ea452d7ced
- 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
829 B
829 B
% toolbox-list(1)
NAME
toolbox-list - List existing toolbox containers and images
SYNOPSIS
toolbox list [--containers | -c] [--images | -i]
DESCRIPTION
Lists existing toolbox containers and images. These are OCI containers and
images, which can be managed directly with tools like buildah and podman.
OPTIONS
The following options are understood:
--containers, -c
List only toolbox containers, not images.
--images, -i
List only toolbox images, not containers.
EXAMPLES
List all existing toolbox containers and images
$ toolbox list
List existing toolbox containers only
$ toolbox list --containers
List existing toolbox images only
$ toolbox list --images
SEE ALSO
toolbox(1), podman(1), podman-ps(1), podman-images(1)