Diff for /parser3/INSTALL between versions 1.48.2.1 and 1.57

version 1.48.2.1, 2005/12/28 16:45:36 version 1.57, 2012/07/23 04:07:02
Line 1 Line 1
 Alexander Petrosian <paf@design.ru> (http://paf.design.ru)  
 $Id$  $Id$
   
 1.What is the process to compile Parser3?  1.What is the process to compile Parser3?
   
   Just start ./buildall-with-xml script and you would get $HOME/parser3install/bin/parser3 binary.    Just start ./buildall script and you would get $HOME/parser3install/bin/parser3 binary.
   In case you do not need XML support, use ./buildall-without-xml  
   
     NOTE:
     In case you do not need XML support, use ./buildall --without-xml
   
     NOTE:
     If case you need apache parser module (DSO), use ./buildall --with-apache
   
     NOTE:
     If you have gc, prce, libxml and libxslt installed, you can use ./configure --with-xml
   
   NOTE:    NOTE:
   On some platforms there is special version of libgc patched to support some    In case you later would experience problems with gcc runtime exception handling 
   local piece of subtlety.    (most notable when reporting sql-related problems), pass this to buildall script:
   Official libgc does not work there, use special version instead.    --with-sjlj-exceptions (HPUX is reported to have such problems)
   (OpenBSD reported to be one of those)  
   
   NOTE:    NOTE:
   On some systems there are no "make" and you should run 'gmake', change buildall script accordingly then.    On some systems there are no "make" and you should run 'gmake', change buildall script accordingly then.
   
 2.What is the process to install Parser3?  2.What is the process to install Parser3?
   
   make install    Copy files from $HOME/parser3install directory into your cgi-bin directory.
   
   Installation layout:    Then install Parser3 to handle documents, step-by-step instrunctions:
     $prefix/bin/      http://www.parser.ru/en/docs/lang/install4apachecgi.htm" in English
       parser3             -- CGI and command line Parser3 interpreter      http://www.parser.ru/docs/lang/install4apachecgi.htm" in Russian
       auto.p.dist         -- configuration file sample,   
                              copy it to auto.p and adjust to your needs    Directory layout:
     $prefix/etc/      bin/
       parser3.charsets/   -- charset definition files        parser3               -- CGI and command line Parser3 interpreter
         koi8-r.cfg        -- cyrillic charset [KOI8-R encoding]        auto.p.dist           -- configuration file sample,
         windows-1250.cfg  -- central europian charset [windows-1250 encoding]                                 copy it to auto.p and adjust to your needs
         windows-1251.cfg  -- cyrillic charset [windows-1251 encoding]      share/
         windows-1257.cfg  -- baltic charset [windows-1257 encoding]        charsets/
           parser3.charsets/   -- charset definition files
             koi8-r.cfg        -- cyrillic charset [KOI8-R encoding]
             windows-1251.cfg  -- cyrillic charset [windows-1251 encoding]
             ...
   
 3.I have heard about $mail:receive experimental support, how do I use it?  3.I have heard about $mail:receive experimental support, how do I use it?
   You need two more libraries  
       glib >= 1.2.10    Just start ./buildall --with-mailreceive.
       gmime >= 1.0.1 [http://spruce.sourceforge.net/gmime/sources/v1.0/gmime-1.0.8.tar.gz]    If you have glib and gmime installed, you can run ./configure --with-mailreceive.
     on your system, and specify path to them to Parser3 configure script.  
   4.Security issues
     glib:    You can disable any exec operations by setting --disable-execs option.
   
     cd $HOME/parser3project/src  
     #on freebsd5 this is reported to work: ftp://ftp.gtk.org/pub/gtk/v1.1/glib-1.1.16.tar.gz  
     wget --passive-ftp ftp://ftp.gtk.org/pub/gtk/v1.2/glib-1.2.10.tar.gz  
     gunzip -c glib-1.2.10.tar.gz | tar vxf -  
     cd glib-1.2.10  
     ./configure --prefix=$HOME/parser3project/gnome --silent  
     make install  
   
     gmime:  
   
     cd gmime-x.x.x  
     ./configure --prefix=$HOME/parser3project/gnome  
     make install  
   
     You need to change buildall script to add this to parser3 configure line:  
         --with-static-mailreceive=$HOME/parser3project/gnome  
   
     NOTE:  
     In case your glib as installed into some other prefix,  
     specify it's configuration file with  
         --with-glib-config=/path/to/your/glib-config  
     NOTE:  
     In case you are using SHARED mime library, you may want to link in direct path to it,  
     use this key to specify which linker key to use do do that:  
         --with-pathlink=LKEY    put dynamic libraries paths to binary  
                                 using linker key (-R, -rpath-link)  
   
 4.  
   
   In case you're not root on machine you're installing Parser,  
   we recommend you to do:  
   ./configure --prefix=$HOME/parser3install  
   and afterwards copy $HOME/parser3install/bin/parser3 to your CGI directory  
   or make a symlink [if your web server configured to follow symlinks].  
   
   You can disable any exec operations by setting  
   --disable-execs  
   option to configure.  
   file::exec, file::cgi and mail:send (unix version) methods would be disabled.    file::exec, file::cgi and mail:send (unix version) methods would be disabled.
   
   You can enable reading and executing files, not belonging to group+user     You can enable reading and executing files, not belonging to group+user 
   other then effective by setting    other then effective by setting --disable-safe-mode option.
   --disable-safe-mode  
   option to configure.  
     
   You can disable user-configured sendmail commands by forcing it, setting    You can disable user-configured sendmail commands by forcing it, setting
   --with=sendmail="COMMAND"    "--with=sendmail=COMMAND" option.
   option to configure, for example:  
   --with-sendmail="/usr/sbin/sendmail -i -t -f postmaster"  5.Since Parser 3.4.0 the several optimisations were implemented.
     If you experience problems you can try to disable them by commenting corresponding 
   In case you are experiencing problem with gcc runtime exception handling,    defines and recompiling parser3.
   try to configure with  
   --with-sjlj-exceptions    src/include/pa_opcode.h
   option.        #define OPTIMIZE_BYTECODE_GET_CLASS               -- $a:
       #define OPTIMIZE_BYTECODE_GET_ELEMENT             -- $a ^a
   By default libstdc++ is linked statically, you can re-enable dynamic libstdc++ linkage by specifying      #define OPTIMIZE_BYTECODE_GET_OBJECT_ELEMENT      -- $a.b ^a.b
   --with-dynamic-stdcpp      #define OPTIMIZE_BYTECODE_GET_OBJECT_VAR_ELEMENT  -- $a.$b ^a.$b
   option to configure.        #define OPTIMIZE_BYTECODE_GET_SELF_ELEMENT        -- $self.a ^self.a
       #define OPTIMIZE_BYTECODE_CONSTRUCT               -- $a(expr),  $a[value]
                                                            $.a(expr), $.a[value]
   Some root config options can be specified at configure time, and would override autodetects.                                                           $self.a(expr), $self.a[value]
       #define OPTIMIZE_BYTECODE_CUT_REM_OPERATOR        -- cut rem operator with any number of params during compilation
   List of enabled charsets:      #define OPTIMIZE_BYTECODE_STRING_POOL             -- simplifying string's bytecode into expression
   --with-charsets=CHARSET[,CHARSET,...]  Enables charsets in root config (windows-1251,  
                           windows-1250 windows-1257 koi8-r; Default is windows-1251)    src/include/pa_string.h
   SQL clients:      #define HASH_CODE_CACHING  -- calculated hash codes are cached and used for sequential hash lookups
   --with-mysql-client=mysqlclientlib?params  
   --with-pgsql-client=pgsqlclientlib?params    src/include/pa_memory.h
   --with-oracle-client=oracleclientlib?params      #define USE_DESTRUCTORS    -- destructors are used to decrease memory consumption during code
                                       processing and make ^memory:compact[] calls non-essential.
 5.  
   If you need to build apache 1.3 parser module, get source distribution of apache 1.3,    src/types/pa_method.h
   run configure there, then run parser configure with one more option:      #define OPTIMIZE_CALL      -- allows faster operators execution by eliminating method frame
   --with-apache13=Apache13 source distribution directory                                    with local variables creation and extra write context switches.
   after 'make' go to that directory and run      #define OPTIMIZE_RESULT    -- parser methods are marked when the $result variable was used.
                                     This allows write operations and context switching optimization.
   ./p3runConfigure <any additional options to apache configure to pass>  
       src/types/pa_wwrapper.h
   example:      #define OPTIMIZE_SINGLE_STRING_WRITE  -- reuse original VString in single string assignments.
   ./p3runConfigure --prefix=$HOME/apache13install --enable-module=rewrite  
     src/lib/cord/include/cord.h
       #define CORD_CAT_OPTIMIZATION -- CORD library never modifies source concatenations. But in parser
                                        write operations it is safe to modify them and save some memory.
       #define CORD_CHARS_CACHE      -- language cords with same language and length are cached and reused.
   
     src/include/pa_string.h
       #define STRING_LENGTH_CACHING -- cache String::Body.length() for char* strings
   
   WARNING: if you want to use apache configure option --enable-shared=max, do this:    src/include/pa_hash.h
   ./p3runConfigure --enable-shared=max --disable-shared=mod_parser3.c      #define HASH_ORDER            -- hash keys are iterated in the order of insertion

Removed from v.1.48.2.1  
changed lines
  Added in v.1.57


E-mail: