diff --git a/Makefile.am b/Makefile.am index b650daba06..91e66fdaee 100644 --- a/Makefile.am +++ b/Makefile.am @@ -319,7 +319,9 @@ dist_man_MANS = \ man/halt.8 \ man/shutdown.8 \ man/systemd-install.1 \ - man/pam_systemd.8 + man/pam_systemd.8 \ + man/systemadm.1 \ + man/systemctl.1 nodist_man_MANS = \ man/systemd.special.7 @@ -339,7 +341,9 @@ dist_noinst_DATA = \ man/halt.html \ man/shutdown.html \ man/systemd-install.html \ - man/pam_systemd.html + man/pam_systemd.html \ + man/systemadm.html \ + man/systemctl.html nodist_noinst_DATA = \ man/systemd.special.html @@ -362,7 +366,9 @@ EXTRA_DIST += \ man/halt.xml \ man/shutdown.xml \ man/systemd-install.xml \ - man/pam_systemd.xml + man/pam_systemd.xml \ + man/systemadm.xml \ + man/systemctl.xml systemd_SOURCES = \ src/main.c diff --git a/man/halt.xml b/man/halt.xml index f07e04a7c4..97a53ba350 100644 --- a/man/halt.xml +++ b/man/halt.xml @@ -173,7 +173,8 @@ systemd1, systemctl1, - shutdown8 + shutdown8, + wall1 diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index e790dd3c3d..796035f7a1 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -207,6 +207,10 @@ tools like screen1. + If the options are omitted they default to + , + , + . diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 4164a991d9..54874fd186 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -159,6 +159,26 @@ become a NOP. + + Environment + + + + $LISTEN_PID + $LISTEN_FDS + + Set by the init system + for supervised processes that use + socket-based activation. This + environment variable specifies the + data + sd_listen_fds() + parses. See above for + details. + + + + See Also diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 9d55ca4f8c..6a689555dd 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -227,6 +227,24 @@ become a NOP. + + Environment + + + + $NOTIFY_SOCKET + + Set by the init system + for supervised processes for status + and start-up completion + notification. This environment variable + specifies the socket + sd_notify() talks + to. See above for details. + + + + Examples diff --git a/man/shutdown.xml b/man/shutdown.xml index bff68213e6..ab14e3d704 100644 --- a/man/shutdown.xml +++ b/man/shutdown.xml @@ -148,7 +148,8 @@ systemd1, systemctl1, - halt8 + halt8, + wall1 diff --git a/man/systemadm.xml b/man/systemadm.xml new file mode 100644 index 0000000000..1c92a17a30 --- /dev/null +++ b/man/systemadm.xml @@ -0,0 +1,111 @@ + + + + + + + + + systemadm + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemadm + 1 + + + + systemadm + Graphical frontend for the systemd system + and session manager + + + + + systemadm OPTIONS + + + + + Description + + systemadm is a graphical + frontend for the systemd system and session manager + and allows introspection and control of + systemd. + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + + Connect to the systemd + system + manager. (Default) + + + + + + Connect to the systemd + session manager of the calling + user. + + + + + In addition to this a number of of parameters + common to all Gtk+ programs are supported. + + + + See Also + + systemd1, + systemctl1 + + + + diff --git a/man/systemctl.xml b/man/systemctl.xml new file mode 100644 index 0000000000..696a5060ad --- /dev/null +++ b/man/systemctl.xml @@ -0,0 +1,458 @@ + + + + + + + + + systemctl + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemctl + 1 + + + + systemctl + Control the systemd system and session manager + + + + + systemctl OPTIONS COMMAND NAME + + + + + Description + + systemctl may be used to + introspect and control the state of the + systemd1 + system and session manager. + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + When listing units, + limit display to certain unit + types. If not specified units of all + types will be shown. The argument + should be a unit type name such as + , + and + similar. + + + + + + When listing units, + show all units, regardless of their + state, including inactive + units. + + + + + + If the requested + operation conflicts with an exisiting + unfinished operation, replace the + existing operation by the requested + operation. If this is not specified + the requested operation will + fail. + + + + + + Talk to the systemd + system manager. (Default) + + + + + + Talk to the systemd + session manager of the calling user. + + + + + + Synchronously wait for + the requested operation to + finish. + + + + + + Don't send wall + message before + halt, power-off, reboot. + + + + The following commands are understood: + + + + list-units + + List known units. + + + list-jobs + + List jobs that are in progress. + + + clear-jobs + + Cancel all jobs that are in progress. + + + load [NAME...] + + Load one or more units + specified on the command line. This + will simply load their configuration + from disk, but not start them. To + start them you need to use the + start command which + will implicitly load a unit that has + not been loaded yet. Note that systemd + garbage collects loaded units that are + not active or referenced by an active + unit. This means that units loaded + this way will usually not stay loaded + for long. Also note that this command + cannot be used to reload unit + configuration. Use the + daemon-reload + command for that. All in all this + command is of little use except for + debugging. + This command should not be + confused with the + daemon-reload or + reload + commands. + + + + cancel [JOB...] + + Cancel one or more + jobs specified on the command line by + their numeric job + IDs. + + + start [NAME...] + + Start one or more + units specified on the command + line. + + + stop [NAME...] + + Stop one or more units + specified on the command + line. + + + restart [NAME...] + + Restart one or more + units specified on the command + line. + + + reload [NAME...] + + Asks all services + whose units are listed on the command + line to reload their + configuration. Note that this will + reload the daemon configuration + itself, not the unit configuration + file of systemd. If you want systemd + to reload the configuration file of a + unit use the + daemon-reload + command. In other words: for the + example case of Apache, this will + reload Apache's + httpd.conf in the + web server, not the + apache.service + systemd unit file. This + command should not be confused with + the daemon-reload + or load + commands. + + + + isolate [NAME] + + Start the unit + specified on the command line and its + dependencies and stop all + others. + + + monitor + + Monitor unit/job + changes. This is mostly useful for + debugging purposes and prints a line + each time systemd loads or unloads a + unit configuration file, or a unit + property changes. + + + dump + + Dump server + status. This will output a (usually + very long) human readable manager + status dump. Its format is subject to + change without notice and should not + be parsed by + applications. + + + snapshot [NAME] + + Create a snapshot. If + a snapshot name is specified the new + snapshot will be named after it. If + none is specified an automatic + snapshot name is generated. In either + case the snapshot name used is printed + to STDOUT. + + A snapshot refers to a saved + state of the systemd manager. It is + implemented itself as unit that is + generated dynamically with this + command and has dependencies on all + units active at the time. At a later + time the user may return to this state + by using the + isolate command on + the snapshot unit. + + Snapshots are only useful for + saving and restoring which units are + running or are stopped, they do not + save/restore any other + state. Snapshots are dynamic and lost + on reboot. + + + daemon-reload + + Reload systemd manager + configuration. This will reload all + unit files and recreate the entire + dependency tree. While the daemon is + reloaded all sockets systemd listens + on on behalf of user configuration will + stay accessible. This + command should not be confused with + the load or + reload + commands. + + + daemon-reexec + + Reexecute the systemd + manager. This will serialize the + manager state, reexecute the process + and deserialize the state again. This + command is of little use except for + debugging and package + upgrades. Sometimes it might be + helpful as a heavy-weight + daemon-reload. While + the daemon is reexecuted all sockets + systemd listens on on behalf of user + configuration will stay + accessible. + + + daemon-exit + + Ask the systemd + manager to quit. This is only + supported for session managers + (i.e. in conjunction with the + option) and + will fail otherwise. + + + show-environment + + Dump the systemd + manager environment block. The + environment block will be dumped in + straight-forward form suitable for + sourcing into a shell script. This + environment block will be passed to + all processes the manager + spawns. + + + set-environment [NAME=VALUE...] + + Set one or more + systemd manager environment variables, + as specified on the command + line. + + + unset-environment [NAME...] + + Unset one or more + systemd manager environment + variables. If only a variable name is + specified it will be removed + regardless of its value. If a variable + and a value are specified the variable + is only removed if it has the + specified value. + + + + halt + + Shut down and halt the + system. This is mostly equivalent to + start halt.target + but also prints a wall message to all + users. + + + poweroff + + Shut down and + power-off the system. This is mostly + equivalent to start + poweroff.target but also + prints a wall message to all + users. + + + reboot + + Shut down and + reboot the system. This is mostly + equivalent to start + reboot.target but also + prints a wall message to all + users. + + + default + + Enter default + mode. This is mostly equivalent to + start + default.target. + + + rescue + + Enter rescue + mode. This is mostly equivalent to + isolate + rescue.target but also + prints a wall message to all + users. + + + emergency + + Enter emergency + mode. This is mostly equivalent to + isolate + emergency.service but also + prints a wall message to all + users. + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + See Also + + systemd1, + systemadm1, + systemd.unit5, + systemd.special7, + wall1 + + + + diff --git a/man/systemd.xml b/man/systemd.xml index f754348ce1..36bce96185 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -122,9 +122,9 @@ Dump understood unit configuration items. This outputs a - terse list of configuration items - understood in unit definition - files. + terse but complete list of + configuration items understood in unit + definition files. @@ -192,32 +192,362 @@ it defaults to . - - Directories - - - - Signal - SIGTERM + System unit directories - systemd serializes its - state, reexecutes itself and - deserializes the saved state - again. This is mostly equivalent to - systemctl - daemon-reexec. + The systemd system + manager reads unit configuration from + various directories. Packages that + want to install unit files shall place + them in the directory returned by + pkg-config systemd + --variable=systemdsystemunitdir. Other + directories checked are + /usr/local/share/systemd/system + and + /usr/share/systemd/system. User + configuration always takes + precedence. pkg-config + systemd + --variable=systemdsystemconfdir + returns the path of the system + configuration directory. Packages + should alter this directory only with + the + systemd-install1 + tool. + + + + + + Session unit directories + + Similar rules apply + for the session unit + directories. However, here the XDG + Base Directory specification + is followed to find + units. Applications should place their + unit files in the directory returned + by pkg-config systemd + --variable=systemdsessionunitdir. Global + configuration is done in the + directory reported by + pkg-config systemd + --variable=systemdsessionconfdir. The + systemd-install1 + tool can handle both global (i.e. for + all users) and private (for one user) + enabling/disabling of + units. + + + + + + SysV init scripts directory + + The location of the + SysV init script directory varies + between distributions. If systemd + cannot find a native unit file for a + requested service it will look for a + SysV init script of the same name + (with the + .service suffix + removed). + + + + + + SysV runlevel link farm directory + + The location of the + SysV runlevel link farm directory + varies between distributions. systemd + will take the link farm into account + when figuring out whether a service + shall be enabled. Note that a service + unit with a native unit configuration + file can be started by activating it + in the SysV runlevel link + farm. + + Signals + + + + SIGTERM + + Upon receiving this + signal the systemd system manager + serializes its state, reexecutes + itself and deserializes the saved + state again. This is mostly equivalent + to systemctl + daemon-reexec. + + systemd session managers will + start the + exit.target unit + when this signal is received. This is + mostly equivalent to + systemctl --session start + exit.target. + + + + SIGINT + + Upon receiving this + signal the systemd system manager will + start the + ctrl-alt-del.target unit. This + is mostly equivalent to + systemctl start + ctl-alt-del.target. + + systemd session managers + treat this signal the same way as + SIGTERM. + + + + SIGWINCH + + When this signal is + received the systemd system manager + will start the + kbrequest.target + unit. This is mostly equivalent to + systemctl start + kbrequest.target. + + This signal is ignored by + systemd session + managers. + + + + SIGPWR + + When this signal is + received the systemd manager + will start the + sigpwr.target + unit. This is mostly equivalent to + systemctl start + sigpwr.target. + + + + SIGUSR1 + + When this signal is + received the systemd manager will try + to reconnect to the D-Bus + bus. + + + + SIGUSR2 + + When this signal is + received the systemd manager will log + its complete state in human readable + form. The data logged is the same as + printed by systemctl + dump. + + + + SIGHUP + + Reloads the complete + daemon configuration. This is mostly + equivalent to systemctl + daemon-reload. + + + + SIGRTMIN+0 + + Enters default mode, starts the + default.target + unit. This is mostly equivalent to + systemctl start + default.target. + + + + SIGRTMIN+1 + + Enters rescue mode, + starts the + rescue.target + unit. This is mostly equivalent to + systemctl isolate + rescue.target. + + + + SIGRTMIN+2 + + Enters emergency mode, + starts the + emergency.service + unit. This is mostly equivalent to + systemctl isolate + emergency.service. + + + + SIGRTMIN+3 + + Halts the machine, + starts the + halt.target + unit. This is mostly equivalent to + systemctl start + halt.target. + + + + SIGRTMIN+4 + + Powers off the machine, + starts the + poweroff.target + unit. This is mostly equivalent to + systemctl start + poweroff.target. + + + + SIGRTMIN+5 + + Reboots the machine, + starts the + reboot.target + unit. This is mostly equivalent to + systemctl start + reboot.target. + + + + + + Environment + + + + $SYSTEMD_LOG_LEVEL + systemd reads the + log level from this environment + variable. This can be overriden with + . + + + + $SYSTEMD_LOG_TARGET + systemd reads the + log target from this environment + variable. This can be overriden with + . + + + + $SYSTEMD_LOG_COLOR + Controls whether + systemd highlights important log + messages. This can be overriden with + . + + + + $SYSTEMD_LOG_LOCATION + Controls whether + systemd prints the code location along + with log messages. This can be + overriden with + . + + + + $XDG_CONFIG_HOME + $XDG_CONFIG_DIRS + $XDG_DATA_HOME + $XDG_DATA_DIRS + + The systemd session + manager uses these variables in + accordance to the XDG + Base Directory specification + to find its configuration. + + + + $SYSTEMD_UNIT_PATH + + Controls where systemd + looks for unit + files. + + + + $SYSTEMD_SYSVINIT_PATH + + Controls where systemd + looks for SysV init scripts. + + + + $SYSTEMD_SYSVRCND_PATH + + Controls where systemd + looks for SysV init script runlevel link + farms. + + + + $LISTEN_PID + $LISTEN_FDS + + Set by systemd for + supervised processes during + socket-based activation. See + sd_listen_fds3 + for more information. + + + + + $NOTIFY_SOCKET + + Set by systemd for + supervised processes for status and + start-up completion notification. See + sd_notify3 + for more information. + + + + Sockets and FIFOs @@ -278,11 +608,18 @@ - See Also + systemctl1, + systemadm1, + systemd-install1, + systemd-notify1, daemon7, + sd-daemon7, + systemd.unit5, + systemd.special5, + pkg-config1 diff --git a/man/telinit.xml b/man/telinit.xml index 925187941f..bbf43bf5d6 100644 --- a/man/telinit.xml +++ b/man/telinit.xml @@ -187,7 +187,8 @@ See Also systemd1, - systemctl1 + systemctl1, + wall1