diff options
author | Rich Megginson <rmeggins@redhat.com> | 2008-07-15 15:50:56 +0000 |
---|---|---|
committer | Rich Megginson <rmeggins@redhat.com> | 2008-07-15 15:50:56 +0000 |
commit | 0bcf4f075f6ac857d60464f4d259374a9929ab2b (patch) | |
tree | e2d03b42d41542ac4373123c355f104a28ff3cc5 /man/man1/dbscan.1 | |
parent | 58bd25b8ce1ecd09d19aae31f6a989928d0413ed (diff) | |
download | ds-0bcf4f075f6ac857d60464f4d259374a9929ab2b.tar.gz ds-0bcf4f075f6ac857d60464f4d259374a9929ab2b.tar.xz ds-0bcf4f075f6ac857d60464f4d259374a9929ab2b.zip |
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
Diffstat (limited to 'man/man1/dbscan.1')
-rw-r--r-- | man/man1/dbscan.1 | 106 |
1 files changed, 106 insertions, 0 deletions
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. |