php-doc-en/reference/phpdbg/book.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="book.phpdbg" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <?phpdoc extension-membership="bundled" ?>
 <title>Interactive PHP Debugger</title>
 <titleabbrev>phpdbg</titleabbrev>

 <preface xml:id="intro.phpdbg">
  &reftitle.intro;
  <para>
   Implemented as a SAPI module, phpdbg can exert complete control over the
   environment without impacting the functionality or performance of your code.
  </para>
  <para>
   phpdbg aims to be a lightweight, powerful, easy to use debugging platform for PHP.
   It offers the following features:
   <itemizedlist>
    <listitem>
     <simpara>Step-Through Debugging</simpara>
    </listitem>
    <listitem>
     <simpara>Flexible Breakpoints (Class Method, Function, File:Line, Address, Opcode)</simpara>
    </listitem>
    <listitem>
     <simpara>Easy Access to PHP with built-in eval()</simpara>
    </listitem>
    <listitem>
     <simpara>Userland API</simpara>
    </listitem>
    <listitem>
     <simpara>SAPI Agnostic - Easily Integrated</simpara>
    </listitem>
    <listitem>
     <simpara>PHP Configuration File Support</simpara>
    </listitem>
    <listitem>
     <simpara>JIT Super Globals - Set Your Own !!</simpara>
    </listitem>
    <listitem>
     <simpara>Optional readline Support - Comfortable Terminal Operation</simpara>
    </listitem>
    <listitem>
     <simpara>Easy Operation - See Help :)</simpara>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   <table>
    <title>Command line options</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Option</entry>
       <entry>Example Argument</entry>
       <entry>Description</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>-c</entry>
       <entry>-c/my/php.ini</entry>
       <entry>
        Set php.ini file to load
       </entry>
      </row>
      <row>
       <entry>-d</entry>
       <entry>-dmemory_limit=4G</entry>
       <entry>
        Set a php.ini directive
       </entry>
      </row>
      <row>
       <entry>-n</entry>
       <entry></entry>
       <entry>
        Disable default php.ini
       </entry>
      </row>
      <row>
       <entry>-q</entry>
       <entry></entry>
       <entry>
        Suppress welcome banner
       </entry>
      </row>
      <row>
       <entry>-v</entry>
       <entry></entry>
       <entry>
        Enable oplog output
       </entry>
      </row>
      <row>
       <entry>-b</entry>
       <entry></entry>
       <entry>
        Disable color
       </entry>
      </row>
      <row>
       <entry>-i</entry>
       <entry>-imy.init</entry>
       <entry>
        Set .phpdbginit file
       </entry>
      </row>
      <row>
       <entry>-I</entry>
       <entry></entry>
       <entry>
        Ignore default .phpdbginit
       </entry>
      </row>
      <row>
       <entry>-O</entry>
       <entry>-Omy.oplog</entry>
       <entry>
        Set oplog output file
       </entry>
      </row>
      <row>
       <entry>-r</entry>
       <entry></entry>
       <entry>
        Run execution context
       </entry>
      </row>
      <row>
       <entry>-rr</entry>
       <entry></entry>
       <entry>
        Run execution context and quit after execution (not respecting breakpoints)
       </entry>
      </row>
      <row>
       <entry>-e</entry>
       <entry></entry>
       <entry>
        Generate extended information for debugger/profiler
       </entry>
      </row>
      <row>
       <entry>-E</entry>
       <entry></entry>
       <entry>
        Enable step through eval, careful!
       </entry>
      </row>
      <row>
       <entry>-s</entry>
       <entry>-s=, -s=foo</entry>
       <entry>
        Read code to execute from stdin with an optional delimiter
       </entry>
      </row>
      <row>
       <entry>-S</entry>
       <entry>-Scli</entry>
       <entry>
        Override SAPI name, careful!
       </entry>
      </row>
      <row>
       <entry></entry>
       <entry></entry>
       <entry>
        <para>
        </para>
       </entry>
      </row>
      <row>
       <entry>-l</entry>
       <entry>-l4000</entry>
       <entry>
        Setup remote console ports
       </entry>
      </row>
      <row>
       <entry>-a</entry>
       <entry>-a192.168.0.3</entry>
       <entry>
        Setup remote console bind address
       </entry>
      </row>
      <row>
       <entry>-x</entry>
       <entry></entry>
       <entry>
        Enable xml output (instead of normal text output)
       </entry>
      </row>
      <row>
       <entry>-p</entry>
       <entry>-p, -p=func, -p*</entry>
       <entry>
        Output opcodes and quit
       </entry>
      </row>
      <row>
       <entry>-h</entry>
       <entry></entry>
       <entry>
        Print the help overview
       </entry>
      </row>
      <row>
       <entry>-V</entry>
       <entry></entry>
       <entry>
        Print version number
       </entry>
      </row>
      <row>
       <entry>--</entry>
       <entry>-- arg1 arg2</entry>
       <entry>
        Use to delimit phpdbg arguments and php $argv; append any $argv argument after it
       </entry>
      </row>
     </tbody>
    </tgroup> 
   </table> 
  </para>

 </preface>

 &reference.phpdbg.setup;
 &reference.phpdbg.constants;
 &reference.phpdbg.reference;

</book>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->