mirror of https://github.com/docker/cli.git
Set Long text for volume commands so they can be used to generate man pages.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
This commit is contained in:
Daniel Nephin
Tibor Vass
parent
106418dbd9
commit
e08631bb28
|
|
@ -1,65 +0,0 @@
|
||||||
% DOCKER(1) Docker User Manuals
|
|
||||||
% Docker Community
|
|
||||||
% JULY 2015
|
|
||||||
# NAME
|
|
||||||
docker-volume-create - Create a new volume
|
|
||||||
|
|
||||||
# SYNOPSIS
|
|
||||||
**docker volume create**
|
|
||||||
[**-d**|**--driver**[=*DRIVER*]]
|
|
||||||
[**--help**]
|
|
||||||
[**--label**[=*[]*]]
|
|
||||||
[**--name**[=*NAME*]]
|
|
||||||
[**-o**|**--opt**[=*[]*]]
|
|
||||||
|
|
||||||
# DESCRIPTION
|
|
||||||
|
|
||||||
Creates a new volume that containers can consume and store data in. If a name is not specified, Docker generates a random name. You create a volume and then configure the container to use it, for example:
|
|
||||||
|
|
||||||
$ docker volume create --name hello
|
|
||||||
hello
|
|
||||||
$ docker run -d -v hello:/world busybox ls /world
|
|
||||||
|
|
||||||
The mount is created inside the container's `/src` directory. Docker doesn't not support relative paths for mount points inside the container.
|
|
||||||
|
|
||||||
Multiple containers can use the same volume in the same time period. This is useful if two containers need access to shared data. For example, if one container writes and the other reads the data.
|
|
||||||
|
|
||||||
## Driver specific options
|
|
||||||
|
|
||||||
Some volume drivers may take options to customize the volume creation. Use the `-o` or `--opt` flags to pass driver options:
|
|
||||||
|
|
||||||
$ docker volume create --driver fake --opt tardis=blue --opt timey=wimey
|
|
||||||
|
|
||||||
These options are passed directly to the volume driver. Options for
|
|
||||||
different volume drivers may do different things (or nothing at all).
|
|
||||||
|
|
||||||
The built-in `local` driver on Windows does not support any options.
|
|
||||||
|
|
||||||
The built-in `local` driver on Linux accepts options similar to the linux `mount`
|
|
||||||
command:
|
|
||||||
|
|
||||||
$ docker volume create --driver local --opt type=tmpfs --opt device=tmpfs --opt o=size=100m,uid=1000
|
|
||||||
|
|
||||||
Another example:
|
|
||||||
|
|
||||||
$ docker volume create --driver local --opt type=btrfs --opt device=/dev/sda2
|
|
||||||
|
|
||||||
|
|
||||||
# OPTIONS
|
|
||||||
**-d**, **--driver**="*local*"
|
|
||||||
Specify volume driver name
|
|
||||||
|
|
||||||
**--help**
|
|
||||||
Print usage statement
|
|
||||||
|
|
||||||
**--label**=*label*
|
|
||||||
Set metadata for a volume
|
|
||||||
|
|
||||||
**--name**=""
|
|
||||||
Specify volume name
|
|
||||||
|
|
||||||
**-o**, **--opt**=[]
|
|
||||||
Set driver specific options
|
|
||||||
|
|
||||||
# HISTORY
|
|
||||||
July 2015, created by Brian Goff <cpuguy83@gmail.com>
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
% DOCKER(1) Docker User Manuals
|
|
||||||
% Docker Community
|
|
||||||
% JULY 2015
|
|
||||||
# NAME
|
|
||||||
docker-volume-inspect - Get low-level information about a volume
|
|
||||||
|
|
||||||
# SYNOPSIS
|
|
||||||
**docker volume inspect**
|
|
||||||
[**-f**|**--format**[=*FORMAT*]]
|
|
||||||
[**--help**]
|
|
||||||
VOLUME [VOLUME...]
|
|
||||||
|
|
||||||
# DESCRIPTION
|
|
||||||
|
|
||||||
Returns information about one or more volumes. By default, this command renders all results
|
|
||||||
in a JSON array. You can specify an alternate format to execute a given template
|
|
||||||
is executed for each result. Go's
|
|
||||||
http://golang.org/pkg/text/template/ package describes all the details of the
|
|
||||||
format.
|
|
||||||
|
|
||||||
# OPTIONS
|
|
||||||
**-f**, **--format**=""
|
|
||||||
Format the output using the given go template.
|
|
||||||
|
|
||||||
**--help**
|
|
||||||
Print usage statement
|
|
||||||
|
|
||||||
# HISTORY
|
|
||||||
July 2015, created by Brian Goff <cpuguy83@gmail.com>
|
|
||||||
|
|
@ -1,33 +0,0 @@
|
||||||
% DOCKER(1) Docker User Manuals
|
|
||||||
% Docker Community
|
|
||||||
% JULY 2015
|
|
||||||
# NAME
|
|
||||||
docker-volume-ls - List all volumes
|
|
||||||
|
|
||||||
# SYNOPSIS
|
|
||||||
**docker volume ls**
|
|
||||||
[**-f**|**--filter**[=*FILTER*]]
|
|
||||||
[**--help**]
|
|
||||||
[**-q**|**--quiet**[=*true*|*false*]]
|
|
||||||
|
|
||||||
# DESCRIPTION
|
|
||||||
|
|
||||||
Lists all the volumes Docker knows about. You can filter using the `-f` or `--filter` flag. The filtering format is a `key=value` pair. To specify more than one filter, pass multiple flags (for example, `--filter "foo=bar" --filter "bif=baz"`)
|
|
||||||
|
|
||||||
There is a single supported filter `dangling=value` which takes a boolean of `true` or `false`.
|
|
||||||
|
|
||||||
# OPTIONS
|
|
||||||
**-f**, **--filter**=""
|
|
||||||
Filter output based on these conditions:
|
|
||||||
- dangling=<boolean> a volume if referenced or not
|
|
||||||
- driver=<string> a volume's driver name
|
|
||||||
- name=<string> a volume's name
|
|
||||||
|
|
||||||
**--help**
|
|
||||||
Print usage statement
|
|
||||||
|
|
||||||
**-q**, **--quiet**=*true*|*false*
|
|
||||||
Only display volume names
|
|
||||||
|
|
||||||
# HISTORY
|
|
||||||
July 2015, created by Brian Goff <cpuguy83@gmail.com>
|
|
||||||
|
|
@ -1,26 +0,0 @@
|
||||||
% DOCKER(1) Docker User Manuals
|
|
||||||
% Docker Community
|
|
||||||
% JULY 2015
|
|
||||||
# NAME
|
|
||||||
docker-volume-rm - Remove a volume
|
|
||||||
|
|
||||||
# SYNOPSIS
|
|
||||||
**docker volume rm**
|
|
||||||
[**--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
|
|
||||||
```
|
|
||||||
|
|
||||||
# OPTIONS
|
|
||||||
**--help**
|
|
||||||
Print usage statement
|
|
||||||
|
|
||||||
# HISTORY
|
|
||||||
July 2015, created by Brian Goff <cpuguy83@gmail.com>
|
|
||||||
|
|
@ -1,62 +0,0 @@
|
||||||
% DOCKER(1) Docker User Manuals
|
|
||||||
% Docker Community
|
|
||||||
% Feb 2016
|
|
||||||
# NAME
|
|
||||||
docker-volume - Create a new volume
|
|
||||||
|
|
||||||
# SYNOPSIS
|
|
||||||
**docker volume** [OPTIONS] COMMAND
|
|
||||||
[**--help**]
|
|
||||||
|
|
||||||
# DESCRIPTION
|
|
||||||
|
|
||||||
docker volume command manages content volumes for docker containers.
|
|
||||||
|
|
||||||
## Data volumes
|
|
||||||
|
|
||||||
A *data volume* is a specially-designated directory within one or more
|
|
||||||
containers.
|
|
||||||
|
|
||||||
Data volumes provide several useful features for persistent or shared data:
|
|
||||||
|
|
||||||
Volumes are initialized when a container is created. If the container's
|
|
||||||
base image contains data at the specified mount point, that existing data is
|
|
||||||
copied into the new volume upon volume initialization. (Note that this does
|
|
||||||
not apply when [mounting a host directory](#mount-a-host-directory-as-a-data-volume).)
|
|
||||||
|
|
||||||
Data volumes can be shared and reused among containers.
|
|
||||||
|
|
||||||
Changes to a data volume are made directly.
|
|
||||||
|
|
||||||
Changes to a data volume will not be included when you update an image.
|
|
||||||
|
|
||||||
Data volumes persist even if the container itself is deleted.
|
|
||||||
|
|
||||||
Data volumes are designed to persist data, independent of the container's life
|
|
||||||
cycle. Docker therefore *never* automatically deletes volumes when you remove
|
|
||||||
a container, nor will it "garbage collect" volumes that are no longer
|
|
||||||
referenced by a container.
|
|
||||||
|
|
||||||
# OPTIONS
|
|
||||||
**--help**
|
|
||||||
Print usage statement
|
|
||||||
|
|
||||||
# COMMANDS
|
|
||||||
**create**
|
|
||||||
Create a volume
|
|
||||||
See **docker-volume-create(1)** for full documentation on the **create** command.
|
|
||||||
|
|
||||||
**inspect**
|
|
||||||
Display detailed information on one or more volumes
|
|
||||||
See **docker-volume-inspect(1)** for full documentation on the **inspect** command.
|
|
||||||
|
|
||||||
**ls**
|
|
||||||
List volumes
|
|
||||||
See **docker-volume-ls(1)** for full documentation on the **ls** command.
|
|
||||||
|
|
||||||
**rm**
|
|
||||||
Remove a volume
|
|
||||||
See **docker-volume-rm(1)** for full documentation on the **rm** command.
|
|
||||||
|
|
||||||
# HISTORY
|
|
||||||
Feb 2016, created by Dan Walsh <dwalsh@redhat.com>
|
|
||||||
Loading…
Reference in New Issue