xref: /dragonfly/usr.bin/objformat/objformat.1 (revision 333227be)
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.\" $DragonFly: src/usr.bin/objformat/objformat.1,v 1.2 2003/06/17 04:29:30 dillon Exp $
28.\"
29.Dd October 25, 1998
30.Os
31.Dt OBJFORMAT 1
32.Sh NAME
33.Nm objformat
34.Nd reports default binary format and program deflector
35.Sh SYNOPSIS
36.Nm
37.Nm prog
38.Sh DESCRIPTION
39If run as
40.Nm
41the default object file format is reported.  The two different object file
42formats are
43.Ar aout
44and
45.Ar elf .
46.Pp
47If invoked by any other name,
48.Nm prog
49is expanded to
50.Pa /usr/libexec/<objformat>/prog
51and executed.
52.Sh DIAGNOSTICS
53The
54.Nm
55utility returns with exit code 1
56if called with an improper number of arguments, or if
57.Nm prog
58could not be executed.
59.Sh ENVIRONMENT
60.Bl -tag -width OBJFORMAT_PATH
61.It Ev OBJFORMAT
62If the environment variable
63.Ev OBJFORMAT
64is set, it overrides the default object file format.
65.Ev OBJFORMAT takes precedence over
66.Pa /etc/objformat .
67.It Ev OBJFORMAT_PATH
68If the environment variable
69.Ev OBJFORMAT_PATH
70is set, its value is used as the base path to
71.Nm prog .
72The default is
73.Pa /usr/libexec .
74.El
75.Sh FILES
76.Bl -tag -width /etc/objformat -compact
77.It Pa /etc/objformat
78If present, specifies the object file format to use.  Syntax is
79.Ql OBJFORMAT=xxx .
80.El
81.Sh SEE ALSO
82.Xr file 1 ,
83.Xr getobjformat 3
84.\" .Sh STANDARDS
85.Sh HISTORY
86The
87.Nm
88command appeared in
89.Fx 3.0 .
90.Sh AUTHORS
91.An -nosplit
92The
93.Nm
94utility was written by
95.An Peter Wemm Aq peter@netplex.com.au .
96This manual page was written by
97.An David O'Brien Aq obrien@NUXI.com .
98.\" .Sh BUGS
99