]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: add some sections to homectl man page
authorLennart Poettering <lennart@poettering.net>
Fri, 24 Jan 2025 12:31:51 +0000 (13:31 +0100)
committerLennart Poettering <lennart@poettering.net>
Fri, 24 Jan 2025 13:54:27 +0000 (14:54 +0100)
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.

man/homectl.xml
src/home/homectl.c

index 6dc830233c6867626d5a9aaee067eb4b120ba573..243d2b2b81a7456ff8399e66e5e6a1db0bda3598 100644 (file)
   </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
 
         <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
 
         <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>
 
         <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>
 
 
         <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, …
 
         <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>
 
         <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>
 
 
         <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>
 
         <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>
 
         <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>
 
index 29786760e2d1ecc84bd94ff1214cb431cc55c371..a056f831a69206f4a6fc46af1c4e20c461249701 100644 (file)
@@ -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"