aboutsummaryrefslogtreecommitdiff
path: root/tg.1
diff options
context:
space:
mode:
authorjakobst1n <jakob.stendahl@outlook.com>2024-06-08 22:40:49 +0200
committerjakobst1n <jakob.stendahl@outlook.com>2024-06-08 22:40:49 +0200
commit4e6a860b275abda39ade147ee7cdc48a3520212a (patch)
tree50102e75438ca2ada76bbf7d3e6b462f3af5e8af /tg.1
parent136502f371851efec48426d424115e136033c157 (diff)
downloadtextgraph-4e6a860b275abda39ade147ee7cdc48a3520212a.tar.gz
textgraph-4e6a860b275abda39ade147ee7cdc48a3520212a.zip
Add simple readme and manual, add script to build debian package
Diffstat (limited to 'tg.1')
-rw-r--r--tg.138
1 files changed, 38 insertions, 0 deletions
diff --git a/tg.1 b/tg.1
new file mode 100644
index 0000000..7892d32
--- /dev/null
+++ b/tg.1
@@ -0,0 +1,38 @@
+.TH TG 1 2024-06-08
+.SH name
+tg \- TermGraph \- Text graphing utility
+.SH SYNOPSIS
+.B tg
+[-a|--axis] [-l|--last-n \fIN\fR] [-h|--height \fIN\fR] [-w|--width \fIN\fR] [-t \fItype\fR] [--interpolate]
+
+.SH DESCRIPTION
+.B tg
+TermGraph is a utility for graphing
+
+.SH OPTIONS
+.IP "\fB-h, --help\fR"
+Display help information.
+
+.IP "\fB-a, --axis\fR"
+Enable axis on the resulting graph.
+
+.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.
+
+.SH EXAMPLES
+
+The simplest version is if you have a text file of values
+.PP
+.nf
+.RS
+cat \fIfile\fR | tg --axis
+.RE
+.fi
+.PP