Documentation ¶
Index ¶
- func GenManTree(cmd *cobra.Command, header *GenManHeader, dir string) error
- func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error
- func GenMarkdownTree(cmd *cobra.Command, dir string) error
- func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error
- type GenManHeader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenManTree ¶
func GenManTree(cmd *cobra.Command, header *GenManHeader, dir string) error
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`.
func GenMarkdownCustom ¶
GenMarkdownCustom creates custom markdown output.
func GenMarkdownTree ¶
GenMarkdownTree will generate a markdown 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 // contains filtered or unexported fields }
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 and will use "Auto generated by spf13/cobra" if the Source is unset.