mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
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 <github@albersweb.de>
This commit is contained in:
parent
58ae808d42
commit
2724010364
5 changed files with 36 additions and 23 deletions
|
@ -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
|
||||||
|
|
|
@ -6,11 +6,10 @@ docker-volume-create - Create a new volume
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker volume create**
|
**docker volume create**
|
||||||
[**-d**|**--driver**[=*local*]]
|
[**-d**|**--driver**[=*DRIVER*]]
|
||||||
[**--name**[=**]]
|
[**--help**]
|
||||||
[**-o**|**--opt**[=**]]
|
[**--name**[=*NAME*]]
|
||||||
|
[**-o**|**--opt**[=*[]*]]
|
||||||
[OPTIONS]
|
|
||||||
|
|
||||||
# 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**=[]
|
**-d**, **--driver**="local"
|
||||||
Specify volume driver name
|
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
|
||||||
|
|
|
@ -6,9 +6,9 @@ docker-volume-inspect - Get low-level information about a volume
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker volume inspect**
|
**docker volume inspect**
|
||||||
[**-f**|**--format**[=**]]
|
[**-f**|**--format**[=*FORMAT*]]
|
||||||
|
[**--help**]
|
||||||
[OPTIONS] VOLUME [VOLUME...]
|
VOLUME [VOLUME...]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
|
@ -22,5 +22,8 @@ format.
|
||||||
**-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>
|
||||||
|
|
|
@ -6,10 +6,9 @@ docker-volume-ls - List all volumes
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker volume ls**
|
**docker volume ls**
|
||||||
[**-f**|**--filter**[=**]]
|
[**-f**|**--filter**[=*FILTER*]]
|
||||||
[**-q**|**--quiet**[=**]]
|
[**--help**]
|
||||||
|
[**-q**|**--quiet**[=*true*|*false*]]
|
||||||
[OPTIONS]
|
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
|
@ -20,6 +19,10 @@ 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
|
||||||
|
|
||||||
|
|
|
@ -6,8 +6,8 @@ docker-volume-rm - Remove a volume
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker volume rm**
|
**docker volume rm**
|
||||||
|
[**--help**]
|
||||||
[OPTIONS] VOLUME [VOLUME...]
|
VOLUME [VOLUME...]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
|
@ -19,6 +19,8 @@ Removes one or more volumes. You cannot remove a volume that is in use by a cont
|
||||||
```
|
```
|
||||||
|
|
||||||
# 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>
|
||||||
|
|
Loading…
Reference in a new issue