From 63b03c0b2889dd490b3511f12f00268c154a655c Mon Sep 17 00:00:00 2001 From: =?utf8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 30 Jun 2014 09:27:16 -0400 Subject: [PATCH 1/1] man: mention that x-systemd.device-timeout is only for fstab Reformat fstab options description. Now they are easier to read and show up in systemd.directives(7). Use a single sublist for both /etc/fstab and /etc/crypttab options. Many of them can be used in both places. crypttab(5) is updated to use the same docbook elements, so formatting is uniform. --- man/crypttab.xml | 80 ++++++++++++++--------------- man/systemd.mount.xml | 94 +++++++++++++++++++++++------------ tools/make-directive-index.py | 5 +- 3 files changed, 106 insertions(+), 73 deletions(-) diff --git a/man/crypttab.xml b/man/crypttab.xml index 9030015b0..9dbf1546b 100644 --- a/man/crypttab.xml +++ b/man/crypttab.xml @@ -109,10 +109,10 @@ comma-delimited list of options. The following options are recognized: - + - discard + Allow discard requests to be passed through the encrypted block device. This @@ -121,7 +121,7 @@ - cipher= + Specifies the cipher to use. See cryptsetup8 @@ -132,7 +132,7 @@ - hash= + Specifies the hash to use for password hashing. See @@ -142,7 +142,7 @@ - keyfile-offset= + Specifies the number of bytes to skip at the start of the key file. See @@ -152,7 +152,7 @@ - keyfile-size= + Specifies the maximum number of bytes to read from the key file. See @@ -164,39 +164,39 @@ - key-slot= + Specifies the key slot to compare the passphrase or key against. If the key slot does not match the given passphrase or key, but another would, the setup of the device will fail regardless. - This option implies luks. See + This option implies . See cryptsetup8 for possible values. The default is to try all key slots in sequential order. - luks + Force LUKS mode. When this mode is used, the following options are ignored since they are provided by the LUKS header on the - device: cipher=, - hash=, - size=. + device: , + , + . - noauto + This device will not be automatically unlocked on boot. - nofail + The system will not wait for the device to show up and be unlocked at boot, and @@ -204,20 +204,20 @@ - plain + Force plain encryption mode. - read-onlyreadonly + Set up the encrypted block device in read-only mode. - size= + Specifies the key size in bits. See @@ -227,33 +227,33 @@ - swap + The encrypted block device will be used as a swap device, and will be formatted accordingly after setting up the encrypted block device, with mkswap8. - This option implies plain. + This option implies . - WARNING: Using the swap + WARNING: Using the option will destroy the contents of the named partition during every boot, so make sure the underlying block device is specified correctly. - tcrypt + Use TrueCrypt encryption mode. When this mode is used, the following options are ignored since they are provided by the TrueCrypt header on the device or do not apply: - cipher=, - hash=, - keyfile-offset=, - keyfile-size=, - size=. + , + , + , + , + . When this mode is used, the passphrase is read from the key file given in the third field. @@ -264,7 +264,7 @@ passphrase and key files to derive a password for the volume. Therefore, the passphrase and all key files need to be provided. Use - tcrypt-keyfile= to provide + to provide the absolute path to all key files. When using an empty passphrase in combination with one or more key files, use /dev/null @@ -272,10 +272,10 @@ - tcrypt-hidden + Use the hidden TrueCrypt volume. - This option implies tcrypt. + This option implies . This will map the hidden volume that is inside of the volume provided in the second @@ -287,29 +287,29 @@ - tcrypt-keyfile= + Specifies the absolute path to a key file to use for a TrueCrypt volume. This - implies tcrypt and can be + implies and can be used more than once to provide several key files. - See the entry for tcrypt + See the entry for on the behavior of the passphrase and key files when using TrueCrypt encryption mode. - tcrypt-system + Use TrueCrypt in system encryption mode. This option implies - tcrypt. + . - timeout= + Specifies the timeout for querying for a password. If no unit is @@ -319,22 +319,22 @@ - tmp + The encrypted block device will be prepared for using it as /tmp; it will be formatted using mke2fs8. - This option implies plain. + This option implies . - WARNING: Using the tmp + WARNING: Using the option will destroy the contents of the named partition during every boot, so make sure the underlying block device is specified correctly. - tries= + Specifies the maximum number of times the user is queried for a password. @@ -343,7 +343,7 @@ - verify + If the encryption password is read from console, it has to be entered twice to diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 126b75cb1..34a1ac855 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -144,38 +144,70 @@ which influence how dependencies are created for mount points from /etc/fstab. systemd will create a dependency of type - from either - local-fs.target or + or + (see option below), 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 - is - specified, it may be used to configure how long systemd - should wait for a device to show up before giving up - on an entry from - /etc/fstab. Specify a time in - seconds or explicitly specify a unit as - s, min, - h, ms. - - If is given, this mount - will be only wanted, not required, by the - local-fs.target. This means that - the boot will continue even if this mount point is not - mounted successfully. Option has - the opposite meaning and is the default. - - If is given, this mount - will not be added as a dependency for - local-fs.target. This means that - it will not be mounted automatically during boot, - unless it is pulled in by some other unit. Option - has the opposite meaning and is - the default. + whether the file system is local or remote. + + + + + + + An automount unit will be created + for the file system. See + systemd.automount5 + for details. + + + + + + Configure how long systemd should + wait for a device to show up before giving up on + an entry from + /etc/fstab. Specify a time in + seconds or explicitly append a unit as + s, min, + h, + ms. + + Note that this option can only be used in + /etc/fstab, and will be + ignored when part of Options= + setting in a unit file. + + + + + + + + With this + mount will be only wanted, not required, by the + local-fs.target. This means + that the boot will continue even if this mount + point is not mounted successfully. Option + has the opposite meaning and + is the default. + + + + + + + + With , this + mount will not be added as a dependency for + local-fs.target. This means + that it will not be mounted automatically during + boot, unless it is pulled in by some other + unit. Option has the + opposite meaning and is the default. + + + If a mount point is configured in both /etc/fstab and a unit file that diff --git a/tools/make-directive-index.py b/tools/make-directive-index.py index 2ff304fdd..5c80a7b9e 100755 --- a/tools/make-directive-index.py +++ b/tools/make-directive-index.py @@ -113,12 +113,13 @@ TEMPLATE = '''\ - crypttab options + <filename>/etc/crypttab</filename> and + <filename>/etc/fstab</filename> options Options which influence mounted filesystems and encrypted volumes. - + -- 2.30.2