diff options
| author | Jason St. John <jstjohn@purdue.edu> | 2013-07-16 10:20:03 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2013-07-16 17:43:11 +0200 |
| commit | 9c33d34fe4cd0bc58ea12e5258e595647c9e0b29 (patch) | |
| tree | 3bac04b01cc73d654d4004f3088a37a9071be5fd /man | |
| parent | 6ed80a4e346883b99263a1a13505ef6afcbc09c3 (diff) | |
man: improve readability of --output options in journalctl(1)
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.
Diffstat (limited to 'man')
| -rw-r--r-- | man/journalctl.xml | 166 | ||||
| -rw-r--r-- | man/systemd.scope.xml | 2 |
2 files changed, 120 insertions, 48 deletions
diff --git a/man/journalctl.xml b/man/journalctl.xml index 0e779b952c..027f22d259 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -233,53 +233,125 @@ <listitem><para>Controls the formatting of the journal entries that - are shown. Takes one of - <literal>short</literal>, - <literal>short-monotonic</literal>, - <literal>verbose</literal>, - <literal>export</literal>, - <literal>json</literal>, - <literal>json-pretty</literal>, - <literal>json-sse</literal>, - <literal>cat</literal>. <literal>short</literal> - is the default and generates an output - that is mostly identical to the - formatting of classic syslog - 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 structured entry items - with all - fields. <literal>export</literal> - 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). <literal>json</literal> - 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). <literal>json-pretty</literal> - also formats entries as JSON data - structures, but formats them in - multiple lines in order to make them - more readable for - humans. <literal>json-sse</literal> - also 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>. <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> + are shown. Takes one of the following options: + </para> + <variablelist> + <varlistentry> + <term> + <option>short</option> + </term> + <listitem> + <para>is the default + and generates an output + that is mostly identical + to the formatting of + classic syslog files, + showing one line per + journal entry.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>short-monotonic</option> + </term> + <listitem> + <para>is very similar + but shows monotonic + timestamps instead of + wallclock timestamps. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>verbose</option> + </term> + <listitem> + <para>shows the + full-structured entry + items with all fields. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>export</option> + </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> diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml index 6cd8c8845a..126440a15f 100644 --- a/man/systemd.scope.xml +++ b/man/systemd.scope.xml @@ -59,7 +59,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. by systemd to encapsulate processes not launched by systemd itself. This management is performed by creating a node in the 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 used to easily launch a command in a new scope unit.</para> |