From: nl6720 <nl6720@gmail.com>
Date: Sat, 18 Jan 2025 15:46:03 +0000 (+0200)
Subject: man: replace "-" with "none" in cryptsetup commands and crypttab
X-Git-Tag: v258-rc1~1563
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=a153d7cbd20478fb2dad10d889863f8303542cf8;p=thirdparty%2Fsystemd.git

man: replace "-" with "none" in cryptsetup commands and crypttab

`none` is more explicit and harder to overlook than `-` which in certain
contexts could be misunderstood to mean standard input.
---

diff --git a/man/fido2-crypttab.sh b/man/fido2-crypttab.sh
index 6823958a4e4..31ecfeaffd0 100644
--- a/man/fido2-crypttab.sh
+++ b/man/fido2-crypttab.sh
@@ -5,7 +5,7 @@
 sudo systemd-cryptenroll --fido2-device=auto /dev/sdXn
 
 # Test: Let's run systemd-cryptsetup to test if this worked.
-sudo systemd-cryptsetup attach mytest /dev/sdXn - fido2-device=auto
+sudo systemd-cryptsetup attach mytest /dev/sdXn none fido2-device=auto
 
 # If that worked, let's now add the same line persistently to /etc/crypttab,
 # for the future. We do not want to use the (unstable) /dev/sdX name, so let's
@@ -13,7 +13,7 @@ sudo systemd-cryptsetup attach mytest /dev/sdXn - fido2-device=auto
 udevadm info -q symlink -r /dev/sdXn
 
 # Now add the line using the by-uuid symlink to /etc/crypttab:
-sudo bash -c 'echo "mytest /dev/disk/by-uuid/... - fido2-device=auto" >>/etc/crypttab'
+sudo bash -c 'echo "mytest /dev/disk/by-uuid/... none fido2-device=auto" >>/etc/crypttab'
 
 # Depending on your distribution and encryption setup, you may need to manually
 # regenerate your initramfs to be able to use a FIDO2 device to unlock the
diff --git a/man/systemd-cryptenroll.xml b/man/systemd-cryptenroll.xml
index b80a63f4266..7c2f4ec0e59 100644
--- a/man/systemd-cryptenroll.xml
+++ b/man/systemd-cryptenroll.xml
@@ -369,7 +369,7 @@
         <para>In order to unlock a LUKS2 volume with an enrolled PKCS#11 security token, specify the
         <option>pkcs11-uri=</option> option in the respective <filename>/etc/crypttab</filename> line:</para>
 
-        <programlisting>myvolume /dev/sda1 - pkcs11-uri=auto</programlisting>
+        <programlisting>myvolume /dev/sda1 none pkcs11-uri=auto</programlisting>
 
         <para>See
         <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a
@@ -403,7 +403,7 @@
         <para>In order to unlock a LUKS2 volume with an enrolled FIDO2 security token, specify the
         <option>fido2-device=</option> option in the respective <filename>/etc/crypttab</filename> line:</para>
 
-        <programlisting>myvolume /dev/sda1 - fido2-device=auto</programlisting>
+        <programlisting>myvolume /dev/sda1 none fido2-device=auto</programlisting>
 
         <para>See
         <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a
@@ -507,7 +507,7 @@
         <para>In order to unlock a LUKS2 volume with an enrolled TPM2 security chip, specify the
         <option>tpm2-device=</option> option in the respective <filename>/etc/crypttab</filename> line:</para>
 
-        <programlisting>myvolume /dev/sda1 - tpm2-device=auto</programlisting>
+        <programlisting>myvolume /dev/sda1 none tpm2-device=auto</programlisting>
 
         <para>See
         <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a
diff --git a/man/tpm2-crypttab.sh b/man/tpm2-crypttab.sh
index aff0c9b62a2..765c1ee8eb4 100644
--- a/man/tpm2-crypttab.sh
+++ b/man/tpm2-crypttab.sh
@@ -5,7 +5,7 @@
 sudo systemd-cryptenroll --tpm2-device=auto --tpm2-pcrs=7 /dev/sdXn
 
 # Test: Let's run systemd-cryptsetup to test if this worked.
-sudo systemd-cryptsetup attach mytest /dev/sdXn - tpm2-device=auto
+sudo systemd-cryptsetup attach mytest /dev/sdXn none tpm2-device=auto
 
 # If that worked, let's now add the same line persistently to /etc/crypttab,
 # for the future. We do not want to use the (unstable) /dev/sdX name, so let's
@@ -13,7 +13,7 @@ sudo systemd-cryptsetup attach mytest /dev/sdXn - tpm2-device=auto
 udevadm info -q symlink -r /dev/sdXn
 
 # Now add the line using the by-uuid symlink to /etc/crypttab:
-sudo bash -c 'echo "mytest /dev/disk/by-uuid/... - tpm2-device=auto" >>/etc/crypttab'
+sudo bash -c 'echo "mytest /dev/disk/by-uuid/... none tpm2-device=auto" >>/etc/crypttab'
 
 # And now let's check that automatic unlocking works:
 sudo systemd-cryptsetup detach mytest
diff --git a/man/yubikey-crypttab.sh b/man/yubikey-crypttab.sh
index 291ec42e32b..e5679537c03 100644
--- a/man/yubikey-crypttab.sh
+++ b/man/yubikey-crypttab.sh
@@ -21,7 +21,7 @@ rm pubkey.pem
 sudo systemd-cryptenroll --pkcs11-token-uri=auto /dev/sdXn
 
 # Test: Let's run systemd-cryptsetup to test if this all worked.
-sudo systemd-cryptsetup attach mytest /dev/sdXn - pkcs11-uri=auto
+sudo systemd-cryptsetup attach mytest /dev/sdXn none pkcs11-uri=auto
 
 # If that worked, let's now add the same line persistently to /etc/crypttab,
 # for the future. We do not want to use the (unstable) /dev/sdX name, so let's
@@ -29,7 +29,7 @@ sudo systemd-cryptsetup attach mytest /dev/sdXn - pkcs11-uri=auto
 udevadm info -q symlink -r /dev/sdXn
 
 # Now add the line using the by-uuid symlink to /etc/crypttab:
-sudo bash -c 'echo "mytest /dev/disk/by-uuid/... - pkcs11-uri=auto" >>/etc/crypttab'
+sudo bash -c 'echo "mytest /dev/disk/by-uuid/... none pkcs11-uri=auto" >>/etc/crypttab'
 
 # Depending on your distribution and encryption setup, you may need to manually
 # regenerate your initramfs to be able to use a Yubikey / PKCS#11 token to