Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fixed bug #834: Regenerate example xdebug.ini.

  • Loading branch information...
commit 3f4580a7e156f692d508a189533e8338dabd66ba 1 parent 527b138
@derickr authored
Showing with 103 additions and 22 deletions.
  1. +103 −22 xdebug.ini
View
125 xdebug.ini
@@ -9,7 +9,7 @@
; just before the script is run. This makes it possible to trace code in the
; auto_prepend_file [1].
;
-; [1] http://www.php.net/manual/en/ini.core.php#ini.auto-append-file
+; [1] http://www.php.net/manual/en/configuration.directives.php#ini.auto-prepend-file
;
;
;xdebug.auto_trace = 0
@@ -17,10 +17,21 @@
; -----------------------------------------------------------------------------
; xdebug.cli_color
;
-; Type: boolean, Default value: 0
+; Type: integer, Default value: 0
;
; If this setting is 1, Xdebug will color var_dumps and stack traces output when
-; in CLI mode.
+; in CLI mode and when the output is a tty. On Windows, the ANSICON [1] tool
+; needs to be installed.
+;
+; [1] http://adoxa.110mb.com/ansicon/
+;
+; If the setting is 2, then Xdebug will always color var_dumps and stack trace,
+; no matter whether it's connected to a tty or whether ANSICON is installed. In
+; this case, you might end up seeing escape codes.
+;
+; See this article [1] for some more information.
+;
+; [1] http://drck.me/clicolor-9cr
;
;
;xdebug.cli_color = 0
@@ -231,7 +242,12 @@
; %l the line number
; ========= ===============
;
-; To make file/line links work with FireFox (Linux), use the following steps:
+; For various IDEs/OSses there are some instructions listed on how to make this
+; work:
+;
+; ----------------
+; Firefox on Linux
+; ----------------
;
; - Open
;
@@ -239,7 +255,9 @@
;
; - Add a new boolean setting "network.protocol-handler.expose.xdebug"
;
-; - Add the following into a shell script "~/bin/ff-xdebug.sh":
+; - Add the following into a shell script
+;
+; ``~/bin/ff-xdebug.sh``:
;
; #! /bin/sh
;
@@ -256,10 +274,60 @@
;
; chmod +x ~/bin/ff-xdebug.sh
;
-; - Set the xdebug.file_link_format to
+; - Set the xdebug.file_link_format setting to
;
; xdebug://%f@%l
;
+; --------------------
+; Windows and netbeans
+; --------------------
+;
+; - Create the file
+;
+; ``netbeans.bat`` and save it in your path ( ``C:\Windows`` will work):
+;
+; @echo off
+; setlocal enableextensions enabledelayedexpansion
+; set NETBEANS=%1
+; set FILE=%~2
+; %NETBEANS% --nosplash --console suppress --open "%FILE:~19%"
+; nircmd win activate process netbeans.exe
+;
+; **Note:** Remove the last line if you don't have ``nircmd``.
+;
+; - Save the following code as
+;
+; ``netbeans_protocol.reg``:
+;
+; Windows Registry Editor Version 5.00
+;
+; [HKEY_CLASSES_ROOT\netbeans]
+; "URL Protocol"=""
+; @="URL:Netbeans Protocol"
+;
+; [HKEY_CLASSES_ROOT\netbeans\DefaultIcon]
+; @="\"C:\\Program Files\\NetBeans 7.1.1\\bin\\netbeans.exe,1\""
+;
+; [HKEY_CLASSES_ROOT\netbeans\shell]
+;
+; [HKEY_CLASSES_ROOT\netbeans\shell\open]
+;
+; [HKEY_CLASSES_ROOT\netbeans\shell\open\command]
+; @="\"C:\\Windows\\netbeans.bat\" \"C:\\Program Files\\NetBeans 7.1.1\\bin\\netbeans.exe\" \"%1\""
+;
+; **Note:** Make sure to change the path to Netbeans (twice), as well as the
+; ``netbeans.bat`` batch file if you saved it somewhere else than
+; ``C:\Windows\``.
+;
+; - Double click on the
+;
+; ``netbeans_protocol.reg`` file to import it into the registry.
+;
+; - Set the xdebug.file_link_format setting to
+;
+; xdebug.file_link_format =
+; "netbeans://open/?f=%f:%l"
+;
;
;xdebug.file_link_format =
@@ -272,7 +340,8 @@
; default is based on environment settings. First the environment setting
; DBGP_IDEKEY is consulted, then USER and as last USERNAME. The default is set
; to the first environment variable that is found. If none could be found the
-; setting has as default ''.
+; setting has as default ''. If this setting is set, it always overrides the
+; environment variables.
;
;
;xdebug.idekey = *complex*
@@ -596,18 +665,19 @@
; 1 writes a computer readable format which has two different records. There are
; different records for entering a stack frame, and leaving a stack frame. The
; table below lists the fields in each type of record. Fields are tab separated.
+; ----- ------------------------------------------------------------------------------
+; 2 writes a trace formatted in (simple) HTML.
; ===== ==============================================================================
;
; Fields for the computerized format:
;
-; =========== ===== ========== ========== ========== ============ ============= ========================================= ================================ ======== ===========
-; Record type 1 2 3 4 5 6 7 8 9 10
-; =========== ===== ========== ========== ========== ============ ============= ========================================= ================================ ======== ===========
-; Entry level function # always '0' time index memory usage function name user-defined (1) or internal name of the include/require file filename line number
-; function (0)
-; ----------- ----- ---------- ---------- ---------- ------------ ------------- ----------------------------------------- -------------------------------- -------- -----------
-; Exit level function # always '1' time index memory usage empty
-; =========== ===== ========== ========== ========== ============ ============= ========================================= ================================ ======== ===========
+; =========== ===== =========== =========== ========== ============ ============= =========================================== ================================ ======== ===========
+; Record type 1 2 3 4 5 6 7 8 9 10
+; =========== ===== =========== =========== ========== ============ ============= =========================================== ================================ ======== ===========
+; Entry level function # always '0' time index memory usage function name user-defined (1) or internal function (0) name of the include/require file filename line number
+; ----------- ----- ----------- ----------- ---------- ------------ ------------- ------------------------------------------- -------------------------------- -------- -----------
+; Exit level function # always '1' time index memory usage empty
+; =========== ===== =========== =========== ========== ============ ============= =========================================== ================================ ======== ===========
;
; See the introduction of Function Traces for a few examples.
;
@@ -692,9 +762,12 @@
;
; Controls the amount of array children and object's properties are shown when
; variables are displayed with either xdebug_var_dump(), xdebug.show_local_vars
-; or through Function Traces. This setting does not have any influence on the
-; number of children that is send to the client through the Remote Debugging
-; feature.
+; or through Function Traces.
+;
+; To disable any limitation, use *-1* as value.
+;
+; This setting does not have any influence on the number of children that is
+; send to the client through the Remote Debugging feature.
;
;
;xdebug.var_display_max_children = 128
@@ -706,7 +779,11 @@
;
; Controls the maximum string length that is shown when variables are displayed
; with either xdebug_var_dump(), xdebug.show_local_vars or through Function
-; Traces. This setting does not have any influence on the amount of data that is
+; Traces.
+;
+; To disable any limitation, use *-1* as value.
+;
+; This setting does not have any influence on the number of children that is
; send to the client through the Remote Debugging feature.
;
;
@@ -719,9 +796,13 @@
;
; Controls how many nested levels of array elements and object properties are
; when variables are displayed with either xdebug_var_dump(),
-; xdebug.show_local_vars or through Function Traces. This setting does not have
-; any influence on the depth of children that is send to the client through the
-; Remote Debugging feature.
+; xdebug.show_local_vars or through Function Traces.
+;
+; The maximum value you can select is 1023. You can also use *-1* as value to
+; select this maximum number.
+;
+; This setting does not have any influence on the number of children that is
+; send to the client through the Remote Debugging feature.
;
;
;xdebug.var_display_max_depth = 3
Please sign in to comment.
Something went wrong with that request. Please try again.