Appendix E: Installation Summary

This Appendix contains explicit instructions on how to install the ce software from:

• media
• the Internet
• a backup directory containing Ce installation tar files

Installing Ce From Media

Your Ce license may allow the use of the software on several different platforms. For each licensed platform, the media contains one tar file that contains the entire Ce package for that platform. Each tar file on the media ranges in size from 2 to 4 MegaBytes.

Instructions

1. The "ce_backup" directory.
   Select a "backup" directory into which the entire media contents can be restored. Ideally, it will be a directory on a host which can be reached by other hosts on which the software is to be installed. We'll call that directory "ce_backup".
2. Log on to a system with which you can restore the Ce tar files from media. You may have to be logged in as root.
3. Set your directory to "ce_backup".
4. If the media is on tape, place the media in the drive and execute these commands:
   
   UNIX: mt -f <device> rewind
   UNIX: % tar xvf <device>
5. If the delivery media is a floppy disk it is in pc format. Put it in a suitable machine and copy the file to the "ce_backup" directory. The file name on the diskette is ce.tz. Name the file ce.tar.Z in the "ce_backup" directory. The file will be in a compressed format. Uncompress the file in the "ce_backup" directory using the command:
   
   Command: % uncompress *.tar.Z (can use compress -d)
6. Now proceed to the Installing Ce from a Backup Directory Section of this Appendix.

You should only have to perform the above steps once. Once the files have been restored to "ce_backup", they can be used for all subsequent installs onto any hosts that can reach "ce_backup" in some way (ftp, rcp, NFS, ...).

Installing Ce from Data Downloaded from the Internet

The file downloaded from the internet is a compressed tar file. A separate compressed tar file is available for each machine type. Only the binary files (in the bin directory) are different between machine types.

Instructions

1. The "ce_backup" directory.
   Determine the location of the "ce_backup" directory. This is a directory into which the ce tar files have been retrieved from the Internet. The machine type of the machine being installed on should match the machine type of Ce. That is: Install HP/UX binaries on HP/UX machines. The tar file will be referred to as "ce_tar_file".
2. Log on to a system with which you can read and write the ce tar files.
3. Set your directory to "ce_backups".
4. Execute the command:
   
   Command: %compress -d ce_backup/ce_tar_file.Z
5. Now proceed to the Installing Ce from a Backup Directory Section of this Appendix.

Installing Ce from a Backup (TAR) Directory

These steps should be repeated once for each host on which you are installing the software. Note that you can often install on one node and propagate files and links to other nodes using network management software. You can also install into directories which are visible to many nodes via NFS, DFS, or AFS. The total installation time is five minutes.

Instructions

1. The "ce_backup" directory.
   Determine the location of the "ce_backup" directory. This is a directory into which the ce tar file which was restored from media or the Internet will be extracted from tar format.
2. Execute the command "tar xvf ce_tar_file". This will create the directory Ce in the current directory.
   
   NOTE: If you are running on a Domain/OS system, you must do the following step from
   a SYS5 shell.
