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
1.6 KiB
% toolbox-enter(1)
NAME
toolbox-enter - Enter a toolbox container for interactive use
SYNOPSIS
toolbox enter [--distro DISTRO | -d DISTRO] [--release RELEASE | -r RELEASE] [CONTAINER]
DESCRIPTION
Spawns an interactive shell inside a toolbox container that was created using
the toolbox create command. It tries to spawn the user's default shell, but
if it's not available inside the container then it falls back to /bin/bash.
When invoked without any options, toolbox enter will try to enter the default
toolbox container for the host, or if there's only one container available then
it will use it. If there aren't any containers, toolbox enter will offer to
create one for you.
A specific container can be selected using the CONTAINER argument.
A toolbox container is an OCI container. Therefore, toolbox enter is
analogous to a podman start followed by a podman exec.
OPTIONS
The following options are understood:
--distro DISTRO, -d DISTRO
Enter a toolbox container for a different operating system DISTRO than the host.
--release RELEASE, -r RELEASE
Enter a toolbox container for a different operating system RELEASE than the host.
EXAMPLES
Enter a toolbox container using the default image matching the host OS
$ toolbox enter
Enter a toolbox container using the default image for Fedora 30
$ toolbox enter --distro fedora --release f30
Enter a custom toolbox container using a custom image
$ toolbox enter foo
SEE ALSO
toolbox(1), toolbox-run(1), podman(1), podman-exec(1),
podman-start(1)