aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-volume-create.1.md
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2019-10-29 17:27:12 -0700
committerMatthew Heon <mheon@redhat.com>2019-10-31 16:34:29 -0400
commit28ad43940f3bfca3870a5450342c4b79c6a2f60f (patch)
treee09c845896ba74942de8ec13e4404df393f374a5 /docs/source/markdown/podman-volume-create.1.md
parent27e79f55407b9e46cee06c97ba53bc3a485f5c03 (diff)
downloadpodman-28ad43940f3bfca3870a5450342c4b79c6a2f60f.tar.gz
podman-28ad43940f3bfca3870a5450342c4b79c6a2f60f.tar.bz2
podman-28ad43940f3bfca3870a5450342c4b79c6a2f60f.zip
Update document formatting and packaging code
* Refactored code and Makefile to support new docs layout * Removed some old code packaging code * Add Readme.md to document what we're doing Signed-off-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-volume-create.1.md')
-rw-r--r--docs/source/markdown/podman-volume-create.1.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-volume-create.1.md b/docs/source/markdown/podman-volume-create.1.md
new file mode 100644
index 000000000..b354f396f
--- /dev/null
+++ b/docs/source/markdown/podman-volume-create.1.md
@@ -0,0 +1,59 @@
+% podman-volume-create(1)
+
+## NAME
+podman\-volume\-create - Create a new volume
+
+## SYNOPSIS
+**podman volume create** [*options*]
+
+## DESCRIPTION
+
+Creates an empty volume and prepares it to be used by containers. The volume
+can be created with a specific name, if a name is not given a random name is
+generated. You can add metadata to the volume by using the **--label** flag and
+driver options can be set using the **--opt** flag.
+
+## OPTIONS
+
+**--driver**=*driver*
+
+Specify the volume driver name (default local).
+
+**--help**
+
+Print usage statement
+
+**-l**, **-label**=*label*
+
+Set metadata for a volume (e.g., --label mykey=value).
+
+**-o**, **--opt**=*option*
+
+Set driver specific options.
+For the default driver, `local`, this allows a volume to be configured to mount a filesystem on the host.
+For the `local` driver the following options are supported: `type`, `device`, and `o`.
+The `type` option sets the type of the filesystem to be mounted, and is equivalent to the `-t` flag to **mount(8)**.
+The `device` option sets the device to be mounted, and is equivalent to the `device` argument to **mount(8)**.
+The `o` option sets options for the mount, and is equivalent to the `-o` flag to **mount(8)** with two exceptions.
+The `o` option supports `uid` and `gid` options to set the UID and GID of the created volume that are not normally supported by **mount(8)**.
+Using volume options with the `local` driver requires root privileges.
+
+## EXAMPLES
+
+```
+$ podman volume create myvol
+
+$ podman volume create
+
+$ podman volume create --label foo=bar myvol
+
+# podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=nodev,noexec myvol
+
+# podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=uid=1000,gid=1000 testvol
+```
+
+## SEE ALSO
+podman-volume(1), mount(8)
+
+## HISTORY
+November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>