generate manpages

14 files changed, 465 insertions, 0 deletions

diff --git a/doc/gen_manpage.go b/doc/gen_manpage.go
new file mode 100644
index 00000000..e5a38b3a
--- /dev/null
+++ b/doc/gen_manpage.go
@@ -0,0 +1,29 @@
+// +build ignore
+
+package main
+
+import (
+	"fmt"
+	"github.com/MichaelMure/git-bug/commands"
+	"github.com/spf13/cobra/doc"
+	"log"
+	"os"
+	"path"
+)
+
+func main() {
+	cwd, _ := os.Getwd()
+	filepath := path.Join(cwd, "doc", "man")
+
+	header := &doc.GenManHeader{
+		Title:   "MINE",
+		Section: "3",
+	}
+
+	fmt.Println("Generating manpage ...")
+
+	err := doc.GenManTree(commands.RootCmd, header, filepath)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
diff --git a/doc/man/git-bug-close.3 b/doc/man/git-bug-close.3
new file mode 100644
index 00000000..1e5d9177
--- /dev/null
+++ b/doc/man/git-bug-close.3
@@ -0,0 +1,34 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-close \- Mark the bug as closed
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug close <id> [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Mark the bug as closed
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for close
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-commands.3 b/doc/man/git-bug-commands.3
new file mode 100644
index 00000000..c040f1e0
--- /dev/null
+++ b/doc/man/git-bug-commands.3
@@ -0,0 +1,38 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-commands \- Display available commands
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug commands [<option>\&...] [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Display available commands
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for commands
+
+.PP
+\fB\-p\fP, \fB\-\-pretty\fP[=false]
+    Output the command description as well as Markdown compatible comment
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-comment.3 b/doc/man/git-bug-comment.3
new file mode 100644
index 00000000..519b08e2
--- /dev/null
+++ b/doc/man/git-bug-comment.3
@@ -0,0 +1,42 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-comment \- Add a new comment to a bug
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug comment <id> [<options>\&...] [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Add a new comment to a bug
+
+
+.SH OPTIONS
+.PP
+\fB\-F\fP, \fB\-\-file\fP=""
+    Take the message from the given file. Use \- to read the message from the standard input
+
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for comment
+
+.PP
+\fB\-m\fP, \fB\-\-message\fP=""
+    Provide the new message from the command line
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-label.3 b/doc/man/git-bug-label.3
new file mode 100644
index 00000000..7329fa3d
--- /dev/null
+++ b/doc/man/git-bug-label.3
@@ -0,0 +1,38 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-label \- Manipulate bug's label
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug label [<option>\&...] <id> [<label>\&...] [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Manipulate bug's label
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for label
+
+.PP
+\fB\-r\fP, \fB\-\-remove\fP[=false]
+    Remove a label
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-ls.3 b/doc/man/git-bug-ls.3
new file mode 100644
index 00000000..32201079
--- /dev/null
+++ b/doc/man/git-bug-ls.3
@@ -0,0 +1,34 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-ls \- Display a summary of all bugs
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug ls [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Display a summary of all bugs
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for ls
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-new.3 b/doc/man/git-bug-new.3
new file mode 100644
index 00000000..eb421f34
--- /dev/null
+++ b/doc/man/git-bug-new.3
@@ -0,0 +1,42 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-new \- Create a new bug
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug new <title> [<option>\&...] [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Create a new bug
+
+
+.SH OPTIONS
+.PP
+\fB\-F\fP, \fB\-\-file\fP=""
+    Take the message from the given file. Use \- to read the message from the standard input
+
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for new
+
+.PP
+\fB\-m\fP, \fB\-\-message\fP=""
+    Provide a message to describe the issue
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-open.3 b/doc/man/git-bug-open.3
new file mode 100644
index 00000000..0d509d5d
--- /dev/null
+++ b/doc/man/git-bug-open.3
@@ -0,0 +1,34 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-open \- Mark the bug as open
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug open <id> [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Mark the bug as open
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for open
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-pull.3 b/doc/man/git-bug-pull.3
new file mode 100644
index 00000000..54cb7133
--- /dev/null
+++ b/doc/man/git-bug-pull.3
@@ -0,0 +1,34 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-pull \- Pull bugs update from a git remote
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug pull [<remote>] [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Pull bugs update from a git remote
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for pull
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-push.3 b/doc/man/git-bug-push.3
new file mode 100644
index 00000000..d6a6174d
--- /dev/null
+++ b/doc/man/git-bug-push.3
@@ -0,0 +1,34 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-push \- Push bugs update to a git remote
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug push [<remote>] [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Push bugs update to a git remote
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for push
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-show.3 b/doc/man/git-bug-show.3
new file mode 100644
index 00000000..7d8391ac
--- /dev/null
+++ b/doc/man/git-bug-show.3
@@ -0,0 +1,34 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-show \- Display the details of a bug
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug show <id> [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Display the details of a bug
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for show
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug-webui.3 b/doc/man/git-bug-webui.3
new file mode 100644
index 00000000..fabf2750
--- /dev/null
+++ b/doc/man/git-bug-webui.3
@@ -0,0 +1,34 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug\-webui \- Launch the web UI
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug webui [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+Launch the web UI
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for webui
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/doc/man/git-bug.3 b/doc/man/git-bug.3
new file mode 100644
index 00000000..d88c6166
--- /dev/null
+++ b/doc/man/git-bug.3
@@ -0,0 +1,37 @@
+.TH "MINE" "3" "Jul 2018" "Auto generated by spf13/cobra" "" 
+.nh
+.ad l
+
+
+.SH NAME
+.PP
+git\-bug \- A bugtracker embedded in Git
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+git\-bug is a bugtracker embedded in git.
+
+.PP
+It use the same internal storage so it doesn't pollute your project. As you would do with commits and branches, you can push your bugs to the same git remote your are already using to collaborate with other peoples.
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+    help for git\-bug
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug\-close(3)\fP, \fBgit\-bug\-commands(3)\fP, \fBgit\-bug\-comment(3)\fP, \fBgit\-bug\-label(3)\fP, \fBgit\-bug\-ls(3)\fP, \fBgit\-bug\-new(3)\fP, \fBgit\-bug\-open(3)\fP, \fBgit\-bug\-pull(3)\fP, \fBgit\-bug\-push(3)\fP, \fBgit\-bug\-show(3)\fP, \fBgit\-bug\-webui(3)\fP
+
+
+.SH HISTORY
+.PP
+20\-Jul\-2018 Auto generated by spf13/cobra
diff --git a/git-bug.go b/git-bug.go
index b7c368d4..42b0855d 100644
--- a/git-bug.go
+++ b/git-bug.go
@@ -1,5 +1,6 @@
 //go:generate go run pack_webui.go
 //go:generate go run doc/gen_markdown.go
+//go:generate go run doc/gen_manpage.go
 
 package main