annotate man/major.texi @ 62359:f7fdfa8ffb34

*** empty log message ***
author Jay Belanger <jay.p.belanger@gmail.com>
date Sun, 15 May 2005 05:36:55 +0000
parents 9cc4be7413fb
children 1cac74a672b0 146c086df160
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 @c This is part of the Emacs manual.
28550
ea0fd9729fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3 @c See file emacs.texi for copying conditions.
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @node Major Modes, Indentation, International, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @chapter Major Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @cindex major modes
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @cindex mode, major
Dave Love <fx@gnu.org>
parents:
diff changeset
8 @kindex TAB @r{(and major modes)}
Dave Love <fx@gnu.org>
parents:
diff changeset
9 @kindex DEL @r{(and major modes)}
Dave Love <fx@gnu.org>
parents:
diff changeset
10 @kindex C-j @r{(and major modes)}
Dave Love <fx@gnu.org>
parents:
diff changeset
11
Dave Love <fx@gnu.org>
parents:
diff changeset
12 Emacs provides many alternative @dfn{major modes}, each of which
Dave Love <fx@gnu.org>
parents:
diff changeset
13 customizes Emacs for editing text of a particular sort. The major modes
Dave Love <fx@gnu.org>
parents:
diff changeset
14 are mutually exclusive, and each buffer has one major mode at any time.
Dave Love <fx@gnu.org>
parents:
diff changeset
15 The mode line normally shows the name of the current major mode, in
Dave Love <fx@gnu.org>
parents:
diff changeset
16 parentheses (@pxref{Mode Line}).
Dave Love <fx@gnu.org>
parents:
diff changeset
17
Dave Love <fx@gnu.org>
parents:
diff changeset
18 The least specialized major mode is called @dfn{Fundamental mode}.
Dave Love <fx@gnu.org>
parents:
diff changeset
19 This mode has no mode-specific redefinitions or variable settings, so
Dave Love <fx@gnu.org>
parents:
diff changeset
20 that each Emacs command behaves in its most general manner, and each
59798
0816b427495a Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
21 user option variable is in its default state. For editing text of a
0816b427495a Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
22 specific type that Emacs knows about, such as Lisp code or English
0816b427495a Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
23 text, you should switch to the appropriate major mode, such as Lisp
0816b427495a Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
24 mode or Text mode.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
25
Dave Love <fx@gnu.org>
parents:
diff changeset
26 Selecting a major mode changes the meanings of a few keys to become
Dave Love <fx@gnu.org>
parents:
diff changeset
27 more specifically adapted to the language being edited. The ones that
Dave Love <fx@gnu.org>
parents:
diff changeset
28 are changed frequently are @key{TAB}, @key{DEL}, and @kbd{C-j}. The
Dave Love <fx@gnu.org>
parents:
diff changeset
29 prefix key @kbd{C-c} normally contains mode-specific commands. In
Dave Love <fx@gnu.org>
parents:
diff changeset
30 addition, the commands which handle comments use the mode to determine
Dave Love <fx@gnu.org>
parents:
diff changeset
31 how comments are to be delimited. Many major modes redefine the
Dave Love <fx@gnu.org>
parents:
diff changeset
32 syntactical properties of characters appearing in the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
33 @xref{Syntax}.
Dave Love <fx@gnu.org>
parents:
diff changeset
34
38461
23f63206a867 Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents: 37986
diff changeset
35 The major modes fall into three major groups. The first group
38745
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
36 contains modes for normal text, either plain or with mark-up. It
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
37 includes Text mode, HTML mode, SGML mode, @TeX{} mode and Outline
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
38 mode. The second group contains modes for specific programming
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
39 languages. These include Lisp mode (which has several variants), C
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
40 mode, Fortran mode, and others. The remaining major modes are not
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
41 intended for use on users' files; they are used in buffers created for
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
42 specific purposes by Emacs, such as Dired mode for buffers made by
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
43 Dired (@pxref{Dired}), Mail mode for buffers made by @kbd{C-x m}
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
44 (@pxref{Sending Mail}), and Shell mode for buffers used for
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
45 communicating with an inferior shell process (@pxref{Interactive
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38461
diff changeset
46 Shell}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
47
Dave Love <fx@gnu.org>
parents:
diff changeset
48 Most programming-language major modes specify that only blank lines
Dave Love <fx@gnu.org>
parents:
diff changeset
49 separate paragraphs. This is to make the paragraph commands useful.
Dave Love <fx@gnu.org>
parents:
diff changeset
50 (@xref{Paragraphs}.) They also cause Auto Fill mode to use the
Dave Love <fx@gnu.org>
parents:
diff changeset
51 definition of @key{TAB} to indent the new lines it creates. This is
28550
ea0fd9729fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
52 because most lines in a program are usually indented
ea0fd9729fa7 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
53 (@pxref{Indentation}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
54
Dave Love <fx@gnu.org>
parents:
diff changeset
55 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
56 * Choosing Modes:: How major modes are specified or chosen.
Dave Love <fx@gnu.org>
parents:
diff changeset
57 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
58
Dave Love <fx@gnu.org>
parents:
diff changeset
59 @node Choosing Modes,,Major Modes,Major Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
60 @section How Major Modes are Chosen
Dave Love <fx@gnu.org>
parents:
diff changeset
61
Dave Love <fx@gnu.org>
parents:
diff changeset
62 @cindex choosing a major mode
Dave Love <fx@gnu.org>
parents:
diff changeset
63 You can select a major mode explicitly for the current buffer, but
Dave Love <fx@gnu.org>
parents:
diff changeset
64 most of the time Emacs determines which mode to use based on the file
Dave Love <fx@gnu.org>
parents:
diff changeset
65 name or on special text in the file.
Dave Love <fx@gnu.org>
parents:
diff changeset
66
Dave Love <fx@gnu.org>
parents:
diff changeset
67 Explicit selection of a new major mode is done with a @kbd{M-x} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
68 From the name of a major mode, add @code{-mode} to get the name of a
Dave Love <fx@gnu.org>
parents:
diff changeset
69 command to select that mode. Thus, you can enter Lisp mode by executing
Dave Love <fx@gnu.org>
parents:
diff changeset
70 @kbd{M-x lisp-mode}.
Dave Love <fx@gnu.org>
parents:
diff changeset
71
Dave Love <fx@gnu.org>
parents:
diff changeset
72 @vindex auto-mode-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
73 When you visit a file, Emacs usually chooses the right major mode based
Dave Love <fx@gnu.org>
parents:
diff changeset
74 on the file's name. For example, files whose names end in @samp{.c} are
Dave Love <fx@gnu.org>
parents:
diff changeset
75 edited in C mode. The correspondence between file names and major modes is
Dave Love <fx@gnu.org>
parents:
diff changeset
76 controlled by the variable @code{auto-mode-alist}. Its value is a list in
Dave Love <fx@gnu.org>
parents:
diff changeset
77 which each element has this form,
Dave Love <fx@gnu.org>
parents:
diff changeset
78
Dave Love <fx@gnu.org>
parents:
diff changeset
79 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
80 (@var{regexp} . @var{mode-function})
Dave Love <fx@gnu.org>
parents:
diff changeset
81 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
82
Dave Love <fx@gnu.org>
parents:
diff changeset
83 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
84 or this form,
Dave Love <fx@gnu.org>
parents:
diff changeset
85
Dave Love <fx@gnu.org>
parents:
diff changeset
86 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
87 (@var{regexp} @var{mode-function} @var{flag})
Dave Love <fx@gnu.org>
parents:
diff changeset
88 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
89
Dave Love <fx@gnu.org>
parents:
diff changeset
90 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
91 For example, one element normally found in the list has the form
Dave Love <fx@gnu.org>
parents:
diff changeset
92 @code{(@t{"\\.c\\'"} . c-mode)}, and it is responsible for selecting C
Dave Love <fx@gnu.org>
parents:
diff changeset
93 mode for files whose names end in @file{.c}. (Note that @samp{\\} is
38461
23f63206a867 Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents: 37986
diff changeset
94 needed in Lisp syntax to include a @samp{\} in the string, which must
60109
b38fabf04e70 (Choosing Modes): Clarify.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
95 be used to suppress the special meaning of @samp{.} in regexps.) If
b38fabf04e70 (Choosing Modes): Clarify.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
96 the element has the form @code{(@var{regexp} @var{mode-function}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
97 @var{flag})} and @var{flag} is non-@code{nil}, then after calling
60109
b38fabf04e70 (Choosing Modes): Clarify.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
98 @var{mode-function}, Emacs discards the suffix that matched
b38fabf04e70 (Choosing Modes): Clarify.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
99 @var{regexp} and searches the list again for another match.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
100
61465
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
101 @vindex magic-mode-alist
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
102 Sometimes the major mode is determined from the way the file's text
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
103 begins. The variable @code{magic-mode-alist} controls this. Its value
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
104 is a list of elements of this form:
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
105
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
106 @example
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
107 (@var{regexp} . @var{mode-function})
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
108 @end example
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
109
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
110 @noindent
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
111 This looks like an element of @code{auto-mode-alist}, but it doesn't work
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
112 the same: this @var{regexp} is matched against the text at the start
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
113 of the buffer, not against the file name. @code{magic-mode-alist}
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
114 takes priority over @code{auto-mode-alist}.
9cc4be7413fb (Choosing Modes): Document magic-mode-alist.
Richard M. Stallman <rms@gnu.org>
parents: 60109
diff changeset
115
60109
b38fabf04e70 (Choosing Modes): Clarify.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
116 You can specify the major mode to use for editing a certain file by
b38fabf04e70 (Choosing Modes): Clarify.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
117 special text in the first nonblank line of the file. The
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
118 mode name should appear in this line both preceded and followed by
Dave Love <fx@gnu.org>
parents:
diff changeset
119 @samp{-*-}. Other text may appear on the line as well. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
120
Dave Love <fx@gnu.org>
parents:
diff changeset
121 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
122 ;-*-Lisp-*-
Dave Love <fx@gnu.org>
parents:
diff changeset
123 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
124
Dave Love <fx@gnu.org>
parents:
diff changeset
125 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
126 tells Emacs to use Lisp mode. Such an explicit specification overrides
38461
23f63206a867 Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents: 37986
diff changeset
127 any defaults based on the file name. Note how the semicolon is used
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
128 to make Lisp treat this line as a comment.
Dave Love <fx@gnu.org>
parents:
diff changeset
129
Dave Love <fx@gnu.org>
parents:
diff changeset
130 Another format of mode specification is
Dave Love <fx@gnu.org>
parents:
diff changeset
131
Dave Love <fx@gnu.org>
parents:
diff changeset
132 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
133 -*- mode: @var{modename};-*-
Dave Love <fx@gnu.org>
parents:
diff changeset
134 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
135
Dave Love <fx@gnu.org>
parents:
diff changeset
136 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
137 which allows you to specify local variables as well, like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
138
Dave Love <fx@gnu.org>
parents:
diff changeset
139 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
140 -*- mode: @var{modename}; @var{var}: @var{value}; @dots{} -*-
Dave Love <fx@gnu.org>
parents:
diff changeset
141 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
142
Dave Love <fx@gnu.org>
parents:
diff changeset
143 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
144 @xref{File Variables}, for more information about this.
Dave Love <fx@gnu.org>
parents:
diff changeset
145
Dave Love <fx@gnu.org>
parents:
diff changeset
146 @vindex interpreter-mode-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
147 When a file's contents begin with @samp{#!}, it can serve as an
Dave Love <fx@gnu.org>
parents:
diff changeset
148 executable shell command, which works by running an interpreter named on
Dave Love <fx@gnu.org>
parents:
diff changeset
149 the file's first line. The rest of the file is used as input to the
Dave Love <fx@gnu.org>
parents:
diff changeset
150 interpreter.
Dave Love <fx@gnu.org>
parents:
diff changeset
151
Dave Love <fx@gnu.org>
parents:
diff changeset
152 When you visit such a file in Emacs, if the file's name does not
Dave Love <fx@gnu.org>
parents:
diff changeset
153 specify a major mode, Emacs uses the interpreter name on the first line
Dave Love <fx@gnu.org>
parents:
diff changeset
154 to choose a mode. If the first line is the name of a recognized
Dave Love <fx@gnu.org>
parents:
diff changeset
155 interpreter program, such as @samp{perl} or @samp{tcl}, Emacs uses a
Dave Love <fx@gnu.org>
parents:
diff changeset
156 mode appropriate for programs for that interpreter. The variable
Dave Love <fx@gnu.org>
parents:
diff changeset
157 @code{interpreter-mode-alist} specifies the correspondence between
Dave Love <fx@gnu.org>
parents:
diff changeset
158 interpreter program names and major modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
159
Dave Love <fx@gnu.org>
parents:
diff changeset
160 When the first line starts with @samp{#!}, you cannot (on many
Dave Love <fx@gnu.org>
parents:
diff changeset
161 systems) use the @samp{-*-} feature on the first line, because the
Dave Love <fx@gnu.org>
parents:
diff changeset
162 system would get confused when running the interpreter. So Emacs looks
Dave Love <fx@gnu.org>
parents:
diff changeset
163 for @samp{-*-} on the second line in such files as well as on the
Dave Love <fx@gnu.org>
parents:
diff changeset
164 first line.
Dave Love <fx@gnu.org>
parents:
diff changeset
165
Dave Love <fx@gnu.org>
parents:
diff changeset
166 @vindex default-major-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
167 When you visit a file that does not specify a major mode to use, or
Dave Love <fx@gnu.org>
parents:
diff changeset
168 when you create a new buffer with @kbd{C-x b}, the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
169 @code{default-major-mode} specifies which major mode to use. Normally
Dave Love <fx@gnu.org>
parents:
diff changeset
170 its value is the symbol @code{fundamental-mode}, which specifies
Dave Love <fx@gnu.org>
parents:
diff changeset
171 Fundamental mode. If @code{default-major-mode} is @code{nil}, the major
37986
e11682cc1516 selected buffer => current buffer.
Richard M. Stallman <rms@gnu.org>
parents: 37421
diff changeset
172 mode is taken from the previously current buffer.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
173
Dave Love <fx@gnu.org>
parents:
diff changeset
174 @findex normal-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
175 If you change the major mode of a buffer, you can go back to the major
Dave Love <fx@gnu.org>
parents:
diff changeset
176 mode Emacs would choose automatically: use the command @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
177 normal-mode} to do this. This is the same function that
Dave Love <fx@gnu.org>
parents:
diff changeset
178 @code{find-file} calls to choose the major mode. It also processes
38461
23f63206a867 Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents: 37986
diff changeset
179 the file's local variables list (if any).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
180
Dave Love <fx@gnu.org>
parents:
diff changeset
181 @vindex change-major-mode-with-file-name
Dave Love <fx@gnu.org>
parents:
diff changeset
182 The commands @kbd{C-x C-w} and @code{set-visited-file-name} change to
Dave Love <fx@gnu.org>
parents:
diff changeset
183 a new major mode if the new file name implies a mode (@pxref{Saving}).
60109
b38fabf04e70 (Choosing Modes): Clarify.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
184 (@kbd{C-x C-s} does this too, if the buffer wasn't visiting a file.)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
185 However, this does not happen if the buffer contents specify a major
Dave Love <fx@gnu.org>
parents:
diff changeset
186 mode, and certain ``special'' major modes do not allow the mode to
Dave Love <fx@gnu.org>
parents:
diff changeset
187 change. You can turn off this mode-changing feature by setting
Dave Love <fx@gnu.org>
parents:
diff changeset
188 @code{change-major-mode-with-file-name} to @code{nil}.
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 38745
diff changeset
189
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 38745
diff changeset
190 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 38745
diff changeset
191 arch-tag: f2558800-cf32-4839-8acb-7d3b4df2a155
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 38745
diff changeset
192 @end ignore