Table of Contents
This document provides a wealth of information about ConfD and how to use it for your particular needs. It is written to be useful both when read front-to-back and also for readers that need to dive into particular aspects of the many features of ConfD.
Readers that are new to ConfD will learn a lot about how to think about, and apply, the features of ConfD by reading the first twelve chapters of this guide. They give an overview of the foundations of ConfD and how they can be used in various types of environments to meet various types of needs. Having read these chapters will also be useful as a guide during early design decisions to avoid missing out on useful ConfD features or applying features in a less than optimal way.
The rest of the document provides information about particular parts of ConfD. Time permitting, it is very useful to read as a whole, but they may also be read selectively depending on which parts of ConfD you are planning to use.
This document also consists of manual pages. The manual pages are reference information for the various tools, libraries and configuration files that are included in the ConfD package. They can also be found in native manual page format in the ConfD release package.
Updated documentation sets are prepared along with ConfD releases and can always be found in the customer download area or as part of the various deliverables. All releases contains the following updated documents:
The ConfD User Guide is this document and is a separate download
The CHANGES file describes all new features and corrections in the release and is a separate download
The HIGHLIGHTS document is released with major releases and describes, with examples, all substantial new features per release. The HIGHLIGHTS document is a separate download.
The KNOWN_ISSUES file is part of the release package and documents all known open issues at the time of release
All ConfD release packages include a README file that describes how to install, set up and get started with ConfD. The README file is located in the top directory of a ConfD installation.
The example collection includes a README file that introduces the reader to the wide selection of examples and what they contain. The README is contained in the examples deliverable.
All of the documents listed above contain information that is essential to the understanding of how to extract the most value out of ConfD and we urge all our users to read them.
We use the following text and syntax conventions throughout the documentation:
Operating system references (e.g. commands, environment
variables, filenames and command options) are rendered in
fixed-width font
Programming language constructs (e.g. functions, constants
and error codes) are rendered in fixed-width
font
Multi-line code snippets and screen output are rendered like this:
# confdc -c test.cs # confdc -l -o test.fxs test.xso
We use the following admonitions throughout this document:
This an example of a tip that is used to describe practical information on how to apply, or think about a certain aspect of the product
This is an example of a note that is used to highlight a particular piece of information
This is an example of a warning that points out information that needs particular attention to avoid problems
We appreciate documentation feedback, comments and suggestions so that we can continuously improve the documentation and make it more useful. Use the request tracker system to send us your comments and make sure you include information about which version and what section of the documentation you are referring to.