gdb_002eprompt.html 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1988-2020 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 the
  7. Invariant Sections being "Free Software" and "Free Software Needs
  8. Free Documentation", with the Front-Cover Texts being "A GNU Manual,"
  9. and with the Back-Cover Texts as in (a) below.
  10. (a) The FSF's Back-Cover Text is: "You are free to copy and modify
  11. this GNU Manual. Buying copies from GNU Press supports the FSF in
  12. developing GNU and promoting software freedom." -->
  13. <!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <title>Debugging with GDB: gdb.prompt</title>
  16. <meta name="description" content="Debugging with GDB: gdb.prompt">
  17. <meta name="keywords" content="Debugging with GDB: gdb.prompt">
  18. <meta name="resource-type" content="document">
  19. <meta name="distribution" content="global">
  20. <meta name="Generator" content="makeinfo">
  21. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  22. <link href="index.html#Top" rel="start" title="Top">
  23. <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
  24. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  25. <link href="Python-modules.html#Python-modules" rel="up" title="Python modules">
  26. <link href="Guile.html#Guile" rel="next" title="Guile">
  27. <link href="gdb_002etypes.html#gdb_002etypes" rel="previous" title="gdb.types">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.smallquotation {font-size: smaller}
  32. div.display {margin-left: 3.2em}
  33. div.example {margin-left: 3.2em}
  34. div.indentedblock {margin-left: 3.2em}
  35. div.lisp {margin-left: 3.2em}
  36. div.smalldisplay {margin-left: 3.2em}
  37. div.smallexample {margin-left: 3.2em}
  38. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  39. div.smalllisp {margin-left: 3.2em}
  40. kbd {font-style:oblique}
  41. pre.display {font-family: inherit}
  42. pre.format {font-family: inherit}
  43. pre.menu-comment {font-family: serif}
  44. pre.menu-preformatted {font-family: serif}
  45. pre.smalldisplay {font-family: inherit; font-size: smaller}
  46. pre.smallexample {font-size: smaller}
  47. pre.smallformat {font-family: inherit; font-size: smaller}
  48. pre.smalllisp {font-size: smaller}
  49. span.nocodebreak {white-space:nowrap}
  50. span.nolinebreak {white-space:nowrap}
  51. span.roman {font-family:serif; font-weight:normal}
  52. span.sansserif {font-family:sans-serif; font-weight:normal}
  53. ul.no-bullet {list-style: none}
  54. -->
  55. </style>
  56. </head>
  57. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  58. <a name="gdb_002eprompt"></a>
  59. <div class="header">
  60. <p>
  61. Previous: <a href="gdb_002etypes.html#gdb_002etypes" accesskey="p" rel="previous">gdb.types</a>, Up: <a href="Python-modules.html#Python-modules" accesskey="u" rel="up">Python modules</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
  62. </div>
  63. <hr>
  64. <a name="gdb_002eprompt-1"></a>
  65. <h4 class="subsubsection">23.2.4.3 gdb.prompt</h4>
  66. <a name="index-gdb_002eprompt"></a>
  67. <p>This module provides a method for prompt value-substitution.
  68. </p>
  69. <dl compact="compact">
  70. <dt><code>substitute_prompt (<var>string</var>)</code></dt>
  71. <dd><p>Return <var>string</var> with escape sequences substituted by values. Some
  72. escape sequences take arguments. You can specify arguments inside
  73. &ldquo;{}&rdquo; immediately following the escape sequence.
  74. </p>
  75. <p>The escape sequences you can pass to this function are:
  76. </p>
  77. <dl compact="compact">
  78. <dt><code>\\</code></dt>
  79. <dd><p>Substitute a backslash.
  80. </p></dd>
  81. <dt><code>\e</code></dt>
  82. <dd><p>Substitute an ESC character.
  83. </p></dd>
  84. <dt><code>\f</code></dt>
  85. <dd><p>Substitute the selected frame; an argument names a frame parameter.
  86. </p></dd>
  87. <dt><code>\n</code></dt>
  88. <dd><p>Substitute a newline.
  89. </p></dd>
  90. <dt><code>\p</code></dt>
  91. <dd><p>Substitute a parameter&rsquo;s value; the argument names the parameter.
  92. </p></dd>
  93. <dt><code>\r</code></dt>
  94. <dd><p>Substitute a carriage return.
  95. </p></dd>
  96. <dt><code>\t</code></dt>
  97. <dd><p>Substitute the selected thread; an argument names a thread parameter.
  98. </p></dd>
  99. <dt><code>\v</code></dt>
  100. <dd><p>Substitute the version of GDB.
  101. </p></dd>
  102. <dt><code>\w</code></dt>
  103. <dd><p>Substitute the current working directory.
  104. </p></dd>
  105. <dt><code>\[</code></dt>
  106. <dd><p>Begin a sequence of non-printing characters. These sequences are
  107. typically used with the ESC character, and are not counted in the string
  108. length. Example: &ldquo;\[\e[0;34m\](gdb)\[\e[0m\]&rdquo; will return a
  109. blue-colored &ldquo;(gdb)&rdquo; prompt where the length is five.
  110. </p></dd>
  111. <dt><code>\]</code></dt>
  112. <dd><p>End a sequence of non-printing characters.
  113. </p></dd>
  114. </dl>
  115. <p>For example:
  116. </p>
  117. <div class="smallexample">
  118. <pre class="smallexample">substitute_prompt (&quot;frame: \f, args: \p{print frame-arguments}&quot;)
  119. </pre></div>
  120. <p>will return the string:
  121. </p>
  122. <div class="smallexample">
  123. <pre class="smallexample">&quot;frame: main, args: scalars&quot;
  124. </pre></div>
  125. </dd>
  126. </dl>
  127. </body>
  128. </html>