BaseTools/UserManuals/UtilityManPage_template.rtf

   1 {\rtf1\ansi\ansicpg1252\deff0\deflang1033\deflangfe2052\deftab360{\fonttbl{\f0\fnil\fcharset77 Verdana-Bold;}{\f1\fswiss\fprq2\fcharset0 Verdana;}}
   2 {\colortbl ;\red8\green96\blue168;\red198\green99\blue85;\red0\green0\blue0;}
   3 {\*\generator Msftedit 5.41.15.1515;}\viewkind4\uc1\pard\nowidctlpar\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Name\par
   4 \pard\nowidctlpar\sb200\cf0\b0\f1\fs18  \~tool name - short description\par
   5 \pard\nowidctlpar\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Synopsis\par
   6 \pard\nowidctlpar\sb200\cf0\b0\f1\fs18  \~tool_name [Options] RequiredArguments\par
   7 \pard\nowidctlpar\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Description\par
   8 \pard\nowidctlpar\sb200\cf0\b0\f1\fs18 tool functions and usage (when does this tool need to be used)\par
   9 \pard\nowidctlpar\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Options\par
  10 \pard\nowidctlpar\sb200\cf0\fs18 -x abc, --xyz abc\par
  11 \b0\f1\tab x equal to xyz,  set to required value value: abc\par
  12 \b\f0 -x [abc], --xyz [abc]\b0\f1\par
  13 \tab x equal to xyz, abc is optional\par
  14 \pard\nowidctlpar\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Examples\par
  15 \pard\nowidctlpar\sb200\cf0\b0\f1\fs18 Example 1 Description\par
  16 \cf2     \b\f0 code snippet\cf0\b0\f1\par
  17 Example 2 Description\par
  18 \cf2     \b\f0 code snippet\cf0\b0\f1\par
  19 \pard\nowidctlpar\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Bugs\par
  20 \pard\nowidctlpar\sb200\cf0\b0\f1\fs18 No known bugs.\par
  21 Report bugs to \cf3 edk2-buildtools-devel@lists.sourceforge.net\cf0\par
  22 \pard\nowidctlpar\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Files \par
  23 \pard\nowidctlpar\sb200\cf0\b0\f1\fs18 configuration files that tool depends on(optional)  - None. if not needed\par
  24 \pard\nowidctlpar\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 See also\par
  25 \pard\nowidctlpar\sb200\cf0\b0\f1\fs18  Tool-golden, Tool-silver, Tool-Copper - None if not applicable.\par
  26 \pard\nowidctlpar\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 License\par
  27 \pard\nowidctlpar\sb200\cf0\b0\f1\fs18 Copyright (c) 1999 - 2007, Intel Corporation. All rights reserved.\par
  28 This program and the accompanying materials are licensed and made available \par
  29 under the terms and conditions of the BSD License which accompanies this \par
  30 distribution.  The full text of the license may be found at\par
  31 http://opensource.org/licenses/bsd-license.php\par
  32 \par
  33 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par
  34 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par
  35 \par
  36 }
  37