dbus: make more cgroup attributes runtime settable

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

diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml
index d95cb011d91e1e4098ff095e7c4b3f564521b039..fe65078f76c0addec440b627297082c3c3413853 100644 (file)
--- a/man/systemd.journal-fields.xml
+++ b/man/systemd.journal-fields.xml
@@ -100,9 +100,9 @@
                                         enforced, and formatted
                                         differently. Developers can
                                         generate a new ID for this
                                         enforced, and formatted
                                         differently. Developers can
                                         generate a new ID for this

-                                        purpose with
-                                        <command>journalctl
-                                        --new-id</command>.</para>
+                                        purpose with <command>journalctl
+                                        <option>--new-id</option></command>.
+                                        </para>

                                 </listitem>
                         </varlistentry>
 
                                 </listitem>
                         </varlistentry>
 


@@ -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_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),
                                 <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
                                         and the owner UID of the
                                         systemd session (if any) of
                                         the process the journal entry


@@ -284,23 +286,75 @@
                                 <listitem>
                                         <para>How the entry was
                                         received by the journal
                                 <listitem>
                                         <para>How the entry was
                                         received by the journal

-                                        service. One of
-                                        <literal>driver</literal>,
-                                        <literal>syslog</literal>,
-                                        <literal>journal</literal>,
-                                        <literal>stdout</literal>,
-                                        <literal>kernel</literal> for
-                                        internally generated messages,
-                                        for those received via the
-                                        local syslog socket with the
-                                        syslog protocol, for those
-                                        received via the native
-                                        journal protocol, for the
-                                        those read from a services'
-                                        standard output or error
-                                        output, or for those read
-                                        from the kernel, respectively.
+                                        service. Valid transports are:

                                         </para>
                                         </para>

+                                        <variablelist>
+                                                <varlistentry>
+                                                        <term>
+                                                                <option>driver</option>
+                                                        </term>
+                                                        <listitem>
+                                                                <para>for
+                                                                internally
+                                                                generated
+                                                                messages
+                                                                </para>
+                                                        </listitem>
+                                                </varlistentry>
+
+                                                <varlistentry>
+                                                        <term>
+                                                                <option>syslog</option>
+                                                        </term>
+                                                        <listitem>
+                                                                <para>for those
+                                                                received via the
+                                                                local syslog
+                                                                socket with the
+                                                                syslog protocol
+                                                                </para>
+                                                        </listitem>
+                                                </varlistentry>
+
+                                                <varlistentry>
+                                                        <term>
+                                                                <option>journal</option>
+                                                        </term>
+                                                        <listitem>
+                                                                <para>for those
+                                                                received via the
+                                                                native journal
+                                                                protocol
+                                                                </para>
+                                                        </listitem>
+                                                </varlistentry>
+
+                                                <varlistentry>
+                                                        <term>
+                                                                <option>stdout</option>
+                                                        </term>
+                                                        <listitem>
+                                                                <para>for those
+                                                                read from a
+                                                                service's
+                                                                standard output
+                                                                or error output
+                                                                </para>
+                                                        </listitem>
+                                                </varlistentry>
+
+                                                <varlistentry>
+                                                        <term>
+                                                                <option>kernel</option>
+                                                        </term>
+                                                        <listitem>
+                                                                <para>for those
+                                                                read from the
+                                                                kernel
+                                                                </para>
+                                                        </listitem>
+                                                </varlistentry>
+                                        </variablelist>

                                 </listitem>
                         </varlistentry>
                 </variablelist>
                                 </listitem>
                         </varlistentry>
                 </variablelist>


@@ -313,34 +367,34 @@
                 messages originating in the kernel and stored in the
                 journal.</para>
 
                 messages originating in the kernel and stored in the
                 journal.</para>
 

-                <variablelist>
+                <variablelist class='journal-directives'>

                         <varlistentry>
                         <varlistentry>

-                                <term>_KERNEL_DEVICE=</term>
+                                <term><varname>_KERNEL_DEVICE=</varname></term>

                                 <listitem>
                                         <para>The kernel device
                                         name. If the entry is
                                         associated to a block device,
                                         the major and minor of the
                                 <listitem>
                                         <para>The kernel device
                                         name. If the entry is
                                         associated to a block device,
                                         the major and minor of the

-                                        device node, separated by ':'
-                                        and prefixed by 'b'. Similar
+                                        device node, separated by <literal>:</literal>
+                                        and prefixed by <literal>b</literal>. Similar

                                         for character devices, but
                                         for character devices, but

