xref: /freebsd/usr.bin/brandelf/brandelf.1 (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
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$
29.\"
30.Dd February 6, 1997
31.Dt BRANDELF 1
32.Os FreeBSD
33.Sh NAME
34.Nm brandelf
35.Nd mark an ELF binary for a specific ABI
36.Sh SYNOPSIS
37.Nm brandelf
38.Op Fl f
39.Op Fl v
40.Op Fl t Ar string
41.Ar file ...
42.Sh DESCRIPTION
43This command marks an ELF binary to be run under a certain ABI for
44.Tn FreeBSD .
45.Pp
46The options are as follows:
47.Bl -tag -width Fl
48.It Fl f
49forces branding even if the brand requested is unknown, and disables
50warnings for unknown brands.
51.It Fl v
52turns on verbose reporting
53.It Fl t Ar string
54Brands the given ELF binaries with
55.Ar string
56as the ABI type.  Currently supported ABI's are
57.Dq Tn FreeBSD
58and
59.Dq Linux .
60.It Ar file
61If
62.Fl t Ar string
63is given it will brand
64.Ar file
65with
66.Ar string ,
67otherwise it will simply display the branding of
68.Ar file .
69.El
70.Sh EXAMPLES
71The following is an example of a typical usage
72of the
73.Nm
74command:
75.Pp
76.Dl % brandelf file
77.Dl % brandelf -t Linux file
78.Sh DIAGNOSTICS
79Exit status is 0 on success, and 1 if the command
80fails if a file doesn't exist, is too short, fails to brand properly,
81or the brand requested is not 'Linux' or 'FreeBSD' and the
82.Fl f
83option is not set.
84.Sh HISTORY
85The
86.Nm
87manual page first appeared in
88.Fx 2.2 .
89.Sh AUTHORS
90This manual page was written by
91.An John-Mark Gurney Aq gurney_j@efn.org .
92