</span><spanid=__span-4-17><aid=__codelineno-4-17name=__codelineno-4-17href=#__codelineno-4-17></a>auto-save-search automatically pass --save to "search" command off
</span><spanid=__span-4-18><aid=__codelineno-4-18name=__codelineno-4-18href=#__codelineno-4-18></a>bn-autosync whether to automatically run bn-sync every step off
</span></code></pre></div> Because of the various contexts in which a parameter can be show, the first letter of the <code>set_show_doc</code> string should be lowercase (unless the first word is a name or an abbreviation) and there should be no punctuation at the end. This way, Pwndbg and GDB can more easily modify the string to fit it into these contexts.</p><h2id=help_docstring>help_docstring<aclass=headerlinkhref=#help_docstringtitle="Permanent link">¤</a></h2><p>While <code>help_docstring</code> is not mandatory, it is highly recommended to use it. Put a detailed explanation of what the parameter does here, and explain any caveats. This string does not have a size limit and is shown with the following command in GDB: <divclass="language-text highlight"><pre><span></span><code><spanid=__span-5-1><aid=__codelineno-5-1name=__codelineno-5-1href=#__codelineno-5-1></a>pwndbg> help set gdb-workaround-stop-event
</span></code></pre></div> Because of the various contexts in which a parameter can be show, the first letter of the <code>set_show_doc</code> string should be lowercase (unless the first word is a name or an abbreviation) and there should be no punctuation at the end. This way, Pwndbg and GDB can more easily modify the string to fit it into these contexts.</p><h2id=help_docstring>help_docstring<aclass=headerlinkhref=#help_docstringtitle="Permanent link">¤</a></h2><p>While <code>help_docstring</code> is not mandatory, it is highly recommended to use it. Put a detailed explanation of what the parameter does here, and explain any caveats. This string does not have a size limit and is shown with the following command in GDB and LLDB: <divclass="language-text highlight"><pre><span></span><code><spanid=__span-5-1><aid=__codelineno-5-1name=__codelineno-5-1href=#__codelineno-5-1></a>pwndbg> help set gdb-workaround-stop-event
</span><spanid=__span-5-2><aid=__codelineno-5-2name=__codelineno-5-2href=#__codelineno-5-2></a>Set asynchronous stop events to improve 'commands' functionality.
</span><spanid=__span-5-3><aid=__codelineno-5-3name=__codelineno-5-3href=#__codelineno-5-3></a>Note that this may cause unexpected behavior with Pwndbg or gdb.execute.
</span></code></pre></div> Note that the last two lines are automatically generated by Pwndbg.</p><div class="admonition note"><pclass=admonition-title>Note</p><p>There is currently no way to display this string nor the <code>set_show_doc</code> string in LLDB.</p></div><p>When writing this explanation, it is important to take into account how it will be displayed <ahref=https://pwndbg.re/pwndbg/dev/configuration/>in the documentation</a> after being parsed as markdown. See what <code>gdb-workaround-stop-event</code> looks like here: <ahref=https://pwndbg.re/pwndbg/dev/configuration/config/#gdb-workaround-stop-event>https://pwndbg.re/pwndbg/dev/configuration/config/#gdb-workaround-stop-event</a> . If there wasn't an empty line between <code>Values explained:</code> and <code>+ `disabled`..</code> the list wouldn't have rendered properly.</p><h2id=param_class>param_class<aclass=headerlinkhref=#param_classtitle="Permanent link">¤</a></h2><p>This argument describes the type of the parameter. It will be used by GDB to perform input validation when the parameter is being set so it is important to set this to the correct value. The possible values are defined in <code>pwndbg/lib/config.py</code>, use the most restrictive one that fits: <divclass="language-python highlight"><pre><span></span><code><spanid=__span-6-1><aid=__codelineno-6-1name=__codelineno-6-1href=#__codelineno-6-1></a><spanclass=c1># Boolean value. True or False, same as in Python.</span>
</span></code></pre></div> Note that the last two lines are automatically generated by Pwndbg.</p><p>When writing this explanation, it is important to take into account how it will be displayed <ahref=https://pwndbg.re/pwndbg/dev/configuration/>in the documentation</a> after being parsed as markdown. See what <code>gdb-workaround-stop-event</code> looks like here: <ahref=https://pwndbg.re/pwndbg/dev/configuration/config/#gdb-workaround-stop-event>https://pwndbg.re/pwndbg/dev/configuration/config/#gdb-workaround-stop-event</a> . If there wasn't an empty line between <code>Values explained:</code> and <code>+ `disabled`..</code> the list wouldn't have rendered properly.</p><h2id=param_class>param_class<aclass=headerlinkhref=#param_classtitle="Permanent link">¤</a></h2><p>This argument describes the type of the parameter. It will be used by GDB to perform input validation when the parameter is being set so it is important to set this to the correct value. The possible values are defined in <code>pwndbg/lib/config.py</code>, use the most restrictive one that fits: <divclass="language-python highlight"><pre><span></span><code><spanid=__span-6-1><aid=__codelineno-6-1name=__codelineno-6-1href=#__codelineno-6-1></a><spanclass=c1># Boolean value. True or False, same as in Python.</span>
</span><spanid=__span-6-3><aid=__codelineno-6-3name=__codelineno-6-3href=#__codelineno-6-3></a><spanclass=c1># Boolean value, or 'auto'.</span>
{"version":"https://jsonfeed.org/version/1","title":"pwndbg Blog","home_page_url":"https://pwndbg.re/pwndbg/latest/","feed_url":"https://pwndbg.re/pwndbg/latest/feed_json_updated.json","description":"pwndbg (/pa\u028an\u02c8di\u02ccb\u028c\u0261/) is a GDB plug-in that makes debugging with GDB suck less, with a focus on features needed by low-level software developers, hardware hackers, reverse-engineers and exploit developers.","icon":"https://pwndbg.re/pwndbg/assets/favicon.ico","authors":[],"language":"en","items":[{"id":"https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/","url":"https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/","title":"Pwndbg coding sprints report","content_html":"Report of the two coding sprints with Pwndbg\n","image":null,"date_modified":"2025-06-02T19:01:53+00:00","authors":[{"name":"Disconnect3d"}],"tags":[]}]}
{"version":"https://jsonfeed.org/version/1","title":"pwndbg Blog","home_page_url":"https://pwndbg.re/pwndbg/latest/","feed_url":"https://pwndbg.re/pwndbg/latest/feed_json_updated.json","description":"pwndbg (/pa\u028an\u02c8di\u02ccb\u028c\u0261/) is a GDB plug-in that makes debugging with GDB suck less, with a focus on features needed by low-level software developers, hardware hackers, reverse-engineers and exploit developers.","icon":"https://pwndbg.re/pwndbg/assets/favicon.ico","authors":[],"language":"en","items":[{"id":"https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/","url":"https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/","title":"Pwndbg coding sprints report","content_html":"Report of the two coding sprints with Pwndbg\n","image":null,"date_modified":"2025-06-03T10:28:07+00:00","authors":[{"name":"Disconnect3d"}],"tags":[]}]}
<?xml version="1.0" encoding="UTF-8" ?><rssversion="2.0"xmlns:atom="http://www.w3.org/2005/Atom"xmlns:dc="http://purl.org/dc/elements/1.1/"><channel><title>pwndbg Blog</title><description>pwndbg (/paʊnˈdiˌbʌɡ/) is a GDB plug-in that makes debugging with GDB suck less, with a focus on features needed by low-level software developers, hardware hackers, reverse-engineers and exploit developers.</description><link>https://pwndbg.re/pwndbg/latest/</link><atom:linkhref="https://pwndbg.re/pwndbg/latest/feed_rss_created.xml"rel="self"type="application/rss+xml"/><docs>https://github.com/pwndbg/pwndbg/</docs><language>en</language><pubDate>Mon, 02 Jun 2025 19:04:20 -0000</pubDate><lastBuildDate>Mon, 02 Jun 2025 19:04:20 -0000</lastBuildDate><ttl>1440</ttl><generator>MkDocs RSS plugin - v1.17.1</generator><image><url>https://pwndbg.re/pwndbg/assets/favicon.ico</url><title>pwndbg Blog</title><link>https://pwndbg.re/pwndbg/latest/</link></image><item><title>Pwndbg coding sprints report</title><author>Disconnect3d</author><description>Report of the two coding sprints with Pwndbg</description><link>https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/</link><pubDate>Sun, 21 Aug 2022 00:00:00 +0000</pubDate><sourceurl="https://pwndbg.re/pwndbg/latest/feed_rss_created.xml">pwndbg Blog</source><guidisPermaLink="true">https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/</guid></item></channel></rss>
<?xml version="1.0" encoding="UTF-8" ?><rssversion="2.0"xmlns:atom="http://www.w3.org/2005/Atom"xmlns:dc="http://purl.org/dc/elements/1.1/"><channel><title>pwndbg Blog</title><description>pwndbg (/paʊnˈdiˌbʌɡ/) is a GDB plug-in that makes debugging with GDB suck less, with a focus on features needed by low-level software developers, hardware hackers, reverse-engineers and exploit developers.</description><link>https://pwndbg.re/pwndbg/latest/</link><atom:linkhref="https://pwndbg.re/pwndbg/latest/feed_rss_created.xml"rel="self"type="application/rss+xml"/><docs>https://github.com/pwndbg/pwndbg/</docs><language>en</language><pubDate>Tue, 03 Jun 2025 10:32:04 -0000</pubDate><lastBuildDate>Tue, 03 Jun 2025 10:32:04 -0000</lastBuildDate><ttl>1440</ttl><generator>MkDocs RSS plugin - v1.17.1</generator><image><url>https://pwndbg.re/pwndbg/assets/favicon.ico</url><title>pwndbg Blog</title><link>https://pwndbg.re/pwndbg/latest/</link></image><item><title>Pwndbg coding sprints report</title><author>Disconnect3d</author><description>Report of the two coding sprints with Pwndbg</description><link>https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/</link><pubDate>Sun, 21 Aug 2022 00:00:00 +0000</pubDate><sourceurl="https://pwndbg.re/pwndbg/latest/feed_rss_created.xml">pwndbg Blog</source><guidisPermaLink="true">https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/</guid></item></channel></rss>
<?xml version="1.0" encoding="UTF-8" ?><rssversion="2.0"xmlns:atom="http://www.w3.org/2005/Atom"xmlns:dc="http://purl.org/dc/elements/1.1/"><channel><title>pwndbg Blog</title><description>pwndbg (/paʊnˈdiˌbʌɡ/) is a GDB plug-in that makes debugging with GDB suck less, with a focus on features needed by low-level software developers, hardware hackers, reverse-engineers and exploit developers.</description><link>https://pwndbg.re/pwndbg/latest/</link><atom:linkhref="https://pwndbg.re/pwndbg/latest/feed_rss_updated.xml"rel="self"type="application/rss+xml"/><docs>https://github.com/pwndbg/pwndbg/</docs><language>en</language><pubDate>Mon, 02 Jun 2025 19:04:20 -0000</pubDate><lastBuildDate>Mon, 02 Jun 2025 19:04:20 -0000</lastBuildDate><ttl>1440</ttl><generator>MkDocs RSS plugin - v1.17.1</generator><image><url>https://pwndbg.re/pwndbg/assets/favicon.ico</url><title>pwndbg Blog</title><link>https://pwndbg.re/pwndbg/latest/</link></image><item><title>Pwndbg coding sprints report</title><author>Disconnect3d</author><description>Report of the two coding sprints with Pwndbg</description><link>https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/</link><pubDate>Mon, 02 Jun 2025 19:01:53 +0000</pubDate><sourceurl="https://pwndbg.re/pwndbg/latest/feed_rss_updated.xml">pwndbg Blog</source><guidisPermaLink="true">https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/</guid></item></channel></rss>
<?xml version="1.0" encoding="UTF-8" ?><rssversion="2.0"xmlns:atom="http://www.w3.org/2005/Atom"xmlns:dc="http://purl.org/dc/elements/1.1/"><channel><title>pwndbg Blog</title><description>pwndbg (/paʊnˈdiˌbʌɡ/) is a GDB plug-in that makes debugging with GDB suck less, with a focus on features needed by low-level software developers, hardware hackers, reverse-engineers and exploit developers.</description><link>https://pwndbg.re/pwndbg/latest/</link><atom:linkhref="https://pwndbg.re/pwndbg/latest/feed_rss_updated.xml"rel="self"type="application/rss+xml"/><docs>https://github.com/pwndbg/pwndbg/</docs><language>en</language><pubDate>Tue, 03 Jun 2025 10:32:04 -0000</pubDate><lastBuildDate>Tue, 03 Jun 2025 10:32:04 -0000</lastBuildDate><ttl>1440</ttl><generator>MkDocs RSS plugin - v1.17.1</generator><image><url>https://pwndbg.re/pwndbg/assets/favicon.ico</url><title>pwndbg Blog</title><link>https://pwndbg.re/pwndbg/latest/</link></image><item><title>Pwndbg coding sprints report</title><author>Disconnect3d</author><description>Report of the two coding sprints with Pwndbg</description><link>https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/</link><pubDate>Tue, 03 Jun 2025 10:28:07 +0000</pubDate><sourceurl="https://pwndbg.re/pwndbg/latest/feed_rss_updated.xml">pwndbg Blog</source><guidisPermaLink="true">https://pwndbg.re/pwndbg/latest/blog/2022/08/21/pwndbg-coding-sprints-report/</guid></item></channel></rss>
DocBot
6 months ago