KAP_for_VAX_C_______________________________________ Installation Guide April 1993 This document contains instructions for installing KAP for VAX C on OpenVMS. Revision/Update Information: This is a new document. Operating System and Version: OpenVMS Version 5.1 to 5.5 Software Version: KAP for VAX C Version 1.1 Digital Equipment Corporation Maynard, Massachusetts The information in this document is subject to change without notice and should not be construed as a commitment by Digital Equipment Corporation. Digital Equipment Corporation assumes no responsibility for any errors that may appear in this document. Possession, use, duplication, or dissemination of the software described in this documentation is authorized only pursuant to a valid written license from Digital or the third-party owner of the software copyright. No responsibility is assumed for the use or reliability of software on equipment that is not supplied by Digital Equipment Corporation. Restricted Rights: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013. © Digital 1993. © Kuck & Associates, Inc. 1993. KAP is a trademark of Kuck & Associates, Inc. All rights reserved. The following are trademarks of Digital Equipment Corporation: Bookreader, DEC, DECnet, VAX C, VAX, OpenVMS, and the DIGITAL logo. All other trademarks and registered trademarks are the property of their respective holders. This document is available on CD-ROM. This document was prepared using VAX DOCUMENT, Version 2.0. _________________________________________________________________ Contents Preface................................................... vii 1 Preparing for KCC Installation 1.1 Required Operating System Components............. 1-1 1.2 License Registration............................. 1-2 1.3 Installation Procedure Requirements.............. 1-2 1.4 Privileges and Disk Space........................ 1-3 1.5 VMSINSTAL Requirements........................... 1-3 1.6 VMSINSTAL Quotas Requirements.................... 1-3 1.7 Backing Up Your System Disk...................... 1-4 2 The KAP for VAX C Installation Procedure 2.1 KAP for VAX C Standalone......................... 2-6 3 Running the Installation Verification Procedure (IVP) 3.1 Reporting Problems............................... 3-1 A Files Installed on Your System B Sample Installation iii Tables A-1 KAP Files Installed ........................... A-1 iv _________________________________________________________________ Preface This guide describes how to install KAP for VAX C V1.1 on OpenVMS systems running OpenVMS Version 5.1 to 5.5, inclusive. The KAP for VAX C product name will also be referred to as KAP or KCC throughout this document. Intended Audience The audience for this guide is the system manager who wants to install KCC on OpenVMS system currently running Versions 5.1 to 5.5, including any dashed release versions such as V5.4-2. Structure of This Manual This guide is organized as follows: o Chapter 1 describes the operating system and hardware requirements for the KAP installation and related procedures that you complete before beginning the installation. o Chapter 2 provides step-by-step installation instructions. o Chapters 3 describes actions to take and considerations to make after the installation. o Appendix A lists the files installed during this installation. o Appendix B contains a sample KAP installation log file. vii Associated Documents In addition to this manual, the following documents are in the documentation set: o KAP for VAX C User Guide o KAP for VAX C Quick Reference The following documents may also prove helpful: o Introduction to OpenVMS System Management o Guide to Setting Up a OpenVMS System o OpenVMS SYSMAN Utility Manual For information on how to install software, see the OpenVMS Upgrade and Installation Manual for your version of OpenVMS. Also, see the release notes and the Software Product Descriptions (SPDs) for any software products you install. viii 1 _________________________________________________________________ Preparing for KCC Installation This chapter discusses the preparations and requirements necessary for installing KCC. Your bill of materials (BOM) and indented bills report (BIL) specify the number and contents of your media. Be sure to verify the contents of your kit with this information. If your kit is damaged or if you find that parts of it are missing, contact your Digital representative. Release notes are provided both online and in hardcopy format. Digital strongly recommends that you read the release notes before proceeding with the installation. For information on accessing the online release notes, see Chapter 3. 1.1 Required Operating System Components The OpenVMS operating system comes with a variety of support options, or classes. Classes include such features as networking and VAX RMS journaling. None of these support options or classes are required for installation of the KCC. To install KCC Version 1.1, your system must be running OpenVMS Version 5.1 to 5.5 or any dash release of one of these versions (for example 5.3-1). The System Support Addendum (SSA) contains a complete list of prerequisite software and required version numbers. Preparing for KCC Installation 1-1 Preparing for KCC Installation 1.2 License Registration 1.2 License Registration Before you install and run KAP on a newly-licensed node, you must first register a License Product Authorization Key (License PAK) using the License Management Facility (LMF). The License PAK may be shipped along with the kit if you ordered the license and media together; otherwise, it is shipped separately to a location based on your license order. You must register and load your KAP license before you start the installation procedure. Register your License PAK in one of the following ways: o Invoke the SYS$UPDATE:VMSLICENSE.COM procedure. When the procedure prompts you for information, respond with data from your license PAK. o At the DCL prompt, enter the LICENSE REGISTER command with the qualifiers that correspond to your License PAK information As you respond to the LMF procedure prompts, note that PRODUCER=KUCK. Load the PAK using the LICENSE LOAD command. If previous versions of the PAK have been loaded on the system remove the current license from system memory using the following command: $ LICENSE UNLOAD lmf-name Then load the new license using the following command: $ LICENSE LOAD lmf-name where lmf-name is KAP-C. 1.3 Installation Procedure Requirements This section and those that follow discuss various requirements for installing KCC. The installation takes 5 to 10 minutes, depending on your system configuration. Installing KCC and running the Installation Verification Procedure (IVP) on a standalone DEC 3100 system takes approximately 5 minutes. 1-2 Preparing for KCC Installation Preparing for KCC Installation 1.4 Privileges and Disk Space 1.4 Privileges and Disk Space o To install KCC, you must be logged in to an account that has SETPRV or at least the following privileges: - CMKRNL - WORLD - SYSPRV o Note that VMSINSTAL turns off the BYPASS privilege at the start of the installation. o The KCC installation requires 5500 blocks of disk space. o To determine the number of free disk blocks on the current system disk, enter the following command at the DCL prompt: $ SHOW DEVICE SYS$SYSDEVICE 1.5 VMSINSTAL Requirements When you invoke VMSINSTAL, it checks the following: o Whether you are logged in to a privileged account o Whether you have adequate quotas for installation o Whether DECnet is running o Whether any users are logged in to the system 1.6 VMSINSTAL Quotas Requirements VMSINSTAL requires that the installation account have a minimum of the following quotas: o ASTLM = 24 o BIOLM = 18 o BYTLM = 18,000 o DIOLM = 18 o ENQLM = 30 o FILLM = 20 Preparing for KCC Installation 1-3 Preparing for KCC Installation 1.6 VMSINSTAL Quotas Requirements If VMSINSTAL detects any problems during the installation, it notifies you and asks if you want to continue the installation. In some instances, you can enter YES to continue. To stop the installation process and correct the situation, enter NO or press Return. Then correct the problem and restart the installation. 1.7 Backing Up Your System Disk At the beginning of the installation, VMSINSTAL asks if you have backed up your system disk. Digital recommends that you do a system disk backup before installing any software. Use the backup procedures that are established at your site. For details on performing a system disk backup, see the section on the Backup Utility in the OpenVMS System Management Subkit. 1-4 Preparing for KCC Installation 2 _________________________________________________________________ The KAP for VAX C Installation Procedure This chapter explains how to install KAP. The following sections provide a step-by-step description of the installation procedure and describe what to do if you encounter an error during installation. The KAP installation procedure consists of a series of questions and informational messages. To abort the installation procedure at any time, press CTRL/Y. When you press CTRL/Y, the installation procedure deletes all files it has created up to that point and exits. You can then start the installation again. 1. Invoke VMSINSTAL. @SYS$UPDATE:VMSINSTAL saveset-name device-name OPTIONS N To start the installation, invoke the VMSINSTAL command procedure from a privileged account, such as the SYSTEM account. VMSINSTAL is in the SYS$UPDATE directory. The following list defines the elements of the VMSINSTAL command procedure: o saveset-name is the installation name for the component. For KCC, use the following installation name: KCC o device-name is the name of the device on which you plan to mount the media. For example, MTA0: is the device name a tape drive. It is not necessary to use the console drive for this installation. However, if you do use the console drive, you should replace any media you removed onve the installation is complete. The KAP for VAX C Installation Procedure 2-1 The KAP for VAX C Installation Procedure o OPTIONS N is an optional parameter that indicates you want to see the question on release notes. If you do not include the OPTIONS N parameter, VMSINSTAL does not ask you about the release notes. If you are restarting the installation and have already reviewed the release notes, you do not need to specify OPTIONS N. 2. Note that there are several other options you can select when you invoke VMSINSTAL: o Auto_answer option (A): Initially creates a file that contains your answers to VMSINSTAL questions and prompts. You can then use the option (and the answer file) to save time during a reinstallation (typically after upgrading your system). o Get save set option (G): Lets you store product save sets temporarily on a magnetic tape or in a disk directory. o File log option (L): Logs all activity to the terminal during installation. o Alternate root option (R): Lets you install the product to a system root other than that of the running system. See the OpenVMS documentation on software installation in the OpenVMS System Management Subkit for detailed information on these options. If you specify more than one option, separate the options with commas (OPTIONS A,N). 3. The following example invokes VMSINSTAL to install KCC from tape drive MTA0: and shows the system response. This example uses the OPTIONS N release note parameter. $ @SYS$UPDATE:VMSINSTAL KCC MTA0: OPTIONS N VAX/OpenVMS Software Product Installation Procedure V1.1 It is 20-MAR-1993 at 06:12. Enter a question mark (?) at any timefor help. 2-2 The KAP for VAX C Installation Procedure The KAP for VAX C Installation Procedure If you do not supply either the product name or the device name, VMSINSTAL prompts you for this information later in the installation procedure. VMSINSTAL does not prompt you for any options, so be sure to include OPTIONS N on the VMSINSTAL command line to access the release notes during the installation. 4. Confirm system backup. * Are you satisfied with the backup of your system disk [YES]? VMSINSTAL asks if you are satisfied with your system backup. You should always back up your system disk before performing an installation. If you are satisfied with the backup of your system disk, press RETURN. Otherwise, enter NO to discontinue the installation. After you back up your system disk, you can restart the installation. 5. Mount the media. Please mount the first volume of the set on MTA0:. * Are you ready? YES The following products will be processed: KCC V1.1 Beginning installation of KCC V1.1 at 06:13 %VMSINSTAL-I-RESTORE, Restoring product saveset A... You should now mount the distribution volume on the device you specified when you invoked VMSINSTAL. The device name appears in the line preceding the question. VMSINSTAL then asks you if you are ready to continue with the installation. If you respond YES to indicate that you are ready, VMSINSTAL displays a message that the media containing the KCC saveset has been mounted on the specified device and that the installation has begun. If you entered the wrong device name when you invoked VMSINSTAL and need to restart the installation, enter NO in response to the "Are you ready?" question. To abort the installation for other reasons, press CTRL/Y. 6. Select a release notes option. The KAP for VAX C Installation Procedure 2-3 The KAP for VAX C Installation Procedure Release notes included with this kit are always copied to SYS$HELP. Additional Release Notes Options: 1 Display release notes 2 Print release notes 3 Both 1 and 2 4 None of the above * Select option [2]: If you specified OPTIONS N when you invoked VMSINSTAL, you are now asked to choose one of the four options for reviewing the release notes. If you select option 1, VMSINSTAL displays the release notes immediately on the console terminal. You can terminate the display at any time by pressing CTRL/C. If you select option 2, VMSINSTAL prompts you for the name of the print queue that you want to use: * Queue name [SYS$PRINT]: You can press RETURN to send the file to the default output print device or you can enter another queue name. If you select option 3, VMSINSTAL displays the release notes immediately on the console terminal and then prompts you for a queue name for the printed version. Select option 4 if you have already reviewed the release notes and are restarting the installation. 7. Next, VMSINSTAL displays the following question: * Do you want to continue the installation [N]?: YES %VMSINSTAL-I-RELMOVED, The product's release notes have been successfully moved to SYS$HELP. To continue the installation, enter YES. Otherwise, press RETURN. In either case, the release notes are copied to a file in the SYS$HELP directory: SYS$HELP:KCC011.RELEASE_NOTES 2-4 The KAP for VAX C Installation Procedure The KAP for VAX C Installation Procedure After the installation, you can enter the following command to read the release notes: $ TYPE SYS$HELP:KCC011.RELEASE_NOTES 8. License confirmation. * Does this product have an authorization key ready and loaded? If the license PAK has been registered and loaded, answer YES. If you answer NO, the IVP phase of the installation will be cancelled. 9. Purge files. * Do you want to purge files replaced by this installation [YES]? You have the option to purge files from previous versions of the KCC that are superseded by this installation. Purging is recommended; however, if you need to keep files from the previous version, enter NO in response to the question. 10.Read informational messages. At this point, the installation procedure displays a number of informational messages that report on the progress of the installation. There are no further questions. If the installation procedure has been successful up to this point, VMSINSTAL moves the new or modified files to their target directories, updates help files, and updates DCL tables, if necessary. If you chose to have files purged, that work is done now. 11.End the installation procedure. Installation of KCC V1.1 completed at 6:15 This is followed by history and data file informational messages. ________________________ Note ________________________ The KCC$STARTUP.COM file must be executed to define the KCC foreign command @SYS$STARTUP:KCC$STARTUP. This startup must be executed each time a user logs on to the system. ______________________________________________________ The KAP for VAX C Installation Procedure 2-5 The KAP for VAX C Installation Procedure 12.Error Recovery If an error occurs during installation, VMSINSTAL displays an error message. If the installation fails, you see the following message: %VMSINSTAL-E-INSFAIL, The installation of KCC V1.1 has failed. Errors can occur during the installation if any of the following conditions exist: o The operating system version is incorrect. o A prerequisite software version is incorrect. o Quotas necessary for successful installation are insufficient. o System parameter values for successful installation are insufficient. For descriptions of the error messages generated by these conditions, see the OpenVMS documentation on system messages, recovery procedures, and OpenVMS software installation. If you are notified that any of these conditions exist, you should take the appropriate action as described in the message. For information on installation requirements, see Chapter 2. 2.1 KAP for VAX C Standalone Installation of KCC and execution of SYS$STARTUP:KCC$STARTUP will create two foreign commands: KCC and KAPC. KAPC is the command for standalone KAP for VAX C optimizer. To use this command, see the KAP for VAX C User Guide. 2-6 The KAP for VAX C Installation Procedure 3 _________________________________________________________________ Running the Installation Verification Procedure (IVP) This chapter describes how to run the Installation Verification Procedure (IVP). VMSINSTAL will execute the Installation Verification Procedure (IVP) as part of a successful installation. To run the IVP standalone, issue the following commands: $ @SYS$STARTUP:KCC$STARTUP $ @SYS$TEST:KCC$IVP If the IVP succeeds, you see these messages: KCC Compilation Test Passed KCC Object Execution Test Passed ***** Installation Verification Procedure SUCCESSFUL ****** If the IVP fails, you see this message: ***** KCC Installation Verification Procedure FAILED ****** If the IVP fails, issue the DCL command SET VERIFY and then run the IVP again. The messages displayed while the IVP runs will indicate the cause of the failure. You will then be able to take corrective action. 3.1 Reporting Problems If you encounter a problem while using KAP, report it to Digital. Depending on the nature of the problem and type of support you have, you can take one of the following actions: o Call Digital if your software contract or warranty agreement entitles you to telephone support. o Submit a Software Performance Report (SPR). Running the Installation Verification Procedure (IVP) 3-1 A _________________________________________________________________ Files Installed on Your System The KCC installation procedure installs a number of files on your system. Table A-1 lists these files and specifies whether the file was modified, replaced, or new. Table_A-1_KAP_Files_Installed______________________________ File_Name_________________________________Status___________ SYS$HELP:KCC011.RELEASE_NOTES New SYS$STARTUP:KCC$STARTUP.COM New/Replaced SYS$SYSTEM:KCC.EXE New/Replaced SYS$SYSTEM:KAPC.EXE New/Replaced SYS$TEST:KCC$IVP.COM New/Replaced SYS$TEST:[KCC]KCCIVPIN.FOR New/Replaced SYS$TEST:[KCC]KCCIVPIN.KMP New/Replaced SYS$TEST:[KCC]KCCIVPIN.VER________________New/Replaced_____ Files Installed on Your System A-1 B _________________________________________________________________ Sample Installation This appendix contains a log of a complete installation of the KAP for VAX C kit. It may be different than your log since you may have selected other options. $@SYS$UPDATE:VMSINSTAL Kcc DISK$KAP:[KAP.KITS.VV] OPTIONS N VAX/OpenVMS Software Product Installation Procedure V5.5 It is 23-MAR-1993 at 13:02. Enter a question mark (?) at any time for help. %VMSINSTAL-W-NOTSYSTEM, You are not logged in to the SYSTEM account. %VMSINSTAL-W-ACTIVE, The following processes are still active: CSOVAX _RTA10: _RTA17: JORY5 TASAR BURTON _RTA16: BATCH_681 HODGE DOWLING KAMATH SERVER_0003 SERVER_0002 * Do you want to continue anyway [NO]? yes * Are you satisfied with the backup of your system disk [YES]? The following products will be processed: KCC V1.1 Sample Installation B-1 Sample Installation Beginning installation of KCC V1.1 at 13:44 %VMSINSTAL-I-RESTORE, Restoring product save set A ... Release notes included with this kit are always copied to SYS$HELP. Additional Release Notes Options: 1. Display release notes 2. Print release notes 3. Both 1 and 2 4. None of the above * Select option [2]: 4 * Do you want to continue the installation [NO]? yes %VMSINSTAL-I-RELMOVED, Product's release notes have been moved to SYS$HELP. %KCC-I-COPYR, -KCC-I-COPYR, ) Kuck and Associates, Inc. 1993. All Rights Reserved. -KCC-I-COPYR, Product: KAP-C Producer: KUCK Version: 1.1 Release Date: 11-MAR-1993 * Does this product have an authorization key registered and loaded? yes * Do you want to purge files replaced by this installation [YES]? %VMSINSTAL-I-RESTORE, Restoring product save set B ... IMPORTANT NOTE: The KCC$STARTUP.COM file must be executed to define the KCC foreign command @SYS$STARTUP:KCC$STARTUP This startup must be executed each time a user logs on to the system. %VMSINSTAL-I-MOVEFILES, Files will now be moved to their target directories... Execution of SYS$TEST:KCC$IVP has not been invoked. After installation is complete this IVP may be run with the commands: @SYS$STARTUP:KCC$STARTUP @SYS$TEST:KCC$IVP Installation of KCC V1.1 completed at 13:45 B-2 Sample Installation Sample Installation VMSINSTAL procedure done at 13:45 $ $@SYS$STARTUP:KCC$STARTUP $@SYS$TEST:KCC$IVP %DCL-I-SUPERSEDE, previous value of KCC$TEST has been superseded *-------------------------------------------* * Installation Verification Procedure * * for KCC 1.1 k141107 930308 * *-------------------------------------------* KCC Compilaton Test Passed KCC Object Execution Test Passed ****** Installation Verification Procedure SUCCESSFUL ****** $ Sample Installation B-3