~nabijaczleweli/klapki

97aaf68550cbbff2bd8cf3d66ff0e60d074fa7a4 — наб a month ago 99f8c8f
Proof klapki.8
1 files changed, 29 insertions(+), 28 deletions(-)

M man/klapki.8
M man/klapki.8 => man/klapki.8 +29 -28
@@ 17,7 17,7 @@ This command-line interface is based on running a set of operations
.Pq see Sx OPS
which modify the state and context, then settling the new set-up, then committing it;
this means that, barring I/O errors,
.Bro Cm dump Brc Ns ing
.Cm dump Ns ing
after the last operation with
.Fl n
is an accurate representation of what would be committed without it.


@@ 53,7 53,7 @@ Verbose operation.
.
.It Fl V
Very verbose \(em adds a
.Brq Cm dump
.Cm dump
.Cm op
in-between each specified
.Cm op .


@@ 79,15 79,14 @@ and ops
.Sh ENVIRONMENT
.Bl -tag -compact -width "KLAPKI_EFI_ROOT"
.It Ev KLAPKI_HOST
By default,
.Nm
uses the value found in
Overrides
.Nm klapi Ns 's
host identifier.
By default, the value found in
.Pa /etc/machine-id
(or, failing that, the current hostname)
as the identifier for the host.
(or, failing that, the current hostname) is used.
.Pp
If this environment variable is present, it will be used instead;
note, that the host identifier is used verbatim as an EFI variable name under
Note, that the host identifier is used verbatim as an EFI variable name under
.Nm Ns 's
GUID
.Pq Li a8a9ad3a-f831-11ea-946d-674ccd7415cc .


@@ 137,10 136,10 @@ Change the boot position to
.Pp
The cluster of entries for the current host can be placed at any point in the boot order; it's
.Sy 0
(i.e. at the beginning) by default, but if you have another operating system or boot-loader and wish to have it be the default,
(at the beginning) by default, but if you have another operating system or boot-loader and wish to have it be the default,
you can simply move
.Nm
down the required amount of entries.
down the required number of entries.
.Pp
See description of
.Cm addvariant


@@ 185,8 184,8 @@ Add an explicit
to the end, if not already known.
Accompanying boot entries will be allocated in the derivation phase as needed.
.Pp
Variants are a global property, and a boot entry is generated for each variant
(that is: for the implicit variant, represented by the empty string, in addition to any configured explicit variants).
Variants are a global property, and each kernel has a boot entry generated for each variant
(that is: for the implicit variant, represented by the empty string, plus for any configured explicit variants).
.Pp
The order of explicit variants is preserved within each version group, which are sorted highest-to-lowest.
For example: a host with two kernels


@@ 269,9 268,9 @@ is used to signal an error in executing the wisdom binary.
Additional
.Cm initrd=
statements
.Ar should
.Em should
work
(with warnings, since the should.
(with warnings, hence the should.
Please report on the bug tracker/mailing list
.Pq see Sx REPORTING BUGS
if you use them successfully!) and will not be managed by


@@ 309,7 308,7 @@ under
.Pq Li a8a9ad3a-f831-11ea-946d-674ccd7415cc .
This will purge the state for the host, and, hence, abandon any entries left over, which remain bootable;
to remove all klapki entries run
.Brq Cm delkernel
.Cm delkernel
first
.Pq see Sx OPS ,
or remove them manually from the ESP and firmware afterward.


@@ 319,30 318,32 @@ Under Linux this involves running
then
.Nm rm
on
.Pq Pa /sys/firmware/efi/efivars/ Ns Ev KLAPKI_HOST Ns Li -a8a9ad3a-f831-11ea-946d-674ccd7415cc .
.Pq Pa /sys/firmware/efi/efivars/ Ns Ev $KLAPKI_HOST Ns Li -a8a9ad3a-f831-11ea-946d-674ccd7415cc .
.
.Sh EXIT STATUS
.Bl -tag -compact -width "AA"
.It Sy 0
success in all steps
.It Sy 1
error reading configuration,
error reading configuration
.It Sy 2
error loading state,
error loading state
.It Sy 3
error resolving state,
error resolving state
.It Sy 4
error running an op,
error running an op
.It Sy 5
error in propagation phase,
error in propagation phase
.It Sy 6
error in aging phase,
error in aging phase
.It Sy 7
error in wisening phase,
error in wisening phase
.It Sy 8
error in saving phase,
error in saving phase
.It Sy 9
error committing context,
error committing context
.It Sy 10
error committing state.
error committing state
.El
.
.Sh EXAMPLES


@@ 414,7 415,7 @@ Updating state config
Updating entry 000D
.Ed
.Pp
Note, that, as expected, only the state configuration (which stores the hash of the wanted entry) and the debug entry itself was updated:
Note, that, as expected, only the state configuration (which stores the hash of the wanted entry) and the debug entry itself were updated:
.Bd -literal -compact -offset 4n
.Li # Nm efibootmgr Fl v
BootCurrent: 000D