zsh-syntax-highlighting/README.md

50 lines
1.4 KiB
Markdown
Raw Normal View History

zsh-syntax-highlighting
=======================
2010-12-25 12:47:12 -05:00
**[Fish shell][fish]-like like syntax highlighting for [Zsh][zsh].**
2011-01-05 17:07:22 -05:00
*Requirements: zsh 4.3.17+.*
2010-12-25 12:47:12 -05:00
[fish]: http://www.fishshell.com/
[zsh]: http://www.zsh.org/
This package provides syntax highlighing for the shell zsh. It enables
highlighing of commands whilst they are typed at a zsh prompt into an
interactive terminal. This helps in reviewing commands before running
them, particularly in catching syntax errors.
[![Screenshot](images/preview-smaller.png)](images/preview.png)
How to install
--------------
See [INSTALL.md](INSTALL.md).
FAQ
---
### Why must `zsh-syntax-highlighting.zsh` be sourced at the end of the `.zshrc` file?
`zsh-syntax-highlighting.zsh` wraps ZLE widgets. It must be sourced after all
custom widgets have been created (i.e., after all `zle -N` calls and after
running `compinit`). Widgets created later will work, but will not update the
syntax highlighting.
### How are new releases announced?
There is currently no "push" announcements channel. However, the following
alternatives exist:
- GitHub's RSS feed of releases: https://github.com/zsh-users/zsh-syntax-highlighting/releases.atom
- An anitya entry: https://release-monitoring.org/project/7552/
How to tweak
------------
2011-01-05 17:07:22 -05:00
Syntax highlighting is done by pluggable highlighter scripts. See the
[`highlighters` directory](./highlighters) for documentation and configuration
settings.