home *** CD-ROM | disk | FTP | other *** search
/ The AGA Experience 2 / agavol2.iso / software / utilities / misc / pdbase / help / english / aminet2pdb.readme < prev    next >
Encoding:
Text File  |  1995-05-06  |  2.7 KB  |  64 lines
  1.          ____           __                  __   ____   ______ ____   ____
  2.         / __ \         /_/                _/ /_ /___ \ / __  // __ \ / __ \
  3.        / /_/ /_   _   __   ______ ______ /  __/____/ // /_/ // / / // /_/ /
  4.       / __  // \_/ \ / /  / __  // ____/ / /  / ____// ____// / / // __  /
  5.      / / / // /__/ // /_ / / / // __/_  / /_ / /___ / /    / /_/ // /_/ /
  6.     /_/ /_//_/  /_//___//_/ /_//_____/ /___/ \____//_/    /_____//_____/
  7.  
  8.                             - Aminet2PDB 1.0 -
  9.  
  10.                      (Copyright ©1995 Cédric Souchon)
  11.  
  12.  
  13.    Aminet2PDB is a CLI-only utility that allows you to create an aminet
  14. tree for PDBase starting from a standard Aminet INDEX file.
  15.  
  16.    A recent aminet tree, converted into PDBase format, is shipped in the
  17. distribution; it can be the starting point for you own public domain
  18. database.
  19.  
  20.  
  21.    The argument template is:
  22.  
  23.    INDEX/A,PDBFILE/A,TREE/S
  24.  
  25. * INDEX   : Name of a standard INDEX file.
  26. * PDBFILE : Name of the PDBase file to create.
  27. * TREE    : When this switch is set, the tree is printed to the standard
  28.             output before being written to a PDBase file.
  29.  
  30.  
  31.  
  32.    Note about INDEX format:
  33.    ~~~~~~~~~~~~~~~~~~~~~~~~
  34.    A utility that handles text files always rises some problems, as the
  35. format is not as rigorous as a binary file (e.g. IFF). Here is what
  36. Aminet2PDB expects:
  37.  
  38.    First, Aminet2PDB searches for the heading of the index, which is
  39. series of lines begining by a '|' character. The construction of the tree
  40. starts right after this heading (which is compulsory), leaving away blank
  41. lines. The work ends when Aminet2PDB encounters the end of the file, or a
  42. line begining with three dashes: '---'.
  43.  
  44.    The format of each significant line is: a file name at the begining of
  45. the line WITHOUT SPACES, followed by any number of spaces, then the aminet
  46. path, composed with one or two directories (no more) separated by a '/'
  47. character. The rest of the line is not parsed, so it can contain anything.
  48.  
  49.    If this format is enforced, the result can be strange. Aminet2PDB
  50. contains as many protections as possible to keep big problems away, such
  51. as a software failure. It tries to detects binary files and non valid text
  52. files when possible. The worst thing that can happen is probably a
  53. surprising result (strange categories in PDBase). Most of the time,
  54. Aminet2PDB will tell you that the conversion went wrong when encountering
  55. a non valid INDEX. Nevertheless, please keep non INDEX files away from
  56. Aminet2PDB.
  57.  
  58.    Aminet2PDB can parse all forms of INDEX I know about, from the complete
  59. INDEX to daily or weekly INDEX posted on the net. In that last case,
  60. Aminet2PDB easily gets rid of net headers and signature at the bottom of
  61. the file (provided that the signature is preceded by three dashes at the
  62. begining ot the line: '---').
  63.  
  64.