chiark / gitweb /
~ianmdlvl / elogind.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
build-sys: update intructions for Makefile-man.am regeneration
[elogind.git] / man / journalctl.xml
diff --git a/man/journalctl.xml b/man/journalctl.xml
index 8680e53285fd8a651099e458624ed6c6dce67df5..78fc6f616066be8aaf4e35a70c776e3f842314cf 100644 (file)
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="journalctl">
+<refentry id="journalctl"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>journalctl</title>
 
         <refentryinfo>
                 <title>journalctl</title>
@@ -84,7 +85,7 @@
                 alternatives, i.e. the resulting output will show
                 entries matching any of the specified matches for the
                 same field. Finally, if the character
                 alternatives, i.e. the resulting output will show
                 entries matching any of the specified matches for the
                 same field. Finally, if the character
-                <literal>+</literal> appears as separate word on the
+                <literal>+</literal> appears as a separate word on the
                 command line, all matches before and after are combined
                 in a disjunction (i.e. logical OR).</para>
 
                 command line, all matches before and after are combined
                 in a disjunction (i.e. logical OR).</para>
 
@@ -104,7 +105,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>
 
@@ -112,14 +113,14 @@
                 <command>less</command> by default, and long lines are
                 "truncated" to screen width. The hidden part can be
                 viewed by using the left-arrow and right-arrow
                 <command>less</command> by default, and long lines are
                 "truncated" to screen width. The hidden part can be
                 viewed by using the left-arrow and right-arrow
-                keys. Paging can be disabled, see
-                <option>--no-pager</option> and section Environment
-                below.</para>
+                keys. Paging can be disabled; see the
+                <option>--no-pager</option> option and the "Environment"
+                section below.</para>
 
                 <para>When outputing to a tty, lines are colored
                 according to priority: lines of level ERROR and higher
 
                 <para>When outputing to a tty, lines are colored
                 according to priority: lines of level ERROR and higher
-                are colored red, lines of level NOTICE and higher are
-                highlighted, and other lines are displayed normally.
+                are colored red; lines of level NOTICE and higher are
+                highlighted; other lines are displayed normally.
                 </para>
         </refsect1>
 
                 </para>
         </refsect1>
 
@@ -130,33 +131,20 @@
 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>
-                                <term><option>-h</option></term>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>--version</option></term>
-
-                                <listitem><para>Prints a short version
-                                string and exits.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>--no-pager</option></term>
-
-                                <listitem><para>Do not pipe output into a
-                                pager.</para></listitem>
-                        </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>
@@ -223,7 +211,7 @@
                                 <term><option>-r</option></term>
                                 <term><option>--reverse</option></term>
 
                                 <term><option>-r</option></term>
                                 <term><option>--reverse</option></term>
 
-                                <listitem><para>Reverse output, so the newest
+                                <listitem><para>Reverse output so that the newest
                                 entries are displayed first.</para></listitem>
                         </varlistentry>
 
                                 entries are displayed first.</para></listitem>
                         </varlistentry>
 
@@ -281,7 +269,7 @@
                                                         <option>short-monotonic</option>
                                                 </term>
                                                 <listitem>
                                                         <option>short-monotonic</option>
                                                 </term>
                                                 <listitem>
-                                                        <para>is very similar
+                                                        <para>is very similar,
                                                         but shows monotonic
                                                         timestamps instead of
                                                         wallclock timestamps.
                                                         but shows monotonic
                                                         timestamps instead of
                                                         wallclock timestamps.
@@ -343,7 +331,7 @@
                                                         but formats them in
                                                         multiple lines in order
                                                         to make them more
                                                         but formats them in
                                                         multiple lines in order
                                                         to make them more
-                                                        readable for humans.</para>
+                                                        readable by humans.</para>
                                                 </listitem>
                                         </varlistentry>
 
                                                 </listitem>
                                         </varlistentry>
 
@@ -367,10 +355,10 @@
                                                 </term>
                                                 <listitem>
                                                         <para>generates a very
                                                 </term>
                                                 <listitem>
                                                         <para>generates a very
