annotate man/programs.texi @ 78699:7669bfcbef45

*** empty log message ***
author Martin Rudalics <rudalics@gmx.at>
date Wed, 29 Aug 2007 09:04:18 +0000
parents 5e6911100617
children 02b9a9aa5b0c
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.
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 1999, 2000,
75348
3d45362f1d38 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 75053
diff changeset
3 @c 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @c See file emacs.texi for copying conditions.
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @node Programs, Building, Text, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @chapter Editing Programs
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @cindex Lisp editing
Dave Love <fx@gnu.org>
parents:
diff changeset
8 @cindex C editing
Dave Love <fx@gnu.org>
parents:
diff changeset
9 @cindex program editing
Dave Love <fx@gnu.org>
parents:
diff changeset
10
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
11 Emacs provides many features to facilitate editing programs. Some
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
12 of these features can
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
13
Dave Love <fx@gnu.org>
parents:
diff changeset
14 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
15 @item
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
16 Find or move over top-level definitions (@pxref{Defuns}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
17 @item
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
18 Apply the usual indentation conventions of the language
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
19 (@pxref{Program Indent}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
20 @item
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
21 Balance parentheses (@pxref{Parentheses}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
22 @item
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
23 Insert, kill or align comments (@pxref{Comments}).
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
24 @item
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
25 Highlight program syntax (@pxref{Font Lock}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
26 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
27
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
28 This chapter describes these features and many more.
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
29
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
30 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
31 * Program Modes:: Major modes for editing programs.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
32 * Defuns:: Commands to operate on major top-level parts
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
33 of a program.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
34 * Program Indent:: Adjusting indentation to show the nesting.
56809
bc1eb92f6563 Interchange nodes (for correct numbering).
Luc Teirlinck <teirllm@auburn.edu>
parents: 56164
diff changeset
35 * Parentheses:: Commands that operate on parentheses.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
36 * Comments:: Inserting, killing, and aligning comments.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
37 * Documentation:: Getting documentation of functions you plan to call.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
38 * Hideshow:: Displaying blocks selectively.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
39 * Symbol Completion:: Completion on symbol names of your program or language.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
40 * Glasses:: Making identifiersLikeThis more readable.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
41 * Misc for Programs:: Other Emacs features useful for editing programs.
26264
Francesco Potortì <pot@gnu.org>
parents: 26106
diff changeset
42 * C Modes:: Special commands of C, C++, Objective-C,
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
43 Java, and Pike modes.
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
44 * Asm Mode:: Asm mode and its special features.
70442
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
45 @ifnottex
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
46 * Fortran:: Fortran mode and its special features.
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
47 @end ifnottex
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
48 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
49
Dave Love <fx@gnu.org>
parents:
diff changeset
50 @node Program Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
51 @section Major Modes for Programming Languages
Dave Love <fx@gnu.org>
parents:
diff changeset
52 @cindex modes for programming languages
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
53
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
54 Emacs has specialized major modes for various programming languages.
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
55 @xref{Major Modes}. A programming language major mode typically
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
56 specifies the syntax of expressions, the customary rules for
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
57 indentation, how to do syntax highlighting for the language, and how
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
58 to find the beginning of a function definition. It often customizes
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
59 or provides facilities for compiling and debugging programs as well.
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
60
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
61 Ideally, Emacs should provide a major mode for each programming
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
62 language that you might want to edit; if it doesn't have a mode for
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
63 your favorite language, you can contribute one. But often the mode
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
64 for one language can serve for other syntactically similar languages.
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
65 The major mode for language @var{l} is called @code{@var{l}-mode},
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
66 and you can select it by typing @kbd{M-x @var{l}-mode @key{RET}}.
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
67 @xref{Choosing Modes}.
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
68
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
69 @cindex Perl mode
Dave Love <fx@gnu.org>
parents:
diff changeset
70 @cindex Icon mode
Dave Love <fx@gnu.org>
parents:
diff changeset
71 @cindex Makefile mode
Dave Love <fx@gnu.org>
parents:
diff changeset
72 @cindex Tcl mode
Dave Love <fx@gnu.org>
parents:
diff changeset
73 @cindex CPerl mode
26106
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
74 @cindex DSSSL mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
75 @cindex Octave mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
76 @cindex Metafont mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
77 @cindex Modula2 mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
78 @cindex Prolog mode
77610
5e6911100617 Restore mention of python.el pending consideration of legal status.
Glenn Morris <rgm@gnu.org>
parents: 77529
diff changeset
79 @cindex Python mode
26106
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
80 @cindex Simula mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
81 @cindex VHDL mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
82 @cindex M4 mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
83 @cindex Shell-script mode
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
84 @cindex Delphi mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
85 @cindex PostScript mode
61053
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
86 @cindex Conf mode
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
87 @cindex DNS mode
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
88 The existing programming language major modes include Lisp, Scheme (a
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
89 variant of Lisp) and the Scheme-based DSSSL expression language, Ada,
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
90 ASM, AWK, C, C++, Delphi (Object Pascal), Fortran (free format and fixed
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
91 format), Icon, IDL (CORBA), IDLWAVE, Java, Metafont (@TeX{}'s
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
92 companion for font creation), Modula2, Objective-C, Octave, Pascal,
77610
5e6911100617 Restore mention of python.el pending consideration of legal status.
Glenn Morris <rgm@gnu.org>
parents: 77529
diff changeset
93 Perl, Pike, PostScript, Prolog, Python, Simula, Tcl, and VHDL. An
61053
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
94 alternative mode for Perl is called CPerl mode. Modes are available for
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
95 the scripting languages of the common GNU and Unix shells, VMS DCL, and
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
96 MS-DOS/MS-Windows @samp{BAT} files. There are also major modes for
61053
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
97 editing makefiles, DNS master files, and various sorts of configuration
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
98 files.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
99
Dave Love <fx@gnu.org>
parents:
diff changeset
100 @kindex DEL @r{(programming modes)}
37978
c41356c953a0 Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents: 37868
diff changeset
101 @findex c-electric-backspace
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
102 In most programming languages, indentation should vary from line to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
103 line to illustrate the structure of the program. So the major modes
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
104 for programming languages arrange for @key{TAB} to update the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
105 indentation of the current line. They also rebind @key{DEL} to treat
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
106 a tab as if it were the equivalent number of spaces; this lets you
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
107 delete one column of indentation without worrying whether the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
108 whitespace consists of spaces or tabs. Use @kbd{C-b C-d} to delete a
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
109 tab character before point, in these modes.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
110
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
111 Separate manuals are available for the modes for Ada (@pxref{Top, , Ada
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
112 Mode, ada-mode, Ada Mode}), C/C++/Objective C/Java/Corba IDL/Pike/AWK
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
113 (@pxref{Top, , CC Mode, ccmode, CC Mode}) and the IDLWAVE modes
69506
91970b147f39 * emacs-xtra.texi (Emerge, Picture Mode. Fortran): New chapters,
Chong Yidong <cyd@stupidchicken.com>
parents: 68818
diff changeset
114 (@pxref{Top, , IDLWAVE, idlwave, IDLWAVE User Manual}). For Fortran
70442
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
115 mode, see
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
116 @iftex
70472
8566e3f340ec msdog.texi (Microsoft Windows):
Eli Zaretskii <eliz@gnu.org>
parents: 70442
diff changeset
117 @ref{Fortran,,, emacs-xtra, Specialized Emacs Features}.
70442
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
118 @end iftex
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
119 @ifnottex
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
120 @ref{Fortran}.
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
121 @end ifnottex
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
122
38122
4aeb215906f3 Proofreading fixes from Peter Milliken <Peter.Milliken@GTECH.COM>.
Eli Zaretskii <eliz@gnu.org>
parents: 38090
diff changeset
123
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
124 @cindex mode hook
Dave Love <fx@gnu.org>
parents:
diff changeset
125 @vindex c-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
126 @vindex lisp-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
127 @vindex emacs-lisp-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
128 @vindex lisp-interaction-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
129 @vindex scheme-mode-hook
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
130 Turning on a major mode runs a normal hook called the @dfn{mode
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
131 hook}, which is the value of a Lisp variable. Each major mode has a
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
132 mode hook, and the hook's name is always made from the mode command's
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
133 name by adding @samp{-hook}. For example, turning on C mode runs the
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
134 hook @code{c-mode-hook}, while turning on Lisp mode runs the hook
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
135 @code{lisp-mode-hook}. The purpose of the mode hook is to give you a
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
136 place to set up customizations for that major mode. @xref{Hooks}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
137
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
138 @node Defuns
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
139 @section Top-Level Definitions, or Defuns
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
140
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
141 In Emacs, a major definition at the top level in the buffer,
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
142 something like a function, is called a @dfn{defun}. The name comes
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
143 from Lisp, but in Emacs we use it for all languages.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
144
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
145 @menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
146 * Left Margin Paren:: An open-paren or similar opening delimiter
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
147 starts a defun if it is at the left margin.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
148 * Moving by Defuns:: Commands to move over or mark a major definition.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
149 * Imenu:: Making buffer indexes as menus.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
150 * Which Function:: Which Function mode shows which function you are in.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
151 @end menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
152
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
153 @node Left Margin Paren
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
154 @subsection Left Margin Convention
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
155
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
156 @cindex open-parenthesis in leftmost column
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
157 @cindex ( in leftmost column
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
158 Emacs assumes by default that any opening delimiter found at the
74697
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
159 left margin is the start of a top-level definition, or defun.
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
160 Therefore, @strong{don't put an opening delimiter at the left margin
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
161 unless it should have that significance}. For instance, never put an
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
162 open-parenthesis at the left margin in a Lisp file unless it is the
74697
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
163 start of a top-level list.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
164
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
165 If you don't follow this convention, not only will you have trouble
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
166 when you explicitly use the commands for motion by defuns; other
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
167 features that use them will also give you trouble. This includes
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
168 the indentation commands (@pxref{Program Indent}) and Font Lock
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
169 mode (@pxref{Font Lock}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
170
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
171 The most likely problem case is when you want an opening delimiter
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
172 at the start of a line inside a string. To avoid trouble, put an
74697
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
173 escape character (@samp{\}, in C and Emacs Lisp, @samp{/} in some
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
174 other Lisp dialects) before the opening delimiter. This will not
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
175 affect the contents of the string, but will prevent that opening
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
176 delimiter from starting a defun. Here's an example:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
177
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
178 @example
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
179 (insert "Foo:
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
180 \(bar)
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
181 ")
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
182 @end example
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
183
46035
11e7a6a33a8c Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents: 45997
diff changeset
184 To help you catch violations of this convention, Font Lock mode
11e7a6a33a8c Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents: 45997
diff changeset
185 highlights confusing opening delimiters (those that ought to be
11e7a6a33a8c Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents: 45997
diff changeset
186 quoted) in bold red.
11e7a6a33a8c Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents: 45997
diff changeset
187
74697
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
188 If you need to override this convention, you can so by setting this
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
189 user option:
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
190
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
191 @defvar open-paren-in-column-0-is-defun-start
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
192 If this user option is set to @code{t} (the default), opening
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
193 parentheses or braces at column zero always start defuns. When it's
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
194 @code{nil}, defuns are found by searching for parens or braces at the
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
195 outermost level.
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
196 @end defvar
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
197
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
198 Usually, you shouldn't need to set
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
199 @code{open-paren-in-column-0-is-defun-start} to @code{nil}. However,
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
200 if your buffer contains parentheses or braces in column zero which
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
201 don't start defuns and this confuses Emacs, it sometimes helps to set
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
202 the option to @code{nil}. Be aware, though, that this will make
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
203 scrolling and display in large buffers quite sluggish, and that
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
204 parentheses and braces must be correctly matched throughout the buffer
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
205 for it to work properly.
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
206
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
207 In the earliest days, the original Emacs found defuns by moving
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
208 upward a level of parentheses or braces until there were no more
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
209 levels to go up. This always required scanning all the way back to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
210 the beginning of the buffer, even for a small function. To speed up
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
211 the operation, we changed Emacs to assume that any opening delimiter
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
212 at the left margin is the start of a defun. This heuristic is nearly
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
213 always right, and avoids the need to scan back to the beginning of the
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
214 buffer. However, now that modern computers are so powerful, this
67683
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
215 scanning is rarely slow enough to annoy, so we've provided a way to
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
216 disable the heuristic.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
217
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
218 @node Moving by Defuns
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
219 @subsection Moving by Defuns
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
220 @cindex defuns
Dave Love <fx@gnu.org>
parents:
diff changeset
221
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
222 These commands move point or set up the region based on top-level
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
223 major definitions, also called @dfn{defuns}.
38123
af8117970ca7 More proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents: 38122
diff changeset
224
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
225 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
226 @item C-M-a
Dave Love <fx@gnu.org>
parents:
diff changeset
227 Move to beginning of current or preceding defun
Dave Love <fx@gnu.org>
parents:
diff changeset
228 (@code{beginning-of-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
229 @item C-M-e
Dave Love <fx@gnu.org>
parents:
diff changeset
230 Move to end of current or following defun (@code{end-of-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
231 @item C-M-h
Dave Love <fx@gnu.org>
parents:
diff changeset
232 Put region around whole current or following defun (@code{mark-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
233 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
234
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
235 @cindex move to beginning or end of function
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
236 @cindex function, move to beginning or end
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
237 @kindex C-M-a
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
238 @kindex C-M-e
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
239 @kindex C-M-h
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
240 @findex beginning-of-defun
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
241 @findex end-of-defun
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
242 @findex mark-defun
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
243 The commands to move to the beginning and end of the current defun
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
244 are @kbd{C-M-a} (@code{beginning-of-defun}) and @kbd{C-M-e}
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
245 (@code{end-of-defun}). If you repeat one of these commands, or use a
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
246 positive numeric argument, each repetition moves to the next defun in
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
247 the direction of motion.
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
248
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
249 @kbd{C-M-a} with a negative argument @minus{}@var{n} moves forward
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
250 @var{n} times to the next beginning of a defun. This is not exactly
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
251 the same place that @kbd{C-M-e} with argument @var{n} would move to;
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
252 the end of this defun is not usually exactly the same place as the
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
253 beginning of the following defun. (Whitespace, comments, and perhaps
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
254 declarations can separate them.) Likewise, @kbd{C-M-e} with a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
255 negative argument moves back to an end of a defun, which is not quite
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
256 the same as @kbd{C-M-a} with a positive argument.
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
257
36263
11db0318031d Remove redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents: 36198
diff changeset
258 @kindex C-M-h @r{(C mode)}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
259 @findex c-mark-function
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
260 To operate on the current defun, use @kbd{C-M-h} (@code{mark-defun})
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
261 which puts point at the beginning and mark at the end of the current
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
262 defun. This is the easiest way to get ready to kill the defun in
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
263 order to move it to a different place in the file. If you use the
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
264 command while point is between defuns, it uses the following defun.
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
265 Successive uses of @kbd{C-M-h}, or using it in Transient Mark mode
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
266 when the mark is active, extends the end of the region to include one
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
267 more defun each time.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
268
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
269 In C mode, @kbd{C-M-h} runs the function @code{c-mark-function},
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
270 which is almost the same as @code{mark-defun}; the difference is that
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
271 it backs up over the argument declarations, function name and returned
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
272 data type so that the entire C function is inside the region. This is
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
273 an example of how major modes adjust the standard key bindings so that
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
274 they do their standard jobs in a way better fitting a particular
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
275 language. Other major modes may replace any or all of these key
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
276 bindings for that purpose.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
277
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
278 @node Imenu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
279 @subsection Imenu
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
280 @cindex index of buffer definitions
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
281 @cindex buffer definitions index
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
282 @cindex tags
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
283
42675
640c0fcaebf1 Fix typos.
Pavel Janík <Pavel@Janik.cz>
parents: 41495
diff changeset
284 The Imenu facility offers a way to find the major definitions in
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
285 a file by name. It is also useful in text formatter major modes,
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
286 where it treats each chapter, section, etc., as a definition.
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
287 (@xref{Tags}, for a more powerful feature that handles multiple files
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
288 together.)
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
289
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
290 @findex imenu
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
291 If you type @kbd{M-x imenu}, it reads the name of a definition using
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
292 the minibuffer, then moves point to that definition. You can use
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
293 completion to specify the name; the command always displays the whole
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
294 list of valid names.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
295
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
296 @findex imenu-add-menubar-index
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
297 Alternatively, you can bind the command @code{imenu} to a mouse
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
298 click. Then it displays mouse menus for you to select a definition
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
299 name. You can also add the buffer's index to the menu bar by calling
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
300 @code{imenu-add-menubar-index}. If you want to have this menu bar
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
301 item available for all buffers in a certain major mode, you can do
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
302 this by adding @code{imenu-add-menubar-index} to its mode hook. But
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
303 if you have done that, you will have to wait a little while each time
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
304 you visit a file in that mode, while Emacs finds all the definitions
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
305 in that buffer.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
306
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
307 @vindex imenu-auto-rescan
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
308 When you change the contents of a buffer, if you add or delete
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
309 definitions, you can update the buffer's index based on the
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
310 new contents by invoking the @samp{*Rescan*} item in the menu.
39063
6ecd6d3c0630 (Imenu): Fix a typo.
Eli Zaretskii <eliz@gnu.org>
parents: 38946
diff changeset
311 Rescanning happens automatically if you set @code{imenu-auto-rescan} to
6ecd6d3c0630 (Imenu): Fix a typo.
Eli Zaretskii <eliz@gnu.org>
parents: 38946
diff changeset
312 a non-@code{nil} value. There is no need to rescan because of small
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
313 changes in the text.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
314
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
315 @vindex imenu-sort-function
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
316 You can customize the way the menus are sorted by setting the
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
317 variable @code{imenu-sort-function}. By default, names are ordered as
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
318 they occur in the buffer; if you want alphabetic sorting, use the
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
319 symbol @code{imenu--sort-by-name} as the value. You can also
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
320 define your own comparison function by writing Lisp code.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
321
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
322 Imenu provides the information to guide Which Function mode
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
323 @ifnottex
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
324 (@pxref{Which Function}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
325 @end ifnottex
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
326 @iftex
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
327 (see below).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
328 @end iftex
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
329 The Speedbar can also use it (@pxref{Speedbar}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
330
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
331 @node Which Function
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
332 @subsection Which Function Mode
40175
ba769a5fb855 (Which Function): Add a cindex entry.
Eli Zaretskii <eliz@gnu.org>
parents: 39063
diff changeset
333 @cindex current function name in mode line
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
334
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
335 Which Function mode is a minor mode that displays the current
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
336 function name in the mode line, updating it as you move around in a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
337 buffer.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
338
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
339 @findex which-function-mode
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
340 @vindex which-func-modes
77129
4805684e0b00 wording for 8.5x11
Karl Berry <karl@gnu.org>
parents: 75348
diff changeset
341 To either enable or disable Which Function mode, use the command
4805684e0b00 wording for 8.5x11
Karl Berry <karl@gnu.org>
parents: 75348
diff changeset
342 @kbd{M-x which-function-mode}. This command is global; it applies to
4805684e0b00 wording for 8.5x11
Karl Berry <karl@gnu.org>
parents: 75348
diff changeset
343 all buffers, both existing ones and those yet to be created. However,
4805684e0b00 wording for 8.5x11
Karl Berry <karl@gnu.org>
parents: 75348
diff changeset
344 it takes effect only in certain major modes, those listed in the value
4805684e0b00 wording for 8.5x11
Karl Berry <karl@gnu.org>
parents: 75348
diff changeset
345 of @code{which-func-modes}. If the value is @code{t}, then Which
4805684e0b00 wording for 8.5x11
Karl Berry <karl@gnu.org>
parents: 75348
diff changeset
346 Function mode applies to all major modes that know how to support
4805684e0b00 wording for 8.5x11
Karl Berry <karl@gnu.org>
parents: 75348
diff changeset
347 it---in other words, all the major modes that support Imenu.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
348
Dave Love <fx@gnu.org>
parents:
diff changeset
349 @node Program Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
350 @section Indentation for Programs
Dave Love <fx@gnu.org>
parents:
diff changeset
351 @cindex indentation for programs
Dave Love <fx@gnu.org>
parents:
diff changeset
352
Dave Love <fx@gnu.org>
parents:
diff changeset
353 The best way to keep a program properly indented is to use Emacs to
Dave Love <fx@gnu.org>
parents:
diff changeset
354 reindent it as you change it. Emacs has commands to indent properly
Dave Love <fx@gnu.org>
parents:
diff changeset
355 either a single line, a specified number of lines, or all of the lines
Dave Love <fx@gnu.org>
parents:
diff changeset
356 inside a single parenthetical grouping.
Dave Love <fx@gnu.org>
parents:
diff changeset
357
Dave Love <fx@gnu.org>
parents:
diff changeset
358 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
359 * Basic Indent:: Indenting a single line.
Dave Love <fx@gnu.org>
parents:
diff changeset
360 * Multi-line Indent:: Commands to reindent many lines at once.
Dave Love <fx@gnu.org>
parents:
diff changeset
361 * Lisp Indent:: Specifying how each Lisp function should be indented.
Dave Love <fx@gnu.org>
parents:
diff changeset
362 * C Indent:: Extra features for indenting C and related modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
363 * Custom C Indent:: Controlling indentation style for C and related modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
364 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
365
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
366 @cindex pretty-printer
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
367 Emacs also provides a Lisp pretty-printer in the library @code{pp}.
Dave Love <fx@gnu.org>
parents:
diff changeset
368 This program reformats a Lisp object with indentation chosen to look nice.
Dave Love <fx@gnu.org>
parents:
diff changeset
369
Dave Love <fx@gnu.org>
parents:
diff changeset
370 @node Basic Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
371 @subsection Basic Program Indentation Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
372
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
373 The basic indentation commands indent a single line according to the
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
374 usual conventions of the language you are editing.
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
375
73197
3719cef078a7 improve more page breaks
Karl Berry <karl@gnu.org>
parents: 72101
diff changeset
376 @need 1000
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
377 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
378 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
379 Adjust indentation of current line.
Dave Love <fx@gnu.org>
parents:
diff changeset
380 @item C-j
69833
3bdd218d87df (Basic Indent): Clarify relationship of C-j to TAB.
Richard M. Stallman <rms@gnu.org>
parents: 69506
diff changeset
381 Insert a newline, then adjust indentation of following line
3bdd218d87df (Basic Indent): Clarify relationship of C-j to TAB.
Richard M. Stallman <rms@gnu.org>
parents: 69506
diff changeset
382 (@code{newline-and-indent}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
383 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
384
Dave Love <fx@gnu.org>
parents:
diff changeset
385 @kindex TAB @r{(programming modes)}
37978
c41356c953a0 Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents: 37868
diff changeset
386 @findex c-indent-command
c41356c953a0 Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents: 37868
diff changeset
387 @findex indent-line-function
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
388 @findex indent-for-tab-command
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
389 The basic indentation command is @key{TAB}, which gives the current line
Dave Love <fx@gnu.org>
parents:
diff changeset
390 the correct indentation as determined from the previous lines. The
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
391 function that @key{TAB} runs depends on the major mode; it is
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
392 @code{lisp-indent-line}
37978
c41356c953a0 Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents: 37868
diff changeset
393 in Lisp mode, @code{c-indent-command} in C mode, etc. These functions
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
394 understand the syntax and conventions of different languages, but they all do
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
395 conceptually the same job: @key{TAB} in any programming-language major mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
396 inserts or deletes whitespace at the beginning of the current line,
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
397 independent of where point is in the line. If point was inside the
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
398 whitespace at the beginning of the line, @key{TAB} puts it at the end of
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
399 that whitespace; otherwise, @key{TAB} keeps point fixed with respect to
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
400 the characters around it.
Dave Love <fx@gnu.org>
parents:
diff changeset
401
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
402 Use @kbd{C-q @key{TAB}} to insert a tab character at point.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
403
Dave Love <fx@gnu.org>
parents:
diff changeset
404 @kindex C-j
Dave Love <fx@gnu.org>
parents:
diff changeset
405 @findex newline-and-indent
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
406 When entering lines of new code, use @kbd{C-j}
69833
3bdd218d87df (Basic Indent): Clarify relationship of C-j to TAB.
Richard M. Stallman <rms@gnu.org>
parents: 69506
diff changeset
407 (@code{newline-and-indent}), which inserts a newline and then adjusts
69842
121db3a5c7ba (Basic Indent): C-j deletes trailing whitespace before the newline.
Richard M. Stallman <rms@gnu.org>
parents: 69840
diff changeset
408 indentation after it. (It also deletes any trailing whitespace which
121db3a5c7ba (Basic Indent): C-j deletes trailing whitespace before the newline.
Richard M. Stallman <rms@gnu.org>
parents: 69840
diff changeset
409 remains before the new newline.) Thus, @kbd{C-j} at the end of a line
121db3a5c7ba (Basic Indent): C-j deletes trailing whitespace before the newline.
Richard M. Stallman <rms@gnu.org>
parents: 69840
diff changeset
410 creates a blank line with appropriate indentation. In programming
121db3a5c7ba (Basic Indent): C-j deletes trailing whitespace before the newline.
Richard M. Stallman <rms@gnu.org>
parents: 69840
diff changeset
411 language modes, it is equivalent to @key{RET} @key{TAB}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
412
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
413 @key{TAB} indents a line that starts within a parenthetical grouping
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
414 under the preceding line within the grouping, or the text after the
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
415 parenthesis. Therefore, if you manually give one of these lines a
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
416 nonstandard indentation, the lines below will tend to follow it. This
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
417 behavior is convenient in cases where you have overridden the standard
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
418 result of @key{TAB} because you find it unaesthetic for a particular
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
419 line.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
420
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
421 In some modes, an open-parenthesis, open-brace or other opening
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
422 delimiter at the left margin is assumed by Emacs (including the
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
423 indentation routines) to be the start of a function. This speeds up
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
424 indentation commands. If you will be editing text which contains
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
425 opening delimiters in column zero that aren't the beginning of a
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
426 functions, even inside strings or comments, you must set
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
427 @code{open-paren-in-column-0-is-defun-start}. @xref{Left Margin
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
428 Paren}, for more information on this.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
429
38009
b6036155d1ca (Basic Indent): Add a cross-reference to description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents: 37997
diff changeset
430 Normally, lines are indented with tabs and spaces. If you want Emacs
68717
e9bbbd27de3f (Basic Indent): Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents: 68697
diff changeset
431 to use spaces only, set @code{indent-tabs-mode} (@pxref{Just Spaces}).
38009
b6036155d1ca (Basic Indent): Add a cross-reference to description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents: 37997
diff changeset
432
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
433 @node Multi-line Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
434 @subsection Indenting Several Lines
Dave Love <fx@gnu.org>
parents:
diff changeset
435
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
436 When you wish to reindent several lines of code which have been
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
437 altered or moved to a different level in the parenthesis structure,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
438 you have several commands available.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
439
Dave Love <fx@gnu.org>
parents:
diff changeset
440 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
441 @item C-M-q
59475
279e43932b6f (Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 59461
diff changeset
442 Reindent all the lines within one parenthetical grouping (@code{indent-pp-sexp}).
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
443 @item C-M-\
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
444 Reindent all lines in the region (@code{indent-region}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
445 @item C-u @key{TAB}
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
446 Shift an entire parenthetical grouping rigidly sideways so that its
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
447 first line is properly indented.
38149
a07facd0bdf8 (Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents: 38148
diff changeset
448 @item M-x indent-code-rigidly
a07facd0bdf8 (Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents: 38148
diff changeset
449 Shift all the lines in the region rigidly sideways, but do not alter
a07facd0bdf8 (Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents: 38148
diff changeset
450 lines that start inside comments and strings.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
451 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
452
Dave Love <fx@gnu.org>
parents:
diff changeset
453 @kindex C-M-q
59475
279e43932b6f (Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 59461
diff changeset
454 @findex indent-pp-sexp
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
455 You can reindent the contents of a single parenthetical grouping by
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
456 positioning point before the beginning of it and typing @kbd{C-M-q}
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
457 (@code{indent-pp-sexp} in Lisp mode, @code{c-indent-exp} in C mode; also
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
458 bound to other suitable commands in other modes). The indentation of
59475
279e43932b6f (Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 59461
diff changeset
459 the line where the grouping starts is not changed; therefore this
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
460 changes only the relative indentation within the grouping, not its
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
461 overall indentation. To correct that as well, type @key{TAB} first.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
462
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
463 Another way to specify the range to be reindented is with the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
464 region. The command @kbd{C-M-\} (@code{indent-region}) applies
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
465 @key{TAB} to every line whose first character is between point and
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
466 mark.
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
467
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
468 @kindex C-u TAB
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
469 If you like the relative indentation within a grouping, but not the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
470 indentation of its first line, you can type @kbd{C-u @key{TAB}} to
38323
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
471 reindent the whole grouping as a rigid unit. (This works in Lisp
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
472 modes and C and related modes.) @key{TAB} with a numeric argument
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
473 reindents the current line as usual, then reindents by the same amount
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
474 all the lines in the parenthetical grouping starting on the current
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
475 line. It is clever, though, and does not alter lines that start
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
476 inside strings. Neither does it alter C preprocessor lines when in C
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
477 mode, but it does reindent any continuation lines that may be attached
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
478 to them.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
479
38149
a07facd0bdf8 (Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents: 38148
diff changeset
480 @findex indent-code-rigidly
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
481 You can also perform this operation on the region, using the command
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
482 @kbd{M-x indent-code-rigidly}. It rigidly shifts all the lines in the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
483 region sideways, like @code{indent-rigidly} does (@pxref{Indentation
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
484 Commands}). It doesn't alter the indentation of lines that start
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
485 inside a string, unless the region also starts inside that string.
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
486 The prefix arg specifies the number of columns to indent.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
487
Dave Love <fx@gnu.org>
parents:
diff changeset
488 @node Lisp Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
489 @subsection Customizing Lisp Indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
490 @cindex customizing Lisp indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
491
Dave Love <fx@gnu.org>
parents:
diff changeset
492 The indentation pattern for a Lisp expression can depend on the function
Dave Love <fx@gnu.org>
parents:
diff changeset
493 called by the expression. For each Lisp function, you can choose among
Dave Love <fx@gnu.org>
parents:
diff changeset
494 several predefined patterns of indentation, or define an arbitrary one with
Dave Love <fx@gnu.org>
parents:
diff changeset
495 a Lisp program.
Dave Love <fx@gnu.org>
parents:
diff changeset
496
Dave Love <fx@gnu.org>
parents:
diff changeset
497 The standard pattern of indentation is as follows: the second line of the
Dave Love <fx@gnu.org>
parents:
diff changeset
498 expression is indented under the first argument, if that is on the same
Dave Love <fx@gnu.org>
parents:
diff changeset
499 line as the beginning of the expression; otherwise, the second line is
Dave Love <fx@gnu.org>
parents:
diff changeset
500 indented underneath the function name. Each following line is indented
Dave Love <fx@gnu.org>
parents:
diff changeset
501 under the previous line whose nesting depth is the same.
Dave Love <fx@gnu.org>
parents:
diff changeset
502
Dave Love <fx@gnu.org>
parents:
diff changeset
503 @vindex lisp-indent-offset
Dave Love <fx@gnu.org>
parents:
diff changeset
504 If the variable @code{lisp-indent-offset} is non-@code{nil}, it overrides
Dave Love <fx@gnu.org>
parents:
diff changeset
505 the usual indentation pattern for the second line of an expression, so that
Dave Love <fx@gnu.org>
parents:
diff changeset
506 such lines are always indented @code{lisp-indent-offset} more columns than
Dave Love <fx@gnu.org>
parents:
diff changeset
507 the containing list.
Dave Love <fx@gnu.org>
parents:
diff changeset
508
Dave Love <fx@gnu.org>
parents:
diff changeset
509 @vindex lisp-body-indent
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
510 Certain functions override the standard pattern. Functions whose
42675
640c0fcaebf1 Fix typos.
Pavel Janík <Pavel@Janik.cz>
parents: 41495
diff changeset
511 names start with @code{def} treat the second lines as the start of
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
512 a @dfn{body}, by indenting the second line @code{lisp-body-indent}
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
513 additional columns beyond the open-parenthesis that starts the
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
514 expression.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
515
41409
9cea749ef5c3 (Lisp Indent): Add index entry for lisp-indent-function.
Eli Zaretskii <eliz@gnu.org>
parents: 40175
diff changeset
516 @cindex @code{lisp-indent-function} property
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
517 You can override the standard pattern in various ways for individual
52153
6b84fb503a42 (Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents: 51451
diff changeset
518 functions, according to the @code{lisp-indent-function} property of
6b84fb503a42 (Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents: 51451
diff changeset
519 the function name. Normally you would use this for macro definitions
6b84fb503a42 (Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents: 51451
diff changeset
520 and specify it using the @code{declare} construct (@pxref{Defining
6b84fb503a42 (Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents: 51451
diff changeset
521 Macros,,, elisp, the Emacs Lisp Reference Manual}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
522
Dave Love <fx@gnu.org>
parents:
diff changeset
523 @node C Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
524 @subsection Commands for C Indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
525
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
526 Here are special features for indentation in C mode and related modes:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
527
Dave Love <fx@gnu.org>
parents:
diff changeset
528 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
529 @item C-c C-q
Dave Love <fx@gnu.org>
parents:
diff changeset
530 @kindex C-c C-q @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
531 @findex c-indent-defun
Dave Love <fx@gnu.org>
parents:
diff changeset
532 Reindent the current top-level function definition or aggregate type
Dave Love <fx@gnu.org>
parents:
diff changeset
533 declaration (@code{c-indent-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
534
Dave Love <fx@gnu.org>
parents:
diff changeset
535 @item C-M-q
Dave Love <fx@gnu.org>
parents:
diff changeset
536 @kindex C-M-q @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
537 @findex c-indent-exp
Dave Love <fx@gnu.org>
parents:
diff changeset
538 Reindent each line in the balanced expression that follows point
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
539 (@code{c-indent-exp}). A prefix argument inhibits warning messages
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
540 about invalid syntax.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
541
Dave Love <fx@gnu.org>
parents:
diff changeset
542 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
543 @findex c-indent-command
Dave Love <fx@gnu.org>
parents:
diff changeset
544 Reindent the current line, and/or in some cases insert a tab character
Dave Love <fx@gnu.org>
parents:
diff changeset
545 (@code{c-indent-command}).
Dave Love <fx@gnu.org>
parents:
diff changeset
546
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
547 @vindex c-tab-always-indent
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
548 If @code{c-tab-always-indent} is @code{t}, this command always reindents
Dave Love <fx@gnu.org>
parents:
diff changeset
549 the current line and does nothing else. This is the default.
Dave Love <fx@gnu.org>
parents:
diff changeset
550
Dave Love <fx@gnu.org>
parents:
diff changeset
551 If that variable is @code{nil}, this command reindents the current line
Dave Love <fx@gnu.org>
parents:
diff changeset
552 only if point is at the left margin or in the line's indentation;
Dave Love <fx@gnu.org>
parents:
diff changeset
553 otherwise, it inserts a tab (or the equivalent number of spaces,
Dave Love <fx@gnu.org>
parents:
diff changeset
554 if @code{indent-tabs-mode} is @code{nil}).
Dave Love <fx@gnu.org>
parents:
diff changeset
555
Dave Love <fx@gnu.org>
parents:
diff changeset
556 Any other value (not @code{nil} or @code{t}) means always reindent the
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
557 line, and also insert a tab if within a comment or a string.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
558 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
559
Dave Love <fx@gnu.org>
parents:
diff changeset
560 To reindent the whole current buffer, type @kbd{C-x h C-M-\}. This
Dave Love <fx@gnu.org>
parents:
diff changeset
561 first selects the whole buffer as the region, then reindents that
Dave Love <fx@gnu.org>
parents:
diff changeset
562 region.
Dave Love <fx@gnu.org>
parents:
diff changeset
563
Dave Love <fx@gnu.org>
parents:
diff changeset
564 To reindent the current block, use @kbd{C-M-u C-M-q}. This moves
Dave Love <fx@gnu.org>
parents:
diff changeset
565 to the front of the block and then reindents it all.
Dave Love <fx@gnu.org>
parents:
diff changeset
566
Dave Love <fx@gnu.org>
parents:
diff changeset
567 @node Custom C Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
568 @subsection Customizing C Indentation
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
569 @cindex style (for indentation)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
570
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
571 C mode and related modes use a flexible mechanism for customizing
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
572 indentation. C mode indents a source line in two steps: first it
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
573 classifies the line syntactically according to its contents and
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
574 context; second, it determines the indentation offset associated by
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
575 your selected @dfn{style} with the syntactic construct and adds this
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
576 onto the indentation of the @dfn{anchor statement}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
577
Dave Love <fx@gnu.org>
parents:
diff changeset
578 @table @kbd
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
579 @item C-c . @key{RET} @var{style} @key{RET}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
580 Select a predefined style @var{style} (@code{c-set-style}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
581 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
582
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
583 A @dfn{style} is a named collection of customizations that can be
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
584 used in C mode and the related modes. @ref{Styles,,, ccmode, The CC
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
585 Mode Manual}, for a complete description. Emacs comes with several
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
586 predefined styles, including @code{gnu}, @code{k&r}, @code{bsd},
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
587 @code{stroustrup}, @code{linux}, @code{python}, @code{java},
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
588 @code{whitesmith}, @code{ellemtel}, and @code{awk}. Some of these
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
589 styles are primarily intended for one language, but any of them can be
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
590 used with any of the languages supported by these modes. To find out
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
591 what a style looks like, select it and reindent some code, e.g., by
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
592 typing @key{C-M-q} at the start of a function definition.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
593
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
594 @kindex C-c . @r{(C mode)}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
595 @findex c-set-style
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
596 To choose a style for the current buffer, use the command @w{@kbd{C-c
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
597 .}}. Specify a style name as an argument (case is not significant).
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
598 This command affects the current buffer only, and it affects only
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
599 future invocations of the indentation commands; it does not reindent
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
600 the code already in the buffer. To reindent the whole buffer in the
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
601 new style, you can type @kbd{C-x h C-M-\}.
38148
071d97105015 Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents: 38136
diff changeset
602
071d97105015 Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents: 38136
diff changeset
603 @vindex c-default-style
071d97105015 Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents: 38136
diff changeset
604 You can also set the variable @code{c-default-style} to specify the
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
605 default style for various major modes. Its value should be either the
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
606 style's name (a string) or an alist, in which each element specifies
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
607 one major mode and which indentation style to use for it. For
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
608 example,
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
609
Dave Love <fx@gnu.org>
parents:
diff changeset
610 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
611 (setq c-default-style
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
612 '((java-mode . "java") (awk-mode . "awk") (other . "gnu")))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
613 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
614
Dave Love <fx@gnu.org>
parents:
diff changeset
615 @noindent
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
616 specifies explicit choices for Java and AWK modes, and the default
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
617 @samp{gnu} style for the other C-like modes. (These settings are
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
618 actually the defaults.) This variable takes effect when you select
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
619 one of the C-like major modes; thus, if you specify a new default
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
620 style for Java mode, you can make it take effect in an existing Java
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
621 mode buffer by typing @kbd{M-x java-mode} there.
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
622
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
623 The @code{gnu} style specifies the formatting recommended by the GNU
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
624 Project for C; it is the default, so as to encourage use of our
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
625 recommended style.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
626
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
627 @xref{Indentation Engine Basics,,, ccmode, the CC Mode Manual}, and
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
628 @ref{Customizing Indentation,,, ccmode, the CC Mode Manual}, for more
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
629 information on customizing indentation for C and related modes,
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
630 including how to override parts of an existing style and how to define
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
631 your own styles.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
632
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
633 @node Parentheses
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
634 @section Commands for Editing with Parentheses
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
635
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
636 @findex check-parens
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
637 @cindex unbalanced parentheses and quotes
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
638 This section describes the commands and features that take advantage
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
639 of the parenthesis structure in a program, or help you keep it
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
640 balanced.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
641
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
642 When talking about these facilities, the term ``parenthesis'' also
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
643 includes braces, brackets, or whatever delimiters are defined to match
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
644 in pairs. The major mode controls which delimiters are significant,
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
645 through the syntax table (@pxref{Syntax}). In Lisp, only parentheses
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
646 count; in C, these commands apply to braces and brackets too.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
647
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
648 You can use @kbd{M-x check-parens} to find any unbalanced
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
649 parentheses and unbalanced string quotes in the buffer.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
650
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
651 @menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
652 * Expressions:: Expressions with balanced parentheses.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
653 * Moving by Parens:: Commands for moving up, down and across
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
654 in the structure of parentheses.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
655 * Matching:: Insertion of a close-delimiter flashes matching open.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
656 @end menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
657
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
658 @node Expressions
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
659 @subsection Expressions with Balanced Parentheses
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
660
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
661 @cindex sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
662 @cindex expression
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
663 @cindex balanced expression
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
664 These commands deal with balanced expressions, also called
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
665 @dfn{sexps}@footnote{The word ``sexp'' is used to refer to an
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
666 expression in Lisp.}.
28627
1f6ba3e73fe9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 28391
diff changeset
667
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
668 @table @kbd
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
669 @item C-M-f
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
670 Move forward over a balanced expression (@code{forward-sexp}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
671 @item C-M-b
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
672 Move backward over a balanced expression (@code{backward-sexp}).
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
673 @item C-M-k
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
674 Kill balanced expression forward (@code{kill-sexp}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
675 @item C-M-t
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
676 Transpose expressions (@code{transpose-sexps}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
677 @item C-M-@@
54272
3fd0ea9feede (Expressions): Doc C-M-SPC as alias for C-M-@.
Richard M. Stallman <rms@gnu.org>
parents: 53386
diff changeset
678 @itemx C-M-@key{SPC}
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
679 Put mark after following expression (@code{mark-sexp}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
680 @end table
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
681
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
682 Each programming language major mode customizes the definition of
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
683 balanced expressions to suit that language. Balanced expressions
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
684 typically include symbols, numbers, and string constants, as well as
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
685 any pair of matching delimiters and their contents. Some languages
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
686 have obscure forms of expression syntax that nobody has bothered to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
687 implement in Emacs.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
688
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
689 @cindex Control-Meta
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
690 By convention, the keys for these commands are all Control-Meta
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
691 characters. They usually act on expressions just as the corresponding
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
692 Meta characters act on words. For instance, the command @kbd{C-M-b}
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
693 moves backward over a balanced expression, just as @kbd{M-b} moves
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
694 back over a word.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
695
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
696 @kindex C-M-f
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
697 @kindex C-M-b
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
698 @findex forward-sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
699 @findex backward-sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
700 To move forward over a balanced expression, use @kbd{C-M-f}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
701 (@code{forward-sexp}). If the first significant character after point
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
702 is an opening delimiter (@samp{(} in Lisp; @samp{(}, @samp{[} or
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
703 @samp{@{} in C), @kbd{C-M-f} moves past the matching closing
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
704 delimiter. If the character begins a symbol, string, or number,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
705 @kbd{C-M-f} moves over that.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
706
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
707 The command @kbd{C-M-b} (@code{backward-sexp}) moves backward over a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
708 balanced expression. The detailed rules are like those above for
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
709 @kbd{C-M-f}, but with directions reversed. If there are prefix
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
710 characters (single-quote, backquote and comma, in Lisp) preceding the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
711 expression, @kbd{C-M-b} moves back over them as well. The balanced
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
712 expression commands move across comments as if they were whitespace,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
713 in most modes.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
714
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
715 @kbd{C-M-f} or @kbd{C-M-b} with an argument repeats that operation the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
716 specified number of times; with a negative argument, it moves in the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
717 opposite direction.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
718
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
719 @cindex killing expressions
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
720 @kindex C-M-k
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
721 @findex kill-sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
722 Killing a whole balanced expression can be done with @kbd{C-M-k}
51451
75df22371834 (Expressions): Delete C-M-DEL.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
723 (@code{kill-sexp}). @kbd{C-M-k} kills the characters that @kbd{C-M-f}
75df22371834 (Expressions): Delete C-M-DEL.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
724 would move over.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
725
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
726 @cindex transposition of expressions
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
727 @kindex C-M-t
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
728 @findex transpose-sexps
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
729 A somewhat random-sounding command which is nevertheless handy is
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
730 @kbd{C-M-t} (@code{transpose-sexps}), which drags the previous
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
731 balanced expression across the next one. An argument serves as a
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
732 repeat count, moving the previous expression over that many following
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
733 ones. A negative argument drags the previous balanced expression
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
734 backwards across those before it (thus canceling out the effect of
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
735 @kbd{C-M-t} with a positive argument). An argument of zero, rather
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
736 than doing nothing, transposes the balanced expressions ending at or
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
737 after point and the mark.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
738
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
739 @kindex C-M-@@
54272
3fd0ea9feede (Expressions): Doc C-M-SPC as alias for C-M-@.
Richard M. Stallman <rms@gnu.org>
parents: 53386
diff changeset
740 @kindex C-M-@key{SPC}
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
741 @findex mark-sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
742 To set the region around the next balanced expression in the buffer,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
743 use @kbd{C-M-@@} (@code{mark-sexp}), which sets mark at the same place
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
744 that @kbd{C-M-f} would move to. @kbd{C-M-@@} takes arguments like
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
745 @kbd{C-M-f}. In particular, a negative argument is useful for putting
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
746 the mark at the beginning of the previous balanced expression. The
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
747 alias @kbd{C-M-@key{SPC}} is equivalent to @kbd{C-M-@@}. When you
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
748 repeat this command, or use it in Transient Mark mode when the mark is
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
749 active, it extends the end of the region by one sexp each time.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
750
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
751 In languages that use infix operators, such as C, it is not possible
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
752 to recognize all balanced expressions as such because there can be
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
753 multiple possibilities at a given position. For example, C mode does
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
754 not treat @samp{foo + bar} as a single expression, even though it
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
755 @emph{is} one C expression; instead, it recognizes @samp{foo} as one
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
756 expression and @samp{bar} as another, with the @samp{+} as punctuation
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
757 between them. Both @samp{foo + bar} and @samp{foo} are legitimate
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
758 choices for ``the expression following point'' when point is at the
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
759 @samp{f}, so the expression commands must perforce choose one or the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
760 other to operate on. Note that @samp{(foo + bar)} is recognized as a
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
761 single expression in C mode, because of the parentheses.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
762
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
763 @node Moving by Parens
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
764 @subsection Moving in the Parenthesis Structure
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
765
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
766 @cindex parenthetical groupings
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
767 @cindex parentheses, moving across
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
768 @cindex matching parenthesis and braces, moving to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
769 @cindex braces, moving across
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
770 @cindex list commands
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
771 The Emacs commands for handling parenthetical groupings see nothing
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
772 except parentheses (or whatever characters must balance in the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
773 language you are working with), and the escape characters that might
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
774 be used to quote those. They are mainly intended for editing
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
775 programs, but can be useful for editing any text that has parentheses.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
776 They are sometimes called ``list'' commands because in Lisp these
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
777 groupings are lists.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
778
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
779 @table @kbd
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
780 @item C-M-n
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
781 Move forward over a parenthetical group (@code{forward-list}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
782 @item C-M-p
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
783 Move backward over a parenthetical group (@code{backward-list}).
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
784 @item C-M-u
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
785 Move up in parenthesis structure (@code{backward-up-list}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
786 @item C-M-d
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
787 Move down in parenthesis structure (@code{down-list}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
788 @end table
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
789
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
790 @kindex C-M-n
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
791 @kindex C-M-p
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
792 @findex forward-list
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
793 @findex backward-list
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
794 The ``list'' commands @kbd{C-M-n} (@code{forward-list}) and
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
795 @kbd{C-M-p} (@code{backward-list}) move over one (or @var{n})
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
796 parenthetical groupings, skipping blithely over any amount of text
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
797 that doesn't include meaningful parentheses (symbols, strings, etc.).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
798
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
799 @kindex C-M-u
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
800 @findex backward-up-list
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
801 @kbd{C-M-n} and @kbd{C-M-p} try to stay at the same level in the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
802 parenthesis structure. To move @emph{up} one (or @var{n}) levels, use
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
803 @kbd{C-M-u} (@code{backward-up-list}). @kbd{C-M-u} moves backward up
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
804 past one unmatched opening delimiter. A positive argument serves as a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
805 repeat count; a negative argument reverses the direction of motion, so
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
806 that the command moves forward and up one or more levels.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
807
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
808 @kindex C-M-d
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
809 @findex down-list
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
810 To move @emph{down} in the parenthesis structure, use @kbd{C-M-d}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
811 (@code{down-list}). In Lisp mode, where @samp{(} is the only opening
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
812 delimiter, this is nearly the same as searching for a @samp{(}. An
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
813 argument specifies the number of levels to go down.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
814
Dave Love <fx@gnu.org>
parents:
diff changeset
815 @node Matching
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
816 @subsection Automatic Display Of Matching Parentheses
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
817 @cindex matching parentheses
Dave Love <fx@gnu.org>
parents:
diff changeset
818 @cindex parentheses, displaying matches
Dave Love <fx@gnu.org>
parents:
diff changeset
819
Dave Love <fx@gnu.org>
parents:
diff changeset
820 The Emacs parenthesis-matching feature is designed to show
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
821 automatically how parentheses (and other matching delimiters) match in
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
822 the text. Whenever you type a self-inserting character that is a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
823 closing delimiter, the cursor moves momentarily to the location of the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
824 matching opening delimiter, provided that is on the screen. If it is
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
825 not on the screen, Emacs displays some of the text near it in the echo
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
826 area. Either way, you can tell which grouping you are closing off.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
827
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
828 If the opening delimiter and closing delimiter are mismatched---such
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
829 as in @samp{[x)}---a warning message is displayed in the echo area.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
830
Dave Love <fx@gnu.org>
parents:
diff changeset
831 @vindex blink-matching-paren
Dave Love <fx@gnu.org>
parents:
diff changeset
832 @vindex blink-matching-paren-distance
Dave Love <fx@gnu.org>
parents:
diff changeset
833 @vindex blink-matching-delay
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
834 Three variables control parenthesis match display:
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
835
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
836 @code{blink-matching-paren} turns the feature on or off: @code{nil}
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
837 disables it, but the default is @code{t} to enable match display.
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
838
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
839 @code{blink-matching-delay} says how many seconds to leave the
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
840 cursor on the matching opening delimiter, before bringing it back to
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
841 the real location of point; the default is 1, but on some systems it
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
842 is useful to specify a fraction of a second.
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
843
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
844 @code{blink-matching-paren-distance} specifies how many characters
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
845 back to search to find the matching opening delimiter. If the match
38287
d6fff7f22127 Minor change.
Richard M. Stallman <rms@gnu.org>
parents: 38238
diff changeset
846 is not found in that distance, scanning stops, and nothing is displayed.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
847 This is to prevent the scan for the matching delimiter from wasting
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
848 lots of time when there is no match. The default is 25600.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
849
Dave Love <fx@gnu.org>
parents:
diff changeset
850 @cindex Show Paren mode
34122
c42bb7d4437b Don't tell that show-paren only works on X. Explain how to customize
Eli Zaretskii <eliz@gnu.org>
parents: 31188
diff changeset
851 @cindex highlighting matching parentheses
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
852 @findex show-paren-mode
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
853 Show Paren mode provides a more powerful kind of automatic matching.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
854 Whenever point is after a closing delimiter, that delimiter and its
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
855 matching opening delimiter are both highlighted; otherwise, if point
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
856 is before an opening delimiter, the matching closing delimiter is
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
857 highlighted. (There is no need to highlight the opening delimiter in
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
858 that case, because the cursor appears on top of that character.) Use
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
859 the command @kbd{M-x show-paren-mode} to enable or disable this mode.
34122
c42bb7d4437b Don't tell that show-paren only works on X. Explain how to customize
Eli Zaretskii <eliz@gnu.org>
parents: 31188
diff changeset
860
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
861 Show Paren mode uses the faces @code{show-paren-match} and
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
862 @code{show-paren-mismatch} to highlight parentheses; you can customize
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
863 them to control how highlighting looks. @xref{Face Customization}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
864
Dave Love <fx@gnu.org>
parents:
diff changeset
865 @node Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
866 @section Manipulating Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
867 @cindex comments
Dave Love <fx@gnu.org>
parents:
diff changeset
868
Dave Love <fx@gnu.org>
parents:
diff changeset
869 Because comments are such an important part of programming, Emacs
47502
e8faddf96f0f Add ref for Flyspell Prog mode.
Richard M. Stallman <rms@gnu.org>
parents: 46035
diff changeset
870 provides special commands for editing and inserting comments. It can
e8faddf96f0f Add ref for Flyspell Prog mode.
Richard M. Stallman <rms@gnu.org>
parents: 46035
diff changeset
871 also do spell checking on comments with Flyspell Prog mode
e8faddf96f0f Add ref for Flyspell Prog mode.
Richard M. Stallman <rms@gnu.org>
parents: 46035
diff changeset
872 (@pxref{Spelling}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
873
Dave Love <fx@gnu.org>
parents:
diff changeset
874 @menu
69840
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
875 * Comment Commands:: Inserting, killing, and aligning comments.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
876 * Multi-Line Comments:: Commands for adding and editing multi-line comments.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
877 * Options for Comments::Customizing the comment features.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
878 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
879
Dave Love <fx@gnu.org>
parents:
diff changeset
880 @node Comment Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
881 @subsection Comment Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
882 @cindex indentation for comments
69840
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
883 @cindex alignment for comments
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
884
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
885 The comment commands in this table insert, kill and align comments.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
886 They are described in this section and following sections.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
887
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
888 @table @asis
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
889 @item @kbd{M-;}
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
890 Insert or realign comment on current line; alternatively, comment or
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
891 uncomment the region (@code{comment-dwim}).
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
892 @item @kbd{C-u M-;}
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
893 Kill comment on current line (@code{comment-kill}).
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
894 @item @kbd{C-x ;}
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
895 Set comment column (@code{comment-set-column}).
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
896 @item @kbd{C-M-j}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
897 @itemx @kbd{M-j}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
898 Like @key{RET} followed by inserting and aligning a comment
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
899 (@code{comment-indent-new-line}). @xref{Multi-Line Comments}.
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
900 @item @kbd{M-x comment-region}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
901 @itemx @kbd{C-c C-c} (in C-like modes)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
902 Add or remove comment delimiters on all the lines in the region.
Dave Love <fx@gnu.org>
parents:
diff changeset
903 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
904
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
905 @kindex M-;
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
906 @findex comment-dwim
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
907 The command to create or align a comment is @kbd{M-;}
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
908 (@code{comment-dwim}). The word ``dwim'' is an acronym for ``Do What
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
909 I Mean''; it indicates that this command can be used for many
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
910 different jobs relating to comments, depending on the situation where
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
911 you use it.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
912
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
913 If there is no comment already on the line, @kbd{M-;} inserts a new
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
914 comment, aligned at a specific column called the @dfn{comment column}.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
915 The new comment begins with the string Emacs thinks comments should
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
916 start with (the value of @code{comment-start}; see below). Point is
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
917 after that string, so you can insert the text of the comment right
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
918 away. If the major mode has specified a string to terminate comments,
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
919 @kbd{M-;} inserts that after point, to keep the syntax valid.
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
920
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
921 If the text of the line extends past the comment column, this
69840
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
922 command aligns the comment start string to a suitable boundary
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
923 (usually, at least one space is inserted).
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
924
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
925 You can also use @kbd{M-;} to align an existing comment. If a line
69840
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
926 already contains the comment-start string, @kbd{M-;} realigns it to
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
927 the conventional alignment and moves point after it. (Exception:
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
928 comments starting in column 0 are not moved.) Even when an existing
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
929 comment is properly aligned, @kbd{M-;} is still useful for moving
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
930 directly to the start of the text inside the comment.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
931
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
932 @findex comment-kill
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
933 @kindex C-u M-;
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
934 @kbd{C-u M-;} kills any comment on the current line, along with the
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
935 whitespace before it. To reinsert the comment on another line, move
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
936 to the end of that line, do @kbd{C-y}, and then do @kbd{M-;} to
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
937 realign it.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
938
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
939 Note that @kbd{C-u M-;} is not a distinct key; it is @kbd{M-;}
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
940 (@code{comment-dwim}) with a prefix argument. That command is
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
941 programmed so that when it receives a prefix argument it calls
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
942 @code{comment-kill}. However, @code{comment-kill} is a valid command
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
943 in its own right, and you can bind it directly to a key if you wish.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
944
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
945 @kbd{M-;} does two other jobs when used with an active region in
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
946 Transient Mark mode (@pxref{Transient Mark}). Then it either adds or
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
947 removes comment delimiters on each line of the region. (If every line
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
948 is a comment, it removes comment delimiters from each; otherwise, it
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
949 adds comment delimiters to each.) If you are not using Transient Mark
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
950 mode, then you should use the commands @code{comment-region} and
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
951 @code{uncomment-region} to do these jobs (@pxref{Multi-Line Comments}),
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
952 or else enable Transient Mark mode momentarily (@pxref{Momentary Mark}).
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
953 A prefix argument used in these circumstances specifies how many
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
954 comment delimiters to add or how many to delete.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
955
69840
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
956 Some major modes have special rules for aligning certain kinds of
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
957 comments in certain contexts. For example, in Lisp code, comments which
Dave Love <fx@gnu.org>
parents:
diff changeset
958 start with two semicolons are indented as if they were lines of code,
Dave Love <fx@gnu.org>
parents:
diff changeset
959 instead of at the comment column. Comments which start with three
71668
a745634e8067 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 71612
diff changeset
960 semicolons are supposed to start at the left margin and are often used
a745634e8067 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 71612
diff changeset
961 for sectioning purposes. Emacs understands
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
962 these conventions by indenting a double-semicolon comment using @key{TAB},
Dave Love <fx@gnu.org>
parents:
diff changeset
963 and by not changing the indentation of a triple-semicolon comment at all.
Dave Love <fx@gnu.org>
parents:
diff changeset
964
Dave Love <fx@gnu.org>
parents:
diff changeset
965 @example
71612
77266daa9ec9 Use ;; instead of ;;; to better follow coding conventions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 71593
diff changeset
966 ;; This function is just an example.
71668
a745634e8067 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 71612
diff changeset
967 ;;; Here either two or three semicolons are appropriate.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
968 (defun foo (x)
71612
77266daa9ec9 Use ;; instead of ;;; to better follow coding conventions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 71593
diff changeset
969 ;;; And now, the first part of the function:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
970 ;; The following line adds one.
Dave Love <fx@gnu.org>
parents:
diff changeset
971 (1+ x)) ; This line adds one.
Dave Love <fx@gnu.org>
parents:
diff changeset
972 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
973
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
974 For C-like modes, you can configure the exact effect of @kbd{M-;}
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
975 more flexibly than for most buffers by setting the variables
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
976 @code{c-indent-comment-alist} and
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
977 @code{c-indent-comments-syntactically-p}. For example, on a line
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
978 ending in a closing brace, @kbd{M-;} puts the comment one space after
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
979 the brace rather than at @code{comment-column}. For full details see
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
980 @ref{Comment Commands,,, ccmode, The CC Mode Manual}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
981
Dave Love <fx@gnu.org>
parents:
diff changeset
982 @node Multi-Line Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
983 @subsection Multiple Lines of Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
984
Dave Love <fx@gnu.org>
parents:
diff changeset
985 @kindex C-M-j
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
986 @kindex M-j
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
987 @cindex blank lines in programs
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
988 @findex comment-indent-new-line
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
989
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
990 If you are typing a comment and wish to continue it on another line,
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
991 you can use the command @kbd{C-M-j} or @kbd{M-j}
67683
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
992 (@code{comment-indent-new-line}). If @code{comment-multi-line}
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
993 (@pxref{Options for Comments}) is non-@code{nil}, it moves to a new
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
994 line within the comment. Otherwise it closes the comment and starts a
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
995 new comment on a new line. When Auto Fill mode is on, going past the
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
996 fill column while typing a comment causes the comment to be continued
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
997 in just this fashion.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
998
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
999 @kindex C-c C-c (C mode)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1000 @findex comment-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1001 To turn existing lines into comment lines, use the @kbd{M-x
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1002 comment-region} command (or type @kbd{C-c C-c} in C-like modes). It
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1003 adds comment delimiters to the lines that start in the region, thus
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1004 commenting them out. With a negative argument, it does the
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1005 opposite---it deletes comment delimiters from the lines in the region.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1006
Dave Love <fx@gnu.org>
parents:
diff changeset
1007 With a positive argument, @code{comment-region} duplicates the last
69840
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
1008 character of the comment start sequence it adds; the argument
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
1009 specifies how many copies of the character to insert. Thus, in Lisp
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
1010 mode, @kbd{C-u 2 M-x comment-region} adds @samp{;;} to each line.
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
1011 Duplicating the comment delimiter is a way of calling attention to the
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
1012 comment. It can also affect how the comment is aligned or indented.
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
1013 In Lisp, for proper indentation, you should use an argument of two or
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
1014 three, if between defuns; if within a defun, it must be three.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1015
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1016 You can configure C Mode such that when you type a @samp{/} at the
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1017 start of a line in a multi-line block comment, this closes the
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1018 comment. Enable the @code{comment-close-slash} clean-up for this.
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1019 @xref{Clean-ups,,, ccmode, The CC Mode Manual}.
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1020
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1021 @node Options for Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
1022 @subsection Options Controlling Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
1023
Dave Love <fx@gnu.org>
parents:
diff changeset
1024 @vindex comment-column
Dave Love <fx@gnu.org>
parents:
diff changeset
1025 @kindex C-x ;
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
1026 @findex comment-set-column
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1027 The @dfn{comment column}, the column at which Emacs tries to place
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1028 comments, is stored in the variable @code{comment-column}. You can
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1029 set it to a number explicitly. Alternatively, the command @kbd{C-x ;}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1030 (@code{comment-set-column}) sets the comment column to the column
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1031 point is at. @kbd{C-u C-x ;} sets the comment column to match the
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1032 last comment before point in the buffer, and then does a @kbd{M-;} to
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1033 align the current line's comment under the previous one.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1034
Dave Love <fx@gnu.org>
parents:
diff changeset
1035 The variable @code{comment-column} is per-buffer: setting the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1036 in the normal fashion affects only the current buffer, but there is a
Dave Love <fx@gnu.org>
parents:
diff changeset
1037 default value which you can change with @code{setq-default}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1038 @xref{Locals}. Many major modes initialize this variable for the
Dave Love <fx@gnu.org>
parents:
diff changeset
1039 current buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1040
Dave Love <fx@gnu.org>
parents:
diff changeset
1041 @vindex comment-start-skip
Dave Love <fx@gnu.org>
parents:
diff changeset
1042 The comment commands recognize comments based on the regular
Dave Love <fx@gnu.org>
parents:
diff changeset
1043 expression that is the value of the variable @code{comment-start-skip}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1044 Make sure this regexp does not match the null string. It may match more
Dave Love <fx@gnu.org>
parents:
diff changeset
1045 than the comment starting delimiter in the strictest sense of the word;
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
1046 for example, in C mode the value of the variable is
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
1047 @c This stops M-q from breaking the line inside that @code.
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1048 @code{@w{"/\\*+ *\\|//+ *"}}, which matches extra stars and spaces
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
1049 after the @samp{/*} itself, and accepts C++ style comments also.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 (Note that @samp{\\} is needed in Lisp syntax to include a @samp{\} in
Dave Love <fx@gnu.org>
parents:
diff changeset
1051 the string, which is needed to deny the first star its special meaning
64920
e736a91dd7b5 (Options for Comments): Fix xref.
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
1052 in regexp syntax. @xref{Regexp Backslash}.)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1053
Dave Love <fx@gnu.org>
parents:
diff changeset
1054 @vindex comment-start
Dave Love <fx@gnu.org>
parents:
diff changeset
1055 @vindex comment-end
Dave Love <fx@gnu.org>
parents:
diff changeset
1056 When a comment command makes a new comment, it inserts the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
1057 @code{comment-start} to begin it. The value of @code{comment-end} is
67513
375a247b599e (Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents: 64920
diff changeset
1058 inserted after point, so that it will follow the text that you will
375a247b599e (Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents: 64920
diff changeset
1059 insert into the comment. When @code{comment-end} is non-empty, it
375a247b599e (Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents: 64920
diff changeset
1060 should start with a space. For example, in C mode,
375a247b599e (Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents: 64920
diff changeset
1061 @code{comment-start} has the value @w{@code{"/* "}} and
375a247b599e (Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents: 64920
diff changeset
1062 @code{comment-end} has the value @w{@code{" */"}}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1063
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1064 @vindex comment-padding
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1065 The variable @code{comment-padding} specifies how many spaces
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1066 @code{comment-region} should insert on each line between the comment
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1067 delimiter and the line's original text. The default is 1, to insert
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1068 one space. @code{nil} means 0. Alternatively, @code{comment-padding}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1069 can hold the actual string to insert.
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1070
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1071 @vindex comment-multi-line
Dave Love <fx@gnu.org>
parents:
diff changeset
1072 The variable @code{comment-multi-line} controls how @kbd{C-M-j}
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1073 (@code{indent-new-comment-line}) behaves when used inside a comment.
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1074 Specifically, when @code{comment-multi-line} is @code{nil}, the
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1075 command inserts a comment terminator, begins a new line, and finally
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1076 inserts a comment starter. Otherwise it does not insert the
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1077 terminator and starter, so it effectively continues the current
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1078 comment across multiple lines. In languages that allow multi-line
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1079 comments, the choice of value for this variable is a matter of taste.
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1080 The default for this variable depends on the major mode.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1081
41495
0bac781ea0d6 Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 41472
diff changeset
1082 @vindex comment-indent-function
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1083 The variable @code{comment-indent-function} should contain a function
69840
d138b536fbe5 (Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents: 69833
diff changeset
1084 that will be called to compute the alignment for a newly inserted
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1085 comment or for aligning an existing comment. It is set differently by
Dave Love <fx@gnu.org>
parents:
diff changeset
1086 various major modes. The function is called with no arguments, but with
Dave Love <fx@gnu.org>
parents:
diff changeset
1087 point at the beginning of the comment, or at the end of a line if a new
Dave Love <fx@gnu.org>
parents:
diff changeset
1088 comment is to be inserted. It should return the column in which the
Dave Love <fx@gnu.org>
parents:
diff changeset
1089 comment ought to start. For example, in Lisp mode, the indent hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1090 function bases its decision on how many semicolons begin an existing
Dave Love <fx@gnu.org>
parents:
diff changeset
1091 comment, and on the code in the preceding lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
1092
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1093 @node Documentation
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1094 @section Documentation Lookup
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1095
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1096 Emacs provides several features you can use to look up the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1097 documentation of functions, variables and commands that you plan to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1098 use in your program.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1099
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1100 @menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1101 * Info Lookup:: Looking up library functions and commands
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1102 in Info files.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1103 * Man Page:: Looking up man pages of library functions and commands.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1104 * Lisp Doc:: Looking up Emacs Lisp functions, etc.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1105 @end menu
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1106
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1107 @node Info Lookup
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1108 @subsection Info Documentation Lookup
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1109
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1110 @findex info-lookup-symbol
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1111 @findex info-lookup-file
56164
f5e9166d3954 (Info Lookup): Fix keybinding for
Jesper Harder <harder@ifa.au.dk>
parents: 56086
diff changeset
1112 @kindex C-h S
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1113 For many major modes, that apply to languages that have
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1114 documentation in Info, you can use @kbd{C-h S}
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1115 (@code{info-lookup-symbol}) to view the Info documentation for a
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1116 symbol used in the program. You specify the symbol with the
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1117 minibuffer; the default is the symbol appearing in the buffer at
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1118 point. For example, in C mode this looks for the symbol in the C
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1119 Library Manual. The command only works if the appropriate manual's
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1120 Info files are installed.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1121
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1122 The major mode determines where to look for documentation for the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1123 symbol---which Info files to look in, and which indices to search.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1124 You can also use @kbd{M-x info-lookup-file} to look for documentation
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1125 for a file name.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1126
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1127 If you use @kbd{C-h S} in a major mode that does not support it,
72101
c7e4f78b81a6 Move periods and commas inside quotes.
Richard M. Stallman <rms@gnu.org>
parents: 71668
diff changeset
1128 it asks you to specify the ``symbol help mode.'' You should enter
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1129 a command such as @code{c-mode} that would select a major
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1130 mode which @kbd{C-h S} does support.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1131
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1132 @node Man Page
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1133 @subsection Man Page Lookup
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1134
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1135 @cindex manual page
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1136 On Unix, the main form of on-line documentation was the @dfn{manual
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1137 page} or @dfn{man page}. In the GNU operating system, we aim to
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1138 replace man pages with better-organized manuals that you can browse
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1139 with Info (@pxref{Misc Help}). This process is not finished, so it is
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1140 still useful to read manual pages.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1141
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1142 @findex manual-entry
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1143 You can read the man page for an operating system command, library
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1144 function, or system call, with the @kbd{M-x man} command. It
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1145 runs the @code{man} program to format the man page; if the system
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1146 permits, it runs @code{man} asynchronously, so that you can keep on
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1147 editing while the page is being formatted. (On MS-DOS and MS-Windows
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1148 3, you cannot edit while Emacs waits for @code{man} to finish.) The
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1149 result goes in a buffer named @samp{*Man @var{topic}*}. These buffers
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1150 use a special major mode, Man mode, that facilitates scrolling and
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1151 jumping to other manual pages. For details, type @kbd{C-h m} while in
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1152 a man page buffer.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1153
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1154 @cindex sections of manual pages
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1155 Each man page belongs to one of ten or more @dfn{sections}, each
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1156 named by a digit or by a digit and a letter. Sometimes there are
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1157 multiple man pages with the same name in different sections. To read
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1158 a man page from a specific section, type
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1159 @samp{@var{topic}(@var{section})} or @samp{@var{section} @var{topic}}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1160 when @kbd{M-x manual-entry} prompts for the topic. For example, to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1161 read the man page for the C library function @code{chmod} (as opposed
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1162 to a command of the same name), type @kbd{M-x manual-entry @key{RET}
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1163 chmod(2) @key{RET}}. (@code{chmod} is a system call, so it is in
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1164 section @samp{2}.)
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1165
38667
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1166 @vindex Man-switches
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1167 If you do not specify a section, the results depend on how the
38667
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1168 @code{man} program works on your system. Some of them display only
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1169 the first man page they find. Others display all man pages that have
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1170 the specified name, so you can move between them with the @kbd{M-n}
38667
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1171 and @kbd{M-p} keys@footnote{On some systems, the @code{man} program
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1172 accepts a @samp{-a} command-line option which tells it to display all
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1173 the man pages for the specified topic. If you want this behavior, you
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1174 can add this option to the value of the variable @code{Man-switches}.}.
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1175 The mode line shows how many manual pages are present in the Man buffer.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1176
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1177 @vindex Man-fontify-manpage-flag
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1178 By default, Emacs highlights the text in man pages. For a long man
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1179 page, highlighting can take substantial time. You can turn off
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1180 highlighting of man pages by setting the variable
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1181 @code{Man-fontify-manpage-flag} to @code{nil}.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1182
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1183 @findex Man-fontify-manpage
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1184 If you insert the text of a man page into an Emacs buffer in some
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1185 other fashion, you can use the command @kbd{M-x Man-fontify-manpage} to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1186 perform the same conversions that @kbd{M-x manual-entry} does.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1187
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1188 @findex woman
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1189 @cindex manual pages, on MS-DOS/MS-Windows
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1190 An alternative way of reading manual pages is the @kbd{M-x woman}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1191 command@footnote{The name of the command, @code{woman}, is an acronym
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1192 for ``w/o (without) man,'' since it doesn't use the @code{man}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1193 program.}. Unlike @kbd{M-x man}, it does not run any external
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1194 programs to format and display the man pages; instead it does the job
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1195 in Emacs Lisp, so it works on systems such as MS-Windows, where the
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
1196 @code{man} program (and other programs it uses) are not generally
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1197 available.
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1198
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1199 @kbd{M-x woman} prompts for a name of a manual page, and provides
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1200 completion based on the list of manual pages that are installed on
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1201 your machine; the list of available manual pages is computed
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1202 automatically the first time you invoke @code{woman}. The word at
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1203 point in the current buffer is used to suggest the default for the
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1204 name the manual page.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1205
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1206 With a numeric argument, @kbd{M-x woman} recomputes the list of the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1207 manual pages used for completion. This is useful if you add or delete
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1208 manual pages.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1209
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1210 If you type a name of a manual page and @kbd{M-x woman} finds that
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1211 several manual pages by the same name exist in different sections, it
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1212 pops up a window with possible candidates asking you to choose one of
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1213 them.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1214
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1215 For more information about setting up and using @kbd{M-x woman}, see
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1216 @ref{Top, WoMan, Browse UN*X Manual Pages WithOut Man, woman, The WoMan
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1217 Manual}.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1218
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1219 @node Lisp Doc
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1220 @subsection Emacs Lisp Documentation Lookup
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1221
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1222 As you edit Lisp code to be run in Emacs, you can use the commands
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1223 @kbd{C-h f} (@code{describe-function}) and @kbd{C-h v}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1224 (@code{describe-variable}) to view documentation of functions and
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1225 variables that you want to use. These commands use the minibuffer to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1226 read the name of a function or variable to document, and display the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1227 documentation in a window. Their default arguments are based on the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1228 code in the neighborhood of point. For @kbd{C-h f}, the default is
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1229 the function called in the innermost list containing point. @kbd{C-h
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1230 v} uses the symbol name around or adjacent to point as its default.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1231
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1232 @cindex Eldoc mode
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1233 @findex eldoc-mode
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1234 A more automatic but less powerful method is Eldoc mode. This minor
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1235 mode constantly displays in the echo area the argument list for the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1236 function being called at point. (In other words, it finds the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1237 function call that point is contained in, and displays the argument
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
1238 list of that function.) If point is over a documented variable, it
62482
8db373573379 (Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61133
diff changeset
1239 shows the first line of the variable's docstring. Eldoc mode applies
8db373573379 (Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61133
diff changeset
1240 in Emacs Lisp and Lisp Interaction modes, and perhaps a few others
8db373573379 (Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61133
diff changeset
1241 that provide special support for looking up doc strings. Use the
8db373573379 (Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61133
diff changeset
1242 command @kbd{M-x eldoc-mode} to enable or disable this feature.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1243
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1244 @node Hideshow
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1245 @section Hideshow minor mode
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1246
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1247 @findex hs-minor-mode
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1248 Hideshow minor mode provides selective display of portions of a
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1249 program, known as @dfn{blocks}. You can use @kbd{M-x hs-minor-mode}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1250 to enable or disable this mode, or add @code{hs-minor-mode} to the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1251 mode hook for certain major modes in order to enable it automatically
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1252 for those modes.
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1253
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1254 Just what constitutes a block depends on the major mode. In C mode
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1255 or C++ mode, they are delimited by braces, while in Lisp mode and
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1256 similar modes they are delimited by parentheses. Multi-line comments
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1257 also count as blocks.
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1258
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1259 @findex hs-hide-all
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1260 @findex hs-hide-block
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1261 @findex hs-show-all
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1262 @findex hs-show-block
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1263 @findex hs-show-region
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1264 @findex hs-hide-level
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1265 @findex hs-minor-mode
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1266 @kindex C-c @@ C-h
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1267 @kindex C-c @@ C-s
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1268 @kindex C-c @@ C-M-h
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1269 @kindex C-c @@ C-M-s
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1270 @kindex C-c @@ C-r
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1271 @kindex C-c @@ C-l
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1272 @kindex S-Mouse-2
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1273 @table @kbd
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1274 @item C-c @@ C-h
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1275 Hide the current block (@code{hs-hide-block}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1276 @item C-c @@ C-s
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1277 Show the current block (@code{hs-show-block}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1278 @item C-c @@ C-c
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
1279 Either hide or show the current block (@code{hs-toggle-hiding}).
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1280 @item S-Mouse-2
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
1281 Either hide or show the block you click on (@code{hs-mouse-toggle-hiding}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1282 @item C-c @@ C-M-h
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1283 Hide all top-level blocks (@code{hs-hide-all}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1284 @item C-c @@ C-M-s
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1285 Show everything in the buffer (@code{hs-show-all}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1286 @item C-c @@ C-l
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1287 Hide all blocks @var{n} levels below this block
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1288 (@code{hs-hide-level}).
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1289 @end table
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1290
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1291 @vindex hs-hide-comments-when-hiding-all
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1292 @vindex hs-isearch-open
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1293 @vindex hs-special-modes-alist
59798
0816b427495a Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents: 59475
diff changeset
1294 These variables exist for customizing Hideshow mode.
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1295
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1296 @table @code
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1297 @item hs-hide-comments-when-hiding-all
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1298 Non-@code{nil} says that @kbd{hs-hide-all} should hide comments too.
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1299
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1300 @item hs-isearch-open
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1301 Specifies what kind of hidden blocks incremental search should make
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1302 visible. The value should be one of these four symbols:
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1303
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1304 @table @code
38946
9a1045bcf43c Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents: 38871
diff changeset
1305 @item code
9a1045bcf43c Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents: 38871
diff changeset
1306 Open only code blocks.
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1307 @item comment
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1308 Open only comments.
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1309 @item t
38946
9a1045bcf43c Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents: 38871
diff changeset
1310 Open both code blocks and comments.
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1311 @item nil
38946
9a1045bcf43c Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents: 38871
diff changeset
1312 Open neither code blocks nor comments.
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1313 @end table
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1314
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1315 @item hs-special-modes-alist
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1316 A list of elements, each specifying how to initialize Hideshow
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1317 variables for one major mode. See the variable's documentation string
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1318 for more information.
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1319 @end table
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1320
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1321 @node Symbol Completion
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1322 @section Completion for Symbol Names
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1323 @cindex completion (symbol names)
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1324
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1325 In Emacs, completion is something you normally do in the minibuffer.
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1326 But one kind of completion is available in all buffers: completion for
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1327 symbol names.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1328
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1329 @kindex M-TAB
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1330 The character @kbd{M-@key{TAB}} runs a command to complete the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1331 partial symbol before point against the set of meaningful symbol
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1332 names. This command inserts at point any additional characters that
75053
8dc8ba72712c (Symbol Completion): Recommend customizing window manager.
Richard M. Stallman <rms@gnu.org>
parents: 74697
diff changeset
1333 it can determine from the partial name.
8dc8ba72712c (Symbol Completion): Recommend customizing window manager.
Richard M. Stallman <rms@gnu.org>
parents: 74697
diff changeset
1334
8dc8ba72712c (Symbol Completion): Recommend customizing window manager.
Richard M. Stallman <rms@gnu.org>
parents: 74697
diff changeset
1335 If your window manager defines @kbd{M-@key{TAB}} to switch windows,
8dc8ba72712c (Symbol Completion): Recommend customizing window manager.
Richard M. Stallman <rms@gnu.org>
parents: 74697
diff changeset
1336 you can type @kbd{@key{ESC} @key{TAB}} or @kbd{C-M-i} instead.
8dc8ba72712c (Symbol Completion): Recommend customizing window manager.
Richard M. Stallman <rms@gnu.org>
parents: 74697
diff changeset
1337 However, most window managers let you customize these shortcuts, and
8dc8ba72712c (Symbol Completion): Recommend customizing window manager.
Richard M. Stallman <rms@gnu.org>
parents: 74697
diff changeset
1338 we recommend that you change any that get in the way of use of Emacs.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1339
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1340 If the partial name in the buffer has multiple possible completions
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1341 that differ in the very next character, so that it is impossible to
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1342 complete even one more character, @kbd{M-@key{TAB}} displays a list of
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1343 all possible completions in another window.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1344
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1345 @cindex tags-based completion
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1346 @cindex Info index completion
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1347 @findex complete-symbol
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1348 In most programming language major modes, @kbd{M-@key{TAB}} runs the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1349 command @code{complete-symbol}, which provides two kinds of completion.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1350 Normally it does completion based on a tags table (@pxref{Tags}); with a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1351 numeric argument (regardless of the value), it does completion based on
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1352 the names listed in the Info file indexes for your language. Thus, to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1353 complete the name of a symbol defined in your own program, use
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1354 @kbd{M-@key{TAB}} with no argument; to complete the name of a standard
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1355 library function, use @kbd{C-u M-@key{TAB}}. Of course, Info-based
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1356 completion works only if there is an Info file for the standard library
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1357 functions of your language, and only if it is installed at your site.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1358
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1359 @cindex Lisp symbol completion
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1360 @cindex completion (Lisp symbols)
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1361 @findex lisp-complete-symbol
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1362 In Emacs-Lisp mode, the name space for completion normally consists of
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1363 nontrivial symbols present in Emacs---those that have function
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1364 definitions, values or properties. However, if there is an
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1365 open-parenthesis immediately before the beginning of the partial symbol,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1366 only symbols with function definitions are considered as completions.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1367 The command which implements this is @code{lisp-complete-symbol}.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1368
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1369 In Text mode and related modes, @kbd{M-@key{TAB}} completes words
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1370 based on the spell-checker's dictionary. @xref{Spelling}.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1371
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1372 @node Glasses
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1373 @section Glasses minor mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1374 @cindex Glasses mode
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1375 @cindex identifiers, making long ones readable
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1376 @cindex StudlyCaps, making them readable
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1377 @findex glasses-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1378
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1379 Glasses minor mode makes @samp{unreadableIdentifiersLikeThis}
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1380 readable by altering the way they display. It knows two different
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1381 ways to do this: by displaying underscores between a lower-case letter
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1382 and the following capital letter, and by emboldening the capital
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1383 letters. It does not alter the buffer text, only the way they
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1384 display, so you can use it even on read-only buffers. You can use the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1385 command @kbd{M-x glasses-mode} to enable or disable the mode in the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1386 current buffer; you can also add @code{glasses-mode} to the mode hook
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1387 of the programming language major modes in which you normally want
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48700
diff changeset
1388 to use Glasses mode.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1389
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1390 @node Misc for Programs
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1391 @section Other Features Useful for Editing Programs
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1392
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1393 A number of Emacs commands that aren't designed specifically for
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1394 editing programs are useful for that nonetheless.
26292
81cd0c225dd9 Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents: 26289
diff changeset
1395
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1396 The Emacs commands that operate on words, sentences and paragraphs
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1397 are useful for editing code. Most symbols names contain words
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1398 (@pxref{Words}); sentences can be found in strings and comments
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1399 (@pxref{Sentences}). Paragraphs in the strict sense can be found in
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1400 program code (in long comments), but the paragraph commands are useful
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1401 in other places too, because programming language major modes define
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1402 paragraphs to begin and end at blank lines (@pxref{Paragraphs}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1403 Judicious use of blank lines to make the program clearer will also
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1404 provide useful chunks of text for the paragraph commands to work on.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1405 Auto Fill mode, if enabled in a programming language major mode,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1406 indents the new lines which it creates.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1407
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1408 The selective display feature is useful for looking at the overall
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1409 structure of a function (@pxref{Selective Display}). This feature
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1410 hides the lines that are indented more than a specified amount.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1411 Programming modes often support Outline minor mode (@pxref{Outline
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1412 Mode}). The Foldout package provides folding-editor features
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1413 (@pxref{Foldout}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1414
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1415 The ``automatic typing'' features may be useful for writing programs.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1416 @xref{Top,,Autotyping, autotype, Autotyping}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1417
Dave Love <fx@gnu.org>
parents:
diff changeset
1418 @node C Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 @section C and Related Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 @cindex C mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 @cindex Java mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 @cindex Pike mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1423 @cindex IDL mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1424 @cindex CORBA IDL mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1425 @cindex Objective C mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1426 @cindex C++ mode
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1427 @cindex AWK mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1428 @cindex mode, Java
Dave Love <fx@gnu.org>
parents:
diff changeset
1429 @cindex mode, C
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1430 @cindex mode, C++
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1431 @cindex mode, Objective C
Dave Love <fx@gnu.org>
parents:
diff changeset
1432 @cindex mode, CORBA IDL
Dave Love <fx@gnu.org>
parents:
diff changeset
1433 @cindex mode, Pike
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1434 @cindex mode, AWK
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1435
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1436 This section gives a brief description of the special features
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1437 available in C, C++, Objective-C, Java, CORBA IDL, Pike and AWK modes.
53386
8bacf8f6aa0c (C Modes): Fix the xref.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 52401
diff changeset
1438 (These are called ``C mode and related modes.'') @xref{Top, , CC Mode,
8bacf8f6aa0c (C Modes): Fix the xref.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 52401
diff changeset
1439 ccmode, CC Mode}, for a more extensive description of these modes
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1440 and their special features.
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1441
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1442 @menu
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1443 * Motion in C:: Commands to move by C statements, etc.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1444 * Electric C:: Colon and other chars can automatically reindent.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1445 * Hungry Delete:: A more powerful DEL command.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1446 * Other C Commands:: Filling comments, viewing expansion of macros,
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1447 and other neat features.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1448 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1449
Dave Love <fx@gnu.org>
parents:
diff changeset
1450 @node Motion in C
Dave Love <fx@gnu.org>
parents:
diff changeset
1451 @subsection C Mode Motion Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1452
Dave Love <fx@gnu.org>
parents:
diff changeset
1453 This section describes commands for moving point, in C mode and
Dave Love <fx@gnu.org>
parents:
diff changeset
1454 related modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
1455
Dave Love <fx@gnu.org>
parents:
diff changeset
1456 @table @code
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1457 @item M-x c-beginning-of-defun
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1458 @itemx M-x c-end-of-defun
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1459 @findex c-beginning-of-defun
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1460 @findex c-end-of-defun
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1461 Move point to the beginning or end of the current function or
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1462 top-level definition. These are found by searching for the least
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1463 enclosing braces. (By contrast, @code{beginning-of-defun} and
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1464 @code{end-of-defun} search for braces in column zero.) If you are
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1465 editing code where the opening brace of a function isn't placed in
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1466 column zero, you may wish to bind @code{C-M-a} and @code{C-M-e} to
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1467 these commands. @xref{Moving by Defuns}.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1468
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1469 @item C-c C-u
Dave Love <fx@gnu.org>
parents:
diff changeset
1470 @kindex C-c C-u @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1471 @findex c-up-conditional
Dave Love <fx@gnu.org>
parents:
diff changeset
1472 Move point back to the containing preprocessor conditional, leaving the
Dave Love <fx@gnu.org>
parents:
diff changeset
1473 mark behind. A prefix argument acts as a repeat count. With a negative
Dave Love <fx@gnu.org>
parents:
diff changeset
1474 argument, move point forward to the end of the containing
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1475 preprocessor conditional.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1476
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1477 @samp{#elif} is equivalent to @samp{#else} followed by @samp{#if}, so
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1478 the function will stop at a @samp{#elif} when going backward, but not
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1479 when going forward.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1480
Dave Love <fx@gnu.org>
parents:
diff changeset
1481 @item C-c C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
1482 @kindex C-c C-p @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1483 @findex c-backward-conditional
Dave Love <fx@gnu.org>
parents:
diff changeset
1484 Move point back over a preprocessor conditional, leaving the mark
Dave Love <fx@gnu.org>
parents:
diff changeset
1485 behind. A prefix argument acts as a repeat count. With a negative
Dave Love <fx@gnu.org>
parents:
diff changeset
1486 argument, move forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
1487
Dave Love <fx@gnu.org>
parents:
diff changeset
1488 @item C-c C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
1489 @kindex C-c C-n @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1490 @findex c-forward-conditional
Dave Love <fx@gnu.org>
parents:
diff changeset
1491 Move point forward across a preprocessor conditional, leaving the mark
Dave Love <fx@gnu.org>
parents:
diff changeset
1492 behind. A prefix argument acts as a repeat count. With a negative
Dave Love <fx@gnu.org>
parents:
diff changeset
1493 argument, move backward.
Dave Love <fx@gnu.org>
parents:
diff changeset
1494
Dave Love <fx@gnu.org>
parents:
diff changeset
1495 @item M-a
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1496 @kindex M-a (C mode)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1497 @findex c-beginning-of-statement
Dave Love <fx@gnu.org>
parents:
diff changeset
1498 Move point to the beginning of the innermost C statement
Dave Love <fx@gnu.org>
parents:
diff changeset
1499 (@code{c-beginning-of-statement}). If point is already at the beginning
Dave Love <fx@gnu.org>
parents:
diff changeset
1500 of a statement, move to the beginning of the preceding statement. With
Dave Love <fx@gnu.org>
parents:
diff changeset
1501 prefix argument @var{n}, move back @var{n} @minus{} 1 statements.
Dave Love <fx@gnu.org>
parents:
diff changeset
1502
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1503 In comments or in strings which span more than one line, this command
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1504 moves by sentences instead of statements.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1505
Dave Love <fx@gnu.org>
parents:
diff changeset
1506 @item M-e
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1507 @kindex M-e (C mode)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1508 @findex c-end-of-statement
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1509 Move point to the end of the innermost C statement or sentence; like
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1510 @kbd{M-a} except that it moves in the other direction
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1511 (@code{c-end-of-statement}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1512 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1513
Dave Love <fx@gnu.org>
parents:
diff changeset
1514 @node Electric C
Dave Love <fx@gnu.org>
parents:
diff changeset
1515 @subsection Electric C Characters
Dave Love <fx@gnu.org>
parents:
diff changeset
1516
Dave Love <fx@gnu.org>
parents:
diff changeset
1517 In C mode and related modes, certain printing characters are
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1518 @dfn{electric}---in addition to inserting themselves, they also
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1519 reindent the current line, and optionally also insert newlines. The
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1520 ``electric'' characters are @kbd{@{}, @kbd{@}}, @kbd{:}, @kbd{#},
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1521 @kbd{;}, @kbd{,}, @kbd{<}, @kbd{>}, @kbd{/}, @kbd{*}, @kbd{(}, and
67683
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
1522 @kbd{)}.
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1523
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1524 You might find electric indentation inconvenient if you are editing
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1525 chaotically indented code. If you are new to CC Mode, you might find
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1526 it disconcerting. You can toggle electric action with the command
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1527 @kbd{C-c C-l}; when it is enabled, @samp{/l} appears in the mode line
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1528 after the mode name:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1529
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1530 @table @kbd
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1531 @item C-c C-l
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1532 @kindex C-c C-l @r{(C mode)}
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1533 @findex c-toggle-electric-state
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1534 Toggle electric action (@code{c-toggle-electric-state}). With a
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1535 prefix argument, this command enables electric action if the argument
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1536 is positive, disables it if it is negative.
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1537 @end table
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1538
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1539 Electric characters insert newlines only when, in addition to the
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1540 electric state, the @dfn{auto-newline} feature is enabled (indicated
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1541 by @samp{/la} in the mode line after the mode name). You can turn
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1542 this feature on or off with the command @kbd{C-c C-a}:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1543
Dave Love <fx@gnu.org>
parents:
diff changeset
1544 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1545 @item C-c C-a
Dave Love <fx@gnu.org>
parents:
diff changeset
1546 @kindex C-c C-a @r{(C mode)}
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1547 @findex c-toggle-auto-newline
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1548 Toggle the auto-newline feature (@code{c-toggle-auto-newline}). With a
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1549 prefix argument, this command turns the auto-newline feature on if the
Dave Love <fx@gnu.org>
parents:
diff changeset
1550 argument is positive, and off if it is negative.
Dave Love <fx@gnu.org>
parents:
diff changeset
1551 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1552
67683
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
1553 Usually the CC Mode style configures the exact circumstances in
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
1554 which Emacs inserts auto-newlines. You can also configure this
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
1555 directly. @xref{Custom Auto-newlines,,, ccmode, The CC Mode Manual}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1556
Dave Love <fx@gnu.org>
parents:
diff changeset
1557 @node Hungry Delete
Dave Love <fx@gnu.org>
parents:
diff changeset
1558 @subsection Hungry Delete Feature in C
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1559 @cindex hungry deletion (C Mode)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1560
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1561 If you want to delete an entire block of whitespace at point, you
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1562 can use @dfn{hungry deletion}. This deletes all the contiguous
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1563 whitespace either before point or after point in a single operation.
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1564 @dfn{Whitespace} here includes tabs and newlines, but not comments or
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1565 preprocessor commands.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1566
Dave Love <fx@gnu.org>
parents:
diff changeset
1567 @table @kbd
68801
e759a2258b51 programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents: 68717
diff changeset
1568 @item C-c C-@key{DEL}
e759a2258b51 programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents: 68717
diff changeset
1569 @itemx C-c @key{DEL}
74697
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
1570 @findex c-hungry-delete-backwards
68801
e759a2258b51 programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents: 68717
diff changeset
1571 @kindex C-c C-@key{DEL} (C Mode)
e759a2258b51 programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents: 68717
diff changeset
1572 @kindex C-c @key{DEL} (C Mode)
74697
3c81cd2d3939 programs.texi (Left Margin Paren): Remove the bit which says
Alan Mackenzie <acm@muc.de>
parents: 73197
diff changeset
1573 @code{c-hungry-delete-backwards}---Delete the entire block of whitespace
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1574 preceding point.
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1575
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1576 @item C-c C-d
68801
e759a2258b51 programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents: 68717
diff changeset
1577 @itemx C-c C-@key{DELETE}
e759a2258b51 programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents: 68717
diff changeset
1578 @itemx C-c @key{DELETE}
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1579 @findex c-hungry-delete-forward
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1580 @kindex C-c C-d (C Mode)
68801
e759a2258b51 programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents: 68717
diff changeset
1581 @kindex C-c C-@key{DELETE} (C Mode)
e759a2258b51 programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents: 68717
diff changeset
1582 @kindex C-c @key{DELETE} (C Mode)
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1583 @code{c-hungry-delete-forward}---Delete the entire block of whitespace
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1584 following point.
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1585 @end table
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1586
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1587 As an alternative to the above commands, you can enable @dfn{hungry
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1588 delete mode}. When this feature is enabled (indicated by @samp{/h} in
68818
353348d5ce78 (Defuns): Delete duplicate explanation of left-margin paren convention.
Richard M. Stallman <rms@gnu.org>
parents: 68801
diff changeset
1589 the mode line after the mode name), a single @key{DEL} deletes all
353348d5ce78 (Defuns): Delete duplicate explanation of left-margin paren convention.
Richard M. Stallman <rms@gnu.org>
parents: 68801
diff changeset
1590 preceding whitespace, not just one space, and a single @kbd{C-c C-d}
353348d5ce78 (Defuns): Delete duplicate explanation of left-margin paren convention.
Richard M. Stallman <rms@gnu.org>
parents: 68801
diff changeset
1591 (but @emph{not} plain @key{DELETE}) deletes all following whitespace.
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1592
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1593 @table @kbd
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1594 @item M-x c-toggle-hungry-state
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1595 @findex c-toggle-hungry-state
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1596 Toggle the hungry-delete feature
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1597 (@code{c-toggle-hungry-state})@footnote{This command had the binding
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1598 @kbd{C-c C-d} in earlier versions of Emacs. @kbd{C-c C-d} is now
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1599 bound to @code{c-hungry-delete-forward}.}. With a prefix argument,
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1600 this command turns the hungry-delete feature on if the argument is
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1601 positive, and off if it is negative.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1602 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1603
Dave Love <fx@gnu.org>
parents:
diff changeset
1604 @vindex c-hungry-delete-key
Dave Love <fx@gnu.org>
parents:
diff changeset
1605 The variable @code{c-hungry-delete-key} controls whether the
Dave Love <fx@gnu.org>
parents:
diff changeset
1606 hungry-delete feature is enabled.
Dave Love <fx@gnu.org>
parents:
diff changeset
1607
Dave Love <fx@gnu.org>
parents:
diff changeset
1608 @node Other C Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1609 @subsection Other Commands for C Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1610
Dave Love <fx@gnu.org>
parents:
diff changeset
1611 @table @kbd
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1612 @item C-c C-w
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1613 @itemx M-x c-subword-mode
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1614 @findex c-subword-mode
67683
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
1615 Enable (or disable) @dfn{subword mode}. In subword mode, Emacs's word
70485
e41cc24662e3 Fix spelling errors.
Eli Zaretskii <eliz@gnu.org>
parents: 70472
diff changeset
1616 commands recognize upper case letters in
67683
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
1617 @samp{StudlyCapsIdentifiers} as word boundaries. This is indicated by
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
1618 the flag @samp{/w} on the mode line after the mode name
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
1619 (e.g. @samp{C/law}). You can even use @kbd{M-x c-subword-mode} in
6fc6fd3c71cd (Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents: 67676
diff changeset
1620 non-CC Mode buffers.
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1621
68697
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1622 In the GNU project, we recommend using underscores to separate words
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1623 within an identifier in C or C++, rather than using case distinctions.
1450f1814186 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68639
diff changeset
1624
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1625 @item M-x c-context-line-break
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1626 @findex c-context-line-break
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1627 This command inserts a line break and indents the new line in a manner
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1628 appropriate to the context. In normal code, it does the work of
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1629 @kbd{C-j} (@code{newline-and-indent}), in a C preprocessor line it
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1630 additionally inserts a @samp{\} at the line break, and within comments
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1631 it's like @kbd{M-j} (@code{c-indent-new-comment-line}).
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1632
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1633 @code{c-context-line-break} isn't bound to a key by default, but it
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1634 needs a binding to be useful. The following code will bind it to
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1635 @kbd{C-j}. We use @code{c-initialization-hook} here to make sure
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1636 the keymap is loaded before we try to change it.
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1637
71593
4d628cade603 fix overfull/underfull boxes
Karl Berry <karl@gnu.org>
parents: 70485
diff changeset
1638 @smallexample
67676
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1639 (defun my-bind-clb ()
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1640 (define-key c-mode-base-map "\C-j" 'c-context-line-break))
76931aba1936 Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents: 67513
diff changeset
1641 (add-hook 'c-initialization-hook 'my-bind-clb)
71593
4d628cade603 fix overfull/underfull boxes
Karl Berry <karl@gnu.org>
parents: 70485
diff changeset
1642 @end smallexample
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1643
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1644 @item C-M-h
Dave Love <fx@gnu.org>
parents:
diff changeset
1645 Put mark at the end of a function definition, and put point at the
Dave Love <fx@gnu.org>
parents:
diff changeset
1646 beginning (@code{c-mark-function}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1647
Dave Love <fx@gnu.org>
parents:
diff changeset
1648 @item M-q
Dave Love <fx@gnu.org>
parents:
diff changeset
1649 @kindex M-q @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1650 @findex c-fill-paragraph
Dave Love <fx@gnu.org>
parents:
diff changeset
1651 Fill a paragraph, handling C and C++ comments (@code{c-fill-paragraph}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1652 If any part of the current line is a comment or within a comment, this
Dave Love <fx@gnu.org>
parents:
diff changeset
1653 command fills the comment or the paragraph of it that point is in,
Dave Love <fx@gnu.org>
parents:
diff changeset
1654 preserving the comment indentation and comment delimiters.
Dave Love <fx@gnu.org>
parents:
diff changeset
1655
Dave Love <fx@gnu.org>
parents:
diff changeset
1656 @item C-c C-e
Dave Love <fx@gnu.org>
parents:
diff changeset
1657 @cindex macro expansion in C
Dave Love <fx@gnu.org>
parents:
diff changeset
1658 @cindex expansion of C macros
Dave Love <fx@gnu.org>
parents:
diff changeset
1659 @findex c-macro-expand
Dave Love <fx@gnu.org>
parents:
diff changeset
1660 @kindex C-c C-e @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1661 Run the C preprocessor on the text in the region, and show the result,
Dave Love <fx@gnu.org>
parents:
diff changeset
1662 which includes the expansion of all the macro calls
Dave Love <fx@gnu.org>
parents:
diff changeset
1663 (@code{c-macro-expand}). The buffer text before the region is also
Dave Love <fx@gnu.org>
parents:
diff changeset
1664 included in preprocessing, for the sake of macros defined there, but the
Dave Love <fx@gnu.org>
parents:
diff changeset
1665 output from this part isn't shown.
Dave Love <fx@gnu.org>
parents:
diff changeset
1666
Dave Love <fx@gnu.org>
parents:
diff changeset
1667 When you are debugging C code that uses macros, sometimes it is hard to
Dave Love <fx@gnu.org>
parents:
diff changeset
1668 figure out precisely how the macros expand. With this command, you
Dave Love <fx@gnu.org>
parents:
diff changeset
1669 don't have to figure it out; you can see the expansions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1670
Dave Love <fx@gnu.org>
parents:
diff changeset
1671 @item C-c C-\
Dave Love <fx@gnu.org>
parents:
diff changeset
1672 @findex c-backslash-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1673 @kindex C-c C-\ @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1674 Insert or align @samp{\} characters at the ends of the lines of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1675 region (@code{c-backslash-region}). This is useful after writing or
Dave Love <fx@gnu.org>
parents:
diff changeset
1676 editing a C macro definition.
Dave Love <fx@gnu.org>
parents:
diff changeset
1677
Dave Love <fx@gnu.org>
parents:
diff changeset
1678 If a line already ends in @samp{\}, this command adjusts the amount of
Dave Love <fx@gnu.org>
parents:
diff changeset
1679 whitespace before it. Otherwise, it inserts a new @samp{\}. However,
Dave Love <fx@gnu.org>
parents:
diff changeset
1680 the last line in the region is treated specially; no @samp{\} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1681 inserted on that line, and any @samp{\} there is deleted.
Dave Love <fx@gnu.org>
parents:
diff changeset
1682
Dave Love <fx@gnu.org>
parents:
diff changeset
1683 @item M-x cpp-highlight-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1684 @cindex preprocessor highlighting
Dave Love <fx@gnu.org>
parents:
diff changeset
1685 @findex cpp-highlight-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1686 Highlight parts of the text according to its preprocessor conditionals.
Dave Love <fx@gnu.org>
parents:
diff changeset
1687 This command displays another buffer named @samp{*CPP Edit*}, which
Dave Love <fx@gnu.org>
parents:
diff changeset
1688 serves as a graphic menu for selecting how to display particular kinds
Dave Love <fx@gnu.org>
parents:
diff changeset
1689 of conditionals and their contents. After changing various settings,
Dave Love <fx@gnu.org>
parents:
diff changeset
1690 click on @samp{[A]pply these settings} (or go to that buffer and type
Dave Love <fx@gnu.org>
parents:
diff changeset
1691 @kbd{a}) to rehighlight the C mode buffer accordingly.
Dave Love <fx@gnu.org>
parents:
diff changeset
1692
Dave Love <fx@gnu.org>
parents:
diff changeset
1693 @item C-c C-s
Dave Love <fx@gnu.org>
parents:
diff changeset
1694 @findex c-show-syntactic-information
Dave Love <fx@gnu.org>
parents:
diff changeset
1695 @kindex C-c C-s @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1696 Display the syntactic information about the current source line
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
1697 (@code{c-show-syntactic-information}). This information directs how
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
1698 the line is indented.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1699
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1700 @item M-x cwarn-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1701 @itemx M-x global-cwarn-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1702 @findex cwarn-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1703 @findex global-cwarn-mode
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1704 @vindex global-cwarn-mode
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1705 @cindex CWarn mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1706 @cindex suspicious constructions in C, C++
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1707 CWarn minor mode highlights certain suspicious C and C++ constructions:
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1708
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1709 @itemize @bullet{}
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1710 @item
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1711 Assignments inside expressions.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1712 @item
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1713 Semicolon following immediately after @samp{if}, @samp{for}, and @samp{while}
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1714 (except after a @samp{do @dots{} while} statement);
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1715 @item
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1716 C++ functions with reference parameters.
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1717 @end itemize
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1718
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1719 @noindent
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1720 You can enable the mode for one buffer with the command @kbd{M-x
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1721 cwarn-mode}, or for all suitable buffers with the command @kbd{M-x
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1722 global-cwarn-mode} or by customizing the variable
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1723 @code{global-cwarn-mode}. You must also enable Font Lock mode to make
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1724 it work.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1725
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1726 @item M-x hide-ifdef-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1727 @findex hide-ifdef-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1728 @cindex Hide-ifdef mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1729 Hide-ifdef minor mode hides selected code within @samp{#if} and
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1730 @samp{#ifdef} preprocessor blocks. See the documentation string of
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1731 @code{hide-ifdef-mode} for more information.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1732
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1733 @item M-x ff-find-related-file
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1734 @cindex related files
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1735 @findex ff-find-related-file
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1736 @vindex ff-related-file-alist
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1737 Find a file ``related'' in a special way to the file visited by the
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1738 current buffer. Typically this will be the header file corresponding
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1739 to a C/C++ source file, or vice versa. The variable
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1740 @code{ff-related-file-alist} specifies how to compute related file
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1741 names.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1742 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1743
Dave Love <fx@gnu.org>
parents:
diff changeset
1744 @node Asm Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1745 @section Asm Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1746
Dave Love <fx@gnu.org>
parents:
diff changeset
1747 @cindex Asm mode
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1748 @cindex assembler mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1749 Asm mode is a major mode for editing files of assembler code. It
Dave Love <fx@gnu.org>
parents:
diff changeset
1750 defines these commands:
Dave Love <fx@gnu.org>
parents:
diff changeset
1751
Dave Love <fx@gnu.org>
parents:
diff changeset
1752 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1753 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
1754 @code{tab-to-tab-stop}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1755 @item C-j
Dave Love <fx@gnu.org>
parents:
diff changeset
1756 Insert a newline and then indent using @code{tab-to-tab-stop}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1757 @item :
Dave Love <fx@gnu.org>
parents:
diff changeset
1758 Insert a colon and then remove the indentation from before the label
Dave Love <fx@gnu.org>
parents:
diff changeset
1759 preceding colon. Then do @code{tab-to-tab-stop}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1760 @item ;
Dave Love <fx@gnu.org>
parents:
diff changeset
1761 Insert or align a comment.
Dave Love <fx@gnu.org>
parents:
diff changeset
1762 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1763
Dave Love <fx@gnu.org>
parents:
diff changeset
1764 The variable @code{asm-comment-char} specifies which character
Dave Love <fx@gnu.org>
parents:
diff changeset
1765 starts comments in assembler syntax.
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52153
diff changeset
1766
70442
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
1767 @ifnottex
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
1768 @include fortran-xtra.texi
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
1769 @end ifnottex
284d18cd0af7 (Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents: 69842
diff changeset
1770
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52153
diff changeset
1771 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52153
diff changeset
1772 arch-tag: c7ee7409-40a4-45c7-bfb7-ae7f2c74d0c0
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52153
diff changeset
1773 @end ignore