From bea27b1ffa4491abde8bf94ed2dcb0dd9d744d27 Mon Sep 17 00:00:00 2001 From: Phil Clifford Date: Sun, 14 Apr 2024 03:05:42 +0100 Subject: [PATCH] Further markdown linting and standartisation of fencing --- .gitignore | 3 + README.md | 76 +++++++++++++------------ build-docs | 2 +- docs/quickemu.1 | 6 +- docs/quickemu.1.md | 122 +++++++++++++++++++++------------------- docs/quickemu_conf.1 | 10 ++-- docs/quickemu_conf.1.md | 12 ++-- docs/quickget.1 | 2 +- docs/quickget.1.md | 24 ++++---- 9 files changed, 134 insertions(+), 123 deletions(-) diff --git a/.gitignore b/.gitignore index ce23a7f..c1d18e8 100644 --- a/.gitignore +++ b/.gitignore @@ -2,10 +2,13 @@ *.conf *.dmg *.fd +*.fixed *.img *.iso *.lock *.log +*.markdownlint.jsonc +*.markdownlint.yaml *.msi *.part *.permall diff --git a/README.md b/README.md index 0f30161..f41709c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ -```bash +``` shell quickget ubuntu-mate 22.04 quickemu --vm ubuntu-mate-22.04.conf ``` @@ -17,7 +17,7 @@ quickemu --vm ubuntu-mate-22.04.conf Quickemu Screenshot -**Made with 💝 for .** +**Made with 💝 for Tux (Linux).** Quickemu is available in the repositories of the following distros (packaging status by [Repology.org](https://repology.org/)): @@ -59,7 +59,9 @@ The original objective of the project was to enable [quick testing of Linux distributions](#creating-linux-guests-) where the virtual machine configurations can be stored anywhere (such as external USB storage or your home directory) and no elevated permissions are required to run the -virtual machines. **Quickemu now also includes comprehensive support for +virtual machines. + +**Quickemu now also includes comprehensive support for [macOS](#creating-macos-guests-) and [Windows](#creating-windows-guests-)**. @@ -97,7 +99,7 @@ Quickemu is available from the AUR (Arch user repository), and can be installed via any AUR helper. Assuming your AUR helper is yay, Run the following command: -``` bash +``` shell yay -Sy quickemu ``` @@ -108,7 +110,7 @@ project's GitHub releases page](https://github.com/quickemu-project/quickemu/releases). Download the .deb and install it with `apt-get`. -``` bash +``` shell sudo apt-get install ./quickemu_x.y.z-1_all.deb ``` @@ -119,7 +121,7 @@ includes a back port of QEMU 6.0.0 for 20.04 (Focal) and 21.04 (Hirsute). To install Quickemu and all the dependencies run the following in a terminal: -``` bash +``` shell sudo apt-add-repository ppa:flexiondotorg/quickemu sudo apt update sudo apt install quickemu @@ -129,13 +131,13 @@ sudo apt install quickemu To quickly try quickemu: -``` sh +``` shell nix-shell -p quickemu ``` To install via Nix profile: -``` sh +``` shell nix-env -iA pkgs.quickemu ``` @@ -152,13 +154,13 @@ To install via NixOS config: To install via Flakes: -``` sh +``` shell # TODO (flake users, please add an example!) ``` ### Other Linux hosts (installing from source) -``` bash +``` shell git clone --filter=blob:none https://github.com/wimpysworld/quickemu cd quickemu ``` @@ -204,13 +206,13 @@ These examples may save a little typing: This also applies to derivatives: -``` sh +``` shell sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed socat spice-client-gtk libtss2-tcti-swtpm0 wget xdg-user-dirs zsync unzip ``` #### Install requirements on Fedora hosts -``` sh +``` shell sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed socat spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip ``` @@ -220,7 +222,7 @@ 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) -``` sh +``` shell brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync ``` @@ -235,7 +237,7 @@ graphical user interface is also available: To install Quickgui on Ubuntu: -``` sh +``` shell sudo add-apt-repository ppa:yannick-mauray/quickgui sudo apt update sudo apt install quickgui @@ -265,7 +267,7 @@ installations, snapshots and disk management `quickget` will automatically download an Ubuntu release and create the virtual machine configuration. -``` bash +``` shell quickget ubuntu 22.04 quickemu --vm ubuntu-22.04.conf ``` @@ -284,7 +286,7 @@ quickemu --vm ubuntu-22.04.conf `quickget` can also download/refresh daily-live images via `zsync` for Ubuntu developers and testers. -``` bash +``` shell quickget ubuntu daily-live quickemu --vm ubuntu-daily-live.conf ``` @@ -418,7 +420,7 @@ configuration. - Download a .iso image of a Linux distribution - Create a VM configuration file; for example `debian-bullseye.conf` -``` bash +``` shell guest_os="linux" disk_img="debian-bullseye/disk.qcow2" iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" @@ -426,7 +428,7 @@ iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" - Use `quickemu` to start the virtual machine: -``` bash +``` shell quickemu --vm debian-bullseye.conf ``` @@ -442,7 +444,7 @@ quickemu --vm debian-bullseye.conf `quickget` automatically downloads a macOS recovery image and creates a virtual machine configuration. -``` bash +``` shell quickget macos catalina quickemu --vm macos-catalina.conf ``` @@ -484,7 +486,7 @@ macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey`, following command followed by pressing command on the hard disk when files are deleted: -``` bash +``` shell sudo trimforce enable ``` @@ -510,7 +512,7 @@ soon as the command completes. The default macOS configuration looks like this: -``` bash +``` shell guest_os="macos" img="macos-catalina/RecoveryImage.img" disk_img="macos-catalina/disk.qcow2" @@ -578,7 +580,7 @@ If the wired ethernet device is not `en0`, then then go to *System Preferences* -\> *Network*, delete all the network devices and apply the changes. Next, open a terminal and run the following: -``` bash +``` shell sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist ``` @@ -606,7 +608,7 @@ and [2022](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022). No automated installation is supported for these releases. -``` bash +``` shell quickget windows 11 quickemu --vm windows-11.conf ``` @@ -624,13 +626,13 @@ By default `quickget` will download the *"English International"* release (*"English (United States)"* for server releases), but you can optionally specify one of the supported languages: For example: -``` bash +``` shell quickget windows 11 "Chinese (Traditional)" ``` The default Windows 11 configuration looks like this: -``` bash +``` shell guest_os="windows" disk_img="windows-11/disk.qcow2" iso="windows-11/windows-11.iso" @@ -658,7 +660,7 @@ To use SPICE add `--display spice` to the Quickemu invocation, this requires that the `spicy` client is installed, available from the `spice-client-gtk` package in Debian/Ubuntu. -``` bash +``` shell quickemu --vm ubuntu-22.04.conf --display spice ``` @@ -672,14 +674,14 @@ To start a VM with SPICE enabled, but no display attached use available from the `spice-client-gtk` package in Debian/Ubuntu to connect to the running VM -``` bash +``` shell quickemu --vm ubuntu-22.04.conf --display none ``` You can also use the `.ports` file in the VM directory to lookup what SSH and SPICE ports the VM is connected to. -``` bash +``` shell cat ubuntu-22.04/ubuntu-22.04.ports ``` @@ -687,7 +689,7 @@ If, for example, the SSH port is set to 22220, and assuming your VM has a started SSH service (details vary by OS), you can typically SSH into it from the host as follows: -``` bash +``` shell ssh -p 22220 your_vm_user@localhost ``` @@ -696,7 +698,7 @@ ssh -p 22220 your_vm_user@localhost Qemu provides support for using BrlAPI to display braille output on a real or fake device. -``` bash +``` shell quickemu --vm ubuntu-22.04.conf --braille --display sdl ``` @@ -763,7 +765,7 @@ the guest. You can install the minimal Samba components on Ubuntu using: -``` bash +``` shell sudo apt install --no-install-recommends samba ``` @@ -905,10 +907,10 @@ import cog # cannot use check_result() because of non-zero return result=subprocess.run(["./quickemu", "--help"], capture_output=True, text=True) help=result.stdout -cog.out(f"\n```\n{help}\n```\n") +cog.out(f"\n``` text\n{help}\n```\n") ]]] --> -``` +``` text Usage quickemu --vm ubuntu.conf [optional params] @@ -959,7 +961,7 @@ Desktop shortcuts can be created for a VM, the shortcuts are saved in `~/.local/share/applications`. Here is an example of how to create a shortcut. -``` bash +``` shell quickemu --vm ubuntu-22.04-desktop.conf --shortcut ``` @@ -984,13 +986,13 @@ must match the resolution of the screen. To know which screen to use, type: -``` bash +``` shell xrandr --listmonitors | grep -v Monitors ``` The command will output something like this: -``` bash +``` shell 0: +*HDMI-0 2560/597x1440/336+1920+0 HDMI-0 1: +DVI-D-0 1920/527x1080/296+0+0 DVI-D-0 ``` @@ -999,7 +1001,7 @@ The first number is what needs to be passed to the `--screen` option. For example: -``` bash +``` shell quickemu --vm vm.conf --screen 0 ``` diff --git a/build-docs b/build-docs index d851e47..6bde83b 160000 --- a/build-docs +++ b/build-docs @@ -1 +1 @@ -Subproject commit d851e47195635c83c9b5981959cf64830a228320 +Subproject commit 6bde83bf7c61ffd9f1de06503c03345c244be712 diff --git a/docs/quickemu.1 b/docs/quickemu.1 index 756add7..9448ee5 100644 --- a/docs/quickemu.1 +++ b/docs/quickemu.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 3.1.13 .\" -.TH "QUICKEMU" "1" "April 13, 2024" "quickemu" "Quickemu User Manual" +.TH "QUICKEMU" "1" "April 14, 2024" "quickemu" "Quickemu User Manual" .SH NAME quickemu \- A quick VM builder and manager .SH SYNOPSIS @@ -156,6 +156,7 @@ The original objective of the project was to enable quick testing of Linux distributions where the virtual machine configurations can be stored anywhere (such as external USB storage or your home directory) and no elevated permissions are required to run the virtual machines. +.PP \f[B]Quickemu now also includes comprehensive support for macOS and Windows\f[R]. .SS Features @@ -1022,6 +1023,7 @@ software emulated TPM device using \f[CR]swtpm\f[R]. Here are the usage instructions: .IP .EX + Usage quickemu \-\-vm ubuntu.conf [optional params] @@ -1094,7 +1096,7 @@ VM\[cq]s window must match the resolution of the screen. To know which screen to use, type: .IP .EX -xrandr \-\-listmonitors \f[B]|\f[R] grep \-v Monitors +xrandr \-\-listmonitors | grep \-v Monitors .EE .PP The command will output something like this: diff --git a/docs/quickemu.1.md b/docs/quickemu.1.md index 6d9ed7d..1ad0ca0 100644 --- a/docs/quickemu.1.md +++ b/docs/quickemu.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: April 13, 2024 +date: April 14, 2024 footer: quickemu header: Quickemu User Manual section: 1 @@ -156,7 +156,9 @@ The original objective of the project was to enable [quick testing of Linux distributions](#creating-linux-guests-) where the virtual machine configurations can be stored anywhere (such as external USB storage or your home directory) and no elevated permissions are required to run the -virtual machines. **Quickemu now also includes comprehensive support for +virtual machines. + +**Quickemu now also includes comprehensive support for [macOS](#creating-macos-guests-) and [Windows](#creating-windows-guests-)**. @@ -227,13 +229,13 @@ These examples may save a little typing: This also applies to derivatives: -``` sh +``` shell sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed socat spice-client-gtk libtss2-tcti-swtpm0 wget xdg-user-dirs zsync unzip ``` #### Install requirements on Fedora hosts -``` sh +``` shell sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed socat spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip ``` @@ -243,7 +245,7 @@ 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) -``` sh +``` shell brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync ``` @@ -258,7 +260,7 @@ graphical user interface is also available: To install Quickgui on Ubuntu: -``` sh +``` shell sudo add-apt-repository ppa:yannick-mauray/quickgui sudo apt update sudo apt install quickgui @@ -288,7 +290,7 @@ installations, snapshots and disk management `quickget` will automatically download an Ubuntu release and create the virtual machine configuration. -``` bash +``` shell quickget ubuntu 22.04 quickemu --vm ubuntu-22.04.conf ``` @@ -307,7 +309,7 @@ quickemu --vm ubuntu-22.04.conf `quickget` can also download/refresh daily-live images via `zsync` for Ubuntu developers and testers. -``` bash +``` shell quickget ubuntu daily-live quickemu --vm ubuntu-daily-live.conf ``` @@ -441,7 +443,7 @@ configuration. - Download a .iso image of a Linux distribution - Create a VM configuration file; for example `debian-bullseye.conf` -``` bash +``` shell guest_os="linux" disk_img="debian-bullseye/disk.qcow2" iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" @@ -449,7 +451,7 @@ iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" - Use `quickemu` to start the virtual machine: -``` bash +``` shell quickemu --vm debian-bullseye.conf ``` @@ -465,7 +467,7 @@ quickemu --vm debian-bullseye.conf `quickget` automatically downloads a macOS recovery image and creates a virtual machine configuration. -``` bash +``` shell quickget macos catalina quickemu --vm macos-catalina.conf ``` @@ -507,7 +509,7 @@ macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey`, following command followed by pressing command on the hard disk when files are deleted: -``` bash +``` shell sudo trimforce enable ``` @@ -533,7 +535,7 @@ soon as the command completes. The default macOS configuration looks like this: -``` bash +``` shell guest_os="macos" img="macos-catalina/RecoveryImage.img" disk_img="macos-catalina/disk.qcow2" @@ -601,7 +603,7 @@ If the wired ethernet device is not `en0`, then then go to *System Preferences* -\> *Network*, delete all the network devices and apply the changes. Next, open a terminal and run the following: -``` bash +``` shell sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist ``` @@ -629,7 +631,7 @@ and [2022](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022). No automated installation is supported for these releases. -``` bash +``` shell quickget windows 11 quickemu --vm windows-11.conf ``` @@ -647,13 +649,13 @@ By default `quickget` will download the *"English International"* release (*"English (United States)"* for server releases), but you can optionally specify one of the supported languages: For example: -``` bash +``` shell quickget windows 11 "Chinese (Traditional)" ``` The default Windows 11 configuration looks like this: -``` bash +``` shell guest_os="windows" disk_img="windows-11/disk.qcow2" iso="windows-11/windows-11.iso" @@ -671,46 +673,48 @@ secureboot="off" Here are the usage instructions: +``` text - Usage - quickemu --vm ubuntu.conf [optional params] +Usage + quickemu --vm ubuntu.conf [optional params] - List of optional parameters: - --access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress' - --braille : Enable braille support. Requires SDL. - --delete-disk : Delete the disk image and EFI variables - --delete-vm : Delete the entire VM and it's configuration - --display : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app' - --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit) - --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers - --screen : Use specified screen to determine the window size. - --screenpct : Percent of fullscreen for VM if --fullscreen is not specified. - --shortcut : Create a desktop shortcut - --snapshot apply : Apply/restore a snapshot. - --snapshot create : Create a snapshot. - --snapshot delete : Delete a snapshot. - --snapshot info : Show disk/snapshot info. - --status-quo : Do not commit any changes to disk/snapshot. - --viewer : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' - --width : Set VM screen width. Does nothing without --height - --height : Set VM screen height. Does nothing without --width - --ssh-port : Set ssh-port manually - --spice-port : Set spice-port manually - --public-dir : Expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '', 'none' - --monitor : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none' - --monitor-telnet-host : Set telnet host for monitor. (default: 'localhost') - --monitor-telnet-port : Set telnet port for monitor. (default: '4440') - --monitor-cmd : Send command to monitor if available. (Example: system_powerdown) - --serial : Set serial connection type. @Options: 'socket' (default), 'telnet', 'none' - --serial-telnet-host : Set telnet host for serial. (default: 'localhost') - --serial-telnet-port : Set telnet port for serial. (default: '6660') - --keyboard : Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio' - --keyboard_layout : Set keyboard layout. - --mouse : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio' - --usb-controller : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none' - --sound-card : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'none' - --extra_args : Pass additional arguments to qemu - --version : Print version +List of optional parameters: + --access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress' + --braille : Enable braille support. Requires SDL. + --delete-disk : Delete the disk image and EFI variables + --delete-vm : Delete the entire VM and it's configuration + --display : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app' + --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit) + --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers + --screen : Use specified screen to determine the window size. + --screenpct : Percent of fullscreen for VM if --fullscreen is not specified. + --shortcut : Create a desktop shortcut + --snapshot apply : Apply/restore a snapshot. + --snapshot create : Create a snapshot. + --snapshot delete : Delete a snapshot. + --snapshot info : Show disk/snapshot info. + --status-quo : Do not commit any changes to disk/snapshot. + --viewer : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' + --width : Set VM screen width. Does nothing without --height + --height : Set VM screen height. Does nothing without --width + --ssh-port : Set ssh-port manually + --spice-port : Set spice-port manually + --public-dir : Expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '', 'none' + --monitor : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none' + --monitor-telnet-host : Set telnet host for monitor. (default: 'localhost') + --monitor-telnet-port : Set telnet port for monitor. (default: '4440') + --monitor-cmd : Send command to monitor if available. (Example: system_powerdown) + --serial : Set serial connection type. @Options: 'socket' (default), 'telnet', 'none' + --serial-telnet-host : Set telnet host for serial. (default: 'localhost') + --serial-telnet-port : Set telnet port for serial. (default: '6660') + --keyboard : Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio' + --keyboard_layout : Set keyboard layout. + --mouse : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio' + --usb-controller : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none' + --sound-card : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'none' + --extra_args : Pass additional arguments to qemu + --version : Print version +``` ## Desktop shortcuts @@ -718,7 +722,7 @@ Desktop shortcuts can be created for a VM, the shortcuts are saved in `~/.local/share/applications`. Here is an example of how to create a shortcut. -``` bash +``` shell quickemu --vm ubuntu-22.04-desktop.conf --shortcut ``` @@ -743,13 +747,13 @@ must match the resolution of the screen. To know which screen to use, type: -``` bash +``` shell xrandr --listmonitors | grep -v Monitors ``` The command will output something like this: -``` bash +``` shell 0: +*HDMI-0 2560/597x1440/336+1920+0 HDMI-0 1: +DVI-D-0 1920/527x1080/296+0+0 DVI-D-0 ``` @@ -758,7 +762,7 @@ The first number is what needs to be passed to the `--screen` option. For example: -``` bash +``` shell quickemu --vm vm.conf --screen 0 ``` diff --git a/docs/quickemu_conf.1 b/docs/quickemu_conf.1 index 14cb642..6650076 100644 --- a/docs/quickemu_conf.1 +++ b/docs/quickemu_conf.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 3.1.13 .\" -.TH "QUICKEMU_CONF" "1" "April 13, 2024" "quickemu_conf" "Quickemu Configuration Manual" +.TH "QUICKEMU_CONF" "1" "April 14, 2024" "quickemu_conf" "Quickemu Configuration Manual" .SH NAME quickemu_conf \- Options and parameters in the quickemu .conf .SH DESCRIPTION @@ -14,7 +14,7 @@ VM These are the options and defaults for the .conf file .IP .EX -\f[I]# Lowercase variables are used in the VM config file only\f[R] +# Lowercase variables are used in the VM config file only boot=\[dq]efi\[dq] cpu_cores=\[dq]\[dq] disk_img=\[dq]\[dq] @@ -46,12 +46,12 @@ monitor_cmd=\[dq]\[dq] serial=\[dq]socket\[dq] serial_telnet_port=\[dq]6660\[dq] serial_telnet_host=\[dq]localhost\[dq] -\f[I]# options: ehci(USB2.0), xhci(USB3.0)\f[R] +# options: ehci(USB2.0), xhci(USB3.0) usb_controller=\[dq]ehci\[dq] -\f[I]# options: ps2, usb, virtio\f[R] +# options: ps2, usb, virtio keyboard=\[dq]usb\[dq] keyboard_layout=\[dq]en\-us\[dq] -\f[I]# options: ps2, usb, tablet, virtio\f[R] +# options: ps2, usb, tablet, virtio mouse=\[dq]tablet\[dq] .EE .SH EXAMPLES diff --git a/docs/quickemu_conf.1.md b/docs/quickemu_conf.1.md index 0bdc67b..7972fd7 100644 --- a/docs/quickemu_conf.1.md +++ b/docs/quickemu_conf.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: April 13, 2024 +date: April 14, 2024 footer: quickemu_conf header: Quickemu Configuration Manual section: 1 @@ -23,7 +23,7 @@ installation ISO and QEMU disk for the installed VM These are the options and defaults for the \.conf file -``` bash +``` shell # Lowercase variables are used in the VM config file only boot="efi" cpu_cores="" @@ -67,7 +67,7 @@ mouse="tablet" # EXAMPLES -``` bash +``` shell guest_os="linux" disk_img="debian-bullseye/disk.qcow2" iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" @@ -75,7 +75,7 @@ iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" The default macOS configuration looks like this: -``` bash +``` shell guest_os="macos" img="macos-catalina/RecoveryImage.img" disk_img="macos-catalina/disk.qcow2" @@ -92,7 +92,7 @@ macos_release="catalina" The default Windows 11 configuration looks like this: -``` bash +``` shell guest_os="windows" disk_img="windows-11/disk.qcow2" iso="windows-11/Win11_EnglishInternational_x64.iso" @@ -169,7 +169,7 @@ the guest. You can install the minimal Samba components on Ubuntu using: -``` bash +``` shell sudo apt install --no-install-recommends samba ``` diff --git a/docs/quickget.1 b/docs/quickget.1 index 23ad28e..937f3d1 100644 --- a/docs/quickget.1 +++ b/docs/quickget.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 3.1.13 .\" -.TH "QUICKGET" "1" "April 13, 2024" "quickget" "Quickget User Manual" +.TH "QUICKGET" "1" "April 14, 2024" "quickget" "Quickget User Manual" .SH NAME quickget \- download and prepare materials for building a quickemu VM .SH SYNOPSIS diff --git a/docs/quickget.1.md b/docs/quickget.1.md index 5fa78bf..cf86687 100644 --- a/docs/quickget.1.md +++ b/docs/quickget.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: April 13, 2024 +date: April 14, 2024 footer: quickget header: Quickget User Manual section: 1 @@ -53,7 +53,7 @@ configuration for `quickemu` to use to build and run `quickget` will automatically download an Ubuntu release and create the virtual machine configuration. -``` bash +``` shell quickget ubuntu 22.04 quickemu --vm ubuntu-22.04.conf ``` @@ -72,7 +72,7 @@ quickemu --vm ubuntu-22.04.conf `quickget` can also download/refresh daily-live images via `zsync` for Ubuntu developers and testers. -``` bash +``` shell quickget ubuntu daily-live quickemu --vm ubuntu-daily-live.conf ``` @@ -206,7 +206,7 @@ configuration. - Download a .iso image of a Linux distribution - Create a VM configuration file; for example `debian-bullseye.conf` -``` bash +``` shell guest_os="linux" disk_img="debian-bullseye/disk.qcow2" iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" @@ -214,7 +214,7 @@ iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" - Use `quickemu` to start the virtual machine: -``` bash +``` shell quickemu --vm debian-bullseye.conf ``` @@ -230,7 +230,7 @@ quickemu --vm debian-bullseye.conf `quickget` automatically downloads a macOS recovery image and creates a virtual machine configuration. -``` bash +``` shell quickget macos catalina quickemu --vm macos-catalina.conf ``` @@ -272,7 +272,7 @@ macOS `high-sierra`, `mojave`, `catalina`, `big-sur`, `monterey`, following command followed by pressing command on the hard disk when files are deleted: -``` bash +``` shell sudo trimforce enable ``` @@ -298,7 +298,7 @@ soon as the command completes. The default macOS configuration looks like this: -``` bash +``` shell guest_os="macos" img="macos-catalina/RecoveryImage.img" disk_img="macos-catalina/disk.qcow2" @@ -366,7 +366,7 @@ If the wired ethernet device is not `en0`, then then go to *System Preferences* -\> *Network*, delete all the network devices and apply the changes. Next, open a terminal and run the following: -``` bash +``` shell sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist ``` @@ -394,7 +394,7 @@ and [2022](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022). No automated installation is supported for these releases. -``` bash +``` shell quickget windows 11 quickemu --vm windows-11.conf ``` @@ -412,13 +412,13 @@ By default `quickget` will download the *"English International"* release (*"English (United States)"* for server releases), but you can optionally specify one of the supported languages: For example: -``` bash +``` shell quickget windows 11 "Chinese (Traditional)" ``` The default Windows 11 configuration looks like this: -``` bash +``` shell guest_os="windows" disk_img="windows-11/disk.qcow2" iso="windows-11/windows-11.iso"