# 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.