annotate man/misc.texi @ 82366:30d1e922e79c

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