O U T L I N E   O F   D O C U M E N T A T I O N

  % DOS.DOC - Waffle/DOS Installation and Reference Manual

	     I   Installing the DOS Version
	    II   Setting up the Modem
	   III   Troubleshooting Under DOS
	    IV   The Scheduler
	     V   Function Keys & Terminal
            VI   Support for FAX
             V   Multitasking and LAN's

  % EXTERN.DOC - External Programs

             I   The extern directory
            II   Format of the extern files
           III   Contents of _system file
            IV   Sample entries of _system file
             V   _send and _receive
            VI   Configuring external editors
           VII   Substitions in the /command= line
          VIII   Making external programs available to users
            IX   Aliasing Waffle commands
             X   Notes and caveats

  % FILES.DOC - Transfer Section Manual

             I   About the FILES section
            II   Setting up the FILES section
           III   Support files
            IV   Format of DIRS file
             V   The ARCLIST Program
            VI   Additional Information

  % FORUM.DOC - Forum Configuration Manual

	     I   Forum Configuration Files
	    II   A Sample Configuration File

  % FUTURE.DOC - Future Enhancements Planned

        A "wish list" of possible features we are
        contemplating for future versions of Waffle.

  % HISTORY.DOC - Past Enhancements

	Previous enhancements to the WAFFLE.EXE
        program, version 1.59 to present day.

  % INTRO.DOC - An Introduction to the Network

	     I   Introduction
	    II   Finding a Connection
	   III   Get in a Domain - optional
	    IV   Mail to Outside Networks
	     V   Further Information

  % LEGAL.DOC - Legal Information

        No warranty with this software. Also information
        on licensing and trademark credits.

  % MANUAL.DOC - Sysop & Configuration Manual

             I   Maintenance
            II   Privileged Commands
           III   Accounts
            IV   Electronic Mail
             V   Additional
            VI   Turning Things Off

  % NETWORK.DOC - Waffle/DOS Networking Manual

                 ( Introduction )

             I   Quick Overview
            II   Setting up your system
           III   Functions of the Networking Programs
             V   Directories Used

                 ( The UUCICO Program )

            VI   UUCICO command line options
           VII   Format of the systems file
          VIII   Format of the dialers file
            IX   Format of the scripts file
             X   Valid time entries
            XI   Configuration of expect/send sequences
           XII   Running UUCICO in master role - dialing out
          XIII   Running UUCICO in slave role - answering
           XIV   UUCP error messages
            XV   Tunable parameters in the static file

                 ( Support Programs )

           XVI   Using UUCP to transfer files
          XVII   The UUX program - sending execution requests
         XVIII   The UUXQT program - processing incoming jobs
           XIX   Inspecting the spool queue with UUQ

                 ( Miscellaneous )

            XX   Logging and debug levels
           XXI   The PERMITS file
          XXII   Beyond mail and news
         XXIII   Grades
          XXIV   Waffle's filename munging
           XXV   Setting nonstandard packet sizes
            XV   Limitations and paranoia

  % NNTP.DOC - Using Waffle with the NNTP protocol

             I   Getting Unix Waffle running with NNTP
            II   Getting DOS Waffle running with NNTP
           III   Compiling the DOS NNTP code
            IV   Caveats using the DOS NNTP code

  % REGISTER.DOC - Registration information

        A "print me" for containing registration and
        ordering information, and our address.

  % RMAIL.DOC - Waffle/DOS Mail Facilities

	     I   General Information about RMAIL
	    II   About the PATHS File
	   III   Gatewaying to another network
	    IV   Transferring mail by an alternate method

  % RNEWS.DOC - Waffle/DOS Usenet Facilities

	     I   Introduction
	    II   Receiving a Newsfeed
	   III   Posting News
	    IV   Giving Someone a Newsfeed
	     V   Compression
	    VI   Gatewaying and Coexisting

  % ROADMAP.DOC - What all the files are

        Contains information on all files used by Waffle,
        and also pointers to other parts of the documention.

  % STATIC.DOC - Waffle Static File Configuration

	     I   Hardware and Modem
	    II   Node and Nodename
	   III   Message Headers
	    IV   Login and Console
	     V   Transfer Section
	    VI   Miscellaneous Parameters
	   VII   Exit Codes
	  VIII   Forum Configuration
	    IX   Prompts
	     X   Access Control
	    XI   Directories
	   XII   Percent Variables

  % STATS.DOC - DOS Usenet statistics information

             I  STATS giving disk usage
            II  ARBITRON standard Usenet report
           III  OVER [size] - find large news articles
            IV  USAGE - Join file usage report

  % SYSMAN.DOC - Password file management utility

             I   CREATE a new password file
            II   CHECK consistency of password file
           III   CLEAN old directories
            IV   CRUNCH unused entries in password file
             V   EXPORT to ascii DB file
            VI   FIND an account in password file
           VII   INDEX the password file
          VIII   LIST contents of password file
            IX   PURGE old accounts
             X   RETIRE old files in user directories

  % TELEBIT.DOC - DOS Telebit Information

        Settings for various Telebit modems.

  % THIRD.DOC - Third Party Products
 
        Packages by other parties available for
        use with Waffle.

  % UNIX.DOC - Unix Installation Manual

	     I   Installing the UNIX Version
	    II   Waffle and the Usenet News Network
	   III   Interfacing with the UUCP Mail System
	    IV   Troubleshooting Under Unix
	     V   Miscellaneous

  % UPDATE.DOC - Update Instructions

        Update instructions if you are replacing
        your older version of Waffle with this one.

  % USER.DOC - User's Guide

	     I   Quick Summary of Commands
	    II   Detailed Command Descriptions
	   III   Input and Output
	    IV   Line Editor
	     V   User Directories


