summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2019-07-14 13:32:48 -0400
committerJune McEnroe <june@causal.agency>2019-07-14 13:32:48 -0400
commit5a8d6a88d24b9e3a1e2c05cd5fbe681c14cb9caa (patch)
tree47150791e9a7447ab0f5369979dc76928aa27ea2
parentFix OSC PT handling (diff)
downloadsrc-5a8d6a88d24b9e3a1e2c05cd5fbe681c14cb9caa.tar.gz
src-5a8d6a88d24b9e3a1e2c05cd5fbe681c14cb9caa.zip
Add more info to shotty man page
-rw-r--r--bin/man1/shotty.128
1 files changed, 26 insertions, 2 deletions
diff --git a/bin/man1/shotty.1 b/bin/man1/shotty.1
index 025ff293..349e603e 100644
--- a/bin/man1/shotty.1
+++ b/bin/man1/shotty.1
@@ -23,8 +23,28 @@ or standard input
 and produces HTML
 .Sy <pre>
 on standard output.
-Terminal output can be captured with
+.
+.Pp
+Terminal output
+can be captured with
 .Xr ptee 1 .
+.Nm
+targets compatibility with
+.Ev TERM Ns = Ns Cm xterm
+and
+.Ev TERM Ns = Ns Cm xterm-256color
+as used by
+.Xr ncurses 3 .
+.
+.Pp
+HTML output uses the classes
+.Sy bg Ns Va n
+and
+.Sy fg Ns Va n ,
+and inline styles for
+bold, italic and underline.
+CSS for colors can be generated with
+.Xr scheme 1 .
 .
 .Pp
 The arguments are as follows:
@@ -61,5 +81,9 @@ Set the terminal width.
 The default value is 80.
 .El
 .
+.Sh EXAMPLES
+.Dl ptee htop | shotty -s > htop.html
+.
 .Sh SEE ALSO
-.Xr ptee 1
+.Xr ptee 1 ,
+.Xr scheme 1