doc/toolbox-run: Skip implementation bits, keep user-visible behaviour

This reverts parts of commit ea452d7ced.

https://github.com/containers/toolbox/pull/814
This commit is contained in:
Debarshi Ray 2021-06-26 03:34:41 +02:00
parent 42e17cead2
commit 4391b5846c

View file

@ -13,13 +13,9 @@ toolbox\-run - Run a command in an existing toolbox container
Runs a command inside an existing toolbox container. The container should have Runs a command inside an existing toolbox container. The container should have
been created using the `toolbox create` command. been created using the `toolbox create` command.
`toolbox run` wraps around `podman exec` and by default passes several options On Fedora, the default container is known as `fedora-toolbox-N`, where N is
to it. It allocates a tty, connects to stdin, runs the passed command as the the release of the host. A specific container can be selected using the
current user in the current directory and shares common environmental `--container` option.
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 A toolbox container is an OCI container. Therefore, `toolbox run` is analogous
to a `podman start` followed by a `podman exec`. to a `podman start` followed by a `podman exec`.
@ -66,5 +62,4 @@ $ toolbox run --container foo uptime
## SEE ALSO ## SEE ALSO
`toolbox(1)`, `podman(1)`, `podman-exec(1)`, `podman-start(1)`, `capsh(1)`, `toolbox(1)`, `podman(1)`, `podman-exec(1)`, `podman-start(1)`
`sh(1)`