summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQi Wang <qiwan@redhat.com>2018-10-18 08:54:51 -0400
committerQi Wang <qiwan@redhat.com>2018-10-23 15:14:44 -0400
commitc285bd664e2a61562ff31778029f4cab7d931a5b (patch)
tree08286e99d5dcf7eba711f75345e611685cbd0e9b /docs
parent10bab99ea01006c4ca0048e6177d753f0732add7 (diff)
downloadpodman-c285bd664e2a61562ff31778029f4cab7d931a5b.tar.gz
podman-c285bd664e2a61562ff31778029f4cab7d931a5b.tar.bz2
podman-c285bd664e2a61562ff31778029f4cab7d931a5b.zip
Explain the device format in man pages
Signed-off-by: Qi Wang <qiwan@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-create.1.md2
-rw-r--r--docs/podman-run.1.md2
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index 509d8820f..5a4d7fb5a 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -178,7 +178,7 @@ Override the key sequence for detaching a container. Format is a single characte
**--device**=[]
-Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
+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)
**--device-read-bps**=[]
diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md
index c303492e7..b708e3407 100644
--- a/docs/podman-run.1.md
+++ b/docs/podman-run.1.md
@@ -182,7 +182,7 @@ Override the key sequence for detaching a container. Format is a single characte
**--device**=[]
-Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
+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)
**--device-read-bps**=[]