twin/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-08-01 04:32:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc: various updates

Browse Source 
* Don't use 'smart typography' when generating man page
* Document PATTERN and PATH
* Capitalise place-holder names consistently
* Add note about PATH overriding glob/ignore rules
* Update args.rs for new PATH capitalisation

Fixes #725
This commit is contained in:
dana
2018-01-11 07:05:52 -06:00
committed by Andrew Gallant
parent 74e96b498c
commit 34c0b1bc70
5 changed files with 49 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/convert-to-man
View File

@@ -1,5 +1,5 @@
#!/bin/sh -e
pandoc -s -t man rg.1.md -o rg.1
pandoc -s -f markdown-smart -t man rg.1.md -o rg.1
sed -i.bak 's/\.TH.*/.TH "rg" "1"/g' rg.1
rm -f rg.1.bak # BSD `sed` requires the creation of a back-up file

31
doc/rg.1
View File

@@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.19.2.1
.\" Automatically generated by Pandoc 2.0.6
.\"
.TH "rg" "1"
.hy
@@ -7,18 +7,18 @@
rg \- recursively search current directory for lines matching a pattern
.SH SYNOPSIS
.PP
rg [\f[I]options\f[]] \f[I]PATTERN\f[] [\f[I]path\f[] ...]
rg [\f[I]OPTIONS\f[]] \f[I]PATTERN\f[] [\f[I]PATH\f[] ...]
.PP
rg [\f[I]options\f[]] [\-e \f[I]PATTERN\f[] ...] [\-f \f[I]FILE\f[] ...]
[\f[I]path\f[] ...]
rg [\f[I]OPTIONS\f[]] [\-e \f[I]PATTERN\f[] ...] [\-f \f[I]FILE\f[] ...]
[\f[I]PATH\f[] ...]
.PP
rg [\f[I]options\f[]] \-\-files [\f[I]path\f[] ...]
rg [\f[I]OPTIONS\f[]] \-\-files [\f[I]PATH\f[] ...]
.PP
rg [\f[I]options\f[]] \-\-type\-list
rg [\f[I]OPTIONS\f[]] \-\-type\-list
.PP
rg [\f[I]options\f[]] \-\-help
rg [\f[I]OPTIONS\f[]] \-\-help
.PP
rg [\f[I]options\f[]] \-\-version
rg [\f[I]OPTIONS\f[]] \-\-version
.SH DESCRIPTION
.PP
ripgrep (rg) combines the usability of The Silver Searcher (an ack
@@ -34,6 +34,21 @@ it searches a file that is simultaneously truncated.
This behavior can be avoided by passing the \-\-no\-mmap flag.
.PP
Project home page: https://github.com/BurntSushi/ripgrep
.SH POSITIONAL ARGUMENTS
.TP
.B \f[I]PATTERN\f[]
A regular expression used for searching.
To match a pattern beginning with a dash, use the \-e/\-\-regexp option.
.RS
.RE
.TP
.B \f[I]PATH\f[]
A file or directory to search.
Directories are searched recursively.
Paths specified expicitly on the command line override glob and ignore
rules.
.RS
.RE
.SH COMMON OPTIONS
.TP
.B \-a, \-\-text

22
doc/rg.1.md
View File

@@ -4,17 +4,17 @@ rg - recursively search current directory for lines matching a pattern
# SYNOPSIS
rg [*options*] *PATTERN* [*path* ...]
rg [*OPTIONS*] *PATTERN* [*PATH* ...]
rg [*options*] [-e *PATTERN* ...] [-f *FILE* ...] [*path* ...]
rg [*OPTIONS*] [-e *PATTERN* ...] [-f *FILE* ...] [*PATH* ...]
rg [*options*] --files [*path* ...]
rg [*OPTIONS*] --files [*PATH* ...]
rg [*options*] --type-list
rg [*OPTIONS*] --type-list
rg [*options*] --help
rg [*OPTIONS*] --help
rg [*options*] --version
rg [*OPTIONS*] --version
# DESCRIPTION
@@ -31,6 +31,16 @@ by passing the --no-mmap flag.
Project home page: https://github.com/BurntSushi/ripgrep
# POSITIONAL ARGUMENTS
*PATTERN*
: A regular expression used for searching. To match a pattern beginning with a
dash, use the -e/--regexp option.
*PATH*
: A file or directory to search. Directories are searched recursively. Paths
specified expicitly on the command line override glob and ignore rules.
# COMMON OPTIONS
-a, --text