From: Lennart Poettering <lennart@poettering.net>
Date: Fri, 24 Jan 2025 12:31:51 +0000 (+0100)
Subject: man: add some sections to homectl man page
X-Git-Tag: v258-rc1~1493^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=cd3730524c522cccf3812ba9f5e0faee642635aa;p=thirdparty%2Fsystemd.git

man: add some sections to homectl man page

This adds the same sections we already have in the homectl --help blurb
also to the man page.

While we are at it, let's also add a new section for Authentication
related switches.
---

diff --git a/man/homectl.xml b/man/homectl.xml
index 6dc830233c6..243d2b2b81a 100644
--- a/man/homectl.xml
+++ b/man/homectl.xml
@@ -191,7 +191,7 @@
   </refsect1>
 
   <refsect1>
-    <title>User Record Properties</title>
+    <title>General User Record Properties</title>
 
     <para>The following options control various properties of the user records/home directories that
     <filename>systemd-homed.service</filename> manages. These switches may be used in conjunction with the
@@ -394,7 +394,12 @@
 
         <xi:include href="version-info.xml" xpointer="v245"/></listitem>
       </varlistentry>
+    </variablelist>
+  </refsect1>
 
+  <refsect1>
+    <title>Authentication User Record Properties</title>
+    <variablelist>
       <varlistentry>
         <term><option>--ssh-authorized-keys=<replaceable>KEYS</replaceable></option></term>
         <listitem><para>Either takes a SSH authorized key line to associate with the user record or a
@@ -526,8 +531,13 @@
 
         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
       </varlistentry>
+    </variablelist>
+  </refsect1>
 
-    <varlistentry>
+  <refsect1>
+    <title>Blob Directory User Record Properties</title>
+    <variablelist>
+      <varlistentry>
         <term><option>--blob=<replaceable>PATH</replaceable></option></term>
         <term><option>-b</option> <replaceable>PATH</replaceable></term>
         <term><option>--blob=<replaceable>FILENAME</replaceable>=<replaceable>PATH</replaceable></option></term>
@@ -560,7 +570,12 @@
 
         <xi:include href="version-info.xml" xpointer="v256"/></listitem>
       </varlistentry>
+    </variablelist>
+  </refsect1>
 
+  <refsect1>
+    <title>Account Management User Record Properties</title>
+    <variablelist>
       <varlistentry>
         <term><option>--locked=<replaceable>BOOLEAN</replaceable></option></term>
 
@@ -651,7 +666,12 @@
 
         <xi:include href="version-info.xml" xpointer="v245"/></listitem>
       </varlistentry>
+    </variablelist>
+  </refsect1>
 
+  <refsect1>
+    <title>Resource Management User Record Properties</title>
+    <variablelist>
       <varlistentry>
         <term><option>--disk-size=<replaceable>BYTES</replaceable></option></term>
         <listitem><para>Either takes a size in bytes as argument (possibly using the usual K, M, G, …
@@ -757,7 +777,12 @@
 
         <xi:include href="version-info.xml" xpointer="v245"/></listitem>
       </varlistentry>
+    </variablelist>
+  </refsect1>
 
+  <refsect1>
+    <title>Storage User Record Properties</title>
+    <variablelist>
       <varlistentry>
         <term><option>--tmp-limit=<replaceable>BYTES</replaceable></option></term>
         <term><option>--tmp-limit=<replaceable>PERCENT</replaceable></option></term>
@@ -815,7 +840,12 @@
 
         <xi:include href="version-info.xml" xpointer="v250"/></listitem>
       </varlistentry>
+    </variablelist>
+  </refsect1>
 
+  <refsect1>
+    <title>LUKS Storage User Record Properties</title>
+    <variablelist>
       <varlistentry>
         <term><option>--fs-type=<replaceable>TYPE</replaceable></option></term>
 
@@ -933,7 +963,12 @@
 
         <xi:include href="version-info.xml" xpointer="v250"/></listitem>
       </varlistentry>
+    </variablelist>
+  </refsect1>
 
+  <refsect1>
+    <title>Mounting User Record Properties</title>
+    <variablelist>
       <varlistentry>
         <term><option>--nosuid=<replaceable>BOOL</replaceable></option></term>
         <term><option>--nodev=<replaceable>BOOL</replaceable></option></term>
@@ -947,7 +982,12 @@
 
         <xi:include href="version-info.xml" xpointer="v245"/></listitem>
       </varlistentry>
+    </variablelist>
+  </refsect1>
 
+  <refsect1>
+    <title>CIFS User Record Properties</title>
+    <variablelist>
       <varlistentry>
         <term><option>--cifs-domain=<replaceable>DOMAIN</replaceable></option></term>
         <term><option>--cifs-user-name=<replaceable>USER</replaceable></option></term>
@@ -966,7 +1006,12 @@
 
         <xi:include href="version-info.xml" xpointer="v245"/></listitem>
       </varlistentry>
+    </variablelist>
+  </refsect1>
 
+  <refsect1>
+    <title>Login Behaviour Record Properties</title>
+    <variablelist>
       <varlistentry>
         <term><option>--stop-delay=<replaceable>SECS</replaceable></option></term>
 
diff --git a/src/home/homectl.c b/src/home/homectl.c
index 29786760e2d..a056f831a69 100644
--- a/src/home/homectl.c
+++ b/src/home/homectl.c
@@ -2772,6 +2772,7 @@ static int help(int argc, char *argv[], void *userdata) {
                "     --setenv=VARIABLE[=VALUE] Set an environment variable at log-in\n"
                "     --timezone=TIMEZONE       Set a time-zone\n"
                "     --language=LOCALE         Set preferred languages\n"
+               "\n%4$sAuthentication User Record Properties:%5$s\n"
                "     --ssh-authorized-keys=KEYS\n"
                "                               Specify SSH public keys\n"
                "     --pkcs11-token-uri=URI    URI to PKCS#11 security token containing\n"