man: refer to systemd.syntax(7) from systemd.nspawn(5)

systemd.nspawn(5) contained a partial repeat of the stuff that is now in the
dedicated man page. Let's just refer to that.

While at it, do s/searched/searched for/ where appropriate and reword some
sentences for brevity.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2019-11-24 16:14:52 +01:00
parent 83dbb4df99
commit 6a5b75dbcc
2 changed files with 24 additions and 48 deletions

View file

@ -32,58 +32,32 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<para>An nspawn container settings file (suffix <para>An nspawn container settings file (suffix <filename>.nspawn</filename>) contains runtime
<filename>.nspawn</filename>) encodes additional runtime configuration for a local container, and is used used by
information about a local container, and is searched, read and <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
used by Files of this type are named after the containers they define settings for. They are optional, and only
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> required for containers whose execution environment shall differ from the defaults. Files of this type
when starting a container. Files of this type are named after the mostly contain settings that may also be set on the <command>systemd-nspawn</command> command line, and
containers they define settings for. They are optional, and only make it easier to persistently attach specific settings to specific containers. The syntax of these files
required for containers whose execution environment shall differ is inspired by <filename>.desktop</filename> files, similarly to other configuration files supported by
from the defaults. Files of this type mostly contain settings that the systemd project. See
may also be set on the <command>systemd-nspawn</command> command <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry> for an
line, and make it easier to persistently attach specific settings overview.</para>
to specific containers. The syntax of these files is inspired by
<filename>.desktop</filename> files following the <ulink
url="http://standards.freedesktop.org/desktop-entry-spec/latest/">XDG
Desktop Entry Specification</ulink>, which in turn are inspired by
Microsoft Windows <filename>.ini</filename> files.</para>
<para>Boolean arguments used in these settings files can be
written in various formats. For positive settings, the strings
<option>1</option>, <option>yes</option>, <option>true</option>
and <option>on</option> are equivalent. For negative settings, the
strings <option>0</option>, <option>no</option>,
<option>false</option> and <option>off</option> are
equivalent.</para>
<para>Empty lines and lines starting with # or ; are
ignored. This may be used for commenting. Lines ending
in a backslash are concatenated with the following
line while reading and the backslash is replaced by a
space character. This may be used to wrap long lines.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title><filename>.nspawn</filename> File Discovery</title> <title><filename>.nspawn</filename> File Discovery</title>
<para>Files are searched by appending the <para>Files are searched for by appending the <filename>.nspawn</filename> suffix to the machine name of
<filename>.nspawn</filename> suffix to the machine name of the the container, as specified with the <option>--machine=</option> switch of
container, as specified with the <option>--machine=</option> <command>systemd-nspawn</command>, or derived from the directory or image file name. This file is first
switch of <command>systemd-nspawn</command>, or derived from the searched for in <filename>/etc/systemd/nspawn/</filename> and
directory or image file name. This file is first searched in <filename>/run/systemd/nspawn/</filename>. If found there, the settings are read and all of them take
<filename>/etc/systemd/nspawn/</filename> and full effect (but may still be overridden by corresponding command line arguments). Otherwise, the file
<filename>/run/systemd/nspawn/</filename>. If found in these will then be searched for next to the image file or in the immediate parent of the root directory of the
directories, its settings are read and all of them take full effect container. If the file is found there, only a subset of the settings will take effect however. All
(but are possibly overridden by corresponding command line settings that possibly elevate privileges or grant additional access to resources of the host (such as
arguments). If not found, the file will then be searched next to files or directories) are ignored. To which options this applies is documented below.</para>
the image file or in the immediate parent of the root directory of
the container. If the file is found there, only a subset of the
settings will take effect however. All settings that possibly
elevate privileges or grant additional access to resources of the
host (such as files or directories) are ignored. To which options
this applies is documented below.</para>
<para>Persistent settings files created and maintained by the <para>Persistent settings files created and maintained by the
administrator (and thus trusted) should be placed in administrator (and thus trusted) should be placed in

View file

@ -42,7 +42,9 @@
<citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry></para></listitem> <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para></listitem>
<listitem><para>daemon config files, see <listitem><para>daemon config files, see
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,