home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 3 / Meeting_Pearls_III.iso / Pearls / imdb / tools / Readme < prev    next >
Text File  |  1995-09-30  |  12KB  |  301 lines
  1.                          ApplyDiffs 1.2 (01.10.95)
  2.                          =========================
  3.  
  4.                         (c) 1995 by André Bernhardt
  5.  
  6. If  you  have  tested  this  little  program,  please  send  an E-Mail with
  7. comments, suggestions, bugreports or simply "It works" to:
  8.  
  9.                 Andre Bernhardt <ujad@rz.uni-karlsruhe.de>
  10.  
  11. If   you   do  not  know  what  the  Internet  MovieDatabase  is,  get  the
  12. MovieDatabase  FAQ  which  may be obtained by anonymous ftp to rtfm.mit.edu
  13. under  /pub/usenet/news.answers/movies/movie-database-faq,  or  by  sending
  14. e-mail to <movie@ibmpcug.co.uk> with the subject "HELP FAQ"
  15.  
  16.  
  17. TEMPLATE
  18. ========
  19.  
  20.  
  21. ApplyDiffs LISTDIR/A,DIFFDIR/A,KEEP/S,NOCHECK/S,QUIET/S,NOSTATS/S
  22.  - LISTDIR  directory where the moviedatabase listfiles are located
  23.  - DIFFDIR  directory where the diffiles are located
  24.  - KEEP     option. If  present, a copy of the old listfiles as well as the
  25.             successfully applied diff-files will be kept.
  26.  - NOCHECK  disables checking the diff- and listfiles before applying.
  27.  - QUIET    option. If present, don't print any progress-information, 
  28.             only stats
  29.  - NOSTATS  option. If present, don't print the stats.
  30.  
  31.  
  32. PURPOSE
  33. =======
  34.  
  35.  
  36. The Internet MovieDatabase files are updated every Friday.  The latest full
  37. versions  of  all  the  files  are  held in the 'database' directory of the
  38. MovieDatabase  FTP-servers.   The  'diffs'  directory contains sets of diff
  39. files for each week's database files with respect to the previous week's.
  40.  
  41. Each  file  in this directory is a tar archive which unpacks to a directory
  42. called  'diffs'.   The  tar archives are named according to the week's full
  43. data  to  which  they  should be applied in order to generate the following
  44. week's data.  The filename format is:
  45.  
  46.   diffs-YYMMDD.tar.gz
  47.  
  48. For  example,  diffs-941230.tar.Z  contains  the diffs to be applied to the
  49. 30th  December  1994  files  in order to generate the files for 6th January
  50. 1995.
  51.  
  52. NOTE:   A  copy  of  the  Internet  MovieDatabase Diff-Files is uploaded on
  53. AMINET  every  week  as  lha-archive.  You should be able to get the latest
  54. diffs from your AMINET-mirror-site.
  55.  
  56. The  program  'ApplyDiffs'  applies all files of the weekly diff-archive to
  57. the  listfiles  of the Internet MovieDatabase and checks the consistency of
  58. the data.
  59.  
  60. NOTE:   if  you miss more than one weeks worth of updates you need to apply
  61. the  patches  for  all  the missing weeks in succession to bring your local
  62. copies up to date.
  63.  
  64. In  order  to  check  that  the  diffs have been applied correctly, all the
  65. database files include a CRC on their first line.  The program 'ApplyDiffs'
  66. will automatically verify that this checksum is correct.
  67.  
  68. After  having  applied  all  diffs  to  the  listfiles,  a  summary  of all
  69. diff-files  together  with  the status information and number of lines that
  70. have been added and deleted is shown.
  71.  
  72.  
  73. REQUIREMENTS
  74. ============
  75.  
  76.  
  77. In  order  to  update your local installation of the Internet MovieDatabase
  78. you need the following things:
  79.  
  80. -  A  complete  and recent distribution of the database files. You can only
  81. apply  a  set  of  diffs  to  a  certain  set of listfiles!  Simply get all
  82. listfiles  from  the FTP-server and start applying diffs from the following
  83. week on.
  84.  
  85. -  A  copy  of the 'gzip'-program for the Amiga.  It should be available on
  86.    AMINET.
  87.  
  88. -  A  copy  of  the 'tar'- or 'gnutar'-program for the Amiga.  You can also
  89.    find this program on AMINET.
  90.  
  91. -  The program 'ApplyDiffs' from this package
  92.  
  93. -  And finally, you need of course 'MovieMUI', the database-program.
  94.  
  95.  
  96. USAGE
  97. =====
  98.  
  99.  
  100. - Uncompress the tar-archive
  101.  
  102.    gzip -d diffs-YYMMDD.tar.gz
  103.  
  104.   where  YYMMDD  is  the  date  of last week's full data to which the diffs
  105.   shall be applied in order to generate this week's data.
  106.  
  107. - Un-tar the archive using the tar-program:
  108.  
  109.    tar -xvf diffs-YYMMDD.tar
  110.   or
  111.    gnutar -xvf diffs-YYMMDD.tar
  112.  
  113. - Start  'ApplyDiffs'  by  giving  the  directory-path where you keep  your
  114.   listfiles  and the directory-path where the diffs are.  'ApplyDiffs' will
  115.   scan the diffs-directory for diff-files and try to apply them.
  116.   If  you  use  the  option  "KEEP",  a  copy  of  the old listfile and the
  117.   apropriate  diff-file  will  be  kept  in case anything goes wrong.  If a
  118.   diff-file  cannot  be  applied,  an  error  message  (e.g.  "CRC-Checksum
  119.   Error") will be issued and the file will be skipped.
  120.  
  121.   E.g. Assuming that you keep your listfiles in the directory 
  122.   "dh0:MovieDatabase/lists/" and you have un'tar'ed the diffs to "t:"
  123.   you need to run 'ApplyDiffs':
  124.  
  125.    ApplyDiffs dh0:MovieDatabase/lists/ t:diffs/
  126.   or
  127.    ApplyDiffs dh0:MovieDatabase/lists/ t:diffs/ KEEP
  128.  
  129. - Run  'MovieMUI'  and  'update  database'  to get the most recent  version
  130.   installed.
  131.  
  132.  
  133. CHECKING
  134. ========
  135.  
  136. Unless the option NOCHECK is specified, ApplyDiffs will check the list- and
  137. diff-files  before  applying.   If  one or more errors were encountered, no
  138. diffs - even those that would work without problems - will be processed.
  139.  
  140. Checking  however  takes  some time.  If you don't need it, you can disable
  141. checking by using the NOCHECK switch.
  142.  
  143.  
  144. STATS-INFORMATION
  145. =================
  146.  
  147.  
  148. After  having  applied  all  diffs  to  the  listfiles,  a  summary  of all
  149. diff-files  together  with  the status information and number of lines that
  150. have been added and deleted is shown.
  151.  
  152. The text in the status column means:
  153.  
  154.  - OK             The diffs have been applied allright.
  155.  
  156.  - New File       This is in fact no error, but to inform you that a new 
  157.                   listfile has become available.
  158.  
  159.  - CRC-Error      The CRC-Sum is not correct.
  160.                   Should not occur unless anyone has tampered with the file.
  161.  
  162.  - IO-Error       ApplyDiffs failed to open, read or write a file.
  163.  
  164.  - Wrong Diffs    You are trying to apply the diffs to a wrong listfile
  165.                   Please check that you do only apply the correct pairs of
  166.                   diffs-listfiles.
  167.  
  168.  - Syntax Error   The diff-file contains commands that are unknown to
  169.                   Applydiff. Maybe this is not a diff-file at all!?
  170.  
  171. IMPORTANT:
  172.  If  the  status  is  other  than  OK,  the  original listfile will be left
  173.  unchanged.   The other files however may have been changed.  You might run
  174.  into  trouble  when  applying the following week's diffs if you don't find
  175.  the cause of the trouble.
  176.  If you can't get ApplyDiffs to apply the diffs to a certain file, the best
  177.  thing  to  do  is  to  get  this  listfile  from  one of the MovieDatabase
  178.  FTP-sites.
  179.  
  180.  
  181. RETURN-VALUES
  182. =============
  183.  
  184.  
  185. ApplyDiffs will return:
  186.  
  187.    0 if everything was O.K.
  188.  
  189.   10 as a warning that some minor problems occurred. 
  190.      E.g. A listfile was missing somewhere, or an CRC-sum was wrong
  191.  
  192.   20 if a serious error has occurred
  193.  
  194. You  can use these values for a shell-script that automagically fetches the
  195. latest diff-file, applies the data and updates the MovieDatabase.
  196.  
  197.  
  198. WHY APPLYDIFFS?
  199. ===============
  200.  
  201.  
  202. Instead  of  Applydiffs,  you could as well use the common program 'patch'.
  203. Unfortunately,  this program creates very big temporary files when updating
  204. the  actors-  &  actresses lists.  It is also very slow and can't check the
  205. CRC-sums.   ApplyDiffs  on  the  other  hand  can only be used to apply the
  206. MovieDatabase-diffs to the listfiles.  It cannot be used to apply any diffs
  207. created by the program 'diff'!
  208.  
  209.  
  210. DISCLAIMER
  211. ==========
  212.  
  213.  
  214.    THERE  IS  NO  WARRANTY  FOR  THE  PROGRAM,  TO  THE EXTENT PERMITTED BY
  215. APPLICABLE  LAW.   EXCEPT  WHEN  OTHERWISE  STATED IN WRITING THE COPYRIGHT
  216. HOLDER  AND/OR OTHER PARTIES PROVIDE THE PROGRAM ''AS IS'' WITHOUT WARRANTY
  217. OF  ANY  KIND,  EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
  218. THE  IMPLIED  WARRANTIES  OF  MERCHANTABILITY  AND FITNESS FOR A PARTICULAR
  219. PURPOSE.   THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
  220. IS  WITH  YOU.   SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
  221. ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  222.  
  223.    IN  NO  EVENT  UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
  224. WILL  ANY  COPYRIGHT  HOLDER,  OR  ANY OTHER PARTY WHO MAY REDISTRIBUTE THE
  225. PROGRAM  AS  PERMITTED  ABOVE,  BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
  226. GENERAL,  SPECIAL,  INCIDENTAL  OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
  227. USE  OR  INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
  228. DATA  OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
  229. PARTIES  OR  A  FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
  230. EVEN  IF  SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
  231. SUCH DAMAGES.
  232.  
  233.  
  234. LICENSE
  235. =======
  236.  
  237.  
  238. This  file  is  part  of  the  Internet Movie Database.  The database is an
  239. international  volunteer  effort  whose  principal  objective is to provide
  240. useful  and up to date movie information *freely* available on-line, across
  241. as  many  systems  and  platforms as possible.  The Internet Movie Database
  242. Team  can  be reached via e-mail at <imdb-team@ibmpcug.co.uk> and are happy
  243. to discuss the implications of and exceptions to this license.
  244.  
  245. All  data  and  software  released  by  the Internet Movie Database Team is
  246. freely available to anyone within certain limitations described below.  You
  247. are  encouraged  to quote subsets of the database in USENET articles, movie
  248. related  FAQs,  magazine  articles  etc.   We  do  ask,  however,  that  if
  249. appropriate,  you  make  reference  to the source of the data and provide a
  250. pointer to database for the benefit of the reader.
  251.  
  252. Permission is granted by the copyright holder to allow free distribution of
  253. this  file  and  any  other  part  of  the  Internet  Movie  Database in an
  254. ELECTRONIC FORM ONLY, providing the following conditions are met:
  255.  
  256.  (1) NO  FEE  OF  ANY  KIND  (however  indirect),  can  be  charged for its
  257.      distribution.   If this file is being stored for later distribution to
  258.      anyone  that  can  be seen as a customer to yourself or your company /
  259.      organization  YOU  MUST  contact  the Internet Movie Database Team for
  260.      permission.
  261.  
  262.  (2) Each of the database files may be distributed individually but only in
  263.      an  unaltered form.  All the header and trailer information (including
  264.      this notice and the details on how to access the database) must remain
  265.      intact.
  266.  
  267.  (3) Specifically  the  files  may  NOT  be  used to  construct any kind of
  268.      on-line  database (except for individual personal use).  Clearance for
  269.      ALL  such  on-line  data resources must be requested from the Internet
  270.      Movie  Database  Team.  This is to enable us to maintain an up to date
  271.      list  of all such sites.  Clearance will be granted provided access to
  272.      said database is itself entirely free from ANY fees.
  273.  
  274.  (4) In  addition, copies  of the movie database frequently asked questions
  275.      list  and additions guide must be made available in the same area / by
  276.      the same method as the other database files.
  277.  
  278.  (5) CD-ROM distribution is  prohibited without written permission from the 
  279.      Internet Movie Database Team (see below for an e-mail contact).
  280.  
  281. Distribution  by  e-mail, BBS and internet systems is positively encouraged
  282. within these limitations.
  283.  
  284. The  files and software which make up the movie database may be uploaded to
  285. commercial  BBS  systems providing that the above conditions are met and no
  286. *additional*   fees   are  applied  above  the  standard  connect  time  or
  287. downloading charges.
  288.  
  289. This  copyright  notice has been designed to ensure that the voluntary time
  290. and  effort  of the Internet Movie Database Team and database users, is not
  291. used  for financial gain by those who have contributed nothing or little to
  292. its  growth  or  success.  The changing nature of the Internet towards more
  293. commercial  uses has forced us to produce this statement.  Please do not be
  294. discouraged  from  submitting additions to the database as a result of this
  295. policy.   If  you  need  further explanation please contact the team at the
  296. address given below.
  297.  
  298. If  you  are in doubt as to whether this copyright notice prevents you from
  299. distributing  the database to others, you should contact the Internet Movie
  300. Database Team by e-mail at <imdb-team@ibmpcug.co.uk>.
  301.