core/builtins/e32header.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # e32header.cif
       
     2 # 
       
     3 # Copyright (c) 2010 Accenture. All rights reserved.
       
     4 # This component and the accompanying materials are made available
       
     5 # under the terms of the "Eclipse Public License v1.0"
       
     6 # which accompanies this distribution, and is available
       
     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 # 
       
     9 # Initial Contributors:
       
    10 # Accenture - Initial contribution
       
    11 #
       
    12 
       
    13 ==name e32header
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Dumps the contents of an E32 image file's header in human readable plain text.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 Note, a different header is present in XIP ROM files compared to other file systems. By default the header type is determined according to the type of file system the image file resides in (using C<RFs::IsFileInRom>). It is possible to override this behaviour using the C<--xip> option.
       
    22 
       
    23 ==argument filename file_name
       
    24 
       
    25 The name of the image file.
       
    26 
       
    27 ==option bool x xip
       
    28 
       
    29 Assume the image file has a ROM header even if it does not reside in an XIP ROM.
       
    30 
       
    31 ==option bool n not-xip
       
    32 
       
    33 Assume the image file does not have a ROM header even if resides in an XIP ROM.
       
    34 
       
    35 ==copyright
       
    36 
       
    37 Copyright (c) 2006-2010 Accenture. All rights reserved.
       
    38