xref: /dflybsd-src/contrib/gdb-7/bfd/README (revision de8e141f24382815c10a4012d209bbbf7abf1112)
15796c8dcSSimon SchubertBFD is an object file library.  It permits applications to use the
25796c8dcSSimon Schubertsame routines to process object files regardless of their format.
35796c8dcSSimon Schubert
45796c8dcSSimon SchubertBFD is used by the GNU debugger, assembler, linker, and the binary
55796c8dcSSimon Schubertutilities.
65796c8dcSSimon Schubert
75796c8dcSSimon SchubertThe documentation on using BFD is scanty and may be occasionally
85796c8dcSSimon Schubertincorrect.  Pointers to documentation problems, or an entirely
95796c8dcSSimon Schubertrewritten manual, would be appreciated.
105796c8dcSSimon Schubert
115796c8dcSSimon SchubertThere is some BFD internals documentation in doc/bfdint.texi which may
125796c8dcSSimon Schuberthelp programmers who want to modify BFD.
135796c8dcSSimon Schubert
145796c8dcSSimon SchubertBFD is normally built as part of another package.  See the build
155796c8dcSSimon Schubertinstructions for that package, probably in a README file in the
165796c8dcSSimon Schubertappropriate directory.
175796c8dcSSimon Schubert
185796c8dcSSimon SchubertBFD supports the following configure options:
195796c8dcSSimon Schubert
205796c8dcSSimon Schubert  --target=TARGET
215796c8dcSSimon Schubert	The default target for which to build the library.  TARGET is
225796c8dcSSimon Schubert	a configuration target triplet, such as sparc-sun-solaris.
235796c8dcSSimon Schubert  --enable-targets=TARGET,TARGET,TARGET...
245796c8dcSSimon Schubert	Additional targets the library should support.  To include
255796c8dcSSimon Schubert	support for all known targets, use --enable-targets=all.
265796c8dcSSimon Schubert  --enable-64-bit-bfd
275796c8dcSSimon Schubert	Include support for 64 bit targets.  This is automatically
285796c8dcSSimon Schubert	turned on if you explicitly request a 64 bit target, but not
295796c8dcSSimon Schubert	for --enable-targets=all.  This requires a compiler with a 64
305796c8dcSSimon Schubert	bit integer type, such as gcc.
315796c8dcSSimon Schubert  --enable-shared
325796c8dcSSimon Schubert	Build BFD as a shared library.
335796c8dcSSimon Schubert  --with-mmap
345796c8dcSSimon Schubert	Use mmap when accessing files.  This is faster on some hosts,
355796c8dcSSimon Schubert	but slower on others.  It may not work on all hosts.
365796c8dcSSimon Schubert
375796c8dcSSimon SchubertReport bugs with BFD to bug-binutils@gnu.org.
385796c8dcSSimon Schubert
395796c8dcSSimon SchubertPatches are encouraged.  When sending patches, always send the output
405796c8dcSSimon Schubertof diff -u or diff -c from the original file to the new file.  Do not
415796c8dcSSimon Schubertsend default diff output.  Do not make the diff from the new file to
425796c8dcSSimon Schubertthe original file.  Remember that any patch must not break other
435796c8dcSSimon Schubertsystems.  Remember that BFD must support cross compilation from any
445796c8dcSSimon Schuberthost to any target, so patches which use ``#ifdef HOST'' are not
455796c8dcSSimon Schubertacceptable.  Please also read the ``Reporting Bugs'' section of the
465796c8dcSSimon Schubertgcc manual.
475796c8dcSSimon Schubert
485796c8dcSSimon SchubertBug reports without patches will be remembered, but they may never get
495796c8dcSSimon Schubertfixed until somebody volunteers to fix them.
50*ef5ccd6cSJohn Marino
51*ef5ccd6cSJohn MarinoCopyright (C) 2012 Free Software Foundation, Inc.
52*ef5ccd6cSJohn Marino
53*ef5ccd6cSJohn MarinoCopying and distribution of this file, with or without modification,
54*ef5ccd6cSJohn Marinoare permitted in any medium without royalty provided the copyright
55*ef5ccd6cSJohn Marinonotice and this notice are preserved.
56