Mercurial > vim
annotate runtime/doc/usr_06.txt @ 33128:b2c506f480c7 v9.0.1846
patch 9.0.1846: [security] crash in fullcommand
Commit: https://github.com/vim/vim/commit/4c6fe2e2ea62469642ed1d80b16d39e616b25cf5
Author: Christian Brabandt <cb@256bit.org>
Date: Sat Sep 2 19:30:03 2023 +0200
patch 9.0.1846: [security] crash in fullcommand
Problem: crash in fullcommand
Solution: Check for typeval correctly
Signed-off-by: Christian Brabandt <cb@256bit.org>
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Sat, 02 Sep 2023 19:45:03 +0200 |
| parents | f8116058ca76 |
| children | 4635e43f2c6f |
| rev | line source |
|---|---|
| 29314 | 1 *usr_06.txt* For Vim version 9.0. Last change: 2021 Nov 07 |
| 7 | 2 |
| 3 VIM USER MANUAL - by Bram Moolenaar | |
| 4 | |
| 5 Using syntax highlighting | |
| 6 | |
| 7 | |
| 8 Black and white text is boring. With colors your file comes to life. This | |
| 9 not only looks nice, it also speeds up your work. Change the colors used for | |
| 10 the different sorts of text. Print your text, with the colors you see on the | |
| 11 screen. | |
| 12 | |
| 13 |06.1| Switching it on | |
| 14 |06.2| No or wrong colors? | |
| 15 |06.3| Different colors | |
| 16 |06.4| With colors or without colors | |
| 17 |06.5| Printing with colors | |
| 18 |06.6| Further reading | |
| 19 | |
| 20 Next chapter: |usr_07.txt| Editing more than one file | |
| 21 Previous chapter: |usr_05.txt| Set your settings | |
| 22 Table of contents: |usr_toc.txt| | |
| 23 | |
| 24 ============================================================================== | |
| 25 *06.1* Switching it on | |
| 26 | |
| 27 It all starts with one simple command: > | |
| 28 | |
| 29 :syntax enable | |
| 30 | |
| 31 That should work in most situations to get color in your files. Vim will | |
| 32 automagically detect the type of file and load the right syntax highlighting. | |
| 33 Suddenly comments are blue, keywords brown and strings red. This makes it | |
| 34 easy to overview the file. After a while you will find that black&white text | |
| 35 slows you down! | |
| 36 | |
| 37 If you always want to use syntax highlighting, put the ":syntax enable" | |
| 38 command in your |vimrc| file. | |
| 39 | |
| 40 If you want syntax highlighting only when the terminal supports colors, you | |
| 41 can put this in your |vimrc| file: > | |
| 42 | |
| 43 if &t_Co > 1 | |
| 44 syntax enable | |
| 45 endif | |
| 46 | |
| 47 If you want syntax highlighting only in the GUI version, put the ":syntax | |
| 48 enable" command in your |gvimrc| file. | |
| 49 | |
| 50 ============================================================================== | |
| 51 *06.2* No or wrong colors? | |
| 52 | |
| 53 There can be a number of reasons why you don't see colors: | |
| 54 | |
| 55 - Your terminal does not support colors. | |
| 56 Vim will use bold, italic and underlined text, but this doesn't look | |
| 57 very nice. You probably will want to try to get a terminal with | |
| 58 colors. For Unix, I recommend the xterm from the XFree86 project: | |
| 59 |xfree-xterm|. | |
| 60 | |
| 61 - Your terminal does support colors, but Vim doesn't know this. | |
| 62 Make sure your $TERM setting is correct. For example, when using an | |
| 63 xterm that supports colors: > | |
| 64 | |
| 65 setenv TERM xterm-color | |
| 66 < | |
| 67 or (depending on your shell): > | |
| 68 | |
| 69 TERM=xterm-color; export TERM | |
| 70 | |
| 71 < The terminal name must match the terminal you are using. If it | |
| 72 still doesn't work, have a look at |xterm-color|, which shows a few | |
| 73 ways to make Vim display colors (not only for an xterm). | |
| 74 | |
| 75 - The file type is not recognized. | |
| 76 Vim doesn't know all file types, and sometimes it's near to impossible | |
| 77 to tell what language a file uses. Try this command: > | |
| 78 | |
| 79 :set filetype | |
| 80 < | |
| 81 If the result is "filetype=" then the problem is indeed that Vim | |
| 82 doesn't know what type of file this is. You can set the type | |
| 83 manually: > | |
| 84 | |
| 85 :set filetype=fortran | |
| 86 | |
| 87 < To see which types are available, look in the directory | |
| 88 $VIMRUNTIME/syntax. For the GUI you can use the Syntax menu. | |
| 89 Setting the filetype can also be done with a |modeline|, so that the | |
| 90 file will be highlighted each time you edit it. For example, this | |
| 91 line can be used in a Makefile (put it near the start or end of the | |
| 92 file): > | |
| 93 | |
| 94 # vim: syntax=make | |
| 95 | |
| 96 < You might know how to detect the file type yourself. Often the file | |
| 97 name extension (after the dot) can be used. | |
| 98 See |new-filetype| for how to tell Vim to detect that file type. | |
| 99 | |
| 100 - There is no highlighting for your file type. | |
| 101 You could try using a similar file type by manually setting it as | |
| 102 mentioned above. If that isn't good enough, you can write your own | |
| 103 syntax file, see |mysyntaxfile|. | |
| 104 | |
| 105 | |
| 106 Or the colors could be wrong: | |
| 107 | |
| 108 - The colored text is very hard to read. | |
| 109 Vim guesses the background color that you are using. If it is black | |
| 110 (or another dark color) it will use light colors for text. If it is | |
| 111 white (or another light color) it will use dark colors for text. If | |
| 112 Vim guessed wrong the text will be hard to read. To solve this, set | |
| 113 the 'background' option. For a dark background: > | |
| 114 | |
| 115 :set background=dark | |
| 116 | |
| 117 < And for a light background: > | |
| 118 | |
| 119 :set background=light | |
| 120 | |
| 121 < Make sure you put this _before_ the ":syntax enable" command, | |
| 122 otherwise the colors will already have been set. You could do | |
| 123 ":syntax reset" after setting 'background' to make Vim set the default | |
| 124 colors again. | |
| 125 | |
| 126 - The colors are wrong when scrolling bottom to top. | |
| 127 Vim doesn't read the whole file to parse the text. It starts parsing | |
| 128 wherever you are viewing the file. That saves a lot of time, but | |
| 129 sometimes the colors are wrong. A simple fix is hitting CTRL-L. Or | |
| 130 scroll back a bit and then forward again. | |
| 131 For a real fix, see |:syn-sync|. Some syntax files have a way to make | |
| 132 it look further back, see the help for the specific syntax file. For | |
| 133 example, |tex.vim| for the TeX syntax. | |
| 134 | |
| 135 ============================================================================== | |
| 136 *06.3* Different colors *:syn-default-override* | |
| 137 | |
| 138 If you don't like the default colors, you can select another color scheme. In | |
| 139 the GUI use the Edit/Color Scheme menu. You can also type the command: > | |
| 140 | |
| 141 :colorscheme evening | |
| 142 | |
| 143 "evening" is the name of the color scheme. There are several others you might | |
| 144 want to try out. Look in the directory $VIMRUNTIME/colors. | |
| 145 | |
| 146 When you found the color scheme that you like, add the ":colorscheme" command | |
| 147 to your |vimrc| file. | |
| 148 | |
| 149 You could also write your own color scheme. This is how you do it: | |
| 150 | |
| 151 1. Select a color scheme that comes close. Copy this file to your own Vim | |
| 152 directory. For Unix, this should work: > | |
| 153 | |
| 154 !mkdir ~/.vim/colors | |
| 155 !cp $VIMRUNTIME/colors/morning.vim ~/.vim/colors/mine.vim | |
| 156 < | |
| 157 This is done from Vim, because it knows the value of $VIMRUNTIME. | |
| 158 | |
| 159 2. Edit the color scheme file. These entries are useful: | |
| 160 | |
| 161 term attributes in a B&W terminal | |
| 162 cterm attributes in a color terminal | |
| 163 ctermfg foreground color in a color terminal | |
| 164 ctermbg background color in a color terminal | |
| 165 gui attributes in the GUI | |
| 166 guifg foreground color in the GUI | |
| 167 guibg background color in the GUI | |
| 168 | |
| 169 For example, to make comments green: > | |
| 170 | |
| 171 :highlight Comment ctermfg=green guifg=green | |
| 172 < | |
| 173 Attributes you can use for "cterm" and "gui" are "bold" and "underline". | |
| 174 If you want both, use "bold,underline". For details see the |:highlight| | |
| 175 command. | |
| 176 | |
| 177 3. Tell Vim to always use your color scheme. Put this line in your |vimrc|: > | |
| 178 | |
| 179 colorscheme mine | |
| 180 | |
| 181 If you want to see what the most often used color combinations look like, use | |
| 671 | 182 this command: > |
| 7 | 183 |
| 671 | 184 :runtime syntax/colortest.vim |
| 7 | 185 |
| 186 You will see text in various color combinations. You can check which ones are | |
|
26057
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
187 readable and look nice. These aren't the only colors available to you though. |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
188 You can specify #rrggbb hex colors and you can define new names for hex |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
189 colors in |v:colornames| like so: > |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
190 |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
191 let v:colornames['mine_red'] = '#aa0000' |
| 27036 | 192 |
|
26057
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
193 If you are authoring a color scheme for others to use, it is important |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
194 to define these colors only when they do not exist: > |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
195 |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
196 call extend(v:colornames, {'mine_red': '#aa0000'}, 'keep') |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
197 |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
198 This allows users of the color scheme to override the precise definition of |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
199 that color prior to loading your color scheme. For example, in a |.vimrc| |
| 27036 | 200 file: > |
|
26057
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
201 |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
202 runtime colors/lists/css_colors.vim |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
203 let v:colornames['your_red'] = v:colornames['css_red'] |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
204 colorscheme yourscheme |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
205 |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
206 As a color scheme author, you should be able to rely on some color names for |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
207 GUI colors. These are defined in `colors/lists/default.vim`. All such files |
| 26100 | 208 found on the |'runtimepath'| are loaded each time the colorscheme command is |
|
26057
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
209 run. A canonical list is provided by the vim distribution, which should |
|
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
210 include all X11 colors (previously defined in rgb.txt). |
| 7 | 211 |
| 212 ============================================================================== | |
| 213 *06.4* With colors or without colors | |
| 214 | |
| 215 Displaying text in color takes a lot of effort. If you find the displaying | |
| 216 too slow, you might want to disable syntax highlighting for a moment: > | |
| 217 | |
| 218 :syntax clear | |
| 219 | |
| 220 When editing another file (or the same one) the colors will come back. | |
| 221 | |
| 222 If you want to stop highlighting completely use: > | |
| 223 | |
| 224 :syntax off | |
| 225 | |
| 226 This will completely disable syntax highlighting and remove it immediately for | |
| 16944 | 227 all buffers. See |:syntax-off| for more details. |
| 7 | 228 |
| 229 *:syn-manual* | |
| 230 If you want syntax highlighting only for specific files, use this: > | |
| 231 | |
| 232 :syntax manual | |
| 233 | |
| 234 This will enable the syntax highlighting, but not switch it on automatically | |
| 235 when starting to edit a buffer. To switch highlighting on for the current | |
| 236 buffer, set the 'syntax' option: > | |
| 237 | |
| 238 :set syntax=ON | |
| 239 < | |
| 240 ============================================================================== | |
| 241 *06.5* Printing with colors *syntax-printing* | |
| 242 | |
| 243 In the MS-Windows version you can print the current file with this command: > | |
| 244 | |
| 245 :hardcopy | |
| 246 | |
| 247 You will get the usual printer dialog, where you can select the printer and a | |
| 248 few settings. If you have a color printer, the paper output should look the | |
| 249 same as what you see inside Vim. But when you use a dark background the | |
| 250 colors will be adjusted to look good on white paper. | |
| 251 | |
| 252 There are several options that change the way Vim prints: | |
| 253 'printdevice' | |
| 254 'printheader' | |
| 255 'printfont' | |
| 256 'printoptions' | |
| 257 | |
| 258 To print only a range of lines, use Visual mode to select the lines and then | |
| 259 type the command: > | |
| 260 | |
| 261 v100j:hardcopy | |
| 262 | |
| 263 "v" starts Visual mode. "100j" moves a hundred lines down, they will be | |
| 264 highlighted. Then ":hardcopy" will print those lines. You can use other | |
| 265 commands to move in Visual mode, of course. | |
| 266 | |
| 267 This also works on Unix, if you have a PostScript printer. Otherwise, you | |
| 268 will have to do a bit more work. You need to convert the text to HTML first, | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
269 and then print it from a web browser. |
| 7 | 270 |
| 271 Convert the current file to HTML with this command: > | |
| 272 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
273 :TOhtml |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
274 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
275 In case that doesn't work: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
276 |
| 7 | 277 :source $VIMRUNTIME/syntax/2html.vim |
| 278 | |
| 279 You will see it crunching away, this can take quite a while for a large file. | |
| 280 Some time later another window shows the HTML code. Now write this somewhere | |
| 281 (doesn't matter where, you throw it away later): | |
| 282 > | |
| 283 :write main.c.html | |
| 284 | |
| 285 Open this file in your favorite browser and print it from there. If all goes | |
| 286 well, the output should look exactly as it does in Vim. See |2html.vim| for | |
| 287 details. Don't forget to delete the HTML file when you are done with it. | |
| 288 | |
| 289 Instead of printing, you could also put the HTML file on a web server, and let | |
| 290 others look at the colored text. | |
| 291 | |
| 292 ============================================================================== | |
| 293 *06.6* Further reading | |
| 294 | |
| 295 |usr_44.txt| Your own syntax highlighted. | |
| 296 |syntax| All the details. | |
| 297 | |
| 298 ============================================================================== | |
| 299 | |
| 300 Next chapter: |usr_07.txt| Editing more than one file | |
| 301 | |
| 14519 | 302 Copyright: see |manual-copyright| vim:tw=78:ts=8:noet:ft=help:norl: |