shellnotes/docs/manpages/notegrep.1

80 lines
1.6 KiB
Groff
Raw Normal View History

2021-06-29 08:47:29 +02:00
.\" Manpage for shellnotes-notegrep.
2021-07-01 19:03:45 +02:00
.\" Contact dmarakom@gmail.com to correct errors or typos.
2021-06-29 08:47:29 +02:00
.TH notegrep 1
.SH NAME
shellnotes-notegrep \- manipulate notes with grep tools
.SH SYNOPSIS
.PP
.B notegrep
[\fIPATTERN\fR]
2021-07-01 19:03:45 +02:00
.IR [FILE...]
2021-06-29 08:47:29 +02:00
.PP
.B notegrep
[\fIOPTION\fR]
2021-07-01 17:22:41 +02:00
[\fIPATTERN\fR]
2021-07-01 19:03:45 +02:00
.IR [FILE...]
2021-06-29 08:47:29 +02:00
.PP
.B notegrep
[\fIOPTION\fR]
2021-07-01 19:03:45 +02:00
.IR [FILE...]
2021-07-01 17:22:41 +02:00
.PP
.B notegrep
[\fIOPTION\fR]
[\fIPATTERN\fR]
2021-07-01 19:03:45 +02:00
2021-07-03 09:38:49 +02:00
.\".PP
.\".B notegrep
.\"[\fI-m\fR]
.\"[\fI*PATTERN(S)\fR]
.\".IR [*FILE(S)...]
2021-06-29 08:47:29 +02:00
.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.
2021-07-03 09:38:49 +02:00
.TP
.BR \-m ", " \--multiple =\fISTRING\fR
Search for more than one patterns in multiple files simultaneously. Each pattern or file must have a comma before the next one. Example: "notegrep -m file1,file2,file3 pattern1,pattern2,pattern3".
2021-07-01 17:22:41 +02:00
.\".SH BUGS
2021-06-29 08:47:29 +02:00
2021-07-01 16:56:37 +02:00
.\".TP
.\".BR \Withoutstringbug ", " \-wsBug ", " \72
.\"If there are no matches in the input, "notegrep -ws" will display the file as is.
2021-06-29 08:47:29 +02:00
.SH AUTHOR
Dimitris Marakomihelakis (dmarakom@gmail.com)