usr.bin: fix more mandoc(1) warnings
[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 .\"
30 .Dd February 6, 1997
31 .Dt BRANDELF 1
32 .Os
33 .Sh NAME
34 .Nm brandelf
35 .Nd mark an ELF binary for a specific ABI
36 .Sh SYNOPSIS
37 .Nm
38 .Op Fl l
39 .Op Fl f Ar ELF_ABI_number
40 .Op Fl t Ar string
41 .Ar
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility marks an ELF binary to be run under a certain ABI for
46 .Dx .
47 .Pp
48 The options are as follows:
49 .Bl -tag -width indent
50 .It Fl f Ar ELF_ABI_number
51 Forces branding with the supplied ELF ABI number.
52 Incompatible with the
53 .Fl t
54 option.
55 These values are assigned by SCO/USL.
56 .It Fl l
57 Writes the list of all known ELF types to the standard error.
58 .It Fl t Ar string
59 Brands the given ELF binaries to be of the
60 .Ar string
61 ABI type.
62 Currently supported ABIs are
63 .Dq Li FreeBSD ,
64 .Dq Li Linux ,
65 and
66 .Dq Li SVR4 .
67 .Dx
68 uses
69 .Dq Li FreeBSD
70 as its native branding.
71 .It Ar file
72 If
73 .Fl t Ar string
74 is given it will brand
75 .Ar file
76 to be of type
77 .Ar string ,
78 otherwise it will simply display the branding of
79 .Ar file .
80 .El
81 .Sh EXIT STATUS
82 Exit status is 0 on success, and 1 if the command
83 fails if a file does not exist, is too short, fails to brand properly,
84 or the brand requested is not one of the known types and the
85 .Fl f
86 option is not set.
87 .Sh EXAMPLES
88 The following is an example of a typical usage
89 of the
90 .Nm
91 command:
92 .Bd -literal -offset indent
93 brandelf file
94 brandelf -t Linux file
95 .Ed
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
104 The
105 .Nm
106 manual page first appeared in
107 .Fx 2.2 .
108 .Sh AUTHORS
109 This manual page was written by
110 .An John-Mark Gurney Aq Mt gurney_j@efn.org .