w3m

README

go-w3m

For an example, check w3m_test.go. Documentation available in Godoc

Documentation

Index

• Variables
• func Clear(a *Arguments) error
• func ClearAll() error
• func GetExecPath() string
• func Spawn(a *Arguments, filename string) error
• type Arguments
• type Daemon
  • func Daemonize(a *Arguments, filename string) *Daemon
  • func (d *Daemon) Stop()

Variables

var (

	// ErrNotFound is returned when w3m can't be found
	ErrNotFound = errors.New("w3m not found")

	// ErrNoArguments is returned when one of the arguments are missing
	ErrNoArguments = errors.New("No arguments provided")
)

Functions

func Clear

func Clear(a *Arguments) error

Clear clears the image

func ClearAll

func ClearAll() error

ClearAll clears all the images on the terminal This works by clearing a frame 9999x9999px large

func GetExecPath

func GetExecPath() string

GetExecPath finds w3mimgdisplay

func Spawn

func Spawn(a *Arguments, filename string) error

Spawn spawns a w3m image

Types

type Arguments

type Arguments struct {
	Xoffset int // default: 0
	Yoffset int // default: 0
	Width   int
	Height  int
}

Arguments is the struct for w3m arguments All fields are required

type Daemon

type Daemon struct {
	LastError error
	// contains filtered or unexported fields
}

Daemon is the struct for daemonizing

func Daemonize

func Daemonize(a *Arguments, filename string) *Daemon

Daemonize runs w3m in a background loop. This function

func (*Daemon) Stop

func (d *Daemon) Stop()

Stop stops the daemon