Skip to content

Commit e4229f0

Browse files
Merge pull request containers#21729 from rhatdan/docs4
[CI:DOCS] Fix up example description of podman-network commands
2 parents a66276e + aad195c commit e4229f0

8 files changed

+19
-25
lines changed

docs/source/markdown/podman-network-connect.1.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,17 @@ Set a static mac address for this container on this network.
2828

2929
## EXAMPLE
3030

31-
Connect a container named *web* to a network named *test*
31+
Connect specified container to a named network:
3232
```
3333
podman network connect test web
3434
```
3535

36-
Connect a container name *web* to a network named *test* with two aliases: web1 and web2
36+
Connect specified container to named network with two aliases:
3737
```
3838
podman network connect --alias web1 --alias web2 test web
3939
```
4040

41-
Connect a container name *web* to a network named *test* with a static ip.
41+
Connect specified container to named network with a static ip:
4242
```
4343
podman network connect --ip 10.89.1.13 test web
4444
```

docs/source/markdown/podman-network-disconnect.1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ and it does not have network connectivity until a network is connected again.
1818
Force the container to disconnect from a network
1919

2020
## EXAMPLE
21-
Disconnect a container named *web* from a network called *test*.
2221

22+
Disconnect container from specified network:
2323
```
2424
podman network disconnect test web
2525
```

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

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

2222
## EXAMPLE
2323

24-
Check if a network called `net1` exists (the network does actually exist).
24+
Check if specified network exists (the network does actually exist):
2525
```
2626
$ podman network exists net1
2727
$ echo $?
2828
0
29-
$
3029
```
3130

32-
Check if a network called `webbackend` exists (the network does not actually exist).
31+
Check if nonexistent network exists:
3332
```
3433
$ podman network exists webbackend
3534
$ echo $?
3635
1
37-
$
3836
```
3937

4038
## SEE ALSO

docs/source/markdown/podman-network-ls.1.md.in

+4-5
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ The `quiet` option restricts the output to only the network names.
7171

7272
## EXAMPLE
7373

74-
Display networks
75-
74+
Display networks:
7675
```
7776
$ podman network ls
7877
NETWORK ID NAME DRIVER
@@ -81,7 +80,7 @@ NETWORK ID NAME DRIVER
8180
8e35c2cd3bf6 podman5 macvlan
8281
```
8382

84-
Display only network names
83+
Display only network names:
8584
```
8685
$ podman network ls -q
8786
podman
@@ -90,14 +89,14 @@ outside
9089
podman9
9190
```
9291

93-
Display name of network which support bridge plugin
92+
Display name of network which support bridge plugin:
9493
```
9594
$ podman network ls --filter driver=bridge --format {{.Name}}
9695
podman
9796
podman2
9897
podman9
9998
```
100-
List networks with their subnets
99+
List networks with their subnets:
101100
```
102101
$ podman network ls --format "{{.Name}}: {{range .Subnets}}{{.Subnet}} {{end}}"
103102
podman: 10.88.0.0/16

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,13 @@ The `until` *filter* can be Unix timestamps, date formatted timestamps, or Go du
3535
Do not prompt for confirmation
3636

3737
## EXAMPLE
38-
Prune networks
38+
39+
Prune networks:
3940
```
4041
podman network prune
4142
```
4243

43-
Prune all networks created before 2h
44+
Prune all networks created not created in the last two hours:
4445
```
4546
podman network prune --filter until=2h
4647
```

docs/source/markdown/podman-network-reload.1.md.in

+2-4
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ Reload network configuration of all containers.
2222

2323
## EXAMPLE
2424

25-
Reload the network configuration after a firewall reload.
26-
25+
Reload the network configuration after a firewall reload:
2726
```
2827
# podman run -p 80:80 -d nginx
2928
b1b538e8bc4078fc3ee1c95b666ebc7449b9a97bacd15bcbe464a29e1be59c1c
@@ -39,8 +38,7 @@ b1b538e8bc4078fc3ee1c95b666ebc7449b9a97bacd15bcbe464a29e1be59c1c
3938
works
4039
```
4140

42-
Reload the network configuration for all containers.
43-
41+
Reload the network configuration for all containers:
4442
```
4543
# podman network reload --all
4644
b1b538e8bc4078fc3ee1c95b666ebc7449b9a97bacd15bcbe464a29e1be59c1c

docs/source/markdown/podman-network-rm.1.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,13 @@ Seconds to wait before forcibly stopping the running containers that are using t
2121

2222
## EXAMPLE
2323

24-
Delete the `podman9` network
25-
24+
Delete specified network:
2625
```
2726
# podman network rm podman9
2827
Deleted: podman9
2928
```
3029

31-
Delete the `fred` network and all containers associated with the network.
32-
30+
Delete specified network and all containers associated with the network:
3331
```
3432
# podman network rm -f fred
3533
Deleted: fred

docs/source/markdown/podman-network-update.1.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Accepts array of DNS resolvers and removes them from the existing list of resolv
2323

2424
## EXAMPLE
2525

26-
Update a network
26+
Update a network:
2727
```
2828
$ podman network update network1 --dns-add 8.8.8.8,1.1.1.1
2929
```
3030

31-
Update a network and add/remove dns servers
31+
Update a network and add/remove dns servers:
3232
```
3333
$ podman network update network1 --dns-drop 8.8.8.8 --dns-add 3.3.3.3
3434
```

0 commit comments

Comments
 (0)