[Fedora-directory-commits] ldapserver/man/man8 migrate-ds.pl.8, NONE, 1.1 ns-slapd.8, NONE, 1.1 setup-ds.pl.8, NONE, 1.1

Tue Jul 15 15:50:58 UTC 2008

Author: rmeggins

Update of /cvs/dirsec/ldapserver/man/man8
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv20958/ldapserver/man/man8

Added Files:
	migrate-ds.pl.8 ns-slapd.8 setup-ds.pl.8 
Log Message:
Resolves: bug 447614
Bug Description: Lack of manpages
Reviewed by: nhosoi (Thanks!)
Branch: HEAD
Fix Description: This adds man pages for the command line utilities.  The configure.ac diffs were a little bit tricky - apparently, mandir is not set to a correct default value, so we have to make sure we set a reasonable default value it if the user has not set it (e.g. rpmbuild will override it with --mandir=something).
Platforms tested: Fedora 8, Fedora 9
Flag Day: no
Doc impact: no


--- NEW FILE migrate-ds.pl.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 MIGRATE-DS.PL 8 "May 18, 2008"
.\" 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
migrate\-ds.pl \- Directory Server Migration script
.SH SYNOPSIS
.B migrate\-ds.pl 
[\-\-options] \fB\-\-\fR [args]
.SH DESCRIPTION
Directory Server Migration script - migrates Directory Server from
older releases to the current release.
.PP
This script will copy instances (data and configuration) from the old
server root directory to their new FHS locations.  This script does a
copy only \- the data in the old instances will be left untouched.  The
old instances must be shutdown first to ensure that the databases are
copied safely.  During migration your migrated instances will be started.
.PP
.SH OPTIONS
A summary of options is included below:
.TP
.B \fB\-\-help\fR
This message
.TP
.B \fB\-\-version\fR
Print the version and exit
.TP
.B \fB\-\-debug\fR
Turn on debugging
.TP
.B \fB\-\-oldsroot\fR
The old server root directory to migrate from
.TP
.B \fB\-\-actualsroot\fR This is the old location of the old server root.
.TP
.B \fB\-\-silent\fR
Use silent setup \- no user input
.TP
.B \fB\-\-file\fR=\fIname\fR
Use the file 'name' in .inf format to supply the
default answers
.TP
.B \fB\-\-keepcache\fR
Do not delete the temporary .inf file generated by
this program
.TP
.B \fB\-\-logfile\fR
Log migration messages to this file \- otherwise, a temp
file will be used
.TP
.B \fB\-\-instance\fR
By default, all directory server instances will be
migrated.  You can use this argument to specify one
or more (e.g. \fB\-i\fR slapd\-foo \fB\-i\fR slapd\-bar) if you do
not want to migrate all of them.
.TP
.B \fB\-\-cross\fR
See below.
.PP
For all options, you can also use the short name e.g. \fB\-h\fR, \fB\-d\fR, etc.
For the \fB\-d\fR argument, specifying it more than once will increase the
debug level e.g. \fB\-ddddd\fR
.PP
args:
You can supply default .inf data in this format:
.IP
section.param=value
.PP
e.g.
.IP
General.FullMachineName=foo.example.com
.PP
or
.IP
"slapd.Suffix=dc=example, dc=com"
.PP
Values passed in this manner will override values in an .inf file
given with the \fB\-f\fR argument.
.PP
actualsroot:
This is used when you must migrate from one machine to another.  The
usual case is that you have mounted the old server root on a different
root directory, either via a network mount, or by copying a tarball
made using a relative directory on the source machine to the
destination machine and untarring it.
.PP
For example: machineA is a 32bit machine, and you want to migrate your
servers to a new 64bit machine.  Lets assume your old server root on
machineA was /opt/myds, and your new machine also wants to use a
server root of /opt/myds.  There are a couple of different ways to
proceed.  Either make a tarball of opt/myds from machineA using a
relative path (i.e. NOT /opt/myds) or use NFS to mount
machineA:/opt/myds on a different mount point
(e.g. machineB:/migration/opt/myds).
.PP
If you do this, you should give the old "real" server root (/opt/myds)
as the \fB\-\-actualsroot\fR argument, and use /migration/opt/myds for the
\fB\-\-oldsroot\fR argument.  That is, the oldsroot is the physical location of
the files on disk.  The actualsroot is the old value of the server root
on the source machine.
.PP
cross:
Also known as crossplatform, or 'c', or 'x'.
This is when the source machine is a different architecture than the
destination machine.  In this case, only certain data will be available
for migration.  Changelog information will not be migrated, and replicas
will need to be reinitialized (if migrating masters or hubs).  This type
of migration requires that all of your old databases have been dumped
to LDIF format, and the LDIF file must be in the default database directory
(usually /opt/fedora\-ds/slapd\-instance/db), and the LDIF file must have
the same name as the database instance directory, with a ".ldif".  For
example, if you have
.IP
/opt/fedora\-ds/slapd\-instance/db/userRoot/ and
/opt/fedora\-ds/slapd\-instance/db/NetscapeRoot/
.PP
you must first use db2ldif to export these databases to LDIF e.g.
.IP
cd /opt/fedora\-ds/slapd\-instance
\&./db2ldif \fB\-n\fR userRoot \fB\-a\fR /opt/fedora\-ds/slapd\-instance/db/userRoot.ldif and
\&./db2ldif \fB\-n\fR NetscapeRoot \fB\-a\fR /opt/fedora\-ds/slapd\-instance/db/NetscapeRoot.ldif
.PP
Then you must somehow make your old server root directory available on
the destination machine, either by creating a tar archive on the source
and copying it to the destination, or by network mounting the source
directory on the destination machine.
.br
.SH AUTHOR
migrate-ds.pl was written by the Fedora Directory Server Project.
.SH "REPORTING BUGS"
Report bugs to http://bugzilla.redhat.com.
.SH COPYRIGHT
Copyright \(co 2008 Red Hat, Inc.
.br
This manual page was written by Michele Baldessari <michele at pupazzo.org>,
for the Debian project (but may be used by others).
.br
This is free software.  You may redistribute copies of it under the terms of
the Directory Server license found in the LICENSE file of this
software distribution.  This license is essentially the GNU General Public
License version 2 with an exception for plug-in distribution.


--- NEW FILE ns-slapd.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 NS-SLAPD 8 "May 18, 2008"
.\" 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
ns-slapd \- The main Directory Server daemon
.SH SYNOPSIS
.B ns-slapd
-D configdir [\fI-d debuglevel\fR] [\fI-i pidlogfile\fR] [\fI-v\fR] [\fI-V\fR]
.SH DESCRIPTION
ns-slapd launches the LDAP Directory Server 
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
.SH OPTIONS
A summary of options is included below:
.TP
.B \-v
Show version of program.
.TP
.B \-D configdir
Specifies the configuration directory pointing at the instance
to be started (e.g. /etc/dirsrv/slapd-localhost)
.TP
.B \-d debuglevel
Specifies the debuglevel to be used 
.TP
.B \-i pidlogfile
Specifies file where the pid of the process will be stored
.br
.SH AUTHOR
ns-slapd was written by the Fedora Directory Server Project.
.SH "REPORTING BUGS"
Report bugs to http://bugzilla.redhat.com.
.SH COPYRIGHT
Copyright \(co 2001 Sun Microsystems, Inc. Used by permission.
.br
Copyright \(co 2008 Red Hat, Inc.
.br
This manual page was written by Michele Baldessari <michele at pupazzo.org>,
for the Debian project (but may be used by others).
.br
This is free software.  You may redistribute copies of it under the terms of
the Directory Server license found in the LICENSE file of this
software distribution.  This license is essentially the GNU General Public
License version 2 with an exception for plug-in distribution.


--- NEW FILE setup-ds.pl.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 SETUP-DS.PL 8 "May 18, 2008"
.\" 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
setup\-ds.pl \- Set up an instance of Directory Server
.SH SYNOPSIS
.B setup-ds.pl
[\fI--options\fR] \fI-- \fR[\fIargs\fR]
.SH DESCRIPTION
Set up a Directory Server instance.  Creates the configuration
files for an instance of Directory Server based on a few parameters
like the hostname, port number, and directory manager information.
Can be run in interactive mode with different levels of verbosity, or
in silent mode with parameters supplied in a .inf format file or
on the command line.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
.SH OPTIONS
A summary of options is included below:
.TP
.B \fB\-\-help\fR
This message
.TP
.B \fB\-\-version\fR
Print the version and exit
.TP
.B \fB\-\-debug\fR
Turn on debugging
.TP
.B \fB\-\-silent\fR
Use silent setup \- no user input
.TP
.B \fB\-\-file\fR=\fIname\fR
Use the file 'name' in .inf format to supply the default answers
.TP
.B \fB\-\-keepcache\fR
Do not delete the temporary .inf file generated by this program
.TP
.B \fB\-\-logfile\fR
Log setup messages to this file \- otherwise, a temp file will be used
.PP
For all options, you can also use the short name e.g. \fB\-h\fR, \fB\-d\fR, etc.  For the \fB\-d\fR argument,
specifying it more than once will increase the debug level e.g. \fB\-ddddd\fR
.PP
args:
You can supply default .inf data in this format:
.IP
section.param=value
.PP
e.g.
.IP
General.FullMachineName=foo.example.com
.PP
or
.IP
"slapd.Suffix=dc=example, dc=com"
.PP
Values passed in this manner will override values in an .inf file given with the \fB\-f\fR argument.
.br
.SH AUTHOR
setup-ds.pl was written by the Fedora Directory Server Project.
.SH "REPORTING BUGS"
Report bugs to http://bugzilla.redhat.com.
.SH COPYRIGHT
Copyright \(co 2008 Red Hat, Inc.
.br
This manual page was written by Michele Baldessari <michele at pupazzo.org>,
for the Debian project (but may be used by others).
.br
This is free software.  You may redistribute copies of it under the terms of
the Directory Server license found in the LICENSE file of this
software distribution.  This license is essentially the GNU General Public
License version 2 with an exception for plug-in distribution.