diff options
Diffstat (limited to 'usr.bin/ee/ee.1')
| -rw-r--r-- | usr.bin/ee/ee.1 | 320 |
1 files changed, 160 insertions, 160 deletions
diff --git a/usr.bin/ee/ee.1 b/usr.bin/ee/ee.1 index 708b7f5..4425992 100644 --- a/usr.bin/ee/ee.1 +++ b/usr.bin/ee/ee.1 @@ -17,27 +17,27 @@ .Op +# .Op Ar .Sh DESCRIPTION -The command -.Nm -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 command -.Nm ree -is the same as +The command +.Nm +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 command +.Nm ree +is the same as .Nm , -but restricted to editing the named +but restricted to editing the named file (no file operations, or shell escapes are allowed). .Pp -For +For .Nm -to work properly, the environment variable -.Ev TERM -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 +to work properly, the environment variable +.Ev TERM +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 you need more information. .Pp The following options are available: @@ -47,28 +47,28 @@ Turn off expansion of tab character to spaces. .It Fl i Turn off display of information window at top of terminal. .It Fl h -Turn off highlighting of borders of windows and menus (improves +Turn off highlighting of borders of windows and menus (improves performance on some terminals). .It Sy +# Move the cursor to line '#' at startup. .El .Ss "Control keys" -To do anything other than insert text, the user must use the control -keys (the -.Li Control -key, represented by a "^", pressed in conjunction with an -alphabetic key, e.g., ^a) and function keys available on the keyboard -(such as +To do anything other than insert text, the user must use the control +keys (the +.Li Control +key, represented by a "^", pressed in conjunction with an +alphabetic key, e.g., ^a) and function keys available on the keyboard +(such as .Em "Next Page" , .Em "Prev Page" , arrow keys, etc.). .Pp -Since not all terminals have function keys, +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 -instance, to move the cursor up, the user can use the up arrow key, -or +has the basic cursor movement functions assigned to control keys as +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 . .Bl -tag -width indent .It ^a @@ -123,10 +123,10 @@ Undelete the last deleted line. Pop up menu. .El .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 -.Em settings +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 +.Em settings menu, or via the initialization file (see below). The mappings are as follows: .Bl -tag -width indent .It ^a @@ -194,11 +194,11 @@ Insert a newline at the cursor position. 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 -obtained by pressing the +Some operations require more information than a single keystroke can +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 @@ -235,23 +235,23 @@ Write the text to the named .Ar file . .El .Ss "Menu Operations" -Pop-up menus can be obtained by pressing the -.Em escape -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 -down arrow keys, or +Pop-up menus can be obtained by pressing the +.Em escape +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 +down arrow keys, or .Em ^u -for moving up and -.Em ^d -for moving down to move to the desired items in the menu, then press -.Em return +for moving up and +.Em ^d +for moving down to move to the desired items in the menu, then press +.Em return to perform the indicated task. .Pp -To the left of each menu item is a letter, which if the corresponding +To the left of each menu item is a letter, which if the corresponding letter is pressed on the keyboard selects that menu entry. .Pp The main menu in @@ -259,30 +259,30 @@ The main menu in is as follows: .Bl -tag -width indent .It leave editor -If changes have been made, the user will get a menu prompting whether or +If changes have been made, the user will get a menu prompting whether or not the changes should be saved. .It help Display a help screen, with all of the keyboard operations and commands. .It file operations -Pop up a menu for selecting whether to read a file, write to a file, or -save the current contents of the editor, as well as send the contents of +Pop up a menu for selecting whether to read a file, write to a file, or +save the current contents of the editor, as well as send the contents of the editor to a print command (see the section .Sx "Initializing ee from a file" ) . .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 -pressing return when the cursor is on a particular item, the value can be +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 .Em escape key. (See .Sx Modes below.) .It search -Pop up a menu in which the user may choose to enter a string to search +Pop up a menu in which the user may choose to enter a string to search for, or search for a string already entered. .It miscellaneous -Pop up a menu that allows the user to format the current paragraph, +Pop up a menu that allows the user to format the current paragraph, execute a shell command, or check the spelling of the text in the editor. .El .Ss "Paragraph Formatting" @@ -298,133 +298,133 @@ Line with no characters, or only spaces and/or tabs. Line starting with a period ('.') or right angle bracket ('>'). .El .Pp -A paragraph may be formatted two ways: explicitly by choosing the +A paragraph may be formatted two ways: explicitly by choosing the .Em format paragraph menu item, or by setting .Nm -to automatically -format paragraphs. The automatic mode may be set via a menu, or via the +to automatically +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 .Nm : -free-form, margins, +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 +"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 +menu, the default is for the margin to be the right edge of 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 +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 automatic formatting to occur. .Ss Modes Although .Nm -is a 'modeless' editor (it is in text insertion mode all the +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: .Bl -tag -width indent .It tab expansion Tabs may be inserted as a single tab character, or replaced with spaces. .It case sensitivity -The search operation can be sensitive to whether characters are upper- or +The search operation can be sensitive to whether characters are upper- or lower-case, or ignore case completely. .It margins observed Lines can either be truncated at the right margin, or extend on forever. .It auto paragraph formatting -While typing in text, the editor can try to keep it looking reasonably well +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 +Toggle whether eight bit characters are displayed as their value in angle brackets (e.g. "<220>") or as a character. .It info window -A window showing the keyboard operations that can be performed can be +A window showing the keyboard operations that can be performed can be displayed or not. .It emacs keys 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 +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. .El .Pp -You may set these modes via the initialization file (see below), or with a +You may set these modes via the initialization file (see below), or with a menu (see above). .Ss "Spell Checking" There are two ways to have the spelling in the text checked from .Nm . One is by the traditional .Xr spell 1 -command, the other is with the +command, the other is with the optional .Xr ispell 1 command. .Pp Using .Nm spell , -the words that are not recognized will be placed at the top +the words that are not recognized will be placed at the top of the file. For the .Nm ispell -option, the file is written to disk, +option, the file is written to disk, then .Nm ispell -run on the file, and the file read back in once +run on the file, and the file read back in once .Nm ispell has completed making changes to the file. .Ss "Printing the contents of the editor" -The user may select a menu item which prints the contents of the editor. +The user may select a menu item which prints the contents of the editor. .Nm -pipes the text in the editor to the command specified by the -initialization command +pipes the text in the editor to the command specified by the +initialization command .Em printcommand -(see the section +(see the section .Sx Initializing ee from a file below). The default is to send the contents to -.Xr lp 1 . +.Xr lp 1 . .Pp -Whatever the user assigns to -.Em printcommand -must take input from +Whatever the user assigns to +.Em printcommand +must take input from standard input. See your system administrator for more details. .Ss "Shell operations" -Shell commands can be executed from within -.Nm -by selecting the -.Em shell command -item in the -.Em miscellaneous -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 -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 -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 -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 -to be sorted, they could be sorted by typing the following at the command +Shell commands can be executed from within +.Nm +by selecting the +.Em shell command +item in the +.Em miscellaneous +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 +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 +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 +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 +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 +.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. .Ss "Initializing ee from a file" Since different users have different preferences, .Nm -allows some -slight configurability. There are three possible locations for an +allows some +slight configurability. There are three possible locations for an initialization file for .Nm : the file @@ -433,21 +433,21 @@ the file .Pa .init.ee 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 +in the current directory (if different from the home +directory). This allows system administrators to set some preferences for the users on a system-wide basis (for example, the .Em print -command), -and the user to customize settings for particular directories (like one +command), +and the user to customize settings for particular directories (like one for correspondence, and a different directory for programming). .Pp The file .Pa /usr/share/misc/init.ee -is read first, then +is read first, then .Pa $HOME/.init.ee , then .Pa .init.ee , -with the settings specified by the +with the settings specified by the most recent file read taking precedence. .Pp The following items may be entered in the initialization file: @@ -465,30 +465,30 @@ Cause .Nm to insert tabs as a single character. .It info -A small information window is displayed at the top of the terminal +A small information window is displayed at the top of the terminal (default). .It noinfo Turn off the display of the information window. .It margins Cause .Nm -to truncate lines at the right margin when the -cursor passes beyond the right margin as set by the user -while text is being inserted +to truncate lines at the right margin when the +cursor passes beyond the right margin as set by the user +while text is being inserted (default). .It nomargins Allow lines to extend beyond the right margin. .It autoformat Cause .Nm -to automatically try to format the current paragraph while +to automatically try to format the current paragraph while text insertion is occurring. .It noautoformat Turn off automatic paragraph formatting (default). .It printcommand Allow the setting of the print command (default: "lp"). .It rightmargin -The user can select a value for the right margin (the first column on the +The user can select a value for the right margin (the first column on the screen is zero). .It highlight Turn on highlighting of border of information window and menus (default). @@ -497,7 +497,7 @@ Turn off highlighting of border of information window and menus. .It eightbit Turn on display of eight bit characters. .It noeightbit -Turn off display of eight bit characters (they are displayed as their decimal +Turn off display of eight bit characters (they are displayed as their decimal value inside angle brackets, e.g., "<220>"). .It 16bit Turns on handling of 16-bit characters. @@ -509,48 +509,48 @@ Turns on emacs key bindings. Turns off emacs key bindings. .El .Ss "Save Editor Configuration" -When using this entry from the -.Em settings -menu, the user may choose to save the current configuration of +When using this entry from the +.Em settings +menu, the user may choose to save the current configuration of 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 -.Pa .init.ee -already exists, it will be renamed +above) to a file named +.Pa .init.ee +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 -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 -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 -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 -has done NO Quality Assurance on ANY -of the program or documentation. You may find -the quality of the materials inferior to -supported materials. +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 +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 +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 +has done NO Quality Assurance on ANY +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 +Always make a copy of files that cannot be easily reproduced before editing. Save files early, and save often. .Ss "International Code Set Support" .Nm Ee -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 -reason Big-5 works is that a two-byte character also takes up two columns on +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 +reason Big-5 works is that a two-byte character also takes up two columns on the screen.) .Sh WARNINGS -The automatic paragraph formatting operation +The automatic paragraph formatting operation may be too slow for slower systems. .Sh FILES .Bl -tag -width /usr/share/misc/init.ee -compact @@ -559,14 +559,14 @@ may be too slow for slower systems. .It Pa .init.ee .El .Sh AUTHORS -The software +The software .Nm was developed by .An Hugh Mahon . .Pp -This software and documentation contains -proprietary information which is protected by -copyright. All rights are reserved. +This software and documentation contains +proprietary information which is protected by +copyright. All rights are reserved. .Pp Copyright (c) 1990, 1991, 1992, 1993, 1995, 1996 Hugh Mahon. .Sh "SEE ALSO" |
