From 822a07003b21f3050e53a19a44d6149a1736a9fe Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Fri, 5 Aug 2022 13:01:03 +0530 Subject: [PATCH] toolbox: add pages (#8280) --- pages/linux/toolbox-create.md | 24 ++++++++++++++++++++++++ pages/linux/toolbox-enter.md | 17 +++++++++++++++++ pages/linux/toolbox-help.md | 12 ++++++++++++ pages/linux/toolbox-init-container.md | 9 +++++++++ pages/linux/toolbox-list.md | 16 ++++++++++++++++ pages/linux/toolbox-rm.md | 17 +++++++++++++++++ pages/linux/toolbox-rmi.md | 17 +++++++++++++++++ pages/linux/toolbox-run.md | 17 +++++++++++++++++ pages/linux/toolbox.md | 21 +++++++++++++++++++++ 9 files changed, 150 insertions(+) create mode 100644 pages/linux/toolbox-create.md create mode 100644 pages/linux/toolbox-enter.md create mode 100644 pages/linux/toolbox-help.md create mode 100644 pages/linux/toolbox-init-container.md create mode 100644 pages/linux/toolbox-list.md create mode 100644 pages/linux/toolbox-rm.md create mode 100644 pages/linux/toolbox-rmi.md create mode 100644 pages/linux/toolbox-run.md create mode 100644 pages/linux/toolbox.md diff --git a/pages/linux/toolbox-create.md b/pages/linux/toolbox-create.md new file mode 100644 index 000000000..14b7a7cc0 --- /dev/null +++ b/pages/linux/toolbox-create.md @@ -0,0 +1,24 @@ +# toolbox create + +> Create a new `toolbox` container. +> More information: . + +- Create a `toolbox` container for a specific distribution: + +`toolbox create --distro {{distribution}}` + +- Create a `toolbox` container for a specific release of the current distribution: + +`toolbox create --release {{release}}` + +- Create a `toolbox` container with a custom image: + +`toolbox create --image {{name}}` + +- Create a `toolbox` container from a custom Fedora image: + +`toolbox create --image {{registry.fedoraproject.org/fedora-toolbox:36}}` + +- Create a `toolbox` container using the default image for Fedora 36: + +`toolbox create --distro {{fedora}} --release {{f36}}` diff --git a/pages/linux/toolbox-enter.md b/pages/linux/toolbox-enter.md new file mode 100644 index 000000000..c99a0b0e8 --- /dev/null +++ b/pages/linux/toolbox-enter.md @@ -0,0 +1,17 @@ +# toolbox enter + +> Enter a `toolbox` container for interactive use. +> See also: `toolbox run`. +> More information: . + +- Enter a `toolbox` container using the default image of a specific distribution: + +`toolbox enter --distro {{distribution}}` + +- Enter a `toolbox` container using the default image of a specific release of the current distribution: + +`toolbox enter --release {{release}}` + +- Enter a toolbox container using the default image for Fedora 36: + +`toolbox enter --distro {{fedora}} --release {{f36}}` diff --git a/pages/linux/toolbox-help.md b/pages/linux/toolbox-help.md new file mode 100644 index 000000000..c09b99341 --- /dev/null +++ b/pages/linux/toolbox-help.md @@ -0,0 +1,12 @@ +# toolbox help + +> Displays help information about `toolbox`. +> More information: . + +- Display the `toolbox` manual: + +`toolbox help` + +- Display the `toolbox` manual for a specific subcommand: + +`toolbox help {{subcommand}}` diff --git a/pages/linux/toolbox-init-container.md b/pages/linux/toolbox-init-container.md new file mode 100644 index 000000000..5075258da --- /dev/null +++ b/pages/linux/toolbox-init-container.md @@ -0,0 +1,9 @@ +# toolbox init-container + +> Initialize a running `toolbox` container. +> This command is should not be executed by the user, and cannot be run on the host. +> More information: . + +- Initialize a running toolbox: + +`toolbox init-container --gid {{gid}} --home {{home}} --home-link --media-link --mnt-link --monitor-host --shell {{shell}} --uid {{uid}} --user {{user}}` diff --git a/pages/linux/toolbox-list.md b/pages/linux/toolbox-list.md new file mode 100644 index 000000000..d166c7572 --- /dev/null +++ b/pages/linux/toolbox-list.md @@ -0,0 +1,16 @@ +# toolbox list + +> List existing `toolbox` containers and images. +> More information: . + +- List all `toolbox` containers and images: + +`toolbox list` + +- List only `toolbox` containers: + +`toolbox list --containers` + +- List only `toolbox` images: + +`toolbox list --images` diff --git a/pages/linux/toolbox-rm.md b/pages/linux/toolbox-rm.md new file mode 100644 index 000000000..929f836a3 --- /dev/null +++ b/pages/linux/toolbox-rm.md @@ -0,0 +1,17 @@ +# toolbox rm + +> Remove one or more `toolbox` containers. +> See also: `toolbox rmi`. +> More information: . + +- Remove a toolbox container: + +`toolbox rm {{container_name}}` + +- Remove all `toolbox` containers: + +`toolbox rm --all` + +- Force the removal of a currently active `toolbox` container: + +`toolbox rm --force {{container_name}}` diff --git a/pages/linux/toolbox-rmi.md b/pages/linux/toolbox-rmi.md new file mode 100644 index 000000000..ac18db3ac --- /dev/null +++ b/pages/linux/toolbox-rmi.md @@ -0,0 +1,17 @@ +# toolbox rmi + +> Remove one or more `toolbox` images. +> See also: `toolbox rm`. +> More information: . + +- Remove a `toolbox` image: + +`toolbox rmi {{image_name}}` + +- Remove all `toolbox` images: + +`toolbox rmi --all` + +- Force the removal of a `toolbox` image which is currently being used by a container (the container will be removed as well): + +`toolbox rmi --force {{image_name}}` diff --git a/pages/linux/toolbox-run.md b/pages/linux/toolbox-run.md new file mode 100644 index 000000000..fd8352d35 --- /dev/null +++ b/pages/linux/toolbox-run.md @@ -0,0 +1,17 @@ +# toolbox run + +> Run a command in an existing `toolbox` container. +> See also: `toolbox enter`. +> More information: . + +- Run a command inside a specific `toolbox` container: + +`toolbox run --container {{container_name}} {{command}}` + +- Run a command inside a `toolbox` container for a specific release of a distribution: + +`toolbox run --distro {{distribution}} --release {{release}} {{command}}` + +- Run `emacs` inside a `toolbox` container using the default image for Fedora 36: + +`toolbox run --distro {{fedora}} --release {{f36}} {{emacs}}` diff --git a/pages/linux/toolbox.md b/pages/linux/toolbox.md new file mode 100644 index 000000000..a82e7621b --- /dev/null +++ b/pages/linux/toolbox.md @@ -0,0 +1,21 @@ +# toolbox + +> Tool for containerized command line environments on Linux. +> Some subcommands such as `toolbox create` have their own usage documentation. +> More information: . + +- Show the `toolbox` version: + +`toolbox --version` + +- Show general help: + +`toolbox --help` + +- Show help for a `toolbox` subcommand (such as `create`, `enter`, `rm`, `rmi`, etc.): + +`toolbox help {{subcommand}}` + +- Run a `toolbox` subcommand: + +`toolbox {{subcommand}}`