2019-02-28 17:07:24 +00:00
|
|
|
% toolbox(1)
|
|
|
|
|
|
|
|
|
|
## NAME
|
2021-06-25 23:54:24 +00:00
|
|
|
toolbox - Tool for containerized command line environments on Linux
|
2019-02-28 17:07:24 +00:00
|
|
|
|
|
|
|
|
## SYNOPSIS
|
2021-03-04 19:36:22 +00:00
|
|
|
**toolbox** [*--assumeyes* | *-y*]
|
|
|
|
|
[*--help* | *-h*]
|
|
|
|
|
[*--log-level LEVEL*]
|
|
|
|
|
[*--log-podman*]
|
doc/toolbox: Restore --verbose
It's good to document the --log-level and --log-podman flags because
they can give us some flexibility with the logging in future, but it's
still desirable to keep --verbose (and the -vv trick) in the manual.
Toolbox is still a small enough code base that not too many log levels
are actually needed, yet. The complexity of remembering which log
level reveals which detail soon starts to outweigh the simplicity of
dumping as much as possible, since there aren't that many log messages
to begin with. It's a lot easier to type and remember things like
--verbose, -v and -vv, than their newer counterparts, and they are a
reasonably widely used convention (eg., flatpak, nmap, ssh, etc.).
If some day Toolbox grows to have a significantly larger number of log
messages, then it's possible that --verbose would be of less use, but
that's not the case today.
https://github.com/containers/toolbox/pull/814
2021-06-26 00:27:41 +00:00
|
|
|
[*--verbose* | *-v*]
|
2021-03-04 19:36:22 +00:00
|
|
|
*COMMAND* [*ARGS*...]
|
2019-02-28 17:07:24 +00:00
|
|
|
|
|
|
|
|
## DESCRIPTION
|
|
|
|
|
|
2021-01-25 21:35:46 +00:00
|
|
|
Toolbox is a tool for Linux operating systems, which allows the use of
|
|
|
|
|
containerized command line environments. It is built on top of Podman and
|
|
|
|
|
other standard container technologies from OCI.
|
|
|
|
|
|
|
|
|
|
This is particularly useful on OSTree based operating systems like Fedora
|
|
|
|
|
CoreOS and Silverblue. The intention of these systems is to discourage
|
|
|
|
|
installation of software on the host, and instead install software as (or in)
|
|
|
|
|
containers — they mostly don't even have package managers like DNF or YUM.
|
|
|
|
|
This makes it difficult to set up a development environment or install tools
|
|
|
|
|
for debugging in the usual way.
|
|
|
|
|
|
|
|
|
|
Toolbox solves this problem by providing a fully mutable container within
|
|
|
|
|
which one can install their favourite development and debugging tools, editors
|
|
|
|
|
and SDKs. For example, it's possible to do `yum install ansible` without
|
|
|
|
|
affecting the base operating system.
|
|
|
|
|
|
|
|
|
|
However, this tool doesn't *require* using an OSTree based system. It works
|
|
|
|
|
equally well on Fedora Workstation and Server, and that's a useful way to
|
|
|
|
|
incrementally adopt containerization.
|
2019-02-28 17:07:24 +00:00
|
|
|
|
|
|
|
|
The toolbox environment is based on an OCI image. On Fedora this is the
|
2021-01-25 21:35:46 +00:00
|
|
|
`fedora-toolbox` image. This image is used to create a toolbox container that
|
|
|
|
|
seamlessly integrates with the rest of the operating system by providing
|
2021-06-26 09:07:24 +00:00
|
|
|
access to the user's home directory, the Wayland and X11 sockets, networking
|
|
|
|
|
(including Avahi), removable devices (like USB sticks), systemd journal, SSH
|
|
|
|
|
agent, D-Bus, ulimits, /dev and the udev database, etc..
|
2019-02-28 17:07:24 +00:00
|
|
|
|
2021-12-17 14:25:34 +00:00
|
|
|
## Supported operating system distributions
|
|
|
|
|
|
|
|
|
|
By default, Toolbox tries to use an image matching the host operating system
|
|
|
|
|
distribution for creating containers. If the host is not supported, then it
|
|
|
|
|
falls back to a Fedora image. Supported host operating systems are:
|
|
|
|
|
|
|
|
|
|
* Fedora
|
|
|
|
|
* Red Hat Enterprise Linux >= 8.5
|
|
|
|
|
|
|
|
|
|
However, it's possible to create containers for a different distribution
|
|
|
|
|
through the use of the `--distro` and `--release` options that are accepted by
|
|
|
|
|
the relevant commands, or their counterparts in the configuration file. The
|
|
|
|
|
`--distro` flag specifies the name of the distribution, and `--release`
|
|
|
|
|
specifies its version. Supported combinations are:
|
|
|
|
|
|
|
|
|
|
Distro |Release
|
|
|
|
|
-------|----------
|
|
|
|
|
fedora |\<release\> or f\<release\> eg., 35 or f35
|
|
|
|
|
rhel |\<major\>.\<minor\> eg., 8.5
|
|
|
|
|
|
2021-03-04 19:36:22 +00:00
|
|
|
## GLOBAL OPTIONS ##
|
2019-02-28 17:07:24 +00:00
|
|
|
|
|
|
|
|
The following options are understood:
|
|
|
|
|
|
2019-04-26 16:28:11 +00:00
|
|
|
**--assumeyes, -y**
|
|
|
|
|
|
|
|
|
|
Automatically answer yes for all questions.
|
|
|
|
|
|
2019-02-28 17:07:24 +00:00
|
|
|
**--help, -h**
|
|
|
|
|
|
|
|
|
|
Print a synopsis of this manual and exit.
|
|
|
|
|
|
2021-03-04 19:36:22 +00:00
|
|
|
**--log-level**=*level*
|
2019-02-28 17:07:24 +00:00
|
|
|
|
2021-03-04 19:36:22 +00:00
|
|
|
Log messages above specified level: debug, info, warn, error, fatal or panic
|
|
|
|
|
(default: error)
|
|
|
|
|
|
|
|
|
|
**--log-podman**
|
|
|
|
|
|
|
|
|
|
Show log messages of invocations of Podman based on the logging level specified
|
|
|
|
|
by option **log-level**.
|
2019-02-28 17:07:24 +00:00
|
|
|
|
doc/toolbox: Restore --verbose
It's good to document the --log-level and --log-podman flags because
they can give us some flexibility with the logging in future, but it's
still desirable to keep --verbose (and the -vv trick) in the manual.
Toolbox is still a small enough code base that not too many log levels
are actually needed, yet. The complexity of remembering which log
level reveals which detail soon starts to outweigh the simplicity of
dumping as much as possible, since there aren't that many log messages
to begin with. It's a lot easier to type and remember things like
--verbose, -v and -vv, than their newer counterparts, and they are a
reasonably widely used convention (eg., flatpak, nmap, ssh, etc.).
If some day Toolbox grows to have a significantly larger number of log
messages, then it's possible that --verbose would be of less use, but
that's not the case today.
https://github.com/containers/toolbox/pull/814
2021-06-26 00:27:41 +00:00
|
|
|
**--verbose, -v**
|
|
|
|
|
|
|
|
|
|
Same as `--log-level=debug`. Use `-vv` to include `--log-podman`.
|
|
|
|
|
|
2019-02-28 17:07:24 +00:00
|
|
|
## COMMANDS
|
|
|
|
|
|
|
|
|
|
Commands for working with toolbox containers and images:
|
|
|
|
|
|
|
|
|
|
**toolbox-create(1)**
|
|
|
|
|
|
|
|
|
|
Create a new toolbox container.
|
|
|
|
|
|
|
|
|
|
**toolbox-enter(1)**
|
|
|
|
|
|
2019-05-16 12:40:17 +00:00
|
|
|
Enter a toolbox container for interactive use.
|
2019-02-28 17:07:24 +00:00
|
|
|
|
2019-07-15 08:23:25 +00:00
|
|
|
**toolbox-help(1)**
|
|
|
|
|
|
|
|
|
|
Display help information about Toolbox.
|
|
|
|
|
|
2019-05-10 18:38:46 +00:00
|
|
|
**toolbox-init-container(1)**
|
|
|
|
|
|
|
|
|
|
Initialize a running container.
|
|
|
|
|
|
2019-02-28 17:07:24 +00:00
|
|
|
**toolbox-list(1)**
|
|
|
|
|
|
|
|
|
|
List existing toolbox containers and images.
|
|
|
|
|
|
2019-02-19 15:59:19 +00:00
|
|
|
**toolbox-rm(1)**
|
|
|
|
|
|
|
|
|
|
Remove one or more toolbox containers.
|
|
|
|
|
|
|
|
|
|
**toolbox-rmi(1)**
|
|
|
|
|
|
|
|
|
|
Remove one or more toolbox images.
|
|
|
|
|
|
2019-05-16 12:40:17 +00:00
|
|
|
**toolbox-run(1)**
|
|
|
|
|
|
|
|
|
|
Run a command in an existing toolbox container.
|
|
|
|
|
|
2021-12-17 01:24:53 +00:00
|
|
|
## FILES ##
|
|
|
|
|
|
|
|
|
|
**toolbox.conf(5)**
|
|
|
|
|
|
|
|
|
|
Toolbox configuration file.
|
|
|
|
|
|
2019-02-28 17:07:24 +00:00
|
|
|
## SEE ALSO
|
|
|
|
|
|
2021-06-26 00:39:52 +00:00
|
|
|
`podman(1)`, https://github.com/containers/toolbox
|
