This chapter explains how to install DECdocument. Section 2.1 contains a step-by-step description of the installation procedure.

2.1 The VMSINSTAL Installation Procedure

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.

Log in to a privileged account.

Log in to a privileged account and set your default device and directory to SYS$UPDATE.

Username: SYSTEM Password: $ SET DEFAULT SYS$UPDATE

Invoke VMSINSTAL.

@SYS$UPDATE:VMSINSTAL DOC032 ddcu: 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:

DOC032

The installation name for the component (DECdocument 3.2).

ddcu:

The name of the device on which you plan to mount the media. For example, MTA0: is the device name for 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 once the installation is complete.

If you are installing from a CD-ROM, this is the name of the CD drive and you would use this command:

$ @SYS$UPDATE:VMSINSTAL DOC032 cd-drive-name:[DECDOC032.KIT] OPTIONS N

OPTIONS N

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. You should review the release notes before proceeding with the installation in case they contain additional information about the installation. If you are restarting the installation and have already reviewed the release notes, you do not need to specify OPTIONS N.

Note that there are several other options you can select when you invoke VMSINSTAL:

• 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).
• Get save set option (G): Lets you store product save sets temporarily on a magnetic tape or in a disk directory.
• File log option (L): Logs all activity to the terminal during installation.
• Alternate root option (R): Lets you install the product to a system root other than that of the running system.

See the VMS documentation on software installation in the VMS System Management Subkit for detailed information on these options. If you specify more than one option, separate the options with commas (OPTIONS A,N).

The following example invokes VMSINSTAL to install DECdocument from device MUA0: on an Alpha system and shows the system response. This example uses the OPTIONS N release note parameter.

$ @SYS$UPDATE:VMSINSTAL DOC032 MUA0: OPTIONS N OpenVMS AXP Software Product Installation Procedure V6.2 It is 11-APR-1997 at 09:32. Enter a question mark (?) at any time for help.

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.

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] to accept the YES default. Otherwise, enter NO to discontinue the installation. After you back up your system disk, you can restart the installation.

Beginning the install.

The following products will be processed: DOC V3.2 Beginning installation of DOC V3.2 at 09.32 %VMSINSTAL-I-RESTORE, Restoring product saveset A...

You should now mount the distribution media on the device you specified when you invoked VMSINSTAL if you have not already done so. The device name appears in the line preceding the "mount" question if the media has not been mounted and, VMSINSTAL will ask 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 DECdocument 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.

Mount additional media volumes.

If your installation kit contains more than one volume, VMSINSTAL prompts you to mount the additional volumes and then asks you to indicate that you are ready for the installation to proceed.

Select a release notes option.

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.

Next, VMSINSTAL displays the following question:

* Do you want to continue the installation [N]?: YES %VMSINSTAL-I-RELMOVED, Product's release notes have been 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:DOC032.RELEASE_NOTES

After the installation, you can enter the following command to review the release notes through the Help facility:

$ HELP DOCUMENT RELEASE_NOTES

Respond to license registration queries.

Installation of DECdocument V3.2 Copyright 1995-1997 Touch Technologies, Inc. beginning at 11-APR-1997 09:32:57.87. In order to run DECdocument, you must have its product authorization key registered and loaded. Product: DOCUMENT Producer: DEC or TTI Version: 3.2 Release Date: dd-mmm-yyyy * Does this product have an authorization key registered and loaded?

The installation procedure displays license information about your product and then asks if you have registered and loaded your Product Authorization Key (PAK).

If you have not registered and loaded your PAK, you must answer NO to this question. You have to register and load your PAK to successfully complete the installation. If you have not done so, you should stop the installation, register and load your PAK, and then restart the installation.

Choose the Installation Verification Procedure (IVP) option.

* Do you want to run the IVP after the installation [YES]?

The installation procedure now asks if you want to run the IVP. The IVP for DECdocument checks to be sure that the installation is successful.

It is recommended that you run the IVP; however if you run the IVP and your open file quota for the current process is not 30 or greater, you see the following message and prompt:

The open file quota for your process is less than 30. The installation of DECdocument can proceed, but the Installation Verification Procedure cannot be run unless the open file quota is increased to 30. You may want to stop installation, run the AUTHORIZE utility to increase your open file quota, log out and log in, then restart the installation. If you elect to proceed with the installation without increasing the open file quota, the IVP will be bypassed. * Do you want to proceed with the installation [NO]?

Enter NO to terminate the installation so that you can increase the open file quota for your process (refer to Section 1.4.3 for additional information). If you type YES, the installation continues but the IVP is not run.

