Add support to readelf and objdump for following links to separate debug information...
[external/binutils.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.
49
50 @item K
51 @itemx =follow-links
52 Display the contents of any selected debug sections that are found in
53 a linked, separate debug info file.  This can result in multiple
54 versions of the same debug section being displayed if both the main
55 file and the separate debug info file contain sections with the same
56 name.
57
58 When displaying other debug information, if a link is encountered to
59 a separate debug info file, then attempt to follow the link and
60 display the referenced contents.
61
62 @item l
63 @itemx =rawline
64 Displays the contents of the @samp{.debug_line} section in a raw
65 format.
66
67 @item L
68 @item =decodedline
69 Displays the interpreted contents of the @samp{.debug_line} section.
70
71 @item m
72 @itemx =macro
73 Displays the contents of the @samp{.debug_macro} and/or
74 @samp{.debug_macinfo} sections.
75
76 @item o
77 @itemx =loc
78 Displays the contents of the @samp{.debug_loc} and/or
79 @samp{.debug_loclists} sections.
80
81 @item p
82 @itemx =pubnames
83 Displays the contents of the @samp{.debug_pubnames} and/or
84 @samp{.debug_gnu_pubnames} sections.
85
86 @item r
87 @itemx =aranges
88 Displays the contents of the @samp{.debug_aranges} section.
89
90 @item R
91 @itemx =Ranges
92 Displays the contents of the @samp{.debug_ranges} and/or
93 @samp{.debug_rnglists} sections.
94
95 @item s
96 @itemx =str
97 Displays the contents of the @samp{.debug_str}, @samp{.debug_line_str}
98 and/or @samp{.debug_str_offsets} sections.
99
100 @item t
101 @itemx =pubtype
102 Displays the contents of the @samp{.debug_pubtypes} and/or
103 @samp{.debug_gnu_pubtypes} sections.
104
105 @item T
106 @itemx =trace_aranges
107 Displays the contents of the @samp{.trace_aranges} section.
108
109 @item u
110 @itemx =trace_abbrev
111 Displays the contents of the @samp{.trace_abbrev} section.
112
113 @item U
114 @itemx =trace_info
115 Displays the contents of the @samp{.trace_info} section.
116
117 @end table
118
119 Note: displaying the contents of @samp{.debug_static_funcs},
120 @samp{.debug_static_vars} and @samp{debug_weaknames} sections is not
121 currently supported.
122
123 @item --dwarf-depth=@var{n}
124 Limit the dump of the @code{.debug_info} section to @var{n} children.
125 This is only useful with @option{--debug-dump=info}.  The default is
126 to print all DIEs; the special value 0 for @var{n} will also have this
127 effect.
128
129 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
130 levels will not be printed.  The range for @var{n} is zero-based.
131
132 @item --dwarf-start=@var{n}
133 Print only DIEs beginning with the DIE numbered @var{n}.  This is only
134 useful with @option{--debug-dump=info}.
135
136 If specified, this option will suppress printing of any header
137 information and all DIEs before the DIE numbered @var{n}.  Only
138 siblings and children of the specified DIE will be printed.
139
140 This can be used in conjunction with @option{--dwarf-depth}.
141