1. docker
  2. Commit dc8259f0ac094e28c8aae93435951fc336cd1d7b
Browse code

Add a parent man page for docker volumes command

It is difficult to gather information about docker volumes command
without a parent man page.

This man page attempts to explain docker volumes and then references
the command man pages.

Signed-off-by: Dan Walsh <dwalsh@redhat.com>

Dan Walsh authored on 2016/02/10 23:03:20
Showing 1 changed files
man/docker-volume.1.md
History View file @ dc8259f
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,62 @@
0 
+% DOCKER(1) Docker User Manuals
1 
+% Docker Community
2 
+% Feb 2016
3 
+# NAME
4 
+docker-volume - Create a new volume
5 
+
6 
+# SYNOPSIS
7 
+**docker volume** [OPTIONS] COMMAND
8 
+[**--help**]
9 
+
10 
+# DESCRIPTION
11 
+
12 
+docker volume command manages content volumes for docker containers.
13 
+
14 
+## Data volumes
15 
+
16 
+A *data volume* is a specially-designated directory within one or more
17 
+containers.
18 
+
19 
+Data volumes provide several useful features for persistent or shared data:
20 
+
21 
+Volumes are initialized when a container is created. If the container's
22 
+base image contains data at the specified mount point, that existing data is
23 
+copied into the new volume upon volume initialization. (Note that this does
24 
+not apply when [mounting a host directory](#mount-a-host-directory-as-a-data-volume).)
25 
+
26 
+Data volumes can be shared and reused among containers.
27 
+
28 
+Changes to a data volume are made directly.
29 
+
30 
+Changes to a data volume will not be included when you update an image.
31 
+
32 
+Data volumes persist even if the container itself is deleted.
33 
+
34 
+Data volumes are designed to persist data, independent of the container's life
35 
+cycle. Docker therefore *never* automatically deletes volumes when you remove
36 
+a container, nor will it "garbage collect" volumes that are no longer
37 
+referenced by a container.
38 
+
39 
+# OPTIONS
40 
+**--help**
41 
+  Print usage statement
42 
+
43 
+# COMMANDS
44 
+**create**
45 
+  Create a volume
46 
+  See **docker-volume-create(1)** for full documentation on the **create** command.
47 
+
48 
+**inspect**
49 
+  Return low-level information on a volume
50 
+  See **docker-volume-inspect(1)** for full documentation on the **inspect** command.
51 
+
52 
+**ls**
53 
+  List volumes
54 
+  See **docker-volume-ls(1)** for full documentation on the **ls** command.
55 
+
56 
+**rm**
57 
+  Remove a volume
58 
+  See **docker-volume-rm(1)** for full documentation on the **rm** command.
59 
+
60 
+# HISTORY
61 
+Feb 2016, created by Dan Walsh <dwalsh@redhat.com>