4mCKBCOMP24m(1)                 Console-setup User's Manual                4mCKBCOMP24m(1)

1mNAME0m
     ckbcomp - compile a XKB keyboard description to a keymap suitable for load-
     keys or kbdcontrol


1mSYNOPSIS0m
     1mckbcomp 22m[4mOPTION24m...] [4mXKBLAYOUT24m [4mXKBVARIANT24m [4mXKBOPTIONS24m]...]]


1mDESCRIPTION0m
     The  1mckbcomp 22mkeymap compiler converts a description of an XKB keyboard lay-
     out into a console keymap that can be read directly by 1mloadkeys22m(1) or  1mkbd-0m
     1mcontrol22m(1).

     On  its  standard  output  1mckbcomp 22mdumps the generated keyboard definition.
     The most important difference between the arguments of 1msetxkbmap22m(1) and the
     arguments of 1mckbcomp 22mis the additional parameter 4m-charmap24m when  non-Unicode
     keyboard  map  is  wanted.   Without 4m-charmap24m 1mckbcomp 22mwill generate Unicode
     keyboard.



1mOPTIONS0m
   1mGeneral options0m
     1m-?22m,1m-help0m
            Print a usage message and exit.

     1m-charmap 4m22mcharmap0m
            The encoding to use for the output keymap.  There should be an char-
            acter mapping table defining this encoding in  4m/usr/local/share/con-0m
            4msoletrans24m.   Definitions  of  the  following  charmaps are provided:
            1mARMSCII-822m, 1mCP125122m, 1mCP125522m,  1mCP125622m,  1mGEORGIAN-ACADEMY22m,  1mGEORGIAN-PS22m,
            1mIBM113322m, 1mISIRI-334222m, 1mISO-8859-122m, 1mISO-8859-222m, 1mISO-8859-322m, 1mISO-8859-422m,
            1mISO-8859-522m,    1mISO-8859-622m,   1mISO-8859-722m,   1mISO-8859-822m,   1mISO-8859-922m,
            1mISO-8859-1022m,  1mISO-8859-1122m,  1mISO-8859-1322m,  1mISO-8859-1422m,  1mISO-8859-1522m,
            1mISO-8859-1622m, 1mKOI8-R22m, 1mKOI8-U22m, 1mTIS-620 22mand 1mVISCII22m.


     1m-I4m22mdir24m  Look in the top-level directory 4mdir24m 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  4m/usr/lo-0m
            4mcal/etc/console-setup/ckb24m, 4m/usr/local/share/X11/xkb24m and 4m/etc/X11/xkb0m


     1m-v 4m22mlevel0m
            Set  level of detail for listing.  The argument 4mlevel24m must be a num-
            ber from 1 to 10.

     1m-compact0m
            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.

     1m-freebsd0m
            Generate a keymap for FreeBSD.

     1m-backspace 22m[1mbs22m|1mdel22m]
            Specifies the behaviour of the <BackSpace> and <Delete> keys.  Value
            1mbs  22mspecifies  VT100-conformant behaviour: <BackSpace> will generate
            1m^H 22m(ASCII BS) and <Delete> will generate 1m^?  22m(ASCII DEL).  Value 1mdel0m
            specifies VT220-conformant behavior: <BackSpace>  will  generate  1m^?0m
            (ASCII DEL) and <Delete> will generate a special function sequence.


   1mXKB Keyboard Description0m
     The  keyboard  layout, variant and options components can be also specified
     directly on the command line.  See the synopsis of the command.

     1m-symbols 4m22mname0m
            Specifies the symbols component name of the  XKB  keyboard  descrip-
            tion.

     1m-keycodes 4m22mname0m
            Specifies  the  keycodes component name of the XKB keyboard descrip-
            tion.

     1m-rules 4m22mname0m
            The name of the rules file to use.

     1m-model 4m22mname0m
            Specifies the keyboard model used to choose the component names.

     1m-layout 4m22mname0m
            Specifies the layout used to choose the component names.

     1m-variant 4m22mname0m
            Specifies the layout variant used to choose the component names.

     1m-option 4m22mname0m
            Adds an option used to choose component names.


1mFILES0m
     4m/usr/local/share/consoletrans0m
     4m/usr/local/etc/console-setup/ckb0m
     4m/usr/share/X11/xkb0m
     4m/etc/X11/xkb0m


1mNOTES0m
     If the option 4m-freebsd24m is used together with 4m-backspace24m 4mdel24m, then  the  key
     <Delete>  will generate the special code 1mfkey7022m.  It is your responsibility
     to assign the appropriate sequence to this special  code by using the  fol-
     lowing command:

         kbdcontrol -f 70 "`printf '\033[3~'`"



1mSEE ALSO0m
     1mkeyboard22m(5), 1msetxkbmap22m(1)

console-setup                      2011-03-17                         4mCKBCOMP24m(1)
