summary refs log tree commit diff
path: root/bin/man1/shotty.1
diff options
context:
space:
mode:
Diffstat (limited to 'bin/man1/shotty.1')
-rw-r--r--bin/man1/shotty.192
1 files changed, 92 insertions, 0 deletions
diff --git a/bin/man1/shotty.1 b/bin/man1/shotty.1
new file mode 100644
index 00000000..d5eaa780
--- /dev/null
+++ b/bin/man1/shotty.1
@@ -0,0 +1,92 @@
+.Dd November 25, 2019
+.Dt SHOTTY 1
+.Os
+.
+.Sh NAME
+.Nm shotty
+.Nd terminal capture
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl Bdns
+.Op Fl b Ar bg
+.Op Fl f Ar fg
+.Op Fl h Ar rows
+.Op Fl w Ar cols
+.Op Ar file
+.
+.Sh DESCRIPTION
+.Nm
+interprets terminal output from
+.Ar file
+or standard input
+and produces HTML
+.Sy <pre>
+on standard output.
+.
+.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 .
+A snapshot of the terminal
+is output each time
+a media copy sequence occurs,
+or once at the end of the capture.
+.
+.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:
+.Bl -tag -width "-w cols"
+.It Fl B
+Replace bold with bright colors.
+.
+.It Fl b Ar bg
+Set the default background color.
+The default value is 0 (black).
+.
+.It Fl d
+Output the terminal state
+following each control sequence.
+.
+.It Fl f Ar fg
+Set the default foreground color.
+The default value is 7 (white).
+.
+.It Fl h Ar rows
+Set the terminal height.
+The default value is 24.
+.
+.It Fl n
+Do not show the cursor.
+.
+.It Fl s
+Set the terminal size
+from the current terminal size.
+.
+.It Fl w Ar cols
+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 scheme 1