From 92d133e6db5e98782de953b82d25cec7d5e5a99c Mon Sep 17 00:00:00 2001 From: Nils Freydank Date: Sun, 5 May 2024 18:28:43 +0200 Subject: [PATCH] README.{txt,adoc}: Migrate from pseudo-markdown to asciidoc --- README.txt => README.adoc | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) rename README.txt => README.adoc (88%) diff --git a/README.txt b/README.adoc similarity index 88% rename from README.txt rename to README.adoc index 146a275..7863672 100644 --- a/README.txt +++ b/README.adoc @@ -1,4 +1,6 @@ -# control-vm.sh += 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. @@ -10,7 +12,7 @@ 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: - bash @@ -18,26 +20,25 @@ Please install the following tools which are used by the script: - socat - remote-viewer as part of virt-viewer (https://virt-manager.org) -# Usage - -```shell +== Usage +[source, shell] +---- ./control-vm.sh 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 +== 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 +== Copyright The bash script and it's documentation (this README) are licensed as MIT, Copyright 2021 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