After DECdocument is installed, you can run the IVP independently to verify that the software is available on your system. You might need to run the IVP after a system failure to make sure that users can access DECdocument.

Purge files.

* Do you want to purge files replaced by this installation [YES]?

You have the option to purge files from previous versions of DECdocument 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.

Select a device and directory.

You must specify a storage area for DECdocument files. The following message is displayed:

You will now be asked for the device and directory where you want the DECdocument files to be stored. The files will be stored in a directory tree called [DOC$TOOLS...] on the device and directory you specify. A system-wide logical name called DOC$ROOT will be created to refer to this directory tree.

If this is a reinstallation of DECdocument, the logical name DOC$ROOT is already defined. If DOC$ROOT is already defined, you are asked whether you want to restore the [DOC$TOOLS...] tree to that device and directory:

The logical name DOC$ROOT is already defined. It refers to the directory ddcu:[dir]. * Do you want to install the new files at that same location [YES]?

You should install DECdocument onto the same device and directory. If you do not, the existing [DOC$TOOLS...] tree will not be accessible through the logical name DOC$ROOT.

If the logical name DOC$ROOT is not currently defined, you receive the following prompt:

* Enter the device and directory where [DOC$TOOLS...] should be created [SYS$SYSDEVICE:[000000]]:

Enter the name of the device and directory on which you want the [DOC$TOOLS...] tree installed, or press Return to install on the system disk.

Select LSE support.

If the Language-Sensitive Editor (LSE) is not installed on your system, you do not receive a prompt for the installation of SDML with LSE. Instead, you receive an informational message stating that LSE is not installed:

Support for the use of SDML with LSE cannot be installed because version 3.2 or higher of the Language-Sensitive Editor is not installed on this system. If you want the Language-Sensitive Editor support, you must do the following: 1. Install the Language-Sensitive Editor version 3.2 or greater 2. Set default to the SYS$LIBRARY directory 3. Link the SDML.ENV file using the following command: $ lsedit/nodisp/nosyst/envi=(SDML)/nosect/command=(doc$lseupdate_env.tpu) These steps can be taken any time after this installation is completed. There is no need to stop the current installation.

If your system has LSE installed, the procedure instead supplies a prompt for the support of SDML with LSE option. You can choose to install this option or continue the installation with the prompt for the next option.

DECdocument provides support for the preparation of documents that use the Standard Digital Markup Language (SDML) with the Language- Sensitive Editor (LSE). * Do you want support for SDML use with LSE [YES]?

Select an IVP destination.

If you indicated that you want the IVP executed after installation, you are asked to specify the command-line destination parameter that corresponds to the device to which you want to send the output of the DOCUMENT command execution (for example, PS, LN03 or LINE). You are also asked if you want the output to be queued automatically to that device.

The IVP will execute a DOCUMENT command. You must supply the destination parameter for this DOCUMENT command and then indicate whether you want the output queued automatically.

If you do not have LN03 fonts installed on your system, you will receive the following notice:

+-------------------------------------------------------------------+ ! **** NOTICE **** ! ! ! ! The IVP for this installation of DECdocument should not be ! ! run against an LN03 destination until the LN03 fonts are ! ! installed. Do not select an LN03 destination for this IVP. ! +-------------------------------------------------------------------+ * Enter the IVP destination parameter (BOOKREADER, PS, LINE, MAIL, TERMINAL): PS * Do you want the IVP output queued automatically [YES]? * Enter the printer queue name: queue_name

If you have not set up the printing device, reply NO to this prompt.

The DECdocument files will now be installed. Your OpenVMS system will be updated to include the new or modified files:

SYS$HELP:DOC032.RELEASE_NOTES

Select the Graphics Editor Option.

At this point, you have the option of installing the Graphics Editor. The Graphics Editor is available for Motif. DECdocument will determine if DECWindows is installed on the system. If so, DECdocument will then determine which version of DECWindows is installed.

