Skip to content

Commit 777b258

Browse files
committed
Fix up example description of podman-image commands
Signed-off-by: Daniel J Walsh <[email protected]>
1 parent fbb4d5d commit 777b258

9 files changed

+43
-39
lines changed

docs/source/markdown/podman-image-diff.1.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,18 @@ Alter the output into a different format. The only valid format for **podman im
2525

2626
## EXAMPLE
2727

28+
Display image differences from images parent layer:
2829
```
29-
$ podman diff redis:old
30+
$ podman image diff redis:old
3031
C /usr
3132
C /usr/local
3233
C /usr/local/bin
3334
A /usr/local/bin/docker-entrypoint.sh
3435
```
3536

37+
Display image differences between two different images in JSON format:
3638
```
37-
$ podman diff --format json redis:old redis:alpine
39+
$ podman image diff --format json redis:old redis:alpine
3840
{
3941
"changed": [
4042
"/usr",

docs/source/markdown/podman-image-exists.1.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,18 @@ Print usage statement
2020

2121
## EXAMPLES
2222

23-
Check if an image called `webclient` exists in local storage (the image does actually exist).
23+
Check if an image called `webclient` exists in local storage (the image does actually exist):
2424
```
2525
$ podman image exists webclient
2626
$ echo $?
2727
0
28-
$
2928
```
3029

31-
Check if an image called `webbackend` exists in local storage (the image does not actually exist).
30+
Check if an image called `webbackend` exists in local storage (the image does not actually exist):
3231
```
3332
$ podman image exists webbackend
3433
$ echo $?
3534
1
36-
$
3735
```
3836

3937
## SEE ALSO

docs/source/markdown/podman-image-inspect.1.md

+2
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Valid placeholders for the Go template are listed below:
4747

4848
## EXAMPLE
4949

50+
Inspect information on the specified image:
5051
```
5152
$ podman image inspect fedora
5253
[
@@ -120,6 +121,7 @@ $ podman image inspect fedora
120121
]
121122
```
122123

124+
Inspect image ID for the specified image:
123125
```
124126
$ podman image inspect --format '{{ .Id }}' fedora
125127
37e5619f4a8ca9dbc4d6c0ae7890625674a10dbcfb76201399e2aaddb40da17d

docs/source/markdown/podman-image-mount.1.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,21 @@ Print the mounted images in specified format (json).
3232

3333
## EXAMPLE
3434

35+
Mount multiple images. Note: In rootless mode, image mounting works only after executing the podman unshare command to enter the user namespace.
3536
```
3637
podman image mount fedora ubi8-init
37-
3838
/var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged
3939
/var/lib/containers/storage/overlay/0ff7d7ca68bed1ace424f9df154d2dd7b5a125c19d887f17653cbcd5b6e30ba1/merged
4040
```
4141

42+
List mounted images:
4243
```
43-
podman mount
44-
44+
podman image mount
4545
registry.fedoraproject.org/fedora:latest /var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged
4646
registry.access.redhat.com/ubi8-init:latest /var/lib/containers/storage/overlay/0ff7d7ca68bed1ace424f9df154d2dd7b5a125c19d887f17653cbcd5b6e30ba1/merged
4747
```
4848

49+
List mounted images in JSON format:
4950
```
5051
podman image mount --format json
5152
[

docs/source/markdown/podman-image-prune.1.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Print usage statement
4949

5050
## EXAMPLES
5151

52-
Remove all dangling images from local storage
52+
Remove all dangling images from local storage:
5353
```
5454
$ sudo podman image prune
5555
@@ -59,7 +59,7 @@ f3e20dc537fb04cb51672a5cb6fdf2292e61d411315549391a0d1f64e4e3097e
5959
324a7a3b2e0135f4226ffdd473e4099fd9e477a74230cdc35de69e84c0f9d907
6060
```
6161

62-
Remove all unused images from local storage without confirming
62+
Remove all unused images from local storage without confirming:
6363
```
6464
$ sudo podman image prune -a -f
6565
f3e20dc537fb04cb51672a5cb6fdf2292e61d411315549391a0d1f64e4e3097e
@@ -71,7 +71,7 @@ e4e5109420323221f170627c138817770fb64832da7d8fe2babd863148287fca
7171
7272
```
7373

74-
Remove all unused images from local storage since given time/hours.
74+
Remove all unused images from local storage since given time/hours:
7575
```
7676
$ sudo podman image prune -a --filter until=2019-11-14T06:15:42.937792374Z
7777
@@ -91,7 +91,7 @@ f3e20dc537fb04cb51672a5cb6fdf2292e61d411315549391a0d1f64e4e3097e
9191
324a7a3b2e0135f4226ffdd473e4099fd9e477a74230cdc35de69e84c0f9d907
9292
```
9393

94-
Remove all unused images from local storage with label version 1.0
94+
Remove all unused images from local storage with label version 1.0:
9595
```
9696
$ sudo podman image prune -a -f --filter label=version=1.0
9797
e813d2135f17fadeffeea8159a34cfdd4c30b98d8111364b913a91fd930643e9
@@ -102,7 +102,6 @@ e813d2135f17fadeffeea8159a34cfdd4c30b98d8111364b913a91fd930643e9
102102
f9f0a8a58c9e02a2b3250b88cc5c95b1e10245ca2c4161d19376580aaa90f55c
103103
1ef14d5ede80db78978b25ad677fd3e897a578c3af614e1fda608d40c8809707
104104
45e1482040e441a521953a6da2eca9bafc769e15667a07c23720d6e0cafc3ab2
105-
106105
```
107106

108107
## SEE ALSO

docs/source/markdown/podman-image-scp.1.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,13 @@ Suppress the output
3030

3131
## EXAMPLES
3232

33-
33+
Copy specified image to local storage:
3434
```
3535
$ podman image scp alpine
3636
Loaded image: docker.io/library/alpine:latest
3737
```
3838

39+
Copy specified image from local storage to remote connection:
3940
```
4041
$ podman image scp alpine Fedora::/home/charliedoern/Documents/alpine
4142
Getting image source signatures
@@ -46,11 +47,13 @@ Storing signatures
4647
Loaded image: docker.io/library/alpine:latest
4748
```
4849

50+
Copy specified image from remote connection to remote connection:
4951
```
5052
$ podman image scp Fedora::alpine RHEL::
5153
Loaded image: docker.io/library/alpine:latest
5254
```
5355

56+
Copy specified image via ssh to local storage:
5457
```
5558
$ podman image scp [email protected]:22/run/user/1000/podman/podman.sock::alpine
5659
WARN[0000] Unknown connection name given. Please use system connection add to specify the default remote socket location
@@ -62,6 +65,7 @@ Storing signatures
6265
Loaded image: docker.io/library/alpine:latest
6366
```
6467

68+
Copy specified image from root account to user accounts local storage:
6569
```
6670
$ sudo podman image scp root@localhost::alpine username@localhost::
6771
Copying blob e2eb06d8af82 done
@@ -76,6 +80,7 @@ Storing signatures
7680
Loaded image: docker.io/library/alpine:latest
7781
```
7882

83+
Copy specified image from root account to local storage:
7984
```
8085
$ sudo podman image scp root@localhost::alpine
8186
Copying blob e2eb06d8af82 done

