summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/spf13/cobra/doc/man_docs.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/spf13/cobra/doc/man_docs.md')
-rw-r--r--vendor/github.com/spf13/cobra/doc/man_docs.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/vendor/github.com/spf13/cobra/doc/man_docs.md b/vendor/github.com/spf13/cobra/doc/man_docs.md
new file mode 100644
index 000000000..d568d9a03
--- /dev/null
+++ b/vendor/github.com/spf13/cobra/doc/man_docs.md
@@ -0,0 +1,26 @@
+# 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 (
+ "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",
+ }
+ doc.GenManTree(cmd, header, "/tmp")
+}
+```
+
+That will get you a man page `/tmp/test.3`