2022-07-21 17:08:31 +03:00
.TH MOAR 1 2022 -07-21
.SH NAME
moar \- the nice pager
.SH SYNOPSIS
.B moar
[options]
.IR file
.br
.B "moar \-\-help"
2022-07-22 10:13:23 +03:00
.br
.B "moar \-\-version"
2022-07-21 17:08:31 +03:00
.SH DESCRIPTION
.B moar
is a pager much like
.I less
(1), but with generally nicer out-of-the-box behavior.
.PP
More information and screenshots: https://github.com/walles/moar#readme
.PP
2022-07-22 12:24:28 +03:00
Inside of \fB moar\fR , press
2022-07-21 17:08:31 +03:00
.B ?
to access the built-in help.
2022-08-07 20:26:51 +03:00
.PP
Input is expected to be (optionally compressed) UTF-8 text.
Invalid / unprintable characters are by default rendered as '?'.
2022-07-21 17:08:31 +03:00
.SH OPTIONS
2022-07-22 10:13:23 +03:00
Multiple-choice options all have the default value listed first.
2022-07-22 12:24:28 +03:00
.PP
All of these options can be appended to the
2022-07-22 12:32:00 +03:00
.B MOAR
2022-07-22 12:24:28 +03:00
environment variable for persistent configuration.
2022-07-22 12:32:00 +03:00
.PP
Doing
.B moar --help
will also list these options.
2022-07-22 09:35:05 +03:00
.TP
2022-07-22 10:13:23 +03:00
\fB \- \- colors\fR ={\fB auto\fR | \fB 8\fR | \fB 16\fR | \fB 256\fR | \fB 16M\fR }
2022-07-22 09:56:50 +03:00
Size of color palette we output to the terminal
.TP
2022-07-22 09:35:05 +03:00
\fB \- \- debug\fR
2022-07-22 12:24:28 +03:00
Print debug logs after exiting, less verbose than
.B \- \- trace
2022-07-22 09:56:50 +03:00
.TP
2022-11-28 21:09:17 +03:00
\fB \- \- follow\fR
Scrolls automatically to follow piped input, just like
.B tail \- f
.TP
2024-01-02 18:14:19 +03:00
\fB \- \- lang\fR =string
Used for highlighting.
Without this flag highlighting is based on the input file name.
Valid values are MIME types like \fB text/x-markdown\fP , file extensions like \fB md\fP or language names like \fB markdown\fP .
For the source of truth on what is supported exactly, look in https://github.com/alecthomas/chroma/tree/master/lexers/embedded or its parent directory.
.TP
2023-12-19 11:20:02 +03:00
\fB \- \- mousemode\fR ={\fB auto\fR | \fB select\fR | \fB scroll\fR }
Guarantee selecting text with the mouse works but maybe not mouse scrolling.
Or guarantee mouse scrolling works but selecting text requiring extra effort.
2023-12-15 23:44:13 +03:00
Details here: https://github.com/walles/moar/blob/master/MOUSE.md
.TP
2022-07-22 09:56:50 +03:00
\fB \- \- no\- clear\- on\- exit\fR
Retain screen contents when exiting moar
.TP
\fB \- \- no\- linenumbers\fR
Hide line numbers on startup, press left arrow key to show
.TP
\fB \- \- no\- statusbar\fR
Hide the status bar, toggle with
.B =
.TP
2023-05-18 10:08:46 +03:00
\fB \- \- quit\- if\- one\- screen\fR
2023-05-18 10:15:32 +03:00
Print input contents without paging if the input fits on one screen
2023-05-18 10:08:46 +03:00
.TP
2022-07-22 09:56:50 +03:00
\fB \- \- render\- unprintable\fR ={\fB highlight\fR | \fB whitespace\fR }
How unprintable characters are rendered
2022-07-22 10:13:23 +03:00
.TP
2022-08-07 20:07:46 +03:00
\fB \- \- scroll\- left\- hint\fR =string
UTF-8 character indicating the view can scroll left, defaults to an inverse \fB <\fR .
This can be a string containing ANSI formatting.
The word
.B ESC
in caps will be interpreted as one escape character.
Example value for faint (using ANSI SGR code 2) tilde characters:
.B ESC[2m~
.TP
\fB \- \- scroll\- right\- hint\fR =string
UTF-8 character indicating the view can scroll right, defaults to an inverse \fB >\fR .
This can be a string containing ANSI formatting.
The word
.B ESC
in caps will be interpreted as one escape character.
Example value for faint (using ANSI SGR code 2) tilde characters:
.B ESC[2m~
.TP
2023-03-19 13:56:54 +03:00
\fB \- \- shift\fR =int
Arrow keys side scroll amount. Or try ALT+arrow to scroll one column at a time.
.TP
2022-07-22 10:13:23 +03:00
\fB \- \- statusbar\fR ={\fB inverse\fR | \fB plain\fR | \fB bold\fR }
Status bar style
.TP
\fB \- \- style\fR ={\fB native\fR | \fI style\fR }
Highlighting style from https://xyproto.github.io/splash/docs/longer/all.html
2022-07-22 12:24:28 +03:00
.TP
\fB \- \- trace\fR
Print trace logs after exiting, more verbose than
.B \- \- debug
.TP
\fB \- \- wrap\fR
Wrap long lines, toggle with
.B w
2023-09-27 21:23:27 +03:00
.TP
\fB \+ \1 234\fR
Immediately scroll to line
.B 1234
2022-07-21 17:08:31 +03:00
.SH ENVIRONMENT
Having
.B PAGER=moar
in your environment will make lots of different programs use
.B moar
as their pager.
2022-07-22 12:32:00 +03:00
.PP
Additional options are read from the
.B MOAR
environment variable if set, just as if those same options had been manually added to each
.B moar
invocation.
2022-07-21 17:08:31 +03:00
.SH BUGS
Kindly report any bugs here: https://github.com/walles/moar/issues