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.9 KiB
% toolbox-run(1)
NAME
toolbox-run - Run a command in an existing toolbox container
SYNOPSIS
toolbox run [--container NAME | -c NAME] [--distro DISTRO | -d DISTRO] [--release RELEASE | -r RELEASE] [COMMAND]
DESCRIPTION
Runs a command inside an existing toolbox container. The container should have
been created using the toolbox create command.
toolbox run wraps around podman exec and by default passes several options
to it. It allocates a tty, connects to stdin, runs the passed command as the
current user in the current directory and shares common environmental
variables.
The executed command is wrapped in capsh that gets rid of all extra
capabilities that could negatively affect the experience.
A toolbox container is an OCI container. Therefore, toolbox run is analogous
to a podman start followed by a podman exec.
OPTIONS
The following options are understood:
--container NAME, -c NAME
Run command inside a toolbox container with the given NAME. This is useful when there are multiple toolbox containers created from the same base image, or entirely customized containers created from custom-built base images.
--distro DISTRO, -d DISTRO
Run command inside a toolbox container for a different operating system DISTRO than the host.
--release RELEASE, -r RELEASE
Run command inside a toolbox container for a different operating system RELEASE than the host.
EXAMPLES
Run ls inside a toolbox container using the default image matching the host OS
$ toolbox run ls -la
Run emacs inside a toolbox container using the default image for Fedora 30
$ toolbox run --distro fedora --release f30 emacs
Run uptime inside a custom toolbox container using a custom image
$ toolbox run --container foo uptime
SEE ALSO
toolbox(1), podman(1), podman-exec(1), podman-start(1), capsh(1),
sh(1)