From 2724010364e6d7d316a244ae37850e8c91abb87c Mon Sep 17 00:00:00 2001 From: Harald Albers Date: Wed, 9 Sep 2015 17:45:28 +0200 Subject: [PATCH] update docker volume man pages - added --help option - fixed several formatting problems Also added --help to volume inspect reference page. Signed-off-by: Harald Albers --- docs/reference/commandline/volume_inspect.md | 1 + man/docker-volume-create.1.md | 20 ++++++++++++-------- man/docker-volume-inspect.1.md | 11 +++++++---- man/docker-volume-ls.1.md | 13 ++++++++----- man/docker-volume-rm.1.md | 14 ++++++++------ 5 files changed, 36 insertions(+), 23 deletions(-) diff --git a/docs/reference/commandline/volume_inspect.md b/docs/reference/commandline/volume_inspect.md index 291ecb3806..28f5d1fb31 100644 --- a/docs/reference/commandline/volume_inspect.md +++ b/docs/reference/commandline/volume_inspect.md @@ -15,6 +15,7 @@ parent = "smn_cli" Inspect one or more volumes -f, --format= Format the output using the given go template. + --help=false Print usage Returns information about a volume. By default, this command renders all results in a JSON array. You can specify an alternate format to execute a given template diff --git a/man/docker-volume-create.1.md b/man/docker-volume-create.1.md index 37089e4d98..b0cb10cbee 100644 --- a/man/docker-volume-create.1.md +++ b/man/docker-volume-create.1.md @@ -6,11 +6,10 @@ docker-volume-create - Create a new volume # SYNOPSIS **docker volume create** -[**-d**|**--driver**[=*local*]] -[**--name**[=**]] -[**-o**|**--opt**[=**]] - -[OPTIONS] +[**-d**|**--driver**[=*DRIVER*]] +[**--help**] +[**--name**[=*NAME*]] +[**-o**|**--opt**[=*[]*]] # DESCRIPTION @@ -40,11 +39,16 @@ different volume drivers may do different things (or nothing at all). *Note*: The built-in `local` volume driver does not currently accept any options. # OPTIONS -**-d**, **--driver**=[] - Specify volume driver name +**-d**, **--driver**="local" + Specify volume driver name + +**--help** + Print usage statement + **--name**="" Specify volume name -**-o**, **--opt**=map[] + +**-o**, **--opt**=[] Set driver specific options # HISTORY diff --git a/man/docker-volume-inspect.1.md b/man/docker-volume-inspect.1.md index afba3e6aca..6097e96e13 100644 --- a/man/docker-volume-inspect.1.md +++ b/man/docker-volume-inspect.1.md @@ -6,9 +6,9 @@ docker-volume-inspect - Get low-level information about a volume # SYNOPSIS **docker volume inspect** -[**-f**|**--format**[=**]] - -[OPTIONS] VOLUME [VOLUME...] +[**-f**|**--format**[=*FORMAT*]] +[**--help**] +VOLUME [VOLUME...] # DESCRIPTION @@ -20,7 +20,10 @@ format. # OPTIONS **-f**, **--format**="" - Format the output using the given go template. + Format the output using the given go template. + +**--help** + Print usage statement # HISTORY July 2015, created by Brian Goff diff --git a/man/docker-volume-ls.1.md b/man/docker-volume-ls.1.md index 785fd62550..dd79cae8a6 100644 --- a/man/docker-volume-ls.1.md +++ b/man/docker-volume-ls.1.md @@ -6,10 +6,9 @@ docker-volume-ls - List all volumes # SYNOPSIS **docker volume ls** -[**-f**|**--filter**[=**]] -[**-q**|**--quiet**[=**]] - -[OPTIONS] +[**-f**|**--filter**[=*FILTER*]] +[**--help**] +[**-q**|**--quiet**[=*true*|*false*]] # DESCRIPTION @@ -19,7 +18,11 @@ There is a single supported filter `dangling=value` which takes a boolean of `tr # OPTIONS **-f**, **--filter**="" - Provide filter values (i.e. 'dangling=true') + Provide filter values (i.e. 'dangling=true') + +**--help** + Print usage statement + **-q**, **--quiet**=false Only display volume names diff --git a/man/docker-volume-rm.1.md b/man/docker-volume-rm.1.md index a1d519012f..876700d4d4 100644 --- a/man/docker-volume-rm.1.md +++ b/man/docker-volume-rm.1.md @@ -6,19 +6,21 @@ docker-volume-rm - Remove a volume # SYNOPSIS **docker volume rm** - -[OPTIONS] VOLUME [VOLUME...] +[**--help**] +VOLUME [VOLUME...] # DESCRIPTION Removes one or more volumes. You cannot remove a volume that is in use by a container. - ``` - $ docker volume rm hello - hello - ``` + ``` + $ docker volume rm hello + hello + ``` # OPTIONS +**--help** + Print usage statement # HISTORY July 2015, created by Brian Goff