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

man: docbook consitency fixes

Browse source 
Use proper (or at least more proper) docbook tags for various
fields. This should help with automatic parsing of the documentation.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2013-01-26 10:45:37 -05:00
parent 652d0dd709
commit 6b76fa6619
5 changed files with 38 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
man/runlevel.xml
View file

@ -124,7 +124,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>/var/run/utmp</varname></term> <term><filename>/var/run/utmp</filename></term>
<listitem><para>The utmp database <listitem><para>The utmp database
<command>runlevel</command> reads the <command>runlevel</command> reads the

8
man/systemd-coredumpctl.xml
View file

@ -162,7 +162,7 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>PID</option></term> <term><replaceable>PID</replaceable></term>
<listitem><para>Process ID of the <listitem><para>Process ID of the
process that dumped process that dumped
@ -170,7 +170,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>COMM</option></term> <term><replaceable>COMM</replaceable></term>
<listitem><para>Name of the executable <listitem><para>Name of the executable
(matches <option>COREDUMP_COMM=</option>). (matches <option>COREDUMP_COMM=</option>).
@ -179,7 +179,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>EXE</option></term> <term><replaceable>EXE</replaceable></term>
<listitem><para>Path to the executable <listitem><para>Path to the executable
(matches <option>COREDUMP_EXE=</option>). (matches <option>COREDUMP_EXE=</option>).
@ -188,7 +188,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>MATCH</option></term> <term><replaceable>MATCH</replaceable></term>
<listitem><para>General journalctl predicates <listitem><para>General journalctl predicates
(see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>). (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).

28
man/systemd-journal-gatewayd.service.xml
View file

