Commit | Line | Data |
---|---|---|
765a273f | 1 | \input texinfo @c -*- Texinfo -*- |
c72af735 | 2 | @setfilename binutils.info |
9bae56c5 | 3 | @include config.texi |
c72af735 | 4 | |
9abcc3b8 RP |
5 | @ifinfo |
6 | @format | |
7 | START-INFO-DIR-ENTRY | |
20f774c1 RP |
8 | * Binutils: (binutils). The GNU binary utilities "ar", "objcopy", |
9 | "objdump", "nm", "nlmconv", "size", | |
10 | "strings", "strip", and "ranlib". | |
9abcc3b8 RP |
11 | END-INFO-DIR-ENTRY |
12 | @end format | |
13 | @end ifinfo | |
c72af735 | 14 | |
8b2c2275 | 15 | @ifinfo |
54f74247 | 16 | Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc. |
8b2c2275 RP |
17 | |
18 | Permission is granted to make and distribute verbatim copies of | |
19 | this manual provided the copyright notice and this permission notice | |
20 | are preserved on all copies. | |
21 | ||
22 | @ignore | |
23 | Permission is granted to process this file through TeX and print the | |
24 | results, provided the printed document carries a copying permission | |
25 | notice identical to this one except for the removal of this paragraph | |
26 | (this paragraph not being relevant to the printed manual). | |
27 | ||
28 | @end ignore | |
29 | ||
30 | Permission is granted to copy and distribute modified versions of this | |
31 | manual under the conditions for verbatim copying, provided also that | |
32 | the entire resulting derived work is distributed under the terms of a | |
33 | permission notice identical to this one. | |
34 | ||
35 | Permission is granted to copy and distribute translations of this manual | |
36 | into another language, under the above conditions for modified versions. | |
37 | @end ifinfo | |
38 | ||
c72af735 RP |
39 | @synindex ky cp |
40 | @c | |
df14d957 | 41 | @c This file documents the GNU binary utilities "ar", "ld", "objcopy", |
ba7c8e29 | 42 | @c "objdump", "nm", "size", "strings", "strip", and "ranlib". |
c72af735 | 43 | @c |
54f74247 | 44 | @c Copyright (C) 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc. |
c72af735 RP |
45 | @c |
46 | @c This text may be freely distributed under the terms of the GNU | |
47 | @c General Public License. | |
48 | @c | |
27e94bd5 | 49 | |
c72af735 | 50 | @setchapternewpage odd |
b94ff924 | 51 | @settitle @sc{gnu} Binary Utilities |
4928b97b RP |
52 | @titlepage |
53 | @finalout | |
b94ff924 | 54 | @title The @sc{gnu} Binary Utilities |
9bae56c5 | 55 | @subtitle Version @value{VERSION} |
c72af735 | 56 | @sp 1 |
e32341a7 | 57 | @subtitle May 1993 |
c72af735 | 58 | @author Roland H. Pesch |
4961ce5b | 59 | @author Jeffrey M. Osier |
c72af735 RP |
60 | @author Cygnus Support |
61 | @page | |
62 | ||
63 | @tex | |
650a49f0 | 64 | {\parskip=0pt \hfill Cygnus Support\par \hfill |
c72af735 RP |
65 | \TeX{}info \texinfoversion\par } |
66 | @end tex | |
67 | ||
68 | @vskip 0pt plus 1filll | |
54f74247 | 69 | Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc. |
c72af735 RP |
70 | |
71 | Permission is granted to make and distribute verbatim copies of | |
72 | this manual provided the copyright notice and this permission notice | |
73 | are preserved on all copies. | |
74 | ||
75 | Permission is granted to copy and distribute modified versions of this | |
76 | manual under the conditions for verbatim copying, provided also that | |
77 | the entire resulting derived work is distributed under the terms of a | |
78 | permission notice identical to this one. | |
79 | ||
80 | Permission is granted to copy and distribute translations of this manual | |
81 | into another language, under the above conditions for modified versions. | |
82 | @end titlepage | |
83 | ||
eae04238 | 84 | @node Top |
8981cac5 | 85 | @top Introduction |
c72af735 RP |
86 | |
87 | @cindex version | |
b94ff924 | 88 | This brief manual contains preliminary documentation for the @sc{gnu} binary |
9bae56c5 | 89 | utilities (collectively version @value{VERSION}): |
8b2c2275 RP |
90 | |
91 | @iftex | |
c72af735 RP |
92 | @table @code |
93 | @item ar | |
94 | Create, modify, and extract from archives | |
95 | ||
96 | @item nm | |
97 | List symbols from object files | |
98 | ||
eed5eeab DM |
99 | @item objcopy |
100 | Copy and translate object files | |
101 | ||
c72af735 RP |
102 | @item objdump |
103 | Display information from object files | |
104 | ||
105 | @item ranlib | |
106 | Generate index to archive contents | |
107 | ||
108 | @item size | |
eae04238 | 109 | List file section sizes and total size |
c72af735 | 110 | |
ba7c8e29 DM |
111 | @item strings |
112 | List printable strings from files | |
113 | ||
c72af735 RP |
114 | @item strip |
115 | Discard symbols | |
eae04238 DM |
116 | |
117 | @item c++filt | |
118 | Demangle encoded C++ symbols | |
119 | ||
fb38844d ILT |
120 | @item addr2line |
121 | Convert addresses into file names and line numbers | |
122 | ||
eae04238 DM |
123 | @item nlmconv |
124 | Convert object code into a Netware Loadable Module | |
217947b2 ILT |
125 | |
126 | @item windres | |
127 | Manipulate Windows resources | |
c72af735 | 128 | @end table |
8b2c2275 | 129 | @end iftex |
c72af735 RP |
130 | |
131 | @menu | |
8b2c2275 | 132 | * ar:: Create, modify, and extract from archives |
8b2c2275 | 133 | * nm:: List symbols from object files |
eed5eeab | 134 | * objcopy:: Copy and translate object files |
8b2c2275 RP |
135 | * objdump:: Display information from object files |
136 | * ranlib:: Generate index to archive contents | |
137 | * size:: List section sizes and total size | |
ba7c8e29 | 138 | * strings:: List printable strings from files |
8b2c2275 | 139 | * strip:: Discard symbols |
b6216af2 | 140 | * c++filt:: Filter to demangle encoded C++ symbols |
fb38844d | 141 | * addr2line:: Convert addresses to file and line |
94e9ad77 | 142 | * nlmconv:: Converts object code into an NLM |
217947b2 | 143 | * windres:: Manipulate Windows resources |
eae04238 | 144 | * Selecting The Target System:: How these utilities determine the target. |
cbcfa129 ILT |
145 | * Reporting Bugs:: Reporting Bugs |
146 | * Index:: Index | |
c72af735 RP |
147 | @end menu |
148 | ||
eae04238 | 149 | @node ar |
c72af735 RP |
150 | @chapter ar |
151 | ||
152 | @kindex ar | |
153 | @cindex archives | |
154 | @cindex collections of files | |
155 | @smallexample | |
650a49f0 | 156 | ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}] |
4d9b5d5a | 157 | ar -M [ <mri-script ] |
c72af735 RP |
158 | @end smallexample |
159 | ||
b94ff924 | 160 | The @sc{gnu} @code{ar} program creates, modifies, and extracts from |
c72af735 RP |
161 | archives. An @dfn{archive} is a single file holding a collection of |
162 | other files in a structure that makes it possible to retrieve | |
163 | the original individual files (called @dfn{members} of the archive). | |
164 | ||
165 | The original files' contents, mode (permissions), timestamp, owner, and | |
ec40bbb8 | 166 | group are preserved in the archive, and can be restored on |
c72af735 RP |
167 | extraction. |
168 | ||
169 | @cindex name length | |
b94ff924 | 170 | @sc{gnu} @code{ar} can maintain archives whose members have names of any |
c72af735 | 171 | length; however, depending on how @code{ar} is configured on your |
ec40bbb8 DM |
172 | system, a limit on member-name length may be imposed for compatibility |
173 | with archive formats maintained with other tools. If it exists, the | |
c72af735 RP |
174 | limit is often 15 characters (typical of formats related to a.out) or 16 |
175 | characters (typical of formats related to coff). | |
176 | ||
177 | @cindex libraries | |
178 | @code{ar} is considered a binary utility because archives of this sort | |
179 | are most often used as @dfn{libraries} holding commonly needed | |
180 | subroutines. | |
181 | ||
182 | @cindex symbol index | |
e31e9a8d | 183 | @code{ar} creates an index to the symbols defined in relocatable |
c72af735 RP |
184 | object modules in the archive when you specify the modifier @samp{s}. |
185 | Once created, this index is updated in the archive whenever @code{ar} | |
186 | makes a change to its contents (save for the @samp{q} update operation). | |
187 | An archive with such an index speeds up linking to the library, and | |
188 | allows routines in the library to call each other without regard to | |
189 | their placement in the archive. | |
190 | ||
918c2f61 | 191 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index |
c72af735 RP |
192 | table. If an archive lacks the table, another form of @code{ar} called |
193 | @code{ranlib} can be used to add just the table. | |
194 | ||
765a273f RP |
195 | @cindex compatibility, @code{ar} |
196 | @cindex @code{ar} compatibility | |
b94ff924 | 197 | @sc{gnu} @code{ar} is designed to be compatible with two different |
765a273f RP |
198 | facilities. You can control its activity using command-line options, |
199 | like the different varieties of @code{ar} on Unix systems; or, if you | |
200 | specify the single command-line option @samp{-M}, you can control it | |
201 | with a script supplied via standard input, like the MRI ``librarian'' | |
202 | program. | |
203 | ||
204 | @menu | |
eae04238 DM |
205 | * ar cmdline:: Controlling @code{ar} on the command line |
206 | * ar scripts:: Controlling @code{ar} with a script | |
765a273f RP |
207 | @end menu |
208 | ||
209 | @page | |
eae04238 | 210 | @node ar cmdline |
765a273f RP |
211 | @section Controlling @code{ar} on the command line |
212 | ||
213 | @smallexample | |
650a49f0 | 214 | ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}] |
765a273f RP |
215 | @end smallexample |
216 | ||
217 | @cindex Unix compatibility, @code{ar} | |
218 | When you use @code{ar} in the Unix style, @code{ar} insists on at least two | |
219 | arguments to execute: one keyletter specifying the @emph{operation} | |
220 | (optionally accompanied by other keyletters specifying | |
221 | @emph{modifiers}), and the archive name to act on. | |
c72af735 | 222 | |
650a49f0 | 223 | Most operations can also accept further @var{member} arguments, |
c72af735 RP |
224 | specifying particular files to operate on. |
225 | ||
b94ff924 | 226 | @sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier |
c72af735 RP |
227 | flags @var{mod} in any order, within the first command-line argument. |
228 | ||
229 | If you wish, you may begin the first command-line argument with a | |
230 | dash. | |
231 | ||
232 | @cindex operations on archive | |
233 | The @var{p} keyletter specifies what operation to execute; it may be | |
234 | any of the following, but you must specify only one of them: | |
235 | ||
236 | @table @code | |
237 | @item d | |
238 | @cindex deleting from archive | |
239 | @emph{Delete} modules from the archive. Specify the names of modules to | |
650a49f0 | 240 | be deleted as @var{member}@dots{}; the archive is untouched if you |
c72af735 RP |
241 | specify no files to delete. |
242 | ||
e31e9a8d | 243 | If you specify the @samp{v} modifier, @code{ar} lists each module |
c72af735 RP |
244 | as it is deleted. |
245 | ||
246 | @item m | |
247 | @cindex moving in archive | |
248 | Use this operation to @emph{move} members in an archive. | |
249 | ||
250 | The ordering of members in an archive can make a difference in how | |
251 | programs are linked using the library, if a symbol is defined in more | |
252 | than one member. | |
253 | ||
254 | If no modifiers are used with @code{m}, any members you name in the | |
650a49f0 | 255 | @var{member} arguments are moved to the @emph{end} of the archive; |
c72af735 RP |
256 | you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a |
257 | specified place instead. | |
258 | ||
259 | @item p | |
260 | @cindex printing from archive | |
261 | @emph{Print} the specified members of the archive, to the standard | |
262 | output file. If the @samp{v} modifier is specified, show the member | |
263 | name before copying its contents to standard output. | |
264 | ||
650a49f0 | 265 | If you specify no @var{member} arguments, all the files in the archive are |
ec40bbb8 | 266 | printed. |
c72af735 RP |
267 | |
268 | @item q | |
269 | @cindex quick append to archive | |
7a2db4e5 | 270 | @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of |
ec40bbb8 | 271 | @var{archive}, without checking for replacement. |
c72af735 RP |
272 | |
273 | The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this | |
274 | operation; new members are always placed at the end of the archive. | |
275 | ||
276 | The modifier @samp{v} makes @code{ar} list each file as it is appended. | |
277 | ||
278 | Since the point of this operation is speed, the archive's symbol table | |
279 | index is not updated, even if it already existed; you can use @samp{ar s} or | |
280 | @code{ranlib} explicitly to update the symbol table index. | |
281 | ||
7a2db4e5 ILT |
282 | However, too many different system assume quick append rebuilds the |
283 | index, so GNU ar treats @code{q} to same way its treats @code{r}. | |
284 | ||
c72af735 RP |
285 | @item r |
286 | @cindex replacement in archive | |
650a49f0 | 287 | Insert the files @var{member}@dots{} into @var{archive} (with |
ec40bbb8 DM |
288 | @emph{replacement}). This operation differs from @samp{q} in that any |
289 | previously existing members are deleted if their names match those being | |
290 | added. | |
c72af735 | 291 | |
650a49f0 | 292 | If one of the files named in @var{member}@dots{} does not exist, @code{ar} |
c72af735 RP |
293 | displays an error message, and leaves undisturbed any existing members |
294 | of the archive matching that name. | |
295 | ||
296 | By default, new members are added at the end of the file; but you may | |
297 | use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request | |
298 | placement relative to some existing member. | |
299 | ||
300 | The modifier @samp{v} used with this operation elicits a line of | |
301 | output for each file inserted, along with one of the letters @samp{a} or | |
302 | @samp{r} to indicate whether the file was appended (no old member | |
303 | deleted) or replaced. | |
304 | ||
305 | @item t | |
306 | @cindex contents of archive | |
307 | Display a @emph{table} listing the contents of @var{archive}, or those | |
650a49f0 | 308 | of the files listed in @var{member}@dots{} that are present in the |
c72af735 RP |
309 | archive. Normally only the member name is shown; if you also want to |
310 | see the modes (permissions), timestamp, owner, group, and size, you can | |
311 | request that by also specifying the @samp{v} modifier. | |
312 | ||
650a49f0 | 313 | If you do not specify a @var{member}, all files in the archive |
c72af735 RP |
314 | are listed. |
315 | ||
316 | @cindex repeated names in archive | |
317 | @cindex name duplication in archive | |
318 | If there is more than one file with the same name (say, @samp{fie}) in | |
e31e9a8d | 319 | an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the |
c72af735 RP |
320 | first instance; to see them all, you must ask for a complete |
321 | listing---in our example, @samp{ar t b.a}. | |
322 | @c WRS only; per Gumby, this is implementation-dependent, and in a more | |
323 | @c recent case in fact works the other way. | |
324 | ||
325 | @item x | |
326 | @cindex extract from archive | |
650a49f0 | 327 | @emph{Extract} members (named @var{member}) from the archive. You can |
c72af735 RP |
328 | use the @samp{v} modifier with this operation, to request that |
329 | @code{ar} list each name as it extracts it. | |
330 | ||
650a49f0 | 331 | If you do not specify a @var{member}, all files in the archive |
c72af735 RP |
332 | are extracted. |
333 | ||
334 | @end table | |
335 | ||
336 | A number of modifiers (@var{mod}) may immediately follow the @var{p} | |
337 | keyletter, to specify variations on an operation's behavior: | |
338 | ||
339 | @table @code | |
340 | @item a | |
341 | @cindex relative placement in archive | |
342 | Add new files @emph{after} an existing member of the | |
ec40bbb8 | 343 | archive. If you use the modifier @samp{a}, the name of an existing archive |
650a49f0 | 344 | member must be present as the @var{relpos} argument, before the |
c72af735 RP |
345 | @var{archive} specification. |
346 | ||
347 | @item b | |
348 | Add new files @emph{before} an existing member of the | |
ec40bbb8 | 349 | archive. If you use the modifier @samp{b}, the name of an existing archive |
650a49f0 | 350 | member must be present as the @var{relpos} argument, before the |
c72af735 RP |
351 | @var{archive} specification. (same as @samp{i}). |
352 | ||
353 | @item c | |
354 | @cindex creating archives | |
355 | @emph{Create} the archive. The specified @var{archive} is always | |
650a49f0 | 356 | created if it did not exist, when you request an update. But a warning is |
c72af735 RP |
357 | issued unless you specify in advance that you expect to create it, by |
358 | using this modifier. | |
359 | ||
52af6a44 | 360 | @item f |
b94ff924 | 361 | Truncate names in the archive. @sc{gnu} @code{ar} will normally permit file |
52af6a44 ILT |
362 | names of any length. This will cause it to create archives which are |
363 | not compatible with the native @code{ar} program on some systems. If | |
364 | this is a concern, the @samp{f} modifier may be used to truncate file | |
365 | names when putting them in the archive. | |
366 | ||
c72af735 RP |
367 | @item i |
368 | Insert new files @emph{before} an existing member of the | |
ec40bbb8 | 369 | archive. If you use the modifier @samp{i}, the name of an existing archive |
650a49f0 | 370 | member must be present as the @var{relpos} argument, before the |
c72af735 RP |
371 | @var{archive} specification. (same as @samp{b}). |
372 | ||
373 | @item l | |
374 | This modifier is accepted but not used. | |
375 | @c whaffor ar l modifier??? presumably compat; with | |
b94ff924 | 376 | @c what???---doc@@cygnus.com, 25jan91 |
c72af735 RP |
377 | |
378 | @item o | |
379 | @cindex dates in archive | |
380 | Preserve the @emph{original} dates of members when extracting them. If | |
381 | you do not specify this modifier, files extracted from the archive | |
e31e9a8d | 382 | are stamped with the time of extraction. |
c72af735 RP |
383 | |
384 | @item s | |
385 | @cindex writing archive index | |
386 | Write an object-file index into the archive, or update an existing one, | |
387 | even if no other change is made to the archive. You may use this modifier | |
388 | flag either with any operation, or alone. Running @samp{ar s} on an | |
389 | archive is equivalent to running @samp{ranlib} on it. | |
390 | ||
391 | @item u | |
392 | @cindex updating an archive | |
b703c078 | 393 | Normally, @samp{ar r}@dots{} inserts all files |
c72af735 RP |
394 | listed into the archive. If you would like to insert @emph{only} those |
395 | of the files you list that are newer than existing members of the same | |
396 | names, use this modifier. The @samp{u} modifier is allowed only for the | |
397 | operation @samp{r} (replace). In particular, the combination @samp{qu} is | |
398 | not allowed, since checking the timestamps would lose any speed | |
399 | advantage from the operation @samp{q}. | |
400 | ||
401 | @item v | |
402 | This modifier requests the @emph{verbose} version of an operation. Many | |
403 | operations display additional information, such as filenames processed, | |
404 | when the modifier @samp{v} is appended. | |
4d9b5d5a DM |
405 | |
406 | @item V | |
407 | This modifier shows the version number of @code{ar}. | |
765a273f RP |
408 | @end table |
409 | ||
eae04238 | 410 | @node ar scripts |
765a273f RP |
411 | @section Controlling @code{ar} with a script |
412 | ||
413 | @smallexample | |
414 | ar -M [ <@var{script} ] | |
415 | @end smallexample | |
416 | ||
417 | @cindex MRI compatibility, @code{ar} | |
418 | @cindex scripts, @code{ar} | |
419 | If you use the single command-line option @samp{-M} with @code{ar}, you | |
420 | can control its operation with a rudimentary command language. This | |
e31e9a8d | 421 | form of @code{ar} operates interactively if standard input is coming |
765a273f RP |
422 | directly from a terminal. During interactive use, @code{ar} prompts for |
423 | input (the prompt is @samp{AR >}), and continues executing even after | |
424 | errors. If you redirect standard input to a script file, no prompts are | |
e31e9a8d | 425 | issued, and @code{ar} abandons execution (with a nonzero exit code) |
765a273f RP |
426 | on any error. |
427 | ||
428 | The @code{ar} command language is @emph{not} designed to be equivalent | |
429 | to the command-line options; in fact, it provides somewhat less control | |
430 | over archives. The only purpose of the command language is to ease the | |
b94ff924 | 431 | transition to @sc{gnu} @code{ar} for developers who already have scripts |
765a273f RP |
432 | written for the MRI ``librarian'' program. |
433 | ||
434 | The syntax for the @code{ar} command language is straightforward: | |
435 | @itemize @bullet | |
436 | @item | |
437 | commands are recognized in upper or lower case; for example, @code{LIST} | |
438 | is the same as @code{list}. In the following descriptions, commands are | |
439 | shown in upper case for clarity. | |
440 | ||
441 | @item | |
442 | a single command may appear on each line; it is the first word on the | |
443 | line. | |
444 | ||
445 | @item | |
446 | empty lines are allowed, and have no effect. | |
447 | ||
448 | @item | |
449 | comments are allowed; text after either of the characters @samp{*} | |
450 | or @samp{;} is ignored. | |
451 | ||
452 | @item | |
453 | Whenever you use a list of names as part of the argument to an @code{ar} | |
454 | command, you can separate the individual names with either commas or | |
455 | blanks. Commas are shown in the explanations below, for clarity. | |
456 | ||
457 | @item | |
458 | @samp{+} is used as a line continuation character; if @samp{+} appears | |
459 | at the end of a line, the text on the following line is considered part | |
460 | of the current command. | |
461 | @end itemize | |
462 | ||
463 | Here are the commands you can use in @code{ar} scripts, or when using | |
464 | @code{ar} interactively. Three of them have special significance: | |
465 | ||
466 | @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is | |
467 | a temporary file required for most of the other commands. | |
468 | ||
469 | @code{SAVE} commits the changes so far specified by the script. Prior | |
470 | to @code{SAVE}, commands affect only the temporary copy of the current | |
471 | archive. | |
472 | ||
473 | @table @code | |
474 | @item ADDLIB @var{archive} | |
475 | @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module}) | |
476 | Add all the contents of @var{archive} (or, if specified, each named | |
477 | @var{module} from @var{archive}) to the current archive. | |
478 | ||
479 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
480 | ||
650a49f0 | 481 | @item ADDMOD @var{member}, @var{member}, @dots{} @var{member} |
765a273f RP |
482 | @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}" |
483 | @c else like "ar q..." | |
650a49f0 | 484 | Add each named @var{member} as a module in the current archive. |
765a273f RP |
485 | |
486 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
487 | ||
488 | @item CLEAR | |
489 | Discard the contents of the current archive, cancelling the effect of | |
490 | any operations since the last @code{SAVE}. May be executed (with no | |
491 | effect) even if no current archive is specified. | |
492 | ||
493 | @item CREATE @var{archive} | |
494 | Creates an archive, and makes it the current archive (required for many | |
495 | other commands). The new archive is created with a temporary name; it | |
496 | is not actually saved as @var{archive} until you use @code{SAVE}. | |
497 | You can overwrite existing archives; similarly, the contents of any | |
498 | existing file named @var{archive} will not be destroyed until @code{SAVE}. | |
499 | ||
500 | @item DELETE @var{module}, @var{module}, @dots{} @var{module} | |
501 | Delete each listed @var{module} from the current archive; equivalent to | |
502 | @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}. | |
503 | ||
504 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
505 | ||
506 | @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) | |
507 | @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile} | |
508 | List each named @var{module} present in @var{archive}. The separate | |
509 | command @code{VERBOSE} specifies the form of the output: when verbose | |
510 | output is off, output is like that of @samp{ar -t @var{archive} | |
b703c078 DM |
511 | @var{module}@dots{}}. When verbose output is on, the listing is like |
512 | @samp{ar -tv @var{archive} @var{module}@dots{}}. | |
765a273f RP |
513 | |
514 | Output normally goes to the standard output stream; however, if you | |
515 | specify @var{outputfile} as a final argument, @code{ar} directs the | |
516 | output to that file. | |
517 | ||
518 | @item END | |
519 | Exit from @code{ar}, with a @code{0} exit code to indicate successful | |
520 | completion. This command does not save the output file; if you have | |
521 | changed the current archive since the last @code{SAVE} command, those | |
522 | changes are lost. | |
523 | ||
524 | @item EXTRACT @var{module}, @var{module}, @dots{} @var{module} | |
525 | Extract each named @var{module} from the current archive, writing them | |
526 | into the current directory as separate files. Equivalent to @samp{ar -x | |
b703c078 | 527 | @var{archive} @var{module}@dots{}}. |
765a273f RP |
528 | |
529 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
530 | ||
531 | @ignore | |
532 | @c FIXME Tokens but no commands??? | |
533 | @item FULLDIR | |
534 | ||
535 | @item HELP | |
536 | @end ignore | |
537 | ||
538 | @item LIST | |
539 | Display full contents of the current archive, in ``verbose'' style | |
540 | regardless of the state of @code{VERBOSE}. The effect is like @samp{ar | |
b94ff924 | 541 | tv @var{archive}}). (This single command is a @sc{gnu} @code{ld} |
765a273f RP |
542 | enhancement, rather than present for MRI compatibility.) |
543 | ||
544 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
545 | ||
546 | @item OPEN @var{archive} | |
547 | Opens an existing archive for use as the current archive (required for | |
548 | many other commands). Any changes as the result of subsequent commands | |
549 | will not actually affect @var{archive} until you next use @code{SAVE}. | |
550 | ||
551 | @item REPLACE @var{module}, @var{module}, @dots{} @var{module} | |
552 | In the current archive, replace each existing @var{module} (named in | |
553 | the @code{REPLACE} arguments) from files in the current working directory. | |
554 | To execute this command without errors, both the file, and the module in | |
555 | the current archive, must exist. | |
556 | ||
557 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
558 | ||
559 | @item VERBOSE | |
560 | Toggle an internal flag governing the output from @code{DIRECTORY}. | |
561 | When the flag is on, @code{DIRECTORY} output matches output from | |
b703c078 | 562 | @samp{ar -tv }@dots{}. |
765a273f RP |
563 | |
564 | @item SAVE | |
565 | Commit your changes to the current archive, and actually save it as a | |
566 | file with the name specified in the last @code{CREATE} or @code{OPEN} | |
567 | command. | |
568 | ||
569 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
c72af735 RP |
570 | |
571 | @end table | |
572 | ||
8b2c2275 RP |
573 | @iftex |
574 | @node ld | |
c72af735 RP |
575 | @chapter ld |
576 | @cindex linker | |
577 | @kindex ld | |
b94ff924 VM |
578 | The @sc{gnu} linker @code{ld} is now described in a separate manual. |
579 | @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}. | |
8b2c2275 | 580 | @end iftex |
c72af735 | 581 | |
eae04238 | 582 | @node nm |
c72af735 RP |
583 | @chapter nm |
584 | @cindex symbols | |
585 | @kindex nm | |
586 | ||
587 | @smallexample | |
d6a4c375 | 588 | nm [ -a | --debug-syms ] [ -g | --extern-only ] |
de3b08ac | 589 | [ -B ] [ -C | --demangle ] [ -D | --dynamic ] |
1896790e | 590 | [ -s | --print-armap ] [ -A | -o | --print-file-name ] |
6cfbdb50 | 591 | [ -n | -v | --numeric-sort ] [ -p | --no-sort ] |
1896790e | 592 | [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ] |
6cfbdb50 DM |
593 | [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ] |
594 | [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ] | |
77dd4469 | 595 | [ --defined-only ] [-l | --line-numbers ] |
9eb39bca | 596 | [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ] |
c72af735 RP |
597 | @end smallexample |
598 | ||
b94ff924 | 599 | @sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}. |
6cfbdb50 DM |
600 | If no object files are listed as arguments, @code{nm} assumes |
601 | @file{a.out}. | |
602 | ||
603 | For each symbol, @code{nm} shows: | |
604 | ||
605 | @itemize @bullet | |
606 | @item | |
607 | The symbol value, in the radix selected by options (see below), or | |
608 | hexadecimal by default. | |
609 | ||
610 | @item | |
611 | The symbol type. At least the following types are used; others are, as | |
612 | well, depending on the object file format. If lowercase, the symbol is | |
613 | local; if uppercase, the symbol is global (external). | |
614 | ||
615 | @c Some more detail on exactly what these symbol types are used for | |
616 | @c would be nice. | |
617 | @table @code | |
618 | @item A | |
85d4b870 ILT |
619 | The symbol's value is absolute, and will not be changed by further |
620 | linking. | |
6cfbdb50 DM |
621 | |
622 | @item B | |
85d4b870 | 623 | The symbol is in the uninitialized data section (known as BSS). |
6cfbdb50 DM |
624 | |
625 | @item C | |
85d4b870 ILT |
626 | The symbol is common. Common symbols are uninitialized data. When |
627 | linking, multiple common symbols may appear with the same name. If the | |
628 | symbol is defined anywhere, the common symbols are treated as undefined | |
629 | references. For more details on common symbols, see the discussion of | |
630 | --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}. | |
6cfbdb50 DM |
631 | |
632 | @item D | |
85d4b870 ILT |
633 | The symbol is in the initialized data section. |
634 | ||
635 | @item G | |
392e2505 | 636 | The symbol is in an initialized data section for small objects. Some |
85d4b870 ILT |
637 | object file formats permit more efficient access to small data objects, |
638 | such as a global int variable as opposed to a large global array. | |
6cfbdb50 DM |
639 | |
640 | @item I | |
85d4b870 ILT |
641 | The symbol is an indirect reference to another symbol. This is a GNU |
642 | extension to the a.out object file format which is rarely used. | |
643 | ||
644 | @item N | |
645 | The symbol is a debugging symbol. | |
646 | ||
647 | @item R | |
648 | The symbol is in a read only data section. | |
649 | ||
650 | @item S | |
392e2505 | 651 | The symbol is in an uninitialized data section for small objects. |
6cfbdb50 DM |
652 | |
653 | @item T | |
85d4b870 | 654 | The symbol is in the text (code) section. |
6cfbdb50 DM |
655 | |
656 | @item U | |
85d4b870 ILT |
657 | The symbol is undefined. |
658 | ||
659 | @item W | |
660 | The symbol is weak. When a weak defined symbol is linked with a normal | |
661 | defined symbol, the normal defined symbol is used with no error. When a | |
662 | weak undefined symbol is linked and the symbol is not defined, the value | |
663 | of the weak symbol becomes zero with no error. | |
664 | ||
665 | @item - | |
666 | The symbol is a stabs symbol in an a.out object file. In this case, the | |
667 | next values printed are the stabs other field, the stabs desc field, and | |
668 | the stab type. Stabs symbols are used to hold debugging information; | |
669 | for more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The | |
670 | ``stabs'' debug format}. | |
671 | ||
672 | @item ? | |
673 | The symbol type is unknown, or object file format specific. | |
6cfbdb50 DM |
674 | @end table |
675 | ||
676 | @item | |
677 | The symbol name. | |
678 | @end itemize | |
c72af735 RP |
679 | |
680 | The long and short forms of options, shown here as alternatives, are | |
681 | equivalent. | |
682 | ||
683 | @table @code | |
6cfbdb50 DM |
684 | @item -A |
685 | @itemx -o | |
686 | @itemx --print-file-name | |
687 | @cindex input file name | |
688 | @cindex file name | |
689 | @cindex source file name | |
690 | Precede each symbol by the name of the input file (or archive element) | |
691 | in which it was found, rather than identifying the input file once only, | |
692 | before all of its symbols. | |
c72af735 RP |
693 | |
694 | @item -a | |
918c2f61 | 695 | @itemx --debug-syms |
c72af735 | 696 | @cindex debugging symbols |
6cfbdb50 DM |
697 | Display all symbols, even debugger-only symbols; normally these are not |
698 | listed. | |
699 | ||
68dd5295 DM |
700 | @item -B |
701 | @cindex @code{nm} format | |
702 | @cindex @code{nm} compatibility | |
d6a4c375 DM |
703 | The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}). |
704 | ||
705 | @item -C | |
706 | @itemx --demangle | |
9793039f | 707 | @cindex demangling in nm |
d6a4c375 DM |
708 | Decode (@dfn{demangle}) low-level symbol names into user-level names. |
709 | Besides removing any initial underscore prepended by the system, this | |
710 | makes C++ function names readable. @xref{c++filt}, for more information | |
711 | on demangling. | |
68dd5295 | 712 | |
9eb39bca ILT |
713 | @item --no-demangle |
714 | Do not demangle low-level symbol names. This is the default. | |
715 | ||
de3b08ac ILT |
716 | @item -D |
717 | @itemx --dynamic | |
718 | @cindex dynamic symbols | |
719 | Display the dynamic symbols rather than the normal symbols. This is | |
720 | only meaningful for dynamic objects, such as certain types of shared | |
721 | libraries. | |
722 | ||
6cfbdb50 DM |
723 | @item -f @var{format} |
724 | @itemx --format=@var{format} | |
68dd5295 DM |
725 | @cindex @code{nm} format |
726 | @cindex @code{nm} compatibility | |
6cfbdb50 DM |
727 | Use the output format @var{format}, which can be @code{bsd}, |
728 | @code{sysv}, or @code{posix}. The default is @code{bsd}. | |
b26ac613 | 729 | Only the first character of @var{format} is significant; it can be |
6cfbdb50 | 730 | either upper or lower case. |
c72af735 RP |
731 | |
732 | @item -g | |
918c2f61 | 733 | @itemx --extern-only |
c72af735 RP |
734 | @cindex external symbols |
735 | Display only external symbols. | |
736 | ||
77dd4469 ILT |
737 | @item -l |
738 | @itemx --line-numbers | |
739 | @cindex symbol line numbers | |
740 | For each symbol, use debugging information to try to find a filename and | |
741 | line number. For a defined symbol, look for the line number of the | |
742 | address of the symbol. For an undefined symbol, look for the line | |
743 | number of a relocation entry which refers to the symbol. If line number | |
744 | information can be found, print it after the other symbol information. | |
745 | ||
b26ac613 DM |
746 | @item -n |
747 | @itemx -v | |
748 | @itemx --numeric-sort | |
749 | Sort symbols numerically by their addresses, rather than alphabetically | |
750 | by their names. | |
751 | ||
c72af735 | 752 | @item -p |
918c2f61 | 753 | @itemx --no-sort |
c72af735 | 754 | @cindex sorting symbols |
650a49f0 | 755 | Do not bother to sort the symbols in any order; print them in the order |
6cfbdb50 DM |
756 | encountered. |
757 | ||
758 | @item -P | |
759 | @itemx --portability | |
760 | Use the POSIX.2 standard output format instead of the default format. | |
761 | Equivalent to @samp{-f posix}. | |
c72af735 | 762 | |
c72af735 | 763 | @item -s |
918c2f61 | 764 | @itemx --print-armap |
c72af735 RP |
765 | @cindex symbol index, listing |
766 | When listing symbols from archive members, include the index: a mapping | |
ec40bbb8 DM |
767 | (stored in the archive by @code{ar} or @code{ranlib}) of which modules |
768 | contain definitions for which names. | |
c72af735 | 769 | |
c72af735 | 770 | @item -r |
918c2f61 | 771 | @itemx --reverse-sort |
ec40bbb8 | 772 | Reverse the order of the sort (whether numeric or alphabetic); let the |
c72af735 RP |
773 | last come first. |
774 | ||
1896790e ILT |
775 | @item --size-sort |
776 | Sort symbols by size. The size is computed as the difference between | |
777 | the value of the symbol and the value of the symbol with the next higher | |
778 | value. The size of the symbol is printed, rather than the value. | |
779 | ||
6cfbdb50 DM |
780 | @item -t @var{radix} |
781 | @itemx --radix=@var{radix} | |
782 | Use @var{radix} as the radix for printing the symbol values. It must be | |
783 | @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal. | |
784 | ||
ec40bbb8 | 785 | @item --target=@var{bfdname} |
c72af735 RP |
786 | @cindex object code format |
787 | Specify an object code format other than your system's default format. | |
eae04238 | 788 | @xref{Target Selection}, for more information. |
c72af735 RP |
789 | |
790 | @item -u | |
918c2f61 | 791 | @itemx --undefined-only |
c72af735 RP |
792 | @cindex external symbols |
793 | @cindex undefined symbols | |
794 | Display only undefined symbols (those external to each object file). | |
795 | ||
dcd6706b JL |
796 | @item --defined-only |
797 | @cindex external symbols | |
798 | @cindex undefined symbols | |
799 | Display only defined symbols for each object file. | |
800 | ||
6cfbdb50 DM |
801 | @item -V |
802 | @itemx --version | |
b26ac613 DM |
803 | Show the version number of @code{nm} and exit. |
804 | ||
805 | @item --help | |
806 | Show a summary of the options to @code{nm} and exit. | |
c72af735 RP |
807 | @end table |
808 | ||
eae04238 | 809 | @node objcopy |
eed5eeab DM |
810 | @chapter objcopy |
811 | ||
812 | @smallexample | |
eae04238 DM |
813 | objcopy [ -F @var{bfdname} | --target=@var{bfdname} ] |
814 | [ -I @var{bfdname} | --input-target=@var{bfdname} ] | |
815 | [ -O @var{bfdname} | --output-target=@var{bfdname} ] | |
eed5eeab | 816 | [ -S | --strip-all ] [ -g | --strip-debug ] |
dff604a7 | 817 | [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ] |
29c0d15c | 818 | [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ] |
246b7c9b | 819 | [ -L @var{symbolname} | --localize-symbol=@var{symbolname} ] |
8d2e72a1 | 820 | [ -W @var{symbolname} | --weaken-symbol=@var{symbolname} ] |
eed5eeab | 821 | [ -x | --discard-all ] [ -X | --discard-locals ] |
f7b839f7 DM |
822 | [ -b @var{byte} | --byte=@var{byte} ] |
823 | [ -i @var{interleave} | --interleave=@var{interleave} ] | |
0aca460e | 824 | [ -R @var{sectionname} | --remove-section=@var{sectionname} ] |
2483354d | 825 | [ -p | --preserve-dates ] [ --debugging ] |
33e0a06d ILT |
826 | [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ] |
827 | [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ] | |
828 | [ --adjust-vma=@var{incr} ] | |
6c7ed084 ILT |
829 | [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ] |
830 | [ --adjust-warnings ] [ --no-adjust-warnings ] | |
5ab41086 | 831 | [ --set-section-flags=@var{section}=@var{flags} ] |
d0130cc8 | 832 | [ --add-section=@var{sectionname}=@var{filename} ] |
decf2865 | 833 | [ --change-leading-char ] [ --remove-leading-char ] |
9a442fe8 | 834 | [ --weaken ] |
f7b839f7 | 835 | [ -v | --verbose ] [ -V | --version ] [ --help ] |
eed5eeab DM |
836 | @var{infile} [@var{outfile}] |
837 | @end smallexample | |
838 | ||
8981cac5 JO |
839 | The @sc{gnu} @code{objcopy} utility copies the contents of an object |
840 | file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to | |
841 | read and write the object files. It can write the destination object | |
842 | file in a format different from that of the source object file. The | |
843 | exact behavior of @code{objcopy} is controlled by command-line options. | |
eed5eeab DM |
844 | |
845 | @code{objcopy} creates temporary files to do its translations and | |
8981cac5 JO |
846 | deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its |
847 | translation work; it has access to all the formats described in @sc{bfd} | |
848 | and thus is able to recognize most formats without being told | |
849 | explicitly. @xref{BFD,,BFD,ld.info,Using LD}. | |
eed5eeab | 850 | |
67f67ed9 ILT |
851 | @code{objcopy} can be used to generate S-records by using an output |
852 | target of @samp{srec} (e.g., use @samp{-O srec}). | |
853 | ||
854 | @code{objcopy} can be used to generate a raw binary file by using an | |
855 | output target of @samp{binary} (e.g., use @samp{-O binary}). When | |
856 | @code{objcopy} generates a raw binary file, it will essentially produce | |
857 | a memory dump of the contents of the input object file. All symbols and | |
a6afc090 | 858 | relocation information will be discarded. The memory dump will start at |
11de29d0 | 859 | the load address of the lowest section copied into the output file. |
67f67ed9 ILT |
860 | |
861 | When generating an S-record or a raw binary file, it may be helpful to | |
862 | use @samp{-S} to remove sections containing debugging information. In | |
863 | some cases @samp{-R} will be useful to remove sections which contain | |
864 | information which is not needed by the binary file. | |
865 | ||
eed5eeab DM |
866 | @table @code |
867 | @item @var{infile} | |
868 | @itemx @var{outfile} | |
8981cac5 | 869 | The source and output files, respectively. |
eed5eeab DM |
870 | If you do not specify @var{outfile}, @code{objcopy} creates a |
871 | temporary file and destructively renames the result with | |
8981cac5 | 872 | the name of @var{infile}. |
eed5eeab | 873 | |
eae04238 DM |
874 | @item -I @var{bfdname} |
875 | @itemx --input-target=@var{bfdname} | |
876 | Consider the source file's object format to be @var{bfdname}, rather than | |
877 | attempting to deduce it. @xref{Target Selection}, for more information. | |
eed5eeab | 878 | |
eae04238 DM |
879 | @item -O @var{bfdname} |
880 | @itemx --output-target=@var{bfdname} | |
881 | Write the output file using the object format @var{bfdname}. | |
882 | @xref{Target Selection}, for more information. | |
eed5eeab | 883 | |
eae04238 DM |
884 | @item -F @var{bfdname} |
885 | @itemx --target=@var{bfdname} | |
886 | Use @var{bfdname} as the object format for both the input and the output | |
887 | file; i.e., simply transfer data from source to destination with no | |
888 | translation. @xref{Target Selection}, for more information. | |
eed5eeab | 889 | |
0aca460e ILT |
890 | @item -R @var{sectionname} |
891 | @itemx --remove-section=@var{sectionname} | |
892 | Remove any section named @var{sectionname} from the output file. This | |
893 | option may be given more than once. Note that using this option | |
894 | inappropriately may make the output file unusable. | |
895 | ||
eed5eeab DM |
896 | @item -S |
897 | @itemx --strip-all | |
898 | Do not copy relocation and symbol information from the source file. | |
899 | ||
900 | @item -g | |
901 | @itemx --strip-debug | |
902 | Do not copy debugging symbols from the source file. | |
903 | ||
9135e5f8 ILT |
904 | @item --strip-unneeded |
905 | Strip all symbols that are not needed for relocation processing. | |
906 | ||
dff604a7 ILT |
907 | @item -K @var{symbolname} |
908 | @itemx --keep-symbol=@var{symbolname} | |
909 | Copy only symbol @var{symbolname} from the source file. This option may | |
910 | be given more than once. | |
911 | ||
29c0d15c ILT |
912 | @item -N @var{symbolname} |
913 | @itemx --strip-symbol=@var{symbolname} | |
dff604a7 | 914 | Do not copy symbol @var{symbolname} from the source file. This option |
8d2e72a1 RH |
915 | may be given more than once. |
916 | ||
246b7c9b RH |
917 | @item -L @var{symbolname} |
918 | @itemx --localize-symbol=@var{symbolname} | |
8d2e72a1 RH |
919 | Make symbol @var{symbolname} local to the file, so that it is not |
920 | visible externally. This option may be given more than once. | |
921 | ||
922 | @item -W @var{symbolname} | |
923 | @itemx --weaken-symbol=@var{symbolname} | |
924 | Make symbol @var{symbolname} weak. This option may be given more than once. | |
29c0d15c | 925 | |
eed5eeab DM |
926 | @item -x |
927 | @itemx --discard-all | |
928 | Do not copy non-global symbols from the source file. | |
929 | @c FIXME any reason to prefer "non-global" to "local" here? | |
930 | ||
931 | @item -X | |
932 | @itemx --discard-locals | |
933 | Do not copy compiler-generated local symbols. | |
934 | (These usually start with @samp{L} or @samp{.}.) | |
935 | ||
db2e6adb DM |
936 | @item -b @var{byte} |
937 | @itemx --byte=@var{byte} | |
938 | Keep only every @var{byte}th byte of the input file (header data is not | |
f7b839f7 DM |
939 | affected). @var{byte} can be in the range from 0 to @var{interleave}-1, |
940 | where @var{interleave} is given by the @samp{-i} or @samp{--interleave} | |
941 | option, or the default of 4. This option is useful for creating files | |
8981cac5 | 942 | to program @sc{rom}. It is typically used with an @code{srec} output |
f7b839f7 DM |
943 | target. |
944 | ||
945 | @item -i @var{interleave} | |
946 | @itemx --interleave=@var{interleave} | |
8981cac5 JO |
947 | Only copy one out of every @var{interleave} bytes. Select which byte to |
948 | copy with the @var{-b} or @samp{--byte} option. The default is 4. | |
949 | @code{objcopy} ignores this option if you do not specify either @samp{-b} or | |
950 | @samp{--byte}. | |
db2e6adb | 951 | |
2483354d ILT |
952 | @item -p |
953 | @itemx --preserve-dates | |
954 | Set the access and modification dates of the output file to be the same | |
955 | as those of the input file. | |
956 | ||
f5818d79 ILT |
957 | @item --debugging |
958 | Convert debugging information, if possible. This is not the default | |
959 | because only certain debugging formats are supported, and the | |
960 | conversion process can be time consuming. | |
961 | ||
596d99ba ILT |
962 | @item --gap-fill @var{val} |
963 | Fill gaps between sections with @var{val}. This is done by increasing | |
964 | the size of the section with the lower address, and filling in the extra | |
965 | space created with @var{val}. | |
966 | ||
33e0a06d ILT |
967 | @item --pad-to @var{address} |
968 | Pad the output file up to the virtual address @var{address}. This is | |
969 | done by increasing the size of the last section. The extra space is | |
970 | filled in with the value specified by @samp{--gap-fill} (default zero). | |
971 | ||
6c7ed084 ILT |
972 | @item --set-start @var{val} |
973 | Set the address of the new file to @var{val}. Not all object file | |
a6afc090 | 974 | formats support setting the start address. |
6c7ed084 ILT |
975 | |
976 | @item --adjust-start @var{incr} | |
977 | Adjust the start address by adding @var{incr}. Not all object file | |
978 | formats support setting the start address. | |
979 | ||
980 | @item --adjust-vma @var{incr} | |
981 | Adjust the address of all sections, as well as the start address, by | |
982 | adding @var{incr}. Some object file formats do not permit section | |
983 | addresses to be changed arbitrarily. Note that this does not relocate | |
984 | the sections; if the program expects sections to be loaded at a certain | |
985 | address, and this option is used to change the sections such that they | |
986 | are loaded at a different address, the program may fail. | |
987 | ||
988 | @item --adjust-section-vma @var{section}@{=,+,-@}@var{val} | |
989 | Set or adjust the address of the named @var{section}. If @samp{=} is | |
990 | used, the section address is set to @var{val}. Otherwise, @var{val} is | |
991 | added to or subtracted from the section address. See the comments under | |
992 | @samp{--adjust-vma}, above. If @var{section} does not exist in the | |
993 | input file, a warning will be issued, unless @samp{--no-adjust-warnings} | |
994 | is used. | |
995 | ||
996 | @item --adjust-warnings | |
997 | If @samp{--adjust-section-vma} is used, and the named section does not | |
998 | exist, issue a warning. This is the default. | |
999 | ||
1000 | @item --no-adjust-warnings | |
1001 | Do not issue a warning if @samp{--adjust-section-vma} is used, even if | |
1002 | the named section does not exist. | |
1003 | ||
5ab41086 ILT |
1004 | @item --set-section-flags @var{section}=@var{flags} |
1005 | Set the flags for the named section. The @var{flags} argument is a | |
1006 | comma separated string of flag names. The recognized names are | |
ee1f0bd1 ILT |
1007 | @samp{alloc}, @samp{contents}, @samp{load}, @samp{readonly}, |
1008 | @samp{code}, @samp{data}, and @samp{rom}. You can set the | |
1009 | @samp{contents} flag for a section which does not have contents, but it | |
1010 | is not meaningful to clear the @samp{contents} flag of a section which | |
1011 | does have contents--just remove the section instead. Not all flags are | |
1012 | meaningful for all object file formats. | |
5ab41086 | 1013 | |
d0130cc8 ILT |
1014 | @item --add-section @var{sectionname}=@var{filename} |
1015 | Add a new section named @var{sectionname} while copying the file. The | |
1016 | contents of the new section are taken from the file @var{filename}. The | |
1017 | size of the section will be the size of the file. This option only | |
1018 | works on file formats which can support sections with arbitrary names. | |
1019 | ||
decf2865 ILT |
1020 | @item --change-leading-char |
1021 | Some object file formats use special characters at the start of | |
1022 | symbols. The most common such character is underscore, which compilers | |
1023 | often add before every symbol. This option tells @code{objcopy} to | |
1024 | change the leading character of every symbol when it converts between | |
1025 | object file formats. If the object file formats use the same leading | |
1026 | character, this option has no effect. Otherwise, it will add a | |
1027 | character, or remove a character, or change a character, as | |
1028 | appropriate. | |
1029 | ||
5da470b2 ILT |
1030 | @item --remove-leading-char |
1031 | If the first character of a global symbol is a special symbol leading | |
1032 | character used by the object file format, remove the character. The | |
1033 | most common symbol leading character is underscore. This option will | |
1034 | remove a leading underscore from all global symbols. This can be useful | |
1035 | if you want to link together objects of different file formats with | |
decf2865 ILT |
1036 | different conventions for symbol names. This is different from |
1037 | @code{--change-leading-char} because it always changes the symbol name | |
1038 | when appropriate, regardless of the object file format of the output | |
1039 | file. | |
5da470b2 | 1040 | |
9a442fe8 ILT |
1041 | @item --weaken |
1042 | Change all global symbols in the file to be weak. This can be useful | |
1043 | when building an object which will be linked against other objects using | |
1044 | the @code{-R} option to the linker. This option is only effective when | |
1045 | using an object file format which supports weak symbols. | |
1046 | ||
eed5eeab DM |
1047 | @item -V |
1048 | @itemx --version | |
1049 | Show the version number of @code{objcopy}. | |
1050 | ||
1051 | @item -v | |
1052 | @itemx --verbose | |
1053 | Verbose output: list all object files modified. In the case of | |
1054 | archives, @samp{objcopy -V} lists all members of the archive. | |
1055 | ||
1056 | @item --help | |
1057 | Show a summary of the options to @code{objcopy}. | |
1058 | @end table | |
1059 | ||
eae04238 | 1060 | @node objdump |
c72af735 RP |
1061 | @chapter objdump |
1062 | ||
1063 | @cindex object file information | |
1064 | @kindex objdump | |
1065 | ||
1066 | @smallexample | |
10f2a7f6 | 1067 | objdump [ -a | --archive-headers ] |
e1c14599 | 1068 | [ -b @var{bfdname} | --target=@var{bfdname} ] [ --debugging ] |
9793039f ILT |
1069 | [ -C | --demangle ] [ -d | --disassemble ] |
1070 | [ -D | --disassemble-all ] [ --disassemble-zeroes ] | |
67c8c901 | 1071 | [ -EB | -EL | --endian=@{big | little @} ] |
d5464baa | 1072 | [ -f | --file-headers ] |
eae04238 | 1073 | [ -h | --section-headers | --headers ] [ -i | --info ] |
10f2a7f6 | 1074 | [ -j @var{section} | --section=@var{section} ] |
a8e27cc6 | 1075 | [ -l | --line-numbers ] [ -S | --source ] |
7e5e9619 JO |
1076 | [ -m @var{machine} | --architecture=@var{machine} ] |
1077 | [ -r | --reloc ] [ -R | --dynamic-reloc ] | |
1078 | [ -s | --full-contents ] [ --stabs ] | |
de3b08ac | 1079 | [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ] |
aa21a2a9 | 1080 | [ -w | --wide ] [ --start-address=@var{address} ] |
4cb99ff2 | 1081 | [ --stop-address=@var{address} ] |
5c59269f | 1082 | [ --prefix-addresses] [ --[no-]show-raw-insn ] |
ab3a59cf | 1083 | [ --adjust-vma=@var{offset} ] |
458bbd1f | 1084 | [ --version ] [ --help ] |
aa21a2a9 | 1085 | @var{objfile}@dots{} |
c72af735 RP |
1086 | @end smallexample |
1087 | ||
1088 | @code{objdump} displays information about one or more object files. | |
1089 | The options control what particular information to display. This | |
1090 | information is mostly useful to programmers who are working on the | |
1091 | compilation tools, as opposed to programmers who just want their | |
1092 | program to compile and work. | |
1093 | ||
b26ac613 DM |
1094 | @var{objfile}@dots{} are the object files to be examined. When you |
1095 | specify archives, @code{objdump} shows information on each of the member | |
1096 | object files. | |
1097 | ||
c72af735 | 1098 | The long and short forms of options, shown here as alternatives, are |
ed78872a | 1099 | equivalent. At least one option besides @samp{-l} must be given. |
c72af735 RP |
1100 | |
1101 | @table @code | |
c72af735 | 1102 | @item -a |
eae04238 | 1103 | @itemx --archive-header |
c72af735 | 1104 | @cindex archive headers |
ec40bbb8 | 1105 | If any of the @var{objfile} files are archives, display the archive |
c72af735 RP |
1106 | header information (in a format similar to @samp{ls -l}). Besides the |
1107 | information you could list with @samp{ar tv}, @samp{objdump -a} shows | |
1108 | the object file format of each archive member. | |
1109 | ||
ab3a59cf ILT |
1110 | @item --adjust-vma=@var{offset} |
1111 | @cindex section addresses in objdump | |
1112 | @cindex VMA in objdump | |
1113 | When dumping information, first add @var{offset} to all the section | |
1114 | addresses. This is useful if the section addresses do not correspond to | |
1115 | the symbol table, which can happen when putting sections at particular | |
1116 | addresses when using a format which can not represent section addresses, | |
1117 | such as a.out. | |
1118 | ||
c72af735 | 1119 | @item -b @var{bfdname} |
eae04238 | 1120 | @itemx --target=@var{bfdname} |
c72af735 | 1121 | @cindex object code format |
ec40bbb8 DM |
1122 | Specify that the object-code format for the object files is |
1123 | @var{bfdname}. This option may not be necessary; @var{objdump} can | |
1124 | automatically recognize many formats. | |
1125 | ||
1126 | For example, | |
c72af735 RP |
1127 | @example |
1128 | objdump -b oasys -m vax -h fu.o | |
1129 | @end example | |
1130 | @noindent | |
ec40bbb8 DM |
1131 | displays summary information from the section headers (@samp{-h}) of |
1132 | @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object | |
c72af735 RP |
1133 | file in the format produced by Oasys compilers. You can list the |
1134 | formats available with the @samp{-i} option. | |
eae04238 | 1135 | @xref{Target Selection}, for more information. |
c72af735 | 1136 | |
9793039f ILT |
1137 | @item -C |
1138 | @itemx --demangle | |
1139 | @cindex demangling in objdump | |
1140 | Decode (@dfn{demangle}) low-level symbol names into user-level names. | |
1141 | Besides removing any initial underscore prepended by the system, this | |
1142 | makes C++ function names readable. @xref{c++filt}, for more information | |
1143 | on demangling. | |
1144 | ||
e1c14599 ILT |
1145 | @item --debugging |
1146 | Display debugging information. This attempts to parse debugging | |
1147 | information stored in the file and print it out using a C like syntax. | |
1148 | Only certain types of debugging information have been implemented. | |
1149 | ||
c72af735 | 1150 | @item -d |
eae04238 | 1151 | @itemx --disassemble |
c72af735 RP |
1152 | @cindex disassembling object code |
1153 | @cindex machine instructions | |
d5464baa ILT |
1154 | Display the assembler mnemonics for the machine instructions from |
1155 | @var{objfile}. This option only disassembles those sections which are | |
1156 | expected to contain instructions. | |
1157 | ||
1158 | @item -D | |
1159 | @itemx --disassemble-all | |
1160 | Like @samp{-d}, but disassemble the contents of all sections, not just | |
1161 | those expected to contain instructions. | |
c72af735 | 1162 | |
51b8c416 ILT |
1163 | @item --prefix-addresses |
1164 | When disassembling, print the complete address on each line. This is | |
1165 | the older disassembly format. | |
1166 | ||
1167 | @item --disassemble-zeroes | |
1168 | Normally the disassembly output will skip blocks of zeroes. This | |
1169 | option directs the disassembler to disassemble those blocks, just like | |
1170 | any other data. | |
1171 | ||
67c8c901 ILT |
1172 | @item -EB |
1173 | @itemx -EL | |
1174 | @itemx --endian=@{big|little@} | |
1175 | @cindex endianness | |
1176 | @cindex disassembly endianness | |
1177 | Specify the endianness of the object files. This only affects | |
1178 | disassembly. This can be useful when disassembling a file format which | |
1179 | does not describe endianness information, such as S-records. | |
1180 | ||
c72af735 | 1181 | @item -f |
eae04238 | 1182 | @itemx --file-header |
c72af735 | 1183 | @cindex object file header |
eae04238 | 1184 | Display summary information from the overall header of |
ec40bbb8 | 1185 | each of the @var{objfile} files. |
c72af735 RP |
1186 | |
1187 | @item -h | |
eae04238 | 1188 | @itemx --section-header |
c5f0c938 | 1189 | @itemx --header |
c72af735 | 1190 | @cindex section headers |
eae04238 | 1191 | Display summary information from the section headers of the |
c72af735 RP |
1192 | object file. |
1193 | ||
db2e6adb DM |
1194 | File segments may be relocated to nonstandard addresses, for example by |
1195 | using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to | |
1196 | @code{ld}. However, some object file formats, such as a.out, do not | |
1197 | store the starting address of the file segments. In those situations, | |
1198 | although @code{ld} relocates the sections correctly, using @samp{objdump | |
1199 | -h} to list the file section headers cannot show the correct addresses. | |
1200 | Instead, it shows the usual addresses, which are implicit for the | |
1201 | target. | |
1202 | ||
b26ac613 DM |
1203 | @item --help |
1204 | Print a summary of the options to @code{objdump} and exit. | |
1205 | ||
c72af735 | 1206 | @item -i |
eae04238 | 1207 | @itemx --info |
c72af735 RP |
1208 | @cindex architectures available |
1209 | @cindex object formats available | |
1210 | Display a list showing all architectures and object formats available | |
ec40bbb8 | 1211 | for specification with @samp{-b} or @samp{-m}. |
c72af735 | 1212 | |
c72af735 | 1213 | @item -j @var{name} |
eae04238 | 1214 | @itemx --section=@var{name} |
c72af735 | 1215 | @cindex section information |
ec40bbb8 | 1216 | Display information only for section @var{name}. |
c72af735 | 1217 | |
c72af735 | 1218 | @item -l |
eae04238 | 1219 | @itemx --line-numbers |
c72af735 | 1220 | @cindex source filenames for object files |
11548211 ILT |
1221 | Label the display (using debugging information) with the filename and |
1222 | source line numbers corresponding to the object code or relocs shown. | |
1223 | Only useful with @samp{-d}, @samp{-D}, or @samp{-r}. | |
c72af735 | 1224 | |
c72af735 | 1225 | @item -m @var{machine} |
eae04238 | 1226 | @itemx --architecture=@var{machine} |
c72af735 | 1227 | @cindex architecture |
67c8c901 ILT |
1228 | @cindex disassembly architecture |
1229 | Specify the architecture to use when disassembling object files. This | |
1230 | can be useful when disasembling object files which do not describe | |
1231 | architecture information, such as S-records. You can list the available | |
1232 | architectures with the @samp{-i} option. | |
c72af735 RP |
1233 | |
1234 | @item -r | |
c5f0c938 | 1235 | @itemx --reloc |
c72af735 | 1236 | @cindex relocation entries, in object file |
d5464baa ILT |
1237 | Print the relocation entries of the file. If used with @samp{-d} or |
1238 | @samp{-D}, the relocations are printed interspersed with the | |
1239 | disassembly. | |
c72af735 | 1240 | |
de3b08ac ILT |
1241 | @item -R |
1242 | @itemx --dynamic-reloc | |
1243 | @cindex dynamic relocation entries, in object file | |
1244 | Print the dynamic relocation entries of the file. This is only | |
1245 | meaningful for dynamic objects, such as certain types of shared | |
1246 | libraries. | |
1247 | ||
c72af735 | 1248 | @item -s |
eae04238 | 1249 | @itemx --full-contents |
c72af735 RP |
1250 | @cindex sections, full contents |
1251 | @cindex object file sections | |
1252 | Display the full contents of any sections requested. | |
1253 | ||
a8e27cc6 ILT |
1254 | @item -S |
1255 | @itemx --source | |
1256 | @cindex source disassembly | |
1257 | @cindex disassembly, with source | |
1258 | Display source code intermixed with disassembly, if possible. Implies | |
1259 | @samp{-d}. | |
1260 | ||
458bbd1f DE |
1261 | @item --show-raw-insn |
1262 | When disassembling instructions, print the instruction in hex as well as | |
4cb99ff2 ILT |
1263 | in symbolic form. This is the default except when |
1264 | @code{--prefix-addresses} is used. | |
458bbd1f | 1265 | |
5c59269f ILT |
1266 | @item --no-show-raw-insn |
1267 | When disassembling instructions, do not print the instruction bytes. | |
1268 | This is the default when @code{--prefix-addresses} is used. | |
1269 | ||
c5f0c938 JG |
1270 | @item --stabs |
1271 | @cindex stab | |
1272 | @cindex .stab | |
1273 | @cindex debug symbols | |
1274 | @cindex ELF object file format | |
c3c93fda JG |
1275 | Display the full contents of any sections requested. Display the |
1276 | contents of the .stab and .stab.index and .stab.excl sections from an | |
1277 | ELF file. This is only useful on systems (such as Solaris 2.0) in which | |
1278 | @code{.stab} debugging symbol-table entries are carried in an ELF | |
1279 | section. In most other file formats, debugging symbol-table entries are | |
c5f0c938 | 1280 | interleaved with linkage symbols, and are visible in the @samp{--syms} |
85d4b870 ILT |
1281 | output. For more information on stabs symbols, see @ref{Top,Stabs,Stabs |
1282 | Overview,stabs.info, The ``stabs'' debug format}. | |
c5f0c938 | 1283 | |
aa21a2a9 ILT |
1284 | @item --start-address=@var{address} |
1285 | @cindex start-address | |
1286 | Start displaying data at the specified address. This affects the output | |
1287 | of the @code{-d}, @code{-r} and @code{-s} options. | |
1288 | ||
1289 | @item --stop-address=@var{address} | |
1290 | @cindex stop-address | |
1291 | Stop displaying data at the specified address. This affects the output | |
1292 | of the @code{-d}, @code{-r} and @code{-s} options. | |
1293 | ||
c72af735 | 1294 | @item -t |
c5f0c938 | 1295 | @itemx --syms |
c72af735 | 1296 | @cindex symbol table entries, printing |
eae04238 | 1297 | Print the symbol table entries of the file. |
c72af735 RP |
1298 | This is similar to the information provided by the @samp{nm} program. |
1299 | ||
de3b08ac ILT |
1300 | @item -T |
1301 | @itemx --dynamic-syms | |
1302 | @cindex dynamic symbol table entries, printing | |
1303 | Print the dynamic symbol table entries of the file. This is only | |
1304 | meaningful for dynamic objects, such as certain types of shared | |
1305 | libraries. This is similar to the information provided by the @samp{nm} | |
1306 | program when given the @samp{-D} (@samp{--dynamic}) option. | |
1307 | ||
b26ac613 DM |
1308 | @item --version |
1309 | Print the version number of @code{objdump} and exit. | |
1310 | ||
c72af735 | 1311 | @item -x |
eae04238 | 1312 | @itemx --all-header |
c72af735 RP |
1313 | @cindex all header information, object file |
1314 | @cindex header information, all | |
1315 | Display all available header information, including the symbol table and | |
1316 | relocation entries. Using @samp{-x} is equivalent to specifying all of | |
1317 | @samp{-a -f -h -r -t}. | |
4b6d0f78 MM |
1318 | |
1319 | @item -w | |
1320 | @item --wide | |
1321 | @cindex wide output, printing | |
1322 | Format some lines for output devices that have more than 80 columns. | |
c72af735 RP |
1323 | @end table |
1324 | ||
eae04238 | 1325 | @node ranlib |
c72af735 RP |
1326 | @chapter ranlib |
1327 | ||
1328 | @kindex ranlib | |
1329 | @cindex archive contents | |
1330 | @cindex symbol index | |
1331 | ||
1332 | @smallexample | |
4d9b5d5a | 1333 | ranlib [-vV] @var{archive} |
c72af735 RP |
1334 | @end smallexample |
1335 | ||
ec40bbb8 | 1336 | @code{ranlib} generates an index to the contents of an archive and |
c72af735 RP |
1337 | stores it in the archive. The index lists each symbol defined by a |
1338 | member of an archive that is a relocatable object file. | |
1339 | ||
918c2f61 | 1340 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index. |
c72af735 | 1341 | |
ec40bbb8 | 1342 | An archive with such an index speeds up linking to the library and |
c72af735 RP |
1343 | allows routines in the library to call each other without regard to |
1344 | their placement in the archive. | |
1345 | ||
b94ff924 | 1346 | The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running |
c72af735 RP |
1347 | @code{ranlib} is completely equivalent to executing @samp{ar -s}. |
1348 | @xref{ar}. | |
1349 | ||
4d9b5d5a DM |
1350 | @table @code |
1351 | @item -v | |
1352 | @itemx -V | |
1353 | Show the version number of @code{ranlib}. | |
c3f471a4 | 1354 | @end table |
4d9b5d5a | 1355 | |
eae04238 | 1356 | @node size |
c72af735 RP |
1357 | @chapter size |
1358 | ||
1359 | @kindex size | |
1360 | @cindex section sizes | |
1361 | ||
1362 | @smallexample | |
4d9b5d5a DM |
1363 | size [ -A | -B | --format=@var{compatibility} ] |
1364 | [ --help ] [ -d | -o | -x | --radix=@var{number} ] | |
1365 | [ --target=@var{bfdname} ] [ -V | --version ] | |
f2843a17 | 1366 | [ @var{objfile}@dots{} ] |
c72af735 RP |
1367 | @end smallexample |
1368 | ||
b94ff924 | 1369 | The @sc{gnu} @code{size} utility lists the section sizes---and the total |
ec40bbb8 DM |
1370 | size---for each of the object or archive files @var{objfile} in its |
1371 | argument list. By default, one line of output is generated for each | |
1372 | object file or each module in an archive. | |
c72af735 | 1373 | |
b26ac613 | 1374 | @var{objfile}@dots{} are the object files to be examined. |
f2843a17 | 1375 | If none are specified, the file @code{a.out} will be used. |
b26ac613 | 1376 | |
c72af735 | 1377 | The command line options have the following meanings: |
c72af735 | 1378 | |
b26ac613 | 1379 | @table @code |
c72af735 RP |
1380 | @item -A |
1381 | @itemx -B | |
ec40bbb8 | 1382 | @itemx --format=@var{compatibility} |
68dd5295 | 1383 | @cindex @code{size} display format |
b94ff924 | 1384 | Using one of these options, you can choose whether the output from @sc{gnu} |
c72af735 | 1385 | @code{size} resembles output from System V @code{size} (using @samp{-A}, |
ec40bbb8 DM |
1386 | or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or |
1387 | @samp{--format=berkeley}). The default is the one-line format similar to | |
c72af735 | 1388 | Berkeley's. |
918c2f61 PB |
1389 | @c Bonus for doc-source readers: you can also say --format=strange (or |
1390 | @c anything else that starts with 's') for sysv, and --format=boring (or | |
c72af735 RP |
1391 | @c anything else that starts with 'b') for Berkeley. |
1392 | ||
1393 | Here is an example of the Berkeley (default) format of output from | |
1394 | @code{size}: | |
1395 | @smallexample | |
eae04238 | 1396 | size --format=Berkeley ranlib size |
c72af735 RP |
1397 | text data bss dec hex filename |
1398 | 294880 81920 11592 388392 5ed28 ranlib | |
1399 | 294880 81920 11888 388688 5ee50 size | |
1400 | @end smallexample | |
1401 | ||
1402 | @noindent | |
1403 | This is the same data, but displayed closer to System V conventions: | |
1404 | ||
1405 | @smallexample | |
eae04238 | 1406 | size --format=SysV ranlib size |
c72af735 RP |
1407 | ranlib : |
1408 | section size addr | |
1409 | .text 294880 8192 | |
1410 | .data 81920 303104 | |
1411 | .bss 11592 385024 | |
1412 | Total 388392 | |
1413 | ||
1414 | ||
1415 | size : | |
1416 | section size addr | |
1417 | .text 294880 8192 | |
1418 | .data 81920 303104 | |
1419 | .bss 11888 385024 | |
1420 | Total 388688 | |
1421 | @end smallexample | |
1422 | ||
918c2f61 | 1423 | @item --help |
c72af735 RP |
1424 | Show a summary of acceptable arguments and options. |
1425 | ||
1426 | @item -d | |
1427 | @itemx -o | |
1428 | @itemx -x | |
ec40bbb8 | 1429 | @itemx --radix=@var{number} |
68dd5295 | 1430 | @cindex @code{size} number format |
c72af735 RP |
1431 | @cindex radix for section sizes |
1432 | Using one of these options, you can control whether the size of each | |
ec40bbb8 DM |
1433 | section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal |
1434 | (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or | |
1435 | @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three | |
c72af735 RP |
1436 | values (8, 10, 16) are supported. The total size is always given in two |
1437 | radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or | |
1438 | octal and hexadecimal if you're using @samp{-o}. | |
1439 | ||
ec40bbb8 | 1440 | @item --target=@var{bfdname} |
c72af735 | 1441 | @cindex object code format |
ec40bbb8 DM |
1442 | Specify that the object-code format for @var{objfile} is |
1443 | @var{bfdname}. This option may not be necessary; @code{size} can | |
eae04238 DM |
1444 | automatically recognize many formats. |
1445 | @xref{Target Selection}, for more information. | |
c72af735 RP |
1446 | |
1447 | @item -V | |
918c2f61 | 1448 | @itemx --version |
4d9b5d5a | 1449 | Display the version number of @code{size}. |
c72af735 RP |
1450 | @end table |
1451 | ||
eae04238 | 1452 | @node strings |
ba7c8e29 DM |
1453 | @chapter strings |
1454 | @kindex strings | |
1455 | @cindex listings strings | |
1456 | @cindex printing strings | |
1457 | @cindex strings, printing | |
1458 | ||
1459 | @smallexample | |
b26ac613 | 1460 | strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-] |
650a49f0 | 1461 | [--all] [--print-file-name] [--bytes=@var{min-len}] |
eae04238 DM |
1462 | [--radix=@var{radix}] [--target=@var{bfdname}] |
1463 | [--help] [--version] @var{file}@dots{} | |
ba7c8e29 DM |
1464 | @end smallexample |
1465 | ||
b94ff924 | 1466 | For each @var{file} given, @sc{gnu} @code{strings} prints the printable |
ba7c8e29 | 1467 | character sequences that are at least 4 characters long (or the number |
67ace729 | 1468 | given with the options below) and are followed by an unprintable |
ba7c8e29 | 1469 | character. By default, it only prints the strings from the initialized |
5f057047 ILT |
1470 | and loaded sections of object files; for other types of files, it prints |
1471 | the strings from the whole file. | |
ba7c8e29 DM |
1472 | |
1473 | @code{strings} is mainly useful for determining the contents of non-text | |
1474 | files. | |
1475 | ||
1476 | @table @code | |
1477 | @item -a | |
1478 | @itemx --all | |
1479 | @itemx - | |
5f057047 ILT |
1480 | Do not scan only the initialized and loaded sections of object files; |
1481 | scan the whole files. | |
ba7c8e29 DM |
1482 | |
1483 | @item -f | |
1484 | @itemx --print-file-name | |
1485 | Print the name of the file before each string. | |
1486 | ||
b26ac613 | 1487 | @item --help |
ba7c8e29 DM |
1488 | Print a summary of the program usage on the standard output and exit. |
1489 | ||
ba7c8e29 | 1490 | @itemx -@var{min-len} |
b26ac613 | 1491 | @item -n @var{min-len} |
ba7c8e29 DM |
1492 | @itemx --bytes=@var{min-len} |
1493 | Print sequences of characters that are at least @var{min-len} characters | |
1494 | long, instead of the default 4. | |
1495 | ||
1496 | @item -o | |
b26ac613 DM |
1497 | Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o} |
1498 | act like @samp{-t d} instead. Since we can not be compatible with both | |
1499 | ways, we simply chose one. | |
ba7c8e29 DM |
1500 | |
1501 | @item -t @var{radix} | |
1502 | @itemx --radix=@var{radix} | |
1503 | Print the offset within the file before each string. The single | |
1504 | character argument specifies the radix of the offset---@samp{o} for | |
1505 | octal, @samp{x} for hexadecimal, or @samp{d} for decimal. | |
1506 | ||
eae04238 DM |
1507 | @item --target=@var{bfdname} |
1508 | @cindex object code format | |
1509 | Specify an object code format other than your system's default format. | |
1510 | @xref{Target Selection}, for more information. | |
1511 | ||
ba7c8e29 DM |
1512 | @item -v |
1513 | @itemx --version | |
1514 | Print the program version number on the standard output and exit. | |
1515 | @end table | |
1516 | ||
eae04238 | 1517 | @node strip |
c72af735 RP |
1518 | @chapter strip |
1519 | ||
1520 | @kindex strip | |
1521 | @cindex removing symbols | |
1522 | @cindex discarding symbols | |
1815e42c | 1523 | @cindex symbols, discarding |
c72af735 RP |
1524 | |
1525 | @smallexample | |
18ef0a3d | 1526 | strip [ -F @var{bfdname} | --target=@var{bfdname} ] |
eae04238 DM |
1527 | [ -I @var{bfdname} | --input-target=@var{bfdname} ] |
1528 | [ -O @var{bfdname} | --output-target=@var{bfdname} ] | |
b703c078 | 1529 | [ -s | --strip-all ] [ -S | -g | --strip-debug ] |
dff604a7 | 1530 | [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ] |
29c0d15c | 1531 | [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ] |
b703c078 | 1532 | [ -x | --discard-all ] [ -X | --discard-locals ] |
0aca460e | 1533 | [ -R @var{sectionname} | --remove-section=@var{sectionname} ] |
2483354d | 1534 | [ -o @var{file} ] [ -p | --preserve-dates ] |
b26ac613 | 1535 | [ -v | --verbose ] [ -V | --version ] [ --help ] |
b703c078 | 1536 | @var{objfile}@dots{} |
c72af735 RP |
1537 | @end smallexample |
1538 | ||
b94ff924 | 1539 | @sc{gnu} @code{strip} discards all symbols from object files |
ec40bbb8 | 1540 | @var{objfile}. The list of object files may include archives. |
b26ac613 | 1541 | At least one object file must be given. |
c72af735 | 1542 | |
ec40bbb8 | 1543 | @code{strip} modifies the files named in its argument, |
c72af735 | 1544 | rather than writing modified copies under different names. |
c72af735 | 1545 | |
c72af735 | 1546 | @table @code |
eae04238 DM |
1547 | @item -F @var{bfdname} |
1548 | @itemx --target=@var{bfdname} | |
b26ac613 | 1549 | Treat the original @var{objfile} as a file with the object |
eae04238 DM |
1550 | code format @var{bfdname}, and rewrite it in the same format. |
1551 | @xref{Target Selection}, for more information. | |
b26ac613 DM |
1552 | |
1553 | @item --help | |
1554 | Show a summary of the options to @code{strip} and exit. | |
1555 | ||
eae04238 DM |
1556 | @item -I @var{bfdname} |
1557 | @itemx --input-target=@var{bfdname} | |
ec40bbb8 | 1558 | Treat the original @var{objfile} as a file with the object |
eae04238 DM |
1559 | code format @var{bfdname}. |
1560 | @xref{Target Selection}, for more information. | |
918c2f61 | 1561 | |
eae04238 DM |
1562 | @item -O @var{bfdname} |
1563 | @itemx --output-target=@var{bfdname} | |
1564 | Replace @var{objfile} with a file in the output format @var{bfdname}. | |
1565 | @xref{Target Selection}, for more information. | |
918c2f61 | 1566 | |
0aca460e ILT |
1567 | @item -R @var{sectionname} |
1568 | @itemx --remove-section=@var{sectionname} | |
1569 | Remove any section named @var{sectionname} from the output file. This | |
1570 | option may be given more than once. Note that using this option | |
1571 | inappropriately may make the output file unusable. | |
1572 | ||
b703c078 DM |
1573 | @item -s |
1574 | @itemx --strip-all | |
1575 | Remove all symbols. | |
1576 | ||
918c2f61 PB |
1577 | @item -g |
1578 | @itemx -S | |
1579 | @itemx --strip-debug | |
1580 | Remove debugging symbols only. | |
1581 | ||
9135e5f8 ILT |
1582 | @item --strip-unneeded |
1583 | Remove all symbols that are not needed for relocation processing. | |
1584 | ||
dff604a7 ILT |
1585 | @item -K @var{symbolname} |
1586 | @itemx --keep-symbol=@var{symbolname} | |
1587 | Keep only symbol @var{symbolname} from the source file. This option may | |
1588 | be given more than once. | |
1589 | ||
29c0d15c ILT |
1590 | @item -N @var{symbolname} |
1591 | @itemx --strip-symbol=@var{symbolname} | |
dff604a7 ILT |
1592 | Remove symbol @var{symbolname} from the source file. This option may be |
1593 | given more than once, and may be combined with strip options other than | |
1594 | @code{-K}. | |
29c0d15c | 1595 | |
16c3e32a ILT |
1596 | @item -o @var{file} |
1597 | Put the stripped output in @var{file}, rather than replacing the | |
1598 | existing file. When this argument is used, only one @var{objfile} | |
1599 | argument may be specified. | |
1600 | ||
2483354d ILT |
1601 | @item -p |
1602 | @itemx --preserve-dates | |
1603 | Preserve the access and modification dates of the file. | |
1604 | ||
918c2f61 PB |
1605 | @item -x |
1606 | @itemx --discard-all | |
1607 | Remove non-global symbols. | |
1608 | ||
1609 | @item -X | |
1610 | @itemx --discard-locals | |
1611 | Remove compiler-generated local symbols. | |
ec40bbb8 | 1612 | (These usually start with @samp{L} or @samp{.}.) |
918c2f61 PB |
1613 | |
1614 | @item -V | |
1615 | @itemx --version | |
ec40bbb8 | 1616 | Show the version number for @code{strip}. |
918c2f61 | 1617 | |
1815e42c | 1618 | @item -v |
918c2f61 PB |
1619 | @itemx --verbose |
1620 | Verbose output: list all object files modified. In the case of | |
1269d441 | 1621 | archives, @samp{strip -v} lists all members of the archive. |
c72af735 RP |
1622 | @end table |
1623 | ||
eae04238 | 1624 | @node c++filt |
b6216af2 PB |
1625 | @chapter c++filt |
1626 | ||
1627 | @kindex c++filt | |
1628 | @cindex demangling C++ symbols | |
1629 | ||
b26ac613 DM |
1630 | @smallexample |
1631 | c++filt [ -_ | --strip-underscores ] | |
6f88f031 | 1632 | [ -n | --no-strip-underscores ] |
b26ac613 | 1633 | [ -s @var{format} | --format=@var{format} ] |
d6a4c375 | 1634 | [ --help ] [ --version ] [ @var{symbol}@dots{} ] |
b26ac613 DM |
1635 | @end smallexample |
1636 | ||
6c69b6bd JO |
1637 | The C++ language provides function overloading, which means that you can |
1638 | write many functions with the same name (providing each takes parameters | |
1639 | of different types). All C++ function names are encoded into a | |
b26ac613 | 1640 | low-level assembly label (this process is known as |
6c69b6bd JO |
1641 | @dfn{mangling}). The @code{c++filt} program does the inverse mapping: it |
1642 | decodes (@dfn{demangles}) low-level names into user-level names so that | |
1643 | the linker can keep these overloaded functions from clashing. | |
1644 | ||
1645 | Every alphanumeric word (consisting of letters, digits, underscores, | |
1646 | dollars, or periods) seen in the input is a potential label. If the | |
1647 | label decodes into a C++ name, the C++ name replaces the low-level | |
1648 | name in the output. | |
b6216af2 | 1649 | |
d6a4c375 | 1650 | You can use @code{c++filt} to decipher individual symbols: |
6c69b6bd JO |
1651 | |
1652 | @example | |
1653 | c++filt @var{symbol} | |
1654 | @end example | |
1655 | ||
d6a4c375 DM |
1656 | If no @var{symbol} arguments are given, @code{c++filt} reads symbol |
1657 | names from the standard input and writes the demangled names to the | |
1658 | standard output. All results are printed on the standard output. | |
b6216af2 | 1659 | |
b26ac613 DM |
1660 | @table @code |
1661 | @item -_ | |
94e9ad77 | 1662 | @itemx --strip-underscores |
b26ac613 DM |
1663 | On some systems, both the C and C++ compilers put an underscore in front |
1664 | of every name. For example, the C name @code{foo} gets the low-level | |
6f88f031 ILT |
1665 | name @code{_foo}. This option removes the initial underscore. Whether |
1666 | @code{c++filt} removes the underscore by default is target dependent. | |
1667 | ||
1668 | @item -n | |
1669 | @itemx --no-strip-underscores | |
1670 | Do not remove the initial underscore. | |
b26ac613 DM |
1671 | |
1672 | @item -s @var{format} | |
1673 | @itemx --format=@var{format} | |
b94ff924 | 1674 | @sc{gnu} @code{nm} can decode three different methods of mangling, used by |
b26ac613 DM |
1675 | different C++ compilers. The argument to this option selects which |
1676 | method it uses: | |
1677 | ||
1678 | @table @code | |
1679 | @item gnu | |
b94ff924 | 1680 | the one used by the @sc{gnu} compiler (the default method) |
b26ac613 DM |
1681 | @item lucid |
1682 | the one used by the Lucid compiler | |
1683 | @item arm | |
1684 | the one specified by the C++ Annotated Reference Manual | |
1685 | @end table | |
1686 | ||
1687 | @item --help | |
1688 | Print a summary of the options to @code{c++filt} and exit. | |
1689 | ||
1690 | @item --version | |
1691 | Print the version number of @code{c++filt} and exit. | |
1692 | @end table | |
b6216af2 | 1693 | |
5eac46ae JO |
1694 | @quotation |
1695 | @emph{Warning:} @code{c++filt} is a new utility, and the details of its | |
1696 | user interface are subject to change in future releases. In particular, | |
1697 | a command-line option may be required in the the future to decode a name | |
1698 | passed as an argument on the command line; in other words, | |
1699 | ||
1700 | @example | |
b26ac613 | 1701 | c++filt @var{symbol} |
5eac46ae JO |
1702 | @end example |
1703 | ||
1704 | @noindent | |
1705 | may in a future release become | |
1706 | ||
1707 | @example | |
b26ac613 | 1708 | c++filt @var{option} @var{symbol} |
5eac46ae JO |
1709 | @end example |
1710 | @end quotation | |
1711 | ||
fb38844d ILT |
1712 | @node addr2line |
1713 | @chapter addr2line | |
1714 | ||
1715 | @kindex addr2line | |
1716 | @cindex address to file name and line number | |
1717 | ||
1718 | @smallexample | |
1719 | addr2line [ -b @var{bfdname} | --target=@var{bfdname} ] | |
1720 | [ -C | --demangle ] | |
1721 | [ -e @var{filename} | --exe=@var{filename} ] | |
1722 | [ -f | --functions ] [ -s | --basename ] | |
1723 | [ -H | --help ] [ -V | --version ] | |
1724 | [ addr addr ... ] | |
1725 | @end smallexample | |
1726 | ||
1727 | @code{addr2line} translates program addresses into file names and line | |
1728 | numbers. Given an address and an executable, it uses the debugging | |
1729 | information in the executable to figure out which file name and line | |
1730 | number are associated with a given address. | |
1731 | ||
1732 | The executable to use is specified with the @code{-e} option. The | |
1733 | default is @file{a.out}. | |
1734 | ||
1735 | @code{addr2line} has two modes of operation. | |
1736 | ||
1737 | In the first, hexadecimal addresses are specified on the command line, | |
1738 | and @code{addr2line} displays the file name and line number for each | |
1739 | address. | |
1740 | ||
1741 | In the second, @code{addr2line} reads hexadecimal addresses from | |
1742 | standard input, and prints the file name and line number for each | |
1743 | address on standard output. In this mode, @code{addr2line} may be used | |
1744 | in a pipe to convert dynamically chosen addresses. | |
1745 | ||
1746 | The format of the output is @samp{FILENAME:LINENO}. The file name and | |
1747 | line number for each address is printed on a separate line. If the | |
1748 | @code{-f} option is used, then each @samp{FILENAME:LINENO} line is | |
1749 | preceded by a @samp{FUNCTIONNAME} line which is the name of the function | |
1750 | containing the address. | |
1751 | ||
1752 | If the file name or function name can not be determined, | |
1753 | @code{addr2line} will print two question marks in their place. If the | |
1754 | line number can not be determined, @code{addr2line} will print 0. | |
1755 | ||
1756 | The long and short forms of options, shown here as alternatives, are | |
1757 | equivalent. | |
1758 | ||
1759 | @table @code | |
1760 | @item -b @var{bfdname} | |
1761 | @itemx --target=@var{bfdname} | |
1762 | @cindex object code format | |
1763 | Specify that the object-code format for the object files is | |
1764 | @var{bfdname}. | |
1765 | ||
1766 | @item -C | |
1767 | @itemx --demangle | |
1768 | @cindex demangling in objdump | |
1769 | Decode (@dfn{demangle}) low-level symbol names into user-level names. | |
1770 | Besides removing any initial underscore prepended by the system, this | |
1771 | makes C++ function names readable. @xref{c++filt}, for more information | |
1772 | on demangling. | |
1773 | ||
1774 | @item -e @var{filename} | |
1775 | @itemx --exe=@var{filename} | |
1776 | Specify the name of the executable for which addresses should be | |
1777 | translated. The default file is @file{a.out}. | |
1778 | ||
1779 | @item -f | |
1780 | @itemx --functions | |
1781 | Display function names as well as file and line number information. | |
1782 | ||
1783 | @item -s | |
1784 | @itemx --basenames | |
1785 | Display only the base of each file name. | |
1786 | @end table | |
1787 | ||
eae04238 | 1788 | @node nlmconv |
94e9ad77 JO |
1789 | @chapter nlmconv |
1790 | ||
1791 | @code{nlmconv} converts a relocatable object file into a NetWare | |
8981cac5 JO |
1792 | Loadable Module. |
1793 | ||
1794 | @ignore | |
1795 | @code{nlmconv} currently works with @samp{i386} object | |
4961ce5b JO |
1796 | files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC} |
1797 | object files in @sc{elf}, or @code{a.out} format@footnote{ | |
1798 | @code{nlmconv} should work with any @samp{i386} or @sc{sparc} object | |
1799 | format in the Binary File Descriptor library. It has only been tested | |
1800 | with the above formats.}. | |
8981cac5 | 1801 | @end ignore |
4961ce5b JO |
1802 | |
1803 | @quotation | |
1804 | @emph{Warning:} @code{nlmconv} is not always built as part of the binary | |
1805 | utilities, since it is only useful for NLM targets. | |
1806 | @end quotation | |
94e9ad77 JO |
1807 | |
1808 | @smallexample | |
eae04238 DM |
1809 | nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ] |
1810 | [ -O @var{bfdname} | --output-target=@var{bfdname} ] | |
94e9ad77 | 1811 | [ -T @var{headerfile} | --header-file=@var{headerfile} ] |
20465f8b | 1812 | [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ] |
94e9ad77 JO |
1813 | [ -h | --help ] [ -V | --version ] |
1814 | @var{infile} @var{outfile} | |
1815 | @end smallexample | |
1816 | ||
1817 | @code{nlmconv} converts the relocatable @samp{i386} object file | |
1818 | @var{infile} into the NetWare Loadable Module @var{outfile}, optionally | |
1819 | reading @var{headerfile} for NLM header information. For instructions | |
5b0ba16d JO |
1820 | on writing the NLM command file language used in header files, see the |
1821 | @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM | |
1822 | Development and Tools Overview}, which is part of the NLM Software | |
1823 | Developer's Kit (``NLM SDK''), available from Novell, Inc. | |
1824 | @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read | |
eae04238 | 1825 | @var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for |
5b0ba16d | 1826 | more information. |
94e9ad77 | 1827 | |
20465f8b JO |
1828 | @code{nlmconv} can perform a link step. In other words, you can list |
1829 | more than one object file for input if you list them in the definitions | |
1830 | file (rather than simply specifying one input file on the command line). | |
1831 | In this case, @code{nlmconv} calls the linker for you. | |
1832 | ||
94e9ad77 | 1833 | @table @code |
eae04238 DM |
1834 | @item -I @var{bfdname} |
1835 | @itemx --input-target=@var{bfdname} | |
94e9ad77 | 1836 | Object format of the input file. @code{nlmconv} can usually determine |
eae04238 DM |
1837 | the format of a given file (so no default is necessary). |
1838 | @xref{Target Selection}, for more information. | |
94e9ad77 | 1839 | |
eae04238 DM |
1840 | @item -O @var{bfdname} |
1841 | @itemx --output-target=@var{bfdname} | |
94e9ad77 JO |
1842 | Object format of the output file. @code{nlmconv} infers the output |
1843 | format based on the input format, e.g. for a @samp{i386} input file the | |
eae04238 DM |
1844 | output format is @samp{nlm32-i386}. |
1845 | @xref{Target Selection}, for more information. | |
94e9ad77 JO |
1846 | |
1847 | @item -T @var{headerfile} | |
1848 | @itemx --header-file=@var{headerfile} | |
1849 | Reads @var{headerfile} for NLM header information. For instructions on | |
5b0ba16d JO |
1850 | writing the NLM command file language used in header files, see@ see the |
1851 | @samp{linkers} section, of the @cite{NLM Development and Tools | |
1852 | Overview}, which is part of the NLM Software Developer's Kit, available | |
1853 | from Novell, Inc. | |
94e9ad77 | 1854 | |
20465f8b JO |
1855 | @item -d |
1856 | @itemx --debug | |
1857 | Displays (on standard error) the linker command line used by @code{nlmconv}. | |
1858 | ||
1859 | @item -l @var{linker} | |
1860 | @itemx --linker=@var{linker} | |
1861 | Use @var{linker} for any linking. @var{linker} can be an abosolute or a | |
1862 | relative pathname. | |
1863 | ||
94e9ad77 JO |
1864 | @item -h |
1865 | @itemx --help | |
1866 | Prints a usage summary. | |
1867 | ||
1868 | @item -V | |
1869 | @itemx --version | |
1870 | Prints the version number for @code{nlmconv}. | |
1871 | @end table | |
1872 | ||
217947b2 ILT |
1873 | @node windres |
1874 | @chapter windres | |
1875 | ||
1876 | @code{windres} may be used to manipulate Windows resources. | |
1877 | ||
1878 | @quotation | |
1879 | @emph{Warning:} @code{windres} is not always built as part of the binary | |
1880 | utilities, since it is only useful for Windows targets. | |
1881 | @end quotation | |
1882 | ||
1883 | @smallexample | |
1884 | windres [options] [input-file] [output-file] | |
1885 | @end smallexample | |
1886 | ||
1887 | @code{windres} reads resources from an input file and copies them into | |
1888 | an output file. Either file may be in one of three formats: | |
1889 | ||
1890 | @table @code | |
1891 | @item rc | |
1892 | A text format read by the Resource Compiler. | |
1893 | ||
1894 | @item res | |
1895 | A binary format generated by the Resource Compiler. | |
1896 | ||
1897 | @item coff | |
1898 | A COFF object or executable. | |
1899 | @end table | |
1900 | ||
1901 | The exact description of these different formats is available in | |
1902 | documentation from Microsoft. | |
1903 | ||
1904 | When @code{windres} converts from the @code{rc} format to the @code{res} | |
1905 | format, it is acting like the Windows Resource Compiler. When | |
1906 | @code{windres} converts from the @code{res} format to the @code{coff} | |
1907 | format, it is acting like the Windows @code{CVTRES} program. | |
1908 | ||
1909 | When @code{windres} generates an @code{rc} file, the output is similar | |
1910 | but not identical to the format expected for the input. When an input | |
1911 | @code{rc} file refers to an external filename, an output @code{rc} file | |
1912 | will instead include the file contents. | |
1913 | ||
1914 | If the input or output format is not specified, @code{windres} will | |
1915 | guess based on the file name, or, for the input file, the file contents. | |
1916 | A file with an extension of @file{.rc} will be treated as an @code{rc} | |
1917 | file, a file with an extension of @file{.res} will be treated as a | |
1918 | @code{res} file, and a file with an extension of @file{.o} or | |
1919 | @file{.exe} will be treated as a @code{coff} file. | |
1920 | ||
1921 | If no output file is specified, @code{windres} will print the resources | |
1922 | in @code{rc} format to standard output. | |
1923 | ||
1924 | The normal use is for you to write an @code{rc} file, use @code{windres} | |
1925 | to convert it to a COFF object file, and then link the COFF file into | |
1926 | your application. This will make the resources described in the | |
1927 | @code{rc} file available to Windows. | |
1928 | ||
1929 | @table @code | |
1930 | @item -i @var{filename} | |
1931 | @itemx --input @var{filename} | |
1932 | The name of the input file. If this option is not used, then | |
1933 | @code{windres} will use the first non-option argument as the input file | |
1934 | name. If there are no non-option arguments, then @code{windres} will | |
1935 | read from standard input. @code{windres} can not read a COFF file from | |
1936 | standard input. | |
1937 | ||
1938 | @item -o @var{filename} | |
1939 | @itemx --output @var{filename} | |
1940 | The name of the output file. If this option is not used, then | |
1941 | @code{windres} will use the first non-option argument, after any used | |
1942 | for the input file name, as the output file name. If there is no | |
1943 | non-option argument, then @code{windres} will write to standard output. | |
1944 | @code{windres} can not write a COFF file to standard output. | |
1945 | ||
1946 | @item -I @var{format} | |
1947 | @itemx --input-format @var{format} | |
1948 | The input format to read. @var{format} may be @samp{res}, @samp{rc}, or | |
1949 | @samp{coff}. If no input format is specified, @code{windres} will | |
1950 | guess, as described above. | |
1951 | ||
1952 | @item -O @var{format} | |
1953 | @itemx --output-format @var{format} | |
1954 | The output format to generate. @var{format} may be @samp{res}, | |
1955 | @samp{rc}, or @samp{coff}. If no output format is specified, | |
1956 | @code{windres} will guess, as described above. | |
1957 | ||
1958 | @item -F @var{target} | |
1959 | @itemx --target @var{target} | |
1960 | Specify the BFD format to use for a COFF file as input or output. This | |
1961 | is a BFD target name; you can use the @code{--help} option to see a list | |
1962 | of supported targets. Normally @code{windres} will use the default | |
1963 | format, which is the first one listed by the @code{--help} option. | |
1964 | @ref{Target Selection}. | |
1965 | ||
1966 | @item --preprocessor @var{program} | |
1967 | When @code{windres} reads an @code{rc} file, it runs it through the C | |
1968 | preprocessor first. This option may be used to specify the preprocessor | |
1969 | to use, including any leading arguments. The default preprocessor | |
1970 | argument is @code{gcc -E -xc-header -DRC_INVOKED}. | |
1971 | ||
1972 | @item --include-dir @var{directory} | |
1973 | Specify an include directory to use when reading an @code{rc} file. | |
1974 | @code{windres} will pass this to the preprocessor as an @code{-I} | |
1975 | option. @code{windres} will also search this directory when looking for | |
1976 | files named in the @code{rc} file. | |
1977 | ||
1978 | @item --define @var{sym[=val]} | |
1979 | Specify a @code{-D} option to pass to the preprocessor when reading an | |
1980 | @code{rc} file. | |
1981 | ||
1982 | @item --language @var{val} | |
1983 | Specify the default language to use when reading an @code{rc} file. | |
1984 | @var{val} should be a hexadecimal language code. The low eight bits are | |
1985 | the language, and the high eight bits are the sublanguage. | |
1986 | ||
1987 | @item --help | |
1988 | Prints a usage summary. | |
1989 | ||
1990 | @item --version | |
1991 | Prints the version number for @code{windres}. | |
1992 | ||
1993 | @item --yydebug | |
1994 | If @code{windres} is compiled with @code{YYDEBUG} defined as @code{1}, | |
1995 | this will turn on parser debugging. | |
1996 | @end table | |
1997 | ||
eae04238 DM |
1998 | @node Selecting The Target System |
1999 | @chapter Selecting the target system | |
2000 | ||
8981cac5 JO |
2001 | You can specify three aspects of the target system to the @sc{gnu} |
2002 | binary file utilities, each in several ways: | |
eae04238 DM |
2003 | |
2004 | @itemize @bullet | |
2005 | @item | |
8981cac5 | 2006 | the target |
eae04238 DM |
2007 | |
2008 | @item | |
8981cac5 | 2009 | the architecture |
eae04238 DM |
2010 | |
2011 | @item | |
8981cac5 | 2012 | the linker emulation (which applies to the linker only) |
eae04238 DM |
2013 | @end itemize |
2014 | ||
2015 | In the following summaries, the lists of ways to specify values are in | |
8981cac5 JO |
2016 | order of decreasing precedence. The ways listed first override those |
2017 | listed later. | |
eae04238 | 2018 | |
8981cac5 JO |
2019 | The commands to list valid values only list the values for which the |
2020 | programs you are running were configured. If they were configured with | |
8490169d | 2021 | @samp{--enable-targets=all}, the commands list most of the available |
eae04238 | 2022 | values, but a few are left out; not all targets can be configured in at |
8981cac5 JO |
2023 | once because some of them can only be configured @dfn{native} (on hosts |
2024 | with the same type as the target system). | |
eae04238 DM |
2025 | |
2026 | @menu | |
2027 | * Target Selection:: | |
2028 | * Architecture Selection:: | |
2029 | * Linker Emulation Selection:: | |
2030 | @end menu | |
2031 | ||
2032 | @node Target Selection | |
8981cac5 | 2033 | @section Target Selection |
eae04238 DM |
2034 | |
2035 | A @dfn{target} is an object file format. A given target may be | |
2036 | supported for multiple architectures (@pxref{Architecture Selection}). | |
8981cac5 JO |
2037 | A target selection may also have variations for different operating |
2038 | systems or architectures. | |
eae04238 | 2039 | |
8981cac5 JO |
2040 | The command to list valid target values is @samp{objdump -i} |
2041 | (the first column of output contains the relevant information). | |
eae04238 | 2042 | |
10f2a7f6 JO |
2043 | Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips}, |
2044 | @samp{a.out-sunos-big}. | |
eae04238 | 2045 | |
55311d1c ILT |
2046 | You can also specify a target using a configuration triplet. This is |
2047 | the same sort of name that is passed to configure to specify a target. | |
2048 | When you use a configuration triplet as an argument, it must be fully | |
2049 | canonicalized. You can see the canonical version of a triplet by | |
2050 | running the shell script @file{config.sub} which is included with the | |
2051 | sources. | |
2052 | ||
2053 | Some sample configuration triplets are: @samp{m68k-hp-bsd}, | |
2054 | @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}. | |
2055 | ||
8981cac5 | 2056 | @subheading @code{objdump} Target |
eae04238 DM |
2057 | |
2058 | Ways to specify: | |
2059 | ||
2060 | @enumerate | |
2061 | @item | |
8981cac5 | 2062 | command line option: @samp{-b} or @samp{--target} |
eae04238 DM |
2063 | |
2064 | @item | |
2065 | environment variable @code{GNUTARGET} | |
2066 | ||
2067 | @item | |
2068 | deduced from the input file | |
2069 | @end enumerate | |
2070 | ||
8981cac5 | 2071 | @subheading @code{objcopy} and @code{strip} Input Target |
eae04238 DM |
2072 | |
2073 | Ways to specify: | |
2074 | ||
2075 | @enumerate | |
2076 | @item | |
8981cac5 | 2077 | command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target} |
eae04238 DM |
2078 | |
2079 | @item | |
2080 | environment variable @code{GNUTARGET} | |
2081 | ||
2082 | @item | |
2083 | deduced from the input file | |
2084 | @end enumerate | |
2085 | ||
8981cac5 | 2086 | @subheading @code{objcopy} and @code{strip} Output Target |
eae04238 DM |
2087 | |
2088 | Ways to specify: | |
2089 | ||
2090 | @enumerate | |
2091 | @item | |
8981cac5 | 2092 | command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target} |
eae04238 DM |
2093 | |
2094 | @item | |
8981cac5 | 2095 | the input target (see ``@code{objcopy} and @code{strip} Input Target'' above) |
eae04238 DM |
2096 | |
2097 | @item | |
2098 | environment variable @code{GNUTARGET} | |
2099 | ||
2100 | @item | |
2101 | deduced from the input file | |
2102 | @end enumerate | |
2103 | ||
8981cac5 | 2104 | @subheading @code{nm}, @code{size}, and @code{strings} Target |
eae04238 DM |
2105 | |
2106 | Ways to specify: | |
2107 | ||
2108 | @enumerate | |
2109 | @item | |
8981cac5 | 2110 | command line option: @samp{--target} |
eae04238 DM |
2111 | |
2112 | @item | |
2113 | environment variable @code{GNUTARGET} | |
2114 | ||
2115 | @item | |
2116 | deduced from the input file | |
2117 | @end enumerate | |
2118 | ||
8981cac5 | 2119 | @subheading Linker Input Target |
eae04238 DM |
2120 | |
2121 | Ways to specify: | |
2122 | ||
2123 | @enumerate | |
2124 | @item | |
8981cac5 | 2125 | command line option: @samp{-b} or @samp{--format} |
eae04238 DM |
2126 | (@pxref{Options,,Options,ld.info,Using LD}) |
2127 | ||
2128 | @item | |
2129 | script command @code{TARGET} | |
2130 | (@pxref{Option Commands,,Option Commands,ld.info,Using LD}) | |
2131 | ||
2132 | @item | |
2133 | environment variable @code{GNUTARGET} | |
2134 | (@pxref{Environment,,Environment,ld.info,Using LD}) | |
2135 | ||
2136 | @item | |
2137 | the default target of the selected linker emulation | |
2138 | (@pxref{Linker Emulation Selection}) | |
2139 | @end enumerate | |
2140 | ||
8981cac5 | 2141 | @subheading Linker Output Target |
eae04238 DM |
2142 | |
2143 | Ways to specify: | |
2144 | ||
2145 | @enumerate | |
2146 | @item | |
8981cac5 | 2147 | command line option: @samp{-oformat} |
eae04238 DM |
2148 | (@pxref{Options,,Options,ld.info,Using LD}) |
2149 | ||
2150 | @item | |
2151 | script command @code{OUTPUT_FORMAT} | |
2152 | (@pxref{Option Commands,,Option Commands,ld.info,Using LD}) | |
2153 | ||
2154 | @item | |
8981cac5 | 2155 | the linker input target (see ``Linker Input Target'' above) |
eae04238 DM |
2156 | @end enumerate |
2157 | ||
2158 | @node Architecture Selection | |
2159 | @section Architecture selection | |
2160 | ||
8981cac5 JO |
2161 | An @dfn{architecture} is a type of @sc{cpu} on which an object file is |
2162 | to run. Its name may contain a colon, separating the name of the | |
2163 | processor family from the name of the particular @sc{cpu}. | |
eae04238 | 2164 | |
8981cac5 JO |
2165 | The command to list valid architecture values is @samp{objdump -i} (the |
2166 | second column contains the relevant information). | |
eae04238 DM |
2167 | |
2168 | Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}. | |
2169 | ||
8981cac5 | 2170 | @subheading @code{objdump} Architecture |
eae04238 DM |
2171 | |
2172 | Ways to specify: | |
2173 | ||
2174 | @enumerate | |
2175 | @item | |
8981cac5 | 2176 | command line option: @samp{-m} or @samp{--architecture} |
eae04238 DM |
2177 | |
2178 | @item | |
2179 | deduced from the input file | |
2180 | @end enumerate | |
2181 | ||
8981cac5 | 2182 | @subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture |
eae04238 DM |
2183 | |
2184 | Ways to specify: | |
2185 | ||
2186 | @enumerate | |
2187 | @item | |
2188 | deduced from the input file | |
2189 | @end enumerate | |
2190 | ||
8981cac5 | 2191 | @subheading Linker Input Architecture |
eae04238 DM |
2192 | |
2193 | Ways to specify: | |
2194 | ||
2195 | @enumerate | |
2196 | @item | |
2197 | deduced from the input file | |
2198 | @end enumerate | |
2199 | ||
8981cac5 | 2200 | @subheading Linker Output Architecture |
eae04238 DM |
2201 | |
2202 | Ways to specify: | |
2203 | ||
2204 | @enumerate | |
2205 | @item | |
2206 | script command @code{OUTPUT_ARCH} | |
2207 | (@pxref{Option Commands,,Option Commands,ld.info,Using LD}) | |
2208 | ||
2209 | @item | |
2210 | the default architecture from the linker output target | |
8981cac5 | 2211 | (@pxref{Target Selection}) |
eae04238 DM |
2212 | @end enumerate |
2213 | ||
2214 | @node Linker Emulation Selection | |
2215 | @section Linker emulation selection | |
2216 | ||
2217 | A linker @dfn{emulation} is a ``personality'' of the linker, which gives | |
2218 | the linker default values for the other aspects of the target system. | |
2219 | In particular, it consists of | |
2220 | ||
2221 | @itemize @bullet | |
2222 | @item | |
8981cac5 | 2223 | the linker script |
eae04238 DM |
2224 | |
2225 | @item | |
8981cac5 | 2226 | the target |
eae04238 DM |
2227 | |
2228 | @item | |
2229 | several ``hook'' functions that are run at certain stages of the linking | |
8981cac5 | 2230 | process to do special things that some targets require |
eae04238 DM |
2231 | @end itemize |
2232 | ||
8981cac5 | 2233 | The command to list valid linker emulation values is @samp{ld -V}. |
eae04238 DM |
2234 | |
2235 | Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}. | |
2236 | ||
2237 | Ways to specify: | |
2238 | ||
2239 | @enumerate | |
2240 | @item | |
8981cac5 | 2241 | command line option: @samp{-m} |
eae04238 DM |
2242 | (@pxref{Options,,Options,ld.info,Using LD}) |
2243 | ||
2244 | @item | |
2245 | environment variable @code{LDEMULATION} | |
2246 | ||
2247 | @item | |
2248 | compiled-in @code{DEFAULT_EMULATION} from @file{Makefile}, | |
2249 | which comes from @code{EMUL} in @file{config/@var{target}.mt} | |
2250 | @end enumerate | |
2251 | ||
cbcfa129 ILT |
2252 | @node Reporting Bugs |
2253 | @chapter Reporting Bugs | |
2254 | @cindex bugs | |
2255 | @cindex reporting bugs | |
2256 | ||
2257 | Your bug reports play an essential role in making the binary utilities | |
2258 | reliable. | |
2259 | ||
2260 | Reporting a bug may help you by bringing a solution to your problem, or | |
2261 | it may not. But in any case the principal function of a bug report is | |
2262 | to help the entire community by making the next version of the binary | |
2263 | utilities work better. Bug reports are your contribution to their | |
2264 | maintenance. | |
2265 | ||
2266 | In order for a bug report to serve its purpose, you must include the | |
2267 | information that enables us to fix the bug. | |
2268 | ||
2269 | @menu | |
2270 | * Bug Criteria:: Have you found a bug? | |
2271 | * Bug Reporting:: How to report bugs | |
2272 | @end menu | |
2273 | ||
2274 | @node Bug Criteria | |
2275 | @section Have you found a bug? | |
2276 | @cindex bug criteria | |
2277 | ||
2278 | If you are not sure whether you have found a bug, here are some guidelines: | |
2279 | ||
2280 | @itemize @bullet | |
2281 | @cindex fatal signal | |
2282 | @cindex crash | |
2283 | @item | |
2284 | If a binary utility gets a fatal signal, for any input whatever, that is | |
2285 | a bug. Reliable utilities never crash. | |
2286 | ||
2287 | @cindex error on valid input | |
2288 | @item | |
2289 | If a binary utility produces an error message for valid input, that is a | |
2290 | bug. | |
2291 | ||
2292 | @item | |
2293 | If you are an experienced user of binary utilities, your suggestions for | |
2294 | improvement are welcome in any case. | |
2295 | @end itemize | |
2296 | ||
2297 | @node Bug Reporting | |
2298 | @section How to report bugs | |
2299 | @cindex bug reports | |
2300 | @cindex bugs, reporting | |
2301 | ||
2302 | A number of companies and individuals offer support for @sc{gnu} | |
2303 | products. If you obtained the binary utilities from a support | |
2304 | organization, we recommend you contact that organization first. | |
2305 | ||
2306 | You can find contact information for many support companies and | |
2307 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs | |
2308 | distribution. | |
2309 | ||
2310 | In any event, we also recommend that you send bug reports for the binary | |
2311 | utilities to @samp{bug-gnu-utils@@prep.ai.mit.edu}. | |
2312 | ||
2313 | The fundamental principle of reporting bugs usefully is this: | |
2314 | @strong{report all the facts}. If you are not sure whether to state a | |
2315 | fact or leave it out, state it! | |
2316 | ||
2317 | Often people omit facts because they think they know what causes the | |
2318 | problem and assume that some details do not matter. Thus, you might | |
2319 | assume that the name of a file you use in an example does not matter. | |
2320 | Well, probably it does not, but one cannot be sure. Perhaps the bug is | |
2321 | a stray memory reference which happens to fetch from the location where | |
2322 | that pathname is stored in memory; perhaps, if the pathname were | |
2323 | different, the contents of that location would fool the utility into | |
2324 | doing the right thing despite the bug. Play it safe and give a | |
2325 | specific, complete example. That is the easiest thing for you to do, | |
2326 | and the most helpful. | |
2327 | ||
2328 | Keep in mind that the purpose of a bug report is to enable us to fix the bug if | |
2329 | it is new to us. Therefore, always write your bug reports on the assumption | |
2330 | that the bug has not been reported previously. | |
2331 | ||
2332 | Sometimes people give a few sketchy facts and ask, ``Does this ring a | |
2333 | bell?'' Those bug reports are useless, and we urge everyone to | |
2334 | @emph{refuse to respond to them} except to chide the sender to report | |
2335 | bugs properly. | |
2336 | ||
2337 | To enable us to fix the bug, you should include all these things: | |
2338 | ||
2339 | @itemize @bullet | |
2340 | @item | |
2341 | The version of the utility. Each utility announces it if you start it | |
2342 | with the @samp{--version} argument. | |
2343 | ||
2344 | Without this, we will not know whether there is any point in looking for | |
2345 | the bug in the current version of the binary utilities. | |
2346 | ||
2347 | @item | |
2348 | Any patches you may have applied to the source, including any patches | |
2349 | made to the @code{BFD} library. | |
2350 | ||
2351 | @item | |
2352 | The type of machine you are using, and the operating system name and | |
2353 | version number. | |
2354 | ||
2355 | @item | |
2356 | What compiler (and its version) was used to compile the utilities---e.g. | |
2357 | ``@code{gcc-2.7}''. | |
2358 | ||
2359 | @item | |
2360 | The command arguments you gave the utility to observe the bug. To | |
2361 | guarantee you will not omit something important, list them all. A copy | |
2362 | of the Makefile (or the output from make) is sufficient. | |
2363 | ||
2364 | If we were to try to guess the arguments, we would probably guess wrong | |
2365 | and then we might not encounter the bug. | |
2366 | ||
2367 | @item | |
2368 | A complete input file, or set of input files, that will reproduce the | |
2369 | bug. If the utility is reading an object file or files, then it is | |
2370 | generally most helpful to send the actual object files, uuencoded if | |
2371 | necessary to get them through the mail system. Making them available | |
2372 | for anonymous FTP is not as good, but may be the only reasonable choice | |
2373 | for large object files. | |
2374 | ||
2375 | If the source files were produced exclusively using @sc{gnu} programs | |
2376 | (e.g., @code{gcc}, @code{gas}, and/or the @sc{gnu} @code{ld}), then it | |
2377 | may be OK to send the source files rather than the object files. In | |
2378 | this case, be sure to say exactly what version of @code{gcc}, or | |
2379 | whatever, was used to produce the object files. Also say how | |
2380 | @code{gcc}, or whatever, was configured. | |
2381 | ||
2382 | @item | |
2383 | A description of what behavior you observe that you believe is | |
2384 | incorrect. For example, ``It gets a fatal signal.'' | |
2385 | ||
2386 | Of course, if the bug is that the utility gets a fatal signal, then we | |
2387 | will certainly notice it. But if the bug is incorrect output, we might | |
2388 | not notice unless it is glaringly wrong. You might as well not give us | |
2389 | a chance to make a mistake. | |
2390 | ||
2391 | Even if the problem you experience is a fatal signal, you should still | |
2392 | say so explicitly. Suppose something strange is going on, such as, your | |
2393 | copy of the utility is out of synch, or you have encountered a bug in | |
2394 | the C library on your system. (This has happened!) Your copy might | |
2395 | crash and ours would not. If you told us to expect a crash, then when | |
2396 | ours fails to crash, we would know that the bug was not happening for | |
2397 | us. If you had not told us to expect a crash, then we would not be able | |
2398 | to draw any conclusion from our observations. | |
2399 | ||
2400 | @item | |
2401 | If you wish to suggest changes to the source, send us context diffs, as | |
2402 | generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p} | |
2403 | option. Always send diffs from the old file to the new file. If you | |
2404 | even discuss something in the @code{ld} source, refer to it by context, | |
2405 | not by line number. | |
2406 | ||
2407 | The line numbers in our development sources will not match those in your | |
2408 | sources. Your line numbers would convey no useful information to us. | |
2409 | @end itemize | |
2410 | ||
2411 | Here are some things that are not necessary: | |
2412 | ||
2413 | @itemize @bullet | |
2414 | @item | |
2415 | A description of the envelope of the bug. | |
2416 | ||
2417 | Often people who encounter a bug spend a lot of time investigating | |
2418 | which changes to the input file will make the bug go away and which | |
2419 | changes will not affect it. | |
2420 | ||
2421 | This is often time consuming and not very useful, because the way we | |
2422 | will find the bug is by running a single example under the debugger | |
2423 | with breakpoints, not by pure deduction from a series of examples. | |
2424 | We recommend that you save your time for something else. | |
2425 | ||
2426 | Of course, if you can find a simpler example to report @emph{instead} | |
2427 | of the original one, that is a convenience for us. Errors in the | |
2428 | output will be easier to spot, running under the debugger will take | |
2429 | less time, and so on. | |
2430 | ||
2431 | However, simplification is not vital; if you do not want to do this, | |
2432 | report the bug anyway and send us the entire test case you used. | |
2433 | ||
2434 | @item | |
2435 | A patch for the bug. | |
2436 | ||
2437 | A patch for the bug does help us if it is a good one. But do not omit | |
2438 | the necessary information, such as the test case, on the assumption that | |
2439 | a patch is all we need. We might see problems with your patch and decide | |
2440 | to fix the problem another way, or we might not understand it at all. | |
2441 | ||
2442 | Sometimes with programs as complicated as the binary utilities it is | |
2443 | very hard to construct an example that will make the program follow a | |
2444 | certain path through the code. If you do not send us the example, we | |
2445 | will not be able to construct one, so we will not be able to verify that | |
2446 | the bug is fixed. | |
2447 | ||
2448 | And if we cannot understand what bug you are trying to fix, or why your | |
2449 | patch should be an improvement, we will not install it. A test case will | |
2450 | help us to understand. | |
2451 | ||
2452 | @item | |
2453 | A guess about what the bug is or what it depends on. | |
2454 | ||
2455 | Such guesses are usually wrong. Even we cannot guess right about such | |
2456 | things without first using the debugger to find the facts. | |
2457 | @end itemize | |
2458 | ||
eae04238 | 2459 | @node Index |
c72af735 RP |
2460 | @unnumbered Index |
2461 | ||
2462 | @printindex cp | |
2463 | ||
2464 | @contents | |
2465 | @bye |