shellnotes/docs/manpages/notegrep.1
2021-08-21 20:43:07 +03:00

73 lines
1.5 KiB
Groff

.\" Manpage for shellnotes-notegrep.
.\" Contact dmarakom@gmail.com to correct errors or typos.
.TH notegrep 1
.SH NAME
shellnotes-notegrep \- manipulate notes with grep tools
.SH SYNOPSIS
.PP
.B notegrep
[\fIPATTERN\fR]
.IR [FILE...]
.PP
.B notegrep
[\fIOPTION\fR]
[\fIPATTERN\fR]
.IR [FILE...]
.PP
.B notegrep
[\fIOPTION\fR]
.IR [FILE...]
.PP
.B notegrep
[\fIOPTION\fR]
[\fIPATTERN\fR]
.SH DESCRIPTION
.B notegrep
uses grep to change the ways your notes are displayed.
.SH OPTIONS
.TP
.BR \-sc ", " \--split-char =\fISTRING\fR
Split the note on a string or character and then display it.
.TP
.BR \-cl ", " \--count-lines =\fISTRING\fR
Count the matching lines of a file.
Asks user to show these lines by default.
.TP
.BR \-sl ", " \--show-lines =\fISTRING\fR
Show the matching lines of a file.
.TP
.BR \-cf ", " \--count-files =\fISTRING\fR
Count how many files contain a pattern.
Asks user to show these files by default.
.TP
.BR \-sf ", " \--show-files =\fISTRING\fR
Show the files with a matching pattern.
.TP
.BR \-ws ", " \--without-string =\fISTRING\fR
Display lines WITHOUT matches.
.TP
.BR \-m ", " \--multiple =\fISTRING\fR
Display multiple matches in more than one files in the Notes folder. Use '.' for all files, not '*' (See BUGS).
.SH BUGS
.TP
.BR \GrepAllFilesBug ", " \-gafBug ", " \71
"*" doesn't work as a selector for all the files in the Notes folder when running "notegrep -m". Use '.' instead
.SH AUTHOR
Dimitris Marakomihelakis (dmarakom@gmail.com)