← Back to branch summary

~ubuntu-branches/debian/experimental/389-ds-base/experimental

« back to all changes in this revision

Viewing changes to .pc/fix-manpages.patch/man/man8/usn-tombstone-cleanup.pl.8

  • Committer: Package Import Robot
  • Author(s): Timo Aaltonen
  • Date: 2014-10-06 17:13:01 UTC
  • mfrom: (0.2.5)
  • Revision ID: package-import@ubuntu.com-20141006171301-px57k3g1k4ksj8cg
Tags: 1.3.3.3-1
* New upstream release.
* Dropped upstreamed patches, refresh others.
* control, rules, 389-ds-base.install: Add support for systemd.
* fix-obsolete-target.diff: Drop syslog.target from the service files.
* 389-ds-base.links: Mask the initscript so that it's not used with systemd.

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/fix-manpages.patch/man/man8/usn-tombstone-cleanup.pl.8
1
 
.\"                                      Hey, EMACS: -*- nroff -*-
2
 
.\" First parameter, NAME, should be all caps
3
 
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4
 
.\" other parameters are allowed: see man(7), man(1)
5
 
.TH USN-TOMBSTONE-CLEANUP.PL 8 "Mar 5, 2013"
6
 
.\" Please adjust this date whenever revising the manpage.
7
 
.\"
8
 
.\" Some roff macros, for reference:
9
 
.\" .nh        disable hyphenation
10
 
.\" .hy        enable hyphenation
11
 
.\" .ad l      left justify
12
 
.\" .ad b      justify to both left and right margins
13
 
.\" .nf        disable filling
14
 
.\" .fi        enable filling
15
 
.\" .br        insert line break
16
 
.\" .sp <n>    insert n+1 empty lines
17
 
.\" for manpage-specific macros, see man(7)
18
 
.SH NAME 
19
 
usn-tombstone-cleanup.pl - Directory Server perl script for cleaning up tombstone entries.
20
 
.SH SYNOPSIS
21
 
usn-tombstone-cleanup.pl [-Z serverID] [-D rootdn] { -w password | -w - | -j filename } -s suffix -n backend [-m maxusn_to_delete] [-P protocol] [-v] [-h]
22
 
.SH DESCRIPTION
23
 
Deletes the tombstone entries maintained by the instance if the USN Plug-in is enabled. 
24
 
.SH OPTIONS
25
 
A summary of options is included below:
26
 
.TP
27
 
.B \fB\-Z\fR \fIServer Identifier\fR
28
 
The server ID of the Directory Server instance.  If there is only 
29
 
one instance on the system, this option can be skipped.
30
 
.TP
31
 
.B \fB\-D\fR \fIRoot DN\fR
32
 
The Directory Manager DN, or root DN.  If not specified, the script will 
33
 
search the server instance configuration for the value.
34
 
.TP
35
 
.B \fB\-w\fR \fIpassword\fR
36
 
The rootdn password.
37
 
.TP
38
 
.B \fB\-w -\fR 
39
 
.br
40
 
Prompt for the rootdn password.
41
 
.TP
42
 
.B \fB\-j\fR \fIpassword filename\fR
43
 
The name of the file that contains the root DN password.
44
 
.TP
45
 
.B \fB\-s\fR \fIsuffix\fR
46
 
Gives the name of the suffix containing the entries to clean/delete. 
47
 
.TP
48
 
.B \fB\-n\fR \fIbackend\fR
49
 
Gives the name of the database containing the entries to clean/delete.  Example, userRoot. 
50
 
.TP
51
 
.B \fB\-m\fR \fImaxusn_to_delete\fR
52
 
Sets the upper bound for entries to delete. All tombstone entries with an entryUSN value up to the specified maximum (inclusive) are deleted, but not past that USN value. If no maximum USN value is set, then all backend tombstone entries are deleted.
53
 
.TP
54
 
.B \fB\-P\fR \fIprotocol\fR
55
 
The connection protocol to connect to the Directory Server.  Protocols are STARTTLS, LDAPS, LDAPI, and LDAP.
56
 
If this option is skipped, the most secure protocol that is available is used.  For LDAPI, AUTOBIND is also
57
 
available for the root user.
58
 
.TP
59
 
.B \fB\-v\fR 
60
 
.br
61
 
Display verbose output
62
 
.TP
63
 
.B \fB\-h\fR 
64
 
.br
65
 
Display usage
66
 
.SH EXAMPLE
67
 
.TP
68
 
usn-tombstone-cleanup.pl -Z instance2 -D 'cn=directory manager' -w password -n userRoot -s 'ou=people,dc=example,dc=com' -P STARTTLS 
69
 
 
70
 
Note: security must be enabled to use protocol STARTTLS.  If STARTTLS is not available it will default to next strongest/available protocol automatically.
71
 
.SH DIAGNOSTICS
72
 
Exit status is zero if no errors occur.  Errors result in a 
73
 
non-zero exit status and a diagnostic message being written 
74
 
to standard error.
75
 
.SH AUTHOR
76
 
usn-tombstone-cleanup.pl was written by the 389 Project.
77
 
.SH "REPORTING BUGS"
78
 
Report bugs to http://bugzilla.redhat.com.
79
 
.SH COPYRIGHT
80
 
Copyright \(co 2013 Red Hat, Inc.