journal: implement message catalog

[elogind.git] / man / journalctl.xml

diff --git a/man/journalctl.xml b/man/journalctl.xml
index 4208fb4edc64e97d9d548313df43884507df6c77..e7fff0c9dca23e7fa0a884779fad8c1c0c0c8b8a 100644 (file)
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -159,16 +159,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. 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>


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


@@ -232,6 +232,25 @@
                                 even a timestamp.</para></listitem>
                         </varlistentry>
 
                                 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.</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>


@@ -351,7 +370,7 @@
 
                         <varlistentry>
                                 <term><option>--field=</option></term>
 
                         <varlistentry>
                                 <term><option>--field=</option></term>

-                                <term><option>-f</option></term>
+                                <term><option>-F</option></term>

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


@@ -404,6 +423,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>