Robot
/
bat
mirror of https://github.com/sharkdp/bat.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: add global `--help` alias limitations

This commit is contained in:
pseudometa 2023-09-02 09:52:40 +02:00 committed by David Peter
parent ed99a3a104
commit 9b73eda957
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -228,15 +228,17 @@ help() {
Then you can do `$ help cp` or `$ help git commit`.
Alternatively, you can also use global aliases to override `-h` and `--help` entirely:
When you are using `zsh`, you can also use global aliases to override `-h` and `--help` entirely:
```bash
alias -g -- -h='-h | bat --language=help --style=plain'
alias -g -- --help='--help | bat --language=help --style=plain'
alias -g -- -h='-h 2>&1 | bat --language=help --style=plain'
alias -g -- --help='--help 2>&1 | bat --language=help --style=plain'
```
This way, you can keep on using `cp --help`, but get colorized help pages.
Be aware that in some cases, `-h` may not be a shorthand of `--help` (for example with `ls`).
Please report any issues with the help syntax in [this repository](https://github.com/victor-gp/cmd-help-sublime-syntax).