shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-01 17:51:22 +03:00
Code
679829e4aa
systemd/man/crypttab.xml

404 lines
21 KiB
XML
Raw Normal View History

man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<?xml version="1.0"?>
<!--*-nxml-*-->
<!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 2012 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
This is based on crypttab(5) from Fedora's initscripts package, which in
turn is based on Debian's version.
The Red Hat version has been written by Miloslav Trmac <mitr@redhat.com>.
-->
build-sys: create Makefile-man.am automatically man rules were repeating the same information in too many places, which was error prone. Those rules can be easily generated from .xml files. For efficiency and because python is not a required dependency, Makefile-man.am is only regenerated when requested with make update-man-list If no metadata in man/*.xml changed, this file should not change. So only when a new man page or a new alias is added, this file should show up in 'git diff'. The change should then be committed. If the support for building from git without python was dropped, we could drop Makefile-man.am from version control. This would also increase the partial build time (since more stuff would be rebuild whenever sources in man/*.xml would be modified), so it would probably wouldn't be worth it.
2013-02-03 07:47:47 +04:00
<refentry id="crypttab" conditional='HAVE_LIBCRYPTSETUP'>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<refentryinfo>
<title>crypttab</title>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Documentation</contrib>
<firstname>Miloslav</firstname>
<surname>Trmac</surname>
<email>mitr@redhat.com</email>
</author>
<author>
<contrib>Documentation</contrib>
<firstname>Lennart</firstname>
<surname>Poettering</surname>
<email>lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>crypttab</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>crypttab</refname>
<refpurpose>Configuration for encrypted block devices</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>/etc/crypttab</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>The <filename>/etc/crypttab</filename> file
describes encrypted block devices that are set up
during system boot.</para>
man: always supply quotes around literals When manpages are displayed on a terminal, <literal>s are indistinguishable from surrounding text. Add quotes everywhere, remove duplicate quotes, and tweak a few lists for consistent formatting. https://bugzilla.redhat.com/show_bug.cgi?id=874631
2013-06-26 16:03:53 +04:00
<para>Empty lines and lines starting with the <literal>#</literal>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
character are ignored. Each of the remaining lines
describes one encrypted block device, fields on the
line are delimited by white space. The first two
fields are mandatory, the remaining two are
optional.</para>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<para>Setting up encrypted block devices using this file
supports three encryption modes: LUKS, TrueCrypt and plain.
See <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for more information about each mode. When no mode is specified
in the options field and the block device contains a LUKS
signature, it is opened as a LUKS device; otherwise, it is
assumed to be in raw dm-crypt (plain mode) format.</para>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<para>The first field contains the name of the
resulting encrypted block device; the device is set up
within <filename>/dev/mapper/</filename>.</para>
<para>The second field contains a path to the
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
underlying block device or file, or a specification of a block
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
device via <literal>UUID=</literal> followed by the
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
UUID.</para>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<para>The third field specifies the encryption
password. If the field is not present or the password
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
is set to <literal>none</literal> or <literal>-</literal>,
the password has to be manually entered during system boot.
Otherwise, the field is interpreted as a absolute path to
a file containing the encryption password. For swap encryption,
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<filename>/dev/urandom</filename> or the hardware
device <filename>/dev/hw_random</filename> can be used
as the password file; using
<filename>/dev/random</filename> may prevent boot
completion if the system does not have enough entropy
to generate a truly random encryption key.</para>
<para>The fourth field, if present, is a
comma-delimited list of options. The following
options are recognized:</para>
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.
2014-06-30 17:27:16 +04:00
<variablelist class='fstab-options'>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>discard</option></term>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Allow discard requests to be
passed through the encrypted block device. This
improves performance on SSD storage but has
security implications.</para></listitem>
</varlistentry>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>cipher=</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Specifies the cipher to use. See
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
for possible values and the default value of
this option. A cipher with unpredictable IV
values, such as <literal>aes-cbc-essiv:sha256</literal>,
is recommended.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>hash=</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Specifies the hash to use for
password hashing. See
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
for possible values and the default value of
this option.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>keyfile-offset=</option></term>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Specifies the number of bytes to
skip at the start of the key file. See
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for possible values and the default value of
this option.</para></listitem>
</varlistentry>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: add keyfile-size= support This is useful e.g. if the keyfile is a raw device, where only parts of it should be read. It is typically used whenever the keyfile-offset= option is specified. Tested-by: Erik Westrup <erik.westrup@gmail.com>
2012-08-03 14:47:24 +04:00
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>keyfile-size=</option></term>
cryptsetup: add keyfile-size= support This is useful e.g. if the keyfile is a raw device, where only parts of it should be read. It is typically used whenever the keyfile-offset= option is specified. Tested-by: Erik Westrup <erik.westrup@gmail.com>
2012-08-03 14:47:24 +04:00
<listitem><para>Specifies the maximum number
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
of bytes to read from the key file. See
cryptsetup: add keyfile-size= support This is useful e.g. if the keyfile is a raw device, where only parts of it should be read. It is typically used whenever the keyfile-offset= option is specified. Tested-by: Erik Westrup <erik.westrup@gmail.com>
2012-08-03 14:47:24 +04:00
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
for possible values and the default value of
this option. This option is ignored in plain
encryption mode, as the key file size is then
given by the key size.</para></listitem>
cryptsetup: add keyfile-size= support This is useful e.g. if the keyfile is a raw device, where only parts of it should be read. It is typically used whenever the keyfile-offset= option is specified. Tested-by: Erik Westrup <erik.westrup@gmail.com>
2012-08-03 14:47:24 +04:00
</varlistentry>
cryptsetup: Support key-slot option Debian recently introduced the option key-slot to /etc/crypttab to specify the LUKS key slot to be used for decrypting the device. On systems where a keyfile is used and the key is not in the first slot, this can speed up the boot process quite a bit, since cryptsetup does not need to try all of the slots sequentially. (Unsuccessfully testing a key slot typically takes up to about 1 second.) This patch makes systemd aware of this option. Debian bug that introduced the feature: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=704470
2014-01-26 15:02:49 +04:00
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>key-slot=</option></term>
cryptsetup: Support key-slot option Debian recently introduced the option key-slot to /etc/crypttab to specify the LUKS key slot to be used for decrypting the device. On systems where a keyfile is used and the key is not in the first slot, this can speed up the boot process quite a bit, since cryptsetup does not need to try all of the slots sequentially. (Unsuccessfully testing a key slot typically takes up to about 1 second.) This patch makes systemd aware of this option. Debian bug that introduced the feature: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=704470
2014-01-26 15:02:49 +04:00
<listitem><para>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.
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.
2014-06-30 17:27:16 +04:00
This option implies <option>luks</option>. See
cryptsetup: Support key-slot option Debian recently introduced the option key-slot to /etc/crypttab to specify the LUKS key slot to be used for decrypting the device. On systems where a keyfile is used and the key is not in the first slot, this can speed up the boot process quite a bit, since cryptsetup does not need to try all of the slots sequentially. (Unsuccessfully testing a key slot typically takes up to about 1 second.) This patch makes systemd aware of this option. Debian bug that introduced the feature: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=704470
2014-01-26 15:02:49 +04:00
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for possible values. The default is to try
all key slots in sequential order.</para></listitem>
</varlistentry>
cryptsetup: add keyfile-offset= support This is useful if your keyfile is a block device, and you want to use a specific part of it, such as an area between the MBR and the first partition. This feature is documented in the Arch wiki[0], and has been supported by the Arch initscripts, so would be nice to get this into systemd. This requires libcryptsetup >= 1.4.2 (released 12.4.2012). Acked-by: Paul Menzel <paulepanter@users.sourceforge.net> [0]: <https://wiki.archlinux.org/index.php/System_Encryption_with_LUKS# Storing_the_key_between_MBR_and_1st_partition>
2012-06-29 16:36:37 +04:00
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>luks</option></term>
cryptsetup: add keyfile-offset= support This is useful if your keyfile is a block device, and you want to use a specific part of it, such as an area between the MBR and the first partition. This feature is documented in the Arch wiki[0], and has been supported by the Arch initscripts, so would be nice to get this into systemd. This requires libcryptsetup >= 1.4.2 (released 12.4.2012). Acked-by: Paul Menzel <paulepanter@users.sourceforge.net> [0]: <https://wiki.archlinux.org/index.php/System_Encryption_with_LUKS# Storing_the_key_between_MBR_and_1st_partition>
2012-06-29 16:36:37 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Force LUKS mode. When this mode
man: wording and grammar updates This includes regularly-submitted corrections to comma setting and orthographical mishaps that appeared in man/ in recent commits.
2013-07-21 08:53:14 +04:00
is used, the following options are ignored since
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
they are provided by the LUKS header on the
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.
2014-06-30 17:27:16 +04:00
device: <option>cipher=</option>,
<option>hash=</option>,
<option>size=</option>.</para></listitem>
cryptsetup: add keyfile-offset= support This is useful if your keyfile is a block device, and you want to use a specific part of it, such as an area between the MBR and the first partition. This feature is documented in the Arch wiki[0], and has been supported by the Arch initscripts, so would be nice to get this into systemd. This requires libcryptsetup >= 1.4.2 (released 12.4.2012). Acked-by: Paul Menzel <paulepanter@users.sourceforge.net> [0]: <https://wiki.archlinux.org/index.php/System_Encryption_with_LUKS# Storing_the_key_between_MBR_and_1st_partition>
2012-06-29 16:36:37 +04:00
</varlistentry>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>noauto</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>This device will not be
automatically unlocked on boot.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>nofail</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>The system will not wait for the
device to show up and be unlocked at boot, and
not fail the boot if it does not show up.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>plain</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Force plain encryption mode.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>read-only</option></term><term><option>readonly</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Set up the encrypted block
device in read-only mode.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>size=</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Specifies the key size
in bits. See
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for possible values and the default value of
this option.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>swap</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>The encrypted block device will
be used as a swap device, and will be formatted
accordingly after setting up the encrypted
block device, with
man: add a mapping for external manpages It is annoying when we have dead links on fd.o. Add project='man-pages|die-net|archlinux' to <citerefentry>-ies. In generated html, add external links to http://man7.org/linux/man-pages/man, http://linux.die.net/man/, https://www.archlinux.org/. By default, pages in sections 2 and 4 go to man7, since Michael Kerrisk is the autorative source on kernel related stuff. The rest of links goes to linux.die.net, because they have the manpages. Except for the pacman stuff, since it seems to be only available from archlinux.org. Poor gummiboot gets no link, because gummitboot(8) ain't to be found on the net. According to common wisdom, that would mean that it does not exist. But I have seen Kay using it, so I know it does, and deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-08 02:25:54 +04:00
<citerefentry project='man-pages'><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
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.
2014-06-30 17:27:16 +04:00
This option implies <option>plain</option>.</para>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
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.
2014-06-30 17:27:16 +04:00
<para>WARNING: Using the <option>swap</option>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
option will destroy the contents of the named
partition during every boot, so make sure the
underlying block device is specified correctly.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>tcrypt</option></term>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Use TrueCrypt encryption mode.
man: wording and grammar updates This includes regularly-submitted corrections to comma setting and orthographical mishaps that appeared in man/ in recent commits.
2013-07-21 08:53:14 +04:00
When this mode is used, the following options are
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
ignored since they are provided by the TrueCrypt
header on the device or do not apply:
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.
2014-06-30 17:27:16 +04:00
<option>cipher=</option>,
<option>hash=</option>,
<option>keyfile-offset=</option>,
<option>keyfile-size=</option>,
<option>size=</option>.</para>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<para>When this mode is used, the passphrase is
read from the key file given in the third field.
Only the first line of this file is read,
excluding the new line character.</para>
<para>Note that the TrueCrypt format uses both
passphrase and key files to derive a password
for the volume. Therefore, the passphrase and
all key files need to be provided. Use
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.
2014-06-30 17:27:16 +04:00
<option>tcrypt-keyfile=</option> to provide
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
the absolute path to all key files. When using
an empty passphrase in combination with one or
more key files, use <literal>/dev/null</literal>
as the password file in the third field.</para></listitem>
</varlistentry>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>tcrypt-hidden</option></term>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Use the hidden TrueCrypt volume.
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.
2014-06-30 17:27:16 +04:00
This option implies <option>tcrypt</option>.</para>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<para>This will map the hidden volume that is
inside of the volume provided in the second
field. Please note that there is no protection
for the hidden volume if the outer volume is
mounted instead. See
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for more information on this limitation.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>tcrypt-keyfile=</option></term>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Specifies the absolute path to a
key file to use for a TrueCrypt volume. This
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.
2014-06-30 17:27:16 +04:00
implies <option>tcrypt</option> and can be
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
used more than once to provide several key
files.</para>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
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.
2014-06-30 17:27:16 +04:00
<para>See the entry for <option>tcrypt</option>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
on the behavior of the passphrase and key files
when using TrueCrypt encryption mode.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>tcrypt-system</option></term>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Use TrueCrypt in system
doc: choose different words to improve clarity I suggest the following changes to improve the way the text reads ("flows").
2014-02-17 05:49:45 +04:00
encryption mode. This option implies
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.
2014-06-30 17:27:16 +04:00
<option>tcrypt</option>.</para></listitem>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>timeout=</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Specifies the timeout for
querying for a password. If no unit is
specified, seconds is used. Supported units are
s, ms, us, min, h, d. A timeout of 0 waits
indefinitely (which is the default).</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
man: document x-systemd.device-timeout for crypttab https://bugs.freedesktop.org/show_bug.cgi?id=54210
2014-07-11 06:34:43 +04:00
<varlistentry>
<term><option>x-systemd.device-timeout=</option></term>
<listitem><para>Specifies how long
systemd should wait for a device to
show up before giving up on the
entry. The argument is a time in
seconds or explicitly specifified
units of <literal>s</literal>,
<literal>min</literal>,
<literal>h</literal>,
<literal>ms</literal>.
</para></listitem>
</varlistentry>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>tmp</option></term>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>The encrypted block device will
be prepared for using it as <filename>/tmp</filename>;
it will be formatted using
man: add a mapping for external manpages It is annoying when we have dead links on fd.o. Add project='man-pages|die-net|archlinux' to <citerefentry>-ies. In generated html, add external links to http://man7.org/linux/man-pages/man, http://linux.die.net/man/, https://www.archlinux.org/. By default, pages in sections 2 and 4 go to man7, since Michael Kerrisk is the autorative source on kernel related stuff. The rest of links goes to linux.die.net, because they have the manpages. Except for the pacman stuff, since it seems to be only available from archlinux.org. Poor gummiboot gets no link, because gummitboot(8) ain't to be found on the net. According to common wisdom, that would mean that it does not exist. But I have seen Kay using it, so I know it does, and deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-08 02:25:54 +04:00
<citerefentry project='man-pages'><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
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.
2014-06-30 17:27:16 +04:00
This option implies <option>plain</option>.</para>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
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.
2014-06-30 17:27:16 +04:00
<para>WARNING: Using the <option>tmp</option>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
option will destroy the contents of the named
partition during every boot, so make sure the
underlying block device is specified correctly.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>tries=</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para>Specifies the maximum number of
cryptsetup: Retry indefinitely if tries=0 option has been set. When running from initrd, entering a wrong passphrase usually means that you cannot boot. Therefore, we allow trying indefinitely.
2013-08-18 20:24:13 +04:00
times the user is queried for a password.
The default is 3. If set to 0, the user is
queried for a password indefinitely.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
<varlistentry>
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.
2014-06-30 17:27:16 +04:00
<term><option>verify</option></term>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<listitem><para> If the encryption password is
read from console, it has to be entered twice to
prevent typos.</para></listitem>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</varlistentry>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</variablelist>
man: document systemd-cryptsetup-generator
2012-06-27 16:51:47 +04:00
<para>At early boot and when the system manager
man: more grammar improvements - place commas - expand contractions (this is written prose :) - add some missing words
2013-07-02 07:44:04 +04:00
configuration is reloaded, this file is translated into
man: document systemd-cryptsetup-generator
2012-06-27 16:51:47 +04:00
native systemd units
by <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</refsect1>
<refsect1>
<title>Example</title>
<example>
<title>/etc/crypttab example</title>
cryptsetup: Add tcrypt support Tcrypt uses a different approach to passphrases/key files. The passphrase and all key files are incorporated into the "password" to open the volume. So, the idea of slots that provide a way to open the volume with different passphrases/key files that are independent from each other like with LUKS does not apply. Therefore, we use the key file from /etc/crypttab as the source for the passphrase. The actual key files that are combined with the passphrase into a password are provided as a new option in /etc/crypttab and can be given multiple times if more than one key file is used by a volume.
2013-07-13 15:19:38 +04:00
<para>Set up four encrypted block devices. One using
LUKS for normal storage, another one for usage as a swap
device and two TrueCrypt volumes.</para>
<programlisting>luks UUID=2505567a-9e27-4efe-a4d5-15ad146c258b
swap /dev/sda7 /dev/urandom swap
truecrypt /dev/sda2 /etc/container_password tcrypt
man: fix path in crypttab(5) https://bugs.freedesktop.org/show_bug.cgi?id=75816
2014-06-24 07:07:53 +04:00
hidden /mnt/tc_hidden /dev/null tcrypt-hidden,tcrypt-keyfile=/etc/keyfile</programlisting>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</example>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
man: document systemd-cryptsetup-generator
2012-06-27 16:51:47 +04:00
<citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
man: add a mapping for external manpages It is annoying when we have dead links on fd.o. Add project='man-pages|die-net|archlinux' to <citerefentry>-ies. In generated html, add external links to http://man7.org/linux/man-pages/man, http://linux.die.net/man/, https://www.archlinux.org/. By default, pages in sections 2 and 4 go to man7, since Michael Kerrisk is the autorative source on kernel related stuff. The rest of links goes to linux.die.net, because they have the manpages. Except for the pacman stuff, since it seems to be only available from archlinux.org. Poor gummiboot gets no link, because gummitboot(8) ain't to be found on the net. According to common wisdom, that would mean that it does not exist. But I have seen Kay using it, so I know it does, and deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-08 02:25:54 +04:00
<citerefentry project='man-pages'><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry project='man-pages'><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
man: document /etc/crypttab
2012-06-27 15:23:12 +04:00
</para>
</refsect1>
</refentry>
Copy Permalink