Mercurial > emacs
annotate man/indent.texi @ 39005:daf9a2765762
(fancy-splash-screens): Temporarily set
minor-mode-map-alist to nil while displaying splash screens.
author | Gerd Moellmann <gerd@gnu.org> |
---|---|
date | Wed, 29 Aug 2001 09:31:27 +0000 |
parents | daea04400144 |
children | a093cd4ed690 |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 1997 Free Software Foundation, Inc. | |
3 @c See file emacs.texi for copying conditions. | |
4 @node Indentation, Text, Major Modes, Top | |
5 @chapter Indentation | |
6 @cindex indentation | |
7 @cindex columns (indentation) | |
8 | |
9 This chapter describes the Emacs commands that add, remove, or | |
10 adjust indentation. | |
11 | |
12 @c WideCommands | |
13 @table @kbd | |
14 @item @key{TAB} | |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38150
diff
changeset
|
15 Indent the current line ``appropriately'' in a mode-dependent fashion. |
25829 | 16 @item @kbd{C-j} |
17 Perform @key{RET} followed by @key{TAB} (@code{newline-and-indent}). | |
18 @item M-^ | |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38150
diff
changeset
|
19 Merge the previous and the current line (@code{delete-indentation}). |
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38150
diff
changeset
|
20 This would cancel out the effect of @kbd{C-j}. |
25829 | 21 @item C-M-o |
38490 | 22 Split the current line at point; text on the line after point becomes a |
23 new line indented to the same column where point is located | |
24 (@code{split-line}). | |
25829 | 25 @item M-m |
26 Move (forward or back) to the first nonblank character on the current | |
27 line (@code{back-to-indentation}). | |
28 @item C-M-\ | |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38150
diff
changeset
|
29 Indent several lines to the same column (@code{indent-region}). |
25829 | 30 @item C-x @key{TAB} |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
38150
diff
changeset
|
31 Shift a block of lines rigidly right or left (@code{indent-rigidly}). |
25829 | 32 @item M-i |
33 Indent from point to the next prespecified tab stop column | |
34 (@code{tab-to-tab-stop}). | |
35 @item M-x indent-relative | |
36 Indent from point to under an indentation point in the previous line. | |
37 @end table | |
38 | |
39 Most programming languages have some indentation convention. For Lisp | |
40 code, lines are indented according to their nesting in parentheses. The | |
41 same general idea is used for C code, though many details are different. | |
42 | |
43 @kindex TAB | |
44 Whatever the language, to indent a line, use the @key{TAB} command. Each | |
45 major mode defines this command to perform the sort of indentation | |
46 appropriate for the particular language. In Lisp mode, @key{TAB} aligns | |
47 the line according to its depth in parentheses. No matter where in the | |
48 line you are when you type @key{TAB}, it aligns the line as a whole. In C | |
49 mode, @key{TAB} implements a subtle and sophisticated indentation style that | |
50 knows about many aspects of C syntax. | |
51 | |
52 In Text mode, @key{TAB} runs the command @code{tab-to-tab-stop}, which | |
53 indents to the next tab stop column. You can set the tab stops with | |
54 @kbd{M-x edit-tab-stops}. | |
55 | |
38743 | 56 Normally, @key{TAB} inserts an optimal mix of tabs and spaces for |
57 the intended indentation. @xref{Just Spaces}, for how to prevent use | |
58 of tabs. | |
38008
710f2cbdd6ab
Add a cross-reference to the description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents:
37420
diff
changeset
|
59 |
25829 | 60 @menu |
61 * Indentation Commands:: Various commands and techniques for indentation. | |
62 * Tab Stops:: You can set arbitrary "tab stops" and then | |
63 indent to the next tab stop when you want to. | |
64 * Just Spaces:: You can request indentation using just spaces. | |
65 @end menu | |
66 | |
67 @node Indentation Commands, Tab Stops, Indentation, Indentation | |
68 @section Indentation Commands and Techniques | |
69 | |
70 @kindex M-m | |
71 @findex back-to-indentation | |
72 To move over the indentation on a line, do @kbd{M-m} | |
73 (@code{back-to-indentation}). This command, given anywhere on a line, | |
74 positions point at the first nonblank character on the line. | |
75 | |
76 To insert an indented line before the current line, do @kbd{C-a C-o | |
77 @key{TAB}}. To make an indented line after the current line, use | |
78 @kbd{C-e C-j}. | |
79 | |
80 If you just want to insert a tab character in the buffer, you can type | |
81 @kbd{C-q @key{TAB}}. | |
82 | |
83 @kindex C-M-o | |
84 @findex split-line | |
85 @kbd{C-M-o} (@code{split-line}) moves the text from point to the end of | |
86 the line vertically down, so that the current line becomes two lines. | |
87 @kbd{C-M-o} first moves point forward over any spaces and tabs. Then it | |
88 inserts after point a newline and enough indentation to reach the same | |
89 column point is on. Point remains before the inserted newline; in this | |
90 regard, @kbd{C-M-o} resembles @kbd{C-o}. | |
91 | |
92 @kindex M-^ | |
93 @findex delete-indentation | |
94 To join two lines cleanly, use the @kbd{M-^} | |
95 (@code{delete-indentation}) command. It deletes the indentation at the | |
96 front of the current line, and the line boundary as well, replacing them | |
97 with a single space. As a special case (useful for Lisp code) the | |
98 single space is omitted if the characters to be joined are consecutive | |
99 open parentheses or closing parentheses, or if the junction follows | |
100 another newline. To delete just the indentation of a line, go to the | |
101 beginning of the line and use @kbd{M-\} | |
102 (@code{delete-horizontal-space}), which deletes all spaces and tabs | |
103 around the cursor. | |
104 | |
105 If you have a fill prefix, @kbd{M-^} deletes the fill prefix if it | |
106 appears after the newline that is deleted. @xref{Fill Prefix}. | |
107 | |
108 @kindex C-M-\ | |
109 @kindex C-x TAB | |
110 @findex indent-region | |
111 @findex indent-rigidly | |
112 There are also commands for changing the indentation of several lines | |
113 at once. @kbd{C-M-\} (@code{indent-region}) applies to all the lines | |
114 that begin in the region; it indents each line in the ``usual'' way, as | |
115 if you had typed @key{TAB} at the beginning of the line. A numeric | |
116 argument specifies the column to indent to, and each line is shifted | |
117 left or right so that its first nonblank character appears in that | |
118 column. @kbd{C-x @key{TAB}} (@code{indent-rigidly}) moves all of the | |
119 lines in the region right by its argument (left, for negative | |
120 arguments). The whole group of lines moves rigidly sideways, which is | |
121 how the command gets its name.@refill | |
122 | |
123 @findex indent-relative | |
124 @kbd{M-x indent-relative} indents at point based on the previous line | |
125 (actually, the last nonempty line). It inserts whitespace at point, moving | |
126 point, until it is underneath an indentation point in the previous line. | |
127 An indentation point is the end of a sequence of whitespace or the end of | |
128 the line. If point is farther right than any indentation point in the | |
129 previous line, the whitespace before point is deleted and the first | |
130 indentation point then applicable is used. If no indentation point is | |
131 applicable even then, @code{indent-relative} runs @code{tab-to-tab-stop} | |
132 @ifinfo | |
38150
e8daadee7c3c
(Indentation Commands): Document what indent-relative does when called
Eli Zaretskii <eliz@gnu.org>
parents:
38008
diff
changeset
|
133 (@pxref{Tab Stops}), |
25829 | 134 @end ifinfo |
135 @iftex | |
38150
e8daadee7c3c
(Indentation Commands): Document what indent-relative does when called
Eli Zaretskii <eliz@gnu.org>
parents:
38008
diff
changeset
|
136 (see next section), |
25829 | 137 @end iftex |
38150
e8daadee7c3c
(Indentation Commands): Document what indent-relative does when called
Eli Zaretskii <eliz@gnu.org>
parents:
38008
diff
changeset
|
138 unless it is called with a numeric argument, in which case it does |
e8daadee7c3c
(Indentation Commands): Document what indent-relative does when called
Eli Zaretskii <eliz@gnu.org>
parents:
38008
diff
changeset
|
139 nothing. |
25829 | 140 |
141 @code{indent-relative} is the definition of @key{TAB} in Indented Text | |
142 mode. @xref{Text}. | |
143 | |
144 @xref{Format Indentation}, for another way of specifying the | |
145 indentation for part of your text. | |
146 | |
147 @node Tab Stops, Just Spaces, Indentation Commands, Indentation | |
148 @section Tab Stops | |
149 | |
150 @cindex tab stops | |
151 @cindex using tab stops in making tables | |
152 @cindex tables, indentation for | |
153 @kindex M-i | |
154 @findex tab-to-tab-stop | |
155 For typing in tables, you can use Text mode's definition of @key{TAB}, | |
156 @code{tab-to-tab-stop}. This command inserts indentation before point, | |
157 enough to reach the next tab stop column. If you are not in Text mode, | |
158 this command can be found on the key @kbd{M-i}. | |
159 | |
160 @findex edit-tab-stops | |
161 @findex edit-tab-stops-note-changes | |
162 @kindex C-c C-c @r{(Edit Tab Stops)} | |
163 @vindex tab-stop-list | |
164 You can specify the tab stops used by @kbd{M-i}. They are stored in a | |
165 variable called @code{tab-stop-list}, as a list of column-numbers in | |
166 increasing order. | |
167 | |
168 The convenient way to set the tab stops is with @kbd{M-x | |
169 edit-tab-stops}, which creates and selects a buffer containing a | |
170 description of the tab stop settings. You can edit this buffer to | |
171 specify different tab stops, and then type @kbd{C-c C-c} to make those | |
172 new tab stops take effect. @code{edit-tab-stops} records which buffer | |
173 was current when you invoked it, and stores the tab stops back in that | |
174 buffer; normally all buffers share the same tab stops and changing them | |
175 in one buffer affects all, but if you happen to make | |
176 @code{tab-stop-list} local in one buffer then @code{edit-tab-stops} in | |
177 that buffer will edit the local settings. | |
178 | |
179 Here is what the text representing the tab stops looks like for ordinary | |
180 tab stops every eight columns. | |
181 | |
182 @example | |
183 : : : : : : | |
184 0 1 2 3 4 | |
185 0123456789012345678901234567890123456789012345678 | |
186 To install changes, type C-c C-c | |
187 @end example | |
188 | |
189 The first line contains a colon at each tab stop. The remaining lines | |
190 are present just to help you see where the colons are and know what to do. | |
191 | |
192 Note that the tab stops that control @code{tab-to-tab-stop} have nothing | |
36208
898561c41ba0
FIx xref to Display Custom.
Richard M. Stallman <rms@gnu.org>
parents:
25829
diff
changeset
|
193 to do with displaying tab characters in the buffer. @xref{Display Custom}, |
25829 | 194 for more information on that. |
195 | |
196 @node Just Spaces,, Tab Stops, Indentation | |
197 @section Tabs vs. Spaces | |
198 | |
199 @vindex indent-tabs-mode | |
37420 | 200 Emacs normally uses both tabs and spaces to indent lines. If you |
201 prefer, all indentation can be made from spaces only. To request | |
202 this, set @code{indent-tabs-mode} to @code{nil}. This is a per-buffer | |
203 variable, so altering the variable affects only the current buffer, | |
204 but there is a default value which you can change as well. | |
205 @xref{Locals}. | |
25829 | 206 |
207 @findex tabify | |
208 @findex untabify | |
209 There are also commands to convert tabs to spaces or vice versa, always | |
210 preserving the columns of all nonblank text. @kbd{M-x tabify} scans the | |
211 region for sequences of spaces, and converts sequences of at least three | |
212 spaces to tabs if that can be done without changing indentation. @kbd{M-x | |
213 untabify} changes all tabs in the region to appropriate numbers of spaces. |