Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / strings / strings.1
1 .\" Copyright (c) 1980, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)strings.1   8.1 (Berkeley) 6/6/93
33 .\" $FreeBSD: src/usr.bin/strings/strings.1,v 1.4.2.3 2002/06/21 15:29:13 charnier Exp $
34 .\"
35 .Dd June 6, 1993
36 .Dt STRINGS 1
37 .Os
38 .Sh NAME
39 .Nm strings
40 .Nd find printable strings in a file
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl afo
44 .Op Fl n Ar number
45 .Op Ar
46 .Sh DESCRIPTION
47 The
48 .Nm
49 utility
50 displays the sequences of printable characters in each of the specified
51 files, or in the standard input, by default.
52 By default, a sequence must be at least four characters in length
53 before being displayed.
54 .Pp
55 The options are as follows:
56 .Bl -tag -width Ds
57 .It Fl a
58 By default,
59 .Nm
60 only searches the text and data segments of object files.
61 The
62 .Fl a
63 option causes
64 .Nm
65 to search the entire object file.
66 .It Fl f
67 Each string is preceded by the name of the file
68 in which it was found.
69 .It Fl n
70 Specifies the minimum number of characters in a sequence to be
71 .Ar number ,
72 instead of four.
73 .It Fl o
74 Each string is preceded by its decimal offset in the
75 file.
76 .El
77 .Pp
78 The
79 .Nm
80 utility is useful for identifying random binaries, among other things.
81 .Sh SEE ALSO
82 .Xr hexdump 1
83 .Sh BUGS
84 The algorithm for identifying strings is extremely primitive.
85 In particular, machine code instructions on certain architectures
86 can resemble sequences of ASCII bytes, which
87 will fool the algorithm.
88 .Sh COMPATIBILITY
89 Historic implementations of
90 .Nm
91 only search the initialized data portion of the object file.
92 This was reasonable as strings were normally stored there.
93 Given new compiler technology which installs strings in the
94 text portion of the object file, the default behavior was
95 changed.
96 .Sh HISTORY
97 The
98 .Nm
99 command appeared in
100 .Bx 3.0 .