toolbox/doc/toolbox-help.1.md at main

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

649 B

Raw Permalink Blame History

% 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

649 B Raw Permalink Blame History