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

Merge pull request #11707 from keszybz/man-directives-spring-cleaning 

systemd.directives(7) spring cleaning
This commit is contained in:
Lennart Poettering 2019-02-13 16:35:00 +01:00 committed by GitHub
parent b35d6d828b 6772ce6e11
commit 2e86089fdf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
20 changed files with 99 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man/coredump.conf.xml
View File

@ -54,7 +54,7 @@
<para>All options are configured in the
<literal>[Coredump]</literal> section:</para>
<variablelist>
<variablelist class='config-directives'>
<varlistentry>
<term><varname>Storage=</varname></term>

2
man/journal-remote.conf.xml
View File

@ -51,7 +51,7 @@
<para>All options are configured in the
<literal>[Remote]</literal> section:</para>
<variablelist>
<variablelist class='config-directives'>
<varlistentry>
<term><varname>Seal=</varname></term>

2
man/journal-upload.conf.xml
View File

@ -48,7 +48,7 @@
<para>All options are configured in the <literal>[Upload]</literal> section:</para>
<variablelist>
<variablelist class='config-directives'>
<varlistentry>
<term><varname>URL=</varname></term>

2
man/journald.conf.xml
View File

@ -50,7 +50,7 @@
<para>All options are configured in the
<literal>[Journal]</literal> section:</para>
<variablelist>
<variablelist class='config-directives'>
<varlistentry>
<term><varname>Storage=</varname></term>

2
man/logind.conf.xml
View File

@ -51,7 +51,7 @@
<para>All options are configured in the
<literal>[Login]</literal> section:</para>
<variablelist>
<variablelist class='config-directives'>
<varlistentry>
<term><varname>NAutoVTs=</varname></term>

2
man/machine-info.xml
View File

@ -58,7 +58,7 @@
<para>The following machine metadata parameters may be set using
<filename>/etc/machine-info</filename>:</para>
<variablelist>
<variablelist class='environment-variables'>
<varlistentry>
<term><varname>PRETTY_HOSTNAME=</varname></term>

2
man/os-release.xml
View File

@ -90,7 +90,7 @@
<para>The following OS identifications parameters may be set using
<filename>os-release</filename>:</para>
<variablelist>
<variablelist class='environment-variables'>
<varlistentry>
<term><varname>NAME=</varname></term>

16
man/pam_systemd.xml
View File

@ -82,7 +82,7 @@
<variablelist class='pam-directives'>
<varlistentry>
<term><option>class=</option></term>
<term><varname>class=</varname></term>
<listitem><para>Takes a string argument which sets the session class. The <varname>XDG_SESSION_CLASS</varname>
environment variable (see below) takes precedence. One of <literal>user</literal>, <literal>greeter</literal>,
@ -92,7 +92,7 @@
</varlistentry>
<varlistentry>
<term><option>type=</option></term>
<term><varname>type=</varname></term>
<listitem><para>Takes a string argument which sets the session type. The <varname>XDG_SESSION_TYPE</varname>
environment variable (see below) takes precedence. One of <literal>unspecified</literal>,
@ -102,7 +102,7 @@
</varlistentry>
<varlistentry>
<term><option>desktop=</option></term>
<term><varname>desktop=</varname></term>
<listitem><para>Takes a single, short identifier string for the desktop environment. The
<varname>XDG_SESSION_DESKTOP</varname> environment variable (see below) takes precedence. This may be used to
@ -117,7 +117,7 @@
</varlistentry>
<varlistentry>
<term><option>debug<optional>=</optional></option></term>
<term><varname>debug</varname><optional>=</optional></term>
<listitem><para>Takes an optional boolean argument. If yes or without the argument, the module will log
debugging information as it operates.</para></listitem>
@ -186,21 +186,21 @@
<varlistentry>
<term><varname>$XDG_SESSION_TYPE</varname></term>
<listitem><para>The session type. This may be used instead of <option>session=</option> on the module parameter
<listitem><para>The session type. This may be used instead of <varname>session=</varname> on the module parameter
line, and is usually preferred.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>$XDG_SESSION_CLASS</varname></term>
<listitem><para>The session class. This may be used instead of <option>class=</option> on the module parameter
<listitem><para>The session class. This may be used instead of <varname>class=</varname> on the module parameter
line, and is usually preferred.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>$XDG_SESSION_DESKTOP</varname></term>
<listitem><para>The desktop identifier. This may be used instead of <option>desktop=</option> on the module
<listitem><para>The desktop identifier. This may be used instead of <varname>desktop=</varname> on the module
parameter line, and is usually preferred.</para></listitem>
</varlistentry>
@ -242,7 +242,7 @@
the context objects.
</para>
<variablelist>
<variablelist class='pam-directives'>
<varlistentry>
<term><varname>systemd.memory_max</varname></term>

