5e63e9ec9b
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
623 B
623 B
% toolbox-help(1)
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