man-pages/man1/ckbcomp.1.html
2021-03-31 01:06:50 +01:00

323 lines
6.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of CKBCOMP</TITLE>
</HEAD><BODY>
<H1>CKBCOMP</H1>
Section: Console-setup User's Manual (1)<BR>Updated: 2011-03-17<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
ckbcomp - compile a XKB keyboard description to a keymap suitable for loadkeys or kbdcontrol
<P>
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>ckbcomp</B>
[<I>OPTION</I>...]&nbsp;[<I>XKBLAYOUT</I>&nbsp;[<I>XKBVARIANT</I>&nbsp;[<I>XKBOPTIONS</I>]...]]
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<B>ckbcomp</B>
keymap compiler converts a description of an XKB keyboard layout into
a console keymap that can be read directly by
<B><A HREF="/cgi-bin/man/man2html?1+loadkeys">loadkeys</A></B>(1)
or
<B><A HREF="/cgi-bin/man/man2html?1+kbdcontrol">kbdcontrol</A></B>(1).
<P>
On its standard output
<B>ckbcomp</B>
dumps the generated keyboard definition. The most important
difference between the arguments of
<B><A HREF="/cgi-bin/man/man2html?1+setxkbmap">setxkbmap</A></B>(1)
and the arguments of
<B>ckbcomp</B>
is the additional parameter
<I>-charmap</I>
when non-Unicode keyboard map is wanted. Without
<I>-charmap</I>
<B>ckbcomp</B>
will generate Unicode keyboard.
<P>
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<A NAME="lbAF">&nbsp;</A>
<H3>General options</H3>
<DL COMPACT>
<DT id="1"><B>-?</B>,<B>-help</B>
<DD>
Print a usage message and exit.
<DT id="2"><B>-charmap&nbsp;</B><I>charmap</I>
<DD>
The encoding to use for the output keymap. There should be an
character mapping table defining this encoding in
<I>/usr/share/consoletrans</I>.
Definitions of the following charmaps are provided:
<B>ARMSCII-8</B>,
<B>CP1251</B>,
<B>CP1255</B>,
<B>CP1256</B>,
<B>GEORGIAN-ACADEMY</B>,
<B>GEORGIAN-PS</B>,
<B>IBM1133</B>,
<B>ISIRI-3342</B>,
<B>ISO-8859-1</B>,
<B>ISO-8859-2</B>,
<B>ISO-8859-3</B>,
<B>ISO-8859-4</B>,
<B>ISO-8859-5</B>,
<B>ISO-8859-6</B>,
<B>ISO-8859-7</B>,
<B>ISO-8859-8</B>,
<B>ISO-8859-9</B>,
<B>ISO-8859-10</B>,
<B>ISO-8859-11</B>,
<B>ISO-8859-13</B>,
<B>ISO-8859-14</B>,
<B>ISO-8859-15</B>,
<B>ISO-8859-16</B>,
<B>KOI8-R</B>,
<B>KOI8-U</B>,
<B>TIS-620</B> and
<B>VISCII</B>.
<P>
<DT id="3"><B>-I</B><I>dir</I>
<DD>
Look in the top-level directory
<I>dir</I>
for files included by the keymap description. This option may be used
multiple times. If a file can not be found in any of the specified
directories, it will be searched also in some other standard
locations, such as
<I>/etc/console-setup/ckb</I>,
<I>/usr/share/X11/xkb</I>
and
<I>/etc/X11/xkb</I>
<P>
<DT id="4"><B>-v&nbsp;</B><I>level</I>
<DD>
Set level of detail for listing. The argument
<I>level</I>
must be a number from 1 to 10.
<DT id="5"><B>-compact</B>
<DD>
Generate a compact keymap with at most two xkb groups and two levels
in each or only one xkb-group and up to four levels.
<DT id="6"><B>-freebsd</B>
<DD>
Generate a keymap for FreeBSD.
<DT id="7"><B>-backspace&nbsp;</B>[<B>bs</B>|<B>del</B>]
<DD>
Specifies the behaviour of the
<FONT SIZE="-1">&lt;BackSpace&gt;</FONT>
and
<FONT SIZE="-1">&lt;Delete&gt;</FONT>
keys. Value
<B>bs</B>
specifies VT100-conformant behaviour:
<FONT SIZE="-1">&lt;BackSpace&gt;</FONT>
will generate
<B>^H</B>
<FONT SIZE="-1">(ASCII BS)</FONT>
and
<FONT SIZE="-1">&lt;Delete&gt;</FONT>
will generate
<B>^?</B>
<FONT SIZE="-1">(ASCII DEL).</FONT>
Value
<B>del</B>
specifies VT220-conformant behavior:
<FONT SIZE="-1">&lt;BackSpace&gt;</FONT>
will generate
<B>^?</B>
<FONT SIZE="-1">(ASCII DEL)</FONT>
and
<FONT SIZE="-1">&lt;Delete&gt;</FONT>
will generate a special function sequence.
<P>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H3>XKB Keyboard Description</H3>
The keyboard layout, variant and options components can be also
specified directly on the command line. See the synopsis of the
command.
<DL COMPACT>
<DT id="8"><B>-symbols&nbsp;</B><I>name</I>
<DD>
Specifies the symbols component name of the XKB keyboard description.
<DT id="9"><B>-keycodes&nbsp;</B><I>name</I>
<DD>
Specifies the keycodes component name of the XKB keyboard description.
<DT id="10"><B>-rules&nbsp;</B><I>name</I>
<DD>
The name of the rules file to use.
<DT id="11"><B>-model&nbsp;</B><I>name</I>
<DD>
Specifies the keyboard model used to choose the component names.
<DT id="12"><B>-layout&nbsp;</B><I>name</I>
<DD>
Specifies the layout used to choose the component names.
<DT id="13"><B>-variant&nbsp;</B><I>name</I>
<DD>
Specifies the layout variant used to choose the component names.
<DT id="14"><B>-option&nbsp;</B><I>name</I>
<DD>
Adds an option used to choose component names.
<P>
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>FILES</H2>
<I>/usr/share/consoletrans</I>
<BR>
<I>/etc/console-setup/ckb</I>
<BR>
<I>/usr/share/X11/xkb</I>
<BR>
<I>/etc/X11/xkb</I>
<P>
<A NAME="lbAI">&nbsp;</A>
<H2>NOTES</H2>
If the option
<I>-freebsd</I>
is used together with
<I>-backspace&nbsp;del</I>,
then the key
<FONT SIZE="-1">&lt;Delete&gt;</FONT>
will generate the special code
<B>fkey70</B>.
It is your responsibility to assign the appropriate sequence to this
special code by using the following command:
<PRE>
kbdcontrol -f 70 &quot;`printf '\033[3~'`&quot;
</PRE>
<P>
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?5+keyboard">keyboard</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?1+setxkbmap">setxkbmap</A></B>(1)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="15"><A HREF="#lbAB">NAME</A><DD>
<DT id="16"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="17"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="18"><A HREF="#lbAE">OPTIONS</A><DD>
<DL>
<DT id="19"><A HREF="#lbAF">General options</A><DD>
<DT id="20"><A HREF="#lbAG">XKB Keyboard Description</A><DD>
</DL>
<DT id="21"><A HREF="#lbAH">FILES</A><DD>
<DT id="22"><A HREF="#lbAI">NOTES</A><DD>
<DT id="23"><A HREF="#lbAJ">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:09 GMT, March 31, 2021
</BODY>
</HTML>