From 5a711439dae8b31fe1138e2684b53fbcb315acf3 Mon Sep 17 00:00:00 2001 From: Phil Clifford Date: Mon, 19 Sep 2022 11:41:22 +0100 Subject: [PATCH] updated docs for release 4.2 --- README.md | 18 ++++++++---------- build-docs | 2 +- docs/quickemu.1 | 22 +++++++++++----------- docs/quickemu.1.md | 20 ++++++++++---------- docs/quickemu_conf.1 | 2 +- docs/quickemu_conf.1.md | 2 +- docs/quickget.1 | 20 +++++++++----------- docs/quickget.1.md | 19 +++++++++---------- 8 files changed, 50 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index c249c77..c29dea1 100644 --- a/README.md +++ b/README.md @@ -193,11 +193,11 @@ quickemu --vm ubuntu-22.04.conf - Complete the installation as normal. - Post-install: - - Install the SPICE agent (`spice-vdagent`) to enable copy/paste - and USB redirection + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection - `sudo apt install spice-vdagent` - - Install the SPICE WebDAV agent (`spice-webdavd`) to enable file - sharing. + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. - `sudo apt install spice-webdavd` ### Ubuntu devel (daily-live) images @@ -268,7 +268,6 @@ with your preferred flavour. - `oraclelinux` (Oracle Linux) - `popos` (Pop!\_OS) - `reactos` (ReactOS) -- `regolith` (Regolith Linux) - `rockylinux` (Rocky Linux) - `slackware` (Slackware) - `solus` (Solus) @@ -296,10 +295,10 @@ quickemu --vm debian-bullseye.conf - Complete the installation as normal. - Post-install: - - Install the SPICE agent (`spice-vdagent`) to enable copy/paste - and USB redirection. - - Install the SPICE WebDAV agent (`spice-webdavd`) to enable file - sharing. + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection. + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. ## macOS Guest @@ -739,7 +738,6 @@ You can also pass optional parameters --version : Print version ``` - ## Desktop shortcuts diff --git a/build-docs b/build-docs index da4705f..b00b951 160000 --- a/build-docs +++ b/build-docs @@ -1 +1 @@ -Subproject commit da4705f350bb95c08dfd7e31627285ffc8019045 +Subproject commit b00b951c83c5c18aafd57c0898c4cfd7394ef4f3 diff --git a/docs/quickemu.1 b/docs/quickemu.1 index 19493ed..ea0bc84 100644 --- a/docs/quickemu.1 +++ b/docs/quickemu.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "QUICKEMU" "1" "September 1, 2022" "quickemu" "Quickemu User Manual" +.TH "QUICKEMU" "1" "September 19, 2022" "quickemu" "Quickemu User Manual" .hy .SH NAME .PP @@ -182,6 +182,8 @@ util-linux (https://github.com/karelzak/util-linux) .IP \[bu] 2 sed (https://www.gnu.org/software/sed/) .IP \[bu] 2 +socat (http://www.dest-unreach.org/socat/) +.IP \[bu] 2 spicy (https://gitlab.freedesktop.org/spice/spice-gtk) .IP \[bu] 2 swtpm (https://github.com/stefanberger/swtpm) @@ -274,15 +276,15 @@ Complete the installation as normal. Post-install: .RS 2 .IP \[bu] 2 -Install the SPICE agent (\f[V]spice-vdagent\f[R]) to enable copy/paste -and USB redirection +Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable +copy/paste and USB redirection .RS 2 .IP \[bu] 2 \f[V]sudo apt install spice-vdagent\f[R] .RE .IP \[bu] 2 -Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) to enable file -sharing. +Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to +enable file sharing. .RS 2 .IP \[bu] 2 \f[V]sudo apt install spice-webdavd\f[R] @@ -399,8 +401,6 @@ All the official Ubuntu flavours are supported, just replace .IP \[bu] 2 \f[V]reactos\f[R] (ReactOS) .IP \[bu] 2 -\f[V]regolith\f[R] (Regolith Linux) -.IP \[bu] 2 \f[V]rockylinux\f[R] (Rocky Linux) .IP \[bu] 2 \f[V]slackware\f[R] (Slackware) @@ -442,11 +442,11 @@ Complete the installation as normal. Post-install: .RS 2 .IP \[bu] 2 -Install the SPICE agent (\f[V]spice-vdagent\f[R]) to enable copy/paste -and USB redirection. +Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable +copy/paste and USB redirection. .IP \[bu] 2 -Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) to enable file -sharing. +Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to +enable file sharing. .RE .SS macOS Guest .PP diff --git a/docs/quickemu.1.md b/docs/quickemu.1.md index 3279bed..49a4393 100644 --- a/docs/quickemu.1.md +++ b/docs/quickemu.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: September 1, 2022 +date: September 19, 2022 footer: quickemu header: Quickemu User Manual section: 1 @@ -145,6 +145,7 @@ QEMU](https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)](https://www.youtube.com/wat - [usbutils](https://github.com/gregkh/usbutils) - [util-linux](https://github.com/karelzak/util-linux) - [sed](https://www.gnu.org/software/sed/) +- [socat](http://www.dest-unreach.org/socat/) - [spicy](https://gitlab.freedesktop.org/spice/spice-gtk) - [swtpm](https://github.com/stefanberger/swtpm) - [Wget](https://www.gnu.org/software/wget/) @@ -216,11 +217,11 @@ quickemu --vm ubuntu-22.04.conf - Complete the installation as normal. - Post-install: - - Install the SPICE agent (`spice-vdagent`) to enable copy/paste - and USB redirection + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection - `sudo apt install spice-vdagent` - - Install the SPICE WebDAV agent (`spice-webdavd`) to enable file - sharing. + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. - `sudo apt install spice-webdavd` ### Ubuntu devel (daily-live) images @@ -291,7 +292,6 @@ with your preferred flavour. - `oraclelinux` (Oracle Linux) - `popos` (Pop!\_OS) - `reactos` (ReactOS) -- `regolith` (Regolith Linux) - `rockylinux` (Rocky Linux) - `slackware` (Slackware) - `solus` (Solus) @@ -319,10 +319,10 @@ quickemu --vm debian-bullseye.conf - Complete the installation as normal. - Post-install: - - Install the SPICE agent (`spice-vdagent`) to enable copy/paste - and USB redirection. - - Install the SPICE WebDAV agent (`spice-webdavd`) to enable file - sharing. + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection. + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. ## macOS Guest diff --git a/docs/quickemu_conf.1 b/docs/quickemu_conf.1 index c012bdd..e7152f9 100644 --- a/docs/quickemu_conf.1 +++ b/docs/quickemu_conf.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "QUICKEMU_CONF" "1" "September 1, 2022" "quickemu_conf" "Quickemu Configuration Manual" +.TH "QUICKEMU_CONF" "1" "September 19, 2022" "quickemu_conf" "Quickemu Configuration Manual" .hy .SH NAME .PP diff --git a/docs/quickemu_conf.1.md b/docs/quickemu_conf.1.md index 6c52fed..ebfc296 100644 --- a/docs/quickemu_conf.1.md +++ b/docs/quickemu_conf.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: September 1, 2022 +date: September 19, 2022 footer: quickemu_conf header: Quickemu Configuration Manual section: 1 diff --git a/docs/quickget.1 b/docs/quickget.1 index 911c807..1bf86c5 100644 --- a/docs/quickget.1 +++ b/docs/quickget.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "QUICKGET" "1" "September 1, 2022" "quickget" "Quickget User Manual" +.TH "QUICKGET" "1" "September 19, 2022" "quickget" "Quickget User Manual" .hy .SH NAME .PP @@ -58,15 +58,15 @@ Complete the installation as normal. Post-install: .RS 2 .IP \[bu] 2 -Install the SPICE agent (\f[V]spice-vdagent\f[R]) to enable copy/paste -and USB redirection +Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable +copy/paste and USB redirection .RS 2 .IP \[bu] 2 \f[V]sudo apt install spice-vdagent\f[R] .RE .IP \[bu] 2 -Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) to enable file -sharing. +Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to +enable file sharing. .RS 2 .IP \[bu] 2 \f[V]sudo apt install spice-webdavd\f[R] @@ -183,8 +183,6 @@ All the official Ubuntu flavours are supported, just replace .IP \[bu] 2 \f[V]reactos\f[R] (ReactOS) .IP \[bu] 2 -\f[V]regolith\f[R] (Regolith Linux) -.IP \[bu] 2 \f[V]rockylinux\f[R] (Rocky Linux) .IP \[bu] 2 \f[V]slackware\f[R] (Slackware) @@ -226,11 +224,11 @@ Complete the installation as normal. Post-install: .RS 2 .IP \[bu] 2 -Install the SPICE agent (\f[V]spice-vdagent\f[R]) to enable copy/paste -and USB redirection. +Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable +copy/paste and USB redirection. .IP \[bu] 2 -Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) to enable file -sharing. +Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to +enable file sharing. .RE .SS macOS Guest .PP diff --git a/docs/quickget.1.md b/docs/quickget.1.md index a3693f9..8bd385a 100644 --- a/docs/quickget.1.md +++ b/docs/quickget.1.md @@ -1,6 +1,6 @@ --- author: Martin Wimpress -date: September 1, 2022 +date: September 19, 2022 footer: quickget header: Quickget User Manual section: 1 @@ -49,11 +49,11 @@ quickemu --vm ubuntu-22.04.conf - Complete the installation as normal. - Post-install: - - Install the SPICE agent (`spice-vdagent`) to enable copy/paste - and USB redirection + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection - `sudo apt install spice-vdagent` - - Install the SPICE WebDAV agent (`spice-webdavd`) to enable file - sharing. + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. - `sudo apt install spice-webdavd` ### Ubuntu devel (daily-live) images @@ -124,7 +124,6 @@ with your preferred flavour. - `oraclelinux` (Oracle Linux) - `popos` (Pop!\_OS) - `reactos` (ReactOS) -- `regolith` (Regolith Linux) - `rockylinux` (Rocky Linux) - `slackware` (Slackware) - `solus` (Solus) @@ -152,10 +151,10 @@ quickemu --vm debian-bullseye.conf - Complete the installation as normal. - Post-install: - - Install the SPICE agent (`spice-vdagent`) to enable copy/paste - and USB redirection. - - Install the SPICE WebDAV agent (`spice-webdavd`) to enable file - sharing. + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection. + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. ## macOS Guest