home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / MSGXP200.ZIP / MSGX.CFG < prev    next >
Text File  |  1992-03-30  |  11KB  |  257 lines
  1. ;---------------------------------------------------------------------------;
  2. ;                                                                           ;
  3. ;   MsgX Configuration File                                                 ;
  4. ;                                                                           ;
  5. ;   This file defines "default" operational behavior of MsgX.  Most of      ;
  6. ;   these parameters can be overridden using command line qualifiers.       ;
  7. ;                                                                           ;
  8. ;---------------------------------------------------------------------------;
  9.  
  10. ; ---------------------------------------
  11. ; The following commands MUST be defined.
  12. ; ---------------------------------------
  13.  
  14. ; MsgX reads Maximus's TEXT control file and/or Squish's configuration
  15. ; file to find information on Echos.
  16. ;
  17. ; Reading these text files will help keep MsgX more compatible with
  18. ; future releases of Maximus.
  19. ;
  20. ; You must at least define one of the following.  If you do not want
  21. ; it to read one of the files for echo information, put "None" in
  22. ; place of the filename, or comment the line out.
  23. ;
  24.  
  25. MaximusAreaCtl  c:\bbs\max\system\msgarea.ctl
  26.  
  27. SquishCfg       c:\bbs\squish\squish.cfg
  28.  
  29. AreasBBS        None
  30.  
  31. ;
  32. ; The work directory is used for various intermediate file creations
  33. ; and any other work files MsgX may need to create.  Please do not
  34. ; leave any of your own files in this directory as MsgX may delete them when
  35. ; it "cleans up" its mess after running.  (You see, this is a very well-
  36. ; behaved program. <g>)
  37. ;
  38. ; The size of the files in this directory depends upon the size of the
  39. ; text files being created from the message base, and whether the /append
  40. ; option has been enabled.  If /appending, MsgX will first need to
  41. ; uncompress all the files from the original archive, append any new
  42. ; entries, and then compress them again.  A RAM disk may prove helpful
  43. ; in execution speed, but also may quickly fill up due to overly large
  44. ; files.
  45. ;
  46.  
  47. WorkDirectory   c:\bbs\msgx\work
  48.  
  49.  
  50.  
  51. ; ------------------------------------
  52. ; The following commands are OPTIONAL.
  53. ; ------------------------------------
  54.  
  55. NoAppendMsgs            ; [No]AppendMsgs - Appends messages to existing
  56.                         ; text files.  Please note that you should make
  57.                         ; sure you have plenty of hard disk space before
  58.                         ; activating this option.  In order to append
  59.                         ; messages to an existing text file, MsgX must first
  60.                         ; uncompress the archive, append the messages,
  61.                         ; and then update the archive with the new file.
  62.  
  63. NoCompress              ; [No]Compress - will archive the text file of
  64.                         ; messages.
  65.  
  66. NoControl               ; [No]Control - Includes CONTROL information in
  67.                         ; the message (PATH, REALNAME, etc.)
  68.  
  69. NoKill                  ; [No]Kill - Deletes the messages after archiving
  70.                         ; them (not yet implemented)
  71.  
  72. NoQuiet                 ; [No]Quiet - Prevents output to standard out
  73.                         ; (the screen, normally) except for the logo.
  74.  
  75. RightMargin     79      ; Maximum length of the line used to word-wrap
  76.                         ; the text of the message
  77.  
  78. NoSeenBys               ; [No]SeenBys - Includes the SEEN-BYS lines in the
  79.                         ; message.
  80.  
  81. Statistics              ; [No]Statistics - will display both a daily and
  82.                         ; composite summary of messages received.  Disabling
  83.                         ; Statistics can improve time performance (slightly)
  84.                         ; and reduce the amount of memory used by MsgX.
  85.  
  86. NoUpdateFILESBBS        ; [No]UpdateFILESBBS - will update the file specified
  87.                         ; int the FILESBBS statement if this is a new archive.
  88.                         ; Note: this command is only relevant if you activate
  89.                         ; the 'Compress' command.
  90.  
  91. Write                   ; [No]Write - writes messages to the text file.
  92.                         ; The only time you may want to suppress the
  93.                         ; writing of messages is when you want a
  94.                         ; statistical summary of the echo without taking
  95.                         ; the time to actually write the messages to a
  96.                         ; text file.
  97.  
  98.  
  99. ; TextFileTitle   "Extracted Messages"  ; Normally, MsgX will create a title
  100.                                         ; header at the top of the text
  101.                                         ; file of extracted messages.  This
  102.                                         ; title is parsed from MsgArea.Ctl
  103.                                         ; (MsgInfo), or constructed from
  104.                                         ; Squish.Cfg and Areas.Bbs.  If
  105.                                         ; specified here (or on command line
  106.                                         ; as /Title), this will override
  107.                                         ; the title in all the message text
  108.                                         ; files created that run.
  109.  
  110. FILESBBS c:\max\files\echos\files.bbs   ; Path and filename used for the
  111.                                         ; BBS list file when 'Update' is
  112.                                         ; active.
  113.  
  114. ;
  115. ; If ArchiveFileName is active here, ALL message text files will be
  116. ; be put into that archive.  If you do not specify an entire qualified
  117. ; path (i.e., only the filename), then the path defined in 'Destination'
  118. ; will be used.  If 'Destination' is not defined, then the archive will
  119. ; reside in the current directory.
  120. ;
  121. ; If ArchiveFileName is not used, then then name of the archive
  122. ; will match the name of the message text file being stored in the
  123. ; archive (with a different extension, of course).  This default is only
  124. ; applicable if you specify only ONE area to archive.  If you specify
  125. ; multiple areas, the default archive name is ECHOS.<ext> in the current
  126. ; directory.  You can override this specify an archive name below, or
  127. ; using /Archive on the command line.
  128. ;
  129.  
  130. ; ArchiveFileName c:\max\files\echos\echos.zip
  131.  
  132. ;
  133. ; Logging definitions
  134. ;
  135. ; Log messages are ranked between 1 to 4, where 1 is the most important
  136. ; type of message (usually a fatal error of some sort), and 4 is the
  137. ; most extraneous (an informational message of some sort).  This gives
  138. ; you control over how verbose to make the status log.
  139. ;
  140. ; Each message in the log file is preceded by a special symbol indicating
  141. ; it's level of importance as follows:
  142. ;
  143. ;       LogLevel  Characters That Precede Included Entries
  144. ;
  145. ;           1      !
  146. ;           2      *
  147. ;           3      +
  148. ;           4      :
  149. ;
  150.  
  151. Log                             ; [No]Log - Log process information to log
  152.                                 ; file
  153.  
  154. LogLevel    4                   ; Level of logging where 1 is the most minimal
  155.                                 ; amount of information, and 4 is the most
  156.                                 ; detailed.
  157.  
  158. LogFile c:\bbs\logs\msgx.log    ; Name of the log file (MUST be defined to
  159.                                 ; use the logging feature.)  There is no
  160.                                 ; default.
  161.  
  162. ;
  163. ; FileListDescription defines the description used if creating a new
  164. ; archive in the file specifed by 'FILESBBS'.
  165. ;
  166. ; The FileListDescription is normally best used on the command line as a
  167. ; qualifier for each run of MsgX.  However, if you only ever extract one
  168. ; set of echos, it is included here for convenience.  Enclose the entire
  169. ; description in quotes.
  170. ;
  171. ; MsgX will create a file description line "on-the-fly" if you leave this
  172. ; undefined.
  173. ;
  174.  
  175. ; FileListDescription "Echos extracted on %A, %d-%b-%Y."
  176.  
  177. ;
  178. ; 'MsgDivider' is used to separate each message.
  179. ;
  180. ; The divider will be centered based on the value used for 'RightMargin'.
  181. ; Quote characters cannot be included in the line.
  182. ;
  183.  
  184. MsgDivider     "+----------------------------------------------------------------------------+"
  185.  
  186. ;
  187. ; 'MsgFileDivider' is written at the end of the file.  Thus, if you are
  188. ; appending messages to an existing text file, this will act as a natural
  189. ; "divider" for sets of messages.
  190. ;
  191. ; The divider will be centered based on the value used for 'RightMargin'.
  192. ; Quote characters cannot be included in the line.
  193. ;
  194.  
  195. MsgFileDivider "+============================================================================+"
  196.  
  197. ;
  198. ; Archiver Information
  199. ;
  200. ; The archive used to compress and uncompress files may be define below.
  201. ; Simply uncomment the desired definitions, or add your own.
  202. ;
  203. ; The following macros are available:
  204. ;
  205. ;   %a - Translates to the name of the archive.
  206. ;   %f - Translates to the list of files to be inserted into the
  207. ;        archive.
  208. ;   %l - Translates to a list-name that contains names of all the message
  209. ;        text files to extract and/or archive.  This option should only
  210. ;        be used for archivers which support list files (such as PKZIP).
  211. ;        This is helpful if you are specifying AppendMsgs and do not always
  212. ;        want MsgX to extract ALL the message files from the archive, but only
  213. ;        those message files which will be updated.
  214. ;
  215. ; Please note:  If you are running MsgX with AppendMsgs, MsgX will use
  216. ;               the definition in ArchiveUpdate in order to update the
  217. ;               archive with the new files.  Otherwise, MsgX will use
  218. ;               the definition in ArchiveAdd, which will add the files
  219. ;               to the new archive.  If the archive already existed in
  220. ;               this case (using NoAppendMsgs), then the new text files
  221. ;               will probably be appended to the bottom of the archive.
  222. ;
  223. ;               Do not use full path names on the archives.  MsgX will
  224. ;               search the current directory or PATH variable to find
  225. ;               the archiving program.
  226. ;
  227.  
  228.   ArchiveExtension    ZIP
  229.   ArchiveAdd          "pkzip -a %a @%l"
  230.   ArchiveUpdate       "pkzip -u %a @%l"
  231.   ArchiveExtract      "pkunzip -o %a @%l"
  232.  
  233. ; ArchiveExtension    ARJ
  234. ; ArchiveAdd          "arj a -e %a %f"   ; If short on memory, add "-m4"
  235. ; ArchiveUpdate       "arj u -e %a %f"
  236. ; ArchiveExtract      "arj e %a %f"
  237.  
  238. ; ArchiveExtension    ARC
  239. ; ArchiveAdd          "arc a %a %f"
  240. ; ArchiveUpdate       "arc u %a %f"
  241. ; ArchiveExtract      "arc x %a %f"
  242.  
  243. ; ArchiveExtension    LZH
  244. ; ArchiveAdd          "lha a %a %f"
  245. ; ArchiveUpdate       "lha a %a %f"
  246. ; ArchiveExtract      "lha x %a %f"
  247.  
  248. ; ArchiveExtension    PAK
  249. ; ArchiveAdd          "pak a /s  %a %f"
  250. ; ArchiveUpdate       "pak u /s  %a %f"
  251. ; ArchiveExtract      "pak e /wa %a %f"
  252.  
  253. ; ArchiveExtension    ZOO
  254. ; ArchiveAdd          "zoo a:  %a %f"
  255. ; ArchiveUpdate       "zoo a:u %a %f"
  256. ; ArchiveExtract      "zoo e:O %a %f"
  257.