Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: regenerated docs for release #626

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,8 @@ with your preferred flavour.
- `ubuntukylin` (Ubuntu Kylin)
- `ubuntu-mate` (Ubuntu MATE)
- `ubuntustudio` (Ubuntu Studio)
- `ubuntu-unity` (Ubuntu Unity)
- `ubuntu` (Ubuntu)
- `ubuntu-unity` (Ubuntu Unity)
- `xubuntu` (Xubuntu)

## Other Operating Systems
Expand Down Expand Up @@ -260,6 +260,7 @@ with your preferred flavour.
- `kolibrios` (KolibriOS)
- `linuxmint` (Linux Mint)
- `lmde` (Linux Mint Debian Edition)
- `mageia` (Mageia)
- `manjaro` (Manjaro)
- `mxlinux` (MX Linux)
- `netboot` (netboot.xyz)
Expand All @@ -270,10 +271,13 @@ with your preferred flavour.
- `oraclelinux` (Oracle Linux)
- `popos` (Pop!\_OS)
- `reactos` (ReactOS)
- `rebornos` (RebornOS)
- `rockylinux` (Rocky Linux)
- `slackware` (Slackware)
- `solus` (Solus)
- `tails` (Tails)
- `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale)
- `void` (Void Linux)
- `zorin` (Zorin OS)

Expand Down Expand Up @@ -776,8 +780,8 @@ You can also pass optional parameters
--extra_args <arguments> : Pass additional arguments to qemu
--version : Print version

```
<!-- [[[end]]] -->
```

## Desktop shortcuts

Expand Down
2 changes: 1 addition & 1 deletion build-docs
8 changes: 7 additions & 1 deletion docs/quickemu.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "QUICKEMU" "1" "December 11, 2022" "quickemu" "Quickemu User Manual"
.TH "QUICKEMU" "1" "February 3, 2023" "quickemu" "Quickemu User Manual"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -407,6 +407,8 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]reactos\f[R] (ReactOS)
.IP \[bu] 2
\f[V]rebornos\f[R] (RebornOS)
.IP \[bu] 2
\f[V]rockylinux\f[R] (Rocky Linux)
.IP \[bu] 2
\f[V]slackware\f[R] (Slackware)
Expand All @@ -415,6 +417,10 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]tails\f[R] (Tails)
.IP \[bu] 2
\f[V]truenas-core\f[R] (TrueNAS Core)
.IP \[bu] 2
\f[V]truenas-scale\f[R] (TrueNAS Scale)
.IP \[bu] 2
\f[V]void\f[R] (Void Linux)
.IP \[bu] 2
\f[V]zorin\f[R] (Zorin OS)
Expand Down
5 changes: 4 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: December 11, 2022
date: February 3, 2023
footer: quickemu
header: Quickemu User Manual
section: 1
Expand Down Expand Up @@ -295,10 +295,13 @@ with your preferred flavour.
- `oraclelinux` (Oracle Linux)
- `popos` (Pop!\_OS)
- `reactos` (ReactOS)
- `rebornos` (RebornOS)
- `rockylinux` (Rocky Linux)
- `slackware` (Slackware)
- `solus` (Solus)
- `tails` (Tails)
- `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale)
- `void` (Void Linux)
- `zorin` (Zorin OS)

