doc

Documentation

Index

• func FlagUsages(f *pflag.FlagSet) string
• func GenAsciidoc(cmd *cobra.Command, w io.Writer) error
• func GenAsciidocCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error
• func GenAsciidocTree(cmd *cobra.Command, dir string) error
• func GenAsciidocTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error

Functions

func FlagUsages

func FlagUsages(f *pflag.FlagSet) string

FlagUsages returns a string containing the usage information for all flags in the FlagSet.

func GenAsciidoc

func GenAsciidoc(cmd *cobra.Command, w io.Writer) error

GenAsciidoc creates markdown output.

func GenAsciidocCustom

func GenAsciidocCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error

GenAsciidocCustom creates custom markdown output.

func GenAsciidocTree

func GenAsciidocTree(cmd *cobra.Command, dir string) error

GenAsciidocTree 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`.

func GenAsciidocTreeCustom

func GenAsciidocTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error

GenAsciidocTreeCustom is the the same as GenAsciidocTree, but with custom filePrepender and linkHandler.