189857SobrienBFD is an object file library.  It permits applications to use the
233965Sjdpsame routines to process object files regardless of their format.
333965Sjdp
433965SjdpBFD is used by the GNU debugger, assembler, linker, and the binary
533965Sjdputilities.
633965Sjdp
733965SjdpThe documentation on using BFD is scanty and may be occasionally
833965Sjdpincorrect.  Pointers to documentation problems, or an entirely
933965Sjdprewritten manual, would be appreciated.
1033965Sjdp
1160484SobrienThere is some BFD internals documentation in doc/bfdint.texi which may
1260484Sobrienhelp programmers who want to modify BFD.
1360484Sobrien
1433965SjdpBFD is normally built as part of another package.  See the build
1533965Sjdpinstructions for that package, probably in a README file in the
1633965Sjdpappropriate directory.
1733965Sjdp
1833965SjdpBFD supports the following configure options:
1933965Sjdp
2033965Sjdp  --target=TARGET
2133965Sjdp	The default target for which to build the library.  TARGET is
2233965Sjdp	a configuration target triplet, such as sparc-sun-solaris.
2333965Sjdp  --enable-targets=TARGET,TARGET,TARGET...
2433965Sjdp	Additional targets the library should support.  To include
2533965Sjdp	support for all known targets, use --enable-targets=all.
2633965Sjdp  --enable-64-bit-bfd
2733965Sjdp	Include support for 64 bit targets.  This is automatically
2833965Sjdp	turned on if you explicitly request a 64 bit target, but not
2933965Sjdp	for --enable-targets=all.  This requires a compiler with a 64
3033965Sjdp	bit integer type, such as gcc.
3133965Sjdp  --enable-shared
3233965Sjdp	Build BFD as a shared library.
3333965Sjdp  --with-mmap
3433965Sjdp	Use mmap when accessing files.  This is faster on some hosts,
3533965Sjdp	but slower on others.  It may not work on all hosts.
3633965Sjdp
3777298SobrienReport bugs with BFD to bug-binutils@gnu.org.
3833965Sjdp
3933965SjdpPatches are encouraged.  When sending patches, always send the output
4033965Sjdpof diff -u or diff -c from the original file to the new file.  Do not
4133965Sjdpsend default diff output.  Do not make the diff from the new file to
4233965Sjdpthe original file.  Remember that any patch must not break other
4333965Sjdpsystems.  Remember that BFD must support cross compilation from any
4433965Sjdphost to any target, so patches which use ``#ifdef HOST'' are not
4533965Sjdpacceptable.  Please also read the ``Reporting Bugs'' section of the
4633965Sjdpgcc manual.
4733965Sjdp
4833965SjdpBug reports without patches will be remembered, but they may never get
4933965Sjdpfixed until somebody volunteers to fix them.
50