Files
rgs/README.md
Peisong Xiao 0994661424
Some checks failed
ci / test (beta, ubuntu-latest, beta) (pull_request) Has been cancelled
ci / test (macos, macos-latest, nightly) (pull_request) Has been cancelled
ci / test (nightly, ubuntu-latest, nightly) (pull_request) Has been cancelled
ci / test (pinned, ubuntu-latest, 1.85.0) (pull_request) Has been cancelled
ci / test (stable, ubuntu-latest, stable) (pull_request) Has been cancelled
ci / test (stable-aarch64, ubuntu-latest, stable, aarch64-unknown-linux-gnu) (pull_request) Has been cancelled
ci / test (stable-arm-gnueabihf, ubuntu-latest, stable, armv7-unknown-linux-gnueabihf) (pull_request) Has been cancelled
ci / test (stable-arm-musleabi, ubuntu-latest, stable, armv7-unknown-linux-musleabi) (pull_request) Has been cancelled
ci / test (stable-arm-musleabihf, ubuntu-latest, stable, armv7-unknown-linux-musleabihf) (pull_request) Has been cancelled
ci / test (stable-musl, ubuntu-latest, stable, x86_64-unknown-linux-musl) (pull_request) Has been cancelled
ci / test (stable-powerpc64, ubuntu-latest, stable, powerpc64-unknown-linux-gnu) (pull_request) Has been cancelled
ci / test (stable-riscv64, ubuntu-latest, stable, riscv64gc-unknown-linux-gnu) (pull_request) Has been cancelled
ci / test (stable-s390x, ubuntu-latest, stable, s390x-unknown-linux-gnu) (pull_request) Has been cancelled
ci / test (stable-x86, ubuntu-latest, stable, i686-unknown-linux-gnu) (pull_request) Has been cancelled
ci / test (win-gnu, windows-latest, nightly-x86_64-gnu) (pull_request) Has been cancelled
ci / test (win-msvc, windows-latest, nightly) (pull_request) Has been cancelled
ci / test (winaarch64-msvc, windows-11-arm, nightly) (pull_request) Has been cancelled
ci / wasm (pull_request) Has been cancelled
ci / rustfmt (pull_request) Has been cancelled
ci / docs (pull_request) Has been cancelled
ci / Compile Fuzz Test Targets (pull_request) Has been cancelled
added docs and migrated name to rgs, migrated repo, added squash-lines feature
2026-01-13 20:35:39 -05:00

43 lines
1.4 KiB
Markdown

# rgs
This repository is a fork of ripgrep with additional features. The original
ripgrep documentation is in README-ripgrep.md:
- README-ripgrep.md
## Additional features in this fork
### Multiline windowing
- `--multiline-window=N` (short: `-W N`) limits multiline matches to a sliding
window of N lines while still using multiline matching semantics.
- `--multiline-window` implicitly enables `--multiline` and cannot be used with
`--no-multiline`.
### Per-file match indexing
- `--in-file-index` / `--no-in-file-index` control indexing of matches within a
file to disambiguate overlapping multiline results.
- When enabled, output is formatted as `filename[index]:line:`.
- When searching a single file, the output is formatted as `[index]:line:` (no
filename).
### Squashed output
- `--squash` collapses contiguous Unicode whitespace (including newlines) into a
single ASCII space in output.
- `--squash-nl-only` collapses newlines into spaces while preserving other
whitespace.
- When multiple lines are squashed into one, line numbers are printed as
`start-end:`.
### Binary name
- The target binary name is `rgs` (not `rg`).
## Acknowledgements
This project is built on top of ripgrep by Andrew Gallant and contributors.
All credit for the original tool, documentation, and design belongs to the
ripgrep project. See README-ripgrep.md and the upstream licenses for details.