From: Lennart Poettering <lennart@poettering.net>
Date: Tue, 18 Aug 2020 07:33:10 +0000 (+0200)
Subject: man: document new homectl --recovery-key= switch
X-Git-Tag: v247-rc1~365^2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=05c8e12c4729a8965079aed63e82799d3023c6a8;p=thirdparty%2Fsystemd.git

man: document new homectl --recovery-key= switch
---

diff --git a/man/homectl.xml b/man/homectl.xml
index f2e98799304..4c792ca8cb3 100644
--- a/man/homectl.xml
+++ b/man/homectl.xml
@@ -376,6 +376,16 @@
         discussion see above.</para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>--recovery-key=</option><replaceable>BOOL</replaceable></term>
+
+        <listitem><para>Accepts a boolean argument. If enabled a recovery key is configured for the
+        account. A recovery key is a computer generated access key that may be used to regain access to an
+        account if the password has been forgotten or the authentication token lost. The key is generated and
+        shown on screen, and should be printed or otherwise transferred to a secure location. A recovery key
+        may be entered instead of a regular password to unlock the account.</para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><option>--locked=</option><replaceable>BOOLEAN</replaceable></term>