MKCACHE(1)               USER COMMANDS                 MKCACHE(1)



NAME
     mkcache - GN cache file maker

SYNOPSIS
     mkcache [-r] [-d dir] [-m menu] [-c  cache]  [-h  host]  [-p
     port]

DESCRIPTION
     Mkcache is a part of the gn package.  GN provides  a  server
     for  the  internet  gopher protocol and HTTP, the Hyper Text
     Transfer Protocol (gopher is a registered trademark  of  the
     University of Minnesota).

     When invoked with no arguments mkcache looks in the  current
     directory for a file called menu in a format described below
     and produces a file in the current directory  called  .cache
     which is suitable for distribution by the gn server.

     Mkcache Options

     The following options are accepted by mkcache:

     -d directory
          Look for the menu file  in  directory  and  create  the
          .cache file there.

     -r   For any items in the menu file which correspond to sub-
          directories  of  the  current  directory,  look in that
          directory for another menu  file  and  produce  another
          .cache  file  in this subdirectory.  Continue this pro-
          cess recursively through the directory tree  below  the
          current  directory  or the directory specified with the
          -d option.
          A word of warning:  the use of the  -r  option  assumes
          that  your  gopher  hierarchy is a tree compatible with
          the file system.  Thus if the  menu  file  contains  an
          item  which is a directory (type 1) but not a subdirec-
          tory of the directory containing the current directory,
          this  directory  will  not  be  processed  by  mkcache.
          Instead a warning message will be printed.  The  reason
          for  this  is  that  an  arbitrary  graph  of menu file
          entries can contain cycles and attempting to follow all
          directory items could easily end in an infinite loop.

     -m menuname
          Use menuname as the name for the menu file rather  than
          the default, menu.

     -c cachename
          Use cachename as the name for  the  cache  file  rather
          than the default, .cache.



Sun Release 4.1    Last change: 1993 Sept 8                     1






MKCACHE(1)               USER COMMANDS                 MKCACHE(1)



     -h host
          Make host the default host  name  for  the  server.   A
          fully  qualified host name (e.g. machine.dept.univ.edu)
          should be used.

     -p port
          Use port as the default port for this server.   If  not
          specified the value of 70 is used.  This number must be
          the same as the port used by the gn server.

     The format of the menu file is like  that  of  a  .links  or
     .names file for the Minnesota gopherd server. It consists of
     a group of lines for each item you want to  appear  in  your
     menu.   The  first  item labeled Name is what will appear on
     the client's menu.  It must be the first line of a group.  A
     sample group might be
          Name=Information about Mathematics
          Type=0  #Type 0 is a file
          Path=0/data_root/dir1/dir2/mathfile
          Host=math.univ.edu
          Port=1234
     The symbol # begins comments.  Lines which do not start with
     the  keywords  Name,  Type, Path, Host, Port, or a few other
     keywords, are ignored.  The Name line must be the first in a
     group, but the others can be in any order.  There is no Numb
     field.  Items will appear on the  menu  in  the  same  order
     their groups appear in the menu file.


     There several special types of entries in a menu file.  They
     are  items  whose  path starts with "7c", (which represent a
     search of gn menus,  and those which start with "1m" or "7m"
     which  represent  a structured file and a search of a struc-
     tured file respectively.  A structured file is  one  with  a
     number of sections which will be displayed with each section
     having its own menu item as if each section were a  separate
     file.   For  information  on  how  to use the 7c, 1m, and 7m
     types see the Installation and Maintenance guide  (the  file
     docs/Install)  in  the  gn distribution.  This document also
     explains how to include HTML documents in menus.


UNRESTRICTIONS
     Mkcache is free; anyone may redistribute  copies  to  anyone
     under  the  terms  stated  in the Free Software Foundation's
     General Public License, a copy of which accompanies  the  gn
     software package.

     The author encourages you to improve and extend gn.





Sun Release 4.1    Last change: 1993 Sept 8                     2






MKCACHE(1)               USER COMMANDS                 MKCACHE(1)



AUTHOR
     Mkcache was written by John Franks,  Dept.  of  Mathematics,
     Northwestern University (john@math.nwu.edu).




















































Sun Release 4.1    Last change: 1993 Sept 8                     3



.