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