update manpage

doc/tagsearch.1

@@ -0,0 +1,138 @@
+.\" Automatically generated by Pandoc 2.11.3
+.\"
+.TH "tagsearch" "1" "2021-03-21" "Search and report on tags" ""
+.hy
+.SH NAME
+.PP
+tagsearch
+.SH SYNOPSIS
+\fBtagsearch\fR [\fB\--root\fR \fIroot\fR] \fICOMMAND\fR [\fICOMMAND-OPTIONS\fR] [\fICOMMAND-FLAGS\fR]
+.PP
+.RS 4
+\fIroot\fR is a different root directory. Otherwise, \fBtagsearch\fR will 
+operate on all files under the current directory.
+.RE
+
+.SH COMMANDS
+\fIfile-tags\fR [\fB\-c|--count\fR] [\fIfiles...\fR]
+.RS 4
+Show the tags from each file. \fI\-\-count\fR will show how many times each file is used across these files
+.RE
+.PP
+\fIfiles\fR [\fB\-o|\-\-or\fR] [\fB\-\-vim\fR] [\fB\-\-not\fR \fInot...\fR] [\fItags...\fR]
+.RS 4
+\fB\-o\fR will match \fIANY\fR, rather than \fIALL\fR, tags
+.P
+\fB\-\-vim\fR will output a format suitable for use with \fBvimgrep\fR.
+.P
+\fB\-\-not\fR \fInot...\fR will exclude results which have '\fInot\fR' tags
+.P
+\fItags...\fR is the tags you want to find files for.
+.RE
+.PP
+\fIhelp\fR
+.RS 4
+Display a brief help string listing available commands
+.RE
+
+.PP
+\fIsimilar-tags\fR
+.RS 4
+Show tags that are potential near-duplicates (mainly searches for differences in pluralisation)
+.RE
+
+.PP
+\fItags\fR [\fIOPTIONS\fR] [\fIFLAGS\fR] [\fB\-\-not\fR \fInot...\fR] [\fITAGS...\fR]
+.RS 4
+Show all tags from files with tags that match filter words
+.RE
+.PP
+\fIuntagged\fR
+.RS 4
+description
+.RE
+
+.SH DESCRIPTION
+Search for all \f[B]keyword\f[R] tags for files under the current directory.
+
+.SH FLAGS
+.TP
+\f[B]-c\f[R], \f[B]--count\f[R]
+Show count of tags
+.TP
+\f[B]-h\f[R], \f[B]--help\f[R]
+Prints help information
+.TP
+\f[B]-l\f[R], \f[B]--list\f[R]
+List all tags for files matching keywords
+.TP
+\f[B]--long\f[R]
+Long list (e.g.\ tall) all tags for files matching keywords
+.TP
+\f[B]-o\f[R], \f[B]--or-filter\f[R]
+Filter using ANY, rather than ALL keywords
+.TP
+\f[B]--similar-tags\f[R]
+Show similar tags
+.TP
+\f[B]-u\f[R], \f[B]--untagged\f[R]
+Show untagged files
+.TP
+\f[B]-V\f[R], \f[B]--version\f[R]
+Prints version information
+.TP
+\f[B]-v\f[R], \f[B]--vim\f[R]
+Output format suitable for vim quickfix
+.TP
+\f[B]--not NOT\&...\f[R]
+Keywords to inverse filter (i.e.\ ignore matching files)
+.SH NOTES
+.PP
+A \f[B]tag\f[R] is something that matches the regexp
+\f[B]\[at][a-zA-Z1-9]+\f[R], i.e.\ \f[B]\[at]\f[R] followed by anything
+\f[B]alphanumeric\f[R].
+.IP
+.nf
+\f[C]
+\[at]rust
+\[at]linux
+\[at]c99
+\f[R]
+.fi
+
+.SH EXAMPLES
+
+.IP 1
+Find all files in the current directory tagged \fB@stoicism\fR \fIand\fR \fB@philosophy\fR
+.nf
+\fBtagsearch files\fR \fIstoicism\fR \fIphilosophy\fR
+.fi
+.PP
+
+.IP 2 
+Find all files in the current directory tagged \fIeither\fR \fB@rust\fR or \fB@golang\fR
+.nf
+\fBtagsearch files\fR \fI\-\-or\fR \fIrust\fR \fIgolang\fR
+.fi
+.PP
+
+
+.IP 3
+List all tags in the current directory
+.nf
+\fBtagsearch tags\fR
+.fi
+.PP
+
+.IP 4
+List all tags in a different directory
+.nf
+\fBtagsearch --root\fR \fI~/somewhere/ tags\fR
+.fi
+
+
+
+
+.SH AUTHORS
+.PP
+Chris Davison <c.jr.davison@gmail.com>