diff --git a/README.rst b/README.rst index a620d53..fccbacf 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,27 @@ 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.28, and supports all commands (in some extent ;)). +4.3.32, and supports all commands (in some extent ;)). + +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 @@ -16,7 +36,7 @@ Either source the file:: $ . /path/to/this/repo/VBoxManage -or add it to a proper place depending on your distribution. Ususal place would +or add it to a proper place depending on your distribution. Usual place would be: * ~/bash-completion.d/ diff --git a/images/vboxmanage_session.gif b/images/vboxmanage_session.gif new file mode 100644 index 0000000..7d7f1ee Binary files /dev/null and b/images/vboxmanage_session.gif differ diff --git a/images/vboxmanage_snapshot.gif b/images/vboxmanage_snapshot.gif new file mode 100644 index 0000000..edd0795 Binary files /dev/null and b/images/vboxmanage_snapshot.gif differ