man/doc: document auto resize modes

diff --git a/docs/USER_RECORD.md b/docs/USER_RECORD.md
index 9263d2db1dde7773c3986e9337b41207b4d50724..9634f32b70bfa161379a126e797090b49d18a450 100644 (file)
--- a/docs/USER_RECORD.md
+++ b/docs/USER_RECORD.md
@@ -501,6 +501,12 @@ memory cost for the PBKDF operation, when LUKS storage is used, in bytes.
 `luksPbkdfParallelThreads` → An unsigned 64bit integer, indicating the intended
 required parallel threads for the PBKDF operation, when LUKS storage is used.
 
+`autoResizeMode` → A string, one of `off`, `grow`, `shrink-and-grow`. Unless
+set to `off`, controls whether the home area shall be grown automatically to
+the size configured in `diskSize` automatically at login time. If set to
+`shrink-and-grown` the home area is also shrunk to the minimal size possible
+(as dictated by used disk space and file system constraints) on logout.
+
 `service` → A string declaring the service that defines or manages this user
 record. It is recommended to use reverse domain name notation for this. For
 example, if `systemd-homed` manages a user a string of `io.systemd.Home` is

diff --git a/man/homectl.xml b/man/homectl.xml
index 89af3d77c7f8ef8b580da8067391613504d92e58..b94d52b0943c350853e652cf33c391408de891e8 100644 (file)
--- a/man/homectl.xml
+++ b/man/homectl.xml
@@ -683,6 +683,26 @@
         for details on the specific attributes.</para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>--auto-resize-mode=</option></term>
+
+        <listitem><para>Configures whether to automatically grow and/or shrink the backing file system on
+        login and logout. Takes one of the strings <literal>off</literal>, <literal>grow</literal>,
+        <literal>shrink-and-grow</literal>. Only applies to the LUKS2 backend currently, and if the btrfs
+        file system is used inside it (since only then online growing/shrinking of the file system is
+        supported). Defaults to <literal>shrink-and-grow</literal>, if LUKS2/btrfs is used, otherwise is
+        off. If set to <literal>off</literal> no automatic shrinking/growing during login or logout is
+        done. If set to <literal>grow</literal> the home area is grown to the size configured via
+        <option>--disk-size=</option> should it currently be smaller. If it already matches the configured
+        size or is larger no operation is executed. If set to <literal>shrink-and-grow</literal> the home
+        area is also resized to the minimal size used disk space and file system constraints permit, during
+        logout. This mode thus ensures that while a home area is activated it is sized to the configured
+        size, but while deactivated it is compacted taking up only the minimal space possible. Note that if
+        the system is powered off abnormally or if the user otherwise not logged out cleanly the shrinking
+        operation will not take place, and the user has to re-login/logout again before it is executed
+        again.</para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><option>--nosuid=</option><replaceable>BOOL</replaceable></term>
         <term><option>--nodev=</option><replaceable>BOOL</replaceable></term>