Merge branch 'vendor/OPENSSL'
[dragonfly.git] / usr.bin / brandelf / brandelf.1
1 .\" Copyright (c) 1997
2 .\"     John-Mark Gurney.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the author nor the names of any co-contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY John-Mark Gurney AND CONTRIBUTORS ``AS IS''
17 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/usr.bin/brandelf/brandelf.1,v 1.17 2007/03/09 14:36:18 ru Exp $
29 .\" $DragonFly: src/usr.bin/brandelf/brandelf.1,v 1.6 2007/09/22 20:50:26 pavalos Exp $
30 .\"
31 .Dd February 6, 1997
32 .Dt BRANDELF 1
33 .Os
34 .Sh NAME
35 .Nm brandelf
36 .Nd mark an ELF binary for a specific ABI
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl lv
40 .Op Fl f Ar ELF_ABI_number
41 .Op Fl t Ar string
42 .Ar
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility marks an ELF binary to be run under a certain ABI for
47 .Dx .
48 .Pp
49 The options are as follows:
50 .Bl -tag -width indent
51 .It Fl f Ar ELF_ABI_number
52 Forces branding with the supplied ELF ABI number.
53 Incompatible with the
54 .Fl t
55 option.
56 These values are assigned by SCO/USL.
57 .It Fl l
58 Writes the list of all known ELF types to the standard error.
59 .It Fl v
60 Turns on verbose output.
61 .It Fl t Ar string
62 Brands the given ELF binaries to be of the
63 .Ar string
64 ABI type.
65 Currently supported ABIs are
66 .Dq Li FreeBSD ,
67 .Dq Li Linux ,
68 and
69 .Dq Li SVR4 .
70 .Ns ( Dx
71 currently uses
72 .Dq Li FreeBSD
73 as its native branding.)
74 .It Ar file
75 If
76 .Fl t Ar string
77 is given it will brand
78 .Ar file
79 to be of type
80 .Ar string ,
81 otherwise it will simply display the branding of
82 .Ar file .
83 .El
84 .Sh EXIT STATUS
85 Exit status is 0 on success, and 1 if the command
86 fails if a file does not exist, is too short, fails to brand properly,
87 or the brand requested is not one of the known types and the
88 .Fl f
89 option is not set.
90 .Sh EXAMPLES
91 The following is an example of a typical usage
92 of the
93 .Nm
94 command:
95 .Bd -literal -offset indent
96 brandelf file
97 brandelf -t Linux file
98 .Ed
99 .Sh SEE ALSO
100 .Rs
101 .%A The Santa Cruz Operation, Inc.
102 .%T System V Application Binary Interface
103 .%D April 29, 1998 (DRAFT)
104 .%O http://www.sco.com/developer/devspecs/
105 .Re
106 .Sh HISTORY
107 The
108 .Nm
109 manual page first appeared in
110 .Fx 2.2 .
111 .Sh AUTHORS
112 This manual page was written by
113 .An John-Mark Gurney Aq gurney_j@efn.org .