mirror of
https://github.com/oSoWoSo/DistroHopper.git
synced 2024-08-14 22:46:53 +00:00
Docs: regenerated for recent PR merges
This commit is contained in:
Phil Clifford
Martin Wimpress
parent
4906752519
commit
218e87990f
8 changed files with 407 additions and 549 deletions
432
docs/quickemu.1
432
docs/quickemu.1
|
|
@ -1,29 +1,11 @@
|
|||
.\" Automatically generated by Pandoc 3.1.1
|
||||
.\" Automatically generated by Pandoc 3.1.8
|
||||
.\"
|
||||
.\" 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" "June 27, 2023" "quickemu" "Quickemu User Manual"
|
||||
.hy
|
||||
.TH "QUICKEMU" "1" "October 17, 2023" "quickemu" "Quickemu User Manual"
|
||||
.SH NAME
|
||||
.PP
|
||||
quickemu - A quick VM builder and manager
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[B]quickemu\f[R] [\f[I]OPTION\f[R]]\&...
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
\f[B]quickemu\f[R] will create and run highly optimised desktop virtual
|
||||
machines for Linux, macOS and Windows
|
||||
.SH OPTIONS
|
||||
|
|
@ -37,12 +19,17 @@ You can also pass optional parameters
|
|||
Enable braille support.
|
||||
Requires SDL.
|
||||
.TP
|
||||
\f[B]\[en]delete\f[R]
|
||||
\f[B]\[en]delete-disk\f[R]
|
||||
Delete the disk image.
|
||||
.TP
|
||||
\f[B]\[en]display\f[R]
|
||||
Select display backend.
|
||||
`sdl' (default), `gtk', `none' or `spice'
|
||||
`sdl' (default), `gtk', `none', `spice' or `spice-app'
|
||||
.TP
|
||||
\f[B]\[en]sound-card\f[R]
|
||||
Select virtual audio emulation.
|
||||
`intel-hda' (default), `ac97' (solaris default), `es1370', `sb16'
|
||||
(freedos default) or `none'
|
||||
.TP
|
||||
\f[B]\[en]fullscreen\f[R]
|
||||
Starts VM in full screen mode (Ctl+Alt+f to exit)
|
||||
|
|
@ -78,19 +65,16 @@ Print version
|
|||
\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
|
||||
Linux, macOS and Windows; with just two commands.
|
||||
You decide what operating system you want to run and Quickemu will
|
||||
figure out the best way to do it for you.
|
||||
For example:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
quickget ubuntu-mate 22.04
|
||||
quickemu --vm ubuntu-mate-22.04.conf
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
The original objective of the project was to enable quick testing of
|
||||
Linux distributions where the virtual machine configurations can be
|
||||
|
|
@ -119,7 +103,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[VI]smbd\f[I] is installed on the host\f[R])
|
||||
\f[CI]smbd\f[I] is installed on the host\f[R])
|
||||
.IP \[bu] 2
|
||||
VirGL acceleration
|
||||
.IP \[bu] 2
|
||||
|
|
@ -198,7 +182,6 @@ 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
|
||||
|
|
@ -211,19 +194,15 @@ These examples may save a little typing
|
|||
.PP
|
||||
Debian (and direct derivatives such as MX Linux):
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed spice-client-gtk libtss2-tcti-swtpm0 wget xdg-user-dirs zsync unzip
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
Fedora:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
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
|
||||
.EE
|
||||
.PP
|
||||
MacOS:
|
||||
.PP
|
||||
|
|
@ -231,15 +210,12 @@ 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]
|
||||
.EX
|
||||
brew install qemu bash coreutils grep jq python\[at]3.10 cdrtools gnu-sed spice-gtk wget zsync
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.SH Usage
|
||||
.SS Graphical User Interfaces
|
||||
.PP
|
||||
While \f[V]quickemu\f[R] and \f[V]quickget\f[R] are designed for the
|
||||
While \f[CR]quickemu\f[R] and \f[CR]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
|
||||
|
|
@ -251,196 +227,194 @@ Philipp Kiemle (https://github.com/daPhipz) for creating the
|
|||
\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R] 🎨
|
||||
.SS Quickgui for Ubuntu
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
sudo add-apt-repository ppa:yannick-mauray/quickgui
|
||||
sudo apt update
|
||||
sudo apt install quickgui
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.SS Ubuntu Guest
|
||||
.PP
|
||||
\f[V]quickget\f[R] will automatically download an Ubuntu release and
|
||||
\f[CR]quickget\f[R] will automatically download an Ubuntu release and
|
||||
create the virtual machine configuration.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
quickget ubuntu 22.04
|
||||
quickemu --vm ubuntu-22.04.conf
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.IP \[bu] 2
|
||||
Complete the installation as normal.
|
||||
.IP \[bu] 2
|
||||
Post-install:
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable
|
||||
copy/paste and USB redirection
|
||||
Install the SPICE agent (\f[CR]spice-vdagent\f[R]) in the guest to
|
||||
enable copy/paste and USB redirection
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
\f[V]sudo apt install spice-vdagent\f[R]
|
||||
\f[CR]sudo apt install spice-vdagent\f[R]
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to
|
||||
enable file sharing.
|
||||
Install the SPICE WebDAV agent (\f[CR]spice-webdavd\f[R]) in the guest
|
||||
to enable file sharing.
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
\f[V]sudo apt install spice-webdavd\f[R]
|
||||
\f[CR]sudo apt install spice-webdavd\f[R]
|
||||
.RE
|
||||
.RE
|
||||
.SS Ubuntu devel (daily-live) images
|
||||
.PP
|
||||
\f[V]quickget\f[R] can also download/refresh devel images via
|
||||
\f[V]zsync\f[R] for Ubuntu developers and testers.
|
||||
\f[CR]quickget\f[R] can also download/refresh devel images via
|
||||
\f[CR]zsync\f[R] for Ubuntu developers and testers.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
quickget ubuntu devel
|
||||
quickemu --vm ubuntu-devel.conf
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
You can run \f[V]quickget ubuntu devel\f[R] to refresh your daily
|
||||
You can run \f[CR]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[V]ubuntu\f[R] with your preferred flavour.
|
||||
\f[CR]ubuntu\f[R] with your preferred flavour.
|
||||
.IP \[bu] 2
|
||||
\f[V]kubuntu\f[R] (Kubuntu)
|
||||
\f[CR]kubuntu\f[R] (Kubuntu)
|
||||
.IP \[bu] 2
|
||||
\f[V]lubuntu\f[R] (Lubuntu)
|
||||
\f[CR]lubuntu\f[R] (Lubuntu)
|
||||
.IP \[bu] 2
|
||||
\f[V]ubuntu-budgie\f[R] (Ubuntu Budgie)
|
||||
\f[CR]ubuntu-budgie\f[R] (Ubuntu Budgie)
|
||||
.IP \[bu] 2
|
||||
\f[V]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
|
||||
\f[CR]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
|
||||
.IP \[bu] 2
|
||||
\f[V]ubuntukylin\f[R] (Ubuntu Kylin)
|
||||
\f[CR]ubuntukylin\f[R] (Ubuntu Kylin)
|
||||
.IP \[bu] 2
|
||||
\f[V]ubuntu-mate\f[R] (Ubuntu MATE)
|
||||
\f[CR]ubuntu-mate\f[R] (Ubuntu MATE)
|
||||
.IP \[bu] 2
|
||||
\f[V]ubuntu-server\f[R] (Ubuntu Server)
|
||||
\f[CR]ubuntu-server\f[R] (Ubuntu Server)
|
||||
.IP \[bu] 2
|
||||
\f[V]ubuntustudio\f[R] (Ubuntu Studio)
|
||||
\f[CR]ubuntustudio\f[R] (Ubuntu Studio)
|
||||
.IP \[bu] 2
|
||||
\f[V]ubuntu\f[R] (Ubuntu)
|
||||
\f[CR]ubuntu\f[R] (Ubuntu)
|
||||
.IP \[bu] 2
|
||||
\f[V]ubuntu-unity\f[R] (Ubuntu Unity)
|
||||
\f[CR]ubuntu-unity\f[R] (Ubuntu Unity)
|
||||
.IP \[bu] 2
|
||||
\f[V]xubuntu\f[R] (Xubuntu)
|
||||
\f[CR]xubuntu\f[R] (Xubuntu)
|
||||
.SS Other Operating Systems
|
||||
.PP
|
||||
\f[V]quickget\f[R] also supports:
|
||||
\f[CR]quickget\f[R] also supports:
|
||||
.IP \[bu] 2
|
||||
\f[V]alma\f[R] (Alma Linux)
|
||||
\f[CR]alma\f[R] (Alma Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]alpine\f[R] (Alpine Linux)
|
||||
\f[CR]alpine\f[R] (Alpine Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]android\f[R] (Android x86)
|
||||
\f[CR]android\f[R] (Android x86)
|
||||
.IP \[bu] 2
|
||||
\f[V]archcraft\f[R] (Archcraft)
|
||||
\f[CR]archcraft\f[R] (Archcraft)
|
||||
.IP \[bu] 2
|
||||
\f[V]archlinux\f[R] (Arch Linux)
|
||||
\f[CR]archlinux\f[R] (Arch Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]arcolinux\f[R] (Arco Linux)
|
||||
\f[CR]arcolinux\f[R] (Arco Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]batocera\f[R] (Batocera)
|
||||
\f[CR]batocera\f[R] (Batocera)
|
||||
.IP \[bu] 2
|
||||
\f[V]blendos\f[R] (BlendOS)
|
||||
\f[CR]blendos\f[R] (BlendOS)
|
||||
.IP \[bu] 2
|
||||
\f[V]cachyos\f[R] (CachyOS)
|
||||
\f[CR]bunsenlabs\f[R] (Bunsenlabs)
|
||||
.IP \[bu] 2
|
||||
\f[V]centos-stream\f[R] (CentOS Stream)
|
||||
\f[CR]cachyos\f[R] (CachyOS)
|
||||
.IP \[bu] 2
|
||||
\f[V]debian\f[R] (Debian)
|
||||
\f[CR]centos-stream\f[R] (CentOS Stream)
|
||||
.IP \[bu] 2
|
||||
\f[V]deepin\f[R] (Deepin)
|
||||
\f[CR]debian\f[R] (Debian)
|
||||
.IP \[bu] 2
|
||||
\f[V]devuan\f[R] (Devuan)
|
||||
\f[CR]deepin\f[R] (Deepin)
|
||||
.IP \[bu] 2
|
||||
\f[V]dragonflybsd\f[R] (DragonFlyBSD)
|
||||
\f[CR]devuan\f[R] (Devuan)
|
||||
.IP \[bu] 2
|
||||
\f[V]elementary\f[R] (elementary OS)
|
||||
\f[CR]dragonflybsd\f[R] (DragonFlyBSD)
|
||||
.IP \[bu] 2
|
||||
\f[V]endeavouros\f[R] (EndeavourOS)
|
||||
\f[CR]elementary\f[R] (elementary OS)
|
||||
.IP \[bu] 2
|
||||
\f[V]endless\f[R] (Endless OS)
|
||||
\f[CR]endeavouros\f[R] (EndeavourOS)
|
||||
.IP \[bu] 2
|
||||
\f[V]fedora\f[R] (Fedora)
|
||||
\f[CR]endless\f[R] (Endless OS)
|
||||
.IP \[bu] 2
|
||||
\f[V]freebsd\f[R] (FreeBSD)
|
||||
\f[CR]fedora\f[R] (Fedora)
|
||||
.IP \[bu] 2
|
||||
\f[V]freedos\f[R] (FreeDOS)
|
||||
\f[CR]freebsd\f[R] (FreeBSD)
|
||||
.IP \[bu] 2
|
||||
\f[V]gentoo\f[R] (Gentoo)
|
||||
\f[CR]freedos\f[R] (FreeDOS)
|
||||
.IP \[bu] 2
|
||||
\f[V]ghostbsd\f[R] (GhostBSD)
|
||||
\f[CR]garuda\f[R] (Garuda Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]haiku\f[R] (Haiku)
|
||||
\f[CR]gentoo\f[R] (Gentoo)
|
||||
.IP \[bu] 2
|
||||
\f[V]holoiso\f[R] (HoloISO)
|
||||
\f[CR]ghostbsd\f[R] (GhostBSD)
|
||||
.IP \[bu] 2
|
||||
\f[V]kali\f[R] (Kali)
|
||||
\f[CR]haiku\f[R] (Haiku)
|
||||
.IP \[bu] 2
|
||||
\f[V]kdeneon\f[R] (KDE Neon)
|
||||
\f[CR]holoiso\f[R] (HoloISO)
|
||||
.IP \[bu] 2
|
||||
\f[V]kolibrios\f[R] (KolibriOS)
|
||||
\f[CR]kali\f[R] (Kali)
|
||||
.IP \[bu] 2
|
||||
\f[V]linuxmint\f[R] (Linux Mint)
|
||||
\f[CR]kdeneon\f[R] (KDE Neon)
|
||||
.IP \[bu] 2
|
||||
\f[V]lmde\f[R] (Linux Mint Debian Edition)
|
||||
\f[CR]kolibrios\f[R] (KolibriOS)
|
||||
.IP \[bu] 2
|
||||
\f[V]mageia\f[R] (Mageia)
|
||||
\f[CR]linuxmint\f[R] (Linux Mint)
|
||||
.IP \[bu] 2
|
||||
\f[V]manjaro\f[R] (Manjaro)
|
||||
\f[CR]lmde\f[R] (Linux Mint Debian Edition)
|
||||
.IP \[bu] 2
|
||||
\f[V]mxlinux\f[R] (MX Linux)
|
||||
\f[CR]mageia\f[R] (Mageia)
|
||||
.IP \[bu] 2
|
||||
\f[V]netboot\f[R] (netboot.xyz)
|
||||
\f[CR]manjaro\f[R] (Manjaro)
|
||||
.IP \[bu] 2
|
||||
\f[V]netbsd\f[R] (NetBSD)
|
||||
\f[CR]mxlinux\f[R] (MX Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]nixos\f[R] (NixOS)
|
||||
\f[CR]netboot\f[R] (netboot.xyz)
|
||||
.IP \[bu] 2
|
||||
\f[V]openbsd\f[R] (OpenBSD)
|
||||
\f[CR]netbsd\f[R] (NetBSD)
|
||||
.IP \[bu] 2
|
||||
\f[V]openindiana\f[R] (OpenIndiana)
|
||||
\f[CR]nixos\f[R] (NixOS)
|
||||
.IP \[bu] 2
|
||||
\f[V]opensuse\f[R] (openSUSE)
|
||||
\f[CR]openbsd\f[R] (OpenBSD)
|
||||
.IP \[bu] 2
|
||||
\f[V]oraclelinux\f[R] (Oracle Linux)
|
||||
\f[CR]openindiana\f[R] (OpenIndiana)
|
||||
.IP \[bu] 2
|
||||
\f[V]popos\f[R] (Pop!_OS)
|
||||
\f[CR]opensuse\f[R] (openSUSE)
|
||||
.IP \[bu] 2
|
||||
\f[V]reactos\f[R] (ReactOS)
|
||||
\f[CR]oraclelinux\f[R] (Oracle Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]rebornos\f[R] (RebornOS)
|
||||
\f[CR]peppermint\f[R] (PeppermintOS)
|
||||
.IP \[bu] 2
|
||||
\f[V]rockylinux\f[R] (Rocky Linux)
|
||||
\f[CR]popos\f[R] (Pop!_OS)
|
||||
.IP \[bu] 2
|
||||
\f[V]siduction\f[R] (Siduction)
|
||||
\f[CR]reactos\f[R] (ReactOS)
|
||||
.IP \[bu] 2
|
||||
\f[V]slackware\f[R] (Slackware)
|
||||
\f[CR]rebornos\f[R] (RebornOS)
|
||||
.IP \[bu] 2
|
||||
\f[V]solus\f[R] (Solus)
|
||||
\f[CR]rockylinux\f[R] (Rocky Linux)
|
||||
.IP \[bu] 2
|
||||
\f[V]tails\f[R] (Tails)
|
||||
\f[CR]siduction\f[R] (Siduction)
|
||||
.IP \[bu] 2
|
||||
\f[V]truenas-core\f[R] (TrueNAS Core)
|
||||
\f[CR]slackware\f[R] (Slackware)
|
||||
.IP \[bu] 2
|
||||
\f[V]truenas-scale\f[R] (TrueNAS Scale)
|
||||
\f[CR]solus\f[R] (Solus)
|
||||
.IP \[bu] 2
|
||||
\f[V]vanillaos\f[R] (Vanilla OS)
|
||||
\f[CR]tails\f[R] (Tails)
|
||||
.IP \[bu] 2
|
||||
\f[V]void\f[R] (Void Linux)
|
||||
\f[CR]trisquel\f[R] (Trisquel)
|
||||
.IP \[bu] 2
|
||||
\f[V]vxlinux\f[R] (VX Linux)
|
||||
\f[CR]truenas-core\f[R] (TrueNAS Core)
|
||||
.IP \[bu] 2
|
||||
\f[V]xerolinux\f[R] (XeroLinux)
|
||||
\f[CR]truenas-scale\f[R] (TrueNAS Scale)
|
||||
.IP \[bu] 2
|
||||
\f[V]zorin\f[R] (Zorin OS)
|
||||
\f[CR]vanillaos\f[R] (Vanilla OS)
|
||||
.IP \[bu] 2
|
||||
\f[CR]void\f[R] (Void Linux)
|
||||
.IP \[bu] 2
|
||||
\f[CR]vxlinux\f[R] (VX Linux)
|
||||
.IP \[bu] 2
|
||||
\f[CR]xerolinux\f[R] (XeroLinux)
|
||||
.IP \[bu] 2
|
||||
\f[CR]zorin\f[R] (Zorin OS)
|
||||
.PP
|
||||
Or you can download a Linux image and manually create a VM
|
||||
configuration.
|
||||
|
|
@ -448,49 +422,42 @@ configuration.
|
|||
Download a .iso image of a Linux distribution
|
||||
.IP \[bu] 2
|
||||
Create a VM configuration file; for example
|
||||
\f[V]debian-bullseye.conf\f[R]
|
||||
\f[CR]debian-bullseye.conf\f[R]
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
guest_os=\[dq]linux\[dq]
|
||||
disk_img=\[dq]debian-bullseye/disk.qcow2\[dq]
|
||||
iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq]
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.IP \[bu] 2
|
||||
Use \f[V]quickemu\f[R] to start the virtual machine:
|
||||
Use \f[CR]quickemu\f[R] to start the virtual machine:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
quickemu --vm debian-bullseye.conf
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.IP \[bu] 2
|
||||
Complete the installation as normal.
|
||||
.IP \[bu] 2
|
||||
Post-install:
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable
|
||||
copy/paste and USB redirection.
|
||||
Install the SPICE agent (\f[CR]spice-vdagent\f[R]) in the guest to
|
||||
enable copy/paste and USB redirection.
|
||||
.IP \[bu] 2
|
||||
Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to
|
||||
enable file sharing.
|
||||
Install the SPICE WebDAV agent (\f[CR]spice-webdavd\f[R]) in the guest
|
||||
to enable file sharing.
|
||||
.RE
|
||||
.SS macOS Guest
|
||||
.PP
|
||||
\f[V]quickget\f[R] automatically downloads a macOS recovery image and
|
||||
\f[CR]quickget\f[R] automatically downloads a macOS recovery image and
|
||||
creates a virtual machine configuration.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
quickget macos catalina
|
||||
quickemu --vm macos-catalina.conf
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
macOS \f[V]high-sierra\f[R], \f[V]mojave\f[R], \f[V]catalina\f[R],
|
||||
\f[V]big-sur\f[R], \f[V]monterey\f[R] and \f[V]ventura\f[R] are
|
||||
macOS \f[CR]high-sierra\f[R], \f[CR]mojave\f[R], \f[CR]catalina\f[R],
|
||||
\f[CR]big-sur\f[R], \f[CR]monterey\f[R] and \f[CR]ventura\f[R] are
|
||||
supported.
|
||||
.IP \[bu] 2
|
||||
Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
|
||||
|
|
@ -501,11 +468,11 @@ From \f[B]macOS Utilities\f[R]
|
|||
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Select \f[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list (on
|
||||
Big Sur and above use \f[V]Apple Inc. VirtIO Block Device\f[R]) and
|
||||
Select \f[CR]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list (on
|
||||
Big Sur and above use \f[CR]Apple Inc. VirtIO Block Device\f[R]) and
|
||||
click \f[B]Erase\f[R].
|
||||
.IP \[bu] 2
|
||||
Enter a \f[V]Name:\f[R] for the disk
|
||||
Enter a \f[CR]Name:\f[R] for the disk
|
||||
.IP \[bu] 2
|
||||
If you are installing macOS Mojave or later (Catalina, Big Sur, Monterey
|
||||
and Ventura), choose any of the APFS options as the filesystem.
|
||||
|
|
@ -554,11 +521,9 @@ command followed by pressing enter to tell macos to use the TRIM command
|
|||
on the hard disk when files are deleted:
|
||||
.RE
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
sudo trimforce enable
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
You will be prompted to enter your account\[cq]s password to gain the
|
||||
privilege needed.
|
||||
|
|
@ -568,40 +533,34 @@ type y (for a \[lq]yes\[rq] response) followed by enter to confirm.
|
|||
If you press enter without first typing y the system will consider that
|
||||
a negative response as though you said \[lq]no\[rq]:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an \[dq]as is\[dq] basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU.
|
||||
Are you sure you with to proceed (y/N)?
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
And a second confirmation once you\[cq]ve confirmed the previous one:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
Your system will immediately reboot when this is complete.
|
||||
Is this OK (y/N)?
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
As the last message states, your system will automatically reboot as
|
||||
soon as the command completes.
|
||||
.PP
|
||||
The default macOS configuration looks like this:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
guest_os=\[dq]macos\[dq]
|
||||
img=\[dq]macos-catalina/RecoveryImage.img\[dq]
|
||||
disk_img=\[dq]macos-catalina/disk.qcow2\[dq]
|
||||
macos_release=\[dq]catalina\[dq]
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.IP \[bu] 2
|
||||
\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
||||
\f[CR]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for
|
||||
macOS.
|
||||
.IP \[bu] 2
|
||||
\f[V]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
|
||||
\f[CR]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to
|
||||
optimise for a particular macOS release.
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
|
|
@ -612,7 +571,6 @@ And VirtIO Block Media (disks) are supported/stable in Catalina and
|
|||
newer.
|
||||
.RE
|
||||
.SS macOS compatibility
|
||||
.PP
|
||||
There are some considerations when running macOS via Quickemu.
|
||||
.IP \[bu] 2
|
||||
Supported macOS releases:
|
||||
|
|
@ -631,7 +589,7 @@ Monterey
|
|||
Ventura
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
\f[V]quickemu\f[R] will automatically download the required
|
||||
\f[CR]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
|
||||
|
|
@ -644,11 +602,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[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for
|
||||
the mouse.
|
||||
VirtIO \f[CR]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used
|
||||
for the mouse.
|
||||
.IP \[bu] 2
|
||||
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].
|
||||
VirtIO Network (\f[CR]virtio-net\f[R]) is supported and enabled on macOS
|
||||
Big Sur and newer but previous releases use \f[CR]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.
|
||||
|
|
@ -680,39 +638,33 @@ webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
|
|||
.IP \[bu] 2
|
||||
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
|
||||
.SS macOS App Store
|
||||
.PP
|
||||
If you see \f[I]\[lq]Your device or computer could not be
|
||||
verified\[rq]\f[R] when you try to login to the App Store, make sure
|
||||
that your wired ethernet device is \f[V]en0\f[R].
|
||||
Use \f[V]ifconfig\f[R] in a terminal to verify this.
|
||||
that your wired ethernet device is \f[CR]en0\f[R].
|
||||
Use \f[CR]ifconfig\f[R] in a terminal to verify this.
|
||||
.PP
|
||||
If the wired ethernet device is not \f[V]en0\f[R], then then go to
|
||||
If the wired ethernet device is not \f[CR]en0\f[R], then then go to
|
||||
\f[I]System Preferences\f[R] -> \f[I]Network\f[R], delete all the
|
||||
network devices and apply the changes.
|
||||
Next, open a terminal and run the following:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
Now reboot, and the App Store should work.
|
||||
.SS Windows 10 & 11 Guests
|
||||
.PP
|
||||
\f[V]quickget\f[R] can download
|
||||
\f[CR]quickget\f[R] can download
|
||||
Windows10 (https://www.microsoft.com/software-download/windows10) and
|
||||
Windows 11 (https://www.microsoft.com/software-download/windows11)
|
||||
automatically and create an optimised virtual machine configuration.
|
||||
This configuration also includes the VirtIO drivers for
|
||||
Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
quickget windows 11
|
||||
quickemu --vm windows-11-22H2.conf
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.IP \[bu] 2
|
||||
Complete the installation as you normally would.
|
||||
.IP \[bu] 2
|
||||
|
|
@ -722,38 +674,34 @@ A local administrator user account is automatically created, with these
|
|||
credentials:
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Username: \f[V]Quickemu\f[R]
|
||||
Username: \f[CR]Quickemu\f[R]
|
||||
.IP \[bu] 2
|
||||
Password: \f[V]quickemu\f[R]
|
||||
Password: \f[CR]quickemu\f[R]
|
||||
.RE
|
||||
.PP
|
||||
The default Windows 11 configuration looks like this:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
guest_os=\[dq]windows\[dq]
|
||||
disk_img=\[dq]windows-11/disk.qcow2\[dq]
|
||||
iso=\[dq]windows-11/windows-11.iso\[dq]
|
||||
fixed_iso=\[dq]windows-11/virtio-win.iso\[dq]
|
||||
tpm=\[dq]on\[dq]
|
||||
secureboot=\[dq]on\[dq]
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.IP \[bu] 2
|
||||
\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to
|
||||
\f[CR]guest_os=\[dq]windows\[dq]\f[R] instructs \f[CR]quickemu\f[R] to
|
||||
optimise for Windows.
|
||||
.IP \[bu] 2
|
||||
\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
|
||||
\f[CR]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
|
||||
drivers.
|
||||
.IP \[bu] 2
|
||||
\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].
|
||||
\f[CR]tpm=\[dq]on\[dq]\f[R] instructs \f[CR]quickemu\f[R] to create a
|
||||
software emulated TPM device using \f[CR]swtpm\f[R].
|
||||
.SH All the options
|
||||
.PP
|
||||
Here are the usage instructions:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
Usage
|
||||
quickemu --vm ubuntu.conf
|
||||
|
||||
|
|
@ -775,7 +723,7 @@ You can also pass optional parameters
|
|||
--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]
|
||||
--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])
|
||||
|
|
@ -787,74 +735,64 @@ You can also pass optional parameters
|
|||
--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]
|
||||
--sound-card <type> : Set sound card. \[at]Options: \[aq]intel-hda\[aq] (default), \[aq]ac97\[aq], \[aq]es1370\[aq], \[aq]sb16\[aq], \[aq]none\[aq]
|
||||
--extra_args <arguments> : Pass additional arguments to qemu
|
||||
--version : Print version
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.SS Desktop shortcuts
|
||||
.PP
|
||||
Desktop shortcuts can be created for a VM, the shortcuts are saved in
|
||||
\f[V]\[ti]/.local/share/applications\f[R].
|
||||
\f[CR]\[ti]/.local/share/applications\f[R].
|
||||
Here is an example of how to create a shortcut.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
quickemu --vm ubuntu-22.04-desktop.conf --shortcut
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.SS Screen and window size (Linux guests only)
|
||||
\f[CR]qemu\f[R] will always default to the primary monitor to display
|
||||
the VM\[cq]s window.
|
||||
.PP
|
||||
\f[V]qemu\f[R] will always default to the primary monitor to display the
|
||||
VM\[cq]s window.
|
||||
.PP
|
||||
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
|
||||
Without the \f[CR]--screen\f[R] option, \f[CR]quickemu\f[R] will look
|
||||
for the size of the smallest monitor, and use a size that fits on said
|
||||
monitor.
|
||||
.PP
|
||||
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.
|
||||
The \f[CR]--screen\f[R] option forces \f[CR]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[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.
|
||||
The \f[CR]--screen\f[R] option is also useful with the
|
||||
\f[CR]--fullscreen\f[R] option, again because \f[CR]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.
|
||||
.PP
|
||||
To know which screen to use, type:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
xrandr --listmonitors | grep -v Monitors
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
The command will output something like this:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
0: +*HDMI-0 2560/597x1440/336+1920+0 HDMI-0
|
||||
1: +DVI-D-0 1920/527x1080/296+0+0 DVI-D-0
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
The first number is what needs to be passed to the \f[V]--screen\f[R]
|
||||
The first number is what needs to be passed to the \f[CR]--screen\f[R]
|
||||
option.
|
||||
.PP
|
||||
For example:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
.EX
|
||||
quickemu --vm vm.conf --screen 0
|
||||
\f[R]
|
||||
.fi
|
||||
.EE
|
||||
.PP
|
||||
The above uses the 2560x1440 screen to compute the size of the window,
|
||||
which Quickemu sizes to 2048x1152.
|
||||
Without the \f[V]--screen\f[R] option, Quickemu would have used the
|
||||
Without the \f[CR]--screen\f[R] option, Quickemu would have used the
|
||||
1920x1080 monitor which results in a window size of 1664x936.
|
||||
.PP
|
||||
The `\[en]screenpct' is an optional integer value between 25 <= pct <
|
||||
|
|
@ -863,7 +801,6 @@ The VM size will be `pct' of the chosen screen.
|
|||
\f[B]If \[en]fullscreen is chosen screen will be fullsize instead of
|
||||
being scaled down by \[en]screenpct value.\f[R]
|
||||
.SH References
|
||||
.PP
|
||||
Useful reference that assisted the development of Quickemu.
|
||||
.IP \[bu] 2
|
||||
General
|
||||
|
|
@ -938,14 +875,11 @@ TPM
|
|||
<https://virtio-fs.gitlab.io/>
|
||||
.RE
|
||||
.SH AUTHORS
|
||||
.PP
|
||||
Written by Martin Wimpress.
|
||||
.SH BUGS
|
||||
.PP
|
||||
Submit bug reports online at:
|
||||
<https://github.com/quickemu-project/quickemu/issues>
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
Full sources at: <https://github.com/quickemu-project/quickemu>
|
||||
.PP
|
||||
quickemu_conf(1), quickget(1), quickgui(1)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue