doc

package
v0.0.0-...-b625668 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 14, 2016 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenMan

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

GenMan will generate a man page for the given command and write it to w. The header argument may be nil, however obviously w may not.

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 GenManTreeFromOpts

func GenManTreeFromOpts(cmd *cobra.Command, opts GenManTreeOptions) error

GenManTreeFromOpts generates a man page for the command and all descendants. The pages are written to the opts.Path directory.

func GenMarkdown

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

func GenMarkdownCustom

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

func GenMarkdownTree

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

func GenMarkdownTreeCustom

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

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.

type GenManTreeOptions

type GenManTreeOptions struct {
	Header           *GenManHeader
	Path             string
	CommandSeparator string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL