3    Supplementary Documentation

To help meet specific needs when working with the DIGITAL UNIX operating system, DIGITAL makes available documentation that supplements the DIGITAL UNIX documentation set. Some of these documents are produced by DIGITAL and others are produced by other organizations and provided by DIGITAL.

The Documentation CD-ROM, Operating System CD-ROM, Associated Products CD-ROMs volumes 1 and 2 all contain supplementary documentation. Much of this documentation pertains to individual components.

For example, the Associated Products Volume 1 CD-ROM contains installation guides for the Multimedia Services for DIGITAL UNIX run-time environment, DECevent, and the DIGITAL Porting Assistant. Other component-specific information includes release notes, Software Product Descriptions (SPD), and user information.

This Documentation Overview does not list all of the supplementary documentation on the CD-ROMs, but it does provide some guidance in the following sections.

3.1    Documentation CD-ROM

You can access the HTML documentation described in this section by clicking on the bookshelf called Supplementary Documentation on the Documentation CD-ROM. The files for these books are located in the /DOCS/HTML directory.

If your system is configured to recognize PostScript files and open them in a PostScript viewer, you can click on them in the bookshelf called PostScript versions of additional books under the Supplementary Documentation bookshelf. The individual PostScript files are located on the DOCS/PSCR directory.

The following sections describe the supplementary documentation on the Documentation CD-ROM. Included with each description of a PostScript document is the name of the file that contains the document. For example, the book DECwindows Extensions to Motif is contained in the file called AQ8YSATE.PS.

3.1.1    CD-ROM Contents Listing

This is an online version of the document called DIGITAL UNIX Version 4.0D CD-ROMs, which is included in the DIGITAL UNIX media kit. It provides brief listings of the components on the CD-ROMs in the media kit.

3.1.2    Documentation Overview

The revised version of the Documentation Overview (the book you are reading) is available in PostScript format. The file is named DOC_OVER.PS.

3.1.3    DIGITAL UNIX Year 2000 Readiness

The DIGITAL UNIX Year 2000 Readiness document contains information about the DIGITAL UNIX Year 2000 program to help you prepare your system for the turn of the century. It also includes other important Year 2000 information on previous DIGITAL UNIX versions and layered products, and describes testing methodologies and guidelines.

Included in this document are links to related Web sites.

3.1.4    Java Documentation

Beginning with the Version 4.0D release, the DIGITAL UNIX operating system includes a Java Development Kit (JDK), which provides tools to develop and run Java applets and programs on the DIGITAL UNIX operating system.

Access to the Java documentation depends upon whether the Java Development Kit is installed on your system and how your system administrator has set up your system. Clicking on Java Overview on the Supplementary Documentation bookshelf takes you to a page that provides information about viewing the Java documentation. This page also provides a Web link to the JavaSoft JDK documentation at the Sun Microsystems Java site.

3.1.5    DECwindows Documentation

The books in this section are designed to aid programmers who are creating or modifying applications that use the DECwindows graphical user interface. These books are in PostScript format. The names of the individual files are listed after the titles.

• DECwindows Companion to the OSF/Motif Style Guide (AQ8YSATE.PS)

  This manual provides supplemental information to the OSF/Motif Style Guide. It contains more detailed explanations and illustrations for application developers to help them create consistent user interfaces for their applications.

• DECwindows Motif Guide to Application Programming (AQ8YTATE.PS)

  This manual describes the DECwindows Motif Toolkit and how to use it to design a DECwindows application interface. In particular, it describes the programming interface for widgets that DIGITAL provides in the Toolkit.

• DECwindows Extensions to Motif (AQ8YUATE.PS)

  This manual describes the programming extensions that DIGITAL provides to supplement the X Window System, Version 11, Release 5, and OSF/Motif Toolkit components included in systems based on the UNIX environment.

  This manual supplements the OSF/Motif Programmer's Guide and the X Window System documentation described in Section 3.1.6.

3.1.6    Documentation for the X Window System

The documentation described in this section pertains to X Windows System, Version 11, Release 6. These documents, provided by the X Consortium, are in PostScript format. The names of the individual files are listed after the titles. (The indexes for these documents are provided in separate files. The index files have the same names as the books, with the characters "_IX" appended to them; for example, the index for the X Window System Protocol is PROTO_IX.PS.)

• X Window System Protocol (PROTO.PS)

  This document describes the X Window System protocol.

• Inter-Client Communication Conventions Manual (ICCCM.PS)

  This document proposes suitable conventions for interclient communications with X Version 11 software. The proposed conventions do not attempt to enforce any particular user interface.

