summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorTim Oram <dev@mitmaro.ca>2018-04-01 12:05:01 -0230
committerTim Oram <dev@mitmaro.ca>2018-04-01 12:06:03 -0230
commitfc961e1a560a298aa5acfbec0d6a31fecdca6af2 (patch)
tree3acb0e8aa600f4a385ab926aefc194f358008437 /src
parentb369acdc7d2a018d28c73b29866b0f98611f0bc1 (diff)
Update documentation
Diffstat (limited to 'src')
-rw-r--r--src/interactive-rebase-tool.147
1 files changed, 34 insertions, 13 deletions
diff --git a/src/interactive-rebase-tool.1 b/src/interactive-rebase-tool.1
index cf41e80..ff17b84 100644
--- a/src/interactive-rebase-tool.1
+++ b/src/interactive-rebase-tool.1
@@ -1,26 +1,47 @@
.\" Manpage for interactive-rebase-tool.
-.\" Contact dev@mitmaro.ca to correct errors or typos.
-.TH INTERACTIVE\-REBASE 1 "02/02/2018" "v0.5.0" "Git Manual"
+
+.TH INTERACTIVE\-REBASE\-TOOL 1 "" "" ""
+
.SH NAME
-interactive-rebase-tool \- an improved sequence editor for git
+interactive-rebase-tool \- full featured sequence editor for git
+
.SH SYNOPSIS
-.nf
-\fIinteractive-rebase-tool\fR <rebase-todo-filepath>
-\fIinteractive-rebase-tool\fR --version | -v
-.fi
+
+.B interactive-rebase-tool
+<\fIrebase-todo-filepath\fR>
+.br
+.B interactive-rebase-tool
+[\fIoptions\fR]
+
.SH DESCRIPTION
-Full feature terminal based sequence editor for git interactive rebase.
-To configure git to use it by default for interactive rebasing
-(i.e. with \fBgit rebase \-i\fR), use
+Native cross platform full feature terminal based sequence editor for git interactive rebase.
+
+To configure git to use it by default for interactive rebasing (i.e. with \fBgit rebase \-\-interactive\fR), use:
.sp
.nf
-\fIgit config\fR --global sequence.editor interactive-rebase-tool
+.in 16
+git config --global sequence.editor interactive-rebase-tool
.fi
+.in 8
.sp
-Press ? during use for a summary of commands.
+
+.SH OPTIONS
+.TP
+\fB\-\-help\fR
+Prints help information
+.TP
+\fB\-\-version\fR
+Prints version information
+
+.SH ON-LINE HELP
+
+Press \fB?\fR during use for a summary of commands.
+
.SH SEE ALSO
git(1)
+
.SH BUGS
-No known bugs.
+See: <https://github.com/MitMaro/git-interactive-rebase-tool/issues>
+
.SH AUTHOR
Tim Oram (dev@mitmaro.ca)