When a specific Toolbx container is selected by name for 'enter' and 'run', it's not necessary that the container was created using a custom image. The container could have also been created using one of the built-in images. Secondly, the phrase 'using a custom image' is awkward because it makes it sound as if the image plays an important role in 'enter' and 'run'. That's not true. Finally, titles are sweeter when they are shorter. https://github.com/containers/toolbox/pull/1281 Signed-off-by: Nils Lindemann <nilslindemann@tutanota.com>
1.8 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. On Fedora, the default container is known as
fedora-toolbox-N
, where N is the release of the host. If there aren't any
containers, toolbox enter
will offer to create the default 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. Has to be coupled with --release
unless the selected DISTRO matches 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 36
$ toolbox enter --distro fedora --release f36
Enter a toolbox container with a custom name
$ toolbox enter foo
SEE ALSO
toolbox(1)
, toolbox-run(1)
, podman(1)
, podman-exec(1)
,
podman-start(1)