#efi #kernel #bootstub

app bootstub-updater

Automatically updates efibootstub when kernel is updated

1 stable release

1.0.0 Aug 23, 2020

#1937 in Command line utilities

GPL-3.0-or-later

22KB
184 lines

bootstub-updater

GitHub GitHub release (latest by date) Crates.io AUR

A utility to facilitate the maintenance of your EFI bootstub.
Written in rust.

Introduction

The aim of bootstub-updater is to simplify the process of maintaining a bootstub entry. After figuring out the command that creates a bootstub, you pretty much set it and forget it!

Installation

bootstub-updater can be installed through one of the methods listed below.

Cargo

First, install rust, and then run the following command:

cargo install bootstub-updater

To update after installation, run:

cargo install bootstub-updater --force

AUR

For those using Arch Linux you can find the package on the AUR here. However, if you're using an AUR helper, the package can be installed through that. For example, If using yay, run the following command:

yay -S bootstub-updater

Looking for maintainer for the AUR package. Email me at rehanalirana@tuta.io if you are interested.

Manual

  1. Download the latest binary from the releases page
  2. (Optional) To ensure the file you downloaded is correct and was not tampered with, do the following:
    1. Download the respective .sha256 file
    2. Run sha256sum on the .tar.gz file
    3. Compare the output of the command with the contents of the .sha256 file. If they are the same, then your file has not been tampered with
  3. Unpack the .tar.gz file by running
    tar -zxvf bootstub-updater.tar.gz
  4. You can now run it by running ./bootstub-updater in the directory the binary was unpacked. It is recommended to place the binary in your $PATH (ex. /usr/bin, which is commonly used), so you can use it from anywhere

Usage

Before anything, figure out the command to create an efibootstub that boots your current kernel. Instructions can be found here.

Command Line

  • -c, --command <COMMAND>
    Enter full efibootmgr command to be run when kernel is updated, replacing the kernel version number with %v. Surround command with quotation marks.

  • -b, --bootnum <NUM>
    Entry number of current entry in efibootmgr. Will be removed and replaced with the new one.

  • -f, --format <FILENAME>
    Example of naming convention of kernel for your current distro. Replace version number with %v.
    ex. vmlinuz-%v

  • -t, --toml <FILEPATH>
    Specify the location of a TOML file to configure the program through a config file. An example can be found here.

  • -k, --kernel-dir <DIRECTORY>
    Optional. If your kernel directory lies somewhere other than at /boot, specify it here.

Config File

bootstub-updater can also be configured through a TOML-formatted config file. You can specify the location of the config file through the --path option.

Through this config file, you can use the same configuration options as through the command line. An example can be found here.

Dependencies

~2–12MB
~103K SLoC