diff options
author | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2017-01-16 17:40:47 +0000 |
---|---|---|
committer | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2017-01-16 17:40:47 +0000 |
commit | 4939d7de20b030c6161dbc9cb45e7973cf77d5a1 (patch) | |
tree | 4f249c2c566e73af26d47096268ffe0c129ea0d1 /doc/pcre2grep.1 | |
parent | 54d34736f2e3bf4fcfd75d33d941d5e87106314e (diff) | |
download | pcre2-4939d7de20b030c6161dbc9cb45e7973cf77d5a1.tar.gz |
File tidies for 10.23-RC1
git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@655 6239d852-aaf2-0410-a92c-79f79f948069
Diffstat (limited to 'doc/pcre2grep.1')
-rw-r--r-- | doc/pcre2grep.1 | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/pcre2grep.1 b/doc/pcre2grep.1 index a1361f8..80e8899 100644 --- a/doc/pcre2grep.1 +++ b/doc/pcre2grep.1 @@ -62,7 +62,7 @@ built, with the default defaults being 20K and 1M respectively. An error occurs if a line is too long and the buffer can no longer be expanded. .P The block of memory that is actually used is three times the "buffer size", to -allow for buffering "before" and "after" lines. If the buffer size is too +allow for buffering "before" and "after" lines. If the buffer size is too small, fewer than requested "before" and "after" lines may be output. .P Patterns can be no longer than 8K or BUFSIZ bytes, whichever is the greater. @@ -146,8 +146,8 @@ Treat binary files as text. This is equivalent to \fB--binary-files\fP=\fItext\fP. .TP \fB-B\fP \fInumber\fP, \fB--before-context=\fP\fInumber\fP -Output up to \fInumber\fP lines of context before each matching line. Fewer -lines are output if the previous match or the start of the file is within +Output up to \fInumber\fP lines of context before each matching line. Fewer +lines are output if the previous match or the start of the file is within \fInumber\fP lines, or if the processing buffer size has been set too small. If file names and/or line numbers are being output, a hyphen separator is used instead of a colon for the context lines. A line containing "--" is output @@ -168,8 +168,8 @@ be of interest and are skipped without causing any output or affecting the return code. .TP \fB--buffer-size=\fP\fInumber\fP -Set the parameter that controls how much memory is obtained at the start of -processing for buffering files that are being scanned. See also +Set the parameter that controls how much memory is obtained at the start of +processing for buffering files that are being scanned. See also \fB--max-buffer-size\fP below. .TP \fB-C\fP \fInumber\fP, \fB--context=\fP\fInumber\fP @@ -185,7 +185,7 @@ exactly the same as the number of lines that would have been output, but if the suppressed lines than the count (that is, the number of matches). .sp If no lines are selected, the number zero is output. If several files are are -being scanned, a count is output for each of them and the \fB-t\fP option can +being scanned, a count is output for each of them and the \fB-t\fP option can be used to cause a total to be output at the end. However, if the \fB--files-with-matches\fP option is also used, only those files whose counts are greater than zero are listed. When \fB-c\fP is used, the \fB-A\fP, @@ -209,14 +209,14 @@ The colour that is used can be specified by setting one of the environment variables PCRE2GREP_COLOUR, PCRE2GREP_COLOR, PCREGREP_COLOUR, or PCREGREP_COLOR, which are checked in that order. If none of these are set, \fBpcre2grep\fP looks for GREP_COLORS or GREP_COLOR (in that order). The value -of the variable should be a string of two numbers, separated by a semicolon, +of the variable should be a string of two numbers, separated by a semicolon, except in the case of GREP_COLORS, which must start with "ms=" or "mt=" followed by two semicolon-separated colours, terminated by the end of the -string or by a colon. If GREP_COLORS does not start with "ms=" or "mt=" it is +string or by a colon. If GREP_COLORS does not start with "ms=" or "mt=" it is ignored, and GREP_COLOR is checked. .sp If the string obtained from one of the above variables contains any characters -other than semicolon or digits, the setting is ignored and the default colour +other than semicolon or digits, the setting is ignored and the default colour is used. The string is copied directly into the control string for setting colour on a terminal, so it is your responsibility to ensure that the values make sense. If no relevant environment variable is set, the default is "1;31", @@ -311,7 +311,7 @@ specified on the command line using \fB-e\fP may also be present; they are tested before the file's patterns. However, no other pattern is taken from the command line; all arguments are treated as the names of paths to be searched. .TP -\fB--file-list\fP=\fIfilename\fP +\fB--file-list\fP=\fIfilename\fP Read a list of files and/or directories that are to be scanned from the given file, one per line. Trailing white space is removed from each line, and blank lines are ignored. These paths are processed before any that are listed on the @@ -456,8 +456,8 @@ There are no short forms for these options. The default settings are specified when the PCRE2 library is compiled, with the default default being 10 million. .TP \fB--max-buffer-size=\fInumber\fP -This limits the expansion of the processing buffer, whose initial size can be -set by \fB--buffer-size\fP. The maximum buffer size is silently forced to be no +This limits the expansion of the processing buffer, whose initial size can be +set by \fB--buffer-size\fP. The maximum buffer size is silently forced to be no smaller than the starting buffer size. .TP \fB-M\fP, \fB--multiline\fP @@ -547,7 +547,7 @@ for the non-argument case above also apply to this case. If the specified capturing parentheses do not exist in the pattern, or were not set in the match, nothing is output unless the file name or line number are being output. .sp -If this option is given multiple times, multiple substrings are output for each +If this option is given multiple times, multiple substrings are output for each match, in the order the options are given, and all on one line. For example, -o3 -o1 -o3 causes the substrings matched by capturing parentheses 3 and 1 and then 3 again to be output. By default, there is no separator (but see the next @@ -610,7 +610,7 @@ specified by any of the \fB--include\fP or \fB--exclude\fP options. .TP \fB-x\fP, \fB--line-regex\fP, \fB--line-regexp\fP Force the patterns to be anchored (each must start matching at the beginning of -a line) and in addition, require them to match entire lines. In multiline mode +a line) and in addition, require them to match entire lines. In multiline mode the match may be more than one line. This is equivalent to having \eA and \eZ characters at the start and end of each alternative top-level branch in every pattern. This option applies only to the patterns that are matched against the |