Files
podman/docs/source/markdown/podman-volume-rm.1.md
Ed Santiago b0601cb34a [CI:DOCS] Restore man page cross-checker
Somewhere in the CIv2 migration we lost the man page vs --help
cross-checker. Add it back, by adding it into the man-page-check
Makefile target; this is part of 'make validate', which is run
in CI even on CI:DOCS PRs.

As happens when CI doesn't run, things broke. Man pages got out
of sync with --help. This PR:

 1) Fixes hack/xref-helpmsgs-manpages to deal with the new
    "Options" (instead of "Flags") form of podman help. #8034
    did part of that, but one of my review comments was
    accidentally left out.

 2) Fixes hack/xref-helpmsgs-manpages to deal with the new
    option syntax in man pages, post- #8292, in which each
    option is preceded by four hashes so as to make them
    HTML <h4> elements with named anchors.

 3) Fixes man pages that #8292 accidentally missed.

 4) Adds man page entries for two flags that got added
    to podman but not documented (pod create --network-alias,
    play kube --log-driver)

Fixes: #8296

Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-11-11 08:31:30 -07:00

1.2 KiB

% 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

-a, --all

Remove all volumes.

-f, --force

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