From 65232ea79d8f6b1288c33852f89b575a9200162d Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 2 Jul 2010 01:17:55 +0200 Subject: [PATCH] man: document automount units --- Makefile.am | 1 + man/systemd.automount.xml | 162 ++++++++++++++++++++++++++++++++++++++ man/systemd.mount.xml | 12 ++- man/systemd.service.xml | 5 +- man/systemd.socket.xml | 31 +++++--- 5 files changed, 194 insertions(+), 17 deletions(-) create mode 100644 man/systemd.automount.xml diff --git a/Makefile.am b/Makefile.am index 457276ed1..7df50cecc 100644 --- a/Makefile.am +++ b/Makefile.am @@ -319,6 +319,7 @@ MANPAGES = \ man/systemd.service.5 \ man/systemd.socket.5 \ man/systemd.mount.5 \ + man/systemd.automount.5 \ man/daemon.7 \ man/sd-daemon.7 \ man/runlevel.8 \ diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml new file mode 100644 index 000000000..a09839a68 --- /dev/null +++ b/man/systemd.automount.xml @@ -0,0 +1,162 @@ + + + + + + + + + systemd.automount + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd.automount + 5 + + + + systemd.automount + systemd automount configuration files + + + + systemd.automount + + + + Description + + A unit configuration file whose name ends in + .automount encodes information + about a file system automount point 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. The common configuration items are configured + in the generic [Unit] and [Install] sections. The + automount specific configuration options are configured + in the [Automount] section. + + Automount units must be named after the file + paths they reflect. Example: the automount point + /home/lennart must be configured + in a unit file + home-lennart.automount. For + details about the escaping logic used to convert a + file system path to a unit name see + systemd.unit5. + + For each automount unit file a matching mount + unit file (see + systemd.mount5 + for details) must exist which is activated when the + automount path is accessed. Example: if an automount + unit home-lennart.automount is + active and the user accesses + /home/lennart the mount unit + home-lennart.mount will be + activated. + + Automount units may be used to implement + on-demand mounting as well as parallelized mounting of + file systems. + + + + + <filename>fstab</filename> + + Automount units may either be configured via unit + files, or via /etc/fstab (see + fstab5 + for details). + + For details how systemd parses + /etc/fstab see + systemd.mount5. + + If an automount point is configured in both + /etc/fstab and a unit file the + configuration in the latter takes precedence. + + + + Options + + Automount files must include an [Automount] + section, which carries information about the file + system automount points it supervises. The options + specific to the [Automount] section of automount units + are the following: + + + + + Where= + Takes an absolute path + of a directory of the automount + point. If the automount point is not + existing at time of the automount + point is installed it is created. This + string must be reflected in the unit + file name. (See above.) This option is + mandatory. + + + + DirectoryMode= + Directories of automount + points (and any parent directories) + are automatically created if + needed. This option specifies the file + system access mode used when creating + these directories. Defaults to + 0755. + + + + + + See Also + + systemd8, + systemctl8, + systemd.unit5, + systemd.mount5, + mount8, + automount8 + + + + diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 275e354d6..94ed66453 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -55,8 +55,9 @@ Description A unit configuration file whose name ends in - .mount encodes information about a file system mount - point controlled and supervised by systemd. + .mount encodes information about + a file system mount point controlled and supervised by + systemd. This man page lists the configuration options specific to this unit type. See @@ -78,6 +79,11 @@ about the escaping logic used to convert a file system path to a unit name see systemd.unit5. + + Optionally, a mount unit may be accompanied by + an automount unit, to allow on-demand or parallelized + mounting. See + systemd.automount5. @@ -117,7 +123,7 @@ this section are shared with other unit types. These options are documented in systemd.exec5. The - options specific to the [Mount] section of service + options specific to the [Mount] section of mount units are the following: diff --git a/man/systemd.service.xml b/man/systemd.service.xml index c6fdc0d50..8005a51a4 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -55,8 +55,9 @@ Description A unit configuration file whose name ends in - .service encodes information about a process - controlled and supervised by systemd. + .service encodes information + about a process controlled and supervised by + systemd. This man page lists the configuration options specific to this unit type. See diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 65ef8c0b1..e15ea602f 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -54,10 +54,11 @@ Description - A unit configuration file whose name ends in .socket - encodes information about an IPC or network socket or - a file system FIFO controlled and supervised by systemd, - for socket-based activation. + A unit configuration file whose name ends in + .socket encodes information about + an IPC or network socket or a file system FIFO + controlled and supervised by systemd, for socket-based + activation. This man page lists the configuration options specific to this unit type. See @@ -71,13 +72,15 @@ Additional options are listed in systemd.exec5. - For each socket file a matching service file (see systemd.service5 for details) - must exist, describing the service to start on - incoming traffic on the socket. Depending on the - setting of (see below) this - must either be named like the socket unit, but with - the suffix replaced; or it must be a template file - named the same way. Example: a socket file + For each socket file a matching service file + (see + systemd.service5 + for details) must exist, describing the service to + start on incoming traffic on the socket. Depending on + the setting of (see below) + this must either be named like the socket unit, but + with the suffix replaced; or it must be a template + file named the same way. Example: a socket file foo.socket needs a matching service foo.service if is set. If @@ -85,6 +88,10 @@ file foo@.service must exist from which services are instantiated for each incoming connection. + + Socket units may be used to implement on-demand + starting of services as well as parallelized starting + of services. @@ -96,7 +103,7 @@ this section are shared with other unit types. These options are documented in systemd.exec5. The - options specific to the [Socket] section of service + options specific to the [Socket] section of socket units are the following: -- 2.30.2