Documentation
¶
Overview ¶
Package manpage provides a Nabat extension that installs a `man` subcommand generating roff documentation for the command tree. Install with nabat.WithExtension.
import (
"nabat.dev/nabat"
"nabat.dev/manpage"
)
app := nabat.MustNew("myctl", nabat.WithExtension(manpage.New(manpage.WithSection(8))))
Defaults: subcommand "man", section 1, hidden=false.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrNilOption = errors.New("nabat/manpage: option is nil")
ErrNilOption is returned when a nil Option is passed to New.
Functions ¶
func New ¶
New returns a nabat.Extension that installs the man subcommand. A nil opts entry returns ErrNilOption. It also fails on an empty WithCommandName or a section outside 1-9.
Example ¶
package main
import (
"context"
"fmt"
"strings"
"nabat.dev/manpage"
"nabat.dev/nabat"
"nabat.dev/nabat/nabattest"
)
func main() {
io, _, stdout, _ := nabattest.NewIO()
app := nabat.MustNew("myctl",
nabat.WithIO(io),
nabat.WithExtension(manpage.New()),
)
if err := app.RunArgs(context.Background(), "man"); err != nil {
fmt.Println("error:", err)
return
}
doc := strings.TrimSpace(stdout.String())
if strings.HasPrefix(doc, ".TH") {
fmt.Println("roff")
} else {
fmt.Println("unexpected format")
}
}
Output: roff
Types ¶
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
Option configures the manpage extension.
func WithCommandName ¶
WithCommandName overrides the man subcommand name (default "man").
func WithSection ¶
WithSection sets the default man page section (1-9; default 1). Users can override at runtime via --section.
Source Files
Click to show internal directories.
Click to hide internal directories.