Debian Codegraph @

upstream/debian-trixie/man8/systemd-debug-generator.8

raw
1 '\" t
2 .TH "SYSTEMD\-DEBUG\-GENERATOR" "8" "" "systemd 257.13" "systemd-debug-generator"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd-debug-generator \- Generator for enabling a runtime debug shell and masking specific units at boot
24 .SH "SYNOPSIS"
25 .PP
26 /usr/lib/systemd/system\-generators/systemd\-debug\-generator
27 .SH "DESCRIPTION"
28 .PP
29 systemd\-debug\-generator
30 is a generator that reads the kernel command line and understands three options:
31 .PP
32 If the
33 \fBsystemd\&.mask=\fR
34 or
35 \fBrd\&.systemd\&.mask=\fR
36 option is specified and followed by a unit name, this unit is masked for the runtime (i\&.e\&. for this session \(em from boot to shutdown), similarly to the effect of
37 \fBsystemctl\fR(1)\*(Aqs
38 \fBmask\fR
39 command\&. This is useful to boot with certain units removed from the initial boot transaction for debugging system startup\&. May be specified more than once\&.
40 \fBrd\&.systemd\&.mask=\fR
41 is honored only by initial RAM disk (initrd) while
42 \fBsystemd\&.mask=\fR
43 is honored only in the main system\&.
44 .PP
45 If the
46 \fBsystemd\&.wants=\fR
47 or
48 \fBrd\&.systemd\&.wants=\fR
49 option is specified and followed by a unit name, a start job for this unit is added to the initial transaction\&. This is useful to start one or more additional units at boot\&. May be specified more than once\&.
50 \fBrd\&.systemd\&.wants=\fR
51 is honored only by initial RAM disk (initrd) while
52 \fBsystemd\&.wants=\fR
53 is honored only in the main system\&.
54 .PP
55 If the
56 \fBsystemd\&.debug_shell\fR
57 or
58 \fBrd\&.systemd\&.debug_shell\fR
59 option is specified, the debug shell service
60 "debug\-shell\&.service"
61 is pulled into the boot transaction and a debug shell will be spawned during early boot\&. By default,
62 /dev/tty9
63 is used, but a specific tty can also be specified, either with or without the
64 /dev/
65 prefix\&. To set the tty to use without enabling the debug shell, the
66 \fBsystemd\&.default_debug_tty=\fR
67 option can be used which also takes a tty with or without the
68 /dev/
69 prefix\&. Note that the shell may also be turned on persistently by enabling it with
70 \fBsystemctl\fR(1)\*(Aqs
71 \fBenable\fR
72 command\&.
73 \fBrd\&.systemd\&.debug_shell\fR
74 is honored only by initial RAM disk (initrd) while
75 \fBsystemd\&.debug_shell\fR
76 is honored only in the main system\&.
77 .PP
78 systemd\-debug\-generator
79 implements
80 \fBsystemd.generator\fR(7)\&.
81 .SH "SYSTEM CREDENTIALS"
82 .PP
83 \fIsystemd\&.extra\-unit\&.*\fR
84 .RS 4
85 Credentials prefixed with
86 "systemd\&.extra\-unit\&."
87 specify additional units to add to the final system\&. Note that these additional units are added to both the initrd and the final system\&.
88 \fIConditionPathExists=!/etc/initrd\-release\fR
89 can be used to make sure the unit is conditioned out in the initrd\&. Note that this can also be used to mask units, by simply specifying an empty value\&.
90 .sp
91 Added in version 256\&.
92 .RE
93 .PP
94 \fIsystemd\&.unit\-dropin\&.*\fR
95 .RS 4
96 Credentials prefixed with
97 "systemd\&.unit\-dropin\&."
98 add drop\-ins for the corresponding units in the final system\&. Each credential must be suffixed with the full unit name including the unit extension\&. Its contents must be a valid unit drop\-in file\&. Optionally, the unit name may be followed with
99 "~", followed by the drop\-in name without the
100 "\&.conf"
101 suffix\&. If not specified, the name of the generated drop\-in will be
102 "50\-credential\&.conf"\&. Note that these additional drop\-ins are added to both the initrd and the final system\&.
103 .sp
104 Added in version 256\&.
105 .RE
106 .SH "SEE ALSO"
107 .PP
108 \fBsystemd\fR(1), \fBsystemctl\fR(1), \fBkernel-command-line\fR(7)