summaryrefslogtreecommitdiffstats
path: root/man/org.freedesktop.portable1.xml
diff options
context:
space:
mode:
Diffstat (limited to 'man/org.freedesktop.portable1.xml')
-rw-r--r--man/org.freedesktop.portable1.xml27
1 files changed, 18 insertions, 9 deletions
diff --git a/man/org.freedesktop.portable1.xml b/man/org.freedesktop.portable1.xml
index 6da7b0c..4de3da2 100644
--- a/man/org.freedesktop.portable1.xml
+++ b/man/org.freedesktop.portable1.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="org.freedesktop.portable1" conditional='ENABLE_PORTABLED'
@@ -229,16 +229,23 @@ node /org/freedesktop/portable1 {
for the current boot session, and a string representing the preferred copy mode
(whether to copy the image or to just symlink it) with the following possible values:
<itemizedlist>
- <listitem><para>(null)</para></listitem>
+ <listitem><para>(empty)</para></listitem>
<listitem><para>copy</para></listitem>
<listitem><para>symlink</para></listitem>
+
+ <listitem><para>mixed</para></listitem>
</itemizedlist>
- This method returns the list of changes applied to the system (for example, which unit was
- added and is now available as a system service). Each change is represented as a triplet of
- strings: the type of change applied, the path on which it was applied, and the source
- (if any). The type of change applied will be one of the following possible values:
+ If an empty string is passed the security profile drop-ins and images will be symlinked while unit
+ files will be copied, <varname>copy</varname> will copy, <varname>symlink</varname> will prefer
+ linking if possible (e.g.: a unit has to be copied out of an image), and <varname>mixed</varname> will
+ prefer linking the resources owned by the OS (e.g.: the portable profile located within the host's
+ /usr/ tree) but will copy the resources owned by the portable image (e.g.: the unit files and the
+ images). This method returns the list of changes applied to the system (for example, which unit was
+ added and is now available as a system service). Each change is represented as a triplet of strings:
+ the type of change applied, the path on which it was applied, and the source (if any). The type of
+ change applied will be one of the following possible values:
<itemizedlist>
<listitem><para>copy</para></listitem>
@@ -252,6 +259,9 @@ node /org/freedesktop/portable1 {
on the system. Note that this method returns only after all the listed operations are completed,
and due to the I/O involved it might take some time.</para>
+ <xi:include href="vpick.xml" xpointer="image"/>
+ <xi:include href="vpick.xml" xpointer="directory"/>
+
<para><function>AttachImageWithExtensions()</function> attaches a portable image to the system.
This method is a superset of <function>AttachImage()</function> with the addition of
a list of extensions as input parameter, which will be overlaid on top of the main
@@ -279,8 +289,7 @@ node /org/freedesktop/portable1 {
<para><function>DetachImageWithExtensions()</function> detaches a portable image from the system.
This method is a superset of <function>DetachImage()</function> with the addition of
a list of extensions as input parameter, which were overlaid on top of the main
- image via <function>AttachImageWithExtensions()</function>.
- The <varname>flag</varname> parameter is currently unused and reserved for future purposes.</para>
+ image via <function>AttachImageWithExtensions()</function>.</para>
<para><function>ReattachImage()</function> combines the effects of the
<function>AttachImage()</function> method and the <function>DetachImage()</function> method.
@@ -297,7 +306,7 @@ node /org/freedesktop/portable1 {
image. For more details on this functionality, see the <varname>MountImages=</varname> entry on
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
and <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
- The <varname>flag</varname> parameter is currently unused and reserved for future purposes</para>
+ </para>
<para><function>RemoveImage()</function> removes the image with the specified name.</para>