• X Toolkit Intrinsics -- C Language Interface (INTRINSC.PS)

  Intrinsics are a programming library tailored to the specical requirements of user-interface construction within a network window system -- specifically the X Window System. The Intrinsics and a widget set make up the X Toolkit. This document describes the X Toolkit Intrinsics.

• X Logical Font Description Conventions (XLFD.PS)

  This document provides a standard logical font description and the conventions to be used in the core protocol so that clients can query and access screen type libraries in a consistent manner across all X servers.

• Xlib -- C Language X Interface (XLIB.PS)

  This document provides reference information for the low-level C language interface to the X Window System protocol. It provides a detailed description of each function in the library, as well as a discussion of the related background information.

3.1.7    Name Server Operations Guide for BIND

Distributed by the Internet Software Consortium, this PostScript document (BINDOPGD.PS) describes the Berkeley Internet Name Domain (BIND) Release 4.9.3 and its implementation as an Internet name server for BSD-derived operating systems.

3.2    Operating System CD-ROM

The documentation described in this section is included on the DIGITAL UNIX Operating System CD-ROM. Some of this documentation is available only when you install the software it describes.

3.2.1    Software Product Descriptions

A Software Product Description (SPD) is the legal description of the DIGITAL UNIX product. It describes the software and gives information about its capabilities and about the hardware it supports. This information is for anyone who needs a legal description of the DIGITAL UNIX product. The SPD is provided on the operating system distribution media in both PostScript and text versions.

PostScript versions of the SPDs are located in the mnt_point/DOCUMENTATION/POSTSCRIPT directory. They files are named as follows:

Digital_UNIX_C_Developers_Extensions_SPD.ps
Digital_UNIX_Server_Extensions_SPD.ps
Digital_UNIX_Operating System_SPD.ps
Prestoserve_for_Digital_UNIX_SPD.ps
Digital_UNIX_Logical_Storage_Manager_SPD.ps

Text versions of the SPDs are located in the mnt_point/DOCUMENTATION/TEXT directory. The files are names as follows:

Digital_UNIX_C_Developers_Extensions_SPD.txt
Digital_UNIX_Server_Extensions_SPD.txt
Digital_UNIX_Operating System_SPD.txt
Prestoserve_for_Digital_UNIX_SPD.txt
Digital_UNIX_Logical_Storage_Manager_SPD.txt

3.2.2    Listings of Fixes Made to the Operating System

DIGITAL maintains lists of fixes it makes to each version of the DIGITAL UNIX operating system. Known as CLDs (for Customer Log Desk), these text files are located in the the mnt_point/DOCUMENTATION/TEXT directory. The files are named as follows:

Digital_UNIX_V3_2C_CLD_Fixes.txt
Digital_UNIX_V3_2D_CLD_Fixes.txt
Digital_UNIX_V3_2G_CLD_Fixes.txt
Digital_UNIX_V4_0_CLD_Fixes.txt
Digital_UNIX_V4_0A_CLD_Fixes.txt
Digital_UNIX_V4_0B_CLD_Fixes.txt
DIGITAL_UNIX_V4_0D_CLD_Fixes.txt

3.2.3    Alternate Formats for Release Notes and Installation Guide

The Release Notes for Version 4.0D and theInstallation Guide are provided in PostScript format in the mnt_point/DOCUMENTATION/POSTSCRIPT directory. The files are named as follows:

DIGITL_UNIX_V4_0D_Release_Notes.ps
Digital_UNIX_V4_0B_Install_Gde.ps

The Release Notes for Version 4.0D are also provided in text format in the mnt_point/DOCUMENTATION/TEXT directory. The file is named as follows:

DIGITL_UNIX_V4_0D_Release_Notes.txt

3.2.4    New and Changed Features in Prior Releases

DIGITAL maintains lists of changes it makes to each release of the DIGITAL UNIX operating system and of the new features it adds to each relase. These text files are located in the the mnt_point/DOCUMENTATION/TEXT directory. The files are named as follows:

DIGITAL_UNIX_V4.0A_Features.txt
DIGITAL_UNIX_V4.0B_Features.txt
DIGITAL_UNIX_V4.0C_Features.txt
DIGITAL_UNIX_V4.0_Features.txt
 

3.2.5    X Image Extension Documentation

The X Image Extension (XIE) code (developed by the X Consortium) provides a powerful mechanism for the transfer and display of virtually any image on X-capable hardware. Documentation for XIE is installed in compressed format in the /usr/doc/xie_v5 directory:

Before you can print a copy of one of the XIE manuals, you must uncompress that manual. For example, to uncompress the X Image Extension Overview, as root issue the following command:

% uncompress /usr/doc/xie/xie_overview.ps.Z

You can then print the resulting, uncompressed file: /usr/doc/xie_v5/xie_overview.ps.

