manpage: expand example section and add arbiter volume create example

To avoid looking weird when the arbiter example is added the whole example section is expanded a little bit. Then an example of creating an arbiter volume is added. Signed-off-by: John Mulligan <[email protected]>
cloustone · May 30, 2018 · 5f9b2b0 · 5f9b2b0
1 parent 626a5fc
commit 5f9b2b0
Showing 1 changed file with 23 additions and 1 deletion.
diff --git a/docs/man/heketi-cli.8 b/docs/man/heketi-cli.8
@@ -677,14 +677,36 @@ Can also be set using the environment variable HEKETI\_CLI\_USER.
 \fB\-v\fP, \fB\-\-version\fP[=false]
 Print version.
 .PP
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
+.SS List Volumes
+.PP
+Specify the Heketi server to contact using an environment variable
+and list the volumes.
 .RS
 .nf
 $ export HEKETI\_CLI\_SERVER=http://localhost:8080
 $ heketi\-cli volume list
 .fi
 .RE
+.PP
+.SS Create a Volume
+.PP
+Create a 4 GiB volume.
+.RS
+.nf
+$ heketi\-cli volume create --size 4
+.fi
+.RE
+.PP
+.SS Create an Arbiter Volume
+.PP
+Create a 4 GiB volume that uses the arbiter feature.
+.RS
+.nf
+$ heketi\-cli volume create --size 4 --gluster-volume-options='user.heketi.arbiter true'
+.fi
+.RE
 .SH COPYRIGHT
 .nf
 Copyright (c) 2015-2018 The heketi Authors