Files
podman/docs/source/markdown/podman-volume-rm.1.md
Paul Holzinger bc48211924 Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash.
I tested that this change is safe and still renders correctly on github
and with the man pages.

This commit also contains a small change to make it build locally.
Assuming you have the dependencies installed you can do:
```
cd docs
make html
```
Preview the html files in docs/build/html with
`python -m http.server 8000 --directory build/html`.

Fixes containers/podman.io#373

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
2021-03-29 14:38:25 +02:00

56 lines
1.2 KiB
Markdown

% podman-volume-rm(1)
## NAME
podman\-volume\-rm - Remove one or more volumes
## SYNOPSIS
**podman volume rm** [*options*] *volume* [...]
## DESCRIPTION
Removes one or more volumes. Only volumes that are not being used will be removed.
If a volume is being used by a container, an error will be returned unless the **\-\-force**
flag is being used. To remove all volumes, use the **\-\-all** flag.
Volumes can be removed individually by providing their full name or a unique partial name.
## OPTIONS
#### **\-\-all**, **-a**
Remove all volumes.
#### **\-\-force**, **-f**
Remove a volume by force.
If it is being used by containers, the containers will be removed first.
#### **\-\-help**
Print usage statement
## EXAMPLES
```
$ podman volume rm myvol1 myvol2
$ podman volume rm --all
$ podman volume rm --force myvol
```
## Exit Status
**0** All specified volumes removed
**1** One of the specified volumes did not exist, and no other failures
**2** One of the specified volumes is being used by a container
**125** The command fails for any other reason
## SEE ALSO
podman-volume(1)
## HISTORY
November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>