Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Note PCRE as regex flavor of patterns. #1481

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: Note PCRE as regex flavor of patterns. #1481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).


Expand Down
11 changes: 9 additions & 2 deletions doc/ag.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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\.
Expand All @@ -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
Expand Down Expand Up @@ -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\.
.
Expand Down Expand Up @@ -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)
4 changes: 3 additions & 1 deletion doc/ag.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down Expand Up @@ -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)