Skip to content

Commit

Permalink
Unify examples section across several man pages
Browse files Browse the repository at this point in the history
This commit adjusts example sections across several man pages
to the format seen in other pages.

Signed-off-by: Patrycja Guzik <[email protected]>
  • Loading branch information
patrycja-guzik committed Mar 28, 2022
1 parent 9cfa969 commit a8e6c63
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 5 deletions.
10 changes: 9 additions & 1 deletion docs/source/markdown/podman-image-unmount.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,19 @@ as the mount point could be removed without their knowledge.

## EXAMPLE

Unmount image with a given ID
```
podman image unmount imageID
```

Unmount multiple images wit given IDs
```
podman image unmount imageID1 imageID2 imageID3
```

Unmount all images
```
podman image unmount --all

```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-image-mount(1)](podman-image-mount.1.md)**, **[podman-container-mount(1)](podman-container-mount.1.md)**
5 changes: 4 additions & 1 deletion docs/source/markdown/podman-network-prune.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,14 @@ Do not prompt for confirmation

## EXAMPLE
Prune networks

```
podman network prune
```

Prune all networks created before 2h
```
podman network prune --filter until=2h
```

## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-network(1)](podman-network.1.md)**, **[podman-network-rm(1)](podman-network-rm.1.md)**
Expand Down
6 changes: 6 additions & 0 deletions docs/source/markdown/podman-pod-pause.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,15 @@ Instead of providing the pod name or ID, pause the last created pod. (This optio

## EXAMPLE

Pause a pod with a given name
```
podman pod pause mywebserverpod
```

Pause a pod with a given ID
```
podman pod pause 860a4b23
```

## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-pod(1)](podman-pod.1.md)**, **[podman-pod-unpause(1)](podman-pod-unpause.1.md)**, **[podman-pause(1)](podman-pause.1.md)**
Expand Down
9 changes: 9 additions & 0 deletions docs/source/markdown/podman-unmount.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,20 @@ started container could be from either of those methods. (This option is not ava

## EXAMPLE

Unmount container with a given ID
```
podman container unmount containerID
```

Unmount multiple containers with given IDs
```
podman unmount containerID1 containerID2 containerID3
```

Unmount all containers
```
podman unmount --all
```

## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-container-mount(1)](podman-container-mount.1.md)**, **[podman-image-mount(1)](podman-image-mount.1.md)**
1 change: 0 additions & 1 deletion docs/source/markdown/podman-unpause.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ podman unpause mywebserver
```

Unpause a container by a partial container ID.

```
podman unpause 860a4b23
```
Expand Down
2 changes: 1 addition & 1 deletion docs/source/markdown/podman-volume-ls.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Volumes can be filtered by the following attributes:
| name | [Name] Volume name (accepts regex) |
| opt | Matches a storage driver options |
| scope | Filters volume by scope |
| until | Only remove volumes created before given timestamp |
| until | Only remove volumes created before given timestamp |

#### **--format**=*format*

Expand Down
7 changes: 6 additions & 1 deletion docs/source/markdown/podman-volume-unmount.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,14 @@ counter reaches zero indicating no other processes are using the mount.

## EXAMPLE

Unmount volume with a given ID
```
podman volume unmount volumeID
```

Unmount multiple volumes with given IDs
```
podman volume unmount volumeID1 volumeID2 volumeID3

```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-volume(1)](podman-volume.1.md)**, **[podman-volume-mount(1)](podman-volume-mount.1.md)**

0 comments on commit a8e6c63

Please sign in to comment.