summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2017-01-10 18:16:15 -0500
committerAndrew Gallant <jamslam@gmail.com>2017-01-10 18:16:15 -0500
commit8751e5570697e6b2b913b2ab06e0dabf9f28b436 (patch)
tree51a57c6e292aaa8dc74ec30635faf2ad9c509726 /doc
parent2143bcf9cb259c2230aa79a7cbc23cb1ec1fdae7 (diff)
Add --path-separator flag.
This flag permits setting the path separator used for all file paths printed by ripgrep in normal operation. Fixes #275
Diffstat (limited to 'doc')
-rw-r--r--doc/rg.112
-rw-r--r--doc/rg.1.md8
2 files changed, 18 insertions, 2 deletions
diff --git a/doc/rg.1 b/doc/rg.1
index 95539939..bed7ac65 100644
--- a/doc/rg.1
+++ b/doc/rg.1
@@ -186,7 +186,7 @@ One byte is equal to one column.
.RS
.RE
.TP
-.B \-\-context\-separator \f[I]ARG\f[]
+.B \-\-context\-separator \f[I]SEPARATOR\f[]
The string to use when separating non\-continuous context lines.
Escape sequences may be used.
[default: \-\-]
@@ -328,6 +328,16 @@ and \-\-files.
.RS
.RE
.TP
+.B \-\-path\-separator \f[I]SEPARATOR\f[]
+The path separator to use when printing file paths.
+This defaults to your platform\[aq]s path separator, which is / on Unix
+and \\ on Windows.
+This flag is intended for overriding the default when the environment
+demands it (e.g., cygwin).
+A path separator is limited to a single byte.
+.RS
+.RE
+.TP
.B \-p, \-\-pretty
Alias for \-\-color=always \-\-heading \-n.
.RS
diff --git a/doc/rg.1.md b/doc/rg.1.md
index 7f19cecf..5e0f7031 100644
--- a/doc/rg.1.md
+++ b/doc/rg.1.md
@@ -128,7 +128,7 @@ Project home page: https://github.com/BurntSushi/ripgrep
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*
+--context-separator *SEPARATOR*
: The string to use when separating non-continuous context lines. Escape
sequences may be used. [default: --]
@@ -221,6 +221,12 @@ Project home page: https://github.com/BurntSushi/ripgrep
a list of matching files such as with --count, --files-with-matches
and --files.
+--path-separator *SEPARATOR*
+: The path separator to use when printing file paths. This defaults to your
+ platform's path separator, which is / on Unix and \\ on Windows. This flag is
+ intended for overriding the default when the environment demands it (e.g.,
+ cygwin). A path separator is limited to a single byte.
+
-p, --pretty
: Alias for --color=always --heading -n.