Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix help messages #156

Merged
merged 1 commit into from
Mar 21, 2022
Merged

Fix help messages #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 37 additions & 34 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,33 @@ Note: efibootmgr requires either the efivarfs or the
legacy efivars kernel module to be loaded prior to use.

usage: efibootmgr [options]
-a | --active sets bootnum active
-A | --inactive sets bootnum inactive
-b | --bootnum XXXX modify BootXXXX (hex)
-B | --delete-bootnum delete bootnum
-c | --create create new variable bootnum and add to bootorder
-d | --disk disk (defaults to /dev/sda) containing loader
-e | --edd [1|3|-1] force EDD 1.0 or 3.0 creation variables, or guess
-E | --device num EDD 1.0 device number (defaults to 0x80)
-g | --gpt force disk w/ invalid PMBR to be treated as GPT
-i | --iface name create a netboot entry for the named interface
-l | --loader name (defaults to \elilo.efi)
-L | --label label Boot manager display label (defaults to "Linux")
-n | --bootnext XXXX set BootNext to XXXX (hex)
-N | --delete-bootnext delete BootNext
-o | --bootorder XXXX,YYYY,ZZZZ,... explicitly set BootOrder (hex)
-O | --delete-bootorder delete BootOrder
-p | --part part (defaults to 1) containing loader
-q | --quiet be quiet
-t | --timeout seconds Boot manager timeout
-T | --delete-timeout delete Timeout value
-u | --unicode | --UCS-2 pass extra args as UCS-2 (default is ASCII)
-v | --verbose print additional information
-V | --version return version and exit
-w | --write-signature write unique sig to MBR if needed
-@ | --append-binary-args append extra variable args from
-a | --active Set bootnum active.
-A | --inactive Set bootnum inactive.
-b | --bootnum XXXX Modify BootXXXX (hex).
-B | --delete-bootnum Delete bootnum.
-c | --create Create new variable bootnum and add to bootorder.
-d | --disk disk (Defaults to /dev/sda) containing loader.
-e | --edd [1|3|-1] Force EDD 1.0 or 3.0 creation variables, or guess.
-E | --device num EDD 1.0 device number (defaults to 0x80).
-f | --reconnect Re-connect devices after driver is loaded.
-F | --no-reconnect Do not re-connect devices after driver is loaded.
-g | --gpt Force disk w/ invalid PMBR to be treated as GPT.
-i | --iface name Create a netboot entry for the named interface.
-l | --loader name (Defaults to \elilo.efi).
-L | --label label Boot manager display label (defaults to "Linux").
-n | --bootnext XXXX Set BootNext to XXXX (hex).
-N | --delete-bootnext Delete BootNext.
-o | --bootorder XXXX,YYYY,ZZZZ,... Explicitly set BootOrder (hex).
-O | --delete-bootorder Delete BootOrder.
-p | --part part (Defaults to 1) containing loader.
-q | --quiet Be quiet.
-t | --timeout seconds Boot manager timeout.
-T | --delete-timeout Delete Timeout value.
-u | --unicode | --UCS-2 Pass extra args as UCS-2 (default is ASCII).
-v | --verbose Print additional information.
-V | --version Return version and exit.
-w | --write-signature Write unique sig to MBR if needed.
-@ | --append-binary-args Append extra variable args from
file (use - to read from stdin).


Expand All @@ -57,13 +59,13 @@ This shows:
BootCurrent - the boot entry used to start the currently running
system.

BootOrder - the boot order as would appear in the boot manager. The
boot manager tries to boot the first active entry on this list. If
BootOrder - the boot order as would appear in the boot manager. The
boot manager tries to boot the first active entry on this list. If
unsuccessful, it tries the next entry, and so on.

BootNext - the boot entry which is scheduled to be run on next boot.
This superceeds BootOrder for one boot only, and is deleted by the
boot manager after first use. This allows you to change the next boot
This supersedes BootOrder for one boot only, and is deleted by the
boot manager after first use. This allows you to change the next boot
behavior without changing BootOrder.

Timeout - the time in seconds between when the boot manager appears
Expand All @@ -79,24 +81,25 @@ Alternative use cases could be as follows:
/dev/sda1 is your EFI System Partition, and is mounted at /boot/efi.
This creates a new boot option, called "Linux", and puts it at the top
of the boot order list. Options may be passed to modify the
default behavior. The default OS Loader is elilo.efi.
default behavior. The default OS Loader is elilo.efi.

