BaseTools/UserManuals/UtilityManPage_template.rtf

   1 {\rtf1\mac\ansicpg10000\cocoartf824\cocoasubrtf420
   2 {\fonttbl\f0\fnil\fcharset77 Verdana-Bold;\f1\fnil\fcharset77 Verdana;}
   3 {\colortbl;\red255\green255\blue255;\red8\green96\blue168;\red198\green99\blue85;\red198\green99\blue85;
   4 }
   5 {\info
   6 {\title Name}
   7 {\author jlin16}
   8 {\*\company ntm}}\margl2822\margr1526\margb1800\margt1958\vieww18720\viewh15160\viewkind1\viewscale100
   9 \deftab360
  10 \pard\tx1440\pardeftab360\li-1440\ri0\sl-340\sb400\sa60
  11
  12 \f0\b\fs28 \cf2 Name\
  13 \pard\pardeftab360\ri0\sb200
  14
  15 \f1\b0\fs18 \cf0  \'catool name - short description\
  16 \pard\tx1440\pardeftab360\li-1440\ri0\sl-340\sb400\sa60\ql\qnatural
  17
  18 \f0\b\fs28 \cf2 Synopsis\
  19 \pard\pardeftab360\ri0\sb200\ql\qnatural
  20
  21 \f1\b0\fs18 \cf0  \'catool_name [Options] RequiredArguments\
  22 \pard\tx1440\pardeftab360\li-1440\ri0\sl-340\sb400\sa60
  23
  24 \f0\b\fs28 \cf2 Description\
  25 \pard\pardeftab360\ri0\sb200
  26
  27 \f1\b0\fs18 \cf0 tool functions and usage (when does this tool need to be used)\
  28 \pard\tx1440\pardeftab360\li-1440\ri0\sl-340\sb400\sa60
  29
  30 \f0\b\fs28 \cf2 Options\
  31 \pard\pardeftab360\ri0\sb200
  32
  33 \fs18 \cf0 -x abc, --xyz abc\
  34
  35 \f1\b0  x equal to xyz,  set to required value value: abc\
  36
  37 \f0\b -x [abc], --xyz [abc]
  38 \f1\b0 \
  39         x equal to xyz, abc is optional\
  40 \pard\tx1440\pardeftab360\li-1440\ri0\sl-340\sb400\sa60
  41
  42 \f0\b\fs28 \cf2 Examples\
  43 \pard\pardeftab360\ri0\sb200
  44
  45 \f1\b0\fs18 \cf0 Example 1 Description\
  46 \cf3
  47 \f0\b code snippet
  48 \f1\b0 \cf0 \
  49 Example 2 Description\
  50 \pard\pardeftab360\ri0\sb200\ql\qnatural
  51 \cf4
  52 \f0\b code snippet
  53 \f1\b0 \cf0 \
  54 \pard\tx1440\pardeftab360\li-1440\ri0\sl-340\sb400\sa60
  55
  56 \f0\b\fs28 \cf2 Bugs\
  57 \pard\pardeftab360\ri0\sb200
  58
  59 \f1\b0\fs18 \cf0 No known bugs.\
  60 Report bugs to issues@buildtools.tianocore.org\
  61 \pard\tx1440\pardeftab360\li-1440\ri0\sl-340\sb400\sa60
  62
  63 \f0\b\fs28 \cf2 Files \
  64 \pard\pardeftab360\ri0\sb200
  65
  66 \f1\b0\fs18 \cf0 configuration files that tool depends on(optional)  - None. if not needed\
  67 \pard\tx1440\pardeftab360\li-1440\ri0\sl-340\sb400\sa60
  68
  69 \f0\b\fs28 \cf2 See also\
  70 \pard\pardeftab360\ri0\sb200
  71
  72 \f1\b0\fs18 \cf0  Tool-golden, Tool-silver, Tool-Copper - None if not applicable.\
  73 \pard\tx1440\pardeftab360\li-1440\ri0\sl-340\sb400\sa60
  74
  75 \f0\b\fs28 \cf2 License\
  76 \pard\pardeftab360\ri0\sb200
  77
  78 \f1\b0\fs18 \cf0 Copyright (c)  1999-2007 Intel Corporation. All rights reserved\
  79 This program and the accompanying materials are licensed and made available \
  80 under the terms and conditions of the BSD License which accompanies this \
  81 distribution.  The full text of the license may be found at\
  82 http://opensource.org/licenses/bsd-license.php\
  83 \
  84 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\
  85 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\
  86 \
  87 }