This chapter provides brief descriptions of the core documentation. It is divided into sections that follow the structure of the printed documentation kits. All of the books in this chapter are available as printed books and, except where indicated, are also provided in various online formats. See Section 1.4 for information about the online Documentation Library structure.
Except for a few externally published manuals, the documentation described
here was produced by Compaq writers working closely with the developers of
the Tru64 UNIX operating system.
2.1 End User Documentation
Manuals for the end user contain the information you need to install
and configure a Tru64 UNIX system, bring it up on a network, and use it.
The documentation in this category is grouped in three primary areas: startup
documentation, general user documentation, and system and network management
documentation.
2.1.1 Startup Documentation
The startup documentation is packaged in printed form with your Tru64 UNIX
media.
It consists of the documents you need to install, configure, and begin
using your system.
Documentation Overview
This is the book you are reading.
Installation Guide
This manual describes the procedures for performing an update installation
or a basic installation of the Tru64 UNIX product on all supported processors.
Installation Guide -- Advanced Topics
This manual describes the procedures for performing an advanced installation
of the Tru64 UNIX product on all supported processors.
It also discusses
system administration procedures in a standalone environment.
Full Installation Quick Start
(available only in printed form)
This foldout card provides easy access to the information needed to
install a Tru64 UNIX system.
Update Installation Quick Reference Card
(available
only in printed form)
This foldout card provides easy access to the information needed to
upgrade a Tru64 UNIX system to the next version.
Update installations
preserve disk partitions, file systems, and file customizations.
Quick Reference Card
(available only in printed form)
This foldout card provides fingertip access to the format of common
user commands, such as
cd
,
chmod
,
lpr
, and
man
.
The card also describes options
that are commonly used with each command.
Additionally, this card provides command summaries for the
vi
,
emacs
,
Mail
, and
mail
applications, and it summarizes the rules for forming regular
expressions.
It provides a description of command control symbols (such as
|, the pipe symbol) and gives definitions of shell environment variables
and metacharacters.
Release Notes
for Version 5.0A
The Release Notes are for all users of the Tru64 UNIX operating system. This book includes the following information:
An overview of the new and changed features of the Version 5.0A software
Announcements about features and interfaces that are scheduled for removal in future versions of Tru64 UNIX
Information about installing the software
Information that is relevant to specific Compaq Alpha processors
Information about the base operating system
Information about the development environment
Information about the graphical interfaces
Additions and corrections to the books in the Tru64 UNIX documentation set
Information about the contents of the media and disk-space requirements
Information about changes to time zone directories and files
Compaq recommends that you read this information before installing or using the Tru64 UNIX operating system.
Note
Compaq maintains an online Technical Update that contains information about restrictions and problems that have been discovered since Version 5.0A began shipping. To view this document on the Web, go to the following URL:
http://www.unix.digital.com/faqs/publications/updates/V50A/TITLE.HTM Compaq recommends that you visit this site periodically to see if any new information has been added.
This manual describes the major components of the Tru64 UNIX operating system. The opening chapter provides an introduction to the operating system, including discussions of recent enhancements, licensing, and available optional software. This is followed by more in-depth discussions on various aspects of the operating system. A partial list of the topics follows:
The various features available to system administrators
The available networking protocols and applications
The supported file systems
The Tru64 UNIX kernel, symmetric multiprocessing, virtual memory, and device recognition
Major features of the Tru64 UNIX development environment
Tru64 UNIX interoperability with Windows NT and Windows 2000
Tru64 UNIX security
Issues concerning internationalization
Because this book might introduce new terms to you, it now contains
the
Glossary of Common UNIX and General Computer Terms,
which was previously part of this
Documentation Overview.
When using the online version of the
Technical Overview, some of the terms
used within the discussions are linked to the Glossary; you are a mouse click
away from the term's definition.
TruCluser Server
Technical Overview
This manual describes the major components of the TruCluster Server product. The opening chapter introduces the features of a TruCluster Server cluster and compares them to those provided in earlier products in the TruCluster Software family. Subsequent chapters provide a more in-depth discussion of certain features, including:
Clusterwide file systems, storage, and device names
The connection manager
Highly available applications
The cluster application availability (CAA) component
The cluster alias subsystem
The cluster interconnect
The distributed lock manager (DLM)
Tru64 UNIX Version 5.0A CD-ROMs
This one-page document provides a brief listing of the components on the CD-ROMs in the media kit. An online version of this document is included in the General User Documents category of the Tru64 UNIX Documentation CD-ROM.
The information on this card is covered in detail in Chapter 2 of the
Installation Guide.
2.1.2 General User Documentation
General user documentation contains important information for all users
of the Tru64 UNIX operating system.
The books in this category provide
introductory information for people who are unfamiliar with Tru64 UNIX.
CDE Companion
This manual provides an introduction to Compaq's implementation of the Common Desktop Environment (CDE), an easy method of interacting with the Tru64 UNIX operating system.
For users migrating from DECwindows Motif to CDE, this book serves as an introduction to the new environment, providing information on how to use CDE to complete tasks previously done by using DECwindows.
For users who are new to desktop environments, this book provides quick-start information on topics such as logging into the system, navigating the system, and using and managing the desktop and applications.
This book can be used in conjunction with the
Common Desktop Environment: User's Guide.
Command and Shell User's Guide
This manual introduces the basic features of the Tru64 UNIX operating system. It describes how to use the command line interface and to perform such tasks as copying files and creating directories. It also describes how to use the shells and their built-in commands.
Although this manual is primarily for users who have little or no familiarity
with UNIX-compatible systems, experienced users can find useful shortcuts
and tips.
Master Index
This book can help you find the information you need in the core documentation set, as follows:
In the printed version of this book, the index items advise you in which books to look and direct you to the pages where the topic is discussed. The printed version of the Master Index was not revised for this release, although the online version was revised.
In the online version of this book, clicking on an index item in many cases will take you to the appropriate book at the point where the topic is discussed. For the Common Desktop Environment books and various other books, clicking on the index item will take you only to the beginning of the appropriate book, where you can use the table of contents or the book's index to find out where the topic is discussed.
This manual provides information needed by users and system administrators who are working on Tru64 UNIX systems that have the optional enhanced security subsets installed. It also provides information needed by developers who are writing programs that will run on secure systems. The enhanced security features help protect systems and data from access by unauthorized users.
This manual also provides information about security on systems that do not have the enhanced security subsets installed.
The information is organized as follows:
Part 1 describes how to use the Tru64 UNIX operating system with enhanced security from the command line.
Part 2 describes how to administer the operating system's enhanced security, which includes enhanced passwords and the audit subsystem. The Security Integration Architecture (SIA) is also discussed. This part of the manual assumes prior knowledge and experience administering secure systems.
Part 3 describes how to write programs that run on the Tru64 UNIX operating system with enhanced security. This part assumes general programming knowledge, including knowing how to use the Tru64 UNIX programming tools.
2.1.3 System and Network Management Documentation
System and network management documentation provides information on
topics such as configuring systems and networks, maintaining disks, and using
system administration tools.
AdvFS Administration
AdvFS is the default file system for the Tru64 UNIX operating system. It provides rapid crash recovery and a flexible structure that allows you to manage your file system while it is on line.
The AdvFS Utilities, which are available as a layered product, extend the file system capabilities by including utilities to add volumes, create clones, stripe files, and balance file domains.
This manual provides task-based information and instruction on using,
configuring, troubleshooting, tuning, and administering AdvFS base and utilities
functions.
Guide to Prestoserve
Prestoserve speeds up synchronous disk writes, including Network File System (NFS) server access, by reducing the amount of disk I/O.
This manual describes how to manage and maintain a Tru64 UNIX
system that includes the optional Prestoserve hardware and software.
Kernel Debugging
The manual describes using the
dbx
,
kdbx
, and
kdebug
debuggers to find problems in kernel
code.
It also describes how to write a
kdbx
utility extension
and how to create and analyze a crash dump file.
This manual is for system administrators responsible for modifying,
rebuilding, and debugging the kernel configuration.
It is also for system
programmers who need to debug their kernel-space programs.
Logical Storage Manager
The Logical Storage Manager (LSM) software provides high data availability, better performance, and greater storage management flexibility through online support for disk storage devices on Alpha systems.
This manual explains LSM concepts and how to install and administer
the LSM software.
Network Administration
This manual provides information on establishing a Tru64 UNIX system on a network and configuring network software such as NFS and DNS. It also explains how to manage a network and network applications and how to solve problems that might arise.
This manual is for experienced system and network administrators who
have knowledge of TCP/IP networking concepts and network configuration.
Readers
should also have knowledge of operating system concepts, commands, and configuration.
Sharing Software on a Local Area Network
This manual describes Remote Installation Services (RIS) and Dataless
Management Services (DMS).
The RIS utility is used for installing software
across a network, instead of using locally mounted media.
DMS allows a server
system to maintain the root,
/usr
, and
/var
file systems for client systems.
Each client computer has its
own root file system on the server, but clients share the
/usr
and
/var
file systems.
Software License Management
This manual describes how to use the License Management Facility (LMF) to manage software licenses from Compaq.
Although intended primarily for system administrators responsible for
managing software licenses on Tru64 UNIX systems, this manual also provides
information for anyone who uses licensed software on Tru64 UNIX systems.
System Administration
This manual describes how to configure, use, and maintain the Tru64 UNIX operating system. It includes information on general day-to-day activities and tasks, changing system configurations, and locating and eliminating sources of trouble.
System administrators are provided with overviews of administrative concepts, as well as step-by-step instructions to perform necessary tasks using the either the SysMan graphical interface or the command-line tools.
This manual is for system administrators responsible for managing the
operating system.
It assumes a knowledge of operating system concepts, commands,
and configurations.
System Configuration and Tuning
This manual describes how to set up and tune high-performance and high-availability systems running the Tru64 UNIX operating system. It can help system administrators to accomplish many system tasks, including the following:
Determine the needs of the environment
Configure and tune a system that will meet current and future needs
Understand how hardware, operating system subsystems, and layered applications interact to affect system performance
Learn recommended ways to improve performance
System Configuration Supplement: OEM Platforms
This manual provides information needed to set up OEM platforms running the Tru64 UNIX operating system. It helps system and network administrators configure Alpha VME single-board computers (SBCs), PCI/ISA modular SBCs, and VMEbus backplane networks in which SBCs operate as Ethernet nodes.
This manual is for experienced system and network administrators who
are thoroughly familiar with their platform's I/O bus and with the operating
system concepts, commands, and configurations.
X Window System Administrator's Guide
(available only in printed form)
This manual, published by O'Reilly & Associates, describes how to
customize a wide range of X Window System environments, from an individual
workstation to groups of workstations and X terminals connected on a network.
Major topics include security, the X display manager (xdm
),
fonts, color, X terminals, and X client applications.
X Window System Environment
This manual describes various aspects of the X Window System environment
as it is implemented on Tru64 UNIX.
It provides information on how to
perform system administration tasks for the Tru64 UNIX X Window System
environment, and describes how to customize X Window System resources and
key mappings.
It also provides information about programming within the Tru64 UNIX
X Window System environment.
2.2 Documentation for Program Developers
The programming documentation consists of manuals designed for software
developers who write software applications on or for the Tru64 UNIX operating
system.
Assembly Language Programmer's Guide
This manual describes the Alpha hardware architecture's assembly language, which is supported by the Tru64 UNIX compiler system. The manual describes the assembly language syntax rules, and how to write assembly language programs.
This manual is for system software developers who are writing assembly
language programs on or for Tru64 UNIX.
Asynchronous Transfer Mode
This manual describes the Tru64 UNIX Asynchronous Transfer Mode (ATM) subsystem, how to configure the subsystem, and how to use the ATM kernel interfaces. It is written for experienced UNIX kernel programmers who are responsible for writing ATM device drivers and kernel modules. After reading this manual, a kernel programmer should be able to do the following:
Understand the ATM subsystem architecture
Configure ATM software
Understand how the different kernel interfaces operate
Write a kernel module
This manual does not describe the application programming interface
(API) that user-level applications would use to access the ATM subsystem.
This manual is not an ATM networking tutorial.
Calling Standard for Alpha Systems
This manual defines the requirements, mechanisms, and conventions used in the interface that supports procedure calls on Tru64 UNIX for Alpha systems. The standard defines data structures, constants, algorithms, conventions, methods, and functional interfaces, which enable a native, user-mode procedure to operate correctly in the multilanguage and multithreaded Tru64 UNIX environment on Alpha hardware.
Although this manual primarily defines requirements for compiler and
debugger writers, the information applies to procedure calling for all programmers
at all levels of programming.
Compaq C Language Reference Manual
This manual (previously called the DEC C Language Reference Manual) provides reference information for using the Compaq C language on Compaq systems. Compaq C is an ISO/ANSI-compliant C compiler for Tru64 UNIX and OpenVMS VAX and Alpha systems.
This manual is based on the ISO C Standard (ISO 9899:1990[1992]), formerly the ANSI X3J11 committee's standard for the C programming language (commonly called ANSI C). All library functions and language extensions to the ANSI C standard are also described.
This manual is intended for programmers who need reference information
on the Compaq C language.
For task-oriented information or platform-specific
information, see the
cc
(1)
reference page and the
Programmer's Guide.
Compaq Portable Mathematics Library
This manual provides reference and exception information for the Compaq Portable Mathematics Library (CPML) software. This manual documents the CPML routines and, in particular, how they behave when given an exception input argument. It also documents operating system entry points and supported floating-point data types.
This manual is for compiler writers and system and application programmers
who do not have high-level language support of CPML routines in their language
of choice, but instead need to access CPML routines directly from application
programs.
Guide to the POSIX Threads Library
This manual (formerly called Guide to DECthreads) provides usage and reference information on POSIX Threads Library routines. It provides information on the three POSIX Threads Library interfaces used to perform multithreaded operations: cma, pthread, and pthread exception-returning.
This manual is for programmers writing multithreaded applications.
It assumes experience with a high-level programming language (such as C),
with UNIX operating systems, and with UNIX software development tools.
Guide to Preparing Product Kits
This manual describes the procedures for creating, maintaining, and installing the collections of files and directories that make up a layered product kit. A kit is the standard mechanism by which layered product modifications are delivered and maintained on a Tru64 UNIX system. Kits are distributed on CD-ROM, diskettes, or tape for installation on customers' systems.
This is the same manual that is included in the Tru64 UNIX Device
Drivers Kit (DDK).
Guide to Realtime Programming
This manual is for programmers who are developing realtime applications on Tru64 UNIX systems. It provides information on writing new realtime applications and porting existing realtime applications from other systems.
This manual does not present function syntax or reference information; the online reference pages provide that information.
This manual is for application programmers or system engineers who
are already familiar with the C programming language.
It assumes experience
with UNIX operating systems and with UNIX software development tools.
Network Programmer's Guide
This manual describes the Tru64 UNIX network programming environment. It describes in depth the X/Open Transport Interface (XTI) and the sockets and STREAMS programming frameworks, including information about system calls, header files, and libraries. Additionally, it provides information about porting sockets-based applications to XTI.
This manual also describes the software bridge
ifnet
(STREAMS module and DLPI STREAMS pseudodevice driver) that the Tru64 UNIX
operating system supports.
This bridge allows programs that use sockets-based
protocol stacks to access STREAMS drivers, and programs that use STREAMS-based
protocol stacks to access BSD-based drivers.
This manual is for experienced UNIX programmers.
OSF/Motif Programmer's Guide
(available in printed form only)
This manual (developed by the OSF and published by Prentice Hall) provides programming information on how to use the various components of the OSF/Motif environment: the Toolkit, window manager, and user interface language.
This manual is for programmers who want to create applications in the
OSF/Motif environment.
OSF/Motif Style Guide
(available in printed form only)
This manual (developed by the OSF and published by Prentice Hall) provides a framework of behavior specifications to guide application developers, widget developers, and window manager developers in the design and implementation of products consistent with the Presentation Manager and the OSF/Motif user interface.
This manual establishes consistent behavior among new products by drawing out common elements from a variety of current behavioral models. It anticipates the evolution of graphical user interfaces as new technology becomes available and as the use of the OSF/Motif user interface spreads.
This manual is for programmers and interface designers developing
OSF/Motif applications who want to present a uniform and usable software
interface consistent with other OSF/Motif applications.
Programmer's Guide
This manual describes the programming environment of the Tru64 UNIX operating system, with an emphasis on the C programming language.
This manual is for all programmers who use the Tru64 UNIX operating
system to create or maintain programs in any supported language.
Programmer's Guide: STREAMS
(available only in printed form)
This manual (developed by AT&T and published by Prentice Hall) provides information on the use of the STREAMS mechanism at the user and kernel levels. It contains introductory information for those who are unfamiliar with the STREAMS mechanism.
This manual addresses topics such as using STREAMS to monitor, control,
and poll STREAMS; designing and implementing STREAMS modules and drivers;
and using STREAMS-based pipes and FIFOs.
It also describes the STREAMS multiplexing
facility and the STREAMS-based terminal and pseudo-terminal subsystems.
Programming Support Tools
This manual describes commands and utilities for text manipulation, macro and program generation, and source file management on Tru64 UNIX.
Although the commands and utilities described in this manual are primarily
for programmers, some of them (such as
grep,
awk,
sed,
and the Source Code Control System
(SCCS)) are useful for general users.
This manual assumes that the reader is a moderately experienced user
of UNIX systems.
Programming with ONC RPC
This manual provides an overview of high-level programming with remote
procedure calls (RPC) in the Open-Network Computing Environment (ONC).
It
describes how to use the
rpcgen
protocol compiler to create
RPC applications and describes the RPC programming interface.
This manual is for programmers who want to write network applications
without knowledge of the underlying network.
Writing Software for the International Market
Internationalization (often called I18N) is the process of designing or adapting programs to interact with users in their own language and to reflect the culture of the user's region.
This manual provides an overview of internationalization concepts. It also provides details about writing internationalized programs, creating and using message catalogs, and developing or customizing locales.
This manual is for programmers developing internationalized applications
for the Tru64 UNIX operating system.
Writing Kernel Modules
Kernel modules are binary images containing code and data structures that run in the UNIX kernel. These modules provide a level of common code that improves the efficiency of a system by combining like tasks in a single area and eliminating redundant code.
This manual provides information for developers who want to augment the kernel with modules tailored to their particular environment.