rroonga 2.0.0-x86-mingw32 → 2.0.1-x86-mingw32

data/vendor/local/share/doc/groonga/en/html/_sources/tutorial/introduction.txt

@@ -8,46 +8,48 @@
 Basic operations
 ================
 
-The groonga package provides a C library (libgroonga) and a command line tool (groonga). This tutorial explains how to use the groonga command, with which you can create/operate databases, start a server, establish a connection with a server, etc.
+A groonga package provides a C library (libgroonga) and a command line tool (groonga). This tutorial explains how to use the command line tool, with which you can create/operate databases, start a server, establish a connection with a server, etc.
 
 Create a database
 -----------------
 
-You can create a new database with the following command.
+The first step to using groonga is to create a new database. The following shows how to do it.
 
 Form::
 
-  groonga -n DB_PATH_NAME
+  groonga -n DB_PATH
 
-The '-n' option specifies to create a new database. DB_PATH_NAME specifies the path of the new database. Note that this command fails if the specified path already exists.
+The `-n` option specifies to create a new database and DB_PATH specifies the path of the new database. Actually, a database consists of a series of files and DB_PATH specifies the file which will be the entrance to the new database. DB_PATH also specifies the path prefix for other files. Note that database creation fails if DB_PATH points to an existing file.
 
-This command creates a database and then enters into interactive mode in which groonga prompts you to enter commands for operating that database. You can terminate this mode with Ctrl-d.
+This command creates a new database and then enters into interactive mode in which groonga prompts you to enter commands for operating that database. You can terminate this mode with Ctrl-d.
 
-Execution example::
+.. groonga-command
+.. include:: ../example/tutorial/introduction-1.log
+.. .. % groonga -n /tmp/groonga-databases/introduction.db
 
-  % groonga -n /tmp/tutorial.db
-  > Ctrl-d
-  %
+After this database creation, you can find a series of files in /tmp/groonga-databases.
 
 Operate a database
 ------------------
 
+The following shows how to operate an existing database.
+
 Form::
 
-  groonga DB_PATH_NAME [COMMAND]
+  groonga DB_PATH [COMMAND]
 
-DB_PATH_NAME specifies the path of a target database.
+DB_PATH specifies the path of a target database. This command fails if the specified database does not exist.
 
-If COMMAND is specified, groonga executes COMMAND and returns the result. Otherwise, groonga starts in interactive mode that reads commands from the standard input and execute them one by one. This tutorial focuses on the interactive mode.
+If COMMAND is specified, groonga executes COMMAND and returns the result. Otherwise, groonga starts in interactive mode that reads commands from the standard input and executes them one by one. This tutorial focuses on the interactive mode.
 
-Let's try to see the status of a groonga process by using a :doc:`/commands/status` command.
+Let's see the status of a groonga process by using a :doc:`/commands/status` command.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-1.log
-.. .. % groonga -n /tmp/groonga-databases/introduction.db
+.. include:: ../example/tutorial/introduction-2.log
+.. .. % groonga /tmp/groonga-databases/introduction.db
 .. status
 
-As shown in the above example, a command basically returns a JSON array. The first element contains an error code, execution time, etc. The second element is the result of an operation.
+As shown in the above example, a command returns a JSON array. The first element contains an error code, execution time, etc. The second element is the result of an operation.
 
 Command format
 --------------
@@ -87,84 +89,54 @@ Basic commands
 Create a table
 --------------
 
-A :doc:`/commands/table_create` command creates a table.
+A :doc:`/commands/table_create` command creates a new table.
 
-In most cases, a table of groonga has a primary key which must be specified with its data type and index type. 
+In most cases, a table has a primary key which must be specified with its data type and index type. 
 
-There are various data types such as integers, floating-point numbers, etc. The index type determines the search performance and the availability of prefix searches. We will explain the details later.
+There are various data types such as integers, strings, etc. See also :doc:`/type` for more details. The index type determines the search performance and the availability of prefix searches. The details will be described later.
 
-Let's create a 'Site' table which has a primary key of ShortText. In this example, the index type is HASH.
+Let's create a table. The following example creates a table with a primary key. The `name` parameter specifies the name of the table. The `flags` parameter specifies the index type for the primary key. The `key_type` parameter specifies the data type of the primary key.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-2.log
+.. include:: ../example/tutorial/introduction-3.log
 .. table_create --name Site --flags TABLE_HASH_KEY --key_type ShortText
 
