Diff for /parser3/INSTALL between versions 1.49 and 1.58

version 1.49, 2005/12/29 13:06:58 version 1.58, 2024/11/04 04:37:43
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.
   
     NOTE:
     In case you do not need XML support, use ./buildall --without-xml
   
   NOTE:    NOTE:
   In case you do not need XML support, use ./buildall-without-xml    In case you need apache parser module (DSO), use ./buildall --with-apache
   
   NOTE:    NOTE:
   On some platforms there is special version of libgc patched to support some    If you have gc, prce, libxml and libxslt installed, you can use ./configure --with-xml
   local piece of subtlety.  
   Official libgc does not work there, use special version instead.  
   (OpenBSD reported to be one of those)  
   If you need that special version, please change buildall script accordingly.  
   
   NOTE:    NOTE:
   In case you later would experience problems with gcc runtime exception handling    In case you later would experience problems with gcc runtime exception handling 
   (most notable when reporting sql-related problems),    (most notable when reporting sql-related problems), pass this to buildall script:
   add this to configure line in buildall script:    --with-sjlj-exceptions (HPUX is reported to have such problems)
   --with-sjlj-exceptions  
   (HPUX is reported to have such problems)  
   
   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?
   
   Copy files from $HOME/parser3install directory into your cgi-bin directory.    Copy files from $HOME/parser3install directory into your cgi-bin directory.
   
   Then install Parser3 as a handler of documents, step-by-step instrunctions:    Then install Parser3 to handle documents, step-by-step instructions:
     http://www.parser.ru/en/docs/lang/install4apachecgi.htm" in English      http://www.parser.ru/en/docs/lang/install4apachecgi.htm" in English
     http://www.parser.ru/docs/lang/install4apachecgi.htm" in Russian      http://www.parser.ru/docs/lang/install4apachecgi.htm" in Russian
   
   Directory layout:    Directory layout:
     bin/      bin/
       parser3             -- CGI and command line Parser3 interpreter        parser3               -- CGI and command line Parser3 interpreter
       auto.p.dist         -- configuration file sample,         auto.p.dist           -- configuration file sample,
                              copy it to auto.p and adjust to your needs                                 copy it to auto.p and adjust to your needs
     etc/      share/
       parser3.charsets/   -- charset definition files        charsets/
         koi8-r.cfg        -- cyrillic charset [KOI8-R encoding]          parser3.charsets/   -- charset definition files
         windows-1250.cfg  -- central europian charset [windows-1250 encoding]            koi8-r.cfg        -- cyrillic charset [KOI8-R encoding]
         windows-1251.cfg  -- cyrillic charset [windows-1251 encoding]            windows-1251.cfg  -- cyrillic charset [windows-1251 encoding]
         windows-1257.cfg  -- baltic charset [windows-1257 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 to bulid these additional 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. Safety features
     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  
   
     Then you need to change buildall script to add this to parser3 configure line:  
         --with-static-mailreceive=$HOME/parser3project/gnome  
     And start that changed ./buildall.  
   
     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.Security issues  
   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 than 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 several optimizations were implemented.
     If you experience problems you can try to disable them by commenting corresponding
   By default libstdc++ is linked statically, you can re-enable dynamic libstdc++ linkage by specifying    defines and recompiling parser3.
   --with-dynamic-stdcpp  
   option to configure.      src/include/pa_opcode.h
       #define OPTIMIZE_BYTECODE_GET_CLASS               -- $a:
       #define OPTIMIZE_BYTECODE_GET_ELEMENT             -- $a ^a
   Some root config options can be specified at configure time, and would override autodetects.      #define OPTIMIZE_BYTECODE_GET_OBJECT_ELEMENT      -- $a.b ^a.b
       #define OPTIMIZE_BYTECODE_GET_OBJECT_VAR_ELEMENT  -- $a.$b ^a.$b
   List of enabled charsets:      #define OPTIMIZE_BYTECODE_GET_SELF_ELEMENT        -- $self.a ^self.a
   --with-charsets=CHARSET[,CHARSET,...]  Enables charsets in root config (windows-1251,      #define OPTIMIZE_BYTECODE_CONSTRUCT               -- $a(expr),  $a[value]
                           windows-1250 windows-1257 koi8-r; Default is windows-1251)                                                           $.a(expr), $.a[value]
   SQL clients:                                                           $self.a(expr), $self.a[value]
   --with-mysql-client=mysqlclientlib?params      #define OPTIMIZE_BYTECODE_CUT_REM_OPERATOR        -- cut rem operator with any number of params during compilation
   --with-pgsql-client=pgsqlclientlib?params      #define OPTIMIZE_BYTECODE_STRING_POOL             -- simplifying string's bytecode into expression
   --with-oracle-client=oracleclientlib?params      #define OPTIMIZE_BYTECODE_GET_SELF_ELEMENT        -- bytecode for $self.a ^self.a
         #define OPTIMIZE_BYTECODE_GET_ELEMENT__SPECIAL    -- bytecode for .CLASS, .CLASS_NAME
 5.      #define FEATURE_GET_ELEMENT4CALL                  -- ^o.m[] calls get_element4call("m"), not get_element("m")
   If you need to build apache 1.3 parser module, get source distribution of apache 1.3,  
   run configure there, then run parser configure with one more option:    src/include/pa_string.h
   --with-apache13=Apache13 source distribution directory      #define HASH_CODE_CACHING  -- calculated hash codes are cached and used for sequential hash lookups
   after 'make' go to that directory and run  
     src/include/pa_memory.h
   ./p3runConfigure <any additional options to apache configure to pass>      #define USE_DESTRUCTORS    -- destructors are used to decrease memory consumption during code
                                       processing and make ^memory:compact[] calls non-essential.
   example:  
   ./p3runConfigure --prefix=$HOME/apache13install --enable-module=rewrite    src/types/pa_method.h
       #define OPTIMIZE_CALL      -- allows faster operators execution by eliminating method frame
                                     with local variables creation and extra write context switches.
       #define OPTIMIZE_RESULT    -- parser methods are marked when the $result variable was used.
                                     This allows write operations and context switching optimization.
   
     src/types/pa_wwrapper.h
       #define OPTIMIZE_SINGLE_STRING_WRITE  -- reuse original VString in single string assignments.
   
     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.49  
changed lines
  Added in v.1.58


E-mail: