Documentation
¶
Index ¶
- func GenMan(cmd *cobra.Command, header *GenManHeader, w io.Writer) error
- func GenManTree(cmd *cobra.Command, header *GenManHeader, dir string) error
- func GenManTreeFromOpts(cmd *cobra.Command, opts GenManTreeOptions) error
- func GenMarkdown(cmd *cobra.Command, w io.Writer) 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
- func GenReST(cmd *cobra.Command, w io.Writer) error
- func GenReSTCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string, string) string) error
- func GenReSTTree(cmd *cobra.Command, dir string) error
- func GenReSTTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string) string, ...) error
- func GenYaml(cmd *cobra.Command, w io.Writer) error
- func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error
- func GenYamlTree(cmd *cobra.Command, dir string) error
- func GenYamlTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error
- type GenManHeader
- type GenManTreeOptions
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenMan ¶
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.
Example ¶
package main
import (
"bytes"
"fmt"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
func main() {
cmd := &cobra.Command{
Use: "test",
Short: "my test program",
}
header := &doc.GenManHeader{
Title: "MINE",
Section: "3",
}
out := new(bytes.Buffer)
cobra.CheckErr(doc.GenMan(cmd, header, out))
fmt.Print(out.String())
}
Output:
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`.
Example ¶
package main
import (
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
func main() {
cmd := &cobra.Command{
Use: "test",
Short: "my test program",
}
header := &doc.GenManHeader{
Title: "MINE",
Section: "3",
}
cobra.CheckErr(doc.GenManTree(cmd, header, "/tmp"))
}
Output:
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 ¶
GenMarkdown creates markdown output.
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`.
func GenMarkdownTreeCustom ¶
func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error
GenMarkdownTreeCustom is the the same as GenMarkdownTree, but with custom filePrepender and linkHandler.
func GenReSTCustom ¶
GenReSTCustom creates custom reStructured Text output.
func GenReSTTree ¶
GenReSTTree will generate a ReST page for this command and all descendants in the directory given. 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 GenReSTTreeCustom ¶
func GenReSTTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string) string, linkHandler func(string, string) string) error
GenReSTTreeCustom is the the same as GenReSTTree, but with custom filePrepender and linkHandler.
func GenYamlCustom ¶
GenYamlCustom creates custom yaml output.
func GenYamlTree ¶
GenYamlTree creates yaml structured ref files for this command and all descendants in the directory given. 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.
type GenManTreeOptions ¶
type GenManTreeOptions struct {
Header *GenManHeader
Path string
CommandSeparator string
}
GenManTreeOptions is the options for generating the man pages. Used only in GenManTreeFromOpts.
Source Files