]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: document recent systemd-sysext interface changes 18311/head
authorLennart Poettering <lennart@poettering.net>
Tue, 19 Jan 2021 18:53:20 +0000 (19:53 +0100)
committerLennart Poettering <lennart@poettering.net>
Wed, 20 Jan 2021 16:50:23 +0000 (17:50 +0100)
man/systemd-sysext.xml

index 6bda5f4fc6591426a39025042d3d8ecad1318b32..e5f2e368998303583adfbe0046095ecec0c0828d 100644 (file)
     with newer ones, for example to install a locally compiled development version of some low-level
     component over the immutable OS image without doing a full OS rebuild or modifying the nominally
     immutable image. (e.g. "install" a locally built package with <command>DESTDIR=/var/lib/extensions/mytest
-    make install &amp;&amp; systemd-sysext --refresh</command>, making it available in
+    make install &amp;&amp; systemd-sysext refresh</command>, making it available in
     <filename>/usr/</filename> as if it was installed in the OS image itself.) This case works regardless if
     the underlying host <filename>/usr/</filename> is managed as immutable disk image or is a traditional
     package manager controlled (i.e. writable) tree.</para>
   <refsect1>
     <title>Commands</title>
 
-    <para>The following command switches are understood:</para>
+    <para>The following commands are understood:</para>
 
     <variablelist>
       <varlistentry>
-        <term><option>--merge</option></term>
-        <term><option>-m</option></term>
+        <term><option>status</option></term>
+
+        <listitem><para>When invoked without any command verb, or when <option>status</option> is specified
+        the current merge status is shown, separately for both <filename>/usr/</filename> and
+        <filename>/opt/</filename>.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>merge</option></term>
         <listitem><para>Merges all currently installed system extension images into
         <filename>/usr/</filename> and <filename>/opt/</filename>, by overmounting these hierarchies with an
         <literal>overlayfs</literal> file system combining the underlying hierarchies with those included in
       </varlistentry>
 
       <varlistentry>
-        <term><option>--unmerge</option></term>
-        <term><option>-u</option></term>
+        <term><option>unmerge</option></term>
         <listitem><para>Unmerges all currently installed system extension images from
         <filename>/usr/</filename> and <filename>/opt/</filename>, by unmounting the
-        <literal>overlayfs</literal> file systems created by <option>--merge</option>
+        <literal>overlayfs</literal> file systems created by <option>merge</option>
         prior.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>--refresh</option></term>
-        <term><option>-R</option></term>
-        <listitem><para>A combination of <option>--unmerge</option> and <option>--merge</option>: if already
+        <term><option>refresh</option></term>
+        <listitem><para>A combination of <option>unmerge</option> and <option>merge</option>: if already
         mounted the existing <literal>overlayfs</literal> instance is unmounted temporarily, and then
         replaced by a new version. This command is useful after installing/removing system extension images,
         in order to update the <literal>overlayfs</literal> file system accordingly. If no system extensions
-        are installed when this command is executed, the equivalent of <option>--unmerge</option> is
+        are installed when this command is executed, the equivalent of <option>unmerge</option> is
         executed, without establishing any new <literal>overlayfs</literal> instance. Note that currently
         there's a brief moment where neither the old nor the new <literal>overlayfs</literal> file system is
         mounted. This implies that all resources supplied by a system extension will briefly disappear — even
       </varlistentry>
 
       <varlistentry>
-        <term><option>--list</option></term>
-        <term><option>-l</option></term>
+        <term><option>list</option></term>
 
         <listitem><para>A brief list of installed extension images is shown.</para></listitem>
       </varlistentry>
       <xi:include href="standard-options.xml" xpointer="help" />
       <xi:include href="standard-options.xml" xpointer="version" />
     </variablelist>
-
-    <para>When invoked without any command switches, the current merge status is shown, separately for both
-    <filename>/usr/</filename> and <filename>/opt/</filename>.</para>
   </refsect1>
 
   <refsect1>
         output style, or explicitly disabling JSON output.</para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>--force</option></term>
+
+        <listitem><para>When merging system extensions into <filename>/usr/</filename> and
+        <filename>/opt/</filename>, ignore version incompatibilities, i.e. force merging regardless of
+        whether the version information included in the extension images matches the host or
+        not.</para></listitem>
+      </varlistentry>
+
       <xi:include href="standard-options.xml" xpointer="no-pager" />
     </variablelist>
   </refsect1>