daemon: Fix broken links to sd-daemon.c

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

diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml
index becffc738a4f56ae3d8760019f8d670396e4e625..b555c0e0ac56ac31f85575926a7a3f665980e21c 100644 (file)
--- a/man/systemd.journal-fields.xml
+++ b/man/systemd.journal-fields.xml
@@ -8,16 +8,16 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it

-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or

   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

-  General Public License for more details.
+  Lesser General Public License for more details.

 
 

-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License

   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 


@@ -53,11 +53,13 @@
                 <para>Entries in the journal resemble an environment
                 block in their syntax, however with fields that can
                 include binary data. Primarily, fields are formatted
                 <para>Entries in the journal resemble an environment
                 block in their syntax, however with fields that can
                 include binary data. Primarily, fields are formatted

-                ASCII strings, and binary formatting is used only
-                where formatting as ASCII makes little sense. New
-                fields may be freely defined by applications, but a
-                few fields have special meaning. All fields with
-                special meaning are optional.</para>
+                UTF-8 text strings, and binary formatting is used only
+                where formatting as UTF-8 text strings makes little
+                sense. New fields may freely be defined by
+                applications, but a few fields have special
+                meaning. All fields with special meanings are
+                optional. In some cases fields may appear more than
+                once per entry.</para>

         </refsect1>
 
         <refsect1>
         </refsect1>
 
         <refsect1>


@@ -74,9 +76,11 @@
                                         message string for this
                                         entry. This is supposed to be
                                         the primary text shown to the
                                         message string for this
                                         entry. This is supposed to be
                                         the primary text shown to the

-                                        user. It is not translated,
-                                        and is not supposed to be
-                                        parsed for meta data.</para>
+                                        user. It is usually not
+                                        translated (but might be in
+                                        some cases), and is not
+                                        supposed to be parsed for meta
+                                        data.</para>

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


@@ -129,6 +133,19 @@
                                 </listitem>
                         </varlistentry>
 
                                 </listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term>ERRNO=</term>
+                                <listitem>
+                                        <para>The low-level Unix error
+                                        number causing this entry, if
+                                        any. Contains the numeric
+                                        value of
+                                        <citerefentry><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                                        formatted as decimal
+                                        string.</para>
+                                </listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term>SYSLOG_FACILITY=</term>
                                 <term>SYSLOG_IDENTIFIER=</term>
                         <varlistentry>
                                 <term>SYSLOG_FACILITY=</term>
                                 <term>SYSLOG_IDENTIFIER=</term>


@@ -261,6 +278,94 @@
                                         originating host.</para>
                                 </listitem>
                         </varlistentry>
                                         originating host.</para>
                                 </listitem>
                         </varlistentry>

+
+                        <varlistentry>
+                                <term>_TRANSPORT=</term>
+                                <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, and for those read
+                                        from the kernel, resp.
+                                        </para>
+                                </listitem>
+                        </varlistentry>
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
+                <title>Kernel Journal Fields</title>
+
+                <para>Kernel fields are fields that are used by
+                messages originating in the kernel and stored in the
+                journal.</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term>_KERNEL_DEVICE=</term>
+                                <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
+                                        for character devices, but
+                                        prefixed by 'c'. For network
+                                        devices the interface index,
+                                        prefixed by 'n'. For all other
+                                        devices '+' followed by the
+                                        subsystem name, followed by
+                                        ':', followed by the kernel
+                                        device name.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term>_KERNEL_SUBSYSTEM=</term>
+                                <listitem>
+                                        <para>The kernel subsystem name.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term>_UDEV_SYSNAME=</term>
+                                <listitem>
+                                        <para>The kernel device name
+                                        as it shows up in the device
+                                        tree below
+                                        <filename>/sys</filename>.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term>_UDEV_DEVNODE=</term>
+                                <listitem>
+                                        <para>The device node path of
+                                        this device in
+                                        <filename>/dev</filename>.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term>_UDEV_DEVLINK=</term>
+                                <listitem>
+                                        <para>Additional symlink names
+                                        pointing to the device node in
+                                        <filename>/dev</filename>. This
+                                        field is frequently set more
+                                        than once per entry.</para>
+                                </listitem>
+                        </varlistentry>

                 </variablelist>
         </refsect1>
 
                 </variablelist>
         </refsect1>
 


@@ -271,7 +376,12 @@
                 addresses of journal entries are serialized into
                 fields prefixed with double underscores. Note that
                 these aren't proper fields when stored in the journal,
                 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.</para>
+                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>

 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>


@@ -328,7 +438,8 @@
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                   <para>
                           <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>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>

                   </para>
         </refsect1>
 
                   </para>
         </refsect1>