Ubuntu Manpage: PyGopherd - Multiprotocol Information Server

Provided by: pygopherd_3.0.0~git20221126.02c65d60-5_all

NAME

       PyGopherd - Multiprotocol Information Server

SYNOPSIS

       pygopherd [ configfile ]

DESCRIPTION

       Welcome  to  PyGopherd.   In  a  nutshell,  PyGopherd  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.

QUICK START

       If  you  have already installed PyGopherd system-wide, or your administrator has done that
       for you, your task for setting up PyGopherd for the first time is quite simple.  You  just
       need to set up your configuration file, make your folder directory, and run it!

       You  can  quickly  set up your configuration file.  The distribution includes two files of
       interest:  conf/pygopherd.conf  and  conf/mime.types.   Debian   users   will   find   the
       configuration  file pre-installed in /etc/pygopherd/pygopherd.conf and the mime.types file
       provided by the system already.

       Open up pygopherd.conf 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: detach, pidfile, port, usechroot, setuid, setgid, and root.  These may or may not
       work at their defaults for you.  The remaining ones should be fine for a basic setup.

       Invoke  PyGopherd  with  pygopherd  path/to/configfile  (or /etc/init.d/pygopherd start on
       Debian).  Place some files in the location specified by the root directive in  the  config
       file and you're ready to run!

OPTIONS

       All  PyGopherd  configuratoin  is done via the configuration file.  Therefore, the program
       has only one command-line option:

       configfile
              This option  argument  specifies  the  location  of  the  configuration  file  that
              PyGopherd is to use.

CONFORMING TO

• The Internet Gopher Protocol as specified in RFC1436

• 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>.

• 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>.

• 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>.

• 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.

• The PYG format for extensible Python gopher objects as created for PyGopherd.

• Hypertext Transfer Protocol HTTP/1.0 as specified in RFC1945

• Hypertext Markup Language (HTML) 3.2 and 4.0 Transitional as specified in RFC1866 and
RFC2854.

• Maildir as specified in
<URL:http://www.qmail.org/qmail-manual-html/man5/maildir.html> and
<URL:http://cr.yp.to/proto/maildir.html>.

• The mbox mail storage format as specified in
<URL:http://www.qmail.org/qmail-manual-html/man5/mbox.html>.

• Registered MIME media types as specified in RFC2048.

• 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.

• Standard Python 2.2.1 or above as implemented on POSIX-compliant systems.

• WAP/WML as defined by the WAP Forum.

BUGS

       Reports  of  bugs  should  be  sent  via  e-mail  to  the  PyGopherd  issue   tracker   at
       <URL:https://github.com/michael-lazar/pygopherd/issues>.

       The  Web  site also lists all current bugs, where you can check their status or contribute
       to fixing them.

COPYRIGHT

       PyGopherd is Copyright (C) 2002-2019 John Goerzen, 2021 Michael Lazar.

       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.

       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.

       You should have received a copy of the GNU General Public License along with this program;
       if not, write to:

       Free Software Foundation, Inc.
       59 Temple Place
       Suite 330
       Boston, MA  02111-1307
       USA

AUTHOR

       PyGopherd,  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.

       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:

       Copyright (C) 1991-2000  University of Minnesota
       Copyright (C) 2000-2002  John Goerzen and other developers

       PyGopherd may be downloaded, and information found, from its homepage:

        <URL:https://github.com/michael-lazar/pygopherd>