chiark / gitweb /
man: docbook consitency fixes
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Sat, 26 Jan 2013 15:45:37 +0000 (10:45 -0500)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Sat, 26 Jan 2013 16:36:53 +0000 (11:36 -0500)
Use proper (or at least more proper) docbook tags for various
fields. This should help with automatic parsing of the documentation.

man/runlevel.xml
man/systemd-coredumpctl.xml
man/systemd-journal-gatewayd.service.xml
man/systemd-udevd.service.xml
man/udev.xml

index 02d5371..0ad4953 100644 (file)
 
                 <variablelist>
                         <varlistentry>
-                                <term><varname>/var/run/utmp</varname></term>
+                                <term><filename>/var/run/utmp</filename></term>
 
                                 <listitem><para>The utmp database
                                 <command>runlevel</command> reads the
index 53b82ed..87ed6fa 100644 (file)
 
                 <variablelist>
                         <varlistentry>
-                                <term><option>PID</option></term>
+                                <term><replaceable>PID</replaceable></term>
 
                                 <listitem><para>Process ID of the
                                 process that dumped
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>COMM</option></term>
+                                <term><replaceable>COMM</replaceable></term>
 
                                 <listitem><para>Name of the executable
                                 (matches <option>COREDUMP_COMM=</option>).
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>EXE</option></term>
+                                <term><replaceable>EXE</replaceable></term>
 
                                 <listitem><para>Path to the executable
                                 (matches <option>COREDUMP_EXE=</option>).
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>MATCH</option></term>
+                                <term><replaceable>MATCH</replaceable></term>
 
                                 <listitem><para>General journalctl predicates
                                 (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
index 37b39c2..44cd616 100644 (file)
@@ -124,13 +124,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <variablelist>
       <varlistentry>
-        <term><option>/browse</option></term>
+        <term><uri>/browse</uri></term>
 
         <listitem><para>Interactive browsing.</para></listitem>
       </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>
 
@@ -149,7 +149,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>/machine</option></term>
+        <term><uri>/machine</uri></term>
 
         <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>
-        <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>
@@ -179,14 +179,14 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <title>Accept header</title>
 
     <para>
-      <option>Accept: </option><replaceable>format</replaceable>
+      <option>Accept: <replaceable>format</replaceable></option>
     </para>
 
     <para>Recognized formats:</para>
 
     <variablelist>
       <varlistentry>
-        <term><option>text/plain</option></term>
+        <term><constant>text/plain</constant></term>
 
         <listitem><para>The default. Plaintext syslog-like output,
         one line per journal entry
@@ -195,7 +195,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>application/json</option></term>
+        <term><constant>application/json</constant></term>
 
         <listitem><para>Entries are formatted as JSON data structures,
         one per line
@@ -207,7 +207,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </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,
         wrapped in a format suitable for <ulink
@@ -219,7 +219,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </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
         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>
 
     <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>where
@@ -256,7 +256,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <variablelist>
       <varlistentry>
-        <term><option>follow</option></term>
+        <term><uri>follow</uri></term>
 
         <listitem><para>wait for new events
         (like <command>journalctl --follow</command>, except that
@@ -265,7 +265,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>discrete</option></term>
+        <term><uri>discrete</uri></term>
 
         <listitem><para>Test that the specified cursor refers to an
         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>
-        <term><option>boot</option></term>
+        <term><uri>boot</uri></term>
 
         <listitem><para>Limit events to the current boot of the system
         (like <command>journalctl --this--boot</command>).</para></listitem>
       </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
         <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
index 92fb38f..9fc59c1 100644 (file)
   <refsect1><title>Environment</title>
     <variablelist>
       <varlistentry>
-        <term><varname>UDEV_LOG=</varname></term>
+        <term><varname>$UDEV_LOG=</varname></term>
         <listitem>
           <para>Set the logging priority.</para>
         </listitem>
index 7ec7a3f..773635e 100644 (file)
@@ -65,7 +65,7 @@
       The following variables can be set:</para>
       <variablelist>
         <varlistentry>
-          <term><option>udev_log</option></term>
+          <term><varname>udev_log</varname></term>
           <listitem>
             <para>The logging priority. Valid values are the numerical syslog priorities
             or their textual representations: <option>err</option>, <option>info</option>
       operators are:</para>
       <variablelist>
         <varlistentry>
-          <term><option>==</option></term>
+          <term><literal>==</literal></term>
           <listitem>
             <para>Compare for equality.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term><option>!=</option></term>
+          <term><literal>!=</literal></term>
           <listitem>
             <para>Compare for inequality.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term><option>=</option></term>
+          <term><literal>=</literal></term>
           <listitem>
             <para>Assign a value to a key. Keys that represent a list are reset
             and only this single value is assigned.</para>
         </varlistentry>
 
         <varlistentry>
-          <term><option>+=</option></term>
+          <term><literal>+=</literal></term>
           <listitem>
             <para>Add the value to a key that holds a list of entries.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term><option>:=</option></term>
+          <term><literal>:=</literal></term>
           <listitem>
             <para>Assign  a  value  to  a key finally; disallow any later changes.</para>
           </listitem>
       pattern characters are supported:</para>
       <variablelist>
         <varlistentry>
-          <term><option>*</option></term>
+          <term><literal>*</literal></term>
           <listitem>
             <para>Matches zero or more characters.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><option>?</option></term>
+          <term><literal>?</literal></term>
           <listitem>
             <para>Matches any single character.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><option>[]</option></term>
+          <term><literal>[]</literal></term>
           <listitem>
             <para>Matches any single character specified within the brackets. For
             example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'.
         </varlistentry>
 
         <varlistentry>
-          <term><option>OWNER, GROUP, MODE</option></term>
+          <term><option>OWNER</option>, <option>GROUP</option>, <option>MODE</option></term>
           <listitem>
             <para>The permissions for the device node. Every specified value overrides
             the compiled-in default value.</para>
           <term><option>IMPORT{<replaceable>type</replaceable>}</option></term>
           <listitem>
             <para>Import a set of variables as device properties,
-            depending on <replaceable>type</replaceable>:</para>
+            depending on <literal>type</literal>:</para>
             <variablelist>
               <varlistentry>
-                <term><option>program</option></term>
+                <term><literal>program</literal></term>
                 <listitem>
                   <para>Execute an external program specified as the assigned value and
                   import its output, which must be in environment key
                 </listitem>
               </varlistentry>
               <varlistentry>
-                <term><option>file</option></term>
+                <term><literal>file</literal></term>
                 <listitem>
                   <para>Import a text file specified as the assigned value, the content
                   of which must be in environment key format.</para>
                 </listitem>
               </varlistentry>
               <varlistentry>
-                <term><option>db</option></term>
+                <term><literal>db</literal></term>
                 <listitem>
                   <para>Import a single property specified as the assigned value from the
                   current device database. This works only if the database is already populated
                 </listitem>
               </varlistentry>
               <varlistentry>
-                <term><option>cmdline</option></term>
+                <term><literal>cmdline</literal></term>
                 <listitem>
                   <para>Import a single property from the kernel command line. For simple flags
                   the value of the property is set to '1'.</para>
                 </listitem>
               </varlistentry>
               <varlistentry>
-                <term><option>parent</option></term>
+                <term><literal>parent</literal></term>
                 <listitem>
                   <para>Import the stored keys from the parent device by reading
                   the database entry of the parent device. The value assigned to
         </varlistentry>
 
         <varlistentry>
-          <term><option>%%</option></term>
+          <term><literal>%%</literal></term>
           <listitem>
           <para>The '%' character itself.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term><option>$$</option></term>
+          <term><literal>$$</literal></term>
           <listitem>
           <para>The '$' character itself.</para>
           </listitem>