wbrawner/toolbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
toolbox/doc/toolbox-help.1.md

36 lines
649 B
Markdown
Raw Permalink Normal View History

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-11 19:19:44 +00:00
% toolbox-help 1
Improve the help or usage output A new help command has been added which either shows the toolbox(1) manual or a manual page for a specific command. The '--help' flag is now identical to the help command and can be placed after the COMMAND segment in the list of command line arguments. Due to a bizarre quirk in less(1) [1], the default pager used to render manuals on most systems, the man(1) invocations need the standard error stream to point to the controlling terminal, if any, to work. This interferes with the global redirection of standard error to /dev/null in the absence of the '--verbose' flag, and is worked around by redirecting to standard output instead. [1] It turns out that less(1) tries to open the controlling terminal device /dev/tty to get to the keyboard for accepting input. However, it doesn't have a controlling terminal when invoked via D-Bus to render a manual on the host. It then strangely falls back to using the standard error stream to get to the keyboard. https://github.com/debarshiray/toolbox/pull/200
2019-07-15 08:23:25 +00:00
## NAME
toolbox\-help - Display help information about Toolbox
## SYNOPSIS
**toolbox help** [*COMMAND*]
## DESCRIPTION
When no COMMAND is specified, the `toolbox(1)` manual is shown. If a COMMAND
is specified, a manual page for that command is brought up.
Note that `toolbox --help ...` is identical to `toolbox help ...` because the
former is internally converted to the latter.
This page can be displayed with `toolbox help help` or `toolbox help --help`.
## EXAMPLES
### Show the toolbox manual
```
$ toolbox help
```
### Show the manual for the create command
```
$ toolbox help create
```
doc: Update to match current state & extend docs - Update "See also" sections Toolbox does not use Buildah for a considerable time now[0]. We can stop referencing it in the "See also" sections of the documentation. In some places mention podman command man pages where they are relevant. - Add section about toolbox images/containers Toolbox only supports certain OCI images. These should be documented. Also, document the change of fedora-toolbox image name. - Add a section about toolbox container setup Toolbox containers are specifically configured OCI containers. This should be documented so that users know what they're using. - Remove redundant part documentation The description of what `toolbox init-container` does is already in toolbox-init-container(1). There's no need to have it in toolbox-create(1). Instead, replace the text with a hint to visit the other part of documentation. - Clarify behaviour of --image option The fact that Toolbox by default tries to pull from the Fedora registry[1] should be noted. - Update synopsis & description of commands Mention options passed to `podman exec`. Remove redundant paragraph about container names (is already dealt with in toolbox-create(1)). There's no need to mention the name of the default container on Fedora since Toolbox now also supports RHEL. Mention the default used image on unrecognised systems. Emphasize the fact that toolboxes are not a fully sandboxed environment. Update the wording of the description and splits it into a few subsections. The description of the --monitor-host was inaccurate and while the option will go away in the future[2], it is currently in and should be more documented. [0] https://github.com/containers/toolbox/pull/160 [1] https://registry.fedoraproject.org [2] https://github.com/containers/toolbox/pull/617 https://github.com/containers/toolbox/pull/512
2021-03-04 19:36:22 +00:00
## SEE ALSO
`toolbox(1)`
Reference in a new issue Copy permalink