commit fbe6aaacc8da7c899093178e2c7bf957e87da0f8
from: noodle <noodle@pastanoggin.com>
date: Wed Dec 31 20:15:19 2025 UTC

add a readme

commit - 0675dc94cbacf747861a2b5f3cbce64f298ce2f5
commit + fbe6aaacc8da7c899093178e2c7bf957e87da0f8
blob - /dev/null
blob + 35dcea3629af925157f172f57d9c367ec5d068f9 (mode 644)
--- /dev/null
+++ README
@@ -0,0 +1,41 @@
+readman keeps track of the manpages you've read via a ~/.manread database.  It's
+currently WIP so backup your ~/.manread on updates.  It tracks read base system,
+X11, and ports manpages and reports on manpages that were changed since last
+reading them.
+
+Todo:
+
+- add support for showing diffs for changed pages via CVS for base system and
+X11 (and maybe ports too)
+- maybe add toggles for showing/hiding X11/ports manpages because the list of
+pages to read is very long otherwise
+- maybe add the 9front version to this repo too?
+
+Example usage:
+
+foobar$ readman -a 1 sh
+foobar$ readman -a 1 comm
+foobar$ readman -a 1 xwd
+foobar$ readman
+* man 1: 3/701
+* man 2: 0/149
+* man 3: 6/2864
+* man 4: 3/1140
+* man 5: 1/139
+* man 6: 0/41
+* man 7: 0/45
+* man 8: 1/372
+* man 9: 0/185
+foobar$ readman 1 sh
+You've read sh(1)
+foobar$ readman 1 echo
+You've not read echo(1)
+foobar$ readman -d 1 sh
+foobar$ readman 1 sh
+You've not read sh(1)
+foobar$ readman 1
+* man 1: 3/701
+* have read: openrsync xwd xwud
+* to read: acme-client addr2line apply appres apropos ar arch as at atq atrm aucat
+awk banner basename bc bdftopcf bdftruncate beforelight ... (example truncated)
+foobar$