mirror of
https://github.com/Luzifer/ansible-role-version.git
synced 2024-12-24 03:21:20 +00:00
32 lines
519 B
Markdown
32 lines
519 B
Markdown
|
# Generating Man Pages For Your Own cobra.Command
|
||
|
|
|
||
|
|
Generating man pages from a cobra command is incredibly easy. An example is as follows:
|
||
|
|
|
||
|
|
```go
|
||
|
|
package main
|
||
|
|
|
||
|
|
import (
|
||
|
|
"log"
|
||
|
|
|
||
|
|
"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",
|
||
|
|
}
|
||
|
|
err := doc.GenManTree(cmd, header, "/tmp")
|
||
|
|
if err != nil {
|
||
|
|
log.Fatal(err)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
That will get you a man page `/tmp/test.3`
|