display-time can now incicate new e-mail in directory.
[bpt/emacs.git] / etc / TUTORIAL
1 Copyright (c) 1985 Free Software Foundation, Inc; See end for conditions.
2 You are looking at the Emacs tutorial.
3
4 Emacs commands generally involve the CONTROL key (sometimes labeled
5 CTRL or CTL) or the META key (sometimes labeled EDIT or ALT). Rather than
6 write that in full each time, we'll use the following abbreviations:
7
8 C-<chr> means hold the CONTROL key while typing the character <chr>
9 Thus, C-f would be: hold the CONTROL key and type f.
10 M-<chr> means hold the META or EDIT or ALT key down while typing <chr>.
11 If there is no META, EDIT or ALT key, instead press and release the
12 ESC key and then type <chr>. We write <ESC> for the ESC key.
13
14 Important note: to end the Emacs session, type C-x C-c. (Two characters.)
15 The characters ">>" at the left margin indicate directions for you to
16 try using a command. For instance:
17 <<Blank lines inserted here by startup of help-with-tutorial>>
18 >> Now type C-v (View next screen) to move to the next screen.
19 (go ahead, do it by holding down the CONTROL key while typing v).
20 From now on, you should do this again whenever you finish
21 reading the screen.
22
23 Note that there is an overlap of two lines when you move from screen
24 to screen; this provides some continuity so you can continue reading
25 the text.
26
27 The first thing that you need to know is how to move around from place
28 to place in the text. You already know how to move forward one screen,
29 with C-v. To move backwards one screen, type M-v (hold down the META key
30 and type v, or type <ESC>v if you do not have a META, EDIT, or ALT key).
31
32 >> Try typing M-v and then C-v, a few times.
33
34
35 * SUMMARY
36 ---------
37
38 The following commands are useful for viewing screenfuls:
39
40 C-v Move forward one screenful
41 M-v Move backward one screenful
42 C-l Clear screen and redisplay all the text,
43 moving the text around the cursor
44 to the center of the screen.
45 (That's CONTROL-L, not CONTROL-1.)
46
47 >> Find the cursor, and note what text is near it.
48 Then type C-l.
49 Find the cursor again and notice that the same text
50 is near the cursor now.
51
52
53 * BASIC CURSOR CONTROL
54 ----------------------
55
56 Moving from screenful to screenful is useful, but how do you
57 move to a specific place within the text on the screen?
58
59 There are several ways you can do this. The most basic way is to use
60 the commands C-p, C-b, C-f, and C-n. Each of these commands moves the
61 cursor one row or column in a particular direction on the screen.
62 Here is a table showing these four commands and the directions they
63 move:
64
65 Previous line, C-p
66 :
67 :
68 Backward, C-b .... Current cursor position .... Forward, C-f
69 :
70 :
71 Next line, C-n
72
73 >> Move the cursor to the line in the middle of that diagram
74 using C-n or C-p. Then type C-l to see the whole diagram
75 centered in the screen.
76
77 You'll probably find it easy to think of these by letter: P for
78 previous, N for next, B for backward and F for forward. These are the
79 basic cursor positioning commands, and you'll be using them ALL the
80 time, so it would be of great benefit if you learn them now.
81
82 >> Do a few C-n's to bring the cursor down to this line.
83
84 >> Move into the line with C-f's and then up with C-p's.
85 See what C-p does when the cursor is in the middle of the line.
86
87 Each line of text ends with a Newline character, which serves to
88 separate it from the following line. The last line in your file ought
89 to have a Newline at the end (but Emacs does not require it to have
90 one).
91
92 >> Try to C-b at the beginning of a line. It should move to
93 the end of the previous line. This is because it moves back
94 across the Newline character.
95
96 C-f can move across a Newline just like C-b.
97
98 >> Do a few more C-b's, so you get a feel for where the cursor is.
99 Then do C-f's to return to the end of the line.
100 Then do one more C-f to move to the following line.
101
102 When you move past the top or bottom of the screen, the text beyond
103 the edge shifts onto the screen. This is called "scrolling". It
104 enables Emacs to move the cursor to the specified place in the text
105 without moving it off the screen.
106
107 >> Try to move the cursor off the bottom of the screen with C-n, and
108 see what happens.
109
110 If moving by characters is too slow, you can move by words. M-f
111 (META-f) moves forward a word and M-b moves back a word.
112
113 >> Type a few M-f's and M-b's.
114
115 When you are in the middle of a word, M-f moves to the end of the word.
116 When you are in whitespace between words, M-f moves to the end of the
117 following word. M-b works likewise in the opposite direction.
118
119 >> Type M-f and M-b a few times, interspersed with C-f's and C-b's
120 so that you can observe the action of M-f and M-b from various
121 places inside and between words.
122
123 Notice the parallel between C-f and C-b on the one hand, and M-f and
124 M-b on the other hand. Very often Meta characters are used for
125 operations related to the units defined by language (words, sentences,
126 paragraphs), while Control characters operate on basic units that are
127 independent of what you are editing (characters, lines, etc).
128
129 This parallel applies between lines and sentences: C-a and C-e move to
130 the beginning or end of a line, and M-a and M-e move to the beginning
131 or end of a sentence.
132
133 >> Try a couple of C-a's, and then a couple of C-e's.
134 Try a couple of M-a's, and then a couple of M-e's.
135
136 See how repeated C-a's do nothing, but repeated M-a's keep moving one
137 more sentence. Although these are not quite analogous, each one seems
138 natural.
139
140 The location of the cursor in the text is also called "point". To
141 paraphrase, the cursor shows on the screen where point is located in
142 the text.
143
144 Here is a summary of simple cursor-moving operations, including the
145 word and sentence moving commands:
146
147 C-f Move forward a character
148 C-b Move backward a character
149
150 M-f Move forward a word
151 M-b Move backward a word
152
153 C-n Move to next line
154 C-p Move to previous line
155
156 C-a Move to beginning of line
157 C-e Move to end of line
158
159 M-a Move back to beginning of sentence
160 M-e Move forward to end of sentence
161
162 >> Try all of these commands now a few times for practice.
163 These are the most often used commands.
164
165 Two other important cursor motion commands are M-< (META Less-than),
166 which moves to the beginning of the whole text, and M-> (META
167 Greater-than), which moves to the end of the whole text.
168
169 On most terminals, the "<" is above the comma, so you must use the
170 shift key to type it. On these terminals you must use the shift key
171 to type M-< also; without the shift key, you would be typing M-comma.
172
173 >> Try M-< now, to move to the beginning of the tutorial.
174 Then use C-v repeatedly to move back here.
175
176 >> Try M-> now, to move to the end of the tutorial.
177 Then use M-v repeatedly to move back here.
178
179 You can also move the cursor with the arrow keys, if your terminal has
180 arrow keys. We recommend learning C-b, C-f, C-n and C-p for three
181 reasons. First, they work on all kinds of terminals. Second, once
182 you gain practice at using Emacs, you will find that typing these Control
183 characters is faster than typing the arrow keys (because you do not
184 have to move your hands away from touch-typing position). Third, once
185 you form the habit of using these Control character commands, you can
186 easily learn to use other advanced cursor motion commands as well.
187
188 Most Emacs commands accept a numeric argument; for most commands, this
189 serves as a repeat-count. The way you give a command a repeat count
190 is by typing C-u and then the digits before you type the command. If
191 you have a META (or EDIT or ALT) key, there is another, alternative way
192 to enter a numeric argument: type the digits while holding down the
193 META key. We recommend learning the C-u method because it works on
194 any terminal. The numeric argument is also called a "prefix argument",
195 because you type the argument before the command it applies to.
196
197 For instance, C-u 8 C-f moves forward eight characters.
198
199 >> Try using C-n or C-p with a numeric argument, to move the cursor
200 to a line near this one with just one command.
201
202 Most commands use the numeric argument as a repeat count, but some
203 commands use it in some other way. Several commands (but none of
204 those you have learned so far) use it as a flag--the presence of a
205 prefix argument, regardless of its value, makes the command do
206 something different.
207
208 C-v and M-v are another kind of exception. When given an argument,
209 they scroll the screen up or down by that many lines, rather than by a
210 screenful. For example, C-u 8 C-v scrolls the screen by 8 lines.
211
212 >> Try typing C-u 8 C-v now.
213
214 This should have scrolled the screen up by 8 lines. If you would like
215 to scroll it down again, you can give an argument to M-v.
216
217 If you are using a windowed display, such as X11 or MS-Windows, there
218 should be a tall rectangular area called a scroll bar at the left hand
219 side of the Emacs window. You can scroll the text by clicking the
220 mouse in the scroll bar.
221
222 >> Try pressing the middle button at the top of the highlighted area
223 within the scroll bar. This should scroll the text to a position
224 determined by how high or low you click.
225
226 >> Try moving the mouse up and down, while holding the middle button
227 pressed down. You'll see that the text scrolls up and down as
228 you move the mouse.
229
230
231 * WHEN EMACS IS HUNG
232 --------------------
233
234 If Emacs stops responding to your commands, you can stop it safely by
235 typing C-g. You can use C-g to stop a command which is taking too
236 long to execute.
237
238 You can also use C-g to discard a numeric argument or the beginning of
239 a command that you do not want to finish.
240
241 >> Type C-u 100 to make a numeric arg of 100, then type C-g.
242 Now type C-f. It should move just one character,
243 because you canceled the argument with C-g.
244
245 If you have typed an <ESC> by mistake, you can get rid of it
246 with a C-g.
247
248
249 * DISABLED COMMANDS
250 -------------------
251
252 Some Emacs commands are "disabled" so that beginning users cannot use
253 them by accident.
254
255 If you type one of the disabled commands, Emacs displays a message
256 saying what the command was, and asking you whether you want to go
257 ahead and execute the command.
258
259 If you really want to try the command, type Space in answer to the
260 question. Normally, if you do not want to execute the disabled
261 command, answer the question with "n".
262
263 >> Type C-x C-l (which is a disabled command),
264 then type n to answer the question.
265
266
267 * WINDOWS
268 ---------
269
270 Emacs can have several windows, each displaying its own text. We will
271 explain later on how to use multiple windows. Right now we want to
272 explain how to get rid of extra windows and go back to basic
273 one-window editing. It is simple:
274
275 C-x 1 One window (i.e., kill all other windows).
276
277 That is CONTROL-x followed by the digit 1. C-x 1 expands the window
278 which contains the cursor, to occupy the full screen. It deletes all
279 other windows.
280
281 >> Move the cursor to this line and type C-u 0 C-l.
282 >> Type CONTROL-h k CONTROL-f.
283 See how this window shrinks, while a new one appears
284 to display documentation on the CONTROL-f command.
285
286 >> Type C-x 1 and see the documentation listing window disappear.
287
288 This command is unlike the other commands you have learned in that it
289 consists of two characters. It starts with the character CONTROL-x.
290 There is a whole series of commands that start with CONTROL-x; many of
291 them have to do with windows, files, buffers, and related things.
292 These commands are two, three or four characters long.
293
294
295 * INSERTING AND DELETING
296 ------------------------
297
298 If you want to insert text, just type the text. Characters which you
299 can see, such as A, 7, *, etc. are taken by Emacs as text and inserted
300 immediately. Type <Return> (the carriage-return key) to insert a
301 Newline character.
302
303 You can delete the last character you typed by typing <Delete>.
304 <Delete> is a key on the keyboard, which may be labeled "Del". In
305 some cases, the "Backspace" key serves as <Delete>, but not always!
306
307 More generally, <Delete> deletes the character immediately before the
308 current cursor position.
309
310 >> Do this now--type a few characters, then delete them
311 by typing <Delete> a few times. Don't worry about this file
312 being changed; you will not alter the master tutorial. This is
313 your personal copy of it.
314
315 When a line of text gets too big for one line on the screen, the line
316 of text is "continued" onto a second screen line. A backslash ("\")
317 (or, if you're using a windowed display, a little curved arrow) at the
318 right margin indicates a line which has been continued.
319
320 >> Insert text until you reach the right margin, and keep on inserting.
321 You'll see a continuation line appear.
322
323 >> Use <Delete>s to delete the text until the line fits on one screen
324 line again. The continuation line goes away.
325
326 You can delete a Newline character just like any other character.
327 Deleting the Newline character between two lines merges them into
328 one line. If the resulting combined line is too long to fit in the
329 screen width, it will be displayed with a continuation line.
330
331 >> Move the cursor to the beginning of a line and type <Delete>. This
332 merges that line with the previous line.
333
334 >> Type <Return> to reinsert the Newline you deleted.
335
336 Remember that most Emacs commands can be given a repeat count;
337 this includes text characters. Repeating a text character inserts
338 it several times.
339
340 >> Try that now -- type C-u 8 * to insert ********.
341
342 You've now learned the most basic way of typing something in
343 Emacs and correcting errors. You can delete by words or lines
344 as well. Here is a summary of the delete operations:
345
346 <Delete> delete the character just before the cursor
347 C-d delete the next character after the cursor
348
349 M-<Delete> kill the word immediately before the cursor
350 M-d kill the next word after the cursor
351
352 C-k kill from the cursor position to end of line
353 M-k kill to the end of the current sentence
354
355 Notice that <Delete> and C-d vs M-<Delete> and M-d extend the parallel
356 started by C-f and M-f (well, <Delete> is not really a control
357 character, but let's not worry about that). C-k and M-k are like C-e
358 and M-e, sort of, in that lines are opposite sentences.
359
360 You can also kill any part of the buffer with one uniform method.
361 Move to one end of that part, and type C-@ or C-SPC (either one).
362 (SPC is the Space bar.) Move to the other end of that part, and type
363 C-w. That kills all the text between the two positions.
364
365 >> Move the cursor to the Y at the start of the previous paragraph.
366 >> Type C-SPC. Emacs should display a message "Mark set"
367 at the bottom of the screen.
368 >> Move the cursor to the n in "end", on the second line of the
369 paragraph.
370 >> Type C-w. This will kill the text starting from the Y,
371 and ending just before the n.
372
373 The difference between "killing" and "deleting" is that "killed" text
374 can be reinserted, whereas "deleted" things cannot be reinserted.
375 Reinsertion of killed text is called "yanking". Generally, the
376 commands that can remove a lot of text kill the text (they set up so
377 that you can yank the text), while the commands that remove just one
378 character, or just blank lines and spaces, do deletion (so you cannot
379 yank that text).
380
381 >> Move the cursor to the beginning of a line which is not empty.
382 Then type C-k to kill the text on that line.
383 >> Type C-k a second time. You'll see that it kills the Newline
384 which follows that line.
385
386 Note that a single C-k kills the contents of the line, and a second
387 C-k kills the line itself, and makes all the other lines move up. C-k
388 treats a numeric argument specially: it kills that many lines AND
389 their contents. This is not mere repetition. C-u 2 C-k kills two
390 lines and their newlines; typing C-k twice would not do that.
391
392 Bringing back killed text is called "yanking". (Think of it as
393 yanking back, or pulling back, some text that was taken away.) You
394 can yank the killed text either at the same place where it was killed,
395 or at some other place in the buffer, or even in a different file.
396 You can yank the text several times, which makes multiple copies of
397 it.
398
399 The command for yanking is C-y. It reinserts the last killed text,
400 at the current cursor position.
401
402 >> Try it; type C-y to yank the text back.
403
404 If you do several C-k's in a row, all of the killed text is saved
405 together, so that one C-y will yank all of the lines at once.
406
407 >> Do this now, type C-k several times.
408
409 Now to retrieve that killed text:
410
411 >> Type C-y. Then move the cursor down a few lines and type C-y
412 again. You now see how to copy some text.
413
414 What do you do if you have some text you want to yank back, and then
415 you kill something else? C-y would yank the more recent kill. But
416 the previous text is not lost. You can get back to it using the M-y
417 command. After you have done C-y to get the most recent kill, typing
418 M-y replaces that yanked text with the previous kill. Typing M-y
419 again and again brings in earlier and earlier kills. When you have
420 reached the text you are looking for, you do not have to do anything to
421 keep it. Just go on with your editing, leaving the yanked text where
422 it is.
423
424 If you M-y enough times, you come back to the starting point (the most
425 recent kill).
426
427 >> Kill a line, move around, kill another line.
428 Then do C-y to get back the second killed line.
429 Then do M-y and it will be replaced by the first killed line.
430 Do more M-y's and see what you get. Keep doing them until
431 the second kill line comes back, and then a few more.
432 If you like, you can try giving M-y positive and negative
433 arguments.
434
435
436 * UNDO
437 ------
438
439 If you make a change to the text, and then decide that it was a
440 mistake, you can undo the change with the undo command, C-x u.
441
442 Normally, C-x u undoes the changes made by one command; if you repeat
443 the C-x u several times in a row, each repetition undoes one
444 additional command.
445
446 But there are two exceptions: commands that do not change the text do
447 not count (this includes cursor motion commands and scrolling
448 command), and self-inserting characters are usually handled in groups
449 of up to 20. (This is to reduce the number of C-x u's you have to
450 type to undo insertion of text.)
451
452 >> Kill this line with C-k, then type C-x u and it should reappear.
453
454 C-_ is an alternative undo command; it works just the same as C-x u,
455 but it is easier to type several times in a row. The disadvantage of
456 C-_ is that on some keyboards it is not obvious how to type it. That
457 is why we provide C-x u as well. On some terminals, you can type C-_
458 by typing / while holding down CONTROL.
459
460 A numeric argument to C-_ or C-x u acts as a repeat count.
461
462 You can undo deletion of text just as you can undo killing of text.
463 The distinction between killing something and deleting it affects
464 whether you can yank it with C-y; it makes no difference for undo.
465
466
467 * FILES
468 -------
469
470 In order to make the text you edit permanent, you must put it in a
471 file. Otherwise, it will go away when your invocation of Emacs goes
472 away. In order to put your text in a file, you must "find" the file
473 before you enter the text. (This is also called "visiting" the file.)
474
475 Finding a file means that you see the contents of the file within
476 Emacs. In many ways, it is as if you were editing the file itself.
477 However, the changes you make using Emacs do not become permanent
478 until you "save" the file. This is so you can avoid leaving a
479 half-changed file on the system when you do not want to. Even when
480 you save, Emacs leaves the original file under a changed name in case
481 you later decide that your changes were a mistake.
482
483 If you look near the bottom of the screen you will see a line that
484 begins and ends with dashes, and starts with "--:-- TUTORIAL" or
485 something like that. This part of the screen normally shows the name
486 of the file that you are visiting. Right now, you are visiting a file
487 called "TUTORIAL" which is your personal scratch copy of the Emacs
488 tutorial. When you find a file with Emacs, that file's name will
489 appear in that precise spot.
490
491 One special thing about the command for finding a file is that you
492 have to say what file name you want. We say the command "reads an
493 argument from the terminal" (in this case, the argument is the name of
494 the file). After you type the command
495
496 C-x C-f Find a file
497
498 Emacs asks you to type the file name. The file name you type appears
499 on the bottom line of the screen. The bottom line is called the
500 minibuffer when it is used for this sort of input. You can use
501 ordinary Emacs editing commands to edit the file name.
502
503 While you are entering the file name (or any minibuffer input),
504 you can cancel the command with C-g.
505
506 >> Type C-x C-f, then type C-g. This cancels the minibuffer,
507 and also cancels the C-x C-f command that was using the
508 minibuffer. So you do not find any file.
509
510 When you have finished entering the file name, type <Return> to
511 terminate it. Then C-x C-f command goes to work, and finds the file
512 you chose. The minibuffer disappears when the C-x C-f command is
513 finished.
514
515 In a little while the file contents appear on the screen, and you can
516 edit the contents. When you wish to make your changes permanent,
517 type the command
518
519 C-x C-s Save the file
520
521 This copies the text within Emacs into the file. The first time you
522 do this, Emacs renames the original file to a new name so that it is
523 not lost. The new name is made by adding "~" to the end of the
524 original file's name.
525
526 When saving is finished, Emacs displays the name of the file written.
527 You should save fairly often, so that you will not lose very much
528 work if the system should crash.
529
530 >> Type C-x C-s, saving your copy of the tutorial.
531 This should show "Wrote ...TUTORIAL" at the bottom of the screen.
532
533 NOTE: On some systems, typing C-x C-s will freeze the screen and you
534 will see no further output from Emacs. This indicates that an
535 operating system "feature" called "flow control" is intercepting the
536 C-s and not letting it get through to Emacs. To unfreeze the screen,
537 type C-q. Then see the section "Spontaneous Entry to Incremental
538 Search" in the Emacs manual for advice on dealing with this "feature".
539
540 You can find an existing file, to view it or edit it. You can also
541 find a file which does not already exist. This is the way to create a
542 file with Emacs: find the file, which will start out empty, and then
543 begin inserting the text for the file. When you ask to "save" the
544 file, Emacs will really create the file with the text that you have
545 inserted. From then on, you can consider yourself to be editing an
546 already existing file.
547
548
549 * BUFFERS
550 ---------
551
552 If you find a second file with C-x C-f, the first file remains
553 inside Emacs. You can switch back to it by finding it again with
554 C-x C-f. This way you can get quite a number of files inside Emacs.
555
556 >> Create a file named "foo" by typing C-x C-f foo <Return>.
557 Then insert some text, edit it, and save "foo" by typing C-x C-s.
558 Finally, type C-x C-f TUTORIAL <Return>
559 to come back to the tutorial.
560
561 Emacs stores each file's text inside an object called a "buffer".
562 Finding a file makes a new buffer inside Emacs. To see a list of the
563 buffers that currently exist in your Emacs job, type
564
565 C-x C-b List buffers
566
567 >> Try C-x C-b now.
568
569 See how each buffer has a name, and it may also have a file name
570 for the file whose contents it holds. Some buffers do not correspond
571 to files. For example, the buffer named "*Buffer List*" does
572 not have any file. It is the buffer which contains the buffer
573 list that was made by C-x C-b. ANY text you see in an Emacs window
574 is always part of some buffer.
575
576 >> Type C-x 1 to get rid of the buffer list.
577
578 If you make changes to the text of one file, then find another file,
579 this does not save the first file. Its changes remain inside Emacs,
580 in that file's buffer. The creation or editing of the second file's
581 buffer has no effect on the first file's buffer. This is very useful,
582 but it also means that you need a convenient way to save the first
583 file's buffer. It would be a nuisance to have to switch back to
584 it with C-x C-f in order to save it with C-x C-s. So we have
585
586 C-x s Save some buffers
587
588 C-x s asks you about each buffer which contains changes that you have
589 not saved. It asks you, for each such buffer, whether to save the
590 buffer.
591
592 >> Insert a line of text, then type C-x s.
593 It should ask you whether to save the buffer named TUTORIAL.
594 Answer yes to the question by typing "y".
595
596
597 * EXTENDING THE COMMAND SET
598 ---------------------------
599
600 There are many, many more Emacs commands than could possibly be put
601 on all the control and meta characters. Emacs gets around this with
602 the X (eXtend) command. This comes in two flavors:
603
604 C-x Character eXtend. Followed by one character.
605 M-x Named command eXtend. Followed by a long name.
606
607 These are commands that are generally useful but used less than the
608 commands you have already learned about. You have already seen two of
609 them: the file commands C-x C-f to Find and C-x C-s to Save. Another
610 example is the command to end the Emacs session--this is the command
611 C-x C-c. (Do not worry about losing changes you have made; C-x C-c
612 offers to save each changed file before it kills the Emacs.)
613
614 C-z is the command to exit Emacs *temporarily*--so that you can go
615 back to the same Emacs session afterward.
616
617 On systems which allow it, C-z "suspends" Emacs; that is, it returns
618 to the shell but does not destroy the Emacs. In the most common
619 shells, you can resume Emacs with the `fg' command or with `%emacs'.
620
621 On systems which do not implement suspending, C-z creates a subshell
622 running under Emacs to give you the chance to run other programs and
623 return to Emacs afterward; it does not truly "exit" from Emacs. In
624 this case, the shell command `exit' is the usual way to get back to
625 Emacs from the subshell.
626
627 The time to use C-x C-c is when you are about to log out. It's also
628 the right thing to use to exit an Emacs invoked under mail handling
629 programs and other miscellaneous utilities, since they may not know
630 how to cope with suspension of Emacs. In ordinary circumstances,
631 though, if you are not about to log out, it is better to suspend Emacs
632 with C-z instead of exiting Emacs.
633
634 There are many C-x commands. Here is a list of the ones you have learned:
635
636 C-x C-f Find file.
637 C-x C-s Save file.
638 C-x C-b List buffers.
639 C-x C-c Quit Emacs.
640 C-x 1 Delete all but one window.
641 C-x u Undo.
642
643 Named eXtended commands are commands which are used even less
644 frequently, or commands which are used only in certain modes. An
645 example is the command replace-string, which globally replaces one
646 string with another. When you type M-x, Emacs prompts you at the
647 bottom of the screen with M-x and you should type the name of the
648 command; in this case, "replace-string". Just type "repl s<TAB>" and
649 Emacs will complete the name. (<TAB> is the Tab key, usually found
650 above the CapsLock or Shift key near the left edge of the keyboard.)
651 End the command name with <Return>.
652
653 The replace-string command requires two arguments--the string to be
654 replaced, and the string to replace it with. You must end each
655 argument with <Return>.
656
657 >> Move the cursor to the blank line two lines below this one.
658 Then type M-x repl s<Return>changed<Return>altered<Return>.
659
660 Notice how this line has changed: you've replaced
661 the word c-h-a-n-g-e-d with "altered" wherever it occurred,
662 after the initial position of the cursor.
663
664
665 * AUTO SAVE
666 -----------
667
668 When you have made changes in a file, but you have not saved them yet,
669 they could be lost if your computer crashes. To protect you from
670 this, Emacs periodically writes an "auto save" file for each file that
671 you are editing. The auto save file name has a # at the beginning and
672 the end; for example, if your file is named "hello.c", its auto save
673 file's name is "#hello.c#". When you save the file in the normal way,
674 Emacs deletes its auto save file.
675
676 If the computer crashes, you can recover your auto-saved editing by
677 finding the file normally (the file you were editing, not the auto
678 save file) and then typing M-x recover file<Return>. When it asks for
679 confirmation, type yes<Return> to go ahead and recover the auto-save
680 data.
681
682
683 * ECHO AREA
684 -----------
685
686 If Emacs sees that you are typing multicharacter commands slowly, it
687 shows them to you at the bottom of the screen in an area called the
688 "echo area". The echo area contains the bottom line of the screen.
689
690
691 * MODE LINE
692 -----------
693
694 The line immediately above the echo area is called the "mode line".
695 The mode line says something like this:
696
697 --:** TUTORIAL (Fundamental)--L670--58%----------------
698
699 This line gives useful information about the status of Emacs and
700 the text you are editing.
701
702 You already know what the filename means--it is the file you have
703 found. -NN%-- indicates your current position in the text; it means
704 that NN percent of the text is above the top of the screen. If the
705 top of the file is on the screen, it will say --Top-- instead of
706 --00%--. If the bottom of the text is on the screen, it will say
707 --Bot--. If you are looking at text so small that all of it fits on
708 the screen, the mode line says --All--.
709
710 The L and digits indicate position in another way: they give the
711 current line number of point.
712
713 The stars near the front mean that you have made changes to the text.
714 Right after you visit or save a file, that part of the mode line shows
715 no stars, just dashes.
716
717 The part of the mode line inside the parentheses is to tell you what
718 editing modes you are in. The default mode is Fundamental which is
719 what you are using now. It is an example of a "major mode".
720
721 Emacs has many different major modes. Some of them are meant for
722 editing different languages and/or kinds of text, such as Lisp mode,
723 Text mode, etc. At any time one and only one major mode is active,
724 and its name can always be found in the mode line just where
725 "Fundamental" is now.
726
727 Each major mode makes a few commands behave differently. For example,
728 there are commands for creating comments in a program, and since each
729 programming language has a different idea of what a comment should
730 look like, each major mode has to insert comments differently. Each
731 major mode is the name of an extended command, which is how you can
732 switch to that mode. For example, M-x fundamental-mode is a command to
733 switch to Fundamental mode.
734
735 If you are going to be editing English text, such as this file, you
736 should probably use Text Mode.
737 >> Type M-x text mode<Return>.
738
739 Don't worry, none of the Emacs commands you have learned changes in
740 any great way. But you can observe that M-f and M-b now treat
741 apostrophes as part of words. Previously, in Fundamental mode,
742 M-f and M-b treated apostrophes as word-separators.
743
744 Major modes usually make subtle changes like that one: most commands
745 do "the same job" in each major mode, but they work a little bit
746 differently.
747
748 To view documentation on your current major mode, type C-h m.
749
750 >> Use C-u C-v once or more to bring this line near the top of screen.
751 >> Type C-h m, to see how Text mode differs from Fundamental mode.
752 >> Type C-x 1 to remove the documentation from the screen.
753
754 Major modes are called major because there are also minor modes.
755 Minor modes are not alternatives to the major modes, just minor
756 modifications of them. Each minor mode can be turned on or off by
757 itself, independent of all other minor modes, and independent of your
758 major mode. So you can use no minor modes, or one minor mode, or any
759 combination of several minor modes.
760
761 One minor mode which is very useful, especially for editing English
762 text, is Auto Fill mode. When this mode is on, Emacs breaks the line
763 in between words automatically whenever you insert text and make a
764 line that is too wide.
765
766 You can turn Auto Fill mode on by doing M-x auto fill mode<Return>.
767 When the mode is on, you can turn it off again by doing M-x
768 auto fill mode<Return>. If the mode is off, this command turns it on,
769 and if the mode is on, this command turns it off. We say that the
770 command "toggles the mode".
771
772 >> Type M-x auto fill mode<Return> now. Then insert a line of "asdf "
773 over again until you see it divide into two lines. You must put in
774 spaces between them because Auto Fill breaks lines only at spaces.
775
776 The margin is usually set at 70 characters, but you can change it
777 with the C-x f command. You should give the margin setting you want
778 as a numeric argument.
779
780 >> Type C-x f with an argument of 20. (C-u 2 0 C-x f).
781 Then type in some text and see Emacs fill lines of 20
782 characters with it. Then set the margin back to 70 using
783 C-x f again.
784
785 If you make changes in the middle of a paragraph, Auto Fill mode
786 does not re-fill it for you.
787 To re-fill the paragraph, type M-q (META-q) with the cursor inside
788 that paragraph.
789
790 >> Move the cursor into the previous paragraph and type M-q.
791
792
793 * SEARCHING
794 -----------
795
796 Emacs can do searches for strings (these are groups of contiguous
797 characters or words) either forward through the text or backward
798 through it. Searching for a string is a cursor motion command;
799 it moves the cursor to the next place where that string appears.
800
801 The Emacs search command is different from the search commands
802 of most editors, in that it is "incremental". This means that the
803 search happens while you type in the string to search for.
804
805 The command to initiate a search is C-s for forward search, and C-r
806 for reverse search. BUT WAIT! Don't try them now.
807
808 When you type C-s you'll notice that the string "I-search" appears as
809 a prompt in the echo area. This tells you that Emacs is in what is
810 called an incremental search waiting for you to type the thing that
811 you want to search for. <Return> terminates a search.
812
813 >> Now type C-s to start a search. SLOWLY, one letter at a time,
814 type the word 'cursor', pausing after you type each
815 character to notice what happens to the cursor.
816 Now you have searched for "cursor", once.
817 >> Type C-s again, to search for the next occurrence of "cursor".
818 >> Now type <Delete> four times and see how the cursor moves.
819 >> Type <Return> to terminate the search.
820
821 Did you see what happened? Emacs, in an incremental search, tries to
822 go to the occurrence of the string that you've typed out so far. To
823 go to the next occurrence of 'cursor' just type C-s again. If no such
824 occurrence exists, Emacs beeps and tells you the search is currently
825 "failing". C-g would also terminate the search.
826
827 NOTE: On some systems, typing C-s will freeze the screen and you will
828 see no further output from Emacs. This indicates that an operating
829 system "feature" called "flow control" is intercepting the C-s and not
830 letting it get through to Emacs. To unfreeze the screen, type C-q.
831 Then see the section "Spontaneous Entry to Incremental Search" in the
832 Emacs manual for advice on dealing with this "feature".
833
834 If you are in the middle of an incremental search and type <Delete>,
835 you'll notice that the last character in the search string is erased
836 and the search backs up to the last place of the search. For
837 instance, suppose you have typed "c", to search for the first
838 occurrence of "c". Now if you type "u", the cursor will move
839 to the first occurrence of "cu". Now type <Delete>. This erases
840 the "u" from the search string, and the cursor moves back to
841 the first occurrence of "c".
842
843 If you are in the middle of a search and type a control or meta
844 character (with a few exceptions--characters that are special in
845 a search, such as C-s and C-r), the search is terminated.
846
847 The C-s starts a search that looks for any occurrence of the search
848 string AFTER the current cursor position. If you want to search for
849 something earlier in the text, type C-r instead. Everything that we
850 have said about C-s also applies to C-r, except that the direction of
851 the search is reversed.
852
853
854 * MULTIPLE WINDOWS
855 ------------------
856
857 One of the nice features of Emacs is that you can display more than one
858 window on the screen at the same time.
859
860 >> Move the cursor to this line and type C-u 0 C-l (that's CONTROL-L, not
861 CONTROL-1).
862
863 >> Now type C-x 2 which splits the screen into two windows.
864 Both windows display this tutorial. The cursor stays in the top window.
865
866 >> Type C-M-v to scroll the bottom window.
867 (If you do not have a real META key, type ESC C-v.)
868
869 >> Type C-x o ("o" for "other") to move the cursor to the bottom window.
870 >> Use C-v and M-v in the bottom window to scroll it.
871 Keep reading these directions in the top window.
872
873 >> Type C-x o again to move the cursor back to the top window.
874 The cursor in the top window is just where it was before.
875
876 You can keep using C-x o to switch between the windows. Each
877 window has its own cursor position, but only one window actually
878 shows the cursor. All the ordinary editing commands apply to the
879 window that the cursor is in. We call this the "selected window".
880
881 The command C-M-v is very useful when you are editing text in one
882 window and using the other window just for reference. You can keep
883 the cursor always in the window where you are editing, and advance
884 through the other window sequentially with C-M-v.
885
886 C-M-v is an example of a CONTROL-META character. If you have a real
887 META key, you can type C-M-v by holding down both CONTROL and META while
888 typing v. It does not matter whether CONTROL or META "comes first,"
889 because both of these keys act by modifying the characters you type.
890
891 If you do not have a real META key, and you use ESC instead, the order
892 does matter: you must type ESC followed by CONTROL-v, because
893 CONTROL-ESC v will not work. This is because ESC is a character in
894 its own right, not a modifier key.
895
896 >> Type C-x 1 (in the top window) to get rid of the bottom window.
897
898 (If you had typed C-x 1 in the bottom window, that would get rid
899 of the top one. Think of this command as "Keep just one
900 window--the window I am already in.")
901
902 You do not have to display the same buffer in both windows. If you
903 use C-x C-f to find a file in one window, the other window does not
904 change. You can find a file in each window independently.
905
906 Here is another way to use two windows to display two different
907 things:
908
909 >> Type C-x 4 C-f followed by the name of one of your files.
910 End with <Return>. See the specified file appear in the bottom
911 window. The cursor goes there, too.
912
913 >> Type C-x o to go back to the top window, and C-x 1 to delete
914 the bottom window.
915
916
917 * RECURSIVE EDITING LEVELS
918 --------------------------
919
920 Sometimes you will get into what is called a "recursive editing
921 level". This is indicated by square brackets in the mode line,
922 surrounding the parentheses around the major mode name. For
923 example, you might see [(Fundamental)] instead of (Fundamental).
924
925 To get out of the recursive editing level, type ESC ESC ESC. That is
926 an all-purpose "get out" command. You can also use it for eliminating
927 extra windows, and getting out of the minibuffer.
928
929 >> Type M-x to get into a minibuffer; then type ESC ESC ESC to get out.
930
931 You cannot use C-g to get out of a recursive editing level. This is
932 because C-g is used for canceling commands and arguments WITHIN the
933 recursive editing level.
934
935
936 * GETTING MORE HELP
937 -------------------
938
939 In this tutorial we have tried to supply just enough information to
940 get you started using Emacs. There is so much available in Emacs that
941 it would be impossible to explain it all here. However, you may want
942 to learn more about Emacs since it has many other useful features.
943 Emacs provides commands for reading documentation about Emacs
944 commands. These "help" commands all start with the character
945 CONTROL-h, which is called "the Help character".
946
947 To use the Help features, type the C-h character, and then a
948 character saying what kind of help you want. If you are REALLY lost,
949 type C-h ? and Emacs will tell you what kinds of help it can give.
950 If you have typed C-h and decide you do not want any help, just
951 type C-g to cancel it.
952
953 (Some sites change the meaning of the character C-h. They really
954 should not do this as a blanket measure for all users, so you have
955 grounds to complain to the system administrator. Meanwhile, if C-h
956 does not display a message about help at the bottom of the screen, try
957 typing the F1 key or M-x help <Return> instead.)
958
959 The most basic HELP feature is C-h c. Type C-h, the character c, and
960 a command character or sequence; then Emacs displays a very brief
961 description of the command.
962
963 >> Type C-h c C-p.
964 The message should be something like
965
966 C-p runs the command previous-line
967
968 This tells you the "name of the function". Function names are used
969 mainly for customizing and extending Emacs. But since function names
970 are chosen to indicate what the command does, they can serve also as
971 very brief documentation--sufficient to remind you of commands you
972 have already learned.
973
974 Multi-character commands such as C-x C-s and (if you have no META or
975 EDIT or ALT key) <ESC>v are also allowed after C-h c.
976
977 To get more information about a command, use C-h k instead of C-h c.
978
979 >> Type C-h k C-p.
980
981 This displays the documentation of the function, as well as its
982 name, in an Emacs window. When you are finished reading the
983 output, type C-x 1 to get rid of the help text. You do not have
984 to do this right away. You can do some editing while referring
985 to the help text, and then type C-x 1.
986
987 Here are some other useful C-h options:
988
989 C-h f Describe a function. You type in the name of the
990 function.
991
992 >> Try typing C-h f previous-line<Return>.
993 This displays all the information Emacs has about the
994 function which implements the C-p command.
995
996 A similar command C-h v displays the documentation of variables whose
997 values you can set to customize Emacs behavior. You need to type in
998 the name of the variable when Emacs prompts for it.
999
1000 C-h a Command Apropos. Type in a keyword and Emacs will list
1001 all the commands whose names contain that keyword.
1002 These commands can all be invoked with META-x.
1003 For some commands, Command Apropos will also list a one
1004 or two character sequence which runs the same command.
1005
1006 >> Type C-h a file<Return>.
1007
1008 This displays in another window a list of all M-x commands with "file"
1009 in their names. You will see character-commands like C-x C-f listed
1010 beside the corresponding command names such as find-file.
1011
1012 >> Type C-M-v to scroll the help window. Do this a few times.
1013
1014 >> Type C-x 1 to delete the help window.
1015
1016 C-h i Read On-line Manuals (a.k.a. Info). This command puts
1017 you into a special buffer called `*info*' where you
1018 can read on-line manuals for the packages installed on
1019 your system. Type m emacs <Return> to read the Emacs
1020 manual. If you have never before used Info, type ?
1021 and Emacs will take you on a guided tour of Info mode
1022 facilities. Once you are through with this tutorial,
1023 you should consult the Emacs Info manual as your
1024 primary documentation.
1025
1026
1027 * CONCLUSION
1028 ------------
1029
1030 Remember, to exit Emacs permanently use C-x C-c. To exit to a shell
1031 temporarily, so that you can come back to Emacs afterward, use C-z.
1032
1033 This tutorial is meant to be understandable to all new users, so if
1034 you found something unclear, don't sit and blame yourself - complain!
1035
1036
1037 * COPYING
1038 ---------
1039
1040 This tutorial descends from a long line of Emacs tutorials
1041 starting with the one written by Stuart Cracraft for the original Emacs.
1042
1043 This version of the tutorial, like GNU Emacs, is copyrighted, and
1044 comes with permission to distribute copies on certain conditions:
1045
1046 Copyright (c) 1985, 1996 Free Software Foundation
1047
1048 Permission is granted to anyone to make or distribute verbatim copies
1049 of this document as received, in any medium, provided that the
1050 copyright notice and permission notice are preserved,
1051 and that the distributor grants the recipient permission
1052 for further redistribution as permitted by this notice.
1053
1054 Permission is granted to distribute modified versions
1055 of this document, or of portions of it,
1056 under the above conditions, provided also that they
1057 carry prominent notices stating who last altered them.
1058
1059 The conditions for copying Emacs itself are more complex, but in the
1060 same spirit. Please read the file COPYING and then do give copies of
1061 GNU Emacs to your friends. Help stamp out software obstructionism
1062 ("ownership") by using, writing, and sharing free software!