aboutsummaryrefslogtreecommitdiff
path: root/misc/sgrep/README
diff options
context:
space:
mode:
Diffstat (limited to 'misc/sgrep/README')
-rw-r--r--misc/sgrep/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/misc/sgrep/README b/misc/sgrep/README
new file mode 100644
index 0000000000000..a8f93ac25a3a5
--- /dev/null
+++ b/misc/sgrep/README
@@ -0,0 +1,9 @@
+Sgrep (sorted grep) searches sorted input files for lines that match a
+search key and outputs the matching lines. When searching large files
+sgrep is much faster than traditional Unix grep, but with significant
+restrictions.
+
+ * All input files must be sorted regular files.
+ * The sort key must start at the beginning of the line.
+ * The search key matches only at the beginning of the line.
+ * No regular expression support.