home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / dev / misc / gadoc.readme < prev    next >
Encoding:
Text File  |  1995-04-27  |  4.9 KB  |  108 lines
  1. Short:    V1.2, autodocs: TeXinfo file, incl. xref
  2. Author:   leibrock@fsinfo.cs.uni-sb.de (Gerhard Leibrock)
  3. Uploader: leibrock@fsinfo.cs.uni-sb.de (Gerhard Leibrock)
  4. Type:     dev/misc
  5.  
  6. GAdoc (Get Auto DOC) is a program which extracts autodoc-style comments
  7. out of any file and generates a two part TeXinfo file out of it.
  8.  
  9.  
  10.     THIS PROGRAM NEEDS TEX OR MAKEINFO TO BE OF ANY USE!
  11.  
  12.  
  13. Warning:
  14.     This program is missing some of the features that can be
  15.     found in the autodoc program from Commodore:
  16.  
  17.     * Lines *strictly* limited to 80 chars/line
  18.     * No word wrapping, if a line is longer than 80 chars
  19.     * Ignores first character of each line
  20.     * Only generates texinfo files, nothing else.
  21.  
  22. Features:
  23.     * Supports standard autodocs
  24.     * Can extract internal autodocs
  25.     * Can extract only autodocs with a special ID
  26.       (Possible to write autodocs in different languages and
  27.       keep them in one file).
  28.     * Supports main program header, as introduced with ROBODdoc from
  29.       weertj@euronet.nl, which didn't work very well on my Amiga
  30.       (So I wrote my own one).
  31.     * Supports xrefs to other files and within the autodoc itself.
  32.  
  33. Compiled with gcc263; runs under NetBSD, Amiga OS, Solaris.
  34.  
  35. (Will NOT run under SM-DOS, because of the filename extensions used :)
  36.  
  37. GAdoc v1.2 was written by Gerhard Leibrock
  38.  
  39.     Email:    leibrock@fsinfo.cs.uni-sb.de
  40.         (fach5@cipsol.cs.uni-sb.de)
  41.  
  42.     Smail:
  43.         Gerhard Leibrock
  44.         Neuhaeuselerstr. 12
  45.         66459 Kirkel, Germany
  46.  
  47. This is an UPDATE of version 1.1. I added the ``-s<ID>'' flag, to make
  48. it possible to write autodocs in different languages and keep them in
  49. one file. Gadoc can now create icons for use under amiga dos with the
  50. ``-aicon'' option.
  51. Also new is the file "2PagesTexi.scr" for use under amigados. It will
  52. create a booklet with dvidvi out of the .dvi file.
  53.  
  54. VERY IMPORTANT:
  55. ---------------
  56. This software is subject to the ``Standard Amiga FD-Software Copyright Note''
  57. It is Cardware as defined in paragraph 4.c.
  58. If you like it and use it regularly please send a postcard to the author.
  59. For more information please read ``AFD-COPYRIGHT'' (Version 1 or higher).
  60.  
  61.  
  62. ============================= Archive contents =============================
  63.  
  64. Original  Packed Ratio    Date     Time    Name
  65. -------- ------- ----- --------- --------  -------------
  66.     3342    1522 54.4% 27-Mar-95 20:52:18  GAdoc.c/2PagesTexi.scr
  67.      471     291 38.2% 27-Mar-95 11:24:18  GAdoc.c/All_Warnings
  68.      628     271 56.8% 27-Mar-95 19:48:56  GAdoc.c/Docs.info
  69.     7215    2818 60.9% 10-Dec-94 12:00:00  GAdoc.c/Docs/AFD-COPYRIGHT
  70.     7764    3187 58.9% 27-Mar-95 21:10:58  GAdoc.c/Docs/AFD-COPYRIGHT.de
  71.     4011     881 78.0% 27-Mar-95 20:18:28  GAdoc.c/Docs/AFD-COPYRIGHT.de.info
  72.     4011     884 77.9% 27-Mar-95 20:18:28  GAdoc.c/Docs/AFD-COPYRIGHT.info
  73.      866     509 41.2% 27-Mar-95 21:13:28  GAdoc.c/Docs/AllGuide.err
  74.      351     144 58.9% 27-Mar-95 20:18:28  GAdoc.c/Docs/AllGuide.err.info
  75.      186      95 48.9% 27-Mar-95 11:24:20  GAdoc.c/Docs/Del-TeX-Trash
  76.     1126     302 73.1% 27-Mar-95 20:18:28  GAdoc.c/Docs/Del-TeX-Trash.info
  77.      293     221 24.5% 27-Mar-95 11:24:20  GAdoc.c/Docs/Do_It
  78.      838     244 70.8% 27-Mar-95 20:18:28  GAdoc.c/Docs/Do_It.info
  79.    16274    6071 62.6% 27-Mar-95 21:13:04  GAdoc.c/Docs/GAdoc.doc
  80.      539     258 52.1% 27-Mar-95 20:18:28  GAdoc.c/Docs/GAdoc.doc.info
  81.    27888    9784 64.9% 27-Mar-95 21:13:28  GAdoc.c/Docs/gadoc.dvi
  82.      523     280 46.4% 27-Mar-95 20:18:28  GAdoc.c/Docs/GAdoc.dvi.info
  83.    19027    6748 64.5% 27-Mar-95 21:09:48  GAdoc.c/Docs/GAdoc.guide
  84.      680     306 55.0% 27-Mar-95 21:11:04  GAdoc.c/Docs/GAdoc.guide.info
  85.    17112    6523 61.8% 27-Mar-95 21:12:10  GAdoc.c/Docs/GAdoc.texi
  86.      317     105 66.8% 27-Mar-95 20:18:28  GAdoc.c/Docs/GAdoc.texi.info
  87.      495     276 44.2% 27-Mar-95 11:24:20  GAdoc.c/Docs/Make4Guide
  88.      833     181 78.2% 27-Mar-95 20:18:28  GAdoc.c/Docs/Make4Guide.info
  89.       81      78  3.7% 27-Mar-95 21:09:48  GAdoc.c/Docs/MakeGuide.err
  90.      250     183 26.8% 27-Mar-95 11:24:20  GAdoc.c/Docs/Script.Make4Guide
  91.    20632   11059 46.3% 27-Mar-95 20:42:10  GAdoc.c/gadoc
  92.      865     412 52.3% 27-Mar-95 11:24:18  GAdoc.c/gadoc.info
  93.     2085    1117 46.4% 27-Mar-95 21:04:30  GAdoc.c/gadoc.readme
  94.      620     267 56.9% 27-Mar-95 11:24:18  GAdoc.c/Icon
  95.      679     305 55.0% 27-Mar-95 08:53:24  GAdoc.c/Icon.info
  96.     3590     715 80.0% 27-Mar-95 11:24:18  GAdoc.c/IconData.h
  97.      269     135 49.8% 27-Mar-95 11:24:18  GAdoc.c/IconData.h.info
  98.     2523    1379 45.3% 27-Mar-95 20:59:00  GAdoc.c/liesmich
  99.      317     105 66.8% 27-Mar-95 11:24:18  GAdoc.c/liesmich.info
  100.    24428    7647 68.6% 27-Mar-95 20:43:04  GAdoc.c/main.c
  101.      269     141 47.5% 27-Mar-95 11:24:18  GAdoc.c/main.c.info
  102.      474     318 32.9% 27-Mar-95 11:24:18  GAdoc.c/Makefile
  103.      833     180 78.3% 27-Mar-95 11:24:18  GAdoc.c/Makefile.info
  104.     2037    1106 45.7% 27-Mar-95 20:57:46  GAdoc.c/readme
  105.      317     107 66.2% 27-Mar-95 11:24:18  GAdoc.c/readme.info
  106. -------- ------- ----- --------- --------
  107.   175059   67155 61.6% 01-Apr-95 12:30:44   40 files
  108.