mirror of
https://github.com/systemd/systemd-stable.git
synced 2025-01-11 05:17:44 +03:00
man: document path units
This commit is contained in:
Lennart Poettering
parent
11fcc3ab1b
commit
b36b082c8a
@ -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 \
|
||||
|
||||
@ -88,6 +88,11 @@
|
||||
<para>If an mount point is beneath another mount point
|
||||
in the file system hierarchy a dependency between both
|
||||
units is created automatically.</para>
|
||||
|
||||
<para>Mount points created at runtime independent on
|
||||
unit files or <filename>/etc/fstab</filename> will be
|
||||
monitored by systemd and appear like any other mount
|
||||
unit in systemd.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
|
||||
174
man/systemd.path.xml
Normal file
174
man/systemd.path.xml
Normal file
@ -0,0 +1,174 @@
|
||||
<?xml version='1.0'?> <!--*-nxml-*-->
|
||||
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
|
||||
<!--
|
||||
This file is part of systemd.
|
||||
|
||||
Copyright 2010 Lennart Poettering
|
||||
|
||||
systemd is free software; you can redistribute it and/or modify it
|
||||
under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
systemd is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||
-->
|
||||
|
||||
<refentry id="systemd.path">
|
||||
<refentryinfo>
|
||||
<title>systemd.path</title>
|
||||
<productname>systemd</productname>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<contrib>Developer</contrib>
|
||||
<firstname>Lennart</firstname>
|
||||
<surname>Poettering</surname>
|
||||
<email>lennart@poettering.net</email>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>systemd.path</refentrytitle>
|
||||
<manvolnum>5</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>systemd.path</refname>
|
||||
<refpurpose>systemd path configuration files</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<para><filename>systemd.path</filename></para>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<para>A unit configuration file whose name ends in
|
||||
<filename>.path</filename> encodes information about
|
||||
a path monitored by systemd, for
|
||||
path-based activation.</para>
|
||||
|
||||
<para>This man page lists the configuration options
|
||||
specific to this unit type. See
|
||||
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
||||
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.</para>
|
||||
|
||||
<para>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 <filename>foo.path</filename> activates a
|
||||
matching service <filename>foo.service</filename>. The
|
||||
unit to activate may be controlled by
|
||||
<varname>Unit=</varname> (see below).</para>
|
||||
|
||||
<para>Internally, path units use the
|
||||
<citerefentry><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
||||
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.</para>
|
||||
|
||||
<para>If an path unit is beneath another mount
|
||||
point in the file system hierarchy a dependency
|
||||
between both units is created automatically.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
|
||||
<para>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:</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><varname>PathExists=</varname></term>
|
||||
<term><varname>PathChanged=</varname></term>
|
||||
<term><varname>DirectoryNotEmpty=</varname></term>
|
||||
|
||||
<listitem><para>Defines paths to
|
||||
monitor for certain changes:
|
||||
<varname>PathExists=</varname> may be
|
||||
used to watch the mere existance of a
|
||||
file or directory. If the file
|
||||
specified exists the configured unit
|
||||
is
|
||||
activated. <varname>PathChanged=</varname>
|
||||
may be used to watch a file or
|
||||
directory and activate the configured
|
||||
unit whenever it changes or is
|
||||
modified. <varname>DirectoryNotEmpty=</varname>
|
||||
may be used to watch a directory and
|
||||
activate the configured unit whenver
|
||||
it contains at least one file.</para>
|
||||
|
||||
<para>The arguments of these
|
||||
directives must be absolute file
|
||||
system paths.</para>
|
||||
|
||||
<para>Multiple directives may be
|
||||
combined, of the same and of different
|
||||
types, to watch multiple paths.</para>
|
||||
|
||||
<para>If a path is already existing
|
||||
(in case of
|
||||
<varname>PathExists=</varname>) or a
|
||||
directory already is not empty (in
|
||||
case of
|
||||
<varname>DirectoryNotEmpty=</varname>)
|
||||
at the time the path unit is activated
|
||||
then the configured unit is
|
||||
immediately activated as
|
||||
well. Something similar does not apply
|
||||
to <varname>PathChanged=</varname>.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><varname>Unit=</varname></term>
|
||||
|
||||
<listitem><para>The unit to activate
|
||||
when any of the configured paths
|
||||
changes. The argument is a unit name,
|
||||
whose suffix is not
|
||||
<filename>.path</filename>. 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.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
@ -153,7 +153,7 @@
|
||||
<term><varname>Unit=</varname></term>
|
||||
|
||||
<listitem><para>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
|
||||
<filename>.timer</filename>. If not
|
||||
specified this value defaults to a
|
||||
|
||||
Loading…
Reference in New Issue
Block a user