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

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