================================
INFORMATION ON "gophermap" FILES
================================

A gophermap file is a means of defining menus for gopher content.  The
gophermap provides a virtual view of the content available allowing one
to rename files, hide them, or even link to content on other servers.


---------------------
gophermap File Format
---------------------

The gophermap file consists of zero or more lines that can be one of
the following types:


** Comment lines:

Comment lines contain plaintext without any tabs. These are sent
unchanged to the client and can be used for descriptions or for welcome
banners.


** Selector lines:

Selector lines are tab-delimited records that specify all the
information a gopher client needs to retrieve the particular resource
including the itemtype, display string, server, and port, in the
following format:

<Type><Name>    <Path>  <Host>  <Port>

Fields are separated by a single tab character.

<Type> is a single character that can be one of the following types.

* 0 = plain text file
* 1 = directory menu listing
* 2 = CSO search query
* 3 = error message
* 4 = BinHex encoded text file
* 5 = binary archive file
* 6 = UUEncoded text file
* 7 = search engine query
* 8 = telnet session pointer
* 9 = binary file
* g = Graphics file format, primarily a GIF file
* h = HTML file
* i = informational message
* s = Audio file format, primarily a WAV file

Example:

1Floodgap Gopher server /home   gopher.floodgap.com     70

The above selector line generates a link to the "/home" selector on
server gopher.floodgap.com, port 70 with an itemtype of 1 and a display
string of "Floodgap Gopher server".

Some fields can be omitted in some situations:

* If you don't specify a port, the server provides the one your server
  is using (almost always 70).
* If you don't specify a host, you link within the current server.
* If you don't specify a path, you link to the root of the server.
* If you only specify a relative selector and not an absolute path,
  the server prepends the path they're browsing.

In order to link to another protocol, <Path> should contain "URL:"
followed by the target URL.  The <Host> and <Port> fields should be
omitted.  For example:

hGoogle home page       URL:http://www.google.com



--
This document is licensed under the GNU Free Documentation License.
It uses material from the Wikipedia articles "Gopher" and "Gophermap":
http://en.wikipedia.org/wiki/Gopher
http://en.wikipedia.org/wiki/Gophermap