d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
28842b571d
freebsd-skq/usr.bin/brandelf/brandelf.1

106 lines
3.1 KiB
Groff
Raw Normal View History

Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.\" Copyright (c) 1997
.\" John-Mark Gurney. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the author nor the names of any co-contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY John-Mark Gurney AND CONTRIBUTORS ``AS IS''
.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
$Id$ -> $FreeBSD$
1999-08-28 01:08:13 +00:00
.\" $FreeBSD$
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.\"
.Dd February 6, 1997
.Dt BRANDELF 1
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 14:16:33 +00:00
.Os
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.Sh NAME
.Nm brandelf
.Nd mark an ELF binary for a specific ABI
.Sh SYNOPSIS
* I goofed and didn't break sentances the right way. * Make the option arguments format better * Fix mispelling Submitted by: ru
2000-04-18 16:25:51 +00:00
.Nm
.Op Fl lv
.Op Fl f Ar ELF_ABI_number
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.Op Fl t Ar string
* I goofed and didn't break sentances the right way. * Make the option arguments format better * Fix mispelling Submitted by: ru
2000-04-18 16:25:51 +00:00
.Ar
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.Sh DESCRIPTION
Use the .Tn macro for a couple of generic FreeBSD references. This has the desired side-effect of preventing a bad hyphenation of the word FreeBSD in one place.
1997-03-24 01:15:16 +00:00
This command marks an ELF binary to be run under a certain ABI for
Use Fx macro wherever possible.
2000-11-14 11:20:58 +00:00
.Fx .
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.Pp
The options are as follows:
.Bl -tag -width Fl
* I goofed and didn't break sentances the right way. * Make the option arguments format better * Fix mispelling Submitted by: ru
2000-04-18 16:25:51 +00:00
.It Fl f Ar ELF_ABI_number
forces branding with the supplied ELF ABI number.
Incompatible with the
.Fl t
option.
These values are assigned by SCO/USL.
Make brandelf explain itself a little better on error. Also, at Boris' suggestion, add -l option to list known ELF types. PR: bin/15285 Reviewed by: bp
2000-01-04 02:33:54 +00:00
.It Fl l
lists all known ELF types on the standard error channel.
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.It Fl v
* I goofed and didn't break sentances the right way. * Make the option arguments format better * Fix mispelling Submitted by: ru
2000-04-18 16:25:51 +00:00
turns on verbose reporting.
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.It Fl t Ar string
Change our ELF binary branding to something more acceptable to the Binutils maintainers. After we established our branding method of writing upto 8 characters of the OS name into the ELF header in the padding; the Binutils maintainers and/or SCO (as USL) decided that instead the ELF header should grow two new fields -- EI_OSABI and EI_ABIVERSION. Each of these are an 8-bit unsigned integer. SCO has assigned official values for the EI_OSABI field. In addition to this, the Binutils maintainers and NetBSD decided that a better ELF branding method was to include ABI information in a ".note" ELF section. With this set of changes, we will now create ELF binaries branded using both "official" methods. Due to the complexity of adding a section to a binary, binaries branded with ``brandelf'' will only brand using the EI_OSABI method. Also due to the complexity of pulling a section out of an ELF file vs. poking around in the ELF header, our image activator only looks at the EI_OSABI header field. Note that a new kernel can still properly load old binaries except for Linux static binaries branded in our old method. * * For a short period of time, ``ld'' will also brand ELF binaries * using our old method. This is so people can still use kernel.old * with a new world. This support will be removed before 5.0-RELEASE, * and may not last anywhere upto the actual release. My expiration * time for this is about 6mo. *
2000-04-18 02:39:26 +00:00
Brands the given ELF binaries to be of the
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.Ar string
* I goofed and didn't break sentances the right way. * Make the option arguments format better * Fix mispelling Submitted by: ru
2000-04-18 16:25:51 +00:00
ABI type.
Currently supported ABIs are
Use Fx macro wherever possible.
2000-11-14 11:20:58 +00:00
.Dq Fx ,
Document SVR4 branding is supported. PR: 19131 Submitted by: Mike Barcroft <mike@q9media.com>
2000-06-12 11:12:19 +00:00
.Dq Tn Linux ,
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
and
Document SVR4 branding is supported. PR: 19131 Submitted by: Mike Barcroft <mike@q9media.com>
2000-06-12 11:12:19 +00:00
.Dq Tn SVR4 .
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.It Ar file
If
.Fl t Ar string
is given it will brand
.Ar file
Change our ELF binary branding to something more acceptable to the Binutils maintainers. After we established our branding method of writing upto 8 characters of the OS name into the ELF header in the padding; the Binutils maintainers and/or SCO (as USL) decided that instead the ELF header should grow two new fields -- EI_OSABI and EI_ABIVERSION. Each of these are an 8-bit unsigned integer. SCO has assigned official values for the EI_OSABI field. In addition to this, the Binutils maintainers and NetBSD decided that a better ELF branding method was to include ABI information in a ".note" ELF section. With this set of changes, we will now create ELF binaries branded using both "official" methods. Due to the complexity of adding a section to a binary, binaries branded with ``brandelf'' will only brand using the EI_OSABI method. Also due to the complexity of pulling a section out of an ELF file vs. poking around in the ELF header, our image activator only looks at the EI_OSABI header field. Note that a new kernel can still properly load old binaries except for Linux static binaries branded in our old method. * * For a short period of time, ``ld'' will also brand ELF binaries * using our old method. This is so people can still use kernel.old * with a new world. This support will be removed before 5.0-RELEASE, * and may not last anywhere upto the actual release. My expiration * time for this is about 6mo. *
2000-04-18 02:39:26 +00:00
to be of type
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.Ar string ,
* I goofed and didn't break sentances the right way. * Make the option arguments format better * Fix mispelling Submitted by: ru
2000-04-18 16:25:51 +00:00
otherwise it will simply display the branding of
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.Ar file .
.El
Sort sections.
2005-01-18 13:43:56 +00:00
.Sh EXIT STATUS
Exit status is 0 on success, and 1 if the command
fails if a file does not exist, is too short, fails to brand properly,
or the brand requested is not one of the known types and the
.Fl f
option is not set.
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.Sh EXAMPLES
The following is an example of a typical usage
of the
.Nm
command:
.Pp
.Dl % brandelf file
.Dl % brandelf -t Linux file
Change our ELF binary branding to something more acceptable to the Binutils maintainers. After we established our branding method of writing upto 8 characters of the OS name into the ELF header in the padding; the Binutils maintainers and/or SCO (as USL) decided that instead the ELF header should grow two new fields -- EI_OSABI and EI_ABIVERSION. Each of these are an 8-bit unsigned integer. SCO has assigned official values for the EI_OSABI field. In addition to this, the Binutils maintainers and NetBSD decided that a better ELF branding method was to include ABI information in a ".note" ELF section. With this set of changes, we will now create ELF binaries branded using both "official" methods. Due to the complexity of adding a section to a binary, binaries branded with ``brandelf'' will only brand using the EI_OSABI method. Also due to the complexity of pulling a section out of an ELF file vs. poking around in the ELF header, our image activator only looks at the EI_OSABI header field. Note that a new kernel can still properly load old binaries except for Linux static binaries branded in our old method. * * For a short period of time, ``ld'' will also brand ELF binaries * using our old method. This is so people can still use kernel.old * with a new world. This support will be removed before 5.0-RELEASE, * and may not last anywhere upto the actual release. My expiration * time for this is about 6mo. *
2000-04-18 02:39:26 +00:00
.Sh SEE ALSO
.Rs
* I goofed and didn't break sentances the right way. * Make the option arguments format better * Fix mispelling Submitted by: ru
2000-04-18 16:25:51 +00:00
.%A The Santa Cruz Operation, Inc.
Change our ELF binary branding to something more acceptable to the Binutils maintainers. After we established our branding method of writing upto 8 characters of the OS name into the ELF header in the padding; the Binutils maintainers and/or SCO (as USL) decided that instead the ELF header should grow two new fields -- EI_OSABI and EI_ABIVERSION. Each of these are an 8-bit unsigned integer. SCO has assigned official values for the EI_OSABI field. In addition to this, the Binutils maintainers and NetBSD decided that a better ELF branding method was to include ABI information in a ".note" ELF section. With this set of changes, we will now create ELF binaries branded using both "official" methods. Due to the complexity of adding a section to a binary, binaries branded with ``brandelf'' will only brand using the EI_OSABI method. Also due to the complexity of pulling a section out of an ELF file vs. poking around in the ELF header, our image activator only looks at the EI_OSABI header field. Note that a new kernel can still properly load old binaries except for Linux static binaries branded in our old method. * * For a short period of time, ``ld'' will also brand ELF binaries * using our old method. This is so people can still use kernel.old * with a new world. This support will be removed before 5.0-RELEASE, * and may not last anywhere upto the actual release. My expiration * time for this is about 6mo. *
2000-04-18 02:39:26 +00:00
.%T System V Application Binary Interface
.%D April 29, 1998 (DRAFT)
.%O http://www.sco.com/developer/devspecs/
.Re
Add a manpage for brandelf(1). Minor stylistic fixes, and a buffer overrun fix, too. Submitted by: John-Mark Gurney <jmg@nike.efn.org>
1997-02-09 20:35:54 +00:00
.Sh HISTORY
The
.Nm
manual page first appeared in
This page will first appear in 2.2, not 3.0. 2.2 Candidate
1997-02-17 15:54:47 +00:00
.Fx 2.2 .
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq.
1998-03-23 07:48:45 +00:00
.Sh AUTHORS
This manual page was written by
.An John-Mark Gurney Aq gurney_j@efn.org .
Reference in New Issue Copy Permalink