1                       Compiling CircleMUD under UNIX
  2                   by Jeremy Elson (jelson@circlemud.org)
  3                   For help, write to help@circlemud.org
  4  
  5  Compiling CircleMUD is easy using almost any variant of UNIX (for
  6  example: Linux/MkLinux, Solaris, SunOS, IRIX, HP/UX, Ultrix, OSF, and
  7  NetBSD/OpenBSD/FreeBSD/BSDI, just to name a few).  If you have any type
  8  of UNIX system, these instructions are for you.  If not, check the main
  9  README file to get a list of other operating systems that can be used to
 10  compile and run CircleMUD.
 11  
 12  Current versions of Circle use the GNU 'autoconf' package to
 13  automatically determine most of the important characteristics of your
 14  system, so chances are good that Circle will compile correctly on any
 15  UNIX system -- even one that we have never seen before.  However, if you
 16  do have problems, please drop us a note at help@circlemud.org so that we
 17  can try to make Circle work with every UNIX variant that we can.
 18  
 19  1)  Download the latest version of CircleMUD.  You can always find the
 20      latest version at the following anonymous FTP sites:
 21  
 22          ftp.circlemud.org:/pub/CircleMUD/3.x
 23          ftp2.circlemud.org:/pub/CircleMUD/3.x
 24  
 25      You can also find information at the WWW site:
 26  
 27          http://www.circlemud.org/
 28  
 29      The latest version will be called something ending in .tar.gz, like
 30      "circle30bplXX.tar.gz". (where 'XX' is the patchlevel)
 31  
 32  
 33  2)  Unpack the archive.  If you have the .tar.gz version, uncompress it
 34      using gzip (GNU unzip) and the tar archiver.  (Both of these utilities
 35      can be downloaded from ftp.gnu.ai.mit.edu:/pub/gnu if you don't have
 36      them.)  To unpack the archive on a UNIX system, type:
 37  
 38          gzip -dc circle30xxxx.tar.gz | tar xvf -
 39  
 40  
 41  3)  Configure CircleMUD for your system.  Circle must be configured using
 42      the 'configure' program which attempts to guess correct values for
 43      various system-dependent variables used during compilation.  It uses
 44      those values to create a 'Makefile' and a header file called 'conf.h'.
 45  
 46      From Circle's root directory, type
 47  
 48          ./configure
 49  
 50      If you're using 'csh' on an old version of System V, csh might try to
 51      execute 'configure' itself, giving you a message like "Permission denied"
 52      when you try to run "./configure".  If so, type "sh ./configure" instead.
 53  
 54      'configure' can take several minutes if you're using a slow computer.
 55  
 56      'configure' will attempt to use the 'gcc' compiler if it exists; if not,
 57      it will try 'cc'.  If you want to use a different compiler, set the
 58      'CC' environment variable to the name of the compiler you wish to use.
 59  
 60      For example, if you want to use the 'xlc' compiler, and your shell is
 61      csh or tcsh:
 62  
 63  	setenv CC xlc
 64  	./configure
 65  
 66      Or, if you want to use the 'xlc' compiler, and your shell is sh or bash:
 67  
 68  	CC=xlc ./configure
 69  
 70      This will tell 'configure' to use the 'xlc' compiler instead of 'gcc'.
 71  
 72  
 73  4)  Build the CircleMUD server.  This must be done from the 'src' directory.
 74      Type:
 75     
 76          cd src; make all
 77  
 78      This will build CircleMUD proper as well as its 10 or so ancillary
 79      utilities, which can take anywhere from 5 minutes to an hour depending
 80      on the speed of your computer.
 81  
 82      Note that in the future, when you need to recompile Circle as you make
 83      changes to the code, it is NOT necessary to run 'configure' again (it
 84      should only be run once, after the first time you unpack Circle from
 85      its .tar file).  If you move the source code to a different computer,
 86      you should reconfigure it by deleting the file 'config.cache' and
 87      running 'configure' again.
 88  
 89      The first time you try to compile Circle, you will be asked to read the
 90      CircleMUD license.  Please read it!
 91  
 92  
 93  5)  Go back to Circle's root directory (by typing "cd ..") and run the
 94      CircleMUD server.  The easiest way to do this the first time is
 95      to use the 'autorun' script, which can be run in the background by
 96      typing:
 97  
 98          ./autorun &
 99  
100      Make sure to do this in Circle's root directory, not the src directory
101      that you used for the previous step.  A file called 'syslog' will start
102      growing in the same directory that contains Circle's log messages.
103  
104      If you're using 'csh' on an old version of System V, csh might try to
105      execute 'autorun' itself, giving you a message like "Permission denied"
106      when you try to run "./autorun".  If so, type "sh ./autorun &" instead.
107  
108  6)  Wait until the line 'No connections.  Going to sleep.' appears in the
109      syslog.  This indicates that the server is ready and waiting for
110      connections.  It shouldn't take more than about 30 seconds for the MUD
111      to reach this state, though performance will vary depending on how fast
112      your computer is.
113  
114      If a file appears called 'syslog.CRASH', the MUD has terminated
115      (probably abnormally).  Check the contents of syslog.CRASH to see
116      what error was encountered.
117  
118  
119  7)  Type 'telnet localhost 4000' to connect.  The first person to log in
120      will be made an implementor (level 34) with all powers.
121  
122  
123  Jeremy Elson (jelson@circlemud.org)
124  (write to help@circlemud.org for help)
125  
126