From 2218198b73ea3f73cee1238e0f6dfd313f182f48 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 23 Jun 2010 20:34:25 +0200 Subject: [PATCH] man: start documenting systemd itself --- man/runlevel.xml | 6 +- man/systemd-install.xml | 28 +++--- man/systemd.xml | 204 +++++++++++++++++++++++++++++++++++++++- src/main.c | 2 +- 4 files changed, 225 insertions(+), 15 deletions(-) diff --git a/man/runlevel.xml b/man/runlevel.xml index 7daffbf3..71b6e385 100644 --- a/man/runlevel.xml +++ b/man/runlevel.xml @@ -67,12 +67,16 @@ Unless overriden in the environment this will check the utmp database for recent runlevel changes. + + + + Options The following option is understood: - --help + Prints a short help text and exits. diff --git a/man/systemd-install.xml b/man/systemd-install.xml index 9881e981..7cd23da5 100644 --- a/man/systemd-install.xml +++ b/man/systemd-install.xml @@ -21,7 +21,7 @@ along with systemd; If not, see . --> - + systemd-install @@ -50,13 +50,13 @@ - systemd-install options name + systemd-install options enable name - systemd-install options name + systemd-install options disable name - systemd-install options name + systemd-install options test name @@ -66,19 +66,23 @@ systemd-install enables or disables systemd units, or checks whether they are enabled. + + + + Options The following options are understood: - --help + Prints a short help text and exits. - --force + Enable/disable a service even if it conflicts @@ -89,14 +93,14 @@ - --system + Enable/disable a system service. - --session + Enable/disable a session service for the calling @@ -104,7 +108,7 @@ - --global + Enable/disable a session service for all @@ -116,7 +120,7 @@ - enable + enable Enable a unit. This will create a number of symlinks as @@ -125,7 +129,7 @@ - disable + disable Disable a unit. This will removed a number of symlinks as @@ -134,7 +138,7 @@ - test + test Checks whether any of the units specified are diff --git a/man/systemd.xml b/man/systemd.xml index f49faca6..8766f04a 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -47,10 +47,212 @@ systemd System and Session Manager + + + systemd options + + + init options + + + Description - Systemd is awesome. + systemd is a system and session manager for + Linux operating systems. When run as first process on + boot (as PID 1) it may act as init system that brings + up and maintains userspace. + + For compatibility with SysV if systemd is called + as init and a PID that is not + 1 it will execute telinit and pass + all command line arguments unmodified. That means + init and telinit + are mostly equivalent when invoked from normal login sessions. See + telinit8 + for more information. + + + + Options + + The following options are understood: + + + + | + + Prints a short help + text and exits. + + + + + Set default unit to + activate on startup. If not specified + defaults to + default.target. + + + + + Tell systemd to run in + a particular mode. Argument is one of + , + . Normally it + should not be necessary to pass this + option, as systemd automatically + detects the mode it is started + in. This call is hence of little use + except for + debugging. + + + + + Determine startup + sequence, dump it and exit. This is an + option useful for debugging + only. + + + + + Dump understood unit + configuration items. This outputs a + terse list of configuration items + understood in unit definition + files. + + + + + Ask for confirmation when spawning processes. + + + + + Extract D-Bus + interface introspection data. This is + mostly useful at build ot install time + to generate data suitable for the + D-Bus interfaces + repository. Optionally the interface + name for the introspection data may be + specified. If omitted the + introspection data for all interfaces + is dumped. + + + + + Set log level. As + argument this accepts a numerical log + level or the well-known syslog3 + symbolic names (lowercase): + , + , + , + , + , + , + , + . + + + + + Set log + target. Argument must be one of + , + , + , + , + . + + + + + Highlight important + log messages. Argument is a boolean + value. If the argument is omitted it + defaults to + . + + + + + Include code location + in log messages. This is mostly + relevant for debugging + purposes. Argument is a boolean + value. If the argument is omitted + it defaults to + . + + + + + + + + Sockets and FIFOs + + + + @/org/freedesktop/systemd1/notify + + Daemon status + notification socket. This is an AF_UNIX + datagram socket in the Linux abstract + namespace, and is used to implement + the daemon notification logic as + implemented by + sd_notify3. + + + + + @/org/freedesktop/systemd1/logger + + Used internally by the + systemd-logger.service + unit to connect STDOUT and/or STDERR + of spawned processes to + syslog3 + or the kernel log buffer. This is an + AF_UNIX stream socket in the Linux + abstract namespace. + + + + @/org/freedesktop/systemd1/private + + Used internally as + communication channel between + systemctl1 + and the systemd process. This is an + AF_UNIX stream socket in the Linux + abstract namespace. This interface is + private to systemd and should not be + used in external + projects. + + + + /dev/initctl + + Limited compatibility + support for the SysV client interface, + as implemented by the + systemd-initctl.service + unit. This is a named pipe in the file + system. This interface is obsolete and + should not be used in new + applications. + + diff --git a/src/main.c b/src/main.c index db2a7678..a002e11c 100644 --- a/src/main.c +++ b/src/main.c @@ -547,7 +547,7 @@ static int help(void) { " --introspect[=INTERFACE] Extract D-Bus interface data\n" " --log-level=LEVEL Set log level\n" " --log-target=TARGET Set log target (console, syslog, kmsg, syslog-or-kmsg, null)\n" - " --log-color[=0|1] Highlight import log messages\n" + " --log-color[=0|1] Highlight important log messages\n" " --log-location[=0|1] Include code location in log messages\n", program_invocation_short_name); -- 2.39.5