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