diff options
Diffstat (limited to 'usr.bin/ee/ee.1')
-rw-r--r-- | usr.bin/ee/ee.1 | 128 |
1 files changed, 85 insertions, 43 deletions
diff --git a/usr.bin/ee/ee.1 b/usr.bin/ee/ee.1 index ad9676b..f57c992 100644 --- a/usr.bin/ee/ee.1 +++ b/usr.bin/ee/ee.1 @@ -20,9 +20,11 @@ The .Nm utility -is a simple screen oriented text editor. It is always in text insertion +is a simple screen oriented text editor. +It is always in text insertion mode unless there is a prompt at the bottom of the terminal, or a -menu present (in a box in the middle of the terminal). The +menu present (in a box in the middle of the terminal). +The .Nm ree utility is the same as .Nm , @@ -33,12 +35,14 @@ For .Nm to work properly, the environment variable .Ev TERM -must be set to indicate the type of terminal being used. For +must be set to indicate the type of terminal being used. +For example, for an .Tn HP 700/92 terminal, the .Ev TERM -variable should be set to "70092". See your System Administrator if +variable should be set to "70092". +See your System Administrator if you need more information. .Pp The following options are available: @@ -67,7 +71,8 @@ arrow keys, etc.). Since not all terminals have function keys, .Nm has the basic cursor movement functions assigned to control keys as -well as more intuitive keys on the keyboard when available. For +well as more intuitive keys on the keyboard when available. +For instance, to move the cursor up, the user can use the up arrow key, or .Em ^u . @@ -126,9 +131,11 @@ Pop up menu. .Ss "EMACS keys mode" Since many shells provide an Emacs mode (for cursor movement and other editing operations), some bindings that may be more useful for people familiar with -those bindings have been provided. These are accessible via the +those bindings have been provided. +These are accessible via the .Em settings -menu, or via the initialization file (see below). The mappings are as follows: +menu, or via the initialization file (see below). +The mappings are as follows: .Bl -tag -width indent .It ^a Move to the beginning of the line. @@ -196,10 +203,12 @@ Move the cursor in the direction indicated. .El .Ss Commands Some operations require more information than a single keystroke can -provide. For the most basic operations, there is a menu that can be +provide. +For the most basic operations, there is a menu that can be obtained by pressing the .Tn ESC -key. The same operations, and more can be performed by obtaining the +key. +The same operations, and more can be performed by obtaining the command prompt (^c) and typing in one of the commands below. .Bl -tag -width indent .It ! Ns Ar cmd @@ -242,8 +251,10 @@ key (or .Em ^[ if no .Em escape -key is present). When in the menu, the escape key can be -used to leave the menu without performing any operations. Use the up and +key is present). +When in the menu, the escape key can be +used to leave the menu without performing any operations. +Use the up and down arrow keys, or .Em ^u for moving up and @@ -272,11 +283,14 @@ the editor to a print command (see the section .It redraw screen Provide a means to repaint the screen if the screen has been corrupted. .It settings -Show the current values of the operating modes, and right margin. By +Show the current values of the operating modes, and right margin. +By pressing return when the cursor is on a particular item, the value can be -changed. To leave this menu, press the +changed. +To leave this menu, press the .Em escape -key. (See +key. +(See .Sx Modes below.) .It search @@ -304,7 +318,8 @@ A paragraph may be formatted two ways: explicitly by choosing the menu item, or by setting .Nm to automatically -format paragraphs. The automatic mode may be set via a menu, or via the +format paragraphs. +The automatic mode may be set via a menu, or via the initialization file. .Pp There are three states for text operation in @@ -312,29 +327,34 @@ There are three states for text operation in free-form, margins, and automatic formatting. .Pp -"Free-form" is best used for things like programming. There are no +"Free-form" is best used for things like programming. +There are no restrictions on the length of lines, and no formatting takes place. .Pp "Margins" allows the user to type in text without having to worry about going beyond the right margin (the right margin may be set in the .Em settings menu, the default is for the margin to be the right edge of the -terminal). This is the mode that allows the +terminal). +This is the mode that allows the .Em format paragraph menu item to work. .Pp -"Automatic formatting" provides word-processor-like behavior. The user +"Automatic formatting" provides word-processor-like behavior. +The user may type in text, while .Nm will make sure the entire paragraph fits within the width of the terminal every time the user inserts a space after -typing or deleting text. Margin observation must also be enabled in order for +typing or deleting text. +Margin observation must also be enabled in order for automatic formatting to occur. .Ss Modes Although .Nm is a 'modeless' editor (it is in text insertion mode all the -time), there are modes in some of the things it does. These include: +time), there are modes in some of the things it does. +These include: .Bl -tag -width indent .It tab expansion Tabs may be inserted as a single tab character, or replaced with spaces. @@ -348,7 +368,7 @@ While typing in text, the editor can try to keep it looking reasonably well within the width of the screen. .It eightbit characters Toggle whether eight bit characters are displayed as their value in angle -brackets (e.g. "<220>") or as a character. +brackets (e.g.\& "<220>") or as a character. .It info window A window showing the keyboard operations that can be performed can be displayed or not. @@ -356,7 +376,8 @@ displayed or not. Control keys may be given bindings similar to emacs, or not. .It 16 bit characters Toggles whether sixteen bit characters are handled as one 16-bit quantities or -two 8-bit quantities. This works primarily with the Chinese Big 5 code set. +two 8-bit quantities. +This works primarily with the Chinese Big 5 code set. .El .Pp You may set these modes via the initialization file (see below), or with a @@ -374,7 +395,8 @@ command. Using .Nm spell , the words that are not recognized will be placed at the top -of the file. For the +of the file. +For the .Nm ispell option, the file is written to disk, then @@ -391,13 +413,15 @@ initialization command .Em printcommand (see the section .Sx Initializing ee from a file -below). The default is to send the contents to +below). +The default is to send the contents to .Xr lp 1 . .Pp Whatever the user assigns to .Em printcommand must take input from -standard input. See your system administrator for more details. +standard input. +See your system administrator for more details. .Ss "Shell operations" Shell commands can be executed from within .Nm @@ -408,25 +432,31 @@ item in the menu, or by placing an exclamation mark ("!") before the command to execute at the .Em command: -prompt. Additionally, the user may direct the contents of the edit buffer +prompt. +Additionally, the user may direct the contents of the edit buffer out to a shell operation (via a pipe) by using the left angle bracket -(">"), followed by a "!" and the shell command to execute. The output of +(">"), followed by a "!" and the shell command to execute. +The output of a shell operation can also be directed into the edit buffer by using a -right angle bracket ("<") before the exclamation mark. These can even be +right angle bracket ("<") before the exclamation mark. +These can even be used together to send output to a shell operation and read back the -results into the editor. So, if the editor contained a list of words +results into the editor. +So, if the editor contained a list of words to be sorted, they could be sorted by typing the following at the command prompt: .Dl ><!sort This would send the contents of the editor to be piped into the .Xr sort 1 utility and the result would be placed into the edit buffer at the current -cursor location. The old information would have to be deleted by the user. +cursor location. +The old information would have to be deleted by the user. .Ss "Initializing ee from a file" Since different users have different preferences, .Nm allows some -slight configurability. There are three possible locations for an +slight configurability. +There are three possible locations for an initialization file for .Nm : the file @@ -436,7 +466,8 @@ the file in the user's home directory, or the file .Pa .init.ee in the current directory (if different from the home -directory). This allows system administrators to set some preferences for +directory). +This allows system administrators to set some preferences for the users on a system-wide basis (for example, the .Em print command), @@ -518,38 +549,48 @@ the editor (see .Sx Initializing ee from a file above) to a file named .Pa .init.ee -in the current directory or the user's home directory. If a file named +in the current directory or the user's home directory. +If a file named .Pa .init.ee already exists, it will be renamed .Pa .init.ee.old . .Sh CAVEATS -THIS MATERIAL IS PROVIDED "AS IS". THERE ARE +THIS MATERIAL IS PROVIDED "AS IS". +THERE ARE NO WARRANTIES OF ANY KIND WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND -FITNESS FOR A PARTICULAR PURPOSE. Neither +FITNESS FOR A PARTICULAR PURPOSE. +Neither Hewlett-Packard nor Hugh Mahon shall be liable for errors contained herein, nor for incidental or consequential damages in connection with the furnishing, performance or -use of this material. Neither Hewlett-Packard +use of this material. +Neither Hewlett-Packard nor Hugh Mahon assumes any responsibility for the use or reliability of this software or -documentation. This software and -documentation is totally UNSUPPORTED. There -is no support contract available. Hewlett-Packard +documentation. +This software and +documentation is totally UNSUPPORTED. +There +is no support contract available. +Hewlett-Packard has done NO Quality Assurance on ANY -of the program or documentation. You may find +of the program or documentation. +You may find the quality of the materials inferior to supported materials. .Pp Always make a copy of files that cannot be easily reproduced before -editing. Save files early, and save often. +editing. +Save files early, and save often. .Ss "International Code Set Support" The .Nm utility supports single-byte character code sets (eight-bit clean), or the -Chinese Big-5 code set. (Other multi-byte code sets may function, but the +Chinese Big-5 code set. +(Other multi-byte code sets may function, but the reason Big-5 works is that a two-byte character also takes up two columns on the screen.) .Sh WARNINGS @@ -569,7 +610,8 @@ was developed by .Pp This software and documentation contains proprietary information which is protected by -copyright. All rights are reserved. +copyright. +All rights are reserved. .Pp Copyright (c) 1990, 1991, 1992, 1993, 1995, 1996 Hugh Mahon. .Sh "SEE ALSO" |