usr.bin/clang/llvm-strings/llvm-strings.1

   1 .\" $FreeBSD$
   2 .\" Man page generated from reStructuredText.
   3 .
   4 .TH "LLVM-STRINGS" "1" "2020-06-26" "10" "LLVM"
   5 .SH NAME
   6 llvm-strings \- print strings
   7 .
   8 .nr rst2man-indent-level 0
   9 .
  10 .de1 rstReportMargin
  11 \\$1 \\n[an-margin]
  12 level \\n[rst2man-indent-level]
  13 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  14 -
  15 \\n[rst2man-indent0]
  16 \\n[rst2man-indent1]
  17 \\n[rst2man-indent2]
  18 ..
  19 .de1 INDENT
  20 .\" .rstReportMargin pre:
  21 . RS \\$1
  22 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  23 . nr rst2man-indent-level +1
  24 .\" .rstReportMargin post:
  25 ..
  26 .de UNINDENT
  27 . RE
  28 .\" indent \\n[an-margin]
  29 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  30 .nr rst2man-indent-level -1
  31 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  32 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  33 ..
  34 .SH SYNOPSIS
  35 .sp
  36 \fBllvm\-strings\fP [\fIoptions\fP] [\fIinput...\fP]
  37 .SH DESCRIPTION
  38 .sp
  39 \fBllvm\-strings\fP is a tool intended as a drop\-in replacement for GNU\(aqs
  40 \fBstrings\fP, which looks for printable strings in files and writes them
  41 to the standard output stream. A printable string is any sequence of four (by
  42 default) or more printable ASCII characters. The end of the file, or any other
  43 byte, terminates the current sequence.
  44 .sp
  45 \fBllvm\-strings\fP looks for strings in each \fBinput\fP file specified.
  46 Unlike GNU \fBstrings\fP it looks in the entire input file, regardless of
  47 file format, rather than restricting the search to certain sections of object
  48 files. If "\fB\-\fP" is specified as an \fBinput\fP, or no \fBinput\fP is specified,
  49 the program reads from the standard input stream.
  50 .SH EXAMPLE
  51 .INDENT 0.0
  52 .INDENT 3.5
  53 .sp
  54 .nf
  55 .ft C
  56 $ cat input.txt
  57 bars
  58 foo
  59 wibble blob
  60 $ llvm\-strings input.txt
  61 bars
  62 wibble blob
  63 .ft P
  64 .fi
  65 .UNINDENT
  66 .UNINDENT
  67 .SH OPTIONS
  68 .INDENT 0.0
  69 .TP
  70 .B \-\-all, \-a
  71 Silently ignored. Present for GNU \fBstrings\fP compatibility.
  72 .UNINDENT
  73 .INDENT 0.0
  74 .TP
  75 .B \-\-bytes=<length>, \-n
  76 Set the minimum number of printable ASCII characters required for a sequence of
  77 bytes to be considered a string. The default value is 4.
  78 .UNINDENT
  79 .INDENT 0.0
  80 .TP
  81 .B \-\-help, \-h
  82 Display a summary of command line options.
  83 .UNINDENT
  84 .INDENT 0.0
  85 .TP
  86 .B \-\-help\-list
  87 Display an uncategorized summary of command line options.
  88 .UNINDENT
  89 .INDENT 0.0
  90 .TP
  91 .B \-\-print\-file\-name, \-f
  92 Display the name of the containing file before each string.
  93 .sp
  94 Example:
  95 .INDENT 7.0
  96 .INDENT 3.5
  97 .sp
  98 .nf
  99 .ft C
 100 $ llvm\-strings \-\-print\-file\-name test.o test.elf
 101 test.o: _Z5hellov
 102 test.o: some_bss
 103 test.o: test.cpp
 104 test.o: main
 105 test.elf: test.cpp
 106 test.elf: test2.cpp
 107 test.elf: _Z5hellov
 108 test.elf: main
 109 test.elf: some_bss
 110 .ft P
 111 .fi
 112 .UNINDENT
 113 .UNINDENT
 114 .UNINDENT
 115 .INDENT 0.0
 116 .TP
 117 .B \-\-radix=<radix>, \-t
 118 Display the offset within the file of each string, before the string and using
 119 the specified radix. Valid \fB<radix>\fP values are \fBo\fP, \fBd\fP and \fBx\fP for
 120 octal, decimal and hexadecimal respectively.
 121 .sp
 122 Example:
 123 .INDENT 7.0
 124 .INDENT 3.5
 125 .sp
 126 .nf
 127 .ft C
 128 $ llvm\-strings \-\-radix=o test.o
 129     1054 _Z5hellov
 130     1066 .rela.text
 131     1101 .comment
 132     1112 some_bss
 133     1123 .bss
 134     1130 test.cpp
 135     1141 main
 136 $ llvm\-strings \-\-radix=d test.o
 137     556 _Z5hellov
 138     566 .rela.text
 139     577 .comment
 140     586 some_bss
 141     595 .bss
 142     600 test.cpp
 143     609 main
 144 $ llvm\-strings \-t x test.o
 145     22c _Z5hellov
 146     236 .rela.text
 147     241 .comment
 148     24a some_bss
 149     253 .bss
 150     258 test.cpp
 151     261 main
 152 .ft P
 153 .fi
 154 .UNINDENT
 155 .UNINDENT
 156 .UNINDENT
 157 .INDENT 0.0
 158 .TP
 159 .B \-\-version
 160 Display the version of the \fBllvm\-strings\fP executable.
 161 .UNINDENT
 162 .INDENT 0.0
 163 .TP
 164 .B @<FILE>
 165 Read command\-line options from response file \fB<FILE>\fP\&.
 166 .UNINDENT
 167 .SH EXIT STATUS
 168 .sp
 169 \fBllvm\-strings\fP exits with a non\-zero exit code if there is an error.
 170 Otherwise, it exits with code 0.
 171 .SH BUGS
 172 .sp
 173 To report bugs, please visit <\fI\%http://llvm.org/bugs/\fP>.
 174 .SH AUTHOR
 175 Maintained by the LLVM Team (https://llvm.org/).
 176 .SH COPYRIGHT
 177 2003-2020, LLVM Project
 178 .\" Generated by docutils manpage writer.
 179 .