(diff-kill-junk): New interactive function.
[emacs.git] / man / misc.texi
blob249a2bed23d8124258124b60c1ef6f7c77dbfca0
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985, 86, 87, 93-95, 97, 2000 Free Software Foundation, Inc.
3 @c See file emacs.texi for copying conditions.
4 @iftex
5 @chapter Miscellaneous Commands
7   This chapter contains several brief topics that do not fit anywhere
8 else: reading netnews, running shell commands and shell subprocesses,
9 using a single shared Emacs for utilities that expect to run an editor
10 as a subprocess, printing hardcopy, sorting text, narrowing display to
11 part of the buffer, editing double-column files and binary files, saving
12 an Emacs session for later resumption, emulating other editors, and
13 various diversions and amusements.
15 @end iftex
16 @node Gnus, Shell, Calendar/Diary, Top
17 @section Gnus
18 @cindex Gnus
19 @cindex reading netnews
21 Gnus is an Emacs package primarily designed for reading and posting
22 Usenet news.  It can also be used to read and respond to messages from a
23 number of other sources---mail, remote directories, digests, and so on.
25 Here we introduce Gnus and describe several basic features.
26 @ifinfo
27 For full details, see @ref{Top, Gnus,, gnus, The Gnus Manual}.
28 @end ifinfo
29 @iftex
30 For full details on Gnus, type @kbd{M-x info} and then select the Gnus
31 manual.
32 @end iftex
34 @findex gnus
35 To start Gnus, type @kbd{M-x gnus @key{RET}}.
37 @menu
38 * Buffers of Gnus::     The group, summary, and article buffers.
39 * Gnus Startup::        What you should know about starting Gnus.
40 * Summary of Gnus::     A short description of the basic Gnus commands.
41 @end menu
43 @node Buffers of Gnus
44 @subsection Gnus Buffers
46 As opposed to most normal Emacs packages, Gnus uses a number of
47 different buffers to display information and to receive commands.  The
48 three buffers users spend most of their time in are the @dfn{group
49 buffer}, the @dfn{summary buffer} and the @dfn{article buffer}.  
51 The @dfn{group buffer} contains a list of groups.  This is the first
52 buffer Gnus displays when it starts up.  It normally displays only the
53 groups to which you subscribe and that contain unread articles.  Use
54 this buffer to select a specific group.
56 The @dfn{summary buffer} lists one line for each article in a single
57 group.  By default, the author, the subject and the line number are
58 displayed for each article, but this is customizable, like most aspects
59 of Gnus display.  The summary buffer is created when you select a group
60 in the group buffer, and is killed when you exit the group.  Use this
61 buffer to select an article.
63 The @dfn{article buffer} displays the article.  In normal Gnus usage,
64 you don't select this buffer---all useful article-oriented commands work
65 in the summary buffer.  But you can select the article buffer, and
66 execute all Gnus commands from that buffer, if you want to.
68 @node Gnus Startup
69 @subsection When Gnus Starts Up
71 At startup, Gnus reads your @file{.newsrc} news initialization file
72 and attempts to communicate with the local news server, which is a
73 repository of news articles.  The news server need not be the same
74 computer you are logged in on.
76 If you start Gnus and connect to the server, but do not see any
77 newsgroups listed in the group buffer, type @kbd{L} or @kbd{A k} to get
78 a listing of all the groups.  Then type @kbd{u} to toggle
79 subscription to groups.
81 The first time you start Gnus, Gnus subscribes you to a few selected
82 groups.  All other groups start out as @dfn{killed groups} for you; you
83 can list them with @kbd{A k}.  All new groups that subsequently come to
84 exist at the news server become @dfn{zombie groups} for you; type @kbd{A
85 z} to list them.  You can subscribe to a group shown in these lists
86 using the @kbd{u} command.
88 When you quit Gnus with @kbd{q}, it automatically records in your
89 @file{.newsrc} and @file{.newsrc.eld} initialization files the
90 subscribed or unsubscribed status of all groups.  You should normally
91 not edit these files manually, but you may if you know how.
93 @node Summary of Gnus
94 @subsection Summary of Gnus Commands
96 Reading news is a two step process:
98 @enumerate
99 @item
100 Choose a group in the group buffer.
102 @item
103 Select articles from the summary buffer.  Each article selected is
104 displayed in the article buffer in a large window, below the summary
105 buffer in its small window.
106 @end enumerate
108   Each Gnus buffer has its own special commands; however, the meanings
109 of any given key in the various Gnus buffers are usually analogous, even
110 if not identical.  Here are commands for the group and summary buffers:
112 @table @kbd
113 @kindex q @r{(Gnus Group mode)}
114 @findex gnus-group-exit
115 @item q
116 In the group buffer, update your @file{.newsrc} initialization file
117 and quit Gnus.
119 In the summary buffer, exit the current group and return to the
120 group buffer.  Thus, typing @kbd{q} twice quits Gnus.
122 @kindex L @r{(Gnus Group mode)}
123 @findex gnus-group-list-all-groups
124 @item L
125 In the group buffer, list all the groups available on your news
126 server (except those you have killed).  This may be a long list!
128 @kindex l @r{(Gnus Group mode)}
129 @findex gnus-group-list-groups
130 @item l
131 In the group buffer, list only the groups to which you subscribe and
132 which contain unread articles.
134 @kindex u @r{(Gnus Group mode)}
135 @findex gnus-group-unsubscribe-current-group
136 @cindex subscribe groups
137 @cindex unsubscribe groups
138 @item u
139 In the group buffer, unsubscribe from (or subscribe to) the group listed
140 in the line that point is on.  When you quit Gnus by typing @kbd{q},
141 Gnus lists in your @file{.newsrc} file which groups you have subscribed
142 to.  The next time you start Gnus, you won't see this group,
143 because Gnus normally displays only subscribed-to groups.
145 @kindex C-k @r{(Gnus)}
146 @findex gnus-group-kill-group
147 @item C-k
148 In the group buffer, ``kill'' the current line's group---don't
149 even list it in @file{.newsrc} from now on.  This affects future
150 Gnus sessions as well as the present session.
152 When you quit Gnus by typing @kbd{q}, Gnus writes information
153 in the file @file{.newsrc} describing all newsgroups except those you
154 have ``killed.''
156 @kindex SPC @r{(Gnus)}
157 @findex gnus-group-read-group
158 @item @key{SPC}
159 In the group buffer, select the group on the line under the cursor
160 and display the first unread article in that group.
162 @need 1000
163 In the summary buffer, 
165 @itemize @bullet
166 @item
167 Select the article on the line under the cursor if none is selected.
169 @item
170 Scroll the text of the selected article (if there is one).
172 @item
173 Select the next unread article if at the end of the current article.
174 @end itemize
176 Thus, you can move through all the articles by repeatedly typing @key{SPC}.
178 @kindex DEL @r{(Gnus)}
179 @item @key{DEL}
180 In the group buffer, move point to the previous group containing
181 unread articles.
183 @findex gnus-summary-prev-page
184 In the summary buffer, scroll the text of the article backwards.
186 @kindex n @r{(Gnus)}
187 @findex gnus-group-next-unread-group
188 @findex gnus-summary-next-unread-article
189 @item n
190 Move point to the next unread group, or select the next unread article.
192 @kindex p @r{(Gnus)}
193 @findex gnus-group-prev-unread-group
194 @findex gnus-summary-prev-unread-article
195 @item p
196 Move point to the previous unread group, or select the previous
197 unread article.
199 @kindex C-n @r{(Gnus Group mode)}
200 @findex gnus-group-next-group
201 @kindex C-p @r{(Gnus Group mode)}
202 @findex gnus-group-prev-group
203 @kindex C-n @r{(Gnus Summary mode)}
204 @findex gnus-summary-next-subject
205 @kindex C-p @r{(Gnus Summary mode)}
206 @findex gnus-summary-prev-subject
207 @item C-n
208 @itemx C-p
209 Move point to the next or previous item, even if it is marked as read.
210 This does not select the article or group on that line.
212 @kindex s @r{(Gnus Summary mode)}
213 @findex gnus-summary-isearch-article
214 @item s
215 In the summary buffer, do an incremental search of the current text in
216 the article buffer, just as if you switched to the article buffer and
217 typed @kbd{C-s}.
219 @kindex M-s @r{(Gnus Summary mode)}
220 @findex gnus-summary-search-article-forward
221 @item M-s @var{regexp} @key{RET}
222 In the summary buffer, search forward for articles containing a match
223 for @var{regexp}.
225 @end table
227 @ignore
228 @node Where to Look
229 @subsection Where to Look Further
231 @c Too many references to the name of the manual if done with xref in TeX!
232 Gnus is powerful and customizable.  Here are references to a few
233 @ifinfo
234 additional topics:
236 @end ifinfo
237 @iftex
238 additional topics in @cite{The Gnus Manual}:
240 @itemize @bullet
241 @item
242 Follow discussions on specific topics.@*
243 See section ``Threading.''
245 @item
246 Read digests.  See section ``Document Groups.''
248 @item
249 Refer to and jump to the parent of the current article.@*
250 See section ``Finding the Parent.''
252 @item
253 Refer to articles by using Message-IDs included in the messages.@*
254 See section ``Article Keymap.''
256 @item
257 Save articles.  See section ``Saving Articles.''
259 @item
260 Have Gnus score articles according to various criteria, like author
261 name, subject, or string in the body of the articles.@*
262 See section ``Scoring.''
264 @item
265 Send an article to a newsgroup.@*
266 See section ``Composing Messages.''
267 @end itemize
268 @end iftex
269 @ifinfo
270 @itemize @bullet
271 @item
272 Follow discussions on specific topics.@*
273 @xref{Threading, , Reading Based on Conversation Threads,
274 gnus, The Gnus Manual}.
276 @item
277 Read digests. @xref{Document Groups, , , gnus, The Gnus Manual}.
279 @item
280 Refer to and jump to the parent of the current article.@*
281 @xref{Finding the Parent, , , gnus, The Gnus Manual}.
283 @item
284 Refer to articles by using Message-IDs included in the messages.@*
285 @xref{Article Keymap, , , gnus, The Gnus Manual}.
287 @item
288 Save articles. @xref{Saving Articles, , , gnus, The Gnus Manual}.
290 @item
291 Have Gnus score articles according to various criteria, like author
292 name, subject, or string in the body of the articles.@*
293 @xref{Scoring, , , gnus, The Gnus Manual}. 
295 @item
296 Send an article to a newsgroup.@*
297 @xref{Composing Messages, , , gnus, The Gnus Manual}.
298 @end itemize
299 @end ifinfo
300 @end ignore
302 @node Shell, Emacs Server, Gnus, Top
303 @section Running Shell Commands from Emacs
304 @cindex subshell
305 @cindex shell commands
307   Emacs has commands for passing single command lines to inferior shell
308 processes; it can also run a shell interactively with input and output to
309 an Emacs buffer named @samp{*shell*}.
311 @table @kbd
312 @item M-! @var{cmd} @key{RET}
313 Run the shell command line @var{cmd} and display the output
314 (@code{shell-command}).
315 @item M-| @var{cmd} @key{RET}
316 Run the shell command line @var{cmd} with region contents as input;
317 optionally replace the region with the output
318 (@code{shell-command-on-region}).
319 @item M-x shell
320 Run a subshell with input and output through an Emacs buffer.
321 You can then give commands interactively.
322 @item M-x term
323 Run a subshell with input and output through an Emacs buffer.
324 You can then give commands interactively.
325 Full terminal emulation is available.
326 @end table
328 @menu
329 * Single Shell::           How to run one shell command and return.
330 * Interactive Shell::      Permanent shell taking input via Emacs.
331 * Shell Mode::             Special Emacs commands used with permanent shell.
332 * History: Shell History.  Repeating previous commands in a shell buffer.
333 * Options: Shell Options.  Options for customizing Shell mode.
334 * Terminal emulator::      An Emacs window as a terminal emulator.
335 * Term Mode::              Special Emacs commands used in Term mode.
336 * Paging in Term::         Paging in the terminal emulator.
337 * Remote Host::            Connecting to another computer.
338 @end menu
340 @node Single Shell
341 @subsection Single Shell Commands
343 @kindex M-!
344 @findex shell-command
345   @kbd{M-!} (@code{shell-command}) reads a line of text using the
346 minibuffer and executes it as a shell command in a subshell made just
347 for that command.  Standard input for the command comes from the null
348 device.  If the shell command produces any output, the output goes into
349 an Emacs buffer named @samp{*Shell Command Output*}, which is displayed
350 in another window but not selected.  A numeric argument, as in @kbd{M-1
351 M-!}, directs this command to insert any output into the current buffer.
352 In that case, point is left before the output and the mark is set after
353 the output.
355   If the shell command line ends in @samp{&}, it runs asynchronously.
356 For a synchronous shell command, @code{shell-command} returns the
357 command's exit status (0 means success), when it is called from a Lisp
358 program.
360 @kindex M-|
361 @findex shell-command-on-region
362   @kbd{M-|} (@code{shell-command-on-region}) is like @kbd{M-!} but
363 passes the contents of the region as the standard input to the shell
364 command, instead of no input.  If a numeric argument is used, meaning
365 insert the output in the current buffer, then the old region is deleted
366 first and the output replaces it as the contents of the region.  It
367 returns the command's exit status when it is called from a Lisp program.
369 @vindex shell-file-name
370 @cindex environment
371   Both @kbd{M-!} and @kbd{M-|} use @code{shell-file-name} to specify the
372 shell to use.  This variable is initialized based on your @code{SHELL}
373 environment variable when Emacs is started.  If the file name does not
374 specify a directory, the directories in the list @code{exec-path} are
375 searched; this list is initialized based on the environment variable
376 @code{PATH} when Emacs is started.  Your @file{.emacs} file can override
377 either or both of these default initializations.@refill
379   Both @kbd{M-!} and @kbd{M-|} wait for the shell command to complete.
380 To stop waiting, type @kbd{C-g} to quit; that terminates the shell
381 command with the signal @code{SIGINT}---the same signal that @kbd{C-c}
382 normally generates in the shell.  Emacs waits until the command actually
383 terminates.  If the shell command doesn't stop (because it ignores the
384 @code{SIGINT} signal), type @kbd{C-g} again; this sends the command a
385 @code{SIGKILL} signal which is impossible to ignore.
387   To specify a coding system for @kbd{M-!} or @kbd{M-|}, use the command
388 @kbd{C-x @key{RET} c} immediately beforehand.  @xref{Specify Coding}.
390 @vindex shell-command-default-error-buffer
391   Error output from the command is normally intermixed with the regular
392 output.  If you set the variable
393 @code{shell-command-default-error-buffer} to a string, which is a buffer
394 name, error output is inserted before point in the buffer of that name.
396 @node Interactive Shell
397 @subsection Interactive Inferior Shell
399 @findex shell
400   To run a subshell interactively, putting its typescript in an Emacs
401 buffer, use @kbd{M-x shell}.  This creates (or reuses) a buffer named
402 @samp{*shell*} and runs a subshell with input coming from and output going
403 to that buffer.  That is to say, any ``terminal output'' from the subshell
404 goes into the buffer, advancing point, and any ``terminal input'' for
405 the subshell comes from text in the buffer.  To give input to the subshell,
406 go to the end of the buffer and type the input, terminated by @key{RET}.
408   Emacs does not wait for the subshell to do anything.  You can switch
409 windows or buffers and edit them while the shell is waiting, or while it is
410 running a command.  Output from the subshell waits until Emacs has time to
411 process it; this happens whenever Emacs is waiting for keyboard input or
412 for time to elapse.
414   To make multiple subshells, rename the buffer @samp{*shell*} to
415 something different using @kbd{M-x rename-uniquely}.  Then type @kbd{M-x
416 shell} again to create a new buffer @samp{*shell*} with its own
417 subshell.  If you rename this buffer as well, you can create a third
418 one, and so on.  All the subshells run independently and in parallel.
420 @vindex explicit-shell-file-name
421 @cindex @code{ESHELL} environment variable
422 @cindex @code{SHELL} environment variable
423   The file name used to load the subshell is the value of the variable
424 @code{explicit-shell-file-name}, if that is non-@code{nil}.  Otherwise,
425 the environment variable @code{ESHELL} is used, or the environment
426 variable @code{SHELL} if there is no @code{ESHELL}.  If the file name
427 specified is relative, the directories in the list @code{exec-path} are
428 searched; this list is initialized based on the environment variable
429 @code{PATH} when Emacs is started.  Your @file{.emacs} file can override
430 either or both of these default initializations.
432   To specify a coding system for the shell, you can use the command
433 @kbd{C-x @key{RET} c} immediately before @kbd{M-x shell}.  You can also
434 specify a coding system after starting the shell by using @kbd{C-x
435 @key{RET} p} in the shell buffer.  @xref{Specify Coding}.
437   As soon as the subshell is started, it is sent as input the contents
438 of the file @file{~/.emacs_@var{shellname}}, if that file exists, where
439 @var{shellname} is the name of the file that the shell was loaded from.
440 For example, if you use bash, the file sent to it is
441 @file{~/.emacs_bash}.
443 @vindex shell-pushd-regexp
444 @vindex shell-popd-regexp
445 @vindex shell-cd-regexp
446   @code{cd}, @code{pushd} and @code{popd} commands given to the inferior
447 shell are watched by Emacs so it can keep the @samp{*shell*} buffer's
448 default directory the same as the shell's working directory.  These
449 commands are recognized syntactically by examining lines of input that are
450 sent.  If you use aliases for these commands, you can tell Emacs to
451 recognize them also.  For example, if the value of the variable
452 @code{shell-pushd-regexp} matches the beginning of a shell command line,
453 that line is regarded as a @code{pushd} command.  Change this variable when
454 you add aliases for @samp{pushd}.  Likewise, @code{shell-popd-regexp} and
455 @code{shell-cd-regexp} are used to recognize commands with the meaning of
456 @samp{popd} and @samp{cd}.  These commands are recognized only at the
457 beginning of a shell command line.@refill
459 @vindex shell-set-directory-error-hook
460   If Emacs gets an error while trying to handle what it believes is a
461 @samp{cd}, @samp{pushd} or @samp{popd} command, it runs the hook
462 @code{shell-set-directory-error-hook} (@pxref{Hooks}).
464 @findex dirs
465   If Emacs does not properly track changes in the current directory of
466 the subshell, use the command @kbd{M-x dirs} to ask the shell what its
467 current directory is.  This command works for shells that support the
468 most common command syntax; it may not work for unusual shells.
470 @findex dirtrack-mode
471   You can also use @kbd{M-x dirtrack-mode} to enable (or disable) an
472 alternative and more aggressive method of tracking changes in the
473 current directory.
475   Emacs defines the environment variable @code{EMACS} in the subshell,
476 with value @code{t}.  A shell script can check this variable to
477 determine whether it has been run from an Emacs subshell.
479 @node Shell Mode
480 @subsection Shell Mode
481 @cindex Shell mode
482 @cindex mode, Shell
484   Shell buffers use Shell mode, which defines several special keys
485 attached to the @kbd{C-c} prefix.  They are chosen to resemble the usual
486 editing and job control characters present in shells that are not under
487 Emacs, except that you must type @kbd{C-c} first.  Here is a complete list
488 of the special key bindings of Shell mode:
490 @table @kbd
491 @item @key{RET}
492 @kindex RET @r{(Shell mode)}
493 @findex comint-send-input
494 At end of buffer send line as input; otherwise, copy current line to end
495 of buffer and send it (@code{comint-send-input}).  When a line is
496 copied, any text at the beginning of the line that matches the variable
497 @code{shell-prompt-pattern} is left out; this variable's value should be
498 a regexp string that matches the prompts that your shell uses.
500 @item @key{TAB}
501 @kindex TAB @r{(Shell mode)}
502 @findex comint-dynamic-complete
503 Complete the command name or file name before point in the shell buffer
504 (@code{comint-dynamic-complete}).  @key{TAB} also completes history
505 references (@pxref{History References}) and environment variable names.
507 @vindex shell-completion-fignore
508 @vindex comint-completion-fignore
509 The variable @code{shell-completion-fignore} specifies a list of file
510 name extensions to ignore in Shell mode completion.  The default setting
511 ignores file names ending in @samp{~}, @samp{#} or @samp{%}.  Other
512 related Comint modes use the variable @code{comint-completion-fignore}
513 instead.
515 @item M-?
516 @kindex M-? @r{(Shell mode)}
517 @findex comint-dynamic-list-filename@dots{}
518 Display temporarily a list of the possible completions of the file name
519 before point in the shell buffer
520 (@code{comint-dynamic-list-filename-completions}).
522 @item C-d
523 @kindex C-d @r{(Shell mode)}
524 @findex comint-delchar-or-maybe-eof
525 Either delete a character or send @sc{eof}
526 (@code{comint-delchar-or-maybe-eof}).  Typed at the end of the shell
527 buffer, @kbd{C-d} sends @sc{eof} to the subshell.  Typed at any other
528 position in the buffer, @kbd{C-d} deletes a character as usual.
530 @item C-c C-a
531 @kindex C-c C-a @r{(Shell mode)}
532 @findex comint-bol
533 Move to the beginning of the line, but after the prompt if any
534 (@code{comint-bol}).  If you repeat this command twice in a row, the
535 second time it moves back to the process mark, which is the beginning of
536 the input that you have not yet sent to the subshell.  (Normally that is
537 the same place---the end of the prompt on this line---but after @kbd{C-c
538 @key{SPC}} the process mark may be in a previous line.)
540 @item C-c @key{SPC}
541 Accumulate multiple lines of input, then send them together.  This
542 command inserts a newline before point, but does not send the preceding
543 text as input to the subshell---at least, not yet.  Both lines, the one
544 before this newline and the one after, will be sent together (along with
545 the newline that separates them), when you type @key{RET}.
547 @item C-c C-u
548 @kindex C-c C-u @r{(Shell mode)}
549 @findex comint-kill-input
550 Kill all text pending at end of buffer to be sent as input
551 (@code{comint-kill-input}).
553 @item C-c C-w
554 @kindex C-c C-w @r{(Shell mode)}
555 Kill a word before point (@code{backward-kill-word}).
557 @item C-c C-c
558 @kindex C-c C-c @r{(Shell mode)}
559 @findex comint-interrupt-subjob
560 Interrupt the shell or its current subjob if any
561 (@code{comint-interrupt-subjob}).  This command also kills
562 any shell input pending in the shell buffer and not yet sent.
564 @item C-c C-z
565 @kindex C-c C-z @r{(Shell mode)}
566 @findex comint-stop-subjob
567 Stop the shell or its current subjob if any (@code{comint-stop-subjob}).
568 This command also kills any shell input pending in the shell buffer and
569 not yet sent.
571 @item C-c C-\
572 @findex comint-quit-subjob
573 @kindex C-c C-\ @r{(Shell mode)}
574 Send quit signal to the shell or its current subjob if any
575 (@code{comint-quit-subjob}).  This command also kills any shell input
576 pending in the shell buffer and not yet sent.
578 @item C-c C-o
579 @kindex C-c C-o @r{(Shell mode)}
580 @findex comint-kill-output
581 Kill the last batch of output from a shell command
582 (@code{comint-kill-output}).  This is useful if a shell command spews
583 out lots of output that just gets in the way.
585 @item C-c C-r
586 @itemx C-M-l
587 @kindex C-c C-r @r{(Shell mode)}
588 @kindex C-M-l @r{(Shell mode)}
589 @findex comint-show-output
590 Scroll to display the beginning of the last batch of output at the top
591 of the window; also move the cursor there (@code{comint-show-output}).
593 @item C-c C-e
594 @kindex C-c C-e @r{(Shell mode)}
595 @findex comint-show-maximum-output
596 Scroll to put the end of the buffer at the bottom of the window
597 (@code{comint-show-maximum-output}).
599 @item C-c C-f
600 @kindex C-c C-f @r{(Shell mode)}
601 @findex shell-forward-command
602 @vindex shell-command-regexp
603 Move forward across one shell command, but not beyond the current line
604 (@code{shell-forward-command}).  The variable @code{shell-command-regexp}
605 specifies how to recognize the end of a command.
607 @item C-c C-b
608 @kindex C-c C-b @r{(Shell mode)}
609 @findex shell-backward-command
610 Move backward across one shell command, but not beyond the current line
611 (@code{shell-backward-command}).
613 @item C-c C-l
614 @kindex C-c C-l @r{(Shell mode)}
615 @findex comint-dynamic-list-input-ring
616 Display the buffer's history of shell commands in another window
617 (@code{comint-dynamic-list-input-ring}).
619 @item M-x dirs
620 Ask the shell what its current directory is, so that Emacs can agree
621 with the shell.
623 @item M-x send-invisible @key{RET} @var{text} @key{RET}
624 @findex send-invisible
625 Send @var{text} as input to the shell, after reading it without
626 echoing.  This is useful when a shell command runs a program that asks
627 for a password.
629 Alternatively, you can arrange for Emacs to notice password prompts
630 and turn off echoing for them, as follows:
632 @example
633 (add-hook 'comint-output-filter-functions
634           'comint-watch-for-password-prompt)
635 @end example
637 @item M-x comint-continue-subjob
638 @findex comint-continue-subjob
639 Continue the shell process.  This is useful if you accidentally suspend
640 the shell process.@footnote{You should not suspend the shell process.
641 Suspending a subjob of the shell is a completely different matter---that
642 is normal practice, but you must use the shell to continue the subjob;
643 this command won't do it.}
645 @item M-x comint-strip-ctrl-m
646 @findex comint-strip-ctrl-m
647 Discard all control-M characters from the current group of shell output.
648 The most convenient way to use this command is to make it run
649 automatically when you get output from the subshell.  To do that,
650 evaluate this Lisp expression:
652 @example
653 (add-hook 'comint-output-filter-functions
654           'comint-strip-ctrl-m)
655 @end example
657 @item M-x comint-truncate-buffer
658 @findex comint-truncate-buffer
659 This command truncates the shell buffer to a certain maximum number of
660 lines, specified by the variable @code{comint-buffer-maximum-size}.
661 Here's how to do this automatically each time you get output from the
662 subshell:
664 @example
665 (add-hook 'comint-output-filter-functions
666           'comint-truncate-buffer)
667 @end example
668 @end table
670   Shell mode also customizes the paragraph commands so that only shell
671 prompts start new paragraphs.  Thus, a paragraph consists of an input
672 command plus the output that follows it in the buffer.
674 @cindex Comint mode
675 @cindex mode, Comint
676   Shell mode is a derivative of Comint mode, a general-purpose mode for
677 communicating with interactive subprocesses.  Most of the features of
678 Shell mode actually come from Comint mode, as you can see from the
679 command names listed above.  The special features of Shell mode in
680 particular include the choice of regular expression for detecting
681 prompts, the directory tracking feature, and a few user commands.
683   Other Emacs features that use variants of Comint mode include GUD
684 (@pxref{Debuggers}) and @kbd{M-x run-lisp} (@pxref{External Lisp}).
686 @findex comint-run
687   You can use @kbd{M-x comint-run} to execute any program of your choice
688 in a subprocess using unmodified Comint mode---without the
689 specializations of Shell mode.
691 @node Shell History
692 @subsection Shell Command History
694   Shell buffers support three ways of repeating earlier commands.  You
695 can use the same keys used in the minibuffer; these work much as they do
696 in the minibuffer, inserting text from prior commands while point
697 remains always at the end of the buffer.  You can move through the
698 buffer to previous inputs in their original place, then resubmit them or
699 copy them to the end.  Or you can use a @samp{!}-style history
700 reference.
702 @menu
703 * Ring: Shell Ring.             Fetching commands from the history list.
704 * Copy: Shell History Copying.  Moving to a command and then copying it.
705 * History References::          Expanding @samp{!}-style history references.
706 @end menu
708 @node Shell Ring
709 @subsubsection Shell History Ring
711 @table @kbd
712 @findex comint-previous-input
713 @kindex M-p @r{(Shell mode)}
714 @item M-p
715 Fetch the next earlier old shell command.
717 @kindex M-n @r{(Shell mode)}
718 @findex comint-next-input
719 @item M-n
720 Fetch the next later old shell command.
722 @kindex M-r @r{(Shell mode)}
723 @kindex M-s @r{(Shell mode)}
724 @findex comint-previous-matching-input
725 @findex comint-next-matching-input
726 @item M-r @var{regexp} @key{RET}
727 @itemx M-s @var{regexp} @key{RET}
728 Search backwards or forwards for old shell commands that match @var{regexp}.
730 @item C-c C-x @r{(Shell mode)}
731 @findex comint-get-next-from-history
732 Fetch the next subsequent command from the history.
733 @end table
735   Shell buffers provide a history of previously entered shell commands.  To
736 reuse shell commands from the history, use the editing commands @kbd{M-p},
737 @kbd{M-n}, @kbd{M-r} and @kbd{M-s}.  These work just like the minibuffer
738 history commands except that they operate on the text at the end of the
739 shell buffer, where you would normally insert text to send to the shell.
741   @kbd{M-p} fetches an earlier shell command to the end of the shell buffer.
742 Successive use of @kbd{M-p} fetches successively earlier shell commands,
743 each replacing any text that was already present as potential shell input.
744 @kbd{M-n} does likewise except that it finds successively more recent shell
745 commands from the buffer.
747   The history search commands @kbd{M-r} and @kbd{M-s} read a regular
748 expression and search through the history for a matching command.  Aside
749 from the choice of which command to fetch, they work just like @kbd{M-p}
750 and @kbd{M-r}.  If you enter an empty regexp, these commands reuse the
751 same regexp used last time.
753   When you find the previous input you want, you can resubmit it by
754 typing @key{RET}, or you can edit it first and then resubmit it if you
755 wish.
757   Often it is useful to reexecute several successive shell commands that
758 were previously executed in sequence.  To do this, first find and
759 reexecute the first command of the sequence.  Then type @kbd{C-c C-x};
760 that will fetch the following command---the one that follows the command
761 you just repeated.  Then type @key{RET} to reexecute this command.  You
762 can reexecute several successive commands by typing @kbd{C-c C-x
763 @key{RET}} over and over.
765   These commands get the text of previous shell commands from a special
766 history list, not from the shell buffer itself.  Thus, editing the shell
767 buffer, or even killing large parts of it, does not affect the history
768 that these commands access.
770 @vindex shell-input-ring-file-name
771   Some shells store their command histories in files so that you can
772 refer to previous commands from previous shell sessions.  Emacs reads
773 the command history file for your chosen shell, to initialize its own
774 command history.  The file name is @file{~/.bash_history} for bash,
775 @file{~/.sh_history} for ksh, and @file{~/.history} for other shells.
777 @node Shell History Copying
778 @subsubsection Shell History Copying
780 @table @kbd
781 @kindex C-c C-p @r{(Shell mode)}
782 @findex comint-previous-prompt
783 @item C-c C-p
784 Move point to the previous prompt (@code{comint-previous-prompt}).
786 @kindex C-c C-n @r{(Shell mode)}
787 @findex comint-next-prompt
788 @item C-c C-n
789 Move point to the following prompt (@code{comint-next-prompt}).
791 @kindex C-c RET @r{(Shell mode)}
792 @findex comint-copy-old-input
793 @item C-c @key{RET}
794 Copy the input command which point is in, inserting the copy at the end
795 of the buffer (@code{comint-copy-old-input}).  This is useful if you
796 move point back to a previous command.  After you copy the command, you
797 can submit the copy as input with @key{RET}.  If you wish, you can
798 edit the copy before resubmitting it.
799 @end table
801   Moving to a previous input and then copying it with @kbd{C-c
802 @key{RET}} produces the same results---the same buffer contents---that
803 you would get by using @kbd{M-p} enough times to fetch that previous
804 input from the history list.  However, @kbd{C-c @key{RET}} copies the
805 text from the buffer, which can be different from what is in the history
806 list if you edit the input text in the buffer after it has been sent.
808 @node History References
809 @subsubsection Shell History References
810 @cindex history reference
812   Various shells including csh and bash support @dfn{history references}
813 that begin with @samp{!} and @samp{^}.  Shell mode can understand these
814 constructs and perform the history substitution for you.  If you insert
815 a history reference and type @key{TAB}, this searches the input history
816 for a matching command, performs substitution if necessary, and places
817 the result in the buffer in place of the history reference.  For
818 example, you can fetch the most recent command beginning with @samp{mv}
819 with @kbd{! m v @key{TAB}}.  You can edit the command if you wish, and
820 then resubmit the command to the shell by typing @key{RET}.
822 @vindex shell-prompt-pattern
823 @vindex comint-prompt-regexp
824   History references take effect only following a shell prompt.  The
825 variable @code{shell-prompt-pattern} specifies how to recognize a shell
826 prompt.  Comint modes in general use the variable
827 @code{comint-prompt-regexp} to specify how to find a prompt; Shell mode
828 uses @code{shell-prompt-pattern} to set up the local value of
829 @code{comint-prompt-regexp}.
831 @vindex comint-input-autoexpand
832   Shell mode can optionally expand history references in the buffer when
833 you send them to the shell.  To request this, set the variable
834 @code{comint-input-autoexpand} to @code{input}.
836 @findex comint-magic-space
837   You can make @key{SPC} perform history expansion by binding @key{SPC} to
838 the command @code{comint-magic-space}.
840 @node Shell Options
841 @subsection Shell Mode Options
843 @vindex comint-scroll-to-bottom-on-input
844   If the variable @code{comint-scroll-to-bottom-on-input} is
845 non-@code{nil}, insertion and yank commands scroll the selected window
846 to the bottom before inserting.
848 @vindex comint-scroll-show-maximum-output
849   If @code{comint-scroll-show-maximum-output} is non-@code{nil}, then
850 scrolling due to arrival of output tries to place the last line of text
851 at the bottom line of the window, so as to show as much useful text as
852 possible.  (This mimics the scrolling behavior of many terminals.)
853 The default is @code{nil}.
855 @vindex comint-scroll-to-bottom-on-output
856   By setting @code{comint-scroll-to-bottom-on-output}, you can opt for
857 having point jump to the end of the buffer whenever output arrives---no
858 matter where in the buffer point was before.  If the value is
859 @code{this}, point jumps in the selected window.  If the value is
860 @code{all}, point jumps in each window that shows the comint buffer.  If
861 the value is @code{other}, point jumps in all nonselected windows that
862 show the current buffer.  The default value is @code{nil}, which means
863 point does not jump to the end.
865 @vindex comint-input-ignoredups
866   The variable @code{comint-input-ignoredups} controls whether successive
867 identical inputs are stored in the input history.  A non-@code{nil}
868 value means to omit an input that is the same as the previous input.
869 The default is @code{nil}, which means to store each input even if it is
870 equal to the previous input.
872 @vindex comint-completion-addsuffix
873 @vindex comint-completion-recexact
874 @vindex comint-completion-autolist
875   Three variables customize file name completion.  The variable
876 @code{comint-completion-addsuffix} controls whether completion inserts a
877 space or a slash to indicate a fully completed file or directory name
878 (non-@code{nil} means do insert a space or slash).
879 @code{comint-completion-recexact}, if non-@code{nil}, directs @key{TAB}
880 to choose the shortest possible completion if the usual Emacs completion
881 algorithm cannot add even a single character.
882 @code{comint-completion-autolist}, if non-@code{nil}, says to list all
883 the possible completions whenever completion is not exact.
885 @findex comint-dynamic-complete-variable
886   The command @code{comint-dynamic-complete-variable} does variable-name
887 completion using the environment variables as set within Emacs.  The
888 variables controlling file name completion apply to variable-name
889 completion too.  This command is normally available through the menu
890 bar.
892 @vindex shell-command-execonly
893   Command completion normally considers only executable files.
894 If you set @code{shell-command-execonly} to @code{nil},
895 it considers nonexecutable files as well.
897 @findex shell-pushd-tohome
898 @findex shell-pushd-dextract
899 @findex shell-pushd-dunique
900   You can configure the behavior of @samp{pushd}.  Variables control
901 whether @samp{pushd} behaves like @samp{cd} if no argument is given
902 (@code{shell-pushd-tohome}), pop rather than rotate with a numeric
903 argument (@code{shell-pushd-dextract}), and only add directories to the
904 directory stack if they are not already on it
905 (@code{shell-pushd-dunique}).  The values you choose should match the
906 underlying shell, of course.
908 @node Terminal emulator
909 @subsection Interactive Inferior Shell with Terminal Emulator
910 @findex term
912   To run a subshell in a terminal emulator, putting its typescript in an Emacs
913 buffer, use @kbd{M-x term}.  This creates (or reuses) a buffer named
914 @samp{*term*} and runs a subshell with input coming from your keyboard and
915 output going to that buffer.
917 All the normal keys that you type are sent without any interpretation
918 by Emacs directly to the subshell, as ``terminal input''.
919 Any ``echo'' of your input is the responsibility of the subshell.
920 (The exception is the terminal escape character,
921 which by default is @kbd{C-c}.  @xref{Term Mode}.)
922 Any ``terminal output'' from the subshell goes into the buffer,
923 advancing point.
925   Some programs (such as Emacs itself) need to control the
926 appearance on the terminal screen in detail.  They do this by
927 sending special control codes.  The exact control
928 codes needed vary from terminal to terminal, but nowadays
929 most terminals and terminal emulators (including @code{xterm})
930 understand the ANSI-standard (VT100-style) escape sequences.
931 Term mode also understands these escape sequences,
932 and for each control code does the appropriate thing
933 to change the buffer so that the appearance of the window
934 matches what it would be on a real terminal.
935 Thus you can actually run Emacs inside an Emacs Term window!
937    Emacs does not wait for the subshell to do anything.  You can switch
938 windows or buffers and edit them while the shell is waiting, or while
939 it is running a command.  Output from the subshell waits until Emacs
940 has time to process it; this happens whenever Emacs is waiting for
941 keyboard input or for time to elapse.
943    To make multiple terminal emulators, rename the buffer @samp{*term*}
944 to something different using @kbd{M-x rename-uniquely},
945 just as with Shell mode.
947    The file name used to load the subshell is determined
948 the same way as for Shell mode.
950 Unlike Shell mode, Term mode does not track the current directory
951 by examining your input.  Instead, if you use a programmable
952 shell, you can have it tell Term what the current directory is.
953 This is done automatically by @code{bash} version 1.15 and later.
955 @node Term Mode
956 @subsection Term Mode
957 @cindex Term mode
958 @cindex mode, Term
960   Term uses Term mode, which has two input modes:
961 In line mode, Term basically acts like Shell mode.  @xref{Shell Mode}.
962 In Char mode, each character is sent directly to the inferior subshell,
963 except for the Term escape character, normally @kbd{C-c}.
965 To switch between line and char mode, use these commands:
966 @table @kbd
967 @kindex C-c C-k @r{(Term mode)}
968 @findex term-char-mode
969 @item C-c C-k
970 Switch to line mode.  Do nothing if already in line mode.
972 @kindex C-c C-j @r{(Term mode)}
973 @findex term-line-mode
974 @item C-c C-j
975 Switch to char mode.  Do nothing if already in char mode.
976 @end table
978 The following commands are only available in Char mode:
979 @table @kbd
980 @item C-c C-c
981 Send a literal @key{C-c} to the sub-shell.
983 @item C-c C-x
984 A prefix command to access the global @key{C-x} commands conveniently.
985 For example, @kbd{C-c C-x o} invokes the global binding of
986 @kbd{C-x o}, which is normally @samp{other-window}.
987 @end table
989 @node Paging in Term
990 @subsection Paging in the terminal emulator
992 Term mode has a pager feature.  When the pager is enabled,
993 term mode will pause at the end of each screenful.
995 @table @kbd
996 @kindex C-c C-q @r{(Term mode)}
997 @findex term-pager-toggle
998 @item C-c C-q
999 Toggles the pager feature:  Disables the pager if it is enabled,
1000 and vice versa.  This works in both line and char modes.
1001 If the pager enabled, the mode-line contains the word @samp{page}.
1002 @end table
1004 If the pager is enabled, and Term receives more than a screenful
1005 of output since your last input, Term will enter More break mode.
1006 This is indicated by @samp{**MORE**} in the mode-line.
1007 Type a @kbd{Space} to display the next screenful of output.
1008 Type @kbd{?} to see your other options.  The interface is similar
1009 to the Unix @code{more} program.
1011 @node Remote Host
1012 @subsection Remote Host Shell
1013 @cindex remote host
1014 @cindex connecting to remote host
1015 @cindex Telnet
1016 @cindex Rlogin
1018   You can login to a remote computer, using whatever commands you
1019 would from a regular terminal (e.g.@: using the @code{telnet} or
1020 @code{rlogin} commands), from a Term window.
1022 A program that asks you for a password will normally suppress
1023 echoing of the password, so the password will not show up in the buffer.
1024 This will happen just as if you were using a real terminal, if
1025 the buffer is in char mode.  If it is in line mode, the password
1026 will be temporarily visible, but will be erased when you hit return.
1027 (This happens automatically; there is no special password processing.)
1029 When you log in to a different machine, you need to specify the
1030 type of terminal your using.  Terminal types @samp{ansi}
1031 or @samp{vt100} will work on most systems.
1033 @c   If you are talking to a Bourne-compatible
1034 @c shell, and your system understands the @code{TERMCAP} variable,
1035 @c you can use the command @kbd{M-x shell-send-termcap}, which
1036 @c sends a string specifying the terminal type and size.
1037 @c (This command is also useful after the window has changed size.)
1039 @c You can of course run @samp{gdb} on that remote computer.  One useful
1040 @c trick:  If you invoke gdb with the @code{--fullname} option,
1041 @c it will send special commands to Emacs that will cause Emacs to
1042 @c pop up the source files you're debugging.  This will work
1043 @c whether or not gdb is running on a different computer than Emacs,
1044 @c as long as Emacs can access the source files specified by gdb.
1046 You cannot log into to a remove comuter using the Shell mode.
1047 @c (This will change when Shell is re-written to use Term.)
1048 Instead, Emacs provides two commands for logging in to another computer
1049 and communicating with it through an Emacs buffer.
1051 @table @kbd
1052 @item M-x telnet @key{RET} @var{hostname} @key{RET}
1053 Set up a Telnet connection to the computer named @var{hostname}.
1054 @item M-x rlogin @key{RET} @var{hostname} @key{RET}
1055 Set up an Rlogin connection to the computer named @var{hostname}.
1056 @end table
1058 @findex telnet
1059   Use @kbd{M-x telnet} to set up a Telnet connection to another
1060 computer.  (Telnet is the standard Internet protocol for remote login.)
1061 It reads the host name of the other computer as an argument with the
1062 minibuffer.  Once the connection is established, talking to the other
1063 computer works like talking to a subshell: you can edit input with the
1064 usual Emacs commands, and send it a line at a time by typing @key{RET}.
1065 The output is inserted in the Telnet buffer interspersed with the input.
1067 @findex rlogin
1068 @vindex rlogin-explicit-args
1069   Use @kbd{M-x rlogin} to set up an Rlogin connection.  Rlogin is
1070 another remote login communication protocol, essentially much like the
1071 Telnet protocol but incompatible with it, and supported only by certain
1072 systems.  Rlogin's advantages are that you can arrange not to have to
1073 give your user name and password when communicating between two machines
1074 you frequently use, and that you can make an 8-bit-clean connection.
1075 (To do that in Emacs, set @code{rlogin-explicit-args} to @code{("-8")}
1076 before you run Rlogin.)
1078   @kbd{M-x rlogin} sets up the default file directory of the Emacs
1079 buffer to access the remote host via FTP (@pxref{File Names}), and it
1080 tracks the shell commands that change the current directory, just like
1081 Shell mode.
1083 @findex rlogin-directory-tracking-mode
1084   There are two ways of doing directory tracking in an Rlogin
1085 buffer---either with remote directory names
1086 @file{/@var{host}:@var{dir}/} or with local names (that works if the
1087 ``remote'' machine shares file systems with your machine of origin).
1088 You can use the command @code{rlogin-directory-tracking-mode} to switch
1089 modes.  No argument means use remote directory names, a positive
1090 argument means use local names, and a negative argument means turn
1091 off directory tracking.
1093 @node Emacs Server, Hardcopy, Shell, Top
1094 @section Using Emacs as a Server
1095 @pindex emacsclient
1096 @cindex Emacs as a server
1097 @cindex server, using Emacs as
1098 @cindex @code{EDITOR} environment variable
1100   Various programs such as @code{mail} can invoke your choice of editor
1101 to edit a particular piece of text, such as a message that you are
1102 sending.  By convention, most of these programs use the environment
1103 variable @code{EDITOR} to specify which editor to run.  If you set
1104 @code{EDITOR} to @samp{emacs}, they invoke Emacs---but in an
1105 inconvenient fashion, by starting a new, separate Emacs process.  This
1106 is inconvenient because it takes time and because the new Emacs process
1107 doesn't share the buffers in the existing Emacs process.
1109   You can arrange to use your existing Emacs process as the editor for
1110 programs like @code{mail} by using the Emacs client and Emacs server
1111 programs.  Here is how.
1113 @cindex @code{TEXEDIT} environment variable
1114   First, the preparation.  Within Emacs, call the function
1115 @code{server-start}.  (Your @file{.emacs} file can do this automatically
1116 if you add the expression @code{(server-start)} to it.)  Then, outside
1117 Emacs, set the @code{EDITOR} environment variable to @samp{emacsclient}.
1118 (Note that some programs use a different environment variable; for
1119 example, to make @TeX{} use @samp{emacsclient}, you should set the
1120 @code{TEXEDIT} environment variable to @samp{emacsclient +%d %s}.)
1122 @kindex C-x #
1123 @findex server-edit
1124   Then, whenever any program invokes your specified @code{EDITOR}
1125 program, the effect is to send a message to your principal Emacs telling
1126 it to visit a file.  (That's what the program @code{emacsclient} does.)
1127 Emacs displays the buffer immediately and you can immediately begin
1128 editing it.
1130   When you've finished editing that buffer, type @kbd{C-x #}
1131 (@code{server-edit}).  This saves the file and sends a message back to
1132 the @code{emacsclient} program telling it to exit.  The programs that
1133 use @code{EDITOR} wait for the ``editor'' (actually, @code{emacsclient})
1134 to exit.  @kbd{C-x #} also checks for other pending external requests
1135 to edit various files, and selects the next such file.
1137   You can switch to a server buffer manually if you wish; you don't have
1138 to arrive at it with @kbd{C-x #}.  But @kbd{C-x #} is the only way to
1139 say that you are ``finished'' with one.
1141 @vindex server-window
1142   If you set the variable @code{server-window} to a window or a frame,
1143 @kbd{C-x #} displays the server buffer in that window or in that frame.
1145   While @code{mail} or another application is waiting for
1146 @code{emacsclient} to finish, @code{emacsclient} does not read terminal
1147 input.  So the terminal that @code{mail} was using is effectively
1148 blocked for the duration.  In order to edit with your principal Emacs,
1149 you need to be able to use it without using that terminal.  There are
1150 two ways to do this:
1152 @itemize @bullet
1153 @item
1154 Using a window system, run @code{mail} and the principal Emacs in two
1155 separate windows.  While @code{mail} is waiting for @code{emacsclient},
1156 the window where it was running is blocked, but you can use Emacs by
1157 switching windows.
1159 @item
1160 Use Shell mode in Emacs to run the other program such as @code{mail};
1161 then, @code{emacsclient} blocks only the subshell under Emacs, and you
1162 can still use Emacs to edit the file.
1163 @end itemize
1165 @vindex server-temp-file-regexp
1166   Some programs write temporary files for you to edit.  After you edit
1167 the temporary file, the program reads it back and deletes it.  If the
1168 Emacs server is later asked to edit the same file name, it should assume
1169 this has nothing to do with the previous occasion for that file name.
1170 The server accomplishes this by killing the temporary file's buffer when
1171 you finish with the file.  Use the variable
1172 @code{server-temp-file-regexp} to specify which files are temporary in
1173 this sense; its value should be a regular expression that matches file
1174 names that are temporary.
1176   If you run @code{emacsclient} with the option @samp{--no-wait}, it
1177 returns immediately without waiting for you to ``finish'' the buffer in
1178 Emacs.
1180   If you have forgotten to start Emacs, then the option
1181 @samp{--alternate-editor=@var{command}} may be useful.  It specifies a
1182 command to run if @code{emacsclient} fails to contact Emacs.  For
1183 example, the following setting for the @var{EDITOR} environment variable
1184 will always give an editor, even if Emacs is not running.
1186 @example
1187 EDITOR="emacsclient --alternate-editor vi +%d %s"
1188 @end example
1190 The environment variable @var{ALTERNATE_EDITOR} has the same effect, but
1191 the value of the @samp{--alternate-editor} takes precedence.
1193 @menu
1194 * Invoking emacsclient::
1195 @end menu
1197 @node Invoking emacsclient,, Emacs Server, Emacs Server
1198 @section Invoking @code{emacsclient}
1200   To run the @code{emacsclient} program, specify file names as arguments,
1201 and optionally line numbers as well.  Do it like this:
1203 @example
1204 emacsclient @r{@{}@r{[}+@var{line}@r{]} @var{filename}@r{@}}@dots{}
1205 @end example
1207 This tells Emacs to visit each of the specified files; if you specify a
1208 line number for a certain file, Emacs moves to that line in the file.
1210 Ordinarily, @code{emacsclient} does not return until you use the
1211 @kbd{C-x #} command on each of these buffers.  When that happens, Emacs
1212 sends a message to the @code{emacsclient} program telling it to return.
1214 But if you use the option @samp{-n} or @samp{--no-wait} when running
1215 @code{emacsclient}, then it returns immediately.  (You can take as long
1216 as you like to edit the files in Emacs.)
1219 @node Hardcopy, PostScript, Emacs Server, Top
1220 @section Hardcopy Output
1221 @cindex hardcopy
1223   The Emacs commands for making hardcopy let you print either an entire
1224 buffer or just part of one, either with or without page headers.
1225 See also the hardcopy commands of Dired (@pxref{Misc File Ops})
1226 and the diary (@pxref{Diary Commands}).
1228 @table @kbd
1229 @item M-x print-buffer
1230 Print hardcopy of current buffer with page headings containing the file
1231 name and page number.
1232 @item M-x lpr-buffer
1233 Print hardcopy of current buffer without page headings.
1234 @item M-x print-region
1235 Like @code{print-buffer} but print only the current region.
1236 @item M-x lpr-region
1237 Like @code{lpr-buffer} but print only the current region.
1238 @end table
1240 @findex print-buffer
1241 @findex print-region
1242 @findex lpr-buffer
1243 @findex lpr-region
1244 @vindex lpr-switches
1245   The hardcopy commands (aside from the Postscript commands) pass extra
1246 switches to the @code{lpr} program based on the value of the variable
1247 @code{lpr-switches}.  Its value should be a list of strings, each string
1248 an option starting with @samp{-}.  For example, to specify a line width
1249 of 80 columns for all the printing you do in Emacs, set
1250 @code{lpr-switches} like this:
1252 @example
1253 (setq lpr-switches '("-w80"))
1254 @end example
1256 @vindex printer-name
1257   You can specify the printer to use by setting the variable
1258 @code{printer-name}.
1260 @vindex lpr-headers-switches
1261 @vindex lpr-commands
1262 @vindex lpr-add-switches
1263   The variable @code{lpr-command} specifies the name of the printer
1264 program to run; the default value depends on your operating system type.
1265 On most systems, the default is @code{"lpr"}.  The variable
1266 @code{lpr-headers-switches} similarly specifies the extra switches to
1267 use to make page headers.  The variable @code{lpr-add-switches} controls
1268 whether to supply @samp{-T} and @samp{-J} options (suitable for
1269 @code{lpr}) to the printer program: @code{nil} means don't add them.
1270 @code{lpr-add-switches} should be @code{nil} if your printer program is
1271 not compatible with @code{lpr}.
1273 @node PostScript, PostScript Variables, Hardcopy, Top
1274 @section PostScript Hardcopy
1276   These commands convert buffer contents to PostScript,
1277 either printing it or leaving it in another Emacs buffer.
1279 @table @kbd
1280 @item M-x ps-print-buffer
1281 Print hardcopy of the current buffer in PostScript form.
1282 @item M-x ps-print-region
1283 Print hardcopy of the current region in PostScript form.
1284 @item M-x ps-print-buffer-with-faces
1285 Print hardcopy of the current buffer in PostScript form, showing the
1286 faces used in the text by means of PostScript features.
1287 @item M-x ps-print-region-with-faces
1288 Print hardcopy of the current region in PostScript form, showing the
1289 faces used in the text.
1290 @item M-x ps-spool-buffer
1291 Generate PostScript for the current buffer text.
1292 @item M-x ps-spool-region
1293 Generate PostScript for the current region.
1294 @item M-x ps-spool-buffer-with-faces
1295 Generate PostScript for the current buffer, showing the faces used.
1296 @item M-x ps-spool-region-with-faces
1297 Generate PostScript for the current region, showing the faces used.
1298 @item M-x handwrite
1299 Generates/prints PostScript for the current buffer as if handwritten.
1300 @end table
1302 @findex ps-print-region
1303 @findex ps-print-buffer
1304 @findex ps-print-region-with-faces
1305 @findex ps-print-buffer-with-faces
1306   The PostScript commands, @code{ps-print-buffer} and
1307 @code{ps-print-region}, print buffer contents in PostScript form.  One
1308 command prints the entire buffer; the other, just the region.  The
1309 corresponding @samp{-with-faces} commands,
1310 @code{ps-print-buffer-with-faces} and @code{ps-print-region-with-faces},
1311 use PostScript features to show the faces (fonts and colors) in the text
1312 properties of the text being printed.
1314   If you are using a color display, you can print a buffer of program
1315 code with color highlighting by turning on Font-Lock mode in that
1316 buffer, and using @code{ps-print-buffer-with-faces}.
1318 @findex ps-spool-region
1319 @findex ps-spool-buffer
1320 @findex ps-spool-region-with-faces
1321 @findex ps-spool-buffer-with-faces
1322   The commands whose names have @samp{spool} instead of @samp{print}
1323 generate the PostScript output in an Emacs buffer instead of sending
1324 it to the printer.
1326 @findex handwrite
1327 @cindex handwriting
1328 @kbd{M-x handwrite} is more frivolous.  It generates a PostScript
1329 rendition of the current buffer as a cursive handwritten document.  It
1330 can be customized in group @code{handwrite}.
1332 @ifinfo
1333   The following section describes variables for customizing these commands.
1334 @end ifinfo
1336 @node PostScript Variables, Sorting, PostScript, Top
1337 @section Variables for PostScript Hardcopy
1339 @vindex ps-lpr-command
1340 @vindex ps-lpr-switches
1341 @vindex ps-printer-name
1342   All the PostScript hardcopy commands use the variables
1343 @code{ps-lpr-command} and @code{ps-lpr-switches} to specify how to print
1344 the output.  @code{ps-lpr-command} specifies the command name to run,
1345 @code{ps-lpr-switches} specifies command line options to use, and
1346 @code{ps-printer-name} specifies the printer.  If you don't set the
1347 first two variables yourself, they take their initial values from
1348 @code{lpr-command} and @code{lpr-switches}.  If @code{ps-printer-name}
1349 is @code{nil}, @code{printer-name} is used.
1351 @vindex ps-print-header
1352 @vindex ps-print-color-p
1353   The variable @code{ps-print-header} controls whether these commands
1354 add header lines to each page---set it to @code{nil} to turn headers
1355 off.  You can turn off color processing by setting
1356 @code{ps-print-color-p} to @code{nil}.
1358 @vindex ps-paper-type
1359 @vindex ps-page-dimensions-database
1360   The variable @code{ps-paper-type} specifies which size of paper to
1361 format for; legitimate values include @code{a4}, @code{a3},
1362 @code{a4small}, @code{b4}, @code{b5}, @code{executive}, @code{ledger},
1363 @code{legal}, @code{letter}, @code{letter-small}, @code{statement},
1364 @code{tabloid}.  The default is @code{letter}.  You can define
1365 additional paper sizes by changing the variable
1366 @code{ps-page-dimensions-database}.
1368 @vindex ps-landscape-mode
1369   The variable @code{ps-landscape-mode} specifies the orientation of
1370 printing on the page.  The default is @code{nil}, which stands for
1371 ``portrait'' mode.  Any non-@code{nil} value specifies ``landscape''
1372 mode.
1374 @vindex ps-number-of-columns
1375   The variable @code{ps-number-of-columns} specifies the number of
1376 columns; it takes effect in both landscape and portrait mode.  The
1377 default is 1.
1379 @vindex ps-font-family
1380 @vindex ps-font-size
1381 @vindex ps-font-info-database
1382   The variable @code{ps-font-family} specifies which font family to use
1383 for printing ordinary text.  Legitimate values include @code{Courier},
1384 @code{Helvetica}, @code{NewCenturySchlbk}, @code{Palatino} and
1385 @code{Times}.  The variable @code{ps-font-size} specifies the size of
1386 the font for ordinary text.  It defaults to 8.5 points.
1388   Many other customization variables for these commands are defined and
1389 described in the Lisp file @file{ps-print.el}.
1391 @node Sorting, Narrowing, PostScript Variables, Top
1392 @section Sorting Text
1393 @cindex sorting
1395   Emacs provides several commands for sorting text in the buffer.  All
1396 operate on the contents of the region (the text between point and the
1397 mark).  They divide the text of the region into many @dfn{sort records},
1398 identify a @dfn{sort key} for each record, and then reorder the records
1399 into the order determined by the sort keys.  The records are ordered so
1400 that their keys are in alphabetical order, or, for numeric sorting, in
1401 numeric order.  In alphabetic sorting, all upper-case letters `A' through
1402 `Z' come before lower-case `a', in accord with the ASCII character
1403 sequence.
1405   The various sort commands differ in how they divide the text into sort
1406 records and in which part of each record is used as the sort key.  Most of
1407 the commands make each line a separate sort record, but some commands use
1408 paragraphs or pages as sort records.  Most of the sort commands use each
1409 entire sort record as its own sort key, but some use only a portion of the
1410 record as the sort key.
1412 @findex sort-lines
1413 @findex sort-paragraphs
1414 @findex sort-pages
1415 @findex sort-fields
1416 @findex sort-numeric-fields
1417 @vindex sort-numeric-base
1418 @table @kbd
1419 @item M-x sort-lines
1420 Divide the region into lines, and sort by comparing the entire
1421 text of a line.  A numeric argument means sort into descending order.
1423 @item M-x sort-paragraphs
1424 Divide the region into paragraphs, and sort by comparing the entire
1425 text of a paragraph (except for leading blank lines).  A numeric
1426 argument means sort into descending order.
1428 @item M-x sort-pages
1429 Divide the region into pages, and sort by comparing the entire
1430 text of a page (except for leading blank lines).  A numeric
1431 argument means sort into descending order.
1433 @item M-x sort-fields
1434 Divide the region into lines, and sort by comparing the contents of
1435 one field in each line.  Fields are defined as separated by
1436 whitespace, so the first run of consecutive non-whitespace characters
1437 in a line constitutes field 1, the second such run constitutes field
1438 2, etc.
1440 Specify which field to sort by with a numeric argument: 1 to sort by
1441 field 1, etc.  A negative argument means count fields from the right
1442 instead of from the left; thus, minus 1 means sort by the last field.
1443 If several lines have identical contents in the field being sorted, they
1444 keep same relative order that they had in the original buffer.
1446 @item M-x sort-numeric-fields
1447 Like @kbd{M-x sort-fields} except the specified field is converted
1448 to an integer for each line, and the numbers are compared.  @samp{10}
1449 comes before @samp{2} when considered as text, but after it when
1450 considered as a number.  By default, numbers are interpreted according
1451 to @code{sort-numeric-base}, but numbers beginning with @samp{0x} or
1452 @samp{0} are interpreted as hexadecimal and octal, respectively.
1454 @item M-x sort-columns
1455 Like @kbd{M-x sort-fields} except that the text within each line
1456 used for comparison comes from a fixed range of columns.  See below
1457 for an explanation.
1459 @item M-x reverse-region
1460 Reverse the order of the lines in the region.  This is useful for
1461 sorting into descending order by fields or columns, since those sort
1462 commands do not have a feature for doing that.
1463 @end table
1465   For example, if the buffer contains this:
1467 @smallexample
1468 On systems where clash detection (locking of files being edited) is
1469 implemented, Emacs also checks the first time you modify a buffer
1470 whether the file has changed on disk since it was last visited or
1471 saved.  If it has, you are asked to confirm that you want to change
1472 the buffer.
1473 @end smallexample
1475 @noindent
1476 applying @kbd{M-x sort-lines} to the entire buffer produces this:
1478 @smallexample
1479 On systems where clash detection (locking of files being edited) is
1480 implemented, Emacs also checks the first time you modify a buffer
1481 saved.  If it has, you are asked to confirm that you want to change
1482 the buffer.
1483 whether the file has changed on disk since it was last visited or
1484 @end smallexample
1486 @noindent
1487 where the upper-case @samp{O} sorts before all lower-case letters.  If
1488 you use @kbd{C-u 2 M-x sort-fields} instead, you get this:
1490 @smallexample
1491 implemented, Emacs also checks the first time you modify a buffer
1492 saved.  If it has, you are asked to confirm that you want to change
1493 the buffer.
1494 On systems where clash detection (locking of files being edited) is
1495 whether the file has changed on disk since it was last visited or
1496 @end smallexample
1498 @noindent
1499 where the sort keys were @samp{Emacs}, @samp{If}, @samp{buffer},
1500 @samp{systems} and @samp{the}.
1502 @findex sort-columns
1503   @kbd{M-x sort-columns} requires more explanation.  You specify the
1504 columns by putting point at one of the columns and the mark at the other
1505 column.  Because this means you cannot put point or the mark at the
1506 beginning of the first line of the text you want to sort, this command
1507 uses an unusual definition of `region': all of the line point is in is
1508 considered part of the region, and so is all of the line the mark is in,
1509 as well as all the lines in between.
1511   For example, to sort a table by information found in columns 10 to 15,
1512 you could put the mark on column 10 in the first line of the table, and
1513 point on column 15 in the last line of the table, and then run
1514 @code{sort-columns}.  Equivalently, you could run it with the mark on
1515 column 15 in the first line and point on column 10 in the last line.
1517   This can be thought of as sorting the rectangle specified by point and
1518 the mark, except that the text on each line to the left or right of the
1519 rectangle moves along with the text inside the rectangle.
1520 @xref{Rectangles}.
1522 @vindex sort-fold-case
1523   Many of the sort commands ignore case differences when comparing, if
1524 @code{sort-fold-case} is non-@code{nil}.
1526 @node Narrowing, Two-Column, Sorting, Top
1527 @section Narrowing
1528 @cindex widening
1529 @cindex restriction
1530 @cindex narrowing
1531 @cindex accessible portion
1533   @dfn{Narrowing} means focusing in on some portion of the buffer,
1534 making the rest temporarily inaccessible.  The portion which you can
1535 still get to is called the @dfn{accessible portion}.  Canceling the
1536 narrowing, which makes the entire buffer once again accessible, is
1537 called @dfn{widening}.  The amount of narrowing in effect in a buffer at
1538 any time is called the buffer's @dfn{restriction}.
1540   Narrowing can make it easier to concentrate on a single subroutine or
1541 paragraph by eliminating clutter.  It can also be used to restrict the
1542 range of operation of a replace command or repeating keyboard macro.
1544 @c WideCommands
1545 @table @kbd
1546 @item C-x n n
1547 Narrow down to between point and mark (@code{narrow-to-region}).
1548 @item C-x n w
1549 Widen to make the entire buffer accessible again (@code{widen}).
1550 @item C-x n p
1551 Narrow down to the current page (@code{narrow-to-page}).
1552 @item C-x n d
1553 Narrow down to the current defun (@code{narrow-to-defun}).
1554 @end table
1556   When you have narrowed down to a part of the buffer, that part appears
1557 to be all there is.  You can't see the rest, you can't move into it
1558 (motion commands won't go outside the accessible part), you can't change
1559 it in any way.  However, it is not gone, and if you save the file all
1560 the inaccessible text will be saved.  The word @samp{Narrow} appears in
1561 the mode line whenever narrowing is in effect.
1563 @kindex C-x n n
1564 @findex narrow-to-region
1565   The primary narrowing command is @kbd{C-x n n} (@code{narrow-to-region}).
1566 It sets the current buffer's restrictions so that the text in the current
1567 region remains accessible but all text before the region or after the region
1568 is inaccessible.  Point and mark do not change.
1570 @kindex C-x n p
1571 @findex narrow-to-page
1572 @kindex C-x n d
1573 @findex narrow-to-defun
1574   Alternatively, use @kbd{C-x n p} (@code{narrow-to-page}) to narrow
1575 down to the current page.  @xref{Pages}, for the definition of a page.
1576 @kbd{C-x n d} (@code{narrow-to-defun}) narrows down to the defun
1577 containing point (@pxref{Defuns}).
1579 @kindex C-x n w
1580 @findex widen
1581   The way to cancel narrowing is to widen with @kbd{C-x n w}
1582 (@code{widen}).  This makes all text in the buffer accessible again.
1584   You can get information on what part of the buffer you are narrowed down
1585 to using the @kbd{C-x =} command.  @xref{Position Info}.
1587   Because narrowing can easily confuse users who do not understand it,
1588 @code{narrow-to-region} is normally a disabled command.  Attempting to use
1589 this command asks for confirmation and gives you the option of enabling it;
1590 if you enable the command, confirmation will no longer be required for
1591 it.  @xref{Disabling}.
1593 @node Two-Column, Editing Binary Files, Narrowing, Top
1594 @section Two-Column Editing
1595 @cindex two-column editing
1596 @cindex splitting columns
1597 @cindex columns, splitting
1599   Two-column mode lets you conveniently edit two side-by-side columns of
1600 text.  It uses two side-by-side windows, each showing its own
1601 buffer.
1603   There are three ways to enter two-column mode:
1605 @table @asis
1606 @item @kbd{@key{F2} 2} or @kbd{C-x 6 2}
1607 @kindex F2 2
1608 @kindex C-x 6 2
1609 @findex 2C-two-columns
1610 Enter two-column mode with the current buffer on the left, and on the
1611 right, a buffer whose name is based on the current buffer's name
1612 (@code{2C-two-columns}).  If the right-hand buffer doesn't already
1613 exist, it starts out empty; the current buffer's contents are not
1614 changed.
1616 This command is appropriate when the current buffer is empty or contains
1617 just one column and you want to add another column.
1619 @item @kbd{@key{F2} s} or @kbd{C-x 6 s}
1620 @kindex F2 s
1621 @kindex C-x 6 s
1622 @findex 2C-split
1623 Split the current buffer, which contains two-column text, into two
1624 buffers, and display them side by side (@code{2C-split}).  The current
1625 buffer becomes the left-hand buffer, but the text in the right-hand
1626 column is moved into the right-hand buffer.  The current column
1627 specifies the split point.  Splitting starts with the current line and
1628 continues to the end of the buffer.
1630 This command is appropriate when you have a buffer that already contains
1631 two-column text, and you wish to separate the columns temporarily.
1633 @item @kbd{@key{F2} b @var{buffer} @key{RET}}
1634 @itemx @kbd{C-x 6 b @var{buffer} @key{RET}}
1635 @kindex F2 b
1636 @kindex C-x 6 b
1637 @findex 2C-associate-buffer
1638 Enter two-column mode using the current buffer as the left-hand buffer,
1639 and using buffer @var{buffer} as the right-hand buffer
1640 (@code{2C-associate-buffer}).
1641 @end table
1643   @kbd{@key{F2} s} or @kbd{C-x 6 s} looks for a column separator, which
1644 is a string that appears on each line between the two columns.  You can
1645 specify the width of the separator with a numeric argument to
1646 @kbd{@key{F2} s}; that many characters, before point, constitute the
1647 separator string.  By default, the width is 1, so the column separator
1648 is the character before point.
1650   When a line has the separator at the proper place, @kbd{@key{F2} s}
1651 puts the text after the separator into the right-hand buffer, and
1652 deletes the separator.  Lines that don't have the column separator at
1653 the proper place remain unsplit; they stay in the left-hand buffer, and
1654 the right-hand buffer gets an empty line to correspond.  (This is the
1655 way to write a line that ``spans both columns while in two-column
1656 mode'': write it in the left-hand buffer, and put an empty line in the
1657 right-hand buffer.)
1659 @kindex F2 RET
1660 @kindex C-x 6 RET
1661 @findex 2C-newline
1662   The command @kbd{C-x 6 @key{RET}} or @kbd{@key{F2} @key{RET}}
1663 (@code{2C-newline}) inserts a newline in each of the two buffers at
1664 corresponding positions.  This is the easiest way to add a new line to
1665 the two-column text while editing it in split buffers.
1667 @kindex F2 1
1668 @kindex C-x 6 1
1669 @findex 2C-merge
1670   When you have edited both buffers as you wish, merge them with
1671 @kbd{@key{F2} 1} or @kbd{C-x 6 1} (@code{2C-merge}).  This copies the
1672 text from the right-hand buffer as a second column in the other buffer.
1673 To go back to two-column editing, use @kbd{@key{F2} s}.
1675 @kindex F2 d
1676 @kindex C-x 6 d
1677 @findex 2C-dissociate
1678   Use @kbd{@key{F2} d} or @kbd{C-x 6 d} to dissociate the two buffers,
1679 leaving each as it stands (@code{2C-dissociate}).  If the other buffer,
1680 the one not current when you type @kbd{@key{F2} d}, is empty,
1681 @kbd{@key{F2} d} kills it.
1683 @node Editing Binary Files, Saving Emacs Sessions, Two-Column, Top
1684 @section Editing Binary Files
1686 @cindex Hexl mode
1687 @cindex mode, Hexl
1688 @cindex editing binary files
1689   There is a special major mode for editing binary files: Hexl mode.  To
1690 use it, use @kbd{M-x hexl-find-file} instead of @kbd{C-x C-f} to visit
1691 the file.  This command converts the file's contents to hexadecimal and
1692 lets you edit the translation.  When you save the file, it is converted
1693 automatically back to binary.
1695   You can also use @kbd{M-x hexl-mode} to translate an existing buffer
1696 into hex.  This is useful if you visit a file normally and then discover
1697 it is a binary file.
1699   Ordinary text characters overwrite in Hexl mode.  This is to reduce
1700 the risk of accidentally spoiling the alignment of data in the file.
1701 There are special commands for insertion.  Here is a list of the
1702 commands of Hexl mode:
1704 @c I don't think individual index entries for these commands are useful--RMS.
1705 @table @kbd
1706 @item C-M-d
1707 Insert a byte with a code typed in decimal.
1709 @item C-M-o
1710 Insert a byte with a code typed in octal.
1712 @item C-M-x
1713 Insert a byte with a code typed in hex.
1715 @item C-x [
1716 Move to the beginning of a 1k-byte ``page.''
1718 @item C-x ]
1719 Move to the end of a 1k-byte ``page.''
1721 @item M-g
1722 Move to an address specified in hex.
1724 @item M-j
1725 Move to an address specified in decimal.
1727 @item C-c C-c
1728 Leave Hexl mode, going back to the major mode this buffer had before you
1729 invoked @code{hexl-mode}.
1730 @end table
1732 @node Saving Emacs Sessions, Recursive Edit, Editing Binary Files, Top
1733 @section Saving Emacs Sessions
1734 @cindex saving sessions
1735 @cindex desktop
1737   You can use the Desktop library to save the state of Emacs from one
1738 session to another.  Saving the state means that Emacs starts up with
1739 the same set of buffers, major modes, buffer positions, and so on that
1740 the previous Emacs session had.
1742 @vindex desktop-enable
1743   To use Desktop, you should use the Customization buffer (@pxref{Easy
1744 Customization}) to set @code{desktop-enable} to a non-@code{nil} value,
1745 or add these lines at the end of your @file{.emacs} file:
1747 @example
1748 (desktop-load-default)
1749 (desktop-read)
1750 @end example
1752 @noindent
1753 @findex desktop-save
1754 The first time you save the state of the Emacs session, you must do it
1755 manually, with the command @kbd{M-x desktop-save}.  Once you have done
1756 that, exiting Emacs will save the state again---not only the present
1757 Emacs session, but also subsequent sessions.  You can also save the
1758 state at any time, without exiting Emacs, by typing @kbd{M-x
1759 desktop-save} again.
1761   In order for Emacs to recover the state from a previous session, you
1762 must start it with the same current directory as you used when you
1763 started the previous session.  This is because @code{desktop-read} looks
1764 in the current directory for the file to read.  This means that you can
1765 have separate saved sessions in different directories; the directory in
1766 which you start Emacs will control which saved session to use.
1768 @vindex desktop-files-not-to-save
1769   The variable @code{desktop-files-not-to-save} controls which files are
1770 excluded from state saving.  Its value is a regular expression that
1771 matches the files to exclude.  By default, remote (ftp-accessed) files
1772 are excluded; this is because visiting them again in the subsequent
1773 session would be slow.  If you want to include these files in state
1774 saving, set @code{desktop-files-not-to-save} to @code{"^$"}.
1775 @xref{Remote Files}.
1777 @node Recursive Edit, Emulation, Saving Emacs Sessions, Top
1778 @section Recursive Editing Levels
1779 @cindex recursive editing level
1780 @cindex editing level, recursive
1782   A @dfn{recursive edit} is a situation in which you are using Emacs
1783 commands to perform arbitrary editing while in the middle of another
1784 Emacs command.  For example, when you type @kbd{C-r} inside of a
1785 @code{query-replace}, you enter a recursive edit in which you can change
1786 the current buffer.  On exiting from the recursive edit, you go back to
1787 the @code{query-replace}.
1789 @kindex C-M-c
1790 @findex exit-recursive-edit
1791 @cindex exiting recursive edit
1792   @dfn{Exiting} the recursive edit means returning to the unfinished
1793 command, which continues execution.  The command to exit is @kbd{C-M-c}
1794 (@code{exit-recursive-edit}).
1796   You can also @dfn{abort} the recursive edit.  This is like exiting,
1797 but also quits the unfinished command immediately.  Use the command
1798 @kbd{C-]} (@code{abort-recursive-edit}) to do this.  @xref{Quitting}.
1800   The mode line shows you when you are in a recursive edit by displaying
1801 square brackets around the parentheses that always surround the major and
1802 minor mode names.  Every window's mode line shows this, in the same way,
1803 since being in a recursive edit is true of Emacs as a whole rather than
1804 any particular window or buffer.
1806   It is possible to be in recursive edits within recursive edits.  For
1807 example, after typing @kbd{C-r} in a @code{query-replace}, you may type a
1808 command that enters the debugger.  This begins a recursive editing level
1809 for the debugger, within the recursive editing level for @kbd{C-r}.
1810 Mode lines display a pair of square brackets for each recursive editing
1811 level currently in progress.
1813   Exiting the inner recursive edit (such as, with the debugger @kbd{c}
1814 command) resumes the command running in the next level up.  When that
1815 command finishes, you can then use @kbd{C-M-c} to exit another recursive
1816 editing level, and so on.  Exiting applies to the innermost level only.
1817 Aborting also gets out of only one level of recursive edit; it returns
1818 immediately to the command level of the previous recursive edit.  If you
1819 wish, you can then abort the next recursive editing level.
1821   Alternatively, the command @kbd{M-x top-level} aborts all levels of
1822 recursive edits, returning immediately to the top-level command reader.
1824   The text being edited inside the recursive edit need not be the same text
1825 that you were editing at top level.  It depends on what the recursive edit
1826 is for.  If the command that invokes the recursive edit selects a different
1827 buffer first, that is the buffer you will edit recursively.  In any case,
1828 you can switch buffers within the recursive edit in the normal manner (as
1829 long as the buffer-switching keys have not been rebound).  You could
1830 probably do all the rest of your editing inside the recursive edit,
1831 visiting files and all.  But this could have surprising effects (such as
1832 stack overflow) from time to time.  So remember to exit or abort the
1833 recursive edit when you no longer need it.
1835   In general, we try to minimize the use of recursive editing levels in
1836 GNU Emacs.  This is because they constrain you to ``go back'' in a
1837 particular order---from the innermost level toward the top level.  When
1838 possible, we present different activities in separate buffers so that
1839 you can switch between them as you please.  Some commands switch to a
1840 new major mode which provides a command to switch back.  These
1841 approaches give you more flexibility to go back to unfinished tasks in
1842 the order you choose.
1844 @node Emulation, Dissociated Press, Recursive Edit, Top
1845 @section Emulation
1846 @cindex emulating other editors
1847 @cindex other editors
1848 @cindex EDT
1849 @cindex vi
1850 @cindex CRiSP
1851 @cindex Brief
1852 @cindex PC keybindings
1853 @cindex scrolling all windows
1854 @cindex PC selecion
1855 @cindex Motif keybindings
1856 @cindex Macintosh keybindings
1857 @cindex WordStar
1859   GNU Emacs can be programmed to emulate (more or less) most other
1860 editors.  Standard facilities can emulate these:
1862 @table @asis
1863 @item CRiSP/Brief (PC editor)
1864 @findex crisp-mode
1865 @vindex crisp-override-meta-x
1866 @findex scroll-all-mode
1867 Turn on keybindings to emulate the CRiSP/Brief editor with @kbd{M-x
1868 crisp-mode}.  Note that this rebinds @kbd{M-x} to exit Emacs unless you
1869 change the user option @code{crisp-override-meta-x}.  You can also load
1870 the @code{scroll-all} package to emulate CRiSP's scroll-all feature
1871 (scrolling all windows together).  Do thsi either with @kbd{M-x
1872 scroll-all-mode} or set the user option @code{crisp-load-scroll-all} to
1873 load it along with @code{crisp-mode}.
1875 @item EDT (DEC VMS editor)
1876 @findex edt-emulation-on
1877 @findex edt-emulation-off
1878 Turn on EDT emulation with @kbd{M-x edt-emulation-on}.  @kbd{M-x
1879 edt-emulation-off} restores normal Emacs command bindings.
1881 Most of the EDT emulation commands are keypad keys, and most standard
1882 Emacs key bindings are still available.  The EDT emulation rebindings
1883 are done in the global keymap, so there is no problem switching
1884 buffers or major modes while in EDT emulation.
1886 @item `PC' bindings
1887 @findex pc-bindings-mode
1888 @kbd{M-x pc-bindings-mode} sets up certain key bindings for `PC
1889 compatibility'---what people are often used to on PCs---as follows:
1890 @kbd{Delete} and its variants) delete forward instead of backward,
1891 @kbd{C-Backspace} kills backward a word (as @kbd{C-Delete} normally
1892 would), @kbd{M-Backspace} does undo, @kbd{Home} and @kbd{End} move to
1893 beginning and end of line, @kbd{C-Home} and @kbd{C-End} move to
1894 beginning and end of buffer and @kbd{C-Escape} does @code{list-buffers}.
1896 @item PC selection mode
1897 @findex pc-selection-mode
1898 @kbd{M-x pc-selction-mode} emulates the mark, copy, cut and paste
1899 look-and-feel of Motif programs (which is the same as the Macintosh GUI
1900 and MS-Windows).  It makes the keybindings of PC mode and also modifies
1901 the bindings of the cursor keys and the @kbd{next}, @kbd{prior},
1902 @kbd{home} and @kbd{end} keys.  It does not provide the full set of CUA
1903 keybindings---the fundamental Emacs keys @kbd{C-c}, @kbd{C-v} and
1904 @kbd{C-x} are not rebound.
1906 The standard keys for moving around (@kbd{right}, @kbd{left}, @kbd{up},
1907 @kbd{down}, @kbd{home}, @kbd{end}, @kbd{prior}, @kbd{next}, called
1908 ``move-keys'') will always de-activate the mark.  Using @kbd{Shift}
1909 together with the ``move keys'' activates the region over which they
1910 move.  The copy, cut and paste functions (as in many other programs)
1911 operate on the active region, bound to @kbd{C-insert}, @kbd{S-delete}
1912 and @kbd{S-insert} respectively.
1914 The @code{s-region} package provides similar, but less complete,
1915 facilities.
1917 @item vi (Berkeley editor)
1918 @findex viper-mode
1919 Viper is the newest emulator for vi.  It implements several levels of
1920 emulation; level 1 is closest to vi itself, while level 5 departs
1921 somewhat from strict emulation to take advantage of the capabilities of
1922 Emacs.  To invoke Viper, type @kbd{M-x viper-mode}; it will guide you
1923 the rest of the way and ask for the emulation level.  @inforef{Top,
1924 Viper, viper}.
1926 @item vi (another emulator)
1927 @findex vi-mode
1928 @kbd{M-x vi-mode} enters a major mode that replaces the previously
1929 established major mode.  All of the vi commands that, in real vi, enter
1930 ``input'' mode are programmed instead to return to the previous major
1931 mode.  Thus, ordinary Emacs serves as vi's ``input'' mode.
1933 Because vi emulation works through major modes, it does not work
1934 to switch buffers during emulation.  Return to normal Emacs first.
1936 If you plan to use vi emulation much, you probably want to bind a key
1937 to the @code{vi-mode} command.
1939 @item vi (alternate emulator)
1940 @findex vip-mode
1941 @kbd{M-x vip-mode} invokes another vi emulator, said to resemble real vi
1942 more thoroughly than @kbd{M-x vi-mode}.  ``Input'' mode in this emulator
1943 is changed from ordinary Emacs so you can use @key{ESC} to go back to
1944 emulated vi command mode.  To get from emulated vi command mode back to
1945 ordinary Emacs, type @kbd{C-z}.
1947 This emulation does not work through major modes, and it is possible
1948 to switch buffers in various ways within the emulator.  It is not
1949 so necessary to assign a key to the command @code{vip-mode} as
1950 it is with @code{vi-mode} because terminating insert mode does
1951 not use it.
1953 @inforef{Top, VIP, vip}, for full information.
1955 @item WordStar (old wordprocessor)
1956 @findex wordstar-mode
1957 @kbd{M-x wordstar-mode} provides a major mode with WordStar-like
1958 keybindings.
1959 @end table
1961 @node Dissociated Press, Amusements, Emulation, Top
1962 @section Dissociated Press
1964 @findex dissociated-press
1965   @kbd{M-x dissociated-press} is a command for scrambling a file of text
1966 either word by word or character by character.  Starting from a buffer of
1967 straight English, it produces extremely amusing output.  The input comes
1968 from the current Emacs buffer.  Dissociated Press writes its output in a
1969 buffer named @samp{*Dissociation*}, and redisplays that buffer after every
1970 couple of lines (approximately) so you can read the output as it comes out.
1972   Dissociated Press asks every so often whether to continue generating
1973 output.  Answer @kbd{n} to stop it.  You can also stop at any time by
1974 typing @kbd{C-g}.  The dissociation output remains in the
1975 @samp{*Dissociation*} buffer for you to copy elsewhere if you wish.
1977 @cindex presidentagon
1978   Dissociated Press operates by jumping at random from one point in the
1979 buffer to another.  In order to produce plausible output rather than
1980 gibberish, it insists on a certain amount of overlap between the end of
1981 one run of consecutive words or characters and the start of the next.
1982 That is, if it has just printed out `president' and then decides to jump
1983 to a different point in the file, it might spot the `ent' in `pentagon'
1984 and continue from there, producing `presidentagon'.@footnote{This
1985 dissociword actually appeared during the Vietnam War, when it was very
1986 appropriate.}  Long sample texts produce the best results.
1988 @cindex againformation
1989   A positive argument to @kbd{M-x dissociated-press} tells it to operate
1990 character by character, and specifies the number of overlap characters.  A
1991 negative argument tells it to operate word by word and specifies the number
1992 of overlap words.  In this mode, whole words are treated as the elements to
1993 be permuted, rather than characters.  No argument is equivalent to an
1994 argument of two.  For your againformation, the output goes only into the
1995 buffer @samp{*Dissociation*}.  The buffer you start with is not changed.
1997 @cindex Markov chain
1998 @cindex ignoriginal
1999 @cindex techniquitous
2000   Dissociated Press produces nearly the same results as a Markov chain
2001 based on a frequency table constructed from the sample text.  It is,
2002 however, an independent, ignoriginal invention.  Dissociated Press
2003 techniquitously copies several consecutive characters from the sample
2004 between random choices, whereas a Markov chain would choose randomly for
2005 each word or character.  This makes for more plausible sounding results,
2006 and runs faster.
2008 @cindex outragedy
2009 @cindex buggestion
2010 @cindex properbose
2011 @cindex mustatement
2012 @cindex developediment
2013 @cindex userenced
2014   It is a mustatement that too much use of Dissociated Press can be a
2015 developediment to your real work.  Sometimes to the point of outragedy.
2016 And keep dissociwords out of your documentation, if you want it to be well
2017 userenced and properbose.  Have fun.  Your buggestions are welcome.
2019 @node Amusements, Customization, Dissociated Press, Top
2020 @section Other Amusements
2021 @cindex boredom
2022 @findex hanoi
2023 @findex yow
2024 @findex gomoku
2025 @cindex tower of Hanoi
2027   If you are a little bit bored, you can try @kbd{M-x hanoi}.  If you are
2028 considerably bored, give it a numeric argument.  If you are very very
2029 bored, try an argument of 9.  Sit back and watch.
2031 @cindex Go Moku
2032   If you want a little more personal involvement, try @kbd{M-x gomoku},
2033 which plays the game Go Moku with you.
2035 @findex blackbox
2036 @findex mpuz
2037 @findex 5x5
2038 @cindex puzzles
2039   @kbd{M-x blackbox}, @kbd{M-x mpuz} and @kbd{M-x 5x5} are kinds of puzzles.
2040 @code{blackbox} challenges you to determine the location of objects
2041 inside a box by tomography.  @code{mpuz} displays a multiplication
2042 puzzle with letters standing for digits in a code that you must
2043 guess---to guess a value, type a letter and then the digit you think it
2044 stands for.  The aim of @code{5x5} is to fill in all the squares.
2046 @findex dunnet
2047   @kbd{M-x dunnet} runs an adventure-style exploration game, which is
2048 a bigger sort of puzzle.
2050 @findex lm
2051 @cindex landmark game
2052 @kbd{M-x lm} runs a relatively non-participatory game in which a robot
2053 attempts to maneuver towards a tree at the center of the window based on
2054 unique olfactory cues from each of the four directions.
2056 @findex life
2057 @cindex Life
2058 @kbd{M-x life} runs Conway's `Life' cellular automaton.
2060 @findex solitaire
2061 @cindex solitaire
2062 @kbd{M-x solitaire} plays a game of solitaire in which you jump pegs
2063 across other pegs.
2065 @findex tetris
2066 @cindex Tetris
2067 @kbd{M-x tetris} runs an implementation of the well-known Tetris game.
2068 @findex snake
2069 @cindex Snake
2070 Likewise, @kbd{M-x snake} provides an implementation of Snake.
2072   When you are frustrated, try the famous Eliza program.  Just do
2073 @kbd{M-x doctor}.  End each input by typing @key{RET} twice.
2075 @cindex Zippy
2076   When you are feeling strange, type @kbd{M-x yow}.