.TH GEE 1 local
.SH NAME
gee \- gopher environment editor
.SH SYNOPSIS
.B gee 
[
.BI \-t " toplevel directory"
] [
.BI \-p " port number"
] [
.BI \-l " link file name"
] [
.BI \-g " index file name"
] 
.SH DESCRIPTION
.I Gee
is an interface which allows easy inspection and modification of the
.IR gopher (1)
archive environment (burrow).  Both files, and all descriptors
including links, and .cap files may be modified with
.I gee.
.I Gee
implements a paged display, and displays files one directory at a time.
.PP
.I Gee
is compatible with most older gopher servers (version 1.1-12), and 
should work ok with the gopher+ descriptors too.  It does not work
with
.IR gn (1)
descriptors, but could be made to.
.PP
.I Gee
is written entirely in 
.B PERL
and may be modified to perform other useful tasks.


.SS OPTIONS
All options may be permanently configured by editing gee.
.PP
.TP
.B \-t " toplevel directory"
.br
.ns
.PP
Specify the toplevel archive directory for
.I gee
to work within.  
.TP
.B \-p " port number"
.br
.ns
.PP
Specify the default port number for gee to consider for 
creation of new file descriptors.  Default port is 70.
.TP
.B \-l " linkfile name"
.br
.ns
.PP
Specify the name of the link file for remote links,
or all links, with gopher+.  Default is .names.
.TP
.B \-g " index directory filename"
.br
.ns
.PP
Specify the name of the dbm file which contains a listing 
of the directories in the archive. Used by the internal function 
which allows simple directory changes to any archive directory.
.SS  " HOW IT WORKS"
.PP
Upon startup,
.I gee
looks for several environment variables, and sets the default
mechanisms for editing, via the EDITOR environment variable,
and for paging files, via the PAGER environment variable.  Also
allowed are the GOPHERTREE environment variable, for specifying
the toplevel directory, and the GOPHERCONFIG environment variable,
to specify the path to the gopherd.conf file.
.PP
Then 
.I gee
queries the user as to whether to re\-index the directories
in the archive, if that option has been configured into the program.
After choosing a starting directory, and changing to that directory,
.I gee
displays the files therein, according to the name, type, host, path,
port, and status.
.PP
Once the items in the starting directory are displayed, the user has 
the following options, which are selected by pressing the appropriate 
key, followed by a <CR> :
.PP
.TP
.B \[number\] " view item stat info and .cap/.link/.name info, if any"
.TP
.B c          " change to directory [number or use directory selector index]"
.TP
.B u          " change to parent directory"
.TP
.B h          " This help section"
.TP
.B n          " make a new entry (edit a template in your favourite editor)"
.TP
.B f          " forward page or same page at end"
.TP
.B b          " back a page or same page at beginning"
.TP
.B q          " quit"
.TP
.B !command   " execute command in current dir"
.PP
When the stat and descriptor info is displayed for a given item,
the user may choose from the following options to make changes or
take other actions on the item, again by selecting the appropriate key:
.PP
.B d   " delete this file from the archive"
.TP
.B e   " change/create displayed info for this item"
.TP
.B h   " This help section"
.TP
.B v   " view this file"
.TP
.B m   " mv, cp, or ln this file somewhere else [use dir list]"
.PP

that item, via editing the descriptor, or to the item itself.  There is
also a help page, for easy reference.
.PP
At the main menu of items
One can also change to a parent/child directory, or any directory in
the archive, if using the indexing option.  
.SH FILES
gopherd.conf  
.SH SEE ALSO
The
.IR " README"
included in the package.