+The second element of the result indicates that the operation succeeded.
+
 View a table
 ------------
 
-A :doc:`/commands/select` command shows contents of table.
+A :doc:`/commands/select` command can enumerate records in a table.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-3.log
+.. include:: ../example/tutorial/introduction-4.log
 .. select --table Site
 
-When only a table is specified, the 'select' command returns the first (at most) 10 records of that table. "[0]" in the result shows the number of records in the 'Site' table. The next array is a list of columns. ["_id","Uint32"] is a column of UInt32, named "_id". ["_key","ShortText"] is a column of ShortText, named "_key".
+When only a table name is specified with a `table` parameter, a :doc:`/commands/select` command returns the first (at most) 10 records in the table. [0] in the result shows the number of records in the table. The next array is a list of columns. ["_id","Uint32"] is a column of UInt32, named _id. ["_key","ShortText"] is a column of ShortText, named _key.
 
-The above two columns, '_id' and '_key', are the necessary columns. The '_id' column stores IDs those are automatically allocated by groonga. The '_key' column is associated with the primary key. You are not allowed to rename these columns.
+The above two columns, _id and _key, are the necessary columns. The _id column stores IDs those are automatically allocated by groonga. The _key column is associated with the primary key. You are not allowed to rename these columns.
 
 Create a column
 ---------------
 
-A :doc:`/commands/column_create` command adds a column to a table.
-
-Let's add a column of ShortText to store titles. You may give a descriptive name 'title' to the column.
-
-.. groonga-command
-.. include:: ../example/tutorial/introduction-4.log
-.. column_create --table Site --name title --flags COLUMN_SCALAR --type ShortText
-.. select --table Site
-
-The COLUMN_SCALAR flag specifies to add a regular column.
-
-Create a lexicon table for full text searches
----------------------------------------------
-
-Let's go on to how to make a full text search.
-
-Groonga uses an inverted index to provide fast full text search. So, the first step is to create a lexicon table which stores an inverted index, also known as postings lists. The primary key of this table is associated with a vocabulary made up of index terms and each record stores postings lists for one index term.
+A :doc:`/commands/column_create` command creates a new column.
 
-The following shows a command which creates a lexicon table named 'Terms'. The data type of its primary key is ShortText.
+Let's add a column. The following example adds a column to the Site table. The `table` parameter specifies the target table. The `name` parameter specifies the name of the column. The `type` parameter specifies the data type of the column.
 
 .. groonga-command
 .. include:: ../example/tutorial/introduction-5.log
-.. table_create --name Terms --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
-
-The table_create command takes many parameters but you don't need to understand all of them. Please skip the next paragraph if you are not interested in how it works.
-
-The 'TABLE_PAT_KEY' flag specifies to store index terms in a patricia trie. The 'KEY_NORMALIZE' flag specifies to normalize index terms. In this example, both flags are validated by using a '|'. The 'default_tokenizer' parameter specifies a method for tokenizing text. This example specifies 'TokenBigram' that is generally called 'N-gram'.
-
-Create an index column for full text search
--------------------------------------------
-
-The second step is to create an index column, which allows you to search records from its associated column. That is to say this step specifies which column needs an index.
-
-Let's create an index column for the 'title' column in the 'Site' table.
-
-.. groonga-command
-.. include:: ../example/tutorial/introduction-6.log
-.. column_create --table Terms --name blog_title --flags COLUMN_INDEX|WITH_POSITION --type Site --source title
-
-This command creates an index column 'blog_title' in the 'Terms' table. The '--type' option specifies a target table and the '--source' option specifies a target column. Then, the 'COLUMN_INDEX' flag specifies to create an index column and the 'WITH_POSITION' flag specifies to create a full inverted index, which contains the positions of each index term. This combination 'COLUMN_INDEX|WITH_POSITION' is recommended for the general purpose.
+.. column_create --table Site --name title --type ShortText
+.. select --table Site
 
-Load data
----------
+Load records
+------------
 
 A :doc:`/commands/load` command loads JSON-formatted records into a table.
 
