comparison man/text.texi @ 25829:ac7e9e5e2ccb

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