]>
Commit | Line | Data |
---|---|---|
765a273f | 1 | \input texinfo @c -*- Texinfo -*- |
c72af735 RP |
2 | @setfilename binutils.info |
3 | ||
9abcc3b8 RP |
4 | @ifinfo |
5 | @format | |
6 | START-INFO-DIR-ENTRY | |
20f774c1 RP |
7 | * Binutils: (binutils). The GNU binary utilities "ar", "objcopy", |
8 | "objdump", "nm", "nlmconv", "size", | |
9 | "strings", "strip", and "ranlib". | |
9abcc3b8 RP |
10 | END-INFO-DIR-ENTRY |
11 | @end format | |
12 | @end ifinfo | |
c72af735 | 13 | |
8b2c2275 | 14 | @ifinfo |
8981cac5 | 15 | Copyright @copyright{} 1991, 1992, 1993, 1994 Free Software Foundation, Inc. |
8b2c2275 RP |
16 | |
17 | Permission is granted to make and distribute verbatim copies of | |
18 | this manual provided the copyright notice and this permission notice | |
19 | are preserved on all copies. | |
20 | ||
21 | @ignore | |
22 | Permission is granted to process this file through TeX and print the | |
23 | results, provided the printed document carries a copying permission | |
24 | notice identical to this one except for the removal of this paragraph | |
25 | (this paragraph not being relevant to the printed manual). | |
26 | ||
27 | @end ignore | |
28 | ||
29 | Permission is granted to copy and distribute modified versions of this | |
30 | manual under the conditions for verbatim copying, provided also that | |
31 | the entire resulting derived work is distributed under the terms of a | |
32 | permission notice identical to this one. | |
33 | ||
34 | Permission is granted to copy and distribute translations of this manual | |
35 | into another language, under the above conditions for modified versions. | |
36 | @end ifinfo | |
37 | ||
c72af735 RP |
38 | @synindex ky cp |
39 | @c | |
df14d957 | 40 | @c This file documents the GNU binary utilities "ar", "ld", "objcopy", |
ba7c8e29 | 41 | @c "objdump", "nm", "size", "strings", "strip", and "ranlib". |
c72af735 | 42 | @c |
e32341a7 | 43 | @c Copyright (C) 1991, 1992, 1993 Free Software Foundation, Inc. |
c72af735 RP |
44 | @c |
45 | @c This text may be freely distributed under the terms of the GNU | |
46 | @c General Public License. | |
47 | @c | |
27e94bd5 | 48 | |
c72af735 RP |
49 | @setchapternewpage odd |
50 | @settitle GNU Binary Utilities | |
4928b97b RP |
51 | @titlepage |
52 | @finalout | |
c72af735 | 53 | @title The GNU Binary Utilities |
b6216af2 | 54 | @subtitle Version 2.2 |
c72af735 | 55 | @sp 1 |
e32341a7 | 56 | @subtitle May 1993 |
c72af735 | 57 | @author Roland H. Pesch |
4961ce5b | 58 | @author Jeffrey M. Osier |
c72af735 RP |
59 | @author Cygnus Support |
60 | @page | |
61 | ||
62 | @tex | |
650a49f0 | 63 | {\parskip=0pt \hfill Cygnus Support\par \hfill |
c72af735 RP |
64 | \TeX{}info \texinfoversion\par } |
65 | @end tex | |
66 | ||
67 | @vskip 0pt plus 1filll | |
8981cac5 | 68 | Copyright @copyright{} 1991, 1992, 1993, 1994 Free Software Foundation, Inc. |
c72af735 RP |
69 | |
70 | Permission is granted to make and distribute verbatim copies of | |
71 | this manual provided the copyright notice and this permission notice | |
72 | are preserved on all copies. | |
73 | ||
74 | Permission is granted to copy and distribute modified versions of this | |
75 | manual under the conditions for verbatim copying, provided also that | |
76 | the entire resulting derived work is distributed under the terms of a | |
77 | permission notice identical to this one. | |
78 | ||
79 | Permission is granted to copy and distribute translations of this manual | |
80 | into another language, under the above conditions for modified versions. | |
81 | @end titlepage | |
82 | ||
eae04238 | 83 | @node Top |
8981cac5 | 84 | @top Introduction |
c72af735 RP |
85 | |
86 | @cindex version | |
87 | This brief manual contains preliminary documentation for the GNU binary | |
b6216af2 | 88 | utilities (collectively version 2.2): |
8b2c2275 RP |
89 | |
90 | @iftex | |
c72af735 RP |
91 | @table @code |
92 | @item ar | |
93 | Create, modify, and extract from archives | |
94 | ||
95 | @item nm | |
96 | List symbols from object files | |
97 | ||
eed5eeab DM |
98 | @item objcopy |
99 | Copy and translate object files | |
100 | ||
c72af735 RP |
101 | @item objdump |
102 | Display information from object files | |
103 | ||
104 | @item ranlib | |
105 | Generate index to archive contents | |
106 | ||
107 | @item size | |
eae04238 | 108 | List file section sizes and total size |
c72af735 | 109 | |
ba7c8e29 DM |
110 | @item strings |
111 | List printable strings from files | |
112 | ||
c72af735 RP |
113 | @item strip |
114 | Discard symbols | |
eae04238 DM |
115 | |
116 | @item c++filt | |
117 | Demangle encoded C++ symbols | |
118 | ||
119 | @item nlmconv | |
120 | Convert object code into a Netware Loadable Module | |
c72af735 | 121 | @end table |
8b2c2275 | 122 | @end iftex |
c72af735 RP |
123 | |
124 | @menu | |
8b2c2275 | 125 | * ar:: Create, modify, and extract from archives |
8b2c2275 | 126 | * nm:: List symbols from object files |
eed5eeab | 127 | * objcopy:: Copy and translate object files |
8b2c2275 RP |
128 | * objdump:: Display information from object files |
129 | * ranlib:: Generate index to archive contents | |
130 | * size:: List section sizes and total size | |
ba7c8e29 | 131 | * strings:: List printable strings from files |
8b2c2275 | 132 | * strip:: Discard symbols |
b6216af2 | 133 | * c++filt:: Filter to demangle encoded C++ symbols |
94e9ad77 | 134 | * nlmconv:: Converts object code into an NLM |
eae04238 | 135 | * Selecting The Target System:: How these utilities determine the target. |
8b2c2275 | 136 | * Index:: |
c72af735 RP |
137 | @end menu |
138 | ||
eae04238 | 139 | @node ar |
c72af735 RP |
140 | @chapter ar |
141 | ||
142 | @kindex ar | |
143 | @cindex archives | |
144 | @cindex collections of files | |
145 | @smallexample | |
650a49f0 | 146 | ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}] |
4d9b5d5a | 147 | ar -M [ <mri-script ] |
c72af735 RP |
148 | @end smallexample |
149 | ||
150 | The GNU @code{ar} program creates, modifies, and extracts from | |
151 | archives. An @dfn{archive} is a single file holding a collection of | |
152 | other files in a structure that makes it possible to retrieve | |
153 | the original individual files (called @dfn{members} of the archive). | |
154 | ||
155 | The original files' contents, mode (permissions), timestamp, owner, and | |
ec40bbb8 | 156 | group are preserved in the archive, and can be restored on |
c72af735 RP |
157 | extraction. |
158 | ||
159 | @cindex name length | |
160 | GNU @code{ar} can maintain archives whose members have names of any | |
161 | length; however, depending on how @code{ar} is configured on your | |
ec40bbb8 DM |
162 | system, a limit on member-name length may be imposed for compatibility |
163 | with archive formats maintained with other tools. If it exists, the | |
c72af735 RP |
164 | limit is often 15 characters (typical of formats related to a.out) or 16 |
165 | characters (typical of formats related to coff). | |
166 | ||
167 | @cindex libraries | |
168 | @code{ar} is considered a binary utility because archives of this sort | |
169 | are most often used as @dfn{libraries} holding commonly needed | |
170 | subroutines. | |
171 | ||
172 | @cindex symbol index | |
e31e9a8d | 173 | @code{ar} creates an index to the symbols defined in relocatable |
c72af735 RP |
174 | object modules in the archive when you specify the modifier @samp{s}. |
175 | Once created, this index is updated in the archive whenever @code{ar} | |
176 | makes a change to its contents (save for the @samp{q} update operation). | |
177 | An archive with such an index speeds up linking to the library, and | |
178 | allows routines in the library to call each other without regard to | |
179 | their placement in the archive. | |
180 | ||
918c2f61 | 181 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index |
c72af735 RP |
182 | table. If an archive lacks the table, another form of @code{ar} called |
183 | @code{ranlib} can be used to add just the table. | |
184 | ||
765a273f RP |
185 | @cindex compatibility, @code{ar} |
186 | @cindex @code{ar} compatibility | |
187 | GNU @code{ar} is designed to be compatible with two different | |
188 | facilities. You can control its activity using command-line options, | |
189 | like the different varieties of @code{ar} on Unix systems; or, if you | |
190 | specify the single command-line option @samp{-M}, you can control it | |
191 | with a script supplied via standard input, like the MRI ``librarian'' | |
192 | program. | |
193 | ||
194 | @menu | |
eae04238 DM |
195 | * ar cmdline:: Controlling @code{ar} on the command line |
196 | * ar scripts:: Controlling @code{ar} with a script | |
765a273f RP |
197 | @end menu |
198 | ||
199 | @page | |
eae04238 | 200 | @node ar cmdline |
765a273f RP |
201 | @section Controlling @code{ar} on the command line |
202 | ||
203 | @smallexample | |
650a49f0 | 204 | ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}] |
765a273f RP |
205 | @end smallexample |
206 | ||
207 | @cindex Unix compatibility, @code{ar} | |
208 | When you use @code{ar} in the Unix style, @code{ar} insists on at least two | |
209 | arguments to execute: one keyletter specifying the @emph{operation} | |
210 | (optionally accompanied by other keyletters specifying | |
211 | @emph{modifiers}), and the archive name to act on. | |
c72af735 | 212 | |
650a49f0 | 213 | Most operations can also accept further @var{member} arguments, |
c72af735 RP |
214 | specifying particular files to operate on. |
215 | ||
216 | GNU @code{ar} allows you to mix the operation code @var{p} and modifier | |
217 | flags @var{mod} in any order, within the first command-line argument. | |
218 | ||
219 | If you wish, you may begin the first command-line argument with a | |
220 | dash. | |
221 | ||
222 | @cindex operations on archive | |
223 | The @var{p} keyletter specifies what operation to execute; it may be | |
224 | any of the following, but you must specify only one of them: | |
225 | ||
226 | @table @code | |
227 | @item d | |
228 | @cindex deleting from archive | |
229 | @emph{Delete} modules from the archive. Specify the names of modules to | |
650a49f0 | 230 | be deleted as @var{member}@dots{}; the archive is untouched if you |
c72af735 RP |
231 | specify no files to delete. |
232 | ||
e31e9a8d | 233 | If you specify the @samp{v} modifier, @code{ar} lists each module |
c72af735 RP |
234 | as it is deleted. |
235 | ||
236 | @item m | |
237 | @cindex moving in archive | |
238 | Use this operation to @emph{move} members in an archive. | |
239 | ||
240 | The ordering of members in an archive can make a difference in how | |
241 | programs are linked using the library, if a symbol is defined in more | |
242 | than one member. | |
243 | ||
244 | If no modifiers are used with @code{m}, any members you name in the | |
650a49f0 | 245 | @var{member} arguments are moved to the @emph{end} of the archive; |
c72af735 RP |
246 | you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a |
247 | specified place instead. | |
248 | ||
249 | @item p | |
250 | @cindex printing from archive | |
251 | @emph{Print} the specified members of the archive, to the standard | |
252 | output file. If the @samp{v} modifier is specified, show the member | |
253 | name before copying its contents to standard output. | |
254 | ||
650a49f0 | 255 | If you specify no @var{member} arguments, all the files in the archive are |
ec40bbb8 | 256 | printed. |
c72af735 RP |
257 | |
258 | @item q | |
259 | @cindex quick append to archive | |
650a49f0 | 260 | @emph{Quick append}; add the files @var{member}@dots{} to the end of |
ec40bbb8 | 261 | @var{archive}, without checking for replacement. |
c72af735 RP |
262 | |
263 | The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this | |
264 | operation; new members are always placed at the end of the archive. | |
265 | ||
266 | The modifier @samp{v} makes @code{ar} list each file as it is appended. | |
267 | ||
268 | Since the point of this operation is speed, the archive's symbol table | |
269 | index is not updated, even if it already existed; you can use @samp{ar s} or | |
270 | @code{ranlib} explicitly to update the symbol table index. | |
271 | ||
272 | @item r | |
273 | @cindex replacement in archive | |
650a49f0 | 274 | Insert the files @var{member}@dots{} into @var{archive} (with |
ec40bbb8 DM |
275 | @emph{replacement}). This operation differs from @samp{q} in that any |
276 | previously existing members are deleted if their names match those being | |
277 | added. | |
c72af735 | 278 | |
650a49f0 | 279 | If one of the files named in @var{member}@dots{} does not exist, @code{ar} |
c72af735 RP |
280 | displays an error message, and leaves undisturbed any existing members |
281 | of the archive matching that name. | |
282 | ||
283 | By default, new members are added at the end of the file; but you may | |
284 | use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request | |
285 | placement relative to some existing member. | |
286 | ||
287 | The modifier @samp{v} used with this operation elicits a line of | |
288 | output for each file inserted, along with one of the letters @samp{a} or | |
289 | @samp{r} to indicate whether the file was appended (no old member | |
290 | deleted) or replaced. | |
291 | ||
292 | @item t | |
293 | @cindex contents of archive | |
294 | Display a @emph{table} listing the contents of @var{archive}, or those | |
650a49f0 | 295 | of the files listed in @var{member}@dots{} that are present in the |
c72af735 RP |
296 | archive. Normally only the member name is shown; if you also want to |
297 | see the modes (permissions), timestamp, owner, group, and size, you can | |
298 | request that by also specifying the @samp{v} modifier. | |
299 | ||
650a49f0 | 300 | If you do not specify a @var{member}, all files in the archive |
c72af735 RP |
301 | are listed. |
302 | ||
303 | @cindex repeated names in archive | |
304 | @cindex name duplication in archive | |
305 | If there is more than one file with the same name (say, @samp{fie}) in | |
e31e9a8d | 306 | an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the |
c72af735 RP |
307 | first instance; to see them all, you must ask for a complete |
308 | listing---in our example, @samp{ar t b.a}. | |
309 | @c WRS only; per Gumby, this is implementation-dependent, and in a more | |
310 | @c recent case in fact works the other way. | |
311 | ||
312 | @item x | |
313 | @cindex extract from archive | |
650a49f0 | 314 | @emph{Extract} members (named @var{member}) from the archive. You can |
c72af735 RP |
315 | use the @samp{v} modifier with this operation, to request that |
316 | @code{ar} list each name as it extracts it. | |
317 | ||
650a49f0 | 318 | If you do not specify a @var{member}, all files in the archive |
c72af735 RP |
319 | are extracted. |
320 | ||
321 | @end table | |
322 | ||
323 | A number of modifiers (@var{mod}) may immediately follow the @var{p} | |
324 | keyletter, to specify variations on an operation's behavior: | |
325 | ||
326 | @table @code | |
327 | @item a | |
328 | @cindex relative placement in archive | |
329 | Add new files @emph{after} an existing member of the | |
ec40bbb8 | 330 | archive. If you use the modifier @samp{a}, the name of an existing archive |
650a49f0 | 331 | member must be present as the @var{relpos} argument, before the |
c72af735 RP |
332 | @var{archive} specification. |
333 | ||
334 | @item b | |
335 | Add new files @emph{before} an existing member of the | |
ec40bbb8 | 336 | archive. If you use the modifier @samp{b}, the name of an existing archive |
650a49f0 | 337 | member must be present as the @var{relpos} argument, before the |
c72af735 RP |
338 | @var{archive} specification. (same as @samp{i}). |
339 | ||
340 | @item c | |
341 | @cindex creating archives | |
342 | @emph{Create} the archive. The specified @var{archive} is always | |
650a49f0 | 343 | created if it did not exist, when you request an update. But a warning is |
c72af735 RP |
344 | issued unless you specify in advance that you expect to create it, by |
345 | using this modifier. | |
346 | ||
347 | @item i | |
348 | Insert new files @emph{before} an existing member of the | |
ec40bbb8 | 349 | archive. If you use the modifier @samp{i}, 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{b}). |
352 | ||
353 | @item l | |
354 | This modifier is accepted but not used. | |
355 | @c whaffor ar l modifier??? presumably compat; with | |
356 | @c what???---pesch@@cygnus.com, 25jan91 | |
357 | ||
358 | @item o | |
359 | @cindex dates in archive | |
360 | Preserve the @emph{original} dates of members when extracting them. If | |
361 | you do not specify this modifier, files extracted from the archive | |
e31e9a8d | 362 | are stamped with the time of extraction. |
c72af735 RP |
363 | |
364 | @item s | |
365 | @cindex writing archive index | |
366 | Write an object-file index into the archive, or update an existing one, | |
367 | even if no other change is made to the archive. You may use this modifier | |
368 | flag either with any operation, or alone. Running @samp{ar s} on an | |
369 | archive is equivalent to running @samp{ranlib} on it. | |
370 | ||
371 | @item u | |
372 | @cindex updating an archive | |
b703c078 | 373 | Normally, @samp{ar r}@dots{} inserts all files |
c72af735 RP |
374 | listed into the archive. If you would like to insert @emph{only} those |
375 | of the files you list that are newer than existing members of the same | |
376 | names, use this modifier. The @samp{u} modifier is allowed only for the | |
377 | operation @samp{r} (replace). In particular, the combination @samp{qu} is | |
378 | not allowed, since checking the timestamps would lose any speed | |
379 | advantage from the operation @samp{q}. | |
380 | ||
381 | @item v | |
382 | This modifier requests the @emph{verbose} version of an operation. Many | |
383 | operations display additional information, such as filenames processed, | |
384 | when the modifier @samp{v} is appended. | |
4d9b5d5a DM |
385 | |
386 | @item V | |
387 | This modifier shows the version number of @code{ar}. | |
765a273f RP |
388 | @end table |
389 | ||
eae04238 | 390 | @node ar scripts |
765a273f RP |
391 | @section Controlling @code{ar} with a script |
392 | ||
393 | @smallexample | |
394 | ar -M [ <@var{script} ] | |
395 | @end smallexample | |
396 | ||
397 | @cindex MRI compatibility, @code{ar} | |
398 | @cindex scripts, @code{ar} | |
399 | If you use the single command-line option @samp{-M} with @code{ar}, you | |
400 | can control its operation with a rudimentary command language. This | |
e31e9a8d | 401 | form of @code{ar} operates interactively if standard input is coming |
765a273f RP |
402 | directly from a terminal. During interactive use, @code{ar} prompts for |
403 | input (the prompt is @samp{AR >}), and continues executing even after | |
404 | errors. If you redirect standard input to a script file, no prompts are | |
e31e9a8d | 405 | issued, and @code{ar} abandons execution (with a nonzero exit code) |
765a273f RP |
406 | on any error. |
407 | ||
408 | The @code{ar} command language is @emph{not} designed to be equivalent | |
409 | to the command-line options; in fact, it provides somewhat less control | |
410 | over archives. The only purpose of the command language is to ease the | |
411 | transition to GNU @code{ar} for developers who already have scripts | |
412 | written for the MRI ``librarian'' program. | |
413 | ||
414 | The syntax for the @code{ar} command language is straightforward: | |
415 | @itemize @bullet | |
416 | @item | |
417 | commands are recognized in upper or lower case; for example, @code{LIST} | |
418 | is the same as @code{list}. In the following descriptions, commands are | |
419 | shown in upper case for clarity. | |
420 | ||
421 | @item | |
422 | a single command may appear on each line; it is the first word on the | |
423 | line. | |
424 | ||
425 | @item | |
426 | empty lines are allowed, and have no effect. | |
427 | ||
428 | @item | |
429 | comments are allowed; text after either of the characters @samp{*} | |
430 | or @samp{;} is ignored. | |
431 | ||
432 | @item | |
433 | Whenever you use a list of names as part of the argument to an @code{ar} | |
434 | command, you can separate the individual names with either commas or | |
435 | blanks. Commas are shown in the explanations below, for clarity. | |
436 | ||
437 | @item | |
438 | @samp{+} is used as a line continuation character; if @samp{+} appears | |
439 | at the end of a line, the text on the following line is considered part | |
440 | of the current command. | |
441 | @end itemize | |
442 | ||
443 | Here are the commands you can use in @code{ar} scripts, or when using | |
444 | @code{ar} interactively. Three of them have special significance: | |
445 | ||
446 | @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is | |
447 | a temporary file required for most of the other commands. | |
448 | ||
449 | @code{SAVE} commits the changes so far specified by the script. Prior | |
450 | to @code{SAVE}, commands affect only the temporary copy of the current | |
451 | archive. | |
452 | ||
453 | @table @code | |
454 | @item ADDLIB @var{archive} | |
455 | @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module}) | |
456 | Add all the contents of @var{archive} (or, if specified, each named | |
457 | @var{module} from @var{archive}) to the current archive. | |
458 | ||
459 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
460 | ||
650a49f0 | 461 | @item ADDMOD @var{member}, @var{member}, @dots{} @var{member} |
765a273f RP |
462 | @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}" |
463 | @c else like "ar q..." | |
650a49f0 | 464 | Add each named @var{member} as a module in the current archive. |
765a273f RP |
465 | |
466 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
467 | ||
468 | @item CLEAR | |
469 | Discard the contents of the current archive, cancelling the effect of | |
470 | any operations since the last @code{SAVE}. May be executed (with no | |
471 | effect) even if no current archive is specified. | |
472 | ||
473 | @item CREATE @var{archive} | |
474 | Creates an archive, and makes it the current archive (required for many | |
475 | other commands). The new archive is created with a temporary name; it | |
476 | is not actually saved as @var{archive} until you use @code{SAVE}. | |
477 | You can overwrite existing archives; similarly, the contents of any | |
478 | existing file named @var{archive} will not be destroyed until @code{SAVE}. | |
479 | ||
480 | @item DELETE @var{module}, @var{module}, @dots{} @var{module} | |
481 | Delete each listed @var{module} from the current archive; equivalent to | |
482 | @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}. | |
483 | ||
484 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
485 | ||
486 | @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) | |
487 | @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile} | |
488 | List each named @var{module} present in @var{archive}. The separate | |
489 | command @code{VERBOSE} specifies the form of the output: when verbose | |
490 | output is off, output is like that of @samp{ar -t @var{archive} | |
b703c078 DM |
491 | @var{module}@dots{}}. When verbose output is on, the listing is like |
492 | @samp{ar -tv @var{archive} @var{module}@dots{}}. | |
765a273f RP |
493 | |
494 | Output normally goes to the standard output stream; however, if you | |
495 | specify @var{outputfile} as a final argument, @code{ar} directs the | |
496 | output to that file. | |
497 | ||
498 | @item END | |
499 | Exit from @code{ar}, with a @code{0} exit code to indicate successful | |
500 | completion. This command does not save the output file; if you have | |
501 | changed the current archive since the last @code{SAVE} command, those | |
502 | changes are lost. | |
503 | ||
504 | @item EXTRACT @var{module}, @var{module}, @dots{} @var{module} | |
505 | Extract each named @var{module} from the current archive, writing them | |
506 | into the current directory as separate files. Equivalent to @samp{ar -x | |
b703c078 | 507 | @var{archive} @var{module}@dots{}}. |
765a273f RP |
508 | |
509 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
510 | ||
511 | @ignore | |
512 | @c FIXME Tokens but no commands??? | |
513 | @item FULLDIR | |
514 | ||
515 | @item HELP | |
516 | @end ignore | |
517 | ||
518 | @item LIST | |
519 | Display full contents of the current archive, in ``verbose'' style | |
520 | regardless of the state of @code{VERBOSE}. The effect is like @samp{ar | |
521 | tv @var{archive}}). (This single command is a GNU @code{ld} | |
522 | enhancement, rather than present for MRI compatibility.) | |
523 | ||
524 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
525 | ||
526 | @item OPEN @var{archive} | |
527 | Opens an existing archive for use as the current archive (required for | |
528 | many other commands). Any changes as the result of subsequent commands | |
529 | will not actually affect @var{archive} until you next use @code{SAVE}. | |
530 | ||
531 | @item REPLACE @var{module}, @var{module}, @dots{} @var{module} | |
532 | In the current archive, replace each existing @var{module} (named in | |
533 | the @code{REPLACE} arguments) from files in the current working directory. | |
534 | To execute this command without errors, both the file, and the module in | |
535 | the current archive, must exist. | |
536 | ||
537 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
538 | ||
539 | @item VERBOSE | |
540 | Toggle an internal flag governing the output from @code{DIRECTORY}. | |
541 | When the flag is on, @code{DIRECTORY} output matches output from | |
b703c078 | 542 | @samp{ar -tv }@dots{}. |
765a273f RP |
543 | |
544 | @item SAVE | |
545 | Commit your changes to the current archive, and actually save it as a | |
546 | file with the name specified in the last @code{CREATE} or @code{OPEN} | |
547 | command. | |
548 | ||
549 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
c72af735 RP |
550 | |
551 | @end table | |
552 | ||
8b2c2275 RP |
553 | @iftex |
554 | @node ld | |
c72af735 RP |
555 | @chapter ld |
556 | @cindex linker | |
557 | @kindex ld | |
558 | The GNU linker @code{ld} is now described in a separate manual. | |
27e94bd5 | 559 | @xref{Top,, Overview,, Using LD: the GNU linker}. |
8b2c2275 | 560 | @end iftex |
c72af735 | 561 | |
eae04238 | 562 | @node nm |
c72af735 RP |
563 | @chapter nm |
564 | @cindex symbols | |
565 | @kindex nm | |
566 | ||
567 | @smallexample | |
d6a4c375 | 568 | nm [ -a | --debug-syms ] [ -g | --extern-only ] |
de3b08ac | 569 | [ -B ] [ -C | --demangle ] [ -D | --dynamic ] |
1896790e | 570 | [ -s | --print-armap ] [ -A | -o | --print-file-name ] |
6cfbdb50 | 571 | [ -n | -v | --numeric-sort ] [ -p | --no-sort ] |
1896790e | 572 | [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ] |
6cfbdb50 DM |
573 | [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ] |
574 | [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ] | |
9eb39bca | 575 | [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ] |
c72af735 RP |
576 | @end smallexample |
577 | ||
b703c078 | 578 | GNU @code{nm} lists the symbols from object files @var{objfile}@dots{}. |
6cfbdb50 DM |
579 | If no object files are listed as arguments, @code{nm} assumes |
580 | @file{a.out}. | |
581 | ||
582 | For each symbol, @code{nm} shows: | |
583 | ||
584 | @itemize @bullet | |
585 | @item | |
586 | The symbol value, in the radix selected by options (see below), or | |
587 | hexadecimal by default. | |
588 | ||
589 | @item | |
590 | The symbol type. At least the following types are used; others are, as | |
591 | well, depending on the object file format. If lowercase, the symbol is | |
592 | local; if uppercase, the symbol is global (external). | |
593 | ||
594 | @c Some more detail on exactly what these symbol types are used for | |
595 | @c would be nice. | |
596 | @table @code | |
597 | @item A | |
598 | Absolute. | |
599 | ||
600 | @item B | |
601 | BSS (uninitialized data). | |
602 | ||
603 | @item C | |
604 | Common. | |
605 | ||
606 | @item D | |
607 | Initialized data. | |
608 | ||
609 | @item I | |
610 | Indirect reference. | |
611 | ||
612 | @item T | |
613 | Text (program code). | |
614 | ||
615 | @item U | |
616 | Undefined. | |
617 | @end table | |
618 | ||
619 | @item | |
620 | The symbol name. | |
621 | @end itemize | |
c72af735 RP |
622 | |
623 | The long and short forms of options, shown here as alternatives, are | |
624 | equivalent. | |
625 | ||
626 | @table @code | |
6cfbdb50 DM |
627 | @item -A |
628 | @itemx -o | |
629 | @itemx --print-file-name | |
630 | @cindex input file name | |
631 | @cindex file name | |
632 | @cindex source file name | |
633 | Precede each symbol by the name of the input file (or archive element) | |
634 | in which it was found, rather than identifying the input file once only, | |
635 | before all of its symbols. | |
c72af735 RP |
636 | |
637 | @item -a | |
918c2f61 | 638 | @itemx --debug-syms |
c72af735 | 639 | @cindex debugging symbols |
6cfbdb50 DM |
640 | Display all symbols, even debugger-only symbols; normally these are not |
641 | listed. | |
642 | ||
68dd5295 DM |
643 | @item -B |
644 | @cindex @code{nm} format | |
645 | @cindex @code{nm} compatibility | |
d6a4c375 DM |
646 | The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}). |
647 | ||
648 | @item -C | |
649 | @itemx --demangle | |
650 | @cindex demangling C++ symbols | |
651 | Decode (@dfn{demangle}) low-level symbol names into user-level names. | |
652 | Besides removing any initial underscore prepended by the system, this | |
653 | makes C++ function names readable. @xref{c++filt}, for more information | |
654 | on demangling. | |
68dd5295 | 655 | |
9eb39bca ILT |
656 | @item --no-demangle |
657 | Do not demangle low-level symbol names. This is the default. | |
658 | ||
de3b08ac ILT |
659 | @item -D |
660 | @itemx --dynamic | |
661 | @cindex dynamic symbols | |
662 | Display the dynamic symbols rather than the normal symbols. This is | |
663 | only meaningful for dynamic objects, such as certain types of shared | |
664 | libraries. | |
665 | ||
6cfbdb50 DM |
666 | @item -f @var{format} |
667 | @itemx --format=@var{format} | |
68dd5295 DM |
668 | @cindex @code{nm} format |
669 | @cindex @code{nm} compatibility | |
6cfbdb50 DM |
670 | Use the output format @var{format}, which can be @code{bsd}, |
671 | @code{sysv}, or @code{posix}. The default is @code{bsd}. | |
b26ac613 | 672 | Only the first character of @var{format} is significant; it can be |
6cfbdb50 | 673 | either upper or lower case. |
c72af735 RP |
674 | |
675 | @item -g | |
918c2f61 | 676 | @itemx --extern-only |
c72af735 RP |
677 | @cindex external symbols |
678 | Display only external symbols. | |
679 | ||
b26ac613 DM |
680 | @item -n |
681 | @itemx -v | |
682 | @itemx --numeric-sort | |
683 | Sort symbols numerically by their addresses, rather than alphabetically | |
684 | by their names. | |
685 | ||
c72af735 | 686 | @item -p |
918c2f61 | 687 | @itemx --no-sort |
c72af735 | 688 | @cindex sorting symbols |
650a49f0 | 689 | Do not bother to sort the symbols in any order; print them in the order |
6cfbdb50 DM |
690 | encountered. |
691 | ||
692 | @item -P | |
693 | @itemx --portability | |
694 | Use the POSIX.2 standard output format instead of the default format. | |
695 | Equivalent to @samp{-f posix}. | |
c72af735 | 696 | |
c72af735 | 697 | @item -s |
918c2f61 | 698 | @itemx --print-armap |
c72af735 RP |
699 | @cindex symbol index, listing |
700 | When listing symbols from archive members, include the index: a mapping | |
ec40bbb8 DM |
701 | (stored in the archive by @code{ar} or @code{ranlib}) of which modules |
702 | contain definitions for which names. | |
c72af735 | 703 | |
c72af735 | 704 | @item -r |
918c2f61 | 705 | @itemx --reverse-sort |
ec40bbb8 | 706 | Reverse the order of the sort (whether numeric or alphabetic); let the |
c72af735 RP |
707 | last come first. |
708 | ||
1896790e ILT |
709 | @item --size-sort |
710 | Sort symbols by size. The size is computed as the difference between | |
711 | the value of the symbol and the value of the symbol with the next higher | |
712 | value. The size of the symbol is printed, rather than the value. | |
713 | ||
6cfbdb50 DM |
714 | @item -t @var{radix} |
715 | @itemx --radix=@var{radix} | |
716 | Use @var{radix} as the radix for printing the symbol values. It must be | |
717 | @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal. | |
718 | ||
ec40bbb8 | 719 | @item --target=@var{bfdname} |
c72af735 RP |
720 | @cindex object code format |
721 | Specify an object code format other than your system's default format. | |
eae04238 | 722 | @xref{Target Selection}, for more information. |
c72af735 RP |
723 | |
724 | @item -u | |
918c2f61 | 725 | @itemx --undefined-only |
c72af735 RP |
726 | @cindex external symbols |
727 | @cindex undefined symbols | |
728 | Display only undefined symbols (those external to each object file). | |
729 | ||
6cfbdb50 DM |
730 | @item -V |
731 | @itemx --version | |
b26ac613 DM |
732 | Show the version number of @code{nm} and exit. |
733 | ||
734 | @item --help | |
735 | Show a summary of the options to @code{nm} and exit. | |
c72af735 RP |
736 | @end table |
737 | ||
eae04238 | 738 | @node objcopy |
eed5eeab DM |
739 | @chapter objcopy |
740 | ||
741 | @smallexample | |
eae04238 DM |
742 | objcopy [ -F @var{bfdname} | --target=@var{bfdname} ] |
743 | [ -I @var{bfdname} | --input-target=@var{bfdname} ] | |
744 | [ -O @var{bfdname} | --output-target=@var{bfdname} ] | |
eed5eeab | 745 | [ -S | --strip-all ] [ -g | --strip-debug ] |
29c0d15c | 746 | [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ] |
eed5eeab | 747 | [ -x | --discard-all ] [ -X | --discard-locals ] |
f7b839f7 DM |
748 | [ -b @var{byte} | --byte=@var{byte} ] |
749 | [ -i @var{interleave} | --interleave=@var{interleave} ] | |
0aca460e | 750 | [ -R @var{sectionname} | --remove-section=@var{sectionname} ] |
33e0a06d ILT |
751 | [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ] |
752 | [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ] | |
753 | [ --adjust-vma=@var{incr} ] | |
6c7ed084 ILT |
754 | [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ] |
755 | [ --adjust-warnings ] [ --no-adjust-warnings ] | |
f7b839f7 | 756 | [ -v | --verbose ] [ -V | --version ] [ --help ] |
eed5eeab DM |
757 | @var{infile} [@var{outfile}] |
758 | @end smallexample | |
759 | ||
8981cac5 JO |
760 | The @sc{gnu} @code{objcopy} utility copies the contents of an object |
761 | file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to | |
762 | read and write the object files. It can write the destination object | |
763 | file in a format different from that of the source object file. The | |
764 | exact behavior of @code{objcopy} is controlled by command-line options. | |
eed5eeab DM |
765 | |
766 | @code{objcopy} creates temporary files to do its translations and | |
8981cac5 JO |
767 | deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its |
768 | translation work; it has access to all the formats described in @sc{bfd} | |
769 | and thus is able to recognize most formats without being told | |
770 | explicitly. @xref{BFD,,BFD,ld.info,Using LD}. | |
eed5eeab | 771 | |
67f67ed9 ILT |
772 | @code{objcopy} can be used to generate S-records by using an output |
773 | target of @samp{srec} (e.g., use @samp{-O srec}). | |
774 | ||
775 | @code{objcopy} can be used to generate a raw binary file by using an | |
776 | output target of @samp{binary} (e.g., use @samp{-O binary}). When | |
777 | @code{objcopy} generates a raw binary file, it will essentially produce | |
778 | a memory dump of the contents of the input object file. All symbols and | |
a6afc090 ILT |
779 | relocation information will be discarded. The memory dump will start at |
780 | the virtual address of the lowest section copied into the output file. | |
67f67ed9 ILT |
781 | |
782 | When generating an S-record or a raw binary file, it may be helpful to | |
783 | use @samp{-S} to remove sections containing debugging information. In | |
784 | some cases @samp{-R} will be useful to remove sections which contain | |
785 | information which is not needed by the binary file. | |
786 | ||
eed5eeab DM |
787 | @table @code |
788 | @item @var{infile} | |
789 | @itemx @var{outfile} | |
8981cac5 | 790 | The source and output files, respectively. |
eed5eeab DM |
791 | If you do not specify @var{outfile}, @code{objcopy} creates a |
792 | temporary file and destructively renames the result with | |
8981cac5 | 793 | the name of @var{infile}. |
eed5eeab | 794 | |
eae04238 DM |
795 | @item -I @var{bfdname} |
796 | @itemx --input-target=@var{bfdname} | |
797 | Consider the source file's object format to be @var{bfdname}, rather than | |
798 | attempting to deduce it. @xref{Target Selection}, for more information. | |
eed5eeab | 799 | |
eae04238 DM |
800 | @item -O @var{bfdname} |
801 | @itemx --output-target=@var{bfdname} | |
802 | Write the output file using the object format @var{bfdname}. | |
803 | @xref{Target Selection}, for more information. | |
eed5eeab | 804 | |
eae04238 DM |
805 | @item -F @var{bfdname} |
806 | @itemx --target=@var{bfdname} | |
807 | Use @var{bfdname} as the object format for both the input and the output | |
808 | file; i.e., simply transfer data from source to destination with no | |
809 | translation. @xref{Target Selection}, for more information. | |
eed5eeab | 810 | |
0aca460e ILT |
811 | @item -R @var{sectionname} |
812 | @itemx --remove-section=@var{sectionname} | |
813 | Remove any section named @var{sectionname} from the output file. This | |
814 | option may be given more than once. Note that using this option | |
815 | inappropriately may make the output file unusable. | |
816 | ||
eed5eeab DM |
817 | @item -S |
818 | @itemx --strip-all | |
819 | Do not copy relocation and symbol information from the source file. | |
820 | ||
821 | @item -g | |
822 | @itemx --strip-debug | |
823 | Do not copy debugging symbols from the source file. | |
824 | ||
29c0d15c ILT |
825 | @item -N @var{symbolname} |
826 | @itemx --strip-symbol=@var{symbolname} | |
827 | Do not copy symbol @var{symbolname} from the source file. This option | |
828 | may be given more than once, and may be combined with other strip | |
829 | options. | |
830 | ||
eed5eeab DM |
831 | @item -x |
832 | @itemx --discard-all | |
833 | Do not copy non-global symbols from the source file. | |
834 | @c FIXME any reason to prefer "non-global" to "local" here? | |
835 | ||
836 | @item -X | |
837 | @itemx --discard-locals | |
838 | Do not copy compiler-generated local symbols. | |
839 | (These usually start with @samp{L} or @samp{.}.) | |
840 | ||
db2e6adb DM |
841 | @item -b @var{byte} |
842 | @itemx --byte=@var{byte} | |
843 | Keep only every @var{byte}th byte of the input file (header data is not | |
f7b839f7 DM |
844 | affected). @var{byte} can be in the range from 0 to @var{interleave}-1, |
845 | where @var{interleave} is given by the @samp{-i} or @samp{--interleave} | |
846 | option, or the default of 4. This option is useful for creating files | |
8981cac5 | 847 | to program @sc{rom}. It is typically used with an @code{srec} output |
f7b839f7 DM |
848 | target. |
849 | ||
850 | @item -i @var{interleave} | |
851 | @itemx --interleave=@var{interleave} | |
8981cac5 JO |
852 | Only copy one out of every @var{interleave} bytes. Select which byte to |
853 | copy with the @var{-b} or @samp{--byte} option. The default is 4. | |
854 | @code{objcopy} ignores this option if you do not specify either @samp{-b} or | |
855 | @samp{--byte}. | |
db2e6adb | 856 | |
596d99ba ILT |
857 | @item --gap-fill @var{val} |
858 | Fill gaps between sections with @var{val}. This is done by increasing | |
859 | the size of the section with the lower address, and filling in the extra | |
860 | space created with @var{val}. | |
861 | ||
33e0a06d ILT |
862 | @item --pad-to @var{address} |
863 | Pad the output file up to the virtual address @var{address}. This is | |
864 | done by increasing the size of the last section. The extra space is | |
865 | filled in with the value specified by @samp{--gap-fill} (default zero). | |
866 | ||
6c7ed084 ILT |
867 | @item --set-start @var{val} |
868 | Set the address of the new file to @var{val}. Not all object file | |
a6afc090 | 869 | formats support setting the start address. |
6c7ed084 ILT |
870 | |
871 | @item --adjust-start @var{incr} | |
872 | Adjust the start address by adding @var{incr}. Not all object file | |
873 | formats support setting the start address. | |
874 | ||
875 | @item --adjust-vma @var{incr} | |
876 | Adjust the address of all sections, as well as the start address, by | |
877 | adding @var{incr}. Some object file formats do not permit section | |
878 | addresses to be changed arbitrarily. Note that this does not relocate | |
879 | the sections; if the program expects sections to be loaded at a certain | |
880 | address, and this option is used to change the sections such that they | |
881 | are loaded at a different address, the program may fail. | |
882 | ||
883 | @item --adjust-section-vma @var{section}@{=,+,-@}@var{val} | |
884 | Set or adjust the address of the named @var{section}. If @samp{=} is | |
885 | used, the section address is set to @var{val}. Otherwise, @var{val} is | |
886 | added to or subtracted from the section address. See the comments under | |
887 | @samp{--adjust-vma}, above. If @var{section} does not exist in the | |
888 | input file, a warning will be issued, unless @samp{--no-adjust-warnings} | |
889 | is used. | |
890 | ||
891 | @item --adjust-warnings | |
892 | If @samp{--adjust-section-vma} is used, and the named section does not | |
893 | exist, issue a warning. This is the default. | |
894 | ||
895 | @item --no-adjust-warnings | |
896 | Do not issue a warning if @samp{--adjust-section-vma} is used, even if | |
897 | the named section does not exist. | |
898 | ||
eed5eeab DM |
899 | @item -V |
900 | @itemx --version | |
901 | Show the version number of @code{objcopy}. | |
902 | ||
903 | @item -v | |
904 | @itemx --verbose | |
905 | Verbose output: list all object files modified. In the case of | |
906 | archives, @samp{objcopy -V} lists all members of the archive. | |
907 | ||
908 | @item --help | |
909 | Show a summary of the options to @code{objcopy}. | |
910 | @end table | |
911 | ||
eae04238 | 912 | @node objdump |
c72af735 RP |
913 | @chapter objdump |
914 | ||
915 | @cindex object file information | |
916 | @kindex objdump | |
917 | ||
918 | @smallexample | |
10f2a7f6 JO |
919 | objdump [ -a | --archive-headers ] |
920 | [ -b @var{bfdname} | --target=@var{bfdname} ] | |
d5464baa ILT |
921 | [ -d | --disassemble ] [ -D | --disassemble-all ] |
922 | [ -f | --file-headers ] | |
eae04238 | 923 | [ -h | --section-headers | --headers ] [ -i | --info ] |
10f2a7f6 JO |
924 | [ -j @var{section} | --section=@var{section} ] |
925 | [ -l | --line-numbers ] | |
7e5e9619 JO |
926 | [ -m @var{machine} | --architecture=@var{machine} ] |
927 | [ -r | --reloc ] [ -R | --dynamic-reloc ] | |
928 | [ -s | --full-contents ] [ --stabs ] | |
de3b08ac ILT |
929 | [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ] |
930 | [ --version ] [ --help ] @var{objfile}@dots{} | |
c72af735 RP |
931 | @end smallexample |
932 | ||
933 | @code{objdump} displays information about one or more object files. | |
934 | The options control what particular information to display. This | |
935 | information is mostly useful to programmers who are working on the | |
936 | compilation tools, as opposed to programmers who just want their | |
937 | program to compile and work. | |
938 | ||
b26ac613 DM |
939 | @var{objfile}@dots{} are the object files to be examined. When you |
940 | specify archives, @code{objdump} shows information on each of the member | |
941 | object files. | |
942 | ||
c72af735 | 943 | The long and short forms of options, shown here as alternatives, are |
ed78872a | 944 | equivalent. At least one option besides @samp{-l} must be given. |
c72af735 RP |
945 | |
946 | @table @code | |
c72af735 | 947 | @item -a |
eae04238 | 948 | @itemx --archive-header |
c72af735 | 949 | @cindex archive headers |
ec40bbb8 | 950 | If any of the @var{objfile} files are archives, display the archive |
c72af735 RP |
951 | header information (in a format similar to @samp{ls -l}). Besides the |
952 | information you could list with @samp{ar tv}, @samp{objdump -a} shows | |
953 | the object file format of each archive member. | |
954 | ||
c72af735 | 955 | @item -b @var{bfdname} |
eae04238 | 956 | @itemx --target=@var{bfdname} |
c72af735 | 957 | @cindex object code format |
ec40bbb8 DM |
958 | Specify that the object-code format for the object files is |
959 | @var{bfdname}. This option may not be necessary; @var{objdump} can | |
960 | automatically recognize many formats. | |
961 | ||
962 | For example, | |
c72af735 RP |
963 | @example |
964 | objdump -b oasys -m vax -h fu.o | |
965 | @end example | |
966 | @noindent | |
ec40bbb8 DM |
967 | displays summary information from the section headers (@samp{-h}) of |
968 | @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object | |
c72af735 RP |
969 | file in the format produced by Oasys compilers. You can list the |
970 | formats available with the @samp{-i} option. | |
eae04238 | 971 | @xref{Target Selection}, for more information. |
c72af735 RP |
972 | |
973 | @item -d | |
eae04238 | 974 | @itemx --disassemble |
c72af735 RP |
975 | @cindex disassembling object code |
976 | @cindex machine instructions | |
d5464baa ILT |
977 | Display the assembler mnemonics for the machine instructions from |
978 | @var{objfile}. This option only disassembles those sections which are | |
979 | expected to contain instructions. | |
980 | ||
981 | @item -D | |
982 | @itemx --disassemble-all | |
983 | Like @samp{-d}, but disassemble the contents of all sections, not just | |
984 | those expected to contain instructions. | |
c72af735 RP |
985 | |
986 | @item -f | |
eae04238 | 987 | @itemx --file-header |
c72af735 | 988 | @cindex object file header |
eae04238 | 989 | Display summary information from the overall header of |
ec40bbb8 | 990 | each of the @var{objfile} files. |
c72af735 RP |
991 | |
992 | @item -h | |
eae04238 | 993 | @itemx --section-header |
c5f0c938 | 994 | @itemx --header |
c72af735 | 995 | @cindex section headers |
eae04238 | 996 | Display summary information from the section headers of the |
c72af735 RP |
997 | object file. |
998 | ||
db2e6adb DM |
999 | File segments may be relocated to nonstandard addresses, for example by |
1000 | using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to | |
1001 | @code{ld}. However, some object file formats, such as a.out, do not | |
1002 | store the starting address of the file segments. In those situations, | |
1003 | although @code{ld} relocates the sections correctly, using @samp{objdump | |
1004 | -h} to list the file section headers cannot show the correct addresses. | |
1005 | Instead, it shows the usual addresses, which are implicit for the | |
1006 | target. | |
1007 | ||
b26ac613 DM |
1008 | @item --help |
1009 | Print a summary of the options to @code{objdump} and exit. | |
1010 | ||
c72af735 | 1011 | @item -i |
eae04238 | 1012 | @itemx --info |
c72af735 RP |
1013 | @cindex architectures available |
1014 | @cindex object formats available | |
1015 | Display a list showing all architectures and object formats available | |
ec40bbb8 | 1016 | for specification with @samp{-b} or @samp{-m}. |
c72af735 | 1017 | |
c72af735 | 1018 | @item -j @var{name} |
eae04238 | 1019 | @itemx --section=@var{name} |
c72af735 | 1020 | @cindex section information |
ec40bbb8 | 1021 | Display information only for section @var{name}. |
c72af735 | 1022 | |
c72af735 | 1023 | @item -l |
eae04238 | 1024 | @itemx --line-numbers |
c72af735 | 1025 | @cindex source filenames for object files |
eae04238 DM |
1026 | Label the display (using debugging information) with the filename |
1027 | and source line numbers corresponding to the object code shown. | |
d5464baa | 1028 | Only useful with @samp{-d} or @samp{-D}. |
c72af735 | 1029 | |
c72af735 | 1030 | @item -m @var{machine} |
eae04238 | 1031 | @itemx --architecture=@var{machine} |
c72af735 | 1032 | @cindex architecture |
ec40bbb8 | 1033 | Specify that the object files @var{objfile} are for architecture |
c72af735 RP |
1034 | @var{machine}. You can list available architectures using the @samp{-i} |
1035 | option. | |
1036 | ||
1037 | @item -r | |
c5f0c938 | 1038 | @itemx --reloc |
c72af735 | 1039 | @cindex relocation entries, in object file |
d5464baa ILT |
1040 | Print the relocation entries of the file. If used with @samp{-d} or |
1041 | @samp{-D}, the relocations are printed interspersed with the | |
1042 | disassembly. | |
c72af735 | 1043 | |
de3b08ac ILT |
1044 | @item -R |
1045 | @itemx --dynamic-reloc | |
1046 | @cindex dynamic relocation entries, in object file | |
1047 | Print the dynamic relocation entries of the file. This is only | |
1048 | meaningful for dynamic objects, such as certain types of shared | |
1049 | libraries. | |
1050 | ||
c72af735 | 1051 | @item -s |
eae04238 | 1052 | @itemx --full-contents |
c72af735 RP |
1053 | @cindex sections, full contents |
1054 | @cindex object file sections | |
1055 | Display the full contents of any sections requested. | |
1056 | ||
c5f0c938 JG |
1057 | @item --stabs |
1058 | @cindex stab | |
1059 | @cindex .stab | |
1060 | @cindex debug symbols | |
1061 | @cindex ELF object file format | |
c3c93fda JG |
1062 | Display the full contents of any sections requested. Display the |
1063 | contents of the .stab and .stab.index and .stab.excl sections from an | |
1064 | ELF file. This is only useful on systems (such as Solaris 2.0) in which | |
1065 | @code{.stab} debugging symbol-table entries are carried in an ELF | |
1066 | section. In most other file formats, debugging symbol-table entries are | |
c5f0c938 JG |
1067 | interleaved with linkage symbols, and are visible in the @samp{--syms} |
1068 | output. | |
1069 | ||
c72af735 | 1070 | @item -t |
c5f0c938 | 1071 | @itemx --syms |
c72af735 | 1072 | @cindex symbol table entries, printing |
eae04238 | 1073 | Print the symbol table entries of the file. |
c72af735 RP |
1074 | This is similar to the information provided by the @samp{nm} program. |
1075 | ||
de3b08ac ILT |
1076 | @item -T |
1077 | @itemx --dynamic-syms | |
1078 | @cindex dynamic symbol table entries, printing | |
1079 | Print the dynamic symbol table entries of the file. This is only | |
1080 | meaningful for dynamic objects, such as certain types of shared | |
1081 | libraries. This is similar to the information provided by the @samp{nm} | |
1082 | program when given the @samp{-D} (@samp{--dynamic}) option. | |
1083 | ||
b26ac613 DM |
1084 | @item --version |
1085 | Print the version number of @code{objdump} and exit. | |
1086 | ||
c72af735 | 1087 | @item -x |
eae04238 | 1088 | @itemx --all-header |
c72af735 RP |
1089 | @cindex all header information, object file |
1090 | @cindex header information, all | |
1091 | Display all available header information, including the symbol table and | |
1092 | relocation entries. Using @samp{-x} is equivalent to specifying all of | |
1093 | @samp{-a -f -h -r -t}. | |
c72af735 RP |
1094 | @end table |
1095 | ||
eae04238 | 1096 | @node ranlib |
c72af735 RP |
1097 | @chapter ranlib |
1098 | ||
1099 | @kindex ranlib | |
1100 | @cindex archive contents | |
1101 | @cindex symbol index | |
1102 | ||
1103 | @smallexample | |
4d9b5d5a | 1104 | ranlib [-vV] @var{archive} |
c72af735 RP |
1105 | @end smallexample |
1106 | ||
ec40bbb8 | 1107 | @code{ranlib} generates an index to the contents of an archive and |
c72af735 RP |
1108 | stores it in the archive. The index lists each symbol defined by a |
1109 | member of an archive that is a relocatable object file. | |
1110 | ||
918c2f61 | 1111 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index. |
c72af735 | 1112 | |
ec40bbb8 | 1113 | An archive with such an index speeds up linking to the library and |
c72af735 RP |
1114 | allows routines in the library to call each other without regard to |
1115 | their placement in the archive. | |
1116 | ||
1117 | The GNU @code{ranlib} program is another form of GNU @code{ar}; running | |
1118 | @code{ranlib} is completely equivalent to executing @samp{ar -s}. | |
1119 | @xref{ar}. | |
1120 | ||
4d9b5d5a DM |
1121 | @table @code |
1122 | @item -v | |
1123 | @itemx -V | |
1124 | Show the version number of @code{ranlib}. | |
c3f471a4 | 1125 | @end table |
4d9b5d5a | 1126 | |
eae04238 | 1127 | @node size |
c72af735 RP |
1128 | @chapter size |
1129 | ||
1130 | @kindex size | |
1131 | @cindex section sizes | |
1132 | ||
1133 | @smallexample | |
4d9b5d5a DM |
1134 | size [ -A | -B | --format=@var{compatibility} ] |
1135 | [ --help ] [ -d | -o | -x | --radix=@var{number} ] | |
1136 | [ --target=@var{bfdname} ] [ -V | --version ] | |
1137 | @var{objfile}@dots{} | |
c72af735 RP |
1138 | @end smallexample |
1139 | ||
1140 | The GNU @code{size} utility lists the section sizes---and the total | |
ec40bbb8 DM |
1141 | size---for each of the object or archive files @var{objfile} in its |
1142 | argument list. By default, one line of output is generated for each | |
1143 | object file or each module in an archive. | |
c72af735 | 1144 | |
b26ac613 DM |
1145 | @var{objfile}@dots{} are the object files to be examined. |
1146 | ||
c72af735 | 1147 | The command line options have the following meanings: |
c72af735 | 1148 | |
b26ac613 | 1149 | @table @code |
c72af735 RP |
1150 | @item -A |
1151 | @itemx -B | |
ec40bbb8 | 1152 | @itemx --format=@var{compatibility} |
68dd5295 | 1153 | @cindex @code{size} display format |
c72af735 RP |
1154 | Using one of these options, you can choose whether the output from GNU |
1155 | @code{size} resembles output from System V @code{size} (using @samp{-A}, | |
ec40bbb8 DM |
1156 | or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or |
1157 | @samp{--format=berkeley}). The default is the one-line format similar to | |
c72af735 | 1158 | Berkeley's. |
918c2f61 PB |
1159 | @c Bonus for doc-source readers: you can also say --format=strange (or |
1160 | @c anything else that starts with 's') for sysv, and --format=boring (or | |
c72af735 RP |
1161 | @c anything else that starts with 'b') for Berkeley. |
1162 | ||
1163 | Here is an example of the Berkeley (default) format of output from | |
1164 | @code{size}: | |
1165 | @smallexample | |
eae04238 | 1166 | size --format=Berkeley ranlib size |
c72af735 RP |
1167 | text data bss dec hex filename |
1168 | 294880 81920 11592 388392 5ed28 ranlib | |
1169 | 294880 81920 11888 388688 5ee50 size | |
1170 | @end smallexample | |
1171 | ||
1172 | @noindent | |
1173 | This is the same data, but displayed closer to System V conventions: | |
1174 | ||
1175 | @smallexample | |
eae04238 | 1176 | size --format=SysV ranlib size |
c72af735 RP |
1177 | ranlib : |
1178 | section size addr | |
1179 | .text 294880 8192 | |
1180 | .data 81920 303104 | |
1181 | .bss 11592 385024 | |
1182 | Total 388392 | |
1183 | ||
1184 | ||
1185 | size : | |
1186 | section size addr | |
1187 | .text 294880 8192 | |
1188 | .data 81920 303104 | |
1189 | .bss 11888 385024 | |
1190 | Total 388688 | |
1191 | @end smallexample | |
1192 | ||
918c2f61 | 1193 | @item --help |
c72af735 RP |
1194 | Show a summary of acceptable arguments and options. |
1195 | ||
1196 | @item -d | |
1197 | @itemx -o | |
1198 | @itemx -x | |
ec40bbb8 | 1199 | @itemx --radix=@var{number} |
68dd5295 | 1200 | @cindex @code{size} number format |
c72af735 RP |
1201 | @cindex radix for section sizes |
1202 | Using one of these options, you can control whether the size of each | |
ec40bbb8 DM |
1203 | section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal |
1204 | (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or | |
1205 | @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three | |
c72af735 RP |
1206 | values (8, 10, 16) are supported. The total size is always given in two |
1207 | radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or | |
1208 | octal and hexadecimal if you're using @samp{-o}. | |
1209 | ||
ec40bbb8 | 1210 | @item --target=@var{bfdname} |
c72af735 | 1211 | @cindex object code format |
ec40bbb8 DM |
1212 | Specify that the object-code format for @var{objfile} is |
1213 | @var{bfdname}. This option may not be necessary; @code{size} can | |
eae04238 DM |
1214 | automatically recognize many formats. |
1215 | @xref{Target Selection}, for more information. | |
c72af735 RP |
1216 | |
1217 | @item -V | |
918c2f61 | 1218 | @itemx --version |
4d9b5d5a | 1219 | Display the version number of @code{size}. |
c72af735 RP |
1220 | @end table |
1221 | ||
eae04238 | 1222 | @node strings |
ba7c8e29 DM |
1223 | @chapter strings |
1224 | @kindex strings | |
1225 | @cindex listings strings | |
1226 | @cindex printing strings | |
1227 | @cindex strings, printing | |
1228 | ||
1229 | @smallexample | |
b26ac613 | 1230 | strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-] |
650a49f0 | 1231 | [--all] [--print-file-name] [--bytes=@var{min-len}] |
eae04238 DM |
1232 | [--radix=@var{radix}] [--target=@var{bfdname}] |
1233 | [--help] [--version] @var{file}@dots{} | |
ba7c8e29 DM |
1234 | @end smallexample |
1235 | ||
1236 | For each @var{file} given, GNU @code{strings} prints the printable | |
1237 | character sequences that are at least 4 characters long (or the number | |
1238 | given with the options below) and are followed by a NUL or newline | |
1239 | character. By default, it only prints the strings from the initialized | |
1240 | data sections of object files; for other types of files, it prints the | |
1241 | strings from the whole file. | |
1242 | ||
1243 | @code{strings} is mainly useful for determining the contents of non-text | |
1244 | files. | |
1245 | ||
1246 | @table @code | |
1247 | @item -a | |
1248 | @itemx --all | |
1249 | @itemx - | |
1250 | Do not scan only the initialized data section of object files; scan | |
1251 | the whole files. | |
1252 | ||
1253 | @item -f | |
1254 | @itemx --print-file-name | |
1255 | Print the name of the file before each string. | |
1256 | ||
b26ac613 | 1257 | @item --help |
ba7c8e29 DM |
1258 | Print a summary of the program usage on the standard output and exit. |
1259 | ||
ba7c8e29 | 1260 | @itemx -@var{min-len} |
b26ac613 | 1261 | @item -n @var{min-len} |
ba7c8e29 DM |
1262 | @itemx --bytes=@var{min-len} |
1263 | Print sequences of characters that are at least @var{min-len} characters | |
1264 | long, instead of the default 4. | |
1265 | ||
1266 | @item -o | |
b26ac613 DM |
1267 | Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o} |
1268 | act like @samp{-t d} instead. Since we can not be compatible with both | |
1269 | ways, we simply chose one. | |
ba7c8e29 DM |
1270 | |
1271 | @item -t @var{radix} | |
1272 | @itemx --radix=@var{radix} | |
1273 | Print the offset within the file before each string. The single | |
1274 | character argument specifies the radix of the offset---@samp{o} for | |
1275 | octal, @samp{x} for hexadecimal, or @samp{d} for decimal. | |
1276 | ||
eae04238 DM |
1277 | @item --target=@var{bfdname} |
1278 | @cindex object code format | |
1279 | Specify an object code format other than your system's default format. | |
1280 | @xref{Target Selection}, for more information. | |
1281 | ||
ba7c8e29 DM |
1282 | @item -v |
1283 | @itemx --version | |
1284 | Print the program version number on the standard output and exit. | |
1285 | @end table | |
1286 | ||
eae04238 | 1287 | @node strip |
c72af735 RP |
1288 | @chapter strip |
1289 | ||
1290 | @kindex strip | |
1291 | @cindex removing symbols | |
1292 | @cindex discarding symbols | |
1815e42c | 1293 | @cindex symbols, discarding |
c72af735 RP |
1294 | |
1295 | @smallexample | |
eae04238 DM |
1296 | strip [ -F @var{bfdname} | --target=@var{bfdname} | --target=@var{bfdname} ] |
1297 | [ -I @var{bfdname} | --input-target=@var{bfdname} ] | |
1298 | [ -O @var{bfdname} | --output-target=@var{bfdname} ] | |
b703c078 | 1299 | [ -s | --strip-all ] [ -S | -g | --strip-debug ] |
29c0d15c | 1300 | [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ] |
b703c078 | 1301 | [ -x | --discard-all ] [ -X | --discard-locals ] |
0aca460e | 1302 | [ -R @var{sectionname} | --remove-section=@var{sectionname} ] |
b26ac613 | 1303 | [ -v | --verbose ] [ -V | --version ] [ --help ] |
b703c078 | 1304 | @var{objfile}@dots{} |
c72af735 RP |
1305 | @end smallexample |
1306 | ||
e31e9a8d | 1307 | GNU @code{strip} discards all symbols from object files |
ec40bbb8 | 1308 | @var{objfile}. The list of object files may include archives. |
b26ac613 | 1309 | At least one object file must be given. |
c72af735 | 1310 | |
ec40bbb8 | 1311 | @code{strip} modifies the files named in its argument, |
c72af735 | 1312 | rather than writing modified copies under different names. |
c72af735 | 1313 | |
c72af735 | 1314 | @table @code |
eae04238 DM |
1315 | @item -F @var{bfdname} |
1316 | @itemx --target=@var{bfdname} | |
b26ac613 | 1317 | Treat the original @var{objfile} as a file with the object |
eae04238 DM |
1318 | code format @var{bfdname}, and rewrite it in the same format. |
1319 | @xref{Target Selection}, for more information. | |
b26ac613 DM |
1320 | |
1321 | @item --help | |
1322 | Show a summary of the options to @code{strip} and exit. | |
1323 | ||
eae04238 DM |
1324 | @item -I @var{bfdname} |
1325 | @itemx --input-target=@var{bfdname} | |
ec40bbb8 | 1326 | Treat the original @var{objfile} as a file with the object |
eae04238 DM |
1327 | code format @var{bfdname}. |
1328 | @xref{Target Selection}, for more information. | |
918c2f61 | 1329 | |
eae04238 DM |
1330 | @item -O @var{bfdname} |
1331 | @itemx --output-target=@var{bfdname} | |
1332 | Replace @var{objfile} with a file in the output format @var{bfdname}. | |
1333 | @xref{Target Selection}, for more information. | |
918c2f61 | 1334 | |
0aca460e ILT |
1335 | @item -R @var{sectionname} |
1336 | @itemx --remove-section=@var{sectionname} | |
1337 | Remove any section named @var{sectionname} from the output file. This | |
1338 | option may be given more than once. Note that using this option | |
1339 | inappropriately may make the output file unusable. | |
1340 | ||
b703c078 DM |
1341 | @item -s |
1342 | @itemx --strip-all | |
1343 | Remove all symbols. | |
1344 | ||
918c2f61 PB |
1345 | @item -g |
1346 | @itemx -S | |
1347 | @itemx --strip-debug | |
1348 | Remove debugging symbols only. | |
1349 | ||
29c0d15c ILT |
1350 | @item -N @var{symbolname} |
1351 | @itemx --strip-symbol=@var{symbolname} | |
1352 | Remove symbol @var{symbolname} from the source file. This option | |
1353 | may be given more than once, and may be combined with other strip | |
1354 | options. | |
1355 | ||
918c2f61 PB |
1356 | @item -x |
1357 | @itemx --discard-all | |
1358 | Remove non-global symbols. | |
1359 | ||
1360 | @item -X | |
1361 | @itemx --discard-locals | |
1362 | Remove compiler-generated local symbols. | |
ec40bbb8 | 1363 | (These usually start with @samp{L} or @samp{.}.) |
918c2f61 PB |
1364 | |
1365 | @item -V | |
1366 | @itemx --version | |
ec40bbb8 | 1367 | Show the version number for @code{strip}. |
918c2f61 | 1368 | |
1815e42c | 1369 | @item -v |
918c2f61 PB |
1370 | @itemx --verbose |
1371 | Verbose output: list all object files modified. In the case of | |
1269d441 | 1372 | archives, @samp{strip -v} lists all members of the archive. |
c72af735 RP |
1373 | @end table |
1374 | ||
eae04238 | 1375 | @node c++filt |
b6216af2 PB |
1376 | @chapter c++filt |
1377 | ||
1378 | @kindex c++filt | |
1379 | @cindex demangling C++ symbols | |
1380 | ||
b26ac613 DM |
1381 | @smallexample |
1382 | c++filt [ -_ | --strip-underscores ] | |
6f88f031 | 1383 | [ -n | --no-strip-underscores ] |
b26ac613 | 1384 | [ -s @var{format} | --format=@var{format} ] |
d6a4c375 | 1385 | [ --help ] [ --version ] [ @var{symbol}@dots{} ] |
b26ac613 DM |
1386 | @end smallexample |
1387 | ||
6c69b6bd JO |
1388 | The C++ language provides function overloading, which means that you can |
1389 | write many functions with the same name (providing each takes parameters | |
1390 | of different types). All C++ function names are encoded into a | |
b26ac613 | 1391 | low-level assembly label (this process is known as |
6c69b6bd JO |
1392 | @dfn{mangling}). The @code{c++filt} program does the inverse mapping: it |
1393 | decodes (@dfn{demangles}) low-level names into user-level names so that | |
1394 | the linker can keep these overloaded functions from clashing. | |
1395 | ||
1396 | Every alphanumeric word (consisting of letters, digits, underscores, | |
1397 | dollars, or periods) seen in the input is a potential label. If the | |
1398 | label decodes into a C++ name, the C++ name replaces the low-level | |
1399 | name in the output. | |
b6216af2 | 1400 | |
d6a4c375 | 1401 | You can use @code{c++filt} to decipher individual symbols: |
6c69b6bd JO |
1402 | |
1403 | @example | |
1404 | c++filt @var{symbol} | |
1405 | @end example | |
1406 | ||
d6a4c375 DM |
1407 | If no @var{symbol} arguments are given, @code{c++filt} reads symbol |
1408 | names from the standard input and writes the demangled names to the | |
1409 | standard output. All results are printed on the standard output. | |
b6216af2 | 1410 | |
b26ac613 DM |
1411 | @table @code |
1412 | @item -_ | |
94e9ad77 | 1413 | @itemx --strip-underscores |
b26ac613 DM |
1414 | On some systems, both the C and C++ compilers put an underscore in front |
1415 | of every name. For example, the C name @code{foo} gets the low-level | |
6f88f031 ILT |
1416 | name @code{_foo}. This option removes the initial underscore. Whether |
1417 | @code{c++filt} removes the underscore by default is target dependent. | |
1418 | ||
1419 | @item -n | |
1420 | @itemx --no-strip-underscores | |
1421 | Do not remove the initial underscore. | |
b26ac613 DM |
1422 | |
1423 | @item -s @var{format} | |
1424 | @itemx --format=@var{format} | |
1425 | GNU @code{nm} can decode three different methods of mangling, used by | |
1426 | different C++ compilers. The argument to this option selects which | |
1427 | method it uses: | |
1428 | ||
1429 | @table @code | |
1430 | @item gnu | |
1431 | the one used by the GNU compiler (the default method) | |
1432 | @item lucid | |
1433 | the one used by the Lucid compiler | |
1434 | @item arm | |
1435 | the one specified by the C++ Annotated Reference Manual | |
1436 | @end table | |
1437 | ||
1438 | @item --help | |
1439 | Print a summary of the options to @code{c++filt} and exit. | |
1440 | ||
1441 | @item --version | |
1442 | Print the version number of @code{c++filt} and exit. | |
1443 | @end table | |
b6216af2 | 1444 | |
5eac46ae JO |
1445 | @quotation |
1446 | @emph{Warning:} @code{c++filt} is a new utility, and the details of its | |
1447 | user interface are subject to change in future releases. In particular, | |
1448 | a command-line option may be required in the the future to decode a name | |
1449 | passed as an argument on the command line; in other words, | |
1450 | ||
1451 | @example | |
b26ac613 | 1452 | c++filt @var{symbol} |
5eac46ae JO |
1453 | @end example |
1454 | ||
1455 | @noindent | |
1456 | may in a future release become | |
1457 | ||
1458 | @example | |
b26ac613 | 1459 | c++filt @var{option} @var{symbol} |
5eac46ae JO |
1460 | @end example |
1461 | @end quotation | |
1462 | ||
eae04238 | 1463 | @node nlmconv |
94e9ad77 JO |
1464 | @chapter nlmconv |
1465 | ||
1466 | @code{nlmconv} converts a relocatable object file into a NetWare | |
8981cac5 JO |
1467 | Loadable Module. |
1468 | ||
1469 | @ignore | |
1470 | @code{nlmconv} currently works with @samp{i386} object | |
4961ce5b JO |
1471 | files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC} |
1472 | object files in @sc{elf}, or @code{a.out} format@footnote{ | |
1473 | @code{nlmconv} should work with any @samp{i386} or @sc{sparc} object | |
1474 | format in the Binary File Descriptor library. It has only been tested | |
1475 | with the above formats.}. | |
8981cac5 | 1476 | @end ignore |
4961ce5b JO |
1477 | |
1478 | @quotation | |
1479 | @emph{Warning:} @code{nlmconv} is not always built as part of the binary | |
1480 | utilities, since it is only useful for NLM targets. | |
1481 | @end quotation | |
94e9ad77 JO |
1482 | |
1483 | @smallexample | |
eae04238 DM |
1484 | nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ] |
1485 | [ -O @var{bfdname} | --output-target=@var{bfdname} ] | |
94e9ad77 | 1486 | [ -T @var{headerfile} | --header-file=@var{headerfile} ] |
20465f8b | 1487 | [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ] |
94e9ad77 JO |
1488 | [ -h | --help ] [ -V | --version ] |
1489 | @var{infile} @var{outfile} | |
1490 | @end smallexample | |
1491 | ||
1492 | @code{nlmconv} converts the relocatable @samp{i386} object file | |
1493 | @var{infile} into the NetWare Loadable Module @var{outfile}, optionally | |
1494 | reading @var{headerfile} for NLM header information. For instructions | |
5b0ba16d JO |
1495 | on writing the NLM command file language used in header files, see the |
1496 | @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM | |
1497 | Development and Tools Overview}, which is part of the NLM Software | |
1498 | Developer's Kit (``NLM SDK''), available from Novell, Inc. | |
1499 | @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read | |
eae04238 | 1500 | @var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for |
5b0ba16d | 1501 | more information. |
94e9ad77 | 1502 | |
20465f8b JO |
1503 | @code{nlmconv} can perform a link step. In other words, you can list |
1504 | more than one object file for input if you list them in the definitions | |
1505 | file (rather than simply specifying one input file on the command line). | |
1506 | In this case, @code{nlmconv} calls the linker for you. | |
1507 | ||
94e9ad77 | 1508 | @table @code |
eae04238 DM |
1509 | @item -I @var{bfdname} |
1510 | @itemx --input-target=@var{bfdname} | |
94e9ad77 | 1511 | Object format of the input file. @code{nlmconv} can usually determine |
eae04238 DM |
1512 | the format of a given file (so no default is necessary). |
1513 | @xref{Target Selection}, for more information. | |
94e9ad77 | 1514 | |
eae04238 DM |
1515 | @item -O @var{bfdname} |
1516 | @itemx --output-target=@var{bfdname} | |
94e9ad77 JO |
1517 | Object format of the output file. @code{nlmconv} infers the output |
1518 | format based on the input format, e.g. for a @samp{i386} input file the | |
eae04238 DM |
1519 | output format is @samp{nlm32-i386}. |
1520 | @xref{Target Selection}, for more information. | |
94e9ad77 JO |
1521 | |
1522 | @item -T @var{headerfile} | |
1523 | @itemx --header-file=@var{headerfile} | |
1524 | Reads @var{headerfile} for NLM header information. For instructions on | |
5b0ba16d JO |
1525 | writing the NLM command file language used in header files, see@ see the |
1526 | @samp{linkers} section, of the @cite{NLM Development and Tools | |
1527 | Overview}, which is part of the NLM Software Developer's Kit, available | |
1528 | from Novell, Inc. | |
94e9ad77 | 1529 | |
20465f8b JO |
1530 | @item -d |
1531 | @itemx --debug | |
1532 | Displays (on standard error) the linker command line used by @code{nlmconv}. | |
1533 | ||
1534 | @item -l @var{linker} | |
1535 | @itemx --linker=@var{linker} | |
1536 | Use @var{linker} for any linking. @var{linker} can be an abosolute or a | |
1537 | relative pathname. | |
1538 | ||
94e9ad77 JO |
1539 | @item -h |
1540 | @itemx --help | |
1541 | Prints a usage summary. | |
1542 | ||
1543 | @item -V | |
1544 | @itemx --version | |
1545 | Prints the version number for @code{nlmconv}. | |
1546 | @end table | |
1547 | ||
eae04238 DM |
1548 | @node Selecting The Target System |
1549 | @chapter Selecting the target system | |
1550 | ||
8981cac5 JO |
1551 | You can specify three aspects of the target system to the @sc{gnu} |
1552 | binary file utilities, each in several ways: | |
eae04238 DM |
1553 | |
1554 | @itemize @bullet | |
1555 | @item | |
8981cac5 | 1556 | the target |
eae04238 DM |
1557 | |
1558 | @item | |
8981cac5 | 1559 | the architecture |
eae04238 DM |
1560 | |
1561 | @item | |
8981cac5 | 1562 | the linker emulation (which applies to the linker only) |
eae04238 DM |
1563 | @end itemize |
1564 | ||
1565 | In the following summaries, the lists of ways to specify values are in | |
8981cac5 JO |
1566 | order of decreasing precedence. The ways listed first override those |
1567 | listed later. | |
eae04238 | 1568 | |
8981cac5 JO |
1569 | The commands to list valid values only list the values for which the |
1570 | programs you are running were configured. If they were configured with | |
eae04238 DM |
1571 | @samp{--with-targets=all}, the commands list most of the available |
1572 | values, but a few are left out; not all targets can be configured in at | |
8981cac5 JO |
1573 | once because some of them can only be configured @dfn{native} (on hosts |
1574 | with the same type as the target system). | |
eae04238 DM |
1575 | |
1576 | @menu | |
1577 | * Target Selection:: | |
1578 | * Architecture Selection:: | |
1579 | * Linker Emulation Selection:: | |
1580 | @end menu | |
1581 | ||
1582 | @node Target Selection | |
8981cac5 | 1583 | @section Target Selection |
eae04238 DM |
1584 | |
1585 | A @dfn{target} is an object file format. A given target may be | |
1586 | supported for multiple architectures (@pxref{Architecture Selection}). | |
8981cac5 JO |
1587 | A target selection may also have variations for different operating |
1588 | systems or architectures. | |
eae04238 | 1589 | |
8981cac5 JO |
1590 | The command to list valid target values is @samp{objdump -i} |
1591 | (the first column of output contains the relevant information). | |
eae04238 | 1592 | |
10f2a7f6 JO |
1593 | Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips}, |
1594 | @samp{a.out-sunos-big}. | |
eae04238 | 1595 | |
8981cac5 | 1596 | @subheading @code{objdump} Target |
eae04238 DM |
1597 | |
1598 | Ways to specify: | |
1599 | ||
1600 | @enumerate | |
1601 | @item | |
8981cac5 | 1602 | command line option: @samp{-b} or @samp{--target} |
eae04238 DM |
1603 | |
1604 | @item | |
1605 | environment variable @code{GNUTARGET} | |
1606 | ||
1607 | @item | |
1608 | deduced from the input file | |
1609 | @end enumerate | |
1610 | ||
8981cac5 | 1611 | @subheading @code{objcopy} and @code{strip} Input Target |
eae04238 DM |
1612 | |
1613 | Ways to specify: | |
1614 | ||
1615 | @enumerate | |
1616 | @item | |
8981cac5 | 1617 | command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target} |
eae04238 DM |
1618 | |
1619 | @item | |
1620 | environment variable @code{GNUTARGET} | |
1621 | ||
1622 | @item | |
1623 | deduced from the input file | |
1624 | @end enumerate | |
1625 | ||
8981cac5 | 1626 | @subheading @code{objcopy} and @code{strip} Output Target |
eae04238 DM |
1627 | |
1628 | Ways to specify: | |
1629 | ||
1630 | @enumerate | |
1631 | @item | |
8981cac5 | 1632 | command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target} |
eae04238 DM |
1633 | |
1634 | @item | |
8981cac5 | 1635 | the input target (see ``@code{objcopy} and @code{strip} Input Target'' above) |
eae04238 DM |
1636 | |
1637 | @item | |
1638 | environment variable @code{GNUTARGET} | |
1639 | ||
1640 | @item | |
1641 | deduced from the input file | |
1642 | @end enumerate | |
1643 | ||
8981cac5 | 1644 | @subheading @code{nm}, @code{size}, and @code{strings} Target |
eae04238 DM |
1645 | |
1646 | Ways to specify: | |
1647 | ||
1648 | @enumerate | |
1649 | @item | |
8981cac5 | 1650 | command line option: @samp{--target} |
eae04238 DM |
1651 | |
1652 | @item | |
1653 | environment variable @code{GNUTARGET} | |
1654 | ||
1655 | @item | |
1656 | deduced from the input file | |
1657 | @end enumerate | |
1658 | ||
8981cac5 | 1659 | @subheading Linker Input Target |
eae04238 DM |
1660 | |
1661 | Ways to specify: | |
1662 | ||
1663 | @enumerate | |
1664 | @item | |
8981cac5 | 1665 | command line option: @samp{-b} or @samp{--format} |
eae04238 DM |
1666 | (@pxref{Options,,Options,ld.info,Using LD}) |
1667 | ||
1668 | @item | |
1669 | script command @code{TARGET} | |
1670 | (@pxref{Option Commands,,Option Commands,ld.info,Using LD}) | |
1671 | ||
1672 | @item | |
1673 | environment variable @code{GNUTARGET} | |
1674 | (@pxref{Environment,,Environment,ld.info,Using LD}) | |
1675 | ||
1676 | @item | |
1677 | the default target of the selected linker emulation | |
1678 | (@pxref{Linker Emulation Selection}) | |
1679 | @end enumerate | |
1680 | ||
8981cac5 | 1681 | @subheading Linker Output Target |
eae04238 DM |
1682 | |
1683 | Ways to specify: | |
1684 | ||
1685 | @enumerate | |
1686 | @item | |
8981cac5 | 1687 | command line option: @samp{-oformat} |
eae04238 DM |
1688 | (@pxref{Options,,Options,ld.info,Using LD}) |
1689 | ||
1690 | @item | |
1691 | script command @code{OUTPUT_FORMAT} | |
1692 | (@pxref{Option Commands,,Option Commands,ld.info,Using LD}) | |
1693 | ||
1694 | @item | |
8981cac5 | 1695 | the linker input target (see ``Linker Input Target'' above) |
eae04238 DM |
1696 | @end enumerate |
1697 | ||
1698 | @node Architecture Selection | |
1699 | @section Architecture selection | |
1700 | ||
8981cac5 JO |
1701 | An @dfn{architecture} is a type of @sc{cpu} on which an object file is |
1702 | to run. Its name may contain a colon, separating the name of the | |
1703 | processor family from the name of the particular @sc{cpu}. | |
eae04238 | 1704 | |
8981cac5 JO |
1705 | The command to list valid architecture values is @samp{objdump -i} (the |
1706 | second column contains the relevant information). | |
eae04238 DM |
1707 | |
1708 | Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}. | |
1709 | ||
8981cac5 | 1710 | @subheading @code{objdump} Architecture |
eae04238 DM |
1711 | |
1712 | Ways to specify: | |
1713 | ||
1714 | @enumerate | |
1715 | @item | |
8981cac5 | 1716 | command line option: @samp{-m} or @samp{--architecture} |
eae04238 DM |
1717 | |
1718 | @item | |
1719 | deduced from the input file | |
1720 | @end enumerate | |
1721 | ||
8981cac5 | 1722 | @subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture |
eae04238 DM |
1723 | |
1724 | Ways to specify: | |
1725 | ||
1726 | @enumerate | |
1727 | @item | |
1728 | deduced from the input file | |
1729 | @end enumerate | |
1730 | ||
8981cac5 | 1731 | @subheading Linker Input Architecture |
eae04238 DM |
1732 | |
1733 | Ways to specify: | |
1734 | ||
1735 | @enumerate | |
1736 | @item | |
1737 | deduced from the input file | |
1738 | @end enumerate | |
1739 | ||
8981cac5 | 1740 | @subheading Linker Output Architecture |
eae04238 DM |
1741 | |
1742 | Ways to specify: | |
1743 | ||
1744 | @enumerate | |
1745 | @item | |
1746 | script command @code{OUTPUT_ARCH} | |
1747 | (@pxref{Option Commands,,Option Commands,ld.info,Using LD}) | |
1748 | ||
1749 | @item | |
1750 | the default architecture from the linker output target | |
8981cac5 | 1751 | (@pxref{Target Selection}) |
eae04238 DM |
1752 | @end enumerate |
1753 | ||
1754 | @node Linker Emulation Selection | |
1755 | @section Linker emulation selection | |
1756 | ||
1757 | A linker @dfn{emulation} is a ``personality'' of the linker, which gives | |
1758 | the linker default values for the other aspects of the target system. | |
1759 | In particular, it consists of | |
1760 | ||
1761 | @itemize @bullet | |
1762 | @item | |
8981cac5 | 1763 | the linker script |
eae04238 DM |
1764 | |
1765 | @item | |
8981cac5 | 1766 | the target |
eae04238 DM |
1767 | |
1768 | @item | |
1769 | several ``hook'' functions that are run at certain stages of the linking | |
8981cac5 | 1770 | process to do special things that some targets require |
eae04238 DM |
1771 | @end itemize |
1772 | ||
8981cac5 | 1773 | The command to list valid linker emulation values is @samp{ld -V}. |
eae04238 DM |
1774 | |
1775 | Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}. | |
1776 | ||
1777 | Ways to specify: | |
1778 | ||
1779 | @enumerate | |
1780 | @item | |
8981cac5 | 1781 | command line option: @samp{-m} |
eae04238 DM |
1782 | (@pxref{Options,,Options,ld.info,Using LD}) |
1783 | ||
1784 | @item | |
1785 | environment variable @code{LDEMULATION} | |
1786 | ||
1787 | @item | |
1788 | compiled-in @code{DEFAULT_EMULATION} from @file{Makefile}, | |
1789 | which comes from @code{EMUL} in @file{config/@var{target}.mt} | |
1790 | @end enumerate | |
1791 | ||
1792 | @node Index | |
c72af735 RP |
1793 | @unnumbered Index |
1794 | ||
1795 | @printindex cp | |
1796 | ||
1797 | @contents | |
1798 | @bye |