• If DECWindows Motif is installed, you will see the following display:

  VMS DECwindows/Motif is installed on this system. DECdocument Graphics Editor Installation Options: 1. Install DECdocument Graphics Editor V3.2-Motif 2. Do not install Graphics Editor * Select option [1]:

  
  If you select option 1, the Graphics Editor V3.2-Motif is installed. You will be asked the following questions:

  Installation of the Graphics Editor will require between 3600 and 15600 free blocks on the target medium, depending on selected options. A library of drawings is available to you. * Do you want to install the library of drawings (12000 blocks) [NO]? * Where should the library of drawings be installed [SYS$COMMON:[SYSHLP.EXAMPLES.DOC_GRAPHICS]]:

  
  If you choose to have the library of drawings installed, the following is displayed:

  The DECdocument Graphics Editor drawings files will be installed in SYS$COMMON:[SYSHLP.EXAMPLES.DOC_GRAPHICS]

  
  The installation continues, and the following is displayed:

  There are two additional pieces of documentation available to you. One is a Bookreader version of the Graphics Editor User's Guide (MOTIF_GRA.DECW$BOOK). The other is a Quick Reference card in PostScript format (GRA_QUICKREF.PS). These files will be put in the SYS$HELP directory if selected. * Do you want the User's Guide in Bookreader form (2000 blocks) [NO]? * Do you want the Quick Reference card (270 blocks) [NO]?

  
  Delete obsolete files.
  If you want to delete the obsolete files from previous DECdocument installations, select Yes by pressing Return at the next question:

  * Do you want to delete obsolete files from previous installations [YES]?

• If DECWindows is not installed on the system, the DECdocument Graphics Editor will not be installed; no questions are asked.

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.

After responding to the last prompt, you see the following message:

The DECdocument files will now be installed. Your VMS system will be updated to include the new or modified files: SYS$HELP:DOC032.RELEASE_NOTES SYS$HELP:HELPLIB.HLB SYS$SHARE:DCLTABLES.EXE SYS$STARTUP:DOC$STARTUP.COM Upon completion of this installation, please be sure to do the following: . Edit the system startup file (SYS$STARTUP:SYSTARTUP_VMS.COM) so that it will execute the command @SYS$STARTUP:DOC$STARTUP.COM. This insures that DOCUMENT will be available after the next system boot. . If you are on a cluster, you should execute the following commands: $ RUN SYS$SYSTEM:SYSMAN SYSMAN> SET ENVIRONMENT/CLUSTER SYSMAN> DO @SYS$STARTUP:DOC$STARTUP.COM SYSMAN> DO INSTALL REPLACE SYS$SHARE:DCLTABLES.EXE SYSMAN> EXIT This will make DECdocument available to all properly licensed nodes of the cluster prior to the next system boot.

Note: For VAX V5.*, the system startup file is SYS$STARTUP:SYSTARTUP_V5.COM. For VAX V6.* the system startup file is SYS$STARTUP:SYSTARTUP_VMS.COM.

Refer to Section 3.3 for more information.

The installation procedure displays the following message:

End of prompts. Now beginning restoration of savesets. No further questions will be asked. Installation should be complete in 25-35 minutes.

Additional messages are displayed as VMSINSTAL restores backup savesets and creates directories; for example:

%VMSINSTAL-I-RESTORE, Restoring product saveset B ... . . %VMSINSTAL-I-RESTORE, Restoring product saveset C ... . . %VMSINSTAL-I-RESTORE, Restoring product saveset D ... . . . . %VMSINSTAL-I-RESTORE, Restoring product save set H ... %VMSINSTAL-I-RESTORE, Restoring product save set I ... Installation of DECdocument V3.2 completed successfully at 11-APR-1997 09:41:40.21. %VMSINSTAL-I-MOVEFILES, Files will now be moved to their target directories... Starting DECdocument V3.2

Observe the IVP.

If you chose to run the IVP, VMSINSTAL runs it now. When the IVP runs successfully, you see the following display:

%DOC-I-IVPSTART, DECdocument V3.2 Installation Verification Procedure %DOC-I-IVPRUN, Running DECdocument ... %DOC-I-IDENT, DECdocument V3.2 (c) 1995-1997 Touch Technologies, Inc. . . . %DVC-I-PAGESOUT, 13 pages written to file: DOC$ROOT:[TEMPLATES]DOC$SAMPLE.PS %DOC-I-IVPSUCCESS, DECdocument V3.2 IVP was successful.

With the successful completion of the IVP, your installation of DECdocument is finished and completion messages are displayed.

If the execution of DECdocument fails, you will see the following messages:

%DOC-I-IVP_FAILURE, DECdocument V3.2 IVP failed. %VMSINSTAL-E-IVPFAIL, The IVP for DOC V3.2 has failed.

See Section 3.7 if you receive this message.

End the installation procedure.

The following installation completion messages are displayed:

Installation of DECdocument V3.2 terminating at 11-APR-1997 09:47:20.40. Installation of DOC V3.2 completed at 09:47 Adding history entry in VMI$ROOT:[SYSUPD]VMSINSTAL.HISTORY Creating installation data file: VMI$ROOT:[SYSUPD]DOC032.VMI_DATA VMSINSTAL procedure done at 09:47

You can now log out of the privileged account:

$ LOGOUT SYSTEM logged out at 11-APR-97 09:48:06.13