xref: /freebsd/usr.sbin/btxld/btxld.8 (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1.\" Copyright (c) 1998 Robert Nordier
2.\" 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
17.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
18.\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
19.\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
20.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
22.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
23.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd September 12, 1998
28.Dt BTXLD 8
29.Os
30.Sh NAME
31.Nm btxld
32.Nd link editor for BTX clients
33.Sh SYNOPSIS
34.Nm
35.Op Fl qv
36.Op Fl b Ar file
37.Op Fl E Ar address
38.Op Fl e Ar address
39.Op Fl f Ar format
40.Op Fl l Ar file
41.Op Fl o Ar filename
42.Op Fl P Ar page
43.Op Fl W Ar page
44.Ar file
45.Sh DESCRIPTION
46The
47.Nm
48utility binds the specified client executable together with a BTX
49loader program and the BTX kernel, and creates a composite object file
50suitable for loading during the boot process.
51.Pp
52The options are:
53.Bl -tag -width indent
54.It Fl q
55Quiet: inhibit warnings.
56.It Fl v
57Verbose: display information about the files processed.
58.It Fl b Ar file
59Specify the BTX kernel to be bound with the client.
60.It Fl E Ar address
61Set the client entry point.
62.It Fl e Ar address
63Set the BTX loader entry point.
64.It Fl f Ar format
65Specify the output format, where
66.Ar format
67is one of
68.Sq bin ,
69.Sq aout ,
70or
71.Sq elf .
72.It Fl l Ar file
73Specify the BTX loader to be bound with the client.
74.It Fl o Ar filename
75Name the output file.
76The default is
77.Dq a.out .
78.It Fl P Ar page
79Specify the first page of the client's segment to be marked
80.Sq present ,
81where
82.Ar page
83may be 0 or 1.
84.It Fl W Ar page
85Specify the first page of the client's segment to be marked
86.Sq writable ,
87where
88.Ar page
89may be 0, and should not exceed the number of pages occupied by the
90combined .text and .data segments of the client image.
91.El
92.Sh EXIT STATUS
93.Ex -std
94.Sh SEE ALSO
95.Xr ld 1 ,
96.Xr boot 8
97.Sh AUTHORS
98.An Robert Nordier Aq Mt rnordier@FreeBSD.org
99