mkosi-addon(1)

📦
version 27.1 · 6 versions
, in arch rolling

💅 mkosi-addon — the glow-up page

Okay bestie, welcome to mkosi-addon(1), straight out of the General Commands Manual ✨ this is the page where we build addons for unified kernel images for the current system using mkosi, and honestly? iconic behavior.

🌸 NAME 🌸

mkosi-addon — builds addons for unified kernel images for the current system using mkosi. That's the whole vibe. No cap. 🫶

✨ SYNOPSIS ✨

mkosi-addon [options...]

That's it. That's the summoning ritual.

🦋 DESCRIPTION 🦋

okay so, mkosi-addon is a wrapper on top of mkosi — think of it as mkosi's hype squad — and its whole job is to simplify the generation of PE addons containing customizations for unified kernel images that are specific to the running or local system. 💖

The way it just includes stuff for you:

  • entries in /etc/crypttab that are marked with x-initrd.attach 🔐
  • /etc/kernel/cmdline 📝

and — plot twist — kernel modules and firmwares for the running hardware can also be included, but only if you provide a local configuration with the option KernelModulesIncludeHost= set. iykyk. 👑

🎀 OPTIONS 🎀

  • --kernel-version= — tells it which kernel version to go look for the kernel modules in. defaults to the kernel version of the running system, aka uname -r. it's giving "just ask the machine." 💀
  • --output=, -o — the name to use for the generated output addon. defaults to mkosi-local.addon.efi. name your baby. 🍼
  • --output-dir=, -O — path to a directory where all the generated artifacts go. defaults to the current working directory. 🗂️
  • --debug — enable additional debugging output. more words! more clues! 🔍
  • --debug-shell — spawns a debug shell in the sandbox if a sandboxed command fails. so when it goes wrong you get to poke around in there yourself. 🐚
  • --debug-sandbox — runs mkosi-sandbox with strace. yes, we're watching everything. 🙈
  • --show-documentation, -D — shows the man page for mkosi-addon. hi, that's this one. you are here. 💅
  • --version — shows the package version. number time. 🔢
  • --help, -h — shows brief usage information. the snack-sized version. 🍓

🌈 SEE ALSO 🌈

  • mkosi(1) — the parent, the blueprint, the main character. go read it next, bestie. 🧚
friendly reminder: every one of these flags is exactly what it says on the tin, so type them carefully — no invented options, no vibes-based guessing. periodt. ⭐

and that's the page, bestie 💜 — brought to you by the General Commands Manual, page mkosi-addon(1), wrapping it up with love and a little sparkle. stay slaying, stay sandboxed. 🎀✨

📦 where this page comes from