doc: various updates
* 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:
22
doc/rg.1.md
22
doc/rg.1.md
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user