-                                                        terse output only
+                                                        terse output, only
                                                         showing the actual
                                                         message of each journal
                                                         showing the actual
                                                         message of each journal
-                                                        entry with no meta data,
+                                                        entry with no metadata,
                                                         not even a timestamp.
                                                         </para>
                                                 </listitem>
                                                         not even a timestamp.
                                                         </para>
                                                 </listitem>
@@ -392,7 +380,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
@@ -400,7 +388,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>
@@ -408,8 +403,8 @@
                                 <term><option>--quiet</option></term>
 
                                 <listitem><para>Suppresses any warning
                                 <term><option>--quiet</option></term>
 
                                 <listitem><para>Suppresses any warning
-                                message regarding inaccessible system
-                                journals when run as normal
+                                messages regarding inaccessible system
+                                journals when run as a normal
                                 user.</para></listitem>
                         </varlistentry>
 
                                 user.</para></listitem>
                         </varlistentry>
 
@@ -441,11 +436,11 @@
                                 <replaceable>offset</replaceable> will look up
                                 boots starting from the end of the
                                 journal. Thus, <constant>1</constant> means the
                                 <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
+                                first boot found in the journal in
                                 chronological order, <constant>2</constant> the
                                 second and so on; while <constant>-0</constant>
                                 is the last boot, <constant>-1</constant> 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
+                                boot before last, 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
                                 <replaceable>offset</replaceable> is equivalent
                                 to specifying <constant>-0</constant>, except
                                 when the current boot is not the last boot
@@ -453,7 +448,7 @@
                                 specified to look at logs from a different
                                 machine).</para>
 
                                 specified to look at logs from a different
                                 machine).</para>
 
-                                <para>If the 32 character
+                                <para>If the 32-character
                                 <replaceable>ID</replaceable> is specified, it
                                 may optionally be followed by
                                 <replaceable>offset</replaceable> which
                                 <replaceable>ID</replaceable> is specified, it
                                 may optionally be followed by
                                 <replaceable>offset</replaceable> which
@@ -462,7 +457,7 @@
                                 values mean earlier boots and a positive values
                                 mean later boots. If
                                 <replaceable>offset</replaceable> is not
                                 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
+                                specified, a value of zero is assumed, and the
                                 logs for the boot given by
                                 <replaceable>ID</replaceable> are shown.
                                 </para>
                                 logs for the boot given by
                                 <replaceable>ID</replaceable> are shown.
                                 </para>
@@ -470,6 +465,17 @@
                                 </listitem>
                         </varlistentry>
 
                                 </listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>--list-boots</option></term>
+
+                                <listitem><para>Show a tabular list of
+                                boot numbers (relative to the current
+                                boot), their IDs, and the timestamps
+                                of the first and last message
+                                pertaining to the boot.
+                                </para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><option>-k</option></term>
                                 <term><option>--dmesg</option></term>
                         <varlistentry>
                                 <term><option>-k</option></term>
                                 <term><option>--dmesg</option></term>
@@ -482,17 +488,27 @@
 
                         <varlistentry>
                                 <term><option>-u</option></term>
 
                         <varlistentry>
                                 <term><option>-u</option></term>
-                                <term><option>--unit=</option></term>
+                                <term><option>--unit=<replaceable>UNIT</replaceable>|<replaceable>PATTERN</replaceable></option></term>
 
                                 <listitem><para>Show messages for the
 
                                 <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>
+                                specified systemd unit
+                                <replaceable>UNIT</replaceable>, or
+                                for any of the units matched by
+                                <replaceable>PATTERN</replaceable>.
+                                If a pattern is specified, a list of
+                                unit names found in the journal is
+                                compared with the specified pattern
+                                and all that match are used. For each
+                                unit name, a match is added for
+                                messages from the unit
+                                (<literal>_SYSTEMD_UNIT=<replaceable>UNIT</replaceable></literal>),
+                                along with 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>
                         </varlistentry>
 
                         <varlistentry>
@@ -558,11 +574,23 @@
                         <varlistentry>
                                 <term><option>--after-cursor=</option></term>
 
                         <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>
