summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-pod-inspect.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-pod-inspect.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-pod-inspect.1.md')
-rw-r--r--docs/source/man/podman-pod-inspect.1.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/source/man/podman-pod-inspect.1.md b/docs/source/man/podman-pod-inspect.1.md
new file mode 100644
index 000000000..831d28259
--- /dev/null
+++ b/docs/source/man/podman-pod-inspect.1.md
@@ -0,0 +1,49 @@
+% podman-pod-inspect(1)
+
+## NAME
+podman\-pod\-inspect - Displays information describing a pod
+
+## SYNOPSIS
+**podman pod inspect** [*options*] *pod* ...
+
+## DESCRIPTION
+Displays configuration and state information about a given pod. It also displays information about containers
+that belong to the pod.
+
+## OPTIONS
+**--latest**, **-l**
+
+Instead of providing the pod name or ID, use the last created pod. If you use methods other than Podman
+to run pods such as CRI-O, the last started pod could be from either of those methods.
+
+The latest option is not supported on the remote client.
+
+## EXAMPLE
+```
+# podman pod inspect foobar
+{
+ "Config": {
+ "id": "3513ca70583dd7ef2bac83331350f6b6c47d7b4e526c908e49d89ebf720e4693",
+ "name": "foobar",
+ "labels": {},
+ "cgroupParent": "/libpod_parent",
+ "UsePodCgroup": true,
+ "created": "2018-08-08T11:15:18.823115347-05:00"
+ },
+ "State": {
+ "CgroupPath": ""
+ },
+ "Containers": [
+ {
+ "id": "d53f8bf1e9730281264aac6e6586e327429f62c704abea4b6afb5d8a2b2c9f2c",
+ "state": "configured"
+ }
+ ]
+}
+```
+
+## SEE ALSO
+podman-pod(1), podman-pod-ps(1)
+
+## HISTORY
+August 2018, Originally compiled by Brent Baude <bbaude@redhat.com>