Workbench

A Bash Alias For Viewing READMEs From the Command Line

Prerequisites

• pandoc
• mktemp
• sed
• xargs

The Alias

RMDIR=`mktemp -d -p ${TMPDIR-/tmp} readme-XXXXXX` \
  && find . -iname 'readme.*' | xargs  -I {} pandoc {} -o $RMDIR/readme.1 \
  && sed -i '1s/^/.TH README 1\n/' $RMDIR/readme.1 \
  && man -l $RMDIR/readme.1

---

Tue Jul 22 2025 20:00:00 GMT-0400 (Eastern Daylight Time)