man(1)

πŸ“¦ version 0.1.1, in nixos 26.05, nixpkgs unstable

πŸ’… beefi(1) β€” the man page, but make it cute

okay bestie, so you're on the beefi man page (yes that's the manual name, and yes it's iconic) and lowkey this whole thing is about one job: making a bootable EFISTUB kernel image. let's get into it ✨


🌸 NAME 🌸

beefi β€” create a bootable EFISTUB kernel image πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

beefi [ -u ] [ -c CMDLINE ] [ -k KERNEL ] [ -i INITRD ] [ -h ] [ --version ]

πŸ’– DESCRIPTION πŸ’–

so beefi is a script, right? and its whole main character energy is creating a bootable EFISTUB kernel image with the kernel commandline and the initramfs image baked right in. 🫢

it does this using objcopy β€” literally glues all those components together into one single image that can be booted directly on UEFI systems. no middleman, no cap. πŸ”₯


✨ OPTIONS ✨

here's the full list of options beefi accepts, no skips, we don't do that here:

  • -c | --cmdline β€” sets the kernel command line πŸ“
  • -k | --kernel KERNEL β€” where the kernel image lives (e.g. /boot/vmlinuz-linux) 🐧
  • -i | --initrd INITRD β€” where the initrd image lives (e.g. /boot/initramfs-linux.img) 🧚
  • -o | --output UTPUT β€” where the output file goes (e.g. /boot/efi/EFI/boot/bootx64.efi) πŸ’Ύ
  • -u | --use-config β€” uses the configuration file /etc/beefi/beefi.conf βš™οΈ
  • -h | --help β€” just prints the help string and dips πŸ‘‹
  • --version β€” just prints the version string and dips πŸ‘‹
ngl, yes, UTPUT is spelled exactly like that in the original and i'm not about to change it. preserving the lore. πŸ’€

πŸŽ€ EXAMPLES πŸŽ€

make a bootable image using the current kernel commandline

run this:

beefi --current-cmdline -k /boot/vmlinuz-linux -i /boot/initramfs-linux.img -o output.efi

slay. that's it. that's the whole vibe. 🌈


make a bootable image using a custom kernel commandline

run this:

beefi -c "root=UUID=aabbccdd-eeff-0011-223344556677 rw quiet" -k /boot/vmlinuz-linux -i /boot/initramfs-linux.img -o output.efi

custom cmdline, your rules, your world. πŸ‘‘


make a bootable image using the config file /etc/beefi/beefi.conf

run this:

beefi -u

one flag. one file. so clean. ✨


🧚 SEE ALSO 🧚

efibootmgr(8), elilo(1) β€” go read those too bestie, i believe in you πŸ’œ


πŸ™ˆ BUGS πŸ™ˆ

found a bug? got a feature? got a patch? literally any of it β€” please direct all of that to Jan Frederick Eick:

he's the one who wants to hear about it, fr fr 🫢


okay that's the whole page!! tysm for reading, you ate that πŸ’…βœ¨

version 0.2, dated 28 August 2017 β€” muah, iconic, no notes πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from