Exec

説明

システムコマンドを実行します。os属性が指定されている場合、コマンドは指定されたオペレーティングシステムのいずれかでApache Antが実行された場合にのみ実行されます。

フォークされたプログラムと対話することはできません。入力データを送信する唯一の方法は、input属性とinputstring属性を使用することです。また、Ant 1.6以降、フォークされたプログラムで入力を読み込もうとすると、EOF（-1）が返されることに注意してください。これは、Ant 1.5ではそのような試行がブロックされていたこととは異なります。

プロジェクトのbasedirを基準とした相対パスを使用して実行可能ファイルを実行する場合は、一部のオペレーティングシステムでvmlauncher=falseを使用する必要がある場合があります。しかし、これでも失敗する可能性があります（Solaris 8/9が問題として報告されています）。resolveexecutable属性の方が信頼性が高く、次のような方法も有効です。

<property name="executable-full-path"
          location="../relative/path/to/executable"/>
<exec executable="${executable-full-path}" ...

Windowsユーザー

<exec>タスクはRuntime.execに委譲し、さらに::CreateProcessを呼び出します。このWin32関数が、呼び出しの正確なセマンティクスを定義します。特に、実行可能ファイルにファイル拡張子を付けない場合、.EXEファイルのみが検索され、.COM、.CMD、または環境変数PATHEXTにリストされている他のファイルタイプは検索されません。これはシェルによってのみ使用されます。

.batファイルは、一般的に直接実行できません。通常は、/cスイッチを使用してコマンドシェル実行可能ファイルcmdを実行する必要があります。

<target name="help">
  <exec executable="cmd">
    <arg value="/c"/>
    <arg value="ant.bat"/>
    <arg value="-p"/>
  </exec>
</target>

よくある問題は、実行可能ファイルがPATHにないことです。エラーメッセージCannot run program "...":CreateProcess error=2. The system cannot find the path specified.が表示された場合は、PATH変数を確認してください。コマンドラインで直接コマンドを入力してください。Windowsがコマンドを見つければ、Antでも実行できるはずです。（そうでない場合は、ユーザーメーリングリストでヘルプを依頼してください。）Windowsがプログラムを実行できない場合は、プログラムのディレクトリをPATHに追加するか（set PATH=%PATH%;dirOfProgram）、ビルドファイルのexecutable属性に絶対パスを指定してください。

Cygwinユーザー

<exec>タスクは、executableパラメータに/bin/shなどのパスを認識しません。これは、Antが実行されているJVMが標準のWindows実行可能ファイルであり、Cygwin環境を認識していないためです（つまり、cygwin1.dllを読み込みません）。これに対する唯一の回避策は、CygwinでJVMをコンパイルすることです（自己責任で）。たとえば、OpenJDKのCygwin向けビルド手順を参照してください。

OpenVMSユーザー

executableと<arg>要素を使用して指定されたコマンドは、一時的なDCLスクリプト内で指定されたとおりに実行されます。これにはいくつかの意味があります。

• DCLスクリプトは一時ディレクトリ内に作成されます。
• パスはVMSスタイルで記述する必要があります。
• executableがDCLスクリプトを指している場合、DCLスクリプトと同様に@記号を前に付けることを忘れないでください（例：executable=@[FOO]BAR.COM）。

HPが提供するJVMは、OpenVMSの終了コードの規則に従っていません。このタスクでJVMを実行する場合、タスクは誤ってエラーが発生したと主張したり（またはエラーを黙って無視したり）する可能性があります。JAVA.EXEを実行するためにこのタスクを使用しないでください。fork属性をtrueに設定した<java>タスクを使用してください。このタスクは、JVMによる終了コードの解釈に従います。

RedHat S/390ユーザー

linux-390で報告されているように、Ant Execタスクを介して呼び出されるシェルスクリプトには、インタープリターを指定する必要があります。つまり、スクリプトは次のようなもので始める必要があります。

#!/bin/bash

そうでないと、タスクは次のように失敗します。

[exec] Warning: UNIXProcess.forkAndExec native error: Exec format error
[exec] Result: 255

Unix（類似）システムでのバックグラウンドプロセスとしてのAntの実行

Antをバックグラウンドプロセスとして実行する場合（ant &など）、spawnをfalseに設定して<exec>タスクを使用する場合は、フォークされたプロセスに明示的な入力を提供する必要があります。そうでなければ、Antは標準入力から読み込もうとするため、中断されます。

パラメータ

例

<exec dir="${src}" executable="cmd.exe" os="Windows 2000" output="dir.txt">
  <arg line="/c dir"/>
</exec>

ネストされた要素として指定されたパラメータ

arg

コマンドライン引数は、ネストされた<arg>要素として指定する必要があります。コマンドライン引数を参照してください。

env

ネストされた<env>要素を使用して、システムコマンドに渡す環境変数を指定できます。

redirector

ネストされたI/Oリダイレクターを指定できます。一般的に、リダイレクターの属性は、タスクレベルで利用可能な対応する属性と同じように動作します。最も注目すべき特殊性は、後方互換性のために<exec>属性を保持することです。ファイルのマッピングはnullソースファイルを使用して行われます。そのため、すべてのMapperタイプが結果を返すわけではありません。結果が返されない場合、リダイレクトの仕様はタスクレベルの属性に戻ります。実際には、入力、出力、エラー出力ファイルのデフォルトを指定できることを意味します。

エラーと戻りコード

デフォルトでは、<exec>の戻りコードは無視されます。failonerrorをtrueに設定すると、失敗を示す戻りコード（OS固有）によってビルドが失敗します。または、resultpropertyをプロパティの名前に設定し、結果コードを割り当てることができます（不変性を除いて）。

プログラムの起動を試行した際にOS依存のエラーコードで失敗した場合、failifexecutionfailsがfalseに設定されていない限り、<exec>はビルドを停止します。これは、プログラムが存在する場合は実行しますが、存在しない場合は何も実行しない場合に使用できます。

これらのエラーコードの意味は何ですか？それらはOS依存です。Windowsボックスでは、ドキュメントを参照する必要があります。error=2は「そのようなプログラムはありません」を意味し、通常はパスにないことを意味します。Antタスクからそのようなエラーが表示された場合は、通常、Antのバグではなく、マシンの構成の問題です。

例

X Windowシステムのディスプレイ1でemacsを起動します。

<exec executable="emacs">
  <env key="DISPLAY" value=":1.0"/>
</exec>

システムコマンドのPATHに${basedir}/binを追加します。

<property environment="env"/>
<exec ... >
  <env key="PATH" path="${env.PATH}:${basedir}/bin"/>
</exec>

指定された${file}を使用して${browser}を起動し、Antプロセスを終了します。ブラウザは残ります。

<property name="browser" location="C:/Program Files/Internet Explorer/iexplore.exe"/>
<property name="file" location="ant/docs/manual/index.html"/>

<exec executable="${browser}" spawn="true">
    <arg value="${file}"/>
</exec>

blah before blahという文字列をcat実行可能ファイルに送信します。<inputfilterchain>を使用して、入力時にbeforeをafterに置き換えます。出力はredirector.outファイルに送信され、同じ名前のプロパティに格納されます。同様に、エラー出力はファイルとプロパティの両方に送信され、どちらもredirector.errという名前になります。

<exec executable="cat">
    <redirector outputproperty="redirector.out"
                errorproperty="redirector.err"
                inputstring="blah before blah">
        <inputfilterchain>
            <replacestring from="before" to="after"/>
        </inputfilterchain>
        <outputmapper type="merge" to="redirector.out"/>
        <errormapper type="merge" to="redirector.err"/>
    </redirector>
</exec>

注記: 引数を単純なarg要素で指定し、スペースで区切ろうとしないでください。これにより、文字列全体を含む単一の引数のみが作成されます。

タイムアウト: タイムアウトが指定されている場合、タイムアウトに達するとサブプロセスがキルされ、ログにメッセージが出力されます。実行の戻り値は-1となり、failonerror=trueの場合、ビルドが停止しますが、それ以外の場合は無視されます。