Menu

[r37]: / trunk / php-mode-web / htdocs / php-mode.html  Maximize  Restore  History

Download this file

1308 lines (1087 with data), 81.4 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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
<html lang="en">
<head>
<title>PHP Mode Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="PHP Mode Manual">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual documents PHP mode version 1.4.0 for
use with GNU Emacs.
Copyright (C) 2008 Aaron S. Hawley
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.2 or any later version published by the Free Software
Foundation; with no Invariant Sections, and no Cover Texts. A
copy of the license is included in the section entitled "Copying
This Manual."
A copy of the license is also available from the Free Software
Foundation Web site at `http://www.gnu.org/licenses/fdl.html'.
The document was typeset with
GNU Texinfo (http://www.texinfo.org/).
$Date: 2008-01-03 20:50:20 -0500 (Thu, 03 Jan 2008) $
$Revision: 30 $-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<h1 class="settitle">PHP Mode Manual</h1>
<div class="contents">
<h2>Table of Contents</h2>
<ul>
<li><a name="toc_Top" href="#Top">PHP Mode Manual</a>
<li><a name="toc_Introduction" href="#Introduction">1 Introduction</a>
<li><a name="toc_Electricity" href="#Electricity">2 Electricity</a>
<li><a name="toc_Motion" href="#Motion">3 Motion</a>
<li><a name="toc_Indentation" href="#Indentation">4 Indentation</a>
<li><a name="toc_Editing" href="#Editing">5 Editing</a>
<li><a name="toc_Completion" href="#Completion">6 Completion</a>
<li><a name="toc_PHP-Comments" href="#PHP-Comments">7 PHP Comments</a>
<li><a name="toc_PHP-Documentation" href="#PHP-Documentation">8 PHP Documentation</a>
<li><a name="toc_Index-Menu" href="#Index-Menu">9 Index Menu</a>
<li><a name="toc_Change-Logs" href="#Change-Logs">10 Change Logs</a>
<li><a name="toc_Speedbar" href="#Speedbar">11 Speedbar</a>
<li><a name="toc_Customization" href="#Customization">12 Customization</a>
<li><a name="toc_Embedded-HTML" href="#Embedded-HTML">Appendix A Embedded HTML</a>
<li><a name="toc_Contributors" href="#Contributors">Appendix B Contributors</a>
<li><a name="toc_Copying-This-Manual" href="#Copying-This-Manual">Appendix C Copying This Manual</a>
<li><a name="toc_Concept-Index" href="#Concept-Index">Concept Index</a>
<li><a name="toc_Function-Index" href="#Function-Index">Function Index</a>
<li><a name="toc_Keyboard-Index" href="#Keyboard-Index">Keyboard Index</a>
<li><a name="toc_Variable-Index" href="#Variable-Index">Variable Index</a>
</li></ul>
</div>
<p><a name="Top"></a>
<h2 class="unnumbered">PHP Mode Manual</h2>
<p>This manual documents PHP mode version 1.4.0 for
use with GNU Emacs.
<p>Copyright &copy; 2008 Aaron S. Hawley
<blockquote>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License, Version 1.2 or any later version published by the
Free Software Foundation; with no Invariant Sections, and no
Cover Texts. A copy of the license is included in the
section entitled &ldquo;Copying This Manual.&rdquo;
<p>A copy of the license is also available from the Free
Software Foundation Web site at
<a href="http://www.gnu.org/licenses/fdl.html">http://www.gnu.org/licenses/fdl.html</a>.
</blockquote>
<p>The document was typeset with
<a href="http://www.texinfo.org/">GNU Texinfo</a>.
<p>$Date: 2008-01-03 20:50:20 -0500 (Thu, 03 Jan 2008) $
<p>$Revision: 30 $
<!-- Generate the nodes for this menu with `C-c C-u C-m'. -->
<!-- Update all node entries with `C-c C-u C-n'. -->
<!-- Insert new nodes with `C-c C-c n'. -->
<p><a name="Introduction"></a>
<h2 class="chapter">1 Introduction</h2>
<p><a name="index-C-mode-1"></a><a name="index-features-2"></a><a name="index-PEAR-3"></a><a name="index-PHP-versions-4"></a><a name="index-syntax-highlighting-5"></a><a name="index-version_002c-PHP-6"></a>PHP mode is a major mode for editing PHP source code in
Emacs. As an extension of Emacs's C mode, it inherits all C
mode's navigation and editing functionality. Syntax
elements of PHP source code is colored according to the
grammar of PHP versions 3, 4 and 5. By default, the indent
rules follow the PHP PEAR coding guidelines. Additional
aids for developing in PHP include documentation search of
the PHP manual, code completion and a class browser.
<p><a name="index-version_002c-PHP-mode-7"></a><a name="index-php_002dmode_002dversion-8"></a>To find out what version of PHP mode you have installed run
<kbd>M-x php-mode-version</kbd>.
<p>PHP mode was first released in 1999 and was written by
Turadg Aleahmad. At the time of PHP mode's initial release,
version 2 of PHP (PHP/FI) was only 2 years old and the
release of PHP 3 had happened the year before. In May of
2000, PHP 4 was released. Subsequent versions of PHP mode
scurried to support the quickly evolving syntax of this
emerging programming language.
<p>In 2001, PHP mode became a SourceForge project and version
1.0 was released later that year. Further refinements of
the Emacs library included improvements to the syntax
coloring rules, portability between XEmacs and GNU Emacs,
integration of various development tools available in
various Emacsen.
<p>PHP mode's support for PHP 5 first appeared in 2004, the
same year PHP 5 was released. 2004 was the last year
Aleahmad made a release. In 2005, Lennart Borgman combined
a forked version of PHP mode with his &ldquo;new XML mode for
Emacs&rdquo; (nXhtml). The stalled development of PHP resulted
in people sharing various patches and improvements to PHP
mode over the Internet.
<p>The 1.4 release in 2008 represented a renewed commitment to
the Emacs Lisp library with the addition of considerable
updates and improvements &ndash; the first in over 2 years.
<!-- In 2007, Aaron S. Hawley offered to update and maintain -->
<!-- PHP mode. PHP mode's files were moved from CVS to a -->
<!-- Subversion code repository. A release appeared in 2008 -->
<!-- with a number of improvements and updates to support -->
<!-- newer versions of CC mode and Emacs that were finally -->
<!-- released in 2007. PHP mode shipped with a 16 page -->
<!-- Texinfo manual authored by Hawley. -->
<p><a name="Electricity"></a>
<h2 class="chapter">2 Electricity</h2>
<p><a name="index-electricity-9"></a><a name="index-self_002dinsert_002dcommand-10"></a>Certain characters when inserted in Emacs have
<dfn>electricity</dfn>. Emacs recognizes them as &ldquo;electric&rdquo;
and automatically reacts in some way to their insertion.
This is unlike the <code>self-insert-command</code> &ndash; the
conventional manner most characters are inserted into the
buffer with no side-effect.
<p><a name="index-indentation_002c-electric-11"></a><a name="index-electric-indentation-12"></a><a name="index-declaration-blocks-13"></a><a name="index-conditional-statements-14"></a><a name="index-braces-15"></a><a name="index-comments-16"></a><a name="index-TAB-17"></a>For example, the indent commands for programming language
modes &ndash; including PHP mode &ndash; are electric. Hitting
<kbd>TAB</kbd> (or <kbd>C-i</kbd>) typically indents the line to the
correct column based on the nested declaration blocks or
conditional (control) syntax statements. Other examples of
electric characters include braces ({ and }), characters
that are recognized as comments (#, / and *), and
semicolons. Inserting &ldquo;electric&rdquo; characters causes the
line to be automatically be indented appropriately by PHP
mode.
<p><a name="index-quoted_002dinsert-18"></a><a name="index-C_002dq-19"></a><a name="index-c_002dtoggle_002delectric_002dstate-20"></a><a name="index-C_002dc-C_002dl-21"></a>Should PHP mode ever do something you wish it didn't, like
indenting incorrectly after inserting a character when you
wish it didn't, then you've been <dfn>electrocuted</dfn>. To
avoid this, use <code>quoted-insert</code> by prefixing the
character with <kbd>C-q</kbd>. For example, <kbd>C-q TAB</kbd> for a
tab. Alternatively, disable the electric effect of PHP mode
with <kbd>C-c C-l</kbd>. Issue <kbd>C-c C-l</kbd> again to activate
the electric effect again.
<!-- Is there a setting to use in ones .emacs to permanently -->
<!-- shut off electricity? -->
<p><a name="Motion"></a>
<h2 class="chapter">3 Motion</h2>
<p><a name="index-motion-22"></a><a name="index-movement-23"></a><a name="index-point-24"></a>The traditional commands for Emacs<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a> and Emacs's C
mode<a rel="footnote" href="#fn-2" name="fnd-2"><sup>2</sup></a> are supported in
PHP mode. The following commands are notable to mention for
working with PHP or are extensions expressly provided PHP
mode.
<a name="index-block-25"></a>
<a name="index-braces-26"></a>
<a name="index-parentheses-27"></a>
<a name="index-string-28"></a>
<a name="index-statements-29"></a>
<a name="index-syntax_002c-forward-30"></a>
<a name="index-forward_002dsexp-31"></a>
<a name="index-C_002dM_002df-32"></a>
<dl><dt><kbd>C-M-f</kbd><dd>Move forward past the current syntax (<code>forward-sexp</code>).
If point is in a string literal, move to the end of the
string. If point is at the beginning of a parenthetical
expression, move to the end of it. If at the beginning of
statement block that is surrounded by braces, move to the
end of the block. If point is at an identifier, skip to the
end of it.
<a name="index-syntax_002c-backward-33"></a><a name="index-backward_002dsexp-34"></a><a name="index-C_002dM_002db-35"></a><br><dt><kbd>C-M-b</kbd><dd>Same as <kbd>C-M-f</kbd>, except a syntactic element move to its
beginning (<code>backward-sexp</code>).
<a name="index-beginning-of-function-36"></a><a name="index-function_002c-beginning-of-37"></a><a name="index-c_002dbeginning_002dof_002ddefun-38"></a><a name="index-C_002dM_002da-39"></a><br><dt><kbd>C-M-a</kbd><dd>Move point to the beginning of the top-level function
definition (<code>c-beginning-of-defun</code>).
<a name="index-end-of-function-40"></a><a name="index-function_002c-end-of-41"></a><a name="index-c_002dend_002dof_002ddefun-42"></a><a name="index-C_002dM_002de-43"></a><br><dt><kbd>C-M-e</kbd><dd>Move point to the end of the top-level function definition
(<code>c-end-of-defun</code>).
<a name="index-end-of-function-44"></a><a name="index-function_002c-end-of-45"></a><a name="index-beginning_002dof_002ddefun-46"></a><a name="index-C_002dM_002d_003cHOME_003e-47"></a><br><dt><kbd>C-M-&lt;HOME&gt;</kbd><dd>Move point to the beginning of the current function
(<code>beginning-of-defun</code>).
<a name="index-end-of-function-48"></a><a name="index-function_002c-end-of-49"></a><a name="index-end_002dof_002ddefun-50"></a><a name="index-C_002dM_002d_003cEND_003e-51"></a><br><dt><kbd>C-M-&lt;END&gt;</kbd><dd>Move point to the end of the current function
(<code>end-of-defun</code>).
<a name="index-indentation_002c-move-to-52"></a><a name="index-back_002dto_002dindentation-53"></a><a name="index-M_002dm-54"></a><br><dt><kbd>M-m</kbd><dd>Move to the indentation at the beginning of the line
(<code>back-to-indentation</code>).
<a name="index-bumpy-case-55"></a><a name="index-camel-case-56"></a><a name="index-mixed-case-57"></a><a name="index-case_002c-mixed-58"></a><a name="index-function_002c-end-of-59"></a><a name="index-backward_002dword-60"></a><a name="index-forward_002dword-61"></a><a name="index-c_002dsubword_002dmode-62"></a><a name="index-C_002dc-C_002dw-63"></a><br><dt><kbd>C-c C-w</kbd><dd>Enable word motion across mixed case identifiers with
<code>forward-word</code> and <code>backward-word</code> commands
(<code>c-subword-mode</code>).
</dl>
<a name="index-universal-argument-64"></a><a name="index-numeric-argument-65"></a><a name="index-universal_002dargument-66"></a><a name="index-C_002du-67"></a>Most movement commands support prefixing the command with a
<dfn>numeric argument</dfn> by using Emacs's <dfn>universal
argument</dfn> command. Type <kbd>C-u </kbd><var>n</var>, where <var>n</var> is
the number of times to repeat a command. If no number
<var>n</var> is provided, Emacs will repeat the command 4 times
by default. See <a href="emacs.html#Arguments">Numeric Arguments</a>.
<p><a name="Indentation"></a>
<h2 class="chapter">4 Indentation</h2>
<p><a name="index-indentation-68"></a><a name="index-PEAR-69"></a><a name="index-spaces-70"></a><a name="index-tabs-71"></a>PHP mode's indentation settings follow the PHP PEAR &ldquo;Coding
Standards&rdquo;<a rel="footnote" href="#fn-3" name="fnd-3"><sup>3</sup></a>.
This has the consequence in PHP mode of making the
indentation commands use four spaces, and not tabs.
<p><a name="index-HTML-72"></a>PHP does not appropriately indent HTML tags. See <a href="#Embedded-HTML">Embedded HTML</a>.
<p>To customize PHP mode's indentation rules, change the
following variables.
<a name="index-indentation-level-73"></a>
<a name="index-c_002dbasic_002doffset-74"></a>
<dl><dt><code>c-basic-offset</code><dd>This style variable of CC mode controls how many columns in
the level of indentation. By default this is 4 spaces in
PHP mode (and in CC mode).
<a name="index-indent_002dtabs_002dmode-75"></a><br><dt><code>indent-tabs-mode</code><dd>Variable of Emacs that determines whether indentation
commands should insert the tab character or insert the
equivalent number of space characters. In PHP mode, this is
set to to nil by default.
<a name="index-tab_002dwidth-76"></a><br><dt><code>tab-width</code><dd>This variable of Emacs determines how &ldquo;wide&rdquo; a tab in the
buffer should be considered. This is also traditionally
described as setting the distance between &ldquo;tab stops&rdquo;. By
default, tabs are not inserted by PHP mode.
</dl>
<p>The usual commands for indenting in
Emacs<a rel="footnote" href="#fn-4" name="fnd-4"><sup>4</sup></a>
and Emacs's C mode<a rel="footnote" href="#fn-5" name="fnd-5"><sup>5</sup></a>: are supported in PHP mode, following the
indentation rules of PHP.
<a name="index-tab-77"></a>
<a name="index-indent-line-78"></a>
<a name="index-line_002c-indent-79"></a>
<a name="index-c_002dindent_002dcommand-80"></a>
<a name="index-TAB-81"></a>
<dl><dt><kbd>TAB</kbd><dd>Properly indent current line, even from the middle of the
line (<code>c-indent-command</code>).
<!-- provide examples? - ash 2007-12-29 -->
<a name="index-newline-82"></a><a name="index-indent-newline-83"></a><a name="index-indent-newline-84"></a><a name="index-newline_002dand_002dindent-85"></a><a name="index-C_002dj-86"></a><br><dt><kbd>C-j</kbd><dd>Insert text after point to a newline, and properly indent
the newline (<code>c-indent-command</code>).
<a name="index-indent-region-87"></a><a name="index-region_002c-indent-88"></a><a name="index-indent_002dregion-89"></a><a name="index-C_002dM_002d_005c-90"></a><br><dt><kbd>C-M-\</kbd><dd>Properly indent each line of region (<code>indent-region</code>).
<!-- I'm not going to bother mentioning C-x TAB, -->
<!-- M-x indent-rigidly. - ash 2007-12-29 -->
<a name="index-function_002c-indent-91"></a><a name="index-indent-function-92"></a><a name="index-class_002c-indent-93"></a><a name="index-indent-class-94"></a><a name="index-c_002dindent_002ddefun-95"></a><a name="index-C_002dc-C_002dq-96"></a><br><dt><kbd>C-c C-q</kbd><dd>Properly indent each line of current top-level function or
top-level class (<code>c-indent-defun</code>).
</dl>
<p><a name="Editing"></a>
<h2 class="chapter">5 Editing</h2>
<a name="index-paragraph_002c-fill-97"></a>
<a name="index-filling-98"></a>
<a name="index-indentation_002c-filling-99"></a>
<a name="index-filling-indentation-100"></a>
<a name="index-filling-comment-101"></a>
<a name="index-comment_002c-filling-102"></a>
<a name="index-Docblock-comment-103"></a>
<a name="index-comment_002c-Docblock-104"></a>
<a name="index-c_002dfill_002dparagraph-105"></a>
<a name="index-M_002dq-106"></a>
<dl><dt><kbd>M-q</kbd><dd>Fill the paragraph to current value of <code>fill-column</code>.
The command does the right thing for indented code and PHP
comments including Docblock comments.
<a name="index-column_002c-fill-107"></a><a name="index-fill-column-108"></a><a name="index-fill_002dcolumn-109"></a><a name="index-set_002dfill_002dcolumn-110"></a><a name="index-fill_002dparagraph-111"></a><a name="index-C_002dx-f-112"></a><br><dt><kbd>C-u </kbd><var>n</var><kbd> C-x f</kbd><dd>Set the <code>fill-column</code> to <var>n</var> when using the <kbd>M-q</kbd>
command (<code>fill-paragraph</code>).
<a name="index-function_002c-mark-113"></a><a name="index-kill_002dregion-114"></a><a name="index-kill_002dring_002dsave-115"></a><a name="index-indent_002dregion-116"></a><a name="index-indent_002drigidly-117"></a><a name="index-c_002dmark_002dfunction-118"></a><a name="index-C_002dM_002dh-119"></a><a name="index-C_002dw-120"></a><a name="index-M_002dw-121"></a><a name="index-C_002dM_002d_005c-122"></a><br><dt><kbd>C-M-h</kbd><dd>Mark the current function (<code>c-mark-function</code>). Puts
the mark at the end and of the function and the point at the
beginning. Useful if you want to kill the region with
<kbd>C-w</kbd> or <kbd>M-w</kbd>, or indent the region with
<kbd>C-M-\</kbd> or <kbd>C-x TAB</kbd> (See <a href="#Indentation">Indentation</a>.).
</dl>
<p><a name="Completion"></a>
<h2 class="chapter">6 Completion</h2>
<p><a name="index-completion-123"></a>Completing function names, identifiers and keywords in PHP
is possible in PHP mode. In PHP mode, it is possible to
complete identifiers defined by PHP programming language,
and functions defined by you.
<p><a name="index-customization_002c-PHP-manual-path-124"></a><a name="index-PHP-manual-path-125"></a><a name="index-php_002dmanual_002dpath-126"></a><a name="index-g_t_002eemacs_002c-php_002dmanual_002dpath-127"></a><a name="index-customize_002dvariable-128"></a>For PHP mode to know the functions of keywords of PHP, it
must have access to the PHP manual. Download the HTML
archive of the manual made of separate files for each
function.<a rel="footnote" href="#fn-6" name="fnd-6"><sup>6</sup></a>
Unpack the files to a directory, and define the variable
<var>php-manual-path</var> to the location of these files.
Configure this setting with either <kbd>M-x
customize-variable RET php-manual-path RET</kbd>, or by setting
the value in your Emacs initialization file
(<samp><span class="file">~/.emacs</span></samp>). The PHP function names
<p><a name="index-etags-129"></a><a name="index-tag-file-130"></a><a name="index-Makefile-131"></a>For functions and classes you define, you'll need to provide
them to Emacs as a <dfn>tag file</dfn>.<a rel="footnote" href="#fn-7" name="fnd-7"><sup>7</sup></a> Creating a
tag file (<samp><span class="file">TAGS</span></samp>) from a PHP source code file is done
by running the <samp><span class="command">etags</span></samp> command on the
file.<a rel="footnote" href="#fn-8" name="fnd-8"><sup>8</sup></a> The
<samp><span class="command">etags</span></samp> command can even generate tag files for
providing completion across multiple files. For larger
projects and PHP coded libraries, use a system like a
Makefile to generate and maintain the tag tables.
<p><a name="index-etags_002c-running-132"></a>Run,
<pre class="example"> etags <var>file</var>
</pre>
<p>to create a tags file for <var>file</var>.
<p>To generate a tag file for all the PHP files in the current
directory, run
<pre class="example"> etags *.php
</pre>
<p>To enable a tags file you need to use the following command.
<a name="index-tag-133"></a>
<a name="index-visit_002dtags_002dtable-134"></a>
<dl><dt><kbd>C-u M-x visit-tags-table</kbd><dd>Specify the <samp><span class="file">TAGS</span></samp> file that PHP mode should use to
find completion candidates for the current buffer.
<br><dt><kbd>M-x visit-tags-table</kbd><dd>Specify the <samp><span class="file">TAGS</span></samp> file that PHP mode should use to
find completion candidates for all buffers, and even other
modes other than PHP mode.
</dl>
<p><a name="index-customization_002c-PHP-completion-file-135"></a><a name="index-PHP-completion-file-136"></a><a name="index-php_002dcompletion_002dfile-137"></a><a name="index-g_t_002eemacs_002c-php_002dcompletion_002dfile-138"></a><a name="index-customize_002dvariable-139"></a>To avoid either
<ol type=1 start=1>
<li>avoid regenerating the completion table from the PHP manual
every Emacs session,
<li>to generate a completion file from a facility external to
Emacs tags,
<li>or to provide more granular control over the completion
rules for files;
</ol>
<p>consider using the variable <code>php-completion-file</code>.
<p>Configure this setting with either <kbd>M-x
customize-variable RET php-completion-file RET</kbd>, or by
setting the value in your Emacs initialization file
(<samp><span class="file">~/.emacs</span></samp>).
<p>For larger projects or because of other specific needs,
conventional ways of setting these and other variables may
be inadequate. As of 2008, third-party packages do exist
for Emacs to configure Emacs settings on groups of files or
for directory trees, including <samp><span class="file">dirvars.el</span></samp>.
<a name="index-complete-function-140"></a>
<a name="index-function_002c-complete-141"></a>
<a name="index-php_002dcomplete_002dfunction-142"></a>
<a name="index-M_002dTAB-143"></a>
<a name="index-ESC-TAB-144"></a>
<a name="index-C_002d_005b-TAB-145"></a>
<dl><dt><kbd>M-TAB</kbd><br><dt><kbd>ESC TAB</kbd><br><dt><kbd>C-[ TAB</kbd><dd>Complete function name at point (<code>php-complete-function</code>).
<a name="index-argument-list_002c-function-146"></a><a name="index-function-argument-list-147"></a><a name="index-minibuffer-148"></a><a name="index-php_002dshow_002darglist-149"></a><a name="index-C_002d_002e-150"></a><br><dt><kbd>C-.</kbd><dd>Show in the minibuffer the argument list for the current
function at point (<code>php-show-arglist</code>). The argument
list is generated by finding and jumping to the respective
function's location specified in the tag file (see above).
The argument list is then read and printed to the
minibuffer.
</dl>
<p><a name="PHP-Comments"></a>
<h2 class="chapter">7 PHP Comments</h2>
<p><a name="index-comment-151"></a>The usual commands for inserting, managing and editing
source code comments in Emacs Emacs<a rel="footnote" href="#fn-9" name="fnd-9"><sup>9</sup></a> and Emacs's C mode<a rel="footnote" href="#fn-10" name="fnd-10"><sup>10</sup></a>: are supported in PHP mode. The following
commands are notable to mention for working with PHP and are
expressly provided for PHP mode.
<a name="index-comment_002c-insert-152"></a>
<a name="index-indent-comment-153"></a>
<a name="index-insert-comment-154"></a>
<a name="index-comment_002c-indent-155"></a>
<a name="index-comment_002dindent-156"></a>
<a name="index-comment_002ddwim-157"></a>
<a name="index-M_002d_003b-158"></a>
<dl><dt><kbd>M-;</kbd><dd>Insert comment at point (<code>comment-dwim</code>). If comment
already exist, indent comment (<code>comment-indent</code>).
<a name="index-M_002dx-comment_002dindent-159"></a><a name="index-newline_002c-comment-160"></a><a name="index-comment-newline-161"></a><a name="index-c_002dindent_002dnew_002dcomment_002dline-162"></a><a name="index-M_002dj-163"></a><br><dt><kbd>M-j</kbd><dd>Insert a newline in a comment on the next line with the
comment starting at the same place as the current line
(<code>c-indent-new-comment-line</code>).
<a name="index-column_002c-comment-164"></a><a name="index-comment-column-165"></a><a name="index-comment_002dcolumn-166"></a><a name="index-comment_002dset_002dcolumn-167"></a><a name="index-C_002dx-_003b-168"></a><br><dt><kbd>C-x ;</kbd><dd>Set the current column as the column to start comments from
in the buffer (<code>comment-set-column</code>). This affects the
variable <code>comment-column</code>.
<a name="index-comment-region-169"></a><a name="index-region_002c-comment-170"></a><a name="index-comment_002dregion-171"></a><a name="index-C_002dc-C_002dc-172"></a><br><dt><kbd>C-c C-c</kbd><dd>Comment out the current region (<code>comment-region</code>). If
region is already commented, the region is uncommented.
<!-- I'm not going to bother mentioning the numeric prefix -->
<!-- argument variations. - ash 2008-01-01 -->
<a name="index-comment_002c-kill-173"></a><a name="index-kill-comment-174"></a><a name="index-comment_002ddwim-175"></a><a name="index-comment_002dset_002dcolumn-176"></a><a name="index-comment_002dkill-177"></a><a name="index-M_002d_002d-C_002dx-_003b-178"></a><br><dt><kbd>M-- C-x ;</kbd><br><dt><kbd>C-u M-;</kbd><dd>Kill the comment on the current line (<code>comment-kill</code>
called by <code>comment-set-column</code> or <code>comment-dwim</code>).
<br><dt><kbd>C-u </kbd><var>n</var><kbd> M-;</kbd><dd>Kill the next <var>n</var> comments (<code>comment-dwim</code>).
<a name="index-region_002c-comment-box-179"></a><a name="index-comment-box-180"></a><a name="index-comment_002dbox-181"></a><a name="index-M_002dx-comment_002dbox-182"></a><br><dt><kbd>M-x comment-box</kbd><dd>Surround region with comment characters.
</dl>
<p><a name="PHP-Documentation"></a>
<h2 class="chapter">8 PHP Documentation</h2>
<p><a name="index-customization_002c-browse_002durl-183"></a><a name="index-documentation_002c-PHP-184"></a><a name="index-PHP-documentation-185"></a><a name="index-browse_002durl-186"></a><a name="index-customize_002dgroup-187"></a>PHP mode supports the online documentation available from
<a href="http://www.php.net/">http://www.php.net/</a>. These commands are handled by
<code>browse-url</code>. Run the Emacs command <kbd>M-x
customize-group RET browse-url RET</kbd> to configure how
<code>browse-url</code> behaves.
<a name="index-browse-PHP-manual-188"></a>
<a name="index-php_002dbrowse_002dmanual-189"></a>
<a name="index-C_002dc-C_002dm-190"></a>
<a name="index-C_002dc-RET-191"></a>
<dl><dt><kbd>C-c C-m</kbd><br><dt><kbd>C-c RET</kbd><dd>Browse PHP manual in a Web browser.
<a name="index-search-PHP-manual-192"></a><a name="index-php_002dsearch_002ddocumentation-193"></a><a name="index-C_002dc-C_002df-194"></a><br><dt><kbd>C-c C-f</kbd><dd>Search PHP manual using identifier at point.
</dl>
<p><a name="Index-Menu"></a>
<h2 class="chapter">9 Index Menu</h2>
<p><a name="index-index-menu-195"></a><a name="index-menu_002c-index-196"></a><a name="index-index_002c-class-197"></a><a name="index-index_002c-function-198"></a><a name="index-class-index-199"></a><a name="index-function-index-200"></a>PHP mode provides a menu of the functions and classes
defined in the current buffer. The menu is pretty simple,
but is helpful when navigating large files. The contents of
the menu also provide a good overview to the user about the
file's contents.
<p>To enable this menu, run the following command.
<a name="index-menu-bar-201"></a>
<a name="index-imenu_002dadd_002dmenubar_002dindex-202"></a>
<dl><dt><kbd>M-x imenu-add-menubar-index</kbd><dd>Scan the file for functions and class declarations, then add
a menu item called &ldquo;Index&rdquo; to the menu bar.
</dl>
<p>In the menu are any one or more of the following menu items.
<a name="index-imenu-203"></a>
<dl><dt>`<samp><span class="samp">Functions</span></samp>'<dd>A sub-menu containing the names of functions defined in the
current buffer. Clicking on a function name will visit the
location of the function's definition.
<a name="index-imenu-204"></a><br><dt>`<samp><span class="samp">Classes</span></samp>'<dd>A sub-menu containing the names of classes defined in the
current buffer. Clicking on a class name will visit the
location of the class's definition.
<a name="index-imenu_002dupdate_002dmenubar-205"></a><a name="index-rescan-206"></a><br><dt>`<samp><span class="samp">*Rescan*</span></samp>'<dd>Rescan the contents of the current buffer, and update both
the indexes the entries in the menu.
</dl>
<p><a name="index-customization_002c-Imenu-auto-rescan-207"></a><a name="index-rescan_002c-automatically-208"></a><a name="index-g_t_002eemacs_002c-imenu_002dauto_002drescan-209"></a><a name="index-imenu_002dauto_002drescan-210"></a><a name="index-customize_002dvariable-211"></a>To have Emacs automatically rescan the current buffer,
change the setting for <code>imenu-auto-rescan</code> to non-nil
with either <kbd>M-x customize-variable RET
php-completion-file RET</kbd>, or by setting the value in your
Emacs initialization file (<samp><span class="file">~/.emacs</span></samp>).
<p><a name="Change-Logs"></a>
<h2 class="chapter">10 Change Logs</h2>
<p>PHP mode can help generate <samp><span class="file">ChangeLog</span></samp> files, a
widely-adopted format for documenting the changes made to
source code, especially software. PHP mode and Emacs will
determine the current function, file name, author
information and date and use it all to prepare a properly
formatted entry for the file.
<p>The <code>add-change-log-entry</code> commands can be run from
within a buffer containing a PHP buffer, or from a buffer in
Diff mode with a revision patch to a PHP source file.
See <a href="emacs.html#Diff-Mode">Diff Mode</a>.
<dl>
<dt><kbd>C-x 4 a</kbd><dd>Add an entry in a ChangeLog file opened in another window,
or add a new line to the already begun entry
(<code>add-change-log-entry-other-window</code>). Provides the
file name and the respective function name, when applicable,
for the current point
</dl>
<p><a name="Speedbar"></a>
<h2 class="chapter">11 Speedbar</h2>
<p>FIXME: Document speedbar support for PHP mode.
<p><a name="Customization"></a>
<h2 class="chapter">12 Customization</h2>
<p><a name="index-customization-212"></a><a name="index-g_t_002eemacs-213"></a><a name="index-initialization-file-214"></a>Customization for PHP mode can be done using Emacs's
Customize feature<a rel="footnote" href="#fn-11" name="fnd-11"><sup>11</sup></a>, or
by adding bits of Emacs Lisp to your Emacs initialization
file (<samp><span class="file">~/.emacs</span></samp>).
<a name="index-customize_002dgroup-215"></a>
<dl><dt><kbd>M-x customize-group RET php RET</kbd><dd>Start a `<samp><span class="samp">*Customize*</span></samp>' buffer with the customizable
settings for PHP mode.
</dl>
<p><a name="Embedded-HTML"></a>
<h2 class="appendix">Appendix A Embedded HTML</h2>
<p><a name="index-markup-formats-216"></a><a name="index-XML-217"></a><a name="index-SGML-218"></a><a name="index-embedded-code-219"></a><a name="index-indentation-220"></a><a name="index-HTML-221"></a><a name="index-php_002dmode-222"></a><a name="index-M_002dx-php_002dmode-223"></a>The PHP programming language is commonly embedded with HTML
but also with other markup formats. Unfortunately, PHP mode
is currently unable to recognize these other bits and
provide commands that behave appropriately. Other modes for
Emacs for properly indenting are available, including HTML
mode, SGML mode and XML mode.
<p><a name="index-html_002dmode-224"></a><a name="index-php_002dmode-225"></a>For example, when editing the HTML sections found in a PHP
file, consider turning on HTML mode with <kbd>M-x
html-mode</kbd>. Use the the mode-specific commands for
manipulating the HTML. When finished, turn back on PHP mode
with <kbd>M-x php-mode</kbd> to return working on the PHP sections
of the file.
<p><a name="index-multiple-major-mode-226"></a><a name="index-mumamo-227"></a><a name="index-mmm_002dmode-228"></a><a name="index-multi_002dmode-229"></a>Alternatively, consider using a <dfn>multiple major mode</dfn>
like mumamo, mmm-mode or multi-mode. These modes allow a
single buffer to appoint different major modes to respective
portions of the buffer.
<p><a name="Contributors"></a>
<h2 class="appendix">Appendix B Contributors</h2>
<ul>
<li>Juanjo
<li>Torsten Martinsen
<li>Vinai Kopp
<li>Sean Champ
<li>Doug Marcey
<li>Kevin Blake
<li>Rex McMaster
<li>Mathias Meyer
<li>Boris Folgmann
<li>Roland Rosenfeld
<li>Fred Yankowski
<li>Craig Andrews
<li>John Keller
<li>Ryan Sammartino
<li>ppercot
<li>Valentin Funk
<li>Stig Bakken
<li>Gregory Stark
<li>Chris Morris
<li>Nils Rennebarth
<li>Gerrit Riessen
<li>Eric Mc Sween
<li>Ville Skytta
<li>Giacomo Tesio
<li>Lennart Borgman
<li>Stefan Monnier
<li>Aaron S. Hawley
</ul>
<p><a name="Copying-This-Manual"></a>
<h2 class="appendix">Appendix C Copying This Manual</h2>
<!-- Get fdl.texi from http://www.gnu.org/licenses/fdl.html -->
<!-- The GNU Free Documentation License. -->
<div align="center">Version 1.2, November 2002</div>
<!-- This file is intended to be included within another document, -->
<!-- hence no sectioning command or @node. -->
<pre class="display"> Copyright &copy; 2000,2001,2002 Free Software Foundation, Inc.
51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre>
<ol type=1 start=0>
<li>PREAMBLE
<p>The purpose of this License is to make a manual, textbook, or other
functional and useful document <dfn>free</dfn> in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
<p>This License is a kind of &ldquo;copyleft&rdquo;, which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
<p>We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
<li>APPLICABILITY AND DEFINITIONS
<p>This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein. The &ldquo;Document&rdquo;, below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as &ldquo;you&rdquo;. You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
<p>A &ldquo;Modified Version&rdquo; of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
<p>A &ldquo;Secondary Section&rdquo; is a named appendix or a front-matter section
of the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
any mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
<p>The &ldquo;Invariant Sections&rdquo; are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant. The Document may contain zero
Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
<p>The &ldquo;Cover Texts&rdquo; are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
<p>A &ldquo;Transparent&rdquo; copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters. A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text. A copy that is not &ldquo;Transparent&rdquo; is called &ldquo;Opaque&rdquo;.
<p>Examples of suitable formats for Transparent copies include plain
<span class="sc">ascii</span> without markup, Texinfo input format, LaTeX input
format, <acronym>SGML</acronym> or <acronym>XML</acronym> using a publicly available
<acronym>DTD</acronym>, and standard-conforming simple <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> designed for human modification. Examples
of transparent image formats include <acronym>PNG</acronym>, <acronym>XCF</acronym> and
<acronym>JPG</acronym>. Opaque formats include proprietary formats that can be
read and edited only by proprietary word processors, <acronym>SGML</acronym> or
<acronym>XML</acronym> for which the <acronym>DTD</acronym> and/or processing tools are
not generally available, and the machine-generated <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> produced by some word processors for
output purposes only.
<p>The &ldquo;Title Page&rdquo; means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, &ldquo;Title Page&rdquo; means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.
<p>A section &ldquo;Entitled XYZ&rdquo; means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as &ldquo;Acknowledgements&rdquo;,
&ldquo;Dedications&rdquo;, &ldquo;Endorsements&rdquo;, or &ldquo;History&rdquo;.) To &ldquo;Preserve the Title&rdquo;
of such a section when you modify the Document means that it remains a
section &ldquo;Entitled XYZ&rdquo; according to this definition.
<p>The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
<li>VERBATIM COPYING
<p>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
<p>You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
<li>COPYING IN QUANTITY
<p>If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document's license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
<p>If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
<p>If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
<p>It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
<li>MODIFICATIONS
<p>You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
<ol type=A start=1>
<li>Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
<li>List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
<li>State on the Title page the name of the publisher of the
Modified Version, as the publisher.
<li>Preserve all the copyright notices of the Document.
<li>Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
<li>Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
<li>Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
<li>Include an unaltered copy of this License.
<li>Preserve the section Entitled &ldquo;History&rdquo;, Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled &ldquo;History&rdquo; in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
<li>Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the &ldquo;History&rdquo; section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
<li>For any section Entitled &ldquo;Acknowledgements&rdquo; or &ldquo;Dedications&rdquo;, Preserve
the Title of the section, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.
<li>Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
<li>Delete any section Entitled &ldquo;Endorsements&rdquo;. Such a section
may not be included in the Modified Version.
<li>Do not retitle any existing section to be Entitled &ldquo;Endorsements&rdquo; or
to conflict in title with any Invariant Section.
<li>Preserve any Warranty Disclaimers.
</ol>
<p>If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
<p>You may add a section Entitled &ldquo;Endorsements&rdquo;, provided it contains
nothing but endorsements of your Modified Version by various
parties&mdash;for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
<p>You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
<p>The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
<li>COMBINING DOCUMENTS
<p>You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
<p>The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
<p>In the combination, you must combine any sections Entitled &ldquo;History&rdquo;
in the various original documents, forming one section Entitled
&ldquo;History&rdquo;; likewise combine any sections Entitled &ldquo;Acknowledgements&rdquo;,
and any sections Entitled &ldquo;Dedications&rdquo;. You must delete all
sections Entitled &ldquo;Endorsements.&rdquo;
<li>COLLECTIONS OF DOCUMENTS
<p>You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
<p>You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
<li>AGGREGATION WITH INDEPENDENT WORKS
<p>A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an &ldquo;aggregate&rdquo; if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation's users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
<p>If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document's Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
<li>TRANSLATION
<p>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
<p>If a section in the Document is Entitled &ldquo;Acknowledgements&rdquo;,
&ldquo;Dedications&rdquo;, or &ldquo;History&rdquo;, the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.
<li>TERMINATION
<p>You may not copy, modify, sublicense, or distribute the Document except
as expressly provided for under this License. Any other attempt to
copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However,
parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such
parties remain in full compliance.
<li>FUTURE REVISIONS OF THIS LICENSE
<p>The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>.
<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License &ldquo;or any later version&rdquo; applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation.
</ol>
<h3 class="heading">ADDENDUM: How to use this License for your documents</h3>
<p>To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
<pre class="smallexample"> Copyright (C) <var>year</var> <var>your name</var>.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
</pre>
<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the &ldquo;with<small class="dots">...</small>Texts.&rdquo; line with this:
<pre class="smallexample"> with the Invariant Sections being <var>list their titles</var>, with
the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts
being <var>list</var>.
</pre>
<p>If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
<p>If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
<!-- Local Variables: -->
<!-- ispell-local-pdict: "ispell-dict" -->
<!-- End: -->
<p><a name="Concept-Index"></a>
<h2 class="unnumbered">Concept Index</h2>
<ul class="index-cp" compact>
<li><a href="#index-g_t_002eemacs-213">.emacs</a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-g_t_002eemacs_002c-imenu_002dauto_002drescan-209">.emacs, imenu-auto-rescan</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-g_t_002eemacs_002c-php_002dcompletion_002dfile-138">.emacs, php-completion-file</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-g_t_002eemacs_002c-php_002dmanual_002dpath-127">.emacs, php-manual-path</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-argument-list_002c-function-146">argument list, function</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-beginning-of-function-36">beginning of function</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-block-25">block</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-braces-26">braces</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-braces-15">braces</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-browse-PHP-manual-188">browse PHP manual</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-bumpy-case-55">bumpy case</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C-mode-1">C mode</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-camel-case-56">camel case</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-case_002c-mixed-58">case, mixed</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-class-index-199">class index</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-class_002c-indent-93">class, indent</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-column_002c-comment-164">column, comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-column_002c-fill-107">column, fill</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-comment-151">comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment-box-180">comment box</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment-column-165">comment column</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment-newline-161">comment newline</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment-region-169">comment region</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002c-Docblock-104">comment, Docblock</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-comment_002c-filling-102">comment, filling</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-comment_002c-indent-155">comment, indent</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002c-insert-152">comment, insert</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002c-kill-173">comment, kill</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comments-16">comments</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-complete-function-140">complete function</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-completion-123">completion</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-conditional-statements-14">conditional statements</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-customization-212">customization</a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-customization_002c-browse_002durl-183">customization, browse-url</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-customization_002c-Imenu-auto-rescan-207">customization, Imenu auto rescan</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-customization_002c-PHP-completion-file-135">customization, PHP completion file</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-customization_002c-PHP-manual-path-124">customization, PHP manual path</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-declaration-blocks-13">declaration blocks</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-Docblock-comment-103">Docblock comment</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-documentation_002c-PHP-184">documentation, PHP</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-electric-indentation-12">electric indentation</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-electricity-9">electricity</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-embedded-code-219">embedded code</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-end-of-function-40">end of function</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-etags-129">etags</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-etags_002c-running-132">etags, running</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-features-2">features</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-fill-column-108">fill column</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-fill_002dcolumn-109">fill-column</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-filling-98">filling</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-filling-comment-101">filling comment</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-filling-indentation-100">filling indentation</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-function-argument-list-147">function argument list</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-function-index-200">function index</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-function_002c-beginning-of-37">function, beginning of</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-function_002c-complete-141">function, complete</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-function_002c-end-of-41">function, end of</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-function_002c-indent-91">function, indent</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-function_002c-mark-113">function, mark</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-HTML-221">HTML</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-HTML-72">HTML</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-class-94">indent class</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-comment-153">indent comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-indent-function-92">indent function</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-line-78">indent line</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-newline-83">indent newline</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-region-87">indent region</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indentation-220">indentation</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-indentation-68">indentation</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indentation-level-73">indentation level</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indentation_002c-electric-11">indentation, electric</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-indentation_002c-filling-99">indentation, filling</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-indentation_002c-move-to-52">indentation, move to</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-index-menu-195">index menu</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-index_002c-class-197">index, class</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-index_002c-function-198">index, function</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-initialization-file-214">initialization file</a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-insert-comment-154">insert comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-kill-comment-174">kill comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-line_002c-indent-79">line, indent</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-Makefile-131">Makefile</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-markup-formats-216">markup formats</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-menu-bar-201">menu bar</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-menu_002c-index-196">menu, index</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-minibuffer-148">minibuffer</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-mixed-case-57">mixed case</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-mmm_002dmode-228">mmm-mode</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-motion-22">motion</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-movement-23">movement</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-multi_002dmode-229">multi-mode</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-multiple-major-mode-226">multiple major mode</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-mumamo-227">mumamo</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-newline-82">newline</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-newline_002c-comment-160">newline, comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-numeric-argument-65">numeric argument</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-paragraph_002c-fill-97">paragraph, fill</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-parentheses-27">parentheses</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-PEAR-69">PEAR</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-PEAR-3">PEAR</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-PHP-completion-file-136">PHP completion file</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-PHP-documentation-185">PHP documentation</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-PHP-manual-path-125">PHP manual path</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-PHP-versions-4">PHP versions</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-point-24">point</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-region_002c-comment-170">region, comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-region_002c-comment-box-179">region, comment box</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-region_002c-indent-88">region, indent</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-rescan-206">rescan</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-rescan_002c-automatically-208">rescan, automatically</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-search-PHP-manual-192">search PHP manual</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-SGML-218">SGML</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-spaces-70">spaces</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-statements-29">statements</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-string-28">string</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-syntax-highlighting-5">syntax highlighting</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-syntax_002c-backward-33">syntax, backward</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-syntax_002c-forward-30">syntax, forward</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-tab-77">tab</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-tabs-71">tabs</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-tag-133">tag</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-tag-file-130">tag file</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-universal-argument-64">universal argument</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-version_002c-PHP-6">version, PHP</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-version_002c-PHP-mode-7">version, PHP mode</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-XML-217">XML</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
</ul><p><a name="Function-Index"></a>
<h2 class="unnumbered">Function Index</h2>
<ul class="index-fn" compact>
<li><a href="#index-back_002dto_002dindentation-53"><code>back-to-indentation</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-backward_002dsexp-34"><code>backward-sexp</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-backward_002dword-60"><code>backward-word</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-beginning_002dof_002ddefun-46"><code>beginning-of-defun</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-browse_002durl-186"><code>browse-url</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-c_002dbeginning_002dof_002ddefun-38"><code>c-beginning-of-defun</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-c_002dend_002dof_002ddefun-42"><code>c-end-of-defun</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-c_002dfill_002dparagraph-105"><code>c-fill-paragraph</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-c_002dindent_002dcommand-80"><code>c-indent-command</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-c_002dindent_002ddefun-95"><code>c-indent-defun</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-c_002dindent_002dnew_002dcomment_002dline-162"><code>c-indent-new-comment-line</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-c_002dmark_002dfunction-118"><code>c-mark-function</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-c_002dsubword_002dmode-62"><code>c-subword-mode</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-c_002dtoggle_002delectric_002dstate-20"><code>c-toggle-electric-state</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-comment_002dbox-181"><code>comment-box</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002ddwim-157"><code>comment-dwim</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002dindent-156"><code>comment-indent</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002dkill-177"><code>comment-kill</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002dregion-171"><code>comment-region</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002dset_002dcolumn-167"><code>comment-set-column</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-customize_002dgroup-215"><code>customize-group</code></a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-customize_002dgroup-187"><code>customize-group</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-customize_002dvariable-211"><code>customize-variable</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-customize_002dvariable-128"><code>customize-variable</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-end_002dof_002ddefun-50"><code>end-of-defun</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-fill_002dparagraph-111"><code>fill-paragraph</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-forward_002dsexp-31"><code>forward-sexp</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-forward_002dword-61"><code>forward-word</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-html_002dmode-224"><code>html-mode</code></a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-imenu-203"><code>imenu</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-imenu_002dadd_002dmenubar_002dindex-202"><code>imenu-add-menubar-index</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-imenu_002dupdate_002dmenubar-205"><code>imenu-update-menubar</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-indent_002dregion-116"><code>indent-region</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-indent_002dregion-89"><code>indent-region</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent_002drigidly-117"><code>indent-rigidly</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-kill_002dregion-114"><code>kill-region</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-kill_002dring_002dsave-115"><code>kill-ring-save</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-newline_002dand_002dindent-85"><code>newline-and-indent</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-php_002dbrowse_002dmanual-189"><code>php-browse-manual</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-php_002dcomplete_002dfunction-142"><code>php-complete-function</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-php_002dmode-222"><code>php-mode</code></a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-php_002dmode_002dversion-8"><code>php-mode-version</code></a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-php_002dsearch_002ddocumentation-193"><code>php-search-documentation</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-php_002dshow_002darglist-149"><code>php-show-arglist</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-quoted_002dinsert-18"><code>quoted-insert</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-self_002dinsert_002dcommand-10"><code>self-insert-command</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-set_002dfill_002dcolumn-110"><code>set-fill-column</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-universal_002dargument-66"><code>universal-argument</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-visit_002dtags_002dtable-134"><code>visit-tags-table</code></a>: <a href="#Completion">Completion</a></li>
</ul><p><a name="Keyboard-Index"></a>
<h2 class="unnumbered">Keyboard Index</h2>
<ul class="index-ky" compact>
<li><a href="#index-C_002d_002e-150"><code>C-.</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-C_002d_005b-TAB-145"><code>C-[ TAB</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-C_002dc-C_002dc-172"><code>C-c C-c</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-C_002dc-C_002df-194"><code>C-c C-f</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-C_002dc-C_002dl-21"><code>C-c C-l</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-C_002dc-C_002dm-190"><code>C-c C-m</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-C_002dc-C_002dq-96"><code>C-c C-q</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-C_002dc-C_002dw-63"><code>C-c C-w</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dc-RET-191"><code>C-c RET</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-C_002dj-86"><code>C-j</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-C_002dM_002d_003cEND_003e-51"><code>C-M-&lt;END&gt;</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002d_003cHOME_003e-47"><code>C-M-&lt;HOME&gt;</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002d_005c-122"><code>C-M-\</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-C_002dM_002d_005c-90"><code>C-M-\</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-C_002dM_002da-39"><code>C-M-a</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002db-35"><code>C-M-b</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002de-43"><code>C-M-e</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002df-32"><code>C-M-f</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002dh-119"><code>C-M-h</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-C_002dq-19"><code>C-q</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-C_002du-67"><code>C-u</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dw-120"><code>C-w</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-C_002dx-_003b-168"><code>C-x ;</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-C_002dx-f-112"><code>C-x f</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-ESC-TAB-144"><code>ESC TAB</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-M_002d_002d-C_002dx-_003b-178"><code>M-- C-x ;</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002d_003b-158"><code>M-;</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002dj-163"><code>M-j</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002dm-54"><code>M-m</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-M_002dq-106"><code>M-q</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-M_002dTAB-143"><code>M-TAB</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-M_002dw-121"><code>M-w</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-M_002dx-comment_002dbox-182"><code>M-x comment-box</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002dx-comment_002dindent-159"><code>M-x comment-indent</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002dx-php_002dmode-223"><code>M-x php-mode</code></a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-TAB-81"><code>TAB</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-TAB-17"><code>TAB</code></a>: <a href="#Electricity">Electricity</a></li>
</ul><p><a name="Variable-Index"></a>
<h2 class="unnumbered">Variable Index</h2>
<ul class="index-vr" compact>
<li><a href="#index-c_002dbasic_002doffset-74"><code>c-basic-offset</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-comment_002dcolumn-166"><code>comment-column</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-imenu_002dauto_002drescan-210"><code>imenu-auto-rescan</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-indent_002dtabs_002dmode-75"><code>indent-tabs-mode</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-php_002dcompletion_002dfile-137"><code>php-completion-file</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-php_002dmanual_002dpath-126"><code>php-manual-path</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-tab_002dwidth-76"><code>tab-width</code></a>: <a href="#Indentation">Indentation</a></li>
</ul><div class="footnote">
<hr>
<a name="texinfo-footnotes-in-document"></a><h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> See <a href="emacs.html#Moving-Point">Changing the Location of Point</a>.</p>
<p class="footnote"><small>[<a name="fn-2" href="#fnd-2">2</a>]</small> See <a href="ccmode.html#Movement-Commands">Movement Commands</a>.</p>
<p class="footnote"><small>[<a name="fn-3" href="#fnd-3">3</a>]</small> <a href="http://pear.php.net/manual/en/standards.php">http://pear.php.net/manual/en/standards.php</a></p>
<p class="footnote"><small>[<a name="fn-4" href="#fnd-4">4</a>]</small> See <a href="emacs.html#Indentation-Commands">Indentation Commands</a>.</p>
<p class="footnote"><small>[<a name="fn-5" href="#fnd-5">5</a>]</small> See <a href="ccmode.html#Indentation-Commands">Indentation Commands</a>.</p>
<p class="footnote"><small>[<a name="fn-6" href="#fnd-6">6</a>]</small> <a href="http://www.php.net/download-docs.php">http://www.php.net/download-docs.php</a></p>
<p class="footnote"><small>[<a name="fn-7" href="#fnd-7">7</a>]</small> See <a href="emacs.html#Tags">Tags Tables</a>.</p>
<p class="footnote"><small>[<a name="fn-8" href="#fnd-8">8</a>]</small> See <a href="emacs.html#Create-Tags-Table">Creating Tags Tables</a>.</p>
<p class="footnote"><small>[<a name="fn-9" href="#fnd-9">9</a>]</small> See <a href="emacs.html#Comments">Manipulating Comments</a>.</p>
<p class="footnote"><small>[<a name="fn-10" href="#fnd-10">10</a>]</small> See <a href="ccmode.html#Comment-Commands">Comment Commands</a>.</p>
<p class="footnote"><small>[<a name="fn-11" href="#fnd-11">11</a>]</small> See <a href="emacs.html#Customization">Customization</a>.</p>
<p><hr></div>
</body></html>
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.