Skip to content

Commit eee67aa

Browse files
committed
Added an introduction describing the specificities of this fork.
1 parent 8b1dc65 commit eee67aa

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,33 @@
1-
# The Silver Searcher
1+
# The Silver Searcher for Windows
2+
3+
## Specificities of this fork
4+
5+
This repository is a fork of [Geoff Greer](https://github.com/ggreer)'s [The Silver Searcher](https://github.com/ggreer/the_silver_searcher) for Unix.
6+
7+
It is dedicated to building a well behaved version of ag.exe for Windows.
8+
The original version can be built for Windows using MinGW, but it has several shortcomings that limit its usefulness for Windows users world-wide.
9+
This version has the following improvements:
10+
11+
* Use and display Windows paths with the \ character.
12+
* The -? option displays help.
13+
* Support command line arguments with non-ASCII characters in any console code page.
14+
* Correctly display pathnames and matching strings with non-ASCII characters in any console code page, even if they're not part of the code page.
15+
* Use PCRE UTF8 option, allowing to search for non-ASCII regular expressions. (Like "." matching 1 character = 1 to 4 bytes!)
16+
* Support the two text files encodings standard in each version of Windows, ANSI and UTF-8, and display matches correctly for both.
17+
(Dynamically detects each file encoding.) (The so-called ANSI encoding is Windows-localization-specific. Ex: Code page 1252 for the USA version.)
18+
* Also support the console encoding for text piped through the standard input.
19+
(Which _is_ often different from the above two, and can be changed dynamically. Ex: Code page 437 by default for the USA version.)
20+
* Support pathnames longer than 260 characters.
21+
* Support Windows junctions and symbolic links.
22+
* Support 64-bit statistics even for the 32-bit build. (Allows searching through more than 4GB of files with the x86 build.)
23+
* The debug version displays the thread number ahead of each debug message.
24+
25+
Thanks to [Krzysztof Kowalczyk](https://github.com/kjk) who did the original [Native Visual Studio Port](https://github.com/kjk/the_silver_searcher).
26+
I've actually started from his August 2016 code, and kept improving it.
27+
28+
For instructions on how to build this code, see [win32/README.md](win32/README.md).
29+
30+
## Original introduction
231

332
A code searching tool similar to `ack`, with a focus on speed.
433

0 commit comments

Comments
 (0)