summaryrefslogtreecommitdiff
path: root/debvm-run
diff options
context:
space:
mode:
authorHelmut Grohne <helmut@subdivi.de>2023-01-07 21:38:35 +0100
committerHelmut Grohne <helmut@subdivi.de>2023-01-07 21:38:35 +0100
commitfcc6be9ec9d98321c7c987d9d8277c149f2bc1f4 (patch)
tree1fcb607de2b24c6a000264d544dc2a93aec8e58c /debvm-run
parentbf7817528fd66da299f85c26732cfde33824f7c7 (diff)
downloaddebvm-fcc6be9ec9d98321c7c987d9d8277c149f2bc1f4.tar.gz
use more perlpod formatting codes
Diffstat (limited to 'debvm-run')
-rwxr-xr-xdebvm-run14
1 files changed, 7 insertions, 7 deletions
diff --git a/debvm-run b/debvm-run
index eda3477..c2a3f21 100755
--- a/debvm-run
+++ b/debvm-run
@@ -9,14 +9,14 @@ debvm-run - Run a VM image created by debvm-create
=head1 SYNOPSIS
-B<debvm-run> [B<-g>] [B<-i> I<image>] [B<-s> I<sshport>] [B<--> I<qemu options>]
+B<debvm-run> [B<-g>] [B<-i> F<image>] [B<-s> I<sshport>] [B<--> I<qemu options>]
=head1 DESCRIPTION
B<debvm-run> is essentially a thin wrapper around B<qemu> for running a virtual machine image created by B<debvm-create> or something compatible.
The virtual machine image is expected to be a raw ext4 image with file system label B<debvm>.
-The architecture of the machine is detected from the contained B</bin/true>.
-It must contain a symbolic link pointing to a kernel image at B</vmlinuz> or B</vmlinux> depending on the architecture and a symbolic link pointing to an initrd image at B</initrd.img>.
+The architecture of the machine is detected from the contained F</bin/true>.
+It must contain a symbolic link pointing to a kernel image at F</vmlinuz> or F</vmlinux> depending on the architecture and a symbolic link pointing to an initrd image at F</initrd.img>.
Both are extracted and passed to B<qemu>.
A net interface configured for user mode is added automatically.
@@ -29,10 +29,10 @@ A net interface configured for user mode is added automatically.
By default, the option B<-nographic> is passed to B<qemu> and one interacts with the serial console of the machine.
This configuration is skipped in the presence of this option.
-=item B<-i> I<image>, B<--image>=I<image>
+=item B<-i> F<image>, B<--image>=F<image>
This option specifies the location of the virtual machine image file.
-By default B<rootfs.ext4> in the working directory is used.
+By default F<rootfs.ext4> in the working directory is used.
=item B<-s> I<sshport>, B<--sshport>=I<sshport>
@@ -51,10 +51,10 @@ One possible use of this method is passing B<-snapshot> to avoid modifying the v
=head1 EXAMPLES
-Run a virtual machine stored in the image B<rootfs.ext4> (the default) with
+Run a virtual machine stored in the image F<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.
+F<rootfs.ext4>, resulting in an ephemeral run.
debvm-run -s 8022 -i rootfs.ext4 -- -snapshot