runtime/doc/sign.txt

   1 *sign.txt*      For Vim version 7.3.  Last change: 2010 Oct 14
   2
   3
   4                   VIM REFERENCE MANUAL    by Gordon Prieur
   5                                           and Bram Moolenaar
   6
   7
   8 Sign Support Features                           *sign-support*
   9
  10 1. Introduction                         |sign-intro|
  11 2. Commands                             |sign-commands|
  12
  13 {Vi does not have any of these features}
  14 {only available when compiled with the |+signs| feature}
  15
  16 ==============================================================================
  17 1. Introduction                                 *sign-intro* *signs*
  18
  19 When a debugger or other IDE tool is driving an editor it needs to be able
  20 to give specific highlights which quickly tell the user useful information
  21 about the file.  One example of this would be a debugger which had an icon
  22 in the left-hand column denoting a breakpoint.  Another example might be an
  23 arrow representing the Program Counter (PC).  The sign features allow both
  24 placement of a sign, or icon, in the left-hand side of the window and
  25 definition of a highlight which will be applied to that line.  Displaying the
  26 sign as an image is most likely only feasible in gvim (although Sun
  27 Microsystem's dtterm does support this it's the only terminal emulator I know
  28 of which does).  A text sign and the highlight should be feasible in any color
  29 terminal emulator.
  30
  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
  33 hits.  Additionally, the debugger supports 8 to 10 different signs and
  34 highlight colors. |workshop|  Same for Netbeans |netbeans|.
  35
  36 There are two steps in using signs:
  37
  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
  40    text "!!".
  41
  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
  44    and files.
  45
  46 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 disappears again.  The color of the column is set with the SignColumn group
  49 |hl-SignColumn|.  Example to set the color: >
  50
  51         :highlight SignColumn guibg=darkgrey
  52
  53 ==============================================================================
  54 2. Commands                                     *sign-commands* *:sig* *:sign*
  55
  56 Here is an example that places a sign "piet", displayed with the text ">>", in
  57 line 23 of the current file: >
  58         :sign define piet text=>> texthl=Search
  59         :exe ":sign place 2 line=23 name=piet file=" . expand("%:p")
  60
  61 And here is the command to delete it again: >
  62         :sign unplace 2
  63
  64 Note that the ":sign" command cannot be followed by another command or a
  65 comment.  If you do need that, use the |:execute| command.
  66
  67
  68 DEFINING A SIGN.                        *:sign-define* *E255* *E160* *E612*
  69
  70 :sign define {name} {argument}...
  71                 Define a new sign or set attributes for an existing sign.
  72                 The {name} can either be a number (all digits) or a name
  73                 starting with a non-digit.  Leading digits are ignored, thus
  74                 "0012", "012" and "12" are considered the same name.
  75                 About 120 different signs can be defined.
  76
  77                 Accepted arguments:
  78
  79         icon={pixmap}
  80                 Define the file name where the bitmap can be found.  Should be
  81                 a full path.  The bitmap should fit in the place of two
  82                 characters.  This is not checked.  If the bitmap is too big it
  83                 will cause redraw problems.  Only GTK 2 can scale the bitmap
  84                 to fit the space available.
  85                         toolkit         supports ~
  86                         GTK 1           pixmap (.xpm)
  87                         GTK 2           many
  88                         Motif           pixmap (.xpm)
  89
  90         linehl={group}
  91                 Highlighting group used for the whole line the sign is placed
  92                 in.  Most useful is defining a background color.
  93
  94         text={text}                                             *E239*
  95                 Define the text that is displayed when there is no icon or the
  96                 GUI is not being used.  Only printable characters are allowed
  97                 and they must occupy one or two display cells.
  98
  99         texthl={group}
 100                 Highlighting group used for the text item.
 101
 102
 103 DELETING A SIGN                                         *:sign-undefine* *E155*
 104
 105 :sign undefine {name}
 106                 Deletes a previously defined sign.  If signs with this {name}
 107                 are still placed this will cause trouble.
 108
 109
 110 LISTING SIGNS                                           *:sign-list* *E156*
 111
 112 :sign list      Lists all defined signs and their attributes.
 113
 114 :sign list {name}
 115                 Lists one defined sign and its attributes.
 116
 117
 118 PLACING SIGNS                                           *:sign-place* *E158*
 119
 120 :sign place {id} line={lnum} name={name} file={fname}
 121                 Place sign defined as {name} at line {lnum} in file {fname}.
 122                                                         *:sign-fname*
 123                 The file {fname} must already be loaded in a buffer.  The
 124                 exact file name must be used, wildcards, $ENV and ~ are not
 125                 expanded, white space must not be escaped.  Trailing white
 126                 space is ignored.
 127
 128                 The sign is remembered under {id}, this can be used for
 129                 further manipulation.  {id} must be a number.
 130                 It's up to the user to make sure the {id} is used only once in
 131                 each file (if it's used several times unplacing will also have
 132                 to be done several times and making changes may not work as
 133                 expected).
 134
 135 :sign place {id} line={lnum} name={name} buffer={nr}
 136                 Same, but use buffer {nr}.
 137
 138 :sign place {id} name={name} file={fname}
 139                 Change the placed sign {id} in file {fname} to use the defined
 140                 sign {name}.  See remark above about {fname} |:sign-fname|.
 141                 This can be used to change the displayed sign without moving
 142                 it (e.g., when the debugger has stopped at a breakpoint).
 143
 144 :sign place {id} name={name} buffer={nr}
 145                 Same, but use buffer {nr}.
 146
 147
 148 REMOVING SIGNS                                          *:sign-unplace* *E159*
 149
 150 :sign unplace {id} file={fname}
 151                 Remove the previously placed sign {id} from file {fname}.
 152                 See remark above about {fname} |:sign-fname|.
 153
 154 :sign unplace {id} buffer={nr}
 155                 Same, but use buffer {nr}.
 156
 157 :sign unplace {id}
 158                 Remove the previously placed sign {id} from all files it
 159                 appears in.
 160
 161 :sign unplace *
 162                 Remove all placed signs.
 163
 164 :sign unplace
 165                 Remove the placed sign at the cursor position.
 166
 167
 168 LISTING PLACED SIGNS
 169
 170 :sign place file={fname}
 171                 List signs placed in file {fname}.
 172                 See remark above about {fname} |:sign-fname|.
 173
 174 :sign place buffer={nr}
 175                 List signs placed in buffer {nr}.
 176
 177 :sign place     List placed signs in all files.
 178
 179
 180 JUMPING TO A SIGN                                       *:sign-jump* *E157*
 181
 182 :sign jump {id} file={fname}
 183                 Open the file {fname} or jump to the window that contains
 184                 {fname} and position the cursor at sign {id}.
 185                 See remark above about {fname} |:sign-fname|.
 186                 If the file isn't displayed in window and the current file can
 187                 not be |abandon|ed this fails.
 188
 189 :sign jump {id} buffer={nr}
 190                 Same, but use buffer {nr}.
 191
 192  vim:tw=78:ts=8:ft=help:norl: