PIBOOTCTL-SHOW(1)

✨ pibootctl-show ✨

okay bestie, welcome to the pibootctl-show manual page πŸ’– this one lives in the pibootctl manual family, and it's literally just here to show you your stored boot configs. no cap.


🌸 SYNOPSIS 🌸

pibootctl show [-h] [-a] [--json | --yaml | --shell] name [pattern]

that's the whole vibe. one command, a bunch of little toggles, go off πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

So what does it do? It displays the stored boot configuration you asked for β€” the one with that name β€” or, if you're feeling picky, just the sub-set of its settings that match the pattern you handed it. that's it. that's the girl. ✨


πŸŽ€ OPTIONS πŸŽ€

  • name β€” the name of the boot configuration you wanna display. yes, you have to tell it which one. it's not a mind reader πŸ™ˆ
  • pattern β€” if you specify this, it only shows settings whose names match the pattern. and the pattern can include shell globbing characters, like *, ?, and simple [classes]. so you can get real specific about it πŸ’…
  • -h, --help β€” shows you a brief help page for the command. the lil quickie version 🫢
  • -a, --all β€” includes all settings in the output, regardless of whether they've been modified. by default? only the modified ones show up. so this is the "give me everything" flag πŸ‘‘
  • --json β€” use JSON as the output format ✨
  • --yaml β€” use YAML as the output format ✨
  • --shell β€” use a var=value output format that's suitable for the shell 🐚

🌈 USAGE 🌈

so the show command is basically the equivalent of the status command, but for stored boot configurations. iconic behaviour honestly.

By default it only displays the settings in the specified configuration that have been modified from their default:

$ pibootctl show 720p
+------------------------+----------------+
| Name                   | Value          |
|------------------------+----------------|
| video.hdmi0.group      | 1 (CEA)        |
| video.hdmi0.mode       | 4 (720p @60Hz) |
+------------------------+----------------+

look at that. clean. tidy. slay. πŸ’…

Now, the full set of settings can also be displayed β€” and heads up, it's usually several pages long, so it'll implicitly invoke the system's pager (yes, it's gonna take over your whole terminal, that's the deal, not sorry 😭). You get all of it with the --all option:

$ pibootctl show 720p --all
+------------------------------+----------+--------------------------------+
| Name                         | Modified | Value                          |
|------------------------------+----------+--------------------------------|
...
| video.hdmi0.enabled          |          | auto                           |
| video.hdmi0.encoding         |          | 0 (auto; 1 for CEA, 2 for DMT) |
| video.hdmi0.flip             |          | 0 (none)                       |
| video.hdmi0.group            | x        | 1 (CEA)                        |
| video.hdmi0.mode             | x        | 4 (720p @60Hz)                 |
| video.hdmi0.mode.force       |          | off                            |
| video.hdmi0.rotate           |          | 0                              |
| video.hdmi0.timings          |          | []                             |
| video.hdmi1.audio            |          | auto                           |
| video.hdmi1.boost            |          | 5                              |
...
πŸ“Œ bestie note: when --all is specified, a "Modified" column gets included in the output, so you can see which settings are no longer default. the x marks the spot ✨

And just like with the status command, you can filter the list of settings even further by specifying a pattern with the command. The pattern can include any of the common shell wildcard characters:

  • * for any number of any character
  • ? for any single character
  • [seq] for any character in seq
  • [!seq] for any character not in seq

For example:

$ pibootctl show --all 720p i2c.*
+-------------+----------+--------+
| Name        | Modified | Value  |
|-------------+----------+--------|
| i2c.baud    |          | 100000 |
| i2c.enabled |          | off    |
+-------------+----------+--------+

only the i2c girlies made it to the party πŸ“

Now for the devs out there who wanna build stuff on top of pibootctl β€” there are options to produce the output in JSON (--json), YAML (--yaml), and shell-friendly (--shell) formats. And these combine with all the aforementioned options as expected, fr fr:

$ pibootctl show --json --all 720p i2c.*
{"i2c.baud": 100000, "i2c.enabled": false}

one line. machine-readable. main character energy πŸ”₯


πŸ’œ AUTHOR πŸ’œ

Dave Jones

2019-2020 Dave Jones


and that's the whole page bestie, tysm for reading 🧚 this was pibootctl-show from version 0.5.2, dated Sep 14, 2020 β€” go forth and show your boot configs, you've got this πŸ’–βœ¨

πŸ“¦ where this page comes from