From 94087bade2a46de5d1ad8cc216325d3f139f82b2 Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Fri, 25 Oct 2019 16:43:38 -0400 Subject: Cleanup man pages The format of the --network flags in man pages was all screwed up. This patch cleans this up. Signed-off-by: Daniel J Walsh --- docs/podman-create.1.md | 18 +++++++++++------- docs/podman-run.1.md | 4 ++++ 2 files changed, 15 insertions(+), 7 deletions(-) (limited to 'docs') 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:'. - 'bridge': create a network stack on the default bridge - 'none': no networking - 'container:': 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. - '|': connect to a user-defined network, multiple networks should be comma separated - 'ns:': 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:`: 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. +- `|`: connect to a user-defined network, multiple networks should be comma separated +- `ns:`: 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:'. + +Valid values are: + - `bridge`: create a network stack on the default bridge - `none`: no networking - `container:`: 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 -- cgit v1.2.3-54-g00ecf