The following list describes the XIE manuals. The names of the individual files are listed after the titles.

• X Image Extension Overview (xie_overview.ps.Z)

  This manual provides general information about the X Image Extension (XIE) code. Topics covered include XIE design goals, XIE historical summary, XIE architecture, element definitions, and subsetting.

• XIElib Specification (xie_lib_spec.ps.Z)

  This manual contains reference information about the XIElib functions, XIElib events, and XIElib errors. The Functions section covers such functions as startup, LUT, photomap, ROI, photoflo, client data, abort and await, photoflo element, technique, and free.

• XIE Sample Implementation Architecture (xie_sample_arch.ps.Z)

  This manual provides an architecture overview of XIE, including chapters on extension initialization, memory management, request dispatching, data representation, data structures, protocol requests, DIXIE photoflo management, DDXIE photoflo management, and photo elements.

• X Image Extension Protocol Reference Manual, Version 5.0 (xie_protocol_ref.ps.Z)

  This manual specifies the X wire protocol for XIE. It defines the syntax, structure, and semantics of the XIE protocol elements. Topics covered include syntax specification, parameter types, resources, pipelined processing, import elements, process elements, export elements, events and errors, techniques, service class, and protocol encodings.

3.2.6    Emacs Documentation

The Free Software Foundation provides two documents to help users of Emacs and Emacs Lisp software. These files are available only if the FSFEMACSSRC300 subset is installed on your system. (To use Emacs and Emacs Lisp, install the OSFEMACS300 subset.)

These documents are located in the /usr/lib/emacs/doc directory. The names of the individual files are listed after the titles.

• GNU Emacs Manual (emacs.ps)

  This manual provides information about how to use and customize the Emacs text editor. It is primarily a reference manual, but can also be used as a tutorial. This manual is intended for general users and anyone who uses Emacs.

• GNU Emacs Lisp Reference Manual (elisp.ps)

  This manual describes Emacs Lisp and presumes considerable familiarity with how to use the Emacs text editor. The earlier chapters describe Emacs features that have counterparts in other programming languages. The later chapters describe features that are peculiar to Emacs Lisp or relate specifically to editing. This manual is for programmers.

3.2.7    Display PostScript Documentation

The Display PostScript system is described in the PostScript Language Reference Manual, which is included in the DIGITAL UNIX documentation set. To update the Display PostScript documentation, Adobe System, Inc., provides some supplemental documentation. These supplements are provided in compressed format in the /usr/share/doclib/dps directory. Before you can print a supplement, you must uncompress it. For example, to uncompress the Level 2 Changes for X, from root issue the following command:

% uncompress /usr/share/doclib/dps/Developer-TechNote.1-001.ps.Z
 

You can then print the resulting, uncompressed file.

The following list describes the Display PostScript documentation supplements. The names of the individual files are listed after the titles.

• Level 2 Changes for X (Developer-TechNote.1-001.ps.Z)

  This supplement describes the changes made to the X implementations of the Display PostScript system for PostScript Level 2.

• Type 2 Image Dictionary (Developer-TechNote.1-002.ps.Z)

  This supplement describes the Type 2 image dictionary, an operand for the image operator in the Display PostScript system. The Type 2 image dictionary is an extension to the Type 1 dictionary. It allows the image operator to use pixel data from a pixmap, the current window, or another window as source when copying into the current window.

• Multiple Master Fonts in the DPS Toolkit Font Panel (Developer-TechNote.1-003.ps)

  This supplement describes new support for multiple master fonts in the Display PostScript Toolkit for X font panel. The supplement also describes how the font panel supports nontypographic sorting and a value-changed callback.

• Writing Applications That Use the Resource Location Library (Developer-TechNote.1-004.ps)

  This supplement describes how applications can use resource paths to become easier to use and customize. Resource paths are included in calls to the resource location library, which applications can use to find resources such as fonts.

3.3    Associated Products CD-ROMs

The Associated Products CD-ROMs contain documentation for various components of DIGITAL UNIX. The document called DIGITAL UNIX Version 4.0D CD-ROMs, described in Section 3.1.1, provides a list of the applications located on these CDs, as do the 00README.TXT files located on the CDs.

Both CDs now include a graphical user interface that you can use to access documentation and to install product software from within the Netscape browser. To use this interface, invoke Netscape and go to the following location:

file:/<mount_point>/index.html

A list of products on the CD-ROM will be displayed. When you click on a product name you will be given the option to install the product or access the documentation, if applicable.

To view Bookreader or PostScript files while using Netscape, your system will need to be configured so that it will recognize the file type of the file you select and will invoke Bookreader or a PostScript viewer.