Subversion Repositories openrisc_2011-10-31

This is annotate.info, produced by makeinfo version 4.8 from

This is annotate.info, produced by makeinfo version 4.8 from

../.././gdb/doc/annotate.texinfo.

../.././gdb/doc/annotate.texinfo.

INFO-DIR-SECTION Software development

INFO-DIR-SECTION Software development

START-INFO-DIR-ENTRY

START-INFO-DIR-ENTRY

* Annotate: (annotate).                 The obsolete annotation interface.

* Annotate: (annotate).                 The obsolete annotation interface.

END-INFO-DIR-ENTRY

END-INFO-DIR-ENTRY

   This file documents GDB's obsolete annotations.

   This file documents GDB's obsolete annotations.

   Copyright (C) 1994, 1995, 2000, 2001, 2003 Free Software Foundation,

   Copyright (C) 1994, 1995, 2000, 2001, 2003 Free Software Foundation,

Inc.

Inc.

   Permission is granted to copy, distribute and/or modify this document

   Permission is granted to copy, distribute and/or modify this document

under the terms of the GNU Free Documentation License, Version 1.1 or

under the terms of the GNU Free Documentation License, Version 1.1 or

any later version published by the Free Software Foundation; with no

any later version published by the Free Software Foundation; with no

Invariant Sections, with no Front-Cover Texts, and with no Back-Cover

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

Texts.  A copy of the license is included in the section entitled "GNU

Free Documentation License".

Free Documentation License".

File: annotate.info,  Node: Top,  Next: Annotations Overview,  Up: (dir)

File: annotate.info,  Node: Top,  Next: Annotations Overview,  Up: (dir)

GDB Annotations

GDB Annotations

***************

***************

This document describes the obsolete level two annotation interface

This document describes the obsolete level two annotation interface

implemented in older GDB versions.

implemented in older GDB versions.

* Menu:

* Menu:

* Annotations Overview::  What annotations are; the general syntax.

* Annotations Overview::  What annotations are; the general syntax.

* Limitations::           Limitations of the annotation interface.

* Limitations::           Limitations of the annotation interface.

* Migrating to GDB/MI::   Migrating to GDB/MI

* Migrating to GDB/MI::   Migrating to GDB/MI

* Server Prefix::       Issuing a command without affecting user state.

* Server Prefix::       Issuing a command without affecting user state.

* Value Annotations::   Values are marked as such.

* Value Annotations::   Values are marked as such.

* Frame Annotations::   Stack frames are annotated.

* Frame Annotations::   Stack frames are annotated.

* Displays::            GDB can be told to display something periodically.

* Displays::            GDB can be told to display something periodically.

* Prompting::           Annotations marking GDB's need for input.

* Prompting::           Annotations marking GDB's need for input.

* Errors::              Annotations for error messages.

* Errors::              Annotations for error messages.

* Breakpoint Info::     Information on breakpoints.

* Breakpoint Info::     Information on breakpoints.

* Invalidation::        Some annotations describe things now invalid.

* Invalidation::        Some annotations describe things now invalid.

* Annotations for Running::

* Annotations for Running::

                        Whether the program is running, how it stopped, etc.

                        Whether the program is running, how it stopped, etc.

* Source Annotations::  Annotations describing source code.

* Source Annotations::  Annotations describing source code.

* GNU Free Documentation License::

* GNU Free Documentation License::

File: annotate.info,  Node: Annotations Overview,  Next: Limitations,  Prev: Top,  Up: Top

File: annotate.info,  Node: Annotations Overview,  Next: Limitations,  Prev: Top,  Up: Top

1 What is an Annotation?

1 What is an Annotation?

************************

************************

To produce obsolete level two annotations, start GDB with the

To produce obsolete level two annotations, start GDB with the

`--annotate=2' option.

`--annotate=2' option.

   Annotations start with a newline character, two `control-z'

   Annotations start with a newline character, two `control-z'

characters, and the name of the annotation.  If there is no additional

characters, and the name of the annotation.  If there is no additional

information associated with this annotation, the name of the annotation

information associated with this annotation, the name of the annotation

is followed immediately by a newline.  If there is additional

is followed immediately by a newline.  If there is additional

information, the name of the annotation is followed by a space, the

information, the name of the annotation is followed by a space, the

additional information, and a newline.  The additional information

additional information, and a newline.  The additional information

cannot contain newline characters.

cannot contain newline characters.

   Any output not beginning with a newline and two `control-z'

   Any output not beginning with a newline and two `control-z'

characters denotes literal output from GDB.  Currently there is no need

characters denotes literal output from GDB.  Currently there is no need

for GDB to output a newline followed by two `control-z' characters, but

for GDB to output a newline followed by two `control-z' characters, but

if there was such a need, the annotations could be extended with an

if there was such a need, the annotations could be extended with an

`escape' annotation which means those three characters as output.

`escape' annotation which means those three characters as output.

   A simple example of starting up GDB with annotations is:

   A simple example of starting up GDB with annotations is:

     $ gdb --annotate=2

     $ gdb --annotate=2

     GNU GDB 5.0

     GNU GDB 5.0

     Copyright 2000 Free Software Foundation, Inc.

     Copyright 2000 Free Software Foundation, Inc.

     GDB is free software, covered by the GNU General Public License,

     GDB is free software, covered by the GNU General Public License,

     and you are welcome to change it and/or distribute copies of it

     and you are welcome to change it and/or distribute copies of it

     under certain conditions.

     under certain conditions.

     Type "show copying" to see the conditions.

     Type "show copying" to see the conditions.

     There is absolutely no warranty for GDB.  Type "show warranty"

     There is absolutely no warranty for GDB.  Type "show warranty"

     for details.

     for details.

     This GDB was configured as "sparc-sun-sunos4.1.3"

     This GDB was configured as "sparc-sun-sunos4.1.3"

     ^Z^Zpre-prompt

     ^Z^Zpre-prompt

     (gdb)

     (gdb)

     ^Z^Zprompt

     ^Z^Zprompt

     quit

     quit

     ^Z^Zpost-prompt

     ^Z^Zpost-prompt

     $

     $

   Here `quit' is input to GDB; the rest is output from GDB.  The three

   Here `quit' is input to GDB; the rest is output from GDB.  The three

lines beginning `^Z^Z' (where `^Z' denotes a `control-z' character) are

lines beginning `^Z^Z' (where `^Z' denotes a `control-z' character) are

annotations; the rest is output from GDB.

annotations; the rest is output from GDB.

File: annotate.info,  Node: Limitations,  Next: Migrating to GDB/MI,  Prev: Annotations Overview,  Up: Top

File: annotate.info,  Node: Limitations,  Next: Migrating to GDB/MI,  Prev: Annotations Overview,  Up: Top

2 Limitations of the Annotation Interface

2 Limitations of the Annotation Interface

*****************************************

*****************************************

The level two annotations mechanism is known to have a number of

The level two annotations mechanism is known to have a number of

technical and architectural limitations.  As a consequence, in 2001,

technical and architectural limitations.  As a consequence, in 2001,

with the release of GDB 5.1 and the addition of GDB/MI, the annotation

with the release of GDB 5.1 and the addition of GDB/MI, the annotation

interface was marked as deprecated.

interface was marked as deprecated.

   This chapter discusses the known problems.

   This chapter discusses the known problems.

2.1 Dependant on CLI output

2.1 Dependant on CLI output

===========================

===========================

The annotation interface works by interspersing markups with GDB normal

The annotation interface works by interspersing markups with GDB normal

command-line interpreter output.  Unfortunately, this makes the

command-line interpreter output.  Unfortunately, this makes the

annotation client dependant on not just the annotations, but also the

annotation client dependant on not just the annotations, but also the

CLI output.  This is because the client is forced to assume that

