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