convert

Documentation

Index

• type Process
  • func NewProcess() (*Process, error)
  • func (p *Process) Kill() error
  • func (p *Process) ToHTML(r io.Reader, resolve func(ref string) string) (doc string, toc []string, err error)

Types

type Process

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

Process starts a mandoc process to convert manpages to HTML.

func NewProcess

func NewProcess() (*Process, error)

func (*Process) Kill

func (p *Process) Kill() error

func (*Process) ToHTML

func (p *Process) ToHTML(r io.Reader, resolve func(ref string) string) (doc string, toc []string, err error)

TODO(stapelberg): ToHTML’s output currently is used directly as (html/template).HTML, i.e. “known safe HTML document fragment”. We should be more aggressive in whitelisting the allowed tags.

resolve, if non-nil, will be called to resolve a reference (like “rm(1)”) into a URL.