62
man/sd-bus-errors.xml
View File

@ -112,7 +112,7 @@
<variablelist>
<varlistentry>
<term><varname>SD_BUS_ERROR_FAILED</varname></term>
<term><constant>SD_BUS_ERROR_FAILED</constant></term>
<listitem><para>A generic error indication. See the error
message for further details. This error name should be
avoided, in favor of a more expressive error
@ -120,134 +120,134 @@
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_NO_MEMORY</varname></term>
<term><constant>SD_BUS_ERROR_NO_MEMORY</constant></term>
<listitem><para>A memory allocation failed, and the requested
operation could not be completed.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_SERVICE_UNKNOWN</varname></term>
<term><constant>SD_BUS_ERROR_SERVICE_UNKNOWN</constant></term>
<listitem><para>The contacted bus service is unknown and
cannot be activated.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_NAME_HAS_NO_OWNER</varname></term>
<term><constant>SD_BUS_ERROR_NAME_HAS_NO_OWNER</constant></term>
<listitem><para>The specified bus service name currently has
no owner.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_NO_REPLY</varname></term>
<term><constant>SD_BUS_ERROR_NO_REPLY</constant></term>
<listitem><para>A message did not receive a reply. This error
is usually generated after a timeout.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_IO_ERROR</varname></term>
<term><constant>SD_BUS_ERROR_IO_ERROR</constant></term>
<listitem><para>Generic input/output error, for example when
accessing a socket or other I/O context.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_BAD_ADDRESS</varname></term>
<term><constant>SD_BUS_ERROR_BAD_ADDRESS</constant></term>
<listitem><para>The specified D-Bus bus address string is
malformed.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_NOT_SUPPORTED</varname></term>
<term><constant>SD_BUS_ERROR_NOT_SUPPORTED</constant></term>
<listitem><para>The requested operation is not supported on
the local system.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_LIMITS_EXCEEDED</varname></term>
<term><constant>SD_BUS_ERROR_LIMITS_EXCEEDED</constant></term>
<listitem><para>Some limited resource has been
exhausted.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_ACCESS_DENIED</varname></term>
<term><constant>SD_BUS_ERROR_ACCESS_DENIED</constant></term>
<listitem><para>Access to a resource has been denied due to security restrictions.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_AUTH_FAILED</varname></term>
<term><constant>SD_BUS_ERROR_AUTH_FAILED</constant></term>
<listitem><para>Authentication did not complete successfully.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_NO_SERVER</varname></term>
<term><constant>SD_BUS_ERROR_NO_SERVER</constant></term>
<listitem><para>Unable to connect to the specified server.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_TIMEOUT</varname></term>
<term><constant>SD_BUS_ERROR_TIMEOUT</constant></term>
<listitem><para>An operation timed out. Note that method calls
which timeout generate a
<varname>SD_BUS_ERROR_NO_REPLY</varname>.</para></listitem>
<constant>SD_BUS_ERROR_NO_REPLY</constant>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_NO_NETWORK</varname></term>
<term><constant>SD_BUS_ERROR_NO_NETWORK</constant></term>
<listitem><para>No network available to execute requested network operation on.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_ADDRESS_IN_USE</varname></term>
<term><constant>SD_BUS_ERROR_ADDRESS_IN_USE</constant></term>
<listitem><para>The specified network address is already being listened on.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_DISCONNECTED</varname></term>
<term><constant>SD_BUS_ERROR_DISCONNECTED</constant></term>
<listitem><para>The connection has been terminated.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_INVALID_ARGS</varname></term>
<term><constant>SD_BUS_ERROR_INVALID_ARGS</constant></term>
<listitem><para>One or more invalid arguments have been passed.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_FILE_NOT_FOUND</varname></term>
<term><constant>SD_BUS_ERROR_FILE_NOT_FOUND</constant></term>
<listitem><para>The requested file could not be found.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_FILE_EXISTS</varname></term>
<term><constant>SD_BUS_ERROR_FILE_EXISTS</constant></term>
<listitem><para>The requested file already exists.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_UNKNOWN_METHOD</varname></term>
<term><constant>SD_BUS_ERROR_UNKNOWN_METHOD</constant></term>
<listitem><para>The requested method does not exist in the selected interface.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_UNKNOWN_OBJECT</varname></term>
<term><constant>SD_BUS_ERROR_UNKNOWN_OBJECT</constant></term>
<listitem><para>The requested object does not exist in the selected service.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_UNKNOWN_INTERFACE</varname></term>
<term><constant>SD_BUS_ERROR_UNKNOWN_INTERFACE</constant></term>
<listitem><para>The requested interface does not exist on the selected object.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_UNKNOWN_PROPERTY</varname></term>
<term><constant>SD_BUS_ERROR_UNKNOWN_PROPERTY</constant></term>
<listitem><para>The requested property does not exist in the selected interface.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_PROPERTY_READ_ONLY</varname></term>
<term><constant>SD_BUS_ERROR_PROPERTY_READ_ONLY</constant></term>
<listitem><para>A write operation was requested on a read-only property.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</varname></term>
<term><constant>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</constant></term>
<listitem><para>The requested PID is not known.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_INVALID_SIGNATURE</varname></term>
<term><constant>SD_BUS_ERROR_INVALID_SIGNATURE</constant></term>
<listitem><para>The specified message signature is not
valid.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_INCONSISTENT_MESSAGE</varname></term>
<term><constant>SD_BUS_ERROR_INCONSISTENT_MESSAGE</constant></term>
<listitem><para>The passed message does not validate
correctly.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</varname></term>
<term><constant>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</constant></term>
<listitem><para>The specified match rule does not exist.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_MATCH_RULE_INVALID</varname></term>
<term><constant>SD_BUS_ERROR_MATCH_RULE_INVALID</constant></term>
<listitem><para>The specified match rule is invalid.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</varname></term>
<term><constant>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</constant></term>
<listitem><para>Access to the requested operation is not
permitted. However, it might be available after interactive
authentication. This is usually returned by method calls

2
man/sd-login.xml
View File

@ -148,7 +148,7 @@
<para>Assignment of hardware devices to seats is managed inside the udev database, via
settings on the devices:</para>
<variablelist>
<variablelist class='udev-directives'>
<varlistentry>
<term>Tag <literal>seat</literal></term>

14
man/sd_bus_request_name.xml
View File

@ -74,23 +74,23 @@
<variablelist>
<varlistentry>
<term><varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname></term>
<term><constant>SD_BUS_NAME_ALLOW_REPLACEMENT</constant></term>
<listitem><para>After acquiring the name successfully, permit other peers to take over the name when they try
to acquire it with the <varname>SD_BUS_NAME_REPLACE_EXISTING</varname> flag set. If
<varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname> is not set on the original request, such a request by other
to acquire it with the <constant>SD_BUS_NAME_REPLACE_EXISTING</constant> flag set. If
<constant>SD_BUS_NAME_ALLOW_REPLACEMENT</constant> is not set on the original request, such a request by other
peers will be denied.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_NAME_REPLACE_EXISTING</varname></term>
<term><constant>SD_BUS_NAME_REPLACE_EXISTING</constant></term>
<listitem><para>Take over the name if it is already acquired by another peer, and that other peer has permitted
takeover by setting <varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname> while acquiring it.</para></listitem>
takeover by setting <constant>SD_BUS_NAME_ALLOW_REPLACEMENT</constant> while acquiring it.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SD_BUS_NAME_QUEUE</varname></term>
<term><constant>SD_BUS_NAME_QUEUE</constant></term>
<listitem><para>Queue the acquisition of the name when the name is already taken.</para></listitem>
</varlistentry>
@ -130,7 +130,7 @@
<para>On success, these calls return 0 or a positive integer. On failure, these calls return a negative errno-style
error code.</para>
<para>If <varname>SD_BUS_NAME_QUEUE</varname> is specified, <function>sd_bus_request_name()</function> will return
<para>If <constant>SD_BUS_NAME_QUEUE</constant> is specified, <function>sd_bus_request_name()</function> will return
0 when the name is already taken by another peer and the client has been added to the queue for the name. In that
case, the caller can subscribe to <literal>NameOwnerChanged</literal> signals to be notified when the name is
successfully acquired. <function>sd_bus_request_name()</function> returns &gt; 0 when the name has immediately

