Preface

A man page is intended to answer concisely the question “What does it do?” The man pages in general comprise a reference manual. Man pages are not intended to be a tutorial.

Overview

The following contains a brief description of each man page section and the information the section references.

• Section 1 describes, in alphabetical order, commands available for Directory Server Enterprise Edition.

• Section 1M describes, in alphabetical order, commands that are used chiefly for Directory Server Enterprise Edition maintenance and administration purposes.

• Section 4 outlines the formats of files delivered with Directory Server Enterprise Edition.

• Section 5dsconf describes Directory Server configuration properties. You modify these properties using the dsconf command.

  Section 5dsconf also describes legacy Directory Server configuration attributes. You modify these attributes using the ldapmodify command on the entries under cn=config.

• Section 5dpconf describes Directory Proxy Server configuration properties. You modify these properties using the dpconf command.

• Section 5dssd describes collections of LDAP schema objects that Directory Server provides. See Intro(5dssd) for an introduction to the LDAP schema reference documentation.

• Section 5dsat describes attribute types defined in the LDAP schema that Directory Server provides.

• Section 5dsoc describes object classes defined in the LDAP schema that Directory Server provides.

Below is a generic format for man pages. The man pages of each manual section generally follow this order, but include only needed headings. See man(1) for more information about man pages in general.

NAME

This section gives the names of the commands or functions documented, followed by a brief description of what they do.

SYNOPSIS

This section shows the syntax of commands or functions. When a command or file does not exist in the standard path, its full path name is shown. Options and arguments are alphabetized, with single letter arguments first, and options with arguments next, unless a different argument order is required.

The following special characters are used in this section:

[ ]

Brackets. The option or argument enclosed in these brackets is optional. If the brackets are omitted, the argument must be specified.

. . .

Ellipses. Several values can be provided for the previous argument, or the previous argument can be specified multiple times, for example, "filename . . ." .

|

Separator. Only one of the arguments separated by this character can be specified at a time.

{ }

Braces. The options and/or arguments enclosed within braces are interdependent, such that everything enclosed must be treated as a unit.

DESCRIPTION

This section defines the functionality and behavior of the service. Thus it describes concisely what the command does. It does not discuss OPTIONS or cite EXAMPLES. Interactive commands, subcommands, requests, macros, and functions are described under USAGE.

OPTIONS

This secton lists the command options with a concise summary of what each option does. The options are listed literally and in the order they appear in the SYNOPSIS section. Possible arguments to options are discussed under the option, and where appropriate, default values are supplied.

OPERANDS

This section lists the command operands and describes how they affect the actions of the command.

OUTPUT

This section describes the output – standard output, standard error, or output files – generated by the command.

RETURN VALUES

If the man page documents functions that return values, this section lists these values and describes the conditions under which they are returned. If a function can return only constant values, such as 0 or –1, these values are listed in tagged paragraphs. Otherwise, a single paragraph describes the return values of each function. Functions declared void do not return values, so they are not discussed in RETURN VALUES.

ERRORS

On failure, most functions place an error code in the global variable errno indicating why they failed. This section lists alphabetically all error codes a function can generate and describes the conditions that cause each error. When more than one condition can cause the same error, each condition is described in a separate paragraph under the error code.

EXAMPLES

This section provides examples of usage or of how to use a command or function. Wherever possible a complete example including command-line entry and machine response is shown. Whenever an example is given, the prompt is shown as $, or if the user must be superuser, #. Examples are followed by explanations, variable substitution rules, or returned values. Most examples illustrate concepts from the SYNOPSIS, DESCRIPTION, OPTIONS, and USAGE sections.

ENVIRONMENT VARIABLES

This section lists any environment variables that the command or function affects, followed by a brief description of the effect.

EXIT STATUS

This section lists the values the command returns to the calling program or shell and the conditions that cause these values to be returned. Usually, zero is returned for successful completion, and values other than zero for various error conditions.

FILES

This section lists all file names referred to by the man page, files of interest, and files created or required by commands. Each is followed by a descriptive summary or explanation.

ATTRIBUTES

This section lists characteristics of commands, utilities, and device drivers by defining the attribute type and its corresponding value. See attributes(5) for more information.

SEE ALSO

This section lists references to other man pages, in-house documentation, and outside publications.

DIAGNOSTICS

This section lists diagnostic messages with a brief explanation of the condition causing the error.

WARNINGS

This section lists warnings about special conditions which could seriously affect your working conditions. This is not a list of diagnostics.

NOTES

This section lists additional information that does not belong anywhere else on the page. It takes the form of an aside to the user, covering points of special interest. Critical information is never covered here.

BUGS

This section describes known bugs and, wherever possible, suggests workarounds.

Directory Server Enterprise Edition Documentation Set

This Directory Server Enterprise Edition documentation set explains how to use Sun Java System Directory Server Enterprise Edition to evaluate, design, deploy, and administer directory services. In addition, it shows how to develop client applications for Directory Server Enterprise Edition. The Directory Server Enterprise Edition documentation set is available at http://docs.sun.com/coll/1224.1.

For an introduction to Directory Server Enterprise Edition, review the following documents in the order in which they are listed.

Table P–1 Directory Server Enterprise Edition Documentation

