[CallSite removal] Migrate all Alias Analysis APIs to use the newly
[llvm-complete.git] / docs / CommandGuide / llvm-objdump.rst
blob0d0291520475d4b17b21459ece7df3d3cefa20bf
1 llvm-objdump - LLVM's object file dumper
2 ========================================
4 SYNOPSIS
5 --------
7 :program:`llvm-objdump` [*commands*] [*options*] [*filenames...*]
9 DESCRIPTION
10 -----------
11 The :program:`llvm-objdump` utility prints the contents of object files and
12 final linked images named on the command line. If no file name is specified,
13 :program:`llvm-objdump` will attempt to read from *a.out*. If *-* is used as a
14 file name, :program:`llvm-objdump` will process a file on its standard input
15 stream.
17 COMMANDS
18 --------
19 At least one of the following commands are required, and some commands can be combined with other commands:
21 .. option:: -disassemble
23   Display assembler mnemonics for the machine instructions
25 .. option:: -help
27   Display usage information and exit. Does not stack with other commands.
29 .. option:: -r
31   Display the relocation entries in the file.
33 .. option:: -s
35   Display the content of each section.
37 .. option:: -section-headers
39   Display summaries of the headers for each section.
41 .. option:: -t
43   Display the symbol table.
45 .. option:: -version
47   Display the version of this program. Does not stack with other commands.
48   
49 OPTIONS
50 -------
51 :program:`llvm-objdump` supports the following options:
53 .. option:: -arch=<architecture>
55   Specify the architecture to disassemble. see -version for available
56   architectures.
58 .. option:: -cfg
60   Create a CFG for every symbol in the object file and write it to a graphviz
61   file (Mach-O-only).
63 .. option:: -dsym=<string>
65   Use .dSYM file for debug info.
67 .. option:: -g
69   Print line information from debug info if available.
71 .. option:: -macho
73   Use Mach-O specific object file parser.
75 .. option:: -mattr=<a1,+a2,-a3,...>
77   Target specific attributes.
78   
79 .. option:: -mc-x86-disable-arith-relaxation
81   Disable relaxation of arithmetic instruction for X86.
83 .. option:: -stats
85   Enable statistics output from program.
86   
87 .. option:: -triple=<string>
89   Target triple to disassemble for, see -version for available targets.
90   
91 .. option:: -x86-asm-syntax=<style>
93   When used with the ``-disassemble`` option, choose style of code to emit from
94   X86 backend. Supported values are:
96    .. option:: att
97    
98     AT&T-style assembly
99    
100    .. option:: intel
101    
102     Intel-style assembly
104    
105   The default disassembly style is **att**. 
107 BUGS
108 ----
110 To report bugs, please visit <http://llvm.org/bugs/>.
112 SEE ALSO
113 --------
115 :manpage:`llvm-nm(1)`