annotate man/indent.texi @ 53755:9bd36e762e48

(jit-lock-stealth-fontify): Allow quit. (jit-lock-fontify-now): Handle the `quit' case. (jit-lock-contextually): Rename from jit-lock-defer-contextually.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Fri, 30 Jan 2004 00:08:38 +0000
parents 695cf19ef79e
children d38f0e75756e 375f2633d815
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 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
13 @item @key{TAB}
38461
23f63206a867 Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents: 38150
diff changeset
14 Indent the current line ``appropriately'' in a mode-dependent fashion.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
15 @item @kbd{C-j}
Dave Love <fx@gnu.org>
parents:
diff changeset
16 Perform @key{RET} followed by @key{TAB} (@code{newline-and-indent}).
Dave Love <fx@gnu.org>
parents:
diff changeset
17 @item M-^
38461
23f63206a867 Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents: 38150
diff changeset
18 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
19 This would cancel out the effect of @kbd{C-j}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
20 @item C-M-o
38490
1518ad710658 Fix last changes.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
21 Split the current line at point; text on the line after point becomes a
1518ad710658 Fix last changes.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
22 new line indented to the same column where point is located
1518ad710658 Fix last changes.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
23 (@code{split-line}).
25829
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-\
38461
23f63206a867 Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents: 38150
diff changeset
28 Indent several lines to the same column (@code{indent-region}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
29 @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
30 Shift a block of lines rigidly right or left (@code{indent-rigidly}).
25829
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
51145
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
38 Emacs supports four general categories of operations that could all
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
39 be called `indentation':
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
40
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
41 @enumerate
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
42 @item
51298
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
43 Insert a tab character. You can type @kbd{C-q @key{TAB}} to do this.
51145
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
44
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
45 A tab character is displayed as a stretch of whitespace which extends
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
46 to the next display tab stop position, and the default width of a tab
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
47 stop is eight. @xref{Display Custom}, for more details.
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
48
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
49 @item
51298
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
50 Advance to the next tab stop. You can set tab stops at your choice of
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
51 column positions, then type @kbd{M-i} to advance to the next tab stop.
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
52 The default is to have tab stops every eight columns, which means by
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
53 default @kbd{M-i} inserts a tab character. To set the tab stops, use
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
54 @kbd{M-x edit-tab-stops}.
51145
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
55
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
56 @item
51298
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
57 Align a line with the previous line. More precisely, the command
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
58 @kbd{M-x indent-relative} indents the current line under the beginning
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
59 of some word in the previous line. In Fundamental mode and in Text
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
60 mode, @key{TAB} runs the command @code{indent-relative}.
51145
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
61
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
62 @item
51298
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
63 The most sophisticated method is @dfn{syntax-driven indentation}.
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
64 Most programming languages have an indentation convention. For Lisp
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
65 code, lines are indented according to their nesting in parentheses. C
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
66 code uses the same general idea, but many details are different.
51145
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
67
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
68 @kindex TAB
51298
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
69 Type @key{TAB} to do syntax-driven indentation, in a mode that
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
70 supports it. It realigns the current line according with the syntax
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
71 of the preceding lines. No matter where in the line you are when you
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
72 type @key{TAB}, it aligns the line as a whole.
51145
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
73 @end enumerate
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
74
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
75 Normally, all of the above methods insert an optimal mix of tabs and
51298
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
76 spaces to align to the desired column. @xref{Just Spaces}, for how to
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
77 disable use of tabs. However, @kbd{C-q @key{TAB}} always inserts a
229d922db4a3 (Indentation): Condense, simplify, clarify prev change.
Richard M. Stallman <rms@gnu.org>
parents: 51145
diff changeset
78 tab, even they are disabled for the indentation commands.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
79
51145
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
80 @c In Text mode, @key{TAB} runs the command @code{tab-to-tab-stop}, which
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
81 @c indents to the next tab stop column. You can set the tab stops with
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
82 @c @kbd{M-x edit-tab-stops}.
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
83
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
84 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
85 * Indentation Commands:: Various commands and techniques for indentation.
Dave Love <fx@gnu.org>
parents:
diff changeset
86 * Tab Stops:: You can set arbitrary "tab stops" and then
Dave Love <fx@gnu.org>
parents:
diff changeset
87 indent to the next tab stop when you want to.
Dave Love <fx@gnu.org>
parents:
diff changeset
88 * Just Spaces:: You can request indentation using just spaces.
Dave Love <fx@gnu.org>
parents:
diff changeset
89 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
90
Dave Love <fx@gnu.org>
parents:
diff changeset
91 @node Indentation Commands, Tab Stops, Indentation, Indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
92 @section Indentation Commands and Techniques
Dave Love <fx@gnu.org>
parents:
diff changeset
93
Dave Love <fx@gnu.org>
parents:
diff changeset
94 @kindex M-m
Dave Love <fx@gnu.org>
parents:
diff changeset
95 @findex back-to-indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
96 To move over the indentation on a line, do @kbd{M-m}
Dave Love <fx@gnu.org>
parents:
diff changeset
97 (@code{back-to-indentation}). This command, given anywhere on a line,
Dave Love <fx@gnu.org>
parents:
diff changeset
98 positions point at the first nonblank character on the line.
Dave Love <fx@gnu.org>
parents:
diff changeset
99
Dave Love <fx@gnu.org>
parents:
diff changeset
100 To insert an indented line before the current line, do @kbd{C-a C-o
Dave Love <fx@gnu.org>
parents:
diff changeset
101 @key{TAB}}. To make an indented line after the current line, use
Dave Love <fx@gnu.org>
parents:
diff changeset
102 @kbd{C-e C-j}.
Dave Love <fx@gnu.org>
parents:
diff changeset
103
Dave Love <fx@gnu.org>
parents:
diff changeset
104 If you just want to insert a tab character in the buffer, you can type
Dave Love <fx@gnu.org>
parents:
diff changeset
105 @kbd{C-q @key{TAB}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
106
Dave Love <fx@gnu.org>
parents:
diff changeset
107 @kindex C-M-o
Dave Love <fx@gnu.org>
parents:
diff changeset
108 @findex split-line
Dave Love <fx@gnu.org>
parents:
diff changeset
109 @kbd{C-M-o} (@code{split-line}) moves the text from point to the end of
Dave Love <fx@gnu.org>
parents:
diff changeset
110 the line vertically down, so that the current line becomes two lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
111 @kbd{C-M-o} first moves point forward over any spaces and tabs. Then it
Dave Love <fx@gnu.org>
parents:
diff changeset
112 inserts after point a newline and enough indentation to reach the same
Dave Love <fx@gnu.org>
parents:
diff changeset
113 column point is on. Point remains before the inserted newline; in this
Dave Love <fx@gnu.org>
parents:
diff changeset
114 regard, @kbd{C-M-o} resembles @kbd{C-o}.
Dave Love <fx@gnu.org>
parents:
diff changeset
115
Dave Love <fx@gnu.org>
parents:
diff changeset
116 @kindex M-^
Dave Love <fx@gnu.org>
parents:
diff changeset
117 @findex delete-indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
118 To join two lines cleanly, use the @kbd{M-^}
Dave Love <fx@gnu.org>
parents:
diff changeset
119 (@code{delete-indentation}) command. It deletes the indentation at the
Dave Love <fx@gnu.org>
parents:
diff changeset
120 front of the current line, and the line boundary as well, replacing them
Dave Love <fx@gnu.org>
parents:
diff changeset
121 with a single space. As a special case (useful for Lisp code) the
Dave Love <fx@gnu.org>
parents:
diff changeset
122 single space is omitted if the characters to be joined are consecutive
Dave Love <fx@gnu.org>
parents:
diff changeset
123 open parentheses or closing parentheses, or if the junction follows
Dave Love <fx@gnu.org>
parents:
diff changeset
124 another newline. To delete just the indentation of a line, go to the
Dave Love <fx@gnu.org>
parents:
diff changeset
125 beginning of the line and use @kbd{M-\}
Dave Love <fx@gnu.org>
parents:
diff changeset
126 (@code{delete-horizontal-space}), which deletes all spaces and tabs
Dave Love <fx@gnu.org>
parents:
diff changeset
127 around the cursor.
Dave Love <fx@gnu.org>
parents:
diff changeset
128
Dave Love <fx@gnu.org>
parents:
diff changeset
129 If you have a fill prefix, @kbd{M-^} deletes the fill prefix if it
Dave Love <fx@gnu.org>
parents:
diff changeset
130 appears after the newline that is deleted. @xref{Fill Prefix}.
Dave Love <fx@gnu.org>
parents:
diff changeset
131
Dave Love <fx@gnu.org>
parents:
diff changeset
132 @kindex C-M-\
Dave Love <fx@gnu.org>
parents:
diff changeset
133 @kindex C-x TAB
Dave Love <fx@gnu.org>
parents:
diff changeset
134 @findex indent-region
Dave Love <fx@gnu.org>
parents:
diff changeset
135 @findex indent-rigidly
Dave Love <fx@gnu.org>
parents:
diff changeset
136 There are also commands for changing the indentation of several lines
Dave Love <fx@gnu.org>
parents:
diff changeset
137 at once. @kbd{C-M-\} (@code{indent-region}) applies to all the lines
Dave Love <fx@gnu.org>
parents:
diff changeset
138 that begin in the region; it indents each line in the ``usual'' way, as
Dave Love <fx@gnu.org>
parents:
diff changeset
139 if you had typed @key{TAB} at the beginning of the line. A numeric
Dave Love <fx@gnu.org>
parents:
diff changeset
140 argument specifies the column to indent to, and each line is shifted
Dave Love <fx@gnu.org>
parents:
diff changeset
141 left or right so that its first nonblank character appears in that
Dave Love <fx@gnu.org>
parents:
diff changeset
142 column. @kbd{C-x @key{TAB}} (@code{indent-rigidly}) moves all of the
Dave Love <fx@gnu.org>
parents:
diff changeset
143 lines in the region right by its argument (left, for negative
Dave Love <fx@gnu.org>
parents:
diff changeset
144 arguments). The whole group of lines moves rigidly sideways, which is
Dave Love <fx@gnu.org>
parents:
diff changeset
145 how the command gets its name.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
146
45437
c48cc0f16c0e (Indentation Commands): Describe how to remove all indentation. Add
Eli Zaretskii <eliz@gnu.org>
parents: 39264
diff changeset
147 @cindex remove indentation
c48cc0f16c0e (Indentation Commands): Describe how to remove all indentation. Add
Eli Zaretskii <eliz@gnu.org>
parents: 39264
diff changeset
148 If you want to remove all indentation from all of the line in the
c48cc0f16c0e (Indentation Commands): Describe how to remove all indentation. Add
Eli Zaretskii <eliz@gnu.org>
parents: 39264
diff changeset
149 region, invoke @kbd{C-x @key{TAB}} with a large negative argument,
c48cc0f16c0e (Indentation Commands): Describe how to remove all indentation. Add
Eli Zaretskii <eliz@gnu.org>
parents: 39264
diff changeset
150 such as -1000.
c48cc0f16c0e (Indentation Commands): Describe how to remove all indentation. Add
Eli Zaretskii <eliz@gnu.org>
parents: 39264
diff changeset
151
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
152 @findex indent-relative
Dave Love <fx@gnu.org>
parents:
diff changeset
153 @kbd{M-x indent-relative} indents at point based on the previous line
Dave Love <fx@gnu.org>
parents:
diff changeset
154 (actually, the last nonempty line). It inserts whitespace at point, moving
Dave Love <fx@gnu.org>
parents:
diff changeset
155 point, until it is underneath an indentation point in the previous line.
Dave Love <fx@gnu.org>
parents:
diff changeset
156 An indentation point is the end of a sequence of whitespace or the end of
Dave Love <fx@gnu.org>
parents:
diff changeset
157 the line. If point is farther right than any indentation point in the
Dave Love <fx@gnu.org>
parents:
diff changeset
158 previous line, the whitespace before point is deleted and the first
Dave Love <fx@gnu.org>
parents:
diff changeset
159 indentation point then applicable is used. If no indentation point is
Dave Love <fx@gnu.org>
parents:
diff changeset
160 applicable even then, @code{indent-relative} runs @code{tab-to-tab-stop}
Dave Love <fx@gnu.org>
parents:
diff changeset
161 @ifinfo
38150
e8daadee7c3c (Indentation Commands): Document what indent-relative does when called
Eli Zaretskii <eliz@gnu.org>
parents: 38008
diff changeset
162 (@pxref{Tab Stops}),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
163 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
164 @iftex
38150
e8daadee7c3c (Indentation Commands): Document what indent-relative does when called
Eli Zaretskii <eliz@gnu.org>
parents: 38008
diff changeset
165 (see next section),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
166 @end iftex
38150
e8daadee7c3c (Indentation Commands): Document what indent-relative does when called
Eli Zaretskii <eliz@gnu.org>
parents: 38008
diff changeset
167 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
168 nothing.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
169
Dave Love <fx@gnu.org>
parents:
diff changeset
170 @code{indent-relative} is the definition of @key{TAB} in Indented Text
Dave Love <fx@gnu.org>
parents:
diff changeset
171 mode. @xref{Text}.
Dave Love <fx@gnu.org>
parents:
diff changeset
172
Dave Love <fx@gnu.org>
parents:
diff changeset
173 @xref{Format Indentation}, for another way of specifying the
Dave Love <fx@gnu.org>
parents:
diff changeset
174 indentation for part of your text.
Dave Love <fx@gnu.org>
parents:
diff changeset
175
Dave Love <fx@gnu.org>
parents:
diff changeset
176 @node Tab Stops, Just Spaces, Indentation Commands, Indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
177 @section Tab Stops
Dave Love <fx@gnu.org>
parents:
diff changeset
178
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 45437
diff changeset
179 @cindex tab stops
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
180 @cindex using tab stops in making tables
Dave Love <fx@gnu.org>
parents:
diff changeset
181 @cindex tables, indentation for
Dave Love <fx@gnu.org>
parents:
diff changeset
182 @kindex M-i
Dave Love <fx@gnu.org>
parents:
diff changeset
183 @findex tab-to-tab-stop
Dave Love <fx@gnu.org>
parents:
diff changeset
184 For typing in tables, you can use Text mode's definition of @key{TAB},
Dave Love <fx@gnu.org>
parents:
diff changeset
185 @code{tab-to-tab-stop}. This command inserts indentation before point,
Dave Love <fx@gnu.org>
parents:
diff changeset
186 enough to reach the next tab stop column. If you are not in Text mode,
Dave Love <fx@gnu.org>
parents:
diff changeset
187 this command can be found on the key @kbd{M-i}.
Dave Love <fx@gnu.org>
parents:
diff changeset
188
Dave Love <fx@gnu.org>
parents:
diff changeset
189 @findex edit-tab-stops
Dave Love <fx@gnu.org>
parents:
diff changeset
190 @findex edit-tab-stops-note-changes
Dave Love <fx@gnu.org>
parents:
diff changeset
191 @kindex C-c C-c @r{(Edit Tab Stops)}
Dave Love <fx@gnu.org>
parents:
diff changeset
192 @vindex tab-stop-list
Dave Love <fx@gnu.org>
parents:
diff changeset
193 You can specify the tab stops used by @kbd{M-i}. They are stored in a
Dave Love <fx@gnu.org>
parents:
diff changeset
194 variable called @code{tab-stop-list}, as a list of column-numbers in
Dave Love <fx@gnu.org>
parents:
diff changeset
195 increasing order.
Dave Love <fx@gnu.org>
parents:
diff changeset
196
Dave Love <fx@gnu.org>
parents:
diff changeset
197 The convenient way to set the tab stops is with @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
198 edit-tab-stops}, which creates and selects a buffer containing a
Dave Love <fx@gnu.org>
parents:
diff changeset
199 description of the tab stop settings. You can edit this buffer to
Dave Love <fx@gnu.org>
parents:
diff changeset
200 specify different tab stops, and then type @kbd{C-c C-c} to make those
Dave Love <fx@gnu.org>
parents:
diff changeset
201 new tab stops take effect. @code{edit-tab-stops} records which buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
202 was current when you invoked it, and stores the tab stops back in that
Dave Love <fx@gnu.org>
parents:
diff changeset
203 buffer; normally all buffers share the same tab stops and changing them
Dave Love <fx@gnu.org>
parents:
diff changeset
204 in one buffer affects all, but if you happen to make
Dave Love <fx@gnu.org>
parents:
diff changeset
205 @code{tab-stop-list} local in one buffer then @code{edit-tab-stops} in
Dave Love <fx@gnu.org>
parents:
diff changeset
206 that buffer will edit the local settings.
Dave Love <fx@gnu.org>
parents:
diff changeset
207
Dave Love <fx@gnu.org>
parents:
diff changeset
208 Here is what the text representing the tab stops looks like for ordinary
Dave Love <fx@gnu.org>
parents:
diff changeset
209 tab stops every eight columns.
Dave Love <fx@gnu.org>
parents:
diff changeset
210
Dave Love <fx@gnu.org>
parents:
diff changeset
211 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
212 : : : : : :
Dave Love <fx@gnu.org>
parents:
diff changeset
213 0 1 2 3 4
Dave Love <fx@gnu.org>
parents:
diff changeset
214 0123456789012345678901234567890123456789012345678
Dave Love <fx@gnu.org>
parents:
diff changeset
215 To install changes, type C-c C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
216 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
217
Dave Love <fx@gnu.org>
parents:
diff changeset
218 The first line contains a colon at each tab stop. The remaining lines
Dave Love <fx@gnu.org>
parents:
diff changeset
219 are present just to help you see where the colons are and know what to do.
Dave Love <fx@gnu.org>
parents:
diff changeset
220
Dave Love <fx@gnu.org>
parents:
diff changeset
221 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
222 to do with displaying tab characters in the buffer. @xref{Display Custom},
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
223 for more information on that.
Dave Love <fx@gnu.org>
parents:
diff changeset
224
Dave Love <fx@gnu.org>
parents:
diff changeset
225 @node Just Spaces,, Tab Stops, Indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
226 @section Tabs vs. Spaces
Dave Love <fx@gnu.org>
parents:
diff changeset
227
Dave Love <fx@gnu.org>
parents:
diff changeset
228 @vindex indent-tabs-mode
37420
e495884180bb Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 36208
diff changeset
229 Emacs normally uses both tabs and spaces to indent lines. If you
e495884180bb Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 36208
diff changeset
230 prefer, all indentation can be made from spaces only. To request
e495884180bb Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 36208
diff changeset
231 this, set @code{indent-tabs-mode} to @code{nil}. This is a per-buffer
e495884180bb Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 36208
diff changeset
232 variable, so altering the variable affects only the current buffer,
e495884180bb Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 36208
diff changeset
233 but there is a default value which you can change as well.
e495884180bb Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 36208
diff changeset
234 @xref{Locals}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
235
51145
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
236 A tab is not always displayed in the same way. By default, tabs are
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
237 eight columns wide, but some people like to customize their tools to
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
238 use a different tab width. So by using spaces only, you can make sure
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
239 that your file looks the same regardless of the tab width setting.
4e1075214fa7 (Indentation): Explain the concepts.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49600
diff changeset
240
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
241 @findex tabify
Dave Love <fx@gnu.org>
parents:
diff changeset
242 @findex untabify
Dave Love <fx@gnu.org>
parents:
diff changeset
243 There are also commands to convert tabs to spaces or vice versa, always
Dave Love <fx@gnu.org>
parents:
diff changeset
244 preserving the columns of all nonblank text. @kbd{M-x tabify} scans the
Dave Love <fx@gnu.org>
parents:
diff changeset
245 region for sequences of spaces, and converts sequences of at least three
Dave Love <fx@gnu.org>
parents:
diff changeset
246 spaces to tabs if that can be done without changing indentation. @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
247 untabify} changes all tabs in the region to appropriate numbers of spaces.
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51298
diff changeset
248
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51298
diff changeset
249 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51298
diff changeset
250 arch-tag: acc07de7-ae11-4ee8-a159-cb59c473f0fb
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51298
diff changeset
251 @end ignore