2
man/systemd-boot.xml
View File

@ -243,7 +243,7 @@
UUID <literal>4a67b082-0a4c-41cf-b6c7-440b29bb8c4</literal>, for communication between the OS and the boot
loader:</para>
<variablelist>
<variablelist class='efi-variables'>
<varlistentry>
<term><varname>LoaderBootCountPath</varname></term>
<listitem><para>If boot counting is enabled, contains the path to the file in whose name the boot counters are

2
man/systemd-sleep.conf.xml
View File

@ -112,7 +112,7 @@
<filename>/etc/systemd/sleep.conf</filename> or a
<filename>sleep.conf.d</filename> file:</para>
<variablelist class='systemd-directives'>
<variablelist class='config-directives'>
<varlistentry>
<term><varname>AllowSuspend=</varname></term>
<term><varname>AllowHibernation=</varname></term>

2
man/systemd-system.conf.xml
View File

@ -63,7 +63,7 @@
<para>All options are configured in the
<literal>[Manager]</literal> section:</para>
<variablelist class='systemd-directives'>
<variablelist class='config-directives'>
<varlistentry>
<term><varname>LogLevel=</varname></term>

16
man/systemd.exec.xml
View File

@ -393,7 +393,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
<refsect1>
<title>Mandatory Access Control</title>
<variablelist>
<variablelist class='unit-directives'>
<varlistentry>
<term><varname>SELinuxContext=</varname></term>
@ -436,7 +436,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
<refsect1>
<title>Process Properties</title>
<variablelist>
<variablelist class='unit-directives'>
<varlistentry>
<term><varname>LimitCPU=</varname></term>
@ -671,7 +671,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
<refsect1>
<title>Scheduling</title>
<variablelist>
<variablelist class='unit-directives'>
<varlistentry>
<term><varname>Nice=</varname></term>
@ -764,7 +764,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
(such as <varname>ProtectSystem=</varname>) are not available, as the underlying kernel functionality is only
accessible to privileged processes.</para>
<variablelist>
<variablelist class='unit-directives'>
<varlistentry>
<term><varname>ProtectSystem=</varname></term>
@ -1388,7 +1388,7 @@ RestrictNamespaces=~cgroup net</programlisting>
<refsect1>
<title>System Call Filtering</title>
<variablelist>
<variablelist class='unit-directives'>
<varlistentry>
<term><varname>SystemCallFilter=</varname></term>
@ -1627,7 +1627,7 @@ SystemCallErrorNumber=EPERM</programlisting>
<refsect1>
<title>Environment</title>
<variablelist>
<variablelist class='unit-directives'>
<varlistentry>
<term><varname>Environment=</varname></term>
@ -1742,7 +1742,7 @@ SystemCallErrorNumber=EPERM</programlisting>
<refsect1>
<title>Logging and Standard Input/Output</title>
<variablelist>
<variablelist class='unit-directives'>
<varlistentry>
<term><varname>StandardInput=</varname></term>
@ -2084,7 +2084,7 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy
<refsect1>
<title>System V Compatibility</title>
<variablelist>
<variablelist class='unit-directives'>
<varlistentry>
<term><varname>UtmpIdentifier=</varname></term>

