--- parser3/INSTALL 2002/04/29 11:48:12 1.19 +++ parser3/INSTALL 2009/07/29 04:59:15 1.53 @@ -1,155 +1,107 @@ -0.Assuming your perform your builds in $D directory - and suggested subdirectories. +Alexander Petrosian (http://paf.design.ru) +$Id: INSTALL,v 1.53 2009/07/29 04:59:15 misha Exp $ -1.What is the process to compile Parser3? +1.What is the process to compile Parser3? - As most UNIX programs Parser3 follows the "standard": + Just start ./buildall-with-xml script and you would get $HOME/parser3install/bin/parser3 binary. - mkdir $D/parser3project - 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. NOTE: - On some system you should run 'gmake'. + In case you do not need XML support, use ./buildall-without-xml NOTE: - By default your would get 'parser3' binary without support of these features: - * xml(xdoc and xnode classes) - Read section (3) on getting xml-abled parser. + On some platforms there is special version of libgc patched to support some + 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: + In case you later would experience problems with gcc runtime exception handling + (most notable when reporting sql-related problems), + add this to configure line in buildall script: + --with-sjlj-exceptions + (HPUX is reported to have such problems) - Read section (4) on configure options. + NOTE: + 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? - make install + Copy files from $HOME/parser3install directory into your cgi-bin directory. + + Then install Parser3 as a handler of documents, step-by-step instrunctions: + http://www.parser.ru/en/docs/lang/install4apachecgi.htm" in English + http://www.parser.ru/docs/lang/install4apachecgi.htm" in Russian - Installation layout: - $prefix/bin/ + Directory layout: + bin/ parser3 -- CGI and command line Parser3 interpreter - $prefix/etc/ - parser3.conf -- main configuration file + auto.p.dist -- configuration file sample, + copy it to auto.p and adjust to your needs + etc/ 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: - For subsequent compilations+installs - to prevent configuration files to be overwritten use - - make install-exec - - it will update parser3 binary only. - -3.What other libraries are needed to compile/install parser? - - * You can compile and use parser without any additional libraries. - That would be 'basic' version of it. - - - * In case you wish xml(xdoc and xnode classes) support you need libraries - libxml2 >= 2.4.11 - libxslt >= 1.0.9 +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 - gdome2 >= 0.7.0 + gmime >= 1.0.1 [http://spruce.sourceforge.net/gmime/sources/v1.0/gmime-1.0.8.tar.gz] on your system, and specify path to them to Parser3 configure script. - Sources of these two libraries must be patched prior to compile: - * libxml2 - * libxslt - - Installation sequence of these libraries to $D/gnome: - - libxml2: [ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/libxml2-2.4.12.tar.gz] - - 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 --without-zlib - make install - - libxslt: [ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxslt/libxslt-1.0.9.tar.gz] + glib: - 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 + 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 - glib: [ftp://ftp.gtk.org/pub/gtk/v1.2/glib-1.2.10.tar.gz] + gmime: - cd glib-x.x.x - ./configure --prefix=$D/gnome + cd gmime-x.x.x + ./configure --prefix=$HOME/parser3project/gnome make install - gdome2: [http://phd.cs.unibo.it/gdome2/tarball/gdome2-0.7.0.tar.gz] - - cd gdome2-x.x.x - patch -p0 < $D/parser3project/parser3/src/patches/libgdome_cpp_syntax1.patch - patch -p0 < $D/parser3project/parser3/src/patches/libgdome_cpp_syntax2.patch - patch -p0 < $D/parser3project/parser3/src/patches/libgdome_morestatic.patch - ./configure --with-glib-prefix=$D/gnome --disable-glibtest --with-libxml-prefix=$D/gnome --prefix=$D/gnome - make install - - And copy these additional headers into install includes directory - - 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 options, choose whether you need static or dynamic linkage with xml libs: - --with-static-xml=$D/gnome - --with-shared-xml=$D/gnome + 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 xml libraries, you may want to link in direct path to them, + 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=/your/home/parser3install - and afterwards copy parser3install/bin/parser3 to your CGI directory - or make a symlink [if your web server configured to follow symlinks]. - - You can disable libstdc++ linkage by setting - --disable-link-libstdcpp - option to configure. - +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. - You can disable reading and executing files, belonging to group - other then current by setting - --disable-foreign-group-files + You can enable reading and executing files, not belonging to group+user + other then effective by setting + --disable-safe-mode option to configure. You can disable user-configured sendmail commands by forcing it, setting "--with=sendmail=COMMAND" - option to configure. - + option to configure, for example: + "--with-sendmail=/usr/sbin/sendmail -i -t -f postmaster" + + By default libstdc++ is linked statically, you can re-enable dynamic libstdc++ linkage by specifying + --with-dynamic-stdcpp + option to configure. + Some root config options can be specified at configure time, and would override autodetects. @@ -157,11 +109,65 @@ --with-charsets=CHARSET[,CHARSET,...] Enables charsets in root config (windows-1251, windows-1250 windows-1257 koi8-r; Default is windows-1251) SQL clients: - --with-mysql-client=mysqlclientlib?withparams - --with-pgsql-client=pgsqlclientlib?withparams - --with-oracle-client=oracleclientlib?withparams + --with-mysql-client=mysqlclientlib?params + --with-pgsql-client=pgsqlclientlib?params + --with-oracle-client=oracleclientlib?params + +5. + 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: + --with-apache13=Apache13 source distribution directory + after 'make' go to that directory and run + + ./p3runConfigure - -Alexandr Petrosian (http://paf.design.ru) + example: + ./p3runConfigure --prefix=$HOME/apache13install --enable-module=rewrite + + WARNING: if you want to use apache configure option --enable-shared=max, do this: + ./p3runConfigure --enable-shared=max --disable-shared=mod_parser3.c + +6. + Since Parser 3.4.0 the several optimisations 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_CONSTRUCT_OBJECT -- ^class::constructor + #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 + + 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. + + src/include/pa_string.h + #define STRING_LENGTH_CACHING -- cache String::Body.length() for char* strings + + src/include/pa_hash.h + #define HASH_ORDER -- hash keys are iterated in the order of insertion -$Id: INSTALL,v 1.19 2002/04/29 11:48:12 paf Exp $