null+****@clear*****
null+****@clear*****
2012年 5月 18日 (金) 17:17:14 JST
Kouhei Sutou 2012-05-18 17:17:14 +0900 (Fri, 18 May 2012)
New Revision: 7cdc2286b87a9b036c3718b712ae44199913a644
Log:
doc install: add about building from source
Added files:
doc/source/install/centos.txt
doc/source/install/debian.txt
doc/source/install/fedora.txt
doc/source/install/mac_os_x.txt
doc/source/install/others.txt
doc/source/install/ubuntu.txt
doc/source/install/windows.txt
Modified files:
Makefile.am
doc/source/install.txt
Modified: Makefile.am (+2 -0)
===================================================================
--- Makefile.am 2012-05-18 17:15:02 +0900 (0dd7d76)
+++ Makefile.am 2012-05-18 17:17:14 +0900 (8f59f68)
@@ -78,6 +78,8 @@ update-latest-release:
packages/rpm/fedora/groonga.spec.in \
packages/rpm/centos/groonga.spec.in \
packages/debian/changelog \
+ doc/source/install.txt \
+ doc/source/install/*.txt \
$(GROONGA_GITHUB_COM_PATH)/index.html \
$(GROONGA_GITHUB_COM_PATH)/ja/index.html
Modified: doc/source/install.txt (+20 -347)
===================================================================
--- doc/source/install.txt 2012-05-18 17:15:02 +0900 (6b8224b)
+++ doc/source/install.txt 2012-05-18 17:17:14 +0900 (3573042)
@@ -5,350 +5,23 @@
Install
=======
-This section describes how to install groonga on each environment.
-
-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.
-
-
-Debian GNU/Linux squeeze
-------------------------
-
-/etc/apt/sources.list.d/groonga.list::
-
- deb http://packages.groonga.org/debian/ squeeze main
- deb-src http://packages.groonga.org/debian/ squeeze main
-
-Install::
-
- % sudo aptitude update
- % sudo aptitude -V -D -y --allow-untrusted install groonga-keyring
- % sudo aptitude -V -D -y install groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.
-
-Install groonga-tokenizer-mecab package::
-
- % sudo aptitude -V -D -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, please install groonga-munin-plugins package.
-
-Install groonga-munin-plugins package::
-
- % sudo aptitude -V -D -y install groonga-munin-plugins
-
-Debian GNU/Linux wheezy
------------------------
-
-/etc/apt/sources.list.d/groonga.list::
-
- deb http://packages.groonga.org/debian/ wheezy main
- deb-src http://packages.groonga.org/debian/ wheezy main
-
-Install::
-
- % sudo aptitude update
- % sudo aptitude -V -D -y --allow-untrusted install groonga-keyring
- % sudo aptitude -V -D -y install groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.
-
-Install groonga-tokenizer-mecab package::
-
- % sudo aptitude -V -D -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, please install groonga-munin-plugins package.
-
-Install groonga-munin-plugins package::
-
- % sudo aptitude -V -D -y install groonga-munin-plugins
-
-Debian GNU/Linux sid
---------------------
-
-/etc/apt/sources.list.d/groonga.list::
-
- deb http://packages.groonga.org/debian/ unstable main
- deb-src http://packages.groonga.org/debian/ unstable main
-
-Install::
-
- % sudo aptitude update
- % sudo aptitude -V -D -y --allow-untrusted install groonga-keyring
- % sudo aptitude -V -D -y install groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.
-
-Install groonga-tokenizer-mecab package::
-
- % sudo aptitude -V -D -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, please install groonga-munin-plugins package.
-
-Install groonga-munin-plugins package::
-
- % sudo aptitude -V -D -y install groonga-munin-plugins
-
-Ubuntu 10.04 LTS Lucid Lynx
----------------------------
-
-.. note::
-
- You'll need to enable the universe repository of Ubuntu to install groonga.
- The following describes how to do it.
-
-/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 -y install groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please 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, please install groonga-munin-plugins package.
-
-Install groonga-munin-plugins package::
-
- % sudo apt-get -y install groonga-munin-plugins
-
-Ubuntu 11.04 Natty Narwhal
---------------------------
-
-.. note::
-
- You'll need to enable the universe repository of Ubuntu to install groonga.
- The following describes how to do it.
-
-/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 -y install groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please 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, please install groonga-munin-plugins package.
-
-Install groonga-munin-plugins package::
-
- % sudo apt-get -y install groonga-munin-plugins
-
-Ubuntu 11.10 Oneiric Ocelot
----------------------------
-
-.. note::
-
- You'll need to enable the universe repository of Ubuntu to install groonga.
- The following describes how to do it.
-
-/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 -y install groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please 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, please install groonga-munin-plugins package.
-
-Install groonga-munin-plugins package::
-
- % sudo apt-get -y install groonga-munin-plugins
-
-Ubuntu 12.04 Precise Pangolin
------------------------------
-
-.. note::
-
- You'll need to enable the universe repository of Ubuntu to install groonga.
- The following describes how to do it.
-
-/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 -y install groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please 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, please install groonga-munin-plugins package.
-
-Install groonga-munin-plugins package::
-
- % sudo apt-get -y install groonga-munin-plugins
-
-CentOS 5
---------
-
-Install::
-
- % sudo rpm -ivh http://packages.groonga.org/centos/groonga-repository-1.0.1-0.noarch.rpm
- % sudo yum update
- % sudo yum install -y groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.
-
-Install groonga-tokenizer-mecab package::
-
- % sudo yum install -y groonga-tokenizer-mecab
-
-There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.
-
-.. note::
-
- Groonga-munin-plugins package requires munin-node package that isn't included in the official CentOS repository. You need to enable `Repoforge (RPMforge) <http://repoforge.org/>`_ repository or `EPEL <http://fedoraproject.org/wiki/EPEL>`_ repository to install it by yum.
-
- Enable Repoforge (RPMforge) repository on i386 environment::
-
- % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm
-
- Enable Repoforge (RPMforge) repository on x86_64 environment::
-
- % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.x86_64.rpm
-
- Enable EPEL repository on any environment::
-
- % sudo rpm -ivh http://download.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm
-
-Install groonga-munin-plugins package::
-
- % sudo yum update
- % sudo yum install -y groonga-munin-plugins
-
-CentOS 6
---------
-
-Install::
-
- % sudo rpm -ivh http://packages.groonga.org/centos/groonga-repository-1.0.1-0.noarch.rpm
- % sudo yum update
- % sudo yum install -y groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.
-
-Install groonga-tokenizer-mecab package::
-
- % sudo yum install -y groonga-tokenizer-mecab
-
-There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.
-
-.. note::
-
- Groonga-munin-plugins package requires munin-node package that isn't included in the official CentOS repository. You need to enable `EPEL <http://fedoraproject.org/wiki/EPEL>`_ repository to install it by yum.
-
- ..
- Enable Repoforge (RPMforge) repository on i686 environment::
-
- % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el6.rf.i686.rpm
-
- Enable Repoforge (RPMforge) repository on x86_64 environment::
-
- % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el6.rf.x86_64.rpm
-
- Enable EPEL repository on any environment::
-
- % sudo rpm -ivh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-6.noarch.rpm
-
-Install groonga-munin-plugins package::
-
- % sudo yum update
- % sudo yum install -y groonga-munin-plugins
-
-Fedora 16
----------
-
-Install::
-
- % sudo rpm -ivh http://packages.groonga.org/fedora/groonga-repository-1.0.1-0.noarch.rpm
- % sudo yum update
- % sudo yum install -y groonga
-
-If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.
-
-Install groonga-tokenizer-mecab package::
-
- % sudo yum install -y groonga-tokenizer-mecab
-
-There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.
-
-Install groonga-munin-plugins package::
-
- % sudo yum install -y groonga-munin-plugins
-
-Mac OS X (MacPorts)
--------------------
-
-Install::
-
- % sudo port install groonga
-
-Mac OS X (Homebrew)
--------------------
-
-Install::
-
- % brew install groonga
-
-Windows (Installer)
--------------------
-
-You just download an installer (.exe file) from
-`packages.groonga.org/windows/ <http://packages.groonga.org/windows/groonga/>`_
-and execute it.
-
-Windows (zip)
--------------
-
-You just download a zip file from
-`packages.groonga.org/windows/ <http://packages.groonga.org/windows/groonga/>`_
-and extract it.
-
-Others
-------
-
-If you want to use a morphological analyzer for tokenization in full-text indexing, please install `MeCab <http://mecab.sourceforge.net/>`_ before installing groonga.
-
-Then, download a tar.gz file from `packages.groonga.org/source/ <http://packages.groonga.org/source/groonga/>`_ and extract it. After that, please run the following command to install groonga.
-
-Install::
-
- ./configure --prefix=/usr --localstatedir=/var && make && sudo make install
-
-The ``--prefix`` option specifies the path to install groonga. If you don't specify the install path, "/usr/local" is used. Please specify "/usr" if you are not familiar with environment variables such as LD_LIBRARY_PATH.
-
-There are some `Munin <http://munin-monitoring.org/>`_ plugins in groonga package. You need to specify `--with-munin-plugins` option if you want to install them.
+This section describes how to install groonga on each
+environment. There are packages for major platforms. It's recommended
+that you use package instead of building groonga by yourself. But
+don't warry. There is a document about building groonga from source.
+
+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.
+
+.. toctree::
+
+ install/windows
+ install/mac_os_x
+ install/debian
+ install/ubuntu
+ install/centos
+ install/fedora
+ install/others
Added: doc/source/install/centos.txt (+130 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/install/centos.txt 2012-05-18 17:17:14 +0900 (aa67480)
@@ -0,0 +1,130 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+CentOS
+======
+
+This section describes how to install groonga related RPM packages on
+CentOS. You can install them by `yum`.
+
+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.
+
+5
+-
+
+Install::
+
+ % sudo rpm -ivh http://packages.groonga.org/centos/groonga-repository-1.0.1-0.noarch.rpm
+ % sudo yum update
+ % sudo yum install -y 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 yum install -y 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.
+
+.. note::
+
+ Groonga-munin-plugins package requires munin-node package that
+ isn't included in the official CentOS repository. You need to
+ enable `Repoforge (RPMforge) <http://repoforge.org/>`_ repository
+ or `EPEL <http://fedoraproject.org/wiki/EPEL>`_ repository to
+ install it by `yum`.
+
+ Enable Repoforge (RPMforge) repository on i386 environment::
+
+ % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm
+
+ Enable Repoforge (RPMforge) repository on x86_64 environment::
+
+ % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.x86_64.rpm
+
+ Enable EPEL repository on any environment::
+
+ % sudo rpm -ivh http://download.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm
+
+Install groonga-munin-plugins package::
+
+ % sudo yum update
+ % sudo yum install -y groonga-munin-plugins
+
+6
+-
+
+Install::
+
+ % sudo rpm -ivh http://packages.groonga.org/centos/groonga-repository-1.0.1-0.noarch.rpm
+ % sudo yum update
+ % sudo yum install -y 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 yum install -y 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.
+
+.. note::
+
+ Groonga-munin-plugins package requires munin-node package that
+ isn't included in the official CentOS repository. You need to
+ enable `EPEL <http://fedoraproject.org/wiki/EPEL>`_ repository to
+ install it by yum.
+
+ ..
+ Enable Repoforge (RPMforge) repository on i686 environment::
+
+ % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el6.rf.i686.rpm
+
+ Enable Repoforge (RPMforge) repository on x86_64 environment::
+
+ % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el6.rf.x86_64.rpm
+
+ Enable EPEL repository on any environment::
+
+ % sudo rpm -ivh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-6.noarch.rpm
+
+Install groonga-munin-plugins package::
+
+ % sudo yum update
+ % sudo yum install -y groonga-munin-plugins
+
+Build from source
+-----------------
+
+Install required packages to build groonga::
+
+ % sudo yum install -y wget tar gcc-c++ make mecab-devel
+
+Download source::
+
+ % wget http://packages.groonga.org/source/groonga/groonga-2.0.2.tar.gz
+ % tar xvzf groonga-2.0.2.tar.gz
+ % cd groonga-2.0.2
+
+Configure (see :ref:`source-configure` about ``configure`` options)::
+
+ % ./configure
+
+Build::
+
+ % make -j$(grep '^processor' /proc/cpuinfo | wc -l)
+
+Install::
+
+ % sudo make intall
Added: doc/source/install/debian.txt (+133 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/install/debian.txt 2012-05-18 17:17:14 +0900 (faaca93)
@@ -0,0 +1,133 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Debian GNU/Linux
+================
+
+This section describes how to install groonga related deb packages on
+Debian GNU/Linux. 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.
+
+squeeze
+-------
+
+Add the groonga apt repository.
+
+/etc/apt/sources.list.d/groonga.list::
+
+ deb http://packages.groonga.org/debian/ squeeze main
+ deb-src http://packages.groonga.org/debian/ squeeze main
+
+Install::
+
+ % sudo aptitude update
+ % sudo aptitude -V -D -y --allow-untrusted install groonga-keyring
+ % sudo aptitude -V -D -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 aptitude -V -D -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 aptitude -V -D -y install groonga-munin-plugins
+
+wheezy
+------
+
+Add the groonga apt repository.
+
+/etc/apt/sources.list.d/groonga.list::
+
+ deb http://packages.groonga.org/debian/ wheezy main
+ deb-src http://packages.groonga.org/debian/ wheezy main
+
+Install::
+
+ % sudo aptitude update
+ % sudo aptitude -V -D -y --allow-untrusted install groonga-keyring
+ % sudo aptitude -V -D -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 aptitude -V -D -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 aptitude -V -D -y install groonga-munin-plugins
+
+sid
+---
+
+Add the groonga apt repository.
+
+/etc/apt/sources.list.d/groonga.list::
+
+ deb http://packages.groonga.org/debian/ unstable main
+ deb-src http://packages.groonga.org/debian/ unstable main
+
+Install::
+
+ % sudo aptitude update
+ % sudo aptitude -V -D -y --allow-untrusted install groonga-keyring
+ % sudo aptitude -V -D -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 aptitude -V -D -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 aptitude -V -D -y install groonga-munin-plugins
+
+Build from source
+-----------------
+
+Install required packages to build groonga::
+
+ % sudo aptitude -V -D -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.2.tar.gz
+ % tar xvzf groonga-2.0.2.tar.gz
+ % cd groonga-2.0.2
+
+Configure (see :ref:`source-configure` about ``configure`` options)::
+
+ % ./configure
+
+Build::
+
+ % make -j$(grep '^processor' /proc/cpuinfo | wc -l)
+
+Install::
+
+ % sudo make intall
Added: doc/source/install/fedora.txt (+72 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/install/fedora.txt 2012-05-18 17:17:14 +0900 (22eaee6)
@@ -0,0 +1,72 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Fedora
+======
+
+This section describes how to install groonga related RPM packages on
+Fedora. You can install them by `yum`.
+
+Groonga related RPM pakcages are also in the official Fedora yum
+repository. So you can use them instead of the groonga yum
+repository. The different between the groonga yum repository and the
+official Fedora yum repository is that the groonga yum repository
+provides the latest version at the release day but the official Fedora
+yum repository provides the latest version a few days later. That is,
+the different is very small. :-)
+
+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.
+
+16
+--
+
+Install::
+
+ % sudo rpm -ivh http://packages.groonga.org/fedora/groonga-repository-1.0.1-0.noarch.rpm
+ % sudo yum update
+ % sudo yum install -y 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 yum install -y 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 yum install -y groonga-munin-plugins
+
+Build from source
+-----------------
+
+Install required packages to build groonga::
+
+ % sudo yum install -y wget tar gcc-c++ make mecab-devel libedit-devel
+
+Download source::
+
+ % wget http://packages.groonga.org/source/groonga/groonga-2.0.2.tar.gz
+ % tar xvzf groonga-2.0.2.tar.gz
+ % cd groonga-2.0.2
+
+Configure (see :ref:`source-configure` about ``configure`` options)::
+
+ % ./configure
+
+Build::
+
+ % make -j$(grep '^processor' /proc/cpuinfo | wc -l)
+
+Install::
+
+ % sudo make intall
Added: doc/source/install/mac_os_x.txt (+52 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/install/mac_os_x.txt 2012-05-18 17:17:14 +0900 (33ab3e4)
@@ -0,0 +1,52 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Mac OS X
+========
+
+This section describes how to install groonga on Mac OS X. You can
+install groonga MacPorts or Homebrew.
+
+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.
+
+MacPorts
+--------
+
+Install::
+
+ % sudo port install groonga
+
+Homebrew
+--------
+
+Install::
+
+ % brew install groonga
+
+Build from source
+-----------------
+
+Install `Xcode <https://developer.apple.com/xcode/>`_.
+
+Download source::
+
+ % curl -O http://packages.groonga.org/source/groonga/groonga-2.0.2.tar.gz
+ % tar xvzf groonga-2.0.2.tar.gz
+ % cd groonga-2.0.2
+
+Configure (see :ref:`source-configure` about ``configure`` options)::
+
+ % ./configure
+
+Build::
+
+ % make -j$(/usr/sbin/sysctl -n hw.ncpu)
+
+Install::
+
+ % sudo make intall
Added: doc/source/install/others.txt (+263 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/install/others.txt 2012-05-18 17:17:14 +0900 (61abd63)
@@ -0,0 +1,263 @@
+.. -*- 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:`/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.2.tar.gz
+ % tar xvzf groonga-2.0.2.tar.gz
+ % cd groonga-2.0.2
+ % ./configure
+ % make
+ % sudo make install
+
+After the above steps, :doc:`/executables/groonga` is found in
+``/usr/local/bin/groonga``.
+
+The default build will work well but you can customize groonga at
+``configure`` 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, ``groonga`` command 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 ``goronga`` 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
+:doc:`/commands/select#match-escalation-threshold` about match
+escalation threshold. -1 means that search escalation is never used.
+
+The default is 0.
+
+Here is an example that search 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/``.
+
+They 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.
+
+They are not installed by default.
+
+Here is an example that installs platform specifiec system management
+files for CentOS::
+
+ % ./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:`/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
Added: doc/source/install/ubuntu.txt (+192 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/install/ubuntu.txt 2012-05-18 17:17:14 +0900 (283ea93)
@@ -0,0 +1,192 @@
+.. -*- 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 -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 -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 -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 -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.2.tar.gz
+ % tar xvzf groonga-2.0.2.tar.gz
+ % cd groonga-2.0.2
+
+Configure (see :ref:`source-configure` about ``configure`` options)::
+
+ % ./configure
+
+Build::
+
+ % make -j$(grep '^processor' /proc/cpuinfo | wc -l)
+
+Install::
+
+ % sudo make intall
Added: doc/source/install/windows.txt (+77 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/install/windows.txt 2012-05-18 17:17:14 +0900 (d2e850a)
@@ -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.2-x86.exe
+<http://packages.groonga.org/windows/groonga/groonga-2.0.2-x86.exe>`_
+and run it.
+
+For 64-bit environment, download `groonga-2.0.2-x64.exe
+<http://packages.groonga.org/windows/groonga/groonga-2.0.2-x64.exe>`_
+and run it.
+
+Use command prompt for ``groonga`` command installed in start menu.
+
+zip
+---
+
+For 32-bit environment: download `groonga-2.0.2-x86.zip
+<http://packages.groonga.org/windows/groonga/groonga-2.0.2-x86.zip>`_
+and extract it.
+
+For 64-bit environment, download `groonga-2.0.2-x64.zip
+<http://packages.groonga.org/windows/groonga/groonga-2.0.2-x64.zip>`_
+and extract it.
+
+``groonga`` command 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.2.zip
+<http://packages.groonga.org/source/groonga/groonga-2.0.2.tar.gz>`_
+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.2
+
+Configure by ``cmake``. The following commnad line is for 64-bit
+version. If you want to build 32-bit version, use ``-G "Visual Studio
+10"`` parameter instead::
+
+ groonga-2.0.2> cmake . -G "Visual Studio 10 Win64" -DCMAKE_INSTALL_PREFIX=C:\groonga
+
+Build by Visual Studio::
+
+ groonga-2.0.2> devenv groonga.sln /Build Release
+
+Install::
+
+ groonga-2.0.2> devenv groonga.sln /Build Release /Project Install
+
+After the above steps, :doc:`/executables/groonga` is found in
+``c:\groonga\bin\groonga.exe``.