An Overview of the Documentation Set
Printing the Documentation
Notation Conventions
Your Comments Invited
The NonStop Distributed Object Manager/MP (NonStop DOM) documentation consists of the following set of HTML documents:
While each document covers a specific area, all documents interlink so you can easily navigate to the material you need. An overview of each document is given below. For a listing of the topics in each document, see the title page of the document.
Note: Since these documents use HTML Cascading Style Sheets, the NonStop DOM documentation set is best viewed with a fourth-generation HTML browser such as Internet Explorer 4.0 or Netscape Communicator.
The Getting Started Guide covers the material you need to know to get NonStop DOM up and running. The guide starts with a brief introduction to distributed object computing and how NonStop DOM fits into the picture. It follows this with instructions on how to install NonStop DOM, the steps needed for a quick configuration, and instructions on how to run one of the sample programs.
Use the Administration Guide to help you configure and run your NonStop DOM system. This guide includes a detailed look at the configuration files used by NonStop DOM and explains how to use the Configuration Tool. The guide also shows you how to optimize your NonStop DOM system, including how to customize the NonStop TS/MP processes running in the NonStop DOM system.
The Programmer's Guide explains how to develop distributed object client/server applications with NonStop DOM. This manual is for all new and prospective users of NonStop DOM. It discusses how to design, develop, and manage NonStop DOM applications and component objects.
With NonStop DOM, you can develop distributed object-oriented applications and components that run on heterogeneous networks, including Tandem systems. The application components you write in NonStop DOM can interoperate with components on other systems that comply with common Object Request Broker Architecture (CORBA®) standards of the Object Management Group® (OMG™).
The Reference Guide is a developer reference that contains Interface Definition Language (IDL) syntax, IDL compiler options, Naming Service interfaces, and details on the NonStop DOM object wrapper. The Reference Guide also describes the classes and interfaces that can be used in NonStop DOM applications. These include the CORBA type Any, the Typedef and Typecode classes, and the objects in the Interface Repository that define the interfaces of CORBA objects.
The glossary provides definitions to the terms used throughout the NonStop DOM documentation set.
The bibliography contains a listings of third-party books covering CORBA and distributed object programming, additional Tandem documents, and Object Management Group (OMG) documents and specifications relating to NonStop DOM.
The index will help you quickly find the topics and subtopics contained in the NonStop DOM documentation set. The index contains a complete listing of document subtopics, arranged in an index-style format of hyperlinks.
If you want to print portions of the documentation set, you can do so using the Print command on your browser (the Print command is located on the broswer's File menu). Before printing, make sure that you click on the frame that contains the content you wish to print. By default, the browser will print the left frame, which contains the Table of Contents for the guide you are currently viewing.
If you want to print an entire guide (such as the Programmer's Guide), start by navigating to the first topic in the guide. After printing the first topic (as described above), press the Next Topic link in the navigation bar at the top of the topic. This will cause the browser to load the next sequential topic in the guide. From there, you can print the second topic. Jump to the next sequential topic by pressing the Next Topic link. Continue cycling through the entire guide, printing each topic as you go, until you have printed the entire set of topics in the guide.
Table 1 summarizes the notation conventions for syntax presentation in these documents.
| Syntax Item | Description |
|---|---|
UPPERCASE LETTERS |
Uppercase letters indicate keywords and reserved words; enter these items exactly as shown. Items not enclosed in brackets are required. For example: MAXATTACH |
< > |
Items enclosed in angle brackets indicate variable items that you supply. Items not enclosed in brackets are required. In the following example, <UserDir>/projectX |
[ ] |
Brackets enclose optional syntax items. For example: TERM [\system-name.]$terminal-name INT[ERRUPTS] A group of items enclosed in brackets is a list from which you can choose one item or none. The items in the list may be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example:
|
{ } |
Braces group a list of items from which you are required to choose one item. The items in the list may be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example:
|
| | | A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example:
|
... |
An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. For example:
An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. For example: "s-char..." |
| " " | When quotation marks surround a defined syntax symbol (such as a bracket or brace), they symbolize an actual character which must be entered as shown. For example: "[" repetition-constant-list "]" |
| Other punctuation | Punctuation not previously described (such as parentheses, commas, and semicolons) must be entered as shown. For example: error := NEXTFILENAME ( <file-name> ) ; LISTOPENS SU $<process-name>.#<su-name> |
Long Commands |
If the syntax of a command is too long to be shown on a single line, each continuation line is indented three spaces, the first of which is separated from the preceding line by a blank line. This spacing distinguishes items in a continuation line from items in a vertical list of selections. For example: ALTER [ / OUT file-spec / ] CONTROLLER [ , attribute-spec ]... |
Tandem welcomes your comments on the quality and usefulness of its software documentation.
After using this documentation set, please take a moment to send us your comments. Also, if you find an error, we would like to hear about it so we can correct the problem in later releases of the documentation. You can contact us by sending an e-mail message or by sending a FAX:
Although you can FAX us, you will receive immediately acknowledgement of your message when you send an e-mail. In your message, be sure to include your name, company name, address, and phone number. If your comments are specific to a particular manual, also include the part number and title of the manual. As soon as possible, we will reply to your message with a detailed response.
Many of the improvements you see in Tandem manuals are a result of suggestions from our customers. Please take this opportunity to help us improve future manuals.
In your message, please include the following information:
Also, please include the document title and part number(s) associated with your comments. Use the following list for a reference to the NonStop DOM documentation set:
To help us improve our software documentation, please answer the following questions in your comments:
If you are reporting a documentation error, please cut and paste the section in question into your e-mail message or include a copy of the page in your FAX. In the message, it is important to note the document title, topic, and subtopic, as appropriate.
Thank you for taking the time to comment on the NonStop DOM documentation set. Your comments will be forwarded to the appropriate person for review and action.