|
|
|
@ -81,73 +81,53 @@ rga should compile with stable Rust (v1.36.0+, check with `rustc --version`). To
|
|
|
|
|
rga --rga-list-adapters
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Adapters:
|
|
|
|
|
<!-- this part generated by update-readme.sh -->
|
|
|
|
|
|
|
|
|
|
Adapters:
|
|
|
|
|
|
|
|
|
|
- **ffmpeg**
|
|
|
|
|
|
|
|
|
|
Uses ffmpeg to extract video metadata/chapters and subtitles
|
|
|
|
|
|
|
|
|
|
Extensions: .mkv, .mp4, .avi
|
|
|
|
|
|
|
|
|
|
* **pandoc**
|
|
|
|
|
|
|
|
|
|
Uses pandoc to convert binary/unreadable text documents to plain markdown-like text
|
|
|
|
|
|
|
|
|
|
Extensions: .epub, .odt, .docx, .fb2, .ipynb
|
|
|
|
|
|
|
|
|
|
- **poppler**
|
|
|
|
|
|
|
|
|
|
Uses pdftotext (from poppler-utils) to extract plain text from PDF files
|
|
|
|
|
|
|
|
|
|
Extensions: .pdf
|
|
|
|
|
Mime Types: application/pdf
|
|
|
|
|
|
|
|
|
|
* **zip**
|
|
|
|
|
|
|
|
|
|
- **zip**
|
|
|
|
|
Reads a zip file as a stream and recurses down into its contents
|
|
|
|
|
|
|
|
|
|
Extensions: .zip
|
|
|
|
|
|
|
|
|
|
Mime Types: application/zip
|
|
|
|
|
|
|
|
|
|
* **decompress**
|
|
|
|
|
|
|
|
|
|
- **decompress**
|
|
|
|
|
Reads compressed file as a stream and runs a different extractor on the contents.
|
|
|
|
|
|
|
|
|
|
Extensions: .tgz, .tbz, .tbz2, .gz, .bz2, .xz, .zst
|
|
|
|
|
|
|
|
|
|
Mime Types: application/gzip, application/x-bzip, application/x-xz, application/zstd
|
|
|
|
|
|
|
|
|
|
* **tar**
|
|
|
|
|
|
|
|
|
|
- **tar**
|
|
|
|
|
Reads a tar file as a stream and recurses down into its contents
|
|
|
|
|
|
|
|
|
|
Extensions: .tar
|
|
|
|
|
|
|
|
|
|
- **sqlite**
|
|
|
|
|
|
|
|
|
|
* **sqlite**
|
|
|
|
|
Uses sqlite bindings to convert sqlite databases into a simple plain text format
|
|
|
|
|
|
|
|
|
|
Extensions: .db, .db3, .sqlite, .sqlite3
|
|
|
|
|
|
|
|
|
|
Mime Types: application/x-sqlite3
|
|
|
|
|
|
|
|
|
|
The following adapters are disabled by default, and can be enabled using '--rga-adapters=+pdfpages,tesseract':
|
|
|
|
|
|
|
|
|
|
- **pdfpages**
|
|
|
|
|
|
|
|
|
|
Converts a pdf to it's individual pages as png files. Only useful in combination with tesseract
|
|
|
|
|
|
|
|
|
|
Converts a pdf to its individual pages as png files. Only useful in combination with tesseract
|
|
|
|
|
Extensions: .pdf
|
|
|
|
|
Mime Types: application/pdf
|
|
|
|
|
|
|
|
|
|
* **tesseract**
|
|
|
|
|
|
|
|
|
|
- **tesseract**
|
|
|
|
|
Uses tesseract to run OCR on images to make them searchable. May need -j1 to prevent overloading the system. Make sure you have tesseract installed.
|
|
|
|
|
|
|
|
|
|
Extensions: .jpg, .png
|
|
|
|
|
|
|
|
|
|
<!-- this part generated by update-readme.sh -->
|
|
|
|
|
## USAGE:
|
|
|
|
|
|
|
|
|
|
> rga \[RGA OPTIONS\] \[RG OPTIONS\] PATTERN \[PATH \...\]
|
|
|
|
@ -179,7 +159,7 @@ The following adapters are disabled by default, and can be enabled using '--rga-
|
|
|
|
|
> Disable caching of results
|
|
|
|
|
>
|
|
|
|
|
> By default, rga caches the extracted text, if it is small enough, to a
|
|
|
|
|
> database in \~/.cache/rga on Linux, *\~/Library/Caches/rga* on macOS,
|
|
|
|
|
> database in \~/.cache/rga on Linux, _\~/Library/Caches/rga_ on macOS,
|
|
|
|
|
> or C:\\Users\\username\\AppData\\Local\\rga on Windows. This way,
|
|
|
|
|
> repeated searches on the same set of files will be much faster. If you
|
|
|
|
|
> pass this flag, all caching will be disabled.
|
|
|
|
@ -230,6 +210,7 @@ advanced options.
|
|
|
|
|
|
|
|
|
|
All other options not shown here are passed directly to rg, especially
|
|
|
|
|
\[PATTERN\] and \[PATH \...\]
|
|
|
|
|
|
|
|
|
|
<!-- end of part generated by update-readme.sh -->
|
|
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|