/[pcre]/code/trunk/doc/pcregrep.1
ViewVC logotype

Contents of /code/trunk/doc/pcregrep.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 280 - (show annotations) (download)
Wed Dec 5 20:56:03 2007 UTC (6 years, 7 months ago) by ph10
File size: 19698 byte(s)
Add --line-offsets and --file-offsets to pcregrep.

1 .TH PCREGREP 1
2 .SH NAME
3 pcregrep - a grep with Perl-compatible regular expressions.
4 .SH SYNOPSIS
5 .B pcregrep [options] [long options] [pattern] [path1 path2 ...]
6 .
7 .SH DESCRIPTION
8 .rs
9 .sp
10 \fBpcregrep\fP searches files for character patterns, in the same way as other
11 grep commands do, but it uses the PCRE regular expression library to support
12 patterns that are compatible with the regular expressions of Perl 5. See
13 .\" HREF
14 \fBpcrepattern\fP(3)
15 .\"
16 for a full description of syntax and semantics of the regular expressions
17 that PCRE supports.
18 .P
19 Patterns, whether supplied on the command line or in a separate file, are given
20 without delimiters. For example:
21 .sp
22 pcregrep Thursday /etc/motd
23 .sp
24 If you attempt to use delimiters (for example, by surrounding a pattern with
25 slashes, as is common in Perl scripts), they are interpreted as part of the
26 pattern. Quotes can of course be used to delimit patterns on the command line
27 because they are interpreted by the shell, and indeed they are required if a
28 pattern contains white space or shell metacharacters.
29 .P
30 The first argument that follows any option settings is treated as the single
31 pattern to be matched when neither \fB-e\fP nor \fB-f\fP is present.
32 Conversely, when one or both of these options are used to specify patterns, all
33 arguments are treated as path names. At least one of \fB-e\fP, \fB-f\fP, or an
34 argument pattern must be provided.
35 .P
36 If no files are specified, \fBpcregrep\fP reads the standard input. The
37 standard input can also be referenced by a name consisting of a single hyphen.
38 For example:
39 .sp
40 pcregrep some-pattern /file1 - /file3
41 .sp
42 By default, each line that matches the pattern is copied to the standard
43 output, and if there is more than one file, the file name is output at the
44 start of each line, followed by a colon. However, there are options that can
45 change how \fBpcregrep\fP behaves. In particular, the \fB-M\fP option makes it
46 possible to search for patterns that span line boundaries. What defines a line
47 boundary is controlled by the \fB-N\fP (\fB--newline\fP) option.
48 .P
49 Patterns are limited to 8K or BUFSIZ characters, whichever is the greater.
50 BUFSIZ is defined in \fB<stdio.h>\fP.
51 .P
52 If the \fBLC_ALL\fP or \fBLC_CTYPE\fP environment variable is set,
53 \fBpcregrep\fP uses the value to set a locale when calling the PCRE library.
54 The \fB--locale\fP option can be used to override this.
55 .
56 .SH OPTIONS
57 .rs
58 .TP 10
59 \fB--\fP
60 This terminate the list of options. It is useful if the next item on the
61 command line starts with a hyphen but is not an option. This allows for the
62 processing of patterns and filenames that start with hyphens.
63 .TP
64 \fB-A\fP \fInumber\fP, \fB--after-context=\fP\fInumber\fP
65 Output \fInumber\fP lines of context after each matching line. If filenames
66 and/or line numbers are being output, a hyphen separator is used instead of a
67 colon for the context lines. A line containing "--" is output between each
68 group of lines, unless they are in fact contiguous in the input file. The value
69 of \fInumber\fP is expected to be relatively small. However, \fBpcregrep\fP
70 guarantees to have up to 8K of following text available for context output.
71 .TP
72 \fB-B\fP \fInumber\fP, \fB--before-context=\fP\fInumber\fP
73 Output \fInumber\fP lines of context before each matching line. If filenames
74 and/or line numbers are being output, a hyphen separator is used instead of a
75 colon for the context lines. A line containing "--" is output between each
76 group of lines, unless they are in fact contiguous in the input file. The value
77 of \fInumber\fP is expected to be relatively small. However, \fBpcregrep\fP
78 guarantees to have up to 8K of preceding text available for context output.
79 .TP
80 \fB-C\fP \fInumber\fP, \fB--context=\fP\fInumber\fP
81 Output \fInumber\fP lines of context both before and after each matching line.
82 This is equivalent to setting both \fB-A\fP and \fB-B\fP to the same value.
83 .TP
84 \fB-c\fP, \fB--count\fP
85 Do not output individual lines; instead just output a count of the number of
86 lines that would otherwise have been output. If several files are given, a
87 count is output for each of them. In this mode, the \fB-A\fP, \fB-B\fP, and
88 \fB-C\fP options are ignored.
89 .TP
90 \fB--colour\fP, \fB--color\fP
91 If this option is given without any data, it is equivalent to "--colour=auto".
92 If data is required, it must be given in the same shell item, separated by an
93 equals sign.
94 .TP
95 \fB--colour=\fP\fIvalue\fP, \fB--color=\fP\fIvalue\fP
96 This option specifies under what circumstances the part of a line that matched
97 a pattern should be coloured in the output. The value may be "never" (the
98 default), "always", or "auto". In the latter case, colouring happens only if
99 the standard output is connected to a terminal. The colour can be specified by
100 setting the environment variable PCREGREP_COLOUR or PCREGREP_COLOR. The value
101 of this variable should be a string of two numbers, separated by a semicolon.
102 They are copied directly into the control string for setting colour on a
103 terminal, so it is your responsibility to ensure that they make sense. If
104 neither of the environment variables is set, the default is "1;31", which gives
105 red.
106 .TP
107 \fB-D\fP \fIaction\fP, \fB--devices=\fP\fIaction\fP
108 If an input path is not a regular file or a directory, "action" specifies how
109 it is to be processed. Valid values are "read" (the default) or "skip"
110 (silently skip the path).
111 .TP
112 \fB-d\fP \fIaction\fP, \fB--directories=\fP\fIaction\fP
113 If an input path is a directory, "action" specifies how it is to be processed.
114 Valid values are "read" (the default), "recurse" (equivalent to the \fB-r\fP
115 option), or "skip" (silently skip the path). In the default case, directories
116 are read as if they were ordinary files. In some operating systems the effect
117 of reading a directory like this is an immediate end-of-file.
118 .TP
119 \fB-e\fP \fIpattern\fP, \fB--regex=\fP\fIpattern\fP, \fB--regexp=\fP\fIpattern\fP
120 Specify a pattern to be matched. This option can be used multiple times in
121 order to specify several patterns. It can also be used as a way of specifying a
122 single pattern that starts with a hyphen. When \fB-e\fP is used, no argument
123 pattern is taken from the command line; all arguments are treated as file
124 names. There is an overall maximum of 100 patterns. They are applied to each
125 line in the order in which they are defined until one matches (or fails to
126 match if \fB-v\fP is used). If \fB-f\fP is used with \fB-e\fP, the command line
127 patterns are matched first, followed by the patterns from the file, independent
128 of the order in which these options are specified. Note that multiple use of
129 \fB-e\fP is not the same as a single pattern with alternatives. For example,
130 X|Y finds the first character in a line that is X or Y, whereas if the two
131 patterns are given separately, \fBpcregrep\fP finds X if it is present, even if
132 it follows Y in the line. It finds Y only if there is no X in the line. This
133 really matters only if you are using \fB-o\fP to show the part(s) of the line
134 that matched.
135 .TP
136 \fB--exclude\fP=\fIpattern\fP
137 When \fBpcregrep\fP is searching the files in a directory as a consequence of
138 the \fB-r\fP (recursive search) option, any files whose names match the pattern
139 are excluded. The pattern is a PCRE regular expression. If a file name matches
140 both \fB--include\fP and \fB--exclude\fP, it is excluded. There is no short
141 form for this option.
142 .TP
143 \fB-F\fP, \fB--fixed-strings\fP
144 Interpret each pattern as a list of fixed strings, separated by newlines,
145 instead of as a regular expression. The \fB-w\fP (match as a word) and \fB-x\fP
146 (match whole line) options can be used with \fB-F\fP. They apply to each of the
147 fixed strings. A line is selected if any of the fixed strings are found in it
148 (subject to \fB-w\fP or \fB-x\fP, if present).
149 .TP
150 \fB-f\fP \fIfilename\fP, \fB--file=\fP\fIfilename\fP
151 Read a number of patterns from the file, one per line, and match them against
152 each line of input. A data line is output if any of the patterns match it. The
153 filename can be given as "-" to refer to the standard input. When \fB-f\fP is
154 used, patterns specified on the command line using \fB-e\fP may also be
155 present; they are tested before the file's patterns. However, no other pattern
156 is taken from the command line; all arguments are treated as file names. There
157 is an overall maximum of 100 patterns. Trailing white space is removed from
158 each line, and blank lines are ignored. An empty file contains no patterns and
159 therefore matches nothing.
160 .TP
161 \fB--file-offsets\fP
162 Instead of showing lines or parts of lines that match, show each match as an
163 offset from the start of the file and a length, separated by a comma. In this
164 mode, no context is shown. That is, the \fB-A\fP, \fB-B\fP, and \fB-C\fP
165 options are ignored. If there is more than one match in a line, each of them is
166 shown separately. This option is mutually exclusive with \fB--line-offsets\fP
167 and \fB--only-matching\fP.
168 .TP
169 \fB-H\fP, \fB--with-filename\fP
170 Force the inclusion of the filename at the start of output lines when searching
171 a single file. By default, the filename is not shown in this case. For matching
172 lines, the filename is followed by a colon and a space; for context lines, a
173 hyphen separator is used. If a line number is also being output, it follows the
174 file name without a space.
175 .TP
176 \fB-h\fP, \fB--no-filename\fP
177 Suppress the output filenames when searching multiple files. By default,
178 filenames are shown when multiple files are searched. For matching lines, the
179 filename is followed by a colon and a space; for context lines, a hyphen
180 separator is used. If a line number is also being output, it follows the file
181 name without a space.
182 .TP
183 \fB--help\fP
184 Output a brief help message and exit.
185 .TP
186 \fB-i\fP, \fB--ignore-case\fP
187 Ignore upper/lower case distinctions during comparisons.
188 .TP
189 \fB--include\fP=\fIpattern\fP
190 When \fBpcregrep\fP is searching the files in a directory as a consequence of
191 the \fB-r\fP (recursive search) option, only those files whose names match the
192 pattern are included. The pattern is a PCRE regular expression. If a file name
193 matches both \fB--include\fP and \fB--exclude\fP, it is excluded. There is no
194 short form for this option.
195 .TP
196 \fB-L\fP, \fB--files-without-match\fP
197 Instead of outputting lines from the files, just output the names of the files
198 that do not contain any lines that would have been output. Each file name is
199 output once, on a separate line.
200 .TP
201 \fB-l\fP, \fB--files-with-matches\fP
202 Instead of outputting lines from the files, just output the names of the files
203 containing lines that would have been output. Each file name is output
204 once, on a separate line. Searching stops as soon as a matching line is found
205 in a file.
206 .TP
207 \fB--label\fP=\fIname\fP
208 This option supplies a name to be used for the standard input when file names
209 are being output. If not supplied, "(standard input)" is used. There is no
210 short form for this option.
211 .TP
212 \fB--line-offsets\fP
213 Instead of showing lines or parts of lines that match, show each match as a
214 line number, the offset from the start of the line, and a length. The line
215 number is terminated by a colon (as usual; see the \fB-n\fP option), and the
216 offset and length are separated by a comma. In this mode, no context is shown.
217 That is, the \fB-A\fP, \fB-B\fP, and \fB-C\fP options are ignored. If there is
218 more than one match in a line, each of them is shown separately. This option is
219 mutually exclusive with \fB--file-offsets\fP and \fB--only-matching\fP.
220 .TP
221 \fB--locale\fP=\fIlocale-name\fP
222 This option specifies a locale to be used for pattern matching. It overrides
223 the value in the \fBLC_ALL\fP or \fBLC_CTYPE\fP environment variables. If no
224 locale is specified, the PCRE library's default (usually the "C" locale) is
225 used. There is no short form for this option.
226 .TP
227 \fB-M\fP, \fB--multiline\fP
228 Allow patterns to match more than one line. When this option is given, patterns
229 may usefully contain literal newline characters and internal occurrences of ^
230 and $ characters. The output for any one match may consist of more than one
231 line. When this option is set, the PCRE library is called in "multiline" mode.
232 There is a limit to the number of lines that can be matched, imposed by the way
233 that \fBpcregrep\fP buffers the input file as it scans it. However,
234 \fBpcregrep\fP ensures that at least 8K characters or the rest of the document
235 (whichever is the shorter) are available for forward matching, and similarly
236 the previous 8K characters (or all the previous characters, if fewer than 8K)
237 are guaranteed to be available for lookbehind assertions.
238 .TP
239 \fB-N\fP \fInewline-type\fP, \fB--newline=\fP\fInewline-type\fP
240 The PCRE library supports five different conventions for indicating
241 the ends of lines. They are the single-character sequences CR (carriage return)
242 and LF (linefeed), the two-character sequence CRLF, an "anycrlf" convention,
243 which recognizes any of the preceding three types, and an "any" convention, in
244 which any Unicode line ending sequence is assumed to end a line. The Unicode
245 sequences are the three just mentioned, plus VT (vertical tab, U+000B), FF
246 (formfeed, U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and
247 PS (paragraph separator, U+2029).
248 .sp
249 When the PCRE library is built, a default line-ending sequence is specified.
250 This is normally the standard sequence for the operating system. Unless
251 otherwise specified by this option, \fBpcregrep\fP uses the library's default.
252 The possible values for this option are CR, LF, CRLF, ANYCRLF, or ANY. This
253 makes it possible to use \fBpcregrep\fP on files that have come from other
254 environments without having to modify their line endings. If the data that is
255 being scanned does not agree with the convention set by this option,
256 \fBpcregrep\fP may behave in strange ways.
257 .TP
258 \fB-n\fP, \fB--line-number\fP
259 Precede each output line by its line number in the file, followed by a colon
260 and a space for matching lines or a hyphen and a space for context lines. If
261 the filename is also being output, it precedes the line number. This option is
262 forced if \fB--line-offsets\fP is used.
263 .TP
264 \fB-o\fP, \fB--only-matching\fP
265 Show only the part of the line that matched a pattern. In this mode, no
266 context is shown. That is, the \fB-A\fP, \fB-B\fP, and \fB-C\fP options are
267 ignored. If there is more than one match in a line, each of them is shown
268 separately. If \fB-o\fP is combined with \fB-v\fP (invert the sense of the
269 match to find non-matching lines), no output is generated, but the return code
270 is set appropriately. This option is mutually exclusive with
271 \fB--file-offsets\fP and \fB--line-offsets\fP.
272 .TP
273 \fB-q\fP, \fB--quiet\fP
274 Work quietly, that is, display nothing except error messages. The exit
275 status indicates whether or not any matches were found.
276 .TP
277 \fB-r\fP, \fB--recursive\fP
278 If any given path is a directory, recursively scan the files it contains,
279 taking note of any \fB--include\fP and \fB--exclude\fP settings. By default, a
280 directory is read as a normal file; in some operating systems this gives an
281 immediate end-of-file. This option is a shorthand for setting the \fB-d\fP
282 option to "recurse".
283 .TP
284 \fB-s\fP, \fB--no-messages\fP
285 Suppress error messages about non-existent or unreadable files. Such files are
286 quietly skipped. However, the return code is still 2, even if matches were
287 found in other files.
288 .TP
289 \fB-u\fP, \fB--utf-8\fP
290 Operate in UTF-8 mode. This option is available only if PCRE has been compiled
291 with UTF-8 support. Both patterns and subject lines must be valid strings of
292 UTF-8 characters.
293 .TP
294 \fB-V\fP, \fB--version\fP
295 Write the version numbers of \fBpcregrep\fP and the PCRE library that is being
296 used to the standard error stream.
297 .TP
298 \fB-v\fP, \fB--invert-match\fP
299 Invert the sense of the match, so that lines which do \fInot\fP match any of
300 the patterns are the ones that are found.
301 .TP
302 \fB-w\fP, \fB--word-regex\fP, \fB--word-regexp\fP
303 Force the patterns to match only whole words. This is equivalent to having \eb
304 at the start and end of the pattern.
305 .TP
306 \fB-x\fP, \fB--line-regex\fP, \fB--line-regexp\fP
307 Force the patterns to be anchored (each must start matching at the beginning of
308 a line) and in addition, require them to match entire lines. This is
309 equivalent to having ^ and $ characters at the start and end of each
310 alternative branch in every pattern.
311 .
312 .
313 .SH "ENVIRONMENT VARIABLES"
314 .rs
315 .sp
316 The environment variables \fBLC_ALL\fP and \fBLC_CTYPE\fP are examined, in that
317 order, for a locale. The first one that is set is used. This can be overridden
318 by the \fB--locale\fP option. If no locale is set, the PCRE library's default
319 (usually the "C" locale) is used.
320 .
321 .
322 .SH "NEWLINES"
323 .rs
324 .sp
325 The \fB-N\fP (\fB--newline\fP) option allows \fBpcregrep\fP to scan files with
326 different newline conventions from the default. However, the setting of this
327 option does not affect the way in which \fBpcregrep\fP writes information to
328 the standard error and output streams. It uses the string "\en" in C
329 \fBprintf()\fP calls to indicate newlines, relying on the C I/O library to
330 convert this to an appropriate sequence if the output is sent to a file.
331 .
332 .
333 .SH "OPTIONS COMPATIBILITY"
334 .rs
335 .sp
336 The majority of short and long forms of \fBpcregrep\fP's options are the same
337 as in the GNU \fBgrep\fP program. Any long option of the form
338 \fB--xxx-regexp\fP (GNU terminology) is also available as \fB--xxx-regex\fP
339 (PCRE terminology). However, the \fB--locale\fP, \fB-M\fP, \fB--multiline\fP,
340 \fB-u\fP, and \fB--utf-8\fP options are specific to \fBpcregrep\fP.
341 .
342 .
343 .SH "OPTIONS WITH DATA"
344 .rs
345 .sp
346 There are four different ways in which an option with data can be specified.
347 If a short form option is used, the data may follow immediately, or in the next
348 command line item. For example:
349 .sp
350 -f/some/file
351 -f /some/file
352 .sp
353 If a long form option is used, the data may appear in the same command line
354 item, separated by an equals character, or (with one exception) it may appear
355 in the next command line item. For example:
356 .sp
357 --file=/some/file
358 --file /some/file
359 .sp
360 Note, however, that if you want to supply a file name beginning with ~ as data
361 in a shell command, and have the shell expand ~ to a home directory, you must
362 separate the file name from the option, because the shell does not treat ~
363 specially unless it is at the start of an item.
364 .P
365 The exception to the above is the \fB--colour\fP (or \fB--color\fP) option,
366 for which the data is optional. If this option does have data, it must be given
367 in the first form, using an equals character. Otherwise it will be assumed that
368 it has no data.
369 .
370 .
371 .SH "MATCHING ERRORS"
372 .rs
373 .sp
374 It is possible to supply a regular expression that takes a very long time to
375 fail to match certain lines. Such patterns normally involve nested indefinite
376 repeats, for example: (a+)*\ed when matched against a line of a's with no final
377 digit. The PCRE matching function has a resource limit that causes it to abort
378 in these circumstances. If this happens, \fBpcregrep\fP outputs an error
379 message and the line that caused the problem to the standard error stream. If
380 there are more than 20 such errors, \fBpcregrep\fP gives up.
381 .
382 .
383 .SH DIAGNOSTICS
384 .rs
385 .sp
386 Exit status is 0 if any matches were found, 1 if no matches were found, and 2
387 for syntax errors and non-existent or inacessible files (even if matches were
388 found in other files) or too many matching errors. Using the \fB-s\fP option to
389 suppress error messages about inaccessble files does not affect the return
390 code.
391 .
392 .
393 .SH "SEE ALSO"
394 .rs
395 .sp
396 \fBpcrepattern\fP(3), \fBpcretest\fP(1).
397 .
398 .
399 .SH AUTHOR
400 .rs
401 .sp
402 .nf
403 Philip Hazel
404 University Computing Service
405 Cambridge CB2 3QH, England.
406 .fi
407 .
408 .
409 .SH REVISION
410 .rs
411 .sp
412 .nf
413 Last updated: 05 December 2007
414 Copyright (c) 1997-2007 University of Cambridge.
415 .fi

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12