zfsbootmenu/docs/man/dist/man8/zbm-efi-kcl.8

104 lines
2.6 KiB
Groff

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "ZBM-EFI-KCL" "8" "2022-12-19" "" "ZFSBootMenu"
.SH NAME
zbm-efi-kcl \- manipulate kernel command lines for EFI binaries
.SH SYNOPSIS
.sp
\fBzbm\-efi\-kcl\fP [\-f <kcl\-file>] [\-k <kcl\-text>] [\-o <output>] \-e <input>
.SH DESCRIPTION
.sp
The \fBzbm\-efi\-kcl\fP utility allows review and manipulation of the embedded kernel command line value present in ZFSBootMenu EFI binaries. This value is used by most UEFI firmware implementations and bootloaders.
.SH OPTIONS
.sp
\fB\-e\fP \fIinput\fP
.INDENT 0.0
.INDENT 3.5
Define the EFI binary upon which to operate. This option is required.
.UNINDENT
.UNINDENT
.sp
\fB\-f\fP \fIkcl\-file\fP
.INDENT 0.0
.INDENT 3.5
Replace the embedded kernel command line with the contents of the file. This is primarily intended for automated changes to the EFI binary.
.UNINDENT
.UNINDENT
.sp
\fB\-k\fP \fIkcl\-text\fP
.INDENT 0.0
.INDENT 3.5
Replace the kernel command line with the quoted argument. Ensure proper shell quoting behavior is respected here.
.UNINDENT
.UNINDENT
.sp
\fB\-o\fP \fIoutput\fP
.INDENT 0.0
.INDENT 3.5
After changing the embedded kernel command line, store the new EFI binary under a new file name. The input EFI binary is left unchanged.
.UNINDENT
.UNINDENT
.sp
If neither \fB\-f\fP or \fB\-k\fP are provided, the command line from the input EFI binary will be opened in \fB$EDITOR\fP\&.
.SH EXAMPLES
.sp
Perform an in\-place edit of the commandline in the release EFI binary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
zbm\-efi\-kcl \-e /boot/efi/EFI/BOOT/zfsbootmenu.EFI
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Perform an edit and store the change in a new file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
zbm\-efi\-kcl \-e /boot/efi/EFI/boot/zfsbootmenu.EFI \-o /boot/efi/EFI/boot/zfsbootmenu\-testing.EFI
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fI\%zfsbootmenu(7)\fP
.SH AUTHOR
ZFSBootMenu Team <https://github.com/zbm-dev/zfsbootmenu>
.SH COPYRIGHT
2019, Zach Dykstra
.\" Generated by docutils manpage writer.
.