1. chmod a+x moor---*
2. sudo mv moor---* /usr/local/bin/moor

Try moor --help to see options.

Configuring

Do moor --help for an up to date list of options.

Environment variable MOOR can be used to set default options.

For example:

export MOOR='--statusbar=bold --no-linenumbers'

Setting moor as your default pager

Set it as your default pager by adding...

export PAGER=/usr/local/bin/moor

... to your .bashrc.

Issues

Issues are tracked here, or you can send questions to .

Packaging

If you package moor, do include the man page in your package.

Comparison with bat

moor and bat do different things. moor is a pager. bat is a file preprocessor that sometimes pipes to a pager (like moor). So comparing them directly is not possible.

What bat does is:

1. Looks at its input and preprocesses it or not
2. Pipes to a pager or not. This pager can be moor or something else.

But some moor features like fast interactive search is moor specific and not something bat can simulate through preprocessing.

To use moor as your bat pager, set BAT_PAGER=moor in your environment.

Or, to use moor instead of bat, set PAGER=moor.

Embedding moor in your app

API Reference: https://pkg.go.dev/github.com/walles/moor/v2/pkg/moor

For a quick start, first fetch your dependency:

go get github.com/walles/moor/v2

Then, here's how you can use the API:

package main

import (
	"github.com/walles/moor/v2/pkg/moor"
)
func main() {
	err := moor.PageFromString("Hello, world!", moor.Options{})
	if err != nil {
		// Handle paging problems
		panic(err)
	}
}

After both go get is done and you have calls to moor in your code, you may have to:

go mod tidy

You can also PageFromStream() or PageFromFile().

Developing

moor draws to the terminal screen using twin, a standalone library originally built for moor and also usable on its own for building terminal UIs.

You need the go tools.

Testing

Run tests:

./test.sh

Launch the manual test suite:

./manual-test.sh

To run tests in 32 bit mode, either do GOARCH=386 ./test.sh if you're on Linux, or docker build . -f Dockerfile-test-386 (tested on macOS).

Both ./test.sh and ./moor.sh enable the race detector. Detected races end up in moor-race-report.* files in the repo root, see RACES.md.

Benchmarking

Run microbenchmarks:

go test -benchmem -run='^$' -bench=. ./...

Telling a real speed difference from luck takes more than one run of each. Use benchstat, which reports the difference with a p-value:

go install golang.org/x/perf/cmd/benchstat@latest
BENCH='go test -benchmem -run=^$ -bench=^BenchmarkReadLongLine$ -count=10 ./internal/reader'
$BENCH >before.txt
... make your change ...
$BENCH >after.txt
benchstat before.txt after.txt

Profiling

Profiling BenchmarkPlainTextSearch(). Try replacing -alloc_objects with -alloc_space or change the -focus function:

go test -memprofilerate=1 -memprofile=profile.out -benchmem -run='^$' -bench '^BenchmarkPlainTextSearch$' ./internal && go tool pprof -alloc_objects -focus findFirstHit -relative_percentages -web profile.out

Or to get a CPU profile:

go test -cpuprofile=profile.out -benchmem -run='^$' -bench '^BenchmarkRenderLines$' ./internal && go tool pprof -focus renderLines -relative_percentages -web profile.out

Building

Build + run:

./moor.sh ...

Install (into /usr/local/bin) from source:

./install.sh

Making a new Release

Make sure that screenshot.png matches moor's current UI. If it doesn't, scale a window to 81x16 characters and make a new one.

Execute release.sh and follow instructions.

TODO

• Enable exiting using ^c (without restoring the screen).

• Enable suspending using ^z, followed by resuming using fg.

• Underline the file name in the status bar while viewing. The point is to make

• Retain the search string when pressing / to search a second time.

Done

• Add > markers at the end of lines being cut because they are too long

• Doing moor on an arbitrary binary (like /bin/ls) should put all

• Make sure search hits are highlighted even when we have to scroll right

• Change out-of-file visualization to writing --- after the end of the file

• Exit search on pressing up / down / pageup / pagedown keys and

• Remedy all FIXMEs in this README file

• Release the go version as the new moor, replacing the previous Ruby

• Add licensing information (same as for the Ruby branch)

• Make sure git grep output gets highlighted properly.

• Handle all kinds of line endings.

• Make sure version information is printed if there are warnings.

• Add spinners while file is still loading

• Make tail -f /dev/null exit properly, fix