10fa208d5a45980201387980519264306519435b
[alioth/jupp.git] / joe.txt
1 JOE(1)              UNIX Programmer's Manual               JOE(1)\r
2 \r
3 Name\r
4      joe - Joe's Own Editor\r
5 \r
6 Syntax\r
7      joe [global-options] [ [local-options] filename ]...\r
8 \r
9      jstar [global-options] [ [local-options] filename ]...\r
10 \r
11      jmacs [global-options] [ [local-options] filename ]...\r
12 \r
13      rjoe [global-options] [ [local-options] filename ]...\r
14 \r
15      jpico [global-options] [ [local-options] filename ]...\r
16 \r
17      jupp32 [global-options] [ [local-options] filename ]...\r
18 \r
19 Description\r
20      JOE is a powerful ASCII-text screen editor.  It has a\r
21      "mode-less" user interface which is similar to many user-\r
22      friendly PC editors.  Users of Micro-Pro's WordStar or\r
23      Borland's "Turbo" languages will feel at home.  JOE is a\r
24      full featured UNIX screen-editor though, and has many\r
25      features for editing programs and text.\r
26 \r
27      JOE also emulates several other editors.  JSTAR is a close\r
28      imitation of WordStar with many "JOE" extensions.  JPICO is\r
29      a close imitation of the Pine mailing system's PICO editor,\r
30      but with many extensions and improvements.  JMACS is a GNU-\r
31      EMACS imitation.  RJOE is a restricted version of JOE, which\r
32      allows you to edit only the files specified on the command\r
33      line.\r
34 \r
35      Although JOE is actually six different editors, it still\r
36      requires only one executable, but one with six different\r
37      names.  The name of the editor with an "rc" appended gives\r
38      the name of JOE's initialization file, which determines the\r
39      personality of the editor.\r
40 \r
41      JUPP is free software; you can distribute it and/or modify\r
42      it under the terms of the GNU General Public License, Ver-\r
43      sion 1, as published by the Free Software Foundation. I have\r
44      no plans for turning JOE into a commercial or share-ware\r
45      product. See the source code for exact authorship and\r
46      licencing information. JOE is available over the Internet\r
47      from http://joe-editor.sf.net/. JUPP is available at\r
48      http://mirbsd.de/jupp.\r
49 \r
50 Usage\r
51      To start the editor, type joe followed by zero or more names\r
52      of files you want to edit.  Each file name may be preceded\r
53      by a local option setting (see the local options table which\r
54      follows).  Other global options, which apply to the editor\r
55      as a whole, may also be placed on the command line (see the\r
56      global options table which follows).  If you are editing a\r
57      new file, you can either give the name of the new file when\r
58      you invoke the editor, or in the editor when you save the\r
59      new file.  A modified syntax for file names is provided to\r
60      allow you to edit program output, standard input/output, or\r
61      sections of files or devices.  See the section Filenames\r
62      below for details.\r
63 \r
64      Once you are in the editor, you can type in text and use\r
65      special control-character sequences to perform other editing\r
66      tasks.  To find out what the control-character sequences\r
67      are, read the rest of this man page or type ^K H for help in\r
68      the editor.\r
69 \r
70      Now for some obscure computer-lore:\r
71 \r
72      The ^ means that you hold down the Control key while press-\r
73      ing the following key (the same way the Shift key works for\r
74      uppercase letters).  A number of control-key sequences are\r
75      duplicated on other keys, so that you don't need to press\r
76      the control key: ESC will work in place of ^[, Del will work\r
77      in place of ^?, Backspace will work in place of ^H, Tab will\r
78      work in place of ^I, Return or Enter will work in place of\r
79      ^M and Linefeed will work in place of ^J.  Some keyboards\r
80      may give you trouble with some control keys.  ^_, ^^ and ^@\r
81      can usually be entered without pressing shift (I.E., try ^-,\r
82      ^6 and ^2).  Other keyboards may reassign these to other\r
83      keys.  Try: ^., ^, and ^/.  ^SPACE can usually be used in\r
84      place of ^@.  ^\ and ^] are interpreted by many communica-\r
85      tion programs, including telnet and kermit.  Usually you\r
86      just hit the key twice to get it to pass through the commun-\r
87      ication program.\r
88 \r
89      Once you have typed ^K H, the first help window appears at\r
90      the top of the screen.  You can continue to enter and edit\r
91      text while the help window is on.  To page through other\r
92      topics, hit ^[, and ^[. (that is, ESC , and ESC .).  Use ^K\r
93      H to dismiss the help window.\r
94 \r
95      You can customize the keyboard layout, the help screens and\r
96      a number of behavior defaults by copying JOE's initializa-\r
97      tion file (c:/windows/system32/joe/joerc) to .joerc in your\r
98      home directory and then by modifying it.  See the section\r
99      joerc below.\r
100 \r
101      To have JOE used as your default editor for e-mail and News,\r
102      you need to set the EDITOR and VISUAL environment variables\r
103      in your shell initialization file (.cshrc or .profile) to\r
104      refer to JOE (joe resides as c:/windows/system32/joe.exe).\r
105 \r
106      There are a number of other obscure invocation parameters\r
107      which may have to be set, particularly if your terminal\r
108      screen is not updating as you think it should.  See the sec-\r
109      tion Environment variables below.\r
110 \r
111 Command Line Options\r
112      The following global options may be specified on the command\r
113      line:\r
114 \r
115      -asis\r
116           Characters with codes above 127 will be sent to the\r
117           terminal as-is, instead of as inverse of the\r
118           corresponding character below 128.  If this does not\r
119           work, check your terminal server.\r
120 \r
121      -backpath path\r
122           If this option is given, backup files will be stored in\r
123           the specified directory instead of in each file's ori-\r
124           ginal directory.\r
125 \r
126      -baud nnn\r
127           Set the baud rate for the purposes of terminal screen\r
128           optimization.  Joe inserts delays for baud rates below\r
129           19200, which bypasses tty buffering so that typeahead\r
130           will interrupt the screen output.  Scrolling commands\r
131           will not be used for 38400 baud.  This is useful for\r
132           X-terms and other console ttys which really aren't\r
133           going over a serial line.\r
134 \r
135      -beep\r
136           Joe will beep on command errors and when the cursor\r
137           goes past extremes.\r
138 \r
139      -columns nnn\r
140           Sets the number of screen columns.\r
141 \r
142      -csmode\r
143           Continued search mode: a search immediately following a\r
144           search will repeat the previous search instead of\r
145           prompting for new string.  This is useful for the the\r
146           ^[S and ^[R commands and for when joe is trying to be\r
147           emacs.\r
148 \r
149      -dopadding\r
150           Joe usually assumes that there is some kind of flow\r
151           control between it and the tty.  If there isn't, this\r
152           option will make joe output extra ^@s to the tty as\r
153           specified by the termcap entry.  The extra ^@s allow\r
154           the terminal to catch up after long terminal commands.\r
155 \r
156      -exask\r
157           This option makes ^KX verify the file name that it's\r
158           about to write.\r
159 \r
160      -force\r
161           This option makes sure that the last line of the file\r
162           has a line-feed which it's saved.\r
163 \r
164      -help\r
165           The editor will start with the help screen on if this\r
166           option is given.\r
167 \r
168      -keepup\r
169           Normally the column number and control-key prefix\r
170           fields of the status lines are on a one second delay to\r
171           reduce CPU consumption, but with this option they are\r
172           updated after each key-stroke.\r
173 \r
174      -lightoff\r
175           The block highlighting will go away after any block\r
176           command if this option is given.\r
177 \r
178      -lines nnn\r
179           Sets the number of screen lines.\r
180 \r
181      -marking\r
182           Text between ^KB and the cursor is highlighted (use\r
183           with -lightoff and a modified joerc file to have drop-\r
184           anchor style block selection).\r
185 \r
186      -mid If this option is set and the cursor moves off the win-\r
187           dow, the window will be scrolled so that the cursor is\r
188           in the center.  This option is forced on slow terminals\r
189           which don't have scrolling commands.\r
190 \r
191      -nobackups\r
192           This option prevents backup files.\r
193 \r
194      -nonotice\r
195           This option prevent the copyright notice from being\r
196           displayed when the editor starts.\r
197 \r
198      -nosta\r
199           This option eliminates the top-most status line.  It's\r
200           nice for when you only want to see your text on the\r
201           screen or if you're using a vt52.\r
202 \r
203      -noxon\r
204           Attempt to turn off ^S/^Q processing.  This is useful\r
205           for when joe is trying to be WordStar or EMACS.\r
206 \r
207      -orphan\r
208           When this option is active, extra files on the command\r
209           line will be placed in orphaned buffers instead of in\r
210           extra windows.  This is useful for when joe is trying\r
211           to be emacs.\r
212 \r
213      -pg nnn\r
214           This specifies the number of lines to keep after\r
215           PgUp/PgDn (^U/^V).  If -1 is given, half the window is\r
216           kept.\r
217 \r
218      -skiptop nnn\r
219           Don't use the top nnn lines of the screen.  Useful for\r
220           when joe is used as a BBS editor.\r
221 \r
222      Each of these options may be specified in the joerc file as\r
223      well.  In addition, the NOXON, BAUD, LINES, COLUMNS and\r
224      DOPADDING options may be specified with environment vari-\r
225      ables.\r
226 \r
227      The JOETERM environment variable may be set to override the\r
228      regular TERM environment variable for specifying your termi-\r
229      nal type.\r
230 \r
231      The following options may be specified before each filename\r
232      on the command line:\r
233 \r
234      +nnn The cursor starts on the specified line.\r
235 \r
236      -crlf\r
237           Joe uses CR-LF as the end of line sequence instead of\r
238           just LF.  This is for editing MS-DOS or VMS files.\r
239 \r
240      -hex Sets the buffer to hex edit mode.\r
241 \r
242      -wordwrap\r
243           Joe wraps the previous word when you type past the\r
244           right margin.\r
245 \r
246      -autoindent\r
247           When you hit Return on an indented line, the indenta-\r
248           tion is duplicated onto the new line.\r
249 \r
250      -overwrite\r
251           Typing overwrites existing characters instead of\r
252           inserting before them.\r
253 \r
254      -lmargin nnn\r
255           Sets the left margin.\r
256 \r
257      -rmargin nnn\r
258           Sets the right margin.\r
259 \r
260      -tab nnn\r
261           Sets the tab width.\r
262 \r
263      -indentc nnn\r
264           Sets the indentation character for ^K, and ^K. (32 for\r
265           SPACE, 9 for TAB).\r
266 \r
267      -istep nnn\r
268           Sets the indentation step for ^K, and ^K..\r
269 \r
270      -linums\r
271           Line numbers are displayed before each line.\r
272 \r
273      -rdonly\r
274           The file is read only.\r
275 \r
276      -keymap name\r
277           Use an alternate section of the joerc file for the key\r
278           sequence bindings. For example, joe, jstar, rjoe and
279           jupp support -keymap cua to make ^Z, ^X, ^C and ^V do
280           the same thing as in contemporary GUI editors.
281 \r
282      These options can also be specified in the joerc file.  They\r
283      can be set depending on the file-name extension.  Programs\r
284      (.c, .h or .p extension) usually have autoindent enabled.\r
285      Wordwrap is enabled on other files, but rc files have it\r
286      disabled.\r
287 \r
288 Editing Tasks\r
289      Basic Editing\r
290 \r
291      When you type characters into the editor, they are normally\r
292      inserted into the file being edited (or appended to the file\r
293      if the cursor is at the end of the file).  This is the nor-\r
294      mal operating mode of the editor.  If you want to replace\r
295      some existing text, you have to delete the old text before\r
296      or after you type in the replacement text.  The Backspace\r
297      key can be used for deleting text: move the cursor to right\r
298      after the text you want to delete and hit Backspace a number\r
299      of times.\r
300 \r
301      Hit the Enter or Return key to insert a line-break.  For\r
302      example, if the cursor was in the middle of a line and you\r
303      hit Return, the line would be split into two lines with the\r
304      cursor appearing at the beginning of the second line.  Hit\r
305      Backspace at the beginning of a line to eliminate a line-\r
306      break.\r
307 \r
308      Use the arrow keys to move around the file.  If your key-\r
309      board doesn't have arrow keys (or if they don't work for\r
310      some reason), use ^F to move forwards (right), ^B to move\r
311      backwards (left), ^P to move to the previous line (up), and\r
312      ^N to move to the next line (down).  The right and left\r
313      arrow keys simply move forwards or backwards one character\r
314      at a time through the text: if you're at the beginning of a\r
315      line and you press left-arrow, you will end up at the end of\r
316      the previous line.  The up and down arrow keys move forwards\r
317      and backwards by enough characters so that the cursor\r
318      appears in the same column that it was in on the original\r
319      line.\r
320 \r
321      If you want to indent the text you enter, you can use the\r
322      TAB key. This inserts a special control character which\r
323      makes the characters which follow it begin at the next TAB\r
324      STOP.  TAB STOPS normally occur every 8 columns, but this\r
325      can be changed with the ^T D command.  PASCAL and C program-\r
326      mers often set TAB STOPS on every 4 columns.\r
327 \r
328      If for some reason your terminal screen gets messed up (for\r
329      example, if you receive a mail notice from biff), you can\r
330      have the editor refresh the screen by hitting ^R.\r
331 \r
332      There are many other keys for deleting text and moving\r
333      around the file.  For example, hit ^D to delete the charac-\r
334      ter the cursor is on instead of deleting backwards like\r
335      Backspace.  ^D will also delete a line-break if the cursor\r
336      is at the end of a line.  Type ^Y to delete the entire line\r
337      the cursor is on or ^J to delete just from the cursor to the\r
338      end of the line.\r
339 \r
340      Hit ^A to move the cursor to the beginning of the line it's\r
341      on.  Hit ^E to move the cursor to the end of the line.  Hit\r
342      ^U or ^V for scrolling the cursor up or down 1/2 a screen's\r
343      worth. "Scrolling" means that the text on the screen moves,\r
344      but the cursor stays at the same place relative to the\r
345      screen.  Hit ^K U or ^K V to move the cursor to the begin-\r
346      ning or the end of the file.  Look at the help screens in\r
347      the editor to find even more delete and movement commands.\r
348 \r
349      If you make a mistake, you can hit ^_ to "undo" it.  On most\r
350      keyboards you hit just ^- to get ^_, but on some you might\r
351      have to hold both the Shift and Control keys down at the\r
352      same time to get it. If you "undo" too much, you can "redo"\r
353      the changes back into existence by hitting ^^ (type this\r
354      with just ^6 on most keyboards).\r
355 \r
356      If you were editing in one place within the file, and you\r
357      then temporarily had to look or edit some other place within\r
358      the file, you can get back to the original place by hitting\r
359      ^K -.  This command actually returns you to the last place\r
360      you made a change in the file.  You can step through a his-\r
361      tory of places with ^K - and ^K =, in the same way you can\r
362      step through the history of changes with the "undo" and\r
363      "redo" commands.\r
364 \r
365      When you are done editing the file, hit ^K X to exit the\r
366      editor.  You will be prompted for a file name if you hadn't\r
367      already named the file you were editing.\r
368 \r
369      When you edit a file, you actually edit only a copy of the\r
370      file.  So if you decide that you don't want the changes you\r
371      made to a file during a particular edit session, you can hit\r
372      ^C to exit the editor without saving them.\r
373 \r
374      If you edit a file and save the changes, a "backup" copy of\r
375      that file is created in the current directory, with a ~\r
376      appended to the name, which contains the original version of\r
377      the file.\r
378 \r
379 \r
380      Word wrap and formatting\r
381 \r
382      If you type past the right edge of the screen in a C\r
383      language or PASCAL file, the screen will scroll to the right\r
384      to follow the cursor.  If you type past the right edge of\r
385      the screen in a normal file (one whose name doesn't end in\r
386      .c, .h or .p), JOE will automatically wrap the last word\r
387      onto the next line so that you don't have to hit Return.\r
388      This is called word-wrap mode.  Word-wrap can be turned on\r
389      or off with the ^T W command.  JOE's initialization file is\r
390      usually set up so that this mode is automatically turned on\r
391      for all non-program files.  See the section below on the\r
392      joerc file to change this and other defaults.\r
393 \r
394      Aside for Word-wrap mode, JOE does not automatically keep\r
395      paragraphs formatted like some word-processors.  Instead, if\r
396      you need a paragraph to be reformatted, hit ^K J.  This com-\r
397      mand "fills in" the paragraph that the cursor is in, fitting\r
398      as many words in a line as is possible.  A paragraph, in\r
399      this case, is a block of text separated above and below by a\r
400      blank line.\r
401 \r
402      The margins which JOE uses for paragraph formatting and\r
403      word-wrap can be set with the ^T L and ^T R commands.  If\r
404      the left margin is set to a value other than 1, then when\r
405      you start typing at the beginning of a line, the cursor will\r
406      immediately jump to the left margin.\r
407 \r
408      If you want to center a line within the margins, use the ^K\r
409      A command.\r
410 \r
411 \r
412      Over-type mode\r
413 \r
414      Sometimes it's tiresome to have to delete old text before or\r
415      after you insert new text.  This happens, for example, when\r
416      you are changing a table and you want to maintain the column\r
417      position of the right side of the table. When this occurs,\r
418      you can put the editor in over-type mode with ^T T. When the\r
419      editor is in this mode, the characters you type in replace\r
420      existing characters, in the way an idealized typewriter\r
421      would.  Also, Backspace simply moves left instead of delet-\r
422      ing the character to the left, when it's not at the end or\r
423      beginning of a line.  Over-type mode is not the natural way\r
424      of dealing with text electronically, so you should go back\r
425      to insert-mode as soon as possible by typing ^T T again.\r
426 \r
427      If you need to insert while you're in over-type mode, hit\r
428      ^@.  This inserts a single SPACE into the text.\r
429 \r
430 \r
431      Control and Meta characters\r
432 \r
433      Each character is represented by a number.  For example, the\r
434      number for 'A' is 65 and the number for '1' is 49.  All of\r
435      the characters which you normally see have numbers in the\r
436      range of 32 - 126 (this particular arbitrary assignment\r
437      between characters and numbers is called the ASCII character\r
438      set).  The numbers outside of this range, from 0 to 255,\r
439      aren't usually displayed, but sometimes have other special\r
440      meanings.  The number 10, for example, is used for the\r
441      line-breaks.  You can enter these special, non-displayed\r
442      control characters by first hitting ` and then hitting a\r
443      character in the range @ A B C ... X Y Z [ ^ ] \ _ to get\r
444      the number 0 - 31, and ? to get 127.  For example, if you\r
445      hit ` J, you'll insert a line-break character, or if you hit\r
446      ` I, you'll insert a TAB character (which does the same\r
447      thing the TAB key does).  A useful control character to\r
448      enter is 12 (` L), which causes most printers to advance to\r
449      the top of the page.  You'll notice that JOE displays this\r
450      character as an underlined L.  You can enter the characters\r
451      above 127, the meta characters, by first hitting ^\.  This\r
452      adds 128 to the next (possibly control) character entered.\r
453      JOE displays characters above 128 in inverse-video.  Some\r
454      foreign languages, which have more letters than English, use\r
455      the meta characters for the rest of their alphabet.  You\r
456      have to put the editor in ASIS mode (described later) to\r
457      have these passed untranslated to the terminal.\r
458 \r
459 \r
460      Prompts\r
461 \r
462      If you hit TAB at any file name prompt, joe will attempt to\r
463      complete the name you entered as much as possible.  If it\r
464      couldn't complete the entire name, because there are more\r
465      than one possible completions, joe beeps.  If you hit TAB\r
466      again, joe list the completions.  You can use the arrow keys\r
467      to move around this directory menu and press RETURN or SPACE\r
468      to select an item.  If you press the first letter of one of\r
469      the directory entries, it will be selected, or if more than\r
470      one entry has the same first letter, the cursor will jump\r
471      between those entries.  If you select a subdirectory or ..,\r
472      the directory name is appended to the prompt and the new\r
473      directory is loaded into the menu.  You can hit Backspace to\r
474      go back to the previous directory.\r
475 \r
476      Most prompts record a history of the responses you give\r
477      them.  You can hit up and down arrow to step through these\r
478      histories.\r
479 \r
480      Prompts are actually single line windows with no status\r
481      line, so you can use any editing command that you normally\r
482      use on text within the prompts.  The prompt history is actu-\r
483      ally just other lines of the same "prompt file".  Thus you\r
484      can can search backwards though the prompt history with the\r
485      normal ^K F command if you want.\r
486 \r
487      Since prompts are windows, you can also switch out of them\r
488      with ^K P and ^K N.\r
489 \r
490 \r
491      Where am I?\r
492 \r
493      Hit ^K SPACE to have JOE report the line number, column\r
494      number, and byte number on the last line of the screen.  The\r
495      number associated with the character the cursor is on (its\r
496      ASCII code) is also shown.  You can have the line number\r
497      and/or column number always displayed on the status line by\r
498      setting placing the appropriate escape sequences in the\r
499      status line setup strings.  Edit the joerc file for details.\r
500 \r
501 \r
502      File operations\r
503 \r
504      You can hit ^K D to save the current file (possibly under a\r
505      different name from what the file was called originally).\r
506      After the file is saved, you can hit ^K E to edit a dif-\r
507      ferent file.\r
508 \r
509      If you want to save only a selected section of the file, see\r
510      the section on Blocks below.\r
511 \r
512      If you want to include another file in the file you're edit-\r
513      ing, use ^K R to insert it.\r
514 \r
515 \r
516      Temporarily suspending the editor\r
517 \r
518      If you need to temporarily stop the editor and go back to\r
519      the shell, hit ^K Z.  You might want to do this to stop\r
520      whatever you're editing and answer an e-mail message or read\r
521      this man page, for example.  You have to type fg or exit\r
522      (you'll be told which when you hit ^K Z) to return to the\r
523      editor.\r
524 \r
525 \r
526      Searching for text\r
527 \r
528      Hit ^K F to have the editor search forwards or backwards for\r
529      a text fragment (string) for you.  You will be prompted for\r
530      the text to search for.  After you hit Return, you are\r
531      prompted to enter options. You can just hit Return again to\r
532      have the editor immediately search forwards for the text, or\r
533      you can enter one or more of these options:\r
534 \r
535      b    Search backwards instead of forwards.\r
536 \r
537      i    Treat uppercase and lower case letters as the same when\r
538           searching.  Normally uppercase and lowercase letters\r
539           are considered to be different.\r
540 \r
541      nnn  (where nnn is a number) If you enter a number, JOE\r
542           searches for the Nth occurrence of the text.  This is\r
543           useful for going to specific places in files structured\r
544           in some regular manner.\r
545 \r
546      r    Replace text.  If you enter the r option, then you will\r
547           be further prompted for replacement text.  Each time\r
548           the editor finds the search text, you will be prompted\r
549           as to whether you want to replace the found search text\r
550           with the replacement text.  You hit: y to replace the\r
551           text and then find the next occurrence, n to not\r
552           replace this text, but to then find the next\r
553           occurrence, l to replace the text and then stop search-\r
554           ing, r to replace all of the remaining occurrences of\r
555           the search text in the remainder of the file without\r
556           asking for confirmation (subject to the nnn option\r
557           above), or ^C to stop searching and replacing.\r
558 \r
559      You can hit ^L to repeat the previous search.\r
560 \r
561 \r
562      Regular Expressions\r
563 \r
564      A number of special character sequences may be entered as\r
565      search text:\r
566 \r
567      \*   This finds zero or more characters.  For example, if\r
568           you give A\*B as the search text, JOE will try to find\r
569           an A followed by any number of characters and then a B.\r
570 \r
571      \?   This finds exactly one character.  For example, if you\r
572           give A\?B as the search text, JOE will find AXB, but\r
573           not AB or AXXB.\r
574 \r
575      \^ \$\r
576           These match the beginning and end of a line.  For exam-\r
577           ple, if you give \^test\$, then JOE with find test on a\r
578           line by itself.\r
579 \r
580      \< \>\r
581           These match the beginning and end of a word.  For\r
582           example, if you give \<\*is\*\>, then joe will find\r
583           whole words which have the sub-string is within them.\r
584 \r
585      \[...]\r
586           This matches any single character which appears within\r
587           the brackets.  For example, if \[Tt]his is entered as\r
588           the search string, then JOE finds both This and this.\r
589           Ranges of characters can be entered within the brack-\r
590           ets.  For example, \[A-Z] finds any uppercase letter.\r
591           If the first character given in the brackets is ^, then\r
592           JOE tries to find any character not given in the the\r
593           brackets.\r
594 \r
595      \c   This works like \*, but matches a balanced C-language\r
596           expression. For example, if you search for malloc(\c),\r
597           then JOE will find all function calls to malloc, even\r
598           if there was a ) within the parenthesis.\r
599 \r
600      \+   This finds zero or more of the character which immedi-\r
601           ately follows the \+.  For example, if you give \[\r
602           ]\+\[ ], where the characters within the brackets are\r
603           both SPACE and TAB, then JOE will find whitespace.\r
604 \r
605      \\   Matches a single \.\r
606 \r
607      \n   This finds the special end-of-line or line-break char-\r
608           acter.\r
609 \r
610      A number of special character sequences may also be given in\r
611      the replacement string:\r
612 \r
613      \&   This gets replaced by the text which matched the search\r
614           string.  For example, if the search string was \<\*\>,\r
615           which matches words, and you give "\&", then joe will\r
616           put quote marks around words.\r
617 \r
618      \0 - \9\r
619           These get replaced with the text which matched the Nth\r
620           \*, \?, \+, \c, \+, or \[...] in the search string.\r
621 \r
622      \\   Use this if you need to put a \ in the replacement\r
623           string.\r
624 \r
625      \n   Use this if you need to put a line-break in the\r
626           replacement string.\r
627 \r
628      Some examples:\r
629 \r
630      Suppose you have a list of addresses, each on a separate\r
631      line, which starts with "Address:" and has each element\r
632      separated by commas.  Like so:\r
633 \r
634      Address: S. Holmes, 221b Baker St., London, England\r
635 \r
636      If you wanted to rearrange the list, to get the country\r
637      first, then the city, then the person's name, and then the\r
638      address, you could do this:\r
639 \r
640      Type ^K F to start the search, and type:\r
641 \r
642      Address:\*,\*,\*,\*\$\r
643 \r
644      to match "Address:", the four comma-separated elements, and\r
645      then the end of the line.  When asked for options, you would\r
646      type r to replace the string, and then type:\r
647 \r
648      Address:\3,\2,\0,\1\r
649 \r
650      To shuffle the information the way you want it. After hit-\r
651      ting return, the search would begin, and the sample line\r
652      would be changed to:\r
653 \r
654      Address: England, London, S. Holmes, 221b Baker St.\r
655 \r
656 \r
657      Blocks\r
658 \r
659      If you want to move, copy, save or delete a specific section\r
660      of text, you can do it with highlighted blocks.  First, move\r
661      the cursor to the start of the section of text you want to\r
662      work on, and press ^K B.  Then move the cursor to the char-\r
663      acter just after the end of the text you want to affect and\r
664      press ^K K.  The text between the ^K B and ^K K should\r
665      become highlighted.  Now you can move your cursor to some-\r
666      place else in your document and press ^K M to move the\r
667      highlighted text there. You can press ^K C to make a copy of\r
668      the highlighted text and insert it to where the cursor is\r
669      positioned.  ^K Y to deletes the highlighted text.  ^K W,\r
670      writes the highlighted text to a file.\r
671 \r
672      A very useful command is ^K /, which filters a block of text\r
673      through a unix command.  For example, if you select a list\r
674      of words with ^K B and ^K K, and then type ^K / sort, the\r
675      list of words will be sorted.  Another useful unix command\r
676      for ^K /, is tr.  If you type ^K / tr a-z A-Z, then all of\r
677      the letters in the highlighted block will be converted to\r
678      uppercase.\r
679 \r
680      After you are finished with some block operations, you can\r
681      just leave the highlighting on if you don't mind it (of\r
682      course, if you accidently hit ^K Y without noticing...).  If\r
683      it really bothers you, however, just hit ^K B ^K K, to turn\r
684      the highlighting off.\r
685 \r
686 \r
687      Indenting program blocks\r
688 \r
689      Auto-indent mode toggled with the ^T I command.  The joerc\r
690      is normally set up so that files with names ending with .p,\r
691      .c or .h have auto-indent mode enabled.  When auto-indent\r
692      mode is enabled and you hit Return, the cursor will be\r
693      placed in the same column that the first non-SPACE/TAB char-\r
694      acter was in on the original line.\r
695 \r
696      You can use the ^K , and ^K . commands to shift a block of\r
697      text to the left or right.  If no highlighting is set when\r
698      you give these commands, the program block the cursor is\r
699      located in will be selected, and will be moved by subsequent\r
700      ^K , and ^K . commands.  The number of columns these com-\r
701      mands shift by can be set through a ^T option.\r
702 \r
703 \r
704      Windows\r
705 \r
706      You can edit more than one file at the same time or edit two\r
707      or more different places of the same file.  To do this, hit\r
708      ^K O, to split the screen into two windows.  Use ^K P or ^K\r
709      N to move the cursor into the top window or the lower win-\r
710      dow.  Use ^K E to edit a new file in one of the windows.  A\r
711      window will go away when you save the file with ^K X or\r
712      abort the file with ^C.  If you abort a file which exists in\r
713      two windows, one of the window goes away, not the file.\r
714 \r
715      You can hit ^K O within a window to create even more win-\r
716      dows.  If you have too many windows on the screen, but you\r
717      don't want to eliminate them, you can hit ^K I.  This will\r
718      show only the window the cursor is in, or if there was only\r
719      one window on the screen to begin with, try to fit all hid-\r
720      den windows on the screen.  If there are more windows than\r
721      can fit on the screen, you can hit ^K N on the bottom-most\r
722      window or ^K P on the top-most window to get to them.\r
723 \r
724      If you gave more than one file name to JOE on the command\r
725      line, each file will be placed in a different window.\r
726 \r
727      You can change the height of the windows with the ^K G and\r
728      ^K T commands.\r
729 \r
730 \r
731      Keyboard macros\r
732 \r
733      Macros allow you to record a series of keystrokes and replay\r
734      them with the press of two keys.  This is useful to automate\r
735      repetitive tasks.  To start a macro recording, hit ^K [ fol-\r
736      lowed by a number from 0 to 9.  The status line will display\r
737      (Macro n recording...).  Now, type in the series of keys-\r
738      trokes that you want to be able to repeat.  The commands you\r
739      type will have their usual effect. Hit ^K ] to stop record-\r
740      ing the macro.  Hit ^K followed by the number you recorded\r
741      the macro in to execute one iteration of the key-strokes.\r
742 \r
743      For example, if you want to put "**" in front of a number of\r
744      lines, you can type:\r
745 \r
746      ^K [ ^A ** <down arrow> ^K ]\r
747 \r
748      Which starts the macro recording, moves the cursor to the\r
749      beginning of the line, inserts "**", moves the cursor down\r
750      one line, and then ends the recording. Since we included the\r
751      key-strokes needed to position the cursor on the next line,\r
752      we can repeatedly use this macro without having to move the\r
753      cursor ourselves, something you should always keep in mind\r
754      when recording a macro.\r
755 \r
756      If you find that the macro you are recording itself has a\r
757      repeated set of key-strokes in it, you can record a macro\r
758      within the macro, as long as you use a different macro\r
759      number.  Also you can execute previously recorded macros\r
760      from within new macros.\r
761 \r
762 \r
763      Repeat\r
764 \r
765      You can use the repeat command, ^K \, to repeat a macro, or\r
766      any other edit command or even a normal character, a speci-\r
767      fied number of times.  Hit ^K \, type in the number of times\r
768      you want the command repeated and press Return.  The next\r
769      edit command you now give will be repeated that many times.\r
770 \r
771      For example, to delete the next 20 lines of text, type:\r
772 \r
773      ^K  20<return>^Y\r
774 \r
775 \r
776      Rectangle mode\r
777 \r
778      Type ^T X to have ^K B and ^K K select rectangular blocks\r
779      instead of stream-of-text blocks.  This mode is useful for\r
780      moving, copying, deleting or saving columns of text.  You\r
781      can also filter columns of text with the ^K / command- if\r
782      you want to sort a column, for example.  The insert file\r
783      command, ^K R is also effected.\r
784 \r
785      When rectangle mode is selected, over-type mode is also use-\r
786      ful (^T T).  When over-type mode is selected, rectangles\r
787      will replace existing text instead of getting inserted\r
788      before it.  Also the delete block command (^K Y) will clear\r
789      the selected rectangle with SPACEs and TABs instead of\r
790      deleting it.  Over-type mode is especially useful for the\r
791      filter block command (^K /), since it will maintain the ori-\r
792      ginal width of the selected column.\r
793 \r
794 \r
795      Tag search\r
796 \r
797      If you are editing a large C program with many source files,\r
798      you can use the ctags program to generate a tags file.  This\r
799      file contains a list of program symbols and the files and\r
800      positions where the symbols are defined.  The ^K ; command\r
801      can be used to lookup a symbol (functions, defined con-\r
802      stants, etc.), load the file where the symbol is defined\r
803      into the current window and position the cursor to where the\r
804      symbol is defined. ^K ; prompts you for the symbol you want,\r
805      but uses the symbol the cursor was on as a default.  Since\r
806      ^K ; loads the definition file into the current window, you\r
807      probably want to split the window first with ^K O, to have\r
808      both the original file and the definition file loaded.\r
809 \r
810 \r
811      Shell windows\r
812 \r
813      Hit ^K ' to run a command shell in one of JOE's windows.\r
814      When the cursor is at the end of a shell window (use ^K V if\r
815      it's not), whatever you type is passed to the shell instead\r
816      of the window.  Any output from the shell or from commands\r
817      executed in the shell is appended to the shell window (the\r
818      cursor will follow this output if it's at the end of the\r
819      shell window).  This command is useful for recording the\r
820      results of shell commands- for example the output of make,\r
821      the result of grepping a set of files for a string, or\r
822      directory listings from FTP sessions. Besides typeable char-\r
823      acters, the keys ^C, Backspace, DEL, Return and ^D are\r
824      passed to the shell.  Type the shell exit command to stop\r
825      recording shell output.  If you press ^C in a shell window,\r
826      when the cursor is not at the end of the window, the shell\r
827      is killed.\r
828 \r
829 Environment variables\r
830      For JOE to operate correctly, a number of other environment\r
831      settings must be correct.  The throughput (baud rate) of the\r
832      connection between the computer and your terminal must be\r
833      set correctly for JOE to update the screen smoothly and\r
834      allow typeahead to defer the screen update.  Use the stty\r
835      nnn command to set this.  You want to set it as close as\r
836      possible to actual throughput of the connection.  For exam-\r
837      ple, if you are connected via a 1200 baud modem, you want to\r
838      use this value for stty.  If you are connected via 14.4k\r
839      modem, but the terminal server you are connected to connects\r
840      to the computer a 9600 baud, you want to set your speed as\r
841      9600 baud.  The special baud rate of 38400 or extb is used\r
842      to indicate that you have a very-high speed connection, such\r
843      as a memory mapped console or an X-window terminal emulator.\r
844      If you can't use stty to set the actual throughput (perhaps\r
845      because of a modem communicating with the computer at a dif-\r
846      ferent rate than it's communicating over the phone line),\r
847      you can put a numeric value in the BAUD environment variable\r
848      instead (use setenv BAUD 9600 for csh or BAUD=9600; export\r
849      BAUD for sh).\r
850 \r
851      The SHELL or EXECSHELL environment variable must be set to\r
852      the full pathname of a shell executable that accepts the -i\r
853      (interactive) and -c (run a command) arguments of the Korn\r
854      Shell; otherwise, /bin/sh is used.\r
855 \r
856      The TERM environment variable must be set to the type of\r
857      terminal you're using.  If the size (number of\r
858      lines/columns) of your terminal is different from what is\r
859      reported in the TERMCAP or TERMINFO entry, you can set this\r
860      with the stty rows nn cols nn command, or by setting the\r
861      LINES and COLUMNS environment variables.\r
862 \r
863      The xterm-xfree86 terminal allows automatic entering and\r
864      leaving of the bracketed paste mode.\r
865 \r
866      JOE normally expects that flow control between the computer\r
867      and your terminal to use ^S/^Q handshaking (I.E., if the\r
868      computer is sending characters too fast for your terminal,\r
869      your terminal sends ^S to stop the output and ^Q to restart\r
870      it).  If the flow control uses out-of-band or hardware\r
871      handshaking or if your terminal is fast enough to always\r
872      keep up with the computer output and you wish to map ^S/^Q\r
873      to edit commands, you can set the environment variable NOXON\r
874      to have JOE attempt to turn off ^S/^Q handshaking.  If the\r
875      connection between the computer and your terminal uses no\r
876      handshaking and your terminal is not fast enough to keep up\r
877      with the output of the computer, you can set the environment\r
878      variable DOPADDING to have JOE slow down the output by\r
879      interspersing PAD characters between the terminal screen\r
880      update sequences.\r
881 \r
882 Filenames\r
883      Wherever JOE expects you to enter a file name, whether on\r
884      the command line or in prompts within the editor, you may\r
885      also type:\r
886 \r
887      !command\r
888           Read or write data to or from a shell command.  For\r
889           example, use joe '!ls' to get a copy of your directory\r
890           listing to edit or from within the editor use ^K D\r
891           !mail jhallen@world.std.com to send the file being\r
892           edited to me.\r
893 \r
894      >>filename\r
895           Use this to have JOE append the edited text to the end\r
896           of the file "filename."\r
897 \r
898      filename,START,SIZE\r
899           Use this to access a fixed section of a file or device.\r
900           START and SIZE may be entered in decimal (ex.: 123)\r
901           octal (ex.: 0777) or hexadecimal (ex.: 0xFF).  For\r
902           example, use joe /dev/fd0,508,2 to edit bytes 508 and\r
903           509 of the first floppy drive in Linux.\r
904 \r
905      -    Use this to get input from the standard input or to\r
906           write output to the standard output.  For example, you\r
907           can put joe in a pipe of commands: quota -v | joe - |\r
908           mail root, if you want to complain about your low\r
909           quota.\r
910 \r
911 The joerc file\r
912      ^T options, the help screens and the key-sequence to editor\r
913      command bindings are all defined in JOE's initialization\r
914      file.  If you make a copy of this file (which resides in\r
915      c:/windows/system32/joe/joerc) to $HOME/.joerc, you can cu-\r
916      stomize these setting to your liking.  The syntax of the\r
917      initialization file should be fairly obvious and there are\r
918      further instruction in it.\r
919 \r
920 Acknowledgments\r
921      JOE was written by Joseph H. Allen.  If you have bug reports\r
922      or questions, e-mail them to jhallen@world.std.com.  Larry\r
923      Foard (entropy@world.std.com) and Gary Gray\r
924      (ggray@world.std.com) also helped with the creation of JOE.\r
925      Thorsten Glaser (tg@mirbsd.org) created JUPP, and the 16-bit\r
926      MS-DOS version of JUPP 2.8 was compiled by Andreas Totlis\r
927      (atotlis@t-online.de).\r