d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
613e383e81
freebsd-dev/lib/libc/gen/getobjformat.3

136 lines
3.8 KiB
Groff
Raw Normal View History

Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.\" Copyright (c) 1998 John D. Polstra
.\" 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 AUTHOR AND CONTRIBUTORS ``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 AUTHOR OR CONTRIBUTORS 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.
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.\"
.Dd September 7, 1998
.Dt GETOBJFORMAT 3
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 13:41:46 +00:00
.Os
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.Sh NAME
.Nm getobjformat
.Nd get preferred object file format
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following.
2000-04-21 09:42:15 +00:00
.Sh LIBRARY
.Lb libc
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In objformat.h
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.Ft int
.Fn getobjformat "char *buf" "size_t bufsize" "int *argcp" "char **argv"
.Sh DESCRIPTION
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
The
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.Fn getobjformat
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
function
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
queries several sources to determine the preferred object file
format, and copies its name into a buffer provided by the caller.
.Pp
Mechanically kill hard sentence breaks.
2004-07-02 23:52:20 +00:00
The object file format is determined as follows.
If
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.Va argv
is
.No non- Ns Ev NULL
and an explicit command line argument such as
.Fl aout
or
.Fl elf
is present, then that determines the object file format.
.Pp
Otherwise, if the variable
.Ev OBJFORMAT
is set in the environment, the object file format is taken from its
value.
.Pp
Otherwise, if the file
.Pa /etc/objformat
is readable and contains a line of the form
.Ql OBJFORMAT=xxx ,
the object file format is taken from there.
.Pp
Otherwise, a built-in system default object file format is returned.
.Pp
.Va buf
points to a user-supplied buffer into which the name of the object
file format is copied.
.Va bufsize
Mechanically kill hard sentence breaks.
2004-07-02 23:52:20 +00:00
gives the size of the buffer in bytes.
The string placed in
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.Va buf
Mechanically kill hard sentence breaks.
2004-07-02 23:52:20 +00:00
is always null-terminated.
It is an error if the buffer is too
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
small to hold the null-terminated name.
.Pp
.Va argv
points to a
.Dv NULL Ns -terminated
argument vector to be scanned for object
format options.
.Va argv
may be
.Dv NULL ,
in which case the argument vector is not scanned.
.Pp
If
.Va argcp
is non-NULL, any object format options are deleted from the
argument vector, and the updated argument count is stored into
the integer referenced by
.Va argcp .
If
.Va argcp
is
.Dv NULL ,
the argument vector is left unchanged.
.Sh RETURN VALUES
On success,
.Fn getobjformat
returns the length of the object file format name, not counting the
null terminator.
If the supplied buffer is too small to hold the object file format
and its null terminator,
.Fn getobjformat
Mechanically kill hard sentence breaks.
2004-07-02 23:52:20 +00:00
returns -1.
In that case, the contents of the buffer and argument
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
vector supplied by the caller are indeterminate.
.Sh ENVIRONMENT
Slight style police. Add some content from objformat(1).
1998-10-25 13:29:57 +00:00
.Bl -tag -width OBJFORMAT
.It Ev OBJFORMAT
If the environment variable
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.Ev OBJFORMAT
Slight style police. Add some content from objformat(1).
1998-10-25 13:29:57 +00:00
is set, it overrides the default object file format.
.Ev OBJFORMAT takes precedence over
.Pa /etc/objformat .
Prepare for mdoc(7)NG.
2000-12-29 14:08:20 +00:00
.El
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.Sh FILES
Slight style police. Add some content from objformat(1).
1998-10-25 13:29:57 +00:00
.Bl -tag -width /etc/objformat -compact
.It Pa /etc/objformat
Mechanically kill hard sentence breaks.
2004-07-02 23:52:20 +00:00
If present, specifies the object file format to use.
Syntax is
Slight style police. Add some content from objformat(1).
1998-10-25 13:29:57 +00:00
.Ql OBJFORMAT=xxx .
Prepare for mdoc(7)NG.
2000-12-29 14:08:20 +00:00
.El
Add a new library function getobjformat(). It checks all the standard places ("/etc/objformat", ${OBJFORMAT}, argv) for an indication of the user's preferred object file format. This consolidates some code that was starting to be duplicated in more and more places. Use the new function in ldconfig. Note: I don't think that gcc should use getobjformat(), even though it could. The compiler should limit itself to functions that are widespread, to ease porting and cross-compilation.
1998-09-09 01:21:25 +00:00
.Sh SEE ALSO
.Xr objformat 1
.Sh HISTORY
The
.Fn getobjformat
Whitespace only change: trim trailing whitespace.
2000-10-30 13:23:19 +00:00
function first appeared in
Slight style police. Add some content from objformat(1).
1998-10-25 13:29:57 +00:00
.Fx 3.0 .
Reference in New Issue Copy Permalink