xref: /titanic_51/usr/src/tools/btxld/btxld.1onbld (revision ba11c5b535a8958668f939901bdcacb3ee8b7570)
1*ba11c5b5SToomas Soome.\" Copyright (c) 1998 Robert Nordier
2*ba11c5b5SToomas Soome.\" All rights reserved.
3*ba11c5b5SToomas Soome.\"
4*ba11c5b5SToomas Soome.\" Redistribution and use in source and binary forms, with or without
5*ba11c5b5SToomas Soome.\" modification, are permitted provided that the following conditions
6*ba11c5b5SToomas Soome.\" are met:
7*ba11c5b5SToomas Soome.\" 1. Redistributions of source code must retain the above copyright
8*ba11c5b5SToomas Soome.\"    notice, this list of conditions and the following disclaimer.
9*ba11c5b5SToomas Soome.\" 2. Redistributions in binary form must reproduce the above copyright
10*ba11c5b5SToomas Soome.\"    notice, this list of conditions and the following disclaimer in the
11*ba11c5b5SToomas Soome.\"    documentation and/or other materials provided with the distribution.
12*ba11c5b5SToomas Soome.\"
13*ba11c5b5SToomas Soome.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS``AS IS'' AND
14*ba11c5b5SToomas Soome.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*ba11c5b5SToomas Soome.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16*ba11c5b5SToomas Soome.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
17*ba11c5b5SToomas Soome.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
18*ba11c5b5SToomas Soome.\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
19*ba11c5b5SToomas Soome.\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
20*ba11c5b5SToomas Soome.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21*ba11c5b5SToomas Soome.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
22*ba11c5b5SToomas Soome.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
23*ba11c5b5SToomas Soome.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24*ba11c5b5SToomas Soome.\"
25*ba11c5b5SToomas Soome.Dd Apr 20, 2017
26*ba11c5b5SToomas Soome.Dt BTXLD 1ONBLD
27*ba11c5b5SToomas Soome.Os
28*ba11c5b5SToomas Soome.Sh NAME
29*ba11c5b5SToomas Soome.Nm btxld
30*ba11c5b5SToomas Soome.Nd link editor for BTX clients
31*ba11c5b5SToomas Soome.Sh SYNOPSIS
32*ba11c5b5SToomas Soome.Nm
33*ba11c5b5SToomas Soome.Op Fl qv
34*ba11c5b5SToomas Soome.Op Fl b Ar file
35*ba11c5b5SToomas Soome.Op Fl E Ar address
36*ba11c5b5SToomas Soome.Op Fl e Ar address
37*ba11c5b5SToomas Soome.Op Fl f Ar format
38*ba11c5b5SToomas Soome.Op Fl l Ar file
39*ba11c5b5SToomas Soome.Op Fl o Ar filename
40*ba11c5b5SToomas Soome.Op Fl P Ar page
41*ba11c5b5SToomas Soome.Op Fl W Ar page
42*ba11c5b5SToomas Soome.Ar file
43*ba11c5b5SToomas Soome.Sh DESCRIPTION
44*ba11c5b5SToomas SoomeThe
45*ba11c5b5SToomas Soome.Nm
46*ba11c5b5SToomas Soomeutility binds the specified client executable together with a BTX
47*ba11c5b5SToomas Soomeloader program and the BTX kernel, and creates a composite object file
48*ba11c5b5SToomas Soomesuitable for loading during the boot process.
49*ba11c5b5SToomas Soome.Pp
50*ba11c5b5SToomas SoomeThe options are:
51*ba11c5b5SToomas Soome.Bl -tag -width indent
52*ba11c5b5SToomas Soome.It Fl q
53*ba11c5b5SToomas SoomeQuiet: inhibit warnings.
54*ba11c5b5SToomas Soome.It Fl v
55*ba11c5b5SToomas SoomeVerbose: display information about the files processed.
56*ba11c5b5SToomas Soome.It Fl b Ar file
57*ba11c5b5SToomas SoomeSpecify the BTX kernel to be bound with the client.
58*ba11c5b5SToomas Soome.It Fl E Ar address
59*ba11c5b5SToomas SoomeSet the client entry point.
60*ba11c5b5SToomas Soome.It Fl e Ar address
61*ba11c5b5SToomas SoomeSet the BTX loader entry point.
62*ba11c5b5SToomas Soome.It Fl f Ar format
63*ba11c5b5SToomas SoomeSpecify the output format, where
64*ba11c5b5SToomas Soome.Ar format
65*ba11c5b5SToomas Soomeis one of
66*ba11c5b5SToomas Soome.Sq bin ,
67*ba11c5b5SToomas Soome.Sq aout ,
68*ba11c5b5SToomas Soomeor
69*ba11c5b5SToomas Soome.Sq elf .
70*ba11c5b5SToomas Soome.It Fl l Ar file
71*ba11c5b5SToomas SoomeSpecify the BTX loader to be bound with the client.
72*ba11c5b5SToomas Soome.It Fl o Ar filename
73*ba11c5b5SToomas SoomeName the output file.
74*ba11c5b5SToomas SoomeThe default is
75*ba11c5b5SToomas Soome.Dq a.out .
76*ba11c5b5SToomas Soome.It Fl P Ar page
77*ba11c5b5SToomas SoomeSpecify the first page of the client's segment to be marked
78*ba11c5b5SToomas Soome.Sq present ,
79*ba11c5b5SToomas Soomewhere
80*ba11c5b5SToomas Soome.Ar page
81*ba11c5b5SToomas Soomemay be 0 or 1.
82*ba11c5b5SToomas Soome.It Fl W Ar page
83*ba11c5b5SToomas SoomeSpecify the first page of the client's segment to be marked
84*ba11c5b5SToomas Soome.Sq writable ,
85*ba11c5b5SToomas Soomewhere
86*ba11c5b5SToomas Soome.Ar page
87*ba11c5b5SToomas Soomemay be 0, and should not exceed the number of pages occupied by the
88*ba11c5b5SToomas Soomecombined .text and .data segments of the client image.
89*ba11c5b5SToomas Soome.El
90*ba11c5b5SToomas Soome.Sh EXIT STATUS
91*ba11c5b5SToomas Soome.Ex -std
92*ba11c5b5SToomas Soome.Sh SEE ALSO
93*ba11c5b5SToomas Soome.Xr ld 1 ,
94*ba11c5b5SToomas Soome.Xr boot 1M
95