From cdb788e4cdc67bf7da6b3b1b3f4f295ef5c25c67 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 2 Jul 2010 00:29:15 +0200 Subject: [PATCH 1/1] man: document mount units --- Makefile.am | 1 + man/systemd.mount.xml | 230 +++++++++++++++++++++++++++++++++++++++++ man/systemd.socket.xml | 14 +-- 3 files changed, 234 insertions(+), 11 deletions(-) create mode 100644 man/systemd.mount.xml diff --git a/Makefile.am b/Makefile.am index 1beeb3419..457276ed1 100644 --- a/Makefile.am +++ b/Makefile.am @@ -318,6 +318,7 @@ MANPAGES = \ man/systemd.unit.5 \ man/systemd.service.5 \ man/systemd.socket.5 \ + man/systemd.mount.5 \ man/daemon.7 \ man/sd-daemon.7 \ man/runlevel.8 \ diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml new file mode 100644 index 000000000..275e354d6 --- /dev/null +++ b/man/systemd.mount.xml @@ -0,0 +1,230 @@ + + + + + + + + + systemd.mount + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd.mount + 5 + + + + systemd.mount + systemd mount configuration files + + + + systemd.mount + + + + Description + + A unit configuration file whose name ends in + .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 + 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 + mount specific configuration options are configured + in the [Mount] section. + + Additional options are listed in + systemd.exec5. + + Mount units must be named after the file paths + they reflect. Example: the mount point + /home/lennart must be configured + in a unit file + home-lennart.mount. For details + about the escaping logic used to convert a file system + path to a unit name see + systemd.unit5. + + + + <filename>fstab</filename> + + Mount units may either be configured via unit + files, or via /etc/fstab (see + fstab5 + for details). + + When reading /etc/fstab a + few special mount options are understood by systemd + which influence how dependencies are created for mount + points from /etc/fstab. If + is specified as + mount option then systemd will create a dependency of + type from either + local-fs.target or + remote-fs.target, depending + whether the file system is local or remote. If + is set, an + automount unit will be created for the file system. See + systemd.automount5 + for details. + + If a mount point is configured in both + /etc/fstab and a unit file the + configuration in the latter takes precedence. + + + + Options + + Mount files must include a [Mount] section, + which carries information about the file system mount points it + supervises. A number of options that may be used in + this section are shared with other unit types. These + options are documented in + systemd.exec5. The + options specific to the [Mount] section of service + units are the following: + + + + + What= + Takes an absolute path + of a device node, file or other + resource to mount. See + mount8 + for details. If this refers to a + device node a dependency on the + respective device unit is + automatically created. (See + systemd.device5 for more information.) + This option is + mandatory. + + + + Where= + Takes an absolute path + of a directory of the mount point. If + the mount point is not existing at + time of mounting it is created. This + string must be reflected in the unit + file name. (See above.) This option is + mandatory. + + + + Type= + Takes a string for the + filesystem type. See + mount8 + for details. This setting is + optional. + + + + Options= + + Mount options to use + when mounting. This takes a comma + seperated list of options. This + setting is optional. + + + + DirectoryMode= + Directories of mount + 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. + + + + TimeoutSec= + Configures the time to + wait for the mount command to + finish. If a comand does not exit + within the configured time the mount + will be considered failed and be shut + down again. All commands still running + will be terminated forcibly via + SIGTERM, and after another delay of + this time with SIGKILL. (See + below.) + Takes a unit-less value in seconds, or + a time span value such as "5min + 20s". Pass 0 to disable the timeout + logic. Defaults to + 60s. + + + + KillMode= + Specifies how + processes of this mount shall be + killed. One of + , + , + , + . + + This option is mostly equivalent + to the + option of service files. See + systemd.service5 + for details. + + + + + + See Also + + systemd8, + systemctl8, + systemd.unit5, + systemd.exec5, + systemd.device5, + mount8 + + + + diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index f187fe3bd..65ef8c0b1 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -65,7 +65,7 @@ for the common options of all unit configuration files. The common configuration items are configured in the generic [Unit] and [Install] sections. The - service specific configuration options are configured + socket specific configuration options are configured in the [Socket] section. Additional options are listed in @@ -406,10 +406,6 @@ address. Defaults to . - ExecStartPre= ExecStartPost= @@ -438,7 +434,6 @@ optional. - TimeoutSec= Configures the time to @@ -454,7 +449,7 @@ will be terminated forcibly via SIGTERM, and after another delay of this time with SIGKILL. (See - below.) + below.) Takes a unit-less value in seconds, or a time span value such as "5min 20s". Pass 0 to disable the timeout @@ -462,11 +457,10 @@ 60s. - KillMode= Specifies how - processes of this service shall be + processes of this socket unit shall be killed. One of , , @@ -479,8 +473,6 @@ systemd.service5 for details. - - -- 2.30.2