mirror of
https://github.com/BurntSushi/ripgrep.git
synced 2024-12-12 19:18:24 +02:00
77ad7588ae
This flag is similar to what's found in grep: it will suppress all error messages, such as those shown when a particular file couldn't be read. Closes #149
338 lines
7.3 KiB
Groff
338 lines
7.3 KiB
Groff
.\" Automatically generated by Pandoc 1.18
|
|
.\"
|
|
.TH "rg" "1"
|
|
.hy
|
|
.SH NAME
|
|
.PP
|
|
rg \- recursively search current directory for lines matching a pattern
|
|
.SH SYNOPSIS
|
|
.PP
|
|
rg [\f[I]options\f[]] \-e PATTERN ...
|
|
[\f[I]<\f[]path\f[I]> ...\f[]]
|
|
.PP
|
|
rg [\f[I]options\f[]] <\f[I]pattern\f[]> [\f[I]<\f[]path\f[I]> ...\f[]]
|
|
.PP
|
|
rg [\f[I]options\f[]] \-\-files [\f[I]<\f[]path\f[I]> ...\f[]]
|
|
.PP
|
|
rg [\f[I]options\f[]] \-\-type\-list
|
|
.PP
|
|
rg [\f[I]options\f[]] \-\-help
|
|
.PP
|
|
rg [\f[I]options\f[]] \-\-version
|
|
.SH DESCRIPTION
|
|
.PP
|
|
ripgrep (rg) combines the usability of The Silver Searcher (an ack
|
|
clone) with the raw speed of grep.
|
|
.PP
|
|
Project home page: https://github.com/BurntSushi/ripgrep
|
|
.SH COMMON OPTIONS
|
|
.TP
|
|
.B \-a, \-\-text
|
|
Search binary files as if they were text.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-c, \-\-count
|
|
Only show count of line matches for each file.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-color \f[I]WHEN\f[]
|
|
Whether to use coloring in match.
|
|
Valid values are never, always or auto.
|
|
[default: auto]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-e, \-\-regexp \f[I]PATTERN\f[] ...
|
|
Use PATTERN to search.
|
|
This option can be provided multiple times, where all patterns given are
|
|
searched.
|
|
This is also useful when searching for patterns that start with a dash.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-F, \-\-fixed\-strings
|
|
Treat the pattern as a literal string instead of a regular expression.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-g, \-\-glob \f[I]GLOB\f[] ...
|
|
Include or exclude files for searching that match the given glob.
|
|
This always overrides any other ignore logic.
|
|
Multiple glob flags may be used.
|
|
Globbing rules match .gitignore globs.
|
|
Precede a glob with a \[aq]!\[aq] to exclude it.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-h, \-\-help
|
|
Show this usage message.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-i, \-\-ignore\-case
|
|
Case insensitive search.
|
|
Overridden by \-\-case\-sensitive.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-n, \-\-line\-number
|
|
Show line numbers (1\-based).
|
|
This is enabled by default at a tty.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-N, \-\-no\-line\-number
|
|
Suppress line numbers.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-q, \-\-quiet
|
|
Do not print anything to stdout.
|
|
If a match is found in a file, stop searching that file.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-t, \-\-type \f[I]TYPE\f[] ...
|
|
Only search files matching TYPE.
|
|
Multiple type flags may be provided.
|
|
Use the \-\-type\-list flag to list all available types.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-T, \-\-type\-not \f[I]TYPE\f[] ...
|
|
Do not search files matching TYPE.
|
|
Multiple not\-type flags may be provided.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-u, \-\-unrestricted ...
|
|
Reduce the level of \[aq]smart\[aq] searching.
|
|
A single \-u doesn\[aq]t respect .gitignore (etc.) files.
|
|
Two \-u flags will search hidden files and directories.
|
|
Three \-u flags will search binary files.
|
|
\-uu is equivalent to grep \-r, and \-uuu is equivalent to grep \-a \-r.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-v, \-\-invert\-match
|
|
Invert matching.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-w, \-\-word\-regexp
|
|
Only show matches surrounded by word boundaries.
|
|
This is equivalent to putting \\b before and after the search pattern.
|
|
.RS
|
|
.RE
|
|
.SH LESS COMMON OPTIONS
|
|
.TP
|
|
.B \-A, \-\-after\-context \f[I]NUM\f[]
|
|
Show NUM lines after each match.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-B, \-\-before\-context \f[I]NUM\f[]
|
|
Show NUM lines before each match.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-C, \-\-context \f[I]NUM\f[]
|
|
Show NUM lines before and after each match.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-column
|
|
Show column numbers (1 based) in output.
|
|
This only shows the column numbers for the first match on each line.
|
|
Note that this doesn\[aq]t try to account for Unicode.
|
|
One byte is equal to one column.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-context\-separator \f[I]ARG\f[]
|
|
The string to use when separating non\-continuous context lines.
|
|
Escape sequences may be used.
|
|
[default: \-\-]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-debug
|
|
Show debug messages.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-files
|
|
Print each file that would be searched (but don\[aq]t search).
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-l, \-\-files\-with\-matches
|
|
Only show path of each file with matches.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-H, \-\-with\-filename
|
|
Prefix each match with the file name that contains it.
|
|
This is the default when more than one file is searched.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-no\-filename
|
|
Never show the filename for a match.
|
|
This is the default when one file is searched.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-heading
|
|
Show the file name above clusters of matches from each file.
|
|
This is the default mode at a tty.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-no\-heading
|
|
Don\[aq]t show any file name heading.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-hidden
|
|
Search hidden directories and files.
|
|
(Hidden directories and files are skipped by default.)
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-L, \-\-follow
|
|
Follow symlinks.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-m, \-\-max\-count NUM
|
|
Limit the number of matching lines per file searched to NUM.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-maxdepth \f[I]NUM\f[]
|
|
Descend at most NUM directories below the command line arguments.
|
|
A value of zero searches only the starting\-points themselves.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-mmap
|
|
Search using memory maps when possible.
|
|
This is enabled by default when ripgrep thinks it will be faster.
|
|
(Note that mmap searching doesn\[aq]t currently support the various
|
|
context related options.)
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-no\-messages
|
|
Suppress all error messages.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-no\-mmap
|
|
Never use memory maps, even when they might be faster.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-no\-ignore
|
|
Don\[aq]t respect ignore files (.gitignore, .ignore, etc.) This implies
|
|
\-\-no\-ignore\-parent.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-no\-ignore\-parent
|
|
Don\[aq]t respect ignore files in parent directories.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-no\-ignore\-vcs
|
|
Don\[aq]t respect version control ignore files (e.g., .gitignore).
|
|
Note that .ignore files will continue to be respected.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-null
|
|
Whenever a file name is printed, follow it with a NUL byte.
|
|
This includes printing filenames before matches, and when printing a
|
|
list of matching files such as with \-\-count, \-\-files\-with\-matches
|
|
and \-\-files.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-p, \-\-pretty
|
|
Alias for \-\-color=always \-\-heading \-n.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-r, \-\-replace \f[I]ARG\f[]
|
|
Replace every match with the string given when printing search results.
|
|
Neither this flag nor any other flag will modify your files.
|
|
.RS
|
|
.PP
|
|
Capture group indices (e.g., $5) and names (e.g., $foo) are supported in
|
|
the replacement string.
|
|
.RE
|
|
.TP
|
|
.B \-s, \-\-case\-sensitive
|
|
Search case sensitively.
|
|
This overrides \-\-ignore\-case and \-\-smart\-case.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-S, \-\-smart\-case
|
|
Search case insensitively if the pattern is all lowercase.
|
|
Search case sensitively otherwise.
|
|
This is overridden by either \-\-case\-sensitive or \-\-ignore\-case.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-j, \-\-threads \f[I]ARG\f[]
|
|
The number of threads to use.
|
|
0 means use the number of logical CPUs (capped at 6).
|
|
[default: 0]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-version
|
|
Show the version number of ripgrep and exit.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-vimgrep
|
|
Show results with every match on its own line, including line numbers
|
|
and column numbers.
|
|
(With this option, a line with more than one match of the regex will be
|
|
printed more than once.)
|
|
.RS
|
|
.RE
|
|
.SH FILE TYPE MANAGEMENT OPTIONS
|
|
.TP
|
|
.B \-\-type\-list
|
|
Show all supported file types and their associated globs.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-type\-add \f[I]ARG\f[] ...
|
|
Add a new glob for a particular file type.
|
|
Only one glob can be added at a time.
|
|
Multiple \-\-type\-add flags can be provided.
|
|
Unless \-\-type\-clear is used, globs are added to any existing globs
|
|
inside of ripgrep.
|
|
Note that this must be passed to every invocation of rg.
|
|
Type settings are NOT persisted.
|
|
.RS
|
|
.PP
|
|
Example:
|
|
\f[C]rg\ \-\-type\-add\ \[aq]foo:*.foo\[aq]\ \-tfoo\ PATTERN\f[]
|
|
.RE
|
|
.TP
|
|
.B \-\-type\-clear \f[I]TYPE\f[] ...
|
|
Clear the file type globs previously defined for TYPE.
|
|
This only clears the default type definitions that are found inside of
|
|
ripgrep.
|
|
Note that this must be passed to every invocation of rg.
|
|
.RS
|
|
.RE
|