FM / doc

/usr/share/vim/vim80/doc

Name	Size	Mode	Actions
arabic.txt	11936	0644	edit dl rm
autocmd.txt	65402	0644	edit dl rm
change.txt	74877	0644	edit dl rm
channel.txt	30819	0644	edit dl rm
cmdline.txt	47283	0644	edit dl rm
debug.txt	7182	0644	edit dl rm
debugger.txt	5744	0644	edit dl rm
develop.txt	22344	0644	edit dl rm
diff.txt	16525	0644	edit dl rm
digraph.txt	62123	0644	edit dl rm
editing.txt	73176	0644	edit dl rm
eval.txt	444462	0644	edit dl rm
farsi.txt	9703	0644	edit dl rm
filetype.txt	26647	0644	edit dl rm
fold.txt	23694	0644	edit dl rm
ft_ada.txt	18247	0644	edit dl rm
ft_rust.txt	9526	0644	edit dl rm
ft_sql.txt	30694	0644	edit dl rm
gui.txt	45592	0644	edit dl rm
gui_w32.txt	18916	0644	edit dl rm
gui_x11.txt	29480	0644	edit dl rm
hangulin.txt	3291	0644	edit dl rm
hebrew.txt	5714	0644	edit dl rm
help.txt	8578	0644	edit dl rm
helphelp.txt	14338	0644	edit dl rm
howto.txt	2911	0644	edit dl rm
if_cscop.txt	19361	0644	edit dl rm
if_lua.txt	14642	0644	edit dl rm
if_mzsch.txt	11823	0644	edit dl rm
if_ole.txt	7405	0644	edit dl rm
if_perl.txt	11149	0644	edit dl rm
if_pyth.txt	37944	0644	edit dl rm
if_ruby.txt	8014	0644	edit dl rm
if_sniff.txt	266	0644	edit dl rm
if_tcl.txt	23026	0644	edit dl rm
indent.txt	39427	0644	edit dl rm
index.txt	76443	0644	edit dl rm
insert.txt	83156	0644	edit dl rm
intro.txt	39226	0644	edit dl rm
map.txt	64668	0644	edit dl rm
mbyte.txt	59306	0644	edit dl rm
message.txt	31230	0644	edit dl rm
mlang.txt	7850	0644	edit dl rm
motion.txt	51602	0644	edit dl rm
netbeans.txt	36998	0644	edit dl rm
options.txt	389116	0644	edit dl rm
os_390.txt	4753	0644	edit dl rm
os_amiga.txt	5461	0644	edit dl rm
os_beos.txt	10983	0644	edit dl rm
os_dos.txt	12021	0644	edit dl rm
os_mac.txt	6851	0644	edit dl rm
os_mint.txt	1402	0644	edit dl rm
os_msdos.txt	518	0644	edit dl rm
os_os2.txt	294	0644	edit dl rm
os_qnx.txt	4071	0644	edit dl rm
os_risc.txt	323	0644	edit dl rm
os_unix.txt	2595	0644	edit dl rm
os_vms.txt	32100	0644	edit dl rm
os_win32.txt	13348	0644	edit dl rm
pattern.txt	59321	0644	edit dl rm
pi_getscript.txt	21078	0644	edit dl rm
pi_gzip.txt	1321	0644	edit dl rm
pi_logipat.txt	4186	0644	edit dl rm
pi_netrw.txt	175550	0644	edit dl rm
pi_paren.txt	2269	0644	edit dl rm
pi_spec.txt	4122	0644	edit dl rm
pi_tar.txt	6223	0644	edit dl rm
pi_vimball.txt	11853	0644	edit dl rm
pi_zip.txt	7229	0644	edit dl rm
print.txt	31158	0644	edit dl rm
quickfix.txt	69021	0644	edit dl rm
quickref.txt	71256	0644	edit dl rm
quotes.txt	12743	0644	edit dl rm
recover.txt	10694	0644	edit dl rm
remote.txt	8420	0644	edit dl rm
repeat.txt	39573	0644	edit dl rm
rileft.txt	4976	0644	edit dl rm
russian.txt	3090	0644	edit dl rm
scroll.txt	14071	0644	edit dl rm
sign.txt	6891	0644	edit dl rm
spell.txt	62781	0644	edit dl rm
sponsor.txt	7198	0644	edit dl rm
starting.txt	73622	0644	edit dl rm
syntax.txt	217471	0644	edit dl rm
tabpage.txt	16720	0644	edit dl rm
tags	328832	0644	edit dl rm
tagsrch.txt	36636	0644	edit dl rm
term.txt	45416	0644	edit dl rm
terminal.txt	33567	0644	edit dl rm
tips.txt	20556	0644	edit dl rm
todo.txt	296268	0644	edit dl rm
uganda.txt	14024	0644	edit dl rm
undo.txt	16539	0644	edit dl rm
usr_01.txt	7090	0644	edit dl rm
usr_02.txt	24339	0644	edit dl rm
usr_03.txt	23605	0644	edit dl rm
usr_04.txt	19082	0644	edit dl rm
usr_05.txt	23824	0644	edit dl rm
usr_06.txt	9587	0644	edit dl rm
usr_07.txt	15984	0644	edit dl rm
usr_08.txt	19374	0644	edit dl rm
usr_09.txt	11450	0644	edit dl rm
usr_10.txt	29180	0644	edit dl rm
usr_11.txt	12611	0644	edit dl rm
usr_12.txt	13424	0644	edit dl rm
usr_20.txt	13703	0644	edit dl rm
usr_21.txt	18373	0644	edit dl rm
usr_22.txt	14297	0644	edit dl rm
usr_23.txt	12588	0644	edit dl rm
usr_24.txt	20869	0644	edit dl rm
usr_25.txt	19114	0644	edit dl rm
usr_26.txt	8254	0644	edit dl rm
usr_27.txt	17723	0644	edit dl rm
usr_28.txt	16015	0644	edit dl rm
usr_29.txt	20116	0644	edit dl rm
usr_30.txt	22656	0644	edit dl rm
usr_31.txt	10394	0644	edit dl rm
usr_32.txt	5373	0644	edit dl rm
usr_40.txt	23184	0644	edit dl rm
usr_41.txt	89301	0644	edit dl rm
usr_42.txt	13798	0644	edit dl rm
usr_43.txt	7404	0644	edit dl rm
usr_44.txt	29211	0644	edit dl rm
usr_45.txt	17912	0644	edit dl rm
usr_90.txt	17661	0644	edit dl rm
usr_toc.txt	9218	0644	edit dl rm
various.txt	28852	0644	edit dl rm
version4.txt	13906	0644	edit dl rm
version5.txt	308543	0644	edit dl rm
version6.txt	577052	0644	edit dl rm
version7.txt	674766	0644	edit dl rm
version8.txt	684252	0644	edit dl rm
visual.txt	21843	0644	edit dl rm
vi_diff.txt	42812	0644	edit dl rm
windows.txt	53030	0644	edit dl rm
workshop.txt	4631	0644	edit dl rm

