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 detailed help:
help2man --help
License and Disclaimer
The content on this page is copyright © 2014—present the tldr-pages team and contributors.This page is used with permission under Creative Commons Attribution 4.0 International License.
While we do attempt to make sure content is accurate, there isn't a warranty of any kind.