Sync EDKII BaseTools to BaseTools project r1971

[mirror_edk2.git] / BaseTools / UserManuals / SplitFile_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  Split.exe\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Description\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 Any file that could be accessed by Split tool, the input file will not be changed by split. Two Binary files will be created in either the same directory as the current working directory, or, if the either of the output files contain a path, then in the URI is used, based off of output directory, if specified by \ldblquote -p\rdblquote , \ldblquote --prefix\rdblquote  option.\par\r
If the either or both of the \endash o or \endash t options is not specified, then the non-specified split filenames will use the filename of the input file, with another suffix, of filename.ext.1 and/or filename.ext.2. \par\r
When reading the input filename, if the end of file is reached before the number of bytes has been reached, i.e., the Offset is larger than the number of bytes in the input file, then the first file will be an exact copy of the input file, while the second file will be created, but it will have zero length.\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\fs28 Options\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 -f, --filename Filename\tab\tab\tab\par\r
\pard\nowidctlpar\fi426\sb200 Input file specified by Filename\par\r
\pard\nowidctlpar\sb200 -s, --split VALUE\tab\tab\tab\tab\par\r
\pard\nowidctlpar\fi425\sb200 The number of bytes in the first file.  \par\r
The Split Occurs at the AFTER VALUE BYTES from the start of the file.\par\r
Value can be integer, hex adderss, or integer-letter, such as 1K, where:\par\r
K=1024Bytes, M=1024K, G=1024M\par\r
\pard\nowidctlpar\sb200 [-p, --prefix OutputDir]\tab\tab\tab\tab\tab\par\r
\pard\nowidctlpar\fi360\sb200 Output directory\par\r
\pard\nowidctlpar\sb200 [-o, --firstfile Filename1]\par\r
\tab First of the Split Files.\par\r
[-t, --secondfile Filename2]\par\r
\tab Second of the Split Files.\par\r
[--version]\par\r
\tab Print version and copyright of this program and exit\par\r
[-v, --verbose]\par\r
\pard\nowidctlpar\li360\sb200 Turn on verbose output with informational messages printed. This is a count value, so specifying \endash vv can be used to increase the verbosity level.\par\r
\pard\nowidctlpar\sb200 [-q, --quiet]\par\r
\tab disable all messages except FATAL ERRORS\par\r
[-d, --debug [#]]\par\r
\tab Enable debug messages, at level #\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\li60\sb200\cf2\b0\fs18 1. c:\\Tools\\Split.exe -f tool_setup.bat\par\r
tool_setup.bat file will be splitted into two files tool_setup.bat1 and tool_setup.bat2. As no \ldblquote -s\rdblquote  specified, tool_setup.bat1 will have size of the input file while tool_setup.bat2 will have size zero.\par\r
2. c:\\Tools\\Split.exe -f tool_setup.bat  -o tool_setup1 -t tool_setup2\par\r
tool_setup.bat file will be splitted into two files tool_setup1 and tool_setup2. As no \ldblquote -s\rdblquote  specified, tool_setup1 will have size of the input file while tool_setup2 will have size zero.\par\r
3. c:\\Tools\\Split.exe -f tool_setup.bat  -s 5k -o tool_setup1 -t tool_setup2\par\r
tool_setup.bat file will be splitted into two files tool_setup1 and tool_setup2. Now \ldblquote -s 5k\rdblquote  specified and tool_setup.bat is not as large as 5k,  so tool_setup1 will have size of the input file while tool_setup2 will have size zero.\par\r
4. c:\\Tools\\Split.exe -f tool_setup.bat -s 4k -p c:\\ -o Test/tool_setup1 -t Test1/tool_setup2\par\r
\pard\nowidctlpar\sb200 tool_setup.bat file will be splitted into two files tool_setup1 and tool_setup2. Now \ldblquote -s 4k\rdblquote  specified and tool_setup.bat is 4.9k,  so tool_setup1 will have size of 4k and tool_setup2 will have size 0.5k. The output files are both preceded with a directory and \ldblquote -p c:\\\rdblquote  is specified, so the \ldblquote Test\rdblquote  and \ldblquote Test1\rdblquote  directories will be created under c:\\ to contain tool_setup1 and tool_setup2 seperately.\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  None.\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) 1999 - 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,WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par\r
\pard\nowidctlpar\li60\sb200\f1\par\r
}\r
\0