-                                        prefixed by 'c'. For network
+                                        prefixed by <literal>c</literal>. For network

                                         devices the interface index,
                                         devices the interface index,

-                                        prefixed by 'n'. For all other
-                                        devices '+' followed by the
+                                        prefixed by <literal>n</literal>. For all other
+                                        devices <literal>+</literal> followed by the

                                         subsystem name, followed by
                                         subsystem name, followed by

-                                        ':', followed by the kernel
+                                        <literal>:</literal>, followed by the kernel

                                         device name.</para>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                         device name.</para>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>

-                                <term>_KERNEL_SUBSYSTEM=</term>
+                                <term><varname>_KERNEL_SUBSYSTEM=</varname></term>

                                 <listitem>
                                         <para>The kernel subsystem name.</para>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                 <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>
                                         <para>The kernel device name
                                         as it shows up in the device


@@ -349,7 +403,7 @@
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>

-                                <term>_UDEV_DEVNODE=</term>
+                                <term><varname>_UDEV_DEVNODE=</varname></term>

                                 <listitem>
                                         <para>The device node path of
                                         this device in
                                 <listitem>
                                         <para>The device node path of
                                         this device in


@@ -357,7 +411,7 @@
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
                                 </listitem>
                         </varlistentry>
                         <varlistentry>

-                                <term>_UDEV_DEVLINK=</term>
+                                <term><varname>_UDEV_DEVLINK=</varname></term>

                                 <listitem>
                                         <para>Additional symlink names
                                         pointing to the device node in
                                 <listitem>
                                         <para>Additional symlink names
                                         pointing to the device node in


@@ -369,16 +423,43 @@
                 </variablelist>
         </refsect1>
 
                 </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>
 
         <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>
                 <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>


@@ -393,8 +474,8 @@
                                         describes the position of an
                                         entry in the journal and is
                                         portable across machines,
                                         describes the position of an
                                         entry in the journal and is
                                         portable across machines,

-                                        platforms and journal
-                                        files.</para>
+                                        platforms and journal files.
+                                        </para>

                                 </listitem>
                         </varlistentry>
 
                                 </listitem>
                         </varlistentry>
 


@@ -402,16 +483,17 @@
                                 <term><varname>__REALTIME_TIMESTAMP=</varname></term>
                                 <listitem>
                                         <para>The wallclock time
                                 <term><varname>__REALTIME_TIMESTAMP=</varname></term>
                                 <listitem>
                                         <para>The wallclock time

-                                        (CLOCK_REALTIME) at the point
-                                        in time the entry was received
-                                        by the journal, in usec since
-                                        the epoch UTC formatted as
-                                        decimal string. This has
-                                        different properties from
+                                        (<constant>CLOCK_REALTIME</constant>)
+                                        at the point in time the entry
+                                        was received by the journal,
+                                        in usec since the epoch UTC
+                                        formatted as decimal
+                                        string. This has different
+                                        properties from

                                         <literal>_SOURCE_REALTIME_TIMESTAMP=</literal>
                                         as it is usually a bit later
                                         <literal>_SOURCE_REALTIME_TIMESTAMP=</literal>
                                         as it is usually a bit later

-                                        but more likely to be
-                                        monotonic.</para>
+                                        but more likely to be monotonic.
+                                        </para>

                                 </listitem>
                         </varlistentry>
 
                                 </listitem>
                         </varlistentry>
 


@@ -419,15 +501,15 @@
                                 <term><varname>__MONOTONIC_TIMESTAMP=</varname></term>
                                 <listitem>
                                         <para>The monotonic time
                                 <term><varname>__MONOTONIC_TIMESTAMP=</varname></term>
                                 <listitem>
                                         <para>The monotonic time

-                                        (CLOCK_MONOTONIC) at the point
-                                        in time the entry was received
-                                        by the journal in usec
-                                        formatted as decimal
+                                        (<constant>CLOCK_MONOTONIC</constant>)
+                                        at the point in time the entry
+                                        was received by the journal in
+                                        usec formatted as decimal

                                         string. To be useful as an
                                         address for the entry this
                                         should be combined with with
                                         string. To be useful as an
                                         address for the entry this
                                         should be combined with with

-                                        boot ID in
-                                        <literal>_BOOT_ID=</literal>.</para>
+                                        boot ID in <literal>_BOOT_ID=</literal>.
+                                        </para>

                                 </listitem>
                         </varlistentry>
                 </variablelist>
                                 </listitem>
                         </varlistentry>
                 </variablelist>


@@ -439,7 +521,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>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>
 
                   </para>
         </refsect1>