]> code.delx.au - gnu-emacs/blob - man/text.texi
Don't use the British spelling of "behaviour".
[gnu-emacs] / man / text.texi
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000
3 @c Free Software Foundation, Inc.
4 @c See file emacs.texi for copying conditions.
5 @node Text, Programs, Indentation, Top
6 @chapter Commands for Human Languages
7 @cindex text
8 @cindex manipulating text
9
10 The term @dfn{text} has two widespread meanings in our area of the
11 computer field. One is data that is a sequence of characters. Any file
12 that you edit with Emacs is text, in this sense of the word. The other
13 meaning is more restrictive: a sequence of characters in a human language
14 for humans to read (possibly after processing by a text formatter), as
15 opposed to a program or commands for a program.
16
17 Human languages have syntactic/stylistic conventions that can be
18 supported or used to advantage by editor commands: conventions involving
19 words, sentences, paragraphs, and capital letters. This chapter
20 describes Emacs commands for all of these things. There are also
21 commands for @dfn{filling}, which means rearranging the lines of a
22 paragraph to be approximately equal in length. The commands for moving
23 over and killing words, sentences and paragraphs, while intended
24 primarily for editing text, are also often useful for editing programs.
25
26 Emacs has several major modes for editing human-language text. If the
27 file contains text pure and simple, use Text mode, which customizes
28 Emacs in small ways for the syntactic conventions of text. Outline mode
29 provides special commands for operating on text with an outline
30 structure.
31 @iftex
32 @xref{Outline Mode}.
33 @end iftex
34
35 For text which contains embedded commands for text formatters, Emacs
36 has other major modes, each for a particular text formatter. Thus, for
37 input to @TeX{}, you would use @TeX{}
38 @iftex
39 mode (@pxref{TeX Mode}).
40 @end iftex
41 @ifinfo
42 mode.
43 @end ifinfo
44 For input to nroff, use Nroff mode.
45
46 Instead of using a text formatter, you can edit formatted text in
47 WYSIWYG style (``what you see is what you get''), with Enriched mode.
48 Then the formatting appears on the screen in Emacs while you edit.
49 @iftex
50 @xref{Formatted Text}.
51 @end iftex
52
53 The ``automatic typing'' features may be useful when writing text.
54 @xref{Top, Autotyping, autotype, Features for Automatic Typing}.
55
56 @menu
57 * Words:: Moving over and killing words.
58 * Sentences:: Moving over and killing sentences.
59 * Paragraphs:: Moving over paragraphs.
60 * Pages:: Moving over pages.
61 * Filling:: Filling or justifying text.
62 * Case:: Changing the case of text.
63 * Text Mode:: The major modes for editing text files.
64 * Outline Mode:: Editing outlines.
65 * TeX Mode:: Editing input to the formatter TeX.
66 * Nroff Mode:: Editing input to the formatter nroff.
67 * Formatted Text:: Editing formatted text directly in WYSIWYG fashion.
68 @end menu
69
70 @node Words
71 @section Words
72 @cindex words
73 @cindex Meta commands and words
74
75 Emacs has commands for moving over or operating on words. By convention,
76 the keys for them are all Meta characters.
77
78 @c widecommands
79 @table @kbd
80 @item M-f
81 Move forward over a word (@code{forward-word}).
82 @item M-b
83 Move backward over a word (@code{backward-word}).
84 @item M-d
85 Kill up to the end of a word (@code{kill-word}).
86 @item M-@key{DEL}
87 Kill back to the beginning of a word (@code{backward-kill-word}).
88 @item M-@@
89 Mark the end of the next word (@code{mark-word}).
90 @item M-t
91 Transpose two words or drag a word across other words
92 (@code{transpose-words}).
93 @end table
94
95 Notice how these keys form a series that parallels the character-based
96 @kbd{C-f}, @kbd{C-b}, @kbd{C-d}, @key{DEL} and @kbd{C-t}. @kbd{M-@@} is
97 cognate to @kbd{C-@@}, which is an alias for @kbd{C-@key{SPC}}.
98
99 @kindex M-f
100 @kindex M-b
101 @findex forward-word
102 @findex backward-word
103 The commands @kbd{M-f} (@code{forward-word}) and @kbd{M-b}
104 (@code{backward-word}) move forward and backward over words. These
105 Meta characters are thus analogous to the corresponding control
106 characters, @kbd{C-f} and @kbd{C-b}, which move over single characters
107 in the text. The analogy extends to numeric arguments, which serve as
108 repeat counts. @kbd{M-f} with a negative argument moves backward, and
109 @kbd{M-b} with a negative argument moves forward. Forward motion
110 stops right after the last letter of the word, while backward motion
111 stops right before the first letter.@refill
112
113 @kindex M-d
114 @findex kill-word
115 @kbd{M-d} (@code{kill-word}) kills the word after point. To be
116 precise, it kills everything from point to the place @kbd{M-f} would
117 move to. Thus, if point is in the middle of a word, @kbd{M-d} kills
118 just the part after point. If some punctuation comes between point and the
119 next word, it is killed along with the word. (If you wish to kill only the
120 next word but not the punctuation before it, simply do @kbd{M-f} to get
121 the end, and kill the word backwards with @kbd{M-@key{DEL}}.)
122 @kbd{M-d} takes arguments just like @kbd{M-f}.
123
124 @findex backward-kill-word
125 @kindex M-DEL
126 @kbd{M-@key{DEL}} (@code{backward-kill-word}) kills the word before
127 point. It kills everything from point back to where @kbd{M-b} would
128 move to. If point is after the space in @w{@samp{FOO, BAR}}, then
129 @w{@samp{FOO, }} is killed. (If you wish to kill just @samp{FOO}, and
130 not the comma and the space, use @kbd{M-b M-d} instead of
131 @kbd{M-@key{DEL}}.)
132
133 @c Don't index M-t and transpose-words here, they are indexed in
134 @c fixit.texi, in the node "Transpose".
135 @c @kindex M-t
136 @c @findex transpose-words
137 @kbd{M-t} (@code{transpose-words}) exchanges the word before or
138 containing point with the following word. The delimiter characters between
139 the words do not move. For example, @w{@samp{FOO, BAR}} transposes into
140 @w{@samp{BAR, FOO}} rather than @samp{@w{BAR FOO,}}. @xref{Transpose}, for
141 more on transposition and on arguments to transposition commands.
142
143 @kindex M-@@
144 @findex mark-word
145 To operate on the next @var{n} words with an operation which applies
146 between point and mark, you can either set the mark at point and then move
147 over the words, or you can use the command @kbd{M-@@} (@code{mark-word})
148 which does not move point, but sets the mark where @kbd{M-f} would move
149 to. @kbd{M-@@} accepts a numeric argument that says how many words to
150 scan for the place to put the mark. In Transient Mark mode, this command
151 activates the mark.
152
153 The word commands' understanding of syntax is completely controlled by
154 the syntax table. Any character can, for example, be declared to be a word
155 delimiter. @xref{Syntax}.
156
157 @node Sentences
158 @section Sentences
159 @cindex sentences
160 @cindex manipulating sentences
161
162 The Emacs commands for manipulating sentences and paragraphs are mostly
163 on Meta keys, so as to be like the word-handling commands.
164
165 @table @kbd
166 @item M-a
167 Move back to the beginning of the sentence (@code{backward-sentence}).
168 @item M-e
169 Move forward to the end of the sentence (@code{forward-sentence}).
170 @item M-k
171 Kill forward to the end of the sentence (@code{kill-sentence}).
172 @item C-x @key{DEL}
173 Kill back to the beginning of the sentence (@code{backward-kill-sentence}).
174 @end table
175
176 @kindex M-a
177 @kindex M-e
178 @findex backward-sentence
179 @findex forward-sentence
180 The commands @kbd{M-a} and @kbd{M-e} (@code{backward-sentence} and
181 @code{forward-sentence}) move to the beginning and end of the current
182 sentence, respectively. They were chosen to resemble @kbd{C-a} and
183 @kbd{C-e}, which move to the beginning and end of a line. Unlike them,
184 @kbd{M-a} and @kbd{M-e} if repeated or given numeric arguments move over
185 successive sentences.
186
187 Moving backward over a sentence places point just before the first
188 character of the sentence; moving forward places point right after the
189 punctuation that ends the sentence. Neither one moves over the
190 whitespace at the sentence boundary.
191
192 @kindex M-k
193 @kindex C-x DEL
194 @findex kill-sentence
195 @findex backward-kill-sentence
196 Just as @kbd{C-a} and @kbd{C-e} have a kill command, @kbd{C-k}, to go
197 with them, so @kbd{M-a} and @kbd{M-e} have a corresponding kill command
198 @kbd{M-k} (@code{kill-sentence}) which kills from point to the end of
199 the sentence. With minus one as an argument it kills back to the
200 beginning of the sentence. Larger arguments serve as a repeat count.
201 There is also a command, @kbd{C-x @key{DEL}}
202 (@code{backward-kill-sentence}), for killing back to the beginning of a
203 sentence. This command is useful when you change your mind in the
204 middle of composing text.@refill
205
206 The sentence commands assume that you follow the American typist's
207 convention of putting two spaces at the end of a sentence; they consider
208 a sentence to end wherever there is a @samp{.}, @samp{?} or @samp{!}
209 followed by the end of a line or two spaces, with any number of
210 @samp{)}, @samp{]}, @samp{'}, or @samp{"} characters allowed in between.
211 A sentence also begins or ends wherever a paragraph begins or ends.
212
213 @vindex sentence-end
214 The variable @code{sentence-end} controls recognition of the end of a
215 sentence. It is a regexp that matches the last few characters of a
216 sentence, together with the whitespace following the sentence. Its
217 normal value is
218
219 @example
220 "[.?!][]\"')]*\\($\\| $\\|\t\\| \\)[ \t\n]*"
221 @end example
222
223 @noindent
224 This example is explained in the section on regexps. @xref{Regexps}.
225
226 If you want to use just one space between sentences, you should
227 set @code{sentence-end} to this value:
228
229 @example
230 "[.?!][]\"')]*\\($\\|\t\\| \\)[ \t\n]*"
231 @end example
232
233 @noindent
234 You should also set the variable @code{sentence-end-double-space} to
235 @code{nil} so that the fill commands expect and leave just one space at
236 the end of a sentence. Note that this makes it impossible to
237 distinguish between periods that end sentences and those that indicate
238 abbreviations.
239
240 @node Paragraphs
241 @section Paragraphs
242 @cindex paragraphs
243 @cindex manipulating paragraphs
244 @kindex M-@{
245 @kindex M-@}
246 @findex backward-paragraph
247 @findex forward-paragraph
248
249 The Emacs commands for manipulating paragraphs are also Meta keys.
250
251 @table @kbd
252 @item M-@{
253 Move back to previous paragraph beginning (@code{backward-paragraph}).
254 @item M-@}
255 Move forward to next paragraph end (@code{forward-paragraph}).
256 @item M-h
257 Put point and mark around this or next paragraph (@code{mark-paragraph}).
258 @end table
259
260 @kbd{M-@{} moves to the beginning of the current or previous
261 paragraph, while @kbd{M-@}} moves to the end of the current or next
262 paragraph. Blank lines and text-formatter command lines separate
263 paragraphs and are not considered part of any paragraph. In Fundamental
264 mode, but not in Text mode, an indented line also starts a new
265 paragraph. (If a paragraph is preceded by a blank line, these commands
266 treat that blank line as the beginning of the paragraph.)
267
268 In major modes for programs, paragraphs begin and end only at blank
269 lines. This makes the paragraph commands continue to be useful even
270 though there are no paragraphs per se.
271
272 When there is a fill prefix, then paragraphs are delimited by all lines
273 which don't start with the fill prefix. @xref{Filling}.
274
275 @kindex M-h
276 @findex mark-paragraph
277 When you wish to operate on a paragraph, you can use the command
278 @kbd{M-h} (@code{mark-paragraph}) to set the region around it. Thus,
279 for example, @kbd{M-h C-w} kills the paragraph around or after point.
280 The @kbd{M-h} command puts point at the beginning and mark at the end of
281 the paragraph point was in. In Transient Mark mode, it activates the
282 mark. If point is between paragraphs (in a run of blank lines, or at a
283 boundary), the paragraph following point is surrounded by point and
284 mark. If there are blank lines preceding the first line of the
285 paragraph, one of these blank lines is included in the region.
286
287 @vindex paragraph-start
288 @vindex paragraph-separate
289 The precise definition of a paragraph boundary is controlled by the
290 variables @code{paragraph-separate} and @code{paragraph-start}. The
291 value of @code{paragraph-start} is a regexp that should match any line
292 that either starts or separates paragraphs. The value of
293 @code{paragraph-separate} is another regexp that should match only lines
294 that separate paragraphs without being part of any paragraph (for
295 example, blank lines). Lines that start a new paragraph and are
296 contained in it must match only @code{paragraph-start}, not
297 @code{paragraph-separate}. For example, in Fundamental mode,
298 @code{paragraph-start} is @code{"[ @t{\}t@t{\}n@t{\}f]"} and
299 @code{paragraph-separate} is @code{"[ @t{\}t@t{\}f]*$"}.@refill
300
301 Normally it is desirable for page boundaries to separate paragraphs.
302 The default values of these variables recognize the usual separator for
303 pages.
304
305 @node Pages
306 @section Pages
307
308 @cindex pages
309 @cindex formfeed
310 Files are often thought of as divided into @dfn{pages} by the
311 @dfn{formfeed} character (ASCII control-L, octal code 014). When you
312 print hardcopy for a file, this character forces a page break; thus,
313 each page of the file goes on a separate page on paper. Most Emacs
314 commands treat the page-separator character just like any other
315 character: you can insert it with @kbd{C-q C-l}, and delete it with
316 @key{DEL}. Thus, you are free to paginate your file or not. However,
317 since pages are often meaningful divisions of the file, Emacs provides
318 commands to move over them and operate on them.
319
320 @c WideCommands
321 @table @kbd
322 @item C-x [
323 Move point to previous page boundary (@code{backward-page}).
324 @item C-x ]
325 Move point to next page boundary (@code{forward-page}).
326 @item C-x C-p
327 Put point and mark around this page (or another page) (@code{mark-page}).
328 @item C-x l
329 Count the lines in this page (@code{count-lines-page}).
330 @end table
331
332 @kindex C-x [
333 @kindex C-x ]
334 @findex forward-page
335 @findex backward-page
336 The @kbd{C-x [} (@code{backward-page}) command moves point to immediately
337 after the previous page delimiter. If point is already right after a page
338 delimiter, it skips that one and stops at the previous one. A numeric
339 argument serves as a repeat count. The @kbd{C-x ]} (@code{forward-page})
340 command moves forward past the next page delimiter.
341
342 @kindex C-x C-p
343 @findex mark-page
344 The @kbd{C-x C-p} command (@code{mark-page}) puts point at the
345 beginning of the current page and the mark at the end. The page
346 delimiter at the end is included (the mark follows it). The page
347 delimiter at the front is excluded (point follows it). @kbd{C-x C-p
348 C-w} is a handy way to kill a page to move it elsewhere. If you move to
349 another page delimiter with @kbd{C-x [} and @kbd{C-x ]}, then yank the
350 killed page, all the pages will be properly delimited once again. The
351 reason @kbd{C-x C-p} includes only the following page delimiter in the
352 region is to ensure that.
353
354 A numeric argument to @kbd{C-x C-p} is used to specify which page to go
355 to, relative to the current one. Zero means the current page. One means
356 the next page, and @minus{}1 means the previous one.
357
358 @kindex C-x l
359 @findex count-lines-page
360 The @kbd{C-x l} command (@code{count-lines-page}) is good for deciding
361 where to break a page in two. It prints in the echo area the total number
362 of lines in the current page, and then divides it up into those preceding
363 the current line and those following, as in
364
365 @example
366 Page has 96 (72+25) lines
367 @end example
368
369 @noindent
370 Notice that the sum is off by one; this is correct if point is not at the
371 beginning of a line.
372
373 @vindex page-delimiter
374 The variable @code{page-delimiter} controls where pages begin. Its
375 value is a regexp that matches the beginning of a line that separates
376 pages. The normal value of this variable is @code{"^@t{\}f"}, which
377 matches a formfeed character at the beginning of a line.
378
379 @node Filling
380 @section Filling Text
381 @cindex filling text
382
383 @dfn{Filling} text means breaking it up into lines that fit a
384 specified width. Emacs does filling in two ways. In Auto Fill mode,
385 inserting text with self-inserting characters also automatically fills
386 it. There are also explicit fill commands that you can use when editing
387 text leaves it unfilled. When you edit formatted text, you can specify
388 a style of filling for each portion of the text (@pxref{Formatted
389 Text}).
390
391 @menu
392 * Auto Fill:: Auto Fill mode breaks long lines automatically.
393 * Refill:: Keeping paragraphs filled.
394 * Fill Commands:: Commands to refill paragraphs and center lines.
395 * Fill Prefix:: Filling paragraphs that are indented
396 or in a comment, etc.
397 * Adaptive Fill:: How Emacs can determine the fill prefix automatically.
398 @end menu
399
400 @node Auto Fill
401 @subsection Auto Fill Mode
402 @cindex Auto Fill mode
403 @cindex mode, Auto Fill
404 @cindex word wrap
405
406 @dfn{Auto Fill} mode is a minor mode in which lines are broken
407 automatically when they become too wide. Breaking happens only when
408 you type a @key{SPC} or @key{RET}.
409
410 @table @kbd
411 @item M-x auto-fill-mode
412 Enable or disable Auto Fill mode.
413 @item @key{SPC}
414 @itemx @key{RET}
415 In Auto Fill mode, break lines when appropriate.
416 @end table
417
418 @findex auto-fill-mode
419 @kbd{M-x auto-fill-mode} turns Auto Fill mode on if it was off, or off
420 if it was on. With a positive numeric argument it always turns Auto
421 Fill mode on, and with a negative argument always turns it off. You can
422 see when Auto Fill mode is in effect by the presence of the word
423 @samp{Fill} in the mode line, inside the parentheses. Auto Fill mode is
424 a minor mode which is enabled or disabled for each buffer individually.
425 @xref{Minor Modes}.
426
427 In Auto Fill mode, lines are broken automatically at spaces when they
428 get longer than the desired width. Line breaking and rearrangement
429 takes place only when you type @key{SPC} or @key{RET}. If you wish to
430 insert a space or newline without permitting line-breaking, type
431 @kbd{C-q @key{SPC}} or @kbd{C-q C-j} (recall that a newline is really a
432 control-J). Also, @kbd{C-o} inserts a newline without line breaking.
433
434 Auto Fill mode works well with programming-language modes, because it
435 indents new lines with @key{TAB}. If a line ending in a comment gets
436 too long, the text of the comment is split into two comment lines.
437 Optionally, new comment delimiters are inserted at the end of the first
438 line and the beginning of the second so that each line is a separate
439 comment; the variable @code{comment-multi-line} controls the choice
440 (@pxref{Comments}).
441
442 Adaptive filling (see the following section) works for Auto Filling as
443 well as for explicit fill commands. It takes a fill prefix
444 automatically from the second or first line of a paragraph.
445
446 Auto Fill mode does not refill entire paragraphs; it can break lines but
447 cannot merge lines. So editing in the middle of a paragraph can result in
448 a paragraph that is not correctly filled. The easiest way to make the
449 paragraph properly filled again is usually with the explicit fill commands.
450 @ifinfo
451 @xref{Fill Commands}.
452 @end ifinfo
453
454 Many users like Auto Fill mode and want to use it in all text files.
455 The section on init files says how to arrange this permanently for yourself.
456 @xref{Init File}.
457
458 @node Refill
459 @subsection Refill Mode
460 @cindex refilling text, word processor style
461 @cindex modes, Refill
462 @cindex Refill minor mode
463
464 Refill minor mode provides support for keeping paragraphs filled as
465 you type or modify them in other ways. It provides an effect similar
466 to typical word processor behavior. This works by running a
467 paragraph-filling command at suitable times.
468
469 When you are typing text, only characters which normally trigger
470 auto filling, like the space character, will trigger refilling. This
471 is to avoid making it too slow. Apart from self-inserting characters,
472 other commands which modify the text cause refilling.
473
474 The current implementation is preliminary and probably not robust.
475 We expect to improve on it.
476
477 To toggle the use of Refill mode in the current buffer, type
478 @kbd{M-x refill-mode}.
479
480 @node Fill Commands
481 @subsection Explicit Fill Commands
482
483 @table @kbd
484 @item M-q
485 Fill current paragraph (@code{fill-paragraph}).
486 @item C-x f
487 Set the fill column (@code{set-fill-column}).
488 @item M-x fill-region
489 Fill each paragraph in the region (@code{fill-region}).
490 @item M-x fill-region-as-paragraph
491 Fill the region, considering it as one paragraph.
492 @item M-s
493 Center a line.
494 @end table
495
496 @kindex M-q
497 @findex fill-paragraph
498 To refill a paragraph, use the command @kbd{M-q}
499 (@code{fill-paragraph}). This operates on the paragraph that point is
500 inside, or the one after point if point is between paragraphs.
501 Refilling works by removing all the line-breaks, then inserting new ones
502 where necessary.
503
504 @findex fill-region
505 To refill many paragraphs, use @kbd{M-x fill-region}, which
506 divides the region into paragraphs and fills each of them.
507
508 @findex fill-region-as-paragraph
509 @kbd{M-q} and @code{fill-region} use the same criteria as @kbd{M-h}
510 for finding paragraph boundaries (@pxref{Paragraphs}). For more
511 control, you can use @kbd{M-x fill-region-as-paragraph}, which refills
512 everything between point and mark. This command deletes any blank lines
513 within the region, so separate blocks of text end up combined into one
514 block.@refill
515
516 @cindex justification
517 A numeric argument to @kbd{M-q} causes it to @dfn{justify} the text as
518 well as filling it. This means that extra spaces are inserted to make
519 the right margin line up exactly at the fill column. To remove the
520 extra spaces, use @kbd{M-q} with no argument. (Likewise for
521 @code{fill-region}.) Another way to control justification, and choose
522 other styles of filling, is with the @code{justification} text property;
523 see @ref{Format Justification}.
524
525 @kindex M-s @r{(Text mode)}
526 @cindex centering
527 @findex center-line
528 The command @kbd{M-s} (@code{center-line}) centers the current line
529 within the current fill column. With an argument @var{n}, it centers
530 @var{n} lines individually and moves past them.
531
532 @vindex fill-column
533 @kindex C-x f
534 @findex set-fill-column
535 The maximum line width for filling is in the variable
536 @code{fill-column}. Altering the value of @code{fill-column} makes it
537 local to the current buffer; until that time, the default value is in
538 effect. The default is initially 70. @xref{Locals}. The easiest way
539 to set @code{fill-column} is to use the command @kbd{C-x f}
540 (@code{set-fill-column}). With a numeric argument, it uses that as the
541 new fill column. With just @kbd{C-u} as argument, it sets
542 @code{fill-column} to the current horizontal position of point.
543
544 Emacs commands normally consider a period followed by two spaces or by
545 a newline as the end of a sentence; a period followed by just one space
546 indicates an abbreviation and not the end of a sentence. To preserve
547 the distinction between these two ways of using a period, the fill
548 commands do not break a line after a period followed by just one space.
549
550 @vindex sentence-end-double-space
551 If the variable @code{sentence-end-double-space} is @code{nil}, the
552 fill commands expect and leave just one space at the end of a sentence.
553 Ordinarily this variable is @code{t}, so the fill commands insist on
554 two spaces for the end of a sentence, as explained above. @xref{Sentences}.
555
556 @vindex colon-double-space
557 If the variable @code{colon-double-space} is non-@code{nil}, the
558 fill commands put two spaces after a colon.
559
560 @vindex sentence-end-without-period
561 Some languages do not use period to indicate end of sentence. For
562 example, a sentence in Thai text ends with double space but without a
563 period. Set the variable @code{sentence-end-without-period} to
564 @code{t} to tell the sentence commands that a period is not necessary.
565
566 @node Fill Prefix
567 @subsection The Fill Prefix
568
569 @cindex fill prefix
570 To fill a paragraph in which each line starts with a special marker
571 (which might be a few spaces, giving an indented paragraph), you can use
572 the @dfn{fill prefix} feature. The fill prefix is a string that Emacs
573 expects every line to start with, and which is not included in filling.
574 You can specify a fill prefix explicitly; Emacs can also deduce the
575 fill prefix automatically (@pxref{Adaptive Fill}).
576
577 @table @kbd
578 @item C-x .
579 Set the fill prefix (@code{set-fill-prefix}).
580 @item M-q
581 Fill a paragraph using current fill prefix (@code{fill-paragraph}).
582 @item M-x fill-individual-paragraphs
583 Fill the region, considering each change of indentation as starting a
584 new paragraph.
585 @item M-x fill-nonuniform-paragraphs
586 Fill the region, considering only paragraph-separator lines as starting
587 a new paragraph.
588 @end table
589
590 @kindex C-x .
591 @findex set-fill-prefix
592 To specify a fill prefix, move to a line that starts with the desired
593 prefix, put point at the end of the prefix, and give the command
594 @w{@kbd{C-x .}}@: (@code{set-fill-prefix}). That's a period after the
595 @kbd{C-x}. To turn off the fill prefix, specify an empty prefix: type
596 @w{@kbd{C-x .}}@: with point at the beginning of a line.@refill
597
598 When a fill prefix is in effect, the fill commands remove the fill
599 prefix from each line before filling and insert it on each line after
600 filling. Auto Fill mode also inserts the fill prefix automatically when
601 it makes a new line. The @kbd{C-o} command inserts the fill prefix on
602 new lines it creates, when you use it at the beginning of a line
603 (@pxref{Blank Lines}). Conversely, the command @kbd{M-^} deletes the
604 prefix (if it occurs) after the newline that it deletes
605 (@pxref{Indentation}).
606
607 For example, if @code{fill-column} is 40 and you set the fill prefix
608 to @samp{;; }, then @kbd{M-q} in the following text
609
610 @example
611 ;; This is an
612 ;; example of a paragraph
613 ;; inside a Lisp-style comment.
614 @end example
615
616 @noindent
617 produces this:
618
619 @example
620 ;; This is an example of a paragraph
621 ;; inside a Lisp-style comment.
622 @end example
623
624 Lines that do not start with the fill prefix are considered to start
625 paragraphs, both in @kbd{M-q} and the paragraph commands; this gives
626 good results for paragraphs with hanging indentation (every line
627 indented except the first one). Lines which are blank or indented once
628 the prefix is removed also separate or start paragraphs; this is what
629 you want if you are writing multi-paragraph comments with a comment
630 delimiter on each line.
631
632 @findex fill-individual-paragraphs
633 You can use @kbd{M-x fill-individual-paragraphs} to set the fill
634 prefix for each paragraph automatically. This command divides the
635 region into paragraphs, treating every change in the amount of
636 indentation as the start of a new paragraph, and fills each of these
637 paragraphs. Thus, all the lines in one ``paragraph'' have the same
638 amount of indentation. That indentation serves as the fill prefix for
639 that paragraph.
640
641 @findex fill-nonuniform-paragraphs
642 @kbd{M-x fill-nonuniform-paragraphs} is a similar command that divides
643 the region into paragraphs in a different way. It considers only
644 paragraph-separating lines (as defined by @code{paragraph-separate}) as
645 starting a new paragraph. Since this means that the lines of one
646 paragraph may have different amounts of indentation, the fill prefix
647 used is the smallest amount of indentation of any of the lines of the
648 paragraph. This gives good results with styles that indent a paragraph's
649 first line more or less that the rest of the paragraph.
650
651 @vindex fill-prefix
652 The fill prefix is stored in the variable @code{fill-prefix}. Its value
653 is a string, or @code{nil} when there is no fill prefix. This is a
654 per-buffer variable; altering the variable affects only the current buffer,
655 but there is a default value which you can change as well. @xref{Locals}.
656
657 The @code{indentation} text property provides another way to control
658 the amount of indentation paragraphs receive. @xref{Format Indentation}.
659
660 @node Adaptive Fill
661 @subsection Adaptive Filling
662
663 @cindex adaptive filling
664 The fill commands can deduce the proper fill prefix for a paragraph
665 automatically in certain cases: either whitespace or certain punctuation
666 characters at the beginning of a line are propagated to all lines of the
667 paragraph.
668
669 If the paragraph has two or more lines, the fill prefix is taken from
670 the paragraph's second line, but only if it appears on the first line as
671 well.
672
673 If a paragraph has just one line, fill commands @emph{may} take a
674 prefix from that line. The decision is complicated because there are
675 three reasonable things to do in such a case:
676
677 @itemize @bullet
678 @item
679 Use the first line's prefix on all the lines of the paragraph.
680
681 @item
682 Indent subsequent lines with whitespace, so that they line up under the
683 text that follows the prefix on the first line, but don't actually copy
684 the prefix from the first line.
685
686 @item
687 Don't do anything special with the second and following lines.
688 @end itemize
689
690 All three of these styles of formatting are commonly used. So the
691 fill commands try to determine what you would like, based on the prefix
692 that appears and on the major mode. Here is how.
693
694 @vindex adaptive-fill-first-line-regexp
695 If the prefix found on the first line matches
696 @code{adaptive-fill-first-line-regexp}, or if it appears to be a
697 comment-starting sequence (this depends on the major mode), then the
698 prefix found is used for filling the paragraph, provided it would not
699 act as a paragraph starter on subsequent lines.
700
701 Otherwise, the prefix found is converted to an equivalent number of
702 spaces, and those spaces are used as the fill prefix for the rest of the
703 lines, provided they would not act as a paragraph starter on subsequent
704 lines.
705
706 In Text mode, and other modes where only blank lines and page
707 delimiters separate paragraphs, the prefix chosen by adaptive filling
708 never acts as a paragraph starter, so it can always be used for filling.
709
710 @vindex adaptive-fill-mode
711 @vindex adaptive-fill-regexp
712 The variable @code{adaptive-fill-regexp} determines what kinds of line
713 beginnings can serve as a fill prefix: any characters at the start of
714 the line that match this regular expression are used. If you set the
715 variable @code{adaptive-fill-mode} to @code{nil}, the fill prefix is
716 never chosen automatically.
717
718 @vindex adaptive-fill-function
719 You can specify more complex ways of choosing a fill prefix
720 automatically by setting the variable @code{adaptive-fill-function} to a
721 function. This function is called with point after the left margin of a
722 line, and it should return the appropriate fill prefix based on that
723 line. If it returns @code{nil}, that means it sees no fill prefix in
724 that line.
725
726 @node Case
727 @section Case Conversion Commands
728 @cindex case conversion
729
730 Emacs has commands for converting either a single word or any arbitrary
731 range of text to upper case or to lower case.
732
733 @c WideCommands
734 @table @kbd
735 @item M-l
736 Convert following word to lower case (@code{downcase-word}).
737 @item M-u
738 Convert following word to upper case (@code{upcase-word}).
739 @item M-c
740 Capitalize the following word (@code{capitalize-word}).
741 @item C-x C-l
742 Convert region to lower case (@code{downcase-region}).
743 @item C-x C-u
744 Convert region to upper case (@code{upcase-region}).
745 @end table
746
747 @kindex M-l
748 @kindex M-u
749 @kindex M-c
750 @cindex words, case conversion
751 @cindex converting text to upper or lower case
752 @cindex capitalizing words
753 @findex downcase-word
754 @findex upcase-word
755 @findex capitalize-word
756 The word conversion commands are the most useful. @kbd{M-l}
757 (@code{downcase-word}) converts the word after point to lower case, moving
758 past it. Thus, repeating @kbd{M-l} converts successive words.
759 @kbd{M-u} (@code{upcase-word}) converts to all capitals instead, while
760 @kbd{M-c} (@code{capitalize-word}) puts the first letter of the word
761 into upper case and the rest into lower case. All these commands convert
762 several words at once if given an argument. They are especially convenient
763 for converting a large amount of text from all upper case to mixed case,
764 because you can move through the text using @kbd{M-l}, @kbd{M-u} or
765 @kbd{M-c} on each word as appropriate, occasionally using @kbd{M-f} instead
766 to skip a word.
767
768 When given a negative argument, the word case conversion commands apply
769 to the appropriate number of words before point, but do not move point.
770 This is convenient when you have just typed a word in the wrong case: you
771 can give the case conversion command and continue typing.
772
773 If a word case conversion command is given in the middle of a word, it
774 applies only to the part of the word which follows point. This is just
775 like what @kbd{M-d} (@code{kill-word}) does. With a negative argument,
776 case conversion applies only to the part of the word before point.
777
778 @kindex C-x C-l
779 @kindex C-x C-u
780 @findex downcase-region
781 @findex upcase-region
782 The other case conversion commands are @kbd{C-x C-u}
783 (@code{upcase-region}) and @kbd{C-x C-l} (@code{downcase-region}), which
784 convert everything between point and mark to the specified case. Point and
785 mark do not move.
786
787 The region case conversion commands @code{upcase-region} and
788 @code{downcase-region} are normally disabled. This means that they ask
789 for confirmation if you try to use them. When you confirm, you may
790 enable the command, which means it will not ask for confirmation again.
791 @xref{Disabling}.
792
793 @node Text Mode
794 @section Text Mode
795 @cindex Text mode
796 @cindex mode, Text
797 @findex text-mode
798
799 When you edit files of text in a human language, it's more convenient
800 to use Text mode rather than Fundamental mode. To enter Text mode, type
801 @kbd{M-x text-mode}.
802
803 In Text mode, only blank lines and page delimiters separate
804 paragraphs. As a result, paragraphs can be indented, and adaptive
805 filling determines what indentation to use when filling a paragraph.
806 @xref{Adaptive Fill}.
807
808 @kindex TAB @r{(Text mode)}
809 Text mode defines @key{TAB} to run @code{indent-relative}
810 (@pxref{Indentation}), so that you can conveniently indent a line like
811 the previous line. When the previous line is not indented,
812 @code{indent-relative} runs @code{tab-to-tab-stop}, which uses Emacs tab
813 stops that you can set (@pxref{Tab Stops}).
814
815 Text mode turns off the features concerned with comments except when
816 you explicitly invoke them. It changes the syntax table so that periods
817 are not considered part of a word, while apostrophes, backspaces and
818 underlines are considered part of words.
819
820 @cindex Paragraph-Indent Text mode
821 @cindex mode, Paragraph-Indent Text
822 @findex paragraph-indent-text-mode
823 @findex paragraph-indent-minor-mode
824 If you indent the first lines of paragraphs, then you should use
825 Paragraph-Indent Text mode rather than Text mode. In this mode, you do
826 not need to have blank lines between paragraphs, because the first-line
827 indentation is sufficient to start a paragraph; however paragraphs in
828 which every line is indented are not supported. Use @kbd{M-x
829 paragraph-indent-text-mode} to enter this mode. Use @kbd{M-x
830 paragraph-indent-minor-mode} to enter an equivalent minor mode, for
831 instance during mail composition.
832
833 @kindex M-TAB @r{(Text mode)}
834 Text mode, and all the modes based on it, define @kbd{M-@key{TAB}} as
835 the command @code{ispell-complete-word}, which performs completion of
836 the partial word in the buffer before point, using the spelling
837 dictionary as the space of possible words. @xref{Spelling}.
838
839 @vindex text-mode-hook
840 Entering Text mode runs the hook @code{text-mode-hook}. Other major
841 modes related to Text mode also run this hook, followed by hooks of
842 their own; this includes Paragraph-Indent Text mode, Nroff mode, @TeX{}
843 mode, Outline mode, and Mail mode. Hook functions on
844 @code{text-mode-hook} can look at the value of @code{major-mode} to see
845 which of these modes is actually being entered. @xref{Hooks}.
846
847 @ifinfo
848 Emacs provides two other modes for editing text that is to be passed
849 through a text formatter to produce fancy formatted printed output.
850 @xref{Nroff Mode}, for editing input to the formatter nroff.
851 @xref{TeX Mode}, for editing input to the formatter TeX.
852
853 Another mode is used for editing outlines. It allows you to view the
854 text at various levels of detail. You can view either the outline
855 headings alone or both headings and text; you can also hide some of the
856 headings at lower levels from view to make the high level structure more
857 visible. @xref{Outline Mode}.
858 @end ifinfo
859
860 @node Outline Mode
861 @section Outline Mode
862 @cindex Outline mode
863 @cindex mode, Outline
864 @cindex invisible lines
865
866 @findex outline-mode
867 @findex outline-minor-mode
868 @vindex outline-minor-mode-prefix
869 Outline mode is a major mode much like Text mode but intended for
870 editing outlines. It allows you to make parts of the text temporarily
871 invisible so that you can see the outline structure. Type @kbd{M-x
872 outline-mode} to switch to Outline mode as the major mode of the current
873 buffer.
874
875 When Outline mode makes a line invisible, the line does not appear on
876 the screen. The screen appears exactly as if the invisible line were
877 deleted, except that an ellipsis (three periods in a row) appears at the
878 end of the previous visible line (only one ellipsis no matter how many
879 invisible lines follow).
880
881 Editing commands that operate on lines, such as @kbd{C-n} and
882 @kbd{C-p}, treat the text of the invisible line as part of the previous
883 visible line. Killing an entire visible line, including its terminating
884 newline, really kills all the following invisible lines along with it.
885
886 Outline minor mode provides the same commands as the major mode,
887 Outline mode, but you can use it in conjunction with other major modes.
888 Type @kbd{M-x outline-minor-mode} to enable the Outline minor mode in
889 the current buffer. You can also specify this in the text of a file,
890 with a file local variable of the form @samp{mode: outline-minor}
891 (@pxref{File Variables}).
892
893 @kindex C-c @@ @r{(Outline minor mode)}
894 The major mode, Outline mode, provides special key bindings on the
895 @kbd{C-c} prefix. Outline minor mode provides similar bindings with
896 @kbd{C-c @@} as the prefix; this is to reduce the conflicts with the
897 major mode's special commands. (The variable
898 @code{outline-minor-mode-prefix} controls the prefix used.)
899
900 @vindex outline-mode-hook
901 Entering Outline mode runs the hook @code{text-mode-hook} followed by
902 the hook @code{outline-mode-hook} (@pxref{Hooks}).
903
904 @menu
905 * Format: Outline Format. What the text of an outline looks like.
906 * Motion: Outline Motion. Special commands for moving through
907 outlines.
908 * Visibility: Outline Visibility. Commands to control what is visible.
909 * Views: Outline Views. Outlines and multiple views.
910 * Foldout:: Folding editing.
911 @end menu
912
913 @node Outline Format
914 @subsection Format of Outlines
915
916 @cindex heading lines (Outline mode)
917 @cindex body lines (Outline mode)
918 Outline mode assumes that the lines in the buffer are of two types:
919 @dfn{heading lines} and @dfn{body lines}. A heading line represents a
920 topic in the outline. Heading lines start with one or more stars; the
921 number of stars determines the depth of the heading in the outline
922 structure. Thus, a heading line with one star is a major topic; all the
923 heading lines with two stars between it and the next one-star heading
924 are its subtopics; and so on. Any line that is not a heading line is a
925 body line. Body lines belong with the preceding heading line. Here is
926 an example:
927
928 @example
929 * Food
930 This is the body,
931 which says something about the topic of food.
932
933 ** Delicious Food
934 This is the body of the second-level header.
935
936 ** Distasteful Food
937 This could have
938 a body too, with
939 several lines.
940
941 *** Dormitory Food
942
943 * Shelter
944 Another first-level topic with its header line.
945 @end example
946
947 A heading line together with all following body lines is called
948 collectively an @dfn{entry}. A heading line together with all following
949 deeper heading lines and their body lines is called a @dfn{subtree}.
950
951 @vindex outline-regexp
952 You can customize the criterion for distinguishing heading lines
953 by setting the variable @code{outline-regexp}. Any line whose
954 beginning has a match for this regexp is considered a heading line.
955 Matches that start within a line (not at the left margin) do not count.
956 The length of the matching text determines the level of the heading;
957 longer matches make a more deeply nested level. Thus, for example,
958 if a text formatter has commands @samp{@@chapter}, @samp{@@section}
959 and @samp{@@subsection} to divide the document into chapters and
960 sections, you could make those lines count as heading lines by
961 setting @code{outline-regexp} to @samp{"@@chap\\|@@\\(sub\\)*section"}.
962 Note the trick: the two words @samp{chapter} and @samp{section} are equally
963 long, but by defining the regexp to match only @samp{chap} we ensure
964 that the length of the text matched on a chapter heading is shorter,
965 so that Outline mode will know that sections are contained in chapters.
966 This works as long as no other command starts with @samp{@@chap}.
967
968 @vindex outline-level
969 You can change the rule for calculating the level of a heading line
970 by setting the variable @code{outline-level}. The value of
971 @code{outline-level} should be a function that takes no arguments and
972 returns the level of the current heading. Some major modes such as C,
973 Nroff, and Emacs Lisp mode set this variable and @code{outline-regexp}
974 in order to work with Outline minor mode.
975
976 @node Outline Motion
977 @subsection Outline Motion Commands
978
979 Outline mode provides special motion commands that move backward and
980 forward to heading lines.
981
982 @table @kbd
983 @item C-c C-n
984 Move point to the next visible heading line
985 (@code{outline-next-visible-heading}).
986 @item C-c C-p
987 Move point to the previous visible heading line
988 (@code{outline-previous-visible-heading}).
989 @item C-c C-f
990 Move point to the next visible heading line at the same level
991 as the one point is on (@code{outline-forward-same-level}).
992 @item C-c C-b
993 Move point to the previous visible heading line at the same level
994 (@code{outline-backward-same-level}).
995 @item C-c C-u
996 Move point up to a lower-level (more inclusive) visible heading line
997 (@code{outline-up-heading}).
998 @end table
999
1000 @findex outline-next-visible-heading
1001 @findex outline-previous-visible-heading
1002 @kindex C-c C-n @r{(Outline mode)}
1003 @kindex C-c C-p @r{(Outline mode)}
1004 @kbd{C-c C-n} (@code{outline-next-visible-heading}) moves down to the next
1005 heading line. @kbd{C-c C-p} (@code{outline-previous-visible-heading}) moves
1006 similarly backward. Both accept numeric arguments as repeat counts. The
1007 names emphasize that invisible headings are skipped, but this is not really
1008 a special feature. All editing commands that look for lines ignore the
1009 invisible lines automatically.@refill
1010
1011 @findex outline-up-heading
1012 @findex outline-forward-same-level
1013 @findex outline-backward-same-level
1014 @kindex C-c C-f @r{(Outline mode)}
1015 @kindex C-c C-b @r{(Outline mode)}
1016 @kindex C-c C-u @r{(Outline mode)}
1017 More powerful motion commands understand the level structure of headings.
1018 @kbd{C-c C-f} (@code{outline-forward-same-level}) and
1019 @kbd{C-c C-b} (@code{outline-backward-same-level}) move from one
1020 heading line to another visible heading at the same depth in
1021 the outline. @kbd{C-c C-u} (@code{outline-up-heading}) moves
1022 backward to another heading that is less deeply nested.
1023
1024 @node Outline Visibility
1025 @subsection Outline Visibility Commands
1026
1027 The other special commands of outline mode are used to make lines visible
1028 or invisible. Their names all start with @code{hide} or @code{show}.
1029 Most of them fall into pairs of opposites. They are not undoable; instead,
1030 you can undo right past them. Making lines visible or invisible is simply
1031 not recorded by the undo mechanism.
1032
1033 @table @kbd
1034 @item C-c C-t
1035 Make all body lines in the buffer invisible (@code{hide-body}).
1036 @item C-c C-a
1037 Make all lines in the buffer visible (@code{show-all}).
1038 @item C-c C-d
1039 Make everything under this heading invisible, not including this
1040 heading itself (@code{hide-subtree}).
1041 @item C-c C-s
1042 Make everything under this heading visible, including body,
1043 subheadings, and their bodies (@code{show-subtree}).
1044 @item C-c C-l
1045 Make the body of this heading line, and of all its subheadings,
1046 invisible (@code{hide-leaves}).
1047 @item C-c C-k
1048 Make all subheadings of this heading line, at all levels, visible
1049 (@code{show-branches}).
1050 @item C-c C-i
1051 Make immediate subheadings (one level down) of this heading line
1052 visible (@code{show-children}).
1053 @item C-c C-c
1054 Make this heading line's body invisible (@code{hide-entry}).
1055 @item C-c C-e
1056 Make this heading line's body visible (@code{show-entry}).
1057 @item C-c C-q
1058 Hide everything except the top @var{n} levels of heading lines
1059 (@code{hide-sublevels}).
1060 @item C-c C-o
1061 Hide everything except for the heading or body that point is in, plus
1062 the headings leading up from there to the top level of the outline
1063 (@code{hide-other}).
1064 @end table
1065
1066 @findex hide-entry
1067 @findex show-entry
1068 @kindex C-c C-c @r{(Outline mode)}
1069 @kindex C-c C-e @r{(Outline mode)}
1070 Two commands that are exact opposites are @kbd{C-c C-c}
1071 (@code{hide-entry}) and @kbd{C-c C-e} (@code{show-entry}). They are
1072 used with point on a heading line, and apply only to the body lines of
1073 that heading. Subheadings and their bodies are not affected.
1074
1075 @findex hide-subtree
1076 @findex show-subtree
1077 @kindex C-c C-s @r{(Outline mode)}
1078 @kindex C-c C-d @r{(Outline mode)}
1079 @cindex subtree (Outline mode)
1080 Two more powerful opposites are @kbd{C-c C-d} (@code{hide-subtree}) and
1081 @kbd{C-c C-s} (@code{show-subtree}). Both expect to be used when point is
1082 on a heading line, and both apply to all the lines of that heading's
1083 @dfn{subtree}: its body, all its subheadings, both direct and indirect, and
1084 all of their bodies. In other words, the subtree contains everything
1085 following this heading line, up to and not including the next heading of
1086 the same or higher rank.@refill
1087
1088 @findex hide-leaves
1089 @findex show-branches
1090 @kindex C-c C-l @r{(Outline mode)}
1091 @kindex C-c C-k @r{(Outline mode)}
1092 Intermediate between a visible subtree and an invisible one is having
1093 all the subheadings visible but none of the body. There are two
1094 commands for doing this, depending on whether you want to hide the
1095 bodies or make the subheadings visible. They are @kbd{C-c C-l}
1096 (@code{hide-leaves}) and @kbd{C-c C-k} (@code{show-branches}).
1097
1098 @kindex C-c C-i @r{(Outline mode)}
1099 @findex show-children
1100 A little weaker than @code{show-branches} is @kbd{C-c C-i}
1101 (@code{show-children}). It makes just the direct subheadings
1102 visible---those one level down. Deeper subheadings remain invisible, if
1103 they were invisible.@refill
1104
1105 @findex hide-body
1106 @findex show-all
1107 @kindex C-c C-t @r{(Outline mode)}
1108 @kindex C-c C-a @r{(Outline mode)}
1109 Two commands have a blanket effect on the whole file. @kbd{C-c C-t}
1110 (@code{hide-body}) makes all body lines invisible, so that you see just
1111 the outline structure. @kbd{C-c C-a} (@code{show-all}) makes all lines
1112 visible. These commands can be thought of as a pair of opposites even
1113 though @kbd{C-c C-a} applies to more than just body lines.
1114
1115 @findex hide-sublevels
1116 @kindex C-c C-q @r{(Outline mode)}
1117 The command @kbd{C-c C-q} (@code{hide-sublevels}) hides all but the
1118 top level headings. With a numeric argument @var{n}, it hides everything
1119 except the top @var{n} levels of heading lines.
1120
1121 @findex hide-other
1122 @kindex C-c C-o @r{(Outline mode)}
1123 The command @kbd{C-c C-o} (@code{hide-other}) hides everything except
1124 the heading or body text that point is in, plus its parents (the headers
1125 leading up from there to top level in the outline).
1126
1127 You can turn off the use of ellipses at the ends of visible lines by
1128 setting @code{selective-display-ellipses} to @code{nil}. Then there is
1129 no visible indication of the presence of invisible lines.
1130
1131 When incremental search finds text that is hidden by Outline mode,
1132 it makes that part of the buffer visible. If you exit the search
1133 at that position, the text remains visible.
1134
1135 @node Outline Views
1136 @subsection Viewing One Outline in Multiple Views
1137
1138 @cindex multiple views of outline
1139 @cindex views of an outline
1140 @cindex outline with multiple views
1141 @cindex indirect buffers and outlines
1142 You can display two views of a single outline at the same time, in
1143 different windows. To do this, you must create an indirect buffer using
1144 @kbd{M-x make-indirect-buffer}. The first argument of this command is
1145 the existing outline buffer name, and its second argument is the name to
1146 use for the new indirect buffer. @xref{Indirect Buffers}.
1147
1148 Once the indirect buffer exists, you can display it in a window in the
1149 normal fashion, with @kbd{C-x 4 b} or other Emacs commands. The Outline
1150 mode commands to show and hide parts of the text operate on each buffer
1151 independently; as a result, each buffer can have its own view. If you
1152 want more than two views on the same outline, create additional indirect
1153 buffers.
1154
1155 @node Foldout
1156 @subsection Folding Editing
1157
1158 @cindex folding editing
1159 The Foldout package extends Outline mode and Outline minor mode with
1160 ``folding'' commands. The idea of folding is that you zoom in on a
1161 nested portion of the outline, while hiding its relatives at higher
1162 levels.
1163
1164 Consider an Outline mode buffer all the text and subheadings under
1165 level-1 headings hidden. To look at what is hidden under one of these
1166 headings, you could use @kbd{C-c C-e} (@kbd{M-x show-entry}) to expose
1167 the body, or @kbd{C-c C-i} to expose the child (level-2) headings.
1168
1169 @kindex C-c C-z
1170 @findex foldout-zoom-subtree
1171 With Foldout, you use @kbd{C-c C-z} (@kbd{M-x foldout-zoom-subtree}).
1172 This exposes the body and child subheadings, and narrows the buffer so
1173 that only the level-1 heading, the body and the level-2 headings are
1174 visible. Now to look under one of the level-2 headings, position the
1175 cursor on it and use @kbd{C-c C-z} again. This exposes the level-2 body
1176 and its level-3 child subheadings and narrows the buffer again. Zooming
1177 in on successive subheadings can be done as much as you like. A string
1178 in the modeline shows how deep you've gone.
1179
1180 When zooming in on a heading, to see only the child subheadings specify
1181 a numeric argument: @kbd{C-u C-c C-z}. The number of levels of children
1182 can be specified too (compare @kbd{M-x show-children}), e.g.@: @kbd{M-2
1183 C-c C-z} exposes two levels of child subheadings. Alternatively, the
1184 body can be spcified with a negative argument: @kbd{M-- C-c C-z}. The
1185 whole subtree can be expanded, similarly to @kbd{C-c C-s} (@kbd{M-x
1186 show-subtree}), by specifying a zero argument: @kbd{M-0 C-c C-z}.
1187
1188 While you're zoomed in, you can still use Outline mode's exposure and
1189 hiding functions without disturbing Foldout. Also, since the buffer is
1190 narrowed, ``global'' editing actions will only affect text under the
1191 zoomed-in heading. This is useful for restricting changes to a
1192 particular chapter or section of your document.
1193
1194 @kindex C-c C-x
1195 @findex foldout-exit-fold
1196 To unzoom (exit) a fold, use @kbd{C-c C-x} (@kbd{M-x foldout-exit-fold}).
1197 This hides all the text and subheadings under the top-level heading and
1198 returns you to the previous view of the buffer. Specifying a numeric
1199 argument exits that many levels of folds. Specifying a zero argument exits all
1200 folds.
1201
1202 To cancel the narrowing of a fold without hiding the text and
1203 subheadings, specify a negative argument. For example, @kbd{M--2 C-c
1204 C-x} exits two folds and leaves the text and subheadings exposed.
1205
1206 Foldout mode also provides mouse commands for entering and exiting
1207 folds, and for showing and hiding text:
1208
1209 @table @asis
1210 @item @kbd{M-C-Mouse-1} zooms in on the heading clicked on
1211 @table @asis
1212 @item single click
1213 expose body.
1214 @item double click
1215 expose subheadings.
1216 @item triple click
1217 expose body and subheadings.
1218 @item quad click
1219 expose entire subtree.
1220 @end table
1221 @item @kbd{M-C-Mouse-2} exposes text under the heading clicked on
1222 @table @r
1223 @item single click
1224 expose body.
1225 @item double click
1226 expose subheadings.
1227 @item triple click
1228 expose body and subheadings.
1229 @item quad click
1230 expose entire subtree.
1231 @end table
1232 @item @kbd{M-C-Mouse-3} hides text under the heading clicked on or exits fold
1233 @table @r
1234 @item single click
1235 hide subtree.
1236 @item double click
1237 exit fold and hide text.
1238 @item triple click
1239 exit fold without hiding text.
1240 @item quad click
1241 exit all folds and hide text.
1242 @end table
1243 @end table
1244
1245 @vindex foldout-mouse-modifiers
1246 You can specify different modifier keys (instead of
1247 @kbd{Control-Meta-}) by setting @code{foldout-mouse-modifiers}; but if
1248 you have already loaded the @file{foldout.el} library, you must reload
1249 it in order for this to take effect.
1250
1251 To use the Foldout package, you can type @kbd{M-x load-library
1252 @key{RET} foldout @key{RET}}; or you can arrange for to do that
1253 automatically by putting this in your @file{.emacs} file:
1254
1255 @example
1256 (eval-after-load "outline" '(require 'foldout))
1257 @end example
1258
1259 @node TeX Mode, Nroff Mode, Outline Mode, Text
1260 @section @TeX{} Mode
1261 @cindex @TeX{} mode
1262 @cindex La@TeX{} mode
1263 @cindex Sli@TeX{} mode
1264 @cindex mode, @TeX{}
1265 @cindex mode, La@TeX{}
1266 @cindex mode, Sli@TeX{}
1267 @findex tex-mode
1268 @findex plain-tex-mode
1269 @findex latex-mode
1270 @findex slitex-mode
1271
1272 @TeX{} is a powerful text formatter written by Donald Knuth; it is also
1273 free, like GNU Emacs. La@TeX{} is a simplified input format for @TeX{},
1274 implemented by @TeX{} macros; it comes with @TeX{}. Sli@TeX{} is a special
1275 form of La@TeX{}.@footnote{Sli@TeX{} is obsoleted by the @samp{slides}
1276 document class in recent La@TeX{} versions.}
1277
1278 Emacs has a special @TeX{} mode for editing @TeX{} input files.
1279 It provides facilities for checking the balance of delimiters and for
1280 invoking @TeX{} on all or part of the file.
1281
1282 @vindex tex-default-mode
1283 @TeX{} mode has three variants, Plain @TeX{} mode, La@TeX{} mode, and
1284 Sli@TeX{} mode (these three distinct major modes differ only slightly).
1285 They are designed for editing the three different formats. The command
1286 @kbd{M-x tex-mode} looks at the contents of the buffer to determine
1287 whether the contents appear to be either La@TeX{} input or Sli@TeX{}
1288 input; if so, it selects the appropriate mode. If the file contents do
1289 not appear to be La@TeX{} or Sli@TeX{}, it selects Plain @TeX{} mode.
1290 If the contents are insufficient to determine this, the variable
1291 @code{tex-default-mode} controls which mode is used.
1292
1293 When @kbd{M-x tex-mode} does not guess right, you can use the commands
1294 @kbd{M-x plain-tex-mode}, @kbd{M-x latex-mode}, and @kbd{M-x
1295 slitex-mode} to select explicitly the particular variants of @TeX{}
1296 mode.
1297
1298 @menu
1299 * Editing: TeX Editing. Special commands for editing in TeX mode.
1300 * LaTeX: LaTeX Editing. Additional commands for LaTeX input files.
1301 * Printing: TeX Print. Commands for printing part of a file with TeX.
1302 * Misc: TeX Misc. Customization of TeX mode, and related features.
1303 @end menu
1304
1305 @node TeX Editing
1306 @subsection @TeX{} Editing Commands
1307
1308 Here are the special commands provided in @TeX{} mode for editing the
1309 text of the file.
1310
1311 @table @kbd
1312 @item "
1313 Insert, according to context, either @samp{``} or @samp{"} or
1314 @samp{''} (@code{tex-insert-quote}).
1315 @item C-j
1316 Insert a paragraph break (two newlines) and check the previous
1317 paragraph for unbalanced braces or dollar signs
1318 (@code{tex-terminate-paragraph}).
1319 @item M-x tex-validate-region
1320 Check each paragraph in the region for unbalanced braces or dollar signs.
1321 @item C-c @{
1322 Insert @samp{@{@}} and position point between them (@code{tex-insert-braces}).
1323 @item C-c @}
1324 Move forward past the next unmatched close brace (@code{up-list}).
1325 @end table
1326
1327 @findex tex-insert-quote
1328 @kindex " @r{(@TeX{} mode)}
1329 In @TeX{}, the character @samp{"} is not normally used; we use
1330 @samp{``} to start a quotation and @samp{''} to end one. To make
1331 editing easier under this formatting convention, @TeX{} mode overrides
1332 the normal meaning of the key @kbd{"} with a command that inserts a pair
1333 of single-quotes or backquotes (@code{tex-insert-quote}). To be
1334 precise, this command inserts @samp{``} after whitespace or an open
1335 brace, @samp{"} after a backslash, and @samp{''} after any other
1336 character.
1337
1338 If you need the character @samp{"} itself in unusual contexts, use
1339 @kbd{C-q} to insert it. Also, @kbd{"} with a numeric argument always
1340 inserts that number of @samp{"} characters. You can turn off the
1341 feature of @kbd{"} expansion by eliminating that binding in the local
1342 map (@pxref{Key Bindings}).
1343
1344 In @TeX{} mode, @samp{$} has a special syntax code which attempts to
1345 understand the way @TeX{} math mode delimiters match. When you insert a
1346 @samp{$} that is meant to exit math mode, the position of the matching
1347 @samp{$} that entered math mode is displayed for a second. This is the
1348 same feature that displays the open brace that matches a close brace that
1349 is inserted. However, there is no way to tell whether a @samp{$} enters
1350 math mode or leaves it; so when you insert a @samp{$} that enters math
1351 mode, the previous @samp{$} position is shown as if it were a match, even
1352 though they are actually unrelated.
1353
1354 @findex tex-insert-braces
1355 @kindex C-c @{ @r{(@TeX{} mode)}
1356 @findex up-list
1357 @kindex C-c @} @r{(@TeX{} mode)}
1358 @TeX{} uses braces as delimiters that must match. Some users prefer
1359 to keep braces balanced at all times, rather than inserting them
1360 singly. Use @kbd{C-c @{} (@code{tex-insert-braces}) to insert a pair of
1361 braces. It leaves point between the two braces so you can insert the
1362 text that belongs inside. Afterward, use the command @kbd{C-c @}}
1363 (@code{up-list}) to move forward past the close brace.
1364
1365 @findex tex-validate-region
1366 @findex tex-terminate-paragraph
1367 @kindex C-j @r{(@TeX{} mode)}
1368 There are two commands for checking the matching of braces. @kbd{C-j}
1369 (@code{tex-terminate-paragraph}) checks the paragraph before point, and
1370 inserts two newlines to start a new paragraph. It prints a message in
1371 the echo area if any mismatch is found. @kbd{M-x tex-validate-region}
1372 checks a region, paragraph by paragraph. The errors are listed in the
1373 @samp{*Occur*} buffer, and you can use @kbd{C-c C-c} or @kbd{Mouse-2} in
1374 that buffer to go to a particular mismatch.
1375
1376 Note that Emacs commands count square brackets and parentheses in
1377 @TeX{} mode, not just braces. This is not strictly correct for the
1378 purpose of checking @TeX{} syntax. However, parentheses and square
1379 brackets are likely to be used in text as matching delimiters and it is
1380 useful for the various motion commands and automatic match display to
1381 work with them.
1382
1383 @node LaTeX Editing
1384 @subsection La@TeX{} Editing Commands
1385
1386 La@TeX{} mode, and its variant, Sli@TeX{} mode, provide a few extra
1387 features not applicable to plain @TeX{}.
1388
1389 @table @kbd
1390 @item C-c C-o
1391 Insert @samp{\begin} and @samp{\end} for La@TeX{} block and position
1392 point on a line between them (@code{tex-latex-block}).
1393 @item C-c C-e
1394 Close the innermost La@TeX{} block not yet closed
1395 (@code{tex-close-latex-block}).
1396 @end table
1397
1398 @findex tex-latex-block
1399 @kindex C-c C-o @r{(La@TeX{} mode)}
1400 @vindex latex-block-names
1401 In La@TeX{} input, @samp{\begin} and @samp{\end} commands are used to
1402 group blocks of text. To insert a @samp{\begin} and a matching
1403 @samp{\end} (on a new line following the @samp{\begin}), use @kbd{C-c
1404 C-o} (@code{tex-latex-block}). A blank line is inserted between the
1405 two, and point is left there. You can use completion when you enter the
1406 block type; to specify additional block type names beyond the standard
1407 list, set the variable @code{latex-block-names}. For example, here's
1408 how to add @samp{theorem}, @samp{corollary}, and @samp{proof}:
1409
1410 @example
1411 (setq latex-block-names '("theorem" "corollary" "proof"))
1412 @end example
1413
1414 @findex tex-close-latex-block
1415 @kindex C-c C-e @r{(La@TeX{} mode)}
1416 In La@TeX{} input, @samp{\begin} and @samp{\end} commands must
1417 balance. You can use @kbd{C-c C-e} (@code{tex-close-latex-block}) to
1418 insert automatically a matching @samp{\end} to match the last unmatched
1419 @samp{\begin}. It indents the @samp{\end} to match the corresponding
1420 @samp{\begin}. It inserts a newline after @samp{\end} if point is at
1421 the beginning of a line.
1422
1423 @node TeX Print
1424 @subsection @TeX{} Printing Commands
1425
1426 You can invoke @TeX{} as an inferior of Emacs on either the entire
1427 contents of the buffer or just a region at a time. Running @TeX{} in
1428 this way on just one chapter is a good way to see what your changes
1429 look like without taking the time to format the entire file.
1430
1431 @table @kbd
1432 @item C-c C-r
1433 Invoke @TeX{} on the current region, together with the buffer's header
1434 (@code{tex-region}).
1435 @item C-c C-b
1436 Invoke @TeX{} on the entire current buffer (@code{tex-buffer}).
1437 @item C-c @key{TAB}
1438 Invoke Bib@TeX{} on the current file (@code{tex-bibtex-file}).
1439 @item C-c C-f
1440 Invoke @TeX{} on the current file (@code{tex-file}).
1441 @item C-c C-l
1442 Recenter the window showing output from the inferior @TeX{} so that
1443 the last line can be seen (@code{tex-recenter-output-buffer}).
1444 @item C-c C-k
1445 Kill the @TeX{} subprocess (@code{tex-kill-job}).
1446 @item C-c C-p
1447 Print the output from the last @kbd{C-c C-r}, @kbd{C-c C-b}, or @kbd{C-c
1448 C-f} command (@code{tex-print}).
1449 @item C-c C-v
1450 Preview the output from the last @kbd{C-c C-r}, @kbd{C-c C-b}, or @kbd{C-c
1451 C-f} command (@code{tex-view}).
1452 @item C-c C-q
1453 Show the printer queue (@code{tex-show-print-queue}).
1454 @end table
1455
1456 @findex tex-buffer
1457 @kindex C-c C-b @r{(@TeX{} mode)}
1458 @findex tex-print
1459 @kindex C-c C-p @r{(@TeX{} mode)}
1460 @findex tex-view
1461 @kindex C-c C-v @r{(@TeX{} mode)}
1462 @findex tex-show-print-queue
1463 @kindex C-c C-q @r{(@TeX{} mode)}
1464 You can pass the current buffer through an inferior @TeX{} by means of
1465 @kbd{C-c C-b} (@code{tex-buffer}). The formatted output appears in a
1466 temporary file; to print it, type @kbd{C-c C-p} (@code{tex-print}).
1467 Afterward, you can use @kbd{C-c C-q} (@code{tex-show-print-queue}) to
1468 view the progress of your output towards being printed. If your terminal
1469 has the ability to display @TeX{} output files, you can preview the
1470 output on the terminal with @kbd{C-c C-v} (@code{tex-view}).
1471
1472 @cindex @env{TEXINPUTS} environment variable
1473 @vindex tex-directory
1474 You can specify the directory to use for running @TeX{} by setting the
1475 variable @code{tex-directory}. @code{"."} is the default value. If
1476 your environment variable @env{TEXINPUTS} contains relative directory
1477 names, or if your files contains @samp{\input} commands with relative
1478 file names, then @code{tex-directory} @emph{must} be @code{"."} or you
1479 will get the wrong results. Otherwise, it is safe to specify some other
1480 directory, such as @code{"/tmp"}.
1481
1482 @vindex tex-run-command
1483 @vindex latex-run-command
1484 @vindex slitex-run-command
1485 @vindex tex-dvi-print-command
1486 @vindex tex-dvi-view-command
1487 @vindex tex-show-queue-command
1488 If you want to specify which shell commands are used in the inferior @TeX{},
1489 you can do so by setting the values of the variables @code{tex-run-command},
1490 @code{latex-run-command}, @code{slitex-run-command},
1491 @code{tex-dvi-print-command}, @code{tex-dvi-view-command}, and
1492 @code{tex-show-queue-command}. You @emph{must} set the value of
1493 @code{tex-dvi-view-command} for your particular terminal; this variable
1494 has no default value. The other variables have default values that may
1495 (or may not) be appropriate for your system.
1496
1497 Normally, the file name given to these commands comes at the end of
1498 the command string; for example, @samp{latex @var{filename}}. In some
1499 cases, however, the file name needs to be embedded in the command; an
1500 example is when you need to provide the file name as an argument to one
1501 command whose output is piped to another. You can specify where to put
1502 the file name with @samp{*} in the command string. For example,
1503
1504 @example
1505 (setq tex-dvi-print-command "dvips -f * | lpr")
1506 @end example
1507
1508 @findex tex-kill-job
1509 @kindex C-c C-k @r{(@TeX{} mode)}
1510 @findex tex-recenter-output-buffer
1511 @kindex C-c C-l @r{(@TeX{} mode)}
1512 The terminal output from @TeX{}, including any error messages, appears
1513 in a buffer called @samp{*tex-shell*}. If @TeX{} gets an error, you can
1514 switch to this buffer and feed it input (this works as in Shell mode;
1515 @pxref{Interactive Shell}). Without switching to this buffer you can
1516 scroll it so that its last line is visible by typing @kbd{C-c
1517 C-l}.
1518
1519 Type @kbd{C-c C-k} (@code{tex-kill-job}) to kill the @TeX{} process if
1520 you see that its output is no longer useful. Using @kbd{C-c C-b} or
1521 @kbd{C-c C-r} also kills any @TeX{} process still running.@refill
1522
1523 @findex tex-region
1524 @kindex C-c C-r @r{(@TeX{} mode)}
1525 You can also pass an arbitrary region through an inferior @TeX{} by typing
1526 @kbd{C-c C-r} (@code{tex-region}). This is tricky, however, because most files
1527 of @TeX{} input contain commands at the beginning to set parameters and
1528 define macros, without which no later part of the file will format
1529 correctly. To solve this problem, @kbd{C-c C-r} allows you to designate a
1530 part of the file as containing essential commands; it is included before
1531 the specified region as part of the input to @TeX{}. The designated part
1532 of the file is called the @dfn{header}.
1533
1534 @cindex header (@TeX{} mode)
1535 To indicate the bounds of the header in Plain @TeX{} mode, you insert two
1536 special strings in the file. Insert @samp{%**start of header} before the
1537 header, and @samp{%**end of header} after it. Each string must appear
1538 entirely on one line, but there may be other text on the line before or
1539 after. The lines containing the two strings are included in the header.
1540 If @samp{%**start of header} does not appear within the first 100 lines of
1541 the buffer, @kbd{C-c C-r} assumes that there is no header.
1542
1543 In La@TeX{} mode, the header begins with @samp{\documentclass} or
1544 @samp{\documentstyle} and ends with @samp{\begin@{document@}}. These
1545 are commands that La@TeX{} requires you to use in any case, so nothing
1546 special needs to be done to identify the header.
1547
1548 @findex tex-file
1549 @kindex C-c C-f @r{(@TeX{} mode)}
1550 The commands (@code{tex-buffer}) and (@code{tex-region}) do all of their
1551 work in a temporary directory, and do not have available any of the auxiliary
1552 files needed by @TeX{} for cross-references; these commands are generally
1553 not suitable for running the final copy in which all of the cross-references
1554 need to be correct.
1555
1556 When you want the auxiliary files for cross references, use @kbd{C-c
1557 C-f} (@code{tex-file}) which runs @TeX{} on the current buffer's file,
1558 in that file's directory. Before running @TeX{}, it offers to save any
1559 modified buffers. Generally, you need to use (@code{tex-file}) twice to
1560 get the cross-references right.
1561
1562 @vindex tex-start-options-string
1563 The value of the variable @code{tex-start-options-string} specifies
1564 options for the @TeX{} run. The default value causes @TeX{} to run in
1565 nonstopmode. To run @TeX{} interactively, set the variable to @code{""}.
1566
1567 @vindex tex-main-file
1568 Large @TeX{} documents are often split into several files---one main
1569 file, plus subfiles. Running @TeX{} on a subfile typically does not
1570 work; you have to run it on the main file. In order to make
1571 @code{tex-file} useful when you are editing a subfile, you can set the
1572 variable @code{tex-main-file} to the name of the main file. Then
1573 @code{tex-file} runs @TeX{} on that file.
1574
1575 The most convenient way to use @code{tex-main-file} is to specify it
1576 in a local variable list in each of the subfiles. @xref{File
1577 Variables}.
1578
1579 @findex tex-bibtex-file
1580 @kindex C-c TAB @r{(@TeX{} mode)}
1581 @vindex tex-bibtex-command
1582 For La@TeX{} files, you can use Bib@TeX{} to process the auxiliary
1583 file for the current buffer's file. Bib@TeX{} looks up bibliographic
1584 citations in a data base and prepares the cited references for the
1585 bibliography section. The command @kbd{C-c TAB}
1586 (@code{tex-bibtex-file}) runs the shell command
1587 (@code{tex-bibtex-command}) to produce a @samp{.bbl} file for the
1588 current buffer's file. Generally, you need to do @kbd{C-c C-f}
1589 (@code{tex-file}) once to generate the @samp{.aux} file, then do
1590 @kbd{C-c TAB} (@code{tex-bibtex-file}), and then repeat @kbd{C-c C-f}
1591 (@code{tex-file}) twice more to get the cross-references correct.
1592
1593 @node TeX Misc
1594 @subsection @TeX{} Mode Miscellany
1595
1596 @vindex tex-shell-hook
1597 @vindex tex-mode-hook
1598 @vindex latex-mode-hook
1599 @vindex slitex-mode-hook
1600 @vindex plain-tex-mode-hook
1601 Entering any variant of @TeX{} mode runs the hooks
1602 @code{text-mode-hook} and @code{tex-mode-hook}. Then it runs either
1603 @code{plain-tex-mode-hook}, @code{latex-mode-hook}, or
1604 @code{slitex-mode-hook}, whichever is appropriate. Starting the
1605 @TeX{} shell runs the hook @code{tex-shell-hook}. @xref{Hooks}.
1606
1607 @findex iso-iso2tex
1608 @findex iso-tex2iso
1609 @findex iso-iso2gtex
1610 @findex iso-gtex2iso
1611 @cindex Latin-1 @TeX{} encoding
1612 @TeX{} encoding
1613 The commands @kbd{M-x iso-iso2tex}, @kbd{M-x iso-tex2iso}, @kbd{M-x
1614 iso-iso2gtex} and @kbd{M-x iso-gtex2iso} can be used to convert
1615 between Latin-1 encoded files and @TeX{}-encoded equivalents.
1616 @ignore
1617 @c Too cryptic to be useful, too cryptic for me to make it better -- rms.
1618 They
1619 are included by default in the @code{format-alist} variable, so they
1620 can be used with @kbd{M-x format-find-file}, for instance.
1621 @end ignore
1622
1623 @ignore @c Not worth documenting if it is only for Czech -- rms.
1624 @findex tildify-buffer
1625 @findex tildify-region
1626 @cindex ties, @TeX{}, inserting
1627 @cindex hard spaces, @TeX{}, inserting
1628 @cindex SGML
1629 @cindex HTML
1630 The commands @kbd{M-x tildify-buffer} and @kbd{M-x tildify-region}
1631 insert @samp{~} (@dfn{tie}) characters where they are conventionally
1632 required. This is set up for Czech---customize the group
1633 @samp{tildify} for other languages or for other sorts of markup.
1634 @end ignore
1635
1636 @cindex Ref@TeX{} package
1637 @cindex references, La@TeX{}
1638 @cindex La@TeX{} references
1639 For managing all kinds of references for La@TeX{}, you can use
1640 Ref@TeX{}. @xref{Top, , RefTeX, reftex}.
1641
1642 @node Nroff Mode
1643 @section Nroff Mode
1644
1645 @cindex nroff
1646 @findex nroff-mode
1647 Nroff mode is a mode like Text mode but modified to handle nroff commands
1648 present in the text. Invoke @kbd{M-x nroff-mode} to enter this mode. It
1649 differs from Text mode in only a few ways. All nroff command lines are
1650 considered paragraph separators, so that filling will never garble the
1651 nroff commands. Pages are separated by @samp{.bp} commands. Comments
1652 start with backslash-doublequote. Also, three special commands are
1653 provided that are not in Text mode:
1654
1655 @findex forward-text-line
1656 @findex backward-text-line
1657 @findex count-text-lines
1658 @kindex M-n @r{(Nroff mode)}
1659 @kindex M-p @r{(Nroff mode)}
1660 @kindex M-? @r{(Nroff mode)}
1661 @table @kbd
1662 @item M-n
1663 Move to the beginning of the next line that isn't an nroff command
1664 (@code{forward-text-line}). An argument is a repeat count.
1665 @item M-p
1666 Like @kbd{M-n} but move up (@code{backward-text-line}).
1667 @item M-?
1668 Prints in the echo area the number of text lines (lines that are not
1669 nroff commands) in the region (@code{count-text-lines}).
1670 @end table
1671
1672 @findex electric-nroff-mode
1673 The other feature of Nroff mode is that you can turn on Electric Nroff
1674 mode. This is a minor mode that you can turn on or off with @kbd{M-x
1675 electric-nroff-mode} (@pxref{Minor Modes}). When the mode is on, each
1676 time you use @key{RET} to end a line that contains an nroff command that
1677 opens a kind of grouping, the matching nroff command to close that
1678 grouping is automatically inserted on the following line. For example,
1679 if you are at the beginning of a line and type @kbd{.@: ( b @key{RET}},
1680 this inserts the matching command @samp{.)b} on a new line following
1681 point.
1682
1683 If you use Outline minor mode with Nroff mode (@pxref{Outline Mode}),
1684 heading lines are lines of the form @samp{.H} followed by a number (the
1685 header level).
1686
1687 @vindex nroff-mode-hook
1688 Entering Nroff mode runs the hook @code{text-mode-hook}, followed by
1689 the hook @code{nroff-mode-hook} (@pxref{Hooks}).
1690
1691 @node Formatted Text
1692 @section Editing Formatted Text
1693
1694 @cindex Enriched mode
1695 @cindex mode, Enriched
1696 @cindex formatted text
1697 @cindex WYSIWYG
1698 @cindex word processing
1699 @dfn{Enriched mode} is a minor mode for editing files that contain
1700 formatted text in WYSIWYG fashion, as in a word processor. Currently,
1701 formatted text in Enriched mode can specify fonts, colors, underlining,
1702 margins, and types of filling and justification. In the future, we plan
1703 to implement other formatting features as well.
1704
1705 Enriched mode is a minor mode (@pxref{Minor Modes}). Typically it is
1706 used in conjunction with Text mode (@pxref{Text Mode}). However, you
1707 can also use it with other major modes such as Outline mode and
1708 Paragraph-Indent Text mode.
1709
1710 @cindex text/enriched MIME format
1711 Potentially, Emacs can store formatted text files in various file
1712 formats. Currently, only one format is implemented: @dfn{text/enriched}
1713 format, which is defined by the MIME protocol. @xref{Format
1714 Conversion,, Format Conversion, elisp, the Emacs Lisp Reference Manual},
1715 for details of how Emacs recognizes and converts file formats.
1716
1717 The Emacs distribution contains a formatted text file that can serve as
1718 an example. Its name is @file{etc/enriched.doc}. It contains samples
1719 illustrating all the features described in this section. It also
1720 contains a list of ideas for future enhancements.
1721
1722 @menu
1723 * Requesting Formatted Text:: Entering and exiting Enriched mode.
1724 * Hard and Soft Newlines:: There are two different kinds of newlines.
1725 * Editing Format Info:: How to edit text properties.
1726 * Faces: Format Faces. Bold, italic, underline, etc.
1727 * Color: Format Colors. Changing the color of text.
1728 * Indent: Format Indentation. Changing the left and right margins.
1729 * Justification: Format Justification.
1730 Centering, setting text flush with the
1731 left or right margin, etc.
1732 * Other: Format Properties. The "special" text properties submenu.
1733 * Forcing Enriched Mode:: How to force use of Enriched mode.
1734 @end menu
1735
1736 @node Requesting Formatted Text
1737 @subsection Requesting to Edit Formatted Text
1738
1739 Whenever you visit a file that Emacs saved in the text/enriched format,
1740 Emacs automatically converts the formatting information in the file into
1741 Emacs's own internal format (text properties), and turns on Enriched
1742 mode.
1743
1744 @findex enriched-mode
1745 To create a new file of formatted text, first visit the nonexistent
1746 file, then type @kbd{M-x enriched-mode} before you start inserting text.
1747 This command turns on Enriched mode. Do this before you begin inserting
1748 text, to ensure that the text you insert is handled properly.
1749
1750 More generally, the command @code{enriched-mode} turns Enriched mode
1751 on if it was off, and off if it was on. With a prefix argument, this
1752 command turns Enriched mode on if the argument is positive, and turns
1753 the mode off otherwise.
1754
1755 When you save a buffer while Enriched mode is enabled in it, Emacs
1756 automatically converts the text to text/enriched format while writing it
1757 into the file. When you visit the file again, Emacs will automatically
1758 recognize the format, reconvert the text, and turn on Enriched mode
1759 again.
1760
1761 @vindex enriched-fill-after-visiting
1762 Normally, after visiting a file in text/enriched format, Emacs refills
1763 each paragraph to fit the specified right margin. You can turn off this
1764 refilling, to save time, by setting the variable
1765 @code{enriched-fill-after-visiting} to @code{nil} or to @code{ask}.
1766
1767 However, when visiting a file that was saved from Enriched mode, there
1768 is no need for refilling, because Emacs saves the right margin settings
1769 along with the text.
1770
1771 @vindex enriched-translations
1772 You can add annotations for saving additional text properties, which
1773 Emacs normally does not save, by adding to @code{enriched-translations}.
1774 Note that the text/enriched standard requires any non-standard
1775 annotations to have names starting with @samp{x-}, as in
1776 @samp{x-read-only}. This ensures that they will not conflict with
1777 standard annotations that may be added later.
1778
1779 @node Hard and Soft Newlines
1780 @subsection Hard and Soft Newlines
1781 @cindex hard newline
1782 @cindex soft newline
1783 @cindex newlines, hard and soft
1784
1785 In formatted text, Emacs distinguishes between two different kinds of
1786 newlines, @dfn{hard} newlines and @dfn{soft} newlines.
1787
1788 Hard newlines are used to separate paragraphs, or items in a list, or
1789 anywhere that there should always be a line break regardless of the
1790 margins. The @key{RET} command (@code{newline}) and @kbd{C-o}
1791 (@code{open-line}) insert hard newlines.
1792
1793 Soft newlines are used to make text fit between the margins. All the
1794 fill commands, including Auto Fill, insert soft newlines---and they
1795 delete only soft newlines.
1796
1797 Although hard and soft newlines look the same, it is important to bear
1798 the difference in mind. Do not use @key{RET} to break lines in the
1799 middle of filled paragraphs, or else you will get hard newlines that are
1800 barriers to further filling. Instead, let Auto Fill mode break lines,
1801 so that if the text or the margins change, Emacs can refill the lines
1802 properly. @xref{Auto Fill}.
1803
1804 On the other hand, in tables and lists, where the lines should always
1805 remain as you type them, you can use @key{RET} to end lines. For these
1806 lines, you may also want to set the justification style to
1807 @code{unfilled}. @xref{Format Justification}.
1808
1809 @node Editing Format Info
1810 @subsection Editing Format Information
1811
1812 There are two ways to alter the formatting information for a formatted
1813 text file: with keyboard commands, and with the mouse.
1814
1815 The easiest way to add properties to your document is by using the Text
1816 Properties menu. You can get to this menu in two ways: from the Edit
1817 menu in the menu bar, or with @kbd{C-Mouse-2} (hold the @key{CTRL} key
1818 and press the middle mouse button).
1819
1820 Most of the items in the Text Properties menu lead to other submenus.
1821 These are described in the sections that follow. Some items run
1822 commands directly:
1823
1824 @table @code
1825 @findex facemenu-remove-props
1826 @item Remove Properties
1827 Delete from the region all the text properties that the Text Properties
1828 menu works with (@code{facemenu-remove-props}).
1829
1830 @findex facemenu-remove-all
1831 @item Remove All
1832 Delete @emph{all} text properties from the region
1833 (@code{facemenu-remove-all}).
1834
1835 @findex list-text-properties-at
1836 @item List Properties
1837 List all the text properties of the character following point
1838 (@code{list-text-properties-at}).
1839
1840 @item Display Faces
1841 Display a list of all the defined faces.
1842
1843 @item Display Colors
1844 Display a list of all the defined colors.
1845 @end table
1846
1847 @node Format Faces
1848 @subsection Faces in Formatted Text
1849
1850 The Faces submenu lists various Emacs faces including @code{bold},
1851 @code{italic}, and @code{underline}. Selecting one of these adds the
1852 chosen face to the region. @xref{Faces}. You can also specify a face
1853 with these keyboard commands:
1854
1855 @table @kbd
1856 @kindex M-g d @r{(Enriched mode)}
1857 @findex facemenu-set-default
1858 @item M-g d
1859 Set the region, or the next inserted character, to the @code{default} face
1860 (@code{facemenu-set-default}).
1861 @kindex M-g b @r{(Enriched mode)}
1862 @findex facemenu-set-bold
1863 @item M-g b
1864 Set the region, or the next inserted character, to the @code{bold} face
1865 (@code{facemenu-set-bold}).
1866 @kindex M-g i @r{(Enriched mode)}
1867 @findex facemenu-set-italic
1868 @item M-g i
1869 Set the region, or the next inserted character, to the @code{italic} face
1870 (@code{facemenu-set-italic}).
1871 @kindex M-g l @r{(Enriched mode)}
1872 @findex facemenu-set-bold-italic
1873 @item M-g l
1874 Set the region, or the next inserted character, to the @code{bold-italic} face
1875 (@code{facemenu-set-bold-italic}).
1876 @kindex M-g u @r{(Enriched mode)}
1877 @findex facemenu-set-underline
1878 @item M-g u
1879 Set the region, or the next inserted character, to the @code{underline} face
1880 (@code{facemenu-set-underline}).
1881 @kindex M-g o @r{(Enriched mode)}
1882 @findex facemenu-set-face
1883 @item M-g o @var{face} @key{RET}
1884 Set the region, or the next inserted character, to the face @var{face}
1885 (@code{facemenu-set-face}).
1886 @end table
1887
1888 If you use these commands with a prefix argument---or, in Transient Mark
1889 mode, if the region is not active---then these commands specify a face
1890 to use for your next self-inserting input. @xref{Transient Mark}. This
1891 applies to both the keyboard commands and the menu commands.
1892
1893 Enriched mode defines two additional faces: @code{excerpt} and
1894 @code{fixed}. These correspond to codes used in the text/enriched file
1895 format.
1896
1897 The @code{excerpt} face is intended for quotations. This face is the
1898 same as @code{italic} unless you customize it (@pxref{Face Customization}).
1899
1900 The @code{fixed} face means, ``Use a fixed-width font for this part
1901 of the text.'' This makes a visible difference only if you have
1902 specified a variable-width font in the default face; however, even if
1903 the default font is fixed-width, applying the @code{fixed} face to a
1904 part of the text will cause that part of the text to appear in a
1905 fixed-width font, if the file is ever displayed with a variable-width
1906 default font. This applies to Emacs and to other systems that display
1907 text/enriched format. So if you specifically want a certain part of
1908 the text to use a fixed-width font, you should specify the
1909 @code{fixed} face for that part.
1910
1911 The @code{fixed} face is normally set up to use a different font
1912 from the default, even if the default face is also fixed-width.
1913 Different systems have different fonts installed, so you may need to
1914 customize this. @xref{Face Customization}.
1915
1916 If your terminal cannot display different faces, you will not be
1917 able to see them, but you can still edit documents containing faces,
1918 and even add faces and colors to documents. The faces you specify
1919 will be visible when the file is viewed on a terminal that can display
1920 them.
1921
1922 @node Format Colors
1923 @subsection Colors in Formatted Text
1924
1925 You can specify foreground and background colors for portions of the
1926 text. There is a menu for specifying the foreground color and a menu
1927 for specifying the background color. Each color menu lists all the
1928 colors that you have used in Enriched mode in the current Emacs session.
1929
1930 If you specify a color with a prefix argument---or, in Transient Mark
1931 mode, if the region is not active---then it applies to your next
1932 self-inserting input. @xref{Transient Mark}. Otherwise, the command
1933 applies to the region.
1934
1935 Each color menu contains one additional item: @samp{Other}. You can use
1936 this item to specify a color that is not listed in the menu; it reads
1937 the color name with the minibuffer. To display list of available colors
1938 and their names, use the @samp{Display Colors} menu item in the Text
1939 Properties menu (@pxref{Editing Format Info}).
1940
1941 Any color that you specify in this way, or that is mentioned in a
1942 formatted text file that you read in, is added to both color menus for
1943 the duration of the Emacs session.
1944
1945 @findex facemenu-set-foreground
1946 @findex facemenu-set-background
1947 There are no key bindings for specifying colors, but you can do so
1948 with the extended commands @kbd{M-x facemenu-set-foreground} and
1949 @kbd{M-x facemenu-set-background}. Both of these commands read the name
1950 of the color with the minibuffer.
1951
1952 @node Format Indentation
1953 @subsection Indentation in Formatted Text
1954
1955 When editing formatted text, you can specify different amounts of
1956 indentation for the right or left margin of an entire paragraph or a
1957 part of a paragraph. The margins you specify automatically affect the
1958 Emacs fill commands (@pxref{Filling}) and line-breaking commands.
1959
1960 The Indentation submenu provides a convenient interface for specifying
1961 these properties. The submenu contains four items:
1962
1963 @table @code
1964 @kindex C-x TAB @r{(Enriched mode)}
1965 @findex increase-left-margin
1966 @item Indent More
1967 Indent the region by 4 columns (@code{increase-left-margin}). In
1968 Enriched mode, this command is also available on @kbd{C-x @key{TAB}}; if
1969 you supply a numeric argument, that says how many columns to add to the
1970 margin (a negative argument reduces the number of columns).
1971
1972 @item Indent Less
1973 Remove 4 columns of indentation from the region.
1974
1975 @item Indent Right More
1976 Make the text narrower by indenting 4 columns at the right margin.
1977
1978 @item Indent Right Less
1979 Remove 4 columns of indentation from the right margin.
1980 @end table
1981
1982 You can use these commands repeatedly to increase or decrease the
1983 indentation.
1984
1985 The most common way to use these commands is to change the indentation
1986 of an entire paragraph. However, that is not the only use. You can
1987 change the margins at any point; the new values take effect at the end
1988 of the line (for right margins) or the beginning of the next line (for
1989 left margins).
1990
1991 This makes it possible to format paragraphs with @dfn{hanging indents},
1992 which means that the first line is indented less than subsequent lines.
1993 To set up a hanging indent, increase the indentation of the region
1994 starting after the first word of the paragraph and running until the end
1995 of the paragraph.
1996
1997 Indenting the first line of a paragraph is easier. Set the margin for
1998 the whole paragraph where you want it to be for the body of the
1999 paragraph, then indent the first line by inserting extra spaces or tabs.
2000
2001 Sometimes, as a result of editing, the filling of a paragraph becomes
2002 messed up---parts of the paragraph may extend past the left or right
2003 margins. When this happens, use @kbd{M-q} (@code{fill-paragraph}) to
2004 refill the paragraph.
2005
2006 @vindex standard-indent
2007 The variable @code{standard-indent} specifies how many columns these
2008 commands should add to or subtract from the indentation. The default
2009 value is 4. The overall default right margin for Enriched mode is
2010 controlled by the variable @code{fill-column}, as usual.
2011
2012 The fill prefix, if any, works in addition to the specified paragraph
2013 indentation: @kbd{C-x .} does not include the specified indentation's
2014 whitespace in the new value for the fill prefix, and the fill commands
2015 look for the fill prefix after the indentation on each line. @xref{Fill
2016 Prefix}.
2017
2018 @node Format Justification
2019 @subsection Justification in Formatted Text
2020
2021 When editing formatted text, you can specify various styles of
2022 justification for a paragraph. The style you specify automatically
2023 affects the Emacs fill commands.
2024
2025 The Justification submenu provides a convenient interface for specifying
2026 the style. The submenu contains five items:
2027
2028 @table @code
2029 @item Flush Left
2030 This is the most common style of justification (at least for English).
2031 Lines are aligned at the left margin but left uneven at the right.
2032
2033 @item Flush Right
2034 This aligns each line with the right margin. Spaces and tabs are added
2035 on the left, if necessary, to make lines line up on the right.
2036
2037 @item Full
2038 This justifies the text, aligning both edges of each line. Justified
2039 text looks very nice in a printed book, where the spaces can all be
2040 adjusted equally, but it does not look as nice with a fixed-width font
2041 on the screen. Perhaps a future version of Emacs will be able to adjust
2042 the width of spaces in a line to achieve elegant justification.
2043
2044 @item Center
2045 This centers every line between the current margins.
2046
2047 @item None
2048 This turns off filling entirely. Each line will remain as you wrote it;
2049 the fill and auto-fill functions will have no effect on text which has
2050 this setting. You can, however, still indent the left margin. In
2051 unfilled regions, all newlines are treated as hard newlines (@pxref{Hard
2052 and Soft Newlines}) .
2053 @end table
2054
2055 In Enriched mode, you can also specify justification from the keyboard
2056 using the @kbd{M-j} prefix character:
2057
2058 @table @kbd
2059 @kindex M-j l @r{(Enriched mode)}
2060 @findex set-justification-left
2061 @item M-j l
2062 Make the region left-filled (@code{set-justification-left}).
2063 @kindex M-j r @r{(Enriched mode)}
2064 @findex set-justification-right
2065 @item M-j r
2066 Make the region right-filled (@code{set-justification-right}).
2067 @kindex M-j f @r{(Enriched mode)}
2068 @findex set-justification-full
2069 @item M-j f
2070 Make the region fully-justified (@code{set-justification-full}).
2071 @kindex M-j c @r{(Enriched mode)}
2072 @kindex M-S @r{(Enriched mode)}
2073 @findex set-justification-center
2074 @item M-j c
2075 @itemx M-S
2076 Make the region centered (@code{set-justification-center}).
2077 @kindex M-j u @r{(Enriched mode)}
2078 @findex set-justification-none
2079 @item M-j u
2080 Make the region unfilled (@code{set-justification-none}).
2081 @end table
2082
2083 Justification styles apply to entire paragraphs. All the
2084 justification-changing commands operate on the paragraph containing
2085 point, or, if the region is active, on all paragraphs which overlap the
2086 region.
2087
2088 @vindex default-justification
2089 The default justification style is specified by the variable
2090 @code{default-justification}. Its value should be one of the symbols
2091 @code{left}, @code{right}, @code{full}, @code{center}, or @code{none}.
2092
2093 @node Format Properties
2094 @subsection Setting Other Text Properties
2095
2096 The Other Properties menu lets you add or remove three other useful text
2097 properties: @code{read-only}, @code{invisible} and @code{intangible}.
2098 The @code{intangible} property disallows moving point within the text,
2099 the @code{invisible} text property hides text from display, and the
2100 @code{read-only} property disallows alteration of the text.
2101
2102 Each of these special properties has a menu item to add it to the
2103 region. The last menu item, @samp{Remove Special}, removes all of these
2104 special properties from the text in the region.
2105
2106 Currently, the @code{invisible} and @code{intangible} properties are
2107 @emph{not} saved in the text/enriched format. The @code{read-only}
2108 property is saved, but it is not a standard part of the text/enriched
2109 format, so other editors may not respect it.
2110
2111 @node Forcing Enriched Mode
2112 @subsection Forcing Enriched Mode
2113
2114 Normally, Emacs knows when you are editing formatted text because it
2115 recognizes the special annotations used in the file that you visited.
2116 However, there are situations in which you must take special actions
2117 to convert file contents or turn on Enriched mode:
2118
2119 @itemize @bullet
2120 @item
2121 When you visit a file that was created with some other editor, Emacs may
2122 not recognize the file as being in the text/enriched format. In this
2123 case, when you visit the file you will see the formatting commands
2124 rather than the formatted text. Type @kbd{M-x format-decode-buffer} to
2125 translate it.
2126
2127 @item
2128 When you @emph{insert} a file into a buffer, rather than visiting it.
2129 Emacs does the necessary conversions on the text which you insert, but
2130 it does not enable Enriched mode. If you wish to do that, type @kbd{M-x
2131 enriched-mode}.
2132 @end itemize
2133
2134 The command @code{format-decode-buffer} translates text in various
2135 formats into Emacs's internal format. It asks you to specify the format
2136 to translate from; however, normally you can type just @key{RET}, which
2137 tells Emacs to guess the format.
2138
2139 @findex format-find-file
2140 If you wish to look at text/enriched file in its raw form, as a
2141 sequence of characters rather than as formatted text, use the @kbd{M-x
2142 find-file-literally} command. This visits a file, like
2143 @code{find-file}, but does not do format conversion. It also inhibits
2144 character code conversion (@pxref{Coding Systems}) and automatic
2145 uncompression (@pxref{Compressed Files}). To disable format conversion
2146 but allow character code conversion and/or automatic uncompression if
2147 appropriate, use @code{format-find-file} with suitable arguments.
2148