mangokong

README

Mango (man page generator) integration for Kong

This package allows Kong packages to generate man pages using Mango.

Simply add mangokong.ManFlag to your CLI struct:

var cli struct {
	Man mangokong.ManFlag `help:"Write man page."`
}

Example

This is what the included example looks like:

Documentation

Index

• func NewManPage(section uint, app *kong.Application) *mango.ManPage
• type ManFlag
  • func (m ManFlag) BeforeApply(app *kong.Kong) error

Functions

func NewManPage

func NewManPage(section uint, app *kong.Application) *mango.ManPage

NewManPage from a Kong Application.

Types

type ManFlag

type ManFlag bool

ManFlag can be used as a Kong flag that will write a default man page to stdout.

func (ManFlag) BeforeApply

func (m ManFlag) BeforeApply(app *kong.Kong) error