help2man

Produce simple man pages from an executable's --help and --version output. More information: <https://www.gnu.org/software/help2man>.

Install

All systems
curl cmd.cat/help2man.sh
Debian Debian
apt-get install help2man
Ubuntu
apt-get install help2man
Alpine
apk add help2man
Arch Arch Linux
pacman -S help2man
image/svg+xml Kali Linux
apt-get install help2man
CentOS
yum install help2man
Fedora
dnf install help2man
Windows (WSL2)
sudo apt-get update sudo apt-get install help2man
OS X
brew install help2man
Raspbian
apt-get install help2man
Dockerfile
dockerfile.run/help2man
Docker
docker run cmd.cat/help2man help2man powered by Commando

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

© tl;dr; authors and contributors