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

From: Dan Walsh <dwalsh(a)redhat.com&gt; 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>. + +=item B<-f FILETYPE>, B<--filetype FILETYPE> + +Specify the SELinux file type to use within the container. + +Default: C<svirt_lxc_file_t>. + =item B<-p PATH>, B<--path PATH> Select path to store container content. Default: C</var/lib/libvirt/filesystems>. +=item B<--homedir HOMEDIR> + +Select homedir path to use within an interactive container. + +Default: C<UID's Homedir>. + =item B<-N NETWORK-OPTIONS>, B<--network NETWORK-OPTIONS> Add a network interface to the sandbox. By default the sandbox will @@ -119,10 +142,22 @@ static,label=system_u:system_r:svirt_t:s0:c412,c355 Create file system image file of this size to store container content. -=item B<-u unitfile>, B<--unitfile unitfile> +=item B<-u UNITFILE>, B<--unitfile UNITFILE> systemd Unit file to run within the container +=item B<-U UID>, B<--uid UID> + +uid to use within an interactive container. + +Default: C<0>. + +=item B<--username USERNAME> + +Select username to use within an interactive container. + +Default: C<UID's Username>. + =back =head1 EXAMPLE @@ -134,9 +169,9 @@ Create httpd1 Service container Created sandbox config /etc/libvirt-sandbox/httpd1.sandbox Created unit file /etc/systemd/system/httpd(a)httpd1.service -Create foobar1 Service container +Create foobar1 Interactive container - # 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 -- 1.8.2