docs: man pages regenerated including recent wiki revisions

lj3954 · Jun 18, 2024 · 3413fd1 · 3413fd1
1 parent 99f0c4c
commit 3413fd1
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 22 deletions.
diff --git a/docs/quickemu.1 b/docs/quickemu.1
@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.2
 .\"
-.TH "QUICKEMU" "1" "May 14, 2024" "quickemu" "Quickemu User Manual"
+.TH "QUICKEMU" "1" "May 26, 2024" "quickemu" "Quickemu User Manual"
 .SH NAME
 quickemu \- A quick VM builder and manager
 .SH SYNOPSIS
@@ -380,12 +380,12 @@ These examples may save a little typing:
 This also applies to derivatives:
 .IP
 .EX
-sudo apt install qemu bash coreutils ovmf grep jq mesa\-utils pciutils procps python3 genisoimage usbutils util\-linux sed socat spice\-client\-gtk libtss2\-tcti\-swtpm0 xdg\-user\-dirs zsync unzip
+sudo apt\-get install bash coreutils curl genisoimage grep jq mesa\-utils ovmf pciutils procps python3 qemu sed socat spice\-client\-gtk swtpm\-tools unzip usbutils util\-linux xdg\-user\-dirs xrandr zsync 
 .EE
 .SS Install requirements on Fedora hosts
 .IP
 .EX
-sudo dnf install qemu bash coreutils edk2\-tools grep jq mesa\-demos pciutils procps python3 genisoimage usbutils util\-linux sed socat spice\-gtk\-tools swtpm xdg\-user\-dirs xrandr unzip
+sudo dnf install bash coreutils curl edk2\-tools genisoimage grep jq mesa\-demos pciutils procps python3 qemu sed socat spice\-gtk\-tools swtpm unzip usbutils util\-linux xdg\-user\-dirs xrandr zsync
 .EE
 .SS Install requirements on Gentoo
 Please note that you may have to use \f[CR]sys\-firmware/edk2\-ovmf\f[R]
@@ -417,14 +417,17 @@ sudo emerge \-\-ask \-\-noreplace app\-emulation/qemu \[rs]
  app\-arch/unzip
 .EE
 .SS Install requirements on macOS hosts
-This is a \f[B]work in progress\f[R] (see \c
-.UR https://github.com/quickemu-project/quickemu/issues/447
-issue 447
-.UE \c
-\ for other steps and changes that may enable running on MacOS)
+Install the Quickemu requirements using brew:
+.IP
+.EX
+brew install bash cdrtools coreutils jq python3 qemu usbutils samba socat swtpm zsync
+.EE
+.PP
+Now clone the project:
 .IP
 .EX
-brew install qemu bash coreutils curl grep jq pciutils python\[at]3.10 cdrtools gnu\-sed spice\-gtk zsync
+git clone https://github.com/quickemu\-project/quickemu
+cd quickemu
 .EE
 .SS \c
 .UR https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends
@@ -1135,7 +1138,7 @@ Arguments
   \-\-braille                         : Enable braille support. Requires SDL.
   \-\-delete\-disk                     : Delete the disk image and EFI variables
   \-\-delete\-vm                       : Delete the entire VM and its configuration
-  \-\-display                         : Select display backend. \[aq]sdl\[aq] (default), \[aq]gtk\[aq], \[aq]none\[aq], \[aq]spice\[aq] or \[aq]spice\-app\[aq]
+  \-\-display                         : Select display backend. \[aq]sdl\[aq] (default), \[aq]cocoa\[aq], \[aq]gtk\[aq], \[aq]none\[aq], \[aq]spice\[aq] or \[aq]spice\-app\[aq]
   \-\-fullscreen                      : Starts VM in full screen mode (Ctl+Alt+f to exit)
   \-\-ignore\-msrs\-always              : Configure KVM to always ignore unhandled machine\-specific registers
   \-\-kill                            : Kill the VM process if it is running

