Merge from vendor branch GCC:
[dragonfly.git] / contrib / binutils / binutils / strings.1
1 .\" Copyright (c) 1993, 94, 95, 2000 Free Software Foundation
2 .\" See section COPYING for conditions for redistribution
3 .TH strings 1 "09 March 2000" "Free Software Foundation" "GNU Development Tools"
4 .de BP
5 .sp
6 .ti \-.2i
7 \(**
8 ..
9
10 .SH NAME
11 strings \- print the strings of printable characters in files
12
13 .SH SYNOPSIS
14 .hy 0
15 .na
16 .TP
17 .B strings
18 .RB "[\|" \-a | \-\c
19 .RB | \-\-all "\|]" 
20 .RB "[\|" \-f | \-\-print\-file\-name "\|]"
21 .RB "[\|" \-o "\|]" 
22 .RB "[\|" \-\-help "\|]" 
23 .RB "[\|" \-v | \-\-version "\|]"  
24 .RB "[\|" \-n
25 .I min\-len\c
26 .RI | \-min\-len\c
27 .RB | "\-\-bytes="\c
28 .I min\-len\c
29 \&\|]
30 .RB "[\|" \-t
31 .I {o,x,d}\c
32 .RB "[\|" "\-\-target=\fIbfdname" "\|]"
33 .RB | "\-\-radix="\c
34 .I {o,x,d}\c
35 \&\|]
36 .I file\c
37 .ad b
38 .hy 1
39 .SH DESCRIPTION
40 For each
41 .I file
42 given, GNU \c
43 .B strings
44 prints the printable character sequences that are at least 4
45 characters long (or the number given with the options below) and are
46 followed by an unprintable character.  By default, it only prints the
47 strings from the initialized and loaded sections of object files; for
48 other types of files, it prints the strings from the whole file.
49
50 .PP
51 .B strings
52 is mainly useful for determining the contents of non-text files.
53
54 .SH OPTIONS
55 The long and short forms of options, shown here as alternatives, are
56 equivalent.
57
58 .TP
59 .B \-a
60 .TP
61 .B \-\-all
62 .TP
63 .B \-
64 Do not scan only the initialized and loaded sections of object files;
65 scan the whole files.
66
67 .TP
68 .B \-f
69 .TP
70 .B \-\-print\-file\-name
71 Print the name of the file before each string.
72
73 .TP
74 .B \-\-help
75 Print a summary of the options to
76 .B strings
77 on the standard output and exit.
78
79 .TP
80 .B \-v
81 .TP
82 .B \-\-version
83 Print the version number
84 of
85 .B strings
86 on the standard output and exit.
87
88 .TP
89 .B "\-n \fImin\-len\fP"
90 .TP
91 .B "\-\fImin\-len\fP"
92 .TP
93 .B "\-\-bytes=\fImin\-len\fP"
94 Print sequences of characters that are at least
95 .I min\-len
96 characters long, instead of the default 4.
97
98 .TP
99 .BR "\-t " {o,x,d}
100 .TP
101 .BR "\-\-radix=" {o,x,d}
102 Print the offset within the file before each string.  The single
103 character argument specifies the radix of the offset\(emoctal,
104 hexadecimal, or decimal.
105
106 .TP
107 .BI "\-\-target=" "bfdname"
108 Specify an object code format other than your system's default format.
109 See 
110 .BR objdump ( 1 ),
111 for information on listing available formats.
112
113 .TP
114 .B \-o
115 Like
116 .BR "\-t o" .
117
118 .PP
119
120 .SH "SEE ALSO"
121 .RB "`\|" binutils "\|'"
122 entry in 
123 .B
124 info\c
125 \&; 
126 .I
127 The GNU Binary Utilities\c
128 \&, Roland H. Pesch (October 1991);
129 .BR ar ( 1 ),
130 .BR nm ( 1 ),
131 .BR objdump ( 1 ),
132 .BR ranlib ( 1 ).
133
134
135 .SH COPYING
136 Copyright (c) 1993, 2000 Free Software Foundation, Inc.
137 .PP
138 This document is distributed under the terms of the GNU Free
139 Documentation License, version 1.1.  That license is described in the
140 sources for this manual page, but it is not displayed here in order to
141 make this manual more consise.  Copies of this license can also be
142 obtained from: http://www.gnu.org/copyleft/.
143
144 \"  .SH GNU Free Documentation License
145 \"    Version 1.1, March 2000
146
147 \"    Copyright (C) 2000  Free Software Foundation, Inc.
148 \"    59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
149      
150 \"    Everyone is permitted to copy and distribute verbatim
151 \"    copies of this license document, but changing it is
152 \"    not allowed.
153 \"  .PP
154 \"  0. PREAMBLE
155 \"  .PP
156 \"  The purpose of this License is to make a manual, textbook, or other
157 \"  written document "free" in the sense of freedom: to assure everyone
158 \"  the effective freedom to copy and redistribute it, with or without
159 \"  modifying it, either commercially or noncommercially.  Secondarily,
160 \"  this License preserves for the author and publisher a way to get
161 \"  credit for their work, while not being considered responsible for
162 \"  modifications made by others.
163 \"  .PP
164 \"  This License is a kind of "copyleft", which means that derivative
165 \"  works of the document must themselves be free in the same sense.  It
166 \"  complements the GNU General Public License, which is a copyleft
167 \"  license designed for free software.
168 \"  .PP
169 \"  We have designed this License in order to use it for manuals for free
170 \"  software, because free software needs free documentation: a free
171 \"  program should come with manuals providing the same freedoms that the
172 \"  software does.  But this License is not limited to software manuals;
173 \"  it can be used for any textual work, regardless of subject matter or
174 \"  whether it is published as a printed book.  We recommend this License
175 \"  principally for works whose purpose is instruction or reference.
176 \"  .PP
177 \"  1. APPLICABILITY AND DEFINITIONS
178 \"  .PP
179 \"  This License applies to any manual or other work that contains a
180 \"  notice placed by the copyright holder saying it can be distributed
181 \"  under the terms of this License.  The "Document", below, refers to any
182 \"  such manual or work.  Any member of the public is a licensee, and is
183 \"  addressed as "you".
184 \"  .PP
185 \"  A "Modified Version" of the Document means any work containing the
186 \"  Document or a portion of it, either copied verbatim, or with
187 \"  modifications and/or translated into another language.
188 \"  .PP
189 \"  A "Secondary Section" is a named appendix or a front-matter section of
190 \"  the Document that deals exclusively with the relationship of the
191 \"  publishers or authors of the Document to the Document's overall subject
192 \"  (or to related matters) and contains nothing that could fall directly
193 \"  within that overall subject.  (For example, if the Document is in part a
194 \"  textbook of mathematics, a Secondary Section may not explain any
195 \"  mathematics.)  The relationship could be a matter of historical
196 \"  connection with the subject or with related matters, or of legal,
197 \"  commercial, philosophical, ethical or political position regarding
198 \"  them.
199 \"  .PP
200 \"  The "Invariant Sections" are certain Secondary Sections whose titles
201 \"  are designated, as being those of Invariant Sections, in the notice
202 \"  that says that the Document is released under this License.
203 \"  .PP
204 \"  The "Cover Texts" are certain short passages of text that are listed,
205 \"  as Front-Cover Texts or Back-Cover Texts, in the notice that says that
206 \"  the Document is released under this License.
207 \"  .PP
208 \"  A "Transparent" copy of the Document means a machine-readable copy,
209 \"  represented in a format whose specification is available to the
210 \"  general public, whose contents can be viewed and edited directly and
211 \"  straightforwardly with generic text editors or (for images composed of
212 \"  pixels) generic paint programs or (for drawings) some widely available
213 \"  drawing editor, and that is suitable for input to text formatters or
214 \"  for automatic translation to a variety of formats suitable for input
215 \"  to text formatters.  A copy made in an otherwise Transparent file
216 \"  format whose markup has been designed to thwart or discourage
217 \"  subsequent modification by readers is not Transparent.  A copy that is
218 \"  not "Transparent" is called "Opaque".
219 \"  .PP
220 \"  Examples of suitable formats for Transparent copies include plain
221 \"  ASCII without markup, Texinfo input format, LaTeX input format, SGML
222 \"  or XML using a publicly available DTD, and standard-conforming simple
223 \"  HTML designed for human modification.  Opaque formats include
224 \"  PostScript, PDF, proprietary formats that can be read and edited only
225 \"  by proprietary word processors, SGML or XML for which the DTD and/or
226 \"  processing tools are not generally available, and the
227 \"  machine-generated HTML produced by some word processors for output
228 \"  purposes only.
229 \"  .PP
230 \"  The "Title Page" means, for a printed book, the title page itself,
231 \"  plus such following pages as are needed to hold, legibly, the material
232 \"  this License requires to appear in the title page.  For works in
233 \"  formats which do not have any title page as such, "Title Page" means
234 \"  the text near the most prominent appearance of the work's title,
235 \"  preceding the beginning of the body of the text.
236 \"  .PP
237 \"  2. VERBATIM COPYING
238 \"  .PP
239 \"  You may copy and distribute the Document in any medium, either
240 \"  commercially or noncommercially, provided that this License, the
241 \"  copyright notices, and the license notice saying this License applies
242 \"  to the Document are reproduced in all copies, and that you add no other
243 \"  conditions whatsoever to those of this License.  You may not use
244 \"  technical measures to obstruct or control the reading or further
245 \"  copying of the copies you make or distribute.  However, you may accept
246 \"  compensation in exchange for copies.  If you distribute a large enough
247 \"  number of copies you must also follow the conditions in section 3.
248 \"  .PP
249 \"  You may also lend copies, under the same conditions stated above, and
250 \"  you may publicly display copies.
251 \"  .PP
252 \"  3. COPYING IN QUANTITY
253 \"  .PP
254 \"  If you publish printed copies of the Document numbering more than 100,
255 \"  and the Document's license notice requires Cover Texts, you must enclose
256 \"  the copies in covers that carry, clearly and legibly, all these Cover
257 \"  Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
258 \"  the back cover.  Both covers must also clearly and legibly identify
259 \"  you as the publisher of these copies.  The front cover must present
260 \"  the full title with all words of the title equally prominent and
261 \"  visible.  You may add other material on the covers in addition.
262 \"  Copying with changes limited to the covers, as long as they preserve
263 \"  the title of the Document and satisfy these conditions, can be treated
264 \"  as verbatim copying in other respects.
265 \"  .PP
266 \"  If the required texts for either cover are too voluminous to fit
267 \"  legibly, you should put the first ones listed (as many as fit
268 \"  reasonably) on the actual cover, and continue the rest onto adjacent
269 \"  pages.
270 \"  .PP
271 \"  If you publish or distribute Opaque copies of the Document numbering
272 \"  more than 100, you must either include a machine-readable Transparent
273 \"  copy along with each Opaque copy, or state in or with each Opaque copy
274 \"  a publicly-accessible computer-network location containing a complete
275 \"  Transparent copy of the Document, free of added material, which the
276 \"  general network-using public has access to download anonymously at no
277 \"  charge using public-standard network protocols.  If you use the latter
278 \"  option, you must take reasonably prudent steps, when you begin
279 \"  distribution of Opaque copies in quantity, to ensure that this
280 \"  Transparent copy will remain thus accessible at the stated location
281 \"  until at least one year after the last time you distribute an Opaque
282 \"  copy (directly or through your agents or retailers) of that edition to
283 \"  the public.
284 \"  .PP
285 \"  It is requested, but not required, that you contact the authors of the
286 \"  Document well before redistributing any large number of copies, to give
287 \"  them a chance to provide you with an updated version of the Document.
288 \"  .PP
289 \"  4. MODIFICATIONS
290 \"  .PP
291 \"  You may copy and distribute a Modified Version of the Document under
292 \"  the conditions of sections 2 and 3 above, provided that you release
293 \"  the Modified Version under precisely this License, with the Modified
294 \"  Version filling the role of the Document, thus licensing distribution
295 \"  and modification of the Modified Version to whoever possesses a copy
296 \"  of it.  In addition, you must do these things in the Modified Version:
297 \"  .PP
298 \"  A. Use in the Title Page (and on the covers, if any) a title distinct
299 \"  from that of the Document, and from those of previous versions
300 \"  (which should, if there were any, be listed in the History section
301 \"  of the Document).  You may use the same title as a previous version
302 \"  if the original publisher of that version gives permission.
303 \"  .PP
304 \"  B. List on the Title Page, as authors, one or more persons or entities
305 \"  responsible for authorship of the modifications in the Modified
306 \"  Version, together with at least five of the principal authors of the
307 \"  Document (all of its principal authors, if it has less than five).
308 \"  .PP
309 \"  C. State on the Title page the name of the publisher of the
310 \"  Modified Version, as the publisher.
311 \"  .PP
312 \"  D. Preserve all the copyright notices of the Document.
313 \"  .PP
314 \"  E. Add an appropriate copyright notice for your modifications
315 \"  adjacent to the other copyright notices.
316 \"  .PP
317 \"  F. Include, immediately after the copyright notices, a license notice
318 \"  giving the public permission to use the Modified Version under the
319 \"  terms of this License, in the form shown in the Addendum below.
320 \"  Preserve in that license notice the full lists of Invariant Sections
321 \"  and required Cover Texts given in the Document's license notice.
322 \"  .PP
323 \"  H. Include an unaltered copy of this License.
324 \"  .PP
325 \"  I. Preserve the section entitled "History", and its title, and add to
326 \"  it an item stating at least the title, year, new authors, and
327 \"  publisher of the Modified Version as given on the Title Page.  If
328 \"  there is no section entitled "History" in the Document, create one
329 \"  stating the title, year, authors, and publisher of the Document as
330 \"  given on its Title Page, then add an item describing the Modified
331 \"  Version as stated in the previous sentence.
332 \"  .PP
333 \"  J. Preserve the network location, if any, given in the Document for
334 \"  public access to a Transparent copy of the Document, and likewise
335 \"  the network locations given in the Document for previous versions
336 \"  it was based on.  These may be placed in the "History" section.
337 \"  You may omit a network location for a work that was published at
338 \"  least four years before the Document itself, or if the original
339 \"  publisher of the version it refers to gives permission.
340 \"  .PP
341 \"  K. In any section entitled "Acknowledgements" or "Dedications",
342 \"  preserve the section's title, and preserve in the section all the
343 \"  substance and tone of each of the contributor acknowledgements
344 \"  and/or dedications given therein.
345 \"  .PP
346 \"  L. Preserve all the Invariant Sections of the Document,
347 \"  unaltered in their text and in their titles.  Section numbers
348 \"  or the equivalent are not considered part of the section titles.
349 \"  .PP
350 \"  M. Delete any section entitled "Endorsements".  Such a section
351 \"  may not be included in the Modified Version.
352 \"  .PP
353 \"  N. Do not retitle any existing section as "Endorsements"
354 \"  or to conflict in title with any Invariant Section.
355 \"  .PP
356 \"  If the Modified Version includes new front-matter sections or
357 \"  appendices that qualify as Secondary Sections and contain no material
358 \"  copied from the Document, you may at your option designate some or all
359 \"  of these sections as invariant.  To do this, add their titles to the
360 \"  list of Invariant Sections in the Modified Version's license notice.
361 \"  These titles must be distinct from any other section titles.
362 \"  .PP
363 \"  You may add a section entitled "Endorsements", provided it contains
364 \"  nothing but endorsements of your Modified Version by various
365 \"  parties--for example, statements of peer review or that the text has
366 \"  been approved by an organization as the authoritative definition of a
367 \"  standard.
368 \"  .PP
369 \"  You may add a passage of up to five words as a Front-Cover Text, and a
370 \"  passage of up to 25 words as a Back-Cover Text, to the end of the list
371 \"  of Cover Texts in the Modified Version.  Only one passage of
372 \"  Front-Cover Text and one of Back-Cover Text may be added by (or
373 \"  through arrangements made by) any one entity.  If the Document already
374 \"  includes a cover text for the same cover, previously added by you or
375 \"  by arrangement made by the same entity you are acting on behalf of,
376 \"  you may not add another; but you may replace the old one, on explicit
377 \"  permission from the previous publisher that added the old one.
378 \"  .PP
379 \"  The author(s) and publisher(s) of the Document do not by this License
380 \"  give permission to use their names for publicity for or to assert or
381 \"  imply endorsement of any Modified Version.
382 \"  .PP
383
384 \"  5. COMBINING DOCUMENTS
385 \"  .PP
386 \"  You may combine the Document with other documents released under this
387 \"  License, under the terms defined in section 4 above for modified
388 \"  versions, provided that you include in the combination all of the
389 \"  Invariant Sections of all of the original documents, unmodified, and
390 \"  list them all as Invariant Sections of your combined work in its
391 \"  license notice.
392 \"  .PP
393 \"  The combined work need only contain one copy of this License, and
394 \"  multiple identical Invariant Sections may be replaced with a single
395 \"  copy.  If there are multiple Invariant Sections with the same name but
396 \"  different contents, make the title of each such section unique by
397 \"  adding at the end of it, in parentheses, the name of the original
398 \"  author or publisher of that section if known, or else a unique number.
399 \"  Make the same adjustment to the section titles in the list of
400 \"  Invariant Sections in the license notice of the combined work.
401 \"  .PP
402 \"  In the combination, you must combine any sections entitled "History"
403 \"  in the various original documents, forming one section entitled
404 \"  "History"; likewise combine any sections entitled "Acknowledgements",
405 \"  and any sections entitled "Dedications".  You must delete all sections
406 \"  entitled "Endorsements."
407 \"  .PP
408
409 \"  6. COLLECTIONS OF DOCUMENTS
410 \"  .PP
411 \"  You may make a collection consisting of the Document and other documents
412 \"  released under this License, and replace the individual copies of this
413 \"  License in the various documents with a single copy that is included in
414 \"  the collection, provided that you follow the rules of this License for
415 \"  verbatim copying of each of the documents in all other respects.
416 \"  .PP
417 \"  You may extract a single document from such a collection, and distribute
418 \"  it individually under this License, provided you insert a copy of this
419 \"  License into the extracted document, and follow this License in all
420 \"  other respects regarding verbatim copying of that document.
421 \"  .PP
422
423 \"  7. AGGREGATION WITH INDEPENDENT WORKS
424 \"  .PP
425 \"  A compilation of the Document or its derivatives with other separate
426 \"  and independent documents or works, in or on a volume of a storage or
427 \"  distribution medium, does not as a whole count as a Modified Version
428 \"  of the Document, provided no compilation copyright is claimed for the
429 \"  compilation.  Such a compilation is called an "aggregate", and this
430 \"  License does not apply to the other self-contained works thus compiled
431 \"  with the Document, on account of their being thus compiled, if they
432 \"  are not themselves derivative works of the Document.
433 \"  .PP
434 \"  If the Cover Text requirement of section 3 is applicable to these
435 \"  copies of the Document, then if the Document is less than one quarter
436 \"  of the entire aggregate, the Document's Cover Texts may be placed on
437 \"  covers that surround only the Document within the aggregate.
438 \"  Otherwise they must appear on covers around the whole aggregate.
439 \"  .PP
440
441 \"  8. TRANSLATION
442 \"  .PP
443 \"  Translation is considered a kind of modification, so you may
444 \"  distribute translations of the Document under the terms of section 4.
445 \"  Replacing Invariant Sections with translations requires special
446 \"  permission from their copyright holders, but you may include
447 \"  translations of some or all Invariant Sections in addition to the
448 \"  original versions of these Invariant Sections.  You may include a
449 \"  translation of this License provided that you also include the
450 \"  original English version of this License.  In case of a disagreement
451 \"  between the translation and the original English version of this
452 \"  License, the original English version will prevail.
453 \"  .PP
454
455 \"  9. TERMINATION
456 \"  .PP
457 \"  You may not copy, modify, sublicense, or distribute the Document except
458 \"  as expressly provided for under this License.  Any other attempt to
459 \"  copy, modify, sublicense or distribute the Document is void, and will
460 \"  automatically terminate your rights under this License.  However,
461 \"  parties who have received copies, or rights, from you under this
462 \"  License will not have their licenses terminated so long as such
463 \"  parties remain in full compliance.
464 \"  .PP
465
466 \"  10. FUTURE REVISIONS OF THIS LICENSE
467 \"  .PP
468 \"  The Free Software Foundation may publish new, revised versions
469 \"  of the GNU Free Documentation License from time to time.  Such new
470 \"  versions will be similar in spirit to the present version, but may
471 \"  differ in detail to address new problems or concerns.  See
472 \"  http://www.gnu.org/copyleft/.
473 \"  .PP
474 \"  Each version of the License is given a distinguishing version number.
475 \"  If the Document specifies that a particular numbered version of this
476 \"  License "or any later version" applies to it, you have the option of
477 \"  following the terms and conditions either of that specified version or
478 \"  of any later version that has been published (not as a draft) by the
479 \"  Free Software Foundation.  If the Document does not specify a version
480 \"  number of this License, you may choose any version ever published (not
481 \"  as a draft) by the Free Software Foundation.
482 \"  .PP
483
484 \"  ADDENDUM: How to use this License for your documents
485 \"  .PP
486 \"  To use this License in a document you have written, include a copy of
487 \"  the License in the document and put the following copyright and
488 \"  license notices just after the title page:
489 \"  .PP
490 \"      Copyright (c)  YEAR  YOUR NAME.
491 \"      Permission is granted to copy, distribute and/or
492 \"      modify this document under the terms of the GNU
493 \"      Free Documentation License, Version 1.1 or any later
494 \"      version published by the Free Software Foundation;
495 \"      with the Invariant Sections being LIST THEIR TITLES,
496 \"      with the Front-Cover Texts being LIST, and with the
497 \"      Back-Cover Texts being LIST.  A copy of the license
498 \"      is included in the section entitled "GNU Free
499 \"      Documentation License".
500 \"  .PP
501 \"  If you have no Invariant Sections, write "with no Invariant Sections"
502 \"  instead of saying which ones are invariant.  If you have no
503 \"  Front-Cover Texts, write "no Front-Cover Texts" instead of
504 \"  "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
505 \"  .PP
506 \"  If your document contains nontrivial examples of program code, we
507 \"  recommend releasing these examples in parallel under your choice of
508 \"  free software license, such as the GNU General Public License,
509 \"  to permit their use in free software.