bat: MANPAGER won't work on Mandoc's man implementation

What version of bat are you using? 0.15.4

Describe the bug you encountered: Using export MANPAGER="sh -c 'col -bx | bat -l man -p'" results in -bx: 1: Syntax error: Unterminated quoted string

Describe what you expected to happen? paging with bat

How did you install bat? Void Linux package manager

** The bug ** It was already reported here for Termux, and it coudl well be the case for Alpine and other Mandoc’s man implementations cases. See https://github.com/termux/termux-packages/issues/4781#issuecomment-573110911

** Lazy solution ** Instead of recompiling man from GNU (https://www.nongnu.org/man-db/development.html) one can be using export MANPAGER='nvim +Man!'

About this issue

  • Original URL
  • State: closed
  • Created 6 years ago
  • Reactions: 6
  • Comments: 15 (1 by maintainers)

Commits related to this issue

Most upvoted comments

#!/bin/sh
cat "$1" | col -bx | bat --language man --style plain

Not that performance matters much for a shell script like this, but you can even cut out the cat invocation:

col -bx < "$1" | bat --language man -p

It does not work because mandoc does not do shell tokenization of the $MANPAGER string, it just splits it into a list of words and passes them to execvp. So the error comes from sh which complains about an unterminated quoted string from the word 'col.

bat itself does not have any problems displaying the output of mandoc’s man command, you just have to configure the pager appropriately. This can be done by putting the following in a wrapper script and then export MANPAGER="your_wrapper":

#!/bin/sh
cat "$1" | col -bx | bat --language man --style plain

col -bx < “$1” | bat --language man -p

Or:

#!/bin/sh
exec col -bx | bat -pl man

These two commands are not equivalent - the former reads from a file denoted by $1 and the latter reads from stdin. The former is required for mandoc, the latter may be required for other things that use $MANPAGER (e.g. using the help function in an ipython shell). The following can be used as a universal solution (note that cat here is not as useless as in https://github.com/sharkdp/bat/issues/1145#issuecomment-736096036):

#!/bin/sh

# mandoc passes a file name, other tools write to stdout
# using `cat "$@"` we take care of both reading from file and stdin
exec cat "$@" | col -bx | bat --language man --style plain --pager "$PAGER"

You are all the way right 😉

Hey, so you have so much free time in your life huh?

It just bothered me when you don’t understand the code and saying it’s wrong. It’s not wrong. See, after you figure out what my code means, you already improve it. Good learning for you, right? 😉 I’ll take your offer then

#!/bin/sh
if [ $# -eq 0 ]; then
  col -bx | "$BAT_BIN" --language man --plain
else
  col -bx < "$1" | "$BAT_BIN" --language man --plain
fi

And you have added one shell condition instead. What do you think is faster: cat or [ -f "$1" ]?

Isn’t it obvious? But sure, have it your way… I don’t have much time and energy for something like this

For others: In ubuntu, bat is actually batcat, so set BAT_BIN to bat or batcat depends on your environment.

In any case, [ -f "$1" ] seems like a wrong condition: if there is no file but stdin, there is no $1 itself.

what else is the else clause for? The code means: if the input is a file then take the file, otherwise take the stdin

Did you actually measure it?

Do I have to? One must be processed through cat and then col, while the other just goes through col

exec cat "$@" | col -bx | bat --language man --style plain --pager "$PAGER"

Or this for better performance:

#!/bin/sh
if [ -f "$1" ]; then
  col -bx < "$1" | bat --language man --plain
else
  col -bx | bat --language man --plain
fi