WPE INSTALLATION INSTRUCTIONS WPS-PLUSTM for ASCII files WPE Editor Version 5.0 ¹ Includes the MORE utility October, 1988 The WPE editor is similar to WPS-PLUSTM, but is intended for general use in editing ASCII files (e.g., LOGIN.COM, documentation, etc.). It matches WPS-PLUSTM where practical, and provides several extended capabilities including two-window editing. These installation instructions are intended for the system manager. Separate user documentation is provided. WPS-PLUSTM Digital Equipment Corporation ¹ This guide describes installation of WPE version 5.010 WPE Version 5.0 WPE Version 5.0 is a completely-rewritten version of WPE. There is significant new functionality, as well as improvements which utilize the features of VMS V5.0 and the associated versions of TPU and EVE. WPE Version 5.0 will not work with versions of VMS prior to 5.0. If you have not upgraded to VMS V5.0, WPE for VMS 4.x is available on previous VAX SIG tapes, OA SIG tapes, and from the DECUS Library. Previous versions of WPE will not work with VMS Version 5.0. TPU and EVE changed significantly at VMS 5.0, and "destroyed" much of WPE. This version of WPE has been tested through VMS Version 5.0-1, and DEC has promised not to break things this badly again. The last version of WPE for VMS 4.x was WPE Version 2.602. ** Important Note ** If you are upgrading from V2.x to V5.0 of WPE: Installation of WPE, and SYSTARTUP procedures, are all new for V5.0. In previous versions, WPE was run from the WPE.COM file. For this version, a DCL command (.CLD file) is provided. Although the files for "old way" installation are provided, you will get significant performance improvements from using the new method. In addition, a WPE_Startup.COM file is provided - to be run from your SYSTARTUP_V5.COM sequence. You will need to remove all previous references to WPE, and include the new procedure. If you are also using the DM (Directory Manager) package, you should also install the updated version (DM Version 8.005) after installing WPE. Installation Requirements About 3000 disk blocks are required for all versions of the documentation. About 4500 disk blocks are required during installation. By deleting all source files, this can be reduced to 1000-2000 blocks after installation (depending on options needed). Full installation of WPE requires 785 Global Pages and 5 Global Sections. The installation procedure assumes that the 19 EVE$xxx.TPU files supplied by installing VMS V5.0 are present in SYS$COMMON:[SYSHLP.EXAMPLES]. If this is not the case, you will not be able to rebuild WPE. You can use the procedure to install WPE, and ignore the error messages. Trying WPE without installation The following command will quickly test-drive WPE without installing it, but without many of the checks and features. edit/tpu/section=disk:[directory]wpe.tpu$section test.filename Note that a full disk-and-directory path is required for the TPU$SECTION (TPU otherwise assumes a location). Note also that on-line Help will not be available. When you exit from WPE, you will see an error message. Installing WPE and MORE These instructions are valid for VMS 5.0-1 General Information The recommended installation method provides a new DCL command for WPE, and other associated features. Alternative installation to run through a WPE.COM file is described later in this section. Either method uses MORE.COM to execute the MORE command. In WPE V5.0, non-default (local) definitions of locations of files are needed in only three places (if you accept all the defaults, modifications will not be needed): WPE_STARTUP.COM - which contains system-wide definitions. SYLOGIN_FRAGMENT.COM - which contains required, recommended, and optional login definitions of symbols. WPEDIT.CLD - which must contain the location of WPEMAIN.EXE, if it's not in SYS$SYSTEM. Recommended Installation Method INSTALL_WPE.COM is provided to automatically do the installation. You may wish to examine this file before executing it. Using this procedure results in installation of 3 new images on your system: wpe.tpu$section, wpemain.exe, and wpe_calluser.exe. DCLTABLES are modified and replaced. You need either SETPRV or (SYSNAM,CMKRNL) privileges to run INSTALL_WPE.COM. The following files are moved to the indicated locations: SYS$COMMON:[SYSLIB]DCLTABLES.EXE (modified, new version installed) SYS$COMMON:[SYSLIB]WPE_CALLUSER.EXE (installed) SYS$COMMON:[SYSLIB]WPE.TPU$SECTION (installed) SYS$COMMON:[SYSLIB]EDW.TPU$SECTION (optional file) SYS$COMMON:[SYSEXE]WPEMAIN.EXE (installed) SYS$COMMON:[SYSHLP]WPEHELP.HLB SYS$COMMON:[SYSMGR]WPE_STARTUP.COM SYS$COMMON:[SYSMGR]MORE.COM SYS$COMMON:[SYSMGR]MAILEDIT.COM (optional file, not recommended for normal use) The following definitions are made: $ define/system/exe TPU$SECTION SYS$SHARE:WPE.TPU$SECTION $ define/system/exe TPU$CALLUSER SYS$SHARE:WPE_CALLUSER.EXE Performing the Installation 1. A video terminal with attached printer is recommended for this installation. If you use a hard-copy terminal, you will not be able to build the (optional) EDT-keypad section. 2. From an account with privileges, in the directory containing the WPE distribution, enter the command: $ @INSTALL_WPE 3. You will be prompted for answers to several routine questions. At the end of the procedure, which takes about 10 minutes, you will be given additional instructions. 4. After the installation, you must edit your SYSTARTUP_V5.COM procedure. Any previous references to WPE, TPU$SECTION, TPU$COMMAND, and MAIL$EDIT should be deleted. Add to your startup commands: @SYS$MANAGER:WPE_STARTUP.COM 5. In your previous system login procedure: Delete any definition of WPE and MAIL$EDIT. The file SYLOGIN_FRAGMENT.COM contains the required definition of the symbol MORE (edit the definition if you move MORE.COM). Also included are the recommended definition of the symbol MAIL, and optional definitions for special situations. 6. You must now logout and login for the revised DCLTABLES and SYLOGIN definitions to take effect. Test the installation by typing WPE filename and/or MORE filename(s). 7. If you are on a VAXCluster, on every other node you must (with privileges SYSNAM,CMKRNL) issue the commands: $ INSTALL REPLACE SYS$SHARE:DCLTABLES $ @SYS$COMMON:[SYSMGR]WPE_STARTUP.COM 8. If you have used version 2.x of WPE, you will note that: The default locations for files have changed to "system" directories. WPE_LASTFILE no longer needs to be defined. WPEHELP.HLB is used, rather than modifying TPUHELP.HLB WPE.COM is no longer used. The WPE*DIT command is put in DCLTABLES. The symbol WPE must not be defined. Mail is handled differently. Alternate Installation to use WPE.COM WPE may be installed without modifying DCLTABLES. WPE will then be run by using the WPE.COM file (WPE :== @WPE.COM). You should note that the WPE command will seem "slower" with this method. 1. Examine the list of files in the recommended installation method. Except for the DCLTABLES operation and WPEMAIN.EXE, copy these files to the indicated directories (or your chosen location). 2. Copy WPE.COM to SYS$COMMON:[SYSMGR] or other chosen location. 3. Examine WPE_STARTUP.COM, and edit it if necessary. You will not need WPEMAIN.EXE when running from WPE.COM. Execute this command file. (you need SYSNAM,CMKRNL privileges). 4. Do steps 4 and 5 of the "recommended" procedure. In changing your system login procedure, remember to include the symbol definition for WPE (example given in SYLOGIN_FRAGMENT.COM). 5. Logout, login, and test WPE. 6. On other nodes of a VAXCluster, execute WPE_STARTUP.COM. Options and Other Information Using WPE as a VMS Mail editor How Mail Editing Works in VMS V5.0 The VMS V5.0 Mail system allows the user to select as mail editor any callable editor on the system. The default editor is EDT. The command: Mail> SET EDITOR TPU will use TPU, with the section file defined by TPU$SECTION, as a mail editor. If MAIL$EDIT is defined, the user's mail EDITOR is not used. Instead, a .COM file is used which, in turn, is expected to activate an editor. We recommend that this method not be used. The advantage of using MAILEDIT.COM is that this can be done on a system-wide basis, transparently to users. Disadvantages are: (1) Mail editing occurs in a subprocess, and is therefore much slower to activate. (2) Users have no individual control. Setup for Mail Editing using WPE Why use WPE? In addition to the advantage of having a single editor to remember, WPE has a special two-window mode which is automatically used for mail replies. The original message appears in a small top window, and the reply is created in a larger window. Therefore, the "question" can be viewed while writing the answer. Cut-and-paste can be used to move parts of the original to the answer. To use this feature, the following symbol should be defined: $ MAI*L :== MAIL/EDIT=(SEND,REPLY=EXTRACT) The file SYLOGIN_FRAGMENT.COM contains this definition. Recommended Method Advise users to do (once) MAIL> SET EDITOR TPU. Include the definition of MAI*L in your system login procedure. Do not define MAIL$EDIT. The logical TPU$SECTION controls which editor will be used in VMS Mail. Alternative Method A MAILEDIT.COM file is supplied with WPE. Define MAIL$EDIT as indicated in SYLOGIN_FRAGMENT.COM. Also, include the definition of MAI*L in your system login procedure. Remember, activation of the mail editor will be slower with this method. The EDW Editor WPE provides an optional mode using the EDT keypad definitions. This mode is called the EDW mode. Users can switch between the WPE and EDW keypads. In addition, a section file can be built which starts up in the EDW mode. You may have done this during installation - if not, the BUILD_EDW.COM file builds the section, using options in the WPE.TPU source. Users desiring to use the EDW version as their default editor should place the following line in their LOGIN.COM file: $ DEFINE TPU$SECTION SYS$SHARE:EDW.TPU$SECTION Saving your Editing Position WPE saves your last editing position in the logical TPU_POSITION, and uses it to position your cursor when you re-edit the same file. If you do not like this behavior, remove the line containing "call_user (1, restart_position)" in WPE.TPU, and rebuild the section files. WPE Help Help for WPE is provided by the contents of WPEHELP.HLB, which is normally placed in SYS$COMMON:[SYSHLP]. If you wish to place this file elsewhere, you must also provide a system-wide definition of the logical symbol WPEHELP. Build and Linkage Files Command files are provided to rebuild all parts of WPE. The names of these procedures begin with BUILD_. BUILD_WPE.COM and BUILD_EDW.COM are used to rebuild the section files (BUILD_EDW must be run from a video terminal, and uses WPE_TO_EDW.TPU). BUILD_WPE_HLB.COM is used to rebuild the help library from the WPE.HLP file. Two FORTRAN programs are provided. If you have a compiler, these can be rebuilt using BUILD_CALLUSER.COM (to rebuild WPE_CALLUSER), and BUILD_WPEMAIN.COM (to rebuild WPEMAIN). The build procedures call associated linkage procedures (LINK_CALLUSER.COM and LINK_WPEMAIN.COM), which may be independently used to rebuild from the supplied .OBJ files. The resulting files are placed in the current directory. Options in WPE.TPU The WPE.TPU source file provides several options. If you modify the source, you must rebuild the section files. Options in the source are marked by comments WPE_OPTION OR WPE_KEYOPTION. The major options are described below. Previous versions of WPE, when editing a .HLP file, would ask if WPE should be tailored for this purpose. Version 5.0 of WPE assumes that tailoring is wanted, and does not ask. If you want to keep the former behavior, edit WPE.TPU. In module wpe_init_variables, find the line where the variable wpe$x_prompt_for_hlp_files is set to FALSE, and change this to TRUE. Previous versions of WPE checked for lines longer than 80 characters, and would ask if wide-screen mode was desired. Version 5.0 provides improved methods of changing to wide-screen and shifting your viewpoint; therefore, the question is not asked. If you want to keep the former behavior, edit WPE.TPU. In module wpe_init_variables, find the line where the variable wpe$x_prompt_for_long_lines is set to FALSE, and change this to TRUE. The cursor now remains within the confines of existing lines. This causes the cursor to sometimes jump around when you move up or down in a file. An option is provided for a "free" cursor. Previous versions of WPE defined KP3 as an EXIT key (for compatibility with DM). This version defines KP3 as "Upper Case". A keyoption is provided to preserve the former behavior. This version of WPE maintains the previous definitions of F12 and F13, which are not exactly like WPS-PLUS. A keyoption is provided to define these keys to more closely emulate WPS-PLUS, if desired. The "Del Word" key is defined to stop deleting at a set of special characters, in addition to a space. This facilitates editing of .COM files. A keyoption is provided to remove this special WPE feature. WPE defines Ctrl/L as "Learn", instead of "Insert FF". A keyoption is provided for the alternative definition. Future Versions of VMS and WPE WPE has been totally rewritten for VMS 5.0. Due to improvements in the underlying EVE and TPU for this version of VMS, WPE is now much better integrated with EVE. The new EVE$BUILD procedure was used; therefore, WPE is a "true" application. It is anticipated that WPE will not "break" at any release of VMS V5.x Several improvements are planned, including tracking of some added features of WPS-PLUSTM Version 3.0. Reported problems will be fixed as soon as possible. Short fixes will be posted to the OASIS and DECUServe bulletin boards. Documentation Both a users' guide and an installer's guide are available. The documentation in this directory is available in three forms: .TXT files should be printable on any printer. .WPL files can be imported into WPS-PLUS (TM). .LN03 files print nicely on LN03 printers. The .LN03 files are formatted in 7" x 9" size for small software binders. Emulating WPE as a VAX NOTES editor: The file NOTES$COMMAND.TPU is provided to add many functions of WPE to the WPS editor interface of VAX NOTES. Refer to the NOTES documentation. Comments, Bugs, Suggestions: Dale E. Coy International Business Machines Corporation Office Interconnect Systems 01-04-60 5 West Kirkwood Boulevard Roanoke, TX 76299-0001 (817) 962-3323 Contents of the Distribution Directory Source and Object Files WPE.TPU WPE_MASTER.FILE WPE_OPTIONS.TPU WPE_VERSION.DAT WPEDIT.CLD WPEHELP.HLP WPEMAIN.FOR, .OBJ WPE_COMMON.DAT WPE_CALLUSER.FOR, .OBJ NOTES$COMMAND.TPU Documentation Files AAAREADME.DOC WPEV5_DIFF.TXT WPE_USER_DOC.LN03, .TXT, .WPL WPE_INSTALLER_DOC.LN03, .TXT, .WPL AA_VERSIONS.POINTER SYLOGIN_FRAGMENT.COM;1 EDT_USER_LOGIN.COM;1 Build, Link, and Installation Files INSTALL_WPE.COM;22 BUILD_CALLUSER.COM;2 BUILD_EDW.COM;4 BUILD_WPE.COM;6 BUILD_WPEMAIN.COM;2 BUILD_WPE_HLB.COM;1 LINK_CALLUSER.COM;3 LINK_WPEMAIN.COM;2 WPE_TO_EDW.TPU;2 Other Required Files MORE.COM WPE_STARTUP.COM Executable and Section Files WPEMAIN.EXE WPE_CALLUSER.EXE WPE.TPU$SECTION WPEHELP.HLB EDW.TPU$SECTION Supplied files (not recommended for normal use) MAILEDIT.COM WPE.COM