summary refs log tree commit diff
path: root/bin/man
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2018-09-11 22:08:54 -0400
committerJune McEnroe <june@causal.agency>2018-09-11 22:08:54 -0400
commit324026700184917040f360aced5995856eea838f (patch)
tree648db1074e9b7d573fc2d56710711b9bf1eaa0c0 /bin/man
parentRewrite gfx.7 and render plaintext README (diff)
downloadsrc-324026700184917040f360aced5995856eea838f.tar.gz
src-324026700184917040f360aced5995856eea838f.zip
Move bin man pages to bin/man
Diffstat (limited to 'bin/man')
l---------bin/man/atch.11
-rw-r--r--bin/man/bin.756
-rw-r--r--bin/man/bri.144
-rw-r--r--bin/man/dtch.154
-rw-r--r--bin/man/fbatt.134
-rw-r--r--bin/man/fbclock.136
-rw-r--r--bin/man/glitch.177
-rw-r--r--bin/man/hnel.133
-rw-r--r--bin/man/klon.645
-rw-r--r--bin/man/modem.122
-rw-r--r--bin/man/pbd.159
-rw-r--r--bin/man/pngo.156
-rw-r--r--bin/man/scheme.152
-rw-r--r--bin/man/wake.116
-rw-r--r--bin/man/watch.135
-rw-r--r--bin/man/xx.159
16 files changed, 679 insertions, 0 deletions
diff --git a/bin/man/atch.1 b/bin/man/atch.1
new file mode 120000
index 00000000..9765e8d6
--- /dev/null
+++ b/bin/man/atch.1
@@ -0,0 +1 @@
+dtch.1
\ No newline at end of file
diff --git a/bin/man/bin.7 b/bin/man/bin.7
new file mode 100644
index 00000000..aab8b82e
--- /dev/null
+++ b/bin/man/bin.7
@@ -0,0 +1,56 @@
+.Dd September 11, 2018
+.Dt bin 7
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm bin
+.Nd various utilities
+.
+.Sh DESCRIPTION
+Various tools primarily targeting
+Darwin,
+FreeBSD
+and NetBSD.
+Some tools target Linux.
+.
+.Pp
+.Bl -tag -width "fbclock(1)" -compact
+.It Xr bri 1
+backlight brightness control
+.
+.It Xr dtch 1
+detached sessions
+.
+.It Xr fbatt 1
+framebuffer battery indicator
+.
+.It Xr fbclock 1
+framebuffer clock
+.
+.It Xr glitch 1
+PNG glitcher
+.
+.It Xr hnel 1
+PTY input remapper
+.
+.It Xr klon 6
+Klondike solitaire
+.
+.It Xr modem 1
+fixed baud rate wrapper
+.
+.It Xr pbd 1
+macOS pasteboard daemon
+.
+.It Xr pngo 1
+PNG optimizer
+.
+.It Xr wake 1
+wake-on-LAN
+.
+.It Xr watch 1
+watch files
+.
+.It Xr xx 1
+hexdump
+.El
diff --git a/bin/man/bri.1 b/bin/man/bri.1
new file mode 100644
index 00000000..6bec4653
--- /dev/null
+++ b/bin/man/bri.1
@@ -0,0 +1,44 @@
+.Dd September 7, 2018
+.Dt BRI 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm bri
+.Nd backlight brightness control
+.
+.Sh SYNOPSIS
+.Nm
+.Op Ar brightness
+.Nm
+.Cm +
+.Nm
+.Cm -
+.
+.Sh DESCRIPTION
+.Nm
+controls the backlight brightness on Linux.
+.
+.Pp
+With no argument,
+the current brightness is printed.
+With a numerical
+.Ar brightness
+argument,
+the brightness is set.
+.
+.Pp
+The
+.Cm +
+and
+.Cm -
+arguments
+may be repeated any number of times
+and adjust the brightness
+in increments of 16.
+.
+.Sh FILES
+.Bl -tag
+.It Pa /sys/class/backlight
+Files under the first subdirectory found
+are used to control the backlight brightness.
+.El
diff --git a/bin/man/dtch.1 b/bin/man/dtch.1
new file mode 100644
index 00000000..ad13c109
--- /dev/null
+++ b/bin/man/dtch.1
@@ -0,0 +1,54 @@
+.Dd September 7, 2018
+.Dt DTCH 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm dtch ,
+.Nm atch
+.Nd detached sessions
+.
+.Sh SYNOPSIS
+.Nm
+.Op Ar name Op Ar command ...
+.Nm atch
+.Op Ar name
+.
+.Sh DESCRIPTION
+.Nm
+spawns the
+.Ar command
+(by default, the user's shell)
+inside a new PTY.
+It then lends control of the detached PTY to
+.Nm atch
+over a UNIX-domain socket.
+.Nm
+should be run as a background job or with
+.Xr nohup 1 .
+.
+.Pp
+.Nm atch
+attaches to the
+.Nm
+session with the corresponding
+.Ar name .
+To detach from a session, type
+.Ic ^Q .
+.
+.Sh FILES
+.Bl -tag
+.It Pa ~/.dtch/ Ns Ar name
+UNIX-domain socket for the session
+.Ar name .
+.El
+.
+.Sh EXAMPLES
+.Bd -literal -offset indent
+dtch foo vim &
+atch foo
+.Ed
+.
+.Sh SEE ALSO
+.Xr nohup 1 ,
+.Xr screen 1 ,
+.Xr forkpty 3
diff --git a/bin/man/fbatt.1 b/bin/man/fbatt.1
new file mode 100644
index 00000000..73bc109c
--- /dev/null
+++ b/bin/man/fbatt.1
@@ -0,0 +1,34 @@
+.Dd September 7, 2018
+.Dt FBATT 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm fbatt
+.Nd framebuffer battery indicator
+.
+.Sh SYNOPSIS
+.Nm
+.
+.Sh DESCRIPTION
+.Nm
+displays a battery charge indicator
+in the top-right corner
+of the Linux framebuffer.
+.
+.Sh ENVIRONMENT
+.Bl -tag
+.It Ev FRAMEBUFFER
+The framebuffer device path.
+.El
+.
+.Sh FILES
+.Bl -tag
+.It Pa /dev/fb0
+The default framebuffer device path.
+.It Pa /sys/class/power_supply
+The first subdirectory containing
+.Pa charge_full
+and
+.Pa charge_now
+is used to read the battery charge.
+.El
diff --git a/bin/man/fbclock.1 b/bin/man/fbclock.1
new file mode 100644
index 00000000..b8efbf10
--- /dev/null
+++ b/bin/man/fbclock.1
@@ -0,0 +1,36 @@
+.Dd September 7, 2018
+.Dt FBCLOCK 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm fbclock
+.Nd framebuffer clock
+.
+.Sh SYNOPSIS
+.Nm
+.
+.Sh DESCRIPTION
+.Nm
+displays a clock
+in the top-right corner
+of the Linux framebuffer.
+.
+.Sh ENVIRONMENT
+.Bl -tag
+.It Ev FONT
+Path to gzipped PSF file.
+.
+.It Ev FRAMEBUFFER
+The framebuffer device path.
+.El
+.
+.Sh FILES
+.Bl -tag
+.It Pa /dev/fb0
+The default framebuffer device path.
+.It Pa /usr/share/kbd/consolefonts/Lat2-Terminus16.psfu.gz
+The default font path.
+.El
+.
+.Sh SEE ALSO
+.Xr setfont 8
diff --git a/bin/man/glitch.1 b/bin/man/glitch.1
new file mode 100644
index 00000000..f9c75527
--- /dev/null
+++ b/bin/man/glitch.1
@@ -0,0 +1,77 @@
+.Dd September 7, 2018
+.Dt GLITCH 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm glitch
+.Nd PNG glitcher
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl cfimprxy
+.Op Fl a Ar filters
+.Op Fl d Ar filters
+.Op Fl o Ar file
+.Op Ar
+.
+.Sh DESCRIPTION
+.Nm
+misinterprets PNG files
+according to the options given
+to create natural glitch effects.
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl a Ar filters
+Apply a pattern of comma-separated filters.
+Filters are
+.Cm none ,
+.Cm sub ,
+.Cm up ,
+.Cm average ,
+.Cm paeth .
+.
+.It Fl c
+Write to standard output.
+.
+.It Fl d Ar filters
+Declare a pattern of comma-separated filters.
+See
+.Fl a
+for list of filters.
+.
+.It Fl f
+Apply filtering in place of reconstruction.
+.
+.It Fl i
+Invert image data after filtering.
+.
+.It Fl m
+Mirror scanlines after filtering.
+.
+.It Fl o Ar file
+Write to
+.Ar file .
+.
+.It Fl p
+Use a broken Paeth predictor function.
+.
+.It Fl r
+Apply reconstruction in place of filtering.
+.
+.It Fl x
+Zero first pixel of each scanline after filtering.
+.
+.It Fl y
+Zero first scanline after filtering.
+.El
+.
+.Sh EXAMPLES
+.Dl glitch -m -a sub -d sub
+.
+.Sh SEE ALSO
+.Xr pngo 1
+.
+.Sh BUGS
+More wanted.
diff --git a/bin/man/hnel.1 b/bin/man/hnel.1
new file mode 100644
index 00000000..ab1c5149
--- /dev/null
+++ b/bin/man/hnel.1
@@ -0,0 +1,33 @@
+.Dd September 7, 2018
+.Dt HNEL 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm hnel
+.Nd PTY input remapper
+.
+.Sh SYNOPSIS
+.Nm
+.Ar string1
+.Ar string2
+.Ar command ...
+.
+.Sh DESCRIPTION
+.Nm
+runs the
+.Ar command
+in a new PTY,
+remapping input characters in
+.Ar string1
+to the corresponding characters in
+.Ar string2 .
+Type
+.Ic ^S
+to toggle remapping.
+.
+.Sh EXAMPLES
+.Dl hnel '[]{}' '{}[]' vim
+.
+.Sh SEE ALSO
+.Xr tr 1 ,
+.Xr forkpty 3
diff --git a/bin/man/klon.6 b/bin/man/klon.6
new file mode 100644
index 00000000..b78f1827
--- /dev/null
+++ b/bin/man/klon.6
@@ -0,0 +1,45 @@
+.Dd September 7, 2018
+.Dt KLON 6
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm klon
+.Nd Klondike solitaire
+.
+.Sh SYNOPSIS
+.Nm
+.
+.Sh DESCRIPTION
+.Nm
+is a curses Klondike solitaire game.
+.
+.Pp
+The keys are as follows:
+.Bl -tag -width Ds
+.It Ic q
+Quit.
+.
+.It Ic u
+Undo.
+.
+.It Ic space
+Draw from stock to waste.
+.
+.It Ic w
+Select waste.
+.
+.It Ic a-d
+Select foundation.
+.
+.It Ic 1-7
+Select tableau.
+.
+.It Ic enter
+Move to any foundation.
+.El
+.
+.Sh CAVEATS
+.Nm
+does not support Linux
+since it uses
+.Xr arc4random_uniform 3 .
diff --git a/bin/man/modem.1 b/bin/man/modem.1
new file mode 100644
index 00000000..175459b0
--- /dev/null
+++ b/bin/man/modem.1
@@ -0,0 +1,22 @@
+.Dd September 7, 2018
+.Dt MODEM 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm modem
+.Nd fixed baud rate wrapper
+.
+.Sh SYNOPSIS
+.Nm
+.Ar command ...
+.
+.Sh DESCRIPTION
+.Nm
+runs the
+.Ar command
+in a new PTY
+with a fixed baud rate
+of 19.2 kbps.
+.
+.Sh SEE ALSO
+.Xr forkpty 3
diff --git a/bin/man/pbd.1 b/bin/man/pbd.1
new file mode 100644
index 00000000..bb4380b0
--- /dev/null
+++ b/bin/man/pbd.1
@@ -0,0 +1,59 @@
+.Dd September 7, 2018
+.Dt PBD 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm pbd ,
+.Nm pbcopy ,
+.Nm pbpaste ,
+.Nm open
+.Nd macOS pasteboard daemon
+.
+.Sh SYNOPSIS
+.Nm
+.Nm pbcopy
+.Nm pbpaste
+.Nm open
+.Ar
+.
+.Sh DESCRIPTION
+.Nm
+is a daemon which pipes into macOS
+.Xr pbcopy 1 ,
+from
+.Xr pbpaste 1
+and invokes
+.Xr open 1
+in response to messages
+sent over TCP port 7062.
+.
+.Pp
+The socket can be forwarded through
+.Xr ssh 1
+and the stub implementations of
+.Nm pbcopy ,
+.Nm pbpaste
+and
+.Nm open
+can be used remotely
+to access the local pasteboard
+and open URLs.
+.
+.Pp
+Forwarding can be configured with:
+.Pp
+.Dl RemoteForward 7062 127.0.0.1:7062
+.
+.Sh EXAMPLES
+.Bd -literal -offset indent
+pbd &
+ssh -R 7062:127.0.0.1:7062 tux.local
+pbpaste
+.Ed
+.
+.Sh SEE ALSO
+.Xr open 1 ,
+.Xr pbcopy 1 ,
+.Xr pbpaste 1 ,
+.Xr ssh 1 ,
+.Xr ssh_config 5
diff --git a/bin/man/pngo.1 b/bin/man/pngo.1
new file mode 100644
index 00000000..4ba8a624
--- /dev/null
+++ b/bin/man/pngo.1
@@ -0,0 +1,56 @@
+.Dd September 7, 2018
+.Dt PNGO 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm pngo
+.Nd PNG optimizer
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl cv
+.Op Fl o Ar file
+.Op Ar
+.
+.Sh DESCRIPTION
+.Nm
+optimizes PNG files for size.
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl c
+Write to standard output.
+.It Fl o Ar file
+Write to
+.Ar file .
+.It Fl v
+Output PNG header information.
+.El
+.
+.Pp
+.Nm
+performs the following optimizations:
+.Bl -bullet
+.It
+Discard ancillary chunks.
+.It
+Discard unnecessary alpha channel.
+.It
+Convert unnecessary truecolor to grayscale.
+.It
+Palletize color if possible.
+.It
+Reduce bit depth if possible.
+.It
+Apply a simple filter heuristic.
+.It
+Apply zlib's best compresion.
+.El
+.
+.Sh SEE ALSO
+.Xr glitch 1
+.
+.Sh CAVEATS
+.Nm
+does not support interlaced PNGs.
diff --git a/bin/man/scheme.1 b/bin/man/scheme.1
new file mode 100644
index 00000000..ae11320d
--- /dev/null
+++ b/bin/man/scheme.1
@@ -0,0 +1,52 @@
+.Dd September 7, 2018
+.Dt SCHEME 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm scheme
+.Nd terminal color scheme
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl acghlmtx
+.
+.Sh DESCRIPTION
+.Nm
+generates a terminal color scheme
+and outputs it in a number of formats.
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl a
+Output only the 16 ANSI colors.
+.
+.It Fl c
+Output a C header file.
+.
+.It Fl g
+Output a swatch PNG.
+.
+.It Fl h
+Output HSV.
+.
+.It Fl l
+Output Linux console OSC sequences.
+.
+.It Fl m
+Output a
+.Xr mintty 1
+theme.
+.
+.It Fl t
+Additionally output terminal
+background,
+text,
+bold,
+selection
+and cursor
+colors.
+.
+.It Fl x
+Output hexadecimal RGB.
+.El
diff --git a/bin/man/wake.1 b/bin/man/wake.1
new file mode 100644
index 00000000..1966cf2a
--- /dev/null
+++ b/bin/man/wake.1
@@ -0,0 +1,16 @@
+.Dd September 7, 2018
+.Dt WAKE 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm wake
+.Nd wake-on-LAN
+.
+.Sh SYNOPSIS
+.Nm
+.
+.Sh DESCRIPTION
+.Nm
+broadcasts a wake-on-LAN packet
+for
+.Ql 04:7D:7B:D5:6A:53 .
diff --git a/bin/man/watch.1 b/bin/man/watch.1
new file mode 100644
index 00000000..fbcff86a
--- /dev/null
+++ b/bin/man/watch.1
@@ -0,0 +1,35 @@
+.Dd September 7, 2018
+.Dt WATCH 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm watch
+.Nd watch files
+.
+.Sh SYNOPSIS
+.Nm
+.Ar
+.Ar command
+.Nm
+.Ar
+.Fl -
+.Ar command
+.Op Ar argument ...
+.
+.Sh DESCRIPTION
+.Nm
+executes the
+.Ar command
+each time a
+.Ar file
+is modified.
+.
+.Sh EXAMPLES
+.Dl watch watch.c make
+.Dl watch wake.c watch.c -- make wake watch
+.
+.Sh CAVEATS
+.Nm
+does not support Linux
+since it uses
+.Xr kqueue 2 .
diff --git a/bin/man/xx.1 b/bin/man/xx.1
new file mode 100644
index 00000000..114c1340
--- /dev/null
+++ b/bin/man/xx.1
@@ -0,0 +1,59 @@
+.Dd September 7, 2018
+.Dt XX 1
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm xx
+.Nd hexdump
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl arsz
+.Op Fl c Ar cols
+.Op Fl g Ar group
+.Op Ar file
+.
+.Sh DESCRIPTION
+.Nm
+dumps the contents of a
+.Ar file
+or standard input
+in hexadecimal format.
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl a
+Toggle ASCII output.
+.
+.It Fl c Ar cols
+Output
+.Ar cols
+bytes per line.
+The default
+.Ar cols
+is 16.
+.
+.It Fl g Ar group
+Output extra space after every
+.Ar group
+bytes.
+The default
+.Ar group
+is 8.
+.
+.It Fl r
+Reverse hexdump.
+Read hexadecimal input
+and write byte output.
+.
+.It Fl s
+Toggle offset output.
+.
+.It Fl z
+Skip output of lines containing only zeros.
+.El
+.
+.Sh SEE ALSO
+.Xr hexdump 1 ,
+.Xr xxd 1