Re: [Qemu-devel] [PATCH 3/3] Add manpage for QEMU Backup Tool

[Stefan Hajnoczi <stefanha@redhat.com>]

On Mon, Aug 21, 2017 at 04:40:39PM +0530, Ishani Chugh wrote:
> +@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 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.
> +@end itemize

It would be helpful to give an example that demonstrates the workflow.
That way new users will know which sub-commands to use and in which
order.  Something like:

Perform a full backup of 'vm001', which has one drive:

  $ qemu-backup guest add --guest vm001 --qmp /path/to/vm001.sock
  $ qemu-backup add --id drive0 --guest vm001 --target /backups/vm001-drive0.img
  $ qemu-backup backup --guest vm001

Stefan