GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — doc-en/features/commandline.xml at master · php/doc-en Expand file tree/ Copy pathcommandline.xmlMore file actions 1982 lines (1874 loc) · 59.7 KB / Copy pathcommandline.xmlFile metadata and controls1982 lines (1874 loc) · 59.7 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 <?xml version="1.0" encoding="utf-8"?> <!-- $Revision$ --> <chapter xml:id="features.commandline" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>Using PHP from the command line</title> <titleabbrev>Command line usage</titleabbrev> <section xml:id="features.commandline.introduction" annotations="chunk:false"> <title>Introduction</title> <para> The main focus of &cli.sapi; is for developing shell applications with PHP. There are quite a few differences between the &cli.sapi; and other <acronym>SAPI</acronym>s which are explained in this chapter. It is worth mentioning that &cli; and <acronym>CGI</acronym> are different <acronym>SAPI</acronym>s although they do share many of the same behaviors. </para> <para> The &cli.sapi; is enabled by default using <option role="configure">--enable-cli</option>, but may be disabled using the <option role="configure">--disable-cli</option> option when running <command>./configure</command>. </para> <para> The name, location and existence of the &cli;/<acronym>CGI</acronym> binaries will differ depending on how PHP is installed on your system. By default when executing <command>make</command>, both the <acronym>CGI</acronym> and &cli; are built and placed as <filename>sapi/cgi/php-cgi</filename> and <filename>sapi/cli/php</filename> respectively, in your PHP source directory. You will note that both are named <filename>php</filename>. What happens during <command>make install</command> depends on your configure line. If a module <acronym>SAPI</acronym> is chosen during configure, such as apxs, or the <option role="configure">--disable-cgi</option> option is used, the &cli; is copied to <filename>{PREFIX}/bin/php</filename> during <command>make install</command> otherwise the <acronym>CGI</acronym> is placed there. So, for example, if <option role="configure">--with-apxs</option> is in your configure line then the &cli; is copied to <filename>{PREFIX}/bin/php </filename> during <command>make install</command>. If you want to override the installation of the <acronym>CGI</acronym> binary, use <command>make install-cli</command> after <command>make install</command>. Alternatively you can specify <option role="configure">--disable-cgi</option> in your configure line. </para> <note> <para> Because both <option role="configure">--enable-cli</option> and <option role="configure">--enable-cgi</option> are enabled by default, simply having <option role="configure">--enable-cli</option> in your configure line does not necessarily mean the &cli; will be copied as <filename>{PREFIX}/bin/php</filename> during <command>make install</command>. </para> </note> <para> The &cli; binary is distributed in the main folder as <filename> php.exe</filename> on Windows. The <acronym>CGI</acronym> version is distributed as <filename>php-cgi.exe</filename>. Additionally, a <filename> php-win.exe</filename> is distributed if PHP is configured using <option role="configure">--enable-cli-win32</option>. This does the same as the &cli; version, except that it doesn't output anything and thus provides no console. </para> <note> <title>What SAPI do I have?</title> <para> From a shell, typing <command>php -v</command> will tell you whether <filename>php</filename> is <acronym>CGI</acronym> or &cli;. See also the function <function>php_sapi_name</function> and the constant <constant>PHP_SAPI</constant>. </para> </note> <note> <para> A Unix <literal>man</literal>ual page is available by typing <command>man php</command> in the shell environment. </para> </note> </section> <section xml:id="features.commandline.differences"> <title>Differences from other <acronym>SAPI</acronym>s</title> <para> Remarkable differences of the &cli; <acronym>SAPI</acronym> compared to other <acronym>SAPI</acronym>s: <itemizedlist> <listitem> <para> Unlike the <acronym>CGI</acronym> <acronym>SAPI</acronym>, no headers are written to the output. </para> <para> Though the <acronym>CGI</acronym> <acronym>SAPI</acronym> provides a way to suppress HTTP headers, there's no equivalent switch to enable them in the &cli.sapi;. </para> <para> &cli; is started up in quiet mode by default, though the <option>-q</option> and <option>--no-header</option> switches are kept for compatibility so that it is possible to use older <acronym>CGI</acronym> scripts. </para> <para> It does not change the working directory to that of the script. (<option>-C</option> and <option>--no-chdir</option> switches kept for compatibility) </para> <para> Plain text error messages (no <acronym>HTML</acronym> formatting). </para> </listitem> <listitem> <para> There are certain &php.ini; directives which are overridden by the &cli.sapi; because they do not make sense in shell environments: </para> <para> <table> <title>Overridden &php.ini; directives</title> <tgroup cols="3"> <thead> <row> <entry>Directive</entry> <entry>&cli; <acronym>SAPI</acronym> default value</entry> <entry>Comment</entry> </row> </thead> <tbody> <row> <entry><link linkend="ini.html-errors">html_errors</link></entry> <entry>&false;</entry> <entry> Defaults to &false;, as it can be quite hard to read error messages in the shell environment when they are cluttered up with uninterpreted <acronym>HTML</acronym> tags. </entry> </row> <row> <entry><link linkend="ini.implicit-flush">implicit_flush</link></entry> <entry>&true;</entry> <entry> In a shell environment, it is usually desirable for output, such as from <function>print</function>, <function>echo</function> and friends, to be displayed immediately, and not held in a buffer. Nonetheless, it is still possible to use <link linkend="ref.outcontrol">output buffering</link> to defer or manipulate standard output. </entry> </row> <row> <entry><link linkend="ini.max-execution-time">max_execution_time</link></entry> <entry>0 (unlimited)</entry> <entry> PHP in a shell environment tends to be used for a much more diverse range of purposes than typical Web-based scripts, and as these can be very long-running, the maximum execution time is set to unlimited. </entry> </row> <row> <entry><link linkend="ini.register-argc-argv">register_argc_argv</link></entry> <entry>&true;</entry> <entry> <para> Setting this to &true; means that scripts executed via the &cli; <acronym>SAPI</acronym> always have access to <emphasis>argc</emphasis> (number of arguments passed to the application) and <emphasis>argv</emphasis> (array of the actual arguments). </para> <para> The PHP variables <varname>$argc</varname> and <varname>$argv</varname> are automatically set to the appropriate values when using the &cli; <acronym>SAPI</acronym>. These values can also be found in the <varname>$_SERVER</varname> array, for example: <varname>$_SERVER['argv']</varname>. </para> <warning> <para> The presence of <varname>$argv</varname> or <varname>$_SERVER['argv']</varname> is not a reliable indication that a script is being run from the command line because they may be set in other contexts when <link linkend="ini.register-argc-argv">register_argc_argv</link> is enabled. The value returned by <function>php_sapi_name</function> should be checked instead. <informalexample> <programlisting role="php"> <![CDATA[ <?php if (php_sapi_name() === 'cli') { echo "This is being run from the command line!\n"; } ]]> </programlisting> </informalexample> </para> </warning> &warn.deprecated.feature-8-5-0; </entry> </row> <row> <entry><link linkend="ini.output-buffering">output_buffering</link></entry> <entry>&false;</entry> <entry> <para> Although the &php.ini; setting is hardcoded to &false;, the <link linkend="book.outcontrol">Output buffering</link> functions are available. </para> </entry> </row> <row> <entry><link linkend="ini.max-input-time">max_input_time</link></entry> <entry>&false;</entry> <entry> <para> The PHP &cli; does not support GET, POST or file uploads. </para> </entry> </row> </tbody> </tgroup> </table> </para> <note> <para> These directives cannot be initialized with another value from the configuration file &php.ini; or a custom one (if specified). This limitation is because the values are applied after all configuration files have been parsed. However, their values can be changed during runtime (although this is not sensible for all of them, such as <link linkend="ini.register-argc-argv">register_argc_argv</link>). </para> </note> <note> <para> It is recommended to set <link linkend="ini.ignore-user-abort">ignore_user_abort</link> for command line scripts. See <function>ignore_user_abort</function> for more information. </para> </note> </listitem> <listitem> <para> To ease working in the shell environment, a number of constants are defined for <link linkend="features.commandline.io-streams">I/O streams </link>. </para> </listitem> <listitem> <para> The &cli.sapi; does <emphasis role="strong">not</emphasis> change the current directory to the directory of the executed script. </para> <example> <title> Example showing the difference to the <acronym>CGI</acronym> <acronym>SAPI</acronym>: </title> <programlisting role="php"> <![CDATA[ <?php // Our simple test application named test.php echo getcwd(), "\n"; ?> ]]> </programlisting> <para> When using the <acronym>CGI</acronym> version, the output is: </para> <screen> <![CDATA[ $ pwd /tmp $ php -q another_directory/test.php /tmp/another_directory ]]> </screen> <para> This clearly shows that PHP changes its current directory to the one of the executed script. </para> <para> Using the &cli.sapi; yields: </para> <screen> <![CDATA[ $ pwd /tmp $ php -f another_directory/test.php /tmp ]]> </screen> <para> This allows greater flexibility when writing shell tools in PHP. </para> </example> <note> <simpara> The <acronym>CGI</acronym> <acronym>SAPI</acronym> supports this &cli.sapi; behavior by means of the <option>-C</option> switch when run from the command line. </simpara> </note> </listitem> </itemizedlist> </para> </section> <section xml:id="features.commandline.options"> <title>Command line options</title> <titleabbrev>Options</titleabbrev> <para> The list of command line options provided by the PHP binary can be queried at any time by running PHP with the <option>-h</option> switch: <screen> <![CDATA[ Usage: php [options] [-f] <file> [--] [args...] php [options] -r <code> [--] [args...] php [options] [-B <begin_code>] -R <code> [-E <end_code>] [--] [args...] php [options] [-B <begin_code>] -F <file> [-E <end_code>] [--] [args...] php [options] -- [args...] php [options] -a -a Run interactively -c <path>|<file> Look for php.ini file in this directory -n No php.ini file will be used -d foo[=bar] Define INI entry foo with value 'bar' -e Generate extended information for debugger/profiler -f <file> Parse and execute <file>. -h This help -i PHP information -l Syntax check only (lint) -m Show compiled in modules -r <code> Run PHP <code> without using script tags <?..?> -B <begin_code> Run PHP <begin_code> before processing input lines -R <code> Run PHP <code> for every input line -F <file> Parse and execute <file> for every input line -E <end_code> Run PHP <end_code> after processing all input lines -H Hide any passed arguments from external tools. -S <addr>:<port> Run with built-in web server. -t <docroot> Specify document root <docroot> for built-in web server. -s Output HTML syntax highlighted source. -v Version number -w Output source with stripped comments and whitespace. args... Arguments passed to script. Use -- args when first argument starts with - or script is read from stdin --ini Show configuration file names --rf <name> Show information about function <name>. --rc <name> Show information about class <name>. --re <name> Show information about extension <name>. --rz <name> Show information about Zend extension <name>. --ri <name> Show configuration for extension <name>. ]]> </screen> </para> <para> <table> <title>Command line options</title> <tgroup cols="2"> <thead> <row> <entry>Option</entry> <entry>Long Option</entry> <entry>Description</entry> </row> </thead> <tbody> <row> <entry>-a</entry> <entry>--interactive</entry> <entry> <para> Run PHP interactively. For more information, see the <link linkend="features.commandline.interactive">Interactive shell</link> section. </para> </entry> </row> <row> <entry>-b</entry> <entry>--bindpath</entry> <entry> <para> Bind Path for external FASTCGI Server mode (<acronym>CGI</acronym> only). </para> </entry> </row> <row> <entry>-C</entry> <entry>--no-chdir</entry> <entry> <para> Do not chdir to the script's directory (<acronym>CGI</acronym> only). </para> </entry> </row> <row> <entry>-q</entry> <entry>--no-header</entry> <entry> <para> Quiet-mode. Suppress <acronym>HTTP</acronym> header output (<acronym>CGI</acronym> only). </para> </entry> </row> <row> <entry>-T</entry> <entry>--timing</entry> <entry> <para> Measure execution time of script repeated <varname>count</varname> times (<acronym>CGI</acronym> only). </para> </entry> </row> <row> <entry>-c</entry> <entry>--php-ini</entry> <entry> <para> Specifies either a directory in which to look for &php.ini;, or a custom <literal>INI</literal> file (which does not need to be named &php.ini;), e.g.: </para> <para><informalexample> <screen> <![CDATA[ $ php -c /custom/directory/ my_script.php $ php -c /custom/directory/custom-file.ini my_script.php ]]> </screen> </informalexample></para> <para> If this option is not specified, &php.ini; is searched for in the <link linkend="configuration.file">default locations</link>. </para> </entry> </row> <row> <entry>-n</entry> <entry>--no-php-ini</entry> <entry> <para> Ignore &php.ini; completely. </para> </entry> </row> <row> <entry>-d</entry> <entry>--define</entry> <entry> <para> Set a custom value for any of the configuration directives allowed in &php.ini;. The syntax is: <screen> <![CDATA[ -d configuration_directive[=value] ]]> </screen> </para> <para><example> <title>Example of using <literal>-d</literal> to set an INI setting</title> <screen> <![CDATA[ # Omitting the value part will set the given configuration directive to "1" $ php -d max_execution_time -r '$foo = ini_get("max_execution_time"); var_dump($foo);' string(1) "1" # Passing an empty value part will set the configuration directive to "" php -d max_execution_time= -r '$foo = ini_get("max_execution_time"); var_dump($foo);' string(0) "" # The configuration directive will be set to anything passed after the '=' character $ php -d max_execution_time=20 -r '$foo = ini_get("max_execution_time"); var_dump($foo);' string(2) "20" $ php -d max_execution_time=doesntmakesense -r '$foo = ini_get("max_execution_time"); var_dump($foo);' string(15) "doesntmakesense" ]]> </screen> </example></para> </entry> </row> <row> <entry>-e</entry> <entry>--profile-info</entry> <entry> <para> Activate the extended information mode, to be used by a debugger/profiler. </para> </entry> </row> <row> <entry>-f</entry> <entry>--file</entry> <entry> <para> Parse and execute the specified file. The <option>-f</option> is optional and may be omitted - providing just the filename to execute is sufficient. </para> </entry> </row> <row> <entry>-h and -?</entry> <entry>--help and --usage</entry> <entry> Output a list of command line options with one-line descriptions of what they do. </entry> </row> <row> <entry>-i</entry> <entry>--info</entry> <entry> Calls <function>phpinfo</function>, and prints out the results. If PHP is not working correctly, it is advisable to use the command <command>php -i</command> and see whether any error messages are printed out before or in place of the information tables. Beware that when using the <acronym>CGI</acronym> mode the output is in <acronym>HTML</acronym> and therefore very large. </entry> </row> <row> <entry>-l</entry> <entry>--syntax-check</entry> <entry> <para> Syntax check but do not execute the given PHP code. The input from standard input will be processed if no filenames are specified, otherwise each filename will be checked. On success, the text <literal>No syntax errors detected in <filename></literal> is written to standard output. On failure, the text <literal>Errors parsing <filename></literal> is written to standard output in addition to the internal parser error. If any failures are found in the specified files (or standard input), the shell return code is set to <literal>-1</literal>, otherwise the shell return code is set to <literal>0</literal>. </para> <para> This option won't find fatal errors (like undefined functions) that require executing the code. </para> <note> <para> Prior to PHP 8.3.0, it was only possible to specify one filename to be checked. </para> </note> <note> <para> This option does not work together with the <option>-r</option> option. </para> </note> </entry> </row> <row> <entry>-m</entry> <entry>--modules</entry> <entry> <para><example> <title>Printing built-in (and loaded) PHP and Zend modules</title> <screen> <![CDATA[ $ php -m [PHP Modules] xml tokenizer standard session posix pcre overload mysql mbstring ctype [Zend Modules] ]]> </screen> </example></para> </entry> </row> <row> <entry>-r</entry> <entry>--run</entry> <entry> <para> Allows execution of PHP included directly on the command line. The PHP start and end tags (<literal><?php</literal> and <literal>?></literal>) are <emphasis role="strong">not needed</emphasis> and will cause a parse error if present. </para> <note> <para> Care must be taken when using this form of PHP not to collide with command line variable substitution done by the shell. </para> <example> <title>Getting a syntax error when using double quotes</title> <screen> <![CDATA[ $ php -r "$foo = get_defined_constants();" PHP Parse error: syntax error, unexpected '=' in Command line code on line 1 Parse error: syntax error, unexpected '=' in Command line code on line 1 ]]> </screen> </example> <para> The problem here is that sh/bash performs variable substitution even when using double quotes <literal>"</literal>. Since the variable <varname>$foo</varname> is unlikely to be defined, it expands to nothing which results in the code passed to PHP for execution actually reading: </para> <informalexample> <screen> <![CDATA[ $ php -r " = get_defined_constants();" ]]> </screen> </informalexample> <para> The correct way would be to use single quotes <literal>'</literal>. Variables in single-quoted strings are not expanded by sh/bash. </para> <example> <title>Using single quotes to prevent the shell's variable substitution</title> <screen> <![CDATA[ $ php -r '$foo = get_defined_constants(); var_dump($foo);' array(370) { ["E_ERROR"]=> int(1) ["E_WARNING"]=> int(2) ["E_PARSE"]=> int(4) ["E_NOTICE"]=> int(8) ["E_CORE_ERROR"]=> [...] ]]> </screen> </example> <para> If using a shell other than sh/bash, further issues might be experienced - if appropriate, a bug report should be opened at <link xlink:href="&url.php.bugs;">&url.php.bugs;</link>. It is still easy to run into trouble when trying to use variables (shell or PHP) in command-line code, or using backslashes for escaping, so take great care when doing so. You have been warned! </para> </note> <note> <para> <option>-r</option> is available in the &cli.sapi;, but not in the <emphasis>CGI</emphasis> <acronym>SAPI</acronym>. </para> </note> <note> <para> This option is only intended for very basic code, so some configuration directives (such as <link linkend="ini.auto-prepend-file">auto_prepend_file</link> and <link linkend="ini.auto-append-file">auto_append_file</link>) are ignored in this mode. </para> </note> </entry> </row> <row> <entry>-B</entry> <entry>--process-begin</entry> <entry> <para> PHP code to execute before processing stdin. </para> </entry> </row> <row> <entry>-R</entry> <entry>--process-code</entry> <entry> <para> PHP code to execute for every input line. </para> <para> There are two special variables available in this mode: <varname>$argn</varname> and <varname>$argi</varname>. <varname>$argn</varname> will contain the line PHP is processing at that moment, while <varname>$argi</varname> will contain the line number. </para> </entry> </row> <row> <entry>-F</entry> <entry>--process-file</entry> <entry> <para> PHP file to execute for every input line. </para> </entry> </row> <row> <entry>-E</entry> <entry>--process-end</entry> <entry> <para> PHP code to execute after processing the input. </para> <para><example> <title>Using the <option>-B</option>, <option>-R</option> and <option>-E</option> options to count the number of lines of a project. </title> <screen> <![CDATA[ $ find my_proj | php -B '$l=0;' -R '$l += count(@file($argn));' -E 'echo "Total Lines: $l\n";' Total Lines: 37328 ]]> </screen> </example></para> </entry> </row> <row> <entry>-S</entry> <entry>--server</entry> <entry> <para> Starts <link linkend="features.commandline.webserver">built-in web server</link>. </para> </entry> </row> <row> <entry>-t</entry> <entry>--docroot</entry> <entry> Specifies document root for <link linkend="features.commandline.webserver">built-in web server</link>. </entry> </row> <row> <entry>-s</entry> <entry>--syntax-highlight and --syntax-highlighting</entry> <entry> <para> Display colour syntax highlighted source. </para> <para> This option uses the internal mechanism to parse the file and writes an HTML highlighted version of it to standard output. Note that all it does is generate a block of <literal><code> [...] </code></literal> HTML tags, no HTML headers. </para> <note> <para> This option does not work together with the <option>-r</option> option. </para> </note> </entry> </row> <row> <entry>-v</entry> <entry>--version</entry> <entry> <para><example> <title>Using <option>-v</option> to get the <acronym>SAPI</acronym> name and the version of PHP and Zend</title> <screen> <![CDATA[ $ php -v PHP 5.3.1 (cli) (built: Dec 11 2009 19:55:07) Copyright (c) 1997-2009 The PHP Group Zend Engine v2.3.0, Copyright (c) 1998-2009 Zend Technologies ]]> </screen> </example></para> </entry> </row> <row> <entry>-w</entry> <entry>--strip</entry> <entry> <para> Display source with comments and whitespace stripped. </para> <note> <para> This option does not work together with the <option>-r</option> option. </para> </note> </entry> </row> <row> <entry></entry> <entry>--ini</entry> <entry> <para> Show configuration file names and scanned directories. Optionally, pass <literal>--ini=diff</literal> to show the differences between the loaded configuration files and the default configuration. <example> <title><literal>--ini</literal> example</title> <programlisting role="shell"> <![CDATA[ $ php --ini Configuration File (php.ini) Path: /usr/dev/php/5.2/lib Loaded Configuration File: /usr/dev/php/5.2/lib/php.ini Scan for additional .ini files in: (none) Additional .ini files parsed: (none) ]]> </programlisting> </example> <note> <simpara> The <literal>--ini=diff</literal> option is not available prior to PHP 8.5.0. </simpara> </note> </para> </entry> </row> <row> <entry>--rf</entry> <entry>--rfunction</entry> <entry> <para> Show information about the given function or class method (e.g. number and name of the parameters). </para> <para> This option is only available if PHP was compiled with <link linkend="book.reflection">Reflection</link> support. </para> <para> <example> <title>basic <literal>--rf</literal> usage</title> <programlisting role="shell"> <![CDATA[ $ php --rf var_dump Function [ <internal> public function var_dump ] { - Parameters [2] { Parameter #0 [ <required> $var ] Parameter #1 [ <optional> $... ] } } ]]> </programlisting> </example> </para> </entry> </row> <row> <entry>--rc</entry> <entry>--rclass</entry> <entry> <para> Show information about the given class (list of constants, properties and methods). </para> <para> This option is only available if PHP was compiled with <link linkend="book.reflection">Reflection</link> support. </para> <para> <example> <title><literal>--rc</literal> example</title> <programlisting role="shell"> <![CDATA[ $ php --rc Directory Class [ <internal:standard> class Directory ] { - Constants [0] { } - Static properties [0] { } - Static methods [0] { } - Properties [0] { } - Methods [3] { Method [ <internal> public method close ] { } Method [ <internal> public method rewind ] { } Method [ <internal> public method read ] { } } } ]]> </programlisting> </example> </para> </entry> </row> <row> <entry>--re</entry> <entry>--rextension</entry> <entry> <para> Show information about the given extension (list of &php.ini; options, defined functions, constants and classes). </para> <para> This option is only available if PHP was compiled with <link linkend="book.reflection">Reflection</link> support. </para> <para> <example> <title><literal>--re</literal> example</title> <programlisting role="shell"> <![CDATA[ $ php --re json Extension [ <persistent> extension #19 json version 1.2.1 ] { - Functions { Function [ <internal> function json_encode ] { } Function [ <internal> function json_decode ] { } } } ]]> </programlisting> </example> </para> </entry> </row> <row> <entry>--rz</entry> <entry>--rzendextension</entry> <entry> <para> Show the configuration information for the given Zend extension (the same information that is returned by <function>phpinfo</function>). </para> </entry> </row> <row> <entry>--ri</entry> <entry>--rextinfo</entry> <entry> <para> Show the configuration information for the given extension (the same information that is returned by <function>phpinfo</function>). The core configuration information is available using "main" as extension name. </para> <para> <example> <title><literal>--ri</literal> example</title> <programlisting role="shell"> <![CDATA[ $ php --ri date date |
| You are visitor 01402503 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |