summaryrefslogtreecommitdiff
path: root/plugins/colorize/README.md
diff options
context:
space:
mode:
authorProbstDJakob <jakob@probstfamilie.de>2019-12-22 21:21:14 +0100
committerMarc Cornellà <marc.cornella@live.com>2019-12-22 21:21:14 +0100
commite21fbe7dffff1619c2deb02eea8cccbd7e9814f4 (patch)
treed7499a9898ed392d5a9531433951f04fbf493558 /plugins/colorize/README.md
parente204c596ef5a1075914c5e7810ec1eba4bbe7411 (diff)
downloadzsh-e21fbe7dffff1619c2deb02eea8cccbd7e9814f4.tar.gz
zsh-e21fbe7dffff1619c2deb02eea8cccbd7e9814f4.tar.bz2
zsh-e21fbe7dffff1619c2deb02eea8cccbd7e9814f4.zip
colorize: update plugin to support less options (#8392)
Diffstat (limited to 'plugins/colorize/README.md')
-rw-r--r--plugins/colorize/README.md18
1 files changed, 7 insertions, 11 deletions
diff --git a/plugins/colorize/README.md b/plugins/colorize/README.md
index d37443011..ee4ab8036 100644
--- a/plugins/colorize/README.md
+++ b/plugins/colorize/README.md
@@ -17,10 +17,10 @@ plugins=(... colorize)
### Requirements
-This plugin requires that either of the following tools be installed:
+This plugin requires that at least one of the following tools is installed:
-* Chroma: [https://github.com/alecthomas/chroma](https://github.com/alecthomas/chroma)
-* Pygments be installed: [pygments.org](https://pygments.org/)
+* [Chroma](https://github.com/alecthomas/chroma)
+* [Pygments](https://pygments.org/download/)
### Colorize tool
@@ -41,12 +41,8 @@ ZSH_COLORIZE_STYLE="colorful"
## Usage
* `ccat <file> [files]`: colorize the contents of the file (or files, if more than one are provided).
- If no arguments are passed it will colorize the standard input or stdin.
+ If no files are passed it will colorize the standard input.
-* `cless <file> [files]`: colorize the contents of the file (or files, if more than one are provided) and
- open less. If no arguments are passed it will colorize the standard input or stdin.
-
-Note that `cless` will behave as less when provided more than one file: you have to navigate files with
-the commands `:n` for next and `:p` for previous. The downside is that less options are not supported.
-But you can circumvent this by either using the LESS environment variable, or by running `ccat file1 file2|less --opts`.
-In the latter form, the file contents will be concatenated and presented by less as a single file.
+* `cless [less-options] <file> [files]`: colorize the contents of the file (or files, if more than one are provided) and open less.
+ If no files are passed it will colorize the standard input.
+ The LESSOPEN and LESSCLOSE will be overwritten for this to work, but only in a local scope.