diff options
| author | Hugues Hiegel <hugues.hiegel@qosmos.com> | 2013-04-25 16:58:15 +0200 |
|---|---|---|
| committer | Hugues Hiegel <hugues.hiegel@qosmos.com> | 2013-04-25 16:59:48 +0200 |
| commit | af47b3d8e6875f093502e45fbed918263e693331 (patch) | |
| tree | 55fbd2357a4fe2a5e0cf2ef2cc4787a0a4b67b77 /doc | |
| parent | 002782c54670a1f02b6f0cd62e23b2a1b3b9660f (diff) | |
[AnsiEsc] Ansi Escapes plugin
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/AnsiEsc.txt | 134 | ||||
| -rw-r--r-- | doc/tags | 76 |
2 files changed, 210 insertions, 0 deletions
diff --git a/doc/AnsiEsc.txt b/doc/AnsiEsc.txt new file mode 100644 index 0000000..4fe361e --- /dev/null +++ b/doc/AnsiEsc.txt @@ -0,0 +1,134 @@ +*AnsiEsc.txt* Ansi Escape Sequence Visualization Dec 13, 2010 + +Author: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamily.AbizM> + (remove NOSPAM from Campbell's email first) +Copyright: (c) 2004-2010 by Charles E. Campbell, Jr. *AnsiEsc-copyright* + The VIM LICENSE applies to AnsiEsc.vim and AnsiEsc.txt + (see |copyright|) except use "AnsiEsc" instead of "Vim". + No warranty, express or implied. Use At-Your-Own-Risk. + +============================================================================== +1. Contents *AnsiEsc* *AnsiEsc-contents* + 1. Contents ...................................|AnsiEsc-contents| + 2. AnsiEsc Manual ...................................|AnsiEsc| + 3. AnsiEsc History ...................................|AnsiEsc-history| + +============================================================================== +2. Manual *AnsiEsc-manual* + + CONCEAL -- the best mode. + For this, your vim must have +conceal. A typical way to get the + conceal feature: + + * cd ..wherever../vim72/ + * wget http://vince.negri.googlepages.com/conceal-ownsyntax.diff + * patch -p0 < conceal-ownsyntax.diff + * make distclean + * configure --with-features=huge + * make + * make install + + Normal: -- ansi escape sequences themselves are Ignore'd~ + Ansi escape sequences have the expected effect on subsequent + text, but the ansi escape sequences themselves still take up + screen columns. The sequences are displayed using "Ignore" + highlighting; depending on your colorscheme, this should either + make the sequences blend into your background or be visually + suppressed. If the sequences aren't suppressed, you need to + improve your colorscheme! + + USAGE~ + :AnsiEsc -- toggles Ansi escape sequence highlighting + :AnsiEsc! -- rebuilds highlighting for new/removed three + or more element Ansi escape sequences. + + RESULT~ + Ansi escape sequences become concealed or ignored (depending + on whether your vim supports Negri's conceal mode), and their + effect on subsequent text is emulated with Vim's syntax + highlighting. + + Syntax highlighting for one and two element codes are + hard-coded into AnsiEsc.vim. There are too many possibilities + for three or more element codes; these are supported by + examining the file for such sequences and only building syntax + highlighting rules for such sequences as are actually present + in the document. + + EXAMPLE~ + + You'll want to use :AnsiEsc to see the following properly! + (using Vince Negri's conceal option or vim 7.3) + + [34;47mColor Escape Sequences[m +[37m - [m [37;1m 1 [m [37;2m 2 [m [37;3m 3 [m [37;4m 4 [m [37;5m 5 [m [37;7m 7 [m +[30mblack[m [30;1mblack[m [30;2mblack[m [30;3mblack[m [30;4mblack[m [30;5mblack[m [30;7mblack[m +[31mred[m [31;1mred[m [31;2mred[m [31;3mred[m [31;4mred[m [31;5mred[m [31;7mred[m +[32mgreen[m [32;1mgreen[m [32;2mgreen[m [32;3mgreen[m [32;4mgreen[m [32;5mgreen[m [32;7mgreen[m +[33myellow[m [33;1myellow[m [33;2myellow[m [33;3myellow[m [33;4myellow[m [33;5myellow[m [33;7myellow[m +[34mblue[m [34;1mblue[m [34;2mblue[m [34;3mblue[m [34;4mblue[m [34;5mblue[m [34;7mblue[m +[35mmagenta[m [35;1mmagenta[m [35;2mmagenta[m [35;3mmagenta[m [35;4mmagenta[m [35;5mmagenta[m [35;7mmagenta[m +[36mcyan[m [36;1mcyan[m [36;2mcyan[m [36;3mcyan[m [36;4mcyan[m [36;5mcyan[m [36;7mcyan[m +[37mwhite[m [37;1mwhite[m [37;2mwhite[m [37;3mwhite[m [37;4mwhite[m [37;5mwhite[m [37;7mwhite[m + +Black [30;40mB[m [30;41mB[m [30;42mB[m [30;43mB[m [30;44mB[m [30;45mB[m [30;46mB[m [30;47mB[m +Red [31;40mR[m [31;41mR[m [31;42mR[m [31;43mR[m [31;44mR[m [31;45mR[m [31;46mR[m [31;47mR[m +Green [32;40mG[m [32;41mG[m [32;42mG[m [32;43mG[m [32;44mG[m [32;45mG[m [32;46mG[m [32;47mG[m +Yellow [33;40mY[m [33;41mY[m [33;42mY[m [33;43mY[m [33;44mY[m [33;45mY[m [33;46mY[m [33;47mY[m +Blue [34;40mB[m [34;41mB[m [34;42mB[m [34;43mB[m [34;44mB[m [34;45mB[m [34;46mB[m [34;47mB[m +Magenta [35;40mM[m [35;41mM[m [35;42mM[m [35;43mM[m [35;44mM[m [35;45mM[m [35;46mM[m [35;47mM[m +Cyan [36;40mC[m [36;41mC[m [36;42mC[m [36;43mC[m [36;44mC[m [36;45mC[m [36;46mC[m [36;47mC[m +White [37;40mW[m [37;41mW[m [37;42mW[m [37;43mW[m [37;44mW[m [37;45mW[m [37;46mW[m [37;47mW[m + + Here's the vim logo: + + [30;48;5;22m/ \[m + [30;48;5;22m/ \[m + [30;48;5;22m/ \[m + [30;48;5;22m/ \[m + [38;5;34;48;5;251m+----+[30;48;5;22m [38;5;34;48;5;251m+----+[30;48;5;22m \[m + [38;5;34;48;5;251m++ ++[30;48;5;22m [38;5;34;48;5;251m+- |[30;48;5;22m \[m + [30;48;5;22m/[38;5;34;48;5;251m| |[30;48;5;22m [m[38;5;34;48;5;251m/ /[30;48;5;22m \[m +[30;48;5;22mX [38;5;34;48;5;251m| |[30;48;5;22m [38;5;34;48;5;251m/ /O[30;48;5;22m \[m + [30;48;5;22m\[38;5;34;48;5;251m| |[30;48;5;22m [38;5;34;48;5;251m/ /+-+[30;48;5;22m [38;5;34;48;5;251m+-\[30;48;5;22m/[38;5;34;48;5;251m/-+[m + [38;5;34;48;5;251m| |/ /[30;48;5;22m [38;5;34;48;5;251m| |[30;48;5;22m [38;5;34;48;5;251m| v |[m + [38;5;34;48;5;251m| / /[30;48;5;22m [38;5;34;48;5;251m| |[30;48;5;22m [m[38;5;34;48;5;251m| + [38;5;34;48;5;251m+|[m + [38;5;34;48;5;251m| /[30;48;5;22m [38;5;34;48;5;251m| |[30;48;5;22m/[38;5;34;48;5;251m| |[38;5;34;48;5;251m\/[m[38;5;34;48;5;251m||[m + [38;5;34;48;5;251m+----[30;48;5;22m\ [38;5;34;48;5;251m+-+ [38;5;34;48;5;251m+-+[m [38;5;34;48;5;251m++[m + [30;48;5;22m\ /[m + [30;48;5;22m\ /[m + + +============================================================================== +3. AnsiEsc History *AnsiEsc-history* {{{1 + v12 Jul 23, 2010 * changed conc to |'cole'| to correspond to vim 7.3's + change + Aug 10, 2010 * (Rainer M Schmid) changed conceallevel setting to + depend on whether the version is before vim 7.3; + for 7.3, also sets concealcursor + * Restores conc/cole/cocu settings when AnsiEsc is + toggled off. + Dec 13, 2010 * Included some additional sequences involving 0 + v11 Apr 20, 2010 * AnsiEsc now supports enabling/disabling via a menu + * <esc>[K and <esc>[00m now supported (as + grep --color=always issues them) + v10 May 06, 2009 * Three or more codes in an ANSI escape sequence are + supported by building custom syntax and highlighting + commands. + May 20, 2009 * cecutil bugfix + v9 May 12, 2008 * Now in plugin + autoload format. Provides :AnsiEsc + command to toggle Ansi-escape sequence processing. + Jan 01, 2009 * Applies Ignore highlighting to extended Ansi escape + sequences support 256-colors. + Mar 18, 2009 * Includes "rapid blink" ansi escape sequences. Vim + doesn't have a blinking attribute, so such text uses + "standout" for vim and "undercurl" for gvim. + v8 Aug 16, 2006 * Uses undercurl, and so is only available for vim 7.0 + v7 Dec 14, 2004 * Works better with vim2ansi output and Vince Negri's + conceal patch for vim 6.x. + v2 Nov 24, 2004 * This version didn't use Vince Negri's conceal patch + (used Ignore highlighting) + +============================================================================== +Modelines: {{{1 +vim:tw=78:ts=8:ft=help:fdm=marker: diff --git a/doc/tags b/doc/tags new file mode 100644 index 0000000..db8d2f0 --- /dev/null +++ b/doc/tags @@ -0,0 +1,76 @@ +:CVSEdit vcscommand.txt /*:CVSEdit* +:CVSEditors vcscommand.txt /*:CVSEditors* +:CVSUnedit vcscommand.txt /*:CVSUnedit* +:CVSWatch vcscommand.txt /*:CVSWatch* +:CVSWatchAdd vcscommand.txt /*:CVSWatchAdd* +:CVSWatchOff vcscommand.txt /*:CVSWatchOff* +:CVSWatchOn vcscommand.txt /*:CVSWatchOn* +:CVSWatchRemove vcscommand.txt /*:CVSWatchRemove* +:CVSWatchers vcscommand.txt /*:CVSWatchers* +:VCSAdd vcscommand.txt /*:VCSAdd* +:VCSAnnotate vcscommand.txt /*:VCSAnnotate* +:VCSBlame vcscommand.txt /*:VCSBlame* +:VCSCommit vcscommand.txt /*:VCSCommit* +:VCSDelete vcscommand.txt /*:VCSDelete* +:VCSDiff vcscommand.txt /*:VCSDiff* +:VCSGotoOriginal vcscommand.txt /*:VCSGotoOriginal* +:VCSInfo vcscommand.txt /*:VCSInfo* +:VCSLock vcscommand.txt /*:VCSLock* +:VCSLog vcscommand.txt /*:VCSLog* +:VCSRemove vcscommand.txt /*:VCSRemove* +:VCSRevert vcscommand.txt /*:VCSRevert* +:VCSReview vcscommand.txt /*:VCSReview* +:VCSStatus vcscommand.txt /*:VCSStatus* +:VCSUnlock vcscommand.txt /*:VCSUnlock* +:VCSUpdate vcscommand.txt /*:VCSUpdate* +:VCSVimDiff vcscommand.txt /*:VCSVimDiff* +AnsiEsc AnsiEsc.txt /*AnsiEsc* +AnsiEsc-contents AnsiEsc.txt /*AnsiEsc-contents* +AnsiEsc-copyright AnsiEsc.txt /*AnsiEsc-copyright* +AnsiEsc-history AnsiEsc.txt /*AnsiEsc-history* +AnsiEsc-manual AnsiEsc.txt /*AnsiEsc-manual* +AnsiEsc.txt AnsiEsc.txt /*AnsiEsc.txt* +VCSCommandCVSDiffOpt vcscommand.txt /*VCSCommandCVSDiffOpt* +VCSCommandCVSExec vcscommand.txt /*VCSCommandCVSExec* +VCSCommandCommitOnWrite vcscommand.txt /*VCSCommandCommitOnWrite* +VCSCommandDeleteOnHide vcscommand.txt /*VCSCommandDeleteOnHide* +VCSCommandDiffSplit vcscommand.txt /*VCSCommandDiffSplit* +VCSCommandDisableExtensionMappings vcscommand.txt /*VCSCommandDisableExtensionMappings* +VCSCommandDisableMappings vcscommand.txt /*VCSCommandDisableMappings* +VCSCommandEdit vcscommand.txt /*VCSCommandEdit* +VCSCommandEnableBufferSetup vcscommand.txt /*VCSCommandEnableBufferSetup* +VCSCommandResultBufferNameExtension vcscommand.txt /*VCSCommandResultBufferNameExtension* +VCSCommandResultBufferNameFunction vcscommand.txt /*VCSCommandResultBufferNameFunction* +VCSCommandSVKExec vcscommand.txt /*VCSCommandSVKExec* +VCSCommandSVNDiffExt vcscommand.txt /*VCSCommandSVNDiffExt* +VCSCommandSVNDiffOpt vcscommand.txt /*VCSCommandSVNDiffOpt* +VCSCommandSVNExec vcscommand.txt /*VCSCommandSVNExec* +VCSCommandSplit vcscommand.txt /*VCSCommandSplit* +b:VCSCommandCommand vcscommand.txt /*b:VCSCommandCommand* +b:VCSCommandOriginalBuffer vcscommand.txt /*b:VCSCommandOriginalBuffer* +b:VCSCommandSourceFile vcscommand.txt /*b:VCSCommandSourceFile* +b:VCSCommandVCSType vcscommand.txt /*b:VCSCommandVCSType* +cvscommand-changes vcscommand.txt /*cvscommand-changes* +vcscommand vcscommand.txt /*vcscommand* +vcscommand-buffer-management vcscommand.txt /*vcscommand-buffer-management* +vcscommand-buffer-variables vcscommand.txt /*vcscommand-buffer-variables* +vcscommand-bugs vcscommand.txt /*vcscommand-bugs* +vcscommand-commands vcscommand.txt /*vcscommand-commands* +vcscommand-config vcscommand.txt /*vcscommand-config* +vcscommand-contents vcscommand.txt /*vcscommand-contents* +vcscommand-customize vcscommand.txt /*vcscommand-customize* +vcscommand-events vcscommand.txt /*vcscommand-events* +vcscommand-install vcscommand.txt /*vcscommand-install* +vcscommand-intro vcscommand.txt /*vcscommand-intro* +vcscommand-manual vcscommand.txt /*vcscommand-manual* +vcscommand-mappings vcscommand.txt /*vcscommand-mappings* +vcscommand-mappings-override vcscommand.txt /*vcscommand-mappings-override* +vcscommand-naming vcscommand.txt /*vcscommand-naming* +vcscommand-options vcscommand.txt /*vcscommand-options* +vcscommand-ssh vcscommand.txt /*vcscommand-ssh* +vcscommand-ssh-config vcscommand.txt /*vcscommand-ssh-config* +vcscommand-ssh-env vcscommand.txt /*vcscommand-ssh-env* +vcscommand-ssh-other vcscommand.txt /*vcscommand-ssh-other* +vcscommand-ssh-wrapper vcscommand.txt /*vcscommand-ssh-wrapper* +vcscommand-statusline vcscommand.txt /*vcscommand-statusline* +vcscommand.txt vcscommand.txt /*vcscommand.txt* |