aboutsummaryrefslogtreecommitdiff
path: root/docs/podman-ps.1.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2017-12-15 16:58:36 -0500
committerAtomic Bot <atomic-devel@projectatomic.io>2017-12-18 16:46:05 +0000
commit5770dc2640c216525ab84031e3712fcc46b3b087 (patch)
tree8a1c5c4e4a6ce6a35a3767247623a62bfd698f77 /docs/podman-ps.1.md
parentde3468e120d489d046c08dad72ba2262e222ccb1 (diff)
downloadpodman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.gz
podman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.bz2
podman-5770dc2640c216525ab84031e3712fcc46b3b087.zip
Rename all references to kpod to podman
The decision is in, kpod is going to be named podman. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #145 Approved by: umohnani8
Diffstat (limited to 'docs/podman-ps.1.md')
-rw-r--r--docs/podman-ps.1.md131
1 files changed, 131 insertions, 0 deletions
diff --git a/docs/podman-ps.1.md b/docs/podman-ps.1.md
new file mode 100644
index 000000000..493a11465
--- /dev/null
+++ b/docs/podman-ps.1.md
@@ -0,0 +1,131 @@
+% podman(1) podman-ps - Simple tool to list containers
+% Urvashi Mohnani
+% podman-ps "1" "AUGUST 2017" "podman"
+
+## NAME
+podman-ps - Prints out information about containers
+
+## SYNOPSIS
+**podman ps**
+[**--all**|**-a**]
+[**--no-trunc**]
+[**--quiet**|**-q**]
+[**--fromat**]
+[**--help**|**-h**]
+
+## DESCRIPTION
+**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
+ * the name of the image the container is using
+ * the COMMAND the container is executing
+ * the time the container was created
+ * the status of the container
+ * port mappings the container is using
+ * alternative names for the container
+
+**podman [GLOBAL OPTIONS]**
+
+**podman ps [GLOBAL OPTIONS]**
+
+**podman ps [OPTIONS]**
+
+## OPTIONS
+
+**--all, -a**
+ Show all the containers, default is only running containers
+
+**--no-trunc**
+ Display the extended information
+
+**--quiet, -q**
+ Print the numeric IDs of the containers only
+
+**--format**
+ Pretty-print containers to JSON or using a Go template
+
+Valid placeholders for the Go template are listed below:
+
+| **Placeholder** | **Description** |
+| --------------- | ------------------------------------------------ |
+| .ID | Container ID |
+| .Image | Image ID/Name |
+| .Command | Quoted command used |
+| .CreatedAt | Creation time for container |
+| .RunningFor | Time elapsed since container was started |
+| .Status | Status of container |
+| .Ports | Exposed ports |
+| .Size | Size of container |
+| .Names | Name of container |
+| .Labels | All the labels assigned to the container |
+| .Mounts | Volumes mounted in the container |
+
+
+**--size, -s**
+ Display the total file size
+
+**--last, -n**
+ Print the n last created containers (all states)
+
+**--latest, -l**
+ show the latest container created (all states)
+
+**--namespace, --ns**
+ Display namespace information
+
+**--filter, -f**
+ Filter output based on conditions given
+
+Valid filters are listed below:
+
+| **Filter** | **Description** |
+| --------------- | ------------------------------------------------------------------- |
+| id | [ID] Container's ID |
+| name | [Name] Container's name |
+| label | [Key] or [Key=Value] Label assigned to a container |
+| exited | [Int] Container's exit code |
+| status | [Status] Container's status, e.g *running*, *stopped* |
+| ancestor | [ImageName] Image or descendant used to create container |
+| before | [ID] or [Name] Containers created before this container |
+| since | [ID] or [Name] Containers created since this container |
+| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
+
+## EXAMPLES
+
+```
+sudo podman ps -a
+CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
+02f65160e14ca redis:alpine "redis-server" 19 hours ago Exited (-1) 19 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0
+69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1
+```
+
+```
+sudo podman ps -a -s
+CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES SIZE
+02f65160e14ca redis:alpine "redis-server" 20 hours ago Exited (-1) 20 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 27.49 MB
+69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 27.49 MB
+```
+
+```
+sudo podman ps -a --format "{{.ID}} {{.Image}} {{.Labels}} {{.Mounts}}"
+02f65160e14ca redis:alpine tier=backend proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/
+69ed779d8ef9f redis:alpine batch=no,type=small proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/
+```
+
+```
+sudo podman ps --ns -a
+CONTAINER ID NAMES PID CGROUP IPC MNT NET PIDNS USER UTS
+3557d882a82e3 k8s_container2_podsandbox1_redhat.test.crio_redhat-test-crio_1 29910 4026531835 4026532585 4026532593 4026532508 4026532595 4026531837 4026532594
+09564cdae0bec k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 29851 4026531835 4026532585 4026532590 4026532508 4026532592 4026531837 4026532591
+a31ebbee9cee7 k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 29717 4026531835 4026532585 4026532587 4026532508 4026532589 4026531837 4026532588
+```
+
+## ps
+Print a list of containers
+
+## SEE ALSO
+podman(1), crio(8), crio.conf(5)
+
+## HISTORY
+August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>