mirror of
https://github.com/systemd/systemd.git
synced 2024-12-22 17:35:35 +03:00
man: fix a few bogus entries in directives index
When wrong element types are used, directives are sometimes placed in the wrong section. Also, strip part of text starting with "'", which is used in a few places and which is displayed improperly in the index.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek
parent
b0343f8c96
commit
f8b68539d0
@ -102,7 +102,7 @@
|
||||
|
||||
<listitem><para>In the daemon process, write the daemon PID
|
||||
(as returned by <function>getpid()</function>) to a PID file,
|
||||
for example <filename>/run/foobar.pid</filename> (for a
|
||||
for example <filename index='false'>/run/foobar.pid</filename> (for a
|
||||
hypothetical daemon "foobar") to ensure that the daemon cannot
|
||||
be started more than once. This must be implemented in
|
||||
race-free fashion so that the PID file is only updated when it
|
||||
|
||||
@ -50,7 +50,7 @@
|
||||
<term><varname>URL=</varname></term>
|
||||
|
||||
<listitem><para>The URL to upload the journal entries to. See the description
|
||||
of <varname>--url=</varname> option in
|
||||
of <option>--url=</option> option in
|
||||
<citerefentry><refentrytitle>systemd-journal-upload</refentrytitle><manvolnum>8</manvolnum></citerefentry>
|
||||
for the description of possible values. There is no default value, so either this
|
||||
option or the command-line option must be always present to make an upload.</para></listitem>
|
||||
|
||||
@ -27,7 +27,7 @@
|
||||
|
||||
<para>Users might want to change two options in particular:</para>
|
||||
|
||||
<variablelist class='environment-variables'>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>K</option></term>
|
||||
|
||||
|
||||
@ -42,7 +42,7 @@
|
||||
|
||||
<para>If <command>systemd-cgtop</command> is not connected to a
|
||||
tty, no column headers are printed and the default is to only run
|
||||
one iteration. The <varname>--iterations=</varname> argument, if
|
||||
one iteration. The <option>--iterations=</option> argument, if
|
||||
given, is honored. This mode is suitable for scripting.</para>
|
||||
|
||||
<para>Resource usage is only accounted for control groups in the
|
||||
|
||||
@ -51,7 +51,7 @@
|
||||
<para><filename>systemd-fsck</filename> does not know any details
|
||||
about specific filesystems, and simply executes file system
|
||||
checkers specific to each filesystem type
|
||||
(<filename>/sbin/fsck.*</filename>). These checkers will decide if
|
||||
(<filename>/sbin/fsck.<replaceable>type</replaceable></filename>). These checkers will decide if
|
||||
the filesystem should actually be checked based on the time since
|
||||
last check, number of mounts, unclean unmount, etc.</para>
|
||||
|
||||
|
||||
@ -51,7 +51,7 @@
|
||||
<para><filename>systemd-makefs</filename> knows very little about specific file
|
||||
systems and swap devices, and after checking that the block device does not already
|
||||
contain a file system or other content, it will execute binaries specific to
|
||||
each filesystem type (<filename>/sbin/mkfs.*</filename>).</para>
|
||||
each filesystem type (<filename>/sbin/mkfs.<replaceable>type</replaceable></filename>).</para>
|
||||
|
||||
<para><filename>systemd-growfs</filename> knows very little about specific file
|
||||
systems and swap devices, and will instruct the kernel to grow the mounted
|
||||
|
||||
@ -356,11 +356,12 @@
|
||||
<para>Example: if a unit has the following,
|
||||
<programlisting>CapabilityBoundingSet=CAP_A CAP_B
|
||||
CapabilityBoundingSet=CAP_B CAP_C</programlisting>
|
||||
then <constant>CAP_A</constant>, <constant>CAP_B</constant>, and <constant>CAP_C</constant> are set.
|
||||
If the second line is prefixed with <literal>~</literal>, e.g.,
|
||||
then <constant index='false'>CAP_A</constant>, <constant index='false'>CAP_B</constant>, and
|
||||
<constant index='false'>CAP_C</constant> are set. If the second line is prefixed with
|
||||
<literal>~</literal>, e.g.,
|
||||
<programlisting>CapabilityBoundingSet=CAP_A CAP_B
|
||||
CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
|
||||
then, only <constant>CAP_A</constant> is set.</para></listitem>
|
||||
then, only <constant index='false'>CAP_A</constant> is set.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
@ -994,8 +995,10 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
|
||||
<para>Example: if a system service unit has the following,
|
||||
<programlisting>RuntimeDirectory=foo/bar baz</programlisting>
|
||||
the service manager creates <filename>/run/foo</filename> (if it does not exist),
|
||||
<filename>/run/foo/bar</filename>, and <filename>/run/baz</filename>. The directories
|
||||
<filename>/run/foo/bar</filename> and <filename>/run/baz</filename> except <filename>/run/foo</filename> are
|
||||
|
||||
<filename index='false'>/run/foo/bar</filename>, and <filename index='false'>/run/baz</filename>. The
|
||||
directories <filename index='false'>/run/foo/bar</filename> and
|
||||
<filename index='false'>/run/baz</filename> except <filename index='false'>/run/foo</filename> are
|
||||
owned by the user and group specified in <varname>User=</varname> and <varname>Group=</varname>, and removed
|
||||
when the service is stopped.</para>
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>/path/to/generator</command>
|
||||
<command index='false'>/path/to/generator</command>
|
||||
<arg choice="plain"><replaceable>normal-dir</replaceable></arg>
|
||||
<arg choice="plain"><replaceable>early-dir</replaceable></arg>
|
||||
<arg choice="plain"><replaceable>late-dir</replaceable></arg>
|
||||
|
||||
@ -91,7 +91,7 @@
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>CPU</option></term>
|
||||
<term>CPU</term>
|
||||
<listitem>
|
||||
<para><varname>CPUWeight=</varname> and <varname>StartupCPUWeight=</varname> replace
|
||||
<varname>CPUShares=</varname> and <varname>StartupCPUShares=</varname>, respectively.</para>
|
||||
@ -101,7 +101,7 @@
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>Memory</option></term>
|
||||
<term>Memory</term>
|
||||
<listitem>
|
||||
<para><varname>MemoryMax=</varname> replaces <varname>MemoryLimit=</varname>. <varname>MemoryLow=</varname>
|
||||
and <varname>MemoryHigh=</varname> are effective only on unified hierarchy.</para>
|
||||
@ -109,10 +109,11 @@
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>IO</option></term>
|
||||
<term>IO</term>
|
||||
<listitem>
|
||||
<para><varname>IO</varname> prefixed settings are a superset of and replace <varname>BlockIO</varname>
|
||||
prefixed ones. On unified hierarchy, IO resource control also applies to buffered writes.</para>
|
||||
<para><literal>IO</literal>-prefixed settings are a superset of and replace
|
||||
<literal>BlockIO</literal>-prefixed ones. On unified hierarchy, IO resource control also applies
|
||||
to buffered writes.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
||||
@ -574,8 +574,8 @@
|
||||
<varlistentry>
|
||||
<term><varname>TimeoutStopSec=</varname></term>
|
||||
<listitem><para>This option serves two purposes. First, it configures the time to wait for each
|
||||
<constant>ExecStop=</constant> command. If any of them times out, subsequent <constant>ExecStop=</constant> commands
|
||||
are skipped and the service will be terminated by <constant>SIGTERM</constant>. If no <constant>ExecStop=</constant>
|
||||
<varname>ExecStop=</varname> command. If any of them times out, subsequent <varname>ExecStop=</varname> commands
|
||||
are skipped and the service will be terminated by <constant>SIGTERM</constant>. If no <varname>ExecStop=</varname>
|
||||
commands are specified, the service gets the <constant>SIGTERM</constant> immediately. Second, it configures the time
|
||||
to wait for the service itself to stop. If it doesn't terminate in the specified time, it will be forcibly terminated
|
||||
by <constant>SIGKILL</constant> (see <varname>KillMode=</varname> in
|
||||
|
||||
@ -48,7 +48,7 @@
|
||||
<filename>/run/systemd/system/*</filename>
|
||||
<filename>/run/systemd/systemd.attached/*</filename>
|
||||
<filename>/run/systemd/generator/*</filename>
|
||||
<filename>…</filename>
|
||||
<filename index='false'>…</filename>
|
||||
<filename>/usr/lib/systemd/system/*</filename>
|
||||
<filename>/run/systemd/generator.late/*</filename></literallayout></para>
|
||||
</refsect2>
|
||||
@ -65,7 +65,7 @@
|
||||
<filename>/run/systemd/user/*</filename>
|
||||
<filename>$XDG_RUNTIME_DIR/systemd/generator/*</filename>
|
||||
<filename>~/.local/share/systemd/user/*</filename>
|
||||
<filename>…</filename>
|
||||
<filename index='false'>…</filename>
|
||||
<filename>/usr/lib/systemd/user/*</filename>
|
||||
<filename>$XDG_RUNTIME_DIR/systemd/generator.late/*</filename></literallayout></para>
|
||||
</refsect2>
|
||||
|
||||
@ -33,7 +33,7 @@
|
||||
<para><literallayout><filename>~/.config/user-tmpfiles.d/*.conf</filename>
|
||||
<filename>$XDG_RUNTIME_DIR/user-tmpfiles.d/*.conf</filename>
|
||||
<filename>~/.local/share/user-tmpfiles.d/*.conf</filename>
|
||||
<filename>…</filename>
|
||||
<filename index='false'>…</filename>
|
||||
<filename>/usr/share/user-tmpfiles.d/*.conf</filename>
|
||||
</literallayout></para>
|
||||
|
||||
|
||||
@ -190,7 +190,7 @@ def _extract_directives(directive_groups, formatting, page):
|
||||
stor[text].append((pagename, section))
|
||||
if text not in formatting:
|
||||
# use element as formatted display
|
||||
if name.text[-1] in '= ':
|
||||
if name.text[-1] in "= '":
|
||||
name.clear()
|
||||
else:
|
||||
name.tail = ''
|
||||
|
||||
Loading…
Reference in New Issue
Block a user