From 422130293602524e9a9cc68eccbf19e5470e94b2 Mon Sep 17 00:00:00 2001 From: Phil Clifford Date: Wed, 14 Jun 2023 11:25:36 +0100 Subject: [PATCH 1/2] docs: regenerated to auto-update --- README.md | 3 +++ build-docs | 2 +- docs/quickemu.1 | 12 ++++++++---- docs/quickemu.1.md | 5 ++++- docs/quickemu_conf.1 | 12 ++++++------ docs/quickemu_conf.1.md | 2 +- docs/quickget.1 | 8 ++++++-- docs/quickget.1.md | 4 +++- 8 files changed, 32 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0792f89..ebd0c08 100644 --- a/README.md +++ b/README.md @@ -225,6 +225,7 @@ with your preferred flavour. - `ubuntucinnamon` (Ubuntu Cinnamon) - `ubuntukylin` (Ubuntu Kylin) - `ubuntu-mate` (Ubuntu MATE) +- `ubuntu-server` (Ubuntu Server) - `ubuntustudio` (Ubuntu Studio) - `ubuntu` (Ubuntu) - `ubuntu-unity` (Ubuntu Unity) @@ -286,6 +287,7 @@ with your preferred flavour. - `vanillaos` (Vanilla OS) - `void` (Void Linux) - `vxlinux` (VX Linux) +- `xerolinux` (XeroLinux) - `zorin` (Zorin OS) Or you can download a Linux image and manually create a VM @@ -754,6 +756,7 @@ You can also pass optional parameters --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. diff --git a/build-docs b/build-docs index a84af78..e8d977b 160000 --- a/build-docs +++ b/build-docs @@ -1 +1 @@ -Subproject commit a84af781b86758ab0e6c7eba58155f1ea3f7eafb +Subproject commit e8d977ba8e4c18ed0760da5d7491e645aaab82c5 diff --git a/docs/quickemu.1 b/docs/quickemu.1 index fa8d96c..a3ff2be 100644 --- a/docs/quickemu.1 +++ b/docs/quickemu.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.19.2 +.\" Automatically generated by Pandoc 3.1.1 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "QUICKEMU" "1" "April 30, 2023" "quickemu" "Quickemu User Manual" +.TH "QUICKEMU" "1" "June 14, 2023" "quickemu" "Quickemu User Manual" .hy .SH NAME .PP @@ -248,8 +248,7 @@ Mauray (https://github.com/ymauray). .PP Many thanks to Luke Wesley-Holley (https://github.com/Lukewh) and Philipp Kiemle (https://github.com/daPhipz) for creating the -\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R] -\[u1F3A8] +\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R] 🎨 .SS Quickgui for Ubuntu .IP .nf @@ -322,6 +321,8 @@ All the official Ubuntu flavours are supported, just replace .IP \[bu] 2 \f[V]ubuntu-mate\f[R] (Ubuntu MATE) .IP \[bu] 2 +\f[V]ubuntu-server\f[R] (Ubuntu Server) +.IP \[bu] 2 \f[V]ubuntustudio\f[R] (Ubuntu Studio) .IP \[bu] 2 \f[V]ubuntu\f[R] (Ubuntu) @@ -437,6 +438,8 @@ All the official Ubuntu flavours are supported, just replace .IP \[bu] 2 \f[V]vxlinux\f[R] (VX Linux) .IP \[bu] 2 +\f[V]xerolinux\f[R] (XeroLinux) +.IP \[bu] 2 \f[V]zorin\f[R] (Zorin OS) .PP Or you can download a Linux image and manually create a VM @@ -760,6 +763,7 @@ You can also pass optional parameters --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. diff --git a/docs/quickemu.1.md b/docs/quickemu.1.md index 61361e2..0e13c87 100644 --- a/docs/quickemu.1.md +++ b/docs/quickemu.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: April 30, 2023 +date: June 14, 2023 footer: quickemu header: Quickemu User Manual section: 1 @@ -249,6 +249,7 @@ with your preferred flavour. - `ubuntucinnamon` (Ubuntu Cinnamon) - `ubuntukylin` (Ubuntu Kylin) - `ubuntu-mate` (Ubuntu MATE) +- `ubuntu-server` (Ubuntu Server) - `ubuntustudio` (Ubuntu Studio) - `ubuntu` (Ubuntu) - `ubuntu-unity` (Ubuntu Unity) @@ -310,6 +311,7 @@ with your preferred flavour. - `vanillaos` (Vanilla OS) - `void` (Void Linux) - `vxlinux` (VX Linux) +- `xerolinux` (XeroLinux) - `zorin` (Zorin OS) Or you can download a Linux image and manually create a VM @@ -542,6 +544,7 @@ Here are the usage instructions: --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. diff --git a/docs/quickemu_conf.1 b/docs/quickemu_conf.1 index f5bd66f..2e56c8f 100644 --- a/docs/quickemu_conf.1 +++ b/docs/quickemu_conf.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.19.2 +.\" Automatically generated by Pandoc 3.1.1 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "QUICKEMU_CONF" "1" "April 30, 2023" "quickemu_conf" "Quickemu Configuration Manual" +.TH "QUICKEMU_CONF" "1" "June 14, 2023" "quickemu_conf" "Quickemu Configuration Manual" .hy .SH NAME .PP @@ -183,7 +183,7 @@ To do so add the following line to the VM configuration: .PP All File Sharing options will only expose \f[V]\[ti]/Public\f[R] (or localised variations) for the current user to the guest VMs. -.SS Samba \[u1F427] \[u1F34F] \[u1FA9F] +.SS Samba 🐧 🍏 🪟 .PP If \f[V]smbd\f[R] is available on the host, Quickemu will automatically enable the built-in QEMU support for exposing a Samba share from the @@ -211,10 +211,10 @@ If using a Windows guest, right-click on \[lq]This PC\[rq], click \[lq]Add a network location\[rq], and paste this address, removing \f[V]smb:\f[R] and replacing forward slashes with backslashes (in this example \f[V]\[rs]\[rs]10.0.2.4\[rs]qemu\f[R]). -.SS SPICE WebDAV \[u1F427] \[u1FA9F] +.SS SPICE WebDAV 🐧 🪟 .IP \[bu] 2 TBD -.SS VirtIO-9P \[u1F427] \[u1F34F] +.SS VirtIO-9P 🐧 🍏 .IP \[bu] 2 TBD .SH Network port forwarding @@ -301,7 +301,7 @@ like this: - USB: Host pass-through requested: - Sennheiser Communications EPOS GTW 270 on bus 001 device 005 needs permission changes: sudo chown -v root:user /dev/bus/usb/001/005 - ERROR! USB permission changes are required \[u1F446] + ERROR! USB permission changes are required 👆 \f[R] .fi .SH TPM diff --git a/docs/quickemu_conf.1.md b/docs/quickemu_conf.1.md index afddeec..18ca1c3 100644 --- a/docs/quickemu_conf.1.md +++ b/docs/quickemu_conf.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: April 30, 2023 +date: June 14, 2023 footer: quickemu_conf header: Quickemu Configuration Manual section: 1 diff --git a/docs/quickget.1 b/docs/quickget.1 index ba743d1..67a528b 100644 --- a/docs/quickget.1 +++ b/docs/quickget.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.19.2 +.\" Automatically generated by Pandoc 3.1.1 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "QUICKGET" "1" "April 30, 2023" "quickget" "Quickget User Manual" +.TH "QUICKGET" "1" "June 14, 2023" "quickget" "Quickget User Manual" .hy .SH NAME .PP @@ -104,6 +104,8 @@ All the official Ubuntu flavours are supported, just replace .IP \[bu] 2 \f[V]ubuntu-mate\f[R] (Ubuntu MATE) .IP \[bu] 2 +\f[V]ubuntu-server\f[R] (Ubuntu Server) +.IP \[bu] 2 \f[V]ubuntustudio\f[R] (Ubuntu Studio) .IP \[bu] 2 \f[V]ubuntu\f[R] (Ubuntu) @@ -219,6 +221,8 @@ All the official Ubuntu flavours are supported, just replace .IP \[bu] 2 \f[V]vxlinux\f[R] (VX Linux) .IP \[bu] 2 +\f[V]xerolinux\f[R] (XeroLinux) +.IP \[bu] 2 \f[V]zorin\f[R] (Zorin OS) .PP Or you can download a Linux image and manually create a VM diff --git a/docs/quickget.1.md b/docs/quickget.1.md index a52b6aa..fbe6331 100644 --- a/docs/quickget.1.md +++ b/docs/quickget.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: April 30, 2023 +date: June 14, 2023 footer: quickget header: Quickget User Manual section: 1 @@ -81,6 +81,7 @@ with your preferred flavour. - `ubuntucinnamon` (Ubuntu Cinnamon) - `ubuntukylin` (Ubuntu Kylin) - `ubuntu-mate` (Ubuntu MATE) +- `ubuntu-server` (Ubuntu Server) - `ubuntustudio` (Ubuntu Studio) - `ubuntu` (Ubuntu) - `ubuntu-unity` (Ubuntu Unity) @@ -142,6 +143,7 @@ with your preferred flavour. - `vanillaos` (Vanilla OS) - `void` (Void Linux) - `vxlinux` (VX Linux) +- `xerolinux` (XeroLinux) - `zorin` (Zorin OS) Or you can download a Linux image and manually create a VM From 51a6502a79188eddd1bffa831599a145afae6d51 Mon Sep 17 00:00:00 2001 From: Phil Clifford Date: Wed, 14 Jun 2023 11:45:23 +0100 Subject: [PATCH 2/2] docs: additional note explaining --screenpct Co-authored-by: dabrown645 dabrown645@users.noreply.github.com --- README.md | 5 +++++ build-docs | 2 +- docs/quickemu.1 | 6 ++++++ docs/quickemu.1.md | 5 +++++ 4 files changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ebd0c08..e1f3b20 100644 --- a/README.md +++ b/README.md @@ -839,6 +839,11 @@ which Quickemu sizes to 2048x1152. Without the `--screen` option, Quickemu would have used the 1920x1080 monitor which results in a window size of 1664x936. +The '--screenpct' is an optional interger value between 25 \<= pct \< +100 which will override system default screen sizes. The VM size will be +'pct' of the chosen screen. **If --fullscreen is chosen screen will be +fullsize instead of being scaled down by --screenpct value.** + # References Useful reference that assisted the development of Quickemu. diff --git a/build-docs b/build-docs index e8d977b..8542286 160000 --- a/build-docs +++ b/build-docs @@ -1 +1 @@ -Subproject commit e8d977ba8e4c18ed0760da5d7491e645aaab82c5 +Subproject commit 8542286bdc67996d5d079274a926d9c4c4941de2 diff --git a/docs/quickemu.1 b/docs/quickemu.1 index a3ff2be..524a4d1 100644 --- a/docs/quickemu.1 +++ b/docs/quickemu.1 @@ -854,6 +854,12 @@ 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 1920x1080 monitor which results in a window size of 1664x936. +.PP +The `\[en]screenpct' is an optional interger value between 25 <= pct < +100 which will override system default screen sizes. +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. diff --git a/docs/quickemu.1.md b/docs/quickemu.1.md index 0e13c87..2cdb74a 100644 --- a/docs/quickemu.1.md +++ b/docs/quickemu.1.md @@ -624,6 +624,11 @@ which Quickemu sizes to 2048x1152. Without the `--screen` option, Quickemu would have used the 1920x1080 monitor which results in a window size of 1664x936. +The '--screenpct' is an optional interger value between 25 \<= pct \< +100 which will override system default screen sizes. The VM size will be +'pct' of the chosen screen. **If --fullscreen is chosen screen will be +fullsize instead of being scaled down by --screenpct value.** + # References Useful reference that assisted the development of Quickemu.