6
man/systemd.netdev.xml
View File

@ -899,15 +899,15 @@
<varlistentry>
<term><varname>FOUDestinationPort=</varname></term>
<listitem>
<para>The <varname>FOUDestinationPort=</varname> specifies the UDP destination port for encapsulation.
<para>This setting specifies the UDP destination port for encapsulation.
This field is mandatory and is not set by default.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>FOUSourcePort=</varname></term>
<listitem>
<para>The <constant>FOUSourcePort=</constant> specifies the UDP source port for encapsulation. Defaults to <varname>0</varname>,
that is, the source port for packets is left to the network stack to decide.</para>
<para>This setting specifies the UDP source port for encapsulation. Defaults to <constant>0</constant>
— that is, the source port for packets is left to the network stack to decide.</para>
</listitem>
</varlistentry>
<varlistentry>

6
man/systemd.nspawn.xml
View File

@ -112,7 +112,7 @@
<para>Settings files may include an <literal>[Exec]</literal>
section, which carries various execution parameters:</para>
<variablelist>
<variablelist class='nspawn-directives'>
<varlistentry>
<term><varname>Boot=</varname></term>
@ -374,7 +374,7 @@
section, which carries various parameters configuring the file
system of the container:</para>
<variablelist>
<variablelist class='nspawn-directives'>
<varlistentry>
<term><varname>ReadOnly=</varname></term>
@ -458,7 +458,7 @@
section, which carries various parameters configuring the network
connectivity of the container:</para>
<variablelist>
<variablelist class='nspawn-directives'>
<varlistentry>
<term><varname>Private=</varname></term>

2
man/udev.conf.xml
View File

@ -40,7 +40,7 @@
ignored. The following variables can be set:
</para>
<variablelist>
<variablelist class='config-directives'>
<varlistentry>
<term><varname>udev_log=</varname></term>

2
man/vconsole.conf.xml
View File

@ -68,7 +68,7 @@
<para>The following options are understood:</para>
<variablelist>
<variablelist class='environment-variables'>
<varlistentry>
<term><varname>KEYMAP=</varname></term>

33
tools/make-directive-index.py
View File

@ -46,12 +46,22 @@ TEMPLATE = '''\
<refsect1>
<title>Environment variables</title>
<para>Environment variables understood by the systemd
manager and other programs.</para>
<para>Environment variables understood by the systemd manager
and other programs and environment variable-compatible settings.</para>
<variablelist id='environment-variables' />
</refsect1>
<refsect1>
<title>EFI variables</title>
<para>EFI variables understood by
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>
and other programs.</para>
<variablelist id='efi-variables' />
</refsect1>
<refsect1>
<title>UDEV directives</title>
@ -98,16 +108,25 @@ TEMPLATE = '''\
</refsect1>
<refsect1>
<title>System manager directives</title>
<title><citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry>
directives</title>
<para>Directives for configuring the behaviour of the
systemd process.</para>
<para>Directives for configuring systemd-nspawn containers.</para>
<variablelist id='systemd-directives' />
<variablelist id='nspawn-directives' />
</refsect1>
<refsect1>
<title>command line options</title>
<title>Program configuration options</title>
<para>Directives for configuring the behaviour of the
systemd process and other tools through configuration files.</para>
<variablelist id='config-directives' />
</refsect1>
<refsect1>
<title>Command line options</title>
<para>Command-line options accepted by programs in the
systemd suite.</para>