2019-09-27 01:09:19 +02:00
|
|
|
# bat-extras: batwatch
|
|
|
|
|
|
2020-04-06 20:42:45 +02:00
|
|
|
Watch for changes in one or more files, and print them with `bat`.
|
|
|
|
|
|
|
|
|
|
|
2019-09-27 01:09:19 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Command Line
|
|
|
|
|
|
|
|
|
|
**Synopsis:**
|
|
|
|
|
|
|
|
|
|
- `batwatch [OPTIONS] FILE... `
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**Options:**
|
|
|
|
|
|
|
|
|
|
| Short | Long | Description |
|
|
|
|
|
| ----- | --------------------- | ------------------------------------------------------------ |
|
|
|
|
|
| | `--watcher=[watcher]` | Use a specific program to watch for file changes. See [below](#watchers) for more details. |
|
|
|
|
|
| | `--clear` | Clear the screen before printing the files.<br />This is enabled by default. |
|
2019-10-25 22:54:45 +02:00
|
|
|
| | `--no-clear` | Do not clear the screen before printing the files. |
|
2019-09-27 01:09:19 +02:00
|
|
|
| | `--color` | Force color output. |
|
|
|
|
|
| | `--no-color` | Force disable color output. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**Options (Passthrough)**:
|
|
|
|
|
All remaining options are passed through to bat.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Watchers
|
|
|
|
|
|
|
|
|
|
Batwatch uses external programs to watch for file changes.
|
|
|
|
|
Currently, the following programs are supported:
|
|
|
|
|
|
|
|
|
|
- [entr](http://entrproject.org/)
|
|
|
|
|
|
2019-10-25 22:54:45 +02:00
|
|
|
There is also a fallback `poll` watcher available.
|
|
|
|
|
|
2019-09-27 01:09:19 +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
|
|
|
|
|
|
|
|
|
|
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.
|
