From 160cd5c9aa2301892e13950015de7968c764340d Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 24 Jun 2010 00:11:04 +0200 Subject: man: add more man pages --- Makefile.am | 20 +++- man/daemon.xml | 11 +- man/halt.xml | 180 +++++++++++++++++++++++++++++ man/pam_systemd.xml | 296 ++++++++++++++++++++++++++++++++++++++++++++++++ man/runlevel.xml | 3 +- man/sd-daemon.xml | 2 +- man/sd_booted.xml | 4 +- man/sd_is_fifo.xml | 4 +- man/sd_listen_fds.xml | 4 +- man/sd_notify.xml | 2 +- man/shutdown.xml | 155 +++++++++++++++++++++++++ man/systemd-install.xml | 9 +- man/systemd.unit.xml | 26 ++--- man/systemd.xml | 31 ++++- man/telinit.xml | 194 +++++++++++++++++++++++++++++++ 15 files changed, 902 insertions(+), 39 deletions(-) create mode 100644 man/halt.xml create mode 100644 man/pam_systemd.xml create mode 100644 man/shutdown.xml create mode 100644 man/telinit.xml diff --git a/Makefile.am b/Makefile.am index e41ba48e24..b650daba06 100644 --- a/Makefile.am +++ b/Makefile.am @@ -308,14 +308,18 @@ dist_man_MANS = \ man/systemd.unit.5 \ man/systemd.service.5 \ man/daemon.7 \ - man/systemd.8 \ + man/systemd.1 \ man/sd_notify.3 \ man/sd_booted.3 \ man/sd_listen_fds.3 \ man/sd_is_fifo.3 \ man/sd-daemon.7 \ man/runlevel.8 \ - man/systemd-install.1 + man/telinit.8 \ + man/halt.8 \ + man/shutdown.8 \ + man/systemd-install.1 \ + man/pam_systemd.8 nodist_man_MANS = \ man/systemd.special.7 @@ -331,7 +335,11 @@ dist_noinst_DATA = \ man/sd_is_fifo.html \ man/sd-daemon.html \ man/runlevel.html \ - man/systemd-install.html + man/telinit.html \ + man/halt.html \ + man/shutdown.html \ + man/systemd-install.html \ + man/pam_systemd.html nodist_noinst_DATA = \ man/systemd.special.html @@ -350,7 +358,11 @@ EXTRA_DIST += \ man/sd_is_fifo.xml \ man/sd-daemon.xml \ man/runlevel.xml \ - man/systemd-install.xml + man/telinit.xml \ + man/halt.xml \ + man/shutdown.xml \ + man/systemd-install.xml \ + man/pam_systemd.xml systemd_SOURCES = \ src/main.c diff --git a/man/daemon.xml b/man/daemon.xml index 3d1e921a16..650e0fa8b1 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -306,11 +306,12 @@ - See Also - - daemon3, - sd_listen_fds3 - + See Also + + systemd1, + daemon3, + sd_listen_fds3 + diff --git a/man/halt.xml b/man/halt.xml new file mode 100644 index 0000000000..f07e04a7c4 --- /dev/null +++ b/man/halt.xml @@ -0,0 +1,180 @@ + + + + + + + + + halt + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + halt + 8 + + + + halt + poweroff + reboot + Halt, power-off or reboot the machine + + + + + halt OPTIONS + + + poweroff OPTIONS + + + reboot OPTIONS + + + + + Description + + halt, + poweroff, reboot + may be used to halt, power-off or reboot the + machine. + + + + + Options + + The following options are understood: + + + + + + Prints a short help + text and exits. + + + + + + Halt the machine, + regardless which one of the three + commands is invoked. + + + + + + + Power-off the machine, + regardless which one of the three + commands is invoked. + + + + + + Reboot the machine, + regardless which one of the three + commands is invoked. + + + + + + + Force immediate halt, + power-off, reboot. Don't contact the + init system. + + + + + + + Only write wtmp + shutdown entry, don't actually halt, + power-off, reboot. + + + + + + + Don't write wtmp + shutdown entry. + + + + + + + Don't sync hard disks/storage media before + halt, power-off, + reboot. + + + + + + Don't send wall + message before + halt, power-off, reboot. + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + Notes + + These are legacy commands available for + compatibility only. + + + + See Also + + systemd1, + systemctl1, + shutdown8 + + + + diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml new file mode 100644 index 0000000000..e790dd3c3d --- /dev/null +++ b/man/pam_systemd.xml @@ -0,0 +1,296 @@ + + + + + + + + + pam_systemd + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + pam_systemd + 8 + + + + pam_systemd + Register user sessions in the systemd control group hierarchy + + + + + pam_systemd.so + + + + + Description + + pam_systemd registers user + sessions in the systemd control group + hierarchy. + + On login, this module ensures the following: + + + If it does not exist yet the + user runtime directory + /var/run/user/$USER is + created and its ownership changed to the user + that is logging in. + + If + is set the + $XDG_SESSION_ID environment + variable is initialized. If auditing is + available and + pam_loginuid.so run before + this module (which es recommended), the + variable is initialized from the auditing + session id + (/proc/self/sessionid). Otherwise + an independent session counter is + used. + + If + is set a new + control group + /user/$USER/$XDG_SESSION_ID + is created and the login process moved into + it. + + If + is set a new + control group + /user/$USER/no-session + is created and the login process moved into + it. + + + + On logout, this module ensures the following: + + + If + $XDG_SESSION_ID is set and + specified, all + remaining processes in the + /user/$USER/$XDG_SESSION_ID + control group are killed and the control group + removed. + + If + $XDG_SESSION_ID is set and + specified, all + remaining processes in the + /user/$USER/$XDG_SESSION_ID + control group are migrated to + /user/$USER/no-session and + the original control group + removed. + + If + is specified, and + no other user session control group remains + except + /user/$USER/no-session + all remaining processes in the + /user/$USER hierarchy + are killed and the control group removed. + + If + is specified, and + no process remains in the + /user/$USER hierarchy the + control group is removed. + + If the + /user/$USER control group + was removed the + $XDG_RUNTIME_DIR directory + and all its contents are + removed, too. + + + If the system was not booted up with systemd as + init system this module does nothing and immediately + returns PAM_SUCCESS. + + + + + Options + + The following options are understood: + + + + + + Takes a boolean + argument. If true, a new session is + created: the + $XDG_SESSION_ID + environment variable is set and the + login process moved to the + /user/$USER/$XDG_SESSION_ID + control group. It is recommended that + all services that are directly created + on the user's behalf set this + option. Only for services that shall + automatically be terminated when the + user logs out completely otherwise, + create-session=0 + should be set. + + + + + + Takes a boolean + argument. If true, all processes + created by the user during his session + and from his session will be + terminated when he logs out from his + session. + + + + + + Takes a boolean + argument. If true, all processes + created by the user during his session + and from his session will be + terminated after he logged out + completely. This is a weaker version + of and is + more friendly for users logged in more + than once as their processes are + terminated only on their complete + logout. + + + + Note that setting kill-user=1 + or even kill-session=1 will break + tools like + screen1. + + + + + Module Types Provided + + Only is provided. + + + + Environment + + + + $XDG_SESSION_ID + + A session identifier, + suitable to be used in file names. The + string itself should be considered + opaque, although often it is just the + audit session ID as reported by + /proc/self/sessionid. Each + ID will be assigned only once during + machine uptime. It may hence be used + to uniquely label files or other + resources of this + session. + + + + $XDG_RUNTIME_DIR + + Path to a user-private + user-writable directory that is bound + to the user login time on the + machine. It is automatically created + the first time a user logs in and + removed on his final logout. If a user + logs in twice at the same time, both + sessions will see the same + $XDG_RUNTIME_DIR + and the same contents. If a user logs + in once, then logs out again, and logs + in again, the directory contents will + have been lost in between, but + applications should not rely on this + behaviour and must be able to deal with + stale files. To store session-private + data in this directory the user should + include the value of $XDG_SESSION_ID + in the filename. This directory shall + be used for runtime file system + objects such as AF_UNIX sockets, + FIFOs, PID files and similar. It is + guaranteed that this directory is + local and offers the greatest possible + file system feature set the + operating system + provides. + + + + + + Example + + #%PAM-1.0 +auth required pam_unix.so +auth required pam_nologin.so +account required pam_unix.so +password required pam_unix.so +session required pam_unix.so +session required pam_loginuid.so +session required pam_systemd.so create-session=1 kill-user=1 + + + + See Also + + pam.conf5, + pam.d5, + pam8, + pam_loginuid8, + systemd1 + + + + diff --git a/man/runlevel.xml b/man/runlevel.xml index 71b6e3852d..04959b18a9 100644 --- a/man/runlevel.xml +++ b/man/runlevel.xml @@ -21,7 +21,7 @@ along with systemd; If not, see . --> - + runlevel @@ -146,6 +146,7 @@ See Also + systemd1, systemctl1 diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index 2acc021041..da1e5b31bb 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -147,12 +147,12 @@ See Also + systemd1, sd_listen_fds3, sd_notify3, sd_booted3, sd_is_fifo3, daemon7, - systemd8, systemd.service5, systemd.socket5, fprintf3 diff --git a/man/sd_booted.xml b/man/sd_booted.xml index 6129a777c2..8d5606d79f 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -114,8 +114,8 @@ See Also - sd_daemon7, - systemd8 + systemd1, + sd_daemon7 diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 2389546130..f1f6d376ee 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -188,9 +188,9 @@ See Also - sd_daemon7, + systemd1, + sd-daemon7, sd_listen_fds3, - systemd8, systemd.service5, systemd.socket5 diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 10ea57c972..4164a991d9 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -163,13 +163,13 @@ See Also - sd_daemon7, + systemd1, + sd-daemon7, sd_is_fifo3, sd_is_socket3, sd_is_socket_inet3, sd_is_socket_unix3, daemon7, - systemd8, systemd.service5, systemd.socket5 diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 140e795979..9d55ca4f8c 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -267,9 +267,9 @@ See Also + systemd1, sd_daemon7, daemon7, - systemd8, systemd.service5 diff --git a/man/shutdown.xml b/man/shutdown.xml new file mode 100644 index 0000000000..bff68213e6 --- /dev/null +++ b/man/shutdown.xml @@ -0,0 +1,155 @@ + + + + + + + + + shutdown + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + shutdown + 8 + + + + shutdown + Halt, power-off or reboot the machine + + + + + shutdown OPTIONS now WALL + + + + + Description + + shutdown may be used to halt, + power-off or reboot the machine. + + The first argument should be the string + now which however is ignored by + this implementation. Optionally, this may be followed + by a wall message to be sent to all logged-in users + before going down. + + + + Options + + The following options are understood: + + + + + + Prints a short help + text and exits. + + + + + + + Halt the machine. + + + + + + + Power-off the + machine (the default). + + + + + + + Reboot the + machine. + + + + + + Equivalent to + , unless + is + specified. + + + + + + Don't halt, power-off, + reboot, just write wall + message. + + + + + + Don't send wall + message before + halt, power-off, reboot. + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + Notes + + This is a legacy command available for + compatibility only. + + + + See Also + + systemd1, + systemctl1, + halt8 + + + + diff --git a/man/systemd-install.xml b/man/systemd-install.xml index 7cd23da574..bb52230856 100644 --- a/man/systemd-install.xml +++ b/man/systemd-install.xml @@ -50,13 +50,13 @@ - systemd-install options enable name + systemd-install OPTIONS enable NAME - systemd-install options disable name + systemd-install OPTIONS disable NAME - systemd-install options test name + systemd-install OPTIONS test NAME @@ -116,7 +116,7 @@ - The following verbs are understood: + The following commands are understood: @@ -161,6 +161,7 @@ See Also + systemd1, systemctl1, systemd.unit5 diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 73dde5aa4f..7c2320e665 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -104,19 +104,19 @@ - See Also - - systemd8, - systemctl8 - systemd.special7 - systemd.service5 - systemd.socket5 - systemd.device5 - systemd.mount5 - systemd.automount5 - systemd.swap5 - systemd.target5 - + See Also + + systemd1, + systemctl8 + systemd.special7 + systemd.service5 + systemd.socket5 + systemd.device5 + systemd.mount5 + systemd.automount5 + systemd.swap5 + systemd.target5 + diff --git a/man/systemd.xml b/man/systemd.xml index 8766f04a95..f754348ce1 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -39,7 +39,7 @@ systemd - 8 + 1 @@ -49,10 +49,10 @@ - systemd options + systemd OPTIONS - init options + init OPTIONS COMMAND @@ -81,7 +81,8 @@ - | + + Prints a short help text and exits. @@ -196,6 +197,28 @@ + + Directories + + + + Signal + + + + SIGTERM + + systemd serializes its + state, reexecutes itself and + deserializes the saved state + again. This is mostly equivalent to + systemctl + daemon-reexec. + + + + + Sockets and FIFOs diff --git a/man/telinit.xml b/man/telinit.xml new file mode 100644 index 0000000000..925187941f --- /dev/null +++ b/man/telinit.xml @@ -0,0 +1,194 @@ + + + + + + + + + telinit + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + telinit + 8 + + + + telinit + Change SysV runlevel + + + + + telinit OPTIONS COMMAND + + + + + Description + + telinit may be used to change + the SysV system runlevel. Since the concept of SysV + runlevels is obsolete the runlevel requests + will be transparently translated into systemd unit + activation requests. + + + + + Options + + The following options are understood: + + + + + + Prints a short help + text and exits. + + + + + + Don't send wall + message before + reboot/halt/power-off. + + + + The following commands are understood: + + + + 0 + + Power-off the + machine. This is translated into an + activation request for + poweroff.target + and is equivalent to + systemctl + poweroff. + + + + 6 + + Reboot the + machine. This is translated into an + activation request for + reboot.target and + is equivalent to systemctl + reboot. + + + + 2 + 3 + 4 + 5 + + Change the SysV + runlevel. This is translated into an + activation request for + runlevel2.target, + runlevel3.target, + ... and is equivalent to + systemctl start + runlevel2.target, + systemctl start + runlevel3.target, + ... + + + + 1 + s + S + + Change into system + rescue mode. This is translated into + an activation request for + rescue.target and + is equivalent to systemctl + rescue. + + + + q + Q + + Reload daemon + configuration. This is equivalent to + systemctl + daemon-reload. + + + + u + U + + Serialize state, + reexecute daemon and deserialize state + again. This is equivalent to + systemctl + daemon-reexec. + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + Notes + + This is a legacy command available for compatibility + only. It should not be used anymore, as the concept of + runlevels is obsolete. + + + + See Also + + systemd1, + systemctl1 + + + + -- cgit v1.2.3-54-g00ecf