~ubuntu-branches/ubuntu/trusty/389-ds-base/trusty

« back to all changes in this revision

Viewing changes to man/man8/syntax-validate.pl.8

  • Committer: Package Import Robot
  • Author(s): Timo Aaltonen
  • Date: 2013-08-30 00:31:55 UTC
  • mfrom: (1.2.1)
  • Revision ID: package-import@ubuntu.com-20130830003155-oimuzdqopkvp2cd0
Tags: 1.3.1.7-0ubuntu1
Sync from unreleased debian git.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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 SYNTAX-VALIDATE.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
syntax-validate.pl - Directory Server perl script for validating attribute syntax.
 
20
.SH SYNOPSIS
 
21
syntax-validate.pl [-Z serverID] [-D rootdn] { -w password | -w - | -j filename } -b baseDN [-f filter] [-P protocol] [-v] [-h]
 
22
.SH DESCRIPTION
 
23
Syntax validation checks every modification to attributes to make sure that the new value has the required syntax for that attribute type. All attribute syntaxes are validated against the definitions in RFC 4514. 
 
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\-b\fR \fIbaseDN\fR
 
46
Gives the base DN for the entries to validate. 
 
47
.TP
 
48
.B \fB\-f\fR \fIfilter\fR
 
49
Contains a search filter to use to select a subset of entries to validate. If this is not given, then all entries under the base DN are checked.
 
50
.TP
 
51
.B \fB\-P\fR \fIprotocol\fR
 
52
The connection protocol to connect to the Directory Server.  Protocols are STARTTLS, LDAPS, LDAPI, and LDAP.
 
53
If this option is skipped, the most secure protocol that is available is used.  For LDAPI, AUTOBIND is also
 
54
available for the root user.
 
55
.TP
 
56
.B \fB\-v\fR 
 
57
.br
 
58
Display verbose ouput
 
59
.TP
 
60
.B \fB\-h\fR 
 
61
.br
 
62
Display usage
 
63
.SH EXAMPLE
 
64
.TP
 
65
syntax-validate.pl -Z instance2 -D 'cn=directory manager' -w password -b 'dc=example,dc=com' -f 'cn=*' -P STARTTLS 
 
66
 
 
67
Note: security must be enabled to use protocol STARTTLS.  If STARTTLS is not available it will default to next strongest/available protocol automatically.
 
68
.SH DIAGNOSTICS
 
69
Exit status is zero if no errors occur.  Errors result in a 
 
70
non-zero exit status and a diagnostic message being written 
 
71
to standard error.
 
72
.SH AUTHOR
 
73
syntax-validate.pl was written by the 389 Project.
 
74
.SH "REPORTING BUGS"
 
75
Report bugs to http://bugzilla.redhat.com.
 
76
.SH COPYRIGHT
 
77
Copyright \(co 2013 Red Hat, Inc.