[Bug]: armbian-* should have a man page and --help switch

[leggewie]

What happened?

Debian and Ubuntu users are used to having a man page for every program on the system. I think armbian-* programs should have that, too. I am happy to help in getting that done.

How to reproduce?

man armbian-config

On which OS are you observing this problem? (for easier diagnosis please provide logs with armbianmonitor -u)

Armbian Ubuntu 24.04 Noble

Code of Conduct

• I agree to follow this project's Code of Conduct

[igorpecovnik]

armbian-config --help works:

Initializing script                     0 seconds
Loaded Runtime variables...             1 seconds
The current Armbian 25.2.2 stable (noble) is supported.           0 seconds
Loaded Dialog...                        0 seconds
Loaded Docs...                          0 seconds
Loaded System helpers...                0 seconds
Loaded Network helpers...               0 seconds
Loaded Software helpers...              0 seconds
Loaded Runtime conditions...            0 seconds
Usage:  armbian-config --[option]
  Options:
     --help [category]   Use [category] to filter specific menu options.
     --cmd  [option]     Run a command from the menu (simple)
     --api  [option]     Run a helper command        (advanced)
     --doc               Generate the README.md file 

     Examples:
     armbian-config --help [cmd||System||Software||Network||Localisation]
     armbian-config --cmd help 
     armbian-config --api help

Man page ? If it can be made automatically from the existing.

[leggewie]

Agreed about help2man. That's what I was hoping to use. "armbian-config --help" requires root and IMHO it should not. Precisely because I want to know what it does before giving it root.

[igorpecovnik]

requires root and IMHO it should not.

We are changing system config files, install applications, ... only some parts doesn't need it. But, yes, making help or docs, should not need it. Making docs 2 man pages can be done here with Github actions, right before packing to deb.