home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Mac Game Programming Gurus / TricksOfTheMacGameProgrammingGurus.iso / More Source / Libraries / VideoToolbox 95.04.18 / Utilities / CVNetConvert / README < prev    next >
Encoding:
Text File  |  1992-07-01  |  8.3 KB  |  195 lines  |  [TEXT/KAHL]
  1. README file for cvnetcnv version 1.05 [92-07-01]
  2.  
  3. ###### WARNING !!! WARNING !!! WARNING !!! WARNING !!! WARNING !!! ######
  4.  
  5. Please DO NOT ABUSE the computer readable database you generate with
  6. this program.  Mailing directly from your computer to all members of
  7. CVNet is *ABUSE*!  No matter how hot a manuscript or how great
  8. a product you have, do not send mails to everyone directly.  If you
  9. think you have some important information for a lot of people, send it
  10. to CVNet.
  11. I wrote this program to give us convenience in finding addresses of our
  12. colleagues.  Abuse of the database will lead to your expulsion from the
  13. CVNet, not to mention that everyone will hate you for it.
  14. ##########################################################################
  15.  
  16. cvnetcnv.c - CVNet master member list format converter.
  17.  
  18.    This program converts CVNet master member list into other data formats
  19.     suitable for importing into a variety of database programs.
  20.     By defining the desired output format in file "cvnetcnv.fmt"
  21.     in the current directory, the program can be customized for
  22.     nearly all kinds of format conversion needs.  Format specification
  23.     files for some common data formats are included in the package.
  24.  
  25.    The program has been tested on the following machines and operating systems.
  26.     BSD Unix 4.3
  27.     Sun 4 (SunOS Release 4.1)
  28.     NeXT (NeXT OS Release 2.1)
  29.     IBM PC/Clones (MSDOS 5.0)
  30.         Microsoft C (v5.1), Turbo C (v2.0), Turbo C++ (v1.0)
  31.     Macintosh (System 7)
  32.         THINK C
  33.  
  34.    This program is not copyrighted.  You are free to do whatever
  35.     you want with it.
  36.  
  37.    Send comments, bug fixes, support for other machines/OS, and additonal
  38.     format specification files to: izumi@pinoko.berkeley.edu.
  39.  
  40.    Up-to-date version of this program and additional format specification files
  41.     will be available via anonymous FTP from our machine
  42.     "pinoko.berkeley.edu" in directory: /pub/CVNet.
  43.  
  44.    This program is in no way guaranteed to do anything useful for you.
  45.    More likely, it will distract your attention from your research.
  46.  
  47.    ---------------------------------------------------------------------------
  48.    Usage:
  49.     cvnetcnv inputfile outputfile [formatfile]
  50.  
  51.    "Inputfile" is a file containing the CVNet master member list as obtained
  52.    from Listserv@vm1.yorkU.ca by sending it a one-line message that says:
  53.    GET MEMBER FILE
  54.    You do not have to edit out the e-mail header and little notes at the
  55.    beginning and end of the e-mail text.
  56.  
  57.    "Outputfile" will contain the result of conversion performed per
  58.    specification in file "cvnetcnv.fmt".
  59.  
  60.    "Formatfile" may be given as an option when you want to override the
  61.    default use of "cvnetcnv.fmt".
  62.  
  63.     The Macintosh version (i.e. if MAC is defined) presents standard file
  64.     dialogs, asking you to open your CVNet master file, and how you want to
  65.     save it. You are asked to open your own format file only if it can't find
  66.     "cvnetcnv.fmt".
  67.    ---------------------------------------------------------------------------
  68.    To Compile:
  69.    NOTE -- Please check if the appropriate macro is defined for
  70.     UNIX, MSDOS, MAC or whatever.  These macros should be mutually
  71.     exclusive.  If you define MAC, comment out the others.
  72.  
  73.    UNIX
  74.     cc -o cvnetcnv cvnetcnv.c
  75.  
  76.    MSDOS (Uncomment #define MSDOS below. Same for Turbo C++)
  77.     cl cvnetcnv.c (MSC)
  78.     tcc cvnetcnv.c (Turbo C)
  79.  
  80.    Macintosh THINK C
  81.         Uncomment #define MAC below. Use the supplied project file CVNetConvert.†π. 
  82.         Should work fine on all Macs and Systems 6 and 7, but was only tested on 
  83.         Mac IIci with System 7.
  84.    ---------------------------------------------------------------------------
  85.    To Prepare Conversion Format Specification File:
  86.  
  87.    The first line of the format file specifies the record format. You may use 
  88.    the following variable names. All other characters not listed below will 
  89.    be written out to the output as is.
  90.  
  91.         $L -- last name
  92.         $F -- first name & initial
  93.         $I -- institutional affiliation
  94.         $A -- address (e-mail)
  95.         $T -- TAB character
  96.         $N -- NEW LINE character (LF for UNIX, CRLF for MSDOS)
  97.         $Cnn -- advance to column nn if possible (if not past it already)
  98.  
  99.     For example, this format line
  100.         $L$C12$F$C22($I)$C43<$A>,
  101.     produces a file suitable for UNIX "mail/sendmail":
  102.         Abramov    Israel    (Brooklyn College)   <ixrbc@cunyvm.bitnet>,
  103.  
  104.     [#### Warning.  Don't send E-mails to everyone on CVNet using the alias file
  105.      you can obtain this way.  That is ABUSE! of the database.]
  106.  
  107.     On the second line, a line beginning with $M may appear optionally. If present,
  108.     it specifies the output file's Macintosh file type and creator (ignored unless 
  109.     the program is running on a Mac).  If not present, the file type/creator
  110.     will be set to that of MacWrite text file.
  111.     
  112.     After the $M line, or on the second line if $M line does not appear,
  113.     a line beginning with $P may appear optionally (which may continue for
  114.     multiple lines).  If present, it will specify the prolog, text placed
  115.     at the beginning of the output file before all address records.
  116.     After this, a line beginning with $E may appear optionally (which
  117.     may continue for multiple lines).  If present, it will specify the
  118.     epilog, text placed at the end of the output file after all
  119.     address records.  
  120.     
  121.     $M, $P, $E must appear in that order if all three are present.
  122.     Not all of them have to be present, e.g., if no prolog is needed
  123.     but epilog is required, $M, $E lines should be entered in that order.
  124.     
  125.     There may not be any blank or extraneous lines between the first line
  126.     and $M.  Similarly, no blank or extraneous lines should be present
  127.     between $M, $P, $E specifications.  However, blank lines are allowed
  128.     within the quoted text for the prolog and epilog. 
  129.     
  130.     $M, $P, $E must appear at column 1 without any leading spaces.
  131.  
  132.     
  133.     $Mttttcccc -- specify the output file's four-character Macintosh type 
  134.         (e.g. TEXT) and creator (e.g. MACA). The rest of the line is ignored.
  135.     $P^prolog text^ -- Place the text between quote chars at the beginning of
  136.         the output file.
  137.     $E^epilog text^ -- Place the text between quote chars at the end of the
  138.         output file.
  139.     
  140.     The prolog and epilog may extend over many lines. The character that 
  141.     immediately follows $P and $E is used as the "quote" character to 
  142.     mark the range of text for prolog and epilog.  The quote char may be any 
  143.     printable character that is not used in the quoted text for the 
  144.     prolog and epilog. The rest of the line after the terminating quote is 
  145.     ignored. After the optional $M, $P, and $E the rest of the file is ignored.
  146.     
  147.     The QuickDEX.fmt format file produces a Macintosh file
  148.     suitable for use with the Rolodex-like program called QuickDEX:
  149.         *$NN$F $L$N$I$N$A
  150.         $MTEXTQDEx
  151.         $P^
  152.         *
  153.         ^
  154.         $E^*
  155.         *
  156.         ^
  157.     The first line specifies the record format, which produces records like this:
  158.         *
  159.         NIsrael Abramov
  160.         Brooklyn College
  161.         ixrbc@cunyvm.bitnet
  162.     The line beginning with $M specifies the Macintosh file type (TEXT) and creator
  163.     (QDEx) so that QuickDEX will recognize it. The lines beginning with $P and $E 
  164.     specify a prolog and epilog, adding some extra *'s and linefeeds to please QuickDEX.
  165.  
  166.     Here are some more examples:
  167.     
  168.     Revert to the old format of CVNet master list (but without continuation lines):
  169.         $L$C12$F$C22$I$C43$A
  170.     produces
  171.         Abramov    Israel    Brooklyn College     ixrbc@cunyvm.bitnet
  172.  
  173.     Tab-separated ASCII format for importing into NeXT SpeedDeX application:
  174.         $L, $F$T$A$T$I
  175.     produces
  176.         Abramov, Israel    ixrbc@cunyvm.bitnet    Brooklyn College
  177.                        ^                   ^
  178.                       TAB                 TAB
  179.  
  180.     A basic format might demarcate field by quotes and commas:
  181.         "$L", "$F", "$I", "$A"
  182.     produces
  183.         "Abramov", "Israel", "Brooklyn College", "ixrbc@cunyvm.bitnet"
  184.  
  185.    ---------------------------------------------------------------------------
  186.    Revision history:
  187.    V1.00, 92-06-07, Izumi Ohzawa, izumi@pinoko.berkeley.edu
  188.    V1.01, 92-06-15, Denis_Pelli@isr.syr.edu added support for Macintosh.
  189.    V1.02, 92-06-16, Izumi Ohzawa, added support for Prolog, Epilog.
  190.    V1.03, 92-06-16, Denis Pelli, set type and creator of Mac files
  191.    V1.04, 92-06-17, Izumi & Denis, minor fixups for portability
  192.    V1.05, 92-07-01, Denis fixed bug reported by Larry Thibos, can now open
  193.                        files in any folder.
  194.    ---------------------------------------------------------------------------
  195.