iadd manpage - gramscii - A simple editor for ASCII box-and-arrow charts Err bitreich.org 70 1Log /scm/gramscii/log.gph bitreich.org 70 1Files /scm/gramscii/files.gph bitreich.org 70 1Refs /scm/gramscii/refs.gph bitreich.org 70 1Tags /scm/gramscii/tag bitreich.org 70 1README /scm/gramscii/file/README.md.gph bitreich.org 70 1LICENSE /scm/gramscii/file/COPYING.gph bitreich.org 70 i--- Err bitreich.org 70 1commit 591777d6f9f064b5a3800ba656837b200c41b524 /scm/gramscii/commit/591777d6f9f064b5a3800ba656837b200c41b524.gph bitreich.org 70 1parent 8dd92909a95ae0bb9159576a8d9e90acf0c6ddb7 /scm/gramscii/commit/8dd92909a95ae0bb9159576a8d9e90acf0c6ddb7.gph bitreich.org 70 hAuthor: KatolaZ URL:mailto:katolaz@freaknet.org bitreich.org 70 iDate: Sat, 20 Jul 2019 18:30:23 +0100 Err bitreich.org 70 i Err bitreich.org 70 iadd manpage Err bitreich.org 70 i Err bitreich.org 70 iDiffstat: Err bitreich.org 70 i A gramscii.1 | 375 +++++++++++++++++++++++++++++++ Err bitreich.org 70 i Err bitreich.org 70 i1 file changed, 375 insertions(+), 0 deletions(-) Err bitreich.org 70 i--- Err bitreich.org 70 1diff --git a/gramscii.1 b/gramscii.1 /scm/gramscii/file/gramscii.1.gph bitreich.org 70 i@@ -0,0 +1,375 @@ Err bitreich.org 70 i+.TH GRAMSCII 1 "19/07/2019" "" "" Err bitreich.org 70 i+.SH NAME Err bitreich.org 70 i+gramscii \- simple editor for ascii box diagrams Err bitreich.org 70 i+.SH SYNOPSIS Err bitreich.org 70 i+.PP Err bitreich.org 70 i+gramscii Err bitreich.org 70 i+.PP Err bitreich.org 70 i+.SH DESCRIPTION Err bitreich.org 70 i+.PP Err bitreich.org 70 i+gramscii is a simple interactive editor to create ASCII box-and-arrows Err bitreich.org 70 i+diagrams. It uses vi-like keybindings for drawing and editing boxes, Err bitreich.org 70 i+arrows, and text. Err bitreich.org 70 i+.PP Err bitreich.org 70 i+.SH COMMANDS Err bitreich.org 70 i+gramscii is a visual modal editor. Commands are associated to Err bitreich.org 70 i+keystrokes, and keystrokes have different meaning in different modes. Err bitreich.org 70 i+The default mode is Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode, which allows the user to move the cursor around the screen. Err bitreich.org 70 i+Exiting from any other mode automatically puts gramscii in Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode. There are four classes of commands in gramscii, namely Err bitreich.org 70 i+.B GENERAL, Err bitreich.org 70 i+.B MOVEMENTS, Err bitreich.org 70 i+.B MODES, Err bitreich.org 70 i+and Err bitreich.org 70 i+.B STYLES. Err bitreich.org 70 i+Each of those classes of commands is described in a separate subsection Err bitreich.org 70 i+below. Err bitreich.org 70 i+.SS GENERAL Err bitreich.org 70 i+General commands available in Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode: Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI R Err bitreich.org 70 i+Redraw the screen Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI q Err bitreich.org 70 i+Quit gramscii, and prompt for a filename if the current screen contains Err bitreich.org 70 i+unsaved changes. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI Q Err bitreich.org 70 i+Quit gramscii and discard any change to the current screen. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI w Err bitreich.org 70 i+Write the current screen to a file. If the current screen has already Err bitreich.org 70 i+been associated to a file, use the same filename. Otherwise, the user is Err bitreich.org 70 i+prompted for a filename to save the screen to. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI W Err bitreich.org 70 i+Write the current screen to a new file. This commands acts like Err bitreich.org 70 i+.B w Err bitreich.org 70 i+but always prompts for a file name to use. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI e Err bitreich.org 70 i+Load (edit) an existing file from disk. gramscii asks the user if they Err bitreich.org 70 i+want to save the current screen (only if the screen has been modifided Err bitreich.org 70 i+since the Err bitreich.org 70 i+last Err bitreich.org 70 i+.BI w Err bitreich.org 70 i+command). Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI E Err bitreich.org 70 i+Load (edit) an existing file from disk, discarding any change to the Err bitreich.org 70 i+current screen. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI N Err bitreich.org 70 i+Start a new empty screen. If the current screen has been modified since Err bitreich.org 70 i+the last Err bitreich.org 70 i+.BI w Err bitreich.org 70 i+command, gramscii will ask the user if they want to save the current Err bitreich.org 70 i+screen before creating a new one. Err bitreich.org 70 i+ Err bitreich.org 70 i+.SS MOVEMENTS Err bitreich.org 70 i+The following commands are available in any mode where cursor movements Err bitreich.org 70 i+are meaningful, currently only Err bitreich.org 70 i+.B move, box, arrow, erase, Err bitreich.org 70 i+and Err bitreich.org 70 i+.B visual Err bitreich.org 70 i+(see Err bitreich.org 70 i+.B MODES Err bitreich.org 70 i+below). Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI h Err bitreich.org 70 i+move the cursor to the left by 1 column Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI j Err bitreich.org 70 i+move the cursor down by 1 row Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI k Err bitreich.org 70 i+move the cursos up by 1 row Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI l Err bitreich.org 70 i+move the cursos right by 1 column Err bitreich.org 70 i+.PP Err bitreich.org 70 i+gramscii accepts also the uppercase commands Err bitreich.org 70 i+.B H, J, K, L, Err bitreich.org 70 i+which will move in the corresponding direction by 5 units at a time. In Err bitreich.org 70 i+addition to the relative movement command above, the following global Err bitreich.org 70 i+positioning commands are available: Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI g Err bitreich.org 70 i+move the cursor to the top-left corner of the screen Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI G Err bitreich.org 70 i+move the cursos to the bottom-right corner of the screen Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI m Err bitreich.org 70 i+move the cursos to the middle of the screen. Err bitreich.org 70 i+.PP Err bitreich.org 70 i+Movements command work in the same way in different modes. Err bitreich.org 70 i+ Err bitreich.org 70 i+.SS MODES Err bitreich.org 70 i+The currently supported modes are: Err bitreich.org 70 i+.B move, Err bitreich.org 70 i+.B box, Err bitreich.org 70 i+.B arrow, Err bitreich.org 70 i+and Err bitreich.org 70 i+.B visual. Err bitreich.org 70 i+The current mode is shown in the Err bitreich.org 70 i+status bar (see Err bitreich.org 70 i+.B STATUS BAR Err bitreich.org 70 i+below for more details). gramscii starts in Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode (mov). The following commands are used to change mode: Err bitreich.org 70 i+.TP 7m Err bitreich.org 70 i+.BI [ESC] Err bitreich.org 70 i+Return to Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode. Err bitreich.org 70 i+.TP 7m Err bitreich.org 70 i+.BI b Err bitreich.org 70 i+Toggle Err bitreich.org 70 i+.B box Err bitreich.org 70 i+mode. All movements in Err bitreich.org 70 i+.B box Err bitreich.org 70 i+mode identify a rectangular box (see Err bitreich.org 70 i+.B Err bitreich.org 70 i+MOVEMENTS Err bitreich.org 70 i+above). When you are happy with the shape of your box, just press Err bitreich.org 70 i+.B b Err bitreich.org 70 i+again to have your box drawn and come back to Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode. The horizontal and vertical borders of the box are drawn using Err bitreich.org 70 i+the current Err bitreich.org 70 i+.B HL Err bitreich.org 70 i+style and the current Err bitreich.org 70 i+.B VL Err bitreich.org 70 i+style, respectively. The corners are drawn using the current Err bitreich.org 70 i+.B CN Err bitreich.org 70 i+style, See Err bitreich.org 70 i+.B STYLES Err bitreich.org 70 i+below for more information. If you press Err bitreich.org 70 i+.B [ESC] Err bitreich.org 70 i+while in box mode, gramscii will come back to Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode discarding the current box. Err bitreich.org 70 i+.TP 7m Err bitreich.org 70 i+.BI a Err bitreich.org 70 i+Toggle Err bitreich.org 70 i+.B arrow Err bitreich.org 70 i+mode. All movements in Err bitreich.org 70 i+.B arrow Err bitreich.org 70 i+mode change the position of the end-point of the current arrow. Press Err bitreich.org 70 i+.BI a Err bitreich.org 70 i+again to draw the current arrow and come back to Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode. If you press Err bitreich.org 70 i+.B [ESC] Err bitreich.org 70 i+while in box mode, gramscii will come back to Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode discarding the current arrow. The horizontal and vertical segments Err bitreich.org 70 i+of the arrow are drawn using the current Err bitreich.org 70 i+.B HL Err bitreich.org 70 i+and Err bitreich.org 70 i+.B VL Err bitreich.org 70 i+line styles. Corners are drawn using the current Err bitreich.org 70 i+.B CN Err bitreich.org 70 i+style. Similarly, the start and the end point of the arrow are drawn Err bitreich.org 70 i+using the current Err bitreich.org 70 i+.B SP Err bitreich.org 70 i+and Err bitreich.org 70 i+.B EP Err bitreich.org 70 i+styles. See Err bitreich.org 70 i+.B STYLES Err bitreich.org 70 i+below for more information. Err bitreich.org 70 i+.TP 7m Err bitreich.org 70 i+.BI x Err bitreich.org 70 i+Toggle Err bitreich.org 70 i+.B erase Err bitreich.org 70 i+mode. In erase mode, any character traversed by the cursor is erased, Err bitreich.org 70 i+i.e., reset to the default background character (space). If you press Err bitreich.org 70 i+.BI [ESC] Err bitreich.org 70 i+while in Err bitreich.org 70 i+.BI erase Err bitreich.org 70 i+mode, the current erase operation is aborted. Press Err bitreich.org 70 i+.B x Err bitreich.org 70 i+again to make the erase permanent. Err bitreich.org 70 i+.TP 7m Err bitreich.org 70 i+.BI i Err bitreich.org 70 i+Enter Err bitreich.org 70 i+.B text Err bitreich.org 70 i+mode. While in text mode, each character typed is printed on the screen Err bitreich.org 70 i+at the corresponding location, and the cursor is advanced by a single Err bitreich.org 70 i+position to the right. Movement modes are not allowed whilt in Err bitreich.org 70 i+.B text Err bitreich.org 70 i+mode. By pressing Err bitreich.org 70 i+.B [ENTER] Err bitreich.org 70 i+the cursor is placed on the following row (if possible), at the same Err bitreich.org 70 i+column where the cursor was when the command Err bitreich.org 70 i+.BI i Err bitreich.org 70 i+was typed. Press Err bitreich.org 70 i+.B [ESC] Err bitreich.org 70 i+to exit Err bitreich.org 70 i+.B text Err bitreich.org 70 i+mode and get back to Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode. Err bitreich.org 70 i+.TP 7m Err bitreich.org 70 i+.BI v Err bitreich.org 70 i+Toggle Err bitreich.org 70 i+.B visual Err bitreich.org 70 i+mode. Visual mode allows to highlight a rectangular region of the Err bitreich.org 70 i+screen, and to perform an operation into it. After entering Err bitreich.org 70 i+.B visual Err bitreich.org 70 i+mode, you can use Err bitreich.org 70 i+.B MOVEMENTS Err bitreich.org 70 i+commands to highlight a rectangle. Then, you can use one of the Err bitreich.org 70 i+following command on the highlighted region: Err bitreich.org 70 i+.RS Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI x Err bitreich.org 70 i+Erase region. All the characters in the region are set to the default Err bitreich.org 70 i+background character (space). Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI f Err bitreich.org 70 i+Fill region. gramscii will wait for a character on input and then will Err bitreich.org 70 i+fill the highlighted region with that character. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI v Err bitreich.org 70 i+leave Err bitreich.org 70 i+.B visual Err bitreich.org 70 i+mode and get back to Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI [ESC] Err bitreich.org 70 i+same as Err bitreich.org 70 i+.BI v, Err bitreich.org 70 i+i.e., leave Err bitreich.org 70 i+.B visual Err bitreich.org 70 i+mode and get back to Err bitreich.org 70 i+.B move Err bitreich.org 70 i+mode. Err bitreich.org 70 i+.RE Err bitreich.org 70 i+ Err bitreich.org 70 i+.SS STYLES Err bitreich.org 70 i+The following commands can be used to customise the style of lines, Err bitreich.org 70 i+corners, and arrow start and end points: Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.B . Err bitreich.org 70 i+(dot) Reset all styles to their default values. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI - Err bitreich.org 70 i+(dash) Change the style used for horizontal lines. Indicated in the Err bitreich.org 70 i+.B STATUS BAR Err bitreich.org 70 i+as "HL". Default is '-'. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI | Err bitreich.org 70 i+(pipe) Chamge the style used for vertical lines. Indicated in the Err bitreich.org 70 i+.B STATUS BAR Err bitreich.org 70 i+as "VL". Default is '|'. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI + Err bitreich.org 70 i+(plus) Change the style used for corners (i.e., intersections between Err bitreich.org 70 i+horizontal and vertical lines). Indicated in the Err bitreich.org 70 i+.B STATUS BAR Err bitreich.org 70 i+as "CN". Default is '+'. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI < Err bitreich.org 70 i+(less-than) Change the style used for arrow start points. Indicated in Err bitreich.org 70 i+the Err bitreich.org 70 i+.B STATUS BAR Err bitreich.org 70 i+as "SP". Default is '+'. Err bitreich.org 70 i+.TP 5m Err bitreich.org 70 i+.BI > Err bitreich.org 70 i+(greater-than) Change the style used for arrow end points. Indicated in Err bitreich.org 70 i+the Err bitreich.org 70 i+.B STATUS BAR Err bitreich.org 70 i+as "EP". Default is '>'. Err bitreich.org 70 i+ Err bitreich.org 70 i+.SH STATUS BAR Err bitreich.org 70 i+gramscii shows a status bar on the last line of the screen. The bar Err bitreich.org 70 i+shows information about the current screen, and in particular: Err bitreich.org 70 i+.RS Err bitreich.org 70 i+.TP 10m Err bitreich.org 70 i+x:XXX Err bitreich.org 70 i+Current column position of the cursor (the leftmost column is 0). Err bitreich.org 70 i+.TP 10m Err bitreich.org 70 i+y:YYY Err bitreich.org 70 i+Current row position of the cursor (top is 0). Err bitreich.org 70 i+.TP 10m Err bitreich.org 70 i+MODE: xxx Err bitreich.org 70 i+Current mode. It is one of Err bitreich.org 70 i+.B mov Err bitreich.org 70 i+(move), Err bitreich.org 70 i+.B box Err bitreich.org 70 i+(box), Err bitreich.org 70 i+.B arr Err bitreich.org 70 i+(arrow), Err bitreich.org 70 i+.B txt Err bitreich.org 70 i+(text), Err bitreich.org 70 i+.B del Err bitreich.org 70 i+(erase), or Err bitreich.org 70 i+.B vis Err bitreich.org 70 i+(visual). Err bitreich.org 70 i+.TP 10m Err bitreich.org 70 i+HL:x Err bitreich.org 70 i+Style used for horizontal lines. Err bitreich.org 70 i+.TP 10m Err bitreich.org 70 i+VL:x Err bitreich.org 70 i+Style used for vertical lines. Err bitreich.org 70 i+.TP 10m Err bitreich.org 70 i+CN:x Err bitreich.org 70 i+Style used for corners. Err bitreich.org 70 i+.TP 10m Err bitreich.org 70 i+SP:x Err bitreich.org 70 i+Style used for arrow starting points. Err bitreich.org 70 i+.TP 10m Err bitreich.org 70 i+EP:x Err bitreich.org 70 i+Style used for arrow end points. Err bitreich.org 70 i+.RE Err bitreich.org 70 i+.PP Err bitreich.org 70 i+The rightmost side of the status bar also reports the name of the file Err bitreich.org 70 i+associated to the current screen: Err bitreich.org 70 i+.RS Err bitreich.org 70 i+.TP 12m Err bitreich.org 70 i+[] Err bitreich.org 70 i+No file is associated to the current screen, and no changes have been Err bitreich.org 70 i+made. The command Err bitreich.org 70 i+.B w Err bitreich.org 70 i+would prompt the user for the name of the file to save the screen to. Err bitreich.org 70 i+.TP 12m Err bitreich.org 70 i+** Err bitreich.org 70 i+The screen has been changed, but there is no file associated to it. The Err bitreich.org 70 i+command Err bitreich.org 70 i+.B w Err bitreich.org 70 i+would prompt the user for the name of the file to save the screen to. Err bitreich.org 70 i+.TP 12m Err bitreich.org 70 i+[filename] Err bitreich.org 70 i+The screen corresponds to the file "filename" and it has not been Err bitreich.org 70 i+modified since the last write on disk. The command Err bitreich.org 70 i+.B w Err bitreich.org 70 i+would automatically save the screen into "filename". Err bitreich.org 70 i+.TP 12m Err bitreich.org 70 i+*filename* Err bitreich.org 70 i+The screen is associated to the file "filename", but the current buffer Err bitreich.org 70 i+includes some changes that have not been saved to the disk. The command Err bitreich.org 70 i+.B w Err bitreich.org 70 i+would automatically save the screen into "filename". Err bitreich.org 70 i+.RE Err bitreich.org 70 i+.SH BUGS Err bitreich.org 70 i+gramscii currently manages only a fixed screen of 25 rows by 100 Err bitreich.org 70 i+columns. This will be changed in a future release to support scrolling Err bitreich.org 70 i+and "virtual" screen of any (reasonable) size. Err bitreich.org 70 i+.PP Err bitreich.org 70 i+gramscii currently does Err bitreich.org 70 i+.B not Err bitreich.org 70 i+provide an "undo" command. This requires a restructuring of buffer Err bitreich.org 70 i+management, and will most probably be implemented in a future release. Err bitreich.org 70 i+.SH AUTHORS Err bitreich.org 70 i+gramscii is written and maintained by Vincenzo "KatolaZ" Nicosia Err bitreich.org 70 i+. You can use, copy, modify, and redistribute Err bitreich.org 70 i+gramscii under the terms of the GNU General Public License, version 3 of Err bitreich.org 70 i+the License or, at your option, any later version. Err bitreich.org 70 .