home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / HER100_1.ZIP / HERALD.ZIP / HERALD.DOC < prev    next >
Text File  |  1993-05-27  |  132KB  |  3,065 lines

  1.  
  2. ------------------The FileHerald: User's Manual--------------
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.     ████████┐ ██┐  ██┐ ███████┐
  16.     └──██┌──┘ ██│  ██│ ██┌────┘
  17.        ██│    ███████│ █████┐
  18.        ██│    ██┌──██│ ██┌──┘
  19.        ██│    ██│  ██│ ███████┐
  20.        └─┘    └─┘  └─┘ └──────┘
  21.  
  22.            ███████┐ ████┐ ██┐     ███████┐
  23.            ██┌────┘ └██┌┘ ██│     ██┌────┘
  24.            █████┐    ██│  ██│     █████┐
  25.            ██┌──┘    ██│  ██│     ██┌──┘
  26.            ██│      ████┐ ██████┐ ███████┐
  27.            └─┘      └───┘ └─────┘ └──────┘
  28.  
  29.                 ██┐  ██┐ ███████┐ ███████┐ ███████┐ ██┐     ████████┐
  30.                 ██│  ██│ ██┌────┘ ██┌──██│ ██┌──██│ ██│     └██┌──██│V1.00-1
  31.                 ███████│ █████┐   ███████│ ███████│ ██│      ██│  ██│
  32.                 ██┌──██│ ██┌──┘   ██┌─██┌┘ ██┌──██│ ██│      ██│  ██│
  33.                 ██│  ██│ ███████┐ ██│ ███┐ ██│  ██│ ██████┐ ████████│
  34.                 └─┘  └─┘ └──────┘ └─┘ └──┘ └─┘  └─┘ └─────┘ └───────┘
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46. File lister, new files announcer and file base maintenance utility
  47.  
  48. V1.00, date: 26.05.93
  49.  
  50. (c) Copyright 5/1993 by Oblivion Software, Norbert Schlia
  51. This documentation is for release V1.00 of The FileHerald
  52. Karlsruhe, Germany, Version 1-1001
  53.  
  54.                                                                 2
  55.  
  56. TABLE OF CONTENTS
  57.  
  58. TABLE OF CONTENTS                                                2
  59. PREFACE                                                          4
  60. This version                                                     4
  61. INTRODUCTION                                                     5
  62. Features overviewed
  63. How to use this manual                                           6
  64. Definitions                                                      7
  65. INSTALLATION                                                     8
  66. Setting up the system                                            8
  67. HERALD'S SUPPORTING FILES                                        9
  68. FileHerald's supporting files overviewed                         9
  69. How FileHerald finds its files                                   9
  70. HERALD.OLD                                                      10
  71. The secret of the template files                                10
  72. What's behind the list files                                    12
  73. CONFIGURING FILEHERALD                                          14
  74. The configuration file                                          14
  75. Quick setup                                                     14
  76. The sections and all keywords in detail                         15
  77. The [SYSTEM]-section                                            15
  78. The [MAINTENANCE]-section                                       20
  79. The [REPACK]-section                                            29
  80. The [ANNOUNCE]-section                                          31
  81. The [NETMAIL]-section                                           36
  82. The [ECHOMAIL]-section                                          37
  83. The [SQUISH]-section                                            38
  84. The [FILELIST]-section                                          39
  85. CREATING FILELISTS                                              45
  86. CREATING MESSAGES                                               45
  87. CONVERTING AREA LISTS                                           46
  88. Multiple BBS systems                                            46
  89. A convenient way to support WME                                 46
  90. MISCELLANOUS                                                    47
  91. Pattern matching rules                                          47
  92. Command line switches                                           48
  93. Errorlevels                                                     50
  94. ENVIRONMENT                                                     51
  95. Network/multitasker operation                                   52
  96. Multiline                                                       53
  97. Batchfiles                                                      54
  98. APPENDIX                                                        56
  99. Copyright and shareware notice                                  58
  100. Disclaimer                                                      59
  101. Trouble shooting                                                60
  102. Support                                                         61
  103. How to register                                                 62
  104. How to register in Europe                                       62
  105. How to register in the United States                            63
  106. How to register outside the US and Europe                       64
  107. Ordering upgrades                                               65
  108. Differences between keys                                        66
  109. SYSTEM REQUIREMENTS AND LIMITATIONS                             67
  110. Processor type and memory management                            67
  111. Disk caching                                                    67
  112. Bugreport                                                       68
  113. Revision History                                                69
  114. Future versions                                                 70
  115.  
  116.                                                                 3
  117. Credits                                                         71
  118. The Beta Crew                                                   71
  119. Other software                                                  72
  120. QUICK REFERENCE GUIDE                                           73
  121.  
  122.  
  123.                                                                 4
  124. PREFACE
  125.  
  126. FileHerald has  taken us  a lot  of time,  effort, sweat, nerves, gallons of
  127. coffee, many  good night's sleep and some broken fingernails to make it what
  128. it is right now. I put nearly every idea I had that a good utility should do
  129. in it,  but there  will be  other  versions,  bugfixes  and  ones  with  new
  130. features, in the future.
  131.  
  132. It started  all last  year in  June 1992.   As  I run a BBS myself, I always
  133. found it  annoying having  to execute several small, but frankly convenient,
  134. utilities one  after another  to create  my filelists, announce new uploads,
  135. reformat my  area lists and more.  Often they did not fit my needs or simply
  136. were not capable of what I wanted them to do.
  137.  
  138. Naturally it  is possible  to run  them in a batch job, but then you have to
  139. configure each  of these  programs individually,  and if  just one  of  them
  140. fails, you  have the  painstaking process  of finding  out which  one is  to
  141. blame.  This is sometimes a pretty annoying and time consuming task.
  142.  
  143. Furthermore, for  the matter  of a good conscience, you will have to pay for
  144. those utilities, which are not free - maybe small fees, indeed, but they add
  145. up to a considerable amount measured on what one of them does alone.
  146.  
  147. So now,  there is one program that does most, if not all, of these jobs, and
  148. you will only have to pay once - that's the best part to it!
  149.  
  150. If there  is something  you would  like FileHerald  to do,  let me  know. If
  151. possible I  will try  to add  it as a new feature.  Since I run only one BBS
  152. software, there may be others that are not compatible to mine.
  153.  
  154. If you do uncover any problems, send me, or one of my support sites, netmail
  155. and  describe   them.  Include  information  on  your  system  software  and
  156. configuration, and  I will try and fix it. Refer to "Bugreports" for further
  157. details.
  158.  
  159. This version
  160.  
  161. Current version  is 1.00-1,  this means  release 1.00,  revision 1.  My beta
  162. sites have been pushing me on and on for months to release Herald. But every
  163. time I  had a  stable and  mature version  on my  hand I  found another nice
  164. feature to  add. So  I programmed it, we had to test it and thus the release
  165. date was postponed one more time.
  166.  
  167. Now, as I have nearly run out of ideas, I think it's time to hit the market.
  168. If you  think that there is something Herald should be able to do, just send
  169. me a netmail. If possible it may be available in future versions.
  170.  
  171. I hope you are satisfied by Herald. Have fun with it!
  172.  
  173.                                                                 5
  174. INTRODUCTION
  175.  
  176. Features overviewed:
  177.  
  178. FileHerald provides an easy and convenient way to perform several actions on
  179. your entire file base. These include:
  180.  
  181. - creates neatly formatted filelists, of both complete and new files
  182. - can make up to 65655 lists in a single pass, each one freely
  183.   configurable.  So you can create special lists for your CD-ROM files,
  184.   or other specialised areas without having to call FileHerald again
  185.   for each list
  186. - a fully configurable template system, allowing for headers and footers in
  187.   the file lists, area lists, and messages
  188. - multi language support
  189. - configurable date and time format for your country's standards and your
  190.   own personal taste
  191. - multi BBS support for all BBS systems using a FILES.BBS compatible
  192.   format. (SuperBBS, ProBoard, Remote Access, RoboBBS, Windowed Modem
  193.   Environment, Wildcat and Opus).
  194. - lists and messages can be sorted by filenames, date and size.  Comment
  195.   lines or graphics are fully supported
  196. - Full FILE_ID.DIZ support, with correct formatting for extended
  197.   descriptions, stripping of non-standard ASCII if desired.
  198. - creates an area overview summary to be presented to your users or to be
  199.   packed with or appended to the lists (both ANSI and ASCII version)
  200. - sorts and reformats your area lists, adds missing download counters and
  201.   missing files, removes missing files from your listings, takes  care that
  202.   only a certain number of particular files (nodediffs for example) are
  203.   kept in your file base.
  204. - Deletes or moves files according to your specifications. You can remove
  205.   old files, with to few downloads, by name, or keep only a certain number
  206.   of files per area.
  207. - adds predefined comments for frequently updated files, i.e., for
  208.   nodediffs or fido newsletters. These files can be added to your file
  209.   list and commented automatically.
  210. - Complete 4DOS support. Comments can be retrieved from DESCRIPT.ION;-
  211.   Files and also removed as files are deleted from your filebase
  212. - identifies unwanted files and removes them from your file base, or to a
  213.   specified path not accessible from from the BBS, or, they are simply
  214.   killed
  215. - announces new uploads via netmail, echomail, squish mail and as text
  216.   messages
  217. - announcements are not made according to time stamps. FileHerald simply
  218.   maintains its own file list, which means you don't have to touch the time
  219.   stamps for FileHerald to work properly
  220. - high exection speed. FileHerald is written in Borland C++ and uses the
  221.   286 specific instruction set.
  222. - capable of handling large file bases. Depending on how much memory your
  223.   system has free under DOS about 20,000 Files over all and 1000 files per
  224.   area are supported (future versions will support unlimited numbers of
  225.   files).
  226. - configuration allows to exclude any area from listing, announcing,
  227.   sorting, repacking and trashing or killing.
  228. - CD-ROM support. FileHerald can handle file areas and area list which are
  229.   accessed from different paths
  230. - ASCII text configuration file. FileHerald has no seperate setup program.
  231.   Everything is configured by HERALD.CFG which is a standard ASCII file
  232.   including comments on every command. This means easy and fast setup.
  233.  
  234.                                                                 6
  235. How to use this manual
  236.  
  237. I know you want to start using FileHerald as quick as possible. The best way
  238. would be  to print  out this  whole document,  and then  read the  following
  239. sections carefully:
  240.  
  241. At first,  look in  "Definitions" for  a better  understanding of the syntax
  242. used in  this text.  Switch to "Installation" to get FileHerald installed on
  243. your system.  Then refer  to  "Quick  setup"  to  set  up  those  statements
  244. absolutely necessary  to FileHerald's  functioning. If  it works, go through
  245. "The Configuration File" to get some better results.
  246.  
  247. The FileHerald  is not  a very complicated program, but it has many features
  248. which may seem confusing at first.  You may never need every single function
  249. of FileHerald,  but in  order to get the best performance out of FileHerald,
  250. you need  to get  a little  better aquainted  with it, and how it works with
  251. your file areas.
  252.  
  253.                                                                 7
  254. Definitions
  255.  
  256. Each Keyword is explained using these brackets:
  257.  
  258. <...>     means this is mandatory for this keyword
  259. [...]     indicates that this is optional for the keyword
  260. (...)     is the default value for the particular keyword
  261. |         seperates parameters that exclude each other
  262. ,         seperates parameters that may be combined
  263. "..."     Text has to be enclosed in double quotes
  264. '...'     Text has to be enclosed in single quotes
  265.  
  266. fidoaddress    fidostyle address: [zone:][net/]node[.point][@domain]
  267. Area list      a list containg information on your file base, usually in a
  268.                particular format, depending on your BBS software
  269. Area file      a list containg file names and their descriptions, usually
  270.                found in the same path as the files themself
  271.  
  272. Commonly an  area file is called "FILES.BBS" and its contents look something
  273. like this:
  274.  
  275. -
  276. - Textfiles
  277. -
  278. alice26a.arj [01] Alice in Wonderland
  279. timem10.arj  [01] H.G. Wells: The Time Machine
  280. warw10.arj   [01] H.G. Wells: War of the Worlds
  281. warworld.arj [00] H.G. Wells: War of the Worlds
  282.                   Texts complete with on-screen reader, search
  283.                   functions and more
  284. -
  285. - Hitch Hikers Guide to the Galaxy
  286. -
  287. - Buch 1: "Hitch Hikers Guide to the Galaxy"
  288. - Buch 2: "The Restaurant at the End of the Universe"
  289. - Buch 3: "Life, the Universe, and Everything"
  290. - Buch 4: "So long, and thanks for all the fish"
  291. -
  292. hitch1.arj   [04] Book 1
  293. hitch2.arj   [01] Book 2
  294. hitch3.arj   [01] Book 3
  295. hitch4.arj   [01] Book 4
  296. -
  297. 101ways.arj  [00] 101 ways to say 'no' :-)
  298.  
  299. The way long comments are handled differ from one BBS system to another, but
  300. the format  is widely  compatible.   I therefore strongly suggest you make a
  301. backup copy of all your area lists prior to running FileHerald!
  302.  
  303.                                                                 8
  304. INSTALLATION
  305.  
  306. Unpacking software
  307.  
  308. Unpack the  HER100 archive  into a  temporary directory,  or  drive  if  you
  309. prefer.  Make sure that all the files are present:
  310.  
  311. INSTALL.EXE   The installation utility
  312. HERALD.DAT    The FileHerald data file
  313.  
  314. Then  execute   the  installation  program  (no  additional  parameters  are
  315. required), and perform the following steps:
  316.  
  317. - At the initial welcome screen, select the number of your preferred
  318.   language.
  319. - Then enter the destination drive (only the letter)
  320. - Now enter the destination directory.
  321. - If you upgrading from a previous version of Herald, you will now be asked
  322.   if you want to upgrade, overwrite, or install anew.  Select the
  323.   appropriate option.
  324.  
  325. 4DOS-Users will  notice that  there is a DESCRIPT.ION file, too.  It has not
  326. got the  hidden-attribute set, so it is visible with the "dir" command.  You
  327. may set  the hidden  flag with  "attrib +H  DESCRIPT.ION".   For  those  not
  328. aquainted with 4DOS, it contains short descriptions of all these files.
  329.  
  330. Setting up the system
  331.  
  332. It is  not necessary,  but possible  and convenient,  to put FileHerald in a
  333. directory along  the DOS path. If set up correctly, FileHerald will find its
  334. supporting files  wherever you  put  them.  This  directory  containing  the
  335. support files will also become FileHerald's temporary work directory.
  336.  
  337. There are three ways to let FileHerald know where its support files are:
  338.  
  339. - If  they are  in the  same directory  as FileHerald,  it can  locate  them
  340. itself, as long as HERALD.EXE is executed from that particular directory.
  341.  
  342. - FileHerald  will recognise an environment variable if specified. This way,
  343. if you  want the  support  files  in  a  different  directory  to  the  main
  344. HERALD.EXE executable, it will still know where to find them.
  345.  
  346. In this  case the  following environment  variable should  be set  from your
  347. AUTOEXEC.BAT,  where   "x:\pathname\"  is   the  full  drive  and  directory
  348. specification.
  349.  
  350. SET HERALD=x:\pathname\
  351.  
  352. Place HERALD.EXE  somewhere along  the DOS  path, and when executed, it will
  353. locate the  neccessary support  files. Those  few  bytes  occupied  in  your
  354. environment memory may be worth it in the long run.
  355.  
  356. - The last way is to put HERALD.EXE and HERALD.CFG in the same directory and
  357. specify all  supporting files  from within the configuration file with their
  358. complete paths.  But this may be more trouble than it's worth...
  359.  
  360.                                                                 9
  361. HERALD'S SUPPORTING FILES
  362.  
  363. FileHerald's supporting files overviewed
  364.  
  365. FileHerald writes  into the following files. This means, they have to always
  366. exist in Herald's work directory:
  367.  
  368. HERALD.LOG     Logfile itself
  369. CFGERROR.LOG   Special logfile for configuration errors
  370.  
  371. FileHerald reads from and writes into the following file:
  372.  
  373. HERALD.OLD     List of files already announced
  374.  
  375. These files are only read:
  376.  
  377. FILEAREA.TXT   Area header template for the area files
  378. MSGHEAD.TXT    Header file for announcement messages
  379. MSGAREA.TXT    Area header template for announcement messages
  380. MSGFOOT.TXT    Footer file for announcement messages
  381. LISTHEAD.TXT   Header file for file lists
  382. LISTAREA.TXT   Area header template for file lists
  383. LISTFOOT.TXT   Footer file for file lists
  384.  
  385. These files need not exist, if they exist, they will be used:
  386.  
  387. COMMENT.LST    List of default comments
  388. KILLALL.LST    List of files that will always be killed
  389. NOKILL.LST     List of files that will never be killed
  390. TRASHALL.LST   List of files that will always be trashed
  391. NOTRASH.LST    List of files that will never be trashed
  392.  
  393. Herald writes these files when creating lists or a text message:
  394.  
  395. ALLFILES.TXT   Complete file list
  396. NEWFILES.TXT   New file list
  397. MESSAGE.TXT    Announcement message
  398.  
  399. You may  change all of the abovelisted names except those .LST files and the
  400. CFGERROR.LOG.
  401.  
  402. How FileHerald finds its files
  403.  
  404. If you  want to  understand how FileHerald locates its supporting files, you
  405. will need to know the following:
  406.  
  407. Files FileHerald  only reads will be located first in the current directory,
  408. then in  the specified  directory, unless you enter the complete path with a
  409. filename.   Then only this absolute path will be used.  "Specified" means by
  410. the environment variable "HERALD" or in the same directory as HERALD.EXE.
  411.  
  412. Thus you  are able to copy some supporting files into a different directory,
  413. change them  as you  like, and  start FileHerald  there using  these changed
  414. files. All  files FileHerald writes to will always be put into the specified
  415. directory, unless  you specify  a complete  path.  For example you will find
  416. HERALD.LOG there, no matter from what directory HERALD.EXE is run.
  417.  
  418.                                                                 10
  419. HERALD.OLD
  420.  
  421. Herald needs  this file to "remember" which files have been announced and/or
  422. repacked. This  makes it  possible to announce files without having to touch
  423. their dates, manipulate their attributes or anything else.
  424.  
  425. Although it  is an  internal file  of Herald,  you may  edit it  with a text
  426. editor when necessary. This is the format:
  427.  
  428. FILENAME EXT [flags] Areanumber
  429.  
  430. Flags currently are "A" which indicates the file has yet to be announced and
  431. "R" which  means the  file has  still to be repacked. A "W" marks files with
  432. descriptions  adopted  from  FILE_ID.DIZ.  This  allows  together  with  the
  433. "KeepDiz" command  to  preserve  them  formatted  as  they  are,  even  when
  434. "AutoWrap" is on.
  435.  
  436. If you  want a file to be announced one more time, simply add "A", or remove
  437. it completely  from HERALD.OLD.  In this  case however,  it will also end up
  438. being repacked again.
  439.  
  440. An example:
  441.  
  442. HELLO    ARJ A 5
  443.  
  444. This file  has not  been announced, but repacked and is located in file area
  445. number 5.
  446.  
  447. The secret of the template files
  448.  
  449. The template  files allow custom made area headers for your lists, messages,
  450. and file  areas.   You can assemble them as you like.  If you have ever used
  451. FEBBS you  will find  that the  headers you  have used  with it  are  widely
  452. compatible.
  453.  
  454. To choose one of the demo headers in the *AREA.TXT templates, mark the start
  455. with "HEADSTART"  and the  end with  "HEADEND".   Only this  fraction of the
  456. template will  show in  your list,  messages and  area files.    Take  care,
  457. because lines with semi-colons, ";", will NOT be treated as comments between
  458. the "HEADSTART" and "HEADEND" parameters.
  459.  
  460. These macros  allow you  to insert  data about  the current  area into  your
  461. headers:
  462.  
  463. ~A   Areaname left justified                      (40 characters)
  464. ~B   Areaname right justified                     (40 characters)
  465. ~#   Areanumber                                   ( 3 characters)
  466. ~L   Access level to the current area             (10 characters)
  467. ~+   Minimum age to the current area              ( 3 characters)
  468. ~F   Number of files in the particular area       ( 5 characters)
  469. ~S   Size of all files in this area in kBytes     ( 6 characters)
  470. ~M   Size of all files in this area in MBytes     ( 6 characters)
  471. ~N   New files in the current area                ( 4 characters)
  472. ~O   Size of all new files in this area           ( 6 characters)
  473. ~D   Number of downloads from this area           ( 4 characters)
  474. ~R   File request info (short)                    (10 characters)
  475. ~T   File request info (centered)
  476. ~%   Current date as defined by DATEFORMAT
  477. ~$   Current time as defined by TIMEFORMAT
  478. ~!   Here the actual list will be inserted.
  479.  
  480.  
  481.                                                                 11
  482. If you  forget the  "~!" macro,  only the  files and  descriptions  will  be
  483. written and  a warning  appended to  your  log  file.  You  may  delete  the
  484. filearea.txt file  when you  do  not  want  to  have  any  headers  in  your
  485. FILES.BBS.
  486.  
  487.                                                                 12
  488. What's behind the list files
  489.  
  490. The list  files provide  a convenient  and clearly arranged means to perform
  491. many maintenance  functions on  your file  base.  Each file is a plain ASCII
  492. file, as  in the  configuration file  ";" marks  comments.   You  find  some
  493. demonstration listfiles renamed to "*.dem" in your FileHerald archive.
  494.  
  495. Each line  consists of  a filename,  optionally containing  wildcards.    In
  496. COMMENT.LST should also be a description.
  497.  
  498. COMMENT.LST;    List of default comments
  499.  
  500. This file  may contain  a list  of default  comments which  will be added to
  501. files that have no comment or what is defined by "MISSINGDESCR".
  502.  
  503. It may look like this:
  504.  
  505.      ;
  506.      ; Demo comment file
  507.      ;
  508.      FNEWS*.*       Fidonewsletter  ; Comment for fido newsletters
  509.      NODEDIFF.*     Nodediff        ; Comment for nodelist diffs
  510.  
  511. KILLALL.LST;    List of files that will always be killed
  512.  
  513. Use this list to remove the 100th upload of Telix 4.25 and other hacks.
  514.  
  515. Works like this:
  516.  
  517.      ;
  518.      ; Demo Listfile
  519.      ;
  520.      NODELIST.*, MaxCount 5     ; Hold a maximum of 5 nodelists
  521.      NODEDIFF.*, Days 30        ; Kill all diffs older than 30 days
  522.      FIDONEWS.*, MaxCount 5     ; Hold a maximum of 5 newsletters
  523.      TELIX425.*                 ; Kill each hack version of Telix 4.25
  524.      GOOFUP.*, Days 200, Dlds 3 ; Kill this file if older than 200 days and
  525.                                 ; downloaded less than 3 times
  526.  
  527. The global  values from  "KILLFILE" and  "TRASHFILE" will  be applied to all
  528. files, except  those matching  one of those in that lists. The values "DAYS"
  529. and "DLDS" are ANDed (as you can see above).
  530.  
  531. You may  also enter  "FILE.*, Days 250, Dlds 3, MaxCount 4", FileHerald will
  532. then kill  or trash  this file when it is older than 250 days and downloaded
  533. less than  3 times.  Then, if  more than  4 files remain, the oldest will be
  534. removed.
  535.  
  536. "MaxCount" always  deletes or  trashes the oldest matching files first, thus
  537. you will have the desired number of the latest versions of these programs in
  538. any area.  Note that  "MaxCount" is  only applied to a single area, if these
  539. files are scattered over more than one they will not be detected!
  540.  
  541. NOKILL.LST;     List of files that will never be killed
  542.  
  543. File listed here will never be deleted.  Specify files here which should not
  544. be deleted.  This does not affect files found in KILLALL.LST.
  545.  
  546.                                                                 13
  547. TRASHALL.LST;   List of files that will always be trashed
  548.  
  549. This is the same as KILLALL.LST, the only difference is that files will only
  550. be moved to the trashpath, but not deleted.
  551.  
  552. NOTRASH.LST;    List of files that will never be trashed
  553.  
  554. Files listed  here will  never be  trashed.  Specify files here which should
  555. not be  removed from  you base.    This  does  not  affect  files  found  in
  556. TRASHALL.LST.
  557.  
  558.                                                                 14
  559. CONFIGURING FILEHERALD
  560.  
  561. The configuration file
  562.  
  563. The configuration  file is  a plain ASCII file which can be changed for your
  564. purposes using  your favourite text editor.  Each line starting with a colon
  565. ";" is  a comment, also everything that stands behind a colon, even if it is
  566. inside a line.
  567.  
  568. Keywords are  not case  sensitive, upper and lower case letters may be mixed
  569. for readability.   You will get a warning for unknown or misspelled commands
  570. and all configuration errors will be written in a file named "CFGERROR.LOG".
  571. When FileHerald is started again, further error messages will be appended to
  572. that file.
  573.  
  574. Data which  is out  of range is, if possible, replaced by its default value.
  575. You will  get warned  about that  as well.   Some  commands  and  parameters
  576. however are required and FileHerald will not be able to work without them.
  577.  
  578. Keywords are  grouped in  sections.   Each section  begins  with  a  section
  579. identifier which  looks like  "[NAME]".   They have  to stand  in the proper
  580. sections.   If not,  FileHerald will  give a  warning.   Some keywords  with
  581. similar function  exist in  more than one section.  Don't get confused about
  582. that.
  583.  
  584. Only the  mere information  is read  from HERALD.CFG.  Make full use of it's
  585. comments as  they will  not occupy  any valuable  system memory.  FileHerald
  586. doesn't even  read all  information from the file but only what it needs for
  587. it's tasks.
  588.  
  589. Quick setup
  590.  
  591. FileHerald has  many fine features and is not an easy program to set up.  If
  592. you consider  yourself "Master  of Setups",  okay, go  ahead and do what you
  593. have to  do.   HERALD.CFG contains  all configuration options available, but
  594. not all information necessary to understand what exactly will happen.
  595.  
  596. First of  all, and  very important,  make a  backup of  all your  area files
  597. before you  start FileHerald  the first  time.  By default it will not write
  598. into  them,  but  if  you  enable  this  function  and  setup  up  something
  599. incorrectly, it may damage your lists.
  600.  
  601. It also is capable of removing files from your list.  I strongly suggest you
  602. do not  make use of the kill and trash functions until you get a little more
  603. familiar with FileHerald.  Make a streamer backup if you can!
  604.  
  605. Go through  HERALD.CFG line  by line.   Correct all paths to fit your needs,
  606. also define  the type of BBS software you use.  Then start FileHerald to see
  607. what happens.   It  almost certainly  will stop  with an  error, then go and
  608. correct it  and start  Herald again.   Repeat that until the desired results
  609. are obtained.
  610.  
  611.                                                                 15
  612. The sections and all keywords in detail
  613.  
  614. The [SYSTEM]-section
  615.  
  616. This section  allows you  to set  up basic parameters like temporary drives,
  617. your name  and BBS  address, what  BBS software you use and country specific
  618. settings as Day and Month names.
  619.  
  620. This section  must be  the very  first in  FileHerald's configuration  file,
  621. otherwise it would miss essential information.
  622.  
  623. -------------------------------------------------------------------------
  624.  
  625. SYSOPNAME;           <First and last name>
  626. BBSNAME;             <Name of you BBS>
  627. BBSADDRESS;          <Your network address if exists>
  628.  
  629. Enter your  personal name,  your BBS's  name and  your network address here.
  630. This will be inserted at the bottom of the lists and is used in all messages
  631. FileHerald creates.   If you let FileHerald create any message types besides
  632. text messages, this is mandatory.
  633.  
  634. REGISTERKEY;         <personal registerkey>
  635.  
  636. Registered users  have to  enter their  registerkey here.   Refer to "How to
  637. register" and "Differences between keys" for more information.
  638.  
  639. -------------------------------------------------------------------------
  640. TEXTWINDOW;          <YES|NO>                 (YES)
  641.  
  642. Switches the  window  containing  information  on  file  count,  area  size,
  643. downloads and  more on  and off.  On slower  computers  that  may  speed  up
  644. execution.
  645.  
  646. -------------------------------------------------------------------------
  647.  
  648. TEMPDRIVE;           <Drive spec>             (environment variable)
  649.  
  650. FileHerald  needs  a  directory  to  store  temporary  files.    By  default
  651. FileHerald reads  the environment variables "TEMP" or "TMP" to determine the
  652. drive or  directory.   Use this  command if you have not set up one of these
  653. variables or  if you want to overide its contents.  You should specify a RAM
  654. drive because it increases execution speed significantly.
  655.  
  656.                                                                 16
  657. -------------------------------------------------------------------------
  658.  
  659. SWAPDIRS;            <List of paths>          (TEMDRIVE)
  660.  
  661. This list  of directories  will be used when swapping to disk while external
  662. programs are  called. You can enter multiple paths seperated by ";", but you
  663. should specify  not only  different directories,  but also  different drives
  664. then, because  being unable  to swap to one directory of a drive means being
  665. unable to swap to any directory of that drive.
  666.  
  667. SWAPTYPE;            <DISK,XMS,EMS,EXT,ANY>   (ANY)
  668.  
  669. This defines where to Herald swaps. You can specify one or more of the above
  670. types. Of  course XMS  and EMS  will be  fastest, but  require HIMEM.SYS and
  671. EMM386 or  QEMM respectively. If you use a 286 machine or do not have enough
  672. memory available,  Herald will  swap to  disk, which  will  be  considerably
  673. slower.
  674.  
  675. -------------------------------------------------------------------------
  676.  
  677. LOGFILE;             <Filename>               (HERALD.LOG)
  678.  
  679. This determines  the filename  of FileHerald's logfile.  You can specify the
  680. same filename and path as your mailer and BBS system uses.
  681.  
  682. LOGLEVEL;            <NORMAL|FULL|DEBUG>      (NORMAL)
  683.  
  684. These are  three possible  logging  levels.    "NORMAL"  just  logs  errors,
  685. warnings and  whether filelists or messages have been created.  "FULL" saves
  686. some more  information, what  has been  written, what  areas were processed.
  687. "DEBUG" gives detailed information what happened.
  688.  
  689. "NORMAL" logs:
  690.  
  691. - Errors and warnings
  692. - Files killed or trashed except those not removed because they are in a
  693.   NOKILL.LST or NOTRASH.LST.
  694. - Files which were added to the area list
  695. - Area lists or 4DOS-DESCRIPT.ION-Files that were created
  696.  
  697. "FULL" logs anything like NORMAL and:
  698.  
  699. - Number of files read from old files list
  700. - Areas processed
  701. - New files found in every area
  702. - Descriptions added to or removed from the list
  703. - Totals on the filebase
  704.  
  705. "DEBUG" logs all of the above and:
  706.  
  707. - Filenames and paths of all processed area files
  708. - Areas skipped and the reasons
  709. - Detailed information about every area
  710.  
  711.                                                                 17
  712. -------------------------------------------------------------------------
  713. NOTIFYMSGTYPE;       <SQUISH|FIDO|ECHO|TEXT>
  714.  
  715. You can  define one  message type  here. You  will then  receive  a  message
  716. containing short but valuable information what happened when Herald was last
  717. run. This is very helpful if you run Herald over during the night hours.
  718.  
  719. NOTIFYMSGAREA;       <SQUISH AREA|NET PATH|BOARD NO|FILENAME>
  720.  
  721. In case  you have  specified a  message type  you must  enter a  valid board
  722. number for  echo mail,  a squish  area for squish, a path for fidostyle or a
  723. filename for text messages here.
  724.  
  725. -------------------------------------------------------------------------
  726. AREASDIRLIST;          <filename>
  727.  
  728. If you  specify a  filename here,  Herald will  create a  list of  all  your
  729. filebase  directories.   Include  will   only  be  those  areas  which  have
  730. filerequests allowed to everyone. This list can be used by Frontdoor mailers
  731. for filerequests.
  732.  
  733. This functions assures you your mailer has a up-to-date list available.
  734.  
  735. -------------------------------------------------------------------------
  736.  
  737. BBSTYPE;             <BBS Type>               (SBBS)
  738.  
  739. You can specify the type of BBS system you use here. If you run one which is
  740. not compatible  to those listed below, you can use the QBBS format described
  741. in "BBS  SOFTWARE SUPPORTED"  as a  work-around. It will help you to support
  742. almost any type of software.
  743.  
  744. FileHerald will  try to  find out itself which software you use by searching
  745. for one of these environment variables:
  746.  
  747. "SBBS"    SuperBBS 1.16
  748. "QBBS"    QuickBBS 2.75
  749. "PB"      ProBoard 1.30
  750. "RA"      Remote Access 1.11
  751. "RBBS"    RoboBBS 1.x
  752. "WME"     Windowed Modem Environment 1.x
  753. "WC3x"    Wildcat 3.x
  754.  
  755. This BBS  systems do not use a system variable and therefore you have to use
  756. "BBSTYPE" to define it:
  757.  
  758. RoboBBS 1.xx
  759. WME 1.xx
  760. Wildcat 3.xx
  761.  
  762. If Herald  can find  one of  them, "BBSTYPE"  and "AREALISTTYPE" will be set
  763. accordingly. In  case you  have set  just one of them, you do not need these
  764. three commands.  Only if  you want  to use another type, or even use several
  765. BBS systems  at once,  you may  need to  tell FileHerald  which one  is  the
  766. correct one.  Should more than one of these be set, they will be searched in
  767. the above  order. Herald  stops at the first one it finds, e.g. this will be
  768. PB if PB and RA were set.
  769.  
  770.                                                                 18
  771. This value  is essential,  because if  you let  FileHerald update  your area
  772. files, it  decides  how  they  are  formatted.  This  is  necessary  because
  773. different BBS  software uses  slightly different  formats, which  can  cause
  774. somewhat messed up area files.
  775.  
  776. AREALISTTYPE;        <SBBS|QBBS|PB|RA|RBBS>   (SBBS)
  777.  
  778. FileHerald needs some information where to find the area list, the files and
  779. more. He  can read the formats listed above. All are binary files except for
  780. QBBS which  uses a  plain ASCII  file giving  you the opportunity to edit it
  781. using any text editor. It contains any information needed by FileHerald.
  782.  
  783. Herald will  set "AREALISTTYPE"  to the  same as  BBSType, but  you may  use
  784. another listformat  than your BBS software does by entering the one you wish
  785. here as arealist type.
  786.  
  787. These are  the files,  Herald needs  one  of  them  depending  on  your  BBS
  788. software:
  789.  
  790. FLSEARCH.BBS    SuperBBS 1.16
  791. FLSEARCH.CTL    QuickBBS 2.75
  792. FILES.PRO       ProBoard 1.30
  793. FILES.RA        Remote Access 1.11
  794. FILEAREA.DEF    RoboBBS 1.xx
  795. FILEAREA.BBS    Windowed Modem Environment 1.xx
  796. FILEAREA.DAT,
  797. ALLFILES.DAT    Wildcat 3.xx
  798.  
  799. Later versions  should work  as well.  Drop me  a note  if  problems  occur!
  800. FileHerald will  handle special  functions some BBS types have. Look in "BBS
  801. SOFTWARES SUPPORTED" for further information.
  802.  
  803. AREALISTPATH;        <path>
  804.  
  805. The command  specifies the  path where  FileHerald can  find the  above area
  806. file. If  you have  defined an  area list  type explicitly  using the  above
  807. keyword or by defining a BBS type, FileHerald will still use the environment
  808. to find  the path. Should no environment variable be found, or when you want
  809. to use  a different  file (e.g.  one in  a different path) you can define it
  810. using this keyword.
  811.  
  812. BBSDATEFORMAT;       <EUROPEAN|AMRICAN>       (EUROPEAN)
  813.  
  814. If you  want to use the special way of ProBoard to support CD-ROMs, you have
  815. to define  which date  format you  use with  it. This command is only needed
  816. with ProBoard 1.30.
  817.  
  818. AREASDIRLIST;        <PATH>
  819.  
  820. Path and filename of your areas directory list. This is the list which tells
  821. your mailer where to locate all requestable files.
  822.  
  823.                                                                 19
  824. -------------------------------------------------------------------------
  825.  
  826. TIMEFORMAT;          <0|1|2|3>                (0)
  827.  
  828. You can  choose the  time format  which is  used in  your country.  The four
  829. formats look like this:
  830.  
  831. 0    HH:MM     Hours from 00 to 23
  832. 1    HH:MM:SS  Hours from 00 to 23
  833. 2    HH:MM     Hours from 01 to 12 and AM/PM
  834. 3    HH:MM:SS  Hours from 01 to 12 and AM/PM
  835.  
  836. DATEFORMAT;          <FORMATSTRING>           (m-d-y)
  837.  
  838. You can  have  FileHerald  use  exactly  whichever  date  format  you  like.
  839. Assemble it using these characters:
  840.  
  841. d    replaced by the day
  842. D    replaced by the name of the day
  843. m    replaced by the month
  844. M    replaced by the name of the month
  845. y    replaced by the year (YY)
  846. Y    replaced by the year (YYYY)
  847.  
  848. Other characters are not changed.  Examples:
  849.  
  850. d.M'Y     ->   01.Sep'1993
  851. d.m.y     ->   01.10.93
  852.  
  853. MONTHNAMES;          <12 NAMES>               (English names)
  854.  
  855. By default  FileHerald uses  the English  month names.   You can specify the
  856. names in  your own  language.   You must  enter all  12 names  seperated  by
  857. commas.  They have to be exactly 3 bytes long:
  858.  
  859. MonthNames  Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
  860.  
  861. DAYNAMES;            <7 NAMES>                (English names)
  862.  
  863. The same as MonthNames but for the weekdays.
  864.  
  865.                                                                 20
  866. The [MAINTENANCE]-section
  867.  
  868. In this  section you  find keywords  to configure  how your  area files  are
  869. formatted, old files treated or missing descriptions handled.
  870.  
  871. -------------------------------------------------------------------------
  872.  
  873. UPDATEAREAFILE;      <YES|NO>                 (NO)
  874.  
  875. Whether FileHerald writes back new formatted area files or not. Normally you
  876. would want  it to  do it,  because it allows you to add new files, comments,
  877. remove files  missing from  your base and more. All these functions will not
  878. work fully if updating the area files is not enabled.
  879.  
  880. However, you  should be  careful and  disable it as long as you are not sure
  881. that everything is set up correctly, since it may mess up your area files.
  882.  
  883. AUTOCREATEAREAFILE;  <YES|NO>                 (NO)
  884.  
  885. Normally FileHerald  warns  you  if  it  cannot  find  the  area  file,  and
  886. subsequently skip it. If enabled, it will create a new one. Depending on the
  887. other settings all files in the area will be added.
  888.  
  889. BACKUPAREAFILE;      <YES|NO>                 (YES)
  890.  
  891. This is  a useful function which lets FileHerald create backups of your area
  892. files and  keep them until the next run. Thus if they are called "FILES.BBS"
  893. you will  have a  "FILES.BAK" with  the old  contents if  something does  go
  894. wrong. But be careful, these backups will be overwritten at each new run!
  895.  
  896. -------------------------------------------------------------------------
  897.  
  898. EXTRAAREAFILETYPE;   <BBS Type>
  899.  
  900. Herald is able to create a second areafile of any type you like. This allows
  901. to convert  areafile formats  from any  type  to  another  or  run  two  BBS
  902. softwares at once.
  903.  
  904. All by "BBSType" and "AreaListType" supported BBS softwares are allowed.
  905.  
  906. EXTRAFILESPECNAME;   <YES|NO>                 (NO)
  907.  
  908. RoboBBS and Remote Access allow the use of special area files in a different
  909. path. This  command instructs Herald to create them. They are called FILES.n
  910. and located  in "ExtraListPath".  Otherwise they  will be named as usual for
  911. that system and created in the default area.
  912.  
  913.                                                                 21
  914.  
  915. EXTRALISTPATH;       <path>
  916.  
  917. Remote Access  1.11 and  RoboBoard offer  CD-ROM support  by using a special
  918. path where  the area  lists are stored, because naturally it is not possible
  919. to put  them on  the ROM. These lists have to be named "FILES.n", where n is
  920. the area  number. The BBS software scans first to see if it finds a matching
  921. file in that directory.
  922.  
  923. RoboBoard simply  uses its  system path,  Remote Access  allows to specify a
  924. special directory  keeping all  that junk  away from your system path. Enter
  925. this special  path here  and Herald will use these FILES.n if it finds them,
  926. just as your BBS software does.
  927.  
  928. You can  also use  this the  other way  round by  entering the  command line
  929. switch "/oX",  where "X"  is one  of the above BBS types. This allows you to
  930. create RoboBBS-style  area files from your own. For example, if you run both
  931. SuperBBS and  RoboBBS at the same time, you can let FileHerald convert these
  932. files from  SBBS to  RoboBBS. "/oRBBS"  writes FILES.n  into the  list  path
  933. instead of  reading them.  They will  be correctly  formatted for the target
  934. system.
  935.  
  936. This keyword is not necessary for SuperBBS and ProBoard.
  937.  
  938. -------------------------------------------------------------------------
  939.  
  940. ADDNEWFILES;         <YES|NO>                 (NO)
  941.  
  942. If you  specify "YES",  FileHerald will  scan each area for files missing in
  943. the area  list and  insert them. If possible descriptions will be added from
  944. "COMMENT.LST" or 4DOS-DESCRIPT.IONs.
  945.  
  946. ADDFROMCDROM;         <YES|NO>                 (NO)
  947.  
  948. Normally CD-ROM areas are automatically excluded from auto-adding, for there
  949. will never  appear new files and it is wasted time to search these areas. On
  950. the other  hand, when you have a new CD-ROM, you might want Herald to create
  951. new FILES.BBS for it once, set this keyword to yes.
  952.  
  953. IGNOREFILE;          <File specs>
  954.  
  955. Of course  you would  not want FileHerald to add "FILES.BBS" and "FILES.BAK"
  956. everytime. So if you specify "*.BBS, *.BAK" they will be ignored.
  957.  
  958. ADDGRAPHINFO;        <YES|NO>                  (NO)
  959.  
  960. Instructs Herald to add information on dimensions and resolution to graphics
  961. - i.e. for a GIF it would look something like this: "GIF 89a, (480*200*16)".
  962. This means that the picture is a GIF version 89a with a 480 x 200 resolution
  963. and 16  colors. Currently  supported are  only GIF and PCX, more will follow
  964. (if someone tells me how to determine these data for JPGs).
  965.  
  966.                                                                 22
  967. -------------------------------------------------------------------------
  968.  
  969. USEFILE_ID;          <NO|MISSING|ALWAYS>       (NO)
  970.  
  971. Program authors  tend to  put a  short description of their efforts into the
  972. distribution archive.  A common  filename  is  FILE_ID.DIZ,  but  there  are
  973. others. Henceforth  FILE_ID.DIZ stands  synonimous for  all of  these. Using
  974. this function you can enable Herald to adopt these descriptions easily.
  975.  
  976. "MISSING" means  if a file lacks a description, Herald attempts to find such
  977. a file. This will be repeated everytime you run Herald, so take care you add
  978. a proper  info if  this function  should fail.  "ALWAYS" means  that all new
  979. files are  scanned for  a FILE_ID.DIZ  no matter  if  they  already  have  a
  980. description. If found, it will be replaced by that in FILE_ID.DIZ.
  981.  
  982. DESCRFILENAME;          <list of filenames>
  983.  
  984. This list  of filenames will be used to find description files. No wildcards
  985. are allowed.
  986.  
  987. UNPACKCOMMAND;          <extension, command>
  988.  
  989. This is a list of packers which are needed to search the archives. Syntax is
  990. the extension, a komma, and the unpack command for that particular archiver.
  991. "%ARCHIVE%" is  replaced by  the archive name to unpack, in "%TEMPPATH%" the
  992. unpacked files  should be  placed, and  "%DESCRFILES%" is  the above list of
  993. files.
  994.  
  995. Note that  some popular  packers like LHA return a non-zero errorlevel if at
  996. least one  of the  files that  should be  unpacked is  not there, but Herald
  997. takes that  as an  error.  In  HERALD.CFG  is  a  list  of  most  widespread
  998. archivers. Do not comment any out as they all may be needed sometimes.
  999.  
  1000. KEEPDIZ;                <YES|NO>               (NO)
  1001.  
  1002. If enabled  Herald preserves  the format  in FILE_ID.DIZ's  as it  is, e.g.,
  1003. newlines remain where they are. This allows you to run Herald with "AutoWrap
  1004. SMART" and reformat your descriptions where necessary without ruining nicely
  1005. formatted ANSI  graphics from  FILE_ID.DIZ's. However, mostly these pictures
  1006. are up  to 44 characters wide which is to much for SuperBBS. Therefore these
  1007. graphics will be messed up by some BBS softwares.
  1008.  
  1009. STRIPHIASCII;                <YES|NO>               (NO)
  1010.  
  1011. This  tells   Herald  to  remove  any  non-standard  ASCII  characters  from
  1012. FILE_ID.DIZ's  when  adopting  them.  Has  no  effect  on  already  existing
  1013. descriptions.
  1014.  
  1015. -------------------------------------------------------------------------
  1016.  
  1017. MISSINGDESCR;        <Text>
  1018.  
  1019. This is  the description  that is  inserted if  it could  not be  determined
  1020. otherwise. Please enter exactly the same string you use in your BBS. This is
  1021. because FileHerald can also identify missing descriptions of older files and
  1022. add them.
  1023.  
  1024.                                                                 23
  1025. -------------------------------------------------------------------------
  1026.  
  1027. SKIPUPDATE;          <list of areas>
  1028.  
  1029. These are  the areas  which you  do not  want to be updated. There are three
  1030. ways to specify the areas. First is by its number, which may look like this:
  1031.  
  1032. 26    means area number 26
  1033. -3    means area 1,2 and 3
  1034. 30-   means area 30 and every following area
  1035. 7-9   means area 7,8 and 9
  1036.  
  1037. Exactly by its name:
  1038.  
  1039. "TOOLS"  specifies the area "Tools", of course case insensitive
  1040.  
  1041. By name, but using regular expressions:
  1042.  
  1043. '*CD-ROM*' fits any area name with "CD-ROM" in it, this is case insensitive,
  1044.         too
  1045.  
  1046. -------------------------------------------------------------------------
  1047.  
  1048. USE4DOSDESCR;        <YES|NO>                 (NO)
  1049.  
  1050. When you  are a 4DOS user, you will find it convenient that FileHerald fully
  1051. supports 4DOS-DESCRIPT.IONs.  To enable  this feature,  set this function to
  1052. "YES". Only  then the  next two  keywords are  functional. If  enabled,  The
  1053. FileHerald will  try to  find descriptions  of new  files or  those with the
  1054. string defined by "MISSINGDESCR" in the 4DOS-DESCRIPT.IONs.
  1055.  
  1056. UPDATE4DOSDESCR;     <NO|NEW|ALL>             (NO)
  1057.  
  1058. If set  to "NEW", each file that has been added its description will also be
  1059. added to the DESCRIPT.ION. Further if set to "ALL", FileHerald will look for
  1060. every file if it is already described and when not add it to the 4DOS-list.
  1061.  
  1062. Of course  this demands  that it  is read  completely for each file and will
  1063. increase the  execution time  significantly. On  the other hand you are sure
  1064. that the DESCRIPT.ION-file is complete.
  1065.  
  1066. When no  such file is found in an area and "UPDATE4DOSDESCR" is at least set
  1067. to "NEW", FileHerald will create a new one and add all descriptions.
  1068.  
  1069. REMOVE4DOSDESCR;     <YES|NO>                 (NO)
  1070.  
  1071. When FileHerald  kills or  trashes a file the discription will remain in the
  1072. DESCRIPT.ION-file. This command tells him to remove them. From my experience
  1073. 4DOS does not always remove them itself.
  1074.  
  1075.                                                                 24
  1076. -------------------------------------------------------------------------
  1077.  
  1078. LONGDESCRMARK;       <NONE|SPACE|Character>   (SPACE)
  1079.  
  1080. This command determines the way long descriptions are treated in area files.
  1081. "SPACE" means  that a  description that  does not  fit in  one line  will be
  1082. continued in  the next  line and  indented a  suitable number of characters.
  1083. Download counters  will be  considered and  you will  see that the result is
  1084. nice.
  1085.  
  1086. If you  use "NONE", all will remain in the same line. This is not suggested,
  1087. because the  results can  be ugly  if a  line gets  too long  for  your  BBS
  1088. software. Remote  Access 1.11  for example reacts with fast screen scrolling
  1089. when a line gets longer than 255 characters.
  1090.  
  1091. If you  specify a  character it  will be  used to  identify following lines.
  1092. SuperBBS uses ">",  ProBoard "+". The latter, however, does not want a blank
  1093. before the "+" while SuperBBS demands that. You see, setting the appropriate
  1094. BBS software type using "BBSTYPE" is essential.
  1095.  
  1096. You can  convert each  of the  three formats  since  FileHerald  detects  it
  1097. automatically.  Therefore,  if  you  change  it,  FileHerald  will  read  it
  1098. correctly and write it in the desired format.
  1099.  
  1100. Here is a list of BBS types and what they "like" most:
  1101.  
  1102. SuperBBS 1.16         ">" and SPACE
  1103. ProBoard 1.30         "+", SPACE and NONE
  1104. Remote Access 1.11    SPACE and NONE (no lines longer than 255 characters!)
  1105. RoboBoard 1.xx        NONE only
  1106.  
  1107. SPACE is the best way for SuperBBS and RemoteAccess, because following lines
  1108. will be indented so that download counters have their own column which makes
  1109. listings clearer  to read for the mere price of a few bytes more on your HD.
  1110. ProBoard handles  any of the three, so I suggest you use "+" because it does
  1111. not waste  any HD space. On the other hand, NONE allows your area list to be
  1112. changed by a text editor more easily.
  1113.  
  1114. RoboBoard  allows  one-line-comments  only,  they  may  be  longer  that  64
  1115. characters, but  only these  will be  displayed. But  it  demands  that  the
  1116. download counters  look exactly  the way  it wants, and it allows no comment
  1117. lines at  all. Take  care when converting to RoboBBS, all comment lines will
  1118. be discarded!
  1119.  
  1120. Please be  careful  if  your  BBS  system  uses  a  different  tag,  because
  1121. FileHerald will  not read  your area files correctly if you do not define it
  1122. explicitly here!
  1123.  
  1124. This means your area files will get messed up if you define for example "&",
  1125. run  Herald  with  the  "UPDATEAREALIST"  option  enabled  and  then  change
  1126. "LONGDESCRMARK" to a different value. So be careful!
  1127.  
  1128. Note also  that Herald  only writes  FILES.BBS back,  when  they  have  been
  1129. changed since  it was  last run  or when  a file  has been added, removed or
  1130. somthing  similar.  This  makes  execution  faster,  but  may  sometimes  be
  1131. bewildering.
  1132.  
  1133.                                                                 25
  1134. -------------------------------------------------------------------------
  1135.  
  1136. AUTOWRAP;      <NONE|FULL|SMART>                 (SMART)
  1137.  
  1138. Normally Herald  reformats your  descriptions appropriately.  If,  for  some
  1139. reason, you  want to  preserve them,  use this command. "NONE" switches word
  1140. wrapping totally  off as  long as a line does not get dangerously long (e.g.
  1141. more than 78 characters for FILES.BBS).
  1142.  
  1143. "FULL" means  that everything  remains as is, but if a line gets longer than
  1144. the maximum for your BBS software it is reformatted. "SMART" is the best way
  1145. because it allows Herald to wrap any line to the most suitable length.
  1146. -------------------------------------------------------------------------
  1147.  
  1148. REMOVEEMPTYLINES;      <NO|YES>                  (NO)
  1149.  
  1150. Normally Herald  leaves empty  lines in  your FILES.BBS. If you enable this,
  1151. they will be removed.
  1152.  
  1153.  
  1154. -------------------------------------------------------------------------
  1155.  
  1156. BLANKSASCOMMENT;      <NO|YES>                  (YES)
  1157.  
  1158. If you  did not  set "LongDescrMark"  to SPACE,  Herald will  consider lines
  1159. starting with  a blank  as comments  as long  as there  are no  more than 30
  1160. columns before the first non-space character:
  1161.  
  1162.   This is a comment
  1163.  
  1164. DEMO.TXT [12] This is the first description line
  1165.                                   This is the second description line
  1166.  
  1167. The second  description line will be appended to DEMO.TXT's description, but
  1168. the  line   with  only   two  blanks   considered  a  comment.  If  you  set
  1169. "BlanksAsComment" to  NO, each  line starting  with at  least one  blank  is
  1170. considered a long description..
  1171.  
  1172.                                                                 26
  1173. -------------------------------------------------------------------------
  1174.  
  1175. LEFTBRACKET;      <character>                 ([)
  1176. RIGHTBRACKET;     <character>                 (])
  1177. COUNTERLEN;       <value>                     (2)
  1178.  
  1179. These three  keywords define  the outlook  of your download counters, if you
  1180. use them.  By default it will look like this "[00]". The value of counterlen
  1181. may vary  from 1  to 5.  FileHerald will  correct the  counter length to the
  1182. given value.  If the  number of  digits is  less than  this value it will be
  1183. filled with "0"s, otherwise the counter will remain longer as specified.
  1184.  
  1185. Example: CounterLen 3
  1186.  
  1187. [2]      -> [002]
  1188. [1234]   -> [1234]
  1189.  
  1190. LeftBracket and  RightBracket have  to be  the same as your BBS system uses.
  1191. Otherwise FileHerald  cannot identify  the counters and this as well as some
  1192. statistical functions  will not  work properly.  You can  however change the
  1193. length as  often as  you like.  FileHerald will  match the counter length as
  1194. desired.
  1195.  
  1196. -------------------------------------------------------------------------
  1197.  
  1198. KILLFILE;            <REMOVEMISSING|DAYS n|DLDS m>
  1199. TRASHFILE;           <DAYS n|DLDS m>
  1200. TRASHPATH;           <path>
  1201.  
  1202. These three  keywords allow you to remove descriptions of files which do not
  1203. exist, delete  files which  are too  old or  haven't been  downloaded for  a
  1204. certain period of time.
  1205.  
  1206. "REMOVEMISSING" works  only with  "KILLFILE" and  tells FileHerald to remove
  1207. descriptions of missing files.
  1208.  
  1209. "DAYS n" lets FileHerald kill or trash files which are older than n days.
  1210.  
  1211. "DLDS n"  makes FileHerald  kill or  trash files  which have been downloaded
  1212. less than n times.
  1213. If you  enter "DAYS  200, DLDS  2" files  older than 200 days and downloaded
  1214. less than 2 times will be removed or killed.
  1215.  
  1216. The trashpath  is where files will be move when they are trashed. FileHerald
  1217. also moves their descriptions and date and time when they were moved to that
  1218. path. You  must enter  that path  when you  want to  use the  trash-feature.
  1219. Please be careful with "KILLFILE" as it actually deletes the files from your
  1220. base and they may be lost forever.
  1221.  
  1222. So I  suggest you  first try  out the  results using  "DEBUG YES" instead of
  1223. risking valuable  software. A  better way  is to  trash the files because it
  1224. leaves it to your discretion as to what actually happens to it.
  1225. If a  file is  actually trashed  or killed when the given expression is true
  1226. also depends  whether the filename is found in "NOTRASH.LST" or "NOKILL.LST"
  1227. respectively. A file found in "KILLALL.LST" or "TRASHALL.LST" will always be
  1228. removed or killed regardless of your specification by the keywords.
  1229.  
  1230. This makes  it possible  to remove  unwanted files  automatically from  your
  1231. base.
  1232.  
  1233.                                                                 27
  1234. -------------------------------------------------------------------------
  1235.  
  1236. AREAHEADER;          <filename>               (FILEAREA.TXT)
  1237.  
  1238. By default  FileHerald will  use the contents "FILEAREA.TXT" as template for
  1239. your area  files. This  keyword allows  you to use another file. Please make
  1240. sure, even  if  you  want  no  headers  in  your  area  files,  just  delete
  1241. "FILEAREA.TXT".
  1242.  
  1243. -------------------------------------------------------------------------
  1244.  
  1245. FILEMAXLINES;        <value>                  (0)
  1246.  
  1247. This is  the maximum number of description lines you allow for one file. "0"
  1248. means don't  care, any  other number  means that  a maximum of so much lines
  1249. will be  used. This,  of course,  only if you don't use "LONGDESCRMARK NONE"
  1250. because then there will always be exactly one line.
  1251.  
  1252. -------------------------------------------------------------------------
  1253.  
  1254. FILEEOLMARK;         <string|~string>
  1255.  
  1256. This offers you the possibility of letting FileHerald begin a new line for a
  1257. certain word.  Many sysops  keep the  names of  every uploader in their area
  1258. files, allowing  downloaders to  know the  origin of  the file. For SuperBBS
  1259. that displays  as "Uploader:  xxxx". It  looks nice  when  it  stands  in  a
  1260. seperate line.
  1261.  
  1262. If you  enter "FILEEOLMARK  ~Uploader:" FileHerald  puts "Uploader:" and the
  1263. rest of the text into a new line. It is not case insensitive, but works only
  1264. for the  first occurrence  of the  string. If you just enter "Uploader:" the
  1265. string itself  and the  rest of  the line will be cut away. Use this only if
  1266. you want to remove the messages once and for all.
  1267.  
  1268. The function  is actually  only  useful  for  file  lists  and  announcement
  1269. messages as you will see below.
  1270.  
  1271. -------------------------------------------------------------------------
  1272.  
  1273. FILECASE;            <IGNORE|CAPITALIZE|LOWERCASE> (IGNORE)
  1274.  
  1275. Depending on  your personal  taste you can change your filenames to upper or
  1276. lower case  using this keyword. If you enter "IGNORE" nothing will happen to
  1277. them and they will stay as your BBS system creates them.
  1278.  
  1279.                                                                 28
  1280. -------------------------------------------------------------------------
  1281.  
  1282. FILEDLCOUNTER;        <IGNORE|STRIP|FIT>      (IGNORE)
  1283.  
  1284. You can  have FileHerald  add missing  counters  as  defined  by  the  three
  1285. commands "COUNTERLEN",  "LEFTBRACKET" and "RIGHTBRACKET". As well as you can
  1286. have them  removed, while  by default  FileHerald will not touch them. "FIT"
  1287. also means,  that they  are changed  if they  do not  look the  way you have
  1288. defined.
  1289.  
  1290. -------------------------------------------------------------------------
  1291.  
  1292. FILEORDER;           <IGNORE,[!]ALPHA,[!]DATE,[!]SIZE,[!]NEW>  (IGNORE)
  1293.  
  1294. FileHerald sorts  your area  files as defined with "FILEORDER". You can only
  1295. give one of the following commands :
  1296.  
  1297. IGNORE   leave original order untouched
  1298. ALPHA    sort by filenames
  1299. DATE     sort by date
  1300. SIZE     sort by filesize
  1301.  
  1302. You may  optionally give  this command  together  with  one  of  the  above.
  1303. FileHerald puts  new files  at the beginning (Files newer than the number of
  1304. days specified  with "MINDAYS")  and sorts  both sections as stated with the
  1305. other command:
  1306.  
  1307. NEW      new files first
  1308.  
  1309. A "!" reverses the sort order. Examples:
  1310.  
  1311. FILEORDER ALPHA, NEW  Sort by filename, new files first
  1312. FILEORDER !DATE       Sort by date, the oldest file first
  1313. FILEORDER SIZE, !NEW  Sort by size, old files first
  1314.  
  1315.                                                                 29
  1316. The [REPACK]-section
  1317.  
  1318. FileHerald can automatically repack new uploads to your own packer. You need
  1319. an external utility to do it, but this gives you the opportunity to use your
  1320. favourite software.  But, of  course, you  are always  sure that the correct
  1321. filenames are in your lists (as they change with the archive type).
  1322.  
  1323. REPACKCOMMAND;       <command>
  1324.  
  1325. This the  repack command,  here REARJ.  The first  "%s" is replaced by the ;
  1326. file to  repack. Re-comment  it out to enable repacking. You may use another
  1327. repacker, you  just have  to enter  the correct  command and command line to
  1328. call it:
  1329.  
  1330. REPACKCOMMAND  rearj %s /tARJ /u /d /v /s >NUL
  1331.  
  1332. Here's an overview on the command line switches of REARJ:
  1333.  
  1334.   /a[suffix] convert archives within archives ("*" for all formats)
  1335.   /bcommand  execute DOS command before extracting files
  1336.   /ccommand  execute DOS command on extracted files before counting them
  1337.   /d         delete original archives
  1338.   /e         do not return error if no archives were found
  1339.   /f         convert diskette archives
  1340.   /i[name]   check integrity of REARJ.EXE
  1341.   /l[name]   write append log file (default name is REARJ.LOG)
  1342.   /o         allow overwrite of existing target archive
  1343.   /q         query for each archive to convert
  1344.   /r         recurse through subdirectories
  1345.   /s         skip verify of file count and total size
  1346.   /tsuffix   create suffix type archives
  1347.   /u[bak]    allow update of archive with backup (default is BAK)
  1348.   /v         execute configured command on extracted files
  1349.   /wdir      assign work directory
  1350.   /xfile     exclude file or wildname
  1351.   /z         simulate operation
  1352.  
  1353. REPACKEXTENSION;     <3 letters>
  1354.  
  1355. Enter here  which  extension  the  target  archives  should  have.  This  is
  1356. mandatory, otherwise you will not find the correct filenames in your lists!!
  1357.  
  1358.                                                                 30
  1359. -------------------------------------------------------------------------
  1360.  
  1361. This is the set of error messages and corresponding errorlevels. "TrashFile"
  1362. decides wether the file is trashed when that particular error occurrs:
  1363.  
  1364. ERRORLEVEL;          <value>
  1365. ERRORMESSAGE;        <Text string>
  1366. TRASHFILE;           <YES|NO>              (NO)
  1367.  
  1368. These commands  can be  given several  times to  define the  complete set of
  1369. errorlevel functions  supported by your re-packer. Errorlevel 0 always means
  1370. "repacking okay" (and must not be defined here). An unkown error code always
  1371. results in  trashing that  particular file.  You  may  omit  these  commands
  1372. completely, but  then  every  file  will  be  trashed  whenever  a  non-zero
  1373. errorlevel is reported.
  1374.  
  1375. Refer to the docs of your repacker if you want to user your own to enter the
  1376. correct data here. This is an example:
  1377.  
  1378. ErrorLevel 1
  1379. ErrorMessage File not found
  1380. TrashFile NO
  1381.  
  1382. "Errorlevel" always  has to  be the  first of these three commands, the next
  1383. two will be related to that level. The levels do not have to be in order but
  1384. the same level must not have duplicate entries.
  1385.  
  1386. -------------------------------------------------------------------------
  1387.  
  1388. SKIPREPACK;
  1389.  
  1390. These are  the areas  which you  do not want to be repacked. There are three
  1391. ways to specify the areas. First is by its number, which may look like this:
  1392.  
  1393. 26    means area number 26
  1394. -3    means area 1,2 and 3
  1395. 30-   means area 30 and every following area
  1396. 7-9   means area 7,8 and 9
  1397.  
  1398. Exactly by its name:
  1399.  
  1400. "TOOLS"  specifies the area "Tools", of course case insensitive
  1401.  
  1402. By name, but using regular expressions:
  1403.  
  1404. '*CD-ROM*' fits any area name with "CD-ROM" in it, this is case insensitive,
  1405.            too
  1406.  
  1407.                                                                 31
  1408. The [ANNOUNCE]-section
  1409.  
  1410. The following  commands allow  you to control the announcement function, the
  1411. looks of the messages
  1412.  
  1413. -------------------------------------------------------------------------
  1414.  
  1415. CREATEMESSAGE;       <NO|YES>                 (NO)
  1416.  
  1417. This command enables announcement messages.
  1418.  
  1419. -------------------------------------------------------------------------
  1420.  
  1421. SKIPANNOUNCE;        <list of areas>
  1422.  
  1423. These are  the areas  which you do not want to be announced. There are three
  1424. ways to specify the areas. First is by its number, which may look like this:
  1425.  
  1426. 26    means area number 26
  1427. -3    means area 1,2 and 3
  1428. 30-   means area 30 and every following area
  1429. 7-9   means area 7,8 and 9
  1430.  
  1431. Exactly by its name:
  1432.  
  1433. "TOOLS"  specifies the area "Tools", of course case insensitive
  1434.  
  1435. By name, but using regular expressions:
  1436.  
  1437. '*CD-ROM*' fits any area name with "CD-ROM" in it, this is case insensitive,
  1438.            too
  1439.  
  1440. -------------------------------------------------------------------------
  1441.  
  1442. UPDATELIST;          <NO|YES>                 (YES)
  1443.  
  1444. By default  FileHerald updates  the list  of files  he has already announced
  1445. every time  he created  a message.  With this  command you  can disable this
  1446. function.
  1447.  
  1448. -------------------------------------------------------------------------
  1449.  
  1450. LISTFILE;            <filename>               (HERALD.OLD)
  1451.  
  1452. This command  defines the name of the old files list, in which all announced
  1453. files are  stored by  their name.  FileHerald uses this list to identify new
  1454. files. You  can manually  delete or  add files  if you want to. Although the
  1455. format is DOS-like, you can also enter names in the "FILENAME.EXT" format.
  1456.  
  1457. -------------------------------------------------------------------------
  1458.  
  1459. MAXLEVEL;            <value>                  (32000)
  1460.  
  1461. This is  the maximum security level an area may have to be announced. If you
  1462. enter 100 any area having more than 100 will not be announced.
  1463.  
  1464.                                                                 32
  1465. -------------------------------------------------------------------------
  1466.  
  1467. ANNOUNCEALWAYS;      <list of filenames>
  1468.  
  1469. Any file  you define  here will  always be announced. Wildcards are allowed,
  1470. FileHerald uses his own pattern matching mechanism.
  1471.  
  1472. ANNOUNCENEVER;       <list of filenames>
  1473.  
  1474. This command  works like  "ANNOUNCEALWAYS", but exactly the other way round.
  1475. Any file  matching one  of those  in this  list  will  never  be  announced.
  1476. Wildcard patterns are allowed.
  1477.  
  1478. ANNOUNCEMISSING;      <YES|NO>                (NO)
  1479.  
  1480. By default files without a description will not be announced. You may switch
  1481. that on  using this  keyword, but  remember it is not of much use for anyone
  1482. who reads  you messages  when files  are presented  without a hint what they
  1483. represent.
  1484.  
  1485. DESCRJUSTIFIED;      <YES|NO>                (NO)
  1486.  
  1487. If you  want justified description texts in your announcements, enable this.
  1488. But note  that it  only works  properly if  you have very long descriptions,
  1489. e.g., mostly about three to five lines. Otherwise the optical effect will be
  1490. inferior.
  1491.  
  1492. -------------------------------------------------------------------------
  1493.  
  1494. MINFILES;            <value>                  (5)
  1495.  
  1496. This is  the number  of new  files which  at least  have to  be  found  that
  1497. FileHerald creates a message.
  1498.  
  1499. -------------------------------------------------------------------------
  1500.  
  1501. SCANMODE;            <NORMAL|STRICT>          (NORMAL)
  1502.  
  1503. Determines how  files are compared. Normally files with different extensions
  1504. are considered  equal, so  that if you repack a file for example from ZIP to
  1505. ARJ it will not be announced again. If you choose "STRICT" this will happen.
  1506.  
  1507.                                                                 33
  1508. -------------------------------------------------------------------------
  1509.  
  1510. MSGHEADER;           <filename>               (MSGHEAD.TXT)
  1511.  
  1512. You can  specify one  or more  header files  here, seperated by kommas. They
  1513. will be  put before  the message.  Please do not define too large files here
  1514. because it might annoy cost sensitive fellows.
  1515.  
  1516. AREAHEADER;          <filename>               (MSGAREA.TXT)
  1517.  
  1518. This template file defines the look of every area header.
  1519.  
  1520. MSGFOOTER;           <filename>               (MSGFOOT.TXT)
  1521.  
  1522. These footer  files will be put under the messages. Enter one or more names,
  1523. seperated by kommas, here. Of course their length fullfill the same terms as
  1524. for the headers.
  1525.  
  1526. -------------------------------------------------------------------------
  1527.  
  1528. MSGMAXLINES;         <value>                  (1)
  1529.  
  1530. This is  the maximum number of lines you allow for one file. "0" means don't
  1531. care, any other number means that a maximum of so much lines will be used.
  1532. -------------------------------------------------------------------------
  1533.  
  1534. MSGLINEFORMAT;       <SIZE|DATE|TIME>
  1535.  
  1536. By default only the filename and its description shows in each line. You can
  1537. specify any  combination of  commands you  like here.  The  order  does  not
  1538. matter, in  the line  it will  always be size, date, time. How date and time
  1539. look like depends on the definitions in the [SYSTEM]-section.
  1540.  
  1541. Examples:
  1542.  
  1543. MSGLINEFORMAT SIZE DATE -> FILENAME 36725   12.12.1993
  1544. MSGLINEFORMAT DATE TIME -> FILENAME 12.12.1993  11:02:22
  1545.  
  1546. -------------------------------------------------------------------------
  1547.  
  1548. MSGLINELEN;          <value>                  (78)
  1549.  
  1550. This value  is the  maximum number  of characters that can be in one line. A
  1551. word that exeeds this limit will be wrapped to the next line. Take care with
  1552. the headers,  footers and area templates, because they will not be truncated
  1553. or wrapped  around in  any way  if their  lines are  too long.  This is your
  1554. concern.
  1555.  
  1556.                                                                 34
  1557. -------------------------------------------------------------------------
  1558.  
  1559. MSGEOLMARK;          <string|~string>
  1560.  
  1561. This offers  you the  possibility to  let FileHerald  begin a new line for a
  1562. certain word.  Many sysops  keep the  names of  every uploader in their area
  1563. files, allowing  downloaders to  know the  origin of  the file. For SuperBBS
  1564. that displays  as "Uploader:  xxxx". It  looks nice  when  it  stands  in  a
  1565. seperate line.
  1566.  
  1567. If you  enter "FILEEOLMARK  ~Uploader:" FileHerald  puts "Uploader:" and the
  1568. rest of the text into a new line. It is not case insensitive, but works only
  1569. for the  first occurrence  of the  string. If you just enter "Uploader:" the
  1570. string itself and the rest of the line will be cut away.
  1571.  
  1572. This makes the announcements shorter and removes unnecessary information.
  1573.  
  1574. -------------------------------------------------------------------------
  1575.  
  1576. MSGFILECASE;         <IGNORE|CAPITALIZE|LOWERCASE> (IGNORE)
  1577.  
  1578. Depending on  your personal  taste you can change your filenames to upper or
  1579. lower case  using this keyword. If you enter "IGNORE" nothing will happen to
  1580. them and they will stay as your BBS system creates them.
  1581.  
  1582. MSGFILEFORMAT;       <DEFAULT|DOS>                 (DEFAULT)
  1583.  
  1584. Also a  matter of taste is how you want your file names formatted. "DEFAULT"
  1585. means the  common "FILENAME.EXT"-look,  "DOS" refers  to the  outfit of  DIR
  1586. listings.
  1587.  
  1588. -------------------------------------------------------------------------
  1589.  
  1590. MSGDLCOUNTER;        <IGNORE|STRIP>                (IGNORE)
  1591.  
  1592. "STRIP" removes  the counters  from the descriptions, thus reducing the size
  1593. of the messages. "IGNORE" by default leaves them untouched.
  1594.  
  1595.                                                                 35
  1596. -------------------------------------------------------------------------
  1597.  
  1598. MSGORDER;            <IGNORE,[!]ALPHA,[!]DATE,[!]SIZE,[!]NEW>  (IGNORE)
  1599.  
  1600. FileHerald sorts your messages as defined with "MSGORDER". You can only give
  1601. one of the following commands:
  1602.  
  1603. IGNORE   leave original order untouched
  1604. ALPHA sort by filenames
  1605. DATE     sort by date
  1606. SIZE     sort by filesize
  1607.  
  1608. You may  optionally give  this command  together  with  one  of  the  above.
  1609. FileHerald puts  new files  at the beginning (Files newer than the number of
  1610. days specified  with "MINDAYS")  and sorts  both sections as stated with the
  1611. other command:
  1612.  
  1613. NEW      new files first
  1614.  
  1615. A "!" reverses the sort order. Examples:
  1616.  
  1617. MSGORDER ALPHA, NEW  Sort by filename, new files first
  1618. MSGORDER !DATE       Sort by date, the oldest file first
  1619. MSGORDER SIZE, !NEW  Sort by size, old files first
  1620.  
  1621. -------------------------------------------------------------------------
  1622.  
  1623. MSGTYPE;             <TEXT|ECHO|FIDO|SQUISH>
  1624.  
  1625. This command determines the message types that will be created.
  1626.  
  1627. Echomail, fidostyle and squish messages are currently not supported.
  1628.  
  1629. -------------------------------------------------------------------------
  1630.  
  1631. MSGNAME;             <filename>               (MESSAGE.TXT)
  1632.  
  1633. This is the name of the text message.
  1634.  
  1635. -------------------------------------------------------------------------
  1636.  
  1637. MSGMAXLEN;           <value in Kbytes)        (12)
  1638.  
  1639. Some mail processors do not support large messages. You can limit their size
  1640. using this  word. Larger  messages will  be split  into a  decent amount  of
  1641. mails. The  maximum value  here is  16 KB,  you should not change it because
  1642. some mail processors could get in trouble otherwise.
  1643.  
  1644. -------------------------------------------------------------------------
  1645.  
  1646. NETPATH;             <path>
  1647.  
  1648. Defines the path to your fidostyle (*.MSG) messages. Only necessary when you
  1649. enable "FIDO" with "MSGTYPE".
  1650.  
  1651. ECHOPATH;            <path>
  1652.  
  1653. Defines the  path to your hudson style message base. Only necessary when you
  1654. enable "ECHO" with "MSGTYPE".
  1655.  
  1656.                                                                 36
  1657. The [NETMAIL]-section
  1658.  
  1659. This is  all necessary  data for  a netmail.  You can  specify a  footer  by
  1660. "PVTFOOT" which will only be appended to that particular message.
  1661.  
  1662. -------------------------------------------------------------------------
  1663.  
  1664. MSGNO;               <value>             (1)
  1665.  
  1666. Each message  has to  have a uniqe number using the "MSGNO" command. You can
  1667. let FileHerald create certain messages or all at one time.
  1668.  
  1669. Message no  1 provides the default values for all following messages. So you
  1670. just have  to change those which are different. Theoretically you can create
  1671. 65535 fidostyle messages.
  1672.  
  1673. -------------------------------------------------------------------------
  1674.  
  1675. FROM;           <sender name>            (SYSOPNAME)
  1676. TO;             <receiver name>
  1677. SUBJECT;        <text string>            ("New files at BBSADDRESS")
  1678.  
  1679. It is possible to attach files to your announcement messages. Enter path and
  1680. filename as  subject and specify "ATT" with the "ATTRIB"-command. FileHerald
  1681. does not  check if  the file exists, so take care that filename and path are
  1682. correct.
  1683.  
  1684. ORIGADDR;       <fidostyle address>      (BBSADDRESS)
  1685. DESTADDR;       <fidostyle address>
  1686.  
  1687. If you  omit any  of the  address fractions,  they will  be replaced  by the
  1688. corresponding value of your BBS address.
  1689.  
  1690. Some examples, if you were 77:222/123, the results will look like:
  1691.  
  1692. DestAddr 233    Result 77:222/233
  1693. DestAddr 332/2  Result 77:332/2
  1694.  
  1695. ATTRIB;         <list of attributes>     (K/S PVT)
  1696.  
  1697. Possible attributes for fidostyle messages are:
  1698.  
  1699. PVT    Private message
  1700. CRA    Crash mail
  1701. FIL    File attach (valid path and filename must be in subject)
  1702. K/S    Kill after sent
  1703. LOC    Local message
  1704. HLD    Hold for pick-up
  1705. FRQ    File request (valid filename(s) must be in subject)
  1706. RRQ    Return receipt request
  1707.  
  1708. NETPATH;        <path>                   (NETPATH)
  1709.  
  1710. Allows you  to specify a different path for this particular mail. Registered
  1711. users only.
  1712.  
  1713. Sysop name and BBS address can only be changed by registered users.
  1714.  
  1715.                                                                 37
  1716. The [ECHOMAIL]-section
  1717.  
  1718. This is all necessary data for an echomail.
  1719.  
  1720. -------------------------------------------------------------------------
  1721.  
  1722. MSGNO;          <value>             (1)
  1723.  
  1724. Each message  has to  have a uniqe number using the "MSGNO" command. You can
  1725. let FileHerald create certain messages or all at one time.
  1726.  
  1727. Message no  1 provides the default values for all following messages. So you
  1728. just have  to change those which are different. Theoretically you can create
  1729. 65535 echomail  messages. This, of course, exceeds the number of echomails a
  1730. hudson style message base can hold.
  1731.  
  1732. FROM;           <sender name>            (SYSOPNAME)
  1733. TO;             <receiver name>          ("ALL")
  1734. SUBJECT;        <text string>            ("New files at BBSADDRESS")
  1735. ORIGADDR;       <fidostyle address>      (BBSADDRESS)
  1736. ORIGIN;         <text string>
  1737. BOARD;          <board number>
  1738.  
  1739. Sysop name and BBS address can only be changed by registered users.
  1740.  
  1741.                                                                 38
  1742. The [SQUISH]-section
  1743.  
  1744. This is all necessary data for a squish mail.
  1745.  
  1746. -------------------------------------------------------------------------
  1747.  
  1748. MSGNO;          <value>             (1)
  1749.  
  1750. Each message  has to  have a uniqe number using the "MSGNO" command. You can
  1751. let FileHerald create certain messages or all at one time.
  1752.  
  1753. Message no  1 provides the default values for all following messages. So you
  1754. just have  to change those which are different. Theoretically you can create
  1755. 65535 squish messages.
  1756.  
  1757. FROM;           <sender name>            (SYSOPNAME)
  1758. TO;             <receiver name>          ("ALL")
  1759. SUBJECT;        <text string>            ("New files at BBSADDRESS")
  1760. ORIGADDR;       <fidostyle address>      (BBSADDRESS)
  1761. SQUISHPATH;     <path>
  1762.  
  1763. Squish path is the path and area name wher this message should be posted in.
  1764.  
  1765. Sysop name and BBS address can only be changed by registered users.
  1766.  
  1767.                                                                 39
  1768. The [FILELIST]-section
  1769.  
  1770. This section  sets up  all paramaters that define your lists. FileHerald can
  1771. create up  to 65535  file lists  at one pass. List no 1 provides the default
  1772. parameters for  all following  lists. You can change them separatly for each
  1773. list.
  1774.  
  1775. -------------------------------------------------------------------------
  1776.  
  1777. LISTNO;              <value>                  (1)
  1778.  
  1779. Each list has to have a uniqe number using the "LISTNO" command. You can let
  1780. FileHerald create certain lists or all at one time.
  1781.  
  1782. -------------------------------------------------------------------------
  1783.  
  1784. CREATFILELIST;      <NO|YES>                 (YES)
  1785.  
  1786. Enables the list function. If set to "NO", no list at all is created.
  1787.  
  1788. -------------------------------------------------------------------------
  1789.  
  1790. MAXDAYS;             <value>                  (10)
  1791.  
  1792. The maximum  number of  days a  file may be old to be added to the new files
  1793. list. All  these  files  will  be  marked  with  an  asterisk  before  their
  1794. description.
  1795.  
  1796. -------------------------------------------------------------------------
  1797.  
  1798. MAXLEVEL;            <value>                  (32000)
  1799.  
  1800. This is  the maximum  security level  an area  may have to be listed. If you
  1801. enter 100  any area  having more  than 100  will not  show up  in the  list.
  1802. Allowed are values between 0 and 65535.
  1803.  
  1804. -------------------------------------------------------------------------
  1805.  
  1806. ALLFILESLIST;        <filename>               (ALLFILES.TXT)
  1807.  
  1808. This is the filename of the complete list.
  1809.  
  1810. NEWFILESLIST;        <filename>               (NEWFILES.TXT)
  1811.  
  1812. This is  the filename  for the new files list. The default value is only for
  1813. list no 1, for every following list a new files list will only be created if
  1814. a filename is explicitely defined.
  1815.  
  1816.                                                                 40
  1817. -------------------------------------------------------------------------
  1818.  
  1819. INFOFILE;            <filename>
  1820.  
  1821. If defined,  an info  file showing  a brief  overview of all file areas your
  1822. system has.  It will only show those areas that are listed. Areas with a too
  1823. high security  level or  which are found in "SKIPLIST" will not show. Herald
  1824. creates two  nearly identical  files, one  named as  above and  one with the
  1825. extension "ANS".  The latter  will contain  ANSI sequences  to colorise  it.
  1826. These sequences are stripped for the "normal" version.
  1827.  
  1828. You can allow your users to display the ANSI version in your BBS.
  1829.  
  1830. APPENDINFO;          <NO|YES>                 (NO)
  1831.  
  1832. Whether the (ASCII) infofile is appended to the end of the lists.
  1833.  
  1834. INFOHEADER;          <text string>
  1835.  
  1836. These three  strings work  just like  the template  files. You can give this
  1837. commands several times. Each command starts a new line. Please consider that
  1838. each template string can not be longer than 1024 characters. As newlines are
  1839. stored in  these strings  you have  to add one character for every line. Any
  1840. character exceeding this limit will simply be discarded.
  1841.  
  1842. AREAINFO;            <template string>
  1843.  
  1844. In AREAINFO you may use the following tokens:
  1845.  
  1846. ~A Areaname left justified                   (40 characters)
  1847. ~B Areaname right justified                  (40 characters)
  1848. ~# Areanumber                                ( 3 characters)
  1849. ~L Access level to the current area          ( 5 characters)
  1850. ~+ Minimum age to the current area           ( 3 characters)
  1851. ~F Number of files in the particular area    ( 5 characters)
  1852. ~G Actual number of files                    ( 5 characters)
  1853. ~S Size of all files in this area in kBytes  ( 6 characters)
  1854. ~M Size of all files in this area in MBytes  ( 6 characters)
  1855. ~D Number of downloads from this area        ( 6 characters)
  1856. ~R File request info (short)                 (10 characters)
  1857.  
  1858. For example "AreaInfo | ~# | ~A  | ~F | ~S | ~D | ~R |" creates the
  1859. following result:
  1860.  
  1861. |  5 | Utilities/Tools  |  146 |  12702 |  115 | anyone  |
  1862.  
  1863. INFOFOOTER;          <template string>
  1864.  
  1865. ~F Number of files in the particular area    ( 5 characters)
  1866. ~G Actual number of files                    ( 5 characters)
  1867. ~S Size of all files in this area in kBytes  ( 6 characters)
  1868. ~M Size of all files in this area in MBytes  ( 6 characters)
  1869. ~D Number of downloads from this area        ( 6 characters)
  1870. ~% Current date as defined by DATEFORMAT
  1871. ~$ Current time as defined by TIMEFORMAT
  1872.  
  1873.                                                                 41
  1874. For the ANSI version you can use these commands to colorise it:
  1875.  
  1876. %CLRSCR%    clear screen
  1877. %NORMAL%    all colors to default
  1878. %BRIGHT%    bright colors
  1879. %BLINK%     blinking colors
  1880. %INVERSE%   inverse colors
  1881. %RESET%     reset all attributes
  1882.  
  1883. Foreground colors
  1884.  
  1885. %FGBLACK%   black
  1886. %FGRED%     red
  1887. %FGGREEN%   green
  1888. %FGYELLOW%  yellow
  1889. %FGBLUE%    blue
  1890. %FGMAGENTA% magenta
  1891. %FGCYAN%    cyan
  1892. %FGWHITE%   white
  1893.  
  1894. Background colors
  1895.  
  1896. %BGBLACK%   black
  1897. %BGRED%     red
  1898. %BGGREEN%   green
  1899. %BGYELLOW%  yellow
  1900. %BGBLUE%    blue
  1901. %BGMAGENTA% magenta
  1902. %BGCYAN%    cyan
  1903. %BGWHITE%   white
  1904.  
  1905. -------------------------------------------------------------------------
  1906.  
  1907. MISSINGFILE;         <short text string>      (<missing>)
  1908.  
  1909. Short message that show if a file is missing in your base. It will be placed
  1910. instead of size, date and/or time.
  1911.  
  1912.                                                                 42
  1913. -------------------------------------------------------------------------
  1914.  
  1915. REQOKMSG;             <text string>
  1916.  
  1917. This text  string should  contain the  info "Filerequests  possible in  this
  1918. area".
  1919.  
  1920. SHORTREQOKMSG;        <text string>
  1921.  
  1922. Same as above, only a shorter version, "anyone" for example.
  1923.  
  1924. NOREQMSG;            <text string>
  1925.  
  1926. This text string should read like "No requests possible from this area".
  1927.  
  1928. SHORTNOREQMSG;       <text string>
  1929.  
  1930. This text string should read like "none".
  1931.  
  1932. PWDONLYMSG;          <text string>
  1933.  
  1934. This informs the user about "Requests only possible with password".
  1935.  
  1936. SHORTPWDONLYMSG;          <text string>
  1937.  
  1938. Could be "password" for example.
  1939.  
  1940. NOFILEREQ;           <list of areas>
  1941. PWDFILEREQ;          <list of areas>
  1942.  
  1943. These commands  allow you  to define  the area  which  allow  requests  with
  1944. password or  no requests  at all.  The list  of areas has to be formatted as
  1945. written below in "SKIPLIST".
  1946.  
  1947. -------------------------------------------------------------------------
  1948.  
  1949. SKIPLIST;            <list of areas>
  1950.  
  1951. These are the areas which you do not want to be listed. There are three ways
  1952. to specify the areas. First is by its number, which may look like this:
  1953.  
  1954. 26    means area number 26
  1955. -3    means area 1,2 and 3
  1956. 30-   means area 30 and every following area
  1957. 7-9   means area 7,8 and 9
  1958.  
  1959. Exactly by its name:
  1960.  
  1961. "TOOLS"  specifies the area "Tools", of course case insensitive
  1962.  
  1963. By name, but using regular expressions:
  1964.  
  1965. '*CD-ROM*' fits any area name with "CD-ROM" in it, this is case insensitive,
  1966. too
  1967.  
  1968.                                                                 43
  1969. -------------------------------------------------------------------------
  1970.  
  1971. LISTHEADER;          <filename>               (LISTHEAD.TXT)
  1972.  
  1973. You can  specify one  or more  header files  here, seperated by kommas. They
  1974. will be put before the lists.
  1975.  
  1976. AREAHEADER;          <filename>               (LISTAREA.TXT)
  1977.  
  1978. This template file defines the look of every area header.
  1979.  
  1980. LISTFOOTER;          <filename>               (LISTFOOT.TXT)
  1981.  
  1982. These footer  files will  be put  under the  lists. Enter one or more names,
  1983. seperated by kommas, here.
  1984.  
  1985. -------------------------------------------------------------------------
  1986.  
  1987. LISTLINEFORMAT;      <SIZE|DATE|TIME>
  1988.  
  1989. By default only the filename and its description shows in each line. You can
  1990. specify any  combination of  commands you  like here.  The  order  does  not
  1991. matter, in  the line  it will  always be size, date, time. How date and time
  1992. look like depends on the definitions in the [SYSTEM]-section.
  1993.  
  1994. Examples:
  1995.  
  1996. LISTLINEFORMAT SIZE DATE   -> FILENAME 36725   12.12.1993
  1997. LISTLINEFORMAT DATE TIME   -> FILENAME 12.12.1993  11:02:22
  1998.  
  1999. -------------------------------------------------------------------------
  2000.  
  2001. LISTMAXLINES;        <value>                  (1)
  2002.  
  2003. This is  the maximum number of lines you allow for one file. "0" means don't
  2004. care, any other number means that a maximum of so much lines will be used.
  2005.  
  2006. -------------------------------------------------------------------------
  2007.  
  2008. LISTLINELEN;         <value>                  (78)
  2009.  
  2010. This value  is the  maximum number  of characters that can be in one line. A
  2011. word that exeeds this limit will be wrapped to the next line. Take care with
  2012. the headers,  footers and area templates, because they will not be truncated
  2013. or wrapped  around in  any way  if their  lines are  too long.  This is your
  2014. concern.
  2015.  
  2016. -------------------------------------------------------------------------
  2017.  
  2018. LISTEOLMARK;         <string|~string>
  2019.  
  2020. This offers  you the  possibility to  let FileHerald  begin a new line for a
  2021. certain word.  Many sysops  keep the  names of  every uploader in their area
  2022. files, allowing  downloaders to  know the  origin of  the file. For SuperBBS
  2023. that displays  as "Uploader:  xxxx". It  looks nice  when  it  stands  in  a
  2024. seperate line.
  2025.  
  2026. If you  enter "LISTEOLMARK  ~Uploader:" FileHerald  puts "Uploader:" and the
  2027. rest of the text into a new line. It is not case insensitive, but works only
  2028. for the  first occurrence  of the  string. If you just enter "Uploader:" the
  2029. string itself and the rest of the line will be cut away.
  2030.  
  2031.                                                                 44
  2032.  
  2033. This keeps lists short and removes unnecessary information.
  2034.  
  2035. -------------------------------------------------------------------------
  2036.  
  2037. LISTFILECASE;        <IGNORE|CAPITALIZE|LOWERCASE> (IGNORE)
  2038.  
  2039. Depending on  your personal  taste you can change your filenames to upper or
  2040. lower case  using this keyword. If you enter "IGNORE" nothing will happen to
  2041. them and they will stay as your BBS system creates them.
  2042.  
  2043. LISTFILEFORMAT;      <DEFAULT|DOS>            (DEFAULT)
  2044.  
  2045. Also a  matter of taste is how you want your file names formatted. "DEFAULT"
  2046. means the  common "FILENAME.EXT"-look,  "DOS" refers  to the  outfit of  DIR
  2047. listings.
  2048.  
  2049. -------------------------------------------------------------------------
  2050.  
  2051. LISTDLCOUNTER;       <IGNORE|STRIP>           (IGNORE)
  2052.  
  2053. "STRIP" removes  the counters  from the descriptions, thus reducing the size
  2054. of the messages. "IGNORE" by default leaves them untouched.
  2055.  
  2056. -------------------------------------------------------------------------
  2057.  
  2058. LISTORDER;           <IGNORE,[!]ALPHA,[!]DATE,[!]SIZE,[!]NEW>  (IGNORE)
  2059.  
  2060. FileHerald sorts your messages as defined with "MSGORDER". You can only give
  2061. one of the following commands:
  2062.  
  2063. IGNORE   leave original order untouched
  2064. ALPHA    sort by filenames
  2065. DATE     sort by date
  2066. SIZE     sort by filesize
  2067.  
  2068. You may  optionally give  this command  together  with  one  of  the  above.
  2069. FileHerald puts  new files  at the beginning (Files newer than the number of
  2070. days specified  with "MINDAYS")  and sorts  both sections as stated with the
  2071. other command:
  2072.  
  2073. NEW      new files first
  2074.  
  2075. A "!" reverses the sort order. Examples:
  2076.  
  2077. LISTORDER ALPHA, NEW  Sort by filename, new files first
  2078. LISTORDER !DATE       Sort by date, the oldest file first
  2079. FILEORDER SIZE, !NEW  Sort by size, old files first
  2080. -------------------------------------------------------------------------
  2081.  
  2082. DESCRJUSTIFIED;      <YES|NO>                (NO)
  2083.  
  2084. If you  want justified description texts in your announcements, enable this.
  2085. But note  that it  only works  properly if  you have very long descriptions,
  2086. e.g., mostly about three to five lines. Otherwise the optical effect will be
  2087. inferior.
  2088.  
  2089.  
  2090.                                                                 45
  2091. CREATING FILELISTS
  2092.  
  2093. When you want to create file lists with FileHerald, you first have to set up
  2094. at least  list no  1 ("LISTNO 1"). Enter the names of your lists, what areas
  2095. should be  listed. Then call Herald with the "/m0" and "/u0" switches if you
  2096. don't want him to create messages or update the old files list.
  2097.  
  2098. When you want to create a certain list, add for example "/l2" to create list
  2099. no 2.  Of course  it has  to be  defined in  HERALD.CFG. You  can enter this
  2100. switch several times to create more lists or use "/la" to create all defined
  2101. lists, but this is default anyway.
  2102.  
  2103. CREATING MESSAGES
  2104.  
  2105. Defining Multiple Lists and Messages
  2106.  
  2107. Herald can  theoretically handle  up to 65535 filelists and messages of each
  2108. type. Of  course this  is limited to less than that by the amount of time it
  2109. would take  for the  lists and by the maximum number of messages your Hudson
  2110. style base or harddisk drive can keep.
  2111.  
  2112. Each single  list or message must be assigned a unique number. These numbers
  2113. do not  have to  be in  their natural order and it is not necessary that all
  2114. preceding values are there. But there has to be a fraction number 1, because
  2115. it supplies  default values  for all  following fractions  (there  are  some
  2116. exceptions, see  below). You  may omit  the keyword "MSGNO 1" or "LISTNO 1",
  2117. anything that  stands before  the next number definition will be taken as if
  2118. this word was there.
  2119.  
  2120. If a  number exists  several times,  these fractions  will be handled as one
  2121. even if  they are  not direct neighbours, so it is your concern to make sure
  2122. that the numbers really are unique.
  2123.  
  2124. Exeptions to Defaults
  2125.  
  2126. Concerning lists,  everything that  is defined  in "LISTNO 1" is default for
  2127. all following  lists, but  not "BOARDS" and "NEWFILES", if you do not define
  2128. these words  explicitly in  every fraction,  no infos  and no new files list
  2129. will be  created. Take  care also  to redefine "ALLFILES", because otherwise
  2130. the older list will be overwritten.
  2131.  
  2132. For messages  everything from  "MSGNO 1" is default except in netmails where
  2133. "NETPATH" is  replaced by  its default  value for  every message  and squish
  2134. mails where  "SQUISHAREA" must  be defined  again in  every  fraction.  Also
  2135. "SUBJ", but  only if  a file is attached to message no 1 (you would not want
  2136. it to be sent to every other adressee, would you?).
  2137.  
  2138.                                                                 46
  2139. CONVERTING AREA LISTS
  2140.  
  2141. Multiple BBS systems
  2142.  
  2143. If you run Wildcat or WME and want to have valid FILES.BBS for your d'bridge
  2144. mailer, use this command line switch:
  2145.  
  2146. HERALD /oX   create X-style FILES.BBS
  2147.  
  2148. You can  let Herald  create an  additional  FILES.BBS  for  each  area.  For
  2149. SuperBBS, Opus and ProBoard they are created in the particular area path and
  2150. named FILES.BBS. It doesn't matter which type you choose (SBBS, QBBS or PB),
  2151. it makes  little difference how the files look as long as they are formatted
  2152. as d'bridge  likes them.  It is also possible to use the "EXTRAAREAFILETYPE"
  2153. keyword which has exactly the same function as the switch.
  2154.  
  2155. For Remote  Access and  RoboBBS you  will find  them in  what's  defined  by
  2156. "EXTRALISTPATH", when you set "EXTRAFILESPECNAME YES". These files are named
  2157. FILES.n where  "n" is  the number  of the particular area. The purpose is to
  2158. allow you  to run  multiple BBS  systems (e.g.  SuperBBS as  main system and
  2159. RoboBBS as an option, then each time Herald is run FILES.n for the subsystem
  2160. are generated).
  2161.  
  2162. A convenient way to support WME
  2163.  
  2164. WME's weird  area list  format makes  it hard to add new files, sort them or
  2165. anything like  this. So  if you  run WME,  you can  set "AreaFileType  WME",
  2166. "BBSType SBBS"  and "ExtraListType  WME". Of  course you also have to define
  2167. the correct path were WME wants its area files with "ExtraListPath".
  2168.  
  2169. Herald will  the use  WME's configuration to locate the areas, use SBBS type
  2170. FILES.BBS to store all file descriptions and create WME type area files from
  2171. them. You  just have  to change  these FILES.BBS,  add new  files or  change
  2172. descriptions as  suited. Herald takes care that a proper WME style area file
  2173. is created.
  2174.  
  2175.                                                                 47
  2176. MISCELLANOUS
  2177.  
  2178. Pattern matching rules
  2179.  
  2180. Everybody is  familiar with  MS-DOS and  its pattern matching rules. In fact
  2181. the designers  of DOS  and CP/M  did some  fairly strange  things with their
  2182. command processor  and OS. One of those things was to only selectively adopt
  2183. the regular expressions allowed within the *IX shells. Only '?' and '*' were
  2184. allowed in  filenames and  even with  these, the '*' was allowed only at the
  2185. end of  a pattern  and in fact when used to specify the filename the '*' did
  2186. not apply  to extension.  This gave  rise to  the all  too common expression
  2187. "*.*".
  2188.  
  2189. FileHerald's pattern  matching rules offer considerably wider flexibility in
  2190. file specification  or when  matching area  names is  concerned.  FileHerald
  2191. allows allows  such specifications as *75.zip or * (equivelant to *.* in DOS
  2192. lingo). The  latter will  match ANY  string of characters. If you want it to
  2193. fit only  complete names  (e.g. "test.bat")  you have  to explicitly specify
  2194. "*.*".
  2195.  
  2196. Expressions  such   as  "[a-e]*t"   would  fit   the  name   "apple.crt"  or
  2197. "catspaw.bat" or  "elegant". So you are able to define much more closely the
  2198. name of  the file  you want  to fit  to your  expression then  it  would  be
  2199. possible using merely MS-DOS matchin rules.
  2200.  
  2201. For example  "FNEWS*.*" would  match "FNEWS29.LZH" as well as "FNEWSCAN.ARJ"
  2202. and eventually  lead to  incorrect behaviour  of FileHerald. However, if you
  2203. use "FNEWS[0-9][0-9].LZH" it will only fit if two digits follow the name.
  2204.  
  2205. In the specified pattern string...
  2206.  
  2207. ...`*' matches any sequence of characters (zero or more)
  2208. ...`?' matches any character
  2209. ...`\' suppresses syntactic significance of a special character
  2210. ...[SET] matches any character in the specified set,
  2211. ...[!SET] or [^SET] matches any character not in the specified set.
  2212.  
  2213. A set  is composed  of characters  or ranges  a range  looks like 'character
  2214. hyphen character'  (as in  0-9 or  A-Z).  [0-9a-zA-Z_] is the minimal set of
  2215. characters allowed in the [..] pattern construct.
  2216.  
  2217. To suppress  the special  syntactic significance  of any  of `[]*?!^-\', and
  2218. match the character exactly, precede it with a `\'.
  2219.  
  2220.                                                                 48
  2221. Command line switches
  2222.  
  2223. HERALD /c<filename>  use 'filename' as configuration file
  2224.  
  2225. This switch  allows you  to temporarily  use a  different configuration file
  2226. instead of HERALD.CFG.
  2227.  
  2228. HERALD /s         work silent, without most of the screen writes
  2229.  
  2230. That switch  supresses most  screen writes  so FileHerald  run a  little bit
  2231. faster on  slower machines.  On the  other hand  if it  runs in a night-time
  2232. event you won't need screen writes at all.
  2233.  
  2234. HERALD /d0     do not update DESCRIPT.IONs
  2235. HERALD /d1     add new files to DESCRIPT.IONs only
  2236. HERALD /d2     update all DESCRIPT.IONs completely
  2237.  
  2238. If you  use 4DOS  and want  to have  all descriptions available for its dir-
  2239. command, you  can run Herald with "/D2". He will look for each file if it is
  2240. already described and if not insert it. If an area lacks such a DESCRIPT.ION
  2241. file, it  will be  created. Non-4DOS-user  should not  use the  /D  command,
  2242. because this is a feature which is completely useless for them.
  2243.  
  2244. "/D1" will only add files which are new. These means files which are added a
  2245. description from  COMMENT.LST or  inserted into  the area  file because they
  2246. missing AND a default description exists in COMMENT.LST.
  2247.  
  2248. This switch overrides the "UPDATE4DOSDESCR" keyword.
  2249.  
  2250. HERALD /a0     do not update area files
  2251. HERALD /a1     update area files
  2252.  
  2253. If you enter "/A0" the area files will not be updated and if you enter "/A1"
  2254. they will,  no matter what has been defined by the "UPDATEAREAFILE" keyword.
  2255. Use it to temporarily override it.
  2256.  
  2257. HERALD /u0     suppress updating HERALD.OLD
  2258.  
  2259. This allows  you to  test FileHerald  or just  use him  to create a message.
  2260. There are  keywords available for that, of course. But it is more convenient
  2261. if you want to switch this function off just one time.
  2262.  
  2263. HERALD /m0     does not create a message
  2264.  
  2265. When you  haven't run  FileHerald for  some time  you may want to update the
  2266. list of  already  announced  files  without  creating  a  huge  announcement
  2267. message. Use this swtich for that purpose.
  2268.  
  2269. The following  command line  parameters allow  you to  selectively create on
  2270. message out  of all,  all of  one style  (echomail, netmail) or all at once.
  2271. None of these switches can be combined with /m0 of course.
  2272.  
  2273. HERALD /mNn    create netmail no n
  2274. HERALD /mEn    create echomail no n
  2275. HERALD /mSn    create squish style message no n
  2276. HERALD /mA     create all messages
  2277. HERALD /mNA    create all netmail messages
  2278. HERALD /mEA    create all echomail messages
  2279. HERALD /mSA    create all squish messages
  2280.  
  2281.                                                                 49
  2282.  
  2283. You can enter these switches more than one time, e.g.
  2284.  
  2285. HERALD /mn2 /mn3 /mn6 /EA
  2286.  
  2287. will create netmail no 2, 3 and 6 and all echomails.
  2288.  
  2289. HERALD /l0    will not create a filelist
  2290.  
  2291. That switch  turns the  filelist off.  It  may  not  be  combined  with  the
  2292. following, which, similar to /m, allow you to create certain lists or all at
  2293. once:
  2294.  
  2295. HERALD /ln     create filelist defined in section n
  2296. HERALD /lA     create all filelists
  2297.  
  2298. HERALD /oX   create X-style FILES.BBS
  2299.  
  2300. You can  let Herald  create an  additional  FILES.BBS  for  each  area.  For
  2301. SuperBBS, Opus and ProBoard they are created in the particular area path and
  2302. named FILES.BBS.  This allows  Wildcat or Windowed Modem Environment to make
  2303. FILES.BBS for their d'bridge mailer.
  2304.  
  2305. For Remote  Access and  RoboBBS you  will find  them in  what's  defined  by
  2306. LISTPATH. These  files are  named FILES.n  where "n"  is the  number of  the
  2307. particular area.  The purpose  is to  allow you  to run multiple BBS systems
  2308. (e.g. SuperBBS  as main  system and  RoboBBS as  an option,  then each  time
  2309. Herald is run FILES.n for the subsystem are generated).
  2310.  
  2311. To get a brief online help, enter one of these:
  2312.  
  2313. HERALD /? and /h  displays help screen
  2314.  
  2315.                                                                 50
  2316. Errorlevels
  2317.  
  2318. 0  No errors, message(s) created
  2319. 1  No errors, no message created
  2320. 2  Error occurred, no message created
  2321. 3  Fatal error occurred, no message created
  2322. 4  Virus detected!
  2323. 5  Aborted by CTRL-BRK
  2324.  
  2325. If you  want to  know whether  a message  has been created, you just have to
  2326. check for errorlevel not zero.
  2327.  
  2328.                                                                 51
  2329. ENVIRONMENT
  2330.  
  2331. HERALD  Defines the workpath
  2332.  
  2333. Herald uses this directory to store his supporting files
  2334.  
  2335. TZ    Set system time zone
  2336.  
  2337. You can  define what timezone you are in by setting the environment variable
  2338. "TZ":
  2339.  
  2340. TZ = zzz[+|-]d[d][lll]
  2341.  
  2342. zzz       name of you time zone, EST, UTC, GMT etc.
  2343. [+|-]d[d] difference between your and world standard time (GMT) in hours
  2344.           "+" or "-" defines whether this value is to be added or subtracted
  2345. [lll]     defines if you have daylight saving time. Enter this only during
  2346.           this time period
  2347.  
  2348. These environment variables of other software are also recognized:
  2349.  
  2350. SBBS, RA, PB
  2351.  
  2352. Read "BBS SOFTWARE SUPPORTED" for more information.
  2353.  
  2354.                                                                 52
  2355. Network/multitasker operation
  2356.  
  2357. Herald has  been tested  with networks. He is capable of sharing and locking
  2358. files, you  just have to load SHARE.EXE before starting FileHerald. Problems
  2359. may occur  because FileHerald  is an ovlerlaid DOS executable which may caus
  2360. sharing violations.  If, then  change HERALD.EXE  to read-only  by  entering
  2361. "attrib +R HERALD.EXE".
  2362.  
  2363. You can  run FileHerald  more than  once at  the same  time in from a single
  2364. directory. Herald takes care that temporary files will not conflict. In that
  2365. case, you have to change Herald's attributes because otherwise you are bound
  2366. to cause a sharing violation!
  2367.  
  2368. If you  run Herald  more than once in a multitasker environment there should
  2369. be no  problem, because  FileHerald uses  his program  ID to generate unique
  2370. filenames. HERALD.OLD  and other  system files  may cause problems when both
  2371. computers try  to access  them at  the same  time. To  avoid conflicts  they
  2372. should reside in different directories for different computers.
  2373.  
  2374.                                                                 53
  2375. Multiline
  2376.  
  2377. Herald  opens   FILES.BBS  and  other  shared  files  in  "read-only"  mode.
  2378. Therefore, if  a user  browses an area while Herald wants to access it, this
  2379. should work  without problems  (as tested  with SuperBBS  and Proboard).  It
  2380. depends on  the way  the BBS  software opens  the area listings. It must not
  2381. lock them for reading.
  2382.  
  2383. A problem is when the BBS software wants to write to the area listing, e.g.,
  2384. when a  user uploaded  a file  to insert the description. What may happen is
  2385. either Herald is denied access and has to skip the area or the BBS software.
  2386. In that case you will lose the description.
  2387.  
  2388. All this  will normally not lead to a system hang, because Herald intercepts
  2389. this bloody "(r)etry, (i)gnore, (c)ancel" junk. After the lists are created,
  2390. you usually  pack the  lists and put them into an user accessible area. What
  2391. sometimes happened  on my  system was  that a  user was  downloading my list
  2392. while my filelist batch wanted to copy the new archive there and my computer
  2393. hung until I pressed "r" next morning.
  2394.  
  2395.                                                                 54
  2396. Batchfiles
  2397.  
  2398. This is  a demo  batchfile which  creates three lists. You have to configure
  2399. those  lists   using  "ListNo".  We  assume  that  you  called  these  lists
  2400. "ALLFILES.TXT", "NEWFILES.TXT", "SPECLST1.TXT" and "SPECLST2.TXT"
  2401.  
  2402. FILELIST.BAT:
  2403.  
  2404. @ECHO OFF
  2405. HERALD -M0 -U0 -L1 -L2 -L3 %1 %2
  2406.  
  2407. REM Parameters could also be "-M0 -U0" which would have the same effect
  2408. REM as long as only three lists are defined in HERALD.CFG
  2409.  
  2410. IF NOT ERRORLEVEL 0 GOTO ERROR
  2411.  
  2412. REM Here only if nothing happened on the way
  2413.  
  2414. DEL F:\FILES\FILES.ARJ
  2415. DEL F:\FILES\SPEC1LST.ARJ
  2416. DEL F:\FILES\SPEC2LST.ARJ
  2417.  
  2418. ARJ A -E -zF:\HERALD\LISTHEAD.TXT F:\FILES\FILES E:\ALLFILES.TXT
  2419. ARJ A -E -zF:\HERALD\LISTHEAD.TXT F:\FILES\NEWFILES E:\NEWFILES.TXT
  2420. ARJ A -E -zF:\HERALD\LISTHEAD.TXT F:\FILES\SPEC1LST E:\SPEC1LST.TXT
  2421. ARJ A -E -zF:\HERALD\LISTHEAD.TXT F:\FILES\SPEC2LST E:\SPEC2LST.TXT
  2422.  
  2423. DEL E:\ALLFILES.TXT
  2424. DEL E:\NEWFILES.TXT
  2425. DEL E:\BOARDS.TXT
  2426.  
  2427. DEL E:\SPEC1LST.TXT
  2428. DEL E:\SPEC2LST.TXT
  2429.  
  2430. :ERROR
  2431.  
  2432. This demo batch file creates a list and announces new files:
  2433.  
  2434. @ECHO OFF
  2435.  
  2436. HERALD
  2437.  
  2438. IF ERRORLEVEL 2 GOTO ERROR
  2439. IF ERRORLEVEL 1 GOTO NOMSG
  2440.  
  2441. REM Here only if a message was created
  2442.  
  2443. POST E:\MESSAGE.TXT  #153  -From "FileHerald"  -To All  -Subj "New files"
  2444. POST E:\MESSAGE.TXT  #157  -From "FileHerald"  -To All  -Subj "New files"
  2445.  
  2446. REM Of course you can use the internal posting functions of Herald!
  2447.  
  2448. :NOMSG
  2449.  
  2450.                                                                 55
  2451. REM Here only if nothing happened on the way
  2452.  
  2453. DEL F:\FILES\FILES.ARJ
  2454. DEL F:\FILES\SPEC1LST.ARJ
  2455. DEL F:\FILES\SPEC2LST.ARJ
  2456.  
  2457. ARJ A -E -zF:\HERALD\LISTHEAD.TXT F:\FILES\FILES E:\ALLFILES.TXT
  2458. ARJ A -E -zF:\HERALD\LISTHEAD.TXT F:\FILES\NEWFILES E:\NEWFILES.TXT
  2459. ARJ A -E -zF:\HERALD\LISTHEAD.TXT F:\FILES\SPEC1LST E:\SPEC1LST.TXT
  2460. ARJ A -E -zF:\HERALD\LISTHEAD.TXT F:\FILES\SPEC2LST E:\SPEC2LST.TXT
  2461.  
  2462. DEL E:\ALLFILES.TXT
  2463. DEL E:\NEWFILES.TXT
  2464. DEL E:\BOARDS.TXT
  2465.  
  2466. :ERROR
  2467.  
  2468. DEL E:\ALLFILES.TXT
  2469. DEL E:\NEWFILES.TXT
  2470. DEL E:\BOARDS.TXT
  2471.  
  2472.  
  2473.                                                                 56
  2474. APPENDIX
  2475.  
  2476. BBS SOFTWARE SUPPORTED;
  2477.  
  2478. This section  gives an  overview on  the different  types  of  BBS  software
  2479. FileHerald supports  and which  of their  special features  are handled. The
  2480. version numbers listed here are the very versions FileHerald has been tested
  2481. with. He  may work  with older  or later  versions as well, but at least for
  2482. RoboBBS I  can say  that the  configuration file  structures may  change and
  2483. problems may occurr.
  2484.  
  2485. Software name and version: SuperBBS 1.16
  2486. Configuration file used  : FLSEARCH.BBS
  2487. Environment variable used: SBBS
  2488.  
  2489. You have  to enter a seperate listpath and filename for SuperBBS to CD-ROMs.
  2490. FileHerald will automatically use this special list.
  2491.  
  2492. Software name and version: QuickBBS 2.75
  2493. Configuration file used  : FLSEARCH.CTL
  2494. Environment variable used: QBBS
  2495.  
  2496. FLSEARCH.CTL is a simple ASCII-file formatted like this:
  2497.  
  2498. PATH <ACCESSLEVEL> <DESCRIPTION> [AREA_FILENAME]
  2499.  
  2500. The path  leads to  the area  file which has to be named "FILES.BBS" and the
  2501. files themself.  ACCESSLEVEL is the minimum level a user needs to access the
  2502. area. If  it is  omitted, 32000 is used as default. "DESCRIPTION" is a brief
  2503. description, in  which underscores  have to be used instead of blanks. Those
  2504. underscores are replaced by blanks and will not show in lists.
  2505.  
  2506. AREA_FILENAME is a non-standard feature only used by FileHerald which allows
  2507. you to  specify for  FileHerald a  different path  and filename for the area
  2508. file. This  is the  only way to support CD-ROMs where the area files can not
  2509. be in the same directory with the files for understandable reasons.
  2510.  
  2511. If your  other software  gets troubled  about this  you may  have to  use  a
  2512. seperate area  list for  FileHerald, but  at least  you have  the chance  to
  2513. support your CD-ROM at all.
  2514.  
  2515. Some lines may look like this:
  2516.  
  2517. C:\files\tools 10 Utilities_and_tools
  2518. F:\files\windows 5 Windows_applications
  2519. J:\util\driver 10 CD-ROM:_BGI-driver C:\files\ROM-DRIV.BBS
  2520.  
  2521. Software name and version: ProBoard 1.30
  2522. Configuration file used  : FILES.PRO
  2523. Environment variable used: PB
  2524.  
  2525. ProBoard has  a very clever and fast way to support CD-ROMs. You can enter a
  2526. special area  file name  and path like for SuperBBS. But you can also define
  2527. the area as a CD-ROM area. Proboard will then not scan the file directory to
  2528. get file  size and  date but  use only the data stored in the area file like
  2529. this:
  2530.  
  2531. PINBALL.ZIP 22234 12/11/92 Nice pinball game
  2532. WOLFD3D.ZIP 676355 09/11/92 Demo version of Castle Wolfenstein
  2533.  
  2534.  
  2535.                                                                 57
  2536. So it  is not  neccessary to access the CD-ROM to get this data which speeds
  2537. up  search  significantly.  Herald  supports  this  feature  but  will  also
  2538. autodetect when a line not fits this format and convert it (i.e. he will try
  2539. to get  that data from the ROM and insert it into your area file for further
  2540. use).
  2541.  
  2542. Software name and version: Remote Access 1.11
  2543. Configuration file used  : FILES.RA
  2544. Environment variable used: RA
  2545.  
  2546. Remote Access  1.11 offers  the possibility  to use  seperate area  files by
  2547. naming a  path where  they are stored. If in this path a file called FILES.n
  2548. is found, where n is the area number (e.g. area 22: FILES.22) this file will
  2549. be used  instead of  one in  the area  path. Herald  will also  do this when
  2550. "LISTPATH" is defined.
  2551.  
  2552. Software name and version: RoboBBS 1.xx
  2553. Configuration file used  : FILEAREA.DEF
  2554. Environment variable used: n/a
  2555.  
  2556. RoboBBS uses  a way  similar to  Remote Access,  but the  number has  to  be
  2557. defined explicitly after a colon ";", e.g. "F:\FILES\TOOLS\;5". RoboBBS will
  2558. then search  for a  "FILES.5" in  its  system  directory.  As  there  is  no
  2559. environment variable  which allows  Herald to  find that  path, you  have to
  2560. enter it using "LISTPATH".
  2561.  
  2562. Software name and version: Windowed Modem Environment 1.xx
  2563. Configuration file used  : FILEAREA.BBS
  2564. Environment variable used: n/a
  2565.  
  2566. WME stores  all area files in its work path. They are named FILEAREA.n where
  2567. "n" is  the area number. They are binary files. FileHerald can both read and
  2568. write these.
  2569.  
  2570. Software name and version: Wildcat 3.xx
  2571. Configuration file used  : FILEAREA.DAT, ALLFILES.DAT
  2572. Environment variable used: n/a
  2573.  
  2574. WC stores  all data  including file  size and  upload date  in a single file
  2575. (ALLFILES.DAT). Herald  can read  the necessary files but not write anything
  2576. to it.
  2577.  
  2578.  
  2579.                                                                 58
  2580. Copyright and shareware notice
  2581.  
  2582. The FileHerald  is copyrighted  software and  not free. You are granted a 30
  2583. days trial period after which you will either have to register or stop using
  2584. FileHerald. The  program is  shareware and may be distributed freely via BBS
  2585. and any  other way,  provided nothing more than a reasonable fee is charged.
  2586. This should  not exceed  the mere cost of the disk FileHerald is handed over
  2587. on.
  2588.  
  2589.                                                                 59
  2590. Disclaimer
  2591.  
  2592. The well known sentences noone ever reads:
  2593.  
  2594. FileHerald is  tested on  various systems  with different configurations. To
  2595. make it  short, it  worked there,  it may  not work  for you.  There  is  no
  2596. guarantee whatsoever  that it  will work  for you.  It is  only sure that it
  2597. occupies disk space and will cost your money to download it somewhere.
  2598.  
  2599. Any damage  directly or  indirectly occurring  to  your  system's  hard-  or
  2600. software is  at your own risk and I am not responsible for any loss of time,
  2601. data or money.
  2602.  
  2603.                                                                 60
  2604. Trouble shooting
  2605.  
  2606. * Sharing problems:
  2607.  
  2608. In multitasker  or network  environments: Set  the read-only  attribute  for
  2609. HERALD.EXE (attrib +R HERALD.EXE).
  2610.  
  2611.  
  2612.                                                                 61
  2613. Support
  2614.  
  2615. Support is granted to registered and unregistered users without distinction,
  2616. but of  course I will not send crash mails to unregistered users. Just write
  2617. a netmail to:
  2618.  
  2619. Norbert Schlia, MUSIC-BBS
  2620. 2:248/504@fidonet, 1200 - 19200 bps (ZYX, FAX), ++49-721-68 88 34
  2621. (24h online)
  2622. 2:248/508@fidonet, 300 - 2400 baud, ++49-721-681532
  2623. (24h online)
  2624. 68:2493/104@cinemanet, 1200 - 19200 bps (ZYX, FAX), ++49-721-68 88 34
  2625. (24h online)
  2626.  
  2627. In the United States:
  2628.  
  2629. You may  contact me by netmail through our U.S. Distributor Butch Bridges at
  2630. 1:19/132 (24  hour line).  All netmail messages are forward to me in Germany
  2631. on a timely basis and I answered as quickly as possible by netmail.
  2632.  
  2633. In the South Africa:
  2634.  
  2635. Write a netmail to Grant Anderson, 5:7101/64 (CDS Online, Johannisburg).
  2636.  
  2637.                                                                 62
  2638. How to register
  2639.  
  2640. This is  copyrighted software  owned by OBLIVION SOFTWARE. You are granted a
  2641. 30 days  trial period,  after which  you have  to  register  or  stop  using
  2642. FileHerald. Otherwise you are in violation of copyright laws.
  2643.  
  2644. Send your  registration to  the registration  site in charge for you. Please
  2645. specify whether  you want  your key  sent to  you via  crash or ground mail.
  2646. Crash mail  of course  is only  possible if  you are  member of  Fidonet  or
  2647. Cinemanet and run a continious mail system.
  2648.  
  2649. There are  extra charges  for ground  mail delivery.  If you want the latest
  2650. version of  The FileHerald, this is only possible via ground mail. Of course
  2651. you can download it from 1:19/132, 2:248/504, 2:248/508 or 68:2493/104.
  2652.  
  2653. How to register in Europe
  2654.  
  2655. Send a Eurocheque or BANK cheque payable to Norbert Schlia or transfer it to
  2656. my account listed below. Please do not send cash money!
  2657.  
  2658. Norbert Schlia (2:248/504, 2:248/508)
  2659. Ruschgraben 26
  2660. W-7500 Karlsruhe 1
  2661. Germany
  2662.  
  2663. Bank Account: 972 48 16, Sparkasse Karlsruhe (660 501 01)
  2664.  
  2665. FileHerald costs  US$25 plus US$ 6 for delivery when you want your keys sent
  2666. to you  on floppy  disks. Specify  which disk size you need. You may fill in
  2667. the equivalent amount in your currency.
  2668.  
  2669. Please advise  if you want FileHerald mailed to you on 5.25 or 3.5 diskette.
  2670. If you do not specify, it will be mailed to you on 5.25 diskette.
  2671.  
  2672.                                                                 63
  2673. How to register in the United States
  2674.  
  2675. Obtain a  money order  or cashier's check in the amount of US$25 and make it
  2676. payable to - Butch Bridges
  2677.  
  2678. Mail it to our Distributor in the United States:
  2679.  
  2680. Butch Bridges  ( 1:19/132 )
  2681. P.O. Box 11
  2682. Ardmore, OK 73402 USA
  2683.  
  2684. Please advise  if you want FileHerald mailed to you on 5.25 or 3.5 diskette.
  2685. If you  do not  specify, it will be mailed to you on 5.25 diskette.  Be sure
  2686. and give  a street  address as  your mailing  address.   PO Box  is  not  an
  2687. acceptable mailing address, UPS requires a steet address.
  2688.  
  2689. Business and  personal checks are not excepted and will be returned to their
  2690. sender. Also we do not accept C.O.D. orders.  Orders with proper payment are
  2691. shipped postage-paid in 72 hours or less.
  2692.  
  2693. If you want to have your key sent to you on floppy disks, specify which size
  2694. you need and add US$ 6 for delivery.
  2695.  
  2696.                                                                 64
  2697. How to register outside the US and Europe
  2698.  
  2699. Send a  BANK cheque  payable to  Norbert Schlia or transfer it to my account
  2700. listed below. Please do not send cash money!
  2701.  
  2702. Norbert Schlia (2:248/504, 2:248/508)
  2703. W-7500 Karlsruhe 1
  2704. Germany
  2705.  
  2706. Bank Account: 972 48 16, Sparkasse Karlsruhe (660 501 01)
  2707.  
  2708. FileHerald costs  US$25 plus US$ 9 for delivery when you want your keys sent
  2709. to you  on floppy  disks. Specify  which disk size you need. You may fill in
  2710. the equivalent amount in your currency.
  2711.  
  2712. Please advise  if you want FileHerald mailed to you on 5.25 or 3.5 diskette.
  2713. If you do not specify, it will be mailed to you on 5.25 diskette.
  2714.  
  2715.                                                                 65
  2716. Ordering upgrades
  2717.  
  2718. The latest  version of  Herald is  always available from these nodes (Magic:
  2719. HERALD):
  2720.  
  2721. System            Phone        Node       Speed  Request hours
  2722. --------------------------------------------------------------------------
  2723. MUSIC-BBS Line 1  49-721-668834  2:248/504  2400 - 19.200 ZYX  6.00 to 5.00
  2724. MUSIC-BBS Line 2  49-721-681532  2:248/508  1200 - 2400        6.00 to 5.00
  2725. F&S-Soft          Mail only!     2:248/509  1200 - 16.800 ZYX  20.00 to NMH
  2726. Suedpfalz Box 1   49-7273-5279   2:248/504  2400 - 19.200 ZYX  not NMH
  2727. Suedpfalz Box 2   49-7273-1547   2:248/508  2400 - 16.800 ZYX  not NMH
  2728. High-Speed BBS    49-721-474758  2:241/7455 1200 - 16.800 ZYX
  2729. LachSack          49-721-757034  2:241/7557 2400 - 14.400 Dual 6:00 to 2:00
  2730.  
  2731. Sued-Afrika (Johannisburg):
  2732. --------------------------------------------------------------------------
  2733. CDS-Online        0027-11-403-1248  5:7101/64  2400 - 16.800 Dual
  2734.  
  2735. USA (Ardmore, Oklahoma):
  2736. --------------------------------------------------------------------------
  2737. The Heat Is On    001-405-221-5522  1:19/132   2400 - 14.400 Dual
  2738.  
  2739.                                                                 66
  2740. Differences between keys
  2741.  
  2742. There are two different keys:
  2743.  
  2744. Register key: allows to run Herald V1.xx and V2.xx without time limit and
  2745. annoying behaviour.
  2746.  
  2747. Evaluation key:  allows to  run Herald  for a  limited time  period. This is
  2748. intended if  you want  to test  Herald for  more than 30 days. If you have a
  2749. good reason, write me, I give you such an evaluation key.
  2750.  
  2751.                                                                 67
  2752. SYSTEM REQUIREMENTS AND LIMITATIONS
  2753.  
  2754. Like any  other program,  The FileHerald  has certain  limitations which you
  2755. should be aware of using the program.
  2756.  
  2757. The line  length of  any text  input file, except of the area files, may not
  2758. exceed 255  characters. Any  input beyond that limit is simply discarded and
  2759. you will  get a  warning "Line  too long  - truncated!".  In area files 1023
  2760. characters per  line are  allowed, which  should do  well.  Also,  a  single
  2761. description may not be longer than 1023 characters or else will be cut.
  2762.  
  2763. The number  of lines  in an area file is also limited to 1000. This does not
  2764. directly refer to the actual line count, because internally each comment and
  2765. each file with its description is stored as a single line independent on how
  2766. many lines it occupies in the area file itself.
  2767.  
  2768. If an  area file exceeds that limit, FileHerald will give a warning and skip
  2769. the area.
  2770.  
  2771. How much  files FileHerald  can handle  over all  depends on  the amount  of
  2772. conventional memory  your computer  has free.  About 600K will be enough for
  2773. 20,000 files, if it is less, the number may be smaller.
  2774.  
  2775. Processor type and memory management
  2776.  
  2777. Herald was  compiled using 286 code and therefore will not run on 8086 based
  2778. machines. In  any way, due to FileHerald's memory management the 640 KB such
  2779. machines have at disposal would never be enough.
  2780.  
  2781. Herald is an overlaid DOS executable, he needs about 200 KB XMS or EMS. Make
  2782. sure that  it is  available, because otherwise Herald would have to load his
  2783. overlays from  disk which  worst case  can become  very slow.  He  tries  to
  2784. allocate XMS first, then EMS.
  2785.  
  2786. He also  uses XMS/EMS  for swapping  when calling other programs. He is also
  2787. capable of  swapping to  DOS extenders  or disk,  but you  should prefer the
  2788. first  two.   This  means  about  650K  of  additional  XMS/EMS  is  needed.
  2789. Considering that  third party programmes call by Herald (e.g. archivers) may
  2790. swap themselves, about 1MB of free XMS/EMS is recommended.
  2791.  
  2792. Disk caching
  2793.  
  2794. A disk  cache may  greatly increase  execution speed.  As  FileHerald  needs
  2795. information on  each file  it processes,  for 2000  files it is necessary to
  2796. call a  DOS function  to get filesize, date and other information 2000 times
  2797. as well.  Tests have  shown that  about 85%  of the execution time goes into
  2798. accessing file dates, only the rest in computing data...
  2799.  
  2800. Therefore  using   a  staged   disk  cache   will  raise   the   effectivity
  2801. significantly.
  2802.  
  2803.                                                                 68
  2804. Bugreport
  2805.  
  2806. If you  discover bugs, send a netmail to my US distributor or directly to me
  2807. containing information on...
  2808.  
  2809. * what happened
  2810. * how did it happen
  2811. * does it happen always or sometimes
  2812.  
  2813. Include your  complete FileHerald configuration AND CONFIG.SYS/AUTOEXEC.BAT,
  2814. write what system you have (computer, HD, BBS software, DOS Version).
  2815.  
  2816.                                                                 69
  2817. Revision History
  2818.  
  2819. 0.93-1   Released by popular demand
  2820. 1.00-1   Out now, after nearly a year of hard work
  2821.  
  2822.                                                                 70
  2823. Future versions
  2824.  
  2825. Future versions  will feature  unlimited numbers  of files and maybe lots of
  2826. new functions I now can never think of. Depends upon what YOU demand!
  2827.  
  2828.                                                                 71
  2829. Credits
  2830.  
  2831. Thanks for giving me advise to Heinz Stelzig who sacrificed much time giving
  2832. me hints,  checking my code and at least it would not have been possible for
  2833. me to  write FileHerald  so fast  without his professional help. Thanks also
  2834. for not laughing at me when I came up with silly ideas :-)
  2835.  
  2836. Thanks to  Grant Anderson and Butch Bridges for proof reading this document,
  2837. especially to  Grant how  did a great job also updating descriptions as they
  2838. changed. Saved me a lot of precious time!
  2839.  
  2840. Thanks to  SWF 3  for providing  music, spent  much time  headbanging  while
  2841. programming here :-))  Yes, and to the makers of "Married with Children" for
  2842. their excellent  portray of  intersexual relations.   To  IBM for  not being
  2843. responsible for my computers. I promise someday I'll get very rich, buy IBM,
  2844. fire Bill  Gates and  give it  as a  gift to Cuba. Should throw them back to
  2845. stone age!
  2846.  
  2847. So, if you don't like IBM, register now!
  2848.  
  2849. Also thanks  to Vogelbräu for providing me good beer, the doctor who revived
  2850. me after I got my last electricity bill (3 computers running 24h, I ended up
  2851. with a heart failure as I saw the amount I had to pay :-((
  2852.  
  2853. To the  girls for  avoiding me,  a new  girl-friend would  only have spoiled
  2854. FileHerald and delayed its completition!
  2855.  
  2856. The still-not-existing-but-planned  German  manual  will  be  translated  by
  2857. Andreas Lorch.
  2858.  
  2859. The Beta Crew
  2860.  
  2861. This is  my beta  crew. Thanks  for having  confidence in  me, risking  your
  2862. filebase and  all, not minding having your system hung over night or brushed
  2863. away megs of files by accident:
  2864.  
  2865. Grant Anderson,  Frank Lachmann, Andreas Lorch, Heinz Stelzig, Bernd Wagner,
  2866. Stefan Witzens
  2867.  
  2868.                                                                 72
  2869. Other software
  2870.  
  2871. The FileHerald  uses these third party products or parts of them for which I
  2872. want to thank their developers saving me much time and efforts by letting me
  2873. use their code:
  2874. ---------------------------------------------------------------------------
  2875. Swapping routines:
  2876.  
  2877. SPAWNO v4.13     12/12/91     disk/EMS/XMS/INT15  swapping  replacement  for
  2878. spawn()
  2879. (c) Copyright 1990,1991,1992 Ralf Brown.  All Rights Reserved.
  2880.  
  2881. ---------------------------------------------------------------------------
  2882. Wildcard matching schemes:
  2883.  
  2884.                      REGEX Globber (Wild Card Matching)
  2885.  
  2886.                A *IX SH style pattern matcher written in C
  2887.                   V1.10 Dedicated to the Public Domain
  2888.  
  2889.                                 March  12, 1991
  2890.                                  J. Kercheval
  2891.                          [72450,3702] -- johnk@wrq.com
  2892. ---------------------------------------------------------------------------
  2893. Squish posting and fidostyle message handling by:
  2894.  
  2895.                  +-----------------------------+
  2896.                  | Squish MsgAPI, revision 0.0 |
  2897.                  +-----------------------------+
  2898.  
  2899. Copyright 1991 by Scott J. Dudley.  All rights reserved.
  2900. "Squish", "SquishMail" and "Maximus" are trademarks of Scott J. Dudley.
  2901. ---------------------------------------------------------------------------
  2902. Registration key system:
  2903.  
  2904.                    REGISTRATION KEY SYSTEM FOR PROGRAMMERS
  2905.                                  Version 2.20
  2906.  
  2907.  
  2908.            (C) Copyright 1992, Brian Pirie. All Rights Reserved.
  2909. ---------------------------------------------------------------------------
  2910. Fidostyle address matching routines are adapted from:
  2911.  
  2912.                  FIDOADR.C - 3/7/92 - David H. Bennett - V1.0
  2913.  
  2914. ---------------------------------------------------------------------------
  2915. The critical error handler was coded in assembly by:
  2916.  
  2917.                  Matthäus Stadler, 2:248/504.1
  2918.  
  2919.  
  2920.                                                                 73
  2921. QUICK REFERENCE GUIDE
  2922.  
  2923. ADDFROMCDROM                                                    21
  2924. ADDGRAPHINFO                                                    21
  2925. ADDNEWFILES                                                     21
  2926. ALLFILESLIST                                                    39
  2927. ANNOUNCEALWAYS                                                  32
  2928. ANNOUNCEMISSING                                                 32
  2929. ANNOUNCENEVER                                                   32
  2930. APPENDINFO                                                      40
  2931. AREAHEADER                                              27, 33, 43
  2932. AREAINFO                                                        40
  2933. AREALISTPATH                                                    18
  2934. AREALISTTYPE                                                    18
  2935. AREASDIRLIST                                                17, 18
  2936. ATTRIB                                                          36
  2937. AUTOCREATEAREAFILE                                              20
  2938. AUTOWRAP                                                        25
  2939. BACKUPAREAFILE                                                  20
  2940. BBS SOFTWARE SUPPORTED                                          56
  2941. BBSADDRESS                                                      15
  2942. BBSDATEFORMAT                                                   18
  2943. BBSNAME                                                         15
  2944. BBSTYPE                                                         17
  2945. BLANKSASCOMMENT                                                 25
  2946. BOARD                                                           37
  2947. COMMENT.LST                                                     12
  2948. COUNTERLEN                                                      26
  2949. CREATEMESSAGE                                                   31
  2950. CREATFILELIST                                                   39
  2951. DATEFORMAT                                                      19
  2952. DAYNAMES                                                        19
  2953. DESCRFILENAME                                                   22
  2954. DESCRIPT.ION                                                     5
  2955. DESCRJUSTIFIED                                              32, 44
  2956. DESTADDR                                                        36
  2957. ECHOPATH                                                        35
  2958. ERRORLEVEL                                                      30
  2959. ERRORMESSAGE                                                    30
  2960. EXTRAAREAFILETYPE                                               20
  2961. EXTRAFILESPECNAME                                               20
  2962. EXTRALISTPATH                                                   21
  2963. FILECASE                                                        27
  2964. FILEDLCOUNTER                                                   28
  2965. FILEEOLMARK                                                     27
  2966. FILEMAXLINES                                                    27
  2967. FILEORDER                                                       28
  2968. FROM                                                    36, 37, 38
  2969. IGNOREFILE                                                      21
  2970. INFOFILE                                                        40
  2971. INFOFOOTER                                                      40
  2972. INFOHEADER                                                      40
  2973. KEEPDIZ                                                         22
  2974. KILLALL.LST                                                     12
  2975. KILLFILE                                                        26
  2976. LEFTBRACKET                                                     26
  2977. LISTDLCOUNTER                                                   44
  2978. LISTEOLMARK                                                     43
  2979. LISTFILE                                                        31
  2980. LISTFILECASE                                                    44
  2981.  
  2982.                                                                 74
  2983. LISTFILEFORMAT                                                  44
  2984. LISTFOOTER                                                      43
  2985. LISTHEADER                                                      43
  2986. LISTLINEFORMAT                                                  43
  2987. LISTLINELEN                                                     43
  2988. LISTMAXLINES                                                    43
  2989. LISTNO                                                          39
  2990. LISTORDER                                                       44
  2991. LOGFILE                                                         16
  2992. LOGLEVEL                                                        16
  2993. LONGDESCRMARK                                                   24
  2994. MAXDAYS                                                         39
  2995. MAXLEVEL                                                    31, 39
  2996. MINFILES                                                        32
  2997. MISSINGDESCR                                                    22
  2998. MISSINGFILE                                                     41
  2999. MONTHNAMES                                                      19
  3000. MSGDLCOUNTER                                                    34
  3001. MSGEOLMARK                                                      34
  3002. MSGFILECASE                                                     34
  3003. MSGFILEFORMAT                                                   34
  3004. MSGFOOTER                                                       33
  3005. MSGHEADER                                                       33
  3006. MSGLINEFORMAT                                                   33
  3007. MSGLINELEN                                                      33
  3008. MSGMAXLEN                                                       35
  3009. MSGMAXLINES                                                     33
  3010. MSGNAME                                                         35
  3011. MSGNO                                                   36, 37, 38
  3012. MSGORDER                                                        35
  3013. MSGTYPE                                                         35
  3014. NETPATH                                                     35, 36
  3015. NEWFILESLIST                                                    39
  3016. NOFILEREQ                                                       42
  3017. NOKILL.LST                                                      12
  3018. NOREQMSG                                                        42
  3019. NOTIFYMSGAREA                                                   17
  3020. NOTIFYMSGTYPE                                                   17
  3021. NOTRASH.LST                                                     13
  3022. ORIGADDR                                                36, 37, 38
  3023. ORIGIN                                                          37
  3024. PWDFILEREQ                                                      42
  3025. PWDONLYMSG                                                      42
  3026. REGISTERKEY                                                     15
  3027. REMOVE4DOSDESCR                                                 23
  3028. REMOVEEMPTYLINES                                                25
  3029. REPACKCOMMAND                                                   29
  3030. REPACKEXTENSION                                                 29
  3031. REQOKMSG                                                        42
  3032. RIGHTBRACKET                                                    26
  3033. SCANMODE                                                        32
  3034. SHORTNOREQMSG                                                   42
  3035. SHORTPWDONLYMSG                                                 42
  3036. SHORTREQOKMSG                                                   42
  3037. SKIPANNOUNCE                                                    31
  3038. SKIPLIST                                                        42
  3039. SKIPREPACK                                                      30
  3040. SKIPUPDATE                                                      23
  3041. SQUISHPATH                                                      38
  3042. STRIPHIASCII                                                    22
  3043. SUBJECT                                                 36, 37, 38
  3044.  
  3045.                                                                 75
  3046. SWAPDIRS                                                        16
  3047. SWAPTYPE                                                        16
  3048. SYSOPNAME                                                       15
  3049. TEMPDRIVE                                                       15
  3050. TEXTWINDOW                                                      15
  3051. TIMEFORMAT                                                      19
  3052. TO                                                      36, 37, 38
  3053. TRASHALL.LST                                                    13
  3054. TRASHFILE                                                   26, 30
  3055. TRASHPATH                                                       26
  3056. UNPACKCOMMAND                                                   22
  3057. UPDATE4DOSDESCR                                                 23
  3058. UPDATEAREAFILE                                                  20
  3059. UPDATELIST                                                      31
  3060. USE4DOSDESCR                                                    23
  3061. USEFILE_ID                                                      22
  3062.  
  3063.                                                                 76
  3064.  
  3065.