Added upstream from http://ftp.icm.edu.pl/pub/loglan/
[loglan.git] / utils / lotek / lotek.hlp
1 (* Loglanizator Tekstowy wersja 1.0   1990 Warszawa  Michal Pakier *)\r
2 ===============REKORD 1=======================================|===============\r
3 + 22 2\r
4           Using the editor LOTEK version 1.0\r
5  \r
6                                      ³F2..............Save File\r
7 Scrolling text    ³  cursor moves    ³F3........File operations\r
8   by line:        ³      one word    ³F4..Errors of compilation\r
9 ^U.............up ³   relatively to  ³F8.....Auxiliary programs\r
10 ^D...........down ³   the line above ³F9......Compilation & run\r
11   by page:        ³^N........to right³F10...........Menu on/off\r
12 PgDn.........down ³^P.........to left³F5................Windows\r
13 PgUp...........up ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ-\r
14    Jump to        ³^K.......block operations³^Y.....delete line\r
15 ^PgDn.....begin of³^Q.......replace & search³\r
16             text  ³^J..........Jumps in text³  delete character\r
17 ^PgUp.......end of³^W....Windows operations ³BackSpace..to left\r
18              text ³^V.........Macrocommands ³Del.......to right\r
19 ^Home.....begin ofÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ-\r
20            window ³^A...............delete to the begin of line\r
21 ^End.......end of ³^S.................delete to the end of line\r
22            window ³F1........On line HELP;press when in trouble\r
23 ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ-\r
24  \r
25                            Help on HELP   press <0>\r
26 ===============REKORD 2=======================================|===============\r
27 + 11\r
28              HELP on HELP.\r
29  \r
30   In any moment you can press the key  F1 and obtain an infor-\r
31 mation on currently available actions.  It may suggest further\r
32 request of more detailed informations. In such a case press one\r
33 of keys {0,1,2,3,4,5,6,7,8,9}, which is shown on screen in the\r
34 angles e.g.<2>.\r
35  \r
36  \r
37       Esc                             leaving Help\r
38       F1             principal information of Help\r
39 ===============REKORD 3=======================================|===============\r
40 + 8 4\r
41                     Saving file on disk  (F2,F3S)\r
42  \r
43 It may happen that for some reason we cannot write file back to\r
44 the directory from which it is read. In such a case press (F3L)\r
45 and choose the directory in which we have all rights next you\r
46 can write file using F3 W.\r
47  \r
48                             More on file operations, press <0>\r
49 ===============REKORD 4=======================================|===============\r
50 + 15 23 3 24 25 26 41\r
51                     File operations   (F3)\r
52  \r
53 permit to load, write file or to begin a new file to edit\r
54  \r
55 Your choices:\r
56  \r
57            L  Loading a file from disk             <0>\r
58            S  Saving file on disk                  <1>\r
59            N  New file edition                     <2>\r
60            W  Write a file on disk                 <3>\r
61            P  Pick one of the lastly used files    <4>\r
62            O  different Options                    <5>\r
63            G  Information on the edited files and on\r
64               free memory\r
65            Q  Quit the LOTEK environment\r
66 ===============REKORD 5=======================================|===============\r
67 + 16\r
68                       Correction of ERRORS\r
69  \r
70 This option facilitates correction of errors in Loglan program.\r
71 In the lowest line you see number of line with error and short\r
72 description of the error. The cursor is placed on the error's\r
73 occurrence. In certain cases it locates precisely the line and\r
74 the column of error, if it is not the case then only line is\r
75 shown and its first column. If you have menu bar (F10) then a\r
76 submenu concerning errors' scrolling appears.\r
77 You have the following choices:\r
78            Ctrl F5  - Move to the first error\r
79            Ctrl F6  - Move to the last error\r
80            Ctrl F8  - Show Next error\r
81            Ctrl F7  _ Show previous error\r
82            Ctrl F10 - Exit from the mode errors' corrrection\r
83 Press F4 for exit from errors' correction.\r
84 ===============REKORD 6=======================================|===============\r
85 + 8\r
86                    CHANGING WINDOW\r
87  \r
88    You can open a new window or change the active one.\r
89         F  Full screen all other windows are closed\r
90         H  Help on Loglan here you can consult doc on Loglan\r
91             use Tab to move between documents\r
92         A  Auxiliary window\r
93         M  Main window\r
94 ===============REKORD 7=======================================|===============\r
95 + 17 22\r
96               AUXILIARY PROGRAMS\r
97  \r
98 You can execute programs which appear in this window without\r
99 exiting LOTEK. This window may be defined by you (see lotek.pth\r
100 and LOTEKINS.EXE). It enables, among others, certain operations\r
101 on the file being edited, the name of the file is transmitted\r
102 as parameter to the called program. As one of options you can\r
103 put the LOTEKINS program which can facilitate modifications of\r
104 the window. You can put a call of a program in this window in-\r
105 to a macrocommand <0>.\r
106 (Example: If we have a computer with two monitors and if you\r
107 put instructions C COLOR (mode co80) and M MONO (mode mono)\r
108 then macrocommand <AltH> @8M@5H@5F will allow to consult do-\r
109 cumentation on the monitor controlled by Hercules card and\r
110 macro <AltM> @8C@5M@5F will permit editing on a colour monitor,\r
111 still having database on Loglan on white & black monitor.)\r
112  \r
113 ===============REKORD 8=======================================|===============\r
114 + 11 36\r
115                     COMPILING YOUR PROGRAM\r
116  \r
117 Your choices are:\r
118  L: Pass 1     Compilation-first phase(program Loglan). During\r
119       this pass all syntax errors are detected.(Use F4)\r
120  G: Pass 2     Second or First and second phase of compilation\r
121       (program Gen).\r
122  R: Run        Program execution (with compilation if needed).\r
123  D: Debuger    First the program is executed and then you can\r
124       watch command after command its execution.\r
125  O: Options    Different options of compilation <0>\r
126 ===============REKORD 9=======================================|===============\r
127 + 17 27 28 29 30 31 32 33 34 35\r
128                        OPERATIONS ON BLOCKS\r
129  \r
130 Press Ctrl_K and then a key which corresponds to the desired\r
131 action. If you do not know what to choose wait 2 secs. and\r
132 a frame will appear with all options.\r
133  \r
134 Your choices are:\r
135  \r
136  K,B,T,L - marking a block <0>\r
137  Y - deleting the marked block <1>\r
138  C,V - copying and moving the block <2>\r
139  S,M - copying and moving with indentation <3>\r
140  R,W - block to and from the disk <4>\r
141  U,I - shifting the block <5>\r
142  H - hiding the block <6>\r
143  F - framing a block (e.g. a comment) <7>\r
144  O - options <8>\r
145 ===============REKORD 10=======================================|===============\r
146 + 13 37 38 39 40\r
147              GO TO INDICATED PLACE IN TEXT\r
148  \r
149 Press Ctrl_J and then a key which corresponds to the desired\r
150 action. If you do not know what to choose wait 2 secs. and\r
151 a frame will appear with all options.\r
152  \r
153 Your choices are:\r
154  \r
155   S - mark this place for return  <0>\r
156   R - return to the marked place  <1>\r
157   J - jump to the marked place    <2>\r
158   L - jump to the given line\r
159   B,K - jump to the begin (resp. to the end) of block <3>\r
160 ===============REKORD 11=======================================|===============\r
161 + 17 15 16 17 18 19 20\r
162              Search and replace operations\r
163  \r
164 Press Ctrl_Q and then a key which corresponds to the desired\r
165 action. If you do not know what to press wait 2 secs. and\r
166 a frame with options will appear.\r
167  \r
168 Your choices:\r
169  \r
170   F - find a word <0>\r
171   A - Alter find a word and replace <1>\r
172   C - replace character <2>\r
173   K - replace key words <3>\r
174   T - find another occurrence of the current word <4>\r
175   R - find and replace word currently pointed by cursor <5>\r
176  \r
177 REMARK: Pressing Ctrl L you can repeat the lastly executed\r
178       action of searching/replacing.\r
179 ===============REKORD 12=======================================|===============\r
180 + 13 14\r
181            Documentation on Loglan -  Loglan's database\r
182  \r
183   Each line on the screen is a title of a section.\r
184                 Press ENTER to see the highlighted section.\r
185  \r
186   Press Tab (& cursor left, right) to change (choose) a document\r
187   or a chapter.\r
188      cursor up - prevoius section,\r
189      cursor down - next section,\r
190      Ctrl PgUp - to the begin of list of sections,\r
191      Ctrl PgDn - to the end of list of sections,\r
192      PgUp,PgDn - previous (next) page of list of sections,\r
193      Ctrl_Q_F - searching a word.\r
194 ===============REKORD 13=======================================|===============\r
195 + 11 12 14\r
196                      Loglan's database - in a section\r
197  \r
198   Enter - return yo the list of sections <0>\r
199   Tab - change(choose) a document, a chapter <1>\r
200   Up,Down,Left,Right - moving the cursor\r
201   Home,End - to the begin (end) of line\r
202   Ctrl PgUp - to the begin of text\r
203   Ctrl PgDn - to the end of text\r
204   PgUp,PgDn - page up (page down)\r
205   Ctrl_K_B,K,L,T - marking a block\r
206   Ctrl_Q_F - searching a word\r
207 ===============REKORD 14=======================================|===============\r
208 + 9\r
209              Loglan's database - CHOOSING A DOCUMENT\r
210  \r
211   On the screen you see names of documents to consult.\r
212 Use cursor left & right to choose the type of document:\r
213              opisy=reports, funkcje=functions, tablice=tables.\r
214 Use cursor up & down, or Home & End to choose a document.\r
215 Press Enter to confirm your choice and to see the chosen doc.\r
216  \r
217                       Press Esc to return to your last choice.\r
218 ===============REKORD 15=======================================|===============\r
219 + 13\r
220                   (F) Searching a word\r
221  \r
222 Give a word you are looking for  (Find :?).\r
223 Next define the options. Then search is performed according to\r
224 your choice of options. If word is found the cursor is located\r
225 after it.\r
226 You can choose the options:\r
227  G.......global search, from the beginning (or the end) of text.\r
228  B..............................................backward search.\r
229  n.................................searching of n-th occurrence.\r
230  U.........................upper & lower case lettersidentified.\r
231  W............................................whole word search.\r
232  L..............................searching inside a marked block.\r
233 ===============REKORD 16=======================================|===============\r
234 + 16\r
235        (A) Replace a word (alter)\r
236  \r
237 First, give a word to be replaced  (Find :?)\r
238 Second, give a word to be put into (Replace with :?)\r
239 Third, define options.\r
240 Search & replace action begins: if a searched word is found then\r
241 at the top of the screen you see a demand of confirmation.\r
242  \r
243 The options are :\r
244  G.......global search, from the beginning (or the end) of text.\r
245  B..............................................backward search.\r
246  n..............................replacing up to n-th occurrence.\r
247  U.........................upper & lower case lettersidentified.\r
248  W............................................whole word search.\r
249  L..............................searching inside a marked block.\r
250  N..........  .uNconditional replace (no confirmation required).\r
251 ===============REKORD 17=======================================|===============\r
252 + 11\r
253                       (C) Replace Characters\r
254  \r
255 This functionality enable to exchange capital letters to small\r
256 ones and viceversa:\r
257  D..........................................Put capital letters.\r
258  S............................................Put small letters.\r
259  G........Global replace from the begin or from the end of text.\r
260  B.............................................Backward replace.\r
261  L.........................Replace inside the highlighted block.\r
262  C.................................Replace inside comments only.\r
263  T..................................Replace inside program only.\r
264 ===============REKORD 18=======================================|===============\r
265 + 10\r
266                  (K) Replace keywords of Loglan\r
267  \r
268 This function permits to put all the keywords of Loglan in the\r
269 selected case (lower or upper).\r
270 Your choices are:\r
271  D.......................................Put in capital letters.\r
272  S.........................................Put in small letters.\r
273  G........Global replace from the begin or from the end of text.\r
274  B.............................................Backward replace.\r
275  L............................Replace inside thehighlited block.\r
276 ===============REKORD 19=======================================|===============\r
277 + 12\r
278            (T) Searching the word indicated by cursor\r
279  \r
280 If word is found the cursor is located after it.\r
281 You can choose the options:\r
282  G.......global search, from the beginning (or the end) of text.\r
283  B..............................................backward search.\r
284  n.................................searching of n-th occurrence.\r
285  U........................upper & lower case letters identified.\r
286  W............................................whole word search.\r
287  L..............................searching inside a marked block.\r
288 ===============REKORD 20=======================================|===============\r
289 + 15\r
290     (R)  Search andReplace the word indicated by cursor\r
291  \r
292 Give a word to be put into (Replace with :?)\r
293 Next, define options.\r
294 Search & replace action begins: if a searched word is found then\r
295 at the top of the screen you will see a demand of confirmation.\r
296  \r
297 The options are :\r
298  G.......global search, from the beginning (or the end) of text.\r
299  B..............................................backward search.\r
300  n.................................replacing up n-th occurrence.\r
301  U.........................upper & lower case lettersidentified.\r
302  W............................................whole word search.\r
303  L..............................searching inside a marked block.\r
304  N..........  .uNconditional replace (no confirmation required).\r
305 ===============REKORD 21=======================================|===============\r
306 + 13 29 30\r
307     Exchange block between windows and other operations\r
308  \r
309 Press Ctrl_W and then a key which corresponds to the desired\r
310 action. If you wait 2 secs. then a frame appears with choices\r
311 suggested.\r
312  \r
313 Options to choose:\r
314   C - copy the block from the second, visible on screen window,\r
315   V - move the block from the second, visible on screen window,\r
316   S - copy with indentation from the other window,\r
317   M - move with indentation from the other window.\r
318  \r
319 More on C,V <0>                           More on S,M <1>\r
320 ===============REKORD 22=======================================|===============\r
321 + 19\r
322                   Defining macrocommands\r
323  \r
324 You can create, store and apply your macrocommands i.e. the\r
325 sequences of keys. A macrocommand can be associated with a let-\r
326 ter, digit or an F key. A macrocommand is executed when you\r
327 press simultaneously Alt+corresponding key.\r
328 Definition of a macrocommand may contain usual characters ASCII\r
329 and also the following combinations of keys:\r
330   ^.............denotes Ctrl + following key (A..Z and 0..9)\r
331   &..............denotes Alt + following key (A..Z and 0..9)\r
332   @........denotes a functional key. The next key may be :\r
333      1..0 - F1..F10 ³ <>^v - cursor ³ H - Home   ³ E - End    ³\r
334      U - PgUp       ³ D - PgDn      ³ I - Insert ³ L - Delete ³\r
335      S - Esc        ³ B - Backspace ³            ³            ³\r
336      C - Enter      ³               ³            ³            ³\r
337   #......the next character is not interpreted e.g.## denotes #\r
338 Braces permit to iterate the string inside them.\r
339 E.g. the string {^C(* *)}12  will cause cration of 12 new lines\r
340 containing the string "(* *)"\r
341 ===============REKORD 23=======================================|===============\r
342 + 17\r
343                 (L) Loading a file\r
344  \r
345 You can enter a file name or a mask e.g. *.log defining a group\r
346 of files. In the first case the file is loaded (or initialized)\r
347 In the second case all names that correspond to the mask are\r
348 shown.\r
349  \r
350 >>>You can press:\r
351    Esc.........Return without loading anything\r
352  \r
353    \18 \19 < >......................Moving in window.\r
354    Enter.........If a file is indicated then it is loaded\r
355                  If a directory is indicated then it is opened\r
356  \r
357    PgUp,PgDn......Previous or next page\r
358                         (the window contains maximum 20 names).\r
359    F4............change directory\r
360 ===============REKORD 24=======================================|===============\r
361 + 5\r
362            (N) New file editing\r
363  \r
364 The scrren is emptied and an edition of the file NONAME.LOG\r
365 begins. At saving time Lotek will propose to change the name\r
366 of the file.\r
367 ===============REKORD 25=======================================|===============\r
368 + 5\r
369               (W) Save the edited file as ...\r
370  \r
371 It permits to change the name of the edited file and to save it\r
372 in the current directory.(see L option for change of directory)\r
373  \r
374 ===============REKORD 26=======================================|===============\r
375 + 4\r
376                  (P) Pick up\r
377  \r
378 you can choose a name among lastly edited files or Load (L)\r
379  \r
380 ===============REKORD 27=======================================|===============\r
381 + 6\r
382                      Marking a block\r
383  \r
384   B - mark begin of block,\r
385   K - mark end of block,\r
386   T - mark the word indicated by cursor as a block,\r
387   L - mark the line indicated by cursor as a block.\r
388 ===============REKORD 28=======================================|===============\r
389 + 3\r
390                Deleting block\r
391  \r
392   You can delete the marked block.\r
393 ===============REKORD 29=======================================|===============\r
394 + 15 30\r
395      (C,V) Copying or moving the highlighted block\r
396  \r
397 Function.C. copies the highlighted block  (Ctrl K + B,K,T,L)\r
398 to the current position of cursor.\r
399 Begin of the block will be positioned exactly on the cursor.\r
400 Other lines are not shifted.\r
401  \r
402 REMARK: One can copy the block into itself.\r
403  \r
404 Function.V. moves the highlighted block (Ctrl K+ B,K,T,L)\r
405 to the current position of cursor.\r
406 The earlier occurrence of the block dissapears.\r
407 Begin of the block will be positioned exactly on the cursor.\r
408 Other lines are not shifted.\r
409  \r
410  ----> Ctrl K S,M  <0>\r
411 ===============REKORD 30=======================================|===============\r
412 + 18 29\r
413      (S,M) Copy or Move the block with indentation\r
414  \r
415 Function.S. copies the highlighted block  (Ctrl K + B,K,T,L)\r
416 to the current position of cursor. It differs however from\r
417 the function Ctrl K C. All lines of the block will begin in\r
418 the position of cursor.\r
419  \r
420 REMARK: One can copy the block into itself.\r
421  \r
422 Function.M. moves the highlighted block (Ctrl K+ B,K,T,L)\r
423 to the current position of cursor. It differs however from\r
424 the function Ctrl K V. All lines of the block will begin in\r
425 the position of cursor.\r
426 The earlier occurrence of the block dissapears.\r
427  \r
428 REMARK: If you move the block into itself it will result in\r
429 shifting it horizontally, it will move to the cursor position.\r
430                                           -----> Ctrl K C,V <0>\r
431 ===============REKORD 31=======================================|===============\r
432 + 10 23 25\r
433             (R,W) Reading and Writing a block\r
434  \r
435 Function R enables inclusion of a file from the disk.\r
436 The file is included in the current postion of the cursor\r
437 without indentation (as Ctrl K C does).\r
438 A window appears and you can choose the name of file\r
439                                                   see F3 L <0>\r
440 Function W enables saving of the block on disk.\r
441 A window appears and you can choose the name of file\r
442                                                   see F3 W <1>\r
443 ===============REKORD 32=======================================|===============\r
444 + 8\r
445    (I,U) Shift the block to right or to left\r
446  \r
447 Function.I.shifts all lines of the block one position to left.\r
448    It applies to the full first and last line of the block.\r
449  \r
450 Function.U.shifts all lines of the block one position to right.\r
451    It applies to the full first and last line of the block.\r
452  \r
453 ===============REKORD 33=======================================|===============\r
454 + 5\r
455                Hiding block\r
456  \r
457   You can unmark the marked block.\r
458 If you repeat this action then the block is marked again.\r
459  \r
460 ===============REKORD 34=======================================|===============\r
461 + 6 35\r
462                      (F) Frame around a block\r
463  \r
464   If you selected a block then a frame can be put around it.\r
465 Options permit to define parameters of the frame.\r
466 Each line is enclosed in (*    *) i.e. it is a comment.\r
467  -----> Ctrl K O <0>\r
468 ===============REKORD 35=======================================|===============\r
469 + 19\r
470                  (O) Parameters of frames\r
471  \r
472 3 lines determine the pattern of frame\r
473   define 3 characters for top, inside and bottom lines of frame.\r
474   - top line:    leftmost, inside, rightmost character;\r
475   - inside line: leftmost, inside, rightmost character;\r
476   - bottom line: leftmost, inside, rightmost character;\r
477  F............................Position of first column of frame.\r
478    - must be between  0..255,\r
479    - must be less then L, the last column of frame,\r
480    - 0 has a special meaning:frame will begin in the first\r
481      column of indicated text,\r
482  L.....................Position of the last column of the frame\r
483    - must be between  0..255\r
484    - must be greater then F, the first column of frame\r
485    - 0 has a special meaning: frame will end in the last column\r
486      of indicated text,\r
487  T.....Put text in the frame: to the LEFT, to the RIGHT, CENTER\r
488                                                    in frame.\r
489 ===============REKORD 36=======================================|===============\r
490 + 14\r
491                        Compilation options\r
492  \r
493  \r
494  \r
495 D: Debug info on/off     Debug on causes: firstly - execution\r
496   of the program is recorded on special file, secondly - you can\r
497   watch the sequence of executed commands.\r
498  \r
499 M: Memory    ______     Divided by 4 amount of memory atributed\r
500   to our pogram. It may assume values from 16384 to 100000.\r
501   If you can select 16384 to accelerate the program.\r
502  \r
503 C: Cursor  on/off        For amateurs only. It enables to hide\r
504   cursor during the program execution.\r
505 ===============REKORD 37=======================================|===============\r
506 + 4\r
507              (S) Marking a place in the text\r
508  \r
509 This function memorises the current position of the cursor.\r
510 It is possible to reposition cursor quickly in this place.\r
511 ===============REKORD 38=======================================|===============\r
512 + 5\r
513         (R) Go to the marked place and ...\r
514  \r
515 The difference with respect to Ctrl J J lies in that befor we\r
516 move to an earlier marked place, we mark the current position\r
517 This enables a return with commands  Ctrl J J/R.\r
518 ===============REKORD 39=======================================|===============\r
519 + 4\r
520       (J) Go to an earlier marked place\r
521  \r
522 Cursor is moved to the place which was earlier marked with the\r
523 use of Ctrl J S command\r
524 ===============REKORD 40=======================================|===============\r
525 + 4\r
526                      Go to block\r
527  \r
528    B - go to the begin of the highlighted block\r
529    K - go to the end of the highlighted block\r
530 ===============REKORD 41=======================================|===============\r
531 + 20\r
532                      File options (F3O)\r
533  \r
534 Your choices:\r
535  \r
536   S..it is the number of line dividing two windows of Lotek.\r
537      (e.g. between main file and auxiliary file or between\r
538       main file and Loglan's database),\r
539   B..backups? If your answer is yes then saving file on disk\r
540      causes that the previous version of the file is saved\r
541      with an extension .BAK\r
542  \r
543   D..Delay of idle time.\r
544      If no key is pressed during D time then the screen shows\r
545      a sky with stars blinking.\r
546  \r
547   W..delay of showing menus.\r
548      If you choose an action of editor say Ctrl+K then first\r
549      you see the headline of a menu window and the window\r
550      itself appear after W time.\r
551  \r
552 =============KONIEC============================================|==============\r
553  \r
554  \r
555  \r
556  \r
557  \r
558  \r
559  \r
560  \r
561  \r