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