man

package

v0.50.0 Latest Latest Go to latest Published: Nov 1, 2026 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitlab.com/phpboyscout/go-tool-base

Links

Open Source Insights

Documentation ¶

Overview ¶

Package man implements the opt-in "man" command that emits roff man pages for a tool's own command tree at runtime, for packaging postinstall scripts or ad-hoc preview, without re-running the source-tree generator. It is gated behind the default-off props.ManCmd feature and listed in --help once that feature is on: the author asked for it, so it is not hidden from them.

Index ¶

func NewCmdMan(props *p.Props) *setup.Command

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewCmdMan ¶

func NewCmdMan(props *p.Props) *setup.Command

NewCmdMan returns the runtime "man" command, gated behind the default-off ManCmd feature. With --dir it writes the full tree under <dir>/man1; without it, the running tool's top-level page is printed to stdout for preview (e.g. "mytool man | man -l -").

Types ¶

This section is empty.

Source Files ¶

View all Source files

man.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL