loader.8: Document module commands

[ziaee]

Summary

Begin documenting module loader commands in loader(8), where the reader would look for them. Segregate them by their availability in individual loader implementations, like build(7) targets. These details were graciously donated by kevans.

MFC after: 3 days
Co-authored-by: Kyle Evans <[e-mail]>

[kevans]

I think this one is even more misplaced than the others because it's not available in the simp flavor at all. There are also other module commands that might be good to document: toggle-module, enable-module at least

[ziaee]

Attempt documenting all of them together in loader.8.

[kevans]

Let's also talk about these ones, similarly constrained in availability:

• boot-conf: loads the loader config and commence the autoboot sequence
• read-conf $file: load the specified configuration file
• reload-conf: reload configuration (as if we had just entered loader)

One more module option one:

• show-module-options: describe all of the modules that loader is currently aware of and whether they are enabled or not

Device option specfic to lua:

• disable-device $device: sets a newbus hint to disable the device; e.g., disable-device pci0 will set hint.pci.0.disabled=1)

stand/man/loader.8

92

[pauamma_gundo.com]

stand/man/loader.8

97

Alternatively, split it into one explanation per command.

[ziaee]

if ok, co-authored-by: kevans? i dont want to steal the credit

[imp]

stand/man/loader.8

109

Does this undo all the enable/disable/toggle-module commands, etc?
Is that what 'as if freshly entering the loader' means.
Also 'entering loader' -> 'entering the loader' no?

[ziaee]

stand/man/loader.8

109

Does this undo all the enable/disable/toggle-module commands, etc?

That's my understanding but I don't actually know.

Also 'entering loader' -> 'entering the loader' no?

Yes.

[ziaee]

Hopefully fix @imp's concerns

[ziaee]

Do I need to do anything else here?

[kevans]

stand/man/loader.8

109

It wipes out any module commands and reverts the environment as best as it can to a pre-loader state. It doesn't enumerate all env vars, but if a loader.conf sets a var foo, we recorded the state of foo and restore that value upon reload. So if you manually set another var, bar, that wasn't in any loader.conf: that stays, but if you overwrote the aforementioned foo and loader.conf had set it, that'll get lost.

[ziaee]

stand/man/loader.8

109

So you're saying it only undoes the application of loader.conf?

[kevans]

stand/man/loader.8

109

It's not so black and white since it undoes *some* command-line actions but not others, but that's the general goal.

[ziaee]

incorporate kevans suggestion from IRC