diff options
Diffstat (limited to 'upstream/opensuse-tumbleweed/man1/portablectl.1')
-rw-r--r-- | upstream/opensuse-tumbleweed/man1/portablectl.1 | 61 |
1 files changed, 57 insertions, 4 deletions
diff --git a/upstream/opensuse-tumbleweed/man1/portablectl.1 b/upstream/opensuse-tumbleweed/man1/portablectl.1 index a74fef62..661e0a00 100644 --- a/upstream/opensuse-tumbleweed/man1/portablectl.1 +++ b/upstream/opensuse-tumbleweed/man1/portablectl.1 @@ -1,5 +1,5 @@ '\" t -.TH "PORTABLECTL" "1" "" "systemd 254" "portablectl" +.TH "PORTABLECTL" "1" "" "systemd 255" "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 \{\ @@ -86,6 +86,8 @@ The following commands are understood: \fBlist\fR .RS 4 List available portable service images\&. This will list all portable service images discovered in the portable image search paths (see below), along with brief metadata and state information\&. Note that many of the commands below may both operate on images inside and outside of the search paths\&. This command is hence mostly a convenience option, the commands are generally not restricted to what this list shows\&. +.sp +Added in version 239\&. .RE .PP \fBattach\fR \fIIMAGE\fR [\fIPREFIX\&...\fR] @@ -194,6 +196,8 @@ and/or are passed, the portable services are immediately started (blocking operation unless \fB\-\-no\-block\fR is passed) and/or enabled after attaching the image\&. +.sp +Added in version 239\&. .RE .PP \fBdetach\fR \fIIMAGE\fR [\fIPREFIX\&...\fR] @@ -204,6 +208,8 @@ command above, and removes the unit file copies, drop\-ins and image symlink aga \fBattach\fR also to \fBdetach\fR\&. +.sp +Added in version 239\&. .PP If \fB\-\-now\fR @@ -220,6 +226,8 @@ Detaches an existing portable service image from the host, and immediately attac character has to match\&. If the new image doesn\*(Aqt exist, the existing one will not be detached\&. The parameters follow the same syntax as the \fBattach\fR command\&. +.sp +Added in version 248\&. .PP If \fB\-\-now\fR @@ -243,6 +251,8 @@ os\-release data and the units files\*(Aq contents is displayed unprocessed\&. This command is useful to determine whether an image qualifies as portable service image, and which unit files are included\&. This command expects the path to the image as parameter, optionally followed by a list of unit file prefixes to consider, similar to the \fBattach\fR command described above\&. +.sp +Added in version 239\&. .RE .PP \fBis\-attached\fR \fIIMAGE\fR @@ -309,16 +319,21 @@ The image is currently attached transiently, and at least one unit file associat T} .TE .sp 1 +Added in version 239\&. .RE .PP \fBread\-only\fR \fIIMAGE\fR [\fIBOOL\fR] .RS 4 Marks or (unmarks) a portable service image read\-only\&. Takes an image name, followed by a boolean as arguments\&. If the boolean is omitted, positive is implied, i\&.e\&. the image is marked read\-only\&. +.sp +Added in version 239\&. .RE .PP \fBremove\fR \fIIMAGE\fR\&... .RS 4 Removes one or more portable service images\&. Note that this command will only remove the specified image path itself \(em it refers to a symbolic link then the symbolic link is removed and not the image it points to\&. +.sp +Added in version 239\&. .RE .PP \fBset\-limit\fR [\fIIMAGE\fR] \fIBYTES\fR @@ -330,6 +345,8 @@ as size\&. Note that per\-image size limits are only supported on btrfs file systems\&. Also, depending on \fIBindPaths=\fR settings in the portable service\*(Aqs unit files directories from the host might be visible in the image environment during runtime which are not affected by this setting, as only the image itself is counted against this limit\&. +.sp +Added in version 239\&. .RE .SH "OPTIONS" .PP @@ -338,6 +355,8 @@ The following options are understood: \fB\-q\fR, \fB\-\-quiet\fR .RS 4 Suppresses additional informational output while running\&. +.sp +Added in version 239\&. .RE .PP \fB\-p\fR \fIPROFILE\fR, \fB\-\-profile=\fR\fIPROFILE\fR @@ -345,6 +364,8 @@ Suppresses additional informational output while running\&. When attaching an image, select the profile to use\&. By default the "default" profile is used\&. For details about profiles, see below\&. +.sp +Added in version 239\&. .RE .PP \fB\-\-copy=\fR @@ -356,6 +377,8 @@ When attaching an image, select whether to prefer copying or symlinking of files (to prefer creation of symbolic links) or "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\&. +.sp +Added in version 239\&. .RE .PP \fB\-\-runtime\fR @@ -364,11 +387,15 @@ When specified the unit and drop\-in files are placed in /run/systemd/system\&.attached/ instead of /etc/systemd/system\&.attached/\&. Images attached with this option set hence remain attached only until the next reboot, while they are normally attached persistently\&. +.sp +Added in version 239\&. .RE .PP \fB\-\-no\-reload\fR .RS 4 Don\*(Aqt reload the service manager after attaching or detaching a portable service image\&. Normally the service manager is reloaded to ensure it is aware of added or removed unit files\&. +.sp +Added in version 239\&. .RE .PP \fB\-\-cat\fR @@ -376,21 +403,29 @@ Don\*(Aqt reload the service manager after attaching or detaching a portable ser When inspecting portable service images, show the (unprocessed) contents of the metadata files pulled from the image, instead of brief summaries\&. Specifically, this will show the \fBos-release\fR(5) and unit file contents of the image\&. +.sp +Added in version 239\&. .RE .PP \fB\-\-enable\fR .RS 4 Immediately enable/disable the portable service after attaching/detaching\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-now\fR .RS 4 Immediately start/stop/restart the portable service after attaching/before detaching/after upgrading\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-no\-block\fR .RS 4 Don\*(Aqt block waiting for attach \-\-now to complete\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-extension=\fR\fIPATH\fR @@ -405,7 +440,9 @@ for the \fIExtensionImages=\fR directive and for the \fBsystemd-sysext\fR(8) -tool\&. The images must contain an +and +\fBsystemd-confext\fR(8) +tools\&. The images must contain an extension\-release file with metadata that matches what is defined in the os\-release @@ -417,6 +454,8 @@ paragraph on \m[blue]\fBPortable Services Documentation\fR\m[]\&\s-2\u[1]\d\s+2\&. .sp Note that the same extensions have to be specified, in the same order, when attaching and detaching\&. +.sp +Added in version 249\&. .RE .PP \fB\-\-force\fR @@ -424,6 +463,8 @@ Note that the same extensions have to be specified, in the same order, when atta Skip safety checks and attach or detach images (with extensions) without first ensuring that the units are not running, and do not insist that the extension\-release\&.\fINAME\fR file in the extension image has to match the image filename\&. +.sp +Added in version 252\&. .RE .PP \fB\-H\fR, \fB\-\-host=\fR @@ -680,6 +721,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\&. @@ -691,6 +738,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 |