+                                <listitem><para>Start showing entries
+                                from the location in the journal
+                                <emphasis>after</emphasis> the
+                                location specified by the this cursor.
+                                The cursor is shown when the
+                                <option>--show-cursor</option> option
+                                is used.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--show-cursor</option></term>
+
+                                <listitem><para>The cursor is shown after the last
+                                entry after two dashes:</para>
+                                <programlisting>-- cursor: s=0639...</programlisting>
+                                <para>The format of the cursor is private
+                                and subject to change.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
@@ -612,7 +640,7 @@
 
                                 <listitem><para>Show messages from
                                 system services and the kernel (with
 
                                 <listitem><para>Show messages from
                                 system services and the kernel (with
-                                <option>--system</option>).  Show
+                                <option>--system</option>). Show
                                 messages from service of current user
                                 (with <option>--user</option>).
                                 If neither is specified, show all
                                 messages from service of current user
                                 (with <option>--user</option>).
                                 If neither is specified, show all
@@ -620,6 +648,16 @@
                                 </para></listitem>
                         </varlistentry>
 
                                 </para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>-M</option></term>
+                                <term><option>--machine=</option></term>
+
+                                <listitem><para>Show messages from a
+                                running, local container. Specify a
+                                container name to connect
+                                to.</para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><option>-D <replaceable>DIR</replaceable></option></term>
                                 <term><option>--directory=<replaceable>DIR</replaceable></option></term>
                         <varlistentry>
                                 <term><option>-D <replaceable>DIR</replaceable></option></term>
                                 <term><option>--directory=<replaceable>DIR</replaceable></option></term>
@@ -636,7 +674,7 @@
                         <varlistentry>
                                 <term><option>--file=<replaceable>GLOB</replaceable></option></term>
 
                         <varlistentry>
                                 <term><option>--file=<replaceable>GLOB</replaceable></option></term>
 
-                                <listitem><para>Takes a file glob as
+                                <listitem><para>Takes a file glob as an
                                 argument. If specified, journalctl will
                                 operate on the specified journal files
                                 matching <replaceable>GLOB</replaceable>
                                 argument. If specified, journalctl will
                                 operate on the specified journal files
                                 matching <replaceable>GLOB</replaceable>
@@ -650,7 +688,7 @@
                                 <term><option>--root=<replaceable>ROOT</replaceable></option></term>
 
                                 <listitem><para>Takes a directory path
                                 <term><option>--root=<replaceable>ROOT</replaceable></option></term>
 
                                 <listitem><para>Takes a directory path
-                                as argument. If specified, journalctl
+                                as an argument. If specified, journalctl
                                 will operate on catalog file hierarchy
                                 underneath the specified directory
                                 instead of the root directory
                                 will operate on catalog file hierarchy
                                 underneath the specified directory
                                 instead of the root directory
@@ -664,8 +702,8 @@
                                 <term><option>--new-id128</option></term>
 
                                 <listitem><para>Instead of showing
                                 <term><option>--new-id128</option></term>
 
                                 <listitem><para>Instead of showing
-                                journal contents, generate a new 128
-                                bit ID suitable for identifying
+                                journal contents, generate a new 128-bit
+                                ID suitable for identifying
                                 messages. This is intended for usage
                                 by developers who need a new
                                 identifier for a new message they
                                 messages. This is intended for usage
                                 by developers who need a new
                                 identifier for a new message they
@@ -695,16 +733,16 @@
 
                         <varlistentry>
                                 <term><option>--list-catalog
 
                         <varlistentry>
                                 <term><option>--list-catalog
-                                <optional><replaceable>ID128...</replaceable></optional>
+                                <optional><replaceable>128-bit-ID...</replaceable></optional>
                                 </option></term>
 
                                 <listitem><para>List the contents of
                                 </option></term>
 
                                 <listitem><para>List the contents of
-                                the message catalog, as table of
-                                message IDs plus their short
+                                the message catalog as a table of
+                                message IDs, plus their short
                                 description strings.</para>
 
                                 <para>If any
                                 description strings.</para>
 
                                 <para>If any
-                                <replaceable>ID128</replaceable>s are
+                                <replaceable>128-bit-ID</replaceable>s are
                                 specified, only those entries are shown.
                                 </para>
                                 </listitem>
                                 specified, only those entries are shown.
                                 </para>
                                 </listitem>
