Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / JCQWK_G3.ZIP / JCQWK.DOC < prev next >

Wrap

Text File | 1994-03-28 | 56.2 KB | 1,298 lines

──┬── ╓──┐ ╓──┐ ╥ ╥ ┬ ╥ ┌ │ ║ ─── ║ │ ║ ║ │ ╟─┴┐ │ ╙──┘ ╙─┼┘ ╙─╨─┘ ╨ ┴ │ Offline Mail Door ╙───┘ Version 2.01Gamma-3 QWK Mail Door for RemoteAccess 2.x Hudson and JAM Messagebases (c) Copyright 1993 Johan Corstjens - JC-TOOLS All rights reserved Documentation by Johan Corstjens & Kief Morris Slightly edited by Mike Ehlert ───────────────────────────────────────────────────────── TABLE OF CONTENTS ───────────────────────────────────────────── 1.0 INTRODUCTION 1.1 ................................. License 1.2 .............................. Disclaimer 1.3 ................................ Features 1.4 ................................... Files 1.5 .............................. What's New 1.6 ............................ RIP Contest! 2.0 INSTALLATION 2.1 ............................... Upgrading 2.2 ................................... Files 2.3 .................... *.JCQ & JCQUSERS.DAT 2.4 .......................... Language Files 2.5 .............................. Menu Files 2.6 ........................... RACONFIG Menu 2.7 .......................... Logging Levels 2.8 ..................Multinode Configuration 3.0 JCQSETUP 3.1 .......................... System Details 3.2 .............................. Path Names 3.3 ............................ User Details 3.4 .................................... Exit 4.0 NOTES 4.1 ........................... User Features 4.2 ................................. Netmail 4.3 ............................File Requests 4.4 ................................. Indexes 4.5 ................................. Support 4.6 ........................ Acknowledgements 4.7 ............................ Future Plans 4.8 ............................ Registration 4.9 .................................. Epilog 5.0 ......................... Latest Versions ──────────────────────────────────────────────────────────────────── ──────────────── INTRODUCTION ──────────────── ──────────────────────────────────────────────────────────────────── JC-QWK is an offline mail door designed to create QWK format mail packets for users of RemoteAccess BBS software version 2.x. It is designed to take advantage of special features of RA 2.0 such as message groups and the new JAM messagebase. JC-QWK can be used with Hudson message areas, JAM message areas, or a combination of both. ──────────────────────────────────────────────────────────────────── ──────────────── 1.0 LICENSE ──────────────── ──────────────────────────────────────────────────────────────────── │ 1.1 LICENSE ──────────────────────────────────────── │ This document and the associated files may be freely copied provided that: (1) All of the files are copied as a group (such as in a single archive). See below for a list of files. (2) The files are not modified in any way (including removal or alteration of copyright notices or this license) (3) No charge beyond a cost-recovery fee not to exceed $3, or a general telecommunications connection fee, is made. (4) After a month of evaluation the product must be registered. This package may not be incorporated into programs or other products which are distributed or sold to others without the authors permission. │ 1.2 DISCLAIMER ──────────────────────────────────────── │ Although this program has been tested by myself and others, it is entirely possible that JC-QWK may malfunction in environments or under circumstances in which it has not been tested. The author disclaims any and all responsibility for damages (both consequential and incidental) resulting from the use or misuse of JC-QWK. Sole responsibility for determining the suitability of the program rests with the user. │ 1.3 FEATURES ──────────────────────────────────────── │ o Allows Downloading/uploading of QWK compatible mail packets. o Allows requesting of files on the BBS. (FDB compatible). o Supports both Hudson and JAM style messagebases. o Supports ASCII, ANSI, Avatar and RIP display formats. o Fully configurable prompts. o Supports all RA control codes, including the ^K!TEXTFILE| command. o Supports RA sysop keys, ALT-E, ALT-S, ALT-C, ALT-H etc. o Users may optionally have their downloaded packets numbered up to 99 - e.g. BBS.Q01, BBS.Q02, etc. o Allows user to modify pointers by message area. o Allows selecting a number of messages instead of a lastread pointer (eg - last 50 messages in each area, rather than message number 7,492). o Optional generating of index files (*.NDX). o Can send an ASCII list of new files (without online scan). o Allows selecting/deselecting complete message groups. o Allows Changing flags by area. o Allows Filters to receive only messages addressed to All, only personal messages, and those written by the user. o Sysop controlled network status per area. o Multi-language support - uses its own language files. o All Hotkeys are changeable by sysop (per language file) o Single or double list displays of message areas o Includes flexible user editor. o Areas can be added/dropped by addressing a message to JC QWK or QMAIL (check your offline mailreader for instructions, if it supports it). o Simple installation - Just install as a type 7 with no parameters other than *M (to swap out of memory). o Message number limits can be defined for each connect speed. o Sysop controlled maximum amount of QWK packets per day. o Multinode/network and DV aware. o Supports Netmail. o Checks uploads for duplicate messages and ignores them. o Users can enable/disable Automatic-downloading mode. o Users can Download bulletins (if sysop allows). │ 1.4 FILES ──────────────────────────────────────── │ The disk or archive you received should contain the following files: JCQWK-G3.ZIP contains: ┌────────────────────────────────────────────────────────────────────┐ │ FILE_ID.DIZ BBS Description of JCQWK. │ │ JCQWK.DOC This file - documentation. │ │ JCQWK.EXE The door program itself. │ │ JCQSETUP.EXE Setup program. │ │ JCQUTIL.EXE Util to pack the JCQWK user base. │ │ JCQUTIL.DOC Documentation on JCQUTIL │ │ ENGLISH.ZIP English menu files (ASCII, ANSI, RIP). │ │ DUTCH.ZIP Dutch menu files (ASCII, ANSI, Avatar, RIP). │ │ LANGUAGE.ZIP Language JCQ files (ENGLISH.JCQ, and others). │ │ CONFIG.ZIP Sample config files for protocols/archivers. │ │ REGISTER.ZIP How to Register. │ │ BETATEAM.TXT List of Beta testers. │ └────────────────────────────────────────────────────────────────────┘ ENGLISH.ZIP now also contains several RIP files! Be sure to copy these all to your RA textfile directory. In addition to the above names, the RIP collection also include several additional langugae prompts, named JC-*.RIP JC-*.ASC. ┌────────────────────────────────────────────────────────────────────┐ │ See FILENAME.DOC in the archive for a list and descriptions! │ └────────────────────────────────────────────────────────────────────┘ LANGUAGE.ZIP contains: ┌────────────────────────────────────────────────────────────────────┐ │ ENGLISH.JCQ English language including RIPed prompts! │ │ STOCK.JCQ English language without RIPed prompts. │ │ DEUTSCH.JCQ German language without RIPed prompts. │ │ DUTCH.JCQ Dutch language without RIPed prompts. │ │ FRENCH.JCQ French language without RIPed prompts. │ └────────────────────────────────────────────────────────────────────┘ CONFIG.ZIP contains: ┌────────────────────────────────────────────────────────────────────┐ │ JCQPACK.CFG Demo setup for compression programs. │ │ JCQPROT.CFG Demo setup for download protocols. │ └────────────────────────────────────────────────────────────────────┘ │ 1.5 WHAT'S NEW ──────────────────────────────────────── │ JC-QWK is a still young program, first developed in 1993. Since then many new features have been added and refined, and many more features are still being planned. If there is a feature that you would like to see added just let me know! I can be reached in the JCQWK.SUP and RA_UTIL echos, or you can send me a netmail at 2:281/610 or 1:102/1001. New since 2.0: Version 2.01gamma adds RIP support, dupe checking, automatic download, short names for message areas, bulletin downloading, file downloading, plus some minor additions and fixes. Version 2.0 had a problem with message areas over 256 (just as RA 2.0 did) but version 2.01g1 fixed it. JCQWK now puts tearlines and Origin lines on uploaded messages. Origin lines are now retained for messages downloads from JAM areas. JCQBYE will be send when exiting JC-QWK so RIP Hotkeys can be reset. Added a small utility so you can delete users who haven't called for a number of days. JC-QWK will use %TASK% or %NODE% environment variables now (if defined) to to determine the node number. Users can abort the scanning process, and are prompted to either continue, abort the scan, or abort and download messages scaned so far. Bulletins can be added to the users packets by the sysop now. Users can request files to download by sending a message addressed to JC-QWK. There is no longer a 2000 message limit per packet to include indexes. Maximum for total downloaded QWK packets a day and a default language (for if the language name supplied by RA is not found) is added too. With all these changes JC-QWK is now smaller in size and is faster as well! New since 1.0: Since the 1.0 release, many minor bugfixes have been made to the program, and a few new features added. The big one, of course, is the JAM support! Support for netmail was also added. UPGRADING - IMPORTANT!!! When updating from a previous 2.x version, you must run JCQSETUP, which will automaticly convert the JC-QWK userbase to 2.01 format. Menu screens and language files have been changed too. Use the new language files included in LANGUAGE.ZIP, as well as the new RIPed English prompts and screens included in ENGLISH.ZIP. If you wish to use an old language file you will need to run JCQSETUP and add in any new prompts and hotkeys yourself. │ 1.6 RIP CONTEST! ──────────────────────────────────────── │ Do you think you're pretty handy with the RIP editor? If so, you can win a free JC-QWK key and get your name mentioned in JC-QWK docs - the first step to international stardom! :) Create the perfect JC-QWK menu and/or welcome screens and send them to one of the support sites mentioned towards the end of this file. Be sure to archive the file, including a small textfile with your name and electronic address (Fidonet etc), your BBS phone number if nothing else) so we know who to send the key to! Also be sure to name the archive something distinctive, such as your fidonet address (110-210.ZIP, for example). Also feel free to send us .RIP files for other parts of JC-QWK, especially for languages other than English so that we can include them in future releases. ──────────────────────────────────────────────────────────────────── ──────────────── 2.0 INSTALLATION ──────────────── ──────────────────────────────────────────────────────────────────── Here's the part you've been looking for! │ 2.1 UPGRADING ──────────────────────────────────────── │ FROM 2.0 (or 2.01gamma-1/gamma-2): Simply copy the new .EXE files over the old ones, be sure to copy the new LANGUAGE.JCQ files over as well. Then copy the new text files in ENGLISH.ZIP to your text file directory. Next set up any of the new options you would like to change. Note that some menu options have been added, so you will have to change any customized menu screens you have. Run JCQSETUP.EXE and enable/disable any new features. Note that the ENGLISH.JCQ included in the new LANGUAGE.ZIP uses ^K!FILENAME| control codes in the place of many prompts. These call external .ASC, .ANS, .AVT and .RIP files (depending on what the user has). If you use the new ENGLISH.JCQ you MUST also use all of the files in the ENGLISH.ZIP (or make your own replacements for them). Put these with your other JC-QWK menu display files (JCQWELC.*, JCQMENU.*, etc). The purpose of this is to fully implement .RIP in JC-QWK. See FILENAME.DOC in the ENGLISH.ZIP archive for a complete description of all RIPed prompts and screens. If you don't want to implement RIP, use the Stock non-ripped English file thats named STOCK.JCQ. Rename the STOCK.JCQ to be ENGLISH.JCQ instead. Then you do not need any of the prompt replacment (JC-?????.???) files either, so they can be removed. From 1.0: If you are upgrading from JC-QWK 1.0 you will need to start over from scratch. Where have you been? :-) │ 2.2 DIRECTORIES AND FILES ──────────────────────────────────────── │ Create a directory to run JC-QWK from and copy the JCQWK.EXE, JCQSETUP.EXE files to it, along with the language (*.JCQ) and configuration (*.CFG) files. The directory should look something like this: ┌────────────────────────────────────────────────────────────────────┐ │ Directory of Z:\BBS\JCQWK │ │ │ │ DUTCH JCQ 10348 05-23-93 10:32a │ │ ENGLISH JCQ 10348 05-23-93 10:32a │ │ JCQWK CFG 6400 05-17-93 10:32a │ │ JCQPACK CFG 1840 05-17-93 11:57p │ │ JCQPROT CFG 1030 05-17-93 11:56p │ │ JCQSETUP EXE 155568 05-23-93 10:22a │ │ JCQUSERS DAT 16281 05-23-93 10:32a │ │ JCQWK EXE 75074 05-23-93 10:30a │ │ 9 file(s) 404969 bytes │ └────────────────────────────────────────────────────────────────────┘ You can put these files anywhere, as long as they are together. (See the file list if you can't find them.) │ 2.3 *.JCQ & JCQUSERS.DAT ──────────────────────────────────────── │ You can create/edit both *.JCQ and JCQUSERS.DAT with JCQSETUP.EXE. see section 3.0 for details on the different options in JCQSETUP. You must keep JCQSETUP.EXE in the same directory as the copy of JCQWK.EXE which you execute. JCQWK.EXE looks for the configuration file in the directory it is in, and JCQSETUP writes the configuration file in whatever directory *it* is in, regardless of what directory you are in when you run them. │ 2.4 LANGUAGE FILES ──────────────────────────────────────── │ JC-QWK uses its own language files, with a separate file for each language named [language].JCQ. JC-QWK decides which language file to use by checking what is being used in RA itself when the door is run. So, for each .RAL files you have available in RA you should have an identical .JCQ files, with the same base name - eg if you have a GERMAN.RAL file, you should also have a GERMAN.JCQ file. You should find several language files included in this package. This JC-QWK archive gives you two different options for the English language. The default fully implements RIP throughout JC-QWK. If you want a simpler, non-RIP implementation, use the STOCK.JCQ file and rename it to ENGLISH.JCQ instead. If you use the stock language, then you do not need to use any of the external text prompt (JC-?????.*) files so they can be deleted. If you have other languages in RemoteAccess, either copy other .JCQ files over to match the name, or use JCQSETUP to create your own language file. See the section on JCQSETUP below for more information. │ 2.5 MENU FILES ──────────────────────────────────────── │ JC-QWK will first look for its menu files (.RIP .ANS .AVT or .ASC) in the directory pointed to by the active language record for RemoteAccess. If the proper files aren't found there, JC-QWK will then search its own directory. It expects at least the files named like the ones in STOCK.ZIP and DUTCH.ZIP. These files are just like the ones used with RemoteAccess - you can even use all of the special RA textfile codes! THE ENGLISH RIP FILES If you use the ENGLISH.JCQ language file found in LANGUAGE.ZIP, you will need to use the JC-*.* prompt replacement textfiles found in the ENGLISH.ZIP archive. This is because the ENGLISH.JCQ calls external textfiles in the place of normal prompts, so it can call .RIP files if the user has RIP. If the user doesn't have RIP, then .ASC, .ANS, and .AVT files must be available to use as prompts. These are all provided in ENGLISH.ZIP, so you need only copy all of the files in that archive to wherever you want to keep your menu files. An alternative to this fully RIPed setup is to use the files found in the ENGLISH.ZIP file except for the JC-*.* files which could be deleted. Then rename the STOCK.JCQ file to ENGLISH.JCQ and you will have a simpler non-RIP setup that doesn't need as many external files. JC-QWK determines if the user is using ANSI, Avatar, or RIP from the dropfile passed to it by RA. Note that in the registered version of JC-QWK, the JCQWELC screen can be supressed. You can combine this with custom designed JC*.* menues to help your menus integrate seamlessly with the look of your BBS. │ 2.6 RACONFIG MENU ──────────────────────────────────────── │ Installing JC-QWK in RA is very simple. Just make a menu command entry for the QWK door and define it as a type 7 exit. The optional parameter should be the full path and name of JCQWK.EXE ending with *M. Swapping should not be needed for JC-QWK, but will probably be needed by some archiving programs which needs a lot of memory (ARJ, for example!) It will look something like this: -------------------------------------------------------------- 1 2 3 4 5 6 12345678901234567890123456789012345678901234567890123456789012345 ; z:\bbs\jcqwk\jcqwk.exe *m Action Execute sub-program (Type 7) Display OptData HotKey Q AutoExec No Color Color example MinSec 7 TimeUsed 0 FlatCost 0 MaxSec 61000 TimeLeft 0 TimeCost 0 A flags -------- Age 0 Terminal Any B flags -------- MinSpeed 0 Nodes C flags -------- MaxSpeed 0 Groups D flags -------- Credit 0 DayTimes --------------------------------------------------------------------------- │ 2.7 LOGGING LEVELS ──────────────────────────────────────── │ Logging will take place in the logfile RA is writing to. If anything goes wrong, check this logfile first before asking for advice! Set logging on DEBUG MODE in JCQSETUP -> BBS setup to get more info if things go wrong. This option will write more information in the log file. If there is a Runtime Error there will be a seperate file in the node direcory (RUNERROR.LOG) containing the Runtime Error information. Please see to it that you do use pathnames for your logfile. The documentation of RA did state that you should not use pathnames in the past, however since 2.0 it is good practice to make use of the *N sign. So c:\bbs\ra\node*N\system.log is a vallid entry! │ 2.8 MULTINODE CONFIGURATION ──────────────────────────────────────── │ If you run more then one node it's a good idea to set the %TASK% environment variable for each node, so that RA, JCQWK, and other programs always know the proper node number in use. For example: SET TASK=1 Note that JCQWK will look for a %NODE% variable to use instead if %TASK% is not defined, so you could use either one. ──────────────────────────────────────────────────────────────────── ──────────────── 3.0 JCQSETUP ──────────────── ──────────────────────────────────────────────────────────────────── You can use JCQSETUP to edit all of the files needed: language files, user records, and configuration files. I strongly advise that you go through all items to make sure they are properly set for your system. Firing up jcqsetup brings the following screen: ---------------------------------------------------------------------------- System details Path names User details Exit ═════════════════════════════╕══════════════════════════════════════════════ ▒│ Personal details │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒│ BBS setup │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒│ Max downloads per day: 0 │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒│ Download protocols │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒│ Compress tools │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒│ Limits │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒│ Language definition │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒│ Columns (double now) │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒│ Forced areas │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒│ Default language: ENGLISH │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒╘═══════════════════════════╛▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Setup program for JC-QWK verion 2.01 ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒ Copyright (c) Johan Corstjens / JC-Tools 1993 ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒ Using config files in C:\BBS\RA\ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ──────────────────────────────────────────────────────────────────────────── Menu for name, location and registration code Things to remember when you use this program are: o Check the line stating the directory of the config files (in the middle of the screen) o The line at the bottom of the screen gives you brief, context sensitive help on the currently highlighted item (throughout the whole program) - in this case telling you that the "Personal Details" option will give you a menu to enter your name, location and registration code. │ 3.1 SYSTEM DETAILS ──────────────────────────────────────── │ o Personal details Displays the personal details menu (see below). o BBS Setup Displays the BBS setup menu. (see below) o Max Downloads per day Displays the maximum number of packets (not messages) that users are allowed to download per day. o Download Protocols Displays the protocol editor, so you can define file transfer protocols available for users to download from the QWK door. (see below) o Compress Tools Displays the compression tools editor, so you can define archivers available for compressing and decompressing mail packets. (see below) o Limits The Limits setup menu, where you can set the maximum number of messages users may download per packet according to their modem speed. (see below) o Language Definition Brings up a menu with .JCQ language files (if any) to choose from. You can press DEL or INS to delete or create one. Selecting a language brings you to the language editor (see below) o Columns Toggles between double and single display, to determine whether available message areas and groups will be displayed in one or two columns. If double is selected, areas will be truncated at position 25. o Forced Areas Enables you to select areas all users are forced to read. o Default language Brings up a menu with .JCQ language files (if any) to choose from. Selected language will be used if no language file with the same name as used in RA exists with extention .JCQ. Bear in mind that if you use sceens like JCQWELC.ANS you have to put them in all textfile directories though! Though not tested putting them in JCQWK directory should work too :-). This way you don't have to put them in all text directories. Personal details menu ──────────────────────────────────────── ╒═══════════════════════════════════════ Personal Details ╕ │ Your name: Johan Corstjens │ │ Your location: Delft, The Netherlands │ │ Registration Code: │ ╘═════════════════════════════════════════════════════════╛ Fill in your name, Location and (if you have one) your registration key code. BBS Setup ──────────────────────────────────────── ╒═══════════════════════════════════════════════ BBS Details ╕ │ BBS name : The 1st Dutch MIDI BBS node 2 │ │ BBS code : MIDIBBS2 │ │ BBS phone : 31-15138754 │ │ Area names : <ENTER> to set up area names │ │ Swap to : Try best method │ │ Log mode : Normal logging │ │ News file : NEWS │ │ Newfile list : Z:\BBS\NEWFILES.LST │ │ Welcome file : WELCOME │ │ Goodbye file : GOODBYE │ │ Dupe database: 0 │ │ Show JCQWELC : True │ │ Bulletins : <ENTER> to setup Bulletins │ ╘════════════════════════════════════════════════════════════╛ BBS NAME: Fill in the name of your BBS BBS CODE: Put the base filename you want your users .QWK and .REP packets to have - don't include the extension. Obviously, this should be a maximum of eight characters. BBS PHONE: This entry is only used to put in the CONTROL.DAT file, so the offline mailreader will show the number of the bbs. AREA NAMES: This part of the menu lets you set up shorter names for message areas. The QWK format only allows 12 character names for message areas, but often the descriptions in RA are longer than this, and may be confusing to the user when they're simply cut off at the limit. Hit enter on this selection, and arrow down over the different message areas. The name as it will appear to the QWK user in their reader is shown at the bottom of the screen, so you can easily decide what can be left alone and what needs changing. To change it, simply hit enter and type the new name. SWAP TO: 'Swap to' can be toggled to force it to swap to disk, EMS, XMS and Extended memmory. Try best method will just look for the best way. LOG MODE: This toggles between normal and debugging mode. JC-QWK logs to the RA log file (defined in RACONFIG). NEWS, WELCOME, GOODBYE: Enter the base filename of the files you want displayed to the offline reader for news, welcome, and goodbye. As with the menu screens, JC-QWK will look in the text path directory pointed to by the language record in use on RA. If the user uses ANSI or Avatar it will search for those extensions, if not it will look for .ASC. If the appropriate file isn't found the JC-QWK directory will then be searched. {-} If you have not registered JC-QWK it will ignore the News entry and generate its own file with a nice message to the user. NEW FILES: The New Files list must be an ASCII textfile, which you can generate with one of the available file utilities, such as the RAFILE program which comes with RA 2.x. This is makes JC-QWK much faster than it would be if it did an online scan of the file directories every time a caller downloaded a new packet! Make sure you include the drive, path and complete filename (with extension). DUPE DATABASE: JC-QWK will check each message a user uploads to make sure it isn't a dupe of one they uploaded before. It determines this by a CRC check, which it stores in a dupefile. The number you put here tells JC-QWK how many message CRC's to keep in the database. If you have too many, it will slow down message uploads and take up more disk space, but if you have too few, dupes may get by. {+} SHOW JCQWELC: If you have registered JC-QWK, you can tell it not to display the JCQWELC screen to callers when they enter the door. This helps to create the appearance that JC-QWK is simply another menu on your BBS, rather than a separate program (especially if you make custom JC*.* screens in the same style as your RA menus). BULLETINS: Bulletins can be selected by JCQSETUP, BBSSETUP -> BULLETIN. In this menu you can press INSERT to add a bulletin, DELETE to del a bulletin and ESCAPE to quit. When you choose INSERT JCQSETUP wil search your DEFAULD MENU DIRECTORY (you can set those in raconfig pathnames -> default menu directory) and present a window with all found bulletin (type 6) menus. When you select an entry, it will b put in the config file. JCQWK will look at this config file (JCQWK.CFG) and if it finds a bulletin (e.g. BULLS) it will scan f all new bulletins in the text directory entered in the language file in RemoteAccess. It will scan for BULLS*.* in case BULLS was selected. It is fully flag/security aware! Download Protocols ──────────────────────────────────────── Download protocols will present a selection screen to you from which you can add, delete or select a file transfer protocol available to users to download and upload their packets. When you select a protocol, a screen will appear: ╒═══════════════════════════════════════════════════════════ Fill in ╕ │ │ │ Name: ZModem │ │ Download cmd: z:\bbs\ra\dsz.exe port *P est 0 *B pB4096 sz -Z -k -m│ │ Upload cmd: z:\bbs\ra\dsz.exe port *P est 0 *B rz │ │ │ ╘════════════════════════════════════════════════════════════════════╛ CHECK THIS BEFORE MAKING THE DOOR AVAILABLE! The first line is the name of the protocol as it appears to the user. Download and Upload cmd are the commands to fire up the external protocol drivers. JC-QWK doesn't use internal protocols like RA does, so you need to have an external driver available. The configuration comes properly set up for DSZ.EXE, a very popular utility available on most BBS's as "DSZ????.*". NOTE: DSZ comes in .EXE and .COM versions - make sure JCQSETUP is set up to call the proper one, or you won't be able to get file transfers to work properly! If you modify these settings, or add other external protocols, check the documentation of those protocols for info on how to set it up. Make sure the Download and Upload Command lines include the full path, including drive letter. If you include "*B" (without quotes) in the command line, JC-QWK will replace it with the baud rate. INSTRUCTIONS FOR NON-STANDARD IRQ's If you are using non-standard IRQ's, remove "Port *P" from the DSZ command lines in JCQSETUP. Then in each DOS window define a %DSZPORT% environment variable to refer to each node's Base Address and IRQ. For example: SET DSZPORT=3F8,5 (this would set the port as COM1, IRQ5) Nodes that use a standard COM port can have this environment variable simply defined as COM number. For example: SET DSZPORT=1 (this would set the port as COM1, IRQ4) So, for example, if you run a 3 line BBS under DesqView, and COM1 and COM2 are both standard, but COM3 uses a non-standard IRQ, then you would define the following %DSZPORT% variables: Node 1 startup batch: SET DSZPORT=1 Node 2 startup batch: SET DSZPORT=2 Node 3 startup batch: SET DSZPORT=3E8,5 The following Addresses and IRQ's apply to standard COM ports: Port Addr IRQ ─────────────────────────────────────────────────────────── COM1 3F8 4 COM2 2F8 3 COM3 3E8 4 COM4 2E8 3 Compression tools: ──────────────────────────────────────── This is simular to the down and upload protocols. It brings up a selection screen with add, delete and select capabilities. ╒════════════════════════════════════════════════ Fill in ╕ │ │ │ Name: ZIP │ │ Expand cmd: f:\system\dosutl\pkunzip.exe -o │ │ Compress cmd: f:\system\dosutl\pkzip.exe -ex │ │ │ ╘═════════════════════════════════════════════════════════╛ Again, the Name is what will appear to the user, Expand/Compression commands must include the full and correct path names! JC-QWK comes with the standard archivers configured with the appropriate switches (of course, you will probably have to change the paths). Refer to your archiver's documentation if you would like to do anything unusual with these. Limits ──────────────────────────────────────── This allows you to choose the maximum number of messages a user at each modem speed can download in a single packet. ╒════════════════Choose╕ │ 300 │ │ 1200 │ │ 2400 │ │ 9600 │ │ 14k4 │ │ Faster │ ╘══════════════════════╛ Selecting a bps rate will pop up the screen below, in which you can control the maximum amount of messages present in one QWK packet. This allows you to permit those users with faster modems to download more messages, since they won't take up as much time as slower users. ╔═════════════════════════════╗ ║ Maximum for 14k4 BPS : 600 ║ ╚═════════════════════════════╝ Language definition ──────────────────────────────────────── There has to be a valid *.JCQ file for each language you define in RACONFIG! In other words, if a user has selected FRENCH.RAL in RA, they should have FRENCH.JCQ in JC-QWK. ╒═ Pick a file ╕ │ ENGLISH.JCQ │ │ DUTCH.JCQ │ │ STOCK.JCQ │ ╘══════════════╛ This will be displayed when you first install JC-QWK. If you want to create your own language file, press insert. You will be prompted for a language name. BE SURE IT IS THE SAME NAME THAT IS DEFINED IN RACONFIG! When selecting (or creating a new one) you will get this screen: ▒╒═════════════════════════════════════════════════ Language ╕ ▒│ EDIT MENU HOTKEYS │ ▒│ Press ? to get help on area flags │ ▒│ <S>elect ALL, <D>eselect ALL, <C>hange flags │ ▒│ Help on flags used in area selection screen │ ▒│ Message area selected │ ▒│ Receive only those messages addressed to you │ ▒│ Receive only those messages addressed to ALL │ ▒│ Receive messages written by yourself │ ▒│ When you have a QWK network │ ▒╘═══════════════════════════════════════════════╡ More ╞═╛ ▒▒╔════════════════════════════════════════════════════════╗▒▒ ▒▒║Press ? to get help on area flags ║▒▒ ╚════════════════════════════════════════════════════════╝▒▒ ───────────────────────────────────────────────────────────── Press ? to get help on flags Selecting the second item on this menu allows you to edit the description in the box below. At the bottom of the screen you can see the original description of the prompt. When creating a new language file it will be filled with the default English prompts. Notice the "More" indicator in the lower right - there are more prompts than shown on this screen. There are some prompts for which you have to provide a hotkey in addition to the line. This is done in a separate editing box (eg the Continue (Y/n/=) prompt). You can use all keys available, as long as the order doesn't change! Edit menu hotkeys ──────────────────────────────────────── This brings you to another menu, from which you can define which hotkeys are used for each action available. ╒═════ Change select character ╕ │ MAINSCREEN │ │ <D> Download │ │ <U> Upload │ │ <R> Restore pointers │ │ <M> Modify pointers │ │ <S> Select areas │ │ <I> Indexfiles toggle │ │ <N> New files toggle │ │ <C> Compression │ │ <T> Transmission protocol │ │ <?> Help key │ │ <Q> Quit │ │ <G> Goodbye - logoff │ │ <S> Stop - interrupt process │ │ <A> Auto Download │ │ <B> Bulletins Toggle │ │ <P> Packet Count Toggle │ │ AREA SELECTION SCREEN │ │ <S> Select all │ │ <D> Deselect all │ │ <C> Change flags │ ╘══════════════════════════════╛ Just fill in the key you want to use for each action. │ 3.2 PATH NAMES ──────────────────────────────────────── │ This lets you tell JC-QWK what directories to use. Selecting an item from this screen lets you enter a pathname. Path names ╒════════════════════════╕ │ Local mail directory │ │ Work directory │ │ Path to mail directory │ ╘════════════════════════╛ ╔════════════════════════════════════════════════════════════╗ ║ C:\TEMP\ ║ ╚════════════════════════════════════════════════════════════╝ LOCAL MAIL DIRECTORY: Local mail directory is the directory mail packets should be placed in, and reply packets will be found in, when you run the door locally. Note that your mail reader may be set up with separate directories for .QWK and .REP files - if so, you will need to reconfigure it, or simply move packets, so your reader can find them. WORK DIRECTORY: Work directory is used by JC-QWK for temporary files and directories needed during processing of mail packets. This directory will be checked, and will be created if it doesn't already exist. PATH TO MAIL DIRECTORY: Path to mail directory is the directory where the files for your Hudson messagebase are located. If it doesn't exist it will state an error. Just ignore if you don't have one. You don't need to tell JC-QWK where your JAM areas are - it locates them on its own, using the MESSAGES.RA file in your BBS setup. A NOTE ON JAM SPEED!: For optimum speed in all JAM activities (echomail processing, scanning, and QWK packing), do not include more than 30 JAM areas in a single directory. Users who have put all of their JAM areas in a single directory have reported it to be *very* slow. │ 3.3 USER DETAILS ──────────────────────────────────────── │ User details will present a selection screen to you listing those users who have used the JC-QWK door. If none are listed, you must enter one manually. You can select <enter>; remove <del>; and add <insert>; users from this screen. When editing a user, the following screen appears: ╒══════════════════════════════════════════════════ Fill in ╕ │ Number in USERS.BBS : 1 │ │ User name : Mike Ehlert │ │ Protocol : ZModem │ │ Compression : ZIP │ │ Receive bulletins : YES │ │ Rcv list of new fls : NO │ │ Receive Index files : YES │ │ Autostart function : OFF │ │ Packet Counter : OFF │ │ Messageareas : <Enter> │ │ │ │ Last successful download: 03-25-94 │ ╘═══════════════════════════════════════════════════════════╛ If the user is found in the RA USERS.BBS file the number of the user is shown. You can edit the user's name and toggle their flags. Selecting message areas will bring you to the next screen (if you use RA 2.x) From this selection screen you can add, delete or edit an area. ╒═══════════════════ Area: M_MAIN-BOARD ╕ │ Actual lastread pointer : 12265 │ │ Last succeeded run pointer : 10376 │ │ Receive own messages only : No │ │ Receive only to "ALL" : No │ │ Receive self written messages : No │ │ Network status : No │ ╘═══════════════════════════════════════╛ ACTUAL LASTREAD POINTER: This is the pointer found in LASTREAD.BBS for this user. It's the highest number message the user has read in this message area. These are the same pointers used when the user reads messages online, or in most other mail doors, so changing this pointer affects which messages are considered new not just in JC-QWK, but also in the RA editor and other mail doors. Therefore: BE CAREFUL NOT TO MESS UP THIS POINTER! YOUR USERS MAY NOT LIKE IT! Don't alter it unless you know exactly what you're doing. LAST SUCCEEDED RUN POINTER: Last succeeded run pointer is the number of the highest message in their last downloaded packet. This is used when the user resets their pointers to the previous run, in case a QWK packet gets messed up and they want to re-download it. RECEIVE OWN MESSAGES ONLY: Whether the user will only receive messages addressed to them directly in that area. This can be toggled by the user online. RECEIVE ONLY TO ALL: Whether or not the user will only get the messages in this area which are addressed to "ALL". This can be toggled by the user online. RECEIVE SELF WRITTEN MESSAGES: Whether the user will get messages which they themselves uploaded to the area. This can also be toggled by the user online. NETWORK STATUS: This will enable the user to upload mail with other names in the "from" field than what's in their EXITINFO.BBS file, regardless of whether the area is set up as REAL NAMES- or HANDLES ONLY in MESSAGES.RA. Normally JC-QWK checks MESSAGES.RA and enforces the use of the user's real name or handle if that is the restriction on the area, only allowing other names in PICK AN ALIAS areas. Netstatus allows that user to upload messages as if the area were PICK AN ALIAS, which they need to do if they are uploading packets from a QWK based network. │ 3.4 EXIT ──────────────────────────────────────── │ Well, this is a familiar one, I think! Choose between "with" or "without" save. ──────────────────────────────────────────────────────────────────── ──────────────── 4.0 NOTES ──────────────── ──────────────────────────────────────────────────────────────────── │ 4.1 USER FEATURES ──────────────────────────────────────── │ OFFLINE ADD/DROP/RESET: JC-QWK supports RESET, ADD and DROP commands given by offline mail readers. Users should refer to the documentation of their offline reader for further details. AUTO DOWNLOAD/UPLOAD: If a user selects this option, They can download new mail and upload a .REP packet with minimal supervision. Each time they enter the JC-QWK door they will automatically move to downloading a new packet. Once that is complete, they are offered the opportunity to press "U" and upload a .REP packet - otherwise they will be disconnected in 10 seconds. This way they can start the download and then leave it to run unattended, without having to worry about logging off. If the user wants to change their settings, or turn this feature off, they must wait until they reach the prompt that they are being logged off, and press "S" to stop the automatic disconnect. Then they will be at the regular JC-QWK menu. │ 4.2 NETMAIL ──────────────────────────────────────── │ JC-QWK supports Fidonet netmail. When a netmail message is exported to a user's packet, the subject is moved to the first line of the message with a leading "Subj:" keyword. To write a netmail message offline, if your reader doesn't do it for you, put the address in the Subject field with a leading "@". The first line must start with "Subj:", with no leading spaces. JC-QWK understands both full addresses as well as a variety of short-form addresses (where the remaining part of the address is based on the main address or AKA for the netmail message area. Some examples (assuming an address of 1:110/290 would be: @151/223 send to 1:151/223 @1:274/40 send to 1:274/40 @270 send to 1:110/270 @.1 send to 1:110/290.1 On messages exported from the Bbs, the subject line will contain the originating address for netmail areas. This was done to allow you to reply without entering an address, since it will already be in the subject line. A future version of JC-QWK will support the CRASH flag. In this version the default attributes that will be used for all netmail imported via JC-QWK are KILL/SEND,PRIVATE and LOCAL. │ 4.3 REQUESTING FILES TO DOWNLOAD ──────────────────────────────────────── │ JC-QWK supports user file requests. A user can write a message addressed to JC-QWK or JCQWK or QMAIL, with a subject of REQUEST and then they can list the files they desire in the text of the message. For example: TO: JCQWK (or TO: JC-QWK or TO: QMAIL) SUBJ: REQUEST ---------------- file1.zip file2.zip file3.zip JCQWK will then scan the RA FileDataBase for those files and will send the ones found to the user, as long as the user has a security and flag level that will allow it. The Sysop can limit the number of files per day that a user is allowed to request, or can disable requests completly. However no check is done for special settings. All done now is just look if the user has access to the area based on his flags and security level. │ 4.4 INDEXES ──────────────────────────────────────── │ JC-QWK offers users the option as to whether the mail door should generate index files and include them in the .QWK packet. Most modern mail readers create this file themselves when they unpack the mail, but some do not. Since indexes are probably unecessary, and take extra time to generate, users may want to turn this off unless they find their reader needs them. │ 4.5 SUPPORT ──────────────────────────────────────── │ Since I am using this program myself, I will be supporting this program with every means I have to get it as perfect as possible. I have setup an area called JCQWK.SUP which is available for all questions/answers. It's available on the support sites at this moment and when there is enough flow it will be put on the backbone. Just ask your host for it, or get it at a support site. │ 4.6 ACKNOWLEDGEMENTS ──────────────────────────────────────── │ Thanks to all my alpha/betatesters on whom I put a lot of pressure, since I wanted this release to be on its way ASAP. Thanks to Ron Huiskes and Hans Siemons who helped me out numbers of times. And of course Kief Morris who updated these files. I also want to say thanks to Mark May who did a marvelous job on the JAM routines. Thanks Mark! And of course my girlfriend Ingrid for her patience when I was too busy with programming to do anything. I would like to thank Kieff Morris who has done a hell of a job writing this documentation. Since other things had more priority for the moment he had to leave our team. So Kief all the best and another big THANK YOU for the work done so far!! For GAMMA 3 Mike Ehlert edited the documentation to reflect new/changed features. Besides of this Mike has done a lot of work editing screens and prompts, so a big THANK YOU is in place here too! │ 4.7 FUTURE PLANS ──────────────────────────────────────── │ Making JC-QWK more flexible and other features you suggest! If you have any requests for features, don't hesitate to contact me! If you don't say anything, that's fine with me, but it won't improve JC-QWK. So please contribute your input to this fine product! │ 4.8 REGISTRATION ──────────────────────────────────────── │ You may use this version for one month to see if it meets your needs. If you decide it's good enough to use longer than that, please register by sending the fee to one of the registration sites available. Refer to the REGISTER.ZIP file on how to register, or ask for instructions at 1:102/1001 or 2:281/610. │ 4.9 EPILOG ──────────────────────────────────────── │ If you find any errors or misbehavior of this program, or suggestions for new features or improvements, please contact me via netmail (2:281/610) or the JCQWK.SUP or RA_UTIL echo. Normally I will bring out bugfixes as soon as possible, at least one week after a bug has been reported. Note that the message echo for JC-QWK, named JCQWK.SUP, is available from support sites. │ 5.0 LATEST VERSIONS ──────────────────────────────────────── │ The latest version of JC-QWK is available for download or file request using the magic name: JCQWK We also allow the public to try the latest wide-beta, which can be requested with magic name: JCQWKBETA EUROPE: Johan Corstjens (2:281/610) 31-15-138754 USR DS 14.4k Delft, Netherlands UNITED STATES: Mike Ehlert (1:102/1001 or 1:102/1005) Thousand Oaks, California 1-805-494-8327 USR DS 16.8k 1-805-494-8427 USR DS 21.8k 1-805-494-9386 USR DS 21.6k And most likely from all betasites (see BETATEAM.TXT) I will release major updates in the common Fidonet file echoes. Last words go to Kief Morris: THANKS for your help with the docs. We hope to keep them updated as well as you did. (c) 1993 JC-Tools - Johan Corstjens The First Dutch MIDI BBS Fido 2:281/610 +31-15138754 V22 >> V32bis HST DS (this number is due to change july 1994!) The Netherlands