Followup of yesterday's commit. Fix man page for configure and unconfigure ...

Ludovic Poitou

21.46.2011 0604895c54230dd8d6ebd0195a65bd3544535fab

Followup of yesterday's commit. Fix man page for configure and unconfigure (Solaris specific)

 opends/resource/man/man1/configure.1

@@ -30,104 +30,63 @@
.SH NAME
configure \- sets the instance location of an OpenDJ package installation
.SH SYNOPSIS
.LP
.nf
\fBconfigure\fR \fIoptions\fR
.fi

.HP \w'\fBconfigure\fR'u
\fBconfigure\fR [options]
.SH DESCRIPTION
.sp
.LP
.PP
The \fBconfigure\fR 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.
.sp
.LP
.PP
This command is available in the OpenSolaris\u\s-2TM\s+2\d package installation only.
.sp
.LP
.PP
Run \fBconfigure --help\fR for more information.
.SH OPTIONS
.sp
.LP
.PP
The following options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-?\fR, \fB-H\fR, \fB--help\fR\fR
.ad
.RS 25n
.rt
.PP
\fB-?, \-H, \-\-help\fR
.RS 4
Displays usage information.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--groupName\fR \fIgroupName\fR\fR
.ad
.RS 25n
.rt
.PP
\fB\-\-groupName {groupName}\fR
.RS 4
The group name of the instance owner. If no group name is specified, the primary group of the \fIuserName\fR is used.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--instancePath\fR \fIpath\fR\fR
.ad
.RS 25n
.rt
.PP
\fB\-\-instancePath {path}\fR
.RS 4
The path where the instance will be located. If no path is specified, the default \fB/var/opendj\fR is used.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--userName\fR \fIuserName\fR\fR
.ad
.RS 25n
.rt
.PP
\fB\-\-userName {userName}\fR
.RS 4
The user name of the instance owner. If no user name is specified, the default \fBldap\fR is used.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-V\fR, \fB--version\fR\fR
.ad
.RS 25n
.rt
.PP
\fB\-V, \-\-version\fR
.RS 4
Displays directory server version information.
.RE

.SH EXAMPLES
.LP
.PP
\fBExample 1 \fRConfiguring a Directory Server Package Installation
.sp
.LP
.PP
The following example configures the instance path, user name and group name for a directory server package installation:

.sp
.in +2
.if n \{\
.RS 4
.\}
.nf
$ /usr/opendj/configure --instancePath /var/opendj --userName myUser \
  --groupName myGroup
.fi
.in -2
.sp

.sp
.LP
.if n \{\
.RE
.\}
.SH ATTRIBUTES
.sp
.LP
.PP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
@@ -138,4 +97,26 @@
_
Interface StabilityUncommitted
.TE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
To view a copy of this license, visit
http://creativecommons.org/licenses/by-nc-nd/3.0/
or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp


 opends/resource/man/man1/unconfigure.1

@@ -30,72 +30,50 @@
.SH NAME
unconfigure \- unconfigures an OpenDJ instance that was  installed by using the package installation
.SH SYNOPSIS
.LP
.nf
\fBunconfigure\fR \fIoptions\fR
.fi

.HP \w'\fBunconfigure\fR'u
\fBunconfigure\fR [options]
.SH DESCRIPTION
.sp
.LP
.PP
The \fBunconfigure\fR command ensures that the removal of an OpenDJ package does not leave the host in an inconsistent state. The command stops the  directory server instance, removes the SMF registration, and resets the instance  location. The command does not remove the server instance files themselves.
.sp
.LP
.PP
Run the \fBunconfigure\fR command as root before removing the OpenDJ package. Do not run this command if you intend to upgrade the directory server.
.sp
.LP
.PP
This command is available in the OpenSolaris\u\s-2TM\s+2\d package installation only.
.sp
.LP
.PP
Run \fBunconfigure --help\fR for more information.
.SH OPTIONS
.sp
.LP
.PP
The following options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-?\fR, \fB-H\fR, \fB--help\fR\fR
.ad
.RS 18n
.rt
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Displays usage information.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-V\fR, \fB--version\fR\fR
.ad
.RS 18n
.rt
.PP
\fB\-V, \-\-version\fR
.RS 4
Displays directory server version information.
.RE

.SH EXAMPLES
.LP
.PP
\fBExample 1 \fRRemoving a Directory Server Package Installation
.sp
.LP
.PP
The following commands unset the instance path for a directory server package  installation, and then remove the package:

.sp
.in +2
.if n \{\
.RS 4
.\}
.nf
# /usr/opendj/unconfigure
# pkgrm opendj
.fi
.in -2
.sp

.if n \{\
.RE
.\}
.SH ATTRIBUTES
.sp
.LP
.PP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;