xref: /freebsd/usr.sbin/btxld/btxld.8 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
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.Dd September 12, 1998
26.Dt BTXLD 8
27.Os
28.Sh NAME
29.Nm btxld
30.Nd link editor for BTX clients
31.Sh SYNOPSIS
32.Nm
33.Op Fl qv
34.Op Fl b Ar file
35.Op Fl E Ar address
36.Op Fl e Ar address
37.Op Fl f Ar format
38.Op Fl l Ar file
39.Op Fl o Ar filename
40.Op Fl P Ar page
41.Op Fl W Ar page
42.Ar file
43.Sh DESCRIPTION
44The
45.Nm
46utility binds the specified client executable together with a BTX
47loader program and the BTX kernel, and creates a composite object file
48suitable for loading during the boot process.
49.Pp
50The options are:
51.Bl -tag -width indent
52.It Fl q
53Quiet: inhibit warnings.
54.It Fl v
55Verbose: display information about the files processed.
56.It Fl b Ar file
57Specify the BTX kernel to be bound with the client.
58.It Fl E Ar address
59Set the client entry point.
60.It Fl e Ar address
61Set the BTX loader entry point.
62.It Fl f Ar format
63Specify the output format, where
64.Ar format
65is one of
66.Sq bin ,
67.Sq aout ,
68or
69.Sq elf .
70.It Fl l Ar file
71Specify the BTX loader to be bound with the client.
72.It Fl o Ar filename
73Name the output file.
74The default is
75.Dq a.out .
76.It Fl P Ar page
77Specify the first page of the client's segment to be marked
78.Sq present ,
79where
80.Ar page
81may be 0 or 1.
82.It Fl W Ar page
83Specify the first page of the client's segment to be marked
84.Sq writable ,
85where
86.Ar page
87may be 0, and should not exceed the number of pages occupied by the
88combined .text and .data segments of the client image.
89.El
90.Sh EXIT STATUS
91.Ex -std
92.Sh SEE ALSO
93.Xr ld 1 ,
94.Xr boot 8
95.Sh AUTHORS
96.An Robert Nordier Aq Mt rnordier@FreeBSD.org
97