From 771610b04d5dc320a40f2270c50b176bd1f8facc Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 24 Jun 2010 17:22:52 +0200 Subject: [PATCH 1/1] man: additional documentation --- man/systemd-install.xml | 6 ++ man/systemd.unit.xml | 129 ++++++++++++++++++++++++++++++---------- 2 files changed, 103 insertions(+), 32 deletions(-) diff --git a/man/systemd-install.xml b/man/systemd-install.xml index bb5223085..8afa7d9ee 100644 --- a/man/systemd-install.xml +++ b/man/systemd-install.xml @@ -66,6 +66,12 @@ systemd-install enables or disables systemd units, or checks whether they are enabled. + + This command is useful to apply or undo the + installation instructions encoded in the [Install] + section of unit files. See + systemd.unit5 + for more information. diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 7c2320e66..af89d316d 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -55,67 +55,132 @@ systemd.automount systemd.swap systemd.target + systemd.path + systemd.timer 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. + about a service, a socket, a device, a mount point, an + automount point, a swap file or patition, a start-up + target, a file system path or a timer controlled and + supervised by systemd1. The syntax is inspired by XDG + .desktop files, which are in turn + inspired by Microsoft Windows .ini + files. This man pages lists the common configuration - options of the various unit types. + options of the all unit types. These options need to + be configured either in the [Unit] resp. [Install] + section of the unit files. Options + Unit file may include a [Unit] section, which + carries generic information about the unit that is not + dependent on the type of unit: + 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. + + Additional names for + this unit. The names listed here must + have the same suffix (i.e. type) as + the unit file name. This option may be + specified more than once, in which + case all listed names are used. Note + that this option is different from the + Alias= option from + the [Install] section mentioned + below. See below for details 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. + + Requirement + 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, in which + case requirement dependencies for all + listed names are created. + + Unit file may include a [Install] section, which + carries installation information for the unit. This + section is not interpreted by + systemd1 + during runtime. It is used exclusively by the + systemd-install1 + during installation of a unit: + + + + Alias= + + Additional names this + unit shall be installed under. The + names listed here must have the same + suffix (i.e. type) as the unit file + name. This option may be specified + more than once, in which case all + listed names are used. At installation + time + systemd-install + will create symlinks from these names + to the unit file name. Note that this + is different from the + Names= option from + the [Unit] section mentioned above: + The names from + Names= apply + unconditionally if the unit is + loaded. The names from + Alias= apply only + if the unit is actually installed with + the systemd-install + tool. Also, if systemd searches for a + unit, it will discover symlinked alias + names, but not names configured only + with Names=. It is + a common pattern to list a name in both + options. In this case, a unit will be + active under all names if installed, + but also if not installed but + requested + explicitly. + + + See Also systemd1, - systemctl8 - systemd.special7 - systemd.service5 - systemd.socket5 - systemd.device5 - systemd.mount5 - systemd.automount5 - systemd.swap5 - systemd.target5 + systemctl8, + systemd-install1, + systemd.special7, + systemd.service5, + systemd.socket5, + systemd.device5, + systemd.mount5, + systemd.automount5, + systemd.swap5, + systemd.target5, + systemd.path5, + systemd.timer5 -- 2.30.2