コマンド使用方法

コマンドの使用法は、

  1. $ python runhabu.py [オプション] [設定ファイル]

です。

設定ファイルは、使用する設定ファイル(YAML形式)を指定します。設定ファイルは省略可能で、省略すると可憐度ディレクトリのhabu.cfgを使用します。設定ファイルが見つからない場合は、エラーが出力してプログラムを終了します。

設定ファイルにschedulerが指定されている場合は、スケジューラモード(デーモンモード)で動作します。指定がない場合は、タスクモードで動作します。

オプション

-h, --help

ヘルプ(コマンドの使用方法)を出力してプログラムを終了します。

-V, --version

バージョン情報を表示して、プログラムを終了します。

-t, --target=TARGET_PIPELINE

設定ファイルに複数のpipelineを記述している場合、指定したパイプライン(TARGET_PIPELINE)だけを実行します。指定したパイプラインが見つからない場合はエラーを出力して終了します。

設定ファイルにschedulerが指定されている場合(スケジューラモード)は、プログラムは常駐しますが、ターゲットが指定されている場合はプログラムは常駐しません(タスクモードで動作します)。

-a, --plugin-path=PLUGIN_PATH

追加のプラグインのディレクトリを指定します。プラグインのロード順は、

  1. コマンドライン引き数のプラグインのパス
  2. 設定ファイルのplugin_path
  3. カレントディレクトリ
  4. habuのモジュールディレクトリ

です。

-e, --enable-netinstall

設定ファイルにモジュールのURLが指定されいて,プラグインパス上にモジュールが見つからない場合,Webからモジュールを自動ダウンロードできるようになります。これを指定しない時は,ネットワーク上を検索セスにエラーがで終了します。

-d, --disable-server

設定ファイルにserverセクションがある場合でもサーバ機能を強制的に無効にします。

--download-url=DOWNLOAD_URL

モジュールをインターネットからダウンロードするときのベースURLです。--download-moduleとあわせて使用します。ダウンロードしたモジュールは--plugin-pathで一番最初に指定したディレクトリに保存されます。--plugin-pathが指定されていない場合は、カレントディレクトリに保存します。

--download-module=DOWNLOAD_MODULE_NAME

モジュールをインターネットからダウンロードするときのモジュール名です。--download-urlとあわせて使用します。--downlaod-urlが指定されていない場合は、「http://svn.sourceforge.jp/svnroot/pyhabu/trunk/habu」を使用します。ダウンロードしたモジュールは--plugin-pathで一番最初に指定したディレクトリに保存されます。--plugin-pathが指定されていない場合は、カレントディレクトリに保存します。

-l, --log-level=LOG_LEVEL

ログレベルを指定します。ログレベルの詳細は,「設定ファイル」を参照してください。

このオプションは設定ファイルの指定を上書きします。

--log-file=LOG_FILE

ログを出力するファイルを指定します。stdoutで標準出力,stderrで標準エラーに出力します。

このオプションは設定ファイルの指定を上書きします。

--proxy-host=PROXY_HOST_NAME

プロキシの配下でhabuを動かす場合は,proxy-hostを指定します。IPまたは,FQANで指定します。

このオプションは設定ファイルの指定を上書きします。

--proxy-proxy=PROXY_HOST_PORT

プロキシの配下でhabuを動かす場合は,proxy-hostに加えてproxy-portを指定します。指定しない場合は,80になります。

このオプションは設定ファイルの指定を上書きします。

--pid-file=PID_FILE_PATH

pidファイルを指定したパスに出力します。この機能は,デーモンモードで動作している場合に有効です。

用語説明

  • タスクモード: パイプラインを一度だけ実行してプログラムを終了します。
  • スケジューラモード(デーモンモード): プログラムが常駐して、パイプラインを定期実行します。