Add support for decoding the DW_MACRO_define_strx and DW_MACRO_undef_strx operands...
[binutils-gdb.git] / binutils / doc / debug.options.texi
1 @c This file contains the entry for the -w/--debug-dump (readelf) and
2 @c -W/--dwarf (objdump) option that is common to both readelf and objdump.
3
4 Displays the contents of the DWARF debug sections in the file, if any
5 are present. Compressed debug sections are automatically decompressed
6 (temporarily) before they are displayed. If one or more of the
7 optional letters or words follows the switch then only those type(s)
8 of data will be dumped. The letters and words refer to the following
9 information:
10
11 @c Please Keep This Table Alpha Sorted.
12 @table @code
13 @item a
14 @itemx =abbrev
15 Displays the contents of the @samp{.debug_abbrev} section.
16
17 @item A
18 @itemx =addr
19 Displays the contents of the @samp{.debug_addr} section.
20
21 @item c
22 @itemx =cu_index
23 Displays the contents of the @samp{.debug_cu_index} and/or
24 @samp{.debug_tu_index} sections.
25
26 @item f
27 @itemx =frames
28 Display the raw contents of a @samp{.debug_frame} section.
29
30 @item F
31 @item =frame-interp
32 Display the interpreted contents of a @samp{.debug_frame} section.
33
34 @item g
35 @itemx =gdb_index
36 Displays the contents of the @samp{.gdb_index} and/or
37 @samp{.debug_names} sections.
38
39 @item i
40 @itemx =info
41 Displays the contents of the @samp{.debug_info} section. Note: the
42 output from this option can also be restricted by the use of the
43 @option{--dwarf-depth} and @option{--dwarf-start} options.
44
45 @item k
46 @itemx =links
47 Displays the contents of the @samp{.gnu_debuglink} and/or
48 @samp{.gnu_debugaltlink} sections. Also displays any links to
49 separate dwarf object files (dwo), if they are specified by the
50 DW_AT_GNU_dwo_name or DW_AT_dwo_name attributes in the
51 @samp{.debug_info} section.
52
53 @item K
54 @itemx =follow-links
55 Display the contents of any selected debug sections that are found in
56 linked, separate debug info file(s). This can result in multiple
57 versions of the same debug section being displayed if it exists in
58 more than one file.
59
60 In addition, when displaying DWARF attributes, if a form is found that
61 references the separate debug info file, then the referenced contents
62 will also be displayed.
63
64 @item l
65 @itemx =rawline
66 Displays the contents of the @samp{.debug_line} section in a raw
67 format.
68
69 @item L
70 @item =decodedline
71 Displays the interpreted contents of the @samp{.debug_line} section.
72
73 @item m
74 @itemx =macro
75 Displays the contents of the @samp{.debug_macro} and/or
76 @samp{.debug_macinfo} sections.
77
78 @item o
79 @itemx =loc
80 Displays the contents of the @samp{.debug_loc} and/or
81 @samp{.debug_loclists} sections.
82
83 @item O
84 @itemx =str-offsets
85 Displays the contents of the @samp{.debug_str_offsets} section.
86
87 @item p
88 @itemx =pubnames
89 Displays the contents of the @samp{.debug_pubnames} and/or
90 @samp{.debug_gnu_pubnames} sections.
91
92 @item r
93 @itemx =aranges
94 Displays the contents of the @samp{.debug_aranges} section.
95
96 @item R
97 @itemx =Ranges
98 Displays the contents of the @samp{.debug_ranges} and/or
99 @samp{.debug_rnglists} sections.
100
101 @item s
102 @itemx =str
103 Displays the contents of the @samp{.debug_str}, @samp{.debug_line_str}
104 and/or @samp{.debug_str_offsets} sections.
105
106 @item t
107 @itemx =pubtype
108 Displays the contents of the @samp{.debug_pubtypes} and/or
109 @samp{.debug_gnu_pubtypes} sections.
110
111 @item T
112 @itemx =trace_aranges
113 Displays the contents of the @samp{.trace_aranges} section.
114
115 @item u
116 @itemx =trace_abbrev
117 Displays the contents of the @samp{.trace_abbrev} section.
118
119 @item U
120 @itemx =trace_info
121 Displays the contents of the @samp{.trace_info} section.
122
123 @end table
124
125 Note: displaying the contents of @samp{.debug_static_funcs},
126 @samp{.debug_static_vars} and @samp{debug_weaknames} sections is not
127 currently supported.
128
129 @item --dwarf-depth=@var{n}
130 Limit the dump of the @code{.debug_info} section to @var{n} children.
131 This is only useful with @option{--debug-dump=info}. The default is
132 to print all DIEs; the special value 0 for @var{n} will also have this
133 effect.
134
135 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
136 levels will not be printed. The range for @var{n} is zero-based.
137
138 @item --dwarf-start=@var{n}
139 Print only DIEs beginning with the DIE numbered @var{n}. This is only
140 useful with @option{--debug-dump=info}.
141
142 If specified, this option will suppress printing of any header
143 information and all DIEs before the DIE numbered @var{n}. Only
144 siblings and children of the specified DIE will be printed.
145
146 This can be used in conjunction with @option{--dwarf-depth}.
147