From 49003e8488c751bdabbf68487db2cd04fd7a97d4 Mon Sep 17 00:00:00 2001 From: Andrew Gallant Date: Thu, 22 Sep 2016 17:48:41 -0400 Subject: Add man page. --- doc/convert-to-man | 4 + doc/rg.1 | 256 +++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/rg.1.md | 166 ++++++++++++++++++++++++++++++++++ 3 files changed, 426 insertions(+) create mode 100755 doc/convert-to-man create mode 100644 doc/rg.1 create mode 100644 doc/rg.1.md diff --git a/doc/convert-to-man b/doc/convert-to-man new file mode 100755 index 00000000..7afa441b --- /dev/null +++ b/doc/convert-to-man @@ -0,0 +1,4 @@ +#!/bin/sh + +pandoc -s -t man rg.1.md -o rg.1 +sed -i 's/\.TH.*/.TH "rg" "1"/g' rg.1 diff --git a/doc/rg.1 b/doc/rg.1 new file mode 100644 index 00000000..1e401906 --- /dev/null +++ b/doc/rg.1 @@ -0,0 +1,256 @@ +.\" Automatically generated by Pandoc 1.17.2 +.\" +.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 \-\-help +.PP +rg \-\-version +.SH DESCRIPTION +.PP +rg (ripgrep) combines the usability of The Silver Searcher (an ack +clone) with the raw speed of grep. +.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. +.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. +.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. +.RS +.RE +.TP +.B \-r, \-\-replace \f[I]ARG\f[] +Replace every match with the string given. +Capture group indices (e.g., $5) and names (e.g., $foo) are supported. +.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 \-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 \-\-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 \-\-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\-mmap +Never use memory maps, even when they might be faster. +.RS +.RE +.TP +.B \-\-no\-ignore +Don\[aq]t respect ignore files (.gitignore, .rgignore, 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 \-p, \-\-pretty +Alias for \-\-color=always \-\-heading \-n. +.RS +.RE +.TP +.B \-j, \-\-threads \f[I]ARG\f[] +The number of threads to use. +Defaults to 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 +.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. +Example: \-\-type\-add html:\f[I]\&.html,\f[].htm +.RS +.RE +.TP +.B \-\-type\-clear \f[I]TYPE\f[] ... +Clear the file type globs for TYPE. +.RS +.RE diff --git a/doc/rg.1.md b/doc/rg.1.md new file mode 100644 index 00000000..953bc1f8 --- /dev/null +++ b/doc/rg.1.md @@ -0,0 +1,166 @@ +# NAME + +rg - recursively search current directory for lines matching a pattern + +# SYNOPSIS + +rg [*options*] -e PATTERN ... [*<*path*> ...*] + +rg [*options*] <*pattern*> [*<*path*> ...*] + +rg [*options*] --files [*<*path*> ...*] + +rg [*options*] --type-list + +rg --help + +rg --version + +# DESCRIPTION + +rg (ripgrep) combines the usability of The Silver Searcher (an ack clone) with +the raw speed of grep. + +# COMMON OPTIONS + +-a, --text +: Search binary files as if they were text. + +-c, --count +: Only show count of line matches for each file. + +--color *WHEN* +: Whether to use coloring in match. Valid values are never, always or auto. + [default: auto] + +-e, --regexp *PATTERN* ... +: Use PATTERN to search. This option can be provided multiple times, where all + patterns given are searched. + +-F, --fixed-strings +: Treat the pattern as a literal string instead of a regular expression. + +-g, --glob *GLOB* ... +: 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 '!' to exclude it. + +-h, --help +: Show this usage message. + +-i, --ignore-case +: Case insensitive search. + +-n, --line-number +: Show line numbers (1-based). This is enabled by default at a tty. + +-N, --no-line-number +: Suppress line numbers. + +-q, --quiet +: Do not print anything to stdout. + +-r, --replace *ARG* +: Replace every match with the string given. Capture group indices (e.g., $5) + and names (e.g., $foo) are supported. + +-t, --type *TYPE* ... +: Only search files matching TYPE. Multiple type flags may be provided. Use the + --type-list flag to list all available types. + +-T, --type-not *TYPE* ... +: Do not search files matching TYPE. Multiple not-type flags may be provided. + +-u, --unrestricted ... +: Reduce the level of 'smart' searching. A single -u doesn'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. + +-v, --invert-match +: Invert matching. + +-w, --word-regexp +: Only show matches surrounded by word boundaries. This is equivalent to + putting \\b before and after the search pattern. + +# LESS COMMON OPTIONS + +-A, --after-context *NUM* +: Show NUM lines after each match. + +-B, --before-context *NUM* +: Show NUM lines before each match. + +-C, --context *NUM* +: Show NUM lines before and after each match. + +--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't try + to account for Unicode. One byte is equal to one column. + +--context-separator *ARG* +: The string to use when separating non-continuous context lines. Escape + sequences may be used. [default: --] + +--debug +: Show debug messages. + +--files +: Print each file that would be searched (but don't search). + +-H, --with-filename +: Prefix each match with the file name that contains it. This is the + default when more than one file is searched. + +--heading +: Show the file name above clusters of matches from each file. + This is the default mode at a tty. + +--no-heading +: Don't show any file name heading. + +--hidden +: Search hidden directories and files. (Hidden directories and files are + skipped by default.) + +-L, --follow +: Follow symlinks. + +--mmap +: Search using memory maps when possible. This is enabled by default + when ripgrep thinks it will be faster. (Note that mmap searching + doesn't currently support the various context related options.) + +--no-mmap +: Never use memory maps, even when they might be faster. + +--no-ignore +: Don't respect ignore files (.gitignore, .rgignore, etc.) + This implies --no-ignore-parent. + +--no-ignore-parent +: Don't respect ignore files in parent directories. + +-p, --pretty +: Alias for --color=always --heading -n. + +-j, --threads *ARG* +: The number of threads to use. Defaults to the number of logical CPUs + (capped at 6). [default: 0] + +--version +: Show the version number of ripgrep and exit. + +# FILE TYPE MANAGEMENT OPTIONS + +--type-list +: Show all supported file types and their associated globs. + +--type-add *ARG* ... +: Add a new glob for a particular file type. + Example: --type-add html:*.html,*.htm + +--type-clear *TYPE* ... +: Clear the file type globs for TYPE. -- cgit v1.2.3