summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-ps.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-03-29 13:52:59 +0200
committerPaul Holzinger <paul.holzinger@web.de>2021-03-29 14:38:25 +0200
commitbc48211924bd8f88263149f8b5d047a52f8d1733 (patch)
tree9e9d01ba112981055b9d5351af35c38b3b3bc20e /docs/source/markdown/podman-ps.1.md
parent7e4b13b94699ee688c146afab727d2dec991376a (diff)
downloadpodman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.gz
podman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.bz2
podman-bc48211924bd8f88263149f8b5d047a52f8d1733.zip
Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash. I tested that this change is safe and still renders correctly on github and with the man pages. This commit also contains a small change to make it build locally. Assuming you have the dependencies installed you can do: ``` cd docs make html ``` Preview the html files in docs/build/html with `python -m http.server 8000 --directory build/html`. Fixes containers/podman.io#373 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.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md
index 75eede527..b950fede4 100644
--- a/docs/source/markdown/podman-ps.1.md
+++ b/docs/source/markdown/podman-ps.1.md
@@ -13,7 +13,7 @@ podman\-ps - Prints out information about containers
**podman container ls** [*options*]
## DESCRIPTION
-**podman ps** lists the running containers on the system. Use the **--all** flag to view
+**podman ps** lists the running containers on the system. Use the **\-\-all** flag to view
all the containers information. By default it lists:
* container id
@@ -26,17 +26,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.
@@ -61,7 +61,7 @@ Valid filters are listed below:
| network | [Network] name or full ID of network |
-#### **--format**=*format*
+#### **\-\-format**=*format*
Pretty-print containers to JSON or using a Go template
@@ -84,52 +84,52 @@ 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) (This option is not available with the remote Podman 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.