mirror of
https://github.com/ivuorinen/cheatsheet-tldr.git
synced 2026-01-30 22:41:36 +00:00
30 lines
644 B
Plaintext
30 lines
644 B
Plaintext
---
|
|
syntax: markdown
|
|
tags: [tldr, common]
|
|
source: https://github.com/tldr-pages/tldr.git
|
|
---
|
|
# 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:
|
|
|
|
`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`:
|
|
|
|
`help2man {{executable}} --output {{path/to/file}}`
|
|
|
|
- Display help:
|
|
|
|
`help2man --help`
|