aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2011-01-25 17:16:27 +0100
committerAndreas Schneider <asn@cryptomilk.org>2011-01-25 17:16:27 +0100
commitadf8730ec57b8b6bc7bd846a2ef07130827743e0 (patch)
tree80bd64e1062551d12a2d13437f64fe1446c414c7
parentb2cf8360ccc208d492dd93506e9ff96da47eb161 (diff)
downloadvmexec-adf8730ec57b8b6bc7bd846a2ef07130827743e0.tar.gz
vmexec-adf8730ec57b8b6bc7bd846a2ef07130827743e0.tar.xz
vmexec-adf8730ec57b8b6bc7bd846a2ef07130827743e0.zip
Added README
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1c6c738
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+vmexec
+======
+
+vmexec boots a given virtual machine image and wait until it comes up. Then it
+runs a list of given commands one after the other on the guest, aborting on
+receiving an error. When all commands are run (or one of them failed), the
+virtual machine is shut down and stopped.
+
+Commands are by default run inside the virtual machine using ssh(1) on UNIX and
+telnet(1) on Windows. By prefixing a command with an equals sign '=', it will
+instead be run on the host system (for example to copy files into or out of the
+virtual machine using scp(1)).
+
+Some care is taken to ensure that the virtual machine is shutdown gracefully
+and not left running even in case the controlling tty is closed or the parent
+process killed. If a previous virtual machine is already running on a
+conflicting port, an attempt is made to shut it down first. For this purpose, a
+PID file is created in $HOME/.vmexec/