.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "PYGOPHERD" "8" "26 November 2022" "John Goerzen" "PyGopherd Manpage"

.SH NAME
PyGopherd \- Multiprotocol Information Server
.SH SYNOPSIS

\fBpygopherd\fR [ \fB\fIconfigfile\fB\fR ]

.SH "DESCRIPTION"
.PP
Welcome to \fBPyGopherd\fR\&.  In a nutshell, \fBPyGopherd\fR
is a modern dynamic
multi-protocol hierarchical information server with a pluggable
modularized extension system, 
full flexible caching, virtual files and
folders, and autodetection of file types -- all with support for
standardized yet extensible per-document metadata. Whew! Read on for
information on this what all these buzzwords mean.
.SH "QUICK START"
.PP
If you have already installed \fBPyGopherd\fR system-wide, or your
administrator has done that for you, your task for setting up
\fBPyGopherd\fR for the first time is quite simple.  You just need
to set up your configuration file, make your folder directory,
and run it!
.PP
You can quickly set up your configuration file.  The
distribution includes two files of interest:
\fIconf/pygopherd.conf\fR and
\fIconf/mime.types\fR\&.  Debian users will find
the configuration file pre-installed in
\fI/etc/pygopherd/pygopherd.conf\fR and the
\fImime.types\fR file provided by the system
already.
.PP
Open up \fIpygopherd.conf\fR in your editor and
adjust to suit.  The file is heavily commented and you can
refer to it for detailed information.  Some settings to take a
look at include: \fIdetach\fR,
\fIpidfile\fR, \fIport\fR, 
\fIusechroot\fR, \fIsetuid\fR,
\fIsetgid\fR, and \fIroot\fR\&.
These may or may not work at their defaults for you.  The
remaining ones should be fine for a basic setup.
.PP
Invoke \fBPyGopherd\fR with \fBpygopherd
path/to/configfile\fR (or
\fB/etc/init.d/pygopherd start\fR on Debian).
Place some files in the location specified by the
\fIroot\fR directive in the config file and
you're ready to run!
.SH "OPTIONS"
.PP
All \fBPyGopherd\fR configuratoin is done via the configuration
file.  Therefore, the program has only one command-line
option:
.TP
\fB\fIconfigfile\fB\fR
This option argument specifies the location
of the configuration file that \fBPyGopherd\fR is to use.
.SH "CONFORMING TO"
.TP 0.2i
\(bu
The Internet Gopher Protocol as specified in RFC1436
.TP 0.2i
\(bu
The Gopher+ upward-compatible enhancements to the Internet Gopher
Protocol from the University of Minnesota as laid out at
 <URL:gopher://gopher.quux.org/0/Archives/mirrors/boombox.micro.umn.edu/pub/gopher/gopher_protocol/Gopher+/Gopher+.txt>\&.
.TP 0.2i
\(bu
The gophermap file format as originally implemented in the
Bucktooth gopher server and described at
 <URL:gopher://gopher.floodgap.com/0/buck/dbrowse%3Ffaquse%201>\&.
.TP 0.2i
\(bu
The Links to URL specification as laid out by John Goerzen
at
 <URL:gopher://gopher.quux.org/0/Archives/Mailing%20Lists/gopher/gopher.2002-02%3f/MBOX-MESSAGE/34>\&.
.TP 0.2i
\(bu
The UMN format for specifying object attributes and links
with .cap, .Links, .abstract, and similar files as specified elsewhere
in this document and implemented by UMN gopherd.
.TP 0.2i
\(bu
The PYG format for extensible Python gopher objects as created for
\fBPyGopherd\fR\&.
.TP 0.2i
\(bu
Hypertext Transfer Protocol HTTP/1.0 as specified in
RFC1945
.TP 0.2i
\(bu
Hypertext Markup Language (HTML) 3.2 and 4.0
Transitional as specified in RFC1866 and RFC2854.
.TP 0.2i
\(bu
Maildir as specified in
 <URL:http://www.qmail.org/qmail-manual-html/man5/maildir.html> and
 <URL:http://cr.yp.to/proto/maildir.html>\&.
.TP 0.2i
\(bu
The mbox mail storage format as specified in
 <URL:http://www.qmail.org/qmail-manual-html/man5/mbox.html>\&.
.TP 0.2i
\(bu
Registered MIME media types as specified in RFC2048.
.TP 0.2i
\(bu
Script execution conforming to both UMN standards as laid out in UMN
gopherd(1) and Bucktooth standards as specified at
 <URL:gopher://gopher.floodgap.com:70/0/buck/dbrowse%3ffaquse%202>, 
so far as each can be implemented consistent with secure
design principles.
.TP 0.2i
\(bu
Standard Python 2.2.1 or above as implemented on
POSIX-compliant systems.
.TP 0.2i
\(bu
WAP/WML as defined by the WAP Forum.
.SH "BUGS"
.PP
Reports of bugs should be sent via e-mail to the \fBPyGopherd\fR issue tracker
at  <URL:https://github.com/michael-lazar/pygopherd/issues>\&.
.PP
The Web site also lists all current bugs, where you can check their
status or contribute to fixing them.
.SH "COPYRIGHT"
.PP
\fBPyGopherd\fR is Copyright (C) 2002-2019 John Goerzen, 2021 Michael Lazar.
.PP
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; version 2 of the
License.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to:

.nf
Free Software Foundation, Inc.
59 Temple Place
Suite 330
Boston, MA  02111-1307
USA
      
.fi
.SH "AUTHOR"
.PP
\fBPyGopherd\fR, its libraries, documentation, and all included
files (except where noted) was written by John Goerzen
<jgoerzen@complete.org>
and copyright is held as stated in the
Copyright section.
.PP
Portions of this manual (specifically relating to certian UMN gopherd
features and characteristics that PyGopherd emulates) are modified
versions of the original
gopherd(1) manpage accompanying the UMN gopher distribution.  That
document is distributed under the same terms as this, and
bears the following copyright notices:

.nf
Copyright (C) 1991-2000  University of Minnesota
Copyright (C) 2000-2002  John Goerzen and other developers
      
.fi
.PP
\fBPyGopherd\fR may be downloaded, and information found, from its
homepage:
.PP
 <URL:https://github.com/michael-lazar/pygopherd>
.PP
.SH "SEE ALSO"
.PP
python (1).