2
.TH SETXKBMAP __appmansuffix__ __xorgversion__
5
\- set the keyboard using the X Keyboard Extension
19
command maps the keyboard to use the layout determined by the options
20
specified on the command line.
22
An XKB keymap is constructed from a number of components which are compiled
23
only as needed. The source for all of the components can be found in
24
.IR __xkbconfigroot__ .
28
Prints a message describing the valid input to \fIsetxkbmap\fP.
30
.B \-compat \fIname\fP
31
Specifies the name of the compatibility map component used to construct
34
.B \-config \fIfile\fP
35
Specifies the name of an XKB configuration file which describes the
38
.B \-device \fIdevice\fP
39
Specifies the numeric device id of the input device to be updated with
40
the new keyboard layout. If not specified, the core keyboard device of
41
the X server is updated.
43
.B \-display \fIdisplay\fP
44
Specifies the display to be updated with the new keyboard layout.
46
.B \-geometry \fIname\fP
47
Specifies the name of the geometry component used to construct
50
.B \-I \fIdirectory\fP
51
Adds a directory to the list of directories to be used to search for
52
specified layout or rules files.
54
.B \-keycodes \fIname\fP
55
Specifies the name of the keycodes component used to construct
58
.B \-keymap \fIname\fP
59
Specifies the name of the keymap description used to construct
62
.B \-layout \fIname\fP
63
Specifies the name of the layout used to determine the components which
64
make up the keyboard description. The \fI-layout\fP option may only be used
65
once. Multiple layouts can be specified as a comma-separated list.
68
Specifies the name of the keyboard model used to determine the components
69
which make up the keyboard description. Only one model may be specified
72
.B \-option \fIname\fP
73
Specifies the name of an option to determine the components which make up
74
the keyboard description; multiple options may be specified, one per
75
\fI-option\fP flag. Note that
77
adds options specified in the command line to the options that were set
78
before (as saved in root window properties). If you want to replace all
79
previously specified options, use the \fI-option\fP flag with an empty
83
With this option \fBsetxkbmap\fP just prints component names in a format
84
acceptable by \fBxkbcomp\fP (an XKB keymap compiler) and exits. The option
85
can be used for tests instead of a verbose option and in cases when one needs
86
to run both the \fBsetxkbmap\fP and the \fBxkbcomp\fP in chain (see below).
89
With this option \fBsetxkbmap\fP just prints the current rules, model,
90
layout, variant, and options, then exits.
93
Specifies the name of the rules file used to resolve the requested layout
94
and model to a set of component names.
96
.B \-symbols \fIname\fP
97
Specifies the name of the symbols component used to construct
101
Force synchronization for X requests.
103
.B \-types \fIname\fP
104
Specifies the name of the types component used to construct
107
.B \-variant \fIname\fP
108
Specifies which variant of the keyboard layout should be used to determine
109
the components which make up the keyboard description. The \fI-variant\fP
110
option may only be used once. Multiple variants can be specified as a
111
comma-separated list and will be matched with the layouts specified with
114
.B \-verbose|\-v [\fIlevel\fP]
115
Specifies level of verbosity in output messages. Valid levels range from
116
0 (least verbose) to 10 (most verbose). The default verbosity level is 5.
117
If no level is specified, each \fI-v\fP or \fI-verbose\fP flag raises the
119
.SH USING WITH xkbcomp
120
If you have an Xserver and a client shell running on different computers and
121
XKB configuration files on those machines are different you can get
122
problems specifying a keyboard map by model, layout, options names.
123
This is because \fBsetxkbcomp\fP converts these names to names of XKB
124
configuration files according to files that are on the client side computer,
125
then it sends the file names to the server where the \fBxkbcomp\fP has to
126
compose a complete keyboard map using files which the server has.
127
Thus if the sets of files differ significantly the names that the
128
\fBsetxkbmap\fP generates can be unacceptable on the server side. You can
129
solve this problem by running the \fBxkbcomp\fP on the client side too.
130
With the \fI-print\fP option \fBsetxkbmap\fP just prints the file names
131
in an appropriate format to its stdout and this output can be piped
132
directly to the \fBxkbcomp\fP input. For example, the command
134
\fBsetxkbmap us -print | xkbcomp - $DISPLAY\fP
136
makes both steps run on the same (client) machine and loads a keyboard map into
139
xkbcomp(__appmansuffix__), xkeyboard-config(__miscmansuffix__)
added
removed
setxkbmap/man/setxkbmap.man
