oSoWoSo/DistroHopper
1
0
Fork 0
mirror of https://github.com/oSoWoSo/DistroHopper.git synced 2024-08-14 22:46:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

Regenerated docs for 4.4 Release

Browse source 
README and man pages regenerated incorporating documentation updates from Release 4.4
This commit is contained in:
Phil Clifford 2022-10-21 10:52:38 +01:00 committed by Martin Wimpress
parent 215597eead
commit 1fb683dd48
8 changed files with 247 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
README.md
View file

@ -235,6 +235,7 @@ with your preferred flavour.
- `alma` (Alma Linux) - `alma` (Alma Linux)
- `alpine` (Alpine Linux) - `alpine` (Alpine Linux)
- `android` (Android x86) - `android` (Android x86)
- `archcraft` (Archcraft)
- `archlinux` (Arch Linux) - `archlinux` (Arch Linux)
- `arcolinux` (Arco Linux) - `arcolinux` (Arco Linux)
- `batocera` (Batocera) - `batocera` (Batocera)
@ -316,9 +317,9 @@ supported.
- Use cursor keys and enter key to select the **macOS Base System** - Use cursor keys and enter key to select the **macOS Base System**
- From **macOS Utilities** - From **macOS Utilities**
- Click **Disk Utility** and **Continue** - Click **Disk Utility** and **Continue**
- Select `QEMU HARDDISK Media` (\~103.08GB) from the list - Select `QEMU HARDDISK Media` (\~103.08GB) from the list and
and click **Erase**. click **Erase**.
- Enter a `Name:` for the disk - Enter a `Name:` for the disk
- If you are installing macOS Mojave or later (Catalina, Big - If you are installing macOS Mojave or later (Catalina, Big
Sur, and Monterey), choose any of the APFS options as the Sur, and Monterey), choose any of the APFS options as the
filesystem. MacOS Extended may not work. filesystem. MacOS Extended may not work.
@ -332,28 +333,43 @@ supported.
**macOS Installer** **macOS Installer**
- On the subsequent reboots use cursor keys and enter key to - On the subsequent reboots use cursor keys and enter key to
select the disk you named select the disk you named
- Once you have finished installing macOS you will be presented with an the out-of-the-box first-start wizard to configure various options and set up your username and password - Once you have finished installing macOS you will be presented with
- OPTIONAL: After you have concluded the out-of-the-box wizard, you may want to enable the TRIM feature that the computer industry created for SSD disks. This feature in our macOS installation will allow QuickEmu to compact (shrink) your macOS disk image whenever you delete files inside the Virtual Machine. Without this step your macOS disk image will only ever get larger and will not shrink even when you delete lots of data inside macOS. an the out-of-the-box first-start wizard to configure various
- To enable TRIM, open the Terminal application and type the following command followed by pressing <kbd>enter</kbd> to tell macos to use the TRIM command on the hard disk when files are deleted: options and set up your username and password
```bash - OPTIONAL: After you have concluded the out-of-the-box wizard, you
sudo trimforce enable may want to enable the TRIM feature that the computer industry
``` created for SSD disks. This feature in our macOS installation will
allow QuickEmu to compact (shrink) your macOS disk image whenever
you delete files inside the Virtual Machine. Without this step your
macOS disk image will only ever get larger and will not shrink even
when you delete lots of data inside macOS.
- To enable TRIM, open the Terminal application and type the
following command followed by pressing
command on the hard disk when files are deleted:
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" 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": ``` bash
sudo trimforce enable
```
```plain You will be prompted to enter your account's password to gain the
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. privilege needed. Once you've entered your password and pressed
Are you sure you with to proceed (y/N)? in the form of two questions that require you to type
``` response as though you said "no":
And a second confirmation once you've confirmed the previous one: ``` 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)?
```
```plain And a second confirmation once you've confirmed the previous one:
Your system will immediately reboot when this is complete.
Is this OK (y/N)?
```
As the last message states, your system will automatically reboot as soon as the command completes. ``` plain
Your system will immediately reboot when this is complete.
Is this OK (y/N)?
```
As the last message states, your system will automatically reboot as
soon as the command completes.
The default macOS configuration looks like this: The default macOS configuration looks like this:
@ -369,6 +385,8 @@ macos_release="catalina"
particular macOS release. particular macOS release.
- For example VirtIO Network and Memory Ballooning are available - For example VirtIO Network and Memory Ballooning are available
in Big Sur and newer, but not previous releases. in Big Sur and newer, but not previous releases.
- And VirtIO Block Media (disks) are supported/stable in Catalina
and newer.
### macOS compatibility ### macOS compatibility

2
build-docs

@ -1 +1 @@
Subproject commit 7cf8e3d597a1838d3ae21a2fa36297a736f35146 Subproject commit 83f2eab64f307de03be0f4ed5860c76f7883b7a7

73
docs/quickemu.1
View file

@ -14,7 +14,7 @@
. ftr VB CB . ftr VB CB
. ftr VBI CBI . ftr VBI CBI
.\} .\}
.TH "QUICKEMU" "1" "September 22, 2022" "quickemu" "Quickemu User Manual" .TH "QUICKEMU" "1" "October 21, 2022" "quickemu" "Quickemu User Manual"
.hy .hy
.SH NAME .SH NAME
.PP .PP
@ -335,6 +335,8 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2 .IP \[bu] 2
\f[V]android\f[R] (Android x86) \f[V]android\f[R] (Android x86)
.IP \[bu] 2 .IP \[bu] 2
\f[V]archcraft\f[R] (Archcraft)
.IP \[bu] 2
\f[V]archlinux\f[R] (Arch Linux) \f[V]archlinux\f[R] (Arch Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]arcolinux\f[R] (Arco Linux) \f[V]arcolinux\f[R] (Arco Linux)
@ -471,23 +473,10 @@ From \f[B]macOS Utilities\f[R]
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R] Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
On macOS Catalina, Big Sur & Monterey
.RS 2
.IP \[bu] 2
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[V]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]. click \f[B]Erase\f[R].
.RE
.RE
.IP \[bu] 2 .IP \[bu] 2
Enter a \f[V]Name:\f[R] for the disk Enter a \f[V]Name:\f[R] for the disk
.RS 2
.IP \[bu] 2 .IP \[bu] 2
If you are installing macOS Mojave or later (Catalina, Big Sur, and If you are installing macOS Mojave or later (Catalina, Big Sur, and
Monterey), choose any of the APFS options as the filesystem. Monterey), choose any of the APFS options as the filesystem.
@ -516,6 +505,58 @@ Installer\f[R]
On the subsequent reboots use cursor keys and enter key to select the On the subsequent reboots use cursor keys and enter key to select the
disk you named disk you named
.RE .RE
.IP \[bu] 2
Once you have finished installing macOS you will be presented with an
the out-of-the-box first-start wizard to configure various options and
set up your username and password
.IP \[bu] 2
OPTIONAL: After you have concluded the out-of-the-box wizard, you may
want to enable the TRIM feature that the computer industry created for
SSD disks.
This feature in our macOS installation will allow QuickEmu to compact
(shrink) your macOS disk image whenever you delete files inside the
Virtual Machine.
Without this step your macOS disk image will only ever get larger and
will not shrink even when you delete lots of data inside macOS.
.RS 2
.IP \[bu] 2
To enable TRIM, open the Terminal application and type the following
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]
sudo trimforce enable
\f[R]
.fi
.PP
You will be prompted to enter your account\[cq]s password to gain the
privilege needed.
Once you\[cq]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.
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]
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
.PP
And a second confirmation once you\[cq]ve confirmed the previous one:
.IP
.nf
\f[C]
Your system will immediately reboot when this is complete.
Is this OK (y/N)?
\f[R]
.fi
.PP
As the last message states, your system will automatically reboot as
soon as the command completes.
.PP .PP
The default macOS configuration looks like this: The default macOS configuration looks like this:
.IP .IP
@ -568,10 +609,6 @@ Optimised by default, but no GPU acceleration is available.
.IP \[bu] 2 .IP \[bu] 2
Host CPU vendor is detected and guest CPU is optimised accordingly. Host CPU vendor is detected and guest CPU is optimised accordingly.
.IP \[bu] 2 .IP \[bu] 2
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 VirtIO \f[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for
the mouse. the mouse.
.IP \[bu] 2 .IP \[bu] 2

59
docs/quickemu.1.md
View file

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: September 22, 2022 date: October 21, 2022
footer: quickemu footer: quickemu
header: Quickemu User Manual header: Quickemu User Manual
section: 1 section: 1
@ -259,6 +259,7 @@ with your preferred flavour.
- `alma` (Alma Linux) - `alma` (Alma Linux)
- `alpine` (Alpine Linux) - `alpine` (Alpine Linux)
- `android` (Android x86) - `android` (Android x86)
- `archcraft` (Archcraft)
- `archlinux` (Arch Linux) - `archlinux` (Arch Linux)
- `arcolinux` (Arco Linux) - `arcolinux` (Arco Linux)
- `batocera` (Batocera) - `batocera` (Batocera)
@ -340,13 +341,9 @@ supported.
- Use cursor keys and enter key to select the **macOS Base System** - Use cursor keys and enter key to select the **macOS Base System**
- From **macOS Utilities** - From **macOS Utilities**
- Click **Disk Utility** and **Continue** - Click **Disk Utility** and **Continue**
- On macOS Catalina, Big Sur & Monterey - Select `QEMU HARDDISK Media` (\~103.08GB) from the list and
- Select `Apple Inc. VirtIO Block Media` from the list and click **Erase**.
click **Erase**. - Enter a `Name:` for the disk
- On macOS Mojave and High Sierra
- Select `QEMU HARDDISK Media` (\~103.08GB) from the list
and click **Erase**.
- Enter a `Name:` for the disk
- If you are installing macOS Mojave or later (Catalina, Big - If you are installing macOS Mojave or later (Catalina, Big
Sur, and Monterey), choose any of the APFS options as the Sur, and Monterey), choose any of the APFS options as the
filesystem. MacOS Extended may not work. filesystem. MacOS Extended may not work.
@ -360,6 +357,49 @@ supported.
**macOS Installer** **macOS Installer**
- On the subsequent reboots use cursor keys and enter key to - On the subsequent reboots use cursor keys and enter key to
select the disk you named select the disk you named
- Once you have finished installing macOS you will be presented with
an the out-of-the-box first-start wizard to configure various
options and set up your username and password
- OPTIONAL: After you have concluded the out-of-the-box wizard, you
may want to enable the TRIM feature that the computer industry
created for SSD disks. This feature in our macOS installation will
allow QuickEmu to compact (shrink) your macOS disk image whenever
you delete files inside the Virtual Machine. Without this step your
macOS disk image will only ever get larger and will not shrink even
when you delete lots of data inside macOS.
- To enable TRIM, open the Terminal application and type the
following command followed by pressing
`<kbd>`{=html}enter`</kbd>`{=html} to tell macos to use the TRIM
command on the hard disk when files are deleted:
``` bash
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
`<kbd>`{=html}enter`</kbd>`{=html} the command will request confirmation
in the form of two questions that require you to type
`<kbd>`{=html}y`</kbd>`{=html} (for a "yes" response) followed by
`<kbd>`{=html}enter`</kbd>`{=html} to confirm. If you press
`<kbd>`{=html}enter`</kbd>`{=html} without first typing
`<kbd>`{=html}y`</kbd>`{=html} the 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:
``` plain
Your system will immediately reboot when this is complete.
Is this OK (y/N)?
```
As the last message states, your system will automatically reboot as
soon as the command completes.
The default macOS configuration looks like this: The default macOS configuration looks like this:
@ -394,9 +434,6 @@ There are some considerations when running macOS via Quickemu.
- Optimised by default, but no GPU acceleration is available. - Optimised by default, but no GPU acceleration is available.
- Host CPU vendor is detected and guest CPU is optimised - Host CPU vendor is detected and guest CPU is optimised
accordingly. accordingly.
- [VirtIO Block
Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
used for the system disk where supported.
- [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used - [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used
for the mouse. for the mouse.
- VirtIO Network (`virtio-net`) is supported and enabled on macOS - VirtIO Network (`virtio-net`) is supported and enabled on macOS

2
docs/quickemu_conf.1
View file

@ -14,7 +14,7 @@
. ftr VB CB . ftr VB CB
. ftr VBI CBI . ftr VBI CBI
.\} .\}
.TH "QUICKEMU_CONF" "1" "September 22, 2022" "quickemu_conf" "Quickemu Configuration Manual" .TH "QUICKEMU_CONF" "1" "October 21, 2022" "quickemu_conf" "Quickemu Configuration Manual"
.hy .hy
.SH NAME .SH NAME
.PP .PP

2
docs/quickemu_conf.1.md
View file

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: September 22, 2022 date: October 21, 2022
footer: quickemu_conf footer: quickemu_conf
header: Quickemu Configuration Manual header: Quickemu Configuration Manual
section: 1 section: 1

73
docs/quickget.1
View file

@ -14,7 +14,7 @@
. ftr VB CB . ftr VB CB
. ftr VBI CBI . ftr VBI CBI
.\} .\}
.TH "QUICKGET" "1" "September 22, 2022" "quickget" "Quickget User Manual" .TH "QUICKGET" "1" "October 21, 2022" "quickget" "Quickget User Manual"
.hy .hy
.SH NAME .SH NAME
.PP .PP
@ -117,6 +117,8 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2 .IP \[bu] 2
\f[V]android\f[R] (Android x86) \f[V]android\f[R] (Android x86)
.IP \[bu] 2 .IP \[bu] 2
\f[V]archcraft\f[R] (Archcraft)
.IP \[bu] 2
\f[V]archlinux\f[R] (Arch Linux) \f[V]archlinux\f[R] (Arch Linux)
.IP \[bu] 2 .IP \[bu] 2
\f[V]arcolinux\f[R] (Arco Linux) \f[V]arcolinux\f[R] (Arco Linux)
@ -253,23 +255,10 @@ From \f[B]macOS Utilities\f[R]
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R] Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
On macOS Catalina, Big Sur & Monterey
.RS 2
.IP \[bu] 2
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[V]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]. click \f[B]Erase\f[R].
.RE
.RE
.IP \[bu] 2 .IP \[bu] 2
Enter a \f[V]Name:\f[R] for the disk Enter a \f[V]Name:\f[R] for the disk
.RS 2
.IP \[bu] 2 .IP \[bu] 2
If you are installing macOS Mojave or later (Catalina, Big Sur, and If you are installing macOS Mojave or later (Catalina, Big Sur, and
Monterey), choose any of the APFS options as the filesystem. Monterey), choose any of the APFS options as the filesystem.
@ -298,6 +287,58 @@ Installer\f[R]
On the subsequent reboots use cursor keys and enter key to select the On the subsequent reboots use cursor keys and enter key to select the
disk you named disk you named
.RE .RE
.IP \[bu] 2
Once you have finished installing macOS you will be presented with an
the out-of-the-box first-start wizard to configure various options and
set up your username and password
.IP \[bu] 2
OPTIONAL: After you have concluded the out-of-the-box wizard, you may
want to enable the TRIM feature that the computer industry created for
SSD disks.
This feature in our macOS installation will allow QuickEmu to compact
(shrink) your macOS disk image whenever you delete files inside the
Virtual Machine.
Without this step your macOS disk image will only ever get larger and
will not shrink even when you delete lots of data inside macOS.
.RS 2
.IP \[bu] 2
To enable TRIM, open the Terminal application and type the following
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]
sudo trimforce enable
\f[R]
.fi
.PP
You will be prompted to enter your account\[cq]s password to gain the
privilege needed.
Once you\[cq]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.
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]
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
.PP
And a second confirmation once you\[cq]ve confirmed the previous one:
.IP
.nf
\f[C]
Your system will immediately reboot when this is complete.
Is this OK (y/N)?
\f[R]
.fi
.PP
As the last message states, your system will automatically reboot as
soon as the command completes.
.PP .PP
The default macOS configuration looks like this: The default macOS configuration looks like this:
.IP .IP
@ -350,10 +391,6 @@ Optimised by default, but no GPU acceleration is available.
.IP \[bu] 2 .IP \[bu] 2
Host CPU vendor is detected and guest CPU is optimised accordingly. Host CPU vendor is detected and guest CPU is optimised accordingly.
.IP \[bu] 2 .IP \[bu] 2
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 VirtIO \f[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for
the mouse. the mouse.
.IP \[bu] 2 .IP \[bu] 2

59
docs/quickget.1.md
View file

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: September 22, 2022 date: October 21, 2022
footer: quickget footer: quickget
header: Quickget User Manual header: Quickget User Manual
section: 1 section: 1
@ -91,6 +91,7 @@ with your preferred flavour.
- `alma` (Alma Linux) - `alma` (Alma Linux)
- `alpine` (Alpine Linux) - `alpine` (Alpine Linux)
- `android` (Android x86) - `android` (Android x86)
- `archcraft` (Archcraft)
- `archlinux` (Arch Linux) - `archlinux` (Arch Linux)
- `arcolinux` (Arco Linux) - `arcolinux` (Arco Linux)
- `batocera` (Batocera) - `batocera` (Batocera)
@ -172,13 +173,9 @@ supported.
- Use cursor keys and enter key to select the **macOS Base System** - Use cursor keys and enter key to select the **macOS Base System**
- From **macOS Utilities** - From **macOS Utilities**
- Click **Disk Utility** and **Continue** - Click **Disk Utility** and **Continue**
- On macOS Catalina, Big Sur & Monterey - Select `QEMU HARDDISK Media` (\~103.08GB) from the list and
- Select `Apple Inc. VirtIO Block Media` from the list and click **Erase**.
click **Erase**. - Enter a `Name:` for the disk
- On macOS Mojave and High Sierra
- Select `QEMU HARDDISK Media` (\~103.08GB) from the list
and click **Erase**.
- Enter a `Name:` for the disk
- If you are installing macOS Mojave or later (Catalina, Big - If you are installing macOS Mojave or later (Catalina, Big
Sur, and Monterey), choose any of the APFS options as the Sur, and Monterey), choose any of the APFS options as the
filesystem. MacOS Extended may not work. filesystem. MacOS Extended may not work.
@ -192,6 +189,49 @@ supported.
**macOS Installer** **macOS Installer**
- On the subsequent reboots use cursor keys and enter key to - On the subsequent reboots use cursor keys and enter key to
select the disk you named select the disk you named
- Once you have finished installing macOS you will be presented with
an the out-of-the-box first-start wizard to configure various
options and set up your username and password
- OPTIONAL: After you have concluded the out-of-the-box wizard, you
may want to enable the TRIM feature that the computer industry
created for SSD disks. This feature in our macOS installation will
allow QuickEmu to compact (shrink) your macOS disk image whenever
you delete files inside the Virtual Machine. Without this step your
macOS disk image will only ever get larger and will not shrink even
when you delete lots of data inside macOS.
- To enable TRIM, open the Terminal application and type the
following command followed by pressing
`<kbd>`{=html}enter`</kbd>`{=html} to tell macos to use the TRIM
command on the hard disk when files are deleted:
``` bash
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
`<kbd>`{=html}enter`</kbd>`{=html} the command will request confirmation
in the form of two questions that require you to type
`<kbd>`{=html}y`</kbd>`{=html} (for a "yes" response) followed by
`<kbd>`{=html}enter`</kbd>`{=html} to confirm. If you press
`<kbd>`{=html}enter`</kbd>`{=html} without first typing
`<kbd>`{=html}y`</kbd>`{=html} the 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:
``` plain
Your system will immediately reboot when this is complete.
Is this OK (y/N)?
```
As the last message states, your system will automatically reboot as
soon as the command completes.
The default macOS configuration looks like this: The default macOS configuration looks like this:
@ -226,9 +266,6 @@ There are some considerations when running macOS via Quickemu.
- Optimised by default, but no GPU acceleration is available. - Optimised by default, but no GPU acceleration is available.
- Host CPU vendor is detected and guest CPU is optimised - Host CPU vendor is detected and guest CPU is optimised
accordingly. accordingly.
- [VirtIO Block
Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
used for the system disk where supported.
- [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used - [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used
for the mouse. for the mouse.
- VirtIO Network (`virtio-net`) is supported and enabled on macOS - VirtIO Network (`virtio-net`) is supported and enabled on macOS