diff options
-rw-r--r-- | readme | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/readme b/readme index a98c60b..5eaa9f6 100644 --- a/readme +++ b/readme | |||
@@ -1,15 +1,16 @@ | |||
1 | YOLK --- ansi escapes for CHICKEN -*- text -*- | 1 | YOLK --- ansi escapes for CHICKEN -*- text -*- |
2 | 2 | ||
3 | yes there's already ansi-escape-sequences[1]. consider this NIH ;) | 3 | yes there's already ansi-escape-sequences[1]. consider this NIH ;) this library |
4 | this library is based on the information a gist by fnky[2]. | 4 | is based on the information a gist by fnky[2]. at some point i should base it |
5 | at some point i should base it instead on xterm's manual[3]. | 5 | instead on xterm's manual[3]. |
6 | 6 | ||
7 | Unless otherwise stated, all procedures and variables in this library are | 7 | Unless otherwise stated, all procedures and variables in this library are |
8 | strings or return strings ready for `display'. | 8 | strings or return strings ready for `display'. |
9 | 9 | ||
10 | INSTALLATION. | 10 | INSTALLATION. |
11 | 11 | ||
12 | Run `chicken-install' in this directory or `make install', which will run it for you. You can also run `make clean' to clean the folder of build artifacts. | 12 | Run `chicken-install' in this directory or `make install', which will run it for |
13 | you. You can also run `make clean' to clean the folder of build artifacts. | ||
13 | 14 | ||
14 | MODULES. | 15 | MODULES. |
15 | 16 | ||
@@ -43,9 +44,9 @@ Syntax. | |||
43 | 44 | ||
44 | - (define-esc-alt-wrapper wrapper-proc-name param-name (default-proc args ...)) | 45 | - (define-esc-alt-wrapper wrapper-proc-name param-name (default-proc args ...)) |
45 | 46 | ||
46 | Many terminal behaviors have multiple escape sequences that might work. This | 47 | Many terminal behaviors have multiple escape sequences that might work. This |
47 | macro defines a parameter named PARAM-NAME and a procedure named | 48 | macro defines a parameter named PARAM-NAME and a procedure named |
48 | WRAPPER-PROC-NAME that will call PARAM-NAME with ARGS ... . The user can change | 49 | WRAPPER-PROC-NAME that will call PARAM-NAME with ARGS ... . The user can change |
49 | which procedure to call by calling (PARAM-NAME new-proc). | 50 | which procedure to call by calling (PARAM-NAME new-proc). |
50 | 51 | ||
51 | (yolk colors) --- NOT FINISHED | 52 | (yolk colors) --- NOT FINISHED |
@@ -58,7 +59,7 @@ Variables. | |||
58 | 59 | ||
59 | -- cursor-home | 60 | -- cursor-home |
60 | 61 | ||
61 | Move the cursor to the top-left corner (0,0). NOTE: This and the move commands | 62 | Move the cursor to the top-left corner (0,0). NOTE: This and the move commands |
62 | might be revised later. | 63 | might be revised later. |
63 | 64 | ||
64 | Procedures. | 65 | Procedures. |
@@ -87,8 +88,8 @@ Move cursor to column N. | |||
87 | -- (cursor-save) | 88 | -- (cursor-save) |
88 | -- (cursor-restore) | 89 | -- (cursor-restore) |
89 | 90 | ||
90 | Save or restore the cursor's position on the screen. These variables are | 91 | Save or restore the cursor's position on the screen. These variables are |
91 | parameters defaulting to the DEC escapes. You can set them to the SCO escapes | 92 | parameters defaulting to the DEC escapes. You can set them to the SCO escapes |
92 | using (cursor-save cursor-save/sco), for example. | 93 | using (cursor-save cursor-save/sco), for example. |
93 | 94 | ||
94 | (yolk erase) --- erasing the screen | 95 | (yolk erase) --- erasing the screen |
@@ -110,7 +111,8 @@ These erase portions of the current line. | |||
110 | 111 | ||
111 | -- erase-line-and-return | 112 | -- erase-line-and-return |
112 | 113 | ||
113 | Convenience function to return the cursor to the beginning of the line after erasing it. | 114 | Convenience function to return the cursor to the beginning of the line after |
115 | erasing it. | ||
114 | 116 | ||
115 | (yolk xterm) --- xterm-specific escape sequences | 117 | (yolk xterm) --- xterm-specific escape sequences |
116 | 118 | ||