xref: /freebsd/usr.sbin/crunch/crunchide/crunchide.1 (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
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.\"
26.Dd June 14, 1994
27.Dt CRUNCHIDE 1
28.Os
29.Sh NAME
30.Nm crunchide
31.Nd hides symbol names from ld, for crunching programs together
32.Sh SYNOPSIS
33.Nm
34.Op Fl f Ar keep-list-file
35.Op Fl k Ar keep-symbol
36.Op Ar object-file ...
37.Sh DESCRIPTION
38The
39.Nm
40utility hides the global symbols of
41.Ar object-file
42such that they are ignored by subsequent runs of the linker,
43.Xr ld 1 .
44Some symbols may be left visible via the
45.Fl k Ar keep-symbol
46and
47.Fl f Ar keep-list-file
48options.
49The
50.Ar keep-list-file
51must contain a list of symbols to keep visible, one symbol per line.
52The names given by
53.Ar keep-symbol
54or in
55.Ar keep-list-file
56should be C names.
57For example,
58to keep the C function
59.Dq foo
60visible, the option
61.Dq -k foo
62should be used.
63.Pp
64The
65.Nm
66utility is designed as a companion program for
67.Xr crunchgen 1 ,
68which automates the process of creating crunched binaries from
69multiple component programs.
70.Sh SEE ALSO
71.Xr crunchgen 1 ,
72.Xr ld 1
73.Sh AUTHORS
74.An -nosplit
75The
76.Nm crunch
77utility was written by
78.An James da Silva Aq Mt jds@cs.umd.edu .
79.Pp
80Copyright (c) 1994 University of Maryland.
81All Rights Reserved.
82.Pp
83.An Chris Demetriou Aq Mt cgd@netbsd.org
84reorganized
85.Nm
86so that it supported multiple object formats, and added
87ELF object support and ECOFF object recognition.
88.Pp
89Copyright (c) 1997
90.An Christopher G. Demetriou .
91All Rights Reserved.
92