summary refs log tree commit diff
path: root/bin/man1/shotty.1
blob: d5eaa780f5bb7965f2cf3fad036cda3d83624701 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
tr> 2022-10-21Update to OpenBSD 7.2 2063.9June McEnroe 2022-10-16NetBSD: include text.tar.xz man pages 2063.8Štěpán Němec 2022-10-16Update to Linux man-mages 6.00Štěpán Němec Relax FILES pattern to include the newly added man2type, man3const, man3head and man3type. 2022-10-16Update to NetBSD 9.3Štěpán Němec 2022-09-18Make copyrights and AUTHORS consistentJune McEnroe 2022-07-27Update to FreeBSD 13.1 2062.83June McEnroe 2022-07-27openbsd: Include man pages from baseXX.tgzKeith Whitney A number of OpenBSD man pages are currently missing in exman, since they reside in OpenBSD's baseXX.tgz [1]: - help(1) - man(1) - pkg_add(1) - OpenBSD::BaseState(3p) - packages(7) - adduser(8) - afterboot(8) - user(8) - useradd(8) - userdel(8) - userinfo(8) - usermod(8) This patch adds baseXX.tgz to the OpenBSD distfiles, which begrudgingly adds ~330 MiB to the install. I figure this might acceptable since base.txz is similarly fetched for FreeBSD. Since this isn't ideal, I'll look into whether these man pages are intended to be in baseXX.tgz or not. If not, I'll see about changing this upstream, and this patch can be reverted. [1] Lines 2876-2931: https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/distrib/sets/lists/base/mi?annotate=1.1065 2022-05-08Update to OpenBSD 7.1 2062.73June McEnroe 2021-10-15Update to OpenBSD 7.0 2062.63June McEnroe 2021-08-29Update to Linux man-pages 5.13 2062.53Štěpán Němec 2021-08-26Update to NetBSD 9.2 2062.52June McEnroe 2021-08-26Support DESTDIR in install/uninstallJune McEnroe 2021-08-26Add version number generatorJune McEnroe 2021-08-22Add ISC license headerJune McEnroe 2021-08-22Update to Linux man-pages 5.12Štěpán Němec 2021-06-21Add manuals for macOS 11.3June McEnroe 2021-05-08Update to OpenBSD 6.9June McEnroe 2021-04-26Update to Linux man-pages 5.11June McEnroe 2021-04-26Update to FreeBSD 13.0June McEnroe 2021-01-27Completely rewrite how manuals are fetched and installedJune McEnroe Also add section 6 manuals from NetBSD and OpenBSD! 2020-12-14Update to man-pages-posix 2017-aJune McEnroe 2020-12-14Update to OpenBSD 6.8June McEnroe 2020-12-14Update to NetBSD 9.1June McEnroe 2020-12-14Update to man-pages 5.09June McEnroe 2020-12-14Update to FreeBSD 12.2June McEnroe 2020-06-08Update to OpenBSD 6.7June McEnroe 2020-05-04Add hack for macOS to search extra man sectionsJune McEnroe 2020-05-04Don't clear MANSECTJune McEnroe