man

package

v0.0.0-...-c7d747a Latest Latest Go to latest Published: Nov 22, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SamarSidharth/kpt

Links

Open Source Insights

Documentation ¶

Overview ¶

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

Constants ¶

View Source

const ManFilename = "README.md"

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

man.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL