doc/toolbox: Add section about supported distribution images

Having a list of supported distributions in the manual has been long
overdue. Complementing it with the expected formats should make lives
of users a bit easier.

https://github.com/containers/toolbox/pull/977
https://github.com/containers/toolbox/pull/986
This commit is contained in:
Ondřej Míchal 2021-12-17 16:25:34 +02:00 committed by Debarshi Ray
parent ffd365342e
commit 8ae0f9c5c6

View file

@ -40,6 +40,26 @@ 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..
## 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
## GLOBAL OPTIONS ##
The following options are understood: