< 目次

advisor コマンドライン・インターフェイスのリファレンス

このリファレンス・セクションでは、コマンド構文で使用される CLI アクションとオプションについて説明します。advisor <--action> [--action-options] [--global-options] [[--] target [target options]]

GUI の代わりにインテル® Advisor コマンドライン・インターフェイス (advisor) を使用する利点は、自動またはバックグラウンド・タスクの一部としてデータ収集と解析を行い、その結果を利用したいときにコマンドライン・インターフェイス (CLI) レポート (または GUI) で表示できることです。

必要条件: コマンドライン・インターフェイスを使用する前に、インテル® Advisor の環境変数を設定します。

ヒント

インテル® Advisor GUI から選択した設定のコマンドラインを生成できます。[Analysis Workflow (解析ワークフロー)] ペイン:

advisor コマンド構文

advisor コマンド構文は次のようになります。

advisor <--action> [--action-options] [--global-options] [[--] target [target options]]

説明:

advisor

インテル® Advisor コマンドライン・ツールの名称です。

<--action>

collect または report でアクションを実行します。それぞれのコマンドでは、1 つのアクションのみ指定できます。例えば、同じコマンドで collect と report アクションの両方を使用することはできません。

[--action-options]

特定のアクションの動作を変更します。コマンドごとに複数のアクション・オプションを使用できます。アクションに適用されないアクション・オプションを使用すると用法エラーとなります。

[--global-options]

同じ方法ですべてのアクションの動作を変更します。アクションごとに複数のグローバルオプションを使用できます。

target

解析するターゲット (アプリケーションの実行形式) です。

[target-options]

ターゲットに適用するオプションです。

アクションオプション/グローバルオプションの規則。

代替構文

アクションオプションまたはグローバルオプションの前にダッシュ (-) を 1 つまたは 2 つ指定できます。ここでは、アクションオプションとグローバルオプションのショート形式の前にはシングルダッシュ (-) を使用し、ロング形式の前にはダブルダッシュ (--) を使用します。例: 次の命令はすべて同等です。

advisor --help

advisor -help

オプションと値は、等号 (=) またはスペースで分離することができます。ここでは等号を使用します。例: 次の命令はすべて同等です。

advisor --report=survey

advisor --report survey

ターゲット実行形式ファイルの前には、2 つのダッシュ (-) とスペースが必要です。例:

advisor --collect=survey -- ./myApplication

アクションオプションには、複数の引数を指定できるものがあります。ほとんどの場合、引数はカンマで区切った文字列 (スペースなし) で渡すか、アクションオプションを繰り返して指定します。以下に例を示します。以下は同等です。

advisor --collect=survey --project-dir=./advi_results --exclude-files=./src/foo,./src/bar -- ./myApplication

advisor --collect=survey --project-dir=./advi_results --exclude-files=./src/foo --exclude-files=./src/bar -- ./myApplication

ディレクトリー

プロジェクトのディレクトリー

デフォルトでは、プロジェクト・ディレクトリーは現在の作業ディレクトリーに設定されています。レポートを異なるディレクトリーに書き込むには、project-dir アクションオプションを使用します。例:

アプリケーションのホットスポットを調査し、結果を ./advi プロジェクト・ディレクトリーに保存します。

advisor --collect=survey --project-dir=./advi_results --search-dir all:=./src -- ./myApplication

サーベイの結果からサーベイレポートを生成し、./advi プロジェクト・ディレクトリーに保存します。

advisor --report=survey --project-dir=./advi_results --format=text --report-output=./out/survey.txt

検索ディレクトリー

search-dir アクションオプションを使用して、解析中に使用されるソース、シンボル、およびバイナリーファイルを含むディレクトリーを指定します。

複数の検索ディレクトリーを指定できます。例:

advisor --collect=survey --project-dir=./advi_results --search-dir src:=./src1,./src2 -- ./myApplication

ヒント

collect アクションを使用する場合、常に検索ディレクトリーを指定しましょう。

ユーザー・データ・ディレクトリー

project-dir に十分なスペースがない場合、リモート・ディレクトリーや別のディレクトリーなど project-dir 以外のディレクトリに結果ファイルを書き込みたい場合は、user-data-dir アクションオプションを使用しします。

例: スータビリティー・データを収集して、結果をリモート・ディレクトリーに保存します。

advisor --collect=suitability --project-dir=./advi_results --user-data-dir=./remote_dir --search-dir src:=./src -- ./myApplication

上位トピック: コマンドライン・インターフェイス