Fixed memory leak and buffer overrun for string op-code.

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

{\rtf1\ansi\ansicpg936\deff0\deflang1033\deflangfe2052\deftab360{\fonttbl{\f0\fswiss\fprq2\fcharset0 Verdana;}{\f1\froman\fprq2\fcharset0 Times New Roman;}}\r
{\colortbl ;\red8\green96\blue168;\red0\green0\blue0;}\r
{\stylesheet{ Normal;}{\s1 heading 1;}{\s2 heading 2;}}\r
{\*\generator Msftedit 5.41.15.1515;}\viewkind4\uc1\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Name\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 MkPkg.exe\f1\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Synopsis\par\r
\pard\nowidctlpar\sb200\cf2\fs18 MkPkg.exe -m <module_file> -p <package_file> [-o distribution_file]\f1\par\r
\pard\nowidctlpar\fi360\li720\sb200\f0 [-x xml-file-header] [-t tools-directory] [-f misc-files] \f1\par\r
\f0 [-q | -v] [-h]\f1\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\f0\fs28 Description\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 MkPkg creates a distribution package file. It packages the specified native packages and native modules, generates an XML formatted description file for these packages and modules and zips them together to a compressed file.\f1\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Options\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 [-o --output-file]\par\r
\pard\nowidctlpar\fi-540\li540\sb200       Specify the distribution file to be created. The default file name is \ldblquote DistributionPackage.zip\rdblquote  \f1\par\r
\pard\nowidctlpar\sb200\f0 [-m, --module]\par\r
      The inf file of module to be distributed standalone.\f1\par\r
\f0 [-p, --package]\par\r
      The dec file of package to be distributed.\par\r
[-f --misc-files]\par\r
      Specify any misc files.\par\r
[-x --xml-file-header]\par\r
      Specify the xml file which includes header information for creating the distribution file.\f1\par\r
\f0 [-t --tools-directory]\par\r
      Specify the directory name of tools.\par\r
[-v, --verbose]\par\r
\pard\nowidctlpar\li360\sb200 Turn on verbose output with informational messages printed. \par\r
\pard\nowidctlpar\sb200 [-q, --quiet]\par\r
\tab Disable all messages except FATAL ERRORS.\par\r
[-h, --help]\par\r
\tab Print copyright, version and usage of this program and exit.\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Example\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 1. Before execute the program, please enter the workspace directory and execute \ldblquote edksetup\rdblquote  to initialize the workspace, in next examples, the workspace is C:\\MyWork\par\r
2. C:\\MyWork\\MkPkg -p MdeModulePkg\\MdeModulePkg.dec\f1\par\r
\tab\f0 Generate a \ldblquote DistributionPackage.zip\rdblquote  file to zip all contents of [MdeModulePkg] package \par\r
3. C:\\MyWork\\MkPkg -p MdePkg\f1\\\f0 MdePkg.dec -m MdeModulePkg\\Application\\HelloWorld\\HelloWorld.inf\f1\par\r
\tab\f0 Generate a \ldblquote DistributionPackage.zip\rdblquote  file to zip all contents of [MdePkg] package and a standalone module [HelloWorld]\par\r
4. C:\\MyWork\\MkPkg -m MdeModulePkg\\Application\\HelloWorld\\HelloWorld.inf -o Hello.far\par\r
\tab Generate a \ldblquote Hello.far\rdblquote  file to zip all contents of a standalone module [HelloWorld]\par\r
5. C:\\MyWork\\MkPkg -m MdeModulePkg\\Application\\HelloWorld\\HelloWorld.inf -t BaseTools\par\r
\tab Generate a \ldblquote DistributionPackage.zip\rdblquote  file to zip all contents of a standalone module [HelloWorld] with all files under directory [BaseTools]\par\r
6. C:\\MyWork\\MkPkg -m MdeModulePkg\\Application\\HelloWorld\\HelloWorld.inf -f Conf\\build_rule.txt\par\r
\f1\tab\f0 Generate a \ldblquote DistributionPackage.zip\rdblquote  file to zip all contents of a standalone module [HelloWorld] with a misc file [Conf\\build_rule.txt]\par\r
7. C:\\MyWork\\MkPkg -p MdeModulePkg\\MdeModulePkg.dec -p MdePkg\\MdePkg.dec -x A.xml\f1\par\r
\tab\f0 Generate a \ldblquote DistributionPackage.zip\rdblquote  file to zip all contents of [MdeModulePkg] package and [MdePkg] package, the header information of this distribution package is read from [A.xml] (Refer to section [Sample of XML header file] for more information of the XML file header)\f1\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Bugs\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 Not found yet.\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Files \par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 None.\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 See also\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18  InstallPkg.exe, RmPkg.exe\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 License\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 Copyright (c) 2008 - 2009, Intel Corporation. All rights reserved.\par\r
This program and the accompanying materials are licensed and made available \par\r
under the terms and conditions of the BSD License which accompanies this \par\r
distribution.  The full text of the license may be found at\par\r
http://opensource.org/licenses/bsd-license.php\par\r
\par\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Sample of XML header file\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 <DistributionPackage xmlns="http://www.uefi.org/2008/2.1" xmlns:xsi="http:/www.w3.org/2001/XMLSchema-instance">\par\r
  <DistributionHeader  ReadOnly="true" RePackage="false">\par\r
\tab   <Name BaseName="Template">DistributionPackageTest</Name>\par\r
\tab   <GUID Version="1.6"> DF0DDA2E-EA83-480b-B2CE-FC0BB2F894C2 </GUID> \par\r
\tab   <Vendor> Nosuch Corporation </Vendor>\par\r
\tab   <Date>2008-03-24T09:30:00</Date> \par\r
\tab   <Copyright>Copyright (c)  2008, Nosuch Corporation. All rights reserved.</Copyright> \par\r
\tab   <License>\par\r
\tab     This program and the accompanying materials are licensed and made available under     \par\r
\tab     the terms and conditions of the BSD License which accompanies this distribution.  \par\r
\tab     The full text of the license may be found at: \par\r
\tab     http://opensource.org/licenses/bsd-license.php\par\r
\tab     THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT \par\r
\tab     WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par\r
\tab   </License>\par\r
\tab   <Abstract> Version 1.2 of the NoSuchChipset Distribution Package. </Abstract>\par\r
\tab   <Description> \par\r
\tab     Initial release of the NoSuchChipset, Version 1.0 providing the base data types \par\r
\tab     and libraries for NoSuch UEFI Driver. This includes special libraries for \par\r
\tab     reporting status codes of the driver. \par\r
\tab   </Description> \par\r
\tab   <XmlSpecification> 1.0 </XmlSpecification>\par\r
\tab </DistributionHeader>\par\r
</DistributionPackage>\f1\par\r
}\r
\0