From ebd13b60c107f424b40438404c18c3e8dc03433c Mon Sep 17 00:00:00 2001 From: Francisco de Zuviría Date: Mon, 22 Apr 2019 16:06:47 -0300 Subject: colorize: add ability to colorize multiple files into less (#7662) cless is an alias for a colorized less wrappper: colorize_via_pygmentize_less. Note that cless opens many files as independent files, navigatable with `:n` and `:p`. --- plugins/colorize/README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'plugins/colorize/README.md') diff --git a/plugins/colorize/README.md b/plugins/colorize/README.md index c006071f9..71fa87861 100644 --- a/plugins/colorize/README.md +++ b/plugins/colorize/README.md @@ -2,6 +2,10 @@ With this plugin you can syntax-highlight file contents of over 300 supported languages and other text formats. +Colorize will highlight the content based on the filename extension. If it can't find a syntax-highlighting +method for a given extension, it will try to find one by looking at the file contents. If no highlight method +is found it will just cat the file normally, without syntax highlighting. + To use it, add colorize to the plugins array of your zshrc file: ``` plugins=(... colorize) @@ -9,9 +13,16 @@ plugins=(... colorize) ## Usage -* `ccat [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. +* `ccat [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. + +* `cless [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. -Colorize will highlight the content based on the filename extension. If it can't find a syntax-highlighting method for a given extension, it will try to find one by looking at the file contents. If no highlight method is found it will just cat the file normally, without syntax highlighting. +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. ## Requirements -- cgit v1.2.3-70-g09d2 From a46798b7903dab20adf48bcad7eb69de2c8ed8a7 Mon Sep 17 00:00:00 2001 From: Jay Schwerberg Date: Tue, 5 Mar 2019 22:34:31 -0800 Subject: Update colorize README.md with env var details --- plugins/colorize/README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'plugins/colorize/README.md') diff --git a/plugins/colorize/README.md b/plugins/colorize/README.md index 71fa87861..d1f878e62 100644 --- a/plugins/colorize/README.md +++ b/plugins/colorize/README.md @@ -11,6 +11,12 @@ To use it, add colorize to the plugins array of your zshrc file: plugins=(... colorize) ``` +## Styles + +Pygments offers multiple styles. By default, the `default` style is used, but you can choose another theme by setting the `ZSH_COLORIZE_STYLE` environment variable: + +`ZSH_COLORIZE_STYLE="colorful"` + ## Usage * `ccat [files]`: colorize the contents of the file (or files, if more than one are provided). -- cgit v1.2.3-70-g09d2