Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenManTree ¶
GenManTree will generate a man page for this command and all descendants in the directory given. The header may be nil. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third` it is undefined which help output will be in the file `cmd-sub-third.1`.
Types ¶
type GenManHeader ¶
type GenManHeader struct { Title string Section string Date *time.Time Source string Manual string }
GenManHeader is a lot like the .TH header at the start of man pages. These include the title, section, date, source, and manual. We will use the current time if Date is unset.
type GenManTreeOptions ¶
GenManTreeOptions is the options for generating the man pages. Used only in GenManTreeFromOpts.
Click to show internal directories.
Click to hide internal directories.