Apply/ExecOn

The name execon is deprecated and only kept for backwards compatibility.

execon という名称は非推奨です。 過去のバージョンとの互換性のためだけに残っています。

Description

説明

Executes a system command. When the os attribute is specified, then the command is only executed when Ant is run on one of the specified operating systems.

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

The files and/or directories of a number of FileSets, DirSets (since Ant 1.6) or FileLists (since Ant 1.6) are passed as arguments to the system command.

FileSetDirSet(Ant1.6〜)、 FileList(Ant1.6〜) で指定されたファイルやディレクトリが、システムコマンドに引数として渡されます。

If you specify a nested mapper and the dest attribute, the timestamp of each source file is compared to the timestamp of a target file which is defined by the nested mapper element and searched for in the given dest.

このとき、dest属性と mapperサブ要素を使うと、 ソースファイルと、dest内にある、mapper要素の定義に従ってそのソースと対応付けられるファイルとのタイムスタンプが比較されます。

At least one fileset or filelist is required, and you must not specify more than one mapper.

fileset または filelist が少なくとも一つは必要です。mapperは二つ以上指定することはできません。

Note that you cannot interact with the forked program, the only way to send input to it is via the input and inputstring attributes.

生成したプログラムと対話することはできません。 input属性、および inputstring 属性で指定した入力を通してのみ、プログラムに入力を渡すことができます。

Parameters

パラメータ

Attribute Description Required
executable the command to execute without any command line arguments. Yes
dest the directory where the <apply> expects the target files will be placed by the command, when it is executed. Yes, if you specify a nested mapper
spawn whether or not you want the commands to be spawned
Default is false.
If you spawn a command, its output will not be logged by ant.
The input, output, error, and result property settings are not active when spawning a process.
since Ant 1.6
No
dir the directory in which the command should be executed. No
relative whether the filenames should be passed on the command line as absolute or relative pathnames (relative to the base directory of the corresponding fileset/list for source files or the dest attribute for target files). No, default is false
forwardslash whether the file names should be passed with forward slashes even if the operating system requires other file separator. The option is ignored if the system file separator is a forward slash. No, default is false
os list of Operating Systems on which the command may be executed. No
output the file to which the output of the command should be redirected. If the error stream is not also redirected to a file or property, it will appear in this output. No
error The file to which the standard error of the command should be redirected. since Ant 1.6 No
logError This attribute is used when you wish to see error output in Ant's log and you are redirecting output to a file/property. The error output will not be included in the output file/property. If you redirect error with the "error" or "errorProperty" attributes, this will have no effect. since Ant 1.6 No
append whether output should be appended to or overwrite an existing file. Defaults to false. If you set parallel to false, you will probably want to set this one to true. No
outputproperty the name of a property in which the output of the command should be stored. Unless the error stream is redirected to a separate file or stream, this property will include the error output. No
errorproperty The name of a property in which the standard error of the command should be stored. since Ant 1.6 No
input A file from which the executed command's standard input is taken. This attribute is mutually exclusive with the inputstring attribute. since Ant 1.6 No
inputstring A string which serves as the input stream for the executed command. This attribute is mutually exclusive with the input attribute. since Ant 1.6 No
resultproperty the name of a property in which the return code of the command should be stored. Only of interest if failonerror=false. If you set parallel to false, only the result of the first execution will be stored. No
timeout Stop the command if it doesn't finish within the specified time (given in milliseconds). No
failonerror Stop the buildprocess if the command exits with a returncode other than 0. No
failifexecutionfails Stop the build if we can't start the program. Defaults to true. No
skipemptyfilesets Don't run the command, if no source files have been found or are newer than their corresponding target files. Despite its name, this attribute applies to filelists as well. No, default is false
parallel Run the command only once, appending all files as arguments. If false, command will be executed once for every file. Defaults to false. No
type One of file, dir or both. If set to file, only the names of plain files will be sent to the command. If set to dir, only the names of directories are considered.
Note: The type attribute does not apply to nested dirsets - dirsets always implicitly assume type to be dir.
No, default is file
newenvironment Do not propagate old environment when new environment variables are specified. No, default is false
vmlauncher Run command using the Java VM's execution facilities where available. If set to false the underlying OS's shell, either directly or through the antRun scripts, will be used. Under some operating systems, this gives access to facilities not normally available through the VM including, under Windows, being able to execute scripts, rather than their associated interpreter. If you want to specify the name of the executable as a relative path to the directory given by the dir attribute, it may become necessary to set vmlauncher to false as well. No, default is true
resolveExecutable When this attribute is true, the name of the executable if resolved firstly against the project basedir and if that does not exist, against the execution directory if specified. On Unix systems, if you only want to allow execution of commands in the user's path, set this to false. since Ant 1.6 No, default is false
maxparallel Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to <= 0 for unlimited. Defaults to unlimited. Since Ant 1.6. No
addsourcefile Whether source file names should be added to the command automatically. Defaults to true. Since Ant 1.6. No
verbose Whether to print a summary after execution or not. Defaults to false. Since Ant 1.6. No
属性 説明 必須
executable 実行したいコマンド。コマンドライン引数は含まない。 Yes
dest 実行の結果、ファイルが格納されるべきディレクトリ。 mapper要素を指定する場合、必須
spawn コマンドを別プロセスにするかどうか。
デフォルトは false。
trueにした場合、コマンドの出力はAnt側では記録されない。
入力、出力、エラー、結果に関するプロパティは指定できない。
Ant 1.6〜
No
dir コマンドが実行されるディレクトリ。 No
relative コマンドに渡されるファイル名を、絶対パスでなく相対パスにするかどうか (相対パスとは、fileset/listのベースディレクトリからの相対パス、またはdest属性からの相対パスになる)。 No, デフォルトはfalse
forwardslash コマンドに渡されるファイル名のファイルセパレータを、OSが期待するものに関わらず、スラッシュ「/」を用いるかどうか。 このオプションは、システムのファイルセパレータが / のとき無視される。 No, デフォルトはfalse
os コマンドを実行するオペレーティングシステムのリスト。 No
output コマンドの出力がリダイレクトされるファイル。 エラー出力先が別に指定されていない場合、それもこの出力に含まれる。 No
error コマンドのエラー出力がリダイレクトされるファイル。Ant 1.6〜 No
logError 出力のリダイレクト先を output や outputproperty で指定している場合で、 エラー出力をAnt側で表示したいときに指定する。 これを指定すると、エラー出力は output や outputproperty には含まれなくなる。 "error"または"errorProperty"を指定している場合は無視される。 Ant 1.6 〜 No
append 出力先が既存ファイルである場合、上書きするのではなく追記する。 デフォルトはfalse (上書き)。 parallel を false に指定したなら、これは true と指定するのがいい。 No
outputproperty コマンドの出力が格納されるプロパティ名。 エラー出力のリダイレクト先を指定していない場合は、エラー出力もあわせて格納される。 No
errorproperty エラー出力が格納されるプロパティ名。Ant 1.6〜 No
input コマンドが標準入力から受け取る場合の入力元ファイル。 inputstring要素と同時には指定できない。Ant 1.6〜 No
inputstring コマンドが標準入力から受け取る場合の入力文字列。 input要素と同時には指定できない。Ant 1.6〜 No
resultproperty コマンドのリターンコードが格納されるプロパティ名。 failonerror が false である場合のみ意味がある。 parallel が false である場合は、最初の結果だけが格納される。 No
timeout 指定された時間内に終了しない場合は、コマンドを止める(単位はミリ秒)。 No
failonerror コマンドが 0 以外のリターンコードで終了する場合は、ビルドプロセスを止める。 No
failifexecutionfails コマンドを実行開始できなかった場合、ビルドプロセスを止める。 デフォルトは true。 No
skipemptyfilesets ソースファイルが見つからないか、 対応するターゲットファイルより新しい場合は、コマンドを実行しない。 skipemptyfilesetsという属性名にかかわらず、filelistに対しても同様に動作する。 No, デフォルトはfalse
parallel すべてのファイル名を引数に並べて、コマンドを一回だけ実行する。 false の場合、コマンドはそれぞれのファイルに対して一回ずつ実行される。 デフォルトはfalse。 No
type filedirboth のどれかを指定する。 fileと指定した場合、通常のファイル名のみコマンド引数に指定される。 dirと指定した場合、ディレクトリ名のみが対象となる。 注: dirset内部要素に対しては効果がない ―― そもそも dirが指定されているとみなされる。 No, デフォルトは file
newenvironment 新しい環境変数を指定する場合、古い環境変数は継承しない。 No, デフォルトは false
vmlauncher Java VM が持つ実行機能を用いてコマンドを実行するかどうか。 false と設定した場合、OSのシェルが直接、あるいはantRun スクリプト経由で使われる。 これにより、一部の OS で、通常はVMから利用できない機能 ―― Windows上でスクリプトを実行するなど ―― を利用することができる 実行ファイルの名前を dir 属性で指定したディレクトリからの相対パスで指定したい場合には、 vmlauncher は false に設定する必要がある。 No。デフォルトは true
resolveExecutable trueに設定すると、executableの名前を、 まずプロジェクトのベースディレクトリを用いて解決することを試み、 存在しなければ実行ディレクトリから探索する。 Unixシステム上において、ユーザパス上に存在するコマンドのみを実行したい場合、falseに設定する。 Ant 1.6〜 No, デフォルトはfalse
maxparallel ソースファイルが多数だった場合に、一回のコマンド実行に渡すファイル数の最大値。 0以下を指定した場合は、無制限となる。デフォルトは無制限。 Ant 1.6〜 No
addsourcefile ソースファイル名をコマンドの引数に追加するかどうか。 デフォルトは trueAnt 1.6〜 No
verbose 実行後に要約を表示するかどうか。 デフォルトは falseAnt 1.6〜 No

