diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/man1/cl-dump.1 | 96 | ||||
-rw-r--r-- | man/man1/dbgen.pl.1 | 84 | ||||
-rw-r--r-- | man/man1/dbscan.1 | 106 | ||||
-rw-r--r-- | man/man1/dsktune.1 | 64 | ||||
-rw-r--r-- | man/man1/infadd.1 | 82 | ||||
-rw-r--r-- | man/man1/ldap-agent.1 | 59 | ||||
-rw-r--r-- | man/man1/ldclt.1 | 232 | ||||
-rw-r--r-- | man/man1/ldif.1 | 55 | ||||
-rw-r--r-- | man/man1/logconv.pl.1 | 118 | ||||
-rw-r--r-- | man/man1/migratecred.1 | 65 | ||||
-rw-r--r-- | man/man1/mmldif.1 | 61 | ||||
-rw-r--r-- | man/man1/pwdhash.1 | 62 | ||||
-rw-r--r-- | man/man1/repl-monitor.1 | 69 | ||||
-rw-r--r-- | man/man1/rsearch.1 | 138 | ||||
-rw-r--r-- | man/man8/migrate-ds.pl.8 | 155 | ||||
-rw-r--r-- | man/man8/ns-slapd.8 | 60 | ||||
-rw-r--r-- | man/man8/setup-ds.pl.8 | 89 |
17 files changed, 1595 insertions, 0 deletions
diff --git a/man/man1/cl-dump.1 b/man/man1/cl-dump.1 new file mode 100644 index 00000000..4cf450b7 --- /dev/null +++ b/man/man1/cl-dump.1 @@ -0,0 +1,96 @@ +.\" 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 CL-DUMP 1 "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 +cl-dump \- Dump and decode Directory Server replication change log +.SH SYNOPSIS +.B cl\-dump +[\fI-h host\fR] [\fI-p port\fR] [\fI-D bind-dn\fR] -w bind-password | -P bind-cert + [\fI-r replica-roots\fR] [\fI-o output-file\fR] [\fI-c\fR] [\fI-v\fR] + +.PP +.B cl\-dump +\-i changelog\-ldif\-file\-with\-base64encoding [\fI\-o output\-file\fR] [\fI\-c\fR] +.PP +.SH DESCRIPTION +Dump and decode Directory Server replication change log +.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 \-c +Dump and interpret CSN only. This option can be used with or +without -i option. +.TP +.B \-D bind\-dn +Directory server's bind DN. Default to "cn=Directory Manager" if +the option is omitted. +.TP +.B \-h host +Directory server's host. Default to the server where the script +is running. +.TP +.B \-i changelog\-ldif\-file\-with\-base64encoding +If you already have a ldif-like changelog, but the changes +in that file are encoded, you may use this option to +decode that ldif-like changelog. +.TP +.B \-o output\-file +Path name for the final result. Default to STDOUT if omitted. +.TP +.B \-p port +Directory server's port. Default to 389. +.TP +.B \-P bind\-cert +Pathname of binding certificate DB +.TP +.B \-r replica\-roots +Specify replica roots whose changelog you want to dump. The replica +roots may be seperated by comma. All the replica roots would be +dumped if the option is omitted. +.TP +.B \-v +Print the version of this script. +.TP +.B \-w bind\-password +Password for the bind DN +.SH RESTRICTIONS +If you are not using \-i option, the script should be run when the server +is running, and from where the server's changelog directory is accessible. +.br +.SH SEE ALSO +.BR repl-monitor (1) +.br +.SH AUTHOR +cl-dump 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@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. diff --git a/man/man1/dbgen.pl.1 b/man/man1/dbgen.pl.1 new file mode 100644 index 00000000..49cf8ee9 --- /dev/null +++ b/man/man1/dbgen.pl.1 @@ -0,0 +1,84 @@ +.\" 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 DBGEN.PL 1 "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 +dbgen.pl \- Random LDIF database creator +.SH SYNOPSIS +.B dbgen.pl +[\fIOPTIONS\fR] -o output_file -n number +.SH DESCRIPTION +Random LDIF database creator. Used to generate large LDIF files +for use in testing the 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 +Verbose output +.TP +.B \-q +Quiet output +.TP +.B \-s suffix +LDAP suffix. Default is 'dc=example,dc=com' +.TP +.B \-c CN naming style +Naming style for RDN's. Default is UID +.TP +.B \-O organizationalPersons +Organizationalpersons objectClass. Default is inetOrgPerson. +.TP +.B \-p piranha style ACI +Piranha style aci. Default is barracua +.TP +.B \-r seed +Seed number for random number generator +.TP +.B \-g +Print extra entries for orgchart +.TP +.B \-x +Suppress printing of the preamble +.TP +.B \-y +Suppress printing of Organizational Units +.TP +.B \-l +Location of directory containing data files, default is /usr/share/dirsrv/data +.TP +.B \-n number +Number of entries to be generated +.br +.SH AUTHOR +dbgen.pl 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@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. diff --git a/man/man1/dbscan.1 b/man/man1/dbscan.1 new file mode 100644 index 00000000..e23ae273 --- /dev/null +++ b/man/man1/dbscan.1 @@ -0,0 +1,106 @@ +.\" 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 DBSCAN 1 "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 +dbscan \- scans a Directory Server database index file and dumps the contents +.SH SYNOPSIS +.B dbscan +\fB-f <filename>\fR [\fI-R\fR] [\fI-t <size>\fR] +[\fI-K <entry_id>\fR] [\fI-k <key>\fR] [\fI-l <size>\fR] +[\fI-G <n>\fR] [\fI-n\fR] [\fI-r\fR] [\fI-s\fR] +.PP +.SH DESCRIPTION +Scans a Directory Server database index file and dumps the contents. +.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\-f\fR <filename> +specify db file +.TP +.B \fB\-R\fR +dump as raw data +.TP +.B \fB\-t\fR <size> +entry truncate size (bytes) +.IP +entry file options: +.TP +.B \fB\-K\fR <entry_id> +lookup only a specific entry id +index file options: +.TP +.B \fB\-k\fR <key> +lookup only a specific key +.TP +.B \fB\-l\fR <size> +max length of dumped id list +(default 4096; 40 bytes <= size <= 1048576 bytes) +.TP +.B \fB\-G\fR <n> +only display index entries with more than <n> ids +.TP +.B \fB\-n\fR +display ID list lengths +.TP +.B \fB\-r\fR +display the conents of ID list +.TP +.B \fB\-s\fR +Summary of index counts +.IP +.SH USAGE +Sample usages: +.TP +Dump the entry file: +.B +dbscan \fB\-f\fR id2entry.db4 +.TP +Display index keys in cn.db4: +.B dbscan \fB\-f\fR cn.db4 +.TP +Display index keys and the count of entries having the key in mail.db4: +.B +dbscan \fB\-r\fR \fB\-f\fR mail.db4 +.TP +Display index keys and the IDs having more than 20 IDs in sn.db4: +.B +dbscan \fB\-r\fR \fB\-G\fR 20 \fB\-f\fR sn.db4 +.TP +Display summary of objectclass.db4: +.B +dbscan \fB\-f\fR objectclass.db4 +.br +.SH AUTHOR +dbscan 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@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. diff --git a/man/man1/dsktune.1 b/man/man1/dsktune.1 new file mode 100644 index 00000000..c3ecb766 --- /dev/null +++ b/man/man1/dsktune.1 @@ -0,0 +1,64 @@ +.\" 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 DSKTUNE 1 "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 +dsktune \- reports memory, network, and file system tuning settings +which can affect the performance of the Directory Server +.SH SYNOPSIS +.B dsktune +[\fI-q\fR] [\fI-c\fR] [\fI-D\fR] [\fI-v\fR] [\fI-i installdir\fR] +.SH DESCRIPTION +Reports memory, network, and file system tuning settings +which can affect the performance of the 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 \fB\-q\fR +dsktune only reports essential settings +.TP +.B \fB\-c\fR +dsktune only reports tuning information for client machines +.TP +.B \fB\-D\fR +dsktune also reports the commands executed +.TP +.B \fB\-v\fR +dsktune only reports its release version date +.TP +.B \fB\-i installdir\fR +specify alternate server installation directory +.br +.SH AUTHOR +dsktune 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@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. diff --git a/man/man1/infadd.1 b/man/man1/infadd.1 new file mode 100644 index 00000000..4f349bf4 --- /dev/null +++ b/man/man1/infadd.1 @@ -0,0 +1,82 @@ +.\" 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 INFADD 1 "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 +infadd \- infinite additions to LDAP server +.SH SYNOPSIS +.B infadd +\fI-s suffix -u bindDN -w password \fR[\fIoptions\fR] +.SH DESCRIPTION +infadd is used +to measure performance of the add operation. It can +span multiple threads in order to test the performance +under heavy locking. +.PP +.SH OPTIONS +.TP +.B \-h hostname +hostname (default: localhost) +.TP +.B \-p port +port (default: 389) +.TP +.B \-t threads +number of threads to spin (default: 1) +.TP +.B \-d +use TCP no\-delay +.TP +.B \-q +quiet mode (no status updates) +.TP +.B \-v +verbose mode (give per\-thread statistics) +.TP +.B \-I num +first uid (default: 0) +.TP +.B \-l count +limit count; stops when the total count exceeds <count> +.TP +.B \-i msec +sample interval in milliseconds (default: 10000) +.TP +.B \-R size +generate <size> random names instead of using data files +.TP +.B \-z size +add binary blob of average size of <size> bytes +.PP +.SH SEE ALSO +.BR rsearch (1) +.br +.SH AUTHOR +infadd 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@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. diff --git a/man/man1/ldap-agent.1 b/man/man1/ldap-agent.1 new file mode 100644 index 00000000..cba23d38 --- /dev/null +++ b/man/man1/ldap-agent.1 @@ -0,0 +1,59 @@ +.\" 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 LDAP-AGENT 1 "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 +ldap-agent \- SNMP agent for Directory Server +.SH SYNOPSIS +.B ldap-agent +.RI [\fI-D\fR] <configuration-file> +.SH DESCRIPTION +ldap-agent is an SNMP subagent for 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 +.TP +.B \-D +Enable debugging +.TP +.B <configfile> +Configuration file for the ldap agent +.SH SEE ALSO +.BR snmpd(8) +.br +.SH USAGE +Sample usage: +.TP +.B ldap-agent /etc/dirsrv/config/ldap-agent.conf +.br +.SH AUTHOR +ldap\-agent 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@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. diff --git a/man/man1/ldclt.1 b/man/man1/ldclt.1 new file mode 100644 index 00000000..5aaf501d --- /dev/null +++ b/man/man1/ldclt.1 @@ -0,0 +1,232 @@ +.\" 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 LDCLT 1 "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 +ldclt \- load test program for LDAP +.SH SYNOPSYS +.B ldclt +[\fI\-qQvV\fR] [\fI\-E <max errors>\fR] +[\fI\-b <base DN>\fR] [\fI\-h <host>\fR] [\fI\-p <port>\fR] [\fI\-t <timeout>\fR] +[\fI\-D <bind DN>\fR] [\fI\-w <passwd>\fR] [\fI\-o <SASL option>\fR] +[\fI\-e <execParams>\fR] [\fI\-a <max pending>\fR] +[\fI\-n <nb threads>\fR] [\fI\-i <nb times>\fR] [\fI\-N <nb samples>\fR] +[\fI\-I <err number>\fR] [\fI\-T <total>\fR] +[\fI\-r <low> \-R <high>\fR] +[\fI\-f <filter>\fR] [\fI\-s <scope>\fR] +[\fI\-S <slave>\fR] [\fI\-P<master port>\fR] +[\fI\-W <waitsec>\fR] [\fI\-Z <certfile>\fR] +.PP +.SH DESCRIPTION +This tool is a LDAP client targeted to validate the reliability of +the product under a wide variety of stress conditions. +.PP +.SH OPTIONS +The valid options are: +.TP +.B \fB\-a\fR +Asynchronous mode, with max pending operations. +.TP +.B \fB\-b\fR +Give the base DN to use. Default "o=sun,c=us". +.TP +.B \fB\-D\fR +Bind DN. See \fB\-w\fR +.TP +.B \fB\-E\fR +Max errors allowed. Default 1000. +.TP +.B \fB\-f\fR +Filter for searches. +.TP +.B \fB\-h\fR +Host to connect. Default "localhost". +.TP +.B \fB\-i\fR +Number of times inactivity allowed. Default 3 (30 seconds) +.TP +\fB\-I\fR +Ignore errors (cf. \fB\-E\fR). Default none. +.TP +.B \fB\-n\fR +Number of threads. Default 10. +.TP +.B \fB\-N\fR +Number of samples (10 seconds each). Default infinite. +.TP +.B \fB\-o\fR +SASL Option. +.TP +.B \fB\-p\fR +Server port. Default 389. +.TP +.B \fB\-P\fR +Master port (to check replication). Default 16000. +.TP +.B \fB\-q\fR +Quiet mode. See option \fB\-I\fR. +.TP +.B \fB\-Q\fR +Super quiet mode. +.TP +.B \fB\-r\fR +Range's low value. +.TP +.B \fB\-R\fR +Range's high value. +.TP +.B \fB\-s\fR +Scope. May be base, subtree or one. Default subtree. +.TP +.B \fB\-S\fR +Slave to check. +.TP +.B \fB\-t\fR +LDAP operations timeout. Default 30 seconds. +.TP +.B \fB\-T\fR +Total number of operations per thread. Default infinite. +.TP +.B \fB\-v\fR +Verbose. +.TP +.B \fB\-V\fR +Very verbose. +.TP +.B \fB\-w\fR +Bind passwd. See \fB\-D\fR. +.TP +.B \fB\-W\fR +Wait between two operations. Default 0 seconds. +.TP +.B \fB\-Z\fR +certfile. Turn on SSL and use certfile as the certificate DB +.TP +.B \fB\-e\fR +Execution parameters: +.IP +\fBadd\fR ldap_add() entries. +.br +\fBappend\fR entries to the genldif file. +.br +\fBascii\fR ascii 7\-bits strings. +.br +\fBattreplace=name:mask\fR replace attribute of existing entry. +.br +\fBattrlist=name:name:name\fR specify list of attribs to retrieve +.br +\fBattrsonly=0|1\fR ldap_search() parameter. Set 0 to read values. +.br +\fBbindeach\fR ldap_bind() for each operation. +.br +\fBbindonly\fR only bind/unbind, no other operation is performed. +.br +\fBclose\fR will close() the fd, rather than ldap_unbind(). +.br +\fBcltcertname=name\fR name of the SSL client certificate +.br +\fBcommoncounter\fR all threads share the same counter. +.br +\fBcounteach\fR count each operation not only successful ones. +.br +\fBdelete\fR ldap_delete() entries. +.br +\fBdontsleeponserverdown\fR will loop very fast if server down. +.br +\fBemailPerson\fR objectclass=emailPerson (\fB\-e\fR add only). +.br +\fBesearch\fR exact search. +.br +\fBgenldif=filename\fR generates a ldif file +.br +\fBimagesdir=path\fR specify where are the images. +.br +\fBincr\fR incremental values. +.br +\fBinetOrgPerson\fR objectclass=inetOrgPerson (\fB\-e\fR add only). +.br +\fBkeydbfile=file\fR filename of the key database +.br +\fBkeydbpin=password\fR password for accessing the key database +.br +\fBnoglobalstats\fR don't print periodical global statistics +.br +\fBnoloop\fR does not loop the incremental numbers. +.br +\fBobject=filename\fR build object from input file +.br +\fBperson\fR objectclass=person (\fB\-e\fR add only). +.br +\fBrandom\fR random filters, etc... +.br +\fBrandomattrlist=name:name:name\fR random select attrib in the list +.br +\fBrandombase\fR random base DN. +.br +\fBrandombaselow=value\fR low value for random generator. +.br +\fBrandombasehigh=value\fR high value for random generator. +.br +\fBrandombinddn\fR random bind DN. +.br +\fBrandombinddnfromfile=fine\fR retrieve bind DN & passwd from file +.br +\fBrandombinddnlow=value\fR low value for random generator. +.br +\fBrandombinddnhigh=value\fR high value for random generator. +.br +\fBrdn=attrname:value\fR alternate for \fB\-f\fR. +.br +\fBreferral=on|off|rebind\fR change referral behaviour. +.br +\fBscalab01\fR activates scalab01 scenario. +.br +\fBscalab01_cnxduration\fR maximum connection duration. +.br +\fBscalab01_maxcnxnb\fR modem pool size. +.br +\fBscalab01_wait\fR sleep() between 2 attempts to connect. +.br +\fBsmoothshutdown\fR main thread waits till the worker threads exit. +.br +\fBstring\fR create random strings rather than random numbers. +.br +\fBv2\fR ldap v2. +.br +\fBwithnewparent\fR rename with newparent specified as argument. +.br +\fBrandomauthid\fR random SASL Authid. +.br +\fBrandomauthidlow=value\fR low value for random SASL Authid. +.br +\fBrandomauthidhigh=value\fR high value for random SASL Authid. +.PP +.SH AUTHOR +ldclt 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@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. diff --git a/man/man1/ldif.1 b/man/man1/ldif.1 new file mode 100644 index 00000000..183e2438 --- /dev/null +++ b/man/man1/ldif.1 @@ -0,0 +1,55 @@ +.\" 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 LDIF 1 "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 +ldif \- manipulates an LDIF stream by adding a column with the +defined attribute type +.SH SYNOPSIS +.B ldif +[\fI-b\fR] attrtype +.SH DESCRIPTION +Manipulates an LDIF stream by adding a column with the +defined attribute type +.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 \-b +Output base64 binary format +.SH USAGE +.TP +.B +ldif dn < /tmp/ldif +.SH AUTHOR +ldif 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@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. diff --git a/man/man1/logconv.pl.1 b/man/man1/logconv.pl.1 new file mode 100644 index 00000000..378a0f05 --- /dev/null +++ b/man/man1/logconv.pl.1 @@ -0,0 +1,118 @@ +.\" 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 LOGCONV.PL 1 "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 +logconv.pl \- analyzes Directory Server access log files +.SH SYNOPSIS +.B logconv.pl +[\fI\-h\fR] [\fI\-d <rootDN>\fR] [\fI\-s <size limit>\fR] [\fI\-v\fR] [\fI\-V\fR] +[\fI\-S <start time>\fR] [\fI\-E <end time>\fR] +[\fI\-efcibaltnxgju\fR] [\fI access log ... ... \fR] +.PP +.SH DESCRIPTION +Analyzes Directory Server access log files for specific information defined on the command +line +.SH OPTIONS +A summary of options is included below: +.TP +.B \fB\-h\fR +help/usage +.TP +.B \fB\-d\fR <Directory Managers DN> +DEFAULT \-> cn=directory manager +.TP +.B \fB\-s\fR <Number of results to return per category> +DEFAULT \-> 20 +.TP +.B \fB\-X\fR <IP address to exclude from connection stats> +E.g. Load balancers +.TP +.B \fB\-v\fR show version of tool +Print version of the tool +.TP +.B \fB\-S\fR <time to begin analyzing logfile from> +Time to begin analyzing logile from +E.g. [28/Mar/2002:13:14:22 \fB\-0800]\fR +.TP +.B \fB\-E\fR <time to stop analyzing logfile> +Time to stop analyzing logile from +E.g. [28/Mar/2002:13:24:62 \fB\-0800]\fR +.TP +\fB\-V\fR <enable verbose output \- includes all stats listed below> +Verbose output +.TP +.B \fB\-[efcibaltnxgju]\fR +.br +\fBe\fR Error Code stats +.br +\fBf\fR Failed Login Stats +.br +\fBc\fR Connection Code Stats +.br +\fBi\fR Client Stats +.br +\fBb\fR Bind Stats +.br +\fBa\fR Search Base Stats +.br +\fBl\fR Search Filter Stats +.br +\fBt\fR Etime Stats +.br +\fBn\fR Nentries Stats +.br +\fBx\fR Extended Operations +.br +\fBr\fR Most Requested Attribute Stats +.br +\fBg\fR Abandoned Operation Stats +.br +\fBj\fR Recommendations +.br +\fBu\fR Unindexed Search Stats +.br +\fBy\fR Connection Latency Stats +.br +\fBp\fR Open Connection ID Stats +.PP +.SH USAGE +Examples: +.IP +logconv.pl \fB\-s\fR 10 \fB\-V\fR access +.IP +logconv.pl \fB\-d\fR "cn=directory manager" /export/server4/slapd\-host/logs/access* +.IP +logconv.pl \fB\-s\fR 50 \fB\-ibgju\fR access* +.IP +logconv.pl \fB\-S\fR "[28/Mar/2002:13:14:22 \fB\-0800]\fR" \fB\-E\fR "[28/Mar/2002:13:50:05 \fB\-0800]\fR" \fB\-e\fR access +.br +.SH AUTHOR +logconv.pl 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@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. diff --git a/man/man1/migratecred.1 b/man/man1/migratecred.1 new file mode 100644 index 00000000..0071b1f1 --- /dev/null +++ b/man/man1/migratecred.1 @@ -0,0 +1,65 @@ +.\" 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 MIGRATECRED 1 "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 +migratecred \- Migrate credentials from one instance of Directory Server +to another +.SH SYNOPSIS +.B migratecred +-o OldInstancePath -n NewInstancePath -c OldCredential [\fI-p NewPluginPath\fR] +.SH DESCRIPTION +migratecred migrates credentials from one Directory Server instance to the other. + +New plugin path defaults to [\fBlibdir\fP/dirsrv/plugins] if not given +.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. +\fBmigratecred\fP is a program that migrates credentials used for +replication and chaining - that is, the password used by the server +to perform the simple BIND operation for server to server communications. +.SH OPTIONS +A summary of options is included below: +.TP +.B \-o OldInstancePath +Path to the source instance +.TP +.B \-n NewInstancePath +Path to the destination instance +.TP +.B \-c OldCredential +Old credential +.TP +.B \-p NewPluginPath +New plugin path (of the new instance) +.br +.SH AUTHOR +migratecred 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@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. diff --git a/man/man1/mmldif.1 b/man/man1/mmldif.1 new file mode 100644 index 00000000..43a98738 --- /dev/null +++ b/man/man1/mmldif.1 @@ -0,0 +1,61 @@ +.\" 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 MMLDIF 1 "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 +mmldif \- mmldif util +.SH SYNOPSIS +.B mmldif +[-c] [-D] [-o out.ldif] in1.ldif in2.ldif ... + +.SH DESCRIPTION +This manual page documents briefly the +.B mmldif +command. +.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 \-c +Write a change file (.delta) for each input file +.TP +.B \-D +Print debugging information +.TP +.B \-o +Write authoritative data to this file +.SH SEE ALSO +.BR ldif (1) +.br +.SH AUTHOR +mmldif 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@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. diff --git a/man/man1/pwdhash.1 b/man/man1/pwdhash.1 new file mode 100644 index 00000000..d5c83212 --- /dev/null +++ b/man/man1/pwdhash.1 @@ -0,0 +1,62 @@ +.\" 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 PWDHASH 1 "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 +pwdhash \- Generator of password hashes +.SH SYNOPSIS +.B pwdhash +[\fI-D config-dir\fR] [\fI-H\fR] [\fI-s scheme | -c comparepwd\fR] password +.PP +.SH DESCRIPTION +Generates password hashes which can also be used in LDIF password fields. +This uses the Directory Server password generator. +.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 \-H +Show summary of options. +.TP +.B \-s scheme +Password scheme to be used (e.g. MD5, SHA1, SHA256, SHA512, +SSHA, SSHA256, SSHA512) +.TP +.B \-c comparepassword +Password to be compared against +.TP +.B \-D configdir +Takes the password schema directly from the ns-slapd configuration +.br +.SH AUTHOR +dbscan 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@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. diff --git a/man/man1/repl-monitor.1 b/man/man1/repl-monitor.1 new file mode 100644 index 00000000..79ea73d5 --- /dev/null +++ b/man/man1/repl-monitor.1 @@ -0,0 +1,69 @@ +.\" 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 REPL-MONITOR 1 "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 +repl-monitor \- Directory Server replication monitor +.SH SYNOPSIS +.B repl-monitor +-f configuration-file [\fI-h host\fR] [\fI-p port\fR] [\fI-r\fR] +[\fI-u refresh-url\fR] [\fI-t refresh-interval\fR] [\fI-v\fR] + +.SH DESCRIPTION +Outputs the status of all of the configured Directory Servers +participating in replication. The servers to query for status +are specified in the configuration file. +.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 \-h host +Hostname of DS server +.TP +.B \-p port +TCP port +.TP +.B \-f configuration\-file +Configuration file +.TP +.B \-r +Removes extra HTML tags +.TP +.B \-u refresh\-url +Refresh url +.TP +.B \-t refresh\-interval +Refresh interval +.br +.SH AUTHOR +repl-monitor 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@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. diff --git a/man/man1/rsearch.1 b/man/man1/rsearch.1 new file mode 100644 index 00000000..b829be2e --- /dev/null +++ b/man/man1/rsearch.1 @@ -0,0 +1,138 @@ +.\" 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 RSEARCH 1 "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 +rsearch \- Stress test an LDAP server with search operations +.SH SYNOPSIS +.B rsearch +\fB\-D\fR binddn \fB\-w\fR bindpw \fB\-s\fR suffix \fB\-f\fR filter [\fIoptions\fR] +.PP +.SH DESCRIPTION +Stress tests an LDAP server with search operations. +.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 \-H +print Usage (this message) +.TP +.B \fB\-h\fR host +ldap server host (default: localhost) +.TP +.B \fB\-p\fR port +ldap server port (default: 389) +.TP +.B \fB\-S\fR scope +search SCOPE [0,1,or 2] (default: 2) +.TP +.B \fB\-b\fR +bind before every operation +.TP +.B \fB\-u\fR +don't unbind \fB\-\-\fR just close the connection +.TP +.B \fB\-L\fR +set linger \fB\-\-\fR connection discarded when closed +.TP +.B \fB\-N\fR +No operation \fB\-\-\fR just bind (ignore mdc) +.TP +.B \fB\-v\fR +verbose +.TP +.B \fB\-y\fR +nodelay +.TP +.B \fB\-q\fR +quiet +.TP +.B \fB\-l\fR +logging +.TP +.B \fB\-m\fR +operaton: modify non\-indexed attr (description). \fB\-B\fR required +.TP +.B \fB\-M\fR +operaton: modify indexed attr (telephonenumber). \fB\-B\fR required +.TP +.B \fB\-d\fR +operaton: delete. \fB\-B\fR required +.TP +.B \fB\-c\fR +operaton: compare. \fB\-B\fR required +.TP +.B \fB\-i\fR file +name file; used for the search filter +.TP +.B \fB\-B\fR file +[DN and] UID file (use '\-B \e?' to see the format) +.TP +.B \fB\-A\fR attrs +list of attributes for search request +.TP +.B \fB\-a\fR file +list of attributes for search request in a file +.HP +.B \fB\-\-\fR (use '\-a \e?' to see the format ; \fB\-a\fR & \fB\-A\fR are mutually exclusive) +.PP +.TP +.B \fB\-n\fR number +(reserved for future use) +.TP +.B \fB\-o\fR number +Search time limit, in seconds; (default: 30; no time limit: 0) +.TP +.B \fB\-j\fR number +sample interval, in seconds (default: 10) +.TP +.B \fB\-t\fR number +threads (default: 1) +.TP +.B \fB\-T\fR number +Time limit, in seconds; cmd stops when exceeds <number> +.TP +.B \fB\-V\fR +show running average +.TP +.B \fB\-C\fR num +take num samples, then stop +.TP +.B \fB\-R\fR num +drop connection & reconnect every num searches +.TP +.B \fB\-x\fR +Use \fB\-B\fR file for binding; ignored if \fB\-B\fR is not given +.br +.SH AUTHOR +rsearch 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@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. diff --git a/man/man8/migrate-ds.pl.8 b/man/man8/migrate-ds.pl.8 new file mode 100644 index 00000000..b3a53ece --- /dev/null +++ b/man/man8/migrate-ds.pl.8 @@ -0,0 +1,155 @@ +.\" 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@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. diff --git a/man/man8/ns-slapd.8 b/man/man8/ns-slapd.8 new file mode 100644 index 00000000..cf471ea7 --- /dev/null +++ b/man/man8/ns-slapd.8 @@ -0,0 +1,60 @@ +.\" 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@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. diff --git a/man/man8/setup-ds.pl.8 b/man/man8/setup-ds.pl.8 new file mode 100644 index 00000000..62c12bbc --- /dev/null +++ b/man/man8/setup-ds.pl.8 @@ -0,0 +1,89 @@ +.\" 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@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. |