toolbox/doc/toolbox-rm.1.md
Debarshi Ray 936a157117 doc, test/system: Fix the titles of the manuals
Currently, the titles of the manuals are rendered with a pair of empty
parentheses and no section title:
  toolbox(1)()                                              toolbox(1)()

  NAME
         toolbox - Tool for containerized command line environments...

However, they should be:
  toolbox(1)             General Commands Manual              toolbox(1)

  NAME
         toolbox - Tool for containerized command line environments...

This is because the troff generated by go-md2man from Markdown has a
faulty invocation of the .TH macro [1]:
  .nh
  .TH toolbox(1)
  .SH NAME
  .PP
  toolbox - Tool for containerized command line environments on Linux

It should be:
  .nh
  .TH toolbox 1
  .SH NAME
  .PP
  toolbox - Tool for containerized command line environments on Linux

Original patch from Andrew Denton for Podman [2].

[1] https://www.gnu.org/software/groff/manual/groff.html

[2] Podman commit 63c779a857b55b00
    https://github.com/containers/podman/pull/15621

https://github.com/containers/toolbox/pull/1210
2023-01-12 18:45:00 +01:00

52 lines
1 KiB
Markdown

% toolbox-rm 1
## NAME
toolbox\-rm - Remove one or more toolbox containers
## SYNOPSIS
**toolbox rm** [*--all* | *-a*] [*--force* | *-f*] [*CONTAINER*...]
## DESCRIPTION
Removes one or more toolbox containers from the host. The container should
have been created using the `toolbox create` command.
A toolbox container is an OCI container. Therefore, `toolbox rm` can be used
interchangeably with `podman rm`.
## OPTIONS ##
The following options are understood:
**--all, -a**
Remove all toolbox containers. It can be used in conjunction with `--force` as
well.
**--force, -f**
Force the removal of running and paused toolbox containers.
## EXAMPLES
### Remove a toolbox container named `fedora-toolbox-gegl:36`
```
$ toolbox rm fedora-toolbox-gegl:36
```
### Remove all toolbox containers, but not those that are running or paused
```
$ toolbox rm --all
```
### Remove all toolbox containers, including ones that are running or paused
```
$ toolbox rm --all --force
```
## SEE ALSO
`toolbox(1)`, `podman(1)`, `podman-rm(1)`