付録C.3 文書収集コマンド(BIBcollectDocコマンド)の文法
(1) 機能
収集先の文書を文書数または収集処理時間で分割して収集します。
(2) 形式
BIBcollectDoc -c CollectorName
[-m { new | diff |next }]
[-f MaxDocNum]
[-t TimeOut]
[-p ErrorLevel]
(3) オプション
- -c CollectorName
- 収集の対象となる収集環境の名前を指定します。
- -m { new | diff | next }
- 実行する文書収集の種類を,新規収集,差分収集,分割収集から選択して指定します。
- new
- 新規収集を実行します。-mオプションにnewを指定して,-fオプションまたは-tオプションで文書数または収集時間を指定した場合,指定した文書数または収集時間まで文書を収集します。
- diff
- 差分収集を実行します。-mオプションにdiffを指定して,-fオプションまたは-tオプションで文書数または収集時間を指定した場合,指定した文書数または収集時間単位に差分を分割して収集します。
- next
- 分割収集を実行します。分割する単位は,収集する文書数または収集処理を続ける時間から選択できます。分割する単位を文書数とする場合は,-fオプションで文書数を指定し,収集時間とする場合は-tオプションで時間を指定してください。
- 初回の分割収集時には,指定した文書数または収集時間まで新規収集します。2回目以降の収集時に,再び-mオプションにnextを指定することで,前回の続きから分割収集を再開します。
- -f MaxDocNum
- 収集する文書数を,1~2,147,483,647の範囲で指定します。収集する文書数を制限する場合に指定します。省略した場合は,-cオプションで指定した収集環境のすべての文書を対象にします。
- -t TimeOut
- 収集時間をhhmm形式の4けたの数字で指定します。hhmmで0001~2359の範囲で指定します。hhには時間を表す数字を00~23の範囲で指定します。また,mmには時間の分を表す数字を00~59の範囲で指定します。
- なお,TimeOutに指定した時間になった時点で,ある文書の収集処理が途中の場合は,その文書の収集処理が完了してから収集を終了します。省略した場合は,時間の制限はありません。
- -p ErrorLevel
- コマンドの動作(戻り値)を詳細化するオプションです。
- 0:分割実行機能により中断した場合かどうかを戻り値で判定しません。
- 1:分割実行機能により中断した場合かどうかを戻り値で判定可能とします。
(4) 戻り値
戻り値を次に示します。
戻り値 | 意味 |
---|
-1 | 異常終了 |
0 | -pの指定が0の場合:正常終了 -pの指定が1の場合:正常終了(対象文書をすべて処理) |
1 | -pの指定が0の場合:警告付き正常終了 -pの指定が1の場合:警告付き正常終了(対象文書をすべて処理) |
2 | 引数不正 |
3 | メモリ不足 |
4 | I/Oエラー |
5 | パーミッションエラー |
6 | 多重実行 |
7 | 定義不正 |
8 | -pの指定が1の場合:正常終了(分割実行機能により中断) |
9 | -pの指定が1の場合:警告付き正常終了(分割実行機能により中断) |
(5) 注意事項
- 文書収集コマンドを実行できるのは,Administratorsグループのユーザだけです。
- 同一の収集先に対して,文書コマンドの多重実行はできません。
- オプションで範囲外を指定した場合は,Usageを表示します。