rroonga 2.0.4-x86-mingw32 → 2.0.7-x86-mingw32

data/vendor/local/share/doc/groonga/ja/html/_sources/install/others.txt

@@ -0,0 +1,267 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Others
+======
+
+This section describes how to install groonga from source on UNIX like
+environment.
+
+To get more detail about installing groonga from source on the
+specific environment, find the document for the specific environment
+from :doc:`/install`.
+
+Dependencies
+------------
+
+Groonga doesn't require any special libraries but requires some tools
+for build.
+
+Tools
+^^^^^
+
+Here are required tools:
+
+  * ``wget``, ``curl`` or Web browser for downloading source archive
+  * ``tar`` and ``gzip`` for extracting source archive
+  * shell
+    (many shells such as ``dash``, ``bash`` and ``zsh`` will work)
+  * C compiler and C++ compiler
+    (``gcc`` and ``g++`` are supported but other compilers may work)
+  * ``make`` (GNU make is supported but other make like BSD make will work)
+
+You must get them ready.
+
+You can use `CMake <http://www.cmake.org/>`_ instead of shell but this
+document doesn't describe about building with CMake.
+
+Here are optional tools:
+
+  * `pkg-config
+    <http://www.freedesktop.org/wiki/Software/pkg-config>`_ for
+    detecting libraries
+  * `sudo <http://www.gratisoft.us/sudo/>`_ for installing built
+    groonga
+
+You must get them ready if you want to use optional libraries.
+
+Libraries
+^^^^^^^^^
+
+All libraries are optional. Here are optional libraries:
+
+  * `MeCab <http://mecab.sourceforge.net/>`_ for tokenizing full-text
+    search target document by morphological analysis
+  * `KyTea <http://www.phontron.com/kytea/>`_ for tokenizing full-text
+    search target document by morphological analysis
+  * `ZeroMQ <http://www.zeromq.org/>`_ for :doc:`/suggest`
+  * `libevent <http://libevent.org/>`_ for :doc:`/suggest`
+  * `MessagePack <http://msgpack.org/>`_ for supporting MessagePack
+    output and :doc:`/suggest`
+  * `libedit <http://www.thrysoee.dk/editline/>`_ for command line
+    editing in :doc:`/reference/executables/groonga`
+  * `zlib <http://zlib.net/>`_ for compressing column value
+  * `LZO <http://www.oberhumer.com/opensource/lzo/>`_ for compressing
+    column value
+
+If you want to use those all or some libraries, you need to install
+them before installing groonga.
+
+Build from source
+-----------------
+
+Groonga uses GNU build system. So the following is the simplest build
+steps::
+
+  % wget http://packages.groonga.org/source/groonga/groonga-2.0.7.tar.gz
+  % tar xvzf groonga-2.0.7.tar.gz
+  % cd groonga-2.0.7
+  % ./configure
+  % make
+  % sudo make install
+
+After the above steps, :doc:`/reference/executables/groonga` is found in
+``/usr/local/bin/groonga``.
+
+The default build will work well but you can customize groonga at
+``configure`` step.
+
+The following describes details about each step.
+
+.. _source-configure:
+
+``configure``
+^^^^^^^^^^^^^
+
+First, you need to run ``configure``. Here are important ``configure``
+options:
+
+``--prefix=PATH``
++++++++++++++++++
+
+Specifies the install base directory. Groonga related files are
+installed under ``${PATH}/`` directory.
+
+The default is ``/usr/local``. In this case, :doc:`/reference/executables/groonga` is
+installed into ``/usr/local/bin/groonga``.
+
+Here is an example that installs groonga into ``~/local`` for an user
+use instead of system wide use::
+
+  % ./configure --prefix=$HOME/local
+
+``--localstatedir=PATH``
+++++++++++++++++++++++++
+
+Specifies the base directory to place modifiable file such as log
+file, PID file and database files. For example, log file is placed at
+``${PATH}/log/groonga.log``.
+
+The default is ``/usr/local/var``.
+
+Here is an example that system wide ``/var`` is used for modifiable
+files::
+
+  % ./configure --localstatedir=/var
+
+``--with-log-path=PATH``
+++++++++++++++++++++++++
+
+Specifies the default log file path. You can override the default log
+path is :doc:`/reference/executables/groonga` command's ``--log-path``
+command line option. So this option is not critical build option. It's
+just for convenient.
+
+The default is ``/usr/local/var/log/groonga.log``. The
+``/usr/local/var`` part is changed by ``--localestatedir`` option.
+
+Here is an example that log file is placed into shared NFS directory
+``/nfs/log/groonga.log``::
+
+  % ./configure --with-log-path=/nfs/log/groonga.log
+
+``--with-default-encoding=ENCODING``
+++++++++++++++++++++++++++++++++++++
+
+Specifies the default encoding. Available encodings are ``euc_jp``,
+``sjis``, ``utf8``, ``latin1``, ``koi8r`` and ``none``.
+
+The default is ``utf-8``.
+
+Here is an example that Shift_JIS is used as the default encoding::
+
+  % ./configure --with-default-encoding=sjis
+
+``--with-match-escalation-threshold=NUMBER``
+++++++++++++++++++++++++++++++++++++++++++++
+
+Specifies the default match escalation threshold. See
+:ref:`match-escalation-threshold` about match
+escalation threshold. -1 means that match operation never escalate.
+
+The default is 0.
+
+Here is an example that match escalation isn't used by default::
+
+  % ./configure --with-match-escalation-threshold=-1
+
+``--with-zlib``
++++++++++++++++
+
+Enables column value compression by zlib.
+
+The default is disabled.
+
+Here is an example that enables column value compression by zlib::
+
+  % ./configure --with-zlib
+
+``--with-lzo``
+++++++++++++++
+
+Enables column value compression by LZO.
+
+The default is disabled.
+
+Here is an example that enables column value compression by LZO::
+
+  % ./configure --with-lzo
+
+``--with-message-pack=MESSAGE_PACK_INSTALL_PREFIX``
++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Specifies where MessagePack is installed. If MessagePack isn't
+installed with ``--prefix=/usr``, you need to specify this option with
+path that you use for building MessagePack.
+
+If you installed MessagePack with ``--prefix=$HOME/local`` option, you
+sholud specify ``--with-message-pack=$HOME/local`` to groonga's
+``configure``.
+
+The default is ``/usr``.
+
+Here is an example that uses MessagePack built with
+``--prefix=$HOME/local`` option::
+
+  % ./configure --with-message-pack=$HOME/local
+
+``--with-munin-plugins``
+++++++++++++++++++++++++
+
+Installs Munin plugins for groonga. They are installed into
+``${PREFIX}/share/groonga/munin/plugins/``.
+
+Those plugins are not installed by default.
+
+Here is an example that installs Munin plugins for groonga::
+
+  % ./configure --with-munin-plugins
+
+``--with-package-platform=PLATFORM``
+++++++++++++++++++++++++++++++++++++
+
+Installs platform specific system management files such as init
+script. Available platforms are ``redhat`` and ``fedora``. ``redhat``
+is for Red Hat and Red Hat clone distributions such as
+CentOS. ``fedora`` is for Fedora.
+
+Those system management files are not installed by default.
+
+Here is an example that installs CentOS specific system management
+files::
+
+  % ./configure --with-package-platform=redhat
+
+``--help``
+++++++++++
+
+Shows all ``configure`` options.
+
+``make``
+^^^^^^^^
+
+``configure`` is succeeded, you can build groonga by ``make``::
+
+  % make
+
+If you have multi cores CPU, you can make faster by using ``-j``
+option. If you have 4 cores CPU, it's good for using ``-j4`` option::
+
+  % make -j4
+
+If you get some errors by ``make``, please report them to us:
+:doc:`/contribution/report`
+
+``make install``
+^^^^^^^^^^^^^^^^
+
+Now, you can install built groonga!::
+
+  % sudo make install
+
+If you have write permission for ``${PREFIX}``, you don't need to use
+``sudo``. e.g. ``--prefix=$HOME/local`` case. In this case, use ``make
+install``::
+
+  % make install

