mirror of https://github.com/cc65/cc65.git
214 lines
6.2 KiB
Plaintext
214 lines
6.2 KiB
Plaintext
<!doctype linuxdoc system>
|
|
|
|
<article>
|
|
<title>od65 Users Guide
|
|
<author><url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">
|
|
|
|
<abstract>
|
|
od65 is the object file dump utility. It is able to output most parts of
|
|
<htmlurl url="ca65.html" name="ca65-generated"> object files in readable form.
|
|
</abstract>
|
|
|
|
<!-- Table of contents -->
|
|
<toc>
|
|
|
|
<!-- Begin the document -->
|
|
|
|
|
|
<sect>Overview<p>
|
|
|
|
od65 is an object file dump utility. It is able to output most parts of
|
|
<htmlurl url="ca65.html" name="ca65-generated"> object files in readable form.
|
|
Since the contents and format of the object files are not documented
|
|
elsewhere and may change at any time, this tool is a portable way to look at
|
|
the contents.
|
|
|
|
Apart from curiosity, most people don't need to use this tool.
|
|
|
|
|
|
|
|
<sect>Usage<p>
|
|
|
|
The od65 utility dumps contents of one or more ca65 generated object file to
|
|
standard output. It has no cross-version compatibility, so you have to use
|
|
a version that matches the version of ca65 used to create the object files.
|
|
|
|
|
|
<sect1>Command line option overview<p>
|
|
|
|
The program may be called as follows:
|
|
|
|
<tscreen><verb>
|
|
---------------------------------------------------------------------------
|
|
Usage: od65 [options] file [options] [file]
|
|
Short options:
|
|
-h Help (this text)
|
|
-H Dump the object file header
|
|
-S Dump segments sizes
|
|
-V Print the version number and exit
|
|
|
|
Long options:
|
|
--dump-all Dump all object file information
|
|
--dump-dbgsyms Dump debug symbols
|
|
--dump-exports Dump exported symbols
|
|
--dump-files Dump the source files
|
|
--dump-header Dump the object file header
|
|
--dump-imports Dump imported symbols
|
|
--dump-lineinfo Dump line information
|
|
--dump-options Dump object file options
|
|
--dump-segments Dump the segments in the file
|
|
--dump-segsize Dump segments sizes
|
|
--help Help (this text)
|
|
--version Print the version number and exit
|
|
---------------------------------------------------------------------------
|
|
</verb></tscreen>
|
|
|
|
|
|
<sect1>Command line options in detail<label id="cmdline-opt-detail"><p>
|
|
|
|
Here is a description of all the command line options:
|
|
|
|
<descrip>
|
|
|
|
<tag><tt>--dump-all</tt></tag>
|
|
|
|
This will output all information, od65 is able to process. The option is a
|
|
shortcut for specifying all the other <tt/--dump/ options.
|
|
|
|
|
|
<tag><tt>--dump-dbgsyms</tt></tag>
|
|
|
|
Dump all debug symbols contained in the object file.
|
|
|
|
|
|
<tag><tt>--dump-exports</tt></tag>
|
|
|
|
Dump all exported symbols contained in the object file.
|
|
|
|
|
|
<tag><tt>--dump-files</tt></tag>
|
|
|
|
Dump the file table contained in the object file.
|
|
|
|
|
|
<tag><tt>-H, --dump-header</tt></tag>
|
|
|
|
Dump the object file header.
|
|
|
|
|
|
<tag><tt>--dump-imports</tt></tag>
|
|
|
|
Dump the list of imported symbols contained in the object file.
|
|
|
|
|
|
<tag><tt>--dump-lineinfo</tt></tag>
|
|
|
|
Dump the line info contained in the object file.
|
|
|
|
|
|
<tag><tt>--dump-segments</tt></tag>
|
|
|
|
Dump the list of segments contained in the object file.
|
|
|
|
|
|
<tag><tt>--dump-scopes</tt></tag>
|
|
|
|
Dump the scope (lexical level) information contained in the object file.
|
|
|
|
|
|
<tag><tt>-S, --dump-segsize</tt></tag>
|
|
|
|
Dump the sizes of all segments contained in the object file. This option is
|
|
quite useful to determine the effect of measures that increase or decrease
|
|
code size.
|
|
|
|
|
|
<tag><tt>-h, --help</tt></tag>
|
|
|
|
Print the short option summary shown above.
|
|
|
|
|
|
<tag><tt>-V, --version</tt></tag>
|
|
|
|
Print the version number of the compiler. When submitting a bug report,
|
|
please include the operating system you're using, and the compiler
|
|
version.
|
|
</descrip>
|
|
|
|
|
|
<sect>Input and output<p>
|
|
|
|
The converter will read one or more object files per invocation and write the
|
|
contents in readable format to standard output. Please note that you need to
|
|
specify any of the <tt/--dump/ options listed <ref id="cmdline-opt-detail"
|
|
name="above">, otherwise no useful output will be generated.
|
|
|
|
Example output for the command
|
|
<tscreen><verb>
|
|
od65 --dump-header --dump-files t.o
|
|
</verb></tscreen>
|
|
<tscreen><verb>
|
|
t.o:
|
|
Header:
|
|
Magic: 0x616E7A55
|
|
Version: 12
|
|
Flags: 0x0001 (OBJ_FLAGS_DBGINFO)
|
|
Options:
|
|
Offset: 88
|
|
Size: 9
|
|
Files:
|
|
Offset: 97
|
|
Size: 10
|
|
Segments:
|
|
Offset: 107
|
|
Size: 101
|
|
Imports:
|
|
Offset: 208
|
|
Size: 1
|
|
Exports:
|
|
Offset: 209
|
|
Size: 1
|
|
Debug symbols:
|
|
Offset: 210
|
|
Size: 55
|
|
Line infos:
|
|
Offset: 265
|
|
Size: 1
|
|
String pool:
|
|
Offset: 266
|
|
Size: 80
|
|
Files:
|
|
Count: 1
|
|
Index: 0
|
|
Name: "t.s"
|
|
Size: 402
|
|
Modification time: 1280498435 (Fri Jul 30 16:00:35 2010)
|
|
</verb></tscreen>
|
|
|
|
|
|
<sect>Copyright<p>
|
|
|
|
od65 is (C) Copyright 2000-2009, Ullrich von Bassewitz. For usage of the
|
|
binaries and/or sources the following conditions apply:
|
|
|
|
This software is provided 'as-is', without any expressed or implied
|
|
warranty. In no event will the authors be held liable for any damages
|
|
arising from the use of this software.
|
|
|
|
Permission is granted to anyone to use this software for any purpose,
|
|
including commercial applications, and to alter it and redistribute it
|
|
freely, subject to the following restrictions:
|
|
|
|
<enum>
|
|
<item> The origin of this software must not be misrepresented; you must not
|
|
claim that you wrote the original software. If you use this software
|
|
in a product, an acknowledgment in the product documentation would be
|
|
appreciated but is not required.
|
|
<item> Altered source versions must be plainly marked as such, and must not
|
|
be misrepresented as being the original software.
|
|
<item> This notice may not be removed or altered from any source
|
|
distribution.
|
|
</enum>
|
|
|
|
</article>
|