summary refs log tree commit diff
path: root/bin/README
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2018-09-07 21:52:17 -0400
committerJune McEnroe <june@causal.agency>2018-09-07 21:52:17 -0400
commit6bc1231339eecec95bff6aaf624aad89316c438e (patch)
tree02661cd79119a360e926b620e4b23b52b5bcfdde /bin/README
parentAdd xx.1 (diff)
downloadsrc-6bc1231339eecec95bff6aaf624aad89316c438e.tar.gz
src-6bc1231339eecec95bff6aaf624aad89316c438e.zip
Replace README with README.7
Diffstat (limited to '')
-rw-r--r--bin/README131
-rw-r--r--bin/README.737
2 files changed, 37 insertions, 131 deletions
diff --git a/bin/README b/bin/README
deleted file mode 100644
index 804f7ceb..00000000
--- a/bin/README
+++ /dev/null
@@ -1,131 +0,0 @@
-
-Tools primarily targetting Darwin, FreeBSD and NetBSD. Some don't build on
-Linux and some only build on Linux. All 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 &
-	atch a
-
-                                 fbatt
-
-Battery charge indicator panel for the Linux framebuffer through
-/sys/class/power_supply.
-
-                                fbclock
-
-Clock panel for the Linux framebuffer. Renders PSF2 bitmap fonts.
-
-                                 glitch
-
-PNG glitcher based on pngo.
-
-	-c         write to stdout
-	-o PATH    write to file
-	-p         broken Paeth predictor
-	-f         filter when reconstructing
-	-r         reconstruct when filtering
-	-d LIST    declare pattern of comma-separated filters
-	-a LIST    apply pattern of comma-separated filters
-	-i         invert after filtering
-	-m         mirror scanlines after filtering
-	-x         zero first pixels after filtering
-	-y         zero first scanline after filtering
-
-                                  hnel
-
-The tr(1) of PTYs, for remapping keys. Originally for preserving HJKL in
-alternate keyboard layouts. Toggle remapping with ^S.
-
-	hnel '[]{}' '{}[]' vi
-
-                                  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
-
-                                 modem
-
-PTY wrapper with a fixed baud rate of 19.2 kbps.
-
-                           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
-
-                                  pngo
-
-PNG optimizer. Does not support interlaced PNGs.
-
- - Discards ancillary chunks
- - Discards unnecessary alpha channel
- - Converts unnecessary truecolor to grayscale
- - Indexes color if possible
- - Reduces bit depth if possible
- - Applies a simple filter type heuristic
- - Applies zlib's best compression
-
-	pngo foo.png
-	pngo -o bar.png foo.png
-	pngo -c foo.png | xx
-
-                                 scheme
-
-Color scheme for terminals.
-
-	-a  generate ANSI palette
-	-t  generate Terminal.app palette
-	-h  output HSV
-	-x  output RGB
-	-g  output PNG
-	-c  output C
-	-l  output Linux console OSC sequences
-	-m  output Mintty theme
-
-                                  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/README.7 b/bin/README.7
new file mode 100644
index 00000000..90465ab8
--- /dev/null
+++ b/bin/README.7
@@ -0,0 +1,37 @@
+.Dd $Mdocdate$
+.Dt README 7
+.Os "Causal Agency"
+.Sh NAME
+.Nm bin
+.Nd various utilities
+.Sh DESCRIPTION
+Various tools primarily targeting
+Darwin,
+FreeBSD
+and NetBSD.
+Some tools also target Linux.
+.Pp
+To build common tools, run:
+.Dl make
+.Pp
+To build BSD tools, run:
+.Dl make bsd
+.Pp
+To build Linux tools, run:
+.Dl make linux
+.Sh SEE ALSO
+.Xr atch 1 ,
+.Xr bri 1 ,
+.Xr dtch 1 ,
+.Xr fbatt 1 ,
+.Xr fbclock 1 ,
+.Xr glitch 1 ,
+.Xr hnel 1 ,
+.Xr klon 6 ,
+.Xr modem 1 ,
+.Xr pbd 1 ,
+.Xr pngo 1 ,
+.Xr scheme 1 ,
+.Xr wake 1 ,
+.Xr watch 1 ,
+.Xr xx 1