summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/systemd-run.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man1/systemd-run.1')
-rw-r--r--upstream/debian-unstable/man1/systemd-run.195
1 files changed, 70 insertions, 25 deletions
diff --git a/upstream/debian-unstable/man1/systemd-run.1 b/upstream/debian-unstable/man1/systemd-run.1
index b2792c09..5d85f498 100644
--- a/upstream/debian-unstable/man1/systemd-run.1
+++ b/upstream/debian-unstable/man1/systemd-run.1
@@ -1,5 +1,5 @@
'\" t
-.TH "SYSTEMD\-RUN" "1" "" "systemd 255" "systemd-run"
+.TH "SYSTEMD\-RUN" "1" "" "systemd 256~rc3" "systemd-run"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -52,9 +52,10 @@ If a command is run as transient service unit, it will be started and managed by
like any other unit\&. It will run in a clean and detached execution environment, with the service manager as its parent process\&. In this mode,
\fBsystemd\-run\fR
will start the service asynchronously in the background and return after the command has begun execution (unless
-\fB\-\-no\-block\fR
-or
-\fB\-\-wait\fR
+\fB\-\-no\-block\fR,
+\fB\-\-wait\fR,
+\fB\-\-pipe\fR, or
+\fB\-\-pty\fR
are specified, see below)\&.
.PP
If a command is run as transient scope unit, it will be executed by
@@ -176,18 +177,22 @@ Make the new
\&.service
or
\&.scope
-unit part of the inherited slice\&. This option can be combined with
-\fB\-\-slice=\fR\&.
-.sp
-An inherited slice is located within
+unit part of the slice the
\fBsystemd\-run\fR
-slice\&. Example: if
+itself has been invoked in\&. This option may be combined with
+\fB\-\-slice=\fR, in which case the slice specified via
+\fB\-\-slice=\fR
+is placed within the slice the
\fBsystemd\-run\fR
-slice is
+command is invoked in\&.
+.sp
+Example: consider
+\fBsystemd\-run\fR
+being invoked in the slice
foo\&.slice, and the
\fB\-\-slice=\fR
argument is
-bar, the unit will be placed under the
+bar\&. The unit will then be placed under
foo\-bar\&.slice\&.
.sp
Added in version 246\&.
@@ -313,6 +318,14 @@ When invoking the command, the transient service connects its standard input, ou
\fBsystemd\-run\fR
is invoked on, via a pseudo TTY device\&. This allows running programs that expect interactive user input/output as services, such as interactive command shells\&.
.sp
+This option will result in
+\fBsystemd\-run\fR
+synchronously waiting for the transient service to terminate, similar to specifying
+\fB\-\-wait\fR\&. If specified along with
+\fB\-\-wait\fR,
+\fBsystemd\-run\fR
+won\*(Aqt exit when manually disconnecting from the pseudo TTY device\&.
+.sp
Note that
\fBmachinectl\fR(1)\*(Aqs
\fBshell\fR
@@ -330,7 +343,9 @@ If specified, standard input, output, and error of the transient service are inh
\fBsystemd\-run\fR
command itself\&. This allows
\fBsystemd\-run\fR
-to be used within shell pipelines\&. Note that this mode is not suitable for interactive command shells and similar, as the service process will not become a TTY controller when invoked on a terminal\&. Use
+to be used within shell pipelines\&.
+.sp
+Note that this mode is not suitable for interactive command shells and similar, as the service process will not become a TTY controller when invoked on a terminal\&. Use
\fB\-\-pty\fR
instead in that case\&.
.sp
@@ -343,12 +358,17 @@ are used in combination the more appropriate option is automatically determined
is used, and otherwise
\fB\-\-pipe\fR\&.
.sp
+This option will result in
+\fBsystemd\-run\fR
+synchronously waiting for the transient service to terminate, similar to specifying
+\fB\-\-wait\fR\&.
+.sp
When this option is used the original file descriptors
\fBsystemd\-run\fR
receives are passed to the service processes as\-is\&. If the service runs with different privileges than
-\fBsystemd\-run\fR, this means the service might not be able to re\-open the passed file descriptors, due to normal file descriptor access restrictions\&. If the invoked process is a shell script that uses the
+\fBsystemd\-run\fR, this means the service might not be able to reopen the passed file descriptors, due to normal file descriptor access restrictions\&. If the invoked process is a shell script that uses the
\fBecho "hello" >/dev/stderr\fR
-construct for writing messages to stderr, this might cause problems, as this only works if stderr can be re\-opened\&. To mitigate this use the construct
+construct for writing messages to stderr, this might cause problems, as this only works if stderr can be reopened\&. To mitigate this use the construct
\fBecho "hello" >&2\fR
instead, which is mostly equivalent and avoids this pitfall\&.
.sp
@@ -476,6 +496,28 @@ for further information\&.
Added in version 236\&.
.RE
.PP
+\fB\-\-ignore\-failure\fR
+.RS 4
+By default, if the specified command fails the invoked unit will be marked failed (though possibly still unloaded, see
+\fB\-\-collect=\fR, above), and this is reported in the logs\&. If this switch is specified this is suppressed and any non\-success exit status/code of the command is treated as success\&.
+.sp
+Added in version 256\&.
+.RE
+.PP
+\fB\-\-background=\fR\fB\fICOLOR\fR\fR
+.RS 4
+Change the terminal background color to the specified ANSI color as long as the session lasts\&. The color specified should be an ANSI X3\&.64 SGR background color, i\&.e\&. strings such as
+"40",
+"41", \&...,
+"47",
+"48;2;\&...",
+"48;5;\&..."\&. See
+\m[blue]\fBANSI Escape Code (Wikipedia)\fR\m[]\&\s-2\u[1]\d\s+2
+for details\&.
+.sp
+Added in version 256\&.
+.RE
+.PP
\fB\-\-user\fR
.RS 4
Talk to the service manager of the calling user, rather than the service manager of the system\&.
@@ -511,6 +553,13 @@ syntax is used either the left hand side or the right hand side may be omitted (
are implied\&.
.RE
.PP
+\fB\-C\fR, \fB\-\-capsule=\fR
+.RS 4
+Execute operation on a capsule\&. Specify a capsule name to connect to\&. See
+\fBcapsule@.service\fR(5)
+for details about capsules\&.
+.RE
+.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print a short help text and exit\&.
@@ -746,14 +795,10 @@ $ systemd\-run \-\-user \-\-wait \-p SuccessExitStatus=SIGUSR1 \-\-expand\-envir
Those three invocations will succeed, i\&.e\&. terminate with an exit code of 0\&.
.SH "SEE ALSO"
.PP
-\fBsystemd\fR(1),
-\fBsystemctl\fR(1),
-\fBsystemd.unit\fR(5),
-\fBsystemd.service\fR(5),
-\fBsystemd.scope\fR(5),
-\fBsystemd.slice\fR(5),
-\fBsystemd.exec\fR(5),
-\fBsystemd.resource-control\fR(5),
-\fBsystemd.timer\fR(5),
-\fBsystemd-mount\fR(1),
-\fBmachinectl\fR(1)
+\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd.unit\fR(5), \fBsystemd.service\fR(5), \fBsystemd.scope\fR(5), \fBsystemd.slice\fR(5), \fBsystemd.exec\fR(5), \fBsystemd.resource-control\fR(5), \fBsystemd.timer\fR(5), \fBsystemd-mount\fR(1), \fBmachinectl\fR(1), \fBrun0\fR(1)
+.SH "NOTES"
+.IP " 1." 4
+ANSI Escape Code (Wikipedia)
+.RS 4
+\%https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters
+.RE