xref: /dragonfly/usr.bin/objformat/objformat.1 (revision 650094e1)
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 May 23, 2009
29.Dt OBJFORMAT 1
30.Os
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
38If run as
39.Nm
40the default object file format is reported.
41The only supported object file format is
42.Ar elf .
43.Pp
44If invoked by any other name, the path of the
45.Nm prog
46that will be executed is determined as follows:
47.Pp
48If
49.Nm prog
50is a binutil (such as
51.Xr as 1
52and
53.Xr ld 1 ) ,
54it is expanded to
55.Pa /usr/libexec/<binutils>/elf/ Ns Nm prog
56and executed.
57.Dq <binutils>
58defaults to the current binutils version used by
59.Dx
60and can be overridden using the
61.Ev BINUTILSVER
62environment variable.
63.Pp
64If
65.Nm prog
66is a compiler (such as
67.Xr gcc 1 ) ,
68it is expanded to
69.Pa /usr/libexec/<ccver>/ Ns Nm prog
70and executed.
71.Dq <ccver>
72defaults to the current compiler used by
73.Dx
74and can be overridden using the
75.Ev CCVER
76environment variable.
77.Sh ENVIRONMENT
78.Bl -tag -width OBJFORMAT_PATH
79.It Ev BINUTILSVER
80The
81.Dq <binutils>
82component to be used for binutils paths.
83.It Ev CCVER
84The
85.Dq <ccver>
86component to be used for compiler paths.
87.It Ev OBJFORMAT_PATH
88If
89.Ev OBJFORMAT_PATH
90is set, its value is prepended to the path name determined by the
91.Nm
92rules.
93If it is a sequence of colon separated paths, each of
94.Ev OBJFORMAT_PATH Ap s
95elements is prepended to the path name until execution succeeds.
96.El
97.Sh DIAGNOSTICS
98The
99.Nm
100utility returns with exit code 1
101if called with an improper number of arguments, or if
102.Nm prog
103could not be executed.
104.Sh SEE ALSO
105.Xr file 1 ,
106.Xr getobjformat 3
107.Sh HISTORY
108The
109.Nm
110command appeared in
111.Fx 3.0 .
112.Sh AUTHORS
113.An -nosplit
114The
115.Nm
116utility was written by
117.An Peter Wemm Aq peter@netplex.com.au .
118This manual page was written by
119.An David O'Brien Aq obrien@NUXI.com .
120