| 1 | .\" Hey, EMACS: -*- nroff -*- |
| 2 | .\" First parameter, NAME, should be all caps |
| 3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
| 4 | .\" other parameters are allowed: see man(7), man(1) |
| 5 | .TH EXIGREP 8 "March 26, 2003" |
| 6 | .\" Please adjust this date whenever revising the manpage. |
| 7 | .\" |
| 8 | .\" Some roff macros, for reference: |
| 9 | .\" .nh disable hyphenation |
| 10 | .\" .hy enable hyphenation |
| 11 | .\" .ad l left justify |
| 12 | .\" .ad b justify to both left and right margins |
| 13 | .\" .nf disable filling |
| 14 | .\" .fi enable filling |
| 15 | .\" .br insert line break |
| 16 | .\" .sp <n> insert n+1 empty lines |
| 17 | .\" for manpage-specific macros, see man(7) |
| 18 | .\" \(oqthis text is enclosed in single quotes\(cq |
| 19 | .\" \(lqthis text is enclosed in double quotes\(rq |
| 20 | .SH NAME |
| 21 | EXIGREP \- Search Exim's main log |
| 22 | .SH SYNOPSIS |
| 23 | .B exigrep |
| 24 | .I [\-l] pattern [log file] ... |
| 25 | |
| 26 | .SH DESCRIPTION |
| 27 | The |
| 28 | .B exigrep |
| 29 | utility is a Perl script that searches one or more main log files for |
| 30 | entries that match a given pattern. |
| 31 | When it finds a match, it extracts all the log entries for the relevant |
| 32 | message, not just those that match the pattern. |
| 33 | Thus, |
| 34 | .B exigrep |
| 35 | can extract complete log entries for a given message, or all mail for a given |
| 36 | user, or for a given host, for example. |
| 37 | |
| 38 | The |
| 39 | .I \-l |
| 40 | flag means \(oqliteral\(cq, that is, treat all characters in the pattern as |
| 41 | standing for themselves. |
| 42 | Otherwise the pattern must be a Perl regular expression. |
| 43 | The pattern match is case-insensitive. |
| 44 | If no file names are given on the command line, the standard input is |
| 45 | read. |
| 46 | |
| 47 | If the location of a |
| 48 | .B zcat |
| 49 | command is known from the definition of ZCAT_COMMAND in Local/Makefile, |
| 50 | .B exigrep |
| 51 | automatically passes any file whose |
| 52 | name ends in COMPRESS_SUFFIX through |
| 53 | .B zcat |
| 54 | as it searches it. |
| 55 | |
| 56 | .SH BUGS |
| 57 | This manual page needs a major re-work. If somebody knows better groff |
| 58 | than us and has more experience in writing manual pages, any patches |
| 59 | would be greatly appreciated. |
| 60 | |
| 61 | .SH SEE ALSO |
| 62 | .BR exim (8), |
| 63 | .BR perlre (1), |
| 64 | /usr/share/doc/exim4\-base/ |
| 65 | |
| 66 | |
| 67 | .SH AUTHOR |
| 68 | This manual page was stitched together from spec.txt by |
| 69 | Andreas Metzler <ametzler at downhill.at.eu.org>, |
| 70 | for the Debian GNU/Linux system (but may be used by others). |