Copyright © 1993, 1994 by Brian Schenkenberger and TMESIS Consulting All rights reserved. ------------------------- This software is provided "as is" and is supplied for informational purpose only. No warranty is expressed or implied and no liability can be accepted for any actions or circumstances incurred from the use of this software or from the information contained herein. The author makes no claim as to the suitability or fitness of this software or information contain herein for a particular purpose. ------------------------- This software may be copied and distributed only with the inclusion of this copyright notice. ------------------------------------------------------------------------- * * * I N S T A L L A T I O N O F S Y M B O L * * * --------------------------------------------------------- Building SYMBOL (v3%4.091): -------------------------- SYMBOL is distributed in source form and therefore, the executables must be built prior to installation. To build SYMBOL, execute the command procedure BUILD_SYMBOL.COM. This procedure requires SYSPRV to place the loadable executive image, SYMBOL$AST_LEI.EXE, into the common root of SYS$LOADABLE_IMAGES. This procedure will create all of the necessary object (*.OBJ) files, executables (*.EXE), listing (*.LIS) files, linker maps (*.MAP), and help source file SYMBOL.HLP and help library file SYMBOL.HLB. Optionally, the .LISting and .MAP files may be disabled by passing qualifiers to the BUILD_SYMBOL.COM procedure. The first parameter should specify a blank or valid optional MACRO qualifiers. To disable the generation of .LISting files, specify "/NOLIST" for the first parameter. The second parameter is used to specify any valid optional LINKing qualifiers. To disable the generation of the .MAP files, specify "/NOMAP" for the second parameter. For example: $ @BUILD_SYMBOL "/NOLIST" "/NOMAP" To generate just a MAP file: $ @BUILD_SYMBOL "/NOLIST" "/MAP" The logical BUILD_VERIFY may be defined to the value of 1 to turn on command verification of the build procedure. SYMBOL File Placement: --------------------- SYMBOL.EXE and SYMLOADER.EXE should be placed in SYS$COMMON:[SYSEXE]. However, this is not an absolute requirement. If you choose, SYMBOL may be located anywhere on your system provided that the following logical definition is made. $ DEFINE/SYSTEM/EXECUTIVE SYMBOL $DEV$???:[]SYMBOL.EXE This line should be placed in SYLOGICAL.COM or your system startup prior to installing SYMBOL. The Loadable Executive Image, SYMBOL$AST_LEI.EXE, is automatically placed in the common root of the directory SYS$LOADABLE_IMAGES. ******************************************************************* The system logical, SYMBOL, will be defined automatically using the INSTALL_SYMBOL.COM procedure. See 'Using INSTALL_SYMBOL.COM' below. ******************************************************************* SYMBOL Known File Requirements: ------------------------------ SYMBOL must be installed as a privileged known image. This command line: $ INSTALL ADD/OPEN/HEADER_RESIDENT/SHARED/PRIVILEGED=CMKRNL SYMBOL should be placed in your system startup and must be activated after the logical (if SYMBOL.EXE was not placed into SYS$COMMON:[SYSEXE]) SYMBOL has been defined. ******************************************************************* SYMBOL will be automatically installed using the INSTALL_SYMBOL.COM procedure. See 'Using INSTALL_SYMBOL.COM' below. ******************************************************************* Loading SYMBOL$AST_LEI: ---------------------- The Loadable Executive Image, SYMBOL$AST_LEI.EXE, can be dynamically loaded using the support executable, SYMLOADER.EXE. ******************************************************************** SYMBOL$AST_LEI.EXE is dynamically loaded with the INSTALL_SYMBOL.COM procedure. See 'Using INSTALL_SYMBOL.COM' below. ******************************************************************** Optionally: The Loadable Executive Image, SYMBOL$AST_LEI.EXE, can be loaded during bootstrapping by performing the following: $ MCR SYSMAN SYS_LOADABLE ADD SYMBOL SYMBOL$AST_LEI/LOAD_STEP=SYSINIT - /SEVERITY=WARNING/MESSAGE="SYMBOL$AST_LEI.EXE load failure." $ @SYS$UPDATE:VMS$SYSTEM_IMAGES.COM This will cause the Loadable Executive Image, SYMBOL$AST_LEI.EXE, to be loaded at the next reboot and subsequent boots. If you elect to load SYMBOL$AST_LEI.EXE during bootstrapping, it can not be unloaded using SYMUNLOAD.EXE. Using INSTALL_SYMBOL.COM: ------------------------ The steps outlined above can be performed using the supplied install procedure: INSTALL_SYMBOL.COM. Invoke this procedure during system startup. If the executables, SYMBOL.EXE and SYMLOADER.EXE, are _not_ located in SYS$COMMON:[SYSEXE], pass the directory specification to the INSTALL_SYMBOL.COM procedure. For example, the following is placed in SYSTARTUP_V5.COM (For V6.n: SYSTARTUP_VMS.COM) to install SYMBOL. In this example, SYMBOL.EXE and SYMLOADER.EXE have been placed into another directory called: SYS$SYSDEVICE:[PUBLIC_DOMAIN.SYMBOL]. $ @SYS$STARTUP:INSTALL_SYMBOL SYS$SYSDEVICE:[PUBLIC_DOMAIN.SYMBOL] SYMBOL Command Definition: ------------------------- The SYMBOL command may be provided using one of the following two command options: *** COMMAND OPTION #1: --------------------- To make the command available, define the foreign command SYMBOL using the following syntax: $ SYMBOL :== $SYMBOL This should be placed in SYLOGIN.COM to make it available for all users. Optionally, the program SYMBOLPERM.EXE can be executed to establish the above definition as a permanent symbol definition. Permanent symbols, such as $STATUS and $SEVERITY, can not be deleted using a DELETE/SYMBOL command or the SYMBOL utility. This will insure that SYMBOL is always defined for a user. This program requires CMEXEC privilege. It is installed with CMEXEC privilege by the INSTALL_SYMBOL.COM procedure. The following line should be placed in the SYLOGIN.COM file to make SYMBOL available as a permanent symbol for all users: $ RUN $DEV$???:[]SYMBOLPERM.EXE *** COMMAND OPTION #2: --------------------- The SYMBOL command may be added directly to the system DCL command table, DCLTABLES.EXE. Use the following: $ SET COMMAND/TABLE=SYS$COMMON:[SYSLIB]DCLTABLES.EXE SYMBOL.CLD Then, replace the current installed version of DCLTABLES.EXE using the following: $ INSTALL REPLACE SYS$COMMON:[SYSLIB]DCLTABLES.EXE NOTE: This procedure may need to be repeated after OpenVMS upgrades. SYMBOL Help Documentation: ------------------------- SYMBOL help functions can be provided using one of the following: The SYMBOL help information can be added directly to the existing VMS help library. The SYMBOL.HLP source file is created by the BUILD.COM procedure. This file can be used to update the default VMS help library using the following command: $ LIBRARY/HELP/INSERT SYS$HELP:HELPLIB.HLB SYMBOL.HLP - or - SYMBOL help information can be provided by defining an optional default library logical (HLP$LIBRARY_xxx) which should translate to SYMBOL.HLB. $ DEFINE/SYSTEM/EXECUTIVE HLP$LIBRARY_x $DEV$???:[]SYMBOL.HLB ----- .END.