diff --git a/docs/quickemu.1.md b/docs/quickemu.1.md
@@ -1,6 +1,6 @@
 ---
 author: Martin Wimpress
-date: May 14, 2024
+date: May 26, 2024
 footer: quickemu
 header: Quickemu User Manual
 section: 1
@@ -238,13 +238,13 @@ These examples may save a little typing:
 This also applies to derivatives:
 
 ``` shell
-sudo apt install qemu bash coreutils ovmf grep jq mesa-utils pciutils procps python3 genisoimage usbutils util-linux sed socat spice-client-gtk libtss2-tcti-swtpm0 xdg-user-dirs zsync unzip
+sudo apt-get install bash coreutils curl genisoimage grep jq mesa-utils ovmf pciutils procps python3 qemu sed socat spice-client-gtk swtpm-tools unzip usbutils util-linux xdg-user-dirs xrandr zsync 
 ```
 
 #### Install requirements on Fedora hosts
 
 ``` shell
-sudo dnf install qemu bash coreutils edk2-tools grep jq mesa-demos pciutils procps python3 genisoimage usbutils util-linux sed socat spice-gtk-tools swtpm xdg-user-dirs xrandr unzip
+sudo dnf install bash coreutils curl edk2-tools genisoimage grep jq mesa-demos pciutils procps python3 qemu sed socat spice-gtk-tools swtpm unzip usbutils util-linux xdg-user-dirs xrandr zsync
 ```
 
 ### Install requirements on Gentoo
@@ -280,12 +280,17 @@ sudo emerge --ask --noreplace app-emulation/qemu \
 
 #### Install requirements on macOS hosts
 
-This is a **work in progress** (see [issue
-447](https://github.com/quickemu-project/quickemu/issues/447) for other
-steps and changes that may enable running on MacOS)
+Install the Quickemu requirements using brew:
 
 ``` shell
-brew install qemu bash coreutils curl grep jq pciutils [email protected] cdrtools gnu-sed spice-gtk zsync
+brew install bash cdrtools coreutils jq python3 qemu usbutils samba socat swtpm zsync
+```
+
+Now clone the project:
+
+``` shell
+git clone https://github.com/quickemu-project/quickemu
+cd quickemu
 ```
 
 ## [Alternative Frontends](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends)
@@ -750,7 +755,7 @@ Arguments
   --braille                         : Enable braille support. Requires SDL.
   --delete-disk                     : Delete the disk image and EFI variables
   --delete-vm                       : Delete the entire VM and its configuration
-  --display                         : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app'
+  --display                         : Select display backend. 'sdl' (default), 'cocoa', '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
   --kill                            : Kill the VM process if it is running

diff --git a/docs/quickemu_conf.1 b/docs/quickemu_conf.1
@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.2
 .\"
-.TH "QUICKEMU_CONF" "1" "May 14, 2024" "quickemu_conf" "Quickemu Configuration Manual"
+.TH "QUICKEMU_CONF" "1" "May 26, 2024" "quickemu_conf" "Quickemu Configuration Manual"
 .SH NAME
 quickemu_conf \- Options and parameters in the quickemu <vm>.conf
 .SH DESCRIPTION

diff --git a/docs/quickemu_conf.1.md b/docs/quickemu_conf.1.md
@@ -1,6 +1,6 @@
 ---
 author: Martin Wimpress
-date: May 14, 2024
+date: May 26, 2024
 footer: quickemu_conf
 header: Quickemu Configuration Manual
 section: 1

diff --git a/docs/quickget.1 b/docs/quickget.1
@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.2
 .\"
-.TH "QUICKGET" "1" "May 14, 2024" "quickget" "Quickget User Manual"
+.TH "QUICKGET" "1" "May 26, 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
@@ -1,6 +1,6 @@
 ---
 author: Martin Wimpress
-date: May 14, 2024
+date: May 26, 2024
 footer: quickget
 header: Quickget User Manual
 section: 1