Skip to content

Commit d3a49fd

Browse files
committed
Add information about --latest support on man pages
On Mac and Windows systems the --latest option is not supported this PR mentions this fact in the examples section of the man page. Also added documentation and consistency to the man pages examples sections. Signed-off-by: Daniel J Walsh <[email protected]>
1 parent d084146 commit d3a49fd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+374
-139
lines changed

docs/source/markdown/podman-attach.1.md.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Attach to a container called "foobar".
3131
$ podman attach foobar
3232
```
3333

34-
Attach to the latest created container.
34+
Attach to the latest created container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
3535
```
3636
$ podman attach --latest
3737
```

docs/source/markdown/podman-container-inspect.1.md.in

+4
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ In addition to normal output, display the total file size if the type is a conta
7474

7575
## EXAMPLE
7676

77+
Inspect the specified container and print its information in json format.
7778
```
7879
$ podman container inspect foobar
7980
[
@@ -305,16 +306,19 @@ $ podman container inspect foobar
305306
]
306307
```
307308

309+
Inspect the specified container for the Image Name it is based on.
308310
```
309311
$ podman container inspect nervous_fermi --format "{{.ImageName}}"
310312
registry.access.redhat.com/ubi8:latest
311313
```
312314

315+
Inspect the specified container for the GraphDriver Name it is running with.
313316
```
314317
$ podman container inspect foobar --format "{{.GraphDriver.Name}}"
315318
overlay
316319
```
317320

321+
Inspect the latest container created for its EffectiveCaps field. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
318322
```
319323
$ podman container inspect --latest --format {{.EffectiveCaps}}
320324
[CAP_CHOWN CAP_DAC_OVERRIDE CAP_FOWNER CAP_FSETID CAP_KILL CAP_NET_BIND_SERVICE CAP_SETFCAP CAP_SETGID CAP_SETPCAP CAP_SETUID]

docs/source/markdown/podman-init.1.md.in

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ Initialize all containers. Containers that have already initialized (including c
2626

2727
## EXAMPLE
2828

29-
Initialize container with a given ID
29+
Initialize specified container with a given ID.
3030
```
3131
podman init 35480fc9d568
3232
```
3333

34-
Initialize container with a given name
34+
Initialize specified container with a given name.
3535
```
3636
podman init test1
3737
```
3838

39-
Initialize the latest container created by Podman
39+
Initialize the latest container. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
4040
```
4141
podman init --latest
4242
```

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

+10-1
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,12 @@ In addition to normal output, display the total file size if the type is a conta
3535

3636
#### **--type**, **-t**=*type*
3737

38-
Return JSON for the specified type. Type can be 'container', 'image', 'volume', 'network', 'pod', or 'all' (default: all)
38+
Return JSON for the specified type. Type can be 'container', 'image', 'volume', 'network', 'pod', or 'all' (default: all)
3939
(Only meaningful when invoked as *podman inspect*)
4040

4141
## EXAMPLE
4242

43+
Inspect the fedora image
4344
```
4445
# podman inspect fedora
4546
[
@@ -121,35 +122,43 @@ Return JSON for the specified type. Type can be 'container', 'image', 'volume',
121122
]
122123
```
123124

125+
Inspect the specified image for Image Name.
124126
```
125127
# podman inspect a04 --format "{{.ImageName}}"
126128
fedora
127129
```
128130

131+
Inspect the specified image for GraphDriver Name.
129132
```
130133
# podman inspect a04 --format "{{.GraphDriver.Name}}"
131134
overlay
132135
```
133136

137+
Inspect the specified image for its Size field.
134138
```
135139
# podman image inspect --format "size: {{.Size}}" alpine
136140
size: 4405240
137141
```
138142

143+
Inspect the latest container created for its EffectiveCaps field. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
139144
```
140145
podman container inspect --latest --format {{.EffectiveCaps}}
141146
[CAP_CHOWN CAP_DAC_OVERRIDE CAP_FSETID CAP_FOWNER CAP_SETGID CAP_SETUID CAP_SETFCAP CAP_SETPCAP CAP_NET_BIND_SERVICE CAP_KILL]
142147
```
143148

149+
Inspect the specified pod for the Name field.
144150
```
145151
# podman inspect myPod --type pod --format "{{.Name}}"
146152
myPod
147153
```
154+
155+
Inspect the specified volume for the Name field.
148156
```
149157
# podman inspect myVolume --type volume --format "{{.Name}}"
150158
myVolume
151159
```
152160

161+
Inspect the specified network for the Name field.
153162
```
154163
# podman inspect nyNetwork --type network --format "{{.name}}"
155164
myNetwork

docs/source/markdown/podman-kill.1.md.in

+2-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ Terminate container by sending `TERM` signal
3939
podman kill --signal TERM 860a4b23
4040
```
4141

42-
Kill the latest container created by Podman
42+
Kill the latest container. (This option is not available with the remote Podman client, including Mac and Windows
43+
(excluding WSL2) machines)
4344
```
4445
podman kill --latest
4546
```

docs/source/markdown/podman-kube-generate.1.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The Kubernetes kind to generate in the YAML file. Currently, the only supported
6363

6464
## EXAMPLES
6565

66-
Create Kubernetes Pod YAML for a container called `some-mariadb`.
66+
Create Kubernetes Pod YAML for the specified container.
6767
```
6868
$ podman kube generate some-mariadb
6969
# Save the output of this file and use kubectl create -f to import
@@ -103,7 +103,7 @@ spec:
103103
claimName: mariadb_data
104104
```
105105

106-
Create Kubernetes Deployment YAML with 3 replicas for a container called `dep-ctr`
106+
Create Kubernetes Deployment YAML with 3 replicas for the specified container.
107107
```
108108
$ podman kube generate --type deployment --replicas 3 dep-ct
109109
r
@@ -140,7 +140,7 @@ spec:
140140
```
141141

142142

143-
Create Kubernetes Pod YAML for a container with the directory `/home/user/my-data` on the host bind-mounted in the container to `/volume`.
143+
Create Kubernetes Pod YAML for the specified container with the host directory `/home/user/my-data` bind-mounted onto the container path `/volume`.
144144
```
145145
$ podman kube generate my-container-with-bind-mounted-data
146146
# Save the output of this file and use kubectl create -f to import
@@ -171,7 +171,7 @@ spec:
171171
name: home-user-my-data-host
172172
```
173173

174-
Create Kubernetes Pod YAML for a container with the named volume `priceless-data` mounted in the container at `/volume`.
174+
Create Kubernetes Pod YAML for the specified container with named volume `priceless-data` mounted onto the container path `/volume`.
175175
```
176176
$ podman kube generate my-container-using-priceless-data
177177
# Save the output of this file and use kubectl create -f to import
@@ -201,7 +201,7 @@ spec:
201201
claimName: priceless-data
202202
```
203203

204-
Create Kubernetes Pod YAML for a pod called `demoweb` and include a service.
204+
Create Kubernetes Pod YAML for the specified pod and include a service.
205205
```
206206
$ sudo podman kube generate -s demoweb
207207
# Save the output of this file and use kubectl create -f to import

docs/source/markdown/podman-kube-play.1.md.in

+8-8
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Using the `--down` command line option, it is also capable of tearing down the p
1414

1515
Using the `--replace` command line option, it tears down the pods(if any) created by a previous run of `podman kube play` and recreate the pods with the Kubernetes YAML file.
1616

17-
Ideally the input file is created by Podman (see podman-kube-generate(1)). This guarantees a smooth import and expected results.
17+
Ideally the input file is created by the Podman command (see podman-kube-generate(1)). This guarantees a smooth import and expected results.
1818

1919
Currently, the supported Kubernetes kinds are:
2020

@@ -270,19 +270,19 @@ upon exit.
270270

271271
## EXAMPLES
272272

273-
Recreate the pod and containers as described in a file called `demo.yml`
273+
Recreate the pod and containers described in the specified host YAML file.
274274
```
275275
$ podman kube play demo.yml
276276
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6
277277
```
278278

279-
Recreate the pod and containers as described in a file `demo.yml` sent to stdin
279+
Recreate the pod and containers specified in a YAML file sent to stdin.
280280
```
281281
$ cat demo.yml | podman kube play -
282282
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6
283-
284283
```
285-
Teardown the pod and containers as described in a file `demo.yml`
284+
285+
Teardown the pod and containers as described in the specified YAML file.
286286
```
287287
$ podman kube play --down demo.yml
288288
Pods stopped:
@@ -291,7 +291,7 @@ Pods removed:
291291
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6
292292
```
293293

294-
Provide `configmap-foo.yml` and `configmap-bar.yml` as sources for environment variables within the containers.
294+
Provide multiple configmaps files as sources for environment variables within the specified pods and containers.
295295
```
296296
$ podman kube play demo.yml --configmap configmap-foo.yml,configmap-bar.yml
297297
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6
@@ -300,14 +300,14 @@ $ podman kube play demo.yml --configmap configmap-foo.yml --configmap configmap-
300300
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6
301301
```
302302

303-
Create a pod connected to two networks (called net1 and net2) with a static ip
303+
Create a pod connected to two networks with a static ip.
304304
```
305305
$ podman kube play demo.yml --network net1:ip=10.89.1.5 --network net2:ip=10.89.10.10
306306
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6
307307
```
308308
Please take into account that networks must be created first using podman-network-create(1).
309309

310-
Create and teardown from a URL pointing to a YAML file
310+
Create and teardown from a URL pointing to a YAML file.
311311
```
312312
$ podman kube play https://podman.io/demo.yml
313313
52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6

docs/source/markdown/podman-load.1.md

+4
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,17 @@ Suppress the progress output
4444

4545
## EXAMPLES
4646

47+
Create an image from a compressed tar file, without showing progress.
4748
```
4849
$ podman load --quiet -i fedora.tar.gz
4950
```
5051

52+
Create an image from the archive.tar file pulled from a URL, without showing progress.
5153
```
5254
$ podman load -q -i https://server.com/archive.tar
5355
```
5456

57+
Create an image from stdin using bash redirection from a tar file.
5558
```
5659
$ podman load < fedora.tar
5760
Getting image source signatures
@@ -64,6 +67,7 @@ Storing signatures
6467
Loaded image: registry.fedoraproject.org/fedora:latest
6568
```
6669

70+
Create an image from stdin using a piped.
6771
```
6872
$ cat fedora.tar | podman load
6973
Getting image source signatures

docs/source/markdown/podman-login.1.md.in

+10-1
Original file line numberDiff line numberDiff line change
@@ -69,52 +69,61 @@ print detailed information about credential store
6969

7070
## EXAMPLES
7171

72+
Add login credentials for specified registry to the default authorization file.
7273
```
7374
$ podman login docker.io
7475
Username: umohnani
7576
Password:
7677
Login Succeeded!
7778
```
7879

80+
Add login credentials using specified username and password for local registry to the default authorization file.
7981
```
8082
$ podman login -u testuser -p testpassword localhost:5000
8183
Login Succeeded!
8284
```
8385

86+
Add login credentials for alternate authfile path for the specified registry.
8487
```
85-
$ podman login --authfile authdir/myauths.json docker.io
88+
$ podman login --authfile authdir/myauths.json quay.io
8689
Username: umohnani
8790
Password:
8891
Login Succeeded!
8992
```
9093

94+
Add login credentials as a Podman Secret for the specified registry to the default authorization file.
9195
```
9296
$ echo -n MySecret! | podman secret create secretname -
9397
a0ad54df3c97cf89d5ca6193c
9498
$ podman login --secret secretname -u testuser quay.io
9599
Login Succeeded!
96100
```
97101

102+
Add login credentials for user test with password test to localhost:5000 registry disabling tls verification requirement.
98103
```
99104
$ podman login --tls-verify=false -u test -p test localhost:5000
100105
Login Succeeded!
101106
```
102107

108+
Add login credentials for user foo with password bar to localhost:5000 registry using the certificate directory /etc/containers/certs.d.
103109
```
104110
$ podman login --cert-dir /etc/containers/certs.d/ -u foo -p bar localhost:5000
105111
Login Succeeded!
106112
```
107113

114+
Add login credentials for docker.io into the default authorization file for user testuser with password information provided via stdin from a file on disk.
108115
```
109116
$ podman login -u testuser --password-stdin < testpassword.txt docker.io
110117
Login Succeeded!
111118
```
112119

120+
Add login credentials for docker.io into the default authorization file for user testuser with password information provided via stdin from a pipe.
113121
```
114122
$ echo $testpassword | podman login -u testuser --password-stdin docker.io
115123
Login Succeeded!
116124
```
117125

126+
Add login credentials for the quay.io registry in verbose mode default authorization file.
118127
```
119128
$ podman login quay.io --verbose
120129
Username: myusername

docs/source/markdown/podman-logout.1.md.in

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,19 @@ Print usage statement
3737

3838
## EXAMPLES
3939

40+
Remove login credentials for the docker.io registry from the authorization file
4041
```
4142
$ podman logout docker.io
42-
Remove login credentials for https://registry-1.docker.io/v2/
4343
```
4444

45+
Remove login credentials for the docker.io registry from the authdir/myauths.json file.
4546
```
4647
$ podman logout --authfile authdir/myauths.json docker.io
47-
Remove login credentials for https://registry-1.docker.io/v2/
4848
```
4949

50+
Remove login credentials for all registries.
5051
```
5152
$ podman logout --all
52-
Remove login credentials for all registries
5353
```
5454

5555
## SEE ALSO

docs/source/markdown/podman-machine-info.1.md

+3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Print usage statement.
2828

2929
## EXAMPLES
3030

31+
Display default Podman machine info.
3132
```
3233
$ podman machine info
3334
Host:
@@ -52,6 +53,7 @@ Version:
5253
Version: 4.4.0
5354
```
5455

56+
Display default Podman machine info formatted as json.
5557
```
5658
$ podman machine info --format json
5759
{
@@ -80,6 +82,7 @@ $ podman machine info --format json
8082
}
8183
```
8284

85+
Display default Podman machine Host.Arch field.
8386
```
8487
$ podman machine info --format "{{ .Host.Arch }}"
8588
amd64

0 commit comments

Comments
 (0)