mblaze/man/magrep.1

.Dd February 15, 2017
.Dt MAGREP 1
.Os
.Sh NAME
.Nm magrep
.Nd search messages matching a pattern
.Sh SYNOPSIS
.Nm
.Op Fl c | Fl q | Fl m Ar max
.Op Fl v
.Op Fl i
.Op Fl a | Fl d
.Ar header Ns Cm \&: Ns Ar regex
.Op Ar msgs\ ...
.Sh DESCRIPTION
.Nm
prints the names of files from the specified
.Ar msgs
if the value of
.Ar header
matches the POSIX Extended Regular Expression
.Ar regex .
.Po
See
.Xr mmsg 7
for the message argument syntax.
.Pc
.Pp
If
.Ar header
is empty,
.Nm
matches against the maildir flags of
.Ar msgs .
.Pp
If
.Ar header
is
.Sq Cm \&/ ,
.Nm
searches any plain text parts of the
.Ar msgs
body.
.Pp
If no
.Ar msgs
are specified and
.Nm
is used interactively,
the current sequence will be searched.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl a
Search for
.Ar regex
in RFC 2822 address
.Ar header
parts only.
.It Fl c
Only print a count of matching messages.
.It Fl d
Decode the
.Ar header
according to RFC 2047 prior to searching.
.It Fl i
Match
.Ar regex
case insensitively.
.It Fl m Ar max
Do not show more than
.Ar max
matches.
.It Fl o
Print each match only,
not the entire line.
This option is ignored if
.Fl c ,
.Fl q
or
.Fl v
is specified.
.It Fl p
Print the filename,
the header and the matching line
for each of the matched
.Ar msgs .
If
.Fl o
is specified each match is printed,
instead of the matching line.
This option is ignored if
.Fl c ,
.Fl q
or
.Fl v
is specified.
.It Fl q
Quiet mode: do not print anything,
quit as soon as possible.
.It Fl v
Invert the match; print (or count) all files where
.Ar regex
does not match.
.El
.Sh EXIT STATUS
The
.Nm
utility exits 0 on success, 1 if no match was found
and >1 if an error occurs.
.Sh SEE ALSO
.Xr grep 1 ,
.Xr mmsg 7 ,
.Xr regex 7
.Sh AUTHORS
.An Leah Neukirchen Aq Mt leah@vuxu.org
.Sh TRIVIA
.Nm
is not called mgrep because many tools with this name already exist.
.Sh LICENSE
.Nm
is in the public domain.
.Pp
To the extent possible under law,
the creator of this work
has waived all copyright and related or
neighboring rights to this work.
.Pp
.Lk http://creativecommons.org/publicdomain/zero/1.0/
magrep: add -p to print matches and the context and -o to only print matches 2017-02-15 17:28:42 +00:00			`.Dd February 15, 2017`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Dt MAGREP 1`
			`.Os`
			`.Sh NAME`
			`.Nm magrep`
magrep.1: update wording Closes: #90 [via git-merge-pr] 2018-01-28 23:32:43 +00:00			`.Nd search messages matching a pattern`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Sh SYNOPSIS`
			`.Nm`
magrep: add -m 2016-08-02 15:03:32 +00:00			`.Op Fl c \| Fl q \| Fl m Ar max`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Op Fl v`
			`.Op Fl i`
			`.Op Fl a \| Fl d`
man: fix rendering with groff Closes #32. 2017-05-17 12:05:18 +00:00			`.Ar header Ns Cm \&: Ns Ar regex`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Op Ar msgs\ ...`
			`.Sh DESCRIPTION`
			`.Nm`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`prints the names of files from the specified`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Ar msgs`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`if the value of`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Ar header`
			`matches the POSIX Extended Regular Expression`
			`.Ar regex .`
magrep.1: update wording Closes: #90 [via git-merge-pr] 2018-01-28 23:32:43 +00:00			`.Po`
			`See`
			`.Xr mmsg 7`
			`for the message argument syntax.`
			`.Pc`
magrep: add search in body 2016-08-02 14:28:35 +00:00			`.Pp`
add magrep.1 2016-08-02 14:02:29 +00:00			`If`
			`.Ar header`
			`is empty,`
			`.Nm`
magrep.1: update wording Closes: #90 [via git-merge-pr] 2018-01-28 23:32:43 +00:00			`matches against the maildir flags of`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`.Ar msgs .`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Pp`
magrep: add search in body 2016-08-02 14:28:35 +00:00			`If`
			`.Ar header`
			`is`
man: fix rendering with groff Closes #32. 2017-05-17 12:05:18 +00:00			`.Sq Cm \&/ ,`
magrep: add search in body 2016-08-02 14:28:35 +00:00			`.Nm`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`searches any plain text parts of the`
			`.Ar msgs`
			`body.`