CLI output.  This is because the client is forced to assume that

specific GDB commands provide specific information.  Any change to

specific GDB commands provide specific information.  Any change to

GDB's CLI output modifies or removes that information and,

GDB's CLI output modifies or removes that information and,

consequently, likely breaks the client.

consequently, likely breaks the client.

   Since the GDB/MI output is independent of the CLI, it does not have

   Since the GDB/MI output is independent of the CLI, it does not have

this problem.

this problem.

2.2 Scalability

2.2 Scalability

===============

===============

The annotation interface relies on value annotations (*note Value

The annotation interface relies on value annotations (*note Value

Annotations::) and the display mechanism as a way of obtaining

Annotations::) and the display mechanism as a way of obtaining

up-to-date value information.  These mechanisms are not scalable.

up-to-date value information.  These mechanisms are not scalable.

   In a graphical environment, where many values can be displayed

   In a graphical environment, where many values can be displayed

simultaneously, a serious performance problem occurs when the client

simultaneously, a serious performance problem occurs when the client

tries to first extract from GDB, and then re-display, all those values.

tries to first extract from GDB, and then re-display, all those values.

The client should instead only request and update the values that

The client should instead only request and update the values that

changed.

changed.

   The GDB/MI Variable Objects provide just that mechanism.

   The GDB/MI Variable Objects provide just that mechanism.

2.3 Correctness

2.3 Correctness

===============

===============

The annotation interface assumes that a variable's value can only be

The annotation interface assumes that a variable's value can only be

changed when the target is running.  This assumption is not correct.  A

changed when the target is running.  This assumption is not correct.  A

single assignment to a single variable can result in the entire target,

single assignment to a single variable can result in the entire target,

and all displayed values, needing an update.

and all displayed values, needing an update.

   The GDB/MI Variable Objects include a mechanism for efficiently

   The GDB/MI Variable Objects include a mechanism for efficiently

reporting such changes.

reporting such changes.

2.4 Reliability

2.4 Reliability

===============

===============

The GDB/MI interface includes a dedicated test directory

The GDB/MI interface includes a dedicated test directory

