mirror of
https://github.com/spf13/cobra
synced 2024-11-10 15:57:09 +00:00
f95d58bdf3
* doc: Add and edit docs * doc: Add tests
519 B
519 B
Generating Man Pages For Your Own cobra.Command
Generating man pages from a cobra command is incredibly easy. An example is as follows:
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