Edit: /usr/share/vim/vim80/doc/sign.txt (6891B)

*sign.txt*      For Vim version 8.0.  Last change: 2016 Aug 17

VIM REFERENCE MANUAL    by Gordon Prieur
					  and Bram Moolenaar

Sign Support Features				*sign-support*

1. Introduction				|sign-intro|
2. Commands				|sign-commands|

{Vi does not have any of these features}
{only available when compiled with the |+signs| feature}

==============================================================================
1. Introduction					*sign-intro* *signs*

When a debugger or other IDE tool is driving an editor it needs to be able
to give specific highlights which quickly tell the user useful information
about the file.  One example of this would be a debugger which had an icon
in the left-hand column denoting a breakpoint.  Another example might be an
arrow representing the Program Counter (PC).  The sign features allow both
placement of a sign, or icon, in the left-hand side of the window and
definition of a highlight which will be applied to that line.  Displaying the
sign as an image is most likely only feasible in gvim (although Sun
Microsystem's dtterm does support this it's the only terminal emulator I know
of which does).  A text sign and the highlight should be feasible in any color
terminal emulator.

Signs and highlights are not useful just for debuggers.  Sun's Visual
WorkShop uses signs and highlights to mark build errors and SourceBrowser
hits.  Additionally, the debugger supports 8 to 10 different signs and
highlight colors. |workshop|  Same for Netbeans |netbeans|.

There are two steps in using signs:

1. Define the sign.  This specifies the image, text and highlighting.  For
   example, you can define a "break" sign with an image of a stop roadsign and
   text "!!".

2. Place the sign.  This specifies the file and line number where the sign is
   displayed.  A defined sign can be placed several times in different lines
   and files.

When signs are defined for a file, Vim will automatically add a column of two
characters to display them in.  When the last sign is unplaced the column
disappears again.  This behavior can be changed with the 'signcolumn' option.

The color of the column is set with the SignColumn group |hl-SignColumn|.
Example to set the color: >

:highlight SignColumn guibg=darkgrey

==============================================================================
2. Commands					*sign-commands* *:sig* *:sign*

