2025-03-14 21:59:59 -06:00
|
|
|
# help2man
|
|
|
|
|
|
|
|
|
|
> Produce simple man pages from an executable's `--help` and `--version` output.
|
|
|
|
|
> More information: <https://www.gnu.org/software/help2man>.
|
|
|
|
|
|
|
|
|
|
- Generate a man page for an executable:
|
|
|
|
|
|
|
|
|
|
`help2man {{executable}}`
|
|
|
|
|
|
|
|
|
|
- Specify the "name" paragraph in the man page:
|
|
|
|
|
|
2025-04-03 20:36:56 -06:00
|
|
|
`help2man {{executable}} {{[-n|--name]}} {{name}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Specify the section for the man page (defaults to 1):
|
|
|
|
|
|
2025-04-03 20:36:56 -06:00
|
|
|
`help2man {{executable}} {{[-s|--section]}} {{section}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Output to a file instead of `stdout`:
|
|
|
|
|
|
2025-04-03 20:36:56 -06:00
|
|
|
`help2man {{executable}} {{[-o|--output]}} {{path/to/file}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Display help:
|
|
|
|
|
|
|
|
|
|
`help2man --help`
|
