summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authortiehuis <marctiehuis@gmail.com>2017-02-28 17:53:52 +1300
committerAndrew Gallant <jamslam@gmail.com>2017-03-08 10:17:18 -0500
commit714ae822418e13b1084d377654b3419f22a51866 (patch)
treeaf54173d5af5712b8c53645e026e55d7548cb908 /doc
parent49fd6687120ef11192847ef47191bbc6d32a2ed9 (diff)
Add `--max-filesize` option to cli
The --max-filesize option allows filtering files which are larger than the specified limit. This is potentially useful if one is attempting to search a number of large files without common file-types/suffixes. See #369.
Diffstat (limited to 'doc')
-rw-r--r--doc/rg.114
-rw-r--r--doc/rg.1.md9
2 files changed, 20 insertions, 3 deletions
diff --git a/doc/rg.1 b/doc/rg.1
index cbc0c89e..1b66f2a2 100644
--- a/doc/rg.1
+++ b/doc/rg.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pandoc 1.19.1
+.\" Automatically generated by Pandoc 1.19.2.1
.\"
.TH "rg" "1"
.hy
@@ -275,11 +275,21 @@ Follow symlinks.
.RS
.RE
.TP
-.B \-m, \-\-max\-count NUM
+.B \-m, \-\-max\-count \f[I]NUM\f[]
Limit the number of matching lines per file searched to NUM.
.RS
.RE
.TP
+.B \-\-max\-filesize \f[I]NUM\f[]+\f[I]SUFFIX\f[]?
+Ignore files larger than \f[I]NUM\f[] in size.
+Directories will never be ignored.
+.RS
+.PP
+\f[I]SUFFIX\f[] is optional and may be one of K, M or G.
+These correspond to kilobytes, megabytes and gigabytes respectively.
+If omitted the input is treated as bytes.
+.RE
+.TP
.B \-\-maxdepth \f[I]NUM\f[]
Descend at most NUM directories below the command line arguments.
A value of zero searches only the starting\-points themselves.
diff --git a/doc/rg.1.md b/doc/rg.1.md
index 8804fcc5..830a3bb4 100644
--- a/doc/rg.1.md
+++ b/doc/rg.1.md
@@ -187,9 +187,16 @@ Project home page: https://github.com/BurntSushi/ripgrep
-L, --follow
: Follow symlinks.
--m, --max-count NUM
+-m, --max-count *NUM*
: Limit the number of matching lines per file searched to NUM.
+--max-filesize *NUM*+*SUFFIX*?
+: Ignore files larger than *NUM* in size. Directories will never be ignored.
+
+ *SUFFIX* is optional and may be one of K, M or G. These correspond to
+ kilobytes, megabytes and gigabytes respectively. If omitted the input is
+ treated as bytes.
+
--maxdepth *NUM*
: Descend at most NUM directories below the command line arguments.
A value of zero searches only the starting-points themselves.