From d1ab0ca07372649dad70a0348d75e394f254e1b6 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sat, 15 May 2010 23:06:41 +0200 Subject: man: add some initial man page work --- man/systemd.service.xml | 213 ++++++++++++++++++++++++++++++++++++++++++++++++ man/systemd.unit.xml | 121 +++++++++++++++++++++++++++ 2 files changed, 334 insertions(+) create mode 100644 man/systemd.service.xml create mode 100644 man/systemd.unit.xml (limited to 'man') diff --git a/man/systemd.service.xml b/man/systemd.service.xml new file mode 100644 index 0000000000..5285ce3d52 --- /dev/null +++ b/man/systemd.service.xml @@ -0,0 +1,213 @@ + + + + + + + + + systemd.service + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd.service + 5 + + + + systemd.service + systemd service configuration files + + + + systemd.service + + + + Description + + A configuration file ending in .service encodes + information about a process controlled and supervised + by systemd. + + This man page lists the configuration options + specific to this unit type. See + systemd.unit5 + for the common options of all unit configuration + files. + + + + Options + + + + Type= + + One of + forking, + simple, + finish, + dbus. + + If set to + forking + (the default) it is expected + that the process configured + with + ExecStart= + will start up and call + fork(). The + parent process is expected to + finish when start-up is + complete and all communication + channels set up. The child + continues to run as the main + daemon process. This is the + behaviour of traditional UNIX + daemons. If this setting is + used it is recommended to also + use the + PIDFile= + option, so that systemd can + identify the main process of + the daemon. systemd will start + follow-up units as soon as the + parent process exited. + + If set to + simple (the + recommended value) it is + expected that the process + configured with + ExecStart= + is the main process of the + daemon. In this mode + communication channels must be + available before the daemon is + started up, as systemd will + immediately start follow-up + units. + + Behaviour of + finish is + similar to + simple, + however it is expected that + the process has to exit before + systemd starts follow-up + units. ValidNoProcess= + is particularly useful for + this type of service. + + Behaviour of + dbus is + similar to + simple, + however it is expected that + the daemon acquires a name on + the D-Bus bus, as configured + by + BusName=. Follow-up + units will be started after + the name has been + acquired. + + + + ValidNoProcess= + + Takes a boolean value + that specifies whether the service + shall be considered active + even when all its processes + exited. Defaults to no. + + + + + PIDFile= + + Takes an absolute file + name pointing to the PID file + of this daemon. Use of this + option is recommended for + services where + Type= is + set to + forking. + + + + + BusName= + + Takes a D-Bus bus name + that this service is reachable + as. This option is mandatory + for services where + Type= is + set to + dbus, but + its use is otherwise + recommended as well if the + process takes a name on the + D-Bus bus. + + + + + ExecStart= + + Takes a command line + that is executed when this + service shall be started + up. The first word of the + command line must be an + absolute file name. It is + mandatory to set this option + for all services. + + + + + + + + See Also + + systemd8, + systemctl8 + systemd.unit5 + + + + diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml new file mode 100644 index 0000000000..cfa1b09499 --- /dev/null +++ b/man/systemd.unit.xml @@ -0,0 +1,121 @@ + + + + + + + + + systemd.unit + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd.unit + 5 + + + + systemd.unit + systemd unit configuration files + + + + systemd.service + systemd.socket + systemd.device + systemd.mount + systemd.automount + systemd.swap + systemd.target + + + + Description + + A unit configuration file encodes information + about a service, a socket, a mount point, an automount + point, a swap file or patition, or a start-up target + controlled and supervised by systemd. The syntax is + inspired by XDG .desktop files, + which are in turn inspired by Windows + .ini files. + + This man pages lists the common configuration + options of the various unit types. + + + + Options + + + + Names= + + Additional names for this unit. The names + listed here mus have the same suffix (i.e. type) + as the identifier name. This option may be + specified more than once. + + + + Requires= + + Dependencies on other + units. If this units get + activated the units listed + here will be activated as + well. If one of the other + units gets deactivated or its + activation fails, this unit + will be deactivated. This + option may be specified more + than once. + + + + + + + See Also + + systemd8, + systemctl8 + systemd.service5 + systemd.socket5 + systemd.device5 + systemd.mount5 + systemd.automount5 + systemd.swap5 + systemd.target5 + + + + -- cgit v1.2.3-54-g00ecf