xref: /openbsd/gnu/usr.bin/binutils/bfd/README (revision e93f7393)
1*e93f7393SniklasBFD is a an object file library.  It permits applications to use the
2*e93f7393Sniklassame routines to process object files regardless of their format.
3*e93f7393Sniklas
4*e93f7393SniklasBFD is used by the GNU debugger, assembler, linker, and the binary
5*e93f7393Sniklasutilities.
6*e93f7393Sniklas
7*e93f7393SniklasThe documentation on using BFD is scanty and may be occasionally
8*e93f7393Sniklasincorrect.  Pointers to documentation problems, or an entirely
9*e93f7393Sniklasrewritten manual, would be appreciated.
10*e93f7393Sniklas
11*e93f7393SniklasBFD is normally built as part of another package.  See the build
12*e93f7393Sniklasinstructions for that package, probably in a README file in the
13*e93f7393Sniklasappropriate directory.
14*e93f7393Sniklas
15*e93f7393SniklasBFD supports the following configure options:
16*e93f7393Sniklas
17*e93f7393Sniklas  --target=TARGET
18*e93f7393Sniklas	The default target for which to build the library.  TARGET is
19*e93f7393Sniklas	a configuration target triplet, such as sparc-sun-solaris.
20*e93f7393Sniklas  --enable-targets=TARGET,TARGET,TARGET...
21*e93f7393Sniklas	Additional targets the library should support.  To include
22*e93f7393Sniklas	support for all known targets, use --enable-targets=all.
23*e93f7393Sniklas  --enable-64-bit-bfd
24*e93f7393Sniklas	Include support for 64 bit targets.  This is automatically
25*e93f7393Sniklas	turned on if you explicitly request a 64 bit target, but not
26*e93f7393Sniklas	for --enable-targets=all.  This requires a compiler with a 64
27*e93f7393Sniklas	bit integer type, such as gcc.
28*e93f7393Sniklas  --enable-shared
29*e93f7393Sniklas	Build BFD as a shared library.
30*e93f7393Sniklas  --enable-commonbfdlib
31*e93f7393Sniklas	Build BFD, opcodes, and libiberty as a single shared library.
32*e93f7393Sniklas  --with-mmap
33*e93f7393Sniklas	Use mmap when accessing files.  This is faster on some hosts,
34*e93f7393Sniklas	but slower on others.  It may not work on all hosts.
35*e93f7393Sniklas
36*e93f7393SniklasReport bugs with BFD to bug-gnu-utils@prep.ai.mit.edu.
37*e93f7393Sniklas
38*e93f7393SniklasPatches are encouraged.  When sending patches, always send the output
39*e93f7393Sniklasof diff -u or diff -c from the original file to the new file.  Do not
40*e93f7393Sniklassend default diff output.  Do not make the diff from the new file to
41*e93f7393Sniklasthe original file.  Remember that any patch must not break other
42*e93f7393Sniklassystems.  Remember that BFD must support cross compilation from any
43*e93f7393Sniklashost to any target, so patches which use ``#ifdef HOST'' are not
44*e93f7393Sniklasacceptable.  Please also read the ``Reporting Bugs'' section of the
45*e93f7393Sniklasgcc manual.
46*e93f7393Sniklas
47*e93f7393SniklasBug reports without patches will be remembered, but they may never get
48*e93f7393Sniklasfixed until somebody volunteers to fix them.
49