Update README to match cctools-809 sources
[striptease.git] / README
blob1b77ec1951db63bb9a1dca65c4ec1d5ac30da87c
1 striptease (or "tease" for short) is an enhanced version of strip.  It's
2 capable of stripping a binary's symbol table of non-text local symbols.
3 This mode, enabled with the -t switch, is similar to "strip -s", except
4 -s strips all local symbols including text symbols.  tease -t allows for
5 useful CrashReporter stacks to be generated on the deployment host.  This
6 is important in light of the hidden-visibility default (-fvisibility=hidden)
7 that results in many symbols not being marked as global and therefore being
8 stripped by an ordinary strip -s.
10 tease also includes a -no_code_signature option, which strips any
11 LC_CODE_SIGNATURE load commands from the target file, in much the same way
12 as the ordinary strip's -no_uuid option.
14 Finally, tease includes an -a option, which instructs it to regenerate the
15 symbol table without stripping anything.  tease -a is intended to be used
16 in conjunction with -no_code_signature (or -no_uuid), to pass over the file
17 and only strip the relevant Mach-O load commands without removing anything
18 from the symbol table.
20 striptease is based on strip.c and other supporting files in Apple's
21 cctools package.  This version of striptease is based on cctools-809,
22 corresponding to Xcode Tools 4.2 and Mac OS X 10.7.  It builds properly
23 under Xcode Tools 2.x on Mac OS X 10.4, as well.  The cctools package is
24 available from:
26 http://opensource.apple.com/tarballs/cctools/cctools-809.tar.gz
28 cctools, and therefore strip, are available under the APSL license:
30 http://www.opensource.apple.com/apsl/
32 All files from cctools necessary to build strip are included, unmodified.
33 This includes strip.c.  Changes to strip.c are made in tease.c.  Many other
34 files from the cctools package not relevant to strip (or tease) are omitted
35 from this distribution.  This README and an accompanying Makefile for
36 build system integration are also included.
38 Use "make" to build a build/Release/tease executable.
40 Use "make DEBUG=1" to build a build/Debug/tease debug executable.
42 Use "make clean" to remove the build directory and built executables.
44 Note that when building on 10.6 or 10.7, the MacOSX10.5.sdk must be present.
45 Also note that compile warnings (and link warnings when building on 10.4)
46 should be ignored -- the cctools-809 sources have some issues.