home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
rtsi.com
/
2014.01.www.rtsi.com.tar
/
www.rtsi.com
/
OS9
/
OSK
/
EFFO
/
forum14.lzh
/
SOFTWARE
/
C
/
FGREP
/
info_fgrep
< prev
next >
Wrap
Text File
|
1990-12-01
|
5KB
|
111 lines
$COMMENT
***********************************************************************
* This file is a so-called "Info" file describing a piece of *
* software in a standardized way using EFFO's "Info" file format. *
* The format provides all basic information about a program *
* in a well structured manner allowing automatic extraction *
* of important short-form data for databases and software lists *
* but including more detailed descriptions as well. *
* The structure is formed by a set of keywords dividing the *
* information into different paragraphs (see syntax description *
* below). *
* *
* Many programs distributed by EFFO will include such a file. *
* It will be called Info_xxxx, where xxxx is the program's name. *
* EFFO encourages all its members and all forum participants as *
* well as commercial suppliers of OS-9 and OS-9000 software to *
* use this format to describe their software. *
* An empty "form" for Info files called "Info_empty_form" will *
* be distributed with all EFFO disks and through the OS9-BBS. *
* *
* The syntax is quite simple: Each paragraph begins with a *
* "keyword line" which is a line with a $-Sign in the very first *
* column immediately followed by the keyword itself. The rest of *
* the line is reserved for short comments about the paragraph's *
* purpose. Some paragaphs are mandatory, and some are restricted *
* in size to ensure that reliable database entries can be *
* extracted automatically from the file. *
* All subseqent lines up to the next keyword line (or the *
* end-of-file) are forming the paragraph body, i.e the information *
* that belongs to the keyword. *
* The order in which the keywords appear in the text (if they *
* appear at all for optional paragraphs) is free with one *
* important exception: "$PROGRAM-NAME" always must be the first *
* keyword in the program description. This rule allows multiple *
* descriptions to be merged into a single text file without using *
* special delimiters in between. *
* Finally, "$COMMENT" paragraphs are provided to include *
* any information not related to a program description, like *
* this text. They can appear anywhere in the file, even before *
* the first "$PROGRAM-NAME". *
***********************************************************************
$PROGRAM-NAME Name of the program (FIRST KEYWORD, <=20 chars, mandatory)
fgrep
$VERSION Current version/revision/edition information (<=20 chars, optional)
$PURPOSE What is the program/package for ? (<=50 chars, mandatory)
very fast grep utility
$SUMMARY Short summary. (<=3 lines of <=80 chars each, mandatory)
find strings in text files
$KEYWORDS Keywords for database, comma separated (<20 chars each, recommended)
find, text
$STATUS Program status (final, beta, experimental etc) (no limit, optional)
final
$HARDWARE System hardware dependencies (no limit, mandatory if any)
none
$SCREEN-INTERFACE Termcap, Zterm, etc. (<40 chars, mandatory if not raw-I/O)
none
$OS-VERSION Required/supported OS versions (<80 chars, mandatory if dependent)
developed using V2.3, should run all OS-9/68k versions
$RUNTIME-FILES Paths of the files required at run-time (no limit, optional)
$DOCUMENTATION-FILES Paths of documentation files (no limit, optional)
none (-> 'fgrep -?')
$SOURCE-LANGUAGE Programming Language(s) used (<30 chars, mandatory)
C
$SOURCE-AVAILABILITY Avaliability of source code (<30 chars, mandatory)
public
$SOURCE-FILES Paths of the source files (no limit, optional)
$COMPILATION How to compile the program (no limit, optional)
$AUTHOR-NAME Name(s) ONLY of the author(s). (<=80 chars, mandatory)
from FREE SOFTWARE FOUNDATION (adaption to OS-9/68k : Stephan Paschedag)
$AVAILABILITY Public, Shareware, Commercial ? (<=30 chars, mandatory)
public
$CONDITIONS Conditions, e.g. Shareware fee (no limit, optional)
$COPYRIGHT Copyright information (<=80 chars, optional)
see file COPYING !
$DISTRIBUTOR Where can the program be obtained from ? (<=80 chars, mandatory)
EFFO
$HISTORY The program's version/revision history (no limit, recommended)
$EXPANSION Planned development for next version
who knows...
$INSTALLATION How to install the program (no limit, optional)
no special installation
$RESTRICTIONS What definitely will NOT work (mandatory if any)
$EXPERIENCES Experiences with the program (no limit, optional)
very good replacement for GREP and BM
is about 4times faster than BM which is 10times faster than GREP