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