xref: /freebsd/usr.sbin/btxld/btxld.8 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
19c9f4492SRobert Nordier.\" Copyright (c) 1998 Robert Nordier
29c9f4492SRobert Nordier.\" All rights reserved.
39c9f4492SRobert Nordier.\"
49c9f4492SRobert Nordier.\" Redistribution and use in source and binary forms, with or without
59c9f4492SRobert Nordier.\" modification, are permitted provided that the following conditions
69c9f4492SRobert Nordier.\" are met:
79c9f4492SRobert Nordier.\" 1. Redistributions of source code must retain the above copyright
89c9f4492SRobert Nordier.\"    notice, this list of conditions and the following disclaimer.
99c9f4492SRobert Nordier.\" 2. Redistributions in binary form must reproduce the above copyright
109c9f4492SRobert Nordier.\"    notice, this list of conditions and the following disclaimer in the
119c9f4492SRobert Nordier.\"    documentation and/or other materials provided with the distribution.
129c9f4492SRobert Nordier.\"
139c9f4492SRobert Nordier.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS``AS IS'' AND
149c9f4492SRobert Nordier.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
159c9f4492SRobert Nordier.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
169c9f4492SRobert Nordier.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
179c9f4492SRobert Nordier.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
189c9f4492SRobert Nordier.\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
199c9f4492SRobert Nordier.\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
209c9f4492SRobert Nordier.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
219c9f4492SRobert Nordier.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
229c9f4492SRobert Nordier.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
239c9f4492SRobert Nordier.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
249c9f4492SRobert Nordier.\"
259c9f4492SRobert Nordier.Dd September 12, 1998
269c9f4492SRobert Nordier.Dt BTXLD 8
279c9f4492SRobert Nordier.Os
289c9f4492SRobert Nordier.Sh NAME
299c9f4492SRobert Nordier.Nm btxld
309c9f4492SRobert Nordier.Nd link editor for BTX clients
319c9f4492SRobert Nordier.Sh SYNOPSIS
32e97407b4SRuslan Ermilov.Nm
339c9f4492SRobert Nordier.Op Fl qv
349c9f4492SRobert Nordier.Op Fl b Ar file
359c9f4492SRobert Nordier.Op Fl E Ar address
369c9f4492SRobert Nordier.Op Fl e Ar address
379c9f4492SRobert Nordier.Op Fl f Ar format
389c9f4492SRobert Nordier.Op Fl l Ar file
399c9f4492SRobert Nordier.Op Fl o Ar filename
409c9f4492SRobert Nordier.Op Fl P Ar page
419c9f4492SRobert Nordier.Op Fl W Ar page
429c9f4492SRobert Nordier.Ar file
439c9f4492SRobert Nordier.Sh DESCRIPTION
449c9f4492SRobert NordierThe
459c9f4492SRobert Nordier.Nm
469c9f4492SRobert Nordierutility binds the specified client executable together with a BTX
479c9f4492SRobert Nordierloader program and the BTX kernel, and creates a composite object file
489c9f4492SRobert Nordiersuitable for loading during the boot process.
499c9f4492SRobert Nordier.Pp
509c9f4492SRobert NordierThe options are:
519c9f4492SRobert Nordier.Bl -tag -width indent
529c9f4492SRobert Nordier.It Fl q
539c9f4492SRobert NordierQuiet: inhibit warnings.
549c9f4492SRobert Nordier.It Fl v
559c9f4492SRobert NordierVerbose: display information about the files processed.
569c9f4492SRobert Nordier.It Fl b Ar file
579c9f4492SRobert NordierSpecify the BTX kernel to be bound with the client.
589c9f4492SRobert Nordier.It Fl E Ar address
599c9f4492SRobert NordierSet the client entry point.
609c9f4492SRobert Nordier.It Fl e Ar address
619c9f4492SRobert NordierSet the BTX loader entry point.
629c9f4492SRobert Nordier.It Fl f Ar format
639c9f4492SRobert NordierSpecify the output format, where
649c9f4492SRobert Nordier.Ar format
659c9f4492SRobert Nordieris one of
669c9f4492SRobert Nordier.Sq bin ,
679c9f4492SRobert Nordier.Sq aout ,
689c9f4492SRobert Nordieror
699c9f4492SRobert Nordier.Sq elf .
709c9f4492SRobert Nordier.It Fl l Ar file
719c9f4492SRobert NordierSpecify the BTX loader to be bound with the client.
729c9f4492SRobert Nordier.It Fl o Ar filename
7307bfccd7SRuslan ErmilovName the output file.
7407bfccd7SRuslan ErmilovThe default is
759c9f4492SRobert Nordier.Dq a.out .
769c9f4492SRobert Nordier.It Fl P Ar page
779c9f4492SRobert NordierSpecify the first page of the client's segment to be marked
789c9f4492SRobert Nordier.Sq present ,
799c9f4492SRobert Nordierwhere
809c9f4492SRobert Nordier.Ar page
819c9f4492SRobert Nordiermay be 0 or 1.
829c9f4492SRobert Nordier.It Fl W Ar page
839c9f4492SRobert NordierSpecify the first page of the client's segment to be marked
849c9f4492SRobert Nordier.Sq writable ,
859c9f4492SRobert Nordierwhere
869c9f4492SRobert Nordier.Ar page
879c9f4492SRobert Nordiermay be 0, and should not exceed the number of pages occupied by the
889c9f4492SRobert Nordiercombined .text and .data segments of the client image.
899c9f4492SRobert Nordier.El
9059a3c79dSRuslan Ermilov.Sh EXIT STATUS
9159a3c79dSRuslan Ermilov.Ex -std
929c9f4492SRobert Nordier.Sh SEE ALSO
939c9f4492SRobert Nordier.Xr ld 1 ,
949c9f4492SRobert Nordier.Xr boot 8
959c9f4492SRobert Nordier.Sh AUTHORS
96*01c2b8acSBaptiste Daroussin.An Robert Nordier Aq Mt rnordier@FreeBSD.org
97