magrep: add search in body 2016-08-02 14:28:35 +00:00			`.Pp`
add magrep.1 2016-08-02 14:02:29 +00:00			`If no`
			`.Ar msgs`
magrep.1: update wording Closes: #90 [via git-merge-pr] 2018-01-28 23:32:43 +00:00			`are specified and`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Nm`
			`is used interactively,`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`the current sequence will be searched.`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Pp`
			`The options are as follows:`
			`.Bl -tag -width Ds`
			`.It Fl a`
			`Search for`
			`.Ar regex`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`in RFC 2822 address`
			`.Ar header`
			`parts only.`
add magrep.1 2016-08-02 14:02:29 +00:00			`.It Fl c`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`Only print a count of matching messages.`
add magrep.1 2016-08-02 14:02:29 +00:00			`.It Fl d`
			`Decode the`
			`.Ar header`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`according to RFC 2047 prior to searching.`
add magrep.1 2016-08-02 14:02:29 +00:00			`.It Fl i`
			`Match`
			`.Ar regex`
			`case insensitively.`
magrep: add -m 2016-08-02 15:03:32 +00:00			`.It Fl m Ar max`
			`Do not show more than`
			`.Ar max`
			`matches.`
magrep: add -p to print matches and the context and -o to only print matches 2017-02-15 17:28:42 +00:00			`.It Fl o`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`Print each match only,`
magrep: add -p to print matches and the context and -o to only print matches 2017-02-15 17:28:42 +00:00			`not the entire line.`
			`This option is ignored if`
magrep.1: fix lint 2017-05-15 13:08:03 +00:00			`.Fl c ,`
magrep: add -p to print matches and the context and -o to only print matches 2017-02-15 17:28:42 +00:00			`.Fl q`
			`or`
			`.Fl v`
			`is specified.`
			`.It Fl p`
man: use 'filename' instead of 'file names' 2017-07-02 16:22:51 +00:00			`Print the filename,`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`the header and the matching line`
			`for each of the matched`
			`.Ar msgs .`
magrep: add -p to print matches and the context and -o to only print matches 2017-02-15 17:28:42 +00:00			`If`
			`.Fl o`
			`is specified each match is printed,`
			`instead of the matching line.`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`This option is ignored if`
magrep.1: fix lint 2017-05-15 13:08:03 +00:00			`.Fl c ,`
magrep: add -p to print matches and the context and -o to only print matches 2017-02-15 17:28:42 +00:00			`.Fl q`
			`or`
			`.Fl v`
			`is specified.`
add magrep.1 2016-08-02 14:02:29 +00:00			`.It Fl q`
			`Quiet mode: do not print anything,`
			`quit as soon as possible.`
			`.It Fl v`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`Invert the match; print (or count) all files where`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Ar regex`
			`does not match.`
magrep.1: fix lint 2017-05-15 13:08:03 +00:00			`.El`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Sh EXIT STATUS`
magrep.1: Improve EXIT STATUS wording, in line with .Ex -std Closes: #53 [via git-merge-pr] 2017-07-01 16:46:39 +00:00			`The`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Nm`
magrep.1: Improve EXIT STATUS wording, in line with .Ex -std Closes: #53 [via git-merge-pr] 2017-07-01 16:46:39 +00:00			`utility exits 0 on success, 1 if no match was found`
Changes to magrep.1 - Try not to use 'messages msgs' - 'matches' instead of 'instead match' - 'specified' instead of 'passed' - Clarify default use of current sequence - Simplify some language used - List '-p' output in the order it is printed - Remove superfluous 'the' - Bring EXIT STATUS in line with '.Ex -std' Closes: #42 [via git-merge-pr] 2017-06-30 11:11:08 +00:00			`and >1 if an error occurs.`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Sh SEE ALSO`
			`.Xr grep 1 ,`
			`.Xr mmsg 7 ,`
			`.Xr regex 7`
			`.Sh AUTHORS`
Leahize 2017-01-21 16:17:12 +00:00			`.An Leah Neukirchen Aq Mt leah@vuxu.org`
add magrep.1 2016-08-02 14:02:29 +00:00			`.Sh TRIVIA`
			`.Nm`
			`is not called mgrep because many tools with this name already exist.`
			`.Sh LICENSE`
			`.Nm`
			`is in the public domain.`
			`.Pp`
			`To the extent possible under law,`
			`the creator of this work`
			`has waived all copyright and related or`
			`neighboring rights to this work.`
			`.Pp`
			`.Lk http://creativecommons.org/publicdomain/zero/1.0/`