man: fix spacing issue in various man pages

[elogind.git] / man / journalctl.xml

diff --git a/man/journalctl.xml b/man/journalctl.xml
index 651a8a56ad99bc6c9c9ad07ae86f230ebb416579..fa29c4103ca521007485611591c790eafd548e4b 100644 (file)
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -49,7 +49,9 @@
 
         <refsynopsisdiv>
                 <cmdsynopsis>
 
         <refsynopsisdiv>
                 <cmdsynopsis>

-                        <command>journalctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">MATCHES</arg></command>
+                        <command>journalctl</command>
+                        <arg choice="opt" rep="repeat">OPTIONS</arg>
+                        <arg choice="opt" rep="repeat">MATCHES</arg>

                 </cmdsynopsis>
         </refsynopsisdiv>
 
                 </cmdsynopsis>
         </refsynopsisdiv>
 


@@ -82,7 +84,7 @@
                 alternatives, i.e. the resulting output will show
                 entries matching any of the specified matches for the
                 same field. Finally, if the character
                 alternatives, i.e. the resulting output will show
                 entries matching any of the specified matches for the
                 same field. Finally, if the character

-                "<literal>+</literal>" appears as separate word on the
+                <literal>+</literal> appears as separate word on the

                 command line all matches before and after are combined
                 in a disjunction (i.e. logical OR).</para>
 
                 command line all matches before and after are combined
                 in a disjunction (i.e. logical OR).</para>
 


@@ -114,8 +116,8 @@
 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>

-                                <term><option>--help</option></term>

                                 <term><option>-h</option></term>
                                 <term><option>-h</option></term>

+                                <term><option>--help</option></term>

 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>
 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>


@@ -136,8 +138,16 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--all</option></term>
+                                <term><option>-l</option></term>
+                                <term><option>--full</option></term>
+
+                                <listitem><para>Show all (printable) fields in
+                                full.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>

                                 <term><option>-a</option></term>
                                 <term><option>-a</option></term>

+                                <term><option>--all</option></term>

 
                                 <listitem><para>Show all fields in
                                 full, even if they include unprintable
 
                                 <listitem><para>Show all fields in
                                 full, even if they include unprintable


@@ -146,8 +156,8 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--follow</option></term>

                                 <term><option>-f</option></term>
                                 <term><option>-f</option></term>

+                                <term><option>--follow</option></term>

 
                                 <listitem><para>Show only the most recent
                                 journal entries, and continuously print
 
                                 <listitem><para>Show only the most recent
                                 journal entries, and continuously print


@@ -156,19 +166,34 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--lines=</option></term>
+                                <term><option>-e</option></term>
+                                <term><option>--pager-end</option></term>
+
+                                <listitem><para>Immediately jump to
+                                the end of the journal inside the
+                                implied pager tool. This implies
+                                <option>-n1000</option> to guarantee
+                                that the pager won't buffer logs of
+                                unbounded size. This may be overridden
+                                with an explicit <option>-n</option>
+                                with some other numeric value on the
+                                command line. Note that this option is
+                                only supported for the
+                                <citerefentry><refentrytitle>less</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                                pager.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>

                                 <term><option>-n</option></term>
                                 <term><option>-n</option></term>

+                                <term><option>--lines=</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>


@@ -181,8 +206,16 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--output=</option></term>
+                                <term><option>-r</option></term>
+                                <term><option>--reverse</option></term>
+
+                                <listitem><para>Reverse output, so the newest
+                                entries are displayed first.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>

                                 <term><option>-o</option></term>
                                 <term><option>-o</option></term>

+                                <term><option>--output=</option></term>

 
                                 <listitem><para>Controls the
                                 formatting of the journal entries that
 
                                 <listitem><para>Controls the
                                 formatting of the journal entries that


@@ -193,6 +226,7 @@
                                 <literal>export</literal>,
                                 <literal>json</literal>,
                                 <literal>json-pretty</literal>,
                                 <literal>export</literal>,
                                 <literal>json</literal>,
                                 <literal>json-pretty</literal>,

+                                <literal>json-sse</literal>,

                                 <literal>cat</literal>. <literal>short</literal>
                                 is the default and generates an output
                                 that is mostly identical to the
                                 <literal>cat</literal>. <literal>short</literal>
                                 is the default and generates an output
                                 that is mostly identical to the


@@ -214,12 +248,20 @@
                                 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
                                 more readable for
                                 also formats entries as JSON data
                                 structures, but formats them in
                                 multiple lines in order to make them
                                 more readable for

-                                humans. <literal>cat</literal>
+                                humans. <literal>json-sse</literal>
+                                also formats entries as JSON data
+                                structures, but wraps them in a format
+                                suitable for <ulink
+                                url="https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events">Server-Sent
+                                Events</ulink>. <literal>cat</literal>

                                 generates a very terse output only
                                 showing the actual message of each
                                 journal entry with no meta data, not
                                 generates a very terse output only
                                 showing the actual message of each
                                 journal entry with no meta data, not


