]> code.delx.au - gnu-emacs/blob - man/misc.texi
PostScript <- Postscript.
[gnu-emacs] / man / misc.texi
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
6
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.
14
15 @end iftex
16 @node Gnus, Shell, Calendar/Diary, Top
17 @section Gnus
18 @cindex Gnus
19 @cindex reading netnews
20
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.
24
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
33
34 @findex gnus
35 To start Gnus, type @kbd{M-x gnus @key{RET}}.
36
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
42
43 @node Buffers of Gnus
44 @subsection Gnus Buffers
45
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}.
50
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.
55
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.
62
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.
67
68 @node Gnus Startup
69 @subsection When Gnus Starts Up
70
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.
75
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.
80
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.
87
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.
92
93 @node Summary of Gnus
94 @subsection Summary of Gnus Commands
95
96 Reading news is a two step process:
97
98 @enumerate
99 @item
100 Choose a group in the group buffer.
101
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
107
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:
111
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.
118
119 In the summary buffer, exit the current group and return to the
120 group buffer. Thus, typing @kbd{q} twice quits Gnus.
121
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!
127
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.
133
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.
144
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.
151
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.''
155
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.
161
162 @need 1000
163 In the summary buffer,
164
165 @itemize @bullet
166 @item
167 Select the article on the line under the cursor if none is selected.
168
169 @item
170 Scroll the text of the selected article (if there is one).
171
172 @item
173 Select the next unread article if at the end of the current article.
174 @end itemize
175
176 Thus, you can move through all the articles by repeatedly typing @key{SPC}.
177
178 @kindex DEL @r{(Gnus)}
179 @item @key{DEL}
180 In the group buffer, move point to the previous group containing
181 unread articles.
182
183 @findex gnus-summary-prev-page
184 In the summary buffer, scroll the text of the article backwards.
185
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.
191
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.
198
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.
211
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}.
218
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}.
224
225 @end table
226
227 @ignore
228 @node Where to Look
229 @subsection Where to Look Further
230
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:
235
236 @end ifinfo
237 @iftex
238 additional topics in @cite{The Gnus Manual}:
239
240 @itemize @bullet
241 @item
242 Follow discussions on specific topics.@*
243 See section ``Threading.''
244
245 @item
246 Read digests. See section ``Document Groups.''
247
248 @item
249 Refer to and jump to the parent of the current article.@*
250 See section ``Finding the Parent.''
251
252 @item
253 Refer to articles by using Message-IDs included in the messages.@*
254 See section ``Article Keymap.''
255
256 @item
257 Save articles. See section ``Saving Articles.''
258
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.''
263
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}.
275
276 @item
277 Read digests. @xref{Document Groups, , , gnus, The Gnus Manual}.
278
279 @item
280 Refer to and jump to the parent of the current article.@*
281 @xref{Finding the Parent, , , gnus, The Gnus Manual}.
282
283 @item
284 Refer to articles by using Message-IDs included in the messages.@*
285 @xref{Article Keymap, , , gnus, The Gnus Manual}.
286
287 @item
288 Save articles. @xref{Saving Articles, , , gnus, The Gnus Manual}.
289
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}.
294
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
301
302 @node Shell, Emacs Server, Gnus, Top
303 @section Running Shell Commands from Emacs
304 @cindex subshell
305 @cindex shell commands
306
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*}.
310
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
327
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
339
340 @node Single Shell
341 @subsection Single Shell Commands
342
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.
354
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.
359
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.
368
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
378
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.
386
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}.
389
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.
395
396 @node Interactive Shell
397 @subsection Interactive Inferior Shell
398
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}.
407
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.
413
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.
419
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.
431
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}.
436
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}.
442
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
458
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}).
463
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.
469
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.
474
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.
478
479 @node Shell Mode
480 @subsection Shell Mode
481 @cindex Shell mode
482 @cindex mode, Shell
483
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:
489
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.
499
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.
506
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.
514
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}).
521
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.
529
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.)
539
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}.
546
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}).
552
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}).
556
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.
563
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.
570
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.
577
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.
584
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}).
592
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}).
598
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.
606
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}).
612
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}).
618
619 @item M-x dirs
620 Ask the shell what its current directory is, so that Emacs can agree
621 with the shell.
622
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.
628
629 Alternatively, you can arrange for Emacs to notice password prompts
630 and turn off echoing for them, as follows:
631
632 @example
633 (add-hook 'comint-output-filter-functions
634 'comint-watch-for-password-prompt)
635 @end example
636
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.}
644
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:
651
652 @example
653 (add-hook 'comint-output-filter-functions
654 'comint-strip-ctrl-m)
655 @end example
656
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:
663
664 @example
665 (add-hook 'comint-output-filter-functions
666 'comint-truncate-buffer)
667 @end example
668 @end table
669
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.
673
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.
682
683 Other Emacs features that use variants of Comint mode include GUD
684 (@pxref{Debuggers}) and @kbd{M-x run-lisp} (@pxref{External Lisp}).
685
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.
690
691 @node Shell History
692 @subsection Shell Command History
693
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.
701
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
707
708 @node Shell Ring
709 @subsubsection Shell History Ring
710
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.
716
717 @kindex M-n @r{(Shell mode)}
718 @findex comint-next-input
719 @item M-n
720 Fetch the next later old shell command.
721
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}.
729
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
734
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.
740
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.
746
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.
752
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.
756
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.
764
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.
769
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.
776
777 @node Shell History Copying
778 @subsubsection Shell History Copying
779
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}).
785
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}).
790
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
800
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.
807
808 @node History References
809 @subsubsection Shell History References
810 @cindex history reference
811
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}.
821
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}.
830
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}.
835
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}.
839
840 @node Shell Options
841 @subsection Shell Mode Options
842
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.
847
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}.
854
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.
864
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.
871
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.
884
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.
891
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.
896
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.
907
908 @node Terminal emulator
909 @subsection Interactive Inferior Shell with Terminal Emulator
910 @findex term
911
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.
916
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.
924
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!
936
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.
942
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.
946
947 The file name used to load the subshell is determined
948 the same way as for Shell mode.
949
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.
954
955 @node Term Mode
956 @subsection Term Mode
957 @cindex Term mode
958 @cindex mode, Term
959
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}.
964
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.
971
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
977
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.
982
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
988
989 @node Paging in Term
990 @subsection Paging in the terminal emulator
991
992 Term mode has a pager feature. When the pager is enabled,
993 term mode will pause at the end of each screenful.
994
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
1003
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.
1010
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
1017
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.
1021
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.)
1028
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.
1032
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.)
1038
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.
1045
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.
1050
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
1057
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.
1066
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.)
1077
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.
1082
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.
1092
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
1099
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.
1108
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.
1112
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}.)
1121
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.
1129
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.
1136
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.
1140
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.
1144
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:
1151
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.
1158
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
1164
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.
1175
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.
1179
1180 @menu
1181 * Invoking emacsclient::
1182 @end menu
1183
1184 @node Invoking emacsclient,, Emacs Server, Emacs Server
1185 @section Invoking @code{emacsclient}
1186
1187 To run the @code{emacsclient} program, specify file names as arguments,
1188 and optionally line numbers as well. Do it like this:
1189
1190 @example
1191 emacsclient @r{@{}@r{[}+@var{line}@r{]} @var{filename}@r{@}}@dots{}
1192 @end example
1193
1194 This tells Emacs to visit each of the specified files; if you specify a
1195 line number for a certain file, Emacs moves to that line in the file.
1196
1197 Ordinarily, @code{emacsclient} does not return until you use the
1198 @kbd{C-x #} command on each of these buffers. When that happens, Emacs
1199 sends a message to the @code{emacsclient} program telling it to return.
1200
1201 But if you use the option @samp{-n} or @samp{--no-wait} when running
1202 @code{emacsclient}, then it returns immediately. (You can take as long
1203 as you like to edit the files in Emacs.)
1204
1205
1206 @node Hardcopy, PostScript, Emacs Server, Top
1207 @section Hardcopy Output
1208 @cindex hardcopy
1209
1210 The Emacs commands for making hardcopy let you print either an entire
1211 buffer or just part of one, either with or without page headers.
1212 See also the hardcopy commands of Dired (@pxref{Misc File Ops})
1213 and the diary (@pxref{Diary Commands}).
1214
1215 @table @kbd
1216 @item M-x print-buffer
1217 Print hardcopy of current buffer with page headings containing the file
1218 name and page number.
1219 @item M-x lpr-buffer
1220 Print hardcopy of current buffer without page headings.
1221 @item M-x print-region
1222 Like @code{print-buffer} but print only the current region.
1223 @item M-x lpr-region
1224 Like @code{lpr-buffer} but print only the current region.
1225 @end table
1226
1227 @findex print-buffer
1228 @findex print-region
1229 @findex lpr-buffer
1230 @findex lpr-region
1231 @vindex lpr-switches
1232 The hardcopy commands (aside from the Postscript commands) pass extra
1233 switches to the @code{lpr} program based on the value of the variable
1234 @code{lpr-switches}. Its value should be a list of strings, each string
1235 an option starting with @samp{-}. For example, to specify a line width
1236 of 80 columns for all the printing you do in Emacs, set
1237 @code{lpr-switches} like this:
1238
1239 @example
1240 (setq lpr-switches '("-w80"))
1241 @end example
1242
1243 @vindex printer-name
1244 You can specify the printer to use by setting the variable
1245 @code{printer-name}.
1246
1247 @vindex lpr-headers-switches
1248 @vindex lpr-commands
1249 @vindex lpr-add-switches
1250 The variable @code{lpr-command} specifies the name of the printer
1251 program to run; the default value depends on your operating system type.
1252 On most systems, the default is @code{"lpr"}. The variable
1253 @code{lpr-headers-switches} similarly specifies the extra switches to
1254 use to make page headers. The variable @code{lpr-add-switches} controls
1255 whether to supply @samp{-T} and @samp{-J} options (suitable for
1256 @code{lpr}) to the printer program: @code{nil} means don't add them.
1257 @code{lpr-add-switches} should be @code{nil} if your printer program is
1258 not compatible with @code{lpr}.
1259
1260 @node PostScript, PostScript Variables, Hardcopy, Top
1261 @section PostScript Hardcopy
1262
1263 These commands convert buffer contents to PostScript,
1264 either printing it or leaving it in another Emacs buffer.
1265
1266 @table @kbd
1267 @item M-x ps-print-buffer
1268 Print hardcopy of the current buffer in PostScript form.
1269 @item M-x ps-print-region
1270 Print hardcopy of the current region in PostScript form.
1271 @item M-x ps-print-buffer-with-faces
1272 Print hardcopy of the current buffer in PostScript form, showing the
1273 faces used in the text by means of PostScript features.
1274 @item M-x ps-print-region-with-faces
1275 Print hardcopy of the current region in PostScript form, showing the
1276 faces used in the text.
1277 @item M-x ps-spool-buffer
1278 Generate PostScript for the current buffer text.
1279 @item M-x ps-spool-region
1280 Generate PostScript for the current region.
1281 @item M-x ps-spool-buffer-with-faces
1282 Generate PostScript for the current buffer, showing the faces used.
1283 @item M-x ps-spool-region-with-faces
1284 Generate PostScript for the current region, showing the faces used.
1285 @item M-x handwrite
1286 Generates/prints PostScript for the current buffer as if handwritten.
1287 @end table
1288
1289 @findex ps-print-region
1290 @findex ps-print-buffer
1291 @findex ps-print-region-with-faces
1292 @findex ps-print-buffer-with-faces
1293 The PostScript commands, @code{ps-print-buffer} and
1294 @code{ps-print-region}, print buffer contents in PostScript form. One
1295 command prints the entire buffer; the other, just the region. The
1296 corresponding @samp{-with-faces} commands,
1297 @code{ps-print-buffer-with-faces} and @code{ps-print-region-with-faces},
1298 use PostScript features to show the faces (fonts and colors) in the text
1299 properties of the text being printed.
1300
1301 If you are using a color display, you can print a buffer of program
1302 code with color highlighting by turning on Font-Lock mode in that
1303 buffer, and using @code{ps-print-buffer-with-faces}.
1304
1305 @findex ps-spool-region
1306 @findex ps-spool-buffer
1307 @findex ps-spool-region-with-faces
1308 @findex ps-spool-buffer-with-faces
1309 The commands whose names have @samp{spool} instead of @samp{print}
1310 generate the PostScript output in an Emacs buffer instead of sending
1311 it to the printer.
1312
1313 @findex handwrite
1314 @cindex handwriting
1315 @kbd{M-x handwrite} is more frivolous. It generates a PostScript
1316 rendition of the current buffer as a cursive handwritten document. It
1317 can be customized in group @code{handwrite}.
1318
1319 @ifinfo
1320 The following section describes variables for customizing these commands.
1321 @end ifinfo
1322
1323 @node PostScript Variables, Sorting, PostScript, Top
1324 @section Variables for PostScript Hardcopy
1325
1326 @vindex ps-lpr-command
1327 @vindex ps-lpr-switches
1328 @vindex ps-printer-name
1329 All the PostScript hardcopy commands use the variables
1330 @code{ps-lpr-command} and @code{ps-lpr-switches} to specify how to print
1331 the output. @code{ps-lpr-command} specifies the command name to run,
1332 @code{ps-lpr-switches} specifies command line options to use, and
1333 @code{ps-printer-name} specifies the printer. If you don't set the
1334 first two variables yourself, they take their initial values from
1335 @code{lpr-command} and @code{lpr-switches}. If @code{ps-printer-name}
1336 is @code{nil}, @code{printer-name} is used.
1337
1338 @vindex ps-print-header
1339 @vindex ps-print-color-p
1340 The variable @code{ps-print-header} controls whether these commands
1341 add header lines to each page---set it to @code{nil} to turn headers
1342 off. You can turn off color processing by setting
1343 @code{ps-print-color-p} to @code{nil}.
1344
1345 @vindex ps-paper-type
1346 @vindex ps-page-dimensions-database
1347 The variable @code{ps-paper-type} specifies which size of paper to
1348 format for; legitimate values include @code{a4}, @code{a3},
1349 @code{a4small}, @code{b4}, @code{b5}, @code{executive}, @code{ledger},
1350 @code{legal}, @code{letter}, @code{letter-small}, @code{statement},
1351 @code{tabloid}. The default is @code{letter}. You can define
1352 additional paper sizes by changing the variable
1353 @code{ps-page-dimensions-database}.
1354
1355 @vindex ps-landscape-mode
1356 The variable @code{ps-landscape-mode} specifies the orientation of
1357 printing on the page. The default is @code{nil}, which stands for
1358 ``portrait'' mode. Any non-@code{nil} value specifies ``landscape''
1359 mode.
1360
1361 @vindex ps-number-of-columns
1362 The variable @code{ps-number-of-columns} specifies the number of
1363 columns; it takes effect in both landscape and portrait mode. The
1364 default is 1.
1365
1366 @vindex ps-font-family
1367 @vindex ps-font-size
1368 @vindex ps-font-info-database
1369 The variable @code{ps-font-family} specifies which font family to use
1370 for printing ordinary text. Legitimate values include @code{Courier},
1371 @code{Helvetica}, @code{NewCenturySchlbk}, @code{Palatino} and
1372 @code{Times}. The variable @code{ps-font-size} specifies the size of
1373 the font for ordinary text. It defaults to 8.5 points.
1374
1375 Many other customization variables for these commands are defined and
1376 described in the Lisp file @file{ps-print.el}.
1377
1378 @node Sorting, Narrowing, PostScript Variables, Top
1379 @section Sorting Text
1380 @cindex sorting
1381
1382 Emacs provides several commands for sorting text in the buffer. All
1383 operate on the contents of the region (the text between point and the
1384 mark). They divide the text of the region into many @dfn{sort records},
1385 identify a @dfn{sort key} for each record, and then reorder the records
1386 into the order determined by the sort keys. The records are ordered so
1387 that their keys are in alphabetical order, or, for numeric sorting, in
1388 numeric order. In alphabetic sorting, all upper-case letters `A' through
1389 `Z' come before lower-case `a', in accord with the ASCII character
1390 sequence.
1391
1392 The various sort commands differ in how they divide the text into sort
1393 records and in which part of each record is used as the sort key. Most of
1394 the commands make each line a separate sort record, but some commands use
1395 paragraphs or pages as sort records. Most of the sort commands use each
1396 entire sort record as its own sort key, but some use only a portion of the
1397 record as the sort key.
1398
1399 @findex sort-lines
1400 @findex sort-paragraphs
1401 @findex sort-pages
1402 @findex sort-fields
1403 @findex sort-numeric-fields
1404 @table @kbd
1405 @item M-x sort-lines
1406 Divide the region into lines, and sort by comparing the entire
1407 text of a line. A numeric argument means sort into descending order.
1408
1409 @item M-x sort-paragraphs
1410 Divide the region into paragraphs, and sort by comparing the entire
1411 text of a paragraph (except for leading blank lines). A numeric
1412 argument means sort into descending order.
1413
1414 @item M-x sort-pages
1415 Divide the region into pages, and sort by comparing the entire
1416 text of a page (except for leading blank lines). A numeric
1417 argument means sort into descending order.
1418
1419 @item M-x sort-fields
1420 Divide the region into lines, and sort by comparing the contents of
1421 one field in each line. Fields are defined as separated by
1422 whitespace, so the first run of consecutive non-whitespace characters
1423 in a line constitutes field 1, the second such run constitutes field
1424 2, etc.
1425
1426 Specify which field to sort by with a numeric argument: 1 to sort by
1427 field 1, etc. A negative argument means count fields from the right
1428 instead of from the left; thus, minus 1 means sort by the last field.
1429 If several lines have identical contents in the field being sorted, they
1430 keep same relative order that they had in the original buffer.
1431
1432 @item M-x sort-numeric-fields
1433 Like @kbd{M-x sort-fields} except the specified field is converted
1434 to an integer for each line, and the numbers are compared. @samp{10}
1435 comes before @samp{2} when considered as text, but after it when
1436 considered as a number.
1437
1438 @item M-x sort-columns
1439 Like @kbd{M-x sort-fields} except that the text within each line
1440 used for comparison comes from a fixed range of columns. See below
1441 for an explanation.
1442
1443 @item M-x reverse-region
1444 Reverse the order of the lines in the region. This is useful for
1445 sorting into descending order by fields or columns, since those sort
1446 commands do not have a feature for doing that.
1447 @end table
1448
1449 For example, if the buffer contains this:
1450
1451 @smallexample
1452 On systems where clash detection (locking of files being edited) is
1453 implemented, Emacs also checks the first time you modify a buffer
1454 whether the file has changed on disk since it was last visited or
1455 saved. If it has, you are asked to confirm that you want to change
1456 the buffer.
1457 @end smallexample
1458
1459 @noindent
1460 applying @kbd{M-x sort-lines} to the entire buffer produces this:
1461
1462 @smallexample
1463 On systems where clash detection (locking of files being edited) is
1464 implemented, Emacs also checks the first time you modify a buffer
1465 saved. If it has, you are asked to confirm that you want to change
1466 the buffer.
1467 whether the file has changed on disk since it was last visited or
1468 @end smallexample
1469
1470 @noindent
1471 where the upper-case @samp{O} sorts before all lower-case letters. If
1472 you use @kbd{C-u 2 M-x sort-fields} instead, you get this:
1473
1474 @smallexample
1475 implemented, Emacs also checks the first time you modify a buffer
1476 saved. If it has, you are asked to confirm that you want to change
1477 the buffer.
1478 On systems where clash detection (locking of files being edited) is
1479 whether the file has changed on disk since it was last visited or
1480 @end smallexample
1481
1482 @noindent
1483 where the sort keys were @samp{Emacs}, @samp{If}, @samp{buffer},
1484 @samp{systems} and @samp{the}.
1485
1486 @findex sort-columns
1487 @kbd{M-x sort-columns} requires more explanation. You specify the
1488 columns by putting point at one of the columns and the mark at the other
1489 column. Because this means you cannot put point or the mark at the
1490 beginning of the first line of the text you want to sort, this command
1491 uses an unusual definition of `region': all of the line point is in is
1492 considered part of the region, and so is all of the line the mark is in,
1493 as well as all the lines in between.
1494
1495 For example, to sort a table by information found in columns 10 to 15,
1496 you could put the mark on column 10 in the first line of the table, and
1497 point on column 15 in the last line of the table, and then run
1498 @code{sort-columns}. Equivalently, you could run it with the mark on
1499 column 15 in the first line and point on column 10 in the last line.
1500
1501 This can be thought of as sorting the rectangle specified by point and
1502 the mark, except that the text on each line to the left or right of the
1503 rectangle moves along with the text inside the rectangle.
1504 @xref{Rectangles}.
1505
1506 @vindex sort-fold-case
1507 Many of the sort commands ignore case differences when comparing, if
1508 @code{sort-fold-case} is non-@code{nil}.
1509
1510 @node Narrowing, Two-Column, Sorting, Top
1511 @section Narrowing
1512 @cindex widening
1513 @cindex restriction
1514 @cindex narrowing
1515 @cindex accessible portion
1516
1517 @dfn{Narrowing} means focusing in on some portion of the buffer,
1518 making the rest temporarily inaccessible. The portion which you can
1519 still get to is called the @dfn{accessible portion}. Canceling the
1520 narrowing, which makes the entire buffer once again accessible, is
1521 called @dfn{widening}. The amount of narrowing in effect in a buffer at
1522 any time is called the buffer's @dfn{restriction}.
1523
1524 Narrowing can make it easier to concentrate on a single subroutine or
1525 paragraph by eliminating clutter. It can also be used to restrict the
1526 range of operation of a replace command or repeating keyboard macro.
1527
1528 @c WideCommands
1529 @table @kbd
1530 @item C-x n n
1531 Narrow down to between point and mark (@code{narrow-to-region}).
1532 @item C-x n w
1533 Widen to make the entire buffer accessible again (@code{widen}).
1534 @item C-x n p
1535 Narrow down to the current page (@code{narrow-to-page}).
1536 @item C-x n d
1537 Narrow down to the current defun (@code{narrow-to-defun}).
1538 @end table
1539
1540 When you have narrowed down to a part of the buffer, that part appears
1541 to be all there is. You can't see the rest, you can't move into it
1542 (motion commands won't go outside the accessible part), you can't change
1543 it in any way. However, it is not gone, and if you save the file all
1544 the inaccessible text will be saved. The word @samp{Narrow} appears in
1545 the mode line whenever narrowing is in effect.
1546
1547 @kindex C-x n n
1548 @findex narrow-to-region
1549 The primary narrowing command is @kbd{C-x n n} (@code{narrow-to-region}).
1550 It sets the current buffer's restrictions so that the text in the current
1551 region remains accessible but all text before the region or after the region
1552 is inaccessible. Point and mark do not change.
1553
1554 @kindex C-x n p
1555 @findex narrow-to-page
1556 @kindex C-x n d
1557 @findex narrow-to-defun
1558 Alternatively, use @kbd{C-x n p} (@code{narrow-to-page}) to narrow
1559 down to the current page. @xref{Pages}, for the definition of a page.
1560 @kbd{C-x n d} (@code{narrow-to-defun}) narrows down to the defun
1561 containing point (@pxref{Defuns}).
1562
1563 @kindex C-x n w
1564 @findex widen
1565 The way to cancel narrowing is to widen with @kbd{C-x n w}
1566 (@code{widen}). This makes all text in the buffer accessible again.
1567
1568 You can get information on what part of the buffer you are narrowed down
1569 to using the @kbd{C-x =} command. @xref{Position Info}.
1570
1571 Because narrowing can easily confuse users who do not understand it,
1572 @code{narrow-to-region} is normally a disabled command. Attempting to use
1573 this command asks for confirmation and gives you the option of enabling it;
1574 if you enable the command, confirmation will no longer be required for
1575 it. @xref{Disabling}.
1576
1577 @node Two-Column, Editing Binary Files, Narrowing, Top
1578 @section Two-Column Editing
1579 @cindex two-column editing
1580 @cindex splitting columns
1581 @cindex columns, splitting
1582
1583 Two-column mode lets you conveniently edit two side-by-side columns of
1584 text. It uses two side-by-side windows, each showing its own
1585 buffer.
1586
1587 There are three ways to enter two-column mode:
1588
1589 @table @asis
1590 @item @kbd{@key{F2} 2} or @kbd{C-x 6 2}
1591 @kindex F2 2
1592 @kindex C-x 6 2
1593 @findex 2C-two-columns
1594 Enter two-column mode with the current buffer on the left, and on the
1595 right, a buffer whose name is based on the current buffer's name
1596 (@code{2C-two-columns}). If the right-hand buffer doesn't already
1597 exist, it starts out empty; the current buffer's contents are not
1598 changed.
1599
1600 This command is appropriate when the current buffer is empty or contains
1601 just one column and you want to add another column.
1602
1603 @item @kbd{@key{F2} s} or @kbd{C-x 6 s}
1604 @kindex F2 s
1605 @kindex C-x 6 s
1606 @findex 2C-split
1607 Split the current buffer, which contains two-column text, into two
1608 buffers, and display them side by side (@code{2C-split}). The current
1609 buffer becomes the left-hand buffer, but the text in the right-hand
1610 column is moved into the right-hand buffer. The current column
1611 specifies the split point. Splitting starts with the current line and
1612 continues to the end of the buffer.
1613
1614 This command is appropriate when you have a buffer that already contains
1615 two-column text, and you wish to separate the columns temporarily.
1616
1617 @item @kbd{@key{F2} b @var{buffer} @key{RET}}
1618 @itemx @kbd{C-x 6 b @var{buffer} @key{RET}}
1619 @kindex F2 b
1620 @kindex C-x 6 b
1621 @findex 2C-associate-buffer
1622 Enter two-column mode using the current buffer as the left-hand buffer,
1623 and using buffer @var{buffer} as the right-hand buffer
1624 (@code{2C-associate-buffer}).
1625 @end table
1626
1627 @kbd{@key{F2} s} or @kbd{C-x 6 s} looks for a column separator, which
1628 is a string that appears on each line between the two columns. You can
1629 specify the width of the separator with a numeric argument to
1630 @kbd{@key{F2} s}; that many characters, before point, constitute the
1631 separator string. By default, the width is 1, so the column separator
1632 is the character before point.
1633
1634 When a line has the separator at the proper place, @kbd{@key{F2} s}
1635 puts the text after the separator into the right-hand buffer, and
1636 deletes the separator. Lines that don't have the column separator at
1637 the proper place remain unsplit; they stay in the left-hand buffer, and
1638 the right-hand buffer gets an empty line to correspond. (This is the
1639 way to write a line that ``spans both columns while in two-column
1640 mode'': write it in the left-hand buffer, and put an empty line in the
1641 right-hand buffer.)
1642
1643 @kindex F2 RET
1644 @kindex C-x 6 RET
1645 @findex 2C-newline
1646 The command @kbd{C-x 6 @key{RET}} or @kbd{@key{F2} @key{RET}}
1647 (@code{2C-newline}) inserts a newline in each of the two buffers at
1648 corresponding positions. This is the easiest way to add a new line to
1649 the two-column text while editing it in split buffers.
1650
1651 @kindex F2 1
1652 @kindex C-x 6 1
1653 @findex 2C-merge
1654 When you have edited both buffers as you wish, merge them with
1655 @kbd{@key{F2} 1} or @kbd{C-x 6 1} (@code{2C-merge}). This copies the
1656 text from the right-hand buffer as a second column in the other buffer.
1657 To go back to two-column editing, use @kbd{@key{F2} s}.
1658
1659 @kindex F2 d
1660 @kindex C-x 6 d
1661 @findex 2C-dissociate
1662 Use @kbd{@key{F2} d} or @kbd{C-x 6 d} to dissociate the two buffers,
1663 leaving each as it stands (@code{2C-dissociate}). If the other buffer,
1664 the one not current when you type @kbd{@key{F2} d}, is empty,
1665 @kbd{@key{F2} d} kills it.
1666
1667 @node Editing Binary Files, Saving Emacs Sessions, Two-Column, Top
1668 @section Editing Binary Files
1669
1670 @cindex Hexl mode
1671 @cindex mode, Hexl
1672 @cindex editing binary files
1673 There is a special major mode for editing binary files: Hexl mode. To
1674 use it, use @kbd{M-x hexl-find-file} instead of @kbd{C-x C-f} to visit
1675 the file. This command converts the file's contents to hexadecimal and
1676 lets you edit the translation. When you save the file, it is converted
1677 automatically back to binary.
1678
1679 You can also use @kbd{M-x hexl-mode} to translate an existing buffer
1680 into hex. This is useful if you visit a file normally and then discover
1681 it is a binary file.
1682
1683 Ordinary text characters overwrite in Hexl mode. This is to reduce
1684 the risk of accidentally spoiling the alignment of data in the file.
1685 There are special commands for insertion. Here is a list of the
1686 commands of Hexl mode:
1687
1688 @c I don't think individual index entries for these commands are useful--RMS.
1689 @table @kbd
1690 @item C-M-d
1691 Insert a byte with a code typed in decimal.
1692
1693 @item C-M-o
1694 Insert a byte with a code typed in octal.
1695
1696 @item C-M-x
1697 Insert a byte with a code typed in hex.
1698
1699 @item C-x [
1700 Move to the beginning of a 1k-byte ``page.''
1701
1702 @item C-x ]
1703 Move to the end of a 1k-byte ``page.''
1704
1705 @item M-g
1706 Move to an address specified in hex.
1707
1708 @item M-j
1709 Move to an address specified in decimal.
1710
1711 @item C-c C-c
1712 Leave Hexl mode, going back to the major mode this buffer had before you
1713 invoked @code{hexl-mode}.
1714 @end table
1715
1716 @node Saving Emacs Sessions, Recursive Edit, Editing Binary Files, Top
1717 @section Saving Emacs Sessions
1718 @cindex saving sessions
1719 @cindex desktop
1720
1721 You can use the Desktop library to save the state of Emacs from one
1722 session to another. Saving the state means that Emacs starts up with
1723 the same set of buffers, major modes, buffer positions, and so on that
1724 the previous Emacs session had.
1725
1726 @vindex desktop-enable
1727 To use Desktop, you should use the Customization buffer (@pxref{Easy
1728 Customization}) to set @code{desktop-enable} to a non-@code{nil} value,
1729 or add these lines at the end of your @file{.emacs} file:
1730
1731 @example
1732 (desktop-load-default)
1733 (desktop-read)
1734 @end example
1735
1736 @noindent
1737 @findex desktop-save
1738 The first time you save the state of the Emacs session, you must do it
1739 manually, with the command @kbd{M-x desktop-save}. Once you have done
1740 that, exiting Emacs will save the state again---not only the present
1741 Emacs session, but also subsequent sessions. You can also save the
1742 state at any time, without exiting Emacs, by typing @kbd{M-x
1743 desktop-save} again.
1744
1745 In order for Emacs to recover the state from a previous session, you
1746 must start it with the same current directory as you used when you
1747 started the previous session. This is because @code{desktop-read} looks
1748 in the current directory for the file to read. This means that you can
1749 have separate saved sessions in different directories; the directory in
1750 which you start Emacs will control which saved session to use.
1751
1752 @vindex desktop-files-not-to-save
1753 The variable @code{desktop-files-not-to-save} controls which files are
1754 excluded from state saving. Its value is a regular expression that
1755 matches the files to exclude. By default, remote (ftp-accessed) files
1756 are excluded; this is because visiting them again in the subsequent
1757 session would be slow. If you want to include these files in state
1758 saving, set @code{desktop-files-not-to-save} to @code{"^$"}.
1759 @xref{Remote Files}.
1760
1761 @node Recursive Edit, Emulation, Saving Emacs Sessions, Top
1762 @section Recursive Editing Levels
1763 @cindex recursive editing level
1764 @cindex editing level, recursive
1765
1766 A @dfn{recursive edit} is a situation in which you are using Emacs
1767 commands to perform arbitrary editing while in the middle of another
1768 Emacs command. For example, when you type @kbd{C-r} inside of a
1769 @code{query-replace}, you enter a recursive edit in which you can change
1770 the current buffer. On exiting from the recursive edit, you go back to
1771 the @code{query-replace}.
1772
1773 @kindex C-M-c
1774 @findex exit-recursive-edit
1775 @cindex exiting recursive edit
1776 @dfn{Exiting} the recursive edit means returning to the unfinished
1777 command, which continues execution. The command to exit is @kbd{C-M-c}
1778 (@code{exit-recursive-edit}).
1779
1780 You can also @dfn{abort} the recursive edit. This is like exiting,
1781 but also quits the unfinished command immediately. Use the command
1782 @kbd{C-]} (@code{abort-recursive-edit}) to do this. @xref{Quitting}.
1783
1784 The mode line shows you when you are in a recursive edit by displaying
1785 square brackets around the parentheses that always surround the major and
1786 minor mode names. Every window's mode line shows this, in the same way,
1787 since being in a recursive edit is true of Emacs as a whole rather than
1788 any particular window or buffer.
1789
1790 It is possible to be in recursive edits within recursive edits. For
1791 example, after typing @kbd{C-r} in a @code{query-replace}, you may type a
1792 command that enters the debugger. This begins a recursive editing level
1793 for the debugger, within the recursive editing level for @kbd{C-r}.
1794 Mode lines display a pair of square brackets for each recursive editing
1795 level currently in progress.
1796
1797 Exiting the inner recursive edit (such as, with the debugger @kbd{c}
1798 command) resumes the command running in the next level up. When that
1799 command finishes, you can then use @kbd{C-M-c} to exit another recursive
1800 editing level, and so on. Exiting applies to the innermost level only.
1801 Aborting also gets out of only one level of recursive edit; it returns
1802 immediately to the command level of the previous recursive edit. If you
1803 wish, you can then abort the next recursive editing level.
1804
1805 Alternatively, the command @kbd{M-x top-level} aborts all levels of
1806 recursive edits, returning immediately to the top-level command reader.
1807
1808 The text being edited inside the recursive edit need not be the same text
1809 that you were editing at top level. It depends on what the recursive edit
1810 is for. If the command that invokes the recursive edit selects a different
1811 buffer first, that is the buffer you will edit recursively. In any case,
1812 you can switch buffers within the recursive edit in the normal manner (as
1813 long as the buffer-switching keys have not been rebound). You could
1814 probably do all the rest of your editing inside the recursive edit,
1815 visiting files and all. But this could have surprising effects (such as
1816 stack overflow) from time to time. So remember to exit or abort the
1817 recursive edit when you no longer need it.
1818
1819 In general, we try to minimize the use of recursive editing levels in
1820 GNU Emacs. This is because they constrain you to ``go back'' in a
1821 particular order---from the innermost level toward the top level. When
1822 possible, we present different activities in separate buffers so that
1823 you can switch between them as you please. Some commands switch to a
1824 new major mode which provides a command to switch back. These
1825 approaches give you more flexibility to go back to unfinished tasks in
1826 the order you choose.
1827
1828 @node Emulation, Dissociated Press, Recursive Edit, Top
1829 @section Emulation
1830 @cindex emulating other editors
1831 @cindex other editors
1832 @cindex EDT
1833 @cindex vi
1834 @cindex CRiSP
1835 @cindex Brief
1836 @cindex PC keybindings
1837 @cindex scrolling all windows
1838 @cindex PC selecion
1839 @cindex Motif keybindings
1840 @cindex Macintosh keybindings
1841 @cindex WordStar
1842
1843 GNU Emacs can be programmed to emulate (more or less) most other
1844 editors. Standard facilities can emulate these:
1845
1846 @table @asis
1847 @item CRiSP/Brief (PC editor)
1848 @findex crisp-mode
1849 @vindex crisp-override-meta-x
1850 @findex scroll-all-mode
1851 Turn on keybindings to emulate the CRiSP/Brief editor with @kbd{M-x
1852 crisp-mode}. Note that this rebinds @kbd{M-x} to exit Emacs unless you
1853 change the user option @code{crisp-override-meta-x}. You can also load
1854 the @code{scroll-all} package to emulate CRiSP's scroll-all feature
1855 (scrolling all windows together). Do thsi either with @kbd{M-x
1856 scroll-all-mode} or set the user option @code{crisp-load-scroll-all} to
1857 load it along with @code{crisp-mode}.
1858
1859 @item EDT (DEC VMS editor)
1860 @findex edt-emulation-on
1861 @findex edt-emulation-off
1862 Turn on EDT emulation with @kbd{M-x edt-emulation-on}. @kbd{M-x
1863 edt-emulation-off} restores normal Emacs command bindings.
1864
1865 Most of the EDT emulation commands are keypad keys, and most standard
1866 Emacs key bindings are still available. The EDT emulation rebindings
1867 are done in the global keymap, so there is no problem switching
1868 buffers or major modes while in EDT emulation.
1869
1870 @item `PC' bindings
1871 @findex pc-bindings-mode
1872 @kbd{M-x pc-bindings-mode} sets up certain key bindings for `PC
1873 compatibility'---what people are often used to on PCs---as follows:
1874 @kbd{Delete} and its variants) delete forward instead of backward,
1875 @kbd{C-Backspace} kills backward a word (as @kbd{C-Delete} normally
1876 would), @kbd{M-Backspace} does undo, @kbd{Home} and @kbd{End} move to
1877 beginning and end of line, @kbd{C-Home} and @kbd{C-End} move to
1878 beginning and end of buffer and @kbd{C-Escape} does @code{list-buffers}.
1879
1880 @item PC selection mode
1881 @findex pc-selection-mode
1882 @kbd{M-x pc-selction-mode} emulates the mark, copy, cut and paste
1883 look-and-feel of Motif programs (which is the same as the Macintosh GUI
1884 and MS-Windows). It makes the keybindings of PC mode and also modifies
1885 the bindings of the cursor keys and the @kbd{next}, @kbd{prior},
1886 @kbd{home} and @kbd{end} keys. It does not provide the full set of CUA
1887 keybindings---the fundamental Emacs keys @kbd{C-c}, @kbd{C-v} and
1888 @kbd{C-x} are not rebound.
1889
1890 The standard keys for moving around (@kbd{right}, @kbd{left}, @kbd{up},
1891 @kbd{down}, @kbd{home}, @kbd{end}, @kbd{prior}, @kbd{next}, called
1892 ``move-keys'') will always de-activate the mark. Using @kbd{Shift}
1893 together with the ``move keys'' activates the region over which they
1894 move. The copy, cut and paste functions (as in many other programs)
1895 operate on the active region, bound to @kbd{C-insert}, @kbd{S-delete}
1896 and @kbd{S-insert} respectively.
1897
1898 The @code{s-region} package provides similar, but less complete,
1899 facilities.
1900
1901 @item vi (Berkeley editor)
1902 @findex viper-mode
1903 Viper is the newest emulator for vi. It implements several levels of
1904 emulation; level 1 is closest to vi itself, while level 5 departs
1905 somewhat from strict emulation to take advantage of the capabilities of
1906 Emacs. To invoke Viper, type @kbd{M-x viper-mode}; it will guide you
1907 the rest of the way and ask for the emulation level. @inforef{Top,
1908 Viper, viper}.
1909
1910 @item vi (another emulator)
1911 @findex vi-mode
1912 @kbd{M-x vi-mode} enters a major mode that replaces the previously
1913 established major mode. All of the vi commands that, in real vi, enter
1914 ``input'' mode are programmed instead to return to the previous major
1915 mode. Thus, ordinary Emacs serves as vi's ``input'' mode.
1916
1917 Because vi emulation works through major modes, it does not work
1918 to switch buffers during emulation. Return to normal Emacs first.
1919
1920 If you plan to use vi emulation much, you probably want to bind a key
1921 to the @code{vi-mode} command.
1922
1923 @item vi (alternate emulator)
1924 @findex vip-mode
1925 @kbd{M-x vip-mode} invokes another vi emulator, said to resemble real vi
1926 more thoroughly than @kbd{M-x vi-mode}. ``Input'' mode in this emulator
1927 is changed from ordinary Emacs so you can use @key{ESC} to go back to
1928 emulated vi command mode. To get from emulated vi command mode back to
1929 ordinary Emacs, type @kbd{C-z}.
1930
1931 This emulation does not work through major modes, and it is possible
1932 to switch buffers in various ways within the emulator. It is not
1933 so necessary to assign a key to the command @code{vip-mode} as
1934 it is with @code{vi-mode} because terminating insert mode does
1935 not use it.
1936
1937 @inforef{Top, VIP, vip}, for full information.
1938
1939 @item WordStar (old wordprocessor)
1940 @findex wordstar-mode
1941 @kbd{M-x wordstar-mode} provides a major mode with WordStar-like
1942 keybindings.
1943 @end table
1944
1945 @node Dissociated Press, Amusements, Emulation, Top
1946 @section Dissociated Press
1947
1948 @findex dissociated-press
1949 @kbd{M-x dissociated-press} is a command for scrambling a file of text
1950 either word by word or character by character. Starting from a buffer of
1951 straight English, it produces extremely amusing output. The input comes
1952 from the current Emacs buffer. Dissociated Press writes its output in a
1953 buffer named @samp{*Dissociation*}, and redisplays that buffer after every
1954 couple of lines (approximately) so you can read the output as it comes out.
1955
1956 Dissociated Press asks every so often whether to continue generating
1957 output. Answer @kbd{n} to stop it. You can also stop at any time by
1958 typing @kbd{C-g}. The dissociation output remains in the
1959 @samp{*Dissociation*} buffer for you to copy elsewhere if you wish.
1960
1961 @cindex presidentagon
1962 Dissociated Press operates by jumping at random from one point in the
1963 buffer to another. In order to produce plausible output rather than
1964 gibberish, it insists on a certain amount of overlap between the end of
1965 one run of consecutive words or characters and the start of the next.
1966 That is, if it has just printed out `president' and then decides to jump
1967 to a different point in the file, it might spot the `ent' in `pentagon'
1968 and continue from there, producing `presidentagon'.@footnote{This
1969 dissociword actually appeared during the Vietnam War, when it was very
1970 appropriate.} Long sample texts produce the best results.
1971
1972 @cindex againformation
1973 A positive argument to @kbd{M-x dissociated-press} tells it to operate
1974 character by character, and specifies the number of overlap characters. A
1975 negative argument tells it to operate word by word and specifies the number
1976 of overlap words. In this mode, whole words are treated as the elements to
1977 be permuted, rather than characters. No argument is equivalent to an
1978 argument of two. For your againformation, the output goes only into the
1979 buffer @samp{*Dissociation*}. The buffer you start with is not changed.
1980
1981 @cindex Markov chain
1982 @cindex ignoriginal
1983 @cindex techniquitous
1984 Dissociated Press produces nearly the same results as a Markov chain
1985 based on a frequency table constructed from the sample text. It is,
1986 however, an independent, ignoriginal invention. Dissociated Press
1987 techniquitously copies several consecutive characters from the sample
1988 between random choices, whereas a Markov chain would choose randomly for
1989 each word or character. This makes for more plausible sounding results,
1990 and runs faster.
1991
1992 @cindex outragedy
1993 @cindex buggestion
1994 @cindex properbose
1995 @cindex mustatement
1996 @cindex developediment
1997 @cindex userenced
1998 It is a mustatement that too much use of Dissociated Press can be a
1999 developediment to your real work. Sometimes to the point of outragedy.
2000 And keep dissociwords out of your documentation, if you want it to be well
2001 userenced and properbose. Have fun. Your buggestions are welcome.
2002
2003 @node Amusements, Customization, Dissociated Press, Top
2004 @section Other Amusements
2005 @cindex boredom
2006 @findex hanoi
2007 @findex yow
2008 @findex gomoku
2009 @cindex tower of Hanoi
2010
2011 If you are a little bit bored, you can try @kbd{M-x hanoi}. If you are
2012 considerably bored, give it a numeric argument. If you are very very
2013 bored, try an argument of 9. Sit back and watch.
2014
2015 @cindex Go Moku
2016 If you want a little more personal involvement, try @kbd{M-x gomoku},
2017 which plays the game Go Moku with you.
2018
2019 @findex blackbox
2020 @findex mpuz
2021 @findex 5x5
2022 @cindex puzzles
2023 @kbd{M-x blackbox}, @kbd{M-x mpuz} and @kbd{M-x 5x5} are kinds of puzzles.
2024 @code{blackbox} challenges you to determine the location of objects
2025 inside a box by tomography. @code{mpuz} displays a multiplication
2026 puzzle with letters standing for digits in a code that you must
2027 guess---to guess a value, type a letter and then the digit you think it
2028 stands for. The aim of @code{5x5} is to fill in all the squares.
2029
2030 @findex dunnet
2031 @kbd{M-x dunnet} runs an adventure-style exploration game, which is
2032 a bigger sort of puzzle.
2033
2034 @findex lm
2035 @cindex landmark game
2036 @kbd{M-x lm} runs a relatively non-participatory game in which a robot
2037 attempts to maneuver towards a tree at the center of the window based on
2038 unique olfactory cues from each of the four directions.
2039
2040 @findex life
2041 @cindex Life
2042 @kbd{M-x life} runs Conway's `Life' cellular automaton.
2043
2044 @findex solitaire
2045 @cindex solitaire
2046 @kbd{M-x solitaire} plays a game of solitaire in which you jump pegs
2047 across other pegs.
2048
2049 @findex tetris
2050 @cindex Tetris
2051 @kbd{M-x tetris} runs an implementation of the well-known Tetris game.
2052 @findex snake
2053 @cindex Snake
2054 Likewise, @kbd{M-x snake} provides an implementation of Snake.
2055
2056 When you are frustrated, try the famous Eliza program. Just do
2057 @kbd{M-x doctor}. End each input by typing @key{RET} twice.
2058
2059 @cindex Zippy
2060 When you are feeling strange, type @kbd{M-x yow}.