journalctl: add --system/--user flags

[elogind.git] / man / journalctl.xml

diff --git a/man/journalctl.xml b/man/journalctl.xml
index d8f8f689295843e1ec77d659d45e7e2aff849c26..66100816ae4070c4ce7bce35dc60da32ad733fb8 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>
 


@@ -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>


@@ -143,8 +145,8 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

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

                                 <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


@@ -153,8 +155,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


@@ -163,8 +165,26 @@
                         </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>Show the most recent
                                 journal events and limit the number of
 
                                 <listitem><para>Show the most recent
                                 journal events and limit the number of


@@ -185,8 +205,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


@@ -240,8 +268,8 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--catalog</option></term>

                                 <term><option>-x</option></term>
                                 <term><option>-x</option></term>

+                                <term><option>--catalog</option></term>

 
                                 <listitem><para>Augment log lines with
                                 explanation texts from the message
 
                                 <listitem><para>Augment log lines with
                                 explanation texts from the message


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

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

                                 <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


@@ -274,8 +302,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


@@ -284,8 +312,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


@@ -295,14 +323,43 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--unit=</option></term>
+                                <term><option>-k</option></term>
+                                <term><option>--dmesg</option></term>
+
+                                <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>

                                 <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
-                                for <literal>_SYSTEMD_UNIT=</literal>
-                                for the specified
-                                unit.</para></listitem>
+                                <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>
+
+                        <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>


@@ -341,8 +398,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


@@ -381,8 +438,8 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--field=</option></term>

                                 <term><option>-F</option></term>
                                 <term><option>-F</option></term>

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

 
                                 <listitem><para>Print all possible
                                 data values the specified field can
 
                                 <listitem><para>Print all possible
                                 data values the specified field can


@@ -391,10 +448,24 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

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

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

 
 

-                                <listitem><para>Takes an absolute
+                                <listitem><para>Takes a

                                 directory path as argument. If
                                 specified journalctl will operate on the
                                 specified journal directory instead of
                                 directory path as argument. If
                                 specified journalctl will operate on the
                                 specified journal directory instead of


@@ -402,6 +473,20 @@
                                 paths.</para></listitem>
                         </varlistentry>
 
                                 paths.</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>
                                 <term><option>--new-id128</option></term>
 
                         <varlistentry>
                                 <term><option>--new-id128</option></term>
 


@@ -436,12 +521,39 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

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

-                                description strings.</para></listitem>
+                                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>
                         </varlistentry>
 
                         <varlistentry>


@@ -564,7 +676,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>