[llvm] [cmake] Add possibility to use ChooseMSVCCRT.cmake when include LLVM library
[llvm-core.git] / docs / CommandGuide / llvm-readelf.rst
blobefb3f6a9c30182e6f056f3569006ae9bd5c6cb34
1 llvm-readelf - GNU-style LLVM Object Reader
2 ===========================================
4 .. program:: llvm-readelf
6 SYNOPSIS
7 --------
9 :program:`llvm-readelf` [*options*] [*input...*]
11 DESCRIPTION
12 -----------
14 The :program:`llvm-readelf` tool displays low-level format-specific information
15 about one or more object files.
17 If ``input`` is "``-``" or omitted, :program:`llvm-readelf` reads from standard
18 input. Otherwise, it will read from the specified ``filenames``.
20 OPTIONS
21 -------
23 .. option:: --all
25  Equivalent to specifying all the main display options.
27 .. option:: --addrsig
29  Display the address-significance table.
31 .. option:: --arm-attributes
33  Display the ARM attributes section. Only applicable for ARM architectures.
35 .. option:: --color
37  Use colors in the output for warnings and errors.
39 .. option:: --demangle, -C
41  Display demangled symbol names in the output.
43 .. option:: --dyn-relocations
45  Display the dynamic relocation entries.
47 .. option:: --dyn-symbols, --dyn-syms
49  Display the dynamic symbol table.
51 .. option:: --dynamic-table, --dynamic, -d
53  Display the dynamic table.
55 .. option:: --elf-cg-profile
57  Display the callgraph profile section.
59 .. option:: --elf-hash-histogram, --histogram, -I
61  Display a bucket list histogram for dynamic symbol hash tables.
63 .. option:: --elf-linker-options
65  Display the linker options section.
67 .. option:: --elf-output-style=<value>
69  Format ELF information in the specified style. Valid options are ``LLVM`` and
70  ``GNU``. ``LLVM`` output is an expanded and structured format, whilst ``GNU``
71  (the default) output mimics the equivalent GNU :program:`readelf` output.
73 .. option:: --elf-section-groups, --section-groups, -g
75  Display section groups.
77 .. option:: --expand-relocs
79  When used with :option:`--relocations`, display each relocation in an expanded
80  multi-line format.
82 .. option:: --file-headers, -h
84  Display file headers.
86 .. option:: --gnu-hash-table
88  Display the GNU hash table for dynamic symbols.
90 .. option:: --hash-symbols
92  Display the expanded hash table with dynamic symbol data.
94 .. option:: --hash-table
96  Display the hash table for dynamic symbols.
98 .. option:: --headers, -e
100  Equivalent to setting: :option:`--file-headers`, :option:`--program-headers`,
101  and :option:`--sections`.
103 .. option:: --help
105  Display a summary of command line options.
107 .. option:: --help-list
109  Display an uncategorized summary of command line options.
111 .. option:: --hex-dump=<section[,section,...]>, -x
113  Display the specified section(s) as hexadecimal bytes. ``section`` may be a
114  section index or section name.
116 .. option:: --needed-libs
118  Display the needed libraries.
120 .. option:: --notes, -n
122  Display all notes.
124 .. option:: --program-headers, --segments, -l
126  Display the program headers.
128 .. option:: --raw-relr
130  Do not decode relocations in RELR relocation sections when displaying them.
132 .. option:: --relocations, --relocs, -r
134  Display the relocation entries in the file.
136 .. option:: --sections, --section-headers, -S
138  Display all sections.
140 .. option:: --section-data
142  When used with :option:`--sections`, display section data for each section
143  shown. This option has no effect for GNU style output.
145 .. option:: --section-mapping
147  Display the section to segment mapping.
149 .. option:: --section-relocations
151  When used with :option:`--sections`, display relocations for each section
152  shown. This option has no effect for GNU style output.
154 .. option:: --section-symbols
156  When used with :option:`--sections`, display symbols for each section shown.
157  This option has no effect for GNU style output.
159 .. option:: --stackmap
161  Display contents of the stackmap section.
163 .. option:: --stack-sizes
165  Display the contents of the stack sizes section(s), i.e. pairs of function
166  names and the size of their stack frames. Currently only implemented for GNU
167  style output.
169 .. option:: --string-dump=<section[,section,...]>, -p
171  Display the specified section(s) as a list of strings. ``section`` may be a
172  section index or section name.
174 .. option:: --symbols, --syms, -s
176  Display the symbol table.
178 .. option:: --unwind, -u
180  Display unwind information.
182 .. option:: --version
184  Display the version of the :program:`llvm-readelf` executable.
186 .. option:: --version-info, -V
188  Display version sections.
190 .. option:: @<FILE>
192  Read command-line options from response file `<FILE>`.
194 EXIT STATUS
195 -----------
197 :program:`llvm-readelf` returns 0 under normal operation. It returns a non-zero
198 exit code if there were any errors.
200 SEE ALSO
201 --------
203 :manpage:`llvm-nm(1)`, :manpage:`llvm-objdump(1)`, :manpage:`llvm-readobj(1)`