diff options
Diffstat (limited to 'man/portablectl.xml')
| -rw-r--r-- | man/portablectl.xml | 54 |
1 files changed, 35 insertions, 19 deletions
diff --git a/man/portablectl.xml b/man/portablectl.xml index c1946d7..92d8ff0 100644 --- a/man/portablectl.xml +++ b/man/portablectl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="portablectl" conditional='ENABLE_PORTABLED' @@ -141,6 +141,8 @@ immediately started (blocking operation unless <option>--no-block</option> is passed) and/or enabled after attaching the image.</para> + <xi:include href="vpick.xml" xpointer="image"/> + <xi:include href="vpick.xml" xpointer="directory"/> <xi:include href="version-info.xml" xpointer="v239"/> </listitem> </varlistentry> @@ -155,11 +157,11 @@ files. This is a convenience feature to allow all arguments passed as <command>attach</command> also to <command>detach</command>.</para> - <xi:include href="version-info.xml" xpointer="v239"/></listitem> - <para>If <option>--now</option> and/or <option>--enable</option> are passed, the portable services are immediately stopped (blocking operation) and/or disabled before detaching the image. Prefix(es) are also accepted, to be used in case the unit names do not match the image name as described in the <command>attach</command>.</para> + + <xi:include href="version-info.xml" xpointer="v239"/></listitem> </varlistentry> <varlistentry> @@ -171,11 +173,11 @@ character has to match. If the new image doesn't exist, the existing one will not be detached. The parameters follow the same syntax as the <command>attach</command> command.</para> - <xi:include href="version-info.xml" xpointer="v248"/></listitem> - <para>If <option>--now</option> and/or <option>--enable</option> are passed, the portable services are immediately stopped if removed, started and/or enabled if added, or restarted if updated. Prefixes are also accepted, in the same way as described in the <command>attach</command> case.</para> + + <xi:include href="version-info.xml" xpointer="v248"/></listitem> </varlistentry> <varlistentry> @@ -310,7 +312,7 @@ <varlistentry> <term><option>-p</option> <replaceable>PROFILE</replaceable></term> - <term><option>--profile=</option><replaceable>PROFILE</replaceable></term> + <term><option>--profile=<replaceable>PROFILE</replaceable></option></term> <listitem><para>When attaching an image, select the profile to use. By default the <literal>default</literal> profile is used. For details about profiles, see below.</para> @@ -321,12 +323,14 @@ <varlistentry> <term><option>--copy=</option></term> - <listitem><para>When attaching an image, select whether to prefer copying or symlinking of files installed into - the host system. Takes one of <literal>copy</literal> (to prefer copying of files), <literal>symlink</literal> - (to prefer creation of symbolic links) or <literal>auto</literal> for an intermediary mode where security - profile drop-ins are symlinked while unit files are copied. Note that this option expresses a preference only, - in cases where symbolic links cannot be created — for example when the image operated on is a raw disk image, - and hence not directly referentiable from the host file system — copying of files is used + <listitem><para>When attaching an image, select whether to prefer copying or symlinking of files + installed into the host system. Takes one of <literal>copy</literal> (files will be copied), + <literal>symlink</literal> (to prefer creation of symbolic links), <literal>auto</literal> for an + intermediary mode where security profile drop-ins and images are symlinked while unit files are + copied, or <literal>mixed</literal> (since v256) where security profile drop-ins are symlinked while + unit files and images are copied. Note that this option expresses a preference only, in cases where + symbolic links cannot be created — for example when the image operated on is a raw disk image, and + hence not directly referentiable from the host file system — copying of files is used unconditionally.</para> <xi:include href="version-info.xml" xpointer="v239"/></listitem> @@ -390,7 +394,16 @@ </varlistentry> <varlistentry> - <term><option>--extension=</option><replaceable>PATH</replaceable></term> + <term><option>--clean</option></term> + + <listitem><para>When detaching ensure the configuration, state, logs, cache, and runtime data + directories of the portable service are removed from the host system.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--extension=<replaceable>PATH</replaceable></option></term> <listitem><para>Add an additional image <replaceable>PATH</replaceable> as an overlay on top of <replaceable>IMAGE</replaceable> when attaching/detaching. This argument can be specified @@ -410,6 +423,8 @@ <para>Note that the same extensions have to be specified, in the same order, when attaching and detaching.</para> + <xi:include href="vpick.xml" xpointer="image"/> + <xi:include href="vpick.xml" xpointer="directory"/> <xi:include href="version-info.xml" xpointer="v249"/></listitem> </varlistentry> @@ -504,12 +519,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>org.freedesktop.portable1</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-portabled.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>org.freedesktop.portable1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-portabled.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> |