Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.sbin / crunch / crunchide / crunchide.1
1 .\"
2 .\" Copyright (c) 1994 University of Maryland
3 .\" All Rights Reserved.
4 .\"
5 .\" Permission to use, copy, modify, distribute, and sell this software and its
6 .\" documentation for any purpose is hereby granted without fee, provided that
7 .\" the above copyright notice appear in all copies and that both that
8 .\" copyright notice and this permission notice appear in supporting
9 .\" documentation, and that the name of U.M. not be used in advertising or
10 .\" publicity pertaining to distribution of the software without specific,
11 .\" written prior permission.  U.M. makes no representations about the
12 .\" suitability of this software for any purpose.  It is provided "as is"
13 .\" without express or implied warranty.
14 .\"
15 .\" U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
17 .\" BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
18 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
19 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
20 .\" IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 .\"
22 .\" Author: James da Silva, Systems Design and Analysis Group
23 .\"                        Computer Science Department
24 .\"                        University of Maryland at College Park
25 .\" $FreeBSD: src/usr.sbin/crunch/crunchide/crunchide.1,v 1.5.2.5 2003/03/12 22:08:14 trhodes Exp $
26 .\"
27 .Dd June 14, 1994
28 .Dt CRUNCHIDE 1
29 .Os
30 .Sh NAME
31 .Nm crunchide
32 .Nd hides symbol names from ld, for crunching programs together
33 .Sh SYNOPSIS
34 .Nm
35 .Op Fl f Ar keep-list-file
36 .Op Fl k Ar keep-symbol
37 .Op Ar object-file ...
38 .Sh DESCRIPTION
39 The
40 .Nm
41 utility hides the global symbols of
42 .Ar object-file
43 such that they are ignored by subsequent runs of the linker,
44 .Xr ld 1 .
45 Some symbols may be left visible via the
46 .Fl k Ar keep-symbol
47 and
48 .Fl f Ar keep-list-file
49 options.  The
50 .Ar keep-list-file
51 must contain a list of symbols to keep visible, one symbol per line.
52 The names given by
53 .Ar keep-symbol
54 or in
55 .Ar keep-list-file
56 should be C names.  For example,
57 to keep the C function
58 .Dq foo
59 visible, the option
60 .Dq -k foo
61 should be used.
62 .Pp
63 The
64 .Nm
65 utility is designed as a companion program for
66 .Xr crunchgen 1 ,
67 which automates the process of creating crunched binaries from
68 multiple component programs.
69 .Sh SEE ALSO
70 .Xr crunchgen 1 ,
71 .Xr ld 1
72 .Sh AUTHORS
73 The
74 .Nm crunch
75 utility was written by
76 .An James da Silva Aq jds@cs.umd.edu .
77 .Pp
78 Copyright (c) 1994 University of Maryland.  All Rights Reserved.
79 .Pp
80 .An Chris Demetriou Aq cgd@netbsd.org
81 reorganized
82 .Nm
83 so that it supported multiple object formats, and added
84 ELF object support and ECOFF object recognition.
85 .Pp
86 Copyright (c) 1997 Christopher G. Demetriou.  All Rights Reserved.