warp/README

   1 Copyright (c) 2020 The NetBSD Foundation, Inc.
   2 All rights reserved.
   3
   4 This code is derived from software contributed to The NetBSD Foundation
   5 by Larry Wall.
   6
   7 Redistribution and use in source and binary forms, with or without
   8 modification, are permitted provided that the following conditions
   9 are met:
  10 1. Redistributions of source code must retain the above copyright
  11    notice, this list of conditions and the following disclaimer.
  12 2. Redistributions in binary form must reproduce the above copyright
  13    notice, this list of conditions and the following disclaimer in the
  14    documentation and/or other materials provided with the distribution.
  15
  16 THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  17 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  18 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  20 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 POSSIBILITY OF SUCH DAMAGE.
  27
  28 --------------------------------------------------------------------------
  29
  30 Warp is a real-time space war game that doesn't get boring very quickly.
  31 Read warp.doc and the manual page for more information.
  32
  33 Warp will probably not run on V7 systems that don't have a non-blocking read,
  34 or on machines with a small address space like the PDP-11.  Caveat Emptor.
  35
  36 Please read all the directions below before you proceed any further, and
  37 then follow them carefully.  Failure to do so may void your warranty. :-)
  38
  39 After you have unpacked your kit, you should have all the files listed
  40 in MANIFEST.
  41
  42                             IMPORTANT
  43
  44 You must choose the uid that you want warp to run under, since warp runs
  45 setuid to protect its files.  Choose a uid (not root) that is used only
  46 by trustworthy persons.  If you do your make install as root, the installed
  47 version will be chowned to this uid.  Otherwise, you should login to your
  48 selected uid before proceeding.  The Configure script will ask you which
  49 uid you want warp to run under.
  50
  51 Installation
  52
  53 1)  Run Configure.  This will figure out various things about your system.
  54     Some things Configure will figure out for itself, other things it will
  55     ask you about.  It will then proceed to make config.h, config.sh, and
  56     Makefile.
  57
  58     You might possibly have to trim # comments from the front of Configure
  59     if your sh doesn't handle them, but all other # comments will be taken
  60     care of.
  61
  62     (If you don't have sh, you'll have to copy the sample file config.H to
  63     config.h and edit the config.h to reflect your system's peculiarities.)
  64
  65 2)  Glance through config.h to make sure system dependencies are correct.
  66     Most of them should have been taken care of by running the Configure script.
  67
  68     If you have any additional changes to make to the C definitions, they
  69     can be done in the Makefile, or in config.h.  Bear in mind that they will
  70     get undone next time you run Configure.
  71
  72 3)  make depend
  73
  74     This will look for all the includes and modify Makefile accordingly.
  75     Configure will offer to do this for you.
  76
  77 4)  make
  78
  79     This will attempt to make warp in the current directory.
  80
  81 5)  make install
  82
  83     This will put warp into a public directory (normally /usr/games).
  84     It will also try to put the man pages in a reasonable place.  It will not
  85     nroff the man page, however.  You may need to be root to do this.  If
  86     you are not root, you must own the directories in question and you should
  87     ignore any messages about chown not working.
  88
  89 6)  Read the manual entry before running warp.
  90
  91 7)  Feel free to edit warp.news.
  92
  93 8)  IMPORTANT!  Help save the world!  Communicate any problems and
  94     suggested patches to me, lwall@sdcrdcf.UUCP (Larry Wall), so we can
  95     keep the world in sync.  If you have a problem, there's someone else
  96     out there who either has had or will have the same problem.
  97
  98     If possible, send in patches such that the patch program will apply them.
  99     Context diffs are the best, then normal diffs.  Don't send ed scripts--
 100     I've probably changed my copy since the version you have.
 101
 102     Watch for warp patches in comp.sources.bugs.  Patches will generally be
 103     in a form usable by the patch program.  If you are just now bringing up
 104     warp and aren't sure how many patches there are, write to me and I'll
 105     send any you don't have.  Your current patch level is shown in patchlevel.h.
 106
 107
 108 NEW FEATURES IN THIS RELEASE
 109
 110 Uses a Configure script for greater portability.
 111 Space Amoebas!!!
 112 Pirates
 113 Friendly Freighters
 114 Harry Mudd
 115 Damage
 116 Keyboard mapping