mirror of
https://github.com/oSoWoSo/DistroHopper.git
synced 2024-08-14 22:46:53 +00:00
New release docs with cogged README (#508)
This commit is contained in:
Phil Clifford
GitHub
parent
39da52a3bf
commit
d0c2bb228a
8 changed files with 698 additions and 520 deletions
302
docs/quickemu.1
302
docs/quickemu.1
|
|
@ -1,6 +1,20 @@
|
|||
.\" Automatically generated by Pandoc 2.9.2.1
|
||||
.\" Automatically generated by Pandoc 2.18
|
||||
.\"
|
||||
.TH "QUICKEMU" "1" "February 20, 2022" "quickemu" "Quickemu User Manual"
|
||||
.\" Define V font for inline verbatim, using C font in formats
|
||||
.\" that render this, and otherwise B font.
|
||||
.ie "\f[CB]x\f[]"x" \{\
|
||||
. ftr V B
|
||||
. ftr VI BI
|
||||
. ftr VB B
|
||||
. ftr VBI BI
|
||||
.\}
|
||||
.el \{\
|
||||
. ftr V CR
|
||||
. ftr VI CI
|
||||
. ftr VB CB
|
||||
. ftr VBI CBI
|
||||
.\}
|
||||
.TH "QUICKEMU" "1" "July 30, 2022" "quickemu" "Quickemu User Manual"
|
||||
.hy
|
||||
.SH NAME
|
||||
.PP
|
||||
|
|
@ -61,8 +75,8 @@ Do not commit any changes to disk/snapshot.
|
|||
Print version
|
||||
.SH EXAMPLES
|
||||
.TP
|
||||
\f[B]quickemu \[en]vm ubuntu-mate-21.10-.conf\f[R]
|
||||
Launches the VM specified in the file \f[I]ubuntu-mate-21.10-.conf\f[R]
|
||||
\f[B]quickemu \[en]vm ubuntu-mate-22.04-.conf\f[R]
|
||||
Launches the VM specified in the file \f[I]ubuntu-mate-22.04-.conf\f[R]
|
||||
.SS Introduction
|
||||
.PP
|
||||
Quickly create and run highly optimised desktop virtual machines for
|
||||
|
|
@ -73,8 +87,8 @@ For example:
|
|||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
quickget ubuntu-mate 21.10
|
||||
quickemu --vm ubuntu-mate-21.10-.conf
|
||||
quickget ubuntu-mate 22.04
|
||||
quickemu --vm ubuntu-mate-22.04-.conf
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
|
|
@ -105,7 +119,7 @@ QEMU Guest Agent support (https://wiki.qemu.org/Features/GuestAgent);
|
|||
provides access to a system-level agent via standard QMP commands
|
||||
.IP \[bu] 2
|
||||
Samba file sharing for Linux, macOS and Windows guests (\f[I]if
|
||||
\f[CI]smbd\f[I] is installed on the host\f[R])
|
||||
\f[VI]smbd\f[I] is installed on the host\f[R])
|
||||
.IP \[bu] 2
|
||||
VirGL acceleration
|
||||
.IP \[bu] 2
|
||||
|
|
@ -181,10 +195,49 @@ xrandr (https://gitlab.freedesktop.org/xorg/app/xrandr)
|
|||
zsync (http://zsync.moria.org.uk/)
|
||||
.IP \[bu] 2
|
||||
unzip (http://www.info-zip.org/UnZip.html)
|
||||
.SS Installing Requirements
|
||||
.PP
|
||||
For Ubuntu, Arch and nixos systems the
|
||||
ppa (https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu),
|
||||
AUR (https://aur.archlinux.org/packages/quickemu) or
|
||||
nix (https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu)
|
||||
packaging will take care of the dependencies.
|
||||
For other host distributions or operating systems it will be necessary
|
||||
to install the above requirements or their equivalents.
|
||||
.PP
|
||||
These examples may save a little typing
|
||||
.PP
|
||||
Debian:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
sudo apt install qemu bash coreutils ovmf grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-client-gtk swtpm wget xdg-user-dirs zsync unzip
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Fedora:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
MacOS:
|
||||
.PP
|
||||
This is a work in progress (see issue
|
||||
248 (https://github.com/quickemu-project/quickemu/issues/248) for other
|
||||
steps and changes that may enable running on MacOS)
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
brew install qemu bash coreutils grep jq python\[at]3.10 cdrtools gnu-sed spice-gtk wget zsync
|
||||
\f[R]
|
||||
.fi
|
||||
.SH Usage
|
||||
.SS Graphical User Interfaces
|
||||
.PP
|
||||
While \f[C]quickemu\f[R] and \f[C]quickget\f[R] are designed for the
|
||||
While \f[V]quickemu\f[R] and \f[V]quickget\f[R] are designed for the
|
||||
terminal, a graphical user interface is also available:
|
||||
.IP \[bu] 2
|
||||
\f[B]Quickgui (https://github.com/quickgui/quickgui)\f[R] by Mark
|
||||
|
|
@ -206,13 +259,13 @@ sudo apt install quickgui
|
|||
.fi
|
||||
.SS Ubuntu Guest
|
||||
.PP
|
||||
\f[C]quickget\f[R] will automatically download an Ubuntu release and
|
||||
\f[V]quickget\f[R] will automatically download an Ubuntu release and
|
||||
create the virtual machine configuration.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
quickget ubuntu 20.04
|
||||
quickemu --vm ubuntu-20.04.conf
|
||||
quickget ubuntu 22.04
|
||||
quickemu --vm ubuntu-22.04.conf
|
||||
\f[R]
|
||||
.fi
|
||||
.IP \[bu] 2
|
||||
|
|
@ -221,24 +274,24 @@ Complete the installation as normal.
|
|||
Post-install:
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Install the SPICE agent (\f[C]spice-vdagent\f[R]) to enable copy/paste
|
||||
Install the SPICE agent (\f[V]spice-vdagent\f[R]) to enable copy/paste
|
||||
and USB redirection
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
\f[C]sudo apt install spice-vdagent\f[R]
|
||||
\f[V]sudo apt install spice-vdagent\f[R]
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
Install the SPICE WebDAV agent (\f[C]spice-webdavd\f[R]) to enable file
|
||||
Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) to enable file
|
||||
sharing.
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
\f[C]sudo apt install spice-webdavd\f[R]
|
||||
\f[V]sudo apt install spice-webdavd\f[R]
|
||||
.RE
|
||||
.RE
|
||||
.SS Ubuntu devel (daily-live) images
|
||||
.PP
|
||||
\f[C]quickget\f[R] can also download/refresh devel images via
|
||||
\f[C]zsync\f[R] for Ubuntu developers and testers.
|
||||
\f[V]quickget\f[R] can also download/refresh devel images via
|
||||
\f[V]zsync\f[R] for Ubuntu developers and testers.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
|
|
@ -247,106 +300,116 @@ quickemu --vm ubuntu-devel.conf
|
|||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
You can run \f[C]quickget ubuntu devel\f[R] to refresh your daily
|
||||
You can run \f[V]quickget ubuntu devel\f[R] to refresh your daily
|
||||
development image as often as you like, it will even automatically
|
||||
switch to a new series.
|
||||
.SS Ubuntu Flavours
|
||||
.PP
|
||||
All the official Ubuntu flavours are supported, just replace
|
||||
\f[C]ubuntu\f[R] with your preferred flavour.
|
||||
\f[V]ubuntu\f[R] with your preferred flavour.
|
||||
.IP \[bu] 2
|
||||
\f[C]kubuntu\f[R] (Kubuntu)
|
||||
\f[V]kubuntu\f[R] (Kubuntu)
|
||||
.IP \[bu] 2
|
||||
\f[C]lubuntu\f[R] (Lubuntu)
|
||||
\f[V]lubuntu\f[R] (Lubuntu)
|
||||
.IP \[bu] 2
|
||||
\f[C]ubuntu-budgie\f[R] (Ubuntu Budgie)
|
||||
\f[V]ubuntu-budgie\f[R] (Ubuntu Budgie)
|
||||
.IP \[bu] 2
|
||||
\f[C]ubuntukylin\f[R] (Ubuntu Kylin)
|
||||
\f[V]ubuntukylin\f[R] (Ubuntu Kylin)
|
||||
.IP \[bu] 2
|
||||
\f[C]ubuntu-mate\f[R] (Ubuntu MATE)
|
||||
\f[V]ubuntu-mate\f[R] (Ubuntu MATE)
|
||||
.IP \[bu] 2
|
||||
\f[C]ubuntustudio\f[R] (Ubuntu Studio)
|
||||
\f[V]ubuntustudio\f[R] (Ubuntu Studio)
|
||||
.IP \[bu] 2
|
||||
\f[C]ubuntu\f[R] (Ubuntu)
|
||||
\f[V]ubuntu\f[R] (Ubuntu)
|
||||
.IP \[bu] 2
|
||||
\f[C]xubuntu\f[R] (Xubuntu)
|
||||
\f[V]xubuntu\f[R] (Xubuntu)
|
||||
.SS Other Operating Systems
|
||||
.PP
|
||||
\f[C]quickget\f[R] also supports:
|
||||
\f[V]quickget\f[R] also supports:
|
||||
.IP \[bu] 2
|
||||
\f[C]alma\f[R] (Alma Linux)
|
||||
\f[V]alma\f[R] (Alma Linux)
|
||||
.IP \[bu] 2
|
||||
\f[C]alpine\f[R] (Alpine Linux)
|
||||
\f[V]alpine\f[R] (Alpine Linux)
|
||||
.IP \[bu] 2
|
||||
\f[C]android\f[R] (Android x86)
|
||||
\f[V]android\f[R] (Android x86)
|
||||
.IP \[bu] 2
|
||||
\f[C]archlinux\f[R] (Arch Linux)
|
||||
\f[V]archlinux\f[R] (Arch Linux)
|
||||
.IP \[bu] 2
|
||||
\f[C]arcolinux\f[R] (Arco Linux)
|
||||
\f[V]arcolinux\f[R] (Arco Linux)
|
||||
.IP \[bu] 2
|
||||
\f[C]cachyos\f[R] (CachyOS)
|
||||
\f[V]batocera\f[R] (Batocera)
|
||||
.IP \[bu] 2
|
||||
\f[C]debian\f[R] (Debian)
|
||||
\f[V]cachyos\f[R] (CachyOS)
|
||||
.IP \[bu] 2
|
||||
\f[C]devuan\f[R] (Devuan)
|
||||
\f[V]centos-stream\f[R] (CentOS Stream)
|
||||
.IP \[bu] 2
|
||||
\f[C]dragonflybsd\f[R] (DragonFlyBSD)
|
||||
\f[V]debian\f[R] (Debian)
|
||||
.IP \[bu] 2
|
||||
\f[C]elementary\f[R] (elementary OS)
|
||||
\f[V]deepin\f[R] (Deepin)
|
||||
.IP \[bu] 2
|
||||
\f[C]fedora\f[R] (Fedora)
|
||||
\f[V]devuan\f[R] (Devuan)
|
||||
.IP \[bu] 2
|
||||
\f[C]freebsd\f[R] (FreeBSD)
|
||||
\f[V]dragonflybsd\f[R] (DragonFlyBSD)
|
||||
.IP \[bu] 2
|
||||
\f[C]freedos\f[R] (FreeDOS)
|
||||
\f[V]elementary\f[R] (elementary OS)
|
||||
.IP \[bu] 2
|
||||
\f[C]garuda\f[R] (Garuda Linux)
|
||||
\f[V]endeavouros\f[R] (EndeavourOS)
|
||||
.IP \[bu] 2
|
||||
\f[C]gentoo\f[R] (Gentoo)
|
||||
\f[V]fedora\f[R] (Fedora)
|
||||
.IP \[bu] 2
|
||||
\f[C]ghostbsd\f[R] (GhostBSD)
|
||||
\f[V]freebsd\f[R] (FreeBSD)
|
||||
.IP \[bu] 2
|
||||
\f[C]haiku\f[R] (Haiku)
|
||||
\f[V]freedos\f[R] (FreeDOS)
|
||||
.IP \[bu] 2
|
||||
\f[C]kali\f[R] (Kali)
|
||||
\f[V]garuda\f[R] (Garuda Linux)
|
||||
.IP \[bu] 2
|
||||
\f[C]kdeneon\f[R] (KDE Neon)
|
||||
\f[V]gentoo\f[R] (Gentoo)
|
||||
.IP \[bu] 2
|
||||
\f[C]kolibrios\f[R] (KolibriOS)
|
||||
\f[V]ghostbsd\f[R] (GhostBSD)
|
||||
.IP \[bu] 2
|
||||
\f[C]linuxmint\f[R] (Linux Mint)
|
||||
\f[V]haiku\f[R] (Haiku)
|
||||
.IP \[bu] 2
|
||||
\f[C]manjaro\f[R] (Manjaro)
|
||||
\f[V]kali\f[R] (Kali)
|
||||
.IP \[bu] 2
|
||||
\f[C]mxlinux\f[R] (MX Linux)
|
||||
\f[V]kdeneon\f[R] (KDE Neon)
|
||||
.IP \[bu] 2
|
||||
\f[C]netboot\f[R] (netboot.xyz)
|
||||
\f[V]kolibrios\f[R] (KolibriOS)
|
||||
.IP \[bu] 2
|
||||
\f[C]netbsd\f[R] (NetBSD)
|
||||
\f[V]linuxmint\f[R] (Linux Mint)
|
||||
.IP \[bu] 2
|
||||
\f[C]nixos\f[R] (NixOS)
|
||||
\f[V]lmde\f[R] (Linux Mint Debian Edition)
|
||||
.IP \[bu] 2
|
||||
\f[C]openbsd\f[R] (OpenBSD)
|
||||
\f[V]manjaro\f[R] (Manjaro)
|
||||
.IP \[bu] 2
|
||||
\f[C]opensuse\f[R] (openSUSE)
|
||||
\f[V]mxlinux\f[R] (MX Linux)
|
||||
.IP \[bu] 2
|
||||
\f[C]oraclelinux\f[R] (Oracle Linux)
|
||||
\f[V]netboot\f[R] (netboot.xyz)
|
||||
.IP \[bu] 2
|
||||
\f[C]popos\f[R] (Pop!_OS)
|
||||
\f[V]netbsd\f[R] (NetBSD)
|
||||
.IP \[bu] 2
|
||||
\f[C]regolith\f[R] (Regolith Linux)
|
||||
\f[V]nixos\f[R] (NixOS)
|
||||
.IP \[bu] 2
|
||||
\f[C]rockylinux\f[R] (Rocky Linux)
|
||||
\f[V]openbsd\f[R] (OpenBSD)
|
||||
.IP \[bu] 2
|
||||
\f[C]slackware\f[R] (Slackware)
|
||||
\f[V]opensuse\f[R] (openSUSE)
|
||||
.IP \[bu] 2
|
||||
\f[C]solus\f[R] (Solus)
|
||||
\f[V]oraclelinux\f[R] (Oracle Linux)
|
||||
.IP \[bu] 2
|
||||
\f[C]tails\f[R] (Tails)
|
||||
\f[V]popos\f[R] (Pop!_OS)
|
||||
.IP \[bu] 2
|
||||
\f[C]void\f[R] (Void Linux)
|
||||
\f[V]regolith\f[R] (Regolith Linux)
|
||||
.IP \[bu] 2
|
||||
\f[C]zorin\f[R] (Zorin OS)
|
||||
\f[V]rockylinux\f[R] (Rocky Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]slackware\f[R] (Slackware)
|
||||
.IP \[bu] 2
|
||||
\f[V]solus\f[R] (Solus)
|
||||
.IP \[bu] 2
|
||||
\f[V]tails\f[R] (Tails)
|
||||
.IP \[bu] 2
|
||||
\f[V]void\f[R] (Void Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]zorin\f[R] (Zorin OS)
|
||||
.PP
|
||||
Or you can download a Linux image and manually create a VM
|
||||
configuration.
|
||||
|
|
@ -354,7 +417,7 @@ configuration.
|
|||
Download a .iso image of a Linux distribution
|
||||
.IP \[bu] 2
|
||||
Create a VM configuration file; for example
|
||||
\f[C]debian-bullseye.conf\f[R]
|
||||
\f[V]debian-bullseye.conf\f[R]
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
|
|
@ -364,7 +427,7 @@ iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq]
|
|||
\f[R]
|
||||
.fi
|
||||
.IP \[bu] 2
|
||||
Use \f[C]quickemu\f[R] to start the virtual machine:
|
||||
Use \f[V]quickemu\f[R] to start the virtual machine:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
|
|
@ -377,15 +440,15 @@ Complete the installation as normal.
|
|||
Post-install:
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Install the SPICE agent (\f[C]spice-vdagent\f[R]) to enable copy/paste
|
||||
Install the SPICE agent (\f[V]spice-vdagent\f[R]) to enable copy/paste
|
||||
and USB redirection.
|
||||
.IP \[bu] 2
|
||||
Install the SPICE WebDAV agent (\f[C]spice-webdavd\f[R]) to enable file
|
||||
Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) to enable file
|
||||
sharing.
|
||||
.RE
|
||||
.SS macOS Guest
|
||||
.PP
|
||||
\f[C]quickget\f[R] automatically downloads a macOS recovery image and
|
||||
\f[V]quickget\f[R] automatically downloads a macOS recovery image and
|
||||
creates a virtual machine configuration.
|
||||
.IP
|
||||
.nf
|
||||
|
|
@ -395,8 +458,8 @@ quickemu --vm macos-catalina.conf
|
|||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
macOS \f[C]high-sierra\f[R], \f[C]mojave\f[R], \f[C]catalina\f[R],
|
||||
\f[C]big-sur\f[R] and \f[C]monterey\f[R] are supported.
|
||||
macOS \f[V]high-sierra\f[R], \f[V]mojave\f[R], \f[V]catalina\f[R],
|
||||
\f[V]big-sur\f[R] and \f[V]monterey\f[R] are supported.
|
||||
.IP \[bu] 2
|
||||
Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
|
||||
.IP \[bu] 2
|
||||
|
|
@ -409,19 +472,19 @@ Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
|
|||
On macOS Catalina, Big Sur & Monterey
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Select \f[C]Apple Inc. VirtIO Block Media\f[R] from the list and click
|
||||
Select \f[V]Apple Inc. VirtIO Block Media\f[R] from the list and click
|
||||
\f[B]Erase\f[R].
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
On macOS Mojave and High Sierra
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Select \f[C]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list and
|
||||
Select \f[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list and
|
||||
click \f[B]Erase\f[R].
|
||||
.RE
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
Enter a \f[C]Name:\f[R] for the disk and click \f[B]Erase\f[R].
|
||||
Enter a \f[V]Name:\f[R] for the disk and click \f[B]Erase\f[R].
|
||||
.IP \[bu] 2
|
||||
Click \f[B]Done\f[R].
|
||||
.IP \[bu] 2
|
||||
|
|
@ -455,10 +518,10 @@ macos_release=\[dq]catalina\[dq]
|
|||
\f[R]
|
||||
.fi
|
||||
.IP \[bu] 2
|
||||
\f[C]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
||||
\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
||||
macOS.
|
||||
.IP \[bu] 2
|
||||
\f[C]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
|
||||
\f[V]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
|
||||
optimise for a particular macOS release.
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
|
|
@ -486,7 +549,7 @@ Big Sur
|
|||
Monterey
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
\f[C]quickemu\f[R] will automatically download the required
|
||||
\f[V]quickemu\f[R] will automatically download the required
|
||||
OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and
|
||||
OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM).
|
||||
.IP \[bu] 2
|
||||
|
|
@ -499,11 +562,11 @@ VirtIO Block
|
|||
Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used
|
||||
for the system disk where supported.
|
||||
.IP \[bu] 2
|
||||
VirtIO \f[C]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for
|
||||
VirtIO \f[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for
|
||||
the mouse.
|
||||
.IP \[bu] 2
|
||||
VirtIO Network (\f[C]virtio-net\f[R]) is supported and enabled on macOS
|
||||
Big Sur and newer but previous releases use \f[C]vmxnet3\f[R].
|
||||
VirtIO Network (\f[V]virtio-net\f[R]) is supported and enabled on macOS
|
||||
Big Sur and newer but previous releases use \f[V]vmxnet3\f[R].
|
||||
.IP \[bu] 2
|
||||
VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
|
||||
newer but disabled for other support macOS releases.
|
||||
|
|
@ -532,7 +595,7 @@ webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
|
|||
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
|
||||
.SS Windows 8.1, 10 & 11 Guests
|
||||
.PP
|
||||
\f[C]quickget\f[R] can automatically download Windows 8.1, Windows
|
||||
\f[V]quickget\f[R] can automatically download Windows 8.1, Windows
|
||||
10 (https://www.microsoft.com/en-gb/software-download/windows10ISO) and
|
||||
Windows 11 (https://www.microsoft.com/en-gb/software-download/windows11)
|
||||
along with the VirtIO drivers for
|
||||
|
|
@ -551,7 +614,7 @@ Complete the installation as you normally would.
|
|||
All relevant drivers and services should be installed automatically.
|
||||
.SS Regional versions
|
||||
.PP
|
||||
By default \f[C]quickget\f[R] will download the \f[I]\[lq]English
|
||||
By default \f[V]quickget\f[R] will download the \f[I]\[lq]English
|
||||
International\[rq]\f[R] release, but you can optionally specify one of
|
||||
the supported languages: For example:
|
||||
.IP
|
||||
|
|
@ -570,74 +633,89 @@ disk_img=\[dq]windows-11/disk.qcow2\[dq]
|
|||
iso=\[dq]windows-11/Win11_EnglishInternational_x64.iso\[dq]
|
||||
fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
|
||||
tpm=\[dq]on\[dq]
|
||||
secureboot=\[dq]on\[dq]
|
||||
\f[R]
|
||||
.fi
|
||||
.IP \[bu] 2
|
||||
\f[C]guest_os=\[dq]windows\[dq]\f[R] instructs \f[C]quickemu\f[R] to
|
||||
\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to
|
||||
optimise for Windows.
|
||||
.IP \[bu] 2
|
||||
\f[C]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
|
||||
\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
|
||||
drivers.
|
||||
.IP \[bu] 2
|
||||
\f[C]tpm=\[dq]on\[dq]\f[R] instructs \f[C]quickemu\f[R] to create a
|
||||
software emulated TPM device using \f[C]swtpm\f[R].
|
||||
\f[V]tpm=\[dq]on\[dq]\f[R] instructs \f[V]quickemu\f[R] to create a
|
||||
software emulated TPM device using \f[V]swtpm\f[R].
|
||||
.SH All the options
|
||||
.PP
|
||||
Here are the usage instructions:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
|
||||
Usage
|
||||
quickemu --vm ubuntu.conf
|
||||
|
||||
You can also pass optional parameters
|
||||
--braille : Enable braille support. Requires SDL.
|
||||
--delete-disk : Delete the disk image and EFI variables
|
||||
--delete-vm : Delete the entire VM and it\[aq]s configuration
|
||||
--display : Select display backend. \[aq]sdl\[aq] (default), \[aq]gtk\[aq], \[aq]none\[aq], or \[aq]spice\[aq]
|
||||
--fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
|
||||
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
|
||||
--screen <screen> : Use specified screen to determine the window size.
|
||||
--shortcut : Create a desktop shortcut
|
||||
--snapshot apply <tag> : Apply/restore a snapshot.
|
||||
--snapshot create <tag> : Create a snapshot.
|
||||
--snapshot delete <tag> : Delete a snapshot.
|
||||
--snapshot info : Show disk/snapshot info.
|
||||
--status-quo : Do not commit any changes to disk/snapshot.
|
||||
--version : Print version
|
||||
|
||||
--braille : Enable braille support. Requires SDL.
|
||||
--delete-disk : Delete the disk image and EFI variables
|
||||
--delete-vm : Delete the entire VM and it\[aq]s configuration
|
||||
--display : Select display backend. \[aq]sdl\[aq] (default), \[aq]gtk\[aq], \[aq]none\[aq], or \[aq]spice\[aq]
|
||||
--fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
|
||||
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
|
||||
--screen <screen> : Use specified screen to determine the window size.
|
||||
--shortcut : Create a desktop shortcut
|
||||
--snapshot apply <tag> : Apply/restore a snapshot.
|
||||
--snapshot create <tag> : Create a snapshot.
|
||||
--snapshot delete <tag> : Delete a snapshot.
|
||||
--snapshot info : Show disk/snapshot info.
|
||||
--status-quo : Do not commit any changes to disk/snapshot.
|
||||
--viewer <viewer> : Choose an alternative viewer. \[at]Options: \[aq]spicy\[aq] (default), \[aq]remote-viewer\[aq], \[aq]none\[aq]
|
||||
--ssh-port <port> : Set ssh-port manually
|
||||
--spice-port <port> : Set spice-port manually
|
||||
--public-dir <path> : expose share directory. \[at]Options: \[aq]\[aq] (default: xdg-user-dir PUBLICSHARE), \[aq]<directory>\[aq], \[aq]none\[aq]
|
||||
--monitor <type> : Set monitor connection type. \[at]Options: \[aq]socket\[aq] (default), \[aq]telnet\[aq], \[aq]none\[aq]
|
||||
--monitor-telnet-host <ip/host> : Set telnet host for monitor. (default: \[aq]localhost\[aq])
|
||||
--monitor-telnet-port <port> : Set telnet port for monitor. (default: \[aq]4440\[aq])
|
||||
--monitor-cmd <cmd> : Send command to monitor if available. (Example: system_powerdown)
|
||||
--serial <type> : Set serial connection type. \[at]Options: \[aq]socket\[aq] (default), \[aq]telnet\[aq], \[aq]none\[aq]
|
||||
--serial-telnet-host <ip/host> : Set telnet host for serial. (default: \[aq]localhost\[aq])
|
||||
--serial-telnet-port <port> : Set telnet port for serial. (default: \[aq]6660\[aq])
|
||||
--keyboard <type> : Set keyboard. \[at]Options: \[aq]usb\[aq] (default), \[aq]ps2\[aq], \[aq]virtio\[aq]
|
||||
--keyboard_layout <layout> : Set keyboard layout.
|
||||
--mouse <type> : Set mouse. \[at]Options: \[aq]tablet\[aq] (default), \[aq]ps2\[aq], \[aq]usb\[aq], \[aq]virtio\[aq]
|
||||
--usb-controller <type> : Set usb-controller. \[at]Options: \[aq]ehci\[aq] (default), \[aq]xhci\[aq], \[aq]none\[aq]
|
||||
--extra_args <arguments> : Pass additional arguments to qemu
|
||||
--version : Print version
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Desktop shortcuts
|
||||
.PP
|
||||
Desktop shortcuts can be created for a VM, the shortcuts are saved in
|
||||
\f[C]\[ti]/.local/share/applications\f[R].
|
||||
\f[V]\[ti]/.local/share/applications\f[R].
|
||||
Here is an example of how to create a shortcut.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
quickemu --vm ubuntu-20.04-desktop.conf --shortcut
|
||||
quickemu --vm ubuntu-22.04-desktop.conf --shortcut
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Screen and window size (Linux guests only)
|
||||
.PP
|
||||
\f[C]qemu\f[R] will always default to the primary monitor to display the
|
||||
\f[V]qemu\f[R] will always default to the primary monitor to display the
|
||||
VM\[cq]s window.
|
||||
.PP
|
||||
Without the \f[C]--screen\f[R] option, \f[C]quickemu\f[R] will look for
|
||||
Without the \f[V]--screen\f[R] option, \f[V]quickemu\f[R] will look for
|
||||
the size of the smallest monitor, and use a size that fits on said
|
||||
monitor.
|
||||
.PP
|
||||
The \f[C]--screen\f[R] option forces \f[C]quickemu\f[R] to use the size
|
||||
The \f[V]--screen\f[R] option forces \f[V]quickemu\f[R] to use the size
|
||||
of the given monitor to compute the size of the window.
|
||||
\f[B]It won\[cq]t use that monitor to display the VM\[cq]s window if
|
||||
it\[cq]s not the primary monitor\f[R].
|
||||
This is useful if the primary monitor if not the smallest one, and if
|
||||
the VM\[cq]s window doesn\[cq]t need to be moved around.
|
||||
.PP
|
||||
The \f[C]--screen\f[R] option is also useful with the
|
||||
\f[C]--fullscreen\f[R] option, again because \f[C]qemu\f[R] will always
|
||||
The \f[V]--screen\f[R] option is also useful with the
|
||||
\f[V]--fullscreen\f[R] option, again because \f[V]qemu\f[R] will always
|
||||
use the primary monitor.
|
||||
In order for the fullscreen mode to work properly, the resolution of the
|
||||
VM\[cq]s window must match the resolution of the screen.
|
||||
|
|
@ -659,7 +737,7 @@ The command will output something like this:
|
|||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
The first number is what needs to be passed to the \f[C]--screen\f[R]
|
||||
The first number is what needs to be passed to the \f[V]--screen\f[R]
|
||||
option.
|
||||
.PP
|
||||
For example:
|
||||
|
|
@ -672,7 +750,7 @@ quickemu --vm vm.conf --screen 0
|
|||
.PP
|
||||
The above uses the 2560x1440 screen to compute the size of the window,
|
||||
which Quickemu sizes to 2048x1152.
|
||||
Without the \f[C]--screen\f[R] option, Quickemu would have used the
|
||||
Without the \f[V]--screen\f[R] option, Quickemu would have used the
|
||||
1920x1080 monitor which results in a window size of 1664x936.
|
||||
.SH References
|
||||
.PP
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue