Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
flexiondotorg committed Jun 14, 2023
2 parents 008478d + 51a6502 commit 8bf8498
Show file tree
Hide file tree
Showing 8 changed files with 48 additions and 16 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -753,6 +755,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 <screen> : Use specified screen to determine the window size.
--screenpct <percent> : Percent of fullscreen for VM if --fullscreen is not specified.
--shortcut : Create a desktop shortcut
--snapshot apply <tag> : Apply/restore a snapshot.
--snapshot create <tag> : Create a snapshot.
Expand Down Expand Up @@ -835,6 +838,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.
Expand Down
2 changes: 1 addition & 1 deletion build-docs
18 changes: 14 additions & 4 deletions docs/quickemu.1
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 <screen> : Use specified screen to determine the window size.
--screenpct <percent> : Percent of fullscreen for VM if --fullscreen is not specified.
--shortcut : Create a desktop shortcut
--snapshot apply <tag> : Apply/restore a snapshot.
--snapshot create <tag> : Create a snapshot.
Expand Down Expand Up @@ -850,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.
Expand Down
10 changes: 9 additions & 1 deletion docs/quickemu.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: April 30, 2023
date: June 14, 2023
footer: quickemu
header: Quickemu User Manual
section: 1
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 <screen> : Use specified screen to determine the window size.
--screenpct <percent> : Percent of fullscreen for VM if --fullscreen is not specified.
--shortcut : Create a desktop shortcut
--snapshot apply <tag> : Apply/restore a snapshot.
--snapshot create <tag> : Create a snapshot.
Expand Down Expand Up @@ -621,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.
Expand Down
12 changes: 6 additions & 6 deletions docs/quickemu_conf.1
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/quickemu_conf.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: April 30, 2023
date: June 14, 2023
footer: quickemu_conf
header: Quickemu Configuration Manual
section: 1
Expand Down
8 changes: 6 additions & 2 deletions docs/quickget.1
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion docs/quickget.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
author: Martin Wimpress
date: April 30, 2023
date: June 14, 2023
footer: quickget
header: Quickget User Manual
section: 1
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 8bf8498

Please sign in to comment.