aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-ps.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2020-11-10 14:59:34 +0100
committerPaul Holzinger <paul.holzinger@web.de>2020-11-10 15:27:08 +0100
commit52a869470530f3c6bf7820a2b63fa9e17f227a16 (patch)
tree84d2940f763b124c75dd124aecbf76ff3707f140 /docs/source/markdown/podman-ps.1.md
parentda01191aa3526e3a77d9a055e23c318c26720785 (diff)
downloadpodman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.gz
podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.bz2
podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.zip
Add anchors for flag names on docs.podman.io
Change the docs markdown so that flag names will be h4 headers. Sphinx will automatically add anchors to headers. Add css to make sure the flag names are not to big compared to the text. The man pages also still renders fine but it looks a bit different. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-ps.1.md')
-rw-r--r--docs/source/markdown/podman-ps.1.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md
index 90f147222..5869f2307 100644
--- a/docs/source/markdown/podman-ps.1.md
+++ b/docs/source/markdown/podman-ps.1.md
@@ -30,17 +30,17 @@ all the containers information. By default it lists:
## OPTIONS
-**--all**, **-a**
+#### **--all**, **-a**
Show all the containers created by Podman, default is only running containers.
Note: Podman shares containers storage with other tools such as Buildah and CRI-O. In some cases these `external` containers might also exist in the same storage. Use the `--external` option to see these external containers. External containers show the 'storage' status.
-**--external**
+#### **--external**
Display external containers that are not controlled by Podman but are stored in containers storage. These external containers are generally created via other container technology such as Buildah or CRI-O and may depend on the same container images that Podman is also using. External containers are denoted with either a 'buildah' or 'storage' in the COMMAND and STATUS column of the ps output. Only used with the --all option.
-**--filter**, **-f**
+#### **--filter**, **-f**
Filter what containers are shown in the output.
Multiple filters can be given with multiple uses of the --filter flag.
@@ -62,7 +62,7 @@ Valid filters are listed below:
| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
| health | [Status] healthy or unhealthy |
-**--format**=*format*
+#### **--format**=*format*
Pretty-print containers to JSON or using a Go template
@@ -84,54 +84,54 @@ Valid placeholders for the Go template are listed below:
| .Labels | All the labels assigned to the container |
| .Mounts | Volumes mounted in the container |
-**--help**, **-h**
+#### **--help**, **-h**
Print usage statement
-**--last**, **-n**
+#### **--last**, **-n**
Print the n last created containers (all states)
-**--latest**, **-l**
+#### **--latest**, **-l**
Show the latest container created (all states)
The latest option is not supported on the remote client.
-**--namespace**, **--ns**
+#### **--namespace**, **--ns**
Display namespace information
-**--no-trunc**
+#### **--no-trunc**
Display the extended information
-**--pod**, **-p**
+#### **--pod**, **-p**
Display the pods the containers are associated with
-**--quiet**, **-q**
+#### **--quiet**, **-q**
Print the numeric IDs of the containers only
-**--sort**
+#### **--sort**
Sort by command, created, id, image, names, runningfor, size, or status",
Note: Choosing size will sort by size of rootFs, not alphabetically like the rest of the options
Default: created
-**--size**, **-s**
+#### **--size**, **-s**
Display the total file size
-**--sync**
+#### **--sync**
Force a sync of container state with the OCI runtime.
In some cases, a container's state in the runtime can become out of sync with Podman's state.
This will update Podman's state based on what the OCI runtime reports.
Forcibly syncing is much slower, but can resolve inconsistent state issues.
-**--watch**, **-w**
+#### **--watch**, **-w**
Refresh the output with current containers on an interval in seconds.