You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

169 lines
7.9KB

  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 6.5, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  16. <title>Command aliases default args (Debugging with GDB)</title>
  17. <meta name="description" content="Command aliases default args (Debugging with GDB)">
  18. <meta name="keywords" content="Command aliases default args (Debugging with GDB)">
  19. <meta name="resource-type" content="document">
  20. <meta name="distribution" content="global">
  21. <meta name="Generator" content="makeinfo">
  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="Commands.html#Commands" rel="up" title="Commands">
  26. <link href="Help.html#Help" rel="next" title="Help">
  27. <link href="Command-Options.html#Command-Options" rel="prev" title="Command Options">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.indentedblock {margin-right: 0em}
  32. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  33. blockquote.smallquotation {font-size: smaller}
  34. div.display {margin-left: 3.2em}
  35. div.example {margin-left: 3.2em}
  36. div.lisp {margin-left: 3.2em}
  37. div.smalldisplay {margin-left: 3.2em}
  38. div.smallexample {margin-left: 3.2em}
  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.nolinebreak {white-space: nowrap}
  50. span.roman {font-family: initial; font-weight: normal}
  51. span.sansserif {font-family: sans-serif; font-weight: normal}
  52. ul.no-bullet {list-style: none}
  53. -->
  54. </style>
  55. </head>
  56. <body lang="en">
  57. <a name="Command-aliases-default-args"></a>
  58. <div class="header">
  59. <p>
  60. Next: <a href="Help.html#Help" accesskey="n" rel="next">Help</a>, Previous: <a href="Command-Options.html#Command-Options" accesskey="p" rel="prev">Command Options</a>, Up: <a href="Commands.html#Commands" accesskey="u" rel="up">Commands</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>
  61. </div>
  62. <hr>
  63. <a name="Automatically-prepend-default-arguments-to-user_002ddefined-aliases"></a>
  64. <h3 class="section">3.5 Automatically prepend default arguments to user-defined aliases</h3>
  65. <p>You can tell <small>GDB</small> to always prepend some default arguments to
  66. the list of arguments provided explicitly by the user when using a
  67. user-defined alias.
  68. </p>
  69. <p>If you repeatedly use the same arguments or options for a command, you
  70. can define an alias for this command and tell <small>GDB</small> to
  71. automatically prepend these arguments or options to the list of
  72. arguments you type explicitly when using the alias<a name="DOCF3" href="#FOOT3"><sup>3</sup></a>.
  73. </p>
  74. <p>For example, if you often use the command <code>thread apply all</code>
  75. specifying to work on the threads in ascending order and to continue in case it
  76. encounters an error, you can tell <small>GDB</small> to automatically preprend
  77. the <code>-ascending</code> and <code>-c</code> options by using:
  78. </p>
  79. <div class="smallexample">
  80. <pre class="smallexample">(gdb) alias thread apply asc-all = thread apply all -ascending -c
  81. </pre></div>
  82. <p>Once you have defined this alias with its default args, any time you type
  83. the <code>thread apply asc-all</code> followed by <code>some arguments</code>,
  84. <small>GDB</small> will execute <code>thread apply all -ascending -c some arguments</code>.
  85. </p>
  86. <p>To have even less to type, you can also define a one word alias:
  87. </p><div class="smallexample">
  88. <pre class="smallexample">(gdb) alias t_a_c = thread apply all -ascending -c
  89. </pre></div>
  90. <p>As usual, unambiguous abbreviations can be used for <var>alias</var>
  91. and <var>default-args</var>.
  92. </p>
  93. <p>The different aliases of a command do not share their default args.
  94. For example, you define a new alias <code>bt_ALL</code> showing all possible
  95. information and another alias <code>bt_SMALL</code> showing very limited information
  96. using:
  97. </p><div class="smallexample">
  98. <pre class="smallexample">(gdb) alias bt_ALL = backtrace -entry-values both -frame-arg all \
  99. -past-main -past-entry -full
  100. (gdb) alias bt_SMALL = backtrace -entry-values no -frame-arg none \
  101. -past-main off -past-entry off
  102. </pre></div>
  103. <p>(For more on using the <code>alias</code> command, see <a href="Aliases.html#Aliases">Aliases</a>.)
  104. </p>
  105. <p>Default args are not limited to the arguments and options of <var>command</var>,
  106. but can specify nested commands if <var>command</var> accepts such a nested command
  107. as argument.
  108. For example, the below defines <code>faalocalsoftype</code> that lists the
  109. frames having locals of a certain type, together with the matching
  110. local vars:
  111. </p><div class="smallexample">
  112. <pre class="smallexample">(gdb) alias faalocalsoftype = frame apply all info locals -q -t
  113. (gdb) faalocalsoftype int
  114. #1 0x55554f5e in sleeper_or_burner (v=0xdf50) at sleepers.c:86
  115. i = 0
  116. ret = 21845
  117. </pre></div>
  118. <p>This is also very useful to define an alias for a set of nested <code>with</code>
  119. commands to have a particular combination of temporary settings. For example,
  120. the below defines the alias <code>pp10</code> that pretty prints an expression
  121. argument, with a maximum of 10 elements if the expression is a string or
  122. an array:
  123. </p><div class="smallexample">
  124. <pre class="smallexample">(gdb) alias pp10 = with print pretty -- with print elements 10 -- print
  125. </pre></div>
  126. <p>This defines the alias <code>pp10</code> as being a sequence of 3 commands.
  127. The first part <code>with print pretty --</code> temporarily activates the setting
  128. <code>set print pretty</code>, then launches the command that follows the separator
  129. <code>--</code>.
  130. The command following the first part is also a <code>with</code> command that
  131. temporarily changes the setting <code>set print elements</code> to 10, then
  132. launches the command that follows the second separator <code>--</code>.
  133. The third part <code>print</code> is the command the <code>pp10</code> alias will launch,
  134. using the temporary values of the settings and the arguments explicitly given
  135. by the user.
  136. For more information about the <code>with</code> command usage,
  137. see <a href="Command-Settings.html#Command-Settings">Command Settings</a>.
  138. </p>
  139. <div class="footnote">
  140. <hr>
  141. <h4 class="footnotes-heading">Footnotes</h4>
  142. <h3><a name="FOOT3" href="#DOCF3">(3)</a></h3>
  143. <p><small>GDB</small>
  144. could easily accept default arguments for pre-defined commands and aliases,
  145. but it was deemed this would be confusing, and so is not allowed.</p>
  146. </div>
  147. <hr>
  148. <div class="header">
  149. <p>
  150. Next: <a href="Help.html#Help" accesskey="n" rel="next">Help</a>, Previous: <a href="Command-Options.html#Command-Options" accesskey="p" rel="prev">Command Options</a>, Up: <a href="Commands.html#Commands" accesskey="u" rel="up">Commands</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>
  151. </div>
  152. </body>
  153. </html>