diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | docs/source/Commands.rst | 2 | ||||
| -rw-r--r-- | docs/source/conf.py | 7 | ||||
| -rw-r--r-- | docs/source/markdown/podman-create.1.md | 4 | ||||
| -rw-r--r-- | docs/source/markdown/podman-run.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-volume-ls.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman.1.md | 4 |
7 files changed, 16 insertions, 7 deletions
diff --git a/docs/requirements.txt b/docs/requirements.txt index 44af373ac..84e7ec6a5 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,3 +2,5 @@ # use md instead of rst recommonmark +# needed for markdown table support +sphinx-markdown-tables diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst index 881dcb4b6..cd5d894da 100644 --- a/docs/source/Commands.rst +++ b/docs/source/Commands.rst @@ -3,7 +3,7 @@ Commands ======== -:doc:`Podman <markdown/podman.1>` (Pod Manager) Global Options +:doc:`Podman <markdown/podman.1>` (Pod Manager) Global Options, Environment Variables, Exit Codes, Configuration Files, and more :doc:`attach <markdown/podman-attach.1>` Attach to a running container diff --git a/docs/source/conf.py b/docs/source/conf.py index aad458a9b..368d7cc29 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -28,9 +28,14 @@ author = "team" # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - "recommonmark", + 'sphinx_markdown_tables', ] +source_parsers = { + '.md': 'recommonmark.parser.CommonMarkParser', +} + + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md index a6083201d..9f2aa1d7b 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -574,9 +574,9 @@ to the container with **--name** then it will generate a random string name. The name is useful any place you need to identify a container. This works for both background and foreground containers. -#### **--network**=*bridge*, **--net** +#### **--network**=*mode*, **--net** -Set the network mode for the container. Invalid if using **--dns**, **--dns-opt**, or **--dns-search** with **--network** that is set to **none** or **container:**_id_. +Set the network mode for the container. Invalid if using **--dns**, **--dns-opt**, or **--dns-search** with **--network** that is set to **none** or **container:**_id_. If used together with **--pod**, the container will not join the pods network namespace. Valid _mode_ values are: diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index db9c98073..8c7d713ac 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -602,7 +602,7 @@ This works for both background and foreground containers. #### **--network**=*mode*, **--net** -Set the network mode for the container. Invalid if using **--dns**, **--dns-opt**, or **--dns-search** with **--network** that is set to **none** or **container:**_id_. +Set the network mode for the container. Invalid if using **--dns**, **--dns-opt**, or **--dns-search** with **--network** that is set to **none** or **container:**_id_. If used together with **--pod**, the container will not join the pods network namespace. Valid _mode_ values are: diff --git a/docs/source/markdown/podman-volume-ls.1.md b/docs/source/markdown/podman-volume-ls.1.md index 98c3fae54..48853bdfd 100644 --- a/docs/source/markdown/podman-volume-ls.1.md +++ b/docs/source/markdown/podman-volume-ls.1.md @@ -40,6 +40,8 @@ $ podman volume ls --format json $ podman volume ls --format "{{.Driver}} {{.Scope}}" $ podman volume ls --filter name=foo,label=blue + +$ podman volume ls --filter label=key=value ``` ## SEE ALSO diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 87867bf35..1954ca2aa 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -168,7 +168,7 @@ podman --remote flag, only the global options `--url`, `--identity`, `--log-leve Connection information can also be managed using the containers.conf file. -## Exit Status +## Exit Codes The exit code from `podman` gives information about why the container failed to run or why it exited. When `podman` commands exit with a non-zero code, @@ -257,7 +257,7 @@ the exit codes follow the `chroot` standard, see below: | [podman-volume(1)](podman-volume.1.md) | Simple management tool for volumes. | | [podman-wait(1)](podman-wait.1.md) | Wait on one or more containers to stop and print their exit codes. | -## FILES +## CONFIGURATION FILES **containers.conf** (`/usr/share/containers/containers.conf`, `/etc/containers/containers.conf`, `$HOME/.config/containers/containers.conf`) |