From 6402d53121dfff681f1a5a7e08c3580c72851eb9 Mon Sep 17 00:00:00 2001 From: jakobst1n Date: Wed, 12 Jun 2024 16:10:00 +0200 Subject: Add help text --- tg.1 | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) (limited to 'tg.1') diff --git a/tg.1 b/tg.1 index 7e983b4..0bea23f 100644 --- a/tg.1 +++ b/tg.1 @@ -2,28 +2,19 @@ .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] +.B tg [OPTIONS] [\fIinput_file\fB] .SH DESCRIPTION .B tg TermGraph is a utility for graphing .SH OPTIONS -.IP "\fB-h, --help\fR" +.IP "\fB--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. @@ -32,12 +23,27 @@ This can be useful if you want to follow the latest state of a graph that is pip 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" +.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-t\fR \fIstar\fR|\fIascii\fR|\fIbraille\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. + +\fBstar\fR +Scatter plot using only the '*' character. + +\fBascii\fR Ascii is slightly prettier to look at. +\fBbraille\fR +This is the most scatter-plot-ish with the highest resolution, but also the most buggy. + .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. -- cgit v1.2.3