| 1 | \input texinfo @c -*- Texinfo -*- |
| 2 | @setfilename binutils.info |
| 3 | @c Copyright 2001 Free Software Foundation, Inc. |
| 4 | |
| 5 | @include config.texi |
| 6 | |
| 7 | @ifinfo |
| 8 | @format |
| 9 | START-INFO-DIR-ENTRY |
| 10 | * Binutils: (binutils). The GNU binary utilities. |
| 11 | * ar: (binutils)ar. Create, modify, and extract from archives |
| 12 | * nm: (binutils)nm. List symbols from object files |
| 13 | * objcopy: (binutils)objcopy. Copy and translate object files |
| 14 | * objdump: (binutils)objdump. Display information from object files |
| 15 | * ranlib: (binutils)ranlib. Generate index to archive contents |
| 16 | * readelf: (binutils)readelf. Display the contents of ELF format files. |
| 17 | * size: (binutils)size. List section sizes and total size |
| 18 | * strings: (binutils)strings. List printable strings from files |
| 19 | * strip: (binutils)strip. Discard symbols |
| 20 | * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols |
| 21 | * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt |
| 22 | * addr2line: (binutils)addr2line. Convert addresses to file and line |
| 23 | * nlmconv: (binutils)nlmconv. Converts object code into an NLM |
| 24 | * windres: (binutils)windres. Manipulate Windows resources |
| 25 | * dlltool: (binutils)dlltool. Create files needed to build and use DLLs |
| 26 | END-INFO-DIR-ENTRY |
| 27 | @end format |
| 28 | @end ifinfo |
| 29 | |
| 30 | @ifinfo |
| 31 | @c man begin COPYRIGHT |
| 32 | Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. |
| 33 | |
| 34 | Permission is granted to copy, distribute and/or modify this document |
| 35 | under the terms of the GNU Free Documentation License, Version 1.1 |
| 36 | or any later version published by the Free Software Foundation; |
| 37 | with no Invariant Sections, with no Front-Cover Texts, and with no |
| 38 | Back-Cover Texts. A copy of the license is included in the |
| 39 | section entitled "GNU Free Documentation License". |
| 40 | |
| 41 | @c man end |
| 42 | @ignore |
| 43 | Permission is granted to process this file through TeX and print the |
| 44 | results, provided the printed document carries a copying permission |
| 45 | notice identical to this one except for the removal of this paragraph |
| 46 | (this paragraph not being relevant to the printed manual). |
| 47 | |
| 48 | @end ignore |
| 49 | @end ifinfo |
| 50 | |
| 51 | @synindex ky cp |
| 52 | @c |
| 53 | @c This file documents the GNU binary utilities "ar", "ld", "objcopy", |
| 54 | @c "objdump", "nm", "size", "strings", "strip", "readelf" and "ranlib". |
| 55 | @c |
| 56 | @c Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. |
| 57 | @c |
| 58 | @c This text may be freely distributed under the terms of the GNU |
| 59 | @c Free Documentation License. |
| 60 | @c |
| 61 | |
| 62 | @setchapternewpage odd |
| 63 | @settitle @sc{gnu} Binary Utilities |
| 64 | @titlepage |
| 65 | @finalout |
| 66 | @title The @sc{gnu} Binary Utilities |
| 67 | @subtitle Version @value{VERSION} |
| 68 | @sp 1 |
| 69 | @subtitle May 1993 |
| 70 | @author Roland H. Pesch |
| 71 | @author Jeffrey M. Osier |
| 72 | @author Cygnus Support |
| 73 | @page |
| 74 | |
| 75 | @tex |
| 76 | {\parskip=0pt \hfill Cygnus Support\par \hfill |
| 77 | \TeX{}info \texinfoversion\par } |
| 78 | @end tex |
| 79 | |
| 80 | @vskip 0pt plus 1filll |
| 81 | Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 1998, 2000, 2001 Free Software Foundation, Inc. |
| 82 | |
| 83 | Permission is granted to copy, distribute and/or modify this document |
| 84 | under the terms of the GNU Free Documentation License, Version 1.1 |
| 85 | or any later version published by the Free Software Foundation; |
| 86 | with no Invariant Sections, with no Front-Cover Texts, and with no |
| 87 | Back-Cover Texts. A copy of the license is included in the |
| 88 | section entitled "GNU Free Documentation License". |
| 89 | |
| 90 | @end titlepage |
| 91 | |
| 92 | @node Top |
| 93 | @top Introduction |
| 94 | |
| 95 | @cindex version |
| 96 | This brief manual contains preliminary documentation for the @sc{gnu} binary |
| 97 | utilities (collectively version @value{VERSION}): |
| 98 | |
| 99 | @iftex |
| 100 | @table @code |
| 101 | @item ar |
| 102 | Create, modify, and extract from archives |
| 103 | |
| 104 | @item nm |
| 105 | List symbols from object files |
| 106 | |
| 107 | @item objcopy |
| 108 | Copy and translate object files |
| 109 | |
| 110 | @item objdump |
| 111 | Display information from object files |
| 112 | |
| 113 | @item ranlib |
| 114 | Generate index to archive contents |
| 115 | |
| 116 | @item readelf |
| 117 | Display the contents of ELF format files. |
| 118 | |
| 119 | @item size |
| 120 | List file section sizes and total size |
| 121 | |
| 122 | @item strings |
| 123 | List printable strings from files |
| 124 | |
| 125 | @item strip |
| 126 | Discard symbols |
| 127 | |
| 128 | @item c++filt |
| 129 | Demangle encoded C++ symbols (on MS-DOS, this program is named |
| 130 | @code{cxxfilt}) |
| 131 | |
| 132 | @item addr2line |
| 133 | Convert addresses into file names and line numbers |
| 134 | |
| 135 | @item nlmconv |
| 136 | Convert object code into a Netware Loadable Module |
| 137 | |
| 138 | @item windres |
| 139 | Manipulate Windows resources |
| 140 | |
| 141 | @item dlltool |
| 142 | Create the files needed to build and use Dynamic Link Libraries |
| 143 | @end table |
| 144 | @end iftex |
| 145 | |
| 146 | This document is distributed under the terms of the GNU Free |
| 147 | Documentation License. A copy of the license is included in the |
| 148 | section entitled "GNU Free Documentation License". |
| 149 | |
| 150 | @menu |
| 151 | * ar:: Create, modify, and extract from archives |
| 152 | * nm:: List symbols from object files |
| 153 | * objcopy:: Copy and translate object files |
| 154 | * objdump:: Display information from object files |
| 155 | * ranlib:: Generate index to archive contents |
| 156 | * readelf:: Display the contents of ELF format files. |
| 157 | * size:: List section sizes and total size |
| 158 | * strings:: List printable strings from files |
| 159 | * strip:: Discard symbols |
| 160 | * c++filt:: Filter to demangle encoded C++ symbols |
| 161 | * cxxfilt: c++filt. MS-DOS name for c++filt |
| 162 | * addr2line:: Convert addresses to file and line |
| 163 | * nlmconv:: Converts object code into an NLM |
| 164 | * windres:: Manipulate Windows resources |
| 165 | * dlltool:: Create files needed to build and use DLLs |
| 166 | * Selecting The Target System:: How these utilities determine the target. |
| 167 | * Reporting Bugs:: Reporting Bugs |
| 168 | * GNU Free Documentation License:: GNU Free Documentation License |
| 169 | * Index:: Index |
| 170 | @end menu |
| 171 | |
| 172 | @node ar |
| 173 | @chapter ar |
| 174 | |
| 175 | @kindex ar |
| 176 | @cindex archives |
| 177 | @cindex collections of files |
| 178 | |
| 179 | @c man title ar create, modify, and extract from archives |
| 180 | |
| 181 | @smallexample |
| 182 | ar [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}] |
| 183 | ar -M [ <mri-script ] |
| 184 | @end smallexample |
| 185 | |
| 186 | @c man begin DESCRIPTION ar |
| 187 | |
| 188 | The @sc{gnu} @command{ar} program creates, modifies, and extracts from |
| 189 | archives. An @dfn{archive} is a single file holding a collection of |
| 190 | other files in a structure that makes it possible to retrieve |
| 191 | the original individual files (called @dfn{members} of the archive). |
| 192 | |
| 193 | The original files' contents, mode (permissions), timestamp, owner, and |
| 194 | group are preserved in the archive, and can be restored on |
| 195 | extraction. |
| 196 | |
| 197 | @cindex name length |
| 198 | @sc{gnu} @command{ar} can maintain archives whose members have names of any |
| 199 | length; however, depending on how @command{ar} is configured on your |
| 200 | system, a limit on member-name length may be imposed for compatibility |
| 201 | with archive formats maintained with other tools. If it exists, the |
| 202 | limit is often 15 characters (typical of formats related to a.out) or 16 |
| 203 | characters (typical of formats related to coff). |
| 204 | |
| 205 | @cindex libraries |
| 206 | @command{ar} is considered a binary utility because archives of this sort |
| 207 | are most often used as @dfn{libraries} holding commonly needed |
| 208 | subroutines. |
| 209 | |
| 210 | @cindex symbol index |
| 211 | @command{ar} creates an index to the symbols defined in relocatable |
| 212 | object modules in the archive when you specify the modifier @samp{s}. |
| 213 | Once created, this index is updated in the archive whenever @command{ar} |
| 214 | makes a change to its contents (save for the @samp{q} update operation). |
| 215 | An archive with such an index speeds up linking to the library, and |
| 216 | allows routines in the library to call each other without regard to |
| 217 | their placement in the archive. |
| 218 | |
| 219 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index |
| 220 | table. If an archive lacks the table, another form of @command{ar} called |
| 221 | @command{ranlib} can be used to add just the table. |
| 222 | |
| 223 | @cindex compatibility, @command{ar} |
| 224 | @cindex @command{ar} compatibility |
| 225 | @sc{gnu} @command{ar} is designed to be compatible with two different |
| 226 | facilities. You can control its activity using command-line options, |
| 227 | like the different varieties of @command{ar} on Unix systems; or, if you |
| 228 | specify the single command-line option @option{-M}, you can control it |
| 229 | with a script supplied via standard input, like the MRI ``librarian'' |
| 230 | program. |
| 231 | |
| 232 | @c man end |
| 233 | |
| 234 | @menu |
| 235 | * ar cmdline:: Controlling @command{ar} on the command line |
| 236 | * ar scripts:: Controlling @command{ar} with a script |
| 237 | @end menu |
| 238 | |
| 239 | @page |
| 240 | @node ar cmdline |
| 241 | @section Controlling @command{ar} on the command line |
| 242 | |
| 243 | @smallexample |
| 244 | @c man begin SYNOPSIS ar |
| 245 | ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}] |
| 246 | @c man end |
| 247 | @end smallexample |
| 248 | |
| 249 | @cindex Unix compatibility, @command{ar} |
| 250 | When you use @command{ar} in the Unix style, @command{ar} insists on at least two |
| 251 | arguments to execute: one keyletter specifying the @emph{operation} |
| 252 | (optionally accompanied by other keyletters specifying |
| 253 | @emph{modifiers}), and the archive name to act on. |
| 254 | |
| 255 | Most operations can also accept further @var{member} arguments, |
| 256 | specifying particular files to operate on. |
| 257 | |
| 258 | @c man begin OPTIONS ar |
| 259 | |
| 260 | @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier |
| 261 | flags @var{mod} in any order, within the first command-line argument. |
| 262 | |
| 263 | If you wish, you may begin the first command-line argument with a |
| 264 | dash. |
| 265 | |
| 266 | @cindex operations on archive |
| 267 | The @var{p} keyletter specifies what operation to execute; it may be |
| 268 | any of the following, but you must specify only one of them: |
| 269 | |
| 270 | @table @samp |
| 271 | @item d |
| 272 | @cindex deleting from archive |
| 273 | @emph{Delete} modules from the archive. Specify the names of modules to |
| 274 | be deleted as @var{member}@dots{}; the archive is untouched if you |
| 275 | specify no files to delete. |
| 276 | |
| 277 | If you specify the @samp{v} modifier, @command{ar} lists each module |
| 278 | as it is deleted. |
| 279 | |
| 280 | @item m |
| 281 | @cindex moving in archive |
| 282 | Use this operation to @emph{move} members in an archive. |
| 283 | |
| 284 | The ordering of members in an archive can make a difference in how |
| 285 | programs are linked using the library, if a symbol is defined in more |
| 286 | than one member. |
| 287 | |
| 288 | If no modifiers are used with @code{m}, any members you name in the |
| 289 | @var{member} arguments are moved to the @emph{end} of the archive; |
| 290 | you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a |
| 291 | specified place instead. |
| 292 | |
| 293 | @item p |
| 294 | @cindex printing from archive |
| 295 | @emph{Print} the specified members of the archive, to the standard |
| 296 | output file. If the @samp{v} modifier is specified, show the member |
| 297 | name before copying its contents to standard output. |
| 298 | |
| 299 | If you specify no @var{member} arguments, all the files in the archive are |
| 300 | printed. |
| 301 | |
| 302 | @item q |
| 303 | @cindex quick append to archive |
| 304 | @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of |
| 305 | @var{archive}, without checking for replacement. |
| 306 | |
| 307 | The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this |
| 308 | operation; new members are always placed at the end of the archive. |
| 309 | |
| 310 | The modifier @samp{v} makes @command{ar} list each file as it is appended. |
| 311 | |
| 312 | Since the point of this operation is speed, the archive's symbol table |
| 313 | index is not updated, even if it already existed; you can use @samp{ar s} or |
| 314 | @command{ranlib} explicitly to update the symbol table index. |
| 315 | |
| 316 | However, too many different systems assume quick append rebuilds the |
| 317 | index, so GNU ar implements @code{q} as a synonym for @code{r}. |
| 318 | |
| 319 | @item r |
| 320 | @cindex replacement in archive |
| 321 | Insert the files @var{member}@dots{} into @var{archive} (with |
| 322 | @emph{replacement}). This operation differs from @samp{q} in that any |
| 323 | previously existing members are deleted if their names match those being |
| 324 | added. |
| 325 | |
| 326 | If one of the files named in @var{member}@dots{} does not exist, @command{ar} |
| 327 | displays an error message, and leaves undisturbed any existing members |
| 328 | of the archive matching that name. |
| 329 | |
| 330 | By default, new members are added at the end of the file; but you may |
| 331 | use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request |
| 332 | placement relative to some existing member. |
| 333 | |
| 334 | The modifier @samp{v} used with this operation elicits a line of |
| 335 | output for each file inserted, along with one of the letters @samp{a} or |
| 336 | @samp{r} to indicate whether the file was appended (no old member |
| 337 | deleted) or replaced. |
| 338 | |
| 339 | @item t |
| 340 | @cindex contents of archive |
| 341 | Display a @emph{table} listing the contents of @var{archive}, or those |
| 342 | of the files listed in @var{member}@dots{} that are present in the |
| 343 | archive. Normally only the member name is shown; if you also want to |
| 344 | see the modes (permissions), timestamp, owner, group, and size, you can |
| 345 | request that by also specifying the @samp{v} modifier. |
| 346 | |
| 347 | If you do not specify a @var{member}, all files in the archive |
| 348 | are listed. |
| 349 | |
| 350 | @cindex repeated names in archive |
| 351 | @cindex name duplication in archive |
| 352 | If there is more than one file with the same name (say, @samp{fie}) in |
| 353 | an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the |
| 354 | first instance; to see them all, you must ask for a complete |
| 355 | listing---in our example, @samp{ar t b.a}. |
| 356 | @c WRS only; per Gumby, this is implementation-dependent, and in a more |
| 357 | @c recent case in fact works the other way. |
| 358 | |
| 359 | @item x |
| 360 | @cindex extract from archive |
| 361 | @emph{Extract} members (named @var{member}) from the archive. You can |
| 362 | use the @samp{v} modifier with this operation, to request that |
| 363 | @command{ar} list each name as it extracts it. |
| 364 | |
| 365 | If you do not specify a @var{member}, all files in the archive |
| 366 | are extracted. |
| 367 | |
| 368 | @end table |
| 369 | |
| 370 | A number of modifiers (@var{mod}) may immediately follow the @var{p} |
| 371 | keyletter, to specify variations on an operation's behavior: |
| 372 | |
| 373 | @table @samp |
| 374 | @item a |
| 375 | @cindex relative placement in archive |
| 376 | Add new files @emph{after} an existing member of the |
| 377 | archive. If you use the modifier @samp{a}, the name of an existing archive |
| 378 | member must be present as the @var{relpos} argument, before the |
| 379 | @var{archive} specification. |
| 380 | |
| 381 | @item b |
| 382 | Add new files @emph{before} an existing member of the |
| 383 | archive. If you use the modifier @samp{b}, the name of an existing archive |
| 384 | member must be present as the @var{relpos} argument, before the |
| 385 | @var{archive} specification. (same as @samp{i}). |
| 386 | |
| 387 | @item c |
| 388 | @cindex creating archives |
| 389 | @emph{Create} the archive. The specified @var{archive} is always |
| 390 | created if it did not exist, when you request an update. But a warning is |
| 391 | issued unless you specify in advance that you expect to create it, by |
| 392 | using this modifier. |
| 393 | |
| 394 | @item f |
| 395 | Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file |
| 396 | names of any length. This will cause it to create archives which are |
| 397 | not compatible with the native @command{ar} program on some systems. If |
| 398 | this is a concern, the @samp{f} modifier may be used to truncate file |
| 399 | names when putting them in the archive. |
| 400 | |
| 401 | @item i |
| 402 | Insert new files @emph{before} an existing member of the |
| 403 | archive. If you use the modifier @samp{i}, the name of an existing archive |
| 404 | member must be present as the @var{relpos} argument, before the |
| 405 | @var{archive} specification. (same as @samp{b}). |
| 406 | |
| 407 | @item l |
| 408 | This modifier is accepted but not used. |
| 409 | @c whaffor ar l modifier??? presumably compat; with |
| 410 | @c what???---doc@@cygnus.com, 25jan91 |
| 411 | |
| 412 | @item N |
| 413 | Uses the @var{count} parameter. This is used if there are multiple |
| 414 | entries in the archive with the same name. Extract or delete instance |
| 415 | @var{count} of the given name from the archive. |
| 416 | |
| 417 | @item o |
| 418 | @cindex dates in archive |
| 419 | Preserve the @emph{original} dates of members when extracting them. If |
| 420 | you do not specify this modifier, files extracted from the archive |
| 421 | are stamped with the time of extraction. |
| 422 | |
| 423 | @item P |
| 424 | Use the full path name when matching names in the archive. @sc{gnu} |
| 425 | @command{ar} can not create an archive with a full path name (such archives |
| 426 | are not POSIX complaint), but other archive creators can. This option |
| 427 | will cause @sc{gnu} @command{ar} to match file names using a complete path |
| 428 | name, which can be convenient when extracting a single file from an |
| 429 | archive created by another tool. |
| 430 | |
| 431 | @item s |
| 432 | @cindex writing archive index |
| 433 | Write an object-file index into the archive, or update an existing one, |
| 434 | even if no other change is made to the archive. You may use this modifier |
| 435 | flag either with any operation, or alone. Running @samp{ar s} on an |
| 436 | archive is equivalent to running @samp{ranlib} on it. |
| 437 | |
| 438 | @item S |
| 439 | @cindex not writing archive index |
| 440 | Do not generate an archive symbol table. This can speed up building a |
| 441 | large library in several steps. The resulting archive can not be used |
| 442 | with the linker. In order to build a symbol table, you must omit the |
| 443 | @samp{S} modifier on the last execution of @samp{ar}, or you must run |
| 444 | @samp{ranlib} on the archive. |
| 445 | |
| 446 | @item u |
| 447 | @cindex updating an archive |
| 448 | Normally, @samp{ar r}@dots{} inserts all files |
| 449 | listed into the archive. If you would like to insert @emph{only} those |
| 450 | of the files you list that are newer than existing members of the same |
| 451 | names, use this modifier. The @samp{u} modifier is allowed only for the |
| 452 | operation @samp{r} (replace). In particular, the combination @samp{qu} is |
| 453 | not allowed, since checking the timestamps would lose any speed |
| 454 | advantage from the operation @samp{q}. |
| 455 | |
| 456 | @item v |
| 457 | This modifier requests the @emph{verbose} version of an operation. Many |
| 458 | operations display additional information, such as filenames processed, |
| 459 | when the modifier @samp{v} is appended. |
| 460 | |
| 461 | @item V |
| 462 | This modifier shows the version number of @command{ar}. |
| 463 | @end table |
| 464 | |
| 465 | @command{ar} ignores an initial option spelt @samp{-X32_64}, for |
| 466 | compatibility with AIX. The behaviour produced by this option is the |
| 467 | default for GNU @command{ar}. @command{ar} does not support any of the other |
| 468 | @samp{-X} options; in particular, it does not support @option{-X32} |
| 469 | which is the default for AIX @command{ar}. |
| 470 | |
| 471 | @c man end |
| 472 | |
| 473 | @ignore |
| 474 | @c man begin SEEALSO ar |
| 475 | nm(1), ranlib(1), and the Info entries for @file{binutils}. |
| 476 | @c man end |
| 477 | @end ignore |
| 478 | |
| 479 | @node ar scripts |
| 480 | @section Controlling @command{ar} with a script |
| 481 | |
| 482 | @smallexample |
| 483 | ar -M [ <@var{script} ] |
| 484 | @end smallexample |
| 485 | |
| 486 | @cindex MRI compatibility, @command{ar} |
| 487 | @cindex scripts, @command{ar} |
| 488 | If you use the single command-line option @samp{-M} with @command{ar}, you |
| 489 | can control its operation with a rudimentary command language. This |
| 490 | form of @command{ar} operates interactively if standard input is coming |
| 491 | directly from a terminal. During interactive use, @command{ar} prompts for |
| 492 | input (the prompt is @samp{AR >}), and continues executing even after |
| 493 | errors. If you redirect standard input to a script file, no prompts are |
| 494 | issued, and @command{ar} abandons execution (with a nonzero exit code) |
| 495 | on any error. |
| 496 | |
| 497 | The @command{ar} command language is @emph{not} designed to be equivalent |
| 498 | to the command-line options; in fact, it provides somewhat less control |
| 499 | over archives. The only purpose of the command language is to ease the |
| 500 | transition to @sc{gnu} @command{ar} for developers who already have scripts |
| 501 | written for the MRI ``librarian'' program. |
| 502 | |
| 503 | The syntax for the @command{ar} command language is straightforward: |
| 504 | @itemize @bullet |
| 505 | @item |
| 506 | commands are recognized in upper or lower case; for example, @code{LIST} |
| 507 | is the same as @code{list}. In the following descriptions, commands are |
| 508 | shown in upper case for clarity. |
| 509 | |
| 510 | @item |
| 511 | a single command may appear on each line; it is the first word on the |
| 512 | line. |
| 513 | |
| 514 | @item |
| 515 | empty lines are allowed, and have no effect. |
| 516 | |
| 517 | @item |
| 518 | comments are allowed; text after either of the characters @samp{*} |
| 519 | or @samp{;} is ignored. |
| 520 | |
| 521 | @item |
| 522 | Whenever you use a list of names as part of the argument to an @command{ar} |
| 523 | command, you can separate the individual names with either commas or |
| 524 | blanks. Commas are shown in the explanations below, for clarity. |
| 525 | |
| 526 | @item |
| 527 | @samp{+} is used as a line continuation character; if @samp{+} appears |
| 528 | at the end of a line, the text on the following line is considered part |
| 529 | of the current command. |
| 530 | @end itemize |
| 531 | |
| 532 | Here are the commands you can use in @command{ar} scripts, or when using |
| 533 | @command{ar} interactively. Three of them have special significance: |
| 534 | |
| 535 | @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is |
| 536 | a temporary file required for most of the other commands. |
| 537 | |
| 538 | @code{SAVE} commits the changes so far specified by the script. Prior |
| 539 | to @code{SAVE}, commands affect only the temporary copy of the current |
| 540 | archive. |
| 541 | |
| 542 | @table @code |
| 543 | @item ADDLIB @var{archive} |
| 544 | @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module}) |
| 545 | Add all the contents of @var{archive} (or, if specified, each named |
| 546 | @var{module} from @var{archive}) to the current archive. |
| 547 | |
| 548 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 549 | |
| 550 | @item ADDMOD @var{member}, @var{member}, @dots{} @var{member} |
| 551 | @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}" |
| 552 | @c else like "ar q..." |
| 553 | Add each named @var{member} as a module in the current archive. |
| 554 | |
| 555 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 556 | |
| 557 | @item CLEAR |
| 558 | Discard the contents of the current archive, canceling the effect of |
| 559 | any operations since the last @code{SAVE}. May be executed (with no |
| 560 | effect) even if no current archive is specified. |
| 561 | |
| 562 | @item CREATE @var{archive} |
| 563 | Creates an archive, and makes it the current archive (required for many |
| 564 | other commands). The new archive is created with a temporary name; it |
| 565 | is not actually saved as @var{archive} until you use @code{SAVE}. |
| 566 | You can overwrite existing archives; similarly, the contents of any |
| 567 | existing file named @var{archive} will not be destroyed until @code{SAVE}. |
| 568 | |
| 569 | @item DELETE @var{module}, @var{module}, @dots{} @var{module} |
| 570 | Delete each listed @var{module} from the current archive; equivalent to |
| 571 | @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}. |
| 572 | |
| 573 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 574 | |
| 575 | @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) |
| 576 | @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile} |
| 577 | List each named @var{module} present in @var{archive}. The separate |
| 578 | command @code{VERBOSE} specifies the form of the output: when verbose |
| 579 | output is off, output is like that of @samp{ar -t @var{archive} |
| 580 | @var{module}@dots{}}. When verbose output is on, the listing is like |
| 581 | @samp{ar -tv @var{archive} @var{module}@dots{}}. |
| 582 | |
| 583 | Output normally goes to the standard output stream; however, if you |
| 584 | specify @var{outputfile} as a final argument, @command{ar} directs the |
| 585 | output to that file. |
| 586 | |
| 587 | @item END |
| 588 | Exit from @command{ar}, with a @code{0} exit code to indicate successful |
| 589 | completion. This command does not save the output file; if you have |
| 590 | changed the current archive since the last @code{SAVE} command, those |
| 591 | changes are lost. |
| 592 | |
| 593 | @item EXTRACT @var{module}, @var{module}, @dots{} @var{module} |
| 594 | Extract each named @var{module} from the current archive, writing them |
| 595 | into the current directory as separate files. Equivalent to @samp{ar -x |
| 596 | @var{archive} @var{module}@dots{}}. |
| 597 | |
| 598 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 599 | |
| 600 | @ignore |
| 601 | @c FIXME Tokens but no commands??? |
| 602 | @item FULLDIR |
| 603 | |
| 604 | @item HELP |
| 605 | @end ignore |
| 606 | |
| 607 | @item LIST |
| 608 | Display full contents of the current archive, in ``verbose'' style |
| 609 | regardless of the state of @code{VERBOSE}. The effect is like @samp{ar |
| 610 | tv @var{archive}}. (This single command is a @sc{gnu} @command{ar} |
| 611 | enhancement, rather than present for MRI compatibility.) |
| 612 | |
| 613 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 614 | |
| 615 | @item OPEN @var{archive} |
| 616 | Opens an existing archive for use as the current archive (required for |
| 617 | many other commands). Any changes as the result of subsequent commands |
| 618 | will not actually affect @var{archive} until you next use @code{SAVE}. |
| 619 | |
| 620 | @item REPLACE @var{module}, @var{module}, @dots{} @var{module} |
| 621 | In the current archive, replace each existing @var{module} (named in |
| 622 | the @code{REPLACE} arguments) from files in the current working directory. |
| 623 | To execute this command without errors, both the file, and the module in |
| 624 | the current archive, must exist. |
| 625 | |
| 626 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 627 | |
| 628 | @item VERBOSE |
| 629 | Toggle an internal flag governing the output from @code{DIRECTORY}. |
| 630 | When the flag is on, @code{DIRECTORY} output matches output from |
| 631 | @samp{ar -tv }@dots{}. |
| 632 | |
| 633 | @item SAVE |
| 634 | Commit your changes to the current archive, and actually save it as a |
| 635 | file with the name specified in the last @code{CREATE} or @code{OPEN} |
| 636 | command. |
| 637 | |
| 638 | Requires prior use of @code{OPEN} or @code{CREATE}. |
| 639 | |
| 640 | @end table |
| 641 | |
| 642 | @iftex |
| 643 | @node ld |
| 644 | @chapter ld |
| 645 | @cindex linker |
| 646 | @kindex ld |
| 647 | The @sc{gnu} linker @command{ld} is now described in a separate manual. |
| 648 | @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}. |
| 649 | @end iftex |
| 650 | |
| 651 | @node nm |
| 652 | @chapter nm |
| 653 | @cindex symbols |
| 654 | @kindex nm |
| 655 | |
| 656 | @c man title nm list symbols from object files |
| 657 | |
| 658 | @smallexample |
| 659 | @c man begin SYNOPSIS nm |
| 660 | nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}] |
| 661 | [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}] |
| 662 | [@option{-s}|@option{--print-armap}] [@option{-A}|@option{-o}|@option{--print-file-name}] |
| 663 | [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}] |
| 664 | [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}] |
| 665 | [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}] |
| 666 | [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}] |
| 667 | [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}] |
| 668 | [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}] |
| 669 | @c man end |
| 670 | @end smallexample |
| 671 | |
| 672 | @c man begin DESCRIPTION nm |
| 673 | @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}. |
| 674 | If no object files are listed as arguments, @command{nm} assumes the file |
| 675 | @file{a.out}. |
| 676 | |
| 677 | For each symbol, @command{nm} shows: |
| 678 | |
| 679 | @itemize @bullet |
| 680 | @item |
| 681 | The symbol value, in the radix selected by options (see below), or |
| 682 | hexadecimal by default. |
| 683 | |
| 684 | @item |
| 685 | The symbol type. At least the following types are used; others are, as |
| 686 | well, depending on the object file format. If lowercase, the symbol is |
| 687 | local; if uppercase, the symbol is global (external). |
| 688 | |
| 689 | @c Some more detail on exactly what these symbol types are used for |
| 690 | @c would be nice. |
| 691 | @table @code |
| 692 | @item A |
| 693 | The symbol's value is absolute, and will not be changed by further |
| 694 | linking. |
| 695 | |
| 696 | @item B |
| 697 | The symbol is in the uninitialized data section (known as BSS). |
| 698 | |
| 699 | @item C |
| 700 | The symbol is common. Common symbols are uninitialized data. When |
| 701 | linking, multiple common symbols may appear with the same name. If the |
| 702 | symbol is defined anywhere, the common symbols are treated as undefined |
| 703 | references. |
| 704 | @ifclear man |
| 705 | For more details on common symbols, see the discussion of |
| 706 | --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}. |
| 707 | @end ifclear |
| 708 | |
| 709 | @item D |
| 710 | The symbol is in the initialized data section. |
| 711 | |
| 712 | @item G |
| 713 | The symbol is in an initialized data section for small objects. Some |
| 714 | object file formats permit more efficient access to small data objects, |
| 715 | such as a global int variable as opposed to a large global array. |
| 716 | |
| 717 | @item I |
| 718 | The symbol is an indirect reference to another symbol. This is a GNU |
| 719 | extension to the a.out object file format which is rarely used. |
| 720 | |
| 721 | @item N |
| 722 | The symbol is a debugging symbol. |
| 723 | |
| 724 | @item R |
| 725 | The symbol is in a read only data section. |
| 726 | |
| 727 | @item S |
| 728 | The symbol is in an uninitialized data section for small objects. |
| 729 | |
| 730 | @item T |
| 731 | The symbol is in the text (code) section. |
| 732 | |
| 733 | @item U |
| 734 | The symbol is undefined. |
| 735 | |
| 736 | @item V |
| 737 | The symbol is a weak object. When a weak defined symbol is linked with |
| 738 | a normal defined symbol, the normal defined symbol is used with no error. |
| 739 | When a weak undefined symbol is linked and the symbol is not defined, |
| 740 | the value of the weak symbol becomes zero with no error. |
| 741 | |
| 742 | @item W |
| 743 | The symbol is a weak symbol that has not been specifically tagged as a |
| 744 | weak object symbol. When a weak defined symbol is linked with a normal |
| 745 | defined symbol, the normal defined symbol is used with no error. |
| 746 | When a weak undefined symbol is linked and the symbol is not defined, |
| 747 | the value of the weak symbol becomes zero with no error. |
| 748 | |
| 749 | @item - |
| 750 | The symbol is a stabs symbol in an a.out object file. In this case, the |
| 751 | next values printed are the stabs other field, the stabs desc field, and |
| 752 | the stab type. Stabs symbols are used to hold debugging information. |
| 753 | @ifclear man |
| 754 | For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The |
| 755 | ``stabs'' debug format}. |
| 756 | @end ifclear |
| 757 | |
| 758 | @item ? |
| 759 | The symbol type is unknown, or object file format specific. |
| 760 | @end table |
| 761 | |
| 762 | @item |
| 763 | The symbol name. |
| 764 | @end itemize |
| 765 | |
| 766 | @c man end |
| 767 | |
| 768 | @c man begin OPTIONS nm |
| 769 | The long and short forms of options, shown here as alternatives, are |
| 770 | equivalent. |
| 771 | |
| 772 | @table @env |
| 773 | @item -A |
| 774 | @itemx -o |
| 775 | @itemx --print-file-name |
| 776 | @cindex input file name |
| 777 | @cindex file name |
| 778 | @cindex source file name |
| 779 | Precede each symbol by the name of the input file (or archive member) |
| 780 | in which it was found, rather than identifying the input file once only, |
| 781 | before all of its symbols. |
| 782 | |
| 783 | @item -a |
| 784 | @itemx --debug-syms |
| 785 | @cindex debugging symbols |
| 786 | Display all symbols, even debugger-only symbols; normally these are not |
| 787 | listed. |
| 788 | |
| 789 | @item -B |
| 790 | @cindex @command{nm} format |
| 791 | @cindex @command{nm} compatibility |
| 792 | The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}). |
| 793 | |
| 794 | @item -C |
| 795 | @itemx --demangle[=@var{style}] |
| 796 | @cindex demangling in nm |
| 797 | Decode (@dfn{demangle}) low-level symbol names into user-level names. |
| 798 | Besides removing any initial underscore prepended by the system, this |
| 799 | makes C++ function names readable. Different compilers have different |
| 800 | mangling styles. The optional demangling style argument can be used to |
| 801 | choose an appropriate demangling style for your compiler. @xref{c++filt}, |
| 802 | for more information on demangling. |
| 803 | |
| 804 | @item --no-demangle |
| 805 | Do not demangle low-level symbol names. This is the default. |
| 806 | |
| 807 | @item -D |
| 808 | @itemx --dynamic |
| 809 | @cindex dynamic symbols |
| 810 | Display the dynamic symbols rather than the normal symbols. This is |
| 811 | only meaningful for dynamic objects, such as certain types of shared |
| 812 | libraries. |
| 813 | |
| 814 | @item -f @var{format} |
| 815 | @itemx --format=@var{format} |
| 816 | @cindex @command{nm} format |
| 817 | @cindex @command{nm} compatibility |
| 818 | Use the output format @var{format}, which can be @code{bsd}, |
| 819 | @code{sysv}, or @code{posix}. The default is @code{bsd}. |
| 820 | Only the first character of @var{format} is significant; it can be |
| 821 | either upper or lower case. |
| 822 | |
| 823 | @item -g |
| 824 | @itemx --extern-only |
| 825 | @cindex external symbols |
| 826 | Display only external symbols. |
| 827 | |
| 828 | @item -l |
| 829 | @itemx --line-numbers |
| 830 | @cindex symbol line numbers |
| 831 | For each symbol, use debugging information to try to find a filename and |
| 832 | line number. For a defined symbol, look for the line number of the |
| 833 | address of the symbol. For an undefined symbol, look for the line |
| 834 | number of a relocation entry which refers to the symbol. If line number |
| 835 | information can be found, print it after the other symbol information. |
| 836 | |
| 837 | @item -n |
| 838 | @itemx -v |
| 839 | @itemx --numeric-sort |
| 840 | Sort symbols numerically by their addresses, rather than alphabetically |
| 841 | by their names. |
| 842 | |
| 843 | @item -p |
| 844 | @itemx --no-sort |
| 845 | @cindex sorting symbols |
| 846 | Do not bother to sort the symbols in any order; print them in the order |
| 847 | encountered. |
| 848 | |
| 849 | @item -P |
| 850 | @itemx --portability |
| 851 | Use the POSIX.2 standard output format instead of the default format. |
| 852 | Equivalent to @samp{-f posix}. |
| 853 | |
| 854 | @item -s |
| 855 | @itemx --print-armap |
| 856 | @cindex symbol index, listing |
| 857 | When listing symbols from archive members, include the index: a mapping |
| 858 | (stored in the archive by @command{ar} or @command{ranlib}) of which modules |
| 859 | contain definitions for which names. |
| 860 | |
| 861 | @item -r |
| 862 | @itemx --reverse-sort |
| 863 | Reverse the order of the sort (whether numeric or alphabetic); let the |
| 864 | last come first. |
| 865 | |
| 866 | @item --size-sort |
| 867 | Sort symbols by size. The size is computed as the difference between |
| 868 | the value of the symbol and the value of the symbol with the next higher |
| 869 | value. The size of the symbol is printed, rather than the value. |
| 870 | |
| 871 | @item -t @var{radix} |
| 872 | @itemx --radix=@var{radix} |
| 873 | Use @var{radix} as the radix for printing the symbol values. It must be |
| 874 | @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal. |
| 875 | |
| 876 | @item --target=@var{bfdname} |
| 877 | @cindex object code format |
| 878 | Specify an object code format other than your system's default format. |
| 879 | @xref{Target Selection}, for more information. |
| 880 | |
| 881 | @item -u |
| 882 | @itemx --undefined-only |
| 883 | @cindex external symbols |
| 884 | @cindex undefined symbols |
| 885 | Display only undefined symbols (those external to each object file). |
| 886 | |
| 887 | @item --defined-only |
| 888 | @cindex external symbols |
| 889 | @cindex undefined symbols |
| 890 | Display only defined symbols for each object file. |
| 891 | |
| 892 | @item -V |
| 893 | @itemx --version |
| 894 | Show the version number of @command{nm} and exit. |
| 895 | |
| 896 | @item -X |
| 897 | This option is ignored for compatibility with the AIX version of |
| 898 | @command{nm}. It takes one parameter which must be the string |
| 899 | @option{32_64}. The default mode of AIX @command{nm} corresponds |
| 900 | to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}. |
| 901 | |
| 902 | @item --help |
| 903 | Show a summary of the options to @command{nm} and exit. |
| 904 | @end table |
| 905 | |
| 906 | @c man end |
| 907 | |
| 908 | @ignore |
| 909 | @c man begin SEEALSO nm |
| 910 | ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}. |
| 911 | @c man end |
| 912 | @end ignore |
| 913 | |
| 914 | @node objcopy |
| 915 | @chapter objcopy |
| 916 | |
| 917 | @c man title objcopy copy and translate object files |
| 918 | |
| 919 | @smallexample |
| 920 | @c man begin SYNOPSIS objcopy |
| 921 | objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}] |
| 922 | [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}] |
| 923 | [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}] |
| 924 | [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}] |
| 925 | [@option{-S}|@option{--strip-all}] [@option{-g}|@option{--strip-debug}] |
| 926 | [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}] |
| 927 | [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}] |
| 928 | [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}] |
| 929 | [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}] |
| 930 | [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}] |
| 931 | [@option{-x}|@option{--discard-all}] [@option{-X}|@option{--discard-locals}] |
| 932 | [@option{-b} @var{byte}|@option{--byte=}@var{byte}] |
| 933 | [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}] |
| 934 | [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}] |
| 935 | [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}] |
| 936 | [@option{-p}|@option{--preserve-dates}] |
| 937 | [@option{--debugging}] |
| 938 | [@option{--gap-fill=}@var{val}] [@option{--pad-to=}@var{address}] |
| 939 | [@option{--set-start=}@var{val}] [@option{--adjust-start=}@var{incr}] |
| 940 | [@option{--change-addresses=}@var{incr}] |
| 941 | [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}] |
| 942 | [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}] |
| 943 | [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}] |
| 944 | [@option{--change-warnings}] [@option{--no-change-warnings}] |
| 945 | [@option{--set-section-flags} @var{section}=@var{flags}] |
| 946 | [@option{--add-section} @var{sectionname}=@var{filename}] |
| 947 | [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]] |
| 948 | [@option{--change-leading-char} ] [@option{--remove-leading-char}] |
| 949 | [@option{--srec-len=}@var{ival} ] [@option{--srec-forceS3}] |
| 950 | [@option{--redefine-sym} @var{old}=@var{new} ] |
| 951 | [@option{--weaken}] |
| 952 | [@option{--keep-symbols=}@var{filename}] |
| 953 | [@option{--strip-symbols=}@var{filename}] |
| 954 | [@option{--keep-global-symbols=}@var{filename}] |
| 955 | [@option{--localize-symbols=}@var{filename}] |
| 956 | [@option{--weaken-symbols=}@var{filename}] |
| 957 | [@option{--alt-machine-code=@var{index}}] |
| 958 | [@option{-v}|@option{--verbose}] |
| 959 | [@option{-V}|@option{--version}] |
| 960 | [@option{--help}] |
| 961 | @var{infile} [@var{outfile}] |
| 962 | @c man end |
| 963 | @end smallexample |
| 964 | |
| 965 | @c man begin DESCRIPTION objcopy |
| 966 | The @sc{gnu} @command{objcopy} utility copies the contents of an object |
| 967 | file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to |
| 968 | read and write the object files. It can write the destination object |
| 969 | file in a format different from that of the source object file. The |
| 970 | exact behavior of @command{objcopy} is controlled by command-line options. |
| 971 | Note that @command{objcopy} should be able to copy a fully linked file |
| 972 | between any two formats. However, copying a relocatable object file |
| 973 | between any two formats may not work as expected. |
| 974 | |
| 975 | @command{objcopy} creates temporary files to do its translations and |
| 976 | deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its |
| 977 | translation work; it has access to all the formats described in @sc{bfd} |
| 978 | and thus is able to recognize most formats without being told |
| 979 | explicitly. @xref{BFD,,BFD,ld.info,Using LD}. |
| 980 | |
| 981 | @command{objcopy} can be used to generate S-records by using an output |
| 982 | target of @samp{srec} (e.g., use @samp{-O srec}). |
| 983 | |
| 984 | @command{objcopy} can be used to generate a raw binary file by using an |
| 985 | output target of @samp{binary} (e.g., use @option{-O binary}). When |
| 986 | @command{objcopy} generates a raw binary file, it will essentially produce |
| 987 | a memory dump of the contents of the input object file. All symbols and |
| 988 | relocation information will be discarded. The memory dump will start at |
| 989 | the load address of the lowest section copied into the output file. |
| 990 | |
| 991 | When generating an S-record or a raw binary file, it may be helpful to |
| 992 | use @option{-S} to remove sections containing debugging information. In |
| 993 | some cases @option{-R} will be useful to remove sections which contain |
| 994 | information that is not needed by the binary file. |
| 995 | |
| 996 | Note - @command{objcopy} is not able to change the endianness of its input |
| 997 | files. If the input format has an endianness, (some formats do not), |
| 998 | @command{objcopy} can only copy the inputs into file formats that have the |
| 999 | same endianness or which have no endianness (eg @samp{srec}). |
| 1000 | |
| 1001 | @c man end |
| 1002 | |
| 1003 | @c man begin OPTIONS objcopy |
| 1004 | |
| 1005 | @table @env |
| 1006 | @item @var{infile} |
| 1007 | @itemx @var{outfile} |
| 1008 | The input and output files, respectively. |
| 1009 | If you do not specify @var{outfile}, @command{objcopy} creates a |
| 1010 | temporary file and destructively renames the result with |
| 1011 | the name of @var{infile}. |
| 1012 | |
| 1013 | @item -I @var{bfdname} |
| 1014 | @itemx --input-target=@var{bfdname} |
| 1015 | Consider the source file's object format to be @var{bfdname}, rather than |
| 1016 | attempting to deduce it. @xref{Target Selection}, for more information. |
| 1017 | |
| 1018 | @item -O @var{bfdname} |
| 1019 | @itemx --output-target=@var{bfdname} |
| 1020 | Write the output file using the object format @var{bfdname}. |
| 1021 | @xref{Target Selection}, for more information. |
| 1022 | |
| 1023 | @item -F @var{bfdname} |
| 1024 | @itemx --target=@var{bfdname} |
| 1025 | Use @var{bfdname} as the object format for both the input and the output |
| 1026 | file; i.e., simply transfer data from source to destination with no |
| 1027 | translation. @xref{Target Selection}, for more information. |
| 1028 | |
| 1029 | @item -B @var{bfdarch} |
| 1030 | @itemx --binary-architecture=@var{bfdarch} |
| 1031 | Useful when transforming a raw binary input file into an object file. |
| 1032 | In this case the output architecture can be set to @var{bfdarch}. This |
| 1033 | option will be ignored if the input file has a known @var{bfdarch}. You |
| 1034 | can access this binary data inside a program by referencing the special |
| 1035 | symbols that are created by the conversion process. These symbols are |
| 1036 | called _binary_@var{objfile}_start, _binary_@var{objfile}_end and |
| 1037 | _binary_@var{objfile}_size. e.g. you can transform a picture file into |
| 1038 | an object file and then access it in your code using these symbols. |
| 1039 | |
| 1040 | @item -j @var{sectionname} |
| 1041 | @itemx --only-section=@var{sectionname} |
| 1042 | Copy only the named section from the input file to the output file. |
| 1043 | This option may be given more than once. Note that using this option |
| 1044 | inappropriately may make the output file unusable. |
| 1045 | |
| 1046 | @item -R @var{sectionname} |
| 1047 | @itemx --remove-section=@var{sectionname} |
| 1048 | Remove any section named @var{sectionname} from the output file. This |
| 1049 | option may be given more than once. Note that using this option |
| 1050 | inappropriately may make the output file unusable. |
| 1051 | |
| 1052 | @item -S |
| 1053 | @itemx --strip-all |
| 1054 | Do not copy relocation and symbol information from the source file. |
| 1055 | |
| 1056 | @item -g |
| 1057 | @itemx --strip-debug |
| 1058 | Do not copy debugging symbols from the source file. |
| 1059 | |
| 1060 | @item --strip-unneeded |
| 1061 | Strip all symbols that are not needed for relocation processing. |
| 1062 | |
| 1063 | @item -K @var{symbolname} |
| 1064 | @itemx --keep-symbol=@var{symbolname} |
| 1065 | Copy only symbol @var{symbolname} from the source file. This option may |
| 1066 | be given more than once. |
| 1067 | |
| 1068 | @item -N @var{symbolname} |
| 1069 | @itemx --strip-symbol=@var{symbolname} |
| 1070 | Do not copy symbol @var{symbolname} from the source file. This option |
| 1071 | may be given more than once. |
| 1072 | |
| 1073 | @item -G @var{symbolname} |
| 1074 | @itemx --keep-global-symbol=@var{symbolname} |
| 1075 | Keep only symbol @var{symbolname} global. Make all other symbols local |
| 1076 | to the file, so that they are not visible externally. This option may |
| 1077 | be given more than once. |
| 1078 | |
| 1079 | @item -L @var{symbolname} |
| 1080 | @itemx --localize-symbol=@var{symbolname} |
| 1081 | Make symbol @var{symbolname} local to the file, so that it is not |
| 1082 | visible externally. This option may be given more than once. |
| 1083 | |
| 1084 | @item -W @var{symbolname} |
| 1085 | @itemx --weaken-symbol=@var{symbolname} |
| 1086 | Make symbol @var{symbolname} weak. This option may be given more than once. |
| 1087 | |
| 1088 | @item -x |
| 1089 | @itemx --discard-all |
| 1090 | Do not copy non-global symbols from the source file. |
| 1091 | @c FIXME any reason to prefer "non-global" to "local" here? |
| 1092 | |
| 1093 | @item -X |
| 1094 | @itemx --discard-locals |
| 1095 | Do not copy compiler-generated local symbols. |
| 1096 | (These usually start with @samp{L} or @samp{.}.) |
| 1097 | |
| 1098 | @item -b @var{byte} |
| 1099 | @itemx --byte=@var{byte} |
| 1100 | Keep only every @var{byte}th byte of the input file (header data is not |
| 1101 | affected). @var{byte} can be in the range from 0 to @var{interleave}-1, |
| 1102 | where @var{interleave} is given by the @option{-i} or @option{--interleave} |
| 1103 | option, or the default of 4. This option is useful for creating files |
| 1104 | to program @sc{rom}. It is typically used with an @code{srec} output |
| 1105 | target. |
| 1106 | |
| 1107 | @item -i @var{interleave} |
| 1108 | @itemx --interleave=@var{interleave} |
| 1109 | Only copy one out of every @var{interleave} bytes. Select which byte to |
| 1110 | copy with the @option{-b} or @option{--byte} option. The default is 4. |
| 1111 | @command{objcopy} ignores this option if you do not specify either @option{-b} or |
| 1112 | @option{--byte}. |
| 1113 | |
| 1114 | @item -p |
| 1115 | @itemx --preserve-dates |
| 1116 | Set the access and modification dates of the output file to be the same |
| 1117 | as those of the input file. |
| 1118 | |
| 1119 | @item --debugging |
| 1120 | Convert debugging information, if possible. This is not the default |
| 1121 | because only certain debugging formats are supported, and the |
| 1122 | conversion process can be time consuming. |
| 1123 | |
| 1124 | @item --gap-fill @var{val} |
| 1125 | Fill gaps between sections with @var{val}. This operation applies to |
| 1126 | the @emph{load address} (LMA) of the sections. It is done by increasing |
| 1127 | the size of the section with the lower address, and filling in the extra |
| 1128 | space created with @var{val}. |
| 1129 | |
| 1130 | @item --pad-to @var{address} |
| 1131 | Pad the output file up to the load address @var{address}. This is |
| 1132 | done by increasing the size of the last section. The extra space is |
| 1133 | filled in with the value specified by @option{--gap-fill} (default zero). |
| 1134 | |
| 1135 | @item --set-start @var{val} |
| 1136 | Set the start address of the new file to @var{val}. Not all object file |
| 1137 | formats support setting the start address. |
| 1138 | |
| 1139 | @item --change-start @var{incr} |
| 1140 | @itemx --adjust-start @var{incr} |
| 1141 | @cindex changing start address |
| 1142 | Change the start address by adding @var{incr}. Not all object file |
| 1143 | formats support setting the start address. |
| 1144 | |
| 1145 | @item --change-addresses @var{incr} |
| 1146 | @itemx --adjust-vma @var{incr} |
| 1147 | @cindex changing object addresses |
| 1148 | Change the VMA and LMA addresses of all sections, as well as the start |
| 1149 | address, by adding @var{incr}. Some object file formats do not permit |
| 1150 | section addresses to be changed arbitrarily. Note that this does not |
| 1151 | relocate the sections; if the program expects sections to be loaded at a |
| 1152 | certain address, and this option is used to change the sections such |
| 1153 | that they are loaded at a different address, the program may fail. |
| 1154 | |
| 1155 | @item --change-section-address @var{section}@{=,+,-@}@var{val} |
| 1156 | @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val} |
| 1157 | @cindex changing section address |
| 1158 | Set or change both the VMA address and the LMA address of the named |
| 1159 | @var{section}. If @samp{=} is used, the section address is set to |
| 1160 | @var{val}. Otherwise, @var{val} is added to or subtracted from the |
| 1161 | section address. See the comments under @option{--change-addresses}, |
| 1162 | above. If @var{section} does not exist in the input file, a warning will |
| 1163 | be issued, unless @option{--no-change-warnings} is used. |
| 1164 | |
| 1165 | @item --change-section-lma @var{section}@{=,+,-@}@var{val} |
| 1166 | @cindex changing section LMA |
| 1167 | Set or change the LMA address of the named @var{section}. The LMA |
| 1168 | address is the address where the section will be loaded into memory at |
| 1169 | program load time. Normally this is the same as the VMA address, which |
| 1170 | is the address of the section at program run time, but on some systems, |
| 1171 | especially those where a program is held in ROM, the two can be |
| 1172 | different. If @samp{=} is used, the section address is set to |
| 1173 | @var{val}. Otherwise, @var{val} is added to or subtracted from the |
| 1174 | section address. See the comments under @option{--change-addresses}, |
| 1175 | above. If @var{section} does not exist in the input file, a warning |
| 1176 | will be issued, unless @option{--no-change-warnings} is used. |
| 1177 | |
| 1178 | @item --change-section-vma @var{section}@{=,+,-@}@var{val} |
| 1179 | @cindex changing section VMA |
| 1180 | Set or change the VMA address of the named @var{section}. The VMA |
| 1181 | address is the address where the section will be located once the |
| 1182 | program has started executing. Normally this is the same as the LMA |
| 1183 | address, which is the address where the section will be loaded into |
| 1184 | memory, but on some systems, especially those where a program is held in |
| 1185 | ROM, the two can be different. If @samp{=} is used, the section address |
| 1186 | is set to @var{val}. Otherwise, @var{val} is added to or subtracted |
| 1187 | from the section address. See the comments under |
| 1188 | @option{--change-addresses}, above. If @var{section} does not exist in |
| 1189 | the input file, a warning will be issued, unless |
| 1190 | @option{--no-change-warnings} is used. |
| 1191 | |
| 1192 | @item --change-warnings |
| 1193 | @itemx --adjust-warnings |
| 1194 | If @option{--change-section-address} or @option{--change-section-lma} or |
| 1195 | @option{--change-section-vma} is used, and the named section does not |
| 1196 | exist, issue a warning. This is the default. |
| 1197 | |
| 1198 | @item --no-change-warnings |
| 1199 | @itemx --no-adjust-warnings |
| 1200 | Do not issue a warning if @option{--change-section-address} or |
| 1201 | @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even |
| 1202 | if the named section does not exist. |
| 1203 | |
| 1204 | @item --set-section-flags @var{section}=@var{flags} |
| 1205 | Set the flags for the named section. The @var{flags} argument is a |
| 1206 | comma separated string of flag names. The recognized names are |
| 1207 | @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload}, |
| 1208 | @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and |
| 1209 | @samp{debug}. You can set the @samp{contents} flag for a section which |
| 1210 | does not have contents, but it is not meaningful to clear the |
| 1211 | @samp{contents} flag of a section which does have contents--just remove |
| 1212 | the section instead. Not all flags are meaningful for all object file |
| 1213 | formats. |
| 1214 | |
| 1215 | @item --add-section @var{sectionname}=@var{filename} |
| 1216 | Add a new section named @var{sectionname} while copying the file. The |
| 1217 | contents of the new section are taken from the file @var{filename}. The |
| 1218 | size of the section will be the size of the file. This option only |
| 1219 | works on file formats which can support sections with arbitrary names. |
| 1220 | |
| 1221 | @item --rename-section @var{oldname}=@var{newname}[,@var{flags}] |
| 1222 | Rename a section from @var{oldname} to @var{newname}, optionally |
| 1223 | changing the section's flags to @var{flags} in the process. This has |
| 1224 | the advantage over usng a linker script to perform the rename in that |
| 1225 | the output stays as an object file and does not become a linked |
| 1226 | executable. |
| 1227 | |
| 1228 | This option is particularly helpful when the input format is binary, |
| 1229 | since this will always create a section called .data. If for example, |
| 1230 | you wanted instead to create a section called .rodata containing binary |
| 1231 | data you could use the following command line to achieve it: |
| 1232 | |
| 1233 | @smallexample |
| 1234 | objcopy -I binary -O <output_format> -B <architecture> \ |
| 1235 | --rename-section .data=.rodata,alloc,load,readonly,data,contents \ |
| 1236 | <input_binary_file> <output_object_file> |
| 1237 | @end smallexample |
| 1238 | |
| 1239 | @item --change-leading-char |
| 1240 | Some object file formats use special characters at the start of |
| 1241 | symbols. The most common such character is underscore, which compilers |
| 1242 | often add before every symbol. This option tells @command{objcopy} to |
| 1243 | change the leading character of every symbol when it converts between |
| 1244 | object file formats. If the object file formats use the same leading |
| 1245 | character, this option has no effect. Otherwise, it will add a |
| 1246 | character, or remove a character, or change a character, as |
| 1247 | appropriate. |
| 1248 | |
| 1249 | @item --remove-leading-char |
| 1250 | If the first character of a global symbol is a special symbol leading |
| 1251 | character used by the object file format, remove the character. The |
| 1252 | most common symbol leading character is underscore. This option will |
| 1253 | remove a leading underscore from all global symbols. This can be useful |
| 1254 | if you want to link together objects of different file formats with |
| 1255 | different conventions for symbol names. This is different from |
| 1256 | @option{--change-leading-char} because it always changes the symbol name |
| 1257 | when appropriate, regardless of the object file format of the output |
| 1258 | file. |
| 1259 | |
| 1260 | @item --srec-len=@var{ival} |
| 1261 | Meaningful only for srec output. Set the maximum length of the Srecords |
| 1262 | being produced to @var{ival}. This length covers both address, data and |
| 1263 | crc fields. |
| 1264 | |
| 1265 | @item --srec-forceS3 |
| 1266 | Meaningful only for srec output. Avoid generation of S1/S2 records, |
| 1267 | creating S3-only record format. |
| 1268 | |
| 1269 | @item --redefine-sym @var{old}=@var{new} |
| 1270 | Change the name of a symbol @var{old}, to @var{new}. This can be useful |
| 1271 | when one is trying link two things together for which you have no |
| 1272 | source, and there are name collisions. |
| 1273 | |
| 1274 | @item --weaken |
| 1275 | Change all global symbols in the file to be weak. This can be useful |
| 1276 | when building an object which will be linked against other objects using |
| 1277 | the @option{-R} option to the linker. This option is only effective when |
| 1278 | using an object file format which supports weak symbols. |
| 1279 | |
| 1280 | @item --keep-symbols=@var{filename} |
| 1281 | Apply @option{--keep-symbol} option to each symbol listed in the file |
| 1282 | @var{filename}. @var{filename} is simply a flat file, with one symbol |
| 1283 | name per line. Line comments may be introduced by the hash character. |
| 1284 | This option may be given more than once. |
| 1285 | |
| 1286 | @item --strip-symbols=@var{filename} |
| 1287 | Apply @option{--strip-symbol} option to each symbol listed in the file |
| 1288 | @var{filename}. @var{filename} is simply a flat file, with one symbol |
| 1289 | name per line. Line comments may be introduced by the hash character. |
| 1290 | This option may be given more than once. |
| 1291 | |
| 1292 | @item --keep-global-symbols=@var{filename} |
| 1293 | Apply @option{--keep-global-symbol} option to each symbol listed in the |
| 1294 | file @var{filename}. @var{filename} is simply a flat file, with one |
| 1295 | symbol name per line. Line comments may be introduced by the hash |
| 1296 | character. This option may be given more than once. |
| 1297 | |
| 1298 | @item --localize-symbols=@var{filename} |
| 1299 | Apply @option{--localize-symbol} option to each symbol listed in the file |
| 1300 | @var{filename}. @var{filename} is simply a flat file, with one symbol |
| 1301 | name per line. Line comments may be introduced by the hash character. |
| 1302 | This option may be given more than once. |
| 1303 | |
| 1304 | @item --weaken-symbols=@var{filename} |
| 1305 | Apply @option{--weaken-symbol} option to each symbol listed in the file |
| 1306 | @var{filename}. @var{filename} is simply a flat file, with one symbol |
| 1307 | name per line. Line comments may be introduced by the hash character. |
| 1308 | This option may be given more than once. |
| 1309 | |
| 1310 | @item --alt-machine-code=@var{index} |
| 1311 | If the output architecture has alternate machine codes, use the |
| 1312 | @var{index}th code instead of the default one. This is useful in case |
| 1313 | a machine is assigned an official code and the tool-chain adopts the |
| 1314 | new code, but other applications still depend on the original code |
| 1315 | being used. |
| 1316 | |
| 1317 | @item -V |
| 1318 | @itemx --version |
| 1319 | Show the version number of @command{objcopy}. |
| 1320 | |
| 1321 | @item -v |
| 1322 | @itemx --verbose |
| 1323 | Verbose output: list all object files modified. In the case of |
| 1324 | archives, @samp{objcopy -V} lists all members of the archive. |
| 1325 | |
| 1326 | @item --help |
| 1327 | Show a summary of the options to @command{objcopy}. |
| 1328 | @end table |
| 1329 | |
| 1330 | @c man end |
| 1331 | |
| 1332 | @ignore |
| 1333 | @c man begin SEEALSO objcopy |
| 1334 | ld(1), objdump(1), and the Info entries for @file{binutils}. |
| 1335 | @c man end |
| 1336 | @end ignore |
| 1337 | |
| 1338 | @node objdump |
| 1339 | @chapter objdump |
| 1340 | |
| 1341 | @cindex object file information |
| 1342 | @kindex objdump |
| 1343 | |
| 1344 | @c man title objdump display information from object files. |
| 1345 | |
| 1346 | @smallexample |
| 1347 | @c man begin SYNOPSIS objdump |
| 1348 | objdump [@option{-a}|@option{--archive-headers}] |
| 1349 | [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}] |
| 1350 | [@option{-C}|@option{--demangle}[=@var{style}] ] |
| 1351 | [@option{-d}|@option{--disassemble}] |
| 1352 | [@option{-D}|@option{--disassemble-all}] |
| 1353 | [@option{-z}|@option{--disassemble-zeroes}] |
| 1354 | [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}] |
| 1355 | [@option{-f}|@option{--file-headers}] |
| 1356 | [@option{--file-start-context}] |
| 1357 | [@option{-g}|@option{--debugging}] |
| 1358 | [@option{-h}|@option{--section-headers}|@option{--headers}] |
| 1359 | [@option{-i}|@option{--info}] |
| 1360 | [@option{-j} @var{section}|@option{--section=}@var{section}] |
| 1361 | [@option{-l}|@option{--line-numbers}] |
| 1362 | [@option{-S}|@option{--source}] |
| 1363 | [@option{-m} @var{machine}|@option{--architecture=}@var{machine}] |
| 1364 | [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}] |
| 1365 | [@option{-p}|@option{--private-headers}] |
| 1366 | [@option{-r}|@option{--reloc}] |
| 1367 | [@option{-R}|@option{--dynamic-reloc}] |
| 1368 | [@option{-s}|@option{--full-contents}] |
| 1369 | [@option{-G}|@option{--stabs}] |
| 1370 | [@option{-t}|@option{--syms}] |
| 1371 | [@option{-T}|@option{--dynamic-syms}] |
| 1372 | [@option{-x}|@option{--all-headers}] |
| 1373 | [@option{-w}|@option{--wide}] |
| 1374 | [@option{--start-address=}@var{address}] |
| 1375 | [@option{--stop-address=}@var{address}] |
| 1376 | [@option{--prefix-addresses}] |
| 1377 | [@option{--[no-]show-raw-insn}] |
| 1378 | [@option{--adjust-vma=}@var{offset}] |
| 1379 | [@option{-V}|@option{--version}] |
| 1380 | [@option{-H}|@option{--help}] |
| 1381 | @var{objfile}@dots{} |
| 1382 | @c man end |
| 1383 | @end smallexample |
| 1384 | |
| 1385 | @c man begin DESCRIPTION objdump |
| 1386 | |
| 1387 | @command{objdump} displays information about one or more object files. |
| 1388 | The options control what particular information to display. This |
| 1389 | information is mostly useful to programmers who are working on the |
| 1390 | compilation tools, as opposed to programmers who just want their |
| 1391 | program to compile and work. |
| 1392 | |
| 1393 | @var{objfile}@dots{} are the object files to be examined. When you |
| 1394 | specify archives, @command{objdump} shows information on each of the member |
| 1395 | object files. |
| 1396 | |
| 1397 | @c man end |
| 1398 | |
| 1399 | @c man begin OPTIONS objdump |
| 1400 | |
| 1401 | The long and short forms of options, shown here as alternatives, are |
| 1402 | equivalent. At least one option from the list |
| 1403 | @option{-a,-d,-D,-f,-g,-G,-h,-H,-p,-r,-R,-S,-t,-T,-V,-x} must be given. |
| 1404 | |
| 1405 | @table @env |
| 1406 | @item -a |
| 1407 | @itemx --archive-header |
| 1408 | @cindex archive headers |
| 1409 | If any of the @var{objfile} files are archives, display the archive |
| 1410 | header information (in a format similar to @samp{ls -l}). Besides the |
| 1411 | information you could list with @samp{ar tv}, @samp{objdump -a} shows |
| 1412 | the object file format of each archive member. |
| 1413 | |
| 1414 | @item --adjust-vma=@var{offset} |
| 1415 | @cindex section addresses in objdump |
| 1416 | @cindex VMA in objdump |
| 1417 | When dumping information, first add @var{offset} to all the section |
| 1418 | addresses. This is useful if the section addresses do not correspond to |
| 1419 | the symbol table, which can happen when putting sections at particular |
| 1420 | addresses when using a format which can not represent section addresses, |
| 1421 | such as a.out. |
| 1422 | |
| 1423 | @item -b @var{bfdname} |
| 1424 | @itemx --target=@var{bfdname} |
| 1425 | @cindex object code format |
| 1426 | Specify that the object-code format for the object files is |
| 1427 | @var{bfdname}. This option may not be necessary; @var{objdump} can |
| 1428 | automatically recognize many formats. |
| 1429 | |
| 1430 | For example, |
| 1431 | @example |
| 1432 | objdump -b oasys -m vax -h fu.o |
| 1433 | @end example |
| 1434 | @noindent |
| 1435 | displays summary information from the section headers (@option{-h}) of |
| 1436 | @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object |
| 1437 | file in the format produced by Oasys compilers. You can list the |
| 1438 | formats available with the @option{-i} option. |
| 1439 | @xref{Target Selection}, for more information. |
| 1440 | |
| 1441 | @item -C |
| 1442 | @itemx --demangle[=@var{style}] |
| 1443 | @cindex demangling in objdump |
| 1444 | Decode (@dfn{demangle}) low-level symbol names into user-level names. |
| 1445 | Besides removing any initial underscore prepended by the system, this |
| 1446 | makes C++ function names readable. Different compilers have different |
| 1447 | mangling styles. The optional demangling style argument can be used to |
| 1448 | choose an appropriate demangling style for your compiler. @xref{c++filt}, |
| 1449 | for more information on demangling. |
| 1450 | |
| 1451 | @item -G |
| 1452 | @item --debugging |
| 1453 | Display debugging information. This attempts to parse debugging |
| 1454 | information stored in the file and print it out using a C like syntax. |
| 1455 | Only certain types of debugging information have been implemented. |
| 1456 | |
| 1457 | @item -d |
| 1458 | @itemx --disassemble |
| 1459 | @cindex disassembling object code |
| 1460 | @cindex machine instructions |
| 1461 | Display the assembler mnemonics for the machine instructions from |
| 1462 | @var{objfile}. This option only disassembles those sections which are |
| 1463 | expected to contain instructions. |
| 1464 | |
| 1465 | @item -D |
| 1466 | @itemx --disassemble-all |
| 1467 | Like @option{-d}, but disassemble the contents of all sections, not just |
| 1468 | those expected to contain instructions. |
| 1469 | |
| 1470 | @item --prefix-addresses |
| 1471 | When disassembling, print the complete address on each line. This is |
| 1472 | the older disassembly format. |
| 1473 | |
| 1474 | @item --disassemble-zeroes |
| 1475 | Normally the disassembly output will skip blocks of zeroes. This |
| 1476 | option directs the disassembler to disassemble those blocks, just like |
| 1477 | any other data. |
| 1478 | |
| 1479 | @item -EB |
| 1480 | @itemx -EL |
| 1481 | @itemx --endian=@{big|little@} |
| 1482 | @cindex endianness |
| 1483 | @cindex disassembly endianness |
| 1484 | Specify the endianness of the object files. This only affects |
| 1485 | disassembly. This can be useful when disassembling a file format which |
| 1486 | does not describe endianness information, such as S-records. |
| 1487 | |
| 1488 | @item -f |
| 1489 | @itemx --file-header |
| 1490 | @cindex object file header |
| 1491 | Display summary information from the overall header of |
| 1492 | each of the @var{objfile} files. |
| 1493 | |
| 1494 | @item --file-start-context |
| 1495 | @cindex source code context |
| 1496 | Specify that when displaying interlisted source code/disassembly |
| 1497 | (assumes @option{-S}) from a file that has not yet been displayed, extend the |
| 1498 | context to the start of the file. |
| 1499 | |
| 1500 | @item -h |
| 1501 | @itemx --section-header |
| 1502 | @itemx --header |
| 1503 | @cindex section headers |
| 1504 | Display summary information from the section headers of the |
| 1505 | object file. |
| 1506 | |
| 1507 | File segments may be relocated to nonstandard addresses, for example by |
| 1508 | using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to |
| 1509 | @command{ld}. However, some object file formats, such as a.out, do not |
| 1510 | store the starting address of the file segments. In those situations, |
| 1511 | although @command{ld} relocates the sections correctly, using @samp{objdump |
| 1512 | -h} to list the file section headers cannot show the correct addresses. |
| 1513 | Instead, it shows the usual addresses, which are implicit for the |
| 1514 | target. |
| 1515 | |
| 1516 | @item --help |
| 1517 | Print a summary of the options to @command{objdump} and exit. |
| 1518 | |
| 1519 | @item -i |
| 1520 | @itemx --info |
| 1521 | @cindex architectures available |
| 1522 | @cindex object formats available |
| 1523 | Display a list showing all architectures and object formats available |
| 1524 | for specification with @option{-b} or @option{-m}. |
| 1525 | |
| 1526 | @item -j @var{name} |
| 1527 | @itemx --section=@var{name} |
| 1528 | @cindex section information |
| 1529 | Display information only for section @var{name}. |
| 1530 | |
| 1531 | @item -l |
| 1532 | @itemx --line-numbers |
| 1533 | @cindex source filenames for object files |
| 1534 | Label the display (using debugging information) with the filename and |
| 1535 | source line numbers corresponding to the object code or relocs shown. |
| 1536 | Only useful with @option{-d}, @option{-D}, or @option{-r}. |
| 1537 | |
| 1538 | @item -m @var{machine} |
| 1539 | @itemx --architecture=@var{machine} |
| 1540 | @cindex architecture |
| 1541 | @cindex disassembly architecture |
| 1542 | Specify the architecture to use when disassembling object files. This |
| 1543 | can be useful when disassembling object files which do not describe |
| 1544 | architecture information, such as S-records. You can list the available |
| 1545 | architectures with the @option{-i} option. |
| 1546 | |
| 1547 | @item -M @var{options} |
| 1548 | @itemx --disassembler-options=@var{options} |
| 1549 | Pass target specific information to the disassembler. Only supported on |
| 1550 | some targets. |
| 1551 | |
| 1552 | If the target is an ARM architecture then this switch can be used to |
| 1553 | select which register name set is used during disassembler. Specifying |
| 1554 | @option{-M reg-name-std} (the default) will select the register names as |
| 1555 | used in ARM's instruction set documentation, but with register 13 called |
| 1556 | 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying |
| 1557 | @option{-M reg-names-apcs} will select the name set used by the ARM |
| 1558 | Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will |
| 1559 | just use @samp{r} followed by the register number. |
| 1560 | |
| 1561 | There are also two variants on the APCS register naming scheme enabled |
| 1562 | by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which |
| 1563 | use the ARM/Thumb Procedure Call Standard naming conventions. (Either |
| 1564 | with the normal register name or the special register names). |
| 1565 | |
| 1566 | This option can also be used for ARM architectures to force the |
| 1567 | disassembler to interpret all instructions as Thumb instructions by |
| 1568 | using the switch @option{--disassembler-options=force-thumb}. This can be |
| 1569 | useful when attempting to disassemble thumb code produced by other |
| 1570 | compilers. |
| 1571 | |
| 1572 | For the x86, some of the options duplicate functions of the @option{-m} |
| 1573 | switch, but allow finer grained control. Multiple selections from the |
| 1574 | following may be specified as a comma separated string. |
| 1575 | @option{x86-64}, @option{i386} and @option{i8086} select disassembly for |
| 1576 | the given architecture. @option{intel} and @option{att} select between |
| 1577 | intel syntax mode and AT&T syntax mode. @option{addr32}, |
| 1578 | @option{addr16}, @option{data32} and @option{data16} specify the default |
| 1579 | address size and operand size. These four options will be overridden if |
| 1580 | @option{x86-64}, @option{i386} or @option{i8086} appear later in the |
| 1581 | option string. Lastly, @option{suffix}, when in AT&T mode, |
| 1582 | instructs the dissassembler to print a mnemonic suffix even when the |
| 1583 | suffix could be inferred by the operands. |
| 1584 | |
| 1585 | For PPC, @option{booke}, @option{booke32} and @option{booke64} select |
| 1586 | disassembly of BookE instructions. @option{32} and @option{64} select |
| 1587 | PowerPC and PowerPC64 disassembly, respectively. |
| 1588 | |
| 1589 | @item -p |
| 1590 | @itemx --private-headers |
| 1591 | Print information that is specific to the object file format. The exact |
| 1592 | information printed depends upon the object file format. For some |
| 1593 | object file formats, no additional information is printed. |
| 1594 | |
| 1595 | @item -r |
| 1596 | @itemx --reloc |
| 1597 | @cindex relocation entries, in object file |
| 1598 | Print the relocation entries of the file. If used with @option{-d} or |
| 1599 | @option{-D}, the relocations are printed interspersed with the |
| 1600 | disassembly. |
| 1601 | |
| 1602 | @item -R |
| 1603 | @itemx --dynamic-reloc |
| 1604 | @cindex dynamic relocation entries, in object file |
| 1605 | Print the dynamic relocation entries of the file. This is only |
| 1606 | meaningful for dynamic objects, such as certain types of shared |
| 1607 | libraries. |
| 1608 | |
| 1609 | @item -s |
| 1610 | @itemx --full-contents |
| 1611 | @cindex sections, full contents |
| 1612 | @cindex object file sections |
| 1613 | Display the full contents of any sections requested. |
| 1614 | |
| 1615 | @item -S |
| 1616 | @itemx --source |
| 1617 | @cindex source disassembly |
| 1618 | @cindex disassembly, with source |
| 1619 | Display source code intermixed with disassembly, if possible. Implies |
| 1620 | @option{-d}. |
| 1621 | |
| 1622 | @item --show-raw-insn |
| 1623 | When disassembling instructions, print the instruction in hex as well as |
| 1624 | in symbolic form. This is the default except when |
| 1625 | @option{--prefix-addresses} is used. |
| 1626 | |
| 1627 | @item --no-show-raw-insn |
| 1628 | When disassembling instructions, do not print the instruction bytes. |
| 1629 | This is the default when @option{--prefix-addresses} is used. |
| 1630 | |
| 1631 | @item -G |
| 1632 | @item --stabs |
| 1633 | @cindex stab |
| 1634 | @cindex .stab |
| 1635 | @cindex debug symbols |
| 1636 | @cindex ELF object file format |
| 1637 | Display the full contents of any sections requested. Display the |
| 1638 | contents of the .stab and .stab.index and .stab.excl sections from an |
| 1639 | ELF file. This is only useful on systems (such as Solaris 2.0) in which |
| 1640 | @code{.stab} debugging symbol-table entries are carried in an ELF |
| 1641 | section. In most other file formats, debugging symbol-table entries are |
| 1642 | interleaved with linkage symbols, and are visible in the @option{--syms} |
| 1643 | output. |
| 1644 | @ifclear man |
| 1645 | For more information on stabs symbols, see @ref{Top,Stabs,Stabs |
| 1646 | Overview,stabs.info, The ``stabs'' debug format}. |
| 1647 | @end ifclear |
| 1648 | |
| 1649 | @item --start-address=@var{address} |
| 1650 | @cindex start-address |
| 1651 | Start displaying data at the specified address. This affects the output |
| 1652 | of the @option{-d}, @option{-r} and @option{-s} options. |
| 1653 | |
| 1654 | @item --stop-address=@var{address} |
| 1655 | @cindex stop-address |
| 1656 | Stop displaying data at the specified address. This affects the output |
| 1657 | of the @option{-d}, @option{-r} and @option{-s} options. |
| 1658 | |
| 1659 | @item -t |
| 1660 | @itemx --syms |
| 1661 | @cindex symbol table entries, printing |
| 1662 | Print the symbol table entries of the file. |
| 1663 | This is similar to the information provided by the @samp{nm} program. |
| 1664 | |
| 1665 | @item -T |
| 1666 | @itemx --dynamic-syms |
| 1667 | @cindex dynamic symbol table entries, printing |
| 1668 | Print the dynamic symbol table entries of the file. This is only |
| 1669 | meaningful for dynamic objects, such as certain types of shared |
| 1670 | libraries. This is similar to the information provided by the @samp{nm} |
| 1671 | program when given the @option{-D} (@option{--dynamic}) option. |
| 1672 | |
| 1673 | @item --version |
| 1674 | Print the version number of @command{objdump} and exit. |
| 1675 | |
| 1676 | @item -x |
| 1677 | @itemx --all-header |
| 1678 | @cindex all header information, object file |
| 1679 | @cindex header information, all |
| 1680 | Display all available header information, including the symbol table and |
| 1681 | relocation entries. Using @option{-x} is equivalent to specifying all of |
| 1682 | @option{-a -f -h -r -t}. |
| 1683 | |
| 1684 | @item -w |
| 1685 | @itemx --wide |
| 1686 | @cindex wide output, printing |
| 1687 | Format some lines for output devices that have more than 80 columns. |
| 1688 | @end table |
| 1689 | |
| 1690 | @c man end |
| 1691 | |
| 1692 | @ignore |
| 1693 | @c man begin SEEALSO objdump |
| 1694 | nm(1), readelf(1), and the Info entries for @file{binutils}. |
| 1695 | @c man end |
| 1696 | @end ignore |
| 1697 | |
| 1698 | @node ranlib |
| 1699 | @chapter ranlib |
| 1700 | |
| 1701 | @kindex ranlib |
| 1702 | @cindex archive contents |
| 1703 | @cindex symbol index |
| 1704 | |
| 1705 | @c man title ranlib generate index to archive. |
| 1706 | |
| 1707 | @smallexample |
| 1708 | @c man begin SYNOPSIS ranlib |
| 1709 | ranlib [@option{-vV}] @var{archive} |
| 1710 | @c man end |
| 1711 | @end smallexample |
| 1712 | |
| 1713 | @c man begin DESCRIPTION ranlib |
| 1714 | |
| 1715 | @command{ranlib} generates an index to the contents of an archive and |
| 1716 | stores it in the archive. The index lists each symbol defined by a |
| 1717 | member of an archive that is a relocatable object file. |
| 1718 | |
| 1719 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index. |
| 1720 | |
| 1721 | An archive with such an index speeds up linking to the library and |
| 1722 | allows routines in the library to call each other without regard to |
| 1723 | their placement in the archive. |
| 1724 | |
| 1725 | The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running |
| 1726 | @command{ranlib} is completely equivalent to executing @samp{ar -s}. |
| 1727 | @xref{ar}. |
| 1728 | |
| 1729 | @c man end |
| 1730 | |
| 1731 | @c man begin OPTIONS ranlib |
| 1732 | |
| 1733 | @table @env |
| 1734 | @item -v |
| 1735 | @itemx -V |
| 1736 | @itemx --version |
| 1737 | Show the version number of @command{ranlib}. |
| 1738 | @end table |
| 1739 | |
| 1740 | @c man end |
| 1741 | |
| 1742 | @ignore |
| 1743 | @c man begin SEEALSO ranlib |
| 1744 | ar(1), nm(1), and the Info entries for @file{binutils}. |
| 1745 | @c man end |
| 1746 | @end ignore |
| 1747 | |
| 1748 | @node size |
| 1749 | @chapter size |
| 1750 | |
| 1751 | @kindex size |
| 1752 | @cindex section sizes |
| 1753 | |
| 1754 | @c man title size list section sizes and total size. |
| 1755 | |
| 1756 | @smallexample |
| 1757 | @c man begin SYNOPSIS size |
| 1758 | size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}] |
| 1759 | [@option{--help}] [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}] |
| 1760 | [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}] |
| 1761 | [@var{objfile}@dots{}] |
| 1762 | @c man end |
| 1763 | @end smallexample |
| 1764 | |
| 1765 | @c man begin DESCRIPTION size |
| 1766 | |
| 1767 | The @sc{gnu} @command{size} utility lists the section sizes---and the total |
| 1768 | size---for each of the object or archive files @var{objfile} in its |
| 1769 | argument list. By default, one line of output is generated for each |
| 1770 | object file or each module in an archive. |
| 1771 | |
| 1772 | @var{objfile}@dots{} are the object files to be examined. |
| 1773 | If none are specified, the file @code{a.out} will be used. |
| 1774 | |
| 1775 | @c man end |
| 1776 | |
| 1777 | @c man begin OPTIONS size |
| 1778 | |
| 1779 | The command line options have the following meanings: |
| 1780 | |
| 1781 | @table @env |
| 1782 | @item -A |
| 1783 | @itemx -B |
| 1784 | @itemx --format=@var{compatibility} |
| 1785 | @cindex @command{size} display format |
| 1786 | Using one of these options, you can choose whether the output from @sc{gnu} |
| 1787 | @command{size} resembles output from System V @command{size} (using @option{-A}, |
| 1788 | or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or |
| 1789 | @option{--format=berkeley}). The default is the one-line format similar to |
| 1790 | Berkeley's. |
| 1791 | @c Bonus for doc-source readers: you can also say --format=strange (or |
| 1792 | @c anything else that starts with 's') for sysv, and --format=boring (or |
| 1793 | @c anything else that starts with 'b') for Berkeley. |
| 1794 | |
| 1795 | Here is an example of the Berkeley (default) format of output from |
| 1796 | @command{size}: |
| 1797 | @smallexample |
| 1798 | $ size --format=Berkeley ranlib size |
| 1799 | text data bss dec hex filename |
| 1800 | 294880 81920 11592 388392 5ed28 ranlib |
| 1801 | 294880 81920 11888 388688 5ee50 size |
| 1802 | @end smallexample |
| 1803 | |
| 1804 | @noindent |
| 1805 | This is the same data, but displayed closer to System V conventions: |
| 1806 | |
| 1807 | @smallexample |
| 1808 | $ size --format=SysV ranlib size |
| 1809 | ranlib : |
| 1810 | section size addr |
| 1811 | .text 294880 8192 |
| 1812 | .data 81920 303104 |
| 1813 | .bss 11592 385024 |
| 1814 | Total 388392 |
| 1815 | |
| 1816 | |
| 1817 | size : |
| 1818 | section size addr |
| 1819 | .text 294880 8192 |
| 1820 | .data 81920 303104 |
| 1821 | .bss 11888 385024 |
| 1822 | Total 388688 |
| 1823 | @end smallexample |
| 1824 | |
| 1825 | @item --help |
| 1826 | Show a summary of acceptable arguments and options. |
| 1827 | |
| 1828 | @item -d |
| 1829 | @itemx -o |
| 1830 | @itemx -x |
| 1831 | @itemx --radix=@var{number} |
| 1832 | @cindex @command{size} number format |
| 1833 | @cindex radix for section sizes |
| 1834 | Using one of these options, you can control whether the size of each |
| 1835 | section is given in decimal (@option{-d}, or @option{--radix=10}); octal |
| 1836 | (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or |
| 1837 | @option{--radix=16}). In @option{--radix=@var{number}}, only the three |
| 1838 | values (8, 10, 16) are supported. The total size is always given in two |
| 1839 | radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or |
| 1840 | octal and hexadecimal if you're using @option{-o}. |
| 1841 | |
| 1842 | @item --target=@var{bfdname} |
| 1843 | @cindex object code format |
| 1844 | Specify that the object-code format for @var{objfile} is |
| 1845 | @var{bfdname}. This option may not be necessary; @command{size} can |
| 1846 | automatically recognize many formats. |
| 1847 | @xref{Target Selection}, for more information. |
| 1848 | |
| 1849 | @item -V |
| 1850 | @itemx --version |
| 1851 | Display the version number of @command{size}. |
| 1852 | @end table |
| 1853 | |
| 1854 | @c man end |
| 1855 | |
| 1856 | @ignore |
| 1857 | @c man begin SEEALSO size |
| 1858 | ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}. |
| 1859 | @c man end |
| 1860 | @end ignore |
| 1861 | |
| 1862 | @node strings |
| 1863 | @chapter strings |
| 1864 | @kindex strings |
| 1865 | @cindex listings strings |
| 1866 | @cindex printing strings |
| 1867 | @cindex strings, printing |
| 1868 | |
| 1869 | @c man title strings print the strings of printable characters in files. |
| 1870 | |
| 1871 | @smallexample |
| 1872 | @c man begin SYNOPSIS strings |
| 1873 | strings [@option{-afov}] [@option{-}@var{min-len}] |
| 1874 | [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}] |
| 1875 | [@option{-t} @var{radix}] [@option{--radix=}@var{radix}] |
| 1876 | [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}] |
| 1877 | [@option{-}] [@option{--all}] [@option{--print-file-name}] |
| 1878 | [@option{--target=}@var{bfdname}] |
| 1879 | [@option{--help}] [@option{--version}] @var{file}@dots{} |
| 1880 | @c man end |
| 1881 | @end smallexample |
| 1882 | |
| 1883 | @c man begin DESCRIPTION strings |
| 1884 | |
| 1885 | For each @var{file} given, @sc{gnu} @command{strings} prints the printable |
| 1886 | character sequences that are at least 4 characters long (or the number |
| 1887 | given with the options below) and are followed by an unprintable |
| 1888 | character. By default, it only prints the strings from the initialized |
| 1889 | and loaded sections of object files; for other types of files, it prints |
| 1890 | the strings from the whole file. |
| 1891 | |
| 1892 | @command{strings} is mainly useful for determining the contents of non-text |
| 1893 | files. |
| 1894 | |
| 1895 | @c man end |
| 1896 | |
| 1897 | @c man begin OPTIONS strings |
| 1898 | |
| 1899 | @table @env |
| 1900 | @item -a |
| 1901 | @itemx --all |
| 1902 | @itemx - |
| 1903 | Do not scan only the initialized and loaded sections of object files; |
| 1904 | scan the whole files. |
| 1905 | |
| 1906 | @item -f |
| 1907 | @itemx --print-file-name |
| 1908 | Print the name of the file before each string. |
| 1909 | |
| 1910 | @item --help |
| 1911 | Print a summary of the program usage on the standard output and exit. |
| 1912 | |
| 1913 | @item -@var{min-len} |
| 1914 | @itemx -n @var{min-len} |
| 1915 | @itemx --bytes=@var{min-len} |
| 1916 | Print sequences of characters that are at least @var{min-len} characters |
| 1917 | long, instead of the default 4. |
| 1918 | |
| 1919 | @item -o |
| 1920 | Like @samp{-t o}. Some other versions of @command{strings} have @option{-o} |
| 1921 | act like @samp{-t d} instead. Since we can not be compatible with both |
| 1922 | ways, we simply chose one. |
| 1923 | |
| 1924 | @item -t @var{radix} |
| 1925 | @itemx --radix=@var{radix} |
| 1926 | Print the offset within the file before each string. The single |
| 1927 | character argument specifies the radix of the offset---@samp{o} for |
| 1928 | octal, @samp{x} for hexadecimal, or @samp{d} for decimal. |
| 1929 | |
| 1930 | @item -e @var{encoding} |
| 1931 | @itemx --encoding=@var{encoding} |
| 1932 | Select the character encoding of the strings that are to be found. |
| 1933 | Possible values for @var{encoding} are: @samp{s} = single-byte |
| 1934 | characters (ASCII, ISO 8859, etc., default), @samp{b} = 16-bit |
| 1935 | Bigendian, @samp{l} = 16-bit Littleendian, @samp{B} = 32-bit Bigendian, |
| 1936 | @samp{L} = 32-bit Littleendian. Useful for finding wide character |
| 1937 | strings. |
| 1938 | |
| 1939 | @item --target=@var{bfdname} |
| 1940 | @cindex object code format |
| 1941 | Specify an object code format other than your system's default format. |
| 1942 | @xref{Target Selection}, for more information. |
| 1943 | |
| 1944 | @item -v |
| 1945 | @itemx --version |
| 1946 | Print the program version number on the standard output and exit. |
| 1947 | @end table |
| 1948 | |
| 1949 | @c man end |
| 1950 | |
| 1951 | @ignore |
| 1952 | @c man begin SEEALSO strings |
| 1953 | ar(1), nm(1), objdump(1), ranlib(1), readelf(1) |
| 1954 | and the Info entries for @file{binutils}. |
| 1955 | @c man end |
| 1956 | @end ignore |
| 1957 | |
| 1958 | @node strip |
| 1959 | @chapter strip |
| 1960 | |
| 1961 | @kindex strip |
| 1962 | @cindex removing symbols |
| 1963 | @cindex discarding symbols |
| 1964 | @cindex symbols, discarding |
| 1965 | |
| 1966 | @c man title strip Discard symbols from object files. |
| 1967 | |
| 1968 | @smallexample |
| 1969 | @c man begin SYNOPSIS strip |
| 1970 | strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname} ] |
| 1971 | [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname} ] |
| 1972 | [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname} ] |
| 1973 | [@option{-s}|@option{--strip-all}] [@option{-S}|@option{-g}|@option{--strip-debug}] |
| 1974 | [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname} ] |
| 1975 | [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname} ] |
| 1976 | [@option{-x}|@option{--discard-all} ] [@option{-X} |@option{--discard-locals}] |
| 1977 | [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname} ] |
| 1978 | [@option{-o} @var{file} ] [@option{-p}|@option{--preserve-dates}] |
| 1979 | [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}] [@option{--help}] |
| 1980 | @var{objfile}@dots{} |
| 1981 | @c man end |
| 1982 | @end smallexample |
| 1983 | |
| 1984 | @c man begin DESCRIPTION strip |
| 1985 | |
| 1986 | @sc{gnu} @command{strip} discards all symbols from object files |
| 1987 | @var{objfile}. The list of object files may include archives. |
| 1988 | At least one object file must be given. |
| 1989 | |
| 1990 | @command{strip} modifies the files named in its argument, |
| 1991 | rather than writing modified copies under different names. |
| 1992 | |
| 1993 | @c man end |
| 1994 | |
| 1995 | @c man begin OPTIONS strip |
| 1996 | |
| 1997 | @table @env |
| 1998 | @item -F @var{bfdname} |
| 1999 | @itemx --target=@var{bfdname} |
| 2000 | Treat the original @var{objfile} as a file with the object |
| 2001 | code format @var{bfdname}, and rewrite it in the same format. |
| 2002 | @xref{Target Selection}, for more information. |
| 2003 | |
| 2004 | @item --help |
| 2005 | Show a summary of the options to @command{strip} and exit. |
| 2006 | |
| 2007 | @item -I @var{bfdname} |
| 2008 | @itemx --input-target=@var{bfdname} |
| 2009 | Treat the original @var{objfile} as a file with the object |
| 2010 | code format @var{bfdname}. |
| 2011 | @xref{Target Selection}, for more information. |
| 2012 | |
| 2013 | @item -O @var{bfdname} |
| 2014 | @itemx --output-target=@var{bfdname} |
| 2015 | Replace @var{objfile} with a file in the output format @var{bfdname}. |
| 2016 | @xref{Target Selection}, for more information. |
| 2017 | |
| 2018 | @item -R @var{sectionname} |
| 2019 | @itemx --remove-section=@var{sectionname} |
| 2020 | Remove any section named @var{sectionname} from the output file. This |
| 2021 | option may be given more than once. Note that using this option |
| 2022 | inappropriately may make the output file unusable. |
| 2023 | |
| 2024 | @item -s |
| 2025 | @itemx --strip-all |
| 2026 | Remove all symbols. |
| 2027 | |
| 2028 | @item -g |
| 2029 | @itemx -S |
| 2030 | @itemx --strip-debug |
| 2031 | Remove debugging symbols only. |
| 2032 | |
| 2033 | @item --strip-unneeded |
| 2034 | Remove all symbols that are not needed for relocation processing. |
| 2035 | |
| 2036 | @item -K @var{symbolname} |
| 2037 | @itemx --keep-symbol=@var{symbolname} |
| 2038 | Keep only symbol @var{symbolname} from the source file. This option may |
| 2039 | be given more than once. |
| 2040 | |
| 2041 | @item -N @var{symbolname} |
| 2042 | @itemx --strip-symbol=@var{symbolname} |
| 2043 | Remove symbol @var{symbolname} from the source file. This option may be |
| 2044 | given more than once, and may be combined with strip options other than |
| 2045 | @option{-K}. |
| 2046 | |
| 2047 | @item -o @var{file} |
| 2048 | Put the stripped output in @var{file}, rather than replacing the |
| 2049 | existing file. When this argument is used, only one @var{objfile} |
| 2050 | argument may be specified. |
| 2051 | |
| 2052 | @item -p |
| 2053 | @itemx --preserve-dates |
| 2054 | Preserve the access and modification dates of the file. |
| 2055 | |
| 2056 | @item -x |
| 2057 | @itemx --discard-all |
| 2058 | Remove non-global symbols. |
| 2059 | |
| 2060 | @item -X |
| 2061 | @itemx --discard-locals |
| 2062 | Remove compiler-generated local symbols. |
| 2063 | (These usually start with @samp{L} or @samp{.}.) |
| 2064 | |
| 2065 | @item -V |
| 2066 | @itemx --version |
| 2067 | Show the version number for @command{strip}. |
| 2068 | |
| 2069 | @item -v |
| 2070 | @itemx --verbose |
| 2071 | Verbose output: list all object files modified. In the case of |
| 2072 | archives, @samp{strip -v} lists all members of the archive. |
| 2073 | @end table |
| 2074 | |
| 2075 | @c man end |
| 2076 | |
| 2077 | @ignore |
| 2078 | @c man begin SEEALSO strip |
| 2079 | the Info entries for @file{binutils}. |
| 2080 | @c man end |
| 2081 | @end ignore |
| 2082 | |
| 2083 | @node c++filt, addr2line, strip, Top |
| 2084 | @chapter c++filt |
| 2085 | |
| 2086 | @kindex c++filt |
| 2087 | @cindex demangling C++ symbols |
| 2088 | |
| 2089 | @c man title cxxfilt Demangle C++ and Java symbols. |
| 2090 | |
| 2091 | @smallexample |
| 2092 | @c man begin SYNOPSIS cxxfilt |
| 2093 | c++filt [@option{-_}|@option{--strip-underscores}] |
| 2094 | [@option{-j}|@option{--java}] |
| 2095 | [@option{-n}|@option{--no-strip-underscores}] |
| 2096 | [@option{-s} @var{format}|@option{--format=}@var{format}] |
| 2097 | [@option{--help}] [@option{--version}] [@var{symbol}@dots{}] |
| 2098 | @c man end |
| 2099 | @end smallexample |
| 2100 | |
| 2101 | @c man begin DESCRIPTION cxxfilt |
| 2102 | |
| 2103 | @kindex cxxfilt |
| 2104 | The C++ and Java languages provides function overloading, which means |
| 2105 | that you can write many functions with the same name (providing each |
| 2106 | takes parameters of different types). All C++ and Java function names |
| 2107 | are encoded into a low-level assembly label (this process is known as |
| 2108 | @dfn{mangling}). The @command{c++filt} |
| 2109 | @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on |
| 2110 | MS-DOS this program is named @command{cxxfilt}.} |
| 2111 | program does the inverse mapping: it decodes (@dfn{demangles}) low-level |
| 2112 | names into user-level names so that the linker can keep these overloaded |
| 2113 | functions from clashing. |
| 2114 | |
| 2115 | Every alphanumeric word (consisting of letters, digits, underscores, |
| 2116 | dollars, or periods) seen in the input is a potential label. If the |
| 2117 | label decodes into a C++ name, the C++ name replaces the low-level |
| 2118 | name in the output. |
| 2119 | |
| 2120 | You can use @command{c++filt} to decipher individual symbols: |
| 2121 | |
| 2122 | @example |
| 2123 | c++filt @var{symbol} |
| 2124 | @end example |
| 2125 | |
| 2126 | If no @var{symbol} arguments are given, @command{c++filt} reads symbol |
| 2127 | names from the standard input and writes the demangled names to the |
| 2128 | standard output. All results are printed on the standard output. |
| 2129 | |
| 2130 | @c man end |
| 2131 | |
| 2132 | @c man begin OPTIONS cxxfilt |
| 2133 | |
| 2134 | @table @env |
| 2135 | @item -_ |
| 2136 | @itemx --strip-underscores |
| 2137 | On some systems, both the C and C++ compilers put an underscore in front |
| 2138 | of every name. For example, the C name @code{foo} gets the low-level |
| 2139 | name @code{_foo}. This option removes the initial underscore. Whether |
| 2140 | @command{c++filt} removes the underscore by default is target dependent. |
| 2141 | |
| 2142 | @item -j |
| 2143 | @itemx --java |
| 2144 | Prints demangled names using Java syntax. The default is to use C++ |
| 2145 | syntax. |
| 2146 | |
| 2147 | @item -n |
| 2148 | @itemx --no-strip-underscores |
| 2149 | Do not remove the initial underscore. |
| 2150 | |
| 2151 | @item -s @var{format} |
| 2152 | @itemx --format=@var{format} |
| 2153 | @sc{gnu} @command{nm} can decode three different methods of mangling, used by |
| 2154 | different C++ compilers. The argument to this option selects which |
| 2155 | method it uses: |
| 2156 | |
| 2157 | @table @code |
| 2158 | @item gnu |
| 2159 | the one used by the @sc{gnu} compiler (the default method) |
| 2160 | @item lucid |
| 2161 | the one used by the Lucid compiler |
| 2162 | @item arm |
| 2163 | the one specified by the C++ Annotated Reference Manual |
| 2164 | @item hp |
| 2165 | the one used by the HP compiler |
| 2166 | @item edg |
| 2167 | the one used by the EDG compiler |
| 2168 | @item gnu-new-abi |
| 2169 | the one used by the @sc{gnu} compiler with the new ABI. |
| 2170 | @end table |
| 2171 | |
| 2172 | @item --help |
| 2173 | Print a summary of the options to @command{c++filt} and exit. |
| 2174 | |
| 2175 | @item --version |
| 2176 | Print the version number of @command{c++filt} and exit. |
| 2177 | @end table |
| 2178 | |
| 2179 | @c man end |
| 2180 | |
| 2181 | @ignore |
| 2182 | @c man begin SEEALSO cxxfilt |
| 2183 | the Info entries for @file{binutils}. |
| 2184 | @c man end |
| 2185 | @end ignore |
| 2186 | |
| 2187 | @quotation |
| 2188 | @emph{Warning:} @command{c++filt} is a new utility, and the details of its |
| 2189 | user interface are subject to change in future releases. In particular, |
| 2190 | a command-line option may be required in the the future to decode a name |
| 2191 | passed as an argument on the command line; in other words, |
| 2192 | |
| 2193 | @example |
| 2194 | c++filt @var{symbol} |
| 2195 | @end example |
| 2196 | |
| 2197 | @noindent |
| 2198 | may in a future release become |
| 2199 | |
| 2200 | @example |
| 2201 | c++filt @var{option} @var{symbol} |
| 2202 | @end example |
| 2203 | @end quotation |
| 2204 | |
| 2205 | @node addr2line |
| 2206 | @chapter addr2line |
| 2207 | |
| 2208 | @kindex addr2line |
| 2209 | @cindex address to file name and line number |
| 2210 | |
| 2211 | @c man title addr2line convert addresses into file names and line numbers. |
| 2212 | |
| 2213 | @smallexample |
| 2214 | @c man begin SYNOPSIS addr2line |
| 2215 | addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}] |
| 2216 | [@option{-C}|@option{--demangle}[=@var{style}] |
| 2217 | [@option{-e} @var{filename}|@option{--exe=}@var{filename}] |
| 2218 | [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}] |
| 2219 | [@option{-H}|@option{--help}] [@option{-V}|@option{--version}] |
| 2220 | [addr addr @dots{}] |
| 2221 | @c man end |
| 2222 | @end smallexample |
| 2223 | |
| 2224 | @c man begin DESCRIPTION addr2line |
| 2225 | |
| 2226 | @command{addr2line} translates program addresses into file names and line |
| 2227 | numbers. Given an address and an executable, it uses the debugging |
| 2228 | information in the executable to figure out which file name and line |
| 2229 | number are associated with a given address. |
| 2230 | |
| 2231 | The executable to use is specified with the @option{-e} option. The |
| 2232 | default is the file @file{a.out}. |
| 2233 | |
| 2234 | @command{addr2line} has two modes of operation. |
| 2235 | |
| 2236 | In the first, hexadecimal addresses are specified on the command line, |
| 2237 | and @command{addr2line} displays the file name and line number for each |
| 2238 | address. |
| 2239 | |
| 2240 | In the second, @command{addr2line} reads hexadecimal addresses from |
| 2241 | standard input, and prints the file name and line number for each |
| 2242 | address on standard output. In this mode, @command{addr2line} may be used |
| 2243 | in a pipe to convert dynamically chosen addresses. |
| 2244 | |
| 2245 | The format of the output is @samp{FILENAME:LINENO}. The file name and |
| 2246 | line number for each address is printed on a separate line. If the |
| 2247 | @command{-f} option is used, then each @samp{FILENAME:LINENO} line is |
| 2248 | preceded by a @samp{FUNCTIONNAME} line which is the name of the function |
| 2249 | containing the address. |
| 2250 | |
| 2251 | If the file name or function name can not be determined, |
| 2252 | @command{addr2line} will print two question marks in their place. If the |
| 2253 | line number can not be determined, @command{addr2line} will print 0. |
| 2254 | |
| 2255 | @c man end |
| 2256 | |
| 2257 | @c man begin OPTIONS addr2line |
| 2258 | |
| 2259 | The long and short forms of options, shown here as alternatives, are |
| 2260 | equivalent. |
| 2261 | |
| 2262 | @table @env |
| 2263 | @item -b @var{bfdname} |
| 2264 | @itemx --target=@var{bfdname} |
| 2265 | @cindex object code format |
| 2266 | Specify that the object-code format for the object files is |
| 2267 | @var{bfdname}. |
| 2268 | |
| 2269 | @item -C |
| 2270 | @itemx --demangle[=@var{style}] |
| 2271 | @cindex demangling in objdump |
| 2272 | Decode (@dfn{demangle}) low-level symbol names into user-level names. |
| 2273 | Besides removing any initial underscore prepended by the system, this |
| 2274 | makes C++ function names readable. Different compilers have different |
| 2275 | mangling styles. The optional demangling style argument can be used to |
| 2276 | choose an appropriate demangling style for your compiler. @xref{c++filt}, |
| 2277 | for more information on demangling. |
| 2278 | |
| 2279 | @item -e @var{filename} |
| 2280 | @itemx --exe=@var{filename} |
| 2281 | Specify the name of the executable for which addresses should be |
| 2282 | translated. The default file is @file{a.out}. |
| 2283 | |
| 2284 | @item -f |
| 2285 | @itemx --functions |
| 2286 | Display function names as well as file and line number information. |
| 2287 | |
| 2288 | @item -s |
| 2289 | @itemx --basenames |
| 2290 | Display only the base of each file name. |
| 2291 | @end table |
| 2292 | |
| 2293 | @c man end |
| 2294 | |
| 2295 | @ignore |
| 2296 | @c man begin SEEALSO addr2line |
| 2297 | Info entries for @file{binutils}. |
| 2298 | @c man end |
| 2299 | @end ignore |
| 2300 | |
| 2301 | @node nlmconv |
| 2302 | @chapter nlmconv |
| 2303 | |
| 2304 | @command{nlmconv} converts a relocatable object file into a NetWare |
| 2305 | Loadable Module. |
| 2306 | |
| 2307 | @ignore |
| 2308 | @command{nlmconv} currently works with @samp{i386} object |
| 2309 | files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC} |
| 2310 | object files in @sc{elf}, or @code{a.out} format@footnote{ |
| 2311 | @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object |
| 2312 | format in the Binary File Descriptor library. It has only been tested |
| 2313 | with the above formats.}. |
| 2314 | @end ignore |
| 2315 | |
| 2316 | @quotation |
| 2317 | @emph{Warning:} @command{nlmconv} is not always built as part of the binary |
| 2318 | utilities, since it is only useful for NLM targets. |
| 2319 | @end quotation |
| 2320 | |
| 2321 | @c man title nlmconv converts object code into an NLM. |
| 2322 | |
| 2323 | @smallexample |
| 2324 | @c man begin SYNOPSIS nlmconv |
| 2325 | nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}] |
| 2326 | [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}] |
| 2327 | [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}] |
| 2328 | [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}] |
| 2329 | [@option{-h}|@option{--help}] [@option{-V}|@option{--version}] |
| 2330 | @var{infile} @var{outfile} |
| 2331 | @c man end |
| 2332 | @end smallexample |
| 2333 | |
| 2334 | @c man begin DESCRIPTION nlmconv |
| 2335 | |
| 2336 | @command{nlmconv} converts the relocatable @samp{i386} object file |
| 2337 | @var{infile} into the NetWare Loadable Module @var{outfile}, optionally |
| 2338 | reading @var{headerfile} for NLM header information. For instructions |
| 2339 | on writing the NLM command file language used in header files, see the |
| 2340 | @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM |
| 2341 | Development and Tools Overview}, which is part of the NLM Software |
| 2342 | Developer's Kit (``NLM SDK''), available from Novell, Inc. |
| 2343 | @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read |
| 2344 | @var{infile}; |
| 2345 | @ifclear man |
| 2346 | see @ref{BFD,,BFD,ld.info,Using LD}, for more information. |
| 2347 | @end ifclear |
| 2348 | |
| 2349 | @command{nlmconv} can perform a link step. In other words, you can list |
| 2350 | more than one object file for input if you list them in the definitions |
| 2351 | file (rather than simply specifying one input file on the command line). |
| 2352 | In this case, @command{nlmconv} calls the linker for you. |
| 2353 | |
| 2354 | @c man end |
| 2355 | |
| 2356 | @c man begin OPTIONS nlmconv |
| 2357 | |
| 2358 | @table @env |
| 2359 | @item -I @var{bfdname} |
| 2360 | @itemx --input-target=@var{bfdname} |
| 2361 | Object format of the input file. @command{nlmconv} can usually determine |
| 2362 | the format of a given file (so no default is necessary). |
| 2363 | @xref{Target Selection}, for more information. |
| 2364 | |
| 2365 | @item -O @var{bfdname} |
| 2366 | @itemx --output-target=@var{bfdname} |
| 2367 | Object format of the output file. @command{nlmconv} infers the output |
| 2368 | format based on the input format, e.g. for a @samp{i386} input file the |
| 2369 | output format is @samp{nlm32-i386}. |
| 2370 | @xref{Target Selection}, for more information. |
| 2371 | |
| 2372 | @item -T @var{headerfile} |
| 2373 | @itemx --header-file=@var{headerfile} |
| 2374 | Reads @var{headerfile} for NLM header information. For instructions on |
| 2375 | writing the NLM command file language used in header files, see@ see the |
| 2376 | @samp{linkers} section, of the @cite{NLM Development and Tools |
| 2377 | Overview}, which is part of the NLM Software Developer's Kit, available |
| 2378 | from Novell, Inc. |
| 2379 | |
| 2380 | @item -d |
| 2381 | @itemx --debug |
| 2382 | Displays (on standard error) the linker command line used by @command{nlmconv}. |
| 2383 | |
| 2384 | @item -l @var{linker} |
| 2385 | @itemx --linker=@var{linker} |
| 2386 | Use @var{linker} for any linking. @var{linker} can be an absolute or a |
| 2387 | relative pathname. |
| 2388 | |
| 2389 | @item -h |
| 2390 | @itemx --help |
| 2391 | Prints a usage summary. |
| 2392 | |
| 2393 | @item -V |
| 2394 | @itemx --version |
| 2395 | Prints the version number for @command{nlmconv}. |
| 2396 | @end table |
| 2397 | |
| 2398 | @c man end |
| 2399 | |
| 2400 | @ignore |
| 2401 | @c man begin SEEALSO nlmconv |
| 2402 | the Info entries for @file{binutils}. |
| 2403 | @c man end |
| 2404 | @end ignore |
| 2405 | |
| 2406 | @node windres |
| 2407 | @chapter windres |
| 2408 | |
| 2409 | @command{windres} may be used to manipulate Windows resources. |
| 2410 | |
| 2411 | @quotation |
| 2412 | @emph{Warning:} @command{windres} is not always built as part of the binary |
| 2413 | utilities, since it is only useful for Windows targets. |
| 2414 | @end quotation |
| 2415 | |
| 2416 | @c man title windres manipulate Windows resources. |
| 2417 | |
| 2418 | @smallexample |
| 2419 | @c man begin SYNOPSIS windres |
| 2420 | windres [options] [input-file] [output-file] |
| 2421 | @c man end |
| 2422 | @end smallexample |
| 2423 | |
| 2424 | @c man begin DESCRIPTION windres |
| 2425 | |
| 2426 | @command{windres} reads resources from an input file and copies them into |
| 2427 | an output file. Either file may be in one of three formats: |
| 2428 | |
| 2429 | @table @code |
| 2430 | @item rc |
| 2431 | A text format read by the Resource Compiler. |
| 2432 | |
| 2433 | @item res |
| 2434 | A binary format generated by the Resource Compiler. |
| 2435 | |
| 2436 | @item coff |
| 2437 | A COFF object or executable. |
| 2438 | @end table |
| 2439 | |
| 2440 | The exact description of these different formats is available in |
| 2441 | documentation from Microsoft. |
| 2442 | |
| 2443 | When @command{windres} converts from the @code{rc} format to the @code{res} |
| 2444 | format, it is acting like the Windows Resource Compiler. When |
| 2445 | @command{windres} converts from the @code{res} format to the @code{coff} |
| 2446 | format, it is acting like the Windows @code{CVTRES} program. |
| 2447 | |
| 2448 | When @command{windres} generates an @code{rc} file, the output is similar |
| 2449 | but not identical to the format expected for the input. When an input |
| 2450 | @code{rc} file refers to an external filename, an output @code{rc} file |
| 2451 | will instead include the file contents. |
| 2452 | |
| 2453 | If the input or output format is not specified, @command{windres} will |
| 2454 | guess based on the file name, or, for the input file, the file contents. |
| 2455 | A file with an extension of @file{.rc} will be treated as an @code{rc} |
| 2456 | file, a file with an extension of @file{.res} will be treated as a |
| 2457 | @code{res} file, and a file with an extension of @file{.o} or |
| 2458 | @file{.exe} will be treated as a @code{coff} file. |
| 2459 | |
| 2460 | If no output file is specified, @command{windres} will print the resources |
| 2461 | in @code{rc} format to standard output. |
| 2462 | |
| 2463 | The normal use is for you to write an @code{rc} file, use @command{windres} |
| 2464 | to convert it to a COFF object file, and then link the COFF file into |
| 2465 | your application. This will make the resources described in the |
| 2466 | @code{rc} file available to Windows. |
| 2467 | |
| 2468 | @c man end |
| 2469 | |
| 2470 | @c man begin OPTIONS windres |
| 2471 | |
| 2472 | @table @env |
| 2473 | @item -i @var{filename} |
| 2474 | @itemx --input @var{filename} |
| 2475 | The name of the input file. If this option is not used, then |
| 2476 | @command{windres} will use the first non-option argument as the input file |
| 2477 | name. If there are no non-option arguments, then @command{windres} will |
| 2478 | read from standard input. @command{windres} can not read a COFF file from |
| 2479 | standard input. |
| 2480 | |
| 2481 | @item -o @var{filename} |
| 2482 | @itemx --output @var{filename} |
| 2483 | The name of the output file. If this option is not used, then |
| 2484 | @command{windres} will use the first non-option argument, after any used |
| 2485 | for the input file name, as the output file name. If there is no |
| 2486 | non-option argument, then @command{windres} will write to standard output. |
| 2487 | @command{windres} can not write a COFF file to standard output. |
| 2488 | |
| 2489 | @item -I @var{format} |
| 2490 | @itemx --input-format @var{format} |
| 2491 | The input format to read. @var{format} may be @samp{res}, @samp{rc}, or |
| 2492 | @samp{coff}. If no input format is specified, @command{windres} will |
| 2493 | guess, as described above. |
| 2494 | |
| 2495 | @item -O @var{format} |
| 2496 | @itemx --output-format @var{format} |
| 2497 | The output format to generate. @var{format} may be @samp{res}, |
| 2498 | @samp{rc}, or @samp{coff}. If no output format is specified, |
| 2499 | @command{windres} will guess, as described above. |
| 2500 | |
| 2501 | @item -F @var{target} |
| 2502 | @itemx --target @var{target} |
| 2503 | Specify the BFD format to use for a COFF file as input or output. This |
| 2504 | is a BFD target name; you can use the @option{--help} option to see a list |
| 2505 | of supported targets. Normally @command{windres} will use the default |
| 2506 | format, which is the first one listed by the @option{--help} option. |
| 2507 | @ifclear man |
| 2508 | @ref{Target Selection}. |
| 2509 | @end ifclear |
| 2510 | |
| 2511 | @item --preprocessor @var{program} |
| 2512 | When @command{windres} reads an @code{rc} file, it runs it through the C |
| 2513 | preprocessor first. This option may be used to specify the preprocessor |
| 2514 | to use, including any leading arguments. The default preprocessor |
| 2515 | argument is @code{gcc -E -xc-header -DRC_INVOKED}. |
| 2516 | |
| 2517 | @item --include-dir @var{directory} |
| 2518 | Specify an include directory to use when reading an @code{rc} file. |
| 2519 | @command{windres} will pass this to the preprocessor as an @option{-I} |
| 2520 | option. @command{windres} will also search this directory when looking for |
| 2521 | files named in the @code{rc} file. |
| 2522 | |
| 2523 | @item -D @var{target} |
| 2524 | @itemx --define @var{sym}[=@var{val}] |
| 2525 | Specify a @option{-D} option to pass to the preprocessor when reading an |
| 2526 | @code{rc} file. |
| 2527 | |
| 2528 | @item -v |
| 2529 | Enable verbose mode. This tells you what the preprocessor is if you |
| 2530 | didn't specify one. |
| 2531 | |
| 2532 | @item --language @var{val} |
| 2533 | Specify the default language to use when reading an @code{rc} file. |
| 2534 | @var{val} should be a hexadecimal language code. The low eight bits are |
| 2535 | the language, and the high eight bits are the sublanguage. |
| 2536 | |
| 2537 | @item --use-temp-file |
| 2538 | Use a temporary file to instead of using popen to read the output of |
| 2539 | the preprocessor. Use this option if the popen implementation is buggy |
| 2540 | on the host (eg., certain non-English language versions of Windows 95 and |
| 2541 | Windows 98 are known to have buggy popen where the output will instead |
| 2542 | go the console). |
| 2543 | |
| 2544 | @item --no-use-temp-file |
| 2545 | Use popen, not a temporary file, to read the output of the preprocessor. |
| 2546 | This is the default behaviour. |
| 2547 | |
| 2548 | @item --help |
| 2549 | Prints a usage summary. |
| 2550 | |
| 2551 | @item --version |
| 2552 | Prints the version number for @command{windres}. |
| 2553 | |
| 2554 | @item --yydebug |
| 2555 | If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1}, |
| 2556 | this will turn on parser debugging. |
| 2557 | @end table |
| 2558 | |
| 2559 | @c man end |
| 2560 | |
| 2561 | @ignore |
| 2562 | @c man begin SEEALSO windres |
| 2563 | the Info entries for @file{binutils}. |
| 2564 | @c man end |
| 2565 | @end ignore |
| 2566 | |
| 2567 | @node dlltool |
| 2568 | @chapter Create files needed to build and use DLLs |
| 2569 | @cindex DLL |
| 2570 | @kindex dlltool |
| 2571 | |
| 2572 | @command{dlltool} may be used to create the files needed to build and use |
| 2573 | dynamic link libraries (DLLs). |
| 2574 | |
| 2575 | @quotation |
| 2576 | @emph{Warning:} @command{dlltool} is not always built as part of the binary |
| 2577 | utilities, since it is only useful for those targets which support DLLs. |
| 2578 | @end quotation |
| 2579 | |
| 2580 | @c man title dlltool Create files needed to build and use DLLs. |
| 2581 | |
| 2582 | @smallexample |
| 2583 | @c man begin SYNOPSIS dlltool |
| 2584 | dlltool [@option{-d}|@option{--input-def} @var{def-file-name}] |
| 2585 | [@option{-b}|@option{--base-file} @var{base-file-name}] |
| 2586 | [@option{-e}|@option{--output-exp} @var{exports-file-name}] |
| 2587 | [@option{-z}|@option{--output-def} @var{def-file-name}] |
| 2588 | [@option{-l}|@option{--output-lib} @var{library-file-name}] |
| 2589 | [@option{--export-all-symbols}] [@option{--no-export-all-symbols}] |
| 2590 | [@option{--exclude-symbols} @var{list}] |
| 2591 | [@option{--no-default-excludes}] |
| 2592 | [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}] |
| 2593 | [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}] |
| 2594 | [@option{-a}|@option{--add-indirect}] [@option{-U}|@option{--add-underscore}] [@option{-k}|@option{--kill-at}] |
| 2595 | [@option{-A}|@option{--add-stdcall-alias}] |
| 2596 | [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] [@option{-i}|@option{--interwork}] |
| 2597 | [@option{-n}|@option{--nodelete}] [@option{-v}|@option{--verbose}] |
| 2598 | [@option{-h}|@option{--help}] [@option{-V}|@option{--version}] |
| 2599 | [object-file @dots{}] |
| 2600 | @c man end |
| 2601 | @end smallexample |
| 2602 | |
| 2603 | @c man begin DESCRIPTION dlltool |
| 2604 | |
| 2605 | @command{dlltool} reads its inputs, which can come from the @option{-d} and |
| 2606 | @option{-b} options as well as object files specified on the command |
| 2607 | line. It then processes these inputs and if the @option{-e} option has |
| 2608 | been specified it creates a exports file. If the @option{-l} option |
| 2609 | has been specified it creates a library file and if the @option{-z} option |
| 2610 | has been specified it creates a def file. Any or all of the @option{-e}, |
| 2611 | @option{-l} and @option{-z} options can be present in one invocation of |
| 2612 | dlltool. |
| 2613 | |
| 2614 | When creating a DLL, along with the source for the DLL, it is necessary |
| 2615 | to have three other files. @command{dlltool} can help with the creation of |
| 2616 | these files. |
| 2617 | |
| 2618 | The first file is a @samp{.def} file which specifies which functions are |
| 2619 | exported from the DLL, which functions the DLL imports, and so on. This |
| 2620 | is a text file and can be created by hand, or @command{dlltool} can be used |
| 2621 | to create it using the @option{-z} option. In this case @command{dlltool} |
| 2622 | will scan the object files specified on its command line looking for |
| 2623 | those functions which have been specially marked as being exported and |
| 2624 | put entries for them in the .def file it creates. |
| 2625 | |
| 2626 | In order to mark a function as being exported from a DLL, it needs to |
| 2627 | have an @option{-export:<name_of_function>} entry in the @samp{.drectve} |
| 2628 | section of the object file. This can be done in C by using the |
| 2629 | asm() operator: |
| 2630 | |
| 2631 | @smallexample |
| 2632 | asm (".section .drectve"); |
| 2633 | asm (".ascii \"-export:my_func\""); |
| 2634 | |
| 2635 | int my_func (void) @{ @dots{} @} |
| 2636 | @end smallexample |
| 2637 | |
| 2638 | The second file needed for DLL creation is an exports file. This file |
| 2639 | is linked with the object files that make up the body of the DLL and it |
| 2640 | handles the interface between the DLL and the outside world. This is a |
| 2641 | binary file and it can be created by giving the @option{-e} option to |
| 2642 | @command{dlltool} when it is creating or reading in a .def file. |
| 2643 | |
| 2644 | The third file needed for DLL creation is the library file that programs |
| 2645 | will link with in order to access the functions in the DLL. This file |
| 2646 | can be created by giving the @option{-l} option to dlltool when it |
| 2647 | is creating or reading in a .def file. |
| 2648 | |
| 2649 | @command{dlltool} builds the library file by hand, but it builds the |
| 2650 | exports file by creating temporary files containing assembler statements |
| 2651 | and then assembling these. The @option{-S} command line option can be |
| 2652 | used to specify the path to the assembler that dlltool will use, |
| 2653 | and the @option{-f} option can be used to pass specific flags to that |
| 2654 | assembler. The @option{-n} can be used to prevent dlltool from deleting |
| 2655 | these temporary assembler files when it is done, and if @option{-n} is |
| 2656 | specified twice then this will prevent dlltool from deleting the |
| 2657 | temporary object files it used to build the library. |
| 2658 | |
| 2659 | Here is an example of creating a DLL from a source file @samp{dll.c} and |
| 2660 | also creating a program (from an object file called @samp{program.o}) |
| 2661 | that uses that DLL: |
| 2662 | |
| 2663 | @smallexample |
| 2664 | gcc -c dll.c |
| 2665 | dlltool -e exports.o -l dll.lib dll.o |
| 2666 | gcc dll.o exports.o -o dll.dll |
| 2667 | gcc program.o dll.lib -o program |
| 2668 | @end smallexample |
| 2669 | |
| 2670 | @c man end |
| 2671 | |
| 2672 | @c man begin OPTIONS dlltool |
| 2673 | |
| 2674 | The command line options have the following meanings: |
| 2675 | |
| 2676 | @table @env |
| 2677 | |
| 2678 | @item -d @var{filename} |
| 2679 | @itemx --input-def @var{filename} |
| 2680 | @cindex input .def file |
| 2681 | Specifies the name of a .def file to be read in and processed. |
| 2682 | |
| 2683 | @item -b @var{filename} |
| 2684 | @itemx --base-file @var{filename} |
| 2685 | @cindex base files |
| 2686 | Specifies the name of a base file to be read in and processed. The |
| 2687 | contents of this file will be added to the relocation section in the |
| 2688 | exports file generated by dlltool. |
| 2689 | |
| 2690 | @item -e @var{filename} |
| 2691 | @itemx --output-exp @var{filename} |
| 2692 | Specifies the name of the export file to be created by dlltool. |
| 2693 | |
| 2694 | @item -z @var{filename} |
| 2695 | @itemx --output-def @var{filename} |
| 2696 | Specifies the name of the .def file to be created by dlltool. |
| 2697 | |
| 2698 | @item -l @var{filename} |
| 2699 | @itemx --output-lib @var{filename} |
| 2700 | Specifies the name of the library file to be created by dlltool. |
| 2701 | |
| 2702 | @item --export-all-symbols |
| 2703 | Treat all global and weak defined symbols found in the input object |
| 2704 | files as symbols to be exported. There is a small list of symbols which |
| 2705 | are not exported by default; see the @option{--no-default-excludes} |
| 2706 | option. You may add to the list of symbols to not export by using the |
| 2707 | @option{--exclude-symbols} option. |
| 2708 | |
| 2709 | @item --no-export-all-symbols |
| 2710 | Only export symbols explicitly listed in an input .def file or in |
| 2711 | @samp{.drectve} sections in the input object files. This is the default |
| 2712 | behaviour. The @samp{.drectve} sections are created by @samp{dllexport} |
| 2713 | attributes in the source code. |
| 2714 | |
| 2715 | @item --exclude-symbols @var{list} |
| 2716 | Do not export the symbols in @var{list}. This is a list of symbol names |
| 2717 | separated by comma or colon characters. The symbol names should not |
| 2718 | contain a leading underscore. This is only meaningful when |
| 2719 | @option{--export-all-symbols} is used. |
| 2720 | |
| 2721 | @item --no-default-excludes |
| 2722 | When @option{--export-all-symbols} is used, it will by default avoid |
| 2723 | exporting certain special symbols. The current list of symbols to avoid |
| 2724 | exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0}, |
| 2725 | @samp{impure_ptr}. You may use the @option{--no-default-excludes} option |
| 2726 | to go ahead and export these special symbols. This is only meaningful |
| 2727 | when @option{--export-all-symbols} is used. |
| 2728 | |
| 2729 | @item -S @var{path} |
| 2730 | @itemx --as @var{path} |
| 2731 | Specifies the path, including the filename, of the assembler to be used |
| 2732 | to create the exports file. |
| 2733 | |
| 2734 | @item -f @var{switches} |
| 2735 | @itemx --as-flags @var{switches} |
| 2736 | Specifies any specific command line switches to be passed to the |
| 2737 | assembler when building the exports file. This option will work even if |
| 2738 | the @option{-S} option is not used. This option only takes one argument, |
| 2739 | and if it occurs more than once on the command line, then later |
| 2740 | occurrences will override earlier occurrences. So if it is necessary to |
| 2741 | pass multiple switches to the assembler they should be enclosed in |
| 2742 | double quotes. |
| 2743 | |
| 2744 | @item -D @var{name} |
| 2745 | @itemx --dll-name @var{name} |
| 2746 | Specifies the name to be stored in the .def file as the name of the DLL |
| 2747 | when the @option{-e} option is used. If this option is not present, then |
| 2748 | the filename given to the @option{-e} option will be used as the name of |
| 2749 | the DLL. |
| 2750 | |
| 2751 | @item -m @var{machine} |
| 2752 | @itemx -machine @var{machine} |
| 2753 | Specifies the type of machine for which the library file should be |
| 2754 | built. @command{dlltool} has a built in default type, depending upon how |
| 2755 | it was created, but this option can be used to override that. This is |
| 2756 | normally only useful when creating DLLs for an ARM processor, when the |
| 2757 | contents of the DLL are actually encode using Thumb instructions. |
| 2758 | |
| 2759 | @item -a |
| 2760 | @itemx --add-indirect |
| 2761 | Specifies that when @command{dlltool} is creating the exports file it |
| 2762 | should add a section which allows the exported functions to be |
| 2763 | referenced without using the import library. Whatever the hell that |
| 2764 | means! |
| 2765 | |
| 2766 | @item -U |
| 2767 | @itemx --add-underscore |
| 2768 | Specifies that when @command{dlltool} is creating the exports file it |
| 2769 | should prepend an underscore to the names of the exported functions. |
| 2770 | |
| 2771 | @item -k |
| 2772 | @itemx --kill-at |
| 2773 | Specifies that when @command{dlltool} is creating the exports file it |
| 2774 | should not append the string @samp{@@ <number>}. These numbers are |
| 2775 | called ordinal numbers and they represent another way of accessing the |
| 2776 | function in a DLL, other than by name. |
| 2777 | |
| 2778 | @item -A |
| 2779 | @itemx --add-stdcall-alias |
| 2780 | Specifies that when @command{dlltool} is creating the exports file it |
| 2781 | should add aliases for stdcall symbols without @samp{@@ <number>} |
| 2782 | in addition to the symbols with @samp{@@ <number>}. |
| 2783 | |
| 2784 | @item -x |
| 2785 | @itemx --no-idata4 |
| 2786 | Specifies that when @command{dlltool} is creating the exports and library |
| 2787 | files it should omit the @code{.idata4} section. This is for compatibility |
| 2788 | with certain operating systems. |
| 2789 | |
| 2790 | @item -c |
| 2791 | @itemx --no-idata5 |
| 2792 | Specifies that when @command{dlltool} is creating the exports and library |
| 2793 | files it should omit the @code{.idata5} section. This is for compatibility |
| 2794 | with certain operating systems. |
| 2795 | |
| 2796 | @item -i |
| 2797 | @itemx --interwork |
| 2798 | Specifies that @command{dlltool} should mark the objects in the library |
| 2799 | file and exports file that it produces as supporting interworking |
| 2800 | between ARM and Thumb code. |
| 2801 | |
| 2802 | @item -n |
| 2803 | @itemx --nodelete |
| 2804 | Makes @command{dlltool} preserve the temporary assembler files it used to |
| 2805 | create the exports file. If this option is repeated then dlltool will |
| 2806 | also preserve the temporary object files it uses to create the library |
| 2807 | file. |
| 2808 | |
| 2809 | @item -v |
| 2810 | @itemx --verbose |
| 2811 | Make dlltool describe what it is doing. |
| 2812 | |
| 2813 | @item -h |
| 2814 | @itemx --help |
| 2815 | Displays a list of command line options and then exits. |
| 2816 | |
| 2817 | @item -V |
| 2818 | @itemx --version |
| 2819 | Displays dlltool's version number and then exits. |
| 2820 | |
| 2821 | @end table |
| 2822 | |
| 2823 | @c man end |
| 2824 | |
| 2825 | @ignore |
| 2826 | @c man begin SEEALSO dlltool |
| 2827 | the Info entries for @file{binutils}. |
| 2828 | @c man end |
| 2829 | @end ignore |
| 2830 | |
| 2831 | @node readelf |
| 2832 | @chapter readelf |
| 2833 | |
| 2834 | @cindex ELF file information |
| 2835 | @kindex readelf |
| 2836 | |
| 2837 | @c man title readelf Displays information about ELF files. |
| 2838 | |
| 2839 | @smallexample |
| 2840 | @c man begin SYNOPSIS readelf |
| 2841 | readelf [@option{-a}|@option{--all}] |
| 2842 | [@option{-h}|@option{--file-header}] |
| 2843 | [@option{-l}|@option{--program-headers}|@option{--segments}] |
| 2844 | [@option{-S}|@option{--section-headers}|@option{--sections}] |
| 2845 | [@option{-e}|@option{--headers}] |
| 2846 | [@option{-s}|@option{--syms}|@option{--symbols}] |
| 2847 | [@option{-n}|@option{--notes}] |
| 2848 | [@option{-r}|@option{--relocs}] |
| 2849 | [@option{-u}|@option{--unwind}] |
| 2850 | [@option{-d}|@option{--dynamic}] |
| 2851 | [@option{-V}|@option{--version-info}] |
| 2852 | [@option{-D}|@option{--use-dynamic}] |
| 2853 | [@option{-x} <number>|@option{--hex-dump=}<number>] |
| 2854 | [@option{-w[liaprmfs]}|@option{--debug-dump}[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames,=str]] |
| 2855 | [@option{-histogram}] |
| 2856 | [@option{-v}|@option{--version}] |
| 2857 | [@option{-W}|@option{--wide}] |
| 2858 | [@option{-H}|@option{--help}] |
| 2859 | @var{elffile}@dots{} |
| 2860 | @c man end |
| 2861 | @end smallexample |
| 2862 | |
| 2863 | @c man begin DESCRIPTION readelf |
| 2864 | |
| 2865 | @command{readelf} displays information about one or more ELF format object |
| 2866 | files. The options control what particular information to display. |
| 2867 | |
| 2868 | @var{elffile}@dots{} are the object files to be examined. At the |
| 2869 | moment, @command{readelf} does not support examining archives, nor does it |
| 2870 | support examing 64 bit ELF files. |
| 2871 | |
| 2872 | @c man end |
| 2873 | |
| 2874 | @c man begin OPTIONS readelf |
| 2875 | |
| 2876 | The long and short forms of options, shown here as alternatives, are |
| 2877 | equivalent. At least one option besides @samp{-v} or @samp{-H} must be |
| 2878 | given. |
| 2879 | |
| 2880 | @table @env |
| 2881 | @item -a |
| 2882 | @itemx --all |
| 2883 | Equivalent to specifiying @option{--file-header}, |
| 2884 | @option{--program-headers}, @option{--sections}, @option{--symbols}, |
| 2885 | @option{--relocs}, @option{--dynamic}, @option{--notes} and |
| 2886 | @option{--version-info}. |
| 2887 | |
| 2888 | @item -h |
| 2889 | @itemx --file-header |
| 2890 | @cindex ELF file header information |
| 2891 | Displays the information contained in the ELF header at the start of the |
| 2892 | file. |
| 2893 | |
| 2894 | @item -l |
| 2895 | @itemx --program-headers |
| 2896 | @itemx --segments |
| 2897 | @cindex ELF program header information |
| 2898 | @cindex ELF segment information |
| 2899 | Displays the information contained in the file's segment headers, if it |
| 2900 | has any. |
| 2901 | |
| 2902 | @item -S |
| 2903 | @itemx --sections |
| 2904 | @itemx --section-headers |
| 2905 | @cindex ELF section information |
| 2906 | Displays the information contained in the file's section headers, if it |
| 2907 | has any. |
| 2908 | |
| 2909 | @item -s |
| 2910 | @itemx --symbols |
| 2911 | @itemx --syms |
| 2912 | @cindex ELF symbol table information |
| 2913 | Displays the entries in symbol table section of the file, if it has one. |
| 2914 | |
| 2915 | @item -e |
| 2916 | @itemx --headers |
| 2917 | Display all the headers in the file. Equivalent to @option{-h -l -S}. |
| 2918 | |
| 2919 | @item -n |
| 2920 | @itemx --notes |
| 2921 | @cindex ELF core notes |
| 2922 | Displays the contents of the NOTE segment, if it exists. |
| 2923 | |
| 2924 | @item -r |
| 2925 | @itemx --relocs |
| 2926 | @cindex ELF reloc information |
| 2927 | Displays the contents of the file's relocation section, if it has one. |
| 2928 | |
| 2929 | @item -u |
| 2930 | @itemx --unwind |
| 2931 | @cindex unwind information |
| 2932 | Displays the contents of the file's unwind section, if it has one. Only |
| 2933 | the unwind sections for IA64 ELF files are currently supported. |
| 2934 | |
| 2935 | @item -d |
| 2936 | @itemx --dynamic |
| 2937 | @cindex ELF dynamic section information |
| 2938 | Displays the contents of the file's dynamic section, if it has one. |
| 2939 | |
| 2940 | @item -V |
| 2941 | @itemx --version-info |
| 2942 | @cindex ELF version sections informations |
| 2943 | Displays the contents of the version sections in the file, it they |
| 2944 | exist. |
| 2945 | |
| 2946 | @item -D |
| 2947 | @itemx --use-dynamic |
| 2948 | When displaying symbols, this option makes @command{readelf} use the |
| 2949 | symbol table in the file's dynamic section, rather than the one in the |
| 2950 | symbols section. |
| 2951 | |
| 2952 | @item -x <number> |
| 2953 | @itemx --hex-dump=<number> |
| 2954 | Displays the contents of the indicated section as a hexadecimal dump. |
| 2955 | |
| 2956 | @item -w[liaprmfs] |
| 2957 | @itemx --debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames,=str] |
| 2958 | Displays the contents of the debug sections in the file, if any are |
| 2959 | present. If one of the optional letters or words follows the switch |
| 2960 | then only data found in those specific sections will be dumped. |
| 2961 | |
| 2962 | @item --histogram |
| 2963 | Display a histogram of bucket list lengths when displaying the contents |
| 2964 | of the symbol tables. |
| 2965 | |
| 2966 | @item -v |
| 2967 | @itemx --version |
| 2968 | Display the version number of readelf. |
| 2969 | |
| 2970 | @item -W |
| 2971 | @itemx --wide |
| 2972 | Don't break output lines to fit into 80 columns. By default |
| 2973 | @command{readelf} breaks section header and segment listing lines for |
| 2974 | 64-bit ELF files, so that they fit into 80 columns. This option causes |
| 2975 | @command{readelf} to print each section header resp. each segment one a |
| 2976 | single line, which is far more readable on terminals wider than 80 columns. |
| 2977 | |
| 2978 | @item -H |
| 2979 | @itemx --help |
| 2980 | Display the command line options understood by @command{readelf}. |
| 2981 | |
| 2982 | @end table |
| 2983 | |
| 2984 | @c man end |
| 2985 | |
| 2986 | @ignore |
| 2987 | @c man begin SEEALSO readelf |
| 2988 | objdump(1), and the Info entries for @file{binutils}. |
| 2989 | @c man end |
| 2990 | @end ignore |
| 2991 | |
| 2992 | @node Selecting The Target System |
| 2993 | @chapter Selecting the target system |
| 2994 | |
| 2995 | You can specify three aspects of the target system to the @sc{gnu} |
| 2996 | binary file utilities, each in several ways: |
| 2997 | |
| 2998 | @itemize @bullet |
| 2999 | @item |
| 3000 | the target |
| 3001 | |
| 3002 | @item |
| 3003 | the architecture |
| 3004 | |
| 3005 | @item |
| 3006 | the linker emulation (which applies to the linker only) |
| 3007 | @end itemize |
| 3008 | |
| 3009 | In the following summaries, the lists of ways to specify values are in |
| 3010 | order of decreasing precedence. The ways listed first override those |
| 3011 | listed later. |
| 3012 | |
| 3013 | The commands to list valid values only list the values for which the |
| 3014 | programs you are running were configured. If they were configured with |
| 3015 | @option{--enable-targets=all}, the commands list most of the available |
| 3016 | values, but a few are left out; not all targets can be configured in at |
| 3017 | once because some of them can only be configured @dfn{native} (on hosts |
| 3018 | with the same type as the target system). |
| 3019 | |
| 3020 | @menu |
| 3021 | * Target Selection:: |
| 3022 | * Architecture Selection:: |
| 3023 | * Linker Emulation Selection:: |
| 3024 | @end menu |
| 3025 | |
| 3026 | @node Target Selection |
| 3027 | @section Target Selection |
| 3028 | |
| 3029 | A @dfn{target} is an object file format. A given target may be |
| 3030 | supported for multiple architectures (@pxref{Architecture Selection}). |
| 3031 | A target selection may also have variations for different operating |
| 3032 | systems or architectures. |
| 3033 | |
| 3034 | The command to list valid target values is @samp{objdump -i} |
| 3035 | (the first column of output contains the relevant information). |
| 3036 | |
| 3037 | Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips}, |
| 3038 | @samp{a.out-sunos-big}. |
| 3039 | |
| 3040 | You can also specify a target using a configuration triplet. This is |
| 3041 | the same sort of name that is passed to @file{configure} to specify a |
| 3042 | target. When you use a configuration triplet as an argument, it must be |
| 3043 | fully canonicalized. You can see the canonical version of a triplet by |
| 3044 | running the shell script @file{config.sub} which is included with the |
| 3045 | sources. |
| 3046 | |
| 3047 | Some sample configuration triplets are: @samp{m68k-hp-bsd}, |
| 3048 | @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}. |
| 3049 | |
| 3050 | @subheading @command{objdump} Target |
| 3051 | |
| 3052 | Ways to specify: |
| 3053 | |
| 3054 | @enumerate |
| 3055 | @item |
| 3056 | command line option: @option{-b} or @option{--target} |
| 3057 | |
| 3058 | @item |
| 3059 | environment variable @code{GNUTARGET} |
| 3060 | |
| 3061 | @item |
| 3062 | deduced from the input file |
| 3063 | @end enumerate |
| 3064 | |
| 3065 | @subheading @command{objcopy} and @command{strip} Input Target |
| 3066 | |
| 3067 | Ways to specify: |
| 3068 | |
| 3069 | @enumerate |
| 3070 | @item |
| 3071 | command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target} |
| 3072 | |
| 3073 | @item |
| 3074 | environment variable @code{GNUTARGET} |
| 3075 | |
| 3076 | @item |
| 3077 | deduced from the input file |
| 3078 | @end enumerate |
| 3079 | |
| 3080 | @subheading @command{objcopy} and @command{strip} Output Target |
| 3081 | |
| 3082 | Ways to specify: |
| 3083 | |
| 3084 | @enumerate |
| 3085 | @item |
| 3086 | command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target} |
| 3087 | |
| 3088 | @item |
| 3089 | the input target (see ``@command{objcopy} and @command{strip} Input Target'' above) |
| 3090 | |
| 3091 | @item |
| 3092 | environment variable @code{GNUTARGET} |
| 3093 | |
| 3094 | @item |
| 3095 | deduced from the input file |
| 3096 | @end enumerate |
| 3097 | |
| 3098 | @subheading @command{nm}, @command{size}, and @command{strings} Target |
| 3099 | |
| 3100 | Ways to specify: |
| 3101 | |
| 3102 | @enumerate |
| 3103 | @item |
| 3104 | command line option: @option{--target} |
| 3105 | |
| 3106 | @item |
| 3107 | environment variable @code{GNUTARGET} |
| 3108 | |
| 3109 | @item |
| 3110 | deduced from the input file |
| 3111 | @end enumerate |
| 3112 | |
| 3113 | @subheading Linker Input Target |
| 3114 | |
| 3115 | Ways to specify: |
| 3116 | |
| 3117 | @enumerate |
| 3118 | @item |
| 3119 | command line option: @option{-b} or @option{--format} |
| 3120 | (@pxref{Options,,Options,ld.info,Using LD}) |
| 3121 | |
| 3122 | @item |
| 3123 | script command @code{TARGET} |
| 3124 | (@pxref{Option Commands,,Option Commands,ld.info,Using LD}) |
| 3125 | |
| 3126 | @item |
| 3127 | environment variable @code{GNUTARGET} |
| 3128 | (@pxref{Environment,,Environment,ld.info,Using LD}) |
| 3129 | |
| 3130 | @item |
| 3131 | the default target of the selected linker emulation |
| 3132 | (@pxref{Linker Emulation Selection}) |
| 3133 | @end enumerate |
| 3134 | |
| 3135 | @subheading Linker Output Target |
| 3136 | |
| 3137 | Ways to specify: |
| 3138 | |
| 3139 | @enumerate |
| 3140 | @item |
| 3141 | command line option: @option{-oformat} |
| 3142 | (@pxref{Options,,Options,ld.info,Using LD}) |
| 3143 | |
| 3144 | @item |
| 3145 | script command @code{OUTPUT_FORMAT} |
| 3146 | (@pxref{Option Commands,,Option Commands,ld.info,Using LD}) |
| 3147 | |
| 3148 | @item |
| 3149 | the linker input target (see ``Linker Input Target'' above) |
| 3150 | @end enumerate |
| 3151 | |
| 3152 | @node Architecture Selection |
| 3153 | @section Architecture selection |
| 3154 | |
| 3155 | An @dfn{architecture} is a type of @sc{cpu} on which an object file is |
| 3156 | to run. Its name may contain a colon, separating the name of the |
| 3157 | processor family from the name of the particular @sc{cpu}. |
| 3158 | |
| 3159 | The command to list valid architecture values is @samp{objdump -i} (the |
| 3160 | second column contains the relevant information). |
| 3161 | |
| 3162 | Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}. |
| 3163 | |
| 3164 | @subheading @command{objdump} Architecture |
| 3165 | |
| 3166 | Ways to specify: |
| 3167 | |
| 3168 | @enumerate |
| 3169 | @item |
| 3170 | command line option: @option{-m} or @option{--architecture} |
| 3171 | |
| 3172 | @item |
| 3173 | deduced from the input file |
| 3174 | @end enumerate |
| 3175 | |
| 3176 | @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture |
| 3177 | |
| 3178 | Ways to specify: |
| 3179 | |
| 3180 | @enumerate |
| 3181 | @item |
| 3182 | deduced from the input file |
| 3183 | @end enumerate |
| 3184 | |
| 3185 | @subheading Linker Input Architecture |
| 3186 | |
| 3187 | Ways to specify: |
| 3188 | |
| 3189 | @enumerate |
| 3190 | @item |
| 3191 | deduced from the input file |
| 3192 | @end enumerate |
| 3193 | |
| 3194 | @subheading Linker Output Architecture |
| 3195 | |
| 3196 | Ways to specify: |
| 3197 | |
| 3198 | @enumerate |
| 3199 | @item |
| 3200 | script command @code{OUTPUT_ARCH} |
| 3201 | (@pxref{Option Commands,,Option Commands,ld.info,Using LD}) |
| 3202 | |
| 3203 | @item |
| 3204 | the default architecture from the linker output target |
| 3205 | (@pxref{Target Selection}) |
| 3206 | @end enumerate |
| 3207 | |
| 3208 | @node Linker Emulation Selection |
| 3209 | @section Linker emulation selection |
| 3210 | |
| 3211 | A linker @dfn{emulation} is a ``personality'' of the linker, which gives |
| 3212 | the linker default values for the other aspects of the target system. |
| 3213 | In particular, it consists of |
| 3214 | |
| 3215 | @itemize @bullet |
| 3216 | @item |
| 3217 | the linker script |
| 3218 | |
| 3219 | @item |
| 3220 | the target |
| 3221 | |
| 3222 | @item |
| 3223 | several ``hook'' functions that are run at certain stages of the linking |
| 3224 | process to do special things that some targets require |
| 3225 | @end itemize |
| 3226 | |
| 3227 | The command to list valid linker emulation values is @samp{ld -V}. |
| 3228 | |
| 3229 | Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}. |
| 3230 | |
| 3231 | Ways to specify: |
| 3232 | |
| 3233 | @enumerate |
| 3234 | @item |
| 3235 | command line option: @option{-m} |
| 3236 | (@pxref{Options,,Options,ld.info,Using LD}) |
| 3237 | |
| 3238 | @item |
| 3239 | environment variable @code{LDEMULATION} |
| 3240 | |
| 3241 | @item |
| 3242 | compiled-in @code{DEFAULT_EMULATION} from @file{Makefile}, |
| 3243 | which comes from @code{EMUL} in @file{config/@var{target}.mt} |
| 3244 | @end enumerate |
| 3245 | |
| 3246 | @node Reporting Bugs |
| 3247 | @chapter Reporting Bugs |
| 3248 | @cindex bugs |
| 3249 | @cindex reporting bugs |
| 3250 | |
| 3251 | Your bug reports play an essential role in making the binary utilities |
| 3252 | reliable. |
| 3253 | |
| 3254 | Reporting a bug may help you by bringing a solution to your problem, or |
| 3255 | it may not. But in any case the principal function of a bug report is |
| 3256 | to help the entire community by making the next version of the binary |
| 3257 | utilities work better. Bug reports are your contribution to their |
| 3258 | maintenance. |
| 3259 | |
| 3260 | In order for a bug report to serve its purpose, you must include the |
| 3261 | information that enables us to fix the bug. |
| 3262 | |
| 3263 | @menu |
| 3264 | * Bug Criteria:: Have you found a bug? |
| 3265 | * Bug Reporting:: How to report bugs |
| 3266 | @end menu |
| 3267 | |
| 3268 | @node Bug Criteria |
| 3269 | @section Have you found a bug? |
| 3270 | @cindex bug criteria |
| 3271 | |
| 3272 | If you are not sure whether you have found a bug, here are some guidelines: |
| 3273 | |
| 3274 | @itemize @bullet |
| 3275 | @cindex fatal signal |
| 3276 | @cindex crash |
| 3277 | @item |
| 3278 | If a binary utility gets a fatal signal, for any input whatever, that is |
| 3279 | a bug. Reliable utilities never crash. |
| 3280 | |
| 3281 | @cindex error on valid input |
| 3282 | @item |
| 3283 | If a binary utility produces an error message for valid input, that is a |
| 3284 | bug. |
| 3285 | |
| 3286 | @item |
| 3287 | If you are an experienced user of binary utilities, your suggestions for |
| 3288 | improvement are welcome in any case. |
| 3289 | @end itemize |
| 3290 | |
| 3291 | @node Bug Reporting |
| 3292 | @section How to report bugs |
| 3293 | @cindex bug reports |
| 3294 | @cindex bugs, reporting |
| 3295 | |
| 3296 | A number of companies and individuals offer support for @sc{gnu} |
| 3297 | products. If you obtained the binary utilities from a support |
| 3298 | organization, we recommend you contact that organization first. |
| 3299 | |
| 3300 | You can find contact information for many support companies and |
| 3301 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs |
| 3302 | distribution. |
| 3303 | |
| 3304 | In any event, we also recommend that you send bug reports for the binary |
| 3305 | utilities to @samp{bug-binutils@@gnu.org}. |
| 3306 | |
| 3307 | The fundamental principle of reporting bugs usefully is this: |
| 3308 | @strong{report all the facts}. If you are not sure whether to state a |
| 3309 | fact or leave it out, state it! |
| 3310 | |
| 3311 | Often people omit facts because they think they know what causes the |
| 3312 | problem and assume that some details do not matter. Thus, you might |
| 3313 | assume that the name of a file you use in an example does not matter. |
| 3314 | Well, probably it does not, but one cannot be sure. Perhaps the bug is |
| 3315 | a stray memory reference which happens to fetch from the location where |
| 3316 | that pathname is stored in memory; perhaps, if the pathname were |
| 3317 | different, the contents of that location would fool the utility into |
| 3318 | doing the right thing despite the bug. Play it safe and give a |
| 3319 | specific, complete example. That is the easiest thing for you to do, |
| 3320 | and the most helpful. |
| 3321 | |
| 3322 | Keep in mind that the purpose of a bug report is to enable us to fix the bug if |
| 3323 | it is new to us. Therefore, always write your bug reports on the assumption |
| 3324 | that the bug has not been reported previously. |
| 3325 | |
| 3326 | Sometimes people give a few sketchy facts and ask, ``Does this ring a |
| 3327 | bell?'' Those bug reports are useless, and we urge everyone to |
| 3328 | @emph{refuse to respond to them} except to chide the sender to report |
| 3329 | bugs properly. |
| 3330 | |
| 3331 | To enable us to fix the bug, you should include all these things: |
| 3332 | |
| 3333 | @itemize @bullet |
| 3334 | @item |
| 3335 | The version of the utility. Each utility announces it if you start it |
| 3336 | with the @option{--version} argument. |
| 3337 | |
| 3338 | Without this, we will not know whether there is any point in looking for |
| 3339 | the bug in the current version of the binary utilities. |
| 3340 | |
| 3341 | @item |
| 3342 | Any patches you may have applied to the source, including any patches |
| 3343 | made to the @code{BFD} library. |
| 3344 | |
| 3345 | @item |
| 3346 | The type of machine you are using, and the operating system name and |
| 3347 | version number. |
| 3348 | |
| 3349 | @item |
| 3350 | What compiler (and its version) was used to compile the utilities---e.g. |
| 3351 | ``@code{gcc-2.7}''. |
| 3352 | |
| 3353 | @item |
| 3354 | The command arguments you gave the utility to observe the bug. To |
| 3355 | guarantee you will not omit something important, list them all. A copy |
| 3356 | of the Makefile (or the output from make) is sufficient. |
| 3357 | |
| 3358 | If we were to try to guess the arguments, we would probably guess wrong |
| 3359 | and then we might not encounter the bug. |
| 3360 | |
| 3361 | @item |
| 3362 | A complete input file, or set of input files, that will reproduce the |
| 3363 | bug. If the utility is reading an object file or files, then it is |
| 3364 | generally most helpful to send the actual object files, uuencoded if |
| 3365 | necessary to get them through the mail system. Note that |
| 3366 | @samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid |
| 3367 | sending very large files to it. Making the files available for |
| 3368 | anonymous FTP is OK. |
| 3369 | |
| 3370 | If the source files were produced exclusively using @sc{gnu} programs |
| 3371 | (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it |
| 3372 | may be OK to send the source files rather than the object files. In |
| 3373 | this case, be sure to say exactly what version of @command{gcc}, or |
| 3374 | whatever, was used to produce the object files. Also say how |
| 3375 | @command{gcc}, or whatever, was configured. |
| 3376 | |
| 3377 | @item |
| 3378 | A description of what behavior you observe that you believe is |
| 3379 | incorrect. For example, ``It gets a fatal signal.'' |
| 3380 | |
| 3381 | Of course, if the bug is that the utility gets a fatal signal, then we |
| 3382 | will certainly notice it. But if the bug is incorrect output, we might |
| 3383 | not notice unless it is glaringly wrong. You might as well not give us |
| 3384 | a chance to make a mistake. |
| 3385 | |
| 3386 | Even if the problem you experience is a fatal signal, you should still |
| 3387 | say so explicitly. Suppose something strange is going on, such as your |
| 3388 | copy of the utility is out of synch, or you have encountered a bug in |
| 3389 | the C library on your system. (This has happened!) Your copy might |
| 3390 | crash and ours would not. If you told us to expect a crash, then when |
| 3391 | ours fails to crash, we would know that the bug was not happening for |
| 3392 | us. If you had not told us to expect a crash, then we would not be able |
| 3393 | to draw any conclusion from our observations. |
| 3394 | |
| 3395 | @item |
| 3396 | If you wish to suggest changes to the source, send us context diffs, as |
| 3397 | generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p} |
| 3398 | option. Always send diffs from the old file to the new file. If you |
| 3399 | wish to discuss something in the @command{ld} source, refer to it by |
| 3400 | context, not by line number. |
| 3401 | |
| 3402 | The line numbers in our development sources will not match those in your |
| 3403 | sources. Your line numbers would convey no useful information to us. |
| 3404 | @end itemize |
| 3405 | |
| 3406 | Here are some things that are not necessary: |
| 3407 | |
| 3408 | @itemize @bullet |
| 3409 | @item |
| 3410 | A description of the envelope of the bug. |
| 3411 | |
| 3412 | Often people who encounter a bug spend a lot of time investigating |
| 3413 | which changes to the input file will make the bug go away and which |
| 3414 | changes will not affect it. |
| 3415 | |
| 3416 | This is often time consuming and not very useful, because the way we |
| 3417 | will find the bug is by running a single example under the debugger |
| 3418 | with breakpoints, not by pure deduction from a series of examples. |
| 3419 | We recommend that you save your time for something else. |
| 3420 | |
| 3421 | Of course, if you can find a simpler example to report @emph{instead} |
| 3422 | of the original one, that is a convenience for us. Errors in the |
| 3423 | output will be easier to spot, running under the debugger will take |
| 3424 | less time, and so on. |
| 3425 | |
| 3426 | However, simplification is not vital; if you do not want to do this, |
| 3427 | report the bug anyway and send us the entire test case you used. |
| 3428 | |
| 3429 | @item |
| 3430 | A patch for the bug. |
| 3431 | |
| 3432 | A patch for the bug does help us if it is a good one. But do not omit |
| 3433 | the necessary information, such as the test case, on the assumption that |
| 3434 | a patch is all we need. We might see problems with your patch and decide |
| 3435 | to fix the problem another way, or we might not understand it at all. |
| 3436 | |
| 3437 | Sometimes with programs as complicated as the binary utilities it is |
| 3438 | very hard to construct an example that will make the program follow a |
| 3439 | certain path through the code. If you do not send us the example, we |
| 3440 | will not be able to construct one, so we will not be able to verify that |
| 3441 | the bug is fixed. |
| 3442 | |
| 3443 | And if we cannot understand what bug you are trying to fix, or why your |
| 3444 | patch should be an improvement, we will not install it. A test case will |
| 3445 | help us to understand. |
| 3446 | |
| 3447 | @item |
| 3448 | A guess about what the bug is or what it depends on. |
| 3449 | |
| 3450 | Such guesses are usually wrong. Even we cannot guess right about such |
| 3451 | things without first using the debugger to find the facts. |
| 3452 | @end itemize |
| 3453 | |
| 3454 | @node GNU Free Documentation License |
| 3455 | @chapter GNU Free Documentation License |
| 3456 | @cindex GNU Free Documentation License |
| 3457 | |
| 3458 | GNU Free Documentation License |
| 3459 | |
| 3460 | Version 1.1, March 2000 |
| 3461 | |
| 3462 | Copyright (C) 2000 Free Software Foundation, Inc. |
| 3463 | 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 3464 | |
| 3465 | Everyone is permitted to copy and distribute verbatim copies |
| 3466 | of this license document, but changing it is not allowed. |
| 3467 | |
| 3468 | |
| 3469 | 0. PREAMBLE |
| 3470 | |
| 3471 | The purpose of this License is to make a manual, textbook, or other |
| 3472 | written document "free" in the sense of freedom: to assure everyone |
| 3473 | the effective freedom to copy and redistribute it, with or without |
| 3474 | modifying it, either commercially or noncommercially. Secondarily, |
| 3475 | this License preserves for the author and publisher a way to get |
| 3476 | credit for their work, while not being considered responsible for |
| 3477 | modifications made by others. |
| 3478 | |
| 3479 | This License is a kind of "copyleft", which means that derivative |
| 3480 | works of the document must themselves be free in the same sense. It |
| 3481 | complements the GNU General Public License, which is a copyleft |
| 3482 | license designed for free software. |
| 3483 | |
| 3484 | We have designed this License in order to use it for manuals for free |
| 3485 | software, because free software needs free documentation: a free |
| 3486 | program should come with manuals providing the same freedoms that the |
| 3487 | software does. But this License is not limited to software manuals; |
| 3488 | it can be used for any textual work, regardless of subject matter or |
| 3489 | whether it is published as a printed book. We recommend this License |
| 3490 | principally for works whose purpose is instruction or reference. |
| 3491 | |
| 3492 | |
| 3493 | 1. APPLICABILITY AND DEFINITIONS |
| 3494 | |
| 3495 | This License applies to any manual or other work that contains a |
| 3496 | notice placed by the copyright holder saying it can be distributed |
| 3497 | under the terms of this License. The "Document", below, refers to any |
| 3498 | such manual or work. Any member of the public is a licensee, and is |
| 3499 | addressed as "you". |
| 3500 | |
| 3501 | A "Modified Version" of the Document means any work containing the |
| 3502 | Document or a portion of it, either copied verbatim, or with |
| 3503 | modifications and/or translated into another language. |
| 3504 | |
| 3505 | A "Secondary Section" is a named appendix or a front-matter section of |
| 3506 | the Document that deals exclusively with the relationship of the |
| 3507 | publishers or authors of the Document to the Document's overall subject |
| 3508 | (or to related matters) and contains nothing that could fall directly |
| 3509 | within that overall subject. (For example, if the Document is in part a |
| 3510 | textbook of mathematics, a Secondary Section may not explain any |
| 3511 | mathematics.) The relationship could be a matter of historical |
| 3512 | connection with the subject or with related matters, or of legal, |
| 3513 | commercial, philosophical, ethical or political position regarding |
| 3514 | them. |
| 3515 | |
| 3516 | The "Invariant Sections" are certain Secondary Sections whose titles |
| 3517 | are designated, as being those of Invariant Sections, in the notice |
| 3518 | that says that the Document is released under this License. |
| 3519 | |
| 3520 | The "Cover Texts" are certain short passages of text that are listed, |
| 3521 | as Front-Cover Texts or Back-Cover Texts, in the notice that says that |
| 3522 | the Document is released under this License. |
| 3523 | |
| 3524 | A "Transparent" copy of the Document means a machine-readable copy, |
| 3525 | represented in a format whose specification is available to the |
| 3526 | general public, whose contents can be viewed and edited directly and |
| 3527 | straightforwardly with generic text editors or (for images composed of |
| 3528 | pixels) generic paint programs or (for drawings) some widely available |
| 3529 | drawing editor, and that is suitable for input to text formatters or |
| 3530 | for automatic translation to a variety of formats suitable for input |
| 3531 | to text formatters. A copy made in an otherwise Transparent file |
| 3532 | format whose markup has been designed to thwart or discourage |
| 3533 | subsequent modification by readers is not Transparent. A copy that is |
| 3534 | not "Transparent" is called "Opaque". |
| 3535 | |
| 3536 | Examples of suitable formats for Transparent copies include plain |
| 3537 | ASCII without markup, Texinfo input format, LaTeX input format, SGML |
| 3538 | or XML using a publicly available DTD, and standard-conforming simple |
| 3539 | HTML designed for human modification. Opaque formats include |
| 3540 | PostScript, PDF, proprietary formats that can be read and edited only |
| 3541 | by proprietary word processors, SGML or XML for which the DTD and/or |
| 3542 | processing tools are not generally available, and the |
| 3543 | machine-generated HTML produced by some word processors for output |
| 3544 | purposes only. |
| 3545 | |
| 3546 | The "Title Page" means, for a printed book, the title page itself, |
| 3547 | plus such following pages as are needed to hold, legibly, the material |
| 3548 | this License requires to appear in the title page. For works in |
| 3549 | formats which do not have any title page as such, "Title Page" means |
| 3550 | the text near the most prominent appearance of the work's title, |
| 3551 | preceding the beginning of the body of the text. |
| 3552 | |
| 3553 | |
| 3554 | 2. VERBATIM COPYING |
| 3555 | |
| 3556 | You may copy and distribute the Document in any medium, either |
| 3557 | commercially or noncommercially, provided that this License, the |
| 3558 | copyright notices, and the license notice saying this License applies |
| 3559 | to the Document are reproduced in all copies, and that you add no other |
| 3560 | conditions whatsoever to those of this License. You may not use |
| 3561 | technical measures to obstruct or control the reading or further |
| 3562 | copying of the copies you make or distribute. However, you may accept |
| 3563 | compensation in exchange for copies. If you distribute a large enough |
| 3564 | number of copies you must also follow the conditions in section 3. |
| 3565 | |
| 3566 | You may also lend copies, under the same conditions stated above, and |
| 3567 | you may publicly display copies. |
| 3568 | |
| 3569 | |
| 3570 | 3. COPYING IN QUANTITY |
| 3571 | |
| 3572 | If you publish printed copies of the Document numbering more than 100, |
| 3573 | and the Document's license notice requires Cover Texts, you must enclose |
| 3574 | the copies in covers that carry, clearly and legibly, all these Cover |
| 3575 | Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on |
| 3576 | the back cover. Both covers must also clearly and legibly identify |
| 3577 | you as the publisher of these copies. The front cover must present |
| 3578 | the full title with all words of the title equally prominent and |
| 3579 | visible. You may add other material on the covers in addition. |
| 3580 | Copying with changes limited to the covers, as long as they preserve |
| 3581 | the title of the Document and satisfy these conditions, can be treated |
| 3582 | as verbatim copying in other respects. |
| 3583 | |
| 3584 | If the required texts for either cover are too voluminous to fit |
| 3585 | legibly, you should put the first ones listed (as many as fit |
| 3586 | reasonably) on the actual cover, and continue the rest onto adjacent |
| 3587 | pages. |
| 3588 | |
| 3589 | If you publish or distribute Opaque copies of the Document numbering |
| 3590 | more than 100, you must either include a machine-readable Transparent |
| 3591 | copy along with each Opaque copy, or state in or with each Opaque copy |
| 3592 | a publicly-accessible computer-network location containing a complete |
| 3593 | Transparent copy of the Document, free of added material, which the |
| 3594 | general network-using public has access to download anonymously at no |
| 3595 | charge using public-standard network protocols. If you use the latter |
| 3596 | option, you must take reasonably prudent steps, when you begin |
| 3597 | distribution of Opaque copies in quantity, to ensure that this |
| 3598 | Transparent copy will remain thus accessible at the stated location |
| 3599 | until at least one year after the last time you distribute an Opaque |
| 3600 | copy (directly or through your agents or retailers) of that edition to |
| 3601 | the public. |
| 3602 | |
| 3603 | It is requested, but not required, that you contact the authors of the |
| 3604 | Document well before redistributing any large number of copies, to give |
| 3605 | them a chance to provide you with an updated version of the Document. |
| 3606 | |
| 3607 | |
| 3608 | 4. MODIFICATIONS |
| 3609 | |
| 3610 | You may copy and distribute a Modified Version of the Document under |
| 3611 | the conditions of sections 2 and 3 above, provided that you release |
| 3612 | the Modified Version under precisely this License, with the Modified |
| 3613 | Version filling the role of the Document, thus licensing distribution |
| 3614 | and modification of the Modified Version to whoever possesses a copy |
| 3615 | of it. In addition, you must do these things in the Modified Version: |
| 3616 | |
| 3617 | A. Use in the Title Page (and on the covers, if any) a title distinct |
| 3618 | from that of the Document, and from those of previous versions |
| 3619 | (which should, if there were any, be listed in the History section |
| 3620 | of the Document). You may use the same title as a previous version |
| 3621 | if the original publisher of that version gives permission. |
| 3622 | B. List on the Title Page, as authors, one or more persons or entities |
| 3623 | responsible for authorship of the modifications in the Modified |
| 3624 | Version, together with at least five of the principal authors of the |
| 3625 | Document (all of its principal authors, if it has less than five). |
| 3626 | C. State on the Title page the name of the publisher of the |
| 3627 | Modified Version, as the publisher. |
| 3628 | D. Preserve all the copyright notices of the Document. |
| 3629 | E. Add an appropriate copyright notice for your modifications |
| 3630 | adjacent to the other copyright notices. |
| 3631 | F. Include, immediately after the copyright notices, a license notice |
| 3632 | giving the public permission to use the Modified Version under the |
| 3633 | terms of this License, in the form shown in the Addendum below. |
| 3634 | G. Preserve in that license notice the full lists of Invariant Sections |
| 3635 | and required Cover Texts given in the Document's license notice. |
| 3636 | H. Include an unaltered copy of this License. |
| 3637 | I. Preserve the section entitled "History", and its title, and add to |
| 3638 | it an item stating at least the title, year, new authors, and |
| 3639 | publisher of the Modified Version as given on the Title Page. If |
| 3640 | there is no section entitled "History" in the Document, create one |
| 3641 | stating the title, year, authors, and publisher of the Document as |
| 3642 | given on its Title Page, then add an item describing the Modified |
| 3643 | Version as stated in the previous sentence. |
| 3644 | J. Preserve the network location, if any, given in the Document for |
| 3645 | public access to a Transparent copy of the Document, and likewise |
| 3646 | the network locations given in the Document for previous versions |
| 3647 | it was based on. These may be placed in the "History" section. |
| 3648 | You may omit a network location for a work that was published at |
| 3649 | least four years before the Document itself, or if the original |
| 3650 | publisher of the version it refers to gives permission. |
| 3651 | K. In any section entitled "Acknowledgements" or "Dedications", |
| 3652 | preserve the section's title, and preserve in the section all the |
| 3653 | substance and tone of each of the contributor acknowledgements |
| 3654 | and/or dedications given therein. |
| 3655 | L. Preserve all the Invariant Sections of the Document, |
| 3656 | unaltered in their text and in their titles. Section numbers |
| 3657 | or the equivalent are not considered part of the section titles. |
| 3658 | M. Delete any section entitled "Endorsements". Such a section |
| 3659 | may not be included in the Modified Version. |
| 3660 | N. Do not retitle any existing section as "Endorsements" |
| 3661 | or to conflict in title with any Invariant Section. |
| 3662 | |
| 3663 | If the Modified Version includes new front-matter sections or |
| 3664 | appendices that qualify as Secondary Sections and contain no material |
| 3665 | copied from the Document, you may at your option designate some or all |
| 3666 | of these sections as invariant. To do this, add their titles to the |
| 3667 | list of Invariant Sections in the Modified Version's license notice. |
| 3668 | These titles must be distinct from any other section titles. |
| 3669 | |
| 3670 | You may add a section entitled "Endorsements", provided it contains |
| 3671 | nothing but endorsements of your Modified Version by various |
| 3672 | parties--for example, statements of peer review or that the text has |
| 3673 | been approved by an organization as the authoritative definition of a |
| 3674 | standard. |
| 3675 | |
| 3676 | You may add a passage of up to five words as a Front-Cover Text, and a |
| 3677 | passage of up to 25 words as a Back-Cover Text, to the end of the list |
| 3678 | of Cover Texts in the Modified Version. Only one passage of |
| 3679 | Front-Cover Text and one of Back-Cover Text may be added by (or |
| 3680 | through arrangements made by) any one entity. If the Document already |
| 3681 | includes a cover text for the same cover, previously added by you or |
| 3682 | by arrangement made by the same entity you are acting on behalf of, |
| 3683 | you may not add another; but you may replace the old one, on explicit |
| 3684 | permission from the previous publisher that added the old one. |
| 3685 | |
| 3686 | The author(s) and publisher(s) of the Document do not by this License |
| 3687 | give permission to use their names for publicity for or to assert or |
| 3688 | imply endorsement of any Modified Version. |
| 3689 | |
| 3690 | |
| 3691 | 5. COMBINING DOCUMENTS |
| 3692 | |
| 3693 | You may combine the Document with other documents released under this |
| 3694 | License, under the terms defined in section 4 above for modified |
| 3695 | versions, provided that you include in the combination all of the |
| 3696 | Invariant Sections of all of the original documents, unmodified, and |
| 3697 | list them all as Invariant Sections of your combined work in its |
| 3698 | license notice. |
| 3699 | |
| 3700 | The combined work need only contain one copy of this License, and |
| 3701 | multiple identical Invariant Sections may be replaced with a single |
| 3702 | copy. If there are multiple Invariant Sections with the same name but |
| 3703 | different contents, make the title of each such section unique by |
| 3704 | adding at the end of it, in parentheses, the name of the original |
| 3705 | author or publisher of that section if known, or else a unique number. |
| 3706 | Make the same adjustment to the section titles in the list of |
| 3707 | Invariant Sections in the license notice of the combined work. |
| 3708 | |
| 3709 | In the combination, you must combine any sections entitled "History" |
| 3710 | in the various original documents, forming one section entitled |
| 3711 | "History"; likewise combine any sections entitled "Acknowledgements", |
| 3712 | and any sections entitled "Dedications". You must delete all sections |
| 3713 | entitled "Endorsements." |
| 3714 | |
| 3715 | |
| 3716 | 6. COLLECTIONS OF DOCUMENTS |
| 3717 | |
| 3718 | You may make a collection consisting of the Document and other documents |
| 3719 | released under this License, and replace the individual copies of this |
| 3720 | License in the various documents with a single copy that is included in |
| 3721 | the collection, provided that you follow the rules of this License for |
| 3722 | verbatim copying of each of the documents in all other respects. |
| 3723 | |
| 3724 | You may extract a single document from such a collection, and distribute |
| 3725 | it individually under this License, provided you insert a copy of this |
| 3726 | License into the extracted document, and follow this License in all |
| 3727 | other respects regarding verbatim copying of that document. |
| 3728 | |
| 3729 | |
| 3730 | 7. AGGREGATION WITH INDEPENDENT WORKS |
| 3731 | |
| 3732 | A compilation of the Document or its derivatives with other separate |
| 3733 | and independent documents or works, in or on a volume of a storage or |
| 3734 | distribution medium, does not as a whole count as a Modified Version |
| 3735 | of the Document, provided no compilation copyright is claimed for the |
| 3736 | compilation. Such a compilation is called an "aggregate", and this |
| 3737 | License does not apply to the other self-contained works thus compiled |
| 3738 | with the Document, on account of their being thus compiled, if they |
| 3739 | are not themselves derivative works of the Document. |
| 3740 | |
| 3741 | If the Cover Text requirement of section 3 is applicable to these |
| 3742 | copies of the Document, then if the Document is less than one quarter |
| 3743 | of the entire aggregate, the Document's Cover Texts may be placed on |
| 3744 | covers that surround only the Document within the aggregate. |
| 3745 | Otherwise they must appear on covers around the whole aggregate. |
| 3746 | |
| 3747 | |
| 3748 | 8. TRANSLATION |
| 3749 | |
| 3750 | Translation is considered a kind of modification, so you may |
| 3751 | distribute translations of the Document under the terms of section 4. |
| 3752 | Replacing Invariant Sections with translations requires special |
| 3753 | permission from their copyright holders, but you may include |
| 3754 | translations of some or all Invariant Sections in addition to the |
| 3755 | original versions of these Invariant Sections. You may include a |
| 3756 | translation of this License provided that you also include the |
| 3757 | original English version of this License. In case of a disagreement |
| 3758 | between the translation and the original English version of this |
| 3759 | License, the original English version will prevail. |
| 3760 | |
| 3761 | |
| 3762 | 9. TERMINATION |
| 3763 | |
| 3764 | You may not copy, modify, sublicense, or distribute the Document except |
| 3765 | as expressly provided for under this License. Any other attempt to |
| 3766 | copy, modify, sublicense or distribute the Document is void, and will |
| 3767 | automatically terminate your rights under this License. However, |
| 3768 | parties who have received copies, or rights, from you under this |
| 3769 | License will not have their licenses terminated so long as such |
| 3770 | parties remain in full compliance. |
| 3771 | |
| 3772 | |
| 3773 | 10. FUTURE REVISIONS OF THIS LICENSE |
| 3774 | |
| 3775 | The Free Software Foundation may publish new, revised versions |
| 3776 | of the GNU Free Documentation License from time to time. Such new |
| 3777 | versions will be similar in spirit to the present version, but may |
| 3778 | differ in detail to address new problems or concerns. See |
| 3779 | http://www.gnu.org/copyleft/. |
| 3780 | |
| 3781 | Each version of the License is given a distinguishing version number. |
| 3782 | If the Document specifies that a particular numbered version of this |
| 3783 | License "or any later version" applies to it, you have the option of |
| 3784 | following the terms and conditions either of that specified version or |
| 3785 | of any later version that has been published (not as a draft) by the |
| 3786 | Free Software Foundation. If the Document does not specify a version |
| 3787 | number of this License, you may choose any version ever published (not |
| 3788 | as a draft) by the Free Software Foundation. |
| 3789 | |
| 3790 | |
| 3791 | ADDENDUM: How to use this License for your documents |
| 3792 | |
| 3793 | To use this License in a document you have written, include a copy of |
| 3794 | the License in the document and put the following copyright and |
| 3795 | license notices just after the title page: |
| 3796 | |
| 3797 | @smallexample |
| 3798 | Copyright (c) YEAR YOUR NAME. |
| 3799 | Permission is granted to copy, distribute and/or modify this document |
| 3800 | under the terms of the GNU Free Documentation License, Version 1.1 |
| 3801 | or any later version published by the Free Software Foundation; |
| 3802 | with the Invariant Sections being LIST THEIR TITLES, with the |
| 3803 | Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. |
| 3804 | A copy of the license is included in the section entitled "GNU |
| 3805 | Free Documentation License". |
| 3806 | @end smallexample |
| 3807 | |
| 3808 | If you have no Invariant Sections, write "with no Invariant Sections" |
| 3809 | instead of saying which ones are invariant. If you have no |
| 3810 | Front-Cover Texts, write "no Front-Cover Texts" instead of |
| 3811 | "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. |
| 3812 | |
| 3813 | If your document contains nontrivial examples of program code, we |
| 3814 | recommend releasing these examples in parallel under your choice of |
| 3815 | free software license, such as the GNU General Public License, |
| 3816 | to permit their use in free software. |
| 3817 | |
| 3818 | @node Index |
| 3819 | @unnumbered Index |
| 3820 | |
| 3821 | @printindex cp |
| 3822 | |
| 3823 | @contents |
| 3824 | @bye |