0
0

README.adoc: Update formatting, fix typos

This commit is contained in:
Nils Freydank 2024-06-23 11:59:43 +02:00
parent 9cb5be5a57
commit 227fd806c1
Signed by: nfr
GPG Key ID: 0F1DEAB2D36AD112

View File

@ -1,16 +1,11 @@
= control-vm.sh = control-vm.sh
:toc: :toc:
This repository contains a simple bash script to start and stop virtual This repository contains a simple bash script to start and stop virtual machines run by QEMU and KVM and to connect to them via SSH or VNC or SPICE.
machines run by QEMU and KVM and to connect to them via SSH or VNC or SPICE.
The newest version can be probably found on The newest version can be probably found on https://git.holgersson.xyz/nfr/control-vm.
https://git.holgersson.xyz/nfr/control-vm.
Note: While the author already runs this software in "production" on his NOTE: While the author already runs this software in "production" on his private setup he would still conside some parts as beta quality. As usual it's strongly recommended to create backups first and read through the bash script to understand roughly what it does.
private setup he would still conside some parts as beta quality. As usual it's
strongly recommended to create backups first and read through the bash script
to understand roughly what it does.
== Installation == Installation
Please install the following tools which are used by the script: Please install the following tools which are used by the script:
@ -26,18 +21,16 @@ Please install the following tools which are used by the script:
./control-vm.sh <name of your virtual machine> start | shutdown | stop | connect | save | restore | pause | resume" ./control-vm.sh <name of your virtual machine> start | shutdown | stop | connect | save | restore | pause | resume"
---- ----
Note that you do not see any 'setup' command there a one-shot boot from ISO is NOTE: You do not see any 'setup' command there as I've implemented no one-shot boot from ISO so far.
not implemented.
== Contact == Contact
If you have questions, suggestions or want to brag about your other qemu If you have questions, suggestions or want to brag about your other qemu managing tools feel free to write an email or conact me via IRC:
managing tools feel free to write an email or conact me via IRC:
mail: nils@holgersson.xyz - mail: nils@holgersson.xyz
IRC: holgersson on libera.chat and oftc, mostly in Gentoo related channels - IRC: holgersson on libera.chat and oftc, mostly in Gentoo related channels
== Copyright == Copyright
The bash script and it's documentation (this README) are licensed as MIT, The bash script and it's documentation (this README) are licensed as MIT, copyright by Nils Freydank.
copyright by Nils Freydank.
The used software has each is own license, but is all FLOSS software. The used software has each is own license, but is all FLOSS software.