Document Title	Contents
Sun Java System Directory Server Enterprise Edition 6.0 Release Notes	Contains the latest information about Directory Server Enterprise Edition, including known problems.
Sun Java System Directory Server Enterprise Edition 6.0 Evaluation Guide	Introduces the key features of this release. Demonstrates how these features work and what they offer in the context of a fictional deployment that you can implement on a single system.
Sun Java System Directory Server Enterprise Edition 6.0 Deployment Planning Guide	Explains how to plan and design highly available, highly scalable directory services based on Directory Server Enterprise Edition. Presents the basic concepts and principles of deployment planning and design. Discusses the solution life cycle, and provides high-level examples and strategies to use when planning solutions based on Directory Server Enterprise Edition.
Sun Java System Directory Server Enterprise Edition 6.0 Installation Guide	Explains how to install the Directory Server Enterprise Edition software. Shows how to select which components to install, configure those components after installation, and verify that the configured components function properly.  For instructions on installing Directory Editor, go to http://docs.sun.com/coll/DirEdit_05q1.
Sun Java System Directory Server Enterprise Edition 6.0 Migration Guide	Provides instructions for upgrading components from earlier versions of Directory Server Enterprise Edition.
Sun Java System Directory Server Enterprise Edition 6.0 Administration Guide	Provides command-line instructions for administering Directory Server Enterprise Edition.  For hints and instructions on using the DSCC to administer Directory Server Enterprise Edition, see the online help provided in the DSCC.  For instructions on administering Directory Editor, go to http://docs.sun.com/coll/DirEdit_05q1. For instructions on administering Identity Synchronization for Windows, go to http://docs.sun.com/coll/isw_04Q3.
Sun Java System Directory Server Enterprise Edition 6.0 Developer's Guide	Shows how to develop directory client applications with the tools and APIs that are provided as part of Directory Server Enterprise Edition.
Sun Java System Directory Server Enterprise Edition 6.0 Reference	Introduces the technical and conceptual foundations of Directory Server Enterprise Edition. Describes its components, architecture, processes, and features. Also provides a referenceto the developer APIs.
Sun Java System Directory Server Enterprise Edition 6.0 Man Page Reference	Describes the command-line tools, schema objects, and other public interfaces that are available through Directory Server Enterprise Edition. Individual sections of this document can be installed as online manual pages.
Sun Java System Identity Synchronization for Windows 6.0 Deployment Planning Guide	Provides general guidelines and best practices for planning and deploying Identity Synchronization for Windows

Related Reading

The SLAMD Distributed Load Generation Engine (SLAMD) is a Java^TM application that is designed to stress test and analyze the performance of network-based applications. It was originally developed by Sun Microsystems, Inc. to benchmark and analyze the performance of LDAP directory servers. SLAMD is available as an open source application under the Sun Public License, an OSI-approved open source license. To obtain information about SLAMD, go to http://www.slamd.com/. SLAMD is also available as a java.net project. See https://slamd.dev.java.net/.

Java Naming and Directory Interface (JNDI) technology supports accessing the Directory Server using LDAP and DSML v2 from Java applications. For information about JNDI, see http://java.sun.com/products/jndi/. The JNDI Tutorial contains detailed descriptions and examples of how to use JNDI. this tutorial is at http://java.sun.com/products/jndi/tutorial/.

Directory Server Enterprise Edition can be purchased as a standalone product or as a component of Sun Java Enterprise System. Java Enterprise System is a software infrastructure that supports enterprise applications distributed across a network or Internet environment. If Directory Server Enterprise Edition was purchased as a component of Java Enterprise System, you should be familiar with the system documentation at http://docs.sun.com/coll/1286.2.

Redistributable Files

Directory Server Enterprise Edition does not provide any files that you can redistribute.

Default Paths and Command Locations

This section explains the default paths used in the documentation, and gives the locations of commands on different operating systems and deployment types.

Default Paths

The following table describes the default paths that are used in this book.

Table P–2 Default Paths

Placeholder	Description	Default Value
install-path	Represents the base installation directory for Directory Server Enterprise Edition software.	When you install from a zip distribution using dsee_deploy(1M), the default install-path is the current directory. You can set the install-path using the -i option of the dsee_deploy command. When you install from a native package distribution, such as you would using the Java Enterprise System installer or when installing Directory Service Control Center, the default installation path is one of the following locations.  (Solaris systems) /opt/SUNWdsee/. (HP-UX systems) /opt/sun/. (Red Hat systems) /opt/sun/. (Windows systems) C:\Program Files\Sun\JavaES5\.
instance-path	Represents the full path to an instance of Directory Proxy Server or Directory Server.	No default path exists. Instance paths must nevertheless always be found on the local file system. The documentation uses /local/dps/ for Directory Proxy Server, and /local/ds/ for Directory Server.
serverroot	Represents the parent directory of the Identity Synchronization for Windows installation location	Depends on installation
isw-hostname	Represents the Identity Synchronization for Windows instance directory	Depends on installation
/path/to/cert8.db	Represents the default path and file name of the client’s certificate database for Identity Synchronization for Windows	current-working-dir/cert8.db
serverroot/isw-hostname/logs/	Represents the default path to the Identity Synchronization for Windows local logs for the System Manager, each connector, and the Central Logger	Depends on installation
serverroot/isw-hostname/logs/central/	Represents the default path to the Identity Synchronization for Windows central logs	Depends on installation

Command Locations

To know more about each of the commands, see the relevant man pages. For full descriptions of the files installed, see also the following documentation.

• covers files installed with Directory Server, and files created for server instances.

• covers files installed with Directory Proxy Server, and files created for server instances.

• covers files installed with Directory Server Resource Kit.