@@ -227,8 +269,32 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--quiet</option></term>
+                                <term><option>-x</option></term>
+                                <term><option>--catalog</option></term>
+
+                                <listitem><para>Augment log lines with
+                                explanation texts from the message
+                                catalog. This will add explanatory
+                                help texts to log messages in the
+                                output where this is available. These
+                                short help texts will explain the
+                                context of an error or log event,
+                                possible solutions, as well as
+                                pointers to support forums, developer
+                                documentation and any other relevant
+                                manuals. Note that help texts are not
+                                available for all messages, but only
+                                for selected ones. For more
+                                information on the message catalog
+                                please refer to the <ulink
+                                url="http://www.freedesktop.org/wiki/Software/systemd/catalog">Message
+                                Catalog Developer
+                                Documentation</ulink>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>

                                 <term><option>-q</option></term>
                                 <term><option>-q</option></term>

+                                <term><option>--quiet</option></term>

 
                                 <listitem><para>Suppresses any warning
                                 message regarding inaccessible system
 
                                 <listitem><para>Suppresses any warning
                                 message regarding inaccessible system


@@ -237,8 +303,8 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--merge</option></term>

                                 <term><option>-m</option></term>
                                 <term><option>-m</option></term>

+                                <term><option>--merge</option></term>

 
                                 <listitem><para>Show entries
                                 interleaved from all available
 
                                 <listitem><para>Show entries
                                 interleaved from all available


@@ -247,32 +313,54 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--this-boot</option></term>

                                 <term><option>-b</option></term>
                                 <term><option>-b</option></term>

+                                <term><option>--this-boot</option></term>

 
                                 <listitem><para>Show data only from
 
                                 <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>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--cursor=</option></term>
-                                <term><option>-c</option></term>
+                                <term><option>-k</option></term>
+                                <term><option>--dmesg</option></term>

 
 

-                                <listitem><para>Jump to the location
-                                in the journal specified by the passed
-                                cursor.</para></listitem>
+                                <listitem><para>Show kernel messages from
+                                current boot. This implies <option>-b</option>
+                                and adds the match <literal>_TRANSPORT=kernel</literal>.
+                                </para></listitem>

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

-                                <term><option>--directory=</option></term>
-                                <term><option>-D</option></term>
+                                <term><option>-u</option></term>
+                                <term><option>--unit=</option></term>
+
+                                <listitem><para>Show messages for the
+                                specified systemd unit. This will add
+                                a match for messages from the unit
+                                (<literal>_SYSTEMD_UNIT=</literal>)
+                                and additional matches for messages
+                                from systemd and messages about
+                                coredumps for the specified unit.</para>
+                                <para>This parameter can be specified multiple times.
+                                </para></listitem>
+                        </varlistentry>

 
 

-                                <listitem><para>Takes an absolute
-                                directory path as argument. If
-                                specified journalctl will operate on the
-                                specified journal directory instead of
-                                the default runtime and system journal
-                                paths.</para></listitem>
+                        <varlistentry>
+                                <term><option>--user-unit=</option></term>
+
+                                <listitem><para>Show messages for the
+                                specified user session unit. This will
+                                add a match for messages from the unit
+                                (<literal>_SYSTEMD_USER_UNIT=</literal>
+                                and <literal>_UID=</literal>) and
+                                additional matches for messages from
+                                session systemd and messages about
+                                coredumps for the specified unit.</para>
+                                <para>This parameter can be specified multiple times.
+                                </para></listitem>

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


@@ -304,7 +392,115 @@
                                 are shown. If a range is specified all
                                 messages within the range are shown,
                                 including both the start and the end
                                 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>
