freebsd-dev/usr.bin/objformat/objformat.1
2001-07-15 08:06:20 +00:00

97 lines
2.7 KiB
Groff

.\"
.\" Copyright (c) 1998 David E. O'Brien
.\"
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd October 25, 1998
.Os
.Dt OBJFORMAT 1
.Sh NAME
.Nm objformat
.Nd reports default binary format and program deflector
.Sh SYNOPSIS
.Nm
.Nm prog
.Sh DESCRIPTION
If run as
.Nm
the default object file format is reported. The two different object file
formats are
.Ar aout
and
.Ar elf .
.Pp
If invoked by any other name,
.Nm prog
is expanded to
.Pa /usr/libexec/<objformat>/prog
and executed.
.Sh DIAGNOSTICS
The
.Nm
utility returns with exit code 1
if called with an improper number of arguments, or if
.Nm prog
could not be executed.
.Sh ENVIRONMENT
.Bl -tag -width OBJFORMAT_PATH
.It Ev OBJFORMAT
If the environment variable
.Ev OBJFORMAT
is set, it overrides the default object file format.
.Ev OBJFORMAT takes precedence over
.Pa /etc/objformat .
.It Ev OBJFORMAT_PATH
If the environment variable
.Ev OBJFORMAT_PATH
is set, its value is used as the base path to
.Nm prog .
The default is
.Pa /usr/libexec .
.El
.Sh FILES
.Bl -tag -width /etc/objformat -compact
.It Pa /etc/objformat
If present, specifies the object file format to use. Syntax is
.Ql OBJFORMAT=xxx .
.El
.Sh SEE ALSO
.Xr file 1 ,
.Xr getobjformat 3
.\" .Sh STANDARDS
.Sh HISTORY
The
.Nm
command appeared in
.Fx 3.0 .
.Sh AUTHORS
.An -nosplit
.Nm
was written by
.An Peter Wemm Aq peter@netplex.com.au .
This manual page was written by
.An David O'Brien Aq obrien@NUXI.com .
.\" .Sh BUGS