From ccba8aeea2305f1174a8280ff93dd8e467cdc5b6 Mon Sep 17 00:00:00 2001 From: Russell Ballestrini Date: Mon, 8 Jul 2024 08:57:37 -0400 Subject: [PATCH] update readme and bump version modified: README.md modified: setup.py --- README.md | 52 +++++++++++++++++++++++++--------------------------- setup.py | 2 +- 2 files changed, 26 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 19d8ca2..0e02005 100644 --- a/README.md +++ b/README.md @@ -12,49 +12,47 @@ https://git.unturf.com/python/virt-back **usage** ``` -root@guile[/mnt/downloads/virt-back]# ./virt-back --help -Usage: virt-back [options] +virt-back --help +usage: virt-back [-h] [-q] [-d] [-g] [-a amount] [-p 'PATH'] [-u 'URI'] [-i] [--info-all] [-b] [-r] [-s] [-c] [--backup-all] [--reboot-all] [--shutdown-all] [--create-all] + +A backup utility for QEMU, KVM, XEN, and Virtualbox guests. Virt-back is a python application that uses the libvirt api to safely shutdown, gzip, and restart guests. The backup process +logs to syslog for auditing and virt-back works great with cron for scheduling outages. Virt-back has been placed in the public domain and the latest version may be downloaded here: -A backup utility for QEMU, KVM, XEN, and Virtualbox guests. Virt-back is a -python application that uses the libvirt api to safely shutdown, gzip, and -restart guests. The backup process logs to syslog for auditing and virt-back -works great with cron for scheduling outages. Virt-back has been placed in the -public domain and the latest version may be downloaded here: https://git.unturf.com/python/virt-back -Options: +options: -h, --help show this help message and exit -q, --quiet prevent output to stdout -d, --date append date to tar filename [default: no date] -g, --no-gzip do not gzip the resulting tar file - -a amount, --retention=amount + -a amount, --retention amount backups to retain [default: 3] - -p 'PATH', --path='PATH' + -p 'PATH', --path 'PATH' backup path [default: '/KVMBACK'] - -u 'URI', --uri='URI' + -u 'URI', --uri 'URI' optional hypervisor uri - Actions for info testing: - These options display info or test a list of guests. +Actions for info testing: + These options display info or test a list of guests. - -i, --info info/test a list of guests (space delimited dom names) - --info-all attempt to show info on ALL guests + -i, --info info/test a list of guests (space delimited dom names) + --info-all attempt to show info on ALL guests - Actions for a list of dom names: - WARNING: These options WILL bring down guests! +Actions for a list of dom names: + WARNING: These options WILL bring down guests! - -b, --backup backup a list of guests (space delimited dom names) - -r, --reboot reboot a list of guests (space delimited dom names) - -s, --shutdown shutdown a list of guests (space delimited dom names) - -c, --create start a list of guests (space delimited dom names) + -b, --backup backup a list of guests (space delimited dom names) + -r, --reboot reboot a list of guests (space delimited dom names) + -s, --shutdown shutdown a list of guests (space delimited dom names) + -c, --create start a list of guests (space delimited dom names) - Actions for all doms: - WARNING: These options WILL bring down ALL guests! +Actions for all doms: + WARNING: These options WILL bring down ALL guests! - --backup-all attempt to shutdown, backup, and start ALL guests - --reboot-all attempt to shutdown and then start ALL guests - --shutdown-all attempt to shutdown ALL guests - --create-all attempt to start ALL guests + --backup-all attempt to shutdown, backup, and start ALL guests + --reboot-all attempt to shutdown and then start ALL guests + --shutdown-all attempt to shutdown ALL guests + --create-all attempt to start ALL guests ``` diff --git a/setup.py b/setup.py index afa323e..30fd31e 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open(os.path.join(os.path.dirname(__file__), "README.md"), encoding="utf-8" setup( name="virt-back", - version="0.2.2", + version="0.2.4", description="virt-back: A backup utility for QEMU, KVM, XEN, and Virtualbox guests", keywords="backup virtual hypervisor QEMU KVM XEN Virtualbox", long_description=long_description,