README
¶
Layout
All man pages follow a common layout that is optimized for presentation on a simple ASCII text display, possibly without any form of highlighting or font control. Sections present may include:[21]: MANUAL STRUCTURE
NAME
The name of the command or function, followed by a one-line description of what it does.
SYNOPSIS
In the case of a command, a formal description of how to run it and what command line options it takes. For program functions, a list of the parameters the function takes and which header file contains its declaration.
DESCRIPTION
A textual description of the functioning of the command or function.
EXAMPLES
Some examples of common usage.
SEE ALSO
A list of related commands or functions.
Other sections may be present, but these are not well standardized across man pages. Common examples include: OPTIONS, EXIT STATUS, RETURN VALUE, ENVIRONMENT, BUGS, FILES, AUTHOR, REPORTING BUGS, HISTORY and COPYRIGHT.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Text ¶
stolen from https://github.com/muesli/roff/blob/main/roff.go
Types ¶
type Command ¶
Command represents a command.
func NewCommand ¶
NewCommand returns a new Command.
func (*Command) AddSubCommand ¶
AddCommand adds a sub-command.
type ManPage ¶
type ManPage struct {
Root Command
Version string
Concept string
License string
Bugs string
Files string
Authors []string
ReportingBugs string
History string
Copyright string
Documentation string
// contains filtered or unexported fields
}
ManPage represents a man page generator.
func NewManPage ¶
NewManPage returns a new ManPage generator instance.
func (*ManPage) AddSection ¶
AddSection adds a section to the man page.
Source Files