$VER: SHELTER DOC Shelter Mailer Manager Installation & Operation Williamson 1.80 This is the documentation for the Shelter Mailers Manager. This program controls the operation of the Umbrella, Gazebo, and Porticus Shelter Mailers. It can also be used with the ROOF mailer, but is redundant as all operations are available in the various ROOF Function Hosts. All Shelter Mailers have the same set of commands, although the options may be different. Shelter.TXT discusses the features of each mailer. Use this as a guide to choose which mailer meets your needs. GenMailer.DOC discusses the configuration of each mailer. Read this carefully, as errors in your configuration could cause the mailer not to work, or may even cause a system exception. Extras.DOC describes the various utilities included in the distribution. NOTE: the word is used in place of the particular mailer's name thoughout the remainder of this document. Installation and Configuration: Copy *.library TO LIBS: Create and assign MAIL:, CFG:, LOG: and INFO: Make sure ALL required ASSIGNS are set in your Startup-Sequence or User-Startup. Make sure all ASSIGNS and PATHS are defined BEFORE starting ARexx, otherwise Arexx will not be able to find programs it calls. This is the same situation that exists with LoadWB. Make sure rexx libraries are LoadLib'ed and RxLib'ed in your Startup-Sequence. Use the example S:Start-ARexx which is based upon the standard Arexx startup script. If you do not do this, ENV: variables will not be set and the Mailer will not work properly. Install and mount the NULL: device in your startup-sequence READ note concerning internal port in README, install Sushi if required. Copy executables to Mail:, make sure MAIL: is assigned and on your path. Copy rexx scripts to the directory you will define as REXXDIR. Mail:rexx/ is perfect for this. Copy wpl/#? to cfg:wpl/ ALL These are the files you must edit. See GenMailer.DOC for explanations. cfg:wpl/gen//GEN.cfg - mailer config cfg:wpl/gen//CACHE.cfg - site cache config cfg:wpl/gen//MODEM?.cfg - modem config cfg:wpl/gen/SCREEN.cfg - public screen config See GenMailer.doc for keyword desciptions. Procedure: Edit /GEN.cfg with your site info. Edit cache.cfg for sites you call regularly. Edit MODEM?.CFG for your serial device, port and modem. Note that Roof and Porticus use modem configs 2 and up, because 1 is reserved for internal uses. Execute: (Use RX xxxx if you do not have the compiled versions) >GENMAILER ALL (path) or >GENMAILER EMSI (path) - path defaults to CFG:WPL/GEN/ carefully observe any ERROR or WARNINGS GenMailer will EXIT on an ERROR. WARNINGS indicate that a parameter is incorrect or missing, it will be ignored or a default will be used. NOTE: There is no checking for MISSING keywords in either Cache.cfg or Modem?.CFG >SHELTER START AmigaDOS script: PGen, Ugen or Ggen is included which does the above. Polling and Dialing with SCALL: >RUN >NIL: (RX) SCALL [phonenumber|line] [line] An alias simplifies the command line. ALIAS DIAL "Run >NIL: Rx SCALL " Usage: Scall Site_Address/A,LINE/K,NUMBER/K, PRI/K,REDIALDELAY/K,DURATION/K,CRASH/S,NOPICKUP/S Site_Address FTN- [domain#][z:][net/]node[.p] CLOCK- clock UUCP- uu FAX- fax_ BBS- bbs_ Number phone number when manual dialing Line modem line to use for dialing DEFAULT DEF_LINE Pri task priority for poll DEFAULT -1 RedialDelay number of seconds to wait between dials DEFAULT 180 Duration number of minutes to attempt connection DEFAULT 60 Switches crash send crash mail only nopickup do not accept inbound files If site is not in the Cache, you must provide the phone number. SHELTER MAILERS will expand addresses based upon your own default address. This mean that if you are, for example, fidonet#1:167/104.99, you simply type: SCALL 104 - to call your boss. or SCALL 151 - to call fidonet#1:167/151.0 Shelter will allow the slave to dial with the 'REDIALDELAY' seconds delay between attempts. This is defined in the Mailer configuration but can be changed on the Scall command line (redialdelay=n" The total duration of the redial attempts to get through will be limited to the period defined by 'CALLWINDOWMIN' or by a 'duration=n' on the command line. This is a POLL window. The number of seconds of REDIALDELAY and BUSYDELAY may also be changed DURING a poll, using "RXSET variablename seconds", but this will not affect polls where a new value was specified on the commad line. The number of minutes of the CALLWINDOWMIN can also be changed but only PRIOR to a poll, changing it during a poll will have no effect. If the variable 'IGNORENOANSWER' is set, dial will not abort when the called node does not answer (very common in the case of an IBM-based HUB.) Calling UUCP sites: SCALL uu sitename may be a Cached uucp site alias or a FQDA (Fully Qualified Domain Address) Calling Atomic Clock sites: SCALL CLOCK[?] CLOCK[?] is the sitename specified in the Cache. Atomic Clock sites MUST be Cached. AUTO MODE: An AUTO mode is included which will start up the Mailer, convert any .FLO files found and call the defined BOSS site. In the case of Umbrella, it will then exit. For security purposes, the directory in which the ?LO files are placed by the external program should NOT be the same as your outbound directory. SHELTER Mailer Manager usage: Usage: SHELTER START - load mailer EXIT - unload mailer RESTART - unload, recompile and reload mailer AUTO - startup, flo convert and call BOSS/HUB POLL - Call all sites with pending mail If priority specified, only sites with priority equal or greater will be called. NORM, DIRECT, CRASH CALL - start a site poll [domain#][z:][net/]node[.p] [ (phonenumber|line ) | line ] expansion is done based upon our address KILL - abort a site poll [domain#][z:][net/]node[.p] expansion is done based upon our address FLOCVT - Converts 4D .?LO files entries to Xfreq. FLOCVT function will also scan and add any remaining ?UT files to queue. .OUT files will be ignored, as these should be echomail which is waiting to be archived. CUT, DUT, NUT and HUT will be added according to priority. NOTE: there is an internal switch to allow FLOCVT to queue .OUT files. You may need to set this to 1 if your tosser creates .OUT files instead of .NUT files for NORMAL mail or does not create .NUT, .CUT, DUT, .HUT at all.. ADDWORK site fullfilename (disposition priority) - Add a file to the queue of a site if file is *.?UT then it will be send as a *.PKT with disposition=D and priority 50 if file is ARCmail, sendas name will be created Priority may also be specified as text: HOLD, NORM, DIRECT, CRASH CLEAN - removes non-existing files from queue. These two commands are used internally by the mailer. OPENSTATUS - open mailer GUI CLOSESTATUS - close mailer GUI The Mailer Display: Each Mailer line has an addressable display which is controlled by LOGPROC. LOGPROC is an Arexx Function Host by Alan Kelms. Title Bar contains 6 or 7 fields: Mailer Name, Version, Port Name, Serial Device, Serial Unit, Modem Name [Locked Rate] The field descriptions: Status: Current status of the line Response: Last event or modem response Baud: Baud rate of the last connect Number: Phone number of last connect Password: DEFFERED|CACHE|LOOKUP and SENT|OK|BAD|NONE Session: Type WAZOO|EMSI|LOGIN|UUCP|HUMAN|BBS|FAX|etc Protocol: File transfer protocol Login: Username (and command) or remote site mailer/version H_Adr: Current host address, this may be different during a session R_Adr: Remote address (primary if EMSI) Sysop: Remote sysop's name and sitename H_Ofr: Wazoo/Emsi offer to remote R_Ofr: Wazoo/Emsi offer from remote H_Freqs: TRUE|FALSE, indicates if we will accept a file request R_Freqs: TRUE|FALSE indicates if remote will accept a file request request is not sent if host will not accept it Inbound: SECURE|NONSECURE|USER|UUCP|FAX Indicates inbound security type. Domain: Indicates remote domain when remote provides it (Note: when the remote does not provide a Domain, the Shelter Mailer AUTOAKA feature will try to determine the correct one, or use the default domain. External Control via AmigaDOS scripts: S:?boot - a script that will set a wpl variable to boot a human caller when he is at a menu prompt. External Control via Environmental Variables: You may set the following ENV: variables TRUE or FALSE directly or via a cron event to enable or disable the feature. The variable will only be effective if the feature is present in the mailer. NOANSWER - if TRUE, a RING will be IGNORED and phone will not be answered DEFAULT: FALSE LOCATION: ENV:/ ACCESS - if TRUE, will allow user access, BBS spawning, Menus and WPLRX Utilities for human callers DEFAULT: TRUE LOCATION: ENV:/ BBS - if TRUE, and ACCESS TRUE, selected bbs is spawned This will allow you to selectively disable BBS spawning, while still allow user access to other features. eg: ACCESS TRUE and BBS FALSE DEFAULT: TRUE LOCATION: ENV:/ ALLOWFREQS - if TRUE inbound file requests will be processed DEFAULT: TRUE LOCATION: ENV:/ FTSFREQS - if TRUE, , and ALLOWFREQS is TRUE, inbound file requests received during FTS1 sessions will be processed DEFAULT: FALSE LOCATION: ENV:/ UUCP - if TRUE, accept inbound uucp calls DEFAULT: set by UUCP keyword LOCATION: ENV:/ FAX - if TRUE, accept inbound fax calls DEFAULT: set by FAX keyword LOCATION: ENV:/ During ZMH, you should set ACCESS and BBS FALSE, and if you wish, UUCP and FAX FALSE also. A FULLY compliant FidoNet system would set ALL the above FALSE (except NOANSWER, of course :) External Control via CLipList Variables: You may set the following clip variables directly (using RXSET) or via a cron event to change the value. The variable will only be effective if the feature is present in the mailer. CALLWINDOWMIN duration of a call window in minutes REDIALDELAY delay in seconds to wait between dials on BUSY response BUSYDELAY delay in seconds to wait between dials on SLAVE DIALING response IGNORENOANSWER TRUE|FALSE Treat a no answer same as busy Direct control via ARexx: It is possible to change the value of many variables while the mailer is active. One method is as follows: (example for GAZEBO) Rx 'Address GAZEBO1 Set umh "05:00 06:00"' A ROOF utility, Irexx.rexx (freqable name) is an interactive arexx/wpl interpreter which allows easy access. Cron: CyberCron v1.5 or better is HIGHLY recommended as your event handler. It features an arexx port and named event queues which make it ideal for the Shelter Mailer environment. I use CyberCron heavly in ROOF and have nothing but praise for this program. Unlike others, it is source-released, so even if the original author abandons it, others may continue suport. Adding Files to the queue: WPL mailers do not use the .FLO flat file format due to the collision and security problems associated with that method. Xferq.library manages the outbound queue. The SHELTER MAILERS MANAGER includes two functions: FLOCVT and ADDWORK, which remove the necessity of external utilities. There are a number of utilities to add files to the outbound queue. Xpack - 5D echomail archiver/router/queuer/scheduler * XList - lists queue for a site, a pattern or all sites * Xkill - remove a filepattern from a sitepattern * Xrmv - remove a file from a site queue AddWork - add a file to a site queue, aware of filetypes SendFile - a simple version of AddWork Xq - FLO convert, scan outs, Xpack front-end Xflo - online flo conversion The above are included in the freqable archive: XPACK.LHA Using terminal programs: WPL Mailers support OwnDevUnit.library, making the use of term programs that also support this standard quite trivial. DISTRIBUTION The compiler of the CAM disks refused to even consider this freely available archive. Therefor, inclusion of any part of this archive on a CAM DISK, or on the CAM/RCS BBS is STRICTLY FORBIDDEN. If you have obtained this archive from one of these sources, there will be NO support. Registration: Please send netmail or email to one of the following addresses indicating the Shelter mailer and versions of the Manager and Genmailer that you are using.. Yup..that's it! Support: via netmail: FidoNet#1:167/104.0 AmigaNet#40:600/104.0 via echos: WELMAT @ FIDONET COMMS_AMY @ AMIGANET comp.sys.amiga.datacomm @ USENET tpg.ml.wpl.application @ MTLNET WPL_APP @ FIDONET via InterNet: robert@ecs.mtlnet.org bobw@amigaecs.1choice.login.qc.ca User support mailing list: wpl-application@alfred.ccs.carleton.ca Requests to join the list: wpl-application-request@alfred.ccs.carleton.ca Support Echo: ROOF_PROJECT @ FIDONET#1:167/151.0 (Zyxel) ROOF_PROJECT @ FIDONET#1:167/104.0 (v42bis) Thanks to Matthew Mondor and Yanik Grignon for their invaluable Beta Testing of the SHELTER MAILERS and GenMailer. Also thanks to Frederic Morin, Denis Turcotte, Yanik and the many others who have contributed over the years to the ROOF PROJECT, making the Shelter Mailers possible. Beta Testers: Porticus Len Lekx FidoNet#1:250/701.2 Kenneth Bartlett FidoNet#1:291/37.0 Matthew Mondor FidoNet#1:167/104.2 Mike Manning Fidonet#1:229/326.0 Gazebo Yanik Grignon FidoNet#1:167/207.0 Matthew Mondor FidoNet#1:167/104.2 Mike Manning Fidonet#1:229/326.0 Umbrella Matthew Mondor FidoNet#1:167/104.2 Xpack/Xq Denis Turcotte FidoNet#1:167/151.0 RoofLOG Denis Turcotte FidoNet#1:167/151.0 The above are those who have made the effort to contact me with bug reports and enhancement requests...thanks to all of you.