-The following adds nine records to the 'Site' table.
+The following example loads nine records into the Site table.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-7.log
+.. include:: ../example/tutorial/introduction-6.log
 .. load --table Site
 .. [
 .. {"_key":"http://example.org/","title":"This is test record 1!"},
@@ -178,99 +150,137 @@ The following adds nine records to the 'Site' table.
 .. {"_key":"http://example.com/vdw","title":"test test record nine."},
 .. ]
 
+The second element of the result indicates how many records were successfully loaded. In this case, all the records are successfully loaded.
+
 Let's make sure that these records are correctly stored.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-8.log
+.. include:: ../example/tutorial/introduction-7.log
 .. select --table Site
 
-Search data
------------
+Get a record
+------------
+
+A :doc:`/commands/select` command can search records in a table.
 
-Before a full text search, let's try to search data by '_id' and '_key'. These columns work as unique keys.
+If a search condition is specified with a `query` parameter, a :doc:`/commands/select` command searches records matching the search condition and returns the matched records.
 
-You can search records by using a 'select' command with a 'query' parameter.
+Let's get a record having a specified record ID. The following example gets the first record in the Site table. More precisely, the `query` parameter specifies a record whose _id column stores 1.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-9.log
+.. include:: ../example/tutorial/introduction-8.log
 .. select --table Site --query _id:1
 
-'_id:1' specifies to search a record whose ID is 1.
+Next, let's get a record having a specified key. The following example gets the record whose primary key is "http://example.org/". More precisely, the `query` parameter specifies a record whose _key column stores "http://example.org/".
 
-Next, let's search a record by a primary key.
+.. groonga-command
+.. include:: ../example/tutorial/introduction-9.log
+.. select --table Site --query '_key:"http://example.org/"'
+
+Create a lexicon table for full text search
+-------------------------------------------
+
+Let's go on to how to make full text search.
+
+Groonga uses an inverted index to provide fast full text search. So, the first step is to create a lexicon table which stores an inverted index, also known as postings lists. The primary key of this table is associated with a vocabulary made up of index terms and each record stores postings lists for one index term.
+
+The following shows a command which creates a lexicon table named Terms. The data type of its primary key is ShortText.
 
 .. groonga-command
 .. include:: ../example/tutorial/introduction-10.log
-.. select --table Site --query "_key:\"http://example.org/\""
+.. table_create --name Terms --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
+
+The :doc:`/commands/table_create` command takes many parameters but you don't need to understand all of them. Please skip the next paragraph if you are not interested in how it works.
+
+The TABLE_PAT_KEY flag specifies to store index terms in a patricia trie. The KEY_NORMALIZE flag specifies to normalize index terms. In this example, both flags are validated by using a '|'. The `default_tokenizer` parameter specifies the method for tokenizing text. This example uses TokenBigram that is generally called N-gram.
+
+Create an index column for full text search
+-------------------------------------------
+
+The second step is to create an index column, which allows you to search records from its associated column. That is to say this step specifies which column needs an index.
+
+Let's create an index column. The following example creates an index column for a column in the Site table.
 
-'_key:\"http://example.org/\"' specifies to search a record whose primary key is "http://example.org/".
+.. groonga-command
+.. include:: ../example/tutorial/introduction-11.log
+.. column_create --table Terms --name blog_title --flags COLUMN_INDEX|WITH_POSITION --type Site --source title
+
+The `table` parameter specifies the index table and the `name` parameter specifies the index column. The `type` parameter specifies the target table and the `source` parameter specifies the target column. The COLUMN_INDEX flag specifies to create an index column and the WITH_POSITION flag specifies to create a full inverted index, which contains the positions of each index term. This combination, COLUMN_INDEX|WITH_POSITION, is recommended for the general purpose.
+
+.. note::
+
+   You can create a lexicon table and index columns before/during/after loading records. If a target column already has records, groonga creates an inverted index in a static manner. In contrast, if you load records into an already indexed column, groonga updates the inverted index in a dynamic manner.
 
 Full text search
 ----------------
 
-It's time to make a full text search. You can make a full text search query with the same 'query' parameter.
+It's time. You can make full text search with a :doc:`/commands/select` command.
+
+A query for full text search is specified with a `query` parameter. The following example searches records whose "title" column contains "this". The '@' specifies to make full text search. Note that a lower case query matches upper case and capitalized terms in a record if KEY_NORMALIZE was specified when creating a lexcon table.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-11.log
+.. include:: ../example/tutorial/introduction-12.log
 .. select --table Site --query title:@this
 
