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 =frames-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},
  48 @samp{.gnu_debugaltlink} and @samp{.debug_sup} sections, if any of
  49 them are present.  Also displays any links to separate dwarf object
  50 files (dwo), if they are specified by the DW_AT_GNU_dwo_name or
  51 DW_AT_dwo_name attributes in the @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 Note - in some distributions this option is enabled by default.  It
  65 can be disabled via the @option{N} debug option.  The default can be
  66 chosen when configuring the binutils via the
  67 @option{--enable-follow-debug-links=yes} or
  68 @option{--enable-follow-debug-links=no} options.  If these are not
  69 used then the default is to enable the following of debug links.
  70
  71 Note - if support for the debuginfod protocol was enabled when the
  72 binutils were built then this option will also include an attempt to
  73 contact any debuginfod servers mentioned in the @var{DEBUGINFOD_URLS}
  74 environment variable.  This could take some time to resolve.  This
  75 behaviour can be disabled via the @option{=do-not-use-debuginfod} debug
  76 option.
  77
  78 @item N
  79 @itemx =no-follow-links
  80 Disables the following of links to separate debug info files.
  81
  82 @item D
  83 @itemx =use-debuginfod
  84 Enables contacting debuginfod servers if there is a need to follow
  85 debug links.  This is the default behaviour.
  86
  87 @item E
  88 @itemx =do-not-use-debuginfod
  89 Disables contacting debuginfod servers when there is a need to follow
  90 debug links.
  91
  92 @item l
  93 @itemx =rawline
  94 Displays the contents of the @samp{.debug_line} section in a raw
  95 format.
  96
  97 @item L
  98 @item =decodedline
  99 Displays the interpreted contents of the @samp{.debug_line} section.
 100
 101 @item m
 102 @itemx =macro
 103 Displays the contents of the @samp{.debug_macro} and/or
 104 @samp{.debug_macinfo} sections.
 105
 106 @item o
 107 @itemx =loc
 108 Displays the contents of the @samp{.debug_loc} and/or
 109 @samp{.debug_loclists} sections.
 110
 111 @item O
 112 @itemx =str-offsets
 113 Displays the contents of the @samp{.debug_str_offsets} section.
 114
 115 @item p
 116 @itemx =pubnames
 117 Displays the contents of the @samp{.debug_pubnames} and/or
 118 @samp{.debug_gnu_pubnames} sections.
 119
 120 @item r
 121 @itemx =aranges
 122 Displays the contents of the @samp{.debug_aranges} section.
 123
 124 @item R
 125 @itemx =Ranges
 126 Displays the contents of the @samp{.debug_ranges} and/or
 127 @samp{.debug_rnglists} sections.
 128
 129 @item s
 130 @itemx =str
 131 Displays the contents of the @samp{.debug_str}, @samp{.debug_line_str}
 132 and/or @samp{.debug_str_offsets} sections.
 133
 134 @item t
 135 @itemx =pubtype
 136 Displays the contents of the @samp{.debug_pubtypes} and/or
 137 @samp{.debug_gnu_pubtypes} sections.
 138
 139 @item T
 140 @itemx =trace_aranges
 141 Displays the contents of the @samp{.trace_aranges} section.
 142
 143 @item u
 144 @itemx =trace_abbrev
 145 Displays the contents of the @samp{.trace_abbrev} section.
 146
 147 @item U
 148 @itemx =trace_info
 149 Displays the contents of the @samp{.trace_info} section.
 150
 151 @end table
 152
 153 Note: displaying the contents of @samp{.debug_static_funcs},
 154 @samp{.debug_static_vars} and @samp{debug_weaknames} sections is not
 155 currently supported.
 156
 157 @item --dwarf-depth=@var{n}
 158 Limit the dump of the @code{.debug_info} section to @var{n} children.
 159 This is only useful with @option{--debug-dump=info}.  The default is
 160 to print all DIEs; the special value 0 for @var{n} will also have this
 161 effect.
 162
 163 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
 164 levels will not be printed.  The range for @var{n} is zero-based.
 165
 166 @item --dwarf-start=@var{n}
 167 Print only DIEs beginning with the DIE numbered @var{n}.  This is only
 168 useful with @option{--debug-dump=info}.
 169
 170 If specified, this option will suppress printing of any header
 171 information and all DIEs before the DIE numbered @var{n}.  Only
 172 siblings and children of the specified DIE will be printed.
 173
 174 This can be used in conjunction with @option{--dwarf-depth}.
 175