-
Notifications
You must be signed in to change notification settings - Fork 79
/
Copy pathcommandline.xml
2002 lines (1896 loc) · 69.8 KB
/
commandline.xml
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$ -->
<!-- EN-Revision: 4b4292baf79bb650763e8230dbb254ee59d5ce80 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,shimooka,mumumu -->
<chapter xml:id="features.commandline" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>PHP をコマンドラインから使用する</title>
<titleabbrev>コマンドラインの使用法</titleabbrev>
<!--Introduction: {{{-->
<section xml:id="features.commandline.introduction" annotations="chunk:false">
<title>はじめに</title>
<para>
&cli.sapi; の主な目的は、シェルアプリケーションを PHP
で開発することです。&cli.sapi; とその他の
<acronym>SAPI</acronym> の間にはちょっとした違いがあり、
それを本章で説明します。&cli; と <acronym>CGI</acronym>
は多くの共通点がありますが、別の <acronym>SAPI</acronym>
であるということも覚えておきましょう。
</para>
<para>
&cli.sapi; は、
<option role="configure">--enable-cli</option> でデフォルトで有効となっています。
<command>./configure</command> の際に
<option role="configure">--disable-cli</option> オプションを指定して無効にすることもできます。
</para>
<para>
&cli;/<acronym>CGI</acronym> バイナリの名前、位置、そして存在するかどうかは
PHP がどのようにインストールされているかによって異なります。デフォルトで
<command>make</command> を実行したときには、<acronym>CGI</acronym> と
&cli; が両方ビルドされて、それぞれ PHP ソースディレクトリの <filename>sapi/cgi/php-cgi</filename> と
<filename>sapi/cli/php</filename> にできあがります。
両方とも <filename>php</filename> という名前であることに注意しましょう。
<command>make install</command> のときにどうなるかは、configure
行に依存します。
configure で例えば apxs のような <acronym>SAPI</acronym> モジュールが選択された場合、または
<option role="configure">--disable-cgi</option> が指定された場合、
<command>make install</command> によって &cli; が <filename>{PREFIX}/bin/php</filename>
にコピーされます。さもなければ <acronym>CGI</acronym> がそこにコピーされます。
つまり、たとえば configure で <option role="configure">--with-apxs </option>
を指定すると、<command>make install</command> での &cli; のコピー先は
<filename>{PREFIX}/bin/php</filename> となります。
既にインストールされている <acronym>CGI</acronym> バイナリを上書きしたい場合には、
<command>make install</command> の後に <command>make install-cli</command>
を実行してください。あるいは configure で
<option role="configure">--disable-cgi</option> を指定することもできます。
</para>
<note>
<para>
<option role="configure">--enable-cli</option>
と <option role="configure">--enable-cgi</option>
の両方がデフォルトで有効になっています。そのため、configure で
<option role="configure">--enable-cli</option>
を指定したからといって、<command>make install</command> で
<filename>{PREFIX}/bin/php</filename>
にコピーされるのが必ずしも &cli; になるとは限りません。
</para>
</note>
<para>
Windows 版の &cli; はメインフォルダ内で <filename>php.exe</filename>
という名前で配布されます。<acronym>CGI</acronym> バージョンは、<filename>php-cgi.exe</filename>
として配布されます。さらに
configure で <option role="configure">--enable-cli-win32</option>
を指定すると、新しく <filename>php-win.exe</filename> というファイルが配布されます。
これは &cli; バージョンとほぼ同じですが、何も出力しないため、コンソールは必要ありません。
</para>
<note>
<title>自分の SAPI は何か?</title>
<para>
シェルで <command>php -v</command> をタイプすると、
<filename>php</filename> が <acronym>CGI</acronym> なのか &cli; なのかわかります。
<function>php_sapi_name</function> と定数 <constant>PHP_SAPI</constant>
も参照ください。
</para>
</note>
<note>
<para>
Unix の <literal>man</literal> ページは、
シェル環境から <command>man php</command> とすれば見ることができます。
</para>
</note>
</section>
<!--}}}-->
<!--Differences: {{{-->
<section xml:id="features.commandline.differences">
<title>他の <acronym>SAPI</acronym> との違い</title>
<para>
&cli; <acronym>SAPI</acronym> を他の <acronym>SAPI</acronym> と比べた時の
大きな違いを以下に示します。
<itemizedlist>
<listitem>
<para>
<acronym>CGI</acronym> <acronym>SAPI</acronym> と異なり、ヘッダが出力されません。
</para>
<para>
<acronym>CGI</acronym> <acronym>SAPI</acronym> は HTTP ヘッダの出力を抑制する機能を
提供していますが、等価な機能は &cli.sapi; ではサポートされていません。
</para>
<para>
デフォルトでは &cli; は静寂モードで起動されます。古い <acronym>CGI</acronym> スクリプトと互換性を
保って使えるように <option>-q</option> および <option>--no-header</option> スイッチが残されています。
</para>
<para>
作業ディレクトリをスクリプトの場所に変更しません
(<option>-C</option> および <option>--no-chdir</option> スイッチは
互換性のために残されています)。
</para>
<para>
エラーメッセージはプレーンテキスト (<acronym>HTML</acronym> フォーマットはしない)
で表示されます。
</para>
</listitem>
<listitem>
<para>
以下に示すいくつかの &php.ini; ディレクティブは、&cli.sapi;
により上書きされます。これは、シェル環境では意味がないためです。
</para>
<para>
<table>
<title>上書きされる &php.ini; のディレクティブ</title>
<tgroup cols="3">
<thead>
<row>
<entry>ディレクティブ</entry>
<entry>&cli; <acronym>SAPI</acronym> のデフォルト値</entry>
<entry>コメント</entry>
</row>
</thead>
<tbody>
<row>
<entry><link linkend="ini.html-errors">html_errors</link></entry>
<entry>&false;</entry>
<entry>
エラーメッセージに含まれる <acronym>HTML</acronym> タグは
シェル上では意味がなく、可読性をかなり低下させるため、この
ディレクティブはデフォルトで &false; となっています。
</entry>
</row>
<row>
<entry><link linkend="ini.implicit-flush">implicit_flush</link></entry>
<entry>&true;</entry>
<entry>
<function>print</function>, <function>echo</function> および
関連するものによる全ての出力は、直ちに出力され、バッファに
キャッシュされないことが望ましいと言えます。この場合でも、
標準出力を保留または操作したい場合には、
<link linkend="ref.outcontrol">出力バッファリング</link>
を使用することが可能です。
</entry>
</row>
<row>
<entry><link linkend="ini.max-execution-time">max_execution_time</link></entry>
<entry>0 (無制限)</entry>
<entry>
シェル環境では、PHP を際限なく使用できる
ようにするために、最大実行時間の制限は無しに設定されています。
Web 用アプリケーションは数秒単位で実行されるよう作られて
いますが、シェルアプリケーションの実行時間は、これよりかなり
長くなる傾向があります。
</entry>
</row>
<row>
<entry><link linkend="ini.register-argc-argv">register_argc_argv</link></entry>
<entry>&true;</entry>
<entry>
<para>
この設定が &true; なので、&cli; <acronym>SAPI</acronym> では常に
<emphasis>argc</emphasis> (アプリケーションに渡した引数の数)
および <emphasis>argv</emphasis> (実際の引数の配列)
を使うことができます。
</para>
<para>
&cli; <acronym>SAPI</acronym> を使用するときに
PHP の <varname>$argc</varname> 変数と
<varname>$argv</varname> 変数が登録され、適切な値がセットされます。
あるいは <varname>$_SERVER</varname> や
<varname>$_SERVER['argv']</varname> を使うこともできます。
</para>
</entry>
</row>
<row>
<entry><link linkend="ini.output-buffering">output_buffering</link></entry>
<entry>&false;</entry>
<entry>
<para>
&php.ini; で &false; とハードコードされていても、
<link linkend="book.outcontrol">出力バッファリング</link>
関数は使用可能です。
</para>
</entry>
</row>
<row>
<entry><link linkend="ini.max-input-time">max_input_time</link></entry>
<entry>&false;</entry>
<entry>
<para>
PHP &cli; は GET、POST あるいはファイルのアップロードをサポートしません。
</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<note>
<para>
これらのディレクティブは、設定ファイル &php.ini; またはカスタム
設定ファイル(指定した場合のみ)で他の値に初期化できません。
この制限は、これらのデフォルト値が全ての設定ファイルをパースした後に
適用されるためです。しかし、これらの値は実行時に変更することが
可能です
(上記のディレクティブの全てについてこれが当てはまるわけでは
ありません。例えば、<link
linkend="ini.register-argc-argv">register_argc_argv</link>)。
</para>
</note>
<note>
<para>
コマンドラインのスクリプトでは
<link linkend="ini.ignore-user-abort">ignore_user_abort</link>
を設定することを推奨します。詳細は <function>ignore_user_abort</function>
を参照ください。
</para>
</note>
</listitem>
<listitem>
<para>
シェル環境での利便性を考慮して、
<link linkend="features.commandline.io-streams">I/O ストリーム
</link> 用に多くの定数が定義されています。
</para>
</listitem>
<listitem>
<para>
&cli.sapi; は、カレントディレクトリをスクリプトのディレクトリに変更
<emphasis role="strong">しません</emphasis>!
</para>
<example>
<title>
<acronym>CGI</acronym> <acronym>SAPI</acronym> との違いを示す例
</title>
<programlisting role="php">
<![CDATA[
<?php
// test.php という名前のシンプルなテストアプリケーション
echo getcwd(), "\n";
?>
]]>
</programlisting>
<para>
<acronym>CGI</acronym> 版を使った場合、出力は以下のようになります。
</para>
<screen>
<![CDATA[
$ pwd
/tmp
$ php -q another_directory/test.php
/tmp/another_directory
]]>
</screen>
<para>
これは、PHP がカレントディレクトリを
スクリプトのディレクトリに変更することを明らかに示しています。
</para>
<para>
&cli.sapi; を使った場合はこのようになります。
</para>
<screen>
<![CDATA[
$ pwd
/tmp
$ php -f another_directory/test.php
/tmp
]]>
</screen>
<para>
これにより、PHP でシェルツールを書く際の柔軟性をより大きくすることができます。
</para>
</example>
<note>
<para>
<acronym>CGI</acronym> <acronym>SAPI</acronym> は、この &cli.sapi;
の動作をコマンドライン実行時のスイッチ <literal>-C</literal>
によりサポートしています。
</para>
</note>
</listitem>
</itemizedlist>
</para>
</section>
<!--}}}-->
<!--Options: {{{-->
<section xml:id="features.commandline.options">
<title>コマンドラインオプション</title>
<titleabbrev>オプション</titleabbrev>
<para>
PHP バイナリにより提供されるコマンドラインオプションの一覧は、
<option>-h</option> スイッチを指定して PHP を実行することにより
いつでも調べることができます。
<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.
-z <file> Load Zend extension <file>.
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>コマンドラインオプション</title>
<tgroup cols="2">
<thead>
<row>
<entry>オプション</entry>
<entry>長い形式のオプション</entry>
<entry>説明</entry>
</row>
</thead>
<tbody>
<row>
<entry>-a</entry>
<entry>--interactive</entry>
<entry>
<para>
PHP を対話的に実行します。詳細な情報は、<link
linkend="features.commandline.interactive">対話シェル</link>
を参照ください。
</para>
</entry>
</row>
<row>
<entry>-b</entry>
<entry>--bindpath</entry>
<entry>
<para>
外部 FASTCGI サーバーモードでのバインドパス (<acronym>CGI</acronym>
のみ)。
</para>
</entry>
</row>
<row>
<entry>-C</entry>
<entry>--no-chdir</entry>
<entry>
<para>
スクリプトのディレクトリへ chdir しません (<acronym>CGI</acronym> のみ)。
</para>
</entry>
</row>
<row>
<entry>-q</entry>
<entry>--no-header</entry>
<entry>
<para>
静寂モード。<acronym>HTTP</acronym> ヘッダの出力を抑制します
(<acronym>CGI</acronym> のみ)。
</para>
</entry>
</row>
<row>
<entry>-T</entry>
<entry>--timing</entry>
<entry>
<para>
スクリプトを <varname>count</varname> 回繰り返して実行した時間を計測します
(<acronym>CGI</acronym> のみ)。
</para>
</entry>
</row>
<row>
<entry>-c</entry>
<entry>--php-ini</entry>
<entry>
<para>
このオプションを使用することにより、&php.ini; を探すディレクトリを
指定したり、カスタマイズされた <literal>INI</literal> ファイル
(&php.ini; という名前である必要はありません)を直接指定する
ことが可能です。例:
</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>
このオプションを指定しない場合、ファイルは、
<link linkend="configuration.file">デフォルトの位置</link>
で探索されます。
</para>
</entry>
</row>
<row>
<entry>-n</entry>
<entry>--no-php-ini</entry>
<entry>
<para>
&php.ini; を完全に無視します。
</para>
</entry>
</row>
<row>
<entry>-d</entry>
<entry>--define</entry>
<entry>
<para>
このオプションにより &php.ini; で指定できる設定ディレクティブに
カスタム値を設定することができます。構文は以下のようになります。
<screen>
<![CDATA[
-d configuration_directive[=value]
]]>
</screen>
</para>
<para><example>
<title>INI 設定に <literal>-d</literal> を使って値を設定する例</title>
<screen>
<![CDATA[
# 値の部分を省略すると、設定ディレクティブに"1"を指定します
$ php -d max_execution_time
-r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(1) "1"
# 空の値を渡すと設定ディレクティブに""を設定します
php -d max_execution_time=
-r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(0) ""
# 設定ディレクティブは文字'='の後に指定したものを設定します
$ 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>
デバッガ/プロファイラ用の拡張情報を出力します。
</para>
</entry>
</row>
<row>
<entry>-f</entry>
<entry>--file</entry>
<entry>
<para>
<option>-f</option> オプションに指定したファイル名をパースし、
実行します。このスイッチはオプションで省略することもできます。
実行するスクリプトを指定するだけで充分です。
</para>
</entry>
</row>
<row>
<entry>-h and -?</entry>
<entry>--help and --usage</entry>
<entry>
このオプションを使用すると、実際の一連のコマンドラインオプションと
各1行の説明が情報を取得できます。
</entry>
</row>
<row>
<entry>-i</entry>
<entry>--info</entry>
<entry>
このコマンドラインオプションは、<function>phpinfo</function> をコールし、
結果を出力します。PHP が正しく動作していない場合、
<command>php -i</command> を実行し、情報テーブルの前または中に
出力されるエラーメッセージを調べることをお勧めします。
<acronym>CGI</acronym> モードの場合、
出力が <acronym>HTML</acronym> 形式で行なわれるため
量がかなり多くなることに注意してください。
</entry>
</row>
<row>
<entry>-l</entry>
<entry>--syntax-check</entry>
<entry>
<para>
構文チェックを行いますが、指定された PHP コードは実行しません。
ファイル名が指定されない場合、標準出力の入力をチェックしますが、
指定された場合、それぞれのファイルがチェックされます。
成功した場合、
テキスト
<literal>No syntax errors detected in <filename></literal>
が標準出力に書き込まれ、リターンコードは <literal>0</literal>
になります。失敗した場合は
テキスト <literal>Errors parsing
<filename></literal> に加え、内部パーサエラーメッセージ
が標準出力に書き込まれ、シェルリターンコードは、
<literal>-1</literal> となります。
</para>
<para>
このオプションは、(未定義の関数のような)致命的なエラー(fatal error)
を見つけることはありません。そうするためには、
コード全体を実行する必要があるからです。
</para>
<note>
<para>
PHP 8.3.0 より前のバージョンでは、
構文チェックできるファイルの数は一つだけでした。
</para>
</note>
<note>
<para>
このオプションは、オプション <option>-r</option> と共に使用することは
できません。
</para>
</note>
</entry>
</row>
<row>
<entry>-m</entry>
<entry>--modules</entry>
<entry>
<para><example>
<title>PHP に組み込まれた (そしてロードされた) Zend モジュールの表示</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>
このオプションにより、コマンドラインのみで PHP
の実行ができるようになります。
PHP の開始および終了タグ
(<literal><?php</literal> および <literal>?></literal>)
は<emphasis role="strong">不要</emphasis>で、これらを付けると
パーサエラーとなります。
</para>
<note>
<para>
このように PHP を実行する際に、コマンドラインの
変数がシェルにより行なわれる置換と干渉しないように注意してください。
</para>
<example>
<title>ダブルクォートの使用時に構文エラーが出る例</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>
ここでの問題は、2 重引用符 <literal>"</literal> を用いた場合でも
sh/bash が変数置換を行うことです。
<varname>$foo</varname> はおそらく定義されていないので、
空文字列に展開された後、実行用に PHP に
そのコードが渡され、以下のように読み込むことになります。
</para>
<informalexample>
<screen>
<![CDATA[
$ php -r " = get_defined_constants();"
]]>
</screen>
</informalexample>
<para>
正しい方法は、1 重引用符<literal>'</literal>を使用することです。
1 重引用符で括られた文字列の中の変数は、sh/bash により展開されません。
</para>
<example>
<title>シングルクォートを使い、シェルの変数置換を防ぐ例</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>
sh/bash 以外のシェルを使用している場合には、別の問題を経験したことが
あるかもしれません。バグを
<link xlink:href="&url.php.bugs;">&url.php.bugs;</link>
に報告してください。
シェル変数をコードに取得しようとしたり、エスケープを行なうために
バックスラッシュを使用したりした場合にも、容易に問題を発生する
可能性があります。注意が必要です。
</para>
</note>
<note>
<para>
<option>-r</option> は &cli.sapi; で有効で、
<emphasis>CGI</emphasis> <acronym>SAPI</acronym> では使用できません。
</para>
</note>
<note>
<para>
このオプションはあくまで基本的な機能を提供するものです。そのため、
いくつかの設定ディレクティブ(例: <link
linkend="ini.auto-prepend-file">auto_prepend_file</link> および <link
linkend="ini.auto-append-file">auto_append_file</link>)は
このモードでは無視されます。
</para>
</note>
</entry>
</row>
<row>
<entry>-B</entry>
<entry>--process-begin</entry>
<entry>
<para>
標準入力を処理する前に実行する PHP コードを指定します。
</para>
</entry>
</row>
<row>
<entry>-R</entry>
<entry>--process-code</entry>
<entry>
<para>
それぞれの入力行に対して実行する PHP コードを指定します。
</para>
<para>
このモードには 2 つの特別な変数
<varname>$argn</varname> と <varname>$argi</varname>
が用意されています。
<varname>$argn</varname> は PHP がその瞬間に処理している行を含み、
<varname>$argi</varname> はその行番号を含んでいます。
</para>
</entry>
</row>
<row>
<entry>-F</entry>
<entry>--process-file</entry>
<entry>
<para>
全ての入力行に対して実行する PHP ファイルを指定します。
</para>
</entry>
</row>
<row>
<entry>-E</entry>
<entry>--process-end</entry>
<entry>
<para>
入力を処理した後に実行する PHP コードを指定します。
</para>
<para><example>
<title>とあるプロジェクトの行数をカウントするための
<option>-B</option>, <option>-R</option> そして <option>-E</option>
オプションの使用例
</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>
<link linkend="features.commandline.webserver">ビルトインウェブサーバー</link>
を開始させます。
</para>
</entry>
</row>
<row>
<entry>-t</entry>
<entry>--docroot</entry>
<entry>
<link linkend="features.commandline.webserver">ビルトインウェブサーバー</link>
のドキュメントルートを指定します。
</entry>
</row>
<row>
<entry>-s</entry>
<entry>--syntax-highlight と --syntax-highlighting</entry>
<entry>
<para>
カラー構文ハイライト表示されたソースを表示します。
</para>
<para>
このオプションは、ファイルをパースし、HTML
ハイライト表示版のファイルを生成し、標準出力に書き出す内部機
構を使用します。行うのは
<literal><code> [...] </code></literal> のブロックを
生成することだけで、HTML ヘッダは
出力されないことに注意してください。
</para>
<note>
<para>
このオプションは、<option>-r</option> オプションと同時に
使用することはできません。
</para>
</note>
</entry>
</row>
<row>
<entry>-v</entry>
<entry>--version</entry>
<entry>
<para><example>
<title><option>-v</option> による、<acronym>SAPI</acronym>
名および PHP と 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>
コメントと空白文字を削除してソースを表示します。
</para>
<note>
<para>
このオプションは、<option>-r</option> オプションと同時に
使用することはできません。
</para>
</note>
</entry>
</row>
<row>
<entry>-z</entry>
<entry>--zend-extension</entry>
<entry>
<para>
Zend 拡張モジュールをロードします。ファイル名のみが指定された場合、
PHP はこの拡張をカレントのシステムのデフォルトライブラリパスから
ロードしようとします
(Linux システムの場合は <filename>/etc/ld.so.conf</filename> で
指定されています)。
ファイル名を絶対パスで指定した場合、システムのライブラリサーチパスを
使用しません。ディレクトリ情報を有する相対ファイル名を
指定すると、PHP は
カレントのディレクトリの相対パスから拡張モジュールをロードする
ことのみを行ないます。
</para>
</entry>
</row>
<row>
<entry></entry>
<entry>--ini</entry>
<entry>
<para>
設定ファイルの名前、設定ファイルを検索するディレクトリを表示します。
<example>
<title><literal>--ini</literal> の例</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>
</para>
</entry>
</row>
<row>
<entry>--rf</entry>
<entry>--rfunction</entry>
<entry>
<para>
指定した関数あるいはクラスメソッドについての情報
(たとえばパラメータの数と名前など) を表示します。
</para>
<para>
このオプションは、PHP が
<link linkend="book.reflection">リフレクション</link>
のサポートつきでコンパイルされている場合にのみ使用可能です。
</para>
<para>
<example>
<title>基本的な <literal>--rf</literal> の使用法</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>
指定したクラスについての情報 (定数、プロパティおよびメソッドの一覧)
を表示します。
</para>
<para>
このオプションは、PHP が
<link linkend="book.reflection">リフレクション</link>
のサポートつきでコンパイルされている場合にのみ使用可能です。
</para>
<para>
<example>
<title><literal>--rc</literal> の例</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>
指定した拡張モジュールについての情報 (&php.ini; オプション、
定義されている関数、定数およびクラスの一覧) を表示します。
</para>
<para>
このオプションは、PHP が
<link linkend="book.reflection">リフレクション</link>
のサポートつきでコンパイルされている場合にのみ使用可能です。
</para>
<para>
<example>
<title><literal>--re</literal> の例</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>
指定した Zend 拡張モジュールについての情報
(<function>phpinfo</function> が返す情報と同じもの)
を表示します。
</para>
</entry>
</row>
<row>
<entry>--ri</entry>
<entry>--rextinfo</entry>
<entry>
<para>
指定した拡張モジュールについての設定情報 (<function>phpinfo</function>
が返す情報と同じもの) を表示します。
コア機能に関する設定情報は、
"main" というモジュール名で取得できます。
</para>