-This command searches records whose 'title' column contains a string 'this'. In this case, only one record matches this query. Note that the lower case query 'this' matches a capitalized 'This' in the 1st record because 'KEY_NORMALIZE' was specified in lexicon column creation.
+In this example, the first record matches the query because its title contains "This", that is the capitalized form of the query.
 
-The 'select' command has an optional parameter 'match_columns'. This parameter specifies default target columns and it is used when target columns are not specified in a query.[1]_
+A :doc:`/commands/select` command accepts an optional parameter, named `match_columns`, that specifies the default target columns. This parameter is used if target columns are not specified in a query. [#]_
 
-A combination of '--match_columns title' and '--query this' brings you the same result that '--query title:@this' does.
+The combination of "`--match_columns` title" and "`--query` this" brings you the same result that "`--query` title:@this" does.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-12.log
+.. include:: ../example/tutorial/introduction-13.log
 .. select --table Site --match_columns title --query this
 
 Specify output columns
 ----------------------
 
-An 'output_columns' parameter in a 'select' command specifies columns to be shown in the search result. If you want to specify more than one columns, please separate column names by commas (,).
+An `output_columns` parameter of a :doc:`/commands/select` command specifies columns to appear in the search result. If you want to specify more than one columns, please separate column names by commas (',').
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-13.log
+.. include:: ../example/tutorial/introduction-14.log
 .. select --table Site --output_columns _key,title,_score --query title:@test
 
-This command specifies three output columns including the '_score' column, which stores the relevance score of each record.
+This example specifies three output columns including the _score column, which stores the relevance score of each record.
 
 Specify output ranges
 ---------------------
 
-A 'select' command returns a part of its search result if 'offset' and/or 'limit' parameters are specified. These parameters are useful to paginate a search result, a widely-used interface which shows a search result on a page by page basis.
+A :doc:`/commands/select` command returns a part of its search result if `offset` and/or `limit` parameters are specified. These parameters are useful to paginate a search result, a widely-used interface which shows a search result on a page by page basis.
 
-An 'offset' parameter specifies the starting point and a 'limit' parameter specifies the maximum number of records to be returned. If you need the first record in a search result, the offset parameter must be 0 or omitted.
+An `offset` parameter specifies the starting point and a `limit` parameter specifies the maximum number of records to be returned. If you need the first record in a search result, the offset parameter must be 0 or omitted.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-14.log
+.. include:: ../example/tutorial/introduction-15.log
 .. select --table Site --offset 0 --limit 3
 .. select --table Site --offset 3 --limit 3
 .. select --table Site --offset 7 --limit 3
 
-Sort
-----
+Sort a search result
+--------------------
+
+A :doc:`/commands/select` command sorts its result when used with a `sortby` parameter.
 
-A 'select' command sorts its result when used with a 'sortby' parameter.
+A `sortby` parameter specifies a column as a sorting creteria. A search result is arranged in ascending order of the column values. If you want to sort a search result in reverse order, please add a leading hyphen ('-') to the column name in a parameter.
 
-A 'sortby' parameter specifies a column as a sorting creteria. A search result is arranged in ascending order of the column values. If you want to sort a search result in reverse order, please add a leading hyphen (-) to the column name of a parameter.
+The following example shows records in the Site table in reverse order.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-15.log
+.. include:: ../example/tutorial/introduction-16.log
 .. select --table Site --sortby -_id
 
-You can use the '_score' column as a sorting criteria for ranking a search result.
+The next example uses the _score column as the sorting criteria for ranking the search result. The result is sorted in relevance order.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-16.log
-.. select --table Site --query title:@test --output_columns _id,_score,title --sortby _score
+.. include:: ../example/tutorial/introduction-17.log
+.. select --table Site --query title:@test --output_columns _id,_score,title --sortby -_score
 
-If you want to specify more than one columns, please separate column names by commas. In such a case, a search result is sorted in order of the column values in the first column, and then records having the same values in the first column are sorted in order of the second column values.
+If you want to specify more than one columns, please separate column names by commas (','). In such a case, a search result is sorted in order of the values in the first column, and then records having the same values in the first column are sorted in order of the second column values.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-17.log
-.. select --table Site --query title:@test --output_columns _id,_score,title --sortby _score,_id
+.. include:: ../example/tutorial/introduction-18.log
+.. select --table Site --query title:@test --output_columns _id,_score,title --sortby -_score,_id
 
 .. rubric:: footnote
 
-.. [1] Currently, a 'match_columns' parameter is available iff there exists an inverted index for full text search. A 'match_columns' parameter for a regular column is not supported.
+.. [#] Currently, a `match_columns` parameter is available iff there exists an inverted index for full text search. A `match_columns` parameter for a regular column is not supported.

data/vendor/local/share/doc/groonga/en/html/_sources/tutorial/network.txt

@@ -7,25 +7,43 @@
 .. groonga-command
 .. database: tutorial
 
-How to use groonga with network
-===============================
+Remote access
+=============
 
-You can use groonga with network. When you run groonga by using the groonga original protocol or HTTP, groonga accepts connection for network.
+You can use groonga as a server which allows remote access. Groonga supports the original protocol (gqtp), the memcached binary protocol and HTTP.
 
-Connect with groonga's original protocol
-----------------------------------------
+Groonga query transfer protocol (gqtp)
+--------------------------------------
 
-Run groonga daemon
-^^^^^^^^^^^^^^^^^^
+How to run a gqtp server
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Groonga has a special protocol, named groonga query transfer ptorotocl (gqtp), for remote access to a database. The following form shows how to run groonga as a gqtp server.
+
+Form::
+
+  groonga [-p PORT_NUMBER] -s DB_PATH
+
+The `-s` option specifies to run groonga as a server. DB_PATH specifies the path of the existing database to be hosted. The `-p` option and its argument, PORT_NUMBER, specify the port number of the server. The default port number is 10041, which is used when you don't specify PORT_NUMBER.
+
+The following command runs a server that listens on the default port number. The server accepts operations to the specified database.
+
+Execution example::
+
+  % groonga -s /tmp/groonga-databases/introduction.db
+  Ctrl-c
+  %
+
+How to run a gqtp daemon
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can also run a gqtp server as a daemon by using the `-d` option, instead of the `-s` option.
 
 Form::
 
-  groonga [-p PORT_NUMBER] -d DB_PATH_NAME
+  groonga [-p PORT_NUMBER] -d DB_PATH
 
-The DB_PATH_NAME is set the full-path of existing database.
-With this form, you can run groonga as a daemon and connect by
-with groonga original protocol on PORT_NUMBER.
-(The port number is 10041 when you don't specify PORT_NUMBER.)
+A groonga daemon prints its process ID as follows. In this example, the process ID is 12345. Then, the daemon opens a specified database and accepts operations to that database.
 
 Execution example::
 
@@ -33,20 +51,16 @@ Execution example::
   12345
   %
 
-Groonga shows its process ID on daemon mode.
+How to run a gqtp client
+^^^^^^^^^^^^^^^^^^^^^^^^
 
-Connect to groonga server
-^^^^^^^^^^^^^^^^^^^^^^^^^
+You can run groonga as a gqtp client as follows:
 
 Form::
 
   groonga [-p PORT_NUMBER] -c [HOST_NAME_OR_IP_ADDRESS]
 
-This command connects to groonga server running at specified HOST_NAME_OR_IP_ADDRESS.
-
-When you don't specify HOST_NAME_OR_IP_ADDRESS, this command connects to groonga server running at localhost. When you don't specify PORT_NUMBER, 10041 is used.
-
-Groonga runs in interactive mode after connect to groonga server successfully. Groonga reads command from standard input and evaluates it repeatedly.
+This command establishes a connection with a gqtp server and then enters into interactive mode. HOST_NAME_OR_IP_ADDRESS specifies the hostname or the IP address of the server. If not specifed, groonga uses the default hostname "localhost". The `-p` option and its argument, PORT_NUMBER, specify the port number of the server. If not specified, groonga uses the default port number 10041.
 
 .. groonga-command
 .. include:: ../example/tutorial/network-1.log
@@ -55,10 +69,12 @@ Groonga runs in interactive mode after connect to groonga server successfully. G
 .. .. > ctrl-d
 .. .. %
 
-Terminate groonga daemon
-^^^^^^^^^^^^^^^^^^^^^^^^
+In interactive mode, groonga reads commands from the standard input and executes them one by one.
+
+How to terminate a gqtp server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-You can terminate groonga daemon with shutdown command.
+You can terminate a gqtp server with a :doc:`/commands/shutdown` command.
 
 .. groonga-command
 .. include:: ../example/tutorial/network-2.log
@@ -66,41 +82,61 @@ You can terminate groonga daemon with shutdown command.
 .. .. > shutdown
 .. .. %
 
-Connect with HTTP
------------------
+Memcached binary protocol
+-------------------------
+
+Groonga supports the memcached binary protocol. The following form shows how to run groonga as a memcached binary protocol server daemon.
+
+Form::
+
+  groonga [-p PORT_NUMBER] -d --protocol memcached DB_PATH
 
-You need to run groonga in HTTP protocol mode when you want to use groonga via HTTP.
+The `--protocol` option and its argument specify the protocol of the server. "memcached" specifies to use the memcached binary protocol.
+
+Hypertext transfer protocol (HTTP)
+-----------------------------------
+
+How to run an HTTP server
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Groonga supports the hypertext transfer protocol (HTTP). The following form shows how to run groonga as an HTTP server daemon.
 
 Form::
 
-  groonga [-p PORT_NUMBER] -d --protocol http DB_PATH_NAME
+  groonga [-p PORT_NUMBER] -d --protocol http DB_PATH
 
-`--protocol` option specifies a protocol of groonga server. `http` means that groonga accepts connections via HTTP.
+The `--protocol` option and its argument specify the protocol of the server. "http" specifies to use HTTP.
 
-Administration tool based on HTML
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The following command runs an HTTP server that listens on the port number 80.
 
-You can access administration tool based on HTML at `http://[HOST_NAME_OR_IP_ADDRESS]:[PORT_NUMBER]/` after the above command is ran. Your browser must enable JavaScript.
+Execution example::
+
+  % groonga -p 80 -d --protocol http /tmp/groonga-databases/introduction.db
+  %
 
-Run command with HTTP
-^^^^^^^^^^^^^^^^^^^^^
+How to send a command to an HTTP server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-You can run command at `/d/COMMAND_NAME` when groonga is ran in HTTP protocol mode.
+You can send a command to an HTTP server by sending a GET request to /d/COMMAND_NAME. Command parameters can be passed as parameters of the GET request. The format is "?NAME_1=VALUE_1&NAME_2=VALUE_2&...".
 
-Command options are passed as HTTP's GET parameters. They are in `?OPTION=VALUE&OPTION=VALUE&...` form.
+The following example shows how to send commands to an HTTP server.
 
 .. groonga-command
 .. include:: ../example/tutorial/network-3.log
-.. .. http://[HOST_NAME_OR_IP_ADDRESS]:[PORT_NUMBER]/d/status
+.. .. http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/d/status
 .. .. Executed command:
 .. status
 .. .. 
-.. .. http://[HOST_NAME_OR_IP_ADDRESS]:[PORT_NUMBER]/d/select?table=Site&query=title:@this
+.. .. http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/d/select?table=Site&query=title:@this
 .. .. Executed command:
 .. select --table Site --query title:@this
 
+Administration tool (HTTP)
+--------------------------
+
+An HTTP server of groonga provides a browser based administration tool that makes database management easy. After starting an HTTP server, you can use the administration tool by accessing http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/. Note that Javascript must be enabled for the tool to work properly.
 
-Security
---------
+Security issues
+---------------
 
-Network service of groonga doesn't support authentication. Everyone can view and modify the database. We recommend that you restrict client accesses by IP address. You can use iptables or any similar tool for it.
+Groonga servers don't support user authentication. Everyone can view and modify databases hosted by groonga servers. You are recommended to restrict IP addresses that can access groonga servers. You can use iptables or similar for this purpose.

data/vendor/local/share/doc/groonga/en/html/_sources/type.txt

@@ -30,75 +30,84 @@ groongaのデータベースでは、テーブルの主キーや、カラムの
 
 ``Object``
 
-  任意のテーブルに属する全てのレコード [#]_
+  任意のテーブルに属する全てのレコードです。 [#]_
 
 ``Bool``
 
-  bool型。trueとfalse。
+  ブーリアン型やブール型などと呼ばれる型であり、真偽値を表します。取り得る値はtrueとfalseです。（デフォルト値: false）
+
+  :doc:`/commands/load` コマンドで値を格納するときは、false、0、空文字列のいずれかを指定するとfalseになり、それ以外を指定するとtrueになります。
 
 ``Int8``
 
-  8bit符号付き整数。
+  8bit符号付き整数であり、-128以上127以下の整数を表します。（デフォルト値: 0）
 
 ``UInt8``
 
-  8bit符号なし整数。
+  8bit符号なし整数であり、0以上255以下の整数を表します。（デフォルト値: 0）
 
 ``Int16``
 
-  16bit符号付き整数。
+  16bit符号付き整数であり、-32,768以上32,767以下の整数を表します。（デフォルト値: 0）
 
 ``UInt16``
 
-  16bit符号なし整数。
+  16bit符号なし整数であり、0以上65,535以下の整数を表します。（デフォルト値: 0）
 
 ``Int32``
 
-  32bit符号付き整数。
+  32bit符号付き整数であり、-2,147,483,648以上2,147,483,647以下の整数を表します。（デフォルト値: 0）
 
 ``UInt32``
 
-  32bit符号なし整数。
+  32bit符号なし整数であり、0以上4,294,967,295以下の整数を表します。（デフォルト値: 0）
 
 ``Int64``
 
-  64bit符号付き整数。
+  64bit符号付き整数であり、-9,223,372,036,854,775,808以上9,223,372,036,854,775,807以下の整数を表します。（デフォルト値: 0）
 
 ``UInt64``
 
-  64bit符号なし整数。
+  64bit符号なし整数であり、0以上18,446,744,073,709,551,615以下の整数を表します。（デフォルト値: 0）
 
 ``Float``
 
-  ieee754形式の64bit浮動小数点数。
+  IEEE 754形式の倍精度浮動小数点数であり、実数を表します。（デフォルト値: 0.0）
+
+  IEEE 754形式の詳細については、 `IEEE 754 - Wikipedia <http://ja.wikipedia.org/wiki/IEEE_754>`_ や `IEEE 754: Standard for Binary Floating-Point <http://grouper.ieee.org/groups/754/>`_ を参照してください。
 
 ``Time``
 
-  1970年1月1日0時0分0秒からの経過マイクロ秒数を64bit符号付き整数で表現した値。
+  日時を表す型であり、1970年1月1日0時0分0秒からの経過時間を、マイクロ秒単位で64bit符号付き整数により表現します。（デフォルト値: 0）
+
+  :doc:`/commands/load` コマンドで値を格納するときは、1970年1月1日0時0分0秒からの経過秒数を指定します。秒単位より詳細な日時を指定するには、小数を使います。
 
 ``ShortText``
 
-  4Kbyte以下の文字列。
+  4,095バイト以下の文字列を表します。（デフォルト値: ""）
 
 ``Text``
 
-  64Kbyte以下の文字列。
+  65,535バイト以下の文字列を表します。（デフォルト値: ""）
 
 ``LongText``
 
-  2Gbyte以下の文字列。
+  2,147,483,647バイト以下の文字列を表します。（デフォルト値: ""）
 
 ``TokyoGeoPoint``
 
-  日本測地系緯度経度座標。緯度と経度はミリ秒単位での整数。
-  "経度のミリ秒x緯度のミリ秒"という文字列表現を持つ。
-  度分秒形式であれば、x度y分z秒は(((x * 60) + y) * 60 + z) * 1000という計算式で変換した値を代入します。
+  旧日本測地系による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0）
+
+  度分秒形式でx度y分z秒となる経度・緯度は、(((x * 60) + y) * 60 + z) * 1000という計算式でミリ秒単位へと変換されます。
+  :doc:`/commands/load` コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。
+
+  測地系の詳細については、 `測地系 - Wikipedia <http://ja.wikipedia.org/wiki/%E6%B8%AC%E5%9C%B0%E7%B3%BB>`_ を参照してください。
 
 ``WGS84GeoPoint``
 
-  世界測地系緯度経度座標。緯度と経度はミリ秒単位での整数。
-  "経度のミリ秒x緯度のミリ秒"という文字列表現を持つ。
-  度分秒形式であれば、x度y分z秒は(((x * 60) + y) * 60 + z) * 1000という計算式で変換した値を代入します。
+  世界測地系（World Geodetic System, WGS 84）による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0）
+
+  度分秒形式からミリ秒形式への変換方法や :doc:`/commands/load` コマンドにおける指定方法はTokyoGeoPointと同じです。
 
 型に関する制限事項
 ------------------