docs

Documentation

Index

• func GenerateManPagesForCommand(cmd *cobra.Command, outputDir string) error
• type ManPageGenerator
  • func NewManPageGenerator(outputDir string) *ManPageGenerator
  • func (g *ManPageGenerator) GenerateManPage(cmd *cobra.Command, cmdName string) error
  • func (g *ManPageGenerator) GenerateManPages(rootCmd *cobra.Command) error

Functions

func GenerateManPagesForCommand

func GenerateManPagesForCommand(cmd *cobra.Command, outputDir string) error

GenerateManPagesForCommand generates man pages for a command and its subcommands

Types

type ManPageGenerator

type ManPageGenerator struct {
	// OutputDir is the directory where man pages will be written
	OutputDir string

	// Section is the man page section (1-9)
	Section int

	// Date is the date to include in the man page
	Date string

	// Footer is the footer to include in the man page
	Footer string

	// Header is the header to include in the man page
	Header string
}

ManPageGenerator generates man pages for commands

func NewManPageGenerator

func NewManPageGenerator(outputDir string) *ManPageGenerator

NewManPageGenerator creates a new man page generator

func (*ManPageGenerator) GenerateManPage

func (g *ManPageGenerator) GenerateManPage(cmd *cobra.Command, cmdName string) error

GenerateManPage generates a man page for a command

func (*ManPageGenerator) GenerateManPages

func (g *ManPageGenerator) GenerateManPages(rootCmd *cobra.Command) error

GenerateManPages generates man pages for all commands