share/man/man1/strings.1

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
  46 .\"
  47 .TH STRINGS 1 "Apr 13, 2007"
  48 .SH NAME
  49 strings \- find printable strings in an object or binary file
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 \fBstrings\fR [\fB-a\fR | \fB-\fR]
  54      [\fB-t\fR \fIformat\fR | \fB-o\fR] [\fB-n\fR \fInumber\fR | \fB-number\fR]  [\fB-N\fR \fIname\fR]  [\fIfile\fR]...
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBstrings\fR utility looks for \fBASCII\fR strings in a binary file. A
  61 string is any sequence of 4 or more printing characters ending with a NEWLINE
  62 or a \fBNULL\fR character.
  63 .sp
  64 .LP
  65 \fBstrings\fR is useful for identifying random object files and many other
  66 things.
  67 .sp
  68 .LP
  69 By default, strings looks at program sections that are loaded in memory.
  70 Program sections are identified by the section type \fBSHT_PROGBITS\fR.
  71 Sections that are loaded in memory are identified by the section flag
  72 \fBSHF_ALLOC\fR. Use \fBelfdump\fR(1)  to display complete section information
  73 for a file.
  74 .sp
  75 .LP
  76 All sections can be inspected with the \fB-a\fR option. Individual sections can
  77 be inspected with the \fB-N\fR option.
  78 .SH OPTIONS
  79 .sp
  80 .LP
  81 The following options are supported:
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fB-a\fR | \fB\(mi\fR\fR
  86 .ad
  87 .RS 23n
  88 Look everywhere in the file for strings.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-n\fR \fInumber\fR \fB|\fR \fB-\fR\fInumber\fR\fR
  95 .ad
  96 .RS 23n
  97 Use a \fInumber\fR as the minimum string length rather than the default, which
  98 is \fB4\fR.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-N\fR \fIname\fR\fR
 105 .ad
 106 .RS 23n
 107 Look only in ELF section name. See \fBelfdump\fR(1). Multiple \fB-N\fR options
 108 can be specified to inspect multiple sections.
 109 .sp
 110 If the \fB-a\fR or \fB-\fRoption is specified, all \fB-N\fR options are
 111 ignored .
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fB-o\fR\fR
 118 .ad
 119 .RS 23n
 120 Equivalent to \fB\fR\fB-t\fR \fBd\fR option.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fB-t\fR \fBformat\fR\fR
 127 .ad
 128 .RS 23n
 129 Write each string preceded by its byte offset from the start of the file. The
 130 format is dependent on the single character used as the \fIformat\fR
 131 option-argument:
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBd\fR\fR
 136 .ad
 137 .RS 5n
 138 The offset is written in decimal.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fBo\fR\fR
 145 .ad
 146 .RS 5n
 147 The offset is written in octal.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBx\fR\fR
 154 .ad
 155 .RS 5n
 156 The offset is written in hexadecimal.
 157 .RE
 158
 159 .RE
 160
 161 .SH OPERANDS
 162 .sp
 163 .LP
 164 The following operand is supported:
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fB\fIfile\fR\fR\fR
 169 .ad
 170 .RS 8n
 171 A path name of a regular file to be used as input. If no \fIfile\fR operand is
 172 specified, the \fBstrings\fR utility reads from the standard input.
 173 .RE
 174
 175 .SH ENVIRONMENT VARIABLES
 176 .sp
 177 .LP
 178 See \fBenviron\fR(5) for descriptions of the following environment variables
 179 that affect the execution of \fBstrings\fR: \fBLANG\fR, \fBLC_ALL\fR,
 180 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 181 .SH EXIT STATUS
 182 .sp
 183 .LP
 184 The following exit values are returned:
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fB0\fR\fR
 189 .ad
 190 .RS 6n
 191 Successful completion.
 192 .RE
 193
 194 .sp
 195 .ne 2
 196 .na
 197 \fB\fB>0\fR\fR
 198 .ad
 199 .RS 6n
 200 An error occurred.
 201 .RE
 202
 203 .SH ATTRIBUTES
 204 .sp
 205 .LP
 206 See \fBattributes\fR(5) for descriptions of the following attributes:
 207 .sp
 208
 209 .sp
 210 .TS
 211 box;
 212 c | c
 213 l | l .
 214 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 215 _
 216 CSI     Enabled
 217 _
 218 Interface Stability     See below.
 219 .TE
 220
 221 .sp
 222 .LP
 223 The \fBstrings\fR utility, including all options except \fB-N\fR, are specified
 224 by standards. See \fBstandards\fR(5). The \fB-N\fR option is not currently
 225 specified by any standard.
 226 .SH SEE ALSO
 227 .sp
 228 .LP
 229 \fBelfdump\fR(1), \fBod\fR(1), \fBattributes\fR(5), \fBenviron\fR(5),
 230 \fBstandards\fR(5)
 231 .SH NOTES
 232 .sp
 233 .LP
 234 The algorithm for identifying strings is extremely primitive.
 235 .sp
 236 .LP
 237 For backwards compatibility, the options \fB-a\fR and \fB\(mi\fR are
 238 interchangeable.