[libvirt] [sandbox PATCH v4 17/21] Image: man file for virt-sandbox-image

[Daniel P. Berrange]

On Fri, Aug 28, 2015 at 01:47:45PM +0000, Eren Yagdiran wrote:
> ---
>  bin/Makefile.am            |   5 ++
>  bin/virt-sandbox-image.pod | 172 +++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 177 insertions(+)
>  create mode 100644 bin/virt-sandbox-image.pod

This needs to also update libvirt-sandbox.spec.in to add the new
file to the RPM

> diff --git a/bin/virt-sandbox-image.pod b/bin/virt-sandbox-image.pod
> new file mode 100644
> index 0000000..a85fcd9
> --- /dev/null
> +++ b/bin/virt-sandbox-image.pod

The virt-sandbox-service command split each subcommand up into a separate
man page. We should probably do the same for this too, but that can wait
until after merge.


> +=head1 OPTIONS
> +
> +=over 4
> +
> +=item B<download name -s source -r registry -u username -p password -t template_directory>

Typically the options would be listed before the position
args. eg

  B<download -s source -r registry -u username -p password -t template_directory name>

Also we should probably use 'templatename' instead of just 'name' to
make things unambiguous


> +=item B<run name imagepath format -c command -n network -v volume -s source -d driver>
> +
> +Run already built image.
> +
> +=over 6
> +
> +=item B<name>
> +
> +Template name to download.
> +
> +=item B<imagepath>
> +
> +Image path where template image will be stored.
> +
> +=item B<-c or --command>
> +
> +Command for running a image. If it is not specified, virt-sandbox-image will try to load command params from specified source. E.g /bin/bash

This is called -i / --ignitor in the code

> +
> +=item B<-n or --network>
> +
> +Network params will be passed directly to the virt-sandbox. More information about network params, See C<virt-sandbox(8)>
> +
> +=item B<-v or --volume>
> +
> +Volume params are for binding host-paths to the guest. E.g -v /home:/home will map /home directory from host to the guest.
> +
> +=item B<-d or --driver>
> +
> +Driver parameter can be specified with only supported driver by libvirt-sandbox. These are lxc:///, qemu:///session, qemu:///system.

And this is -c / --connect

Regards,
Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|