toolbox/doc/toolbox-list.1.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

48 lines
815 B
Markdown

% toolbox-list 1
## NAME
toolbox\-list - List existing toolbox containers and images
## SYNOPSIS
**toolbox list** [*--containers* | *-c*] [*--images* | *-i*]
## DESCRIPTION
Lists existing toolbox containers and images. These are OCI containers and
images, which can be managed directly with a tool like `podman`.
## OPTIONS ##
The following options are understood:
**--containers, -c**
List only toolbox containers, not images.
**--images, -i**
List only toolbox images, not containers.
## EXAMPLES
### List all existing toolbox containers and images
```
$ toolbox list
```
### List existing toolbox containers only
```
$ toolbox list --containers
```
### List existing toolbox images only
```
$ toolbox list --images
```
## SEE ALSO
`toolbox(1)`, `podman(1)`, `podman-ps(1)`, `podman-images(1)`