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

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