docs: regenerated man pages for new and changed options
Also README.md and sub-project aligned
This commit is contained in:
Phil Clifford
Martin Wimpress
parent
aaf4ae4ff6
commit
f6b5d684d4
|
|
@ -19,7 +19,7 @@
|
|||
# Introduction
|
||||
|
||||
**Quickemu** is a wrapper for the excellent [QEMU](https://www.qemu.org/) that
|
||||
automatically *“does the right thing”* when creating virtual machines. No
|
||||
automatically *"does the right thing"* when creating virtual machines. No
|
||||
requirement for exhaustive configuration options. You decide what operating
|
||||
system you want to run and Quickemu takes care of the rest 🤖
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Subproject commit 91309a4efd67c29fe44f103fa78d82cd71beaf78
|
||||
Subproject commit b565cefbfc9a94cd699da6c5fa9c59c1c1646dbb
|
||||
|
|
@ -1,10 +1,10 @@
|
|||
.\" Automatically generated by Pandoc 3.2
|
||||
.\"
|
||||
.TH "QUICKEMU" "1" "May 13, 2024" "quickemu" "Quickemu User Manual"
|
||||
.TH "QUICKEMU" "1" "May 14, 2024" "quickemu" "Quickemu User Manual"
|
||||
.SH NAME
|
||||
quickemu \- A quick VM builder and manager
|
||||
.SH SYNOPSIS
|
||||
\f[B]quickemu\f[R] [\f[I]OPTION\f[R]]\&...
|
||||
\f[B]quickemu\f[R] [\f[I]OPTION\f[R]]...
|
||||
.SH DESCRIPTION
|
||||
\f[B]quickemu\f[R] will create and run highly optimised desktop virtual
|
||||
machines for Linux, macOS and Windows
|
||||
|
|
@ -17,7 +17,7 @@ You can also pass optional parameters
|
|||
.TP
|
||||
\f[B]\-\-access\f[R]
|
||||
Enable remote spice access support.
|
||||
\[oq]local\[cq] (default), \[oq]remote\[cq], \[oq]clientipaddress\[cq]
|
||||
\[aq]local\[aq] (default), \[aq]remote\[aq], \[aq]clientipaddress\[aq]
|
||||
.TP
|
||||
\f[B]\-\-braille\f[R]
|
||||
Enable braille support.
|
||||
|
|
@ -31,8 +31,8 @@ Delete the entire VM and its configuration
|
|||
.TP
|
||||
\f[B]\-\-display\f[R]
|
||||
Select display backend.
|
||||
\[oq]sdl\[cq] (default), \[oq]gtk\[cq], \[oq]none\[cq], \[oq]spice\[cq]
|
||||
or \[oq]spice\-app\[cq]
|
||||
\[aq]sdl\[aq] (default), \[aq]gtk\[aq], \[aq]none\[aq], \[aq]spice\[aq]
|
||||
or \[aq]spice\-app\[aq]
|
||||
.TP
|
||||
\f[B]\-\-fullscreen\f[R]
|
||||
Starts VM in full screen mode (Ctl+Alt+f to exit)
|
||||
|
|
@ -66,14 +66,14 @@ Do not commit any changes to disk/snapshot.
|
|||
.TP
|
||||
\f[B]\-\-viewer <viewer>\f[R]
|
||||
Choose an alternative viewer.
|
||||
\[at]Options: \[oq]spicy\[cq] (default), \[oq]remote\-viewer\[cq],
|
||||
\[oq]none\[cq]
|
||||
\[at]Options: \[aq]spicy\[aq] (default), \[aq]remote\-viewer\[aq],
|
||||
\[aq]none\[aq]
|
||||
.TP
|
||||
\f[B]\-\-width <width>\f[R]
|
||||
Set VM screen width; requires \[oq]\-\-height\[cq]
|
||||
Set VM screen width; requires \[aq]\-\-height\[aq]
|
||||
.TP
|
||||
\f[B]\-\-height <height>\f[R]
|
||||
Set VM screen height; requires \[oq]\-\-width\[cq]
|
||||
Set VM screen height; requires \[aq]\-\-width\[aq]
|
||||
.TP
|
||||
\f[B]\-\-ssh\-port <port>\f[R]
|
||||
Set SSH port manually
|
||||
|
|
@ -83,21 +83,21 @@ Set SPICE port manually
|
|||
.TP
|
||||
\f[B]\-\-public\-dir <path>\f[R]
|
||||
Expose share directory.
|
||||
\[at]Options: \[cq]\[cq] (default: xdg\-user\-dir PUBLICSHARE),
|
||||
\[oq]\[cq], \[oq]none\[cq]
|
||||
\[at]Options: \[aq]\[aq] (default: xdg\-user\-dir PUBLICSHARE),
|
||||
\[aq]\[aq], \[aq]none\[aq]
|
||||
.TP
|
||||
\f[B]\-\-monitor <type>\f[R]
|
||||
Set monitor connection type.
|
||||
\[at]Options: \[oq]socket\[cq] (default), \[oq]telnet\[cq],
|
||||
\[oq]none\[cq]
|
||||
\[at]Options: \[aq]socket\[aq] (default), \[aq]telnet\[aq],
|
||||
\[aq]none\[aq]
|
||||
.TP
|
||||
\f[B]\-\-monitor\-telnet\-host <ip/host>\f[R]
|
||||
Set telnet host for monitor.
|
||||
(default: \[oq]localhost\[cq])
|
||||
(default: \[aq]localhost\[aq])
|
||||
.TP
|
||||
\f[B]\-\-monitor\-telnet\-port <port>\f[R]
|
||||
Set telnet port for monitor.
|
||||
(default: \[oq]4440\[cq])
|
||||
(default: \[aq]4440\[aq])
|
||||
.TP
|
||||
\f[B]\-\-monitor\-cmd <cmd>\f[R]
|
||||
Send command to monitor if available.
|
||||
|
|
@ -105,37 +105,37 @@ Send command to monitor if available.
|
|||
.TP
|
||||
\f[B]\-\-serial <type>\f[R]
|
||||
Set serial connection type.
|
||||
\[at]Options: \[oq]socket\[cq] (default), \[oq]telnet\[cq],
|
||||
\[oq]none\[cq]
|
||||
\[at]Options: \[aq]socket\[aq] (default), \[aq]telnet\[aq],
|
||||
\[aq]none\[aq]
|
||||
.TP
|
||||
\f[B]\-\-serial\-telnet\-host <ip/host>\f[R]
|
||||
Set telnet host for serial.
|
||||
(default: \[oq]localhost\[cq])
|
||||
(default: \[aq]localhost\[aq])
|
||||
.TP
|
||||
\f[B]\-\-serial\-telnet\-port <port>\f[R]
|
||||
Set telnet port for serial.
|
||||
(default: \[oq]6660\[cq])
|
||||
(default: \[aq]6660\[aq])
|
||||
.TP
|
||||
\f[B]\-\-keyboard <type>\f[R]
|
||||
Set keyboard.
|
||||
\[at]Options: \[oq]usb\[cq] (default), \[oq]ps2\[cq], \[oq]virtio\[cq]
|
||||
\[at]Options: \[aq]usb\[aq] (default), \[aq]ps2\[aq], \[aq]virtio\[aq]
|
||||
.TP
|
||||
\f[B]\-\-keyboard_layout <layout>\f[R]
|
||||
Set keyboard layout: \[oq]en\-us\[cq] (default)
|
||||
Set keyboard layout: \[aq]en\-us\[aq] (default)
|
||||
.TP
|
||||
\f[B]\-\-mouse <type>\f[R]
|
||||
Set mouse.
|
||||
\[at]Options: \[oq]tablet\[cq] (default), \[oq]ps2\[cq], \[oq]usb\[cq],
|
||||
\[oq]virtio\[cq]
|
||||
\[at]Options: \[aq]tablet\[aq] (default), \[aq]ps2\[aq], \[aq]usb\[aq],
|
||||
\[aq]virtio\[aq]
|
||||
.TP
|
||||
\f[B]\-\-usb\-controller <type>\f[R]
|
||||
Set usb\-controller.
|
||||
\[at]Options: \[oq]ehci\[cq] (default), \[oq]xhci\[cq], \[oq]none\[cq]
|
||||
\[at]Options: \[aq]ehci\[aq] (default), \[aq]xhci\[aq], \[aq]none\[aq]
|
||||
.TP
|
||||
\f[B]\-\-sound\-card <type>\f[R]
|
||||
Set sound card.
|
||||
\[at]Options: \[oq]intel\-hda\[cq] (default), \[oq]ac97\[cq],
|
||||
\[oq]es1370\[cq], \[oq]sb16\[cq], \[oq]none\[cq]
|
||||
\[at]Options: \[aq]intel\-hda\[aq] (default), \[aq]ac97\[aq],
|
||||
\[aq]es1370\[aq], \[aq]sb16\[aq], \[aq]none\[aq]
|
||||
.TP
|
||||
\f[B]\-\-extra_args <arguments>\f[R]
|
||||
Pass additional arguments to qemu
|
||||
|
|
@ -144,14 +144,14 @@ Pass additional arguments to qemu
|
|||
Print version
|
||||
.SH EXAMPLES
|
||||
.TP
|
||||
\f[B]quickemu \[en]vm ubuntu\-mate\-22.04.conf\f[R]
|
||||
\f[B]quickemu \-\-vm ubuntu\-mate\-22.04.conf\f[R]
|
||||
Launches the VM specified in the file \f[I]ubuntu\-mate\-22.04.conf\f[R]
|
||||
.SH Introduction
|
||||
\f[B]Quickemu\f[R] is a wrapper for the excellent \c
|
||||
.UR https://www.qemu.org/
|
||||
QEMU
|
||||
.UE \c
|
||||
\ that automatically \f[I]\[lq]does the right thing\[rq]\f[R] when
|
||||
\ that automatically \f[I]\[dq]does the right thing\[dq]\f[R] when
|
||||
creating virtual machines.
|
||||
No requirement for exhaustive configuration options.
|
||||
You decide what operating system you want to run and Quickemu takes care
|
||||
|
|
@ -892,21 +892,21 @@ on the hard disk when files are deleted:
|
|||
sudo trimforce enable
|
||||
.EE
|
||||
.PP
|
||||
You will be prompted to enter your account\[cq]s password to gain the
|
||||
You will be prompted to enter your account\[aq]s password to gain the
|
||||
privilege needed.
|
||||
Once you\[cq]ve entered your password and pressed enter the command will
|
||||
Once you\[aq]ve entered your password and pressed enter the command will
|
||||
request confirmation in the form of two questions that require you to
|
||||
type y (for a \[lq]yes\[rq] response) followed by enter to confirm.
|
||||
type y (for a \[dq]yes\[dq] response) followed by enter to confirm.
|
||||
.PP
|
||||
If you press enter without first typing y the system will consider that
|
||||
a negative response as though you said \[lq]no\[rq]:
|
||||
a negative response as though you said \[dq]no\[dq]:
|
||||
.IP
|
||||
.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)?
|
||||
.EE
|
||||
.PP
|
||||
And a second confirmation once you\[cq]ve confirmed the previous one:
|
||||
And a second confirmation once you\[aq]ve confirmed the previous one:
|
||||
.IP
|
||||
.EX
|
||||
Your system will immediately reboot when this is complete.
|
||||
|
|
@ -1034,8 +1034,8 @@ SPICE webdavd
|
|||
.IP \[bu] 2
|
||||
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
|
||||
.SH macOS App Store
|
||||
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
|
||||
If you see \f[I]\[dq]Your device or computer could not be
|
||||
verified\[dq]\f[R] when you try to login to the App Store, make sure
|
||||
that your wired ethernet device is \f[CR]en0\f[R].
|
||||
Use \f[CR]ifconfig\f[R] in a terminal to verify this.
|
||||
.PP
|
||||
|
|
@ -1076,7 +1076,7 @@ VirtIO drivers for Windows
|
|||
.UE \c
|
||||
\&.
|
||||
.PP
|
||||
\f[B]Windows 8.1\f[R] is also supported but doesn\[cq]t feature any
|
||||
\f[B]Windows 8.1\f[R] is also supported but doesn\[aq]t feature any
|
||||
automated installation or driver optimisation.
|
||||
.PP
|
||||
\f[CR]quickget\f[R] can also download \c
|
||||
|
|
@ -1150,8 +1150,8 @@ Arguments
|
|||
\-\-viewer <viewer> : Choose an alternative viewer. \[at]Options: \[aq]spicy\[aq] (default), \[aq]remote\-viewer\[aq], \[aq]none\[aq]
|
||||
\-\-width <width> : Set VM screen width; requires \[aq]\-\-height\[aq]
|
||||
\-\-height <height> : Set VM screen height; requires \[aq]\-\-width\[aq]
|
||||
\-\-ssh\-port <port> : Set ssh\-port manually
|
||||
\-\-spice\-port <port> : Set spice\-port manually
|
||||
\-\-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])
|
||||
|
|
@ -1161,10 +1161,11 @@ Arguments
|
|||
\-\-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.
|
||||
\-\-keyboard_layout <layout> : Set keyboard layout: \[aq]en\-us\[aq] (default)
|
||||
\-\-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]
|
||||
\-\-sound\-card <type> : Set sound card. \[at]Options: \[aq]intel\-hda\[aq] (default), \[aq]ac97\[aq], \[aq]es1370\[aq], \[aq]sb16\[aq], \[aq]usb\-audio\[aq], \[aq]none\[aq]
|
||||
\-\-sound\-duplex <type> : Set sound card duplex. \[at]Options: \[aq]hda\-micro\[aq] (default: speaker/mic), \[aq]hda\-duplex\[aq] (line\-in/line\-out), \[aq]hda\-output\[aq] (output\-only)
|
||||
\-\-extra_args <arguments> : Pass additional arguments to qemu
|
||||
\-\-version : Print version
|
||||
.EE
|
||||
|
|
@ -1184,7 +1185,7 @@ General
|
|||
.IP \[bu] 2
|
||||
\c
|
||||
.UR https://qemu.readthedocs.io/en/latest/
|
||||
QEMU\[cq]s documentation!
|
||||
QEMU\[aq]s documentation!
|
||||
.UE \c
|
||||
.IP \[bu] 2
|
||||
\c
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
author: Martin Wimpress
|
||||
date: May 13, 2024
|
||||
date: May 14, 2024
|
||||
footer: quickemu
|
||||
header: Quickemu User Manual
|
||||
section: 1
|
||||
|
|
@ -13,7 +13,7 @@ quickemu - A quick VM builder and manager
|
|||
|
||||
# SYNOPSIS
|
||||
|
||||
**quickemu** \[*OPTION*\]…
|
||||
**quickemu** \[*OPTION*\]...
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
|
|
@ -28,8 +28,8 @@ machines for Linux, macOS and Windows
|
|||
You can also pass optional parameters
|
||||
|
||||
**--access**
|
||||
: Enable remote spice access support. ‘local’ (default), ‘remote’,
|
||||
‘clientipaddress’
|
||||
: Enable remote spice access support. 'local' (default), 'remote',
|
||||
'clientipaddress'
|
||||
|
||||
**--braille**
|
||||
: Enable braille support. Requires SDL.
|
||||
|
|
@ -41,8 +41,8 @@ You can also pass optional parameters
|
|||
: Delete the entire VM and its configuration
|
||||
|
||||
**--display**
|
||||
: Select display backend. ‘sdl’ (default), ‘gtk’, ‘none’, ‘spice’ or
|
||||
‘spice-app’
|
||||
: Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or
|
||||
'spice-app'
|
||||
|
||||
**--fullscreen**
|
||||
: Starts VM in full screen mode (Ctl+Alt+f to exit)
|
||||
|
|
@ -75,14 +75,14 @@ You can also pass optional parameters
|
|||
: Do not commit any changes to disk/snapshot.
|
||||
|
||||
**--viewer \<viewer\>**
|
||||
: Choose an alternative viewer. @Options: ‘spicy’ (default),
|
||||
‘remote-viewer’, ‘none’
|
||||
: Choose an alternative viewer. @Options: 'spicy' (default),
|
||||
'remote-viewer', 'none'
|
||||
|
||||
**--width \<width\>**
|
||||
: Set VM screen width; requires ‘--height’
|
||||
: Set VM screen width; requires '--height'
|
||||
|
||||
**--height \<height\>**
|
||||
: Set VM screen height; requires ‘--width’
|
||||
: Set VM screen height; requires '--width'
|
||||
|
||||
**--ssh-port \<port\>**
|
||||
: Set SSH port manually
|
||||
|
|
@ -91,47 +91,47 @@ You can also pass optional parameters
|
|||
: Set SPICE port manually
|
||||
|
||||
**--public-dir \<path\>**
|
||||
: Expose share directory. @Options: ’’ (default: xdg-user-dir
|
||||
PUBLICSHARE), ‘<directory>’, ‘none’
|
||||
: Expose share directory. @Options: '' (default: xdg-user-dir
|
||||
PUBLICSHARE), '<directory>', 'none'
|
||||
|
||||
**--monitor \<type\>**
|
||||
: Set monitor connection type. @Options: ‘socket’ (default), ‘telnet’,
|
||||
‘none’
|
||||
: Set monitor connection type. @Options: 'socket' (default), 'telnet',
|
||||
'none'
|
||||
|
||||
**--monitor-telnet-host \<ip/host\>**
|
||||
: Set telnet host for monitor. (default: ‘localhost’)
|
||||
: Set telnet host for monitor. (default: 'localhost')
|
||||
|
||||
**--monitor-telnet-port \<port\>**
|
||||
: Set telnet port for monitor. (default: ‘4440’)
|
||||
: Set telnet port for monitor. (default: '4440')
|
||||
|
||||
**--monitor-cmd \<cmd\>**
|
||||
: Send command to monitor if available. (Example: system_powerdown)
|
||||
|
||||
**--serial \<type\>**
|
||||
: Set serial connection type. @Options: ‘socket’ (default), ‘telnet’,
|
||||
‘none’
|
||||
: Set serial connection type. @Options: 'socket' (default), 'telnet',
|
||||
'none'
|
||||
|
||||
**--serial-telnet-host \<ip/host\>**
|
||||
: Set telnet host for serial. (default: ‘localhost’)
|
||||
: Set telnet host for serial. (default: 'localhost')
|
||||
|
||||
**--serial-telnet-port \<port\>**
|
||||
: Set telnet port for serial. (default: ‘6660’)
|
||||
: Set telnet port for serial. (default: '6660')
|
||||
|
||||
**--keyboard \<type\>**
|
||||
: Set keyboard. @Options: ‘usb’ (default), ‘ps2’, ‘virtio’
|
||||
: Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio'
|
||||
|
||||
**--keyboard_layout \<layout\>**
|
||||
: Set keyboard layout: ‘en-us’ (default)
|
||||
: Set keyboard layout: 'en-us' (default)
|
||||
|
||||
**--mouse \<type\>**
|
||||
: Set mouse. @Options: ‘tablet’ (default), ‘ps2’, ‘usb’, ‘virtio’
|
||||
: Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
|
||||
|
||||
**--usb-controller \<type\>**
|
||||
: Set usb-controller. @Options: ‘ehci’ (default), ‘xhci’, ‘none’
|
||||
: Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
|
||||
|
||||
**--sound-card \<type\>**
|
||||
: Set sound card. @Options: ‘intel-hda’ (default), ‘ac97’, ‘es1370’,
|
||||
‘sb16’, ‘none’
|
||||
: Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370',
|
||||
'sb16', 'none'
|
||||
|
||||
**--extra_args \<arguments\>**
|
||||
: Pass additional arguments to qemu
|
||||
|
|
@ -141,14 +141,14 @@ You can also pass optional parameters
|
|||
|
||||
# EXAMPLES
|
||||
|
||||
**quickemu –vm ubuntu-mate-22.04.conf**
|
||||
**quickemu --vm ubuntu-mate-22.04.conf**
|
||||
: Launches the VM specified in the file *ubuntu-mate-22.04.conf*
|
||||
|
||||
# Introduction
|
||||
|
||||
**Quickemu** is a wrapper for the excellent
|
||||
[QEMU](https://www.qemu.org/) that automatically *“does the right
|
||||
thing”* when creating virtual machines. No requirement for exhaustive
|
||||
[QEMU](https://www.qemu.org/) that automatically *"does the right
|
||||
thing"* when creating virtual machines. No requirement for exhaustive
|
||||
configuration options. You decide what operating system you want to run
|
||||
and Quickemu takes care of the rest 🤖
|
||||
|
||||
|
|
@ -597,21 +597,21 @@ macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
|
|||
sudo trimforce enable
|
||||
```
|
||||
|
||||
You will be prompted to enter your account’s password to gain the
|
||||
privilege needed. Once you’ve entered your password and pressed
|
||||
You will be prompted to enter your account's password to gain the
|
||||
privilege needed. Once you've entered your password and pressed
|
||||
<kbd>enter</kbd> the command will request confirmation in the form of
|
||||
two questions that require you to type <kbd>y</kbd> (for a “yes”
|
||||
two questions that require you to type <kbd>y</kbd> (for a "yes"
|
||||
response) followed by <kbd>enter</kbd> to confirm.
|
||||
|
||||
If you press <kbd>enter</kbd> without first typing <kbd>y</kbd> the
|
||||
system will consider that a negative response as though you said “no”:
|
||||
system will consider that a negative response as though you said "no":
|
||||
|
||||
``` plain
|
||||
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 "as is" 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)?
|
||||
```
|
||||
|
||||
And a second confirmation once you’ve confirmed the previous one:
|
||||
And a second confirmation once you've confirmed the previous one:
|
||||
|
||||
``` plain
|
||||
Your system will immediately reboot when this is complete.
|
||||
|
|
@ -682,7 +682,7 @@ There are some considerations when running macOS via Quickemu.
|
|||
|
||||
# macOS App Store
|
||||
|
||||
If you see *“Your device or computer could not be verified”* when you
|
||||
If you see *"Your device or computer could not be verified"* when you
|
||||
try to login to the App Store, make sure that your wired ethernet device
|
||||
is `en0`. Use `ifconfig` in a terminal to verify this.
|
||||
|
||||
|
|
@ -709,7 +709,7 @@ 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/).
|
||||
|
||||
**Windows 8.1** is also supported but doesn’t feature any automated
|
||||
**Windows 8.1** is also supported but doesn't feature any automated
|
||||
installation or driver optimisation.
|
||||
|
||||
`quickget` can also download [Windows 10
|
||||
|
|
@ -764,8 +764,8 @@ Arguments
|
|||
--viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none'
|
||||
--width <width> : Set VM screen width; requires '--height'
|
||||
--height <height> : Set VM screen height; requires '--width'
|
||||
--ssh-port <port> : Set ssh-port manually
|
||||
--spice-port <port> : Set spice-port manually
|
||||
--ssh-port <port> : Set SSH port manually
|
||||
--spice-port <port> : Set SPICE port manually
|
||||
--public-dir <path> : Expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '<directory>', 'none'
|
||||
--monitor <type> : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none'
|
||||
--monitor-telnet-host <ip/host> : Set telnet host for monitor. (default: 'localhost')
|
||||
|
|
@ -775,10 +775,11 @@ Arguments
|
|||
--serial-telnet-host <ip/host> : Set telnet host for serial. (default: 'localhost')
|
||||
--serial-telnet-port <port> : Set telnet port for serial. (default: '6660')
|
||||
--keyboard <type> : Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio'
|
||||
--keyboard_layout <layout> : Set keyboard layout.
|
||||
--keyboard_layout <layout> : Set keyboard layout: 'en-us' (default)
|
||||
--mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
|
||||
--usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
|
||||
--sound-card <type> : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'none'
|
||||
--sound-card <type> : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'usb-audio', 'none'
|
||||
--sound-duplex <type> : Set sound card duplex. @Options: 'hda-micro' (default: speaker/mic), 'hda-duplex' (line-in/line-out), 'hda-output' (output-only)
|
||||
--extra_args <arguments> : Pass additional arguments to qemu
|
||||
--version : Print version
|
||||
```
|
||||
|
|
@ -798,7 +799,7 @@ quickemu --vm ubuntu-22.04-desktop.conf --shortcut
|
|||
Useful reference that assisted the development of Quickemu.
|
||||
|
||||
- General
|
||||
- [QEMU’s documentation!](https://qemu.readthedocs.io/en/latest/)
|
||||
- [QEMU's documentation!](https://qemu.readthedocs.io/en/latest/)
|
||||
- <https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines>
|
||||
- <https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/>
|
||||
- macOS
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Automatically generated by Pandoc 3.2
|
||||
.\"
|
||||
.TH "QUICKEMU_CONF" "1" "May 13, 2024" "quickemu_conf" "Quickemu Configuration Manual"
|
||||
.TH "QUICKEMU_CONF" "1" "May 14, 2024" "quickemu_conf" "Quickemu Configuration Manual"
|
||||
.SH NAME
|
||||
quickemu_conf \- Options and parameters in the quickemu <vm>.conf
|
||||
.SH DESCRIPTION
|
||||
|
|
@ -143,11 +143,11 @@ following line to the VM configuration:
|
|||
.IP \[bu] 2
|
||||
\f[CR]fixed_iso=\[dq]/path/to/image.iso\[dq]\f[R]
|
||||
.SS Floppy disks
|
||||
If you\[cq]re like \c
|
||||
If you\[aq]re like \c
|
||||
.UR https://popey.com
|
||||
Alan Pope
|
||||
.UE \c
|
||||
\ you\[cq]ll probably want to mount a floppy disk image in the guest.
|
||||
\ you\[aq]ll probably want to mount a floppy disk image in the guest.
|
||||
To do so add the following line to the VM configuration:
|
||||
.IP \[bu] 2
|
||||
\f[CR]floppy=\[dq]/path/to/floppy.img\[dq]\f[R]
|
||||
|
|
@ -173,8 +173,8 @@ For example:
|
|||
\- smbd: On guest: smb://10.0.2.4/qemu
|
||||
.EE
|
||||
.PP
|
||||
If using a Windows guest, right\-click on \[lq]This PC\[rq], click
|
||||
\[lq]Add a network location\[rq], and paste this address, removing
|
||||
If using a Windows guest, right\-click on \[dq]This PC\[dq], click
|
||||
\[dq]Add a network location\[dq], and paste this address, removing
|
||||
\f[CR]smb:\f[R] and replacing forward slashes with backslashes (in this
|
||||
example \f[CR]\[rs]\[rs]10.0.2.4\[rs]qemu\f[R]).
|
||||
.SS SPICE WebDAV 🐧 🪟
|
||||
|
|
@ -229,7 +229,7 @@ So you can generate your own MAC addresses with:
|
|||
Quickemu supports USB redirection via SPICE pass\-through and host
|
||||
pass\-through.
|
||||
.SS SPICE redirection (recommended)
|
||||
Using SPICE for USB pass\-through is easiest as it doesn\[cq]t require
|
||||
Using SPICE for USB pass\-through is easiest as it doesn\[aq]t require
|
||||
any elevated permission:
|
||||
.IP \[bu] 2
|
||||
Start Quickemu with \f[CR]\-\-display spice\f[R] and then
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
author: Martin Wimpress
|
||||
date: May 13, 2024
|
||||
date: May 14, 2024
|
||||
footer: quickemu_conf
|
||||
header: Quickemu Configuration Manual
|
||||
section: 1
|
||||
|
|
@ -149,7 +149,7 @@ following line to the VM configuration:
|
|||
|
||||
### Floppy disks
|
||||
|
||||
If you’re like [Alan Pope](https://popey.com) you’ll probably want to
|
||||
If you're like [Alan Pope](https://popey.com) you'll probably want to
|
||||
mount a floppy disk image in the guest. To do so add the following line
|
||||
to the VM configuration:
|
||||
|
||||
|
|
@ -177,8 +177,8 @@ when the virtual machine is started. For example:
|
|||
|
||||
- smbd: On guest: smb://10.0.2.4/qemu
|
||||
|
||||
If using a Windows guest, right-click on “This PC”, click “Add a network
|
||||
location”, and paste this address, removing `smb:` and replacing forward
|
||||
If using a Windows guest, right-click on "This PC", click "Add a network
|
||||
location", and paste this address, removing `smb:` and replacing forward
|
||||
slashes with backslashes (in this example `\\10.0.2.4\qemu`).
|
||||
|
||||
#### SPICE WebDAV 🐧 🪟
|
||||
|
|
@ -245,7 +245,7 @@ pass-through.
|
|||
|
||||
#### SPICE redirection (recommended)
|
||||
|
||||
Using SPICE for USB pass-through is easiest as it doesn’t require any
|
||||
Using SPICE for USB pass-through is easiest as it doesn't require any
|
||||
elevated permission:
|
||||
|
||||
- Start Quickemu with `--display spice` and then
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Automatically generated by Pandoc 3.2
|
||||
.\"
|
||||
.TH "QUICKGET" "1" "May 13, 2024" "quickget" "Quickget User Manual"
|
||||
.TH "QUICKGET" "1" "May 14, 2024" "quickget" "Quickget User Manual"
|
||||
.SH NAME
|
||||
quickget \- download and prepare materials for building a quickemu VM
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -458,21 +458,21 @@ on the hard disk when files are deleted:
|
|||
sudo trimforce enable
|
||||
.EE
|
||||
.PP
|
||||
You will be prompted to enter your account\[cq]s password to gain the
|
||||
You will be prompted to enter your account\[aq]s password to gain the
|
||||
privilege needed.
|
||||
Once you\[cq]ve entered your password and pressed enter the command will
|
||||
Once you\[aq]ve entered your password and pressed enter the command will
|
||||
request confirmation in the form of two questions that require you to
|
||||
type y (for a \[lq]yes\[rq] response) followed by enter to confirm.
|
||||
type y (for a \[dq]yes\[dq] response) followed by enter to confirm.
|
||||
.PP
|
||||
If you press enter without first typing y the system will consider that
|
||||
a negative response as though you said \[lq]no\[rq]:
|
||||
a negative response as though you said \[dq]no\[dq]:
|
||||
.IP
|
||||
.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)?
|
||||
.EE
|
||||
.PP
|
||||
And a second confirmation once you\[cq]ve confirmed the previous one:
|
||||
And a second confirmation once you\[aq]ve confirmed the previous one:
|
||||
.IP
|
||||
.EX
|
||||
Your system will immediately reboot when this is complete.
|
||||
|
|
@ -600,8 +600,8 @@ SPICE webdavd
|
|||
.IP \[bu] 2
|
||||
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
|
||||
.SH macOS App Store
|
||||
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
|
||||
If you see \f[I]\[dq]Your device or computer could not be
|
||||
verified\[dq]\f[R] when you try to login to the App Store, make sure
|
||||
that your wired ethernet device is \f[CR]en0\f[R].
|
||||
Use \f[CR]ifconfig\f[R] in a terminal to verify this.
|
||||
.PP
|
||||
|
|
@ -642,7 +642,7 @@ VirtIO drivers for Windows
|
|||
.UE \c
|
||||
\&.
|
||||
.PP
|
||||
\f[B]Windows 8.1\f[R] is also supported but doesn\[cq]t feature any
|
||||
\f[B]Windows 8.1\f[R] is also supported but doesn\[aq]t feature any
|
||||
automated installation or driver optimisation.
|
||||
.PP
|
||||
\f[CR]quickget\f[R] can also download \c
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
author: Martin Wimpress
|
||||
date: May 13, 2024
|
||||
date: May 14, 2024
|
||||
footer: quickget
|
||||
header: Quickget User Manual
|
||||
section: 1
|
||||
|
|
@ -331,21 +331,21 @@ macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
|
|||
sudo trimforce enable
|
||||
```
|
||||
|
||||
You will be prompted to enter your account’s password to gain the
|
||||
privilege needed. Once you’ve entered your password and pressed
|
||||
You will be prompted to enter your account's password to gain the
|
||||
privilege needed. Once you've entered your password and pressed
|
||||
<kbd>enter</kbd> the command will request confirmation in the form of
|
||||
two questions that require you to type <kbd>y</kbd> (for a “yes”
|
||||
two questions that require you to type <kbd>y</kbd> (for a "yes"
|
||||
response) followed by <kbd>enter</kbd> to confirm.
|
||||
|
||||
If you press <kbd>enter</kbd> without first typing <kbd>y</kbd> the
|
||||
system will consider that a negative response as though you said “no”:
|
||||
system will consider that a negative response as though you said "no":
|
||||
|
||||
``` plain
|
||||
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 "as is" 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)?
|
||||
```
|
||||
|
||||
And a second confirmation once you’ve confirmed the previous one:
|
||||
And a second confirmation once you've confirmed the previous one:
|
||||
|
||||
``` plain
|
||||
Your system will immediately reboot when this is complete.
|
||||
|
|
@ -416,7 +416,7 @@ There are some considerations when running macOS via Quickemu.
|
|||
|
||||
# macOS App Store
|
||||
|
||||
If you see *“Your device or computer could not be verified”* when you
|
||||
If you see *"Your device or computer could not be verified"* when you
|
||||
try to login to the App Store, make sure that your wired ethernet device
|
||||
is `en0`. Use `ifconfig` in a terminal to verify this.
|
||||
|
||||
|
|
@ -443,7 +443,7 @@ 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/).
|
||||
|
||||
**Windows 8.1** is also supported but doesn’t feature any automated
|
||||
**Windows 8.1** is also supported but doesn't feature any automated
|
||||
installation or driver optimisation.
|
||||
|
||||
`quickget` can also download [Windows 10
|
||||
|
|
|
|||
Loading…
Reference in New Issue