package
4.0.0-alpha.4
Repository: https://github.com/peterbourgon/ff.git
Documentation: pkg.go.dev

# Functions

Columns in the current TTY, or [DefaultColumns] if the TTY can't be determined.
Command returns a standard [Help] for the given command.
Flags returns a default [Help] value representing fs.
FormatFlag is a simple helper to format a flag in a single motion.
MakeFlagSpec produces a [FlagSpec] from an [ff.Flag].
NewFlagsSection returns a single FLAGS section representing every flag available to fs.
NewFlagsSections returns FLAGS section(s) representing every flag available to fs.
NewSection returns a section with the given title and lines, using [DefaultLinePrefix].
NewSubcommandsSection returns a SUBCOMMANDS section containing one line for every subcommand in the slice.
NewUntitledSection returns a section with no title and the given lines, with no line prefix.
Rewrap calls [RewrapAt] with a max width of [Columns].
RewrapAt rewraps s at max columns.
WrapFlag lets you write ffhelp.WrapFlag(f) instead of ffhelp.Flag{Flag: f}.

# Variables

DefaultColumns is the default value returned by [Columns].
DefaultLinePrefix is used by [Section] constructors in this package.

# Structs

Flag wraps [ff.Flag] to implement [fmt.Formatter].
FlagSpec represents a single-line help text for an [ff.Flag].
Section describes a single block of help text.

# Type aliases

Help represents help output for a flag set, command, etc.