From 260b43450938e23b669b4f78b446197309ac4c69 Mon Sep 17 00:00:00 2001 From: Curtis McEnroe Date: Tue, 11 Sep 2018 15:13:30 -0400 Subject: Add "blank" lines to man pages --- bin/README.7 | 6 ++++++ bin/bri.1 | 6 ++++++ bin/dtch.1 | 21 +++++++++++++++------ bin/fbatt.1 | 5 +++++ bin/fbclock.1 | 7 +++++++ bin/glitch.1 | 17 +++++++++++++++++ bin/hnel.1 | 7 ++++++- bin/klon.6 | 11 +++++++++++ bin/modem.1 | 6 +++++- bin/pbd.1 | 18 +++++++++++++----- bin/pngo.1 | 7 +++++++ bin/scheme.1 | 11 +++++++++++ bin/wake.1 | 3 +++ bin/watch.1 | 9 +++++++-- bin/xx.1 | 10 ++++++++++ gfx/README.7 | 4 ++++ gfx/brot.1 | 15 +++++++++++++++ gfx/gfxx.1 | 35 +++++++++++++++++++++++++++++++++++ 18 files changed, 183 insertions(+), 15 deletions(-) diff --git a/bin/README.7 b/bin/README.7 index 16ef3120..b8b272b0 100644 --- a/bin/README.7 +++ b/bin/README.7 @@ -1,24 +1,30 @@ .Dd September 7, 2018 .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 , diff --git a/bin/bri.1 b/bin/bri.1 index 95250cda..6bec4653 100644 --- a/bin/bri.1 +++ b/bin/bri.1 @@ -1,9 +1,11 @@ .Dd September 7, 2018 .Dt BRI 1 .Os "Causal Agency" +. .Sh NAME .Nm bri .Nd backlight brightness control +. .Sh SYNOPSIS .Nm .Op Ar brightness @@ -11,9 +13,11 @@ .Cm + .Nm .Cm - +. .Sh DESCRIPTION .Nm controls the backlight brightness on Linux. +. .Pp With no argument, the current brightness is printed. @@ -21,6 +25,7 @@ With a numerical .Ar brightness argument, the brightness is set. +. .Pp The .Cm + @@ -30,6 +35,7 @@ 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 diff --git a/bin/dtch.1 b/bin/dtch.1 index b3780e36..ad13c109 100644 --- a/bin/dtch.1 +++ b/bin/dtch.1 @@ -1,16 +1,18 @@ .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 ..." +.Op Ar name Op Ar command ... .Nm atch .Op Ar name +. .Sh DESCRIPTION .Nm spawns the @@ -23,6 +25,7 @@ over a UNIX-domain socket. .Nm should be run as a background job or with .Xr nohup 1 . +. .Pp .Nm atch attaches to the @@ -31,14 +34,20 @@ session with the corresponding .Ar name . To detach from a session, type .Ic ^Q . +. .Sh FILES .Bl -tag -.It Pa ~/.dtch -Location of UNIX-domain sockets for each session. +.It Pa ~/.dtch/ Ns Ar name +UNIX-domain socket for the session +.Ar name . .El +. .Sh EXAMPLES -.Dl dtch foo vim & -.Dl atch foo +.Bd -literal -offset indent +dtch foo vim & +atch foo +.Ed +. .Sh SEE ALSO .Xr nohup 1 , .Xr screen 1 , diff --git a/bin/fbatt.1 b/bin/fbatt.1 index 5d648827..73bc109c 100644 --- a/bin/fbatt.1 +++ b/bin/fbatt.1 @@ -1,21 +1,26 @@ .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 diff --git a/bin/fbclock.1 b/bin/fbclock.1 index 32dafefe..b8efbf10 100644 --- a/bin/fbclock.1 +++ b/bin/fbclock.1 @@ -1,23 +1,29 @@ .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 @@ -25,5 +31,6 @@ 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/glitch.1 b/bin/glitch.1 index b667e87f..f9c75527 100644 --- a/bin/glitch.1 +++ b/bin/glitch.1 @@ -1,9 +1,11 @@ .Dd September 7, 2018 .Dt GLITCH 1 .Os "Causal Agency" +. .Sh NAME .Nm glitch .Nd PNG glitcher +. .Sh SYNOPSIS .Nm .Op Fl cfimprxy @@ -11,11 +13,13 @@ .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 @@ -27,34 +31,47 @@ Filters are .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/hnel.1 b/bin/hnel.1 index 862b03f6..ab1c5149 100644 --- a/bin/hnel.1 +++ b/bin/hnel.1 @@ -1,14 +1,17 @@ .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 ..." +.Ar command ... +. .Sh DESCRIPTION .Nm runs the @@ -21,8 +24,10 @@ to the corresponding characters in Type .Ic ^S to toggle remapping. +. .Sh EXAMPLES .Dl hnel '[]{}' '{}[]' vim +. .Sh SEE ALSO .Xr tr 1 , .Xr forkpty 3 diff --git a/bin/klon.6 b/bin/klon.6 index 414f961f..b78f1827 100644 --- a/bin/klon.6 +++ b/bin/klon.6 @@ -1,32 +1,43 @@ .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 diff --git a/bin/modem.1 b/bin/modem.1 index 157aaf53..175459b0 100644 --- a/bin/modem.1 +++ b/bin/modem.1 @@ -1,12 +1,15 @@ .Dd September 7, 2018 .Dt MODEM 1 .Os "Causal Agency" +. .Sh NAME .Nm modem .Nd fixed baud rate wrapper +. .Sh SYNOPSIS .Nm -.Ar "command ..." +.Ar command ... +. .Sh DESCRIPTION .Nm runs the @@ -14,5 +17,6 @@ runs the in a new PTY with a fixed baud rate of 19.2 kbps. +. .Sh SEE ALSO .Xr forkpty 3 diff --git a/bin/pbd.1 b/bin/pbd.1 index 0c6bad1f..bb4380b0 100644 --- a/bin/pbd.1 +++ b/bin/pbd.1 @@ -1,18 +1,21 @@ .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 @@ -23,6 +26,7 @@ and invokes .Xr open 1 in response to messages sent over TCP port 7062. +. .Pp The socket can be forwarded through .Xr ssh 1 @@ -34,15 +38,19 @@ and 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 -RemoteForward 7062 127.0.0.1:7062 +pbd & +ssh -R 7062:127.0.0.1:7062 tux.local +pbpaste .Ed -.Sh EXAMPLES -.Dl pbd & -.Dl ssh -R 7062:127.0.0.1:7062 tux.local -.Dl pbpaste +. .Sh SEE ALSO .Xr open 1 , .Xr pbcopy 1 , diff --git a/bin/pngo.1 b/bin/pngo.1 index cb4c2abe..4ba8a624 100644 --- a/bin/pngo.1 +++ b/bin/pngo.1 @@ -1,17 +1,21 @@ .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 @@ -23,6 +27,7 @@ Write to .It Fl v Output PNG header information. .El +. .Pp .Nm performs the following optimizations: @@ -42,8 +47,10 @@ 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/scheme.1 b/bin/scheme.1 index 2d1c1913..ae11320d 100644 --- a/bin/scheme.1 +++ b/bin/scheme.1 @@ -1,33 +1,43 @@ .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, @@ -36,6 +46,7 @@ bold, selection and cursor colors. +. .It Fl x Output hexadecimal RGB. .El diff --git a/bin/wake.1 b/bin/wake.1 index 7e49f37b..1966cf2a 100644 --- a/bin/wake.1 +++ b/bin/wake.1 @@ -1,11 +1,14 @@ .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 diff --git a/bin/watch.1 b/bin/watch.1 index 761fcc67..fbcff86a 100644 --- a/bin/watch.1 +++ b/bin/watch.1 @@ -1,18 +1,21 @@ .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 -.Cm -- +.Fl - .Ar command -.Op Ar "argument ..." +.Op Ar argument ... +. .Sh DESCRIPTION .Nm executes the @@ -20,9 +23,11 @@ executes the 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 diff --git a/bin/xx.1 b/bin/xx.1 index 09aa8795..114c1340 100644 --- a/bin/xx.1 +++ b/bin/xx.1 @@ -1,26 +1,31 @@ .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 @@ -28,6 +33,7 @@ bytes per line. The default .Ar cols is 16. +. .It Fl g Ar group Output extra space after every .Ar group @@ -35,15 +41,19 @@ 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 diff --git a/gfx/README.7 b/gfx/README.7 index 5d05d3be..de29c37f 100644 --- a/gfx/README.7 +++ b/gfx/README.7 @@ -1,14 +1,17 @@ .Dd September 8, 2018 .Dt README 7 .Os "Causal Agency" +. .Sh NAME .Nm gfx .Nd graphical utilities +. .Sh DESCRIPTION Graphial tools targeting Cocoa, X11 and Linux framebuffer. +. .Pp To build, run one of: .Bd -literal -offset indent @@ -16,6 +19,7 @@ make GFX=cocoa make GFX=x11 make GFX=fb .Ed +. .Sh SEE ALSO .Xr brot 1 , .Xr gfxx 1 diff --git a/gfx/brot.1 b/gfx/brot.1 index 4480f45b..71a0da01 100644 --- a/gfx/brot.1 +++ b/gfx/brot.1 @@ -1,48 +1,63 @@ .Dd September 8, 2018 .Dt BROT 1 .Os "Causal Agency" +. .Sh NAME .Nm brot .Nd Mandelbrot renderer +. .Sh SYNOPSIS .Nm .Op Fl i Ar depth .Op Fl s Ar samples .Op Fl t Ar a+bi .Op Fl f Ar a+bi +. .Sh DESCRIPTION .Nm renders the Mandelbrot set in grayscale. +. .Pp The arguments are as follows: .Bl -tag -width Ds .It Fl f Ar a+bi Set complex transform factor. +. .It Fl i Ar depth Set number of iterations. +. .It Fl s Ar samples Set number of samples per pixel. +. .It Fl t Ar a+bi Set complex translation term. .El +. .Pp The interactive keys are as follows: .Bl -tag -width Ds .It Ic q Quit. +. .It Ic ,. Adjust depth. +. .It Ic [] Adjust samples. +. .It Ic hl Adjust real component of translation. +. .It Ic kj Adjust imaginary componenent of translation. +. .It Ic ui Adjust rotation. +. .It Ic -+ Adjust scale. +. .It Ic 0 Reset translation and transform. .El diff --git a/gfx/gfxx.1 b/gfx/gfxx.1 index a29b14e0..19a25c10 100644 --- a/gfx/gfxx.1 +++ b/gfx/gfxx.1 @@ -1,9 +1,11 @@ .Dd September 8, 2018 .Dt GFXX 1 .Os "Causal Agency" +. .Sh NAME .Nm gfxx .Nd graphics data explorer +. .Sh SYNOPSIS .Nm .Op Fl fm @@ -16,15 +18,18 @@ .Op Fl w Ar width .Op Fl z Ar scale .Op Fl o Ar prefix +. .Sh DESCRIPTION .Nm is an interactive graphics data explorer capable of dumping PNGs. +. .Pp The arguments are as follows: .Bl -tag -width Ds .It Fl E Ar lb Set bit order to little or big endian. +. .It Fl b Ar bits Set number of bits of padding, red, @@ -32,72 +37,102 @@ green and blue components. Four digits are required. +. .It Fl c Ar space Set color space to one of .Cm indexed , .Cm grayscale , .Cm rgb . +. .It Fl e Ar lb Set byte order to little or big endian. +. .It Fl f Flip display vertically. +. .It Fl m Mirror display horizontally. +. .It Fl n Ar offset Set byte offset into data. +. .It Fl o Ar prefix Set PNG output filename prefix. +. .It Fl p Ar file Load indexed color palette from .Ar file . +. .It Fl w Ar width Set display column width. +. .It Fl z Ar scale Set display scale. .El +. .Pp The interactive keys are as follows: .Bl -tag -width Ds .It Ic q Quit. +. .It Ic x Export one frame as PNG. +. .It Ic X Export each frame as PNG. +. .It Ic o Print interactive options. +. .It Ic [] Select color space. +. .It Ic p Sample indexed palette from top-left corner. +. .It Ic P Export indexed palette as RGB data. +. .It Ic {} Select bits preset. +. .It Ic e Toggle byte order. +. .It Ic E Toggle bit order. +. .It Ic hl Adjust offset by byte. +. .It Ic jk Adjust offset by pixel. +. .It Ic HL Adjust offset by pixel row. +. .It Ic JK Adjust offset by pixel row square. +. .It Ic ,. Adjust display column width. +. .It Ic <> Adjust display column width by half or double. +. .It Ic f Toggle vertically flipped display. +. .It Ic m Toggle horizontally mirrored display. +. .It Ic -+ Adjust display scale. +. .It Ic 0-9 Set bits. .El +. .Sh SEE ALSO .Xr pngo 1 -- cgit 1.4.1