Mercurial > vim
annotate runtime/doc/repeat.txt @ 26686:c04b28fad0cc v8.2.3872
patch 8.2.3872: Vim9: finddir() and uniq() return types can be more specific
Commit: https://github.com/vim/vim/commit/080182216e605df3428cc699b9fd7e761368d12f
Author: Bram Moolenaar <Bram@vim.org>
Date: Wed Dec 22 18:45:37 2021 +0000
patch 8.2.3872: Vim9: finddir() and uniq() return types can be more specific
Problem: Vim9: finddir() and uniq() return types can be more specific.
Solution: Adjust the return type.
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Wed, 22 Dec 2021 20:00:04 +0100 |
| parents | bb2175e5ccee |
| children | edb7d53fc7e3 |
| rev | line source |
|---|---|
| 26304 | 1 *repeat.txt* For Vim version 8.2. Last change: 2021 Nov 24 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 Repeating commands, Vim scripts and debugging *repeating* | |
| 8 | |
| 9 Chapter 26 of the user manual introduces repeating |usr_26.txt|. | |
| 10 | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
11 1. Single repeats |single-repeat| |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
12 2. Multiple repeats |multi-repeat| |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
13 3. Complex repeats |complex-repeat| |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
14 4. Using Vim scripts |using-scripts| |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
15 5. Using Vim packages |packages| |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
16 6. Creating Vim packages |package-create| |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
17 7. Debugging scripts |debug-scripts| |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
18 8. Profiling |profiling| |
| 7 | 19 |
| 20 ============================================================================== | |
| 21 1. Single repeats *single-repeat* | |
| 22 | |
| 23 *.* | |
| 24 . Repeat last change, with count replaced with [count]. | |
| 25 Also repeat a yank command, when the 'y' flag is | |
| 22 | 26 included in 'cpoptions'. Does not repeat a |
| 27 command-line command. | |
| 7 | 28 |
| 29 Simple changes can be repeated with the "." command. Without a count, the | |
| 30 count of the last change is used. If you enter a count, it will replace the | |
|
5663
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
31 last one. |v:count| and |v:count1| will be set. |
|
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
32 |
|
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
33 If the last change included a specification of a numbered register, the |
|
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
34 register number will be incremented. See |redo-register| for an example how |
|
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
35 to use this. |
|
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
36 |
|
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
37 Note that when repeating a command that used a Visual selection, the same SIZE |
|
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
38 of area is used, see |visual-repeat|. |
| 7 | 39 |
| 40 *@:* | |
| 41 @: Repeat last command-line [count] times. | |
| 42 {not available when compiled without the | |
| 43 |+cmdline_hist| feature} | |
| 44 | |
| 45 | |
| 46 ============================================================================== | |
| 47 2. Multiple repeats *multi-repeat* | |
| 48 | |
|
11494
8e5ec22db3d8
patch 8.0.0630: it is not easy to work on lines without a match
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
49 *:g* *:global* *E148* |
| 7 | 50 :[range]g[lobal]/{pattern}/[cmd] |
| 51 Execute the Ex command [cmd] (default ":p") on the | |
| 52 lines within [range] where {pattern} matches. | |
| 53 | |
| 54 :[range]g[lobal]!/{pattern}/[cmd] | |
| 55 Execute the Ex command [cmd] (default ":p") on the | |
| 56 lines within [range] where {pattern} does NOT match. | |
| 57 | |
| 58 *:v* *:vglobal* | |
| 59 :[range]v[global]/{pattern}/[cmd] | |
| 60 Same as :g!. | |
| 61 | |
| 24636 | 62 Example: > |
| 63 :g/^Obsolete/d _ | |
| 64 Using the underscore after `:d` avoids clobbering registers or the clipboard. | |
| 65 This also makes it faster. | |
| 66 | |
| 1125 | 67 Instead of the '/' which surrounds the {pattern}, you can use any other |
| 5239 | 68 single byte character, but not an alphabetic character, '\', '"' or '|'. |
| 1125 | 69 This is useful if you want to include a '/' in the search pattern or |
| 70 replacement string. | |
| 71 | |
| 72 For the definition of a pattern, see |pattern|. | |
| 73 | |
| 6336 | 74 NOTE [cmd] may contain a range; see |collapse| and |edit-paragraph-join| for |
| 75 examples. | |
| 76 | |
| 7 | 77 The global commands work by first scanning through the [range] lines and |
| 78 marking each line where a match occurs (for a multi-line pattern, only the | |
| 79 start of the match matters). | |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
80 In a second scan the [cmd] is executed for each marked line, as if the cursor |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
81 was in that line. For ":v" and ":g!" the command is executed for each not |
| 7 | 82 marked line. If a line is deleted its mark disappears. |
| 83 The default for [range] is the whole buffer (1,$). Use "CTRL-C" to interrupt | |
| 84 the command. If an error message is given for a line, the command for that | |
| 85 line is aborted and the global command continues with the next marked or | |
| 86 unmarked line. | |
| 18831 | 87 *E147* |
|
11494
8e5ec22db3d8
patch 8.0.0630: it is not easy to work on lines without a match
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
88 When the command is used recursively, it only works on one line. Giving a |
|
8e5ec22db3d8
patch 8.0.0630: it is not easy to work on lines without a match
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
89 range is then not allowed. This is useful to find all lines that match a |
|
8e5ec22db3d8
patch 8.0.0630: it is not easy to work on lines without a match
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
90 pattern and do not match another pattern: > |
|
8e5ec22db3d8
patch 8.0.0630: it is not easy to work on lines without a match
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
91 :g/found/v/notfound/{cmd} |
|
8e5ec22db3d8
patch 8.0.0630: it is not easy to work on lines without a match
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
92 This first finds all lines containing "found", but only executes {cmd} when |
|
8e5ec22db3d8
patch 8.0.0630: it is not easy to work on lines without a match
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
93 there is no match for "notfound". |
| 7 | 94 |
|
11494
8e5ec22db3d8
patch 8.0.0630: it is not easy to work on lines without a match
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
95 To execute a non-Ex command, you can use the `:normal` command: > |
| 7 | 96 :g/pat/normal {commands} |
| 97 Make sure that {commands} ends with a whole command, otherwise Vim will wait | |
| 98 for you to type the rest of the command for each match. The screen will not | |
| 99 have been updated, so you don't know what you are doing. See |:normal|. | |
| 100 | |
| 101 The undo/redo command will undo/redo the whole global command at once. | |
| 102 The previous context mark will only be set once (with "''" you go back to | |
| 103 where the cursor was before the global command). | |
| 104 | |
| 105 The global command sets both the last used search pattern and the last used | |
| 106 substitute pattern (this is vi compatible). This makes it easy to globally | |
| 107 replace a string: | |
| 108 :g/pat/s//PAT/g | |
| 109 This replaces all occurrences of "pat" with "PAT". The same can be done with: | |
| 110 :%s/pat/PAT/g | |
| 111 Which is two characters shorter! | |
| 112 | |
| 1623 | 113 When using "global" in Ex mode, a special case is using ":visual" as a |
| 114 command. This will move to a matching line, go to Normal mode to let you | |
| 115 execute commands there until you use |Q| to return to Ex mode. This will be | |
| 116 repeated for each matching line. While doing this you cannot use ":global". | |
| 117 To abort this type CTRL-C twice. | |
| 168 | 118 |
| 7 | 119 ============================================================================== |
| 120 3. Complex repeats *complex-repeat* | |
| 121 | |
| 122 *q* *recording* | |
| 123 q{0-9a-zA-Z"} Record typed characters into register {0-9a-zA-Z"} | |
| 124 (uppercase to append). The 'q' command is disabled | |
| 125 while executing a register, and it doesn't work inside | |
|
7233
9487ea110214
commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845
Christian Brabandt <cb@256bit.org>
parents:
6757
diff
changeset
|
126 a mapping and |:normal|. |
|
9487ea110214
commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845
Christian Brabandt <cb@256bit.org>
parents:
6757
diff
changeset
|
127 |
|
9487ea110214
commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845
Christian Brabandt <cb@256bit.org>
parents:
6757
diff
changeset
|
128 Note: If the register being used for recording is also |
|
9487ea110214
commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845
Christian Brabandt <cb@256bit.org>
parents:
6757
diff
changeset
|
129 used for |y| and |p| the result is most likely not |
|
9487ea110214
commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845
Christian Brabandt <cb@256bit.org>
parents:
6757
diff
changeset
|
130 what is expected, because the put will paste the |
|
9487ea110214
commit https://github.com/vim/vim/commit/a0ed84a26897c994512873a895b9fc54e90c6845
Christian Brabandt <cb@256bit.org>
parents:
6757
diff
changeset
|
131 recorded macro and the yank will overwrite the |
| 16610 | 132 recorded macro. |
| 7 | 133 |
| 20552 | 134 Note: The recording happens while you type, replaying |
| 135 the register happens as if the keys come from a | |
| 136 mapping. This matters, for example, for undo, which | |
| 137 only syncs when commands were typed. | |
| 138 | |
| 7 | 139 q Stops recording. (Implementation note: The 'q' that |
| 140 stops recording is not stored in the register, unless | |
| 16610 | 141 it was the result of a mapping) |
| 7 | 142 |
| 143 *@* | |
| 3445 | 144 @{0-9a-z".=*+} Execute the contents of register {0-9a-z".=*+} [count] |
| 7 | 145 times. Note that register '%' (name of the current |
| 146 file) and '#' (name of the alternate file) cannot be | |
| 2681 | 147 used. |
| 148 The register is executed like a mapping, that means | |
| 149 that the difference between 'wildchar' and 'wildcharm' | |
| 20552 | 150 applies, and undo might not be synced in the same way. |
| 2681 | 151 For "@=" you are prompted to enter an expression. The |
| 152 result of the expression is then executed. | |
| 16610 | 153 See also |@:|. |
| 7 | 154 |
| 168 | 155 *@@* *E748* |
| 7 | 156 @@ Repeat the previous @{0-9a-z":*} [count] times. |
| 157 | |
| 24636 | 158 *:@* |
| 3445 | 159 :[addr]@{0-9a-z".=*+} Execute the contents of register {0-9a-z".=*+} as an Ex |
| 7 | 160 command. First set cursor at line [addr] (default is |
| 161 current line). When the last line in the register does | |
| 162 not have a <CR> it will be added automatically when | |
| 163 the 'e' flag is present in 'cpoptions'. | |
| 164 For ":@=" the last used expression is used. The | |
| 165 result of evaluating the expression is executed as an | |
| 166 Ex command. | |
| 167 Mappings are not recognized in these commands. | |
|
20891
4bdc07beeadb
patch 8.2.0997: cannot execute a register containing line continuation
Bram Moolenaar <Bram@vim.org>
parents:
20552
diff
changeset
|
168 When the |line-continuation| character (\) is present |
|
4bdc07beeadb
patch 8.2.0997: cannot execute a register containing line continuation
Bram Moolenaar <Bram@vim.org>
parents:
20552
diff
changeset
|
169 at the beginning of a line in a linewise register, |
|
4bdc07beeadb
patch 8.2.0997: cannot execute a register containing line continuation
Bram Moolenaar <Bram@vim.org>
parents:
20552
diff
changeset
|
170 then it is combined with the previous line. This is |
|
4bdc07beeadb
patch 8.2.0997: cannot execute a register containing line continuation
Bram Moolenaar <Bram@vim.org>
parents:
20552
diff
changeset
|
171 useful for yanking and executing parts of a Vim |
|
4bdc07beeadb
patch 8.2.0997: cannot execute a register containing line continuation
Bram Moolenaar <Bram@vim.org>
parents:
20552
diff
changeset
|
172 script. |
| 16610 | 173 Future: Will execute the register for each line in the |
| 174 address range. | |
| 7 | 175 |
| 24636 | 176 :[addr]*{0-9a-z".=+} *:star-compatible* |
| 177 When '*' is present in 'cpoptions' |cpo-star|, use | |
| 178 ":*" in the same way as ":@". This is NOT the default | |
| 179 when 'nocompatible' is used. When the '*' flag is not | |
| 180 present in 'cpoptions', ":*" is an alias for ":'<,'>", | |
| 181 select the Visual area |:star|. | |
| 182 | |
| 7 | 183 *:@:* |
| 184 :[addr]@: Repeat last command-line. First set cursor at line | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
185 [addr] (default is current line). |
| 7 | 186 |
|
10186
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
187 :[addr]@ *:@@* |
| 20241 | 188 :[addr]@@ Repeat the previous :@{register}. First set cursor at |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
189 line [addr] (default is current line). |
| 7 | 190 |
| 191 ============================================================================== | |
| 192 4. Using Vim scripts *using-scripts* | |
| 193 | |
| 194 For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|. | |
| 195 | |
| 196 *:so* *:source* *load-vim-script* | |
| 197 :so[urce] {file} Read Ex commands from {file}. These are commands that | |
| 198 start with a ":". | |
| 716 | 199 Triggers the |SourcePre| autocommand. |
| 16808 | 200 *:source!* |
| 7 | 201 :so[urce]! {file} Read Vim commands from {file}. These are commands |
| 202 that are executed from Normal mode, like you type | |
| 203 them. | |
| 204 When used after |:global|, |:argdo|, |:windo|, | |
| 205 |:bufdo|, in a loop or when another command follows | |
| 206 the display won't be updated while executing the | |
| 207 commands. | |
| 16808 | 208 Cannot be used in the |sandbox|. |
| 7 | 209 |
| 210 *:ru* *:runtime* | |
|
8526
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
211 :ru[ntime][!] [where] {file} .. |
| 7 | 212 Read Ex commands from {file} in each directory given |
|
8526
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
213 by 'runtimepath' and/or 'packpath'. There is no error |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
214 for non-existing files. |
| 18831 | 215 |
|
8526
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
216 Example: > |
| 7 | 217 :runtime syntax/c.vim |
| 218 | |
| 219 < There can be multiple {file} arguments, separated by | |
| 220 spaces. Each {file} is searched for in the first | |
| 221 directory from 'runtimepath', then in the second | |
| 222 directory, etc. Use a backslash to include a space | |
| 223 inside {file} (although it's better not to use spaces | |
| 224 in file names, it causes trouble). | |
| 225 | |
| 226 When [!] is included, all found files are sourced. | |
| 227 When it is not included only the first found file is | |
| 228 sourced. | |
| 229 | |
|
8526
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
230 When [where] is omitted only 'runtimepath' is used. |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
231 Other values: |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
232 START search under "start" in 'packpath' |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
233 OPT search under "opt" in 'packpath' |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
234 PACK search under "start" and "opt" in |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
235 'packpath' |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
236 ALL first use 'runtimepath', then search |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
237 under "start" and "opt" in 'packpath' |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
238 |
| 7 | 239 When {file} contains wildcards it is expanded to all |
| 240 matching files. Example: > | |
| 18130 | 241 :runtime! plugin/**/*.vim |
| 7 | 242 < This is what Vim uses to load the plugin files when |
| 237 | 243 starting up. This similar command: > |
| 18130 | 244 :runtime plugin/**/*.vim |
| 7 | 245 < would source the first file only. |
| 246 | |
| 247 When 'verbose' is one or higher, there is a message | |
| 248 when no file could be found. | |
| 249 When 'verbose' is two or higher, there is a message | |
| 250 about each searched file. | |
| 251 | |
|
8416
1a6527cce675
commit https://github.com/vim/vim/commit/be82c254862e475a582c0717455e1db6bf96b0d0
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
252 *:pa* *:packadd* *E919* |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
253 :pa[ckadd][!] {name} Search for an optional plugin directory in 'packpath' |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
254 and source any plugin files found. The directory must |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
255 match: |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
256 pack/*/opt/{name} ~ |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
257 The directory is added to 'runtimepath' if it wasn't |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
258 there yet. |
|
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
259 If the directory pack/*/opt/{name}/after exists it is |
|
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
260 added at the end of 'runtimepath'. |
|
8303
88207f4b861a
commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
261 |
| 13051 | 262 If loading packages from "pack/*/start" was skipped, |
| 263 then this directory is searched first: | |
| 264 pack/*/start/{name} ~ | |
| 265 | |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
266 Note that {name} is the directory name, not the name |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
267 of the .vim file. All the files matching the pattern |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
268 pack/*/opt/{name}/plugin/**/*.vim ~ |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
269 will be sourced. This allows for using subdirectories |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
270 below "plugin", just like with plugins in |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
271 'runtimepath'. |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
272 |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
273 If the filetype detection was not enabled yet (this |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
274 is usually done with a "syntax enable" or "filetype |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
275 on" command in your .vimrc file), this will also look |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
276 for "{name}/ftdetect/*.vim" files. |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
277 |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
278 When the optional ! is added no plugin files or |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
279 ftdetect scripts are loaded, only the matching |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
280 directories are added to 'runtimepath'. This is |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
281 useful in your .vimrc. The plugins will then be |
| 24911 | 282 loaded during initialization, see |load-plugins| (note |
| 283 that the loading order will be reversed, because each | |
| 284 directory is inserted before others). | |
| 22565 | 285 Note that for ftdetect scripts to be loaded |
| 286 you will need to write `filetype plugin indent on` | |
| 287 AFTER all `packadd!` commands. | |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
288 |
|
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
289 Also see |pack-add|. |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
290 {only available when compiled with |+eval|} |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8388
diff
changeset
|
291 |
|
8673
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
8526
diff
changeset
|
292 *:packl* *:packloadall* |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
293 :packl[oadall][!] Load all packages in the "start" directory under each |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
294 entry in 'packpath'. |
| 18831 | 295 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
296 First all the directories found are added to |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
297 'runtimepath', then the plugins found in the |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
298 directories are sourced. This allows for a plugin to |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
299 depend on something of another plugin, e.g. an |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
300 "autoload" directory. See |packload-two-steps| for |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
301 how this can be useful. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
302 |
|
8673
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
8526
diff
changeset
|
303 This is normally done automatically during startup, |
|
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
8526
diff
changeset
|
304 after loading your .vimrc file. With this command it |
|
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
8526
diff
changeset
|
305 can be done earlier. |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
306 |
| 17161 | 307 Packages will be loaded only once. Using |
| 308 `:packloadall` a second time will have no effect. | |
| 309 When the optional ! is added this command will load | |
| 310 packages even when done before. | |
| 311 | |
| 312 Note that when using `:packloadall` in the |vimrc| | |
| 313 file, the 'runtimepath' option is updated, and later | |
| 314 all plugins in 'runtimepath' will be loaded, which | |
| 315 means they are loaded again. Plugins are expected to | |
| 316 handle that. | |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
317 |
|
8795
aba2d0a01290
commit https://github.com/vim/vim/commit/7db8f6f4f85e5d0526d23107b2a5e2334dc23354
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
318 An error only causes sourcing the script where it |
|
8673
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
8526
diff
changeset
|
319 happens to be aborted, further plugins will be loaded. |
|
8526
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
320 See |packages|. |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
321 {only available when compiled with |+eval|} |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
322 |
| 7 | 323 :scripte[ncoding] [encoding] *:scripte* *:scriptencoding* *E167* |
| 324 Specify the character encoding used in the script. | |
| 325 The following lines will be converted from [encoding] | |
| 326 to the value of the 'encoding' option, if they are | |
| 327 different. Examples: > | |
| 328 scriptencoding iso-8859-5 | |
| 329 scriptencoding cp932 | |
| 330 < | |
| 331 When [encoding] is empty, no conversion is done. This | |
| 332 can be used to restrict conversion to a sequence of | |
| 333 lines: > | |
| 334 scriptencoding euc-jp | |
| 335 ... lines to be converted ... | |
| 336 scriptencoding | |
| 337 ... not converted ... | |
| 338 | |
| 339 < When conversion isn't supported by the system, there | |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
340 is no error message and no conversion is done. When a |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
341 line can't be converted there is no error and the |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
342 original line is kept. |
| 7 | 343 |
| 344 Don't use "ucs-2" or "ucs-4", scripts cannot be in | |
| 345 these encodings (they would contain NUL bytes). | |
| 346 When a sourced script starts with a BOM (Byte Order | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
347 Mark) in utf-8 format Vim will recognize it, no need |
| 7 | 348 to use ":scriptencoding utf-8" then. |
| 349 | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
350 If you set the 'encoding' option in your |.vimrc|, |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
351 `:scriptencoding` must be placed after that. E.g.: > |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
352 set encoding=utf-8 |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
353 scriptencoding utf-8 |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
354 < |
| 7 | 355 |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
356 :scriptv[ersion] {version} *:scriptv* *:scriptversion* |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
357 *E999* *E984* |
| 16267 | 358 Specify the version of Vim for the lines that follow |
| 359 in the same file. Only applies at the toplevel of | |
| 360 sourced scripts, not inside functions. | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
361 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
362 If {version} is higher than what the current Vim |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
363 version supports E999 will be given. You either need |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
364 to rewrite the script to make it work with an older |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
365 Vim version, or update Vim to a newer version. See |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
366 |vimscript-version| for what changed between versions. |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
367 |
|
23938
2a885d095bff
patch 8.2.2511: Vim9: cannot use Vim9 script syntax in some places
Bram Moolenaar <Bram@vim.org>
parents:
23717
diff
changeset
|
368 :vim9s[cript] [noclear] *:vim9s* *:vim9script* |
| 23466 | 369 Marks a script file as containing |Vim9-script| |
| 370 commands. Also see |vim9-namespace|. | |
| 371 Must be the first command in the file. | |
| 372 For [noclear] see |vim9-reload|. | |
| 373 Without the |+eval| feature this changes the syntax | |
| 374 for some commands. | |
|
23938
2a885d095bff
patch 8.2.2511: Vim9: cannot use Vim9 script syntax in some places
Bram Moolenaar <Bram@vim.org>
parents:
23717
diff
changeset
|
375 See |:vim9cmd| for executing one command with Vim9 |
|
2a885d095bff
patch 8.2.2511: Vim9: cannot use Vim9 script syntax in some places
Bram Moolenaar <Bram@vim.org>
parents:
23717
diff
changeset
|
376 syntax and semantics. |
| 24911 | 377 |
| 6476 | 378 *:scr* *:scriptnames* |
| 379 :scr[iptnames] List all sourced script names, in the order they were | |
| 7 | 380 first sourced. The number is used for the script ID |
| 381 |<SID>|. | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
382 {not available when compiled without the |+eval| |
|
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
383 feature} |
| 7 | 384 |
|
15085
1783c0b6bc2e
patch 8.1.0553: it is not easy to edit a script that was sourced
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
385 :scr[iptnames][!] {scriptId} *:script* |
| 15194 | 386 Edit script {scriptId}. Although ":scriptnames name" |
| 387 works, using ":script name" is recommended. | |
| 388 When the current buffer can't be |abandon|ed and the ! | |
| 389 is not present, the command fails. | |
|
15085
1783c0b6bc2e
patch 8.1.0553: it is not easy to edit a script that was sourced
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
390 |
| 7 | 391 *:fini* *:finish* *E168* |
| 392 :fini[sh] Stop sourcing a script. Can only be used in a Vim | |
| 393 script file. This is a quick way to skip the rest of | |
| 394 the file. If it is used after a |:try| but before the | |
| 395 matching |:finally| (if present), the commands | |
| 396 following the ":finally" up to the matching |:endtry| | |
| 397 are executed first. This process applies to all | |
| 398 nested ":try"s in the script. The outermost ":endtry" | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
399 then stops sourcing the script. |
| 7 | 400 |
| 401 All commands and command sequences can be repeated by putting them in a named | |
| 402 register and then executing it. There are two ways to get the commands in the | |
| 403 register: | |
| 404 - Use the record command "q". You type the commands once, and while they are | |
| 405 being executed they are stored in a register. Easy, because you can see | |
| 406 what you are doing. If you make a mistake, "p"ut the register into the | |
| 407 file, edit the command sequence, and then delete it into the register | |
| 408 again. You can continue recording by appending to the register (use an | |
| 409 uppercase letter). | |
| 410 - Delete or yank the command sequence into the register. | |
| 411 | |
| 412 Often used command sequences can be put under a function key with the ':map' | |
| 413 command. | |
| 414 | |
| 415 An alternative is to put the commands in a file, and execute them with the | |
| 416 ':source!' command. Useful for long command sequences. Can be combined with | |
| 417 the ':map' command to put complicated commands under a function key. | |
| 418 | |
| 419 The ':source' command reads Ex commands from a file line by line. You will | |
| 420 have to type any needed keyboard input. The ':source!' command reads from a | |
| 421 script file character by character, interpreting each character as if you | |
| 422 typed it. | |
| 423 | |
| 424 Example: When you give the ":!ls" command you get the |hit-enter| prompt. If | |
| 425 you ':source' a file with the line "!ls" in it, you will have to type the | |
| 426 <Enter> yourself. But if you ':source!' a file with the line ":!ls" in it, | |
| 427 the next characters from that file are read until a <CR> is found. You will | |
| 428 not have to type <CR> yourself, unless ":!ls" was the last line in the file. | |
| 429 | |
| 430 It is possible to put ':source[!]' commands in the script file, so you can | |
| 431 make a top-down hierarchy of script files. The ':source' command can be | |
| 432 nested as deep as the number of files that can be opened at one time (about | |
| 433 15). The ':source!' command can be nested up to 15 levels deep. | |
| 434 | |
| 435 You can use the "<sfile>" string (literally, this is not a special key) inside | |
| 436 of the sourced file, in places where a file name is expected. It will be | |
| 437 replaced by the file name of the sourced file. For example, if you have a | |
| 438 "other.vimrc" file in the same directory as your ".vimrc" file, you can source | |
| 439 it from your ".vimrc" file with this command: > | |
| 440 :source <sfile>:h/other.vimrc | |
| 441 | |
| 442 In script files terminal-dependent key codes are represented by | |
| 443 terminal-independent two character codes. This means that they can be used | |
| 444 in the same way on different kinds of terminals. The first character of a | |
| 445 key code is 0x80 or 128, shown on the screen as "~@". The second one can be | |
| 446 found in the list |key-notation|. Any of these codes can also be entered | |
| 447 with CTRL-V followed by the three digit decimal code. This does NOT work for | |
| 448 the <t_xx> termcap codes, these can only be used in mappings. | |
| 449 | |
| 450 *:source_crnl* *W15* | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
451 Win32: Files that are read with ":source" normally have <CR><NL> <EOL>s. |
|
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
452 These always work. If you are using a file with <NL> <EOL>s (for example, a |
|
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
453 file made on Unix), this will be recognized if 'fileformats' is not empty and |
|
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
454 the first line does not end in a <CR>. This fails if the first line has |
|
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
455 something like ":map <F1> :help^M", where "^M" is a <CR>. If the first line |
|
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
456 ends in a <CR>, but following ones don't, you will get an error message, |
|
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
457 because the <CR> from the first lines will be lost. |
| 7 | 458 |
| 333 | 459 Mac Classic: Files that are read with ":source" normally have <CR> <EOL>s. |
| 7 | 460 These always work. If you are using a file with <NL> <EOL>s (for example, a |
| 461 file made on Unix), this will be recognized if 'fileformats' is not empty and | |
| 462 the first line does not end in a <CR>. Be careful not to use a file with <NL> | |
| 463 linebreaks which has a <CR> in first line. | |
| 464 | |
| 465 On other systems, Vim expects ":source"ed files to end in a <NL>. These | |
| 466 always work. If you are using a file with <CR><NL> <EOL>s (for example, a | |
| 18972 | 467 file made on MS-Windows), all lines will have a trailing <CR>. This may cause |
| 7 | 468 problems for some commands (e.g., mappings). There is no automatic <EOL> |
| 469 detection, because it's common to start with a line that defines a mapping | |
| 470 that ends in a <CR>, which will confuse the automaton. | |
| 471 | |
| 472 *line-continuation* | |
| 473 Long lines in a ":source"d Ex command script file can be split by inserting | |
| 474 a line continuation symbol "\" (backslash) at the start of the next line. | |
| 475 There can be white space before the backslash, which is ignored. | |
| 476 | |
| 477 Example: the lines > | |
| 478 :set comments=sr:/*,mb:*,el:*/, | |
| 479 \://, | |
| 480 \b:#, | |
| 481 \:%, | |
| 482 \n:>, | |
| 483 \fb:- | |
| 484 are interpreted as if they were given in one line: | |
| 485 :set comments=sr:/*,mb:*,el:*/,://,b:#,:%,n:>,fb:- | |
| 486 | |
| 487 All leading whitespace characters in the line before a backslash are ignored. | |
| 488 Note however that trailing whitespace in the line before it cannot be | |
| 489 inserted freely; it depends on the position where a command is split up | |
| 490 whether additional whitespace is allowed or not. | |
| 491 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
492 When a space is required it's best to put it right after the backslash. A |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
493 space at the end of a line is hard to see and may be accidentally deleted. > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
494 :syn match Comment |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
495 \ "very long regexp" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
496 \ keepend |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
497 |
| 7 | 498 There is a problem with the ":append" and ":insert" commands: > |
| 499 :1append | |
| 500 \asdf | |
| 501 . | |
| 502 The backslash is seen as a line-continuation symbol, thus this results in the | |
| 503 command: > | |
| 504 :1appendasdf | |
| 505 . | |
| 506 To avoid this, add the 'C' flag to the 'cpoptions' option: > | |
| 507 :set cpo+=C | |
| 508 :1append | |
| 509 \asdf | |
| 510 . | |
| 511 :set cpo-=C | |
| 512 | |
| 513 Note that when the commands are inside a function, you need to add the 'C' | |
| 514 flag when defining the function, it is not relevant when executing it. > | |
| 515 :set cpo+=C | |
| 516 :function Foo() | |
| 517 :1append | |
| 518 \asdf | |
| 519 . | |
| 520 :endfunction | |
| 521 :set cpo-=C | |
|
14714
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
522 < |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
523 *line-continuation-comment* |
| 14864 | 524 To add a comment in between the lines start with '"\ '. Notice the space |
| 525 after the backslash. Example: > | |
|
14714
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
526 let array = [ |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
527 "\ first entry comment |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
528 \ 'first', |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
529 "\ second entry comment |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
530 \ 'second', |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
531 \ ] |
| 7 | 532 |
| 533 Rationale: | |
| 534 Most programs work with a trailing backslash to indicate line | |
| 535 continuation. Using this in Vim would cause incompatibility with Vi. | |
| 536 For example for this Vi mapping: > | |
| 537 :map xx asdf\ | |
| 538 < Therefore the unusual leading backslash is used. | |
| 539 | |
|
14714
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
540 Starting a comment in a continuation line results in all following |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
541 continuation lines to be part of the comment. Since it was like this |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
542 for a long time, when making it possible to add a comment halfway a |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
543 sequence of continuation lines, it was not possible to use \", since |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
544 that was a valid continuation line. Using '"\ ' comes closest, even |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
545 though it may look a bit weird. Requiring the space after the |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
546 backslash is to make it very unlikely this is a normal comment line. |
|
bdbb049c2aa8
patch 8.1.0369: continuation lines cannot contain comments
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
547 |
| 7 | 548 ============================================================================== |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
549 5. Using Vim packages *packages* |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
550 |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
551 A Vim package is a directory that contains one or more plugins. The |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
552 advantages over normal plugins: |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
553 - A package can be downloaded as an archive and unpacked in its own directory. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
554 Thus the files are not mixed with files of other plugins. That makes it |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
555 easy to update and remove. |
|
8376
e448f2a5d45b
commit https://github.com/vim/vim/commit/91715873d19a1859c08eeded7848113596e2f2bd
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
556 - A package can be a git, mercurial, etc. repository. That makes it really |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
557 easy to update. |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
558 - A package can contain multiple plugins that depend on each other. |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
559 - A package can contain plugins that are automatically loaded on startup and |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
560 ones that are only loaded when needed with `:packadd`. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
561 |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
562 |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
563 Using a package and loading automatically ~ |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
564 |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
565 Let's assume your Vim files are in the "~/.vim" directory and you want to add a |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
566 package from a zip archive "/tmp/foopack.zip": |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
567 % mkdir -p ~/.vim/pack/foo |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
568 % cd ~/.vim/pack/foo |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
569 % unzip /tmp/foopack.zip |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
570 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
571 The directory name "foo" is arbitrary, you can pick anything you like. |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
572 |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
573 You would now have these files under ~/.vim: |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
574 pack/foo/README.txt |
|
8475
aec051e61547
commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
575 pack/foo/start/foobar/plugin/foo.vim |
|
aec051e61547
commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
576 pack/foo/start/foobar/syntax/some.vim |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
577 pack/foo/opt/foodebug/plugin/debugger.vim |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
578 |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
579 When Vim starts up, after processing your .vimrc, it scans all directories in |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
580 'packpath' for plugins under the "pack/*/start" directory. First all those |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
581 directories are added to 'runtimepath'. Then all the plugins are loaded. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
582 See |packload-two-steps| for how these two steps can be useful. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
583 |
| 18831 | 584 In the example Vim will find "pack/foo/start/foobar/plugin/foo.vim" and adds |
|
8475
aec051e61547
commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
585 "~/.vim/pack/foo/start/foobar" to 'runtimepath'. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
586 |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
587 If the "foobar" plugin kicks in and sets the 'filetype' to "some", Vim will |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
588 find the syntax/some.vim file, because its directory is in 'runtimepath'. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
589 |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
590 Vim will also load ftdetect files, if there are any. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
591 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
592 Note that the files under "pack/foo/opt" are not loaded automatically, only the |
|
8475
aec051e61547
commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
593 ones under "pack/foo/start". See |pack-add| below for how the "opt" directory |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
594 is used. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
595 |
|
8526
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
596 Loading packages automatically will not happen if loading plugins is disabled, |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
597 see |load-plugins|. |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
598 |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
599 To load packages earlier, so that 'runtimepath' gets updated: > |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
600 :packloadall |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
601 This also works when loading plugins is disabled. The automatic loading will |
|
981cc3bef9f3
commit https://github.com/vim/vim/commit/8dcf259d904cfb965d31841dc74a5cfaf5a351d9
Christian Brabandt <cb@256bit.org>
parents:
8475
diff
changeset
|
602 only happen once. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
603 |
|
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
604 If the package has an "after" directory, that directory is added to the end of |
|
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
605 'runtimepath', so that anything there will be loaded later. |
|
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
606 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
607 |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
608 Using a single plugin and loading it automatically ~ |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
609 |
|
8388
f5972de59001
commit https://github.com/vim/vim/commit/f3654827368e6204608036353a0360e9e7c21e02
Christian Brabandt <cb@256bit.org>
parents:
8376
diff
changeset
|
610 If you don't have a package but a single plugin, you need to create the extra |
|
f5972de59001
commit https://github.com/vim/vim/commit/f3654827368e6204608036353a0360e9e7c21e02
Christian Brabandt <cb@256bit.org>
parents:
8376
diff
changeset
|
611 directory level: |
|
8475
aec051e61547
commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
612 % mkdir -p ~/.vim/pack/foo/start/foobar |
|
aec051e61547
commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
613 % cd ~/.vim/pack/foo/start/foobar |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
614 % unzip /tmp/someplugin.zip |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
615 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
616 You would now have these files: |
|
8475
aec051e61547
commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
617 pack/foo/start/foobar/plugin/foo.vim |
|
aec051e61547
commit https://github.com/vim/vim/commit/af1a0e371e739f8dff337fd31da0ff8ffb347b43
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
618 pack/foo/start/foobar/syntax/some.vim |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
619 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
620 From here it works like above. |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
621 |
|
8376
e448f2a5d45b
commit https://github.com/vim/vim/commit/91715873d19a1859c08eeded7848113596e2f2bd
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
622 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
623 Optional plugins ~ |
|
8388
f5972de59001
commit https://github.com/vim/vim/commit/f3654827368e6204608036353a0360e9e7c21e02
Christian Brabandt <cb@256bit.org>
parents:
8376
diff
changeset
|
624 *pack-add* |
|
f5972de59001
commit https://github.com/vim/vim/commit/f3654827368e6204608036353a0360e9e7c21e02
Christian Brabandt <cb@256bit.org>
parents:
8376
diff
changeset
|
625 To load an optional plugin from a pack use the `:packadd` command: > |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
626 :packadd foodebug |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
627 This searches for "pack/*/opt/foodebug" in 'packpath' and will find |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
628 ~/.vim/pack/foo/opt/foodebug/plugin/debugger.vim and source it. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8416
diff
changeset
|
629 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
630 This could be done if some conditions are met. For example, depending on |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
631 whether Vim supports a feature or a dependency is missing. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
632 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
633 You can also load an optional plugin at startup, by putting this command in |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
634 your |.vimrc|: > |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
635 :packadd! foodebug |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9116
diff
changeset
|
636 The extra "!" is so that the plugin isn't loaded if Vim was started with |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
637 |--noplugin|. |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
638 |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
639 It is perfectly normal for a package to only have files in the "opt" |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
640 directory. You then need to load each plugin when you want to use it. |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
641 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
642 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
643 Where to put what ~ |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
644 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
645 Since color schemes, loaded with `:colorscheme`, are found below |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
646 "pack/*/start" and "pack/*/opt", you could put them anywhere. We recommend |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
647 you put them below "pack/*/opt", for example |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
648 ".vim/pack/mycolors/opt/dark/colors/very_dark.vim". |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
649 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
650 Filetype plugins should go under "pack/*/start", so that they are always |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
651 found. Unless you have more than one plugin for a file type and want to |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
652 select which one to load with `:packadd`. E.g. depending on the compiler |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
653 version: > |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
654 if foo_compiler_version > 34 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
655 packadd foo_new |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
656 else |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
657 packadd foo_old |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
658 endif |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
659 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
660 The "after" directory is most likely not useful in a package. It's not |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
661 disallowed though. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
662 |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
663 ============================================================================== |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
664 6. Creating Vim packages *package-create* |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
665 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
666 This assumes you write one or more plugins that you distribute as a package. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
667 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
668 If you have two unrelated plugins you would use two packages, so that Vim |
| 21499 | 669 users can choose what they include or not. Or you can decide to use one |
| 21825 | 670 package with optional plugins, and tell the user to add the preferred ones with |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
671 `:packadd`. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
672 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
673 Decide how you want to distribute the package. You can create an archive or |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
674 you could use a repository. An archive can be used by more users, but is a |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
675 bit harder to update to a new version. A repository can usually be kept |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
676 up-to-date easily, but it requires a program like "git" to be available. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
677 You can do both, github can automatically create an archive for a release. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
678 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
679 Your directory layout would be like this: |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
680 start/foobar/plugin/foo.vim " always loaded, defines commands |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
681 start/foobar/plugin/bar.vim " always loaded, defines commands |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
682 start/foobar/autoload/foo.vim " loaded when foo command used |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
683 start/foobar/doc/foo.txt " help for foo.vim |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
684 start/foobar/doc/tags " help tags |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
685 opt/fooextra/plugin/extra.vim " optional plugin, defines commands |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
686 opt/fooextra/autoload/extra.vim " loaded when extra command used |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
687 opt/fooextra/doc/extra.txt " help for extra.vim |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
688 opt/fooextra/doc/tags " help tags |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
689 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
690 This allows for the user to do: > |
| 24103 | 691 mkdir ~/.vim/pack |
| 692 cd ~/.vim/pack | |
| 693 git clone https://github.com/you/foobar.git myfoobar | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
694 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
695 Here "myfoobar" is a name that the user can choose, the only condition is that |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
696 it differs from other packages. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
697 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
698 In your documentation you explain what the plugins do, and tell the user how |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
699 to load the optional plugin: > |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
700 :packadd! fooextra |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
701 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
702 You could add this packadd command in one of your plugins, to be executed when |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
703 the optional plugin is needed. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
704 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
705 Run the `:helptags` command to generate the doc/tags file. Including this |
| 21825 | 706 generated file in the package means that the user can drop the package in the |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
707 pack directory and the help command works right away. Don't forget to re-run |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
708 the command after changing the plugin help: > |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
709 :helptags path/start/foobar/doc |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
710 :helptags path/opt/fooextra/doc |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
711 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
712 |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
713 Dependencies between plugins ~ |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
714 *packload-two-steps* |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9116
diff
changeset
|
715 Suppose you have two plugins that depend on the same functionality. You can |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
716 put the common functionality in an autoload directory, so that it will be |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
717 found automatically. Your package would have these files: |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
718 |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
719 pack/foo/start/one/plugin/one.vim > |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
720 call foolib#getit() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
721 < pack/foo/start/two/plugin/two.vim > |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
722 call foolib#getit() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
723 < pack/foo/start/lib/autoload/foolib.vim > |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
724 func foolib#getit() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
725 |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
726 This works, because loading packages will first add all found directories to |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
727 'runtimepath' before sourcing the plugins. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
728 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
729 ============================================================================== |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
730 7. Debugging scripts *debug-scripts* |
| 7 | 731 |
| 732 Besides the obvious messages that you can add to your scripts to find out what | |
| 733 they are doing, Vim offers a debug mode. This allows you to step through a | |
| 734 sourced file or user function and set breakpoints. | |
| 735 | |
| 736 NOTE: The debugging mode is far from perfect. Debugging will have side | |
| 737 effects on how Vim works. You cannot use it to debug everything. For | |
| 738 example, the display is messed up by the debugging messages. | |
| 739 | |
| 740 An alternative to debug mode is setting the 'verbose' option. With a bigger | |
| 741 number it will give more verbose messages about what Vim is doing. | |
| 742 | |
| 743 | |
| 744 STARTING DEBUG MODE *debug-mode* | |
| 745 | |
| 746 To enter debugging mode use one of these methods: | |
| 747 1. Start Vim with the |-D| argument: > | |
| 748 vim -D file.txt | |
| 749 < Debugging will start as soon as the first vimrc file is sourced. This is | |
| 750 useful to find out what is happening when Vim is starting up. A side | |
| 751 effect is that Vim will switch the terminal mode before initialisations | |
| 752 have finished, with unpredictable results. | |
| 753 For a GUI-only version (Windows, Macintosh) the debugging will start as | |
| 754 soon as the GUI window has been opened. To make this happen early, add a | |
| 755 ":gui" command in the vimrc file. | |
| 756 *:debug* | |
| 757 2. Run a command with ":debug" prepended. Debugging will only be done while | |
| 758 this command executes. Useful for debugging a specific script or user | |
| 759 function. And for scripts and functions used by autocommands. Example: > | |
| 760 :debug edit test.txt.gz | |
| 761 | |
| 762 3. Set a breakpoint in a sourced file or user function. You could do this in | |
| 763 the command line: > | |
| 764 vim -c "breakadd file */explorer.vim" . | |
| 765 < This will run Vim and stop in the first line of the "explorer.vim" script. | |
| 766 Breakpoints can also be set while in debugging mode. | |
| 767 | |
| 768 In debugging mode every executed command is displayed before it is executed. | |
| 769 Comment lines, empty lines and lines that are not executed are skipped. When | |
| 770 a line contains two commands, separated by "|", each command will be displayed | |
| 771 separately. | |
| 772 | |
| 773 | |
| 774 DEBUG MODE | |
| 775 | |
| 776 Once in debugging mode, the usual Ex commands can be used. For example, to | |
| 777 inspect the value of a variable: > | |
| 778 echo idx | |
| 779 When inside a user function, this will print the value of the local variable | |
| 780 "idx". Prepend "g:" to get the value of a global variable: > | |
| 781 echo g:idx | |
| 782 All commands are executed in the context of the current function or script. | |
| 783 You can also set options, for example setting or resetting 'verbose' will show | |
| 784 what happens, but you might want to set it just before executing the lines you | |
| 785 are interested in: > | |
| 786 :set verbose=20 | |
| 787 | |
| 788 Commands that require updating the screen should be avoided, because their | |
| 789 effect won't be noticed until after leaving debug mode. For example: > | |
| 790 :help | |
| 791 won't be very helpful. | |
| 792 | |
| 793 There is a separate command-line history for debug mode. | |
| 794 | |
| 26304 | 795 NOTE: In Vim9 script, if a command is written at the script level and |
| 796 continues on the next line, not using the old way with a backslash for line | |
| 797 continuation, only the first line is printed before the debugging prompt. | |
| 798 | |
| 7 | 799 The line number for a function line is relative to the start of the function. |
| 800 If you have trouble figuring out where you are, edit the file that defines | |
| 801 the function in another Vim, search for the start of the function and do | |
| 802 "99j". Replace "99" with the line number. | |
| 803 | |
| 804 Additionally, these commands can be used: | |
| 805 *>cont* | |
| 806 cont Continue execution until the next breakpoint is hit. | |
| 807 *>quit* | |
| 808 quit Abort execution. This is like using CTRL-C, some | |
| 809 things might still be executed, doesn't abort | |
| 810 everything. Still stops at the next breakpoint. | |
| 811 *>next* | |
| 812 next Execute the command and come back to debug mode when | |
| 813 it's finished. This steps over user function calls | |
| 814 and sourced files. | |
| 815 *>step* | |
| 816 step Execute the command and come back to debug mode for | |
| 817 the next command. This steps into called user | |
| 818 functions and sourced files. | |
| 819 *>interrupt* | |
| 820 interrupt This is like using CTRL-C, but unlike ">quit" comes | |
| 821 back to debug mode for the next command that is | |
| 822 executed. Useful for testing |:finally| and |:catch| | |
| 823 on interrupt exceptions. | |
| 824 *>finish* | |
| 825 finish Finish the current script or user function and come | |
| 826 back to debug mode for the command after the one that | |
| 827 sourced or called it. | |
|
7605
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
828 *>bt* |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
829 *>backtrace* |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
830 *>where* |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
831 backtrace Show the call stacktrace for current debugging session. |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
832 bt |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
833 where |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
834 *>frame* |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7605
diff
changeset
|
835 frame N Goes to N backtrace level. + and - signs make movement |
|
7605
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
836 relative. E.g., ":frame +3" goes three frames up. |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
837 *>up* |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
838 up Goes one level up from call stacktrace. |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
839 *>down* |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
840 down Goes one level down from call stacktrace. |
| 7 | 841 |
| 842 About the additional commands in debug mode: | |
| 843 - There is no command-line completion for them, you get the completion for the | |
| 844 normal Ex commands only. | |
|
8303
88207f4b861a
commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
845 - You can shorten them, up to a single character, unless more than one command |
|
7605
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
846 starts with the same letter. "f" stands for "finish", use "fr" for "frame". |
| 7 | 847 - Hitting <CR> will repeat the previous one. When doing another command, this |
| 848 is reset (because it's not clear what you want to repeat). | |
| 849 - When you want to use the Ex command with the same name, prepend a colon: | |
| 850 ":cont", ":next", ":finish" (or shorter). | |
| 25056 | 851 *vim9-debug* |
| 852 When debugging a compiled :def function, "step" will stop before every | |
| 25161 | 853 executed line, not every single instruction. Thus it works mostly like a not |
| 25056 | 854 compiled function. Access to local variables is limited you can use: > |
| 855 echo varname | |
| 856 But not much else. | |
| 857 When executing a command that is not a specific bytecode instruction but | |
| 858 executed like a normal Ex command, "step" will stop once in the compiled | |
| 859 context, where local variables can be inspected, and once just before | |
| 860 executing the command. | |
| 7 | 861 |
|
7605
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
862 The backtrace shows the hierarchy of function calls, e.g.: |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
863 >bt ~ |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
864 3 function One[3] ~ |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
865 2 Two[3] ~ |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
866 ->1 Three[3] ~ |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
867 0 Four ~ |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
868 line 1: let four = 4 ~ |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
869 |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
870 The "->" points to the current frame. Use "up", "down" and "frame N" to |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
871 select another frame. |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
872 |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
873 In the current frame you can evaluate the local function variables. There is |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
874 no way to see the command at the current line yet. |
|
8fc60af6dbf5
commit https://github.com/vim/vim/commit/f1f60f859cdbb2638b3662ccf7b1d179865fe7dc
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
875 |
| 7 | 876 |
| 877 DEFINING BREAKPOINTS | |
| 878 *:breaka* *:breakadd* | |
| 879 :breaka[dd] func [lnum] {name} | |
| 880 Set a breakpoint in a function. Example: > | |
| 881 :breakadd func Explore | |
| 882 < Doesn't check for a valid function name, thus the breakpoint | |
| 883 can be set before the function is defined. | |
| 884 | |
| 885 :breaka[dd] file [lnum] {name} | |
| 886 Set a breakpoint in a sourced file. Example: > | |
| 887 :breakadd file 43 .vimrc | |
| 888 | |
| 10 | 889 :breaka[dd] here |
| 890 Set a breakpoint in the current line of the current file. | |
| 891 Like doing: > | |
| 892 :breakadd file <cursor-line> <current-file> | |
| 893 < Note that this only works for commands that are executed when | |
| 894 sourcing the file, not for a function defined in that file. | |
| 895 | |
|
13262
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
896 :breaka[dd] expr {expression} |
|
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
897 Sets a breakpoint, that will break whenever the {expression} |
|
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
898 evaluates to a different value. Example: > |
|
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
899 :breakadd expr g:lnum |
| 25773 | 900 < Will break, whenever the global variable lnum changes. |
|
13262
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
901 |
| 25773 | 902 Errors in evaluation are suppressed, you can use the name of a |
| 903 variable that does not exist yet. This also means you will | |
| 904 not notice anything if the expression has a mistake. | |
| 905 | |
|
13262
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
906 Note if you watch a |script-variable| this will break |
|
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
907 when switching scripts, since the script variable is only |
|
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
908 valid in the script where it has been defined and if that |
|
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
909 script is called from several other scripts, this will stop |
|
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
910 whenever that particular variable will become visible or |
| 24024 | 911 inaccessible again. |
|
13262
69278c25429d
patch 8.0.1505: debugger can't break on a condition
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
912 |
| 7 | 913 The [lnum] is the line number of the breakpoint. Vim will stop at or after |
| 914 this line. When omitted line 1 is used. | |
| 915 | |
| 170 | 916 *:debug-name* |
| 7 | 917 {name} is a pattern that is matched with the file or function name. The |
| 918 pattern is like what is used for autocommands. There must be a full match (as | |
| 919 if the pattern starts with "^" and ends in "$"). A "*" matches any sequence | |
| 920 of characters. 'ignorecase' is not used, but "\c" can be used in the pattern | |
| 921 to ignore case |/\c|. Don't include the () for the function name! | |
| 922 | |
| 11 | 923 The match for sourced scripts is done against the full file name. If no path |
| 924 is specified the current directory is used. Examples: > | |
| 925 breakadd file explorer.vim | |
| 926 matches "explorer.vim" in the current directory. > | |
| 7 | 927 breakadd file *explorer.vim |
| 11 | 928 matches ".../plugin/explorer.vim", ".../plugin/iexplorer.vim", etc. > |
| 7 | 929 breakadd file */explorer.vim |
| 11 | 930 matches ".../plugin/explorer.vim" and "explorer.vim" in any other directory. |
| 7 | 931 |
| 932 The match for functions is done against the name as it's shown in the output | |
|
23717
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
933 of ":function". However, for local functions the script-specific prefix such |
|
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
934 as "<SNR>99_" is ignored to make it easier to match script-local functions |
|
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
935 without knowing the ID of the script. |
| 7 | 936 |
| 148 | 937 Note that functions are first loaded and later executed. When they are loaded |
| 938 the "file" breakpoints are checked, when they are executed the "func" | |
| 939 breakpoints. | |
| 940 | |
| 7 | 941 |
| 942 DELETING BREAKPOINTS | |
| 943 *:breakd* *:breakdel* *E161* | |
| 944 :breakd[el] {nr} | |
| 945 Delete breakpoint {nr}. Use |:breaklist| to see the number of | |
| 946 each breakpoint. | |
| 947 | |
| 359 | 948 :breakd[el] * |
| 949 Delete all breakpoints. | |
| 950 | |
| 7 | 951 :breakd[el] func [lnum] {name} |
| 952 Delete a breakpoint in a function. | |
| 953 | |
| 954 :breakd[el] file [lnum] {name} | |
| 955 Delete a breakpoint in a sourced file. | |
| 956 | |
| 10 | 957 :breakd[el] here |
| 958 Delete a breakpoint at the current line of the current file. | |
| 959 | |
| 7 | 960 When [lnum] is omitted, the first breakpoint in the function or file is |
| 961 deleted. | |
| 962 The {name} must be exactly the same as what was typed for the ":breakadd" | |
| 963 command. "explorer", "*explorer.vim" and "*explorer*" are different. | |
| 964 | |
| 965 | |
| 966 LISTING BREAKPOINTS | |
| 967 *:breakl* *:breaklist* | |
| 968 :breakl[ist] | |
| 969 List all breakpoints. | |
| 970 | |
| 971 | |
| 972 OBSCURE | |
| 973 | |
| 974 *:debugg* *:debuggreedy* | |
| 975 :debugg[reedy] | |
| 976 Read debug mode commands from the normal input stream, instead | |
| 977 of getting them directly from the user. Only useful for test | |
| 978 scripts. Example: > | |
| 979 echo 'q^Mq' | vim -e -s -c debuggreedy -c 'breakadd file script.vim' -S script.vim | |
| 980 | |
| 981 :0debugg[reedy] | |
| 982 Undo ":debuggreedy": get debug mode commands directly from the | |
| 983 user, don't use typeahead for debug commands. | |
| 984 | |
| 170 | 985 ============================================================================== |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
986 8. Profiling *profile* *profiling* |
| 170 | 987 |
|
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
988 Profiling means that Vim measures the time that is spent on executing |
| 170 | 989 functions and/or scripts. The |+profile| feature is required for this. |
|
23717
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
990 It is included when Vim was compiled with "huge" features. |
| 170 | 991 |
| 794 | 992 You can also use the |reltime()| function to measure time. This only requires |
|
23717
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
993 the |+reltime| feature, which is present in more builds. |
| 794 | 994 |
| 5244 | 995 For profiling syntax highlighting see |:syntime|. |
| 996 | |
| 5763 | 997 For example, to profile the one_script.vim script file: > |
| 998 :profile start /tmp/one_script_profile | |
| 999 :profile file one_script.vim | |
| 1000 :source one_script.vim | |
| 1001 :exit | |
| 1002 | |
| 5244 | 1003 |
| 170 | 1004 :prof[ile] start {fname} *:prof* *:profile* *E750* |
| 1005 Start profiling, write the output in {fname} upon exit. | |
| 6757 | 1006 "~/" and environment variables in {fname} will be expanded. |
| 790 | 1007 If {fname} already exists it will be silently overwritten. |
| 170 | 1008 The variable |v:profiling| is set to one. |
| 1009 | |
| 790 | 1010 :prof[ile] pause |
| 1011 Don't profile until the following ":profile continue". Can be | |
| 1012 used when doing something that should not be counted (e.g., an | |
| 1013 external command). Does not nest. | |
| 1014 | |
| 1015 :prof[ile] continue | |
| 1016 Continue profiling after ":profile pause". | |
| 1017 | |
| 170 | 1018 :prof[ile] func {pattern} |
| 1019 Profile function that matches the pattern {pattern}. | |
| 1020 See |:debug-name| for how {pattern} is used. | |
| 1021 | |
| 1022 :prof[ile][!] file {pattern} | |
| 1023 Profile script file that matches the pattern {pattern}. | |
| 1024 See |:debug-name| for how {pattern} is used. | |
| 1025 This only profiles the script itself, not the functions | |
| 1026 defined in it. | |
| 1027 When the [!] is added then all functions defined in the script | |
| 5763 | 1028 will also be profiled. |
| 1029 Note that profiling only starts when the script is loaded | |
| 1030 after this command. A :profile command in the script itself | |
| 1031 won't work. | |
| 170 | 1032 |
| 1033 | |
| 364 | 1034 :profd[el] ... *:profd* *:profdel* |
| 1035 Stop profiling for the arguments specified. See |:breakdel| | |
| 1036 for the arguments. | |
| 1037 | |
| 1038 | |
| 170 | 1039 You must always start with a ":profile start fname" command. The resulting |
|
23717
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
1040 file is written when Vim exits. For example, to profile one specific |
|
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
1041 function: > |
|
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
1042 profile start /tmp/vimprofile |
|
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
1043 profile func MyFunc |
|
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
1044 |
|
e3720756acdc
patch 8.2.2400: Vim9: compiled functions are not profiled
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
1045 Here is an example of the output, with line |
| 170 | 1046 numbers prepended for the explanation: |
| 1047 | |
| 1048 1 FUNCTION Test2() ~ | |
| 1049 2 Called 1 time ~ | |
| 1050 3 Total time: 0.155251 ~ | |
| 1051 4 Self time: 0.002006 ~ | |
| 1052 5 ~ | |
| 1053 6 count total (s) self (s) ~ | |
| 856 | 1054 7 9 0.000096 for i in range(8) ~ |
| 1055 8 8 0.153655 0.000410 call Test3() ~ | |
| 1056 9 8 0.000070 endfor ~ | |
| 1057 10 " Ask a question ~ | |
| 1058 11 1 0.001341 echo input("give me an answer: ") ~ | |
| 170 | 1059 |
| 1060 The header (lines 1-4) gives the time for the whole function. The "Total" | |
| 1061 time is the time passed while the function was executing. The "Self" time is | |
| 1062 the "Total" time reduced by time spent in: | |
| 1063 - other user defined functions | |
| 1064 - sourced scripts | |
| 1065 - executed autocommands | |
| 1066 - external (shell) commands | |
| 1067 | |
| 1068 Lines 7-11 show the time spent in each executed line. Lines that are not | |
| 1069 executed do not count. Thus a comment line is never counted. | |
| 1070 | |
| 1071 The Count column shows how many times a line was executed. Note that the | |
| 1072 "for" command in line 7 is executed one more time as the following lines. | |
| 1073 That is because the line is also executed to detect the end of the loop. | |
| 1074 | |
| 1075 The time Vim spends waiting for user input isn't counted at all. Thus how | |
| 1076 long you take to respond to the input() prompt is irrelevant. | |
| 1077 | |
| 1078 Profiling should give a good indication of where time is spent, but keep in | |
| 1079 mind there are various things that may clobber the results: | |
| 1080 | |
| 1081 - The accuracy of the time measured depends on the gettimeofday() system | |
| 1082 function. It may only be as accurate as 1/100 second, even though the times | |
| 1083 are displayed in micro seconds. | |
| 1084 | |
| 1085 - Real elapsed time is measured, if other processes are busy they may cause | |
| 1086 delays at unpredictable moments. You may want to run the profiling several | |
| 1087 times and use the lowest results. | |
| 1088 | |
| 1089 - If you have several commands in one line you only get one time. Split the | |
| 1090 line to see the time for the individual commands. | |
| 1091 | |
| 1092 - The time of the lines added up is mostly less than the time of the whole | |
| 1093 function. There is some overhead in between. | |
| 1094 | |
| 1095 - Functions that are deleted before Vim exits will not produce profiling | |
| 1096 information. You can check the |v:profiling| variable if needed: > | |
| 856 | 1097 :if !v:profiling |
| 170 | 1098 : delfunc MyFunc |
| 1099 :endif | |
| 1100 < | |
| 177 | 1101 - Profiling may give weird results on multi-processor systems, when sleep |
| 1102 mode kicks in or the processor frequency is reduced to save power. | |
| 170 | 1103 |
| 1125 | 1104 - The "self" time is wrong when a function is used recursively. |
| 1105 | |
| 1106 | |
| 14421 | 1107 vim:tw=78:ts=8:noet:ft=help:norl: |