Remove IEEE 695 object support
[deliverable/binutils-gdb.git] / bfd / doc / bfd.texinfo
index eadf87cc3451ccac1401da1af75ceafedc76e9da..8f925a1b10901f8a302f2b5c596b1adab59a36a4 100644 (file)
@@ -1,55 +1,39 @@
 \input texinfo.tex
 @setfilename bfd.info
 \input texinfo.tex
 @setfilename bfd.info
-@c $Id$
-@tex
-% NOTE LOCAL KLUGE TO AVOID TOO MUCH WHITESPACE
-\global\long\def\example{%
-\begingroup
-\let\aboveenvbreak=\par
-\let\afterenvbreak=\par
-\parskip=0pt
-\lisp}
-\global\long\def\Eexample{%
-\Elisp
-\endgroup
-\vskip -\parskip% to cancel out effect of following \par
-}
-@end tex
+@c Copyright (C) 1988-2018 Free Software Foundation, Inc.
+@c 
 @synindex fn cp
 
 @synindex fn cp
 
-@ifinfo
-@format
-START-INFO-DIR-ENTRY
+@ifnottex
+@dircategory Software development
+@direntry
 * Bfd: (bfd).                   The Binary File Descriptor library.
 * Bfd: (bfd).                   The Binary File Descriptor library.
-END-INFO-DIR-ENTRY
-@end format
-@end ifinfo
+@end direntry
+@end ifnottex
 
 
-@ifinfo
+@copying
 This file documents the BFD library.
 
 This file documents the BFD library.
 
-Copyright (C) 1991 Free Software Foundation, Inc.
+Copyright @copyright{} 1991-2018 Free Software Foundation, Inc.
 
 
-Permission is granted to make and distribute verbatim copies of
-this manual provided the copyright notice and this permission notice
-are preserved on all copies.
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with the
+Invariant Sections being ``GNU General Public License'' and ``Funding
+Free Software'', the Front-Cover texts being (a) (see below), and with
+the Back-Cover Texts being (b) (see below).  A copy of the license is
+included in the section entitled ``GNU Free Documentation License''.
 
 
-@ignore
-Permission is granted to process this file through Tex and print the
-results, provided the printed document carries copying permission
-notice identical to this one except for the removal of this paragraph
-(this paragraph not being relevant to the printed manual).
+(a) The FSF's Front-Cover Text is:
 
 
-@end ignore
-Permission is granted to copy and distribute modified versions of this
-manual under the conditions for verbatim copying, subject to the terms
-of the GNU General Public License, which includes the provision that the
-entire resulting derived work is distributed under the terms of a
-permission notice identical to this one.
-
-Permission is granted to copy and distribute translations of this manual
-into another language, under the above conditions for modified versions.
-@end ifinfo
+     A GNU Manual
+
+(b) The FSF's Back-Cover Text is:
+
+     You have freedom to copy and modify this GNU Manual, like GNU
+     software.  Copies published by the Free Software Foundation raise
+     funds for GNU development.
+@end copying
 @iftex
 @c@finalout
 @setchapternewpage on
 @iftex
 @c@finalout
 @setchapternewpage on
@@ -59,18 +43,18 @@ into another language, under the above conditions for modified versions.
 @title{libbfd}
 @subtitle{The Binary File Descriptor Library}
 @sp 1
 @title{libbfd}
 @subtitle{The Binary File Descriptor Library}
 @sp 1
-@subtitle First Edition---BFD version < 3.0
-@subtitle April 1991
+@subtitle First Edition---BFD version < 3.0  % Since no product is stable before version 3.0 :-)
+@subtitle Original Document Created: April 1991
 @author {Steve Chamberlain}
 @author {Cygnus Support}
 @page
 
 @tex
 \def\$#1${{#1}}  % Kluge: collect RCS revision info without $...$
 @author {Steve Chamberlain}
 @author {Cygnus Support}
 @page
 
 @tex
 \def\$#1${{#1}}  % Kluge: collect RCS revision info without $...$