2) A system administrator wants to change the boot order. She would
2) A system administrator wants to change the boot order. She would
call 'efibootmgr -o 3,4' to specify PXE boot first, then Linux
boot.

3) A system administrator wants to change the boot order for the next
boot only. She would call 'efibootmgr -n 4' to specify that the
boot only. She would call 'efibootmgr -n 4' to specify that the
Linux entry be taken on next boot.

4) A system administrator wants to delete the Linux boot option from
the menu. 'efibootmgr -b 4 -B' deletes entry 4 and removes it
the menu. 'efibootmgr -b 4 -B' deletes entry 4 and removes it
from BootOrder.

5) A system administrator wants to create a boot option to network
boot (PXE). You create the boot entry with:
'efibootmgr -c -i eth0 -L netboot'

Please direct any bugs, features, patches, etc. to Peter Jones:
Please direct any bugs, features, patches, etc. to the Red Hat bootloader
team:

https://github.com/rhboot/efibootmgr
70 changes: 35 additions & 35 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,33 @@ legacy efivars kernel module to be loaded prior to use.

```
usage: efibootmgr [options]
-a | --active sets bootnum active
-A | --inactive sets bootnum inactive
-b | --bootnum XXXX modify BootXXXX (hex)
-B | --delete-bootnum delete bootnum
-c | --create create new variable bootnum and add to bootorder
-d | --disk disk (defaults to /dev/sda) containing loader
-e | --edd [1|3|-1] force EDD 1.0 or 3.0 creation variables, or guess
-E | --device num EDD 1.0 device number (defaults to 0x80)
-f | --reconnect Re-connect devices after driver is loaded
-F | --no-reconnect Do not re-connect devices after driver is loaded
-g | --gpt force disk w/ invalid PMBR to be treated as GPT
-i | --iface name create a netboot entry for the named interface
-l | --loader name (defaults to \elilo.efi)
-L | --label label Boot manager display label (defaults to "Linux")
-n | --bootnext XXXX set BootNext to XXXX (hex)
-N | --delete-bootnext delete BootNext
-o | --bootorder XXXX,YYYY,ZZZZ,... explicitly set BootOrder (hex)
-O | --delete-bootorder delete BootOrder
-p | --part part (defaults to 1) containing loader
-q | --quiet be quiet
-t | --timeout seconds Boot manager timeout
-T | --delete-timeout delete Timeout value
-u | --unicode | --UCS-2 pass extra args as UCS-2 (default is ASCII)
-v | --verbose print additional information
-V | --version return version and exit
-w | --write-signature write unique sig to MBR if needed
-@ | --append-binary-args append extra variable args from
-a | --active Set bootnum active.
-A | --inactive Set bootnum inactive.
-b | --bootnum XXXX Modify BootXXXX (hex).
-B | --delete-bootnum Delete bootnum.
-c | --create Create new variable bootnum and add to bootorder.
-d | --disk disk (Defaults to /dev/sda) containing loader.
-e | --edd [1|3|-1] Force EDD 1.0 or 3.0 creation variables, or guess.
-E | --device num EDD 1.0 device number (defaults to 0x80).
-f | --reconnect Re-connect devices after driver is loaded.
-F | --no-reconnect Do not re-connect devices after driver is loaded.
-g | --gpt Force disk w/ invalid PMBR to be treated as GPT.
-i | --iface name Create a netboot entry for the named interface.
-l | --loader name (Defaults to \elilo.efi).
-L | --label label Boot manager display label (defaults to "Linux").
-n | --bootnext XXXX Set BootNext to XXXX (hex).
-N | --delete-bootnext Delete BootNext.
-o | --bootorder XXXX,YYYY,ZZZZ,... Explicitly set BootOrder (hex).
-O | --delete-bootorder Delete BootOrder.
-p | --part part (Defaults to 1) containing loader.
-q | --quiet Be quiet.
-t | --timeout seconds Boot manager timeout.
-T | --delete-timeout Delete Timeout value.
-u | --unicode | --UCS-2 Pass extra args as UCS-2 (default is ASCII).
-v | --verbose Print additional information.
-V | --version Return version and exit.
-w | --write-signature Write unique sig to MBR if needed.
-@ | --append-binary-args Append extra variable args from
file (use - to read from stdin).
```

Expand All @@ -60,13 +60,13 @@ This shows:
**BootCurrent** - the boot entry used to start the currently running
system.

