update manpage to include parallelogram - gramscii - A simple editor for ASCII box-and-arrow charts
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) Tags
(DIR) README
(DIR) LICENSE
---
(DIR) commit 0940cd06c4a36b4794c48ebc703559caf7d53c53
(DIR) parent a95019dfe0b64ed01051f2f059af7d7756d0dcdb
(HTM) Author: KatolaZ <katolaz@freaknet.org>
Date: Wed, 14 Aug 2019 08:00:17 +0100
update manpage to include parallelogram
Diffstat:
M gramscii.1 | 45 +++++++++++++++++++++++++------
1 file changed, 37 insertions(+), 8 deletions(-)
---
(DIR) diff --git a/gramscii.1 b/gramscii.1
@@ -271,6 +271,7 @@ starting with
The currently supported modes are:
.B move,
.B box,
+.B parallelogram,
.B arrow,
.B erase,
.B text,
@@ -300,7 +301,7 @@ above). When you are happy with the shape of your box, just press
.B b
again or
.B [ENTER]
-to draw the current box permanently and get back to
+to draw the current box permanently and return to
.B move
mode. The horizontal and vertical borders of the box are drawn using
the current
@@ -313,10 +314,33 @@ style, See
.B STYLES
below for more information. If you press
.B [ESC]
-while in box mode, gramscii will come back to
+while in box mode, gramscii will return to
.B move
mode discarding the current box.
.TP 7m
+.BI z
+Toggle
+.B parallelogram
+mode. All moves in
+.B parallelogram
+mode identify the bounding box of a parallelogram (see
+.B MOVEMENTS
+above). By default the parallelogram leans to the right. Pressing
+.B Z
+while in parallelogram mode toggles the direction towards which the
+parallelogram leans. Press
+.BI z
+again or
+.B [ENTER]
+to draw the current parallelogram and return to
+.B move
+mode. If you press
+.B [ESC]
+while in parallelogram mode, the current parallelogram will be discarded
+and gramscii will return to
+.B move
+mode.
+.TP 7m
.BI a
Toggle
.B arrow
@@ -326,11 +350,11 @@ mode change the position of the end-point of the current arrow. Press
.BI a
again or
.B [ENTER]
-to draw the current arrow and come back to
+to draw the current arrow and return to
.B move
mode. If you press
.B [ESC]
-while in box mode, gramscii will come back to
+while in arrow mode, gramscii will return to
.B move
mode discarding the current arrow. The horizontal and vertical segments
of the arrow are drawn using the current
@@ -388,7 +412,7 @@ was typed. Press
.B [ESC]
to exit
.B text
-mode and get back to
+mode and return to
.B move
mode.
.TP 7m
@@ -429,7 +453,7 @@ Everything else in the screen is erased.
.BI v
leave
.B visual
-mode and get back to
+mode and return to
.B move
mode.
.TP 5m
@@ -438,7 +462,7 @@ same as
.BI v,
i.e., leave
.B visual
-mode and get back to
+mode and return to
.B move
mode.
.TP 5m
@@ -447,7 +471,7 @@ same as
.BI v,
i.e., leave
.B visual
-mode and get back to
+mode and return to
.B move
mode.
.RE
@@ -518,6 +542,8 @@ Current mode. It is one of
(move),
.B box
(box),
+.B par
+(parallelogram),
.B arr
(arrow),
.B txt
@@ -575,6 +601,9 @@ would automatically save the screen into "filename".
gramscii currently manages only a fixed screen of the same size of the
screen where it starts from. This will be changed in a future release to
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.
.SH AUTHORS
gramscii is written and maintained by Vincenzo "KatolaZ" Nicosia
<katolaz@freaknet.org>. You can use, copy, modify, and redistribute