spf13--cobra/man_docs.md

# Generating Man Pages For Your Own cobra.Command

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

```go
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`
Auto generation of a man page 2015-08-18 15:33:41 -07:00			`# Generating Man Pages For Your Own cobra.Command`

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

			```go
			`package main`

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

			`func main() {`
			`cmd := &cobra.Command{`
			`Use: "test",`
			`Short: "my test program",`
			`}`
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 16:02:02 -04:00			`header := &cobra.GenManHeader{`
			`Title: "MINE",`
			`Section: "3",`
			`}`
			`cmd.GenManTree(header, "/tmp")`
Auto generation of a man page 2015-08-18 15:33:41 -07:00			`}`
			```

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