home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / mwrite07 / mwriter.doc next >
Text File  |  1993-01-23  |  7KB  |  227 lines
  1. MWRiTER v.7                    © 1992 Martin Budsjö
  2.             The manual.
  3. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4.   Intro.
  5.  
  6. A bird? A plane? No, it's MessageWRiTER
  7.  
  8. MWRiTER is a standalone, external, batchdriven, nonuserfriendly message
  9. poster. It reads a file and adds it to any QBBS compatibel message area.
  10. The input file does not need special editing before posting, the cmd line
  11. needs though. :-)
  12.  
  13. Why?
  14.  
  15. I allways wanted to make some type of automatic message poster to mail
  16. comments to my users. This program makes it possible to easily write 
  17. other programms that just creates the messages and then uses MWRiTER 
  18. to mail them! Nice eh?
  19.  
  20. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  21.   Config file finding.
  22.  
  23. The MWRiTER.CFG file must be located in the ~ (curr dir) or ~/CONF or $QBBS 
  24. or $QBBS\CONF folder. ( $ stand for environment variabel.) 
  25.         WARNING: If there is files both in $QBBS folder an 
  26.              in ~ the later will be used.
  27.  
  28. o    Configuration reading is preformed accumulative in 
  29.     the folowing order:
  30.     1st    $QBBS\MWRiTER.CFG 
  31.     2nd        $QBBS\CONF\MWRiTER.CFG 
  32.     3rd            Commandline.
  33.  
  34. o    If the $QBBS is not set, $QBBS will be ~.
  35. o    AREAS.BBS file is scanned if the $MAILER or $BINKLEY is set
  36.     and AREAS.BBS if found.
  37. o    Writing an entrie in the MWRiTER.CFG file works as a default 
  38.     value. It may be overwritten by the same entrie on the 
  39.     commandline.
  40.  
  41. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42.   Configfile _&_ commandline entries.
  43.  
  44. Rules.
  45.  
  46. o AB=ab Eentries may be in upper or lower case letters.
  47. o 12 21    Entries in any order. 
  48. o     Configuration info may be in MWRiTER.CFG or in the cmd line.
  49. o     All entries MUST be defined. Exclude  -Vy -Rnr -Anr entries.
  50.     
  51. o  " "    All _entries_ is ended with " " (space)
  52. o  REM    _NO_ remarks, only entries in MWRiTER.CFG file. 
  53. o  str    Strings    is " " (space) ended OR is surrounded with ", ', /, $, ! signs.
  54.         ex valid strings:    "Martin Budsjo"
  55.                     /Martin "SYSOP" Budsjo/
  56.         ex nonvalid strs:    Martin Budsjo        (is 2 strings)
  57.  
  58. o  nr    Numbers is any number. 
  59.     Different entries have different max/min values.
  60. o    The {} signs surrounds optional entries.
  61.  
  62.  
  63. Entries.
  64.   Address information.
  65.  
  66.     Entry        Name        Description
  67.     -OZnr        OrginZoneNumber    Your Mailers ZONE number
  68.     -ONnr        OrginNet..    - - | | - -  NET number
  69.     -OOnr        OrginnOde..    - - | | - -  NODE ...
  70.     -OPnr        OrginPoint..    - - | | - -  POINT ...
  71.     -DZnr        DestZone..    Well,you'll figure the rest out.
  72.     -DNnr        ...
  73.     -DOnr        ....
  74.     -DPnr
  75.  
  76.     Ex: 2:203/109.1 makes: -OZ2 -ON203 -OO109 -OP1
  77.  
  78.  
  79.   To,From,Subject info
  80.  
  81.     Entry        Name        Description
  82.     -Fstr        FROM        Mail is from...
  83.     -Tstr        TO        Mail is to..
  84.     -Sstr        Subject        Mail is about.
  85.     {-Astr,str,...}    Attributes    Mail have attributes as...
  86.             attr.    Local    Message entered localy (default)
  87.                 Private    Private message.
  88.                 Sent    Message is sent.
  89.                 Deleted    Message is marked for deletion.
  90.                 Crash    Message should be CRASH mailed.
  91.                 Recvd    Message is recived by the "to" user.
  92.                 File    Message have a file attached.
  93.                 Fwd    Message is forwarded.
  94.                 Unknown    Message have a unkown destination.
  95.                 K/S    Message is to be killed when sent.
  96.                 Hold    Message to be held for pickup.
  97.  
  98.     ex: To post a letter to "User Rookie" from "MWRiTER" about
  99.         "This is great". 
  100.         -FMWRiTER -T'User Rookie' -S"This is great"
  101.  
  102.  
  103.   Other entries:
  104.  
  105.     Entry        Name        Description
  106.     -Mnr        Msgs base    The number of the messagebase
  107.                     to use.
  108.     -Nstring    Msgs basename    The name listed in areas.bbs file
  109.                     for the area to write msgs in.
  110.                     This keyword have priority over
  111.                     the -M keyword. This keyword forces
  112.                     the use of path from the AREAS.BBS
  113.                     file instead of the -P keyword.
  114.     -Pstring    Msgs.Path    Path to all the *.MSG & *.HDR
  115.                     files. (if -N is not used...)
  116.     {-Vyes}        Verbose mode    Writes a sickening amount of data
  117.                     on screen when executing.
  118.                     Includes a binary print of the 
  119.                     errorlevel.
  120.                     (yes i know, it's stupid to
  121.                       have options on toggels....)
  122.     {-Rnr}        Relpy nr    Message is a reply to msgs nr.
  123.     filename    Inputfile    File to be posted.
  124.     
  125.  
  126. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  127. Syntax.
  128.     For use with the AREAS.BBS file:
  129.  
  130. MWRiTER -OZnr -ONnr -OOnr -OPnr -DZnr -DNnr -DOnr -DPnr 
  131.     -Tstr -Fstr {-Astr} -Sstr -Nstr {-Rnr} {-Vyes} filename
  132.  
  133.     Without the AREAS.BBS file:
  134. MWRiTER -OZnr -ONnr -OOnr -OPnr -DZnr -DNnr -DOnr -DPnr 
  135.     -Tstr -Fstr {-Astr} -Sstr -Mnr -Pstr {-Rnr} {-Vyes} filename
  136.  
  137. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  138. Errorlevels.
  139.  
  140. Error sheet    Bit      Error
  141.            0    Non-valid msg base number. (not number,or zero)
  142.            1    Unkown attr. flag.
  143.           2    No infile defined, or infile not found.
  144.         3    Orgin       address not properly defined.
  145.         4       Destination ---------   |   |  ---------
  146.         5    Undefined error. 
  147.         6    MSGS path not defined
  148.         7       TO        --- | | ---
  149.         8       FROM      --- | | ---
  150.         9       SUBJECT      --- | | ---
  151.           10-15     Not used.
  152.     
  153.     Errorlevel 0 stand for OK, others NOT OK.
  154.     If errors is detected and MWRiTER exit whit errorlevel > 0
  155.     The message base is not opend or changed in any way if MWRiTER
  156.     finds any errors.
  157.     Errorlevels below 0 means something realy went wrong.
  158. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  159. Disclaimer:
  160.         If any data own by you is harmed or in any other way
  161.         corrupted as a result of this software, 
  162. > > > > > > >    i will take NO respoibility for anything. < < < < < <
  163.  
  164. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  165. Bugg reports.
  166.  
  167. Send it all to;
  168.     Fidonet:    Martin Budsjo 2:203/109.1
  169.        NeST:    Martin Budsjo 90:1101/107.0
  170.     FujiNet:    Martin Budsjo 7:104/0.0
  171.        InterNet:    marbud@u14001.skm14.svskt.se
  172.      
  173. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  174. ~~~~~~~~~~~~~~~~~~~~~~~~ Exampel config follows ~~~~~~~~~~~~~~~~~~~~~~~~
  175. -OZ2
  176. -ON203
  177. -OO109
  178. -OP1
  179.  
  180. -DZ0
  181. -DN0
  182. -DO0
  183. -DP0
  184.  
  185. -M100
  186. -Pe:\qbbs\msgs\
  187. -VYes
  188. -FMWRiTER
  189. ~~~~~~~~~~~~~~~~~~~~~~~~~ End of exampel config ~~~~~~~~~~~~~~~~~~~~~~~~
  190. This config forces you to put the -Tstr -Sstr in the cmdline at least.
  191.  
  192. It puts all messages in area nr 100. 
  193. All letter comes from 2:203/109.1 (hey! that's,me!)
  194. And they are all going to 0:0/0.0 (nowhere.. (Local) )
  195. Messagebase is in the folder e:\qbbs\msgs\. (*.MSG & *.HDR files)
  196. Verbose mode is on.
  197. Default from string is MWRiTER
  198.  
  199. Remember! all entries in MWRiTER.CFG file is just defaults.
  200. There is only one entrie that propably not may be defined in the .CFG
  201. file. The filename.           ^^^^^^^^ (never tested.)
  202.  
  203.  
  204.  
  205. Have fun!
  206.  
  207.  
  208. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Known Bugs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  209.  
  210. The -A entrie only sets the mail attribute. Mwriter does not support
  211. attached files or any other strange things.
  212.  
  213. Mwriter is only tested with my setup to this date, but it should work just
  214. fine in any QBBS/BINKLEY compatibel environment.
  215.  
  216. Mwriter is written with GFAbasic vers < 4.0, it's probably not NICE to MiNT
  217. or MTOS etc etc.
  218.  
  219. ~~~~~~~~~~~~~~~~~~~~~~~~~~~ BuggReports & Cash ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  220.  
  221.  
  222. Martin Budsjö    Sysop Look - NoHands BBS  2:203/109.1 @ fidonet.org
  223.                     marbud@u14001.skm14.svskt.se
  224.                      90:1101/107.0 @ nest.ftn
  225.                       7:104/0.0 @ FujiNet.ftn
  226. <EOM
  227.