(`gdb/gdb.mi'), and any addition or fix to GDB/MI must include

(`gdb/gdb.mi'), and any addition or fix to GDB/MI must include

testsuite changes.

testsuite changes.

2.5 Maintainability

2.5 Maintainability

===================

===================

The annotation mechanism was implemented by interspersing CLI print

The annotation mechanism was implemented by interspersing CLI print

statements with various annotations.  As a consequence, any CLI output

statements with various annotations.  As a consequence, any CLI output

change can alter the annotation output.

change can alter the annotation output.

   Since the GDB/MI output is independent of the CLI, and the GDB/MI is

   Since the GDB/MI output is independent of the CLI, and the GDB/MI is

increasingly implemented independent of the CLI code, its long term

increasingly implemented independent of the CLI code, its long term

maintenance is much easier.

maintenance is much easier.

File: annotate.info,  Node: Migrating to GDB/MI,  Next: Server Prefix,  Prev: Limitations,  Up: Top

File: annotate.info,  Node: Migrating to GDB/MI,  Next: Server Prefix,  Prev: Limitations,  Up: Top

3 Migrating to GDB/MI

3 Migrating to GDB/MI

*********************

*********************

By using the `interp mi' command, it is possible for annotation clients

By using the `interp mi' command, it is possible for annotation clients

to invoke GDB/MI commands, and hence access the GDB/MI.  By doing this,

to invoke GDB/MI commands, and hence access the GDB/MI.  By doing this,

existing annotation clients have a migration path from this obsolete

existing annotation clients have a migration path from this obsolete

interface to GDB/MI.

interface to GDB/MI.

File: annotate.info,  Node: Server Prefix,  Next: Value Annotations,  Prev: Migrating to GDB/MI,  Up: Top

File: annotate.info,  Node: Server Prefix,  Next: Value Annotations,  Prev: Migrating to GDB/MI,  Up: Top

4 The Server Prefix

4 The Server Prefix

*******************

*******************

To issue a command to GDB without affecting certain aspects of the

To issue a command to GDB without affecting certain aspects of the

state which is seen by users, prefix it with `server '.  This means

state which is seen by users, prefix it with `server '.  This means

that this command will not affect the command history, nor will it

that this command will not affect the command history, nor will it

affect GDB's notion of which command to repeat if  is pressed on a

affect GDB's notion of which command to repeat if  is pressed on a

line by itself.

line by itself.

   The server prefix does not affect the recording of values into the

   The server prefix does not affect the recording of values into the

value history; to print a value without recording it into the value

value history; to print a value without recording it into the value

history, use the `output' command instead of the `print' command.

history, use the `output' command instead of the `print' command.

File: annotate.info,  Node: Value Annotations,  Next: Frame Annotations,  Prev: Server Prefix,  Up: Top

File: annotate.info,  Node: Value Annotations,  Next: Frame Annotations,  Prev: Server Prefix,  Up: Top

5 Values

5 Values

********

********

_Value Annotations have been removed.  GDB/MI instead provides Variable

_Value Annotations have been removed.  GDB/MI instead provides Variable

Objects._

Objects._

   When a value is printed in various contexts, GDB uses annotations to

   When a value is printed in various contexts, GDB uses annotations to

delimit the value from the surrounding text.

delimit the value from the surrounding text.

   If a value is printed using `print' and added to the value history,

   If a value is printed using `print' and added to the value history,

the annotation looks like

the annotation looks like

     ^Z^Zvalue-history-begin HISTORY-NUMBER VALUE-FLAGS

     ^Z^Zvalue-history-begin HISTORY-NUMBER VALUE-FLAGS

     HISTORY-STRING

     HISTORY-STRING

     ^Z^Zvalue-history-value

     ^Z^Zvalue-history-value

     THE-VALUE

     THE-VALUE

     ^Z^Zvalue-history-end

     ^Z^Zvalue-history-end

where HISTORY-NUMBER is the number it is getting in the value history,

where HISTORY-NUMBER is the number it is getting in the value history,

HISTORY-STRING is a string, such as `$5 = ', which introduces the value

HISTORY-STRING is a string, such as `$5 = ', which introduces the value

to the user, THE-VALUE is the output corresponding to the value itself,

to the user, THE-VALUE is the output corresponding to the value itself,

and VALUE-FLAGS is `*' for a value which can be dereferenced and `-'

and VALUE-FLAGS is `*' for a value which can be dereferenced and `-'

for a value which cannot.

for a value which cannot.

   If the value is not added to the value history (it is an invalid

   If the value is not added to the value history (it is an invalid

float or it is printed with the `output' command), the annotation is

float or it is printed with the `output' command), the annotation is

similar:

similar:

     ^Z^Zvalue-begin VALUE-FLAGS

     ^Z^Zvalue-begin VALUE-FLAGS

     THE-VALUE

     THE-VALUE

     ^Z^Zvalue-end

     ^Z^Zvalue-end

   When GDB prints an argument to a function (for example, in the output

   When GDB prints an argument to a function (for example, in the output

from the `backtrace' command), it annotates it as follows:

from the `backtrace' command), it annotates it as follows:

     ^Z^Zarg-begin

     ^Z^Zarg-begin

     ARGUMENT-NAME

     ARGUMENT-NAME

     ^Z^Zarg-name-end

     ^Z^Zarg-name-end

     SEPARATOR-STRING

     SEPARATOR-STRING

     ^Z^Zarg-value VALUE-FLAGS

     ^Z^Zarg-value VALUE-FLAGS

     THE-VALUE

     THE-VALUE

     ^Z^Zarg-end

     ^Z^Zarg-end

where ARGUMENT-NAME is the name of the argument, SEPARATOR-STRING is

where ARGUMENT-NAME is the name of the argument, SEPARATOR-STRING is

text which separates the name from the value for the user's benefit

text which separates the name from the value for the user's benefit

(such as `='), and VALUE-FLAGS and THE-VALUE have the same meanings as

(such as `='), and VALUE-FLAGS and THE-VALUE have the same meanings as

in a `value-history-begin' annotation.

in a `value-history-begin' annotation.

   When printing a structure, GDB annotates it as follows:

   When printing a structure, GDB annotates it as follows:

     ^Z^Zfield-begin VALUE-FLAGS

     ^Z^Zfield-begin VALUE-FLAGS

     FIELD-NAME

     FIELD-NAME

     ^Z^Zfield-name-end

     ^Z^Zfield-name-end

     SEPARATOR-STRING

     SEPARATOR-STRING

     ^Z^Zfield-value

     ^Z^Zfield-value

     THE-VALUE

     THE-VALUE

     ^Z^Zfield-end

     ^Z^Zfield-end

where FIELD-NAME is the name of the field, SEPARATOR-STRING is text

where FIELD-NAME is the name of the field, SEPARATOR-STRING is text

which separates the name from the value for the user's benefit (such as

which separates the name from the value for the user's benefit (such as

`='), and VALUE-FLAGS and THE-VALUE have the same meanings as in a

`='), and VALUE-FLAGS and THE-VALUE have the same meanings as in a

`value-history-begin' annotation.

`value-history-begin' annotation.

   When printing an array, GDB annotates it as follows:

   When printing an array, GDB annotates it as follows:

     ^Z^Zarray-section-begin ARRAY-INDEX VALUE-FLAGS

     ^Z^Zarray-section-begin ARRAY-INDEX VALUE-FLAGS

where ARRAY-INDEX is the index of the first element being annotated and

where ARRAY-INDEX is the index of the first element being annotated and

VALUE-FLAGS has the same meaning as in a `value-history-begin'

VALUE-FLAGS has the same meaning as in a `value-history-begin'

annotation.  This is followed by any number of elements, where is

annotation.  This is followed by any number of elements, where is

element can be either a single element:

element can be either a single element:

     `,' WHITESPACE         ; omitted for the first element

     `,' WHITESPACE         ; omitted for the first element

     THE-VALUE

     THE-VALUE

     ^Z^Zelt

     ^Z^Zelt

   or a repeated element

   or a repeated element

     `,' WHITESPACE         ; omitted for the first element

     `,' WHITESPACE         ; omitted for the first element

     THE-VALUE

     THE-VALUE

     ^Z^Zelt-rep NUMBER-OF-REPETITIONS

     ^Z^Zelt-rep NUMBER-OF-REPETITIONS

     REPETITION-STRING

     REPETITION-STRING

     ^Z^Zelt-rep-end

     ^Z^Zelt-rep-end

   In both cases, THE-VALUE is the output for the value of the element

   In both cases, THE-VALUE is the output for the value of the element

and WHITESPACE can contain spaces, tabs, and newlines.  In the repeated

and WHITESPACE can contain spaces, tabs, and newlines.  In the repeated

case, NUMBER-OF-REPETITIONS is the number of consecutive array elements

case, NUMBER-OF-REPETITIONS is the number of consecutive array elements

which contain that value, and REPETITION-STRING is a string which is

which contain that value, and REPETITION-STRING is a string which is

designed to convey to the user that repetition is being depicted.

designed to convey to the user that repetition is being depicted.

   Once all the array elements have been output, the array annotation is

   Once all the array elements have been output, the array annotation is

ended with

ended with

     ^Z^Zarray-section-end

     ^Z^Zarray-section-end

File: annotate.info,  Node: Frame Annotations,  Next: Displays,  Prev: Value Annotations,  Up: Top

File: annotate.info,  Node: Frame Annotations,  Next: Displays,  Prev: Value Annotations,  Up: Top

6 Frames

6 Frames

********

********

_Value Annotations have been removed.  GDB/MI instead provides a number

_Value Annotations have been removed.  GDB/MI instead provides a number

of frame commands._

of frame commands._

   _Frame annotations are no longer available.  The GDB/MI provides

   _Frame annotations are no longer available.  The GDB/MI provides

`-stack-list-arguments', `-stack-list-locals', and `-stack-list-frames'

`-stack-list-arguments', `-stack-list-locals', and `-stack-list-frames'

commands._

commands._

   Whenever GDB prints a frame, it annotates it.  For example, this

   Whenever GDB prints a frame, it annotates it.  For example, this

applies to frames printed when GDB stops, output from commands such as

applies to frames printed when GDB stops, output from commands such as

`backtrace' or `up', etc.

`backtrace' or `up', etc.

   The frame annotation begins with

   The frame annotation begins with

     ^Z^Zframe-begin LEVEL ADDRESS

     ^Z^Zframe-begin LEVEL ADDRESS

     LEVEL-STRING

     LEVEL-STRING

where LEVEL is the number of the frame (0 is the innermost frame, and

where LEVEL is the number of the frame (0 is the innermost frame, and

other frames have positive numbers), ADDRESS is the address of the code

other frames have positive numbers), ADDRESS is the address of the code

executing in that frame, and LEVEL-STRING is a string designed to

executing in that frame, and LEVEL-STRING is a string designed to

convey the level to the user.  ADDRESS is in the form `0x' followed by

convey the level to the user.  ADDRESS is in the form `0x' followed by

one or more lowercase hex digits (note that this does not depend on the

one or more lowercase hex digits (note that this does not depend on the

language).  The frame ends with

language).  The frame ends with

     ^Z^Zframe-end

     ^Z^Zframe-end

   Between these annotations is the main body of the frame, which can

   Between these annotations is the main body of the frame, which can

consist of

consist of

   *      ^Z^Zfunction-call

   *      ^Z^Zfunction-call

          FUNCTION-CALL-STRING

          FUNCTION-CALL-STRING

     where FUNCTION-CALL-STRING is text designed to convey to the user

     where FUNCTION-CALL-STRING is text designed to convey to the user

     that this frame is associated with a function call made by GDB to a

     that this frame is associated with a function call made by GDB to a

     function in the program being debugged.

     function in the program being debugged.

   *      ^Z^Zsignal-handler-caller

   *      ^Z^Zsignal-handler-caller

          SIGNAL-HANDLER-CALLER-STRING

          SIGNAL-HANDLER-CALLER-STRING

     where SIGNAL-HANDLER-CALLER-STRING is text designed to convey to

     where SIGNAL-HANDLER-CALLER-STRING is text designed to convey to

     the user that this frame is associated with whatever mechanism is

     the user that this frame is associated with whatever mechanism is

     used by this operating system to call a signal handler (it is the

     used by this operating system to call a signal handler (it is the

     frame which calls the signal handler, not the frame for the signal

     frame which calls the signal handler, not the frame for the signal

     handler itself).

     handler itself).

   * A normal frame.

   * A normal frame.

     This can optionally (depending on whether this is thought of as

     This can optionally (depending on whether this is thought of as

     interesting information for the user to see) begin with

     interesting information for the user to see) begin with

          ^Z^Zframe-address

          ^Z^Zframe-address

          ADDRESS

          ADDRESS

          ^Z^Zframe-address-end

          ^Z^Zframe-address-end

          SEPARATOR-STRING

          SEPARATOR-STRING

     where ADDRESS is the address executing in the frame (the same

     where ADDRESS is the address executing in the frame (the same

     address as in the `frame-begin' annotation, but printed in a form

     address as in the `frame-begin' annotation, but printed in a form

     which is intended for user consumption--in particular, the syntax

     which is intended for user consumption--in particular, the syntax

     varies depending on the language), and SEPARATOR-STRING is a string

     varies depending on the language), and SEPARATOR-STRING is a string

     intended to separate this address from what follows for the user's

     intended to separate this address from what follows for the user's

     benefit.

     benefit.

     Then comes

     Then comes

          ^Z^Zframe-function-name

          ^Z^Zframe-function-name

          FUNCTION-NAME

          FUNCTION-NAME

          ^Z^Zframe-args

          ^Z^Zframe-args

          ARGUMENTS

          ARGUMENTS

     where FUNCTION-NAME is the name of the function executing in the

     where FUNCTION-NAME is the name of the function executing in the

     frame, or `??' if not known, and ARGUMENTS are the arguments to

     frame, or `??' if not known, and ARGUMENTS are the arguments to

     the frame, with parentheses around them (each argument is annotated

     the frame, with parentheses around them (each argument is annotated

     individually as well, *note Value Annotations::).

     individually as well, *note Value Annotations::).

     If source information is available, a reference to it is then

     If source information is available, a reference to it is then

     printed:

     printed:

          ^Z^Zframe-source-begin

          ^Z^Zframe-source-begin

          SOURCE-INTRO-STRING

          SOURCE-INTRO-STRING

          ^Z^Zframe-source-file

          ^Z^Zframe-source-file

          FILENAME

          FILENAME

          ^Z^Zframe-source-file-end

          ^Z^Zframe-source-file-end

          :

          :

          ^Z^Zframe-source-line

          ^Z^Zframe-source-line

          LINE-NUMBER

          LINE-NUMBER

          ^Z^Zframe-source-end

          ^Z^Zframe-source-end

     where SOURCE-INTRO-STRING separates for the user's benefit the

     where SOURCE-INTRO-STRING separates for the user's benefit the

     reference from the text which precedes it, FILENAME is the name of

     reference from the text which precedes it, FILENAME is the name of

     the source file, and LINE-NUMBER is the line number within that

     the source file, and LINE-NUMBER is the line number within that

     file (the first line is line 1).

     file (the first line is line 1).

     If GDB prints some information about where the frame is from (which

     If GDB prints some information about where the frame is from (which

     library, which load segment, etc.; currently only done on the

     library, which load segment, etc.; currently only done on the

     RS/6000), it is annotated with

     RS/6000), it is annotated with

          ^Z^Zframe-where

          ^Z^Zframe-where

          INFORMATION

          INFORMATION

     Then, if source is to actually be displayed for this frame (for

     Then, if source is to actually be displayed for this frame (for

     example, this is not true for output from the `backtrace'

     example, this is not true for output from the `backtrace'

     command), then a `source' annotation (*note Source Annotations::)

     command), then a `source' annotation (*note Source Annotations::)

     is displayed.  Unlike most annotations, this is output instead of

     is displayed.  Unlike most annotations, this is output instead of

     the normal text which would be output, not in addition.

     the normal text which would be output, not in addition.

File: annotate.info,  Node: Displays,  Next: Prompting,  Prev: Frame Annotations,  Up: Top

File: annotate.info,  Node: Displays,  Next: Prompting,  Prev: Frame Annotations,  Up: Top

7 Displays

7 Displays

**********

**********

_Display Annotations have been removed.  GDB/MI instead provides

_Display Annotations have been removed.  GDB/MI instead provides

Variable Objects._

Variable Objects._

   When GDB is told to display something using the `display' command,

   When GDB is told to display something using the `display' command,

the results of the display are annotated:

the results of the display are annotated:

     ^Z^Zdisplay-begin

     ^Z^Zdisplay-begin

     NUMBER

     NUMBER

     ^Z^Zdisplay-number-end

     ^Z^Zdisplay-number-end

     NUMBER-SEPARATOR

     NUMBER-SEPARATOR

     ^Z^Zdisplay-format

     ^Z^Zdisplay-format

     FORMAT

     FORMAT

     ^Z^Zdisplay-expression

     ^Z^Zdisplay-expression

     EXPRESSION

     EXPRESSION

     ^Z^Zdisplay-expression-end

     ^Z^Zdisplay-expression-end

     EXPRESSION-SEPARATOR

     EXPRESSION-SEPARATOR

     ^Z^Zdisplay-value

     ^Z^Zdisplay-value

     VALUE

     VALUE

     ^Z^Zdisplay-end

     ^Z^Zdisplay-end

where NUMBER is the number of the display, NUMBER-SEPARATOR is intended

where NUMBER is the number of the display, NUMBER-SEPARATOR is intended

to separate the number from what follows for the user, FORMAT includes

to separate the number from what follows for the user, FORMAT includes

information such as the size, format, or other information about how

information such as the size, format, or other information about how

the value is being displayed, EXPRESSION is the expression being

the value is being displayed, EXPRESSION is the expression being

displayed, EXPRESSION-SEPARATOR is intended to separate the expression

displayed, EXPRESSION-SEPARATOR is intended to separate the expression

from the text that follows for the user, and VALUE is the actual value

from the text that follows for the user, and VALUE is the actual value

being displayed.

being displayed.

File: annotate.info,  Node: Prompting,  Next: Errors,  Prev: Displays,  Up: Top

File: annotate.info,  Node: Prompting,  Next: Errors,  Prev: Displays,  Up: Top

8 Annotation for GDB Input

8 Annotation for GDB Input

**************************

**************************

When GDB prompts for input, it annotates this fact so it is possible to

When GDB prompts for input, it annotates this fact so it is possible to

know when to send output, when the output from a given command is over,

know when to send output, when the output from a given command is over,

etc.

etc.

   Different kinds of input each have a different "input type".  Each

   Different kinds of input each have a different "input type".  Each

input type has three annotations: a `pre-' annotation, which denotes

input type has three annotations: a `pre-' annotation, which denotes

the beginning of any prompt which is being output, a plain annotation,

the beginning of any prompt which is being output, a plain annotation,

which denotes the end of the prompt, and then a `post-' annotation

which denotes the end of the prompt, and then a `post-' annotation

which denotes the end of any echo which may (or may not) be associated

which denotes the end of any echo which may (or may not) be associated

with the input.  For example, the `prompt' input type features the

with the input.  For example, the `prompt' input type features the

following annotations:

following annotations:

     ^Z^Zpre-prompt

     ^Z^Zpre-prompt

     ^Z^Zprompt

     ^Z^Zprompt

     ^Z^Zpost-prompt

     ^Z^Zpost-prompt

   The input types are

   The input types are

`prompt'

`prompt'

     When GDB is prompting for a command (the main GDB prompt).

     When GDB is prompting for a command (the main GDB prompt).

`commands'

`commands'

     When GDB prompts for a set of commands, like in the `commands'

     When GDB prompts for a set of commands, like in the `commands'

     command.  The annotations are repeated for each command which is

     command.  The annotations are repeated for each command which is

     input.

     input.

`overload-choice'

`overload-choice'

     When GDB wants the user to select between various overloaded

     When GDB wants the user to select between various overloaded

     functions.

     functions.

`query'

`query'

     When GDB wants the user to confirm a potentially dangerous

     When GDB wants the user to confirm a potentially dangerous

     operation.

     operation.

`prompt-for-continue'

`prompt-for-continue'

     When GDB is asking the user to press return to continue.  Note:

     When GDB is asking the user to press return to continue.  Note:

     Don't expect this to work well; instead use `set height 0' to

     Don't expect this to work well; instead use `set height 0' to

     disable prompting.  This is because the counting of lines is buggy

     disable prompting.  This is because the counting of lines is buggy

     in the presence of annotations.

     in the presence of annotations.

File: annotate.info,  Node: Errors,  Next: Breakpoint Info,  Prev: Prompting,  Up: Top

File: annotate.info,  Node: Errors,  Next: Breakpoint Info,  Prev: Prompting,  Up: Top

9 Errors

9 Errors

********

********

     ^Z^Zquit

     ^Z^Zquit

   This annotation occurs right before GDB responds to an interrupt.

   This annotation occurs right before GDB responds to an interrupt.

     ^Z^Zerror

     ^Z^Zerror

   This annotation occurs right before GDB responds to an error.

   This annotation occurs right before GDB responds to an error.

   Quit and error annotations indicate that any annotations which GDB

   Quit and error annotations indicate that any annotations which GDB

was in the middle of may end abruptly.  For example, if a

was in the middle of may end abruptly.  For example, if a

`value-history-begin' annotation is followed by a `error', one cannot

`value-history-begin' annotation is followed by a `error', one cannot

expect to receive the matching `value-history-end'.  One cannot expect

expect to receive the matching `value-history-end'.  One cannot expect

not to receive it either, however; an error annotation does not

not to receive it either, however; an error annotation does not

necessarily mean that GDB is immediately returning all the way to the

necessarily mean that GDB is immediately returning all the way to the

top level.

top level.

   A quit or error annotation may be preceded by

   A quit or error annotation may be preceded by

     ^Z^Zerror-begin

     ^Z^Zerror-begin

   Any output between that and the quit or error annotation is the error

   Any output between that and the quit or error annotation is the error

message.

message.

   Warning messages are not yet annotated.

   Warning messages are not yet annotated.

File: annotate.info,  Node: Breakpoint Info,  Next: Invalidation,  Prev: Errors,  Up: Top

File: annotate.info,  Node: Breakpoint Info,  Next: Invalidation,  Prev: Errors,  Up: Top

10 Information on Breakpoints

10 Information on Breakpoints

*****************************

*****************************

_Breakpoint Annotations have been removed.  GDB/MI instead provides

_Breakpoint Annotations have been removed.  GDB/MI instead provides

breakpoint commands._

breakpoint commands._

   The output from the `info breakpoints' command is annotated as

   The output from the `info breakpoints' command is annotated as

follows:

follows:

     ^Z^Zbreakpoints-headers

     ^Z^Zbreakpoints-headers

     HEADER-ENTRY

     HEADER-ENTRY

     ^Z^Zbreakpoints-table

     ^Z^Zbreakpoints-table

where HEADER-ENTRY has the same syntax as an entry (see below) but

where HEADER-ENTRY has the same syntax as an entry (see below) but

instead of containing data, it contains strings which are intended to

instead of containing data, it contains strings which are intended to

convey the meaning of each field to the user.  This is followed by any

convey the meaning of each field to the user.  This is followed by any

number of entries.  If a field does not apply for this entry, it is

number of entries.  If a field does not apply for this entry, it is

omitted.  Fields may contain trailing whitespace.  Each entry consists

omitted.  Fields may contain trailing whitespace.  Each entry consists

of:

of:

     ^Z^Zrecord

     ^Z^Zrecord

     ^Z^Zfield 0

     ^Z^Zfield 0

     NUMBER

     NUMBER

     ^Z^Zfield 1

     ^Z^Zfield 1

     TYPE

     TYPE

     ^Z^Zfield 2

     ^Z^Zfield 2

     DISPOSITION

     DISPOSITION

     ^Z^Zfield 3

     ^Z^Zfield 3

     ENABLE

     ENABLE

     ^Z^Zfield 4

     ^Z^Zfield 4

     ADDRESS

     ADDRESS

     ^Z^Zfield 5

     ^Z^Zfield 5

     WHAT

     WHAT

     ^Z^Zfield 6

     ^Z^Zfield 6

     FRAME

     FRAME

     ^Z^Zfield 7

     ^Z^Zfield 7

     CONDITION

     CONDITION

     ^Z^Zfield 8

     ^Z^Zfield 8

     IGNORE-COUNT

     IGNORE-COUNT

     ^Z^Zfield 9

     ^Z^Zfield 9

     COMMANDS

     COMMANDS

   Note that ADDRESS is intended for user consumption--the syntax

   Note that ADDRESS is intended for user consumption--the syntax

varies depending on the language.

varies depending on the language.

   The output ends with

   The output ends with

     ^Z^Zbreakpoints-table-end

     ^Z^Zbreakpoints-table-end

File: annotate.info,  Node: Invalidation,  Next: Annotations for Running,  Prev: Breakpoint Info,  Up: Top

File: annotate.info,  Node: Invalidation,  Next: Annotations for Running,  Prev: Breakpoint Info,  Up: Top

11 Invalidation Notices

11 Invalidation Notices

***********************

***********************

The following annotations say that certain pieces of state may have

The following annotations say that certain pieces of state may have

changed.

changed.

`^Z^Zframes-invalid'

`^Z^Zframes-invalid'

     The frames (for example, output from the `backtrace' command) may

     The frames (for example, output from the `backtrace' command) may

     have changed.

     have changed.

`^Z^Zbreakpoints-invalid'

`^Z^Zbreakpoints-invalid'

     The breakpoints may have changed.  For example, the user just

     The breakpoints may have changed.  For example, the user just

     added or deleted a breakpoint.

     added or deleted a breakpoint.

File: annotate.info,  Node: Annotations for Running,  Next: Source Annotations,  Prev: Invalidation,  Up: Top

File: annotate.info,  Node: Annotations for Running,  Next: Source Annotations,  Prev: Invalidation,  Up: Top

12 Running the Program

12 Running the Program

**********************

**********************

When the program starts executing due to a GDB command such as `step'

When the program starts executing due to a GDB command such as `step'

or `continue',

or `continue',

     ^Z^Zstarting

     ^Z^Zstarting

   is output.  When the program stops,

   is output.  When the program stops,

     ^Z^Zstopped

     ^Z^Zstopped

   is output.  Before the `stopped' annotation, a variety of

   is output.  Before the `stopped' annotation, a variety of

annotations describe how the program stopped.

annotations describe how the program stopped.

`^Z^Zexited EXIT-STATUS'

`^Z^Zexited EXIT-STATUS'

     The program exited, and EXIT-STATUS is the exit status (zero for

     The program exited, and EXIT-STATUS is the exit status (zero for

     successful exit, otherwise nonzero).

     successful exit, otherwise nonzero).

`^Z^Zsignalled'

`^Z^Zsignalled'

     The program exited with a signal.  After the `^Z^Zsignalled', the

     The program exited with a signal.  After the `^Z^Zsignalled', the

     annotation continues:

     annotation continues:

          INTRO-TEXT

          INTRO-TEXT

          ^Z^Zsignal-name

          ^Z^Zsignal-name

          NAME

          NAME

          ^Z^Zsignal-name-end

          ^Z^Zsignal-name-end

          MIDDLE-TEXT

          MIDDLE-TEXT

          ^Z^Zsignal-string

          ^Z^Zsignal-string

          STRING

          STRING

          ^Z^Zsignal-string-end

          ^Z^Zsignal-string-end

          END-TEXT

          END-TEXT

     where NAME is the name of the signal, such as `SIGILL' or

     where NAME is the name of the signal, such as `SIGILL' or

     `SIGSEGV', and STRING is the explanation of the signal, such as

     `SIGSEGV', and STRING is the explanation of the signal, such as

     `Illegal Instruction' or `Segmentation fault'.  INTRO-TEXT,

     `Illegal Instruction' or `Segmentation fault'.  INTRO-TEXT,

     MIDDLE-TEXT, and END-TEXT are for the user's benefit and have no

     MIDDLE-TEXT, and END-TEXT are for the user's benefit and have no

     particular format.

     particular format.

`^Z^Zsignal'

`^Z^Zsignal'

     The syntax of this annotation is just like `signalled', but GDB is

     The syntax of this annotation is just like `signalled', but GDB is

     just saying that the program received the signal, not that it was

     just saying that the program received the signal, not that it was

     terminated with it.

     terminated with it.

`^Z^Zbreakpoint NUMBER'

`^Z^Zbreakpoint NUMBER'

     The program hit breakpoint number NUMBER.

     The program hit breakpoint number NUMBER.

`^Z^Zwatchpoint NUMBER'

`^Z^Zwatchpoint NUMBER'

     The program hit watchpoint number NUMBER.

     The program hit watchpoint number NUMBER.

File: annotate.info,  Node: Source Annotations,  Next: GNU Free Documentation License,  Prev: Annotations for Running,  Up: Top

File: annotate.info,  Node: Source Annotations,  Next: GNU Free Documentation License,  Prev: Annotations for Running,  Up: Top

13 Displaying Source

13 Displaying Source

********************

********************

The following annotation is used instead of displaying source code:

The following annotation is used instead of displaying source code:

     ^Z^Zsource FILENAME:LINE:CHARACTER:MIDDLE:ADDR

     ^Z^Zsource FILENAME:LINE:CHARACTER:MIDDLE:ADDR

   where FILENAME is an absolute file name indicating which source

   where FILENAME is an absolute file name indicating which source

file, LINE is the line number within that file (where 1 is the first

file, LINE is the line number within that file (where 1 is the first

line in the file), CHARACTER is the character position within the file

line in the file), CHARACTER is the character position within the file

(where 0 is the first character in the file) (for most debug formats

(where 0 is the first character in the file) (for most debug formats

this will necessarily point to the beginning of a line), MIDDLE is

this will necessarily point to the beginning of a line), MIDDLE is

`middle' if ADDR is in the middle of the line, or `beg' if ADDR is at

`middle' if ADDR is in the middle of the line, or `beg' if ADDR is at

the beginning of the line, and ADDR is the address in the target

the beginning of the line, and ADDR is the address in the target

program associated with the source which is being displayed.  ADDR is

program associated with the source which is being displayed.  ADDR is

in the form `0x' followed by one or more lowercase hex digits (note

in the form `0x' followed by one or more lowercase hex digits (note

that this does not depend on the language).

that this does not depend on the language).

File: annotate.info,  Node: GNU Free Documentation License,  Prev: Source Annotations,  Up: Top

File: annotate.info,  Node: GNU Free Documentation License,  Prev: Source Annotations,  Up: Top

14 GNU Free Documentation License

14 GNU Free Documentation License

*********************************

*********************************

                      Version 1.2, November 2002

                      Version 1.2, November 2002

     Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.

     Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.

     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

     Everyone is permitted to copy and distribute verbatim copies

     Everyone is permitted to copy and distribute verbatim copies

     of this license document, but changing it is not allowed.

     of this license document, but changing it is not allowed.

  0. PREAMBLE

  0. PREAMBLE

     The purpose of this License is to make a manual, textbook, or other

     The purpose of this License is to make a manual, textbook, or other

     functional and useful document "free" in the sense of freedom: to

     functional and useful document "free" in the sense of freedom: to

     assure everyone the effective freedom to copy and redistribute it,

     assure everyone the effective freedom to copy and redistribute it,

     with or without modifying it, either commercially or

     with or without modifying it, either commercially or

     noncommercially.  Secondarily, this License preserves for the

     noncommercially.  Secondarily, this License preserves for the

     author and publisher a way to get credit for their work, while not

     author and publisher a way to get credit for their work, while not

     being considered responsible for modifications made by others.

     being considered responsible for modifications made by others.

     This License is a kind of "copyleft", which means that derivative

     This License is a kind of "copyleft", which means that derivative

     works of the document must themselves be free in the same sense.

     works of the document must themselves be free in the same sense.

     It complements the GNU General Public License, which is a copyleft

     It complements the GNU General Public License, which is a copyleft

     license designed for free software.

     license designed for free software.

     We have designed this License in order to use it for manuals for

     We have designed this License in order to use it for manuals for

     free software, because free software needs free documentation: a

     free software, because free software needs free documentation: a

     free program should come with manuals providing the same freedoms

     free program should come with manuals providing the same freedoms

     that the software does.  But this License is not limited to

     that the software does.  But this License is not limited to

     software manuals; it can be used for any textual work, regardless

     software manuals; it can be used for any textual work, regardless

     of subject matter or whether it is published as a printed book.

     of subject matter or whether it is published as a printed book.

     We recommend this License principally for works whose purpose is

     We recommend this License principally for works whose purpose is

     instruction or reference.

     instruction or reference.

  1. APPLICABILITY AND DEFINITIONS

  1. APPLICABILITY AND DEFINITIONS

     This License applies to any manual or other work, in any medium,

     This License applies to any manual or other work, in any medium,

     that contains a notice placed by the copyright holder saying it

     that contains a notice placed by the copyright holder saying it

     can be distributed under the terms of this License.  Such a notice

     can be distributed under the terms of this License.  Such a notice

     grants a world-wide, royalty-free license, unlimited in duration,

     grants a world-wide, royalty-free license, unlimited in duration,

     to use that work under the conditions stated herein.  The

     to use that work under the conditions stated herein.  The

     "Document", below, refers to any such manual or work.  Any member

     "Document", below, refers to any such manual or work.  Any member

     of the public is a licensee, and is addressed as "you".  You

     of the public is a licensee, and is addressed as "you".  You

     accept the license if you copy, modify or distribute the work in a

     accept the license if you copy, modify or distribute the work in a

     way requiring permission under copyright law.

     way requiring permission under copyright law.

     A "Modified Version" of the Document means any work containing the

     A "Modified Version" of the Document means any work containing the

     Document or a portion of it, either copied verbatim, or with

     Document or a portion of it, either copied verbatim, or with

     modifications and/or translated into another language.

     modifications and/or translated into another language.

     A "Secondary Section" is a named appendix or a front-matter section

     A "Secondary Section" is a named appendix or a front-matter section

     of the Document that deals exclusively with the relationship of the

     of the Document that deals exclusively with the relationship of the

     publishers or authors of the Document to the Document's overall

     publishers or authors of the Document to the Document's overall

     subject (or to related matters) and contains nothing that could

     subject (or to related matters) and contains nothing that could

     fall directly within that overall subject.  (Thus, if the Document

     fall directly within that overall subject.  (Thus, if the Document

     is in part a textbook of mathematics, a Secondary Section may not

     is in part a textbook of mathematics, a Secondary Section may not

     explain any mathematics.)  The relationship could be a matter of

     explain any mathematics.)  The relationship could be a matter of

     historical connection with the subject or with related matters, or

     historical connection with the subject or with related matters, or

     of legal, commercial, philosophical, ethical or political position

     of legal, commercial, philosophical, ethical or political position

     regarding them.

     regarding them.

     The "Invariant Sections" are certain Secondary Sections whose

     The "Invariant Sections" are certain Secondary Sections whose

     titles are designated, as being those of Invariant Sections, in

     titles are designated, as being those of Invariant Sections, in

     the notice that says that the Document is released under this

     the notice that says that the Document is released under this

     License.  If a section does not fit the above definition of

     License.  If a section does not fit the above definition of

     Secondary then it is not allowed to be designated as Invariant.

     Secondary then it is not allowed to be designated as Invariant.

     The Document may contain zero Invariant Sections.  If the Document

     The Document may contain zero Invariant Sections.  If the Document

     does not identify any Invariant Sections then there are none.

     does not identify any Invariant Sections then there are none.

     The "Cover Texts" are certain short passages of text that are

     The "Cover Texts" are certain short passages of text that are

     listed, as Front-Cover Texts or Back-Cover Texts, in the notice

     listed, as Front-Cover Texts or Back-Cover Texts, in the notice

     that says that the Document is released under this License.  A

     that says that the Document is released under this License.  A

     Front-Cover Text may be at most 5 words, and a Back-Cover Text may

     Front-Cover Text may be at most 5 words, and a Back-Cover Text may

     be at most 25 words.

     be at most 25 words.

     A "Transparent" copy of the Document means a machine-readable copy,

     A "Transparent" copy of the Document means a machine-readable copy,

     represented in a format whose specification is available to the

     represented in a format whose specification is available to the

     general public, that is suitable for revising the document

     general public, that is suitable for revising the document

     straightforwardly with generic text editors or (for images

     straightforwardly with generic text editors or (for images

     composed of pixels) generic paint programs or (for drawings) some

     composed of pixels) generic paint programs or (for drawings) some

     widely available drawing editor, and that is suitable for input to

     widely available drawing editor, and that is suitable for input to

     text formatters or for automatic translation to a variety of

     text formatters or for automatic translation to a variety of

     formats suitable for input to text formatters.  A copy made in an

     formats suitable for input to text formatters.  A copy made in an

     otherwise Transparent file format whose markup, or absence of

     otherwise Transparent file format whose markup, or absence of

     markup, has been arranged to thwart or discourage subsequent

     markup, has been arranged to thwart or discourage subsequent

     modification by readers is not Transparent.  An image format is

     modification by readers is not Transparent.  An image format is

     not Transparent if used for any substantial amount of text.  A

     not Transparent if used for any substantial amount of text.  A

     copy that is not "Transparent" is called "Opaque".

     copy that is not "Transparent" is called "Opaque".

     Examples of suitable formats for Transparent copies include plain

     Examples of suitable formats for Transparent copies include plain

     ASCII without markup, Texinfo input format, LaTeX input format,

     ASCII without markup, Texinfo input format, LaTeX input format,

     SGML or XML using a publicly available DTD, and

     SGML or XML using a publicly available DTD, and

     standard-conforming simple HTML, PostScript or PDF designed for

     standard-conforming simple HTML, PostScript or PDF designed for

     human modification.  Examples of transparent image formats include

     human modification.  Examples of transparent image formats include

     PNG, XCF and JPG.  Opaque formats include proprietary formats that

     PNG, XCF and JPG.  Opaque formats include proprietary formats that

     can be read and edited only by proprietary word processors, SGML or

     can be read and edited only by proprietary word processors, SGML or

     XML for which the DTD and/or processing tools are not generally

     XML for which the DTD and/or processing tools are not generally

     available, and the machine-generated HTML, PostScript or PDF

     available, and the machine-generated HTML, PostScript or PDF

     produced by some word processors for output purposes only.

     produced by some word processors for output purposes only.

     The "Title Page" means, for a printed book, the title page itself,

     The "Title Page" means, for a printed book, the title page itself,

     plus such following pages as are needed to hold, legibly, the

     plus such following pages as are needed to hold, legibly, the

     material this License requires to appear in the title page.  For

     material this License requires to appear in the title page.  For

     works in formats which do not have any title page as such, "Title

     works in formats which do not have any title page as such, "Title

     Page" means the text near the most prominent appearance of the

     Page" means the text near the most prominent appearance of the

     work's title, preceding the beginning of the body of the text.

     work's title, preceding the beginning of the body of the text.

     A section "Entitled XYZ" means a named subunit of the Document

     A section "Entitled XYZ" means a named subunit of the Document

     whose title either is precisely XYZ or contains XYZ in parentheses

     whose title either is precisely XYZ or contains XYZ in parentheses

     following text that translates XYZ in another language.  (Here XYZ

     following text that translates XYZ in another language.  (Here XYZ

     stands for a specific section name mentioned below, such as

     stands for a specific section name mentioned below, such as

     "Acknowledgements", "Dedications", "Endorsements", or "History".)

     "Acknowledgements", "Dedications", "Endorsements", or "History".)

     To "Preserve the Title" of such a section when you modify the

     To "Preserve the Title" of such a section when you modify the

     Document means that it remains a section "Entitled XYZ" according

     Document means that it remains a section "Entitled XYZ" according

     to this definition.

     to this definition.

     The Document may include Warranty Disclaimers next to the notice

     The Document may include Warranty Disclaimers next to the notice

     which states that this License applies to the Document.  These

     which states that this License applies to the Document.  These

     Warranty Disclaimers are considered to be included by reference in

     Warranty Disclaimers are considered to be included by reference in

     this License, but only as regards disclaiming warranties: any other

     this License, but only as regards disclaiming warranties: any other

     implication that these Warranty Disclaimers may have is void and

     implication that these Warranty Disclaimers may have is void and

     has no effect on the meaning of this License.

     has no effect on the meaning of this License.

  2. VERBATIM COPYING

  2. VERBATIM COPYING

     You may copy and distribute the Document in any medium, either

     You may copy and distribute the Document in any medium, either

     commercially or noncommercially, provided that this License, the

     commercially or noncommercially, provided that this License, the

     copyright notices, and the license notice saying this License

     copyright notices, and the license notice saying this License

     applies to the Document are reproduced in all copies, and that you

     applies to the Document are reproduced in all copies, and that you

     add no other conditions whatsoever to those of this License.  You

     add no other conditions whatsoever to those of this License.  You

     may not use technical measures to obstruct or control the reading

     may not use technical measures to obstruct or control the reading

     or further copying of the copies you make or distribute.  However,

     or further copying of the copies you make or distribute.  However,

     you may accept compensation in exchange for copies.  If you

     you may accept compensation in exchange for copies.  If you

     distribute a large enough number of copies you must also follow

     distribute a large enough number of copies you must also follow

     the conditions in section 3.

     the conditions in section 3.

     You may also lend copies, under the same conditions stated above,

     You may also lend copies, under the same conditions stated above,

     and you may publicly display copies.

     and you may publicly display copies.

  3. COPYING IN QUANTITY

  3. COPYING IN QUANTITY

     If you publish printed copies (or copies in media that commonly

     If you publish printed copies (or copies in media that commonly

     have printed covers) of the Document, numbering more than 100, and

     have printed covers) of the Document, numbering more than 100, and

     the Document's license notice requires Cover Texts, you must

     the Document's license notice requires Cover Texts, you must

     enclose the copies in covers that carry, clearly and legibly, all

     enclose the copies in covers that carry, clearly and legibly, all

     these Cover Texts: Front-Cover Texts on the front cover, and

     these Cover Texts: Front-Cover Texts on the front cover, and

     Back-Cover Texts on the back cover.  Both covers must also clearly

     Back-Cover Texts on the back cover.  Both covers must also clearly

     and legibly identify you as the publisher of these copies.  The

     and legibly identify you as the publisher of these copies.  The

     front cover must present the full title with all words of the

     front cover must present the full title with all words of the

     title equally prominent and visible.  You may add other material

     title equally prominent and visible.  You may add other material

     on the covers in addition.  Copying with changes limited to the

     on the covers in addition.  Copying with changes limited to the

     covers, as long as they preserve the title of the Document and

     covers, as long as they preserve the title of the Document and

     satisfy these conditions, can be treated as verbatim copying in

     satisfy these conditions, can be treated as verbatim copying in

     other respects.

     other respects.

     If the required texts for either cover are too voluminous to fit

     If the required texts for either cover are too voluminous to fit

     legibly, you should put the first ones listed (as many as fit

     legibly, you should put the first ones listed (as many as fit

     reasonably) on the actual cover, and continue the rest onto

     reasonably) on the actual cover, and continue the rest onto

     adjacent pages.

     adjacent pages.

     If you publish or distribute Opaque copies of the Document

     If you publish or distribute Opaque copies of the Document

     numbering more than 100, you must either include a

     numbering more than 100, you must either include a

     machine-readable Transparent copy along with each Opaque copy, or

     machine-readable Transparent copy along with each Opaque copy, or

     state in or with each Opaque copy a computer-network location from

     state in or with each Opaque copy a computer-network location from

     which the general network-using public has access to download

     which the general network-using public has access to download

     using public-standard network protocols a complete Transparent

     using public-standard network protocols a complete Transparent

     copy of the Document, free of added material.  If you use the

     copy of the Document, free of added material.  If you use the

     latter option, you must take reasonably prudent steps, when you

     latter option, you must take reasonably prudent steps, when you

     begin distribution of Opaque copies in quantity, to ensure that

     begin distribution of Opaque copies in quantity, to ensure that

     this Transparent copy will remain thus accessible at the stated

     this Transparent copy will remain thus accessible at the stated

     location until at least one year after the last time you

     location until at least one year after the last time you

     distribute an Opaque copy (directly or through your agents or

     distribute an Opaque copy (directly or through your agents or

     retailers) of that edition to the public.

     retailers) of that edition to the public.

     It is requested, but not required, that you contact the authors of

     It is requested, but not required, that you contact the authors of

     the Document well before redistributing any large number of

     the Document well before redistributing any large number of

     copies, to give them a chance to provide you with an updated

     copies, to give them a chance to provide you with an updated

     version of the Document.

     version of the Document.

  4. MODIFICATIONS

  4. MODIFICATIONS

     You may copy and distribute a Modified Version of the Document

     You may copy and distribute a Modified Version of the Document

     under the conditions of sections 2 and 3 above, provided that you

     under the conditions of sections 2 and 3 above, provided that you

     release the Modified Version under precisely this License, with

     release the Modified Version under precisely this License, with

     the Modified Version filling the role of the Document, thus

     the Modified Version filling the role of the Document, thus

     licensing distribution and modification of the Modified Version to

     licensing distribution and modification of the Modified Version to

     whoever possesses a copy of it.  In addition, you must do these

     whoever possesses a copy of it.  In addition, you must do these

     things in the Modified Version:

     things in the Modified Version:

       A. Use in the Title Page (and on the covers, if any) a title

       A. Use in the Title Page (and on the covers, if any) a title

          distinct from that of the Document, and from those of

          distinct from that of the Document, and from those of

          previous versions (which should, if there were any, be listed

          previous versions (which should, if there were any, be listed

          in the History section of the Document).  You may use the

          in the History section of the Document).  You may use the

          same title as a previous version if the original publisher of

          same title as a previous version if the original publisher of

          that version gives permission.

          that version gives permission.

       B. List on the Title Page, as authors, one or more persons or

       B. List on the Title Page, as authors, one or more persons or

          entities responsible for authorship of the modifications in

          entities responsible for authorship of the modifications in

          the Modified Version, together with at least five of the

          the Modified Version, together with at least five of the

          principal authors of the Document (all of its principal

          principal authors of the Document (all of its principal

          authors, if it has fewer than five), unless they release you

          authors, if it has fewer than five), unless they release you

          from this requirement.

          from this requirement.

       C. State on the Title page the name of the publisher of the

       C. State on the Title page the name of the publisher of the

          Modified Version, as the publisher.

          Modified Version, as the publisher.

       D. Preserve all the copyright notices of the Document.

       D. Preserve all the copyright notices of the Document.

       E. Add an appropriate copyright notice for your modifications

       E. Add an appropriate copyright notice for your modifications

          adjacent to the other copyright notices.

          adjacent to the other copyright notices.

       F. Include, immediately after the copyright notices, a license

       F. Include, immediately after the copyright notices, a license

          notice giving the public permission to use the Modified

          notice giving the public permission to use the Modified

          Version under the terms of this License, in the form shown in

          Version under the terms of this License, in the form shown in

          the Addendum below.

          the Addendum below.

       G. Preserve in that license notice the full lists of Invariant

       G. Preserve in that license notice the full lists of Invariant

          Sections and required Cover Texts given in the Document's

          Sections and required Cover Texts given in the Document's

          license notice.

          license notice.

       H. Include an unaltered copy of this License.

       H. Include an unaltered copy of this License.

       I. Preserve the section Entitled "History", Preserve its Title,

       I. Preserve the section Entitled "History", Preserve its Title,

          and add to it an item stating at least the title, year, new

          and add to it an item stating at least the title, year, new

          authors, and publisher of the Modified Version as given on

          authors, and publisher of the Modified Version as given on

          the Title Page.  If there is no section Entitled "History" in

          the Title Page.  If there is no section Entitled "History" in

          the Document, create one stating the title, year, authors,

          the Document, create one stating the title, year, authors,

          and publisher of the Document as given on its Title Page,

          and publisher of the Document as given on its Title Page,

          then add an item describing the Modified Version as stated in

          then add an item describing the Modified Version as stated in

          the previous sentence.

          the previous sentence.

       J. Preserve the network location, if any, given in the Document

       J. Preserve the network location, if any, given in the Document

          for public access to a Transparent copy of the Document, and

          for public access to a Transparent copy of the Document, and

          likewise the network locations given in the Document for

          likewise the network locations given in the Document for

          previous versions it was based on.  These may be placed in

          previous versions it was based on.  These may be placed in

          the "History" section.  You may omit a network location for a

          the "History" section.  You may omit a network location for a

          work that was published at least four years before the

          work that was published at least four years before the

          Document itself, or if the original publisher of the version

          Document itself, or if the original publisher of the version

          it refers to gives permission.

          it refers to gives permission.

       K. For any section Entitled "Acknowledgements" or "Dedications",

       K. For any section Entitled "Acknowledgements" or "Dedications",

          Preserve the Title of the section, and preserve in the

          Preserve the Title of the section, and preserve in the

          section all the substance and tone of each of the contributor

          section all the substance and tone of each of the contributor

          acknowledgements and/or dedications given therein.

          acknowledgements and/or dedications given therein.

       L. Preserve all the Invariant Sections of the Document,

       L. Preserve all the Invariant Sections of the Document,

          unaltered in their text and in their titles.  Section numbers

          unaltered in their text and in their titles.  Section numbers

          or the equivalent are not considered part of the section

          or the equivalent are not considered part of the section

          titles.

          titles.

       M. Delete any section Entitled "Endorsements".  Such a section

       M. Delete any section Entitled "Endorsements".  Such a section

          may not be included in the Modified Version.

          may not be included in the Modified Version.

       N. Do not retitle any existing section to be Entitled

       N. Do not retitle any existing section to be Entitled

          "Endorsements" or to conflict in title with any Invariant

          "Endorsements" or to conflict in title with any Invariant

          Section.

          Section.

       O. Preserve any Warranty Disclaimers.

       O. Preserve any Warranty Disclaimers.

     If the Modified Version includes new front-matter sections or

     If the Modified Version includes new front-matter sections or

     appendices that qualify as Secondary Sections and contain no

     appendices that qualify as Secondary Sections and contain no

     material copied from the Document, you may at your option

     material copied from the Document, you may at your option

     designate some or all of these sections as invariant.  To do this,

     designate some or all of these sections as invariant.  To do this,

     add their titles to the list of Invariant Sections in the Modified

     add their titles to the list of Invariant Sections in the Modified

     Version's license notice.  These titles must be distinct from any

     Version's license notice.  These titles must be distinct from any

     other section titles.

     other section titles.

     You may add a section Entitled "Endorsements", provided it contains

     You may add a section Entitled "Endorsements", provided it contains

     nothing but endorsements of your Modified Version by various

     nothing but endorsements of your Modified Version by various

     parties--for example, statements of peer review or that the text

     parties--for example, statements of peer review or that the text

     has been approved by an organization as the authoritative

     has been approved by an organization as the authoritative

     definition of a standard.

     definition of a standard.

     You may add a passage of up to five words as a Front-Cover Text,

     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

     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

     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

     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

     added by (or through arrangements made by) any one entity.  If the

     Document already includes a cover text for the same cover,

     Document already includes a cover text for the same cover,