aboutsummaryrefslogtreecommitdiff
path: root/tg.1
blob: 7e983b47ca0c1ecc83a9a831addeec643becfab0 (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
.TH TG 1 2024-06-08
.SH name
tg \- TermGraph \- Text graphing utility
.SH SYNOPSIS
.B tg
[-s|--silent] [-l|--last-n \fIN\fR] [-h|--height \fIN\fR] [-w|--width \fIN\fR] [-t \fItype\fR]

.SH DESCRIPTION
.B tg
TermGraph is a utility for graphing

.SH OPTIONS
.IP "\fB-h, --help\fR"
Display help information.

.IP "\fB-s, --silent\fR"
Disable distracting elements, such as axis and non-graph text.

.IP "\fB-a, --ascii\fR"
Shorthand for -t ascii, if multiple options setting mode is specified, 
the last will likely be respected.

.IP "\fB-b, --braille\fR"
Shorthand for -t braille, if multiple options setting mode is specified, 
the last will likely be respected.

.IP "\fB-n, --last-n\fR \fIcount\fR"
If specified, only the newest \fIcount\fR samples will be plotted.
This can be useful if you want to follow the latest state of a graph that is piped in.

.IP "\fB-c, --cut\fR"
This is a special case of \fB--last-n\fR. Where the number of columns 
\fB--width\fI will be used for the count.

.IP "\fB-t\fR \fItype\fR"
The type of graph to draw,
it defaults to \fBstar\fR, which is the fastest one.
Options are \fBstar\fR, \fBascii\fR and \fBbraille\fR.
Ascii is slightly prettier to look at.

.IP "\fB-w, --width\fR \fIwidth\fR"
Specify a width for the output. 
If not specified, it will attempt to determine the TTY width and use that.
If it cannot be automatically determined, it will fail.

.IP "\fB-h, --height\fR \fIheight\fR"
Specify a height for the output. 
If not specified, it will attempt to determine the TTY height and use that.
If it cannot be automatically determined, it will fail.

.IP "\fB--color\fR \fIyes\fR|\fIno\fR"
Enable or disable colors, by default color will be enabled if it looks like a tty is connected.

It can therefore be nice to use \fB--color yes\fR
if you are piping the output into another program that supports colors.

.SH EXAMPLES

The simplest version is if you have a text file of values
.PP
.nf
.RS
cat \fIfile\fR | tg
.RE
.fi
.PP