Edit

IABSD.fr/xenocara/app/setxkbmap/setxkbmap.man

Branch :

  • Show log

    Commit

  • Author : matthieu
    Date : 2007-09-12 11:08:59
    Hash : 58e8aa09
    Message : setxkbmap 1.0.4

  • app/setxkbmap/setxkbmap.man
  • .\"
    .\" $XFree86: xc/programs/setxkbmap/setxkbmap.man,v 3.6 2003/01/20 04:15:08 dawes Exp $
    .\"
    .TH SETXKBMAP __appmansuffix__ __xorgversion__
    .SH NAME
    setxkbmap
    \- set the keyboard using the X Keyboard Extension
    .SH SYNOPSIS
    .B setxkbmap [
    .I args
    .B ] [
    .I layout
    .B [
    .I variant
    .B [
    .I option  ...
    .B ] ] ]
    .SH DESCRIPTION
    The
    .B setxkbmap
    command maps the keyboard to use the layout determined by the options
    specified on the command line.
    .P
    An XKB keymap is constructed from a number of components which are compiled
    only as needed.  The source for all of the components can be found in
    .IR __xkbconfigroot__ .
    .SH OPTIONS
    .TP 8
    .B \-help
    Prints a message describing the valid input to \fIsetxkbmap\fP.
    .TP 8
    .B \-compat \fIname\fP
    Specifies the name of the compatibility map component used to construct
    a keyboard layout.
    .TP 8
    .B \-config \fIfile\fP
    Specifies the name of an XKB configuration file which describes the
    keyboard to be used.
    .TP 8
    .B \-device \fIdevice\fP
    Specifies the numeric device id of the input device to be updated with 
    the new keyboard layout. If not specified, the core keyboard device of 
    the X server is updated.
    .TP 8
    .B \-display \fIdisplay\fP
    Specifies the display to be updated with the new keyboard layout.
    .TP 8
    .B \-geometry \fIname\fP
    Specifies the name of the geometry component used to construct
    a keyboard layout.
    .TP 8
    .B \-I \fIdirectory\fP
    Adds a directory to the list of directories to be used to search for
    specified layout or rules files.
    .TP 8
    .B \-keycodes \fIname\fP
    Specifies the name of the keycodes component used to construct
    a keyboard layout.
    .TP 8
    .B \-keymap \fIname\fP
    Specifies the name of the keymap description used to construct
    a keyboard layout.
    .TP 8
    .B \-layout \fIname\fP
    Specifies the name of the layout used to determine the components which
    make up the keyboard description.  Only one layout may be specified on
    the command line.
    .TP 8
    .B \-model \fIname\fP
    Specifies the name of the keyboard model used to determine the components 
    which make up the keyboard description.  Only one model may be specified
    on the command line.
    .TP 8
    .B \-option \fIname\fP
    Specifies the name of an option to determine the components which make up 
    the keyboard description;  multiple options may be specified, one per
    \fI-option\fP flag. Note that
    .B setxkbmap
    adds options specified in the command line to the options that were set 
    before (as saved in root window properties). If you want to replace all
    previously specified options, use the \fI-option\fP flag with an empty 
    argument first.
    .TP 8
    .B \-print
    With this option the \fBsetxkbmap\fP just prints component names in a format
    acceptable by \fBxkbcomp\fP (an XKB keymap compiler) and exits. The option
    can be used for tests instead of a verbose option and in cases when one needs
    to run both the \fBsetxkbmap\fP and the \fBxkbcomp\fP in chain (see below).
    .TP 8
    .B \-rules \fIfile\fP
    Specifies the name of the rules file used to resolve the requested layout
    and model to a set of component names.
    .TP 8
    .B \-symbols \fIname\fP
    Specifies the name of the symbols component used to construct
    a keyboard layout.
    .TP 8
    .B \-synch
    Force synchronization for X requests.
    .TP 8
    .B \-types \fIname\fP
    Specifies the name of the types component used to construct
    a keyboard layout.
    .TP 8
    .B \-variant \fIname\fP
    Specifies which variant of the keyboard layout should be used to determine 
    the components which make up the keyboard description.  Only one variant
    may be specified on the command line.
    .TP 8
    .B \-verbose|\-v [\fIlevel\fP]
    Specifies level of verbosity in output messages.  Valid levels range from 
    0 (least verbose) to 10 (most verbose).  The default verbosity level is 5. 
    If no level is specified, each \fI-v\fP or \fI-verbose\fP flag raises the 
    level by 1.
    .SH USING WITH xkbcomp
    If you have an Xserver and a client shell running on different computers and
    XKB configuration files on those machines are different you can get
    problems specifying a keyboard map by model, layout, options names.
    This is because \fBsetxkbcomp\fP converts these names to names of XKB
    configuration files according to files that are on the client side computer,
    then it sends the file names to the server where the \fBxkbcomp\fP has to
    compose a complete keyboard map using files which the server has.
    Thus if the sets of files differ significantly the names that the
    \fBsetxkbmap\fP generates can be unacceptable on the server side.  You can
    solve this problem by running the \fBxkbcomp\fP on the client side too.
    With the \fI-print\fP option \fBsetxkbmap\fP just prints the file names
    in an appropriate format to its stdout and this output can be piped
    directly to the \fBxkbcomp\fP input. For example, the command
    
    \fBsetxkbmap us -print | xkbcomp - $DISPLAY\fP
    
    makes both steps run on the same (client) machine and loads a keyboard map into
    the server.
    .SH SEE ALSO
    xkbcomp(__appmansuffix__)
    .SH FILES
    .I __xkbconfigroot__