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