Commit 2af777ba authored by Lennart Poettering's avatar Lennart Poettering
Browse files

man: document systemd-journalctl(1)

parent b47ffcfd
......@@ -694,7 +694,8 @@ MANPAGES = \
man/systemd-ask-password.1 \
man/systemd-cat.1 \
man/systemd-machine-id-setup.1 \
man/systemd-journald.conf.5 \
man/reboot.8 \
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
This file is part of systemd.
Copyright 2012 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
General Public License for more details.
You should have received a copy of the GNU General Public License
along with systemd; If not, see <>.
<refentry id="systemd-journalctl">
<refpurpose>Query the systemd journal</refpurpose>
<command>systemd-journalctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">MATCH</arg></command>
<para><command>systemd-journalctl</command> may be
used to query the contents of the
<para>If called without parameter will show the full
contents of the journal, starting with the oldest
entry collected.</para>
<para>If a match argument is passed the output is
filtered accordingly. A match is in the format
e.g. <literal>_SYSTEMD_UNIT=httpd.service</literal>.</para>
<para>Output is interleaved from all accessible
journal files, whether they are rotated or currently
being written, and regardless whether they belong to the
system itself or are accessible user journals.</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>
group get access to the system journal and the
journals of other users.</para>
<para>The following options are understood:</para>
<listitem><para>Prints a short help
text and exits.</para></listitem>
<listitem><para>Prints a short version
string and exits.</para></listitem>
<listitem><para>Do not pipe output into a
<listitem><para>Show all fields in
full, even if they include unprintable
characters or are very
<listitem><para>Show only most recent
entries, and continously print new
entries as they are appended to the
<listitem><para>Controls the number of
journal lines to show, counting from
the most recent ones. Takes a positive
integer argument. In follow mode
defaults to 10, otherwise is unset
thus not limiting how many lines are
<listitem><para>Show all stored output
lines, even in follow mode. Undoes the
effect of
<listitem><para>Controls the
formatting of the entries that are
shown. Takes one of
<literal>cat</literal>. <literal>short</literal>
is the default and generates an output
that is mostly identical to the
formatting of classic syslog log
files, showing one line per journal
entry. <literal>short-monotonic</literal>
is very similar but shows monotonic
timestamps instead of wallclock
timestamps. <literal>verbose</literal>
shows the full structered entry items
with all
fiels. <literal>export</literal>
serializes the journal into a binary
(but mostly text-based) stream
suitable for backups and network
transfer. <literal>json</literal>
formats entries as JSON data
structures. <literal>cat</literal>
generates a very terse output only
showing the actual message of each
journal entry with no meta data, not
even a timestamp.</para></listitem>
<listitem><para>Suppresses any warning
message regarding inaccessable system
journals when run as normal
<listitem><para>Instead of showing
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
introduce and want to make
recognizable. Will print the new ID in
three different formats which can be
copied into source code or
<title>Exit status</title>
<para>On success 0 is returned, a non-zero failure
code otherwise.</para>
<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
<title>See Also</title>
......@@ -54,7 +54,7 @@ static int help(void) {
" -h --help Show this help\n"
" --version Show package version\n"
" --no-pager Do not pipe output into a pager\n"
" -a --all Show all properties, including long and unprintable\n"
" -a --all Show all fields, including long and unprintable\n"
" -f --follow Follow journal\n"
" -n --lines=INTEGER Journal entries to show\n"
" --no-tail Show all lines, even in follow mode\n"
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment