Skip to content

Commit bc5a4fb

Browse files
committed
Fix up example description of podman-pod commands
Signed-off-by: Daniel J Walsh <[email protected]>
1 parent d5a17ad commit bc5a4fb

10 files changed

+34
-32
lines changed

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

+4-8
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,16 @@ was an issue accessing the local storage.
1414

1515
## EXAMPLES
1616

17-
Check if a pod called `web` exists in local storage (the pod does actually exist).
17+
Check if specified pod exists in local storage (the pod does actually exist):
1818
```
19-
$ sudo podman pod exists web
20-
$ echo $?
19+
$ sudo podman pod exists web; echo $?
2120
0
22-
$
2321
```
2422

25-
Check if a pod called `backend` exists in local storage (the pod does not actually exist).
23+
Check if specified pod exists in local storage (the pod does not actually exist):
2624
```
27-
$ sudo podman pod exists backend
28-
$ echo $?
25+
$ sudo podman pod exists backend; echo $?
2926
1
30-
$
3127
```
3228

3329
## SEE ALSO

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

+2
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ Valid placeholders for the Go template are listed below:
6060
@@option latest
6161

6262
## EXAMPLE
63+
64+
Inspect specified pod:
6365
```
6466
# podman pod inspect foobar
6567
[

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,27 @@ Sends signal to all containers associated with a pod.
2020

2121
## EXAMPLE
2222

23-
Kill pod with a given name
23+
Kill pod with a given name:
2424
```
2525
podman pod kill mywebserver
2626
```
2727

28-
Kill pod with a given ID
28+
Kill pod with a given ID:
2929
```
3030
podman pod kill 860a4b23
3131
```
3232

33-
Terminate pod by sending `TERM` signal
33+
Terminate pod by sending `TERM` signal:
3434
```
3535
podman pod kill --signal TERM 860a4b23
3636
```
3737

38-
Kill the latest pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
38+
Kill the latest pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines):
3939
```
4040
podman pod kill --latest
4141
```
4242

43-
Terminate all pods by sending `KILL` signal
43+
Terminate all pods by sending `KILL` signal:
4444
```
4545
podman pod kill --all
4646
```

docs/source/markdown/podman-pod-logs.1.md.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ To view a pod's logs:
4040
podman pod logs -t podIdorName
4141
```
4242

43-
To view logs of a specific container on the pod
43+
To view logs of a specific container on the pod:
4444
```
4545
podman pod logs -c ctrIdOrName podIdOrName
4646
```

