haskal
/
vagrant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

website/docs: update docs on `vagrant plugin`

This commit is contained in:
Mitchell Hashimoto 2014-01-05 21:28:16 -08:00
parent 561e65ec72
commit ad0651a29b
1 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
website/docs/source/v2/cli/plugin.html.md
View File

@ -28,6 +28,25 @@ repositories, usually [RubyGems](http://rubygems.org). This command will
also update a plugin if it is already installed, but you can also use
`vagrant plugin update` for that.
This command accepts optional command-line flags:
* `--entry-point ENTRYPOINT` - By default, installed plugins are loaded
internally by loading an initialization file of the same name as the plugin.
Most of the time, this is correct. If the plugin you're installing has
another entrypoint, this flag can be used to specify it.
* `--plugin-source SOURCE` - Adds a source from which to fetch a plugin. Note
that this doesn't only affect the single plugin being installed, by all future
plugin as well. This is a limitation of the underlying plugin installer
Vagrant uses.
* `--plugin-version VERSION` - The version of the plugin to install. By default,
this command will install the latest version. You can constrain the version
using this flag. You can set it to a specific version, such as "1.2.3" or
you can set it to a version contraint, such as "> 1.0.2". You can set it
to a more complex constraint by comma-separating multiple constraints:
"> 1.0.2, < 1.1.0" (don't forget to quote these on the command-line).
# Plugin License
**Command: `vagrant plugin license <name> <license-file>`**
@ -39,7 +58,10 @@ such as the [VMware Fusion provider](/v2/vmware/index.html).
**Command: `vagrant plugin list`**
This lists all installed plugins and their respective versions.
This lists all installed plugins and their respective installed versions.
If a version constraint was specified for a plugin when installing it, the
constraint will be listed as well. Other plugin-specific information may
be shown, too.
# Plugin Uninstall
@ -50,7 +72,13 @@ plugin will also be uninstalled assuming no other plugin needs them.
# Plugin Update
**Command: `vagrant plugin update <name>`**
**Command: `vagrant plugin update [<name>]`**
This updates the plugin with the given name. If the plugin isn't already
installed, this will not install it.
This updates the plugins that are installed within Vagrant. If you specified
version constraints when installing the plugin, this command will respect
those constraints. If you want to change a version constraint, re-install
the plugin using `vagrant plugin install`.
If a name is specified, only that single plugin will be updated. If a
name is specified of a plugin that is not installed, this command will not
install it.