1- *usr_05.txt* For Vim version 7.4. Last change: 2012 Nov 20
1+ *usr_05.txt* For Vim version 7.4. Last change: 2016 Mar 25
22
33 VIM USER MANUAL - by Bram Moolenaar
44
@@ -12,10 +12,11 @@ Vim's capabilities. Or define your own macros.
1212| 05.1 | The vimrc file
1313| 05.2 | The example vimrc file explained
1414| 05.3 | Simple mappings
15- | 05.4 | Adding a plugin
16- | 05.5 | Adding a help file
17- | 05.6 | The option window
18- | 05.7 | Often used options
15+ | 05.4 | Adding a package
16+ | 05.5 | Adding a plugin
17+ | 05.6 | Adding a help file
18+ | 05.7 | The option window
19+ | 05.8 | Often used options
1920
2021 Next chapter: | usr_06.txt | Using syntax highlighting
2122 Previous chapter: | usr_04.txt | Making small changes
@@ -263,7 +264,46 @@ The ":map" command (with no arguments) lists your current mappings. At
263264least the ones for Normal mode. More about mappings in section | 40.1 | .
264265
265266==============================================================================
266- *05.4* Adding a plugin *add-plugin* *plugin*
267+ *05.4* Adding a package *add-package* *matchit-install*
268+
269+ A package is a set of files that you can add to Vim. There are two kinds of
270+ packages: optional and automatically loaded on startup.
271+
272+ The Vim distribution comes with a few packages that you can optionally use.
273+ For example, the matchit plugin. This plugin makes the "%" command jump to
274+ matching HTML tags, if/else/endif in Vim scripts, etc. Very useful, although
275+ it's not backwards compatible (that's why it is not enabled by default).
276+
277+ To start using the matchit plugin, add one line to your vimrc file: >
278+ packadd matchit
279+
280+ That's all! You can also type the command to try it out. Now you can find
281+ help about this plugin: >
282+ :help matchit
283+
284+ This works, because when `:packadd ` loaded the plugin it also added the
285+ package directory in 'runtimepath' , so that the help file can be found.
286+
287+ You can find packages on the Internet in various places. It usually comes as
288+ an archive or as a repository. For an archive you can follow these steps:
289+ 1. create the package directory: >
290+ mkdir -p ~/.vim/pack/fancy
291+ < "fancy" can be any name of your liking. Use one that describes the
292+ package.
293+ 2. unpack the archive in that directory. This assumes the top
294+ directory in the archive is "start": >
295+ cd ~/.vim/pack/fancy
296+ unzip /tmp/fancy.zip
297+ < If the archive layout is different make sure that you end up with a
298+ path like this:
299+ ~/.vim/pack/fancy/start/fancytext/plugin/fancy.vim ~
300+ Here "fancytext" is the name of the package, it can be anything
301+ else.
302+
303+ More information about packages can be found here: | packages | .
304+
305+ ==============================================================================
306+ *05.5* Adding a plugin *add-plugin* *plugin*
267307
268308Vim's functionality can be extended by adding plugins. A plugin is nothing
269309more than a Vim script file that is loaded automatically when Vim starts. You
@@ -415,23 +455,19 @@ Further reading:
415455| new-filetype | How to detect a new file type.
416456
417457==============================================================================
418- *05.5 * Adding a help file *add-local-help* *matchit-install *
458+ *05.6 * Adding a help file *add-local-help*
419459
420460If you are lucky, the plugin you installed also comes with a help file. We
421461will explain how to install the help file, so that you can easily find help
422462for your new plugin.
423- Let us use the "matchit.vim" plugin as an example (it is included with
424- Vim). This plugin makes the "%" command jump to matching HTML tags,
425- if/else/endif in Vim scripts, etc. Very useful, although it's not backwards
426- compatible (that's why it is not enabled by default).
427- This plugin comes with documentation: "matchit.txt". Let's first copy the
428- plugin to the right directory. This time we will do it from inside Vim, so
429- that we can use $VIMRUNTIME. (You may skip some of the "mkdir" commands if
430- you already have the directory.) >
463+ Let us use the "doit.vim" plugin as an example. This plugin comes with
464+ documentation: "doit.txt". Let's first copy the plugin to the right
465+ directory. This time we will do it from inside Vim. (You may skip some of
466+ the "mkdir" commands if you already have the directory.) >
431467
432468 :!mkdir ~/.vim
433469 :!mkdir ~/.vim/plugin
434- :!cp $VIMRUNTIME/macros/matchit .vim ~/.vim/plugin
470+ :!cp /tmp/doit .vim ~/.vim/plugin
435471
436472 The "cp" command is for Unix, on MS-DOS you can use "copy".
437473
@@ -441,7 +477,7 @@ Now create a "doc" directory in one of the directories in 'runtimepath'. >
441477
442478 Copy the help file to the "doc" directory. >
443479
444- :!cp $VIMRUNTIME/macros/matchit .txt ~/.vim/doc
480+ :!cp /tmp/doit .txt ~/.vim/doc
445481
446482 Now comes the trick, which allows you to jump to the subjects in the new help
447483file: Generate the local tags file with the | :helptags | command. >
@@ -450,10 +486,10 @@ file: Generate the local tags file with the |:helptags| command. >
450486
451487 Now you can use the >
452488
453- :help g%
489+ :help doit
454490
455- command to find help for "g% " in the help file you just added. You can see an
456- entry for the local help file when you do: >
491+ command to find help for "doit " in the help file you just added. You can see
492+ an entry for the local help file when you do: >
457493
458494 :help local-additions
459495
@@ -464,7 +500,7 @@ them through the tag.
464500For writing a local help file, see | write-local-help | .
465501
466502==============================================================================
467- *05.6 * The option window
503+ *05.7 * The option window
468504
469505If you are looking for an option that does what you want, you can search in
470506the help files here: | options | . Another way is by using this command: >
@@ -503,7 +539,7 @@ border. This is what the 'scrolloff' option does, it specifies an offset
503539from the window border where scrolling starts.
504540
505541==============================================================================
506- *05.7 * Often used options
542+ *05.8 * Often used options
507543
508544There are an awful lot of options. Most of them you will hardly ever use.
509545Some of the more useful ones will be mentioned here. Don't forget you can
0 commit comments