TUTORIAL 46 KB

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