diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-14 13:46:56 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-14 13:46:56 +0000 |
commit | 8e79ad9f544d1c4a0476e0d96aef0496ca7fc741 (patch) | |
tree | cda1743f5820600fd8c638ac7f034f917ac8c381 /man/sbuild-qemu-boot.1.in | |
parent | Initial commit. (diff) | |
download | sbuild-8e79ad9f544d1c4a0476e0d96aef0496ca7fc741.tar.xz sbuild-8e79ad9f544d1c4a0476e0d96aef0496ca7fc741.zip |
Adding upstream version 0.85.6.upstream/0.85.6
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man/sbuild-qemu-boot.1.in')
-rw-r--r-- | man/sbuild-qemu-boot.1.in | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/man/sbuild-qemu-boot.1.in b/man/sbuild-qemu-boot.1.in new file mode 100644 index 0000000..e6e80dd --- /dev/null +++ b/man/sbuild-qemu-boot.1.in @@ -0,0 +1,98 @@ +.\" Copyright © 2020-2022 Christian Kastner <ckk@debian.org> +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +.\" General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see +.\" <http://www.gnu.org/licenses/>. +.so defs.man +.TH SBUILD\-QEMU\-BOOT "1" "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild" +.SH NAME +sbuild\-qemu\-boot \- Boot a VM using a QEMU image +.SH SYNOPSIS +.B sbuild\-qemu\-boot +.RB [ \-h ] +.RB [ \-\-read-write ] +.RB [ \-\-snapshot ] +.RB [ \-\-shared-dir ] +.RB [ \-\-arch=ARCH ] +.RB [ \-\-ram\-size=MiB ] +.RB [ \-\-cpus=CPUs ] +.RB [ \-\-ssh\-port=PORT ] +.RB [ \-\-noexec ] +.RB IMAGE +.SH DESCRIPTION +\fBsbuild\-qemu\-boot\fR boots a QEMU VM using \fBIMAGE\fR into a console. The +image is in read-only mode by default, as the goal is to support +experimentation. +.PP +The architecture is auto-guessed by stripping any file suffix and then +splitting the image name on dashes ``\-'', and finally by looking for a Debian +architecture name. \fIsid\-amd64.img\fR, \fIamd64\-temporary.image\fR or even +just \fIamd64\fR would all be assumed to be amd64 images, but not +\fIamd64.rebuild\-tests.img\fR. If this guesses wrong, use the +\fB\-\-arch\fR option. +.PP +Note that you might need to invoke stty(1) within the VM to match your +host terminal's settings. +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Show this help message and exit. +.TP +\fB\-\-read\-write\fR +Write changes back to the image, instead of using the image in read\-only mode. +.TP +\fB\-\-snapshot\fR +Create a snapshot of the image before changing it. Useful for +reproducibility purposes. Ignored if the image is not booted in read\-write +mode, which is the default. +.TP +\fB\-\-shared\-dir\fR +Share this directory on the host with the guest. This will only work when the +image was created with sbuild-qemu-create(1). +.TP +\fB\-\-arch\fR=ARCH +Architecture to use (instead of attempting to auto\-guess). +.TP +\fB\-\-ram\-size\fR=MiB +VM memory size in MB. Default: 2048 +.TP +\fB\-\-cpus\fR=CPUs +VM CPU count. Default: 2 +.TP +\fB\-\-ssh\-port\fR=PORT +Forward local port PORT to port 22 within the guest. Package +\fBopenssh\-server\fR must be installed within the guest for this to be useful. +.TP +\fB\-\-boot\fR=auto,bios,efi,ieee1275,none +How to boot the image. Default is BIOS on amd64 and i386, EFI on arm64 and +armhf, and IEEE1275 on ppc64el. +.TP +\fB\-\-noexec\fR +Don't actually do anything. Just print the command string that +would be executed, and then exit. +.SH EXAMPLES +\fB$ sbuild\-qemu\-boot \-\-shared\-dir /tmp/foo unstable\-autopkgtest\-amd64.img\fR +.PP +This will update the image \fBunstable\-autopkgtest\-amd64.img\fR in +the current directory. If no such file exists there, then +\fB$IMAGEDIR/unstable\-autopkgtest\-amd64.img\fR is tried. +.SH ENVIRONMENT +If \fB$IMAGEDIR\fR is unset, then \fI~/.cache/sbuild\fR is used. +.SH COPYRIGHT +.nf +Copyright \[co] 2020\-2022 Christian Kastner <ckk@debian.org> +.fi +.SH "SEE ALSO" +.BR sbuild (1), +.BR sbuild\-qemu (1), +.BR sbuild\-qemu\-create (1). |