All Posts programming cheat-sheet of help2man

cheat-sheet of help2man

· 124 words · 1 minute read

help2man is a tool to produce simple man pages from an executable’s --help and --version output.

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

More information: https://www.gnu.org/software/help2man .

I hope you enjoyed reading this post as much as I enjoyed writing it. If you know a person who can benefit from this information, send them a link of this post. If you want to get notified about new posts, follow me on YouTube , Twitter (x) , LinkedIn , and GitHub .