BaseTools/UserManuals/TianoCompress_Utility_Man_Page.rtf

   1 {\rtf1\ansi\ansicpg1252\deff0\deflang1033\deflangfe2052\deftab360{\fonttbl{\f0\fswiss\fprq2\fcharset0 Verdana;}{\f1\froman\fprq2\fcharset0 Times New Roman;}}
   2 {\colortbl ;\red0\green127\blue127;\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\fi-1300\li-1440\sb400\sa60\sl-340\slmult0\tx0\tx1440\cf1\b\f0\fs28 Name\par
   5 \pard\nowidctlpar\sb200\cf2\b0\fs18 TianoCompress.exe \endash  encode or decode a file\par
   6 \pard\keep\keepn\nowidctlpar\s2\fi-1300\li-1440\sb400\sa60\sl-340\slmult0\tx0\tx1440\cf1\b\fs28 Synopsis\par
   7 \pard\nowidctlpar\sb200\cf2\fs18 TianoCompress.exe [options] Filename\par
   8 \pard\keep\keepn\nowidctlpar\s2\fi-1300\li-1440\sb400\sa60\sl-340\slmult0\tx0\tx1440\cf1\fs28 Description\par
   9 \pard\nowidctlpar\sb200\cf2\b0\fs18 TianoCompress tool is used to encode or decode files with EFI extension encode or decode algorithm. When \ldblquote -e\rdblquote  option specified in command line, then the tool will encode the input file with EFI extension encode algorithm; when \ldblquote -d\rdblquote  option specified in command line, then the tool will decode the input file with EFI extension decode algorithm.  When decoding file, this tool performs some rudimentary checking on the input files to verify they are indeed compressed by EFI extension algorithm. These checks include: \par
  10     Check the input file header (8 bytes header); \par
  11     The first 4 bytes is component size (not usable); \par
  12     The following 4 bytes is original size which is the input file size and it is the decompressed file size. \par
  13 While encoding file, this tool does not perform any checking.\par
  14 \pard\keep\keepn\nowidctlpar\s2\fi-1300\li-1440\sb400\sa60\sl-340\slmult0\tx0\tx1440\cf1\b\fs28 Options\par
  15 \pard\nowidctlpar\sb200\cf2\fs18 -e\par
  16 \b0      Encode the input file, which means to compress the input file\par
  17 \b -d\par
  18 \b0       Decode the input file, which means to decompress the input file\par
  19 \b -o, --output Filename\b0\f1\par
  20 \f0       The file containing encoded or decoded content of input file\par
  21 \b --version\par
  22 \b0\f1\tab\f0 Print version and copyright of this program and exit\par
  23 \b -v, --verbose\par
  24 \pard\nowidctlpar\li360\sb200\b0 Turn on verbose output with informational messages printed. This is a count value, so specifying \endash v can be used to increase the verbosity level.\par
  25 \pard\nowidctlpar\sb200\b -q, --quiet\b0\f1\par
  26 \tab\f0 Disable all messages except FATAL ERRORS\par
  27 \b --debug [0-9]\par
  28 \b0\f1\tab\f0 Enable debug messages. nly 0-9 Level is supported.\par
  29 \b -h, --help\par
  30 \b0\f1\tab\f0 Print copyright, version and usage of this program and exit\par
  31 \pard\keep\keepn\nowidctlpar\s2\fi-1300\li-1440\sb400\sa60\sl-340\slmult0\tx0\tx1440\cf1\b\fs28 Example\par
  32 \pard\nowidctlpar\sb200\cf2\b0\fs18 1. Encode the input file \ldblquote file.efi\rdblquote  and specify the output file name with \ldblquote file.tiano\par
  33 \b TianoCompress \endash e \endash o file.tiano file.efi\par
  34 \b0 2. Decode the input file \ldblquote file.tiano\rdblquote  and specify the output file name with \ldblquote file.orig\rdblquote\par
  35 \b TianoCompress \endash d \endash o file.orig file.tiano\par
  36 \b0 3. Decode the input file "file.tiano" in the quiet mode and specify the output file name with "file.orig"\par
  37 \b TianoCompress \endash d -q \endash o file.orig file.tiano\par
  38 \pard\keep\keepn\nowidctlpar\s2\fi-1300\li-1440\sb400\sa60\sl-340\slmult0\tx0\tx1440\cf1\fs28 Bugs\par
  39 \pard\nowidctlpar\sb200\cf2\b0\fs18 No known bugs.\par
  40 Report bugs to edk2-buildtools-devel@lists.sourceforge.net\f1\par
  41 \pard\keep\keepn\nowidctlpar\s2\fi-1300\li-1440\sb400\sa60\sl-340\slmult0\tx0\tx1440\cf1\b\f0\fs28 Files\par
  42 \pard\nowidctlpar\sb200\cf2\b0\fs18 None\par
  43 \pard\keep\keepn\nowidctlpar\s2\fi-1300\li-1440\sb400\sa60\sl-340\slmult0\tx0\tx1440\cf1\b\fs28 See also\par
  44 \pard\nowidctlpar\sb200\cf2\b0\fs18 None\par
  45 \pard\keep\keepn\nowidctlpar\s2\fi-1300\li-1440\sb400\sa60\sl-340\slmult0\tx0\tx1440\cf1\b\fs28 License\par
  46 \pard\nowidctlpar\cf2\b0\fs18 Copyright (c) 1999 - 2009, Intel Corporation. All rights reserved.\par
  47 This program and the accompanying materials are licensed and made available \par
  48 under the terms and conditions of the BSD License which accompanies this \par
  49 distribution.  The full text of the license may be found at\par
  50 http://opensource.org/licenses/bsd-license.php\par
  51 \par
  52 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par
  53 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par
  54 }
  55