man: document new download magic

[elogind.git] / man / localectl.xml

diff --git a/man/localectl.xml b/man/localectl.xml
index 5e7886c108e2ca9163988c3a8cc80d5196d1ac9d..b472b6bd9c7651f3903b42a022c3f1da7b96f874 100644 (file)
--- a/man/localectl.xml
+++ b/man/localectl.xml
@@ -21,7 +21,8 @@
   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" conditional='ENABLE_LOCALED'>
+<refentry id="localectl" conditional='ENABLE_LOCALED'
+          xmlns:xi="http://www.w3.org/2001/XInclude">

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


@@ -49,7 +50,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>
 


@@ -70,6 +73,11 @@
                 UI before the user logs in, such as the display
                 manager, as well as the default for users after
                 login.</para>
                 UI before the user logs in, such as the display
                 manager, as well as the default for users after
                 login.</para>

+
+                <para>Use
+                <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                to initialize the system locale for mounted (but not
+                booted) system images.</para>

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


@@ -78,59 +86,31 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
                 <para>The following options are understood:</para>
 
                 <variablelist>

-                        <varlistentry>
-                                <term><option>-h</option></term>
-                                <term><option>--help</option></term>
-
-                                <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>
 
                         <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>-H</option></term>
-                                <term><option>--host</option></term>
-
-                                <listitem><para>Execute the operation
-                                remotely. Specify a hostname, or
-                                username and hostname separated by @,
-                                to connect to. This will use SSH to
-                                talk to a remote
-                                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
                         <varlistentry>
                                 <term><option>--no-convert</option></term>
 
                                 <listitem><para>If
                                 <command>set-keymap</command> or
                                 <command>set-x11-keymap</command> is

-                                invoked and this option is passed then
+                                invoked and this option is passed, then

                                 the keymap will not be converted from
                                 the console to X11, or X11 to console,
                                 respectively.</para></listitem>
                         </varlistentry>
                                 the keymap will not be converted from
                                 the console to X11, or X11 to console,
                                 respectively.</para></listitem>
                         </varlistentry>

+
+                        <xi:include href="user-system-options.xml" xpointer="host" />
+
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
+                        <xi:include href="standard-options.xml" xpointer="no-pager" />

                 </variablelist>
 
                 <para>The following commands are understood:</para>
                 </variablelist>
 
                 <para>The following commands are understood:</para>


@@ -172,14 +152,14 @@
                                 <term><command>set-keymap MAP [TOGGLEMAP]</command></term>
 
                                 <listitem><para>Set the system
                                 <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
+                                keyboard mapping for the console and
+                                X11. This takes a mapping name (such
+                                as "de" or "us"), and possibly a
+                                second one to define a toggle keyboard

                                 mapping. Unless
                                 <option>--no-convert</option> is
                                 mapping. Unless
                                 <option>--no-convert</option> is

-                                passed the selected setting is also
-                                applied to the default keyboard
+                                passed, the selected setting is also
+                                applied as the default system keyboard

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


@@ -198,23 +178,42 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><command>set-x11-keymap LAYOUT [MODEL] [VARIANT] [OPTIONS]</command></term>
+                                <term><command>set-x11-keymap LAYOUT [MODEL [VARIANT [OPTIONS]]]</command></term>

 
                                 <listitem><para>Set the system default
 
                                 <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
+                                keyboard mapping for X11 and the
+                                virtual console. This takes a keyboard
+                                mapping name (such as
+                                <literal>de</literal> or
+                                <literal>us</literal>), and possibly a
+                                model, variant, and options, see

                                 <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
-                                applied to the system console keyboard
+                                passed, the selected setting is also
+                                applied as the system console keyboard

                                 mapping, after converting it to the
                                 closest matching console keyboard
                                 mapping.</para></listitem>
                         </varlistentry>
 
                                 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,25 +221,11 @@
         <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>
 
                 code otherwise.</para>
         </refsect1>
 

-        <refsect1>
-                <title>Environment</title>
-
-                <variablelist class='environment-variables'>
-                        <varlistentry>
-                                <term><varname>$SYSTEMD_PAGER</varname></term>
-                                <listitem><para>Pager to use when
-                                <option>--no-pager</option> is not given;
-                                overrides <varname>$PAGER</varname>.  Setting
-                                this to an empty string or the value
-                                <literal>cat</literal> is equivalent to passing
-                                <option>--no-pager</option>.</para></listitem>
-                        </varlistentry>
-                </variablelist>
-        </refsect1>
+        <xi:include href="less-variables.xml" />

 
         <refsect1>
                 <title>See Also</title>
 
         <refsect1>
                 <title>See Also</title>


@@ -251,8 +236,12 @@
                         <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>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

-                        <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>

                 </para>
         </refsect1>
 
                 </para>
         </refsect1>