[4mPYGOPHERD[24m(8)                   PyGopherd Manpage                  [4mPYGOPHERD[24m(8)

[1mNAME[0m
       PyGopherd - Multiprotocol Information Server

[1mSYNOPSIS[0m
       [1mpygopherd [22m[ [4mconfigfile[24m ]


[1mDESCRIPTION[0m
       Welcome  to  [1mPyGopherd[22m.   In  a nutshell, [1mPyGopherd [22mis a modern dynamic
       multi-protocol hierarchical information server with a  pluggable  modu-
       larized  extension  system,  full  flexible  caching, virtual files and
       folders, and autodetection of file types -- all with support for  stan-
       dardized yet extensible per-document metadata. Whew! Read on for infor-
       mation on this what all these buzzwords mean.

[1mQUICK START[0m
       If  you  have already installed [1mPyGopherd [22msystem-wide, or your adminis-
       trator has done that for you, your task for setting  up  [1mPyGopherd  [22mfor
       the  first time is quite simple.  You just need to set up your configu-
       ration file, make your folder directory, and run it!

       You can quickly set up your configuration file.  The  distribution  in-
       cludes  two files of interest: [4mconf/pygopherd.conf[24m and [4mconf/mime.types[24m.
       Debian users will find the configuration file pre-installed in [4m/etc/py-[0m
       [4mgopherd/pygopherd.conf[24m and the [4mmime.types[24m file provided by  the  system
       already.

       Open  up [4mpygopherd.conf[24m 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: [4mdetach[24m, [4mpidfile[24m, [4mport[24m, [4musech-[0m
       [4mroot[24m, [4msetuid[24m, [4msetgid[24m, and [4mroot[24m.  These may or may not work at their de-
       faults for you.  The remaining ones should be fine for a basic setup.

       Invoke [1mPyGopherd [22mwith [1mpygopherd path/to/configfile [22m(or  [1m/etc/init.d/py-[0m
       [1mgopherd  start  [22mon Debian).  Place some files in the location specified
       by the [4mroot[24m directive in the config file and you're ready to run!

[1mOPTIONS[0m
       All [1mPyGopherd [22mconfiguratoin is done via the configuration file.  There-
       fore, the program has only one command-line option:

       [4mconfigfile[0m
              This option argument specifies the location of the configuration
              file that [1mPyGopherd [22mis to use.

[1mCONFORMING TO[0m
       +o The Internet Gopher Protocol as specified in RFC1436

       +o 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.mi-
         cro.umn.edu/pub/gopher/gopher_protocol/Gopher+/Gopher+.txt>.

       +o 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>.

       +o The Links to URL specification as laid out by John Goerzen at
          <URL:gopher://gopher.quux.org/0/Archives/Mailing%20Lists/gopher/go-
         pher.2002-02%3f/MBOX-MESSAGE/34>.

       +o 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.

       +o The PYG format for extensible Python gopher objects  as  created  for
         [1mPyGopherd[22m.

       +o Hypertext Transfer Protocol HTTP/1.0 as specified in RFC1945

       +o Hypertext  Markup  Language (HTML) 3.2 and 4.0 Transitional as speci-
         fied in RFC1866 and RFC2854.

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

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

       +o Registered MIME media types as specified in RFC2048.

       +o 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 prin-
         ciples.

       +o Standard Python 2.2.1 or above as implemented on POSIX-compliant sys-
         tems.

       +o WAP/WML as defined by the WAP Forum.

[1mBUGS[0m
       Reports  of  bugs  should  be  sent  via  e-mail to the [1mPyGopherd [22missue
       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.

[1mCOPYRIGHT[0m
       [1mPyGopherd [22mis 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 MER-
       CHANTABILITY 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


[1mAUTHOR[0m
       [1mPyGopherd[22m, 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 ver-
       sions  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


       [1mPyGopherd [22mmay be downloaded, and information found, from its homepage:

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

[1mSEE ALSO[0m
       python (1).

JohGoerze                  1Novembe202                   4mPYGOPHER24)