@@ -712,18 +750,18 @@
 
                         <varlistentry>
                                 <term><option>--dump-catalog
 
                         <varlistentry>
                                 <term><option>--dump-catalog
-                                <optional><replaceable>ID128...</replaceable></optional>
+                                <optional><replaceable>128-bit-ID...</replaceable></optional>
                                 </option></term>
 
                                 <listitem><para>Show the contents of
                                 the message catalog, with entries
                                 separated by a line consisting of two
                                 </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
+                                dashes and the ID (the format is the
                                 same as <filename>.catalog</filename>
                                 same as <filename>.catalog</filename>
-                                files.</para>
+                                files).</para>
 
                                 <para>If any
 
                                 <para>If any
-                                <replaceable>ID128</replaceable>s are
+                                <replaceable>128-bit-ID</replaceable>s are
                                 specified, only those entries are shown.
                                 </para>
                                 </listitem>
                                 specified, only those entries are shown.
                                 </para>
                                 </listitem>
@@ -735,7 +773,7 @@
                                 <listitem><para>Update the message
                                 catalog index. This command needs to
                                 be executed each time new catalog
                                 <listitem><para>Update the message
                                 catalog index. This command needs to
                                 be executed each time new catalog
-                                files are installed, removed or
+                                files are installed, removed, or
                                 updated to rebuild the binary catalog
                                 index.</para></listitem>
                         </varlistentry>
                                 updated to rebuild the binary catalog
                                 index.</para></listitem>
                         </varlistentry>
@@ -751,18 +789,23 @@
                                 sealing key is stored in the journal
                                 data directory and shall remain on the
                                 host. The verification key should be
                                 sealing key is stored in the journal
                                 data directory and shall remain on the
                                 host. The verification key should be
-                                stored externally. Also see the
+                                stored externally. Refer to the
                                 <option>Seal=</option> option in
                                 <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                 <option>Seal=</option> option in
                                 <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-                                for details.</para></listitem>
+                                for information on Forward Secure
+                                Sealing and for a link to a refereed
+                                scholarly paper detailing the
+                                cryptographic theory it is based on.
+                                </para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><option>--force</option></term>
 
                         </varlistentry>
 
                         <varlistentry>
                                 <term><option>--force</option></term>
 
-                                <listitem><para>When --setup-keys is passed and
-                                Forward Secure Sealing has already been set up,
-                                recreate FSS keys.</para></listitem>
+                                <listitem><para>When
+                                <option>--setup-keys</option> is passed and
+                                Forward Secure Sealing (FSS) has already been
+                                configured, recreate FSS keys.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
@@ -801,31 +844,20 @@
                                 operation.</para></listitem>
                         </varlistentry>
 
                                 operation.</para></listitem>
                         </varlistentry>
 
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
+                        <xi:include href="standard-options.xml" xpointer="no-pager" />
                 </variablelist>
         </refsect1>
 
         <refsect1>
                 <title>Exit status</title>
 
                 </variablelist>
         </refsect1>
 
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success, 0 is returned, a non-zero failure
-                code otherwise.</para>
+                <para>On success, 0 is returned; otherwise, a non-zero
+                failure code is returned.</para>
         </refsect1>
 
         </refsect1>
 
-        <refsect1>
-                <title>Environment</title>
-
-                <variablelist class='environment-variables'>
-                        <varlistentry>
-                                <term><varname>$SYSTEMD_PAGER</varname></term>
-                                <listitem><para>Pager to use when
-                                <option>--no-pager</option> is not given;
-                                overrides <varname>$PAGER</varname>.  Setting
-                                this to an empty string or the value
-                                <literal>cat</literal> is equivalent to passing
-                                <option>--no-pager</option>.</para></listitem>
-                        </varlistentry>
-                </variablelist>
-        </refsect1>
+        <xi:include href="less-variables.xml" />
 
         <refsect1>
                 <title>Examples</title>
 
         <refsect1>
                 <title>Examples</title>
Unnamed repository; edit this file 'description' to name the repository.