Merge branch 'josch' into 'main'

debvm-run: add an example (I always forget about the -snapshot option)

See merge request helmutg/debvm!17

1 files changed, 9 insertions, 0 deletions

diff --git a/debvm-run b/debvm-run
index 9b64ef4..eda3477 100755
--- a/debvm-run
+++ b/debvm-run
@@ -49,6 +49,15 @@ One possible use of this method is passing B<-snapshot> to avoid modifying the v
 
 =back
 
+=head1 EXAMPLES
+
+Run a virtual machine stored in the image B<rootfs.ext4> (the default) with
+local port 8022 routed to port 22 of the virtual machine. The B<-snapshot>
+argument is passed to QEMU and prevents any permanent changes to
+B<rootfs.ext4>, resulting in an ephemeral run.
+
+    debvm-run -s 8022 -i rootfs.ext4 -- -snapshot
+
 =head1 LIMITATIONS
 
 Due to the way kernel and bootloader are being extracted before running B<qemu>, one cannot upgrade a kernel and then just reboot.