man: wording and grammar updates

[elogind.git] / man / journalctl.xml

diff --git a/man/journalctl.xml b/man/journalctl.xml
index 0e779b952c0813538ce47af48320eccd5339d858..508f1dd534fa21ef981afecf685b8b1c703957c9 100644 (file)
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -104,7 +104,7 @@
 
                 <para>All users are granted access to their private
                 per-user journals. However, by default, only root and
 
                 <para>All users are granted access to their private
                 per-user journals. However, by default, only root and

-                users who are members of the <literal>adm</literal>
+                users who are members of the <literal>systemd-journal</literal>

                 group get access to the system journal and the
                 journals of other users.</para>
 
                 group get access to the system journal and the
                 journals of other users.</para>
 


@@ -152,11 +152,20 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>-l</option></term>
+                                <term><option>--no-full</option></term>

                                 <term><option>--full</option></term>
                                 <term><option>--full</option></term>

+                                <term><option>-l</option></term>

 
 

-                                <listitem><para>Show all (printable) fields in
-                                full.</para></listitem>
+                                <listitem><para>Ellipsize fields when
+                                they do not fit in available columns.
+                                The default is to show full fields,
+                                allowing them to wrap or be truncated
+                                by the pager if one is used.</para>
+
+                                <para>The old options
+                                <option>-l</option>/<option>--full</option>
+                                are not useful anymore, except to undo
+                                <option>--no-full</option>.</para></listitem>

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


@@ -233,53 +242,150 @@
 
                                 <listitem><para>Controls the
                                 formatting of the journal entries that
 
                                 <listitem><para>Controls the
                                 formatting of the journal entries that

-                                are shown. Takes one of
-                                <literal>short</literal>,
-                                <literal>short-monotonic</literal>,
-                                <literal>verbose</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
-                                formatting of classic syslog
-                                files, showing one line per journal
-                                entry. <literal>short-monotonic</literal>
-                                is very similar but shows monotonic
-                                timestamps instead of wallclock
-                                timestamps. <literal>verbose</literal>
-                                shows the full structured entry items
-                                with all
-                                fields. <literal>export</literal>
-                                serializes the journal into a binary
-                                (but mostly text-based) stream
-                                suitable for backups and network
-                                transfer (see <ulink
-                                url="http://www.freedesktop.org/wiki/Software/systemd/export">Journal
-                                Export Format</ulink> for more
-                                information). <literal>json</literal>
-                                formats entries as JSON data
-                                structures, one per
-                                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
-                                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>
+                                are shown. Takes one of the following options:
+                                </para>
+                                <variablelist>
+                                        <varlistentry>
+                                                <term>
+                                                        <option>short</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>is the default
+                                                        and generates an output
+                                                        that is mostly identical
+                                                        to the formatting of
+                                                        classic syslog files,
+                                                        showing one line per
+                                                        journal entry.</para>
+                                                </listitem>
+                                        </varlistentry>
+
+                                        <varlistentry>
+                                                <term>
+                                                        <option>short-iso</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>is very similar,
+                                                        but shows ISO 8601
+                                                        wallclock timestamps.
+                                                        </para>
+                                                </listitem>
+                                        </varlistentry>
+
+                                        <varlistentry>
+                                                <term>
+                                                        <option>short-precise</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>is very similar,
+                                                        but shows timestamps
+                                                        with full microsecond
+                                                        precision.
+                                                        </para>
+                                                </listitem>
+                                        </varlistentry>
+
+                                        <varlistentry>
+                                                <term>
+                                                        <option>short-monotonic</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>is very similar,
+                                                        but shows monotonic
+                                                        timestamps instead of
+                                                        wallclock timestamps.
+                                                        </para>
+                                                </listitem>
+                                        </varlistentry>
+
+                                        <varlistentry>
+                                                <term>
+                                                        <option>verbose</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>shows the
+                                                        full-structured entry
+                                                        items with all fields.
+                                                        </para>
+                                                </listitem>
+                                        </varlistentry>
+
+                                        <varlistentry>
+                                                <term>
+                                                        <option>export</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>serializes the
+                                                        journal into a binary
+                                                        (but mostly text-based)
+                                                        stream suitable for
+                                                        backups and network
+                                                        transfer (see <ulink
+                                                        url="http://www.freedesktop.org/wiki/Software/systemd/export">Journal
+                                                        Export Format</ulink>
+                                                        for more
+                                                        information).</para>
+                                                </listitem>
+                                        </varlistentry>
+
+                                        <varlistentry>
+                                                <term>
+                                                        <option>json</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>formats entries
+                                                        as JSON data structures,
+                                                        one per line (see <ulink
+                                                        url="http://www.freedesktop.org/wiki/Software/systemd/json">Journal
+                                                        JSON Format</ulink> for
+                                                        more information).</para>
+                                                </listitem>
+                                        </varlistentry>
+
+                                        <varlistentry>
+                                                <term>
+                                                        <option>json-pretty</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>formats entries as
+                                                        JSON data structures,
+                                                        but formats them in
+                                                        multiple lines in order
+                                                        to make them more
+                                                        readable for humans.</para>
+                                                </listitem>
+                                        </varlistentry>
+
+                                        <varlistentry>
+                                                <term>
+                                                        <option>json-sse</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>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>.</para>
+                                                </listitem>
+                                        </varlistentry>
+
+                                        <varlistentry>
+                                                <term>
+                                                        <option>cat</option>
+                                                </term>
+                                                <listitem>
+                                                        <para>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>
+                                </variablelist>
+                                </listitem>

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


@@ -295,7 +401,7 @@
                                 context of an error or log event,
                                 possible solutions, as well as
                                 pointers to support forums, developer
                                 context of an error or log event,
                                 possible solutions, as well as
                                 pointers to support forums, developer

-                                documentation and any other relevant
+                                documentation, and any other relevant

                                 manuals. Note that help texts are not
                                 available for all messages, but only
                                 for selected ones. For more
                                 manuals. Note that help texts are not
                                 available for all messages, but only
                                 for selected ones. For more


@@ -303,7 +409,14 @@
                                 please refer to the <ulink
                                 url="http://www.freedesktop.org/wiki/Software/systemd/catalog">Message
                                 Catalog Developer
                                 please refer to the <ulink
                                 url="http://www.freedesktop.org/wiki/Software/systemd/catalog">Message
                                 Catalog Developer

-                                Documentation</ulink>.</para></listitem>
+                                Documentation</ulink>.</para>
+
+                                <para>Note: when attaching
+                                <command>journalctl</command> output
+                                to bug reports, please do
+                                <emphasis>not</emphasis> use
+                                <option>-x</option>.</para>
+                                </listitem>

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


@@ -327,42 +440,50 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>-b <optional><replaceable>ID</replaceable></optional></option></term>
-                                <term><option>--boot=<optional><replaceable>ID</replaceable></optional></option></term>
+                                <term><option>-b <optional><replaceable>ID</replaceable></optional><optional><replaceable>±offset</replaceable></optional></option></term>
+                                <term><option>--boot=<optional><replaceable>ID</replaceable></optional><optional><replaceable>±offset</replaceable></optional></option></term>

 
 

-                                <listitem><para>Show messages from the specified
-                                boot <replaceable>ID</replaceable> or from
-                                current boot if no <replaceable>ID</replaceable>
-                                is given. This will add a match for
+                                <listitem><para>Show messages from a specific
+                                boot. This will add a match for

                                 <literal>_BOOT_ID=</literal>.</para>
 
                                 <literal>_BOOT_ID=</literal>.</para>
 

-                                <para>The argument is a 128 bit ID given in
-                                short or UUID form and optionally followed by
-                                <literal>:n</literal> which identifies the nth
-                                boot relative to the boot ID given to the left
-                                of <literal>:</literal>. Supplying a negative
-                                value for n will look for a past boot and a
-                                positive value for a future boot. The boot IDs
-                                are searched for in chronological order. If no
-                                number is provided after <literal>:</literal>,
-                                <literal>-1</literal> is assumed. A value of 0
-                                is valid and equivalent to omitting
-                                <literal>:0</literal>.</para>
-
-                                <para>Alternatively, the argument may constist
-                                only of <literal>:n</literal>. In this case, a
-                                positive value will look up the nth boot
-                                starting from the beginning of the jouranl, a
-                                negative value will look up a previous boot
-                                relative to the current boot. <literal>:0</literal>
-                                will look for the current boot ID. Thus,
-                                <literal>:1</literal> is the first boot found in
-                                the journal, <literal>:2</literal> the second
-                                and so on; while <literal>:-1</literal> is the
-                                previous boot, <literal>:-2</literal> the boot
-                                before that and so on. Omitting a value after
-                                <literal>:</literal> will look for the previous
-                                boot.</para></listitem>
+                                <para>The argument may be empty, in which case
+                                logs for the current boot will be shown.</para>
+
+                                <para>If the boot ID is omitted, a positive
+                                <replaceable>offset</replaceable> will look up
+                                the boots starting from the beginning of the
+                                journal, and a equal-or-less-than zero
+                                <replaceable>offset</replaceable> will look up
+                                boots starting from the end of the
+                                journal. Thus, <constant>1</constant> means the
+                                first boot found in the journal in the
+                                chronological order, <constant>2</constant> the
+                                second and so on; while <constant>-0</constant>
+                                is the last boot, <constant>-1</constant> the
+                                boot before that, and so on. An empty
+                                <replaceable>offset</replaceable> is equivalent
+                                to specifying <constant>-0</constant>, except
+                                when the current boot is not the last boot
+                                (e.g. because <option>--directory</option> was
+                                specified to look at logs from a different
+                                machine).</para>
+
+                                <para>If the 32 character
+                                <replaceable>ID</replaceable> is specified, it
+                                may optionally be followed by
+                                <replaceable>offset</replaceable> which
+                                identifies the boot relative to the one given by
+                                boot <replaceable>ID</replaceable>. Negative
+                                values mean earlier boots and a positive values
+                                mean later boots. If
+                                <replaceable>offset</replaceable> is not
+                                specified, a value of zero is assumed and the
+                                logs for the boot given by
+                                <replaceable>ID</replaceable> are shown.
+                                </para>
+
+                                </listitem>

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


@@ -450,6 +571,16 @@
                                 cursor.</para></listitem>
                         </varlistentry>
 
                                 cursor.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--after-cursor=</option></term>
+
+                                <listitem><para>Start showing entries from the
+                                location in the journal
+                                <emphasis>after</emphasis> the location
+                                specified by the this cursor.
+                                </para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>--since=</option></term>
                                 <term><option>--until=</option></term>
                         <varlistentry>
                                 <term><option>--since=</option></term>
                                 <term><option>--until=</option></term>


@@ -749,9 +880,9 @@
 
                 <programlisting>journalctl /dev/sda</programlisting>
 
 
                 <programlisting>journalctl /dev/sda</programlisting>
 

-                <para>Show all kernel logs from last boot:</para>
+                <para>Show all kernel logs from previous boot:</para>

 
 

-                <programlisting>journalctl -k -b :</programlisting>
+                <programlisting>journalctl -k -b -1</programlisting>

 
         </refsect1>
 
 
         </refsect1>