From nobody Wed Nov 5 12:03:24 2025 Delivered-To: importer@patchew.org Received-SPF: temperror (zoho.com: Error in retrieving data from DNS) 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=temperror (zoho.com: Error in retrieving data from DNS) 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 149815535844081.76542325716377; Thu, 22 Jun 2017 11:15:58 -0700 (PDT) Received: from localhost ([::1]:60403 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dO6e3-0003SY-4T for importer@patchew.org; Thu, 22 Jun 2017 14:15:55 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:47020) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dO6bc-0001mZ-Lw for qemu-devel@nongnu.org; Thu, 22 Jun 2017 14:13:26 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dO6bZ-0002ZT-Dc for qemu-devel@nongnu.org; Thu, 22 Jun 2017 14:13:24 -0400 Received: from research.iiit.ac.in ([196.12.53.8]:37810) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dO6bY-0002Xc-EQ for qemu-devel@nongnu.org; Thu, 22 Jun 2017 14:13:21 -0400 Received: from localhost (localhost [127.0.0.1]) by research.iiit.ac.in (Postfix) with ESMTP id ED347741AC9; Thu, 22 Jun 2017 23:43:13 +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 JfqAKA5C2nCL; Thu, 22 Jun 2017 23:43:11 +0530 (IST) Received: from localhost (localhost [127.0.0.1]) by research.iiit.ac.in (Postfix) with ESMTP id 0A63E741AFE; Thu, 22 Jun 2017 23:43:11 +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 2QKr4iCGk4Ry; Thu, 22 Jun 2017 23:43:10 +0530 (IST) Received: from ishani-Inspiron-5558.iiit.ac.in (unknown [10.1.97.126]) by research.iiit.ac.in (Postfix) with ESMTPSA id C130A741AC9; Thu, 22 Jun 2017 23:43:10 +0530 (IST) DKIM-Filter: OpenDKIM Filter v2.9.2 research.iiit.ac.in 0A63E741AFE DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=research.iiit.ac.in; s=4E8815E6-5B55-11E4-B758-8D4964374E96; t=1498155191; bh=UihW1FIbhQ8kghfnKdqpA/yA3JD43XUpHLNywh3DU7M=; h=From:To:Subject:Date:Message-Id:MIME-Version:Content-Type: Content-Transfer-Encoding; b=T/ZJTPv2E7DTxLZacHmCmlB0gg8I4Xpos8ObYgFuNSOCDdUTmyHM10suruI1hdmrK JIzk0D5WnVlPJKc/Dy8DQmtNTcU41GpwzLY0VsQI/u9RUSvfrvuKZFiTXVZuIqssc7 y7zNfetXCjlvxMSa9+omw5EmJVaT97ei7DnL/06A= X-Virus-Scanned: amavisd-new at research.iiit.ac.in From: Ishani Chugh To: qemu-devel@nongnu.org Date: Thu, 22 Jun 2017 23:43:02 +0530 Message-Id: <1498155182-27351-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 v4] 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_6 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 i= n action. The following commit is an initial implementation of manpage list= ing the commands which the backup tool will support. Signed-off-by: Ishani Chugh --- Makefile | 2 +- contrib/backup/qemu-backup.texi | 132 ++++++++++++++++++++++++++++++++++++= ++++ 2 files changed, 133 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..cdfad82 --- /dev/null +++ b/contrib/backup/qemu-backup.texi @@ -0,0 +1,132 @@ +\input texinfo +@setfilename qemu-backup + +@documentlanguage en +@documentencoding UTF-8 + +@settitle QEMU Backup Tool +@copying + +Copyright @copyright{} 2017 The QEMU Project developers +@end copying +@ifinfo +@direntry +* QEMU: (QEMU-backup). Man page for QEMU Backup Tool. +@end direntry +@end ifinfo +@iftex +@titlepage +@sp 7 +@center @titlefont{QEMU Backup Tool} +@sp 1 +@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 +@itemize +@item qemu-backup guest add --guest guestname --qmp socketpath +@item qemu-backup guest list +@item qemu-backup drive add --id driveid --guest guestname --target target +@item qemu-backup drive add --all --guest guestname --target target +@item qemu-backup drive list --guest guestname +@item qemu-backup backup [--inc] --guest guestname +@item qemu-backup restore --guest guestname +@item qemu-backup drive remove --guest guestname --id driveid +@item qemu-backup guest remove --guest guestname +@end itemize +@node Command Parameters +@chapter Command Parameters +@itemize +@item --guest: Name of the guest. +@item --id: id of guest or drive. +@item --target: Destination path on which you want your backup to be made. +@item --all: Add all the drives present in a guest which are suitable for = backup. +@item --inc: For incremental backup. +@item --qmp: Path of qmp socket. +@end itemize + +@node Command Descriptions +@chapter Command Descriptions +@itemize +@item qemu-backup guest add --guest guestname --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 target +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/root.img + +@item qemu-backup drive add --all --guest guestname --destination destinat= ion +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/ + +@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 + +@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: drive remove --guest=3Dfedora --id=3Droot + +@item qemu-backup guest remove --guest guestname +This command removes the guest from the configuration file. + +example: qemu-backup guest remove --guest=3Dfedora + +@end itemize + +@node License +@appendix License +QEMU is a trademark of Fabrice Bellard. +QEMU is released under the +@url{https://www.gnu.org/licenses/gpl-2.0.txt,GNU General Public License}, +version 2. Parts of QEMU have specific licenses, see file +@url{http://git.qemu.org/?p=3Dqemu.git;a=3Dblob_plain;f=3DLICENSE,LICENSE}. +@bye --=20 2.7.4