journalctl: advertise --header a bit more
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Fri, 4 Mar 2022 15:39:34 +0000 (16:39 +0100)
committerLuca Boccassi <luca.boccassi@gmail.com>
Thu, 10 Mar 2022 12:54:30 +0000 (12:54 +0000)
Fixes #2738.

(cherry picked from commit 367a5e8a67bbc2b5e03ca1a3e5a601ef49b5bd2a)
(cherry picked from commit 7302937a08dcc33186eaf4bc3e7bc58af4979ffe)

man/journalctl.xml

index 9e784f3d3c5354f86b99066084196ad386913ad4..424acc9f163ebb2587ca1f92838ff9812aa75a48 100644 (file)
       <option>--boot</option>, <option>--unit=</option>, etc., to
       further limit what entries will be shown (logical AND).</para>
 
-      <para>Output is interleaved from all accessible journal files,
-      whether they are rotated or currently being written, and
-      regardless of whether they belong to the system itself or are
-      accessible user journals.</para>
+      <para>Output is interleaved from all accessible journal files, whether they are rotated or currently
+      being written, and regardless of whether they belong to the system itself or are accessible user
+      journals. The <option>--header</option> option can be used to identify which files
+      <emphasis>are</emphasis> being shown.</para>
 
       <para>The set of journal files which will be used can be
       modified using the <option>--user</option>,
       <varlistentry>
         <term><option>--header</option></term>
 
-        <listitem><para>Instead of showing journal contents, show
-        internal header information of the journal fields
-        accessed.</para></listitem>
+        <listitem><para>Instead of showing journal contents, show internal header information of the journal
+        fields accessed.</para>
+
+        <para>This option is particularly useful when trying to identify out-of-order journal entries, as
+        happens for example when the machine is booted with the wrong system time.</para></listitem>
       </varlistentry>
 
       <varlistentry>