2018-03-20 17:41:19 +08:00
# buildah-rm "1" "March 2017" "buildah"
2017-03-29 03:37:24 +08:00
## NAME
2018-04-26 21:01:15 +08:00
buildah\-rm - Removes one or more working containers.
2017-03-29 03:37:24 +08:00
## SYNOPSIS
2018-09-30 01:21:22 +08:00
**buildah rm** [*container* ...]
2017-03-29 03:37:24 +08:00
## DESCRIPTION
2017-04-14 03:42:04 +08:00
Removes one or more working containers, unmounting them if necessary.
2017-03-29 03:37:24 +08:00
2018-01-05 07:09:34 +08:00
## OPTIONS
New CI check: xref --help vs man pages
Run 'buildah --help', recursively against all subcommands,
then cross-reference the results against docs/buildah*.md.
Report differences in subcommands and/or flags.
The majority of the changes in this PR are trivial (see
below) but a handful may be controversial and require
careful review:
* Making 'bud' the default output of 'buildah help',
with 'build-using-dockerfile' as an alias. This is
the inverse of the situation until now: buildah
would list build-using-dockerfile as the primary
name. The man page, OTOH, lists 'bud'. The source
file name is 'bud'. I suspect that most people
type 'bud'. So, for consistency, I choose to make
'bud' the default visible command.
* add --encryption-key and --encrypt-layer documentation
to buildah-commit.md, and --encrypt-layer to -push.md.
Please double-check the wording here.
* remove --notruncate from buildah-images.md. The option
does not exist (although there is a TODO comment in
the code). If it should exist, it is left to the
reader to implement. I would humbly suggest that this
is a good idea, for consistency with buildah containers.
* remove --shm-size from buildah-pull.md. The option
does not exist, and I suspect this was a copy-paste error.
* remove --security-opt from run.go. It was unimplemented
and undocumented.
* remove --userns-[gu]id-map from buildah-bud.md. These
are global options, not bud options, and are documented
well enough in buildah.bud.
Trivial (IMO) changes:
* split options in man pages, from '**--foo, -f**'
to '**--foo**, **-f**'. This conforms with the style
used in podman man pages.
* add missing one-letter aliases (usually "-q", "-a")
* add missing man page entries for some easy options
* sort out-of-order subcommand listings in man pages
Finally, do note that this is a copy-and-alter duplicate of the
original script in podman, and that is horrible. In an ideal
world I would've been able to refactor the podman version into
something usable on both repos (and then more). It turns out the
differences in man page format and in special-case handling are
too broad to let me do a clean refactor.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-09-21 22:51:19 +08:00
**--all**, ** -a**
2018-01-05 07:09:34 +08:00
2018-09-30 01:21:22 +08:00
All Buildah containers will be removed. Buildah containers are denoted with an '*' in the 'BUILDER' column listed by the command 'buildah containers'.A container name or id cannot be provided when this option is used.
2018-01-05 07:09:34 +08:00
2017-03-29 03:37:24 +08:00
## EXAMPLE
2017-04-14 03:42:04 +08:00
buildah rm containerID
buildah rm containerID1 containerID2 containerID3
2017-03-29 03:37:24 +08:00
2018-01-05 07:09:34 +08:00
buildah rm --all
2017-03-29 03:37:24 +08:00
## SEE ALSO
buildah(1)
