home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / MSQ2-204.ZIP / MSGEDSQ.DOC < prev    next >
Text File  |  1992-02-04  |  16KB  |  400 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                             Msgedsq v2.0.4
  8.  
  9.  
  10.                 FTSC & Squish Compatible Message Editor
  11.  
  12.                   Copyright (c) 1991-92, John Dennis
  13.  
  14.  
  15.        Written originally by Jim Nutt, modifications by John Dennis
  16.  
  17.                Squish MsgAPI Copyright (c), Scott Dudley
  18.                  Spawnl Code Copyright (c), Ralf Brown
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.            As this is a *free* editor, support is not feasible, nor will
  26.       any be given.  Use this program at your own risk; the author(s)
  27.       will NOT be held responsible for ANY damage that *may* have been
  28.       caused directly, or indirectly, from the use of this program.  It is
  29.       not even guaranteed to occupy space on the media you choose to place
  30.       it on :-)
  31.  
  32.       Having said that, see the end of this document for what support I
  33.       will attemp to give, given time and inclination (Hey, I can have a 
  34.       bad day too!).
  35.  
  36.            This program is *free* for all use.  If you wish to distribute
  37.       copies to other people, NO fee may be charged. The exception to this
  38.       is delivery costs and the fee some Bulletin Boards charge for access.
  39.       Distributed copies may differ only in the archiver used -- you MUST
  40.       include all the files that came with the original archive.  You can
  41.       do what you like with the copy you intend to use.
  42.  
  43.            A Note: This used to be a "Public Domain" editor; but because
  44.       parts of the executable are (c) Copyrighted by other parties, this is
  45.       NOT possible anymore.  It is free, and I intend it to stay that way.
  46.       (Plus this stops someone taking bits of it and selling them for profit -
  47.       unlikely, but you never know :-).
  48.  
  49.  
  50.  
  51.  
  52.                           I n s t r u c t i o n s
  53.  
  54.           Since this editor is descended from Msged, I will assume you
  55.       already know how it works in general. If you haven't ever used it
  56.       before this, get a copy of the Msged by Jim Nutt and read the docs
  57.       in there.  This manual discusses the differences/additions to the
  58.       original Msged.
  59.  
  60.          I have attempted to produce a stable editor,  fixing many of
  61.       the bugs (IMO) that still exist in the process.  BUT, this IS a
  62.       gamma version, and therefore you may be taking extra risks by
  63.       running this program.
  64.  
  65.           To run this program you need approx. 170k, preferably 200k
  66.       plus an EGA/VGA card.  As this program is designed to run in a
  67.       multi-tasking environment, a 100% compatible IBM is probably a
  68.       good idea.  You will also need DOS 3.3 and above for all the file
  69.       sharing to work.  You most definitely need to run share.exe if you
  70.       plan to run it in a multi-tasking environment.
  71.  
  72.  
  73.                             a d d i t i o n s
  74.  
  75.              ■  Share support has been added to all area types.
  76.              ■  Qbbs support died an ignominious death.
  77.              ■  Memory usage reduced drastically.
  78.              ■  Echomail conventions (^aMSGID) properly supported.
  79.              ■  Multiple uplink support for Squish MsgBases.
  80.              ■  Editor bugs fixed (hopefully).
  81.              ■  Reply in Other area function added.
  82.              ■  Option added to save last-read or highest read
  83.                 pointer.
  84.              ■  Added "-p<node>" support for areas.bbs file.
  85.  
  86.  
  87.  
  88.                          S q u i s h   S u p p o r t
  89.  
  90.  
  91.              The entire reason for the creation of this program is to
  92.       (hopefully :) provide support for the new MsgBase format used by
  93.       Maximus-CBCS.  This MsgBase provides us with greater flexibility
  94.       and safety over other formats (eg. Hudson & fido),  plus many
  95.       other features.
  96.  
  97.              You can enable squish support for an area in a number of
  98.       ways; the simplest is to substitute the "fido" declarations in
  99.       the config file with "squish".  The format is exactly the same as
  100.       fido declarations; the MsgBase type, followed by default Msg
  101.       flags, followed by the path to the MsgBase path and then the
  102.       EchoMail tag (if it's an echomail area). Ie:
  103.  
  104.  
  105.  
  106.       MsgBase Area Fla Description               Path             Tag
  107.               Type gs
  108.       ------  ---- --- ------------------------- ---------------- --------
  109.       fido    echo     "muffin, maximus support" d:\mail\muffin   muffin
  110.       squish  echo     "tub, squish support"     d:\mail\tub      tub
  111.       squish  echo p   "r55 mail"                d:\mail\r55_mail local
  112.  
  113.  
  114.           You can also use your areas.bbs file to define squish areas:
  115.       simply precede squish areas with the '$' character.  SquishMail
  116.       will understand this flag. Ie:
  117.  
  118.            $d:\mail\tub         tub       3:690/626
  119.            d:\mail\r55_mail     r55_mail
  120.            #d:\mail\blah        blah
  121.  
  122.  
  123.       NOTE:  When defining the path for a squish area, you MUST specify
  124.              the base name of the squish area.  That is, the whole path
  125.              name minus the extension.  If the area does not exist as
  126.              the path specified, it will be CREATED. (It won't be if
  127.              there are intervening directories not created in the
  128.              specified path).
  129.  
  130.  
  131.           If you are running share.exe then full file sharing with
  132.       squish *and* fido MsgBases is supported.  I would recommend you
  133.       re-scan the Area periodically if other users are entering Msgs;
  134.       Msgedsq keeps an internal list of Msgs in the MsgBase.
  135.  
  136.           The existence of a <basename>.sqo file will cause Msgedsq to
  137.       read it's contents and insert them into the origin line for that
  138.       area.  Please keep the size down so it will fit on one line (the
  139.       address and " * Origin:" will be inserted for you).
  140.  
  141.           A real BIG bonus is support for multiple uplinks for each Msg
  142.       in the MsgBase.  As of this writing, there are no linkers that link
  143.       squish MsgBases in this manner (in public release), but expect some
  144.       in the near future.  Maximus does support this in local areas, so
  145.       you can try it on those areas to see how it looks.  This support is
  146.       on automatically for all squish areas (fido *.msgs don't have support
  147.       for this).  When reading areas linked in this manner, you will see on
  148.       the msg header at the top of the screen:
  149.  
  150.                      2045 33 34 55 445 4 56 44 56 45
  151.  
  152.                 (there is a maximum of 10 replies to any msg)
  153.  
  154.           You can type the msg number you want to go to, or you can use
  155.       the link-to to function (<ctrl>-right arrow); in which case a
  156.       small menu will appear on the right hand side of the screen.
  157.       Just pick the msg you wish to go to.
  158.  
  159.       NOTE:    If there is only one uplink, the menu won't appear.
  160.                Also, if the MsgBase hasn't been linked with this
  161.                support, it will work exactly the same as the fido
  162.                areas.
  163.  
  164.  
  165.  
  166.  
  167.               M u l t i p l e - N e t w o r k     S u p p o r t
  168.  
  169.  
  170.           Msgedsq does it's best to support multiple networks, if you
  171.       follow these simple rules, you should have no trouble.  The first
  172.       thing you will want to be able to do is enter messages in an echo
  173.       area while still getting the correct ^aMSGID and origin line
  174.       address.  To do This you must specify a default address for each
  175.       echomail area that is going to be different to your primary
  176.       address.    "What is my primary address?"  Your primary address
  177.       is the FIRST address you specify in your config file.
  178.  
  179.           You can specify as many addresses in the config file as you
  180.       like, They will generally be ignored, except when you want to
  181.       change the address for any area (usually the netmail area);
  182.       excepting the primary address which MUST be specified (or
  183.       unpredictable results may follow).
  184.  
  185.  
  186.       EchoMail
  187.  
  188.  
  189.           Each echomail area will use the primary address unless
  190.       another address is specified.    This can be done in two ways; in
  191.       the config file, or in the areas.bbs file, viz:
  192.  
  193.            msged.cfg
  194.  
  195.            squish echo "tub, squish support" d:\mail\tub tub 51:6234/1
  196.  
  197.            areas.bbs
  198.  
  199.            $d:\mail\tub  tub -p51:6234/1 51:6234/2 51:6234/17
  200.  
  201.            The first case is fairly obvious, but note that the echomail
  202.       tag MUST be before the address.  In the second case, the "-p"
  203.       stands for primary address and MUST also be after the tag.  The
  204.       Squish Conference processor by Scott Dudley also supports the
  205.       "-p" switch.  The address does not have to be one of your aka's,
  206.       so be careful.
  207.  
  208.              In either case, the actual MsgBase format used does not
  209.       matter; BUT remember that this format ONLY applies to echomail
  210.       areas.  Msgedsq will use this address to create your ^aMSGIDs
  211.       and origin lines. You can change the address to one of your Aka's
  212.       by using the <ctrl>-w function (but remember you have to change
  213.       it back yourself), see the section on new config verbs for usage.
  214.  
  215.  
  216.  
  217.       NetMail
  218.  
  219.           Because the netmail areas (you can have more than one) use
  220.       the primary address by default, you must remember to change
  221.       address when entering mail from another net (or whatever).  This
  222.       will ensure that msgs entered locally will have the right origin
  223.       address and ^aMSGID.  Again, you can change the current address
  224.       by using the <ctrl>-w function, but also remember that you have
  225.       to change it back if you want to use the old address.
  226.  
  227.           When reading messages, Msgedsq tries it's hardest to get the
  228.       origin and destination address right; it parses ^aMSGIDs and
  229.       ^aINTLs (and others) to find the correct address.  If it cannot
  230.       find the zone any-where, it will use the zone from the address
  231.       defines for the current area.  It can look weird sometimes (eg
  232.       58:690/626.4 instead of 3:690...).  Msgs addressed to you, with
  233.       an aka that has been specified, will always look right on the
  234.       screen.
  235.  
  236.       NOTE:  What you see is What you Get; the address(s) you see on
  237.              the screen is what Msgedsq think they are.  Be sure to
  238.              use the right address when replying to Msgs, or addresses
  239.              could get stuffed up.
  240.  
  241.           As a last fallback, when writing the Msg to disk the from:
  242.       address is checked and if the zone does not match the destination
  243.       zone it will try and change the from: address to one of your
  244.       aka's, it does this by checking the to: zone with all of your
  245.       from: zones.
  246.  
  247.           These days, you can probably turn off the 'gate' verb, as
  248.       most mailers handle routine without changing the destination
  249.       address.  You can do this by putting "none" after "gate".  It's
  250.       probably a good idea to experiment to make sure you are familiar
  251.       with how it works.
  252.  
  253.  
  254.  
  255.  
  256.                        N e w   C o n f i g    V e r b s
  257.  
  258.  
  259.              To support all these features I had to add a few new
  260.       config verbs.  They are all in the config file, just search for
  261.       "NEW" to find them.
  262.  
  263.  
  264.  
  265.         Chngaddr
  266.  
  267.           Chngaddr this will change the default address for *any* area
  268.       to one of your aka's.  A pick list will appear and you can choses
  269.       from that.  The cfg file distributed has this function set to
  270.       <ctrl>-w.  To set it do this:
  271.  
  272.            readkey 0x0017 chngaddr
  273.  
  274.       This will set it to <ctrl>-w (who :-).
  275.  
  276.  
  277.  
  278.       Set Switches
  279.  
  280.               This function replaces the old setup routines.  You
  281.       cannot save any changes made here,  they are only active while
  282.       the program is executing.  You can make them permanent in the
  283.       config file.  The function is assigned to <alt>-s by default, you
  284.       can redefine it by:
  285.  
  286.            readkey 0x2b00 config
  287.  
  288.       This will set it to <alt>-s
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.       RepOth
  297.  
  298.           This is for replying to a message in another area.  Links
  299.       will not be retained (because it's in another area), nor will
  300.       ^aREPLYs.  when finished it will return you to where you were.
  301.       The function defaults to <alt>-n, but can be redefined by:
  302.  
  303.            readkey 0x3100 repoth
  304.  
  305.       This defines it to <alt>-n.
  306.  
  307.  
  308.  
  309.       Showaddr
  310.  
  311.            Because you can have different addresses at any time, it is
  312.       sometimes hard to remember which one you are using, so the
  313.       current address is displayed at the top right hand corner of the
  314.       screen (minus the domain).  This feature is ON by default.  You
  315.       can turn it off by including the following in the config file:
  316.  
  317.            no showaddr
  318.  
  319.       This is actually a switch, so you can manipulate it by the
  320.       <alt>-s function during program execution.
  321.  
  322.  
  323.  
  324.       Sqlcurrent
  325.  
  326.           This is specifically for squish areas only; if you include
  327.       this in your config file then Msgedsq will store the Msg number
  328.       of the last msg you read in the squish equivalent of the lastread
  329.       file.  If this is not included, the number of the highest msg you
  330.       read will be stored.  (Actually, not the number, but the
  331.       equivalent.  Do not worry; tossing Msgs into the msgbase does not
  332.       affect this).
  333.  
  334.  
  335.  
  336.  
  337.  
  338.                                P o i n t s
  339.  
  340.  
  341.            If you're running a fakenet, set the pointnet as normal, and
  342.       any addresses not marked crash or direct will be re-addressed
  343.       using the pointnet.  (ie: the msg will be from your pointnet).
  344.       This only applies to netmail areas.  If done this way, then the
  345.       ^aMSGID will be your actual address.  You can also  define an aka
  346.       of your pointnet and use that for entering messages (and kill the
  347.       pointnet from the cfg), which you may prefer, and probably use if
  348.       you are running a fully 4D point. (that way you can write non-
  349.       crash msgs using your 4D address, and also send your areafixes as
  350.       well).  Note that a 4D areafix is due out soon...(gamma version
  351.       is available now).
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.                             C o n c l u s i o n
  359.  
  360.  
  361.           Have a look at the history.doc file for latest additions. Ok, that's
  362.       it; if you find any bugs/enhancements, please give me a yell, either by
  363.       netmail/email or echomail in the r55_prog echo area. My address is below.
  364.  
  365.       I certainly don't *promise* to do anything, but I will attempt to
  366.       fix it/them, generally speaking.  Since this is still a gamma version
  367.       I expect there will be a few bugs lurking  round :-).  PLEASE include
  368.       the version number when reporting bugs, and try to give some indication
  369.       of what you were trying to do.  Reports consisting of "It doesn't work!"
  370.       don't help matter much.  (The version number is always at the top of the
  371.       doccies and in the first screen that appears when firing up).  Also, don't
  372.       expect an immediate reply because I usually try to hostroute netmail.
  373.  
  374.       New versions will be announced in the MUFFIN echo area, along with
  375.       ways to get it.  As of this writing, the Australian src for the
  376.       newest version is Lincoln & Richard Dale @ 3:690/626@fidonet. You
  377.       can also get it in America from Edward Branley @ 1:396/10@fidonet.
  378.  
  379.       John Dennis,
  380.  
  381.       FidoNet : 3:690/626.4@fidonet.org
  382.       InterNet: john@miyu.dialix.oz.au
  383.  
  384.  
  385.  
  386.       Any Trademarks are (c) Copyright of their respective owners.
  387.  
  388.  
  389.           Thanks must go to Jim Nutt who put the Msged 2.00 src in the
  390.       public domain.  Without that src, this editor would never have been
  391.       a reality (obviously :-) and a lot of us would still be waiting for
  392.       a squish compatible editor.
  393.  
  394.           Also like to thank Scott Dudley who designed & built the squish
  395.       format, *and* he released the src code to the MsgAPI, making it real
  396.       easy to add Squish support. (and ensuring compatibility, a damn good
  397.       idea, IMO).
  398.  
  399.       /* end */
  400.