Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[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 .\" $DragonFly: src/usr.bin/strings/Attic/strings.1,v 1.2 2003/06/17 04:29:31 dillon Exp $
35 .\"
36 .Dd June 6, 1993
37 .Dt STRINGS 1
38 .Os
39 .Sh NAME
40 .Nm strings
41 .Nd find printable strings in a file
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl afo
45 .Op Fl n Ar number
46 .Op Ar
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility
51 displays the sequences of printable characters in each of the specified
52 files, or in the standard input, by default.
53 By default, a sequence must be at least four characters in length
54 before being displayed.
55 .Pp
56 The options are as follows:
57 .Bl -tag -width Ds
58 .It Fl a
59 By default,
60 .Nm
61 only searches the text and data segments of object files.
62 The
63 .Fl a
64 option causes
65 .Nm
66 to search the entire object file.
67 .It Fl f
68 Each string is preceded by the name of the file
69 in which it was found.
70 .It Fl n
71 Specifies the minimum number of characters in a sequence to be
72 .Ar number ,
73 instead of four.
74 .It Fl o
75 Each string is preceded by its decimal offset in the
76 file.
77 .El
78 .Pp
79 The
80 .Nm
81 utility is useful for identifying random binaries, among other things.
82 .Sh SEE ALSO
83 .Xr hexdump 1
84 .Sh BUGS
85 The algorithm for identifying strings is extremely primitive.
86 In particular, machine code instructions on certain architectures
87 can resemble sequences of ASCII bytes, which
88 will fool the algorithm.
89 .Sh COMPATIBILITY
90 Historic implementations of
91 .Nm
92 only search the initialized data portion of the object file.
93 This was reasonable as strings were normally stored there.
94 Given new compiler technology which installs strings in the
95 text portion of the object file, the default behavior was
96 changed.
97 .Sh HISTORY
98 The
99 .Nm
100 command appeared in
101 .Bx 3.0 .