Debian Codegraph @

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

raw
1 '\" t
2 .TH "SYSTEMD\-DEBUG\-GENERATOR" "8" "" "systemd 261~rc3" "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 \fBsystemd\-debug\-generator\fR
30 is a generator that provides some debugging functionality\&.
31 .PP
32 \fBsystemd\-debug\-generator\fR
33 implements
34 \fBsystemd.generator\fR(7)\&.
35 .SH "KERNEL COMMAND LINE"
36 .PP
37 \fBsystemd\-debug\-generator\fR
38 understands the following kernel command line parameters:
39 .PP
40 \fIsystemd\&.mask=\fR, \fIrd\&.systemd\&.mask=\fR
41 .RS 4
42 These options take a unit name as argument\&. The unit specified is masked for the runtime (i\&.e\&. for this session \(em from boot to shutdown), similarly to the effect of
43 \fBsystemctl\fR(1)\*(Aqs
44 \fBmask\fR
45 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\&. The option prefixed with
46 "rd\&."
47 is honored only in the initrd, while the one without prefix is only honored on the host\&.
48 .sp
49 Added in version 215\&.
50 .RE
51 .PP
52 \fIsystemd\&.wants=\fR, \fIrd\&.systemd\&.wants=\fR
53 .RS 4
54 These options take a unit name as argument\&. 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\&. The option prefixed with
55 "rd\&."
56 is honored only in the initrd, while the one that is not prefixed only on the host\&.
57 .sp
58 Added in version 215\&.
59 .RE
60 .PP
61 \fIsystemd\&.debug_shell\fR, \fIrd\&.systemd\&.debug_shell\fR, \fIsystemd\&.default_debug_tty=\fR, \fIrd\&.systemd\&.default_debug_tty=\fR
62 .RS 4
63 If the
64 \fBsystemd\&.debug_shell\fR
65 or
66 \fBrd\&.systemd\&.debug_shell\fR
67 option is specified, the debug shell service
68 "debug\-shell\&.service"
69 is pulled into the boot transaction and a debug shell will be spawned during early boot\&. By default,
70 /dev/tty9
71 is used, but a specific tty can also be specified, either with or without the
72 /dev/
73 prefix\&. To set the tty to use without enabling the debug shell, the
74 \fBsystemd\&.default_debug_tty=\fR
75 option can be used which also takes a tty with or without the
76 /dev/
77 prefix\&. Note that the shell may also be turned on persistently by enabling it with
78 \fBsystemctl\fR(1)\*(Aqs
79 \fBenable\fR
80 command\&. The options prefixed with
81 "rd\&."
82 are honored only in the initrd, while the ones without prefix are only honored on the host\&.
83 .sp
84 Added in version 215\&.
85 .RE
86 .PP
87 \fIsystemd\&.break=\fR, \fIrd\&.systemd\&.break=\fR
88 .RS 4
89 Takes one of
90 \fBpre\-udev\fR,
91 \fBpre\-basic\fR,
92 \fBpre\-mount\fR, or
93 \fBpre\-switch\-root\fR
94 (the default for the
95 "rd\&."
96 option)\&. It also accepts multiple values separated by comma (",")\&. These options allow one to pause the boot process at a certain point and spawn a debug shell\&. After exiting this shell, the system will resume booting\&. The option prefixed with
97 "rd\&."
98 is honored only in the initrd, while the one without prefix is only honored on the host\&.
99 .sp
100 .it 1 an-trap
101 .nr an-no-space-flag 1
102 .nr an-break-flag 1
103 .br
104 .B Table\ \&1.\ \&Available breakpoints
105 .TS
106 allbox tab(:);
107 lB lB lB lB.
108 T{
109 Breakpoints
110 T}:T{
111 Description
112 T}:T{
113 Can be used in the initrd
114 T}:T{
115 Can be used on the host
116 T}
117 .T&
118 l l l l
119 l l l l
120 l l l l
121 l l l l.
122 T{
123 \fBpre\-udev\fR
124 T}:T{
125 Before starting to process kernel uevents, i\&.e\&., before systemd\-udevd\&.service starts\&.
126 T}:T{
127 ✓
128 T}:T{
129 ✓
130 T}
131 T{
132 \fBpre\-basic\fR
133 T}:T{
134 Before leaving early boot and regular services start, i\&.e\&., before basic\&.target is reached\&.
135 T}:T{
136 ✓
137 T}:T{
138 ✓
139 T}
140 T{
141 \fBpre\-mount\fR
142 T}:T{
143 Before the root filesystem is mounted, i\&.e\&., before sysroot\&.mount starts\&.
144 T}:T{
145 ✓
146 T}:T{
147 ✗
148 T}
149 T{
150 \fBpre\-switch\-root\fR
151 T}:T{
152 Before switching from the initrd to the real root\&.
153 T}:T{
154 ✓
155 T}:T{
156 ✗
157 T}
158 .TE
159 .sp 1
160 Added in version 258\&.
161 .RE
162 .SH "SYSTEM CREDENTIALS"
163 .PP
164 \fIsystemd\&.extra\-unit\&.*\fR
165 .RS 4
166 Credentials prefixed with
167 "systemd\&.extra\-unit\&."
168 specify additional units to add to the final system\&. Note that these additional units are added to both the initrd and the final system\&.
169 \fIConditionPathExists=!/etc/initrd\-release\fR
170 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\&.
171 .sp
172 Added in version 256\&.
173 .RE
174 .PP
175 \fIsystemd\&.unit\-dropin\&.*\fR
176 .RS 4
177 Credentials prefixed with
178 "systemd\&.unit\-dropin\&."
179 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
180 "~", followed by the drop\-in name without the
181 "\&.conf"
182 suffix\&. If not specified, the name of the generated drop\-in will be
183 "50\-credential\&.conf"\&. Note that these additional drop\-ins are added to both the initrd and the final system\&.
184 .sp
185 Added in version 256\&.
186 .RE
187 .SH "SEE ALSO"
188 .PP
189 \fBsystemd\fR(1), \fBsystemctl\fR(1), \fBkernel-command-line\fR(7), \fBsystemd.system-credentials\fR(7), \fBbootup\fR(7)