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