annotate man/indent.texi @ 33969:96d72c104f9a raeburn-tag-5-for-export

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