FM / doc

/usr/share/vim/vim91/doc

Name	Size	Mode	Actions
arabic.txt	12204	0644	edit dl rm
autocmd.txt	77872	0644	edit dl rm
builtin.txt	432001	0644	edit dl rm
change.txt	80714	0644	edit dl rm
channel.txt	59103	0644	edit dl rm
cmdline.txt	53181	0644	edit dl rm
debug.txt	6896	0644	edit dl rm
debugger.txt	5443	0644	edit dl rm
develop.txt	23118	0644	edit dl rm
diff.txt	18341	0644	edit dl rm
digraph.txt	62443	0644	edit dl rm
editing.txt	77499	0644	edit dl rm
eval.txt	173232	0644	edit dl rm
farsi.txt	523	0644	edit dl rm
filetype.txt	30622	0644	edit dl rm
fold.txt	24730	0644	edit dl rm
ft_ada.txt	18212	0644	edit dl rm
ft_context.txt	5161	0644	edit dl rm
ft_mp.txt	4706	0644	edit dl rm
ft_ps1.txt	2187	0644	edit dl rm
ft_raku.txt	4219	0644	edit dl rm
ft_rust.txt	19800	0644	edit dl rm
ft_sql.txt	30694	0644	edit dl rm
gui.txt	53499	0644	edit dl rm
gui_w32.txt	19123	0644	edit dl rm
gui_x11.txt	29318	0644	edit dl rm
hangulin.txt	598	0644	edit dl rm
hebrew.txt	5666	0644	edit dl rm
help.txt	9491	0644	edit dl rm
help.txt.vim-tiny	1350	0644	edit dl rm
helphelp.txt	16060	0644	edit dl rm
howto.txt	2916	0644	edit dl rm
if_cscop.txt	19325	0644	edit dl rm
if_lua.txt	18546	0644	edit dl rm
if_mzsch.txt	11941	0644	edit dl rm
if_ole.txt	7117	0644	edit dl rm
if_perl.txt	11451	0644	edit dl rm
if_pyth.txt	40820	0644	edit dl rm
if_ruby.txt	8516	0644	edit dl rm
if_sniff.txt	271	0644	edit dl rm
if_tcl.txt	22948	0644	edit dl rm
indent.txt	43699	0644	edit dl rm
index.txt	82373	0644	edit dl rm
insert.txt	88124	0644	edit dl rm
intro.txt	39623	0644	edit dl rm
map.txt	81176	0644	edit dl rm
mbyte.txt	58640	0644	edit dl rm
message.txt	31931	0644	edit dl rm
mlang.txt	8160	0644	edit dl rm
motion.txt	54387	0644	edit dl rm
netbeans.txt	37957	0644	edit dl rm
options.txt	419402	0644	edit dl rm
os_390.txt	4741	0644	edit dl rm
os_amiga.txt	5466	0644	edit dl rm
os_beos.txt	293	0644	edit dl rm
os_dos.txt	15495	0644	edit dl rm
os_haiku.txt	8543	0644	edit dl rm
os_mac.txt	6856	0644	edit dl rm
os_mint.txt	391	0644	edit dl rm
os_msdos.txt	523	0644	edit dl rm
os_os2.txt	299	0644	edit dl rm
os_qnx.txt	4071	0644	edit dl rm
os_risc.txt	328	0644	edit dl rm
os_unix.txt	2607	0644	edit dl rm
os_vms.txt	33743	0644	edit dl rm
os_win32.txt	14912	0644	edit dl rm
pattern.txt	63653	0644	edit dl rm
pi_getscript.txt	21077	0644	edit dl rm
pi_gzip.txt	1547	0644	edit dl rm
pi_logipat.txt	4196	0644	edit dl rm
pi_netrw.txt	181735	0644	edit dl rm
pi_paren.txt	2274	0644	edit dl rm
pi_spec.txt	4127	0644	edit dl rm
pi_tar.txt	7191	0644	edit dl rm
pi_vimball.txt	11859	0644	edit dl rm
pi_zip.txt	7778	0644	edit dl rm
popup.txt	40382	0644	edit dl rm
print.txt	31445	0644	edit dl rm
quickfix.txt	85701	0644	edit dl rm
quickref.txt	73061	0644	edit dl rm
quotes.txt	12748	0644	edit dl rm
README.Debian	324	0644	edit dl rm
recover.txt	10727	0644	edit dl rm
remote.txt	8626	0644	edit dl rm
repeat.txt	46502	0644	edit dl rm
rileft.txt	5063	0644	edit dl rm
russian.txt	3024	0644	edit dl rm
scroll.txt	14356	0644	edit dl rm
sign.txt	26860	0644	edit dl rm
spell.txt	64205	0644	edit dl rm
sponsor.txt	6776	0644	edit dl rm
starting.txt	74540	0644	edit dl rm
syntax.txt	237597	0644	edit dl rm
tabpage.txt	17246	0644	edit dl rm
tags	391091	0644	edit dl rm
tags.vim-tiny	1935	0644	edit dl rm
tagsrch.txt	40475	0644	edit dl rm
term.txt	55685	0644	edit dl rm
terminal.txt	63169	0644	edit dl rm
testing.txt	22507	0644	edit dl rm
textprop.txt	20478	0644	edit dl rm
tips.txt	21336	0644	edit dl rm
todo.txt	316358	0644	edit dl rm
uganda.txt	13052	0644	edit dl rm
undo.txt	17811	0644	edit dl rm
userfunc.txt	20624	0644	edit dl rm
usr_01.txt	7076	0644	edit dl rm
usr_02.txt	24228	0644	edit dl rm
usr_03.txt	23934	0644	edit dl rm
usr_04.txt	19131	0644	edit dl rm
usr_05.txt	27946	0644	edit dl rm
usr_06.txt	10639	0644	edit dl rm
usr_07.txt	15995	0644	edit dl rm
usr_08.txt	19379	0644	edit dl rm
usr_09.txt	11502	0644	edit dl rm
usr_10.txt	29200	0644	edit dl rm
usr_11.txt	13025	0644	edit dl rm
usr_12.txt	13433	0644	edit dl rm
usr_20.txt	13733	0644	edit dl rm
usr_21.txt	18456	0644	edit dl rm
usr_22.txt	14904	0644	edit dl rm
usr_23.txt	12744	0644	edit dl rm
usr_24.txt	20827	0644	edit dl rm
usr_25.txt	19176	0644	edit dl rm
usr_26.txt	8259	0644	edit dl rm
usr_27.txt	17709	0644	edit dl rm
usr_28.txt	16020	0644	edit dl rm
usr_29.txt	20259	0644	edit dl rm
usr_30.txt	22658	0644	edit dl rm
usr_31.txt	10399	0644	edit dl rm
usr_32.txt	5378	0644	edit dl rm
usr_40.txt	23554	0644	edit dl rm
usr_41.txt	65272	0644	edit dl rm
usr_42.txt	13853	0644	edit dl rm
usr_43.txt	7409	0644	edit dl rm
usr_44.txt	28948	0644	edit dl rm
usr_45.txt	17680	0644	edit dl rm
usr_50.txt	4554	0644	edit dl rm
usr_51.txt	25517	0644	edit dl rm
usr_52.txt	13498	0644	edit dl rm
usr_90.txt	16778	0644	edit dl rm
usr_toc.txt	9886	0644	edit dl rm
various.txt	32432	0644	edit dl rm
version4.txt	13911	0644	edit dl rm
version5.txt	308529	0644	edit dl rm
version6.txt	576942	0644	edit dl rm
version7.txt	674698	0644	edit dl rm
version8.txt	1599852	0644	edit dl rm
version9.txt	1611325	0644	edit dl rm
vim9.txt	91753	0644	edit dl rm
vim9class.txt	41040	0644	edit dl rm
visual.txt	22625	0644	edit dl rm
vi_diff.txt	57404	0644	edit dl rm
windows.txt	58706	0644	edit dl rm
workshop.txt	371	0644	edit dl rm

