[systemd-commits] 2 commits - man/binfmt.d.xml man/journalctl.xml man/journald.conf.xml man/machine-id.xml man/os-release.xml man/sd-id128.xml man/systemd.cgroup.xml man/systemd.exec.xml man/systemd.scope.xml man/systemd.xml

Lennart Poettering lennart at kemper.freedesktop.org
Tue Jul 16 08:46:37 PDT 2013


 man/binfmt.d.xml       |    2 
 man/journalctl.xml     |  166 +++++++++++++++++++++++++++++++++++--------------
 man/journald.conf.xml  |    2 
 man/machine-id.xml     |    2 
 man/os-release.xml     |    2 
 man/sd-id128.xml       |    2 
 man/systemd.cgroup.xml |   20 ++---
 man/systemd.exec.xml   |    6 -
 man/systemd.scope.xml  |    2 
 man/systemd.xml        |    2 
 10 files changed, 139 insertions(+), 67 deletions(-)

New commits:
commit 9c33d34fe4cd0bc58ea12e5258e595647c9e0b29
Author: Jason St. John <jstjohn at purdue.edu>
Date:   Tue Jul 16 10:20:03 2013 +0200

    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.

diff --git a/man/journalctl.xml b/man/journalctl.xml
index 0e779b9..027f22d 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 6cd8c88..126440a 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>
 

commit 6ed80a4e346883b99263a1a13505ef6afcbc09c3
Author: Jason St. John <jstjohn at purdue.edu>
Date:   Tue Jul 16 10:19:00 2013 +0200

    man: use HTTPS links for links that support it

diff --git a/man/binfmt.d.xml b/man/binfmt.d.xml
index 7f31b76..f4f4195 100644
--- a/man/binfmt.d.xml
+++ b/man/binfmt.d.xml
@@ -67,7 +67,7 @@
 
                 <para>Each file contains a list of binfmt_misc kernel
                 binary format rules. Consult <ulink
-                url="http://www.kernel.org/doc/Documentation/binfmt_misc.txt">binfmt_misc.txt</ulink>
+                url="https://www.kernel.org/doc/Documentation/binfmt_misc.txt">binfmt_misc.txt</ulink>
                 for more information on registration of additional
                 binary formats and how to write rules.</para>
 
diff --git a/man/journald.conf.xml b/man/journald.conf.xml
index 5986d61..487e8d6 100644
--- a/man/journald.conf.xml
+++ b/man/journald.conf.xml
@@ -133,7 +133,7 @@
                                 command), forward secure sealing (FSS)
                                 for all persistent journal files is
                                 enabled. FSS is based on <ulink
-                                url="http://eprint.iacr.org/2013/397">Seekable
+                                url="https://eprint.iacr.org/2013/397">Seekable
                                 Sequential Key Generators</ulink> by
                                 G. A. Marson and B. Poettering and
                                 may be used to protect journal files
diff --git a/man/machine-id.xml b/man/machine-id.xml
index b037e47..4b4759e 100644
--- a/man/machine-id.xml
+++ b/man/machine-id.xml
@@ -93,7 +93,7 @@
 
                 <para>Note that the machine ID historically is not an
                 OSF UUID as defined by <ulink
-                url="http://tools.ietf.org/html/rfc4122">RFC
+                url="https://tools.ietf.org/html/rfc4122">RFC
                 4122</ulink>, nor a Microsoft GUID; however, starting with
                 systemd v30, newly generated machine IDs do
                 qualify as v4 UUIDs.</para>
diff --git a/man/os-release.xml b/man/os-release.xml
index d714b51..045dd08 100644
--- a/man/os-release.xml
+++ b/man/os-release.xml
@@ -241,7 +241,7 @@
 
                                 <listitem><para>A CPE name for the
                                 operating system, following the <ulink
-                                url="http://cpe.mitre.org/specification/">Common
+                                url="https://cpe.mitre.org/specification/">Common
                                 Platform Enumeration
                                 Specification</ulink> as proposed by
                                 the MITRE Corporation. This field
diff --git a/man/sd-id128.xml b/man/sd-id128.xml
index 02fb76b..3a5e133 100644
--- a/man/sd-id128.xml
+++ b/man/sd-id128.xml
@@ -71,7 +71,7 @@
                 process and generate 128-bit ID values. The 128-bit ID
                 values processed and generated by these APIs are a
                 generalization of OSF UUIDs as defined by <ulink
