[llvm-exegesis] [NFC] Fixing typo.
[llvm-complete.git] / docs / CommandGuide / llvm-objdump.rst
blobc3e7c166005b637cfe10bde4e91ece3558ef2f5c
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
20 combined with other commands:
22 .. option:: -d, -disassemble
24   Display assembler mnemonics for the machine instructions. Disassembles all
25   text sections found in the input file(s).
27 .. option:: -D, -disassemble-all
29   Display assembler mnemonics for the machine instructions. Disassembles all
30   sections found in the input file(s).
32 .. option:: -help
34   Display usage information and exit. Does not stack with other commands.
36 .. option:: -r
38   Display the relocation entries in the file.
40 .. option:: -s
42   Display the content of each section.
44 .. option:: -section-headers
46   Display summaries of the headers for each section.
48 .. option:: -t
50   Display the symbol table.
52 .. option:: -version
54   Display the version of this program. Does not stack with other commands.
56 OPTIONS
57 -------
58 :program:`llvm-objdump` supports the following options:
60 .. option:: -arch=<architecture>
62   Specify the architecture to disassemble. see ``-version`` for available
63   architectures.
65 .. option:: -cfg
67   Create a CFG for every symbol in the object file and write it to a graphviz
68   file (Mach-O-only).
70 .. option:: -dsym=<string>
72   Use .dSYM file for debug info.
74 .. option:: -g
76   Print line information from debug info if available.
78 .. option:: -m, -macho
80   Use Mach-O specific object file parser. Commands and other options may behave
81   differently when used with ``-macho``.
83 .. option:: -mattr=<a1,+a2,-a3,...>
85   Target specific attributes.
87 .. option:: -mc-x86-disable-arith-relaxation
89   Disable relaxation of arithmetic instruction for X86.
91 .. option:: -stats
93   Enable statistics output from program.
95 .. option:: -triple=<string>
97   Target triple to disassemble for, see ``-version`` for available targets.
99 .. option:: -x86-asm-syntax=<style>
101   When used with the ``-disassemble`` option, choose style of code to emit from
102   X86 backend. Supported values are:
104    .. option:: att
106     AT&T-style assembly
108    .. option:: intel
110     Intel-style assembly
113   The default disassembly style is **att**.
115 BUGS
116 ----
118 To report bugs, please visit <http://llvm.org/bugs/>.
120 SEE ALSO
121 --------
123 :manpage:`llvm-nm(1)`