chiark / gitweb /
journald: move /dev/log socket to /run
[elogind.git] / man / localectl.xml
index febdeec..c2e79a2 100644 (file)
@@ -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>
 
 
                 <variablelist>
                         <varlistentry>
 
                 <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>
 
                                 <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>
 
                         <varlistentry>
                         </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
                                 <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>
                                 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
                                 applied to the default keyboard
                                 mapping of X11, after converting it to
                                 the closest matching X11 keyboard
                                 <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
                                 applied to the system console keyboard
                                 mapping, after converting it to the
                                 closest matching console keyboard
         <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>
                         <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>