From: Lennart Poettering <lennart@poettering.net>
Date: Thu, 31 May 2012 23:05:38 +0000 (+0200)
Subject: man: document systemd-journal
X-Git-Tag: v185~19
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=01cf0ca850dd1c21e1c405a4493fe61d0c28d721;p=systemd

man: document systemd-journal
---

diff --git a/Makefile.am b/Makefile.am
index 2e29a0f4..597711ea 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -499,6 +499,7 @@ MANPAGES = \
 	man/systemd-machine-id-setup.1 \
 	man/systemd-detect-virt.1 \
 	man/journald.conf.5 \
+	man/systemd-journald.service.8 \
 	man/journalctl.1 \
 	man/systemd-inhibit.1
 
@@ -507,13 +508,15 @@ MANPAGES_ALIAS = \
 	man/poweroff.8 \
 	man/init.1 \
 	man/systemd-modules-load.8 \
-	man/systemd-sysctl.8
+	man/systemd-sysctl.8 \
+	man/systemd-journald.8
 
 man/reboot.8: man/halt.8
 man/poweroff.8: man/halt.8
 man/init.1: man/systemd.1
 man/systemd-modules-load.8: man/systemd-modules-load.service.8
 man/systemd-sysctl.8: man/systemd-sysctl.service.8
+man/systemd-journald.8: man/systemd-journald.service.8
 
 XML_FILES = \
 	${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}}
diff --git a/man/journalctl.xml b/man/journalctl.xml
index 5e0c6dd5..de02e4e2 100644
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -56,10 +56,11 @@
         <refsect1>
                 <title>Description</title>
 
-                <para><command>journalctl</command> may be
-                used to query the contents of the
+                <para><command>journalctl</command> may be used to
+                query the contents of the
                 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-                journal.</para>
+                journal as written by
+                <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 
                 <para>If called without parameter will show the full
                 contents of the journal, starting with the oldest
@@ -254,6 +255,7 @@
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
diff --git a/man/journald.conf.xml b/man/journald.conf.xml
index cce945b7..5ad0f02b 100644
--- a/man/journald.conf.xml
+++ b/man/journald.conf.xml
@@ -48,13 +48,15 @@
         </refnamediv>
 
         <refsynopsisdiv>
-                <para><filename>journald.conf</filename></para>
+                <para><filename>/etc/systemd/journald.conf</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
-                <para>This files configures various parameters of the systemd journal service.</para>
+                <para>This files configures various parameters of the
+                systemd journal service
+                <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 
         </refsect1>
 
@@ -246,6 +248,7 @@
                   <title>See Also</title>
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
diff --git a/man/logind.conf.xml b/man/logind.conf.xml
index 0d0c9b0e..33ddf621 100644
--- a/man/logind.conf.xml
+++ b/man/logind.conf.xml
@@ -48,7 +48,7 @@
         </refnamediv>
 
         <refsynopsisdiv>
-                <para><filename>logind.conf</filename></para>
+                <para><filename>/etc/systemd/logind.conf</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml
new file mode 100644
index 00000000..202ea004
--- /dev/null
+++ b/man/systemd-journald.service.xml
@@ -0,0 +1,110 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+  This file is part of systemd.
+
+  Copyright 2010 Lennart Poettering
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 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
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="systemd-journald.service">
+
+        <refentryinfo>
+                <title>systemd-journald</title>
+                <productname>systemd</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Lennart</firstname>
+                                <surname>Poettering</surname>
+                                <email>lennart@poettering.net</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>systemd-journald</refentrytitle>
+                <manvolnum>8</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-journald.service</refname>
+                <refname>systemd-journald</refname>
+                <refpurpose>systemd Journal Service</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd-journald.service</filename></para>
+                <para><filename>/usr/lib/systemd/systemd-journald</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><filename>systemd-journald</filename> is a
+                system service that collects and stores logging
+                data. It creates and maintains structured, indexed
+                journals based on logging information that is received
+                from the kernel, from user processes via the libc
+                <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                call, from STDOUT/STDERR of system services or via its
+                native API. It will implicitly collect numerous meta
+                data fields for each log messages in a secure and
+                unfakeable way. See
+                <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                for more information about the collected meta data.
+                </para>
+
+                <para>Log data collected by the journal is primarily
+                text based but can also include binary data where
+                necessary. All objects stored in the journal can be up
+                to 2^64-1 bytes in size.</para>
+
+                <para>By default the journal stores log data in
+                <filename>/run/log/journal/</filename>. Since
+                <filename>/run/</filename> is volatile log data is
+                lost at reboot. To make the data persistant it
+                is sufficient to create
+                <filename>/var/log/journal/</filename> where
+                <filename>systemd-journald</filename> will then store
+                the data.</para>
+
+                <para><filename>systemd-journald</filename> will
+                forward all received log messages to the AF_UNIX
+                SOCK_DGRAM socket
+                <filename>/run/systemd/journal/syslog</filename> (if it exists) which
+                may be used by UNIX syslog daemons to process the data
+                further.</para>
+
+                <para>See
+                <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                for information about the configuration of this
+                service.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
diff --git a/units/systemd-journald.service.in b/units/systemd-journald.service.in
index da07cb9c..d169b44a 100644
--- a/units/systemd-journald.service.in
+++ b/units/systemd-journald.service.in
@@ -7,7 +7,7 @@
 
 [Unit]
 Description=Journal Service
-Documentation=man:journald.conf(5)
+Documentation=man:systemd-journald.service(7) man:journald.conf(5)
 DefaultDependencies=no
 Requires=systemd-journald.socket
 After=systemd-journald.socket