Parameters specified as nested elements

内部要素として指定するパラメータ

fileset

You can use any number of nested <fileset> elements to define the files for this task and refer to <fileset>s defined elsewhere.

このタスクが操作対象とするファイルを指定するための<fileset> 要素を、 いくつでも内包できます。 別の場所で定義された <fileset> を参照することもできます。

filelist

Since Ant 1.6

Ant 1.6〜

You can use any number of nested <filelist> elements to define the files for this task and refer to <filelist>s defined elsewhere.

このタスクが操作対象とするファイルを指定するための<filelist> 要素を、 いくつでも内包できます。 別の場所で定義された <filelist> を参照することもできます。

dirset

Since Ant 1.6

Ant 1.6〜

You can use any number of nested <dirset> elements to define the directories for this task and refer to <dirset>s defined elsewhere.

このタスクが操作対象とするディレクトリを指定するための<dirlist> 要素を、 いくつでも内包できます。 別の場所で定義された <dirlist> を参照することもできます。

mapper

A single <mapper> specifies the target files relative to the dest attribute for dependency checking. At least one <fileset> or <filelist> is required.

dest属性で指定したターゲットファイルとの依存性を定義するための<mapper>をひとつだけ指定できます。 <fileset><filelist>が必要です。

arg

Command line arguments should be specified as nested <arg> elements. See Command line arguments.

コマンドライン引数は、<arg> 内部要素で指定します。 コマンドライン引数 を参照してください。

srcfile

By default the file names of the source files will be added to the end of the command line (unless you set addsourcefile to false). If you need to place it somewhere different, use a nested <srcfile> element between your <arg> elements to mark the insertion point.

デフォルトでは、ソースファイルのファイル名はコマンドラインの最後に加えられます (addsourcefileがfalseでない場合)。 別の位置に置きたい場合、<arg> 要素の間に、 挿入箇所を指定するための <srcfile> 要素を指定します。

targetfile

<targetfile> is similar to <srcfile> and marks the position of the target filename on the command line. If omitted, the target filenames will not be added to the command line at all. This element can only be specified, if you also define a nested mapper and the dest attribute.

<targetfile><srcfile> と同じ要領で、 コマンドライン上で、ターゲットファイル名を置きたい位置を指定します。 省略した場合、ターゲットファイル名はコマンドラインに加えられません。 この要素を指定するには、mapper要素 および dest 属性を指定しておく必要があります。

env

It is possible to specify environment variables to pass to the system command via nested <env> elements. See the description in the section about exec

<env> 要素で、環境変数を指定できます。 execセクションの説明を参照してください。

Examples

<apply executable="ls">
  <arg value="-l"/>
  <fileset dir="/tmp">
    <patternset>
      <exclude name="**/*.txt"/>
    </patternset>
  </fileset>
  <fileset refid="other.files"/>
</apply>

invokes ls -l, adding the absolute filenames of all files below /tmp not ending in .txt and all files of the FileSet with id other.files to the command line.

/tmp より下にある、.txt で終わるものを除く全てのファイルの絶対パスと、 idother.files である FileSet で指定されているファイルを引数として、 ls -l を呼び出します。

<apply executable="somecommand" parallel="false">
  <arg value="arg1"/>
  <srcfile/>
  <arg value="arg2"/>
  <fileset dir="/tmp"/>
</apply>

invokes somecommand arg1 SOURCEFILENAME arg2 for each file in /tmp replacing SOURCEFILENAME with the absolute filename of each file in turn. If parallel had been set to true, SOURCEFILENAME would be replaced with the absolute filenames of all files separated by spaces.

/tmp 内のファイルそれぞれについて、 somecommand arg1 SOURCEFILENAME arg2 (SOURCEFILENAMEは各ファイルの絶対パス) を起動します。 parallelを true に設定した場合、SOURCEFILENAME は、すべてのファイルの絶対パス名をスペースで区切ったものになります。

<apply executable="cc" dest="src/C" parallel="false">
  <arg value="-c"/>
  <arg value="-o"/>
  <targetfile/>
  <srcfile/>
  <fileset dir="src/C" includes="*.c"/>
  <mapper type="glob" from="*.c" to="*.o"/>
</apply>

invokes cc -c -o TARGETFILE SOURCEFILE for each .c file that is newer than the corresponding .o, replacing TARGETFILE with the absolute filename of the .o and SOURCEFILE with the absolute name of the .c file.

対応する .o より新しい .c ファイル全てについて、 cc -c -o TARGETFILE SOURCEFILEを起動します。 TARGETFILE は .o ファイルの絶対ファイル名、 SOURCEFILE は .c ファイルの絶対ファイル名にそれぞれ置き換えたものです。


Copyright © 2000-2004 The Apache Software Foundation. All rights Reserved.
[訳注:これは高崎 俊史, 漆島 賢二の訳を参考に、的場が翻訳しました。 日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]