OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [gdb-5.0/] [gdb/] [doc/] [gdb.info-11] - Diff between revs 362 and 1765

Only display areas with differences | Details | Blame | View Log

Rev 362 Rev 1765
This is ./gdb.info, produced by makeinfo version 4.0 from gdb.texinfo.
This is ./gdb.info, produced by makeinfo version 4.0 from gdb.texinfo.
INFO-DIR-SECTION Programming & development tools.
INFO-DIR-SECTION Programming & development tools.
START-INFO-DIR-ENTRY
START-INFO-DIR-ENTRY
* Gdb: (gdb).                     The GNU debugger.
* Gdb: (gdb).                     The GNU debugger.
END-INFO-DIR-ENTRY
END-INFO-DIR-ENTRY
   This file documents the GNU debugger GDB.
   This file documents the GNU debugger GDB.
   This is the Eighth Edition, March 2000, of `Debugging with GDB: the
   This is the Eighth Edition, March 2000, of `Debugging with GDB: the
GNU Source-Level Debugger' for GDB Version 5.0.
GNU Source-Level Debugger' for GDB Version 5.0.
   Copyright (C) 1988-2000 Free Software Foundation, Inc.
   Copyright (C) 1988-2000 Free Software Foundation, Inc.
   Permission is granted to make and distribute verbatim copies of this
   Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
manual provided the copyright notice and this permission notice are
preserved on all copies.
preserved on all copies.
   Permission is granted to copy and distribute modified versions of
   Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided also
this manual under the conditions for verbatim copying, provided also
that the entire resulting derived work is distributed under the terms
that the entire resulting derived work is distributed under the terms
of a permission notice identical to this one.
of a permission notice identical to this one.
   Permission is granted to copy and distribute translations of this
   Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
manual into another language, under the above conditions for modified
versions.
versions.


File: gdb.info,  Node: GDB/MI Stack Manipulation,  Next: GDB/MI Symbol Query,  Prev: GDB/MI Miscellaneous Commands,  Up: GDB/MI
File: gdb.info,  Node: GDB/MI Stack Manipulation,  Next: GDB/MI Symbol Query,  Prev: GDB/MI Miscellaneous Commands,  Up: GDB/MI
Stack manipulation commands in GDB/MI
Stack manipulation commands in GDB/MI
=====================================
=====================================
The `-stack-info-frame' Command
The `-stack-info-frame' Command
-------------------------------
-------------------------------
Synopsis
Synopsis
........
........
      -stack-info-frame
      -stack-info-frame
   Get info on the current frame.
   Get info on the current frame.
GDB Command
GDB Command
...........
...........
   The corresponding GDB command is `info frame' or `frame' (without
   The corresponding GDB command is `info frame' or `frame' (without
arguments).
arguments).
Example
Example
.......
.......
   N.A.
   N.A.
The `-stack-info-depth' Command
The `-stack-info-depth' Command
-------------------------------
-------------------------------
Synopsis
Synopsis
........
........
      -stack-info-depth [ MAX-DEPTH ]
      -stack-info-depth [ MAX-DEPTH ]
   Return the depth of the stack.  If the integer argument MAX-DEPTH is
   Return the depth of the stack.  If the integer argument MAX-DEPTH is
specified, do not count beyond MAX-DEPTH frames.
specified, do not count beyond MAX-DEPTH frames.
GDB Command
GDB Command
...........
...........
   There's no equivalent GDB command.
   There's no equivalent GDB command.
Example
Example
.......
.......
   For a stack with frame levels 0 through 11:
   For a stack with frame levels 0 through 11:
     (gdb)
     (gdb)
     -stack-info-depth
     -stack-info-depth
     ^done,depth="12"
     ^done,depth="12"
     (gdb)
     (gdb)
     -stack-info-depth 4
     -stack-info-depth 4
     ^done,depth="4"
     ^done,depth="4"
     (gdb)
     (gdb)
     -stack-info-depth 12
     -stack-info-depth 12
     ^done,depth="12"
     ^done,depth="12"
     (gdb)
     (gdb)
     -stack-info-depth 11
     -stack-info-depth 11
     ^done,depth="11"
     ^done,depth="11"
     (gdb)
     (gdb)
     -stack-info-depth 13
     -stack-info-depth 13
     ^done,depth="12"
     ^done,depth="12"
     (gdb)
     (gdb)
The `-stack-list-arguments' Command
The `-stack-list-arguments' Command
-----------------------------------
-----------------------------------
Synopsis
Synopsis
........
........
      -stack-list-arguments SHOW-VALUES
      -stack-list-arguments SHOW-VALUES
         [ LOW-FRAME HIGH-FRAME ]
         [ LOW-FRAME HIGH-FRAME ]
   Display a list of the arguments for the frames between LOW-FRAME and
   Display a list of the arguments for the frames between LOW-FRAME and
HIGH-FRAME (inclusive).  If LOW-FRAME and HIGH-FRAME are not provided,
HIGH-FRAME (inclusive).  If LOW-FRAME and HIGH-FRAME are not provided,
list the arguments for the whole call stack.
list the arguments for the whole call stack.
   The SHOW-VALUES argument must have a value of 0 or 1.  A value of 0
   The SHOW-VALUES argument must have a value of 0 or 1.  A value of 0
means that only the names of the arguments are listed, a value of 1
means that only the names of the arguments are listed, a value of 1
means that both names and values of the arguments are printed.
means that both names and values of the arguments are printed.
GDB Command
GDB Command
...........
...........
   GDB does not have an equivalent command.  `gdbtk' has a
   GDB does not have an equivalent command.  `gdbtk' has a
`gdb_get_args' command which partially overlaps with the functionality
`gdb_get_args' command which partially overlaps with the functionality
of `-stack-list-arguments'.
of `-stack-list-arguments'.
Example
Example
.......
.......
     (gdb)
     (gdb)
     -stack-list-frames
     -stack-list-frames
     ^done,
     ^done,
     stack={
     stack={
     frame={level="0 ",addr="0x00010734",func="callee4",
     frame={level="0 ",addr="0x00010734",func="callee4",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"},
     frame={level="1 ",addr="0x0001076c",func="callee3",
     frame={level="1 ",addr="0x0001076c",func="callee3",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="17"},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="17"},
     frame={level="2 ",addr="0x0001078c",func="callee2",
     frame={level="2 ",addr="0x0001078c",func="callee2",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="22"},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="22"},
     frame={level="3 ",addr="0x000107b4",func="callee1",
     frame={level="3 ",addr="0x000107b4",func="callee1",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="27"},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="27"},
     frame={level="4 ",addr="0x000107e0",func="main",
     frame={level="4 ",addr="0x000107e0",func="main",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="32"}}
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="32"}}
     (gdb)
     (gdb)
     -stack-list-arguments 0
     -stack-list-arguments 0
     ^done,
     ^done,
     stack-args={
     stack-args={
     frame={level="0",args={}},
     frame={level="0",args={}},
     frame={level="1",args={name="strarg"}},
     frame={level="1",args={name="strarg"}},
     frame={level="2",args={name="intarg",name="strarg"}},
     frame={level="2",args={name="intarg",name="strarg"}},
     frame={level="3",args={name="intarg",name="strarg",name="fltarg"}},
     frame={level="3",args={name="intarg",name="strarg",name="fltarg"}},
     frame={level="4",args={}}}
     frame={level="4",args={}}}
     (gdb)
     (gdb)
     -stack-list-arguments 1
     -stack-list-arguments 1
     ^done,
     ^done,
     stack-args={
     stack-args={
     frame={level="0",args={}},
     frame={level="0",args={}},
     frame={level="1",
     frame={level="1",
      args={{name="strarg",value="0x11940 \"A string argument.\""}}},
      args={{name="strarg",value="0x11940 \"A string argument.\""}}},
     frame={level="2",args={
     frame={level="2",args={
     {name="intarg",value="2"},
     {name="intarg",value="2"},
     {name="strarg",value="0x11940 \"A string argument.\""}}},
     {name="strarg",value="0x11940 \"A string argument.\""}}},
     {frame={level="3",args={
     {frame={level="3",args={
     {name="intarg",value="2"},
     {name="intarg",value="2"},
     {name="strarg",value="0x11940 \"A string argument.\""},
     {name="strarg",value="0x11940 \"A string argument.\""},
     {name="fltarg",value="3.5"}}},
     {name="fltarg",value="3.5"}}},
     frame={level="4",args={}}}
     frame={level="4",args={}}}
     (gdb)
     (gdb)
     -stack-list-arguments 0 2 2
     -stack-list-arguments 0 2 2
     ^done,stack-args={frame={level="2",args={name="intarg",name="strarg"}}}
     ^done,stack-args={frame={level="2",args={name="intarg",name="strarg"}}}
     (gdb)
     (gdb)
     -stack-list-arguments 1 2 2
     -stack-list-arguments 1 2 2
     ^done,stack-args={frame={level="2",
     ^done,stack-args={frame={level="2",
     args={{name="intarg",value="2"},
     args={{name="intarg",value="2"},
     {name="strarg",value="0x11940 \"A string argument.\""}}}}
     {name="strarg",value="0x11940 \"A string argument.\""}}}}
     (gdb)
     (gdb)
The `-stack-list-frames' Command
The `-stack-list-frames' Command
--------------------------------
--------------------------------
Synopsis
Synopsis
........
........
      -stack-list-frames [ LOW-FRAME HIGH-FRAME ]
      -stack-list-frames [ LOW-FRAME HIGH-FRAME ]
   List the frames currently on the stack.  For each frame it displays
   List the frames currently on the stack.  For each frame it displays
the following info:
the following info:
`LEVEL'
`LEVEL'
     The frame number, 0 being the topmost frame, i.e. the innermost
     The frame number, 0 being the topmost frame, i.e. the innermost
     function.
     function.
`ADDR'
`ADDR'
     The `$pc' value for that frame.
     The `$pc' value for that frame.
`FUNC'
`FUNC'
     Function name.
     Function name.
`FILE'
`FILE'
     File name of the source file where the function lives.
     File name of the source file where the function lives.
`LINE'
`LINE'
     Line number corresponding to the `$pc'.
     Line number corresponding to the `$pc'.
   If invoked without arguments, this command prints a backtrace for the
   If invoked without arguments, this command prints a backtrace for the
whole stack.  If given two integer arguments, it shows the frames whose
whole stack.  If given two integer arguments, it shows the frames whose
levels are between the two arguments (inclusive).  If the two arguments
levels are between the two arguments (inclusive).  If the two arguments
are equal, it shows the single frame at the corresponding level.
are equal, it shows the single frame at the corresponding level.
GDB Command
GDB Command
...........
...........
   The corresponding GDB commands are `backtrace' and `where'.
   The corresponding GDB commands are `backtrace' and `where'.
Example
Example
.......
.......
   Full stack backtrace:
   Full stack backtrace:
     (gdb)
     (gdb)
     -stack-list-frames
     -stack-list-frames
     ^done,stack=
     ^done,stack=
     {frame={level="0 ",addr="0x0001076c",func="foo",
     {frame={level="0 ",addr="0x0001076c",func="foo",
       file="recursive2.c",line="11"},
       file="recursive2.c",line="11"},
     frame={level="1 ",addr="0x000107a4",func="foo",
     frame={level="1 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="2 ",addr="0x000107a4",func="foo",
     frame={level="2 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="3 ",addr="0x000107a4",func="foo",
     frame={level="3 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="4 ",addr="0x000107a4",func="foo",
     frame={level="4 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="5 ",addr="0x000107a4",func="foo",
     frame={level="5 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="6 ",addr="0x000107a4",func="foo",
     frame={level="6 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="7 ",addr="0x000107a4",func="foo",
     frame={level="7 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="8 ",addr="0x000107a4",func="foo",
     frame={level="8 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="9 ",addr="0x000107a4",func="foo",
     frame={level="9 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="10",addr="0x000107a4",func="foo",
     frame={level="10",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="11",addr="0x00010738",func="main",
     frame={level="11",addr="0x00010738",func="main",
       file="recursive2.c",line="4"}}
       file="recursive2.c",line="4"}}
     (gdb)
     (gdb)
   Show frames between low_frame and high_frame:
   Show frames between low_frame and high_frame:
     (gdb)
     (gdb)
     -stack-list-frames 3 5
     -stack-list-frames 3 5
     ^done,stack=
     ^done,stack=
     {frame={level="3 ",addr="0x000107a4",func="foo",
     {frame={level="3 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="4 ",addr="0x000107a4",func="foo",
     frame={level="4 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
       file="recursive2.c",line="14"},
     frame={level="5 ",addr="0x000107a4",func="foo",
     frame={level="5 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"}}
       file="recursive2.c",line="14"}}
     (gdb)
     (gdb)
   Show a single frame:
   Show a single frame:
     (gdb)
     (gdb)
     -stack-list-frames 3 3
     -stack-list-frames 3 3
     ^done,stack=
     ^done,stack=
     {frame={level="3 ",addr="0x000107a4",func="foo",
     {frame={level="3 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"}}
       file="recursive2.c",line="14"}}
     (gdb)
     (gdb)
The `-stack-list-locals' Command
The `-stack-list-locals' Command
--------------------------------
--------------------------------
Synopsis
Synopsis
........
........
      -stack-list-locals PRINT-VALUES
      -stack-list-locals PRINT-VALUES
   Display the local variable names for the current frame.  With an
   Display the local variable names for the current frame.  With an
argument of 0 prints only the names of the variables, with argument of 1
argument of 0 prints only the names of the variables, with argument of 1
prints also their values.
prints also their values.
GDB Command
GDB Command
...........
...........
   `info locals' in GDB, `gdb_get_locals' in `gdbtk'.
   `info locals' in GDB, `gdb_get_locals' in `gdbtk'.
Example
Example
.......
.......
     (gdb)
     (gdb)
     -stack-list-locals 0
     -stack-list-locals 0
     ^done,locals={name="A",name="B",name="C"}
     ^done,locals={name="A",name="B",name="C"}
     (gdb)
     (gdb)
     -stack-list-locals 1
     -stack-list-locals 1
     ^done,locals={{name="A",value="1"},{name="B",value="2"},
     ^done,locals={{name="A",value="1"},{name="B",value="2"},
       {name="C",value="3"}}
       {name="C",value="3"}}
     (gdb)
     (gdb)
The `-stack-select-frame' Command
The `-stack-select-frame' Command
---------------------------------
---------------------------------
Synopsis
Synopsis
........
........
      -stack-select-frame FRAMENUM
      -stack-select-frame FRAMENUM
   Change the current frame.  Select a different frame FRAMENUM on the
   Change the current frame.  Select a different frame FRAMENUM on the
stack.
stack.
GDB Command
GDB Command
...........
...........
   The corresponding GDB commands are `frame', `up', `down',
   The corresponding GDB commands are `frame', `up', `down',
`select-frame', `up-silent', and `down-silent'.
`select-frame', `up-silent', and `down-silent'.
Example
Example
.......
.......
     (gdb)
     (gdb)
     -stack-select-frame 2
     -stack-select-frame 2
     ^done
     ^done
     (gdb)
     (gdb)


File: gdb.info,  Node: GDB/MI Symbol Query,  Next: GDB/MI Target Manipulation,  Prev: GDB/MI Stack Manipulation,  Up: GDB/MI
File: gdb.info,  Node: GDB/MI Symbol Query,  Next: GDB/MI Target Manipulation,  Prev: GDB/MI Stack Manipulation,  Up: GDB/MI
GDB/MI Symbol Query Commands
GDB/MI Symbol Query Commands
============================
============================
The `-symbol-info-address' Command
The `-symbol-info-address' Command
----------------------------------
----------------------------------
Synopsis
Synopsis
........
........
      -symbol-info-address SYMBOL
      -symbol-info-address SYMBOL
   Describe where SYMBOL is stored.
   Describe where SYMBOL is stored.
GDB Command
GDB Command
...........
...........
   The corresponding GDB command is `info address'.
   The corresponding GDB command is `info address'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-symbol-info-file' Command
The `-symbol-info-file' Command
-------------------------------
-------------------------------
Synopsis
Synopsis
........
........
      -symbol-info-file
      -symbol-info-file
   Show the file for the symbol.
   Show the file for the symbol.
GDB Command
GDB Command
...........
...........
   There's no equivalent GDB command.  `gdbtk' has `gdb_filnd_file'.
   There's no equivalent GDB command.  `gdbtk' has `gdb_filnd_file'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-symbol-info-function' Command
The `-symbol-info-function' Command
-----------------------------------
-----------------------------------
Synopsis
Synopsis
........
........
      -symbol-info-function
      -symbol-info-function
   Show which function the symbol lives in.
   Show which function the symbol lives in.
GDB Command
GDB Command
...........
...........
   `gdb_get_function' in `gdbtk'.
   `gdb_get_function' in `gdbtk'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-symbol-info-line' Command
The `-symbol-info-line' Command
-------------------------------
-------------------------------
Synopsis
Synopsis
........
........
      -symbol-info-line
      -symbol-info-line
   Show the core addresses of the code for a source line.
   Show the core addresses of the code for a source line.
GDB Command
GDB Command
...........
...........
   The corresponding GDB comamnd is `info line'.  `gdbtk' has the
   The corresponding GDB comamnd is `info line'.  `gdbtk' has the
`gdb_get_line' `gdb_get_file' commands.
`gdb_get_line' `gdb_get_file' commands.
Example
Example
.......
.......
   N.A.
   N.A.
The `-symbol-info-symbol' Command
The `-symbol-info-symbol' Command
---------------------------------
---------------------------------
Synopsis
Synopsis
........
........
      -symbol-info-symbol ADDR
      -symbol-info-symbol ADDR
   Describe what symbol is at location ADDR.
   Describe what symbol is at location ADDR.
GDB Command
GDB Command
...........
...........
   The corresponding GDB command is `info symbol'.
   The corresponding GDB command is `info symbol'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-symbol-list-functions' Command
The `-symbol-list-functions' Command
------------------------------------
------------------------------------
Synopsis
Synopsis
........
........
      -symbol-list-functions
      -symbol-list-functions
   List the functions in the executable.
   List the functions in the executable.
GDB Command
GDB Command
...........
...........
   `info functions' in GDB, `gdb_listfunc' `gdb_search' in `gdbtk'.
   `info functions' in GDB, `gdb_listfunc' `gdb_search' in `gdbtk'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-symbol-list-types' Command
The `-symbol-list-types' Command
--------------------------------
--------------------------------
Synopsis
Synopsis
........
........
      -symbol-list-types
      -symbol-list-types
   List all the type names.
   List all the type names.
GDB Command
GDB Command
...........
...........
   The corresponding commands are `info types' in GDB, `gdb_search' in
   The corresponding commands are `info types' in GDB, `gdb_search' in
`gdbtk'.
`gdbtk'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-symbol-list-variables' Command
The `-symbol-list-variables' Command
------------------------------------
------------------------------------
Synopsis
Synopsis
........
........
      -symbol-list-variables
      -symbol-list-variables
   List all the global and static variable names.
   List all the global and static variable names.
GDB Command
GDB Command
...........
...........
   `info variables' in GDB, `gdb_search' in `gdbtk'.
   `info variables' in GDB, `gdb_search' in `gdbtk'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-symbol-locate' Command
The `-symbol-locate' Command
----------------------------
----------------------------
Synopsis
Synopsis
........
........
      -symbol-locate
      -symbol-locate
GDB Command
GDB Command
...........
...........
   `gdb_loc' in `gdbtk'.
   `gdb_loc' in `gdbtk'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-symbol-type' Command
The `-symbol-type' Command
--------------------------
--------------------------
Synopsis
Synopsis
........
........
      -symbol-type VARIABLE
      -symbol-type VARIABLE
   Show type of VARIABLE.
   Show type of VARIABLE.
GDB Command
GDB Command
...........
...........
   The corresponding GDB command is `ptype', `gdbtk' has
   The corresponding GDB command is `ptype', `gdbtk' has
`gdb_obj_variable'.
`gdb_obj_variable'.
Example
Example
.......
.......
   N.A.
   N.A.


File: gdb.info,  Node: GDB/MI Target Manipulation,  Next: GDB/MI Thread Commands,  Prev: GDB/MI Symbol Query,  Up: GDB/MI
File: gdb.info,  Node: GDB/MI Target Manipulation,  Next: GDB/MI Thread Commands,  Prev: GDB/MI Symbol Query,  Up: GDB/MI
GDB/MI Target Manipulation Commands
GDB/MI Target Manipulation Commands
===================================
===================================
The `-target-attach' Command
The `-target-attach' Command
----------------------------
----------------------------
Synopsis
Synopsis
........
........
      -target-attach PID | FILE
      -target-attach PID | FILE
   Attach to a process PID or a file FILE outside of GDB.
   Attach to a process PID or a file FILE outside of GDB.
GDB command
GDB command
...........
...........
   The corresponding GDB command is `attach'.
   The corresponding GDB command is `attach'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-target-compare-sections' Command
The `-target-compare-sections' Command
--------------------------------------
--------------------------------------
Synopsis
Synopsis
........
........
      -target-compare-sections [ SECTION ]
      -target-compare-sections [ SECTION ]
   Compare data of section SECTION on target to the exec file.  Without
   Compare data of section SECTION on target to the exec file.  Without
the argument, all sections are compared.
the argument, all sections are compared.
GDB Command
GDB Command
...........
...........
   The GDB equivalent is `compare-sections'.
   The GDB equivalent is `compare-sections'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-target-detach' Command
The `-target-detach' Command
----------------------------
----------------------------
Synopsis
Synopsis
........
........
      -target-detach
      -target-detach
   Disconnect from the remote target.  There's no output.
   Disconnect from the remote target.  There's no output.
GDB command
GDB command
...........
...........
   The corresponding GDB command is `detach'.
   The corresponding GDB command is `detach'.
Example
Example
.......
.......
     (gdb)
     (gdb)
     -target-detach
     -target-detach
     ^done
     ^done
     (gdb)
     (gdb)
The `-target-download' Command
The `-target-download' Command
------------------------------
------------------------------
Synopsis
Synopsis
........
........
      -target-download
      -target-download
   Loads the executable onto the remote target.  It prints out an
   Loads the executable onto the remote target.  It prints out an
update message every half second, which includes the fields:
update message every half second, which includes the fields:
`section'
`section'
     The name of the section.
     The name of the section.
`section-sent'
`section-sent'
     The size of what has been sent so far for that section.
     The size of what has been sent so far for that section.
`section-size'
`section-size'
     The size of the section.
     The size of the section.
`total-sent'
`total-sent'
     The total size of what was sent so far (the current and the
     The total size of what was sent so far (the current and the
     previous sections).
     previous sections).
`total-size'
`total-size'
     The size of the overall executable to download.
     The size of the overall executable to download.
Each message is sent as status record (*note GDB/MI Output Syntax:
Each message is sent as status record (*note GDB/MI Output Syntax:
GDB/MI Output Syntax.).
GDB/MI Output Syntax.).
   In addition, it prints the name and size of the sections, as they are
   In addition, it prints the name and size of the sections, as they are
downloaded.  These messages include the following fields:
downloaded.  These messages include the following fields:
`section'
`section'
     The name of the section.
     The name of the section.
`section-size'
`section-size'
     The size of the section.
     The size of the section.
`total-size'
`total-size'
     The size of the overall executable to download.
     The size of the overall executable to download.
At the end,  a summary is printed.
At the end,  a summary is printed.
GDB Command
GDB Command
...........
...........
   The corresponding GDB command is `load'.
   The corresponding GDB command is `load'.
Example
Example
.......
.......
   Note: each status message appears on a single line.  Here the
   Note: each status message appears on a single line.  Here the
messages have been broken down so that they can fit onto a page.
messages have been broken down so that they can fit onto a page.
     (gdb)
     (gdb)
     -target-download
     -target-download
     +download,{section=".text",section-size="6668",total-size="9880"}
     +download,{section=".text",section-size="6668",total-size="9880"}
     +download,{section=".text",section-sent="512",section-size="6668",
     +download,{section=".text",section-sent="512",section-size="6668",
     total-sent="512",total-size="9880"}
     total-sent="512",total-size="9880"}
     +download,{section=".text",section-sent="1024",section-size="6668",
     +download,{section=".text",section-sent="1024",section-size="6668",
     total-sent="1024",total-size="9880"}
     total-sent="1024",total-size="9880"}
     +download,{section=".text",section-sent="1536",section-size="6668",
     +download,{section=".text",section-sent="1536",section-size="6668",
     total-sent="1536",total-size="9880"}
     total-sent="1536",total-size="9880"}
     +download,{section=".text",section-sent="2048",section-size="6668",
     +download,{section=".text",section-sent="2048",section-size="6668",
     total-sent="2048",total-size="9880"}
     total-sent="2048",total-size="9880"}
     +download,{section=".text",section-sent="2560",section-size="6668",
     +download,{section=".text",section-sent="2560",section-size="6668",
     total-sent="2560",total-size="9880"}
     total-sent="2560",total-size="9880"}
     +download,{section=".text",section-sent="3072",section-size="6668",
     +download,{section=".text",section-sent="3072",section-size="6668",
     total-sent="3072",total-size="9880"}
     total-sent="3072",total-size="9880"}
     +download,{section=".text",section-sent="3584",section-size="6668",
     +download,{section=".text",section-sent="3584",section-size="6668",
     total-sent="3584",total-size="9880"}
     total-sent="3584",total-size="9880"}
     +download,{section=".text",section-sent="4096",section-size="6668",
     +download,{section=".text",section-sent="4096",section-size="6668",
     total-sent="4096",total-size="9880"}
     total-sent="4096",total-size="9880"}
     +download,{section=".text",section-sent="4608",section-size="6668",
     +download,{section=".text",section-sent="4608",section-size="6668",
     total-sent="4608",total-size="9880"}
     total-sent="4608",total-size="9880"}
     +download,{section=".text",section-sent="5120",section-size="6668",
     +download,{section=".text",section-sent="5120",section-size="6668",
     total-sent="5120",total-size="9880"}
     total-sent="5120",total-size="9880"}
     +download,{section=".text",section-sent="5632",section-size="6668",
     +download,{section=".text",section-sent="5632",section-size="6668",
     total-sent="5632",total-size="9880"}
     total-sent="5632",total-size="9880"}
     +download,{section=".text",section-sent="6144",section-size="6668",
     +download,{section=".text",section-sent="6144",section-size="6668",
     total-sent="6144",total-size="9880"}
     total-sent="6144",total-size="9880"}
     +download,{section=".text",section-sent="6656",section-size="6668",
     +download,{section=".text",section-sent="6656",section-size="6668",
     total-sent="6656",total-size="9880"}
     total-sent="6656",total-size="9880"}
     +download,{section=".init",section-size="28",total-size="9880"}
     +download,{section=".init",section-size="28",total-size="9880"}
     +download,{section=".fini",section-size="28",total-size="9880"}
     +download,{section=".fini",section-size="28",total-size="9880"}
     +download,{section=".data",section-size="3156",total-size="9880"}
     +download,{section=".data",section-size="3156",total-size="9880"}
     +download,{section=".data",section-sent="512",section-size="3156",
     +download,{section=".data",section-sent="512",section-size="3156",
     total-sent="7236",total-size="9880"}
     total-sent="7236",total-size="9880"}
     +download,{section=".data",section-sent="1024",section-size="3156",
     +download,{section=".data",section-sent="1024",section-size="3156",
     total-sent="7748",total-size="9880"}
     total-sent="7748",total-size="9880"}
     +download,{section=".data",section-sent="1536",section-size="3156",
     +download,{section=".data",section-sent="1536",section-size="3156",
     total-sent="8260",total-size="9880"}
     total-sent="8260",total-size="9880"}
     +download,{section=".data",section-sent="2048",section-size="3156",
     +download,{section=".data",section-sent="2048",section-size="3156",
     total-sent="8772",total-size="9880"}
     total-sent="8772",total-size="9880"}
     +download,{section=".data",section-sent="2560",section-size="3156",
     +download,{section=".data",section-sent="2560",section-size="3156",
     total-sent="9284",total-size="9880"}
     total-sent="9284",total-size="9880"}
     +download,{section=".data",section-sent="3072",section-size="3156",
     +download,{section=".data",section-sent="3072",section-size="3156",
     total-sent="9796",total-size="9880"}
     total-sent="9796",total-size="9880"}
     ^done,address="0x10004",load-size="9880",transfer-rate="6586",
     ^done,address="0x10004",load-size="9880",transfer-rate="6586",
     write-rate="429"
     write-rate="429"
     (gdb)
     (gdb)
The `-target-exec-status' Command
The `-target-exec-status' Command
---------------------------------
---------------------------------
Synopsis
Synopsis
........
........
      -target-exec-status
      -target-exec-status
   Provide information on the state of the target (whether it is
   Provide information on the state of the target (whether it is
running or not, for instance).
running or not, for instance).
GDB Command
GDB Command
...........
...........
   There's no equivalent GDB command.
   There's no equivalent GDB command.
Example
Example
.......
.......
   N.A.
   N.A.
The `-target-list-available-targets' Command
The `-target-list-available-targets' Command
--------------------------------------------
--------------------------------------------
Synopsis
Synopsis
........
........
      -target-list-available-targets
      -target-list-available-targets
   List the possible targets to connect to.
   List the possible targets to connect to.
GDB Command
GDB Command
...........
...........
   The corresponding GDB command is `help target'.
   The corresponding GDB command is `help target'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-target-list-current-targets' Command
The `-target-list-current-targets' Command
------------------------------------------
------------------------------------------
Synopsis
Synopsis
........
........
      -target-list-current-targets
      -target-list-current-targets
   Describe the current target.
   Describe the current target.
GDB Command
GDB Command
...........
...........
   The corresponding information is printed by `info file' (among other
   The corresponding information is printed by `info file' (among other
things).
things).
Example
Example
.......
.......
   N.A.
   N.A.
The `-target-list-parameters' Command
The `-target-list-parameters' Command
-------------------------------------
-------------------------------------
Synopsis
Synopsis
........
........
      -target-list-parameters
      -target-list-parameters
GDB Command
GDB Command
...........
...........
   No equivalent.
   No equivalent.
Example
Example
.......
.......
   N.A.
   N.A.
The `-target-select' Command
The `-target-select' Command
----------------------------
----------------------------
Synopsis
Synopsis
........
........
      -target-select TYPE PARAMETERS ...
      -target-select TYPE PARAMETERS ...
   Connect GDB to the remote target.  This command takes two args:
   Connect GDB to the remote target.  This command takes two args:
`TYPE'
`TYPE'
     The type of target, for instance `async', `remote', etc.
     The type of target, for instance `async', `remote', etc.
`PARAMETERS'
`PARAMETERS'
     Device names, host names and the like.  *Note Commands for
     Device names, host names and the like.  *Note Commands for
     managing targets: Target Commands, for more details.
     managing targets: Target Commands, for more details.
   The output is a connection notification, followed by the address at
   The output is a connection notification, followed by the address at
which the target program is, in the following form:
which the target program is, in the following form:
     ^connected,addr="ADDRESS",func="FUNCTION NAME",
     ^connected,addr="ADDRESS",func="FUNCTION NAME",
       args={ARG LIST}
       args={ARG LIST}
GDB Command
GDB Command
...........
...........
   The corresponding GDB command is `target'.
   The corresponding GDB command is `target'.
Example
Example
.......
.......
     (gdb)
     (gdb)
     -target-select async /dev/ttya
     -target-select async /dev/ttya
     ^connected,addr="0xfe00a300",func="??",args={}
     ^connected,addr="0xfe00a300",func="??",args={}
     (gdb)
     (gdb)


File: gdb.info,  Node: GDB/MI Thread Commands,  Next: GDB/MI Tracepoint Commands,  Prev: GDB/MI Target Manipulation,  Up: GDB/MI
File: gdb.info,  Node: GDB/MI Thread Commands,  Next: GDB/MI Tracepoint Commands,  Prev: GDB/MI Target Manipulation,  Up: GDB/MI
GDB/MI Thread Commands
GDB/MI Thread Commands
======================
======================
The `-thread-info' Command
The `-thread-info' Command
--------------------------
--------------------------
Synopsis
Synopsis
........
........
      -thread-info
      -thread-info
GDB command
GDB command
...........
...........
   No equivalent.
   No equivalent.
Example
Example
.......
.......
   N.A.
   N.A.
The `-thread-list-all-threads' Command
The `-thread-list-all-threads' Command
--------------------------------------
--------------------------------------
Synopsis
Synopsis
........
........
      -thread-list-all-threads
      -thread-list-all-threads
GDB Command
GDB Command
...........
...........
   The equivalent GDB command is `info threads'.
   The equivalent GDB command is `info threads'.
Example
Example
.......
.......
   N.A.
   N.A.
The `-thread-list-ids' Command
The `-thread-list-ids' Command
------------------------------
------------------------------
Synopsis
Synopsis
........
........
      -thread-list-ids
      -thread-list-ids
   Produces a list of the currently known gdb thread ids.  At the end
   Produces a list of the currently known gdb thread ids.  At the end
of the list it also prints the total number of such threads.
of the list it also prints the total number of such threads.
GDB Command
GDB Command
...........
...........
   Part of `info threads' supplies the same information.
   Part of `info threads' supplies the same information.
Example
Example
.......
.......
   No threads present, besides the main process.
   No threads present, besides the main process.
     (gdb)
     (gdb)
     -thread-list-ids
     -thread-list-ids
     ^done,thread-ids={},number-of-threads="0"
     ^done,thread-ids={},number-of-threads="0"
     (gdb)
     (gdb)
   Several threads.
   Several threads.
     (gdb)
     (gdb)
     -thread-list-ids
     -thread-list-ids
     ^done,thread-ids={thread-id="3",thread-id="2",thread-id="1"},
     ^done,thread-ids={thread-id="3",thread-id="2",thread-id="1"},
     number-of-threads="3"
     number-of-threads="3"
     (gdb)
     (gdb)
The `-thread-select' Command
The `-thread-select' Command
----------------------------
----------------------------
Synopsis
Synopsis
........
........
      -thread-select THREADNUM
      -thread-select THREADNUM
   Make THREADNUM the current thread.  It prints the number of the new
   Make THREADNUM the current thread.  It prints the number of the new
current thread, and the topmost frame for that thread.
current thread, and the topmost frame for that thread.
GDB Command
GDB Command
...........
...........
   The corresponding GDB command is `thread'.
   The corresponding GDB command is `thread'.
Example
Example
.......
.......
     (gdb)
     (gdb)
     -exec-next
     -exec-next
     ^running
     ^running
     (gdb)
     (gdb)
     *stopped,reason="end-stepping-range",thread-id="2",line="187",
     *stopped,reason="end-stepping-range",thread-id="2",line="187",
     file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
     file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
     (gdb)
     (gdb)
     -thread-list-ids
     -thread-list-ids
     ^done,
     ^done,
     thread-ids={thread-id="3",thread-id="2",thread-id="1"},
     thread-ids={thread-id="3",thread-id="2",thread-id="1"},
     number-of-threads="3"
     number-of-threads="3"
     (gdb)
     (gdb)
     -thread-select 3
     -thread-select 3
     ^done,new-thread-id="3",
     ^done,new-thread-id="3",
     frame={level="0 ",func="vprintf",
     frame={level="0 ",func="vprintf",
     args={{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""},
     args={{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""},
     {name="arg",value="0x2"}},file="vprintf.c",line="31"}
     {name="arg",value="0x2"}},file="vprintf.c",line="31"}
     (gdb)
     (gdb)


File: gdb.info,  Node: GDB/MI Tracepoint Commands,  Next: GDB/MI Variable Objects,  Prev: GDB/MI Thread Commands,  Up: GDB/MI
File: gdb.info,  Node: GDB/MI Tracepoint Commands,  Next: GDB/MI Variable Objects,  Prev: GDB/MI Thread Commands,  Up: GDB/MI
GDB/MI Tracepoint Commands
GDB/MI Tracepoint Commands
==========================
==========================
   The tracepoint commands are not yet implemented.
   The tracepoint commands are not yet implemented.


File: gdb.info,  Node: GDB/MI Variable Objects,  Next: GDB/MI Draft Changes to Output Syntax,  Prev: GDB/MI Tracepoint Commands,  Up: GDB/MI
File: gdb.info,  Node: GDB/MI Variable Objects,  Next: GDB/MI Draft Changes to Output Syntax,  Prev: GDB/MI Tracepoint Commands,  Up: GDB/MI
GDB/MI Variable Objects
GDB/MI Variable Objects
=======================
=======================
Motivation for Variable Objects in GDB/MI
Motivation for Variable Objects in GDB/MI
-----------------------------------------
-----------------------------------------
   For the implementation of a variable debugger window (locals, watched
   For the implementation of a variable debugger window (locals, watched
expressions, etc.), we are proposing the adaptation of the existing code
expressions, etc.), we are proposing the adaptation of the existing code
used by `Insight'.
used by `Insight'.
   The two main reasons for that are:
   The two main reasons for that are:
  1. It has been proven in practice (it is already on its second
  1. It has been proven in practice (it is already on its second
     generation).
     generation).
  2. It will shorten development time (needless to say how important it
  2. It will shorten development time (needless to say how important it
     is now).
     is now).
   The original interface was designed to be used by Tcl code, so it was
   The original interface was designed to be used by Tcl code, so it was
slightly changed so it could be used through flathead.  This document
slightly changed so it could be used through flathead.  This document
describes the flathead operations that will be available and gives some
describes the flathead operations that will be available and gives some
hints about their use.
hints about their use.
   _Note_: In addition to the set of operations described here, we
   _Note_: In addition to the set of operations described here, we
expect the GUI implementation of a variable window to require, at
expect the GUI implementation of a variable window to require, at
least, the following operations:
least, the following operations:
   * -gdb-show output-radix
   * -gdb-show output-radix
   * -stack-list-arguments
   * -stack-list-arguments
   * -stack-list-locals
   * -stack-list-locals
   * -stack-select-frame
   * -stack-select-frame
Introduction to Variable Objects in GDB/MI
Introduction to Variable Objects in GDB/MI
------------------------------------------
------------------------------------------
   The basic idea behind variable objects is the creation of a named
   The basic idea behind variable objects is the creation of a named
object to represent a variable, an expression, a memory location or
object to represent a variable, an expression, a memory location or
even a CPU register.  For each object created, a set of operations is
even a CPU register.  For each object created, a set of operations is
available for examining or changing its properties.
available for examining or changing its properties.
   Furthermore, complex data types, such as C structures, are
   Furthermore, complex data types, such as C structures, are
represented in a tree format.  For instance, the `struct' type variable
represented in a tree format.  For instance, the `struct' type variable
is the root and the children will represent the struct members.  If a
is the root and the children will represent the struct members.  If a
child is itself of a complex type, it will also have children of its
child is itself of a complex type, it will also have children of its
own.  Appropriate language differences are handled for C, C++ and Java.
own.  Appropriate language differences are handled for C, C++ and Java.
   When returning the actual values of the objects, this facility allows
   When returning the actual values of the objects, this facility allows
for the individual selection of the display format used in the result
for the individual selection of the display format used in the result
creation.  It can be chosen among: binary, decimal, hexadecimal, octal
creation.  It can be chosen among: binary, decimal, hexadecimal, octal
and natural.  Natural refers to a default format automatically chosen
and natural.  Natural refers to a default format automatically chosen
based on the variable type (like decimal for an `int', hex for
based on the variable type (like decimal for an `int', hex for
pointers, etc.).
pointers, etc.).
   The following is the complete set of flathead operations defined to
   The following is the complete set of flathead operations defined to
access this functionality:
access this functionality:
*Operation*            *Description*
*Operation*            *Description*
-var-create            create a variable object
-var-create            create a variable object
-var-delete            delete the variable object and its children
-var-delete            delete the variable object and its children
-var-set-format        set the display format of this variable
-var-set-format        set the display format of this variable
-var-show-format       show the display format of this variable
-var-show-format       show the display format of this variable
-var-info-num-children tells how many children this object has
-var-info-num-children tells how many children this object has
-var-list-children     return a list of the object's children
-var-list-children     return a list of the object's children
-var-info-type         show the type of this variable object
-var-info-type         show the type of this variable object
-var-info-expression   print what this variable object represents
-var-info-expression   print what this variable object represents
-var-show-attributes   is this variable editable? does it exist
-var-show-attributes   is this variable editable? does it exist
                       here?
                       here?
-var-evaluate-expressionget the value of this variable
-var-evaluate-expressionget the value of this variable
-var-assign            set the value of this variable
-var-assign            set the value of this variable
-var-update            update the variable and its children
-var-update            update the variable and its children
   In the next subsection we describe each operation in detail and
   In the next subsection we describe each operation in detail and
suggest how it can be used.
suggest how it can be used.
Description And Use of Operations on Variable Objects
Description And Use of Operations on Variable Objects
-----------------------------------------------------
-----------------------------------------------------
The `-var-create' Command
The `-var-create' Command
-------------------------
-------------------------
Synopsis
Synopsis
........
........
      -var-create {NAME | "-"}
      -var-create {NAME | "-"}
         {FRAME-ADDR | "*"} EXPRESSION
         {FRAME-ADDR | "*"} EXPRESSION
   This operation creates a variable object, which allows the
   This operation creates a variable object, which allows the
monitoring of a variable, the result of an expression, a memory cell or
monitoring of a variable, the result of an expression, a memory cell or
a CPU register.
a CPU register.
   The NAME parameter is the string by which the object can be
   The NAME parameter is the string by which the object can be
referenced.  It must be unique.  If `-' is specified, the varobj system
referenced.  It must be unique.  If `-' is specified, the varobj system
will generate a string "varNNNNNN" automatically.  It will be unique
will generate a string "varNNNNNN" automatically.  It will be unique
provided that one does not specify NAME on that format.  The command
provided that one does not specify NAME on that format.  The command
fails if a duplicate name is found.
fails if a duplicate name is found.
   The frame under which the expression should be evaluated can be
   The frame under which the expression should be evaluated can be
specified by FRAME-ADDR.  A `*' indicates that the current frame should
specified by FRAME-ADDR.  A `*' indicates that the current frame should
be used.
be used.
   EXPRESSION is any expression valid on the current language set (must
   EXPRESSION is any expression valid on the current language set (must
not begin with a `*'), or one of the following:
not begin with a `*'), or one of the following:
   * `*ADDR', where ADDR is the address of a memory cell
   * `*ADDR', where ADDR is the address of a memory cell
   * `*ADDR-ADDR' - a memory address range (TBD)
   * `*ADDR-ADDR' - a memory address range (TBD)
   * `$REGNAME' - a CPU register name
   * `$REGNAME' - a CPU register name
Result
Result
......
......
   This operation returns the name, number of children and the type of
   This operation returns the name, number of children and the type of
the object created.  Type is returned as a string as the ones generated
the object created.  Type is returned as a string as the ones generated
by the GDB CLI:
by the GDB CLI:
      name="NAME",numchild="N",type="TYPE"
      name="NAME",numchild="N",type="TYPE"
The `-var-delete' Command
The `-var-delete' Command
-------------------------
-------------------------
Synopsis
Synopsis
........
........
      -var-delete NAME
      -var-delete NAME
   Deletes a previously created variable object and all of its children.
   Deletes a previously created variable object and all of its children.
   Returns an error if the object NAME is not found.
   Returns an error if the object NAME is not found.
The `-var-set-format' Command
The `-var-set-format' Command
-----------------------------
-----------------------------
Synopsis
Synopsis
........
........
      -var-set-format NAME FORMAT-SPEC
      -var-set-format NAME FORMAT-SPEC
   Sets the output format for the value of the object NAME to be
   Sets the output format for the value of the object NAME to be
FORMAT-SPEC.
FORMAT-SPEC.
   The syntax for the FORMAT-SPEC is as follows:
   The syntax for the FORMAT-SPEC is as follows:
      FORMAT-SPEC ==>
      FORMAT-SPEC ==>
      {binary | decimal | hexadecimal | octal | natural}
      {binary | decimal | hexadecimal | octal | natural}
The `-var-show-format' Command
The `-var-show-format' Command
------------------------------
------------------------------
Synopsis
Synopsis
........
........
      -var-show-format NAME
      -var-show-format NAME
   Returns the format used to display the value of the object NAME.
   Returns the format used to display the value of the object NAME.
      format ==>
      format ==>
      FORMAT-SPEC
      FORMAT-SPEC
The `-var-info-num-children' Command
The `-var-info-num-children' Command
------------------------------------
------------------------------------
Synopsis
Synopsis
........
........
      -var-info-num-children NAME
      -var-info-num-children NAME
   Returns the number of children of a variable object NAME:
   Returns the number of children of a variable object NAME:
      numchild=N
      numchild=N
The `-var-list-children' Command
The `-var-list-children' Command
--------------------------------
--------------------------------
Synopsis
Synopsis
........
........
      -var-list-children NAME
      -var-list-children NAME
   Returns a list of the children of the specified variable object:
   Returns a list of the children of the specified variable object:
      numchild=N,children={{name=NAME,
      numchild=N,children={{name=NAME,
      numchild=N,type=TYPE},(repeats N times)}
      numchild=N,type=TYPE},(repeats N times)}
The `-var-info-type' Command
The `-var-info-type' Command
----------------------------
----------------------------
Synopsis
Synopsis
........
........
      -var-info-type NAME
      -var-info-type NAME
   Returns the type of the specified variable NAME.  The type is
   Returns the type of the specified variable NAME.  The type is
returned as a string in the same format as it is output by the GDB CLI:
returned as a string in the same format as it is output by the GDB CLI:
      type=TYPENAME
      type=TYPENAME
The `-var-info-expression' Command
The `-var-info-expression' Command
----------------------------------
----------------------------------
Synopsis
Synopsis
........
........
      -var-info-expression NAME
      -var-info-expression NAME
   Returns what is represented by the variable object NAME:
   Returns what is represented by the variable object NAME:
      lang=LANG-SPEC,exp=EXPRESSION
      lang=LANG-SPEC,exp=EXPRESSION
where LANG-SPEC is `{"C" | "C++" | "Java"}'.
where LANG-SPEC is `{"C" | "C++" | "Java"}'.
The `-var-show-attributes' Command
The `-var-show-attributes' Command
----------------------------------
----------------------------------
Synopsis
Synopsis
........
........
      -var-show-attributes NAME
      -var-show-attributes NAME
   List attributes of the specified variable object NAME:
   List attributes of the specified variable object NAME:
      status=ATTR [ ( ,ATTR )* ]
      status=ATTR [ ( ,ATTR )* ]
where ATTR is `{ { editable | noneditable } | TBD }'.
where ATTR is `{ { editable | noneditable } | TBD }'.
The `-var-evaluate-expression' Command
The `-var-evaluate-expression' Command
--------------------------------------
--------------------------------------
Synopsis
Synopsis
........
........
      -var-evaluate-expression NAME
      -var-evaluate-expression NAME
   Evaluates the expression that is represented by the specified
   Evaluates the expression that is represented by the specified
variable object and returns its value as a string in the current format
variable object and returns its value as a string in the current format
specified for the object:
specified for the object:
      value=VALUE
      value=VALUE
The `-var-assign' Command
The `-var-assign' Command
-------------------------
-------------------------
Synopsis
Synopsis
........
........
      -var-assign NAME EXPRESSION
      -var-assign NAME EXPRESSION
   Assigns the value of EXPRESSION to the variable object specified by
   Assigns the value of EXPRESSION to the variable object specified by
NAME.  The object must be "editable".
NAME.  The object must be "editable".
The `-var-update' Command
The `-var-update' Command
-------------------------
-------------------------
Synopsis
Synopsis
........
........
      -var-update {NAME | "*"}
      -var-update {NAME | "*"}
   Update the value of the variable object NAME by evaluating its
   Update the value of the variable object NAME by evaluating its
expression after fetching all the new values from memory or registers.
expression after fetching all the new values from memory or registers.
A `*' causes all existing variable objects to be updated.
A `*' causes all existing variable objects to be updated.


File: gdb.info,  Node: GDB/MI Draft Changes to Output Syntax,  Prev: GDB/MI Variable Objects,  Up: GDB/MI
File: gdb.info,  Node: GDB/MI Draft Changes to Output Syntax,  Prev: GDB/MI Variable Objects,  Up: GDB/MI
GDB/MI Draft Changes to Output Syntax
GDB/MI Draft Changes to Output Syntax
=====================================
=====================================
   One problem identified in the existing GDB/MI output syntax was the
   One problem identified in the existing GDB/MI output syntax was the
difficulty in differentiating between a tuple such as:
difficulty in differentiating between a tuple such as:
     {number="1",type="breakpoint",disp="keep",enabled="y"}
     {number="1",type="breakpoint",disp="keep",enabled="y"}
   where each value has a unique label, and a list such as:
   where each value has a unique label, and a list such as:
     {"1","2","4"}
     {"1","2","4"}
     {bp="1",bp="2",bp="4"}
     {bp="1",bp="2",bp="4"}
   where values are un-labeled or the label is duplicated.
   where values are un-labeled or the label is duplicated.
   What follows is a draft revision to the output specification that
   What follows is a draft revision to the output specification that
addresses this problem.
addresses this problem.
   The output from GDB/MI consists of zero or more out-of-band records
   The output from GDB/MI consists of zero or more out-of-band records
optionally followed by a single result record, the result record being
optionally followed by a single result record, the result record being
for the most recent command input.  The sequence is terminated by
for the most recent command input.  The sequence is terminated by
"(gdb)".
"(gdb)".
   Asynchronous GDB/MI output is similar.
   Asynchronous GDB/MI output is similar.
   Each output record directly associated with an input command is
   Each output record directly associated with an input command is
prefixed by the input commands `TOKEN'.
prefixed by the input commands `TOKEN'.
`OUTPUT ==>'
`OUTPUT ==>'
     { OUT-OF-BAND-RECORD } `[' RESULT-RECORD `]' "(gdb)" NL
     { OUT-OF-BAND-RECORD } `[' RESULT-RECORD `]' "(gdb)" NL
`RESULT-RECORD ==>'
`RESULT-RECORD ==>'
     `[' TOKEN `]' "^" RESULT-CLASS { "," RESULT } NL
     `[' TOKEN `]' "^" RESULT-CLASS { "," RESULT } NL
`OUT-OF-BAND-RECORD ==>'
`OUT-OF-BAND-RECORD ==>'
     ASYNC-RECORD `|' STREAM-RECORD
     ASYNC-RECORD `|' STREAM-RECORD
`ASYNC-RECORD ==>'
`ASYNC-RECORD ==>'
     EXEC-ASYNC-OUTPUT `|' STATUS-ASYNC-OUTPUT `|' NOTIFY-ASYNC-OUTPUT
     EXEC-ASYNC-OUTPUT `|' STATUS-ASYNC-OUTPUT `|' NOTIFY-ASYNC-OUTPUT
`EXEC-ASYNC-OUTPUT ==>'
`EXEC-ASYNC-OUTPUT ==>'
     `[' TOKEN `]' "*" ASYNC-OUTPUT
     `[' TOKEN `]' "*" ASYNC-OUTPUT
`STATUS-ASYNC-OUTPUT ==>'
`STATUS-ASYNC-OUTPUT ==>'
     `[' TOKEN `]' "+" ASYNC-OUTPUT
     `[' TOKEN `]' "+" ASYNC-OUTPUT
`NOTIFY-ASYNC-OUTPUT ==>'
`NOTIFY-ASYNC-OUTPUT ==>'
     `[' TOKEN `]' "=" ASYNC-OUTPUT
     `[' TOKEN `]' "=" ASYNC-OUTPUT
`ASYNC-OUTPUT ==>'
`ASYNC-OUTPUT ==>'
     ASYNC-CLASS { "," RESULT } NL
     ASYNC-CLASS { "," RESULT } NL
`RESULT-CLASS ==>'
`RESULT-CLASS ==>'
     "done" `|' "running" `|' "connected" `|' "error" `|' "exit"
     "done" `|' "running" `|' "connected" `|' "error" `|' "exit"
`ASYNC-CLASS ==>'
`ASYNC-CLASS ==>'
     "stopped" `|' _others depending on need as still in development_
     "stopped" `|' _others depending on need as still in development_
`RESULT ==>'
`RESULT ==>'
     STRING "=" VALUE
     STRING "=" VALUE
`VALUE ==>'
`VALUE ==>'
     C-STRING `|' TUPPLE `|' LIST
     C-STRING `|' TUPPLE `|' LIST
`TUPPLE ==>'
`TUPPLE ==>'
     "{}" `|' "{" RESULT { "," RESULT } "}"
     "{}" `|' "{" RESULT { "," RESULT } "}"
`LIST ==>'
`LIST ==>'
     "`[]'" `|' "`['" VALUE { "," VALUE } "`]'"
     "`[]'" `|' "`['" VALUE { "," VALUE } "`]'"
`STRING ==>'
`STRING ==>'
     _[-A-Za-z\.0-9_]*_
     _[-A-Za-z\.0-9_]*_
`C-STRING ==>'
`C-STRING ==>'
     _See the input specification_
     _See the input specification_
`STREAM-RECORD ==>'
`STREAM-RECORD ==>'
     CONSOLE-STREAM-OUTPUT `|' TARGET-STREAM-OUTPUT `|'
     CONSOLE-STREAM-OUTPUT `|' TARGET-STREAM-OUTPUT `|'
     LOG-STREAM-OUTPUT
     LOG-STREAM-OUTPUT
`CONSOLE-STREAM-OUTPUT ==>'
`CONSOLE-STREAM-OUTPUT ==>'
     "~" C-STRING
     "~" C-STRING
`TARGET-STREAM-OUTPUT ==>'
`TARGET-STREAM-OUTPUT ==>'
     "@" C-STRING
     "@" C-STRING
`LOG-STREAM-OUTPUT ==>'
`LOG-STREAM-OUTPUT ==>'
     "&" C-STRING
     "&" C-STRING
`NL ==>'
`NL ==>'
     CR `|' CR-LF
     CR `|' CR-LF
`TOKEN ==>'
`TOKEN ==>'
     "any sequence of digits"
     "any sequence of digits"
   In addition, the following are still being developed.
   In addition, the following are still being developed.
`QUERY'
`QUERY'
     This action is currently undefined.
     This action is currently undefined.
   Notes:
   Notes:
   * All output sequences end in a single line containing a period.
   * All output sequences end in a single line containing a period.
   * The `TOKEN' is from the corresponding request.  If an execution
   * The `TOKEN' is from the corresponding request.  If an execution
     command is interrupted by the -exec-interrupt command, the token
     command is interrupted by the -exec-interrupt command, the token
     associated with the `*stopped' message is the one of the original
     associated with the `*stopped' message is the one of the original
     execution command, not the one of the interrupt-command.
     execution command, not the one of the interrupt-command.
   * STATUS-ASYNC-OUTPUT contains on-going status information about the
   * STATUS-ASYNC-OUTPUT contains on-going status information about the
     progress of a slow operation.  It can be discarded. All status
     progress of a slow operation.  It can be discarded. All status
     output is prefixed by the prefix `+'.
     output is prefixed by the prefix `+'.
   * EXEC-ASYNC-OUTPUT contains asynchronous state change on the target
   * EXEC-ASYNC-OUTPUT contains asynchronous state change on the target
     (stopped, started, disappeared). All async output is prefixed by
     (stopped, started, disappeared). All async output is prefixed by
     the prefix `*'.
     the prefix `*'.
   * NOTIFY-ASYNC-OUTPUT contains supplementary information that the
   * NOTIFY-ASYNC-OUTPUT contains supplementary information that the
     client should handle (new breakpoint information). All notify
     client should handle (new breakpoint information). All notify
     output is prefixed by the prefix `='.
     output is prefixed by the prefix `='.
   * CONSOLE-STREAM-OUTPUT is output that should be displayed as is, in
   * CONSOLE-STREAM-OUTPUT is output that should be displayed as is, in
     the console.  It is the textual response to a CLI command. All the
     the console.  It is the textual response to a CLI command. All the
     console output is prefixed by the prefix "~".
     console output is prefixed by the prefix "~".
   * TARGET-STREAM-OUTPUT is the output produced by the target program.
   * TARGET-STREAM-OUTPUT is the output produced by the target program.
     All the target output is prefixed by the prefix "@".
     All the target output is prefixed by the prefix "@".
   * LOG-STREAM-OUTPUT is output text coming from GDB's internals, for
   * LOG-STREAM-OUTPUT is output text coming from GDB's internals, for
     instance messages that should be displayed as part of an error
     instance messages that should be displayed as part of an error
     log.  All the log output is prefixed by the prefix "&".
     log.  All the log output is prefixed by the prefix "&".


File: gdb.info,  Node: GDB Bugs,  Next: Formatting Documentation,  Prev: GDB/MI,  Up: Top
File: gdb.info,  Node: GDB Bugs,  Next: Formatting Documentation,  Prev: GDB/MI,  Up: Top
Reporting Bugs in GDB
Reporting Bugs in GDB
*********************
*********************
   Your bug reports play an essential role in making GDB reliable.
   Your bug reports play an essential role in making GDB reliable.
   Reporting a bug may help you by bringing a solution to your problem,
   Reporting a bug may help you by bringing a solution to your problem,
or it may not.  But in any case the principal function of a bug report
or it may not.  But in any case the principal function of a bug report
is to help the entire community by making the next version of GDB work
is to help the entire community by making the next version of GDB work
better.  Bug reports are your contribution to the maintenance of GDB.
better.  Bug reports are your contribution to the maintenance of GDB.
   In order for a bug report to serve its purpose, you must include the
   In order for a bug report to serve its purpose, you must include the
information that enables us to fix the bug.
information that enables us to fix the bug.
* Menu:
* Menu:
* Bug Criteria::                Have you found a bug?
* Bug Criteria::                Have you found a bug?
* Bug Reporting::               How to report bugs
* Bug Reporting::               How to report bugs


File: gdb.info,  Node: Bug Criteria,  Next: Bug Reporting,  Up: GDB Bugs
File: gdb.info,  Node: Bug Criteria,  Next: Bug Reporting,  Up: GDB Bugs
Have you found a bug?
Have you found a bug?
=====================
=====================
   If you are not sure whether you have found a bug, here are some
   If you are not sure whether you have found a bug, here are some
guidelines:
guidelines:
   * If the debugger gets a fatal signal, for any input whatever, that
   * If the debugger gets a fatal signal, for any input whatever, that
     is a GDB bug.  Reliable debuggers never crash.
     is a GDB bug.  Reliable debuggers never crash.
   * If GDB produces an error message for valid input, that is a bug.
   * If GDB produces an error message for valid input, that is a bug.
     (Note that if you're cross debugging, the problem may also be
     (Note that if you're cross debugging, the problem may also be
     somewhere in the connection to the target.)
     somewhere in the connection to the target.)
   * If GDB does not produce an error message for invalid input, that
   * If GDB does not produce an error message for invalid input, that
     is a bug.  However, you should note that your idea of "invalid
     is a bug.  However, you should note that your idea of "invalid
     input" might be our idea of "an extension" or "support for
     input" might be our idea of "an extension" or "support for
     traditional practice".
     traditional practice".
   * If you are an experienced user of debugging tools, your suggestions
   * If you are an experienced user of debugging tools, your suggestions
     for improvement of GDB are welcome in any case.
     for improvement of GDB are welcome in any case.


File: gdb.info,  Node: Bug Reporting,  Prev: Bug Criteria,  Up: GDB Bugs
File: gdb.info,  Node: Bug Reporting,  Prev: Bug Criteria,  Up: GDB Bugs
How to report bugs
How to report bugs
==================
==================
   A number of companies and individuals offer support for GNU products.
   A number of companies and individuals offer support for GNU products.
If you obtained GDB from a support organization, we recommend you
If you obtained GDB from a support organization, we recommend you
contact that organization first.
contact that organization first.
   You can find contact information for many support companies and
   You can find contact information for many support companies and
individuals in the file `etc/SERVICE' in the GNU Emacs distribution.
individuals in the file `etc/SERVICE' in the GNU Emacs distribution.
   In any event, we also recommend that you send bug reports for GDB to
   In any event, we also recommend that you send bug reports for GDB to
this addresses:
this addresses:
     bug-gdb@gnu.org
     bug-gdb@gnu.org
   *Do not send bug reports to `info-gdb', or to `help-gdb', or to any
   *Do not send bug reports to `info-gdb', or to `help-gdb', or to any
newsgroups.*  Most users of GDB do not want to receive bug reports.
newsgroups.*  Most users of GDB do not want to receive bug reports.
Those that do have arranged to receive `bug-gdb'.
Those that do have arranged to receive `bug-gdb'.
   The mailing list `bug-gdb' has a newsgroup `gnu.gdb.bug' which
   The mailing list `bug-gdb' has a newsgroup `gnu.gdb.bug' which
serves as a repeater.  The mailing list and the newsgroup carry exactly
serves as a repeater.  The mailing list and the newsgroup carry exactly
the same messages.  Often people think of posting bug reports to the
the same messages.  Often people think of posting bug reports to the
newsgroup instead of mailing them.  This appears to work, but it has one
newsgroup instead of mailing them.  This appears to work, but it has one
problem which can be crucial: a newsgroup posting often lacks a mail
problem which can be crucial: a newsgroup posting often lacks a mail
path back to the sender.  Thus, if we need to ask for more information,
path back to the sender.  Thus, if we need to ask for more information,
we may be unable to reach you.  For this reason, it is better to send
we may be unable to reach you.  For this reason, it is better to send
bug reports to the mailing list.
bug reports to the mailing list.
   As a last resort, send bug reports on paper to:
   As a last resort, send bug reports on paper to:
     GNU Debugger Bugs
     GNU Debugger Bugs
     Free Software Foundation Inc.
     Free Software Foundation Inc.
     59 Temple Place - Suite 330
     59 Temple Place - Suite 330
     Boston, MA 02111-1307
     Boston, MA 02111-1307
     USA
     USA
   The fundamental principle of reporting bugs usefully is this:
   The fundamental principle of reporting bugs usefully is this:
*report all the facts*.  If you are not sure whether to state a fact or
*report all the facts*.  If you are not sure whether to state a fact or
leave it out, state it!
leave it out, state it!
   Often people omit facts because they think they know what causes the
   Often people omit facts because they think they know what causes the
problem and assume that some details do not matter.  Thus, you might
problem and assume that some details do not matter.  Thus, you might
assume that the name of the variable you use in an example does not
assume that the name of the variable you use in an example does not
matter.  Well, probably it does not, but one cannot be sure.  Perhaps
matter.  Well, probably it does not, but one cannot be sure.  Perhaps
the bug is a stray memory reference which happens to fetch from the
the bug is a stray memory reference which happens to fetch from the
location where that name is stored in memory; perhaps, if the name were
location where that name is stored in memory; perhaps, if the name were
different, the contents of that location would fool the debugger into
different, the contents of that location would fool the debugger into
doing the right thing despite the bug.  Play it safe and give a
doing the right thing despite the bug.  Play it safe and give a
specific, complete example.  That is the easiest thing for you to do,
specific, complete example.  That is the easiest thing for you to do,
and the most helpful.
and the most helpful.
   Keep in mind that the purpose of a bug report is to enable us to fix
   Keep in mind that the purpose of a bug report is to enable us to fix
the bug.  It may be that the bug has been reported previously, but
the bug.  It may be that the bug has been reported previously, but
neither you nor we can know that unless your bug report is complete and
neither you nor we can know that unless your bug report is complete and
self-contained.
self-contained.
   Sometimes people give a few sketchy facts and ask, "Does this ring a
   Sometimes people give a few sketchy facts and ask, "Does this ring a
bell?"  Those bug reports are useless, and we urge everyone to _refuse
bell?"  Those bug reports are useless, and we urge everyone to _refuse
to respond to them_ except to chide the sender to report bugs properly.
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:
   To enable us to fix the bug, you should include all these things:
   * The version of GDB.  GDB announces it if you start with no
   * The version of GDB.  GDB announces it if you start with no
     arguments; you can also print it at any time using `show version'.
     arguments; you can also print it at any time using `show version'.
     Without this, we will not know whether there is any point in
     Without this, we will not know whether there is any point in
     looking for the bug in the current version of GDB.
     looking for the bug in the current version of GDB.
   * The type of machine you are using, and the operating system name
   * The type of machine you are using, and the operating system name
     and version number.
     and version number.
   * What compiler (and its version) was used to compile GDB--e.g.
   * What compiler (and its version) was used to compile GDB--e.g.
     "gcc-2.8.1".
     "gcc-2.8.1".
   * What compiler (and its version) was used to compile the program
   * What compiler (and its version) was used to compile the program
     you are debugging--e.g.  "gcc-2.8.1", or "HP92453-01 A.10.32.03 HP
     you are debugging--e.g.  "gcc-2.8.1", or "HP92453-01 A.10.32.03 HP
     C Compiler".  For GCC, you can say `gcc --version' to get this
     C Compiler".  For GCC, you can say `gcc --version' to get this
     information; for other compilers, see the documentation for those
     information; for other compilers, see the documentation for those
     compilers.
     compilers.
   * The command arguments you gave the compiler to compile your
   * The command arguments you gave the compiler to compile your
     example and observe the bug.  For example, did you use `-O'?  To
     example and observe the bug.  For example, did you use `-O'?  To
     guarantee you will not omit something important, list them all.  A
     guarantee you will not omit something important, list them all.  A
     copy of the Makefile (or the output from make) is sufficient.
     copy of the Makefile (or the output from make) is sufficient.
     If we were to try to guess the arguments, we would probably guess
     If we were to try to guess the arguments, we would probably guess
     wrong and then we might not encounter the bug.
     wrong and then we might not encounter the bug.
   * A complete input script, and all necessary source files, that will
   * A complete input script, and all necessary source files, that will
     reproduce the bug.
     reproduce the bug.
   * A description of what behavior you observe that you believe is
   * A description of what behavior you observe that you believe is
     incorrect.  For example, "It gets a fatal signal."
     incorrect.  For example, "It gets a fatal signal."
     Of course, if the bug is that GDB gets a fatal signal, then we
     Of course, if the bug is that GDB gets a fatal signal, then we
     will certainly notice it.  But if the bug is incorrect output, we
     will certainly notice it.  But if the bug is incorrect output, we
     might not notice unless it is glaringly wrong.  You might as well
     might not notice unless it is glaringly wrong.  You might as well
     not give us a chance to make a mistake.
     not give us a chance to make a mistake.
     Even if the problem you experience is a fatal signal, you should
     Even if the problem you experience is a fatal signal, you should
     still say so explicitly.  Suppose something strange is going on,
     still say so explicitly.  Suppose something strange is going on,
     such as, your copy of GDB is out of synch, or you have encountered
     such as, your copy of GDB is out of synch, or you have encountered
     a bug in the C library on your system.  (This has happened!)  Your
     a bug in the C library on your system.  (This has happened!)  Your
     copy might crash and ours would not.  If you told us to expect a
     copy might crash and ours would not.  If you told us to expect a
     crash, then when ours fails to crash, we would know that the bug
     crash, then when ours fails to crash, we would know that the bug
     was not happening for us.  If you had not told us to expect a
     was not happening for us.  If you had not told us to expect a
     crash, then we would not be able to draw any conclusion from our
     crash, then we would not be able to draw any conclusion from our
     observations.
     observations.
   * If you wish to suggest changes to the GDB source, send us context
   * If you wish to suggest changes to the GDB source, send us context
     diffs.  If you even discuss something in the GDB source, refer to
     diffs.  If you even discuss something in the GDB source, refer to
     it by context, not by line number.
     it by context, not by line number.
     The line numbers in our development sources will not match those
     The line numbers in our development sources will not match those
     in your sources.  Your line numbers would convey no useful
     in your sources.  Your line numbers would convey no useful
     information to us.
     information to us.
   Here are some things that are not necessary:
   Here are some things that are not necessary:
   * A description of the envelope of the bug.
   * A description of the envelope of the bug.
     Often people who encounter a bug spend a lot of time investigating
     Often people who encounter a bug spend a lot of time investigating
     which changes to the input file will make the bug go away and which
     which changes to the input file will make the bug go away and which
     changes will not affect it.
     changes will not affect it.
     This is often time consuming and not very useful, because the way
     This is often time consuming and not very useful, because the way
     we will find the bug is by running a single example under the
     we will find the bug is by running a single example under the
     debugger with breakpoints, not by pure deduction from a series of
     debugger with breakpoints, not by pure deduction from a series of
     examples.  We recommend that you save your time for something else.
     examples.  We recommend that you save your time for something else.
     Of course, if you can find a simpler example to report _instead_
     Of course, if you can find a simpler example to report _instead_
     of the original one, that is a convenience for us.  Errors in the
     of the original one, that is a convenience for us.  Errors in the
     output will be easier to spot, running under the debugger will take
     output will be easier to spot, running under the debugger will take
     less time, and so on.
     less time, and so on.
     However, simplification is not vital; if you do not want to do
     However, simplification is not vital; if you do not want to do
     this, report the bug anyway and send us the entire test case you
     this, report the bug anyway and send us the entire test case you
     used.
     used.
   * A patch for the bug.
   * A patch for the bug.
     A patch for the bug does help us if it is a good one.  But do not
     A patch for the bug does help us if it is a good one.  But do not
     omit the necessary information, such as the test case, on the
     omit the necessary information, such as the test case, on the
     assumption that a patch is all we need.  We might see problems
     assumption that a patch is all we need.  We might see problems
     with your patch and decide to fix the problem another way, or we
     with your patch and decide to fix the problem another way, or we
     might not understand it at all.
     might not understand it at all.
     Sometimes with a program as complicated as GDB it is very hard to
     Sometimes with a program as complicated as GDB it is very hard to
     construct an example that will make the program follow a certain
     construct an example that will make the program follow a certain
     path through the code.  If you do not send us the example, we will
     path through the code.  If you do not send us the example, we will
     not be able to construct one, so we will not be able to verify
     not be able to construct one, so we will not be able to verify
     that the bug is fixed.
     that the bug is fixed.
     And if we cannot understand what bug you are trying to fix, or why
     And if we cannot understand what bug you are trying to fix, or why
     your patch should be an improvement, we will not install it.  A
     your patch should be an improvement, we will not install it.  A
     test case will help us to understand.
     test case will help us to understand.
   * A guess about what the bug is or what it depends on.
   * A guess about what the bug is or what it depends on.
     Such guesses are usually wrong.  Even we cannot guess right about
     Such guesses are usually wrong.  Even we cannot guess right about
     such things without first using the debugger to find the facts.
     such things without first using the debugger to find the facts.


File: gdb.info,  Node: Command Line Editing,  Next: Using History Interactively,  Prev: Formatting Documentation,  Up: Top
File: gdb.info,  Node: Command Line Editing,  Next: Using History Interactively,  Prev: Formatting Documentation,  Up: Top
Command Line Editing
Command Line Editing
********************
********************
   This chapter describes the basic features of the GNU command line
   This chapter describes the basic features of the GNU command line
editing interface.
editing interface.
* Menu:
* Menu:
* Introduction and Notation::   Notation used in this text.
* Introduction and Notation::   Notation used in this text.
* Readline Interaction::        The minimum set of commands for editing a line.
* Readline Interaction::        The minimum set of commands for editing a line.
* Readline Init File::          Customizing Readline from a user's view.
* Readline Init File::          Customizing Readline from a user's view.
* Bindable Readline Commands::  A description of most of the Readline commands
* Bindable Readline Commands::  A description of most of the Readline commands
                                available for binding
                                available for binding
* Readline vi Mode::            A short description of how to make Readline
* Readline vi Mode::            A short description of how to make Readline
                                behave like the vi editor.
                                behave like the vi editor.


File: gdb.info,  Node: Introduction and Notation,  Next: Readline Interaction,  Up: Command Line Editing
File: gdb.info,  Node: Introduction and Notation,  Next: Readline Interaction,  Up: Command Line Editing
Introduction to Line Editing
Introduction to Line Editing
============================
============================
   The following paragraphs describe the notation used to represent
   The following paragraphs describe the notation used to represent
keystrokes.
keystrokes.
   The text  is read as `Control-K' and describes the character
   The text  is read as `Control-K' and describes the character
produced when the  key is pressed while the Control key is depressed.
produced when the  key is pressed while the Control key is depressed.
   The text  is read as `Meta-K' and describes the character
   The text  is read as `Meta-K' and describes the character
produced when the meta key (if you have one) is depressed, and the 
produced when the meta key (if you have one) is depressed, and the 
key is pressed.  If you do not have a meta key, the identical keystroke
key is pressed.  If you do not have a meta key, the identical keystroke
can be generated by typing  first, and then typing .  Either
can be generated by typing  first, and then typing .  Either
process is known as "metafying" the  key.
process is known as "metafying" the  key.
   The text  is read as `Meta-Control-k' and describes the
   The text  is read as `Meta-Control-k' and describes the
character produced by "metafying" .
character produced by "metafying" .
   In addition, several keys have their own names.  Specifically,
   In addition, several keys have their own names.  Specifically,
, , , , , and  all stand for themselves
, , , , , and  all stand for themselves
when seen in this text, or in an init file (*note Readline Init File::).
when seen in this text, or in an init file (*note Readline Init File::).


File: gdb.info,  Node: Readline Interaction,  Next: Readline Init File,  Prev: Introduction and Notation,  Up: Command Line Editing
File: gdb.info,  Node: Readline Interaction,  Next: Readline Init File,  Prev: Introduction and Notation,  Up: Command Line Editing
Readline Interaction
Readline Interaction
====================
====================
   Often during an interactive session you type in a long line of text,
   Often during an interactive session you type in a long line of text,
only to notice that the first word on the line is misspelled.  The
only to notice that the first word on the line is misspelled.  The
Readline library gives you a set of commands for manipulating the text
Readline library gives you a set of commands for manipulating the text
as you type it in, allowing you to just fix your typo, and not forcing
as you type it in, allowing you to just fix your typo, and not forcing
you to retype the majority of the line.  Using these editing commands,
you to retype the majority of the line.  Using these editing commands,
you move the cursor to the place that needs correction, and delete or
you move the cursor to the place that needs correction, and delete or
insert the text of the corrections.  Then, when you are satisfied with
insert the text of the corrections.  Then, when you are satisfied with
the line, you simply press .  You do not have to be at the end
the line, you simply press .  You do not have to be at the end
of the line to press ; the entire line is accepted regardless
of the line to press ; the entire line is accepted regardless
of the location of the cursor within the line.
of the location of the cursor within the line.
* Menu:
* Menu:
* Readline Bare Essentials::    The least you need to know about Readline.
* Readline Bare Essentials::    The least you need to know about Readline.
* Readline Movement Commands::  Moving about the input line.
* Readline Movement Commands::  Moving about the input line.
* Readline Killing Commands::   How to delete text, and how to get it back!
* Readline Killing Commands::   How to delete text, and how to get it back!
* Readline Arguments::          Giving numeric arguments to commands.
* Readline Arguments::          Giving numeric arguments to commands.
* Searching::                   Searching through previous lines.
* Searching::                   Searching through previous lines.


File: gdb.info,  Node: Readline Bare Essentials,  Next: Readline Movement Commands,  Up: Readline Interaction
File: gdb.info,  Node: Readline Bare Essentials,  Next: Readline Movement Commands,  Up: Readline Interaction
Readline Bare Essentials
Readline Bare Essentials
------------------------
------------------------
   In order to enter characters into the line, simply type them.  The
   In order to enter characters into the line, simply type them.  The
typed character appears where the cursor was, and then the cursor moves
typed character appears where the cursor was, and then the cursor moves
one space to the right.  If you mistype a character, you can use your
one space to the right.  If you mistype a character, you can use your
erase character to back up and delete the mistyped character.
erase character to back up and delete the mistyped character.
   Sometimes you may miss typing a character that you wanted to type,
   Sometimes you may miss typing a character that you wanted to type,
and not notice your error until you have typed several other
and not notice your error until you have typed several other
characters.  In that case, you can type  to move the cursor to the
characters.  In that case, you can type  to move the cursor to the
left, and then correct your mistake.  Afterwards, you can move the
left, and then correct your mistake.  Afterwards, you can move the
cursor to the right with .
cursor to the right with .
   When you add text in the middle of a line, you will notice that
   When you add text in the middle of a line, you will notice that
characters to the right of the cursor are `pushed over' to make room
characters to the right of the cursor are `pushed over' to make room
for the text that you have inserted.  Likewise, when you delete text
for the text that you have inserted.  Likewise, when you delete text
behind the cursor, characters to the right of the cursor are `pulled
behind the cursor, characters to the right of the cursor are `pulled
back' to fill in the blank space created by the removal of the text.  A
back' to fill in the blank space created by the removal of the text.  A
list of the basic bare essentials for editing the text of an input line
list of the basic bare essentials for editing the text of an input line
follows.
follows.
     Move back one character.
     Move back one character.
     Move forward one character.
     Move forward one character.
     Delete the character to the left of the cursor.
     Delete the character to the left of the cursor.
     Delete the character underneath the cursor.
     Delete the character underneath the cursor.
Printing characters
Printing characters
     Insert the character into the line at the cursor.
     Insert the character into the line at the cursor.
     Undo the last editing command.  You can undo all the way back to an
     Undo the last editing command.  You can undo all the way back to an
     empty line.
     empty line.


File: gdb.info,  Node: Readline Movement Commands,  Next: Readline Killing Commands,  Prev: Readline Bare Essentials,  Up: Readline Interaction
File: gdb.info,  Node: Readline Movement Commands,  Next: Readline Killing Commands,  Prev: Readline Bare Essentials,  Up: Readline Interaction
Readline Movement Commands
Readline Movement Commands
--------------------------
--------------------------
   The above table describes the most basic possible keystrokes that
   The above table describes the most basic possible keystrokes that
you need in order to do editing of the input line.  For your
you need in order to do editing of the input line.  For your
convenience, many other commands have been added in addition to ,
convenience, many other commands have been added in addition to ,
, , and .  Here are some commands for moving more rapidly
, , and .  Here are some commands for moving more rapidly
about the line.
about the line.
     Move to the start of the line.
     Move to the start of the line.
     Move to the end of the line.
     Move to the end of the line.
     Move forward a word, where a word is composed of letters and
     Move forward a word, where a word is composed of letters and
     digits.
     digits.
     Move backward a word.
     Move backward a word.
     Clear the screen, reprinting the current line at the top.
     Clear the screen, reprinting the current line at the top.
   Notice how  moves forward a character, while  moves
   Notice how  moves forward a character, while  moves
forward a word.  It is a loose convention that control keystrokes
forward a word.  It is a loose convention that control keystrokes
operate on characters while meta keystrokes operate on words.
operate on characters while meta keystrokes operate on words.


File: gdb.info,  Node: Readline Killing Commands,  Next: Readline Arguments,  Prev: Readline Movement Commands,  Up: Readline Interaction
File: gdb.info,  Node: Readline Killing Commands,  Next: Readline Arguments,  Prev: Readline Movement Commands,  Up: Readline Interaction
Readline Killing Commands
Readline Killing Commands
-------------------------
-------------------------
   "Killing" text means to delete the text from the line, but to save
   "Killing" text means to delete the text from the line, but to save
it away for later use, usually by "yanking" (re-inserting) it back into
it away for later use, usually by "yanking" (re-inserting) it back into
the line.  If the description for a command says that it `kills' text,
the line.  If the description for a command says that it `kills' text,
then you can be sure that you can get the text back in a different (or
then you can be sure that you can get the text back in a different (or
the same) place later.
the same) place later.
   When you use a kill command, the text is saved in a "kill-ring".
   When you use a kill command, the text is saved in a "kill-ring".
Any number of consecutive kills save all of the killed text together, so
Any number of consecutive kills save all of the killed text together, so
that when you yank it back, you get it all.  The kill ring is not line
that when you yank it back, you get it all.  The kill ring is not line
specific; the text that you killed on a previously typed line is
specific; the text that you killed on a previously typed line is
available to be yanked back later, when you are typing another line.
available to be yanked back later, when you are typing another line.
   Here is the list of commands for killing text.
   Here is the list of commands for killing text.
     Kill the text from the current cursor position to the end of the
     Kill the text from the current cursor position to the end of the
     line.
     line.
     Kill from the cursor to the end of the current word, or if between
     Kill from the cursor to the end of the current word, or if between
     words, to the end of the next word.
     words, to the end of the next word.
     Kill from the cursor the start of the previous word, or if between
     Kill from the cursor the start of the previous word, or if between
     words, to the start of the previous word.
     words, to the start of the previous word.
     Kill from the cursor to the previous whitespace.  This is
     Kill from the cursor to the previous whitespace.  This is
     different than  because the word boundaries differ.
     different than  because the word boundaries differ.
   Here is how to "yank" the text back into the line.  Yanking means to
   Here is how to "yank" the text back into the line.  Yanking means to
copy the most-recently-killed text from the kill buffer.
copy the most-recently-killed text from the kill buffer.
     Yank the most recently killed text back into the buffer at the
     Yank the most recently killed text back into the buffer at the
     cursor.
     cursor.
     Rotate the kill-ring, and yank the new top.  You can only do this
     Rotate the kill-ring, and yank the new top.  You can only do this
     if the prior command is  or .
     if the prior command is  or .


File: gdb.info,  Node: Readline Arguments,  Next: Searching,  Prev: Readline Killing Commands,  Up: Readline Interaction
File: gdb.info,  Node: Readline Arguments,  Next: Searching,  Prev: Readline Killing Commands,  Up: Readline Interaction
Readline Arguments
Readline Arguments
------------------
------------------
   You can pass numeric arguments to Readline commands.  Sometimes the
   You can pass numeric arguments to Readline commands.  Sometimes the
argument acts as a repeat count, other times it is the sign of the
argument acts as a repeat count, other times it is the sign of the
argument that is significant.  If you pass a negative argument to a
argument that is significant.  If you pass a negative argument to a
command which normally acts in a forward direction, that command will
command which normally acts in a forward direction, that command will
act in a backward direction.  For example, to kill text back to the
act in a backward direction.  For example, to kill text back to the
start of the line, you might type `M-- C-k'.
start of the line, you might type `M-- C-k'.
   The general way to pass numeric arguments to a command is to type
   The general way to pass numeric arguments to a command is to type
meta digits before the command.  If the first `digit' typed is a minus
meta digits before the command.  If the first `digit' typed is a minus
sign (<->), then the sign of the argument will be negative.  Once you
sign (<->), then the sign of the argument will be negative.  Once you
have typed one meta digit to get the argument started, you can type the
have typed one meta digit to get the argument started, you can type the
remainder of the digits, and then the command.  For example, to give
remainder of the digits, and then the command.  For example, to give
the  command an argument of 10, you could type `M-1 0 C-d'.
the  command an argument of 10, you could type `M-1 0 C-d'.


File: gdb.info,  Node: Searching,  Prev: Readline Arguments,  Up: Readline Interaction
File: gdb.info,  Node: Searching,  Prev: Readline Arguments,  Up: Readline Interaction
Searching for Commands in the History
Searching for Commands in the History
-------------------------------------
-------------------------------------
   Readline provides commands for searching through the command history
   Readline provides commands for searching through the command history
for lines containing a specified string.  There are two search modes:
for lines containing a specified string.  There are two search modes:
INCREMENTAL and NON-INCREMENTAL.
INCREMENTAL and NON-INCREMENTAL.
   Incremental searches begin before the user has finished typing the
   Incremental searches begin before the user has finished typing the
search string.  As each character of the search string is typed,
search string.  As each character of the search string is typed,
Readline displays the next entry from the history matching the string
Readline displays the next entry from the history matching the string
typed so far.  An incremental search requires only as many characters
typed so far.  An incremental search requires only as many characters
as needed to find the desired history entry.  The characters present in
as needed to find the desired history entry.  The characters present in
the value of the ISEARCH-TERMINATORS variable are used to terminate an
the value of the ISEARCH-TERMINATORS variable are used to terminate an
incremental search.  If that variable has not been assigned a value,
incremental search.  If that variable has not been assigned a value,
the  and  characters will terminate an incremental search.
the  and  characters will terminate an incremental search.
 will abort an incremental search and restore the original line.
 will abort an incremental search and restore the original line.
When the search is terminated, the history entry containing the search
When the search is terminated, the history entry containing the search
string becomes the current line.  To find other matching entries in the
string becomes the current line.  To find other matching entries in the
history list, type  or  as appropriate.  This will search
history list, type  or  as appropriate.  This will search
backward or forward in the history for the next entry matching the
backward or forward in the history for the next entry matching the
search string typed so far.  Any other key sequence bound to a Readline
search string typed so far.  Any other key sequence bound to a Readline
command will terminate the search and execute that command.  For
command will terminate the search and execute that command.  For
instance, a  will terminate the search and accept the line,
instance, a  will terminate the search and accept the line,
thereby executing the command from the history list.
thereby executing the command from the history list.
   Non-incremental searches read the entire search string before
   Non-incremental searches read the entire search string before
starting to search for matching history lines.  The search string may be
starting to search for matching history lines.  The search string may be
typed by the user or be part of the contents of the current line.
typed by the user or be part of the contents of the current line.
 
 

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.