summaryrefslogtreecommitdiff
path: root/docs/podman-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/podman-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/podman-inspect.1.md')
-rw-r--r--docs/podman-inspect.1.md115
1 files changed, 0 insertions, 115 deletions
diff --git a/docs/podman-inspect.1.md b/docs/podman-inspect.1.md
deleted file mode 100644
index f1630c713..000000000
--- a/docs/podman-inspect.1.md
+++ /dev/null
@@ -1,115 +0,0 @@
-% podman-inspect(1)
-
-## NAME
-podman\-inspect - Display a container or image's configuration
-
-## SYNOPSIS
-**podman inspect** [*options*] *name* [...]
-
-**podman image inspect** [*options*] *image*
-
-**podman container inspect** [*options*] *container*
-
-## DESCRIPTION
-This displays the low-level information on containers and images identified by name or ID. By default, this will render
-all results in a JSON array. If the container and image have the same name, this will return container JSON for
-unspecified type. If a format is specified, the given template will be executed for each result.
-
-## OPTIONS
-
-**--type**, **-t**=*type*
-
-Return JSON for the specified type. Type can be 'container', 'image' or 'all' (default: all)
-(Only meaningful when invoked as *podman inspect*)
-
-**--format**, **-f**=*format*
-
-Format the output using the given Go template.
-The keys of the returned JSON can be used as the values for the --format flag (see examples below).
-
-**--latest**, **-l**
-
-Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
-to run containers such as CRI-O, the last started container could be from either of those methods.
-
-The latest option is not supported on the remote client or when invoked as *podman image inspect*.
-
-**--size**, **-s**
-
-Display the total file size if the type is a container
-
-
-## EXAMPLE
-
-```
-# podman inspect fedora
-{
- "Id": "422dc563ca3260ad9ef5c47a1c246f5065d7f177ce51f4dd208efd82967ff182",
- "Digest": "sha256:1b9bfb4e634dc1e5c19d0fa1eb2e5a28a5c2b498e3d3e4ac742bd7f5dae08611",
- "RepoTags": [
- "docker.io/library/fedora:latest"
- ],
- "RepoDigests": [
- "docker.io/library/fedora@sha256:1b9bfb4e634dc1e5c19d0fa1eb2e5a28a5c2b498e3d3e4ac742bd7f5dae08611"
- ],
- "Parent": "",
- "Comment": "",
- "Created": "2017-11-14T21:07:08.475840838Z",
- "Config": {
- "Env": [
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
- "DISTTAG=f27container",
- "FGC=f27",
- "FBR=f27"
- ]
- },
- "Version": "17.06.2-ce",
- "Author": "[Adam Miller \u003cmaxamillion@fedoraproject.org\u003e] [Patrick Uiterwijk \u003cpatrick@puiterwijk.org\u003e]",
- "Architecture": "amd64",
- "Os": "linux",
- "Size": 251722732,
- "VirtualSize": 514895140,
- "GraphDriver": {
- "Name": "overlay",
- "Data": {
- "MergedDir": "/var/lib/containers/storage/overlay/d32459d9ce237564fb93573b85cbc707600d43fbe5e46e8eeef22cad914bb516/merged",
- "UpperDir": "/var/lib/containers/storage/overlay/d32459d9ce237564fb93573b85cbc707600d43fbe5e46e8eeef22cad914bb516/diff",
- "WorkDir": "/var/lib/containers/storage/overlay/d32459d9ce237564fb93573b85cbc707600d43fbe5e46e8eeef22cad914bb516/work"
- }
- },
- "RootFS": {
- "Type": "layers",
- "Layers": [
- "sha256:d32459d9ce237564fb93573b85cbc707600d43fbe5e46e8eeef22cad914bb516"
- ]
- },
- "Labels": null,
- "Annotations": {}
-}
-```
-
-```
-# podman inspect a04 --format "{{.ImageName}}"
-fedora
-```
-
-```
-# podman inspect a04 --format "{{.GraphDriver.Name}}"
-overlay
-```
-
-```
-# podman image inspect --format "size: {{.Size}}" alpine
-size: 4405240
-```
-
-```
-podman container inspect --latest --format {{.EffectiveCaps}}
-[CAP_CHOWN CAP_DAC_OVERRIDE CAP_FSETID CAP_FOWNER CAP_MKNOD CAP_NET_RAW CAP_SETGID CAP_SETUID CAP_SETFCAP CAP_SETPCAP CAP_NET_BIND_SERVICE CAP_SYS_CHROOT CAP_KILL CAP_AUDIT_WRITE]
-```
-
-## SEE ALSO
-podman(1)
-
-## HISTORY
-July 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>