**BootOrder** - the boot order as would appear in the boot manager. The
boot manager tries to boot the first active entry on this list. If
**BootOrder** - the boot order as would appear in the boot manager. The
boot manager tries to boot the first active entry on this list. If
unsuccessful, it tries the next entry, and so on.

**BootNext** - the boot entry which is scheduled to be run on next boot.
This superceeds BootOrder for one boot only, and is deleted by the
boot manager after first use. This allows you to change the next boot
This supersedes BootOrder for one boot only, and is deleted by the
boot manager after first use. This allows you to change the next boot
behavior without changing BootOrder.

**Timeout** - the time in seconds between when the boot manager appears
Expand All @@ -82,18 +82,18 @@ Alternative use cases could be as follows:
/dev/sda1 is your EFI System Partition, and is mounted at /boot/efi.
This creates a new boot option, called "Linux", and puts it at the top
of the boot order list. Options may be passed to modify the
default behavior. The default OS Loader is elilo.efi.
default behavior. The default OS Loader is elilo.efi.

2) A system administrator wants to change the boot order. She would
2) A system administrator wants to change the boot order. She would
call `efibootmgr -o 3,4` to specify PXE boot first, then Linux
boot.

3) A system administrator wants to change the boot order for the next
boot only. She would call `efibootmgr -n 4` to specify that the
boot only. She would call `efibootmgr -n 4` to specify that the
Linux entry be taken on next boot.

4) A system administrator wants to delete the Linux boot option from
the menu. `efibootmgr -b 4 -B` deletes entry 4 and removes it
the menu. `efibootmgr -b 4 -B` deletes entry 4 and removes it
from BootOrder.

