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