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