toolbox: add pages (#8280)

pull/1/head
K.B.Dharun Krishna 2022-08-05 13:01:03 +05:30 committed by GitHub
parent aefb4ec4e3
commit 822a07003b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 150 additions and 0 deletions

View File

@ -0,0 +1,24 @@
# toolbox create
> Create a new `toolbox` container.
> More information: <https://manned.org/toolbox-create.1>.
- 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}}`

View File

@ -0,0 +1,17 @@
# toolbox enter
> Enter a `toolbox` container for interactive use.
> See also: `toolbox run`.
> More information: <https://manned.org/toolbox-enter.1>.
- 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}}`

View File

@ -0,0 +1,12 @@
# toolbox help
> Displays help information about `toolbox`.
> More information: <https://manned.org/toolbox-help.1>.
- Display the `toolbox` manual:
`toolbox help`
- Display the `toolbox` manual for a specific subcommand:
`toolbox help {{subcommand}}`

View File

@ -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: <https://manned.org/toolbox-init-container.1>.
- 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}}`

View File

@ -0,0 +1,16 @@
# toolbox list
> List existing `toolbox` containers and images.
> More information: <https://manned.org/toolbox-list.1>.
- List all `toolbox` containers and images:
`toolbox list`
- List only `toolbox` containers:
`toolbox list --containers`
- List only `toolbox` images:
`toolbox list --images`

17
pages/linux/toolbox-rm.md Normal file
View File

@ -0,0 +1,17 @@
# toolbox rm
> Remove one or more `toolbox` containers.
> See also: `toolbox rmi`.
> More information: <https://manned.org/toolbox-rm.1>.
- 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}}`

View File

@ -0,0 +1,17 @@
# toolbox rmi
> Remove one or more `toolbox` images.
> See also: `toolbox rm`.
> More information: <https://manned.org/toolbox-rmi.1>.
- 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}}`

View File

@ -0,0 +1,17 @@
# toolbox run
> Run a command in an existing `toolbox` container.
> See also: `toolbox enter`.
> More information: <https://manned.org/toolbox-run>.
- 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}}`

21
pages/linux/toolbox.md Normal file
View File

@ -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: <https://manned.org/toolbox.1>.
- 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}}`