home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / WHO28.ZIP / WHO.DOC < prev    next >
Encoding:
Text File  |  1995-04-24  |  19.3 KB  |  481 lines

  1.  
  2.         ■ WHO 2.8 Manual
  3.  
  4.     ■ Author...
  5.         
  6.         DaCoTa
  7.             
  8.         Sysop of Insanity Systems
  9.              +31-85-636369
  10.  
  11.     ■ Disclaimer...
  12.         
  13.                 I only guarantee it will use 13961 bytes of your
  14.                 precious diskspace and that it works perfectly at my
  15.                 place.
  16.  
  17.     ■ What's it supposed to do?..
  18.  
  19.                 It checks all of the supported programms on callers and
  20.                 if someone has made an inbound call, the history file of
  21.                 the mailer will be updated with that info. This way you
  22.                 can track all incoming calls from your mailer and you
  23.                 don't have to gaze through kilos of logfiles.
  24.  
  25.                 WHO supports eigth programms:
  26.  
  27.         ■ Mailers
  28.  
  29.                         FrontDoor 2.x
  30.                         InterMail
  31.  
  32.         ■ Bulletin Board Systems
  33.  
  34.             RemoteAccess 2.x
  35.             ProBoard 2.x
  36.             SuperBBS 1.x
  37.  
  38.         ■ Rear-End FAX Receivers
  39.  
  40.                         BGFAX 1.x
  41.                         ZxXEL FAX 2.x and 3.x
  42.  
  43.                 ■ Voice Mailboxes (VMBs)
  44.  
  45.                         ZyXEL FAX 3.x
  46.  
  47.                 If you have another BBS system or a different mailer,
  48.                 give me a sign and I will see what I can do for you. If
  49.                 you have complete structure files of a BBS system, I
  50.                 could add it in 15 minutes if you supply the info to me.
  51.  
  52.         ■ How does it work?..
  53.  
  54.                 Just put it in your batchfile, just start it every time
  55.                 after something or someone called. A good position is
  56.                 right before the mailer is started or right after the
  57.                 BBS, FAX and/or VMB software.
  58.                 
  59.         ■ What do all those things mean?..
  60.  
  61.         ■ With FrontDoor 2.x...
  62.  
  63.                         The environment setting FD should be set to
  64.                         point to the directory where SETUP.FD is
  65.                         located, e.g.:
  66.  
  67.             SET FD=C:\BBS\FD
  68.  
  69.                         It reads SETUP.FD and writes to INBOUND.HIS,
  70.                         LASTCALL.FD and FD.LOG or their mL equivalents.
  71.  
  72.         ■ With InterMail...
  73.  
  74.                         The environment setting IM should be set to
  75.                         point to the directory where CONFIG.FD is
  76.                         located, e.g.:
  77.  
  78.             SET IM=C:\BBS\IM
  79.  
  80.                         It reads SETUP.FD and writes INBOUND.HIS,
  81.                         LASTCALL.IM and IM.LOG or their mL equivalents.
  82.  
  83.                 ■ With a MultiLine system...
  84.  
  85.                     >>> IMPORTANT <<<
  86.  
  87.                         If you're running a multiline system, WHO looks
  88.                         at the TASK environment setting for the line.
  89.                         This is no standard but it's being used almost
  90.                         everywhere. If you use WHO with a multiline
  91.                         system, the filenames which are used for
  92.                         FrontDoor, InterMail and BGfax are changed.
  93.  
  94.                         If you haven't set up a TASK setting or if
  95.                         you're using an environment setting with another
  96.                         name, you can pass the line number with a
  97.                         command line switch. Just start WHO with:
  98.  
  99.                         WHO /TASK=[n]
  100.  
  101.                         Lets say it is line nr. 3, you can start WHO
  102.                         with:
  103.             
  104.                         WHO /TASK=3
  105.  
  106.                         If you've set an environment setting with
  107.                         another name, e.g. you've set up a LINE
  108.                         environment setting with the line number, you
  109.                         can start WHO from within a batchfile (won't
  110.                         work from the DOS prompt!) with:
  111.  
  112.                         WHO /TASK=%LINE%
  113.  
  114.                         If you want to force WHO to store all data in
  115.                         one mailer's history, you can add /FORCE to the
  116.                         command line. So if you have a dual line system
  117.                         where line one is the mailer and line two is the
  118.                         BBS, run WHO with
  119.  
  120.                         WHO /TASK=1 /FORCE
  121.  
  122.                         This way all the data from the second line will
  123.                         be logged to the mailer on the first line. Only
  124.                         use this in combination with the /TASK=
  125.                         parameter or strange things will happen. I'm not
  126.                         shure what exactly, but it won't be much good.
  127.  
  128.                         If you want to default WHO to a single line
  129.                         system, start WHO with
  130.  
  131.                         WHO /TASK=0 /FORCE
  132.  
  133.                         and all the data will then be put into the
  134.                         normal single line history files.
  135.  
  136.                         The command line switch overrules the TASK
  137.                         environment setting, even if it is invalid!
  138.  
  139.                 ■ Other options...
  140.  
  141.                         /LOCAL
  142.  
  143.                                 Log local calls too. Only works with the
  144.                                 three BBS systems. Behind the name there
  145.                                 is a Local flag so you can pick them out
  146.                                 easily.
  147.  
  148.                         /ALIAS
  149.  
  150.                                 Use the users alias in stead of his/her
  151.                                 real name. Only works with Remote Access
  152.                                 and SuperBBS.
  153.  
  154.                         /NOLOG
  155.  
  156.                                 Don't log things to the mailer's
  157.                                 logfile. Saves you some diskspace. (Not
  158.                                 much though :)
  159.  
  160.                         /NORA /NOPB /NOSBBS /NOBGFAX /NOZFAX
  161.  
  162.                                 Disable the processing of one or more
  163.                                 systems. Especially for ProBoard sysops
  164.                                 who have a RA environment setting.
  165.  
  166.                         /? /HELP
  167.  
  168.                                 Display a little help screen.
  169.  
  170.                 ■ With RemoteAccess 2.x...
  171.  
  172.                         If RemoteAccess is installed it checks
  173.                         LASTCALL.BBS and compares this to the last
  174.                         caller in the inbound history of the mailer.
  175.  
  176.                         The node nummer is made out of three numbers.
  177.                         The net number is the line, the zone number is
  178.                         the baudrate and the node number is the number
  179.                         of times the user called this system. So if the
  180.                         node number is:
  181.  
  182.                         2:14400/9
  183.  
  184.                         the user called in on line two at 14400 baud and
  185.                         it was his or her ninth call. On single line
  186.                         systems there is no net number.
  187.  
  188.                         The environment setting RA should be set to
  189.                         point to the directory where LASTCALL.BBS is
  190.                         located, e.g.:
  191.  
  192.             SET RA=C:\BBS\RA
  193.  
  194.                         It reads LASTCALL.BBS and CONFIG.RA.
  195.  
  196.                         RemoteAccess 1.1x isn't supported. If you're
  197.                         still working with it, please, change to 2.x!
  198.                         All that development isn't done for nothing!
  199.  
  200.         ■ With ProBoard 2.x...
  201.  
  202.                         It reads ProBoards BINLOG.PB and compares this
  203.                         to the last caller in the inbound history of the
  204.                         mailer.
  205.  
  206.                         The node nummer is made out of two numbers. The
  207.                         net number is the line and the zone number is
  208.                         the baudrate on which the user called. So if the
  209.                         node number is:
  210.  
  211.                         1:14400/0
  212.  
  213.                         the user called in on line one at 14400 baud. On
  214.                         single line systems there is no net number.
  215.  
  216.                         The environment setting PROBOARD should be set
  217.                         to point to the directory where BINLOG.PB is
  218.                         located, e.g.:
  219.  
  220.             SET PROBOARD=C:\BBS\PB
  221.  
  222.             It only reads BINLOG.PB.
  223.  
  224.         ■ With SuperBBS 1.x...
  225.  
  226.                         It reads SuperBBS's CALLERS.BBS and compares
  227.                         this to the last caller in the inbound history
  228.                         of the mailer.
  229.  
  230.                         The node nummer is made out of two numbers. The
  231.                         net number is the line and the zone number is
  232.                         the baudrate on which the user called. So if the
  233.                         node number is:
  234.  
  235.                         3:14400/0
  236.  
  237.                         the user called in on line three at 14400 baud.
  238.                         On single line systems there is no net number.
  239.  
  240.                         After the user's location there are seven flags
  241.                         which represent the following things:
  242.  
  243.                         D if the user downloaded something;
  244.                         U if the user uploaded something;
  245.                         R if the user read some messages;
  246.                         W if the user wrote some messages;
  247.                         P if the user paged the sysop;
  248.                         N if the user was a new user;
  249.                         Q if the user used the QWK system.
  250.  
  251.                         The environment setting SBBS should be set to
  252.                         point to the directory where CALLERS.BBS is
  253.                         located, e.g.:
  254.  
  255.             SET SBBS=C:\BBS\SBBS
  256.  
  257.             It only reads CALLERS.BBS.
  258.  
  259.                 ■ With BGFAX 1.x...
  260.             
  261.                         It reads the ASCII logfile FAXIN.LOG and
  262.                         compares the last entry to the last entry in the
  263.                         mailer's history. If you use the PID feature of
  264.                         BGFAX, you should pass it on to WHO with the
  265.                         TASK variable or with the /TASK= command line
  266.                         switch.
  267.             
  268.                         Now, the node nummer is made out of two numbers.
  269.                         The zone number is the baudrate of the call and
  270.                         the node number is the number of received pages.
  271.                         So if the node number is:
  272.  
  273.                         14400/3
  274.  
  275.                         the fax was at 14400 baud and BGFAX received
  276.                         three pages.
  277.  
  278.                         The location field is the filename of the
  279.                         received fax file. After the filename is the
  280.                         status report. If the fax wasn't completely
  281.                         received (e.g. if there should be more pages.)
  282.                         it reports Not Done. Else it reports Finished.
  283.                         After the status report is the resolution and
  284.                         compression status. It can report 1D or 2D
  285.                         compression and HR (High Resolution) or NR
  286.                         (Normal resolution) faxes.
  287.  
  288.                         If you use BGFAX 1.36, please don't use the /ED
  289.                         switch with it. WHO expects the USA date format
  290.                         (mm-dd-yy) in the logfile so if you'll change it
  291.                         to European date format (dd-mm-yy) WHO will mess
  292.                         things up.
  293.  
  294.                         If you have a ML system with BGfax, WHO will
  295.                         report a fax on every task. This due to a
  296.                         limitation in the logging of BGfax. You can work
  297.                         around this to include /NOBGFAX in every node
  298.                         and put WHO /TASK=1 in the batchfile where the
  299.                         faxes are received. This way all the faxes are
  300.                         reported to task nr. 1.
  301.  
  302.                         The environment setting BGFAX should be set to
  303.                         point to the directory where FAXIN.LOG is
  304.                         located, the same directory as where the faxes
  305.                         are received, e.g.:
  306.  
  307.                         SET BGFAX=C:\BBS\BGFAX\INBOUND
  308.  
  309.             It only reads FAXIN.LOG.
  310.  
  311.         ■ With ZyXEL FAX 2.x...
  312.  
  313.                         It reads the logfile ZFAX.LOG and compares the
  314.                         last entry to the last entry in the mailer's
  315.                         history.
  316.             
  317.                         Now, the node nummer is made out of the baudrate
  318.                         of the call. So if the node number is:
  319.  
  320.                         14400/0
  321.  
  322.             the fax was at 14400 baud. 
  323.  
  324.                         The system name is the received fax ID and the
  325.                         location is the filename in which the fax was
  326.                         received. Behind the filename is the result code
  327.                         and the compression (1D or 2D) and resolution
  328.                         (NR or HR) status.
  329.  
  330.                         The environment setting ZFAX should be set to
  331.                         point to the directory where ZFAX.LOG is
  332.                         located, e.g.:
  333.  
  334.             SET ZFAX=C:\BBS\ZFAX
  335.  
  336.             It only reads ZFAX.LOG.
  337.  
  338.                 ■ With ZyXEL FAX 3.x...
  339.  
  340.                         It reads the logfiles ZFAXIN.LOG and ZFAXVM.LOG
  341.                         and compares the last entries to the last entry
  342.                         in the mailer's history.
  343.             
  344.                         Now, the node nummer is made out of the baudrate
  345.                         of the call. So if the node number is:
  346.  
  347.                         14400/2
  348.  
  349.                         the fax was at 14400 baud and contained two
  350.                         pages.
  351.  
  352.                         The system name is the received fax ID and the
  353.                         location is the filename in which the fax was
  354.                         received. Behind the filename is the result code
  355.                         and the compression (1D or 2D) and resolution
  356.                         (NR or HR) status.
  357.  
  358.                         For the Voice Manager the resolution and
  359.                         compression flags won't be set and the number of
  360.                         pages will be zero. (Guess why :)
  361.  
  362.                         The environment setting ZFAX should be set to
  363.                         point to the directory where ZFAXIN.LOG and
  364.                         ZFAXVM.LOG are located, e.g.:
  365.  
  366.             SET ZFAX=C:\BBS\ZFAX
  367.  
  368.                         It reads ZFAXIN.LOG and ZFAXVM.LOG.
  369.  
  370.          ■ Why did I make it?..
  371.         
  372.                 I didn't want to gaze througt the logfile to see who had
  373.                 called my BBS, so I thought... Let's put it in the
  374.                 INBOUND.HIS of FrontDoor! (Not a really new idea, but
  375.                 what the heck.) Worked on it for maybe two or three
  376.                 hours, and did what I wanted at my place...
  377.  
  378.                 After a while some people came up to me with requests
  379.                 for BGFAX, ZFAX and InterMail. So after a big struggle
  380.                 for time and peace between my final exams I created
  381.                 this. (BTW, I passed those exams! :)
  382.  
  383.                 When I finished that, other requests for MultiLine
  384.                 systems and ProBoard were coming in. Also found the
  385.                 structures of SuperBBS somewhere (or better, the
  386.                 structures found me, thanx to Thomas Raehalme :) and put
  387.                 those in too.
  388.  
  389.     ■ What errors can be reported?..
  390.  
  391.                 All the errors WHO can return are self-explaining. If a
  392.                 fatal error occurs you will hear two beeps. When you
  393.                 hear only one beep, you should register :)
  394.  
  395.                 If you find a bug, please report it to me. (How? Look at
  396.                 the end of this DOC) This program is very, very heavily
  397.                 tested, but some things just aren't showing on a small,
  398.                 single line humdrum system.
  399.  
  400.                 Errors in this doc aren't very dangerous, but you can
  401.                 report them to me if you want to. :-)
  402.  
  403.     ■ Credits...
  404.  
  405.                 The following copyrighted programs are mentioned in this
  406.                 file and other files supplied with this software
  407.                 package: (in alphabetical order)
  408.         
  409.                         BGFAX                  B.J. Guillot
  410.                         FrontDoor              Joaquim H. Homrighausen
  411.                         InterMail              Peter Steward
  412.                         Portal of Power        The Portal Team
  413.                         ProBoard               Philippe Leybaert
  414.                         RemoteAccess           Andrew Milner
  415.                         SuperBBS               SuperBBS group
  416.                         ZyXEL FAX              ZyXEL Communication Corp.
  417.  
  418.                 Special thanks to the following persons for: (in
  419.                 alphabetical order)
  420.  
  421.                         Tommy Arveborg         Bugs
  422.                         JeRoen van Baarsel     InterMail, Bugs, ß
  423.                         Jeroen Beekhof         Bugs
  424.                         Terry Belton           My bad English ;-)
  425.                         Marcel Jansen          ZyXEL FAX 3.x, Bugs
  426.                         Martijn Janssen        Bugs, ß
  427.                         Paul Kolenbrander      FrontDoor, Bugs
  428.                         Karlo Leenhouts        ProBoard, ß
  429.                         Peter Lindeman         InterMail, Bugs, ß
  430.                         Terence Milbourn       FrontDoor, Bugs
  431.                         Hans Niewenhuis        Suggestions, Bugs
  432.                         Frank Schots           Bugs
  433.                         Sikko Stienstra        ZyXEL FAX 3.x, Bugs
  434.             Thomas Raehalme        Structures
  435.             Richard R. Sands       Sound routine
  436.                         Rini Schaap            Portal of Power, Bugs
  437.  
  438.     ■ Registration...
  439.  
  440.                 Register and support the Shareware system (and get rid
  441.                 of the little not-so-annoying beep :). Just send me the
  442.                 little amount of HFL 10 (Approx. US$ 7) to Postbank
  443.                 account 6492481 to Claudio Tagliola in Holland. If
  444.                 you'll send me your registration form I'll put your key
  445.                 on your board asap. Read REGISTER.DOC for more details.
  446.         
  447.                 The unregistered version isn't crippled in any way, it
  448.                 only makes a little beeping sound. WHO takes note of the
  449.                 audio times in the mailer config, so you won't wake up
  450.                 in the middle of the night and delete this program in
  451.                 pure rage. (That would be a shame, not? :)
  452.  
  453.     ■ Bug reports... Ideas... Flames... Registrations...
  454.  
  455.                 If you have found a bug, have a suggestion, are unhappy
  456.                 with something or just want to register this fine piece
  457.                 of software, contact me:
  458.         
  459.         ■ BBS
  460.             
  461.             Insanity Systems
  462.                         +31-85-636369
  463.             Open 25 hours a day and 8 days a week
  464.             From 1k2 to 28k8
  465.  
  466.         ■ Netmail
  467.  
  468.             2:283/607@FidoNet
  469.             79:1100/106@HOLLANDnet
  470.             85:100/309@085net
  471.             115:3137/0@PascalNet
  472.             135:1040/102@DutchSceneConnection
  473.                         202:900/101@SupportNet
  474.             206:3106/0@DisasterNetwork
  475.  
  476.                 ■ VNSP
  477.  
  478.                         I'm registered as a member of @VNSP under the
  479.                         registrationcode VNSP/941222/01/M.
  480.  
  481.