usr.sbin/btxld/btxld.8

   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: src/usr.sbin/btxld/btxld.8,v 1.2.2.2 2001/08/16 15:55:41 ru Exp $
  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
  46 The
  47 .Nm
  48 utility binds the specified client executable together with a BTX
  49 loader program and the BTX kernel, and creates a composite object file
  50 suitable for loading during the boot process.
  51 .Pp
  52 The options are:
  53 .Bl -tag -width indent
  54 .It Fl q
  55 Quiet: inhibit warnings.
  56 .It Fl v
  57 Verbose: display information about the files processed.
  58 .It Fl b Ar file
  59 Specify the BTX kernel to be bound with the client.
  60 .It Fl E Ar address
  61 Set the client entry point.
  62 .It Fl e Ar address
  63 Set the BTX loader entry point.
  64 .It Fl f Ar format
  65 Specify the output format, where
  66 .Ar format
  67 is one of
  68 .Sq bin ,
  69 .Sq aout ,
  70 or
  71 .Sq elf .
  72 .It Fl l Ar file
  73 Specify the BTX loader to be bound with the client.
  74 .It Fl o Ar filename
  75 Name the output file.  The default is
  76 .Dq a.out .
  77 .It Fl P Ar page
  78 Specify the first page of the client's segment to be marked
  79 .Sq present ,
  80 where
  81 .Ar page
  82 may be 0 or 1.
  83 .It Fl W Ar page
  84 Specify the first page of the client's segment to be marked
  85 .Sq writable ,
  86 where
  87 .Ar page
  88 may be 0, and should not exceed the number of pages occupied by the
  89 combined .text and .data segments of the client image.
  90 .El
  91 .Sh EXIT STATUS
  92 .Ex -std
  93 .Sh SEE ALSO
  94 .Xr ld 1 ,
  95 .Xr boot 8
  96 .Sh AUTHORS
  97 .An Robert Nordier Aq Mt rnordier@FreeBSD.org .