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