data/vendor/local/share/doc/groonga/ja/html/_sources/install/solaris.txt

@@ -0,0 +1,43 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Oracle Solaris
+==============
+
+This section describes how to install groonga from source on Oracle
+Solaris.
+
+Oracle Solaris 11
+-----------------
+
+Install required packages to build groonga::
+
+  % sudo pkg install gnu-tar gcc-45 system/header
+
+Download source::
+
+  % wget http://packages.groonga.org/source/groonga/groonga-2.0.7.tar.gz
+  % gtar xvzf groonga-2.0.7.tar.gz
+  % cd groonga-2.0.7
+
+Configure with ``CFLAGS="-m64" CXXFLAGS="-m64"`` variables. They are
+needed for building 64-bit version. To build 32-bit version, just
+remove those variables. (see :ref:`source-configure` about ``configure``
+options)::
+
+  % ./configure CFLAGS="-m64" CXXFLAGS="-m64"
+
+Build::
+
+  % make
+
+..
+   Build with multi processes. ( ``% sudo pkg install gnu-make`` is
+   required)::
+
+      % gmake -j$(psrinfo -p)
+
+Install::
+
+  % sudo make install

data/vendor/local/share/doc/groonga/ja/html/_sources/install/ubuntu.txt

@@ -0,0 +1,196 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Ubuntu
+======
+
+This section describes how to install groonga related deb packages on
+Ubuntu. You can install them by ``apt``.
+
+We distribute both 32-bit and 64-bit packages but we strongly
+recommend a 64-bit package for server. You should use a 32-bit package
+just only for tests or development. You will encounter an out of
+memory error with a 32-bit package even if you just process medium
+size data.
+
+10.04 LTS Lucid Lynx
+--------------------
+
+.. note::
+
+   Enable the universe repository to install groonga::
+
+     % sudo cp /etc/apt/sources.list /etc/apt/sources.list.d/universe.list
+     % sudo sed -i'' -e 's/main/universe/' /etc/apt/sources.list.d/universe.list
+
+Add the groonga apt repository.
+
+/etc/apt/sources.list.d/groonga.list::
+
+  deb http://packages.groonga.org/ubuntu/ lucid universe
+  deb-src http://packages.groonga.org/ubuntu/ lucid universe
+
+Install::
+
+  % sudo apt-get update
+  % sudo apt-get -y --allow-unauthenticated install groonga-keyring
+  % sudo apt-get update
+  % sudo apt-get -y install groonga
+
+If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a
+tokenizer, install groonga-tokenizer-mecab package.
+
+Install groonga-tokenizer-mecab package::
+
+  % sudo apt-get -y install groonga-tokenizer-mecab
+
+There is a package that provides `Munin
+<http://munin-monitoring.org/>`_ plugins. If you want to monitor
+groonga status by Munin, install groonga-munin-plugins package.
+
+Install groonga-munin-plugins package::
+
+  % sudo apt-get -y install groonga-munin-plugins
+
+11.04 Natty Narwhal
+-------------------
+
+.. note::
+
+   Enable the universe repository to install groonga::
+
+     % sudo cp /etc/apt/sources.list /etc/apt/sources.list.d/universe.list
+     % sudo sed -i'' -e 's/main/universe/' /etc/apt/sources.list.d/universe.list
+
+Add the groonga apt repository.
+
+/etc/apt/sources.list.d/groonga.list::
+
+  deb http://packages.groonga.org/ubuntu/ natty universe
+  deb-src http://packages.groonga.org/ubuntu/ natty universe
+
+Install::
+
+  % sudo apt-get update
+  % sudo apt-get -y --allow-unauthenticated install groonga-keyring
+  % sudo apt-get update
+  % sudo apt-get -y install groonga
+
+If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a
+tokenizer, install groonga-tokenizer-mecab package.
+
+Install groonga-tokenizer-mecab package::
+
+  % sudo apt-get -y install groonga-tokenizer-mecab
+
+There is a package that provides `Munin
+<http://munin-monitoring.org/>`_ plugins. If you want to monitor
+groonga status by Munin, install groonga-munin-plugins package.
+
+Install groonga-munin-plugins package::
+
+  % sudo apt-get -y install groonga-munin-plugins
+
+11.10 Oneiric Ocelot
+--------------------
+
+.. note::
+
+   Enable the universe repository to install groonga::
+
+     % sudo cp /etc/apt/sources.list /etc/apt/sources.list.d/universe.list
+     % sudo sed -i'' -e 's/main/universe/' /etc/apt/sources.list.d/universe.list
+
+Add the groonga apt repository.
+
+/etc/apt/sources.list.d/groonga.list::
+
+  deb http://packages.groonga.org/ubuntu/ oneiric universe
+  deb-src http://packages.groonga.org/ubuntu/ oneiric universe
+
+Install::
+
+  % sudo apt-get update
+  % sudo apt-get -y --allow-unauthenticated install groonga-keyring
+  % sudo apt-get update
+  % sudo apt-get -y install groonga
+
+If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a
+tokenizer, install groonga-tokenizer-mecab package.
+
+Install groonga-tokenizer-mecab package::
+
+  % sudo apt-get -y install groonga-tokenizer-mecab
+
+There is a package that provides `Munin
+<http://munin-monitoring.org/>`_ plugins. If you want to monitor
+groonga status by Munin, install groonga-munin-plugins package.
+
+Install groonga-munin-plugins package::
+
+  % sudo apt-get -y install groonga-munin-plugins
+
+12.04 LTS Precise Pangolin
+--------------------------
+
+.. note::
+
+   Enable the universe repository to install groonga::
+
+     % sudo cp /etc/apt/sources.list /etc/apt/sources.list.d/universe.list
+     % sudo sed -i'' -e 's/main/universe/' /etc/apt/sources.list.d/universe.list
+
+Add the groonga apt repository.
+
+/etc/apt/sources.list.d/groonga.list::
+
+  deb http://packages.groonga.org/ubuntu/ precise universe
+  deb-src http://packages.groonga.org/ubuntu/ precise universe
+
+Install::
+
+  % sudo apt-get update
+  % sudo apt-get -y --allow-unauthenticated install groonga-keyring
+  % sudo apt-get update
+  % sudo apt-get -y install groonga
+
+If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a
+tokenizer, install groonga-tokenizer-mecab package.
+
+Install groonga-tokenizer-mecab package::
+
+  % sudo apt-get -y install groonga-tokenizer-mecab
+
+There is a package that provides `Munin
+<http://munin-monitoring.org/>`_ plugins. If you want to monitor
+groonga status by Munin, install groonga-munin-plugins package.
+
+Install groonga-munin-plugins package::
+
+  % sudo apt-get -y install groonga-munin-plugins
+
+Build from source
+-----------------
+
+Install required packages to build groonga::
+
+  % sudo apt-get -V -y install wget tar build-essential zlib1g-dev liblzo2-dev libmsgpack-dev libzmq-dev libevent-dev libmecab-dev
+
+Download source::
+
+  % wget http://packages.groonga.org/source/groonga/groonga-2.0.7.tar.gz
+  % tar xvzf groonga-2.0.7.tar.gz
+  % cd groonga-2.0.7
+
+Configure (see :ref:`source-configure` about ``configure`` options)::
+
+  % ./configure
+
+Build::
+
+  % make -j$(grep '^processor' /proc/cpuinfo | wc -l)
+
+Install::
+
+  % sudo make intall

