extern/bat-extras
1
0
Fork 0
mirror of https://github.com/eth-p/bat-extras.git synced 2025-01-20 20:28:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: Clean up command documentation

Browse Source
This commit is contained in:
Ethan P 2020-05-15 20:53:59 -07:00
parent 5fbf8adf41
commit 85c4cfbfe8
No known key found for this signature in database
GPG Key ID: 6963FD04F6CF35EA
5 changed files with 35 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/batdiff.md
View File

@ -7,16 +7,14 @@ This script supports using [delta](https://github.com/dandavison/delta) as an al
## Command Line
## Usage
**Synopsis:**
- `batdiff [OPTIONS] FILE`
- `batdiff [OPTIONS] FILE OTHER_FILE`
`batdiff [OPTIONS] FILE`
`batdiff [OPTIONS] FILE OTHER_FILE`
**Options:**
## Options
| Short | Long | Description |
| ----- | ------------------------- | ------------------------------------------------------------ |

43
doc/batgrep.md
View File

@ -6,37 +6,32 @@ Search through files or directories looking for matching regular expressions (or
## Command Line
## Usage
**Synopsis:**
- `batgrep [OPTIONS] PATTERN [PATH...] `
`batgrep [OPTIONS] PATTERN [PATH...]`
**Options:**
## 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. |
| 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. |
| | `--pager=[PAGER]` | Specify the pager to use. |
| | `--terminal-width=[COLS]` | Generate output for the specified terminal width. |
**Options (Passthrough)**:
The following options are passed directly to ripgrep, and are not handled by this script.
| Short | Long | Notes |

18
doc/batman.md
View File

@ -6,15 +6,13 @@ Gone are the days of losing your place while reading through monotone manual pag
## Command Line
## Usage
**Synopsis:**
- `batman [SECTION] [ENTRY] `
`batman [SECTION] [ENTRY]`
**Environment:**
## Environment
| Variable | Description |
| ---------- | ------------------------------------------------------------ |
@ -23,14 +21,6 @@ Gone are the days of losing your place while reading through monotone manual pag
## Caveats
None so far.
## Installation
This script is a part of the `bat-extras` suite of scripts. You can find install instructions [here](../README.md#installation).
@ -46,4 +36,4 @@ Thanks to [@sharkdp](https://github.com/sharkdp) and [@LunarLambda](https://gith
## Issues?
If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!
Contributions are always welcome.
Contributions are always welcome.

18
doc/batwatch.md
View File

@ -6,15 +6,13 @@ Watch for changes in one or more files, and print them with `bat`.
## Command Line
## Usage
**Synopsis:**
- `batwatch [OPTIONS] FILE... `
`batwatch [OPTIONS] FILE...`
**Options:**
## Options
| Short | Long | Description |
| ----- | --------------------- | ------------------------------------------------------------ |
@ -24,9 +22,6 @@ Watch for changes in one or more files, and print them with `bat`.
| | `--color` | Force color output. |
| | `--no-color` | Force disable color output. |
**Options (Passthrough)**:
All remaining options are passed through to bat.
@ -48,13 +43,8 @@ This script is a part of the `bat-extras` suite of scripts. You can find install
## Caveats
None so far.
## Issues?
If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!
Contributions are always welcome.
Contributions are always welcome.

10
doc/prettybat.md
View File

@ -6,15 +6,14 @@ The only thing better than syntax highlighting? Syntax highlighting *and* code f
## Command Line
## Usage
**Synopsis:**
- `prettybat [OPTIONS] [PATH...] `
`prettybat [OPTIONS] [PATH...]`
**Options:**
## Options
Every option is passed through to `bat`.
See `man bat` for more information.
@ -58,4 +57,3 @@ This script is a part of the `bat-extras` suite of scripts. You can find install
If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!
Contributions are always welcome.