]> git.sur5r.net Git - openldap/blob - doc/man/man8/rcpt500.8
Update misleading statement about ldap_init(). It use is actually
[openldap] / doc / man / man8 / rcpt500.8
1 .TH RCPT500 8C "22 September 1998" "OpenLDAP LDVERSION"
2 .SH NAME
3 rcpt500 \- mail to X.500 gateway program
4 .SH SYNOPSIS
5 .B LIBEXECDIR/rcpt500 [\-l] [\-h ldaphost] [\-p ldapport]
6 .B [\-b searchbase] [\-a] [\-U] [\-z sizelimit] [\-u dapuser]
7 .B [\-f filterfile] [\-t templatefile] [\-c rdncount]
8 .SH DESCRIPTION
9 .B rcpt500
10 is a mail-query server that answers X.500 white pages queries.  It is
11 designed to be run out of your mail system alias file (or the equivalent).
12 .B rcpt500
13 accepts the entire contents (including headers) of an RFC 822
14 message on standard input.  The message is parsed, and a search or help
15 command found in the Subject: header of message body is recognized and
16 a reply is sent to the sender.
17 .LP
18 If you are using
19 .BR sendmail (8),
20 you could add the following line to the
21 .BR aliases (5)
22 file
23 .RB ( /etc/aliases )
24 to have
25 .B rcpt500
26 invoked whenever mail is sent to the address \fInamelookup\fP on your host:
27 .nf
28 .fi
29 .ft tt
30     namelookup: "|LIBEXECDIR/rcpt500 -l"
31 .ft
32 .fi
33 .SH OPTIONS
34 .TP
35 .B \-l
36 Enable logging of requests to the LOG_DAEMON facility.
37 .TP
38 .BI \-h " ldaphost"
39 Specify an alternate host on which the ldap server is running.
40 .TP
41 .BI \-p " ldapport"
42 Specify and alternate TCP port where the ldap server is running.
43 .TP
44 .BI \-b " searchbase"
45 Specify an alternate base for searches.  \fIsearchbase\fP should be
46 a string-represented LDAP Distinguished Name.
47 .TP
48 .B \-a
49 Turn off dereferencing of aliases for the LDAP search.
50 .TP
51 .B \-U
52 Use Connectionless LDAP (over UDP).  This option is only available when
53 .B rcpt500
54 is compiled with -DCLDAP.
55 .TP
56 .BI \-z " sizelimit"
57 Limit the maximum number of entries returned to \fIsizelimit\fP
58 entries.
59 .TP
60 .BI \-t " templatefile"
61 Specify an alternate template configuration file for use with the
62 .BR ldap_init_templates (3)
63 facility, used by rcpt500.
64 .TP
65 .BI \-c " rdncount"
66 Specify the number of DN components to show for the names and DN attributes
67 within entries matching the search.
68 .SH NOTES
69 The default values for most of the things you can specify with options
70 are configured at compile time in the
71 .B include/ldapconfig.h.edit
72 include
73 file.  Also included there are the pathname of the help file, the name
74 of the command used to send replies, etc.  You should configure
75 .B ldapconfig.h.edit
76 for your site.
77 .SH FILES
78 .PD 0
79 .TP 20
80 .B DATADIR/rcpt500.help
81 help file
82 .PD
83 .SH "SEE ALSO"
84 .BR ldap (3),
85 .BR aliases (5),
86 .BR sendmail (8)
87 .SH ACKNOWLEDGEMENTS
88 .B      OpenLDAP
89 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
90 .B      OpenLDAP
91 is derived from University of Michigan LDAP 3.3 Release.