aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjakobst1n <jakob.stendahl@outlook.com>2024-06-12 01:44:46 +0200
committerjakobst1n <jakob.stendahl@outlook.com>2024-06-12 01:44:46 +0200
commit29e5f0102073462d300be8458240c9699d403d55 (patch)
tree36d7e23cd2ceed8b1f89eae642a6684d22cbc5e1
parentb259af1b4bb64c5033bd9ad155f2ef45938c8584 (diff)
downloadtextgraph-29e5f0102073462d300be8458240c9699d403d55.tar.gz
textgraph-29e5f0102073462d300be8458240c9699d403d55.zip
Add manual page to readme
-rw-r--r--README.md76
1 files changed, 76 insertions, 0 deletions
diff --git a/README.md b/README.md
index f0e1a26..11b698b 100644
--- a/README.md
+++ b/README.md
@@ -97,3 +97,79 @@ Example of a simple sinusoid
-8 │⠉⠉⠉⠒⠄ ⠠⠒⠉⠉⠉⠒│
-10└───────────────────────────────────┘
```
+
+## Manual
+For reference, this is a translation of the manual page.
+Best is to check to manual page itself, not the README `man -l tg.1`.
+```
+TG(1) General Commands Manual TG(1)
+
+
+
+name
+ tg - TermGraph - Text graphing utility
+
+SYNOPSIS
+ tg [-s|--silent] [-l|--last-n N] [-h|--height N] [-w|--width N] [-t
+ type]
+
+
+DESCRIPTION
+ tg TermGraph is a utility for graphing
+
+
+OPTIONS
+ -h, --help
+ Display help information.
+
+
+ -s, --silent
+ Disable distracting elements, such as axis and non-graph text.
+
+
+ -a, --ascii
+ Shorthand for -t ascii, if multiple options setting mode is
+ specified, the last will likely be respected.
+
+
+ -b, --braille
+ Shorthand for -t braille, if multiple options setting mode is
+ specified, the last will likely be respected.
+
+
+ -n, --last-n count
+ If specified, only the newest count samples will be plotted.
+ This can be useful if you want to follow the latest state of a
+ graph that is piped in.
+
+
+ -c, --cut
+ This is a special case of --last-n. Where the number of columns
+ --width will be used for the count.
+
+
+ -t type
+ The type of graph to draw, it defaults to star, which is the
+ fastest one. Options are star, ascii and braille. Ascii is
+ slightly prettier to look at.
+
+
+ -w, --width width
+ Specify a width for the output. If not specified, it will at‐
+ tempt to determine the TTY width and use that. If it cannot be
+ automatically determined, it will fail.
+
+
+ -h, --height height
+ Specify a height for the output. If not specified, it will at‐
+ tempt to determine the TTY height and use that. If it cannot be
+ automatically determined, it will fail.
+
+
+EXAMPLES
+ The simplest version is if you have a text file of values
+
+ cat file | tg
+
+ 2024-06-08 TG(1)
+```