-\xdef\manvers{\$Revision$}  % For use in headers, footers too
+\xdef\manvers{1.5}  % For use in headers, footers too
 {\parskip=0pt
 {\parskip=0pt
-\hfill Cygnus Support\par
-\hfill sac\@cygnus.com\par
+\hfill Free Software Foundation\par
+\hfill sac\@www.gnu.org\par
 \hfill {\it BFD}, \manvers\par
 \hfill \TeX{}info \texinfoversion\par
 }
 \hfill {\it BFD}, \manvers\par
 \hfill \TeX{}info \texinfoversion\par
 }
@@ -78,22 +62,18 @@ into another language, under the above conditions for modified versions.
 @end tex
 
 @vskip 0pt plus 1filll
 @end tex
 
 @vskip 0pt plus 1filll
-Copyright @copyright{} 1991 Free Software Foundation, Inc.
-
-Permission is granted to make and distribute verbatim copies of
-this manual provided the copyright notice and this permission notice
-are preserved on all copies.
+Copyright @copyright{} 1991-2018 Free Software Foundation, Inc.
 
 
-Permission is granted to copy and distribute modified versions of this
-manual under the conditions for verbatim copying, subject to the terms
-of the GNU General Public License, which includes the provision that the
-entire resulting derived work is distributed under the terms of a
-permission notice identical to this one.
+      Permission is granted to copy, distribute and/or modify this document
+      under the terms of the GNU Free Documentation License, Version 1.3
+      or any later version published by the Free Software Foundation;
+      with no Invariant Sections, with no Front-Cover Texts, and with no
+      Back-Cover Texts.  A copy of the license is included in the
+      section entitled ``GNU Free Documentation License''.
 
 
-Permission is granted to copy and distribute translations of this manual
-into another language, under the above conditions for modified versions.
 @end titlepage
 @end iftex
 @end titlepage
 @end iftex
+@contents
 
 @node Top, Overview, (dir), (dir)
 @ifinfo
 
 @node Top, Overview, (dir), (dir)
 @ifinfo
@@ -104,7 +84,8 @@ This file documents the binary file descriptor library libbfd.
 * Overview::                   Overview of BFD
 * BFD front end::              BFD front end
 * BFD back ends::              BFD back ends
 * Overview::                   Overview of BFD
 * BFD front end::              BFD front end
 * BFD back ends::              BFD back ends
-* Index::                      Index
+* GNU Free Documentation License::  GNU Free Documentation License
+* BFD Index::          BFD Index
 @end menu
 
 @node Overview, BFD front end, Top, Top
 @end menu
 
 @node Overview, BFD front end, Top, Top
@@ -164,7 +145,7 @@ To use the library, include @file{bfd.h} and link with @file{libbfd.a}.
 BFD provides a common interface to the parts of an object file
 for a calling application. 
 
 BFD provides a common interface to the parts of an object file
 for a calling application. 
 
-When an application sucessfully opens a target file (object, archive, or
+When an application successfully opens a target file (object, archive, or
 whatever), a pointer to an internal structure is returned. This pointer
 points to a structure called @code{bfd}, described in
 @file{bfd.h}.  Our convention is to call this pointer a BFD, and
 whatever), a pointer to an internal structure is returned. This pointer
 points to a structure called @code{bfd}, described in
 @file{bfd.h}.  Our convention is to call this pointer a BFD, and
@@ -177,17 +158,17 @@ For example, this sequence does what you would probably expect:
 return the number of sections in an object file attached to a BFD
 @code{abfd}. 
 
 return the number of sections in an object file attached to a BFD
 @code{abfd}. 
 
-@lisp
+@example
 @c @cartouche
 #include "bfd.h"
 
 @c @cartouche
 #include "bfd.h"
 
-unsigned int number_of_sections(abfd)
+unsigned int number_of_sections (abfd)
 bfd *abfd;
 @{
 bfd *abfd;
 @{
-  return bfd_count_sections(abfd);
+  return bfd_count_sections (abfd);
 @}
 @c @end cartouche
 @}
 @c @end cartouche
-@end lisp
+@end example
 
 The abstraction used within BFD is that an object file has:
 
 
 The abstraction used within BFD is that an object file has:
 
@@ -212,10 +193,12 @@ IEEE-695.
 @include bfdsumm.texi
 
 @node BFD front end, BFD back ends, Overview, Top
 @include bfdsumm.texi
 
 @node BFD front end, BFD back ends, Overview, Top
-@chapter BFD front end
-@include bfdt.texi
+@chapter BFD Front End
 
 @menu
 
 @menu
