man-configure.xml revision 73adb2e3dbaa8a9f6448cefccb7933f68c3c7348
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
! Copyright 2011-2015 ForgeRock AS.
!
-->
<refentry xml:id='configure-1'
xmlns='http://docbook.org/ns/docbook'
version='5.0' xml:lang='en'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:schemaLocation='http://docbook.org/ns/docbook
<info>
<copyright>
<year>2011-2015</year>
<holder>ForgeRock AS.</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>configure</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
<refmiscinfo class="version">${docTargetVersion}</refmiscinfo>
</refmeta>
<refnamediv>
<refname>configure</refname>
<refpurpose>sets the instance location of an OpenDJ package installation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
The <command>configure</command> command configures an OpenDJ package installation.
The command registers the directory server as an SMF service,
specifies where the directory server instance will be located,
and specifies the user and group names of the instance owner.
</para>
<para>
This command is available
in the <trademark>OpenSolaris</trademark> package installation only.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<para>
The following options are supported:
</para>
<varlistentry>
<term><option>--groupName {groupName}</option></term>
<listitem>
<para>
The group name of the instance owner.
If no group name is specified,
the primary group of the <replaceable>userName</replaceable> is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--instancePath {path}</option></term>
<listitem>
<para>
The path where the instance will be located.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--userName {userName}</option></term>
<listitem>
<para>
The user name of the instance owner.
If no user name is specified, the default <literal>ldap</literal> is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V, --version</option></term>
<listitem>
<para>
Displays directory server version information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?, -H, --help</option></term>
<listitem>
<para>
Displays usage information.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
The following example configures the instance path,
user name and group name for a directory server package installation:
</para>
<screen>
--userName myUser \
--groupName myGroup
</screen>
</refsect1>
<refsect1>
<title>Attributes</title>
<para>
See <citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for descriptions of the following attributes:
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>ATTRIBUTE TYPE</entry>
<entry>ATTRIBUTE VALUE</entry>
</row>
</thead>
<tbody align="center">
<row>
<entry>Interface Stability</entry>
<entry>Uncommitted</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>