man

Documentation

Overview

Package man contains libraries for rendering package documentation as man pages.

Index

• Constants
• type Command
  • func (m Command) GetExecCmd() string
  • func (m Command) GetStdOut() io.Writer
  • func (m Command) Run() error

Constants

const ManFilename = "README.md"

Types

type Command

type Command struct {
	// Path is the path to a local package
	Path string

	// ManExecCommand is the exec command to run for displaying the man pages.
	ManExecCommand string

	// StdOut is the StdOut value
	StdOut io.Writer
}

Command displays local package documentation as man pages. The location of the man page is read from the Kptfile packageMetadata. If no man page is specified, and error is returned.

Man page format should be the format supported by the github.com/cpuguy83/go-md2man/md2man library

func (Command) GetExecCmd

func (m Command) GetExecCmd() string

GetExecCmd returns the command that will be executed to display the man pages.

func (Command) GetStdOut

func (m Command) GetStdOut() io.Writer

GetStdOut returns the io.Writer that will be used as the man stdout

func (Command) Run

func (m Command) Run() error

Run runs the command.