docs/source/markdown/podman-image-tree.1.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,8 @@ Show all child images and layers of the specified image
2323

2424
## EXAMPLES
2525

26+
List image tree information on specified image:
2627
```
27-
$ podman pull docker.io/library/wordpress
28-
$ podman pull docker.io/library/php:7.2-apache
29-
3028
$ podman image tree docker.io/library/wordpress
3129
Image ID: 6e880d17852f
3230
Tags: [docker.io/library/wordpress:latest]
@@ -51,10 +49,10 @@ Image Layers
5149
├── ID: 834f4497afda Size: 7.168kB
5250
├── ID: bfe2ce1263f8 Size: 40.06MB
5351
└── ID: 748e99b214cf Size: 11.78kB Top Layer of: [docker.io/library/wordpress:latest]
52+
```
5453

55-
$ podman pull docker.io/circleci/ruby:latest
56-
$ podman pull docker.io/library/ruby:latest
57-
54+
Show all child images and layers of the specified image:
55+
```
5856
$ podman image tree ae96a4ad4f3f --whatrequires
5957
Image ID: ae96a4ad4f3f
6058
Tags: [docker.io/library/ruby:latest]

docs/source/markdown/podman-image-trust.1.md.in

+14-15
Original file line numberDiff line numberDiff line change
@@ -78,18 +78,19 @@ Trust may be updated using the command **podman image trust set** for an existin
7878

7979
## EXAMPLES
8080

81-
Accept all unsigned images from a registry
82-
83-
sudo podman image trust set --type accept docker.io
84-
85-
Modify default trust policy
86-
87-
sudo podman image trust set -t reject default
81+
Accept all unsigned images from a registry:
82+
```
83+
sudo podman image trust set --type accept docker.io
84+
```
8885

89-
Display system trust policy
86+
Modify default trust policy:
87+
```
88+
sudo podman image trust set -t reject default
89+
```
9090

91-
podman image trust show
91+
Display system trust policy:
9292
```
93+
podman image trust show
9394
TRANSPORT NAME TYPE ID STORE
9495
all default reject
9596
repository docker.io/library accept
@@ -99,10 +100,9 @@ repository docker.io reject
99100
docker-daemon accept
100101
```
101102

102-
Display trust policy file
103-
104-
podman image trust show --raw
103+
Display trust policy file:
105104
```
105+
podman image trust show --raw
106106
{
107107
"default": [
108108
{
@@ -147,10 +147,9 @@ Display trust policy file
147147
}
148148
```
149149

150-
Display trust as JSON
151-
152-
podman image trust show --json
150+
Display trust as JSON:
153151
```
152+
podman image trust show --json
154153
[
155154
{
156155
"transport": "all",

docs/source/markdown/podman-image-unmount.1.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,17 @@ Note: Other processes using the file system can fail if the mount point is remov
3232

3333
## EXAMPLE
3434

35-
Unmount image with a given ID
35+
Unmount image with a given ID:
3636
```
3737
podman image unmount imageID
3838
```
3939

40-
Unmount multiple images with given IDs
40+
Unmount multiple images with given IDs:
4141
```
4242
podman image unmount imageID1 imageID2 imageID3
4343
```
4444

45-
Unmount all images
45+
Unmount all images:
4646
```
4747
podman image unmount --all
4848
```

0 commit comments

Comments
 (0)