From 0b1c028512ce54f4ffd156b28f7693c407596a28 Mon Sep 17 00:00:00 2001 From: Chase Covello Date: Fri, 28 Apr 2023 15:46:49 -0700 Subject: [PATCH] Updated man pages with new options Added new sound card options to man pages, along with newer command-line options that weren't in the summary at the top. --- docs/quickemu.1 | 78 ++++++++++++++++++++++++++++++++++++++--- docs/quickemu.1.md | 65 +++++++++++++++++++++++++++++++--- docs/quickemu_conf.1 | 4 ++- docs/quickemu_conf.1.md | 2 ++ quickemu | 4 +-- 5 files changed, 140 insertions(+), 13 deletions(-) diff --git a/docs/quickemu.1 b/docs/quickemu.1 index f2ef286..cd6a7b9 100644 --- a/docs/quickemu.1 +++ b/docs/quickemu.1 @@ -37,12 +37,15 @@ You can also pass optional parameters Enable braille support. Requires SDL. .TP -\f[B]\[en]delete\f[R] -Delete the disk image. +\f[B]\[en]delete-disk, \[en]delete\f[R] +Delete the disk image and EFI variables +.TP +\f[B]\[en]delete-vm\f[R] +Delete the entire VM and it\[cq]s configuration .TP \f[B]\[en]display\f[R] Select display backend. -`sdl' (default), `gtk', `none' or `spice' +`sdl' (default), `gtk', `none', `spice', or `spice-app' .TP \f[B]\[en]fullscreen\f[R] Starts VM in full screen mode (Ctl+Alt+f to exit) @@ -71,6 +74,70 @@ Show disk/snapshot info. \f[B]\[en]status-quo\f[R] Do not commit any changes to disk/snapshot. .TP +\f[B]\[en]viewer \f[R] +Choose an alternative viewer. +\[at]Options: `spicy' (default), `remote-viewer', `none' +.TP +\f[B]\[en]ssh-port \f[R] +Set ssh-port manually +.TP +\f[B]\[en]spice-port \f[R] +Set spice-port manually +.TP +\f[B]\[en]public-dir \f[R] +Expose share directory. +\[at]Options: \[cq]\[cq] (default: xdg-user-dir PUBLICSHARE), `', `none' +.TP +\f[B]\[en]monitor \f[R] +Set monitor connection type. +\[at]Options: `socket' (default), `telnet', `none' +.TP +\f[B]\[en]monitor-telnet-host \f[R] +Set telnet host for monitor. +(default: `localhost') +.TP +\f[B]\[en]monitor-telnet-port \f[R] +Set telnet port for monitor. +(default: `4440') +.TP +\f[B]\[en]monitor-cmd \f[R] +Send command to monitor if available. +(Example: system_powerdown) +.TP +\f[B]\[en]serial \f[R] +Set serial connection type. +\[at]Options: `socket' (default), `telnet', `none' +.TP +\f[B]\[en]serial-telnet-host \f[R] +Set telnet host for serial. +(default: `localhost') +.TP +\f[B]\[en]serial-telnet-port \f[R] +Set telnet port for serial. +(default: `6660') +.TP +\f[B]\[en]keyboard \f[R] +Set keyboard. +\[at]Options: `usb' (default), `ps2', `virtio' +.TP +\f[B]\[en]keyboard_layout \f[R] +Set keyboard layout. +.TP +\f[B]\[en]mouse \f[R] +Set mouse. +\[at]Options: `tablet' (default), `ps2', `usb', `virtio' +.TP +\f[B]\[en]usb-controller \f[R] +Set usb-controller. +\[at]Options: `ehci' (default), `xhci', `none' +.TP +\f[B]\[en]sound-card \f[R] +Set sound card. +\[at]Options: `intel-hda' (default), `ac97', `es1370', `sb16', `none' +.TP +\f[B]\[en]extra_args \f[R] +Pass additional arguments to qemu +.TP \f[B]\[en]version\f[R] Print version .SH EXAMPLES @@ -749,7 +816,7 @@ Usage You can also pass optional parameters --braille : Enable braille support. Requires SDL. - --delete-disk : Delete the disk image and EFI variables + --delete-disk, --delete : Delete the disk image and EFI variables --delete-vm : Delete the entire VM and it\[aq]s configuration --display : Select display backend. \[aq]sdl\[aq] (default), \[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) @@ -764,7 +831,7 @@ You can also pass optional parameters --viewer : Choose an alternative viewer. \[at]Options: \[aq]spicy\[aq] (default), \[aq]remote-viewer\[aq], \[aq]none\[aq] --ssh-port : Set ssh-port manually --spice-port : Set spice-port manually - --public-dir : expose share directory. \[at]Options: \[aq]\[aq] (default: xdg-user-dir PUBLICSHARE), \[aq]\[aq], \[aq]none\[aq] + --public-dir : Expose share directory. \[at]Options: \[aq]\[aq] (default: xdg-user-dir PUBLICSHARE), \[aq]\[aq], \[aq]none\[aq] --monitor : Set monitor connection type. \[at]Options: \[aq]socket\[aq] (default), \[aq]telnet\[aq], \[aq]none\[aq] --monitor-telnet-host : Set telnet host for monitor. (default: \[aq]localhost\[aq]) --monitor-telnet-port : Set telnet port for monitor. (default: \[aq]4440\[aq]) @@ -776,6 +843,7 @@ You can also pass optional parameters --keyboard_layout : Set keyboard layout. --mouse : Set mouse. \[at]Options: \[aq]tablet\[aq] (default), \[aq]ps2\[aq], \[aq]usb\[aq], \[aq]virtio\[aq] --usb-controller : Set usb-controller. \[at]Options: \[aq]ehci\[aq] (default), \[aq]xhci\[aq], \[aq]none\[aq] + --sound-card : Set sound card. \[at]Options: \[aq]intel-hda\[aq] (default), \[aq]ac97\[aq], \[aq]es1370\[aq], \[aq]sb16\[aq], \[aq]none\[aq] --extra_args : Pass additional arguments to qemu --version : Print version \f[R] diff --git a/docs/quickemu.1.md b/docs/quickemu.1.md index 0a13c9a..90633a3 100644 --- a/docs/quickemu.1.md +++ b/docs/quickemu.1.md @@ -30,11 +30,14 @@ You can also pass optional parameters **--braille** : Enable braille support. Requires SDL. -**--delete** -: Delete the disk image. +**--delete-disk, --delete** +: 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' or 'spice' +: Select display backend. 'sdl' (default), 'gtk', 'none', 'spice', or 'spice-app' **--fullscreen** : Starts VM in full screen mode (Ctl+Alt+f to exit) @@ -63,6 +66,57 @@ You can also pass optional parameters **--status-quo** : Do not commit any changes to disk/snapshot. +**--viewer \** +: Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' + +**--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 @@ -533,7 +587,7 @@ Here are the usage instructions: You can also pass optional parameters --braille : Enable braille support. Requires SDL. - --delete-disk : Delete the disk image and EFI variables + --delete-disk, --delete : 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) @@ -548,7 +602,7 @@ Here are the usage instructions: --viewer : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' --ssh-port : Set ssh-port manually --spice-port : Set spice-port manually - --public-dir : expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '', 'none' + --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') @@ -560,6 +614,7 @@ Here are the usage instructions: --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 diff --git a/docs/quickemu_conf.1 b/docs/quickemu_conf.1 index 3967eeb..7cce399 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 2.17.1.1 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. @@ -72,6 +72,8 @@ keyboard=\[dq]usb\[dq] keyboard_layout=\[dq]en-us\[dq] # options: ps2, usb, tablet, virtio mouse=\[dq]tablet\[dq] +# options: intel-hda, ac97, es1370, sb16, none +sound_card=\[dq]intel-hda\[dq] \f[R] .fi .SH EXAMPLES diff --git a/docs/quickemu_conf.1.md b/docs/quickemu_conf.1.md index 4c7396d..184eb53 100644 --- a/docs/quickemu_conf.1.md +++ b/docs/quickemu_conf.1.md @@ -63,6 +63,8 @@ keyboard="usb" keyboard_layout="en-us" # options: ps2, usb, tablet, virtio mouse="tablet" +# options: intel-hda, ac97, es1370, sb16, none +sound_card="intel-hda" ``` # EXAMPLES diff --git a/quickemu b/quickemu index 65b3eef..5d26a0d 100755 --- a/quickemu +++ b/quickemu @@ -1322,7 +1322,7 @@ function usage() { echo echo "You can also pass optional parameters" echo " --braille : Enable braille support. Requires SDL." - echo " --delete-disk : Delete the disk image and EFI variables" + echo " --delete-disk, --delete : Delete the disk image and EFI variables" echo " --delete-vm : Delete the entire VM and it's configuration" echo " --display : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app'" echo " --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)" @@ -1337,7 +1337,7 @@ function usage() { echo " --viewer : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none'" echo " --ssh-port : Set ssh-port manually" echo " --spice-port : Set spice-port manually" - echo " --public-dir : expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '', 'none'" + echo " --public-dir : Expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '', 'none'" echo " --monitor : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none'" echo " --monitor-telnet-host : Set telnet host for monitor. (default: 'localhost')" echo " --monitor-telnet-port : Set telnet port for monitor. (default: '4440')"