wbrawner/toolbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
toolbox/doc/toolbox-rm.1.md

53 lines
1 KiB
Markdown
Raw Permalink Normal View History

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-11 19:19:44 +00:00
% toolbox-rm 1
Add rm and rmi commands https://github.com/debarshiray/toolbox/pull/45
2019-02-19 15:59:19 +00:00
## NAME
toolbox\-rm - Remove one or more toolbox containers
## SYNOPSIS
doc: Update to match current state & extend docs - Update "See also" sections Toolbox does not use Buildah for a considerable time now[0]. We can stop referencing it in the "See also" sections of the documentation. In some places mention podman command man pages where they are relevant. - Add section about toolbox images/containers Toolbox only supports certain OCI images. These should be documented. Also, document the change of fedora-toolbox image name. - Add a section about toolbox container setup Toolbox containers are specifically configured OCI containers. This should be documented so that users know what they're using. - Remove redundant part documentation The description of what `toolbox init-container` does is already in toolbox-init-container(1). There's no need to have it in toolbox-create(1). Instead, replace the text with a hint to visit the other part of documentation. - Clarify behaviour of --image option The fact that Toolbox by default tries to pull from the Fedora registry[1] should be noted. - Update synopsis & description of commands Mention options passed to `podman exec`. Remove redundant paragraph about container names (is already dealt with in toolbox-create(1)). There's no need to mention the name of the default container on Fedora since Toolbox now also supports RHEL. Mention the default used image on unrecognised systems. Emphasize the fact that toolboxes are not a fully sandboxed environment. Update the wording of the description and splits it into a few subsections. The description of the --monitor-host was inaccurate and while the option will go away in the future[2], it is currently in and should be more documented. [0] https://github.com/containers/toolbox/pull/160 [1] https://registry.fedoraproject.org [2] https://github.com/containers/toolbox/pull/617 https://github.com/containers/toolbox/pull/512
2021-03-04 19:36:22 +00:00
**toolbox rm** [*--all* | *-a*] [*--force* | *-f*] [*CONTAINER*...]
Add rm and rmi commands https://github.com/debarshiray/toolbox/pull/45
2019-02-19 15:59:19 +00:00
## 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**
Fix spelling mistakes using codespell https://github.com/containers/toolbox/pull/1166 https://github.com/containers/toolbox/pull/1149 Signed-off-by: Nieves Montero <nmontero@redhat.com>
2022-10-24 11:22:30 +00:00
Remove all toolbox containers. It can be used in conjunction with `--force` as
Add rm and rmi commands https://github.com/debarshiray/toolbox/pull/45
2019-02-19 15:59:19 +00:00
well.
**--force, -f**
Force the removal of running and paused toolbox containers.
## EXAMPLES
doc: Refer to a newer Fedora release in the examples Fedora 30 reached End of Life on 26th May 2020: https://docs.fedoraproject.org/en-US/releases/eol/ https://github.com/containers/toolbox/pull/953
2021-12-10 02:02:54 +00:00
### Remove a toolbox container named `fedora-toolbox-gegl:36`
Add rm and rmi commands https://github.com/debarshiray/toolbox/pull/45
2019-02-19 15:59:19 +00:00
```
doc: Refer to a newer Fedora release in the examples Fedora 30 reached End of Life on 26th May 2020: https://docs.fedoraproject.org/en-US/releases/eol/ https://github.com/containers/toolbox/pull/953
2021-12-10 02:02:54 +00:00
$ toolbox rm fedora-toolbox-gegl:36
Add rm and rmi commands https://github.com/debarshiray/toolbox/pull/45
2019-02-19 15:59:19 +00:00
```
### 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
doc: Update to match current state & extend docs - Update "See also" sections Toolbox does not use Buildah for a considerable time now[0]. We can stop referencing it in the "See also" sections of the documentation. In some places mention podman command man pages where they are relevant. - Add section about toolbox images/containers Toolbox only supports certain OCI images. These should be documented. Also, document the change of fedora-toolbox image name. - Add a section about toolbox container setup Toolbox containers are specifically configured OCI containers. This should be documented so that users know what they're using. - Remove redundant part documentation The description of what `toolbox init-container` does is already in toolbox-init-container(1). There's no need to have it in toolbox-create(1). Instead, replace the text with a hint to visit the other part of documentation. - Clarify behaviour of --image option The fact that Toolbox by default tries to pull from the Fedora registry[1] should be noted. - Update synopsis & description of commands Mention options passed to `podman exec`. Remove redundant paragraph about container names (is already dealt with in toolbox-create(1)). There's no need to mention the name of the default container on Fedora since Toolbox now also supports RHEL. Mention the default used image on unrecognised systems. Emphasize the fact that toolboxes are not a fully sandboxed environment. Update the wording of the description and splits it into a few subsections. The description of the --monitor-host was inaccurate and while the option will go away in the future[2], it is currently in and should be more documented. [0] https://github.com/containers/toolbox/pull/160 [1] https://registry.fedoraproject.org [2] https://github.com/containers/toolbox/pull/617 https://github.com/containers/toolbox/pull/512
2021-03-04 19:36:22 +00:00
`toolbox(1)`, `podman(1)`, `podman-rm(1)`
Reference in a new issue Copy permalink