<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.11">
<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.5.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-11-04 11:51:51 -0500 (Tue, 04 Nov 2008) $
$Revision: 90 $
-->
<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_Installation" href="#Installation">2 Installation</a>
<li><a name="toc_Electricity" href="#Electricity">3 Electricity</a>
<li><a name="toc_Motion" href="#Motion">4 Motion</a>
<li><a name="toc_Indentation" href="#Indentation">5 Indentation</a>
<li><a name="toc_Editing" href="#Editing">6 Editing</a>
<li><a name="toc_Completion" href="#Completion">7 Completion</a>
<li><a name="toc_PHP-Comments" href="#PHP-Comments">8 PHP Comments</a>
<li><a name="toc_PHP-Documentation" href="#PHP-Documentation">9 PHP Documentation</a>
<li><a name="toc_Index-Menu" href="#Index-Menu">10 Index Menu</a>
<li><a name="toc_Change-Logs" href="#Change-Logs">11 Change Logs</a>
<li><a name="toc_Speedbar" href="#Speedbar">12 Speedbar</a>
<li><a name="toc_Customization" href="#Customization">13 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.5.0 for
use with GNU Emacs.
<p>Copyright © 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 “Copying This Manual.”
<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-11-04 11:51:51 -0500 (Tue, 04 Nov 2008) $
<p>$Revision: 90 $
<!-- See the indexes at the end of this document for notes on -->
<!-- maintaining the index. -->
<!-- Throughout the document there are comments about -->
<!-- maintaining the manual, the motivation for a section, -->
<!-- and todo items. Keep all these current alongside the -->
<!-- ``printed'' portions of the documentation. -->
<!-- The strategy is to document everything that is useful to -->
<!-- a PHP programmer using Emacs. The intended audience is -->
<!-- describe in the introduction. The scope is not. -->
<!-- Obviously, everything about PHP mode should be described -->
<!-- here, but even items that are not, should also be -->
<!-- explained or at least mentioned. -->
<!-- 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><a name="index-M_002dx-php_002dmode_002dversion-9"></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 “new XML mode for
Emacs” (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 – 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>This manual describes PHP mode for practiced Emacs users
especially those who have read or can refer to the Emacs
manual. The reader should already know how to program in
PHP, although one could easily learn how to program PHP
using PHP mode and Emacs. There are no explanations of PHP
programming in this manual.
<p><a name="Installation"></a>
<h2 class="chapter">2 Installation</h2>
<p><a name="index-installing-PHP-mode-10"></a><a name="index-PHP-mode_002c-installing-11"></a>PHP mode can be installed like any Emacs Lisp library.
<p><a name="index-downloading-PHP-mode-12"></a><a name="index-PHP-mode_002c-downloading-13"></a>Download a source archive of the file. It is available from
PHP mode's Web site.
<p><a name="index-PHP-mode-Web-site-14"></a><a name="index-Web-site_002c-PHP-mode-15"></a><a href="http://php-mode.sourceforge.net/">http://php-mode.sourceforge.net/</a>
<p><a name="index-GPG-signature-16"></a><a name="index-verifiy-PHP-mode-with-GPG-17"></a><a name="index-OpenPGP-18"></a><a name="index-GnuPG-19"></a>Download either the file
<samp><span class="file">php-mode-1.5.0.tar.gz</span></samp> or
<samp><span class="file">php-mode-1.5.0.zip</span></samp>. Both source files have
a respective GnuPG<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a> signature file with
a <var>.sig</var> file name extension.
<p>To verify the source archive you need the key of the
maintainer. The public key can be downloaded from the Web
site and imported, or imported from a key server.
<pre class="example"> $ gpg --recv-keys 8E372922
gpg: requesting key 8E372922 from hkp server keys.gnupg.net
gpg: key 8E372922: public key
"Aaron S. Hawley (SourceForge) <ashawley@users.sourceforge.net>"
imported
</pre>
<p>The public key can also be imported from a file.
<pre class="example"> $ gpg --import ashawley-sf-pubkey.asc
gpg: key 8E372922: public key
"Aaron S. Hawley (SourceForge) <ashawley@users.sourceforge.net>"
imported
gpg: Total number processed: 1
gpg: imported: 1
</pre>
<p>Assign the trust for the maintainer key.
<pre class="example"> $ gpg --edit-key 8E372922
Command> trust
pub 1024D/8E372922 created: 2008-01-25 expires: 2010-01-01 usage: SC
trust: unknown validity: unknown
sub 2048g/A4B44512 created: 2008-01-25 expires: 2010-01-01 usage: E
[ unknown] (1). Aaron S. Hawley (SourceForge)
<ashawley@users.sourceforge.net>
Please decide how far you trust this user to correctly
verify other users' keys (by looking at passports, checking
fingerprints from different sources, etc.)
1 = I don't know or won't say
2 = I do NOT trust
3 = I trust marginally
4 = I trust fully
5 = I trust ultimately
m = back to the main menu
Your decision? 1
pub 1024D/8E372922 created: 2008-01-25 expires: 2010-01-01 usage: SC
trust: undefined validity: unknown
sub 2048g/A4B44512 created: 2008-01-25 expires: 2010-01-01 usage: E
[ unknown] (1). Aaron S. Hawley (SourceForge)
<ashawley@users.sourceforge.net>
Command> quit
</pre>
<!-- The key has to be signed as well? - ASH 2008-10-22 -->
<p>Verify a source package by using the GPG verify command on
the signature file with the source file located in the same
directory.
<pre class="example"> $ gpg --verify php-mode-1.4.0.tar.gz.sig
gpg: Signature made Fri 25 Jan 2008 01:30:24 PM EST
gpg: using DSA key ID 8E372922
gpg: Good signature from
"Aaron S. Hawley (SourceForge) <ashawley@users.sourceforge.net>"
Primary key fingerprint: B425 30C2 4F72 D4F1 FD01
D07D 7087 6760 8E37 2922
</pre>
<p><a name="index-PHP-mode_002c-unpacking-20"></a><a name="index-unpacking-PHP-mode-21"></a><a name="index-extracting-PHP-mode-22"></a>After the source package is verified, unpack the source
archive.
<pre class="example"> $ tar zxf php php-mode-1.5.0.tar.gz
</pre>
<p><a name="index-PHP-mode-documentation-23"></a><a name="index-documentatino_002c-PHP-mode-24"></a>The files are extracted to the directory
<samp><span class="file">php-mode-1.5.0</span></samp>. Run <kbd>make</kbd> in the
directory to build all the formats of the documentation –
Info, HTML, PostScript and PDF. Read the notes in the
<samp><span class="file">Makefile</span></samp> to learn how to run <kbd>make</kbd> to compile
the manual into a single particular format.
<p><a name="index-g_t_002eemacs_002c-load_002dpath-25"></a><a name="index-load_002dpath-26"></a>If you have a local directory where Emacs Lisp libraries are
stored, for example <samp><span class="file">~/elisp</span></samp>, then put the following
in your <samp><span class="file">.emacs</span></samp> file if you haven't already
<pre class="lisp"> (add-to-list 'load-path "~/elisp")
</pre>
<p><a name="index-php_002dmode_002eel_002c-installing-27"></a><a name="index-installing-php_002dmode_002eel-28"></a><a name="index-php_002dmode_002eel_002c-loading-29"></a><a name="index-loading-php_002dmode_002eel-30"></a><a name="index-php_002dmode-31"></a><a name="index-load_002dpath-32"></a>Then, put the file <samp><span class="file">php-model.el</span></samp> into your Emacs
<code>load-path</code>, <samp><span class="file">~/elisp</span></samp>, and add <code>php-mode</code> to
your <samp><span class="file">.emacs</span></samp> file.
<pre class="lisp"> (load "php-mode")
</pre>
<p><a name="index-PHP-file-name-extension-33"></a><a name="index-extension_002c-PHP-file-name-34"></a><a name="index-file-name-extension_002c-PHP-35"></a><a name="index-customize_002dvariable-36"></a><a name="index-M_002dx-customize_002dvariable-37"></a>From inside Emacs, run <kbd>M-x customize-variable RET
php-file-patterns RET</kbd>. This variable instructs Emacs what
file names should be opened in PHP mode. If the defaults
are fine, then click or hit <kbd>RET</kbd> on ‘<samp><span class="samp">Save for
Future Sessions</span></samp>’.
<p><a name="index-g_t_002eemacs_002c-auto_002dmode_002dalist-38"></a>Alternatively, put these lines in your <samp><span class="file">.emacs</span></samp> file.
<pre class="lisp"> (add-to-list 'auto-mode-alist
'("\\.php[34]?\\'\\|\\.phtml\\'" . php-mode))
</pre>
<p><a name="index-Drupal-39"></a><a name="index-g_t_002eemacs_002c-Drupal-40"></a>If you work on projects, like Drupal, that use other
extension for PHP source file, you may need to add this to
your <samp><span class="file">.emacs</span></samp>.
<pre class="lisp"> (add-to-list 'auto-mode-alist '("\\.module\\'" . php-mode))
(add-to-list 'auto-mode-alist '("\\.inc\\'" . php-mode))
</pre>
<!-- Consider canvasing your operating system or software -->
<!-- distributor to include PHP mode as a package, or have it -->
<!-- installed with the existing Emacs package. -->
<!-- At some point, PHP mode should be included into Emacs. -->
<!-- In 2008, PHP mode is not very stable. Further, it is -->
<!-- unclear whether php-mode should be absorbed into CC mode -->
<!-- or not. Further, it is not clear how Emacs is planning -->
<!-- to support ``server page'' languages, where source code -->
<!-- is mixed with other languages and markup. -->
<!-- Explain how to install the info files in -->
<!-- Info-directory-list? -->
<p><a name="Electricity"></a>
<h2 class="chapter">3 Electricity</h2>
<!-- This article explains electricity, because the Emacs -->
<!-- manual, as of 2008, doesn't do a good job of introducing -->
<!-- the concept. -->
<!-- The section only gives examples of ``electric'' -->
<!-- commands. There should be a list of those commands. -->
<p><a name="index-electricity-41"></a><a name="index-self_002dinsert_002dcommand-42"></a>Certain characters when inserted in Emacs have
<dfn>electricity</dfn>. Emacs recognizes them as “electric”
and automatically reacts in some way to their insertion.
This is unlike the <code>self-insert-command</code> – the
conventional manner Emacs inserts most characters into the
buffer and without side-effect.
<p><a name="index-indentation_002c-electric-43"></a><a name="index-electric-indentation-44"></a><a name="index-declaration-blocks-45"></a><a name="index-conditional-statements-46"></a><a name="index-braces-47"></a><a name="index-comments-48"></a><a name="index-TAB-49"></a>For example, the indent commands for programming language
modes – including PHP mode – 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
related to comments (#, / and *), and
semicolons. Inserting “electric” characters causes the
line to be automatically be indented appropriately by PHP
mode.
<p><a name="index-quoted_002dinsert-50"></a><a name="index-C_002dq-51"></a><a name="index-c_002dtoggle_002delectric_002dstate-52"></a><a name="index-C_002dc-C_002dl-53"></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">4 Motion</h2>
<!-- It's important to explain when a feature is really a -->
<!-- subset of a feature of Emacs or C Mode, and take the -->
<!-- opportunity to create a cross-reference to those free -->
<!-- manuals. -->
<p><a name="index-motion-54"></a><a name="index-movement-55"></a><a name="index-C-mode_002c-movement-56"></a><a name="index-point-57"></a>
The traditional point movement commands for
Emacs<a rel="footnote" href="#fn-2" name="fnd-2"><sup>2</sup></a> and Emacs's C mode<a rel="footnote" href="#fn-3" name="fnd-3"><sup>3</sup></a> are supported in PHP mode. The following are
noteworthy commands for working on PHP code or are
extensions expressly provided by PHP mode.
<dl>
<!-- The forward-sexp command isn't optimally named nor -->
<!-- behaved for a language like PHP, but it comes for free -->
<!-- (gratis) from Emacs, and may prove useful. It would be -->
<!-- better to have a php-forward-syntax command that follows -->
<!-- the parsing rules of PHP and not a lisp language. For -->
<!-- instance, if at the beginning or end of a statement, move -->
<!-- to the next statement. The syntaxes that would be useful -->
<!-- to move across would need to be researched. -->
<a name="index-block-58"></a><a name="index-braces-59"></a><a name="index-parentheses-60"></a><a name="index-string-61"></a><a name="index-statements-62"></a><a name="index-syntax_002c-forward-63"></a><a name="index-forward_002dsexp-64"></a><a name="index-C_002dM_002df-65"></a><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-66"></a><a name="index-backward_002dsexp-67"></a><a name="index-C_002dM_002db-68"></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-69"></a><a name="index-function_002c-beginning-of-70"></a><a name="index-c_002dbeginning_002dof_002ddefun-71"></a><a name="index-C_002dM_002da-72"></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-73"></a><a name="index-function_002c-end-of-74"></a><a name="index-c_002dend_002dof_002ddefun-75"></a><a name="index-C_002dM_002de-76"></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-77"></a><a name="index-function_002c-end-of-78"></a><a name="index-beginning_002dof_002ddefun-79"></a><a name="index-C_002dM_002d_003cHOME_003e-80"></a><br><dt><kbd>C-M-<HOME></kbd><dd>Move point to the beginning of the current function
(<code>beginning-of-defun</code>).
<a name="index-end-of-function-81"></a><a name="index-function_002c-end-of-82"></a><a name="index-end_002dof_002ddefun-83"></a><a name="index-C_002dM_002d_003cEND_003e-84"></a><br><dt><kbd>C-M-<END></kbd><dd>Move point to the end of the current function
(<code>end-of-defun</code>).
<a name="index-indentation_002c-move-to-85"></a><a name="index-back_002dto_002dindentation-86"></a><a name="index-M_002dm-87"></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-88"></a><a name="index-camel-case-89"></a><a name="index-mixed-case-90"></a><a name="index-case_002c-mixed-91"></a><a name="index-function_002c-end-of-92"></a><a name="index-backward_002dword-93"></a><a name="index-forward_002dword-94"></a><a name="index-c_002dsubword_002dmode-95"></a><a name="index-C_002dc-C_002dw-96"></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-97"></a><a name="index-numeric-argument-98"></a><a name="index-universal_002dargument-99"></a><a name="index-C_002du-100"></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="http://emacswiki.org/cgi-bin/info-ref?find=Arguments">Numeric Arguments</a>.
<p><a name="Indentation"></a>
<h2 class="chapter">5 Indentation</h2>
<!-- It's important to explain when a feature is really a -->
<!-- subset of a feature of Emacs or C Mode, and take the -->
<!-- opportunity to create a cross-reference to those free -->
<!-- manuals. -->
<p><a name="index-indentation_002c-rules-for-101"></a><a name="index-C-mode_002c-indentation-rules-102"></a>PHP mode's indentation settings inherit the defaults set by
Emacs C mode, or the rules customized for C
mode.<a rel="footnote" href="#fn-4" name="fnd-4"><sup>4</sup></a>
<p><a name="index-PEAR_002c-indentation-103"></a><a name="index-spaces-104"></a><a name="index-tabs-105"></a>PHP mode provides indentation settings that follow the PHP
PEAR “Coding
Standards”<a rel="footnote" href="#fn-5" name="fnd-5"><sup>5</sup></a>.
It has the consequence in PHP mode of making the indentation
commands use four spaces, and not tabs. This setting is
turned on whenever the file name associated with a buffer
includes the string “PEAR”, case insensitive and the file
ends in “.php”.
<p><a name="index-indentation_002c-force-PEAR-rules-106"></a><a name="index-php_002dmode_002dforce_002dpear-107"></a><a name="index-customize_002dvariable-108"></a><a name="index-M_002dx-customize_002dvariable-109"></a><a name="index-g_t_002eemacs_002c-php_002dmode_002dforce_002dpear-110"></a>You can force the use of this setting for
all files edited with PHP mode by setting
<code>php-mode-force-pear</code> to non-nil. Configure the
variable with either <kbd>M-x customize-variable RET
php-mode-force-pear RET</kbd>, or by setting its value in your
Emacs initialization file (<samp><span class="file">~/.emacs</span></samp>).
<p><a name="index-HTML-111"></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.
<!-- There are probably other variables that are safe for -->
<!-- users to change and are worth mentioning. Ones from C -->
<!-- mode come to mind, like indentation-style. Some day it -->
<!-- would also be useful to support a variety of PHP -->
<!-- programming styles. -->
<!-- Perhaps the indentation commands should be featured -->
<!-- before customization. They could have separate sections. -->
<a name="index-indentation_002c-level-of-112"></a>
<a name="index-c_002dbasic_002doffset-113"></a>
<dl><dt><code>c-basic-offset</code><dd>This style variable of C mode controls how many columns in
the level of indentation. By default this is 4 spaces in
PHP mode (and in C mode).
<a name="index-indent_002dtabs_002dmode-114"></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-115"></a><br><dt><code>tab-width</code><dd>This variable of Emacs determines how “wide” a tab in the
buffer should be considered. This is also traditionally
described as setting the distance between “tab stops”. By
default, PHP mode does not insert tabs for indentation.
<br><dt><code>php-mode-force-pear</code><dd>Use the indentation rules of PHP PEAR for all files opened
in PHP mode. See above.
</dl>
<p><a name="index-indentation_002c-commands-for-116"></a><a name="index-C-mode_002c-indentation-rules-117"></a><a name="index-C-mode_002c-indentation-commands-118"></a>The usual commands for indenting in
Emacs<a rel="footnote" href="#fn-6" name="fnd-6"><sup>6</sup></a>
and Emacs's C mode<a rel="footnote" href="#fn-7" name="fnd-7"><sup>7</sup></a>: are supported in PHP mode, following the
indentation rules of PHP.
<a name="index-tab-119"></a>
<a name="index-indent-line-120"></a>
<a name="index-line_002c-indent-121"></a>
<a name="index-c_002dindent_002dcommand-122"></a>
<a name="index-TAB-123"></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-124"></a><a name="index-indent-newline-125"></a><a name="index-indent-newline-126"></a><a name="index-newline_002dand_002dindent-127"></a><a name="index-C_002dj-128"></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-129"></a><a name="index-region_002c-indent-130"></a><a name="index-indent_002dregion-131"></a><a name="index-C_002dM_002d_005c-132"></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-133"></a><a name="index-indent-function-134"></a><a name="index-class_002c-indent-135"></a><a name="index-indent-class-136"></a><a name="index-c_002dindent_002ddefun-137"></a><a name="index-C_002dc-C_002dq-138"></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">6 Editing</h2>
<!-- Provide an introduction to this section. -->
<a name="index-paragraph_002c-fill-139"></a>
<a name="index-filling-140"></a>
<a name="index-indentation_002c-filling-141"></a>
<a name="index-filling-indentation-142"></a>
<a name="index-filling-comment-143"></a>
<a name="index-comment_002c-filling-144"></a>
<a name="index-Docblock-comment-145"></a>
<a name="index-comment_002c-Docblock-146"></a>
<a name="index-c_002dfill_002dparagraph-147"></a>
<a name="index-M_002dq-148"></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-149"></a><a name="index-fill-column-150"></a><a name="index-fill_002dcolumn-151"></a><a name="index-set_002dfill_002dcolumn-152"></a><a name="index-fill_002dparagraph-153"></a><a name="index-C_002dx-f-154"></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-155"></a><a name="index-kill_002dregion-156"></a><a name="index-kill_002dring_002dsave-157"></a><a name="index-indent_002dregion-158"></a><a name="index-indent_002drigidly-159"></a><a name="index-c_002dmark_002dfunction-160"></a><a name="index-C_002dM_002dh-161"></a><a name="index-C_002dw-162"></a><a name="index-M_002dw-163"></a><a name="index-C_002dM_002d_005c-164"></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>.).
<a name="index-defun_002c-mark-165"></a><a name="index-mark_002ddefun-166"></a><a name="index-M_002dx-mark_002ddefun-167"></a><br><dt><kbd>M-x mark-defun</kbd><dd>Like <kbd>C-M-h</kbd> (<code>c-mark-function</code>), except place the
mark at the end of the function even if it's not at the
top-level. With functions that are methods defined in a
class, they may be indented and not top-level functions,
however this command will only mark the current function.
<!-- Perhaps, M-x mark-defun should be the default for running -->
<!-- C-M-h again. This is the downside of inheriting C mode's -->
<!-- key bindings. -->
</dl>
<!-- This narrowing stuff could deserve its own -->
<!-- chapter/section. -->
<p><a name="index-narrowing-168"></a><a name="index-widening-169"></a>The traditional commands for narrowing to a region in
Emacs<a rel="footnote" href="#fn-8" name="fnd-8"><sup>8</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-function-narrowing-170"></a>
<a name="index-function_002c-narrow-171"></a>
<a name="index-narrow_002dto_002ddefun-172"></a>
<a name="index-C_002dx-n-d-173"></a>
<dl><dt><kbd>C-x n d</kbd><dd>Narrow the buffer to the contents of the current function
(<code>narrow-to-defun</code>). This will narrow to the function
as identified to the current function, even if it is nested
in an object or another function. The logic to narrow the
function is the same as the <code>beginning-of-defun</code> and
<code>end-of-defun</code> commands – see <a href="#Motion">Motion</a>, and the
<code>mark-defun</code> command – see above.
<a name="index-widening-174"></a><a name="index-widen-175"></a><a name="index-C_002dx-n-w-176"></a><br><dt><kbd>C-x n w</kbd><dd>Undo any narrowing by widening the buffer again by making
the rest of the buffer available (<code>widen</code>).
</dl>
<p><a name="Completion"></a>
<h2 class="chapter">7 Completion</h2>
<p><a name="index-completion-177"></a>Completing function names, identifiers and PHP keywords is
possible in PHP mode. In PHP mode, it is possible to
complete identifiers defined by the PHP programming
language, and to complete functions defined by you.
<p><a name="index-customization_002c-PHP-manual-path-178"></a><a name="index-PHP-manual-path-179"></a><a name="index-php_002dmanual_002dpath-180"></a><a name="index-g_t_002eemacs_002c-php_002dmanual_002dpath-181"></a><a name="index-customize_002dvariable-182"></a><a name="index-M_002dx-customize_002dvariable-183"></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-9" name="fnd-9"><sup>9</sup></a>
Unpack the files to a directory, and define the variable
<code>php-manual-path</code> 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
its value in your Emacs initialization file
(<samp><span class="file">~/.emacs</span></samp>).
<!-- FIXME: Explain how the function name completion works, as -->
<!-- much as the user would need to know. -->
<!-- The following explains how to get completion to work in -->
<!-- detail, with any expectation that the reader knows how -->
<!-- completion works in Emacs. The more opportunities to -->
<!-- share features that come with Emacs as they apply to PHP -->
<!-- development, the better. -->
<p><a name="index-etags-184"></a><a name="index-tag-file-185"></a><a name="index-Makefile-186"></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-10" name="fnd-10"><sup>10</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-11" name="fnd-11"><sup>11</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-187"></a>Run,
<pre class="example"> etags <var>file</var>
</pre>
<p>to create a <samp><span class="file">TAGS</span></samp> file for <var>file</var>.
<p>To generate a <samp><span class="file">TAGS</span></samp> 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-188"></a>
<a name="index-visit_002dtags_002dtable-189"></a>
<a name="index-M_002dx-visit_002dtags_002dtable-190"></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-191"></a><a name="index-PHP-completion-file-192"></a><a name="index-php_002dcompletion_002dfile-193"></a><a name="index-g_t_002eemacs_002c-php_002dcompletion_002dfile-194"></a>If you are interested in any one or more of the following
consider using the variable <code>php-completion-file</code>.
<ol type=1 start=1>
<li>avoid regenerating the completion table from the PHP manual
every Emacs session,
<li>generating a completion file from a facility external to
Emacs tags,
<li>or provide more granular control over the completion
rules for files;
</ol>
<p><a name="index-customize_002dvariable-195"></a><a name="index-M_002dx-customize_002dvariable-196"></a>Configure this setting with either <kbd>M-x
customize-variable RET php-completion-file RET</kbd>, or by
setting its value in your Emacs initialization file
(<samp><span class="file">~/.emacs</span></samp>).
<p>To create a file that can be set for
<code>php-completion-file</code>, create with the following shell
commands with the HTML version of the PHP manual installed
at <samp><span class="file">/usr/share/doc/php-manual/en/html</span></samp>.
<pre class="example"> $ cd /usr/share/doc/php-manual/en/html
$ ls -1 function*.html \
| sed -e 's/^function\.\([-a-zA-Z_0-9]*\)\.html/\1/' \
| tr - _ \
> ~/.emacs.d/php/php-completion-file
</pre>
<!-- PHP mode could ship with a php-completion-file, but that -->
<!-- could require releasing a new version of PHP mode -->
<!-- whenever significant changes occur to the API of PHP. -->
<!-- Keep the following notes on third-party packages updated -->
<!-- with respect to managing Emacs settings on a per-project -->
<!-- basis. Otherwise, delete the paragraph(s). Perhaps the -->
<!-- Emacs project will choose or develop a solution, soon. -->
<p>In larger projects or with other specific needs,
conventional methods 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-197"></a>
<a name="index-function_002c-complete-198"></a>
<a name="index-php_002dcomplete_002dfunction-199"></a>
<a name="index-M_002dTAB-200"></a>
<a name="index-ESC-TAB-201"></a>
<a name="index-C_002d_005b-TAB-202"></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-203"></a><a name="index-function-argument-list-204"></a><a name="index-minibuffer-205"></a><a name="index-php_002dshow_002darglist-206"></a><a name="index-C_002d_002e-207"></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">8 PHP Comments</h2>
<p><a name="index-comment-208"></a>The usual commands for inserting, managing and editing
source code comments in Emacs<a rel="footnote" href="#fn-12" name="fnd-12"><sup>12</sup></a> and Emacs's C mode<a rel="footnote" href="#fn-13" name="fnd-13"><sup>13</sup></a> are supported in PHP mode. The following
noteworthy commands are useful for working with PHP or are
extensions expressly provided by PHP mode.
<!-- These commands aren't provided by PHP mode, but are -->
<!-- important to mention sine the PHP language has comments! -->
<!-- It should probably discuss the various types of comments. -->
<!-- A section should explain the phpdoc format as supported -->
<!-- in PHP mode. -->
<a name="index-comment_002c-insert-209"></a>
<a name="index-indent-comment-210"></a>
<a name="index-insert-comment-211"></a>
<a name="index-comment_002c-indent-212"></a>
<a name="index-comment_002dindent-213"></a>
<a name="index-comment_002ddwim-214"></a>
<a name="index-M_002d_003b-215"></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-216"></a><a name="index-newline_002c-comment-217"></a><a name="index-comment-newline-218"></a><a name="index-c_002dindent_002dnew_002dcomment_002dline-219"></a><a name="index-M_002dj-220"></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 column as the current line
(<code>c-indent-new-comment-line</code>).
<a name="index-column_002c-comment-221"></a><a name="index-comment-column-222"></a><a name="index-comment_002dcolumn-223"></a><a name="index-comment_002dset_002dcolumn-224"></a><a name="index-C_002dx-_003b-225"></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-226"></a><a name="index-region_002c-comment-227"></a><a name="index-comment_002dregion-228"></a><a name="index-C_002dc-C_002dc-229"></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-230"></a><a name="index-kill-comment-231"></a><a name="index-comment_002ddwim-232"></a><a name="index-comment_002dset_002dcolumn-233"></a><a name="index-comment_002dkill-234"></a><a name="index-M_002d_002d-C_002dx-_003b-235"></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-236"></a><a name="index-comment-box-237"></a><a name="index-comment_002dbox-238"></a><a name="index-M_002dx-comment_002dbox-239"></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">9 PHP Documentation</h2>
<p><a name="index-customization_002c-browse_002durl-240"></a><a name="index-documentation_002c-PHP-241"></a><a name="index-PHP-documentation-242"></a><a name="index-browse_002durl-243"></a><a name="index-customize_002dgroup-244"></a>PHP mode supports the online documentation available from
<a href="http://www.php.net/">http://www.php.net/</a>. The <code>browse-url</code> system of
Emacs supports these commands. Run the Emacs command
<kbd>M-x customize-group RET browse-url RET</kbd> to configure
how <code>browse-url</code> behaves. For example, you may want to
change the Web browser Emacs uses for visiting a page of the
manual for PHP.
<a name="index-browse-PHP-manual-245"></a>
<a name="index-php_002dbrowse_002dmanual-246"></a>
<a name="index-C_002dc-C_002dm-247"></a>
<a name="index-C_002dc-RET-248"></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-249"></a><a name="index-php_002dsearch_002ddocumentation-250"></a><a name="index-C_002dc-C_002df-251"></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">10 Index Menu</h2>
<!-- Imenu is documented, but it should be mentioned here -->
<!-- because PHP explicitly supports it by configuring -->
<!-- imenu-generic-expression with PHP-specific settings in -->
<!-- php-imenu-generic-expression. It should also documented -->
<!-- because PHP does not implicitly add the index menu to the -->
<!-- menubar, it needs to be done by the user. -->
<!-- PHP mode could automatically add the Imenu to the menubar -->
<!-- when it starts, however, it may be prohibitively slow for -->
<!-- large files. The first step towards this is suggesting -->
<!-- to users that they run imenu-add-menubar-index by adding -->
<!-- it to php-mode-hook. However, php-mode-hook isn't -->
<!-- documented, yet. -->
<p><a name="index-index-menu-252"></a><a name="index-menu_002c-index-253"></a><a name="index-index_002c-class-254"></a><a name="index-index_002c-function-255"></a><a name="index-class-index-256"></a><a name="index-function-index-257"></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.
<!-- Initially contributed by Gerrit Riessen -->
<p>To enable this menu, run the following command.
<a name="index-menu-bar-258"></a>
<a name="index-imenu_002dadd_002dmenubar_002dindex-259"></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 “Index” to the menu bar.
</dl>
<p>In the menu will be any one or more of the following menu
items.
<a name="index-imenu-260"></a>
<dl><dt>‘<samp><span class="samp">All 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-261"></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.
<br><dt>‘<samp><span class="samp">Public Methods, Private Methods, Protected Methods</span></samp>’<dd>Each of these three “method” sub-menus list the names of
objects methods defined as “public”, “private” or
“protected”. Clicking on a method name will visit the
location of the function's definition.
<a name="index-imenu_002dupdate_002dmenubar-262"></a><a name="index-rescan-263"></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-264"></a><a name="index-rescan_002c-automatically-265"></a><a name="index-g_t_002eemacs_002c-imenu_002dauto_002drescan-266"></a><a name="index-imenu_002dauto_002drescan-267"></a><a name="index-customize_002dvariable-268"></a><a name="index-M_002dx-customize_002dvariable-269"></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 its value in your
Emacs initialization file (<samp><span class="file">~/.emacs</span></samp>).
<p><a name="Change-Logs"></a>
<h2 class="chapter">11 Change Logs</h2>
<p><a name="index-php_002dbeginning_002dof_002ddefun_002dregexp-270"></a><a name="index-add_002dlog_002dcurrent_002ddefun_002dheader_002dregexp-271"></a><!-- This is documented, because PHP mode explicitly supports -->
<!-- the features of add-log by setting the value for the -->
<!-- add-log-current-defun-header-regexp to -->
<!-- php-beginning-of-defun-regexp. This feature is -->
<!-- documented in the PHP manual, but it is worth advertising -->
<!-- to PHP programmers. -->
<p><a name="index-ChangeLog-272"></a><a name="index-file_002c-ChangeLog-273"></a>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 <samp><span class="file">ChangeLog</span></samp> entry in the file.
<p><a name="index-Diff-mode-274"></a><a name="index-diff-file-275"></a><a name="index-file_002c-diff-276"></a><a name="index-patch-file-277"></a><a name="index-file_002c-patch-278"></a><a name="index-add_002dchange_002dlog_002dentry-279"></a>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="http://emacswiki.org/cgi-bin/info-ref?find=Diff Mode">Diff Mode</a>.
<a name="index-ChangeLog-entry-280"></a>
<a name="index-add-ChangeLog-entry-281"></a>
<a name="index-add_002dchange_002dlog_002dentry_002dother_002dwindow-282"></a>
<a name="index-C_002dx-4-a-283"></a>
<dl><dt><kbd>C-x 4 a</kbd><dd>Add an entry in a <samp><span class="file">ChangeLog</span></samp> 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. The point can be in a PHP source
file, or in the hunk of a diff file.<a rel="footnote" href="#fn-14" name="fnd-14"><sup>14</sup></a> This
command will also add the current author and date to the
entry.
</dl>
<p><a name="Speedbar"></a>
<h2 class="chapter">12 Speedbar</h2>
<p>FIXME: Document speedbar support for PHP mode.
<p><a name="Customization"></a>
<h2 class="chapter">13 Customization</h2>
<p><a name="index-customization-284"></a><a name="index-g_t_002eemacs-285"></a><a name="index-initialization-file-286"></a>Customization for PHP mode can be done using Emacs's
“Customize” feature<a rel="footnote" href="#fn-15" name="fnd-15"><sup>15</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-287"></a>
<a name="index-M_002dx-customize_002dgroup-288"></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>
<!-- There are other sections that talk about customization, -->
<!-- but they aren't mentioned here and they don't -->
<!-- cross-reference back to this section. -->
<!-- Things that aren't documented elsewhere but deserve -->
<!-- documentation, in order of importance: -->
<!-- * php-mode-hook -->
<!-- * php-search-url -->
<!-- * php-file-patterns -->
<!-- * php-mode-pear-hook -->
<p><a name="Embedded-HTML"></a>
<h2 class="appendix">Appendix A Embedded HTML</h2>
<!-- Someday, there will be a decisive way to work on PHP and -->
<!-- HTML markup together. For now, it's not decided. This -->
<!-- section offers some workarounds and offers some -->
<!-- suggestions. -->
<p><a name="index-markup-formats-289"></a><a name="index-XML-290"></a><a name="index-SGML-291"></a><a name="index-embedded-code-292"></a><a name="index-indentation_002c-markup-293"></a><a name="index-HTML-294"></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 Emacs
modes for properly indenting HTML include HTML mode, SGML
mode and XML mode.
<p><a name="index-php_002dmode-295"></a><a name="index-M_002dx-php_002dmode-296"></a><a name="index-html_002dmode-297"></a><a name="index-M_002dx-html_002dmode-298"></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-299"></a><a name="index-mumamo-300"></a><a name="index-mmm_002dmode-301"></a><a name="index-multi_002dmode-302"></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
<li>Aaron Iba
<li>Dias Badekas
</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 © 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 “copyleft”, 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 “Document”, below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as “you”. You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
<p>A “Modified Version” 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 “Secondary Section” 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 “Invariant Sections” 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 “Cover Texts” 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 “Transparent” 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 “Transparent” is called “Opaque”.
<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 “Title Page” 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, “Title Page” 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 “Entitled XYZ” 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 “Acknowledgements”,
“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title”
of such a section when you modify the Document means that it remains a
section “Entitled XYZ” 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 “History”, 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 “History” 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 “History” 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 “Acknowledgements” or “Dedications”, 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 “Endorsements”. Such a section
may not be included in the Modified Version.
<li>Do not retitle any existing section to be Entitled “Endorsements” 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 “Endorsements”, provided it contains
nothing but endorsements of your Modified Version by various
parties—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 “History”
in the various original documents, forming one section Entitled
“History”; likewise combine any sections Entitled “Acknowledgements”,
and any sections Entitled “Dedications”. You must delete all
sections Entitled “Endorsements.”
<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 “aggregate” 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 “Acknowledgements”,
“Dedications”, or “History”, 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 “or any later version” 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 “with<small class="dots">...</small>Texts.” 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: -->
<!-- Indices -->
<!-- Indexes are well-supported and easy to add in Texinfo, so -->
<!-- I have created them liberally in this document. Every -->
<!-- command, variable and function that is mentioned is -->
<!-- indexed regardless if it is defined by PHP-mode or -->
<!-- not. - ASH 2008-10-22 -->
<!-- Quickly, variable mentions are given a @vindex, functions -->
<!-- a @findex, keyboard commands a @kindex and everything -->
<!-- else a @cindex. And if a concept is a multiple word -->
<!-- phrase, be sure to use the various permutations to -->
<!-- provide different alphabetical ordered entries for -->
<!-- readers. Take a look at the conventions already used -->
<!-- throughout the document for examples to follow from. -->
<!-- If the indexing philosophy is less than adequate it will -->
<!-- take less effort to retract entries, then it would be if -->
<!-- an entire index had to be created from scratch. So with -->
<!-- each edit, spend a little time keeping it up to date. -->
<p><a name="Concept-Index"></a>
<h2 class="unnumbered">Concept Index</h2>
<ul class="index-cp" compact>
<li><a href="#index-g_t_002eemacs-285">.emacs</a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-g_t_002eemacs_002c-auto_002dmode_002dalist-38">.emacs, auto-mode-alist</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-g_t_002eemacs_002c-Drupal-40">.emacs, Drupal</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-g_t_002eemacs_002c-imenu_002dauto_002drescan-266">.emacs, imenu-auto-rescan</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-g_t_002eemacs_002c-load_002dpath-25">.emacs, load-path</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-g_t_002eemacs_002c-php_002dcompletion_002dfile-194">.emacs, php-completion-file</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-g_t_002eemacs_002c-php_002dmanual_002dpath-181">.emacs, php-manual-path</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-g_t_002eemacs_002c-php_002dmode_002dforce_002dpear-110">.emacs, php-mode-force-pear</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-add-ChangeLog-entry-281">add ChangeLog entry</a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-argument-list_002c-function-203">argument list, function</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-beginning-of-function-69">beginning of function</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-block-58">block</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-braces-59">braces</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-braces-47">braces</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-browse-PHP-manual-245">browse PHP manual</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-bumpy-case-88">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-C-mode_002c-indentation-commands-118">C mode, indentation commands</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-C-mode_002c-indentation-rules-102">C mode, indentation rules</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-C-mode_002c-movement-56">C mode, movement</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-camel-case-89">camel case</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-case_002c-mixed-91">case, mixed</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-ChangeLog-272">ChangeLog</a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-ChangeLog-entry-280">ChangeLog entry</a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-class-index-256">class index</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-class_002c-indent-135">class, indent</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-column_002c-comment-221">column, comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-column_002c-fill-149">column, fill</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-comment-208">comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment-box-237">comment box</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment-column-222">comment column</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment-newline-218">comment newline</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment-region-226">comment region</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002c-Docblock-146">comment, Docblock</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-comment_002c-filling-144">comment, filling</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-comment_002c-indent-212">comment, indent</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002c-insert-209">comment, insert</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002c-kill-230">comment, kill</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comments-48">comments</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-complete-function-197">complete function</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-completion-177">completion</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-conditional-statements-46">conditional statements</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-customization-284">customization</a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-customization_002c-browse_002durl-240">customization, browse-url</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-customization_002c-Imenu-auto-rescan-264">customization, Imenu auto rescan</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-customization_002c-PHP-completion-file-191">customization, PHP completion file</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-customization_002c-PHP-manual-path-178">customization, PHP manual path</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-declaration-blocks-45">declaration blocks</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-defun_002c-mark-165">defun, mark</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-diff-file-275">diff file</a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-Diff-mode-274">Diff mode</a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-Docblock-comment-145">Docblock comment</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-documentatino_002c-PHP-mode-24">documentatino, PHP mode</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-documentation_002c-PHP-241">documentation, PHP</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-downloading-PHP-mode-12">downloading PHP mode</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-Drupal-39">Drupal</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-electric-indentation-44">electric indentation</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-electricity-41">electricity</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-embedded-code-292">embedded code</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-end-of-function-73">end of function</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-etags-184">etags</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-etags_002c-running-187">etags, running</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-extension_002c-PHP-file-name-34">extension, PHP file name</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-extracting-PHP-mode-22">extracting PHP mode</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-features-2">features</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-file-name-extension_002c-PHP-35">file name extension, PHP</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-file_002c-ChangeLog-273">file, ChangeLog</a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-file_002c-diff-276">file, diff</a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-file_002c-patch-278">file, patch</a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-fill-column-150">fill column</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-filling-140">filling</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-filling-comment-143">filling comment</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-filling-indentation-142">filling indentation</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-function-argument-list-204">function argument list</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-function-index-257">function index</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-function-narrowing-170">function narrowing</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-function_002c-beginning-of-70">function, beginning of</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-function_002c-complete-198">function, complete</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-function_002c-end-of-74">function, end of</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-function_002c-indent-133">function, indent</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-function_002c-mark-155">function, mark</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-function_002c-narrow-171">function, narrow</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-GnuPG-19">GnuPG</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-GPG-signature-16">GPG signature</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-HTML-294">HTML</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-HTML-111">HTML</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-class-136">indent class</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-comment-210">indent comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-indent-function-134">indent function</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-line-120">indent line</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-newline-125">indent newline</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent-region-129">indent region</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indentation_002c-commands-for-116">indentation, commands for</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indentation_002c-electric-43">indentation, electric</a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-indentation_002c-filling-141">indentation, filling</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-indentation_002c-force-PEAR-rules-106">indentation, force PEAR rules</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indentation_002c-level-of-112">indentation, level of</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indentation_002c-markup-293">indentation, markup</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-indentation_002c-move-to-85">indentation, move to</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-indentation_002c-rules-for-101">indentation, rules for</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-index-menu-252">index menu</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-index_002c-class-254">index, class</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-index_002c-function-255">index, function</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-initialization-file-286">initialization file</a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-insert-comment-211">insert comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-installing-PHP-mode-10">installing PHP mode</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-installing-php_002dmode_002eel-28">installing php-mode.el</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-kill-comment-231">kill comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-line_002c-indent-121">line, indent</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-loading-php_002dmode_002eel-30">loading php-mode.el</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-Makefile-186">Makefile</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-markup-formats-289">markup formats</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-menu-bar-258">menu bar</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-menu_002c-index-253">menu, index</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-minibuffer-205">minibuffer</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-mixed-case-90">mixed case</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-mmm_002dmode-301">mmm-mode</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-motion-54">motion</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-movement-55">movement</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-multi_002dmode-302">multi-mode</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-multiple-major-mode-299">multiple major mode</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-mumamo-300">mumamo</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-narrowing-168">narrowing</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-newline-124">newline</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-newline_002c-comment-217">newline, comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-numeric-argument-98">numeric argument</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-OpenPGP-18">OpenPGP</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-paragraph_002c-fill-139">paragraph, fill</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-parentheses-60">parentheses</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-patch-file-277">patch file</a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-PEAR-3">PEAR</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-PEAR_002c-indentation-103">PEAR, indentation</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-PHP-completion-file-192">PHP completion file</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-PHP-documentation-242">PHP documentation</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-PHP-file-name-extension-33">PHP file name extension</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-PHP-manual-path-179">PHP manual path</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-PHP-mode-documentation-23">PHP mode documentation</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-PHP-mode-Web-site-14">PHP mode Web site</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-PHP-mode_002c-downloading-13">PHP mode, downloading</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-PHP-mode_002c-installing-11">PHP mode, installing</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-PHP-mode_002c-unpacking-20">PHP mode, unpacking</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-PHP-versions-4">PHP versions</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-php_002dmode_002eel_002c-installing-27">php-mode.el, installing</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-php_002dmode_002eel_002c-loading-29">php-mode.el, loading</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-point-57">point</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-region_002c-comment-227">region, comment</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-region_002c-comment-box-236">region, comment box</a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-region_002c-indent-130">region, indent</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-rescan-263">rescan</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-rescan_002c-automatically-265">rescan, automatically</a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-search-PHP-manual-249">search PHP manual</a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-SGML-291">SGML</a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-spaces-104">spaces</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-statements-62">statements</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-string-61">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-66">syntax, backward</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-syntax_002c-forward-63">syntax, forward</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-tab-119">tab</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-tabs-105">tabs</a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-tag-188">tag</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-tag-file-185">tag file</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-universal-argument-97">universal argument</a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-unpacking-PHP-mode-21">unpacking PHP mode</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-verifiy-PHP-mode-with-GPG-17">verifiy PHP mode with GPG</a>: <a href="#Installation">Installation</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-Web-site_002c-PHP-mode-15">Web site, PHP mode</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-widening-169">widening</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-XML-290">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-add_002dchange_002dlog_002dentry-279"><code>add-change-log-entry</code></a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-add_002dchange_002dlog_002dentry_002dother_002dwindow-282"><code>add-change-log-entry-other-window</code></a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-back_002dto_002dindentation-86"><code>back-to-indentation</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-backward_002dsexp-67"><code>backward-sexp</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-backward_002dword-93"><code>backward-word</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-beginning_002dof_002ddefun-79"><code>beginning-of-defun</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-browse_002durl-243"><code>browse-url</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-c_002dbeginning_002dof_002ddefun-71"><code>c-beginning-of-defun</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-c_002dend_002dof_002ddefun-75"><code>c-end-of-defun</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-c_002dfill_002dparagraph-147"><code>c-fill-paragraph</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-c_002dindent_002dcommand-122"><code>c-indent-command</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-c_002dindent_002ddefun-137"><code>c-indent-defun</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-c_002dindent_002dnew_002dcomment_002dline-219"><code>c-indent-new-comment-line</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-c_002dmark_002dfunction-160"><code>c-mark-function</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-c_002dsubword_002dmode-95"><code>c-subword-mode</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-c_002dtoggle_002delectric_002dstate-52"><code>c-toggle-electric-state</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-comment_002dbox-238"><code>comment-box</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002ddwim-214"><code>comment-dwim</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002dindent-213"><code>comment-indent</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002dkill-234"><code>comment-kill</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002dregion-228"><code>comment-region</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-comment_002dset_002dcolumn-224"><code>comment-set-column</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-customize_002dgroup-287"><code>customize-group</code></a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-customize_002dgroup-244"><code>customize-group</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-customize_002dvariable-268"><code>customize-variable</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-customize_002dvariable-182"><code>customize-variable</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-customize_002dvariable-108"><code>customize-variable</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-customize_002dvariable-36"><code>customize-variable</code></a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-end_002dof_002ddefun-83"><code>end-of-defun</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-fill_002dparagraph-153"><code>fill-paragraph</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-forward_002dsexp-64"><code>forward-sexp</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-forward_002dword-94"><code>forward-word</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-html_002dmode-297"><code>html-mode</code></a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-imenu-260"><code>imenu</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-imenu_002dadd_002dmenubar_002dindex-259"><code>imenu-add-menubar-index</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-imenu_002dupdate_002dmenubar-262"><code>imenu-update-menubar</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-indent_002dregion-158"><code>indent-region</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-indent_002dregion-131"><code>indent-region</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-indent_002drigidly-159"><code>indent-rigidly</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-kill_002dregion-156"><code>kill-region</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-kill_002dring_002dsave-157"><code>kill-ring-save</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-mark_002ddefun-166"><code>mark-defun</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-narrow_002dto_002ddefun-172"><code>narrow-to-defun</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-newline_002dand_002dindent-127"><code>newline-and-indent</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-php_002dbrowse_002dmanual-246"><code>php-browse-manual</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-php_002dcomplete_002dfunction-199"><code>php-complete-function</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-php_002dmode-295"><code>php-mode</code></a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-php_002dmode-31"><code>php-mode</code></a>: <a href="#Installation">Installation</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-250"><code>php-search-documentation</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-php_002dshow_002darglist-206"><code>php-show-arglist</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-quoted_002dinsert-50"><code>quoted-insert</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-self_002dinsert_002dcommand-42"><code>self-insert-command</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-set_002dfill_002dcolumn-152"><code>set-fill-column</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-universal_002dargument-99"><code>universal-argument</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-visit_002dtags_002dtable-189"><code>visit-tags-table</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-widen-175"><code>widen</code></a>: <a href="#Editing">Editing</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-207"><code>C-.</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-C_002d_005b-TAB-202"><code>C-[ TAB</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-C_002dc-C_002dc-229"><code>C-c C-c</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-C_002dc-C_002df-251"><code>C-c C-f</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-C_002dc-C_002dl-53"><code>C-c C-l</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-C_002dc-C_002dm-247"><code>C-c C-m</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-C_002dc-C_002dq-138"><code>C-c C-q</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-C_002dc-C_002dw-96"><code>C-c C-w</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dc-RET-248"><code>C-c RET</code></a>: <a href="#PHP-Documentation">PHP Documentation</a></li>
<li><a href="#index-C_002dj-128"><code>C-j</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-C_002dM_002d_003cEND_003e-84"><code>C-M-<END></code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002d_003cHOME_003e-80"><code>C-M-<HOME></code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002d_005c-164"><code>C-M-\</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-C_002dM_002d_005c-132"><code>C-M-\</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-C_002dM_002da-72"><code>C-M-a</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002db-68"><code>C-M-b</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002de-76"><code>C-M-e</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002df-65"><code>C-M-f</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dM_002dh-161"><code>C-M-h</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-C_002dq-51"><code>C-q</code></a>: <a href="#Electricity">Electricity</a></li>
<li><a href="#index-C_002du-100"><code>C-u</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-C_002dw-162"><code>C-w</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-C_002dx-4-a-283"><code>C-x 4 a</code></a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-C_002dx-_003b-225"><code>C-x ;</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-C_002dx-f-154"><code>C-x f</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-C_002dx-n-d-173"><code>C-x n d</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-C_002dx-n-w-176"><code>C-x n w</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-ESC-TAB-201"><code>ESC TAB</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-M_002d_002d-C_002dx-_003b-235"><code>M-- C-x ;</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002d_003b-215"><code>M-;</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002dj-220"><code>M-j</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002dm-87"><code>M-m</code></a>: <a href="#Motion">Motion</a></li>
<li><a href="#index-M_002dq-148"><code>M-q</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-M_002dTAB-200"><code>M-TAB</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-M_002dw-163"><code>M-w</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-M_002dx-comment_002dbox-239"><code>M-x comment-box</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002dx-comment_002dindent-216"><code>M-x comment-indent</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-M_002dx-customize_002dgroup-288"><code>M-x customize-group</code></a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-M_002dx-customize_002dvariable-269"><code>M-x customize-variable</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-M_002dx-customize_002dvariable-183"><code>M-x customize-variable</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-M_002dx-customize_002dvariable-109"><code>M-x customize-variable</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-M_002dx-customize_002dvariable-37"><code>M-x customize-variable</code></a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-M_002dx-html_002dmode-298"><code>M-x html-mode</code></a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-M_002dx-mark_002ddefun-167"><code>M-x mark-defun</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-M_002dx-php_002dmode-296"><code>M-x php-mode</code></a>: <a href="#Embedded-HTML">Embedded HTML</a></li>
<li><a href="#index-M_002dx-php_002dmode_002dversion-9"><code>M-x php-mode-version</code></a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-M_002dx-visit_002dtags_002dtable-190"><code>M-x visit-tags-table</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-TAB-123"><code>TAB</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-TAB-49"><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-add_002dlog_002dcurrent_002ddefun_002dheader_002dregexp-271"><code>add-log-current-defun-header-regexp</code></a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-c_002dbasic_002doffset-113"><code>c-basic-offset</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-comment_002dcolumn-223"><code>comment-column</code></a>: <a href="#PHP-Comments">PHP Comments</a></li>
<li><a href="#index-fill_002dcolumn-151"><code>fill-column</code></a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-imenu_002dauto_002drescan-267"><code>imenu-auto-rescan</code></a>: <a href="#Index-Menu">Index Menu</a></li>
<li><a href="#index-indent_002dtabs_002dmode-114"><code>indent-tabs-mode</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-load_002dpath-26"><code>load-path</code></a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-php_002dbeginning_002dof_002ddefun_002dregexp-270"><code>php-beginning-of-defun-regexp</code></a>: <a href="#Change-Logs">Change Logs</a></li>
<li><a href="#index-php_002dcompletion_002dfile-193"><code>php-completion-file</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-php_002dmanual_002dpath-180"><code>php-manual-path</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-php_002dmode_002dforce_002dpear-107"><code>php-mode-force-pear</code></a>: <a href="#Indentation">Indentation</a></li>
<li><a href="#index-tab_002dwidth-115"><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> More information on GPG and
OpenPGP at <a href="http://www.gnupg.org/">http://www.gnupg.org/</a></p>
<p class="footnote"><small>[<a name="fn-2" href="#fnd-2">2</a>]</small> See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Moving Point">Changing the Location of Point</a>.</p>
<p class="footnote"><small>[<a name="fn-3" href="#fnd-3">3</a>]</small> See <a href="http://cc-mode.sourceforge.net/html-manual/#Movement-Commands">Movement Commands</a>.</p>
<p class="footnote"><small>[<a name="fn-4" href="#fnd-4">4</a>]</small> See <a href="http://cc-mode.sourceforge.net/html-manual/#Customizing-Indentation">Customizing Indentation</a>.</p>
<p class="footnote"><small>[<a name="fn-5" href="#fnd-5">5</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-6" href="#fnd-6">6</a>]</small> See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Indentation Commands">Indentation Commands</a>.</p>
<p class="footnote"><small>[<a name="fn-7" href="#fnd-7">7</a>]</small> See <a href="http://cc-mode.sourceforge.net/html-manual/#Indentation-Commands">Indentation Commands</a>.</p>
<p class="footnote"><small>[<a name="fn-8" href="#fnd-8">8</a>]</small> See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Narrowing">Narrowing</a>.</p>
<p class="footnote"><small>[<a name="fn-9" href="#fnd-9">9</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-10" href="#fnd-10">10</a>]</small> See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Tags">Tags Tables</a>.</p>
<p class="footnote"><small>[<a name="fn-11" href="#fnd-11">11</a>]</small> See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Create Tags Table">Creating Tags Tables</a>.</p>
<p class="footnote"><small>[<a name="fn-12" href="#fnd-12">12</a>]</small> See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Comments">Manipulating Comments</a>.</p>
<p class="footnote"><small>[<a name="fn-13" href="#fnd-13">13</a>]</small> See <a href="http://cc-mode.sourceforge.net/html-manual/#Comment-Commands">Comment Commands</a>.</p>
<p class="footnote"><small>[<a name="fn-14" href="#fnd-14">14</a>]</small> See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Diff Mode">Diff Mode</a>.</p>
<p class="footnote"><small>[<a name="fn-15" href="#fnd-15">15</a>]</small> See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Customization">Customization</a>.</p>
<hr></div>
</body></html>
