(tooltip-show): If an error is signaled in
[emacs.git] / etc / TUTORIAL
blob4437ecd47b04b112e9bb10652bb357fbe2a564bd
1 Copyright (c) 1985 Free Software Foundation, Inc;  See end for conditions.
2 You are looking at the Emacs tutorial.
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:
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.
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.
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.
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).
32 >>  Try typing M-v and then C-v, a few times.
35 * SUMMARY
36 ---------
38 The following commands are useful for viewing screenfuls:
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.)
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.
53 * BASIC CURSOR CONTROL
54 ----------------------
56 Moving from screenful to screenful is useful, but how do you
57 move to a specific place within the text on the screen?
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:
65                           Previous line, C-p
66                                   :
67                                   :
68    Backward, C-b .... Current cursor position .... Forward, C-f
69                                   :
70                                   :
71                             Next line, C-n
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.
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.
82 >> Do a few C-n's to bring the cursor down to this line.
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.
87 Each of text line 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).
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.
96 C-f can move across a Newline just like C-b.
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.
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.
107 >> Try to move the cursor off the bottom of the screen with C-n, and
108    see what happens.
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.
113 >> Type a few M-f's and M-b's.
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.
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.
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).
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.
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.
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.
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.
144 Here is a summary of simple cursor-moving operations, including the
145 word and sentence moving commands:
147         C-f     Move forward a character
148         C-b     Move backward a character
150         M-f     Move forward a word
151         M-b     Move backward a word
153         C-n     Move to next line
154         C-p     Move to previous line
156         C-a     Move to beginning of line
157         C-e     Move to end of line
159         M-a     Move back to beginning of sentence
160         M-e     Move forward to end of sentence
162 >> Try all of these commands now a few times for practice.
163    These are the most often used commands.
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.
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.
173 >> Try M-< now, to move to the beginning of the tutorial.
174    Then use C-v repeatedly to move back here.
176 >> Try M-> now, to move to the end of the tutorial.
177    Then use M-v repeatedly to move back here.
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.
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.
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.
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.
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.
212 >> Try typing C-u 8 C-v now.
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.
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.
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.
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.
231 * WHEN EMACS IS HUNG
232 --------------------
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.
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.
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.
245 If you have typed an <ESC> by mistake, you can get rid of it
246 with a C-g.
249 * DISABLED COMMANDS
250 -------------------
252 Some Emacs commands are "disabled" so that beginning users cannot use
253 them by accident.
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.
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".
263 >> Type C-x C-l (which is a disabled command),
264    then type n to answer the question.
267 * WINDOWS
268 ---------
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:
275         C-x 1   One window (i.e., kill all other windows).
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.
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.
286 >> Type C-x 1 and see the documentation listing window disappear.
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.
295 * INSERTING AND DELETING
296 ------------------------
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.
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!
307 More generally, <Delete> deletes the character immediately before the
308 current cursor position.
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.
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 at the right margin indicates a line which has been continued.
319 >> Insert text until you reach the right margin, and keep on inserting.
320    You'll see a continuation line appear.
322 >> Use <Delete>s to delete the text until the line fits on one screen
323    line again.  The continuation line goes away.
325 You can delete a Newline character just like any other character.
326 Deleting the Newline character between two lines merges them into
327 one line.  If the resulting combined line is too long to fit in the
328 screen width, it will be displayed with a continuation line.
330 >> Move the cursor to the beginning of a line and type <Delete>.  This
331    merges that line with the previous line.
333 >> Type <Return> to reinsert the Newline you deleted.
335 Remember that most Emacs commands can be given a repeat count;
336 this includes text characters.  Repeating a text character inserts
337 it several times.
339 >>  Try that now -- type C-u 8 * to insert ********.
341 You've now learned the most basic way of typing something in
342 Emacs and correcting errors.  You can delete by words or lines
343 as well.  Here is a summary of the delete operations:
345         <Delete>     delete the character just before the cursor
346         C-d          delete the next character after the cursor
348         M-<Delete>   kill the word immediately before the cursor
349         M-d          kill the next word after the cursor
351         C-k          kill from the cursor position to end of line
352         M-k          kill to the end of the current sentence
354 Notice that <Delete> and C-d vs M-<Delete> and M-d extend the parallel
355 started by C-f and M-f (well, <Delete> is not really a control
356 character, but let's not worry about that).  C-k and M-k are like C-e
357 and M-e, sort of, in that lines are opposite sentences.
359 You can also kill any part of the buffer with one uniform method.
360 Move to one end of that part, and type C-@ or C-SPC (either one).
361 (SPC is the Space bar.)  Move to the other end of that part, and type
362 C-w.  That kills all the text between the two positions.
364 >> Move the cursor to the Y at the start of the previous paragraph.
365 >> Type C-SPC.  Emacs should display a message "Mark set"
366    at the bottom of the screen.
367 >> Move the cursor to the n in "end", on the second line of the
368    paragraph.
369 >> Type C-w.  This will kill the text starting from the Y,
370    and ending just before the n.
372 When you delete more than one character at a time, Emacs saves the
373 deleted text so that you can bring it back.  Bringing back killed text
374 is called "yanking".  You can yank the killed text either at the same
375 place where it was killed, or at some other place in the text.  You
376 can yank the text several times in order to make multiple copies of
377 it.  The command to yank is C-y.
379 Note that the difference between "Killing" and "Deleting" something is
380 that "Killed" things can be yanked back, and "Deleted" things cannot.
381 Generally, the commands that can remove a lot of text save the text,
382 while the commands that delete just one character, or just blank lines
383 and spaces, do not save the deleted text.
385 >> Move the cursor to the  beginning of a line which is not empty.
386    Then type C-k to kill the text on that line.
387 >> Type C-k a second time.  You'll see that it kills the Newline
388    which follows that line.
390 Note that a single C-k kills the contents of the line, and a second
391 C-k kills the line itself, and makes all the other lines move up.  C-k
392 treats a numeric argument specially: it kills that many lines AND
393 their contents.  This is not mere repetition.  C-u 2 C-k kills two
394 lines and their newlines; typing C-k twice would not do that.
396 To retrieve the last killed text and put it where the cursor currently
397 is, type C-y.
399 >> Try it; type C-y to yank the text back.
401 Think of C-y as if you were yanking something back that someone took
402 away from you.  Notice that if you do several C-k's in a row, all of
403 the killed text is saved together, so that one C-y will yank all of
404 the lines.
406 >> Do this now, type C-k several times.
408 Now to retrieve that killed text:
410 >> Type C-y.  Then move the cursor down a few lines and type C-y
411    again.  You now see how to copy some text.
413 What do you do if you have some text you want to yank back, and then
414 you kill something else?  C-y would yank the more recent kill.  But
415 the previous text is not lost.  You can get back to it using the M-y
416 command.  After you have done C-y to get the most recent kill, typing
417 M-y replaces that yanked text with the previous kill.  Typing M-y
418 again and again brings in earlier and earlier kills.  When you have
419 reached the text you are looking for, you do not have to do anything to
420 keep it.  Just go on with your editing, leaving the yanked text where
421 it is.
423 If you M-y enough times, you come back to the starting point (the most
424 recent kill).
426 >> Kill a line, move around, kill another line.
427    Then do C-y to get back the second killed line.
428    Then do M-y and it will be replaced by the first killed line.
429    Do more M-y's and see what you get.  Keep doing them until
430    the second kill line comes back, and then a few more.
431    If you like, you can try giving M-y positive and negative
432    arguments.
435 * UNDO
436 ------
438 If you make a change to the text, and then decide that it was a
439 mistake, you can undo the change with the undo command, C-x u.
441 Normally, C-x u undoes the changes made by one command; if you repeat
442 the C-x u several times in a row, each repetition undoes one
443 additional command.
445 But there are two exceptions: commands that do not change the text do
446 not count (this includes cursor motion commands and scrolling
447 command), and self-inserting characters are usually handled in groups
448 of up to 20.  (This is to reduce the number of C-x u's you have to
449 type to undo insertion of text.)
451 >> Kill this line with C-k, then type C-x u and it should reappear.
453 C-_ is an alternative undo command; it works just the same as C-x u,
454 but it is easier to type several times in a row.  The disadvantage of
455 C-_ is that on some keyboards it is not obvious how to type it.  That
456 is why we provide C-x u as well.  On some terminals, you can type C-_
457 by typing / while holding down CONTROL.
459 A numeric argument to C-_ or C-x u acts as a repeat count.
462 * FILES
463 -------
465 In order to make the text you edit permanent, you must put it in a
466 file.  Otherwise, it will go away when your invocation of Emacs goes
467 away.  In order to put your text in a file, you must "find" the file
468 before you enter the text.  (This is also called "visiting" the file.)
470 Finding a file means that you see the contents of the file within
471 Emacs.  In many ways, it is as if you were editing the file itself.
472 However, the changes you make using Emacs do not become permanent
473 until you "save" the file.  This is so you can avoid leaving a
474 half-changed file on the system when you do not want to.  Even when
475 you save, Emacs leaves the original file under a changed name in case
476 you later decide that your changes were a mistake.
478 If you look near the bottom of the screen you will see a line that
479 begins and ends with dashes, and starts with "--:-- TUTORIAL" or
480 something like that.  This part of the screen normally shows the name
481 of the file that you are visiting.  Right now, you are visiting a file
482 called "TUTORIAL" which is your personal scratch copy of the Emacs
483 tutorial.  When you find a file with Emacs, that file's name will
484 appear in that precise spot.
486 One special thing about the command for finding a file is that you
487 have to say what file name you want.  We say the command "reads an
488 argument from the terminal" (in this case, the argument is the name of
489 the file).  After you type the command
491         C-x C-f   Find a file
493 Emacs asks you to type the file name.  The file name you type appears
494 on the bottom line of the screen.  The bottom line is called the
495 minibuffer when it is used for this sort of input.  You can use
496 ordinary Emacs editing commands to edit the file name.
498 While you are entering the file name (or any minibuffer input),
499 you can cancel the command with C-g.
501 >> Type C-x C-f, then type C-g.  This cancels the minibuffer,
502    and also cancels the C-x C-f command that was using the
503    minibuffer.  So you do not find any file.
505 When you have finished entering the file name, type <Return> to
506 terminate it.  Then C-x C-f command goes to work, and finds the file
507 you chose.  The minibuffer disappears when the C-x C-f command is
508 finished.
510 In a little while the file contents appear on the screen, and you can
511 edit the contents.  When you wish to make your changes permanent,
512 type the command
514         C-x C-s   Save the file
516 This copies the text within Emacs into the file.  The first time you
517 do this, Emacs renames the original file to a new name so that it is
518 not lost.  The new name is made by adding "~" to the end of the
519 original file's name.
521 When saving is finished, Emacs prints the name of the file written.
522 You should save fairly often, so that you will not lose very much
523 work if the system should crash.
525 >> Type C-x C-s, saving your copy of the tutorial.
526    This should print "Wrote ...TUTORIAL" at the bottom of the screen.
528 NOTE: On some systems, typing C-x C-s will freeze the screen and you
529 will see no further output from Emacs.  This indicates that an
530 operating system "feature" called "flow control" is intercepting the
531 C-s and not letting it get through to Emacs.  To unfreeze the screen,
532 type C-q.  Then see the section "Spontaneous Entry to Incremental
533 Search" in the Emacs manual for advice on dealing with this "feature".
535 You can find an existing file, to view it or edit it.  You can also
536 find a file which does not already exist.  This is the way to create a
537 file with Emacs: find the file, which will start out empty, and then
538 begin inserting the text for the file.  When you ask to "save" the
539 file, Emacs will really create the file with the text that you have
540 inserted.  From then on, you can consider yourself to be editing an
541 already existing file.
544 * BUFFERS
545 ---------
547 If you find a second file with C-x C-f, the first file remains
548 inside Emacs.  You can switch back to it by finding it again with
549 C-x C-f.  This way you can get quite a number of files inside Emacs.
551 >> Create a file named "foo" by typing  C-x C-f foo <Return>.
552    Then insert some text, edit it, and save "foo" by typing  C-x C-s.
553    Finally, type C-x C-f TUTORIAL <Return>
554    to come back to the tutorial.
556 Emacs stores each file's text inside an object called a "buffer".
557 Finding a file makes a new buffer inside Emacs.  To see a list of the
558 buffers that currently exist in your Emacs job, type
560         C-x C-b   List buffers
562 >> Try C-x C-b now.
564 See how each buffer has a name, and it may also have a file name
565 for the file whose contents it holds.  Some buffers do not correspond
566 to files.  For example, the buffer named "*Buffer List*" does
567 not have any file.  It is the buffer which contains the buffer
568 list that was made by C-x C-b.  ANY text you see in an Emacs window
569 is always part of some buffer.
571 >> Type C-x 1 to get rid of the buffer list.
573 If you make changes to the text of one file, then find another file,
574 this does not save the first file.  Its changes remain inside Emacs,
575 in that file's buffer.  The creation or editing of the second file's
576 buffer has no effect on the first file's buffer.  This is very useful,
577 but it also means that you need a convenient way to save the first
578 file's buffer.  It would be a nuisance to have to switch back to
579 it with C-x C-f in order to save it with C-x C-s.  So we have
581         C-x s     Save some buffers
583 C-x s asks you about each buffer which contains changes that you have
584 not saved.  It asks you, for each such buffer, whether to save the
585 buffer.
587 >> Insert a line of text, then type C-x s.
588    It should ask you whether to save the buffer named TUTORIAL.
589    Answer yes to the question by typing "y".
592 * EXTENDING THE COMMAND SET
593 ---------------------------
595 There are many, many more Emacs commands than could possibly be put
596 on all the control and meta characters.  Emacs gets around this with
597 the X (eXtend) command.  This comes in two flavors:
599         C-x     Character eXtend.  Followed by one character.
600         M-x     Named command eXtend.  Followed by a long name.
602 These are commands that are generally useful but used less than the
603 commands you have already learned about.  You have already seen two of
604 them: the file commands C-x C-f to Find and C-x C-s to Save.  Another
605 example is the command to end the Emacs session--this is the command
606 C-x C-c.  (Do not worry about losing changes you have made; C-x C-c
607 offers to save each changed file before it kills the Emacs.)
609 C-z is the command to exit Emacs *temporarily*--so that you can go
610 back to the same Emacs session afterward.
612 On systems which allow it, C-z "suspends" Emacs; that is, it returns
613 to the shell but does not destroy the Emacs.  In the most common
614 shells, you can resume Emacs with the `fg' command or with `%emacs'.
616 On systems which do not implement suspending, C-z creates a subshell
617 running under Emacs to give you the chance to run other programs and
618 return to Emacs afterward; it does not truly "exit" from Emacs.  In
619 this case, the shell command `exit' is the usual way to get back to
620 Emacs from the subshell.
622 The time to use C-x C-c is when you are about to log out.  It's also
623 the right thing to use to exit an Emacs invoked under mail handling
624 programs and other miscellaneous utilities, since they may not know
625 how to cope with suspension of Emacs.  In ordinary circumstances,
626 though, if you are not about to log out, it is better to suspend Emacs
627 with C-z instead of exiting Emacs.
629 There are many C-x commands.  Here is a list of the ones you have learned:
631         C-x C-f         Find file.
632         C-x C-s         Save file.
633         C-x C-b         List buffers.
634         C-x C-c         Quit Emacs.
635         C-x 1           Delete all but one window.
636         C-x u           Undo.
638 Named eXtended commands are commands which are used even less
639 frequently, or commands which are used only in certain modes.  An
640 example is the command replace-string, which globally replaces one
641 string with another.  When you type M-x, Emacs prompts you at the
642 bottom of the screen with M-x and you should type the name of the
643 command; in this case, "replace-string".  Just type "repl s<TAB>" and
644 Emacs will complete the name.  (<TAB> is the Tab key, usually found
645 above the CapsLock or Shift key near the left edge of the keyboard.)
646 End the command name with <Return>.
648 The replace-string command requires two arguments--the string to be
649 replaced, and the string to replace it with.  You must end each
650 argument with <Return>.
652 >> Move the cursor to the blank line two lines below this one.
653    Then type M-x repl s<Return>changed<Return>altered<Return>.
655    Notice how this line has changed: you've replaced
656    the word c-h-a-n-g-e-d with "altered" wherever it occurred,
657    after the initial position of the cursor.
660 * AUTO SAVE
661 -----------
663 When you have made changes in a file, but you have not saved them yet,
664 they could be lost if your computer crashes.  To protect you from
665 this, Emacs periodically writes an "auto save" file for each file that
666 you are editing.  The auto save file name has a # at the beginning and
667 the end; for example, if your file is named "hello.c", its auto save
668 file's name is "#hello.c#".  When you save the file in the normal way,
669 Emacs deletes its auto save file.
671 If the computer crashes, you can recover your auto-saved editing by
672 finding the file normally (the file you were editing, not the auto
673 save file) and then typing M-x recover file<Return>.  When it asks for
674 confirmation, type yes<Return> to go ahead and recover the auto-save
675 data.
678 * ECHO AREA
679 -----------
681 If Emacs sees that you are typing multicharacter commands slowly, it
682 shows them to you at the bottom of the screen in an area called the
683 "echo area".  The echo area contains the bottom line of the screen.
686 * MODE LINE
687 -----------
689 The line immediately above the echo area is called the "mode line".
690 The mode line says something like this:
692 --:**  TUTORIAL          (Fundamental)--L670--58%----------------
694 This line gives useful information about the status of Emacs and
695 the text you are editing.
697 You already know what the filename means--it is the file you have
698 found.  -NN%-- indicates your current position in the text; it means
699 that NN percent of the text is above the top of the screen.  If the
700 top of the file is on the screen, it will say --Top-- instead of
701 --00%--.  If the bottom of the text is on the screen, it will say
702 --Bot--.  If you are looking at text so small that all of it fits on
703 the screen, the mode line says --All--.
705 The L and digits indicate position in another way: they give the
706 current line number of point.
708 The stars near the front mean that you have made changes to the text.
709 Right after you visit or save a file, that part of the mode line shows
710 no stars, just dashes.
712 The part of the mode line inside the parentheses is to tell you what
713 editing modes you are in.  The default mode is Fundamental which is
714 what you are using now.  It is an example of a "major mode".  
716 Emacs has many different major modes.  Some of them are meant for
717 editing different languages and/or kinds of text, such as Lisp mode,
718 Text mode, etc.  At any time one and only one major mode is active,
719 and its name can always be found in the mode line just where
720 "Fundamental" is now.
722 Each major mode makes a few commands behave differently.  For example,
723 there are commands for creating comments in a program, and since each
724 programming language has a different idea of what a comment should
725 look like, each major mode has to insert comments differently.  Each
726 major mode is the name of an extended command, which is how you can
727 switch to that mode.  For example, M-x fundamental-mode is a command to
728 switch to Fundamental mode.
730 If you are going to be editing English text, such as this file, you
731 should probably use Text Mode.
732 >> Type M-x text mode<Return>.
734 Don't worry, none of the  Emacs commands you have learned changes in
735 any great way.  But you can observe that M-f and M-b now treat
736 apostrophes as part of words.  Previously, in Fundamental mode,
737 M-f and M-b treated apostrophes as word-separators.
739 Major modes usually make subtle changes like that one: most commands
740 do "the same job" in each major mode, but they work a little bit
741 differently.
743 To view documentation on your current major mode, type C-h m.
745 >> Use C-u C-v once or more to bring this line near the top of screen.
746 >> Type C-h m, to see how Text mode differs from Fundamental mode.
747 >> Type C-x 1 to remove the documentation from the screen.
749 Major modes are called major because there are also minor modes.
750 Minor modes are not alternatives to the major modes, just minor
751 modifications of them.  Each minor mode can be turned on or off by
752 itself, independent of all other minor modes, and independent of your
753 major mode.  So you can use no minor modes, or one minor mode, or any
754 combination of several minor modes.
756 One minor mode which is very useful, especially for editing English
757 text, is Auto Fill mode.  When this mode is on, Emacs breaks the line
758 in between words automatically whenever you insert text and make a
759 line that is too wide.
761 You can turn Auto Fill mode on by doing M-x auto fill mode<Return>.
762 When the mode is on, you can turn it off again by doing M-x
763 auto fill mode<Return>.  If the mode is off, this command turns it on,
764 and if the mode is on, this command turns it off.  We say that the
765 command "toggles the mode".
767 >> Type M-x auto fill mode<Return> now.  Then insert a line of "asdf "
768    over again until you see it divide into two lines.  You must put in
769    spaces between them because Auto Fill breaks lines only at spaces.
771 The margin is usually set at 70 characters, but you can change it
772 with the C-x f command.  You should give the margin setting you want
773 as a numeric argument.
775 >> Type C-x f with an argument of 20.  (C-u 2 0 C-x f).
776    Then type in some text and see Emacs fill lines of 20
777    characters with it.  Then set the margin back to 70 using
778    C-x f again.
780 If you make changes in the middle of a paragraph, Auto Fill mode
781 does not re-fill it for you.
782 To re-fill the paragraph, type M-q (Meta-q) with the cursor inside
783 that paragraph.
785 >> Move the cursor into the previous paragraph and type M-q.
788 * SEARCHING
789 -----------
791 Emacs can do searches for strings (these are groups of contiguous
792 characters or words) either forward through the text or backward
793 through it.  Searching for a string is a cursor motion command;
794 it moves the cursor to the next place where that string appears.
796 The Emacs search command is different from the search commands
797 of most editors, in that it is "incremental".  This means that the
798 search happens while you type in the string to search for.
800 The command to initiate a search is C-s for forward search, and C-r
801 for reverse search.  BUT WAIT!  Don't try them now.
803 When you type C-s you'll notice that the string "I-search" appears as
804 a prompt in the echo area.  This tells you that Emacs is in what is
805 called an incremental search waiting for you to type the thing that
806 you want to search for.  <Return> terminates a search.
808 >> Now type C-s to start a search.  SLOWLY, one letter at a time,
809    type the word 'cursor', pausing after you type each
810    character to notice what happens to the cursor.
811    Now you have searched for "cursor", once.
812 >> Type C-s again, to search for the next occurrence of "cursor".
813 >> Now type <Delete> four times and see how the cursor moves.
814 >> Type <Return> to terminate the search.
816 Did you see what happened?  Emacs, in an incremental search, tries to
817 go to the occurrence of the string that you've typed out so far.  To
818 go to the next occurrence of 'cursor' just type C-s again.  If no such
819 occurrence exists, Emacs beeps and tells you the search is currently
820 "failing".  C-g would also terminate the search.
822 NOTE: On some systems, typing C-s will freeze the screen and you will
823 see no further output from Emacs.  This indicates that an operating
824 system "feature" called "flow control" is intercepting the C-s and not
825 letting it get through to Emacs.  To unfreeze the screen, type C-q.
826 Then see the section "Spontaneous Entry to Incremental Search" in the
827 Emacs manual for advice on dealing with this "feature".
829 If you are in the middle of an incremental search and type <Delete>,
830 you'll notice that the last character in the search string is erased
831 and the search backs up to the last place of the search.  For
832 instance, suppose you have typed "c", to search for the first
833 occurrence of "c".  Now if you type "u", the cursor will move
834 to the first occurrence of "cu".  Now type <Delete>.  This erases
835 the "u" from the search string, and the cursor moves back to
836 the first occurrence of "c".
838 If you are in the middle of a search and type a control or meta
839 character (with a few exceptions--characters that are special in
840 a search, such as C-s and C-r), the search is terminated.
842 The C-s starts a search that looks for any occurrence of the search
843 string AFTER the current cursor position.  If you want to search for
844 something earlier in the text, type C-r instead.  Everything that we
845 have said about C-s also applies to C-r, except that the direction of
846 the search is reversed.
849 * MULTIPLE WINDOWS
850 ------------------
852 One of the nice features of Emacs is that you can display more than one
853 window on the screen at the same time.
855 >> Move the cursor to this line and type C-u 0 C-l (that's control-L, not
856    control-1).
858 >> Now type C-x 2 which splits the screen into two windows.
859    Both windows display this tutorial.  The cursor stays in the top window.
861 >> Type C-M-v to scroll the bottom window.
862    (If you do not have a real Meta key, type ESC C-v.)
864 >> Type C-x o ("o" for "other") to move the cursor to the bottom window.
865 >> Use C-v and M-v in the bottom window to scroll it.
866    Keep reading these directions in the top window.
868 >> Type C-x o again to move the cursor back to the top window.
869    The cursor in the top window is just where it was before.
871 You can keep using C-x o to switch between the windows.  Each
872 window has its own cursor position, but only one window actually
873 shows the cursor.  All the ordinary editing commands apply to the
874 window that the cursor is in.  We call this the "selected window".
876 The command C-M-v is very useful when you are editing text in one
877 window and using the other window just for reference.  You can keep
878 the cursor always in the window where you are editing, and advance
879 through the other window sequentially with C-M-v.
881 C-M-v is an example of a CONTROL-META character.  If you have a real
882 META key, you can type C-M-v by holding down both CONTROL and META while
883 typing v.  It does not matter whether CONTROL or META "comes first,"
884 because both of these keys act by modifying the characters you type.
886 If you do not have a real META key, and you use ESC instead, the order
887 does matter: you must type ESC followed by Control-v, because
888 Control-ESC v will not work.  This is because ESC is a character in
889 its own right, not a modifier key.
891 >> Type C-x 1 (in the top window) to get rid of the bottom window.
893 (If you had typed C-x 1 in the bottom window, that would get rid
894 of the top one.  Think of this command as "Keep just one
895 window--the window I am already in.")
897 You do not have to display the same buffer in both windows.  If you
898 use C-x C-f to find a file in one window, the other window does not
899 change.  You can find a file in each window independently.
901 Here is another way to use two windows to display two different
902 things:
904 >> Type C-x 4 C-f followed by the name of one of your files.
905    End with <Return>.  See the specified file appear in the bottom
906    window.  The cursor goes there, too.
908 >> Type C-x o to go back to the top window, and C-x 1 to delete
909    the bottom window.
912 * RECURSIVE EDITING LEVELS
913 --------------------------
915 Sometimes you will get into what is called a "recursive editing
916 level".  This is indicated by square brackets in the mode line,
917 surrounding the parentheses around the major mode name.  For
918 example, you might see [(Fundamental)] instead of (Fundamental).
920 To get out of the recursive editing level, type ESC ESC ESC.  That is
921 an all-purpose "get out" command.  You can also use it for eliminating
922 extra windows, and getting out of the minibuffer.
924 >> Type M-x to get into a minibuffer; then type ESC ESC ESC to get out.
926 You cannot use C-g to get out of a recursive editing level.  This is
927 because C-g is used for canceling commands and arguments WITHIN the
928 recursive editing level.
931 * GETTING MORE HELP
932 -------------------
934 In this tutorial we have tried to supply just enough information to
935 get you started using Emacs.  There is so much available in Emacs that
936 it would be impossible to explain it all here.  However, you may want
937 to learn more about Emacs since it has many other useful features.
938 Emacs provides commands for reading documentation about Emacs
939 commands.  These "help" commands all start with the character
940 Control-h, which is called "the Help character".
942 To use the Help features, type the C-h character, and then a
943 character saying what kind of help you want.  If you are REALLY lost,
944 type C-h ? and Emacs will tell you what kinds of help it can give.
945 If you have typed C-h and decide you do not want any help, just
946 type C-g to cancel it.
948 (Some sites change the meaning of the character C-h.  They really
949 should not do this as a blanket measure for all users, so you have
950 grounds to complain to the system administrator.  Meanwhile, if C-h
951 does not display a message about help at the bottom of the screen, try
952 typing the F1 key or M-x help <Return> instead.)
954 The most basic HELP feature is C-h c.  Type C-h, the character c, and
955 a command character or sequence; then Emacs displays a very brief
956 description of the command.
958 >> Type C-h c C-p.
959   The message should be something like
961         C-p runs the command previous-line
963 This tells you the "name of the function".  Function names are used
964 mainly for customizing and extending Emacs.  But since function names
965 are chosen to indicate what the command does, they can serve also as
966 very brief documentation--sufficient to remind you of commands you
967 have already learned.
969 Multi-character commands such as C-x C-s and (if you have no META or
970 EDIT or ALT key) <ESC>v are also allowed after C-h c.
972 To get more information about a command, use C-h k instead of C-h c.
974 >> Type C-h k C-p.
976 This displays the documentation of the function, as well as its
977 name, in an Emacs window.  When you are finished reading the
978 output, type C-x 1 to get rid of the help text.  You do not have
979 to do this right away.  You can do some editing while referring
980 to the help text, and then type C-x 1.
982 Here are some other useful C-h options:
984    C-h f        Describe a function.  You type in the name of the
985                 function.
987 >> Try typing C-h f previous-line<Return>.
988    This prints all the information Emacs has about the
989    function which implements the C-p command.
991    C-h a        Command Apropos.  Type in a keyword and Emacs will list
992                 all the commands whose names contain that keyword.
993                 These commands can all be invoked with Meta-x.
994                 For some commands, Command Apropos will also list a one
995                 or two character sequence which runs the same command.
997 >> Type C-h a file<Return>.
999 This displays in another window a list of all M-x commands with "file"
1000 in their names.  You will see character-commands like C-x C-f listed
1001 beside the corresponding command names such as find-file.
1003 >> Type C-M-v to scroll the help window.  Do this a few times.
1005 >> Type C-x 1 to delete the help window.
1008 * CONCLUSION
1009 ------------
1011 Remember, to exit Emacs permanently use C-x C-c.  To exit to a shell
1012 temporarily, so that you can come back to Emacs afterward, use C-z.
1014 This tutorial is meant to be understandable to all new users, so if
1015 you found something unclear, don't sit and blame yourself - complain!
1018 * COPYING
1019 ---------
1021 This tutorial descends from a long line of Emacs tutorials
1022 starting with the one written by Stuart Cracraft for the original Emacs.
1024 This version of the tutorial, like GNU Emacs, is copyrighted, and
1025 comes with permission to distribute copies on certain conditions:
1027 Copyright (c) 1985, 1996 Free Software Foundation
1029    Permission is granted to anyone to make or distribute verbatim copies
1030    of this document as received, in any medium, provided that the
1031    copyright notice and permission notice are preserved,
1032    and that the distributor grants the recipient permission
1033    for further redistribution as permitted by this notice.
1035    Permission is granted to distribute modified versions
1036    of this document, or of portions of it,
1037    under the above conditions, provided also that they
1038    carry prominent notices stating who last altered them.
1040 The conditions for copying Emacs itself are more complex, but in the
1041 same spirit.  Please read the file COPYING and then do give copies of
1042 GNU Emacs to your friends.  Help stamp out software obstructionism
1043 ("ownership") by using, writing, and sharing free software!