glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-16 02:37:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
spf13--cobra/man_docs.md
Eric Paris edcf765d9f Mangen: allow callers to specify header information 
We previously had this weak argument called projectName which let you
set a single part of a man page header. Instead do the best we can if
the caller doesn't pass us anything, but let the caller specify anything
they want.
2015-09-08 18:52:09 -04:00

441 B
Raw Blame History

Generating Man Pages For Your Own cobra.Command

Generating bash completions from a cobra command is incredibly easy. An example is as follows:

package main

import (
	"github.com/spf13/cobra"
)

func main() {
	cmd := &cobra.Command{
		Use:   "test",
		Short: "my test program",
	}
	header := &cobra.GenManHeader{
		Title: "MINE",
		Section: "3",
	}
	cmd.GenManTree(header, "/tmp")
}

That will get you a man page /tmp/test.1