1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<!-- Copyright (C) 1994-2021 Free Software Foundation, Inc. 4 5Permission is granted to copy, distribute and/or modify this document 6under the terms of the GNU Free Documentation License, Version 1.3 or 7any later version published by the Free Software Foundation; with no 8Invariant Sections, with no Front-Cover Texts, and with no Back-Cover 9Texts. A copy of the license is included in the section entitled "GNU 10Free Documentation License". --> 11<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ --> 12<head> 13<title>GDB’s Obsolete Annotations: Annotations Overview</title> 14 15<meta name="description" content="GDB’s Obsolete Annotations: Annotations Overview"> 16<meta name="keywords" content="GDB’s Obsolete Annotations: Annotations Overview"> 17<meta name="resource-type" content="document"> 18<meta name="distribution" content="global"> 19<meta name="Generator" content="makeinfo"> 20<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 21<link href="index.html#Top" rel="start" title="Top"> 22<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> 23<link href="index.html#Top" rel="up" title="Top"> 24<link href="Limitations.html#Limitations" rel="next" title="Limitations"> 25<link href="index.html#Top" rel="previous" title="Top"> 26<style type="text/css"> 27<!-- 28a.summary-letter {text-decoration: none} 29blockquote.smallquotation {font-size: smaller} 30div.display {margin-left: 3.2em} 31div.example {margin-left: 3.2em} 32div.indentedblock {margin-left: 3.2em} 33div.lisp {margin-left: 3.2em} 34div.smalldisplay {margin-left: 3.2em} 35div.smallexample {margin-left: 3.2em} 36div.smallindentedblock {margin-left: 3.2em; font-size: smaller} 37div.smalllisp {margin-left: 3.2em} 38kbd {font-style:oblique} 39pre.display {font-family: inherit} 40pre.format {font-family: inherit} 41pre.menu-comment {font-family: serif} 42pre.menu-preformatted {font-family: serif} 43pre.smalldisplay {font-family: inherit; font-size: smaller} 44pre.smallexample {font-size: smaller} 45pre.smallformat {font-family: inherit; font-size: smaller} 46pre.smalllisp {font-size: smaller} 47span.nocodebreak {white-space:nowrap} 48span.nolinebreak {white-space:nowrap} 49span.roman {font-family:serif; font-weight:normal} 50span.sansserif {font-family:sans-serif; font-weight:normal} 51ul.no-bullet {list-style: none} 52--> 53</style> 54 55 56</head> 57 58<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> 59<a name="Annotations-Overview"></a> 60<div class="header"> 61<p> 62Next: <a href="Limitations.html#Limitations" accesskey="n" rel="next">Limitations</a>, Previous: <a href="index.html#Top" accesskey="p" rel="previous">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> 63</div> 64<hr> 65<a name="What-is-an-Annotation_003f"></a> 66<h2 class="chapter">1 What is an Annotation?</h2> 67<a name="index-annotations"></a> 68 69<p>To produce obsolete level two annotations, start <small>GDB</small> with the 70<code>--annotate=2</code> option. 71</p> 72<p>Annotations start with a newline character, two ‘<samp>control-z</samp>’ 73characters, and the name of the annotation. If there is no additional 74information associated with this annotation, the name of the annotation 75is followed immediately by a newline. If there is additional 76information, the name of the annotation is followed by a space, the 77additional information, and a newline. The additional information 78cannot contain newline characters. 79</p> 80<p>Any output not beginning with a newline and two ‘<samp>control-z</samp>’ 81characters denotes literal output from <small>GDB</small>. Currently there is 82no need for <small>GDB</small> to output a newline followed by two 83‘<samp>control-z</samp>’ characters, but if there was such a need, the 84annotations could be extended with an ‘<samp>escape</samp>’ annotation which 85means those three characters as output. 86</p> 87<p>A simple example of starting up <small>GDB</small> with annotations is: 88</p> 89<div class="smallexample"> 90<pre class="smallexample">$ gdb --annotate=2 91GNU GDB 5.0 92Copyright 2000 Free Software Foundation, Inc. 93GDB is free software, covered by the GNU General Public License, 94and you are welcome to change it and/or distribute copies of it 95under certain conditions. 96Type "show copying" to see the conditions. 97There is absolutely no warranty for GDB. Type "show warranty" 98for details. 99This GDB was configured as "sparc-sun-sunos4.1.3" 100 101^Z^Zpre-prompt 102(gdb) 103^Z^Zprompt 104quit 105 106^Z^Zpost-prompt 107$ 108</pre></div> 109 110<p>Here ‘<samp>quit</samp>’ is input to <small>GDB</small>; the rest is output from 111<small>GDB</small>. The three lines beginning ‘<samp>^Z^Z</samp>’ (where ‘<samp>^Z</samp>’ 112denotes a ‘<samp>control-z</samp>’ character) are annotations; the rest is 113output from <small>GDB</small>. 114</p> 115 116 117 118</body> 119</html> 120