/* ////////// LICENSE INFO ////////////////////

 * Copyright (C) 2013 by NYSOL CORPORATION
 *
 * Unless you have received this program directly from NYSOL pursuant
 * to the terms of a commercial license agreement with NYSOL, then
 * this program is licensed to you under the terms of the GNU Affero General
 * Public License (AGPL) as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF 
 * NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Please refer to the AGPL (http://www.gnu.org/licenses/agpl-3.0.txt)
 * for more details.

 ////////// LICENSE INFO ////////////////////*/
// =============================================================================
/// kgsortfHelp.h : kgsortf help
// =============================================================================
_title="項目指定によるレコードの並べ替え";
_doc="\
msortf(項目指定によるレコードの並べ換え)\n\
 \"f=\"パラメータで指定した項目を基準にして、レコードを並べ換える。\n\
書式\n\
 msortf f=[%n|%r|%nr] [tmpPath=] [-nfn] [-nfno] [-x] [i=] [o=] [-help]\n\
パラメータ\n\
 f= 項目名リスト[%n|%r|%nr]【必須】\n\
    レコードを並べ換える基準となる項目名リストを指定する。\n\
    項目名を指定するだけだと、文字列としてソートされる。\n\
    数値項目として並べ替えたい場合は\n\
    \"f=項目名%n\"のように項目名のあとに\"%n\"を\n\
    指定するよって数値項目としてソートされる。\n\
    また、文字列および数値の降順ソートを実行する場合はそれぞれ\n\
    \"f=項目名%r\"、\"f=項目名%nr\"と指定する。\n\
    なお、データにNULL値が含まれる場合、\n\
    NULL値はどのような値よりも小さい値として扱われる。\n\
    また、多重ソートを行う場合は、ソートの優先順位にしたがって(,)\n\
    カンマ区切りで項目名を指定する。\n\
    注意点)文字列項目に対して\"%n\"を指定した場合の動作は不定である。\n\
    NULL値は，数値としても文字列としても、最も小さい値として扱われる。\n\
上級者用パラメータ\n\
 pways=     同時併合ファイル数([2-100]:デフォルト32)【任意】\n\
            分割ソートされた複数のファイルを同時に何個併合するかを指定する。\n\
 blocks=    バッファブロック数([1-1000]:デフォルト100 1blk=400KB)【任意】\n\
            メモリ内でソートする際のメモリサイズ上限をブロックサイズで指定する。\n\
            1ブロックは一行の最大長×4で，デフォルトでは400KB。\n\
 maxlines=  メモリソートレコード件数上限([100-1000万]:デフォルト50万)【任意】\n\
            メモリ内でソートする際の件数の上限を指定する。\n\
            データの一行あたりの平均サイズに応じて、\n\
            blocks=制限とmaxlines=制限のいずれかが使われる。\n\
 threadCnt= メモリ内でソートを実行するthread数([1-50]:デフォルト8)【任意】\n\
            分割ソートする際に、\n\
            マルチスレッドの機能を用いて同時にソートする数を指定する\n\
例\n\
 msortf f=item,date i=dat.csv o=rsl.csv\n\
 msortf f=quantity%nr,price%n i=dat.csv o=rsl.csv\n\
";

