summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2016-09-26 19:21:17 -0400
committerAndrew Gallant <jamslam@gmail.com>2016-09-26 19:21:17 -0400
commit7a3fd1f23fe7a4d679fb1fb7d13884a653e5d4f5 (patch)
tree22e9bf417c21f52ba39590825b49d02b01b72855 /doc
parentd30640344090fc3ffde6d58e0c5a4c928fb00990 (diff)
Add a --null flag.
This flag causes a NUL byte to follow any file path in ripgrep's output. Closes #89.
Diffstat (limited to 'doc')
-rw-r--r--doc/rg.18
-rw-r--r--doc/rg.1.md6
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/rg.1 b/doc/rg.1
index 8c70e711..b61376d9 100644
--- a/doc/rg.1
+++ b/doc/rg.1
@@ -239,6 +239,14 @@ 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
diff --git a/doc/rg.1.md b/doc/rg.1.md
index 3a6c579b..c996d832 100644
--- a/doc/rg.1.md
+++ b/doc/rg.1.md
@@ -155,6 +155,12 @@ the raw speed of grep.
: Don't respect version control ignore files (e.g., .gitignore).
Note that .ignore files will continue to be respected.
+--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.
+
-p, --pretty
: Alias for --color=always --heading -n.