Bläddra i källkod

Merge pull request #16188 from albers/docs-volume-help

Update docs and man pages for `docker volume` subcommands
moxiegirl 9 år sedan
förälder
incheckning
b154a6f68e

+ 1 - 0
docs/reference/commandline/volume_inspect.md

@@ -15,6 +15,7 @@ parent = "smn_cli"
     Inspect one or more volumes
     Inspect one or more volumes
 
 
     -f, --format=       Format the output using the given go template.
     -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
 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
 in a JSON array. You can specify an alternate format to execute a given template

+ 12 - 8
man/docker-volume-create.1.md

@@ -6,11 +6,10 @@ docker-volume-create - Create a new volume
 
 
 # SYNOPSIS
 # SYNOPSIS
 **docker volume create**
 **docker volume create**
-[**-d**|**--driver**[=*local*]]
-[**--name**[=**]]
-[**-o**|**--opt**[=**]]
-
-[OPTIONS]
+[**-d**|**--driver**[=*DRIVER*]]
+[**--help**]
+[**--name**[=*NAME*]]
+[**-o**|**--opt**[=*[]*]]
 
 
 # DESCRIPTION
 # 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.
 *Note*: The built-in `local` volume driver does not currently accept any options.
 
 
 # OPTIONS
 # OPTIONS
-**-d**, **--driver**=[]
-   Specify volume driver name
+**-d**, **--driver**="local"
+  Specify volume driver name
+
+**--help**
+  Print usage statement
+
 **--name**=""
 **--name**=""
   Specify volume name
   Specify volume name
-**-o**, **--opt**=map[]
+
+**-o**, **--opt**=[]
   Set driver specific options
   Set driver specific options
 
 
 # HISTORY
 # HISTORY

+ 7 - 4
man/docker-volume-inspect.1.md

@@ -6,9 +6,9 @@ docker-volume-inspect - Get low-level information about a volume
 
 
 # SYNOPSIS
 # SYNOPSIS
 **docker volume inspect**
 **docker volume inspect**
-[**-f**|**--format**[=**]]
-
-[OPTIONS] VOLUME [VOLUME...]
+[**-f**|**--format**[=*FORMAT*]]
+[**--help**]
+VOLUME [VOLUME...]
 
 
 # DESCRIPTION
 # DESCRIPTION
 
 
@@ -20,7 +20,10 @@ format.
 
 
 # OPTIONS
 # OPTIONS
 **-f**, **--format**=""
 **-f**, **--format**=""
-   Format the output using the given go template.
+  Format the output using the given go template.
+
+**--help**
+  Print usage statement
 
 
 # HISTORY
 # HISTORY
 July 2015, created by Brian Goff <cpuguy83@gmail.com>
 July 2015, created by Brian Goff <cpuguy83@gmail.com>

+ 8 - 5
man/docker-volume-ls.1.md

@@ -6,10 +6,9 @@ docker-volume-ls - List all volumes
 
 
 # SYNOPSIS
 # SYNOPSIS
 **docker volume ls**
 **docker volume ls**
-[**-f**|**--filter**[=**]]
-[**-q**|**--quiet**[=**]]
-
-[OPTIONS]
+[**-f**|**--filter**[=*FILTER*]]
+[**--help**]
+[**-q**|**--quiet**[=*true*|*false*]]
 
 
 # DESCRIPTION
 # DESCRIPTION
 
 
@@ -19,7 +18,11 @@ There is a single supported filter `dangling=value` which takes a boolean of `tr
 
 
 # OPTIONS
 # OPTIONS
 **-f**, **--filter**=""
 **-f**, **--filter**=""
-   Provide filter values (i.e. 'dangling=true')
+  Provide filter values (i.e. 'dangling=true')
+
+**--help**
+  Print usage statement
+
 **-q**, **--quiet**=false
 **-q**, **--quiet**=false
   Only display volume names
   Only display volume names
 
 

+ 8 - 6
man/docker-volume-rm.1.md

@@ -6,19 +6,21 @@ docker-volume-rm - Remove a volume
 
 
 # SYNOPSIS
 # SYNOPSIS
 **docker volume rm**
 **docker volume rm**
-
-[OPTIONS] VOLUME [VOLUME...]
+[**--help**]
+VOLUME [VOLUME...]
 
 
 # DESCRIPTION
 # DESCRIPTION
 
 
 Removes one or more volumes. You cannot remove a volume that is in use by a container.
 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
 # OPTIONS
+**--help**
+  Print usage statement
 
 
 # HISTORY
 # HISTORY
 July 2015, created by Brian Goff <cpuguy83@gmail.com>
 July 2015, created by Brian Goff <cpuguy83@gmail.com>