Here is an example that places a sign "piet", displayed with the text ">>", in
line 23 of the current file: >
	:sign define piet text=>> texthl=Search
	:exe ":sign place 2 line=23 name=piet file=" . expand("%:p")

And here is the command to delete it again: >
	:sign unplace 2

Note that the ":sign" command cannot be followed by another command or a
comment.  If you do need that, use the |:execute| command.

DEFINING A SIGN.			*:sign-define* *E255* *E160* *E612*

:sign define {name} {argument}...
		Define a new sign or set attributes for an existing sign.
		The {name} can either be a number (all digits) or a name
		starting with a non-digit.  Leading digits are ignored, thus
		"0012", "012" and "12" are considered the same name.
		About 120 different signs can be defined.

Accepted arguments:

icon={bitmap}
		Define the file name where the bitmap can be found.  Should be
		a full path.  The bitmap should fit in the place of two
		characters.  This is not checked.  If the bitmap is too big it
		will cause redraw problems.  Only GTK 2 can scale the bitmap
		to fit the space available.
			toolkit		supports ~
			GTK 1		pixmap (.xpm)
			GTK 2		many
			Motif		pixmap (.xpm)
			Win32		.bmp, .ico, .cur
					pixmap (.xpm) |+xpm_w32|

linehl={group}
		Highlighting group used for the whole line the sign is placed
		in.  Most useful is defining a background color.

text={text}						*E239*
		Define the text that is displayed when there is no icon or the
		GUI is not being used.  Only printable characters are allowed
		and they must occupy one or two display cells.

texthl={group}
		Highlighting group used for the text item.

DELETING A SIGN						*:sign-undefine* *E155*

:sign undefine {name}
		Deletes a previously defined sign.  If signs with this {name}
		are still placed this will cause trouble.

LISTING SIGNS						*:sign-list* *E156*

:sign list	Lists all defined signs and their attributes.

:sign list {name}
		Lists one defined sign and its attributes.

PLACING SIGNS						*:sign-place* *E158*

:sign place {id} line={lnum} name={name} file={fname}
		Place sign defined as {name} at line {lnum} in file {fname}.
							*:sign-fname*
		The file {fname} must already be loaded in a buffer.  The
		exact file name must be used, wildcards, $ENV and ~ are not
		expanded, white space must not be escaped.  Trailing white
		space is ignored.

The sign is remembered under {id}, this can be used for
		further manipulation.  {id} must be a number.
		It's up to the user to make sure the {id} is used only once in
		each file (if it's used several times unplacing will also have
		to be done several times and making changes may not work as
		expected).

:sign place {id} line={lnum} name={name} buffer={nr}
		Same, but use buffer {nr}.

*E885*
:sign place {id} name={name} file={fname}
		Change the placed sign {id} in file {fname} to use the defined
		sign {name}.  See remark above about {fname} |:sign-fname|.
		This can be used to change the displayed sign without moving
		it (e.g., when the debugger has stopped at a breakpoint).

:sign place {id} name={name} buffer={nr}
		Same, but use buffer {nr}.

REMOVING SIGNS						*:sign-unplace* *E159*

:sign unplace {id} file={fname}
		Remove the previously placed sign {id} from file {fname}.
		See remark above about {fname} |:sign-fname|.

:sign unplace * file={fname}
		Remove all placed signs in file {fname}.

:sign unplace {id} buffer={nr}
		Remove the previously placed sign {id} from buffer {nr}.

:sign unplace * buffer={nr}
		Remove all placed signs in buffer {nr}.

:sign unplace {id}
		Remove the previously placed sign {id} from all files it
		appears in.

:sign unplace *
		Remove all placed signs.

:sign unplace
		Remove the placed sign at the cursor position.

LISTING PLACED SIGNS					*:sign-place-list*

:sign place file={fname}
		List signs placed in file {fname}.
		See remark above about {fname} |:sign-fname|.

:sign place buffer={nr}
		List signs placed in buffer {nr}.

:sign place	List placed signs in all files.

JUMPING TO A SIGN					*:sign-jump* *E157*

:sign jump {id} file={fname}
		Open the file {fname} or jump to the window that contains
		{fname} and position the cursor at sign {id}.
		See remark above about {fname} |:sign-fname|.
		If the file isn't displayed in window and the current file can
		not be |abandon|ed this fails.

:sign jump {id} buffer={nr}					*E934*
		Same, but use buffer {nr}.  This fails if buffer {nr} does not
		have a name.

vim:tw=78:ts=8:ft=help:norl:

cmd: