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>
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>
<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>
<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
- 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>
<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>-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>
<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>
<option>short-monotonic</option>
</term>
<listitem>
- <para>is very similar
+ <para>is very similar,
but shows monotonic
timestamps instead of
wallclock timestamps.
but formats them in
multiple lines in order
to make them more
- readable for humans.</para>
+ readable by humans.</para>
</listitem>
</varlistentry>
</term>
<listitem>
<para>generates a very
- terse output only
+ terse output, only
showing the actual
message of each journal
- entry with no meta data,
+ entry with no metadata,
not even a timestamp.
</para>
</listitem>
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
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>
<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>
<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
- 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
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
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>
</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>-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
- 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>
<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>
<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
</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>--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>
<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
<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
<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
- 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
- <replaceable>ID128</replaceable>s are
+ <replaceable>128-bit-ID</replaceable>s are
specified, only those entries are shown.
</para>
</listitem>
<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
- dashes and the id (the format is the
+ dashes and the ID (the format is the
same as <filename>.catalog</filename>
- files.</para>
+ files).</para>
<para>If any
- <replaceable>ID128</replaceable>s are
+ <replaceable>128-bit-ID</replaceable>s are
specified, only those entries are shown.
</para>
</listitem>
<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>
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>
- 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>
- <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>
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>
- <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>
- <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>
~ianmdlvl / elogind.git / blobdiff