update manpage for trapezium mode - gramscii - A simple editor for ASCII box-an… | |
Log | |
Files | |
Refs | |
Tags | |
README | |
LICENSE | |
--- | |
commit a30a9afd8016c424b3b6d0ddbe68efedc93e43ae | |
parent c5123472d732ee8d512c914707251b0053d758e1 | |
Author: KatolaZ <[email protected]> | |
Date: Sun, 29 Sep 2019 21:31:53 +0100 | |
update manpage for trapezium mode | |
Diffstat: | |
M gramscii.1 | 54 ++++++++++++++++++++++++++---… | |
1 file changed, 45 insertions(+), 9 deletions(-) | |
--- | |
diff --git a/gramscii.1 b/gramscii.1 | |
@@ -1,4 +1,4 @@ | |
-.TH GRAMSCII 1 "19/07/2019" "" "" | |
+.TH GRAMSCII 1 "28/09/2019" "" "" | |
.SH NAME | |
gramscii \- simple editor for ASCII box diagrams | |
.SH SYNOPSIS | |
@@ -11,8 +11,8 @@ gramscii | |
.SH DESCRIPTION | |
.PP | |
gramscii is a simple interactive editor to create ASCII box-and-arrows | |
-diagrams. It uses vi-like keybindings for drawing and editing boxes, | |
-arrows, and text. | |
+diagrams. It uses vi-like keybindings for drawing and editing boxes | |
+(rectangles, palallelograms, trapezia, triangles), arrows, and text. | |
.PP | |
.SH OPTIONS | |
.TP 5m | |
@@ -163,7 +163,7 @@ entered. Useful to include comments in scripts. | |
.SS MOVEMENTS | |
The following movement commands are available in any mode where cursor | |
movements are meaningful, currently only | |
-.B move, box, arrow, erase, | |
+.B move, box, arrow, parallelogram, trapezium, erase, | |
and | |
.B visual | |
(see | |
@@ -255,7 +255,7 @@ is equivalent to | |
). | |
.PP | |
Global positioning commands are available in | |
-.B box, arrow, visual, parallelogram, | |
+.B box, arrow, visual, parallelogram, trapezium, | |
and | |
.B erase | |
mode. Notice that | |
@@ -287,8 +287,9 @@ will move the cursor by 14 steps to the left. Similarily, t… | |
will move the cursor by 7 LONG_STEPs rows down (with the default | |
LONG_STEP equal to 5, this will correspond to 35 rows down). | |
.PP | |
-Multipliers can be used whenever a movement command is legal, i.e. in | |
-move, box, arrox, visual, and erase mode. So for instance the sequence: | |
+Multipliers can be used whenever a movement command is legal, i.e. in | |
+move, box, arrox, parallelogram, trapezium, visual, and erase mode. So | |
+for instance the sequence: | |
.RS | |
ggb13l18jb | |
.PP | |
@@ -304,6 +305,7 @@ The currently supported modes are: | |
.B move, | |
.B box, | |
.B parallelogram, | |
+.B trapezium, | |
.B arrow, | |
.B erase, | |
.B text, | |
@@ -373,6 +375,32 @@ and gramscii will return to | |
.B move | |
mode. | |
.TP 7m | |
+.BI t | |
+Toggle | |
+.B trapezium | |
+mode. All moves in | |
+.B trapezium | |
+mode identify the bounding box of a trapezium (see | |
+.B MOVEMENTS | |
+above). A trapezium with a short horizontal side of length zero is a | |
+triangle, and gramscii knows that. By default, the trapezium is | |
+isosceles, with the short side up. | |
+Pressing | |
+.B T | |
+while in trapezium mode toggles the type and orientation of the | |
+trapezium. Press | |
+.BI t | |
+again or | |
+.B [ENTER] | |
+to draw the current trapezium and return to | |
+.B move | |
+mode. If you press | |
+.B [ESC] | |
+while in trapezium mode, the current trapezium will be discarded | |
+and gramscii will return to | |
+.B move | |
+mode. | |
+.TP 7m | |
.BI a | |
Toggle | |
.B arrow | |
@@ -515,7 +543,8 @@ in | |
.B box, | |
and | |
.B arrow | |
-mode. The following style commands are available: | |
+mode. Some caveats apply to parallelogram and trapezium mode though (see | |
+BUGS). The following style commands are available: | |
.TP 5m | |
.B . | |
(dot) Reset all styles to their default values. | |
@@ -576,6 +605,8 @@ Current mode. It is one of | |
(box), | |
.B par | |
(parallelogram), | |
+.B trp | |
+(trapezium), | |
.B arr | |
(arrow), | |
.B txt | |
@@ -635,7 +666,12 @@ screen where it starts from. This will be changed in a fut… | |
support scrolling and "virtual" screens of any (reasonable) size. | |
.PP | |
It is not currently possible to change the style of the oblique sides of | |
-a parallelogram. | |
+a parallelogram or of a trapezium. | |
+.PP | |
+The trapezium routine does not handle well the case of trapezia whose | |
+height would yield a negative length for the small horizontal side. | |
+Nevertheless, an exceptionally creative user might consider this a | |
+feature, rather than a bug. | |
.SH AUTHORS | |
gramscii is written and maintained by Vincenzo "KatolaZ" Nicosia | |
<[email protected]>. You can use, copy, modify, and redistribute |