package doc

import "github.com/spf13/cobra/doc"

Index

Examples

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.

Example

Code:play  

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())
}

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

Code:play  

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"))
}

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

GenMarkdown creates markdown output.

func GenMarkdownCustom 

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

GenMarkdownCustom creates custom markdown output.

func GenMarkdownTree 

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

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 same as GenMarkdownTree, but with custom filePrepender and linkHandler.

func GenReST 

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

GenReST creates reStructured Text output.

func GenReSTCustom 

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

GenReSTCustom creates custom reStructured Text output.

func GenReSTTree 

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

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 same as GenReSTTree, but with custom filePrepender and linkHandler.

func GenYaml 

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

GenYaml creates yaml output.

func GenYamlCustom 

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

GenYamlCustom creates custom yaml output.

func GenYamlTree 

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

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

func GenYamlTreeCustom 

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

GenYamlTreeCustom creates yaml structured ref files.

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

man_docs.go md_docs.go rest_docs.go util.go yaml_docs.go

Version
v1.9.1 (latest)
Published
Feb 16, 2025
Platform
linux/amd64
Imports
13 packages
Last checked
5 days ago –

Tools for package owners.