chiark / gitweb /
man: document COREDUMP_UNIT and COREDUMP_USER_UNIT
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 7 Feb 2013 05:50:37 +0000 (00:50 -0500)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 7 Feb 2013 06:02:34 +0000 (01:02 -0500)
Also fix formatting for kernel related fields, enabling them
to show up in the directives index.

man/systemd.journal-fields.xml

index 2e9bc5b..a0f1bfd 100644 (file)
                 messages originating in the kernel and stored in the
                 journal.</para>
 
-                <variablelist>
+                <variablelist class='journal-directives'>
                         <varlistentry>
-                                <term>_KERNEL_DEVICE=</term>
+                                <term><varname>_KERNEL_DEVICE=</varname></term>
                                 <listitem>
                                         <para>The kernel device
                                         name. If the entry is
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term>_KERNEL_SUBSYSTEM=</term>
+                                <term><varname>_KERNEL_SUBSYSTEM=</varname></term>
                                 <listitem>
                                         <para>The kernel subsystem name.</para>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term>_UDEV_SYSNAME=</term>
+                                <term><varname>_UDEV_SYSNAME=</varname></term>
                                 <listitem>
                                         <para>The kernel device name
                                         as it shows up in the device
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term>_UDEV_DEVNODE=</term>
+                                <term><varname>_UDEV_DEVNODE=</varname></term>
                                 <listitem>
                                         <para>The device node path of
                                         this device in
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term>_UDEV_DEVLINK=</term>
+                                <term><varname>_UDEV_DEVLINK=</varname></term>
                                 <listitem>
                                         <para>Additional symlink names
                                         pointing to the device node in
         </refsect1>
 
         <refsect1>
+                <title>Special Journal Fields</title>
+
+                <para>Fields used by the <command>systemd-coredump</command>
+                coredump kernel helper.
+                </para>
+
+                <variablelist class='journal-directives'>
+                        <varlistentry>
+                                <term><varname>COREDUMP_UNIT=</varname></term>
+                                <term><varname>COREDUMP_USER_UNIT=</varname></term>
+                                <listitem>
+                                        <para>Used to annotate
+                                        messages containing coredumps from
+                                        system and session units.
+                                        See
+                                        <citerefentry><refentrytitle>systemd-coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
+                                        </para>
+                                </listitem>
+                        </varlistentry>
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
                 <title>Address Fields</title>
 
                 <para>During serialization into external formats, such
                           <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                   </para>
         </refsect1>