~nabijaczleweli/klapki

6210471b77c048dfd319ff4e4d8ff521c36ad5ce — наб autouploader 5 months ago f1a7e2d
Manpage update by job 309205
5 files changed, 36 insertions(+), 8 deletions(-)

M index.txt
M klapki.8
M klapki.8.html
M klapki.8.html_fragment
M klapki.md
M index.txt => index.txt +0 -1
@@ 2,7 2,6 @@ klapki(8)          klapki.8.ronn

SHA1(3ssl)         https://manpages.debian.org/buster/libssl-doc/SHA1.3ssl.en.html
efibootmgr(8)      https://manpages.debian.org/buster/efibootmgr/efibootmgr.8.en.html
efivar(1)          https://manpages.debian.org/buster/efivar/efivar.1.en.html
execl(3)           https://manpages.debian.org/buster/manpages-dev/execl.3.en.html
gethostname(2)     https://manpages.debian.org/buster/manpages-dev/gethostname.2.en.html
memfd_create(2)    https://manpages.debian.org/buster/manpages-dev/memfd_create.2.en.html

M klapki.8 => klapki.8 +5 -1
@@ 12,7 12,7 @@ This command\-line interface is based on running a set of operations (see \fIOPS
.P
Care is taken to only write what is needed and only when it\'s needed – files and wanted entries are hashed with SHA1(3ssl) and only updated on mismatch; foreign entries are never touched, and klapki(8) prefers to abandon entries it doesn\'t understand than to accidentally mangle them\.
.P
Minimal state is stored, and it\'s only supplementary\. This means that removing all instances of a kernel boot entry with tools such as efibootmgr(8), efivar(1), or the platform UI will make klapki(8) forget about the kernel entirely, after minor complaints\.
Minimal state is stored, and it\'s only supplementary (see \fIUNINSTALLATION\fR)\. This means that removing all instances of a kernel boot entry with tools such as efibootmgr(8), the EFI Shell, or the platform UI will make klapki(8) forget about the kernel entirely, after minor complaints\.
.P
klapki(8)\'s entries \fIcan\fR be moved across \fBBootNNNN\fR entries, however, so long as they are kept identical\.
.P


@@ 133,6 133,10 @@ klapki(8) stops processing if the child exits with a non\-zero status or is kill
Additional \fBinitrd=\fR statements \fIshould\fR work (with warnings, since the should\. Please report on the bug tracker/mailing list (see \fIREPORTING BUGS\fR) if you use them successfully!) and will not be managed by klapki(8),
.P
The simplest \fB/etc/klapki/description\fR would be a link to \fB/bin/echo\fR\. A simple \fBcmdline\fR is a \fB/bin/sh\fR shebang + \fBecho\fR command\. A cursed \fBcmdline\fR would be a \fB/bin/sh\fR shebang and an \fBawk \'{gsub(/initrd=[^ ]+ ?/, ""); print}\' /proc/cmdline\fR command\.
.SH "UNINSTALLATION"
Remove the EFI variable corresponding to the host (see \fIENVIRONMENT\fR) under klapki\'s GUID (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 \fB{delkernel}\fR first (see \fIOPS\fR), or remove them manually from the ESP and firmware afterward\.
.P
On Linux this involves running \fBchattr \-i\fR, then \fBrm\fR on \fB/sys/firmware/efi/efivars/{KLAPKI_HOST}\-a8a9ad3a\-f831\-11ea\-946d\-674ccd7415cc\fR\.
.SH "EXIT VALUES"
.nf
1 \- error reading configuration,

M klapki.8.html => klapki.8.html +11 -2
@@ 60,6 60,7 @@
    <a href="#ENVIRONMENT">ENVIRONMENT</a>
    <a href="#OPS">OPS</a>
    <a href="#WISDOM">WISDOM</a>
    <a href="#UNINSTALLATION">UNINSTALLATION</a>
    <a href="#EXIT-VALUES">EXIT VALUES</a>
    <a href="#EXAMPLES">EXAMPLES</a>
    <a href="#AUTHOR">AUTHOR</a>


@@ 96,8 97,8 @@ then settling the new set-up, then committing it; this means that, barring I/O e
files and wanted entries are hashed with <a class="man-ref" href="https://manpages.debian.org/buster/libssl-doc/SHA1.3ssl.en.html">SHA1<span class="s">(3ssl)</span></a> and only updated on mismatch;
foreign entries are never touched, and <a class="man-ref" href="klapki.8.html">klapki<span class="s">(8)</span></a> prefers to abandon entries it doesn't understand than to accidentally mangle them.</p>

<p>Minimal state is stored, and it's only supplementary.
This means that removing all instances of a kernel boot entry with tools such as <a class="man-ref" href="https://manpages.debian.org/buster/efibootmgr/efibootmgr.8.en.html">efibootmgr<span class="s">(8)</span></a>, <a class="man-ref" href="https://manpages.debian.org/buster/efivar/efivar.1.en.html">efivar<span class="s">(1)</span></a>,
<p>Minimal state is stored, and it's only supplementary (see <a href="#UNINSTALLATION" title="UNINSTALLATION" data-bare-link="true">UNINSTALLATION</a>).
This means that removing all instances of a kernel boot entry with tools such as <a class="man-ref" href="https://manpages.debian.org/buster/efibootmgr/efibootmgr.8.en.html">efibootmgr<span class="s">(8)</span></a>, the EFI Shell,
or the platform UI will make <a class="man-ref" href="klapki.8.html">klapki<span class="s">(8)</span></a> forget about the kernel entirely, after minor complaints.</p>

<p><a class="man-ref" href="klapki.8.html">klapki<span class="s">(8)</span></a>'s entries <em>can</em> be moved across <code>BootNNNN</code> entries, however, so long as they are kept identical.</p>


@@ 243,6 244,14 @@ Please report on the bug tracker/mailing list (see <a href="#REPORTING-BUGS" tit
A simple <code>cmdline</code> is a <code>/bin/sh</code> shebang + <code>echo</code> command.
A cursed <code>cmdline</code> would be a <code>/bin/sh</code> shebang and an <code>awk '{gsub(/initrd=[^ ]+ ?/, ""); print}' /proc/cmdline</code> command.</p>

<h2 id="UNINSTALLATION">UNINSTALLATION</h2>

<p>Remove the EFI variable corresponding to the host (see <a href="#ENVIRONMENT" title="ENVIRONMENT" data-bare-link="true">ENVIRONMENT</a>) under klapki's GUID (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 <code>{delkernel}</code> first (see <a href="#OPS" title="OPS" data-bare-link="true">OPS</a>), or remove them manually from the ESP and firmware afterward.</p>

<p>On Linux this involves running <code>chattr -i</code>, then <code>rm</code> on <code>/sys/firmware/efi/efivars/{KLAPKI_HOST}-a8a9ad3a-f831-11ea-946d-674ccd7415cc</code>.</p>

<h2 id="EXIT-VALUES">EXIT VALUES</h2>

<pre><code>1 - error reading configuration,

M klapki.8.html_fragment => klapki.8.html_fragment +10 -2
@@ 20,8 20,8 @@ then settling the new set-up, then committing it; this means that, barring I/O e
files and wanted entries are hashed with <a class="man-ref" href="https://manpages.debian.org/buster/libssl-doc/SHA1.3ssl.en.html">SHA1<span class="s">(3ssl)</span></a> and only updated on mismatch;
foreign entries are never touched, and <a class="man-ref" href="klapki.8.html">klapki<span class="s">(8)</span></a> prefers to abandon entries it doesn't understand than to accidentally mangle them.</p>

<p>Minimal state is stored, and it's only supplementary.
This means that removing all instances of a kernel boot entry with tools such as <a class="man-ref" href="https://manpages.debian.org/buster/efibootmgr/efibootmgr.8.en.html">efibootmgr<span class="s">(8)</span></a>, <a class="man-ref" href="https://manpages.debian.org/buster/efivar/efivar.1.en.html">efivar<span class="s">(1)</span></a>,
<p>Minimal state is stored, and it's only supplementary (see <a href="#UNINSTALLATION" title="UNINSTALLATION" data-bare-link="true">UNINSTALLATION</a>).
This means that removing all instances of a kernel boot entry with tools such as <a class="man-ref" href="https://manpages.debian.org/buster/efibootmgr/efibootmgr.8.en.html">efibootmgr<span class="s">(8)</span></a>, the EFI Shell,
or the platform UI will make <a class="man-ref" href="klapki.8.html">klapki<span class="s">(8)</span></a> forget about the kernel entirely, after minor complaints.</p>

<p><a class="man-ref" href="klapki.8.html">klapki<span class="s">(8)</span></a>'s entries <em>can</em> be moved across <code>BootNNNN</code> entries, however, so long as they are kept identical.</p>


@@ 167,6 167,14 @@ Please report on the bug tracker/mailing list (see <a href="#REPORTING-BUGS" tit
A simple <code>cmdline</code> is a <code>/bin/sh</code> shebang + <code>echo</code> command.
A cursed <code>cmdline</code> would be a <code>/bin/sh</code> shebang and an <code>awk '{gsub(/initrd=[^ ]+ ?/, ""); print}' /proc/cmdline</code> command.</p>

<h2 id="UNINSTALLATION">UNINSTALLATION</h2>

<p>Remove the EFI variable corresponding to the host (see <a href="#ENVIRONMENT" title="ENVIRONMENT" data-bare-link="true">ENVIRONMENT</a>) under klapki's GUID (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 <code>{delkernel}</code> first (see <a href="#OPS" title="OPS" data-bare-link="true">OPS</a>), or remove them manually from the ESP and firmware afterward.</p>

<p>On Linux this involves running <code>chattr -i</code>, then <code>rm</code> on <code>/sys/firmware/efi/efivars/{KLAPKI_HOST}-a8a9ad3a-f831-11ea-946d-674ccd7415cc</code>.</p>

<h2 id="EXIT-VALUES">EXIT VALUES</h2>

<pre><code>1 - error reading configuration,

M klapki.md => klapki.md +10 -2
@@ 17,8 17,8 @@ Care is taken to only write what is needed and only when it's needed –
files and wanted entries are hashed with SHA1(3ssl) and only updated on mismatch;
foreign entries are never touched, and klapki(8) prefers to abandon entries it doesn't understand than to accidentally mangle them.

Minimal state is stored, and it's only supplementary.
This means that removing all instances of a kernel boot entry with tools such as efibootmgr(8), efivar(1),
Minimal state is stored, and it's only supplementary (see [UNINSTALLATION][]).
This means that removing all instances of a kernel boot entry with tools such as efibootmgr(8), the EFI Shell,
or the platform UI will make klapki(8) forget about the kernel entirely, after minor complaints.

klapki(8)'s entries *can* be moved across `BootNNNN` entries, however, so long as they are kept identical.


@@ 152,6 152,14 @@ The simplest `/etc/klapki/description` would be a link to `/bin/echo`.
A simple `cmdline` is a `/bin/sh` shebang + `echo` command.
A cursed `cmdline` would be a `/bin/sh` shebang and an `awk '{gsub(/initrd=[^ ]+ ?/, ""); print}' /proc/cmdline` command.

## UNINSTALLATION

Remove the EFI variable corresponding to the host (see [ENVIRONMENT][]) under klapki's GUID (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 `{delkernel}` first (see [OPS][]), or remove them manually from the ESP and firmware afterward.

On Linux this involves running `chattr -i`, then `rm` on `/sys/firmware/efi/efivars/{KLAPKI_HOST}-a8a9ad3a-f831-11ea-946d-674ccd7415cc`.

## EXIT VALUES

    1 - error reading configuration,