mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-27 20:23:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

man: improve readability of --output options in journalctl(1)

Browse Source 
The list and descriptions of valid output options was difficult to read,
so break up the long block of text into discrete man page list items to
improve readability.
This commit is contained in:
Jason St. John 2013-07-16 10:20:03 +02:00 committed by Lennart Poettering
parent 6ed80a4e34
commit 9c33d34fe4
2 changed files with 120 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

166
man/journalctl.xml
View File

@ -233,53 +233,125 @@
<listitem><para>Controls the <listitem><para>Controls the
formatting of the journal entries that formatting of the journal entries that
are shown. Takes one of are shown. Takes one of the following options:
<literal>short</literal>, </para>
<literal>short-monotonic</literal>, <variablelist>
<literal>verbose</literal>, <varlistentry>
<literal>export</literal>, <term>
<literal>json</literal>, <option>short</option>
<literal>json-pretty</literal>, </term>
<literal>json-sse</literal>, <listitem>
<literal>cat</literal>. <literal>short</literal> <para>is the default
is the default and generates an output and generates an output
that is mostly identical to the that is mostly identical
formatting of classic syslog to the formatting of
files, showing one line per journal classic syslog files,
entry. <literal>short-monotonic</literal> showing one line per
is very similar but shows monotonic journal entry.</para>
timestamps instead of wallclock </listitem>
timestamps. <literal>verbose</literal> </varlistentry>
shows the full structured entry items
with all <varlistentry>
fields. <literal>export</literal> <term>
serializes the journal into a binary <option>short-monotonic</option>
(but mostly text-based) stream </term>
suitable for backups and network <listitem>
transfer (see <ulink <para>is very similar
url="http://www.freedesktop.org/wiki/Software/systemd/export">Journal but shows monotonic
Export Format</ulink> for more timestamps instead of
information). <literal>json</literal> wallclock timestamps.
formats entries as JSON data </para>
structures, one per </listitem>
line (see <ulink </varlistentry>
url="http://www.freedesktop.org/wiki/Software/systemd/json">Journal
JSON Format</ulink> for more <varlistentry>
information). <literal>json-pretty</literal> <term>
also formats entries as JSON data <option>verbose</option>
structures, but formats them in </term>
multiple lines in order to make them <listitem>
more readable for <para>shows the
humans. <literal>json-sse</literal> full-structured entry
also formats entries as JSON data items with all fields.
structures, but wraps them in a format </para>
suitable for <ulink </listitem>
url="https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events">Server-Sent </varlistentry>
Events</ulink>. <literal>cat</literal>
generates a very terse output only <varlistentry>
showing the actual message of each <term>
journal entry with no meta data, not <option>export</option>
even a timestamp.</para></listitem> </term>
<listitem>
<para>serializes the
journal into a binary
(but mostly text-based)
stream suitable for
backups and network
transfer (see <ulink
url="http://www.freedesktop.org/wiki/Software/systemd/export">Journal
Export Format</ulink>
for more
information).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>json</option>
</term>
<listitem>
<para>formats entries
as JSON data structures,
one per line (see <ulink
url="http://www.freedesktop.org/wiki/Software/systemd/json">Journal
JSON Format</ulink> for
more information).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>json-pretty</option>
</term>
<listitem>
<para>formats entries as
JSON data structures,
but formats them in
multiple lines in order
to make them more
readable for humans.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>json-sse</option>
</term>
<listitem>
<para>formats entries as
JSON data structures,
but wraps them in a
format suitable for <ulink
url="https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events">Server-Sent
Events</ulink>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>cat</option>
</term>
<listitem>
<para>generates a very
terse output only
showing the actual
message of each journal
entry with no meta data,
not even a timestamp.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

2
man/systemd.scope.xml
View File

@ -59,7 +59,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
by systemd to encapsulate processes not launched by systemd by systemd to encapsulate processes not launched by systemd
itself. This management is performed by creating a node in the itself. This management is performed by creating a node in the
control group tree. Processes are moved into the scope by means control group tree. Processes are moved into the scope by means
of the DBus API. of the D-Bus API.
<command>systemd-run <option>--scope</option></command> can be <command>systemd-run <option>--scope</option></command> can be
used to easily launch a command in a new scope unit.</para> used to easily launch a command in a new scope unit.</para>