tldr/pages/common/help2man.md

25 lines
558 B
Markdown
Raw Normal View History

2018-05-10 15:45:31 +01:00
# help2man
> Produce simple man pages from an executable's `--help` and `--version` output.
2019-06-07 11:58:28 +01:00
> More information: <https://www.gnu.org/software/help2man>.
2018-05-10 15:45:31 +01:00
- Generate a man page for an executable:
`help2man {{executable}}`
- Specify the "name" paragraph in the man page:
`help2man {{executable}} --name {{name}}`
- Specify the section for the man page (defaults to 1):
`help2man {{executable}} --section {{section}}`
- Output to a file instead of stdout:
2018-05-10 15:45:31 +01:00
`help2man {{executable}} --output {{path/to/file}}`
- Display detailed help:
`help2man --help`