Command-aliases-default-args.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  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: Command aliases default args</title>
  16. <meta name="description" content="Debugging with GDB: Command aliases default args">
  17. <meta name="keywords" content="Debugging with GDB: Command aliases default args">
  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="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="previous" title="Command Options">
  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="Command-aliases-default-args"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="Help.html#Help" accesskey="n" rel="next">Help</a>, Previous: <a href="Command-Options.html#Command-Options" accesskey="p" rel="previous">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>
  62. </div>
  63. <hr>
  64. <a name="Automatically-prepend-default-arguments-to-user_002ddefined-aliases"></a>
  65. <h3 class="section">3.5 Automatically prepend default arguments to user-defined aliases</h3>
  66. <p>You can tell <small>GDB</small> to always prepend some default arguments to
  67. the list of arguments provided explicitly by the user when using a
  68. user-defined alias.
  69. </p>
  70. <p>If you repeatedly use the same arguments or options for a command, you
  71. can define an alias for this command and tell <small>GDB</small> to
  72. automatically prepend these arguments or options to the list of
  73. arguments you type explicitly when using the alias<a name="DOCF3" href="#FOOT3"><sup>3</sup></a>.
  74. </p>
  75. <p>For example, if you often use the command <code>thread apply all</code>
  76. specifying to work on the threads in ascending order and to continue in case it
  77. encounters an error, you can tell <small>GDB</small> to automatically preprend
  78. the <code>-ascending</code> and <code>-c</code> options by using:
  79. </p>
  80. <div class="smallexample">
  81. <pre class="smallexample">(gdb) alias thread apply asc-all = thread apply all -ascending -c
  82. </pre></div>
  83. <p>Once you have defined this alias with its default args, any time you type
  84. the <code>thread apply asc-all</code> followed by <code>some arguments</code>,
  85. <small>GDB</small> will execute <code>thread apply all -ascending -c some arguments</code>.
  86. </p>
  87. <p>To have even less to type, you can also define a one word alias:
  88. </p><div class="smallexample">
  89. <pre class="smallexample">(gdb) alias t_a_c = thread apply all -ascending -c
  90. </pre></div>
  91. <p>As usual, unambiguous abbreviations can be used for <var>alias</var>
  92. and <var>default-args</var>.
  93. </p>
  94. <p>The different aliases of a command do not share their default args.
  95. For example, you define a new alias <code>bt_ALL</code> showing all possible
  96. information and another alias <code>bt_SMALL</code> showing very limited information
  97. using:
  98. </p><div class="smallexample">
  99. <pre class="smallexample">(gdb) alias bt_ALL = backtrace -entry-values both -frame-arg all \
  100. -past-main -past-entry -full
  101. (gdb) alias bt_SMALL = backtrace -entry-values no -frame-arg none \
  102. -past-main off -past-entry off
  103. </pre></div>
  104. <p>(For more on using the <code>alias</code> command, see <a href="Aliases.html#Aliases">Aliases</a>.)
  105. </p>
  106. <p>Default args are not limited to the arguments and options of <var>command</var>,
  107. but can specify nested commands if <var>command</var> accepts such a nested command
  108. as argument.
  109. For example, the below defines <code>faalocalsoftype</code> that lists the
  110. frames having locals of a certain type, together with the matching
  111. local vars:
  112. </p><div class="smallexample">
  113. <pre class="smallexample">(gdb) alias faalocalsoftype = frame apply all info locals -q -t
  114. (gdb) faalocalsoftype int
  115. #1 0x55554f5e in sleeper_or_burner (v=0xdf50) at sleepers.c:86
  116. i = 0
  117. ret = 21845
  118. </pre></div>
  119. <p>This is also very useful to define an alias for a set of nested <code>with</code>
  120. commands to have a particular combination of temporary settings. For example,
  121. the below defines the alias <code>pp10</code> that pretty prints an expression
  122. argument, with a maximum of 10 elements if the expression is a string or
  123. an array:
  124. </p><div class="smallexample">
  125. <pre class="smallexample">(gdb) alias pp10 = with print pretty -- with print elements 10 -- print
  126. </pre></div>
  127. <p>This defines the alias <code>pp10</code> as being a sequence of 3 commands.
  128. The first part <code>with print pretty --</code> temporarily activates the setting
  129. <code>set print pretty</code>, then launches the command that follows the separator
  130. <code>--</code>.
  131. The command following the first part is also a <code>with</code> command that
  132. temporarily changes the setting <code>set print elements</code> to 10, then
  133. launches the command that follows the second separator <code>--</code>.
  134. The third part <code>print</code> is the command the <code>pp10</code> alias will launch,
  135. using the temporary values of the settings and the arguments explicitly given
  136. by the user.
  137. For more information about the <code>with</code> command usage,
  138. see <a href="Command-Settings.html#Command-Settings">Command Settings</a>.
  139. </p>
  140. <div class="footnote">
  141. <hr>
  142. <h4 class="footnotes-heading">Footnotes</h4>
  143. <h3><a name="FOOT3" href="#DOCF3">(3)</a></h3>
  144. <p><small>GDB</small>
  145. could easily accept default arguments for pre-defined commands and aliases,
  146. but it was deemed this would be confusing, and so is not allowed.</p>
  147. </div>
  148. <hr>
  149. <div class="header">
  150. <p>
  151. Next: <a href="Help.html#Help" accesskey="n" rel="next">Help</a>, Previous: <a href="Command-Options.html#Command-Options" accesskey="p" rel="previous">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>
  152. </div>
  153. </body>
  154. </html>