About ChorusOS 5.0 Documentation

Chapter 3 Documentation Descriptions

This chapter lists the ChorusOS 5.0 documentation collections and provides a brief description of each document in these collections.

The same collections and documents are provided in online PDF, HTML, and AnswerBook formats to be viewed using a browser.

The ChorusOS 5.0 documentation set is organized in collections to reflect groups of users and their tasks.

The books contained in the ChorusOS 5.0 documentation collections are briefly described in the following sections:

ChorusOS 5.0 Installation Collection

The ChorusOS 5.0 Installation Collection contains documents relevant to installing the ChorusOS operating system (host, targets, boot services, network connections). A brief description of each document in this collection follows.

Table 3-1 ChorusOS 5.0 Installation Collection

Document title 

Description 

About ChorusOS 5.0 Documentation

This book is intended for all users of ChorusOS products. 

ChorusOS 5.0 Installation Guide

This book documents the procedures for installing, building, and booting ChorusOS system. It describes how to: 

  • Install the ChorusOS operating system on a host workstation running the Solaris operating environment.

  • Set up a boot server running on the Solaris operating environment.

  • Build and boot the ChorusOS operating system on the UltraSPARC, Intel, PowerPC, and MPC8xx supported reference targets.

This document is aimed at system administrators and solution designers. It is the companion volume to the ChorusOS 5.0 System Administrator's Guide.

ChorusOS 5.0 Transition Guide

This book provides information on:

  • The major differences between version 4.0 and version 5.0 of the ChorusOS operating system.

  • Porting your existing software applications and drivers.

This book is intended for solution designers, application developers, and system administrators. 

ChorusOS 5.0 Application Developer Collection

The ChorusOS 5.0 Application Developer Collection contains documents relevant to software application developers working in the ChorusOS environment. A brief description of each document in this collection follows.

Table 3-2 ChorusOS 5.0 Application Developer Collection

Document title 

Description 

ChorusOS 5.0 Features and Architecture Overview

This guide describes the features and architecture of the ChorusOS operating system. It serves as a general overview of the architecture of the ChorusOS operating system, presenting its particularities and advantages, as well as introducing all its features and components. 

This guide is intended for all users. 

ChorusOS 5.0 Application Developer's Guide

This guide demonstrates the key tasks developers perform when creating applications to run on ChorusOS systems. It does not cover hardware support such as bus and device driver development, subsystem development, system internals, installation, general system architecture or system administration, though it does incorporate parts of some of these as necessary to illustrate specific aspects of ChorusOS application development. 

This book is intended for application developers and describes how to build applications using the range of ChorusOS APIs through code examples. 

ChorusOS 5.0 Debugging Guide

This guide presents the source-level debugging architecture of the ChorusOS operating system. It provides an overview of the GNU GDB debugger and of the Insight graphical user interface, and highlights the modifications to these tools that are specific to the ChorusOS operating system. It discusses the use of these tools to debug ChorusOS applications and systems. 

This book is intended for application developers. 

ChorusOS 5.0 System Administrator Collection

The ChorusOS 5.0 System Administrator Collection contains documents describing all aspects of ChorusOS system administration. A brief description of each book in this collection follows.

Table 3-3 ChorusOS 5.0 System Administration Collection

Document title 

Description 

ChorusOS 5.0 System Administrator's Guide

This guide provides a single source of information for an installed ChorusOS system. It contains information on using ChorusOS product, including configuring and tuning information, with instructions on the configuration of the system image. The setting up and sharing of file systems is also explained. This guide provides full explanations of network commands and daemons, and advice on setting up a ChorusOS 5.0 system for Ethernet and PPP. 

This book is intended for system administrators of a ChorusOS system. 

ChorusOS 5.0 Source Delivery Guide

This guide describes how to install, configure, and build the source code delivery of the ChorusOS product. It explains both the source architecture and the way the product is built from source code. It also deals with issues such as how to perform source development in such a way that the delivery can still be patched as fixes and improvements to the system become available. 

This book is intended for ChorusOS specialists performing source development. 

ChorusOS 5.0 Target Platform Collection

The ChorusOS 5.0 Target Platform Collection contains documents relevant to developers that are porting the ChorusOS 5.0 operating system to different target platforms with the reference target families, or adding device drivers. A brief description of each document in this collection follows.

Table 3-4 ChorusOS 5.0 Target Platform Collection

Document title 

Description 

ChorusOS 5.0 Board Support Package Developer's Guide

This book provides a single guide for developers that are porting the ChorusOS system to a new hardware platform, or adding device support to the ChorusOS system. It describes the Board Support Package (BSP) architecture and the device driver framework, as well as device driver hardening. 

This book is intended for developers that are involved in ChorusOS hardware support. 

ChorusOS 5.0 Target Family Guide (SPARC Platform Edition)

This guide defines the ChorusOS 5.0 product for the UltraSPARC-IIi and UltraSPARC-IIe target processor families. 

