journalctl: add option to forgo ellipsization

[elogind.git] / man / journalctl.xml

diff --git a/man/journalctl.xml b/man/journalctl.xml
index 9800cf30ed260ecfd8b4650f06f6a8a23e7f2d2c..471c9452ca5e25cf2b827097642234abdf7347dd 100644 (file)
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -62,7 +62,7 @@
                 journal as written by
                 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 
                 journal as written by
                 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 

-                <para>If called without parameter will show the full
+                <para>If called without parameter it will show the full

                 contents of the journal, starting with the oldest
                 entry collected.</para>
 
                 contents of the journal, starting with the oldest
                 entry collected.</para>
 


@@ -135,6 +135,13 @@
                                 pager.</para></listitem>
                         </varlistentry>
 
                                 pager.</para></listitem>
                         </varlistentry>
 

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

                         <varlistentry>
                                 <term><option>--all</option></term>
                                 <term><option>-a</option></term>
                         <varlistentry>
                                 <term><option>--all</option></term>
                                 <term><option>-a</option></term>


@@ -149,7 +156,7 @@
                                 <term><option>--follow</option></term>
                                 <term><option>-f</option></term>
 
                                 <term><option>--follow</option></term>
                                 <term><option>-f</option></term>
 

-                                <listitem><para>Show only most recent
+                                <listitem><para>Show only the most recent

                                 journal entries, and continuously print
                                 new entries as they are appended to
                                 the journal.</para></listitem>
                                 journal entries, and continuously print
                                 new entries as they are appended to
                                 the journal.</para></listitem>


@@ -159,13 +166,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. Takes a positive
-                                integer argument. In follow mode
-                                defaults to 10, otherwise is unset
-                                thus not limiting how many lines are
-                                shown.</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>


@@ -190,6 +197,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


@@ -211,18 +219,50 @@
                                 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
                                 even a timestamp.</para></listitem>
                         </varlistentry>
 
                                 generates a very terse output only
                                 showing the actual message of each
                                 journal entry with no meta data, not
                                 even a timestamp.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--catalog</option></term>
+                                <term><option>-x</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>--quiet</option></term>
                                 <term><option>-q</option></term>
                         <varlistentry>
                                 <term><option>--quiet</option></term>
                                 <term><option>-q</option></term>


@@ -248,19 +288,21 @@
                                 <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>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--directory=</option></term>
-                                <term><option>-D</option></term>
-
-                                <listitem><para>Takes an absolute
-                                directory path as argument. If
-                                specified will operate on the
-                                specified journal directory instead of
-                                the default runtime and system journal
-                                paths.</para></listitem>
+                                <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>
                         </varlistentry>
 
                         <varlistentry>


@@ -287,12 +329,77 @@
                                 <literal>info</literal> (6),
                                 <literal>debug</literal> (7). If a
                                 single log level is specified all
                                 <literal>info</literal> (6),
                                 <literal>debug</literal> (7). If a
                                 single log level is specified all

-                                messages with this log levels or a
+                                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
                                 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>
+                                value of the range. This will add
+                                <literal>PRIORITY=</literal> matches
+                                for the specified
+                                priorities.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--cursor=</option></term>
+                                <term><option>-c</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 "2012-10-30 18:17:16". If
+                                the time part is omitted, 00:00:00 is
+                                assumed. If only the seconds component
+                                is omitted, :00 is assumed. If the
+                                date component is ommitted, 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>--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>
+                                <term><option>--directory=</option></term>
+                                <term><option>-D</option></term>
+
+                                <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>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -316,7 +423,7 @@
 
                                 <listitem><para>Instead of showing
                                 journal contents show internal header
 
                                 <listitem><para>Instead of showing
                                 journal contents show internal header

-                                information of the journal fiels
+                                information of the journal fields

                                 accessed.</para></listitem>
                         </varlistentry>
 
                                 accessed.</para></listitem>
                         </varlistentry>
 


@@ -328,6 +435,26 @@
                                 journal files.</para></listitem>
                         </varlistentry>
 
                                 journal files.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--list-catalog</option></term>
+
+                                <listitem><para>List the contents of
+                                the message catalog, as table of
+                                message IDs plus their short
+                                description strings.</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>
 


@@ -425,7 +552,7 @@
                 <programlisting>journalctl _SYSTEMD_UNIT=avahi-daemon.service _SYSTEMD_UNIT=dbus.service</programlisting>
 
                 <para>If the separator "<literal>+</literal>" is used
                 <programlisting>journalctl _SYSTEMD_UNIT=avahi-daemon.service _SYSTEMD_UNIT=dbus.service</programlisting>
 
                 <para>If the separator "<literal>+</literal>" is used

-                two expression may be combined in a logical OR. The
+                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
                 from the D-Bus service (from any of its
                 following will show all messages from the Avahi
                 service process with the PID 28097 plus all messages
                 from the D-Bus service (from any of its