rroonga 3.0.7-x86-mingw32 → 3.0.8-x86-mingw32

data/vendor/local/share/man/man1/groonga.1

@@ -1,4 +1,4 @@
-.TH "GROONGA" "1" "June 27, 2013" "3.0.5" "groonga"
+.TH "GROONGA" "1" "September 27, 2013" "3.0.8" "groonga"
 .SH NAME
 groonga \- groonga documentation
 .
@@ -34,6 +34,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .IP \(bu 2
 \fBnews\fP
 .UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+This document is also ditributed in forms of release source archive and updated time to time.
+If you want to refer latest documentation in source form, you can view such files via GitHub repository browser (\fI\%https://github.com/groonga/groonga/tree/master/doc/source\fP).
+.UNINDENT
+.UNINDENT
 .SH CHARACTERISTICS OF GROONGA
 .SS Groonga overview
 .sp
@@ -114,7 +122,7 @@ Start command prompt \fBcmd.exe\fP and download x86 executable binary by default
 .sp
 .nf
 .ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.5\-x86.exe
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.8\-x86.exe
 .ft P
 .fi
 .UNINDENT
@@ -130,7 +138,7 @@ Start command prompt \fBcmd.exe\fP and download x64 executable binary by default
 .sp
 .nf
 .ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.5\-x64.exe
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.8\-x64.exe
 .ft P
 .fi
 .UNINDENT
@@ -151,7 +159,7 @@ Start command prompt \fBcmd.exe\fP and download x86 zip archive by default brows
 .sp
 .nf
 .ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.5\-x86.zip
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.8\-x86.zip
 .ft P
 .fi
 .UNINDENT
@@ -167,7 +175,7 @@ Start command prompt \fBcmd.exe\fP and download x64 zip archive by default brows
 .sp
 .nf
 .ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.5\-x64.zip
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.8\-x64.zip
 .ft P
 .fi
 .UNINDENT
@@ -203,7 +211,7 @@ Visual Studio 2010 Express and download it by default browser:
 .nf
 .ft C
 > cd c:\eUsers\e%USERNAME%\eDownloads
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/source/groonga/groonga\-3.0.5.zip
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/source/groonga/groonga\-3.0.8.zip
 .ft P
 .fi
 .UNINDENT
@@ -217,7 +225,7 @@ Move to the groonga\(aqs source folder:
 .sp
 .nf
 .ft C
-> cd c:\eUsers\e%USERNAME%\eDownloads\egroonga\-3.0.5
+> cd c:\eUsers\e%USERNAME%\eDownloads\egroonga\-3.0.8
 .ft P
 .fi
 .UNINDENT
@@ -231,7 +239,7 @@ parameter instead:
 .sp
 .nf
 .ft C
-groonga\-3.0.5> cmake . \-G "Visual Studio 10 Win64" \-DCMAKE_INSTALL_PREFIX=C:\egroonga
+groonga\-3.0.8> cmake . \-G "Visual Studio 10 Win64" \-DCMAKE_INSTALL_PREFIX=C:\egroonga
 .ft P
 .fi
 .UNINDENT
@@ -243,7 +251,7 @@ Build:
 .sp
 .nf
 .ft C
-groonga\-3.0.5> cmake \-\-build . \-\-config Release
+groonga\-3.0.8> cmake \-\-build . \-\-config Release
 .ft P
 .fi
 .UNINDENT
@@ -255,7 +263,7 @@ Install:
 .sp
 .nf
 .ft C
-groonga\-3.0.5> cmake \-\-build . \-\-config Release \-\-target Install
+groonga\-3.0.8> cmake \-\-build . \-\-config Release \-\-target Install
 .ft P
 .fi
 .UNINDENT
@@ -309,9 +317,9 @@ Download source:
 .sp
 .nf
 .ft C
-% curl \-O http://packages.groonga.org/source/groonga/groonga\-3.0.5.tar.gz
-% tar xvzf groonga\-3.0.5.tar.gz
-% cd groonga\-3.0.5
+% curl \-O http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
+% tar xvzf groonga\-3.0.8.tar.gz
+% cd groonga\-3.0.8
 .ft P
 .fi
 .UNINDENT
@@ -711,9 +719,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.5.tar.gz
-% tar xvzf groonga\-3.0.5.tar.gz
-% cd groonga\-3.0.5
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
+% tar xvzf groonga\-3.0.8.tar.gz
+% cd groonga\-3.0.8
 .ft P
 .fi
 .UNINDENT
@@ -1185,9 +1193,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.5.tar.gz
-% tar xvzf groonga\-3.0.5.tar.gz
-% cd groonga\-3.0.5
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
+% tar xvzf groonga\-3.0.8.tar.gz
+% cd groonga\-3.0.8
 .ft P
 .fi
 .UNINDENT
@@ -1525,9 +1533,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.5.tar.gz
-% tar xvzf groonga\-3.0.5.tar.gz
-% cd groonga\-3.0.5
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
+% tar xvzf groonga\-3.0.8.tar.gz
+% cd groonga\-3.0.8
 .ft P
 .fi
 .UNINDENT
@@ -1612,7 +1620,7 @@ groonga\-server\-gqtp (GQTP protocol based server package)
 See \fB/server\fP section about details.
 .UNINDENT
 .UNINDENT
-.SS Fedora 18
+.SS Fedora
 .sp
 Install:
 .INDENT 0.0
@@ -1732,9 +1740,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.5.tar.gz
-% tar xvzf groonga\-3.0.5.tar.gz
-% cd groonga\-3.0.5
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
+% tar xvzf groonga\-3.0.8.tar.gz
+% cd groonga\-3.0.8
 .ft P
 .fi
 .UNINDENT
@@ -1799,9 +1807,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.5.tar.gz
-% gtar xvzf groonga\-3.0.5.tar.gz
-% cd groonga\-3.0.5
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
+% gtar xvzf groonga\-3.0.8.tar.gz
+% cd groonga\-3.0.8
 .ft P
 .fi
 .UNINDENT
@@ -1889,7 +1897,7 @@ Here are optional tools:
 .INDENT 3.5
 .INDENT 0.0
 .IP \(bu 2
-\fI\%pkg-config\fP for
+\fI\%pkg\-config\fP for
 detecting libraries
 .IP \(bu 2
 \fI\%sudo\fP for installing built
@@ -1941,9 +1949,9 @@ steps:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.5.tar.gz
-% tar xvzf groonga\-3.0.5.tar.gz
-% cd groonga\-3.0.5
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
+% tar xvzf groonga\-3.0.8.tar.gz
+% cd groonga\-3.0.8
 % ./configure
 % make
 % sudo make install
@@ -2228,10 +2236,10 @@ There are mailing lists for discussion about groonga.
 .INDENT 0.0
 .TP
 .B For English speakers
-\fI\%groonga-talk@lists.sourceforge.net\fP
+\fI\%groonga\-talk@lists.sourceforge.net\fP
 .TP
 .B For Japanese speakers
-\fI\%groonga-dev@lists.sourceforge.jp\fP
+\fI\%groonga\-dev@lists.sourceforge.jp\fP
 .UNINDENT
 .SS Twitter
 .sp
@@ -2324,10 +2332,10 @@ status
 #     "max_command_version": 2,
 #     "n_queries": 0,
 #     "cache_hit_rate": 0.0,
-#     "version": "3.0.5",
-#     "alloc_count": 157,
+#     "version": "3.0.7",
+#     "alloc_count": 154,
 #     "command_version": 1,
-#     "starttime": 1372040812,
+#     "starttime": 1377493494,
 #     "default_command_version": 1
 #   }
 # ]
@@ -3478,10 +3486,10 @@ status
 #     "max_command_version": 2,
 #     "n_queries": 0,
 #     "cache_hit_rate": 0.0,
-#     "version": "3.0.5",
-#     "alloc_count": 136,
+#     "version": "3.0.7",
+#     "alloc_count": 133,
 #     "command_version": 1,
-#     "starttime": 1372040831,
+#     "starttime": 1377493621,
 #     "default_command_version": 1
 #   }
 # ]
@@ -3590,14 +3598,14 @@ status
 #     0.000355720520019531
 #   ],
 #   {
-#     "uptime": 0,
+#     "uptime": 1,
 #     "max_command_version": 2,
 #     "n_queries": 0,
 #     "cache_hit_rate": 0.0,
-#     "version": "3.0.5",
-#     "alloc_count": 137,
+#     "version": "3.0.7",
+#     "alloc_count": 134,
 #     "command_version": 1,
-#     "starttime": 1372040831,
+#     "starttime": 1377493621,
 #     "default_command_version": 1
 #   }
 # ]
@@ -6127,6 +6135,20 @@ select \-\-table Blog2 \-\-match_columns title \-\-query message
 .fi
 .UNINDENT
 .UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+There may be a question that "which is the better solution for indexing."
+It depends on the case.
+.INDENT 0.0
+.IP \(bu 2
+Indexes for each column \- The update performance tends to be better than multiple colum index because there is enough buffer for updating. On the other hand, the efficiency of disk usage is not so good.
+.IP \(bu 2
+Indexes for multiple column \- It saves disk usage because it shares common buffer. On the other hand, the update performance is not so good.
+.UNINDENT
+.UNINDENT
+.UNINDENT
 .SS インデックス名を指定した全文検索
 .sp
 執筆中です。
@@ -8821,12 +8843,32 @@ There are three packages for server use.
 .IP \(bu 2
 \fBgroonga\-server\-http\fP (simple HTTP protocol based server package)
 .IP \(bu 2
-\fBgroonga\-server\-gqtp\fP (GQTP protocol based server package)
+\fBgroonga\-server\-gqtp\fP (\fB/spec/gqtp\fP protocol based server package)
 .UNINDENT
 .sp
-Note that there is a conflict between \fBgroonga\-httpd\fP and \fBgroonga\-server\-http\fP
+There is the reason why groonga supports not only GQTP but also two HTTP server
+packages. \fB/spec/gqtp\fP \- Groonga Query Transfer Protocol is desined to reduce overheads
+and improve performance. But, GQTP is less support of client library than HTTP protocol does.
+As HTTP is matured protocol, you can take advantage of existing tool and there are many client
+library (See \fI\%related projects\fP for details).
+If you use \fBgroonga\-httpd\fP package, you can also take benefits of nginx functionality.
+.sp
+We recommend to use \fBgroonga\-server\-http\fP at first, then if you want to use more
+fullfilling functionality, use \fBgroonga\-httpd\fP package. If you have performance issues which
+is derived from protocol overheads, consider to use \fBgroonga\-server\-gqtp\fP.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+There is a conflict between \fBgroonga\-httpd\fP and \fBgroonga\-server\-http\fP
 package because of port number.
 See \fB/server/http/comparison\fP if you want to know which package meets your demands.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
 .SS groonga\-httpd
 .sp
 \fBgroonga\-httpd\fP is a nginx and HTTP protocol based server package.
@@ -9089,7 +9131,7 @@ Restarting groonga HTTP server(Fedora):
 .UNINDENT
 .SS groonga\-server\-gqtp
 .sp
-\fBgroonga\-server\-gqtp\fP is a GQTP protocol based server package.
+\fBgroonga\-server\-gqtp\fP is a \fB/spec/gqtp\fP protocol based server package.
 .TS
 center;
 |l|l|.
@@ -10507,14 +10549,14 @@ Execution example:
     0.000355720520019531
   ],
   {
-    "uptime": 1,
+    "uptime": 0,
     "max_command_version": 2,
     "n_queries": 0,
     "cache_hit_rate": 0.0,
-    "version": "3.0.5",
-    "alloc_count": 157,
+    "version": "3.0.7",
+    "alloc_count": 154,
     "command_version": 1,
-    "starttime": 1372040796,
+    "starttime": 1377493431,
     "default_command_version": 1
   }
 ]
@@ -10615,6 +10657,9 @@ groonga_database /path/to/groonga/database;
 .sp
 Specifies the path to a groonga database. This is the required
 directive.
+.SS \fBgroonga_database_auto_create\fP
+.sp
+TODO
 .SS \fBgroonga_base_path\fP
 .sp
 Synopsis:
@@ -10678,6 +10723,149 @@ location /d/ {
 .fi
 .UNINDENT
 .UNINDENT
+.SS \fBgroonga_log_path\fP
+.sp
+Synopsis:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+groonga_log_path path | off;
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B Default
+\fB/var/log/groonga/httpd/groonga.log\fP
+.TP
+.B Context
+\fBhttp\fP, \fBserver\fP, \fBlocation\fP
+.UNINDENT
+.sp
+Specifies groonga log path in the \fBhttp\fP, \fBserver\fP or \fBlocation\fP block. The
+default is \fB/var/log/groonga/httpd/groonga.log\fP.
+You can disable logging to specify \fBoff\fP.
+.sp
+Examples:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+location /d/ {
+  groonga on;
+  # You can disable log for groonga.
+  groonga_log_path off;
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS \fBgroonga_log_level\fP
+.sp
+Synopsis:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+groonga_log_level none | emergency | alert | ciritical | error | warning | notice | info | debug | dump;
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B Default
+\fBnotice\fP
+.TP
+.B Context
+\fBhttp\fP, \fBserver\fP, \fBlocation\fP
+.UNINDENT
+.sp
+Specifies groonga log level in the \fBhttp\fP, \fBserver\fP or \fBlocation\fP block. The
+default is \fBnotice\fP. You can disable logging by specifying \fBnone\fP as log level.
+.sp
+Examples:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+location /d/ {
+  groonga on;
+  # You can customize log level for groonga.
+  groonga_log_level notice;
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS \fBgroonga_query_log_path\fP
+.sp
+Synopsis:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+groonga_query_log_path path | off;
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B Default
+\fB/var/log/groonga/httpd/groonga\-query.log\fP
+.TP
+.B Context
+\fBhttp\fP, \fBserver\fP, \fBlocation\fP
+.UNINDENT
+.sp
+Specifies groonga\(aqs query log path in the \fBhttp\fP, \fBserver\fP or
+\fBlocation\fP block. The default is
+\fB/var/log/groonga/httpd/groonga\-query.log\fP.  You can disable logging
+to specify \fBoff\fP.
+.sp
+Examples:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+location /d/ {
+  groonga on;
+  # You can disable query log for groonga.
+  groonga_query_log_path off;
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Query log is useful for the following cases:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+Detecting slow query.
+.IP \(bu 2
+Debugging.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+You can analyze your query log by \fI\%groonga\-query\-log package\fP. The package provides
+useful tools.
+.sp
+For example, there is a tool that analyzing your query log. It can
+detect slow queries from your query log. There is a tool that
+replaying same queries in your query log. It can test the new groonga
+before updating production environment.
 .SS Performance related directives
 .sp
 The following directives are related to the performance of groonga\-httpd.
@@ -10691,9 +10879,177 @@ This isn\(aqt a groonga\-httpd specific directive, but an nginx\(aqs one. For de
 see \fI\%http://wiki.nginx.org/CoreModule#worker_processes\fP.
 .sp
 By default, this is set to 1. It is nginx\(aqs default.
+.SS \fBproxy_cache\fP
+.sp
+In short, you can use nginx\(aqs reverse proxy and cache mechanism
+instead of groonga\(aqs built\-in query cache feature.
+.SS Query cache
+.sp
+Groonga has query cache feature for \fB/reference/commands/select\fP
+command. The feature improves performance in many cases.
+.sp
+Query cache feature works well on groonga\-httpd except you use
+\fB/reference/commands/cache_limit\fP command on 2 or more
+workers. Normally, \fB/reference/commands/cache_limit\fP command
+isn\(aqt used. So there is no problem on many cases.
+.sp
+Here is a description about a problem of using
+\fB/reference/commands/cache_limit\fP command on 2 or more workers.
+.sp
+Groonga\(aqs query cache is available in the same process. It means that
+workers can\(aqt share the cache. If you don\(aqt change cache size, it
+isn\(aqt a big problem. If you want to change cache size by
+\fB/reference/commands/cache_limit\fP command, there is a problem.
+.sp
+There is no portable ways to change cache size for all workers.
+.sp
+For example, there are 3 workers:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+                                   +\-\- worker 1
+client \-\- groonga\-httpd (master) \-\-+\-\- worker 2
+                                   +\-\- worker 3
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The client requests \fB/reference/commands/cache_limit\fP command and
+the worker 1 receives it:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+                                   +\-> worker 1 (changed!)
+client \-> groonga\-httpd (master) \-\-+\-\- worker 2
+                                   +\-\- worker 3
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The client requests \fB/reference/commands/cache_limit\fP command
+again and the worker 1 receives it again:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+                                   +\-> worker 1 (changed again!!!)
+client \-> groonga\-httpd (master) \-\-+\-\- worker 2
+                                   +\-\- worker 3
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In this case, the worker 2 and the worker 3 aren\(aqt received any
+requests. So they don\(aqt change cache size.
+.sp
+You can\(aqt choose a worker. So you can\(aqt change cache sizes of all
+workers by \fB/reference/commands/cache_limit\fP command.
+.SS Reverse proxy and cache
+.sp
+You can use nginx\(aqs reverse proxy and cache feature for query cache:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+                                                            +\-\- worker 1
+client \-\- groonga\-httpd (master) \-\- reverse proxy + cache \-\-+\-\- worker 2
+                                                            +\-\- worker 3
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+You can use the same cache configuration for all workers but you can\(aqt
+change cache configuration dynamically by HTTP.
+.sp
+Here is a sample configuration:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+\&...
+http {
+  proxy_cache_path /var/cache/groonga\-httpd levels=1:2 keys_zone=groonga:10m;
+  proxy_cache_valid 10m;
+  ...
+  # Reverse proxy and cache
+  server {
+    listen 10041;
+    ...
+    # Only select command
+    location /d/select {
+      # Pass through groonga with cache
+      proxy_cache groonga;
+      proxy_pass http://localhost:20041;
+    }
+
+    location / {
+      # Pass through groonga
+      proxy_pass http://localhost:20041;
+    }
+  }
+
+  # groonga
+  server {
+    location 20041;
+    location /d/ {
+      groonga on;
+      groonga_database /var/lib/groonga/db/db;
+    }
+  }
+  ...
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+See the following nginx documentations for parameter details:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+\fI\%http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path\fP
+.IP \(bu 2
+\fI\%http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_valid\fP
+.IP \(bu 2
+\fI\%http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache\fP
+.IP \(bu 2
+\fI\%http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass\fP
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Note that you need to remove cache files created by nginx by hand
+after you load new data to groonga. For the above sample
+configuration, run the following command to remove cache files:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+% groonga DB_PATH < load.grn
+% rm \-rf /var/cache/groonga\-httpd/*
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+If you use groonga\(aqs query cache feature, you don\(aqt need to expire
+cache by hand. It is done automatically.
 .SS Available nginx modules
 .sp
-All standard HTTP modules is available. HttpRewriteModule is
+All standard HTTP modules are available. HttpRewriteModule is
 disabled when you don\(aqt have PCRE (Perl Compatible Regular
 Expressions). For the list of standard HTTP modules, see
 \fI\%http://wiki.nginx.org/Modules\fP.
@@ -11585,67 +11941,112 @@ value are statuses that have positive value in GQTP protocol. You
 can convert status value in GQTP protocol to return code by
 handling it as 2byte signed integer.
 .UNINDENT
-.SS cache_limit
-.SS 名前
+.SS \fBcache_limit\fP
+.SS Summary
 .sp
-cache_limit \- cacheサイズの設定・取得
-.SS 書式
+\fBcache_limit\fP gets or sets the max number of query cache
+entries. Query cache is used only by \fBselect\fP command.
+.sp
+If the max number of query cache entries is 100, the recent 100
+\fBselect\fP commands are only cached. The cache expire algorithm is LRU
+(least recently used).
+.SS Syntax
+.sp
+\fBcache_limit\fP has one optional parameter:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-cache_limit max
+cache_limit [max=null]
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
-.SS 説明
-.sp
-groonga組込コマンドの一つであるcache_limitについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+.SS Usage
 .sp
-cache_limitは、クエリキャッシュの最大件数を取得したり設定したりします。
-.SS 引数
+You can get the current max number of cache entries by executing
+\fBcache_limit\fP without parameter.
 .sp
-\fBmax\fP
-.INDENT 0.0
-.INDENT 3.5
-クエリキャッシュの最大件数を整数で指定します。
-maxが指定されなかった場合には、クエリキャッシュの最大件数は変更せず、
-現在の設定値のみが返されます。
-.UNINDENT
-.UNINDENT
-.SS 返値
-.SS json
+Execution example:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-[以前の設定値]
+cache_limit
+# [[0, 1337566253.89858, 0.000355720520019531], 100]
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
-\fB以前の設定値\fP
+You can set the max number of cache entries by executing \fBcache_limit\fP
+with \fBmax\fP parameter.
+.sp
+Here is an example that sets \fB10\fP as the max number of cache
+entries.
+.sp
+Execution example:
 .INDENT 0.0
 .INDENT 3.5
-すでに設定されていたクエリキャッシュの最大件数を返す。
+.sp
+.nf
+.ft C
+cache_limit 10
+# [[0, 1337566253.89858, 0.000355720520019531], 100]
+cache_limit
+# [[0, 1337566253.89858, 0.000355720520019531], 10]
+.ft P
+.fi
 .UNINDENT
 .UNINDENT
-.SS 例
+.sp
+If \fBmax\fP parameter is used, the return value is the max number of
+cache entries before \fBmax\fP parameter is set.
+.SS Parameters
+.sp
+This section describes all parameters.
+.SS \fBmax\fP
+.sp
+It specifies the max number of query cache entries as a number.
+.sp
+If \fBmax\fP parameter isn\(aqt specified, the current max number of query
+cache entries isn\(aqt changed. \fBcache_limit\fP just returns the current
+max number of query cache entries.
+.SS Return value
+.sp
+\fBcache_limit\fP returns the current max number of query cache entries:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-cache_limit 4
-[100]
+[[HEADER, n_entries]]
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
+.sp
+\fBHEADER\fP
+.INDENT 0.0
+.INDENT 3.5
+See \fB/reference/command/output_format\fP about \fBHEADER\fP.
+.UNINDENT
+.UNINDENT
+.sp
+\fBn_entries\fP
+.INDENT 0.0
+.INDENT 3.5
+\fBn_entries\fP is the current max number of query cache entries. It
+is a number.
+.UNINDENT
+.UNINDENT
+.SS See also
+.INDENT 0.0
+.IP \(bu 2
+\fBselect\fP
+.UNINDENT
 .SS check
 .SS 名前
 .sp
@@ -12664,7 +13065,7 @@ define_selector entry_selector Entry
 .SS defrag
 .SS 名前
 .sp
-defrag \- オブジェクトにセットされたロックを解除する
+\fBdefrag\fP command resolves fragmentation of specified objects.
 .SS 書式
 .INDENT 0.0
 .INDENT 3.5
@@ -12735,11 +13136,16 @@ defrag Entry.body
 .fi
 .UNINDENT
 .UNINDENT
-.SS delete
-.SS 名前
+.SS \fBdelete\fP
+.SS Summary
 .sp
-delete \- 一件のレコードの削除
-.SS 書式
+\fBdelete\fP command deletes specified record of table.
+.SS Cascade delete
+.sp
+There is a case that multiple table is associated. For example, the key of one table are referenced by other table\(aqs records. In such a case, if you delete the key of one table, other table\(aqs records are also removed.
+.sp
+Note that the type of other table\(aqs column is COLUMN_VECTOR, only the value of referencing key is removed from the vector value.
+.SS Syntax
 .INDENT 0.0
 .INDENT 3.5
 .sp
@@ -12750,77 +13156,243 @@ delete table [key [id [filter]]]
 .fi
 .UNINDENT
 .UNINDENT
-.SS 説明
+.SS Usage
+.sp
+Here are a schema definition and sample data to show usage.
 .sp
-groonga組込コマンドの一つであるdeleteについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+Delete the record from Entry table which has "2" as the key.
 .sp
-deleteは、使用しているデータベースのテーブルに1件のレコードを削除します。
-.SS 引数
+Execution example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+delete Entry 2
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+select Entry
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         1
+#       ],
+#       [
+#         [
+#           "_id",
+#           "UInt32"
+#         ],
+#         [
+#           "_key",
+#           "UInt32"
+#         ],
+#         [
+#           "status",
+#           "ShortText"
+#         ]
+#       ],
+#       [
+#         1,
+#         1,
+#         "OK"
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Here is the example about cascaded delete.
+.sp
+The country column of Users table associates with Country table.
+.sp
+"Cascaded delete" removes the records which matches specified key and refers that key.
+.sp
+Execution example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+table_create Country TABLE_HASH_KEY ShortText
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+table_create Users TABLE_HASH_KEY UInt32
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Users name COLUMN_SCALAR ShortText
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Users country COLUMN_SCALAR Country
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+load \-\-table Users
+[
+{"_key": 1, "name": "John", country: "United States"}
+{"_key": 2, "name": "Mike", country: "United States"}
+{"_key": 3, "name": "Takashi", country: "Japan"}
+{"_key": 4, "name": "Hanako", country: "Japan"}
+]
+# [[0, 1337566253.89858, 0.000355720520019531], 4]
+load \-\-table Country
+[
+{"_key": "United States"}
+{"_key": "Japan"}
+]
+# [[0, 1337566253.89858, 0.000355720520019531], 2]
+delete Country "United States"
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+select Country
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         1
+#       ],
+#       [
+#         [
+#           "_id",
+#           "UInt32"
+#         ],
+#         [
+#           "_key",
+#           "ShortText"
+#         ]
+#       ],
+#       [
+#         2,
+#         "Japan"
+#       ]
+#     ]
+#   ]
+# ]
+select Users
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         4
+#       ],
+#       [
+#         [
+#           "_id",
+#           "UInt32"
+#         ],
+#         [
+#           "_key",
+#           "UInt32"
+#         ],
+#         [
+#           "country",
+#           "Country"
+#         ],
+#         [
+#           "name",
+#           "ShortText"
+#         ]
+#       ],
+#       [
+#         1,
+#         1,
+#         "",
+#         "John"
+#       ],
+#       [
+#         2,
+#         2,
+#         "",
+#         "Mike"
+#       ],
+#       [
+#         3,
+#         3,
+#         "Japan",
+#         "Takashi"
+#       ],
+#       [
+#         4,
+#         4,
+#         "Japan",
+#         "Hanako"
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Parameters
 .sp
 \fBtable\fP
 .INDENT 0.0
 .INDENT 3.5
-レコードを削除しようとするテーブルの名前を指定します。
+It specifies the name of table to delete the records.
 .UNINDENT
 .UNINDENT
 .sp
 \fBkey\fP
 .INDENT 0.0
 .INDENT 3.5
-削除するレコードの主キー値を指定します。主キーなしのテーブルの場合はこのパラメータを指定しても無視されます(idパラメータを代わりに指定します)。
+It specifies the key of record to delete. If you use the table with TABLE_NO_KEY, the key is just ignored.
+(Use \fBid\fP parameter in such a case)
 .UNINDENT
 .UNINDENT
 .sp
 \fBid\fP
 .INDENT 0.0
 .INDENT 3.5
-レコードIDによってレコードを指定します。idパラメータを指定する場合は、keyパラメータを指定してはいけません。
+It specifies the id of record to delete. If you specify \fBid\fP parameter, you must not specify \fBkey\fP parameter.
 .UNINDENT
 .UNINDENT
 .sp
 \fBfilter\fP
 .INDENT 0.0
 .INDENT 3.5
-script形式のgrn_expr文字列によってレコードを指定します。filterパラメータを指定する場合は、id及びkeyパラメータを指定してはいけません。
+It specifies the expression of grn_expr to identify the record. If you specify \fBfilter\fP parameter,
+you must not specify \fBkey\fP and \fBid\fP parameter.
 .UNINDENT
 .UNINDENT
-.sp
-返値
-\-\-\-
-.SS json形式
+.SS Return value
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-[成功かどうかのフラグ]
+[HEADER, SUCCEEDED_OR_NOT]
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
-\fB成功かどうかのフラグ\fP
+\fBHEADER\fP
 .INDENT 0.0
 .INDENT 3.5
-エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
+See \fB/reference/command/output_format\fP about HEADER.
 .UNINDENT
 .UNINDENT
-.SS 例
 .sp
-テーブルEntryからレコードを削除します。:
+\fBSUCCEEDED_OR_NOT\fP
 .INDENT 0.0
 .INDENT 3.5
-.sp
-.nf
-.ft C
-delete Entry abandon
-
-[true]
-.ft P
-.fi
+If command succeeded, it returns true, otherwise it returns false on error.
 .UNINDENT
 .UNINDENT
-.SS 関連項目
+.SS See also
 .sp
 \fBload\fP
 .SS dump
@@ -13491,52 +14063,28 @@ You can specify absolute path such as \fBregister
 If \fBregister\fP fails, error details are in \fBHEADER\fP.
 .sp
 See \fB/reference/command/output_format\fP for \fBHEADER\fP.
-.SS \fBselect\fP
+.SS \fBruby_eval\fP
 .SS Summary
 .sp
-\fBselect\fP searches records that are matched to specified conditions
-from a table and then outputs them.
-.sp
-\fBselect\fP is the most important command in groonga. You need to
-understand \fBselect\fP to use the full power of groonga.
+\fBruby_eval\fP command evaluates ruby script and returns the result.
 .SS Syntax
 .sp
-\fBselect\fP has many parameters. The required parameter is only
-\fBtable\fP and others are optional:
+\fBruby_eval\fP has one required parameter:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-select table
-       [match_columns=null]
-       [query=null]
-       [filter=null]
-       [scorer=null]
-       [sortby=null]
-       [output_columns="_id, _key, *"]
-       [offset=0]
-       [limit=10]
-       [drilldown=null]
-       [drilldown_sortby=null]
-       [drilldown_output_columns=null]
-       [drilldown_offset=0]
-       [drilldown_limit=10]
-       [cache=yes]
-       [match_escalation_threshold=0]
-       [query_expansion=null]
-       [query_flags=ALLOW_PRAGMA|ALLOW_COLUMN|ALLOW_UPDATE|ALLOW_LEADING_NOT|NONE]
-       [query_expander=null]
+ruby_eval ruby_script
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .SS Usage
 .sp
-Let\(aqs learn about \fBselect\fP usage with examples. This section shows
-many popular usages.
+You can execute any scripts which mruby supports by calling \fBruby_eval\fP.
 .sp
-Here are a schema definition and sample data to show usage.
+Here is an example that just calculate \fB1 + 2\fP by mruby plugin.
 .sp
 Execution example:
 .INDENT 0.0
@@ -13544,21 +14092,144 @@ Execution example:
 .sp
 .nf
 .ft C
-table_create Entries TABLE_HASH_KEY ShortText
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-column_create Entries content COLUMN_SCALAR Text
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-column_create Entries n_likes COLUMN_SCALAR UInt32
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText \-\-default_tokenizer TokenBigram
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
+register ruby/eval
 # [[0, 1337566253.89858, 0.000355720520019531], true]
-load \-\-table Entries
-[
-{"_key":    "The first post!",
+ruby_eval "1 + 2"
+# [[0, 1337566253.89858, 0.000355720520019531], {"value": 3}]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Register \fBruby/eval\fP plugin to use \fBruby_eval\fP command in advance.
+.sp
+Note that \fBruby_eval\fP is implemented as an experimental plugin,
+and the specification may be changed in the future.
+.SS Parameters
+.sp
+This section describes all parameters.
+.SS \fBruby_script\fP
+.sp
+It specifies the ruby script which you want to evaluate.
+.SS Return value
+.sp
+\fBruby_eval\fP returns the evaluated result which key is "value" as json format:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+[[HEADER, EVALUATED]]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fBHEADER\fP
+.INDENT 0.0
+.INDENT 3.5
+See \fB/reference/command/output_format\fP about \fBHEADER\fP.
+.UNINDENT
+.UNINDENT
+.sp
+\fBEVALUATED\fP
+.INDENT 0.0
+.INDENT 3.5
+\fBEVALUATED\fP consists of pair of key and value in forms of {key:value}.
+.TS
+center;
+|l|l|.
+_
+T{
+Name
+T}	T{
+Description
+T}
+_
+T{
+\fBkey\fP
+T}	T{
+reserved word \(aqvalue\(aq.
+T}
+_
+T{
+\fBvalue\fP
+T}	T{
+the value of evaluated script. It must be a number.
+T}
+_
+.TE
+.UNINDENT
+.UNINDENT
+.SS See also
+.SS \fBselect\fP
+.SS Summary
+.sp
+\fBselect\fP searches records that are matched to specified conditions
+from a table and then outputs them.
+.sp
+\fBselect\fP is the most important command in groonga. You need to
+understand \fBselect\fP to use the full power of groonga.
+.SS Syntax
+.sp
+\fBselect\fP has many parameters. The required parameter is only
+\fBtable\fP and others are optional:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+select table
+       [match_columns=null]
+       [query=null]
+       [filter=null]
+       [scorer=null]
+       [sortby=null]
+       [output_columns="_id, _key, *"]
+       [offset=0]
+       [limit=10]
+       [drilldown=null]
+       [drilldown_sortby=null]
+       [drilldown_output_columns=null]
+       [drilldown_offset=0]
+       [drilldown_limit=10]
+       [cache=yes]
+       [match_escalation_threshold=0]
+       [query_expansion=null]
+       [query_flags=ALLOW_PRAGMA|ALLOW_COLUMN|ALLOW_UPDATE|ALLOW_LEADING_NOT|NONE]
+       [query_expander=null]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Usage
+.sp
+Let\(aqs learn about \fBselect\fP usage with examples. This section shows
+many popular usages.
+.sp
+Here are a schema definition and sample data to show usage.
+.sp
+Execution example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+table_create Entries TABLE_HASH_KEY ShortText
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Entries content COLUMN_SCALAR Text
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Entries n_likes COLUMN_SCALAR UInt32
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText \-\-default_tokenizer TokenBigram
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+load \-\-table Entries
+[
+{"_key":    "The first post!",
  "content": "Welcome! This is my first post!",
  "n_likes": 5},
 {"_key":    "Groonga",
@@ -15982,16 +16653,16 @@ drilldown条件が実行される前の検索結果が以下のように出力
 .sp
 .nf
 .ft C
-[[検索件数], [[カラム名1,カラム型1],..], 検索結果1,..]
+[[ヒット数], [[カラム名1,カラム型1],..], 検索結果1,..]
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
-\fB検索件数\fP
+\fBヒット数\fP
 .INDENT 0.0
 .INDENT 3.5
-検索件数が出力されます。
+検索条件にヒットしたレコードの数が出力されます。 \fB\-\-limit\fP オプションで出力件数を制限した場合は出力するレコード数と一致しません。 \fBヒット数\fP は \fB\-\-limit\fP オプションに関係なく常にヒットしたレコードの数になります。
 .UNINDENT
 .UNINDENT
 .sp
@@ -16182,14 +16853,14 @@ status
 #     0.000355720520019531
 #   ],
 #   {
-#     "uptime": 6,
+#     "uptime": 50,
 #     "max_command_version": 2,
 #     "n_queries": 39,
 #     "cache_hit_rate": 0.0,
-#     "version": "3.0.5",
-#     "alloc_count": 303,
+#     "version": "3.0.7",
+#     "alloc_count": 300,
 #     "command_version": 1,
-#     "starttime": 1372040777,
+#     "starttime": 1377493297,
 #     "default_command_version": 1
 #   }
 # ]
@@ -17582,7 +18253,7 @@ tokenize TokenTrigram "Fulltext Search"
 .sp
 If you want to use other tokenizers, you need to register additional
 tokenizer plugin by \fBregister\fP command. For example, you can use
-MySQL compatible normalizer by registering \fI\%groonga-normalizer-mysql\fP.
+MySQL compatible normalizer by registering \fI\%groonga\-normalizer\-mysql\fP.
 .SS \fBstring\fP
 .sp
 It specifies any string which you want to tokenize. If you want to
@@ -18357,7 +19028,7 @@ groongaのデータベースでは、テーブルの主キーや、カラムの
 .INDENT 3.5
 IEEE 754形式の倍精度浮動小数点数であり、実数を表します。（デフォルト値: 0.0）
 .sp
-IEEE 754形式の詳細については、 \fI\%IEEE 754 - Wikipedia\fP や \fI\%IEEE 754: Standard for Binary Floating-Point\fP を参照してください。
+IEEE 754形式の詳細については、 \fI\%IEEE 754 \- Wikipedia\fP や \fI\%IEEE 754: Standard for Binary Floating\-Point\fP を参照してください。
 .UNINDENT
 .UNINDENT
 .sp
@@ -18399,7 +19070,7 @@ IEEE 754形式の詳細については、 \fI\%IEEE 754 - Wikipedia\fP や \fI\%
 度分秒形式でx度y分z秒となる経度・緯度は、(((x * 60) + y) * 60 + z) * 1000という計算式でミリ秒単位へと変換されます。
 \fB/reference/commands/load\fP コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、\(aqx\(aq のほかに \(aq,\(aq を使うことができます。
 .sp
-測地系の詳細については、 \fI\%測地系 - Wikipedia\fP を参照してください。
+測地系の詳細については、 \fI\%測地系 \- Wikipedia\fP を参照してください。
 .UNINDENT
 .UNINDENT
 .sp
@@ -19402,9 +20073,9 @@ Here is a special character list:
 .INDENT 3.5
 .INDENT 0.0
 .IP \(bu 2
-\fB[space]\fP (escaped as \fB[backquote][space]\fP) (You should
+\fB[space]\fP (escaped as \fB[backslash][space]\fP) (You should
 substitute \fB[space]\fP with a white space character that is 0x20
-in ASCII and \fB[backquote]\fP with \fB\e\e\fP.)
+in ASCII and \fB[backslash]\fP with \fB\e\e\fP.)
 .IP \(bu 2
 \fB"\fP (escaped as \fB\e"\fP)
 .IP \(bu 2
@@ -19424,6 +20095,19 @@ You can use quote instead of escape. Quote syntax is \fB"..."\fP or
 You need escape \fB\(aq\fP as \fB\e\(aq\fP in \fB\(aq...\(aq\fP quote syntax. For
 example, \fBAlice\(aqs brother (Bob)\fP can be quoted \fB"Alice\(aqs brother
 (Bob)"\fP or \fB\(aqAlice\e\(aqs brother (Bob)\(aq\fP.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+There is a important point which you have to care. The \(aq\(aq\e\(aq\(aq (backslash)
+character is interpreted by command line shell. So if you want to search
+\(aq\(aq(\(aq\(aq itself for example, you need to escape twice (\(aq\(aq\e\e(\(aq\(aq) in command line shell.
+The command line shell interprets \(aq\(aq\e\e(\(aq\(aq as \(aq\(aq\e(\(aq\(aq, then pass such a literal
+to groonga. groonga regards \(aq\(aq\e(\(aq\(aq as \(aq\(aq(\(aq\(aq, then search \(aq\(aq(\(aq\(aq
+itself from database. If you can\(aqt do intended search by groonga, confirm whether
+special character is escaped properly.
+.UNINDENT
+.UNINDENT
 .SS Conditional expression
 .sp
 Here is available conditional expression list.
@@ -24346,20 +25030,26 @@ TokyoGeoPoint(日本測地系座標)かWGS84GeoPoint(世界測地系座標)の
 .sp
 \fBhtml_untag\fP strips HTML tags from HTML and outputs plain text.
 .sp
-\fBhtml_untag\fP is used in \fB\-\-output_columns\fP described at \fB/reference/commands/select\fP.
+\fBhtml_untag\fP is used in \fB\-\-output_columns\fP described at \fIoutput_columns\fP.
 .SS Syntax
 .sp
-\fBhtml_untag\fP requires only one argument. It is \fBcolumn\fP.
+\fBhtml_untag\fP requires only one argument. It is \fBhtml\fP.
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-html_untag(column)
+html_untag(html)
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
+.SS Requirements
+.sp
+\fBhtml_untag\fP requires groonga 3.0.5 or later.
+.sp
+\fBhtml_untag\fP requires \fB/reference/command/command_version\fP 2 or
+later.
 .SS Usage
 .sp
 Here are a schema definition and sample data to show usage.
@@ -24372,14 +25062,10 @@ Execution example:
 .sp
 .nf
 .ft C
-table_create WebClips TABLE_NO_KEY
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-column_create WebClips url COLUMN_SCALAR ShortText
+table_create WebClips TABLE_HASH_KEY ShortText
 # [[0, 1337566253.89858, 0.000355720520019531], true]
 column_create WebClips content COLUMN_SCALAR ShortText
 # [[0, 1337566253.89858, 0.000355720520019531], true]
-column_create WebClips tag COLUMN_VECTOR ShortText
-# [[0, 1337566253.89858, 0.000355720520019531], true]
 .ft P
 .fi
 .UNINDENT
@@ -24395,8 +25081,8 @@ Execution example:
 .ft C
 load \-\-table WebClips
 [
-{"_key": 1, "url": "http://groonga.org", "tag": ["groonga"], "content": "groonga is <span class=\(aqemphasize\(aq>fast</span>"},
-{"_key": 2, "url": "http://mroonga.org", "tag": ["mroonga"], "content": "mroonga is <span class=\e"emphasize\e">fast</span>"},
+{"_key": "http://groonga.org", "content": "groonga is <span class=\(aqemphasize\(aq>fast</span>"},
+{"_key": "http://mroonga.org", "content": "mroonga is <span class=\e"emphasize\e">fast</span>"},
 ]
 # [[0, 1337566253.89858, 0.000355720520019531], 2]
 .ft P
@@ -24412,7 +25098,7 @@ Execution example:
 .sp
 .nf
 .ft C
-select WebClips \-\-output_columns "_key, html_untag(content)" \-\-command_version 2
+select WebClips \-\-output_columns "html_untag(content)" \-\-command_version 2
 # [
 #   [
 #     0,
@@ -24448,13 +25134,13 @@ When executing the above query, you can see "span" tag with "class" attribute is
 Note that you must specify \fB\-\-command_version 2\fP to use \fBhtml_untag\fP function.
 .SS Parameters
 .sp
-There is one required parameter, \fBcolumn\fP.
-.SS \fBcolumn\fP
+There is one required parameter, \fBhtml\fP.
+.SS \fBhtml\fP
 .sp
-It specifies a column of the table.
+It specifies HTML text to be untagged.
 .SS Return value
 .sp
-\fBhtml_untag\fP returns plain text which is stripped HTML tags from content of column.
+\fBhtml_untag\fP returns plain text which is stripped HTML tags from HTML text.
 .SS now
 .SS 名前
 .sp
@@ -24493,19 +25179,19 @@ now()
 .SS query
 .SS Summary
 .sp
-\fBquery\fP enables you to specify \fB\-\-match_columns\fP and \fB\-\-query\fP parameters as
-function arguments.
-.sp
-\fBquery\fP is one of the groonga builtin functions, so you can specify
-multiple \fBquery\fP function as parameters of \fB\-\-filter\fP option.
+\fBquery\fP provides \fB\-\-match_columns\fP and \fB\-\-query\fP parameters of
+\fB/reference/commands/select\fP feature as function. You can specify
+multiple \fBquery\fP functions in \fB\-\-filter\fP parameter in
+\fB/reference/commands/select\fP.
 .sp
 Because of such flexibility, you can control full text search behavior
-by combination of multiple \fBquery\fP function.
+by combination of multiple \fBquery\fP functions.
 .sp
-\fBquery\fP can be used in only \fB\-\-filter\fP in \fB/reference/commands/select\fP.
+\fBquery\fP can be used in only \fB\-\-filter\fP in
+\fB/reference/commands/select\fP.
 .SS Syntax
 .sp
-\fBquery\fP requires two arguments \- \fBmatch_column\fP and \fBquery_string\fP.
+\fBquery\fP requires two arguments \- \fBmatch_columns\fP and \fBquery_string\fP.
 .sp
 The parameter \fBquery_expander\fP or \fBsubstitution_table\fP is optional.
 .INDENT 0.0
@@ -24513,9 +25199,9 @@ The parameter \fBquery_expander\fP or \fBsubstitution_table\fP is optional.
 .sp
 .nf
 .ft C
-query(match_column, query_string)
-query(match_column, query_string, query_expander)
-query(match_column, query_string, substitution_table)
+query(match_columns, query_string)
+query(match_columns, query_string, query_expander)
+query(match_columns, query_string, substitution_table)
 .ft P
 .fi
 .UNINDENT
@@ -24582,7 +25268,7 @@ load \-\-table Users
 .UNINDENT
 .sp
 Here is the simple usage of \fBquery\fP function which execute full text
-search by keyword \(aqalice\(aq without using \fB\-\-match_column\fP and
+search by keyword \(aqalice\(aq without using \fB\-\-match_columns\fP and
 \fB\-\-query\fP arguments in \fB\-\-filter\fP.
 .sp
 Execution example:
@@ -24772,15 +25458,12 @@ keywords on your purpose.
 .SS Parameters
 .SS Required parameter
 .sp
-There are two required parameter, \fBmatch_column\fP and \fBquery_string\fP.
-.SS \fBmatch_column\fP
+There are two required parameter, \fBmatch_columns\fP and \fBquery_string\fP.
+.SS \fBmatch_columns\fP
 .sp
 It specifies the default target column for fulltext search by
 \fBquery_string\fP parameter value. It is the same role as
-\fBmatch_column\fP parameter in \fBselect\fP.
-.sp
-See \fIselect\-match\-columns\fP about \fBmatch_column\fP parameter in
-\fBselect\fP.
+\fIselect\-match\-columns\fP parameter in \fBselect\fP.
 .SS \fBquery_string\fP
 .sp
 It specifies the search condition in
@@ -25264,13 +25947,17 @@ There are two required parameter, \fBscope\fP and \fBfilter_string\fP.
 .SS \fBscope\fP
 .sp
 It specifies a column of the table that is specified by \fBtable\fP
-parameter in \fBselect\fP. \fBfilter_string\fP is evaluated in the column
+parameter in \fBselect\fP. The column has a limitation. The limitation
+is described later. \fBfilter_string\fP is evaluated in the column
 context. It means that \fBfilter_string\fP is evaluated like
 \fBselect \-\-table TYPE_OF_THE_COLUMN \-\-filter FILTER_STRING\fP.
 .sp
 The specified column type must be a table. In other words, the column
 type must be reference type.
 .sp
+You can chain columns by \fBCOLUMN_1.COLUMN_2.COLUMN_3...COLUMN_N\fP
+syntax. For example, \fBuser.group.name\fP.
+.sp
 See \fIselect\-table\fP about \fBtable\fP parameter in \fBselect\fP.
 .SS \fBfilter_string\fP
 .sp
@@ -25735,209 +26422,2556 @@ Second with two digits.
 Microsecond with six digits.
 .UNINDENT
 .sp
-Example:
-.INDENT 7.0
-.INDENT 3.5
+Example:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+2011\-07\-05 06:25:18.345734
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.TP
+.B ID
+ID of a thread. Groonga process creates threads to process
+requests concurrently. Each thread outputs some logs for a
+request. This ID can be used to extract a log sequence by
+a thread.
+.sp
+Example:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+45ea3034
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B >
+A character that indicates query is started.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B :
+A character that indicates query is processing.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B <
+A character that indicates query is finished.
+.TP
+.B MESSAGE
+Details about the log with free format.
+.sp
+Example:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+query log opened.
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.TP
+.B QUERY
+A query to be processed.
+.sp
+Example:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+select users \-\-match_columns hobby \-\-query music
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.TP
+.B ELAPSED_TIME
+Elapsed time in nanoseconds since query is started.
+.sp
+Example:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+000000000075770
+(It means 75,770 nanoseconds.)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.TP
+.B PROGRESS
+A processed work at the time.
+.sp
+Example:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+select(313401)
+(It means that \(aqselect\(aq is processed and 313,401 records are remained.)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.TP
+.B RETURN_CODE
+A return code for the query.
+.sp
+Example:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+rc=0
+(It means return code is 0. 0 means GRN_SUCCESS.)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+2011\-07\-05 06:25:19.458756|45ea3034|>select Properties \-\-limit 0
+2011\-07\-05 06:25:19.458829|45ea3034|:000000000072779 select(19)
+2011\-07\-05 06:25:19.458856|45ea3034|:000000000099998 output(0)
+2011\-07\-05 06:25:19.458875|45ea3034|<000000000119062 rc=0
+2011\-07\-05 06:25:19.458986|45ea3034|>quit
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS API
+.sp
+Groonga can be used as a fulltext search library. This section
+describes APIs that are provided by groonga.
+.SS \fBgrn_cache\fP
+.SS Summary
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+This API is experimental.
+.UNINDENT
+.UNINDENT
+.sp
+\fBgrn_cache\fP is a data store that keeps responses of
+\fB/reference/commands/select\fP command. It is not general use cache
+object. It is only for \fB/reference/commands/select\fP command.
+.sp
+You can just change the current cache object by
+\fBgrn_cache_current_set()\fP. \fB/reference/commands/select\fP
+command response cache is done internally.
+.sp
+\fB/reference/commands/select\fP command uses one global cache
+object. If you open multiple databases, the one cache is shared. It is
+an important problem.
+.sp
+If you open multiple databases and use
+\fB/reference/commands/select\fP command, you need to use
+\fBgrn_cache\fP object. It is \fB/reference/executables/groonga\-httpd\fP
+case. If you open only one database or don\(aqt use
+\fB/reference/commands/select\fP command, you don\(aqt need to use
+\fBgrn_cache\fP object. It is \fI\%rroonga\fP case.
+.SS Example
+.sp
+Here is an example that change the current cache object.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+grn_cache *cache;
+grn_cache *cache_previous;
+cache = grn_cache_open(ctx);
+cache_previous = grn_cache_current_get(ctx);
+grn_cache_current_set(ctx, cache);
+/* grn_ctx_send(ctx, ...); */
+grn_cache_current_set(ctx, cache_previous);
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_cache
+It is an opaque cache object. You can create a \fBgrn_cache\fP by
+\fBgrn_cache_open()\fP and free the created object by
+\fBgrn_cache_close()\fP.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_cache *grn_cache_open(grn_ctx\fI\ *ctx\fP)
+Creates a new cache object.
+.sp
+If memory allocation for the new cache object is failed, \fBNULL\fP
+is returned. Error information is stored into the \fBctx\fP.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- The context.
+.UNINDENT
+.TP
+.B Returns
+A newly allocated cache object on success, \fBNULL\fP
+otherwise. The returned cache object must be freed by
+\fBgrn_cache_close()\fP.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_cache_close(grn_ctx\fI\ *ctx\fP, grn_cache\fI\ *cache\fP)
+Frees resourses of the \fBcache\fP.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- The context.
+.IP \(bu 2
+\fBcache\fP \-\- The cache object to be freed.
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP otherwise.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_cache_current_set(grn_ctx\fI\ *ctx\fP, grn_cache\fI\ *cache\fP)
+Sets the cache object that is used in
+\fB/reference/commands/select\fP command.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- The context.
+.IP \(bu 2
+\fBcache\fP \-\- The cache object that is used in
+\fB/reference/commands/select\fP command.
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP otherwise.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_cache *grn_cache_current_get(grn_ctx\fI\ *ctx\fP)
+Gets the cache object that is used in
+\fB/reference/commands/select\fP command.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- The context.
+.UNINDENT
+.TP
+.B Returns
+The cache object that is used in
+\fB/reference/commands/select\fP command. It may be \fBNULL\fP.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_cache_set_max_n_entries(grn_ctx\fI\ *ctx\fP, grn_cache\fI\ *cache\fP, unsigned int\fI\ n\fP)
+Sets the max number of entries of the cache object.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- The context.
+.IP \(bu 2
+\fBcache\fP \-\- The cache object to be changed.
+.IP \(bu 2
+\fBn\fP \-\- The new max number of entries of the cache object.
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP otherwise.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B unsigned int grn_cache_get_max_n_entries(grn_ctx\fI\ *ctx\fP, grn_cache\fI\ *cache\fP)
+Gets the max number of entries of the cache object.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- The context.
+.IP \(bu 2
+\fBcache\fP \-\- The target cache object.
+.UNINDENT
+.TP
+.B Returns
+The max number of entries of the cache object.
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_column\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_obj *grn_column_create(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP, const char\fI\ *path\fP, grn_obj_flags\fI\ flags\fP, grn_obj\fI\ *type\fP)
+tableに新たなカラムを定義します。nameは省略できません。一つのtableに同一のnameのcolumnを複数定義することはできません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBname\fP \-\- カラム名を指定します。
+.IP \(bu 2
+\fBname_size\fP \-\- nameパラメータのsize(byte)を指定します。
+.IP \(bu 2
+\fBpath\fP \-\- カラムを格納するファイルパスを指定します。
+flagsに \fBGRN_OBJ_PERSISTENT\fP が指定されている場合のみ有効です。
+NULLなら自動的にファイルパスが付与されます。
+.IP \(bu 2
+\fBflags\fP \-\- 
+.sp
+\fBGRN_OBJ_PERSISTENT\fP を指定すると永続columnとなります。
+.sp
+\fBGRN_OBJ_COLUMN_INDEX\fP を指定すると転置インデックスとなります。
+.sp
+\fBGRN_OBJ_COLUMN_SCALAR\fP を指定するとスカラ値(単独の値)を格納します。
+.sp
+\fBGRN_OBJ_COLUMN_VECTOR\fP を指定すると値の配列を格納します。
+.sp
+\fBGRN_OBJ_COMPRESS_ZLIB\fP を指定すると値をzlib圧縮して格納します。
+.sp
+\fBGRN_OBJ_COMPRESS_LZO\fP を指定すると値をlzo圧縮して格納します。
+.sp
+\fBGRN_OBJ_COLUMN_INDEX\fP と共に \fBGRN_OBJ_WITH_SECTION\fP を指定すると、転置索引にsection(段落情報)を合わせて格納します。
+.sp
+\fBGRN_OBJ_COLUMN_INDEX\fP と共に \fBGRN_OBJ_WITH_WEIGHT\fP を指定すると、転置索引にweight情報を合わせて格納します。
+.sp
+\fBGRN_OBJ_COLUMN_INDEX\fP と共に \fBGRN_OBJ_WITH_POSITION\fP を指定すると、転置索引に出現位置情報を合わせて格納します。
+
+.IP \(bu 2
+\fBtype\fP \-\- カラム値の型を指定します。定義済みのtypeあるいはtableを指定できます。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_column_index_update(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *column\fP, grn_id\fI\ id\fP, unsigned int\fI\ section\fP, grn_obj\fI\ *oldvalue\fP, grn_obj\fI\ *newvalue\fP)
+oldvalue, newvalueの値から得られるキーに対応するcolumnの値の中の、id, sectionに対応するエントリを更新します。columnは \fBGRN_OBJ_COLUMN_INDEX\fP 型のカラムでなければなりません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBcolumn\fP \-\- 対象columnを指定します。
+.IP \(bu 2
+\fBid\fP \-\- 対象レコードのIDを指定します。
+.IP \(bu 2
+\fBsection\fP \-\- 対象レコードのセクション番号を指定します。
+.IP \(bu 2
+\fBoldvalue\fP \-\- 更新前の値を指定します。
+.IP \(bu 2
+\fBnewvalue\fP \-\- 更新後の値を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_column_table(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *column\fP)
+columnが属するtableを返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBcolumn\fP \-\- 対象columnを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_column_rename(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *column\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP)
+ctxが使用するdbにおいてcolumnに対応する名前をnameに更新します。columnは永続オブジェクトでなければいけません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBcolumn\fP \-\- 対象columnを指定します。
+.IP \(bu 2
+\fBname\fP \-\- 新しい名前を指定します。
+.IP \(bu 2
+\fBname_size\fP \-\- nameパラメータのsize（byte）を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_column_name(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, char\fI\ *namebuf\fP, int\fI\ buf_size\fP)
+カラムobjの名前の長さを返します。buf_sizeの長さが名前の長さ以上であった場合は、namebufに該当する名前をコピーします。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBnamebuf\fP \-\- 名前を格納するバッファ（呼出側で準備する）を指定します。
+.IP \(bu 2
+\fBbuf_size\fP \-\- namebufのサイズ（byte長）を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_column_index(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *column\fP, grn_operator\fI\ op\fP, grn_obj\fI\ **indexbuf\fP, int\fI\ buf_size\fP, int\fI\ *section\fP)
+columnに張られているindexのうち、opの操作を実行可能なものの数を返します。またそれらのidを、buf_sizeに指定された個数を上限としてindexbufに返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBcolumn\fP \-\- 対象のcolumnを指定します。
+.IP \(bu 2
+\fBop\fP \-\- indexで実行したい操作を指定します。
+.IP \(bu 2
+\fBindexbuf\fP \-\- indexを格納するバッファ（呼出側で準備する）を指定します。
+.IP \(bu 2
+\fBbuf_size\fP \-\- indexbufのサイズ（byte長）を指定します。
+.IP \(bu 2
+\fBsection\fP \-\- section番号を格納するint長バッファ（呼出側で準備する）を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_command_version\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_command_version
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_COMMAND_VERSION_MIN
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_COMMAND_VERSION_STABLE
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_COMMAND_VERSION_MAX
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_command_version grn_get_default_command_version(void)
+デフォルトのcommand_versionを返します。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_set_default_command_version(grn_command_version\fI\ version\fP)
+デフォルトのcommand_versionを変更します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBversion\fP \-\- 変更後のデフォルトのcommand_versionを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_ctx\fP
+.SS Summary
+.sp
+\fBgrn_ctx\fP is the most important object. \fBgrn_ctx\fP
+keeps the current infomation such as:
+.INDENT 0.0
+.IP \(bu 2
+The last occurred error.
+.IP \(bu 2
+The current encoding.
+.IP \(bu 2
+The default thresholds. (e.g. \fImatch\-escalation\-threshold\fP)
+.IP \(bu 2
+The default command version. (See \fB/reference/command/command_version\fP)
+.UNINDENT
+.sp
+\fBgrn_ctx\fP provides platform features such as:
+.INDENT 0.0
+.IP \(bu 2
+Memory management.
+.IP \(bu 2
+Logging.
+.UNINDENT
+.sp
+Most APIs receive \fBgrn_ctx\fP as the first argument.
+.sp
+You can\(aqt use the same \fBgrn_ctx\fP from two or more threads. You
+need to create a \fBgrn_ctx\fP for a thread. You can use two or
+more \fBgrn_ctx\fP in a thread but it is not needed for usual
+use\-case.
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_ctx
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ctx_init(grn_ctx\fI\ *ctx\fP, int\fI\ flags\fP)
+ctxを初期化します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- 初期化するctx構造体へのポインタを指定します。
+.IP \(bu 2
+\fBflags\fP \-\- 初期化する \fBctx\fP のオプションを指定します。
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP on error.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ctx_fin(grn_ctx\fI\ *ctx\fP)
+ctxの管理するメモリを解放し、使用を終了します。
+.sp
+If \fBctx\fP is initialized by \fBgrn_ctx_open()\fP not \fBgrn_ctx_init()\fP. You need also to call \fBgrn_ctx_close()\fP.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- 解放するctx構造体へのポインタを指定します。
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP on error.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_ctx *grn_ctx_open(int\fI\ flags\fP)
+初期化された \fBgrn_ctx\fP オブジェクトを返します。
+.sp
+\fBgrn_ctx_init()\fP で初期化された \fBgrn_ctx\fP オブジェクトは構造体の実体をAPIの呼び元で確保するのに対して、 \fBgrn_ctx_open()\fP ではgroongaライブラリの内部で、実体を確保します。
+どちらで初期化された \fBgrn_ctx\fP も、 \fBgrn_ctx_fin()\fP で解放できます。
+\fBgrn_ctx_open()\fP で確保した \fBgrn_ctx\fP 構造体に関しては、\fBgrn_ctx_fin()\fP で解放した後に、その \fBgrn_ctx\fP で作成した \fBgrn_obj\fP を \fBgrn_obj_close()\fP によって解放しても問題ありません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBflags\fP \-\- 初期化する \fBctx\fP のオプションを指定します。
+.UNINDENT
+.TP
+.B Returns
+初期化された \fBgrn_ctx\fP オブジェクトを返します。
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ctx_close(grn_ctx\fI\ *ctx\fP)
+It calls \fBgrn_ctx_fin()\fP and frees allocated memory for \fBctx\fP by \fBgrn_ctx_open()\fP.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- no longer needed \fBgrn_ctx\fP.
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP on error.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ctx_set_finalizer(grn_ctx\fI\ *ctx\fP, grn_proc_func\fI\ *func\fP)
+ctxを破棄するときに呼ばれる関数を設定します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- 対象ctxを指定します。
+.IP \(bu 2
+\fBfunc\fP \-\- \fBctx\fP を破棄するときに呼ばれる関数を指定します。
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP on error.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_command_version grn_ctx_get_command_version(grn_ctx\fI\ *ctx\fP)
+command_versionを返します。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ctx_set_command_version(grn_ctx\fI\ *ctx\fP, grn_command_version\fI\ version\fP)
+command_versionを変更します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBversion\fP \-\- 変更後のcommand_versionを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ctx_use(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *db\fP)
+ctxが操作対象とするdbを指定します。NULLを指定した場合は、dbを操作しない状態(init直後の状態)になります。
+.sp
+Don\(aqt use it with \fBgrn_ctx\fP that has \fBGRN_CTX_PER_DB\fP flag.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBdb\fP \-\- ctxが使用するdbを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_ctx_db(grn_ctx\fI\ *ctx\fP)
+ctxが現在操作対象としているdbを返します。dbを使用していない場合はNULLを返します。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_ctx_get(grn_ctx\fI\ *ctx\fP, const char\fI\ *name\fP, int\fI\ name_size\fP)
+ctxが使用するdbからnameに対応するオブジェクトを検索して返す。nameに一致するオブジェクトが存在しなければNULLを返す。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBname\fP \-\- 検索しようとするオブジェクトの名前。
+.IP \(bu 2
+\fBname_size\fP \-\- The number of bytes of name. If negative value is specified, name is assumed that NULL\-terminated string.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_ctx_at(grn_ctx\fI\ *ctx\fP, grn_id\fI\ id\fP)
+ctx、またはctxが使用するdbからidに対応するオブジェクトを検索して返す。idに一致するオブジェクトが存在しなければNULLを返す。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBid\fP \-\- 検索しようとするオブジェクトのidを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_db\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.sp
+TODO...
+.INDENT 0.0
+.TP
+.B grn_db
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_db_create_optarg
+It is used for specifying options for \fBgrn_db_create()\fP.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char **grn_db_create_optarg.builtin_type_names
+組み込み型の名前となるnul終端文字列の配列を指定する。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_db_create_optarg.n_builtin_type_names
+n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を
+指定する。配列のoffsetはenum型grn_builtin_typeの値に対応する。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_db_create(grn_ctx\fI\ *ctx\fP, const char\fI\ *path\fP, grn_db_create_optarg\fI\ *optarg\fP)
+新たなdbを作成します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- 初期化済みの \fBgrn_ctx\fP を指定します。
+.IP \(bu 2
+\fBpath\fP \-\- 作成するdbを格納するファイルパスを指定します。NULLならtemporary dbとなります。NULL以外のパスを指定した場合はpersistent dbとなります。
+.IP \(bu 2
+\fBoptarg\fP \-\- 
+.sp
+Currently, it is not used. It is just ignored.
+.sp
+作成するdbの組み込み型の名前を変更する時に指定します。
+.sp
+optarg.builtin_type_namesには、組み込み型の名前となるnull終端文字列の配列を指定します。optarg.n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を指定します。配列のoffsetはenum型grn_builtin_typeの値に対応します。
+
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_db_open(grn_ctx\fI\ *ctx\fP, const char\fI\ *path\fP)
+既存のdbを開きます。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBpath\fP \-\- 開こうとするdbを格納するファイルパスを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void grn_db_touch(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *db\fP)
+dbの内容の最終更新時刻を現在時刻にします。
+.sp
+最終更新時刻はキャッシュが有効かどうかの判断などに利用されます。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBdb\fP \-\- 内容が変更されたdbを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_obj_db(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+objの属するdbを返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_encoding\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_encoding
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_encoding grn_get_default_encoding(void)
+デフォルトのencodingを返します。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_set_default_encoding(grn_encoding\fI\ encoding\fP)
+デフォルトのencodingを変更します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBencoding\fP \-\- 変更後のデフォルトのencodingを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B const char *grn_encoding_to_string(grn_encoding\fI\ encoding\fP)
+Returns string representation for the encoding. For example, \(aqgrn_encoding_to_string(\fBGRN_ENC_UTF8\fP)\(aq returns \(aq"utf8"\(aq.
+.sp
+"unknown" is returned for invalid encoding.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBencoding\fP \-\- The encoding.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_encoding grn_encoding_parse(const char\fI\ *name\fP)
+Parses encoding name and returns grn_encoding. For example, \(aqgrn_encoding_parse("UTF8")\(aq returns \(aq\fBGRN_ENC_UTF8\fP\(aq.
+.sp
+\fBGRN_ENC_UTF8\fP is returned for invalid encoding name.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBname\fP \-\- The encoding name.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS grn_expr
+.sp
+\fIgrn_expr\fP is an \fBgrn_obj\fP that represents an expression. Here
+is a list of what expression can do:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+Expression can apply some operations to a record by
+\fBgrn_expr_exec()\fP.
+.IP \(bu 2
+Expression can represents search condition. \fBgrn_table_select()\fP
+can select records that match against the search condition represented
+by expression.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+There are two string representations of expression:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+\fB/reference/grn_expr/query_syntax\fP
+.IP \(bu 2
+\fB/reference/grn_expr/script_syntax\fP
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+\fBgrn_expr_parse()\fP parses string represented expression and
+appends the parsed expression to another expression.
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B GRN_API grn_obj *grn_expr_create(grn_ctx\fI\ *ctx\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_rc grn_expr_close(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_obj *grn_expr_add_var(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_obj *grn_expr_get_var_by_offset(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP, unsigned int\fI\ offset\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_obj *grn_expr_append_obj(grn_ctx *ctx, grn_obj *expr, grn_obj *obj, grn_operator op, int nargs);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_obj *grn_expr_append_const(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP, grn_obj\fI\ *obj\fP, grn_operator\fI\ op\fP, int\fI\ nargs\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_obj *grn_expr_append_const_str(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP, const char\fI\ *str\fP, unsigned int\fI\ str_size\fP, grn_operator\fI\ op\fP, int\fI\ nargs\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_obj *grn_expr_append_const_int(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP, int\fI\ i\fP, grn_operator\fI\ op\fP, int\fI\ nargs\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_rc grn_expr_append_op(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP, grn_operator\fI\ op\fP, int\fI\ nargs\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_expr_syntax_escape(grn_ctx\fI\ *ctx\fP, const char\fI\ *string\fP, int\fI\ string_size\fP, const char\fI\ *target_characters\fP, char\fI\ escape_character\fP, grn_obj\fI\ *escaped_string\fP)
+Escapes \fBtarget_characters\fP in \fBstring\fP by \fBescape_character\fP.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- Its encoding must be the same encoding of \fBstring\fP.
+It is used for allocating buffer for \fBescaped_string\fP.
+.IP \(bu 2
+\fBstring\fP \-\- String expression representation.
+.IP \(bu 2
+\fBstring_size\fP \-\- The byte size of \fBstring\fP. \fB\-1\fP means \fBstring\fP
+is NULL terminated string.
+.IP \(bu 2
+\fBtarget_characters\fP \-\- NULL terminated escape target characters.
+For example, \fB"+\-><~*()\e"\e\e:"\fP is
+\fBtarget_characters\fP for
+\fB/reference/grn_expr/query_syntax\fP.
+.IP \(bu 2
+\fBescape_character\fP \-\- The character to use escape a character in
+\fBtarget_characters\fP. For example, \fB\e\e\fP
+(backslash) is \fBescaped_character\fP for
+\fB/reference/grn_expr/query_syntax\fP.
+.IP \(bu 2
+\fBescaped_string\fP \-\- The output of escaped \fBstring\fP. It should be
+text typed bulk.
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP on error.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_expr_syntax_escape_query(grn_ctx\fI\ *ctx\fP, const char\fI\ *query\fP, int\fI\ query_size\fP, grn_obj\fI\ *escaped_query\fP)
+Escapes special characters in
+\fB/reference/grn_expr/query_syntax\fP.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- Its encoding must be the same encoding of \fBquery\fP.
+It is used for allocating buffer for \fBescaped_query\fP.
+.IP \(bu 2
+\fBquery\fP \-\- String expression representation in
+\fB/reference/grn_expr/query_syntax\fP.
+.IP \(bu 2
+\fBquery_size\fP \-\- The byte size of \fBquery\fP. \fB\-1\fP means \fBquery\fP
+is NULL terminated string.
+.IP \(bu 2
+\fBescaped_query\fP \-\- The output of escaped \fBquery\fP. It should be
+text typed bulk.
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP on error.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_rc grn_expr_compile(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_obj *grn_expr_exec(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP, int\fI\ nargs\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_API grn_obj *grn_expr_alloc(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *expr\fP, grn_id\fI\ domain\fP, grn_obj_flags\fI\ flags\fP)
+.UNINDENT
+.SS \fBgrn_geo\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_geo_point
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_geo_select_in_rectangle(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *index\fP, grn_obj\fI\ *top_left_point\fP, grn_obj\fI\ *bottom_right_point\fP, grn_obj\fI\ *res\fP, grn_operator\fI\ op\fP)
+It selects records that are in the rectangle specified by top_left_point parameter and bottom_right_point parameter. Records are searched by index parameter. Found records are added to res parameter table with op parameter operation.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBindex\fP \-\- the index column for TokyoGeoPoint or WGS84GeoPpoint type.
+.IP \(bu 2
+\fBtop_left_point\fP \-\- the top left point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or  WGS84GeoPoint)
+.IP \(bu 2
+\fBbottom_right_point\fP \-\- the bottom right point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
+.IP \(bu 2
+\fBres\fP \-\- the table to store found record IDs. It must be \fBGRN_TABLE_HASH_KEY\fP type table.
+.IP \(bu 2
+\fBop\fP \-\- the operator for matched records.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_geo_estimate_in_rectangle(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *index\fP, grn_obj\fI\ *top_left_point\fP, grn_obj\fI\ *bottom_right_point\fP)
+It estimates number of records in the rectangle specified by top_left_point parameter and bottom_right_point parameter. Number of records is estimated by index parameter. If an error is occurred, \-1 is returned.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBindex\fP \-\- the index column for TokyoGeoPoint or WGS84GeoPpoint type.
+.IP \(bu 2
+\fBtop_left_point\fP \-\- the top left point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
+.IP \(bu 2
+\fBbottom_right_point\fP \-\- the bottom right point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_geo_cursor_open_in_rectangle(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *index\fP, grn_obj\fI\ *top_left_point\fP, grn_obj\fI\ *bottom_right_point\fP, int\fI\ offset\fP, int\fI\ limit\fP)
+It opens a cursor to get records in the rectangle specfied by top_left_point parameter and bottom_right_point parameter.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBindex\fP \-\- the index column for TokyoGeoPoint or WGS84GeoPpoint type.
+.IP \(bu 2
+\fBtop_left_point\fP \-\- the top left point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
+.IP \(bu 2
+\fBbottom_right_point\fP \-\- the bottom right point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
+.IP \(bu 2
+\fBoffset\fP \-\- the cursor returns records from offset parameter position. offset parameter is based on 0.
+.IP \(bu 2
+\fBlimit\fP \-\- the cursor returns at most limit parameter records. \-1 means no limit.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_posting *grn_geo_cursor_next(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *cursor\fP)
+It returns the next posting that has record ID. It returns NULL after all records are returned.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBcursor\fP \-\- the geo cursor.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_hook\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_hook_entry
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_add_hook(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_hook_entry\fI\ entry\fP, int\fI\ offset\fP, grn_obj\fI\ *proc\fP, grn_obj\fI\ *data\fP)
+objに対してhookを追加します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBentry\fP \-\- 
+.sp
+\fBGRN_HOOK_GET\fP は、objectの参照時に呼び出されるhookを定義します。
+.sp
+\fBGRN_HOOK_SET\fP は、objectの更新時に呼び出されるhookを定義します。
+.sp
+\fBGRN_HOOK_SELECT\fP は、検索処理の実行中に適時呼び出され、処理の実行状況を調べたり、実行の中断を指示することができます。
+
+.IP \(bu 2
+\fBoffset\fP \-\- 
+.sp
+hookの実行順位。offsetに対応するhookの直前に新たなhookを挿入します。
+.sp
+0を指定した場合は先頭に挿入されます。\-1を指定した場合は末尾に挿入されます。
+.sp
+objectに複数のhookが定義されている場合は順位の順に呼び出されます。
+
+.IP \(bu 2
+\fBproc\fP \-\- 手続きを指定します。
+.IP \(bu 2
+\fBdata\fP \-\- hook固有情報を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_obj_get_nhooks(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_hook_entry\fI\ entry\fP)
+objに定義されているhookの数を返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBentry\fP \-\- hookタイプを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_obj_get_hook(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_hook_entry\fI\ entry\fP, int\fI\ offset\fP, grn_obj\fI\ *data\fP)
+objに定義されているhookの手続き（proc）を返します。hook固有情報が定義されている場合は、その内容をdataにコピーして返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBentry\fP \-\- hookタイプを指定します。
+.IP \(bu 2
+\fBoffset\fP \-\- 実行順位を指定します。
+.IP \(bu 2
+\fBdata\fP \-\- hook固有情報格納バッファを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_delete_hook(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_hook_entry\fI\ entry\fP, int\fI\ offset\fP)
+objに定義されているhookを削除します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBentry\fP \-\- hookタイプを指定します。
+.IP \(bu 2
+\fBoffset\fP \-\- 実行順位を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_ii\fP
+.SS Summary
+.sp
+buffered index builder
+.sp
+特定のアプリケーション用に準備した内部APIです。
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_ii
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_ii_buffer
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_ii_buffer *grn_ii_buffer_open(grn_ctx\fI\ *ctx\fP, grn_ii\fI\ *ii\fP, long long unsigned int\fI\ update_buffer_size\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ii_buffer_append(grn_ctx\fI\ *ctx\fP, grn_ii_buffer\fI\ *ii_buffer\fP, grn_id\fI\ rid\fP, unsigned int\fI\ section\fP, grn_obj\fI\ *value\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ii_buffer_commit(grn_ctx\fI\ *ctx\fP, grn_ii_buffer\fI\ *ii_buffer\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ii_buffer_close(grn_ctx\fI\ *ctx\fP, grn_ii_buffer\fI\ *ii_buffer\fP)
+.UNINDENT
+.SS \fBgrn_index_cursor\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_obj *grn_index_cursor_open(grn_ctx\fI\ *ctx\fP, grn_table_cursor\fI\ *tc\fP, grn_obj\fI\ *index\fP, grn_id\fI\ rid_min\fP, grn_id\fI\ rid_max\fP, int\fI\ flags\fP)
+\fBgrn_table_cursor\fP から取得できるそれぞれのレコードについて、 \fBGRN_OBJ_COLUMN_INDEX\fP 型のカラムの値を順番に取り出すためのカーソルを生成して返します。
+.sp
+rid_min, rid_maxを指定して取得するレコードidの値を制限することができます。
+.sp
+戻り値であるgrn_index_cursorは \fBgrn_obj_close()\fP を使って解放します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtc\fP \-\- 対象cursorを指定します。
+.IP \(bu 2
+\fBindex\fP \-\- 対象インデックスカラムを指定します。
+.IP \(bu 2
+\fBrid_min\fP \-\- 出力するレコードidの下限を指定します。
+.IP \(bu 2
+\fBrid_max\fP \-\- 出力するレコードidの上限を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_posting *grn_index_cursor_next(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *ic\fP, grn_id\fI\ *tid\fP)
+cursorの範囲内のインデックスの値を順番に取り出します。
+.sp
+tidにNULL以外を指定した場合は、index_cursorを作成するときに指定したtable_cursorの現在の対象レコードのidを返します。
+.sp
+戻り値である \fBgrn_posting\fP 構造体は解放する必要はありません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBic\fP \-\- 対象cursorを指定します。
+.IP \(bu 2
+\fBtid\fP \-\- テーブルレコードIDを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_info\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_info_type
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_obj_get_info(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_info_type\fI\ type\fP, grn_obj\fI\ *valuebuf\fP)
+objのtypeに対応する情報をvaluebufに格納します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objを指定します。
+.IP \(bu 2
+\fBtype\fP \-\- 取得する情報の種類を指定します。
+.IP \(bu 2
+\fBvaluebuf\fP \-\- 値を格納するバッファ（呼出側で準備）を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_set_info(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_info_type\fI\ type\fP, grn_obj\fI\ *value\fP)
+objのtypeに対応する情報をvalueの内容に更新します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objを指定します。
+.IP \(bu 2
+\fBtype\fP \-\- 設定する情報の種類を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_obj_get_element_info(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_id\fI\ id\fP, grn_info_type\fI\ type\fP, grn_obj\fI\ *value\fP)
+objのidに対応するレコードの、typeに対応する情報をvaluebufに格納します。呼出側ではtypeに応じて十分なサイズのバッファを確保しなければいけません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objを指定します。
+.IP \(bu 2
+\fBid\fP \-\- 対象IDを指定します。
+.IP \(bu 2
+\fBtype\fP \-\- 取得する情報の種類を指定します。
+.IP \(bu 2
+\fBvalue\fP \-\- 値を格納するバッファ（呼出側で準備）を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_set_element_info(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_id\fI\ id\fP, grn_info_type\fI\ type\fP, grn_obj\fI\ *value\fP)
+objのidに対応するレコードのtypeに対応する情報をvalueの内容に更新します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBid\fP \-\- 対象IDを指定します。
+.IP \(bu 2
+\fBtype\fP \-\- 設定する情報の種類を指定します。
+.IP \(bu 2
+\fBvalue\fP \-\- 設定しようとする値を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_match_escalation\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B long long int grn_ctx_get_match_escalation_threshold(grn_ctx\fI\ *ctx\fP)
+検索の挙動をエスカレーションする閾値を返します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_ctx_set_match_escalation_threshold(grn_ctx\fI\ *ctx\fP, long long int\fI\ threshold\fP)
+検索の挙動をエスカレーションする閾値を変更します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBthreshold\fP \-\- 変更後の検索の挙動をエスカレーションする閾値を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B long long int grn_get_default_match_escalation_threshold(void)
+デフォルトの検索の挙動をエスカレーションする閾値を返します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_set_default_match_escalation_threshold(long long int\fI\ threshold\fP)
+デフォルトの検索の挙動をエスカレーションする閾値を変更します。エスカレーションの詳細は詳細は検索の仕様に関するドキュメントを参照してください。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBthreshold\fP \-\- 変更後のデフォルトの検索の挙動をエスカレーションする閾値を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_obj\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_obj
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_obj_column(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP)
+nameがカラム名の場合、それに対応するtableのカラムを返します。対応するカラムが存在しなければNULLを返します。
+.sp
+nameはアクセサ文字列の場合、それに対応するaccessorを返します。アクセサ文字列とは、カラム名等を\(aq.\(aqで連結した文字列です。\(aq_id\(aq, \(aq_key\(aqは特殊なアクセサで、それぞれレコードID/keyを返します。例) \(aqcol1\(aq / \(aqcol2.col3\(aq / \(aqcol2._id\(aq
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBname\fP \-\- カラム名を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_bool grn_obj_is_builtin(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+Check whether groonga built\-in object.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBctx\fP \-\- context
+.IP \(bu 2
+\fBobj\fP \-\- target object
+.UNINDENT
+.TP
+.B Returns
+\fBGRN_TRUE\fP for built\-in groonga object, \fBGRN_FALSE\fP otherwise.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_obj_get_value(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_id\fI\ id\fP, grn_obj\fI\ *value\fP)
+objのIDに対応するレコードのvalueを取得します。valueを戻り値として返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBid\fP \-\- 対象レコードのIDを指定します。
+.IP \(bu 2
+\fBvalue\fP \-\- 値を格納するバッファ（呼出側で準備する）を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_obj_get_values(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_id\fI\ offset\fP, void\fI\ **values\fP)
+objに指定されたカラムについて、offsetに指定されたレコードIDを開始位置として、IDが連続するレコードに対応するカラム値が昇順に格納された配列へのポインタをvaluesにセットします。
+.sp
+取得できた件数が戻り値として返されます。エラーが発生した場合は \-1 が返されます。
+.sp
+\fBNOTE:\fP
+.INDENT 7.0
+.INDENT 3.5
+値が固定長であるカラムのみがobjに指定できます。範囲内のIDに対応するレコードが有効であるとは限りません。delete操作を実行したことのあるテーブルに対しては、\fBgrn_table_at()\fP などによって各レコードの存否を別途確認しなければなりません。
+.UNINDENT
+.UNINDENT
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBoffset\fP \-\- 値を取得する範囲の開始位置となるレコードIDを指定します。
+.IP \(bu 2
+\fBvalues\fP \-\- 値の配列がセットされます。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_set_value(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_id\fI\ id\fP, grn_obj\fI\ *value\fP, int\fI\ flags\fP)
+objのIDに対応するレコードの値を更新します。対応するレコードが存在しない場合は \fBGRN_INVALID_ARGUMENT\fP を返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBid\fP \-\- 対象レコードのIDを指定します。
+.IP \(bu 2
+\fBvalue\fP \-\- 格納する値を指定します。
+.IP \(bu 2
+\fBflags\fP \-\- 
+.sp
+以下のいずれかの形式が使用できます。
+.INDENT 2.0
+.INDENT 2.0
+.IP \(bu 2
+\fBGRN_OBJ_SET\fP
+.IP \(bu 2
+\fBGRN_OBJ_INCR\fP
+.IP \(bu 2
+\fBGRN_OBJ_DECR\fP
+.UNINDENT
+.INDENT 2.0
+.IP \(bu 2
+\fBGRN_OBJ_APPEND\fP
+.IP \(bu 2
+\fBGRN_OBJ_PREPEND\fP
+.IP \(bu 2
+\fBGRN_OBJ_GET\fP
+.UNINDENT
+.INDENT 2.0
+.IP \(bu 2
+\fBGRN_OBJ_COMPARE\fP
+.IP \(bu 2
+\fBGRN_OBJ_LOCK\fP
+.IP \(bu 2
+\fBGRN_OBJ_UNLOCK\fP
+.UNINDENT
+.UNINDENT
+
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_SET_MASK
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_SET
+レコードの値をvalueと置き換えます。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_INCR
+レコードの値にvalueを加算します。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_DECR
+レコードの値にvalueを減算します。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_APPEND
+レコードの値の末尾にvalueを追加します。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_PREPEND
+レコードの値の先頭にvalueを追加します。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_GET
+新しいレコードの値をvalueにセットします。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_COMPARE
+レコードの値とvalueが等しいか調べます。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_LOCK
+当該レコードをロックします。\fBGRN_OBJ_COMPARE\fP と共に指定された場合は、レコードの値とvalueが等しい場合に限ってロックします。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B GRN_OBJ_UNLOCK
+当該レコードのロックを解除します。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_remove(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+objをメモリから解放し、それが永続オブジェクトであった場合は、該当するファイル一式を削除します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_rename(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP)
+ctxが使用するdbにおいてobjに対応する名前をnameに更新します。objは永続オブジェクトでなければいけません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBname\fP \-\- 新しい名前を指定します。
+.IP \(bu 2
+\fBname_size\fP \-\- nameパラメータのsize（byte）を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_close(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+一時的なobjectであるobjをメモリから解放します。objに属するobjectも再帰的にメモリから解放されます。
+.sp
+永続的な、table, column, exprなどは解放してはいけません。一般的には、一時的か永続的かを気にしなくてよい \fBgrn_obj_unlink()\fP を用いるべきです。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_reinit(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_id\fI\ domain\fP, unsigned char\fI\ flags\fP)
+objの型を変更します。
+.sp
+objは \fBGRN_OBJ_INIT()\fP マクロなどで初期化済みでなければいけません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBdomain\fP \-\- 変更後のobjの型を指定します。
+.IP \(bu 2
+\fBflags\fP \-\- \fBGRN_OBJ_VECTOR\fP を指定するとdomain型の値のベクタを格納するオブジェクトになります。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void grn_obj_unlink(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+objをメモリから解放します。objに属するobjectも再帰的にメモリから解放されます。
+.UNINDENT
+.INDENT 0.0
+.TP
+.B const char *grn_obj_path(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+objに対応するファイルパスを返します。一時objectならNULLを返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_obj_name(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, char\fI\ *namebuf\fP, int\fI\ buf_size\fP)
+objの名前の長さを返します。無名objectなら0を返します。
+.sp
+名前付きのobjectであり、buf_sizeの長さが名前の長以上であった場合は、namebufに該当する名前をコピーします。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBnamebuf\fP \-\- 名前を格納するバッファ（呼出側で準備する）を指定します。
+.IP \(bu 2
+\fBbuf_size\fP \-\- namebufのサイズ（byte長）を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_id grn_obj_get_range(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+objパラメータのとる値の範囲を表わしているオブジェクトのIDを返します。例えば、\fBgrn_builtin_type\fP にある \fBGRN_DB_INT\fP などを返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_obj_expire(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, int\fI\ threshold\fP)
+objの占有するメモリのうち、可能な領域をthresholdを指標として解放します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_obj_check(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+objに対応するファイルの整合性を検査します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_lock(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_id\fI\ id\fP, int\fI\ timeout\fP)
+objをlockします。timeout（秒）経過してもlockを取得できない場合は \fBGRN_RESOURCE_DEADLOCK_AVOIDED\fP を返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_unlock(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_id\fI\ id\fP)
+objをunlockします。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_clear_lock(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+強制的にロックをクリアします。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B unsigned int grn_obj_is_locked(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+objが現在lockされていれば0以外の値を返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_obj_defrag(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, int\fI\ threshold\fP)
+objの占有するDBファイル領域のうち、可能な領域をthresholdを指標としてフラグメントの解消を行います。
+.sp
+フラグメント解消が実行されたセグメントの数を返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_id grn_obj_id(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+objのidを返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_delete_by_id(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *db\fP, grn_id\fI\ id\fP, grn_bool\fI\ removep\fP)
+dbからidに対応するテーブルやカラムなどを削除します。mroonga向けに用意した内部APIです。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBdb\fP \-\- The target database.
+.IP \(bu 2
+\fBid\fP \-\- The object (table, column and so on) ID to be deleted.
+.IP \(bu 2
+\fBremovep\fP \-\- If \fBGRN_TRUE\fP, clear object cache and remove relation between ID and key in database. Otherwise, just clear object cache.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_path_by_id(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *db\fP, grn_id\fI\ id\fP, char\fI\ *buffer\fP)
+dbのidに対応するpathを返します。mroonga向けに用意した内部APIです。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBdb\fP \-\- The target database.
+.IP \(bu 2
+\fBid\fP \-\- The object (table, column and so on) ID to be deleted.
+.IP \(bu 2
+\fBbuffer\fP \-\- path string corresponding to the id will be set in this buffer.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_proc\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_proc_type
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_proc_func
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_proc_create(grn_ctx\fI\ *ctx\fP, const char\fI\ *name\fP, int\fI\ name_size\fP, grn_proc_type\fI\ type\fP, grn_proc_func\fI\ *init\fP, grn_proc_func\fI\ *next\fP, grn_proc_func\fI\ *fin\fP, unsigned int\fI\ nvars\fP, grn_expr_var\fI\ *vars\fP)
+nameに対応する新たなproc(手続き)をctxが使用するdbに定義します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBname\fP \-\- 作成するprocの名前を指定します。
+.IP \(bu 2
+\fBname_size\fP \-\- The number of bytes of name parameter. If negative value is specified, name parameter is assumed that NULL\-terminated string.
+.IP \(bu 2
+\fBtype\fP \-\- procの種類を指定します。
+.IP \(bu 2
+\fBinit\fP \-\- 初期化関数のポインタを指定します。
+.IP \(bu 2
+\fBnext\fP \-\- 実処理関数のポインタを指定します。
+.IP \(bu 2
+\fBfin\fP \-\- 終了関数のポインタを指定します。
+.IP \(bu 2
+\fBnvars\fP \-\- procで使用する変数の数を指定します。
+.IP \(bu 2
+\fBvars\fP \-\- procで使用する変数の定義を指定します。( \fBgrn_expr_var\fP 構造体の配列)
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_obj *grn_proc_get_info(grn_ctx\fI\ *ctx\fP, grn_user_data\fI\ *user_data\fP, grn_expr_var\fI\ **vars\fP, unsigned int\fI\ *nvars\fP, grn_obj\fI\ **caller\fP)
+user_dataをキーとして、現在実行中の \fBgrn_proc_func\fP 関数および定義されている変数( \fBgrn_expr_var\fP )の配列とその数を取得します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBuser_data\fP \-\- \fBgrn_proc_func\fP に渡されたuser_dataを指定します。
+.IP \(bu 2
+\fBnvars\fP \-\- 変数の数を取得します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_set_finalizer(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_proc_func\fI\ *func\fP)
+objectを破棄するときに呼ばれる関数を設定します。
+.sp
+table, column, proc, exprのみ設定可能です。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 対象objectを指定します。
+.IP \(bu 2
+\fBfunc\fP \-\- objectを破棄するときに呼ばれる関数を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_search\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_search_optarg
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_obj_search(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP, grn_obj\fI\ *query\fP, grn_obj\fI\ *res\fP, grn_operator\fI\ op\fP, grn_search_optarg\fI\ *optarg\fP)
+objを対象としてqueryにマッチするレコードを検索し、opの指定に従ってresにレコードを追加あるいは削除します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBobj\fP \-\- 検索対象のobjectを指定します。
+.IP \(bu 2
+\fBquery\fP \-\- 検索クエリを指定します。
+.IP \(bu 2
+\fBres\fP \-\- 検索結果を格納するテーブルを指定します。
+.IP \(bu 2
+\fBop\fP \-\- \fBGRN_OP_OR\fP, \fBGRN_OP_AND\fP, \fBGRN_OP_AND_NOT\fP, \fBGRN_OP_ADJUST\fP のいずれかを指定します。
+.IP \(bu 2
+\fBoptarg\fP \-\- 詳細検索条件を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_table\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_obj *grn_table_create(grn_ctx\fI\ *ctx\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP, const char\fI\ *path\fP, grn_obj_flags\fI\ flags\fP, grn_obj\fI\ *key_type\fP, grn_obj\fI\ *value_type\fP)
+nameパラメータに対応する新たなtableをctxが使用するdbに定義します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBname\fP \-\- 
+.sp
+作成するtableの名前を指定します。NULLなら無名tableとなります。
+.sp
+persistent dbに対して名前をありのtableを作成するときには、flagsに \fBGRN_OBJ_PERSISTENT\fP が指定されていなけれなりません。
+
+.IP \(bu 2
+\fBpath\fP \-\- 作成するtableのファイルパスを指定します。
+flagsに \fBGRN_OBJ_PERSISTENT\fP が指定されている場合のみ有効です。
+NULLなら自動的にファイルパスが付与されます。
+.IP \(bu 2
+\fBflags\fP \-\- 
+.sp
+\fBGRN_OBJ_PERSISTENT\fP を指定すると永続tableとなります。
+.sp
+\fBGRN_OBJ_TABLE_PAT_KEY\fP, \fBGRN_OBJ_TABLE_HASH_KEY\fP, \fBGRN_OBJ_TABLE_NO_KEY\fP のいずれかを指定します。
+.sp
+\fBGRN_OBJ_KEY_NORMALIZE\fP を指定すると正規化された文字列がkeyとなります。
+.sp
+\fBGRN_OBJ_KEY_WITH_SIS\fP を指定するとkey文字列の全suffixが自動的に登録されます。
+
+.IP \(bu 2
+\fBkey_type\fP \-\- 
+.sp
+keyの型を指定します。\fBGRN_OBJ_TABLE_NO_KEY\fP が指定された場合は無効です。
+既存のtypeあるいはtableを指定できます。
+.sp
+key_typeにtable Aを指定してtable Bを作成した場合、Bは必ずAのサブセットとなります。
+
+.IP \(bu 2
+\fBvalue_type\fP \-\- keyに対応する値を格納する領域の型を指定します。
+tableはcolumnとは別に、keyに対応する値を格納する領域を一つだけ持つことができます。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_id grn_table_add(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const void\fI\ *key\fP, unsigned int\fI\ key_size\fP, int\fI\ *added\fP)
+keyに対応する新しいrecordをtableに追加し、そのIDを返します。keyに対応するrecordがすでにtableに存在するならば、そのrecordのIDを返します。
+.sp
+\fBGRN_OBJ_TABLE_NO_KEY\fP が指定されたtableでは、key, key_size は無視されます。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBkey\fP \-\- 検索keyを指定します。
+.IP \(bu 2
+\fBadded\fP \-\- NULL以外の値が指定された場合、新たにrecordが追加された時には1が、既存recordだった時には0がセットされます。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_id grn_table_get(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const void\fI\ *key\fP, unsigned int\fI\ key_size\fP)
+It finds a record that has key parameter and returns ID of the found record. If table parameter is a database, it finds an object (table, column and so on) that has key parameter  and returns ID of the found object.
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- The table or database.
+.IP \(bu 2
+\fBkey\fP \-\- The record or object key to be found.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_id grn_table_at(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, grn_id\fI\ id\fP)
+tableにidに対応するrecordが存在するか確認し、存在すれば指定されたIDを、存在しなければ \fBGRN_ID_NIL\fP を返します。
+.sp
+注意: 実行には相応のコストがかかるのであまり頻繁に呼ばないようにして下さい。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBid\fP \-\- 検索idを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_id grn_table_lcp_search(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const void\fI\ *key\fP, unsigned int\fI\ key_size\fP)
+tableが \fBGRN_TABLE_PAT_KEY\fP もしくは \fBGRN_TABLE_DAT_KEY\fP を指定して作ったtableなら、longest common prefix searchを行い、対応するIDを返します。
+.sp
+tableが \fBGRN_TABLE_HASH_KEY\fP を指定して作ったtableなら、完全に一致するキーを検索し、対応するIDを返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBkey\fP \-\- 検索keyを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_table_get_key(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, grn_id\fI\ id\fP, void\fI\ *keybuf\fP, int\fI\ buf_size\fP)
+tableのIDに対応するレコードのkeyを取得します。
+.sp
+対応するレコードが存在する場合はkey長を返します。見つからない場合は0を返します。対応するキーの検索に成功し、またbuf_sizeの長さがkey長以上であった場合は、keybufに該当するkeyをコピーします。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBid\fP \-\- 対象レコードのIDを指定します。
+.IP \(bu 2
+\fBkeybuf\fP \-\- keyを格納するバッファ(呼出側で準備する)を指定します。
+.IP \(bu 2
+\fBbuf_size\fP \-\- keybufのサイズ(byte長)を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_table_delete(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const void\fI\ *key\fP, unsigned int\fI\ key_size\fP)
+tableのkeyに対応するレコードを削除します。対応するレコードが存在しない場合は \fBGRN_INVALID_ARGUMENT\fP を返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBkey\fP \-\- 検索keyを指定します。
+.IP \(bu 2
+\fBkey_size\fP \-\- 検索keyのサイズを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_table_delete_by_id(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, grn_id\fI\ id\fP)
+tableのidに対応するレコードを削除します。対応するレコードが存在しない場合は \fBGRN_INVALID_ARGUMENT\fP を返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBid\fP \-\- レコードIDを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_table_update_by_id(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, grn_id\fI\ id\fP, const void\fI\ *dest_key\fP, unsigned int\fI\ dest_key_size\fP)
+tableのidに対応するレコードのkeyを変更します。新しいkeyとそのbyte長をdest_keyとdest_key_sizeに指定します。
+.sp
+この操作は、\fBGRN_TABLE_DAT_KEY\fP 型のテーブルのみ使用できます。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBid\fP \-\- レコードIDを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_table_update(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const void\fI\ *src_key\fP, unsigned int\fI\ src_key_size\fP, const void\fI\ *dest_key\fP, unsigned int\fI\ dest_key_size\fP)
+tableのsrc_keyに対応するレコードのkeyを変更します。新しいkeyとそのbyte長をdest_keyとdest_key_sizeに指定します。
+.sp
+この操作は、\fBGRN_TABLE_DAT_KEY\fP 型のテーブルのみ使用できます。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBsrc_key\fP \-\- 対象レコードのkeyを指定します。
+.IP \(bu 2
+\fBsrc_key_size\fP \-\- 対象レコードのkeyの長さ(byte)を指定します。
+.IP \(bu 2
+\fBdest_key\fP \-\- 変更後のkeyを指定します。
+.IP \(bu 2
+\fBdest_key_size\fP \-\- 変更後のkeyの長さ(byte)を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_table_truncate(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP)
+tableの全レコードを一括して削除します。
+.sp
+注意: multithread環境では他のthreadのアクセスによって、存在しないアドレスへアクセスし、SIGSEGVが発生する可能性があります。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_table_sort_key
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_table_sort_flags
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_table_sort(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, int\fI\ offset\fP, int\fI\ limit\fP, grn_obj\fI\ *result\fP, grn_table_sort_key\fI\ *keys\fP, int\fI\ n_keys\fP)
+table内のレコードをソートし、上位limit個の要素をresultに格納します。
+.sp
+keys.keyには、tableのcolumn,accessor,procのいずれかが指定できます。keys.flagsには、\fBGRN_TABLE_SORT_ASC\fP / \fBGRN_TABLE_SORT_DESC\fP のいずれかを指定できます。\fBGRN_TABLE_SORT_ASC\fP では昇順、\fBGRN_TABLE_SORT_DESC\fP では降順でソートされます。keys.offsetは、内部利用のためのメンバです。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBoffset\fP \-\- sortされたレコードのうち、(0ベースで)offset番目から順にresにレコードを格納します。
+.IP \(bu 2
+\fBlimit\fP \-\- resに格納するレコードの上限を指定します。
+.IP \(bu 2
+\fBresult\fP \-\- 結果を格納するtableを指定します。
+.IP \(bu 2
+\fBkeys\fP \-\- ソートキー配列へのポインタを指定します。
+.IP \(bu 2
+\fBn_keys\fP \-\- ソートキー配列のサイズを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_table_group_result
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_table_group_flags
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_table_group(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, grn_table_sort_key\fI\ *keys\fP, int\fI\ n_keys\fP, grn_table_group_result\fI\ *results\fP, int\fI\ n_results\fP)
+tableのレコードを特定の条件でグループ化します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBkeys\fP \-\- group化キー構造体の配列へのポインタを指定します。
+.IP \(bu 2
+\fBn_keys\fP \-\- group化キー構造体の配列のサイズを指定します。
+.IP \(bu 2
+\fBresults\fP \-\- group化の結果を格納する構造体の配列へのポインタを指定します。
+.IP \(bu 2
+\fBn_results\fP \-\- group化の結果を格納する構造体の配列のサイズを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_table_setoperation(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table1\fP, grn_obj\fI\ *table2\fP, grn_obj\fI\ *res\fP, grn_operator\fI\ op\fP)
+table1とtable2をopの指定に従って集合演算した結果をresに格納します。
+.sp
+resにtable1あるいはtable2そのものを指定した場合を除けば、table1, table2は破壊されません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable1\fP \-\- 対象table1を指定します。
+.IP \(bu 2
+\fBtable2\fP \-\- 対象table2を指定します。
+.IP \(bu 2
+\fBres\fP \-\- 結果を格納するtableを指定します。
+.IP \(bu 2
+\fBop\fP \-\- 実行する演算の種類を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_table_difference(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table1\fP, grn_obj\fI\ *table2\fP, grn_obj\fI\ *res1\fP, grn_obj\fI\ *res2\fP)
+table1とtable2から重複するレコードを取り除いた結果をそれぞれres1, res2に格納します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable1\fP \-\- 対象table1を指定します。
+.IP \(bu 2
+\fBtable2\fP \-\- 対象table2を指定します。
+.IP \(bu 2
+\fBres1\fP \-\- 結果を格納するtableを指定します。
+.IP \(bu 2
+\fBres2\fP \-\- 結果を格納するtableを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B int grn_table_columns(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP, grn_obj\fI\ *res\fP)
+nameパラメータから始まるtableのカラムIDをresパラメータに格納します。name_sizeパラメータが0の場合はすべてのカラムIDを格納します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBname\fP \-\- 取得したいカラム名のprefixを指定します。
+.IP \(bu 2
+\fBname_size\fP \-\- nameパラメータの長さを指定します。
+.IP \(bu 2
+\fBres\fP \-\- 結果を格納する \fBGRN_TABLE_HASH_KEY\fP のtableを指定します。
+.UNINDENT
+.TP
+.B Returns
+格納したカラムIDの数を返します。
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B unsigned int grn_table_size(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP)
+tableに登録されているレコードの件数を返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_rc grn_table_rename(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP)
+ctxが使用するdbにおいてtableに対応する名前をnameに更新します。tableの全てのcolumnも同時に名前が変更されます。tableは永続オブジェクトでなければいけません。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBname_size\fP \-\- nameパラメータのsize(byte)を指定します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_table_cursor\fP
+.SS Summary
+.sp
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
+.INDENT 0.0
+.TP
+.B grn_table_cursor
+TODO...
+.UNINDENT
+.INDENT 0.0
+.TP
+.B grn_table_cursor *grn_table_cursor_open(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *table\fP, const void\fI\ *min\fP, unsigned int\fI\ min_size\fP, const void\fI\ *max\fP, unsigned int\fI\ max_size\fP, int\fI\ offset\fP, int\fI\ limit\fP, int\fI\ flags\fP)
+tableに登録されているレコードを順番に取り出すためのカーソルを生成して返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtable\fP \-\- 対象tableを指定します。
+.IP \(bu 2
+\fBmin\fP \-\- keyの下限を指定します。（NULLは下限なしと見なします。） \fBGRN_CURSOR_PREFIX\fP については後述。
+.IP \(bu 2
+\fBmin_size\fP \-\- minのsizeを指定します。\fBGRN_CURSOR_PREFIX\fP については後述。
+.IP \(bu 2
+\fBmax\fP \-\- keyの上限を指定します。（NULLは上限なしと見なします。） \fBGRN_CURSOR_PREFIX\fP については後述。
+.IP \(bu 2
+\fBmax_size\fP \-\- maxのsizeを指定します。\fBGRN_CURSOR_PREFIX\fP については無視される場合があります。
+.IP \(bu 2
+\fBflags\fP \-\- 
+.sp
+\fBGRN_CURSOR_ASCENDING\fP を指定すると昇順にレコードを取り出します。
+.sp
+\fBGRN_CURSOR_DESCENDING\fP を指定すると降順にレコードを取り出します。(下記 \fBGRN_CURSOR_PREFIX\fP を指定し、keyが近いレコードを取得する場合、もしくは、common prefix searchを行う場合には、\fBGRN_CURSOR_ASCENDING\fP / \fBGRN_CURSOR_DESCENDING\fP は無視されます。)
+.sp
+\fBGRN_CURSOR_GT\fP を指定するとminに一致したkeyをcursorの範囲に含みません。(minがNULLの場合もしくは、下記 \fBGRN_CURSOR_PREFIX\fP を指定し、keyが近いレコードを取得する場合、もしくは、common prefix searchを行う場合には、\fBGRN_CURSOR_GT\fP は無視されます。)
+.sp
+\fBGRN_CURSOR_LT\fP を指定するとmaxに一致したkeyをcursorの範囲に含みません。(maxがNULLの場合もしくは、下記 \fBGRN_CURSOR_PREFIX\fP を指定した場合には、\fBGRN_CURSOR_LT\fP は無視されます。)
+.sp
+\fBGRN_CURSOR_BY_ID\fP を指定するとID順にレコードを取り出します。(下記 \fBGRN_CURSOR_PREFIX\fP を指定した場合には、\fBGRN_CURSOR_BY_ID\fP は無視されます。) \fBGRN_OBJ_TABLE_PAT_KEY\fP を指定したtableについては、\fBGRN_CURSOR_BY_KEY\fP を指定するとkey順にレコードを取り出します。( \fBGRN_OBJ_TABLE_HASH_KEY\fP , \fBGRN_OBJ_TABLE_NO_KEY\fP を指定したテーブルでは \fBGRN_CURSOR_BY_KEY\fP は無視されます。)
+.sp
+\fBGRN_CURSOR_PREFIX\fP を指定すると、 \fBGRN_OBJ_TABLE_PAT_KEY\fP を指定したテーブルに関する下記のレコードを取り出すカーソルが作成されます。maxがNULLの場合には、keyがminと前方一致するレコードを取り出します。max_sizeパラメータは無視されます。
+.sp
+maxとmax_sizeが指定され、かつ、テーブルのkeyがShortText型である場合、maxとcommon prefix searchを行い、common prefixがmin_sizeバイト以上のレコードを取り出します。minは無視されます。
+.sp
+maxとmax_sizeが指定され、かつ、テーブルのkeyが固定長型の場合、maxとPAT木上で近い位置にあるノードから順番にレコードを取り出します。ただし、keyのパトリシア木で、min_sizeバイト未満のビットに対するノードで、maxと異なった方向にあるノードに対応するレコードについては取り出しません。PAT木上で位置が近いこととkeyの値が近いことは同一ではありません。この場合、maxで与えられるポインタが指す値は、対象テーブルのkeyサイズと同じか超える幅である必要があります。minは無視されます。
+.sp
+\fBGRN_CURSOR_BY_ID\fP / \fBGRN_CURSOR_BY_KEY\fP / \fBGRN_CURSOR_PREFIX\fP の3フラグは、同時に指定することができません。
+.sp
+\fBGRN_OBJ_TABLE_PAT_KEY\fP を指定して作ったテーブルで、\fBGRN_CURSOR_PREFIX\fP と \fBGRN_CURSOR_RK\fP を指定すると、半角小文字のアルファベット文字列から、それを旧JIS X 4063:2000規格に従って全角カタカナに変換した文字列に前方一致する値をkeyとするレコードを取り出します。\fBGRN_ENC_UTF8\fP のみをサポートしています。\fBGRN_CURSOR_ASCENDING\fP / \fBGRN_CURSOR_DESCENDING\fP は無効であり、レコードをkey値の昇降順で取り出すことはできません。
+
+.IP \(bu 2
+\fBoffset\fP \-\- 
+.sp
+該当する範囲のレコードのうち、(0ベースで)offset番目からレコードを取り出します。
+.sp
+\fBGRN_CURSOR_PREFIX\fP を指定したときは負の数を指定することはできません。
+
+.IP \(bu 2
+\fBlimit\fP \-\- 
+.sp
+該当する範囲のレコードのうち、limit件のみを取り出します。\-1が指定された場合は、全件が指定されたものとみなします。
 .sp
-.nf
-.ft C
-2011\-07\-05 06:25:18.345734
-.ft P
-.fi
+\fBGRN_CURSOR_PREFIX\fP を指定したときは\-1より小さい負の数を指定することはできません。
+
+.UNINDENT
 .UNINDENT
 .UNINDENT
+.INDENT 0.0
 .TP
-.B ID
-ID of a thread. Groonga process creates threads to process
-requests concurrently. Each thread outputs some logs for a
-request. This ID can be used to extract a log sequence by
-a thread.
-.sp
-Example:
+.B grn_rc grn_table_cursor_close(grn_ctx\fI\ *ctx\fP, grn_table_cursor\fI\ *tc\fP)
+\fBgrn_table_cursor_open()\fP で生成したcursorを解放します。
 .INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-45ea3034
-.ft P
-.fi
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtc\fP \-\- 対象cursorを指定します。
 .UNINDENT
 .UNINDENT
 .UNINDENT
 .INDENT 0.0
 .TP
-.B >
-A character that indicates query is started.
-.UNINDENT
-.INDENT 0.0
+.B grn_id grn_table_cursor_next(grn_ctx\fI\ *ctx\fP, grn_table_cursor\fI\ *tc\fP)
+cursorのカレントレコードを一件進めてそのIDを返します。cursorの対象範囲の末尾に達すると \fBGRN_ID_NIL\fP を返します。
+.INDENT 7.0
 .TP
-.B :
-A character that indicates query is processing.
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtc\fP \-\- 対象cursorを指定します。
+.UNINDENT
+.UNINDENT
 .UNINDENT
 .INDENT 0.0
 .TP
-.B <
-A character that indicates query is finished.
+.B int grn_table_cursor_get_key(grn_ctx\fI\ *ctx\fP, grn_table_cursor\fI\ *tc\fP, void\fI\ **key\fP)
+cursorのカレントレコードのkeyをkeyパラメータにセットし、その長さを返します。
+.INDENT 7.0
 .TP
-.B MESSAGE
-Details about the log with free format.
-.sp
-Example:
+.B Parameters
 .INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-query log opened.
-.ft P
-.fi
+.IP \(bu 2
+\fBtc\fP \-\- 対象cursorを指定します。
+.IP \(bu 2
+\fBkey\fP \-\- カレントレコードのkeyへのポインタがセットされます。
 .UNINDENT
 .UNINDENT
+.UNINDENT
+.INDENT 0.0
 .TP
-.B QUERY
-A query to be processed.
-.sp
-Example:
+.B int grn_table_cursor_get_value(grn_ctx\fI\ *ctx\fP, grn_table_cursor\fI\ *tc\fP, void\fI\ **value\fP)
+cursorパラメータのカレントレコードのvalueをvalueパラメータにセットし、その長さを返します。
 .INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-select users \-\-match_columns hobby \-\-query music
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
 .TP
-.B ELAPSED_TIME
-Elapsed time in nanoseconds since query is started.
-.sp
-Example:
+.B Parameters
 .INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-000000000075770
-(It means 75,770 nanoseconds.)
-.ft P
-.fi
+.IP \(bu 2
+\fBtc\fP \-\- 対象cursorを指定します。
+.IP \(bu 2
+\fBvalue\fP \-\- カレントレコードのvalueへのポインタがセットされます。
 .UNINDENT
 .UNINDENT
+.UNINDENT
+.INDENT 0.0
 .TP
-.B PROGRESS
-A processed work at the time.
-.sp
-Example:
+.B grn_rc grn_table_cursor_set_value(grn_ctx\fI\ *ctx\fP, grn_table_cursor\fI\ *tc\fP, const void\fI\ *value\fP, int\fI\ flags\fP)
+cursorのカレントレコードのvalueを引数の内容に置き換えます。cursorのカレントレコードが存在しない場合は \fBGRN_INVALID_ARGUMENT\fP を返します。
 .INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-select(313401)
-(It means that \(aqselect\(aq is processed and 313,401 records are remained.)
-.ft P
-.fi
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtc\fP \-\- 対象cursorを指定します。
+.IP \(bu 2
+\fBvalue\fP \-\- 新しいvalueの値を指定します。
+.IP \(bu 2
+\fBflags\fP \-\- \fBgrn_obj_set_value()\fP のflagsと同様の値を指定できます。
 .UNINDENT
 .UNINDENT
+.UNINDENT
+.INDENT 0.0
 .TP
-.B RETURN_CODE
-A return code for the query.
-.sp
-Example:
+.B grn_rc grn_table_cursor_delete(grn_ctx\fI\ *ctx\fP, grn_table_cursor\fI\ *tc\fP)
+cursorのカレントレコードを削除します。cursorのカレントレコードが存在しない場合は \fBGRN_INVALID_ARGUMENT\fP を返します。
 .INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-rc=0
-(It means return code is 0. 0 means GRN_SUCCESS.)
-.ft P
-.fi
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtc\fP \-\- 対象cursorを指定します。
 .UNINDENT
 .UNINDENT
 .UNINDENT
-.sp
-Example:
 .INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-2011\-07\-05 06:25:19.458756|45ea3034|>select Properties \-\-limit 0
-2011\-07\-05 06:25:19.458829|45ea3034|:000000000072779 select(19)
-2011\-07\-05 06:25:19.458856|45ea3034|:000000000099998 output(0)
-2011\-07\-05 06:25:19.458875|45ea3034|<000000000119062 rc=0
-2011\-07\-05 06:25:19.458986|45ea3034|>quit
-.ft P
-.fi
+.TP
+.B grn_obj *grn_table_cursor_table(grn_ctx\fI\ *ctx\fP, grn_table_cursor\fI\ *tc\fP)
+cursorが属するtableを返します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
+.IP \(bu 2
+\fBtc\fP \-\- 対象cursorを指定します。
 .UNINDENT
 .UNINDENT
-.SS API
-.sp
-Groonga can be used as a fulltext search library. This section
-describes APIs that are provided by groonga.
-.SS \fBgrn_ctx\fP
+.UNINDENT
+.SS \fBgrn_type\fP
 .SS Summary
 .sp
-\fBgrn_ctx\fP is the most important object. \fBgrn_ctx\fP
-keeps the current infomation such as:
+TODO...
+.SS Example
+.sp
+TODO...
+.SS Reference
 .INDENT 0.0
-.IP \(bu 2
-The last occurred error.
-.IP \(bu 2
-The current encoding.
-.IP \(bu 2
-The default thresholds. (e.g. \fImatch\-escalation\-threshold\fP)
-.IP \(bu 2
-The default command version. (See \fB/reference/command/command_version\fP)
+.TP
+.B grn_builtin_type
+TODO...
 .UNINDENT
-.sp
-\fBgrn_ctx\fP provides platform features such as:
 .INDENT 0.0
+.TP
+.B grn_obj *grn_type_create(grn_ctx\fI\ *ctx\fP, const char\fI\ *name\fP, unsigned int\fI\ name_size\fP, grn_obj_flags\fI\ flags\fP, unsigned int\fI\ size\fP)
+nameに対応する新たなtype（型）をdbに定義します。
+.INDENT 7.0
+.TP
+.B Parameters
+.INDENT 7.0
 .IP \(bu 2
-Memory management.
+\fBname\fP \-\- 作成するtypeの名前を指定します。
 .IP \(bu 2
-Logging.
+\fBflags\fP \-\- \fBGRN_OBJ_KEY_VAR_SIZE\fP, \fBGRN_OBJ_KEY_FLOAT\fP, \fBGRN_OBJ_KEY_INT\fP, \fBGRN_OBJ_KEY_UINT\fP のいずれかを指定します。
+.IP \(bu 2
+\fBsize\fP \-\- \fBGRN_OBJ_KEY_VAR_SIZE\fP の場合は最大長、それ以外の場合は長さ（単位:byte）を指定します。
 .UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \fBgrn_user_data\fP
+.SS Summary
 .sp
-Most APIs receive \fBgrn_ctx\fP as the first argument.
-.sp
-You can\(aqt use the same \fBgrn_ctx\fP from two or more threads. You
-need to create a \fBgrn_ctx\fP for a thread. You can use two or
-more \fBgrn_ctx\fP in a thread but it is not needed for usual
-use\-case.
+TODO...
 .SS Example
 .sp
 TODO...
 .SS Reference
 .INDENT 0.0
 .TP
-.B grn_ctx
+.B grn_user_data
 TODO...
 .UNINDENT
 .INDENT 0.0
 .TP
-.B grn_rc grn_ctx_init(grn_ctx\fI\ *ctx\fP, int\fI\ flags\fP)
-ctxを初期化します。
+.B grn_user_data *grn_obj_user_data(grn_ctx\fI\ *ctx\fP, grn_obj\fI\ *obj\fP)
+objectに登録できるユーザデータへのポインタを返します。table, column, proc, exprのみ使用可能です。
 .INDENT 7.0
 .TP
 .B Parameters
 .INDENT 7.0
 .IP \(bu 2
-\fBctx\fP \-\- 初期化するctx構造体へのポインタを指定します。
-.IP \(bu 2
-\fBflags\fP \-\- 初期化する \fBctx\fP のオプションを指定します。
+\fBobj\fP \-\- 対象objectを指定します。
 .UNINDENT
-.TP
-.B Returns
-\fBGRN_SUCCESS\fP on success, not \fBGRN_SUCCESS\fP on error.
 .UNINDENT
 .UNINDENT
-.SS grn_expr
-.sp
-TODO...
 .SH SPECIFICATION
 .SS GQTP
 .sp
@@ -26519,6 +29553,13 @@ The maximum index size: 256GBytes
 .UNINDENT
 .sp
 Keep in mind that these limitations may vary depending on conditions.
+.SS Limitations of column
+.sp
+A column has the following limitation.
+.INDENT 0.0
+.IP \(bu 2
+The maximum stored data size of each column: 256GiB
+.UNINDENT
 .SH トラブルシューティング
 .SS 同じ検索キーワードなのに全文検索結果が異なる
 .sp
@@ -26814,12 +29855,12 @@ Here are open source softwares that use groonga on Travis CI:
 \fI\%.travis.yml for nroonga\fP
 .UNINDENT
 .IP \(bu 2
-\fI\%logaling-command\fP (A glossary management command line tool)
+\fI\%logaling\-command\fP (A glossary management command line tool)
 .INDENT 2.0
 .IP \(bu 2
-\fI\%logaling-command on Travis CI\fP
+\fI\%logaling\-command on Travis CI\fP
 .IP \(bu 2
-\fI\%.travis.yml for logaling-command\fP
+\fI\%.travis.yml for logaling\-command\fP
 .UNINDENT
 .UNINDENT
 .UNINDENT
@@ -26908,6 +29949,81 @@ edgeごとにqueueを持つ。
 msgはcomによって、edgeのqueueにenqueueされる。
 edgeがworkerに結びついていないときは、同時に、ctx_newというqueueに、msgをenqueueした対象のedgeをenqueueする。
 .UNINDENT
+.SS ユーザーと協力して開発をうまく進めていくための指針
+.sp
+groongaを使ってくれているユーザーと協力して
+開発をうまく進めていくためにこうするといい、という事柄をまとめました。
+まとめておくと、新しく開発に加わる人とも共有することができます。
+.SS twitter編
+.sp
+groongaを使ってもらえるようにtwitterのアカウントgroongaを取得して
+日々、リリースの案内をしたり、ユーザーサポートをしたりしています。
+.sp
+リリースの案内に利用する場合には、やりとりを考えなくて良いですが、
+複数人によるサポートをgroongaで行う場合に、どうサポートするのが
+良いのか/どうしてそうするのかという共通認識を持っていないと一貫性のないサポートとなってしま
+います。
+.sp
+twitterでサポートされている安心感からgroongaユーザーの拡大に繋げる
+ことができるようにサポートの際に気をつけることをまとめます。
+.SS 過去のツイートはおさらいしておく
+.SS 理由
+.sp
+自分がツイートした内容を把握していない返信をされたら普通いい気はしません。
+.SS 対応
+.sp
+過去のツイートをおさらいし、こうすれば良いという提案をできるのが望ましいです。:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+良い例: ○○だと原因は□□ですね。××すると大丈夫です。
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS こちらから情報を提供する
+.SS 理由
+.sp
+困っているユーザーが複数回ツイートして限られたなかで情報を提供してくれていることがあります。
+その限られたツイートから解決方法が見つかればユーザーにとって余計な手間が少なくて済みます。
+あれこれ情報提供を要求すると、ユーザーはそのぶん確認する作業が必要になります。
+.SS 対応
+.sp
+最初に声をかけるときに解決策を1つか2つ提案できると望ましいです。ユーザーにあまり負担を感じさせないようにすると良いです。:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+良い例: ○○の場合は□□の可能性があるので、××を試してもらえますか？
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS twitterでのやりとりはできるだけ他の場所(例えばredmine)へと誘導しない
+.SS 理由
+.sp
+twitterは気軽につぶやけることが重要なので、気軽にできないことを相手に要求すると萎縮されてしまう可能性があります。
+.sp
+いきなりredmineでバグ報告をお願いすると、しりごみしてしまうかも知れません。:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+駄目な例: 再現手順をMLかredmineに報告してもらえますか?
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+groonga関連で気軽につぶやけないとなると開発者は困っている人を見つけられないし、利用者は困ったままとなるので、双方にとって嬉しくない状態になっ
+てしまいます。
+.SS 対応
+.sp
+twitterでやりとりを完結できるようにします。
 .SS ドキュメント作成
 .SS Sphinxのインストール
 .sp
@@ -27979,7 +31095,7 @@ news.txtに変更点をまとめましたが、それを元にリリースアナ
 .INDENT 3.5
 .INDENT 0.0
 .IP \(bu 2
-\fI\%http://sourceforge.jp/projects/groonga/lists/archive/dev/2012-April/000794.html\fP
+\fI\%http://sourceforge.jp/projects/groonga/lists/archive/dev/2012\-April/000794.html\fP
 .UNINDENT
 .UNINDENT
 .UNINDENT
@@ -28121,14 +31237,35 @@ doc/source以下のドキュメントを更新、翻訳まで完了している
 これによりcloneしておいたgroonga.github.comのdoc/locale以下に更新したドキュメントがコピーされます。
 .sp
 生成されているドキュメントに問題のないことを確認できたら、コミット、pushしてgroonga.orgへと反映します。
+.SS Homebrewの更新
+.sp
+OS Xでのパッケージ管理方法として \fI\%Homebrew\fP があります。
+.sp
+groongaを簡単にインストールできるようにするために、Homebrewへpull requestを送ります。
+.INDENT 0.0
+.INDENT 3.5
+\fI\%https://github.com/mxcl/homebrew\fP
+.UNINDENT
+.UNINDENT
+.sp
+すでにgroongaのFormulaは取り込まれているので、リリースのたびにFormulaの内容を更新する作業を実施します。
+.sp
+groonga 3.0.6のときは以下のように更新してpull requestを送りました。
+.INDENT 0.0
+.INDENT 3.5
+\fI\%https://github.com/mxcl/homebrew/pull/21456/files\fP
+.UNINDENT
+.UNINDENT
+.sp
+上記URLを参照するとわかるようにソースアーカイブのurlとsha1チェックサムを更新します。
 .SS リリースアナウンス
 .sp
 作成したリリースアナウンスをメーリングリストへと流します。
 .INDENT 0.0
 .IP \(bu 2
-groonga\-dev \fI\%groonga-dev@lists.sourceforge.jp\fP
+groonga\-dev \fI\%groonga\-dev@lists.sourceforge.jp\fP
 .IP \(bu 2
-Groonga\-talk \fI\%groonga-talk@lists.sourceforge.net\fP
+Groonga\-talk \fI\%groonga\-talk@lists.sourceforge.net\fP
 .UNINDENT
 .SS freecode.comへリリース情報を登録
 .sp
@@ -28546,7 +31683,7 @@ text. So you can use your favorite editor. Here is a
 specialized editor for .po file edit list.
 .INDENT 0.0
 .TP
-.B Emacs\(aqs \fI\%po-mode\fP
+.B Emacs\(aqs \fI\%po\-mode\fP
 It is bundled in gettext.
 .TP
 .B \fI\%Poedit\fP
@@ -28637,7 +31774,7 @@ button.
 \fBSEE ALSO:\fP
 .INDENT 0.0
 .INDENT 3.5
-\fI\%Help.GitHub - Sending pull requests\fP.
+\fI\%Help.GitHub \- Sending pull requests\fP.
 .UNINDENT
 .UNINDENT
 .SS How to send patch