Mercurial > vim

comparison runtime/doc/sign.txt @ 15512:f0f06837a699

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update runtime files. commit https://github.com/vim/vim/commit/d09091d4955c5f41de69928f2db85611ed54ed23 Author: Bram Moolenaar <Bram@vim.org> Date: Thu Jan 17 16:07:22 2019 +0100 Update runtime files.
author Bram Moolenaar <Bram@vim.org>
date Thu, 17 Jan 2019 16:15:08 +0100
parents 51b3c36b0523
children 0e473e9e70c2
comparison
equal deleted inserted replaced
15511:f41122780189 15512:f0f06837a699
1 *sign.txt* For Vim version 8.1. Last change: 2019 Jan 06 1 *sign.txt* For Vim version 8.1. Last change: 2019 Jan 17
2 2
3 3
4 VIM REFERENCE MANUAL by Gordon Prieur 4 VIM REFERENCE MANUAL by Gordon Prieur
5 and Bram Moolenaar 5 and Bram Moolenaar
6 6
29 terminal emulator. 29 terminal emulator.
30 30
31 Signs and highlights are not useful just for debuggers. Sun's Visual 31 Signs and highlights are not useful just for debuggers. Sun's Visual
32 WorkShop uses signs and highlights to mark build errors and SourceBrowser 32 WorkShop uses signs and highlights to mark build errors and SourceBrowser
33 hits. Additionally, the debugger supports 8 to 10 different signs and 33 hits. Additionally, the debugger supports 8 to 10 different signs and
34 highlight colors. |workshop| Same for Netbeans |netbeans|. 34 highlight colors, see |NetBeans|.
35 35
36 There are two steps in using signs: 36 There are two steps in using signs:
37 37
38 1. Define the sign. This specifies the image, text and highlighting. For 38 1. Define the sign. This specifies the image, text and highlighting. For
39 example, you can define a "break" sign with an image of a stop roadsign and 39 example, you can define a "break" sign with an image of a stop roadsign and
41 41
42 2. Place the sign. This specifies the file and line number where the sign is 42 2. Place the sign. This specifies the file and line number where the sign is
43 displayed. A defined sign can be placed several times in different lines 43 displayed. A defined sign can be placed several times in different lines
44 and files. 44 and files.
45 45
46 *sign-column*
46 When signs are defined for a file, Vim will automatically add a column of two 47 When signs are defined for a file, Vim will automatically add a column of two
47 characters to display them in. When the last sign is unplaced the column 48 characters to display them in. When the last sign is unplaced the column
48 disappears again. This behavior can be changed with the 'signcolumn' option. 49 disappears again. This behavior can be changed with the 'signcolumn' option.
49 50
50 The color of the column is set with the SignColumn group |hl-SignColumn|. 51 The color of the column is set with the SignColumn group |hl-SignColumn|.
53 :highlight SignColumn guibg=darkgrey 54 :highlight SignColumn guibg=darkgrey
54 < 55 <
55 *sign-identifier* 56 *sign-identifier*
56 Each placed sign is identified by a number called the sign identifier. This 57 Each placed sign is identified by a number called the sign identifier. This
57 identifier is used to jump to the sign or to remove the sign. The identifier 58 identifier is used to jump to the sign or to remove the sign. The identifier
58 is assigned when placing the sign using the |sign-place| command or the 59 is assigned when placing the sign using the |:sign-place| command or the
59 |sign_place()| function. Each sign identifier should be a unique number. If 60 |sign_place()| function. Each sign identifier should be a unique number. If
60 multiple placed signs use the same identifier, then jumping to or removing a 61 multiple placed signs use the same identifier, then jumping to or removing a
61 sign becomes unpredictable. To avoid overlapping identifiers, sign groups can 62 sign becomes unpredictable. To avoid overlapping identifiers, sign groups can
62 be used. The |sign_place()| function can be called with a zero sign identifier 63 be used. The |sign_place()| function can be called with a zero sign identifier
63 to allocate the next available identifier. 64 to allocate the next available identifier.
73 *sign-priority* 74 *sign-priority*
74 Each placed sign is assigned a priority value. When multiple signs are placed 75 Each placed sign is assigned a priority value. When multiple signs are placed
75 on the same line, the attributes of the sign with the highest priority is used 76 on the same line, the attributes of the sign with the highest priority is used
76 independent of the sign group. The default priority for a sign is 10. The 77 independent of the sign group. The default priority for a sign is 10. The
77 priority is assigned at the time of placing a sign. 78 priority is assigned at the time of placing a sign.
79
80 When the line on which the sign is placed is deleted, the sign is moved to the
81 next line (or the last line of the buffer, if there is no next line). When
82 the delete is undone the sign does not move back.
78 83
79 ============================================================================== 84 ==============================================================================
80 2. Commands *sign-commands* *:sig* *:sign* 85 2. Commands *sign-commands* *:sig* *:sign*
81 86
82 Here is an example that places a sign "piet", displayed with the text ">>", in 87 Here is an example that places a sign "piet", displayed with the text ">>", in