bat-extras/doc/batdiff.md

54 lines
1.8 KiB
Markdown
Raw Normal View History

2020-04-27 13:00:44 +02:00
# bat-extras: batdiff
Diff a file against the current git index, or display the diff between two files.
This script supports using [delta](https://github.com/dandavison/delta) as an alternative highlighter for diffs.
2020-05-16 05:53:59 +02:00
## Usage
2020-04-27 13:00:44 +02:00
batdiff [OPTIONS] FILE
batdiff [OPTIONS] FILE OTHER_FILE
2020-04-27 13:00:44 +02:00
2020-05-16 05:53:59 +02:00
## Options
2020-04-27 13:00:44 +02:00
2020-05-16 06:08:43 +02:00
| Short | Long | Description |
| ----- | ----------------------------- | ------------------------------------------------------------ |
| `-C` | `--context=[LINES]` | The number of lines to show before and after the differing lines. |
| | `--delta` | Display diffs using `delta`. |
| | `--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. |
2020-04-27 13:00:44 +02:00
## Installation
This script is a part of the `bat-extras` suite of scripts. You can find install instructions [here](../README.md#installation).
## Caveats
**When using `bat` as the printer:**
- Syntax highlighting in diffs between two files is not supported.
- Syntax highlighting in a single-file diff requires `bat` >= 0.15.
**When using `delta` as the printer:**
- The `--no-color` option does not remove all color output.
## Issues?
If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!
Contributions are always welcome.