pager

package
v0.0.0-...-d3da680 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 4, 2024 License: Apache-2.0 Imports: 8 Imported by: 3

Documentation

Overview

Package pager implements paging using commands "less" or "more", depending on availability.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Main

func Main(ctx context.Context, fn func(ctx context.Context, out io.WriteCloser) int) int

Main implements paging using commands "less" or "more" if they are available. If os.Stdout is not terminal or less/more are not available in $PATH, Main calls fn with out set to os.Stdout and returns its exit code. Otherwise creates a pager subprocess, directs its stdout to os.Stdout and calls fn with out set to pager stdin. fn's context is canceled if the user quits pager.

If fn returns non-zero exit code before pager exits, Main returns that exit code. Otherwise Main returns pager's exit code. It is a race between the user hitting q and fn failing.

Example:

func main() int {
	return Main(context.Background(), func(ctx context.Context, out io.WriteCloser) int {
		for i := 0; i < 100000 && ctx.Err() == nil; i++ {
			fmt.Fprintln(out, i)
		}
		return 0
	})
}

Types

This section is empty.

Jump to

Keyboard shortcuts

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