summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorumohnani8 <umohnani@redhat.com>2018-04-16 10:53:23 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-04-17 14:49:47 +0000
commit64497042324e9f6ff6663e3dd5c61157f4137531 (patch)
tree2e38a1ce8975437b35d188e8327767f67dfec64a
parent18b9f2bd10206e9b4053c9f1a736abe2866ba274 (diff)
downloadpodman-64497042324e9f6ff6663e3dd5c61157f4137531.tar.gz
podman-64497042324e9f6ff6663e3dd5c61157f4137531.tar.bz2
podman-64497042324e9f6ff6663e3dd5c61157f4137531.zip
Modify diff and inspect docs
Format the examples in podman-diff.md better. The description for --type in the inspect docs was slightly different from that in the inline help. Also stated what values to use in the Go template for the --format flag. Signed-off-by: umohnani8 <umohnani@redhat.com> Closes: #620 Approved by: mheon
-rw-r--r--docs/podman-diff.1.md8
-rw-r--r--docs/podman-inspect.1.md12
2 files changed, 15 insertions, 5 deletions
diff --git a/docs/podman-diff.1.md b/docs/podman-diff.1.md
index 1ba5951db..a673c85c6 100644
--- a/docs/podman-diff.1.md
+++ b/docs/podman-diff.1.md
@@ -20,13 +20,16 @@ Alter the output into a different format. The only valid format for diff is `js
## EXAMPLE
-podman diff redis:alpine
+```
+# podman diff redis:alpine
C /usr
C /usr/local
C /usr/local/bin
A /usr/local/bin/docker-entrypoint.sh
+```
-podman diff --format json redis:alpine
+```
+# podman diff --format json redis:alpine
{
"changed": [
"/usr",
@@ -37,6 +40,7 @@ podman diff --format json redis:alpine
"/usr/local/bin/docker-entrypoint.sh"
]
}
+```
## SEE ALSO
podman(1)
diff --git a/docs/podman-inspect.1.md b/docs/podman-inspect.1.md
index d5996cdf7..1c83485c1 100644
--- a/docs/podman-inspect.1.md
+++ b/docs/podman-inspect.1.md
@@ -17,11 +17,12 @@ unspecified type. If a format is specified, the given template will be executed
**--type, t="TYPE"**
-Return data on items of the specified type. Type can be 'container', 'image' or 'all' (default: all)
+Return JSON for the specified type. Type can be 'container', 'image' or 'all' (default: all)
**--format, -f="FORMAT"**
-Format the output using the given Go template
+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
@@ -87,10 +88,15 @@ fedora
```
```
-$ sudo podman inspect a04 --format "{{.GraphDriver.Name}}"
+# podman inspect a04 --format "{{.GraphDriver.Name}}"
overlay
```
+```
+# podman inspect --format "size: {{.Size}}" alpine
+size: 4405240
+```
+
## SEE ALSO
podman(1)