xref: /dflybsd-src/contrib/binutils-2.27/bfd/README (revision e656dc90e3d65d744d534af2f5ea88cf8101ebcf)
1*a9fa9459SzrjBFD is an object file library.  It permits applications to use the
2*a9fa9459Szrjsame routines to process object files regardless of their format.
3*a9fa9459Szrj
4*a9fa9459SzrjBFD is used by the GNU debugger, assembler, linker, and the binary
5*a9fa9459Szrjutilities.
6*a9fa9459Szrj
7*a9fa9459SzrjThe documentation on using BFD is scanty and may be occasionally
8*a9fa9459Szrjincorrect.  Pointers to documentation problems, or an entirely
9*a9fa9459Szrjrewritten manual, would be appreciated.
10*a9fa9459Szrj
11*a9fa9459SzrjThere is some BFD internals documentation in doc/bfdint.texi which may
12*a9fa9459Szrjhelp programmers who want to modify BFD.
13*a9fa9459Szrj
14*a9fa9459SzrjBFD is normally built as part of another package.  See the build
15*a9fa9459Szrjinstructions for that package, probably in a README file in the
16*a9fa9459Szrjappropriate directory.
17*a9fa9459Szrj
18*a9fa9459SzrjBFD supports the following configure options:
19*a9fa9459Szrj
20*a9fa9459Szrj  --target=TARGET
21*a9fa9459Szrj	The default target for which to build the library.  TARGET is
22*a9fa9459Szrj	a configuration target triplet, such as sparc-sun-solaris.
23*a9fa9459Szrj  --enable-targets=TARGET,TARGET,TARGET...
24*a9fa9459Szrj	Additional targets the library should support.  To include
25*a9fa9459Szrj	support for all known targets, use --enable-targets=all.
26*a9fa9459Szrj  --enable-64-bit-bfd
27*a9fa9459Szrj	Include support for 64 bit targets.  This is automatically
28*a9fa9459Szrj	turned on if you explicitly request a 64 bit target, but not
29*a9fa9459Szrj	for --enable-targets=all.  This requires a compiler with a 64
30*a9fa9459Szrj	bit integer type, such as gcc.
31*a9fa9459Szrj  --enable-shared
32*a9fa9459Szrj	Build BFD as a shared library.
33*a9fa9459Szrj  --with-mmap
34*a9fa9459Szrj	Use mmap when accessing files.  This is faster on some hosts,
35*a9fa9459Szrj	but slower on others.  It may not work on all hosts.
36*a9fa9459Szrj
37*a9fa9459SzrjReport bugs with BFD to bug-binutils@gnu.org.
38*a9fa9459Szrj
39*a9fa9459SzrjPatches are encouraged.  When sending patches, always send the output
40*a9fa9459Szrjof diff -u or diff -c from the original file to the new file.  Do not
41*a9fa9459Szrjsend default diff output.  Do not make the diff from the new file to
42*a9fa9459Szrjthe original file.  Remember that any patch must not break other
43*a9fa9459Szrjsystems.  Remember that BFD must support cross compilation from any
44*a9fa9459Szrjhost to any target, so patches which use ``#ifdef HOST'' are not
45*a9fa9459Szrjacceptable.  Please also read the ``Reporting Bugs'' section of the
46*a9fa9459Szrjgcc manual.
47*a9fa9459Szrj
48*a9fa9459SzrjBug reports without patches will be remembered, but they may never get
49*a9fa9459Szrjfixed until somebody volunteers to fix them.
50*a9fa9459Szrj
51*a9fa9459SzrjCopyright (C) 2012-2016 Free Software Foundation, Inc.
52*a9fa9459Szrj
53*a9fa9459SzrjCopying and distribution of this file, with or without modification,
54*a9fa9459Szrjare permitted in any medium without royalty provided the copyright
55*a9fa9459Szrjnotice and this notice are preserved.
56