From 01cf0ca850dd1c21e1c405a4493fe61d0c28d721 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 1 Jun 2012 01:05:38 +0200 Subject: [PATCH] man: document systemd-journal --- Makefile.am | 5 +- man/journalctl.xml | 8 ++- man/journald.conf.xml | 7 +- man/logind.conf.xml | 2 +- man/systemd-journald.service.xml | 110 ++++++++++++++++++++++++++++++ units/systemd-journald.service.in | 2 +- 6 files changed, 126 insertions(+), 8 deletions(-) create mode 100644 man/systemd-journald.service.xml diff --git a/Makefile.am b/Makefile.am index 2e29a0f41..597711ea7 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 5e0c6dd5c..de02e4e21 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -56,10 +56,11 @@ Description - journalctl may be - used to query the contents of the + journalctl may be used to + query the contents of the systemd1 - journal. + journal as written by + systemd-journald.service8. If called without parameter will show the full contents of the journal, starting with the oldest @@ -254,6 +255,7 @@ See Also systemd1, + systemd-journald.service8, systemctl1, systemd.journal-fields7, journald.conf5 diff --git a/man/journald.conf.xml b/man/journald.conf.xml index cce945b7d..5ad0f02b3 100644 --- a/man/journald.conf.xml +++ b/man/journald.conf.xml @@ -48,13 +48,15 @@ - journald.conf + /etc/systemd/journald.conf Description - This files configures various parameters of the systemd journal service. + This files configures various parameters of the + systemd journal service + systemd-journald.service8. @@ -246,6 +248,7 @@ See Also systemd1, + systemd-journald.service8, journalctl1, systemd.journal-fields7, systemd.conf5 diff --git a/man/logind.conf.xml b/man/logind.conf.xml index 0d0c9b0ec..33ddf621e 100644 --- a/man/logind.conf.xml +++ b/man/logind.conf.xml @@ -48,7 +48,7 @@ - logind.conf + /etc/systemd/logind.conf diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml new file mode 100644 index 000000000..202ea0040 --- /dev/null +++ b/man/systemd-journald.service.xml @@ -0,0 +1,110 @@ + + + + + + + + + systemd-journald + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-journald + 8 + + + + systemd-journald.service + systemd-journald + systemd Journal Service + + + + systemd-journald.service + /usr/lib/systemd/systemd-journald + + + + Description + + systemd-journald 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 + syslog3 + 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 + systemd.journal-fields7 + for more information about the collected meta data. + + + 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. + + By default the journal stores log data in + /run/log/journal/. Since + /run/ is volatile log data is + lost at reboot. To make the data persistant it + is sufficient to create + /var/log/journal/ where + systemd-journald will then store + the data. + + systemd-journald will + forward all received log messages to the AF_UNIX + SOCK_DGRAM socket + /run/systemd/journal/syslog (if it exists) which + may be used by UNIX syslog daemons to process the data + further. + + See + journald.conf5 + for information about the configuration of this + service. + + + + See Also + + systemd1, + journalctl1, + journald.conf5, + systemd.journal-fields7 + + + + diff --git a/units/systemd-journald.service.in b/units/systemd-journald.service.in index da07cb9ce..d169b44a8 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 -- 2.30.2