From nobody Sun May 5 12:00:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zoho.com; dkim=fail spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1497905572191848.533144772936; Mon, 19 Jun 2017 13:52:52 -0700 (PDT) Received: from localhost ([::1]:44285 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dN3fF-0006h8-TX for importer@patchew.org; Mon, 19 Jun 2017 16:52:49 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:47778) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dN3eP-0006FI-4x for qemu-devel@nongnu.org; Mon, 19 Jun 2017 16:51:58 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dN3eK-00076A-7l for qemu-devel@nongnu.org; Mon, 19 Jun 2017 16:51:57 -0400 Received: from research.iiit.ac.in ([196.12.53.8]:55238) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dN3eJ-00072y-9G for qemu-devel@nongnu.org; Mon, 19 Jun 2017 16:51:52 -0400 Received: from localhost (localhost [127.0.0.1]) by research.iiit.ac.in (Postfix) with ESMTP id 26A4B741F38; Tue, 20 Jun 2017 01:44:49 +0530 (IST) Received: from research.iiit.ac.in ([127.0.0.1]) by localhost (research.iiit.ac.in [127.0.0.1]) (amavisd-new, port 10032) with ESMTP id 9pqTozuG87kU; Tue, 20 Jun 2017 01:44:47 +0530 (IST) Received: from localhost (localhost [127.0.0.1]) by research.iiit.ac.in (Postfix) with ESMTP id 621B2741F50; Tue, 20 Jun 2017 01:44:47 +0530 (IST) Received: from research.iiit.ac.in ([127.0.0.1]) by localhost (research.iiit.ac.in [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id WK1BYHBOUazN; Tue, 20 Jun 2017 01:44:47 +0530 (IST) Received: from ishani-Inspiron-5558.iiit.ac.in (unknown [10.1.97.126]) by research.iiit.ac.in (Postfix) with ESMTPSA id 39BF4741F38; Tue, 20 Jun 2017 01:44:47 +0530 (IST) DKIM-Filter: OpenDKIM Filter v2.9.2 research.iiit.ac.in 621B2741F50 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=research.iiit.ac.in; s=4E8815E6-5B55-11E4-B758-8D4964374E96; t=1497903287; bh=WjdSLOJegMv2cGz67ijIq5135A23wnyOdRpvzGM4GAY=; h=From:To:Subject:Date:Message-Id:MIME-Version:Content-Type: Content-Transfer-Encoding; b=AeU7XmZNS5OCO//cRXP9UA5Rc7RlvT27yuL9WK9hC8uZJiy20oSl9ESqg+UzHZKiv tT56QA1ebBfvhV2kZxrGEGiyWCYidik4wGCWMhJg8DAZDQ9mxXT29UHCZocxwi6Zn0 BlNtcxIaeO/2t/W4UhCphw6zraCbAsYfwzzPLNvw= X-Virus-Scanned: amavisd-new at research.iiit.ac.in From: Ishani Chugh To: qemu-devel@nongnu.org Date: Tue, 20 Jun 2017 01:44:22 +0530 Message-Id: <1497903262-18626-1-git-send-email-chugh.ishani@research.iiit.ac.in> X-Mailer: git-send-email 2.7.4 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 196.12.53.8 Subject: [Qemu-devel] [PATCH v3] Add manpage for QEMU Backup Tool X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Ishani Chugh , jsnow@redhat.com, stefanha@redhat.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZohoMail: RDKM_2 RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" qemu-backup will be a command-line tool for performing full and incremental= disk backups on running VMs. It is intended as a reference implementation for management stack and= backup developers to see QEMU's backup features in action. The following commit is an initial im= plementation of manpage listing the commands which the backup tool will support. Signed-off-by: Ishani Chugh --- Makefile | 2 +- contrib/backup/qemu-backup.texi | 139 ++++++++++++++++++++++++++++++++++++= ++++ 2 files changed, 140 insertions(+), 1 deletion(-) create mode 100644 contrib/backup/qemu-backup.texi diff --git a/Makefile b/Makefile index c830d7a..094f291 100644 --- a/Makefile +++ b/Makefile @@ -504,7 +504,7 @@ clean: VERSION ?=3D $(shell cat VERSION) =20 dist: qemu-$(VERSION).tar.bz2 - +qemu-backup.8: contrib/backup/qemu-backup.texi qemu-%.tar.bz2: $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2= ,%,$@)" =20 diff --git a/contrib/backup/qemu-backup.texi b/contrib/backup/qemu-backup.t= exi new file mode 100644 index 0000000..1db63c0 --- /dev/null +++ b/contrib/backup/qemu-backup.texi @@ -0,0 +1,139 @@ +@setfilename qemu-backup-tool-manpage + +@documentlanguage en +@documentencoding UTF-8 + +\input texinfo +@settitle Manpage_backup_tool 1.0 +@copying +This is a manpage for qemu_backup_tool, version 1.0. + +Copyright @copyright{} 2016 Free Software Foundation, Inc. +@end copying +@ifinfo +@direntry +* QEMU: (qemu-backup-tool-manpage). Man page for QEMU backup tool. +@end direntry +@end ifinfo +@iftex +@titlepage +@sp 7 +@center @titlefont{QEMU_backup_tool} +@sp 1 +@center @titlefont{Man Page} +@sp 3 +@end titlepage +@end iftex +@ifnottex +@node Top +@top Short Sample + +@menu +* Name:: +* Synopsis:: +* list of Commands:: +* Command Parameters:: +* Command Descriptions:: +* License:: +@end menu + +@end ifnottex + +@node Name +@chapter Name + +QEMU disk backup tool. + +@node Synopsis +@chapter Synopsis + +qemu-backup command [ command options]. + +@node list of Commands +@chapter list of Commands +@cindex chapter, first dummy +@itemize +@item qemu-backup guest add [--id id] [--qmp socketpath] +@item qemu-backup guest list +@item qemu-backup drive add [--guest guestname] [--id driveid] [--target t= arget] +@item qemu-backup drive list [--guest guestname] +@item qemu-backup backup [--guest guestname] +@item qemu-backup restore [--guest guestname] +@item qemu-backup drive-remove [--guest guestname] [--id driveid] +@item qemu-backup remove [--guest guestname] +@item qemu-backup drive add [--all] [--guest guestname] [--target target] +@item qemu-backup backup [--inc] [--guest guestname] +@end itemize +@node Command Parameters +@chapter Command Parameters +@cindex chapter, first dummy +@itemize +@item --guest: Name of the guest. +@item --id: id of guest or drive. +@item --target: Destination on which you want your backup to be made. +@item --all: Add all the drives present in a guest for backup except cd-ro= m. +@item --inc: For incremental backup. +@item --qmp: Path of qmp socket. +@end itemize + +@node Command Descriptions +@chapter Command Descriptions +@cindex chapter, first dummy +@itemize +@item qemu-backup guest add [--id id] [--qmp socketpath] +This command adds a guest to the configuration file given its path to qmp = socket. +example: +qemu-backup guest add --id=3Dfedora =E2=80=93qmp=3D/var/run/qemu/fedora.so= ck + +@item qemu-backup guest list +This commands lists the names of guests which are added to configuration f= ile. + +@item qemu-backup drive add [--guest guestname] [--id driveid] [--target t= arget] +This command adds different drives for backup in a particular guest by giv= ing the name of drive to be backed up and target imagefile in which we want= to store the drive backup. +example: +qemu-backup drive add --guest=3Dfedora --id=3Droot +--target=3D/backup/fedora/root.img +qemu-backup drive add --guest=3Dfedora --id=3Ddata +--target=3D/backup/fedora/data.img + +@item qemu-backup drive list [--guest guestname] +This commands gives the names of the drive present in a guest which are ad= ded for backup. +example: qemu-backup drive list --guest=3Dfedora + +@item qemu-backup backup [--guest guestname] + +This command makes the backup of the drives, in their respective given des= tinations. The ids of drive and their destinations are taken from the confi= guration file. +example: qemu-backup backup --guest=3Dfedora + +@item qemu-backup restore [--guest guestname] +This command is needed if we want to restore the backup. It will list the = commands to be run for performing the same but will not perform any action. +example: qemu-backup restore --guest=3Dfedora +cp /backup/fedora/root.img /var/run/qemu/fedora/root.img +cp /backup/fedora/data.img /var/run/qemu/fedora/data.img + +@item qemu-backup drive-remove [--guest guestname] [--id driveid] +This command helps remove a drive which is set for backup in configuration= of given host. +example: qemu-backup remove --guest=3Dfedora --id=3Droot + +@item qemu-backup remove [--guest guestname] +This command removes the guest from the configuration file. +example: qemu-backup remove =E2=80=93guest=3Dfedora + +@item qemu-backup drive add --all [-guest guestname] [-destination destina= tion] +This command adds all the drives of the guest for backup other than CDROM = drive. Here all the backup drives will have the same names as original driv= es and target will be the destination folder. +example: qemu-backup drive add --all --guest fedora --destination =3D/back= up/fedora/ + +@end itemize + + +@node License +@appendix License + +QEMU is a trademark of Fabrice Bellard. + +QEMU is released under the GNU General Public License (TODO: add link). +Parts of QEMU have specific licenses, see file LICENSE. + +TODO (refer to file LICENSE, include it, include the GPL?) + +@bye --=20 2.7.4