+* typedef bfd::
+* Error reporting::
+* Miscellaneous::
 * Memory Usage::
 * Initialization::
 * Sections::
 * Memory Usage::
 * Initialization::
 * Sections::
@@ -233,8 +216,11 @@ IEEE-695.
 * Hash Tables::
 @end menu
 
 * Hash Tables::
 @end menu
 
-@node Memory Usage, Initialization, BFD front end, BFD front end
-@section Memory usage
+@include bfdt.texi
+@include bfdio.texi
+
+@node Memory Usage, Initialization, Miscellaneous, BFD front end
+@section Memory Usage
 BFD keeps all of its internal structures in obstacks. There is one obstack
 per open BFD file, into which the current state is stored. When a BFD is
 closed, the obstack is deleted, and so everything which has been
 BFD keeps all of its internal structures in obstacks. There is one obstack
 per open BFD file, into which the current state is stored. When a BFD is
 closed, the obstack is deleted, and so everything which has been
@@ -298,20 +284,21 @@ structures.
 @node Hash Tables, , Linker Functions, BFD front end
 @include  hash.texi
 
 @node Hash Tables, , Linker Functions, BFD front end
 @include  hash.texi
 
-@node BFD back ends, Index, BFD front end, Top
+@node BFD back ends, GNU Free Documentation License, BFD front end, Top
 @chapter BFD back ends
 @menu
 * What to Put Where::
 * aout ::      a.out backends
 * coff ::      coff backends
 * elf  ::      elf backends
 @chapter BFD back ends
 @menu
 * What to Put Where::
 * aout ::      a.out backends
 * coff ::      coff backends
 * elf  ::      elf backends
+* mmo  ::      mmo backend
 @ignore
 * oasys ::     oasys backends
 @ignore
 * oasys ::     oasys backends
-* ieee ::      ieee backend
 * srecord ::   s-record backend
 @end ignore
 @end menu
 @node What to Put Where, aout, BFD back ends, BFD back ends
 * srecord ::   s-record backend
 @end ignore
 @end menu
 @node What to Put Where, aout, BFD back ends, BFD back ends
+@section What to Put Where
 All of BFD lives in one directory.
 
 @node aout, coff, What to Put Where, BFD back ends
 All of BFD lives in one directory.
 
 @node aout, coff, What to Put Where, BFD back ends
@@ -320,17 +307,23 @@ All of BFD lives in one directory.
 @node coff, elf, aout, BFD back ends
 @include  coffcode.texi
 
 @node coff, elf, aout, BFD back ends
 @include  coffcode.texi
 
-@node elf,  , coff, BFD back ends
+@node elf, mmo, coff, BFD back ends
 @include  elf.texi
 @c Leave this out until the file has some actual contents...
 @c @include  elfcode.texi
 
 @include  elf.texi
 @c Leave this out until the file has some actual contents...
 @c @include  elfcode.texi
 
-@node Index,  , BFD back ends , Top
-@unnumbered Index
+@node mmo,  , elf, BFD back ends
+@include  mmo.texi
+
+@node GNU Free Documentation License, BFD Index, BFD back ends, Top
+@include fdl.texi
+
+@node BFD Index,  , GNU Free Documentation License, Top
+@unnumbered BFD Index
 @printindex cp
 
 @tex
 @printindex cp
 
 @tex
-% I think something like @colophon should be in texinfo.  In the
+% I think something like @@colophon should be in texinfo.  In the
 % meantime:
 \long\def\colophon{\hbox to0pt{}\vfill
 \centerline{The body of this manual is set in}
 % meantime:
 \long\def\colophon{\hbox to0pt{}\vfill
 \centerline{The body of this manual is set in}
@@ -341,8 +334,7 @@ All of BFD lives in one directory.
 \centerline{{\sl\fontname\tensl\/}}
 \centerline{are used for emphasis.}\vfill}
 \page\colophon
 \centerline{{\sl\fontname\tensl\/}}
 \centerline{are used for emphasis.}\vfill}
 \page\colophon
-% Blame: doc@cygnus.com, 28mar91.
+% Blame: doc@@cygnus.com, 28mar91.
 @end tex
 
 @end tex
 
-@contents
 @bye
 @bye
This page took 0.027152 seconds and 4 git commands to generate.