From 8ae0f9c5c677a45f9de55b612165cd730aeebcd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20M=C3=ADchal?= Date: Fri, 17 Dec 2021 16:25:34 +0200 Subject: [PATCH] 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 --- doc/toolbox.1.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/toolbox.1.md b/doc/toolbox.1.md index 1f08a04..c714751 100644 --- a/doc/toolbox.1.md +++ b/doc/toolbox.1.md @@ -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 |\ or f\ eg., 35 or f35 +rhel |\.\ eg., 8.5 + ## GLOBAL OPTIONS ## The following options are understood: