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