PIBOOTCTL-HELP(1)

✨ pibootctl-help — the pibootctl manual, bestie edition ✨

okay so this is the manual page for pibootctl-help, which lives inside the pibootctl manual. it's the help desk of the help desk. it's giving customer service but make it iconic 🎀

---

🌸 SYNOPSIS 🌸

pibootctl help [-h] [command | setting]

---

💖 DESCRIPTION 💖

okay so here's the vibe: run it with no arguments at all and it shows you the whole list of pibootctl commands. like a menu. a little directory of possibilities. slay ✨

give it a command name and it spills the description and options for that named command. give it a setting name instead and it tells you the description and the default value for that setting. it just knows 🦋

---

💅 OPTIONS 💅

• -h, --help — shows you a brief help page for the command. tiny help. help appetizer. 🍓
• command — the name of the command you want help for. heads up bestie, you have to give the full command name — abbreviations are not accepted. no shortcuts, no nicknames, no "you know what i meant". it's giving strict. 💀
• setting — the name of the setting you want help for.

okay so plot twist: if the setting isn't recognized and it contains an underscore (_) character, the utility will just assume it's a config.txt configuration command and try to output help for the setting that corresponds to it. and if multiple settings correspond to it? then it prints their names instead. no cap. 🫶

---

🌈 USAGE 🌈

so the help command is the default command — which means if you call pibootctl with no other arguments, this is what you get. it's the main character, it's just always there for you. 👑

but you can also use it to grab help for specific commands:

$ pibootctl help ls
usage: pibootctl list [-h] [--json | --yaml | --shell]

List all stored boot configurations.

optional arguments:
  -h, --help  show this help message and exit
  --json      Use JSON as the format
  --yaml      Use YAML as the format
  --shell     Use a var=value or tab-delimited format suitable for the
              shell

alternatively, it can describe settings for you:

$ pibootctl help boot.debug.enabled
      Name: boot.debug.enabled
   Default: off
Command(s): start_debug, start_file, fixup_file

Enables loading the debugging firmware. This implies that start_db.elf (or
start4db.elf) will be loaded as the GPU firmware rather than the default
start.elf (or start4.elf). Note that the debugging firmware incorporates
the camera firmware so this will implicitly switch camera.enabled on if it
is not already.

The debugging firmware performs considerably more logging than the default
firmware but at a performance cost, ergo it should only be used when
required.

and finally — this one's for the ones who grew up on the "classic" boot configuration commands — you can use it to figure out which pibootctl settings correspond to those classic commands:

$ pibootctl help start_file
start_file is affected by the following settings:

camera.enabled
boot.debug.enabled
boot.firmware.filename

fr fr, this is the translation layer you didn't know you needed 🧚

---

💜 AUTHOR 💜

Dave Jones

---

🎀 COPYRIGHT 🎀

2019-2020 Dave Jones

---

and that's the whole page, bestie — no notes, ate, left no crumbs 💅✨ this was pibootctl-help, version 0.5.2, dated Sep 14, 2020. go forth and pibootctl help everything you love 🦋💖