From nobody Mon Apr 29 12:33:01 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.zohomail.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 1500119022795219.1006435443793; Sat, 15 Jul 2017 04:43:42 -0700 (PDT) Received: from localhost ([::1]:41645 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dWLU4-0000tk-Gt for importer@patchew.org; Sat, 15 Jul 2017 07:43:40 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:57472) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dWLTD-0000dC-Is for qemu-devel@nongnu.org; Sat, 15 Jul 2017 07:42:49 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dWLTA-0005Nc-EE for qemu-devel@nongnu.org; Sat, 15 Jul 2017 07:42:47 -0400 Received: from research.iiit.ac.in ([196.12.53.8]:45072) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dWLT8-0005Ih-OG for qemu-devel@nongnu.org; Sat, 15 Jul 2017 07:42:44 -0400 Received: from localhost (localhost [127.0.0.1]) by research.iiit.ac.in (Postfix) with ESMTP id E6E2B741B39; Sat, 15 Jul 2017 17:12:34 +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 olOTSVjyBdwf; Sat, 15 Jul 2017 17:12:32 +0530 (IST) Received: from localhost (localhost [127.0.0.1]) by research.iiit.ac.in (Postfix) with ESMTP id 71B3C741F4E; Sat, 15 Jul 2017 17:12:32 +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 Fmrg8xUAlBFg; Sat, 15 Jul 2017 17:12:32 +0530 (IST) Received: from ishani-Inspiron-5558.iiit.ac.in (unknown [10.1.99.12]) by research.iiit.ac.in (Postfix) with ESMTPSA id 4B19D741B39; Sat, 15 Jul 2017 17:12:32 +0530 (IST) DKIM-Filter: OpenDKIM Filter v2.9.2 research.iiit.ac.in 71B3C741F4E DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=research.iiit.ac.in; s=4E8815E6-5B55-11E4-B758-8D4964374E96; t=1500118952; bh=SwQh8I+DBgUMOAqm5u4dnKoIiEWQ4SIhQFqziYkjn4s=; h=From:To:Subject:Date:Message-Id; b=V7XAGVsSHdBhseuPa1P4M/ZU5J8ogYIQe9vDOiV4v2cQTWrPknGn8fBoxG/asoR3d oYdsl4PRMBMltht1JuGQsL8ZWylcnaFhnKVVNp0qIQ53fgxEKFXXT3mK7z/lCnfI8f SKfhBAuLOLwJ5lJfh2PBWT662bxKNvm0SzsITCe8= X-Virus-Scanned: amavisd-new at research.iiit.ac.in From: Ishani Chugh To: qemu-devel@nongnu.org Date: Sat, 15 Jul 2017 17:12:05 +0530 Message-Id: <1500118925-10569-1-git-send-email-chugh.ishani@research.iiit.ac.in> X-Mailer: git-send-email 2.7.4 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 v5] 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-Transfer-Encoding: quoted-printable MIME-Version: 1.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 implementation of manpage listing the commands which the backup tool will support. The manpage wil be build along with other docs when configure is provided with --enable-docs flag in the location contrib/backup in build directory. Signed-off-by: Ishani Chugh --- Makefile | 15 +++-- contrib/backup/qemu-backup.texi | 135 ++++++++++++++++++++++++++++++++++++= ++++ 2 files changed, 146 insertions(+), 4 deletions(-) create mode 100644 contrib/backup/qemu-backup.texi diff --git a/Makefile b/Makefile index 16a0430..1826a74 100644 --- a/Makefile +++ b/Makefile @@ -209,6 +209,8 @@ ifdef BUILD_DOCS DOCS=3Dqemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8 DOCS+=3Ddocs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/= interop/qemu-qmp-ref.7 DOCS+=3Ddocs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/in= terop/qemu-ga-ref.7 +DOCS+=3Dcontrib/backup/qemu-backup.html contrib/backup/qemu-backup.txt +DOCS+=3Dcontrib/backup/qemu-backup.pdf contrib/backup/qemu-backup.info ifdef CONFIG_VIRTFS DOCS+=3Dfsdev/virtfs-proxy-helper.1 endif @@ -508,6 +510,8 @@ VERSION ?=3D $(shell cat VERSION) =20 dist: qemu-$(VERSION).tar.bz2 =20 +qemu-backup.8: contrib/backup/qemu-backup.texi + qemu-%.tar.bz2: $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2= ,%,$@)" =20 @@ -719,16 +723,19 @@ fsdev/virtfs-proxy-helper.1: fsdev/virtfs-proxy-helpe= r.texi qemu-nbd.8: qemu-nbd.texi qemu-option-trace.texi qemu-ga.8: qemu-ga.texi =20 -html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-re= f.html -info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-re= f.info -pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.p= df -txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.t= xt +html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-re= f.html contrib/backup/qemu-backup.html +info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-re= f.info contrib/backup/qemu-backup.info +pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.p= df contrib/backup/qemu-backup.pdf +txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.t= xt contrib/backup/qemu-backup.txt =20 qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ qemu-img.texi qemu-nbd.texi qemu-options.texi qemu-option-trace.texi \ qemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi \ qemu-monitor-info.texi =20 +contrib/backup/qemu-backup.html contrib/backup/qemu-backup.pdf contrib/bac= kup/qemu-backup.txt contrib/backup/qemu-backup.info: \ + contrib/backup/qemu-backup.texi + docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \ docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \ docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7: \ diff --git a/contrib/backup/qemu-backup.texi b/contrib/backup/qemu-backup.t= exi new file mode 100644 index 0000000..ba9f9ec --- /dev/null +++ b/contrib/backup/qemu-backup.texi @@ -0,0 +1,135 @@ +\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 [--tcp] +@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 guest remove --guest guestname +@item qemu-backup drive remove --guest guestname --id driveid +@end itemize +@node Command Parameters +@chapter Command Parameters +@itemize +@item --all: Add all the drives present in a guest which are suitable for = backup. +@item --guest: Name of the guest. +@item --id: id of guest or drive. +@item --inc: (Optional) For incremental backup. +@item --qmp: Path of qmp socket. +@item --target: Destination path on which you want your backup to be made. +@item --tcp: (Optional) Specifies TCP socket. +@end itemize + +@node Command Descriptions +@chapter Command Descriptions +@itemize +@item qemu-backup guest add --guest guestname --qmp socketpath [--tcp] +This command adds a guest to the configuration file given its path to qmp = socket. + +example: +qemu-backup guest add --id=3Dfedora --qmp=3D/var/run/qemu/fedora.sock + +qemu-backup guest add --id=3Dfedora --qmp=3Dlocalhost:4444 --tcp + +@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/ba= ckup/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 and read-only drives. Here all the backup drives will have the same n= ames as original drives 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 guest remove --guest guestname +This command removes the guest from the configuration file. + +example: qemu-backup guest remove --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 + + +@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