troff

Documentation

Index

• Constants
• func Abstract(w io.Writer, abstract string)
• func AuthorBio(w io.Writer, a Author)
• func Bold(w io.Writer)
• func ChangeDate(w io.Writer, d time.Time)
• func CodeBlock(w io.Writer, code []byte)
• func Display(w io.Writer, p []byte)
• func Esc(w io.Writer, p []byte)
• func Figure(w io.Writer, link string, verticalSize string)
• func HTML(w io.Writer, attribute string)
• func Indent(w io.Writer)
• func IndentParagraph(w io.Writer, title string)
• func Italic(w io.Writer)
• func LeftAlignedParagraph(w io.Writer, title string, level int)
• func LineBreak(w io.Writer)
• func NewRenderer() blackfriday.Renderer
• func Outdent(w io.Writer)
• func Picture(w io.Writer, source string, height, width float32, position Position, ...)
• func Roman(w io.Writer)
• func Table(w io.Writer, p []byte)
• func TableHeading(w io.Writer)
• func Title(w io.Writer, tl string)
• func Underline(w io.Writer)
• type Author
• type Macro
• type PictureFlag
• type Position

Constants

const (
	// Left align the picture
	Left Position = iota
	// Center align the picture
	Center
	// Right align the picture
	Right

	// Outline the picture with a box.
	Outline PictureFlag = iota
	// Scale freely scales both picture dimensions.
	Scale
	// White out the area to be occupied by the picture.
	White
)

Functions

func Abstract

func Abstract(w io.Writer, abstract string)

Abstract prints

.AB
<abstract>
.AE

func AuthorBio

func AuthorBio(w io.Writer, a Author)

AuthorBio prints

.AU
.I <a.Name>
.I <a.Email>
.AI <a.Affiliation>

func Bold

func Bold(w io.Writer)

Bold prints

.B

func ChangeDate

func ChangeDate(w io.Writer, d time.Time)

ChangeDate changes the date to the given date by printing .ND May 8, 1945

func CodeBlock

func CodeBlock(w io.Writer, code []byte)

CodeBlock prints codeblock

.P1
<codeblock>
.P2

func Display

func Display(w io.Writer, p []byte)

Display prints

.DS
<p>
.DE

func Esc

func Esc(w io.Writer, p []byte)

Esc should print escaped bytes, but it just writes it. TODO(sevki): fix!

func Figure

func Figure(w io.Writer, link string, verticalSize string)

Figure prints

.FG <link> <size>

func HTML

func HTML(w io.Writer, attribute string)

HTML prints .HTML <attribute>\n

func Indent

func Indent(w io.Writer)

Indent prints

.RS\n

func IndentParagraph

func IndentParagraph(w io.Writer, title string)

IndentParagraph takes a <title> and prints

.IP <title>\n

func Italic

func Italic(w io.Writer)

Italic prints

.I

func LeftAlignedParagraph

func LeftAlignedParagraph(w io.Writer, title string, level int)

LeftAlignedParagraph prints

.LP

func LineBreak

func LineBreak(w io.Writer)

LineBreak prints a new line

\n

func NewRenderer

func NewRenderer() blackfriday.Renderer

NewRenderer returns a blackfriday.Renderer that will print plan9 troff macros https://plan9.io/sys/doc/troff.pdf

func Outdent

func Outdent(w io.Writer)

Outdent prints

.RE\n

func Picture

func Picture(w io.Writer, source string, height, width float32, position Position, offset float32, flags PictureFlag)

Picture is the mpicture macro https://9p.io/magic/man2html/6/mpictures

func Roman

func Roman(w io.Writer)

Roman prints

.R

func Table

func Table(w io.Writer, p []byte)

Table prints

.TS
.DS
<p>
.DE
.TE

func TableHeading

func TableHeading(w io.Writer)

TableHeading prints

.TH\n

func Title

func Title(w io.Writer, tl string)

Title prints

.TL
<title>\n

func Underline

func Underline(w io.Writer)

Underline prints

.UL

Types

type Author

type Author struct {
	Name        string
	Affiliation string
	Email       string
}

Author information

type Macro

type Macro string

Macro is a troff macro

type PictureFlag

type PictureFlag int

PictureFlag sets the picture options like scale and outline

type Position

type Position int

Position of the picture