222 lines
6.6 KiB
HTML
222 lines
6.6 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of SETXKBMAP</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>SETXKBMAP</H1>
|
|
Section: User Commands (1)<BR>Updated: setxkbmap 1.3.2<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
setxkbmap
|
|
- set the keyboard using the X Keyboard Extension
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>setxkbmap [</B>
|
|
|
|
<I>args</I>
|
|
|
|
<B>] [</B>
|
|
|
|
<I>layout</I>
|
|
|
|
<B>[</B>
|
|
|
|
<I>variant</I>
|
|
|
|
<B>[</B>
|
|
|
|
<I>option ...</I>
|
|
|
|
<B>] ] ]</B>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<B>setxkbmap</B>
|
|
|
|
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
|
|
<I>/usr/share/X11/xkb</I>.
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-compat </B><I>name</I>
|
|
|
|
<DD>
|
|
Specifies the name of the compatibility map component used to construct
|
|
a keyboard layout.
|
|
<DT id="2"><B>-config </B><I>file</I>
|
|
|
|
<DD>
|
|
Specifies the name of an XKB configuration file which describes the
|
|
keyboard to be used.
|
|
<DT id="3"><B>-device </B><I>device</I>
|
|
|
|
<DD>
|
|
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.
|
|
<DT id="4"><B>-display </B><I>display</I>
|
|
|
|
<DD>
|
|
Specifies the display to be updated with the new keyboard layout.
|
|
<DT id="5"><B>-geometry </B><I>name</I>
|
|
|
|
<DD>
|
|
Specifies the name of the geometry component used to construct
|
|
a keyboard layout.
|
|
<DT id="6"><B>-help</B>
|
|
|
|
<DD>
|
|
Prints a message describing the valid input to <I>setxkbmap</I>.
|
|
<DT id="7"><B>-I </B><I>directory</I>
|
|
|
|
<DD>
|
|
Adds a directory to the list of directories to be used to search for
|
|
specified layout or rules files.
|
|
<DT id="8"><B>-keycodes </B><I>name</I>
|
|
|
|
<DD>
|
|
Specifies the name of the keycodes component used to construct
|
|
a keyboard layout.
|
|
<DT id="9"><B>-keymap </B><I>name</I>
|
|
|
|
<DD>
|
|
Specifies the name of the keymap description used to construct
|
|
a keyboard layout.
|
|
<DT id="10"><B>-layout </B><I>name</I>
|
|
|
|
<DD>
|
|
Specifies the name of the layout used to determine the components which
|
|
make up the keyboard description. The <I>-layout</I> option may only be used
|
|
once. Multiple layouts can be specified as a comma-separated list.
|
|
<DT id="11"><B>-model </B><I>name</I>
|
|
|
|
<DD>
|
|
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.
|
|
<DT id="12"><B>-option </B><I>name</I>
|
|
|
|
<DD>
|
|
Specifies the name of an option to determine the components which make up
|
|
the keyboard description; multiple options may be specified, one per
|
|
<I>-option</I> flag. Note that
|
|
<B>setxkbmap</B>
|
|
|
|
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 <I>-option</I> flag with an empty
|
|
argument first.
|
|
<DT id="13"><B>-print</B>
|
|
|
|
<DD>
|
|
With this option <B>setxkbmap</B> just prints component names in a format
|
|
acceptable by <B>xkbcomp</B> (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 <B>setxkbmap</B> and the <B>xkbcomp</B> in chain (see below).
|
|
<DT id="14"><B>-query</B>
|
|
|
|
<DD>
|
|
With this option <B>setxkbmap</B> just prints the current rules, model,
|
|
layout, variant, and options, then exits.
|
|
<DT id="15"><B>-rules </B><I>file</I>
|
|
|
|
<DD>
|
|
Specifies the name of the rules file used to resolve the requested layout
|
|
and model to a set of component names.
|
|
<DT id="16"><B>-symbols </B><I>name</I>
|
|
|
|
<DD>
|
|
Specifies the name of the symbols component used to construct
|
|
a keyboard layout.
|
|
<DT id="17"><B>-synch</B>
|
|
|
|
<DD>
|
|
Force synchronization for X requests.
|
|
<DT id="18"><B>-types </B><I>name</I>
|
|
|
|
<DD>
|
|
Specifies the name of the types component used to construct
|
|
a keyboard layout.
|
|
<DT id="19"><B>-variant </B><I>name</I>
|
|
|
|
<DD>
|
|
Specifies which variant of the keyboard layout should be used to determine
|
|
the components which make up the keyboard description. The <I>-variant</I>
|
|
option may only be used once. Multiple variants can be specified as a
|
|
comma-separated list and will be matched with the layouts specified with
|
|
<I>-layout</I>.
|
|
<DT id="20"><B>-verbose|-v [</B><I>level</I>]
|
|
|
|
<DD>
|
|
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 <I>-v</I> or <I>-verbose</I> flag raises the
|
|
level by 1.
|
|
<DT id="21"><B>-version</B>
|
|
|
|
<DD>
|
|
Prints the program's version number.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>USING WITH xkbcomp</H2>
|
|
|
|
If you have an Xserver and a client shell running on different computers and
|
|
some XKB configuration files on those machines are different, you can get
|
|
problems specifying a keyboard map by model, layout, and options names.
|
|
This is because <B>setxkbmap</B> converts its arguments to names of XKB
|
|
configuration files according to files that are on the client-side computer,
|
|
then sends these file names to the server where <B>xkbcomp</B> has to
|
|
compose a complete keyboard map using files which the server has.
|
|
Thus if the sets of files differ in some way, the names that
|
|
<B>setxkbmap</B> generates can be unacceptable on the server side. You can
|
|
solve this problem by running the <B>xkbcomp</B> on the client side too.
|
|
With the <I>-print</I> option <B>setxkbmap</B> just prints the file names
|
|
in an appropriate format to its stdout and this output can be piped
|
|
directly to the <B>xkbcomp</B> input. For example, the command
|
|
<P>
|
|
<B>setxkbmap us -print | xkbcomp - $DISPLAY</B>
|
|
<P>
|
|
makes both steps run on the same (client) machine and loads a keyboard map into
|
|
the server.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<A HREF="/cgi-bin/man/man2html?1+xkbcomp">xkbcomp</A>(1), <A HREF="/cgi-bin/man/man2html?7+xkeyboard-config">xkeyboard-config</A>(7)
|
|
<A NAME="lbAH"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<I>/usr/share/X11/xkb</I>
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="22"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="23"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="24"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="25"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="26"><A HREF="#lbAF">USING WITH xkbcomp</A><DD>
|
|
<DT id="27"><A HREF="#lbAG">SEE ALSO</A><DD>
|
|
<DT id="28"><A HREF="#lbAH">FILES</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:27 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|