diff options
Diffstat (limited to 'doc/git-todo.1')
-rw-r--r-- | doc/git-todo.1 | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/git-todo.1 b/doc/git-todo.1 new file mode 100644 index 0000000..3bff60b --- /dev/null +++ b/doc/git-todo.1 @@ -0,0 +1,63 @@ +'\" t +.\" Title: git-todo +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/03/2020 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "GIT\-TODO" "1" "10/03/2020" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +git-todo \- Output recent TODO lines +.SH "SYNOPSIS" +.sp +\fIgit todo\fR [options] [<ref>] +.SH "DESCRIPTION" +.sp +Find TODO lines and output them in a grep\-style format including the name of the file containing them and their line number\&. +.sp +By default, outputs all TODO lines since \fBmaster\fR\&. +.SH "OPTIONS" +.PP +\-h, \-\-help +.RS 4 +Print usage help\&. +.RE +.PP +\-V, \-\-version +.RS 4 +Print the program version\&. +.RE +.SH "EXAMPLES" +.sp +Show TODOs since the \fBv1\&.0\&.0\fR tag: +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ git todo v1\&.0\&.0 +.fi +.if n \{\ +.RE +.\} |