[{"id":1769371,"web_url":"http://patchwork.ozlabs.org/comment/1769371/","msgid":"<3c31dda5-167f-9027-1919-db2633cec304@redhat.com>","list_archive_url":null,"date":"2017-09-15T19:11:24","subject":"Re: [Qemu-devel] [PATCH v4 1/3] Add manpage for QEMU Backup Tool","submitter":{"id":64343,"url":"http://patchwork.ozlabs.org/api/people/64343/","name":"John Snow","email":"jsnow@redhat.com"},"content":"On 09/08/2017 12:41 PM, Ishani Chugh wrote:\n> qemu-backup will be a command-line tool for performing full and\n> incremental disk backups on running VMs. It is intended as a\n> reference implementation for management stack and backup developers\n> to see QEMU's backup features in action. This commit is an\n> initial implementation of manpage listing the commands which the\n> backup tool will support. The manpage will be built along with other\n> docs when configure is provided with --enable-docs flag in the\n> location contrib/backup in build directory.\n> \n> Signed-off-by: Ishani Chugh <chugh.ishani@research.iiit.ac.in>\n> ---\n>  Makefile                        |  14 ++--\n>  contrib/backup/qemu-backup.texi | 142 ++++++++++++++++++++++++++++++++++++++++\n>  2 files changed, 152 insertions(+), 4 deletions(-)\n>  create mode 100644 contrib/backup/qemu-backup.texi\n> \n> diff --git a/Makefile b/Makefile\n> index 337a1f6..794cac5 100644\n> --- a/Makefile\n> +++ b/Makefile\n> @@ -209,6 +209,7 @@ ifdef BUILD_DOCS\n>  DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8\n>  DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7\n>  DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7\n> +DOCS+=contrib/backup/qemu-backup.html contrib/backup/qemu-backup.txt\n>  ifdef CONFIG_VIRTFS\n>  DOCS+=fsdev/virtfs-proxy-helper.1\n>  endif\n> @@ -517,6 +518,8 @@ VERSION ?= $(shell cat VERSION)\n> \n>  dist: qemu-$(VERSION).tar.bz2\n> \n> +qemu-backup.8: contrib/backup/qemu-backup.texi\n> +\n>  qemu-%.tar.bz2:\n>  \t$(SRC_PATH)/scripts/make-release \"$(SRC_PATH)\" \"$(patsubst qemu-%.tar.bz2,%,$@)\"\n> \n> @@ -728,16 +731,19 @@ fsdev/virtfs-proxy-helper.1: fsdev/virtfs-proxy-helper.texi\n>  qemu-nbd.8: qemu-nbd.texi qemu-option-trace.texi\n>  qemu-ga.8: qemu-ga.texi\n> \n> -html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html\n> -info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info\n> -pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf\n> -txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt\n> +html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html contrib/backup/qemu-backup.html\n> +info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info contrib/backup/qemu-backup.info\n> +pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf contrib/backup/qemu-backup.pdf\n> +txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt contrib/backup/qemu-backup.txt\n> \n>  qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \\\n>  \tqemu-img.texi qemu-nbd.texi qemu-options.texi qemu-option-trace.texi \\\n>  \tqemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi \\\n>  \tqemu-monitor-info.texi\n> \n> +contrib/backup/qemu-backup.html contrib/backup/qemu-backup.pdf contrib/backup/qemu-backup.txt contrib/backup/qemu-backup.info: \\\n> +\tcontrib/backup/qemu-backup.texi\n> +\n>  docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \\\n>      docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \\\n>      docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7: \\\n> diff --git a/contrib/backup/qemu-backup.texi b/contrib/backup/qemu-backup.texi\n> new file mode 100644\n> index 0000000..7ad266c\n> --- /dev/null\n> +++ b/contrib/backup/qemu-backup.texi\n> @@ -0,0 +1,142 @@\n> +\\input texinfo\n> +@setfilename qemu-backup\n> +\n> +@documentlanguage en\n> +@documentencoding UTF-8\n> +\n> +@settitle QEMU Backup Tool\n> +@copying\n> +\n> +Copyright @copyright{} 2017 The QEMU Project developers\n> +@end copying\n> +@ifinfo\n> +@direntry\n> +* QEMU: (QEMU-backup).    Man page for QEMU Backup Tool.\n> +@end direntry\n> +@end ifinfo\n> +@iftex\n> +@titlepage\n> +@sp 7\n> +@center @titlefont{QEMU Backup Tool}\n> +@sp 1\n> +@sp 3\n> +@end titlepage\n> +@end iftex\n> +@ifnottex\n> +@node Top\n> +@top Short Sample\n> +\n> +@menu\n> +* Name::\n> +* Synopsis::\n> +* List of Commands::\n> +* Command Parameters::\n> +* Command Descriptions::\n> +* License::\n> +@end menu\n> +\n> +@end ifnottex\n> +\n> +@node Name\n> +@chapter Name\n> +\n> +QEMU disk backup tool.\n> +\n> +@node Synopsis\n> +@chapter Synopsis\n> +\n> +qemu-backup command [command options].\n> +\n> +@node  List of Commands\n> +@chapter  List of Commands\n> +@itemize\n> +@item qemu-backup guest add --guest guestname --qmp socketpath\n> +@item qemu-backup guest list\n> +@item qemu-backup drive add --id driveid --guest guestname --target target\n> +@item qemu-backup drive add --all --guest guestname --target target\n> +@item qemu-backup drive list --guest guestname\n> +@item qemu-backup restore --guest guestname\n> +@item qemu-backup guest remove --guest guestname\n> +@item qemu-backup drive remove --guest guestname --id driveid\n> +@end itemize\n> +@node  Command Parameters\n> +@chapter  Command Parameters\n> +@itemize\n> +@item --all: Add all the drives present in a guest which are suitable for backup.\n> +@item --guest: Name of the guest.\n> +@item --id: id of guest or drive.\n> +@item --qmp: Path of qmp socket.\n> +@item --target: Destination path on which you want your backup to be made.\n> +@end itemize\n> +\n> +@node  Command Descriptions\n> +@chapter  Command Descriptions\n> +@itemize\n> +@item qemu-backup guest add --guest guestname --qmp socketpath\n> +This command adds a guest to the configuration file given its path to qmp socket.\n\nIn the generated output (contrib/backup/qemu-backup.html) this doesn't\nactually create a newline, and the resultant text looks like this:\n\nqemu-backup guest add –guest guestname –qmp socketpath This command adds\na guest to the configuration file given its path to qmp socket.\n\nLooking at some other texi docs, @item appears by itself on a newline:\n\n(from qemu-doc.texi:)\n\n@item\nQEMU can optionally use an in-kernel accelerator, like kvm. The\naccelerators\nexecute most of the guest code natively, while\ncontinuing to emulate the rest of the machine.\n\nIf your intention was to create a heading and a paragraph, you may need\nadditional markup to accomplish this. The resulting documentation is a\nlittle difficult to read otherwise.\n\n> +\n> +example:\n\nPerhaps \"examples\" as there are two that follow.\n\n> +qemu-backup guest add --id=fedora --qmp=unix:/var/run/qemu/fedora.sock\n> +\n> +qemu-backup guest add --id=fedora --qmp=tcp:localhost:4444\n> +\n> +@item qemu-backup guest list\n> +This commands lists the names of guests which are added to configuration file.\n\n\"to the configuration file\"\n\n> +\n> +@item qemu-backup drive add --guest guestname --id driveid --target target\n> +This command adds different drives for backup in a particular guest by giving the name of drive to be backed up and target imagefile in which we want to store the drive backup.\n\n\"of the drive\",\n\"and a target image file where the drive backup is to be stored.\"\n\n> +\n> +example: qemu-backup drive add --guest=fedora --id=root --target=/backup/root.img\n> +\n> +@item qemu-backup drive add --all --guest guestname --destination destination\n> +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 names as original drives and target will be the destination folder.\n> +\n> +example: qemu-backup drive add --all --guest fedora --destination =/backup/fedora/\n> +\n\nextra space between destination and =/backup/fedora\n\n> +@item qemu-backup drive list --guest guestname\n> +This commands gives the names of the drive present in a guest which are added for backup.\n> +\n\n\"of the drives\", and perhaps \"which have been configured for backup\"\n\n> +example: qemu-backup drive list --guest=fedora\n> +\n> +@item qemu-backup backup --guest guestname\n> +\n> +This command makes the backup of the drives, in their respective given destinations. The ids of drive and their destinations are taken from the configuration file.\n> +\n> +example: qemu-backup backup --guest=fedora\n> +\n> +@item qemu-backup restore --guest guestname\n> +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.\n> +\n\nMight be worthwhile to explain why it won't automatically perform these\nactions for you, i.e. any one of these reasons:\n\n- To allow you to safely shut down your VM to preserve data integrity\nfor drives that are (perhaps) not being restored\n- To allow the administrator a chance to move backups that were moved\noff-site back onto the server\n- To allow the administrator a chance to move backups in a more\nefficient way if possible/desired (a python utility may not always have\nthe best information for how to do an efficient restoration, for\ninstance...)\n\n> +example: qemu-backup restore --guest=fedora\n> +\n> +@item qemu-backup guest remove --guest guestname\n> +This command removes the guest from the configuration file.\n> +\n> +example: qemu-backup guest remove --guest=fedora\n> +\n> +@item qemu-backup drive remove --guest guestname --id driveid\n> +This command helps remove a drive which is set for backup in configuration of given host.\n> +\n\n\"helps remove\" should just be \"removes\"\n\n> +example: drive remove --guest=fedora --id=root\n> +\n> +@item A full backup can be performed by following the given steps:\n> +\n> +Perform a full backup of 'vm001', which has one drive:\n> +\n> +qemu-backup guest add --guest vm001 --qmp /path/to/vm001.sock\n> +\n> +qemu-backup add --id drive0 --guest vm001 --target /backups/vm001-drive0.img\n> +\n> +qemu-backup backup --guest vm001\n> +\n> +\n> +@end itemize\n> +\n> +@node License\n> +@appendix License\n> +QEMU is a trademark of Fabrice Bellard.\n> +QEMU is released under the\n> +@url{https://www.gnu.org/licenses/gpl-2.0.txt,GNU General Public License},\n> +version 2. Parts of QEMU have specific licenses, see file\n> +@url{http://git.qemu.org/?p=qemu.git;a=blob_plain;f=LICENSE,LICENSE}.\n> +@bye\n> --\n> 2.7.4\n> \n\nLooks good so far, thank you for your work this summer :)\n\nSince Stefan gave his Reviewed-by for the whole series, I'll leave it up\nto you as to whether or not you want to continue sending revisions. If\nyou'd like to move on and work on something else, I can always send some\nfixup patches myself.\n\nLet me know!\n\nIn the event that you'd like to press on:\n\nReviewed-by: John Snow <jsnow@redhat.com>","headers":{"Return-Path":"<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":["ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=nongnu.org\n\t(client-ip=2001:4830:134:3::11; helo=lists.gnu.org;\n\tenvelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n\treceiver=<UNKNOWN>)","ext-mx01.extmail.prod.ext.phx2.redhat.com;\n\tdmarc=none (p=none dis=none) header.from=redhat.com","ext-mx01.extmail.prod.ext.phx2.redhat.com;\n\tspf=fail smtp.mailfrom=jsnow@redhat.com"],"Received":["from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11])\n\t(using TLSv1 with cipher AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xv4lM13R4z9s7g\n\tfor <incoming@patchwork.ozlabs.org>;\n\tSat, 16 Sep 2017 05:11:59 +1000 (AEST)","from localhost ([::1]:54708 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>)\n\tid 1dsw1t-0000Ys-9a\n\tfor incoming@patchwork.ozlabs.org; Fri, 15 Sep 2017 15:11:57 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:54744)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from <jsnow@redhat.com>) id 1dsw1X-0000YZ-V6\n\tfor qemu-devel@nongnu.org; Fri, 15 Sep 2017 15:11:38 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from <jsnow@redhat.com>) id 1dsw1U-0001Eb-Nb\n\tfor qemu-devel@nongnu.org; Fri, 15 Sep 2017 15:11:35 -0400","from mx1.redhat.com ([209.132.183.28]:48270)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from <jsnow@redhat.com>) id 1dsw1U-0001Ci-EC\n\tfor qemu-devel@nongnu.org; Fri, 15 Sep 2017 15:11:32 -0400","from smtp.corp.redhat.com\n\t(int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11])\n\t(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby mx1.redhat.com (Postfix) with ESMTPS id BA41881DFC;\n\tFri, 15 Sep 2017 19:11:30 +0000 (UTC)","from [10.18.17.130] (dhcp-17-130.bos.redhat.com [10.18.17.130])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id 3E40660468;\n\tFri, 15 Sep 2017 19:11:25 +0000 (UTC)"],"DMARC-Filter":"OpenDMARC Filter v1.3.2 mx1.redhat.com BA41881DFC","From":"John Snow <jsnow@redhat.com>","To":"Ishani Chugh <chugh.ishani@research.iiit.ac.in>, qemu-devel@nongnu.org","References":"<1504888905-22396-1-git-send-email-chugh.ishani@research.iiit.ac.in>\n\t<1504888905-22396-2-git-send-email-chugh.ishani@research.iiit.ac.in>","Message-ID":"<3c31dda5-167f-9027-1919-db2633cec304@redhat.com>","Date":"Fri, 15 Sep 2017 15:11:24 -0400","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101\n\tThunderbird/52.3.0","MIME-Version":"1.0","In-Reply-To":"<1504888905-22396-2-git-send-email-chugh.ishani@research.iiit.ac.in>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-US","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.11","X-Greylist":"Sender IP whitelisted, not delayed by milter-greylist-4.5.16\n\t(mx1.redhat.com [10.5.110.25]);\n\tFri, 15 Sep 2017 19:11:30 +0000 (UTC)","Content-Transfer-Encoding":"quoted-printable","X-detected-operating-system":"by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]\n\t[fuzzy]","X-Received-From":"209.132.183.28","Subject":"Re: [Qemu-devel] [PATCH v4 1/3] Add manpage for QEMU Backup Tool","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.21","Precedence":"list","List-Id":"<qemu-devel.nongnu.org>","List-Unsubscribe":"<https://lists.nongnu.org/mailman/options/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>","List-Archive":"<http://lists.nongnu.org/archive/html/qemu-devel/>","List-Post":"<mailto:qemu-devel@nongnu.org>","List-Help":"<mailto:qemu-devel-request@nongnu.org?subject=help>","List-Subscribe":"<https://lists.nongnu.org/mailman/listinfo/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=subscribe>","Cc":"famz@redhat.com, stefanha@redhat.com","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>"}},{"id":1770509,"web_url":"http://patchwork.ozlabs.org/comment/1770509/","msgid":"<1927575186.665815.1505769581650.JavaMail.zimbra@research.iiit.ac.in>","list_archive_url":null,"date":"2017-09-18T21:19:41","subject":"Re: [Qemu-devel] [PATCH v4 1/3] Add manpage for QEMU Backup Tool","submitter":{"id":71382,"url":"http://patchwork.ozlabs.org/api/people/71382/","name":"Ishani","email":"chugh.ishani@research.iiit.ac.in"},"content":"----- On Sep 16, 2017, at 12:41 AM, jsnow jsnow@redhat.com wrote:\n\n> On 09/08/2017 12:41 PM, Ishani Chugh wrote:\n>> qemu-backup will be a command-line tool for performing full and\n>> incremental disk backups on running VMs. It is intended as a\n>> reference implementation for management stack and backup developers\n>> to see QEMU's backup features in action. This commit is an\n>> initial implementation of manpage listing the commands which the\n>> backup tool will support. The manpage will be built along with other\n>> docs when configure is provided with --enable-docs flag in the\n>> location contrib/backup in build directory.\n>> \n>> Signed-off-by: Ishani Chugh <chugh.ishani@research.iiit.ac.in>\n>> ---\n>>  Makefile                        |  14 ++--\n>>  contrib/backup/qemu-backup.texi | 142 ++++++++++++++++++++++++++++++++++++++++\n>>  2 files changed, 152 insertions(+), 4 deletions(-)\n>>  create mode 100644 contrib/backup/qemu-backup.texi\n>> \n>> diff --git a/Makefile b/Makefile\n>> index 337a1f6..794cac5 100644\n>> --- a/Makefile\n>> +++ b/Makefile\n>> @@ -209,6 +209,7 @@ ifdef BUILD_DOCS\n>>  DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8\n>>  DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt\n>>  docs/interop/qemu-qmp-ref.7\n>>  DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt\n>>  docs/interop/qemu-ga-ref.7\n>> +DOCS+=contrib/backup/qemu-backup.html contrib/backup/qemu-backup.txt\n>>  ifdef CONFIG_VIRTFS\n>>  DOCS+=fsdev/virtfs-proxy-helper.1\n>>  endif\n>> @@ -517,6 +518,8 @@ VERSION ?= $(shell cat VERSION)\n>> \n>>  dist: qemu-$(VERSION).tar.bz2\n>> \n>> +qemu-backup.8: contrib/backup/qemu-backup.texi\n>> +\n>>  qemu-%.tar.bz2:\n>>  \t$(SRC_PATH)/scripts/make-release \"$(SRC_PATH)\" \"$(patsubst qemu-%.tar.bz2,%,$@)\"\n>> \n>> @@ -728,16 +731,19 @@ fsdev/virtfs-proxy-helper.1:\n>> fsdev/virtfs-proxy-helper.texi\n>>  qemu-nbd.8: qemu-nbd.texi qemu-option-trace.texi\n>>  qemu-ga.8: qemu-ga.texi\n>> \n>> -html: qemu-doc.html docs/interop/qemu-qmp-ref.html\n>> docs/interop/qemu-ga-ref.html\n>> -info: qemu-doc.info docs/interop/qemu-qmp-ref.info\n>> docs/interop/qemu-ga-ref.info\n>> -pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf\n>> -txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt\n>> +html: qemu-doc.html docs/interop/qemu-qmp-ref.html\n>> docs/interop/qemu-ga-ref.html contrib/backup/qemu-backup.html\n>> +info: qemu-doc.info docs/interop/qemu-qmp-ref.info\n>> docs/interop/qemu-ga-ref.info contrib/backup/qemu-backup.info\n>> +pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf\n>> contrib/backup/qemu-backup.pdf\n>> +txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt\n>> contrib/backup/qemu-backup.txt\n>> \n>>  qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \\\n>>  \tqemu-img.texi qemu-nbd.texi qemu-options.texi qemu-option-trace.texi \\\n>>  \tqemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi \\\n>>  \tqemu-monitor-info.texi\n>> \n>> +contrib/backup/qemu-backup.html contrib/backup/qemu-backup.pdf\n>> contrib/backup/qemu-backup.txt contrib/backup/qemu-backup.info: \\\n>> +\tcontrib/backup/qemu-backup.texi\n>> +\n>>  docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \\\n>>      docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \\\n>>      docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7: \\\n>> diff --git a/contrib/backup/qemu-backup.texi b/contrib/backup/qemu-backup.texi\n>> new file mode 100644\n>> index 0000000..7ad266c\n>> --- /dev/null\n>> +++ b/contrib/backup/qemu-backup.texi\n>> @@ -0,0 +1,142 @@\n>> +\\input texinfo\n>> +@setfilename qemu-backup\n>> +\n>> +@documentlanguage en\n>> +@documentencoding UTF-8\n>> +\n>> +@settitle QEMU Backup Tool\n>> +@copying\n>> +\n>> +Copyright @copyright{} 2017 The QEMU Project developers\n>> +@end copying\n>> +@ifinfo\n>> +@direntry\n>> +* QEMU: (QEMU-backup).    Man page for QEMU Backup Tool.\n>> +@end direntry\n>> +@end ifinfo\n>> +@iftex\n>> +@titlepage\n>> +@sp 7\n>> +@center @titlefont{QEMU Backup Tool}\n>> +@sp 1\n>> +@sp 3\n>> +@end titlepage\n>> +@end iftex\n>> +@ifnottex\n>> +@node Top\n>> +@top Short Sample\n>> +\n>> +@menu\n>> +* Name::\n>> +* Synopsis::\n>> +* List of Commands::\n>> +* Command Parameters::\n>> +* Command Descriptions::\n>> +* License::\n>> +@end menu\n>> +\n>> +@end ifnottex\n>> +\n>> +@node Name\n>> +@chapter Name\n>> +\n>> +QEMU disk backup tool.\n>> +\n>> +@node Synopsis\n>> +@chapter Synopsis\n>> +\n>> +qemu-backup command [command options].\n>> +\n>> +@node  List of Commands\n>> +@chapter  List of Commands\n>> +@itemize\n>> +@item qemu-backup guest add --guest guestname --qmp socketpath\n>> +@item qemu-backup guest list\n>> +@item qemu-backup drive add --id driveid --guest guestname --target target\n>> +@item qemu-backup drive add --all --guest guestname --target target\n>> +@item qemu-backup drive list --guest guestname\n>> +@item qemu-backup restore --guest guestname\n>> +@item qemu-backup guest remove --guest guestname\n>> +@item qemu-backup drive remove --guest guestname --id driveid\n>> +@end itemize\n>> +@node  Command Parameters\n>> +@chapter  Command Parameters\n>> +@itemize\n>> +@item --all: Add all the drives present in a guest which are suitable for\n>> backup.\n>> +@item --guest: Name of the guest.\n>> +@item --id: id of guest or drive.\n>> +@item --qmp: Path of qmp socket.\n>> +@item --target: Destination path on which you want your backup to be made.\n>> +@end itemize\n>> +\n>> +@node  Command Descriptions\n>> +@chapter  Command Descriptions\n>> +@itemize\n>> +@item qemu-backup guest add --guest guestname --qmp socketpath\n>> +This command adds a guest to the configuration file given its path to qmp\n>> socket.\n> \n> In the generated output (contrib/backup/qemu-backup.html) this doesn't\n> actually create a newline, and the resultant text looks like this:\n> \n> qemu-backup guest add –guest guestname –qmp socketpath This command adds\n> a guest to the configuration file given its path to qmp socket.\n> \n> Looking at some other texi docs, @item appears by itself on a newline:\n> \n> (from qemu-doc.texi:)\n> \n> @item\n> QEMU can optionally use an in-kernel accelerator, like kvm. The\n> accelerators\n> execute most of the guest code natively, while\n> continuing to emulate the rest of the machine.\n> \n> If your intention was to create a heading and a paragraph, you may need\n> additional markup to accomplish this. The resulting documentation is a\n> little difficult to read otherwise.\n> \n>> +\n>> +example:\n> \n> Perhaps \"examples\" as there are two that follow.\n> \n>> +qemu-backup guest add --id=fedora --qmp=unix:/var/run/qemu/fedora.sock\n>> +\n>> +qemu-backup guest add --id=fedora --qmp=tcp:localhost:4444\n>> +\n>> +@item qemu-backup guest list\n>> +This commands lists the names of guests which are added to configuration file.\n> \n> \"to the configuration file\"\n> \n>> +\n>> +@item qemu-backup drive add --guest guestname --id driveid --target target\n>> +This command adds different drives for backup in a particular guest by giving\n>> the name of drive to be backed up and target imagefile in which we want to\n>> store the drive backup.\n> \n> \"of the drive\",\n> \"and a target image file where the drive backup is to be stored.\"\n> \n>> +\n>> +example: qemu-backup drive add --guest=fedora --id=root\n>> --target=/backup/root.img\n>> +\n>> +@item qemu-backup drive add --all --guest guestname --destination destination\n>> +This command adds all the drives of the guest for backup other than CDROM drive\n>> and read-only drives. Here all the backup drives will have the same names as\n>> original drives and target will be the destination folder.\n>> +\n>> +example: qemu-backup drive add --all --guest fedora --destination\n>> =/backup/fedora/\n>> +\n> \n> extra space between destination and =/backup/fedora\n> \n>> +@item qemu-backup drive list --guest guestname\n>> +This commands gives the names of the drive present in a guest which are added\n>> for backup.\n>> +\n> \n> \"of the drives\", and perhaps \"which have been configured for backup\"\n> \n>> +example: qemu-backup drive list --guest=fedora\n>> +\n>> +@item qemu-backup backup --guest guestname\n>> +\n>> +This command makes the backup of the drives, in their respective given\n>> destinations. The ids of drive and their destinations are taken from the\n>> configuration file.\n>> +\n>> +example: qemu-backup backup --guest=fedora\n>> +\n>> +@item qemu-backup restore --guest guestname\n>> +This command is needed if we want to restore the backup. It will list the\n>> commands to be run for performing the same but will not perform any action.\n>> +\n> \n> Might be worthwhile to explain why it won't automatically perform these\n> actions for you, i.e. any one of these reasons:\n> \n> - To allow you to safely shut down your VM to preserve data integrity\n> for drives that are (perhaps) not being restored\n> - To allow the administrator a chance to move backups that were moved\n> off-site back onto the server\n> - To allow the administrator a chance to move backups in a more\n> efficient way if possible/desired (a python utility may not always have\n> the best information for how to do an efficient restoration, for\n> instance...)\n> \n>> +example: qemu-backup restore --guest=fedora\n>> +\n>> +@item qemu-backup guest remove --guest guestname\n>> +This command removes the guest from the configuration file.\n>> +\n>> +example: qemu-backup guest remove --guest=fedora\n>> +\n>> +@item qemu-backup drive remove --guest guestname --id driveid\n>> +This command helps remove a drive which is set for backup in configuration of\n>> given host.\n>> +\n> \n> \"helps remove\" should just be \"removes\"\n> \n>> +example: drive remove --guest=fedora --id=root\n>> +\n>> +@item A full backup can be performed by following the given steps:\n>> +\n>> +Perform a full backup of 'vm001', which has one drive:\n>> +\n>> +qemu-backup guest add --guest vm001 --qmp /path/to/vm001.sock\n>> +\n>> +qemu-backup add --id drive0 --guest vm001 --target /backups/vm001-drive0.img\n>> +\n>> +qemu-backup backup --guest vm001\n>> +\n>> +\n>> +@end itemize\n>> +\n>> +@node License\n>> +@appendix License\n>> +QEMU is a trademark of Fabrice Bellard.\n>> +QEMU is released under the\n>> +@url{https://www.gnu.org/licenses/gpl-2.0.txt,GNU General Public License},\n>> +version 2. Parts of QEMU have specific licenses, see file\n>> +@url{http://git.qemu.org/?p=qemu.git;a=blob_plain;f=LICENSE,LICENSE}.\n>> +@bye\n>> --\n>> 2.7.4\n>> \n> \n> Looks good so far, thank you for your work this summer :)\n> \n> Since Stefan gave his Reviewed-by for the whole series, I'll leave it up\n> to you as to whether or not you want to continue sending revisions. If\n> you'd like to move on and work on something else, I can always send some\n> fixup patches myself.\n> \n> Let me know!\n> \n> In the event that you'd like to press on:\n> \n> Reviewed-by: John Snow <jsnow@redhat.com>\n\nThanks for review. I will address the comments in next revision. I would like\nto keep on contributing and sending revisions. Thanks for being so helpful entire summer :)\n\nRegards,\nIshani","headers":{"Return-Path":"<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":["ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=nongnu.org\n\t(client-ip=2001:4830:134:3::11; helo=lists.gnu.org;\n\tenvelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n\treceiver=<UNKNOWN>)","ozlabs.org; dkim=pass (1024-bit key;\n\tunprotected) header.d=research.iiit.ac.in\n\theader.i=@research.iiit.ac.in header.b=\"SfCRtmhT\"; \n\tdkim-atps=neutral"],"Received":["from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11])\n\t(using TLSv1 with cipher AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xwzSK1lr2z9s7m\n\tfor <incoming@patchwork.ozlabs.org>;\n\tTue, 19 Sep 2017 07:20:32 +1000 (AEST)","from localhost ([::1]:38962 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>)\n\tid 1du3Su-0008U9-Kk\n\tfor incoming@patchwork.ozlabs.org; Mon, 18 Sep 2017 17:20:28 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:45006)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from <chugh.ishani@research.iiit.ac.in>)\n\tid 1du3SL-0008Tu-Md\n\tfor qemu-devel@nongnu.org; Mon, 18 Sep 2017 17:19:55 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from <chugh.ishani@research.iiit.ac.in>)\n\tid 1du3SI-0005i6-3w\n\tfor qemu-devel@nongnu.org; Mon, 18 Sep 2017 17:19:53 -0400","from research.iiit.ac.in ([196.12.53.8]:44858)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from <chugh.ishani@research.iiit.ac.in>)\n\tid 1du3SH-0005ge-5S\n\tfor qemu-devel@nongnu.org; Mon, 18 Sep 2017 17:19:50 -0400","from localhost (localhost [127.0.0.1])\n\tby research.iiit.ac.in (Postfix) with ESMTP id A428B741AB0;\n\tTue, 19 Sep 2017 02:49:45 +0530 (IST)","from research.iiit.ac.in ([127.0.0.1])\n\tby localhost (research.iiit.ac.in [127.0.0.1]) (amavisd-new,\n\tport 10032)\n\twith ESMTP id lkJylgUb100u; Tue, 19 Sep 2017 02:49:41 +0530 (IST)","from localhost (localhost [127.0.0.1])\n\tby research.iiit.ac.in (Postfix) with ESMTP id C2871741B0A;\n\tTue, 19 Sep 2017 02:49:41 +0530 (IST)","from research.iiit.ac.in ([127.0.0.1])\n\tby localhost (research.iiit.ac.in [127.0.0.1]) (amavisd-new,\n\tport 10026)\n\twith ESMTP id y2vvuyP6I1F0; Tue, 19 Sep 2017 02:49:41 +0530 (IST)","from research.iiit.ac.in (localhost [127.0.0.1])\n\tby research.iiit.ac.in (Postfix) with ESMTP id A5CD2741AB0;\n\tTue, 19 Sep 2017 02:49:41 +0530 (IST)"],"DKIM-Filter":"OpenDKIM Filter v2.9.2 research.iiit.ac.in C2871741B0A","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=research.iiit.ac.in; \n\ts=4E8815E6-5B55-11E4-B758-8D4964374E96; t=1505769581;\n\tbh=9BsKpjaSxoKMmp0PwPnrnBDI5v3gK6SzpEi71J0hEDc=;\n\th=Date:From:To:Message-ID:Subject:MIME-Version:Content-Type:\n\tContent-Transfer-Encoding;\n\tb=SfCRtmhT79l0kcYE3j1dAaQDqsGHNk9E1R5v8XGiARByVW7V9V0d6Ipkh9Vdcm0/a\n\tv1SKx5LNXApLP10eBB/hTDkfezZiXt+MRzJEyUfJYS3KTsxU1eIMJcJZYYqutIJYbx\n\t0Hmd+ACVfIlxAO8sBKyMRRSSYc/1TEz4P/ml5Ras=","X-Virus-Scanned":"amavisd-new at research.iiit.ac.in","Date":"Tue, 19 Sep 2017 02:49:41 +0530 (IST)","From":"Ishani <chugh.ishani@research.iiit.ac.in>","To":"jsnow <jsnow@redhat.com>","Message-ID":"<1927575186.665815.1505769581650.JavaMail.zimbra@research.iiit.ac.in>","In-Reply-To":"<3c31dda5-167f-9027-1919-db2633cec304@redhat.com>","References":"<1504888905-22396-1-git-send-email-chugh.ishani@research.iiit.ac.in>\n\t<1504888905-22396-2-git-send-email-chugh.ishani@research.iiit.ac.in>\n\t<3c31dda5-167f-9027-1919-db2633cec304@redhat.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Transfer-Encoding":"quoted-printable","X-Originating-IP":"[10.2.24.155]","X-Mailer":"Zimbra 8.6.0_GA_1194 (ZimbraWebClient - FF55 (Linux)/8.6.0_GA_1194)","Thread-Topic":"Add manpage for QEMU Backup Tool","Thread-Index":"MQkafkaLfpMO2wJKyOe7O428/Nmycw==","X-detected-operating-system":"by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]\n\t[fuzzy]","X-Received-From":"196.12.53.8","Subject":"Re: [Qemu-devel] [PATCH v4 1/3] Add manpage for QEMU Backup Tool","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.21","Precedence":"list","List-Id":"<qemu-devel.nongnu.org>","List-Unsubscribe":"<https://lists.nongnu.org/mailman/options/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>","List-Archive":"<http://lists.nongnu.org/archive/html/qemu-devel/>","List-Post":"<mailto:qemu-devel@nongnu.org>","List-Help":"<mailto:qemu-devel-request@nongnu.org?subject=help>","List-Subscribe":"<https://lists.nongnu.org/mailman/listinfo/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=subscribe>","Cc":"famz@redhat.com, qemu-devel@nongnu.org, stefanha <stefanha@redhat.com>","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>"}}]