Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed bug #834: Regenerate example xdebug.ini.

  • Loading branch information...
commit 3f4580a7e156f692d508a189533e8338dabd66ba 1 parent 527b138
Derick Rethans authored June 27, 2012

Showing 1 changed file with 103 additions and 22 deletions. Show diff stats Hide diff stats

  1. 125  xdebug.ini
125  xdebug.ini
@@ -9,7 +9,7 @@
9 9
 ; just before the script is run. This makes it possible to trace code in the
10 10
 ; auto_prepend_file [1].
11 11
 ; 
12  
-; [1] http://www.php.net/manual/en/ini.core.php#ini.auto-append-file
  12
+; [1] http://www.php.net/manual/en/configuration.directives.php#ini.auto-prepend-file
13 13
 ; 
14 14
 ;
15 15
 ;xdebug.auto_trace = 0
@@ -17,10 +17,21 @@
17 17
 ; -----------------------------------------------------------------------------
18 18
 ; xdebug.cli_color
19 19
 ;
20  
-; Type: boolean, Default value: 0
  20
+; Type: integer, Default value: 0
21 21
 ;
22 22
 ; If this setting is 1, Xdebug will color var_dumps and stack traces output when
23  
-; in CLI mode.
  23
+; in CLI mode and when the output is a tty. On Windows, the ANSICON [1] tool
  24
+; needs to be installed.
  25
+; 
  26
+; [1] http://adoxa.110mb.com/ansicon/
  27
+; 
  28
+; If the setting is 2, then Xdebug will always color var_dumps and stack trace,
  29
+; no matter whether it's connected to a tty or whether ANSICON is installed. In
  30
+; this case, you might end up seeing escape codes.
  31
+; 
  32
+; See this article [1] for some more information.
  33
+; 
  34
+; [1] http://drck.me/clicolor-9cr
24 35
 ; 
25 36
 ;
26 37
 ;xdebug.cli_color = 0
@@ -231,7 +242,12 @@
231 242
 ; %l         the line number
232 243
 ; =========  ===============
233 244
 ; 
234  
-; To make file/line links work with FireFox (Linux), use the following steps:
  245
+; For various IDEs/OSses there are some instructions listed on how to make this
  246
+; work:
  247
+; 
  248
+; ----------------
  249
+; Firefox on Linux
  250
+; ----------------
235 251
 ; 
236 252
 ; - Open
237 253
 ; 
@@ -239,7 +255,9 @@
239 255
 ; 
240 256
 ; - Add a new boolean setting "network.protocol-handler.expose.xdebug"
241 257
 ; 
242  
-; - Add the following into a shell script "~/bin/ff-xdebug.sh":
  258
+; - Add the following into a shell script
  259
+; 
  260
+;   ``~/bin/ff-xdebug.sh``:
243 261
 ; 
244 262
 ;     #! /bin/sh
245 263
 ;     
@@ -256,10 +274,60 @@
256 274
 ; 
257 275
 ; chmod +x ~/bin/ff-xdebug.sh
258 276
 ; 
259  
-; - Set the xdebug.file_link_format to
  277
+; - Set the xdebug.file_link_format setting to
260 278
 ; 
261 279
 ; xdebug://%f@%l
262 280
 ; 
  281
+; --------------------
  282
+; Windows and netbeans
  283
+; --------------------
  284
+; 
  285
+; - Create the file
  286
+; 
  287
+;   ``netbeans.bat`` and save it in your path ( ``C:\Windows`` will work):
  288
+; 
  289
+;     @echo off 
  290
+;     setlocal enableextensions enabledelayedexpansion 
  291
+;     set NETBEANS=%1
  292
+;     set FILE=%~2
  293
+;     %NETBEANS% --nosplash --console suppress --open "%FILE:~19%"
  294
+;     nircmd win activate process netbeans.exe
  295
+;     
  296
+;   **Note:** Remove the last line if you don't have ``nircmd``.
  297
+; 
  298
+; - Save the following code as
  299
+; 
  300
+;   ``netbeans_protocol.reg``:
  301
+; 
  302
+;     Windows Registry Editor Version 5.00
  303
+;     
  304
+;     [HKEY_CLASSES_ROOT\netbeans]
  305
+;     "URL Protocol"=""
  306
+;     @="URL:Netbeans Protocol"
  307
+;     
  308
+;     [HKEY_CLASSES_ROOT\netbeans\DefaultIcon]
  309
+;     @="\"C:\\Program Files\\NetBeans 7.1.1\\bin\\netbeans.exe,1\""
  310
+;     
  311
+;     [HKEY_CLASSES_ROOT\netbeans\shell]
  312
+;     
  313
+;     [HKEY_CLASSES_ROOT\netbeans\shell\open]
  314
+;     
  315
+;     [HKEY_CLASSES_ROOT\netbeans\shell\open\command]
  316
+;     @="\"C:\\Windows\\netbeans.bat\" \"C:\\Program Files\\NetBeans 7.1.1\\bin\\netbeans.exe\" \"%1\""
  317
+;     
  318
+;   **Note:** Make sure to change the path to Netbeans (twice), as well as the
  319
+;   ``netbeans.bat`` batch file if you saved it somewhere else than
  320
