389-ds-base/man/man8/suffix2instance.8

.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH SUFFIX2INSTANCE 8 "Mar 5, 2013"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME 
suffix2instance - Directory Server script for finding a backend name
.SH SYNOPSIS
suffix2instance [\-Z serverID] \-s suffix [\-h]
.SH DESCRIPTION
Maps a suffix to a backend name.  This script can be run while the server is running, or stopped.
.SH OPTIONS
A summary of options is included below:
.TP
.B \fB\-Z\fR \fIServer Identifier\fR
The server ID of the Directory Server instance.  If there is only 
one instance on the system, this option can be skipped.
.TP
.B \fB\-s\fR \fISuffix DN\fR
The suffix DN to be mapped to a backend name.  Example: "dc=example,dc=com"
.TP
.B \fB\-h\fR
.br
Display the usage.
.SH EXAMPLE
.TP
suffix2instance \-s 'dc=example,dc=com'
.TP
suffix2instance \-Z instance3 \-s 'dc=example,dc=com'
.SH DIAGNOSTICS
Exit status is zero if no errors occur.  Errors result in a 
non-zero exit status and a diagnostic message being written 
to standard error.
.SH AUTHOR
suffix2instance was written by the 389 Project.
.SH "REPORTING BUGS"
Report bugs to https://fedorahosted.org/389/newticket.
.SH COPYRIGHT
Copyright \(co 2013 Red Hat, Inc.