toolbox/doc/toolbox.conf.5.md
Debarshi Ray 936a157117 doc, test/system: Fix the titles of the manuals
Currently, the titles of the manuals are rendered with a pair of empty
parentheses and no section title:
  toolbox(1)()                                              toolbox(1)()

  NAME
         toolbox - Tool for containerized command line environments...

However, they should be:
  toolbox(1)             General Commands Manual              toolbox(1)

  NAME
         toolbox - Tool for containerized command line environments...

This is because the troff generated by go-md2man from Markdown has a
faulty invocation of the .TH macro [1]:
  .nh
  .TH toolbox(1)
  .SH NAME
  .PP
  toolbox - Tool for containerized command line environments on Linux

It should be:
  .nh
  .TH toolbox 1
  .SH NAME
  .PP
  toolbox - Tool for containerized command line environments on Linux

Original patch from Andrew Denton for Podman [2].

[1] https://www.gnu.org/software/groff/manual/groff.html

[2] Podman commit 63c779a857b55b00
    https://github.com/containers/podman/pull/15621

https://github.com/containers/toolbox/pull/1210
2023-01-12 18:45:00 +01:00

67 lines
1.6 KiB
Markdown

% toolbox.conf 5
## NAME
toolbox.conf - Toolbox configuration file
## DESCRIPTION
Persistently overrides the default behaviour of `toolbox(1)`. The syntax is
TOML and the names of the options match their command line counterparts.
Currently, the only supported section is *general*.
## OPTIONS
**distro** = "DISTRO"
Create a toolbox container for a different operating system DISTRO than the
host. Cannot be used with `image`.
**image** = "NAME"
Change the NAME of the image used to create the toolbox container. This is
useful for creating containers from custom-built images. Cannot be used with
`distro` and `release`.
If NAME does not contain a registry, the local image storage will be
consulted, and if it's not present there then it will be pulled from a suitable
remote registry.
**release** = "RELEASE"
Create a toolbox container for a different operating system RELEASE than the
host. Cannot be used with `image`.
## FILES
The following locations are looked up in increasing order of priority:
**/etc/containers/toolbox.conf**
This is meant to be provided by the operating system distributor or the system
administrator, and affects all users on the host.
Fields specified here can be overridden by any of the files below.
**$XDG_CONFIG_HOME/containers/toolbox.conf**
This is meant for user-specific changes. Fields specified here override any of
the files above.
## EXAMPLES
### Override the default operating system distro:
```
[general]
distro = "fedora"
release = "36"
```
### Override the default image:
```
[general]
image = "registry.fedoraproject.org/fedora-toolbox:36"
```
## SEE ALSO
`toolbox(1)`, `toolbox-create(1)`