chiark / gitweb /
man: add sd_event_add_child(3)
[elogind.git] / man / localectl.xml
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">
4
5 <!--
6   This file is part of systemd.
7
8   Copyright 2012 Lennart Poettering
9
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.
14
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.
19
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/>.
22 -->
23
24 <refentry id="localectl" conditional='ENABLE_LOCALED'
25           xmlns:xi="http://www.w3.org/2001/XInclude">
26
27         <refentryinfo>
28                 <title>localectl</title>
29                 <productname>systemd</productname>
30
31                 <authorgroup>
32                         <author>
33                                 <contrib>Developer</contrib>
34                                 <firstname>Lennart</firstname>
35                                 <surname>Poettering</surname>
36                                 <email>lennart@poettering.net</email>
37                         </author>
38                 </authorgroup>
39         </refentryinfo>
40
41         <refmeta>
42                 <refentrytitle>localectl</refentrytitle>
43                 <manvolnum>1</manvolnum>
44         </refmeta>
45
46         <refnamediv>
47                 <refname>localectl</refname>
48                 <refpurpose>Control the system locale and keyboard layout settings</refpurpose>
49         </refnamediv>
50
51         <refsynopsisdiv>
52                 <cmdsynopsis>
53                         <command>localectl</command>
54                         <arg choice="opt" rep="repeat">OPTIONS</arg>
55                         <arg choice="req">COMMAND</arg>
56                 </cmdsynopsis>
57         </refsynopsisdiv>
58
59         <refsect1>
60                 <title>Description</title>
61
62                 <para><command>localectl</command> may be used to
63                 query and change the system locale and keyboard layout
64                 settings.</para>
65
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>
70
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
75                 login.</para>
76
77                 <para>Use
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>
81         </refsect1>
82
83         <refsect1>
84                 <title>Options</title>
85
86                 <para>The following options are understood:</para>
87
88                 <variablelist>
89                         <varlistentry>
90                                 <term><option>--no-ask-password</option></term>
91
92                                 <listitem><para>Do not query the user
93                                 for authentication for privileged
94                                 operations.</para></listitem>
95                         </varlistentry>
96
97                         <varlistentry>
98                                 <term><option>--no-convert</option></term>
99
100                                 <listitem><para>If
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>
107                         </varlistentry>
108
109                         <xi:include href="user-system-options.xml" xpointer="host" />
110
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" />
114                 </variablelist>
115
116                 <para>The following commands are understood:</para>
117
118                 <variablelist>
119                         <varlistentry>
120                                 <term><command>status</command></term>
121
122                                 <listitem><para>Show current settings
123                                 of the system locale and keyboard
124                                 mapping.</para></listitem>
125                         </varlistentry>
126
127                         <varlistentry>
128                                 <term><command>set-locale LOCALE...</command></term>
129
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
134                                 on. See
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).
140                                 </para></listitem>
141                         </varlistentry>
142
143                         <varlistentry>
144                                 <term><command>list-locales</command></term>
145
146                                 <listitem><para>List available locales
147                                 useful for configuration with
148                                 <command>set-locale</command>.</para></listitem>
149                         </varlistentry>
150
151                         <varlistentry>
152                                 <term><command>set-keymap MAP [TOGGLEMAP]</command></term>
153
154                                 <listitem><para>Set the system
155                                 keyboard mapping for the console. This
156                                 takes a keyboard mapping name (such as
157                                 "de" or "us"), and possibly a second
158                                 one to define a toggle keyboard
159                                 mapping. Unless
160                                 <option>--no-convert</option> is
161                                 passed, the selected setting is also
162                                 applied to the default keyboard
163                                 mapping of X11, after converting it to
164                                 the closest matching X11 keyboard
165                                 mapping. Use
166                                 <command>list-keymaps</command> for a
167                                 list of available keyboard mappings
168                                 (see below).</para></listitem>
169                         </varlistentry>
170
171                         <varlistentry>
172                                 <term><command>list-keymaps</command></term>
173
174                                 <listitem><para>List available
175                                 keyboard mappings for the console,
176                                 useful for configuration with
177                                 <command>set-keymap</command>.</para></listitem>
178                         </varlistentry>
179
180                         <varlistentry>
181                                 <term><command>set-x11-keymap LAYOUT [MODEL] [VARIANT] [OPTIONS]</command></term>
182
183                                 <listitem><para>Set the system default
184                                 keyboard mapping for X11. This takes a
185                                 keyboard mapping name (such as "de" or
186                                 "us"), and possibly a model, variant
187                                 and options, see
188                                 <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>
189                                 for details. Unless
190                                 <option>--no-convert</option> is
191                                 passed, the selected setting is also
192                                 applied to the system console keyboard
193                                 mapping, after converting it to the
194                                 closest matching console keyboard
195                                 mapping.</para></listitem>
196                         </varlistentry>
197
198                         <varlistentry>
199                                 <term><command>list-x11-keymap-models</command></term>
200                                 <term><command>list-x11-keymap-layouts</command></term>
201                                 <term><command>list-x11-keymap-variants [LAYOUT]</command></term>
202                                 <term><command>list-x11-keymap-options</command></term>
203
204                                 <listitem><para>List available X11
205                                 keymap models, layouts, variants and
206                                 options, useful for configuration with
207                                 <command>set-keymap</command>. The
208                                 command
209                                 <command>list-x11-keymap-variants</command>
210                                 optionally takes a layout parameter to
211                                 limit the output to the variants
212                                 suitable for the specific
213                                 layout.</para></listitem>
214                         </varlistentry>
215                 </variablelist>
216
217         </refsect1>
218
219         <refsect1>
220                 <title>Exit status</title>
221
222                 <para>On success, 0 is returned, a non-zero failure
223                 code otherwise.</para>
224         </refsect1>
225
226         <xi:include href="less-variables.xml" />
227
228         <refsect1>
229                 <title>See Also</title>
230                 <para>
231                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
232                         <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
233                         <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
234                         <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
235                         <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
236                         <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>,
237                         <ulink url="http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html">
238                           The XKB Configuration Guide
239                         </ulink>,
240                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
241                         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
242                         <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
243                 </para>
244         </refsect1>
245
246 </refentry>