6/lib/libc/gen/getobjformat.3

   1 .\" Copyright (c) 1998 John D. Polstra
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd September 7, 1998
  28 .Dt GETOBJFORMAT 3
  29 .Os
  30 .Sh NAME
  31 .Nm getobjformat
  32 .Nd get preferred object file format
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In objformat.h
  37 .Ft int
  38 .Fn getobjformat "char *buf" "size_t bufsize" "int *argcp" "char **argv"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn getobjformat
  42 function
  43 queries several sources to determine the preferred object file
  44 format, and copies its name into a buffer provided by the caller.
  45 .Pp
  46 The object file format is determined as follows.
  47 If
  48 .Va argv
  49 is
  50 .No non- Ns Ev NULL
  51 and an explicit command line argument such as
  52 .Fl aout
  53 or
  54 .Fl elf
  55 is present, then that determines the object file format.
  56 .Pp
  57 Otherwise, if the variable
  58 .Ev OBJFORMAT
  59 is set in the environment, the object file format is taken from its
  60 value.
  61 .Pp
  62 Otherwise, if the file
  63 .Pa /etc/objformat
  64 is readable and contains a line of the form
  65 .Ql OBJFORMAT=xxx ,
  66 the object file format is taken from there.
  67 .Pp
  68 Otherwise, a built-in system default object file format is returned.
  69 .Pp
  70 .Va buf
  71 points to a user-supplied buffer into which the name of the object
  72 file format is copied.
  73 .Va bufsize
  74 gives the size of the buffer in bytes.
  75 The string placed in
  76 .Va buf
  77 is always null-terminated.
  78 It is an error if the buffer is too
  79 small to hold the null-terminated name.
  80 .Pp
  81 .Va argv
  82 points to a
  83 .Dv NULL Ns -terminated
  84 argument vector to be scanned for object
  85 format options.
  86 .Va argv
  87 may be
  88 .Dv NULL ,
  89 in which case the argument vector is not scanned.
  90 .Pp
  91 If
  92 .Va argcp
  93 is non-NULL, any object format options are deleted from the
  94 argument vector, and the updated argument count is stored into
  95 the integer referenced by
  96 .Va argcp .
  97 If
  98 .Va argcp
  99 is
 100 .Dv NULL ,
 101 the argument vector is left unchanged.
 102 .Sh RETURN VALUES
 103 On success,
 104 .Fn getobjformat
 105 returns the length of the object file format name, not counting the
 106 null terminator.
 107 If the supplied buffer is too small to hold the object file format
 108 and its null terminator,
 109 .Fn getobjformat
 110 returns -1.
 111 In that case, the contents of the buffer and argument
 112 vector supplied by the caller are indeterminate.
 113 .Sh ENVIRONMENT
 114 .Bl -tag -width OBJFORMAT
 115 .It Ev OBJFORMAT
 116 If the environment variable
 117 .Ev OBJFORMAT
 118 is set, it overrides the default object file format.
 119 .Ev OBJFORMAT
 120 takes precedence over
 121 .Pa /etc/objformat .
 122 .El
 123 .Sh FILES
 124 .Bl -tag -width /etc/objformat -compact
 125 .It Pa /etc/objformat
 126 If present, specifies the object file format to use.
 127 Syntax is
 128 .Ql OBJFORMAT=xxx .
 129 .El
 130 .Sh SEE ALSO
 131 .Xr objformat 1
 132 .Sh HISTORY
 133 The
 134 .Fn getobjformat
 135 function first appeared in
 136 .Fx 3.0 .