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 | |
d6391983 | 7 | * Binutils:: The GNU binary utilities "ar", "ld", "objcopy", |
ba7c8e29 | 8 | "objdump", "nm", "size", "strings", "strip", and "ranlib". |
9abcc3b8 RP |
9 | END-INFO-DIR-ENTRY |
10 | @end format | |
11 | @end ifinfo | |
c72af735 | 12 | |
8b2c2275 | 13 | @ifinfo |
e32341a7 | 14 | Copyright @copyright{} 1991, 1992, 1993 Free Software Foundation, Inc. |
8b2c2275 RP |
15 | |
16 | Permission is granted to make and distribute verbatim copies of | |
17 | this manual provided the copyright notice and this permission notice | |
18 | are preserved on all copies. | |
19 | ||
20 | @ignore | |
21 | Permission is granted to process this file through TeX and print the | |
22 | results, provided the printed document carries a copying permission | |
23 | notice identical to this one except for the removal of this paragraph | |
24 | (this paragraph not being relevant to the printed manual). | |
25 | ||
26 | @end ignore | |
27 | ||
28 | Permission is granted to copy and distribute modified versions of this | |
29 | manual under the conditions for verbatim copying, provided also that | |
30 | the entire resulting derived work is distributed under the terms of a | |
31 | permission notice identical to this one. | |
32 | ||
33 | Permission is granted to copy and distribute translations of this manual | |
34 | into another language, under the above conditions for modified versions. | |
35 | @end ifinfo | |
36 | ||
c72af735 RP |
37 | @synindex ky cp |
38 | @c | |
df14d957 | 39 | @c This file documents the GNU binary utilities "ar", "ld", "objcopy", |
ba7c8e29 | 40 | @c "objdump", "nm", "size", "strings", "strip", and "ranlib". |
c72af735 | 41 | @c |
e32341a7 | 42 | @c Copyright (C) 1991, 1992, 1993 Free Software Foundation, Inc. |
c72af735 RP |
43 | @c |
44 | @c This text may be freely distributed under the terms of the GNU | |
45 | @c General Public License. | |
46 | @c | |
27e94bd5 | 47 | |
c72af735 RP |
48 | @setchapternewpage odd |
49 | @settitle GNU Binary Utilities | |
27e94bd5 RP |
50 | @c @smallbook |
51 | @c @cropmarks | |
4928b97b RP |
52 | @titlepage |
53 | @finalout | |
c72af735 | 54 | @title The GNU Binary Utilities |
b6216af2 | 55 | @subtitle Version 2.2 |
c72af735 | 56 | @sp 1 |
e32341a7 | 57 | @subtitle May 1993 |
c72af735 RP |
58 | @author Roland H. Pesch |
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 | |
e32341a7 | 68 | Copyright @copyright{} 1991, 1992, 1993 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 | ||
83 | @node Top, ar, (dir), (dir) | |
84 | @chapter Introduction | |
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 | ||
df14d957 | 95 | @item objcopy |
e31e9a8d JO |
96 | Copy and translate object files |
97 | ||
c72af735 RP |
98 | @item nm |
99 | List symbols from object files | |
100 | ||
101 | @item objdump | |
102 | Display information from object files | |
103 | ||
104 | @item ranlib | |
105 | Generate index to archive contents | |
106 | ||
107 | @item size | |
108 | List section sizes and total size | |
109 | ||
ba7c8e29 DM |
110 | @item strings |
111 | List printable strings from files | |
112 | ||
c72af735 RP |
113 | @item strip |
114 | Discard symbols | |
115 | @end table | |
8b2c2275 | 116 | @end iftex |
c72af735 RP |
117 | |
118 | @menu | |
8b2c2275 | 119 | * ar:: Create, modify, and extract from archives |
df14d957 | 120 | * objcopy:: Copy and translate object files |
8b2c2275 RP |
121 | * ld:(ld)Overview. Combine object and archive files |
122 | * nm:: List symbols from object files | |
123 | * objdump:: Display information from object files | |
124 | * ranlib:: Generate index to archive contents | |
125 | * size:: List section sizes and total size | |
ba7c8e29 | 126 | * strings:: List printable strings from files |
8b2c2275 | 127 | * strip:: Discard symbols |
b6216af2 | 128 | * c++filt:: Filter to demangle encoded C++ symbols |
8b2c2275 | 129 | * Index:: |
c72af735 RP |
130 | @end menu |
131 | ||
df14d957 | 132 | @node ar, objcopy, Top, Top |
c72af735 RP |
133 | @chapter ar |
134 | ||
135 | @kindex ar | |
136 | @cindex archives | |
137 | @cindex collections of files | |
138 | @smallexample | |
650a49f0 | 139 | ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}] |
4d9b5d5a | 140 | ar -M [ <mri-script ] |
c72af735 RP |
141 | @end smallexample |
142 | ||
143 | The GNU @code{ar} program creates, modifies, and extracts from | |
144 | archives. An @dfn{archive} is a single file holding a collection of | |
145 | other files in a structure that makes it possible to retrieve | |
146 | the original individual files (called @dfn{members} of the archive). | |
147 | ||
148 | The original files' contents, mode (permissions), timestamp, owner, and | |
ec40bbb8 | 149 | group are preserved in the archive, and can be restored on |
c72af735 RP |
150 | extraction. |
151 | ||
152 | @cindex name length | |
153 | GNU @code{ar} can maintain archives whose members have names of any | |
154 | length; however, depending on how @code{ar} is configured on your | |
ec40bbb8 DM |
155 | system, a limit on member-name length may be imposed for compatibility |
156 | with archive formats maintained with other tools. If it exists, the | |
c72af735 RP |
157 | limit is often 15 characters (typical of formats related to a.out) or 16 |
158 | characters (typical of formats related to coff). | |
159 | ||
160 | @cindex libraries | |
161 | @code{ar} is considered a binary utility because archives of this sort | |
162 | are most often used as @dfn{libraries} holding commonly needed | |
163 | subroutines. | |
164 | ||
165 | @cindex symbol index | |
e31e9a8d | 166 | @code{ar} creates an index to the symbols defined in relocatable |
c72af735 RP |
167 | object modules in the archive when you specify the modifier @samp{s}. |
168 | Once created, this index is updated in the archive whenever @code{ar} | |
169 | makes a change to its contents (save for the @samp{q} update operation). | |
170 | An archive with such an index speeds up linking to the library, and | |
171 | allows routines in the library to call each other without regard to | |
172 | their placement in the archive. | |
173 | ||
918c2f61 | 174 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index |
c72af735 RP |
175 | table. If an archive lacks the table, another form of @code{ar} called |
176 | @code{ranlib} can be used to add just the table. | |
177 | ||
765a273f RP |
178 | @cindex compatibility, @code{ar} |
179 | @cindex @code{ar} compatibility | |
180 | GNU @code{ar} is designed to be compatible with two different | |
181 | facilities. You can control its activity using command-line options, | |
182 | like the different varieties of @code{ar} on Unix systems; or, if you | |
183 | specify the single command-line option @samp{-M}, you can control it | |
184 | with a script supplied via standard input, like the MRI ``librarian'' | |
185 | program. | |
186 | ||
187 | @menu | |
188 | * ar-cmdline:: Controlling @code{ar} on the command line | |
189 | * ar-scripts:: Controlling @code{ar} with a script | |
190 | @end menu | |
191 | ||
192 | @page | |
193 | @node ar-cmdline, ar-scripts, ar, ar | |
194 | @section Controlling @code{ar} on the command line | |
195 | ||
196 | @smallexample | |
650a49f0 | 197 | ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}] |
765a273f RP |
198 | @end smallexample |
199 | ||
200 | @cindex Unix compatibility, @code{ar} | |
201 | When you use @code{ar} in the Unix style, @code{ar} insists on at least two | |
202 | arguments to execute: one keyletter specifying the @emph{operation} | |
203 | (optionally accompanied by other keyletters specifying | |
204 | @emph{modifiers}), and the archive name to act on. | |
c72af735 | 205 | |
650a49f0 | 206 | Most operations can also accept further @var{member} arguments, |
c72af735 RP |
207 | specifying particular files to operate on. |
208 | ||
209 | GNU @code{ar} allows you to mix the operation code @var{p} and modifier | |
210 | flags @var{mod} in any order, within the first command-line argument. | |
211 | ||
212 | If you wish, you may begin the first command-line argument with a | |
213 | dash. | |
214 | ||
215 | @cindex operations on archive | |
216 | The @var{p} keyletter specifies what operation to execute; it may be | |
217 | any of the following, but you must specify only one of them: | |
218 | ||
219 | @table @code | |
220 | @item d | |
221 | @cindex deleting from archive | |
222 | @emph{Delete} modules from the archive. Specify the names of modules to | |
650a49f0 | 223 | be deleted as @var{member}@dots{}; the archive is untouched if you |
c72af735 RP |
224 | specify no files to delete. |
225 | ||
e31e9a8d | 226 | If you specify the @samp{v} modifier, @code{ar} lists each module |
c72af735 RP |
227 | as it is deleted. |
228 | ||
229 | @item m | |
230 | @cindex moving in archive | |
231 | Use this operation to @emph{move} members in an archive. | |
232 | ||
233 | The ordering of members in an archive can make a difference in how | |
234 | programs are linked using the library, if a symbol is defined in more | |
235 | than one member. | |
236 | ||
237 | If no modifiers are used with @code{m}, any members you name in the | |
650a49f0 | 238 | @var{member} arguments are moved to the @emph{end} of the archive; |
c72af735 RP |
239 | you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a |
240 | specified place instead. | |
241 | ||
242 | @item p | |
243 | @cindex printing from archive | |
244 | @emph{Print} the specified members of the archive, to the standard | |
245 | output file. If the @samp{v} modifier is specified, show the member | |
246 | name before copying its contents to standard output. | |
247 | ||
650a49f0 | 248 | If you specify no @var{member} arguments, all the files in the archive are |
ec40bbb8 | 249 | printed. |
c72af735 RP |
250 | |
251 | @item q | |
252 | @cindex quick append to archive | |
650a49f0 | 253 | @emph{Quick append}; add the files @var{member}@dots{} to the end of |
ec40bbb8 | 254 | @var{archive}, without checking for replacement. |
c72af735 RP |
255 | |
256 | The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this | |
257 | operation; new members are always placed at the end of the archive. | |
258 | ||
259 | The modifier @samp{v} makes @code{ar} list each file as it is appended. | |
260 | ||
261 | Since the point of this operation is speed, the archive's symbol table | |
262 | index is not updated, even if it already existed; you can use @samp{ar s} or | |
263 | @code{ranlib} explicitly to update the symbol table index. | |
264 | ||
265 | @item r | |
266 | @cindex replacement in archive | |
650a49f0 | 267 | Insert the files @var{member}@dots{} into @var{archive} (with |
ec40bbb8 DM |
268 | @emph{replacement}). This operation differs from @samp{q} in that any |
269 | previously existing members are deleted if their names match those being | |
270 | added. | |
c72af735 | 271 | |
650a49f0 | 272 | If one of the files named in @var{member}@dots{} does not exist, @code{ar} |
c72af735 RP |
273 | displays an error message, and leaves undisturbed any existing members |
274 | of the archive matching that name. | |
275 | ||
276 | By default, new members are added at the end of the file; but you may | |
277 | use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request | |
278 | placement relative to some existing member. | |
279 | ||
280 | The modifier @samp{v} used with this operation elicits a line of | |
281 | output for each file inserted, along with one of the letters @samp{a} or | |
282 | @samp{r} to indicate whether the file was appended (no old member | |
283 | deleted) or replaced. | |
284 | ||
285 | @item t | |
286 | @cindex contents of archive | |
287 | Display a @emph{table} listing the contents of @var{archive}, or those | |
650a49f0 | 288 | of the files listed in @var{member}@dots{} that are present in the |
c72af735 RP |
289 | archive. Normally only the member name is shown; if you also want to |
290 | see the modes (permissions), timestamp, owner, group, and size, you can | |
291 | request that by also specifying the @samp{v} modifier. | |
292 | ||
650a49f0 | 293 | If you do not specify a @var{member}, all files in the archive |
c72af735 RP |
294 | are listed. |
295 | ||
296 | @cindex repeated names in archive | |
297 | @cindex name duplication in archive | |
298 | If there is more than one file with the same name (say, @samp{fie}) in | |
e31e9a8d | 299 | an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the |
c72af735 RP |
300 | first instance; to see them all, you must ask for a complete |
301 | listing---in our example, @samp{ar t b.a}. | |
302 | @c WRS only; per Gumby, this is implementation-dependent, and in a more | |
303 | @c recent case in fact works the other way. | |
304 | ||
305 | @item x | |
306 | @cindex extract from archive | |
650a49f0 | 307 | @emph{Extract} members (named @var{member}) from the archive. You can |
c72af735 RP |
308 | use the @samp{v} modifier with this operation, to request that |
309 | @code{ar} list each name as it extracts it. | |
310 | ||
650a49f0 | 311 | If you do not specify a @var{member}, all files in the archive |
c72af735 RP |
312 | are extracted. |
313 | ||
314 | @end table | |
315 | ||
316 | A number of modifiers (@var{mod}) may immediately follow the @var{p} | |
317 | keyletter, to specify variations on an operation's behavior: | |
318 | ||
319 | @table @code | |
320 | @item a | |
321 | @cindex relative placement in archive | |
322 | Add new files @emph{after} an existing member of the | |
ec40bbb8 | 323 | archive. If you use the modifier @samp{a}, the name of an existing archive |
650a49f0 | 324 | member must be present as the @var{relpos} argument, before the |
c72af735 RP |
325 | @var{archive} specification. |
326 | ||
327 | @item b | |
328 | Add new files @emph{before} an existing member of the | |
ec40bbb8 | 329 | archive. If you use the modifier @samp{b}, the name of an existing archive |
650a49f0 | 330 | member must be present as the @var{relpos} argument, before the |
c72af735 RP |
331 | @var{archive} specification. (same as @samp{i}). |
332 | ||
333 | @item c | |
334 | @cindex creating archives | |
335 | @emph{Create} the archive. The specified @var{archive} is always | |
650a49f0 | 336 | created if it did not exist, when you request an update. But a warning is |
c72af735 RP |
337 | issued unless you specify in advance that you expect to create it, by |
338 | using this modifier. | |
339 | ||
340 | @item i | |
341 | Insert new files @emph{before} an existing member of the | |
ec40bbb8 | 342 | archive. If you use the modifier @samp{i}, the name of an existing archive |
650a49f0 | 343 | member must be present as the @var{relpos} argument, before the |
c72af735 RP |
344 | @var{archive} specification. (same as @samp{b}). |
345 | ||
346 | @item l | |
347 | This modifier is accepted but not used. | |
348 | @c whaffor ar l modifier??? presumably compat; with | |
349 | @c what???---pesch@@cygnus.com, 25jan91 | |
350 | ||
351 | @item o | |
352 | @cindex dates in archive | |
353 | Preserve the @emph{original} dates of members when extracting them. If | |
354 | you do not specify this modifier, files extracted from the archive | |
e31e9a8d | 355 | are stamped with the time of extraction. |
c72af735 RP |
356 | |
357 | @item s | |
358 | @cindex writing archive index | |
359 | Write an object-file index into the archive, or update an existing one, | |
360 | even if no other change is made to the archive. You may use this modifier | |
361 | flag either with any operation, or alone. Running @samp{ar s} on an | |
362 | archive is equivalent to running @samp{ranlib} on it. | |
363 | ||
364 | @item u | |
365 | @cindex updating an archive | |
b703c078 | 366 | Normally, @samp{ar r}@dots{} inserts all files |
c72af735 RP |
367 | listed into the archive. If you would like to insert @emph{only} those |
368 | of the files you list that are newer than existing members of the same | |
369 | names, use this modifier. The @samp{u} modifier is allowed only for the | |
370 | operation @samp{r} (replace). In particular, the combination @samp{qu} is | |
371 | not allowed, since checking the timestamps would lose any speed | |
372 | advantage from the operation @samp{q}. | |
373 | ||
374 | @item v | |
375 | This modifier requests the @emph{verbose} version of an operation. Many | |
376 | operations display additional information, such as filenames processed, | |
377 | when the modifier @samp{v} is appended. | |
4d9b5d5a DM |
378 | |
379 | @item V | |
380 | This modifier shows the version number of @code{ar}. | |
765a273f RP |
381 | @end table |
382 | ||
383 | @node ar-scripts, , ar-cmdline, ar | |
384 | @section Controlling @code{ar} with a script | |
385 | ||
386 | @smallexample | |
387 | ar -M [ <@var{script} ] | |
388 | @end smallexample | |
389 | ||
390 | @cindex MRI compatibility, @code{ar} | |
391 | @cindex scripts, @code{ar} | |
392 | If you use the single command-line option @samp{-M} with @code{ar}, you | |
393 | can control its operation with a rudimentary command language. This | |
e31e9a8d | 394 | form of @code{ar} operates interactively if standard input is coming |
765a273f RP |
395 | directly from a terminal. During interactive use, @code{ar} prompts for |
396 | input (the prompt is @samp{AR >}), and continues executing even after | |
397 | errors. If you redirect standard input to a script file, no prompts are | |
e31e9a8d | 398 | issued, and @code{ar} abandons execution (with a nonzero exit code) |
765a273f RP |
399 | on any error. |
400 | ||
401 | The @code{ar} command language is @emph{not} designed to be equivalent | |
402 | to the command-line options; in fact, it provides somewhat less control | |
403 | over archives. The only purpose of the command language is to ease the | |
404 | transition to GNU @code{ar} for developers who already have scripts | |
405 | written for the MRI ``librarian'' program. | |
406 | ||
407 | The syntax for the @code{ar} command language is straightforward: | |
408 | @itemize @bullet | |
409 | @item | |
410 | commands are recognized in upper or lower case; for example, @code{LIST} | |
411 | is the same as @code{list}. In the following descriptions, commands are | |
412 | shown in upper case for clarity. | |
413 | ||
414 | @item | |
415 | a single command may appear on each line; it is the first word on the | |
416 | line. | |
417 | ||
418 | @item | |
419 | empty lines are allowed, and have no effect. | |
420 | ||
421 | @item | |
422 | comments are allowed; text after either of the characters @samp{*} | |
423 | or @samp{;} is ignored. | |
424 | ||
425 | @item | |
426 | Whenever you use a list of names as part of the argument to an @code{ar} | |
427 | command, you can separate the individual names with either commas or | |
428 | blanks. Commas are shown in the explanations below, for clarity. | |
429 | ||
430 | @item | |
431 | @samp{+} is used as a line continuation character; if @samp{+} appears | |
432 | at the end of a line, the text on the following line is considered part | |
433 | of the current command. | |
434 | @end itemize | |
435 | ||
436 | Here are the commands you can use in @code{ar} scripts, or when using | |
437 | @code{ar} interactively. Three of them have special significance: | |
438 | ||
439 | @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is | |
440 | a temporary file required for most of the other commands. | |
441 | ||
442 | @code{SAVE} commits the changes so far specified by the script. Prior | |
443 | to @code{SAVE}, commands affect only the temporary copy of the current | |
444 | archive. | |
445 | ||
446 | @table @code | |
447 | @item ADDLIB @var{archive} | |
448 | @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module}) | |
449 | Add all the contents of @var{archive} (or, if specified, each named | |
450 | @var{module} from @var{archive}) to the current archive. | |
451 | ||
452 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
453 | ||
650a49f0 | 454 | @item ADDMOD @var{member}, @var{member}, @dots{} @var{member} |
765a273f RP |
455 | @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}" |
456 | @c else like "ar q..." | |
650a49f0 | 457 | Add each named @var{member} as a module in the current archive. |
765a273f RP |
458 | |
459 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
460 | ||
461 | @item CLEAR | |
462 | Discard the contents of the current archive, cancelling the effect of | |
463 | any operations since the last @code{SAVE}. May be executed (with no | |
464 | effect) even if no current archive is specified. | |
465 | ||
466 | @item CREATE @var{archive} | |
467 | Creates an archive, and makes it the current archive (required for many | |
468 | other commands). The new archive is created with a temporary name; it | |
469 | is not actually saved as @var{archive} until you use @code{SAVE}. | |
470 | You can overwrite existing archives; similarly, the contents of any | |
471 | existing file named @var{archive} will not be destroyed until @code{SAVE}. | |
472 | ||
473 | @item DELETE @var{module}, @var{module}, @dots{} @var{module} | |
474 | Delete each listed @var{module} from the current archive; equivalent to | |
475 | @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}. | |
476 | ||
477 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
478 | ||
479 | @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) | |
480 | @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile} | |
481 | List each named @var{module} present in @var{archive}. The separate | |
482 | command @code{VERBOSE} specifies the form of the output: when verbose | |
483 | output is off, output is like that of @samp{ar -t @var{archive} | |
b703c078 DM |
484 | @var{module}@dots{}}. When verbose output is on, the listing is like |
485 | @samp{ar -tv @var{archive} @var{module}@dots{}}. | |
765a273f RP |
486 | |
487 | Output normally goes to the standard output stream; however, if you | |
488 | specify @var{outputfile} as a final argument, @code{ar} directs the | |
489 | output to that file. | |
490 | ||
491 | @item END | |
492 | Exit from @code{ar}, with a @code{0} exit code to indicate successful | |
493 | completion. This command does not save the output file; if you have | |
494 | changed the current archive since the last @code{SAVE} command, those | |
495 | changes are lost. | |
496 | ||
497 | @item EXTRACT @var{module}, @var{module}, @dots{} @var{module} | |
498 | Extract each named @var{module} from the current archive, writing them | |
499 | into the current directory as separate files. Equivalent to @samp{ar -x | |
b703c078 | 500 | @var{archive} @var{module}@dots{}}. |
765a273f RP |
501 | |
502 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
503 | ||
504 | @ignore | |
505 | @c FIXME Tokens but no commands??? | |
506 | @item FULLDIR | |
507 | ||
508 | @item HELP | |
509 | @end ignore | |
510 | ||
511 | @item LIST | |
512 | Display full contents of the current archive, in ``verbose'' style | |
513 | regardless of the state of @code{VERBOSE}. The effect is like @samp{ar | |
514 | tv @var{archive}}). (This single command is a GNU @code{ld} | |
515 | enhancement, rather than present for MRI compatibility.) | |
516 | ||
517 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
518 | ||
519 | @item OPEN @var{archive} | |
520 | Opens an existing archive for use as the current archive (required for | |
521 | many other commands). Any changes as the result of subsequent commands | |
522 | will not actually affect @var{archive} until you next use @code{SAVE}. | |
523 | ||
524 | @item REPLACE @var{module}, @var{module}, @dots{} @var{module} | |
525 | In the current archive, replace each existing @var{module} (named in | |
526 | the @code{REPLACE} arguments) from files in the current working directory. | |
527 | To execute this command without errors, both the file, and the module in | |
528 | the current archive, must exist. | |
529 | ||
530 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
531 | ||
532 | @item VERBOSE | |
533 | Toggle an internal flag governing the output from @code{DIRECTORY}. | |
534 | When the flag is on, @code{DIRECTORY} output matches output from | |
b703c078 | 535 | @samp{ar -tv }@dots{}. |
765a273f RP |
536 | |
537 | @item SAVE | |
538 | Commit your changes to the current archive, and actually save it as a | |
539 | file with the name specified in the last @code{CREATE} or @code{OPEN} | |
540 | command. | |
541 | ||
542 | Requires prior use of @code{OPEN} or @code{CREATE}. | |
c72af735 RP |
543 | |
544 | @end table | |
545 | ||
df14d957 ILT |
546 | @node objcopy, nm, ar, Top |
547 | @chapter objcopy | |
e31e9a8d JO |
548 | |
549 | @smallexample | |
df14d957 ILT |
550 | objcopy [ -F @var{format} | --format=@var{format} ] |
551 | [ -I @var{format} | --input-format=@var{format} ] | |
552 | [ -O @var{format} | --output-format=@var{format} ] | |
553 | [ -S | --strip-all ] [ -g | --strip-debug ] | |
554 | [ -x | --discard-all ] [ -X | --discard-locals ] | |
b26ac613 | 555 | [ -v | --verbose ] [ -V | --version ] [ --help ] |
df14d957 | 556 | @var{infile} [@var{outfile}] |
e31e9a8d JO |
557 | @end smallexample |
558 | ||
df14d957 ILT |
559 | The GNU @code{objcopy} utility copies the contents of an object file to |
560 | another. @code{objcopy} uses the GNU BFD Library to read and write the | |
918c2f61 PB |
561 | object files. It can write the destination object file in a format |
562 | different from that of the source object file. The exact behavior of | |
df14d957 | 563 | @code{objcopy} is controlled by command-line options. |
e31e9a8d | 564 | |
df14d957 ILT |
565 | @code{objcopy} creates temporary files to do its translations and |
566 | deletes them afterward. @code{objcopy} uses BFD to do all its | |
e31e9a8d JO |
567 | translation work; it knows about all the formats BFD knows about, and |
568 | thus is able to recognize most formats without being told explicitly. | |
569 | @xref{BFD,,BFD,ld.info,Using LD, the GNU linker}. | |
570 | ||
571 | @table @code | |
918c2f61 PB |
572 | @item @var{infile} |
573 | @itemx @var{outfile} | |
574 | The source and output files respectively. | |
df14d957 | 575 | If you do not specify @var{outfile}, @code{objcopy} creates a |
918c2f61 PB |
576 | temporary file and destructively renames the result with |
577 | the name of the input file. | |
578 | ||
579 | @item -I @var{format} | |
580 | @itemx --input-format=@var{format} | |
ec40bbb8 | 581 | Consider the source file's object format to be @var{format}, rather than |
918c2f61 PB |
582 | attempting to deduce it. |
583 | ||
584 | @item -O @var{format} | |
585 | @itemx --output-format=@var{format} | |
ec40bbb8 | 586 | Write the output file using the object format @var{format}. |
918c2f61 PB |
587 | |
588 | @item -F @var{format} | |
589 | @itemx --format=@var{format} | |
590 | Use @var{format} as the object format for both the input and the output | |
591 | file; i.e. simply transfer data from source to destination with no | |
592 | translation. | |
e31e9a8d | 593 | |
918c2f61 PB |
594 | @item -S |
595 | @itemx --strip-all | |
596 | Do not copy relocation and symbol information from the source file. | |
e31e9a8d | 597 | |
918c2f61 PB |
598 | @item -g |
599 | @itemx --strip-debug | |
600 | Do not copy debugging symbols from the source file. | |
e31e9a8d | 601 | |
918c2f61 PB |
602 | @item -x |
603 | @itemx --discard-all | |
604 | Do not copy non-global symbols from the source file. | |
605 | @c FIXME any reason to prefer "non-global" to "local" here? | |
e31e9a8d | 606 | |
918c2f61 PB |
607 | @item -X |
608 | @itemx --discard-locals | |
609 | Do not copy compiler-generated local symbols. | |
610 | (These usually start with @samp{L} or @samp{.}.) | |
e31e9a8d JO |
611 | |
612 | @item -V | |
918c2f61 | 613 | @itemx --version |
df14d957 | 614 | Show the version number of @code{objcopy}. |
e31e9a8d | 615 | |
918c2f61 PB |
616 | @item -v |
617 | @itemx --verbose | |
618 | Verbose output: list all object files modified. In the case of | |
df14d957 | 619 | archives, @samp{objcopy -V} lists all members of the archive. |
b26ac613 DM |
620 | |
621 | @item --help | |
622 | Show a summary of the options to @code{objcopy}. | |
e31e9a8d JO |
623 | @end table |
624 | ||
8b2c2275 RP |
625 | @iftex |
626 | @node ld | |
c72af735 RP |
627 | @chapter ld |
628 | @cindex linker | |
629 | @kindex ld | |
630 | The GNU linker @code{ld} is now described in a separate manual. | |
27e94bd5 | 631 | @xref{Top,, Overview,, Using LD: the GNU linker}. |
8b2c2275 | 632 | @end iftex |
c72af735 | 633 | |
df14d957 | 634 | @node nm, objdump, objcopy, Top |
c72af735 RP |
635 | @chapter nm |
636 | @cindex symbols | |
637 | @kindex nm | |
638 | ||
639 | @smallexample | |
d6a4c375 DM |
640 | nm [ -a | --debug-syms ] [ -g | --extern-only ] |
641 | [ -B ] [ -C | --demangle ] | |
6cfbdb50 DM |
642 | [ -s | --print-armap ] [ -A | -o | --print-file-name ] |
643 | [ -n | -v | --numeric-sort ] [ -p | --no-sort ] | |
4d9b5d5a | 644 | [ -r | --reverse-sort ] [ -u | --undefined-only ] |
6cfbdb50 DM |
645 | [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ] |
646 | [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ] | |
b26ac613 | 647 | [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ] |
c72af735 RP |
648 | @end smallexample |
649 | ||
b703c078 | 650 | GNU @code{nm} lists the symbols from object files @var{objfile}@dots{}. |
6cfbdb50 DM |
651 | If no object files are listed as arguments, @code{nm} assumes |
652 | @file{a.out}. | |
653 | ||
654 | For each symbol, @code{nm} shows: | |
655 | ||
656 | @itemize @bullet | |
657 | @item | |
658 | The symbol value, in the radix selected by options (see below), or | |
659 | hexadecimal by default. | |
660 | ||
661 | @item | |
662 | The symbol type. At least the following types are used; others are, as | |
663 | well, depending on the object file format. If lowercase, the symbol is | |
664 | local; if uppercase, the symbol is global (external). | |
665 | ||
666 | @c Some more detail on exactly what these symbol types are used for | |
667 | @c would be nice. | |
668 | @table @code | |
669 | @item A | |
670 | Absolute. | |
671 | ||
672 | @item B | |
673 | BSS (uninitialized data). | |
674 | ||
675 | @item C | |
676 | Common. | |
677 | ||
678 | @item D | |
679 | Initialized data. | |
680 | ||
681 | @item I | |
682 | Indirect reference. | |
683 | ||
684 | @item T | |
685 | Text (program code). | |
686 | ||
687 | @item U | |
688 | Undefined. | |
689 | @end table | |
690 | ||
691 | @item | |
692 | The symbol name. | |
693 | @end itemize | |
c72af735 RP |
694 | |
695 | The long and short forms of options, shown here as alternatives, are | |
696 | equivalent. | |
697 | ||
698 | @table @code | |
6cfbdb50 DM |
699 | @item -A |
700 | @itemx -o | |
701 | @itemx --print-file-name | |
702 | @cindex input file name | |
703 | @cindex file name | |
704 | @cindex source file name | |
705 | Precede each symbol by the name of the input file (or archive element) | |
706 | in which it was found, rather than identifying the input file once only, | |
707 | before all of its symbols. | |
c72af735 RP |
708 | |
709 | @item -a | |
918c2f61 | 710 | @itemx --debug-syms |
c72af735 | 711 | @cindex debugging symbols |
6cfbdb50 DM |
712 | Display all symbols, even debugger-only symbols; normally these are not |
713 | listed. | |
714 | ||
68dd5295 DM |
715 | @item -B |
716 | @cindex @code{nm} format | |
717 | @cindex @code{nm} compatibility | |
d6a4c375 DM |
718 | The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}). |
719 | ||
720 | @item -C | |
721 | @itemx --demangle | |
722 | @cindex demangling C++ symbols | |
723 | Decode (@dfn{demangle}) low-level symbol names into user-level names. | |
724 | Besides removing any initial underscore prepended by the system, this | |
725 | makes C++ function names readable. @xref{c++filt}, for more information | |
726 | on demangling. | |
68dd5295 | 727 | |
6cfbdb50 DM |
728 | @item -f @var{format} |
729 | @itemx --format=@var{format} | |
68dd5295 DM |
730 | @cindex @code{nm} format |
731 | @cindex @code{nm} compatibility | |
6cfbdb50 DM |
732 | Use the output format @var{format}, which can be @code{bsd}, |
733 | @code{sysv}, or @code{posix}. The default is @code{bsd}. | |
b26ac613 | 734 | Only the first character of @var{format} is significant; it can be |
6cfbdb50 | 735 | either upper or lower case. |
c72af735 RP |
736 | |
737 | @item -g | |
918c2f61 | 738 | @itemx --extern-only |
c72af735 RP |
739 | @cindex external symbols |
740 | Display only external symbols. | |
741 | ||
b26ac613 DM |
742 | @item -n |
743 | @itemx -v | |
744 | @itemx --numeric-sort | |
745 | Sort symbols numerically by their addresses, rather than alphabetically | |
746 | by their names. | |
747 | ||
c72af735 | 748 | @item -p |
918c2f61 | 749 | @itemx --no-sort |
c72af735 | 750 | @cindex sorting symbols |
650a49f0 | 751 | Do not bother to sort the symbols in any order; print them in the order |
6cfbdb50 DM |
752 | encountered. |
753 | ||
754 | @item -P | |
755 | @itemx --portability | |
756 | Use the POSIX.2 standard output format instead of the default format. | |
757 | Equivalent to @samp{-f posix}. | |
c72af735 | 758 | |
c72af735 | 759 | @item -s |
918c2f61 | 760 | @itemx --print-armap |
c72af735 RP |
761 | @cindex symbol index, listing |
762 | When listing symbols from archive members, include the index: a mapping | |
ec40bbb8 DM |
763 | (stored in the archive by @code{ar} or @code{ranlib}) of which modules |
764 | contain definitions for which names. | |
c72af735 | 765 | |
c72af735 | 766 | @item -r |
918c2f61 | 767 | @itemx --reverse-sort |
ec40bbb8 | 768 | Reverse the order of the sort (whether numeric or alphabetic); let the |
c72af735 RP |
769 | last come first. |
770 | ||
6cfbdb50 DM |
771 | @item -t @var{radix} |
772 | @itemx --radix=@var{radix} | |
773 | Use @var{radix} as the radix for printing the symbol values. It must be | |
774 | @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal. | |
775 | ||
ec40bbb8 | 776 | @item --target=@var{bfdname} |
c72af735 RP |
777 | @cindex object code format |
778 | Specify an object code format other than your system's default format. | |
779 | @xref{objdump}, for information on listing available formats. | |
c72af735 RP |
780 | |
781 | @item -u | |
918c2f61 | 782 | @itemx --undefined-only |
c72af735 RP |
783 | @cindex external symbols |
784 | @cindex undefined symbols | |
785 | Display only undefined symbols (those external to each object file). | |
786 | ||
6cfbdb50 DM |
787 | @item -V |
788 | @itemx --version | |
b26ac613 DM |
789 | Show the version number of @code{nm} and exit. |
790 | ||
791 | @item --help | |
792 | Show a summary of the options to @code{nm} and exit. | |
c72af735 RP |
793 | @end table |
794 | ||
795 | @node objdump, ranlib, nm, Top | |
796 | @chapter objdump | |
797 | ||
798 | @cindex object file information | |
799 | @kindex objdump | |
800 | ||
801 | @smallexample | |
4d9b5d5a DM |
802 | objdump [ -a ] [ -b @var{bfdname} ] [ -d ] [ -f ] |
803 | [ -h | --header ] [ -i ] [ -j @var{section} ] [ -l ] | |
b26ac613 DM |
804 | [ -m @var{machine} ] [ -r | --reloc ] [ -s ] [ --stabs ] |
805 | [ -t | --syms ] [ -x ] [ --version ] [ --help ] | |
4d9b5d5a | 806 | @var{objfile}@dots{} |
c72af735 RP |
807 | @end smallexample |
808 | ||
809 | @code{objdump} displays information about one or more object files. | |
810 | The options control what particular information to display. This | |
811 | information is mostly useful to programmers who are working on the | |
812 | compilation tools, as opposed to programmers who just want their | |
813 | program to compile and work. | |
814 | ||
b26ac613 DM |
815 | @var{objfile}@dots{} are the object files to be examined. When you |
816 | specify archives, @code{objdump} shows information on each of the member | |
817 | object files. | |
818 | ||
c72af735 | 819 | The long and short forms of options, shown here as alternatives, are |
ed78872a | 820 | equivalent. At least one option besides @samp{-l} must be given. |
c72af735 RP |
821 | |
822 | @table @code | |
c72af735 RP |
823 | @item -a |
824 | @c print_arelt_descr | |
825 | @cindex archive headers | |
ec40bbb8 | 826 | If any of the @var{objfile} files are archives, display the archive |
c72af735 RP |
827 | header information (in a format similar to @samp{ls -l}). Besides the |
828 | information you could list with @samp{ar tv}, @samp{objdump -a} shows | |
829 | the object file format of each archive member. | |
830 | ||
c5f0c938 | 831 | @c suggest longname --target or --format or --bfd |
c72af735 RP |
832 | @item -b @var{bfdname} |
833 | @cindex object code format | |
ec40bbb8 DM |
834 | Specify that the object-code format for the object files is |
835 | @var{bfdname}. This option may not be necessary; @var{objdump} can | |
836 | automatically recognize many formats. | |
837 | ||
838 | For example, | |
c72af735 RP |
839 | @example |
840 | objdump -b oasys -m vax -h fu.o | |
841 | @end example | |
842 | @noindent | |
ec40bbb8 DM |
843 | displays summary information from the section headers (@samp{-h}) of |
844 | @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object | |
c72af735 RP |
845 | file in the format produced by Oasys compilers. You can list the |
846 | formats available with the @samp{-i} option. | |
847 | ||
848 | @item -d | |
849 | @cindex disassembling object code | |
850 | @cindex machine instructions | |
851 | Disassemble. Display the assembler mnemonics for the machine | |
ec40bbb8 | 852 | instructions from @var{objfile}. |
c72af735 RP |
853 | |
854 | @item -f | |
855 | @cindex object file header | |
856 | File header. Display summary information from the overall header of | |
ec40bbb8 | 857 | each of the @var{objfile} files. |
c72af735 RP |
858 | |
859 | @item -h | |
c5f0c938 | 860 | @itemx --header |
c72af735 RP |
861 | @cindex section headers |
862 | Header. Display summary information from the section headers of the | |
863 | object file. | |
864 | ||
b26ac613 DM |
865 | @item --help |
866 | Print a summary of the options to @code{objdump} and exit. | |
867 | ||
c72af735 RP |
868 | @item -i |
869 | @cindex architectures available | |
870 | @cindex object formats available | |
871 | Display a list showing all architectures and object formats available | |
ec40bbb8 | 872 | for specification with @samp{-b} or @samp{-m}. |
c72af735 | 873 | |
c5f0c938 | 874 | @c suggest longname --section |
c72af735 RP |
875 | @item -j @var{name} |
876 | @cindex section information | |
ec40bbb8 | 877 | Display information only for section @var{name}. |
c72af735 | 878 | |
c5f0c938 | 879 | @c suggest longname --label or --linespec |
c72af735 RP |
880 | @item -l |
881 | @cindex source filenames for object files | |
882 | Label the display (using debugging information) with the source filename | |
883 | and line numbers corresponding to the object code shown. | |
884 | ||
c5f0c938 | 885 | @c suggest longname --architecture |
c72af735 RP |
886 | @item -m @var{machine} |
887 | @cindex architecture | |
ec40bbb8 | 888 | Specify that the object files @var{objfile} are for architecture |
c72af735 RP |
889 | @var{machine}. You can list available architectures using the @samp{-i} |
890 | option. | |
891 | ||
892 | @item -r | |
c5f0c938 | 893 | @itemx --reloc |
c72af735 RP |
894 | @cindex relocation entries, in object file |
895 | Relocation. Print the relocation entries of the file. | |
896 | ||
897 | @item -s | |
898 | @cindex sections, full contents | |
899 | @cindex object file sections | |
900 | Display the full contents of any sections requested. | |
901 | ||
c5f0c938 JG |
902 | @item --stabs |
903 | @cindex stab | |
904 | @cindex .stab | |
905 | @cindex debug symbols | |
906 | @cindex ELF object file format | |
c3c93fda JG |
907 | Display the full contents of any sections requested. Display the |
908 | contents of the .stab and .stab.index and .stab.excl sections from an | |
909 | ELF file. This is only useful on systems (such as Solaris 2.0) in which | |
910 | @code{.stab} debugging symbol-table entries are carried in an ELF | |
911 | section. In most other file formats, debugging symbol-table entries are | |
c5f0c938 JG |
912 | interleaved with linkage symbols, and are visible in the @samp{--syms} |
913 | output. | |
914 | ||
c72af735 | 915 | @item -t |
c5f0c938 | 916 | @itemx --syms |
c72af735 RP |
917 | @cindex symbol table entries, printing |
918 | Symbol Table. Print the symbol table entries of the file. | |
919 | This is similar to the information provided by the @samp{nm} program. | |
920 | ||
b26ac613 DM |
921 | @item --version |
922 | Print the version number of @code{objdump} and exit. | |
923 | ||
c72af735 RP |
924 | @item -x |
925 | @cindex all header information, object file | |
926 | @cindex header information, all | |
927 | Display all available header information, including the symbol table and | |
928 | relocation entries. Using @samp{-x} is equivalent to specifying all of | |
929 | @samp{-a -f -h -r -t}. | |
c72af735 RP |
930 | @end table |
931 | ||
932 | @node ranlib, size, objdump, Top | |
933 | @chapter ranlib | |
934 | ||
935 | @kindex ranlib | |
936 | @cindex archive contents | |
937 | @cindex symbol index | |
938 | ||
939 | @smallexample | |
4d9b5d5a | 940 | ranlib [-vV] @var{archive} |
c72af735 RP |
941 | @end smallexample |
942 | ||
ec40bbb8 | 943 | @code{ranlib} generates an index to the contents of an archive and |
c72af735 RP |
944 | stores it in the archive. The index lists each symbol defined by a |
945 | member of an archive that is a relocatable object file. | |
946 | ||
918c2f61 | 947 | You may use @samp{nm -s} or @samp{nm --print-armap} to list this index. |
c72af735 | 948 | |
ec40bbb8 | 949 | An archive with such an index speeds up linking to the library and |
c72af735 RP |
950 | allows routines in the library to call each other without regard to |
951 | their placement in the archive. | |
952 | ||
953 | The GNU @code{ranlib} program is another form of GNU @code{ar}; running | |
954 | @code{ranlib} is completely equivalent to executing @samp{ar -s}. | |
955 | @xref{ar}. | |
956 | ||
4d9b5d5a DM |
957 | @table @code |
958 | @item -v | |
959 | @itemx -V | |
960 | Show the version number of @code{ranlib}. | |
c3f471a4 | 961 | @end table |
4d9b5d5a | 962 | |
ba7c8e29 | 963 | @node size, strings, ranlib, Top |
c72af735 RP |
964 | @chapter size |
965 | ||
966 | @kindex size | |
967 | @cindex section sizes | |
968 | ||
969 | @smallexample | |
4d9b5d5a DM |
970 | size [ -A | -B | --format=@var{compatibility} ] |
971 | [ --help ] [ -d | -o | -x | --radix=@var{number} ] | |
972 | [ --target=@var{bfdname} ] [ -V | --version ] | |
973 | @var{objfile}@dots{} | |
c72af735 RP |
974 | @end smallexample |
975 | ||
976 | The GNU @code{size} utility lists the section sizes---and the total | |
ec40bbb8 DM |
977 | size---for each of the object or archive files @var{objfile} in its |
978 | argument list. By default, one line of output is generated for each | |
979 | object file or each module in an archive. | |
c72af735 | 980 | |
b26ac613 DM |
981 | @var{objfile}@dots{} are the object files to be examined. |
982 | ||
c72af735 | 983 | The command line options have the following meanings: |
c72af735 | 984 | |
b26ac613 | 985 | @table @code |
c72af735 RP |
986 | @item -A |
987 | @itemx -B | |
ec40bbb8 | 988 | @itemx --format=@var{compatibility} |
68dd5295 | 989 | @cindex @code{size} display format |
c72af735 RP |
990 | Using one of these options, you can choose whether the output from GNU |
991 | @code{size} resembles output from System V @code{size} (using @samp{-A}, | |
ec40bbb8 DM |
992 | or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or |
993 | @samp{--format=berkeley}). The default is the one-line format similar to | |
c72af735 | 994 | Berkeley's. |
918c2f61 PB |
995 | @c Bonus for doc-source readers: you can also say --format=strange (or |
996 | @c anything else that starts with 's') for sysv, and --format=boring (or | |
c72af735 RP |
997 | @c anything else that starts with 'b') for Berkeley. |
998 | ||
999 | Here is an example of the Berkeley (default) format of output from | |
1000 | @code{size}: | |
1001 | @smallexample | |
4d9b5d5a | 1002 | size --format Berkeley ranlib size |
c72af735 RP |
1003 | text data bss dec hex filename |
1004 | 294880 81920 11592 388392 5ed28 ranlib | |
1005 | 294880 81920 11888 388688 5ee50 size | |
1006 | @end smallexample | |
1007 | ||
1008 | @noindent | |
1009 | This is the same data, but displayed closer to System V conventions: | |
1010 | ||
1011 | @smallexample | |
4d9b5d5a | 1012 | size --format SysV ranlib size |
c72af735 RP |
1013 | ranlib : |
1014 | section size addr | |
1015 | .text 294880 8192 | |
1016 | .data 81920 303104 | |
1017 | .bss 11592 385024 | |
1018 | Total 388392 | |
1019 | ||
1020 | ||
1021 | size : | |
1022 | section size addr | |
1023 | .text 294880 8192 | |
1024 | .data 81920 303104 | |
1025 | .bss 11888 385024 | |
1026 | Total 388688 | |
1027 | @end smallexample | |
1028 | ||
918c2f61 | 1029 | @item --help |
c72af735 RP |
1030 | Show a summary of acceptable arguments and options. |
1031 | ||
1032 | @item -d | |
1033 | @itemx -o | |
1034 | @itemx -x | |
ec40bbb8 | 1035 | @itemx --radix=@var{number} |
68dd5295 | 1036 | @cindex @code{size} number format |
c72af735 RP |
1037 | @cindex radix for section sizes |
1038 | Using one of these options, you can control whether the size of each | |
ec40bbb8 DM |
1039 | section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal |
1040 | (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or | |
1041 | @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three | |
c72af735 RP |
1042 | values (8, 10, 16) are supported. The total size is always given in two |
1043 | radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or | |
1044 | octal and hexadecimal if you're using @samp{-o}. | |
1045 | ||
ec40bbb8 | 1046 | @item --target=@var{bfdname} |
c72af735 | 1047 | @cindex object code format |
ec40bbb8 DM |
1048 | Specify that the object-code format for @var{objfile} is |
1049 | @var{bfdname}. This option may not be necessary; @code{size} can | |
c72af735 RP |
1050 | automatically recognize many formats. @xref{objdump}, for information |
1051 | on listing available formats. | |
1052 | ||
1053 | @item -V | |
918c2f61 | 1054 | @itemx --version |
4d9b5d5a | 1055 | Display the version number of @code{size}. |
c72af735 RP |
1056 | @end table |
1057 | ||
ba7c8e29 DM |
1058 | @node strings, strip, size, Top |
1059 | @chapter strings | |
1060 | @kindex strings | |
1061 | @cindex listings strings | |
1062 | @cindex printing strings | |
1063 | @cindex strings, printing | |
1064 | ||
1065 | @smallexample | |
b26ac613 | 1066 | strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-] |
650a49f0 RP |
1067 | [--all] [--print-file-name] [--bytes=@var{min-len}] |
1068 | [--radix=@var{radix}] [--help] [--version] @var{file}@dots{} | |
ba7c8e29 DM |
1069 | @end smallexample |
1070 | ||
1071 | For each @var{file} given, GNU @code{strings} prints the printable | |
1072 | character sequences that are at least 4 characters long (or the number | |
1073 | given with the options below) and are followed by a NUL or newline | |
1074 | character. By default, it only prints the strings from the initialized | |
1075 | data sections of object files; for other types of files, it prints the | |
1076 | strings from the whole file. | |
1077 | ||
1078 | @code{strings} is mainly useful for determining the contents of non-text | |
1079 | files. | |
1080 | ||
1081 | @table @code | |
1082 | @item -a | |
1083 | @itemx --all | |
1084 | @itemx - | |
1085 | Do not scan only the initialized data section of object files; scan | |
1086 | the whole files. | |
1087 | ||
1088 | @item -f | |
1089 | @itemx --print-file-name | |
1090 | Print the name of the file before each string. | |
1091 | ||
b26ac613 | 1092 | @item --help |
ba7c8e29 DM |
1093 | Print a summary of the program usage on the standard output and exit. |
1094 | ||
ba7c8e29 | 1095 | @itemx -@var{min-len} |
b26ac613 | 1096 | @item -n @var{min-len} |
ba7c8e29 DM |
1097 | @itemx --bytes=@var{min-len} |
1098 | Print sequences of characters that are at least @var{min-len} characters | |
1099 | long, instead of the default 4. | |
1100 | ||
1101 | @item -o | |
b26ac613 DM |
1102 | Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o} |
1103 | act like @samp{-t d} instead. Since we can not be compatible with both | |
1104 | ways, we simply chose one. | |
ba7c8e29 DM |
1105 | |
1106 | @item -t @var{radix} | |
1107 | @itemx --radix=@var{radix} | |
1108 | Print the offset within the file before each string. The single | |
1109 | character argument specifies the radix of the offset---@samp{o} for | |
1110 | octal, @samp{x} for hexadecimal, or @samp{d} for decimal. | |
1111 | ||
1112 | @item -v | |
1113 | @itemx --version | |
1114 | Print the program version number on the standard output and exit. | |
1115 | @end table | |
1116 | ||
1117 | @node strip, c++filt, strings, Top | |
c72af735 RP |
1118 | @chapter strip |
1119 | ||
1120 | @kindex strip | |
1121 | @cindex removing symbols | |
1122 | @cindex discarding symbols | |
1815e42c | 1123 | @cindex symbols, discarding |
c72af735 RP |
1124 | |
1125 | @smallexample | |
b703c078 DM |
1126 | strip [ -F @var{format} | --format=@var{format} | --target=@var{format} ] |
1127 | [ -I @var{format} | --input-format=@var{format} ] | |
1128 | [ -O @var{format} | --output-format=@var{format} ] | |
1129 | [ -s | --strip-all ] [ -S | -g | --strip-debug ] | |
1130 | [ -x | --discard-all ] [ -X | --discard-locals ] | |
b26ac613 | 1131 | [ -v | --verbose ] [ -V | --version ] [ --help ] |
b703c078 | 1132 | @var{objfile}@dots{} |
c72af735 RP |
1133 | @end smallexample |
1134 | ||
e31e9a8d | 1135 | GNU @code{strip} discards all symbols from object files |
ec40bbb8 | 1136 | @var{objfile}. The list of object files may include archives. |
b26ac613 | 1137 | At least one object file must be given. |
c72af735 | 1138 | |
ec40bbb8 | 1139 | @code{strip} modifies the files named in its argument, |
c72af735 | 1140 | rather than writing modified copies under different names. |
c72af735 | 1141 | |
c72af735 | 1142 | @table @code |
b26ac613 DM |
1143 | @item -F @var{format} |
1144 | @itemx --format=@var{format} | |
1145 | @itemx --target=@var{format} | |
1146 | Treat the original @var{objfile} as a file with the object | |
1147 | code format @var{format}, and rewrite it in the same format. | |
1148 | ||
1149 | @item --help | |
1150 | Show a summary of the options to @code{strip} and exit. | |
1151 | ||
918c2f61 PB |
1152 | @item -I @var{format} |
1153 | @itemx --input-format=@var{format} | |
ec40bbb8 DM |
1154 | Treat the original @var{objfile} as a file with the object |
1155 | code format @var{format}. | |
918c2f61 PB |
1156 | |
1157 | @item -O @var{format} | |
1158 | @itemx --output-format=@var{format} | |
ec40bbb8 | 1159 | Replace @var{objfile} with a file in the output format @var{format}. |
918c2f61 | 1160 | |
b703c078 DM |
1161 | @item -s |
1162 | @itemx --strip-all | |
1163 | Remove all symbols. | |
1164 | ||
918c2f61 PB |
1165 | @item -g |
1166 | @itemx -S | |
1167 | @itemx --strip-debug | |
1168 | Remove debugging symbols only. | |
1169 | ||
1170 | @item -x | |
1171 | @itemx --discard-all | |
1172 | Remove non-global symbols. | |
1173 | ||
1174 | @item -X | |
1175 | @itemx --discard-locals | |
1176 | Remove compiler-generated local symbols. | |
ec40bbb8 | 1177 | (These usually start with @samp{L} or @samp{.}.) |
918c2f61 PB |
1178 | |
1179 | @item -V | |
1180 | @itemx --version | |
ec40bbb8 | 1181 | Show the version number for @code{strip}. |
918c2f61 | 1182 | |
1815e42c | 1183 | @item -v |
918c2f61 PB |
1184 | @itemx --verbose |
1185 | Verbose output: list all object files modified. In the case of | |
1269d441 | 1186 | archives, @samp{strip -v} lists all members of the archive. |
c72af735 RP |
1187 | @end table |
1188 | ||
b6216af2 PB |
1189 | @node c++filt, Index, strip, Top |
1190 | @chapter c++filt | |
1191 | ||
1192 | @kindex c++filt | |
1193 | @cindex demangling C++ symbols | |
1194 | ||
b26ac613 DM |
1195 | @smallexample |
1196 | c++filt [ -_ | --strip-underscores ] | |
1197 | [ -s @var{format} | --format=@var{format} ] | |
d6a4c375 | 1198 | [ --help ] [ --version ] [ @var{symbol}@dots{} ] |
b26ac613 DM |
1199 | @end smallexample |
1200 | ||
6c69b6bd JO |
1201 | The C++ language provides function overloading, which means that you can |
1202 | write many functions with the same name (providing each takes parameters | |
1203 | of different types). All C++ function names are encoded into a | |
b26ac613 | 1204 | low-level assembly label (this process is known as |
6c69b6bd JO |
1205 | @dfn{mangling}). The @code{c++filt} program does the inverse mapping: it |
1206 | decodes (@dfn{demangles}) low-level names into user-level names so that | |
1207 | the linker can keep these overloaded functions from clashing. | |
1208 | ||
1209 | Every alphanumeric word (consisting of letters, digits, underscores, | |
1210 | dollars, or periods) seen in the input is a potential label. If the | |
1211 | label decodes into a C++ name, the C++ name replaces the low-level | |
1212 | name in the output. | |
b6216af2 | 1213 | |
d6a4c375 | 1214 | You can use @code{c++filt} to decipher individual symbols: |
6c69b6bd JO |
1215 | |
1216 | @example | |
1217 | c++filt @var{symbol} | |
1218 | @end example | |
1219 | ||
d6a4c375 DM |
1220 | If no @var{symbol} arguments are given, @code{c++filt} reads symbol |
1221 | names from the standard input and writes the demangled names to the | |
1222 | standard output. All results are printed on the standard output. | |
b6216af2 | 1223 | |
b26ac613 DM |
1224 | @table @code |
1225 | @item -_ | |
1226 | @item --strip-underscores | |
1227 | On some systems, both the C and C++ compilers put an underscore in front | |
1228 | of every name. For example, the C name @code{foo} gets the low-level | |
1229 | name @code{_foo}. This option removes the initial underscore. | |
1230 | ||
1231 | @item -s @var{format} | |
1232 | @itemx --format=@var{format} | |
1233 | GNU @code{nm} can decode three different methods of mangling, used by | |
1234 | different C++ compilers. The argument to this option selects which | |
1235 | method it uses: | |
1236 | ||
1237 | @table @code | |
1238 | @item gnu | |
1239 | the one used by the GNU compiler (the default method) | |
1240 | @item lucid | |
1241 | the one used by the Lucid compiler | |
1242 | @item arm | |
1243 | the one specified by the C++ Annotated Reference Manual | |
1244 | @end table | |
1245 | ||
1246 | @item --help | |
1247 | Print a summary of the options to @code{c++filt} and exit. | |
1248 | ||
1249 | @item --version | |
1250 | Print the version number of @code{c++filt} and exit. | |
1251 | @end table | |
b6216af2 | 1252 | |
5eac46ae JO |
1253 | @quotation |
1254 | @emph{Warning:} @code{c++filt} is a new utility, and the details of its | |
1255 | user interface are subject to change in future releases. In particular, | |
1256 | a command-line option may be required in the the future to decode a name | |
1257 | passed as an argument on the command line; in other words, | |
1258 | ||
1259 | @example | |
b26ac613 | 1260 | c++filt @var{symbol} |
5eac46ae JO |
1261 | @end example |
1262 | ||
1263 | @noindent | |
1264 | may in a future release become | |
1265 | ||
1266 | @example | |
b26ac613 | 1267 | c++filt @var{option} @var{symbol} |
5eac46ae JO |
1268 | @end example |
1269 | @end quotation | |
1270 | ||
b6216af2 | 1271 | @node Index, , c++filt, Top |
c72af735 RP |
1272 | @unnumbered Index |
1273 | ||
1274 | @printindex cp | |
1275 | ||
1276 | @contents | |
1277 | @bye |