summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-create.1.md
diff options
context:
space:
mode:
authorStefan Becker <chemobejk@gmail.com>2020-02-23 14:38:34 +0200
committerStefan Becker <chemobejk@gmail.com>2020-02-23 14:38:34 +0200
commit111af1ba4a0069e930c9f88ffa63b855e7383c1d (patch)
tree363cb13c189f54f6921a21c1a70b0a76ad005faf /docs/source/markdown/podman-create.1.md
parent3e7be5cf2788a27dfcb8b6d4dd867efcc4cac22a (diff)
downloadpodman-111af1ba4a0069e930c9f88ffa63b855e7383c1d.tar.gz
podman-111af1ba4a0069e930c9f88ffa63b855e7383c1d.tar.bz2
podman-111af1ba4a0069e930c9f88ffa63b855e7383c1d.zip
docs: symlink to host device is resolved
Also apply changes from commit 3fd9f0c028f9dab7c8923629d4dc5d38e594db1a to the other two commands that have the --device option. Documents #4550 Signed-off-by: Stefan Becker <chemobejk@gmail.com>
Diffstat (limited to 'docs/source/markdown/podman-create.1.md')
-rw-r--r--docs/source/markdown/podman-create.1.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md
index ca38be6a1..64e331b42 100644
--- a/docs/source/markdown/podman-create.1.md
+++ b/docs/source/markdown/podman-create.1.md
@@ -201,13 +201,20 @@ it in the **libpod.conf** file: see **libpod.conf(5)** for more information.
Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*.
-**--device**=*device*
+**--device**=_host-device_[**:**_container-device_][**:**_permissions_]
-Add a host device to the container. The format is `<device-on-host>[:<device-on-container>][:<permissions>]` (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
+Add a host device to the container. Optional *permissions* parameter
+can be used to specify device permissions, it is combination of
+**r** for read, **w** for write, and **m** for **mknod**(2).
-Note: if the user only has access rights via a group then accessing the device
-from inside a rootless container will fail. The `crun` runtime offers a
-workaround for this by adding the option `--annotation run.oci.keep_original_groups=1`.
+Example: **--device=/dev/sdc:/dev/xvdc:rwm**.
+
+Note: if _host_device_ is a symbolic link then it will be resolved first.
+The container will only store the major and minor numbers of the host device.
+
+Note: if the user only has access rights via a group, accessing the device
+from inside a rootless container will fail. The **crun**(1) runtime offers a
+workaround for this by adding the option **--annotation run.oci.keep_original_groups=1**.
**--device-cgroup-rule**="type major:minor mode"