libsablot/INSTALL

   1 This file describes the installation procedure of Sablotron. To know
   2 more on Sablotron, please read the README file in the same directory
   3 as this file.
   4
   5 To get more info on installing on *Windows*, please read
   6 the INSTALL_WIN file.
   7
   8 For specific information on how to build Sablotron with JavaScript
   9 engine (to enable extensions) see the README_JS file.
  10
  11 1. Intro
  12 2. Building
  13 3. Preinstalled Expat
  14 4. Binary distributions
  15 5. Environment
  16 6. Documentation
  17 7. More info
  18
  19
  20 1. Intro
  21 ========================================
  22
  23 Sablotron is based on Expat XML parser.
  24
  25 There is a significant change of how Expat is used since version
  26 0.50. Sablotron _never_ looks for Expat under its own source tree, but
  27 it supposes, that you have installed Expat library (1.95.1 or later)
  28 in your system.
  29
  30 To get Expat, visit
  31
  32 http://sourceforge.net/projects/expat/
  33
  34 and download/install source/binary package.
  35
  36 Sablotron should be able to find and link older expat libraries
  37 (libxmlparse, libxmltok), but this feature is not tested and is
  38 deprecated.
  39
  40
  41 2. Building (sources)
  42 ========================================
  43
  44 If you have downloaded the binary distribution, you can skip reading this
  45 section and go to the Environment section.
  46
  47 Sablotron compiles e.g. on the following platforms:
  48
  49 - Linux (RH 5.2 - 7.0, gcc 2.95.2 or later)
  50 - Windows (NT 4.0, 9x, 2000, VC++ 4.2/6.0)
  51 - Solaris (Solaris 2.5.1, 2.6, 7, gcc 2.91.57)
  52 - FreeBSD (FreeBSD 3.4, 4.1)
  53 - OpenBSD (OpenBSD 2.8 beta)
  54 - HP-UX
  55 - Irix
  56 - MacOS X
  57
  58 If you need any other port, please contact us.
  59
  60 We use GNU autoconf since the version 0.41. So the following steps
  61 should work on any UNIX platform:
  62
  63   ./configure
  64   make
  65   make install (may require the root privileges)
  66
  67 These switches can be passed to ./configure
  68
  69   --enable-javascript
  70         enables JS extension functions
  71   --enable-perlconnect
  72         required when installed with Charlie application framework
  73   --enable-debugger
  74         enables XSLT debugger
  75   --with-readline
  76         links the debugger with the readline library to make its command-line
  77         interface more comfortable (SABLOT_GPL=1 must be exported)
  78
  79 These are some other useful switches you may want to pass to the configure
  80 script:
  81
  82   --help
  83         display all switches available
  84   --prefix='path where to install'
  85         specifies the installation path (/usr/local on most systems)
  86   --enable-warnings
  87         force compilation with the -Wall switch (for curious people)
  88   --disable-adding-meta
  89         disables adding of the META tag (html output method)
  90   --disable-static
  91         static library is not created to make compilation faster
  92
  93
  94 3. Preinstalled Expat
  95 ========================================
  96
  97 This chapter is obsolete, but may contain some useful info for people
  98 running older configuration.
  99
 100 This version of the build process on all Unix platforms respects the
 101 presence of Expat sources. If you have installed Sablotron and Expat in
 102 the past (with `make install'), the configure script writes makefiles, so
 103 they link Expat from your system directories (the sources win, if present).
 104
 105 If you have installed Expat in some non-system directories in the
 106 past, configure script won't find headers, and build process will
 107 fail, even if you specify include path with --includedir switch. To
 108 fix this problem, set CPLUS_INCLUDE_PATH environment variable to point
 109 to Expat headers.
 110
 111
 112 4. Binary distributions
 113 ========================================
 114
 115 Binaries are available for Linux Intel (rpm) and Windows32.
 116
 117
 118 5. Environment
 119 ========================================
 120
 121 No environment changes are needed (finally!). That's,
 122 of course, true only if you've used standard 'make install'
 123 procedure.
 124
 125 The list of environment variables, you may possibly need modify:
 126
 127 LIBRARY_PATH: set this variable to the directory, where the Expat XML
 128 parser is installed. Do it in the case the configure/linker couldn't
 129 find the expat libraries.
 130
 131 LD_LIBRARY_PATH: add lib directory to this variable, if sabcmd reports
 132 "Can't load shared library libsablot.0.xx" or such thing.
 133
 134 CPLUS_INCLUDE_PATH: is needed if you didn't install Sablotron (and
 135 mainly Expat) into system directories and you're going compile new
 136 version against older version of Expat. (see "Preinstalled Expat")
 137
 138 On some systems (UnixWare, NetBSD...) the compiler is unable to find
 139 headers in /usr/local/include. Consequently the 'configure' script
 140 doesn't find the expat header and compilation fails. To avoid this
 141 problem, set CPPFLAGS environment to
 142 '-I/usr/local/include'. CPLUS_INCLUDE_PATH is not enough.
 143
 144 If want to link Sablotron with GNU readline library you need set SABLOT_GPL
 145 environment variable to 1 to declare you are going to use this software
 146 under the GPL.
 147
 148
 149 6. Documentation
 150 ========================================
 151
 152 The source package contains XML sources of three guides:
 153
 154 Sablotron Guide and Reference
 155 Sablotron Extensions API Reference
 156 SXP Reference
 157
 158 These guides are translated to HTML during the building of the package.
 159 By default, you can find the HTML guides in
 160
 161 $(distdir)/doc/apidoc/[sablot|jsdom-ref|sxp]
 162 and
 163 $(datadir)/doc/html/[sablot|jsdom-ref|sxp]
 164
 165 directories.
 166
 167 The building of documentation requires Perl and XML::Parser to be installed;
 168 otherwise the building is skipped.
 169
 170
 171 7. More info
 172 ========================================
 173
 174 We suppose you have read the README file. If you haven't, read it now.
 175 If it is not enough, take a look at our website:
 176
 177 http://www.gingerall.org
 178
 179
 180 Enjoy Sablotron!!
 181
 182 GA
 183
 184
 185
 186
 187