Annotations-Overview.html 5.0 KB

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