manpages

Documentation

Overview

Package manpages provides command definitions for man page generation.

Package manpages provides extended command definitions for man page generation.

Package manpages provides functionality for generating man pages for ChatMate CLI commands.

Index

• func NewRootCommand() *cobra.Command
• type Generator
  • func NewGenerator(outputDir string) *Generator
  • func (g *Generator) Generate() error
  • func (g *Generator) ListGeneratedFiles() error
  • func (g *Generator) ShowInstallationInstructions()

Functions

func NewRootCommand

func NewRootCommand() *cobra.Command

NewRootCommand creates the root cobra command with all subcommands for man page generation.

This function creates a simplified version of the ChatMate CLI structure focused on generating comprehensive man pages. It includes all commands with detailed help text and examples suitable for man page documentation.

Types

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator handles the generation of man pages for ChatMate commands.

func NewGenerator

func NewGenerator(outputDir string) *Generator

NewGenerator creates a new man page generator with the specified output directory.

func (*Generator) Generate

func (g *Generator) Generate() error

Generate creates man pages for all ChatMate commands.

This method generates comprehensive man pages including:

• Main chatmate man page with overview and common usage
• Individual man pages for each subcommand (hire, list, status, etc.)
• Proper man page formatting with sections and cross-references

Returns:

• error: Generation failure or file system error

func (*Generator) ListGeneratedFiles

func (g *Generator) ListGeneratedFiles() error

ListGeneratedFiles displays all generated man page files.

This method scans the output directory and lists all .1 (man page) files that were generated, providing feedback to the user about what was created.

func (*Generator) ShowInstallationInstructions

func (g *Generator) ShowInstallationInstructions()

ShowInstallationInstructions displays helpful instructions for installing and using man pages.