-                url="http://tools.ietf.org/html/rfc4122">RFC
+                url="https://tools.ietf.org/html/rfc4122">RFC
                 4122</ulink> but use a simpler string
                 format. These functions impose no structure on the
                 used IDs, much unlike OSF UUIDs or Microsoft GUIDs,
diff --git a/man/systemd.cgroup.xml b/man/systemd.cgroup.xml
index e31faf5..bb0cb1c 100644
--- a/man/systemd.cgroup.xml
+++ b/man/systemd.cgroup.xml
@@ -127,7 +127,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           controls the <literal>cpu.shares</literal> control group
           attribute, which defaults to 1024. For details about this
           control group attribute, see <ulink
-          url="http://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.</para>
+          url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.</para>
 
           <para>Implies <literal>CPUAccounting=true</literal>.</para>
         </listitem>
@@ -152,7 +152,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           <literal>memory.soft_limit_in_bytes</literal> control group
           attributes. For details about these control group attributes,
           see <ulink
-          url="http://www.kernel.org/doc/Documentation/cgroups/memory.txt">memory.txt</ulink>.</para>
+          url="https://www.kernel.org/doc/Documentation/cgroups/memory.txt">memory.txt</ulink>.</para>
 
           <para>Implies <literal>MemoryAccounting=true</literal>.</para>
         </listitem>
@@ -172,7 +172,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         defaults to 1000. For details about
         this control group attribute, see
         <ulink
-            url="http://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.</para></listitem>
+            url="https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -191,7 +191,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           attribute, which defaults to 1000. Use this option multiple
           times to set weights for multiple devices. For details about
           this control group attribute, see <ulink
-          url="http://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.</para>
+          url="https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.</para>
         </listitem>
       </varlistentry>
 
@@ -215,7 +215,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           attributes. Use this option multiple times to set bandwidth
           limits for multiple devices. For details about these control
           group attributes, see
-          <ulink url="http://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.
+          <ulink url="https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.
           </para>
         </listitem>
       </varlistentry>
@@ -236,7 +236,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           <literal>devices.deny</literal> control group
           attributes. For details about these control group attributes,
           see <ulink
-          url="http://www.kernel.org/doc/Documentation/cgroups/devices.txt">devices.txt</ulink>.</para>
+          url="https://www.kernel.org/doc/Documentation/cgroups/devices.txt">devices.txt</ulink>.</para>
         </listitem>
       </varlistentry>
 
@@ -299,10 +299,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
       The documentation for control groups and specific controllers in the Linux kernel:
-      <ulink url="http://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>,
-      <ulink url="http://www.kernel.org/doc/Documentation/cgroups/cpuacct.txt">cpuacct.txt</ulink>,
-      <ulink url="http://www.kernel.org/doc/Documentation/cgroups/memory.txt">memory.txt</ulink>,
-      <ulink url="http://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.
+      <ulink url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>,
+      <ulink url="https://www.kernel.org/doc/Documentation/cgroups/cpuacct.txt">cpuacct.txt</ulink>,
+      <ulink url="https://www.kernel.org/doc/Documentation/cgroups/memory.txt">memory.txt</ulink>,
+      <ulink url="https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.
     </para>
   </refsect1>
 </refentry>
diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index c995834..1169095 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -167,7 +167,7 @@
                                 for this process) and 1000 (to make
                                 killing of this process under memory
                                 pressure very likely). See <ulink
-                                url="http://www.kernel.org/doc/Documentation/filesystems/proc.txt">proc.txt</ulink>
+                                url="https://www.kernel.org/doc/Documentation/filesystems/proc.txt">proc.txt</ulink>
                                 for details.</para></listitem>
                         </varlistentry>
 
@@ -832,7 +832,7 @@
                                 and doing this might result in
                                 undefined behaviour. For details about
                                 control groups see <ulink
-                                url="http://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>.</para>
+                                url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>.</para>
 
                                 <para>This option may appear more than
                                 once, in which case the list of
@@ -923,7 +923,7 @@
                                 service is not desirable. For details
                                 about control group attributes see
                                 <ulink
-                                url="http://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>. This
+                                url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>. This
                                 option may appear more than once, in
                                 order to set multiple control group
                                 attributes. If this option is used
diff --git a/man/systemd.xml b/man/systemd.xml
index b4b4845..c7aed3c 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -425,7 +425,7 @@
                 individual Linux control groups named after the unit
                 which they belong to in the private systemd
                 hierarchy. (see <ulink
-                url="http://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>
+                url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>
                 for more information about control groups, or short
                 "cgroups"). systemd uses this to effectively keep
                 track of processes. Control group information is



More information about the systemd-commits mailing list