extern/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2025-04-19 09:08:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge 31d6fdb715 into a006457a72

Browse Source
This commit is contained in:
Justin Su 2025-03-10 08:07:38 -04:00 committed by GitHub
commit b543cb5929
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -113,7 +113,7 @@ bat f - g # output 'f', then stdin, then 'g'.
#### `fzf` #### `fzf`
You can use `bat` as a previewer for [`fzf`](https://github.com/junegunn/fzf). To do this, You can use `bat` as a previewer for [`fzf`](https://github.com/junegunn/fzf). To do this,
use `bat`s `--color=always` option to force colorized output. You can also use `--line-range` use `bat`'s `--color=always` option to force colorized output. You can also use `--line-range`
option to restrict the load times for long files: option to restrict the load times for long files:
```bash ```bash
@ -474,8 +474,8 @@ Use `bat --list-themes` to get a list of all available themes for syntax
highlighting. To select the `TwoDark` theme, call `bat` with the highlighting. To select the `TwoDark` theme, call `bat` with the
`--theme=TwoDark` option or set the `BAT_THEME` environment variable to `--theme=TwoDark` option or set the `BAT_THEME` environment variable to
`TwoDark`. Use `export BAT_THEME="TwoDark"` in your shell's startup file to `TwoDark`. Use `export BAT_THEME="TwoDark"` in your shell's startup file to
make the change permanent. Alternatively, use `bat`s make the change permanent. Alternatively, use `bat`'s
[configuration file](https://github.com/sharkdp/bat#configuration-file). [configuration file](#configuration-file).
If you want to preview the different themes on a custom file, you can use If you want to preview the different themes on a custom file, you can use
the following command (you need [`fzf`](https://github.com/junegunn/fzf) for this): the following command (you need [`fzf`](https://github.com/junegunn/fzf) for this):
@ -488,7 +488,7 @@ You can use the `--theme-dark` / `--theme-light` options or the `BAT_THEME_DARK`
to customize the themes used. This is especially useful if you frequently switch between dark and light mode. to customize the themes used. This is especially useful if you frequently switch between dark and light mode.
You can also use a custom theme by following the You can also use a custom theme by following the
['Adding new themes' section below](https://github.com/sharkdp/bat#adding-new-themes). ['Adding new themes' section below](#adding-new-themes).
### 8-bit themes ### 8-bit themes
@ -512,11 +512,11 @@ Although these themes are more restricted, they have three advantages over truec
### Output style ### Output style
You can use the `--style` option to control the appearance of `bat`s output. You can use the `--style` option to control the appearance of `bat`'s output.
You can use `--style=numbers,changes`, for example, to show only Git changes You can use `--style=numbers,changes`, for example, to show only Git changes
and line numbers but no grid and no file header. Set the `BAT_STYLE` environment and line numbers but no grid and no file header. Set the `BAT_STYLE` environment
variable to make these changes permanent or use `bat`s variable to make these changes permanent or use `bat`'s
[configuration file](https://github.com/sharkdp/bat#configuration-file). [configuration file](#configuration-file).
>[!tip] >[!tip]
> If you specify a default style in `bat`'s config file, you can change which components > If you specify a default style in `bat`'s config file, you can change which components
@ -633,7 +633,7 @@ If you want to pass command-line arguments to the pager, you can also set them v
export BAT_PAGER="less -RF" export BAT_PAGER="less -RF"
``` ```
Instead of using environment variables, you can also use `bat`s [configuration file](https://github.com/sharkdp/bat#configuration-file) to configure the pager (`--pager` option). Instead of using environment variables, you can also use `bat`'s [configuration file](#configuration-file) to configure the pager (`--pager` option).
### Using `less` as a pager ### Using `less` as a pager
@ -840,7 +840,7 @@ bash assets/create.sh
cargo install --path . --locked --force cargo install --path . --locked --force
``` ```
If you want to build an application that uses `bat`s pretty-printing If you want to build an application that uses `bat`'s pretty-printing
features as a library, check out the [the API documentation](https://docs.rs/bat/). features as a library, check out the [the API documentation](https://docs.rs/bat/).
Note that you have to use either `regex-onig` or `regex-fancy` as a feature Note that you have to use either `regex-onig` or `regex-fancy` as a feature
when you depend on `bat` as a library. when you depend on `bat` as a library.