+                                value of the range. This will add
+                                <literal>PRIORITY=</literal> matches
+                                for the specified
+                                priorities.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-c</option></term>
+                                <term><option>--cursor=</option></term>
+
+                                <listitem><para>Start showing entries
+                                from the location in the journal
+                                specified by the passed
+                                cursor.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--since=</option></term>
+                                <term><option>--until=</option></term>
+
+                                <listitem><para>Start showing entries
+                                on or newer than the specified date,
+                                or on or older than the specified
+                                date, respectively. Date specifications
+                                should be of the format
+                                <literal>2012-10-30 18:17:16</literal>.
+                                If the time part is omitted,
+                                <literal>00:00:00</literal> is assumed.
+                                If only the seconds component is omitted,
+                                <literal>:00</literal> is assumed. If the
+                                date component is omitted, the current
+                                day is assumed. Alternatively the strings
+                                <literal>yesterday</literal>,
+                                <literal>today</literal>,
+                                <literal>tomorrow</literal> are
+                                understood, which refer to 00:00:00 of
+                                the day before the current day, the
+                                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
+                                times before or after the current
+                                time, respectively.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-F</option></term>
+                                <term><option>--field=</option></term>
+
+                                <listitem><para>Print all possible
+                                data values the specified field can
+                                take in all entries of the
+                                journal.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--system</option></term>
+                                <term><option>--user</option></term>
+
+                                <listitem><para>Show messages from
+                                system services and the kernel (with
+                                <option>--system</option>).  Show
+                                messages from service of current user
+                                (with <option>--user</option>).
+                                If neither is specified, show all
+                                messages that the user can see.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-D <replaceable>DIR</replaceable></option></term>
+                                <term><option>--directory=<replaceable>DIR</replaceable></option></term>
+
+                                <listitem><para>Takes a directory path
+                                as argument. If specified journalctl
+                                will operate on the specified journal
+                                directory
+                                <replaceable>DIR</replaceable> instead
+                                of the default runtime and system
+                                journal paths.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--file=<replaceable>GLOB</replaceable></option></term>
+
+                                <listitem><para>Takes a file glob as
+                                argument. If specified journalctl will
+                                operate on the specified journal files
+                                matching <replaceable>GLOB</replaceable>
+                                instead of the default runtime and
+                                system journal paths. May be specified
+                                multiple times, in which case files will
+                                be suitably interleaved.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--root=<replaceable>ROOT</replaceable></option></term>
+
+                                <listitem><para>Takes a directory path
+                                as argument. If specified journalctl
+                                will operate on catalog file hierarchy
+                                underneath the specified directory
+                                instead of the root directory
+                                (e.g. <option>--update-catalog</option>
+                                will create
+                                <filename><replaceable>ROOT</replaceable>/var/lib/systemd/catalog/database</filename>).
+                                </para></listitem>

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


@@ -340,6 +536,53 @@
                                 journal files.</para></listitem>
                         </varlistentry>
 
                                 journal files.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--list-catalog
+                                <optional><replaceable>ID128...</replaceable></optional>
+                                </option></term>
+
+                                <listitem><para>List the contents of
+                                the message catalog, as table of
+                                message IDs plus their short
+                                description strings.</para>
+
+                                <para>If any
+                                <replaceable>ID128</replaceable>s are
+                                specified, only those entries are shown.
+                                </para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--dump-catalog
+                                <optional><replaceable>ID128...</replaceable></optional>
+                                </option></term>
+
+                                <listitem><para>Show the contents of
+                                the message catalog, with entries
+                                separated by a line consisting of two
+                                dashes and the id (the format is the
+                                same as <filename>.catalog</filename>
+                                files.</para>
+
+                                <para>If any
+                                <replaceable>ID128</replaceable>s are
+                                specified, only those entries are shown.
+                                </para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--update-catalog</option></term>
+
+                                <listitem><para>Update the message
+                                catalog index. This command needs to
+                                be executed each time new catalog
+                                files are installed, removed or
+                                updated to rebuild the binary catalog
+                                index.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>--setup-keys</option></term>
 
                         <varlistentry>
                                 <term><option>--setup-keys</option></term>
 


@@ -351,7 +594,10 @@
                                 sealing key is stored in the journal
                                 data directory and shall remain on the
                                 host. The verification key should be
                                 sealing key is stored in the journal
                                 data directory and shall remain on the
                                 host. The verification key should be

-                                stored externally.</para></listitem>
+                                stored externally. Also see the
+                                <option>Seal=</option> option in
+                                <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                for details.</para></listitem>

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


@@ -403,7 +649,7 @@
         <refsect1>
                 <title>Environment</title>
 
         <refsect1>
                 <title>Environment</title>
 

-                <variablelist>
+                <variablelist class='environment-variables'>

                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when


@@ -436,7 +682,7 @@
 
                 <programlisting>journalctl _SYSTEMD_UNIT=avahi-daemon.service _SYSTEMD_UNIT=dbus.service</programlisting>
 
 
                 <programlisting>journalctl _SYSTEMD_UNIT=avahi-daemon.service _SYSTEMD_UNIT=dbus.service</programlisting>
 

-                <para>If the separator "<literal>+</literal>" is used
+                <para>If the separator <literal>+</literal> is used

                 two expressions may be combined in a logical OR. The
                 following will show all messages from the Avahi
                 service process with the PID 28097 plus all messages
                 two expressions may be combined in a logical OR. The
                 following will show all messages from the Avahi
                 service process with the PID 28097 plus all messages


@@ -449,7 +695,7 @@
 
                 <programlisting>journalctl /usr/bin/dbus-daemon</programlisting>
 
 
                 <programlisting>journalctl /usr/bin/dbus-daemon</programlisting>
 

-                <para>Show all logs of the kernel device node <filename>/dev/sda</filename>:</para>
+                <para>Show all logs of the kernel device node <filename noindex='true'>/dev/sda</filename>:</para>

 
                 <programlisting>journalctl /dev/sda</programlisting>
 
 
                 <programlisting>journalctl /dev/sda</programlisting>