git.sur5r.net Git - openldap/blob - doc/man/man8/go500.8

   1 .TH GO500 8C "22 September 1998" "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 go500 \- Local Gopher index search to X.500 search gateway
   7 .SH SYNOPSIS
   8 .B LIBEXECDIR/go500 [\-b searchbase] [\-d level] [\-l]
   9 .B [\-x hostname] [\-c rdncount] [\-f filterfile]
  10 .B [\-t templatefile]
  11 .B [\-p port] [\-I]
  12 .SH DESCRIPTION
  13 .I go500
  14 is the local gopher index search to X.500 search daemon.
  15 It looks like a gopher index server to a gopher
  16 client, translating the search criteria it is given into a
  17 search of a pre-configured portion of the X.500 directory.
  18 It uses LDAP to talk to X.500.  By default, it listens on
  19 port 5555 for connections from gopher clients.
  20 .LP
  21 The
  22 .B go500
  23 server can be run either from
  24 .BR inetd (8)
  25 or as stand-alone server.
  26 .SH STAND-ALONE OPERATION
  27 To start
  28 .B go500
  29 as a stand-alone server, simply start it with no arguments
  30 .LP
  31 .nf
  32 .ft tt
  33         LIBEXECDIR/go500
  34 .ft
  35 .fi
  36 .LP
  37 If you would like to start it at boot time add some lines like this to
  38 the
  39 .B etc/rc.local
  40 or equivalent file:
  41 .LP
  42 .nf
  43 .ft tt
  44         if [ -f LIBEXECDIR/go500 ]; then
  45                 LIBEXECDIR/go500; echo ' go500'
  46         fi
  47 .ft
  48 .fi
  49 .SH OPERATION WITH INETD
  50 To arrange to have
  51 .B go500
  52 started from
  53 .BR inetd (8),
  54 the Internet protocol
  55 daemon, add a line like the following to your
  56 .B /etc/services
  57 file, or the equivalent:
  58 .LP
  59 .nf
  60 .ft tt
  61     go500           5555/tcp        go500
  62 .ft
  63 .fi
  64 .LP
  65 Next, add a line like this to your
  66 .B /etc/inetd.conf
  67 file, or the equivalent:
  68 .LP
  69 .nf
  70 .ft tt
  71     go500   stream  tcp     nowait  nobody  LIBEXECDIR/go500    go500 -I
  72 .ft
  73 .fi
  74 .LP
  75 For these changes to take effect with inetd, you will probably have
  76 to send it it a HUP signal.  See
  77 .BR inetd (8)
  78 for more details.
  79 .SH GOPHER CONFIGURATION
  80 The next step is to configure your local gopher server to have an
  81 entry for
  82 .BR go500 .
  83 With the standard unix gopher server, this
  84 can be done with a
  85 .B .link
  86 file.
  87 A sample
  88 .B .link
  89 file is given below, with the things you should
  90 change given in <>'s:
  91 .LP
  92 .nf
  93 .ft tt
  94         Name=<Label of your choice>
  95         Type=7
  96         Port=5555
  97         Path=
  98         Host=<host.running.go500.here>
  99 .ft
 100 .fi
 101 .LP
 102 You may also have to restart your gopher daemon, or remove the
 103 .B .cache
 104 file.
 105 See
 106 .BR gopherd (8)
 107 for more details.
 108 .SH OPTIONS
 109 .TP
 110 .BI \-b " searchbase"
 111 Specify an alternate starting point for searches.  The argument should
 112 be a Distinguished Name in the form defined by RFC 1485.  For example,
 113 the DN "o=University of Michigan, c=US" could be given to search the
 114 University of Michigan portion of the X.500 tree.
 115 .TP
 116 .BI \-d " level"
 117 Turn on debugging as defined by
 118 .I level.
 119 If this option is specified,
 120 .B go500
 121 will not fork or disassociate from the invoking terminal.  Some general
 122 operation and status messages are printed for any value of \fIlevel\fP.
 123 \fIlevel\fP is taken as a bit string, with each bit corresponding to a
 124 different kind of debugging information.
 125 .TP
 126 .BI \-f " filterfile"
 127 Specify an alternate filter configuration file for use with the
 128 .BR ldap_getfilter (3)
 129 facility, used by
 130 .BR go500 .
 131 .TP
 132 .B \-l
 133 Enable logging of various status and errors to the LOG_LOCAL3 facility via
 134 syslog(8).
 135 .TP
 136 .BI \-p " port"
 137 Specify an alternate port on which to listen for connections.
 138 .TP
 139 .BI \-t " templatefile"
 140 Specify an alternate template  configuration  file  for
 141 use  with  the
 142 .BR ldap_init_templates (3)
 143 facility, used by
 144 .BR go500 .
 145 .TP
 146 .BI \-c " rdncount"
 147 Specify the number of DN components to show for the names and DN attributes
 148 within entries matching the search.
 149 .TP
 150 .BI \-x " hostname"
 151 Specify an alternate host on which the ldap server is running.
 152 .TP
 153 .B \-I
 154 Run from
 155 .BR inetd (8).
 156 .SH NOTES
 157 Some implementations of inetd have a small limit on the number of arguments
 158 that can be specified in the
 159 .BR /etc/inetd.conf (5)
 160 file.  This can cause
 161 problems if you are using
 162 .B go500
 163 with a lot of arguments.
 164 .LP
 165 The default values for most of the things you can specify with
 166 options are configured at compile time in the
 167 .B include/ldapconfig.h.edit
 168 include file.
 169 .SH "SEE ALSO"
 170 .BR ldap (3),
 171 .BR inetd (8),
 172 .BR gopherd (8),
 173 .BR go500gw (8)
 174 .SH ACKNOWLEDGEMENTS
 175 .B      OpenLDAP
 176 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 177 .B      OpenLDAP
 178 is derived from University of Michigan LDAP 3.3 Release.