summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-10-27 16:02:15 +0100
committerGitHub <noreply@github.com>2019-10-27 16:02:15 +0100
commitac73fd3fe5dcbf2647d589f9c9f37fe9531ed663 (patch)
treec5edd02d8e6fa1e6d020c69e39e7773de7ce1ab8
parentea46937675bbb5839a4f2fdf894d480b57744aeb (diff)
parent94087bade2a46de5d1ad8cc216325d3f139f82b2 (diff)
downloadpodman-ac73fd3fe5dcbf2647d589f9c9f37fe9531ed663.tar.gz
podman-ac73fd3fe5dcbf2647d589f9c9f37fe9531ed663.tar.bz2
podman-ac73fd3fe5dcbf2647d589f9c9f37fe9531ed663.zip
Merge pull request #4348 from rhatdan/man
Cleanup man pages
-rw-r--r--docs/podman-create.1.md18
-rw-r--r--docs/podman-run.1.md4
2 files changed, 15 insertions, 7 deletions
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index 8b2218227..6617850fd 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -515,13 +515,16 @@ This works for both background and foreground containers.
**--network**, **--net**="*bridge*"
Set the Network mode for the container. Invalid if using **--dns**, **--dns-option**, or **--dns-search** with **--network** that is set to 'none' or 'container:<name|id>'.
- 'bridge': create a network stack on the default bridge
- 'none': no networking
- 'container:<name|id>': reuse another container's network stack
- 'host': use the Podman host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
- '<network-name>|<network-id>': connect to a user-defined network, multiple networks should be comma separated
- 'ns:<path>': path to a network namespace to join
- 'slirp4netns': use slirp4netns to create a user network stack. This is the default for rootless containers
+
+Valid values are:
+
+- `bridge`: create a network stack on the default bridge
+- `none`: no networking
+- `container:<name|id>`: reuse another container's network stack
+- `host`: use the Podman host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
+- `<network-name>|<network-id>`: connect to a user-defined network, multiple networks should be comma separated
+- `ns:<path>`: path to a network namespace to join
+- `slirp4netns`: use slirp4netns to create a user network stack. This is the default for rootless containers
**--network-alias**=*alias*
@@ -626,6 +629,7 @@ If container is running in --read-only mode, then mount a read-write tmpfs on /r
Restart policy to follow when containers exit.
Restart policy will not take effect if a container is stopped via the `podman kill` or `podman stop` commands.
+
Valid values are:
- `no` : Do not restart containers on exit
diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md
index d2e9ffeac..d6d8f4c1e 100644
--- a/docs/podman-run.1.md
+++ b/docs/podman-run.1.md
@@ -526,6 +526,9 @@ This works for both background and foreground containers.
**--network**, **--net**=*node*
Set the Network mode for the container. Invalid if using **--dns**, **--dns-option**, or **--dns-search** with **--network** that is set to 'none' or 'container:<name|id>'.
+
+Valid values are:
+
- `bridge`: create a network stack on the default bridge
- `none`: no networking
- `container:<name|id>`: reuse another container's network stack
@@ -645,6 +648,7 @@ If container is running in --read-only mode, then mount a read-write tmpfs on /r
Restart policy to follow when containers exit.
Restart policy will not take effect if a container is stopped via the `podman kill` or `podman stop` commands.
+
Valid values are:
- `no` : Do not restart containers on exit