From: Lennart Poettering Date: Fri, 2 Jul 2010 00:38:30 +0000 (+0200) Subject: man: document path units X-Git-Tag: v1~71 X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b36b082c8a24d2575909c3e0b4b8aeec49ec17bb;p=systemd man: document path units --- diff --git a/Makefile.am b/Makefile.am index 2e001a64..aa60784a 100644 --- a/Makefile.am +++ b/Makefile.am @@ -322,6 +322,7 @@ MANPAGES = \ man/systemd.automount.5 \ man/systemd.swap.5 \ man/systemd.timer.5 \ + man/systemd.path.5 \ man/daemon.7 \ man/sd-daemon.7 \ man/runlevel.8 \ diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index bb969bb4..7be7d493 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -88,6 +88,11 @@ If an mount point is beneath another mount point in the file system hierarchy a dependency between both units is created automatically. + + Mount points created at runtime independent on + unit files or /etc/fstab will be + monitored by systemd and appear like any other mount + unit in systemd. diff --git a/man/systemd.path.xml b/man/systemd.path.xml new file mode 100644 index 00000000..44f536cf --- /dev/null +++ b/man/systemd.path.xml @@ -0,0 +1,174 @@ + + + + + + + + + systemd.path + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd.path + 5 + + + + systemd.path + systemd path configuration files + + + + systemd.path + + + + Description + + A unit configuration file whose name ends in + .path encodes information about + a path monitored by systemd, for + path-based activation. + + This man page lists the configuration options + specific to this unit type. See + systemd.unit5 + for the common options of all unit configuration + files. The common configuration items are configured + in the generic [Unit] and [Install] sections. The + path specific configuration options are configured in + the [Path] section. + + For each path file a matching unit file must + exist, describing the unit to activate when the path + changes. By default a service by the same name as the + path (except for the suffix) is activated. Example: a + path file foo.path activates a + matching service foo.service. The + unit to activate may be controlled by + Unit= (see below). + + Internally, path units use the + inotify7 + API to monitor file systems. Due to that it suffers by the + same limitations as inotify, and for example cannot be + used to monitor files or directories changed by other + machines on remote NFS file systems. + + If an path unit is beneath another mount + point in the file system hierarchy a dependency + between both units is created automatically. + + + + Options + + Path files must include a [Path] section, + which carries information about the path(s) it + monitors. The options specific to the [Path] section + of path units are the following: + + + + PathExists= + PathChanged= + DirectoryNotEmpty= + + Defines paths to + monitor for certain changes: + PathExists= may be + used to watch the mere existance of a + file or directory. If the file + specified exists the configured unit + is + activated. PathChanged= + may be used to watch a file or + directory and activate the configured + unit whenever it changes or is + modified. DirectoryNotEmpty= + may be used to watch a directory and + activate the configured unit whenver + it contains at least one file. + + The arguments of these + directives must be absolute file + system paths. + + Multiple directives may be + combined, of the same and of different + types, to watch multiple paths. + + If a path is already existing + (in case of + PathExists=) or a + directory already is not empty (in + case of + DirectoryNotEmpty=) + at the time the path unit is activated + then the configured unit is + immediately activated as + well. Something similar does not apply + to PathChanged=. + + + + Unit= + + The unit to activate + when any of the configured paths + changes. The argument is a unit name, + whose suffix is not + .path. If not + specified this value defaults to a + service that has the same name as the + path unit, except for the suffix. (See + above.) It is recommended that the + unit name that is activated and the + unit name of the path unit is chosen + identical except for the + suffix. + + + + + + See Also + + systemd8, + systemctl8, + systemd.unit5, + systemd.service5, + inotify7 + + + + diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index b61cabc3..5845383e 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -153,7 +153,7 @@ Unit= The unit to activate - when this timer elapses. Argument is a + when this timer elapses. The argument is a unit name, whose suffix is not .timer. If not specified this value defaults to a