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

[thirdparty/systemd.git] / man / homectl.xml

diff --git a/man/homectl.xml b/man/homectl.xml
index f2e98799304431ea7d993eae76038ac01828e2e0..4c792ca8cb39e2b6bb0e4145c291736b7761f430 100644 (file)
--- 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>