The focus of this short target family specific document is to provide accurate and succinct reference information that exhaustively describes what is supported for a given hardware platform. It does not include procedures to build a ChorusOS system. Such information can be found in the ChorusOS 5.0 Installation Guide.

This document does not replace a support contract that describes what is supported for a specific customer. 

This book is intended for solution designers, and may serve for ChorusOS evaluation purposes. 

ChorusOS 5.0 Target Family Guide (Intel Platform Edition)

This guide defines the ChorusOS 5.0 product for the x86/Pentium target processor family. 

The focus of this short target family specific document is to provide accurate and succinct reference information that exhaustively describes what is supported for a given hardware platform. It does not include procedures to build a ChorusOS system. Such information can be found in the ChorusOS 5.0 Installation Guide.

This document does not replace a support contract that describes what is supported for a specific customer. 

This book is intended for solution designers, and may serve for ChorusOS evaluation purposes. 

ChorusOS 5.0 Target Family Guide (PowerPC Platform Edition)

This guide defines the ChorusOS 5.0 product for the PowerPC target processor family. 

The focus of this short target family specific document is to provide accurate and succinct reference information that exhaustively describes what is supported for a given hardware platform. It does not include procedures to build a ChorusOS system. Such information can be found in the ChorusOS 5.0 Installation Guide.

This document does not replace a support contract that describes what is supported for a specific customer. 

This book is intended for solution designers, and may serve for ChorusOS evaluation purposes 

ChorusOS 5.0 Target Family Guide (MPC8xx Platform Edition)

This guide defines the ChorusOS 5.0 product for the MPC8xx target micro-controller family. 

The focus of this short target family specific document is to provide accurate and succinct reference information that exhaustively describes what is supported for a given hardware platform. It does not include procedures to build a ChorusOS system. Such information can be found in the ChorusOS 5.0 Installation Guide.

This document does not replace a support contract that describes what is supported for a specific customer. 

This book is intended for solution designers, and may serve for ChorusOS evaluation purposes. 

ChorusOS 5.0 Reference Manual Collection

The ChorusOS 5.0 Reference Manual Collection contains the ChorusOS 5.0 man pages. A brief description of each man page section in this collection follows.

Table 3-5 ChorusOS 5.0 Reference Manual Collection

ChorusOS 5.0 Man Page Section 

Description 

man pages section 1CC: User utilities This Reference Manual describes the commands and utilities available with the ChorusOS operating system.
man pages section 1M: System Management Utilities This Reference Manual describes the system management utilities and daemons supplied with the ChorusOS operating system.
man pages section 2DL: Data Link Services This Reference Manual describes ChorusOS data link services.
man pages section 2K: Kernel Services This Reference Manual describes the microkernel system calls provided by the ChorusOS operating system.
man pages section 2MON: Monitoring Services This Reference Manual describes the monitoring services provided by the ChorusOS operating system.
man pages section 2POSIX: POSIX System Calls This Reference Manual describes the POSIX 1003.1 and 1003.1b compliant system Calls available in the ChorusOS operating system.
man pages section 2RESTART: Hot Restart and Persistent Memory Services This Reference Manual describes the system calls associated with the ChorusOS Hot Restart feature.
man pages section 3EXT: ChorusOS Extensions This Reference Manual describes the ChorusOS system extensions.
man pages section 3FTPD: FTP Daemon Services This Reference Manual describes the FTP daemons and related services and functions provided by the ChorusOS operating system.
man pages section 3LDAP: LDAP Library

This Reference Manual describes the routines that are available in the LDAP client library implementation in ChorusOS. 

man pages section 3M: Mathematical Libraries

This Reference Manual details the mathematical functions supplied with the ChorusOS operation system. 

man pages section 3POSIX: POSIX Library Functions

This Reference Manual describes the POSIX library functions available in the ChorusOS operating system.  

man pages section 3RPC: RPC Services

This Reference Manual describes the remote procedure calls and RPC library routines of the ChorusOS operating system. 

man pages section 3STDC: Standard C Library Functions

This Reference Manual describes the standard C functions supplied with the ChorusOS operating system. 

man pages section 3TELD:Telnet Services

This Reference Manual describes the functions and commands of the TELNETD library API supplied with the ChorusOS operating system. 

man pages section 4CC: Files

This Reference Manual describes the file formats used or read by various programs of the ChorusOS operating system. 

man pages section 5FEA: ChorusOS Features and APIs

This Reference Manual describes the features and APIs available in the ChorusOS operating system. 

man pages section 7P: Protocols

This Reference Manual describes the networking protocols used by the ChorusOS operating system. 

man pages section 7S: Services

This Reference Manual describes the special device files and services supplied with the ChorusOS operating system. 

man pages section 9DDI: Device Driver Interfaces

This Reference Manual describes all the Device Driver Interfaces that are available in the ChorusOS system. 

man pages section 9DKI: Driver to Kernel Interface

This Reference Manual describes the Driver to Kernel Interfaces that are available in the ChorusOS system. 

man pages section 9DRV: Driver Implementations

This Reference Manual describes all the Driver Implementations that are available in the ChorusOS system.