Sync EDKII BaseTools to BaseTools project r1971

[mirror_edk2.git] / BaseTools / UserManuals / TargetTool_Utility_Man_Page.rtf

{\rtf1\ansi\ansicpg1252\deff0\deflang1033\deflangfe2052\deftab360{\fonttbl{\f0\fswiss\fprq2\fcharset0 Verdana;}{\f1\froman\fprq2\fcharset0 Times New Roman;}{\f2\fmodern\fprq1\fcharset0 Courier New;}{\f3\fswiss\fprq2\fcharset0 Arial;}}
{\colortbl ;\red8\green96\blue168;\red0\green0\blue0;}
{\stylesheet{ Normal;}{\s1 heading 1;}{\s2 heading 2;}}
{\*\generator Msftedit 5.41.15.1515;}\viewkind4\uc1\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Name\par
\pard\nowidctlpar\sb200\cf2\b0\fs18 TargetTool.exe or TargetToo.py \endash  Command line tool edits EDKII build configuration file: target.txt.\par
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Synopsis\par
\pard\nowidctlpar\sb200\cf2\fs18 TargetTool [options] \{args\}\b0\f1\par
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Description\par
\pard\nowidctlpar\sb200\cf2\b0\fs18 TargetTool can be used to print current build setting in target.txt. It can also be used to clear current setting in target.txt. Meanwhile, it can be used to modify the current setting in target.txt. After it sets the build configuration, build tool can run without any command line option to build the tip with the current setting in target.txt. TargetTool command line option can be specified together to print or set one or a group of configurations.\f1\par
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Options\par
\pard\nowidctlpar\sb200\cf2\fs18 Args\f1\par
\pard\nowidctlpar\li360\sb200\b0\f0 This is the required command option, which can be one of the follow values.\par
Clean  Clean the all default configuration of target.txt.\par
Print   Print the all default configuration of target.txt.\par
Set    Replace the default configuration with expected value specified by option.\par
\pard\nowidctlpar\sb200\b -a TARGET_ARCH, --arch=TARGET_ARCH\par
\pard\nowidctlpar\li360\sb200\b0 ARCHS is one of list: IA32, X64, IPF or EBC, which replaces target.txt's TARGET_ARCH definition. Tospecify more archs, please repeat this option. 0 will clear this setting in target.txt and can't combine with other value.\par
\pard\nowidctlpar\sb200\b -p DSCFILE, --platform=DSCFILE\cf0\b0\f2\fs20\par
\pard\nowidctlpar\li360\sb200\cf2\f0\fs18 Specify a DSC file, which replace target.txt's ACTIVE_PLATFORM definition. 0 will clear this setting in target.txt and can't combine with other value.\par
\pard\nowidctlpar\sb200\b -c TOOL_DEFINITION_FILE, --tooldef=TOOL_DEFINITION_FILE\cf0\b0\f2\fs20\par
\pard\nowidctlpar\li360\sb200\cf2\f0\fs18 Specify the WORKSPACE relative path of tool_def.txt file, which replace target.txt's TOOL_CHAIN_CONF definition. 0 will clear this setting in target.txt and can't combine with other value.\par
\pard\nowidctlpar\sb200\b -t TARGET, --target=TARGET\par
\pard\nowidctlpar\li360\sb200\b0 TARGET is one of list: DEBUG, RELEASE, which replaces target.txt's TARGET definition. To specify more TARGET, please repeat this option. 0 will clear this setting in target.txt and can't combine with other value.\par
\pard\nowidctlpar\sb200\b -n TOOL_CHAIN_TAG, --tagname=TOOL_CHAIN_TAG\par
\pard\nowidctlpar\li360\sb200\b0 Specify the Tool Chain Tagname, which replaces target.txt's TOOL_CHAIN_TAG definition. 0 will clear this setting in target.txt and can't combine with other value.\par
\pard\nowidctlpar\sb200\b -r BUILD_RULE_FILE, --buildrule=BUILD_RULE_FILE\par
\pard\nowidctlpar\li360\sb200\b0 Specify the build rule configure file, which replaces target.txt's BUILD_RULE_CONF definition. If not specified, the default value Conf/build_rule.txt will be set.\par
\pard\nowidctlpar\sb200\b -m NUM, --multithread=NUM\par
\pard\nowidctlpar\li360\sb200\b0 Specify the multi-thread number which replace target.txt's MAX_CONCURRENT_THREAD_NUMBER. If the value is less than 2, MULTIPLE_THREAD will be disabled. If the value is larger than 1, MULTIPLE_THREAD will be enabled.\f1\par
\pard\nowidctlpar\sb200\b\f0 --version\f1\par
\pard\nowidctlpar\fi360\sb200\b0\f0 Show program's version number and exit\par
\pard\nowidctlpar\sb200\b -h, --help\par
\pard\nowidctlpar\li360\sb200\b0 Show this help message and exit\f1\par
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Example\par
\pard\nowidctlpar\sb200\cf2\b0\fs18 1. Print current build setting in target.txt  \par
\b TargetTool Print\f1\par
\b0\f0 2. Clear current build setting in target.txt.\par
\b TargetTool Clean\b0\f1\par
\f0 3. Set the build thread number to 3.\f1\par
\b\f0 TargetTool -m 3 set\f1\par
\b0\f0 4. Set the build arch to IA32, X64 and IPF both.  \par
\b TargetTool -a IA32 -a X64 -a IPF set\f1\par
\b0\f0 5. Set the build target to DEBUG and set the active platform to NT32Pkg.dsc\f1\par
\b\f0 TargetTool -t DEBUG -p Nt32Pkg/Nt32Pkg.dsc set\f1\par
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\f0\fs28 Bugs\par
\pard\nowidctlpar\sb200\cf2\b0\fs18 No known bugs.\par
Report bugs to edk2-buildtools-devel@lists.sourceforge.net\f1\par
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Files\par
\pard\nowidctlpar\sb200\cf2\b0\fs18 None\par
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 See also\par
\pard\nowidctlpar\sb200\cf2\b0\fs18 None\par
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 License\par
\pard\nowidctlpar\cf2\b0\fs18 Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.\par
This program and the accompanying materials are licensed and made available \par
under the terms and conditions of the BSD License which accompanies this \par
distribution.  The full text of the license may be found at\par
http://opensource.org/licenses/bsd-license.php\par
\par
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par
\pard\nowidctlpar\sb200 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par
\cf0\f1\par
\pard\nowidctlpar\f3\fs20\par
}