Manpage

CLI2MAN(1)

General Commands Manual

CLI2MAN(1)

NAME

cli2man — Use the help message of a command to create a manpage.

SYNOPSIS

cli2man

(<command> | --input | --stdin) [options] [--option-section] [--info-section] [--set-order] [--gzip]

cli2man

--print-order [--set-order]

cli2man

--version

DESCRIPTION

Use the help message of a command to create a manpage.

OPTIONS

-h, --help

show this help message and exit

-m, --open-in-man

open the output in man

-z, --gzip

compress file output

-o FILE, --output FILE

write to file instead of stdout. when FILE is set to "auto" the format is: command.section(.gz)

-i FILE, --input FILE

read CLI-help input from file

--stdin

read CLI-help input from stdin

--info-section NAME

parse non-option sections

--option-section NAME

parse option sections other than "Options:"

-I FILE, --include FILE

include material from FILE

--print-order

prints section order default order if non is set by user

--set-order SECTIONS

comma separated list of sections

-s NUM, --section NUM

section number for manual page (default: 1)

--arch ARCH

set architecture for manual page

--os OS

operating system name

-T FORMAT

set output format (default: mdoc) -Tmarkdown EXPERIMENTAL -Tmdoc

--create-script FILE

creates manpage generation shell script based on current CLI-settings

-v, --version

display version information

December 1, 2014

Linux 3.18.0-rc5+