@ -124,13 +124,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>/browse</option></term> <term><uri>/browse</uri></term>
<listitem><para>Interactive browsing.</para></listitem> <listitem><para>Interactive browsing.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>/entries[?option1&amp;option2=value...]</option></term> <term><uri>/entries[?option1&amp;option2=value...]</uri></term>
<listitem><para>Retrieval of events in various formats.</para> <listitem><para>Retrieval of events in various formats.</para>
@ -149,7 +149,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>/machine</option></term> <term><uri>/machine</uri></term>
<listitem><para>Return a JSON structure describing the machine.</para> <listitem><para>Return a JSON structure describing the machine.</para>
@ -167,7 +167,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>/fields/</option><replaceable>FIELD_NAME</replaceable></term> <term><uri>/fields/<replaceable>FIELD_NAME</replaceable></uri></term>
<listitem><para>Return a list of values of this field present in the logs.</para> <listitem><para>Return a list of values of this field present in the logs.</para>
</listitem> </listitem>
@ -179,14 +179,14 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<title>Accept header</title> <title>Accept header</title>
<para> <para>
<option>Accept: </option><replaceable>format</replaceable> <option>Accept: <replaceable>format</replaceable></option>
</para> </para>
<para>Recognized formats:</para> <para>Recognized formats:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>text/plain</option></term> <term><constant>text/plain</constant></term>
<listitem><para>The default. Plaintext syslog-like output, <listitem><para>The default. Plaintext syslog-like output,
one line per journal entry one line per journal entry
@ -195,7 +195,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>application/json</option></term> <term><constant>application/json</constant></term>
<listitem><para>Entries are formatted as JSON data structures, <listitem><para>Entries are formatted as JSON data structures,
one per line one per line
@ -207,7 +207,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>application/event-stream</option></term> <term><constant>application/event-stream</constant></term>
<listitem><para>Entries are formatted as JSON data structures, <listitem><para>Entries are formatted as JSON data structures,
wrapped in a format suitable for <ulink wrapped in a format suitable for <ulink
@ -219,7 +219,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>application/vnd.fdo.journal</option></term> <term><constant>application/vnd.fdo.journal</constant></term>
<listitem><para>Entries are serialized into a binary (but <listitem><para>Entries are serialized into a binary (but
mostly text-based) stream suitable for backups and network mostly text-based) stream suitable for backups and network
@ -237,7 +237,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<title>Range header</title> <title>Range header</title>
<para> <para>
<option>Range: entries=&lt;cursor&gt;[[:&lt;num_skip&gt;]:&lt;num_entries&gt;]</option> <option>Range: entries=<replaceable>cursor</replaceable>[[:<replaceable>num_skip</replaceable>]:<replaceable>num_entries</replaceable>]</option>
</para> </para>
<para>where <para>where
@ -256,7 +256,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>follow</option></term> <term><uri>follow</uri></term>
<listitem><para>wait for new events <listitem><para>wait for new events
(like <command>journalctl --follow</command>, except that (like <command>journalctl --follow</command>, except that
@ -265,7 +265,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>discrete</option></term> <term><uri>discrete</uri></term>
<listitem><para>Test that the specified cursor refers to an <listitem><para>Test that the specified cursor refers to an
entry in the journal. Returns just this entry.</para> entry in the journal. Returns just this entry.</para>
@ -273,14 +273,14 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>boot</option></term> <term><uri>boot</uri></term>
<listitem><para>Limit events to the current boot of the system <listitem><para>Limit events to the current boot of the system
(like <command>journalctl --this--boot</command>).</para></listitem> (like <command>journalctl --this--boot</command>).</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>&lt;KEY&gt;=&lt;match&gt;</option></term> <term><uri><replaceable>KEY</replaceable>=<replaceable>match</replaceable></uri></term>
<listitem><para>Match journal fields. See <listitem><para>Match journal fields. See
<citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>

2
man/systemd-udevd.service.xml
View file

@ -118,7 +118,7 @@
<refsect1><title>Environment</title> <refsect1><title>Environment</title>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>UDEV_LOG=</varname></term> <term><varname>$UDEV_LOG=</varname></term>
<listitem> <listitem>
<para>Set the logging priority.</para> <para>Set the logging priority.</para>
</listitem> </listitem>

36
man/udev.xml
View file

@ -65,7 +65,7 @@
The following variables can be set:</para> The following variables can be set:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>udev_log</option></term> <term><varname>udev_log</varname></term>
<listitem> <listitem>
<para>The logging priority. Valid values are the numerical syslog priorities <para>The logging priority. Valid values are the numerical syslog priorities
or their textual representations: <option>err</option>, <option>info</option> or their textual representations: <option>err</option>, <option>info</option>
@ -107,21 +107,21 @@
operators are:</para> operators are:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>==</option></term> <term><literal>==</literal></term>
<listitem> <listitem>
<para>Compare for equality.</para> <para>Compare for equality.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>!=</option></term> <term><literal>!=</literal></term>
<listitem> <listitem>
<para>Compare for inequality.</para> <para>Compare for inequality.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>=</option></term> <term><literal>=</literal></term>
<listitem> <listitem>
<para>Assign a value to a key. Keys that represent a list are reset <para>Assign a value to a key. Keys that represent a list are reset
and only this single value is assigned.</para> and only this single value is assigned.</para>
@ -129,14 +129,14 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>+=</option></term> <term><literal>+=</literal></term>
<listitem> <listitem>
<para>Add the value to a key that holds a list of entries.</para> <para>Add the value to a key that holds a list of entries.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>:=</option></term> <term><literal>:=</literal></term>
<listitem> <listitem>
<para>Assign a value to a key finally; disallow any later changes.</para> <para>Assign a value to a key finally; disallow any later changes.</para>
</listitem> </listitem>
@ -297,19 +297,19 @@
pattern characters are supported:</para> pattern characters are supported:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>*</option></term> <term><literal>*</literal></term>
<listitem> <listitem>
<para>Matches zero or more characters.</para> <para>Matches zero or more characters.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>?</option></term> <term><literal>?</literal></term>
<listitem> <listitem>
<para>Matches any single character.</para> <para>Matches any single character.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>[]</option></term> <term><literal>[]</literal></term>
<listitem> <listitem>
<para>Matches any single character specified within the brackets. For <para>Matches any single character specified within the brackets. For
example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'. example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'.
@ -354,7 +354,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>OWNER, GROUP, MODE</option></term> <term><option>OWNER</option>, <option>GROUP</option>, <option>MODE</option></term>
<listitem> <listitem>
<para>The permissions for the device node. Every specified value overrides <para>The permissions for the device node. Every specified value overrides
the compiled-in default value.</para> the compiled-in default value.</para>
@ -427,10 +427,10 @@
<term><option>IMPORT{<replaceable>type</replaceable>}</option></term> <term><option>IMPORT{<replaceable>type</replaceable>}</option></term>
<listitem> <listitem>
<para>Import a set of variables as device properties, <para>Import a set of variables as device properties,
depending on <replaceable>type</replaceable>:</para> depending on <literal>type</literal>:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>program</option></term> <term><literal>program</literal></term>
<listitem> <listitem>
<para>Execute an external program specified as the assigned value and <para>Execute an external program specified as the assigned value and
import its output, which must be in environment key import its output, which must be in environment key
@ -439,14 +439,14 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>file</option></term> <term><literal>file</literal></term>
<listitem> <listitem>
<para>Import a text file specified as the assigned value, the content <para>Import a text file specified as the assigned value, the content
of which must be in environment key format.</para> of which must be in environment key format.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>db</option></term> <term><literal>db</literal></term>
<listitem> <listitem>
<para>Import a single property specified as the assigned value from the <para>Import a single property specified as the assigned value from the
current device database. This works only if the database is already populated current device database. This works only if the database is already populated
@ -454,14 +454,14 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>cmdline</option></term> <term><literal>cmdline</literal></term>
<listitem> <listitem>
<para>Import a single property from the kernel command line. For simple flags <para>Import a single property from the kernel command line. For simple flags
the value of the property is set to '1'.</para> the value of the property is set to '1'.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>parent</option></term> <term><literal>parent</literal></term>
<listitem> <listitem>
<para>Import the stored keys from the parent device by reading <para>Import the stored keys from the parent device by reading
the database entry of the parent device. The value assigned to the database entry of the parent device. The value assigned to
@ -677,14 +677,14 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>%%</option></term> <term><literal>%%</literal></term>
<listitem> <listitem>
<para>The '%' character itself.</para> <para>The '%' character itself.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>$$</option></term> <term><literal>$$</literal></term>
<listitem> <listitem>
<para>The '$' character itself.</para> <para>The '$' character itself.</para>
</listitem> </listitem>