TUTORIAL 46.2 KB
Newer Older
1
Emacs tutorial.  See end for copying conditions.
Jim Blandy's avatar
Jim Blandy committed
2

Karl Heuer's avatar
Karl Heuer committed
3 4
Emacs commands generally involve the CONTROL key (sometimes labeled
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:
Jim Blandy's avatar
Jim Blandy committed
6 7 8

 C-<chr>  means hold the CONTROL key while typing the character <chr>
	  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 11
	  If there is no META, EDIT or ALT key, instead press and release the
	  ESC key and then type <chr>.  We write <ESC> for the ESC key.
Jim Blandy's avatar
Jim Blandy committed
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
To stop the tutorial, type C-x k, then <Return> at the prompt.
Jim Blandy's avatar
Jim Blandy committed
16 17
The characters ">>" at the left margin indicate directions for you to
try using a command.  For instance:
18 19
<<Blank lines inserted around following line by help-with-tutorial>>
[Middle of page left blank for didactic purposes.   Text continues below]
20
>> Now type C-v (View next screen) to scroll down in the tutorial.
21
	(go ahead, do it by holding down the CONTROL key while typing v).
22
	From now on, please do this whenever you reach the end of the screen.
Jim Blandy's avatar
Jim Blandy committed
23

24 25
Note that there is an overlap of two lines when you scroll a whole
screenful; this provides some continuity so you can continue reading
26
the text.
Jim Blandy's avatar
Jim Blandy committed
27

28 29 30 31 32
This is a copy of the Emacs tutorial text, customized slightly for
you.  Later on we will instruct you to try various commands to alter
this text.  Don't worry if you change this text before we tell you to;
that is called "editing" and that's what Emacs is for.

33 34 35
The first thing that you need to know is how to move around from place
to place in the text.  You already know how to move forward one screen,
with C-v.  To move backwards one screen, type M-v (hold down the META key
36
and type v, or type <ESC>v if you do not have a META, EDIT, or ALT key).
Jim Blandy's avatar
Jim Blandy committed
37

38
>> Try typing M-v and then C-v, a few times.
Jim Blandy's avatar
Jim Blandy committed
39

40
It is ok to scroll this text in other ways, if you know how.
Jim Blandy's avatar
Jim Blandy committed
41

Jim Blandy's avatar
Jim Blandy committed
42 43
* SUMMARY
---------
Jim Blandy's avatar
Jim Blandy committed
44 45 46 47 48

The following commands are useful for viewing screenfuls:

	C-v	Move forward one screenful
	M-v	Move backward one screenful
49 50 51
	C-l	Clear screen and redisplay all the text,
		 moving the text around the cursor
		 to the center of the screen.
52
		 (That's CONTROL-L, not CONTROL-1.)
Jim Blandy's avatar
Jim Blandy committed
53

54 55 56 57 58
>> Find the cursor, and note what text is near it.  Then type C-l.
   Find the cursor again and notice that the same text is still near
   the cursor, but now it is in the center of the screen.
   If you press C-l again, this piece of text will move to the top of
   the screen.  Press C-l again, and it moves to the bottom.
Jim Blandy's avatar
Jim Blandy committed
59

Richard M. Stallman's avatar
Richard M. Stallman committed
60 61 62
You can also use the PageUp and PageDn keys to move by screenfuls, if
your terminal has them, but you can edit more efficiently if you use
C-v and M-v.
63

Jim Blandy's avatar
Jim Blandy committed
64 65
* BASIC CURSOR CONTROL
----------------------
Jim Blandy's avatar
Jim Blandy committed
66

67 68 69
Moving from screenful to screenful is useful, but how do you
move to a specific place within the text on the screen?

70 71 72 73
There are several ways you can do this.  You can use the arrow keys,
but it's more efficient to keep your hands in the standard position
and use the commands C-p, C-b, C-f, and C-n.  These characters
are equivalent to the four arrow keys, like this:
74

Jim Blandy's avatar
Jim Blandy committed
75 76 77 78 79 80
			  Previous line, C-p
				  :
				  :
   Backward, C-b .... Current cursor position .... Forward, C-f
				  :
				  :
81
			    Next line, C-n
Jim Blandy's avatar
Jim Blandy committed
82 83

>> Move the cursor to the line in the middle of that diagram
84 85
   using C-n or C-p.  Then type C-l to see the whole diagram
   centered in the screen.
Jim Blandy's avatar
Jim Blandy committed
86

87 88 89
You'll find it easy to remember these letters by words they stand for:
P for previous, N for next, B for backward and F for forward.  You
will be using these basic cursor positioning commands all the time.
Jim Blandy's avatar
Jim Blandy committed
90 91 92 93 94 95

>> Do a few C-n's to bring the cursor down to this line.

>> Move into the line with C-f's and then up with C-p's.
   See what C-p does when the cursor is in the middle of the line.

96
Each line of text ends with a Newline character, which serves to
97 98
separate it from the following line.  (Normally, the last line in
a file will have a Newline at the end, but Emacs does not require it.)
99 100 101 102

>> Try to C-b at the beginning of a line.  It should move to
   the end of the previous line.  This is because it moves back
   across the Newline character.
Jim Blandy's avatar
Jim Blandy committed
103

104
C-f can move across a Newline just like C-b.
Jim Blandy's avatar
Jim Blandy committed
105

106 107 108
>> Do a few more C-b's, so you get a feel for where the cursor is.
   Then do C-f's to return to the end of the line.
   Then do one more C-f to move to the following line.
Jim Blandy's avatar
Jim Blandy committed
109

110 111 112 113 114 115
When you move past the top or bottom of the screen, the text beyond
the edge shifts onto the screen.  This is called "scrolling".  It
enables Emacs to move the cursor to the specified place in the text
without moving it off the screen.

>> Try to move the cursor off the bottom of the screen with C-n, and
Jim Blandy's avatar
Jim Blandy committed
116 117 118
   see what happens.

If moving by characters is too slow, you can move by words.  M-f
119
(META-f) moves forward a word and M-b moves back a word.
Jim Blandy's avatar
Jim Blandy committed
120

121 122 123 124 125 126 127 128 129
>> Type a few M-f's and M-b's.

When you are in the middle of a word, M-f moves to the end of the word.
When you are in whitespace between words, M-f moves to the end of the
following word.  M-b works likewise in the opposite direction.

>> Type M-f and M-b a few times, interspersed with C-f's and C-b's
   so that you can observe the action of M-f and M-b from various
   places inside and between words.
Jim Blandy's avatar
Jim Blandy committed
130 131 132

Notice the parallel between C-f and C-b on the one hand, and M-f and
M-b on the other hand.  Very often Meta characters are used for
133 134 135 136 137 138 139
operations related to the units defined by language (words, sentences,
paragraphs), while Control characters operate on basic units that are
independent of what you are editing (characters, lines, etc).

This parallel applies between lines and sentences: C-a and C-e move to
the beginning or end of a line, and M-a and M-e move to the beginning
or end of a sentence.
Jim Blandy's avatar
Jim Blandy committed
140 141 142 143

>> Try a couple of C-a's, and then a couple of C-e's.
   Try a couple of M-a's, and then a couple of M-e's.

144 145 146
See how repeated C-a's do nothing, but repeated M-a's keep moving one
more sentence.  Although these are not quite analogous, each one seems
natural.
Jim Blandy's avatar
Jim Blandy committed
147 148 149 150 151

The location of the cursor in the text is also called "point".  To
paraphrase, the cursor shows on the screen where point is located in
the text.

152 153
Here is a summary of simple cursor-moving operations, including the
word and sentence moving commands:
Jim Blandy's avatar
Jim Blandy committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170

	C-f	Move forward a character
	C-b	Move backward a character

	M-f	Move forward a word
	M-b	Move backward a word

	C-n	Move to next line
	C-p	Move to previous line

	C-a	Move to beginning of line
	C-e	Move to end of line

	M-a	Move back to beginning of sentence
	M-e	Move forward to end of sentence

>> Try all of these commands now a few times for practice.
171 172
   These are the most often used commands.

173 174
Two other important cursor motion commands are M-< (META Less-than),
which moves to the beginning of the whole text, and M-> (META
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
Greater-than), which moves to the end of the whole text.

On most terminals, the "<" is above the comma, so you must use the
shift key to type it.  On these terminals you must use the shift key
to type M-< also; without the shift key, you would be typing M-comma.

>> Try M-< now, to move to the beginning of the tutorial.
   Then use C-v repeatedly to move back here.

>> Try M-> now, to move to the end of the tutorial.
   Then use M-v repeatedly to move back here.

You can also move the cursor with the arrow keys, if your terminal has
arrow keys.  We recommend learning C-b, C-f, C-n and C-p for three
reasons.  First, they work on all kinds of terminals.  Second, once
190
you gain practice at using Emacs, you will find that typing these Control
191 192
characters is faster than typing the arrow keys (because you do not
have to move your hands away from touch-typing position).  Third, once
193
you form the habit of using these Control character commands, you can
194 195 196 197 198
easily learn to use other advanced cursor motion commands as well.

Most Emacs commands accept a numeric argument; for most commands, this
serves as a repeat-count.  The way you give a command a repeat count
is by typing C-u and then the digits before you type the command.  If
Richard M. Stallman's avatar
Richard M. Stallman committed
199
you have a META (or EDIT or ALT) key, there is another, alternative way
200 201
to enter a numeric argument: type the digits while holding down the
META key.  We recommend learning the C-u method because it works on
202 203
any terminal.  The numeric argument is also called a "prefix argument",
because you type the argument before the command it applies to.
Jim Blandy's avatar
Jim Blandy committed
204 205

For instance, C-u 8 C-f moves forward eight characters.
206

207 208
>> Try using C-n or C-p with a numeric argument, to move the cursor
   to a line near this one with just one command.
Jim Blandy's avatar
Jim Blandy committed
209

210 211 212 213 214 215 216
Most commands use the numeric argument as a repeat count, but some
commands use it in some other way.  Several commands (but none of
those you have learned so far) use it as a flag--the presence of a
prefix argument, regardless of its value, makes the command do
something different.

C-v and M-v are another kind of exception.  When given an argument,
217 218
they scroll the text up or down by that many lines, rather than by a
screenful.  For example, C-u 8 C-v scrolls by 8 lines.
Jim Blandy's avatar
Jim Blandy committed
219 220 221

>> Try typing C-u 8 C-v now.

222
This should have scrolled the text up by 8 lines.  If you would like
223
to scroll it down again, you can give an argument to M-v.
Jim Blandy's avatar
Jim Blandy committed
224

Chong Yidong's avatar
Chong Yidong committed
225
If you are using a graphical display, such as X or MS-Windows, there
226
should be a tall rectangular area called a scroll bar on one side of
Chong Yidong's avatar
Chong Yidong committed
227 228
the Emacs window.  You can scroll the text by clicking the mouse in
the scroll bar.
Richard M. Stallman's avatar
Richard M. Stallman committed
229

230
If your mouse has a wheel button, you can also use this to scroll.
Jim Blandy's avatar
Jim Blandy committed
231

232 233 234

* IF EMACS STOPS RESPONDING
---------------------------
Jim Blandy's avatar
Jim Blandy committed
235

236 237 238 239
If Emacs stops responding to your commands, you can stop it safely by
typing C-g.  You can use C-g to stop a command which is taking too
long to execute.

Jim Blandy's avatar
Jim Blandy committed
240
You can also use C-g to discard a numeric argument or the beginning of
241
a command that you do not want to finish.
Jim Blandy's avatar
Jim Blandy committed
242

243
>> Type C-u 100 to make a numeric argument of 100, then type C-g.
Chong Yidong's avatar
Chong Yidong committed
244 245
   Now type C-f.  It should move just one character, because you
   canceled the argument with C-g.
Jim Blandy's avatar
Jim Blandy committed
246

247
If you have typed an <ESC> by mistake, you can get rid of it with a C-g.
Richard M. Stallman's avatar
Richard M. Stallman committed
248

249 250 251 252 253 254 255 256 257 258 259

* DISABLED COMMANDS
-------------------

Some Emacs commands are "disabled" so that beginning users cannot use
them by accident.

If you type one of the disabled commands, Emacs displays a message
saying what the command was, and asking you whether you want to go
ahead and execute the command.

260 261 262
If you really want to try the command, type <SPC> (the Space bar) in
answer to the question.  Normally, if you do not want to execute the
disabled command, answer the question with "n".
263

264
>> Type C-x C-l (which is a disabled command),
265
   then type n to answer the question.
Jim Blandy's avatar
Jim Blandy committed
266 267


Jim Blandy's avatar
Jim Blandy committed
268 269
* WINDOWS
---------
Jim Blandy's avatar
Jim Blandy committed
270

Chong Yidong's avatar
Chong Yidong committed
271 272 273
Emacs can have several "windows", each displaying its own text.  We
will explain later on how to use multiple windows.  Right now we want
to explain how to get rid of extra windows and go back to basic
274
one-window editing.  It is simple:
Jim Blandy's avatar
Jim Blandy committed
275 276 277

	C-x 1	One window (i.e., kill all other windows).

278
That is CONTROL-x followed by the digit 1.  C-x 1 expands the window
279 280
which contains the cursor, to occupy the full screen.  It deletes all
other windows.
Jim Blandy's avatar
Jim Blandy committed
281 282

>> Move the cursor to this line and type C-u 0 C-l.
Chong Yidong's avatar
Chong Yidong committed
283
>> Type C-h k C-f.
Jim Blandy's avatar
Jim Blandy committed
284
   See how this window shrinks, while a new one appears
Chong Yidong's avatar
Chong Yidong committed
285
   to display documentation on the C-f command.
Jim Blandy's avatar
Jim Blandy committed
286 287 288

>> Type C-x 1 and see the documentation listing window disappear.

289
There is a whole series of commands that start with CONTROL-x; many of
290 291 292
them have to do with windows, files, buffers, and related things.
These commands are two, three or four characters long.

Jim Blandy's avatar
Jim Blandy committed
293

Jim Blandy's avatar
Jim Blandy committed
294 295
* INSERTING AND DELETING
------------------------
Jim Blandy's avatar
Jim Blandy committed
296

Chong Yidong's avatar
Chong Yidong committed
297 298 299 300
If you want to insert text, just type the text.  Ordinary characters,
like A, 7, *, etc., are inserted as you type them.  To insert a
Newline character, type <Return> (this is the key on the keyboard
which is sometimes labeled "Enter").
301

302
To delete the character immediately before the current cursor
Chong Yidong's avatar
Chong Yidong committed
303 304 305
position, type <DEL>.  This is the key on the keyboard usually labeled
"Backspace"--the same one you normally use, outside Emacs, to delete
the last character typed.
306

Chong Yidong's avatar
Chong Yidong committed
307 308
There may also be another key on your keyboard labeled <Delete>, but
that's not the one we refer to as <DEL>.
Jim Blandy's avatar
Jim Blandy committed
309

Chong Yidong's avatar
Chong Yidong committed
310 311 312 313
>> Do this now--type a few characters, then delete them by
   typing <DEL> a few times.  Don't worry about this file
   being changed; you will not alter the master tutorial.
   This is your personal copy of it.
314 315

When a line of text gets too big for one line on the screen, the line
Chong Yidong's avatar
Chong Yidong committed
316 317 318 319
of text is "continued" onto a second screen line.  If you're using a
graphical display, little curved arrows appear in the narrow spaces on
each side of the text area (the left and right "fringes"), to indicate
where a line has been continued.  If you're using a text terminal, the
320
continued line is indicated by a backslash ('\') on the rightmost
Chong Yidong's avatar
Chong Yidong committed
321
screen column.
322 323 324 325

>> Insert text until you reach the right margin, and keep on inserting.
   You'll see a continuation line appear.

Chong Yidong's avatar
Chong Yidong committed
326
>> Use <DEL>s to delete the text until the line fits on one screen
Jim Blandy's avatar
Jim Blandy committed
327 328
   line again.  The continuation line goes away.

329 330 331 332 333
You can delete a Newline character just like any other character.
Deleting the Newline character between two lines merges them into
one line.  If the resulting combined line is too long to fit in the
screen width, it will be displayed with a continuation line.

Chong Yidong's avatar
Chong Yidong committed
334
>> Move the cursor to the beginning of a line and type <DEL>.  This
335 336
   merges that line with the previous line.

Jim Blandy's avatar
Jim Blandy committed
337 338
>> Type <Return> to reinsert the Newline you deleted.

339 340 341 342 343 344 345 346 347 348 349 350 351
The <Return> key is special, in that pressing it may do more than
just insert a Newline character.  Depending on the surrounding text,
it may insert whitespace after the Newline character, so that when
you start typing on the newly created line, the text lines up with
that on the previous line.  We call this behavior (where pressing a
key does more than simply inserting the relevant character) "electric".

>> Here is an example of <Return> being electric.
   Type <Return> at the end of this line.

You should see that after inserting the Newline, Emacs inserts spaces
so that the cursor moves under the "T" of "Type".

Jim Blandy's avatar
Jim Blandy committed
352
Remember that most Emacs commands can be given a repeat count;
353 354
this includes text characters.  Repeating a text character inserts
it several times.
Jim Blandy's avatar
Jim Blandy committed
355

356
>> Try that now -- type C-u 8 * to insert ********.
Jim Blandy's avatar
Jim Blandy committed
357 358 359 360 361

You've now learned the most basic way of typing something in
Emacs and correcting errors.  You can delete by words or lines
as well.  Here is a summary of the delete operations:

Chong Yidong's avatar
Chong Yidong committed
362
	<DEL>        Delete the character just before the cursor
363
	C-d   	     Delete the next character after the cursor
Jim Blandy's avatar
Jim Blandy committed
364

Chong Yidong's avatar
Chong Yidong committed
365
	M-<DEL>      Kill the word immediately before the cursor
366
	M-d	     Kill the next word after the cursor
Jim Blandy's avatar
Jim Blandy committed
367

368 369
	C-k	     Kill from the cursor position to end of line
	M-k	     Kill to the end of the current sentence
Jim Blandy's avatar
Jim Blandy committed
370

Chong Yidong's avatar
Chong Yidong committed
371 372 373 374
Notice that <DEL> and C-d vs M-<DEL> and M-d extend the parallel
started by C-f and M-f (well, <DEL> is not really a control character,
but let's not worry about that).  C-k and M-k are like C-e and M-e,
sort of, in that lines are paired with sentences.
Jim Blandy's avatar
Jim Blandy committed
375

Chong Yidong's avatar
Chong Yidong committed
376 377 378 379 380 381
You can also kill a segment of text with one uniform method.  Move to
one end of that part, and type C-<SPC>.  (<SPC> is the Space bar.)
Next, move the cursor to the other end of the text you intend to kill.
As you do this, Emacs highlights the text between the cursor and the
position where you typed C-<SPC>.  Finally, type C-w.  This kills all
the text between the two positions.
Karl Heuer's avatar
Karl Heuer committed
382 383

>> Move the cursor to the Y at the start of the previous paragraph.
384
>> Type C-<SPC>.  Emacs should display a message "Mark set"
Karl Heuer's avatar
Karl Heuer committed
385 386 387 388 389 390
   at the bottom of the screen.
>> Move the cursor to the n in "end", on the second line of the
   paragraph.
>> Type C-w.  This will kill the text starting from the Y,
   and ending just before the n.

391
The difference between "killing" and "deleting" is that "killed" text
392
can be reinserted (at any position), whereas "deleted" things cannot
Xue Fuqiao's avatar
Xue Fuqiao committed
393 394 395 396 397 398 399 400 401
be reinserted in this way (you can, however, undo a deletion--see
below).  Reinsertion of killed text is called "yanking".  (Think of it
as yanking back, or pulling back, some text that was taken away.)
Generally, the commands that can remove a lot of text kill the text
(they are set up so that you can yank the text), while the commands
that remove just one character, or only remove blank lines and spaces,
do deletion (so you cannot yank that text).  <DEL> and C-d do deletion
in the simplest case, with no argument.  When given an argument, they
kill instead.
Jim Blandy's avatar
Jim Blandy committed
402

Chong Yidong's avatar
Chong Yidong committed
403
>> Move the cursor to the beginning of a line which is not empty.
404 405 406
   Then type C-k to kill the text on that line.
>> Type C-k a second time.  You'll see that it kills the Newline
   which follows that line.
Jim Blandy's avatar
Jim Blandy committed
407 408

Note that a single C-k kills the contents of the line, and a second
Richard M. Stallman's avatar
Richard M. Stallman committed
409
C-k kills the line itself, and makes all the other lines move up.  C-k
410 411
treats a numeric argument specially: it kills that many lines AND
their contents.  This is not mere repetition.  C-u 2 C-k kills two
412
lines and their Newlines; typing C-k twice would not do that.
Jim Blandy's avatar
Jim Blandy committed
413

Xue Fuqiao's avatar
Xue Fuqiao committed
414 415 416 417 418 419
You can yank the killed text either at the same place where it was
killed, or at some other place in the text you are editing, or even in
a different file.  You can yank the same text several times; that
makes multiple copies of it.  Some other editors call killing and
yanking "cutting" and "pasting" (see the Glossary in the Emacs
manual).
420 421 422

The command for yanking is C-y.  It reinserts the last killed text,
at the current cursor position.
Jim Blandy's avatar
Jim Blandy committed
423 424 425

>> Try it; type C-y to yank the text back.

426 427
If you do several C-k's in a row, all of the killed text is saved
together, so that one C-y will yank all of the lines at once.
Jim Blandy's avatar
Jim Blandy committed
428 429 430 431 432 433 434 435 436 437 438 439

>> Do this now, type C-k several times.

Now to retrieve that killed text:

>> Type C-y.  Then move the cursor down a few lines and type C-y
   again.  You now see how to copy some text.

What do you do if you have some text you want to yank back, and then
you kill something else?  C-y would yank the more recent kill.  But
the previous text is not lost.  You can get back to it using the M-y
command.  After you have done C-y to get the most recent kill, typing
440
M-y replaces that yanked text with the previous kill.  Typing M-y
441 442 443 444 445 446 447
again and again brings in earlier and earlier kills.  When you have
reached the text you are looking for, you do not have to do anything to
keep it.  Just go on with your editing, leaving the yanked text where
it is.

If you M-y enough times, you come back to the starting point (the most
recent kill).
Jim Blandy's avatar
Jim Blandy committed
448 449 450 451 452 453 454 455 456 457

>> Kill a line, move around, kill another line.
   Then do C-y to get back the second killed line.
   Then do M-y and it will be replaced by the first killed line.
   Do more M-y's and see what you get.  Keep doing them until
   the second kill line comes back, and then a few more.
   If you like, you can try giving M-y positive and negative
   arguments.


Jim Blandy's avatar
Jim Blandy committed
458 459
* UNDO
------
Jim Blandy's avatar
Jim Blandy committed
460

461
If you make a change to the text, and then decide that it was a
Chong Yidong's avatar
Chong Yidong committed
462
mistake, you can undo the change with the undo command, C-/.
463

Chong Yidong's avatar
Chong Yidong committed
464 465
Normally, C-/ undoes the changes made by one command; if you repeat
C-/ several times in a row, each repetition undoes one more command.
466

Chong Yidong's avatar
Chong Yidong committed
467 468
But there are two exceptions: commands that do not change the text
don't count (this includes cursor motion commands and scrolling
469
commands), and self-inserting characters are usually handled in groups
Chong Yidong's avatar
Chong Yidong committed
470 471
of up to 20.  (This is to reduce the number of C-/'s you have to type
to undo insertion of text.)
Jim Blandy's avatar
Jim Blandy committed
472

Chong Yidong's avatar
Chong Yidong committed
473
>> Kill this line with C-k, then type C-/ and it should reappear.
Jim Blandy's avatar
Jim Blandy committed
474

Chong Yidong's avatar
Chong Yidong committed
475 476 477 478
C-_ is an alternative undo command; it works exactly the same as C-/.
On some text terminals, typing C-/ actually sends C-_ to Emacs.
Alternatively, C-x u also works exactly like C-/, but is a little less
convenient to type.
Jim Blandy's avatar
Jim Blandy committed
479

Chong Yidong's avatar
Chong Yidong committed
480
A numeric argument to C-/, C-_, or C-x u acts as a repeat count.
Jim Blandy's avatar
Jim Blandy committed
481

482 483 484 485
You can undo deletion of text just as you can undo killing of text.
The distinction between killing something and deleting it affects
whether you can yank it with C-y; it makes no difference for undo.

Jim Blandy's avatar
Jim Blandy committed
486

Jim Blandy's avatar
Jim Blandy committed
487 488
* FILES
-------
Jim Blandy's avatar
Jim Blandy committed
489 490

In order to make the text you edit permanent, you must put it in a
Chong Yidong's avatar
Chong Yidong committed
491 492 493
file.  Otherwise, it will go away when you exit Emacs.  In order to
put your text in a file, you must "find" the file before you enter the
text.  (This is also called "visiting" the file.)
494 495 496 497 498 499 500 501

Finding a file means that you see the contents of the file within
Emacs.  In many ways, it is as if you were editing the file itself.
However, the changes you make using Emacs do not become permanent
until you "save" the file.  This is so you can avoid leaving a
half-changed file on the system when you do not want to.  Even when
you save, Emacs leaves the original file under a changed name in case
you later decide that your changes were a mistake.
Jim Blandy's avatar
Jim Blandy committed
502 503

If you look near the bottom of the screen you will see a line that
Chong Yidong's avatar
Chong Yidong committed
504
begins with dashes, and starts with " -:---  TUTORIAL" or something
505
like that.  This part of the screen normally shows the name of the
Chong Yidong's avatar
Chong Yidong committed
506 507 508
file that you are visiting.  Right now, you are visiting your personal
copy of the Emacs tutorial, which is called "TUTORIAL".  When you find
a file with Emacs, that file's name will appear in that precise spot.
Jim Blandy's avatar
Jim Blandy committed
509

510 511
One special thing about the command for finding a file is that you
have to say what file name you want.  We say the command "reads an
Chong Yidong's avatar
Chong Yidong committed
512 513
argument" (in this case, the argument is the name of the file).  After
you type the command
Jim Blandy's avatar
Jim Blandy committed
514 515 516

	C-x C-f   Find a file

517 518 519 520 521 522 523
Emacs asks you to type the file name.  The file name you type appears
on the bottom line of the screen.  The bottom line is called the
minibuffer when it is used for this sort of input.  You can use
ordinary Emacs editing commands to edit the file name.

While you are entering the file name (or any minibuffer input),
you can cancel the command with C-g.
Jim Blandy's avatar
Jim Blandy committed
524 525 526 527 528

>> Type C-x C-f, then type C-g.  This cancels the minibuffer,
   and also cancels the C-x C-f command that was using the
   minibuffer.  So you do not find any file.

529
When you have finished entering the file name, type <Return> to
Chong Yidong's avatar
Chong Yidong committed
530 531
terminate it.  The minibuffer disappears, and the C-x C-f command goes
to work to find the file you chose.
532

Chong Yidong's avatar
Chong Yidong committed
533 534 535
The file contents now appear on the screen, and you can edit the
contents.  When you wish to make your changes permanent, type the
command
Jim Blandy's avatar
Jim Blandy committed
536 537 538

	C-x C-s   Save the file

539 540 541
This copies the text within Emacs into the file.  The first time you
do this, Emacs renames the original file to a new name so that it is
not lost.  The new name is made by adding "~" to the end of the
542 543
original file's name.  When saving is finished, Emacs displays the
name of the file written.
Jim Blandy's avatar
Jim Blandy committed
544

Chong Yidong's avatar
Chong Yidong committed
545 546 547
>> Type C-x C-s TUTORIAL <Return>.
   This should save this tutorial to a file named TUTORIAL, and show
   "Wrote ...TUTORIAL" at the bottom of the screen.
Jim Blandy's avatar
Jim Blandy committed
548

549 550
You can find an existing file, to view it or edit it.  You can also
find a file which does not already exist.  This is the way to create a
551 552 553 554 555
file with Emacs: find the file, which starts out empty, and then begin
inserting the text for the file.  When you ask to "save" the file,
Emacs actually creates the file with the text that you have inserted.
From then on, you can consider yourself to be editing an already
existing file.
Jim Blandy's avatar
Jim Blandy committed
556 557


Jim Blandy's avatar
Jim Blandy committed
558 559
* BUFFERS
---------
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563 564

If you find a second file with C-x C-f, the first file remains
inside Emacs.  You can switch back to it by finding it again with
C-x C-f.  This way you can get quite a number of files inside Emacs.

Karl Heuer's avatar
Karl Heuer committed
565
Emacs stores each file's text inside an object called a "buffer".
566
Finding a file makes a new buffer inside Emacs.  To see a list of the
Chong Yidong's avatar
Chong Yidong committed
567
buffers that currently exist, type
Jim Blandy's avatar
Jim Blandy committed
568 569 570 571 572

	C-x C-b   List buffers

>> Try C-x C-b now.

Richard M. Stallman's avatar
Richard M. Stallman committed
573 574
See how each buffer has a name, and it may also have a file name for
the file whose contents it holds.  ANY text you see in an Emacs window
575
is always part of some buffer.
Jim Blandy's avatar
Jim Blandy committed
576 577 578

>> Type C-x 1 to get rid of the buffer list.

Juanma Barranquero's avatar
Juanma Barranquero committed
579
When you have several buffers, only one of them is "current" at any
Richard M. Stallman's avatar
Richard M. Stallman committed
580 581 582 583 584 585
time.  That buffer is the one you edit.  If you want to edit another
buffer, you need to "switch" to it.  If you want to switch to a buffer
that corresponds to a file, you can do it by visiting the file again
with C-x C-f.  But there is an easier way: use the C-x b command.
In that command, you have to type the buffer's name.

Chong Yidong's avatar
Chong Yidong committed
586 587
>> Create a file named "foo" by typing C-x C-f foo <Return>.
   Then type C-x b TUTORIAL <Return> to come back to this tutorial.
Richard M. Stallman's avatar
Richard M. Stallman committed
588 589 590

Most of the time, the buffer's name is the same as the file name
(without the file directory part).  However, this is not always true.
Chong Yidong's avatar
Chong Yidong committed
591 592
The buffer list you make with C-x C-b shows you both the buffer name
and the file name of every buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
593

Chong Yidong's avatar
Chong Yidong committed
594 595 596 597 598 599 600 601 602
Some buffers do not correspond to files.  The buffer named
"*Buffer List*", which contains the buffer list that you made with
C-x C-b, does not have any file.  This TUTORIAL buffer initially did
not have a file, but now it does, because in the previous section you
typed C-x C-s and saved it to a file.

The buffer named "*Messages*" also does not correspond to any file.
This buffer contains the messages that have appeared on the bottom
line during your Emacs session.
Richard M. Stallman's avatar
Richard M. Stallman committed
603 604

>> Type C-x b *Messages* <Return> to look at the buffer of messages.
Richard M. Stallman's avatar
Richard M. Stallman committed
605
   Then type C-x b TUTORIAL <Return> to come back to this tutorial.
Richard M. Stallman's avatar
Richard M. Stallman committed
606

Jim Blandy's avatar
Jim Blandy committed
607 608 609 610 611
If you make changes to the text of one file, then find another file,
this does not save the first file.  Its changes remain inside Emacs,
in that file's buffer.  The creation or editing of the second file's
buffer has no effect on the first file's buffer.  This is very useful,
but it also means that you need a convenient way to save the first
612 613
file's buffer.  Having to switch back to that buffer, in order to save
it with C-x C-s, would be a nuisance.  So we have
Jim Blandy's avatar
Jim Blandy committed
614 615 616

	C-x s     Save some buffers

617 618 619
C-x s asks you about each buffer which contains changes that you have
not saved.  It asks you, for each such buffer, whether to save the
buffer.
Jim Blandy's avatar
Jim Blandy committed
620

621 622 623
>> Insert a line of text, then type C-x s.
   It should ask you whether to save the buffer named TUTORIAL.
   Answer yes to the question by typing "y".
Jim Blandy's avatar
Jim Blandy committed
624

Karl Heuer's avatar
Karl Heuer committed
625

Jim Blandy's avatar
Jim Blandy committed
626 627
* EXTENDING THE COMMAND SET
---------------------------
Jim Blandy's avatar
Jim Blandy committed
628 629 630 631 632 633 634 635

There are many, many more Emacs commands than could possibly be put
on all the control and meta characters.  Emacs gets around this with
the X (eXtend) command.  This comes in two flavors:

	C-x	Character eXtend.  Followed by one character.
	M-x	Named command eXtend.  Followed by a long name.

636
These are commands that are generally useful but are used less than the
637 638 639 640 641
commands you have already learned about.  You have already seen a few
of them: the file commands C-x C-f to Find and C-x C-s to Save, for
example.  Another example is the command to end the Emacs
session--this is the command C-x C-c.  (Do not worry about losing
changes you have made; C-x C-c offers to save each changed file before
642
it kills Emacs.)
Jim Blandy's avatar
Jim Blandy committed
643

Chong Yidong's avatar
Chong Yidong committed
644 645 646 647
If you are using a graphical display, you don't need any special
command to move from Emacs to another application.  You can do this
with the mouse or with window manager commands.  However, if you're
using a text terminal which can only show one application at a time,
648
you need to "suspend" Emacs to move to any other application.
649

650 651 652
C-z is the command to exit Emacs *temporarily*--so that you can go
back to the same Emacs session afterward.  When Emacs is running on a
text terminal, C-z "suspends" Emacs; that is, it returns to the shell
Chong Yidong's avatar
Chong Yidong committed
653
but does not destroy the Emacs job.  In the most common shells, you
654
can resume Emacs with the "fg" command or with "%emacs".
655 656

The time to use C-x C-c is when you are about to log out.  It's also
657 658
the right thing to use to exit an Emacs invoked for a quick edit, such
as by a mail handling utility.
Jim Blandy's avatar
Jim Blandy committed
659

660
There are many C-x commands.  Here is a list of the ones you have learned:
Jim Blandy's avatar
Jim Blandy committed
661

662 663 664 665 666 667 668 669
	C-x C-f		Find file
	C-x C-s		Save file
	C-x s		Save some buffers
	C-x C-b		List buffers
	C-x b		Switch buffer
	C-x C-c		Quit Emacs
	C-x 1		Delete all but one window
	C-x u		Undo
Jim Blandy's avatar
Jim Blandy committed
670 671

Named eXtended commands are commands which are used even less
672
frequently, or commands which are used only in certain modes.  An
673 674
example is the command replace-string, which replaces one string with
another in the buffer.  When you type M-x, Emacs prompts you at the
675 676
bottom of the screen with M-x and you should type the name of the
command; in this case, "replace-string".  Just type "repl s<TAB>" and
677
Emacs will complete the name.  (<TAB> is the Tab key, usually found
Eli Zaretskii's avatar
Eli Zaretskii committed
678
above the CapsLock or Shift key near the left edge of the keyboard.)
Chong Yidong's avatar
Chong Yidong committed
679
Submit the command name with <Return>.
680 681 682 683

The replace-string command requires two arguments--the string to be
replaced, and the string to replace it with.  You must end each
argument with <Return>.
Jim Blandy's avatar
Jim Blandy committed
684 685 686 687

>> Move the cursor to the blank line two lines below this one.
   Then type M-x repl s<Return>changed<Return>altered<Return>.

688 689 690
   Notice how this line has changed: you've replaced the word
   "changed" with "altered" wherever it occurred, after the
   initial position of the cursor.
Jim Blandy's avatar
Jim Blandy committed
691 692


Richard M. Stallman's avatar
Richard M. Stallman committed
693 694 695 696 697
* AUTO SAVE
-----------

When you have made changes in a file, but you have not saved them yet,
they could be lost if your computer crashes.  To protect you from
698 699 700 701 702
this, Emacs periodically writes an "auto save" file for each file that
you are editing.  The auto save file name has a # at the beginning and
the end; for example, if your file is named "hello.c", its auto save
file's name is "#hello.c#".  When you save the file in the normal way,
Emacs deletes its auto save file.
Richard M. Stallman's avatar
Richard M. Stallman committed
703 704 705

If the computer crashes, you can recover your auto-saved editing by
finding the file normally (the file you were editing, not the auto
Eli Zaretskii's avatar
Eli Zaretskii committed
706
save file) and then typing M-x recover-this-file <Return>.  When it
707
asks for confirmation, type yes<Return> to go ahead and recover the
Eli Zaretskii's avatar
Eli Zaretskii committed
708
auto-save data.
Richard M. Stallman's avatar
Richard M. Stallman committed
709 710


711
* ECHO AREA
Jim Blandy's avatar
Jim Blandy committed
712
-----------
Jim Blandy's avatar
Jim Blandy committed
713

Richard M. Stallman's avatar
Richard M. Stallman committed
714 715 716
If Emacs sees that you are typing multicharacter commands slowly, it
shows them to you at the bottom of the screen in an area called the
"echo area".  The echo area contains the bottom line of the screen.
Jim Blandy's avatar
Jim Blandy committed
717 718


719 720 721
* MODE LINE
-----------

Richard M. Stallman's avatar
Richard M. Stallman committed
722
The line immediately above the echo area is called the "mode line".
723 724
The mode line says something like this:

Chong Yidong's avatar
Chong Yidong committed
725
 -:**-  TUTORIAL       63% L749    (Fundamental)
726 727 728

This line gives useful information about the status of Emacs and
the text you are editing.
Jim Blandy's avatar
Jim Blandy committed
729 730

You already know what the filename means--it is the file you have
Chong Yidong's avatar
Chong Yidong committed
731 732 733 734 735 736
found.  NN% indicates your current position in the buffer text; it
means that NN percent of the buffer is above the top of the screen.
If the top of the buffer is on the screen, it will say "Top" instead
of " 0%".  If the bottom of the buffer is on the screen, it will say
"Bot".  If you are looking at a buffer so small that all of it fits on
the screen, the mode line says "All".
Jim Blandy's avatar
Jim Blandy committed
737

Gerd Moellmann's avatar
Gerd Moellmann committed
738 739 740
The L and digits indicate position in another way: they give the
current line number of point.

Jim Blandy's avatar
Jim Blandy committed
741
The stars near the front mean that you have made changes to the text.
742 743
Right after you visit or save a file, that part of the mode line shows
no stars, just dashes.
Jim Blandy's avatar
Jim Blandy committed
744 745

The part of the mode line inside the parentheses is to tell you what
746
editing modes you are in.  The default mode is Fundamental which is
747
what you are using now.  It is an example of a "major mode".
748 749

Emacs has many different major modes.  Some of them are meant for
750
editing different languages and/or kinds of text, such as Lisp mode,
751 752 753 754 755 756 757 758 759
Text mode, etc.  At any time one and only one major mode is active,
and its name can always be found in the mode line just where
"Fundamental" is now.

Each major mode makes a few commands behave differently.  For example,
there are commands for creating comments in a program, and since each
programming language has a different idea of what a comment should
look like, each major mode has to insert comments differently.  Each
major mode is the name of an extended command, which is how you can
760
switch to that mode.  For example, M-x fundamental-mode is a command to
761
switch to Fundamental mode.
Jim Blandy's avatar
Jim Blandy committed
762

763
If you are going to be editing human-language text, such as this file, you
Jim Blandy's avatar
Jim Blandy committed
764
should probably use Text Mode.
765

766
>> Type M-x text-mode <Return>.
Jim Blandy's avatar
Jim Blandy committed
767

768
Don't worry, none of the Emacs commands you have learned changes in
769 770 771
any great way.  But you can observe that M-f and M-b now treat
apostrophes as part of words.  Previously, in Fundamental mode,
M-f and M-b treated apostrophes as word-separators.
Jim Blandy's avatar
Jim Blandy committed
772

773 774 775 776 777
Major modes usually make subtle changes like that one: most commands
do "the same job" in each major mode, but they work a little bit
differently.

To view documentation on your current major mode, type C-h m.
Jim Blandy's avatar
Jim Blandy committed
778

779
>> Move the cursor to the line following this line.
Chong Yidong's avatar
Chong Yidong committed
780
>> Type C-l C-l to bring this line to the top of screen.
Jim Blandy's avatar
Jim Blandy committed
781 782 783 784
>> Type C-h m, to see how Text mode differs from Fundamental mode.
>> Type C-x 1 to remove the documentation from the screen.

Major modes are called major because there are also minor modes.
Richard M. Stallman's avatar
Richard M. Stallman committed
785
Minor modes are not alternatives to the major modes, just minor
786 787 788 789
modifications of them.  Each minor mode can be turned on or off by
itself, independent of all other minor modes, and independent of your
major mode.  So you can use no minor modes, or one minor mode, or any
combination of several minor modes.
Jim Blandy's avatar
Jim Blandy committed
790

791 792 793 794
One minor mode which is very useful, especially for editing
human-language text, is Auto Fill mode.  When this mode is on, Emacs
breaks the line in between words automatically whenever you insert
text and make a line that is too wide.
795

796 797 798 799 800
You can turn Auto Fill mode on by doing M-x auto-fill-mode <Return>.
When the mode is on, you can turn it off again by doing
M-x auto-fill-mode <Return>.  If the mode is off, this command turns
it on, and if the mode is on, this command turns it off.  We say that
the command "toggles the mode".
Jim Blandy's avatar
Jim Blandy committed
801

802
>> Type M-x auto-fill-mode <Return> now.  Then insert a line of "asdf "
Jim Blandy's avatar
Jim Blandy committed
803 804 805 806 807 808 809 810 811 812 813 814
   over again until you see it divide into two lines.  You must put in
   spaces between them because Auto Fill breaks lines only at spaces.

The margin is usually set at 70 characters, but you can change it
with the C-x f command.  You should give the margin setting you want
as a numeric argument.

>> Type C-x f with an argument of 20.  (C-u 2 0 C-x f).
   Then type in some text and see Emacs fill lines of 20
   characters with it.  Then set the margin back to 70 using
   C-x f again.

Richard M. Stallman's avatar
Richard M. Stallman committed
815
If you make changes in the middle of a paragraph, Auto Fill mode
Jim Blandy's avatar
Jim Blandy committed
816
does not re-fill it for you.
817
To re-fill the paragraph, type M-q (META-q) with the cursor inside
Jim Blandy's avatar
Jim Blandy committed
818 819 820 821
that paragraph.

>> Move the cursor into the previous paragraph and type M-q.

Karl Heuer's avatar
Karl Heuer committed
822

Jim Blandy's avatar
Jim Blandy committed
823 824
* SEARCHING
-----------
Jim Blandy's avatar
Jim Blandy committed
825

Chong Yidong's avatar
Chong Yidong committed
826 827 828 829
Emacs can do searches for strings (a "string" is a group of contiguous
characters) either forward through the text or backward through it.
Searching for a string is a cursor motion command; it moves the cursor
to the next place where that string appears.
830

831
The Emacs search command is "incremental".  This means that the
832 833 834 835 836 837 838 839
search happens while you type in the string to search for.

The command to initiate a search is C-s for forward search, and C-r
for reverse search.  BUT WAIT!  Don't try them now.

When you type C-s you'll notice that the string "I-search" appears as
a prompt in the echo area.  This tells you that Emacs is in what is
called an incremental search waiting for you to type the thing that
840
you want to search for.  <Return> terminates a search.
Jim Blandy's avatar
Jim Blandy committed
841 842

>> Now type C-s to start a search.  SLOWLY, one letter at a time,
843
   type the word "cursor", pausing after you type each
Jim Blandy's avatar
Jim Blandy committed
844
   character to notice what happens to the cursor.
845 846
   Now you have searched for "cursor", once.
>> Type C-s again, to search for the next occurrence of "cursor".
Chong Yidong's avatar
Chong Yidong committed
847
>> Now type <DEL> four times and see how the cursor moves.
848
>> Type <Return> to terminate the search.
Jim Blandy's avatar
Jim Blandy committed
849 850

Did you see what happened?  Emacs, in an incremental search, tries to
851
go to the occurrence of the string that you've typed out so far.  To
852
go to the next occurrence of "cursor" just type C-s again.  If no such
Richard M. Stallman's avatar
Richard M. Stallman committed
853 854
occurrence exists, Emacs beeps and tells you the search is currently
"failing".  C-g would also terminate the search.
Jim Blandy's avatar
Jim Blandy committed
855

856 857
If you are in the middle of an incremental search and type <DEL>, the
search "retreats" to an earlier location.  If you type <DEL> just
Chong Yidong's avatar
Chong Yidong committed
858 859 860 861 862 863 864 865
after you had typed C-s to advance to the next occurrence of a search
string, the <DEL> moves the cursor back to an earlier occurrence.  If
there are no earlier occurrences, the <DEL> erases the last character
in the search string.  For instance, suppose you have typed "c", to
search for the first occurrence of "c".  Now if you type "u", the
cursor will move to the first occurrence of "cu".  Now type <DEL>.
This erases the "u" from the search string, and the cursor moves back
to the first occurrence of "c".
Jim Blandy's avatar
Jim Blandy committed
866

867
If you are in the middle of a search and type a control or meta
Chong Yidong's avatar
Chong Yidong committed
868 869
character (with a few exceptions--characters that are special in a
search, such as C-s and C-r), the search is terminated.
Jim Blandy's avatar
Jim Blandy committed
870

Chong Yidong's avatar
Chong Yidong committed
871 872
C-s starts a search that looks for any occurrence of the search string
AFTER the current cursor position.  If you want to search for
873 874 875
something earlier in the text, type C-r instead.  Everything that we
have said about C-s also applies to C-r, except that the direction of
the search is reversed.
Jim Blandy's avatar
Jim Blandy committed
876 877


Jim Blandy's avatar
Jim Blandy committed
878 879
* MULTIPLE WINDOWS
------------------
Jim Blandy's avatar
Jim Blandy committed
880

Chong Yidong's avatar
Chong Yidong committed
881 882 883
One of the nice features of Emacs is that you can display more than
one window on the screen at the same time.  (Note that Emacs uses the
term "frames"--described in the next section--for what some other
884 885
applications call "windows".  The Emacs manual contains a Glossary of
Emacs terms.)
Jim Blandy's avatar
Jim Blandy committed
886

Chong Yidong's avatar
Chong Yidong committed
887
>> Move the cursor to this line and type C-l C-l.
Jim Blandy's avatar
Jim Blandy committed
888 889

>> Now type C-x 2 which splits the screen into two windows.
Chong Yidong's avatar
Chong Yidong committed
890 891
   Both windows display this tutorial.  The editing cursor stays in
   the top window.
Jim Blandy's avatar
Jim Blandy committed
892 893

>> Type C-M-v to scroll the bottom window.
894
   (If you do not have a real META key, type <ESC> C-v.)
Jim Blandy's avatar
Jim Blandy committed
895 896 897 898 899 900

>> Type C-x o ("o" for "other") to move the cursor to the bottom window.
>> Use C-v and M-v in the bottom window to scroll it.
   Keep reading these directions in the top window.

>> Type C-x o again to move the cursor back to the top window.
901
   The cursor in the top window is just where it was before.
Jim Blandy's avatar
Jim Blandy committed
902

Chong Yidong's avatar
Chong Yidong committed
903 904 905 906 907
You can keep using C-x o to switch between the windows.  The "selected
window", where most editing takes place, is the one with a prominent
cursor which blinks when you are not typing.  The other windows have
their own cursor positions; if you are running Emacs in a graphical
display, those cursors are drawn as unblinking hollow boxes.
Jim Blandy's avatar
Jim Blandy committed
908 909

The command C-M-v is very useful when you are editing text in one
Chong Yidong's avatar
Chong Yidong committed
910
window and using the other window just for reference.  Without leaving
911 912
the selected window, you can scroll the text in the other window with
C-M-v.
Jim Blandy's avatar
Jim Blandy committed
913

Chong Yidong's avatar
Chong Yidong committed
914 915 916 917 918
C-M-v is an example of a CONTROL-META character.  If you have a META
(or Alt) key, you can type C-M-v by holding down both CONTROL and META
while typing v.  It does not matter whether CONTROL or META "comes
first," as both of these keys act by modifying the characters you
type.
919

Chong Yidong's avatar
Chong Yidong committed
920 921
If you do not have a META key, and you use <ESC> instead, the order
does matter: you must type <ESC> followed by CONTROL-v, because
922 923
CONTROL-<ESC> v will not work.  This is because <ESC> is a character
in its own right, not a modifier key.
924

Jim Blandy's avatar
Jim Blandy committed
925 926 927 928 929 930
>> Type C-x 1 (in the top window) to get rid of the bottom window.

(If you had typed C-x 1 in the bottom window, that would get rid
of the top one.  Think of this command as "Keep just one
window--the window I am already in.")

931 932 933
You do not have to display the same buffer in both windows.  If you
use C-x C-f to find a file in one window, the other window does not
change.  You can find a file in each window independently.
Jim Blandy's avatar
Jim Blandy committed
934

935
Here is another way to use two windows to display two different things:
Jim Blandy's avatar
Jim Blandy committed
936 937

>> Type C-x 4 C-f followed by the name of one of your files.
938
   End with <Return>.  See the specified file appear in the bottom
Jim Blandy's avatar
Jim Blandy committed
939 940 941 942 943 944
   window.  The cursor goes there, too.

>> Type C-x o to go back to the top window, and C-x 1 to delete
   the bottom window.


945 946 947
* MULTIPLE FRAMES
------------------

Chong Yidong's avatar
Chong Yidong committed
948 949 950 951 952 953
Emacs can also create multiple "frames".  A frame is what we call one
collection of windows, together with its menus, scroll bars, echo
area, etc.  On graphical displays, what Emacs calls a "frame" is what
most other applications call a "window".  Multiple graphical frames
can be shown on the screen at the same time.  On a text terminal, only
one frame can be shown at a time.
954

Eli Zaretskii's avatar
Eli Zaretskii committed
955
>> Type C-x 5 2.
956 957 958 959 960
   See a new frame appear on your screen.

You can do everything you did in the original frame in the new frame.
There is nothing special about the first frame.

Eli Zaretskii's avatar
Eli Zaretskii committed
961
>> Type C-x 5 0.
962 963
   This removes the selected frame.

Chong Yidong's avatar
Chong Yidong committed
964 965 966 967
You can also remove a frame by using the normal method provided by the
graphical system (often clicking a button with an "X" at a top corner
of the frame).  If you remove the Emacs job's last frame this way,
that exits Emacs.
968 969


Jim Blandy's avatar
Jim Blandy committed
970 971
* RECURSIVE EDITING LEVELS
--------------------------
Jim Blandy's avatar
Jim Blandy committed
972 973 974 975 976 977

Sometimes you will get into what is called a "recursive editing
level".  This is indicated by square brackets in the mode line,
surrounding the parentheses around the major mode name.  For
example, you might see [(Fundamental)] instead of (Fundamental).

978 979 980
To get out of the recursive editing level, type <ESC> <ESC> <ESC>.
That is an all-purpose "get out" command.  You can also use it for
eliminating extra windows, and getting out of the minibuffer.
Jim Blandy's avatar
Jim Blandy committed
981

982 983
>> Type M-x to get into a minibuffer; then type <ESC> <ESC> <ESC> to
   get out.
Jim Blandy's avatar
Jim Blandy committed
984

985 986 987
You cannot use C-g to get out of a recursive editing level.  This is
because C-g is used for canceling commands and arguments WITHIN the
recursive editing level.
Jim Blandy's avatar
Jim Blandy committed
988 989


Jim Blandy's avatar
Jim Blandy committed
990 991
* GETTING MORE HELP
-------------------
Jim Blandy's avatar
Jim Blandy committed
992 993 994 995

In this tutorial we have tried to supply just enough information to
get you started using Emacs.  There is so much available in Emacs that
it would be impossible to explain it all here.  However, you may want
996 997 998
to learn more about Emacs since it has many other useful features.
Emacs provides commands for reading documentation about Emacs
commands.  These "help" commands all start with the character
999
CONTROL-h, which is called "the Help character".
Jim Blandy's avatar
Jim Blandy committed
1000

1001
To use the Help features, type the C-h character, and then a
Jim Blandy's avatar
Jim Blandy committed
1002 1003
character saying what kind of help you want.  If you are REALLY lost,
type C-h ? and Emacs will tell you what kinds of help it can give.
1004
If you have typed C-h and decide you do not want any help, just
1005
type C-g to cancel it.
Jim Blandy's avatar
Jim Blandy committed
1006

1007 1008
(If C-h does not display a message about help at the bottom of the
screen, try typing the F1 key or M-x help <Return> instead.)
Richard M. Stallman's avatar
Richard M. Stallman committed
1009 1010 1011

The most basic HELP feature is C-h c.  Type C-h, the character c, and
a command character or sequence; then Emacs displays a very brief
Jim Blandy's avatar
Jim Blandy committed
1012 1013
description of the command.

Gerd Moellmann's avatar
Gerd Moellmann committed
1014
>> Type C-h c C-p.
Richard M. Stallman's avatar
Richard M. Stallman committed
1015 1016

The message should be something like this:
Jim Blandy's avatar
Jim Blandy committed
1017 1018 1019

	C-p runs the command previous-line

1020 1021
This tells you the "name of the function".  Since function names
are chosen to indicate what the command does, they can serve as
1022 1023
very brief documentation--sufficient to remind you of commands you
have already learned.
Jim Blandy's avatar
Jim Blandy committed
1024

Eli Zaretskii's avatar
Eli Zaretskii committed
1025 1026
Multi-character commands such as C-x C-s and <ESC>v (instead of M-v,
if you have no META or EDIT or ALT key) are also allowed after C-h c.
Jim Blandy's avatar
Jim Blandy committed
1027

1028
To get more information about a command, use C-h k instead of C-h c.
Jim Blandy's avatar
Jim Blandy committed
1029

Gerd Moellmann's avatar
Gerd Moellmann committed
1030
>> Type C-h k C-p.
Jim Blandy's avatar
Jim Blandy committed
1031

Chong Yidong's avatar
Chong Yidong committed
1032 1033 1034 1035 1036
This displays the documentation of the function, as well as its name,
in an Emacs window.  When you are finished reading the output, type
C-x 1 to get rid of that window.  You do not have to do this right
away.  You can do some editing while referring to the help text, and
then type C-x 1.
Jim Blandy's avatar
Jim Blandy committed
1037 1038 1039 1040 1041 1042

Here are some other useful C-h options:

   C-h f	Describe a function.  You type in the name of the
		function.

1043
>> Try typing C-h f previous-line <Return>.
1044
   This displays all the information Emacs has about the
1045
   function which implements the C-p command.
Jim Blandy's avatar
Jim Blandy committed
1046

1047 1048 1049
A similar command C-h v displays the documentation of variables,
including those whose values you can set to customize Emacs behavior.
You need to type in the name of the variable when Emacs prompts for it.
1050

Jim Blandy's avatar
Jim Blandy committed
1051 1052
   C-h a	Command Apropos.  Type in a keyword and Emacs will list
		all the commands whose names contain that keyword.
1053
		These commands can all be invoked with META-x.
Eli Zaretskii's avatar
Eli Zaretskii committed
1054 1055 1056
		For some commands, Command Apropos will also list a
		sequence of one or more characters which runs the same
		command.
Jim Blandy's avatar
Jim Blandy committed
1057

1058
>> Type C-h a file <Return>.
Jim Blandy's avatar
Jim Blandy committed
1059

1060
This displays in another window a list of all M-x commands with "file"
1061 1062
in their names.  You will see character-commands listed beside the
corresponding command names (such as C-x C-f beside find-file).
Jim Blandy's avatar
Jim Blandy committed
1063 1064 1065 1066

>> Type C-M-v to scroll the help window.  Do this a few times.

>> Type C-x 1 to delete the help window.
Jim Blandy's avatar
Jim Blandy committed
1067

1068
   C-h i	Read included Manuals (a.k.a. Info).  This command puts
1069
		you into a special buffer called "*info*" where you
1070 1071
		can read manuals for the packages installed on your system.
		Type m emacs <Return> to read the Emacs manual.
Eli Zaretskii's avatar
Eli Zaretskii committed
1072
		If you have never before used Info, type h and Emacs
1073 1074 1075
		will take you on a guided tour of Info mode facilities.
		Once you are through with this tutorial, you should
		consult the Emacs Info manual as your primary documentation.
1076

Jim Blandy's avatar
Jim Blandy committed
1077

1078 1079 1080
* MORE FEATURES
---------------

1081 1082 1083 1084
You can learn more about Emacs by reading its manual, either as a
printed book, or inside Emacs (use the Help menu or type C-h r).
Two features that you may like especially are completion, which saves
typing, and dired, which simplifies file handling.
1085 1086 1087 1088

Completion is a way to avoid unnecessary typing.  For instance, if you
want to switch to the *Messages* buffer, you can type C-x b *M<Tab>
and Emacs will fill in the rest of the buffer name as far as it can
1089 1090 1091
determine from what you have already typed.  Completion also works for
command names and file names.  Completion is described in the Emacs
manual in the node called "Completion".
1092 1093 1094

Dired enables you to list files in a directory (and optionally its
subdirectories), move around that list, visit, rename, delete and
1095 1096
otherwise operate on the files.  Dired is described in the Emacs
manual in the node called "Dired".
1097 1098 1099 1100

The manual also describes many other Emacs features.


Jim Blandy's avatar
Jim Blandy committed
1101 1102
* CONCLUSION
------------
Jim Blandy's avatar
Jim Blandy committed
1103

1104
To exit Emacs use C-x C-c.
Jim Blandy's avatar
Jim Blandy committed
1105 1106 1107 1108 1109

This tutorial is meant to be understandable to all new users, so if
you found something unclear, don't sit and blame yourself - complain!


Karl Heuer's avatar
Karl Heuer committed
1110 1111
* COPYING
---------
Jim Blandy's avatar
Jim Blandy committed
1112 1113 1114 1115

This tutorial descends from a long line of Emacs tutorials
starting with the one written by Stuart Cracraft for the original Emacs.

Glenn Morris's avatar
Glenn Morris committed
1116 1117 1118
This version of the tutorial is a part of GNU Emacs.  It is copyrighted
and comes with permission to distribute copies on certain conditions:

Paul Eggert's avatar
Paul Eggert committed
1119
  Copyright (C) 1985, 1996, 1998, 2001-2019 Free Software Foundation,
1120
  Inc.
Glenn Morris's avatar
Glenn Morris committed
1121 1122

  This file is part of GNU Emacs.
1123 1124

  GNU Emacs is free software: you can redistribute it and/or modify
Glenn Morris's avatar
Glenn Morris committed
1125
  it under the terms of the GNU General Public License as published by
1126 1127 1128
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

Glenn Morris's avatar
Glenn Morris committed
1129 1130 1131 1132
  GNU Emacs is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
1133

Glenn Morris's avatar
Glenn Morris committed
1134
  You should have received a copy of the GNU General Public License
1135
  along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Glenn Morris's avatar
Glenn Morris committed
1136 1137 1138 1139

Please read the file COPYING and then do give copies of GNU Emacs to
your friends.  Help stamp out software obstructionism ("ownership") by
using, writing, and sharing free software!