cobra/doc/man_docs.md

32 lines
519 B
Markdown
Raw Normal View History

2015-08-18 22:33:41 +00:00
# Generating Man Pages For Your Own cobra.Command
Generating man pages from a cobra command is incredibly easy. An example is as follows:
2015-08-18 22:33:41 +00:00
```go
package main
import (
"log"
2015-08-18 22:33:41 +00:00
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
2015-08-18 22:33:41 +00:00
)
func main() {
cmd := &cobra.Command{
Use: "test",
Short: "my test program",
}
2016-11-15 14:16:05 +00:00
header := &doc.GenManHeader{
Title: "MINE",
Section: "3",
}
err := doc.GenManTree(cmd, header, "/tmp")
if err != nil {
log.Fatal(err)
}
2015-08-18 22:33:41 +00:00
}
```
2016-11-15 14:16:05 +00:00
That will get you a man page `/tmp/test.3`