sd-login: add a public accessor for the VT number

[elogind.git] / man / localectl.xml

diff --git a/man/localectl.xml b/man/localectl.xml
index 6d7c7889b9307a4b1a11cb01eb1134e92ab4db60..a3e07f6508ba5a1f5cad19175781f3f349cd7ee8 100644 (file)
--- a/man/localectl.xml
+++ b/man/localectl.xml
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 

-<refentry id="localectl">
+<refentry id="localectl" conditional='ENABLE_LOCALED'>

 
         <refentryinfo>
                 <title>localectl</title>
 
         <refentryinfo>
                 <title>localectl</title>


@@ -49,7 +49,9 @@
 
         <refsynopsisdiv>
                 <cmdsynopsis>
 
         <refsynopsisdiv>
                 <cmdsynopsis>

-                        <command>localectl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg></command>
+                        <command>localectl</command>
+                        <arg choice="opt" rep="repeat">OPTIONS</arg>
+                        <arg choice="req">COMMAND</arg>

                 </cmdsynopsis>
         </refsynopsisdiv>
 
                 </cmdsynopsis>
         </refsynopsisdiv>
 


@@ -79,8 +81,8 @@
 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>

-                                <term><option>--help</option></term>

                                 <term><option>-h</option></term>
                                 <term><option>-h</option></term>

+                                <term><option>--help</option></term>

 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>
 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>


@@ -103,18 +105,26 @@
                         <varlistentry>
                                 <term><option>--no-ask-password</option></term>
 
                         <varlistentry>
                                 <term><option>--no-ask-password</option></term>
 

-                                <listitem><para>Don't query the user
+                                <listitem><para>Do not query the user

                                 for authentication for privileged
                                 operations.</para></listitem>
                         </varlistentry>
 
                                 for authentication for privileged
                                 operations.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>-P</option></term>
+                                <term><option>--privileged</option></term>
+
+                                <listitem><para>Acquire privileges via PolicyKit
+                                before executing the operation.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>-H</option></term>
                                 <term><option>--host</option></term>
 
                         <varlistentry>
                                 <term><option>-H</option></term>
                                 <term><option>--host</option></term>
 

-                                <listitem><para>Execute operation
+                                <listitem><para>Execute the operation

                                 remotely. Specify a hostname, or
                                 remotely. Specify a hostname, or

-                                username and hostname separated by @,
+                                username and hostname separated by <literal>@</literal>,

                                 to connect to. This will use SSH to
                                 talk to a remote
                                 system.</para></listitem>
                                 to connect to. This will use SSH to
                                 talk to a remote
                                 system.</para></listitem>


@@ -178,12 +188,12 @@
                                 one to define a toggle keyboard
                                 mapping. Unless
                                 <option>--no-convert</option> is
                                 one to define a toggle keyboard
                                 mapping. Unless
                                 <option>--no-convert</option> is

-                                passed the selected setting is also
+                                passed, the selected setting is also

                                 applied to the default keyboard
                                 mapping of X11, after converting it to
                                 the closest matching X11 keyboard
                                 mapping. Use
                                 applied to the default keyboard
                                 mapping of X11, after converting it to
                                 the closest matching X11 keyboard
                                 mapping. Use

-                                <command>list-locales</command> for a
+                                <command>list-keymaps</command> for a

                                 list of available keyboard mappings
                                 (see below).</para></listitem>
                         </varlistentry>
                                 list of available keyboard mappings
                                 (see below).</para></listitem>
                         </varlistentry>


@@ -194,7 +204,7 @@
                                 <listitem><para>List available
                                 keyboard mappings for the console,
                                 useful for configuration with
                                 <listitem><para>List available
                                 keyboard mappings for the console,
                                 useful for configuration with

-                                <command>set-keyboard</command>.</para></listitem>
+                                <command>set-keymap</command>.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -208,13 +218,30 @@
                                 <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>
                                 for details. Unless
                                 <option>--no-convert</option> is
                                 <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>
                                 for details. Unless
                                 <option>--no-convert</option> is

-                                passed the selected setting is also
+                                passed, the selected setting is also

                                 applied to the system console keyboard
                                 mapping, after converting it to the
                                 closest matching console keyboard
                                 mapping.</para></listitem>
                         </varlistentry>
 
                                 applied to the system console keyboard
                                 mapping, after converting it to the
                                 closest matching console keyboard
                                 mapping.</para></listitem>
                         </varlistentry>
 

+                        <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>

                 </variablelist>
 
         </refsect1>
                 </variablelist>
 
         </refsect1>


@@ -222,14 +249,14 @@
         <refsect1>
                 <title>Exit status</title>
 
         <refsect1>
                 <title>Exit status</title>
 

-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure

                 code otherwise.</para>
         </refsect1>
 
         <refsect1>
                 <title>Environment</title>
 
                 code otherwise.</para>
         </refsect1>
 
         <refsect1>
                 <title>Environment</title>
 

-                <variablelist>
+                <variablelist class='environment-variables'>

                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when


@@ -251,6 +278,9 @@
                         <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>,
                         <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>,

+                        <ulink url="http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html">
+                          The XKB Configuration Guide
+                        </ulink>,

                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 </para>
                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 </para>