data/vendor/local/share/doc/groonga/ja/html/_sources/install/windows.txt

@@ -0,0 +1,77 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Windows
+=======
+
+This section describes how to install groonga on Windows. You can
+install groogna by extracting a zip package or running an installer.
+
+We distribute both 32-bit and 64-bit packages but we strongly
+recommend a 64-bit package for server. You should use a 32-bit package
+just only for tests or development. You will encounter an out of
+memory error with a 32-bit package even if you just process medium
+size data.
+
+Installer
+---------
+
+For 32-bit environment, download `groonga-2.0.7-x86.exe
+<http://packages.groonga.org/windows/groonga/groonga-2.0.7-x86.exe>`_
+and run it.
+
+For 64-bit environment, download `groonga-2.0.7-x64.exe
+<http://packages.groonga.org/windows/groonga/groonga-2.0.7-x64.exe>`_
+and run it.
+
+Use command prompt for :doc:`/reference/executables/groonga` installed in start menu.
+
+zip
+---
+
+For 32-bit environment, download `groonga-2.0.7-x86.zip
+<http://packages.groonga.org/windows/groonga/groonga-2.0.7-x86.zip>`_
+and extract it.
+
+For 64-bit environment, download `groonga-2.0.7-x64.zip
+<http://packages.groonga.org/windows/groonga/groonga-2.0.7-x64.zip>`_
+and extract it.
+
+:doc:`/reference/executables/groonga` is in ``bin`` folder.
+
+Build from source
+-----------------
+
+First, you need to install required tools for building groonga on
+Windows. Here are required tools:
+
+  * `Microsoft Visual Studio 2010 Express
+    <http://www.microsoft.com/japan/msdn/vstudio/express/>`_
+  * `CMake <http://www.cmake.org/>`_
+
+Download zipped source `groonga-2.0.7.zip
+<http://packages.groonga.org/source/groonga/groonga-2.0.7.zip>`_
+and extract it.
+
+Start ``Visual Studio Command Prompt (2010)`` installed by Microsoft
+Visual Studio 2010 Express and move to the groonga's source folder::
+
+  > cd c:\Users\%USERNAME%\Downloads\groonga-2.0.7
+
+Configure by ``cmake``. The following commnad line is for 64-bit
+version. To build 32-bit version, use ``-G "Visual Studio 10"``
+parameter instead::
+
+  groonga-2.0.7> cmake . -G "Visual Studio 10 Win64" -DCMAKE_INSTALL_PREFIX=C:\groonga
+
+Build by Visual Studio::
+
+  groonga-2.0.7> devenv groonga.sln /Build Release
+
+Install::
+
+  groonga-2.0.7> devenv groonga.sln /Build Release /Project Install
+
+After the above steps, :doc:`/reference/executables/groonga` is found in
+``c:\groonga\bin\groonga.exe``.