help2man

all

Produce simple man pages from an executable's `--help` and `--version` output.

Options (3)

-n, --nameboolean

Specify the "name" paragraph in the man page

Example: help2man {{executable}} {{[-n|--name]}} {{name}}

-s, --sectionboolean

Specify the section for the man page (defaults to 1)

Example: help2man {{executable}} {{[-s|--section]}} {{section}}

-o, --outputboolean

Output to a file instead of `stdout`

Example: help2man {{executable}} {{[-o|--output]}} {{path/to/file}}

Generate a man page for an executable

help2man executable

Specify the "name" paragraph in the man page

help2man executable [-n|--name] name

Specify the section for the man page (defaults to 1)

help2man executable [-s|--section] section

Output to a file instead of `stdout`

help2man executable [-o|--output] path/to/file

Display help

help2man --help