home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / mpostp11.zip / MPOST.DOC < prev    next >
Text File  |  1993-01-17  |  17KB  |  372 lines
  1.  
  2.   ┌──────────────────────────────────────────────────────────────────────────┐
  3.   └───────────────────────────── M S G P O S T ──────────────────────────────┘
  4.  
  5.                       Fidonet/Squish Message Base Writer
  6.  
  7.                   MsgPost/2 Version 1.10 - 5th December 1992
  8.  
  9.  
  10.         (C) Copyright 1992 by CodeLand Australia, All Rights Reserved
  11.                        Colin Wheat - 3:690/613@fidonet
  12.  
  13.                  MsgPost is an MsgAPI Level Zero Application.
  14.                 Squish MsgAPI, revision 0.0 by Scott J. Dudley
  15.  
  16.    "Squish", "SquishMail" and "Maximus" are trademarks of Scott J. Dudley.
  17.  
  18.   ┌──────────────────────────────────────────────────────────────────────────┐
  19.   └─ INTRODUCTION ───────────────────────────────────────────────────────────┘
  20.  
  21.     MsgPost  takes a supplied text file and converts it into a message
  22.     in your message base. Base formats supported are Fidonet  (*.MSG),
  23.     and the new  Maximus-CBCS Squish format.   Netmail,  Echomail  and
  24.     Local area messages are possible. MsgPost also includes an inbuilt
  25.     message splitter for large text postings.  MsgPost had the ability
  26.     to batch post messages from an optional text file names list file.
  27.  
  28.     Operator  control  is  by  both  the command line, and an optional
  29.     configuration  file.   The  default  configuration  file  name  is
  30.     MPost.Cfg.   Use  the  -C  command  line  option to operate with a
  31.     different name, or  to  allow  multiple  configuration  files  for
  32.     different  tasks.  Under DOS v3.xx and above MsgPost looks for the
  33.     default  configuration  file  in  the  directory  the   executable
  34.     resides.  The default directory  is used for earlier DOS versions.
  35.  
  36.     MsgPost automatically generates multiple "split" messages when the
  37.     input  text  file  exceeds  the  preset  limit.   Use  the  Split:
  38.     configuration file verb  or the -S command line command to set the
  39.     maximum message size.  Splitting can be turned off by using a zero
  40.     setting.  E.g. "-S0".   The  splitter adds a ^ASPLIT  kludge line,
  41.     as  documented  in  the   Fidonet  standards  proposals   document
  42.     FSC-0047.* by Pat Terry of 5:494/4.101.  Note that the  UUCP "To:"
  43.     line  is not yet supported  as it  would  clash  with the  MsgPost
  44.     configuration "To:" verb.
  45.  
  46.   ┌──────────────────────────────────────────────────────────────────────────┐
  47.   └─ COMMAND LINE CONTROLS ──────────────────────────────────────────────────┘
  48.  
  49.     Normal usage would have most settings in the default configuration
  50.     file.  The only required command line item is the -T<name> switch,
  51.     which specifies the path and name of the input text file.  Also of
  52.     use  on the command line is the -C<name> switch, enabling multiple
  53.     custom  configurations.   The  other  command  line  options   are
  54.     overrides  for the settings included in the configuration and text
  55.     files.
  56.  
  57.     Syntax:  MPostP [-switch -switch ... ]
  58.  
  59.     COMMAND LINE ONLY:
  60.  
  61.     -T<Text source file path & name>
  62.     -Tmessage.txt
  63.     Text file path and name. This is the text file data for MsgPost to
  64.     write in message format. Full path and name is possible up to 80
  65.     characters. If no message text is required, for example in the
  66.     case of file attaching, use '-T' on the command line, with no name
  67.     appended.
  68.  
  69.     -K
  70.     Delete source text file after processing.
  71.  
  72.     -C<Configuration file path & name>
  73.     -Cmpost.cfg
  74.     The configuration file path and name for MsgPost to load. The
  75.     default name is MPost.Cfg in the executable directory.
  76.  
  77.     -@<List file name>
  78.     -@mpost.lst
  79.     Run in List mode. This tells MsgPost to read a text file list of
  80.     names to which to post the output message(s). Format of the name
  81.     list file is one name per line. The message destination address
  82.     can also be listed after the name entry, in which case a comma is
  83.     required, and netmail mode is forced. <name> is optional, the
  84.     default text file name being "MPost.Lst".
  85.  
  86.     Example list file format:
  87.     Colin Wheat
  88.     John Dennis,    3:690/668
  89.     Lincoln Dale,   3:690/626@fidonet
  90.  
  91.     -?
  92.     Program help screen.
  93.  
  94.  
  95.     CONFIGURATION OVERRIDES:
  96.  
  97.     -M<Message area path & name>
  98.     -Md:\msg\net
  99.     This  can  be either a *.MSG base directory path, or the full path
  100.     and name of a Squish base. To indicate a squish format, use a
  101.     leading '$' character in the path.  e.g. "-M$d:\msg\chat" would
  102.     indicate a Squish base, "-Md:\msg\chat" a *.MSG base. This setting
  103.     overrides "Area:" entries in the configuration and text files.
  104.  
  105.     -N[Zone:]Net/Node[.Point][@Domain]
  106.     -N3:690/626
  107.     Create a Netmail message with listed destination address.
  108.  
  109.     -O[Zone:]Net/Node[.Point][@Domain]
  110.     -O3:690/613
  111.     Message origin address. Use this to specify an origin address
  112.     where either a configuration or text file 'Address:' setting is
  113.     not used, or for a message origin address different from the
  114.     configuration "Address" verb's system address.
  115.  
  116.     -P<c|f|h|d|k|p|r|u|l>
  117.     -Pp
  118.     Message priority flag(s). Optional flags for the created message.
  119.     It's possible to use multiple -P calls, or to chain the letters
  120.     together should you require more then one. e.g. "-Pp" would turn
  121.     on the private flag. "-Ppk" would create a private killsent
  122.     message. Listed below are each of the flag types:
  123.  
  124.     C - Send Crash
  125.     F - File attach (fully pathed filename must be in message SUBJECT
  126.         line).
  127.     H - Hold for pickup
  128.     D - Send Direct
  129.     K - Kill after sending
  130.     P - Private
  131.     R - File Request (requested filename must be in message SUBJECT
  132.         line).
  133.     U - File Update Request (requested filename must be in SUBJECT
  134.         line).
  135.     L - Turn OFF the local flag. This flag defaults on. Don't use this
  136.         unless specifically required.
  137.  
  138.     Note that setting either C or H flags will toggle the other flag
  139.     off.
  140.  
  141.     -F<Message addressed to first name>
  142.     -FArthur
  143.     "-FSimon Blears"
  144.     Message addressed to first name, or name. "-F<fname>" and
  145.     "-L<lname>" would normally be used together, and enable use of
  146.     MsgPost from online programs, such as Maximus itself. It's also
  147.     possible to use '-F' without the '-L' command to specify the
  148.     complete name, as in the example below. Note the use of the "
  149.     characters to embedd the space character(s), as required for the
  150.     MS-DOS command line.
  151.  
  152.     MPostP.Exe -Tmessage.txt "-FSimon Blears"
  153.  
  154.     -L<Message addressed to last name>
  155.     -LMarsh
  156.     Message addressed to last name. MsgPost uses <fname> and <lname> to
  157.     build the To: field for the generated message. Here's a mecca
  158.     display file example call for Maximus, which might be used for tasks
  159.     such as posting a welcome message from the Sysop to new users:
  160.  
  161.     [xtern_run]MPostP.Exe -Tc:\max\newuser.txt -F%f -L%l
  162.  
  163.     -W<Message addressed from name>
  164.     -WColin_Wheat
  165.     Message addressed from name, up to 35 characters. Space characters
  166.     cannont be included, use the underline character '_' as a
  167.     substitute.
  168.  
  169.     -J<Message subject>
  170.     -JMaximus_Utilities_Listing
  171.     Message subject text, up to 71 characters. this overrides any
  172.     configuration file or text file "Subj:" entries. The MsgPost default
  173.     subject is the string "Automated Posting". Unlike configuration or
  174.     text file settings, white space is not allowed on the command line.
  175.     Use a format such as: "-JMy_Subject". Use underscore characters
  176.     where you require spaces. MsgPost will convert underscore characters
  177.     to spaces.
  178.  
  179.     -S<##>
  180.     An override for the configuration file 'Split: <###>' option, -S[##]
  181.     sets the maximum message size in kilobytes for message splitting.
  182.     Range is from 0 to 16. Using a value of 0 turns off splitting. In
  183.     this case MsgPost loads up to 16Kb from the input text file,
  184.     ignoring any extra text from the file. The default split maximum is
  185.     12Kb, a value which is probably safe with most of today's existing
  186.     mail processers. You may want to use a setting such as -S8,
  187.     producing split messages up to 8Kb in size.
  188.  
  189.   ┌──────────────────────────────────────────────────────────────────────────┐
  190.   └─ CONFIGURATION FILE ─────────────────────────────────────────────────────┘
  191.  
  192.     MsgPost is able to load information from a configuration file, the
  193.     default  name  being MPost.Cfg.  This  can be  changed with the -C
  194.     command line command.
  195.  
  196.     Note that for convienence, all of these can appear at the  top  of
  197.     the  message  text file. Settings placed in the text file override
  198.     the configuration file. You may wish to place your system address,
  199.     origin, and from name in the configuration file, and  include  the
  200.     To,  and  subj  fields  in each particular text file.  I'd suggest
  201.     having all fields in  the  configuration  file  as  defaults,  and
  202.     override these with entries in the text files where necessary.
  203.  
  204.     Address: [Zone:]Net/Node[.Point][@Domain]
  205.     Address: 3:690/613
  206.     Your system address, required for all operations. For posting
  207.     messages from 'aka' addresses, see the -O command line option.
  208.  
  209.     Origin: <Your system echomail identification>
  210.     Origin: Perth's Library BBS =AUSTRALIA=
  211.     Echomail only origin line. If no origin line is set in either the
  212.     configuration file or the import text file MsgPost attempts to
  213.     read the message area ORIGIN. file assuming an Echomail format
  214.     message is being generated. For Squish message areas, the name
  215.     <body_name>.SQO is searched for.
  216.  
  217.     Area: <Message area path & name>
  218.     Area: d:\msg\net
  219.     The message area path. Indicate a Squish format area by use a
  220.     leading '$'character. This is the path, and for Squish areas the
  221.     name of the message base, into which MsgPost will write the
  222.     generated messages. Only one entry or area is supported.
  223.  
  224.     Netmail: [Zone:]Net/Node[.Point][@Domain]
  225.     Netmail: 3:800/812
  226.     Create a Netmail message, to destination address. This option
  227.     tells MsgPost to create the generated message(s) in Netmail
  228.     format, and specifies the destination address. 5d addresses are
  229.     supported.
  230.  
  231.     MsgType: <Echomail | Conference | Local | Matrix>
  232.     MsgType: Echomail
  233.     'MsgType: <Type>' specifies the type of message to create.
  234.     Available types are Echomail, Conference, Local, and Matrix.
  235.     Echomail is the default type when nothing is specified. The
  236.     Conference type is similar to Echomail, but uses a PID kludge line
  237.     and no tear or Origin line in the generated message. Local
  238.     messages are also similar to Echomail, without the Origin and
  239.     SeenBy lines or PID kludge line. Matrix is the netmail format,
  240.     also activated by providing a netmail destination address, via
  241.     either the 'Netmail:' configuration verb or the -N command line
  242.     option.
  243.  
  244.     To: <Some Name>
  245.     To: All
  246.     The message TO field.
  247.     The To: field for the generated message(s). This command is not
  248.     required, the default is to "All". For List mode this field is
  249.     ignored.
  250.  
  251.     From: <Your Name>
  252.     From: Colin Wheat
  253.     The 'From:' option indicated the message(s) From: field. Also not
  254.     required, the default being "MPost/2 v1.10".
  255.  
  256.     Subj: <Your Subject>
  257.     Subj: Text files to *.MSG and Squish bases
  258.     The SUBJECT field of the message. Subj:' is the option that tells
  259.     MsgPost the generated message(s) subject line. Not required, the
  260.     default is "Automated Posting".
  261.  
  262.     Attr: <c|f|h|d|k|p|r|u|l>
  263.     Attr: pk
  264.     Optional  message attributes. The 'Attr:' option enables setting
  265.     of most of the generated message(s) attributes. These include
  266.     c,f,h,d,k,p,r,u, and l.
  267.     C - Send Crash
  268.     F - File attach (fully pathed filename must be in message SUBJECT
  269.         line).
  270.     H - Hold for pickup
  271.     D - Send Direct
  272.     K - Kill after sending
  273.     P - Private
  274.     R - File Request (requested filename must be in message SUBJECT
  275.         line).
  276.     U - File Update Request (requested filename must be in SUBJECT
  277.         line).
  278.     L - Turn OFF the local flag. This flag defaults on. Don't use this
  279.         unless specifically required.
  280.     Note that setting either C or H flags will toggle the other flag
  281.     off.
  282.  
  283.     FakeNet: <###>
  284.     FakeNet: 6130
  285.     The 'FakeNet:' option specifies the fakenet for point systems.
  286.     Normally not a requirement for 4D points, this may reduce problems
  287.     with MsgPost's default SEENBY addition. See also the 'NoSeenBy:'
  288.     configuration option.
  289.  
  290.     NoSeenBy:
  291.     NoSeenBy:
  292.     The 'NoSeenBy:' command turns off the addition of a SEENBY line
  293.     listing the message origin address, for Echomail messages.
  294.  
  295.     Split: <###>
  296.     Split: 8
  297.     'Split: <###>' sets the maximum message size in Kilobytes for
  298.     message splitting. Range is from 0 to 16. Using a value of zero
  299.     turns off splitting, in which case MsgPost loads up to 16Kb from
  300.     the input text file, ignoring any extra text from the file. The
  301.     default split maximum is 12Kb, a value which is probably safe with
  302.     most today's existing mail processers. Recommended setting is 8Kb,
  303.     producing split messages to 8Kb in size each.
  304.  
  305.   ┌──────────────────────────────────────────────────────────────────────────┐
  306.   └─ ERROR LEVELS ───────────────────────────────────────────────────────────┘
  307.  
  308.                         0 - Normal exit
  309.                         1 - Syntax exit
  310.                         2 - Out of memory
  311.                         3 - Configuration or text file not found
  312.                         4 - No system address set
  313.                         5 - Message base open failed
  314.                         6 - Names list file not found
  315.  
  316.   ┌──────────────────────────────────────────────────────────────────────────┐
  317.   └─ MESSAGE SPLITTING AND SIZE LIMITS ──────────────────────────────────────┘
  318.  
  319.     Most Fidonet mail processers impose a maximum message size,  for a
  320.     variety of reasons.  Because of  this  limit  MsgPost includes the
  321.     ability  to  automagically  split  large text files  into multiple
  322.     messages.  I've not researched the limits for all, or even most of
  323.     of the mail processers currently in use world wide. However it has
  324.     been  discussed  in  a  National  development  conference.  Listed
  325.     below are what was suggested.  Thanks to David Nugent for these:
  326.  
  327.     Squish      16K for v1.01. Later versions may allow higher values.
  328.     TosScan     38K
  329.     QMail       16K
  330.     D'Bridge    48K (Echomail only)
  331.     Confmail   ~14K (higher produces bogus output)
  332.  
  333.     MsgPost defaults to a ~12Kb maximum message size,  however  allows
  334.     up to ~16Kb by use of the Split configuration verb  or the  -S[##]
  335.     command line option.  Note that  using the larger sizes  may break
  336.     some mail processers, and is not recommended.
  337.  
  338.   ┌──────────────────────────────────────────────────────────────────────────┐
  339.   └─ DISTRIBUTION ───────────────────────────────────────────────────────────┘
  340.  
  341.     MsgPost should be considered "Post Card Ware". If you continue to
  342.     use the executable  you are required  to send a  postcard to  the
  343.     Author at the address below.  This is the only way the Author can
  344.     justify putting  further time into the  package.  The C source is
  345.     included in the distribution archive.  The Author requests you do
  346.     NOT  release  modified  versions under the  MsgPost name.  Please
  347.     consider  sending any  code modifications or  improvements to the
  348.     Author at the Fidonet address  listed below,  so that they may be
  349.     considered for inclusion in later MsgPost version releases.
  350.  
  351.     CodeLand Australia
  352.     P.O.Box 351
  353.     Kalamunda W.A. 6076
  354.     AUSTRALIA
  355.  
  356.     The Author can be contacted by Fidonet Netmail at 3:690/613, and
  357.     via   international  Echomail   in  the   Maximus-CBCS   support
  358.     conferences Muffin and MaxDev.
  359.  
  360.   ┌──────────────────────────────────────────────────────────────────────────┐
  361.   └─ REGISTERED USERS ───────────────────────────────────────────────────────┘
  362.  
  363.    MSGPOST v1.00 was released on 5th December, 1991. Registration is
  364.    simply gained by sending a postcard to CodeLand Australia.
  365.  
  366.    Alberto Pasqvale of 2:3321/504.1
  367.    Arthur Marsh of 3:800/812
  368.  
  369.   ┌──────────────────────────────────────────────────────────────────────────┐
  370.   └──────────────────────────────────────────────────────────────────────────┘
  371.  
  372.