man: document that Documentation= follows an order

[elogind.git] / man / journalctl.xml

diff --git a/man/journalctl.xml b/man/journalctl.xml
index 3786fdf51491f476a4b876adb55272ecbb141bbb..026bb22940d502e8c2b369d0bad5f176589313d7 100644 (file)
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -159,16 +159,13 @@
                                 <term><option>--lines=</option></term>
                                 <term><option>-n</option></term>
 
                                 <term><option>--lines=</option></term>
                                 <term><option>-n</option></term>
 

-                                <listitem><para>Controls the number of
-                                journal lines to show, counting from
-                                the most recent ones. The argument is
-                                optional, and if specified is a
-                                positive integer. If not specified and
-                                in follow mode defaults to 10. If this
-                                option is not passed and follow mode
-                                is not enabled, how many lines are
-                                shown is not
-                                limited.</para></listitem>
+                                <listitem><para>Show the most recent
+                                journal events and limit the number of
+                                events shown. If
+                                <option>--follow</option> is used,
+                                this option is implied. The argument,
+                                a positive integer, is optional, and
+                                defaults to 10. </para></listitem>

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


@@ -215,7 +212,10 @@
                                 information). <literal>json</literal>
                                 formats entries as JSON data
                                 structures, one per
                                 information). <literal>json</literal>
                                 formats entries as JSON data
                                 structures, one per

-                                line. <literal>json-pretty</literal>
+                                line (see <ulink
+                                url="http://www.freedesktop.org/wiki/Software/systemd/json">Journal
+                                JSON Format</ulink> for more
+                                information). <literal>json-pretty</literal>

                                 also formats entries as JSON data
                                 structures, but formats them in
                                 multiple lines in order to make them
                                 also formats entries as JSON data
                                 structures, but formats them in
                                 multiple lines in order to make them


@@ -257,7 +257,56 @@
                                 <term><option>-b</option></term>
 
                                 <listitem><para>Show data only from
                                 <term><option>-b</option></term>
 
                                 <listitem><para>Show data only from

-                                current boot.</para></listitem>
+                                current boot. This will add a match
+                                for <literal>_BOOT_ID=</literal> for
+                                the current boot ID of the
+                                kernel.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--unit=</option></term>
+                                <term><option>-u</option></term>
+
+                                <listitem><para>Show data only of the
+                                specified unit. This will add a match
+                                for <literal>_SYSTEMD_UNIT=</literal>
+                                for the specified
+                                unit.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-p</option></term>
+                                <term><option>--priority=</option></term>
+
+                                <listitem><para>Filter output by
+                                message priorities or priority
+                                ranges. Takes either a single numeric
+                                or textual log level (i.e. between
+                                0/<literal>emerg</literal> and
+                                7/<literal>debug</literal>), or a
+                                range of numeric/text log levels in
+                                the form FROM..TO. The log levels are
+                                the usual syslog log levels as
+                                documented in
+                                <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+                                i.e. <literal>emerg</literal> (0),
+                                <literal>alert</literal> (1),
+                                <literal>crit</literal> (2),
+                                <literal>err</literal> (3),
+                                <literal>warning</literal> (4),
+                                <literal>notice</literal> (5),
+                                <literal>info</literal> (6),
+                                <literal>debug</literal> (7). If a
+                                single log level is specified all
+                                messages with this log level or a
+                                lower (hence more important) log level
+                                are shown. If a range is specified all
+                                messages within the range are shown,
+                                including both the start and the end
+                                value of the range. This will add
+                                <literal>PRIORITY=</literal> matches
+                                for the specified
+                                priorities.</para></listitem>

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


@@ -275,9 +324,9 @@
                                 <term><option>--until=</option></term>
 
                                 <listitem><para>Start showing entries
                                 <term><option>--until=</option></term>
 
                                 <listitem><para>Start showing entries

-                                newer or of the specified date,
-                                resp. older or of the specified
-                                date. Date specifications should be of
+                                on or newer than the specified date,
+                                or on or older than the specified
+                                date, respectively. Date specifications should be of

                                 the format "2012-10-30 18:17:16". If
                                 the time part is omitted, 00:00:00 is
                                 assumed. If only the seconds component
                                 the format "2012-10-30 18:17:16". If
                                 the time part is omitted, 00:00:00 is
                                 assumed. If only the seconds component


@@ -290,14 +339,24 @@
                                 <literal>tomorrow</literal> are
                                 understood, which refer to 00:00:00 of
                                 the day before the current day, the
                                 <literal>tomorrow</literal> are
                                 understood, which refer to 00:00:00 of
                                 the day before the current day, the

-                                current day, resp the day after the
-                                current day. <literal>now</literal>
+                                current day, or the day after the
+                                current day, respectively. <literal>now</literal>

                                 refers to the current time. Finally,
                                 relative times may be specified,
                                 prefixed with <literal>-</literal> or
                                 <literal>+</literal>, referring to
                                 refers to the current time. Finally,
                                 relative times may be specified,
                                 prefixed with <literal>-</literal> or
                                 <literal>+</literal>, referring to

-                                times before resp. after the current
-                                time.</para></listitem>
+                                times before or after the current
+                                time, respectively.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--field=</option></term>
+                                <term><option>-F</option></term>
+
+                                <listitem><para>Print all possible
+                                data values the specified field can
+                                take in all entries of the
+                                journal.</para></listitem>

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


@@ -312,38 +371,6 @@
                                 paths.</para></listitem>
                         </varlistentry>
 
                                 paths.</para></listitem>
                         </varlistentry>
 

-                        <varlistentry>
-                                <term><option>-p</option></term>
-                                <term><option>--priority=</option></term>
-
-                                <listitem><para>Filter output by
-                                message priorities or priority
-                                ranges. Takes either a single numeric
-                                or textual log level (i.e. between
-                                0/<literal>emerg</literal> and
-                                7/<literal>debug</literal>), or a
-                                range of numeric/text log levels in
-                                the form FROM..TO. The log levels are
-                                the usual syslog log levels as
-                                documented in
-                                <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-                                i.e. <literal>emerg</literal> (0),
-                                <literal>alert</literal> (1),
-                                <literal>crit</literal> (2),
-                                <literal>err</literal> (3),
-                                <literal>warning</literal> (4),
-                                <literal>notice</literal> (5),
-                                <literal>info</literal> (6),
-                                <literal>debug</literal> (7). If a
-                                single log level is specified all
-                                messages with this log level or a
-                                lower (hence more important) log level
-                                are shown. If a range is specified all
-                                messages within the range are shown,
-                                including both the start and the end
-                                value of the range.</para></listitem>
-                        </varlistentry>
-

                         <varlistentry>
                                 <term><option>--new-id128</option></term>
 
                         <varlistentry>
                                 <term><option>--new-id128</option></term>