F I L E   S T R U C T U R E

% /WAFFLE/ADMIN

  Contains various logfiles and the Waffle password file.

  admin/bounces		Bounced network mail - DOS
  admin/callers		List of callers to system
  admin/control		Log of Usenet control messages - DOS
  admin/cron		Log of CRON invokations - DOS
  admin/errors		Errors detected during operation
  admin/events		Interesting Events Logfile
  admin/extern		External program logfile (with /log option)
  admin/index		An index to the password file
  admin/logfail		Login failures or breakin attempts
  admin/mail		Log of network mail - DOS
  admin/net		UUCP connections made - DOS
  admin/password	Password file (accounts)
  admin/requests	New user applications
  admin/traffic		Summary of UUCP traffic - DOS
  admin/transfer	File transfer log
  admin/uucico          Detailed UUCP logfile - DOS
  admin/uulog           Log showing UUCP transfer - DOS

% /WAFFLE/BIN

  Executables and batch or shell files should be kept
  in this directory. The DOS version contains

  bin/login.bat		Login to Waffle locally
  bin/poll.bat		Poll neighboring sites
  bin/run.bat		Run Waffle as a BBS
  bin/uushell.bat	Batch file for incoming UUCP connections

  bin/arclist.exe       List directories of archive files
  bin/batch.exe		News Batcher for newsfeeds
  bin/comp16.exe        A 16 bit compress
  bin/compress.exe	Compression program
  bin/convpw.exe        Convert 1.64 password file to 1.65 format
  bin/makebox.exe       Build index files for mailboxes
  bin/rmail.exe		Low level Mail interface
  bin/rnews.exe		Low level News interface
  bin/stats.exe         Print newsgroup statistics
  bin/sysman.exe        Password file management utility
  bin/uucico.exe	Connect to a remote site with UUCP protocol
  bin/uucp.exe		Binary file transfer program
  bin/uuq.exe		Inspect outgoing queue
  bin/uux.exe		Run programs remotely on Unix system
  bin/uuxqt.exe		Processes incoming news or mail
  bin/waffle.exe	News & Mail reader

% /WAFFLE/DOCS

  Documentation for the Waffle system.

% /WAFFLE/HELP
% /WAFFLE/INFO

  Files displayed for the HELP and INFO commands.

% /WAFFLE/EXTERN

  Configuration directory for dealing with external programs,
  or "doors" as they are sometimes called.

  extern/_editors	External editors
  extern/_receive	Protocols for uploading
  extern/_send		Protocols for downloading
  extern/_system	Interface to system programs

% /WAFFLE/MENUS

  Menus relating to Waffle operation, in ASCII text format.

  menus/admin		Menu for ADMIN command
  menus/areas		FILES section areas
  menus/browse          Menu for hotkey SCAN command
  menus/console		Help at Awaiting Ring - DOS
  menus/edit		Editor Menu
  menus/editors		External Editors Available
  menus/files		FILES command menu
  menus/join		Menu for JOIN command
  menus/local		F1 help display - DOS
  menus/mail		Menu within MAIL command
  menus/main		Toplevel ? menu
  menus/more		Selection at [more] prompt
  menus/prejoin		Menu upon first invokation of JOIN
  menus/protocol	Protocols available
  menus/terminal	Menu for TERM command
  menus/scan		Within READ or NEW commands

% /WAFFLE/SYSTEM

  Configuration files, and files dealing with networking.

  system/aliases	Mail aliases & mailing lists
  system/cookies	COOKIE database
  system/data		System data (calls, last caller)
  system/dirs		List of Directories in FILES section
  system/feeds		Newsfeed file - DOS
  system/journal	The JOURNAL - J command
  system/local		Local forum configuration file
  system/refuse		List of Disallowed callers
  system/schedule	CRON scheduler datafile - DOS
  system/sig            Systemwide default signature file
  system/signup		Newuser questionnaire
  system/stamp		Time stamp for CRON scheduler - DOS
  system/static		Main Waffle Configuration File
  system/usenet		Usenet Forum Configuration File
  system/validate       List of users that haven't been validated
  system/zippy		ZiPPY Database for Pinheads

% /WAFFLE/TEXT

  Banners or notices displayed by Waffle at various times.

  text/change           Notice for account changes
  text/chat             Message for CHAT request
  text/entry            Message displayed before Login
  text/excuse           CHAT excuse
  text/failed           Login failure message, before termination
  text/feedback         FEEDBACK banner
  text/files            FILES section banner
  text/logout           BYE message
  text/logfail          Third login failure message, before hangup
  text/loghelp          Login help for the confused
  text/logwarn          Login failure warning, for bad password
  text/master           Banner for MASTER in FILES section
  text/moderate         Moderated newsgroup notification message
  text/newusers         Newuser Notice
  text/shoo             F4 kickoff message - DOS
  text/status           Display for STATUS command
  text/time             Time used up message
  text/trumpet          Displayed on entry to CHAT - DOS
  text/unfiles          Shown when access denied to FILES section
  text/welcome          WELCOME message

% /WAFFLE/UUCP

  uucp/dialers          Connection scripts for modems - DOS
  uucp/paths            UUCP Mail Routing - DOS
  uucp/permits          Permissions for remote dialins - DOS
  uucp/scripts          Connection scripts for login - DOS
  uucp/sequence         Sequence number for UUCP jobs - DOS
  uucp/systems          UUCP neighbors & scripts - DOS

% /WAFFLE/WORDS

  Directory containing short files that are treated as
  commands. These will be displayed when the word corresponding
  to the filename is entered at the main Waffle prompt.

--

"It is a great tragedy of history that computer programmers are
allowed to write their own docs. You are reading proof of this fact."

dell@vox.darkside.com
(C) Copyright 1992 Darkside Int'l
