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         </refsect1>
  77
  78         <refsect1>
  79                 <title>Options</title>
  80
  81                 <para>The following options are understood:</para>
  82
  83                 <variablelist>
  84                         <varlistentry>
  85                                 <term><option>-h</option></term>
  86                                 <term><option>--help</option></term>
  87
  88                                 <listitem><para>Prints a short help
  89                                 text and exits.</para></listitem>
  90                         </varlistentry>
  91
  92                         <varlistentry>
  93                                 <term><option>--version</option></term>
  94
  95                                 <listitem><para>Prints a short version
  96                                 string and exits.</para></listitem>
  97                         </varlistentry>
  98
  99                         <varlistentry>
 100                                 <term><option>--no-pager</option></term>
 101
 102                                 <listitem><para>Do not pipe output into a
 103                                 pager.</para></listitem>
 104                         </varlistentry>
 105
 106                         <varlistentry>
 107                                 <term><option>--no-ask-password</option></term>
 108
 109                                 <listitem><para>Do not query the user
 110                                 for authentication for privileged
 111                                 operations.</para></listitem>
 112                         </varlistentry>
 113
 114                         <varlistentry>
 115                                 <term><option>-P</option></term>
 116                                 <term><option>--privileged</option></term>
 117
 118                                 <listitem><para>Acquire privileges via PolicyKit
 119                                 before executing the operation.</para></listitem>
 120                         </varlistentry>
 121
 122                         <varlistentry>
 123                                 <term><option>-H</option></term>
 124                                 <term><option>--host</option></term>
 125
 126                                 <listitem><para>Execute the operation
 127                                 remotely. Specify a hostname, or
 128                                 username and hostname separated by <literal>@</literal>,
 129                                 to connect to. This will use SSH to
 130                                 talk to the remote
 131                                 system.</para></listitem>
 132                         </varlistentry>
 133
 134                         <varlistentry>
 135                                 <term><option>--no-convert</option></term>
 136
 137                                 <listitem><para>If
 138                                 <command>set-keymap</command> or
 139                                 <command>set-x11-keymap</command> is
 140                                 invoked and this option is passed, then
 141                                 the keymap will not be converted from
 142                                 the console to X11, or X11 to console,
 143                                 respectively.</para></listitem>
 144                         </varlistentry>
 145                 </variablelist>
 146
 147                 <para>The following commands are understood:</para>
 148
 149                 <variablelist>
 150                         <varlistentry>
 151                                 <term><command>status</command></term>
 152
 153                                 <listitem><para>Show current settings
 154                                 of the system locale and keyboard
 155                                 mapping.</para></listitem>
 156                         </varlistentry>
 157
 158                         <varlistentry>
 159                                 <term><command>set-locale LOCALE...</command></term>
 160
 161                                 <listitem><para>Set the system
 162                                 locale. This takes one or more
 163                                 assignments such as "LANG=de_DE.utf8",
 164                                 "LC_MESSAGES=en_GB.utf8", and so
 165                                 on. See
 166                                 <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 167                                 for details on the available settings
 168                                 and their meanings. Use
 169                                 <command>list-locales</command> for a
 170                                 list of available locales (see below).
 171                                 </para></listitem>
 172                         </varlistentry>
 173
 174                         <varlistentry>
 175                                 <term><command>list-locales</command></term>
 176
 177                                 <listitem><para>List available locales
 178                                 useful for configuration with
 179                                 <command>set-locale</command>.</para></listitem>
 180                         </varlistentry>
 181
 182                         <varlistentry>
 183                                 <term><command>set-keymap MAP [TOGGLEMAP]</command></term>
 184
 185                                 <listitem><para>Set the system
 186                                 keyboard mapping for the console. This
 187                                 takes a keyboard mapping name (such as
 188                                 "de" or "us"), and possibly a second
 189                                 one to define a toggle keyboard
 190                                 mapping. Unless
 191                                 <option>--no-convert</option> is
 192                                 passed, the selected setting is also
 193                                 applied to the default keyboard
 194                                 mapping of X11, after converting it to
 195                                 the closest matching X11 keyboard
 196                                 mapping. Use
 197                                 <command>list-keymaps</command> for a
 198                                 list of available keyboard mappings
 199                                 (see below).</para></listitem>
 200                         </varlistentry>
 201
 202                         <varlistentry>
 203                                 <term><command>list-keymaps</command></term>
 204
 205                                 <listitem><para>List available
 206                                 keyboard mappings for the console,
 207                                 useful for configuration with
 208                                 <command>set-keymap</command>.</para></listitem>
 209                         </varlistentry>
 210
 211                         <varlistentry>
 212                                 <term><command>set-x11-keymap LAYOUT [MODEL] [VARIANT] [OPTIONS]</command></term>
 213
 214                                 <listitem><para>Set the system default
 215                                 keyboard mapping for X11. This takes a
 216                                 keyboard mapping name (such as "de" or
 217                                 "us"), and possibly a model, variant
 218                                 and options, see
 219                                 <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>
 220                                 for details. Unless
 221                                 <option>--no-convert</option> is
 222                                 passed, the selected setting is also
 223                                 applied to the system console keyboard
 224                                 mapping, after converting it to the
 225                                 closest matching console keyboard
 226                                 mapping.</para></listitem>
 227                         </varlistentry>
 228
 229                         <varlistentry>
 230                                 <term><command>list-x11-keymap-models</command></term>
 231                                 <term><command>list-x11-keymap-layouts</command></term>
 232                                 <term><command>list-x11-keymap-variants [LAYOUT]</command></term>
 233                                 <term><command>list-x11-keymap-options</command></term>
 234
 235                                 <listitem><para>List available X11
 236                                 keymap models, layouts, variants and
 237                                 options, useful for configuration with
 238                                 <command>set-keymap</command>. The
 239                                 command
 240                                 <command>list-x11-keymap-variants</command>
 241                                 optionally takes a layout parameter to
 242                                 limit the output to the variants
 243                                 suitable for the specific
 244                                 layout.</para></listitem>
 245                         </varlistentry>
 246                 </variablelist>
 247
 248         </refsect1>
 249
 250         <refsect1>
 251                 <title>Exit status</title>
 252
 253                 <para>On success, 0 is returned, a non-zero failure
 254                 code otherwise.</para>
 255         </refsect1>
 256
 257         <xi:include href="less-variables.xml" />
 258
 259         <refsect1>
 260                 <title>See Also</title>
 261                 <para>
 262                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 263                         <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 264                         <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 265                         <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 266                         <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 267                         <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>,
 268                         <ulink url="http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html">
 269                           The XKB Configuration Guide
 270                         </ulink>,
 271                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 272                         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 273                 </para>
 274         </refsect1>
 275
 276 </refentry>