doc/INSTALL

   1 BINARY INSTALL, BUILD, TOOLS, LOCALIZING  (last updated 2007-02-15)
   2 -------------------------------------------------------------------
   3
   4 CONTENTS
   5
   6 (1) WIN32 BINARY DISTRIBUTION INSTALLATION
   7 (2) BUILD newLISP FROM SOURCE for LINUX, free/net/openBSD, MacOSX, Solaris
   8 (3) COMMENTS FOR COMPILING AND LINKING
   9 (4) TOOLS
  10 (5) LOCALIZATION
  11 (6) INSTALLING AFTER BUILDING FROM SOURCE
  12 (7) UNINSTALL
  13 (8) RUNNING newLISP IN A SHELL OR CONSOLE WINDOW
  14 (9) RUNNING THE newLISP-GS GRAPHICAL FRONTEND
  15
  16
  17 (1) WIN32 BINARY DISTRIBUTION INSTALLATION
  18 ------------------------------------------
  19
  20 The Win32 binary distribution comes packed asa Win32 installer
  21 application. After downloading a file:
  22
  23     newlisp-xxxx-win-gs-xxx.exe
  24
  25 douuble click on it and follow instructtions. xxxx and xxx are
  26 the version numbers for newLISP and the newLISP-tk the GUI frontend.
  27
  28
  29 (2) BUILD newLISP FROM SOURCE for LINUX, free/net/openBSD, MacOSX, Solaris
  30 ---------------------------------------------------------------------------
  31
  32 Un-tar/gunzip the distribution file newlisp_9.x.x.tgz :
  33
  34     tar xzvf newlisp_9.x.x.tgz
  35
  36 Change the current directory in to newlisp_x.x.x/
  37 From the command line do:
  38
  39     make
  40
  41 this will automatically detect one of the platforms Linus, MacOS X, FreeBSD,
  42 OpenBSD, NetBSD and SunOS/Solaris.
  43
  44 To just check what OS flavor make would detect, type:
  45
  46     ./configure
  47
  48 ther are many other flavors for different OS and compilers type
  49 make with help to see all options:
  50
  51     make help
  52
  53 If 'make' comes back with error messages try gmake, or any other
  54 make compatible with gmake.
  55
  56 to remove objects and before switching make flavors:
  57
  58     make clean
  59
  60 Since version 9.0.14 newLISP can also be compiled for 64-bit Linux
  61 with 64-bit memory pointers. See the file: Makefile for details.
  62
  63
  64 (3) COMMENTS FOR COMPILING AND LINKING
  65 --------------------------------------
  66
  67 Some OS's and installations may not support 'readline' or support for
  68 milli seconds resolution in the time functions or library import functionality.
  69 See the options NANOSLEEP, READLINE and NOIMPORT in the makefile_xxx
  70 for your platform and compilation flavor. When using the READLINE option
  71 on some OSs the library options -lreadline and -lncurses or -ltermcap have
  72 to be replaced. Study the makefile of your platorm.
  73
  74 On MacOSX the flavor 'osx' is without readline support the flavor 'darwin'
  75 is with readline support.
  76
  77 On some platforms the warning message "ANSI does not support long long" will be
  78 issued for every file compiled. This message can be discarded and does not occur
  79 on newer versions of GCC. The 'long long' data type is not used anywhere in the
  80 newLISP source but part of some header files of the GCC installation.
  81
  82 The Linux version is without readline support by default, because readline
  83 support does not come in the default install of many Linux distributions.
  84
  85 When creating Win32 versions read the file README_WIN32 first.
  86
  87
  88 (4) TOOLS
  89 ---------
  90
  91 Besides gcc for the 'C' compiler, several other tools are used for packaging
  92 the installer for Win32, configuring PCRE etc. These tools can be found at:
  93 http://newlisp.org/download/Tools/
  94
  95 For a normal installation from the source distribution only the GCC or
  96 compatible compiler is required.
  97
  98
  99 (5) LOCALIZATION
 100 ----------------
 101
 102 The PCRE Regular Expressions code can be localized to your country/language
 103 (see comments in file 'makefile'), it comes with default character tables for
 104 English. For correct working of other string functions in your country/language
 105 a localizable 'C' library/OS may have to be used. The names of newLISP functions can
 106 be localized during runtime without performance loss, (see newlisp_manual.html).
 107
 108 There are also UTF-8 versions/makefiles available in the source distribution.
 109 See the chapter about 'Customization, localization and UTF-8' in the manual.
 110
 111
 112 (6) INSTALLING AFTER BUILDING FROM SOURCE
 113 -----------------------------------------
 114
 115 To install log in as super user or root and do:
 116
 117     make install
 118
 119 On Mac OSX when not running as superuser (but with admin rights):
 120
 121     sudo make install
 122
 123 If you cannot get super user or root privileges, newslisp can be installed
 124 in yur home directory in $HOME/bin and $HOME/share instead of /usr/bin
 125 and /usr/share
 126
 127     make install_home
 128
 129 This will create /usr/share/newlisp  or $HOME/bin and $HOME/share/newlisp and
 130 /usr/share/doc/newlisp or $HOME/share/doc/newlisp
 131
 132 (7) UNINSTALL
 133 --------------
 134
 135 sto uninstall if installed with make install do:
 136
 137     make uninstall
 138
 139 or if installed with install_home
 140
 141     make uninstall_home
 142
 143
 144 make and executables are tested on Mandrake Linux, FreeBSD, Solaris
 145 Darwin/Mac OSX and WinXP Home
 146
 147 (8) RUNNING newLISP IN A SHELL OR CONSOLE WINDOW
 148 -------------------------------------------------
 149
 150 On all platforms simply execute:
 151
 152  newlisp <enter>
 153
 154 on the command line. On Win32 the execution path of newlisp.exe was added
 155 to the environment during installation. On all other platforms the newlisp
 156 binary is in /usr/bin/newlisp or when using the home install in $HOME/bin
 157 where $HOME is the the home directory of the user taken from the environment
 158 variable HOME.
 159
 160
 161 (9) RUNNING THE newLISP-GS GRAPHICAL FRONTEND
 162
 163 On Win32 and Mac OS X a Java based syntaxhighlighting editor is installed in
 164 in the Applications menus. The editor needs a Java runtime environment JRE
 165 versin 1.5 as a minimum. In case it is not installed it can be obtained from
 166 http://java.sun.com .
 167
 168                                  +++
 169