Skip to content

Commit fccebb3

Browse files
committed
doc: 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. containers#977
1 parent 7c891cb commit fccebb3

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/toolbox.1.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,20 @@ access to the user's home directory, the Wayland and X11 sockets, networking
4040
(including Avahi), removable devices (like USB sticks), systemd journal, SSH
4141
agent, D-Bus, ulimits, /dev and the udev database, etc..
4242

43+
## Supported distribution images
44+
45+
Toolbox maintains a list of supported distribution images. These images are
46+
maintained by the team to be compatible with Toolbox. Some commands accept the
47+
`--distro` and `--release` flags. `--distro` accepts `ID` from `os-release`
48+
(e.g., on Fedora it is `fedora`). `--release` accepts version number of the
49+
selected distribution. Each distribution uses sligthly different versioning
50+
schema and some don't have any at all. Supported distributions are:
51+
52+
Name |os-release|Format |URI
53+
------|----------|---------------------------|-----------------------------------------
54+
Fedora|fedora |\<release\> or f\<release\>|registry.fedoraproject.org/fedora-toolbox
55+
RHEL |rhel |\<major\>.\<minor\> |registry.access.redhat.com/ubi8/ubi
56+
4357
## GLOBAL OPTIONS ##
4458

4559
The following options are understood:

0 commit comments

Comments
 (0)