pager: introduce "jump to end" option

[elogind.git] / man / journalctl.xml

diff --git a/man/journalctl.xml b/man/journalctl.xml
index a533f4d0ea1f7fe44a03eb18e7a64a0f1d640cc6..201f66a3b5378e923c20be5df8186335fcbc42af 100644 (file)
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -114,8 +114,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 +136,15 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--all</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 +153,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 +163,30 @@
                         </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. Very useful in
+                                combination with the
+                                <option>-b</option> option. Note that
+                                this 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 +199,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


@@ -215,7 +241,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


@@ -233,8 +262,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


@@ -243,8 +296,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


@@ -253,8 +306,8 @@
                         </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
                                 current boot. This will add a match
 
                                 <listitem><para>Show data only from
                                 current boot. This will add a match


@@ -264,8 +317,8 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--unit=</option></term>

                                 <term><option>-u</option></term>
                                 <term><option>-u</option></term>

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

 
                                 <listitem><para>Show data only of the
                                 specified unit. This will add a match
 
                                 <listitem><para>Show data only of the
                                 specified unit. This will add a match


@@ -274,6 +327,17 @@
                                 unit.</para></listitem>
                         </varlistentry>
 
                                 unit.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--user-unit=</option></term>
+
+                                <listitem><para>Show data only of the
+                                specified user session unit. This will
+                                add a match for
+                                <literal>_SYSTEMD_USER_UNIT=</literal>
+                                for the specified
+                                unit.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>-p</option></term>
                                 <term><option>--priority=</option></term>
                         <varlistentry>
                                 <term><option>-p</option></term>
                                 <term><option>--priority=</option></term>


@@ -310,8 +374,8 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--cursor=</option></term>

                                 <term><option>-c</option></term>
                                 <term><option>-c</option></term>

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

 
                                 <listitem><para>Start showing entries
                                 from the location in the journal
 
                                 <listitem><para>Start showing entries
                                 from the location in the journal


@@ -331,7 +395,7 @@
                                 the time part is omitted, 00:00:00 is
                                 assumed. If only the seconds component
                                 is omitted, :00 is assumed. If the
                                 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
+                                date component is omitted, the

                                 current day is assumed. Alternatively
                                 the strings
                                 <literal>yesterday</literal>,
                                 current day is assumed. Alternatively
                                 the strings
                                 <literal>yesterday</literal>,


@@ -350,8 +414,18 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

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

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

 
                                 <listitem><para>Takes an absolute
                                 directory path as argument. If
 
                                 <listitem><para>Takes an absolute
                                 directory path as argument. If


@@ -394,6 +468,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>
 


@@ -457,7 +551,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