Edit: /usr/share/vim/vim91/doc/usr_06.txt (10639B)

*usr_06.txt*	For Vim version 9.1.  Last change: 2021 Nov 07

VIM USER MANUAL - by Bram Moolenaar

Using syntax highlighting

Black and white text is boring.  With colors your file comes to life.  This
not only looks nice, it also speeds up your work.  Change the colors used for
the different sorts of text.  Print your text, with the colors you see on the
screen.

|06.1|	Switching it on
|06.2|	No or wrong colors?
|06.3|	Different colors
|06.4|	With colors or without colors
|06.5|	Printing with colors
|06.6|	Further reading

==============================================================================
*06.1*	Switching it on

It all starts with one simple command: >

:syntax enable

That should work in most situations to get color in your files.  Vim will
automagically detect the type of file and load the right syntax highlighting.
Suddenly comments are blue, keywords brown and strings red.  This makes it
easy to overview the file.  After a while you will find that black&white text
slows you down!

If you always want to use syntax highlighting, put the ":syntax enable"
command in your |vimrc| file.

If you want syntax highlighting only when the terminal supports colors, you
can put this in your |vimrc| file: >

if &t_Co > 1
	   syntax enable
	endif

If you want syntax highlighting only in the GUI version, put the ":syntax
enable" command in your |gvimrc| file.

