diff --git a/README.md b/README.md index 9a88acf78..2d1e84d22 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ A code searching tool similar to `ack`, with a focus on speed. [![#ag on Freenode](https://img.shields.io/badge/Freenode-%23ag-brightgreen.svg)](https://webchat.freenode.net/?channels=ag) +Search patterns can be literals or [Perl Compatible Regular Expressions (PCREs)](http://www.pcre.org/). + Do you know C? Want to improve ag? [I invite you to pair with me](http://geoff.greer.fm/2014/10/13/help-me-get-to-ag-10/). diff --git a/doc/ag.1 b/doc/ag.1 index 822096a41..39484bd67 100644 --- a/doc/ag.1 +++ b/doc/ag.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "AG" "1" "December 2016" "" "" +.TH "AG" "1" "March 2022" "" "" . .SH "NAME" \fBag\fR \- The Silver Searcher\. Like ack, but faster\. @@ -12,6 +12,9 @@ .SH "DESCRIPTION" Recursively search for PATTERN in PATH\. Like grep or ack, but faster\. . +.P +PATTERN is a Perl\-Compatible Regular Expression (PCRE)\. Refer to pcre(3), pcrepattern(3) and pcresyntax(3) for details\. +. .SH "OPTIONS" . .TP @@ -252,6 +255,10 @@ Only match whole words\. Use NUM worker threads\. Default is the number of CPU cores, with a max of 8\. . .TP +\fB\-W \-\-width NUM\fR +Truncate match lines after NUM characters\. +. +.TP \fB\-z \-\-search\-zip\fR Search contents of compressed files\. Currently, gz and xz are supported\. This option requires that ag is built with lzma and zlib\. . @@ -284,4 +291,4 @@ Use the \fB\-t\fR option to search all text files; \fB\-a\fR to search all files ag was originally created by Geoff Greer\. More information (and the latest release) can be found at http://geoff\.greer\.fm/ag . .SH "SEE ALSO" -grep(1) +grep(1), pcre(3), pcrepattern(3), pcresyntax(3) diff --git a/doc/ag.1.md b/doc/ag.1.md index b360c80b4..0eace3c04 100644 --- a/doc/ag.1.md +++ b/doc/ag.1.md @@ -9,6 +9,8 @@ ag(1) -- The Silver Searcher. Like ack, but faster. Recursively search for PATTERN in PATH. Like grep or ack, but faster. +PATTERN is a Perl-Compatible Regular Expression (PCRE). Refer to pcre(3), pcrepattern(3) and pcresyntax(3) for details. + ## OPTIONS * `--ackmate`: @@ -259,4 +261,4 @@ release) can be found at http://geoff.greer.fm/ag ## SEE ALSO -grep(1) +grep(1), pcre(3), pcrepattern(3), pcresyntax(3)