AIR
/
quickemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc refresh to include option

Browse Source
pull/521/head
Phil Clifford 2 years ago committed by Martin Wimpress
parent ab2e7e5300
commit 2e5785286f
7 changed files with 63 additions and 43 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 74
      README.md
  2. 7
      docs/quickemu.1
  3. 10
      docs/quickemu.1.md
  4. 2
      docs/quickemu_conf.1
  5. 2
      docs/quickemu_conf.1.md
  6. 5
      docs/quickget.1
  7. 6
      docs/quickget.1.md

74
README.md
Unescape View File

@ -231,6 +231,10 @@ with your preferred flavour.
`quickget` also supports: `quickget` also supports:
## Other Operating Systems
`quickget` also supports:
- `alma` (Alma Linux) - `alma` (Alma Linux)
- `alpine` (Alpine Linux) - `alpine` (Alpine Linux)
- `android` (Android x86) - `android` (Android x86)
@ -648,46 +652,46 @@ cog.out(f"```\n\n{help}\n\n```\n\n")
``` ```
Usage Usage
quickemu --vm ubuntu.conf quickemu --vm ubuntu.conf
You can also pass optional parameters You can also pass optional parameters
--braille : Enable braille support. Requires SDL. --braille : Enable braille support. Requires SDL.
--delete-disk : Delete the disk image and EFI variables --delete-disk : Delete the disk image and EFI variables
--delete-vm : Delete the entire VM and it's configuration --delete-vm : Delete the entire VM and it's configuration
--display : Select display backend. 'sdl' (default), 'gtk', 'none', or 'spice' --display : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app'
--fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit) --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
--screen <screen> : Use specified screen to determine the window size. --screen <screen> : Use specified screen to determine the window size.
--shortcut : Create a desktop shortcut --shortcut : Create a desktop shortcut
--snapshot apply <tag> : Apply/restore a snapshot. --snapshot apply <tag> : Apply/restore a snapshot.
--snapshot create <tag> : Create a snapshot. --snapshot create <tag> : Create a snapshot.
--snapshot delete <tag> : Delete a snapshot. --snapshot delete <tag> : Delete a snapshot.
--snapshot info : Show disk/snapshot info. --snapshot info : Show disk/snapshot info.
--status-quo : Do not commit any changes to disk/snapshot. --status-quo : Do not commit any changes to disk/snapshot.
--viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' --viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none'
--ssh-port <port> : Set ssh-port manually --ssh-port <port> : Set ssh-port manually
--spice-port <port> : Set spice-port manually --spice-port <port> : Set spice-port manually
--public-dir <path> : expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '<directory>', 'none' --public-dir <path> : expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '<directory>', 'none'
--monitor <type> : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none' --monitor <type> : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none'
--monitor-telnet-host <ip/host> : Set telnet host for monitor. (default: 'localhost') --monitor-telnet-host <ip/host> : Set telnet host for monitor. (default: 'localhost')
--monitor-telnet-port <port> : Set telnet port for monitor. (default: '4440') --monitor-telnet-port <port> : Set telnet port for monitor. (default: '4440')
--monitor-cmd <cmd> : Send command to monitor if available. (Example: system_powerdown) --monitor-cmd <cmd> : Send command to monitor if available. (Example: system_powerdown)
--serial <type> : Set serial connection type. @Options: 'socket' (default), 'telnet', 'none' --serial <type> : Set serial connection type. @Options: 'socket' (default), 'telnet', 'none'
--serial-telnet-host <ip/host> : Set telnet host for serial. (default: 'localhost') --serial-telnet-host <ip/host> : Set telnet host for serial. (default: 'localhost')
--serial-telnet-port <port> : Set telnet port for serial. (default: '6660') --serial-telnet-port <port> : Set telnet port for serial. (default: '6660')
--keyboard <type> : Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio' --keyboard <type> : Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio'
--keyboard_layout <layout> : Set keyboard layout. --keyboard_layout <layout> : Set keyboard layout.
--mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio' --mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
--usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none' --usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
--extra_args <arguments> : Pass additional arguments to qemu --extra_args <arguments> : Pass additional arguments to qemu
--version : Print version --version : Print version
``` ```
<!-- [[[end]]] --> <!-- [[[end]]] -->
## Desktop shortcuts ## Desktop shortcuts
Desktop shortcuts can be created for a VM, the shortcuts are saved in Desktop shortcuts can be created for a VM, the shortcuts are saved in

7
docs/quickemu.1
Unescape View File

