aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/options/device.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-09-06 06:39:09 -0600
committerEd Santiago <santiago@redhat.com>2022-09-06 08:20:32 -0600
commit40cd1c0ff5d4c1e99e51cf60046c957a1a6ba81e (patch)
tree626b8f9fdc93e148327a529418952a1c3765cd33 /docs/source/markdown/options/device.md
parentcd09e3b6d0b0eb32f6ad6062b13194f97873c664 (diff)
downloadpodman-40cd1c0ff5d4c1e99e51cf60046c957a1a6ba81e.tar.gz
podman-40cd1c0ff5d4c1e99e51cf60046c957a1a6ba81e.tar.bz2
podman-40cd1c0ff5d4c1e99e51cf60046c957a1a6ba81e.zip
Man pages: refactor common options: --device
The refactors are starting to get harder to review - sorry. Here the differences are pretty small, mostly changes to the "it is a combination" wording and some asteriskization. The more significant diffs are that there are some Notes that are pod- or container- or build-specific; I needed to move those from the middle to the end, then keep them in the source files themselves. I don't think this affects readability of the resulting man pages, but your opinion may differ. Last important thing: I included the /dev/fuse text in the common option, which means it will now show up in podman-build (it was not previously there). If this text is not applicable to podman-build, please LMK ASAP so I can just move it back to individual source files. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options/device.md')
-rw-r--r--docs/source/markdown/options/device.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/source/markdown/options/device.md b/docs/source/markdown/options/device.md
new file mode 100644
index 000000000..619c70a9b
--- /dev/null
+++ b/docs/source/markdown/options/device.md
@@ -0,0 +1,14 @@
+#### **--device**=*host-device[:container-device][:permissions]*
+
+Add a host device to the <<container|pod>>. Optional *permissions* parameter
+can be used to specify device permissions by combining
+**r** for read, **w** for write, and **m** for **mknod**(2).
+
+Example: **--device=/dev/sdc:/dev/xvdc:rwm**.
+
+Note: if *host-device* is a symbolic link then it will be resolved first.
+The <<container|pod>> will only store the major and minor numbers of the host device.
+
+Podman may load kernel modules required for using the specified
+device. The devices that Podman will load modules for when necessary are:
+/dev/fuse.