Debian Codegraph @

upstream/debian-unstable/man8/systemd-factory-reset.8

raw
1 '\" t
2 .TH "SYSTEMD\-FACTORY\-RESET" "8" "" "systemd 261~rc3" "systemd-factory-reset"
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-factory-reset, systemd-factory-reset-request.service, systemd-factory-reset-complete.service, systemd-factory-reset.socket, [email protected] \- Request or complete a factory reset operation, or query current factory reset mode
24 .SH "SYNOPSIS"
25 .PP
26 /usr/lib/systemd/systemd\-factory\-reset
27 .PP
28 systemd\-factory\-reset\-request\&.service
29 .PP
30 systemd\-factory\-reset\-complete\&.service
31 .PP
32 systemd\-factory\-reset\&.socket
33 .PP
34 systemd\-factory\-reset@\&.service
35 .SH "DESCRIPTION"
36 .PP
37 systemd\-factory\-reset
38 is a tool that can query the current factory reset state, request factory request operations or complete them\&.
39 .PP
40 Some of the functionality is also available via the
41 /run/systemd/io\&.systemd\&.FactoryReset
42 Varlink service (implemented via the
43 systemd\-factory\-reset\&.socket/systemd\-factory\-reset@\&.service
44 units)\&.
45 .PP
46 See
47 \m[blue]\fBFactory Reset\fR\m[]\&\s-2\u[1]\d\s+2
48 for an overview of the factory reset logic\&.
49 .SH "COMMANDS"
50 .PP
51 The
52 /usr/lib/systemd/systemd\-factory\-reset
53 executable may also be invoked from the command line, taking one of the following command arguments:
54 .PP
55 \fBstatus\fR
56 .RS 4
57 Report current factory reset state\&. Reports one of
58 "unsupported"
59 (if the OS does not support a factory reset logic),
60 "unspecified"
61 (if no factory reset was requested, but it wasn\*(Aqt turned off explicitly either),
62 "off"
63 (if the factory reset logic was explicitly turned off via the kernel command line option),
64 "on"
65 (if the factory reset is currently enabled and executed),
66 "complete"
67 (if the factory reset logic ran during the current boot but is complete now),
68 "pending"
69 (if a factory reset has been requested for the next boot)\&.
70 .sp
71 Returns with an exit status of 0 if the factory reset mechanism is currently not in effect, 10 if a factory reset is currently being executed, or 11 if it is pending for the next boot\&.
72 .sp
73 Added in version 258\&.
74 .RE
75 .PP
76 \fBrequest\fR
77 .RS 4
78 Request a factory reset operation to be executed on next boot\&.
79 .sp
80 Note that this is a relatively low\-level operation\&. The primary interface for requesting a factory reset operation is by starting the
81 factory\-reset\&.target
82 unit\&.
83 .sp
84 This sets the
85 \fIFactoryResetRequest\fR
86 EFI variable, see below\&.
87 .sp
88 This operation is executed when the
89 systemd\-factory\-reset\-request\&.service
90 unit is started (which is typically one of the services hooked into and ordered before
91 factory\-reset\&.target)\&.
92 .sp
93 Added in version 258\&.
94 .RE
95 .PP
96 \fBcancel\fR
97 .RS 4
98 Cancel any previously requested (but not yet executed) factory reset operation\&.
99 .sp
100 Added in version 258\&.
101 .RE
102 .PP
103 \fBcomplete\fR
104 .RS 4
105 Mark an ongoing factory reset operation as complete\&.
106 .sp
107 This operation is executed when the
108 systemd\-factory\-reset\-complete\&.service
109 unit is started (which is typically one of the services hooked into and ordered after
110 factory\-reset\-now\&.target)\&.
111 .sp
112 Added in version 258\&.
113 .RE
114 .SH "OPTIONS"
115 .PP
116 The following options are understood:
117 .PP
118 \fB\-\-retrigger\fR
119 .RS 4
120 When used with the
121 \fBcomplete\fR
122 command retriggers all block devices, which might result in auto\-discovered devices being usable that previously weren\*(Aqt because the factory reset logic was in place\&.
123 .sp
124 Added in version 258\&.
125 .RE
126 .PP
127 \fB\-\-quiet\fR, \fB\-q\fR
128 .RS 4
129 Suppresses the state output of
130 \fBstatus\fR, but still sets the exit status as documented\&.
131 .sp
132 Added in version 258\&.
133 .RE
134 .PP
135 \fB\-h\fR, \fB\-\-help\fR
136 .RS 4
137 Print a short help text and exit\&.
138 .RE
139 .PP
140 \fB\-\-version\fR
141 .RS 4
142 Print a short version string and exit\&.
143 .RE
144 .SH "EFI VARIABLES"
145 .PP
146 The following EFI variable is set and read by
147 \fBsystemd\-factory\-reset\fR, under the vendor UUID
148 "8cf2644b\-4b0b\-428f\-9387\-6d876050dc67", for communication between this boot and the next\&.
149 .PP
150 \fIFactoryResetRequest\fR
151 .RS 4
152 Set whenever a factory reset is requested from the next boot, deleted once the factory reset is complete\&. Contains JSON data describing the requesting OS, in order to avoid confusion in multi\-boot systems\&.
153 .sp
154 Added in version 258\&.
155 .RE
156 .SH "SEE ALSO"
157 .PP
158 \fBsystemd\fR(1), \fBsystemd-factory-reset-generator\fR(8), \fBsystemd.special\fR(7), \m[blue]\fBFactory Reset\fR\m[]\&\s-2\u[1]\d\s+2
159 .SH "NOTES"
160 .IP " 1." 4
161 Factory Reset
162 .RS 4
163 \%https://systemd.io/FACTORY_RESET
164 .RE