[libvirt] [sandbox PATCH 6/6] Update man page to document current virt-sandbox-service options

[Daniel P. Berrange]

On Thu, Apr 18, 2013 at 09:57:01AM -0400, dwalsh at redhat.com wrote:
> From: Dan Walsh <dwalsh at redhat.com>
> 
> Also cleanup some formatting issues in man pages.
> ---
>  bin/virt-sandbox-service-create.pod | 45 ++++++++++++++++++++++++++++++++-----
>  1 file changed, 40 insertions(+), 5 deletions(-)
> 
> diff --git a/bin/virt-sandbox-service-create.pod b/bin/virt-sandbox-service-create.pod
> index fdc44bb..8b9bf95 100644
> --- a/bin/virt-sandbox-service-create.pod
> +++ b/bin/virt-sandbox-service-create.pod
> @@ -4,7 +4,12 @@ virt-sandbox-service create - Create a Security container
>  
>  =head1 SYNOPSIS
>  
> -  virt-sandbox-service [-c URI] create [-h] [ -u UNIT_FILE ] [ --copy ] [-p PATH] [-N NETWORK-OPTS] [-s SECURITY-OPTS] [-i SIZE] [-n] NAME [ COMMAND ]
> +  virt-sandbox-service [-c URI] create [-h] [-C] [-f FILE_TYPE]
> +                                   [--homedir HOMEDIR] [-G GID] [-i IMAGESIZE]
> +                                   [-N NETWORK] [-p PATH] [-s SECURITY]
> +                                   [-u UNITFILES] [--username USERNAME]
> +                                   [-U UID]
> +                                   name [command [command ...]]
>  
>  =head1 DESCRIPTION
>  
> @@ -24,7 +29,7 @@ The create command can setup a sandbox for running one or more systemd unit file
>  
>  Display help message
>  
> -=item B<-c> URI, B<--connect URI>
> +=item B<-c URI>, B<--connect URI>
>  
>  The connection URI for the hypervisor (only LXC or QEMU are
>  supported currently).
> @@ -37,12 +42,30 @@ Name of the systemd unit file to be to run within the Service Container. Can be
>  
>  Copy content from /etc and /var directories that will be mounted within the container.
>  
> +=item B<-G GID>, B<--gid GID>
> +
> +gid to use within an interactive container. 
> +
> +Default: C<UID>.

Should be the primary GID of the user.


> @@ -134,9 +169,9 @@ Create httpd1 Service container
>   Created sandbox config /etc/libvirt-sandbox/httpd1.sandbox
>   Created unit file /etc/systemd/system/httpd at httpd1.service
>  
> -Create foobar1 Service container
> +Create foobar1 Interactive container

With the latest changes I pushed, this is referred to as a "Generic"
container now, since it isn't really Interactive.

> - # virt-sandbox-service create foobar1 -- /usr/bin/foobar -a -b
> + # virt-sandbox-service create -U 1234 foobar1 -- /usr/bin/foobar -a -b
>   Created container dir /var/lib/libvirt/filesystems/foobar1
>   Created sandbox config /etc/libvirt-sandbox/foobar1.sandbox


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 :|