Lines Matching refs:CR
343 #define CR "\n" macro
347 {"overview!", CR
348 "**phpdbg** is a lightweight, powerful and easy to use debugging platform for PHP5.4+" CR
349 "It supports the following commands:" CR CR
351 "**Information**" CR
352 " **list** list PHP source" CR
353 " **info** displays information on the debug session" CR
354 " **print** show opcodes" CR
355 " **frame** select a stack frame and print a stack frame summary" CR
356 " **generator** show active generators or select a generator frame" CR
357 " **back** shows the current backtrace" CR
358 " **help** provide help on a topic" CR CR
360 "**Starting and Stopping Execution**" CR
361 " **exec** set execution context" CR
362 " **stdin** set executing script from stdin" CR
363 " **run** attempt execution" CR
364 " **step** continue execution until other line is reached" CR
365 " **continue** continue execution" CR
366 " **until** continue execution up to the given location" CR
367 " **next** continue execution up to the given location and halt on the first line after it" CR
368 " **finish** continue up to end of the current execution frame" CR
369 …** continue up to end of the current execution frame and halt after the calling instruction" CR
370 " **break** set a breakpoint at the specified target" CR
371 " **watch** set a watchpoint on $variable" CR
372 " **clear** clear one or all breakpoints" CR
373 " **clean** clean the execution environment" CR CR
375 "**Miscellaneous**" CR
376 " **set** set the phpdbg configuration" CR
377 " **source** execute a phpdbginit script" CR
378 " **register** register a phpdbginit function as a command alias" CR
379 " **sh** shell a command" CR
380 " **ev** evaluate some code" CR
381 " **quit** exit phpdbg" CR CR
386 "but **help ex** will list the summary for **exec** and **export**." CR CR
388 "Type **help aliases** to show a full alias list, including any registered phpdginit functions" CR
389 "Type **help syntax** for a general introduction to the command syntax." CR
390 "Type **help options** for a list of phpdbg command line options." CR
393 {"options", CR
394 "Below are the command line options supported by phpdbg" CR CR
396 "**Command Line Options and Flags**" CR
397 " **Option** **Example Argument** **Description**" CR
398 " **-c** **-c**/my/php.ini Set php.ini file to load" CR
399 " **-d** **-d**memory_limit=4G Set a php.ini directive" CR
400 " **-n** Disable default php.ini" CR
401 " **-q** Suppress welcome banner" CR
402 " **-v** Enable oplog output" CR
403 " **-b** Disable colour" CR
404 " **-i** **-i**my.init Set .phpdbginit file" CR
405 " **-I** Ignore default .phpdbginit" CR
406 " **-O** **-O**my.oplog Sets oplog output file" CR
407 " **-r** Run execution context" CR
408 … Run execution context and quit after execution (not respecting breakpoints)" CR
409 " **-e** Generate extended information for debugger/profiler" CR
410 " **-E** Enable step through eval, careful!" CR
411 …s** **-s=**, **-s**=foo Read code to execute from stdin with an optional delimiter" CR
412 " **-S** **-S**cli Override SAPI name, careful!" CR
413 " **-l** **-l**4000 Setup remote console ports" CR
414 " **-a** **-a**192.168.0.3 Setup remote console bind address" CR
415 " **-x** Enable xml output (instead of normal text output)" CR
416 " **-p** **-p**, **-p=func**, **-p* ** Output opcodes and quit" CR
417 " **-h** Print the help overview" CR
418 " **-V** Print version number" CR
420 "argument after it" CR CR
422 "**Reading from stdin**" CR CR
427 "it will read until EOF. See also the help entry for the **stdin** command." CR CR
429 "**Remote Console Mode**" CR CR
436 "interface/port." CR CR
438 "**Opcode output**" CR CR
440 "Outputting opcodes requires that a file path is passed as last argument. Modes of execution:" CR
441 "**-p** Outputs the main execution context" CR
442 "**-p* **Outputs all opcodes in the whole file (including classes and functions)" CR
443 "**-p=function_name** Outputs opcodes of a given function in the file" CR
444 "**-p=class_name::** Outputs opcodes of all the methods of a given class" CR
448 {"phpdbginit", CR
452 "details)." CR CR
454 "Debugger scripts can also be executed using the **source** command." CR CR
457 "code. " CR CR
460 "files and not in interactive sessions." CR CR
464 "and **register** PHP functions as new commands." CR CR
470 {"syntax", CR
475 "than by substitution by the alias." CR CR
477 "Some commands take an argument. Arguments are typed according to their format:" CR
478 " * **omitted**" CR
479 " * **address** **0x** followed by a hex string" CR
480 " * **number** an optionally signed number" CR
481 " * **method** a valid **Class::methodName** expression" CR
482 " * **func#op** a valid **Function name** follow by # and an integer" CR
483 " * **method#op** a valid **Class::methodName** follow by # and an integer" CR
484 " * **string** a general string" CR
485 " * **function** a valid **Function name**" CR
486 " * **file:line** a valid **filename** follow by : and an integer" CR CR
488 "In some cases the type of the argument enables the second keyword to be omitted." CR CR
491 "on any specific command." CR CR
493 "**Valid Examples**" CR CR
495 " $P quit" CR
496 " $P q" CR
497 " Quit the debugger" CR CR
499 " $P ev $total[2]" CR
500 " Evaluate and print the variable $total[2] in the current stack frame" CR
501 " " CR
502 " $P break 200" CR
503 " $P b my_source.php:200" CR
504 " Break at line 200 in the current source and in file **my_source.php**. " CR CR
506 " $P b @ ClassX::get_args if $arg[0] == \"fred\"" CR
507 " $P b ~ 3" CR
508 " Break at ClassX::get_args() if $arg[0] == \"fred\" and delete breakpoint 3" CR CR
510 "**Examples of invalid commands**" CR
512 " $P #This is a comment" CR
517 {"aliases!", CR
519 "is a synomyn for **info break** and **l func** for **list func**, etc." CR CR
524 {"duplicate!", CR
532 "a complete backtrace is given." CR CR
534 "**Examples**" CR CR
535 " $P back 5" CR
536 " $P t " CR
537 " " CR
544 "types:" CR CR
546 " **Target** **Alias** **Purpose**" CR
547 " **at** **@** specify breakpoint by location and condition" CR
548 " **del** **~** delete breakpoint by breakpoint identifier number" CR CR
552 "execution, if evaluated as true in a boolean context at the specified target." CR CR
554 "Note that breakpoints can also be disabled and re-enabled by the **set break** command." CR CR
556 "**Examples**" CR CR
557 " $P break test.php:100" CR
558 " $P b test.php:100" CR
559 " Break execution at line 100 of test.php" CR CR
561 " $P break 200" CR
562 " $P b 200" CR
563 " Break execution at line 200 of the currently PHP script file" CR CR
565 " $P break \\\\mynamespace\\\\my_function" CR
566 " $P b \\\\mynamespace\\\\my_function" CR
567 " Break execution on entry to \\\\mynamespace\\\\my_function" CR CR
569 " $P break classX::method" CR
570 " $P b classX::method" CR
571 " Break execution on entry to classX::method" CR CR
573 " $P break 0x7ff68f570e08" CR
574 " $P b 0x7ff68f570e08" CR
575 " Break at the opline at the address 0x7ff68f570e08" CR CR
577 " $P break my_function#14" CR
578 " $P b my_function#14" CR
579 " Break at the opline #14 of the function my_function" CR CR
581 " $P break \\\\my\\\\class::method#2" CR
582 " $P b \\\\my\\\\class::method#2" CR
583 " Break at the opline #2 of the method \\\\my\\\\class::method" CR CR
585 " $P break test.php:#3" CR
586 " $P b test.php:#3" CR
587 " Break at opline #3 in test.php" CR CR
589 " $P break if $cnt > 10" CR
590 " $P b if $cnt > 10" CR
591 " Break when the condition ($cnt > 10) evaluates to true" CR CR
593 " $P break at phpdbg::isGreat if $opt == 'S'" CR
594 " $P break @ phpdbg::isGreat if $opt == 'S'" CR
595 " Break at any opcode in phpdbg::isGreat when the condition ($opt == 'S') is true" CR CR
597 " $P break at test.php:20 if !isset($x)" CR
598 " Break at every opcode on line 20 of test.php when the condition evaluates to true" CR CR
600 " $P break ZEND_ADD" CR
601 " $P b ZEND_ADD" CR
602 " Break on any occurrence of the opcode ZEND_ADD" CR CR
604 " $P break del 2" CR
605 " $P b ~ 2" CR
606 " Remove breakpoint 2" CR CR
609 "as they significantly slow execution." CR CR
619 "take place." CR CR
626 "Clearing breakpoints means you can once again run code without interruption." CR CR
628 "Note: use break delete N to clear a specific breakpoint." CR CR
636 "been explicitly changed by issuing a **frame** command. " CR CR
638 "**Examples**" CR CR
639 " $P ev $variable" CR
640 " Will print_r($variable) on the console, if it is defined" CR CR
642 " $P ev $variable = \"Hello phpdbg :)\"" CR
643 " Will set $variable in the current scope" CR CR
647 "is needed here. You can even call PHP functions which have breakpoints defined. " CR CR
655 "**-e** command line option." CR CR
658 "context." CR CR
660 "**Examples**" CR CR
662 " $P exec /tmp/script.php" CR
663 " $P e /tmp/script.php" CR
671 "also passed - in that case it will just read until EOF)." CR
672 "This input will be then compiled as PHP code and set as execution context." CR CR
674 "**Example**" CR CR
676 " $P stdin foo" CR
677 " <?php" CR
678 " echo \"Hello, world!\\n\";" CR
687 "completion of the script" CR CR
690 "skipped. "CR CR
698 …allowing access to the variables in a higher stack frame than that currently being executed." CR CR
700 "**Examples**" CR CR
701 " $P frame 2" CR
702 " $P ev $count" CR
703 " Go to frame 2 and print out variable **$count** in that frame" CR CR
713 "not in the current **back** trace." CR CR
715 "**Examples**" CR CR
716 " $P generator" CR
717 " List of generators, with the #id being the object handle, e.g.:" CR
718 " #3: my_generator(argument=\"value\") at test.php:5" CR
719 " $P g 3" CR
720 " $P ev $i" CR
721 … Go to frame of generator with object handle 3 and print out variable **$i** in that frame" CR CR
728 …*info** commands provide quick access to various types of information about the PHP environment" CR
729 "By default general information about environment and PHP build is shown." CR
730 "Specific info commands are show below:" CR CR
732 " **Target** **Alias** **Purpose**" CR
733 " **break** **b** show current breakpoints" CR
734 " **files** **F** show included files" CR
735 " **classes** **c** show loaded classes" CR
736 " **funcs** **f** show loaded functions" CR
737 " **error** **e** show last error" CR
738 " **constants** **d** show user-defined constants" CR
739 " **vars** **v** show active variables" CR
740 " **globals** **g** show superglobal variables" CR
741 " **literal** **l** show active literal constants" CR
751 "variables including the return value before it is returned" CR CR
753 "**Examples**" CR CR
755 " $P leave" CR
756 " $P L" CR CR
759 "skipped. "CR CR
766 "a second subcommand keyword:" CR CR
768 " **Type** **Alias** **Purpose**" CR
769 " **lines** **l** List N lines from the current execution point" CR
770 " **func** **f** List the complete source for a specified function" CR
771 " **method** **m** List the complete source for a specified class::method" CR
772 " **class** **c** List the complete source for a specified class" CR CR
776 "to list off a class." CR CR
778 "**Examples**" CR CR
779 " $P list 2" CR
780 " $P l l 2" CR
781 " List the next 2 lines from the current file" CR CR
783 " $P list my_function" CR
784 " $P l f my_function" CR
785 " List the source of the function **my_function**" CR CR
788 " $P list func .mine" CR
789 " $P l f .mine" CR
790 " List the source of the method **mine** from the active class in scope" CR CR
792 " $P list m my::method" CR
793 " $P l my::method" CR
794 " List the source of **my::method**" CR CR
796 " $P list c myClass" CR
797 " $P l c myClass" CR
798 " List the source of **myClass**" CR CR
806 "Continue with execution after hitting a break or watchpoint" CR CR
808 "**Examples**" CR CR
809 " $P continue" CR
810 " $P c" CR
811 " Continue executing until the next break or watchpoint" CR CR
817 "By default, print will show the opcodes of the current execution context." CR
818 "Other printing commands give access to instruction information." CR
819 "Specific printers loaded are show below:" CR CR
821 " **Type** **Alias** **Purpose**" CR
822 " **exec** **e** print out the instructions in the execution context" CR
823 " **opline** **o** print out the instruction in the current opline" CR
824 " **class** **c** print out the instructions in the specified class" CR
825 " **method** **m** print out the instructions in the specified method" CR
826 " **func** **f** print out the instructions in the specified function" CR
827 " **stack** **s** print out the instructions in the current stack" CR CR
829 …specific printing command, it will treat it as function or method name and print its opcodes" CR CR
831 "**Examples**" CR CR
832 " $P print class \\\\my\\\\class" CR
833 " $P p c \\\\my\\\\class" CR
834 " Print the instructions for the methods in \\\\my\\\\class" CR CR
836 " $P print method \\\\my\\\\class::method" CR
837 " $P p m \\\\my\\\\class::method" CR
838 " Print the instructions for \\\\my\\\\class::method" CR CR
840 " $P print func .getSomething" CR
841 " $P p f .getSomething" CR
843 " Print the instructions for ::getSomething in the active scope" CR CR
845 " $P print func my_function" CR
846 " $P p f my_function" CR
847 " Print the instructions for the global function my_function" CR CR
849 " $P print opline" CR
850 " $P p o" CR
851 " Print the instruction for the current opline" CR CR
853 " $P print exec" CR
854 " $P p e" CR
855 " Print the instructions for the execution context" CR CR
857 " $P print stack" CR
858 " $P p s" CR
864 "Register any global function for use as a command in phpdbg console" CR CR
866 "**Examples**" CR CR
867 " $P register scandir" CR
868 " $P R scandir" CR
869 " Will register the scandir function for use in phpdbg" CR CR
877 "**< filename** for reading STDIN from a file." CR CR
879 "**Examples**" CR CR
881 " $P run" CR
882 " $P r" CR
883 " Will cause execution of the context, if it is set" CR CR
884 " $P r test < foo.txt" CR
885 " Will execute with $argv[1] == \"test\" and read from the foo.txt file for STDIN" CR CR
893 "are as follows:" CR CR
895 " **Type** **Alias** **Purpose**" CR
896 " **prompt** **p** set the prompt" CR
897 " **color** **c** set color <element> <color>" CR
898 " **colors** **C** set colors [<on|off>]" CR
899 " **oplog** **O** set oplog [output]" CR
900 " **break** **b** set break **id** <on|off>" CR
901 " **breaks** **B** set breaks [<on|off>]" CR
902 " **quiet** **q** set quiet [<on|off>]" CR
903 " **stepping** **s** set stepping [<opcode|line>]" CR
904 " **refcount** **r** set refcount [<on|off>] " CR CR
908 "**-bold** or **-underline** qualifier." CR CR
910 "Color elements can be one of **prompt**, **notice**, or **error**." CR CR
912 "**Examples**" CR CR
913 " $P S C on" CR
914 " Set colors on" CR CR
916 " $P set p >" CR
917 " $P set color prompt white-bold" CR
918 " Set the prompt to a bold >" CR CR
920 " $P S c error red-bold" CR
921 " Use red bold for errors" CR CR
923 " $P S refcount on" CR
924 " Enable refcount display when hitting watchpoints" CR CR
926 " $P S b 4 off" CR
927 " Temporarily disable breakpoint 4. This can be subsequently reenabled by a **S b 4 on**." CR
932 "Direct access to shell commands saves having to switch windows/consoles" CR CR
934 "**Examples**" CR CR
935 " $P sh ls /usr/src/php-src" CR
941 "Sourcing a **phpdbginit** script during your debugging session might save some time." CR CR
943 "**Examples**" CR CR
945 " $P source /my/init" CR
946 " $P < /my/init" CR
947 " Will execute the phpdbginit file at /my/init" CR CR
951 "Exporting breakpoints allows you to share, and or save your current debugging session" CR CR
953 "**Examples**" CR CR
955 " $P export /my/exports" CR
956 " $P > /my/exports" CR
957 " Will export all breakpoints to /my/exports" CR CR
961 "Execute opcodes until next line" CR CR
963 "**Examples**" CR CR
965 " $P s" CR
966 " Will continue and break again in the next encountered line" CR CR
971 "be stopped when that line is left." CR CR
973 …ote when **step**ping is enabled, any opcode steps within the current line are also skipped. "CR CR
976 "skipped. " CR CR
984 "will then continue until the next breakpoint or completion of the script" CR CR
986 …ote when **step**ping is enabled, any opcode steps within the current line are also skipped. "CR CR
989 "skipped. " CR CR
995 "Sets watchpoints on variables as long as they are defined" CR
996 "Passing no parameter to **watch**, lists all actually active watchpoints" CR CR
998 "**Format for $variable**" CR CR
999 " **$var** Variable $var" CR
1000 " **$var[]** All array elements of $var" CR
1001 " **$var->** All properties of $var" CR
1002 " **$var->a** Property $var->a" CR
1003 " **$var[b]** Array element with key b in array $var" CR CR
1005 "Subcommands of **watch**:" CR CR
1007 " **Type** **Alias** **Purpose**" CR
1008 …** **a** Sets watchpoint on array/object to observe if an entry is added or removed" CR
1009 …riable recursively and automatically adds watchpoints if some entry is added to an array/object" CR
1010 " **delete** **d** Removes watchpoint" CR CR
1012 … when **recursive** watchpoints are removed, watchpoints on all the children are removed too" CR CR
1014 "**Examples**" CR CR
1015 " $P watch" CR
1016 " List currently active watchpoints" CR CR
1018 " $P watch $array" CR
1019 " $P w $array" CR
1020 " Set watchpoint on $array" CR CR
1022 " $P watch recursive $obj->" CR
1023 " $P w r $obj->" CR
1024 " Set recursive watchpoint on $obj->" CR CR
1026 " $P watch delete $obj->a" CR
1027 " $P w d $obj->a" CR
1028 " Remove watchpoint $obj->a" CR CR
1030 …get many segmentation faults, each time when a memory page containing a watched address is hit." CR
1031 …en you can continue, phpdbg will remove the write protection, so that the program can continue." CR
