home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / AmigaGuide / AmigaGuideIndexMaker_1.2.LHA / agix / agix.doc next >
Encoding:
PGP Message  |  1994-08-05  |  3.1 KB  |  82 lines
  1. -----BEGIN PGP SIGNED MESSAGE-----
  2.  
  3.  
  4.           $VER: AGIX.doc 1.2 (5.8.94) Copyright © Ralph Seichter
  5.           ======================================================
  6.  
  7. PURPOSE:
  8.  
  9.    Although  AmigaGuide documents may have a node index, only few documents
  10. make  use of this feature. I suppose that many people are too lazy to build
  11. an  index  manually (I definitely am), so I thought it would be a good idea
  12. to have this task done automatically. AGIX scans an AmigaGuide document for
  13. references  like  @{"foo" link "bar"} (note that AGIX does not use the node
  14. definitions), sorts them alphabetically and produces an index file.
  15.  
  16.    "Haven't I seen something like that before?" you might ask. Well, I have
  17. seen  one  similar  program  so far, but on my machine it didn't work, so I
  18. decided  to  try  it myself. The result is short (only 1960 bytes) and uses
  19. StrnCmp() from locale.library instead of stricmp(), if available, and has a
  20. very nice sounding name. :)
  21.  
  22.  
  23. USAGE:
  24.  
  25.    The  parameter  required  is the input FILE name; AGIX uses the standard
  26. output  channel.  Please  note that the complete source file is loaded into
  27. memory for greater speed. This is generally an advantage, because only very
  28. few document files are so large that they don't fit into memory. The output
  29. should be appended to the original AmigaGuide document. The optional INDENT
  30. parameter  (the default is 1) allows you to specify how many blanks will be
  31. written  in front of each output line. Make sure to run AGIX from CLI only!
  32. Usage examples:
  33.  
  34.      1> agix foo.guide
  35.  
  36.      1> agix FILE bar.guide INDENT 3 >bar.index
  37.      1> Join bar.guide bar.index AS barindex.guide
  38.  
  39.  
  40. COPYRIGHT NOTICE:
  41.  
  42.    AGIX  is Copyright (c) 1994 Ralph Seichter, all rights reserved. You may
  43. however  use it freely and give away as many copies as you wish, as long as
  44. the following conditions are met:
  45.  
  46.      1. No files may be added to or deleted from the archive.
  47.  
  48.      2. The archive must not be included in commercial software
  49.         packages without my written permission.
  50.  
  51.      3. You must not charge anybody for giving him/her a copy.
  52.  
  53.    If you have suggestions or comments to make, please feel free to contact
  54. me. Any form of feedback is appreciated.
  55.  
  56.      Ralph Seichter       Phone: V +49-2233-70293 Q
  57.      Deutscher Ring 6     EMail: zodiac@darkness.gun.de
  58.      50354 Huerth
  59.      Federal Republic of Germany
  60.  
  61.  
  62. DISCLAIMER:
  63.  
  64.    THIS  MATERIAL  IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  65. EXPRESS  OR  IMPLIED,  STATUTORY OR OTHERWISE, INCLUDING WITHOUT LIMITATION
  66. ANY  IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY AND FITNESS FOR
  67. A  PARTICULAR  PURPOSE.  THE  ENTIRE  RISK  AS  TO  THE  USE,  RESULTS, AND
  68. PERFORMANCE  OF  THIS  MATERIAL IS ASSUMED BY YOU AND IF THE PRODUCT SHOULD
  69. PROVE  TO  BE  DEFECTIVE,  YOU  ASSUME  THE  ENTIRE  COST  OF ALL NECESSARY
  70. SERVICING, REPAIR, OR OTHER REMEDIATION.
  71.  
  72.  
  73. -----BEGIN PGP SIGNATURE-----
  74. Version: 2.3a.4
  75.  
  76. iQCVAgUBLkJv+pM5gwXWjSWFAQEBuwQAmS6ER5d7bxJG35296DAzoeqRijDNdJRu
  77. 1gkN/HQWGMyiLppJ52dIagGxEt36AZaL33IlenOGSovW/Ud2IGcX6FBVHDP/20uS
  78. /y1vw2Q4eNCERRGcJ/RP88410YvOgtzbjjMUQtJopLhB7DtRgv2XLLc3ozJ63Ba6
  79. JVmiRUkgEvw=
  80. =+5I3
  81. -----END PGP SIGNATURE-----
  82.