lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-24 01:02:09 +02:00
Code Activity
tldr/pages/common/help2man.md
Vitor Henrique 46a054215a
pages*: make help and version commands comply with the style guide (#12107) 
* pages*: use generic word for help

* git: add newline to the end

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* pages*: make help and version commands comply with the style guide

* java: fix Java name

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-01-30 12:55:24 +08:00

551 B
Raw Blame History

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