Debian Codegraph @

upstream/debian-unstable/man8/systemd-bless-boot.service.8

raw
1 '\" t
2 .TH "SYSTEMD\-BLESS\-BOOT\&.SERVICE" "8" "" "systemd 261~rc3" "systemd-bless-boot.service"
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-bless-boot.service, systemd-bless-boot \- Mark current boot process as successful
24 .SH "SYNOPSIS"
25 .PP
26 systemd\-bless\-boot\&.service
27 .PP
28 /usr/lib/systemd/systemd\-bless\-boot
29 .SH "DESCRIPTION"
30 .PP
31 systemd\-bless\-boot\&.service
32 is a system service that marks the current boot process as successful\&. It\*(Aqs automatically pulled into the initial transaction when
33 \fBsystemd-bless-boot-generator\fR(8)
34 detects that
35 \fBsystemd-boot\fR(7)
36 style boot counting is used\&.
37 .PP
38 Internally, the service operates based on the
39 \fILoaderBootCountPath\fR
40 EFI variable (of the vendor UUID
41 \fB4a67b082\-0a4c\-41cf\-b6c7\-440b29bb8c4f\fR), which is passed from the boot loader to the OS\&. It contains a file system path (relative to the EFI system partition) of the
42 \m[blue]\fBUAPI\&.1 Boot Loader Specification\fR\m[]\&\s-2\u[1]\d\s+2
43 compliant boot loader entry file or unified kernel image file that was used to boot up the system\&.
44 \fBsystemd\-bless\-boot\&.service\fR
45 removes the two "tries done" and "tries left" numeric boot counters from the filename, which indicates to future invocations of the boot loader that the entry has completed booting successfully at least once\&. (This service will hence rename the boot loader entry file or unified kernel image file on the first successful boot\&.)
46 .SH "OPTIONS"
47 .PP
48 The
49 /usr/lib/systemd/systemd\-bless\-boot
50 executable may also be invoked from the command line, taking one of the following command arguments:
51 .PP
52 \fBstatus\fR
53 .RS 4
54 The current status of the boot loader entry file or unified kernel image file is shown\&. This outputs one of
55 "good",
56 "bad",
57 "indeterminate",
58 "clean",
59 "dirty", depending on the state and previous invocations of the command\&. The string
60 "indeterminate"
61 is shown initially after boot, before it has been marked as "good" or "bad"\&. The string
62 "good"
63 is shown after the boot was marked as "good" with the
64 \fBgood\fR
65 command below, and "bad" conversely after the
66 \fBbad\fR
67 command was invoked\&. The string
68 "clean"
69 is returned when boot counting is currently not in effect (which includes the case where the current entry was already marked as persistently good)\&. The string
70 "dirty"
71 is returned when the system is booted up with a known\-bad kernel (i\&.e\&. one where the tries left counter has previously reached zero already)\&.
72 .sp
73 This command is implied if no command argument is specified\&.
74 .sp
75 Added in version 240\&.
76 .RE
77 .PP
78 \fBgood\fR
79 .RS 4
80 When invoked, the current boot loader entry file or unified kernel image file will be marked as "good", executing the file rename operation described above\&. This command is intended to be invoked at the end of a successful boot\&. The
81 systemd\-bless\-boot\&.service
82 unit invokes this command\&.
83 .sp
84 Added in version 240\&.
85 .RE
86 .PP
87 \fBbad\fR
88 .RS 4
89 When called the "tries left" counter in the boot loader entry file name or unified kernel image file name is set to zero, marking the boot loader entry or kernel image as "bad", so that the boot loader will not consider it anymore on future boots (at least as long as there are other entries available that are not marked "bad" yet)\&. This command is normally not executed, but can be used to instantly put an end to the boot counting logic if a problem is detected and persistently mark the boot entry as bad\&.
90 .sp
91 Added in version 240\&.
92 .RE
93 .PP
94 \fBindeterminate\fR
95 .RS 4
96 This command undoes any marking of the current boot loader entry file or unified kernel image file as good or bad\&. This is implemented by renaming the boot loader entry file or unified kernel image file back to the path encoded in the
97 \fILoaderBootCountPath\fR
98 EFI variable\&. Note that operation will fail if the current kernel is not booted with boot counting enabled (i\&.e\&. if the EFI variable is not set)\&. If the boot counter already reached zero tries left on a previous boot this operation will fail too: once an entry is marked
99 \fBbad\fR
100 it can only be reset to
101 \fBgood\fR
102 again, but not to
103 \fBindeterminate\fR\&.
104 .sp
105 Added in version 240\&.
106 .RE
107 .PP
108 \fB\-h\fR, \fB\-\-help\fR
109 .RS 4
110 Print a short help text and exit\&.
111 .RE
112 .PP
113 \fB\-\-version\fR
114 .RS 4
115 Print a short version string and exit\&.
116 .RE
117 .SH "SEE ALSO"
118 .PP
119 \fBsystemd\fR(1), \fBsystemd-boot\fR(7), \fBsystemd.special\fR(7)
120 .SH "NOTES"
121 .IP " 1." 4
122 UAPI.1 Boot Loader Specification
123 .RS 4
124 \%https://uapi-group.org/specifications/specs/boot_loader_specification
125 .RE