1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2012 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="localectl" conditional='ENABLE_LOCALED'
25 xmlns:xi="http://www.w3.org/2001/XInclude">
28 <title>localectl</title>
29 <productname>systemd</productname>
33 <contrib>Developer</contrib>
34 <firstname>Lennart</firstname>
35 <surname>Poettering</surname>
36 <email>lennart@poettering.net</email>
42 <refentrytitle>localectl</refentrytitle>
43 <manvolnum>1</manvolnum>
47 <refname>localectl</refname>
48 <refpurpose>Control the system locale and keyboard layout settings</refpurpose>
53 <command>localectl</command>
54 <arg choice="opt" rep="repeat">OPTIONS</arg>
55 <arg choice="req">COMMAND</arg>
60 <title>Description</title>
62 <para><command>localectl</command> may be used to
63 query and change the system locale and keyboard layout
66 <para>The system locale controls the language settings
67 of system services and of the UI before the user logs
68 in, such as the display manager, as well as the
69 default for users after login.</para>
71 <para>The keyboard settings control the keyboard
72 layout used on the text console and of the graphical
73 UI before the user logs in, such as the display
74 manager, as well as the default for users after
78 <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
79 to initialize the system locale for mounted (but not
80 booted) system images.</para>
84 <title>Options</title>
86 <para>The following options are understood:</para>
90 <term><option>--no-ask-password</option></term>
92 <listitem><para>Do not query the user
93 for authentication for privileged
94 operations.</para></listitem>
98 <term><option>--no-convert</option></term>
101 <command>set-keymap</command> or
102 <command>set-x11-keymap</command> is
103 invoked and this option is passed, then
104 the keymap will not be converted from
105 the console to X11, or X11 to console,
106 respectively.</para></listitem>
109 <xi:include href="user-system-options.xml" xpointer="host" />
111 <xi:include href="standard-options.xml" xpointer="help" />
112 <xi:include href="standard-options.xml" xpointer="version" />
113 <xi:include href="standard-options.xml" xpointer="no-pager" />
116 <para>The following commands are understood:</para>
120 <term><command>status</command></term>
122 <listitem><para>Show current settings
123 of the system locale and keyboard
124 mapping.</para></listitem>
128 <term><command>set-locale LOCALE...</command></term>
130 <listitem><para>Set the system
131 locale. This takes one or more
132 assignments such as "LANG=de_DE.utf8",
133 "LC_MESSAGES=en_GB.utf8", and so
135 <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>
136 for details on the available settings
137 and their meanings. Use
138 <command>list-locales</command> for a
139 list of available locales (see below).
144 <term><command>list-locales</command></term>
146 <listitem><para>List available locales
147 useful for configuration with
148 <command>set-locale</command>.</para></listitem>
152 <term><command>set-keymap MAP [TOGGLEMAP]</command></term>
154 <listitem><para>Set the system
155 keyboard mapping for the console and
156 X11. This takes a mapping name (such
157 as "de" or "us"), and possibly a
158 second one to define a toggle keyboard
160 <option>--no-convert</option> is
161 passed, the selected setting is also
162 applied as the default system keyboard
163 mapping of X11, after converting it to
164 the closest matching X11 keyboard
166 <command>list-keymaps</command> for a
167 list of available keyboard mappings
168 (see below).</para></listitem>
172 <term><command>list-keymaps</command></term>
174 <listitem><para>List available
175 keyboard mappings for the console,
176 useful for configuration with
177 <command>set-keymap</command>.</para></listitem>
181 <term><command>set-x11-keymap LAYOUT [MODEL [VARIANT [OPTIONS]]]</command></term>
183 <listitem><para>Set the system default
184 keyboard mapping for X11 and the
185 virtual console. This takes a keyboard
186 mapping name (such as
187 <literal>de</literal> or
188 <literal>us</literal>), and possibly a
189 model, variant, and options, see
190 <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>
192 <option>--no-convert</option> is
193 passed, the selected setting is also
194 applied as the system console keyboard
195 mapping, after converting it to the
196 closest matching console keyboard
197 mapping.</para></listitem>
201 <term><command>list-x11-keymap-models</command></term>
202 <term><command>list-x11-keymap-layouts</command></term>
203 <term><command>list-x11-keymap-variants [LAYOUT]</command></term>
204 <term><command>list-x11-keymap-options</command></term>
206 <listitem><para>List available X11
207 keymap models, layouts, variants and
208 options, useful for configuration with
209 <command>set-keymap</command>. The
211 <command>list-x11-keymap-variants</command>
212 optionally takes a layout parameter to
213 limit the output to the variants
214 suitable for the specific
215 layout.</para></listitem>
222 <title>Exit status</title>
224 <para>On success, 0 is returned, a non-zero failure
225 code otherwise.</para>
228 <xi:include href="less-variables.xml" />
231 <title>See Also</title>
233 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
234 <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
235 <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
236 <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
237 <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
238 <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>,
239 <ulink url="http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html">
240 The XKB Configuration Guide
242 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
243 <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
244 <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>