picnoir/Systemd
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #7934 from keszybz/man-improvements

Browse source 
Man page improvements
This commit is contained in:
Yu Watanabe 2018-01-20 11:15:52 +09:00 committed by GitHub
parent 09f5dfad2c 22a705631d
commit 7e577c30d6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 60 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
man/coredump.conf.xml
View file

@ -146,6 +146,9 @@
</varlistentry>
</variablelist>
<para>The defaults for all values are listed as comments in the
template <filename>/etc/systemd/coredump.conf</filename> file that
is installed by default.</para>
</refsect1>
<refsect1>

4
man/systemd.journal-fields.xml
View file

@ -339,7 +339,7 @@
<varlistentry>
<term><varname>_STREAM_ID=</varname></term>
<listitem>
<para>Only applies to <literal>_TRANSPORT=stream</literal> records: specifies a randomized 128bit ID assigned
<para>Only applies to <literal>_TRANSPORT=stdout</literal> records: specifies a randomized 128bit ID assigned
to the stream connection when it was first created. This ID is useful to reconstruct individual log streams
from the log records: all log records carrying the same stream ID originate from the same stream.</para>
</listitem>
@ -347,7 +347,7 @@
<varlistentry>
<term><varname>_LINE_BREAK=</varname></term>
<listitem>
<para>Only applies to <literal>_TRANSPORT=stream</literal> records: indicates that the log message in the
<para>Only applies to <literal>_TRANSPORT=stdout</literal> records: indicates that the log message in the
standard output/error stream was not terminated with a normal newline character (<literal>\n</literal>,
i.e. ASCII 10). Specifically, when set this field is one of <option>nul</option> (in case the line was
terminated by a NUL byte), <option>line-max</option> (in case the maximum log line length was reached, as

2
man/systemd.link.xml
View file

@ -453,6 +453,8 @@
</listitem>
</varlistentry>
</variablelist>
<para>Defaults to <literal>off</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>

27
man/systemd.preset.xml
View file

@ -136,23 +136,26 @@
</refsect1>
<refsect1>
<title>Example</title>
<title>Examples</title>
<example>
<title>Default off example <filename>/usr/lib/systemd/system-preset/99-default.preset</filename>:</title>
<title>Default to off</title>
<programlisting>disable *</programlisting>
<programlisting># /usr/lib/systemd/system-preset/99-default.preset
disable *</programlisting>
</example>
<para>This disables all units. Due to the filename prefix
<literal>99-</literal>, it will be read last and hence can easily
be overridden by spin or administrator preset policy or
suchlike.</para>
be overridden by spin or administrator preset policy.</para>
<example>
<title>A GNOME spin example <filename>/usr/lib/systemd/system-preset/50-gnome.preset</filename>:</title>
<title>A GNOME spin</title>
<programlisting>enable gdm.service
<programlisting># /usr/lib/systemd/system-preset/50-gnome.preset
enable gdm.service
enable colord.service
enable accounts-daemon.service
enable avahi-daemon.*</programlisting>
@ -168,9 +171,11 @@ enable avahi-daemon.*</programlisting>
example like the one from the first example above.</para>
<example>
<title>Administrator policy <filename>/etc/systemd/system-preset/00-lennart.preset</filename>:</title>
<title>Administrator policy</title>
<programlisting>enable httpd.service
<programlisting># /etc/systemd/system-preset/00-lennart.preset
enable httpd.service
enable sshd.service
enable postfix.service
disable *</programlisting>
@ -179,8 +184,8 @@ disable *</programlisting>
<para>This enables three specific services and disables all
others. This is useful for administrators to specifically select
the units to enable, and disable all others. Due to the filename
prefix <literal>00-</literal> it will be read early and hence
overrides all other preset policy files.</para>
prefix <literal>00-</literal> it will be read early and
override all other preset policy files.</para>
</refsect1>
<refsect1>

68
man/systemd.special.xml
View file

@ -277,17 +277,6 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>getty-pre.target</filename></term>
<listitem>
<para>A special passive target unit. Users of this target
are expected to pull it in the boot transaction via
a dependency (e.g. <varname>Wants=</varname>). Order your
unit before this unit if you want to make use of the console
just before <filename>getty</filename> is started.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>graphical.target</filename></term>
<listitem>
@ -354,6 +343,29 @@
<option>noauto</option> mount options set.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>initrd-root-device.target</filename></term>
<listitem>
<para>A special initrd target unit that is reached when the root filesystem device is available, but before
it has been mounted.
<citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>3</manvolnum></citerefentry>
and
<citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>3</manvolnum></citerefentry>
automatically setup the appropriate dependencies to make this happen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>initrd-root-fs.target</filename></term>
<listitem>
<para><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>3</manvolnum></citerefentry>
automatically adds dependencies of type
<varname>Before=</varname> to the
<filename>sysroot.mount</filename> unit, which is generated
from the kernel command line.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>kbrequest.target</filename></term>
<listitem>
@ -538,29 +550,6 @@
SysV.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>initrd-root-device.target</filename></term>
<listitem>
<para>A special initrd target unit that is reached when the root filesystem device is available, but before
it has been mounted.
<citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>3</manvolnum></citerefentry>
and
<citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>3</manvolnum></citerefentry>
automatically setup the appropriate dependencies to make this happen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>initrd-root-fs.target</filename></term>
<listitem>
<para><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>3</manvolnum></citerefentry>
automatically adds dependencies of type
<varname>Before=</varname> to the
<filename>sysroot.mount</filename> unit, which is generated
from the kernel command line.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>runlevel2.target</filename></term>
<term><filename>runlevel3.target</filename></term>
@ -820,6 +809,17 @@
stopped.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>getty-pre.target</filename></term>
<listitem>
<para>A special passive target unit. Users of this target
are expected to pull it in the boot transaction via
a dependency (e.g. <varname>Wants=</varname>). Order your
unit before this unit if you want to make use of the console
just before <filename>getty</filename> is started.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>local-fs-pre.target</filename></term>
<listitem>

4
man/systemd.unit.xml
View file

@ -505,8 +505,8 @@
<listitem><para>Configures requirement dependencies on other units. If this unit gets activated, the units
listed here will be activated as well. If one of the other units fails to activate, and an ordering dependency
<varname>After=</varname> on the failing unit is set, this unit will not be started. Besides, with or without
specifying <varname>After=</varname>, this unit will be deactivated if one of the other units get deactivated.
This option may be specified more than once or multiple space-separated units may be
specifying <varname>After=</varname>, this unit will be stopped if one of the other units is explicitly
stopped. This option may be specified more than once or multiple space-separated units may be
specified in one option in which case requirement dependencies for all listed names will be created. Note that
requirement dependencies do not influence the order in which services are started or stopped. This has to be
configured independently with the <varname>After=</varname> or <varname>Before=</varname> options. If a unit

2
man/tmpfiles.d.xml
View file

@ -697,7 +697,7 @@ d /run/uscreens 0755 root screen 10d12h
</programlisting>
<para>Contents of <filename>/run/screens</filename> and /run/uscreens will
cleaned up after 10 and 10½ days, respectively.</para>
be cleaned up after 10 and 10½ days, respectively.</para>
</example>
<example>