Expand Down
22 changes: 21 additions & 1 deletion docs/quickemu_conf.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "QUICKEMU_CONF" "1" "December 11, 2022" "quickemu_conf" "Quickemu Configuration Manual"
.TH "QUICKEMU_CONF" "1" "February 3, 2023" "quickemu_conf" "Quickemu Configuration Manual"
.hy
.SH NAME
.PP
Expand All @@ -38,6 +38,8 @@ boot=\[dq]efi\[dq]
cpu_cores=\[dq]\[dq]
disk_img=\[dq]\[dq]
disk_size=\[dq]\[dq]
display=\[dq]\[dq]
extra_args=\[dq]\[dq]
fixed_iso=\[dq]\[dq]
floppy=\[dq]\[dq]
guest_os=\[dq]linux\[dq]
Expand All @@ -52,6 +54,24 @@ ram=\[dq]\[dq]
secureboot=\[dq]off\[dq]
tpm=\[dq]off\[dq]
usb_devices=()
viewer=\[dq]spicy\[dq]
ssh_port=\[dq]\[dq]
spice_port=\[dq]\[dq]
public_dir=\[dq]\[dq]
monitor=\[dq]socket\[dq]
monitor_telnet_port=\[dq]4440\[dq]
monitor_telnet_host=\[dq]localhost\[dq]
monitor_cmd=\[dq]\[dq]
serial=\[dq]socket\[dq]
serial_telnet_port=\[dq]6660\[dq]
serial_telnet_host=\[dq]localhost\[dq]
# options: ehci(USB2.0), xhci(USB3.0)
usb_controller=\[dq]ehci\[dq]
# options: ps2, usb, virtio
keyboard=\[dq]usb\[dq]
keyboard_layout=\[dq]en-us\[dq]
# options: ps2, usb, tablet, virtio
mouse=\[dq]tablet\[dq]
\f[R]
.fi
.SH EXAMPLES
Expand Down
22 changes: 21 additions & 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: December 11, 2022
date: February 3, 2023
footer: quickemu_conf
header: Quickemu Configuration Manual
section: 1
Expand Down Expand Up @@ -29,6 +29,8 @@ boot="efi"
cpu_cores=""
disk_img=""
disk_size=""
display=""
extra_args=""
fixed_iso=""
floppy=""
guest_os="linux"
Expand All @@ -43,6 +45,24 @@ ram=""
secureboot="off"
tpm="off"
usb_devices=()
viewer="spicy"
ssh_port=""
spice_port=""
public_dir=""
monitor="socket"
monitor_telnet_port="4440"
monitor_telnet_host="localhost"
monitor_cmd=""
serial="socket"
serial_telnet_port="6660"
serial_telnet_host="localhost"
# options: ehci(USB2.0), xhci(USB3.0)
usb_controller="ehci"
# options: ps2, usb, virtio
keyboard="usb"
keyboard_layout="en-us"
# options: ps2, usb, tablet, virtio
mouse="tablet"
```

# EXAMPLES
Expand Down
8 changes: 7 additions & 1 deletion docs/quickget.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "QUICKGET" "1" "December 11, 2022" "quickget" "Quickget User Manual"
.TH "QUICKGET" "1" "February 3, 2023" "quickget" "Quickget User Manual"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -189,6 +189,8 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]reactos\f[R] (ReactOS)
.IP \[bu] 2
\f[V]rebornos\f[R] (RebornOS)
.IP \[bu] 2
\f[V]rockylinux\f[R] (Rocky Linux)
.IP \[bu] 2
\f[V]slackware\f[R] (Slackware)
Expand All @@ -197,6 +199,10 @@ All the official Ubuntu flavours are supported, just replace
.IP \[bu] 2
\f[V]tails\f[R] (Tails)
.IP \[bu] 2
\f[V]truenas-core\f[R] (TrueNAS Core)
.IP \[bu] 2
\f[V]truenas-scale\f[R] (TrueNAS Scale)
.IP \[bu] 2
\f[V]void\f[R] (Void Linux)
.IP \[bu] 2
\f[V]zorin\f[R] (Zorin OS)
Expand Down
5 changes: 4 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: December 11, 2022
date: February 3, 2023
footer: quickget
header: Quickget User Manual
section: 1
Expand Down Expand Up @@ -127,10 +127,13 @@ with your preferred flavour.
- `oraclelinux` (Oracle Linux)
- `popos` (Pop!\_OS)
- `reactos` (ReactOS)
- `rebornos` (RebornOS)
- `rockylinux` (Rocky Linux)
- `slackware` (Slackware)
- `solus` (Solus)
- `tails` (Tails)
- `truenas-core` (TrueNAS Core)
- `truenas-scale` (TrueNAS Scale)
- `void` (Void Linux)
- `zorin` (Zorin OS)

Expand Down