home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / OSK / EFFO / forum16.lzh / SOFTWARE / ASSEMBLER / DEMERGE / info_demerge < prev   
Text File  |  1991-04-01  |  5KB  |  131 lines
  1. $COMMENT
  2.   ***********************************************************************
  3.   *     This file is a so-called "Info" file describing a piece of      *
  4.   *   software in a standardized way using EFFO's "Info" file format.   *
  5.   *     The format provides all basic information about a program       *
  6.   *   in a well structured manner allowing automatic extraction         *
  7.   *   of important short-form data for databases and software lists     *
  8.   *   but including more detailed descriptions as well.                 *
  9.   *     The structure is formed by a set of keywords dividing the       *
  10.   *   information into different paragraphs (see syntax description     *
  11.   *   below).                                                           *
  12.   *                                                                     *
  13.   *     Many programs distributed by EFFO will include such a file.     *
  14.   *   It will be called Info_xxxx, where xxxx is the program's name.    *
  15.   *   EFFO encourages all its members and all forum participants as     *
  16.   *   well as commercial suppliers of OS-9 and OS-9000 software to      *
  17.   *   use this format to describe their software.                       *
  18.   *     An empty "form" for Info files called "Info_empty_form" will    *
  19.   *   be distributed with all EFFO disks and through the OS9-BBS.       *
  20.   *                                                                     *
  21.   *     The syntax is quite simple: Each paragraph begins with a        *
  22.   *   "keyword line" which is a line with a $-Sign in the very first    *
  23.   *   column immediately followed by the keyword itself. The rest of    *
  24.   *   the line is reserved for short comments about the paragraph's     *
  25.   *   purpose. Some paragaphs are mandatory, and some are restricted    *
  26.   *   in size to ensure that reliable database entries can be           *
  27.   *   extracted automatically from the file.                            *
  28.   *     All subseqent lines up to the next keyword line (or the         *
  29.   *   end-of-file) are forming the paragraph body, i.e the information  *
  30.   *   that belongs to the keyword.                                      *
  31.   *     The order in which the keywords appear in the text (if they     *
  32.   *   appear at all for optional paragraphs) is free with one           *
  33.   *   important exception: "$PROGRAM-NAME" always must be the first     *
  34.   *   keyword in the program description. This rule allows multiple     *
  35.   *   descriptions to be merged into a single text file without using   *
  36.   *   special delimiters in between.                                    *
  37.   *     Finally, "$COMMENT" paragraphs are provided to include          *
  38.   *   any information not related to a program description, like        *
  39.   *   this text. They can appear anywhere in the file, even before      *
  40.   *   the first "$PROGRAM-NAME".                                        *
  41.   ***********************************************************************
  42. $COMMENT
  43.   This file is an empty form that can be used to create a "Info" file for
  44.   a program by inserting appropriate text between the keyword lines below.
  45.   This template lists all possible keywords. Altough it is recommended to
  46.   supply information for as many keywords as possible, all keyword lines
  47.   marked "optional" can be omitted from an info file. If you are not yet
  48.   familiar with the "Info" file concept, please have a look at existing
  49.   info files before filling in this form, in order to get an idea of what
  50.   sort of information we expect for the various keywords.
  51.  
  52. $PROGRAM-NAME  demerge
  53.  
  54. $VERSION  V0/Rev.0/Edt0
  55.  
  56. $PURPOSE  De-merges a merged file to single module files
  57.  
  58. $SUMMARY  usable to de-merge e.g. an OS9Boot to single files to replace
  59.           single modules.
  60.  
  61. $KEYWORDS  Demerge, Modules
  62.  
  63. $PROJECT  -
  64.  
  65. $STATUS  final
  66.  
  67. $REFERENCES  -
  68.  
  69. $HARDWARE  no special
  70.  
  71. $SCREEN-INTERFACE  none
  72.  
  73. $PREREQUISITES  none
  74.  
  75. $HARDWARE-OPTIONS none
  76.  
  77. $OS-VERSION  all (I hope)
  78.  
  79. $DOCUMENTATION  none
  80.  
  81. $RUNTIME-FILES  Input file - output files created with names of modules
  82. contained in input file
  83.  
  84. $DOCUMENTATION-FILES  none
  85.  
  86. $SOURCE-LANGUAGE  Assembler
  87.  
  88. $SOURCE-AVAILABILITY  Yes, Public
  89.  
  90. $SOURCE-FILES  demerge.a
  91.  
  92. $SOURCE-PREREQUISITES  standard
  93.  
  94. $COMPILATION  r68 demerge.a -qo=[RELS/]demerge.r
  95.               l68 demerge.r -o=demerge -l=/dd/lib/sys.l
  96.  
  97. $AUTHOR-NAME  W. Wittig
  98.  
  99. $AUTHOR-INFO  Albrechtstr. 44, D-6100 Darmstadt
  100.  
  101. $AVAILABILITY  Public
  102.  
  103. $CONDITIONS  No military use - distribution only with this limitation note.
  104.  
  105. $COPYRIGHT  W. Wittig - free - no military use
  106.  
  107. $DISTRIBUTOR  EFFO
  108.  
  109. $HISTORY  none
  110.  
  111. $EXPANSION  none
  112.  
  113. $HOLDER  
  114.  
  115. $INSTALLATION  copy to your execution directory - then "demerge mergedfile"
  116.  
  117. $BUGS  none I know
  118.  
  119. $RESTRICTIONS  merged file may not exceed 64000 bytes in length
  120.  
  121. $DESCRIPTION  
  122.  
  123. $EXPERIENCES  
  124.  
  125. $NOTES  Restriction above is due to reading whole merged file in memory. An
  126. other way would be to read one module at a time into memory and writing it
  127. to file.
  128.  
  129. $MISCELLANEOUS 
  130.  
  131.