diff --git a/docs/user-guide/boxes.md b/docs/user-guide/boxes.md index 3c01f188b..24509458c 100644 --- a/docs/user-guide/boxes.md +++ b/docs/user-guide/boxes.md @@ -47,6 +47,7 @@ $ vagrant box remove ubuntu_base **Warning:** There is no going back from this command. This command literally deletes the files off the filesystem. + ## Creating a Box Boxes are created from a vagrant project. So the first step to creating a box diff --git a/docs/user-guide/commands.md b/docs/user-guide/commands.md index acb173bd7..e2a38df27 100644 --- a/docs/user-guide/commands.md +++ b/docs/user-guide/commands.md @@ -36,6 +36,11 @@ this may be annoying for reference needs, the titles of each section are simply the command, so you can easily use the browser search to find any command you're looking for. + +## vagrant box + +Boxes have there own section: [Vagrant Boxes](/docs/user-guide/boxes.html) + ## vagrant init @@ -49,6 +54,39 @@ environment which Vagrant creates. For more information regarding `Vagrantfile`s, read the entire section of the user guide dedicated to the `Vagrantfile`. + +## vagrant package + +{% highlight bash %} +$ vagrant package [ output-file ] [ --include ] +{% endhighlight %} + +Vagrant package brings together all the necessary files required for [VirtualBox](http://www.virtualbox.org) to create +and register an identical virtual environment for other projects or other machines. It is important to note +that if you intend to recreate an identical experience for another developer using Vagrant that the Vagrantfile +residing at the root of your project directory should be included, see [Vagrant Boxes](/docs/user-guide/boxes.html/#creating-a-box) for more information. + + +## vagrant resume + +When you're ready to get rolling again its just as easy to start your virtual machine back up with +`vagrant resume`. + + +## vagrant suspend + +When you're ready to call it quits for the day, there's no need to leave your Vagrant box soaking +up cpu cycles and memory. Simply issue `vagrant suspend` from your project root and VirtualBox will +take a snapshot of the box's current state from which you can resume later. + + +## vagrant ssh + +Working from the command line inside your box is accomplished with a vanilla ssh connection. In fact +you could use ssh directly, but using `vagrant ssh` means you don't have to remember the login information +or what port ssh is forwarded to from your box. To learn more about those settings see the section on the [Vagrantfile](/docs/user-guide/vagrantfile.html). +If you're box is booted simply run `vagrant ssh` from the root of your project directory. + ## vagrant up @@ -63,23 +101,5 @@ listed below, not in any specific order: * Provision with chef (if configured) * Boot in the background - -## vagrant ssh -Working from the command line inside your box is accomplished with a vanilla ssh connection. In fact -you could use ssh directly, but using `vagrant ssh` means you don't have to remember the login information -or what port ssh is forwarded to on your box. To learn more about those settings see the section on the [Vagrantfile](/docs/user-guide/vagrantfile.html). - - -## vagrant suspend - -When you're ready to call it quits for the day, there's no need to leave your Vagrant box soaking -up cpu cycles and memory. Simply issue `vagrant suspend` from your project root and VirtualBox will -take a snapshot of the box's current state from which you can resume later. - - -## vagrant resume - -When you're ready to get rolling again its just as easy to start your virtual machine back up with -`vagrant resume`. diff --git a/docs/user-guide/vagrantfile.md b/docs/user-guide/vagrantfile.md index 4bd0f7544..fb6545401 100644 --- a/docs/user-guide/vagrantfile.md +++ b/docs/user-guide/vagrantfile.md @@ -38,4 +38,4 @@ Vagrant::Config.run do |config| end {% endhighlight %} -There are many available configuration options. These are listed below: \ No newline at end of file +There are many available configuration options. These are listed below: