usr.bin/patch/README

   1 $DragonFly: src/usr.bin/patch/Attic/README,v 1.1 2004/09/24 18:44:28 joerg Exp $
   2 #######################################################################
   3
   4 this version modified to fit in with the 386bsd release.
   5 this isn't gnu software, so we're not obligated to give
   6 you the original sources -- if you want them, get them
   7 from prep.ai.mit.edu:pub/gnu/patch-2.0.12u8.tar.z
   8
   9                                         -- cgd
  10
  11 #######################################################################
  12
  13
  14 This version of patch contains modifications made by the Free Software
  15 Foundation, summarized in the file ChangeLog.  Primarily they are to
  16 support the unified context diff format that GNU diff can produce, and
  17 to support making GNU Emacs-style backup files.  They also include
  18 fixes for some bugs.
  19
  20 There are two GNU variants of patch: this one, which retains Larry
  21 Wall's interactive Configure script and has patchlevels starting with
  22 `12u'; and another one that has a GNU-style non-interactive configure
  23 script and accepts long-named options, and has patchlevels starting
  24 with `12g'.  Unlike the 12g variant, the 12u variant contains no
  25 copylefted code, for the paranoid.  The two variants are otherwise the
  26 same.  They should be available from the same places.
  27
  28 The FSF is distributing this version of patch independently because as
  29 of this writing, Larry Wall has not released a new version of patch
  30 since mid-1988.  I have heard that he has been too busy working on
  31 other things, like Perl.
  32
  33 Here is a wish list of some projects to improve patch:
  34
  35 1.  Correctly handle files and patchfiles that contain NUL characters.
  36 This is hard to do straightforwardly; it would be less work to
  37 adopt a kind of escape encoding internally.
  38 Let ESC be a "control prefix".  ESC @ stands for NUL.  ESC [ stands for ESC.
  39 You need to crunch this when reading input (replace fgets),
  40 and when writing the output file (replace fputs),
  41 but otherwise everything can go along as it does now.
  42 Be careful to handle reject files correctly;
  43 I think they are currently created using `write', not `fputs'.
  44
  45 2.  Correctly handle patches produced by GNU diff for files that do
  46 not end with a newline.
  47
  48 Please send bug reports for this version of patch to
  49 bug-gnu-utils@prep.ai.mit.edu as well as to Larry Wall (lwall@netlabs.com).
  50  --djm@gnu.ai.mit.edu (David MacKenzie)
  51
  52                         Patch Kit, Version 2.0
  53
  54                     Copyright (c) 1988, Larry Wall
  55
  56 Redistribution and use in source and binary forms, with or without
  57 modification, are permitted provided that the following condition
  58 is met:
  59  1. Redistributions of source code must retain the above copyright
  60     notice, this condition and the following disclaimer.
  61
  62 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  63 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  64 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  65 ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  66 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  67 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  68 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  69 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  70 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  71 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  72 SUCH DAMAGE.
  73 --------------------------------------------------------------------------
  74
  75 Please read all the directions below before you proceed any further, and
  76 then follow them carefully.  Failure to do so may void your warranty. :-)
  77
  78 After you have unpacked your kit, you should have all the files listed
  79 in MANIFEST.
  80
  81 Installation
  82
  83 1)  Run Configure.  This will figure out various things about your system.
  84     Some things Configure will figure out for itself, other things it will
  85     ask you about.  It will then proceed to make config.h, config.sh, and
  86     Makefile.
  87
  88     You might possibly have to trim # comments from the front of Configure
  89     if your sh doesn't handle them, but all other # comments will be taken
  90     care of.
  91
  92     If you don't have sh, you'll have to rip the prototype of config.h out
  93     of Configure and generate the defines by hand.
  94
  95 2)  Glance through config.h to make sure system dependencies are correct.
  96     Most of them should have been taken care of by running the
  97     Configure script.
  98
  99     If you have any additional changes to make to the C definitions, they
 100     can be done in the Makefile, or in config.h.  Bear in mind that they may
 101     get undone next time you run Configure.
 102
 103 3)  make
 104
 105     This will attempt to make patch in the current directory.
 106
 107 4)  make install
 108
 109     This will put patch into a public directory (normally /usr/local/bin).
 110     It will also try to put the man pages in a reasonable place.  It will not
 111     nroff the man page, however.
 112
 113 5)  Read the manual entry before running patch.
 114
 115 6)  IMPORTANT!  Help save the world!  Communicate any problems and
 116     suggested patches to me, lwall@netlabs.com (Larry Wall),
 117     so we can keep the world in sync.  If you have a problem, there's
 118     someone else out there who either has had or will have the same problem.
 119
 120     If possible, send in patches such that the patch program will apply them.
 121     Context diffs are the best, then normal diffs.  Don't send ed scripts--
 122     I've probably changed my copy since the version you have.
 123
 124     Watch for patch patches in comp.sources.bugs.  Patches will generally be
 125     in a form usable by the patch program.  Your current patch level
 126     is shown in patchlevel.h.