5) A system administrator wants to create a boot option to network
Expand Down
76 changes: 38 additions & 38 deletions src/efibootmgr.8.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,29 @@ non-volatile variables through
The following is a list of options accepted by efibootmgr:
.TP
\fB-a | --active\fR
Sets bootnum active
Set bootnum active.
.TP
\fB-A | --inactive\fR
Sets bootnum inactive
Set bootnum inactive.
.TP
\fB-b | --bootnum \fIXXXX\fB\fR
Modify Boot\fIXXXX\fR (hex)
Modify Boot\fIXXXX\fR (hex).
.TP
\fB-B | --delete-bootnum\fR
Delete bootnum
Delete bootnum.
.TP
\fB-c | --create\fR
Create new variable bootnum and add to bootorder
Create new variable bootnum and add to bootorder.
.TP
\fB-C | --create-only\fR
Create new variable bootnum and and do not add to bootorder
Create new variable bootnum and and do not add to bootorder.
.TP
\fB-d | --disk \fIDISK\fB\fR
The disk containing the loader (defaults to
\fI/dev/sda\fR)
\fI/dev/sda\fR).
.TP
\fB-D | --remove-dups\fR
Remove duplicated entries from BootOrder
Remove duplicated entries from BootOrder.
.TP
\fB-e | --edd \fI1|3\fB\fR
Force EDD 1.0 or 3.0 creation variables.
Expand Down Expand Up @@ -86,72 +86,72 @@ Re-connect devices after driver is loaded. Only applicable for driver entries.
Do not reconnect devices after driver is loaded. Only applicable for driver entries.
.TP
\fB-g | --gpt\fR
Force disk with invalid PMBR to be treated as GPT
Force disk with invalid PMBR to be treated as GPT.
.TP
\fB-i | --iface \fINAME\fB\fR
Create a netboot entry for the named interface
Create a netboot entry for the named interface.
.TP
\fB-k | --keep \fINAME\fB\fR
Keep old entries when adjusting order
Keep old entries when adjusting order.
.TP
\fB-l | --loader \fINAME\fB\fR
Specify a loader (defaults to \fI@@DEFAULT_LOADER@@\fR)
Specify a loader (defaults to \fI@@DEFAULT_LOADER@@\fR).
.TP
\fB-L | --label \fILABEL\fB\fR
Boot manager display label (defaults to "Linux")
Boot manager display label (defaults to "Linux").
.TP
\fB-m | --mirror-below-4G \fIt|f\fB\fR
Set t if you want to mirror memory below 4GB
Set t if you want to mirror memory below 4GB.
.TP
\fB-M | --mirror-above-4G \fIX\fB\fR
X percentage memory to mirror above 4GB. Floating-point value with up to 2 decimal places is accepted.
X percentage memory to mirror above 4GB. Floating-point value with up to 2 decimal places is accepted.
.TP
\fB-n | --bootnext \fIXXXX\fB\fR
Set BootNext to XXXX (hex)
Set BootNext to XXXX (hex).
.TP
\fB-N | --delete-bootnext\fR
Delete BootNext
Delete BootNext.
.TP
\fB-o | --bootorder \fIXXXX\fB,\fIYYYY\fB,\fIZZZZ\fB\fR
Explicitly set BootOrder (hex). Any value from 0 to FFFF is accepted so long as it corresponds to an existing Boot#### variable, and zero padding is not required.
Explicitly set BootOrder (hex). Any value from 0 to FFFF is accepted so long as it corresponds to an existing Boot#### variable, and zero padding is not required.
.TP
\fB-O | --delete-bootorder\fR
Delete BootOrder
Delete BootOrder.
.TP
\fB-p | --part \fIPART\fB\fR
Partition number containing the bootloader (defaults to 1)
Partition number containing the bootloader (defaults to 1).
.TP
\fB-q | --quiet\fR
Quiet mode - suppresses output
Quiet mode - suppresses output.
.TP
\fB-r | --driver\fR
Operate on Driver#### variables instead of Boot#### variables
Operate on Driver#### variables instead of Boot#### variables.
.TP
\fB-t | --timeout \fIseconds\fB\fR
Boot Manager timeout, in \fIseconds\fR\&
Boot Manager timeout, in \fIseconds\fR\&.
.TP
\fB-T | --delete-timeout\fR
Delete Timeout variable
Delete Timeout variable.
.TP
\fB-u | --unicode | --UCS-2 \fR
Handle extra command line arguments as UCS-2 (default is
ASCII)
ASCII).
.TP
\fB-v | --verbose\fR
Verbose mode - prints additional information
Verbose mode - prints additional information.
.TP
\fB-V | --version\fR
Just print version string and exit
Just print version string and exit.
.TP
\fB-w | --write-signature\fR
write unique signature to the MBR if needed
Write unique signature to the MBR if needed.
.TP
\fB-y | --sysprep\fR
Operate on SysPrep#### variables instead of Boot#### variables
Operate on SysPrep#### variables instead of Boot#### variables.
.TP
\fB-@ | --append-binary-args \fR
append extra variable args from file (use - to read
from stdin). Data in file is appended as command line
Append extra variable args from file (use - to read
from stdin). Data in file is appended as command line
arguments to the boot loader command, with no modification to
the data, so you can pass any binary or text data necessary.
.SH "EXAMPLES"
Expand Down Expand Up @@ -182,12 +182,12 @@ running system
\(bu
BootOrder - the boot order as would appear in the boot manager.
The boot manager tries to boot the first active entry in this
list. If unsuccessful, it tries the next entry, and so on.
list. If unsuccessful, it tries the next entry, and so on.
.TP 0.2i
\(bu
BootNext - the boot entry which is scheduled to be run on next
boot. This supercedes BootOrder for one boot only, and is
deleted by the boot manager after first use. This allows you
boot. This supersedes BootOrder for one boot only, and is
deleted by the boot manager after first use. This allows you
to change the next boot behavior without changing BootOrder.
.TP 0.2i
\(bu
Expand All @@ -203,10 +203,10 @@ flag (* means active) and the name displayed on the screen.
.SS "Creating a new boot option"
An OS installer would call \fBefibootmgr -c\fR\&.
This assumes that \fI/dev/sda1\fR is your EFI System
Partition, and is mounted at \fI/boot/efi\fR\&. This
Partition, and is mounted at \fI/boot/efi\fR\&. This
creates a new boot option, called "Linux", and puts it at the top of
the boot order list. Options may be passed to modify the default
behavior. The default OS Loader is \fI@@DEFAULT_LOADER@@\fR\&.
the boot order list. Options may be passed to modify the default
behavior. The default OS Loader is \fI@@DEFAULT_LOADER@@\fR\&.
.SS "Changing the boot order"
Assuming the configuration in the first example,
\fBefibootmgr -o 3,4\fR could be called to specify
Expand All @@ -221,7 +221,7 @@ Assuming the configuration in the first example,
entry 4 and remove it from the BootOrder.
.SS "Creating network boot entries"
A system administrator wants to create a boot option to network
boot. You create the boot entry with:
boot. You create the boot entry with:
\fBefibootmgr -c -i eth0 -L netboot [ -l '\\filename.efi' ]\fR
.SH "BUGS"
.PP
Expand Down
Loading