diff --git a/README.md b/README.md index 56dcf4c..71daeb6 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,101 @@ rga is a line-oriented search tool that allows you to look for a regex in a mult [![Crates.io](https://img.shields.io/crates/v/ripgrep_all.svg)](https://crates.io/crates/ripgrep_all) For more detail, see this introductory blogpost: https://phiresky.github.io/blog/2019/rga--ripgrep-for-zip-targz-docx-odt-epub-jpg/ + +rga will recursively descend into archives and match text in every file type it knows. + +Here is an [example directory](https://github.com/phiresky/ripgrep-all/tree/master/exampledir/demo) with different file types: + +``` +demo/ +├── greeting.mkv +├── hello.odt +├── hello.sqlite3 +└── somearchive.zip +├── dir +│ ├── greeting.docx +│ └── inner.tar.gz +│ └── greeting.pdf +└── greeting.epub +``` + +![rga output](doc/demodir.png) + +## USAGE: + +> rga \[FLAGS\] \[OPTIONS\] PATTERN \[PATH ...\] + +## FLAGS: + +**\--rga-accurate** + +> Use more accurate but slower matching by mime type +> +> By default, rga will match files using file extensions. Some programs, +> such as sqlite3, don\'t care about the file extension at all, so users +> sometimes use any or no extension at all. With this flag, rga will try +> to detect the mime type of input files using the magic bytes (similar +> to the \`file\` utility), and use that to choose the adapter. +> Detection is only done on the first 8KiB of the file, since we can\'t +> always seek on the input (in archives). + +**-h**, **\--help** + +> Prints help information + +**\--rga-list-adapters** + +> List all known adapters + +**\--rga-no-cache** + +> Disable caching of results +> +> By default, rga caches the extracted text to a database in +> \~/.cache/rga if it is small enough. This way, repeated searches on +> the same set of files will be much faster. If you pass this flag, all +> caching will be disabled. + +**\--rg-help** + +> Show help for ripgrep itself + +**\--rg-version** + +> Show version of ripgrep itself + +**-V**, **\--version** + +> Prints version information + +## OPTIONS: + +**\--rga-adapters=**\\... + +> Change which adapters to use and in which priority order (descending) +> +> \"foo,bar\" means use only adapters foo and bar. \"-bar,baz\" means +> use all default adapters except for bar and baz. \"+bar,baz\" means +> use all default adapters and also bar and baz. + +**\--rga-cache-compression-level=**\ + +> \[default: 12\] + +**\--rga-cache-max-blob-len** \ + +> Max compressed size to cache +> +> Longest byte length (after compression) to store in cache. Longer +> adapter outputs will not be cached and recomputed every time. +> \[default: 2000000\] + +**\--rga-max-archive-recursion=**\ + +> Maximum nestedness of archives to recurse into \[default: 4\] + +**-h** shows a concise overview, **\--help** shows more detail and +advanced options. + +All other options not shown here are passed directly to rg, especially +\[PATTERN\] and \[PATH \...\]