Diff for /parser3/INSTALL between versions 1.5 and 1.58

version 1.5, 2002/02/13 13:04:33 version 1.58, 2024/11/04 04:37:43
Line 1 Line 1
 0.Assuming your perform your builds in $D directory   $Id$
   and suggested subdirectories.  
   
 1.What is the process to compile Parser3?   
   
   As most UNIX programs Parser3 follows the "standard":  1. What is the process to compile Parser3?
   
   mkdir $D/parser3project    Just start ./buildall script and you would get $HOME/parser3install/bin/parser3 binary.
   cd $D/parser3project  
   gunzip -c parser3-x.x.tar.gz | tar xvf -  
   mv parser3-x.x parser3  
   cd parser3  
   ./configure --prefix=/usr/local  
   make  
     
   That renaming is needed for SQL drivers to be able to find   
   necessary include-file in Parser3 sources.  
   
   By default your would get 'parser3' binary without support of these features:  
         * cache(hashfile class)   
         * xml(xdoc and xnode classes)  
   
 2.What is the process to install Parser3?  
   
   make install  
   
   Installation layout:  
     $prefix/bin/  
       parser3             -- CGI and command line Parser3 interpreter  
     $prefix/etc/  
       parser3.conf        -- main configuration file  
       parser3.charsets/   -- charset definition files  
         koi8-r.cfg        -- cyrillic charset [KOI8-R encoding]  
         windows-1250.cfg  -- central europian charset [windows-1250 encoding]  
         windows-1251.cfg  -- cyrillic charset [windows-1251 encoding]  
         windows-1257.cfg  -- baltic charset [windows-1257 encoding]  
   
   NOTE:    NOTE:
     For subsequent compilations+installs     In case you do not need XML support, use ./buildall --without-xml
     to prevent configuration files to be overwritten use  
     
     make install-exec  
       
     it will update parser3 binary only.  
   
 2.What other libraries are needed to compile/install libxml ?   
   
   * You can compile and use parser without any additional libraries.  
     That would be 'basic' version of it.  
   
   
   * In case you wish cache(hashfile class) support you need library  
       libdb 2.x.x >= 2.7.7  
     on your system, and specify it to Parser3 configure script.  
   
     Installation sequence of this library to $D/BerkeleyDB:  
       cd db-2.x.x  
       cd build_unix  
       ../dist/configure --prefix=$D  
       make install  
   
   
     Parser3 configure option is --with-db2=$D/BerkeleyDB  
   
   
   * In case you wish xml(xdoc and xnode classes) support you need libraries  
       libxml2 >= 2.3.6  
       libxslt >= 1.0.9  
       glib >= 1.2.10  
       gdome2 >= 0.7.0  
     on your system, and specify path to them to Parser3 configure script.  
   
     Sources of these two libraries must be patched prior to compile:     NOTE:
       * libxml2    In case you need apache parser module (DSO), use ./buildall --with-apache
       * libxslt  
   
     Installation sequence of these libraries to $D/gnome:  
   
     libxml2:   
   
     cd libxml2-x.x.x  
     patch -p0 < $D/parser3project/parser3/src/patches/libxml_error_column_tab.patch  
     patch -p0 < $D/parser3project/parser3/src/patches/libxml_htmloutput_of_xslemptyattr_emptyquotes.patch  
     patch -p0 < $D/parser3project/parser3/src/patches/libxml_transcoder_context1.patch  
     patch -p0 < $D/parser3project/parser3/src/patches/libxml_transcoder_context2.patch  
     patch -p0 < $D/parser3project/parser3/src/patches/libxml_transcoder_context3.patch  
     patch -p0 < $D/parser3project/parser3/src/patches/libxml_transcoder_context4.patch  
     ./configure --prefix=$D/gnome  
     make install  
   
     libxslt:  
   
     cd libxslt-x.x.x  
     patch -p0 < $D/parser3project/parser3/src/patches/libxslt_html_output_no_charset_meta.patch  
     ./configure --with-libxml-prefix=$D/gnome --prefix=$D/gnome --without-debug --without-debugger  
     make install  
   
     glib: [ftp://ftp.gtk.org/pub/gtk/v1.2/glib-1.2.10.tar.gz]  
   
     cd glib-x.x.x    NOTE:
     ./configure --prefix=$D/gnome     If you have gc, prce, libxml and libxslt installed, you can use ./configure --with-xml
     make install  
   
     gdome2:    NOTE:
     In case you later would experience problems with gcc runtime exception handling 
     (most notable when reporting sql-related problems), pass this to buildall script:
     --with-sjlj-exceptions (HPUX is reported to have such problems)
   
     ./configure --with-glib-prefix=$D/gnome --disable-glibtest --with-libxml-prefix=$D/gnome --prefix=$D/gnome    NOTE:
     make install    On some systems there are no "make" and you should run 'gmake', change buildall script accordingly then.
   
     And patch+copy these additional headers into install includes directory  2. What is the process to install Parser3?
   
         patch -p0 < $D/parser3project/parser3/src/patches/libgdome_cpp_syntax1.patch    Copy files from $HOME/parser3install directory into your cgi-bin directory.
         patch -p0 < $D/parser3project/parser3/src/patches/libgdome_cpp_syntax2.patch  
     mkdir $D/gnome/include/libgdome/gdomecore  
     cp libgdome/gdomecore/gdome-xml-node.h $D/gnome/include/libgdome/gdomecore  
     cp libgdome/gdomecore/gdome-xml-document.h $D/gnome/include/libgdome/gdomecore  
       
   
     Parser3 configure option:    Then install Parser3 to handle documents, step-by-step instructions:
         --with-gnome-xml=$D/gnome      http://www.parser.ru/en/docs/lang/install4apachecgi.htm" in English
       http://www.parser.ru/docs/lang/install4apachecgi.htm" in Russian
   
     Directory layout:
       bin/
         parser3               -- CGI and command line Parser3 interpreter
         auto.p.dist           -- configuration file sample,
                                  copy it to auto.p and adjust to your needs
       share/
         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?
   
     Just start ./buildall --with-mailreceive.
     If you have glib and gmime installed, you can run ./configure --with-mailreceive.
   
   4. Safety features
     You can disable any exec operations by setting --disable-execs option.
     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 
     other than effective by setting --disable-safe-mode option.
   
     You can disable user-configured sendmail commands by forcing it, setting
     "--with=sendmail=COMMAND" option.
   
   5. Since Parser 3.4.0 several optimizations were implemented.
     If you experience problems you can try to disable them by commenting corresponding
     defines and recompiling parser3.
   
     src/include/pa_opcode.h
       #define OPTIMIZE_BYTECODE_GET_CLASS               -- $a:
       #define OPTIMIZE_BYTECODE_GET_ELEMENT             -- $a ^a
       #define OPTIMIZE_BYTECODE_GET_OBJECT_ELEMENT      -- $a.b ^a.b
       #define OPTIMIZE_BYTECODE_GET_OBJECT_VAR_ELEMENT  -- $a.$b ^a.$b
       #define OPTIMIZE_BYTECODE_GET_SELF_ELEMENT        -- $self.a ^self.a
       #define OPTIMIZE_BYTECODE_CONSTRUCT               -- $a(expr),  $a[value]
                                                            $.a(expr), $.a[value]
                                                            $self.a(expr), $self.a[value]
       #define OPTIMIZE_BYTECODE_CUT_REM_OPERATOR        -- cut rem operator with any number of params during compilation
       #define OPTIMIZE_BYTECODE_STRING_POOL             -- simplifying string's bytecode into expression
       #define OPTIMIZE_BYTECODE_GET_SELF_ELEMENT        -- bytecode for $self.a ^self.a
       #define OPTIMIZE_BYTECODE_GET_ELEMENT__SPECIAL    -- bytecode for .CLASS, .CLASS_NAME
       #define FEATURE_GET_ELEMENT4CALL                  -- ^o.m[] calls get_element4call("m"), not get_element("m")
   
     src/include/pa_string.h
       #define HASH_CODE_CACHING  -- calculated hash codes are cached and used for sequential hash lookups
   
     src/include/pa_memory.h
       #define USE_DESTRUCTORS    -- destructors are used to decrease memory consumption during code
                                     processing and make ^memory:compact[] calls non-essential.
   
     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.
   
     NOTE:    src/include/pa_string.h
     In case your glib as installed into some other prefix,      #define STRING_LENGTH_CACHING -- cache String::Body.length() for char* strings
     specify it's configuration file with  
         --with-glib-config=/path/to/your/glib-config  
    
 Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)  
   
 $Id$    src/include/pa_hash.h
       #define HASH_ORDER            -- hash keys are iterated in the order of insertion

Removed from v.1.5  
changed lines
  Added in v.1.58


E-mail: