home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / fal2_105.zip / FAILMAIL.DOC < prev    next >
Text File  |  1995-10-01  |  14KB  |  423 lines
  1.  
  2.  
  3.  
  4.  
  5.            ┌───       ┐              ┐
  6.            │        . │            . │
  7.            ├──  ──┐ ┐ │ ├─┬─┐  ──┐ ┐ │
  8.            │   ┌──┤ │ │ │ │ │ ┌──┤ │ │
  9.            ┴   └──┴ ┴ ┴ ┴ ┴ ┴ └──┴ ┴ ┴
  10.  
  11.                   Failmail 1.05
  12.    FTS compatibile netmail tracker, requester & router
  13.           (c) 1995, Zbynêk Pospíchal, 2:420/22
  14.                    All rights reserved
  15.  
  16.  
  17.  1. Disclaimer and License █
  18.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  19.  
  20.   "Failmail" refers to all executables and documentation  as
  21. distributed  in the  compressed files  in which packages for
  22. all platforms was released.
  23.  
  24.     *  Failmail is copyrighted material by Zbynêk Pospíchal.
  25.        It may only be used in agreement with the  conditions
  26.        set out in this License agreement.
  27.  
  28.     *  Although care has been taken  to  write  and  test  a
  29.        program that does what this document states, Failmail
  30.        is provided "as is", without warranty or guarantee of
  31.        any kind, either expressed  or  implied,  as  to  the
  32.        fitness  for  a  particular  purpose  or  quality  or
  33.        performance of this  program,  except  that  Failmail
  34.        will occupy disk space.
  35.  
  36.     *  In no event shall Zbynêk  Pospíchal be liable to  you
  37.        or anyone else for  any damages  or cost,  including,
  38.        but not limited to, any lost profits, lost savings or
  39.        lost  income  which  may  result  from  the  use   or
  40.        inability to use Failmail.
  41.  
  42.     *  Registered  versions   of   Failmail   may   NOT   be
  43.        distributed  to  or  used   by  users  who  are   not
  44.        registered users.
  45.  
  46.     *  Only unregistered evaluation versions of Failmail may
  47.        be distributed freely, provided no money or any other
  48.        compensation  is  asked  or  accepted  without  prior
  49.        written permission from the author.
  50.  
  51.     *  Registration is REQUIRED for  commercial usage (in  a
  52.        commercial   environment,   such   as   a   business,
  53.        government   organization,    association,    school,
  54.        foundation, or any other form of juridical person, or
  55.        any system where Failmail  is directly or  indirectly
  56.        used to make profit).
  57.  
  58.  
  59.  
  60.  
  61.                          - 2 -
  62.  
  63.     *  In no way  is Zbynêk  Pospíchal obligated  to you  or
  64.        anyone else to provide future versions of, or support
  65.        for Failmail
  66.  
  67.     *  Zbynêk Pospíchal reserves  the right  not to  release
  68.        future evaluation versions of Failmail, but switch to
  69.        a commercial "buy before  you try" marketing  concept
  70.        instead.
  71.  
  72.  2. How to use this manual ? █
  73.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  74.  
  75.   The  main  part  of  this  document  describes  the   main
  76. principes of operation of Failmail and the using on  FidoNet
  77. system, installing and configuring of Failmail.
  78.  
  79.   The appendix is full reference of Failmail. If you do  not
  80. know, you can find here what you are need about Failmail.
  81.  
  82.  3. What is Failmail ? █
  83.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  84.  
  85.   Failmail is an  electronic mail  support program  designed
  86. for use in FidoNet compatibile networks. Failmail is program
  87. only  for  managing  netmail  (and,  of  course,   echomail)
  88. messages in *.MSG  type message  base. You  can not  replace
  89. your mailer program (such as FrontDoor, Intermail,  d'Bridge
  90. or T-Mail) with Failmail.
  91.  
  92.   If you do  not know, what  is FidoNet, netmail,  echomail,
  93. mailer, message base etc., you do not need this program. For
  94. your orientation will be better  if  you  will  delete  this
  95. program and forget that words.
  96.  
  97.   FidoNet runs typicaly on commuted telephone lines. But  if
  98. I am connected to  a Local Area  Network (LAN) with  someone
  99. else and he wants read messages  from FidoNet too, I have  a
  100. problem (with standard  FidoNet software  such as  FrontDoor
  101. and GoldEd) -  this  user  may  read  only  public  messages
  102. (echomail) and send private messages to him is not available
  103. or this user may read  all messages include my private.  One
  104. of solutions is using Failmail. This function is very useful
  105. if exists two  independent nodes (not  one system with  more
  106. lines)  at  one  LAN. New  feature (1.05) now  can route all
  107. messages  for specified  address, not  only all messages for
  108. specified user.
  109.  
  110.   Every  FidoNet  system  (include  points)  has  individual
  111. address, for example 2:420/22.  If someone  send netmail  to
  112. this address, but not for user (or operator) of this  system
  113. and if operator of this system does not send this message to
  114. system with this user,  message  is  lost.  Nota  bene  many
  115. sysops reads  only his  private netmails.  Is some  solution
  116. ? Yes ! Now you are no longer human message tracker, you are
  117. only sysop now - that can Failmail too.
  118.  
  119.  
  120.                          - 3 -
  121.  
  122.   Have you a BBS ? Many sysops wants allow to users read his
  123. private  netmail  messages.  But  - too  many  BBS  software
  124. systems is  stupid and users can read  all netmail  messages
  125. (include  messages to sysop and to robots such as AllFix  or
  126. AreaFix). It is not good. Solution was in disabling  netmail
  127. area  for  users.  That is  not good  too. Exist  some other
  128. solution ?  Netmail  area  for every user of BBS ?  No way !
  129. Solution  has  name  Failmail  -  it  can copy  messages for
  130. users which not listed in track list to some area.
  131.  
  132.  4. Technical requirements █
  133.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  134.  
  135.   For correct function of Failmail you need:
  136.  
  137.   - Some IBM PC or compatibile system (or emulator of this)
  138.  
  139.   - 250 kB of free memory (512 kB reccomended), 1.5 MB for
  140.     DPMI version (2 MB reccomended)
  141.  
  142.   - 100 kB of free disk space (and more to work)
  143.  
  144.   - MS-DOS or PC-DOS 3.30 (or  later)  or  DR-DOS  3.41  (or
  145.     later), Novell DOS, VDM  with DOS  in IBM  OS/2  1.3 (or
  146.     later), PTS-DOS, DOS window in Windows NT or  DOS window
  147.     at NextStep
  148.  
  149.   - 386 (and DPMI) versions requires an computer with 386 or
  150.     better CPU
  151.  
  152.   - OS/2 version requires an OS/2 system version 2.x or 
  153.     later and 386 or better CPU.
  154.  
  155.   Recommended additional requirements
  156.  
  157.    - software or hardware disk cache
  158.  
  159.    - multitasking software (such as DESQview or OS/2)
  160.  
  161.    - FidoNet compatibile mailer ;-)
  162.  
  163.  5. Installation of Failmail █
  164.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  165.  
  166.   For installation you need  fileextractor  RAR  (or  public
  167. domain UNRAR). Reccomended  for instalation  of Failmail  is
  168. creating his own directory (for example, C:\T-MAIL\Failmail)
  169. and unpacking it to this directory.
  170.  
  171.   If   this   is   done,   you   may   modify   Failmail.CFG
  172. (configuration file of Failmail)  and Failmail.USR (base  of
  173. names and addresses/directories).
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.                          - 4 -
  181.  
  182. What do you need in Failmail.CFG:
  183.  
  184. NETMAIL C:\T-MAIL\NETMAIL\
  185. ; path to netmail directory
  186. ADDRESS 2:420/22
  187. ; your FidoNet address
  188. UNKMOVE YES
  189. ; messages for unknown users on this address may be moved
  190. UNKMAIL C:\T-MAIL\NET2USR\
  191. ; and where may be moved this messages
  192.  
  193.   Values here are default, it  means, if you do not  specify
  194. it, these values for these variables are used.
  195.  
  196. And example of Failmail.USR
  197.  
  198. USER Zbynek Pospichal
  199. ADDR 2:420/22.9
  200. USER Sysop
  201. NONE
  202. USER Cosysop
  203. PATH F:\USER\JOE\NETMAIL\
  204. ALLR 2:420/22.8
  205. PATH C:\TEMP\
  206.  
  207.   Value in variable USER can  be max. 37 characters  length,
  208. value in variable ADDR  may  be  max. 21 characters  length,
  209. value in variable PATH  can  be  max. 60  characters  length
  210. (in OS/2 version on HPFS partitions max. 254 characters
  211. length). You may  specify only  one  action  for  each  user
  212. record. New  variable (1.05) ALLR  can specify  routing  all
  213. messages  for specified point/node - in ALLR record are  the
  214. same variable  as in USER  record - except NONE variable, it
  215. is not needed.
  216.  
  217.   Variable ADDR means  FidoNet 4D  address to  which may  be
  218. mails routed, variable PATH means directory to which may  be
  219. mails moved. If  is specified  flag NONE,  message for  this
  220. user is for Failmail locked, but  it is not same as ADDR  to
  221. our address or PATH  to main netmail path - system not serve
  222. this message.
  223.  
  224.   In 1.0 version is one  new  feature  here  -  if  you  want
  225. tracking messages for user specified in Failmail.USR, you can
  226. specify it by  REROUTE substatement at end on second  line in
  227. user record, eg.:
  228.  
  229. USER Zbynek Pospichal
  230. ADDR 2:420/22.9 REROUTE
  231. USER Sysop
  232. NONE REROUTE
  233. USER Cosysop
  234. PATH F:\USER\JOE\NETMAIL\ REROUTE
  235.  
  236.  
  237. If you will specify user, use this:
  238.  
  239.  
  240.                          - 5 -
  241.  
  242. USER Zbynek Pospichal
  243. NONE
  244.  
  245. I do not reccomend (very) this:
  246.  
  247. USER Zbynek Pospichal
  248. ADDR 2:420/22
  249.  
  250. USER Zbynek Pospichal
  251. PATH C:\T-MAIL\NETMAIL\
  252.  
  253.   Of course, 2:420/22  is now  address of  system, where  is
  254. running Failmail and C:\T-MAIL\NETMAIL is netmail  directory
  255. on my system. If you try one  of last two ways, you will  be
  256. wait, wait, wait... It will be never ending.
  257.  
  258.   Hmm, and now you can run Failmail by execute Failmail.EXE.
  259. Configuration file must be in  the directory, from which  is
  260. Failmail executed, or  you may  specify other  configuration
  261. file and "userbase" path in command line:
  262.  
  263. Failmail.EXE /CFG:C:\CTRL\Failmail.CTL /USR:E:\Failmail.USR
  264.  
  265.  If you are registered user, you have some registration key. 
  266. This key must be in the current directory.
  267.  
  268.  
  269.  6. Used development tools █
  270.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  271.  
  272.   All parts  of  FailMail  was  compiled  and  developed  in
  273. Borland C++  3.1 -  4.5, some  small blocks  was written  in
  274. assembler and compiled by Turbo Assembler 3.1. As editor was
  275. used Borland C++ IDE (for sources) and MAT/32 3.1 beta  (for
  276. documents). As debugger was used Borland Turbo Debugger  3.2
  277. and internal debugger  from Borland C++  IDE. All parts  and
  278. modifications of FailMail was developed under OS/2 Warp. 
  279.   OS/2  version  was  compiled in Borland  C++ 2.0 for OS/2,
  280. assembler  parts  was compiled  in Turbo  Assembler 4.1  for
  281. OS/2. As debugger was used Borland Debugger for OS/2.
  282.  
  283.  
  284.  
  285.  Appendix A █
  286.  ▀▀▀▀▀▀▀▀▀▀▀▀
  287.  Full list of Failmail.CFG variables:
  288.  
  289. NETMAIL
  290.  
  291.  Specifies the path  to  netmail  directory  -  for  example
  292.  C:\T-MAIL\NETMAIL\
  293.  
  294. ADDRESS
  295.  
  296.  Specifies our FidoNet  (or other  on compatibile  networks)
  297.  addresses - for example 2:420/22.  You can specify max.  10
  298.  addresses; main address may  be specified in first  ADDRESS
  299.  variable in config file,  more ADDRESS variable are  AKA's,
  300.  you may  specify  up  to  9  AKAs  in  real  mode  versions
  301.  (FailMail and FailMail/386) and up to 255 AKAs in protected
  302.  mode versions (FailMail/2,  FailMail/X  and  FailMail/Lin),
  303.  more will not be recognized by internal address table.
  304.  
  305.  
  306.                          - 6 -
  307.  
  308. FASTMOD
  309.  
  310.  Specifies if may  be used fast  mode of operating  Failmail
  311.  (it is exacting  of memory,  especiely for  more users)  or
  312.  normal mode (it is more  slower,  but  need  not  too  many
  313.  memory). Available values  are ON or  YES meaning use  fast
  314.  mode; OFF or NO means use normal mode. The default value is
  315.  ON. FASTMOD  cannot be use in real-mode versions (FAILMAIL,
  316.  FAILM386), only in OS/2, Linux and DPMI versions (they will
  317.  be released in the future).
  318.  
  319. MAXUSER
  320.  
  321.  Max. number of users in userbase, important for  allocating
  322.  memory. This  variable  has  meaning  only  in  fast  mode.
  323.  Default and maximal value is 1024.
  324.  
  325. COPYATT
  326.  
  327.  If may be moved file attachments to listed users with  PATH
  328.  variable set YES or ON means yes, NO or OFF means no.  File
  329.  is moved to user's netmail directory
  330.  
  331. UNKMOVE
  332.  
  333.  Messages to unknown users on our node (users not  specified
  334.  in user list) can be exported to some other area. Value  ON
  335.  or YES enables this, values OFF or NO disables. The default
  336.  value is ON.
  337.  
  338. UNKMAIL
  339.  
  340.  To where directory may be stored messages to unknown  users
  341.  with our address. Of course, it has meaning only if UNKMOVE
  342.  mode is ON
  343.  
  344. FROMUNK
  345.  
  346.  May be exported messages from directory of unknown users to
  347.  netmail directory (if they are not for listed users)
  348.  
  349. FROMNET
  350.  
  351.  May be  exported messages  from directories  of users  with
  352.  PATH specification of  netmail directory (or  LAN-connected
  353.  nodes)
  354.  
  355. EXMSGRM
  356.  If may be deleted original exported messages from folders
  357.  of users with PATH specification or from unkmail folder.
  358.  
  359. TRACKER
  360.  If may be rerouted messages for users specified in our user
  361.  file, but not for our address.
  362.  
  363. {+} means: this function is  available  only  in  registered
  364.            versions
  365.  
  366.                          - 7 -
  367.  
  368.  For your information: Valid values for binar variables (eg.
  369.  COPYATT, FASTMOD, FROMNET, FROMUNK, EXMSGRM and TRACKER) are
  370.  ON  or YES if you want enable future of this function, and
  371.  OFF  or NO if you want disable it.
  372.  
  373.  
  374.  Appendix B █
  375.  ▀▀▀▀▀▀▀▀▀▀▀▀
  376.  
  377.  Command line switches of Failmail:
  378.  
  379.  /?           displays help screen
  380.  /CFG:        explicit path to configuration file
  381.  /USR:        explicit path to user list file
  382.  /NX          do not export messages from unlisted users
  383.  /NY          do not export messages from listed users
  384.  /NM          do not move messages to unknown users
  385.  /NT          do not track messages
  386.  /FAST        fast mode (not available now)
  387.  /NORM        normal mode (now used allways)
  388.  
  389.  
  390.  Appendix C █
  391.  ▀▀▀▀▀▀▀▀▀▀▀▀
  392.  
  393. Trademarks:
  394.  
  395. AllFix is a trademark of Harald Harms
  396.  
  397. Borland  C++,  Turbo  Assembler   and  Turbo  Debugger   are
  398. trademarks of Borland International
  399.  
  400. d'Bridge is a trademark of Chris Irwin
  401.  
  402. DESQview and QEMM are trademarks Quarterdeck Office  Systems
  403. Inc.
  404.  
  405. DR-DOS and Novell DOS are trademarks of Novell Inc.
  406.  
  407. FidoNet is a trademark of Tom Jennings, Fido Software
  408.  
  409. FrontDoor is a tredemark of Joachim Homrighausen
  410.  
  411. GoldEd is a trademark of Odinn Sorensen
  412.  
  413. IBM, IBM PC, IBM OS/2, PC-DOS and Warp are trademarks of IBM
  414. Corp.
  415.  
  416. Intermail  is  a  trademark  of  Peter  Stewart,   InterZone
  417. Software
  418.  
  419. MAT is a trademark of Cybex s.r.o.
  420.  
  421. MS-DOS and Windows NT are tredemarks of Microsoft Corp.
  422.  
  423. T-Mail is a trademark of Andy Elkin