==============================================================================
*06.2*	No or wrong colors?

There can be a number of reasons why you don't see colors:

- Your terminal does not support colors.
	Vim will use bold, italic and underlined text, but this doesn't look
	very nice.  You probably will want to try to get a terminal with
	colors.  For Unix, I recommend the xterm from the XFree86 project:
	|xfree-xterm|.

- Your terminal does support colors, but Vim doesn't know this.
	Make sure your $TERM setting is correct.  For example, when using an
	xterm that supports colors: >

setenv TERM xterm-color
<
	or (depending on your shell): >

TERM=xterm-color; export TERM

<	The terminal name must match the terminal you are using.  If it
	still doesn't work, have a look at |xterm-color|, which shows a few
	ways to make Vim display colors (not only for an xterm).

- The file type is not recognized.
	Vim doesn't know all file types, and sometimes it's near to impossible
	to tell what language a file uses.  Try this command: >

:set filetype
<
	If the result is "filetype=" then the problem is indeed that Vim
	doesn't know what type of file this is.  You can set the type
	manually: >

:set filetype=fortran

<	To see which types are available, look in the directory
	$VIMRUNTIME/syntax.  For the GUI you can use the Syntax menu.
	Setting the filetype can also be done with a |modeline|, so that the
	file will be highlighted each time you edit it.  For example, this
	line can be used in a Makefile (put it near the start or end of the
	file): >

# vim: syntax=make

<	You might know how to detect the file type yourself.  Often the file
	name extension (after the dot) can be used.
	See |new-filetype| for how to tell Vim to detect that file type.

- There is no highlighting for your file type.
	You could try using a similar file type by manually setting it as
	mentioned above.  If that isn't good enough, you can write your own
	syntax file, see |mysyntaxfile|.

Or the colors could be wrong:

- The colored text is very hard to read.
	Vim guesses the background color that you are using.  If it is black
	(or another dark color) it will use light colors for text.  If it is
	white (or another light color) it will use dark colors for text.  If
	Vim guessed wrong the text will be hard to read.  To solve this, set
	the 'background' option.  For a dark background: >

:set background=dark

<	And for a light background: >

:set background=light

<	Make sure you put this _before_ the ":syntax enable" command,
	otherwise the colors will already have been set.  You could do
	":syntax reset" after setting 'background' to make Vim set the default
	colors again.

- The colors are wrong when scrolling bottom to top.
	Vim doesn't read the whole file to parse the text.  It starts parsing
	wherever you are viewing the file.  That saves a lot of time, but
	sometimes the colors are wrong.  A simple fix is hitting CTRL-L.  Or
	scroll back a bit and then forward again.
	For a real fix, see |:syn-sync|.  Some syntax files have a way to make
	it look further back, see the help for the specific syntax file.  For
	example, |tex.vim| for the TeX syntax.

==============================================================================
*06.3*	Different colors				*:syn-default-override*

If you don't like the default colors, you can select another color scheme.  In
the GUI use the Edit/Color Scheme menu.  You can also type the command: >

:colorscheme evening

"evening" is the name of the color scheme.  There are several others you might
want to try out.  Look in the directory $VIMRUNTIME/colors.

When you found the color scheme that you like, add the ":colorscheme" command
to your |vimrc| file.

You could also write your own color scheme.  This is how you do it:

1. Select a color scheme that comes close.  Copy this file to your own Vim
   directory.  For Unix, this should work: >

