doc

Documentation

Index

• func GenMan(cmd *cobra.Command, header *GenManHeader, out io.Writer)
• func GenManTree(cmd *cobra.Command, header *GenManHeader, dir string)
• func GenMarkdown(cmd *cobra.Command, out io.Writer)
• func GenMarkdownCustom(cmd *cobra.Command, out io.Writer, linkHandler func(string) string)
• func GenMarkdownTree(cmd *cobra.Command, dir string)
• func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string) string, ...)
• type GenManHeader

Functions

func GenMan

func GenMan(cmd *cobra.Command, header *GenManHeader, out io.Writer)

GenMan will generate a man page for the given command in the out buffer. The header argument may be nil, however obviously out may not.

func GenManTree

func GenManTree(cmd *cobra.Command, header *GenManHeader, dir string)

GenManTree will generate a man page for this command and all decendants 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 GenMarkdown

func GenMarkdown(cmd *cobra.Command, out io.Writer)

func GenMarkdownCustom

func GenMarkdownCustom(cmd *cobra.Command, out io.Writer, linkHandler func(string) string)

func GenMarkdownTree

func GenMarkdownTree(cmd *cobra.Command, dir string)

func GenMarkdownTreeCustom

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

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 if unset and will use "Auto generated by spf13/cobra" if the Source is unset.