summaryrefslogtreecommitdiffstats
path: root/upstream/fedora-rawhide/man1/systemd.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-17 10:51:52 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-17 10:51:52 +0000
commit4ad94864781f48b1a4b77f9cfb934622bf756ba1 (patch)
tree3900955c1886e6d2570fea7125ee1f01bafe876d /upstream/fedora-rawhide/man1/systemd.1
parentAdding upstream version 4.22.0. (diff)
downloadmanpages-l10n-4ad94864781f48b1a4b77f9cfb934622bf756ba1.tar.xz
manpages-l10n-4ad94864781f48b1a4b77f9cfb934622bf756ba1.zip
Adding upstream version 4.23.0.upstream/4.23.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/fedora-rawhide/man1/systemd.1')
-rw-r--r--upstream/fedora-rawhide/man1/systemd.1234
1 files changed, 200 insertions, 34 deletions
diff --git a/upstream/fedora-rawhide/man1/systemd.1 b/upstream/fedora-rawhide/man1/systemd.1
index 24ba6297..410c1617 100644
--- a/upstream/fedora-rawhide/man1/systemd.1
+++ b/upstream/fedora-rawhide/man1/systemd.1
@@ -1,5 +1,5 @@
'\" t
-.TH "SYSTEMD" "1" "" "systemd 255" "systemd"
+.TH "SYSTEMD" "1" "" "systemd 256~rc3" "systemd"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -394,6 +394,12 @@ The location of the SysV runlevel link farm directory varies between distributio
.RE
.SH "SIGNALS"
.PP
+The service listens to various UNIX process signals that can be used to request various actions asynchronously\&. The signal handling is enabled very early during boot, before any further processes are invoked\&. However, a supervising container manager or similar that intends to request these operations via this mechanism must take into consideration that this functionality is not available during the earliest initialization phase\&. An
+\fBsd_notify()\fR
+notification message carrying the
+\fIX_SYSTEMD_SIGNALS_LEVEL=2\fR
+field is emitted once the signal handlers are enabled, see below\&. This may be used to schedule submission of these signals correctly\&.
+.PP
\fBSIGTERM\fR
.RS 4
Upon receiving this signal the systemd system manager serializes its state, reexecutes itself and deserializes the saved state again\&. This is mostly equivalent to
@@ -657,7 +663,7 @@ Some of the variables understood by
.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,
@@ -667,7 +673,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\&.
.sp
This can be overridden with
\fB\-\-log\-level=\fR\&.
@@ -809,6 +823,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\&.
@@ -820,6 +840,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
@@ -883,9 +909,9 @@ for more information\&.
.PP
\fI$NOTIFY_SOCKET\fR
.RS 4
-Set by systemd for supervised processes for status and start\-up completion notification\&. See
+Set by service manager for its services for status and readiness notifications\&. Also consumed by service manager for notifying supervising container managers or service managers up the stack about its own progress\&. See
\fBsd_notify\fR(3)
-for more information\&.
+and the relevant section below for more information\&.
.RE
.PP
For further environment variables understood by systemd and its various components, see
@@ -940,12 +966,20 @@ Takes a boolean argument or enables the option if specified without an argument\
Added in version 233\&.
.RE
.PP
-\fIsystemd\&.crash_reboot\fR
+\fIsystemd\&.crash_action=\fR
.RS 4
-Takes a boolean argument or enables the option if specified without an argument\&. If enabled, the system manager (PID 1) will reboot the machine automatically when it crashes, after a 10s delay\&. Otherwise, the system will hang indefinitely\&. Defaults to disabled, in order to avoid a reboot loop\&. If combined with
-\fIsystemd\&.crash_shell\fR, the system is rebooted after the shell exits\&.
+Takes one of
+"freeze",
+"reboot"
+or
+"poweroff"\&. Defaults to
+"freeze"\&. If set to
+"freeze", the system will hang indefinitely when the system manager (PID 1) crashes\&. If set to
+"reboot", the system manager (PID 1) will reboot the machine automatically when it crashes, after a 10s delay\&. If set to
+"poweroff", the system manager (PID 1) will power off the machine immediately when it crashes\&. If combined with
+\fIsystemd\&.crash_shell\fR, the configured crash action is executed after the shell exits\&.
.sp
-Added in version 227\&.
+Added in version 256\&.
.RE
.PP
\fIsystemd\&.confirm_spawn\fR
@@ -1247,19 +1281,26 @@ or
\fBAF_UNIX\fR
address where to send a
\fBREADY=1\fR
-notification datagram when the system has finished booting\&. See
+notification message when the service manager has completed booting\&. See
\fBsd_notify\fR(3)
-for more information\&. Note that in case the hypervisor does not support
+and the next section for more information\&. Note that in case the hypervisor does not support
\fBSOCK_DGRAM\fR
over
\fBAF_VSOCK\fR,
\fBSOCK_SEQPACKET\fR
will be tried instead\&. The credential payload for
\fBAF_VSOCK\fR
-should be in the form
+should be a string in the form
"vsock:CID:PORT"\&.
+"vsock\-stream",
+"vsock\-dgram"
+and
+"vsock\-seqpacket"
+can be used instead of
+"vsock"
+to force usage of the corresponding socket type\&.
.sp
-This feature is useful for hypervisors/VMMs or other processes on the host to receive a notification via VSOCK when a virtual machine has finished booting\&.
+This feature is useful for machine managers or other processes on the host to receive a notification via VSOCK when a virtual machine has finished booting\&.
.sp
Added in version 254\&.
.RE
@@ -1274,6 +1315,146 @@ for details\&.
.sp
Added in version 254\&.
.RE
+.PP
+For a list of system credentials various other components of systemd consume, see
+\fBsystemd.system-credentials\fR(7)\&.
+.SH "READINESS PROTOCOL"
+.PP
+The service manager implements a readiness notification protocol both between the manager and its services (i\&.e\&. down the stack), and between the manager and a potential supervisor further up the stack (the latter could be a machine or container manager, or in case of a per\-user service manager the system service manager instance)\&. The basic protocol (and the suggested API for it) is described in
+\fBsd_notify\fR(3)\&.
+.PP
+The notification socket the service manager (including PID 1) uses for reporting readiness to its own supervisor is set via the usual
+\fI$NOTIFY_SOCKET\fR
+environment variable (see above)\&. Since this is directly settable only for container managers and for the per\-user instance of the service manager, an additional mechanism to configure this is available, in particular intended for use in VM environments: the
+\fIvmm\&.notify_socket\fR
+system credential (see above) may be set to a suitable socket (typically an
+\fBAF_VSOCK\fR
+one) via SMBIOS Type 11 vendor strings\&. For details see above\&.
+.PP
+The notification protocol from the service manager up the stack towards a supervisor supports a number of extension fields that allow a supervisor to learn about specific properties of the system and track its boot progress\&. Specifically the following fields are sent:
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+An
+\fIX_SYSTEMD_HOSTNAME=\&...\fR
+message will be sent out once the initial hostname for the system has been determined\&. Note that during later runtime the hostname might be changed again programmatically, and (currently) no further notifications are sent out in that case\&.
+.sp
+Added in version 256\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+An
+\fIX_SYSTEMD_MACHINE_ID=\&...\fR
+message will be sent out once the machine ID of the system has been determined\&. See
+\fBmachine-id\fR(5)
+for details\&.
+.sp
+Added in version 256\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+An
+\fIX_SYSTEMD_SIGNALS_LEVEL=\&...\fR
+message will be sent out once the service manager installed the various UNIX process signal handlers described above\&. The field\*(Aqs value is an unsigned integer formatted as decimal string, and indicates the supported UNIX process signal feature level of the service manager\&. Currently, only a single feature level is defined:
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fIX_SYSTEMD_SIGNALS_LEVEL=2\fR
+covers the various UNIX process signals documented above \(en which are a superset of those supported by the historical SysV init system\&.
+.RE
+.sp
+Signals sent to PID 1 before this message is sent might not be handled correctly yet\&. A consumer of these messages should parse the value as an unsigned integer indication the level of support\&. For now only the mentioned level 2 is defined, but later on additional levels might be defined with higher integers, that will implement a superset of the currently defined behaviour\&.
+.sp
+Added in version 256\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fIX_SYSTEMD_UNIT_ACTIVE=\&...\fR
+and
+\fIX_SYSTEMD_UNIT_INACTIVE=\&...\fR
+messages will be sent out for each target unit as it becomes active or stops being active\&. This is useful to track boot progress and functionality\&. For example, once the
+ssh\-access\&.target
+unit is reported started SSH access is typically available, see
+\fBsystemd.special\fR(7)
+for details\&.
+.sp
+Added in version 256\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+An
+\fIX_SYSTEMD_SHUTDOWN=\&...\fR
+message will be sent out very shortly before the system shuts down\&. The value is one of the strings
+"reboot",
+"halt",
+"poweroff",
+"kexec"
+and indicates which kind of shutdown is being executed\&.
+.sp
+Added in version 256\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+An
+\fIX_SYSTEMD_REBOOT_PARAMETER=\&...\fR
+message will also be sent out very shortly before the system shuts down\&. Its value is the reboot argument as configured with
+\fBsystemctl \-\-reboot\-argument=\&...\fR\&.
+.sp
+Added in version 256\&.
+.RE
+.PP
+Note that these extension fields are sent in addition to the regular
+"READY=1"
+and
+"RELOADING=1"
+notifications\&.
.SH "OPTIONS"
.PP
\fBsystemd\fR
@@ -1355,7 +1536,7 @@ Enable core dumping on crash\&. This switch has no effect when running as user i
above\&.
.RE
.PP
-\fB\-\-crash\-vt=\fR\fIVT\fR
+\fB\-\-crash\-vt=\fR\fB\fIVT\fR\fR
.RS 4
Switch to a specific virtual console (VT) on crash\&. This switch has no effect when running as user instance\&. Same as
\fIsystemd\&.crash_chvt=\fR
@@ -1371,13 +1552,13 @@ Run a shell on crash\&. This switch has no effect when running as user instance\
above\&.
.RE
.PP
-\fB\-\-crash\-reboot\fR
+\fB\-\-crash\-action=\fR
.RS 4
-Automatically reboot the system on crash\&. This switch has no effect when running as user instance\&. See
-\fIsystemd\&.crash_reboot\fR
+Specify what to do when the system manager (PID 1) crashes\&. This switch has no effect when systemd is running as user instance\&. See
+\fIsystemd\&.crash_action=\fR
above\&.
.sp
-Added in version 227\&.
+Added in version 256\&.
.RE
.PP
\fB\-\-confirm\-spawn\fR
@@ -1502,22 +1683,7 @@ Added in version 252\&.
.RE
.SH "SEE ALSO"
.PP
-The
-\m[blue]\fBsystemd Homepage\fR\m[]\&\s-2\u[9]\d\s+2,
-\fBsystemd-system.conf\fR(5),
-\fBlocale.conf\fR(5),
-\fBsystemctl\fR(1),
-\fBjournalctl\fR(1),
-\fBsystemd-notify\fR(1),
-\fBdaemon\fR(7),
-\fBsd-daemon\fR(3),
-\fBorg.freedesktop.systemd1\fR(5),
-\fBsystemd.unit\fR(5),
-\fBsystemd.special\fR(7),
-\fBpkg-config\fR(1),
-\fBkernel-command-line\fR(7),
-\fBbootup\fR(7),
-\fBsystemd.directives\fR(7)
+The \m[blue]\fBsystemd Homepage\fR\m[]\&\s-2\u[9]\d\s+2, \fBsystemd-system.conf\fR(5), \fBlocale.conf\fR(5), \fBsystemctl\fR(1), \fBjournalctl\fR(1), \fBsystemd-notify\fR(1), \fBdaemon\fR(7), \fBsd-daemon\fR(3), \fBorg.freedesktop.systemd1\fR(5), \fBsystemd.unit\fR(5), \fBsystemd.special\fR(7), \fBpkg-config\fR(1), \fBkernel-command-line\fR(7), \fBbootup\fR(7), \fBsystemd.directives\fR(7)
.SH "NOTES"
.IP " 1." 4
Control Groups v2