Hulk did something

[bytom/vapor.git] / vendor / github.com / spf13 / cobra / doc / man_docs.md

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 (file)
index 0000000..3709160
--- /dev/null
+++ b/vendor/github.com/spf13/cobra/doc/man_docs.md
@@ -0,0 +1,31 @@
+# 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`