xref: /illumos-gate/usr/src/tools/btxld/btxld.1onbld (revision e8921a52c53ee69f7b65f054d9b2e886139daa59)
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 Nov 8, 2017
26.Dt BTXLD 1ONBLD
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 V Ar version
42.Op Fl W Ar page
43.Ar file
44.Sh DESCRIPTION
45The
46.Nm
47utility binds the specified client executable together with a BTX
48loader program and the BTX kernel, and creates a composite object file
49suitable for loading during the boot process.
50.Pp
51The options are:
52.Bl -tag -width indent
53.It Fl q
54Quiet: inhibit warnings.
55.It Fl v
56Verbose: display information about the files processed.
57.It Fl b Ar file
58Specify the BTX kernel to be bound with the client.
59.It Fl E Ar address
60Set the client entry point.
61.It Fl e Ar address
62Set the BTX loader entry point.
63.It Fl f Ar format
64Specify the output format, where
65.Ar format
66is one of
67.Sq bin ,
68.Sq aout ,
69or
70.Sq elf .
71.It Fl l Ar file
72Specify the BTX loader to be bound with the client.
73.It Fl o Ar filename
74Name the output file.
75The default is
76.Dq a.out .
77.It Fl P Ar page
78Specify the first page of the client's segment to be marked
79.Sq present ,
80where
81.Ar page
82may be 0 or 1.
83.It Fl V Ar version
84Specify the version string.
85.It Fl W Ar page
86Specify the first page of the client's segment to be marked
87.Sq writable ,
88where
89.Ar page
90may be 0, and should not exceed the number of pages occupied by the
91combined .text and .data segments of the client image.
92.El
93.Sh EXIT STATUS
94.Ex -std
95.Sh SEE ALSO
96.Xr ld 1 ,
97.Xr boot 1M
98