annotate man/misc.texi @ 46638:b41d86e98fdd

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