Add bin/README

12 files changed, 99 insertions, 23 deletions

diff --git a/bin/README b/bin/README
new file mode 100644
index 00000000..b476d085
--- /dev/null
+++ b/bin/README
@@ -0,0 +1,99 @@
+
+Tools primarily targetting Darwin and FreeBSD. Some don't build on Linux
+and some only build on Linux. All code licensed AGPLv3. See LICENSE.
+
+                                  bri
+
+Backlight brightness control for Linux through /sys/class/backlight.
+
+    bri 255
+    bri ---
+    bri ++
+
+                               dtch/atch
+
+Session detach and attach. Simple implementation of part of screen(1) by
+lending out the master end of a PTY over a UNIX domain socket. Detach
+with ^Q.
+
+    dtch a nvim & disown
+    atch a
+
+                                fbclock
+
+Clock panel for the Linux framebuffer. Renders PSF2 bitmap fonts.
+
+                                  gfxx
+
+Work in progress.
+
+                                  hnel
+
+The tr(1) of PTYs, for remapping keys. Originally for preserving HJKL in
+alternate keyboard layouts. Toggle remapping with ^S.
+
+    hnel '[]{}' '{}[]' vi
+
+                                  jrp
+
+JIT RPN calculator for x86_64. Mostly just to be overkill.
+
+    B   bin    O   oct    D   dec    X   hex
+    ;   drop   :   dup    \   swap
+    _   neg    +   add    -   sub
+    *   mul    /   div    %   rem
+    &   and    |   or     ^   xor
+    ~   not    <   shl    >   shr
+    '   quot   ,   prch   .   prnt
+
+                                  klon
+
+Klondike solitaire for curses. BSD-only for arc4random_uniform.
+
+    q   quit
+    u   undo
+    ' ' draw
+    w   waste
+    a-d foundations
+    1-7 tableau
+    ^M  auto-foundation
+
+                           pbd/pbcopy/pbpaste
+
+TCP server which pipes into macOS pbcopy(1) and from pbpaste(1), and
+pbcopy and pbpaste implementations that connect to it. Used to share
+the macOS pasteboard over SSH with RemoteForward 7062 127.0.0.1:7062.
+This used to make nvim's "+ register work but they seem to have changed
+their detection.
+
+    pbd & disown
+    ssh tux.local
+    pbpaste
+
+                                  typo
+
+Typing game for curses. BSD-only for arc4random_uniform. Displays random
+words from 10 000 common words in words.txt to be typed. Calculates WPM
+assuming every 5 letters is 1 word.
+
+                                  wake
+
+Broadcasts a wake-on-LAN packet to one of my machines.
+
+                                 watch
+
+Executes a command each time files change. BSD-only for kqueue(2).
+
+    watch watch.c make
+    watch wake.c watch.c -- make wake watch
+
+                                   xx
+
+Hexdump tool.
+
+    -a          toggle ASCII
+    -c N        set columns
+    -g N        set grouping
+    -r          reverse hexdump
+    -s          toggle offsets
+    -z          skip zeros
diff --git a/bin/bri.c b/bin/bri.c
index ce15cac7..edf1aeee 100644
--- a/bin/bri.c
+++ b/bin/bri.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// Backlight brightness control.
-
 #include <dirent.h>
 #include <err.h>
 #include <errno.h>
diff --git a/bin/dtch.c b/bin/dtch.c
index ab313f58..a5982a5e 100644
--- a/bin/dtch.c
+++ b/bin/dtch.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// Session attach and detach.
-
 #include <err.h>
 #include <errno.h>
 #include <fcntl.h>
diff --git a/bin/fbclock.c b/bin/fbclock.c
index d99c655d..97d931f7 100644
--- a/bin/fbclock.c
+++ b/bin/fbclock.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// Linux framebuffer clock.
-
 #include <assert.h>
 #include <err.h>
 #include <fcntl.h>
diff --git a/bin/hnel.c b/bin/hnel.c
index e670efb5..94d00a0b 100644
--- a/bin/hnel.c
+++ b/bin/hnel.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// PTY wrapper for remapping arbitrary keys.
-
 #include <err.h>
 #include <poll.h>
 #include <stdbool.h>
diff --git a/bin/jrp.c b/bin/jrp.c
index 049dc7d4..1f2449ad 100644
--- a/bin/jrp.c
+++ b/bin/jrp.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// JIT RPN calculator.
-
 #include <err.h>
 #include <histedit.h>
 #include <stdbool.h>
diff --git a/bin/klon.c b/bin/klon.c
index dab04805..fb0a0b56 100644
--- a/bin/klon.c
+++ b/bin/klon.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// Klondike solitaire.
-
 #include <assert.h>
 #include <curses.h>
 #include <locale.h>
diff --git a/bin/pbd.c b/bin/pbd.c
index be3d95a0..28e61754 100644
--- a/bin/pbd.c
+++ b/bin/pbd.c
@@ -14,9 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// TCP server which pipes between macOS pbcopy and pbpaste, and pbcopy and
-// pbpaste implementations which connect to it.
-
 #include <arpa/inet.h>
 #include <err.h>
 #include <netinet/in.h>
diff --git a/bin/typo.c b/bin/typo.c
index 2d235bc5..660c8249 100644
--- a/bin/typo.c
+++ b/bin/typo.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// Typing game.
-
 #include <curses.h>
 #include <err.h>
 #include <stdlib.h>
diff --git a/bin/wake.c b/bin/wake.c
index 01222087..a92cbd0c 100644
--- a/bin/wake.c
+++ b/bin/wake.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// Wake-on-LAN.
-
 #include <sys/types.h>
 
 #include <err.h>
diff --git a/bin/watch.c b/bin/watch.c
index bb432815..ac900eee 100644
--- a/bin/watch.c
+++ b/bin/watch.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// Execute a command each time files change.
-
 #include <sys/types.h>
 
 #include <err.h>
diff --git a/bin/xx.c b/bin/xx.c
index 4fec0f7f..25b84e2e 100644
--- a/bin/xx.c
+++ b/bin/xx.c
@@ -14,8 +14,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// Hexdump.
-
 #include <ctype.h>
 #include <err.h>
 #include <stdbool.h>