usr.bin/objformat/objformat.1

   1 .\"
   2 .\" Copyright (c) 1998 David E. O'Brien
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/usr.bin/objformat/objformat.1,v 1.3.2.4 2002/06/21 15:28:32 charnier Exp $
  27 .\"
  28 .Dd October 25, 1998
  29 .Os
  30 .Dt OBJFORMAT 1
  31 .Sh NAME
  32 .Nm objformat
  33 .Nd reports default binary format and program deflector
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Nm prog
  37 .Sh DESCRIPTION
  38 If run as
  39 .Nm
  40 the default object file format is reported.  The two different object file
  41 formats are
  42 .Ar aout
  43 and
  44 .Ar elf .
  45 .Pp
  46 If invoked by any other name,
  47 .Nm prog
  48 is expanded to
  49 .Pa /usr/libexec/<objformat>/prog
  50 and executed.
  51 .Sh DIAGNOSTICS
  52 The
  53 .Nm
  54 utility returns with exit code 1
  55 if called with an improper number of arguments, or if
  56 .Nm prog
  57 could not be executed.
  58 .Sh ENVIRONMENT
  59 .Bl -tag -width OBJFORMAT_PATH
  60 .It Ev OBJFORMAT
  61 If the environment variable
  62 .Ev OBJFORMAT
  63 is set, it overrides the default object file format.
  64 .Ev OBJFORMAT takes precedence over
  65 .Pa /etc/objformat .
  66 .It Ev OBJFORMAT_PATH
  67 If the environment variable
  68 .Ev OBJFORMAT_PATH
  69 is set, its value is used as the base path to
  70 .Nm prog .
  71 The default is
  72 .Pa /usr/libexec .
  73 .El
  74 .Sh FILES
  75 .Bl -tag -width /etc/objformat -compact
  76 .It Pa /etc/objformat
  77 If present, specifies the object file format to use.  Syntax is
  78 .Ql OBJFORMAT=xxx .
  79 .El
  80 .Sh SEE ALSO
  81 .Xr file 1 ,
  82 .Xr getobjformat 3
  83 .\" .Sh STANDARDS
  84 .Sh HISTORY
  85 The
  86 .Nm
  87 command appeared in
  88 .Fx 3.0 .
  89 .Sh AUTHORS
  90 .An -nosplit
  91 The
  92 .Nm
  93 utility was written by
  94 .An Peter Wemm Aq peter@netplex.com.au .
  95 This manual page was written by
  96 .An David O'Brien Aq obrien@NUXI.com .
  97 .\" .Sh BUGS