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

   1 .TH GO500GW 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 go500gw \- General Gopher to X.500 gateway for browsing and searching
   7 .SH SYNOPSIS
   8 .B LIBEXECDIR/go500gw [\-a] [\-d level] [\-f filterfile]
   9 .B [\-t templatefile] [\-c rdncount]
  10 .B [\-h helpfile] [\-l] [\-p listenport]
  11 .B [\-P ldapport] [\-x ldaphost] [\-I]
  12 .SH DESCRIPTION
  13 .B go500gw
  14 is the general gopher to X.500 browsing and search gateway daemon.
  15 It speaks gopher on one side and X.500 (via LDAP)
  16 on the other.  It presents the X.500 DIT as a tree of menus,
  17 search items, and documents in gopher space, supporting both
  18 browsing and searching of X.500 via a gopher client.  By default,
  19 it listens on port 7777 for connections from gopher clients.
  20 .LP
  21 The
  22 .B go500gw
  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 go500gw
  29 as a stand-alone server, simply start it with no arguments
  30 .LP
  31 .nf
  32 .ft tt
  33         LIBEXECDIR/go500gw
  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 .BR /etc/rc.local (5)
  40 or equivalent file:
  41 .LP
  42 .nf
  43 .ft tt
  44         if [ -f LIBEXECDIR/go500gw ]; then
  45                 LIBEXECDIR/go500gw; echo ' go500gw'
  46         fi
  47 .ft
  48 .fi
  49 .SH OPERATION WITH INETD
  50 To arrange to have
  51 .B go500gw
  52 started from
  53 .BR inetd (8), the Internet protocol
  54 daemon, add a line like the following to your
  55 .BR /etc/services (5)
  56 file, or the equivalent:
  57 .LP
  58 .nf
  59 .ft tt
  60     go500gw           7777/tcp        go500gw
  61 .ft
  62 .fi
  63 .LP
  64 Next, add a line like this to your
  65 .BR /etc/inetd.conf (5)
  66 file, or the equivalent:
  67 .LP
  68 .nf
  69 .ft tt
  70     go500gw  stream  tcp  nowait  nobody  LIBEXECDIR/go500gw    go500gw -I
  71 .ft
  72 .fi
  73 .LP
  74 For these changes to take effect with inetd, you will probably have
  75 to send it it a HUP signal.  See
  76 .BR inetd (8)
  77 for more details.
  78 .SH GOPHER CONFIGURATION
  79 The next step is to configure your local gopher server to have an
  80 entry for
  81 .BR go500gw .
  82 With the standard unix gopher server, this
  83 can be done with a
  84 .B .link
  85 file.  A sample
  86 .B .link
  87 file is given below, with the things you should change given in <>'s:
  88 .LP
  89 .nf
  90 .ft tt
  91         Name=<Label of your choice>
  92         Type=1
  93         Port=7777
  94         Path=1<optional RFC 1779-format DN at which to start browsing>
  95         Host=<host.running.go500gw.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 .SH OPTIONS
 103 .TP
 104 .B \-a
 105 Search aliases when doing LDAP searches.  The default is not to
 106 search aliases.
 107 .TP
 108 .BI \-d " level"
 109 Turn on debugging as defined by
 110 .I level.
 111 If this option is specified,
 112 .B go500gw
 113 will not fork or disassociate from the invoking terminal.  Some general
 114 operation and status messages are printed for any value of \fIlevel\fP.
 115 \fIlevel\fP is taken as a bit string, with each bit corresponding to a
 116 different kind of debugging information.
 117 .TP
 118 .BI \-f " filterfile"
 119 Specify an alternate filter configuration file for use with the
 120 .BR ldap_getfilter (3)
 121 facility, used by
 122 .BR go500gw .
 123 .TP
 124 .BI \-h " helpfile"
 125 Specify an alternate help file.  The help file is what is displayed
 126 in the "About the Gopher to X.500 Gateway" menu item.
 127 .TP
 128 .B \-l
 129 Enable logging of various status and errors to the LOG_LOCAL3 facility via
 130 .BR syslog (8).
 131 .TP
 132 .BI \-p " listenport"
 133 Specify an alternate port on which to listen for connections.
 134 .TP
 135 .BI \-P " ldapport"
 136 Specify an alternate port on which to contact the LDAP server.
 137 .TP
 138 .BI \-t " templatefile"
 139 Specify an alternate template  configuration  file  for
 140 use  with  the
 141 .BI ldap_init_templates (3)
 142 facility, used by
 143 .B go500gw .
 144 .TP
 145 .BI \-c " rdncount"
 146 Specify the number of DN components to show for the names and DN attributes
 147 within entries matching the search.
 148 .TP
 149 .BI \-x " hostname"
 150 Specify an alternate host on which the ldap server is running.
 151 .TP
 152 .B \-I
 153 Run from
 154 .BR inetd (8).
 155 .SH NOTES
 156 Some implementations of inetd have a small limit on the number of arguments
 157 that can be specified in the
 158 .BR /etc/inetd.conf (5)
 159 file.  This can cause
 160 problems if you are using
 161 .B go500gw
 162 with a lot of arguments.
 163 .LP
 164 The default values for most of the things you can specify with
 165 options are configured at compile time in the
 166 .B include/ldapconfig.h.edit
 167 include file.
 168 .SH "SEE ALSO"
 169 .BR ldap (3),
 170 .BR ldap_getfilter (3),
 171 .BR inetd (8),
 172 .BR gopherd (8),
 173 .BR go500 (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.