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