| 1 | \input texinfo @c -*- Texinfo -*- |
| 2 | @setfilename binutils.info |
| 3 | @settitle @sc{gnu} Binary Utilities |
| 4 | @finalout |
| 5 | @synindex ky cp |
| 6 | |
| 7 | @c man begin INCLUDE |
| 8 | @include bfdver.texi |
| 9 | @c man end |
| 10 | |
| 11 | @copying |
| 12 | @c man begin COPYRIGHT |
| 13 | Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
| 14 | 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
| 15 | Free Software Foundation, Inc. |
| 16 | |
| 17 | Permission is granted to copy, distribute and/or modify this document |
| 18 | under the terms of the GNU Free Documentation License, Version 1.3 |
| 19 | or any later version published by the Free Software Foundation; |
| 20 | with no Invariant Sections, with no Front-Cover Texts, and with no |
| 21 | Back-Cover Texts. A copy of the license is included in the |
| 22 | section entitled ``GNU Free Documentation License''. |
| 23 | |
| 24 | @c man end |
| 25 | @end copying |
| 26 | |
| 27 | @dircategory Software development |
| 28 | @direntry |
| 29 | * Binutils: (binutils). The GNU binary utilities. |
| 30 | @end direntry |
| 31 | |
| 32 | @dircategory Individual utilities |
| 33 | @direntry |
| 34 | * addr2line: (binutils)addr2line. Convert addresses to file and line. |
| 35 | * ar: (binutils)ar. Create, modify, and extract from archives. |
| 36 | * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols. |
| 37 | * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt. |
| 38 | * dlltool: (binutils)dlltool. Create files needed to build and use DLLs. |
| 39 | * nlmconv: (binutils)nlmconv. Converts object code into an NLM. |
| 40 | * nm: (binutils)nm. List symbols from object files. |
| 41 | * objcopy: (binutils)objcopy. Copy and translate object files. |
| 42 | * objdump: (binutils)objdump. Display information from object files. |
| 43 | * ranlib: (binutils)ranlib. Generate index to archive contents. |
| 44 | * readelf: (binutils)readelf. Display the contents of ELF format files. |
| 45 | * size: (binutils)size. List section sizes and total size. |
| 46 | * strings: (binutils)strings. List printable strings from files. |
| 47 | * strip: (binutils)strip. Discard symbols. |
| 48 | * elfedit: (binutils)elfedit. Update the ELF header of ELF files. |
| 49 | * windmc: (binutils)windmc. Generator for Windows message resources. |
| 50 | * windres: (binutils)windres. Manipulate Windows resources. |
| 51 | @end direntry |
| 52 | |
| 53 | @titlepage |
| 54 | @title The @sc{gnu} Binary Utilities |
| 55 | @ifset VERSION_PACKAGE |
| 56 | @subtitle @value{VERSION_PACKAGE} |
| 57 | @end ifset |
| 58 | @subtitle Version @value{VERSION} |
| 59 | @sp 1 |
| 60 | @subtitle @value{UPDATED} |
| 61 | @author Roland H. Pesch |
| 62 | @author Jeffrey M. Osier |
| 63 | @author Cygnus Support |
| 64 | @page |
| 65 | |
| 66 | @tex |
| 67 | {\parskip=0pt \hfill Cygnus Support\par \hfill |
| 68 | Texinfo \texinfoversion\par } |
| 69 | @end tex |
| 70 | |
| 71 | @vskip 0pt plus 1filll |
| 72 | @insertcopying |
| 73 | @end titlepage |
| 74 | @contents |
| 75 | |
| 76 | @node Top |
| 77 | @top Introduction |
| 78 | |
| 79 | @cindex version |
| 80 | This brief manual contains documentation for the @sc{gnu} binary |
| 81 | utilities |
| 82 | @ifset VERSION_PACKAGE |
| 83 | @value{VERSION_PACKAGE} |
| 84 | @end ifset |
| 85 | version @value{VERSION}: |
| 86 | |
| 87 | @iftex |
| 88 | @table @code |
| 89 | @item ar |
| 90 | Create, modify, and extract from archives |
| 91 | |
| 92 | @item nm |
| 93 | List symbols from object files |
| 94 | |
| 95 | @item objcopy |
| 96 | Copy and translate object files |
| 97 | |
| 98 | @item objdump |
| 99 | Display information from object files |
| 100 | |
| 101 | @item ranlib |
| 102 | Generate index to archive contents |
| 103 | |
| 104 | @item readelf |
| 105 | Display the contents of ELF format files. |
| 106 | |
| 107 | @item size |
| 108 | List file section sizes and total size |
| 109 | |
| 110 | @item strings |
| 111 | List printable strings from files |
| 112 | |
| 113 | @item strip |
| 114 | Discard symbols |
| 115 | |
| 116 | @item elfedit |
| 117 | Update the ELF header of ELF files. |
| 118 | |
| 119 | @item c++filt |
| 120 | Demangle encoded C++ symbols (on MS-DOS, this program is named |
| 121 | @code{cxxfilt}) |
| 122 | |
| 123 | @item addr2line |
| 124 | Convert addresses into file names and line numbers |
| 125 | |
| 126 | @item nlmconv |
| 127 | Convert object code into a Netware Loadable Module |
| 128 | |
| 129 | @item windres |
| 130 | Manipulate Windows resources |
| 131 | |
| 132 | @item windmc |
| 133 | Genertor for Windows message resources |
| 134 | |
| 135 | @item dlltool |
| 136 | Create the files needed to build and use Dynamic Link Libraries |
| 137 | @end table |
| 138 | @end iftex |
| 139 | |
| 140 | This document is distributed under the terms of the GNU Free |
| 141 | Documentation License version 1.3. A copy of the license is included |
| 142 | in the section entitled ``GNU Free Documentation License''. |
| 143 | |
| 144 | @menu |
| 145 | * ar:: Create, modify, and extract from archives |
| 146 | * nm:: List symbols from object files |
| 147 | * objcopy:: Copy and translate object files |
| 148 | * objdump:: Display information from object files |
| 149 | * ranlib:: Generate index to archive contents |
| 150 | * readelf:: Display the contents of ELF format files |
| 151 | * size:: List section sizes and total size |
| 152 | * strings:: List printable strings from files |
| 153 | * strip:: Discard symbols |
| 154 | * elfedit:: Update the ELF header of ELF files |
| 155 | * c++filt:: Filter to demangle encoded C++ symbols |
| 156 | * cxxfilt: c++filt. MS-DOS name for c++filt |
| 157 | * addr2line:: Convert addresses to file and line |
| 158 | * nlmconv:: Converts object code into an NLM |
| 159 | * windres:: Manipulate Windows resources |
| 160 | * windmc:: Generator for Windows message resources |
| 161 | * dlltool:: Create files needed to build and use DLLs |
| 162 | * Common Options:: Command-line options for all utilities |
| 163 | * Selecting the Target System:: How these utilities determine the target |
| 164 | * Reporting Bugs:: Reporting Bugs |
| 165 | * GNU Free Documentation License:: GNU Free Documentation License |
| 166 | * Binutils Index:: Binutils Index |
| 167 | @end menu |
| 168 | |
| 169 | @node ar |
| 170 | @chapter ar |
| 171 | |
| 172 | @kindex ar |
| 173 | @cindex archives |
| 174 | @cindex collections of files |
| 175 | |
| 176 | @c man title ar create, modify, and extract from archives |
| 177 | |
| 178 | @smallexample |
| 179 | ar [@option{--plugin} @var{name}] [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}] |
| 180 | ar -M [ <mri-script ] |
| 181 | @end smallexample |
| 182 | |
| 183 | @c man begin DESCRIPTION ar |
| 184 | |
| 185 | The @sc{gnu} @command{ar} program creates, modifies, and extracts from |
| 186 | archives. An @dfn{archive} is a single file holding a collection of |
| 187 | other files in a structure that makes it possible to retrieve |
| 188 | the original individual files (called @dfn{members} of the archive). |
| 189 | |
| 190 | The original files' contents, mode (permissions), timestamp, owner, and |
| 191 | group are preserved in the archive, and can be restored on |
| 192 | extraction. |
| 193 | |
| 194 | @cindex name length |
| 195 | @sc{gnu} @command{ar} can maintain archives whose members have names of any |
| 196 | length; however, depending on how @command{ar} is configured on your |
| 197 | system, a limit on member-name length may be imposed for compatibility |
| 198 | with archive formats maintained with other tools. If it exists, the |
| 199 | limit is often 15 characters (typical of formats related to a.out) or 16 |
| 200 | characters (typical of formats related to coff). |
| 201 | |
| 202 | @cindex libraries |
| 203 | @command{ar} is considered a binary utility because archives of this sort |
| 204 | are most often used as @dfn{libraries} holding commonly needed |
| 205 | subroutines. |
| 206 | |
| 207 | @cindex symbol index |
| 208 | @command{ar} creates an index to the symbols defined in relocatable |
| 209 | object modules in the archive when you specify the modifier @samp{s}. |
| 210 | Once created, this index is updated in the archive whenever @command{ar} |
| 211 | makes a change to its contents (save for the @samp{q} update operation). |
| 212 | An archive with such an index speeds up linking to the library, and |
| 213 | allows routines in the library to call each other without regard to |
| 214 | their placement in the archive. |
| 215 | |
| 216 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index |
| 217 | table. If an archive lacks the table, another form of @command{ar} called |
| 218 | @command{ranlib} can be used to add just the table. |
| 219 | |
| 220 | @cindex thin archives |
| 221 | @sc{gnu} @command{ar} can optionally create a @emph{thin} archive, |
| 222 | which contains a symbol index and references to the original copies |
| 223 | of the member files of the archives. Such an archive is useful |
| 224 | for building libraries for use within a local build, where the |
| 225 | relocatable objects are expected to remain available, and copying the |
| 226 | contents of each object would only waste time and space. Thin archives |
| 227 | are also @emph{flattened}, so that adding one or more archives to a |
| 228 | thin archive will add the elements of the nested archive individually. |
| 229 | The paths to the elements of the archive are stored relative to the |
| 230 | archive itself. |
| 231 | |
| 232 | @cindex compatibility, @command{ar} |
| 233 | @cindex @command{ar} compatibility |
| 234 | @sc{gnu} @command{ar} is designed to be compatible with two different |
| 235 | facilities. You can control its activity using command-line options, |
| 236 | like the different varieties of @command{ar} on Unix systems; or, if you |
| 237 | specify the single command-line option @option{-M}, you can control it |
| 238 | with a script supplied via standard input, like the MRI ``librarian'' |
| 239 | program. |
| 240 | |
| 241 | @c man end |
| 242 | |
| 243 | @menu |
| 244 | * ar cmdline:: Controlling @command{ar} on the command line |
| 245 | * ar scripts:: Controlling @command{ar} with a script |
| 246 | @end menu |
| 247 | |
| 248 | @page |
| 249 | @node ar cmdline |
| 250 | @section Controlling @command{ar} on the Command Line |
| 251 | |
| 252 | @smallexample |
| 253 | @c man begin SYNOPSIS ar |
| 254 | ar [@option{--plugin} @var{name}] [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}] |
| 255 | @c man end |
| 256 | @end smallexample |
| 257 | |
| 258 | @cindex Unix compatibility, @command{ar} |
| 259 | When you use @command{ar} in the Unix style, @command{ar} insists on at least two |
| 260 | arguments to execute: one keyletter specifying the @emph{operation} |
| 261 | (optionally accompanied by other keyletters specifying |
| 262 | @emph{modifiers}), and the archive name to act on. |
| 263 | |
| 264 | Most operations can also accept further @var{member} arguments, |
| 265 | specifying particular files to operate on. |
| 266 | |
| 267 | @c man begin OPTIONS ar |
| 268 | |
| 269 | @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier |
| 270 | flags @var{mod} in any order, within the first command-line argument. |
| 271 | |
| 272 | If you wish, you may begin the first command-line argument with a |
| 273 | dash. |
| 274 | |
| 275 | @cindex operations on archive |
| 276 | The @var{p} keyletter specifies what operation to execute; it may be |
| 277 | any of the following, but you must specify only one of them: |
| 278 | |
| 279 | @table @samp |
| 280 | @item d |
| 281 | @cindex deleting from archive |
| 282 | @emph{Delete} modules from the archive. Specify the names of modules to |
| 283 | be deleted as @var{member}@dots{}; the archive is untouched if you |
| 284 | specify no files to delete. |
| 285 | |
| 286 | If you specify the @samp{v} modifier, @command{ar} lists each module |
| 287 | as it is deleted. |
| 288 | |
| 289 | @item m |
| 290 | @cindex moving in archive |
| 291 | Use this operation to @emph{move} members in an archive. |
| 292 | |
| 293 | The ordering of members in an archive can make a difference in how |
| 294 | programs are linked using the library, if a symbol is defined in more |
| 295 | than one member. |
| 296 | |
| 297 | If no modifiers are used with @code{m}, any members you name in the |
| 298 | @var{member} arguments are moved to the @emph{end} of the archive; |
| 299 | you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a |
| 300 | specified place instead. |
| 301 | |
| 302 | @item p |
| 303 | @cindex printing from archive |
| 304 | @emph{Print} the specified members of the archive, to the standard |
| 305 | output file. If the @samp{v} modifier is specified, show the member |
| 306 | name before copying its contents to standard output. |
| 307 | |
| 308 | If you specify no @var{member} arguments, all the files in the archive are |
| 309 | printed. |
| 310 | |
| 311 | @item q |
| 312 | @cindex quick append to archive |
| 313 | @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of |
| 314 | @var{archive}, without checking for replacement. |
| 315 | |
| 316 | The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this |
| 317 | operation; new members are always placed at the end of the archive. |
| 318 | |
| 319 | The modifier @samp{v} makes @command{ar} list each file as it is appended. |
| 320 | |
| 321 | Since the point of this operation is speed, the archive's symbol table |
| 322 | index is not updated, even if it already existed; you can use @samp{ar s} or |
| 323 | @command{ranlib} explicitly to update the symbol table index. |
| 324 | |
| 325 | However, too many different systems assume quick append rebuilds the |
| 326 | index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}. |
| 327 | |
| 328 | @item r |
| 329 | @cindex replacement in archive |
| 330 | Insert the files @var{member}@dots{} into @var{archive} (with |
| 331 | @emph{replacement}). This operation differs from @samp{q} in that any |
| 332 | previously existing members are deleted if their names match those being |
| 333 | added. |
| 334 | |
| 335 | If one of the files named in @var{member}@dots{} does not exist, @command{ar} |
| 336 | displays an error message, and leaves undisturbed any existing members |
| 337 | of the archive matching that name. |
| 338 | |
| 339 | By default, new members are added at the end of the file; but you may |
| 340 | use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request |
| 341 | placement relative to some existing member. |
| 342 | |
| 343 | The modifier @samp{v} used with this operation elicits a line of |
| 344 | output for each file inserted, along with one of the letters @samp{a} or |
| 345 | @samp{r} to indicate whether the file was appended (no old member |
| 346 | deleted) or replaced. |
| 347 | |
| 348 | @item t |
| 349 | @cindex contents of archive |
| 350 | Display a @emph{table} listing the contents of @var{archive}, or those |
| 351 | of the files listed in @var{member}@dots{} that are present in the |
| 352 | archive. Normally only the member name is shown; if you also want to |
| 353 | see the modes (permissions), timestamp, owner, group, and size, you can |
| 354 | request that by also specifying the @samp{v} modifier. |
| 355 | |
| 356 | If you do not specify a @var{member}, all files in the archive |
| 357 | are listed. |
| 358 | |
| 359 | @cindex repeated names in archive |
| 360 | @cindex name duplication in archive |
| 361 | If there is more than one file with the same name (say, @samp{fie}) in |
| 362 | an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the |
| 363 | first instance; to see them all, you must ask for a complete |
| 364 | listing---in our example, @samp{ar t b.a}. |
| 365 | @c WRS only; per Gumby, this is implementation-dependent, and in a more |
| 366 | @c recent case in fact works the other way. |
| 367 | |
| 368 | @item x |
| 369 | @cindex extract from archive |
| 370 | @emph{Extract} members (named @var{member}) from the archive. You can |
| 371 | use the @samp{v} modifier with this operation, to request that |
| 372 | @command{ar} list each name as it extracts it. |
| 373 | |
| 374 | If you do not specify a @var{member}, all files in the archive |
| 375 | are extracted. |
| 376 | |
| 377 | Files cannot be extracted from a thin archive. |
| 378 | |
| 379 | @end table |
| 380 | |
| 381 | A number of modifiers (@var{mod}) may immediately follow the @var{p} |
| 382 | keyletter, to specify variations on an operation's behavior: |
| 383 | |
| 384 | @table @samp |
| 385 | @item a |
| 386 | @cindex relative placement in archive |
| 387 | Add new files @emph{after} an existing member of the |
| 388 | archive. If you use the modifier @samp{a}, the name of an existing archive |
| 389 | member must be present as the @var{relpos} argument, before the |
| 390 | @var{archive} specification. |
| 391 | |
| 392 | @item b |
| 393 | Add new files @emph{before} an existing member of the |
| 394 | archive. If you use the modifier @samp{b}, the name of an existing archive |
| 395 | member must be present as the @var{relpos} argument, before the |
| 396 | @var{archive} specification. (same as @samp{i}). |
| 397 | |
| 398 | @item c |
| 399 | @cindex creating archives |
| 400 | @emph{Create} the archive. The specified @var{archive} is always |
| 401 | created if it did not exist, when you request an update. But a warning is |
| 402 | issued unless you specify in advance that you expect to create it, by |
| 403 | using this modifier. |
| 404 | |
| 405 | @item D |
| 406 | @cindex deterministic archives |
| 407 | Operate in @emph{deterministic} mode. When adding files and the archive |
| 408 | index use zero for UIDs, GIDs, timestamps, and use consistent file modes |
| 409 | for all files. When this option is used, if @command{ar} is used with |
| 410 | identical options and identical input files, multiple runs will create |
| 411 | identical output files regardless of the input files' owners, groups, |
| 412 | file modes, or modification times. |
| 413 | |
| 414 | @item f |
| 415 | Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file |
| 416 | names of any length. This will cause it to create archives which are |
| 417 | not compatible with the native @command{ar} program on some systems. If |
| 418 | this is a concern, the @samp{f} modifier may be used to truncate file |
| 419 | names when putting them in the archive. |
| 420 | |
| 421 | @item i |
| 422 | Insert new files @emph{before} an existing member of the |
| 423 | archive. If you use the modifier @samp{i}, the name of an existing archive |
| 424 | member must be present as the @var{relpos} argument, before the |
| 425 | @var{archive} specification. (same as @samp{b}). |
| 426 | |
| 427 | @item l |
| 428 | This modifier is accepted but not used. |
| 429 | @c whaffor ar l modifier??? presumably compat; with |
| 430 | @c what???---doc@@cygnus.com, 25jan91 |
| 431 | |
| 432 | @item N |
| 433 | Uses the @var{count} parameter. This is used if there are multiple |
| 434 | entries in the archive with the same name. Extract or delete instance |
| 435 | @var{count} of the given name from the archive. |
| 436 | |
| 437 | @item o |
| 438 | @cindex dates in archive |
| 439 | Preserve the @emph{original} dates of members when extracting them. If |
| 440 | you do not specify this modifier, files extracted from the archive |
| 441 | are stamped with the time of extraction. |
| 442 | |
| 443 | @item P |
| 444 | Use the full path name when matching names in the archive. @sc{gnu} |
| 445 | @command{ar} can not create an archive with a full path name (such archives |
| 446 | are not POSIX complaint), but other archive creators can. This option |
| 447 | will cause @sc{gnu} @command{ar} to match file names using a complete path |
| 448 | name, which can be convenient when extracting a single file from an |
| 449 | archive created by another tool. |
| 450 | |
| 451 | @item s |
| 452 | @cindex writing archive index |
| 453 | Write an object-file index into the archive, or update an existing one, |
| 454 | even if no other change is made to the archive. You may use this modifier |
| 455 | flag either with any operation, or alone. Running @samp{ar s} on an |
| 456 | archive is equivalent to running @samp{ranlib} on it. |
| 457 | |
| 458 | @item S |
| 459 | @cindex not writing archive index |
| 460 | Do not generate an archive symbol table. This can speed up building a |
| 461 | large library in several steps. The resulting archive can not be used |
| 462 | with the linker. In order to build a symbol table, you must omit the |
| 463 | @samp{S} modifier on the last execution of @samp{ar}, or you must run |
| 464 | @samp{ranlib} on the archive. |
| 465 | |
| 466 | @item T |
| 467 | @cindex creating thin archive |
| 468 | Make the specified @var{archive} a @emph{thin} archive. If it already |
| 469 | exists and is a regular archive, the existing members must be present |
| 470 | in the same directory as @var{archive}. |
| 471 | |
| 472 | @item u |
| 473 | @cindex updating an archive |
| 474 | Normally, @samp{ar r}@dots{} inserts all files |
| 475 | listed into the archive. If you would like to insert @emph{only} those |
| 476 | of the files you list that are newer than existing members of the same |
| 477 | names, use this modifier. The @samp{u} modifier is allowed only for the |
| 478 | operation @samp{r} (replace). In particular, the combination @samp{qu} is |
| 479 | not allowed, since checking the timestamps would lose any speed |
| 480 | advantage from the operation @samp{q}. |
| 481 | |
| 482 | @item v |
| 483 | This modifier requests the @emph{verbose} version of an operation. Many |
| 484 | operations display additional information, such as filenames processed, |
| 485 | when the modifier @samp{v} is appended. |
| 486 | |
| 487 | @item V |
| 488 | This modifier shows the version number of @command{ar}. |
| 489 | @end table |
| 490 | |
| 491 | @command{ar} ignores an initial option spelt @samp{-X32_64}, for |
| 492 | compatibility with AIX. The behaviour produced by this option is the |
| 493 | default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other |
| 494 | @samp{-X} options; in particular, it does not support @option{-X32} |
| 495 | which is the default for AIX @command{ar}. |
| 496 | |
| 497 | The optional command line switch @option{--plugin} @var{name} causes |
| 498 | @command{ar} to load the plugin called @var{name} which adds support |
| 499 | for more file formats. This option is only available if the toolchain |
| 500 | has been built with plugin support enabled. |
| 501 | |
| 502 | @c man end |
| 503 | |
| 504 | @ignore |
| 505 | @c man begin SEEALSO ar |
| 506 | nm(1), ranlib(1), and the Info entries for @file{binutils}. |
| 507 | @c man end |
| 508 | @end ignore |
| 509 | |
| 510 | @node ar scripts |
| 511 | @section Controlling @command{ar} with a Script |
| 512 | |
| 513 | @smallexample |
| 514 | ar -M [ <@var{script} ] |
| 515 | @end smallexample |
| 516 | |
| 517 | @cindex MRI compatibility, @command{ar} |
| 518 | @cindex scripts, @command{ar} |
| 519 | If you use the single command-line option @samp{-M} with @command{ar}, you |
| 520 | can control its operation with a rudimentary command language. This |
| 521 | form of @command{ar} operates interactively if standard input is coming |
| 522 | directly from a terminal. During interactive use, @command{ar} prompts for |
| 523 | input (the prompt is @samp{AR >}), and continues executing even after |
| 524 | errors. If you redirect standard input to a script file, no prompts are |
| 525 | issued, and @command{ar} abandons execution (with a nonzero exit code) |
| 526 | on any error. |
| 527 | |
| 528 | The @command{ar} command language is @emph{not} designed to be equivalent |
| 529 | to the command-line options; in fact, it provides somewhat less control |
| 530 | over archives. The only purpose of the command language is to ease the |
| 531 | transition to @sc{gnu} @command{ar} for developers who already have scripts |
| 532 | written for the MRI ``librarian'' program. |
| 533 | |
| 534 | The syntax for the @command{ar} command language is straightforward: |
| 535 | @itemize @bullet |
| 536 | @item |
| 537 | commands are recognized in upper or lower case; for example, @code{LIST} |
| 538 | is the same as @code{list}. In the following descriptions, commands are |
| 539 | shown in upper case for clarity. |
| 540 | |
| 541 | @item |
| 542 | a single command may appear on each line; it is the first word on the |
| 543 | line. |
| 544 | |
| 545 | @item |
| 546 | empty lines are allowed, and have no effect. |
| 547 | |
| 548 | @item |
| 549 | comments are allowed; text after either of the characters @samp{*} |
| 550 | or @samp{;} is ignored. |
| 551 | |
| 552 | @item |
| 553 | Whenever you use a list of names as part of the argument to an @command{ar} |
| 554 | command, you can separate the individual names with either commas or |
| 555 | blanks. Commas are shown in the explanations below, for clarity. |
| 556 | |
| 557 | @item |
| 558 | @samp{+} is used as a line continuation character; if @samp{+} appears |
| 559 | at the end of a line, the text on the following line is considered part |
| 560 | of the current command. |
| 561 | @end itemize |
| 562 | |
| 563 | Here are the commands you can use in @command{ar} scripts, or when using |
| 564 | @command{ar} interactively. Three of them have special significance: |
| 565 | |
| 566 | @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is |
| 567 | a temporary file required for most of the other commands. |
| 568 | |
| 569 | @code{SAVE} commits the changes so far specified by the script. Prior |
| 570 | to @code{SAVE}, commands affect only the temporary copy of the current |
| 571 | archive. |
| 572 | |
| 573 | @table @code |
| 574 | @item ADDLIB @var{archive} |
| 575 | @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module}) |
| 576 | Add all the contents of @var{archive} (or, if specified, each named |
| 577 | @var{module} from @var{archive}) to the current archive. |
| 578 | |
| 579 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 580 | |
| 581 | @item ADDMOD @var{member}, @var{member}, @dots{} @var{member} |
| 582 | @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}" |
| 583 | @c else like "ar q..." |
| 584 | Add each named @var{member} as a module in the current archive. |
| 585 | |
| 586 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 587 | |
| 588 | @item CLEAR |
| 589 | Discard the contents of the current archive, canceling the effect of |
| 590 | any operations since the last @code{SAVE}. May be executed (with no |
| 591 | effect) even if no current archive is specified. |
| 592 | |
| 593 | @item CREATE @var{archive} |
| 594 | Creates an archive, and makes it the current archive (required for many |
| 595 | other commands). The new archive is created with a temporary name; it |
| 596 | is not actually saved as @var{archive} until you use @code{SAVE}. |
| 597 | You can overwrite existing archives; similarly, the contents of any |
| 598 | existing file named @var{archive} will not be destroyed until @code{SAVE}. |
| 599 | |
| 600 | @item DELETE @var{module}, @var{module}, @dots{} @var{module} |
| 601 | Delete each listed @var{module} from the current archive; equivalent to |
| 602 | @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}. |
| 603 | |
| 604 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 605 | |
| 606 | @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) |
| 607 | @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile} |
| 608 | List each named @var{module} present in @var{archive}. The separate |
| 609 | command @code{VERBOSE} specifies the form of the output: when verbose |
| 610 | output is off, output is like that of @samp{ar -t @var{archive} |
| 611 | @var{module}@dots{}}. When verbose output is on, the listing is like |
| 612 | @samp{ar -tv @var{archive} @var{module}@dots{}}. |
| 613 | |
| 614 | Output normally goes to the standard output stream; however, if you |
| 615 | specify @var{outputfile} as a final argument, @command{ar} directs the |
| 616 | output to that file. |
| 617 | |
| 618 | @item END |
| 619 | Exit from @command{ar}, with a @code{0} exit code to indicate successful |
| 620 | completion. This command does not save the output file; if you have |
| 621 | changed the current archive since the last @code{SAVE} command, those |
| 622 | changes are lost. |
| 623 | |
| 624 | @item EXTRACT @var{module}, @var{module}, @dots{} @var{module} |
| 625 | Extract each named @var{module} from the current archive, writing them |
| 626 | into the current directory as separate files. Equivalent to @samp{ar -x |
| 627 | @var{archive} @var{module}@dots{}}. |
| 628 | |
| 629 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 630 | |
| 631 | @ignore |
| 632 | @c FIXME Tokens but no commands??? |
| 633 | @item FULLDIR |
| 634 | |
| 635 | @item HELP |
| 636 | @end ignore |
| 637 | |
| 638 | @item LIST |
| 639 | Display full contents of the current archive, in ``verbose'' style |
| 640 | regardless of the state of @code{VERBOSE}. The effect is like @samp{ar |
| 641 | tv @var{archive}}. (This single command is a @sc{gnu} @command{ar} |
| 642 | enhancement, rather than present for MRI compatibility.) |
| 643 | |
| 644 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 645 | |
| 646 | @item OPEN @var{archive} |
| 647 | Opens an existing archive for use as the current archive (required for |
| 648 | many other commands). Any changes as the result of subsequent commands |
| 649 | will not actually affect @var{archive} until you next use @code{SAVE}. |
| 650 | |
| 651 | @item REPLACE @var{module}, @var{module}, @dots{} @var{module} |
| 652 | In the current archive, replace each existing @var{module} (named in |
| 653 | the @code{REPLACE} arguments) from files in the current working directory. |
| 654 | To execute this command without errors, both the file, and the module in |
| 655 | the current archive, must exist. |
| 656 | |
| 657 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 658 | |
| 659 | @item VERBOSE |
| 660 | Toggle an internal flag governing the output from @code{DIRECTORY}. |
| 661 | When the flag is on, @code{DIRECTORY} output matches output from |
| 662 | @samp{ar -tv }@dots{}. |
| 663 | |
| 664 | @item SAVE |
| 665 | Commit your changes to the current archive, and actually save it as a |
| 666 | file with the name specified in the last @code{CREATE} or @code{OPEN} |
| 667 | command. |
| 668 | |
| 669 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 670 | |
| 671 | @end table |
| 672 | |
| 673 | @iftex |
| 674 | @node ld |
| 675 | @chapter ld |
| 676 | @cindex linker |
| 677 | @kindex ld |
| 678 | The @sc{gnu} linker @command{ld} is now described in a separate manual. |
| 679 | @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}. |
| 680 | @end iftex |
| 681 | |
| 682 | @node nm |
| 683 | @chapter nm |
| 684 | @cindex symbols |
| 685 | @kindex nm |
| 686 | |
| 687 | @c man title nm list symbols from object files |
| 688 | |
| 689 | @smallexample |
| 690 | @c man begin SYNOPSIS nm |
| 691 | nm [@option{-a}|@option{--debug-syms}] |
| 692 | [@option{-g}|@option{--extern-only}][@option{--plugin} @var{name}] |
| 693 | [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}] |
| 694 | [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}] |
| 695 | [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}] |
| 696 | [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}] |
| 697 | [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}] |
| 698 | [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}] |
| 699 | [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}] |
| 700 | [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}] |
| 701 | [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}] |
| 702 | @c man end |
| 703 | @end smallexample |
| 704 | |
| 705 | @c man begin DESCRIPTION nm |
| 706 | @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}. |
| 707 | If no object files are listed as arguments, @command{nm} assumes the file |
| 708 | @file{a.out}. |
| 709 | |
| 710 | For each symbol, @command{nm} shows: |
| 711 | |
| 712 | @itemize @bullet |
| 713 | @item |
| 714 | The symbol value, in the radix selected by options (see below), or |
| 715 | hexadecimal by default. |
| 716 | |
| 717 | @item |
| 718 | The symbol type. At least the following types are used; others are, as |
| 719 | well, depending on the object file format. If lowercase, the symbol is |
| 720 | local; if uppercase, the symbol is global (external). |
| 721 | |
| 722 | @c Some more detail on exactly what these symbol types are used for |
| 723 | @c would be nice. |
| 724 | @table @code |
| 725 | @item A |
| 726 | The symbol's value is absolute, and will not be changed by further |
| 727 | linking. |
| 728 | |
| 729 | @item B |
| 730 | @itemx b |
| 731 | The symbol is in the uninitialized data section (known as BSS). |
| 732 | |
| 733 | @item C |
| 734 | The symbol is common. Common symbols are uninitialized data. When |
| 735 | linking, multiple common symbols may appear with the same name. If the |
| 736 | symbol is defined anywhere, the common symbols are treated as undefined |
| 737 | references. |
| 738 | @ifclear man |
| 739 | For more details on common symbols, see the discussion of |
| 740 | --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}. |
| 741 | @end ifclear |
| 742 | |
| 743 | @item D |
| 744 | @itemx d |
| 745 | The symbol is in the initialized data section. |
| 746 | |
| 747 | @item G |
| 748 | @itemx g |
| 749 | The symbol is in an initialized data section for small objects. Some |
| 750 | object file formats permit more efficient access to small data objects, |
| 751 | such as a global int variable as opposed to a large global array. |
| 752 | |
| 753 | @item i |
| 754 | For PE format files this indicates that the symbol is in a section |
| 755 | specific to the implementation of DLLs. For ELF format files this |
| 756 | indicates that the symbol is an indirect function. This is a GNU |
| 757 | extension to the standard set of ELF symbol types. It indicates a |
| 758 | symbol which if referenced by a relocation does not evaluate to its |
| 759 | address, but instead must be invoked at runtime. The runtime |
| 760 | execution will then return the value to be used in the relocation. |
| 761 | |
| 762 | @item N |
| 763 | The symbol is a debugging symbol. |
| 764 | |
| 765 | @item p |
| 766 | The symbols is in a stack unwind section. |
| 767 | |
| 768 | @item R |
| 769 | @itemx r |
| 770 | The symbol is in a read only data section. |
| 771 | |
| 772 | @item S |
| 773 | @itemx s |
| 774 | The symbol is in an uninitialized data section for small objects. |
| 775 | |
| 776 | @item T |
| 777 | @itemx t |
| 778 | The symbol is in the text (code) section. |
| 779 | |
| 780 | @item U |
| 781 | The symbol is undefined. |
| 782 | |
| 783 | @item u |
| 784 | The symbol is a unique global symbol. This is a GNU extension to the |
| 785 | standard set of ELF symbol bindings. For such a symbol the dynamic linker |
| 786 | will make sure that in the entire process there is just one symbol with |
| 787 | this name and type in use. |
| 788 | |
| 789 | @item V |
| 790 | @itemx v |
| 791 | The symbol is a weak object. When a weak defined symbol is linked with |
| 792 | a normal defined symbol, the normal defined symbol is used with no error. |
| 793 | When a weak undefined symbol is linked and the symbol is not defined, |
| 794 | the value of the weak symbol becomes zero with no error. On some |
| 795 | systems, uppercase indicates that a default value has been specified. |
| 796 | |
| 797 | @item W |
| 798 | @itemx w |
| 799 | The symbol is a weak symbol that has not been specifically tagged as a |
| 800 | weak object symbol. When a weak defined symbol is linked with a normal |
| 801 | defined symbol, the normal defined symbol is used with no error. |
| 802 | When a weak undefined symbol is linked and the symbol is not defined, |
| 803 | the value of the symbol is determined in a system-specific manner without |
| 804 | error. On some systems, uppercase indicates that a default value has been |
| 805 | specified. |
| 806 | |
| 807 | @item - |
| 808 | The symbol is a stabs symbol in an a.out object file. In this case, the |
| 809 | next values printed are the stabs other field, the stabs desc field, and |
| 810 | the stab type. Stabs symbols are used to hold debugging information. |
| 811 | @ifclear man |
| 812 | For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The |
| 813 | ``stabs'' debug format}. |
| 814 | @end ifclear |
| 815 | |
| 816 | @item ? |
| 817 | The symbol type is unknown, or object file format specific. |
| 818 | @end table |
| 819 | |
| 820 | @item |
| 821 | The symbol name. |
| 822 | @end itemize |
| 823 | |
| 824 | @c man end |
| 825 | |
| 826 | @c man begin OPTIONS nm |
| 827 | The long and short forms of options, shown here as alternatives, are |
| 828 | equivalent. |
| 829 | |
| 830 | @table @env |
| 831 | @item -A |
| 832 | @itemx -o |
| 833 | @itemx --print-file-name |
| 834 | @cindex input file name |
| 835 | @cindex file name |
| 836 | @cindex source file name |
| 837 | Precede each symbol by the name of the input file (or archive member) |
| 838 | in which it was found, rather than identifying the input file once only, |
| 839 | before all of its symbols. |
| 840 | |
| 841 | @item -a |
| 842 | @itemx --debug-syms |
| 843 | @cindex debugging symbols |
| 844 | Display all symbols, even debugger-only symbols; normally these are not |
| 845 | listed. |
| 846 | |
| 847 | @item -B |
| 848 | @cindex @command{nm} format |
| 849 | @cindex @command{nm} compatibility |
| 850 | The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}). |
| 851 | |
| 852 | @item -C |
| 853 | @itemx --demangle[=@var{style}] |
| 854 | @cindex demangling in nm |
| 855 | Decode (@dfn{demangle}) low-level symbol names into user-level names. |
| 856 | Besides removing any initial underscore prepended by the system, this |
| 857 | makes C++ function names readable. Different compilers have different |
| 858 | mangling styles. The optional demangling style argument can be used to |
| 859 | choose an appropriate demangling style for your compiler. @xref{c++filt}, |
| 860 | for more information on demangling. |
| 861 | |
| 862 | @item --no-demangle |
| 863 | Do not demangle low-level symbol names. This is the default. |
| 864 | |
| 865 | @item -D |
| 866 | @itemx --dynamic |
| 867 | @cindex dynamic symbols |
| 868 | Display the dynamic symbols rather than the normal symbols. This is |
| 869 | only meaningful for dynamic objects, such as certain types of shared |
| 870 | libraries. |
| 871 | |
| 872 | @item -f @var{format} |
| 873 | @itemx --format=@var{format} |
| 874 | @cindex @command{nm} format |
| 875 | @cindex @command{nm} compatibility |
| 876 | Use the output format @var{format}, which can be @code{bsd}, |
| 877 | @code{sysv}, or @code{posix}. The default is @code{bsd}. |
| 878 | Only the first character of @var{format} is significant; it can be |
| 879 | either upper or lower case. |
| 880 | |
| 881 | @item -g |
| 882 | @itemx --extern-only |
| 883 | @cindex external symbols |
| 884 | Display only external symbols. |
| 885 | |
| 886 | @item --plugin @var{name} |
| 887 | @cindex load plugin |
| 888 | Load the plugin called @var{name} to add support for extra target |
| 889 | types. This option is only available if the toolchain has been built |
| 890 | with plugin support enabled. |
| 891 | |
| 892 | @item -l |
| 893 | @itemx --line-numbers |
| 894 | @cindex symbol line numbers |
| 895 | For each symbol, use debugging information to try to find a filename and |
| 896 | line number. For a defined symbol, look for the line number of the |
| 897 | address of the symbol. For an undefined symbol, look for the line |
| 898 | number of a relocation entry which refers to the symbol. If line number |
| 899 | information can be found, print it after the other symbol information. |
| 900 | |
| 901 | @item -n |
| 902 | @itemx -v |
| 903 | @itemx --numeric-sort |
| 904 | Sort symbols numerically by their addresses, rather than alphabetically |
| 905 | by their names. |
| 906 | |
| 907 | @item -p |
| 908 | @itemx --no-sort |
| 909 | @cindex sorting symbols |
| 910 | Do not bother to sort the symbols in any order; print them in the order |
| 911 | encountered. |
| 912 | |
| 913 | @item -P |
| 914 | @itemx --portability |
| 915 | Use the POSIX.2 standard output format instead of the default format. |
| 916 | Equivalent to @samp{-f posix}. |
| 917 | |
| 918 | @item -S |
| 919 | @itemx --print-size |
| 920 | Print both value and size of defined symbols for the @code{bsd} output style. |
| 921 | This option has no effect for object formats that do not record symbol |
| 922 | sizes, unless @samp{--size-sort} is also used in which case a |
| 923 | calculated size is displayed. |
| 924 | |
| 925 | @item -s |
| 926 | @itemx --print-armap |
| 927 | @cindex symbol index, listing |
| 928 | When listing symbols from archive members, include the index: a mapping |
| 929 | (stored in the archive by @command{ar} or @command{ranlib}) of which modules |
| 930 | contain definitions for which names. |
| 931 | |
| 932 | @item -r |
| 933 | @itemx --reverse-sort |
| 934 | Reverse the order of the sort (whether numeric or alphabetic); let the |
| 935 | last come first. |
| 936 | |
| 937 | @item --size-sort |
| 938 | Sort symbols by size. The size is computed as the difference between |
| 939 | the value of the symbol and the value of the symbol with the next higher |
| 940 | value. If the @code{bsd} output format is used the size of the symbol |
| 941 | is printed, rather than the value, and @samp{-S} must be used in order |
| 942 | both size and value to be printed. |
| 943 | |
| 944 | @item --special-syms |
| 945 | Display symbols which have a target-specific special meaning. These |
| 946 | symbols are usually used by the target for some special processing and |
| 947 | are not normally helpful when included included in the normal symbol |
| 948 | lists. For example for ARM targets this option would skip the mapping |
| 949 | symbols used to mark transitions between ARM code, THUMB code and |
| 950 | data. |
| 951 | |
| 952 | @item -t @var{radix} |
| 953 | @itemx --radix=@var{radix} |
| 954 | Use @var{radix} as the radix for printing the symbol values. It must be |
| 955 | @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal. |
| 956 | |
| 957 | @item --target=@var{bfdname} |
| 958 | @cindex object code format |
| 959 | Specify an object code format other than your system's default format. |
| 960 | @xref{Target Selection}, for more information. |
| 961 | |
| 962 | @item -u |
| 963 | @itemx --undefined-only |
| 964 | @cindex external symbols |
| 965 | @cindex undefined symbols |
| 966 | Display only undefined symbols (those external to each object file). |
| 967 | |
| 968 | @item --defined-only |
| 969 | @cindex external symbols |
| 970 | @cindex undefined symbols |
| 971 | Display only defined symbols for each object file. |
| 972 | |
| 973 | @item -V |
| 974 | @itemx --version |
| 975 | Show the version number of @command{nm} and exit. |
| 976 | |
| 977 | @item -X |
| 978 | This option is ignored for compatibility with the AIX version of |
| 979 | @command{nm}. It takes one parameter which must be the string |
| 980 | @option{32_64}. The default mode of AIX @command{nm} corresponds |
| 981 | to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}. |
| 982 | |
| 983 | @item --help |
| 984 | Show a summary of the options to @command{nm} and exit. |
| 985 | @end table |
| 986 | |
| 987 | @c man end |
| 988 | |
| 989 | @ignore |
| 990 | @c man begin SEEALSO nm |
| 991 | ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}. |
| 992 | @c man end |
| 993 | @end ignore |
| 994 | |
| 995 | @node objcopy |
| 996 | @chapter objcopy |
| 997 | |
| 998 | @c man title objcopy copy and translate object files |
| 999 | |
| 1000 | @smallexample |
| 1001 | @c man begin SYNOPSIS objcopy |
| 1002 | objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}] |
| 1003 | [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}] |
| 1004 | [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}] |
| 1005 | [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}] |
| 1006 | [@option{-S}|@option{--strip-all}] |
| 1007 | [@option{-g}|@option{--strip-debug}] |
| 1008 | [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}] |
| 1009 | [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}] |
| 1010 | [@option{--strip-unneeded-symbol=}@var{symbolname}] |
| 1011 | [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}] |
| 1012 | [@option{--localize-hidden}] |
| 1013 | [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}] |
| 1014 | [@option{--globalize-symbol=}@var{symbolname}] |
| 1015 | [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}] |
| 1016 | [@option{-w}|@option{--wildcard}] |
| 1017 | [@option{-x}|@option{--discard-all}] |
| 1018 | [@option{-X}|@option{--discard-locals}] |
| 1019 | [@option{-b} @var{byte}|@option{--byte=}@var{byte}] |
| 1020 | [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}] |
| 1021 | [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}] |
| 1022 | [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}] |
| 1023 | [@option{-p}|@option{--preserve-dates}] |
| 1024 | [@option{--debugging}] |
| 1025 | [@option{--gap-fill=}@var{val}] |
| 1026 | [@option{--pad-to=}@var{address}] |
| 1027 | [@option{--set-start=}@var{val}] |
| 1028 | [@option{--adjust-start=}@var{incr}] |
| 1029 | [@option{--change-addresses=}@var{incr}] |
| 1030 | [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}] |
| 1031 | [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}] |
| 1032 | [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}] |
| 1033 | [@option{--change-warnings}] [@option{--no-change-warnings}] |
| 1034 | [@option{--set-section-flags} @var{section}=@var{flags}] |
| 1035 | [@option{--add-section} @var{sectionname}=@var{filename}] |
| 1036 | [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]] |
| 1037 | [@option{--long-section-names} @{enable,disable,keep@}] |
| 1038 | [@option{--change-leading-char}] [@option{--remove-leading-char}] |
| 1039 | [@option{--reverse-bytes=}@var{num}] |
| 1040 | [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}] |
| 1041 | [@option{--redefine-sym} @var{old}=@var{new}] |
| 1042 | [@option{--redefine-syms=}@var{filename}] |
| 1043 | [@option{--weaken}] |
| 1044 | [@option{--keep-symbols=}@var{filename}] |
| 1045 | [@option{--strip-symbols=}@var{filename}] |
| 1046 | [@option{--strip-unneeded-symbols=}@var{filename}] |
| 1047 | [@option{--keep-global-symbols=}@var{filename}] |
| 1048 | [@option{--localize-symbols=}@var{filename}] |
| 1049 | [@option{--globalize-symbols=}@var{filename}] |
| 1050 | [@option{--weaken-symbols=}@var{filename}] |
| 1051 | [@option{--alt-machine-code=}@var{index}] |
| 1052 | [@option{--prefix-symbols=}@var{string}] |
| 1053 | [@option{--prefix-sections=}@var{string}] |
| 1054 | [@option{--prefix-alloc-sections=}@var{string}] |
| 1055 | [@option{--add-gnu-debuglink=}@var{path-to-file}] |
| 1056 | [@option{--keep-file-symbols}] |
| 1057 | [@option{--only-keep-debug}] |
| 1058 | [@option{--extract-symbol}] |
| 1059 | [@option{--writable-text}] |
| 1060 | [@option{--readonly-text}] |
| 1061 | [@option{--pure}] |
| 1062 | [@option{--impure}] |
| 1063 | [@option{--file-alignment=}@var{num}] |
| 1064 | [@option{--heap=}@var{size}] |
| 1065 | [@option{--image-base=}@var{address}] |
| 1066 | [@option{--section-alignment=}@var{num}] |
| 1067 | [@option{--stack=}@var{size}] |
| 1068 | [@option{--subsystem=}@var{which}:@var{major}.@var{minor}] |
| 1069 | [@option{-v}|@option{--verbose}] |
| 1070 | [@option{-V}|@option{--version}] |
| 1071 | [@option{--help}] [@option{--info}] |
| 1072 | @var{infile} [@var{outfile}] |
| 1073 | @c man end |
| 1074 | @end smallexample |
| 1075 | |
| 1076 | @c man begin DESCRIPTION objcopy |
| 1077 | The @sc{gnu} @command{objcopy} utility copies the contents of an object |
| 1078 | file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to |
| 1079 | read and write the object files. It can write the destination object |
| 1080 | file in a format different from that of the source object file. The |
| 1081 | exact behavior of @command{objcopy} is controlled by command-line options. |
| 1082 | Note that @command{objcopy} should be able to copy a fully linked file |
| 1083 | between any two formats. However, copying a relocatable object file |
| 1084 | between any two formats may not work as expected. |
| 1085 | |
| 1086 | @command{objcopy} creates temporary files to do its translations and |
| 1087 | deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its |
| 1088 | translation work; it has access to all the formats described in @sc{bfd} |
| 1089 | and thus is able to recognize most formats without being told |
| 1090 | explicitly. @xref{BFD,,BFD,ld.info,Using LD}. |
| 1091 | |
| 1092 | @command{objcopy} can be used to generate S-records by using an output |
| 1093 | target of @samp{srec} (e.g., use @samp{-O srec}). |
| 1094 | |
| 1095 | @command{objcopy} can be used to generate a raw binary file by using an |
| 1096 | output target of @samp{binary} (e.g., use @option{-O binary}). When |
| 1097 | @command{objcopy} generates a raw binary file, it will essentially produce |
| 1098 | a memory dump of the contents of the input object file. All symbols and |
| 1099 | relocation information will be discarded. The memory dump will start at |
| 1100 | the load address of the lowest section copied into the output file. |
| 1101 | |
| 1102 | When generating an S-record or a raw binary file, it may be helpful to |
| 1103 | use @option{-S} to remove sections containing debugging information. In |
| 1104 | some cases @option{-R} will be useful to remove sections which contain |
| 1105 | information that is not needed by the binary file. |
| 1106 | |
| 1107 | Note---@command{objcopy} is not able to change the endianness of its input |
| 1108 | files. If the input format has an endianness (some formats do not), |
| 1109 | @command{objcopy} can only copy the inputs into file formats that have the |
| 1110 | same endianness or which have no endianness (e.g., @samp{srec}). |
| 1111 | (However, see the @option{--reverse-bytes} option.) |
| 1112 | |
| 1113 | @c man end |
| 1114 | |
| 1115 | @c man begin OPTIONS objcopy |
| 1116 | |
| 1117 | @table @env |
| 1118 | @item @var{infile} |
| 1119 | @itemx @var{outfile} |
| 1120 | The input and output files, respectively. |
| 1121 | If you do not specify @var{outfile}, @command{objcopy} creates a |
| 1122 | temporary file and destructively renames the result with |
| 1123 | the name of @var{infile}. |
| 1124 | |
| 1125 | @item -I @var{bfdname} |
| 1126 | @itemx --input-target=@var{bfdname} |
| 1127 | Consider the source file's object format to be @var{bfdname}, rather than |
| 1128 | attempting to deduce it. @xref{Target Selection}, for more information. |
| 1129 | |
| 1130 | @item -O @var{bfdname} |
| 1131 | @itemx --output-target=@var{bfdname} |
| 1132 | Write the output file using the object format @var{bfdname}. |
| 1133 | @xref{Target Selection}, for more information. |
| 1134 | |
| 1135 | @item -F @var{bfdname} |
| 1136 | @itemx --target=@var{bfdname} |
| 1137 | Use @var{bfdname} as the object format for both the input and the output |
| 1138 | file; i.e., simply transfer data from source to destination with no |
| 1139 | translation. @xref{Target Selection}, for more information. |
| 1140 | |
| 1141 | @item -B @var{bfdarch} |
| 1142 | @itemx --binary-architecture=@var{bfdarch} |
| 1143 | Useful when transforming a architecture-less input file into an object file. |
| 1144 | In this case the output architecture can be set to @var{bfdarch}. This |
| 1145 | option will be ignored if the input file has a known @var{bfdarch}. You |
| 1146 | can access this binary data inside a program by referencing the special |
| 1147 | symbols that are created by the conversion process. These symbols are |
| 1148 | called _binary_@var{objfile}_start, _binary_@var{objfile}_end and |
| 1149 | _binary_@var{objfile}_size. e.g. you can transform a picture file into |
| 1150 | an object file and then access it in your code using these symbols. |
| 1151 | |
| 1152 | @item -j @var{sectionname} |
| 1153 | @itemx --only-section=@var{sectionname} |
| 1154 | Copy only the named section from the input file to the output file. |
| 1155 | This option may be given more than once. Note that using this option |
| 1156 | inappropriately may make the output file unusable. |
| 1157 | |
| 1158 | @item -R @var{sectionname} |
| 1159 | @itemx --remove-section=@var{sectionname} |
| 1160 | Remove any section named @var{sectionname} from the output file. This |
| 1161 | option may be given more than once. Note that using this option |
| 1162 | inappropriately may make the output file unusable. |
| 1163 | |
| 1164 | @item -S |
| 1165 | @itemx --strip-all |
| 1166 | Do not copy relocation and symbol information from the source file. |
| 1167 | |
| 1168 | @item -g |
| 1169 | @itemx --strip-debug |
| 1170 | Do not copy debugging symbols or sections from the source file. |
| 1171 | |
| 1172 | @item --strip-unneeded |
| 1173 | Strip all symbols that are not needed for relocation processing. |
| 1174 | |
| 1175 | @item -K @var{symbolname} |
| 1176 | @itemx --keep-symbol=@var{symbolname} |
| 1177 | When stripping symbols, keep symbol @var{symbolname} even if it would |
| 1178 | normally be stripped. This option may be given more than once. |
| 1179 | |
| 1180 | @item -N @var{symbolname} |
| 1181 | @itemx --strip-symbol=@var{symbolname} |
| 1182 | Do not copy symbol @var{symbolname} from the source file. This option |
| 1183 | may be given more than once. |
| 1184 | |
| 1185 | @item --strip-unneeded-symbol=@var{symbolname} |
| 1186 | Do not copy symbol @var{symbolname} from the source file unless it is needed |
| 1187 | by a relocation. This option may be given more than once. |
| 1188 | |
| 1189 | @item -G @var{symbolname} |
| 1190 | @itemx --keep-global-symbol=@var{symbolname} |
| 1191 | Keep only symbol @var{symbolname} global. Make all other symbols local |
| 1192 | to the file, so that they are not visible externally. This option may |
| 1193 | be given more than once. |
| 1194 | |
| 1195 | @item --localize-hidden |
| 1196 | In an ELF object, mark all symbols that have hidden or internal visibility |
| 1197 | as local. This option applies on top of symbol-specific localization options |
| 1198 | such as @option{-L}. |
| 1199 | |
| 1200 | @item -L @var{symbolname} |
| 1201 | @itemx --localize-symbol=@var{symbolname} |
| 1202 | Make symbol @var{symbolname} local to the file, so that it is not |
| 1203 | visible externally. This option may be given more than once. |
| 1204 | |
| 1205 | @item -W @var{symbolname} |
| 1206 | @itemx --weaken-symbol=@var{symbolname} |
| 1207 | Make symbol @var{symbolname} weak. This option may be given more than once. |
| 1208 | |
| 1209 | @item --globalize-symbol=@var{symbolname} |
| 1210 | Give symbol @var{symbolname} global scoping so that it is visible |
| 1211 | outside of the file in which it is defined. This option may be given |
| 1212 | more than once. |
| 1213 | |
| 1214 | @item -w |
| 1215 | @itemx --wildcard |
| 1216 | Permit regular expressions in @var{symbolname}s used in other command |
| 1217 | line options. The question mark (?), asterisk (*), backslash (\) and |
| 1218 | square brackets ([]) operators can be used anywhere in the symbol |
| 1219 | name. If the first character of the symbol name is the exclamation |
| 1220 | point (!) then the sense of the switch is reversed for that symbol. |
| 1221 | For example: |
| 1222 | |
| 1223 | @smallexample |
| 1224 | -w -W !foo -W fo* |
| 1225 | @end smallexample |
| 1226 | |
| 1227 | would cause objcopy to weaken all symbols that start with ``fo'' |
| 1228 | except for the symbol ``foo''. |
| 1229 | |
| 1230 | @item -x |
| 1231 | @itemx --discard-all |
| 1232 | Do not copy non-global symbols from the source file. |
| 1233 | @c FIXME any reason to prefer "non-global" to "local" here? |
| 1234 | |
| 1235 | @item -X |
| 1236 | @itemx --discard-locals |
| 1237 | Do not copy compiler-generated local symbols. |
| 1238 | (These usually start with @samp{L} or @samp{.}.) |
| 1239 | |
| 1240 | @item -b @var{byte} |
| 1241 | @itemx --byte=@var{byte} |
| 1242 | Keep only every @var{byte}th byte of the input file (header data is not |
| 1243 | affected). @var{byte} can be in the range from 0 to @var{interleave}-1, |
| 1244 | where @var{interleave} is given by the @option{-i} or @option{--interleave} |
| 1245 | option, or the default of 4. This option is useful for creating files |
| 1246 | to program @sc{rom}. It is typically used with an @code{srec} output |
| 1247 | target. |
| 1248 | |
| 1249 | @item -i @var{interleave} |
| 1250 | @itemx --interleave=@var{interleave} |
| 1251 | Only copy one out of every @var{interleave} bytes. Select which byte to |
| 1252 | copy with the @option{-b} or @option{--byte} option. The default is 4. |
| 1253 | @command{objcopy} ignores this option if you do not specify either @option{-b} or |
| 1254 | @option{--byte}. |
| 1255 | |
| 1256 | @item -p |
| 1257 | @itemx --preserve-dates |
| 1258 | Set the access and modification dates of the output file to be the same |
| 1259 | as those of the input file. |
| 1260 | |
| 1261 | @item --debugging |
| 1262 | Convert debugging information, if possible. This is not the default |
| 1263 | because only certain debugging formats are supported, and the |
| 1264 | conversion process can be time consuming. |
| 1265 | |
| 1266 | @item --gap-fill @var{val} |
| 1267 | Fill gaps between sections with @var{val}. This operation applies to |
| 1268 | the @emph{load address} (LMA) of the sections. It is done by increasing |
| 1269 | the size of the section with the lower address, and filling in the extra |
| 1270 | space created with @var{val}. |
| 1271 | |
| 1272 | @item --pad-to @var{address} |
| 1273 | Pad the output file up to the load address @var{address}. This is |
| 1274 | done by increasing the size of the last section. The extra space is |
| 1275 | filled in with the value specified by @option{--gap-fill} (default zero). |
| 1276 | |
| 1277 | @item --set-start @var{val} |
| 1278 | Set the start address of the new file to @var{val}. Not all object file |
| 1279 | formats support setting the start address. |
| 1280 | |
| 1281 | @item --change-start @var{incr} |
| 1282 | @itemx --adjust-start @var{incr} |
| 1283 | @cindex changing start address |
| 1284 | Change the start address by adding @var{incr}. Not all object file |
| 1285 | formats support setting the start address. |
| 1286 | |
| 1287 | @item --change-addresses @var{incr} |
| 1288 | @itemx --adjust-vma @var{incr} |
| 1289 | @cindex changing object addresses |
| 1290 | Change the VMA and LMA addresses of all sections, as well as the start |
| 1291 | address, by adding @var{incr}. Some object file formats do not permit |
| 1292 | section addresses to be changed arbitrarily. Note that this does not |
| 1293 | relocate the sections; if the program expects sections to be loaded at a |
| 1294 | certain address, and this option is used to change the sections such |
| 1295 | that they are loaded at a different address, the program may fail. |
| 1296 | |
| 1297 | @item --change-section-address @var{section}@{=,+,-@}@var{val} |
| 1298 | @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val} |
| 1299 | @cindex changing section address |
| 1300 | Set or change both the VMA address and the LMA address of the named |
| 1301 | @var{section}. If @samp{=} is used, the section address is set to |
| 1302 | @var{val}. Otherwise, @var{val} is added to or subtracted from the |
| 1303 | section address. See the comments under @option{--change-addresses}, |
| 1304 | above. If @var{section} does not exist in the input file, a warning will |
| 1305 | be issued, unless @option{--no-change-warnings} is used. |
| 1306 | |
| 1307 | @item --change-section-lma @var{section}@{=,+,-@}@var{val} |
| 1308 | @cindex changing section LMA |
| 1309 | Set or change the LMA address of the named @var{section}. The LMA |
| 1310 | address is the address where the section will be loaded into memory at |
| 1311 | program load time. Normally this is the same as the VMA address, which |
| 1312 | is the address of the section at program run time, but on some systems, |
| 1313 | especially those where a program is held in ROM, the two can be |
| 1314 | different. If @samp{=} is used, the section address is set to |
| 1315 | @var{val}. Otherwise, @var{val} is added to or subtracted from the |
| 1316 | section address. See the comments under @option{--change-addresses}, |
| 1317 | above. If @var{section} does not exist in the input file, a warning |
| 1318 | will be issued, unless @option{--no-change-warnings} is used. |
| 1319 | |
| 1320 | @item --change-section-vma @var{section}@{=,+,-@}@var{val} |
| 1321 | @cindex changing section VMA |
| 1322 | Set or change the VMA address of the named @var{section}. The VMA |
| 1323 | address is the address where the section will be located once the |
| 1324 | program has started executing. Normally this is the same as the LMA |
| 1325 | address, which is the address where the section will be loaded into |
| 1326 | memory, but on some systems, especially those where a program is held in |
| 1327 | ROM, the two can be different. If @samp{=} is used, the section address |
| 1328 | is set to @var{val}. Otherwise, @var{val} is added to or subtracted |
| 1329 | from the section address. See the comments under |
| 1330 | @option{--change-addresses}, above. If @var{section} does not exist in |
| 1331 | the input file, a warning will be issued, unless |
| 1332 | @option{--no-change-warnings} is used. |
| 1333 | |
| 1334 | @item --change-warnings |
| 1335 | @itemx --adjust-warnings |
| 1336 | If @option{--change-section-address} or @option{--change-section-lma} or |
| 1337 | @option{--change-section-vma} is used, and the named section does not |
| 1338 | exist, issue a warning. This is the default. |
| 1339 | |
| 1340 | @item --no-change-warnings |
| 1341 | @itemx --no-adjust-warnings |
| 1342 | Do not issue a warning if @option{--change-section-address} or |
| 1343 | @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even |
| 1344 | if the named section does not exist. |
| 1345 | |
| 1346 | @item --set-section-flags @var{section}=@var{flags} |
| 1347 | Set the flags for the named section. The @var{flags} argument is a |
| 1348 | comma separated string of flag names. The recognized names are |
| 1349 | @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload}, |
| 1350 | @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and |
| 1351 | @samp{debug}. You can set the @samp{contents} flag for a section which |
| 1352 | does not have contents, but it is not meaningful to clear the |
| 1353 | @samp{contents} flag of a section which does have contents--just remove |
| 1354 | the section instead. Not all flags are meaningful for all object file |
| 1355 | formats. |
| 1356 | |
| 1357 | @item --add-section @var{sectionname}=@var{filename} |
| 1358 | Add a new section named @var{sectionname} while copying the file. The |
| 1359 | contents of the new section are taken from the file @var{filename}. The |
| 1360 | size of the section will be the size of the file. This option only |
| 1361 | works on file formats which can support sections with arbitrary names. |
| 1362 | |
| 1363 | @item --rename-section @var{oldname}=@var{newname}[,@var{flags}] |
| 1364 | Rename a section from @var{oldname} to @var{newname}, optionally |
| 1365 | changing the section's flags to @var{flags} in the process. This has |
| 1366 | the advantage over usng a linker script to perform the rename in that |
| 1367 | the output stays as an object file and does not become a linked |
| 1368 | executable. |
| 1369 | |
| 1370 | This option is particularly helpful when the input format is binary, |
| 1371 | since this will always create a section called .data. If for example, |
| 1372 | you wanted instead to create a section called .rodata containing binary |
| 1373 | data you could use the following command line to achieve it: |
| 1374 | |
| 1375 | @smallexample |
| 1376 | objcopy -I binary -O <output_format> -B <architecture> \ |
| 1377 | --rename-section .data=.rodata,alloc,load,readonly,data,contents \ |
| 1378 | <input_binary_file> <output_object_file> |
| 1379 | @end smallexample |
| 1380 | |
| 1381 | @item --long-section-names @{enable,disable,keep@} |
| 1382 | Controls the handling of long section names when processing @code{COFF} |
| 1383 | and @code{PE-COFF} object formats. The default behaviour, @samp{keep}, |
| 1384 | is to preserve long section names if any are present in the input file. |
| 1385 | The @samp{enable} and @samp{disable} options forcibly enable or disable |
| 1386 | the use of long section names in the output object; when @samp{disable} |
| 1387 | is in effect, any long section names in the input object will be truncated. |
| 1388 | The @samp{enable} option will only emit long section names if any are |
| 1389 | present in the inputs; this is mostly the same as @samp{keep}, but it |
| 1390 | is left undefined whether the @samp{enable} option might force the |
| 1391 | creation of an empty string table in the output file. |
| 1392 | |
| 1393 | @item --change-leading-char |
| 1394 | Some object file formats use special characters at the start of |
| 1395 | symbols. The most common such character is underscore, which compilers |
| 1396 | often add before every symbol. This option tells @command{objcopy} to |
| 1397 | change the leading character of every symbol when it converts between |
| 1398 | object file formats. If the object file formats use the same leading |
| 1399 | character, this option has no effect. Otherwise, it will add a |
| 1400 | character, or remove a character, or change a character, as |
| 1401 | appropriate. |
| 1402 | |
| 1403 | @item --remove-leading-char |
| 1404 | If the first character of a global symbol is a special symbol leading |
| 1405 | character used by the object file format, remove the character. The |
| 1406 | most common symbol leading character is underscore. This option will |
| 1407 | remove a leading underscore from all global symbols. This can be useful |
| 1408 | if you want to link together objects of different file formats with |
| 1409 | different conventions for symbol names. This is different from |
| 1410 | @option{--change-leading-char} because it always changes the symbol name |
| 1411 | when appropriate, regardless of the object file format of the output |
| 1412 | file. |
| 1413 | |
| 1414 | @item --reverse-bytes=@var{num} |
| 1415 | Reverse the bytes in a section with output contents. A section length must |
| 1416 | be evenly divisible by the value given in order for the swap to be able to |
| 1417 | take place. Reversing takes place before the interleaving is performed. |
| 1418 | |
| 1419 | This option is used typically in generating ROM images for problematic |
| 1420 | target systems. For example, on some target boards, the 32-bit words |
| 1421 | fetched from 8-bit ROMs are re-assembled in little-endian byte order |
| 1422 | regardless of the CPU byte order. Depending on the programming model, the |
| 1423 | endianness of the ROM may need to be modified. |
| 1424 | |
| 1425 | Consider a simple file with a section containing the following eight |
| 1426 | bytes: @code{12345678}. |
| 1427 | |
| 1428 | Using @samp{--reverse-bytes=2} for the above example, the bytes in the |
| 1429 | output file would be ordered @code{21436587}. |
| 1430 | |
| 1431 | Using @samp{--reverse-bytes=4} for the above example, the bytes in the |
| 1432 | output file would be ordered @code{43218765}. |
| 1433 | |
| 1434 | By using @samp{--reverse-bytes=2} for the above example, followed by |
| 1435 | @samp{--reverse-bytes=4} on the output file, the bytes in the second |
| 1436 | output file would be ordered @code{34127856}. |
| 1437 | |
| 1438 | @item --srec-len=@var{ival} |
| 1439 | Meaningful only for srec output. Set the maximum length of the Srecords |
| 1440 | being produced to @var{ival}. This length covers both address, data and |
| 1441 | crc fields. |
| 1442 | |
| 1443 | @item --srec-forceS3 |
| 1444 | Meaningful only for srec output. Avoid generation of S1/S2 records, |
| 1445 | creating S3-only record format. |
| 1446 | |
| 1447 | @item --redefine-sym @var{old}=@var{new} |
| 1448 | Change the name of a symbol @var{old}, to @var{new}. This can be useful |
| 1449 | when one is trying link two things together for which you have no |
| 1450 | source, and there are name collisions. |
| 1451 | |
| 1452 | @item --redefine-syms=@var{filename} |
| 1453 | Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}" |
| 1454 | listed in the file @var{filename}. @var{filename} is simply a flat file, |
| 1455 | with one symbol pair per line. Line comments may be introduced by the hash |
| 1456 | character. This option may be given more than once. |
| 1457 | |
| 1458 | @item --weaken |
| 1459 | Change all global symbols in the file to be weak. This can be useful |
| 1460 | when building an object which will be linked against other objects using |
| 1461 | the @option{-R} option to the linker. This option is only effective when |
| 1462 | using an object file format which supports weak symbols. |
| 1463 | |
| 1464 | @item --keep-symbols=@var{filename} |
| 1465 | Apply @option{--keep-symbol} option to each symbol listed in the file |
| 1466 | @var{filename}. @var{filename} is simply a flat file, with one symbol |
| 1467 | name per line. Line comments may be introduced by the hash character. |
| 1468 | This option may be given more than once. |
| 1469 | |
| 1470 | @item --strip-symbols=@var{filename} |
| 1471 | Apply @option{--strip-symbol} option to each symbol listed in the file |
| 1472 | @var{filename}. @var{filename} is simply a flat file, with one symbol |
| 1473 | name per line. Line comments may be introduced by the hash character. |
| 1474 | This option may be given more than once. |
| 1475 | |
| 1476 | @item --strip-unneeded-symbols=@var{filename} |
| 1477 | Apply @option{--strip-unneeded-symbol} option to each symbol listed in |
| 1478 | the file @var{filename}. @var{filename} is simply a flat file, with one |
| 1479 | symbol name per line. Line comments may be introduced by the hash |
| 1480 | character. This option may be given more than once. |
| 1481 | |
| 1482 | @item --keep-global-symbols=@var{filename} |
| 1483 | Apply @option{--keep-global-symbol} option to each symbol listed in the |
| 1484 | file @var{filename}. @var{filename} is simply a flat file, with one |
| 1485 | symbol name per line. Line comments may be introduced by the hash |
| 1486 | character. This option may be given more than once. |
| 1487 | |
| 1488 | @item --localize-symbols=@var{filename} |
| 1489 | Apply @option{--localize-symbol} option to each symbol listed in the file |
| 1490 | @var{filename}. @var{filename} is simply a flat file, with one symbol |
| 1491 | name per line. Line comments may be introduced by the hash character. |
| 1492 | This option may be given more than once. |
| 1493 | |
| 1494 | @item --globalize-symbols=@var{filename} |
| 1495 | Apply @option{--globalize-symbol} option to each symbol listed in the file |
| 1496 | @var{filename}. @var{filename} is simply a flat file, with one symbol |
| 1497 | name per line. Line comments may be introduced by the hash character. |
| 1498 | This option may be given more than once. |
| 1499 | |
| 1500 | @item --weaken-symbols=@var{filename} |
| 1501 | Apply @option{--weaken-symbol} option to each symbol listed in the file |
| 1502 | @var{filename}. @var{filename} is simply a flat file, with one symbol |
| 1503 | name per line. Line comments may be introduced by the hash character. |
| 1504 | This option may be given more than once. |
| 1505 | |
| 1506 | @item --alt-machine-code=@var{index} |
| 1507 | If the output architecture has alternate machine codes, use the |
| 1508 | @var{index}th code instead of the default one. This is useful in case |
| 1509 | a machine is assigned an official code and the tool-chain adopts the |
| 1510 | new code, but other applications still depend on the original code |
| 1511 | being used. For ELF based architectures if the @var{index} |
| 1512 | alternative does not exist then the value is treated as an absolute |
| 1513 | number to be stored in the e_machine field of the ELF header. |
| 1514 | |
| 1515 | @item --writable-text |
| 1516 | Mark the output text as writable. This option isn't meaningful for all |
| 1517 | object file formats. |
| 1518 | |
| 1519 | @item --readonly-text |
| 1520 | Make the output text write protected. This option isn't meaningful for all |
| 1521 | object file formats. |
| 1522 | |
| 1523 | @item --pure |
| 1524 | Mark the output file as demand paged. This option isn't meaningful for all |
| 1525 | object file formats. |
| 1526 | |
| 1527 | @item --impure |
| 1528 | Mark the output file as impure. This option isn't meaningful for all |
| 1529 | object file formats. |
| 1530 | |
| 1531 | @item --prefix-symbols=@var{string} |
| 1532 | Prefix all symbols in the output file with @var{string}. |
| 1533 | |
| 1534 | @item --prefix-sections=@var{string} |
| 1535 | Prefix all section names in the output file with @var{string}. |
| 1536 | |
| 1537 | @item --prefix-alloc-sections=@var{string} |
| 1538 | Prefix all the names of all allocated sections in the output file with |
| 1539 | @var{string}. |
| 1540 | |
| 1541 | @item --add-gnu-debuglink=@var{path-to-file} |
| 1542 | Creates a .gnu_debuglink section which contains a reference to @var{path-to-file} |
| 1543 | and adds it to the output file. |
| 1544 | |
| 1545 | @item --keep-file-symbols |
| 1546 | When stripping a file, perhaps with @option{--strip-debug} or |
| 1547 | @option{--strip-unneeded}, retain any symbols specifying source file names, |
| 1548 | which would otherwise get stripped. |
| 1549 | |
| 1550 | @item --only-keep-debug |
| 1551 | Strip a file, removing contents of any sections that would not be |
| 1552 | stripped by @option{--strip-debug} and leaving the debugging sections |
| 1553 | intact. In ELF files, this preserves all note sections in the output. |
| 1554 | |
| 1555 | The intention is that this option will be used in conjunction with |
| 1556 | @option{--add-gnu-debuglink} to create a two part executable. One a |
| 1557 | stripped binary which will occupy less space in RAM and in a |
| 1558 | distribution and the second a debugging information file which is only |
| 1559 | needed if debugging abilities are required. The suggested procedure |
| 1560 | to create these files is as follows: |
| 1561 | |
| 1562 | @enumerate |
| 1563 | @item Link the executable as normal. Assuming that is is called |
| 1564 | @code{foo} then... |
| 1565 | @item Run @code{objcopy --only-keep-debug foo foo.dbg} to |
| 1566 | create a file containing the debugging info. |
| 1567 | @item Run @code{objcopy --strip-debug foo} to create a |
| 1568 | stripped executable. |
| 1569 | @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo} |
| 1570 | to add a link to the debugging info into the stripped executable. |
| 1571 | @end enumerate |
| 1572 | |
| 1573 | Note---the choice of @code{.dbg} as an extension for the debug info |
| 1574 | file is arbitrary. Also the @code{--only-keep-debug} step is |
| 1575 | optional. You could instead do this: |
| 1576 | |
| 1577 | @enumerate |
| 1578 | @item Link the executable as normal. |
| 1579 | @item Copy @code{foo} to @code{foo.full} |
| 1580 | @item Run @code{objcopy --strip-debug foo} |
| 1581 | @item Run @code{objcopy --add-gnu-debuglink=foo.full foo} |
| 1582 | @end enumerate |
| 1583 | |
| 1584 | i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the |
| 1585 | full executable. It does not have to be a file created by the |
| 1586 | @option{--only-keep-debug} switch. |
| 1587 | |
| 1588 | Note---this switch is only intended for use on fully linked files. It |
| 1589 | does not make sense to use it on object files where the debugging |
| 1590 | information may be incomplete. Besides the gnu_debuglink feature |
| 1591 | currently only supports the presence of one filename containing |
| 1592 | debugging information, not multiple filenames on a one-per-object-file |
| 1593 | basis. |
| 1594 | |
| 1595 | @item --file-alignment @var{num} |
| 1596 | Specify the file alignment. Sections in the file will always begin at |
| 1597 | file offsets which are multiples of this number. This defaults to |
| 1598 | 512. |
| 1599 | [This option is specific to PE targets.] |
| 1600 | |
| 1601 | @item --heap @var{reserve} |
| 1602 | @itemx --heap @var{reserve},@var{commit} |
| 1603 | Specify the number of bytes of memory to reserve (and optionally commit) |
| 1604 | to be used as heap for this program. |
| 1605 | [This option is specific to PE targets.] |
| 1606 | |
| 1607 | @item --image-base @var{value} |
| 1608 | Use @var{value} as the base address of your program or dll. This is |
| 1609 | the lowest memory location that will be used when your program or dll |
| 1610 | is loaded. To reduce the need to relocate and improve performance of |
| 1611 | your dlls, each should have a unique base address and not overlap any |
| 1612 | other dlls. The default is 0x400000 for executables, and 0x10000000 |
| 1613 | for dlls. |
| 1614 | [This option is specific to PE targets.] |
| 1615 | |
| 1616 | @item --section-alignment @var{num} |
| 1617 | Sets the section alignment. Sections in memory will always begin at |
| 1618 | addresses which are a multiple of this number. Defaults to 0x1000. |
| 1619 | [This option is specific to PE targets.] |
| 1620 | |
| 1621 | @item --stack @var{reserve} |
| 1622 | @itemx --stack @var{reserve},@var{commit} |
| 1623 | Specify the number of bytes of memory to reserve (and optionally commit) |
| 1624 | to be used as stack for this program. |
| 1625 | [This option is specific to PE targets.] |
| 1626 | |
| 1627 | @item --subsystem @var{which} |
| 1628 | @itemx --subsystem @var{which}:@var{major} |
| 1629 | @itemx --subsystem @var{which}:@var{major}.@var{minor} |
| 1630 | Specifies the subsystem under which your program will execute. The |
| 1631 | legal values for @var{which} are @code{native}, @code{windows}, |
| 1632 | @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd}, |
| 1633 | @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set |
| 1634 | the subsystem version also. Numeric values are also accepted for |
| 1635 | @var{which}. |
| 1636 | [This option is specific to PE targets.] |
| 1637 | |
| 1638 | @item --extract-symbol |
| 1639 | Keep the file's section flags and symbols but remove all section data. |
| 1640 | Specifically, the option: |
| 1641 | |
| 1642 | @itemize |
| 1643 | @item removes the contents of all sections; |
| 1644 | @item sets the size of every section to zero; and |
| 1645 | @item sets the file's start address to zero. |
| 1646 | @end itemize |
| 1647 | |
| 1648 | This option is used to build a @file{.sym} file for a VxWorks kernel. |
| 1649 | It can also be a useful way of reducing the size of a @option{--just-symbols} |
| 1650 | linker input file. |
| 1651 | |
| 1652 | @item -V |
| 1653 | @itemx --version |
| 1654 | Show the version number of @command{objcopy}. |
| 1655 | |
| 1656 | @item -v |
| 1657 | @itemx --verbose |
| 1658 | Verbose output: list all object files modified. In the case of |
| 1659 | archives, @samp{objcopy -V} lists all members of the archive. |
| 1660 | |
| 1661 | @item --help |
| 1662 | Show a summary of the options to @command{objcopy}. |
| 1663 | |
| 1664 | @item --info |
| 1665 | Display a list showing all architectures and object formats available. |
| 1666 | @end table |
| 1667 | |
| 1668 | @c man end |
| 1669 | |
| 1670 | @ignore |
| 1671 | @c man begin SEEALSO objcopy |
| 1672 | ld(1), objdump(1), and the Info entries for @file{binutils}. |
| 1673 | @c man end |
| 1674 | @end ignore |
| 1675 | |
| 1676 | @node objdump |
| 1677 | @chapter objdump |
| 1678 | |
| 1679 | @cindex object file information |
| 1680 | @kindex objdump |
| 1681 | |
| 1682 | @c man title objdump display information from object files. |
| 1683 | |
| 1684 | @smallexample |
| 1685 | @c man begin SYNOPSIS objdump |
| 1686 | objdump [@option{-a}|@option{--archive-headers}] |
| 1687 | [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}] |
| 1688 | [@option{-C}|@option{--demangle}[=@var{style}] ] |
| 1689 | [@option{-d}|@option{--disassemble}] |
| 1690 | [@option{-D}|@option{--disassemble-all}] |
| 1691 | [@option{-z}|@option{--disassemble-zeroes}] |
| 1692 | [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}] |
| 1693 | [@option{-f}|@option{--file-headers}] |
| 1694 | [@option{-F}|@option{--file-offsets}] |
| 1695 | [@option{--file-start-context}] |
| 1696 | [@option{-g}|@option{--debugging}] |
| 1697 | [@option{-e}|@option{--debugging-tags}] |
| 1698 | [@option{-h}|@option{--section-headers}|@option{--headers}] |
| 1699 | [@option{-i}|@option{--info}] |
| 1700 | [@option{-j} @var{section}|@option{--section=}@var{section}] |
| 1701 | [@option{-l}|@option{--line-numbers}] |
| 1702 | [@option{-S}|@option{--source}] |
| 1703 | [@option{-m} @var{machine}|@option{--architecture=}@var{machine}] |
| 1704 | [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}] |
| 1705 | [@option{-p}|@option{--private-headers}] |
| 1706 | [@option{-r}|@option{--reloc}] |
| 1707 | [@option{-R}|@option{--dynamic-reloc}] |
| 1708 | [@option{-s}|@option{--full-contents}] |
| 1709 | [@option{-W[lLiaprmfFsoRt]}| |
| 1710 | @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges]] |
| 1711 | [@option{-G}|@option{--stabs}] |
| 1712 | [@option{-t}|@option{--syms}] |
| 1713 | [@option{-T}|@option{--dynamic-syms}] |
| 1714 | [@option{-x}|@option{--all-headers}] |
| 1715 | [@option{-w}|@option{--wide}] |
| 1716 | [@option{--start-address=}@var{address}] |
| 1717 | [@option{--stop-address=}@var{address}] |
| 1718 | [@option{--prefix-addresses}] |
| 1719 | [@option{--[no-]show-raw-insn}] |
| 1720 | [@option{--adjust-vma=}@var{offset}] |
| 1721 | [@option{--special-syms}] |
| 1722 | [@option{--prefix=}@var{prefix}] |
| 1723 | [@option{--prefix-strip=}@var{level}] |
| 1724 | [@option{--insn-width=}@var{width}] |
| 1725 | [@option{-V}|@option{--version}] |
| 1726 | [@option{-H}|@option{--help}] |
| 1727 | @var{objfile}@dots{} |
| 1728 | @c man end |
| 1729 | @end smallexample |
| 1730 | |
| 1731 | @c man begin DESCRIPTION objdump |
| 1732 | |
| 1733 | @command{objdump} displays information about one or more object files. |
| 1734 | The options control what particular information to display. This |
| 1735 | information is mostly useful to programmers who are working on the |
| 1736 | compilation tools, as opposed to programmers who just want their |
| 1737 | program to compile and work. |
| 1738 | |
| 1739 | @var{objfile}@dots{} are the object files to be examined. When you |
| 1740 | specify archives, @command{objdump} shows information on each of the member |
| 1741 | object files. |
| 1742 | |
| 1743 | @c man end |
| 1744 | |
| 1745 | @c man begin OPTIONS objdump |
| 1746 | |
| 1747 | The long and short forms of options, shown here as alternatives, are |
| 1748 | equivalent. At least one option from the list |
| 1749 | @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given. |
| 1750 | |
| 1751 | @table @env |
| 1752 | @item -a |
| 1753 | @itemx --archive-header |
| 1754 | @cindex archive headers |
| 1755 | If any of the @var{objfile} files are archives, display the archive |
| 1756 | header information (in a format similar to @samp{ls -l}). Besides the |
| 1757 | information you could list with @samp{ar tv}, @samp{objdump -a} shows |
| 1758 | the object file format of each archive member. |
| 1759 | |
| 1760 | @item --adjust-vma=@var{offset} |
| 1761 | @cindex section addresses in objdump |
| 1762 | @cindex VMA in objdump |
| 1763 | When dumping information, first add @var{offset} to all the section |
| 1764 | addresses. This is useful if the section addresses do not correspond to |
| 1765 | the symbol table, which can happen when putting sections at particular |
| 1766 | addresses when using a format which can not represent section addresses, |
| 1767 | such as a.out. |
| 1768 | |
| 1769 | @item -b @var{bfdname} |
| 1770 | @itemx --target=@var{bfdname} |
| 1771 | @cindex object code format |
| 1772 | Specify that the object-code format for the object files is |
| 1773 | @var{bfdname}. This option may not be necessary; @var{objdump} can |
| 1774 | automatically recognize many formats. |
| 1775 | |
| 1776 | For example, |
| 1777 | @example |
| 1778 | objdump -b oasys -m vax -h fu.o |
| 1779 | @end example |
| 1780 | @noindent |
| 1781 | displays summary information from the section headers (@option{-h}) of |
| 1782 | @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object |
| 1783 | file in the format produced by Oasys compilers. You can list the |
| 1784 | formats available with the @option{-i} option. |
| 1785 | @xref{Target Selection}, for more information. |
| 1786 | |
| 1787 | @item -C |
| 1788 | @itemx --demangle[=@var{style}] |
| 1789 | @cindex demangling in objdump |
| 1790 | Decode (@dfn{demangle}) low-level symbol names into user-level names. |
| 1791 | Besides removing any initial underscore prepended by the system, this |
| 1792 | makes C++ function names readable. Different compilers have different |
| 1793 | mangling styles. The optional demangling style argument can be used to |
| 1794 | choose an appropriate demangling style for your compiler. @xref{c++filt}, |
| 1795 | for more information on demangling. |
| 1796 | |
| 1797 | @item -g |
| 1798 | @itemx --debugging |
| 1799 | Display debugging information. This attempts to parse STABS and IEEE |
| 1800 | debugging format information stored in the file and print it out using |
| 1801 | a C like syntax. If neither of these formats are found this option |
| 1802 | falls back on the @option{-W} option to print any DWARF information in |
| 1803 | the file. |
| 1804 | |
| 1805 | @item -e |
| 1806 | @itemx --debugging-tags |
| 1807 | Like @option{-g}, but the information is generated in a format compatible |
| 1808 | with ctags tool. |
| 1809 | |
| 1810 | @item -d |
| 1811 | @itemx --disassemble |
| 1812 | @cindex disassembling object code |
| 1813 | @cindex machine instructions |
| 1814 | Display the assembler mnemonics for the machine instructions from |
| 1815 | @var{objfile}. This option only disassembles those sections which are |
| 1816 | expected to contain instructions. |
| 1817 | |
| 1818 | @item -D |
| 1819 | @itemx --disassemble-all |
| 1820 | Like @option{-d}, but disassemble the contents of all sections, not just |
| 1821 | those expected to contain instructions. |
| 1822 | |
| 1823 | If the target is an ARM architecture this switch also has the effect |
| 1824 | of forcing the disassembler to decode pieces of data found in code |
| 1825 | sections as if they were instructions. |
| 1826 | |
| 1827 | @item --prefix-addresses |
| 1828 | When disassembling, print the complete address on each line. This is |
| 1829 | the older disassembly format. |
| 1830 | |
| 1831 | @item -EB |
| 1832 | @itemx -EL |
| 1833 | @itemx --endian=@{big|little@} |
| 1834 | @cindex endianness |
| 1835 | @cindex disassembly endianness |
| 1836 | Specify the endianness of the object files. This only affects |
| 1837 | disassembly. This can be useful when disassembling a file format which |
| 1838 | does not describe endianness information, such as S-records. |
| 1839 | |
| 1840 | @item -f |
| 1841 | @itemx --file-headers |
| 1842 | @cindex object file header |
| 1843 | Display summary information from the overall header of |
| 1844 | each of the @var{objfile} files. |
| 1845 | |
| 1846 | @item -F |
| 1847 | @itemx --file-offsets |
| 1848 | @cindex object file offsets |
| 1849 | When disassembling sections, whenever a symbol is displayed, also |
| 1850 | display the file offset of the region of data that is about to be |
| 1851 | dumped. If zeroes are being skipped, then when disassembly resumes, |
| 1852 | tell the user how many zeroes were skipped and the file offset of the |
| 1853 | location from where the disassembly resumes. When dumping sections, |
| 1854 | display the file offset of the location from where the dump starts. |
| 1855 | |
| 1856 | @item --file-start-context |
| 1857 | @cindex source code context |
| 1858 | Specify that when displaying interlisted source code/disassembly |
| 1859 | (assumes @option{-S}) from a file that has not yet been displayed, extend the |
| 1860 | context to the start of the file. |
| 1861 | |
| 1862 | @item -h |
| 1863 | @itemx --section-headers |
| 1864 | @itemx --headers |
| 1865 | @cindex section headers |
| 1866 | Display summary information from the section headers of the |
| 1867 | object file. |
| 1868 | |
| 1869 | File segments may be relocated to nonstandard addresses, for example by |
| 1870 | using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to |
| 1871 | @command{ld}. However, some object file formats, such as a.out, do not |
| 1872 | store the starting address of the file segments. In those situations, |
| 1873 | although @command{ld} relocates the sections correctly, using @samp{objdump |
| 1874 | -h} to list the file section headers cannot show the correct addresses. |
| 1875 | Instead, it shows the usual addresses, which are implicit for the |
| 1876 | target. |
| 1877 | |
| 1878 | @item -H |
| 1879 | @itemx --help |
| 1880 | Print a summary of the options to @command{objdump} and exit. |
| 1881 | |
| 1882 | @item -i |
| 1883 | @itemx --info |
| 1884 | @cindex architectures available |
| 1885 | @cindex object formats available |
| 1886 | Display a list showing all architectures and object formats available |
| 1887 | for specification with @option{-b} or @option{-m}. |
| 1888 | |
| 1889 | @item -j @var{name} |
| 1890 | @itemx --section=@var{name} |
| 1891 | @cindex section information |
| 1892 | Display information only for section @var{name}. |
| 1893 | |
| 1894 | @item -l |
| 1895 | @itemx --line-numbers |
| 1896 | @cindex source filenames for object files |
| 1897 | Label the display (using debugging information) with the filename and |
| 1898 | source line numbers corresponding to the object code or relocs shown. |
| 1899 | Only useful with @option{-d}, @option{-D}, or @option{-r}. |
| 1900 | |
| 1901 | @item -m @var{machine} |
| 1902 | @itemx --architecture=@var{machine} |
| 1903 | @cindex architecture |
| 1904 | @cindex disassembly architecture |
| 1905 | Specify the architecture to use when disassembling object files. This |
| 1906 | can be useful when disassembling object files which do not describe |
| 1907 | architecture information, such as S-records. You can list the available |
| 1908 | architectures with the @option{-i} option. |
| 1909 | |
| 1910 | If the target is an ARM architecture then this switch has an |
| 1911 | additional effect. It restricts the disassembly to only those |
| 1912 | instructions supported by the architecture specified by @var{machine}. |
| 1913 | If it is necessary to use this switch because the input file does not |
| 1914 | contain any architecture information, but it is also desired to |
| 1915 | disassemble all the instructions use @option{-marm}. |
| 1916 | |
| 1917 | @item -M @var{options} |
| 1918 | @itemx --disassembler-options=@var{options} |
| 1919 | Pass target specific information to the disassembler. Only supported on |
| 1920 | some targets. If it is necessary to specify more than one |
| 1921 | disassembler option then multiple @option{-M} options can be used or |
| 1922 | can be placed together into a comma separated list. |
| 1923 | |
| 1924 | If the target is an ARM architecture then this switch can be used to |
| 1925 | select which register name set is used during disassembler. Specifying |
| 1926 | @option{-M reg-names-std} (the default) will select the register names as |
| 1927 | used in ARM's instruction set documentation, but with register 13 called |
| 1928 | 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying |
| 1929 | @option{-M reg-names-apcs} will select the name set used by the ARM |
| 1930 | Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will |
| 1931 | just use @samp{r} followed by the register number. |
| 1932 | |
| 1933 | There are also two variants on the APCS register naming scheme enabled |
| 1934 | by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which |
| 1935 | use the ARM/Thumb Procedure Call Standard naming conventions. (Either |
| 1936 | with the normal register names or the special register names). |
| 1937 | |
| 1938 | This option can also be used for ARM architectures to force the |
| 1939 | disassembler to interpret all instructions as Thumb instructions by |
| 1940 | using the switch @option{--disassembler-options=force-thumb}. This can be |
| 1941 | useful when attempting to disassemble thumb code produced by other |
| 1942 | compilers. |
| 1943 | |
| 1944 | For the x86, some of the options duplicate functions of the @option{-m} |
| 1945 | switch, but allow finer grained control. Multiple selections from the |
| 1946 | following may be specified as a comma separated string. |
| 1947 | @option{x86-64}, @option{i386} and @option{i8086} select disassembly for |
| 1948 | the given architecture. @option{intel} and @option{att} select between |
| 1949 | intel syntax mode and AT&T syntax mode. |
| 1950 | @option{intel-mnemonic} and @option{att-mnemonic} select between |
| 1951 | intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic} |
| 1952 | implies @option{intel} and @option{att-mnemonic} implies @option{att}. |
| 1953 | @option{addr64}, @option{addr32}, |
| 1954 | @option{addr16}, @option{data32} and @option{data16} specify the default |
| 1955 | address size and operand size. These four options will be overridden if |
| 1956 | @option{x86-64}, @option{i386} or @option{i8086} appear later in the |
| 1957 | option string. Lastly, @option{suffix}, when in AT&T mode, |
| 1958 | instructs the disassembler to print a mnemonic suffix even when the |
| 1959 | suffix could be inferred by the operands. |
| 1960 | |
| 1961 | For PowerPC, @option{booke} controls the disassembly of BookE |
| 1962 | instructions. @option{32} and @option{64} select PowerPC and |
| 1963 | PowerPC64 disassembly, respectively. @option{e300} selects |
| 1964 | disassembly for the e300 family. @option{440} selects disassembly for |
| 1965 | the PowerPC 440. @option{ppcps} selects disassembly for the paired |
| 1966 | single instructions of the PPC750CL. |
| 1967 | |
| 1968 | For MIPS, this option controls the printing of instruction mnemonic |
| 1969 | names and register names in disassembled instructions. Multiple |
| 1970 | selections from the following may be specified as a comma separated |
| 1971 | string, and invalid options are ignored: |
| 1972 | |
| 1973 | @table @code |
| 1974 | @item no-aliases |
| 1975 | Print the 'raw' instruction mnemonic instead of some pseudo |
| 1976 | instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move', |
| 1977 | 'sll' instead of 'nop', etc. |
| 1978 | |
| 1979 | @item gpr-names=@var{ABI} |
| 1980 | Print GPR (general-purpose register) names as appropriate |
| 1981 | for the specified ABI. By default, GPR names are selected according to |
| 1982 | the ABI of the binary being disassembled. |
| 1983 | |
| 1984 | @item fpr-names=@var{ABI} |
| 1985 | Print FPR (floating-point register) names as |
| 1986 | appropriate for the specified ABI. By default, FPR numbers are printed |
| 1987 | rather than names. |
| 1988 | |
| 1989 | @item cp0-names=@var{ARCH} |
| 1990 | Print CP0 (system control coprocessor; coprocessor 0) register names |
| 1991 | as appropriate for the CPU or architecture specified by |
| 1992 | @var{ARCH}. By default, CP0 register names are selected according to |
| 1993 | the architecture and CPU of the binary being disassembled. |
| 1994 | |
| 1995 | @item hwr-names=@var{ARCH} |
| 1996 | Print HWR (hardware register, used by the @code{rdhwr} instruction) names |
| 1997 | as appropriate for the CPU or architecture specified by |
| 1998 | @var{ARCH}. By default, HWR names are selected according to |
| 1999 | the architecture and CPU of the binary being disassembled. |
| 2000 | |
| 2001 | @item reg-names=@var{ABI} |
| 2002 | Print GPR and FPR names as appropriate for the selected ABI. |
| 2003 | |
| 2004 | @item reg-names=@var{ARCH} |
| 2005 | Print CPU-specific register names (CP0 register and HWR names) |
| 2006 | as appropriate for the selected CPU or architecture. |
| 2007 | @end table |
| 2008 | |
| 2009 | For any of the options listed above, @var{ABI} or |
| 2010 | @var{ARCH} may be specified as @samp{numeric} to have numbers printed |
| 2011 | rather than names, for the selected types of registers. |
| 2012 | You can list the available values of @var{ABI} and @var{ARCH} using |
| 2013 | the @option{--help} option. |
| 2014 | |
| 2015 | For VAX, you can specify function entry addresses with @option{-M |
| 2016 | entry:0xf00ba}. You can use this multiple times to properly |
| 2017 | disassemble VAX binary files that don't contain symbol tables (like |
| 2018 | ROM dumps). In these cases, the function entry mask would otherwise |
| 2019 | be decoded as VAX instructions, which would probably lead the rest |
| 2020 | of the function being wrongly disassembled. |
| 2021 | |
| 2022 | @item -p |
| 2023 | @itemx --private-headers |
| 2024 | Print information that is specific to the object file format. The exact |
| 2025 | information printed depends upon the object file format. For some |
| 2026 | object file formats, no additional information is printed. |
| 2027 | |
| 2028 | @item -r |
| 2029 | @itemx --reloc |
| 2030 | @cindex relocation entries, in object file |
| 2031 | Print the relocation entries of the file. If used with @option{-d} or |
| 2032 | @option{-D}, the relocations are printed interspersed with the |
| 2033 | disassembly. |
| 2034 | |
| 2035 | @item -R |
| 2036 | @itemx --dynamic-reloc |
| 2037 | @cindex dynamic relocation entries, in object file |
| 2038 | Print the dynamic relocation entries of the file. This is only |
| 2039 | meaningful for dynamic objects, such as certain types of shared |
| 2040 | libraries. As for @option{-r}, if used with @option{-d} or |
| 2041 | @option{-D}, the relocations are printed interspersed with the |
| 2042 | disassembly. |
| 2043 | |
| 2044 | @item -s |
| 2045 | @itemx --full-contents |
| 2046 | @cindex sections, full contents |
| 2047 | @cindex object file sections |
| 2048 | Display the full contents of any sections requested. By default all |
| 2049 | non-empty sections are displayed. |
| 2050 | |
| 2051 | @item -S |
| 2052 | @itemx --source |
| 2053 | @cindex source disassembly |
| 2054 | @cindex disassembly, with source |
| 2055 | Display source code intermixed with disassembly, if possible. Implies |
| 2056 | @option{-d}. |
| 2057 | |
| 2058 | @item --prefix=@var{prefix} |
| 2059 | @cindex Add prefix to absolute paths |
| 2060 | Specify @var{prefix} to add to the absolute paths when used with |
| 2061 | @option{-S}. |
| 2062 | |
| 2063 | @item --prefix-strip=@var{level} |
| 2064 | @cindex Strip absolute paths |
| 2065 | Indicate how many initial directory names to strip off the hardwired |
| 2066 | absolute paths. It has no effect without @option{--prefix=}@var{prefix}. |
| 2067 | |
| 2068 | @item --show-raw-insn |
| 2069 | When disassembling instructions, print the instruction in hex as well as |
| 2070 | in symbolic form. This is the default except when |
| 2071 | @option{--prefix-addresses} is used. |
| 2072 | |
| 2073 | @item --no-show-raw-insn |
| 2074 | When disassembling instructions, do not print the instruction bytes. |
| 2075 | This is the default when @option{--prefix-addresses} is used. |
| 2076 | |
| 2077 | @item --insn-width=@var{width} |
| 2078 | @cindex Instruction width |
| 2079 | Display @var{width} bytes on a single line when disassembling |
| 2080 | instructions. |
| 2081 | |
| 2082 | @item -W[lLiaprmfFsoRt] |
| 2083 | @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges] |
| 2084 | @cindex DWARF |
| 2085 | @cindex debug symbols |
| 2086 | Displays the contents of the debug sections in the file, if any are |
| 2087 | present. If one of the optional letters or words follows the switch |
| 2088 | then only data found in those specific sections will be dumped. |
| 2089 | |
| 2090 | Note that there is no single letter option to display the content of |
| 2091 | trace sections. |
| 2092 | |
| 2093 | @item -G |
| 2094 | @itemx --stabs |
| 2095 | @cindex stab |
| 2096 | @cindex .stab |
| 2097 | @cindex debug symbols |
| 2098 | @cindex ELF object file format |
| 2099 | Display the full contents of any sections requested. Display the |
| 2100 | contents of the .stab and .stab.index and .stab.excl sections from an |
| 2101 | ELF file. This is only useful on systems (such as Solaris 2.0) in which |
| 2102 | @code{.stab} debugging symbol-table entries are carried in an ELF |
| 2103 | section. In most other file formats, debugging symbol-table entries are |
| 2104 | interleaved with linkage symbols, and are visible in the @option{--syms} |
| 2105 | output. |
| 2106 | @ifclear man |
| 2107 | For more information on stabs symbols, see @ref{Top,Stabs,Stabs |
| 2108 | Overview,stabs.info, The ``stabs'' debug format}. |
| 2109 | @end ifclear |
| 2110 | |
| 2111 | @item --start-address=@var{address} |
| 2112 | @cindex start-address |
| 2113 | Start displaying data at the specified address. This affects the output |
| 2114 | of the @option{-d}, @option{-r} and @option{-s} options. |
| 2115 | |
| 2116 | @item --stop-address=@var{address} |
| 2117 | @cindex stop-address |
| 2118 | Stop displaying data at the specified address. This affects the output |
| 2119 | of the @option{-d}, @option{-r} and @option{-s} options. |
| 2120 | |
| 2121 | @item -t |
| 2122 | @itemx --syms |
| 2123 | @cindex symbol table entries, printing |
| 2124 | Print the symbol table entries of the file. |
| 2125 | This is similar to the information provided by the @samp{nm} program, |
| 2126 | although the display format is different. The format of the output |
| 2127 | depends upon the format of the file being dumped, but there are two main |
| 2128 | types. One looks like this: |
| 2129 | |
| 2130 | @smallexample |
| 2131 | [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss |
| 2132 | [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred |
| 2133 | @end smallexample |
| 2134 | |
| 2135 | where the number inside the square brackets is the number of the entry |
| 2136 | in the symbol table, the @var{sec} number is the section number, the |
| 2137 | @var{fl} value are the symbol's flag bits, the @var{ty} number is the |
| 2138 | symbol's type, the @var{scl} number is the symbol's storage class and |
| 2139 | the @var{nx} value is the number of auxilary entries associated with |
| 2140 | the symbol. The last two fields are the symbol's value and its name. |
| 2141 | |
| 2142 | The other common output format, usually seen with ELF based files, |
| 2143 | looks like this: |
| 2144 | |
| 2145 | @smallexample |
| 2146 | 00000000 l d .bss 00000000 .bss |
| 2147 | 00000000 g .text 00000000 fred |
| 2148 | @end smallexample |
| 2149 | |
| 2150 | Here the first number is the symbol's value (sometimes refered to as |
| 2151 | its address). The next field is actually a set of characters and |
| 2152 | spaces indicating the flag bits that are set on the symbol. These |
| 2153 | characters are described below. Next is the section with which the |
| 2154 | symbol is associated or @emph{*ABS*} if the section is absolute (ie |
| 2155 | not connected with any section), or @emph{*UND*} if the section is |
| 2156 | referenced in the file being dumped, but not defined there. |
| 2157 | |
| 2158 | After the section name comes another field, a number, which for common |
| 2159 | symbols is the alignment and for other symbol is the size. Finally |
| 2160 | the symbol's name is displayed. |
| 2161 | |
| 2162 | The flag characters are divided into 7 groups as follows: |
| 2163 | @table @code |
| 2164 | @item l |
| 2165 | @itemx g |
| 2166 | @itemx u |
| 2167 | @itemx ! |
| 2168 | The symbol is a local (l), global (g), unique global (u), neither |
| 2169 | global nor local (a space) or both global and local (!). A |
| 2170 | symbol can be neither local or global for a variety of reasons, e.g., |
| 2171 | because it is used for debugging, but it is probably an indication of |
| 2172 | a bug if it is ever both local and global. Unique global symbols are |
| 2173 | a GNU extension to the standard set of ELF symbol bindings. For such |
| 2174 | a symbol the dynamic linker will make sure that in the entire process |
| 2175 | there is just one symbol with this name and type in use. |
| 2176 | |
| 2177 | @item w |
| 2178 | The symbol is weak (w) or strong (a space). |
| 2179 | |
| 2180 | @item C |
| 2181 | The symbol denotes a constructor (C) or an ordinary symbol (a space). |
| 2182 | |
| 2183 | @item W |
| 2184 | The symbol is a warning (W) or a normal symbol (a space). A warning |
| 2185 | symbol's name is a message to be displayed if the symbol following the |
| 2186 | warning symbol is ever referenced. |
| 2187 | |
| 2188 | @item I |
| 2189 | @item i |
| 2190 | The symbol is an indirect reference to another symbol (I), a function |
| 2191 | to be evaluated during reloc processing (i) or a normal symbol (a |
| 2192 | space). |
| 2193 | |
| 2194 | @item d |
| 2195 | @itemx D |
| 2196 | The symbol is a debugging symbol (d) or a dynamic symbol (D) or a |
| 2197 | normal symbol (a space). |
| 2198 | |
| 2199 | @item F |
| 2200 | @item f |
| 2201 | @item O |
| 2202 | The symbol is the name of a function (F) or a file (f) or an object |
| 2203 | (O) or just a normal symbol (a space). |
| 2204 | @end table |
| 2205 | |
| 2206 | @item -T |
| 2207 | @itemx --dynamic-syms |
| 2208 | @cindex dynamic symbol table entries, printing |
| 2209 | Print the dynamic symbol table entries of the file. This is only |
| 2210 | meaningful for dynamic objects, such as certain types of shared |
| 2211 | libraries. This is similar to the information provided by the @samp{nm} |
| 2212 | program when given the @option{-D} (@option{--dynamic}) option. |
| 2213 | |
| 2214 | @item --special-syms |
| 2215 | When displaying symbols include those which the target considers to be |
| 2216 | special in some way and which would not normally be of interest to the |
| 2217 | user. |
| 2218 | |
| 2219 | @item -V |
| 2220 | @itemx --version |
| 2221 | Print the version number of @command{objdump} and exit. |
| 2222 | |
| 2223 | @item -x |
| 2224 | @itemx --all-headers |
| 2225 | @cindex all header information, object file |
| 2226 | @cindex header information, all |
| 2227 | Display all available header information, including the symbol table and |
| 2228 | relocation entries. Using @option{-x} is equivalent to specifying all of |
| 2229 | @option{-a -f -h -p -r -t}. |
| 2230 | |
| 2231 | @item -w |
| 2232 | @itemx --wide |
| 2233 | @cindex wide output, printing |
| 2234 | Format some lines for output devices that have more than 80 columns. |
| 2235 | Also do not truncate symbol names when they are displayed. |
| 2236 | |
| 2237 | @item -z |
| 2238 | @itemx --disassemble-zeroes |
| 2239 | Normally the disassembly output will skip blocks of zeroes. This |
| 2240 | option directs the disassembler to disassemble those blocks, just like |
| 2241 | any other data. |
| 2242 | @end table |
| 2243 | |
| 2244 | @c man end |
| 2245 | |
| 2246 | @ignore |
| 2247 | @c man begin SEEALSO objdump |
| 2248 | nm(1), readelf(1), and the Info entries for @file{binutils}. |
| 2249 | @c man end |
| 2250 | @end ignore |
| 2251 | |
| 2252 | @node ranlib |
| 2253 | @chapter ranlib |
| 2254 | |
| 2255 | @kindex ranlib |
| 2256 | @cindex archive contents |
| 2257 | @cindex symbol index |
| 2258 | |
| 2259 | @c man title ranlib generate index to archive. |
| 2260 | |
| 2261 | @smallexample |
| 2262 | @c man begin SYNOPSIS ranlib |
| 2263 | ranlib [@option{-vVt}] @var{archive} |
| 2264 | @c man end |
| 2265 | @end smallexample |
| 2266 | |
| 2267 | @c man begin DESCRIPTION ranlib |
| 2268 | |
| 2269 | @command{ranlib} generates an index to the contents of an archive and |
| 2270 | stores it in the archive. The index lists each symbol defined by a |
| 2271 | member of an archive that is a relocatable object file. |
| 2272 | |
| 2273 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index. |
| 2274 | |
| 2275 | An archive with such an index speeds up linking to the library and |
| 2276 | allows routines in the library to call each other without regard to |
| 2277 | their placement in the archive. |
| 2278 | |
| 2279 | The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running |
| 2280 | @command{ranlib} is completely equivalent to executing @samp{ar -s}. |
| 2281 | @xref{ar}. |
| 2282 | |
| 2283 | @c man end |
| 2284 | |
| 2285 | @c man begin OPTIONS ranlib |
| 2286 | |
| 2287 | @table @env |
| 2288 | @item -v |
| 2289 | @itemx -V |
| 2290 | @itemx --version |
| 2291 | Show the version number of @command{ranlib}. |
| 2292 | |
| 2293 | @item -t |
| 2294 | Update the timestamp of the symbol map of an archive. |
| 2295 | @end table |
| 2296 | |
| 2297 | @c man end |
| 2298 | |
| 2299 | @ignore |
| 2300 | @c man begin SEEALSO ranlib |
| 2301 | ar(1), nm(1), and the Info entries for @file{binutils}. |
| 2302 | @c man end |
| 2303 | @end ignore |
| 2304 | |
| 2305 | @node size |
| 2306 | @chapter size |
| 2307 | |
| 2308 | @kindex size |
| 2309 | @cindex section sizes |
| 2310 | |
| 2311 | @c man title size list section sizes and total size. |
| 2312 | |
| 2313 | @smallexample |
| 2314 | @c man begin SYNOPSIS size |
| 2315 | size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}] |
| 2316 | [@option{--help}] |
| 2317 | [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}] |
| 2318 | [@option{--common}] |
| 2319 | [@option{-t}|@option{--totals}] |
| 2320 | [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}] |
| 2321 | [@var{objfile}@dots{}] |
| 2322 | @c man end |
| 2323 | @end smallexample |
| 2324 | |
| 2325 | @c man begin DESCRIPTION size |
| 2326 | |
| 2327 | The @sc{gnu} @command{size} utility lists the section sizes---and the total |
| 2328 | size---for each of the object or archive files @var{objfile} in its |
| 2329 | argument list. By default, one line of output is generated for each |
| 2330 | object file or each module in an archive. |
| 2331 | |
| 2332 | @var{objfile}@dots{} are the object files to be examined. |
| 2333 | If none are specified, the file @code{a.out} will be used. |
| 2334 | |
| 2335 | @c man end |
| 2336 | |
| 2337 | @c man begin OPTIONS size |
| 2338 | |
| 2339 | The command line options have the following meanings: |
| 2340 | |
| 2341 | @table @env |
| 2342 | @item -A |
| 2343 | @itemx -B |
| 2344 | @itemx --format=@var{compatibility} |
| 2345 | @cindex @command{size} display format |
| 2346 | Using one of these options, you can choose whether the output from @sc{gnu} |
| 2347 | @command{size} resembles output from System V @command{size} (using @option{-A}, |
| 2348 | or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or |
| 2349 | @option{--format=berkeley}). The default is the one-line format similar to |
| 2350 | Berkeley's. |
| 2351 | @c Bonus for doc-source readers: you can also say --format=strange (or |
| 2352 | @c anything else that starts with 's') for sysv, and --format=boring (or |
| 2353 | @c anything else that starts with 'b') for Berkeley. |
| 2354 | |
| 2355 | Here is an example of the Berkeley (default) format of output from |
| 2356 | @command{size}: |
| 2357 | @smallexample |
| 2358 | $ size --format=Berkeley ranlib size |
| 2359 | text data bss dec hex filename |
| 2360 | 294880 81920 11592 388392 5ed28 ranlib |
| 2361 | 294880 81920 11888 388688 5ee50 size |
| 2362 | @end smallexample |
| 2363 | |
| 2364 | @noindent |
| 2365 | This is the same data, but displayed closer to System V conventions: |
| 2366 | |
| 2367 | @smallexample |
| 2368 | $ size --format=SysV ranlib size |
| 2369 | ranlib : |
| 2370 | section size addr |
| 2371 | .text 294880 8192 |
| 2372 | .data 81920 303104 |
| 2373 | .bss 11592 385024 |
| 2374 | Total 388392 |
| 2375 | |
| 2376 | |
| 2377 | size : |
| 2378 | section size addr |
| 2379 | .text 294880 8192 |
| 2380 | .data 81920 303104 |
| 2381 | .bss 11888 385024 |
| 2382 | Total 388688 |
| 2383 | @end smallexample |
| 2384 | |
| 2385 | @item --help |
| 2386 | Show a summary of acceptable arguments and options. |
| 2387 | |
| 2388 | @item -d |
| 2389 | @itemx -o |
| 2390 | @itemx -x |
| 2391 | @itemx --radix=@var{number} |
| 2392 | @cindex @command{size} number format |
| 2393 | @cindex radix for section sizes |
| 2394 | Using one of these options, you can control whether the size of each |
| 2395 | section is given in decimal (@option{-d}, or @option{--radix=10}); octal |
| 2396 | (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or |
| 2397 | @option{--radix=16}). In @option{--radix=@var{number}}, only the three |
| 2398 | values (8, 10, 16) are supported. The total size is always given in two |
| 2399 | radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or |
| 2400 | octal and hexadecimal if you're using @option{-o}. |
| 2401 | |
| 2402 | @item --common |
| 2403 | Print total size of common symbols in each file. When using Berkeley |
| 2404 | format these are included in the bss size. |
| 2405 | |
| 2406 | @item -t |
| 2407 | @itemx --totals |
| 2408 | Show totals of all objects listed (Berkeley format listing mode only). |
| 2409 | |
| 2410 | @item --target=@var{bfdname} |
| 2411 | @cindex object code format |
| 2412 | Specify that the object-code format for @var{objfile} is |
| 2413 | @var{bfdname}. This option may not be necessary; @command{size} can |
| 2414 | automatically recognize many formats. |
| 2415 | @xref{Target Selection}, for more information. |
| 2416 | |
| 2417 | @item -V |
| 2418 | @itemx --version |
| 2419 | Display the version number of @command{size}. |
| 2420 | @end table |
| 2421 | |
| 2422 | @c man end |
| 2423 | |
| 2424 | @ignore |
| 2425 | @c man begin SEEALSO size |
| 2426 | ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}. |
| 2427 | @c man end |
| 2428 | @end ignore |
| 2429 | |
| 2430 | @node strings |
| 2431 | @chapter strings |
| 2432 | @kindex strings |
| 2433 | @cindex listings strings |
| 2434 | @cindex printing strings |
| 2435 | @cindex strings, printing |
| 2436 | |
| 2437 | @c man title strings print the strings of printable characters in files. |
| 2438 | |
| 2439 | @smallexample |
| 2440 | @c man begin SYNOPSIS strings |
| 2441 | strings [@option{-afovV}] [@option{-}@var{min-len}] |
| 2442 | [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}] |
| 2443 | [@option{-t} @var{radix}] [@option{--radix=}@var{radix}] |
| 2444 | [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}] |
| 2445 | [@option{-}] [@option{--all}] [@option{--print-file-name}] |
| 2446 | [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}] |
| 2447 | [@option{--help}] [@option{--version}] @var{file}@dots{} |
| 2448 | @c man end |
| 2449 | @end smallexample |
| 2450 | |
| 2451 | @c man begin DESCRIPTION strings |
| 2452 | |
| 2453 | For each @var{file} given, @sc{gnu} @command{strings} prints the printable |
| 2454 | character sequences that are at least 4 characters long (or the number |
| 2455 | given with the options below) and are followed by an unprintable |
| 2456 | character. By default, it only prints the strings from the initialized |
| 2457 | and loaded sections of object files; for other types of files, it prints |
| 2458 | the strings from the whole file. |
| 2459 | |
| 2460 | @command{strings} is mainly useful for determining the contents of non-text |
| 2461 | files. |
| 2462 | |
| 2463 | @c man end |
| 2464 | |
| 2465 | @c man begin OPTIONS strings |
| 2466 | |
| 2467 | @table @env |
| 2468 | @item -a |
| 2469 | @itemx --all |
| 2470 | @itemx - |
| 2471 | Do not scan only the initialized and loaded sections of object files; |
| 2472 | scan the whole files. |
| 2473 | |
| 2474 | @item -f |
| 2475 | @itemx --print-file-name |
| 2476 | Print the name of the file before each string. |
| 2477 | |
| 2478 | @item --help |
| 2479 | Print a summary of the program usage on the standard output and exit. |
| 2480 | |
| 2481 | @item -@var{min-len} |
| 2482 | @itemx -n @var{min-len} |
| 2483 | @itemx --bytes=@var{min-len} |
| 2484 | Print sequences of characters that are at least @var{min-len} characters |
| 2485 | long, instead of the default 4. |
| 2486 | |
| 2487 | @item -o |
| 2488 | Like @samp{-t o}. Some other versions of @command{strings} have @option{-o} |
| 2489 | act like @samp{-t d} instead. Since we can not be compatible with both |
| 2490 | ways, we simply chose one. |
| 2491 | |
| 2492 | @item -t @var{radix} |
| 2493 | @itemx --radix=@var{radix} |
| 2494 | Print the offset within the file before each string. The single |
| 2495 | character argument specifies the radix of the offset---@samp{o} for |
| 2496 | octal, @samp{x} for hexadecimal, or @samp{d} for decimal. |
| 2497 | |
| 2498 | @item -e @var{encoding} |
| 2499 | @itemx --encoding=@var{encoding} |
| 2500 | Select the character encoding of the strings that are to be found. |
| 2501 | Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte |
| 2502 | characters (ASCII, ISO 8859, etc., default), @samp{S} = |
| 2503 | single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} = |
| 2504 | 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit |
| 2505 | littleendian. Useful for finding wide character strings. (@samp{l} |
| 2506 | and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings). |
| 2507 | |
| 2508 | @item -T @var{bfdname} |
| 2509 | @itemx --target=@var{bfdname} |
| 2510 | @cindex object code format |
| 2511 | Specify an object code format other than your system's default format. |
| 2512 | @xref{Target Selection}, for more information. |
| 2513 | |
| 2514 | @item -v |
| 2515 | @itemx -V |
| 2516 | @itemx --version |
| 2517 | Print the program version number on the standard output and exit. |
| 2518 | @end table |
| 2519 | |
| 2520 | @c man end |
| 2521 | |
| 2522 | @ignore |
| 2523 | @c man begin SEEALSO strings |
| 2524 | ar(1), nm(1), objdump(1), ranlib(1), readelf(1) |
| 2525 | and the Info entries for @file{binutils}. |
| 2526 | @c man end |
| 2527 | @end ignore |
| 2528 | |
| 2529 | @node strip |
| 2530 | @chapter strip |
| 2531 | |
| 2532 | @kindex strip |
| 2533 | @cindex removing symbols |
| 2534 | @cindex discarding symbols |
| 2535 | @cindex symbols, discarding |
| 2536 | |
| 2537 | @c man title strip Discard symbols from object files. |
| 2538 | |
| 2539 | @smallexample |
| 2540 | @c man begin SYNOPSIS strip |
| 2541 | strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}] |
| 2542 | [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}] |
| 2543 | [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}] |
| 2544 | [@option{-s}|@option{--strip-all}] |
| 2545 | [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}] |
| 2546 | [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}] |
| 2547 | [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}] |
| 2548 | [@option{-w}|@option{--wildcard}] |
| 2549 | [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}] |
| 2550 | [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}] |
| 2551 | [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}] |
| 2552 | [@option{--keep-file-symbols}] |
| 2553 | [@option{--only-keep-debug}] |
| 2554 | [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}] |
| 2555 | [@option{--help}] [@option{--info}] |
| 2556 | @var{objfile}@dots{} |
| 2557 | @c man end |
| 2558 | @end smallexample |
| 2559 | |
| 2560 | @c man begin DESCRIPTION strip |
| 2561 | |
| 2562 | @sc{gnu} @command{strip} discards all symbols from object files |
| 2563 | @var{objfile}. The list of object files may include archives. |
| 2564 | At least one object file must be given. |
| 2565 | |
| 2566 | @command{strip} modifies the files named in its argument, |
| 2567 | rather than writing modified copies under different names. |
| 2568 | |
| 2569 | @c man end |
| 2570 | |
| 2571 | @c man begin OPTIONS strip |
| 2572 | |
| 2573 | @table @env |
| 2574 | @item -F @var{bfdname} |
| 2575 | @itemx --target=@var{bfdname} |
| 2576 | Treat the original @var{objfile} as a file with the object |
| 2577 | code format @var{bfdname}, and rewrite it in the same format. |
| 2578 | @xref{Target Selection}, for more information. |
| 2579 | |
| 2580 | @item --help |
| 2581 | Show a summary of the options to @command{strip} and exit. |
| 2582 | |
| 2583 | @item --info |
| 2584 | Display a list showing all architectures and object formats available. |
| 2585 | |
| 2586 | @item -I @var{bfdname} |
| 2587 | @itemx --input-target=@var{bfdname} |
| 2588 | Treat the original @var{objfile} as a file with the object |
| 2589 | code format @var{bfdname}. |
| 2590 | @xref{Target Selection}, for more information. |
| 2591 | |
| 2592 | @item -O @var{bfdname} |
| 2593 | @itemx --output-target=@var{bfdname} |
| 2594 | Replace @var{objfile} with a file in the output format @var{bfdname}. |
| 2595 | @xref{Target Selection}, for more information. |
| 2596 | |
| 2597 | @item -R @var{sectionname} |
| 2598 | @itemx --remove-section=@var{sectionname} |
| 2599 | Remove any section named @var{sectionname} from the output file. This |
| 2600 | option may be given more than once. Note that using this option |
| 2601 | inappropriately may make the output file unusable. |
| 2602 | |
| 2603 | @item -s |
| 2604 | @itemx --strip-all |
| 2605 | Remove all symbols. |
| 2606 | |
| 2607 | @item -g |
| 2608 | @itemx -S |
| 2609 | @itemx -d |
| 2610 | @itemx --strip-debug |
| 2611 | Remove debugging symbols only. |
| 2612 | |
| 2613 | @item --strip-unneeded |
| 2614 | Remove all symbols that are not needed for relocation processing. |
| 2615 | |
| 2616 | @item -K @var{symbolname} |
| 2617 | @itemx --keep-symbol=@var{symbolname} |
| 2618 | When stripping symbols, keep symbol @var{symbolname} even if it would |
| 2619 | normally be stripped. This option may be given more than once. |
| 2620 | |
| 2621 | @item -N @var{symbolname} |
| 2622 | @itemx --strip-symbol=@var{symbolname} |
| 2623 | Remove symbol @var{symbolname} from the source file. This option may be |
| 2624 | given more than once, and may be combined with strip options other than |
| 2625 | @option{-K}. |
| 2626 | |
| 2627 | @item -o @var{file} |
| 2628 | Put the stripped output in @var{file}, rather than replacing the |
| 2629 | existing file. When this argument is used, only one @var{objfile} |
| 2630 | argument may be specified. |
| 2631 | |
| 2632 | @item -p |
| 2633 | @itemx --preserve-dates |
| 2634 | Preserve the access and modification dates of the file. |
| 2635 | |
| 2636 | @item -w |
| 2637 | @itemx --wildcard |
| 2638 | Permit regular expressions in @var{symbolname}s used in other command |
| 2639 | line options. The question mark (?), asterisk (*), backslash (\) and |
| 2640 | square brackets ([]) operators can be used anywhere in the symbol |
| 2641 | name. If the first character of the symbol name is the exclamation |
| 2642 | point (!) then the sense of the switch is reversed for that symbol. |
| 2643 | For example: |
| 2644 | |
| 2645 | @smallexample |
| 2646 | -w -K !foo -K fo* |
| 2647 | @end smallexample |
| 2648 | |
| 2649 | would cause strip to only keep symbols that start with the letters |
| 2650 | ``fo'', but to discard the symbol ``foo''. |
| 2651 | |
| 2652 | @item -x |
| 2653 | @itemx --discard-all |
| 2654 | Remove non-global symbols. |
| 2655 | |
| 2656 | @item -X |
| 2657 | @itemx --discard-locals |
| 2658 | Remove compiler-generated local symbols. |
| 2659 | (These usually start with @samp{L} or @samp{.}.) |
| 2660 | |
| 2661 | @item --keep-file-symbols |
| 2662 | When stripping a file, perhaps with @option{--strip-debug} or |
| 2663 | @option{--strip-unneeded}, retain any symbols specifying source file names, |
| 2664 | which would otherwise get stripped. |
| 2665 | |
| 2666 | @item --only-keep-debug |
| 2667 | Strip a file, removing contents of any sections that would not be |
| 2668 | stripped by @option{--strip-debug} and leaving the debugging sections |
| 2669 | intact. In ELF files, this preserves all note sections in the output. |
| 2670 | |
| 2671 | The intention is that this option will be used in conjunction with |
| 2672 | @option{--add-gnu-debuglink} to create a two part executable. One a |
| 2673 | stripped binary which will occupy less space in RAM and in a |
| 2674 | distribution and the second a debugging information file which is only |
| 2675 | needed if debugging abilities are required. The suggested procedure |
| 2676 | to create these files is as follows: |
| 2677 | |
| 2678 | @enumerate |
| 2679 | @item Link the executable as normal. Assuming that is is called |
| 2680 | @code{foo} then... |
| 2681 | @item Run @code{objcopy --only-keep-debug foo foo.dbg} to |
| 2682 | create a file containing the debugging info. |
| 2683 | @item Run @code{objcopy --strip-debug foo} to create a |
| 2684 | stripped executable. |
| 2685 | @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo} |
| 2686 | to add a link to the debugging info into the stripped executable. |
| 2687 | @end enumerate |
| 2688 | |
| 2689 | Note---the choice of @code{.dbg} as an extension for the debug info |
| 2690 | file is arbitrary. Also the @code{--only-keep-debug} step is |
| 2691 | optional. You could instead do this: |
| 2692 | |
| 2693 | @enumerate |
| 2694 | @item Link the executable as normal. |
| 2695 | @item Copy @code{foo} to @code{foo.full} |
| 2696 | @item Run @code{strip --strip-debug foo} |
| 2697 | @item Run @code{objcopy --add-gnu-debuglink=foo.full foo} |
| 2698 | @end enumerate |
| 2699 | |
| 2700 | i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the |
| 2701 | full executable. It does not have to be a file created by the |
| 2702 | @option{--only-keep-debug} switch. |
| 2703 | |
| 2704 | Note---this switch is only intended for use on fully linked files. It |
| 2705 | does not make sense to use it on object files where the debugging |
| 2706 | information may be incomplete. Besides the gnu_debuglink feature |
| 2707 | currently only supports the presence of one filename containing |
| 2708 | debugging information, not multiple filenames on a one-per-object-file |
| 2709 | basis. |
| 2710 | |
| 2711 | @item -V |
| 2712 | @itemx --version |
| 2713 | Show the version number for @command{strip}. |
| 2714 | |
| 2715 | @item -v |
| 2716 | @itemx --verbose |
| 2717 | Verbose output: list all object files modified. In the case of |
| 2718 | archives, @samp{strip -v} lists all members of the archive. |
| 2719 | @end table |
| 2720 | |
| 2721 | @c man end |
| 2722 | |
| 2723 | @ignore |
| 2724 | @c man begin SEEALSO strip |
| 2725 | the Info entries for @file{binutils}. |
| 2726 | @c man end |
| 2727 | @end ignore |
| 2728 | |
| 2729 | @node c++filt, addr2line, elfedit, Top |
| 2730 | @chapter c++filt |
| 2731 | |
| 2732 | @kindex c++filt |
| 2733 | @cindex demangling C++ symbols |
| 2734 | |
| 2735 | @c man title cxxfilt Demangle C++ and Java symbols. |
| 2736 | |
| 2737 | @smallexample |
| 2738 | @c man begin SYNOPSIS cxxfilt |
| 2739 | c++filt [@option{-_}|@option{--strip-underscores}] |
| 2740 | [@option{-n}|@option{--no-strip-underscores}] |
| 2741 | [@option{-p}|@option{--no-params}] |
| 2742 | [@option{-t}|@option{--types}] |
| 2743 | [@option{-i}|@option{--no-verbose}] |
| 2744 | [@option{-s} @var{format}|@option{--format=}@var{format}] |
| 2745 | [@option{--help}] [@option{--version}] [@var{symbol}@dots{}] |
| 2746 | @c man end |
| 2747 | @end smallexample |
| 2748 | |
| 2749 | @c man begin DESCRIPTION cxxfilt |
| 2750 | |
| 2751 | @kindex cxxfilt |
| 2752 | The C++ and Java languages provide function overloading, which means |
| 2753 | that you can write many functions with the same name, providing that |
| 2754 | each function takes parameters of different types. In order to be |
| 2755 | able to distinguish these similarly named functions C++ and Java |
| 2756 | encode them into a low-level assembler name which uniquely identifies |
| 2757 | each different version. This process is known as @dfn{mangling}. The |
| 2758 | @command{c++filt} |
| 2759 | @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on |
| 2760 | MS-DOS this program is named @command{CXXFILT}.} |
| 2761 | program does the inverse mapping: it decodes (@dfn{demangles}) low-level |
| 2762 | names into user-level names so that they can be read. |
| 2763 | |
| 2764 | Every alphanumeric word (consisting of letters, digits, underscores, |
| 2765 | dollars, or periods) seen in the input is a potential mangled name. |
| 2766 | If the name decodes into a C++ name, the C++ name replaces the |
| 2767 | low-level name in the output, otherwise the original word is output. |
| 2768 | In this way you can pass an entire assembler source file, containing |
| 2769 | mangled names, through @command{c++filt} and see the same source file |
| 2770 | containing demangled names. |
| 2771 | |
| 2772 | You can also use @command{c++filt} to decipher individual symbols by |
| 2773 | passing them on the command line: |
| 2774 | |
| 2775 | @example |
| 2776 | c++filt @var{symbol} |
| 2777 | @end example |
| 2778 | |
| 2779 | If no @var{symbol} arguments are given, @command{c++filt} reads symbol |
| 2780 | names from the standard input instead. All the results are printed on |
| 2781 | the standard output. The difference between reading names from the |
| 2782 | command line versus reading names from the standard input is that |
| 2783 | command line arguments are expected to be just mangled names and no |
| 2784 | checking is performed to separate them from surrounding text. Thus |
| 2785 | for example: |
| 2786 | |
| 2787 | @smallexample |
| 2788 | c++filt -n _Z1fv |
| 2789 | @end smallexample |
| 2790 | |
| 2791 | will work and demangle the name to ``f()'' whereas: |
| 2792 | |
| 2793 | @smallexample |
| 2794 | c++filt -n _Z1fv, |
| 2795 | @end smallexample |
| 2796 | |
| 2797 | will not work. (Note the extra comma at the end of the mangled |
| 2798 | name which makes it invalid). This command however will work: |
| 2799 | |
| 2800 | @smallexample |
| 2801 | echo _Z1fv, | c++filt -n |
| 2802 | @end smallexample |
| 2803 | |
| 2804 | and will display ``f(),'', i.e., the demangled name followed by a |
| 2805 | trailing comma. This behaviour is because when the names are read |
| 2806 | from the standard input it is expected that they might be part of an |
| 2807 | assembler source file where there might be extra, extraneous |
| 2808 | characters trailing after a mangled name. For example: |
| 2809 | |
| 2810 | @smallexample |
| 2811 | .type _Z1fv, @@function |
| 2812 | @end smallexample |
| 2813 | |
| 2814 | @c man end |
| 2815 | |
| 2816 | @c man begin OPTIONS cxxfilt |
| 2817 | |
| 2818 | @table @env |
| 2819 | @item -_ |
| 2820 | @itemx --strip-underscores |
| 2821 | On some systems, both the C and C++ compilers put an underscore in front |
| 2822 | of every name. For example, the C name @code{foo} gets the low-level |
| 2823 | name @code{_foo}. This option removes the initial underscore. Whether |
| 2824 | @command{c++filt} removes the underscore by default is target dependent. |
| 2825 | |
| 2826 | @item -n |
| 2827 | @itemx --no-strip-underscores |
| 2828 | Do not remove the initial underscore. |
| 2829 | |
| 2830 | @item -p |
| 2831 | @itemx --no-params |
| 2832 | When demangling the name of a function, do not display the types of |
| 2833 | the function's parameters. |
| 2834 | |
| 2835 | @item -t |
| 2836 | @itemx --types |
| 2837 | Attempt to demangle types as well as function names. This is disabled |
| 2838 | by default since mangled types are normally only used internally in |
| 2839 | the compiler, and they can be confused with non-mangled names. For example, |
| 2840 | a function called ``a'' treated as a mangled type name would be |
| 2841 | demangled to ``signed char''. |
| 2842 | |
| 2843 | @item -i |
| 2844 | @itemx --no-verbose |
| 2845 | Do not include implementation details (if any) in the demangled |
| 2846 | output. |
| 2847 | |
| 2848 | @item -s @var{format} |
| 2849 | @itemx --format=@var{format} |
| 2850 | @command{c++filt} can decode various methods of mangling, used by |
| 2851 | different compilers. The argument to this option selects which |
| 2852 | method it uses: |
| 2853 | |
| 2854 | @table @code |
| 2855 | @item auto |
| 2856 | Automatic selection based on executable (the default method) |
| 2857 | @item gnu |
| 2858 | the one used by the @sc{gnu} C++ compiler (g++) |
| 2859 | @item lucid |
| 2860 | the one used by the Lucid compiler (lcc) |
| 2861 | @item arm |
| 2862 | the one specified by the C++ Annotated Reference Manual |
| 2863 | @item hp |
| 2864 | the one used by the HP compiler (aCC) |
| 2865 | @item edg |
| 2866 | the one used by the EDG compiler |
| 2867 | @item gnu-v3 |
| 2868 | the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI. |
| 2869 | @item java |
| 2870 | the one used by the @sc{gnu} Java compiler (gcj) |
| 2871 | @item gnat |
| 2872 | the one used by the @sc{gnu} Ada compiler (GNAT). |
| 2873 | @end table |
| 2874 | |
| 2875 | @item --help |
| 2876 | Print a summary of the options to @command{c++filt} and exit. |
| 2877 | |
| 2878 | @item --version |
| 2879 | Print the version number of @command{c++filt} and exit. |
| 2880 | @end table |
| 2881 | |
| 2882 | @c man end |
| 2883 | |
| 2884 | @ignore |
| 2885 | @c man begin SEEALSO cxxfilt |
| 2886 | the Info entries for @file{binutils}. |
| 2887 | @c man end |
| 2888 | @end ignore |
| 2889 | |
| 2890 | @quotation |
| 2891 | @emph{Warning:} @command{c++filt} is a new utility, and the details of its |
| 2892 | user interface are subject to change in future releases. In particular, |
| 2893 | a command-line option may be required in the future to decode a name |
| 2894 | passed as an argument on the command line; in other words, |
| 2895 | |
| 2896 | @example |
| 2897 | c++filt @var{symbol} |
| 2898 | @end example |
| 2899 | |
| 2900 | @noindent |
| 2901 | may in a future release become |
| 2902 | |
| 2903 | @example |
| 2904 | c++filt @var{option} @var{symbol} |
| 2905 | @end example |
| 2906 | @end quotation |
| 2907 | |
| 2908 | @node addr2line |
| 2909 | @chapter addr2line |
| 2910 | |
| 2911 | @kindex addr2line |
| 2912 | @cindex address to file name and line number |
| 2913 | |
| 2914 | @c man title addr2line convert addresses into file names and line numbers. |
| 2915 | |
| 2916 | @smallexample |
| 2917 | @c man begin SYNOPSIS addr2line |
| 2918 | addr2line [@option{-a}|@option{--addresses}] |
| 2919 | [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}] |
| 2920 | [@option{-C}|@option{--demangle}[=@var{style}]] |
| 2921 | [@option{-e} @var{filename}|@option{--exe=}@var{filename}] |
| 2922 | [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}] |
| 2923 | [@option{-i}|@option{--inlines}] |
| 2924 | [@option{-p}|@option{--pretty-print}] |
| 2925 | [@option{-j}|@option{--section=}@var{name}] |
| 2926 | [@option{-H}|@option{--help}] [@option{-V}|@option{--version}] |
| 2927 | [addr addr @dots{}] |
| 2928 | @c man end |
| 2929 | @end smallexample |
| 2930 | |
| 2931 | @c man begin DESCRIPTION addr2line |
| 2932 | |
| 2933 | @command{addr2line} translates addresses into file names and line numbers. |
| 2934 | Given an address in an executable or an offset in a section of a relocatable |
| 2935 | object, it uses the debugging information to figure out which file name and |
| 2936 | line number are associated with it. |
| 2937 | |
| 2938 | The executable or relocatable object to use is specified with the @option{-e} |
| 2939 | option. The default is the file @file{a.out}. The section in the relocatable |
| 2940 | object to use is specified with the @option{-j} option. |
| 2941 | |
| 2942 | @command{addr2line} has two modes of operation. |
| 2943 | |
| 2944 | In the first, hexadecimal addresses are specified on the command line, |
| 2945 | and @command{addr2line} displays the file name and line number for each |
| 2946 | address. |
| 2947 | |
| 2948 | In the second, @command{addr2line} reads hexadecimal addresses from |
| 2949 | standard input, and prints the file name and line number for each |
| 2950 | address on standard output. In this mode, @command{addr2line} may be used |
| 2951 | in a pipe to convert dynamically chosen addresses. |
| 2952 | |
| 2953 | The format of the output is @samp{FILENAME:LINENO}. The file name and |
| 2954 | line number for each address is printed on a separate line. If the |
| 2955 | @command{-f} option is used, then each @samp{FILENAME:LINENO} line is |
| 2956 | preceded by a @samp{FUNCTIONNAME} line which is the name of the function |
| 2957 | containing the address. If the @command{-a} option is used, then the |
| 2958 | address read is first printed. |
| 2959 | |
| 2960 | If the file name or function name can not be determined, |
| 2961 | @command{addr2line} will print two question marks in their place. If the |
| 2962 | line number can not be determined, @command{addr2line} will print 0. |
| 2963 | |
| 2964 | @c man end |
| 2965 | |
| 2966 | @c man begin OPTIONS addr2line |
| 2967 | |
| 2968 | The long and short forms of options, shown here as alternatives, are |
| 2969 | equivalent. |
| 2970 | |
| 2971 | @table @env |
| 2972 | @item -a |
| 2973 | @itemx --addresses |
| 2974 | Display address before function names or file and line number |
| 2975 | information. The address is printed with a @samp{0x} prefix to easily |
| 2976 | identify it. |
| 2977 | |
| 2978 | @item -b @var{bfdname} |
| 2979 | @itemx --target=@var{bfdname} |
| 2980 | @cindex object code format |
| 2981 | Specify that the object-code format for the object files is |
| 2982 | @var{bfdname}. |
| 2983 | |
| 2984 | @item -C |
| 2985 | @itemx --demangle[=@var{style}] |
| 2986 | @cindex demangling in objdump |
| 2987 | Decode (@dfn{demangle}) low-level symbol names into user-level names. |
| 2988 | Besides removing any initial underscore prepended by the system, this |
| 2989 | makes C++ function names readable. Different compilers have different |
| 2990 | mangling styles. The optional demangling style argument can be used to |
| 2991 | choose an appropriate demangling style for your compiler. @xref{c++filt}, |
| 2992 | for more information on demangling. |
| 2993 | |
| 2994 | @item -e @var{filename} |
| 2995 | @itemx --exe=@var{filename} |
| 2996 | Specify the name of the executable for which addresses should be |
| 2997 | translated. The default file is @file{a.out}. |
| 2998 | |
| 2999 | @item -f |
| 3000 | @itemx --functions |
| 3001 | Display function names as well as file and line number information. |
| 3002 | |
| 3003 | @item -s |
| 3004 | @itemx --basenames |
| 3005 | Display only the base of each file name. |
| 3006 | |
| 3007 | @item -i |
| 3008 | @itemx --inlines |
| 3009 | If the address belongs to a function that was inlined, the source |
| 3010 | information for all enclosing scopes back to the first non-inlined |
| 3011 | function will also be printed. For example, if @code{main} inlines |
| 3012 | @code{callee1} which inlines @code{callee2}, and address is from |
| 3013 | @code{callee2}, the source information for @code{callee1} and @code{main} |
| 3014 | will also be printed. |
| 3015 | |
| 3016 | @item -j |
| 3017 | @itemx --section |
| 3018 | Read offsets relative to the specified section instead of absolute addresses. |
| 3019 | |
| 3020 | @item -p |
| 3021 | @itemx --pretty-print |
| 3022 | Make the output more human friendly: each location are printed on one line. |
| 3023 | If option @option{-i} is specified, lines for all enclosing scopes are |
| 3024 | prefixed with @samp{(inlined by)}. |
| 3025 | @end table |
| 3026 | |
| 3027 | @c man end |
| 3028 | |
| 3029 | @ignore |
| 3030 | @c man begin SEEALSO addr2line |
| 3031 | Info entries for @file{binutils}. |
| 3032 | @c man end |
| 3033 | @end ignore |
| 3034 | |
| 3035 | @node nlmconv |
| 3036 | @chapter nlmconv |
| 3037 | |
| 3038 | @command{nlmconv} converts a relocatable object file into a NetWare |
| 3039 | Loadable Module. |
| 3040 | |
| 3041 | @ignore |
| 3042 | @command{nlmconv} currently works with @samp{i386} object |
| 3043 | files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC} |
| 3044 | object files in @sc{elf}, or @code{a.out} format@footnote{ |
| 3045 | @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object |
| 3046 | format in the Binary File Descriptor library. It has only been tested |
| 3047 | with the above formats.}. |
| 3048 | @end ignore |
| 3049 | |
| 3050 | @quotation |
| 3051 | @emph{Warning:} @command{nlmconv} is not always built as part of the binary |
| 3052 | utilities, since it is only useful for NLM targets. |
| 3053 | @end quotation |
| 3054 | |
| 3055 | @c man title nlmconv converts object code into an NLM. |
| 3056 | |
| 3057 | @smallexample |
| 3058 | @c man begin SYNOPSIS nlmconv |
| 3059 | nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}] |
| 3060 | [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}] |
| 3061 | [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}] |
| 3062 | [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}] |
| 3063 | [@option{-h}|@option{--help}] [@option{-V}|@option{--version}] |
| 3064 | @var{infile} @var{outfile} |
| 3065 | @c man end |
| 3066 | @end smallexample |
| 3067 | |
| 3068 | @c man begin DESCRIPTION nlmconv |
| 3069 | |
| 3070 | @command{nlmconv} converts the relocatable @samp{i386} object file |
| 3071 | @var{infile} into the NetWare Loadable Module @var{outfile}, optionally |
| 3072 | reading @var{headerfile} for NLM header information. For instructions |
| 3073 | on writing the NLM command file language used in header files, see the |
| 3074 | @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM |
| 3075 | Development and Tools Overview}, which is part of the NLM Software |
| 3076 | Developer's Kit (``NLM SDK''), available from Novell, Inc. |
| 3077 | @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read |
| 3078 | @var{infile}; |
| 3079 | @ifclear man |
| 3080 | see @ref{BFD,,BFD,ld.info,Using LD}, for more information. |
| 3081 | @end ifclear |
| 3082 | |
| 3083 | @command{nlmconv} can perform a link step. In other words, you can list |
| 3084 | more than one object file for input if you list them in the definitions |
| 3085 | file (rather than simply specifying one input file on the command line). |
| 3086 | In this case, @command{nlmconv} calls the linker for you. |
| 3087 | |
| 3088 | @c man end |
| 3089 | |
| 3090 | @c man begin OPTIONS nlmconv |
| 3091 | |
| 3092 | @table @env |
| 3093 | @item -I @var{bfdname} |
| 3094 | @itemx --input-target=@var{bfdname} |
| 3095 | Object format of the input file. @command{nlmconv} can usually determine |
| 3096 | the format of a given file (so no default is necessary). |
| 3097 | @xref{Target Selection}, for more information. |
| 3098 | |
| 3099 | @item -O @var{bfdname} |
| 3100 | @itemx --output-target=@var{bfdname} |
| 3101 | Object format of the output file. @command{nlmconv} infers the output |
| 3102 | format based on the input format, e.g. for a @samp{i386} input file the |
| 3103 | output format is @samp{nlm32-i386}. |
| 3104 | @xref{Target Selection}, for more information. |
| 3105 | |
| 3106 | @item -T @var{headerfile} |
| 3107 | @itemx --header-file=@var{headerfile} |
| 3108 | Reads @var{headerfile} for NLM header information. For instructions on |
| 3109 | writing the NLM command file language used in header files, see@ see the |
| 3110 | @samp{linkers} section, of the @cite{NLM Development and Tools |
| 3111 | Overview}, which is part of the NLM Software Developer's Kit, available |
| 3112 | from Novell, Inc. |
| 3113 | |
| 3114 | @item -d |
| 3115 | @itemx --debug |
| 3116 | Displays (on standard error) the linker command line used by @command{nlmconv}. |
| 3117 | |
| 3118 | @item -l @var{linker} |
| 3119 | @itemx --linker=@var{linker} |
| 3120 | Use @var{linker} for any linking. @var{linker} can be an absolute or a |
| 3121 | relative pathname. |
| 3122 | |
| 3123 | @item -h |
| 3124 | @itemx --help |
| 3125 | Prints a usage summary. |
| 3126 | |
| 3127 | @item -V |
| 3128 | @itemx --version |
| 3129 | Prints the version number for @command{nlmconv}. |
| 3130 | @end table |
| 3131 | |
| 3132 | @c man end |
| 3133 | |
| 3134 | @ignore |
| 3135 | @c man begin SEEALSO nlmconv |
| 3136 | the Info entries for @file{binutils}. |
| 3137 | @c man end |
| 3138 | @end ignore |
| 3139 | |
| 3140 | @node windmc |
| 3141 | @chapter windmc |
| 3142 | |
| 3143 | @command{windmc} may be used to generator Windows message resources. |
| 3144 | |
| 3145 | @quotation |
| 3146 | @emph{Warning:} @command{windmc} is not always built as part of the binary |
| 3147 | utilities, since it is only useful for Windows targets. |
| 3148 | @end quotation |
| 3149 | |
| 3150 | @c man title windmc generates Windows message resources. |
| 3151 | |
| 3152 | @smallexample |
| 3153 | @c man begin SYNOPSIS windmc |
| 3154 | windmc [options] input-file |
| 3155 | @c man end |
| 3156 | @end smallexample |
| 3157 | |
| 3158 | @c man begin DESCRIPTION windmc |
| 3159 | |
| 3160 | @command{windmc} reads message definitions from an input file (.mc) and |
| 3161 | translate them into a set of output files. The output files may be of |
| 3162 | four kinds: |
| 3163 | |
| 3164 | @table @code |
| 3165 | @item h |
| 3166 | A C header file containing the message definitions. |
| 3167 | |
| 3168 | @item rc |
| 3169 | A resource file compilable by the @command{windres} tool. |
| 3170 | |
| 3171 | @item bin |
| 3172 | One or more binary files containing the resource data for a specific |
| 3173 | message language. |
| 3174 | |
| 3175 | @item dbg |
| 3176 | A C include file that maps message id's to their symbolic name. |
| 3177 | @end table |
| 3178 | |
| 3179 | The exact description of these different formats is available in |
| 3180 | documentation from Microsoft. |
| 3181 | |
| 3182 | When @command{windmc} converts from the @code{mc} format to the @code{bin} |
| 3183 | format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the |
| 3184 | Windows Message Compiler. |
| 3185 | |
| 3186 | @c man end |
| 3187 | |
| 3188 | @c man begin OPTIONS windmc |
| 3189 | |
| 3190 | @table @env |
| 3191 | @item -a |
| 3192 | @itemx --ascii_in |
| 3193 | Specifies that the input file specified is ASCII. This is the default |
| 3194 | behaviour. |
| 3195 | |
| 3196 | @item -A |
| 3197 | @itemx --ascii_out |
| 3198 | Specifies that messages in the output @code{bin} files should be in ASCII |
| 3199 | format. |
| 3200 | |
| 3201 | @item -b |
| 3202 | @itemx --binprefix |
| 3203 | Specifies that @code{bin} filenames should have to be prefixed by the |
| 3204 | basename of the source file. |
| 3205 | |
| 3206 | @item -c |
| 3207 | @itemx --customflag |
| 3208 | Sets the customer bit in all message id's. |
| 3209 | |
| 3210 | @item -C @var{codepage} |
| 3211 | @itemx --codepage_in @var{codepage} |
| 3212 | Sets the default codepage to be used to convert input file to UTF16. The |
| 3213 | default is ocdepage 1252. |
| 3214 | |
| 3215 | @item -d |
| 3216 | @itemx --decimal_values |
| 3217 | Outputs the constants in the header file in decimal. Default is using |
| 3218 | hexadecimal output. |
| 3219 | |
| 3220 | @item -e @var{ext} |
| 3221 | @itemx --extension @var{ext} |
| 3222 | The extension for the header file. The default is .h extension. |
| 3223 | |
| 3224 | @item -F @var{target} |
| 3225 | @itemx --target @var{target} |
| 3226 | Specify the BFD format to use for a bin file as output. This |
| 3227 | is a BFD target name; you can use the @option{--help} option to see a list |
| 3228 | of supported targets. Normally @command{windmc} will use the default |
| 3229 | format, which is the first one listed by the @option{--help} option. |
| 3230 | @ifclear man |
| 3231 | @ref{Target Selection}. |
| 3232 | @end ifclear |
| 3233 | |
| 3234 | @item -h @var{path} |
| 3235 | @itemx --headerdir @var{path} |
| 3236 | The target directory of the generated header file. The default is the |
| 3237 | current directory. |
| 3238 | |
| 3239 | @item -H |
| 3240 | @itemx --help |
| 3241 | Displays a list of command line options and then exits. |
| 3242 | |
| 3243 | @item -m @var{characters} |
| 3244 | @itemx --maxlength @var{characters} |
| 3245 | Instructs @command{windmc} to generate a warning if the length |
| 3246 | of any message exceeds the number specified. |
| 3247 | |
| 3248 | @item -n |
| 3249 | @itemx --nullterminate |
| 3250 | Terminate message text in @code{bin} files by zero. By default they are |
| 3251 | terminated by CR/LF. |
| 3252 | |
| 3253 | @item -o |
| 3254 | @itemx --hresult_use |
| 3255 | Not yet implemented. Instructs @code{windmc} to generate an OLE2 header |
| 3256 | file, using HRESULT definitions. Status codes are used if the flag is not |
| 3257 | specified. |
| 3258 | |
| 3259 | @item -O @var{codepage} |
| 3260 | @itemx --codepage_out @var{codepage} |
| 3261 | Sets the default codepage to be used to output text files. The default |
| 3262 | is ocdepage 1252. |
| 3263 | |
| 3264 | @item -r @var{path} |
| 3265 | @itemx --rcdir @var{path} |
| 3266 | The target directory for the generated @code{rc} script and the generated |
| 3267 | @code{bin} files that the resource compiler script includes. The default |
| 3268 | is the current directory. |
| 3269 | |
| 3270 | @item -u |
| 3271 | @itemx --unicode_in |
| 3272 | Specifies that the input file is UTF16. |
| 3273 | |
| 3274 | @item -U |
| 3275 | @itemx --unicode_out |
| 3276 | Specifies that messages in the output @code{bin} file should be in UTF16 |
| 3277 | format. This is the default behaviour. |
| 3278 | |
| 3279 | @item -v |
| 3280 | @item --verbose |
| 3281 | Enable verbose mode. |
| 3282 | |
| 3283 | @item -V |
| 3284 | @item --version |
| 3285 | Prints the version number for @command{windmc}. |
| 3286 | |
| 3287 | @item -x @var{path} |
| 3288 | @itemx --xdgb @var{path} |
| 3289 | The path of the @code{dbg} C include file that maps message id's to the |
| 3290 | symbolic name. No such file is generated without specifying the switch. |
| 3291 | @end table |
| 3292 | |
| 3293 | @c man end |
| 3294 | |
| 3295 | @ignore |
| 3296 | @c man begin SEEALSO windmc |
| 3297 | the Info entries for @file{binutils}. |
| 3298 | @c man end |
| 3299 | @end ignore |
| 3300 | |
| 3301 | @node windres |
| 3302 | @chapter windres |
| 3303 | |
| 3304 | @command{windres} may be used to manipulate Windows resources. |
| 3305 | |
| 3306 | @quotation |
| 3307 | @emph{Warning:} @command{windres} is not always built as part of the binary |
| 3308 | utilities, since it is only useful for Windows targets. |
| 3309 | @end quotation |
| 3310 | |
| 3311 | @c man title windres manipulate Windows resources. |
| 3312 | |
| 3313 | @smallexample |
| 3314 | @c man begin SYNOPSIS windres |
| 3315 | windres [options] [input-file] [output-file] |
| 3316 | @c man end |
| 3317 | @end smallexample |
| 3318 | |
| 3319 | @c man begin DESCRIPTION windres |
| 3320 | |
| 3321 | @command{windres} reads resources from an input file and copies them into |
| 3322 | an output file. Either file may be in one of three formats: |
| 3323 | |
| 3324 | @table @code |
| 3325 | @item rc |
| 3326 | A text format read by the Resource Compiler. |
| 3327 | |
| 3328 | @item res |
| 3329 | A binary format generated by the Resource Compiler. |
| 3330 | |
| 3331 | @item coff |
| 3332 | A COFF object or executable. |
| 3333 | @end table |
| 3334 | |
| 3335 | The exact description of these different formats is available in |
| 3336 | documentation from Microsoft. |
| 3337 | |
| 3338 | When @command{windres} converts from the @code{rc} format to the @code{res} |
| 3339 | format, it is acting like the Windows Resource Compiler. When |
| 3340 | @command{windres} converts from the @code{res} format to the @code{coff} |
| 3341 | format, it is acting like the Windows @code{CVTRES} program. |
| 3342 | |
| 3343 | When @command{windres} generates an @code{rc} file, the output is similar |
| 3344 | but not identical to the format expected for the input. When an input |
| 3345 | @code{rc} file refers to an external filename, an output @code{rc} file |
| 3346 | will instead include the file contents. |
| 3347 | |
| 3348 | If the input or output format is not specified, @command{windres} will |
| 3349 | guess based on the file name, or, for the input file, the file contents. |
| 3350 | A file with an extension of @file{.rc} will be treated as an @code{rc} |
| 3351 | file, a file with an extension of @file{.res} will be treated as a |
| 3352 | @code{res} file, and a file with an extension of @file{.o} or |
| 3353 | @file{.exe} will be treated as a @code{coff} file. |
| 3354 | |
| 3355 | If no output file is specified, @command{windres} will print the resources |
| 3356 | in @code{rc} format to standard output. |
| 3357 | |
| 3358 | The normal use is for you to write an @code{rc} file, use @command{windres} |
| 3359 | to convert it to a COFF object file, and then link the COFF file into |
| 3360 | your application. This will make the resources described in the |
| 3361 | @code{rc} file available to Windows. |
| 3362 | |
| 3363 | @c man end |
| 3364 | |
| 3365 | @c man begin OPTIONS windres |
| 3366 | |
| 3367 | @table @env |
| 3368 | @item -i @var{filename} |
| 3369 | @itemx --input @var{filename} |
| 3370 | The name of the input file. If this option is not used, then |
| 3371 | @command{windres} will use the first non-option argument as the input file |
| 3372 | name. If there are no non-option arguments, then @command{windres} will |
| 3373 | read from standard input. @command{windres} can not read a COFF file from |
| 3374 | standard input. |
| 3375 | |
| 3376 | @item -o @var{filename} |
| 3377 | @itemx --output @var{filename} |
| 3378 | The name of the output file. If this option is not used, then |
| 3379 | @command{windres} will use the first non-option argument, after any used |
| 3380 | for the input file name, as the output file name. If there is no |
| 3381 | non-option argument, then @command{windres} will write to standard output. |
| 3382 | @command{windres} can not write a COFF file to standard output. Note, |
| 3383 | for compatibility with @command{rc} the option @option{-fo} is also |
| 3384 | accepted, but its use is not recommended. |
| 3385 | |
| 3386 | @item -J @var{format} |
| 3387 | @itemx --input-format @var{format} |
| 3388 | The input format to read. @var{format} may be @samp{res}, @samp{rc}, or |
| 3389 | @samp{coff}. If no input format is specified, @command{windres} will |
| 3390 | guess, as described above. |
| 3391 | |
| 3392 | @item -O @var{format} |
| 3393 | @itemx --output-format @var{format} |
| 3394 | The output format to generate. @var{format} may be @samp{res}, |
| 3395 | @samp{rc}, or @samp{coff}. If no output format is specified, |
| 3396 | @command{windres} will guess, as described above. |
| 3397 | |
| 3398 | @item -F @var{target} |
| 3399 | @itemx --target @var{target} |
| 3400 | Specify the BFD format to use for a COFF file as input or output. This |
| 3401 | is a BFD target name; you can use the @option{--help} option to see a list |
| 3402 | of supported targets. Normally @command{windres} will use the default |
| 3403 | format, which is the first one listed by the @option{--help} option. |
| 3404 | @ifclear man |
| 3405 | @ref{Target Selection}. |
| 3406 | @end ifclear |
| 3407 | |
| 3408 | @item --preprocessor @var{program} |
| 3409 | When @command{windres} reads an @code{rc} file, it runs it through the C |
| 3410 | preprocessor first. This option may be used to specify the preprocessor |
| 3411 | to use, including any leading arguments. The default preprocessor |
| 3412 | argument is @code{gcc -E -xc-header -DRC_INVOKED}. |
| 3413 | |
| 3414 | @item -I @var{directory} |
| 3415 | @itemx --include-dir @var{directory} |
| 3416 | Specify an include directory to use when reading an @code{rc} file. |
| 3417 | @command{windres} will pass this to the preprocessor as an @option{-I} |
| 3418 | option. @command{windres} will also search this directory when looking for |
| 3419 | files named in the @code{rc} file. If the argument passed to this command |
| 3420 | matches any of the supported @var{formats} (as described in the @option{-J} |
| 3421 | option), it will issue a deprecation warning, and behave just like the |
| 3422 | @option{-J} option. New programs should not use this behaviour. If a |
| 3423 | directory happens to match a @var{format}, simple prefix it with @samp{./} |
| 3424 | to disable the backward compatibility. |
| 3425 | |
| 3426 | @item -D @var{target} |
| 3427 | @itemx --define @var{sym}[=@var{val}] |
| 3428 | Specify a @option{-D} option to pass to the preprocessor when reading an |
| 3429 | @code{rc} file. |
| 3430 | |
| 3431 | @item -U @var{target} |
| 3432 | @itemx --undefine @var{sym} |
| 3433 | Specify a @option{-U} option to pass to the preprocessor when reading an |
| 3434 | @code{rc} file. |
| 3435 | |
| 3436 | @item -r |
| 3437 | Ignored for compatibility with rc. |
| 3438 | |
| 3439 | @item -v |
| 3440 | Enable verbose mode. This tells you what the preprocessor is if you |
| 3441 | didn't specify one. |
| 3442 | |
| 3443 | @item -c @var{val} |
| 3444 | @item --codepage @var{val} |
| 3445 | Specify the default codepage to use when reading an @code{rc} file. |
| 3446 | @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal |
| 3447 | codepage code. The valid range is from zero up to 0xffff, but the |
| 3448 | validity of the codepage is host and configuration dependent. |
| 3449 | |
| 3450 | @item -l @var{val} |
| 3451 | @item --language @var{val} |
| 3452 | Specify the default language to use when reading an @code{rc} file. |
| 3453 | @var{val} should be a hexadecimal language code. The low eight bits are |
| 3454 | the language, and the high eight bits are the sublanguage. |
| 3455 | |
| 3456 | @item --use-temp-file |
| 3457 | Use a temporary file to instead of using popen to read the output of |
| 3458 | the preprocessor. Use this option if the popen implementation is buggy |
| 3459 | on the host (eg., certain non-English language versions of Windows 95 and |
| 3460 | Windows 98 are known to have buggy popen where the output will instead |
| 3461 | go the console). |
| 3462 | |
| 3463 | @item --no-use-temp-file |
| 3464 | Use popen, not a temporary file, to read the output of the preprocessor. |
| 3465 | This is the default behaviour. |
| 3466 | |
| 3467 | @item -h |
| 3468 | @item --help |
| 3469 | Prints a usage summary. |
| 3470 | |
| 3471 | @item -V |
| 3472 | @item --version |
| 3473 | Prints the version number for @command{windres}. |
| 3474 | |
| 3475 | @item --yydebug |
| 3476 | If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1}, |
| 3477 | this will turn on parser debugging. |
| 3478 | @end table |
| 3479 | |
| 3480 | @c man end |
| 3481 | |
| 3482 | @ignore |
| 3483 | @c man begin SEEALSO windres |
| 3484 | the Info entries for @file{binutils}. |
| 3485 | @c man end |
| 3486 | @end ignore |
| 3487 | |
| 3488 | @node dlltool |
| 3489 | @chapter dlltool |
| 3490 | @cindex DLL |
| 3491 | @kindex dlltool |
| 3492 | |
| 3493 | @command{dlltool} is used to create the files needed to create dynamic |
| 3494 | link libraries (DLLs) on systems which understand PE format image |
| 3495 | files such as Windows. A DLL contains an export table which contains |
| 3496 | information that the runtime loader needs to resolve references from a |
| 3497 | referencing program. |
| 3498 | |
| 3499 | The export table is generated by this program by reading in a |
| 3500 | @file{.def} file or scanning the @file{.a} and @file{.o} files which |
| 3501 | will be in the DLL. A @file{.o} file can contain information in |
| 3502 | special @samp{.drectve} sections with export information. |
| 3503 | |
| 3504 | @quotation |
| 3505 | @emph{Note:} @command{dlltool} is not always built as part of the |
| 3506 | binary utilities, since it is only useful for those targets which |
| 3507 | support DLLs. |
| 3508 | @end quotation |
| 3509 | |
| 3510 | @c man title dlltool Create files needed to build and use DLLs. |
| 3511 | |
| 3512 | @smallexample |
| 3513 | @c man begin SYNOPSIS dlltool |
| 3514 | dlltool [@option{-d}|@option{--input-def} @var{def-file-name}] |
| 3515 | [@option{-b}|@option{--base-file} @var{base-file-name}] |
| 3516 | [@option{-e}|@option{--output-exp} @var{exports-file-name}] |
| 3517 | [@option{-z}|@option{--output-def} @var{def-file-name}] |
| 3518 | [@option{-l}|@option{--output-lib} @var{library-file-name}] |
| 3519 | [@option{-y}|@option{--output-delaylib} @var{library-file-name}] |
| 3520 | [@option{--export-all-symbols}] [@option{--no-export-all-symbols}] |
| 3521 | [@option{--exclude-symbols} @var{list}] |
| 3522 | [@option{--no-default-excludes}] |
| 3523 | [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}] |
| 3524 | [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}] |
| 3525 | [@option{-a}|@option{--add-indirect}] |
| 3526 | [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}] |
| 3527 | [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}] |
| 3528 | [@option{-p}|@option{--ext-prefix-alias} @var{prefix}] |
| 3529 | [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] |
| 3530 | [@option{--use-nul-prefixed-import-tables}] |
| 3531 | [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}] |
| 3532 | [@option{-i}|@option{--interwork}] |
| 3533 | [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}] |
| 3534 | [@option{-v}|@option{--verbose}] |
| 3535 | [@option{-h}|@option{--help}] [@option{-V}|@option{--version}] |
| 3536 | [@option{--no-leading-underscore}] [@option{--leading-underscore}] |
| 3537 | [object-file @dots{}] |
| 3538 | @c man end |
| 3539 | @end smallexample |
| 3540 | |
| 3541 | @c man begin DESCRIPTION dlltool |
| 3542 | |
| 3543 | @command{dlltool} reads its inputs, which can come from the @option{-d} and |
| 3544 | @option{-b} options as well as object files specified on the command |
| 3545 | line. It then processes these inputs and if the @option{-e} option has |
| 3546 | been specified it creates a exports file. If the @option{-l} option |
| 3547 | has been specified it creates a library file and if the @option{-z} option |
| 3548 | has been specified it creates a def file. Any or all of the @option{-e}, |
| 3549 | @option{-l} and @option{-z} options can be present in one invocation of |
| 3550 | dlltool. |
| 3551 | |
| 3552 | When creating a DLL, along with the source for the DLL, it is necessary |
| 3553 | to have three other files. @command{dlltool} can help with the creation of |
| 3554 | these files. |
| 3555 | |
| 3556 | The first file is a @file{.def} file which specifies which functions are |
| 3557 | exported from the DLL, which functions the DLL imports, and so on. This |
| 3558 | is a text file and can be created by hand, or @command{dlltool} can be used |
| 3559 | to create it using the @option{-z} option. In this case @command{dlltool} |
| 3560 | will scan the object files specified on its command line looking for |
| 3561 | those functions which have been specially marked as being exported and |
| 3562 | put entries for them in the @file{.def} file it creates. |
| 3563 | |
| 3564 | In order to mark a function as being exported from a DLL, it needs to |
| 3565 | have an @option{-export:<name_of_function>} entry in the @samp{.drectve} |
| 3566 | section of the object file. This can be done in C by using the |
| 3567 | asm() operator: |
| 3568 | |
| 3569 | @smallexample |
| 3570 | asm (".section .drectve"); |
| 3571 | asm (".ascii \"-export:my_func\""); |
| 3572 | |
| 3573 | int my_func (void) @{ @dots{} @} |
| 3574 | @end smallexample |
| 3575 | |
| 3576 | The second file needed for DLL creation is an exports file. This file |
| 3577 | is linked with the object files that make up the body of the DLL and it |
| 3578 | handles the interface between the DLL and the outside world. This is a |
| 3579 | binary file and it can be created by giving the @option{-e} option to |
| 3580 | @command{dlltool} when it is creating or reading in a @file{.def} file. |
| 3581 | |
| 3582 | The third file needed for DLL creation is the library file that programs |
| 3583 | will link with in order to access the functions in the DLL (an `import |
| 3584 | library'). This file can be created by giving the @option{-l} option to |
| 3585 | dlltool when it is creating or reading in a @file{.def} file. |
| 3586 | |
| 3587 | If the @option{-y} option is specified, dlltool generates a delay-import |
| 3588 | library that can be used instead of the normal import library to allow |
| 3589 | a program to link to the dll only as soon as an imported function is |
| 3590 | called for the first time. The resulting executable will need to be |
| 3591 | linked to the static delayimp library containing __delayLoadHelper2(), |
| 3592 | which in turn will import LoadLibraryA and GetProcAddress from kernel32. |
| 3593 | |
| 3594 | @command{dlltool} builds the library file by hand, but it builds the |
| 3595 | exports file by creating temporary files containing assembler statements |
| 3596 | and then assembling these. The @option{-S} command line option can be |
| 3597 | used to specify the path to the assembler that dlltool will use, |
| 3598 | and the @option{-f} option can be used to pass specific flags to that |
| 3599 | assembler. The @option{-n} can be used to prevent dlltool from deleting |
| 3600 | these temporary assembler files when it is done, and if @option{-n} is |
| 3601 | specified twice then this will prevent dlltool from deleting the |
| 3602 | temporary object files it used to build the library. |
| 3603 | |
| 3604 | Here is an example of creating a DLL from a source file @samp{dll.c} and |
| 3605 | also creating a program (from an object file called @samp{program.o}) |
| 3606 | that uses that DLL: |
| 3607 | |
| 3608 | @smallexample |
| 3609 | gcc -c dll.c |
| 3610 | dlltool -e exports.o -l dll.lib dll.o |
| 3611 | gcc dll.o exports.o -o dll.dll |
| 3612 | gcc program.o dll.lib -o program |
| 3613 | @end smallexample |
| 3614 | |
| 3615 | |
| 3616 | @command{dlltool} may also be used to query an existing import library |
| 3617 | to determine the name of the DLL to which it is associated. See the |
| 3618 | description of the @option{-I} or @option{--identify} option. |
| 3619 | |
| 3620 | @c man end |
| 3621 | |
| 3622 | @c man begin OPTIONS dlltool |
| 3623 | |
| 3624 | The command line options have the following meanings: |
| 3625 | |
| 3626 | @table @env |
| 3627 | |
| 3628 | @item -d @var{filename} |
| 3629 | @itemx --input-def @var{filename} |
| 3630 | @cindex input .def file |
| 3631 | Specifies the name of a @file{.def} file to be read in and processed. |
| 3632 | |
| 3633 | @item -b @var{filename} |
| 3634 | @itemx --base-file @var{filename} |
| 3635 | @cindex base files |
| 3636 | Specifies the name of a base file to be read in and processed. The |
| 3637 | contents of this file will be added to the relocation section in the |
| 3638 | exports file generated by dlltool. |
| 3639 | |
| 3640 | @item -e @var{filename} |
| 3641 | @itemx --output-exp @var{filename} |
| 3642 | Specifies the name of the export file to be created by dlltool. |
| 3643 | |
| 3644 | @item -z @var{filename} |
| 3645 | @itemx --output-def @var{filename} |
| 3646 | Specifies the name of the @file{.def} file to be created by dlltool. |
| 3647 | |
| 3648 | @item -l @var{filename} |
| 3649 | @itemx --output-lib @var{filename} |
| 3650 | Specifies the name of the library file to be created by dlltool. |
| 3651 | |
| 3652 | @item -y @var{filename} |
| 3653 | @itemx --output-delaylib @var{filename} |
| 3654 | Specifies the name of the delay-import library file to be created by dlltool. |
| 3655 | |
| 3656 | @item --export-all-symbols |
| 3657 | Treat all global and weak defined symbols found in the input object |
| 3658 | files as symbols to be exported. There is a small list of symbols which |
| 3659 | are not exported by default; see the @option{--no-default-excludes} |
| 3660 | option. You may add to the list of symbols to not export by using the |
| 3661 | @option{--exclude-symbols} option. |
| 3662 | |
| 3663 | @item --no-export-all-symbols |
| 3664 | Only export symbols explicitly listed in an input @file{.def} file or in |
| 3665 | @samp{.drectve} sections in the input object files. This is the default |
| 3666 | behaviour. The @samp{.drectve} sections are created by @samp{dllexport} |
| 3667 | attributes in the source code. |
| 3668 | |
| 3669 | @item --exclude-symbols @var{list} |
| 3670 | Do not export the symbols in @var{list}. This is a list of symbol names |
| 3671 | separated by comma or colon characters. The symbol names should not |
| 3672 | contain a leading underscore. This is only meaningful when |
| 3673 | @option{--export-all-symbols} is used. |
| 3674 | |
| 3675 | @item --no-default-excludes |
| 3676 | When @option{--export-all-symbols} is used, it will by default avoid |
| 3677 | exporting certain special symbols. The current list of symbols to avoid |
| 3678 | exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0}, |
| 3679 | @samp{impure_ptr}. You may use the @option{--no-default-excludes} option |
| 3680 | to go ahead and export these special symbols. This is only meaningful |
| 3681 | when @option{--export-all-symbols} is used. |
| 3682 | |
| 3683 | @item -S @var{path} |
| 3684 | @itemx --as @var{path} |
| 3685 | Specifies the path, including the filename, of the assembler to be used |
| 3686 | to create the exports file. |
| 3687 | |
| 3688 | @item -f @var{options} |
| 3689 | @itemx --as-flags @var{options} |
| 3690 | Specifies any specific command line options to be passed to the |
| 3691 | assembler when building the exports file. This option will work even if |
| 3692 | the @option{-S} option is not used. This option only takes one argument, |
| 3693 | and if it occurs more than once on the command line, then later |
| 3694 | occurrences will override earlier occurrences. So if it is necessary to |
| 3695 | pass multiple options to the assembler they should be enclosed in |
| 3696 | double quotes. |
| 3697 | |
| 3698 | @item -D @var{name} |
| 3699 | @itemx --dll-name @var{name} |
| 3700 | Specifies the name to be stored in the @file{.def} file as the name of |
| 3701 | the DLL when the @option{-e} option is used. If this option is not |
| 3702 | present, then the filename given to the @option{-e} option will be |
| 3703 | used as the name of the DLL. |
| 3704 | |
| 3705 | @item -m @var{machine} |
| 3706 | @itemx -machine @var{machine} |
| 3707 | Specifies the type of machine for which the library file should be |
| 3708 | built. @command{dlltool} has a built in default type, depending upon how |
| 3709 | it was created, but this option can be used to override that. This is |
| 3710 | normally only useful when creating DLLs for an ARM processor, when the |
| 3711 | contents of the DLL are actually encode using Thumb instructions. |
| 3712 | |
| 3713 | @item -a |
| 3714 | @itemx --add-indirect |
| 3715 | Specifies that when @command{dlltool} is creating the exports file it |
| 3716 | should add a section which allows the exported functions to be |
| 3717 | referenced without using the import library. Whatever the hell that |
| 3718 | means! |
| 3719 | |
| 3720 | @item -U |
| 3721 | @itemx --add-underscore |
| 3722 | Specifies that when @command{dlltool} is creating the exports file it |
| 3723 | should prepend an underscore to the names of @emph{all} exported symbols. |
| 3724 | |
| 3725 | @item --no-leading-underscore |
| 3726 | @item --leading-underscore |
| 3727 | Specifies whether standard symbol should be forced to be prefixed, or |
| 3728 | not. |
| 3729 | |
| 3730 | @item --add-stdcall-underscore |
| 3731 | Specifies that when @command{dlltool} is creating the exports file it |
| 3732 | should prepend an underscore to the names of exported @emph{stdcall} |
| 3733 | functions. Variable names and non-stdcall function names are not modified. |
| 3734 | This option is useful when creating GNU-compatible import libs for third |
| 3735 | party DLLs that were built with MS-Windows tools. |
| 3736 | |
| 3737 | @item -k |
| 3738 | @itemx --kill-at |
| 3739 | Specifies that when @command{dlltool} is creating the exports file it |
| 3740 | should not append the string @samp{@@ <number>}. These numbers are |
| 3741 | called ordinal numbers and they represent another way of accessing the |
| 3742 | function in a DLL, other than by name. |
| 3743 | |
| 3744 | @item -A |
| 3745 | @itemx --add-stdcall-alias |
| 3746 | Specifies that when @command{dlltool} is creating the exports file it |
| 3747 | should add aliases for stdcall symbols without @samp{@@ <number>} |
| 3748 | in addition to the symbols with @samp{@@ <number>}. |
| 3749 | |
| 3750 | @item -p |
| 3751 | @itemx --ext-prefix-alias @var{prefix} |
| 3752 | Causes @command{dlltool} to create external aliases for all DLL |
| 3753 | imports with the specified prefix. The aliases are created for both |
| 3754 | external and import symbols with no leading underscore. |
| 3755 | |
| 3756 | @item -x |
| 3757 | @itemx --no-idata4 |
| 3758 | Specifies that when @command{dlltool} is creating the exports and library |
| 3759 | files it should omit the @code{.idata4} section. This is for compatibility |
| 3760 | with certain operating systems. |
| 3761 | |
| 3762 | @item --use-nul-prefixed-import-tables |
| 3763 | Specifies that when @command{dlltool} is creating the exports and library |
| 3764 | files it should prefix the @code{.idata4} and @code{.idata5} by zero an |
| 3765 | element. This emulates old gnu import library generation of |
| 3766 | @code{dlltool}. By default this option is turned off. |
| 3767 | |
| 3768 | @item -c |
| 3769 | @itemx --no-idata5 |
| 3770 | Specifies that when @command{dlltool} is creating the exports and library |
| 3771 | files it should omit the @code{.idata5} section. This is for compatibility |
| 3772 | with certain operating systems. |
| 3773 | |
| 3774 | @item -I @var{filename} |
| 3775 | @itemx --identify @var{filename} |
| 3776 | Specifies that @command{dlltool} should inspect the import library |
| 3777 | indicated by @var{filename} and report, on @code{stdout}, the name(s) |
| 3778 | of the associated DLL(s). This can be performed in addition to any |
| 3779 | other operations indicated by the other options and arguments. |
| 3780 | @command{dlltool} fails if the import library does not exist or is not |
| 3781 | actually an import library. See also @option{--identify-strict}. |
| 3782 | |
| 3783 | @item --identify-strict |
| 3784 | Modifies the behavior of the @option{--identify} option, such |
| 3785 | that an error is reported if @var{filename} is associated with |
| 3786 | more than one DLL. |
| 3787 | |
| 3788 | @item -i |
| 3789 | @itemx --interwork |
| 3790 | Specifies that @command{dlltool} should mark the objects in the library |
| 3791 | file and exports file that it produces as supporting interworking |
| 3792 | between ARM and Thumb code. |
| 3793 | |
| 3794 | @item -n |
| 3795 | @itemx --nodelete |
| 3796 | Makes @command{dlltool} preserve the temporary assembler files it used to |
| 3797 | create the exports file. If this option is repeated then dlltool will |
| 3798 | also preserve the temporary object files it uses to create the library |
| 3799 | file. |
| 3800 | |
| 3801 | @item -t @var{prefix} |
| 3802 | @itemx --temp-prefix @var{prefix} |
| 3803 | Makes @command{dlltool} use @var{prefix} when constructing the names of |
| 3804 | temporary assembler and object files. By default, the temp file prefix |
| 3805 | is generated from the pid. |
| 3806 | |
| 3807 | @item -v |
| 3808 | @itemx --verbose |
| 3809 | Make dlltool describe what it is doing. |
| 3810 | |
| 3811 | @item -h |
| 3812 | @itemx --help |
| 3813 | Displays a list of command line options and then exits. |
| 3814 | |
| 3815 | @item -V |
| 3816 | @itemx --version |
| 3817 | Displays dlltool's version number and then exits. |
| 3818 | |
| 3819 | @end table |
| 3820 | |
| 3821 | @c man end |
| 3822 | |
| 3823 | @menu |
| 3824 | * def file format:: The format of the dlltool @file{.def} file |
| 3825 | @end menu |
| 3826 | |
| 3827 | @node def file format |
| 3828 | @section The format of the @command{dlltool} @file{.def} file |
| 3829 | |
| 3830 | A @file{.def} file contains any number of the following commands: |
| 3831 | |
| 3832 | @table @asis |
| 3833 | |
| 3834 | @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]} |
| 3835 | The result is going to be named @var{name}@code{.exe}. |
| 3836 | |
| 3837 | @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]} |
| 3838 | The result is going to be named @var{name}@code{.dll}. |
| 3839 | |
| 3840 | @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]} |
| 3841 | @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *} |
| 3842 | Declares @var{name1} as an exported symbol from the DLL, with optional |
| 3843 | ordinal number @var{integer}, or declares @var{name1} as an alias |
| 3844 | (forward) of the function @var{external-name} in the DLL. |
| 3845 | If @var{its_name} is specified, this name is used as string in export table. |
| 3846 | @var{module-name}. |
| 3847 | |
| 3848 | @item @code{IMPORTS ( (} @var{internal-name} @code{=} @var{module-name} @code{.} @var{integer} @code{) | [} @var{internal-name} @code{= ]} @var{module-name} @code{.} @var{external-name} @code{) [ == ) @var{its_name} @code{]} *} |
| 3849 | Declares that @var{external-name} or the exported function whose |
| 3850 | ordinal number is @var{integer} is to be imported from the file |
| 3851 | @var{module-name}. If @var{internal-name} is specified then this is |
| 3852 | the name that the imported function will be referred to in the body of |
| 3853 | the DLL. |
| 3854 | If @var{its_name} is specified, this name is used as string in import table. |
| 3855 | |
| 3856 | @item @code{DESCRIPTION} @var{string} |
| 3857 | Puts @var{string} into the output @file{.exp} file in the |
| 3858 | @code{.rdata} section. |
| 3859 | |
| 3860 | @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]} |
| 3861 | @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]} |
| 3862 | Generates @code{--stack} or @code{--heap} |
| 3863 | @var{number-reserve},@var{number-commit} in the output @code{.drectve} |
| 3864 | section. The linker will see this and act upon it. |
| 3865 | |
| 3866 | @item @code{CODE} @var{attr} @code{+} |
| 3867 | @item @code{DATA} @var{attr} @code{+} |
| 3868 | @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *} |
| 3869 | Generates @code{--attr} @var{section-name} @var{attr} in the output |
| 3870 | @code{.drectve} section, where @var{attr} is one of @code{READ}, |
| 3871 | @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see |
| 3872 | this and act upon it. |
| 3873 | |
| 3874 | @end table |
| 3875 | |
| 3876 | @ignore |
| 3877 | @c man begin SEEALSO dlltool |
| 3878 | The Info pages for @file{binutils}. |
| 3879 | @c man end |
| 3880 | @end ignore |
| 3881 | |
| 3882 | @node readelf |
| 3883 | @chapter readelf |
| 3884 | |
| 3885 | @cindex ELF file information |
| 3886 | @kindex readelf |
| 3887 | |
| 3888 | @c man title readelf Displays information about ELF files. |
| 3889 | |
| 3890 | @smallexample |
| 3891 | @c man begin SYNOPSIS readelf |
| 3892 | readelf [@option{-a}|@option{--all}] |
| 3893 | [@option{-h}|@option{--file-header}] |
| 3894 | [@option{-l}|@option{--program-headers}|@option{--segments}] |
| 3895 | [@option{-S}|@option{--section-headers}|@option{--sections}] |
| 3896 | [@option{-g}|@option{--section-groups}] |
| 3897 | [@option{-t}|@option{--section-details}] |
| 3898 | [@option{-e}|@option{--headers}] |
| 3899 | [@option{-s}|@option{--syms}|@option{--symbols}] |
| 3900 | [@option{--dyn-syms}] |
| 3901 | [@option{-n}|@option{--notes}] |
| 3902 | [@option{-r}|@option{--relocs}] |
| 3903 | [@option{-u}|@option{--unwind}] |
| 3904 | [@option{-d}|@option{--dynamic}] |
| 3905 | [@option{-V}|@option{--version-info}] |
| 3906 | [@option{-A}|@option{--arch-specific}] |
| 3907 | [@option{-D}|@option{--use-dynamic}] |
| 3908 | [@option{-x} <number or name>|@option{--hex-dump=}<number or name>] |
| 3909 | [@option{-p} <number or name>|@option{--string-dump=}<number or name>] |
| 3910 | [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>] |
| 3911 | [@option{-c}|@option{--archive-index}] |
| 3912 | [@option{-w[lLiaprmfFsoRt]}| |
| 3913 | @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges]] |
| 3914 | [@option{-I}|@option{--histogram}] |
| 3915 | [@option{-v}|@option{--version}] |
| 3916 | [@option{-W}|@option{--wide}] |
| 3917 | [@option{-H}|@option{--help}] |
| 3918 | @var{elffile}@dots{} |
| 3919 | @c man end |
| 3920 | @end smallexample |
| 3921 | |
| 3922 | @c man begin DESCRIPTION readelf |
| 3923 | |
| 3924 | @command{readelf} displays information about one or more ELF format object |
| 3925 | files. The options control what particular information to display. |
| 3926 | |
| 3927 | @var{elffile}@dots{} are the object files to be examined. 32-bit and |
| 3928 | 64-bit ELF files are supported, as are archives containing ELF files. |
| 3929 | |
| 3930 | This program performs a similar function to @command{objdump} but it |
| 3931 | goes into more detail and it exists independently of the @sc{bfd} |
| 3932 | library, so if there is a bug in @sc{bfd} then readelf will not be |
| 3933 | affected. |
| 3934 | |
| 3935 | @c man end |
| 3936 | |
| 3937 | @c man begin OPTIONS readelf |
| 3938 | |
| 3939 | The long and short forms of options, shown here as alternatives, are |
| 3940 | equivalent. At least one option besides @samp{-v} or @samp{-H} must be |
| 3941 | given. |
| 3942 | |
| 3943 | @table @env |
| 3944 | @item -a |
| 3945 | @itemx --all |
| 3946 | Equivalent to specifying @option{--file-header}, |
| 3947 | @option{--program-headers}, @option{--sections}, @option{--symbols}, |
| 3948 | @option{--relocs}, @option{--dynamic}, @option{--notes} and |
| 3949 | @option{--version-info}. |
| 3950 | |
| 3951 | @item -h |
| 3952 | @itemx --file-header |
| 3953 | @cindex ELF file header information |
| 3954 | Displays the information contained in the ELF header at the start of the |
| 3955 | file. |
| 3956 | |
| 3957 | @item -l |
| 3958 | @itemx --program-headers |
| 3959 | @itemx --segments |
| 3960 | @cindex ELF program header information |
| 3961 | @cindex ELF segment information |
| 3962 | Displays the information contained in the file's segment headers, if it |
| 3963 | has any. |
| 3964 | |
| 3965 | @item -S |
| 3966 | @itemx --sections |
| 3967 | @itemx --section-headers |
| 3968 | @cindex ELF section information |
| 3969 | Displays the information contained in the file's section headers, if it |
| 3970 | has any. |
| 3971 | |
| 3972 | @item -g |
| 3973 | @itemx --section-groups |
| 3974 | @cindex ELF section group information |
| 3975 | Displays the information contained in the file's section groups, if it |
| 3976 | has any. |
| 3977 | |
| 3978 | @item -t |
| 3979 | @itemx --section-details |
| 3980 | @cindex ELF section information |
| 3981 | Displays the detailed section information. Implies @option{-S}. |
| 3982 | |
| 3983 | @item -s |
| 3984 | @itemx --symbols |
| 3985 | @itemx --syms |
| 3986 | @cindex ELF symbol table information |
| 3987 | Displays the entries in symbol table section of the file, if it has one. |
| 3988 | |
| 3989 | @item --dyn-syms |
| 3990 | @cindex ELF dynamic symbol table information |
| 3991 | Displays the entries in dynamic symbol table section of the file, if it |
| 3992 | has one. |
| 3993 | |
| 3994 | @item -e |
| 3995 | @itemx --headers |
| 3996 | Display all the headers in the file. Equivalent to @option{-h -l -S}. |
| 3997 | |
| 3998 | @item -n |
| 3999 | @itemx --notes |
| 4000 | @cindex ELF notes |
| 4001 | Displays the contents of the NOTE segments and/or sections, if any. |
| 4002 | |
| 4003 | @item -r |
| 4004 | @itemx --relocs |
| 4005 | @cindex ELF reloc information |
| 4006 | Displays the contents of the file's relocation section, if it has one. |
| 4007 | |
| 4008 | @item -u |
| 4009 | @itemx --unwind |
| 4010 | @cindex unwind information |
| 4011 | Displays the contents of the file's unwind section, if it has one. Only |
| 4012 | the unwind sections for IA64 ELF files, as well as ARM unwind tables |
| 4013 | (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported. |
| 4014 | |
| 4015 | @item -d |
| 4016 | @itemx --dynamic |
| 4017 | @cindex ELF dynamic section information |
| 4018 | Displays the contents of the file's dynamic section, if it has one. |
| 4019 | |
| 4020 | @item -V |
| 4021 | @itemx --version-info |
| 4022 | @cindex ELF version sections informations |
| 4023 | Displays the contents of the version sections in the file, it they |
| 4024 | exist. |
| 4025 | |
| 4026 | @item -A |
| 4027 | @itemx --arch-specific |
| 4028 | Displays architecture-specific information in the file, if there |
| 4029 | is any. |
| 4030 | |
| 4031 | @item -D |
| 4032 | @itemx --use-dynamic |
| 4033 | When displaying symbols, this option makes @command{readelf} use the |
| 4034 | symbol hash tables in the file's dynamic section, rather than the |
| 4035 | symbol table sections. |
| 4036 | |
| 4037 | @item -x <number or name> |
| 4038 | @itemx --hex-dump=<number or name> |
| 4039 | Displays the contents of the indicated section as a hexadecimal bytes. |
| 4040 | A number identifies a particular section by index in the section table; |
| 4041 | any other string identifies all sections with that name in the object file. |
| 4042 | |
| 4043 | @item -R <number or name> |
| 4044 | @itemx --relocated-dump=<number or name> |
| 4045 | Displays the contents of the indicated section as a hexadecimal |
| 4046 | bytes. A number identifies a particular section by index in the |
| 4047 | section table; any other string identifies all sections with that name |
| 4048 | in the object file. The contents of the section will be relocated |
| 4049 | before they are displayed. |
| 4050 | |
| 4051 | @item -p <number or name> |
| 4052 | @itemx --string-dump=<number or name> |
| 4053 | Displays the contents of the indicated section as printable strings. |
| 4054 | A number identifies a particular section by index in the section table; |
| 4055 | any other string identifies all sections with that name in the object file. |
| 4056 | |
| 4057 | @item -c |
| 4058 | @itemx --archive-index |
| 4059 | @cindex Archive file symbol index information |
| 4060 | Displays the file symbol index infomation contained in the header part |
| 4061 | of binary archives. Performs the same function as the @option{t} |
| 4062 | command to @command{ar}, but without using the BFD library. @xref{ar}. |
| 4063 | |
| 4064 | @item -w[lLiaprmfFsoRt] |
| 4065 | @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges] |
| 4066 | Displays the contents of the debug sections in the file, if any are |
| 4067 | present. If one of the optional letters or words follows the switch |
| 4068 | then only data found in those specific sections will be dumped. |
| 4069 | |
| 4070 | Note that there is no single letter option to display the content of |
| 4071 | trace sections. |
| 4072 | |
| 4073 | Note: the @option{=decodedline} option will display the interpreted |
| 4074 | contents of a .debug_line section whereas the @option{=rawline} option |
| 4075 | dumps the contents in a raw format. |
| 4076 | |
| 4077 | Note: the @option{=frames-interp} option will display the interpreted |
| 4078 | contents of a .debug_frame section whereas the @option{=frames} option |
| 4079 | dumps the contents in a raw format. |
| 4080 | |
| 4081 | @item -I |
| 4082 | @itemx --histogram |
| 4083 | Display a histogram of bucket list lengths when displaying the contents |
| 4084 | of the symbol tables. |
| 4085 | |
| 4086 | @item -v |
| 4087 | @itemx --version |
| 4088 | Display the version number of readelf. |
| 4089 | |
| 4090 | @item -W |
| 4091 | @itemx --wide |
| 4092 | Don't break output lines to fit into 80 columns. By default |
| 4093 | @command{readelf} breaks section header and segment listing lines for |
| 4094 | 64-bit ELF files, so that they fit into 80 columns. This option causes |
| 4095 | @command{readelf} to print each section header resp. each segment one a |
| 4096 | single line, which is far more readable on terminals wider than 80 columns. |
| 4097 | |
| 4098 | @item -H |
| 4099 | @itemx --help |
| 4100 | Display the command line options understood by @command{readelf}. |
| 4101 | |
| 4102 | @end table |
| 4103 | |
| 4104 | @c man end |
| 4105 | |
| 4106 | @ignore |
| 4107 | @c man begin SEEALSO readelf |
| 4108 | objdump(1), and the Info entries for @file{binutils}. |
| 4109 | @c man end |
| 4110 | @end ignore |
| 4111 | |
| 4112 | @node elfedit |
| 4113 | @chapter elfedit |
| 4114 | |
| 4115 | @cindex Update ELF header |
| 4116 | @kindex elfedit |
| 4117 | |
| 4118 | @c man title elfedit Update the ELF header of ELF files. |
| 4119 | |
| 4120 | @smallexample |
| 4121 | @c man begin SYNOPSIS elfedit |
| 4122 | elfedit [@option{--input-mach=}@var{machine}] |
| 4123 | [@option{--input-type=}@var{type}] |
| 4124 | @option{--output-mach=}@var{machine} |
| 4125 | @option{--output-type=}@var{type} |
| 4126 | [@option{-v}|@option{--version}] |
| 4127 | [@option{-h}|@option{--help}] |
| 4128 | @var{elffile}@dots{} |
| 4129 | @c man end |
| 4130 | @end smallexample |
| 4131 | |
| 4132 | @c man begin DESCRIPTION elfedit |
| 4133 | |
| 4134 | @command{elfedit} updates the ELF header of ELF files which have |
| 4135 | the matching ELF machine and file types. The options control how and |
| 4136 | which fields in the ELF header should be updated. |
| 4137 | |
| 4138 | @var{elffile}@dots{} are the ELF files to be updated. 32-bit and |
| 4139 | 64-bit ELF files are supported, as are archives containing ELF files. |
| 4140 | @c man end |
| 4141 | |
| 4142 | @c man begin OPTIONS elfedit |
| 4143 | |
| 4144 | The long and short forms of options, shown here as alternatives, are |
| 4145 | equivalent. At least one of the @option{--output-mach} and |
| 4146 | @option{--output-type} options must be given. |
| 4147 | |
| 4148 | @table @env |
| 4149 | |
| 4150 | @itemx --input-mach=@var{machine} |
| 4151 | Set the matching input ELF machine type to @var{machine}. If |
| 4152 | @option{--input-mach} isn't specified, it will match any ELF |
| 4153 | machine types. |
| 4154 | |
| 4155 | The supported ELF machine types are, @var{L1OM} and @var{x86-64}. |
| 4156 | |
| 4157 | @itemx --output-mach=@var{machine} |
| 4158 | Change the ELF machine type in the ELF header to @var{machine}. The |
| 4159 | supported ELF machine types are the same as @option{--input-mach}. |
| 4160 | |
| 4161 | @itemx --input-type=@var{type} |
| 4162 | Set the matching input ELF file type to @var{type}. If |
| 4163 | @option{--input-type} isn't specified, it will match any ELF file types. |
| 4164 | |
| 4165 | The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}. |
| 4166 | |
| 4167 | @itemx --output-type=@var{type} |
| 4168 | Change the ELF file type in the ELF header to @var{type}. The |
| 4169 | supported ELF types are the same as @option{--input-type}. |
| 4170 | |
| 4171 | @item -v |
| 4172 | @itemx --version |
| 4173 | Display the version number of @command{elfedit}. |
| 4174 | |
| 4175 | @item -h |
| 4176 | @itemx --help |
| 4177 | Display the command line options understood by @command{elfedit}. |
| 4178 | |
| 4179 | @end table |
| 4180 | |
| 4181 | @c man end |
| 4182 | |
| 4183 | @ignore |
| 4184 | @c man begin SEEALSO elfedit |
| 4185 | readelf(1), and the Info entries for @file{binutils}. |
| 4186 | @c man end |
| 4187 | @end ignore |
| 4188 | |
| 4189 | @node Common Options |
| 4190 | @chapter Common Options |
| 4191 | |
| 4192 | The following command-line options are supported by all of the |
| 4193 | programs described in this manual. |
| 4194 | |
| 4195 | @c man begin OPTIONS |
| 4196 | @table @env |
| 4197 | @include at-file.texi |
| 4198 | @c man end |
| 4199 | |
| 4200 | @item --help |
| 4201 | Display the command-line options supported by the program. |
| 4202 | |
| 4203 | @item --version |
| 4204 | Display the version number of the program. |
| 4205 | |
| 4206 | @c man begin OPTIONS |
| 4207 | @end table |
| 4208 | @c man end |
| 4209 | |
| 4210 | @node Selecting the Target System |
| 4211 | @chapter Selecting the Target System |
| 4212 | |
| 4213 | You can specify two aspects of the target system to the @sc{gnu} |
| 4214 | binary file utilities, each in several ways: |
| 4215 | |
| 4216 | @itemize @bullet |
| 4217 | @item |
| 4218 | the target |
| 4219 | |
| 4220 | @item |
| 4221 | the architecture |
| 4222 | @end itemize |
| 4223 | |
| 4224 | In the following summaries, the lists of ways to specify values are in |
| 4225 | order of decreasing precedence. The ways listed first override those |
| 4226 | listed later. |
| 4227 | |
| 4228 | The commands to list valid values only list the values for which the |
| 4229 | programs you are running were configured. If they were configured with |
| 4230 | @option{--enable-targets=all}, the commands list most of the available |
| 4231 | values, but a few are left out; not all targets can be configured in at |
| 4232 | once because some of them can only be configured @dfn{native} (on hosts |
| 4233 | with the same type as the target system). |
| 4234 | |
| 4235 | @menu |
| 4236 | * Target Selection:: |
| 4237 | * Architecture Selection:: |
| 4238 | @end menu |
| 4239 | |
| 4240 | @node Target Selection |
| 4241 | @section Target Selection |
| 4242 | |
| 4243 | A @dfn{target} is an object file format. A given target may be |
| 4244 | supported for multiple architectures (@pxref{Architecture Selection}). |
| 4245 | A target selection may also have variations for different operating |
| 4246 | systems or architectures. |
| 4247 | |
| 4248 | The command to list valid target values is @samp{objdump -i} |
| 4249 | (the first column of output contains the relevant information). |
| 4250 | |
| 4251 | Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips}, |
| 4252 | @samp{a.out-sunos-big}. |
| 4253 | |
| 4254 | You can also specify a target using a configuration triplet. This is |
| 4255 | the same sort of name that is passed to @file{configure} to specify a |
| 4256 | target. When you use a configuration triplet as an argument, it must be |
| 4257 | fully canonicalized. You can see the canonical version of a triplet by |
| 4258 | running the shell script @file{config.sub} which is included with the |
| 4259 | sources. |
| 4260 | |
| 4261 | Some sample configuration triplets are: @samp{m68k-hp-bsd}, |
| 4262 | @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}. |
| 4263 | |
| 4264 | @subheading @command{objdump} Target |
| 4265 | |
| 4266 | Ways to specify: |
| 4267 | |
| 4268 | @enumerate |
| 4269 | @item |
| 4270 | command line option: @option{-b} or @option{--target} |
| 4271 | |
| 4272 | @item |
| 4273 | environment variable @code{GNUTARGET} |
| 4274 | |
| 4275 | @item |
| 4276 | deduced from the input file |
| 4277 | @end enumerate |
| 4278 | |
| 4279 | @subheading @command{objcopy} and @command{strip} Input Target |
| 4280 | |
| 4281 | Ways to specify: |
| 4282 | |
| 4283 | @enumerate |
| 4284 | @item |
| 4285 | command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target} |
| 4286 | |
| 4287 | @item |
| 4288 | environment variable @code{GNUTARGET} |
| 4289 | |
| 4290 | @item |
| 4291 | deduced from the input file |
| 4292 | @end enumerate |
| 4293 | |
| 4294 | @subheading @command{objcopy} and @command{strip} Output Target |
| 4295 | |
| 4296 | Ways to specify: |
| 4297 | |
| 4298 | @enumerate |
| 4299 | @item |
| 4300 | command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target} |
| 4301 | |
| 4302 | @item |
| 4303 | the input target (see ``@command{objcopy} and @command{strip} Input Target'' above) |
| 4304 | |
| 4305 | @item |
| 4306 | environment variable @code{GNUTARGET} |
| 4307 | |
| 4308 | @item |
| 4309 | deduced from the input file |
| 4310 | @end enumerate |
| 4311 | |
| 4312 | @subheading @command{nm}, @command{size}, and @command{strings} Target |
| 4313 | |
| 4314 | Ways to specify: |
| 4315 | |
| 4316 | @enumerate |
| 4317 | @item |
| 4318 | command line option: @option{--target} |
| 4319 | |
| 4320 | @item |
| 4321 | environment variable @code{GNUTARGET} |
| 4322 | |
| 4323 | @item |
| 4324 | deduced from the input file |
| 4325 | @end enumerate |
| 4326 | |
| 4327 | @node Architecture Selection |
| 4328 | @section Architecture Selection |
| 4329 | |
| 4330 | An @dfn{architecture} is a type of @sc{cpu} on which an object file is |
| 4331 | to run. Its name may contain a colon, separating the name of the |
| 4332 | processor family from the name of the particular @sc{cpu}. |
| 4333 | |
| 4334 | The command to list valid architecture values is @samp{objdump -i} (the |
| 4335 | second column contains the relevant information). |
| 4336 | |
| 4337 | Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}. |
| 4338 | |
| 4339 | @subheading @command{objdump} Architecture |
| 4340 | |
| 4341 | Ways to specify: |
| 4342 | |
| 4343 | @enumerate |
| 4344 | @item |
| 4345 | command line option: @option{-m} or @option{--architecture} |
| 4346 | |
| 4347 | @item |
| 4348 | deduced from the input file |
| 4349 | @end enumerate |
| 4350 | |
| 4351 | @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture |
| 4352 | |
| 4353 | Ways to specify: |
| 4354 | |
| 4355 | @enumerate |
| 4356 | @item |
| 4357 | deduced from the input file |
| 4358 | @end enumerate |
| 4359 | |
| 4360 | @node Reporting Bugs |
| 4361 | @chapter Reporting Bugs |
| 4362 | @cindex bugs |
| 4363 | @cindex reporting bugs |
| 4364 | |
| 4365 | Your bug reports play an essential role in making the binary utilities |
| 4366 | reliable. |
| 4367 | |
| 4368 | Reporting a bug may help you by bringing a solution to your problem, or |
| 4369 | it may not. But in any case the principal function of a bug report is |
| 4370 | to help the entire community by making the next version of the binary |
| 4371 | utilities work better. Bug reports are your contribution to their |
| 4372 | maintenance. |
| 4373 | |
| 4374 | In order for a bug report to serve its purpose, you must include the |
| 4375 | information that enables us to fix the bug. |
| 4376 | |
| 4377 | @menu |
| 4378 | * Bug Criteria:: Have you found a bug? |
| 4379 | * Bug Reporting:: How to report bugs |
| 4380 | @end menu |
| 4381 | |
| 4382 | @node Bug Criteria |
| 4383 | @section Have You Found a Bug? |
| 4384 | @cindex bug criteria |
| 4385 | |
| 4386 | If you are not sure whether you have found a bug, here are some guidelines: |
| 4387 | |
| 4388 | @itemize @bullet |
| 4389 | @cindex fatal signal |
| 4390 | @cindex crash |
| 4391 | @item |
| 4392 | If a binary utility gets a fatal signal, for any input whatever, that is |
| 4393 | a bug. Reliable utilities never crash. |
| 4394 | |
| 4395 | @cindex error on valid input |
| 4396 | @item |
| 4397 | If a binary utility produces an error message for valid input, that is a |
| 4398 | bug. |
| 4399 | |
| 4400 | @item |
| 4401 | If you are an experienced user of binary utilities, your suggestions for |
| 4402 | improvement are welcome in any case. |
| 4403 | @end itemize |
| 4404 | |
| 4405 | @node Bug Reporting |
| 4406 | @section How to Report Bugs |
| 4407 | @cindex bug reports |
| 4408 | @cindex bugs, reporting |
| 4409 | |
| 4410 | A number of companies and individuals offer support for @sc{gnu} |
| 4411 | products. If you obtained the binary utilities from a support |
| 4412 | organization, we recommend you contact that organization first. |
| 4413 | |
| 4414 | You can find contact information for many support companies and |
| 4415 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs |
| 4416 | distribution. |
| 4417 | |
| 4418 | @ifset BUGURL |
| 4419 | In any event, we also recommend that you send bug reports for the binary |
| 4420 | utilities to @value{BUGURL}. |
| 4421 | @end ifset |
| 4422 | |
| 4423 | The fundamental principle of reporting bugs usefully is this: |
| 4424 | @strong{report all the facts}. If you are not sure whether to state a |
| 4425 | fact or leave it out, state it! |
| 4426 | |
| 4427 | Often people omit facts because they think they know what causes the |
| 4428 | problem and assume that some details do not matter. Thus, you might |
| 4429 | assume that the name of a file you use in an example does not matter. |
| 4430 | Well, probably it does not, but one cannot be sure. Perhaps the bug is |
| 4431 | a stray memory reference which happens to fetch from the location where |
| 4432 | that pathname is stored in memory; perhaps, if the pathname were |
| 4433 | different, the contents of that location would fool the utility into |
| 4434 | doing the right thing despite the bug. Play it safe and give a |
| 4435 | specific, complete example. That is the easiest thing for you to do, |
| 4436 | and the most helpful. |
| 4437 | |
| 4438 | Keep in mind that the purpose of a bug report is to enable us to fix the bug if |
| 4439 | it is new to us. Therefore, always write your bug reports on the assumption |
| 4440 | that the bug has not been reported previously. |
| 4441 | |
| 4442 | Sometimes people give a few sketchy facts and ask, ``Does this ring a |
| 4443 | bell?'' This cannot help us fix a bug, so it is basically useless. We |
| 4444 | respond by asking for enough details to enable us to investigate. |
| 4445 | You might as well expedite matters by sending them to begin with. |
| 4446 | |
| 4447 | To enable us to fix the bug, you should include all these things: |
| 4448 | |
| 4449 | @itemize @bullet |
| 4450 | @item |
| 4451 | The version of the utility. Each utility announces it if you start it |
| 4452 | with the @option{--version} argument. |
| 4453 | |
| 4454 | Without this, we will not know whether there is any point in looking for |
| 4455 | the bug in the current version of the binary utilities. |
| 4456 | |
| 4457 | @item |
| 4458 | Any patches you may have applied to the source, including any patches |
| 4459 | made to the @code{BFD} library. |
| 4460 | |
| 4461 | @item |
| 4462 | The type of machine you are using, and the operating system name and |
| 4463 | version number. |
| 4464 | |
| 4465 | @item |
| 4466 | What compiler (and its version) was used to compile the utilities---e.g. |
| 4467 | ``@code{gcc-2.7}''. |
| 4468 | |
| 4469 | @item |
| 4470 | The command arguments you gave the utility to observe the bug. To |
| 4471 | guarantee you will not omit something important, list them all. A copy |
| 4472 | of the Makefile (or the output from make) is sufficient. |
| 4473 | |
| 4474 | If we were to try to guess the arguments, we would probably guess wrong |
| 4475 | and then we might not encounter the bug. |
| 4476 | |
| 4477 | @item |
| 4478 | A complete input file, or set of input files, that will reproduce the |
| 4479 | bug. If the utility is reading an object file or files, then it is |
| 4480 | generally most helpful to send the actual object files. |
| 4481 | |
| 4482 | If the source files were produced exclusively using @sc{gnu} programs |
| 4483 | (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it |
| 4484 | may be OK to send the source files rather than the object files. In |
| 4485 | this case, be sure to say exactly what version of @command{gcc}, or |
| 4486 | whatever, was used to produce the object files. Also say how |
| 4487 | @command{gcc}, or whatever, was configured. |
| 4488 | |
| 4489 | @item |
| 4490 | A description of what behavior you observe that you believe is |
| 4491 | incorrect. For example, ``It gets a fatal signal.'' |
| 4492 | |
| 4493 | Of course, if the bug is that the utility gets a fatal signal, then we |
| 4494 | will certainly notice it. But if the bug is incorrect output, we might |
| 4495 | not notice unless it is glaringly wrong. You might as well not give us |
| 4496 | a chance to make a mistake. |
| 4497 | |
| 4498 | Even if the problem you experience is a fatal signal, you should still |
| 4499 | say so explicitly. Suppose something strange is going on, such as your |
| 4500 | copy of the utility is out of sync, or you have encountered a bug in |
| 4501 | the C library on your system. (This has happened!) Your copy might |
| 4502 | crash and ours would not. If you told us to expect a crash, then when |
| 4503 | ours fails to crash, we would know that the bug was not happening for |
| 4504 | us. If you had not told us to expect a crash, then we would not be able |
| 4505 | to draw any conclusion from our observations. |
| 4506 | |
| 4507 | @item |
| 4508 | If you wish to suggest changes to the source, send us context diffs, as |
| 4509 | generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p} |
| 4510 | option. Always send diffs from the old file to the new file. If you |
| 4511 | wish to discuss something in the @command{ld} source, refer to it by |
| 4512 | context, not by line number. |
| 4513 | |
| 4514 | The line numbers in our development sources will not match those in your |
| 4515 | sources. Your line numbers would convey no useful information to us. |
| 4516 | @end itemize |
| 4517 | |
| 4518 | Here are some things that are not necessary: |
| 4519 | |
| 4520 | @itemize @bullet |
| 4521 | @item |
| 4522 | A description of the envelope of the bug. |
| 4523 | |
| 4524 | Often people who encounter a bug spend a lot of time investigating |
| 4525 | which changes to the input file will make the bug go away and which |
| 4526 | changes will not affect it. |
| 4527 | |
| 4528 | This is often time consuming and not very useful, because the way we |
| 4529 | will find the bug is by running a single example under the debugger |
| 4530 | with breakpoints, not by pure deduction from a series of examples. |
| 4531 | We recommend that you save your time for something else. |
| 4532 | |
| 4533 | Of course, if you can find a simpler example to report @emph{instead} |
| 4534 | of the original one, that is a convenience for us. Errors in the |
| 4535 | output will be easier to spot, running under the debugger will take |
| 4536 | less time, and so on. |
| 4537 | |
| 4538 | However, simplification is not vital; if you do not want to do this, |
| 4539 | report the bug anyway and send us the entire test case you used. |
| 4540 | |
| 4541 | @item |
| 4542 | A patch for the bug. |
| 4543 | |
| 4544 | A patch for the bug does help us if it is a good one. But do not omit |
| 4545 | the necessary information, such as the test case, on the assumption that |
| 4546 | a patch is all we need. We might see problems with your patch and decide |
| 4547 | to fix the problem another way, or we might not understand it at all. |
| 4548 | |
| 4549 | Sometimes with programs as complicated as the binary utilities it is |
| 4550 | very hard to construct an example that will make the program follow a |
| 4551 | certain path through the code. If you do not send us the example, we |
| 4552 | will not be able to construct one, so we will not be able to verify that |
| 4553 | the bug is fixed. |
| 4554 | |
| 4555 | And if we cannot understand what bug you are trying to fix, or why your |
| 4556 | patch should be an improvement, we will not install it. A test case will |
| 4557 | help us to understand. |
| 4558 | |
| 4559 | @item |
| 4560 | A guess about what the bug is or what it depends on. |
| 4561 | |
| 4562 | Such guesses are usually wrong. Even we cannot guess right about such |
| 4563 | things without first using the debugger to find the facts. |
| 4564 | @end itemize |
| 4565 | |
| 4566 | @node GNU Free Documentation License |
| 4567 | @appendix GNU Free Documentation License |
| 4568 | |
| 4569 | @include fdl.texi |
| 4570 | |
| 4571 | @node Binutils Index |
| 4572 | @unnumbered Binutils Index |
| 4573 | |
| 4574 | @printindex cp |
| 4575 | |
| 4576 | @bye |