r887 - in /trunk/packages/vim-scripts/debian: README.Debian changelog

[zack at users.alioth.debian.org]

Author: zack
Date: Sun Feb  4 19:23:57 2007
New Revision: 887

URL: http://svn.debian.org/wsvn/pkg-vim/?sc=1&rev=887
Log:
rewritten usage notes pointing to vim-addons

Modified:
    trunk/packages/vim-scripts/debian/README.Debian
    trunk/packages/vim-scripts/debian/changelog

Modified: trunk/packages/vim-scripts/debian/README.Debian
URL: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim-scripts/debian/README.Debian?rev=887&op=diff
==============================================================================
--- trunk/packages/vim-scripts/debian/README.Debian (original)
+++ trunk/packages/vim-scripts/debian/README.Debian Sun Feb  4 19:23:57 2007
@@ -1,39 +1,38 @@
-
 Using the addons
 ================
 
-  If you just link these scripts instead of copying them, they will be
-upgraded automatically. That's a good idea.
+The addons shipped by the "vim-scripts" package are *not* enabled per
+default, you have to copy, or better link, them in a directory which is
+in the Vim runtimepath (see :help 'runtimepath' in Vim) in order to use
+them.  All the shipped addons however are registered in the Vim addon
+registry, therefore you can install the "vim-addon-manager" package and
+use it to manage enabling and disabling of addons.
 
-  If you, as system administrator, want to make those scripts available
-to everyone, you should not make those links in the $VIMRUNTIME
-directory for two reasons: On installing a new version of vim, a new
-$VIMRUNTIME directory is used - the old symlinks are ignored; on
-removing the old version, the symlinks might be removed, leaving no
-trace behind.
+For example, after having installed "vim-addon-manager", you can (as a
+user) enable the "gnupg" addon by executing:
 
-  You can, however, put them into /etc/vim which is included in
-option 'runtimepath' on Debian systems. For example:
+  vim-addons install gnupg
 
-  cd /etc/vim
-  mkdir ftplugin
-  cd ftplugin
-  ln -s /usr/share/vim-scripts/ftplugin/xml.vim
+If you (as a system administrator) want to do the same in a system-wide
+manner, so that all the users can benefit of the addon for free, you can
+do so executing:
 
-will make the xml.vim filetype plugin available to every user.
+  vim-addons --system-wide install gnupg
 
-  You can also have all scripts available by all users adding
-/usr/share/vim-scripts to the 'runtimepath' vim option. Just add the
-following line to your /etc/vim/vimrc.local [1]:
-  set runtimepath+=/usr/share/vim-scripts
+Refer to the documentation of vim-addons for more info.
 
-  Also you may want to have a look at the scripts which hide in Vim's
-macro directory, which is found at /usr/share/vim/vim63/macros in
-Debian. Especially the matchit.vim script is nice.
+Shipped addons
+--------------
 
-[1] you can create it if you don't have one, it will be sourced by
-    /etc/vim/vimrc and changes on it will be preserved across vim
-    package upgrades
+You can obtain the list of the shipped addons, together with their
+description, directly from the Vim addon registry entry for vim-scripts
+(/usr/share/vim/registry/vim-scripts.yaml).
+
+For a quick listing of pairs addon name / addon description try:
+
+  egrep '^(addon|description):' /usr/share/vim/registry/vim-scripts.yaml | sed "1~2i\ "
+
+ -- Stefano Zacchiroli <zack at debian.org>  Sun, 04 Feb 2007 19:04:45 +0100
 
 dtd2vim
 =======
@@ -43,3 +42,4 @@
 to use dtd2vim you have to install the "perlsgml" debian package, which
 contains the Perl DTD module required by dtd2vim.
 
+ -- Stefano Zacchiroli <zack at debian.org>  Sun, 04 Feb 2007 19:04:45 +0100

Modified: trunk/packages/vim-scripts/debian/changelog
URL: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim-scripts/debian/changelog?rev=887&op=diff
==============================================================================
--- trunk/packages/vim-scripts/debian/changelog (original)
+++ trunk/packages/vim-scripts/debian/changelog Sun Feb  4 19:23:57 2007
@@ -11,6 +11,7 @@
     - bumped debhelper dependency to > 5, changed debian/compat accordingly
   * debian/README.debian
     - mention the requirement of perlsgml for using dtd2vim
+    - rewritten usage notes pointing to vim-addon-manager
   * addons adds/removals/upgrades(/other changes)
     - added binary dtd2vim to generate XML data file for Vim 7 DTD-based omni
       completion
@@ -31,7 +32,7 @@
     - added a description of what the shipped html pages are and a stamp
       marking when they have been downloaded
 
- -- Stefano Zacchiroli <zack at debian.org>  Sat, 27 Jan 2007 10:09:26 +0100
+ -- Stefano Zacchiroli <zack at debian.org>  Sun,  4 Feb 2007 19:23:14 +0100
 
 vim-scripts (7.0.4) unstable; urgency=low