This is the mail archive of the
binutils@sources.redhat.com
mailing list for the binutils project.
[PATCH] Clean up ld docs (part 1)
- From: Bob Wilson <bwilson at tensilica dot com>
- To: binutils at sources dot redhat dot com
- Date: Fri, 14 Feb 2003 15:29:21 -0800
- Subject: [PATCH] Clean up ld docs (part 1)
- Organization: Tensilica, Inc.
This patch cleans up the ld documentation in much the same way as my patches
for binutils and bfd docs. I'm splitting this into 2 patches so that it is
more clear what is changed. The second patch moves the entire WIN32 node,
because it is currently stuck in between two Hitachi-specific nodes and the
menus show that it should be positioned after the TI COFF node. I'm going to
send the second patch separately.
2003-02-14 Bob Wilson <bob.wilson@acm.org>
* gen-doc.texi: Set ARM and HPPA variables.
* ld.texinfo: Fix typos and obvious texinfo mistakes. Make section
title capitalization more consistent. Add missing menu entries for
machine-specific sections and conditionalize them consistently.
Conditionalize text that is irrelevant when SingleFormat is set.
Add @group divisions to improve page breaks in long examples.
Use @iftex/@ifnottex instead of @iftex/@ifinfo so that HTML output
is correct. Remove "FIXME" comment about not using
@raisesections/@lowersections. Use @raisesections/@lowersections
consistently for machine-specific sections. Change to be more polite
about poor bug reports. Replace FDL appendix with include of fdl.texi.
* fdl.texi: New file.
Index: gen-doc.texi
===================================================================
RCS file: /cvs/src/src/ld/gen-doc.texi,v
retrieving revision 1.5
diff -c -3 -r1.5 gen-doc.texi
*** gen-doc.texi 30 Dec 2002 19:25:04 -0000 1.5
--- gen-doc.texi 13 Feb 2003 18:22:58 -0000
***************
*** 5,10 ****
--- 5,12 ----
@c 2. Specific target machines
@set H8300
@set I960
+ @set ARM
+ @set HPPA
@set MMIX
@set MSP430
@set TICOFF
Index: ld.texinfo
===================================================================
RCS file: /cvs/src/src/ld/ld.texinfo,v
retrieving revision 1.84
diff -c -3 -r1.84 ld.texinfo
*** ld.texinfo 23 Jan 2003 09:30:43 -0000 1.84
--- ld.texinfo 14 Feb 2003 22:45:00 -0000
***************
*** 69,75 ****
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 process this file through Tex and print the
results, provided the printed document carries copying permission
--- 69,75 ----
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 process this file through Tex and print the
results, provided the printed document carries copying permission
***************
*** 112,118 ****
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".
@c man end
@end titlepage
--- 112,118 ----
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''.
@c man end
@end titlepage
***************
*** 126,132 ****
This document is distributed under the terms of the GNU Free
Documentation License. A copy of the license is included in the
! section entitled "GNU Free Documentation License".
@menu
* Overview:: Overview
--- 126,132 ----
This document is distributed under the terms of the GNU Free
Documentation License. A copy of the license is included in the
! section entitled ``GNU Free Documentation License''.
@menu
* Overview:: Overview
***************
*** 145,150 ****
--- 145,156 ----
@ifset I960
* i960:: ld and the Intel 960 family
@end ifset
+ @ifset ARM
+ * ARM:: ld and the ARM family
+ @end ifset
+ @ifset HPPA
+ * HPPA ELF32:: ld and HPPA 32-bit ELF
+ @end ifset
@ifset TICOFF
* TI COFF:: ld and the TI COFF
@end ifset
***************
*** 280,286 ****
are specified, the linker does not produce any output, and issues the
message @samp{No input files}.
! If the linker can not recognize the format of an object file, it will
assume that it is a linker script. A script specified in this way
augments the main linker script used for the link (either the default
linker script or the one specified by using @samp{-T}). This feature
--- 286,292 ----
are specified, the linker does not produce any output, and issues the
message @samp{No input files}.
! If the linker cannot recognize the format of an object file, it will
assume that it is a linker script. A script specified in this way
augments the main linker script used for the link (either the default
linker script or the one specified by using @samp{-T}). This feature
***************
*** 298,304 ****
For options whose names are multiple letters, either one dash or two can
precede the option name; for example, @samp{-trace-symbol} and
! @samp{--trace-symbol} are equivalent. Note - there is one exception to
this rule. Multiple letter options that start with a lower case 'o' can
only be preceeded by two dashes. This is to reduce confusion with the
@samp{-o} option. So for example @samp{-omagic} sets the output file
--- 304,310 ----
For options whose names are multiple letters, either one dash or two can
precede the option name; for example, @samp{-trace-symbol} and
! @samp{--trace-symbol} are equivalent. Note---there is one exception to
this rule. Multiple letter options that start with a lower case 'o' can
only be preceeded by two dashes. This is to reduce confusion with the
@samp{-o} option. So for example @samp{-omagic} sets the output file
***************
*** 312,319 ****
Unique abbreviations of the names of multiple-letter options are
accepted.
! Note - if the linker is being invoked indirectly, via a compiler driver
! (eg @samp{gcc}) then all the linker command line options should be
prefixed by @samp{-Wl,} (or whatever is appropriate for the particular
compiler driver) like this:
--- 318,325 ----
Unique abbreviations of the names of multiple-letter options are
accepted.
! Note---if the linker is being invoked indirectly, via a compiler driver
! (e.g., @samp{gcc}) then all the linker command line options should be
prefixed by @samp{-Wl,} (or whatever is appropriate for the particular
compiler driver) like this:
***************
*** 458,463 ****
--- 464,470 ----
be added to the dynamic symbol table if the output format supports it.
See the description of @samp{--version-script} in @ref{VERSION}.
+ @ifclear SingleFormat
@cindex big-endian objects
@cindex endianness
@kindex -EB
***************
*** 468,473 ****
--- 475,481 ----
@kindex -EL
@item -EL
Link little-endian objects. This affects the default output format.
+ @end ifclear
@kindex -f
@kindex --auxiliary
***************
*** 510,519 ****
Some older linkers used the @option{-F} option throughout a compilation
toolchain for specifying object-file format for both input and output
! object files. The @sc{gnu} linker uses other mechanisms for this
purpose: the @option{-b}, @option{--format}, @option{--oformat} options, the
@code{TARGET} command in linker scripts, and the @code{GNUTARGET}
! environment variable. The @sc{gnu} linker will ignore the @option{-F}
option when not creating an ELF shared object.
@cindex finalization function
--- 518,531 ----
Some older linkers used the @option{-F} option throughout a compilation
toolchain for specifying object-file format for both input and output
! object files.
! @ifclear SingleFormat
! The @sc{gnu} linker uses other mechanisms for this
purpose: the @option{-b}, @option{--format}, @option{--oformat} options, the
@code{TARGET} command in linker scripts, and the @code{GNUTARGET}
! environment variable.
! @end ifclear
! The @sc{gnu} linker will ignore the @option{-F}
option when not creating an ELF shared object.
@cindex finalization function
***************
*** 1424,1430 ****
@itemx --version-script=@var{version-scriptfile}
Specify the name of a version script to the linker. This is typically
used when creating shared libraries to specify additional information
! about the version heirarchy for the library being created. This option
is only meaningful on ELF platforms which support shared libraries.
@xref{VERSION}.
--- 1436,1442 ----
@itemx --version-script=@var{version-scriptfile}
Specify the name of a version script to the linker. This is typically
used when creating shared libraries to specify additional information
! about the version hierarchy for the library being created. This option
is only meaningful on ELF platforms which support shared libraries.
@xref{VERSION}.
***************
*** 1615,1621 ****
@c man end
! @subsection Options specific to i386 PE targets
@c man begin OPTIONS
--- 1627,1633 ----
@c man end
! @subsection Options Specific to i386 PE Targets
@c man begin OPTIONS
***************
*** 1657,1663 ****
@item --enable-stdcall-fixup
@itemx --disable-stdcall-fixup
If the link finds a symbol that it cannot resolve, it will attempt to
! do "fuzzy linking" by looking for another defined symbol that differs
only in the format of the symbol name (cdecl vs stdcall) and will
resolve that symbol by linking to the match. For example, the
undefined symbol @code{_foo} might be linked to the function
--- 1669,1675 ----
@item --enable-stdcall-fixup
@itemx --disable-stdcall-fixup
If the link finds a symbol that it cannot resolve, it will attempt to
! do ``fuzzy linking'' by looking for another defined symbol that differs
only in the format of the symbol name (cdecl vs stdcall) and will
resolve that symbol by linking to the match. For example, the
undefined symbol @code{_foo} might be linked to the function
***************
*** 1740,1766 ****
@kindex --major-image-version
@item --major-image-version @var{value}
! Sets the major number of the "image version". Defaults to 1.
@kindex --major-os-version
@item --major-os-version @var{value}
! Sets the major number of the "os version". Defaults to 4.
@kindex --major-subsystem-version
@item --major-subsystem-version @var{value}
! Sets the major number of the "subsystem version". Defaults to 4.
@kindex --minor-image-version
@item --minor-image-version @var{value}
! Sets the minor number of the "image version". Defaults to 0.
@kindex --minor-os-version
@item --minor-os-version @var{value}
! Sets the minor number of the "os version". Defaults to 0.
@kindex --minor-subsystem-version
@item --minor-subsystem-version @var{value}
! Sets the minor number of the "subsystem version". Defaults to 0.
@cindex DEF files, creating
@cindex DLLs, creating
--- 1752,1778 ----
@kindex --major-image-version
@item --major-image-version @var{value}
! Sets the major number of the ``image version''. Defaults to 1.
@kindex --major-os-version
@item --major-os-version @var{value}
! Sets the major number of the ``os version''. Defaults to 4.
@kindex --major-subsystem-version
@item --major-subsystem-version @var{value}
! Sets the major number of the ``subsystem version''. Defaults to 4.
@kindex --minor-image-version
@item --minor-image-version @var{value}
! Sets the minor number of the ``image version''. Defaults to 0.
@kindex --minor-os-version
@item --minor-os-version @var{value}
! Sets the minor number of the ``os version''. Defaults to 0.
@kindex --minor-subsystem-version
@item --minor-subsystem-version @var{value}
! Sets the minor number of the ``subsystem version''. Defaults to 0.
@cindex DEF files, creating
@cindex DLLs, creating
***************
*** 1979,1986 ****
@c man begin ENVIRONMENT
You can change the behavior of @command{ld} with the environment variables
! @code{GNUTARGET}, @code{LDEMULATION}, and @code{COLLECT_NO_DEMANGLE}.
@kindex GNUTARGET
@cindex default input format
@code{GNUTARGET} determines the input-file object format if you don't
--- 1991,2002 ----
@c man begin ENVIRONMENT
You can change the behavior of @command{ld} with the environment variables
! @ifclear SingleFormat
! @code{GNUTARGET},
! @end ifclear
! @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}.
+ @ifclear SingleFormat
@kindex GNUTARGET
@cindex default input format
@code{GNUTARGET} determines the input-file object format if you don't
***************
*** 1994,1999 ****
--- 2010,2016 ----
object-file formats is unique. However, the configuration procedure for
BFD on each system places the conventional format for that system first
in the search-list, so ambiguities are resolved in favor of convention.
+ @end ifclear
@kindex LDEMULATION
@cindex default emulation
***************
*** 2220,2226 ****
@end menu
@node Entry Point
! @subsection Setting the entry point
@kindex ENTRY(@var{symbol})
@cindex start of execution
@cindex first instruction
--- 2237,2243 ----
@end menu
@node Entry Point
! @subsection Setting the Entry Point
@kindex ENTRY(@var{symbol})
@cindex start of execution
@cindex first instruction
***************
*** 2249,2255 ****
@end itemize
@node File Commands
! @subsection Commands dealing with files
@cindex linker script file commands
Several linker script commands deal with files.
--- 2266,2272 ----
@end itemize
@node File Commands
! @subsection Commands Dealing with Files
@cindex linker script file commands
Several linker script commands deal with files.
***************
*** 2336,2342 ****
@ifclear SingleFormat
@node Format Commands
! @subsection Commands dealing with object file formats
A couple of linker script commands deal with object file formats.
@table @code
--- 2353,2359 ----
@ifclear SingleFormat
@node Format Commands
! @subsection Commands Dealing with Object File Formats
A couple of linker script commands deal with object file formats.
@table @code
***************
*** 2383,2389 ****
@end ifclear
@node Miscellaneous Commands
! @subsection Other linker script commands
There are a few other linker scripts commands.
@table @code
--- 2400,2406 ----
@end ifclear
@node Miscellaneous Commands
! @subsection Other Linker Script Commands
There are a few other linker scripts commands.
@table @code
***************
*** 2550,2556 ****
linker will use the definition in the linker script.
@node SECTIONS
! @section SECTIONS command
@kindex SECTIONS
The @code{SECTIONS} command tells the linker how to map input sections
into output sections, and how to place the output sections in memory.
--- 2567,2573 ----
linker will use the definition in the linker script.
@node SECTIONS
! @section SECTIONS Command
@kindex SECTIONS
The @code{SECTIONS} command tells the linker how to map input sections
into output sections, and how to place the output sections in memory.
***************
*** 2607,2613 ****
@end menu
@node Output Section Description
! @subsection Output section description
The full description of an output section looks like this:
@smallexample
@group
--- 2624,2630 ----
@end menu
@node Output Section Description
! @subsection Output Section Description
The full description of an output section looks like this:
@smallexample
@group
***************
*** 2640,2646 ****
@end itemize
@node Output Section Name
! @subsection Output section name
@cindex name, section
@cindex section name
The name of the output section is @var{section}. @var{section} must
--- 2657,2663 ----
@end itemize
@node Output Section Name
! @subsection Output Section Name
@cindex name, section
@cindex section name
The name of the output section is @var{section}. @var{section} must
***************
*** 2658,2664 ****
Discarding}.
@node Output Section Address
! @subsection Output section address
@cindex address, section
@cindex section address
The @var{address} is an expression for the VMA (the virtual memory
--- 2675,2681 ----
Discarding}.
@node Output Section Address
! @subsection Output Section Address
@cindex address, section
@cindex section address
The @var{address} is an expression for the VMA (the virtual memory
***************
*** 2705,2711 ****
location counter.
@node Input Section
! @subsection Input section description
@cindex input sections
@cindex mapping input sections to output sections
The most common output section command is an input section description.
--- 2722,2728 ----
location counter.
@node Input Section
! @subsection Input Section Description
@cindex input sections
@cindex mapping input sections to output sections
The most common output section command is an input section description.
***************
*** 2724,2730 ****
@end menu
@node Input Section Basics
! @subsubsection Input section basics
@cindex input section basics
An input section description consists of a file name optionally followed
by a list of section names in parentheses.
--- 2741,2747 ----
@end menu
@node Input Section Basics
! @subsubsection Input Section Basics
@cindex input section basics
An input section description consists of a file name optionally followed
by a list of section names in parentheses.
***************
*** 2785,2791 ****
the archive search path.
@node Input Section Wildcards
! @subsubsection Input section wildcard patterns
@cindex input section wildcards
@cindex wildcard file name patterns
@cindex file name wildcard patterns
--- 2802,2808 ----
the archive search path.
@node Input Section Wildcards
! @subsubsection Input Section Wildcard Patterns
@cindex input section wildcards
@cindex wildcard file name patterns
@cindex file name wildcard patterns
***************
*** 2862,2868 ****
@end smallexample
@node Input Section Common
! @subsubsection Input section for common symbols
@cindex common symbol placement
@cindex uninitialized data placement
A special notation is needed for common symbols, because in many object
--- 2879,2885 ----
@end smallexample
@node Input Section Common
! @subsubsection Input Section for Common Symbols
@cindex common symbol placement
@cindex uninitialized data placement
A special notation is needed for common symbols, because in many object
***************
*** 2898,2904 ****
@samp{*(COMMON)}.
@node Input Section Keep
! @subsubsection Input section and garbage collection
@cindex KEEP
@cindex garbage collection
When link-time garbage collection is in use (@samp{--gc-sections}),
--- 2915,2921 ----
@samp{*(COMMON)}.
@node Input Section Keep
! @subsubsection Input Section and Garbage Collection
@cindex KEEP
@cindex garbage collection
When link-time garbage collection is in use (@samp{--gc-sections}),
***************
*** 2908,2914 ****
@code{KEEP(SORT(*)(.ctors))}.
@node Input Section Example
! @subsubsection Input section example
The following example is a complete linker script. It tells the linker
to read all of the sections from file @file{all.o} and place them at the
start of output section @samp{outputa} which starts at location
--- 2925,2931 ----
@code{KEEP(SORT(*)(.ctors))}.
@node Input Section Example
! @subsubsection Input Section Example
The following example is a complete linker script. It tells the linker
to read all of the sections from file @file{all.o} and place them at the
start of output section @samp{outputa} which starts at location
***************
*** 2927,2937 ****
--- 2944,2958 ----
all.o
foo.o (.input1)
@}
+ @end group
+ @group
outputb :
@{
foo.o (.input2)
foo1.o (.input1)
@}
+ @end group
+ @group
outputc :
@{
*(.input1)
***************
*** 2942,2948 ****
@end smallexample
@node Output Section Data
! @subsection Output section data
@cindex data
@cindex section data
@cindex output section data
--- 2963,2969 ----
@end smallexample
@node Output Section Data
! @subsection Output Section Data
@cindex data
@cindex section data
@cindex output section data
***************
*** 2982,2988 ****
true of, for example, S-records, the value will be stored in the
endianness of the first input object file.
! Note - these commands only work inside a section description and not
between them, so the following will produce an error from the linker:
@smallexample
SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@
--- 3003,3009 ----
true of, for example, S-records, the value will be stored in the
endianness of the first input object file.
! Note---these commands only work inside a section description and not
between them, so the following will produce an error from the linker:
@smallexample
SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@
***************
*** 3019,3025 ****
expression.
@node Output Section Keywords
! @subsection Output section keywords
There are a couple of keywords which can appear as output section
commands.
--- 3040,3046 ----
expression.
@node Output Section Keywords
! @subsection Output Section Keywords
There are a couple of keywords which can appear as output section
commands.
***************
*** 3098,3104 ****
@end table
@node Output Section Discarding
! @subsection Output section discarding
@cindex discarding sections
@cindex sections, discarding
@cindex removing sections
--- 3119,3125 ----
@end table
@node Output Section Discarding
! @subsection Output Section Discarding
@cindex discarding sections
@cindex sections, discarding
@cindex removing sections
***************
*** 3122,3128 ****
section named @samp{/DISCARD/} are not included in the output file.
@node Output Section Attributes
! @subsection Output section attributes
@cindex output section attributes
We showed above that the full description of an output section looked
like this:
--- 3143,3149 ----
section named @samp{/DISCARD/} are not included in the output file.
@node Output Section Attributes
! @subsection Output Section Attributes
@cindex output section attributes
We showed above that the full description of an output section looked
like this:
***************
*** 3149,3155 ****
@end menu
@node Output Section Type
! @subsubsection Output section type
Each output section may have a type. The type is a keyword in
parentheses. The following types are defined:
--- 3170,3176 ----
@end menu
@node Output Section Type
! @subsubsection Output Section Type
Each output section may have a type. The type is a keyword in
parentheses. The following types are defined:
***************
*** 3186,3192 ****
@end smallexample
@node Output Section LMA
! @subsubsection Output section LMA
@kindex AT>@var{lma_region}
@kindex AT(@var{lma})
@cindex load address
--- 3207,3213 ----
@end smallexample
@node Output Section LMA
! @subsubsection Output Section LMA
@kindex AT>@var{lma_region}
@kindex AT(@var{lma})
@cindex load address
***************
*** 3251,3257 ****
@end smallexample
@node Output Section Region
! @subsubsection Output section region
@kindex >@var{region}
@cindex section, assigning to memory region
@cindex memory regions and sections
--- 3272,3278 ----
@end smallexample
@node Output Section Region
! @subsubsection Output Section Region
@kindex >@var{region}
@cindex section, assigning to memory region
@cindex memory regions and sections
***************
*** 3267,3273 ****
@end smallexample
@node Output Section Phdr
! @subsubsection Output section phdr
@kindex :@var{phdr}
@cindex section, assigning to program header
@cindex program headers and sections
--- 3288,3294 ----
@end smallexample
@node Output Section Phdr
! @subsubsection Output Section Phdr
@kindex :@var{phdr}
@cindex section, assigning to program header
@cindex program headers and sections
***************
*** 3287,3293 ****
@end smallexample
@node Output Section Fill
! @subsubsection Output section fill
@kindex =@var{fillexp}
@cindex section fill pattern
@cindex fill pattern, entire section
--- 3308,3314 ----
@end smallexample
@node Output Section Fill
! @subsubsection Output Section Fill
@kindex =@var{fillexp}
@cindex section fill pattern
@cindex fill pattern, entire section
***************
*** 3315,3321 ****
@end smallexample
@node Overlay Description
! @subsection Overlay description
@kindex OVERLAY
@cindex overlays
An overlay description provides an easy way to describe sections which
--- 3336,3342 ----
@end smallexample
@node Overlay Description
! @subsection Overlay Description
@kindex OVERLAY
@cindex overlays
An overlay description provides an easy way to describe sections which
***************
*** 3429,3435 ****
@end smallexample
@node MEMORY
! @section MEMORY command
@kindex MEMORY
@cindex memory regions
@cindex regions of memory
--- 3450,3456 ----
@end smallexample
@node MEMORY
! @section MEMORY Command
@kindex MEMORY
@cindex memory regions
@cindex regions of memory
***************
*** 3847,3853 ****
If you wish to bind a reference to a specific version of the symbol
within the shared library, you can use the aliases of convenience
! (i.e. @samp{old_foo}), or you can use the @samp{.symver} directive to
specifically bind to an external version of the function in question.
You can also specify the language in the version script:
--- 3868,3874 ----
If you wish to bind a reference to a specific version of the symbol
within the shared library, you can use the aliases of convenience
! (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to
specifically bind to an external version of the function in question.
You can also specify the language in the version script:
***************
*** 3903,3922 ****
In addition, you can use the suffixes @code{K} and @code{M} to scale a
constant by
@c TEXI2ROFF-KILL
! @ifinfo
@c END TEXI2ROFF-KILL
@code{1024} or @code{1024*1024}
@c TEXI2ROFF-KILL
! @end ifinfo
@tex
${\rm 1024}$ or ${\rm 1024}^2$
@end tex
@c END TEXI2ROFF-KILL
respectively. For example, the following all refer to the same quantity:
@smallexample
! _fourk_1 = 4K;
! _fourk_2 = 4096;
! _fourk_3 = 0x1000;
@end smallexample
@node Symbols
--- 3924,3943 ----
In addition, you can use the suffixes @code{K} and @code{M} to scale a
constant by
@c TEXI2ROFF-KILL
! @ifnottex
@c END TEXI2ROFF-KILL
@code{1024} or @code{1024*1024}
@c TEXI2ROFF-KILL
! @end ifnottex
@tex
${\rm 1024}$ or ${\rm 1024}^2$
@end tex
@c END TEXI2ROFF-KILL
respectively. For example, the following all refer to the same quantity:
@smallexample
! _fourk_1 = 4K;
! _fourk_2 = 4096;
! _fourk_3 = 0x1000;
@end smallexample
@node Symbols
***************
*** 3931,3938 ****
specify a symbol which contains odd characters or has the same name as a
keyword by surrounding the symbol name in double quotes:
@smallexample
! "SECTION" = 9;
! "with a space" = "also with a space" + 10;
@end smallexample
Since symbols can contain many non-alphabetic characters, it is safest
--- 3952,3959 ----
specify a symbol which contains odd characters or has the same name as a
keyword by surrounding the symbol name in double quotes:
@smallexample
! "SECTION" = 9;
! "with a space" = "also with a space" + 10;
@end smallexample
Since symbols can contain many non-alphabetic characters, it is safest
***************
*** 4019,4025 ****
The linker recognizes the standard C set of arithmetic operators, with
the standard bindings and precedence levels:
@c TEXI2ROFF-KILL
! @ifinfo
@c END TEXI2ROFF-KILL
@smallexample
precedence associativity Operators Notes
--- 4040,4046 ----
The linker recognizes the standard C set of arithmetic operators, with
the standard bindings and precedence levels:
@c TEXI2ROFF-KILL
! @ifnottex
@c END TEXI2ROFF-KILL
@smallexample
precedence associativity Operators Notes
***************
*** 4041,4047 ****
(1) Prefix operators
(2) @xref{Assignments}.
@c TEXI2ROFF-KILL
! @end ifinfo
@tex
\vskip \baselineskip
%"lispnarrowing" is the extra indent used generally for smallexample
--- 4062,4068 ----
(1) Prefix operators
(2) @xref{Assignments}.
@c TEXI2ROFF-KILL
! @end ifnottex
@tex
\vskip \baselineskip
%"lispnarrowing" is the extra indent used generally for smallexample
***************
*** 4391,4405 ****
functionality are not listed.
@menu
! * H8/300:: @code{ld} and the H8/300
! * i960:: @code{ld} and the Intel 960 family
! * ARM:: @code{ld} and the ARM family
! * HPPA ELF32:: @code{ld} and HPPA 32-bit ELF
@ifset MMIX
! * MMIX:: @code{ld} and MMIX
@end ifset
@ifset MSP430
! * MSP430:: @code{ld} and MSP430
@end ifset
@ifset TICOFF
* TI COFF:: @command{ld} and TI COFF
--- 4412,4434 ----
functionality are not listed.
@menu
! @ifset H8300
! * H8/300:: @command{ld} and the H8/300
! @end ifset
! @ifset I960
! * i960:: @command{ld} and the Intel 960 family
! @end ifset
! @ifset ARM
! * ARM:: @command{ld} and the ARM family
! @end ifset
! @ifset HPPA
! * HPPA ELF32:: @command{ld} and HPPA 32-bit ELF
! @end ifset
@ifset MMIX
! * MMIX:: @command{ld} and MMIX
@end ifset
@ifset MSP430
! * MSP430:: @command{ld} and MSP430
@end ifset
@ifset TICOFF
* TI COFF:: @command{ld} and TI COFF
***************
*** 4410,4417 ****
@end menu
@end ifset
- @c FIXME! This could use @raisesections/@lowersections, but there seems to be a conflict
- @c between those and node-defaulting.
@ifset H8300
@ifclear GENERIC
@raisesections
--- 4439,4444 ----
***************
*** 4803,4809 ****
@c This stuff is pointless to say unless you're especially concerned
@c with Hitachi chips; don't enable it for generic case, please.
@node Hitachi
! @chapter @command{ld} and other Hitachi chips
@command{ld} also supports the H8/300H, the H8/500, and the Hitachi SH. No
special features, commands, or command-line options are required for
--- 4830,4836 ----
@c This stuff is pointless to say unless you're especially concerned
@c with Hitachi chips; don't enable it for generic case, please.
@node Hitachi
! @chapter @command{ld} and Other Hitachi Chips
@command{ld} also supports the H8/300H, the H8/500, and the Hitachi SH. No
special features, commands, or command-line options are required for
***************
*** 4817,4823 ****
@end ifclear
@node i960
! @section @command{ld} and the Intel 960 family
@cindex i960 support
--- 4844,4850 ----
@end ifclear
@node i960
! @section @command{ld} and the Intel 960 Family
@cindex i960 support
***************
*** 4868,4879 ****
@end ifclear
@end ifset
@ifclear GENERIC
@raisesections
@end ifclear
@node ARM
! @section @command{ld}'s support for interworking between ARM and Thumb code
@cindex ARM interworking support
@kindex --support-old-code
--- 4895,4907 ----
@end ifclear
@end ifset
+ @ifset ARM
@ifclear GENERIC
@raisesections
@end ifclear
@node ARM
! @section @command{ld}'s Support for Interworking Between ARM and Thumb Code
@cindex ARM interworking support
@kindex --support-old-code
***************
*** 4897,4904 ****
branched to using a BX instruction, and the program will start
executing in Thumb mode straight away.
@node HPPA ELF32
! @section @command{ld} and HPPA 32-bit ELF support
@cindex HPPA multiple sub-space stubs
@kindex --multi-subspace
When generating a shared library, @command{ld} will by default generate
--- 4925,4942 ----
branched to using a BX instruction, and the program will start
executing in Thumb mode straight away.
+ @ifclear GENERIC
+ @lowersections
+ @end ifclear
+ @end ifset
+
+ @ifset HPPA
+ @ifclear GENERIC
+ @raisesections
+ @end ifclear
+
@node HPPA ELF32
! @section @command{ld} and HPPA 32-bit ELF Support
@cindex HPPA multiple sub-space stubs
@kindex --multi-subspace
When generating a shared library, @command{ld} will by default generate
***************
*** 4929,4938 ****
create a larger group (of one section). If input sections are too
large, it may not be possible for a branch to reach its stub.
@ifset MMIX
@node MMIX
@section @code{ld} and MMIX
! For MMIX, there is choice of generating @code{ELF} object files or
@code{mmo} object files when linking. The simulator @code{mmix}
understands the @code{mmo} format. The binutils @code{objcopy} utility
can translate between the two formats.
--- 4967,4985 ----
create a larger group (of one section). If input sections are too
large, it may not be possible for a branch to reach its stub.
+ @ifclear GENERIC
+ @lowersections
+ @end ifclear
+ @end ifset
+
@ifset MMIX
+ @ifclear GENERIC
+ @raisesections
+ @end ifclear
+
@node MMIX
@section @code{ld} and MMIX
! For MMIX, there is a choice of generating @code{ELF} object files or
@code{mmo} object files when linking. The simulator @code{mmix}
understands the @code{mmo} format. The binutils @code{objcopy} utility
can translate between the two formats.
***************
*** 4953,4961 ****
--- 5000,5016 ----
Initial and trailing multiples of zero-valued 32-bit words in a section,
are left out from an mmo file.
+
+ @ifclear GENERIC
+ @lowersections
+ @end ifclear
@end ifset
@ifset MSP430
+ @ifclear GENERIC
+ @raisesections
+ @end ifclear
+
@node MSP430
@section @code{ld} and MSP430
For the MSP430 it is possible to select the MPU architecture. The flag @samp{-m [mpu type]}
***************
*** 4986,4996 ****
The last two sections are used by gcc.
@end table
@end ifset
@ifset TICOFF
@node TI COFF
! @section @command{ld}'s support for various TI COFF versions
@cindex TI COFF versions
@kindex --format=@var{version}
The @samp{--format} switch allows selection of one of the various
--- 5041,5059 ----
The last two sections are used by gcc.
@end table
+
+ @ifclear GENERIC
+ @lowersections
+ @end ifclear
@end ifset
@ifset TICOFF
+ @ifclear GENERIC
+ @raisesections
+ @end ifclear
+
@node TI COFF
! @section @command{ld}'s Support for Various TI COFF Versions
@cindex TI COFF versions
@kindex --format=@var{version}
The @samp{--format} switch allows selection of one of the various
***************
*** 4998,5008 ****
also supported. The TI COFF versions also vary in header byte-order
format; @command{ld} will read any version or byte order, but the output
header format depends on the default specified by the specific target.
- @end ifset
@ifclear GENERIC
@lowersections
@end ifclear
@ifclear SingleFormat
@node BFD
--- 5061,5071 ----
also supported. The TI COFF versions also vary in header byte-order
format; @command{ld} will read any version or byte order, but the output
header format depends on the default specified by the specific target.
@ifclear GENERIC
@lowersections
@end ifclear
+ @end ifset
@ifclear SingleFormat
@node BFD
***************
*** 5042,5048 ****
@end menu
@node BFD outline
! @section How it works: an outline of BFD
@cindex opening object files
@include bfdsumm.texi
@end ifclear
--- 5105,5111 ----
@end menu
@node BFD outline
! @section How It Works: An Outline of BFD
@cindex opening object files
@include bfdsumm.texi
@end ifclear
***************
*** 5069,5075 ****
@end menu
@node Bug Criteria
! @section Have you found a bug?
@cindex bug criteria
If you are not sure whether you have found a bug, here are some guidelines:
--- 5132,5138 ----
@end menu
@node Bug Criteria
! @section Have You Found a Bug?
@cindex bug criteria
If you are not sure whether you have found a bug, here are some guidelines:
***************
*** 5098,5104 ****
@end itemize
@node Bug Reporting
! @section How to report bugs
@cindex bug reports
@cindex @command{ld} bugs, reporting
--- 5161,5167 ----
@end itemize
@node Bug Reporting
! @section How to Report Bugs
@cindex bug reports
@cindex @command{ld} bugs, reporting
***************
*** 5133,5141 ****
on the assumption that the bug has not been reported previously.
Sometimes people give a few sketchy facts and ask, ``Does this ring a
! bell?'' Those bug reports are useless, and we urge everyone to
! @emph{refuse to respond to them} except to chide the sender to report
! bugs properly.
To enable us to fix the bug, you should include all these things:
--- 5196,5204 ----
on the assumption that the bug has not been reported previously.
Sometimes people give a few sketchy facts and ask, ``Does this ring a
! bell?'' This cannot help us fix a bug, so it is basically useless. We
! respond by asking for enough details to enable us to investigate.
! You might as well expedite matters by sending them to begin with.
To enable us to fix the bug, you should include all these things:
***************
*** 5395,5762 ****
@end table
@node GNU Free Documentation License
! @appendix GNU Free Documentation License
! @cindex GNU Free Documentation License
!
! GNU Free Documentation License
!
! Version 1.1, March 2000
!
! Copyright (C) 2000 Free Software Foundation, Inc.
! 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
!
! Everyone is permitted to copy and distribute verbatim copies
! of this license document, but changing it is not allowed.
!
!
! 0. PREAMBLE
!
! The purpose of this License is to make a manual, textbook, or other
! written document "free" in the sense of freedom: to assure everyone
! the effective freedom to copy and redistribute it, with or without
! modifying it, either commercially or noncommercially. Secondarily,
! this License preserves for the author and publisher a way to get
! credit for their work, while not being considered responsible for
! modifications made by others.
!
! This License is a kind of "copyleft", which means that derivative
! works of the document must themselves be free in the same sense. It
! complements the GNU General Public License, which is a copyleft
! license designed for free software.
!
! We have designed this License in order to use it for manuals for free
! software, because free software needs free documentation: a free
! program should come with manuals providing the same freedoms that the
! software does. But this License is not limited to software manuals;
! it can be used for any textual work, regardless of subject matter or
! whether it is published as a printed book. We recommend this License
! principally for works whose purpose is instruction or reference.
!
!
! 1. APPLICABILITY AND DEFINITIONS
!
! This License applies to any manual or other work that contains a
! notice placed by the copyright holder saying it can be distributed
! under the terms of this License. The "Document", below, refers to any
! such manual or work. Any member of the public is a licensee, and is
! addressed as "you".
!
! A "Modified Version" of the Document means any work containing the
! Document or a portion of it, either copied verbatim, or with
! modifications and/or translated into another language.
!
! A "Secondary Section" is a named appendix or a front-matter section of
! the Document that deals exclusively with the relationship of the
! publishers or authors of the Document to the Document's overall subject
! (or to related matters) and contains nothing that could fall directly
! within that overall subject. (For example, if the Document is in part a
! textbook of mathematics, a Secondary Section may not explain any
! mathematics.) The relationship could be a matter of historical
! connection with the subject or with related matters, or of legal,
! commercial, philosophical, ethical or political position regarding
! them.
!
! The "Invariant Sections" are certain Secondary Sections whose titles
! are designated, as being those of Invariant Sections, in the notice
! that says that the Document is released under this License.
!
! The "Cover Texts" are certain short passages of text that are listed,
! as Front-Cover Texts or Back-Cover Texts, in the notice that says that
! the Document is released under this License.
!
! A "Transparent" copy of the Document means a machine-readable copy,
! represented in a format whose specification is available to the
! general public, whose contents can be viewed and edited directly and
! straightforwardly with generic text editors or (for images composed of
! pixels) generic paint programs or (for drawings) some widely available
! drawing editor, and that is suitable for input to text formatters or
! for automatic translation to a variety of formats suitable for input
! to text formatters. A copy made in an otherwise Transparent file
! format whose markup has been designed to thwart or discourage
! subsequent modification by readers is not Transparent. A copy that is
! not "Transparent" is called "Opaque".
!
! Examples of suitable formats for Transparent copies include plain
! ASCII without markup, Texinfo input format, LaTeX input format, SGML
! or XML using a publicly available DTD, and standard-conforming simple
! HTML designed for human modification. Opaque formats include
! PostScript, PDF, proprietary formats that can be read and edited only
! by proprietary word processors, SGML or XML for which the DTD and/or
! processing tools are not generally available, and the
! machine-generated HTML produced by some word processors for output
! purposes only.
!
! The "Title Page" means, for a printed book, the title page itself,
! plus such following pages as are needed to hold, legibly, the material
! this License requires to appear in the title page. For works in
! formats which do not have any title page as such, "Title Page" means
! the text near the most prominent appearance of the work's title,
! preceding the beginning of the body of the text.
!
!
! 2. VERBATIM COPYING
!
! You may copy and distribute the Document in any medium, either
! commercially or noncommercially, provided that this License, the
! copyright notices, and the license notice saying this License applies
! to the Document are reproduced in all copies, and that you add no other
! conditions whatsoever to those of this License. You may not use
! technical measures to obstruct or control the reading or further
! copying of the copies you make or distribute. However, you may accept
! compensation in exchange for copies. If you distribute a large enough
! number of copies you must also follow the conditions in section 3.
!
! You may also lend copies, under the same conditions stated above, and
! you may publicly display copies.
!
!
! 3. COPYING IN QUANTITY
!
! If you publish printed copies of the Document numbering more than 100,
! and the Document's license notice requires Cover Texts, you must enclose
! the copies in covers that carry, clearly and legibly, all these Cover
! Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
! the back cover. Both covers must also clearly and legibly identify
! you as the publisher of these copies. The front cover must present
! the full title with all words of the title equally prominent and
! visible. You may add other material on the covers in addition.
! Copying with changes limited to the covers, as long as they preserve
! the title of the Document and satisfy these conditions, can be treated
! as verbatim copying in other respects.
!
! If the required texts for either cover are too voluminous to fit
! legibly, you should put the first ones listed (as many as fit
! reasonably) on the actual cover, and continue the rest onto adjacent
! pages.
!
! If you publish or distribute Opaque copies of the Document numbering
! more than 100, you must either include a machine-readable Transparent
! copy along with each Opaque copy, or state in or with each Opaque copy
! a publicly-accessible computer-network location containing a complete
! Transparent copy of the Document, free of added material, which the
! general network-using public has access to download anonymously at no
! charge using public-standard network protocols. If you use the latter
! option, you must take reasonably prudent steps, when you begin
! distribution of Opaque copies in quantity, to ensure that this
! Transparent copy will remain thus accessible at the stated location
! until at least one year after the last time you distribute an Opaque
! copy (directly or through your agents or retailers) of that edition to
! the public.
!
! It is requested, but not required, that you contact the authors of the
! Document well before redistributing any large number of copies, to give
! them a chance to provide you with an updated version of the Document.
!
!
! 4. MODIFICATIONS
!
! You may copy and distribute a Modified Version of the Document under
! the conditions of sections 2 and 3 above, provided that you release
! the Modified Version under precisely this License, with the Modified
! Version filling the role of the Document, thus licensing distribution
! and modification of the Modified Version to whoever possesses a copy
! of it. In addition, you must do these things in the Modified Version:
!
! A. Use in the Title Page (and on the covers, if any) a title distinct
! from that of the Document, and from those of previous versions
! (which should, if there were any, be listed in the History section
! of the Document). You may use the same title as a previous version
! if the original publisher of that version gives permission.
! B. List on the Title Page, as authors, one or more persons or entities
! responsible for authorship of the modifications in the Modified
! Version, together with at least five of the principal authors of the
! Document (all of its principal authors, if it has less than five).
! C. State on the Title page the name of the publisher of the
! Modified Version, as the publisher.
! D. Preserve all the copyright notices of the Document.
! E. Add an appropriate copyright notice for your modifications
! adjacent to the other copyright notices.
! F. Include, immediately after the copyright notices, a license notice
! giving the public permission to use the Modified Version under the
! terms of this License, in the form shown in the Addendum below.
! G. Preserve in that license notice the full lists of Invariant Sections
! and required Cover Texts given in the Document's license notice.
! H. Include an unaltered copy of this License.
! I. Preserve the section entitled "History", and its title, and add to
! it an item stating at least the title, year, new authors, and
! publisher of the Modified Version as given on the Title Page. If
! there is no section entitled "History" in the Document, create one
! stating the title, year, authors, and publisher of the Document as
! given on its Title Page, then add an item describing the Modified
! Version as stated in the previous sentence.
! J. Preserve the network location, if any, given in the Document for
! public access to a Transparent copy of the Document, and likewise
! the network locations given in the Document for previous versions
! it was based on. These may be placed in the "History" section.
! You may omit a network location for a work that was published at
! least four years before the Document itself, or if the original
! publisher of the version it refers to gives permission.
! K. In any section entitled "Acknowledgements" or "Dedications",
! preserve the section's title, and preserve in the section all the
! substance and tone of each of the contributor acknowledgements
! and/or dedications given therein.
! L. Preserve all the Invariant Sections of the Document,
! unaltered in their text and in their titles. Section numbers
! or the equivalent are not considered part of the section titles.
! M. Delete any section entitled "Endorsements". Such a section
! may not be included in the Modified Version.
! N. Do not retitle any existing section as "Endorsements"
! or to conflict in title with any Invariant Section.
!
! If the Modified Version includes new front-matter sections or
! appendices that qualify as Secondary Sections and contain no material
! copied from the Document, you may at your option designate some or all
! of these sections as invariant. To do this, add their titles to the
! list of Invariant Sections in the Modified Version's license notice.
! These titles must be distinct from any other section titles.
!
! You may add a section entitled "Endorsements", provided it contains
! nothing but endorsements of your Modified Version by various
! parties--for example, statements of peer review or that the text has
! been approved by an organization as the authoritative definition of a
! standard.
!
! You may add a passage of up to five words as a Front-Cover Text, and a
! passage of up to 25 words as a Back-Cover Text, to the end of the list
! of Cover Texts in the Modified Version. Only one passage of
! Front-Cover Text and one of Back-Cover Text may be added by (or
! through arrangements made by) any one entity. If the Document already
! includes a cover text for the same cover, previously added by you or
! by arrangement made by the same entity you are acting on behalf of,
! you may not add another; but you may replace the old one, on explicit
! permission from the previous publisher that added the old one.
!
! The author(s) and publisher(s) of the Document do not by this License
! give permission to use their names for publicity for or to assert or
! imply endorsement of any Modified Version.
!
!
! 5. COMBINING DOCUMENTS
!
! You may combine the Document with other documents released under this
! License, under the terms defined in section 4 above for modified
! versions, provided that you include in the combination all of the
! Invariant Sections of all of the original documents, unmodified, and
! list them all as Invariant Sections of your combined work in its
! license notice.
!
! The combined work need only contain one copy of this License, and
! multiple identical Invariant Sections may be replaced with a single
! copy. If there are multiple Invariant Sections with the same name but
! different contents, make the title of each such section unique by
! adding at the end of it, in parentheses, the name of the original
! author or publisher of that section if known, or else a unique number.
! Make the same adjustment to the section titles in the list of
! Invariant Sections in the license notice of the combined work.
!
! In the combination, you must combine any sections entitled "History"
! in the various original documents, forming one section entitled
! "History"; likewise combine any sections entitled "Acknowledgements",
! and any sections entitled "Dedications". You must delete all sections
! entitled "Endorsements."
!
!
! 6. COLLECTIONS OF DOCUMENTS
!
! You may make a collection consisting of the Document and other documents
! released under this License, and replace the individual copies of this
! License in the various documents with a single copy that is included in
! the collection, provided that you follow the rules of this License for
! verbatim copying of each of the documents in all other respects.
!
! You may extract a single document from such a collection, and distribute
! it individually under this License, provided you insert a copy of this
! License into the extracted document, and follow this License in all
! other respects regarding verbatim copying of that document.
!
!
! 7. AGGREGATION WITH INDEPENDENT WORKS
!
! A compilation of the Document or its derivatives with other separate
! and independent documents or works, in or on a volume of a storage or
! distribution medium, does not as a whole count as a Modified Version
! of the Document, provided no compilation copyright is claimed for the
! compilation. Such a compilation is called an "aggregate", and this
! License does not apply to the other self-contained works thus compiled
! with the Document, on account of their being thus compiled, if they
! are not themselves derivative works of the Document.
!
! If the Cover Text requirement of section 3 is applicable to these
! copies of the Document, then if the Document is less than one quarter
! of the entire aggregate, the Document's Cover Texts may be placed on
! covers that surround only the Document within the aggregate.
! Otherwise they must appear on covers around the whole aggregate.
!
!
! 8. TRANSLATION
!
! Translation is considered a kind of modification, so you may
! distribute translations of the Document under the terms of section 4.
! Replacing Invariant Sections with translations requires special
! permission from their copyright holders, but you may include
! translations of some or all Invariant Sections in addition to the
! original versions of these Invariant Sections. You may include a
! translation of this License provided that you also include the
! original English version of this License. In case of a disagreement
! between the translation and the original English version of this
! License, the original English version will prevail.
!
!
! 9. TERMINATION
!
! You may not copy, modify, sublicense, or distribute the Document except
! as expressly provided for under this License. Any other attempt to
! copy, modify, sublicense or distribute the Document is void, and will
! automatically terminate your rights under this License. However,
! parties who have received copies, or rights, from you under this
! License will not have their licenses terminated so long as such
! parties remain in full compliance.
!
!
! 10. FUTURE REVISIONS OF THIS LICENSE
!
! The Free Software Foundation may publish new, revised versions
! of the GNU Free Documentation License from time to time. Such new
! versions will be similar in spirit to the present version, but may
! differ in detail to address new problems or concerns. See
! http://www.gnu.org/copyleft/.
!
! Each version of the License is given a distinguishing version number.
! If the Document specifies that a particular numbered version of this
! License "or any later version" applies to it, you have the option of
! following the terms and conditions either of that specified version or
! of any later version that has been published (not as a draft) by the
! Free Software Foundation. If the Document does not specify a version
! number of this License, you may choose any version ever published (not
! as a draft) by the Free Software Foundation.
!
!
! ADDENDUM: How to use this License for your documents
!
! To use this License in a document you have written, include a copy of
! the License in the document and put the following copyright and
! license notices just after the title page:
!
! @smallexample
! Copyright (c) YEAR YOUR NAME.
! Permission is granted to copy, distribute and/or modify this document
! under the terms of the GNU Free Documentation License, Version 1.1
! or any later version published by the Free Software Foundation;
! with the Invariant Sections being LIST THEIR TITLES, with the
! Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
! A copy of the license is included in the section entitled "GNU
! Free Documentation License".
! @end smallexample
!
! If you have no Invariant Sections, write "with no Invariant Sections"
! instead of saying which ones are invariant. If you have no
! Front-Cover Texts, write "no Front-Cover Texts" instead of
! "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
!
! If your document contains nontrivial examples of program code, we
! recommend releasing these examples in parallel under your choice of
! free software license, such as the GNU General Public License,
! to permit their use in free software.
@node Index
@unnumbered Index
--- 5458,5464 ----
@end table
@node GNU Free Documentation License
! @include fdl.texi
@node Index
@unnumbered Index
diff -c -3 /dev/null fdl.texi
*** /dev/null Thu Apr 11 07:25:15 2002
--- fdl.texi Fri Feb 14 11:47:12 2003
***************
*** 0 ****
--- 1,366 ----
+ @c -*-texinfo-*-
+ @appendix GNU Free Documentation License
+ @center Version 1.1, March 2000
+
+ @display
+ Copyright (C) 2000, Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+ @end display
+ @sp 1
+ @enumerate 0
+ @item
+ PREAMBLE
+
+ The purpose of this License is to make a manual, textbook, or other
+ written document ``free'' in the sense of freedom: to assure everyone
+ the effective freedom to copy and redistribute it, with or without
+ modifying it, either commercially or noncommercially. Secondarily,
+ this License preserves for the author and publisher a way to get
+ credit for their work, while not being considered responsible for
+ modifications made by others.
+
+ This License is a kind of ``copyleft'', which means that derivative
+ works of the document must themselves be free in the same sense. It
+ complements the GNU General Public License, which is a copyleft
+ license designed for free software.
+
+ We have designed this License in order to use it for manuals for free
+ software, because free software needs free documentation: a free
+ program should come with manuals providing the same freedoms that the
+ software does. But this License is not limited to software manuals;
+ it can be used for any textual work, regardless of subject matter or
+ whether it is published as a printed book. We recommend this License
+ principally for works whose purpose is instruction or reference.
+
+ @sp 1
+ @item
+ APPLICABILITY AND DEFINITIONS
+
+ This License applies to any manual or other work that contains a
+ notice placed by the copyright holder saying it can be distributed
+ under the terms of this License. The ``Document'', below, refers to any
+ such manual or work. Any member of the public is a licensee, and is
+ addressed as ``you.''
+
+ A ``Modified Version'' of the Document means any work containing the
+ Document or a portion of it, either copied verbatim, or with
+ modifications and/or translated into another language.
+
+ A ``Secondary Section'' is a named appendix or a front-matter section of
+ the Document that deals exclusively with the relationship of the
+ publishers or authors of the Document to the Document's overall subject
+ (or to related matters) and contains nothing that could fall directly
+ within that overall subject. (For example, if the Document is in part a
+ textbook of mathematics, a Secondary Section may not explain any
+ mathematics.) The relationship could be a matter of historical
+ connection with the subject or with related matters, or of legal,
+ commercial, philosophical, ethical or political position regarding
+ them.
+
+ The ``Invariant Sections'' are certain Secondary Sections whose titles
+ are designated, as being those of Invariant Sections, in the notice
+ that says that the Document is released under this License.
+
+ The ``Cover Texts'' are certain short passages of text that are listed,
+ as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+ the Document is released under this License.
+
+ A ``Transparent'' copy of the Document means a machine-readable copy,
+ represented in a format whose specification is available to the
+ general public, whose contents can be viewed and edited directly and
+ straightforwardly with generic text editors or (for images composed of
+ pixels) generic paint programs or (for drawings) some widely available
+ drawing editor, and that is suitable for input to text formatters or
+ for automatic translation to a variety of formats suitable for input
+ to text formatters. A copy made in an otherwise Transparent file
+ format whose markup has been designed to thwart or discourage
+ subsequent modification by readers is not Transparent. A copy that is
+ not ``Transparent'' is called ``Opaque.''
+
+ Examples of suitable formats for Transparent copies include plain
+ ASCII without markup, Texinfo input format, LaTeX input format, SGML
+ or XML using a publicly available DTD, and standard-conforming simple
+ HTML designed for human modification. Opaque formats include
+ PostScript, PDF, proprietary formats that can be read and edited only
+ by proprietary word processors, SGML or XML for which the DTD and/or
+ processing tools are not generally available, and the
+ machine-generated HTML produced by some word processors for output
+ purposes only.
+
+ The ``Title Page'' means, for a printed book, the title page itself,
+ plus such following pages as are needed to hold, legibly, the material
+ this License requires to appear in the title page. For works in
+ formats which do not have any title page as such, ``Title Page'' means
+ the text near the most prominent appearance of the work's title,
+ preceding the beginning of the body of the text.
+ @sp 1
+ @item
+ VERBATIM COPYING
+
+ You may copy and distribute the Document in any medium, either
+ commercially or noncommercially, provided that this License, the
+ copyright notices, and the license notice saying this License applies
+ to the Document are reproduced in all copies, and that you add no other
+ conditions whatsoever to those of this License. You may not use
+ technical measures to obstruct or control the reading or further
+ copying of the copies you make or distribute. However, you may accept
+ compensation in exchange for copies. If you distribute a large enough
+ number of copies you must also follow the conditions in section 3.
+
+ You may also lend copies, under the same conditions stated above, and
+ you may publicly display copies.
+ @sp 1
+ @item
+ COPYING IN QUANTITY
+
+ If you publish printed copies of the Document numbering more than 100,
+ and the Document's license notice requires Cover Texts, you must enclose
+ the copies in covers that carry, clearly and legibly, all these Cover
+ Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+ the back cover. Both covers must also clearly and legibly identify
+ you as the publisher of these copies. The front cover must present
+ the full title with all words of the title equally prominent and
+ visible. You may add other material on the covers in addition.
+ Copying with changes limited to the covers, as long as they preserve
+ the title of the Document and satisfy these conditions, can be treated
+ as verbatim copying in other respects.
+
+ If the required texts for either cover are too voluminous to fit
+ legibly, you should put the first ones listed (as many as fit
+ reasonably) on the actual cover, and continue the rest onto adjacent
+ pages.
+
+ If you publish or distribute Opaque copies of the Document numbering
+ more than 100, you must either include a machine-readable Transparent
+ copy along with each Opaque copy, or state in or with each Opaque copy
+ a publicly-accessible computer-network location containing a complete
+ Transparent copy of the Document, free of added material, which the
+ general network-using public has access to download anonymously at no
+ charge using public-standard network protocols. If you use the latter
+ option, you must take reasonably prudent steps, when you begin
+ distribution of Opaque copies in quantity, to ensure that this
+ Transparent copy will remain thus accessible at the stated location
+ until at least one year after the last time you distribute an Opaque
+ copy (directly or through your agents or retailers) of that edition to
+ the public.
+
+ It is requested, but not required, that you contact the authors of the
+ Document well before redistributing any large number of copies, to give
+ them a chance to provide you with an updated version of the Document.
+ @sp 1
+ @item
+ MODIFICATIONS
+
+ You may copy and distribute a Modified Version of the Document under
+ the conditions of sections 2 and 3 above, provided that you release
+ the Modified Version under precisely this License, with the Modified
+ Version filling the role of the Document, thus licensing distribution
+ and modification of the Modified Version to whoever possesses a copy
+ of it. In addition, you must do these things in the Modified Version:
+
+ A. Use in the Title Page (and on the covers, if any) a title distinct
+ from that of the Document, and from those of previous versions
+ (which should, if there were any, be listed in the History section
+ of the Document). You may use the same title as a previous version
+ if the original publisher of that version gives permission.@*
+ B. List on the Title Page, as authors, one or more persons or entities
+ responsible for authorship of the modifications in the Modified
+ Version, together with at least five of the principal authors of the
+ Document (all of its principal authors, if it has less than five).@*
+ C. State on the Title page the name of the publisher of the
+ Modified Version, as the publisher.@*
+ D. Preserve all the copyright notices of the Document.@*
+ E. Add an appropriate copyright notice for your modifications
+ adjacent to the other copyright notices.@*
+ F. Include, immediately after the copyright notices, a license notice
+ giving the public permission to use the Modified Version under the
+ terms of this License, in the form shown in the Addendum below.@*
+ G. Preserve in that license notice the full lists of Invariant Sections
+ and required Cover Texts given in the Document's license notice.@*
+ H. Include an unaltered copy of this License.@*
+ I. Preserve the section entitled ``History'', and its title, and add to
+ it an item stating at least the title, year, new authors, and
+ publisher of the Modified Version as given on the Title Page. If
+ there is no section entitled ``History'' in the Document, create one
+ stating the title, year, authors, and publisher of the Document as
+ given on its Title Page, then add an item describing the Modified
+ Version as stated in the previous sentence.@*
+ J. Preserve the network location, if any, given in the Document for
+ public access to a Transparent copy of the Document, and likewise
+ the network locations given in the Document for previous versions
+ it was based on. These may be placed in the ``History'' section.
+ You may omit a network location for a work that was published at
+ least four years before the Document itself, or if the original
+ publisher of the version it refers to gives permission.@*
+ K. In any section entitled ``Acknowledgements'' or ``Dedications'',
+ preserve the section's title, and preserve in the section all the
+ substance and tone of each of the contributor acknowledgements
+ and/or dedications given therein.@*
+ L. Preserve all the Invariant Sections of the Document,
+ unaltered in their text and in their titles. Section numbers
+ or the equivalent are not considered part of the section titles.@*
+ M. Delete any section entitled ``Endorsements.'' Such a section
+ may not be included in the Modified Version.@*
+ N. Do not retitle any existing section as ``Endorsements''
+ or to conflict in title with any Invariant Section.@*
+ @sp 1
+ If the Modified Version includes new front-matter sections or
+ appendices that qualify as Secondary Sections and contain no material
+ copied from the Document, you may at your option designate some or all
+ of these sections as invariant. To do this, add their titles to the
+ list of Invariant Sections in the Modified Version's license notice.
+ These titles must be distinct from any other section titles.
+
+ You may add a section entitled ``Endorsements'', provided it contains
+ nothing but endorsements of your Modified Version by various
+ parties--for example, statements of peer review or that the text has
+ been approved by an organization as the authoritative definition of a
+ standard.
+
+ You may add a passage of up to five words as a Front-Cover Text, and a
+ passage of up to 25 words as a Back-Cover Text, to the end of the list
+ of Cover Texts in the Modified Version. Only one passage of
+ Front-Cover Text and one of Back-Cover Text may be added by (or
+ through arrangements made by) any one entity. If the Document already
+ includes a cover text for the same cover, previously added by you or
+ by arrangement made by the same entity you are acting on behalf of,
+ you may not add another; but you may replace the old one, on explicit
+ permission from the previous publisher that added the old one.
+
+ The author(s) and publisher(s) of the Document do not by this License
+ give permission to use their names for publicity for or to assert or
+ imply endorsement of any Modified Version.
+ @sp 1
+ @item
+ COMBINING DOCUMENTS
+
+ You may combine the Document with other documents released under this
+ License, under the terms defined in section 4 above for modified
+ versions, provided that you include in the combination all of the
+ Invariant Sections of all of the original documents, unmodified, and
+ list them all as Invariant Sections of your combined work in its
+ license notice.
+
+ The combined work need only contain one copy of this License, and
+ multiple identical Invariant Sections may be replaced with a single
+ copy. If there are multiple Invariant Sections with the same name but
+ different contents, make the title of each such section unique by
+ adding at the end of it, in parentheses, the name of the original
+ author or publisher of that section if known, or else a unique number.
+ Make the same adjustment to the section titles in the list of
+ Invariant Sections in the license notice of the combined work.
+
+ In the combination, you must combine any sections entitled ``History''
+ in the various original documents, forming one section entitled
+ ``History''; likewise combine any sections entitled ``Acknowledgements'',
+ and any sections entitled ``Dedications.'' You must delete all sections
+ entitled ``Endorsements.''
+ @sp 1
+ @item
+ COLLECTIONS OF DOCUMENTS
+
+ You may make a collection consisting of the Document and other documents
+ released under this License, and replace the individual copies of this
+ License in the various documents with a single copy that is included in
+ the collection, provided that you follow the rules of this License for
+ verbatim copying of each of the documents in all other respects.
+
+ You may extract a single document from such a collection, and distribute
+ it individually under this License, provided you insert a copy of this
+ License into the extracted document, and follow this License in all
+ other respects regarding verbatim copying of that document.
+ @sp 1
+ @item
+ AGGREGATION WITH INDEPENDENT WORKS
+
+ A compilation of the Document or its derivatives with other separate
+ and independent documents or works, in or on a volume of a storage or
+ distribution medium, does not as a whole count as a Modified Version
+ of the Document, provided no compilation copyright is claimed for the
+ compilation. Such a compilation is called an ``aggregate'', and this
+ License does not apply to the other self-contained works thus compiled
+ with the Document, on account of their being thus compiled, if they
+ are not themselves derivative works of the Document.
+
+ If the Cover Text requirement of section 3 is applicable to these
+ copies of the Document, then if the Document is less than one quarter
+ of the entire aggregate, the Document's Cover Texts may be placed on
+ covers that surround only the Document within the aggregate.
+ Otherwise they must appear on covers around the whole aggregate.
+ @sp 1
+ @item
+ TRANSLATION
+
+ Translation is considered a kind of modification, so you may
+ distribute translations of the Document under the terms of section 4.
+ Replacing Invariant Sections with translations requires special
+ permission from their copyright holders, but you may include
+ translations of some or all Invariant Sections in addition to the
+ original versions of these Invariant Sections. You may include a
+ translation of this License provided that you also include the
+ original English version of this License. In case of a disagreement
+ between the translation and the original English version of this
+ License, the original English version will prevail.
+ @sp 1
+ @item
+ TERMINATION
+
+ You may not copy, modify, sublicense, or distribute the Document except
+ as expressly provided for under this License. Any other attempt to
+ copy, modify, sublicense or distribute the Document is void, and will
+ automatically terminate your rights under this License. However,
+ parties who have received copies, or rights, from you under this
+ License will not have their licenses terminated so long as such
+ parties remain in full compliance.
+ @sp 1
+ @item
+ FUTURE REVISIONS OF THIS LICENSE
+
+ The Free Software Foundation may publish new, revised versions
+ of the GNU Free Documentation License from time to time. Such new
+ versions will be similar in spirit to the present version, but may
+ differ in detail to address new problems or concerns. See
+ http://www.gnu.org/copyleft/.
+
+ Each version of the License is given a distinguishing version number.
+ If the Document specifies that a particular numbered version of this
+ License ``or any later version'' applies to it, you have the option of
+ following the terms and conditions either of that specified version or
+ of any later version that has been published (not as a draft) by the
+ Free Software Foundation. If the Document does not specify a version
+ number of this License, you may choose any version ever published (not
+ as a draft) by the Free Software Foundation.
+
+ @end enumerate
+
+ @unnumberedsec ADDENDUM: How to use this License for your documents
+
+ To use this License in a document you have written, include a copy of
+ the License in the document and put the following copyright and
+ license notices just after the title page:
+
+ @smallexample
+ @group
+ Copyright (C) @var{year} @var{your name}.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.1
+ or any later version published by the Free Software Foundation;
+ with the Invariant Sections being @var{list their titles}, with the
+ Front-Cover Texts being @var{list}, and with the Back-Cover Texts being @var{list}.
+ A copy of the license is included in the section entitled "GNU
+ Free Documentation License."
+ @end group
+ @end smallexample
+
+ If you have no Invariant Sections, write ``with no Invariant Sections''
+ instead of saying which ones are invariant. If you have no
+ Front-Cover Texts, write ``no Front-Cover Texts'' instead of
+ ``Front-Cover Texts being @var{list}''; likewise for Back-Cover Texts.
+
+ If your document contains nontrivial examples of program code, we
+ recommend releasing these examples in parallel under your choice of
+ free software license, such as the GNU General Public License,
+ to permit their use in free software.