Runeman

Runeman is a fast, GTK-based manual page viewer written in Go.

Features

• View system manpages with proper rendering via troff -Tutf8.
• Tabbed interface with per-tab history (back/forward).
• Clickable references (printf(3), open(2), ...).
• in-page search with highlighting
  • regex search using /pattern/
• Cross-reference index:
  • see which pages reference the current page
  • navigate APIs and related commands more easily
• Styling via config file (fonts, colors, spacing)

Screenshots

Requirements

• A Unix-like system with:
  • man
  • troff (or groff)
• GTK4
• Go

Installation

Build from source

git clone https://github.com/friedelschoen/runeman.git
cd runeman
go build
# grab some coffee, might take a while...

This produces a runeman binary.

This can be installed to ~/go/bin. Add that to your path.

go install

Run

runeman

You can also open a specific page directly:

runeman 3 printf

More information in runeman(1).

Configuration

Runeman reads an optional configuration file:

• $XDG_CONFIG_HOME/runeman/runeman.conf
  • falls back to ~/.config/runeman/runeman.conf
• /etc/runeman/runeman.conf
• /usr/share/runeman/runeman.conf

If the file does not exist, following defaults are used:

[view]
margin-top = 10
margin-bottom = 10
margin-left = 10
margin-right = 10
show-history = no

[style.link]
foreground = #4444ff

[style.match]
background = #fbbf77

[style.match-selected]
background = #bbffbb

More information about the configuration in runeman(5).

License

Licensed under the beautiful terms of the Zlib-license.

Status

Runeman is usable and under heavy development. Might crash, might solve world hunger.

The interface and internal APIs may still change, contributions and issues are always welcome.