bat-extras/doc/batgrep.md

# bat-extras: batgrep

Quickly search through and highlight files using [ripgrep](https://github.com/burntsushi/ripgrep).

Search through files or directories looking for matching regular expressions (or fixed strings with `-F`), and print the output using `bat` for an easy and syntax-highlighted experience.


## Usage

`batgrep [OPTIONS] PATTERN [PATH...]`


## Options

| Short | Long                         | Description                                                  |
| ----- | ---------------------------- | ------------------------------------------------------------ |
| `-i`  | `--ignore-case`              | Use case insensitive searching.                              |
| `-s`  | `--case-sensitive`           | Use case sensitive searching.                                |
| `-S`  | `--smart-case`               | Use smart case searching.                                    |
| `-A`  | `--after-context=[LINES]`    | Display the next *n* lines after a matched line.             |
| `-B`  | `--before-context=[LINES]`   | Display the previous `n` lines before a matched line.        |
| `-C`  | `--context=[LINES]`          | A combination of `--after-context` and `--before-context`.   |
| `-p`  | `--search-pattern`           | Tell pager to search for `PATTERN`. Currently supported pagers: `less`. |
|       | `--no-follow`                | Do not follow symlinks.                                      |
|       | `--no-snip`                  | Do not show the `snip` decoration.<br /><br />This is automatically enabled when `--context=0` or when `bat --version` is less than `0.12.x`. |
|       | `--no-highlight`             | Do not highlight matching lines.<br /><br />This is automatically enabled when `--context=0`. |
|       | `--color`                    | Force color output.                                          |
|       | `--no-color`                 | Force disable color output.                                  |
|       | `--paging=["never"/"always"]`| Enable/disable paging.                                     |
|       | `--pager=[PAGER]`            | Specify the pager to use.                                    |
|       | `--terminal-width=[COLS]`    | Generate output for the specified terminal width.            |

The following options are passed directly to ripgrep, and are not handled by this script.

| Short | Long                       | Notes                                                        |
| ----- | -------------------------- | ------------------------------------------------------------ |
| `-F`  | `--fixed-strings`          |                                                              |
| `-U`  | `--multiline`              |                                                              |
| `-P`  | `--pcre2`                  |                                                              |
| `-z`  | `--search-zip`             |                                                              |
| `-w`  | `--word-regexp`            |                                                              |
|       | `--one-file-system`        |                                                              |
|       | `--multiline-dotall`       |                                                              |
|       | `--ignore` / `--no-ignore` |                                                              |
|       | `--crlf` / `--no-crlf`     |                                                              |
|       | `--hidden` / `--no-hidden` |                                                              |
| `-E`  | `--encoding`               | This is unsupported by `bat`, and may cause issues when trying to display unsupported encodings. |
| `-g`  | `--glob`                   |                                                              |
| `-t`  | `--type`                   |                                                              |
| `-T`  | `--type-not`               |                                                              |
| `-m`  | `--max-count`              |                                                              |
|       | `--max-depth`              |                                                              |
|       | `--iglob`                  |                                                              |
|       | `--ignore-file`            |                                                              |


## Installation

This script is a part of the `bat-extras` suite of scripts. You can find install instructions [here](../README.md#installation).


## Caveats

**Differences from ripgrep:**

- `--follow` is enabled by default for `batgrep`.

- Not all the `ripgrep` options are supported.


## Issues?

If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!
Contributions are always welcome.
Initial commit. 2019-06-19 23:15:10 +02:00			`# bat-extras: batgrep`

Update documentation to be more clear and descriptive 2020-04-06 20:42:45 +02:00			`Quickly search through and highlight files using [ripgrep](https://github.com/burntsushi/ripgrep).`

			Search through files or directories looking for matching regular expressions (or fixed strings with `-F`), and print the output using `bat` for an easy and syntax-highlighted experience.
Initial commit. 2019-06-19 23:15:10 +02:00


doc: Clean up command documentation 2020-05-16 05:53:59 +02:00			`## Usage`
Initial commit. 2019-06-19 23:15:10 +02:00
doc: Clean up command documentation 2020-05-16 05:53:59 +02:00			`batgrep [OPTIONS] PATTERN [PATH...]`
Initial commit. 2019-06-19 23:15:10 +02:00


doc: Clean up command documentation 2020-05-16 05:53:59 +02:00			`## Options`
Initial commit. 2019-06-19 23:15:10 +02:00
doc: Clean up command documentation 2020-05-16 05:53:59 +02:00			`\| Short \| Long \| Description \|`
			`\| ----- \| ---------------------------- \| ------------------------------------------------------------ \|`
			\| `-i` \| `--ignore-case` \| Use case insensitive searching. \|
			\| `-s` \| `--case-sensitive` \| Use case sensitive searching. \|
			\| `-S` \| `--smart-case` \| Use smart case searching. \|
			\| `-A` \| `--after-context=[LINES]` \| Display the next n lines after a matched line. \|
			\| `-B` \| `--before-context=[LINES]` \| Display the previous `n` lines before a matched line. \|
			\| `-C` \| `--context=[LINES]` \| A combination of `--after-context` and `--before-context`. \|
			\| `-p` \| `--search-pattern` \| Tell pager to search for `PATTERN`. Currently supported pagers: `less`. \|
			\| \| `--no-follow` \| Do not follow symlinks. \|
			\| \| `--no-snip` \| Do not show the `snip` decoration.<br /><br />This is automatically enabled when `--context=0` or when `bat --version` is less than `0.12.x`. \|
			\| \| `--no-highlight` \| Do not highlight matching lines.<br /><br />This is automatically enabled when `--context=0`. \|
			\| \| `--color` \| Force color output. \|
			\| \| `--no-color` \| Force disable color output. \|
docs: Change markdown that may be parsed incorrectly 2020-05-02 10:32:00 +02:00			\| \| `--paging=["never"/"always"]`\| Enable/disable paging. \|
doc: Clean up command documentation 2020-05-16 05:53:59 +02:00			\| \| `--pager=[PAGER]` \| Specify the pager to use. \|
			\| \| `--terminal-width=[COLS]` \| Generate output for the specified terminal width. \|
Initial commit. 2019-06-19 23:15:10 +02:00
			`The following options are passed directly to ripgrep, and are not handled by this script.`

			`\| Short \| Long \| Notes \|`
			`\| ----- \| -------------------------- \| ------------------------------------------------------------ \|`
			\| `-F` \| `--fixed-strings` \| \|
			\| `-U` \| `--multiline` \| \|
			\| `-P` \| `--pcre2` \| \|
			\| `-z` \| `--search-zip` \| \|
			\| `-w` \| `--word-regexp` \| \|
			\| \| `--one-file-system` \| \|
			\| \| `--multiline-dotall` \| \|
			\| \| `--ignore` / `--no-ignore` \| \|
			\| \| `--crlf` / `--no-crlf` \| \|
			\| \| `--hidden` / `--no-hidden` \| \|
			\| `-E` \| `--encoding` \| This is unsupported by `bat`, and may cause issues when trying to display unsupported encodings. \|
			\| `-g` \| `--glob` \| \|
			\| `-t` \| `--type` \| \|
			\| `-T` \| `--type-not` \| \|
			\| `-m` \| `--max-count` \| \|
			\| \| `--max-depth` \| \|
			\| \| `--iglob` \| \|
			\| \| `--ignore-file` \| \|



Update documentation to add install instructions for each script 2019-09-18 23:15:45 +02:00			`## Installation`

			This script is a part of the `bat-extras` suite of scripts. You can find install instructions [here](../README.md#installation).



Initial commit. 2019-06-19 23:15:10 +02:00			`## Caveats`

			`Differences from ripgrep:`

			- `--follow` is enabled by default for `batgrep`.

			- Not all the `ripgrep` options are supported.



			`## Issues?`

			`If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!`
Change --less-search-pattern to --search-pattern in docs 2020-01-18 05:44:58 +01:00			`Contributions are always welcome.`