From ccc9a4f9ffdab069b0b785627c48962fdadf6d46 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Sat, 26 Jan 2013 10:47:16 -0500 Subject: man: extend systemd.directives(7) to all manual pages New sections are added: PAM options, crypttab options, commandline options, miscellaneous. The last category will be used for all untagged elements. Commandline options sections is meant to be a developer tool: when adding an option it is sometimes useful to be able to check if similarly named options exist elsewhere. --- Makefile.am | 25 ++------- make-directive-index.py | 92 +++++++++++++++++++++++++--------- man/crypttab.xml | 2 +- man/journalctl.xml | 2 +- man/kernel-command-line.xml | 2 +- man/localectl.xml | 2 +- man/loginctl.xml | 2 +- man/pam_systemd.xml | 4 +- man/runlevel.xml | 2 +- man/sd_listen_fds.xml | 2 +- man/sd_notify.xml | 2 +- man/systemctl.xml | 2 +- man/systemd-bootchart.xml | 2 +- man/systemd-cryptsetup-generator.xml | 2 +- man/systemd-fsck@.service.xml | 2 +- man/systemd-fstab-generator.xml | 2 +- man/systemd-journald.service.xml | 2 +- man/systemd-modules-load.service.xml | 2 +- man/systemd-quotacheck.service.xml | 2 +- man/systemd-udevd.service.xml | 4 +- man/systemd-vconsole-setup.service.xml | 2 +- man/systemd.automount.xml | 2 +- man/systemd.exec.xml | 2 +- man/systemd.kill.xml | 2 +- man/systemd.mount.xml | 4 +- man/systemd.path.xml | 2 +- man/systemd.service.xml | 4 +- man/systemd.socket.xml | 2 +- man/systemd.swap.xml | 2 +- man/systemd.timer.xml | 2 +- man/systemd.unit.xml | 4 +- man/systemd.xml | 4 +- man/timedatectl.xml | 2 +- man/udev.xml | 8 +-- 34 files changed, 112 insertions(+), 87 deletions(-) diff --git a/Makefile.am b/Makefile.am index f362b53728..9c92bffc01 100644 --- a/Makefile.am +++ b/Makefile.am @@ -767,31 +767,12 @@ MANPAGES += \ man/systemd.index.7 \ man/systemd.directives.7 -XML_DIRECTIVE_FILES = \ - man/systemd.xml \ - man/systemd.unit.xml \ - man/systemd.service.xml \ - man/systemd.socket.xml \ - man/systemd.mount.xml \ - man/systemd.automount.xml \ - man/systemd.swap.xml \ - man/systemd.target.xml \ - man/systemd.path.xml \ - man/systemd.timer.xml \ - man/systemd.snapshot.xml \ - man/systemd.exec.xml \ - man/systemd.kill.xml \ - man/systemd.device.xml \ - man/systemd.conf.xml \ - man/systemd.journal-fields.xml \ - man/systemd.time.xml \ - man/bootchart.conf.xml - -man/systemd.index.xml: make-man-index.py $(filter-out man/systemd.index.xml,$(XML_FILES)) +NON_INDEX_XML_FILES = $(filter-out man/systemd.index.xml,$(XML_FILES)) +man/systemd.index.xml: make-man-index.py $(NON_INDEX_XML_FILES) $(AM_V_at)$(MKDIR_P) $(dir $@) $(AM_V_GEN)$(PYTHON) $^ > $@ -man/systemd.directives.xml: make-directive-index.py $(XML_DIRECTIVE_FILES) +man/systemd.directives.xml: make-directive-index.py $(filter-out man/systemd.directives.xml,$(NON_INDEX_XML_FILES)) $(AM_V_at)$(MKDIR_P) $(dir $@) $(AM_V_GEN)$(PYTHON) $^ > $@ diff --git a/make-directive-index.py b/make-directive-index.py index 48d830e96f..29c594cb75 100755 --- a/make-directive-index.py +++ b/make-directive-index.py @@ -2,7 +2,7 @@ # # This file is part of systemd. # -# Copyright 2012 Zbigniew Jędrzejewski-Szmek +# Copyright 2012-2013 Zbigniew Jędrzejewski-Szmek # # 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 @@ -20,6 +20,7 @@ import sys import collections import xml.etree.ElementTree as tree +import re TEMPLATE = '''\ @@ -57,28 +58,20 @@ TEMPLATE = '''\ - - System manager directives - - Directives for configuring the behaviour of the - systemd process. - - - - Options on the kernel command line Kernel boot options for configuring the behaviour of the systemd process. - + Environment variables - Environment variables understood by the systemd process. + Environment variables understood by the systemd + manager and other programs. @@ -93,14 +86,39 @@ TEMPLATE = '''\ - Journal directives + Journal fields - Directives for configuring the behaviour of the - journald process. + Fields in the journal events with a well known meaning. + + PAM configuration directives + + Directives for configuring PAM behaviour. + + + + + + crypttab options + + Options which influence mounted filesystems and + encrypted volumes. + + + + + + System manager directives + + Directives for configuring the behaviour of the + systemd process. + + + + bootchart.conf directives @@ -110,6 +128,24 @@ TEMPLATE = '''\ + + command-line options + + Command-line options accepted by programs in the + systemd suite. + + + + + + Miscellaneous options and directives + + Other configuration elements which don't fit in + any of the above groups. + + + + Colophon @@ -127,11 +163,16 @@ def _extract_directives(directive_groups, page): section = t.find('./refmeta/manvolnum').text pagename = t.find('./refmeta/refentrytitle').text for variablelist in t.iterfind('.//variablelist'): - klass = variablelist.attrib.get('class') or 'unit-directives' - stor = directive_groups[klass] - for varname in variablelist.iterfind('./varlistentry/term/varname'): - text = ''.join(varname.text.partition('=')[:2]) - stor[text].append((pagename, section)) + klass = variablelist.attrib.get('class') + storvar = directive_groups[klass or 'miscellaneous'] + storopt = directive_groups['options'] + # - + cipher= diff --git a/man/journalctl.xml b/man/journalctl.xml index 959ae1efa2..d8f8f68929 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -518,7 +518,7 @@ Environment - + $SYSTEMD_PAGER Pager to use when diff --git a/man/kernel-command-line.xml b/man/kernel-command-line.xml index 154d399d5a..f249798171 100644 --- a/man/kernel-command-line.xml +++ b/man/kernel-command-line.xml @@ -74,7 +74,7 @@ Core OS Command Line Arguments - + systemd.unit= rd.systemd.unit= diff --git a/man/localectl.xml b/man/localectl.xml index 73bff98938..7563eb513c 100644 --- a/man/localectl.xml +++ b/man/localectl.xml @@ -229,7 +229,7 @@ Environment - + $SYSTEMD_PAGER Pager to use when diff --git a/man/loginctl.xml b/man/loginctl.xml index 9d082cf915..90b6f1e110 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -457,7 +457,7 @@ Environment - + $SYSTEMD_PAGER Pager to use when diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 600bfd71b4..0093a8fb2d 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -118,7 +118,7 @@ The following options are understood: - + @@ -247,7 +247,7 @@ The following environment variables are set for the processes of the user's session: - + $XDG_SESSION_ID diff --git a/man/runlevel.xml b/man/runlevel.xml index 0ad4953efd..6d9fe85726 100644 --- a/man/runlevel.xml +++ b/man/runlevel.xml @@ -96,7 +96,7 @@ Environment - + $RUNLEVEL diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index b891b6b039..9c8fdbccaf 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -168,7 +168,7 @@ Environment - + $LISTEN_PID $LISTEN_FDS diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 75edeeadf3..81f74aa843 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -254,7 +254,7 @@ Environment - + $NOTIFY_SOCKET diff --git a/man/systemctl.xml b/man/systemctl.xml index 60a0f401bd..38426454d4 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -1296,7 +1296,7 @@ Environment - + $SYSTEMD_PAGER Pager to use when diff --git a/man/systemd-bootchart.xml b/man/systemd-bootchart.xml index 8c4d7cc1dc..0df7c4bcf4 100644 --- a/man/systemd-bootchart.xml +++ b/man/systemd-bootchart.xml @@ -65,7 +65,7 @@ systemd-bootchart can be invoked in several different ways: - + Kernel invocation diff --git a/man/systemd-cryptsetup-generator.xml b/man/systemd-cryptsetup-generator.xml index 49d4d5545b..c5f8d2a9d8 100644 --- a/man/systemd-cryptsetup-generator.xml +++ b/man/systemd-cryptsetup-generator.xml @@ -72,7 +72,7 @@ systemd-cryptsetup-generator understands the following kernel command line parameters: - + luks= rd.luks= diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml index 62f63110e1..4d6464c2b8 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -77,7 +77,7 @@ systemd-fsck understands one kernel command line parameter: - + fsck.mode= diff --git a/man/systemd-fstab-generator.xml b/man/systemd-fstab-generator.xml index b265b6c082..4bd25bfa8f 100644 --- a/man/systemd-fstab-generator.xml +++ b/man/systemd-fstab-generator.xml @@ -81,7 +81,7 @@ systemd-fstab-generator understands the following kernel command line parameters: - + fstab= diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml index abc03df5db..4969ab19c3 100644 --- a/man/systemd-journald.service.xml +++ b/man/systemd-journald.service.xml @@ -137,7 +137,7 @@ journald.conf may be overridden on the kernel command line: - + systemd.journald.forward_to_syslog= systemd.journald.forward_to_kmsg= diff --git a/man/systemd-modules-load.service.xml b/man/systemd-modules-load.service.xml index e5f10a7beb..ea10be2234 100644 --- a/man/systemd-modules-load.service.xml +++ b/man/systemd-modules-load.service.xml @@ -71,7 +71,7 @@ systemd-modules-load.service understands the following kernel command line parameters: - + modules-load= diff --git a/man/systemd-quotacheck.service.xml b/man/systemd-quotacheck.service.xml index 4d0218b659..2ffee9158e 100644 --- a/man/systemd-quotacheck.service.xml +++ b/man/systemd-quotacheck.service.xml @@ -67,7 +67,7 @@ systemd-quotacheck understands one kernel command line parameter: - + quotacheck.mode= diff --git a/man/systemd-udevd.service.xml b/man/systemd-udevd.service.xml index 9fc59c1bf1..2b9a29adcd 100644 --- a/man/systemd-udevd.service.xml +++ b/man/systemd-udevd.service.xml @@ -116,7 +116,7 @@ Environment - + $UDEV_LOG= @@ -127,7 +127,7 @@ Kernel command line - + Parameters starting with "rd." will be read when systemd-udevd is used in an initrd. diff --git a/man/systemd-vconsole-setup.service.xml b/man/systemd-vconsole-setup.service.xml index c1ef80dae4..df1b1a16b6 100644 --- a/man/systemd-vconsole-setup.service.xml +++ b/man/systemd-vconsole-setup.service.xml @@ -76,7 +76,7 @@ vconsole.conf may be overridden on the kernel command line: - + vconsole.keymap= vconsole.keymap.toggle= diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index 7575835060..f428ddfe1a 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -123,7 +123,7 @@ specific to the [Automount] section of automount units are the following: - + Where= diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index fb74bcc972..53094e587d 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -82,7 +82,7 @@ Options - + WorkingDirectory= diff --git a/man/systemd.kill.xml b/man/systemd.kill.xml index 1bff7b81fa..5ff8feee63 100644 --- a/man/systemd.kill.xml +++ b/man/systemd.kill.xml @@ -82,7 +82,7 @@ Options - + KillMode= diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index f319cf7ce9..022be4661d 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -182,7 +182,7 @@ options specific to the [Mount] section of mount units are the following: - + What= @@ -276,7 +276,7 @@ for compatibility reasons and should not be used in newly written mount files. - + FsckPassNo= diff --git a/man/systemd.path.xml b/man/systemd.path.xml index a602caab13..ccf16df004 100644 --- a/man/systemd.path.xml +++ b/man/systemd.path.xml @@ -108,7 +108,7 @@ monitors. The options specific to the [Path] section of path units are the following: - + PathExists= PathExistsGlob= diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 891b3474aa..d2feb98247 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -121,7 +121,7 @@ options specific to the [Service] section of service units are the following: - + Type= @@ -887,7 +887,7 @@ for compatibility reasons and should not be used in newly written service files. - + SysVStartPriority= Set the SysV start diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 7ba8bdc85b..28730ca441 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -143,7 +143,7 @@ options specific to the [Socket] section of socket units are the following: - + ListenStream= ListenDatagram= diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index dae9d59e7c..e547e71722 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -136,7 +136,7 @@ options specific to the [Swap] section of swap units are the following: - + What= diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 8682643349..2c2ba58226 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -97,7 +97,7 @@ defines. The options specific to the [Timer] section of timer units are the following: - + OnActiveSec= OnBootSec= diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 953a2897ad..dcdfc1e5d6 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -222,7 +222,7 @@ carries generic information about the unit that is not dependent on the type of unit: - + Description= @@ -944,7 +944,7 @@ systemctl1 tool during installation of a unit: - + Alias= diff --git a/man/systemd.xml b/man/systemd.xml index 962ed56ffc..bae90a5f09 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -508,7 +508,7 @@ Directories - + System unit directories @@ -987,7 +987,7 @@ /proc/cmdline instead.: - + systemd.unit= rd.systemd.unit= diff --git a/man/timedatectl.xml b/man/timedatectl.xml index 01ca0a73d5..4f34bb7b73 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -221,7 +221,7 @@ Environment - + $SYSTEMD_PAGER Pager to use when diff --git a/man/udev.xml b/man/udev.xml index 773635ecf7..415cf8e6a9 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -148,7 +148,7 @@ not only the device that has generated the event. If multiple keys that match a parent device are specified in a single rule, all these keys must match at one and the same parent device. - + @@ -322,7 +322,7 @@ The following keys can get values assigned: - + @@ -489,7 +489,7 @@ Rule and device options: - + @@ -546,7 +546,7 @@ is executed, allowing for the use of device properties set by earlier matching rules. For all other fields, substitutions are performed while the individual rule is being processed. The available substitutions are: - + , -- cgit v1.2.3-54-g00ecf