!mkdir ~/.vim/colors
	!cp $VIMRUNTIME/colors/morning.vim ~/.vim/colors/mine.vim
<
   This is done from Vim, because it knows the value of $VIMRUNTIME.

2. Edit the color scheme file.  These entries are useful:

term		attributes in a B&W terminal
	cterm		attributes in a color terminal
	ctermfg		foreground color in a color terminal
	ctermbg		background color in a color terminal
	gui		attributes in the GUI
	guifg		foreground color in the GUI
	guibg		background color in the GUI

For example, to make comments green: >

:highlight Comment ctermfg=green guifg=green
<
   Attributes you can use for "cterm" and "gui" are "bold" and "underline".
   If you want both, use "bold,underline".  For details see the |:highlight|
   command.

3. Tell Vim to always use your color scheme.  Put this line in your |vimrc|: >

colorscheme mine

If you want to see what the most often used color combinations look like, use
this command: >

:runtime syntax/colortest.vim

You will see text in various color combinations.  You can check which ones are
readable and look nice. These aren't the only colors available to you though.
You can specify #rrggbb hex colors and you can define new names for hex
colors in |v:colornames| like so: >

let v:colornames['mine_red'] = '#aa0000'

If you are authoring a color scheme for others to use, it is important
to define these colors only when they do not exist: >

call extend(v:colornames, {'mine_red': '#aa0000'}, 'keep')

This allows users of the color scheme to override the precise definition of
that color prior to loading your color scheme. For example, in a |.vimrc|
file: >

runtime colors/lists/css_colors.vim
	let v:colornames['your_red'] = v:colornames['css_red']
	colorscheme yourscheme

As a color scheme author, you should be able to rely on some color names for
GUI colors. These are defined in `colors/lists/default.vim`. All such files
found on the |'runtimepath'| are loaded each time the colorscheme command is
run. A canonical list is provided by the vim distribution, which should
include all X11 colors (previously defined in rgb.txt).

==============================================================================
*06.4*	With colors or without colors

Displaying text in color takes a lot of effort.  If you find the displaying
too slow, you might want to disable syntax highlighting for a moment: >

:syntax clear

When editing another file (or the same one) the colors will come back.

If you want to stop highlighting completely use: >

:syntax off

This will completely disable syntax highlighting and remove it immediately for
all buffers.  See |:syntax-off| for more details.

*:syn-manual*
If you want syntax highlighting only for specific files, use this: >

:syntax manual

This will enable the syntax highlighting, but not switch it on automatically
when starting to edit a buffer.  To switch highlighting on for the current
buffer, set the 'syntax' option: >

:set syntax=ON
<
==============================================================================
*06.5*	Printing with colors				*syntax-printing*

In the MS-Windows version you can print the current file with this command: >

:hardcopy

You will get the usual printer dialog, where you can select the printer and a
few settings.  If you have a color printer, the paper output should look the
same as what you see inside Vim.  But when you use a dark background the
colors will be adjusted to look good on white paper.

There are several options that change the way Vim prints:
	'printdevice'
	'printheader'
	'printfont'
	'printoptions'

To print only a range of lines,  use Visual mode to select the lines and then
type the command: >

v100j:hardcopy

"v" starts Visual mode.  "100j" moves a hundred lines down, they will be
highlighted.  Then ":hardcopy" will print those lines.  You can use other
commands to move in Visual mode, of course.

This also works on Unix, if you have a PostScript printer.  Otherwise, you
will have to do a bit more work.  You need to convert the text to HTML first,
and then print it from a web browser.

Convert the current file to HTML with this command: >

:TOhtml

In case that doesn't work: >

:source $VIMRUNTIME/syntax/2html.vim

You will see it crunching away, this can take quite a while for a large file.
Some time later another window shows the HTML code.  Now write this somewhere
(doesn't matter where, you throw it away later):
>
	:write main.c.html

Open this file in your favorite browser and print it from there.  If all goes
well, the output should look exactly as it does in Vim.  See |2html.vim| for
details.  Don't forget to delete the HTML file when you are done with it.

Instead of printing, you could also put the HTML file on a web server, and let
others look at the colored text.

==============================================================================
*06.6*	Further reading

|usr_44.txt|  Your own syntax highlighted.
|syntax|      All the details.

==============================================================================

Next chapter: |usr_07.txt|  Editing more than one file

cmd: