Sync EDKII BaseTools to BaseTools project r1971

[mirror_edk2.git] / BaseTools / UserManuals / InstallPkg_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 InstallPkg.exe\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Synopsis\par\r
\pard\nowidctlpar\sb200\cf2\fs18 InstallPkg.exe -i <distribution_package> [-t] [-f] [-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 InstallPkg reads a distribution package file and install its contents to current workspace. It parses [dist.pkg] in the zip file and install packages/modules/tools/miscfiles to workspace and update distribution package database of current workspace.\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 [-i --distribution-package]\par\r
      The distribution package to be installed\f1\par\r
\f0 [-t --install-tools]\par\r
\tab Specify it to install tools or ignore the tools of the distribution package.\f1\par\r
\f0 [-f --misc-files]\par\r
\f1\tab\f0 Specify it to install misc file or ignore the misc files of the distribution package.\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\\InstallPkg -i DistributionPackage.zip\f1\par\r
\tab\f0 Unzip the \ldblquote DistributionPackage.zip\rdblquote  to install all packages and modules of it.\par\r
3. C:\\MyWork\\InstallPkg -i DistributionPackage.zip -t -f\par\r
Unzip the \ldblquote DistributionPackage.zip\rdblquote  to install all packages and modules of it with the files of tools and misc files\par\r
4. If the package or module already exists in the workspace, the program will ask for a input:\f1\par\r
\pard\nowidctlpar\li360\sb200\b\f0 Directory [MdePkg] already exists, please select another location, press [Enter] with no input to quit:\par\r
\pard\nowidctlpar\sb200\b0\f1\tab\f0 So type a new directory to install the package/module to a new location or just press [ENTER] to exit the program.\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\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  MkPkg.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
\par\r
}\r
\0