From 61e8e294f5f7ca9fb3b3a8df37e0395c4bda7c16 Mon Sep 17 00:00:00 2001
From: shinygold <10763595+shinygold@users.noreply.github.com>
Date: Mar 16 2021 04:19:35 +0000
Subject: cryptsetup: add documentation for keyfile-timeout


(cherry picked from commit 4e1334512debb27f4a0c4a6da237a4b8d59fea08)

Related: #1763155

patch_name: 0298-cryptsetup-add-documentation-for-keyfile-timeout.patch
present_in_specfile: true
location_in_specfile: 298
squash_commits: true

---

diff --git a/man/crypttab.xml b/man/crypttab.xml
index 3574ce0..6074315 100644
--- a/man/crypttab.xml
+++ b/man/crypttab.xml
@@ -151,6 +151,17 @@
       </varlistentry>
 
       <varlistentry>
+        <term><option>keyfile-timeout=</option></term>
+
+        <listitem><para> Specifies the timeout for the device on
+        which the key file resides and falls back to a password if
+        it could not be mounted. See
+        <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+        for key files on external devices.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term><option>luks</option></term>
 
         <listitem><para>Force LUKS mode. When this mode is used, the
@@ -417,7 +428,8 @@
       <programlisting>luks       UUID=2505567a-9e27-4efe-a4d5-15ad146c258b
 swap       /dev/sda7       /dev/urandom       swap
 truecrypt  /dev/sda2       /etc/container_password  tcrypt
-hidden     /mnt/tc_hidden  /dev/null    tcrypt-hidden,tcrypt-keyfile=/etc/keyfile</programlisting>
+hidden     /mnt/tc_hidden  /dev/null    tcrypt-hidden,tcrypt-keyfile=/etc/keyfile
+external   /dev/sda3       keyfile:LABEL=keydev keyfile-timeout=10s</programlisting>
     </example>
   </refsect1>