2012-10-21 05:35:00 +04:00
<?xml version='1.0'?> <!-- * - nxml - * -->
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2012 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
2014-02-12 09:55:38 +04:00
<refentry id= "localectl" conditional= 'ENABLE_LOCALED'
xmlns:xi="http://www.w3.org/2001/XInclude">
2012-10-21 05:35:00 +04:00
<refentryinfo >
<title > localectl</title>
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Lennart</firstname>
<surname > Poettering</surname>
<email > lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > localectl</refentrytitle>
<manvolnum > 1</manvolnum>
</refmeta>
<refnamediv >
<refname > localectl</refname>
<refpurpose > Control the system locale and keyboard layout settings</refpurpose>
</refnamediv>
<refsynopsisdiv >
<cmdsynopsis >
2013-05-30 06:38:06 +04:00
<command > localectl</command>
<arg choice= "opt" rep= "repeat" > OPTIONS</arg>
<arg choice= "req" > COMMAND</arg>
2012-10-21 05:35:00 +04:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <command > localectl</command> may be used to
query and change the system locale and keyboard layout
settings.</para>
<para > The system locale controls the language settings
of system services and of the UI before the user logs
in, such as the display manager, as well as the
default for users after login.</para>
<para > The keyboard settings control the keyboard
layout used on the text console and of the graphical
UI before the user logs in, such as the display
manager, as well as the default for users after
login.</para>
</refsect1>
<refsect1 >
<title > Options</title>
<para > The following options are understood:</para>
<variablelist >
<varlistentry >
<term > <option > -h</option> </term>
2013-02-13 13:39:22 +04:00
<term > <option > --help</option> </term>
2012-10-21 05:35:00 +04:00
<listitem > <para > Prints a short help
text and exits.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > --version</option> </term>
<listitem > <para > Prints a short version
string and exits.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > --no-pager</option> </term>
<listitem > <para > Do not pipe output into a
pager.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > --no-ask-password</option> </term>
2013-07-02 07:44:04 +04:00
<listitem > <para > Do not query the user
2012-10-21 05:35:00 +04:00
for authentication for privileged
operations.</para> </listitem>
</varlistentry>
2013-05-17 17:38:13 +04:00
<varlistentry >
<term > <option > -P</option> </term>
<term > <option > --privileged</option> </term>
<listitem > <para > Acquire privileges via PolicyKit
before executing the operation.</para> </listitem>
</varlistentry>
2012-10-21 05:35:00 +04:00
<varlistentry >
<term > <option > -H</option> </term>
<term > <option > --host</option> </term>
2012-11-06 23:27:38 +04:00
<listitem > <para > Execute the operation
2012-10-21 05:35:00 +04:00
remotely. Specify a hostname, or
2013-06-29 20:09:14 +04:00
username and hostname separated by <literal > @</literal> ,
2012-10-21 05:35:00 +04:00
to connect to. This will use SSH to
2013-11-07 04:17:48 +04:00
talk to the remote
2012-10-21 05:35:00 +04:00
system.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > --no-convert</option> </term>
<listitem > <para > If
<command > set-keymap</command> or
<command > set-x11-keymap</command> is
2013-09-12 23:12:49 +04:00
invoked and this option is passed, then
2012-10-21 05:35:00 +04:00
the keymap will not be converted from
the console to X11, or X11 to console,
respectively.</para> </listitem>
</varlistentry>
</variablelist>
<para > The following commands are understood:</para>
<variablelist >
<varlistentry >
<term > <command > status</command> </term>
<listitem > <para > Show current settings
of the system locale and keyboard
mapping.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <command > set-locale LOCALE...</command> </term>
<listitem > <para > Set the system
locale. This takes one or more
assignments such as "LANG=de_DE.utf8",
"LC_MESSAGES=en_GB.utf8", and so
on. See
<citerefentry > <refentrytitle > locale</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry>
for details on the available settings
and their meanings. Use
<command > list-locales</command> for a
list of available locales (see below).
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <command > list-locales</command> </term>
<listitem > <para > List available locales
useful for configuration with
<command > set-locale</command> .</para> </listitem>
</varlistentry>
<varlistentry >
<term > <command > set-keymap MAP [TOGGLEMAP]</command> </term>
<listitem > <para > Set the system
keyboard mapping for the console. This
takes a keyboard mapping name (such as
"de" or "us"), and possibly a second
one to define a toggle keyboard
mapping. Unless
<option > --no-convert</option> is
2013-07-02 07:44:04 +04:00
passed, the selected setting is also
2012-10-21 05:35:00 +04:00
applied to the default keyboard
mapping of X11, after converting it to
the closest matching X11 keyboard
mapping. Use
2013-01-15 19:27:11 +04:00
<command > list-keymaps</command> for a
2012-10-21 05:35:00 +04:00
list of available keyboard mappings
(see below).</para> </listitem>
</varlistentry>
<varlistentry >
<term > <command > list-keymaps</command> </term>
<listitem > <para > List available
keyboard mappings for the console,
useful for configuration with
2013-01-13 14:19:37 +04:00
<command > set-keymap</command> .</para> </listitem>
2012-10-21 05:35:00 +04:00
</varlistentry>
<varlistentry >
<term > <command > set-x11-keymap LAYOUT [MODEL] [VARIANT] [OPTIONS]</command> </term>
<listitem > <para > Set the system default
keyboard mapping for X11. This takes a
keyboard mapping name (such as "de" or
"us"), and possibly a model, variant
and options, see
<citerefentry > <refentrytitle > kbd</refentrytitle> <manvolnum > 4</manvolnum> </citerefentry>
for details. Unless
<option > --no-convert</option> is
2013-07-02 07:44:04 +04:00
passed, the selected setting is also
2012-10-21 05:35:00 +04:00
applied to the system console keyboard
mapping, after converting it to the
closest matching console keyboard
mapping.</para> </listitem>
</varlistentry>
2013-04-05 02:23:23 +04:00
<varlistentry >
<term > <command > list-x11-keymap-models</command> </term>
<term > <command > list-x11-keymap-layouts</command> </term>
<term > <command > list-x11-keymap-variants [LAYOUT]</command> </term>
<term > <command > list-x11-keymap-options</command> </term>
<listitem > <para > List available X11
keymap models, layouts, variants and
options, useful for configuration with
<command > set-keymap</command> . The
command
<command > list-x11-keymap-variants</command>
optionally takes a layout parameter to
limit the output to the variants
suitable for the specific
layout.</para> </listitem>
</varlistentry>
2012-10-21 05:35:00 +04:00
</variablelist>
</refsect1>
<refsect1 >
<title > Exit status</title>
2013-07-02 07:44:04 +04:00
<para > On success, 0 is returned, a non-zero failure
2012-10-21 05:35:00 +04:00
code otherwise.</para>
</refsect1>
2014-02-12 09:55:38 +04:00
<xi:include href= "less-variables.xml" />
2012-10-21 05:35:00 +04:00
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > locale</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > locale.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > vconsole.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > loadkeys</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > kbd</refentrytitle> <manvolnum > 4</manvolnum> </citerefentry> ,
2013-05-30 06:38:06 +04:00
<ulink url= "http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html" >
The XKB Configuration Guide
</ulink> ,
2012-10-21 05:35:00 +04:00
<citerefentry > <refentrytitle > systemctl</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd-localed.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
</para>
</refsect1>
</refentry>
