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

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

Parent Directory | Revision Log | View Patch Patch

-revision 281 by ph10,
Fri Dec  7 15:57:05 2007 UTC
+revision 378 by ph10,
Sun Mar  1 14:13:34 2009 UTC
 Line 47 
 possible to search for patterns that spa
  boundary is controlled by the \fB-N\fP (\fB--newline\fP) option.
  .P
  Patterns are limited to 8K or BUFSIZ characters, whichever is the greater.
  BUFSIZ is defined in \fB<stdio.h>\fP. When there is more than one pattern
  (specified by the use of \fB-e\fP and/or \fB-f\fP), each pattern is applied to
  each line in the order in which they are defined, except that all the \fB-e\fP
  patterns are tried before the \fB-f\fP patterns. As soon as one pattern matches
  (or fails to match when \fB-v\fP is used), no further patterns are considered.
  .P
  When \fB--only-matching\fP, \fB--file-offsets\fP, or \fB--line-offsets\fP
  is used, the output is the part of the line that matched (either shown
  literally, or as an offset). In this case, scanning resumes immediately
  following the match, so that further matches on the same line can be found.
  If there are multiple patterns, they are all tried on the remainder of the
  line. However, patterns that follow the one that matched are not tried on the
  earlier part of the line.
  .P
  If the \fBLC_ALL\fP or \fBLC_CTYPE\fP environment variable is set,
  \fBpcregrep\fP uses the value to set a locale when calling the PCRE library.
  The \fB--locale\fP option can be used to override this.
  .
+ .SH "SUPPORT FOR COMPRESSED FILES"
+ .rs
+ .sp
+ It is possible to compile \fBpcregrep\fP so that it uses \fBlibz\fP or
+ \fBlibbz2\fP to read files whose names end in \fB.gz\fP or \fB.bz2\fP,
+ respectively. You can find out whether your binary has support for one or both
+ of these file types by running it with the \fB--help\fP option. If the
+ appropriate support is not present, files are treated as plain text. The
+ standard input is always so treated.
+ .
  .SH OPTIONS
  .rs
  .TP 10
-Line 105 
 If data is required, it must be given in
+Line 115 
 If data is required, it must be given in
  equals sign.
  .TP
  \fB--colour=\fP\fIvalue\fP, \fB--color=\fP\fIvalue\fP
- This option specifies under what circumstances the part of a line that matched
+ This option specifies under what circumstances the parts of a line that matched
- a pattern should be coloured in the output. The value may be "never" (the
+ a pattern should be coloured in the output. By default, the output is not
- default), "always", or "auto". In the latter case, colouring happens only if
+ coloured. The value (which is optional, see above) may be "never", "always", or
- the standard output is connected to a terminal. The colour can be specified by
+ "auto". In the latter case, colouring happens only if the standard output is
- setting the environment variable PCREGREP_COLOUR or PCREGREP_COLOR. The value
+ connected to a terminal. More resources are used when colouring is enabled,
- of this variable should be a string of two numbers, separated by a semicolon.
+ because \fBpcregrep\fP has to search for all possible matches in a line, not
- They are copied directly into the control string for setting colour on a
+ just one, in order to colour them all.
- terminal, so it is your responsibility to ensure that they make sense. If
- neither of the environment variables is set, the default is "1;31", which gives
+ The colour that is used can be specified by setting the environment variable
- red.
+ PCREGREP_COLOUR or PCREGREP_COLOR. The value of this variable should be a
+ string of two numbers, separated by a semicolon. They are copied directly into
+ the control string for setting colour on a terminal, so it is your
+ responsibility to ensure that they make sense. If neither of the environment
+ variables is set, the default is "1;31", which gives red.
  .TP
  \fB-D\fP \fIaction\fP, \fB--devices=\fP\fIaction\fP
  If an input path is not a regular file or a directory, "action" specifies how