docs/source/markdown/podman-pod-pause.1.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Instead of providing the pod name or ID, pause the last created pod. (This optio
2121

2222
## EXAMPLE
2323

24-
Pause a pod with a given name
24+
Pause a pod with a given name:
2525
```
2626
podman pod pause mywebserverpod
2727
```
2828

29-
Pause a pod with a given ID
29+
Pause a pod with a given ID:
3030
```
3131
podman pod pause 860a4b23
3232
```

docs/source/markdown/podman-pod-restart.1.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,26 @@ Instead of providing the pod name or ID, restart the last created pod. (This opt
2424

2525
## EXAMPLE
2626

27-
Restart pod with a given name
27+
Restart pod with a given name:
2828
```
2929
podman pod restart mywebserverpod
3030
cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907
3131
```
3232

33-
Restart multiple pods with given IDs
33+
Restart multiple pods with given IDs:
3434
```
3535
podman pod restart 490eb 3557fb
3636
490eb241aaf704d4dd2629904410fe4aa31965d9310a735f8755267f4ded1de5
3737
3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
3838
```
3939

40-
Restart the last created pod
40+
Restart the last created pod:
4141
```
4242
podman pod restart --latest
4343
3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
4444
```
4545

46-
Restart all pods
46+
Restart all pods:
4747
```
4848
podman pod restart --all
4949
19456b4cd557eaf9629825113a552681a6013f8c8cad258e36ab825ef536e818

docs/source/markdown/podman-pod-rm.1.md.in

+5-5
Original file line numberDiff line numberDiff line change
@@ -32,28 +32,28 @@ The --force option must be specified to use the --time option.
3232

3333
## EXAMPLE
3434

35-
Remove pod with a given name
35+
Remove pod with a given name:
3636
```
3737
podman pod rm mywebserverpod
3838
```
3939

40-
Remove multiple pods with given names and/or IDs
40+
Remove multiple pods with given names and/or IDs:
4141
```
4242
podman pod rm mywebserverpod myflaskserverpod 860a4b23
4343
```
4444

45-
Forcefully remove pod with a given ID
45+
Forcefully remove pod with a given ID:
4646
```
4747
podman pod rm -f 860a4b23
4848
```
4949

50-
Forcefully remove all pods
50+
Forcefully remove all pods:
5151
```
5252
podman pod rm -f -a
5353
podman pod rm -fa
5454
```
5555

56-
Remove pod using ID specified in a given file
56+
Remove pod using ID specified in a given file:
5757
```
5858
podman pod rm --pod-id-file /path/to/id/file
5959
```

docs/source/markdown/podman-pod-start.1.md.in

+5-5
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,27 @@ Starts all pods
2222

2323
## EXAMPLE
2424

25-
Start pod with a given name
25+
Start pod with a given name:
2626
```
2727
podman pod start mywebserverpod
2828
```
2929

30-
Start pods with given IDs
30+
Start pods with given IDs:
3131
```
3232
podman pod start 860a4b23 5421ab4
3333
```
3434

35-
Start the latest pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
35+
Start the latest pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines):
3636
```
3737
podman pod start --latest
3838
```
3939

40-
Start all pods
40+
Start all pods:
4141
```
4242
podman pod start --all
4343
```
4444

45-
Start pod using ID specified in a given file
45+
Start pod using ID specified in a given file:
4646
```
4747
podman pod start --pod-id-file /path/to/id/file
4848
```

docs/source/markdown/podman-pod-stats.1.md.in

+4
Original file line numberDiff line numberDiff line change
@@ -44,19 +44,22 @@ When using a Go template, precede the format with `table` to print headers.
4444

4545
## EXAMPLE
4646

47+
List statistics about all pods without streaming:
4748
```
4849
# podman pod stats -a --no-stream
4950
ID NAME CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS
5051
a9f807ffaacd frosty_hodgkin -- 3.092MB / 16.7GB 0.02% -- / -- -- / -- 2
5152
3b33001239ee sleepy_stallman -- -- / -- -- -- / -- -- / -- --
5253
```
5354

55+
List statistics about specified pod without streaming:
5456
```
5557
# podman pod stats --no-stream a9f80
5658
ID NAME CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS
5759
a9f807ffaacd frosty_hodgkin -- 3.092MB / 16.7GB 0.02% -- / -- -- / -- 2
5860
```
5961

62+
List statistics about specified pod in JSON format without streaming:
6063
```
6164
# podman pod stats --no-stream --format=json a9f80
6265
[
@@ -73,6 +76,7 @@ a9f807ffaacd frosty_hodgkin -- 3.092MB / 16.7GB 0.02% -- / -- --
7376
]
7477
```
7578

79+
List selected statistics formatted in a table about specified pod:
7680
```
7781
# podman pod stats --no-stream --format "table {{.ID}} {{.Name}} {{.MemUsage}}" 6eae
7882
ID NAME MEM USAGE / LIMIT

docs/source/markdown/podman-pod-unpause.1.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Instead of providing the pod name or ID, unpause the last created pod. (This opt
2121

2222
## EXAMPLE
2323

24-
Unpause pod with a given name
24+
Unpause pod with a given name:
2525
```
2626
podman pod unpause mywebserverpod
2727
```
2828

29-
Unpause pod with a given ID
29+
Unpause pod with a given ID:
3030
```
3131
podman pod unpause 860a4b23
3232
```

0 commit comments

Comments
 (0)