3. Select and create, if necessary, the directory where you will want the Ce binary files to be stored (e.g. /usr/ce/bin). The binary files are "ce", "xdmc", "ce_init", "ce_report", "ce_update", and "ce_isceterm". Soft links ceterm, cv, and ce_merge are also created in this directory. These files occupy about 2.5 megabytes of disk storage.
4. Select and create the directory where you will want the Ce help files to be stored (e.g. /usr/ce/help). The help files occupy about 2 megabytes of disk storage.
5. Select the directory where you will want the "Ce app-defaults" file to go. This should be somewhere the users "XFILESEARCHPATH" will pick it up. This is a small file.
6. Select the directories where you will want the manual pages to be placed. This should be somewhere the users "MANPATH" will pick it up. These are small files. The manual pages ce.1, xdmc.1, and ce_isceterm.1. Soft links ceterm.1 and cv.1 are also created.
7. From the "ce_backup" directory, execute the command "ce/bin/ce_install". "ce_install" is a script that performs the installation. It will prompt you for the names of the directories you set up in previous steps and them move the files to their appropriate locations. In addition, if the software is shipped with the network license software the license server (lserv) may be started as part of the install script. See the section "File List" and "Installation Considerations" for information on the directories. Note that if ce already exists in the target directory, it is renamed to ce.r"version" where "version" is the version number of that release.
8. On systems other than SunOS 4.1.* and Apollo domain OS, the ceterm program must be setuid'ed to root. This is required to open a pseudo-terminal and update the utmp information. The setuid in Ce is dropped as soon as these functions are completed or determined to not be needed. It is possible to install Ce without being root using the -noroot parameter to ce-install. Running the installation with "ce/ce_install -noroot" will install the files assuming you have write permission to the target locations. If you use this technique, you may need to get someone with root authority to setuid the executable before you run ceterm.
9. The HTML documentation can be downloaded from the Internet or was provided on installation media. at the anonymous FTP site, the HTML documentation is in a file named cehtml25.tar.Z. On PC format floppy diskette, it is named cehtml.tz Copy the file to a location accessible from your web server and name the file cehtml25.tar.Z Then uncompress the file with the UNIX command:
   
   compress -d cehtm.25.tar.Z
   
   At this point, you have a UNIX tar format file. When expanded by the tar command, this file will produce a directory in the current working directory named ce. Change directories to where you want the HTML documentation to be placed and execute the UNIX command:
   
   tar xvf cehtml25.tar
   
   From some suitable web page on your site, create a link to the web directory "/ce/ce.html" to attach the ce documentation to your intranet. Note that the HTML files in the documentation are self contained and need no customization.

User Installation

These steps should be repeated for each user of the Ce software and are contained within the "new_messages" file for mailing to new Ce users.

Instructions

1. If the software includes the network licensing software then the environment variable "LSHOST" should be set in the user's ".profile" or ".login". "LSHOST" must be set to the host name of the License Server (lserv). For example, the .profile might include:
   
   LSHOST = host1; export LSHOST
   Where "host1" is replaced by the name of the node where the license server is currently running. Before continuing with the user installation the user should ensure that "LSHOST" is set by logging out/in again or manually setting it.
   
   An alternative which does not require modifying the users environment, is to set the "Ce.LSHOST" X resource in the "/usr/lib/X11/app-defaults/Ce" file created by the install process.
2. The user should enter "ce_init" which will create the following files in the "$HOME" user's home directory:
   
   $HOME/.Cekeys (key definitions)
   $HOME/ce_practice (practice file)
   
   In additions, the user will be placed within Ce, editing the file "ce_practice".

File List

The Ce installation consists of a set of files that are accessed by all Ce users and a set of files for each individual user.

Ce consists of the directories and files listed in Table E-1. File and directory names in boldface refer to objects that all users can access. File and directory names in italics refer to files only accessible by the system administrator. "site_installation_path" is the main directory that contains the Ce software and its location is selected by the system administrator at the time of installation.

Table E-1. Ce Directories and Files

NOTES:

1. Moved to the binary directory specified in the install script. These files are used a lot and should be copied local to each node.

2. Moved to the license server directory specified in the install script. These files only exist on some machines.

3. Moved to the help directory specified in the install script or the manual page directory specified in the install script. Used when the user requests help.

Installation Considerations

This section describes location dependencies between Ce files.

The actual ce/ceterm/cv executable has no location dependent information and can reside anywhere. As it tends to be heavily used, having it installed locally on a node can be an advantage. Some platforms page the text portion of executables from the actual executable file and paging across the network is slower than local paging. Also, a network hit will bring Ce down with no chance for Ce to do any data preservation.

The "ce_init" shell script has references to the help directory and also to the Ce executable. If the help directory is moved or the Ce executable is moved, this file will have to be edited. The "ce_report" shell also references the help directory. This shell script will have to be modified if the help directory is moved.

The help directory is a good candidate for an NFS mount point to a centralized location. The help files are useful are useful but are not used as much as they should be.

As of release 2.5 the data directory is no longer used.

The key definitions are installed by default using Aegis expressions. If the site default is to be Unix, the system administrator should specify this in the installation. The users can override this when they run ce_init.