diff options
| -rw-r--r-- | man/less-variables.xml | 29 | ||||
| -rw-r--r-- | man/standard-conf.xml | 71 | ||||
| -rw-r--r-- | man/standard-options.xml | 39 | ||||
| -rw-r--r-- | man/user-system-options.xml | 50 |
4 files changed, 189 insertions, 0 deletions
diff --git a/man/less-variables.xml b/man/less-variables.xml new file mode 100644 index 0000000000..0fb4d7fbcf --- /dev/null +++ b/man/less-variables.xml @@ -0,0 +1,29 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<refsect1> + <title>Environment</title> + + <variablelist class='environment-variables'> + <varlistentry id='pager'> + <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> + + <varlistentry id='less'> + <term><varname>$SYSTEMD_LESS</varname></term> + + <listitem><para>Override the default + options passed to + <command>less</command> + (<literal>FRSXMK</literal>).</para></listitem> + </varlistentry> + </variablelist> +</refsect1> diff --git a/man/standard-conf.xml b/man/standard-conf.xml new file mode 100644 index 0000000000..004f53f70c --- /dev/null +++ b/man/standard-conf.xml @@ -0,0 +1,71 @@ +<?xml version="1.0"?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> +<!DOCTYPE refsection PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<refsection> + <refsection id='confd'> + <title>Configuration Directories and Precedence</title> + + <para>Configuration files are read from directories in + <filename>/etc/</filename>, <filename>/run/</filename>, and + <filename>/usr/lib/</filename>, in order of precedence. + Each configuration file in these configuration directories shall be named in + the style of <filename><replaceable>filename</replaceable>.conf</filename>. + Files in <filename>/etc/</filename> override files with the same name in + <filename>/run/</filename> and <filename>/usr/lib/</filename>. Files in + <filename>/run/</filename> override files with the same name in + <filename>/usr/lib/</filename>.</para> + + <para>Packages should install their configuration files in + <filename>/usr/lib/</filename>. Files in <filename>/etc/</filename> are + reserved for the local administrator, who may use this logic to override the + configuration files installed by vendor packages. All configuration files + are sorted by their filename in lexicographic order, regardless of which of + the directories they reside in. If multiple files specify the same option, + the entry in the file with the lexicographically latest name will take + precedence. It is recommended to prefix all filenames with a two-digit number + and a dash, to simplify the ordering of the files.</para> + + <para>If the administrator wants to disable a configuration file supplied by + the vendor, the recommended way is to place a symlink to + <filename>/dev/null</filename> in the configuration directory in + <filename>/etc/</filename>, with the same filename as the vendor + configuration file.</para> + </refsection> + + <refsection id='main-conf'> + <title>Configuration Directories and Precedence</title> + + <para>Default configuration is defined during compilation, so a + configuration file is only needed when it is necessary to deviate + from those defaults. By default the configuration file in + <filename>/etc/systemd/</filename> contains commented out entries + showing the defaults as a guide to the administrator. This file + can be edited to create local overrides. + </para> + + <para>When packages need to customize the configuration, they can + install configuration snippets in + <filename>/usr/lib/systemd/*.conf.d/</filename>. Files in + <filename>/etc/</filename> are reserved for the local + administrator, who may use this logic to override the + configuration files installed by vendor packages. The main + configuration file is read before any of the configuration + directories, and has the lowest precedence; entries in a file in + any configuration directory override entries in the single + configuration file. Files in the + <filename>*.conf.d/</filename> configuration subdirectories + are sorted by their filename in lexicographic order, regardless of + which of the subdirectories they reside in. If multiple files + specify the same option, the entry in the file with the + lexicographically latest name takes precedence. It is recommended + to prefix all filenames in those subdirectories with a two-digit + number and a dash, to simplify the ordering of the files.</para> + + <para>To disable a configuration file supplied by the vendor, the + recommended way is to place a symlink to + <filename>/dev/null</filename> in the configuration directory in + <filename>/etc/</filename>, with the same filename as the vendor + configuration file.</para> + </refsection> +</refsection> diff --git a/man/standard-options.xml b/man/standard-options.xml new file mode 100644 index 0000000000..f214463392 --- /dev/null +++ b/man/standard-options.xml @@ -0,0 +1,39 @@ +<?xml version="1.0"?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<variablelist> + <varlistentry id='help'> + <term><option>-h</option></term> + <term><option>--help</option></term> + + <listitem id='help-text'> + <para>Print a short help text and exit. + </para></listitem> + </varlistentry> + + <varlistentry id='version'> + <term><option>--version</option></term> + + <listitem id='version-text'> + <para>Print a short version string and exit.</para> + </listitem> + </varlistentry> + + <varlistentry id='no-pager'> + <term><option>--no-pager</option></term> + + <listitem> + <para>Do not pipe output into a pager.</para> + </listitem> + </varlistentry> + + <varlistentry id='no-legend'> + <term><option>--no-legend</option></term> + + <listitem> + <para>Do not print the legend, i.e. column headers and the + footer with hints.</para> + </listitem> + </varlistentry> +</variablelist> diff --git a/man/user-system-options.xml b/man/user-system-options.xml new file mode 100644 index 0000000000..8616c54249 --- /dev/null +++ b/man/user-system-options.xml @@ -0,0 +1,50 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<variablelist> + <varlistentry id='user'> + <term><option>--user</option></term> + + <listitem id='user-text'> + <para>Talk to the service manager of the calling user, + rather than the service manager of the system.</para> + </listitem> + </varlistentry> + + <varlistentry id='system'> + <term><option>--system</option></term> + + <listitem id='system-text'> + <para>Talk to the service manager of the system. This is the + implied default.</para> + </listitem> + </varlistentry> + + <varlistentry id='host'> + <term><option>-H</option></term> + <term><option>--host=</option></term> + + <listitem id='host-text'> + <para>Execute the operation remotely. Specify a hostname, or a + username and hostname separated by <literal>@</literal>, to + connect to. The hostname may optionally be suffixed by a + container name, separated by <literal>:</literal>, which + connects directly to a specific container on the specified + host. This will use SSH to talk to the remote machine manager + instance. Container names may be enumerated with + <command>machinectl -H + <replaceable>HOST</replaceable></command>.</para> + </listitem> + </varlistentry> + + <varlistentry id='machine'> + <term><option>-M</option></term> + <term><option>--machine=</option></term> + + <listitem id='machine-text'> + <para>Execute operation on a local container. Specify a + container name to connect to.</para> + </listitem> + </varlistentry> +</variablelist> |