Sync EDKII BaseTools to BaseTools project r1937.

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

{\rtf1\adeflang1025\ansi\ansicpg1252\uc2\adeff0\deff0\stshfdbch13\stshfloch0\stshfhich0\stshfbi0\deflang1033\deflangfe2052{\fonttbl{\f0\froman\fcharset0\fprq2{\*\panose 02020603050405020304}Times New Roman{\*\falt Times New Roman};}{\f13\fnil\fcharset134\fprq2{\*\panose 02010600030101010101}\'cb\'ce\'cc\'e5{\*\falt SimSun};}\r
{\f38\fnil\fcharset134\fprq2{\*\panose 02010600030101010101}@\'cb\'ce\'cc\'e5{\*\falt ???????????????????????????????};}{\f39\fswiss\fcharset0\fprq2{\*\panose 020b0604030504040204}Verdana{\*\falt Tahoma};}\r
{\f148\fnil\fcharset77\fprq0{\*\panose 00000000000000000000}Verdana-Bold{\*\falt Times New Roman};}{\f149\froman\fcharset238\fprq2 Times New Roman CE{\*\falt Times New Roman};}{\f150\froman\fcharset204\fprq2 Times New Roman Cyr{\*\falt Times New Roman};}\r
{\f152\froman\fcharset161\fprq2 Times New Roman Greek{\*\falt Times New Roman};}{\f153\froman\fcharset162\fprq2 Times New Roman Tur{\*\falt Times New Roman};}{\f154\fbidi \froman\fcharset177\fprq2 Times New Roman (Hebrew){\*\falt Times New Roman};}\r
{\f155\fbidi \froman\fcharset178\fprq2 Times New Roman (Arabic){\*\falt Times New Roman};}{\f156\froman\fcharset186\fprq2 Times New Roman Baltic{\*\falt Times New Roman};}\r
{\f157\froman\fcharset163\fprq2 Times New Roman (Vietnamese){\*\falt Times New Roman};}{\f281\fnil\fcharset0\fprq2 SimSun Western{\*\falt SimSun};}{\f531\fnil\fcharset0\fprq2 @\'cb\'ce\'cc\'e5 Western{\*\falt ???????????????????????????????};}\r
{\f539\fswiss\fcharset238\fprq2 Verdana CE{\*\falt Tahoma};}{\f540\fswiss\fcharset204\fprq2 Verdana Cyr{\*\falt Tahoma};}{\f542\fswiss\fcharset161\fprq2 Verdana Greek{\*\falt Tahoma};}{\f543\fswiss\fcharset162\fprq2 Verdana Tur{\*\falt Tahoma};}\r
{\f546\fswiss\fcharset186\fprq2 Verdana Baltic{\*\falt Tahoma};}{\f547\fswiss\fcharset163\fprq2 Verdana (Vietnamese){\*\falt Tahoma};}}{\colortbl;\red0\green0\blue0;\red0\green0\blue255;\red0\green255\blue255;\red0\green255\blue0;\red255\green0\blue255;\r
\red255\green0\blue0;\red255\green255\blue0;\red255\green255\blue255;\red0\green0\blue128;\red0\green128\blue128;\red0\green128\blue0;\red128\green0\blue128;\red128\green0\blue0;\red128\green128\blue0;\red128\green128\blue128;\red192\green192\blue192;\r
\red8\green96\blue168;\red198\green99\blue85;}{\stylesheet{\ql \li0\ri0\widctlpar\wrapdefault\aspalpha\aspnum\faauto\adjustright\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \ltrch\fcs0 \r
\fs24\lang1033\langfe2052\loch\f0\hich\af0\dbch\af13\cgrid\langnp1033\langfenp2052 \snext0 Normal;}{\*\cs10 \additive \ssemihidden Default Paragraph Font;}{\*\r
\ts11\tsrowd\trftsWidthB3\trpaddl108\trpaddr108\trpaddfl3\trpaddft3\trpaddfb3\trpaddfr3\tblind0\tblindtype3\tscellwidthfts0\tsvertalt\tsbrdrt\tsbrdrl\tsbrdrb\tsbrdrr\tsbrdrdgl\tsbrdrdgr\tsbrdrh\tsbrdrv \r
\ql \li0\ri0\widctlpar\wrapdefault\aspalpha\aspnum\faauto\adjustright\rin0\lin0\itap0 \rtlch\fcs1 \af0\afs20 \ltrch\fcs0 \fs20\lang1024\langfe1024\cgrid\langnp1024\langfenp1024 \snext11 \ssemihidden Normal Table;}}\r
{\*\latentstyles\lsdstimax156\lsdlockeddef0}{\*\rsidtbl \rsid2166179}{\*\generator Microsoft Word 11.0.0000;}{\info{\title Name}{\author jlin16}{\operator lgao4}{\creatim\yr2010\mo3\dy18\hr17\min13}{\revtim\yr2010\mo3\dy18\hr17\min13}{\version2}{\edmins0}\r
{\nofpages2}{\nofwords163}{\nofchars931}{\*\company ntm}{\nofcharsws1092}{\vern24615}{\*\password 00000000}}{\*\xmlnstbl {\xmlns1 http://schemas.microsoft.com/office/word/2003/wordml}{\xmlns2 urn:schemas-microsoft-com:office:smarttags}}\r
\paperw12240\paperh15840\margl2822\margr1526\margt1958\margb1800\gutter0\ltrsect \r
\deftab360\widowctrl\ftnbj\aenddoc\donotembedsysfont0\donotembedlingdata1\grfdocevents0\validatexml0\showplaceholdtext0\ignoremixedcontent0\saveinvalidxml0\showxmlerrors0\horzdoc\dghspace120\dgvspace120\dghorigin1701\dgvorigin1984\dghshow0\dgvshow3\r
\jcompress\viewkind1\viewscale100\rsidroot2166179 \fet0{\*\wgrffmtfilter 013f}\ilfomacatclnup0\ltrpar \sectd \ltrsect\linex0\sectdefaultcl\sftnbj {\*\pnseclvl1\pnucrm\pnstart1\pnindent720\pnhang {\pntxta \hich .}}{\*\pnseclvl2\r
\pnucltr\pnstart1\pnindent720\pnhang {\pntxta \hich .}}{\*\pnseclvl3\pndec\pnstart1\pnindent720\pnhang {\pntxta \hich .}}{\*\pnseclvl4\pnlcltr\pnstart1\pnindent720\pnhang {\pntxta \hich )}}{\*\pnseclvl5\pndec\pnstart1\pnindent720\pnhang {\pntxtb \hich (}\r
{\pntxta \hich )}}{\*\pnseclvl6\pnlcltr\pnstart1\pnindent720\pnhang {\pntxtb \hich (}{\pntxta \hich )}}{\*\pnseclvl7\pnlcrm\pnstart1\pnindent720\pnhang {\pntxtb \hich (}{\pntxta \hich )}}{\*\pnseclvl8\pnlcltr\pnstart1\pnindent720\pnhang {\pntxtb \hich (}\r
{\pntxta \hich )}}{\*\pnseclvl9\pnlcrm\pnstart1\pnindent720\pnhang {\pntxtb \hich (}{\pntxta \hich )}}\pard\plain \ltrpar\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\nowidctlpar\tx1440\wrapdefault\faauto\rin0\lin-1440\itap0 \rtlch\fcs1 \af0\afs24\alang1025 \r
\ltrch\fcs0 \fs24\lang1033\langfe2052\loch\af0\hich\af0\dbch\af13\cgrid\langnp1033\langfenp2052 {\rtlch\fcs1 \ab\af148\afs28 \ltrch\fcs0 \b\f148\fs28\cf17\insrsid2166179 \hich\af148\dbch\af13\loch\f148 Name\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \hich\af39\dbch\af13\loch\f39  \~tool name - short description\r
\par }\pard \ltrpar\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\nowidctlpar\tx1440\wrapdefault\faauto\rin0\lin-1440\itap0 {\rtlch\fcs1 \ab\af148\afs28 \ltrch\fcs0 \b\f148\fs28\cf17\insrsid2166179 \hich\af148\dbch\af13\loch\f148 Synopsis\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \hich\af39\dbch\af13\loch\f39  \~tool_name [Options] RequiredArguments\r
\par }\pard \ltrpar\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\nowidctlpar\tx1440\wrapdefault\faauto\rin0\lin-1440\itap0 {\rtlch\fcs1 \ab\af148\afs28 \ltrch\fcs0 \b\f148\fs28\cf17\insrsid2166179 \hich\af148\dbch\af13\loch\f148 Description\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \hich\af39\dbch\af13\loch\f39 tool functions and usage (when does this tool need to be used)\r
\par }\pard \ltrpar\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\nowidctlpar\tx1440\wrapdefault\faauto\rin0\lin-1440\itap0 {\rtlch\fcs1 \ab\af148\afs28 \ltrch\fcs0 \b\f148\fs28\cf17\insrsid2166179 \hich\af148\dbch\af13\loch\f148 Options\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \ab\af148\afs18 \ltrch\fcs0 \b\f148\fs18\insrsid2166179 \hich\af148\dbch\af13\loch\f148 -x abc, --xyz abc\r
\par }{\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \tab \hich\af39\dbch\af13\loch\f39 x equal to xyz,  set to required value value: abc\r
\par }{\rtlch\fcs1 \ab\af148\afs18 \ltrch\fcs0 \b\f148\fs18\insrsid2166179 \hich\af148\dbch\af13\loch\f148 -x [abc], --xyz [abc]}{\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \r
\par \tab \hich\af39\dbch\af13\loch\f39 x equal to xyz, abc is optional\r
\par }\pard \ltrpar\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\nowidctlpar\tx1440\wrapdefault\faauto\rin0\lin-1440\itap0 {\rtlch\fcs1 \ab\af148\afs28 \ltrch\fcs0 \b\f148\fs28\cf17\insrsid2166179 \hich\af148\dbch\af13\loch\f148 Examples\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \hich\af39\dbch\af13\loch\f39 Example 1 Description\r
\par }{\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\cf18\insrsid2166179 \hich\af39\dbch\af13\loch\f39     }{\rtlch\fcs1 \ab\af148\afs18 \ltrch\fcs0 \b\f148\fs18\cf18\insrsid2166179 \hich\af148\dbch\af13\loch\f148 code snippet}{\rtlch\fcs1 \af39\afs18 \r
\ltrch\fcs0 \f39\fs18\insrsid2166179 \r
\par \hich\af39\dbch\af13\loch\f39 Example 2 Description\r
\par }{\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\cf18\insrsid2166179 \hich\af39\dbch\af13\loch\f39     }{\rtlch\fcs1 \ab\af148\afs18 \ltrch\fcs0 \b\f148\fs18\cf18\insrsid2166179 \hich\af148\dbch\af13\loch\f148 code snippet}{\rtlch\fcs1 \af39\afs18 \r
\ltrch\fcs0 \f39\fs18\insrsid2166179 \r
\par }\pard \ltrpar\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\nowidctlpar\tx1440\wrapdefault\faauto\rin0\lin-1440\itap0 {\rtlch\fcs1 \ab\af148\afs28 \ltrch\fcs0 \b\f148\fs28\cf17\insrsid2166179 \hich\af148\dbch\af13\loch\f148 Bugs\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \hich\af39\dbch\af13\loch\f39 No known bugs.\r
\par \hich\af39\dbch\af13\loch\f39 Report bugs to }{\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\cf1\insrsid2166179\charrsid6704915 \hich\af39\dbch\af13\loch\f39 edk2-buildtools-{\*\xmlopen\xmlns2{\factoidname PersonName}}dev{\*\xmlclose}\r
el@lists.sourceforge.net}{\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \r
\par }\pard \ltrpar\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\nowidctlpar\tx1440\wrapdefault\faauto\rin0\lin-1440\itap0 {\rtlch\fcs1 \ab\af148\afs28 \ltrch\fcs0 \b\f148\fs28\cf17\insrsid2166179 \hich\af148\dbch\af13\loch\f148 Files \r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \hich\af39\dbch\af13\loch\f39 configuration files that tool depends on(optional)  - None. if not needed\r
\par }\pard \ltrpar\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\nowidctlpar\tx1440\wrapdefault\faauto\rin0\lin-1440\itap0 {\rtlch\fcs1 \ab\af148\afs28 \ltrch\fcs0 \b\f148\fs28\cf17\insrsid2166179 \hich\af148\dbch\af13\loch\f148 See also\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \hich\af39\dbch\af13\loch\f39  Tool-golden, Tool-silver, Tool-Copper - None if not applicable.\r
\par }\pard \ltrpar\ql \li-1440\ri0\sb400\sa60\sl-340\slmult0\nowidctlpar\tx1440\wrapdefault\faauto\rin0\lin-1440\itap0 {\rtlch\fcs1 \ab\af148\afs28 \ltrch\fcs0 \b\f148\fs28\cf17\insrsid2166179 \hich\af148\dbch\af13\loch\f148 License\r
\par }\pard \ltrpar\ql \li0\ri0\sb200\nowidctlpar\wrapdefault\faauto\rin0\lin0\itap0 {\rtlch\fcs1 \af39\afs18 \ltrch\fcs0 \f39\fs18\insrsid2166179 \hich\af39\dbch\af13\loch\f39 Copyright (c)  1999-2007 Intel Corporation. Al\hich\af39\dbch\af13\loch\f39 \r
l rights reserved\r
\par \hich\af39\dbch\af13\loch\f39 This program and the accompanying materials are licensed and made available \r
\par \hich\af39\dbch\af13\loch\f39 under the terms and conditions of the BSD License which accompanies this \r
\par \hich\af39\dbch\af13\loch\f39 distribution.  The full text of the license may be found at\r
\par \hich\af39\dbch\af13\loch\f39 http://opensource.org/licen\hich\af39\dbch\af13\loch\f39 ses/bsd-license.php\r
\par \r
\par \hich\af39\dbch\af13\loch\f39 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
\par \hich\af39\dbch\af13\loch\f39 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\par \r
\par }}