-Line 128 
 option), or "skip" (silently skip the pa
+Line 142 
 option), or "skip" (silently skip the pa
  are read as if they were ordinary files. In some operating systems the effect
  of reading a directory like this is an immediate end-of-file.
  .TP
  \fB-e\fP \fIpattern\fP, \fB--regex=\fP\fIpattern\fP, \fB--regexp=\fP\fIpattern\fP
  Specify a pattern to be matched. This option can be used multiple times in
  order to specify several patterns. It can also be used as a way of specifying a
  single pattern that starts with a hyphen. When \fB-e\fP is used, no argument
-Line 147 
 that matched.
+Line 161 
 that matched.
  .TP
  \fB--exclude\fP=\fIpattern\fP
  When \fBpcregrep\fP is searching the files in a directory as a consequence of
- the \fB-r\fP (recursive search) option, any files whose names match the pattern
+ the \fB-r\fP (recursive search) option, any regular files whose names match the
- are excluded. The pattern is a PCRE regular expression. If a file name matches
+ pattern are excluded. Subdirectories are not excluded by this option; they are
- both \fB--include\fP and \fB--exclude\fP, it is excluded. There is no short
+ searched recursively, subject to the \fB--exclude_dir\fP and
- form for this option.
+ \fB--include_dir\fP options. The pattern is a PCRE regular expression, and is
+ matched against the final component of the file name (not the entire path). If
+ a file name matches both \fB--include\fP and \fB--exclude\fP, it is excluded.
+ There is no short form for this option.
+ .TP
+ \fB--exclude_dir\fP=\fIpattern\fP
+ When \fBpcregrep\fP is searching the contents of a directory as a consequence
+ of the \fB-r\fP (recursive search) option, any subdirectories whose names match
+ the pattern are excluded. (Note that the \fP--exclude\fP option does not affect
+ subdirectories.) The pattern is a PCRE regular expression, and is matched
+ against the final component of the name (not the entire path). If a
+ subdirectory name matches both \fB--include_dir\fP and \fB--exclude_dir\fP, it
+ is excluded. There is no short form for this option.
  .TP
  \fB-F\fP, \fB--fixed-strings\fP
  Interpret each pattern as a list of fixed strings, separated by newlines,
-Line 168 
 present; they are tested before the file
+Line 194 
 present; they are tested before the file
  is taken from the command line; all arguments are treated as file names. There
  is an overall maximum of 100 patterns. Trailing white space is removed from
  each line, and blank lines are ignored. An empty file contains no patterns and
  therefore matches nothing. See also the comments about multiple patterns versus
  a single pattern with alternatives in the description of \fB-e\fP above.
  .TP
  \fB--file-offsets\fP
-Line 182 
 and \fB--only-matching\fP.
+Line 208 
 and \fB--only-matching\fP.
  \fB-H\fP, \fB--with-filename\fP
  Force the inclusion of the filename at the start of output lines when searching
  a single file. By default, the filename is not shown in this case. For matching
- lines, the filename is followed by a colon and a space; for context lines, a
+ lines, the filename is followed by a colon; for context lines, a hyphen
- hyphen separator is used. If a line number is also being output, it follows the
+ separator is used. If a line number is also being output, it follows the file
- file name without a space.
+ name.
  .TP
  \fB-h\fP, \fB--no-filename\fP
  Suppress the output filenames when searching multiple files. By default,
  filenames are shown when multiple files are searched. For matching lines, the
- filename is followed by a colon and a space; for context lines, a hyphen
+ filename is followed by a colon; for context lines, a hyphen separator is used.
- separator is used. If a line number is also being output, it follows the file
+ If a line number is also being output, it follows the file name.
- name without a space.
  .TP
  \fB--help\fP
- Output a brief help message and exit.
+ Output a help message, giving brief details of the command options and file
+ type support, and then exit.
  .TP
  \fB-i\fP, \fB--ignore-case\fP
  Ignore upper/lower case distinctions during comparisons.
  .TP
  \fB--include\fP=\fIpattern\fP
  When \fBpcregrep\fP is searching the files in a directory as a consequence of
- the \fB-r\fP (recursive search) option, only those files whose names match the
+ the \fB-r\fP (recursive search) option, only those regular files whose names
- pattern are included. The pattern is a PCRE regular expression. If a file name
+ match the pattern are included. Subdirectories are always included and searched
- matches both \fB--include\fP and \fB--exclude\fP, it is excluded. There is no
+ recursively, subject to the \fP--include_dir\fP and \fB--exclude_dir\fP
- short form for this option.
+ options. The pattern is a PCRE regular expression, and is matched against the
+ final component of the file name (not the entire path). If a file name matches
+ both \fB--include\fP and \fB--exclude\fP, it is excluded. There is no short
+ form for this option.
+ .TP
+ \fB--include_dir\fP=\fIpattern\fP
+ When \fBpcregrep\fP is searching the contents of a directory as a consequence
+ of the \fB-r\fP (recursive search) option, only those subdirectories whose
+ names match the pattern are included. (Note that the \fB--include\fP option
+ does not affect subdirectories.) The pattern is a PCRE regular expression, and
+ is matched against the final component of the name (not the entire path). If a
+ subdirectory name matches both \fB--include_dir\fP and \fB--exclude_dir\fP, it
+ is excluded. There is no short form for this option.
  .TP
  \fB-L\fP, \fB--files-without-match\fP
  Instead of outputting lines from the files, just output the names of the files
-Line 223 
 are being output. If not supplied, "(sta
+Line 261 
 are being output. If not supplied, "(sta
  short form for this option.
  .TP
  \fB--line-offsets\fP
  Instead of showing lines or parts of lines that match, show each match as a
  line number, the offset from the start of the line, and a length. The line
  number is terminated by a colon (as usual; see the \fB-n\fP option), and the
  offset and length are separated by a comma. In this mode, no context is shown.
  That is, the \fB-A\fP, \fB-B\fP, and \fB-C\fP options are ignored. If there is
  more than one match in a line, each of them is shown separately. This option is
-Line 270 
 being scanned does not agree with the co
+Line 308 
 being scanned does not agree with the co
  .TP
  \fB-n\fP, \fB--line-number\fP
  Precede each output line by its line number in the file, followed by a colon
- and a space for matching lines or a hyphen and a space for context lines. If
+ for matching lines or a hyphen for context lines. If the filename is also being
- the filename is also being output, it precedes the line number. This option is
+ output, it precedes the line number. This option is forced if
- forced if \fB--line-offsets\fP is used.
+ \fB--line-offsets\fP is used.
  .TP
  \fB-o\fP, \fB--only-matching\fP
  Show only the part of the line that matched a pattern. In this mode, no
  context is shown. That is, the \fB-A\fP, \fB-B\fP, and \fB-C\fP options are
  ignored. If there is more than one match in a line, each of them is shown
  separately. If \fB-o\fP is combined with \fB-v\fP (invert the sense of the
  match to find non-matching lines), no output is generated, but the return code
  is set appropriately. This option is mutually exclusive with
  \fB--file-offsets\fP and \fB--line-offsets\fP.
  .TP
  \fB-q\fP, \fB--quiet\fP
-Line 423 
 Cambridge CB2 3QH, England.
+Line 461 
 Cambridge CB2 3QH, England.
  .rs
  .sp
  .nf
- Last updated: 07 December 2007
+ Last updated: 01 March 2009
- Copyright (c) 1997-2007 University of Cambridge.
+ Copyright (c) 1997-2009 University of Cambridge.
  .fi

 Legend:



Removed from v.281
 


changed lines


 
Added in v.378
 Legend:



Removed from v.281
 


changed lines


 
Added in v.378
-Removed from v.281
+Added in v.378

webmaster@exim.org	ViewVC Help
Powered by ViewVC 1.1.12