blob: 5af87cb2ae24f548166d10867d5345d0e4753b8a [file] [log] [blame]
<html lang="en">
<head>
<title>Python - Debugging with GDB</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Debugging with GDB">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Extending-GDB.html#Extending-GDB" title="Extending GDB">
<link rel="prev" href="Sequences.html#Sequences" title="Sequences">
<link rel="next" href="Guile.html#Guile" title="Guile">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 1988-2019 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being ``Free Software'' and ``Free Software Needs
Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,''
and with the Back-Cover Texts as in (a) below.
(a) The FSF's Back-Cover Text is: ``You are free to copy and modify
this GNU Manual. Buying copies from GNU Press supports the FSF in
developing GNU and promoting software freedom.''
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Python"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Guile.html#Guile">Guile</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Sequences.html#Sequences">Sequences</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Extending-GDB.html#Extending-GDB">Extending GDB</a>
<hr>
</div>
<h3 class="section">23.2 Extending <span class="sc">gdb</span> using Python</h3>
<p><a name="index-python-scripting-1836"></a><a name="index-scripting-with-python-1837"></a>
You can extend <span class="sc">gdb</span> using the <a href="http://www.python.org/">Python programming language</a>. This feature is available only if
<span class="sc">gdb</span> was configured using <samp><span class="option">--with-python</span></samp>.
<span class="sc">gdb</span> can be built against either Python 2 or Python 3; which
one you have depends on this configure-time option.
<p><a name="index-python-directory-1838"></a>Python scripts used by <span class="sc">gdb</span> should be installed in
<samp><var>data-directory</var><span class="file">/python</span></samp>, where <var>data-directory</var> is
the data directory as determined at <span class="sc">gdb</span> startup (see <a href="Data-Files.html#Data-Files">Data Files</a>).
This directory, known as the <dfn>python directory</dfn>,
is automatically added to the Python Search Path in order to allow
the Python interpreter to locate all scripts installed at this location.
<p>Additionally, <span class="sc">gdb</span> commands and convenience functions which
are written in Python and are located in the
<samp><var>data-directory</var><span class="file">/python/gdb/command</span></samp> or
<samp><var>data-directory</var><span class="file">/python/gdb/function</span></samp> directories are
automatically imported when <span class="sc">gdb</span> starts.
<ul class="menu">
<li><a accesskey="1" href="Python-Commands.html#Python-Commands">Python Commands</a>: Accessing Python from <span class="sc">gdb</span>.
<li><a accesskey="2" href="Python-API.html#Python-API">Python API</a>: Accessing <span class="sc">gdb</span> from Python.
<li><a accesskey="3" href="Python-Auto_002dloading.html#Python-Auto_002dloading">Python Auto-loading</a>: Automatically loading Python code.
<li><a accesskey="4" href="Python-modules.html#Python-modules">Python modules</a>: Python modules provided by <span class="sc">gdb</span>.
</ul>
</body></html>