From 2226f2011d46796c32a48666761bf6c312771df2 Mon Sep 17 00:00:00 2001 From: Daniele Varrazzo Date: Sat, 22 Sep 2012 19:58:49 +0100 Subject: [PATCH] Documentation fixes for the English and Japanese HTML doc pages * Get rid of duplicate documentation for "-Z" option * standardize which section "--all" appears under * note that 9.2 is a supported Postgres version * turn HTML docs into valid HTML 4.01 Commit by Josh Kupershmidt. Performed by me as git am was failing to apply this patch. --- doc/pg_reorg-ja.html | 56 ++++++++++++++--------------- doc/pg_reorg.html | 85 ++++++++++++++++++++++---------------------- 2 files changed, 70 insertions(+), 71 deletions(-) diff --git a/doc/pg_reorg-ja.html b/doc/pg_reorg-ja.html index d6c7bb1..8ad5b01 100755 --- a/doc/pg_reorg-ja.html +++ b/doc/pg_reorg-ja.html @@ -1,9 +1,9 @@ - + pg_reorg - + @@ -12,8 +12,8 @@
Top > pg_reorg -
-
+
+
    @@ -44,6 +44,7 @@ pg_reorg [OPTIONS] 詳細はオプションを参照してください。

    • 固有オプション
        +
      • -a, --all : 全てのデータベースに対して実行します
      • -o [--order-by] columns [,...]
      • -n [--no-order]
      • -t [--table] table
        • @@ -51,7 +52,6 @@ pg_reorg [OPTIONS]
      • -Z [--no-analyze]
    • 接続オプション
        -
      • -a, --all : 全てのデータベースに対して実行します
      • -d, --dbname=DBNAME : 接続するデータベース
      • -h, --host=HOSTNAME : データベースサーバホスト、またはソケットディレクトリ
      • -p, --port=PORT : データベースサーバのポート
        • @@ -91,7 +91,6 @@ pg_reorg [OPTIONS]

        オプション

        pg_reorg では、下記のコマンドライン引数を指定できます。

        -

        固有オプション

        pg_reorg を実行する対象と並び替えの基準を指定するパラメータです。 @@ -100,16 +99,15 @@ pg_reorg [OPTIONS]

        -
        -n
        --no-order
        +
        -n
        --no-order
        オンライン VACUUM FULL の処理を行います。
        -
        -o columns [,...]
        +
        -o columns [,...]
        --order-by columns [,...]
        指定したカラムをキーにオンライン CLUSTER を行います。
        -
        --t table
        +-t table
        --table=table
        オンライン CLUSTER 、または、オンライン VACUUM FULL を行うテーブルを指定します。 @@ -117,7 +115,7 @@ pg_reorg [OPTIONS]
        --T seconds
        +-T seconds
        --wait-timeout=seconds
        @@ -127,7 +125,7 @@ pg_reorg [OPTIONS] デフォルトは60秒です。
        -
        -Z
        --no-analyze
        +
        -Z
        --no-analyze
        再編成後に ANALYZE を行いません。 このオプションが指定されていない場合は、再編成後に ANALYZE します。
        @@ -140,11 +138,11 @@ PostgreSQLに接続するためのパラメータです。

        -
        -a
        --all
        +
        -a
        --all
        対象となる全てのデータベースに対してオンライン CLUSTER、または、オンラインVACUUM FULLを行います。
        --d DBNAME
        +-d DBNAME
        --dbname=DBNAME
        オンライン CLUSTER、または、オンライン VACUUM FULL を行うデータベース名を指定します。 @@ -152,27 +150,27 @@ PostgreSQLに接続するためのパラメータです。 データベース名はPGDATABASE環境変数から読み取られます。 この変数も設定されていない場合は、接続時に指定したユーザ名が使用されます。
        -
        -h HOSTNAME
        +
        -h HOSTNAME
        --host=HOSTNAME
        サーバが稼働しているマシンのホスト名を指定します。ホスト名がスラッシュから始まる場合、Unixドメインソケット用のディレクトリとして使用されます。
        -
        -p PORT
        +
        -p PORT
        --port=PORT
        サーバが接続を監視するTCPポートもしくはUnixドメインソケットファイルの拡張子を指定します。
        -
        -U USERNAME
        +
        -U USERNAME
        --username=USERNAME
        接続するユーザ名を指定します。
        -
        -w
        +
        -w
        --no-password
        パスワードの入力を促しません。 サーバがパスワード認証を必要とし、かつ、.pgpassファイルなどの他の方法が利用できない場合、接続試行は失敗します。 -バッチジョブやパスワードを入力するユーザが存在しない場合にこのオプションは有用かもしれません。 +バッチジョブやパスワードを入力するユーザが存在しない場合にこのオプションは有用かもしれません。
        -
        -W
        +
        -W
        --password
        データベースに接続する前に、強制的にパスワード入力を促します。
        @@ -184,9 +182,9 @@ PostgreSQLに接続するためのパラメータです。

        一般オプション

        -
        -e
        --echo
        +
        -e
        --echo
        サーバに送信するSQLを表示します。
        -
        -E
        --elevel
        +
        -E
        --elevel
        ログ出力レベルを設定します。 DEBUG, INFO, NOTICE, WARNING, ERROR, LOG, FATAL, PANIC から選択します。 デフォルトは INFO です。
        @@ -199,9 +197,9 @@ DEBUG, INFO, NOTICE, WARNING, ERROR, LOG, FATAL, PANIC から選択します。

        環境変数

        - PGDATABASE
        - PGHOST
        - PGPORT
        + PGDATABASE
        + PGHOST
        + PGPORT
        PGUSER
        デフォルトの接続パラメータです。
        @@ -314,7 +312,7 @@ $ psql -f $PGSHARE/contrib/pg_reorg.sql -d your_database

        動作環境

        PostgreSQLバージョン
        -
        PostgreSQL 8.2, 8.3, 8.4, 9.0, 9.1
        +
        PostgreSQL 8.2, 8.3, 8.4, 9.0, 9.1, 9.2
        OS
        RHEL 5.2, Windows XP SP3
        ディスク容量
        @@ -333,13 +331,13 @@ $ psql -f $PGSHARE/contrib/pg_reorg.sql -d your_database clusterdb, vacuumdb -
        +
        Top > pg_reorg -
        +

        -Portions Copyright (c) 2008-2011, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
        +Portions Copyright (c) 2008-2011, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
        Portions Copyright (c) 2011, Itagaki Takahiro

        diff --git a/doc/pg_reorg.html b/doc/pg_reorg.html index 22923d4..a98e495 100755 --- a/doc/pg_reorg.html +++ b/doc/pg_reorg.html @@ -1,9 +1,9 @@ - + pg_reorg - + @@ -12,8 +12,8 @@
        Top > pg_reorg -
        -
        +
        +
          @@ -44,6 +44,7 @@ pg_reorg [OPTIONS] See also "Options" for details.

          • Reorg Options
              +
            • -a, --all : reorganize all databases
            • -o [--order-by] columns [,...]
            • -n [--no-order]
            • -t [--table] table
              • @@ -51,7 +52,6 @@ See also "Options" for details.

            • -Z [--no-analyze]
          • Connection Options
              -
            • -a, --all : reorganize all databases
            • -d, --dbname=DBNAME : database to connect
            • -h, --host=HOSTNAME : database server host or socket directory
            • -p, --port=PORT : database server port
              • @@ -83,43 +83,39 @@ You can choose one of the following methods to reorganize.

            Examples

            -

            Execute the following command to do online CLUSTER to all tables in test database.

            +

            Execute the following command to perform an online CLUSTER of all tables in test database.

            $ pg_reorg test
            -

            Execute the following command to do online VACUUM FULL to foo table in test database.

            +

            Execute the following command to perform an online VACUUM FULL to foo table in test database.

            $ pg_reorg --no-order --table foo -d test

            Options

            pg_reorg has the following command line options:

            -

            Reorg Options

            Options to order rows. -If not specified, pg_reorg do online CLUSTER using cluster indexes. +If not specified, pg_reorg performs an online CLUSTER using cluster indexes. Only one option can be specified. -Options to specify target tables or databases. +You may also specify target tables or databases.

            -
            -n
            --no-order
            +
            -n
            --no-order
            Do online VACUUM FULL.
            -
            -o columns [,...]
            +
            -o columns [,...]
            --order-by=columns [,...]
            Do online CLUSTER ordered by specified columns.
            --t table
            +-t table
            --table=table
            Reorganize table only. If you don't specify this option, all tables in specified databases are reorganized.
            -
            -Z
            --no-analyze
            -
            Do ANALYZE after reorganization. If you don't specify this option, ANALYZE is performed automatically after reorg.
            -
            --T seconds
            +-T seconds
            --wait-timeout=seconds
            @@ -130,7 +126,7 @@ Also, if the server version is 8.4 or newer, pg_reorg forces to disconnect confl The default is 60 seconds.
            -
            -Z
            --no-analyze
            +
            -Z
            --no-analyze
            Disable ANALYZE after the reorganization. If not specified, run ANALYZE after the reorganization.
            @@ -143,47 +139,46 @@ You cannot use --all and --dbname or --table together.

            -
            -a
            --all
            +
            -a
            --all
            Reorganize all databases.
            --d dbname
            +-d dbname
            --dbname dbname
            Specifies the name of the database to be reorganized. If this is not specified and -a (or --all) is not used, the database name is read from the environment variable PGDATABASE. If that is not set, the user name specified for the connection is used.
            -
            -h host
            +
            -h host
            --host host
            Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the Unix domain socket.
            -
            -p port
            +
            -p port
            --port port
            Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections.
            -
            -U username
            +
            -U username
            --username username
            User name to connect as.
            -
            -w
            +
            -w
            --no-password
            Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a .pgpass file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.
            -
            -
            -W
            +
            -W
            --password
            Force the program to prompt for a password before connecting to a database.
            -
            This option is never essential, since the program will automatically prompt for a password if the server demands password authentication. However, vacuumdb will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt.
            +
            This option is never essential, since the program will automatically prompt for a password if the server demands password authentication. However, pg_reorg will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt.

            Generic Options

            -
            -e
            --echo
            +
            -e
            --echo
            Echo commands sent to server.
            -
            -E
            --elevel
            +
            -E
            --elevel
            Choose the output message level from DEBUG, INFO, NOTICE, WARNING, ERROR, LOG, FATAL, and PANIC. The default is INFO.
            --help
            @@ -195,9 +190,9 @@ The default is INFO.

        Environment

        - PGDATABASE
        - PGHOST
        - PGPORT
        + PGDATABASE
        + PGHOST
        + PGPORT
        PGUSER
        Default connection parameters
        @@ -207,7 +202,7 @@ The default is INFO.

        Diagnostics

        Error messages are reported when pg_reorg fails. The following list shows the cause of errors.

        -

        You need to cleanup by hand after fatal erros. +

        You need to cleanup by hand after fatal errors. To cleanup, execute $PGHOME/share/contrib/uninstall_pg_reorg.sql to the database where the error occured and then execute $PGHOME/share/contrib/pg_reorg.sql. (Do uninstall and reinstall.)

        @@ -256,7 +251,7 @@ Be careful to avoid data corruptions.

        DDL commands

        You cannot do DDL commands except VACUUM and ANALYZE during pg_reorg. -In many case pg_reorg would fail and rollback collectly, but there are some cases ending with data-corruption .

        +In many cases pg_reorg will fail and rollback collectly, but there are some cases which may result in data-corruption .

        TRUNCATE
        @@ -276,14 +271,14 @@ In many case pg_reorg would fail and rollback collectly, but there are some case

        Details

        -

        pg_reorg creates a work table in reorg schema and sorts rows in it. -Then, it updates system catalog directly to swap the work table and the original one.

        +

        pg_reorg creates a work table in the reorg schema and sorts the rows in this table. +Then, it updates the system catalogs directly to swap the work table and the original one.

        Installations

        pg_reorg can be built with "make" on UNIX or Linux. pgxs build framework is used automatically. -Before build, you might need to install postgres packages for developper (postgresql-devel, etc.) +Before building, you might need to install postgres packages for developer (postgresql-devel, etc.) and add pg_config to your $PATH. 

        $ cd pg_reorg
@@ -303,10 +298,13 @@ $ psql -f $PGSHARE/contrib/pg_reorg.sql -d your_database

        Requirements

        -
        PostgreSQL version
        -
        PostgreSQL 8.2, 8.3, 8.4, 9.0, 9.1
        +
        PostgreSQL versions
        +
        PostgreSQL 8.2, 8.3, 8.4, 9.0, 9.1, 9.2
        OS
        RHEL 5.2, Windows XP SP3
        -
        Disks
        Requires amount of disks twice larger than target table and indexes. (If the total size of targets are 1GB, additional 2GB of disks are required.)
        +
        Disks
        Requires free disk space twice as large as the target +table(s) and indexes. For example, if the total size of the tables and +indexes to be reorganized is 1GB, an additional 2GB of disk space is +required.

        Releases

        @@ -321,15 +319,18 @@ $ psql -f $PGSHARE/contrib/pg_reorg.sql -d your_database clusterdb, vacuumdb -
        +
        Top > pg_reorg +
        +

        -Portions Copyright (c) 2008-2011, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
        +Portions Copyright (c) 2008-2011, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
        Portions Copyright (c) 2011, Itagaki Takahiro

        +