summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@pm.me>2019-10-23 15:35:57 -0400
committerMatthew Heon <matthew.heon@pm.me>2019-10-23 15:35:57 -0400
commitdaadfe97448f041ee4cda0acbf3369ab9f0d5cd7 (patch)
treea76803e137acb51b3a9116a0afd8ac454c39981c /docs
parent2e6c9aa4901b30653d814f4984663cf07fc5e57f (diff)
downloadpodman-daadfe97448f041ee4cda0acbf3369ab9f0d5cd7.tar.gz
podman-daadfe97448f041ee4cda0acbf3369ab9f0d5cd7.tar.bz2
podman-daadfe97448f041ee4cda0acbf3369ab9f0d5cd7.zip
Add documentation on options to volume create manpage
Document the rough equivalence between our option types and the various parts of the mount command. Amend examples a bit to cover this. Signed-off-by: Matthew Heon <matthew.heon@pm.me>
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-volume-create.1.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/podman-volume-create.1.md b/docs/podman-volume-create.1.md
index 6612b0ad2..b354f396f 100644
--- a/docs/podman-volume-create.1.md
+++ b/docs/podman-volume-create.1.md
@@ -30,6 +30,13 @@ 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
@@ -40,11 +47,13 @@ $ 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=nodev,noexec myvol
+
+# podman volume create --opt device=tmpfs --opt type=tmpfs --opt o=uid=1000,gid=1000 testvol
```
## SEE ALSO
-podman-volume(1)
+podman-volume(1), mount(8)
## HISTORY
November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>