BaseTools/UserManuals/MkPkg_Utility_Man_Page.rtf

   1 {\rtf1\ansi\ansicpg936\deff0\deflang1033\deflangfe2052\deftab360{\fonttbl{\f0\fswiss\fprq2\fcharset0 Verdana;}{\f1\froman\fprq2\fcharset0 Times New Roman;}}
   2 {\colortbl ;\red8\green96\blue168;\red0\green0\blue0;}
   3 {\stylesheet{ Normal;}{\s1 heading 1;}{\s2 heading 2;}}
   4 {\*\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
   5 \pard\nowidctlpar\sb200\cf2\b0\fs18 MkPkg.exe\f1\par
   6 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Synopsis\par
   7 \pard\nowidctlpar\sb200\cf2\fs18 MkPkg.exe -m <module_file> -p <package_file> [-o distribution_file]\f1\par
   8 \pard\nowidctlpar\fi360\li720\sb200\f0 [-x xml-file-header] [-t tools-directory] [-f misc-files] \f1\par
   9 \f0 [-q | -v] [-h]\f1\par
  10 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\f0\fs28 Description\par
  11 \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
  12 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Options\par
  13 \pard\nowidctlpar\sb200\cf2\b0\fs18 [-o --output-file]\par
  14 \pard\nowidctlpar\fi-540\li540\sb200       Specify the distribution file to be created. The default file name is \ldblquote DistributionPackage.zip\rdblquote  \f1\par
  15 \pard\nowidctlpar\sb200\f0 [-m, --module]\par
  16       The inf file of module to be distributed standalone.\f1\par
  17 \f0 [-p, --package]\par
  18       The dec file of package to be distributed.\par
  19 [-f --misc-files]\par
  20       Specify any misc files.\par
  21 [-x --xml-file-header]\par
  22       Specify the xml file which includes header information for creating the distribution file.\f1\par
  23 \f0 [-t --tools-directory]\par
  24       Specify the directory name of tools.\par
  25 [-v, --verbose]\par
  26 \pard\nowidctlpar\li360\sb200 Turn on verbose output with informational messages printed. \par
  27 \pard\nowidctlpar\sb200 [-q, --quiet]\par
  28 \tab Disable all messages except FATAL ERRORS.\par
  29 [-h, --help]\par
  30 \tab Print copyright, version and usage of this program and exit.\par
  31 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Example\par
  32 \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
  33 2. C:\\MyWork\\MkPkg -p MdeModulePkg\\MdeModulePkg.dec\f1\par
  34 \tab\f0 Generate a \ldblquote DistributionPackage.zip\rdblquote  file to zip all contents of [MdeModulePkg] package \par
  35 3. C:\\MyWork\\MkPkg -p MdePkg\f1\\\f0 MdePkg.dec -m MdeModulePkg\\Application\\HelloWorld\\HelloWorld.inf\f1\par
  36 \tab\f0 Generate a \ldblquote DistributionPackage.zip\rdblquote  file to zip all contents of [MdePkg] package and a standalone module [HelloWorld]\par
  37 4. C:\\MyWork\\MkPkg -m MdeModulePkg\\Application\\HelloWorld\\HelloWorld.inf -o Hello.far\par
  38 \tab Generate a \ldblquote Hello.far\rdblquote  file to zip all contents of a standalone module [HelloWorld]\par
  39 5. C:\\MyWork\\MkPkg -m MdeModulePkg\\Application\\HelloWorld\\HelloWorld.inf -t BaseTools\par
  40 \tab Generate a \ldblquote DistributionPackage.zip\rdblquote  file to zip all contents of a standalone module [HelloWorld] with all files under directory [BaseTools]\par
  41 6. C:\\MyWork\\MkPkg -m MdeModulePkg\\Application\\HelloWorld\\HelloWorld.inf -f Conf\\build_rule.txt\par
  42 \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
  43 7. C:\\MyWork\\MkPkg -p MdeModulePkg\\MdeModulePkg.dec -p MdePkg\\MdePkg.dec -x A.xml\f1\par
  44 \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
  45 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Bugs\par
  46 \pard\nowidctlpar\sb200\cf2\b0\fs18 Not found yet.\par
  47 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Files \par
  48 \pard\nowidctlpar\sb200\cf2\b0\fs18 None.\par
  49 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 See also\par
  50 \pard\nowidctlpar\sb200\cf2\b0\fs18  InstallPkg.exe, RmPkg.exe\par
  51 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 License\par
  52 \pard\nowidctlpar\sb200\cf2\b0\fs18 Copyright (c) 2008 - 2009, Intel Corporation. All rights reserved.\par
  53 This program and the accompanying materials are licensed and made available \par
  54 under the terms and conditions of the BSD License which accompanies this \par
  55 distribution.  The full text of the license may be found at\par
  56 http://opensource.org/licenses/bsd-license.php\par
  57 \par
  58 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par
  59 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par
  60 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Sample of XML header file\par
  61 \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
  62   <DistributionHeader  ReadOnly="true" RePackage="false">\par
  63 \tab   <Name BaseName="Template">DistributionPackageTest</Name>\par
  64 \tab   <GUID Version="1.6"> DF0DDA2E-EA83-480b-B2CE-FC0BB2F894C2 </GUID> \par
  65 \tab   <Vendor> Nosuch Corporation </Vendor>\par
  66 \tab   <Date>2008-03-24T09:30:00</Date> \par
  67 \tab   <Copyright>Copyright (c)  2008, Nosuch Corporation. All rights reserved.</Copyright> \par
  68 \tab   <License>\par
  69 \tab     This program and the accompanying materials are licensed and made available under     \par
  70 \tab     the terms and conditions of the BSD License which accompanies this distribution.  \par
  71 \tab     The full text of the license may be found at: \par
  72 \tab     http://opensource.org/licenses/bsd-license.php\par
  73 \tab     THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT \par
  74 \tab     WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par
  75 \tab   </License>\par
  76 \tab   <Abstract> Version 1.2 of the NoSuchChipset Distribution Package. </Abstract>\par
  77 \tab   <Description> \par
  78 \tab     Initial release of the NoSuchChipset, Version 1.0 providing the base data types \par
  79 \tab     and libraries for NoSuch UEFI Driver. This includes special libraries for \par
  80 \tab     reporting status codes of the driver. \par
  81 \tab   </Description> \par
  82 \tab   <XmlSpecification> 1.0 </XmlSpecification>\par
  83 \tab </DistributionHeader>\par
  84 </DistributionPackage>\f1\par
  85 }
  86