From 5c3246b1a6bbe8c44210f7a73f0e030dcb21f7bb Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Fri, 16 Mar 2012 01:00:23 +0100
Subject: [PATCH] man: document journal features of systemctl(1)

---
 TODO                       |  6 ----
 man/systemctl.xml          | 57 ++++++++++++++++++++++++++++++++------
 man/systemd-journalctl.xml |  8 +++---
 3 files changed, 53 insertions(+), 18 deletions(-)

diff --git a/TODO b/TODO
index 2f5e64319..e200c9029 100644
--- a/TODO
+++ b/TODO
@@ -82,10 +82,6 @@ Features:
 
 * add interface to allow immediate rotation of the journal, and even flushing.
 
-* don't log coredumps of PID 1 into the journal
-
-* if a journal file is corrupt, rotate it and create a new one
-
 * dbus: in fedora, make the machine a symlink to /etc/machine-id
 
 * journald: reuse XZ context
@@ -94,8 +90,6 @@ Features:
 
 * write RPM spec macros for presets
 
-* write man pages for systemd-cat
-
 * journal: write man pages for API
 
 * journal: OR matches are borked
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 3266333be..c467ed8bf 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -414,6 +414,45 @@
                                 PolicyKit before executing the
                                 operation.</para></listitem>
                         </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--lines=</option></term>
+                                <term><option>-n</option></term>
+
+                                <listitem><para>When used with
+                                <command>status</command> controls the
+                                number of journal lines to show,
+                                counting from the most recent
+                                ones. Takes a positive integer
+                                argument. Defaults to
+                                10.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--follow</option></term>
+                                <term><option>-f</option></term>
+
+                                <listitem><para>When used with
+                                <command>status</command> continously
+                                prints new journal entries as they are
+                                appended to the
+                                journal.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--output=</option></term>
+                                <term><option>-o</option></term>
+
+                                <listitem><para>When used with
+                                <command>status</command> controls the
+                                formatting of the journal entries that
+                                are shown. For the available choices
+                                see
+                                <citerefentry><refentrytitle>systemd-journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. Defaults
+                                to
+                                <literal>short</literal>.</para></listitem>
+                        </varlistentry>
+
                 </variablelist>
 
                 <para>The following commands are understood:</para>
@@ -558,14 +597,15 @@
 
                                 <listitem><para>Show terse runtime
                                 status information about one or more
-                                units. This function is intended to
-                                generate human-readable output. If you
-                                are looking for computer-parsable
-                                output, use <command>show</command>
-                                instead. If a PID is passed
-                                information about the unit the process
-                                of the PID belongs to is
-                                shown.</para></listitem>
+                                units, followed by its most recent log
+                                data from the journal. This function
+                                is intended to generate human-readable
+                                output. If you are looking for
+                                computer-parsable output, use
+                                <command>show</command> instead. If a
+                                PID is passed information about the
+                                unit the process of the PID belongs to
+                                is shown.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>show [NAME...|JOB...]</command></term>
@@ -1139,6 +1179,7 @@
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
diff --git a/man/systemd-journalctl.xml b/man/systemd-journalctl.xml
index ff3bb3d05..1441ecaca 100644
--- a/man/systemd-journalctl.xml
+++ b/man/systemd-journalctl.xml
@@ -125,9 +125,9 @@
                                 <term><option>-f</option></term>
 
                                 <listitem><para>Show only most recent
-                                entries, and continously print new
-                                entries as they are appended to the
-                                journal.</para></listitem>
+                                journal entries, and continously print
+                                new entries as they are appended to
+                                the journal.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
@@ -157,7 +157,7 @@
                                 <term><option>-o</option></term>
 
                                 <listitem><para>Controls the
-                                formatting of the entries that are
+                                formatting of the journal entries that are
                                 shown. Takes one of
                                 <literal>short</literal>,
                                 <literal>short-monotonic</literal>,
-- 
2.30.2