@ -14,7 +14,7 @@
. ftr VB CB . ftr VB CB
. ftr VBI CBI . ftr VBI CBI
.\} .\}
.TH "QUICKEMU" "1" "July 30, 2022" "quickemu" "Quickemu User Manual" .TH "QUICKEMU" "1" "August 1, 2022" "quickemu" "Quickemu User Manual"
.hy .hy
.SH NAME .SH NAME
.PP .PP
@ -326,6 +326,9 @@ All the official Ubuntu flavours are supported, just replace
.SS Other Operating Systems .SS Other Operating Systems
.PP .PP
\f[V]quickget\f[R] also supports: \f[V]quickget\f[R] also supports:
.SS Other Operating Systems
.PP
\f[V]quickget\f[R] also supports:
.IP \[bu] 2 .IP \[bu] 2
\f[V]alma\f[R] (Alma Linux) \f[V]alma\f[R] (Alma Linux)
.IP \[bu] 2 .IP \[bu] 2
@ -658,7 +661,7 @@ You can also pass optional parameters
--braille : Enable braille support. Requires SDL. --braille : Enable braille support. Requires SDL.
--delete-disk : Delete the disk image and EFI variables --delete-disk : Delete the disk image and EFI variables
--delete-vm : Delete the entire VM and it\[aq]s configuration --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], or \[aq]spice\[aq] --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) --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
--screen <screen> : Use specified screen to determine the window size. --screen <screen> : Use specified screen to determine the window size.

10
docs/quickemu.1.md
Unescape View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: July 30, 2022 date: August 1, 2022
footer: quickemu footer: quickemu
header: Quickemu User Manual header: Quickemu User Manual
section: 1 section: 1
@ -255,6 +255,10 @@ with your preferred flavour.
`quickget` also supports: `quickget` also supports:
## Other Operating Systems
`quickget` also supports:
- `alma` (Alma Linux) - `alma` (Alma Linux)
- `alpine` (Alpine Linux) - `alpine` (Alpine Linux)
- `android` (Android x86) - `android` (Android x86)
@ -466,7 +470,7 @@ Here are the usage instructions:
--braille : Enable braille support. Requires SDL. --braille : Enable braille support. Requires SDL.
--delete-disk : Delete the disk image and EFI variables --delete-disk : Delete the disk image and EFI variables
--delete-vm : Delete the entire VM and it's configuration --delete-vm : Delete the entire VM and it's configuration
--display : Select display backend. 'sdl' (default), 'gtk', 'none', or 'spice' --display : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app'
--fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit) --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
--screen <screen> : Use specified screen to determine the window size. --screen <screen> : Use specified screen to determine the window size.
@ -494,6 +498,8 @@ Here are the usage instructions:
--extra_args <arguments> : Pass additional arguments to qemu --extra_args <arguments> : Pass additional arguments to qemu
--version : Print version --version : Print version
## Desktop shortcuts ## Desktop shortcuts
Desktop shortcuts can be created for a VM, the shortcuts are saved in Desktop shortcuts can be created for a VM, the shortcuts are saved in

2
docs/quickemu_conf.1
Unescape View File

@ -14,7 +14,7 @@
. ftr VB CB . ftr VB CB
. ftr VBI CBI . ftr VBI CBI
.\} .\}
.TH "QUICKEMU_CONF" "1" "July 30, 2022" "quickemu_conf" "Quickemu Configuration Manual" .TH "QUICKEMU_CONF" "1" "August 1, 2022" "quickemu_conf" "Quickemu Configuration Manual"
.hy .hy
.SH NAME .SH NAME
.PP .PP

2
docs/quickemu_conf.1.md
Unescape View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: July 30, 2022 date: August 1, 2022
footer: quickemu_conf footer: quickemu_conf
header: Quickemu Configuration Manual header: Quickemu Configuration Manual
section: 1 section: 1

5
docs/quickget.1
Unescape View File

@ -14,7 +14,7 @@
. ftr VB CB . ftr VB CB
. ftr VBI CBI . ftr VBI CBI
.\} .\}
.TH "QUICKGET" "1" "July 30, 2022" "quickget" "Quickget User Manual" .TH "QUICKGET" "1" "August 1, 2022" "quickget" "Quickget User Manual"
.hy .hy
.SH NAME .SH NAME
.PP .PP
@ -110,6 +110,9 @@ All the official Ubuntu flavours are supported, just replace
.SS Other Operating Systems .SS Other Operating Systems
.PP .PP
\f[V]quickget\f[R] also supports: \f[V]quickget\f[R] also supports:
.SS Other Operating Systems
.PP
\f[V]quickget\f[R] also supports:
.IP \[bu] 2 .IP \[bu] 2
\f[V]alma\f[R] (Alma Linux) \f[V]alma\f[R] (Alma Linux)
.IP \[bu] 2 .IP \[bu] 2

6
docs/quickget.1.md
Unescape View File

@ -1,6 +1,6 @@
--- ---
author: Martin Wimpress author: Martin Wimpress
date: July 30, 2022 date: August 1, 2022
footer: quickget footer: quickget
header: Quickget User Manual header: Quickget User Manual
section: 1 section: 1
@ -88,6 +88,10 @@ with your preferred flavour.
`quickget` also supports: `quickget` also supports:
## Other Operating Systems
`quickget` also supports:
- `alma` (Alma Linux) - `alma` (Alma Linux)
- `alpine` (Alpine Linux) - `alpine` (Alpine Linux)
- `android` (Android x86) - `android` (Android x86)

Write Preview
Loading…
Cancel
Save