From c9a061c7b943563445951d2735083111586cd4ce Mon Sep 17 00:00:00 2001 From: Debarshi Ray Date: Tue, 5 Mar 2019 14:11:12 +0100 Subject: [PATCH] doc/toolbox-enter: Mention the underlying podman commands It's useful to know things like a running toolbox container has to be stopped before removal or 'rm --force' needs to be used, etc.. This is implicitly tied to the fact that entering a toolbox container is equivalent to a 'podman start' followed by a 'podman exec'. --- doc/toolbox-enter.1.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/toolbox-enter.1.md b/doc/toolbox-enter.1.md index e1bad40..53324cf 100644 --- a/doc/toolbox-enter.1.md +++ b/doc/toolbox-enter.1.md @@ -11,10 +11,12 @@ toolbox\-enter - Enter an existing toolbox container for interactive use Spawns an interactive shell inside an existing toolbox container. The container should have been created using the `toolbox create` command. -A toolbox container is an OCI container. On Fedora the toolbox containers are -tagged with the version of the OS that corresponds to the content inside them. -Their names are prefixed with the name of the base image and suffixed with the -current user name. +A toolbox container is an OCI container. Therefore, `toolbox enter` is +analogous to a `podman start` followed by a `podman exec`. + +On Fedora the toolbox containers are tagged with the version of the OS that +corresponds to the content inside them. Their names are prefixed with the name +of the base image and suffixed with the current user name. ## OPTIONS ## @@ -53,4 +55,4 @@ $ toolbox enter --container foo ## SEE ALSO -`buildah(1)`, `podman(1)` +`buildah(1)`, `podman(1)`, `podman-exec(1)`, `podman-start(1)`