Sync with FreeBSD:
[dragonfly.git] / usr.bin / brandelf / brandelf.1
CommitLineData
984263bc
MD
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.9.2.3 2001/08/16 13:16:42 ru Exp $
1bf4b486 29.\" $DragonFly: src/usr.bin/brandelf/brandelf.1,v 1.5 2005/08/01 01:49:17 swildner Exp $
984263bc
MD
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
44This command marks an ELF binary to be run under a certain ABI for
9bb2a92d 45.Dx .
984263bc
MD
46.Pp
47The options are as follows:
48.Bl -tag -width Fl
49.It Fl f Ar ELF_ABI_number
50forces branding with the supplied ELF ABI number.
51Incompatible with the
52.Fl t
53option.
54These values are assigned by SCO/USL.
55.It Fl l
56lists all known ELF types on the standard error channel.
57.It Fl v
58turns on verbose reporting.
59.It Fl t Ar string
60Brands the given ELF binaries to be of the
61.Ar string
62ABI type.
63Currently supported ABIs are
64.Dq Fx ,
65.Dq Tn Linux ,
66and
67.Dq Tn SVR4 .
52ac7bd7 68.Ns ( Dx
1bf4b486 69currently uses
9bb2a92d
HP
70.Dq Fx
71as its native branding.)
984263bc
MD
72.It Ar file
73If
74.Fl t Ar string
75is given it will brand
76.Ar file
77to be of type
78.Ar string ,
79otherwise it will simply display the branding of
80.Ar file .
81.El
82.Sh EXAMPLES
83The following is an example of a typical usage
84of the
85.Nm
86command:
87.Pp
88.Dl % brandelf file
89.Dl % brandelf -t Linux file
90.Sh DIAGNOSTICS
91Exit status is 0 on success, and 1 if the command
92fails if a file does not exist, is too short, fails to brand properly,
93or the brand requested is not one of the known types and the
94.Fl f
95option is not set.
96.Sh SEE ALSO
97.Rs
98.%A The Santa Cruz Operation, Inc.
99.%T System V Application Binary Interface
100.%D April 29, 1998 (DRAFT)
101.%O http://www.sco.com/developer/devspecs/
102.Re
103.Sh HISTORY
104The
105.Nm
106manual page first appeared in
107.Fx 2.2 .
108.Sh AUTHORS
109This manual page was written by
110.An John-Mark Gurney Aq gurney_j@efn.org .