summaryrefslogtreecommitdiffstats
path: root/upstream/fedora-rawhide/man1/portablectl.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/fedora-rawhide/man1/portablectl.1')
-rw-r--r--upstream/fedora-rawhide/man1/portablectl.188
1 files changed, 69 insertions, 19 deletions
diff --git a/upstream/fedora-rawhide/man1/portablectl.1 b/upstream/fedora-rawhide/man1/portablectl.1
index 4dba78bb..d0b277fc 100644
--- a/upstream/fedora-rawhide/man1/portablectl.1
+++ b/upstream/fedora-rawhide/man1/portablectl.1
@@ -1,5 +1,5 @@
'\" t
-.TH "PORTABLECTL" "1" "" "systemd 255" "portablectl"
+.TH "PORTABLECTL" "1" "" "systemd 256~rc3" "portablectl"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -38,10 +38,10 @@ or
\fIRootImage=\fR
assignments (in case of service units) pointing to the image file or directory, ensuring the services will run within the file system context of the image\&.
.PP
-Portable service images are an efficient way to bundle multiple related services and other units together, and transfer them as a whole between systems\&. When these images are attached the local system the contained units may run in most ways like regular system\-provided units, either with full privileges or inside strict sandboxing, depending on the selected configuration\&. For more details, see
+Portable service images are an efficient way to bundle multiple related services and other units together, and transfer them as a whole between systems\&. When these images are attached to the local system, the contained units may run in most ways like regular system\-provided units, either with full privileges or inside strict sandboxing, depending on the selected configuration\&. For more details, see
\m[blue]\fBPortable Services Documentation\fR\m[]\&\s-2\u[1]\d\s+2\&.
.PP
-Specifically portable service images may be of the following kind:
+Portable service images may be of the following kinds:
.sp
.RS 4
.ie n \{\
@@ -197,6 +197,18 @@ are passed, the portable services are immediately started (blocking operation un
\fB\-\-no\-block\fR
is passed) and/or enabled after attaching the image\&.
.sp
+In place of the image path a
+"\&.v/"
+versioned directory may be specified, see
+\fBsystemd.v\fR(7)
+for details\&.
+.sp
+In place of the directory path a
+"\&.v/"
+versioned directory may be specified, see
+\fBsystemd.v\fR(7)
+for details\&.
+.sp
Added in version 239\&.
.RE
.PP
@@ -209,14 +221,14 @@ command above, and removes the unit file copies, drop\-ins and image symlink aga
also to
\fBdetach\fR\&.
.sp
-Added in version 239\&.
-.PP
If
\fB\-\-now\fR
and/or
\fB\-\-enable\fR
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
\fBattach\fR\&.
+.sp
+Added in version 239\&.
.RE
.PP
\fBreattach\fR \fIIMAGE\fR [\fIPREFIX\&...\fR]
@@ -227,8 +239,6 @@ character has to match\&. If the new image doesn\*(Aqt exist, the existing one w
\fBattach\fR
command\&.
.sp
-Added in version 248\&.
-.PP
If
\fB\-\-now\fR
and/or
@@ -236,6 +246,8 @@ and/or
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
\fBattach\fR
case\&.
+.sp
+Added in version 248\&.
.RE
.PP
\fBinspect\fR \fIIMAGE\fR [\fIPREFIX\&...\fR]
@@ -359,7 +371,7 @@ Suppresses additional informational output while running\&.
Added in version 239\&.
.RE
.PP
-\fB\-p\fR \fIPROFILE\fR, \fB\-\-profile=\fR\fIPROFILE\fR
+\fB\-p\fR \fIPROFILE\fR, \fB\-\-profile=\fR\fB\fIPROFILE\fR\fR
.RS 4
When attaching an image, select the profile to use\&. By default the
"default"
@@ -372,11 +384,13 @@ Added in version 239\&.
.RS 4
When attaching an image, select whether to prefer copying or symlinking of files installed into the host system\&. Takes one of
"copy"
-(to prefer copying of files),
+(files will be copied),
"symlink"
-(to prefer creation of symbolic links) or
+(to prefer creation of symbolic links),
"auto"
-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 \(em for example when the image operated on is a raw disk image, and hence not directly referentiable from the host file system \(em copying of files is used unconditionally\&.
+for an intermediary mode where security profile drop\-ins and images are symlinked while unit files are copied, or
+"mixed"
+(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 \(em for example when the image operated on is a raw disk image, and hence not directly referentiable from the host file system \(em copying of files is used unconditionally\&.
.sp
Added in version 239\&.
.RE
@@ -428,7 +442,14 @@ Don\*(Aqt block waiting for attach \-\-now to complete\&.
Added in version 245\&.
.RE
.PP
-\fB\-\-extension=\fR\fIPATH\fR
+\fB\-\-clean\fR
+.RS 4
+When detaching ensure the configuration, state, logs, cache, and runtime data directories of the portable service are removed from the host system\&.
+.sp
+Added in version 256\&.
+.RE
+.PP
+\fB\-\-extension=\fR\fB\fIPATH\fR\fR
.RS 4
Add an additional image
\fIPATH\fR
@@ -440,7 +461,7 @@ for the
\fIExtensionImages=\fR
directive and for the
\fBsystemd-sysext\fR(8)
-and\&.
+and
\fBsystemd-confext\fR(8)
tools\&. The images must contain an
extension\-release
@@ -455,6 +476,18 @@ paragraph on
.sp
Note that the same extensions have to be specified, in the same order, when attaching and detaching\&.
.sp
+In place of the image path a
+"\&.v/"
+versioned directory may be specified, see
+\fBsystemd.v\fR(7)
+for details\&.
+.sp
+In place of the directory path a
+"\&.v/"
+versioned directory may be specified, see
+\fBsystemd.v\fR(7)
+for details\&.
+.sp
Added in version 249\&.
.RE
.PP
@@ -592,7 +625,7 @@ On success, 0 is returned, a non\-zero failure code otherwise\&.
.PP
\fI$SYSTEMD_LOG_LEVEL\fR
.RS 4
-The maximum log level of emitted messages (messages with a higher log level, i\&.e\&. less important ones, will be suppressed)\&. Either one of (in order of decreasing importance)
+The maximum log level of emitted messages (messages with a higher log level, i\&.e\&. less important ones, will be suppressed)\&. Takes a comma\-separated list of values\&. A value may be either one of (in order of decreasing importance)
\fBemerg\fR,
\fBalert\fR,
\fBcrit\fR,
@@ -602,7 +635,15 @@ The maximum log level of emitted messages (messages with a higher log level, i\&
\fBinfo\fR,
\fBdebug\fR, or an integer in the range 0\&...7\&. See
\fBsyslog\fR(3)
-for more information\&.
+for more information\&. Each value may optionally be prefixed with one of
+\fBconsole\fR,
+\fBsyslog\fR,
+\fBkmsg\fR
+or
+\fBjournal\fR
+followed by a colon to set the maximum log level for that specific log target (e\&.g\&.
+\fBSYSTEMD_LOG_LEVEL=debug,console:info\fR
+specifies to log at debug level except when logging to the console which should be at info level)\&. Note that the global maximum log level takes priority over any per target maximum log levels\&.
.RE
.PP
\fI$SYSTEMD_LOG_COLOR\fR
@@ -721,6 +762,12 @@ will be ignored by the executable, and needs to be handled by the pager\&.
This option instructs the pager to not send termcap initialization and deinitialization strings to the terminal\&. It is set by default to allow command output to remain visible in the terminal even after the pager exits\&. Nevertheless, this prevents some pager functionality from working, in particular paged output cannot be scrolled with the mouse\&.
.RE
.sp
+Note that setting the regular
+\fI$LESS\fR
+environment variable has no effect for
+\fBless\fR
+invocations by systemd tools\&.
+.sp
See
\fBless\fR(1)
for more discussion\&.
@@ -732,6 +779,12 @@ Override the charset passed to
\fBless\fR
(by default
"utf\-8", if the invoking terminal is determined to be UTF\-8 compatible)\&.
+.sp
+Note that setting the regular
+\fI$LESSCHARSET\fR
+environment variable has no effect for
+\fBless\fR
+invocations by systemd tools\&.
.RE
.PP
\fI$SYSTEMD_PAGERSECURE\fR
@@ -787,10 +840,7 @@ and other conditions\&.
.RE
.SH "SEE ALSO"
.PP
-\fBsystemd\fR(1),
-\fBsystemd-sysext\fR(8),
-\fBorg.freedesktop.portable1\fR(5),
-\fBsystemd-portabled.service\fR(8)
+\fBsystemd\fR(1), \fBsystemd-sysext\fR(8), \fBorg.freedesktop.portable1\fR(5), \fBsystemd-portabled.service\fR(8), \fBimportctl\fR(1)
.SH "NOTES"
.IP " 1." 4
Portable Services Documentation