23 is a simple screen oriented text editor.
24 It is always in text insertion
25 mode unless there is a prompt at the bottom of the terminal, or a
26 menu present (in a box in the middle of the terminal).
29 utility is the same as
31 but restricted to editing the named
32 file (no file operations, or shell escapes are allowed).
36 to work properly, the environment variable
38 must be set to indicate the type of terminal being used.
44 variable should be set to "70092".
45 See your System Administrator if
46 you need more information.
48 The following options are available:
49 .Bl -tag -width indent
51 Turn off expansion of tab character to spaces.
53 Turn off display of information window at top of terminal.
55 Turn off highlighting of borders of windows and menus (improves
56 performance on some terminals).
58 Move the cursor to line '#' at startup.
61 To do anything other than insert text, the user must use the control
64 key, represented by a "^", pressed in conjunction with an
65 alphabetic key, e.g., ^a) and function keys available on the keyboard
71 Since not all terminals have function keys,
73 has the basic cursor movement functions assigned to control keys as
74 well as more intuitive keys on the keyboard when available.
76 instance, to move the cursor up, the user can use the up arrow key,
79 .Bl -tag -width indent
81 Prompt for the decimal value of a character to insert.
83 Move to the bottom of the text.
85 Get the prompt for a command.
89 Prompt for the string to search for.
91 Undelete the last deleted character.
93 Move to the beginning of the line.
101 Delete the character the cursor is sitting on.
103 Move the cursor left.
107 Move to the next page.
109 Move to the end of the line.
111 Move to the previous page.
113 Move the cursor to the right.
115 Move to the top of the text.
119 Undelete the last deleted word.
121 Delete the word beginning at the cursor position.
125 Delete from the cursor position to the end of line.
127 Undelete the last deleted line.
131 .Ss "EMACS keys mode"
132 Since many shells provide an Emacs mode (for cursor movement and other editing
133 operations), some bindings that may be more useful for people familiar with
134 those bindings have been provided.
135 These are accessible via the
137 menu, or via the initialization file (see below).
138 The mappings are as follows:
139 .Bl -tag -width indent
141 Move to the beginning of the line.
147 Delete character the cursor is sitting on.
159 Undelete last deleted character.
163 Undelete last deleted line.
167 Move to the next line.
169 Prompt for the decimal value of a character to insert.
173 Restore last deleted word.
175 Move to the top of the text.
177 Move to the bottom of the text.
179 Move to the next page.
181 Delete the word beginning at the cursor position.
183 Prompt for the string to search for.
190 .Bl -tag -width indent
192 Move to the next page.
194 Move to the previous page.
196 Delete the character the cursor is on.
198 Delete from the cursor to the end of line.
200 Insert a newline at the cursor position.
202 Move the cursor in the direction indicated.
205 Some operations require more information than a single keystroke can
207 For the most basic operations, there is a menu that can be
208 obtained by pressing the
211 The same operations, and more can be performed by obtaining the
212 command prompt (^c) and typing in one of the commands below.
213 .Bl -tag -width indent
219 Move to the line indicated.
221 Make searches case sensitive.
223 Display the ASCII value of the character at the cursor.
225 Save the edited text, and leave the editor.
227 Expand tabs to spaces.
229 Print the name of the file.
233 Display the current line number.
235 Make searches insensitive to case (the default).
237 Don't expand tab to spaces when the TAB key is pressed.
239 Leave the editor without saving changes.
244 Write the text to the named
247 .Ss "Menu Operations"
248 Pop-up menus can be obtained by pressing the
255 When in the menu, the escape key can be
256 used to leave the menu without performing any operations.
262 for moving down to move to the desired items in the menu, then press
264 to perform the indicated task.
266 To the left of each menu item is a letter, which if the corresponding
267 letter is pressed on the keyboard selects that menu entry.
272 .Bl -tag -width indent
274 If changes have been made, the user will get a menu prompting whether or
275 not the changes should be saved.
277 Display a help screen, with all of the keyboard operations and commands.
279 Pop up a menu for selecting whether to read a file, write to a file, or
280 save the current contents of the editor, as well as send the contents of
281 the editor to a print command (see the section
282 .Sx "Initializing ee from a file" ) .
284 Provide a means to repaint the screen if the screen has been corrupted.
286 Show the current values of the operating modes, and right margin.
288 pressing return when the cursor is on a particular item, the value can be
290 To leave this menu, press the
297 Pop up a menu in which the user may choose to enter a string to search
298 for, or search for a string already entered.
300 Pop up a menu that allows the user to format the current paragraph,
301 execute a shell command, or check the spelling of the text in the editor.
303 .Ss "Paragraph Formatting"
304 Paragraphs are defined for
306 by a block of text bounded by:
307 .Bl -bullet -width indent
309 Begin or end of file.
311 Line with no characters, or only spaces and/or tabs.
313 Line starting with a period ('.') or right angle bracket ('>').
316 A paragraph may be formatted two ways: explicitly by choosing the
318 menu item, or by setting
322 The automatic mode may be set via a menu, or via the
325 There are three states for text operation in
328 and automatic formatting.
330 "Free-form" is best used for things like programming.
332 restrictions on the length of lines, and no formatting takes place.
334 "Margins" allows the user to type in text without having to worry about going
335 beyond the right margin (the right margin may be set in the
337 menu, the default is for the margin to be the right edge of the
339 This is the mode that allows the
343 "Automatic formatting" provides word-processor-like behavior.
345 may type in text, while
347 will make sure the entire paragraph fits
348 within the width of the terminal every time the user inserts a space after
349 typing or deleting text.
350 Margin observation must also be enabled in order for
351 automatic formatting to occur.
355 is a 'modeless' editor (it is in text insertion mode all the
356 time), there are modes in some of the things it does.
358 .Bl -tag -width indent
360 Tabs may be inserted as a single tab character, or replaced with spaces.
362 The search operation can be sensitive to whether characters are upper- or
363 lower-case, or ignore case completely.
365 Lines can either be truncated at the right margin, or extend on forever.
366 .It auto paragraph formatting
367 While typing in text, the editor can try to keep it looking reasonably well
368 within the width of the screen.
369 .It eightbit characters
370 Toggle whether eight bit characters are displayed as their value in angle
371 brackets (e.g.\& "<220>") or as a character.
373 A window showing the keyboard operations that can be performed can be
376 Control keys may be given bindings similar to emacs, or not.
377 .It 16 bit characters
378 Toggles whether sixteen bit characters are handled as one 16-bit quantities or
379 two 8-bit quantities.
380 This works primarily with the Chinese Big 5 code set.
383 You may set these modes via the initialization file (see below), or with a
386 There are two ways to have the spelling in the text checked from
388 One is by the traditional
390 command, the other is with the
397 the words that are not recognized will be placed at the top
401 option, the file is written to disk,
404 run on the file, and the file read back in once
406 has completed making changes to the file.
407 .Ss "Printing the contents of the editor"
408 The user may select a menu item which prints the contents of the editor.
411 utility pipes the text in the editor to the command specified by the
412 initialization command
415 .Sx Initializing ee from a file
417 The default is to send the contents to
420 Whatever the user assigns to
424 See your system administrator for more details.
425 .Ss "Shell operations"
426 Shell commands can be executed from within
432 menu, or by placing an exclamation mark ("!") before the command to
436 Additionally, the user may direct the contents of the edit buffer
437 out to a shell operation (via a pipe) by using the left angle bracket
438 (">"), followed by a "!" and the shell command to execute.
440 a shell operation can also be directed into the edit buffer by using a
441 right angle bracket ("<") before the exclamation mark.
443 used together to send output to a shell operation and read back the
444 results into the editor.
445 So, if the editor contained a list of words
446 to be sorted, they could be sorted by typing the following at the command
449 This would send the contents of the editor to be piped into the
451 utility and the result would be placed into the edit buffer at the current
453 The old information would have to be deleted by the user.
454 .Ss "Initializing ee from a file"
455 Since different users have different preferences,
458 slight configurability.
459 There are three possible locations for an
460 initialization file for
463 .Pa /usr/share/misc/init.ee ,
466 in the user's home directory, or the file
468 in the current directory (if different from the home
470 This allows system administrators to set some preferences for
471 the users on a system-wide basis (for example, the
474 and the user to customize settings for particular directories (like one
475 for correspondence, and a different directory for programming).
478 .Pa /usr/share/misc/init.ee
483 with the settings specified by the
484 most recent file read taking precedence.
486 The following items may be entered in the initialization file:
487 .Bl -tag -width indent
489 Set searches to be case sensitive.
491 Set searches to be insensitive to case (default).
495 to expand tabs to spaces (default).
499 to insert tabs as a single character.
501 A small information window is displayed at the top of the terminal
504 Turn off the display of the information window.
508 to truncate lines at the right margin when the
509 cursor passes beyond the right margin as set by the user
510 while text is being inserted
513 Allow lines to extend beyond the right margin.
517 to automatically try to format the current paragraph while
518 text insertion is occurring.
520 Turn off automatic paragraph formatting (default).
522 Allow the setting of the print command (default: "lp").
524 The user can select a value for the right margin (the first column on the
527 Turn on highlighting of border of information window and menus (default).
529 Turn off highlighting of border of information window and menus.
531 Turn on display of eight bit characters.
533 Turn off display of eight bit characters (they are displayed as their decimal
534 value inside angle brackets, e.g., "<220>").
536 Turns on handling of 16-bit characters.
538 Turns off handling of 16-bit characters.
540 Turns on emacs key bindings.
542 Turns off emacs key bindings.
544 .Ss "Save Editor Configuration"
545 When using this entry from the
547 menu, the user may choose to save the current configuration of
549 .Sx Initializing ee from a file
550 above) to a file named
552 in the current directory or the user's home directory.
555 already exists, it will be renamed
558 THIS MATERIAL IS PROVIDED "AS IS".
560 NO WARRANTIES OF ANY KIND WITH REGARD TO THIS
561 MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE
562 IMPLIED WARRANTIES OF MERCHANTABILITY AND
563 FITNESS FOR A PARTICULAR PURPOSE.
565 Hewlett-Packard nor Hugh Mahon shall be liable
566 for errors contained herein, nor for
567 incidental or consequential damages in
568 connection with the furnishing, performance or
569 use of this material.
570 Neither Hewlett-Packard
571 nor Hugh Mahon assumes any responsibility for
572 the use or reliability of this software or
575 documentation is totally UNSUPPORTED.
577 is no support contract available.
579 has done NO Quality Assurance on ANY
580 of the program or documentation.
582 the quality of the materials inferior to
585 Always make a copy of files that cannot be easily reproduced before
587 Save files early, and save often.
588 .Ss "International Code Set Support"
591 utility supports single-byte character code sets (eight-bit clean), or the
592 Chinese Big-5 code set.
593 (Other multi-byte code sets may function, but the
594 reason Big-5 works is that a two-byte character also takes up two columns on
597 The automatic paragraph formatting operation
598 may be too slow for slower systems.
600 .Bl -tag -width /usr/share/misc/init.ee -compact
601 .It Pa /usr/share/misc/init.ee
602 .It Pa $HOME/.init.ee
611 This software and documentation contains
612 proprietary information which is protected by
614 All rights are reserved.
616 Copyright (c) 1990, 1991, 1992, 1993, 1995, 1996 Hugh Mahon.