From 359957ee23e8dad97f6c75969d7ecfe4d3c4369f Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 23 Jun 2010 01:49:57 +0200 Subject: [PATCH] man: document runlevel and systemd-install --- .gitignore | 1 + Makefile.am | 18 ++++- man/runlevel.xml | 149 ++++++++++++++++++++++++++++++++++++ man/systemd-install.xml | 165 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 330 insertions(+), 3 deletions(-) create mode 100644 man/runlevel.xml create mode 100644 man/systemd-install.xml diff --git a/.gitignore b/.gitignore index 7e44eaa1..1632e3f1 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,7 @@ systemd-logger systemctl systemadm .dirstamp +*.1 *.3 *.5 *.7 diff --git a/Makefile.am b/Makefile.am index 0f9ef8ea..68b1bd14 100644 --- a/Makefile.am +++ b/Makefile.am @@ -313,7 +313,9 @@ dist_man_MANS = \ man/sd_booted.3 \ man/sd_listen_fds.3 \ man/sd_is_fifo.3 \ - man/sd-daemon.7 + man/sd-daemon.7 \ + man/runlevel.8 \ + man/systemd-install.1 nodist_man_MANS = \ man/systemd.special.7 @@ -327,7 +329,9 @@ dist_noinst_DATA = \ man/sd_booted.html \ man/sd_listen_fds.html \ man/sd_is_fifo.html \ - man/sd-daemon.html + man/sd-daemon.html \ + man/runlevel.html \ + man/systemd-install.html nodist_noinst_DATA = \ man/systemd.special.html @@ -344,7 +348,9 @@ EXTRA_DIST += \ man/sd_booted.xml \ man/sd_listen_fds.xml \ man/sd_is_fifo.xml \ - man/sd-daemon.xml + man/sd-daemon.xml \ + man/runlevel.xml \ + man/systemd-install.xml systemd_SOURCES = \ src/main.c @@ -594,6 +600,12 @@ man/%.3: man/%.xml man/%.3.in: man/%.xml.in $(XSLTPROC_PROCESS_MAN) +man/%.1: man/%.xml + $(XSLTPROC_PROCESS_MAN) + +man/%.1.in: man/%.xml.in + $(XSLTPROC_PROCESS_MAN) + man/%.5: man/%.xml $(XSLTPROC_PROCESS_MAN) diff --git a/man/runlevel.xml b/man/runlevel.xml new file mode 100644 index 00000000..1404ff6d --- /dev/null +++ b/man/runlevel.xml @@ -0,0 +1,149 @@ + + + + + + + + + runlevel + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + runlevel + 8 + + + + runlevel + Print previous and current SysV runlevel + + + + + runlevel options + + + + + Description + + runlevel prints the previous + and current SysV runlevel if they are known. + + The two runlevel characters are seperated by a + single space character. If a runlevel cannot be + determined N is printed instead. If neither can be + determined the word "unknown" is printed. + + Unless overriden in the environment this will + check the utmp database for recent runlevel + changes. + + The following option is understood: + + + + --help + + Prints a short help + text and exits. + + + + + + + Exit status + + If one or both runlevels could be determined, 0 + is returned, a non-zero failure code otherwise. + + + + + Environment + + + + $RUNLEVEL + + If + $RUNLEVEL is set, + runlevel will print + this value as current runlevel and + ignore utmp. + + + + $PREVLEVEL + + If + $PREVLEVEL is set + runlevel will print + this value as previous runlevel and + ignore utmp. + + + + + + Files + + + + /var/run/utmp + + The utmp database + runlevel reads the + previous and current runlevel + from. + + + + + + + Notes + + This is a legacy call available for compatbility + only. It should not be used anymore, as the concept of + runlevels is obselete. + + + + See Also + + systemctl1, + + + + diff --git a/man/systemd-install.xml b/man/systemd-install.xml new file mode 100644 index 00000000..9881e981 --- /dev/null +++ b/man/systemd-install.xml @@ -0,0 +1,165 @@ + + + + + + + + + systemd-install + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-install + 1 + + + + systemd-install + Enable or disable a systemd unit + definition file + + + + + systemd-install options name + + + systemd-install options name + + + systemd-install options name + + + + + Description + + systemd-install enables or + disables systemd units, or checks whether they are + enabled. + + The following options are understood: + + + + --help + + Prints a short help + text and exits. + + + + --force + + Enable/disable a + service even if it conflicts + with/contradicts another service. This + might have the effect of disabling + another service that was + enabled. + + + + --system + + Enable/disable a + system service. + + + + --session + + Enable/disable a + session service for the calling + user. + + + + --global + + Enable/disable a + session service for all + users. + + + + The following verbs are understood: + + + + enable + + Enable a unit. This + will create a number of symlinks as + encoded in the [Install] section of a + unit file. + + + + disable + + Disable a unit. This + will removed a number of symlinks as + encoded in the [Install] section of a + unit file. + + + + test + + Checks whether any of + the units specified are + installed. This will check for the + existance of a number of symlinks as + encoded in the [Install] section of a + unit file. + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + See Also + + systemctl1, + systemd.unit5 + + + + -- 2.39.5