journal: make libgcrypt dependency optional

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

diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml
index c523ab090817db92eda913159db7de77a386b0f3..d790c35a03d0f5d3ad0afe5874f8b12b09bbffa2 100644 (file)
--- a/man/systemd.journal-fields.xml
+++ b/man/systemd.journal-fields.xml
@@ -53,11 +53,12 @@
                 <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.</para>
         </refsect1>
 
         <refsect1>
@@ -74,9 +75,11 @@
                                         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>
 
@@ -129,6 +132,19 @@
                                 </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>
@@ -289,6 +305,42 @@
                 </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>
+                </variablelist>
+        </refsect1>
+
         <refsect1>
                 <title>Address Fields</title>
 
@@ -296,7 +348,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,
-                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>
@@ -353,7 +410,8 @@
                   <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>