man: document COREDUMP_UNIT and COREDUMP_USER_UNIT

[elogind.git] / man / systemd.journal-fields.xml

diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml
index d95cb011d91e1e4098ff095e7c4b3f564521b039..a0f1bfda13f3b7cd100d59fa0021d55e910fcd7a 100644 (file)
--- a/man/systemd.journal-fields.xml
+++ b/man/systemd.journal-fields.xml
@@ -212,13 +212,15 @@
                                 <term><varname>_SYSTEMD_CGROUP=</varname></term>
                                 <term><varname>_SYSTEMD_SESSION=</varname></term>
                                 <term><varname>_SYSTEMD_UNIT=</varname></term>
+                                <term><varname>_SYSTEMD_USER_UNIT=</varname></term>
                                 <term><varname>_SYSTEMD_OWNER_UID=</varname></term>
 
                                 <listitem>
                                         <para>The control group path in
                                         the systemd hierarchy, the
                                         systemd session ID (if any),
-                                        the systemd unit name (if any)
+                                        the systemd unit name (if any),
+                                        the systemd user session unit name (if any)
                                         and the owner UID of the
                                         systemd session (if any) of
                                         the process the journal entry
@@ -313,9 +315,9 @@
                 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
@@ -334,13 +336,13 @@
                                 </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
@@ -349,7 +351,7 @@
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term>_UDEV_DEVNODE=</term>
+                                <term><varname>_UDEV_DEVNODE=</varname></term>
                                 <listitem>
                                         <para>The device node path of
                                         this device in
@@ -357,7 +359,7 @@
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
-                                <term>_UDEV_DEVLINK=</term>
+                                <term><varname>_UDEV_DEVLINK=</varname></term>
                                 <listitem>
                                         <para>Additional symlink names
                                         pointing to the device node in
@@ -369,16 +371,43 @@
                 </variablelist>
         </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 the
-                addresses of journal entries are serialized into
-                fields prefixed with double underscores. Note that
-                these aren't proper fields when stored in the journal,
-                but addressing meta data of entries. They cannot be
-                written as part of structured log entries via calls
-                such as
+                <para>During serialization into external formats, such
+                as the <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/export">Journal
+                Export Format</ulink> or the <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/json">Journal
+                JSON Format</ulink>, the addresses of journal entries
+                are serialized into fields prefixed with double
+                underscores. Note that these aren't proper fields when
+                stored in the journal, but addressing meta data of
+                entries. They cannot be written as part of structured
+                log entries via calls such as
                 <citerefentry><refentrytitle>sd_journal_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>. They
                 may also not be used as matches for
                 <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>
@@ -439,7 +468,9 @@
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <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>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>