+;   ``C:\Windows\``.
  321
+; 
  322
+; - Double click on the
  323
+; 
  324
+;   ``netbeans_protocol.reg`` file to import it into the registry.
  325
+; 
  326
+; - Set the xdebug.file_link_format setting to
  327
+; 
  328
+; xdebug.file_link_format =
  329
+;     "netbeans://open/?f=%f:%l"
  330
+; 
263 331
 ;
264 332
 ;xdebug.file_link_format = 
265 333
 
@@ -272,7 +340,8 @@
272 340
 ; default is based on environment settings. First the environment setting
273 341
 ; DBGP_IDEKEY is consulted, then USER and as last USERNAME. The default is set
274 342
 ; to the first environment variable that is found. If none could be found the
275  
-; setting has as default ''.
  343
+; setting has as default ''. If this setting is set, it always overrides the
  344
+; environment variables.
276 345
 ; 
277 346
 ;
278 347
 ;xdebug.idekey = *complex*
@@ -596,18 +665,19 @@
596 665
 ; 1      writes a computer readable format which has two different records. There are
597 666
 ;        different records for entering a stack frame, and leaving a stack frame. The
598 667
 ;        table below lists the fields in each type of record. Fields are tab separated.
  668
+; -----  ------------------------------------------------------------------------------
  669
+; 2      writes a trace formatted in (simple) HTML.
599 670
 ; =====  ==============================================================================
600 671
 ; 
601 672
 ; Fields for the computerized format:
602 673
 ; 
603  
-; ===========  =====  ==========  ==========  ==========  ============  =============  =========================================  ================================  ========  ===========
604  
-; Record type  1      2           3           4           5             6              7                                          8                                 9         10
605  
-; ===========  =====  ==========  ==========  ==========  ============  =============  =========================================  ================================  ========  ===========
606  
-; 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
607  
-;                                                                                      function (0)                                                                           
608  
-; -----------  -----  ----------  ----------  ----------  ------------  -------------  -----------------------------------------  --------------------------------  --------  -----------
609  
-; Exit         level  function #  always '1'  time index  memory usage  empty                                                                                                 
610  
-; ===========  =====  ==========  ==========  ==========  ============  =============  =========================================  ================================  ========  ===========
  674
+; ===========  =====  ===========  ===========  ==========  ============  =============  ===========================================  ================================  ========  ===========
  675
+; Record type  1      2            3            4           5             6              7                                            8                                 9         10
  676
+; ===========  =====  ===========  ===========  ==========  ============  =============  ===========================================  ================================  ========  ===========
  677
+; 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
  678
+; -----------  -----  -----------  -----------  ----------  ------------  -------------  -------------------------------------------  --------------------------------  --------  -----------
  679
+; Exit         level  function #   always '1'   time index  memory usage  empty                                                                                                   
  680
+; ===========  =====  ===========  ===========  ==========  ============  =============  ===========================================  ================================  ========  ===========
611 681
 ; 
612 682
 ; See the introduction of Function Traces for a few examples.
613 683
 ; 
@@ -692,9 +762,12 @@
692 762
 ;
693 763
 ; Controls the amount of array children and object's properties are shown when
694 764
 ; variables are displayed with either xdebug_var_dump(), xdebug.show_local_vars
695  
-; or through Function Traces. This setting does not have any influence on the
696  
-; number of children that is send to the client through the Remote Debugging
697  
-; feature.
  765
+; or through Function Traces.
  766
+; 
  767
+; To disable any limitation, use *-1* as value.
  768
+; 
  769
+; This setting does not have any influence on the number of children that is
  770
+; send to the client through the Remote Debugging feature.
698 771
 ; 
699 772
 ;
700 773
 ;xdebug.var_display_max_children = 128
@@ -706,7 +779,11 @@
706 779
 ;
707 780
 ; Controls the maximum string length that is shown when variables are displayed
708 781
 ; with either xdebug_var_dump(), xdebug.show_local_vars or through Function
709  
-; Traces. This setting does not have any influence on the amount of data that is
  782
+; Traces.
  783
+; 
  784
+; To disable any limitation, use *-1* as value.
  785
+; 
  786
+; This setting does not have any influence on the number of children that is
710 787
 ; send to the client through the Remote Debugging feature.
711 788
 ; 
712 789
 ;
@@ -719,9 +796,13 @@
719 796
 ;
720 797
 ; Controls how many nested levels of array elements and object properties are
721 798
 ; when variables are displayed with either xdebug_var_dump(),
722  
-; xdebug.show_local_vars or through Function Traces. This setting does not have
723  
-; any influence on the depth of children that is send to the client through the
724  
-; Remote Debugging feature.
  799
+; xdebug.show_local_vars or through Function Traces.
  800
+; 
  801
+; The maximum value you can select is 1023. You can also use *-1* as value to
  802
+; select this maximum number.
  803
+; 
  804
+; This setting does not have any influence on the number of children that is
  805
+; send to the client through the Remote Debugging feature.
725 806
 ; 
726 807
 ;
727 808
 ;xdebug.var_display_max_depth = 3

0 notes on commit 3f4580a

Please sign in to comment.
Something went wrong with that request. Please try again.