vim-addons home^Wmanpage
authorStefano Zacchiroli <zack@debian.org>
Wed, 26 Dec 2007 11:42:09 +0000 (12:42 +0100)
committerStefano Zacchiroli <zack@debian.org>
Wed, 26 Dec 2007 11:42:09 +0000 (12:42 +0100)
hacking/software.mdwn
hacking/software/Makefile [new file with mode: 0644]
hacking/software/vim-addons.1.html [new file with mode: 0644]

index 8fa7f58..69e05ee 100644 (file)
@@ -39,7 +39,7 @@ package](http://packages.qa.debian.org/cduce)]
   package](http://packages.qa.debian.org/vim)]
 * [Debian](http://www.debian.org)-specific stuff:
   * **Vim addon manager** - manager of addons for the [Vim
-  editor](http://www.vim.org) [[[hompage|vim-addon-manager]], [debian
+  editor](http://www.vim.org) [ [[manpage|vim-addons.1.html]], [debian
   package](http://packages.qa.debian.org/vim-addon-manager)]
   * **debcheckout** (now part of *[devscripts](http://alioth.debian.org/projects/devscripts/)*) -
   checkout Debian packages from their version control systems
diff --git a/hacking/software/Makefile b/hacking/software/Makefile
new file mode 100644 (file)
index 0000000..d58355b
--- /dev/null
@@ -0,0 +1,8 @@
+all: vim-addons.1.html
+
+vim-addons.1.html: vim-addons.1
+       rman -f html -r 'http://upsilon.cc/~zack/hacking/software/%s.%s.html' \
+               $< > $@
+.INTERMEDIATE: vim-addons.1
+vim-addons.1: /usr/share/man/man1/vim-addons.1.gz
+       gunzip -c $< > $@
diff --git a/hacking/software/vim-addons.1.html b/hacking/software/vim-addons.1.html
new file mode 100644 (file)
index 0000000..ab027af
--- /dev/null
@@ -0,0 +1,175 @@
+ <!-- manual page source format generated by PolyglotMan v3.2, -->
+<!-- available at http://polyglotman.sourceforge.net/ -->
+
+<html>
+<head>
+<title>vim-addons(1) manual page</title>
+</head>
+<body bgcolor='white'>
+<a href='#toc'>Table of Contents</a><p>
+
+<h3><a name='sect0' href='#toc0'>Name</a></h3>
+<p>
+vim-addons - command line manager of Vim add-ons 
+<h3><a name='sect1' href='#toc1'>Synopsis</a></h3>
+<p>
+vim-addons [OPTION
+...] [COMMAND [ADDON ...]] 
+<h3><a name='sect2' href='#toc2'>Description</a></h3>
+<p>
+Manage Vim addons installed system-wide,
+enabling on a per-user basis their installation, removal, ... <p>
+vim-addons is
+capable of managing all Vim addons registered in the system-wide registry
+of Vim addons (see <a href='http://upsilon.cc/~zack/hacking/software/vim-registry.5.html'>vim-registry(5)</a>
+). Each system-wide addon can be, with respect
+to a user Vim configuration, in one of the following states: </pre>
+<dl>
+
+<dt><b></b> installed
+</dt>
+<dd>all of the files composing the addon are installed (i.e. symlinked) somewhere
+under ~/.vim. The addon is fully functional for the current user </pre></dd>
+
+<dt><b></b> removed
+</dt>
+<dd>the files composing the addon are not installed under ~/.vim. The addon might
+still be working for the current user if it is installed system-wide by
+the local administrator </pre></dd>
+
+<dt><b></b> disabled </dt>
+<dd>the files composing the addon are not
+installed under ~/.vim, but the addon is installed system-wide. However, the
+addon has been disabled for the current user explicitely requiring so via
+some configuration line in ~/.vim/plugin/vim-addons.vim. The addon is not working
+for the current user </pre></dd>
+
+<dt><b></b> broken </dt>
+<dd>only some of the files composing the addon
+are installed under ~/.vim. The addon is probably not working for the current
+user </dd>
+</dl>
+
+<h3><a name='sect3' href='#toc3'>Commands</a></h3>
+<p>
+A number of commands can be given to vim-addons to inspect
+or alter the status of the addons: list, status, install, remove, disable,
+amend, files, show. <p>
+A description of the semantics of each command is reported
+below. </pre>
+<dl>
+
+<dt><b></b> list </dt>
+<dd>list, one per line, the names of the addons available in the
+system (i.e. of all the addons mentioned in the registry, not necessarily
+of all enabled addons) </pre></dd>
+
+<dt><b></b> status </dt>
+<dd>show, one per line, the status of the addons
+available in the system. If one or more addon arguments are specified only
+show the status of those addons. This is the default command if nothing
+is specified. </pre></dd>
+
+<dt><b></b> install </dt>
+<dd>install one or more addons under ~/.vim. Requires at
+least one addon argument </pre></dd>
+
+<dt><b></b> remove </dt>
+<dd>remove one or more addons from ~/.vim. Requires
+at least one addon argument </pre></dd>
+
+<dt><b></b> disable </dt>
+<dd>disable one or more addons to be used
+by the current user. Usually used for addons which are system-wide enabled
+by the local administrator but that the current user does not want to be
+used. Using this command will automatically change the content of ~/.vim/plugin/vim-addons.vim,
+probably adding let definitions which will inhibit the given addon to be
+used. Requires at least one addon argument </pre></dd>
+
+<dt><b></b> amend </dt>
+<dd>undo the effects of a
+previous disable command. Requires at least one addon argument </pre></dd>
+
+<dt><b></b> files </dt>
+<dd>list,
+one per line, the files composing the specified addons. Files are listed
+relative to components of the Vim runtimepath (see &rsquo;runtimepath&rsquo; in the Vim
+help). Requires at least one addon argument </pre></dd>
+
+<dt><b></b> show </dt>
+<dd>displays detailed information
+about the specified addons </dd>
+</dl>
+
+<h3><a name='sect4' href='#toc4'>Options</a></h3>
+<p>
+All commands accept the following options:
+</pre>
+<dl>
+
+<dt><b></b> -h, --help </dt>
+<dd>show this usage message and exit </pre></dd>
+
+<dt><b></b> -q, --query </dt>
+<dd>be quiet and make the
+output more parseable (for "status") </pre></dd>
+
+<dt><b></b> -r, --registry-dir </dt>
+<dd>set the registry directory
+(default: /usr/share/vim/registry) </pre></dd>
+
+<dt><b></b> -s, --source-dir </dt>
+<dd>set the addons source
+directory (default: /usr/share/vim/addons) </pre></dd>
+
+<dt><b></b> -t, --target-dir </dt>
+<dd>set the addons
+target directory (default: $HOME/.vim) </pre></dd>
+
+<dt><b></b> -v, --verbose </dt>
+<dd>increase verbosity level
+</pre></dd>
+
+<dt><b></b> -y, --system-dir </dt>
+<dd>set the system-wide target directory (default: /var/lib/vim/addons)
+</pre></dd>
+
+<dt><b></b> -w, --system-wide </dt>
+<dd>set the addons target directory to the system-wide target
+directory, possibly overriding the -t option </dd>
+</dl>
+
+<h3><a name='sect5' href='#toc5'>Author</a></h3>
+<p>
+Stefano Zacchiroli &lt;zack@debian.org&gt;
+
+<h3><a name='sect6' href='#toc6'>See Also</a></h3>
+<p>
+<a href='http://upsilon.cc/~zack/hacking/software/vim.1.html'>vim(1)</a>
+, <a href='http://upsilon.cc/~zack/hacking/software/vim-registry.5.html'>vim-registry(5)</a>
+<h3><a name='sect7' href='#toc7'>Copyright</a></h3>
+<p>
+Copyright (C) 2007 Stefano Zacchiroli
+<p>
+This program is free software, you can redistribute it and/or modify it
+under the terms of the GNU General Public License version 3 as published
+by the Free Software Foundation; either version 3 of the License, or (at
+your option) any later version. 
+<p> <p>
+
+<hr><p>
+<a name='toc'><b>Table of Contents</b></a><p>
+<ul>
+<ul>
+<li><a name='toc0' href='#sect0'>Name</a></li>
+<li><a name='toc1' href='#sect1'>Synopsis</a></li>
+<li><a name='toc2' href='#sect2'>Description</a></li>
+<li><a name='toc3' href='#sect3'>Commands</a></li>
+<li><a name='toc4' href='#sect4'>Options</a></li>
+<li><a name='toc5' href='#sect5'>Author</a></li>
+<li><a name='toc6' href='#sect6'>See Also</a></li>
+<li><a name='toc7' href='#sect7'>Copyright</a></li>
+</ul></ul>
+</body>
+</html>