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