zsh-syntax-highlighting/README.md

zsh-syntax-highlighting
=======================

**[Fish shell](http://www.fishshell.com) like syntax highlighting for [Zsh](http://www.zsh.org).**

*Requirements: zsh 4.3.17+.*

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.


How to install
--------------

### Using packages

* Arch Linux: [community/zsh-syntax-highlighting](https://www.archlinux.org/packages/zsh-syntax-highlighting) / [AUR/zsh-syntax-highlighting-git](https://aur.archlinux.org/packages/zsh-syntax-highlighting-git)
* Gentoo: [mv overlay](http://gpo.zugaina.org/app-shells/zsh-syntax-highlighting)
* Mac OS X / Homebrew: [brew install zsh-syntax-highlighting](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/zsh-syntax-highlighting.rb)

### In your ~/.zshrc

* Clone this repository:

        git clone git://github.com/zsh-users/zsh-syntax-highlighting.git

  (or [download a snapshot](https://github.com/zsh-users/zsh-syntax-highlighting/archive/master.tar.gz))

* Source the script **at the end** of `~/.zshrc`:

        source /path/to/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh

* Source `~/.zshrc`  to take changes into account:

        source ~/.zshrc


### With oh-my-zsh

* Download the script or clone this repository in [oh-my-zsh](http://github.com/robbyrussell/oh-my-zsh) plugins directory:

        git clone git://github.com/zsh-users/zsh-syntax-highlighting.git ~/.oh-my-zsh/custom/plugins/zsh-syntax-highlighting

* Activate the plugin in `~/.zshrc`:

        plugins=( [plugins...] zsh-syntax-highlighting)

* Source `~/.zshrc`  to take changes into account:

        source ~/.zshrc

Note that `zsh-syntax-highlighting` must be the last plugin sourced,
so make it the last element of the `$plugins` array.

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
------------

Syntax highlighting is done by pluggable highlighter scripts, see the [highlighters directory](highlighters)
for documentation and configuration settings.
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-13 04:57:14 +08:00			`zsh-syntax-highlighting`
			`=======================`
Add README 2010-12-26 01:47:12 +08:00
Fix fish shell URL Signed-off-by: Julien Nicoulaud <julien.nicoulaud@gmail.com> 2011-02-02 04:02:45 +08:00			`[Fish shell](http://www.fishshell.com) like syntax highlighting for [Zsh](http://www.zsh.org).`
Update README 2011-01-06 06:07:22 +08:00
#110: Now using :A modifier, bump zsh version requirement 2013-12-24 19:40:35 +08:00			`Requirements: zsh 4.3.17+.`
Add README 2010-12-26 01:47:12 +08:00
README.md += overview description paragraph Based on text by Carsten Hey <carsten@debian.org>. 2015-10-20 22:56:10 +08:00			`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.`

Issue 7: Add instructions for using with oh-my-zsh 2010-12-30 23:35:55 +08:00
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-13 04:57:14 +08:00			`How to install`
			`--------------`
Add "copy-pastable" installation instructions 2010-12-26 05:10:50 +08:00
Add links to Arch Linux and Gentoo packages (Anyone knowing packages for other systems or wanting to create it, please get in touch!) 2011-12-04 02:36:21 +08:00			`### Using packages`

Update README.md Edited links to Archlinux packages (the link to `zsh-syntax-highlighting-git` is out-of-date, and `zsh-syntax-highlighting` is now available in [community]) 2014-01-09 09:21:35 +08:00			`* Arch Linux: [community/zsh-syntax-highlighting](https://www.archlinux.org/packages/zsh-syntax-highlighting) / [AUR/zsh-syntax-highlighting-git](https://aur.archlinux.org/packages/zsh-syntax-highlighting-git)`
Add links to Arch Linux and Gentoo packages (Anyone knowing packages for other systems or wanting to create it, please get in touch!) 2011-12-04 02:36:21 +08:00			`* Gentoo: [mv overlay](http://gpo.zugaina.org/app-shells/zsh-syntax-highlighting)`
docs: Document homebrew package name. Fixes zsh-users/zsh-syntax-highlighting#156. 2015-09-06 03:21:52 +08:00			`* Mac OS X / Homebrew: [brew install zsh-syntax-highlighting](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/zsh-syntax-highlighting.rb)`
Add links to Arch Linux and Gentoo packages (Anyone knowing packages for other systems or wanting to create it, please get in touch!) 2011-12-04 02:36:21 +08:00
Issue 17: Update README with "How to override the default styles" Harmonize variable names 2011-01-02 00:34:35 +08:00			`### In your ~/.zshrc`
Add "copy-pastable" installation instructions 2010-12-26 05:10:50 +08:00
README: make installation step 1 more accurate Based on a patch by George Angelopoulos <george@usermod.net>. Closes #149. 2015-09-01 01:26:57 +08:00			`* Clone this repository:`
Add "copy-pastable" installation instructions 2010-12-26 05:10:50 +08:00
Fix README links 2011-07-21 18:45:21 +08:00			`git clone git://github.com/zsh-users/zsh-syntax-highlighting.git`
Add "copy-pastable" installation instructions 2010-12-26 05:10:50 +08:00
README: make installation step 1 more accurate Based on a patch by George Angelopoulos <george@usermod.net>. Closes #149. 2015-09-01 01:26:57 +08:00			`(or [download a snapshot](https://github.com/zsh-users/zsh-syntax-highlighting/archive/master.tar.gz))`

Emphasize installations instructions ;) 2011-01-06 06:11:24 +08:00			* Source the script at the end of `~/.zshrc`:
Add README 2010-12-26 01:47:12 +08:00
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-13 04:57:14 +08:00			`source /path/to/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh`
Issue 7: Add instructions for using with oh-my-zsh 2010-12-30 23:35:55 +08:00
Issue 17: Update README with "How to override the default styles" Harmonize variable names 2011-01-02 00:34:35 +08:00			* Source `~/.zshrc` to take changes into account:
Issue 7: Add instructions for using with oh-my-zsh 2010-12-30 23:35:55 +08:00
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-13 04:57:14 +08:00			`source ~/.zshrc`
Issue 7: Add instructions for using with oh-my-zsh 2010-12-30 23:35:55 +08:00

Issue 17: Update README with "How to override the default styles" Harmonize variable names 2011-01-02 00:34:35 +08:00			`### With oh-my-zsh`
Issue 7: Add instructions for using with oh-my-zsh 2010-12-30 23:35:55 +08:00
Issue 17: Update README with "How to override the default styles" Harmonize variable names 2011-01-02 00:34:35 +08:00			`* Download the script or clone this repository in [oh-my-zsh](http://github.com/robbyrussell/oh-my-zsh) plugins directory:`

README.md: install with oh-my-zsh in a single command 2015-10-20 06:10:24 +08:00			`git clone git://github.com/zsh-users/zsh-syntax-highlighting.git ~/.oh-my-zsh/custom/plugins/zsh-syntax-highlighting`
Issue 17: Update README with "How to override the default styles" Harmonize variable names 2011-01-02 00:34:35 +08:00
docs: Clarify oh-my-zsh installation instructions Suggested-by: Ory Band (on issue #169) 2015-10-18 20:46:20 +08:00			* Activate the plugin in `~/.zshrc`:
Issue 17: Update README with "How to override the default styles" Harmonize variable names 2011-01-02 00:34:35 +08:00
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-13 04:57:14 +08:00			`plugins=( [plugins...] zsh-syntax-highlighting)`
Issue 17: Update README with "How to override the default styles" Harmonize variable names 2011-01-02 00:34:35 +08:00
			* Source `~/.zshrc` to take changes into account:
Fix relative link in main readme 2013-02-27 09:59:53 +08:00
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-13 04:57:14 +08:00			`source ~/.zshrc`
Issue 17: Update README with "How to override the default styles" Harmonize variable names 2011-01-02 00:34:35 +08:00
docs: Clarify oh-my-zsh installation instructions Suggested-by: Ory Band (on issue #169) 2015-10-18 20:46:20 +08:00			Note that `zsh-syntax-highlighting` must be the last plugin sourced,
			so make it the last element of the `$plugins` array.
Update README 2011-01-06 06:07:22 +08:00
README: give the rationale for the at-end-of-.zshrc requirement 2015-01-26 17:08:31 +08:00			`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
README: Expand the at-end-of-.zshrc FAQ answer. Fixes zsh-users/zsh-syntax-highlighting#185. 2015-09-25 02:45:35 +08:00			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.`
README: give the rationale for the at-end-of-.zshrc requirement 2015-01-26 17:08:31 +08:00
README: Document release announcements. Thanks to tibbs@fedora for setting up anitya. 2015-09-25 06:58:22 +08:00			`### 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/`

Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-13 04:57:14 +08:00			`How to tweak`
			`------------`
Update README 2011-01-06 06:07:22 +08:00
Fix relative link in main readme 2013-02-27 09:59:53 +08:00			`Syntax highlighting is done by pluggable highlighter scripts, see the [highlighters directory](highlighters)`
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-13 04:57:14 +08:00			`for documentation and configuration settings.`