home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / OSK / EFFO / forum16.lzh / SOFTWARE / C / HEXED / info_hexed < prev   
Text File  |  1991-03-25  |  5KB  |  114 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.  
  43. $PROGRAM-NAME  Name of the program (FIRST KEYWORD, <=20 chars, mandatory)
  44.   hexed
  45.  
  46. $VERSION  Current version/revision/edition information (<=20 chars, optional)
  47.   1.0
  48.  
  49. $PURPOSE  What is the program/package for ? (<=50 chars, mandatory)
  50.   hex-editor using standard texteditor
  51.  
  52. $SUMMARY  Short summary. (<=3 lines of <=80 chars each, mandatory)
  53.   generates hexdump from binary data file,
  54.   uses standard texteditor to modify dump,
  55.   then retransforms dump to binary data again
  56.  
  57. $KEYWORDS  Keywords for database, comma separated (<20 chars each, recommended)
  58.   hexeditor
  59.  
  60. $STATUS  Program status (final, beta, experimental etc) (no limit, optional)
  61.   final
  62.  
  63. $REFERENCES  Other programs/infos related to this program (no limit, optional)
  64.   vi (EFFO forum 13) or any other texteditor in use
  65.  
  66. $HARDWARE  System hardware dependencies (no limit, mandatory if any)
  67.   no hardware dependency
  68.  
  69. $SCREEN-INTERFACE  Termcap, Zterm, etc. (<40 chars, mandatory if not raw-I/O)
  70.   as usual for the specific editor
  71.  
  72. $OS-VERSION  Required/supported OS versions (<80 chars, mandatory if dependent)
  73.   OS-9 V2.2, C-Compiler V3.2
  74.  
  75. $RUNTIME-FILES  Paths of the files required at run-time (no limit, optional)
  76.   uses /r0 for temporary files; may be changed using -t-option
  77.  
  78. $DOCUMENTATION-FILES  Paths of documentation files (no limit, optional)
  79.   hexed.doc
  80.  
  81. $SOURCE-LANGUAGE  Programming Language(s) used (<30 chars, mandatory)
  82.   C
  83.  
  84. $SOURCE-AVAILABILITY  Avaliability of source code (<30 chars, mandatory)
  85.   public
  86.  
  87. $SOURCE-FILES  Paths of the source files (no limit, optional)
  88.   hexed.c
  89.  
  90. $COMPILATION  How to compile the program (no limit, optional)
  91.   hexed.sub    is a script
  92.  
  93. $AUTHOR-NAME  Name(s) ONLY of the author(s). (<=80 chars, mandatory)
  94.   Helmut Hoheisel-Zimmermann, D-2300 Kiel 14
  95.  
  96. $AVAILABILITY  Public, Shareware, Commercial ? (<=30 chars, mandatory)
  97.   public
  98.  
  99. $CONDITIONS  Conditions, e.g. Shareware fee (no limit, optional)
  100.   no military use
  101.  
  102. $COPYRIGHT  Copyright information (<=80 chars, optional)
  103.   by H. Hoheisel-Zimmermann
  104.  
  105. $DISTRIBUTOR  Where can the program be obtained from ? (<=80 chars, mandatory)
  106.   EFFO
  107.  
  108. $HISTORY  The program's version/revision history (no limit, recommended)
  109.   developed in 03/91
  110.  
  111. $EXPANSION  Planned development for next version
  112.   no expansion planned by the author
  113.  
  114.