control-vm/README.adoc

= control-vm.sh
:toc:

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.

The newest version can be probably found on
https://git.holgersson.xyz/nfr/control-vm.

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.

== Installation
Please install the following tools which are used by the script:

- bash
- >=qemu-6.0.0 
- socat
- remote-viewer as part of virt-viewer (https://virt-manager.org)
 
== Usage
[source, shell]
----
./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
not implemented.

== Contact
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:
mail: nils@holgersson.xyz
IRC: holgersson on libera.chat and oftc, mostly in Gentoo related channels

== Copyright
The bash script and it's documentation (this README) are licensed as MIT,
copyright by Nils Freydank.

The used software has each is own license, but is all FLOSS software.

// vim:syntax=asciidoc:fileencoding=utf-8:ts=4:expandtab:linebreak:wrap
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`= control-vm.sh`
			`:toc:`

Initial commit 2021-09-30 11:49:37 +02:00			`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.`

			`The newest version can be probably found on`
			`https://git.holgersson.xyz/nfr/control-vm.`

			`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.`

README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`== Installation`
Initial commit 2021-09-30 11:49:37 +02:00			`Please install the following tools which are used by the script:`

			`- bash`
			`- >=qemu-6.0.0`
			`- socat`
README.txt: Mention the correct SPICE client 2021-09-30 19:25:03 +02:00			`- remote-viewer as part of virt-viewer (https://virt-manager.org)`
Initial commit 2021-09-30 11:49:37 +02:00
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`== Usage`
			`[source, shell]`
			`----`
Initial commit 2021-09-30 11:49:37 +02:00			`./control-vm.sh <name of your virtual machine> start \| shutdown \| stop \| connect \| save \| restore \| pause \| resume"`
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`----`
Initial commit 2021-09-30 11:49:37 +02:00
			`Note that you do not see any 'setup' command there a one-shot boot from ISO is`
			`not implemented.`

README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`== Contact`
Initial commit 2021-09-30 11:49:37 +02:00			`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:`
			`mail: nils@holgersson.xyz`
			`IRC: holgersson on libera.chat and oftc, mostly in Gentoo related channels`

README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00			`== Copyright`
Initial commit 2021-09-30 11:49:37 +02:00			`The bash script and it's documentation (this README) are licensed as MIT,`
Drop the copyright year from all files I actually copied that strategy from curl: https://daniel.haxx.se/blog/2023/01/08/copyright-without-years Comments below that blog post mention other sources, disagreeing or agreeing with the kind of strategy propagated: lawyer propagating the year (re-publishing and own blog): https://liferay.dev/blogs/-/blogs/how-and-why-to-properly-write-copyright-statements-in-your-code#why-keep-the-year https://matija.suklje.name/how-and-why-to-properly-write-copyright-statements-in-your-code#why-keep-the-year linux foundation note about copyright notices w/o years mentioned: https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects To me it seems currently viable to reproduce the date based on the git log, even signed if necessary. 2024-05-05 18:28:43 +02:00			`copyright by Nils Freydank.`
Initial commit 2021-09-30 11:49:37 +02:00
			`The used software has each is own license, but is all FLOSS software.`
README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc 2024-05-05 18:28:43 +02:00
			`// vim:syntax=asciidoc:fileencoding=utf-8:ts=4:expandtab:linebreak:wrap`