Merge pull request #15 from borekon/patch-1

added the ubuntu default bash completion folder

LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2015, Roman Dobosz
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the organization nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL ROMAN DOBOSZ BE LIABLE FOR ANY DIRECT, INDIRECT, 
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README

@@ -1,8 +0,0 @@
-VBoxManage bash completion script.
-
-This version of the completion was initially based on Sebastian T. Hafner
-script. However, in some point of time I've decided to rewrite it almost from
-scratch.
-
-Current version of script was written and tested against VBoxManage in version
-4.3.18, and supports all commands (in some extent ;)).

README.rst

@@ -0,0 +1,57 @@
+VBoxManage bash completion script
+=================================
+
+This version of the completion was initially based on Sebastian T. Hafner
+script. However, in some point of time I've decided to rewrite it almost from
+scratch.
+
+Current version of script was written and tested against VBoxManage in version
+7.0.22, and should contain all commands and their options.
+
+Unlike other attempts, I've tried to make the script context aware. See the
+simple session with the VBoxManage command below, to have an idea how it works:
+
+.. image:: /images/vboxmanage_session.gif?raw=true
+   :alt: VBoxManage session
+
+
+Note, that ``startvm`` command proposes only VMs, which are not running, while
+``controlvm`` will complete only running VMs.
+
+What is worth to mention, this completion script is a real thing, so it only
+offer things which have sense for particular commands, for example:
+
+.. image:: /images/vboxmanage_snapshot.gif?raw=true
+   :alt: Take a snapshot
+
+For ``snapshot take`` subcommand, the only options which are proposed are
+``--live`` and ``--description``. Other commands and subcommands are behaving in
+similar way.
+
+
+Installation
+============
+
+Either source the file::
+
+    $ . /path/to/this/repo/VBoxManage
+
+or add it to a proper place depending on your distribution. Usual place would
+be:
+
+* ~/bash-completion.d/
+* /usr/local/etc/bash-completion.d/
+* /etc/bash_completion.d/
+* ~/.local/share/bash-completion
+* etc.
+
+It's also okay to copy it into some directory, and place proper line in
+``.profile`` or ``.bashrc``::
+
+    source /some/directory/VBoxManage
+
+License
+=======
+
+This software is licensed under 3-clause BSD license. See LICENSE file for
+details.