git.sur5r.net Git - openldap/blob - contrib/whois++/whois++d.man

   1 .\" Copyright (c) 1993 The University of Adelaide.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms are permitted
   5 .\" provided that the above copyright notice and this paragraph are
   6 .\" duplicated in all such forms and that any documentation,
   7 .\" advertising materials, and other materials related to such
   8 .\" distribution and use acknowledge that the software was developed
   9 .\" by the University of Adelaide. The name of the University may not
  10 .\" be used to endorse or promote products derived from this software
  11 .\" without specific prior written permission.
  12 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  13 .\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  14 .\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  15 .\"
  16 .\"     @(#)whois++d.man        1.5
  17 .\"
  18 .TH WHOIS++D 8 "26 April 1993"
  19 .SH NAME
  20 whois++d \- Whois++ white pages server
  21 .SH SYNOPSIS
  22 .B whois++d
  23 [
  24 .B \-b
  25 .I basename
  26 ] [
  27 .B \-d
  28 .I debuglevel
  29 ] [
  30 .B \-h
  31 .I ldaphost
  32 ] [
  33 .B \-i
  34 ] [
  35 .B \-l
  36 ] [
  37 .B \-s
  38 .I maxhits
  39 ] [
  40 .B \-t
  41 .I timelimit
  42 ] [
  43 .B \-T
  44 .I tailorfile
  45 ] [
  46 .B \-u
  47 .I user
  48 ] [
  49 .B \-v
  50 ] [
  51 .B \-?
  52 ]
  53 .SH DESCRIPTION
  54 .I Whois++d
  55 is an implementation of the new whois++ white pages server. The server is in
  56 reality a DUA interface that uses the lightweight directory access protocol
  57 [RFC????] to communicate with an X.500 Directory System Agent (DSA) via a
  58 .MS ldapd 8
  59 server. The whois++ architecture (and command format) is described in an
  60 Internet Draft of the IETF's WNILS Working Group.
  61
  62 By default
  63 .I whois++d
  64 reads it's configuration information from a tailor file (whois++dtailor)
  65 located in the
  66 .IR ETCDIR
  67 but this may be supplemented by command line options, including the
  68 specification of a secondary tailor file.
  69 .PP
  70 Options are:
  71 .TP
  72 .B \-b
  73 Specify the base for all queries, this must be specified either via the
  74 commandline or (more normally) via the tailor file.
  75 .TP
  76 .B \-d
  77 Print debugging information.
  78 A number after the ``d'' determines the level of messages printed.
  79 .TP
  80 .B \-h
  81 Specify the host running the
  82 .MS ldapd 8
  83 server.
  84 .TP
  85 .B \-i
  86 If the entry for the ``base'' of the searches has an info attribute then
  87 print it as part of the welcome banner.
  88 .TP
  89 .B \-l
  90 Enable logging of queries via syslog.
  91 .TP
  92 .B \-s
  93 Specify the maximum number of entries you wish returned as a result of a
  94 search. This is normally controlled by the DSA but if this is not possible
  95 then it can be restricted via this option.
  96 .TP
  97 .B \-t
  98 Specify a timelimit for queries to the DSA. Note this is
  99 .B not
 100 the timeout limit between queries when using the
 101 .I hold
 102 constraint.
 103 .TP
 104 .B \-T
 105 Specify an additional tailor file. Useful if you only have a binary and the
 106 default location is not what you consider to be a ``normal'' place.
 107 .TP
 108 .B \-u
 109 Specify the user's DN to use when binding to the directory.
 110 .TP
 111 .B \-v
 112 Return the version number of this server and then exit.
 113 .TP
 114 .B \-?
 115 Print a list of valid commandline options and then exit.
 116 .SH "CONFIGURATION FILE"
 117 When started
 118 .B whois++d
 119 reads it's configuration file before processing any command line options.
 120 The configuration commands that may be included in this tailor file are
 121 .IP banner
 122 Specify a file to display as a welcome message.
 123 .IP base
 124 This specifies the entry within the DIT where searches will commence. This is
 125 normally set to the organisation's entry.
 126 .IP configdir
 127 Identifies where the configuration files may be found, currently only used
 128 for the template descriptions.
 129 .IP contact
 130 This is the distinguished name of the person responsible for this service, and
 131 whose entry will be displayed if the client uses the `describe' query. If this
 132 is not defined in the configuration file it defaults to the DSA manager.
 133 .IP helpdir
 134 This directory contains the multi-lingual help files. There should be a
 135 subdirectory for each language supported and within these subdirectories
 136 are helpfiles that are displayed by the server. At a minimum there should be
 137 an english directory containing a `general' helpfile (which contains
 138 introductory information).
 139 .IP hostname
 140 Used when the server is queried using the `describe' command. If not specified
 141 it will default to the local hostname.
 142 .IP language
 143 Specify the default language to be used when producing diagnostic messages.
 144 .IP ldaphost
 145 This specifies the host running a ldap server which can be used to communicate
 146 with the X.500 DSA.
 147 .IP password
 148 The password to use then binding to the X.500 DSA.
 149 .IP template
 150 The whois++ template name is not always the same as the X.500 object class
 151 so this option allows the two values to be associated with each other. The
 152 two values are template-name and objectclass-name.
 153 .IP user
 154 The LDAP distinguished name of the user to use when binding to the directory.
 155 This is optional but the DSA may restrict the information available to the
 156 whois++ server unless it authenticates itself.
 157 .NT
 158 Multi-lingual support is not available yet.
 159 .SH FILES
 160 ETCDIR/whois++dtailor   whois++ server tailor file
 161 .SH "SEE ALSO"
 162 ldapd(8)