annotate man/misc.texi @ 28285:c54d62415e91

Changed the type of parameter passed to the function defined by `quickurl-format-function'. Before only the text of the URL was passed. Now the whole URL structure is passed and the function is responsible for extracting the parts it requires. Changed the default of `quickurl-format-function' accordingly. (quickurl-insert): Changed the `funcall' of `quickurl-format-function' to match the above change. (quickurl-list-insert): Changed the `url' case so that it makes use of `quickurl-format-function', previous to this the format was hard wired.
author Gerd Moellmann <gerd@gnu.org>
date Thu, 23 Mar 2000 13:53:14 +0000
parents b1d15e69d22c
children fe21629219ef
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.
28125
b1d15e69d22c Typo, copyright fix.
Dave Love <fx@gnu.org>
parents: 27469
diff changeset
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000
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
Dave Love <fx@gnu.org>
parents:
diff changeset
97 Reading news is a two step process:
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
Dave Love <fx@gnu.org>
parents:
diff changeset
309 processes; it can also run a shell interactively with input and output to
Dave Love <fx@gnu.org>
parents:
diff changeset
310 an Emacs buffer named @samp{*shell*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
311
Dave Love <fx@gnu.org>
parents:
diff changeset
312 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
313 @item M-! @var{cmd} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
314 Run the shell command line @var{cmd} and display the output
Dave Love <fx@gnu.org>
parents:
diff changeset
315 (@code{shell-command}).
Dave Love <fx@gnu.org>
parents:
diff changeset
316 @item M-| @var{cmd} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
317 Run the shell command line @var{cmd} with region contents as input;
Dave Love <fx@gnu.org>
parents:
diff changeset
318 optionally replace the region with the output
Dave Love <fx@gnu.org>
parents:
diff changeset
319 (@code{shell-command-on-region}).
Dave Love <fx@gnu.org>
parents:
diff changeset
320 @item M-x shell
Dave Love <fx@gnu.org>
parents:
diff changeset
321 Run a subshell with input and output through an Emacs buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
322 You can then give commands interactively.
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
323 @item M-x term
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
324 Run a subshell with input and output through an Emacs buffer.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
325 You can then give commands interactively.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
326 Full terminal emulation is available.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
327 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
328
Dave Love <fx@gnu.org>
parents:
diff changeset
329 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
330 * Single Shell:: How to run one shell command and return.
Dave Love <fx@gnu.org>
parents:
diff changeset
331 * Interactive Shell:: Permanent shell taking input via Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
332 * Shell Mode:: Special Emacs commands used with permanent shell.
Dave Love <fx@gnu.org>
parents:
diff changeset
333 * History: Shell History. Repeating previous commands in a shell buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
334 * Options: Shell Options. Options for customizing Shell mode.
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
335 * Terminal emulator:: An Emacs window as a terminal emulator.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
336 * Term Mode:: Special Emacs commands used in Term mode.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
337 * Paging in Term:: Paging in the terminal emulator.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
338 * Remote Host:: Connecting to another computer.
Dave Love <fx@gnu.org>
parents:
diff changeset
339 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
340
Dave Love <fx@gnu.org>
parents:
diff changeset
341 @node Single Shell
Dave Love <fx@gnu.org>
parents:
diff changeset
342 @subsection Single Shell Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
343
Dave Love <fx@gnu.org>
parents:
diff changeset
344 @kindex M-!
Dave Love <fx@gnu.org>
parents:
diff changeset
345 @findex shell-command
Dave Love <fx@gnu.org>
parents:
diff changeset
346 @kbd{M-!} (@code{shell-command}) reads a line of text using the
Dave Love <fx@gnu.org>
parents:
diff changeset
347 minibuffer and executes it as a shell command in a subshell made just
Dave Love <fx@gnu.org>
parents:
diff changeset
348 for that command. Standard input for the command comes from the null
Dave Love <fx@gnu.org>
parents:
diff changeset
349 device. If the shell command produces any output, the output goes into
Dave Love <fx@gnu.org>
parents:
diff changeset
350 an Emacs buffer named @samp{*Shell Command Output*}, which is displayed
Dave Love <fx@gnu.org>
parents:
diff changeset
351 in another window but not selected. A numeric argument, as in @kbd{M-1
Dave Love <fx@gnu.org>
parents:
diff changeset
352 M-!}, directs this command to insert any output into the current buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
353 In that case, point is left before the output and the mark is set after
Dave Love <fx@gnu.org>
parents:
diff changeset
354 the output.
Dave Love <fx@gnu.org>
parents:
diff changeset
355
Dave Love <fx@gnu.org>
parents:
diff changeset
356 If the shell command line ends in @samp{&}, it runs asynchronously.
Dave Love <fx@gnu.org>
parents:
diff changeset
357 For a synchronous shell command, @code{shell-command} returns the
Dave Love <fx@gnu.org>
parents:
diff changeset
358 command's exit status (0 means success), when it is called from a Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
359 program.
Dave Love <fx@gnu.org>
parents:
diff changeset
360
Dave Love <fx@gnu.org>
parents:
diff changeset
361 @kindex M-|
Dave Love <fx@gnu.org>
parents:
diff changeset
362 @findex shell-command-on-region
Dave Love <fx@gnu.org>
parents:
diff changeset
363 @kbd{M-|} (@code{shell-command-on-region}) is like @kbd{M-!} but
Dave Love <fx@gnu.org>
parents:
diff changeset
364 passes the contents of the region as the standard input to the shell
Dave Love <fx@gnu.org>
parents:
diff changeset
365 command, instead of no input. If a numeric argument is used, meaning
Dave Love <fx@gnu.org>
parents:
diff changeset
366 insert the output in the current buffer, then the old region is deleted
Dave Love <fx@gnu.org>
parents:
diff changeset
367 first and the output replaces it as the contents of the region. It
Dave Love <fx@gnu.org>
parents:
diff changeset
368 returns the command's exit status when it is called from a Lisp program.
Dave Love <fx@gnu.org>
parents:
diff changeset
369
Dave Love <fx@gnu.org>
parents:
diff changeset
370 @vindex shell-file-name
Dave Love <fx@gnu.org>
parents:
diff changeset
371 @cindex environment
Dave Love <fx@gnu.org>
parents:
diff changeset
372 Both @kbd{M-!} and @kbd{M-|} use @code{shell-file-name} to specify the
Dave Love <fx@gnu.org>
parents:
diff changeset
373 shell to use. This variable is initialized based on your @code{SHELL}
Dave Love <fx@gnu.org>
parents:
diff changeset
374 environment variable when Emacs is started. If the file name does not
Dave Love <fx@gnu.org>
parents:
diff changeset
375 specify a directory, the directories in the list @code{exec-path} are
Dave Love <fx@gnu.org>
parents:
diff changeset
376 searched; this list is initialized based on the environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
377 @code{PATH} when Emacs is started. Your @file{.emacs} file can override
Dave Love <fx@gnu.org>
parents:
diff changeset
378 either or both of these default initializations.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
379
Dave Love <fx@gnu.org>
parents:
diff changeset
380 Both @kbd{M-!} and @kbd{M-|} wait for the shell command to complete.
Dave Love <fx@gnu.org>
parents:
diff changeset
381 To stop waiting, type @kbd{C-g} to quit; that terminates the shell
Dave Love <fx@gnu.org>
parents:
diff changeset
382 command with the signal @code{SIGINT}---the same signal that @kbd{C-c}
Dave Love <fx@gnu.org>
parents:
diff changeset
383 normally generates in the shell. Emacs waits until the command actually
Dave Love <fx@gnu.org>
parents:
diff changeset
384 terminates. If the shell command doesn't stop (because it ignores the
Dave Love <fx@gnu.org>
parents:
diff changeset
385 @code{SIGINT} signal), type @kbd{C-g} again; this sends the command a
Dave Love <fx@gnu.org>
parents:
diff changeset
386 @code{SIGKILL} signal which is impossible to ignore.
Dave Love <fx@gnu.org>
parents:
diff changeset
387
Dave Love <fx@gnu.org>
parents:
diff changeset
388 To specify a coding system for @kbd{M-!} or @kbd{M-|}, use the command
Dave Love <fx@gnu.org>
parents:
diff changeset
389 @kbd{C-x @key{RET} c} immediately beforehand. @xref{Specify Coding}.
Dave Love <fx@gnu.org>
parents:
diff changeset
390
Dave Love <fx@gnu.org>
parents:
diff changeset
391 @vindex shell-command-default-error-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
392 Error output from the command is normally intermixed with the regular
Dave Love <fx@gnu.org>
parents:
diff changeset
393 output. If you set the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
394 @code{shell-command-default-error-buffer} to a string, which is a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
395 name, error output is inserted before point in the buffer of that name.
Dave Love <fx@gnu.org>
parents:
diff changeset
396
Dave Love <fx@gnu.org>
parents:
diff changeset
397 @node Interactive Shell
Dave Love <fx@gnu.org>
parents:
diff changeset
398 @subsection Interactive Inferior Shell
Dave Love <fx@gnu.org>
parents:
diff changeset
399
Dave Love <fx@gnu.org>
parents:
diff changeset
400 @findex shell
Dave Love <fx@gnu.org>
parents:
diff changeset
401 To run a subshell interactively, putting its typescript in an Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
402 buffer, use @kbd{M-x shell}. This creates (or reuses) a buffer named
Dave Love <fx@gnu.org>
parents:
diff changeset
403 @samp{*shell*} and runs a subshell with input coming from and output going
Dave Love <fx@gnu.org>
parents:
diff changeset
404 to that buffer. That is to say, any ``terminal output'' from the subshell
Dave Love <fx@gnu.org>
parents:
diff changeset
405 goes into the buffer, advancing point, and any ``terminal input'' for
Dave Love <fx@gnu.org>
parents:
diff changeset
406 the subshell comes from text in the buffer. To give input to the subshell,
Dave Love <fx@gnu.org>
parents:
diff changeset
407 go to the end of the buffer and type the input, terminated by @key{RET}.
Dave Love <fx@gnu.org>
parents:
diff changeset
408
Dave Love <fx@gnu.org>
parents:
diff changeset
409 Emacs does not wait for the subshell to do anything. You can switch
Dave Love <fx@gnu.org>
parents:
diff changeset
410 windows or buffers and edit them while the shell is waiting, or while it is
Dave Love <fx@gnu.org>
parents:
diff changeset
411 running a command. Output from the subshell waits until Emacs has time to
Dave Love <fx@gnu.org>
parents:
diff changeset
412 process it; this happens whenever Emacs is waiting for keyboard input or
Dave Love <fx@gnu.org>
parents:
diff changeset
413 for time to elapse.
Dave Love <fx@gnu.org>
parents:
diff changeset
414
Dave Love <fx@gnu.org>
parents:
diff changeset
415 To make multiple subshells, rename the buffer @samp{*shell*} to
Dave Love <fx@gnu.org>
parents:
diff changeset
416 something different using @kbd{M-x rename-uniquely}. Then type @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
417 shell} again to create a new buffer @samp{*shell*} with its own
Dave Love <fx@gnu.org>
parents:
diff changeset
418 subshell. If you rename this buffer as well, you can create a third
Dave Love <fx@gnu.org>
parents:
diff changeset
419 one, and so on. All the subshells run independently and in parallel.
Dave Love <fx@gnu.org>
parents:
diff changeset
420
Dave Love <fx@gnu.org>
parents:
diff changeset
421 @vindex explicit-shell-file-name
Dave Love <fx@gnu.org>
parents:
diff changeset
422 @cindex @code{ESHELL} environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
423 @cindex @code{SHELL} environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
424 The file name used to load the subshell is the value of the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
425 @code{explicit-shell-file-name}, if that is non-@code{nil}. Otherwise,
Dave Love <fx@gnu.org>
parents:
diff changeset
426 the environment variable @code{ESHELL} is used, or the environment
Dave Love <fx@gnu.org>
parents:
diff changeset
427 variable @code{SHELL} if there is no @code{ESHELL}. If the file name
Dave Love <fx@gnu.org>
parents:
diff changeset
428 specified is relative, the directories in the list @code{exec-path} are
Dave Love <fx@gnu.org>
parents:
diff changeset
429 searched; this list is initialized based on the environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
430 @code{PATH} when Emacs is started. Your @file{.emacs} file can override
Dave Love <fx@gnu.org>
parents:
diff changeset
431 either or both of these default initializations.
Dave Love <fx@gnu.org>
parents:
diff changeset
432
Dave Love <fx@gnu.org>
parents:
diff changeset
433 To specify a coding system for the shell, you can use the command
Dave Love <fx@gnu.org>
parents:
diff changeset
434 @kbd{C-x @key{RET} c} immediately before @kbd{M-x shell}. You can also
Dave Love <fx@gnu.org>
parents:
diff changeset
435 specify a coding system after starting the shell by using @kbd{C-x
Dave Love <fx@gnu.org>
parents:
diff changeset
436 @key{RET} p} in the shell buffer. @xref{Specify Coding}.
Dave Love <fx@gnu.org>
parents:
diff changeset
437
Dave Love <fx@gnu.org>
parents:
diff changeset
438 As soon as the subshell is started, it is sent as input the contents
Dave Love <fx@gnu.org>
parents:
diff changeset
439 of the file @file{~/.emacs_@var{shellname}}, if that file exists, where
Dave Love <fx@gnu.org>
parents:
diff changeset
440 @var{shellname} is the name of the file that the shell was loaded from.
Dave Love <fx@gnu.org>
parents:
diff changeset
441 For example, if you use bash, the file sent to it is
Dave Love <fx@gnu.org>
parents:
diff changeset
442 @file{~/.emacs_bash}.
Dave Love <fx@gnu.org>
parents:
diff changeset
443
Dave Love <fx@gnu.org>
parents:
diff changeset
444 @vindex shell-pushd-regexp
Dave Love <fx@gnu.org>
parents:
diff changeset
445 @vindex shell-popd-regexp
Dave Love <fx@gnu.org>
parents:
diff changeset
446 @vindex shell-cd-regexp
Dave Love <fx@gnu.org>
parents:
diff changeset
447 @code{cd}, @code{pushd} and @code{popd} commands given to the inferior
Dave Love <fx@gnu.org>
parents:
diff changeset
448 shell are watched by Emacs so it can keep the @samp{*shell*} buffer's
Dave Love <fx@gnu.org>
parents:
diff changeset
449 default directory the same as the shell's working directory. These
Dave Love <fx@gnu.org>
parents:
diff changeset
450 commands are recognized syntactically by examining lines of input that are
Dave Love <fx@gnu.org>
parents:
diff changeset
451 sent. If you use aliases for these commands, you can tell Emacs to
Dave Love <fx@gnu.org>
parents:
diff changeset
452 recognize them also. For example, if the value of the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
453 @code{shell-pushd-regexp} matches the beginning of a shell command line,
Dave Love <fx@gnu.org>
parents:
diff changeset
454 that line is regarded as a @code{pushd} command. Change this variable when
Dave Love <fx@gnu.org>
parents:
diff changeset
455 you add aliases for @samp{pushd}. Likewise, @code{shell-popd-regexp} and
Dave Love <fx@gnu.org>
parents:
diff changeset
456 @code{shell-cd-regexp} are used to recognize commands with the meaning of
Dave Love <fx@gnu.org>
parents:
diff changeset
457 @samp{popd} and @samp{cd}. These commands are recognized only at the
Dave Love <fx@gnu.org>
parents:
diff changeset
458 beginning of a shell command line.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
459
Dave Love <fx@gnu.org>
parents:
diff changeset
460 @vindex shell-set-directory-error-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
461 If Emacs gets an error while trying to handle what it believes is a
Dave Love <fx@gnu.org>
parents:
diff changeset
462 @samp{cd}, @samp{pushd} or @samp{popd} command, it runs the hook
Dave Love <fx@gnu.org>
parents:
diff changeset
463 @code{shell-set-directory-error-hook} (@pxref{Hooks}).
Dave Love <fx@gnu.org>
parents:
diff changeset
464
Dave Love <fx@gnu.org>
parents:
diff changeset
465 @findex dirs
Dave Love <fx@gnu.org>
parents:
diff changeset
466 If Emacs does not properly track changes in the current directory of
Dave Love <fx@gnu.org>
parents:
diff changeset
467 the subshell, use the command @kbd{M-x dirs} to ask the shell what its
Dave Love <fx@gnu.org>
parents:
diff changeset
468 current directory is. This command works for shells that support the
Dave Love <fx@gnu.org>
parents:
diff changeset
469 most common command syntax; it may not work for unusual shells.
Dave Love <fx@gnu.org>
parents:
diff changeset
470
Dave Love <fx@gnu.org>
parents:
diff changeset
471 @findex dirtrack-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
472 You can also use @kbd{M-x dirtrack-mode} to enable (or disable) an
Dave Love <fx@gnu.org>
parents:
diff changeset
473 alternative and more aggressive method of tracking changes in the
Dave Love <fx@gnu.org>
parents:
diff changeset
474 current directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
475
Dave Love <fx@gnu.org>
parents:
diff changeset
476 Emacs defines the environment variable @code{EMACS} in the subshell,
Dave Love <fx@gnu.org>
parents:
diff changeset
477 with value @code{t}. A shell script can check this variable to
Dave Love <fx@gnu.org>
parents:
diff changeset
478 determine whether it has been run from an Emacs subshell.
Dave Love <fx@gnu.org>
parents:
diff changeset
479
Dave Love <fx@gnu.org>
parents:
diff changeset
480 @node Shell Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
481 @subsection Shell Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
482 @cindex Shell mode
Dave Love <fx@gnu.org>
parents:
diff changeset
483 @cindex mode, Shell
Dave Love <fx@gnu.org>
parents:
diff changeset
484
Dave Love <fx@gnu.org>
parents:
diff changeset
485 Shell buffers use Shell mode, which defines several special keys
Dave Love <fx@gnu.org>
parents:
diff changeset
486 attached to the @kbd{C-c} prefix. They are chosen to resemble the usual
Dave Love <fx@gnu.org>
parents:
diff changeset
487 editing and job control characters present in shells that are not under
Dave Love <fx@gnu.org>
parents:
diff changeset
488 Emacs, except that you must type @kbd{C-c} first. Here is a complete list
Dave Love <fx@gnu.org>
parents:
diff changeset
489 of the special key bindings of Shell mode:
Dave Love <fx@gnu.org>
parents:
diff changeset
490
Dave Love <fx@gnu.org>
parents:
diff changeset
491 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
492 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
493 @kindex RET @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
494 @findex comint-send-input
Dave Love <fx@gnu.org>
parents:
diff changeset
495 At end of buffer send line as input; otherwise, copy current line to end
Dave Love <fx@gnu.org>
parents:
diff changeset
496 of buffer and send it (@code{comint-send-input}). When a line is
Dave Love <fx@gnu.org>
parents:
diff changeset
497 copied, any text at the beginning of the line that matches the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
498 @code{shell-prompt-pattern} is left out; this variable's value should be
Dave Love <fx@gnu.org>
parents:
diff changeset
499 a regexp string that matches the prompts that your shell uses.
Dave Love <fx@gnu.org>
parents:
diff changeset
500
Dave Love <fx@gnu.org>
parents:
diff changeset
501 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
502 @kindex TAB @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
503 @findex comint-dynamic-complete
Dave Love <fx@gnu.org>
parents:
diff changeset
504 Complete the command name or file name before point in the shell buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
505 (@code{comint-dynamic-complete}). @key{TAB} also completes history
Dave Love <fx@gnu.org>
parents:
diff changeset
506 references (@pxref{History References}) and environment variable names.
Dave Love <fx@gnu.org>
parents:
diff changeset
507
Dave Love <fx@gnu.org>
parents:
diff changeset
508 @vindex shell-completion-fignore
Dave Love <fx@gnu.org>
parents:
diff changeset
509 @vindex comint-completion-fignore
Dave Love <fx@gnu.org>
parents:
diff changeset
510 The variable @code{shell-completion-fignore} specifies a list of file
Dave Love <fx@gnu.org>
parents:
diff changeset
511 name extensions to ignore in Shell mode completion. The default setting
Dave Love <fx@gnu.org>
parents:
diff changeset
512 ignores file names ending in @samp{~}, @samp{#} or @samp{%}. Other
Dave Love <fx@gnu.org>
parents:
diff changeset
513 related Comint modes use the variable @code{comint-completion-fignore}
Dave Love <fx@gnu.org>
parents:
diff changeset
514 instead.
Dave Love <fx@gnu.org>
parents:
diff changeset
515
Dave Love <fx@gnu.org>
parents:
diff changeset
516 @item M-?
Dave Love <fx@gnu.org>
parents:
diff changeset
517 @kindex M-? @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
518 @findex comint-dynamic-list-filename@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
519 Display temporarily a list of the possible completions of the file name
Dave Love <fx@gnu.org>
parents:
diff changeset
520 before point in the shell buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
521 (@code{comint-dynamic-list-filename-completions}).
Dave Love <fx@gnu.org>
parents:
diff changeset
522
Dave Love <fx@gnu.org>
parents:
diff changeset
523 @item C-d
Dave Love <fx@gnu.org>
parents:
diff changeset
524 @kindex C-d @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
525 @findex comint-delchar-or-maybe-eof
26290
df10644e22b5 Fix complaints from makeinfo 4.0.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
526 Either delete a character or send @sc{eof}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
527 (@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
528 buffer, @kbd{C-d} sends @sc{eof} to the subshell. Typed at any other
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
529 position in the buffer, @kbd{C-d} deletes a character as usual.
Dave Love <fx@gnu.org>
parents:
diff changeset
530
Dave Love <fx@gnu.org>
parents:
diff changeset
531 @item C-c C-a
Dave Love <fx@gnu.org>
parents:
diff changeset
532 @kindex C-c C-a @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
533 @findex comint-bol
Dave Love <fx@gnu.org>
parents:
diff changeset
534 Move to the beginning of the line, but after the prompt if any
Dave Love <fx@gnu.org>
parents:
diff changeset
535 (@code{comint-bol}). If you repeat this command twice in a row, the
Dave Love <fx@gnu.org>
parents:
diff changeset
536 second time it moves back to the process mark, which is the beginning of
Dave Love <fx@gnu.org>
parents:
diff changeset
537 the input that you have not yet sent to the subshell. (Normally that is
Dave Love <fx@gnu.org>
parents:
diff changeset
538 the same place---the end of the prompt on this line---but after @kbd{C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
539 @key{SPC}} the process mark may be in a previous line.)
Dave Love <fx@gnu.org>
parents:
diff changeset
540
Dave Love <fx@gnu.org>
parents:
diff changeset
541 @item C-c @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
542 Accumulate multiple lines of input, then send them together. This
Dave Love <fx@gnu.org>
parents:
diff changeset
543 command inserts a newline before point, but does not send the preceding
Dave Love <fx@gnu.org>
parents:
diff changeset
544 text as input to the subshell---at least, not yet. Both lines, the one
Dave Love <fx@gnu.org>
parents:
diff changeset
545 before this newline and the one after, will be sent together (along with
Dave Love <fx@gnu.org>
parents:
diff changeset
546 the newline that separates them), when you type @key{RET}.
Dave Love <fx@gnu.org>
parents:
diff changeset
547
Dave Love <fx@gnu.org>
parents:
diff changeset
548 @item C-c C-u
Dave Love <fx@gnu.org>
parents:
diff changeset
549 @kindex C-c C-u @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
550 @findex comint-kill-input
Dave Love <fx@gnu.org>
parents:
diff changeset
551 Kill all text pending at end of buffer to be sent as input
Dave Love <fx@gnu.org>
parents:
diff changeset
552 (@code{comint-kill-input}).
Dave Love <fx@gnu.org>
parents:
diff changeset
553
Dave Love <fx@gnu.org>
parents:
diff changeset
554 @item C-c C-w
Dave Love <fx@gnu.org>
parents:
diff changeset
555 @kindex C-c C-w @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
556 Kill a word before point (@code{backward-kill-word}).
Dave Love <fx@gnu.org>
parents:
diff changeset
557
Dave Love <fx@gnu.org>
parents:
diff changeset
558 @item C-c C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
559 @kindex C-c C-c @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
560 @findex comint-interrupt-subjob
Dave Love <fx@gnu.org>
parents:
diff changeset
561 Interrupt the shell or its current subjob if any
Dave Love <fx@gnu.org>
parents:
diff changeset
562 (@code{comint-interrupt-subjob}). This command also kills
Dave Love <fx@gnu.org>
parents:
diff changeset
563 any shell input pending in the shell buffer and not yet sent.
Dave Love <fx@gnu.org>
parents:
diff changeset
564
Dave Love <fx@gnu.org>
parents:
diff changeset
565 @item C-c C-z
Dave Love <fx@gnu.org>
parents:
diff changeset
566 @kindex C-c C-z @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
567 @findex comint-stop-subjob
Dave Love <fx@gnu.org>
parents:
diff changeset
568 Stop the shell or its current subjob if any (@code{comint-stop-subjob}).
Dave Love <fx@gnu.org>
parents:
diff changeset
569 This command also kills any shell input pending in the shell buffer and
Dave Love <fx@gnu.org>
parents:
diff changeset
570 not yet sent.
Dave Love <fx@gnu.org>
parents:
diff changeset
571
Dave Love <fx@gnu.org>
parents:
diff changeset
572 @item C-c C-\
Dave Love <fx@gnu.org>
parents:
diff changeset
573 @findex comint-quit-subjob
Dave Love <fx@gnu.org>
parents:
diff changeset
574 @kindex C-c C-\ @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
575 Send quit signal to the shell or its current subjob if any
Dave Love <fx@gnu.org>
parents:
diff changeset
576 (@code{comint-quit-subjob}). This command also kills any shell input
Dave Love <fx@gnu.org>
parents:
diff changeset
577 pending in the shell buffer and not yet sent.
Dave Love <fx@gnu.org>
parents:
diff changeset
578
Dave Love <fx@gnu.org>
parents:
diff changeset
579 @item C-c C-o
Dave Love <fx@gnu.org>
parents:
diff changeset
580 @kindex C-c C-o @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
581 @findex comint-kill-output
Dave Love <fx@gnu.org>
parents:
diff changeset
582 Kill the last batch of output from a shell command
Dave Love <fx@gnu.org>
parents:
diff changeset
583 (@code{comint-kill-output}). This is useful if a shell command spews
Dave Love <fx@gnu.org>
parents:
diff changeset
584 out lots of output that just gets in the way.
Dave Love <fx@gnu.org>
parents:
diff changeset
585
Dave Love <fx@gnu.org>
parents:
diff changeset
586 @item C-c C-r
Dave Love <fx@gnu.org>
parents:
diff changeset
587 @itemx C-M-l
Dave Love <fx@gnu.org>
parents:
diff changeset
588 @kindex C-c C-r @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
589 @kindex C-M-l @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
590 @findex comint-show-output
Dave Love <fx@gnu.org>
parents:
diff changeset
591 Scroll to display the beginning of the last batch of output at the top
Dave Love <fx@gnu.org>
parents:
diff changeset
592 of the window; also move the cursor there (@code{comint-show-output}).
Dave Love <fx@gnu.org>
parents:
diff changeset
593
Dave Love <fx@gnu.org>
parents:
diff changeset
594 @item C-c C-e
Dave Love <fx@gnu.org>
parents:
diff changeset
595 @kindex C-c C-e @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
596 @findex comint-show-maximum-output
Dave Love <fx@gnu.org>
parents:
diff changeset
597 Scroll to put the end of the buffer at the bottom of the window
Dave Love <fx@gnu.org>
parents:
diff changeset
598 (@code{comint-show-maximum-output}).
Dave Love <fx@gnu.org>
parents:
diff changeset
599
Dave Love <fx@gnu.org>
parents:
diff changeset
600 @item C-c C-f
Dave Love <fx@gnu.org>
parents:
diff changeset
601 @kindex C-c C-f @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
602 @findex shell-forward-command
Dave Love <fx@gnu.org>
parents:
diff changeset
603 @vindex shell-command-regexp
Dave Love <fx@gnu.org>
parents:
diff changeset
604 Move forward across one shell command, but not beyond the current line
Dave Love <fx@gnu.org>
parents:
diff changeset
605 (@code{shell-forward-command}). The variable @code{shell-command-regexp}
Dave Love <fx@gnu.org>
parents:
diff changeset
606 specifies how to recognize the end of a command.
Dave Love <fx@gnu.org>
parents:
diff changeset
607
Dave Love <fx@gnu.org>
parents:
diff changeset
608 @item C-c C-b
Dave Love <fx@gnu.org>
parents:
diff changeset
609 @kindex C-c C-b @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
610 @findex shell-backward-command
Dave Love <fx@gnu.org>
parents:
diff changeset
611 Move backward across one shell command, but not beyond the current line
Dave Love <fx@gnu.org>
parents:
diff changeset
612 (@code{shell-backward-command}).
Dave Love <fx@gnu.org>
parents:
diff changeset
613
Dave Love <fx@gnu.org>
parents:
diff changeset
614 @item C-c C-l
Dave Love <fx@gnu.org>
parents:
diff changeset
615 @kindex C-c C-l @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
616 @findex comint-dynamic-list-input-ring
Dave Love <fx@gnu.org>
parents:
diff changeset
617 Display the buffer's history of shell commands in another window
Dave Love <fx@gnu.org>
parents:
diff changeset
618 (@code{comint-dynamic-list-input-ring}).
Dave Love <fx@gnu.org>
parents:
diff changeset
619
Dave Love <fx@gnu.org>
parents:
diff changeset
620 @item M-x dirs
Dave Love <fx@gnu.org>
parents:
diff changeset
621 Ask the shell what its current directory is, so that Emacs can agree
Dave Love <fx@gnu.org>
parents:
diff changeset
622 with the shell.
Dave Love <fx@gnu.org>
parents:
diff changeset
623
Dave Love <fx@gnu.org>
parents:
diff changeset
624 @item M-x send-invisible @key{RET} @var{text} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
625 @findex send-invisible
Dave Love <fx@gnu.org>
parents:
diff changeset
626 Send @var{text} as input to the shell, after reading it without
Dave Love <fx@gnu.org>
parents:
diff changeset
627 echoing. This is useful when a shell command runs a program that asks
Dave Love <fx@gnu.org>
parents:
diff changeset
628 for a password.
Dave Love <fx@gnu.org>
parents:
diff changeset
629
Dave Love <fx@gnu.org>
parents:
diff changeset
630 Alternatively, you can arrange for Emacs to notice password prompts
Dave Love <fx@gnu.org>
parents:
diff changeset
631 and turn off echoing for them, as follows:
Dave Love <fx@gnu.org>
parents:
diff changeset
632
Dave Love <fx@gnu.org>
parents:
diff changeset
633 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
634 (add-hook 'comint-output-filter-functions
Dave Love <fx@gnu.org>
parents:
diff changeset
635 'comint-watch-for-password-prompt)
Dave Love <fx@gnu.org>
parents:
diff changeset
636 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
637
Dave Love <fx@gnu.org>
parents:
diff changeset
638 @item M-x comint-continue-subjob
Dave Love <fx@gnu.org>
parents:
diff changeset
639 @findex comint-continue-subjob
Dave Love <fx@gnu.org>
parents:
diff changeset
640 Continue the shell process. This is useful if you accidentally suspend
Dave Love <fx@gnu.org>
parents:
diff changeset
641 the shell process.@footnote{You should not suspend the shell process.
Dave Love <fx@gnu.org>
parents:
diff changeset
642 Suspending a subjob of the shell is a completely different matter---that
Dave Love <fx@gnu.org>
parents:
diff changeset
643 is normal practice, but you must use the shell to continue the subjob;
Dave Love <fx@gnu.org>
parents:
diff changeset
644 this command won't do it.}
Dave Love <fx@gnu.org>
parents:
diff changeset
645
Dave Love <fx@gnu.org>
parents:
diff changeset
646 @item M-x comint-strip-ctrl-m
Dave Love <fx@gnu.org>
parents:
diff changeset
647 @findex comint-strip-ctrl-m
Dave Love <fx@gnu.org>
parents:
diff changeset
648 Discard all control-M characters from the current group of shell output.
Dave Love <fx@gnu.org>
parents:
diff changeset
649 The most convenient way to use this command is to make it run
Dave Love <fx@gnu.org>
parents:
diff changeset
650 automatically when you get output from the subshell. To do that,
Dave Love <fx@gnu.org>
parents:
diff changeset
651 evaluate this Lisp expression:
Dave Love <fx@gnu.org>
parents:
diff changeset
652
Dave Love <fx@gnu.org>
parents:
diff changeset
653 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
654 (add-hook 'comint-output-filter-functions
Dave Love <fx@gnu.org>
parents:
diff changeset
655 'comint-strip-ctrl-m)
Dave Love <fx@gnu.org>
parents:
diff changeset
656 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
657
Dave Love <fx@gnu.org>
parents:
diff changeset
658 @item M-x comint-truncate-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
659 @findex comint-truncate-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
660 This command truncates the shell buffer to a certain maximum number of
Dave Love <fx@gnu.org>
parents:
diff changeset
661 lines, specified by the variable @code{comint-buffer-maximum-size}.
Dave Love <fx@gnu.org>
parents:
diff changeset
662 Here's how to do this automatically each time you get output from the
Dave Love <fx@gnu.org>
parents:
diff changeset
663 subshell:
Dave Love <fx@gnu.org>
parents:
diff changeset
664
Dave Love <fx@gnu.org>
parents:
diff changeset
665 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
666 (add-hook 'comint-output-filter-functions
Dave Love <fx@gnu.org>
parents:
diff changeset
667 'comint-truncate-buffer)
Dave Love <fx@gnu.org>
parents:
diff changeset
668 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
669 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
670
Dave Love <fx@gnu.org>
parents:
diff changeset
671 Shell mode also customizes the paragraph commands so that only shell
Dave Love <fx@gnu.org>
parents:
diff changeset
672 prompts start new paragraphs. Thus, a paragraph consists of an input
Dave Love <fx@gnu.org>
parents:
diff changeset
673 command plus the output that follows it in the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
674
Dave Love <fx@gnu.org>
parents:
diff changeset
675 @cindex Comint mode
Dave Love <fx@gnu.org>
parents:
diff changeset
676 @cindex mode, Comint
Dave Love <fx@gnu.org>
parents:
diff changeset
677 Shell mode is a derivative of Comint mode, a general-purpose mode for
Dave Love <fx@gnu.org>
parents:
diff changeset
678 communicating with interactive subprocesses. Most of the features of
Dave Love <fx@gnu.org>
parents:
diff changeset
679 Shell mode actually come from Comint mode, as you can see from the
Dave Love <fx@gnu.org>
parents:
diff changeset
680 command names listed above. The special features of Shell mode in
Dave Love <fx@gnu.org>
parents:
diff changeset
681 particular include the choice of regular expression for detecting
Dave Love <fx@gnu.org>
parents:
diff changeset
682 prompts, the directory tracking feature, and a few user commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
683
Dave Love <fx@gnu.org>
parents:
diff changeset
684 Other Emacs features that use variants of Comint mode include GUD
Dave Love <fx@gnu.org>
parents:
diff changeset
685 (@pxref{Debuggers}) and @kbd{M-x run-lisp} (@pxref{External Lisp}).
Dave Love <fx@gnu.org>
parents:
diff changeset
686
Dave Love <fx@gnu.org>
parents:
diff changeset
687 @findex comint-run
Dave Love <fx@gnu.org>
parents:
diff changeset
688 You can use @kbd{M-x comint-run} to execute any program of your choice
Dave Love <fx@gnu.org>
parents:
diff changeset
689 in a subprocess using unmodified Comint mode---without the
Dave Love <fx@gnu.org>
parents:
diff changeset
690 specializations of Shell mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
691
Dave Love <fx@gnu.org>
parents:
diff changeset
692 @node Shell History
Dave Love <fx@gnu.org>
parents:
diff changeset
693 @subsection Shell Command History
Dave Love <fx@gnu.org>
parents:
diff changeset
694
Dave Love <fx@gnu.org>
parents:
diff changeset
695 Shell buffers support three ways of repeating earlier commands. You
Dave Love <fx@gnu.org>
parents:
diff changeset
696 can use the same keys used in the minibuffer; these work much as they do
Dave Love <fx@gnu.org>
parents:
diff changeset
697 in the minibuffer, inserting text from prior commands while point
Dave Love <fx@gnu.org>
parents:
diff changeset
698 remains always at the end of the buffer. You can move through the
Dave Love <fx@gnu.org>
parents:
diff changeset
699 buffer to previous inputs in their original place, then resubmit them or
Dave Love <fx@gnu.org>
parents:
diff changeset
700 copy them to the end. Or you can use a @samp{!}-style history
Dave Love <fx@gnu.org>
parents:
diff changeset
701 reference.
Dave Love <fx@gnu.org>
parents:
diff changeset
702
Dave Love <fx@gnu.org>
parents:
diff changeset
703 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
704 * Ring: Shell Ring. Fetching commands from the history list.
Dave Love <fx@gnu.org>
parents:
diff changeset
705 * Copy: Shell History Copying. Moving to a command and then copying it.
Dave Love <fx@gnu.org>
parents:
diff changeset
706 * History References:: Expanding @samp{!}-style history references.
Dave Love <fx@gnu.org>
parents:
diff changeset
707 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
708
Dave Love <fx@gnu.org>
parents:
diff changeset
709 @node Shell Ring
Dave Love <fx@gnu.org>
parents:
diff changeset
710 @subsubsection Shell History Ring
Dave Love <fx@gnu.org>
parents:
diff changeset
711
Dave Love <fx@gnu.org>
parents:
diff changeset
712 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
713 @findex comint-previous-input
Dave Love <fx@gnu.org>
parents:
diff changeset
714 @kindex M-p @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
715 @item M-p
Dave Love <fx@gnu.org>
parents:
diff changeset
716 Fetch the next earlier old shell command.
Dave Love <fx@gnu.org>
parents:
diff changeset
717
Dave Love <fx@gnu.org>
parents:
diff changeset
718 @kindex M-n @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
719 @findex comint-next-input
Dave Love <fx@gnu.org>
parents:
diff changeset
720 @item M-n
Dave Love <fx@gnu.org>
parents:
diff changeset
721 Fetch the next later old shell command.
Dave Love <fx@gnu.org>
parents:
diff changeset
722
Dave Love <fx@gnu.org>
parents:
diff changeset
723 @kindex M-r @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
724 @kindex M-s @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
725 @findex comint-previous-matching-input
Dave Love <fx@gnu.org>
parents:
diff changeset
726 @findex comint-next-matching-input
Dave Love <fx@gnu.org>
parents:
diff changeset
727 @item M-r @var{regexp} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
728 @itemx M-s @var{regexp} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
729 Search backwards or forwards for old shell commands that match @var{regexp}.
Dave Love <fx@gnu.org>
parents:
diff changeset
730
Dave Love <fx@gnu.org>
parents:
diff changeset
731 @item C-c C-x @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
732 @findex comint-get-next-from-history
Dave Love <fx@gnu.org>
parents:
diff changeset
733 Fetch the next subsequent command from the history.
Dave Love <fx@gnu.org>
parents:
diff changeset
734 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
735
Dave Love <fx@gnu.org>
parents:
diff changeset
736 Shell buffers provide a history of previously entered shell commands. To
Dave Love <fx@gnu.org>
parents:
diff changeset
737 reuse shell commands from the history, use the editing commands @kbd{M-p},
Dave Love <fx@gnu.org>
parents:
diff changeset
738 @kbd{M-n}, @kbd{M-r} and @kbd{M-s}. These work just like the minibuffer
Dave Love <fx@gnu.org>
parents:
diff changeset
739 history commands except that they operate on the text at the end of the
Dave Love <fx@gnu.org>
parents:
diff changeset
740 shell buffer, where you would normally insert text to send to the shell.
Dave Love <fx@gnu.org>
parents:
diff changeset
741
Dave Love <fx@gnu.org>
parents:
diff changeset
742 @kbd{M-p} fetches an earlier shell command to the end of the shell buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
743 Successive use of @kbd{M-p} fetches successively earlier shell commands,
Dave Love <fx@gnu.org>
parents:
diff changeset
744 each replacing any text that was already present as potential shell input.
Dave Love <fx@gnu.org>
parents:
diff changeset
745 @kbd{M-n} does likewise except that it finds successively more recent shell
Dave Love <fx@gnu.org>
parents:
diff changeset
746 commands from the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
747
Dave Love <fx@gnu.org>
parents:
diff changeset
748 The history search commands @kbd{M-r} and @kbd{M-s} read a regular
Dave Love <fx@gnu.org>
parents:
diff changeset
749 expression and search through the history for a matching command. Aside
Dave Love <fx@gnu.org>
parents:
diff changeset
750 from the choice of which command to fetch, they work just like @kbd{M-p}
Dave Love <fx@gnu.org>
parents:
diff changeset
751 and @kbd{M-r}. If you enter an empty regexp, these commands reuse the
Dave Love <fx@gnu.org>
parents:
diff changeset
752 same regexp used last time.
Dave Love <fx@gnu.org>
parents:
diff changeset
753
Dave Love <fx@gnu.org>
parents:
diff changeset
754 When you find the previous input you want, you can resubmit it by
Dave Love <fx@gnu.org>
parents:
diff changeset
755 typing @key{RET}, or you can edit it first and then resubmit it if you
Dave Love <fx@gnu.org>
parents:
diff changeset
756 wish.
Dave Love <fx@gnu.org>
parents:
diff changeset
757
Dave Love <fx@gnu.org>
parents:
diff changeset
758 Often it is useful to reexecute several successive shell commands that
Dave Love <fx@gnu.org>
parents:
diff changeset
759 were previously executed in sequence. To do this, first find and
Dave Love <fx@gnu.org>
parents:
diff changeset
760 reexecute the first command of the sequence. Then type @kbd{C-c C-x};
Dave Love <fx@gnu.org>
parents:
diff changeset
761 that will fetch the following command---the one that follows the command
Dave Love <fx@gnu.org>
parents:
diff changeset
762 you just repeated. Then type @key{RET} to reexecute this command. You
Dave Love <fx@gnu.org>
parents:
diff changeset
763 can reexecute several successive commands by typing @kbd{C-c C-x
Dave Love <fx@gnu.org>
parents:
diff changeset
764 @key{RET}} over and over.
Dave Love <fx@gnu.org>
parents:
diff changeset
765
Dave Love <fx@gnu.org>
parents:
diff changeset
766 These commands get the text of previous shell commands from a special
Dave Love <fx@gnu.org>
parents:
diff changeset
767 history list, not from the shell buffer itself. Thus, editing the shell
Dave Love <fx@gnu.org>
parents:
diff changeset
768 buffer, or even killing large parts of it, does not affect the history
Dave Love <fx@gnu.org>
parents:
diff changeset
769 that these commands access.
Dave Love <fx@gnu.org>
parents:
diff changeset
770
Dave Love <fx@gnu.org>
parents:
diff changeset
771 @vindex shell-input-ring-file-name
Dave Love <fx@gnu.org>
parents:
diff changeset
772 Some shells store their command histories in files so that you can
Dave Love <fx@gnu.org>
parents:
diff changeset
773 refer to previous commands from previous shell sessions. Emacs reads
Dave Love <fx@gnu.org>
parents:
diff changeset
774 the command history file for your chosen shell, to initialize its own
Dave Love <fx@gnu.org>
parents:
diff changeset
775 command history. The file name is @file{~/.bash_history} for bash,
Dave Love <fx@gnu.org>
parents:
diff changeset
776 @file{~/.sh_history} for ksh, and @file{~/.history} for other shells.
Dave Love <fx@gnu.org>
parents:
diff changeset
777
Dave Love <fx@gnu.org>
parents:
diff changeset
778 @node Shell History Copying
Dave Love <fx@gnu.org>
parents:
diff changeset
779 @subsubsection Shell History Copying
Dave Love <fx@gnu.org>
parents:
diff changeset
780
Dave Love <fx@gnu.org>
parents:
diff changeset
781 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
782 @kindex C-c C-p @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
783 @findex comint-previous-prompt
Dave Love <fx@gnu.org>
parents:
diff changeset
784 @item C-c C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
785 Move point to the previous prompt (@code{comint-previous-prompt}).
Dave Love <fx@gnu.org>
parents:
diff changeset
786
Dave Love <fx@gnu.org>
parents:
diff changeset
787 @kindex C-c C-n @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
788 @findex comint-next-prompt
Dave Love <fx@gnu.org>
parents:
diff changeset
789 @item C-c C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
790 Move point to the following prompt (@code{comint-next-prompt}).
Dave Love <fx@gnu.org>
parents:
diff changeset
791
Dave Love <fx@gnu.org>
parents:
diff changeset
792 @kindex C-c RET @r{(Shell mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
793 @findex comint-copy-old-input
Dave Love <fx@gnu.org>
parents:
diff changeset
794 @item C-c @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
795 Copy the input command which point is in, inserting the copy at the end
Dave Love <fx@gnu.org>
parents:
diff changeset
796 of the buffer (@code{comint-copy-old-input}). This is useful if you
Dave Love <fx@gnu.org>
parents:
diff changeset
797 move point back to a previous command. After you copy the command, you
Dave Love <fx@gnu.org>
parents:
diff changeset
798 can submit the copy as input with @key{RET}. If you wish, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
799 edit the copy before resubmitting it.
Dave Love <fx@gnu.org>
parents:
diff changeset
800 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
801
Dave Love <fx@gnu.org>
parents:
diff changeset
802 Moving to a previous input and then copying it with @kbd{C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
803 @key{RET}} produces the same results---the same buffer contents---that
Dave Love <fx@gnu.org>
parents:
diff changeset
804 you would get by using @kbd{M-p} enough times to fetch that previous
Dave Love <fx@gnu.org>
parents:
diff changeset
805 input from the history list. However, @kbd{C-c @key{RET}} copies the
Dave Love <fx@gnu.org>
parents:
diff changeset
806 text from the buffer, which can be different from what is in the history
Dave Love <fx@gnu.org>
parents:
diff changeset
807 list if you edit the input text in the buffer after it has been sent.
Dave Love <fx@gnu.org>
parents:
diff changeset
808
Dave Love <fx@gnu.org>
parents:
diff changeset
809 @node History References
Dave Love <fx@gnu.org>
parents:
diff changeset
810 @subsubsection Shell History References
Dave Love <fx@gnu.org>
parents:
diff changeset
811 @cindex history reference
Dave Love <fx@gnu.org>
parents:
diff changeset
812
Dave Love <fx@gnu.org>
parents:
diff changeset
813 Various shells including csh and bash support @dfn{history references}
Dave Love <fx@gnu.org>
parents:
diff changeset
814 that begin with @samp{!} and @samp{^}. Shell mode can understand these
Dave Love <fx@gnu.org>
parents:
diff changeset
815 constructs and perform the history substitution for you. If you insert
Dave Love <fx@gnu.org>
parents:
diff changeset
816 a history reference and type @key{TAB}, this searches the input history
Dave Love <fx@gnu.org>
parents:
diff changeset
817 for a matching command, performs substitution if necessary, and places
Dave Love <fx@gnu.org>
parents:
diff changeset
818 the result in the buffer in place of the history reference. For
Dave Love <fx@gnu.org>
parents:
diff changeset
819 example, you can fetch the most recent command beginning with @samp{mv}
Dave Love <fx@gnu.org>
parents:
diff changeset
820 with @kbd{! m v @key{TAB}}. You can edit the command if you wish, and
Dave Love <fx@gnu.org>
parents:
diff changeset
821 then resubmit the command to the shell by typing @key{RET}.
Dave Love <fx@gnu.org>
parents:
diff changeset
822
Dave Love <fx@gnu.org>
parents:
diff changeset
823 @vindex shell-prompt-pattern
Dave Love <fx@gnu.org>
parents:
diff changeset
824 @vindex comint-prompt-regexp
Dave Love <fx@gnu.org>
parents:
diff changeset
825 History references take effect only following a shell prompt. The
Dave Love <fx@gnu.org>
parents:
diff changeset
826 variable @code{shell-prompt-pattern} specifies how to recognize a shell
Dave Love <fx@gnu.org>
parents:
diff changeset
827 prompt. Comint modes in general use the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
828 @code{comint-prompt-regexp} to specify how to find a prompt; Shell mode
Dave Love <fx@gnu.org>
parents:
diff changeset
829 uses @code{shell-prompt-pattern} to set up the local value of
Dave Love <fx@gnu.org>
parents:
diff changeset
830 @code{comint-prompt-regexp}.
Dave Love <fx@gnu.org>
parents:
diff changeset
831
Dave Love <fx@gnu.org>
parents:
diff changeset
832 @vindex comint-input-autoexpand
Dave Love <fx@gnu.org>
parents:
diff changeset
833 Shell mode can optionally expand history references in the buffer when
Dave Love <fx@gnu.org>
parents:
diff changeset
834 you send them to the shell. To request this, set the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
835 @code{comint-input-autoexpand} to @code{input}.
Dave Love <fx@gnu.org>
parents:
diff changeset
836
Dave Love <fx@gnu.org>
parents:
diff changeset
837 @findex comint-magic-space
Dave Love <fx@gnu.org>
parents:
diff changeset
838 You can make @key{SPC} perform history expansion by binding @key{SPC} to
Dave Love <fx@gnu.org>
parents:
diff changeset
839 the command @code{comint-magic-space}.
Dave Love <fx@gnu.org>
parents:
diff changeset
840
Dave Love <fx@gnu.org>
parents:
diff changeset
841 @node Shell Options
Dave Love <fx@gnu.org>
parents:
diff changeset
842 @subsection Shell Mode Options
Dave Love <fx@gnu.org>
parents:
diff changeset
843
Dave Love <fx@gnu.org>
parents:
diff changeset
844 @vindex comint-scroll-to-bottom-on-input
Dave Love <fx@gnu.org>
parents:
diff changeset
845 If the variable @code{comint-scroll-to-bottom-on-input} is
Dave Love <fx@gnu.org>
parents:
diff changeset
846 non-@code{nil}, insertion and yank commands scroll the selected window
Dave Love <fx@gnu.org>
parents:
diff changeset
847 to the bottom before inserting.
Dave Love <fx@gnu.org>
parents:
diff changeset
848
Dave Love <fx@gnu.org>
parents:
diff changeset
849 @vindex comint-scroll-show-maximum-output
Dave Love <fx@gnu.org>
parents:
diff changeset
850 If @code{comint-scroll-show-maximum-output} is non-@code{nil}, then
Dave Love <fx@gnu.org>
parents:
diff changeset
851 scrolling due to arrival of output tries to place the last line of text
Dave Love <fx@gnu.org>
parents:
diff changeset
852 at the bottom line of the window, so as to show as much useful text as
Dave Love <fx@gnu.org>
parents:
diff changeset
853 possible. (This mimics the scrolling behavior of many terminals.)
Dave Love <fx@gnu.org>
parents:
diff changeset
854 The default is @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
855
Dave Love <fx@gnu.org>
parents:
diff changeset
856 @vindex comint-scroll-to-bottom-on-output
Dave Love <fx@gnu.org>
parents:
diff changeset
857 By setting @code{comint-scroll-to-bottom-on-output}, you can opt for
Dave Love <fx@gnu.org>
parents:
diff changeset
858 having point jump to the end of the buffer whenever output arrives---no
Dave Love <fx@gnu.org>
parents:
diff changeset
859 matter where in the buffer point was before. If the value is
Dave Love <fx@gnu.org>
parents:
diff changeset
860 @code{this}, point jumps in the selected window. If the value is
Dave Love <fx@gnu.org>
parents:
diff changeset
861 @code{all}, point jumps in each window that shows the comint buffer. If
Dave Love <fx@gnu.org>
parents:
diff changeset
862 the value is @code{other}, point jumps in all nonselected windows that
Dave Love <fx@gnu.org>
parents:
diff changeset
863 show the current buffer. The default value is @code{nil}, which means
Dave Love <fx@gnu.org>
parents:
diff changeset
864 point does not jump to the end.
Dave Love <fx@gnu.org>
parents:
diff changeset
865
Dave Love <fx@gnu.org>
parents:
diff changeset
866 @vindex comint-input-ignoredups
Dave Love <fx@gnu.org>
parents:
diff changeset
867 The variable @code{comint-input-ignoredups} controls whether successive
Dave Love <fx@gnu.org>
parents:
diff changeset
868 identical inputs are stored in the input history. A non-@code{nil}
Dave Love <fx@gnu.org>
parents:
diff changeset
869 value means to omit an input that is the same as the previous input.
Dave Love <fx@gnu.org>
parents:
diff changeset
870 The default is @code{nil}, which means to store each input even if it is
Dave Love <fx@gnu.org>
parents:
diff changeset
871 equal to the previous input.
Dave Love <fx@gnu.org>
parents:
diff changeset
872
Dave Love <fx@gnu.org>
parents:
diff changeset
873 @vindex comint-completion-addsuffix
Dave Love <fx@gnu.org>
parents:
diff changeset
874 @vindex comint-completion-recexact
Dave Love <fx@gnu.org>
parents:
diff changeset
875 @vindex comint-completion-autolist
Dave Love <fx@gnu.org>
parents:
diff changeset
876 Three variables customize file name completion. The variable
Dave Love <fx@gnu.org>
parents:
diff changeset
877 @code{comint-completion-addsuffix} controls whether completion inserts a
Dave Love <fx@gnu.org>
parents:
diff changeset
878 space or a slash to indicate a fully completed file or directory name
Dave Love <fx@gnu.org>
parents:
diff changeset
879 (non-@code{nil} means do insert a space or slash).
Dave Love <fx@gnu.org>
parents:
diff changeset
880 @code{comint-completion-recexact}, if non-@code{nil}, directs @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
881 to choose the shortest possible completion if the usual Emacs completion
Dave Love <fx@gnu.org>
parents:
diff changeset
882 algorithm cannot add even a single character.
Dave Love <fx@gnu.org>
parents:
diff changeset
883 @code{comint-completion-autolist}, if non-@code{nil}, says to list all
Dave Love <fx@gnu.org>
parents:
diff changeset
884 the possible completions whenever completion is not exact.
Dave Love <fx@gnu.org>
parents:
diff changeset
885
Dave Love <fx@gnu.org>
parents:
diff changeset
886 @findex comint-dynamic-complete-variable
Dave Love <fx@gnu.org>
parents:
diff changeset
887 The command @code{comint-dynamic-complete-variable} does variable-name
Dave Love <fx@gnu.org>
parents:
diff changeset
888 completion using the environment variables as set within Emacs. The
Dave Love <fx@gnu.org>
parents:
diff changeset
889 variables controlling file name completion apply to variable-name
Dave Love <fx@gnu.org>
parents:
diff changeset
890 completion too. This command is normally available through the menu
Dave Love <fx@gnu.org>
parents:
diff changeset
891 bar.
Dave Love <fx@gnu.org>
parents:
diff changeset
892
Dave Love <fx@gnu.org>
parents:
diff changeset
893 @vindex shell-command-execonly
Dave Love <fx@gnu.org>
parents:
diff changeset
894 Command completion normally considers only executable files.
Dave Love <fx@gnu.org>
parents:
diff changeset
895 If you set @code{shell-command-execonly} to @code{nil},
Dave Love <fx@gnu.org>
parents:
diff changeset
896 it considers nonexecutable files as well.
Dave Love <fx@gnu.org>
parents:
diff changeset
897
Dave Love <fx@gnu.org>
parents:
diff changeset
898 @findex shell-pushd-tohome
Dave Love <fx@gnu.org>
parents:
diff changeset
899 @findex shell-pushd-dextract
Dave Love <fx@gnu.org>
parents:
diff changeset
900 @findex shell-pushd-dunique
Dave Love <fx@gnu.org>
parents:
diff changeset
901 You can configure the behavior of @samp{pushd}. Variables control
Dave Love <fx@gnu.org>
parents:
diff changeset
902 whether @samp{pushd} behaves like @samp{cd} if no argument is given
Dave Love <fx@gnu.org>
parents:
diff changeset
903 (@code{shell-pushd-tohome}), pop rather than rotate with a numeric
Dave Love <fx@gnu.org>
parents:
diff changeset
904 argument (@code{shell-pushd-dextract}), and only add directories to the
Dave Love <fx@gnu.org>
parents:
diff changeset
905 directory stack if they are not already on it
Dave Love <fx@gnu.org>
parents:
diff changeset
906 (@code{shell-pushd-dunique}). The values you choose should match the
Dave Love <fx@gnu.org>
parents:
diff changeset
907 underlying shell, of course.
Dave Love <fx@gnu.org>
parents:
diff changeset
908
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
909 @node Terminal emulator
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
910 @subsection Interactive Inferior Shell with Terminal Emulator
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
911 @findex term
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
912
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
913 To run a subshell in a terminal emulator, putting its typescript in an Emacs
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
914 buffer, use @kbd{M-x term}. This creates (or reuses) a buffer named
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
915 @samp{*term*} and runs a subshell with input coming from your keyboard and
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
916 output going to that buffer.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
917
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
918 All the normal keys that you type are sent without any interpretation
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
919 by Emacs directly to the subshell, as ``terminal input''.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
920 Any ``echo'' of your input is the responsibility of the subshell.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
921 (The exception is the terminal escape character,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
922 which by default is @kbd{C-c}. @xref{Term Mode}.)
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
923 Any ``terminal output'' from the subshell goes into the buffer,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
924 advancing point.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
925
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
926 Some programs (such as Emacs itself) need to control the
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
927 appearance on the terminal screen in detail. They do this by
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
928 sending special control codes. The exact control
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
929 codes needed vary from terminal to terminal, but nowadays
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
930 most terminals and terminal emulators (including @code{xterm})
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
931 understand the ANSI-standard (VT100-style) escape sequences.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
932 Term mode also understands these escape sequences,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
933 and for each control code does the appropriate thing
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
934 to change the buffer so that the appearance of the window
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
935 matches what it would be on a real terminal.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
936 Thus you can actually run Emacs inside an Emacs Term window!
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
937
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
938 Emacs does not wait for the subshell to do anything. You can switch
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
939 windows or buffers and edit them while the shell is waiting, or while
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
940 it is running a command. Output from the subshell waits until Emacs
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
941 has time to process it; this happens whenever Emacs is waiting for
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
942 keyboard input or for time to elapse.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
943
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
944 To make multiple terminal emulators, rename the buffer @samp{*term*}
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
945 to something different using @kbd{M-x rename-uniquely},
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
946 just as with Shell mode.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
947
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
948 The file name used to load the subshell is determined
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
949 the same way as for Shell mode.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
950
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
951 Unlike Shell mode, Term mode does not track the current directory
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
952 by examining your input. Instead, if you use a programmable
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
953 shell, you can have it tell Term what the current directory is.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
954 This is done automatically by @code{bash} version 1.15 and later.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
955
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
956 @node Term Mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
957 @subsection Term Mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
958 @cindex Term mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
959 @cindex mode, Term
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
960
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
961 Term uses Term mode, which has two input modes:
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
962 In line mode, Term basically acts like Shell mode. @xref{Shell Mode}.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
963 In Char mode, each character is sent directly to the inferior subshell,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
964 except for the Term escape character, normally @kbd{C-c}.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
965
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
966 To switch between line and char mode, use these commands:
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
967 @table @kbd
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
968 @kindex C-c C-k @r{(Term mode)}
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
969 @findex term-char-mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
970 @item C-c C-k
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
971 Switch to line mode. Do nothing if already in line mode.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
972
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
973 @kindex C-c C-j @r{(Term mode)}
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
974 @findex term-line-mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
975 @item C-c C-j
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
976 Switch to char mode. Do nothing if already in char mode.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
977 @end table
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
978
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
979 The following commands are only available in Char mode:
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
980 @table @kbd
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
981 @item C-c C-c
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
982 Send a literal @key{C-c} to the sub-shell.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
983
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
984 @item C-c C-x
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
985 A prefix command to access the global @key{C-x} commands conveniently.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
986 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
987 @kbd{C-x o}, which is normally @samp{other-window}.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
988 @end table
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
989
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
990 @node Paging in Term
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
991 @subsection Paging in the terminal emulator
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
992
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
993 Term mode has a pager feature. When the pager is enabled,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
994 term mode will pause at the end of each screenful.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
995
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
996 @table @kbd
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
997 @kindex C-c C-q @r{(Term mode)}
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
998 @findex term-pager-toggle
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
999 @item C-c C-q
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1000 Toggles the pager feature: Disables the pager if it is enabled,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1001 and vice versa. This works in both line and char modes.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1002 If the pager enabled, the mode-line contains the word @samp{page}.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1003 @end table
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1004
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1005 If the pager is enabled, and Term receives more than a screenful
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1006 of output since your last input, Term will enter More break mode.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1007 This is indicated by @samp{**MORE**} in the mode-line.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1008 Type a @kbd{Space} to display the next screenful of output.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1009 Type @kbd{?} to see your other options. The interface is similar
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1010 to the Unix @code{more} program.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1011
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1012 @node Remote Host
Dave Love <fx@gnu.org>
parents:
diff changeset
1013 @subsection Remote Host Shell
Dave Love <fx@gnu.org>
parents:
diff changeset
1014 @cindex remote host
Dave Love <fx@gnu.org>
parents:
diff changeset
1015 @cindex connecting to remote host
Dave Love <fx@gnu.org>
parents:
diff changeset
1016 @cindex Telnet
Dave Love <fx@gnu.org>
parents:
diff changeset
1017 @cindex Rlogin
Dave Love <fx@gnu.org>
parents:
diff changeset
1018
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1019 You can login to a remote computer, using whatever commands you
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1020 would from a regular terminal (e.g.@: using the @code{telnet} or
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1021 @code{rlogin} commands), from a Term window.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1022
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1023 A program that asks you for a password will normally suppress
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1024 echoing of the password, so the password will not show up in the buffer.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1025 This will happen just as if you were using a real terminal, if
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1026 the buffer is in char mode. If it is in line mode, the password
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1027 will be temporarily visible, but will be erased when you hit return.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1028 (This happens automatically; there is no special password processing.)
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1029
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1030 When you log in to a different machine, you need to specify the
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1031 type of terminal your using. Terminal types @samp{ansi}
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1032 or @samp{vt100} will work on most systems.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1033
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1034 @c If you are talking to a Bourne-compatible
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1035 @c shell, and your system understands the @code{TERMCAP} variable,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1036 @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
1037 @c sends a string specifying the terminal type and size.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1038 @c (This command is also useful after the window has changed size.)
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1039
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1040 @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
1041 @c trick: If you invoke gdb with the @code{--fullname} option,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1042 @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
1043 @c pop up the source files you're debugging. This will work
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1044 @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
1045 @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
1046
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1047 You cannot log into to a remove comuter using the Shell mode.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1048 @c (This will change when Shell is re-written to use Term.)
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1049 Instead, Emacs provides two commands for logging in to another computer
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 and communicating with it through an Emacs buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1051
Dave Love <fx@gnu.org>
parents:
diff changeset
1052 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1053 @item M-x telnet @key{RET} @var{hostname} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
1054 Set up a Telnet connection to the computer named @var{hostname}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1055 @item M-x rlogin @key{RET} @var{hostname} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
1056 Set up an Rlogin connection to the computer named @var{hostname}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1057 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1058
Dave Love <fx@gnu.org>
parents:
diff changeset
1059 @findex telnet
Dave Love <fx@gnu.org>
parents:
diff changeset
1060 Use @kbd{M-x telnet} to set up a Telnet connection to another
Dave Love <fx@gnu.org>
parents:
diff changeset
1061 computer. (Telnet is the standard Internet protocol for remote login.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1062 It reads the host name of the other computer as an argument with the
Dave Love <fx@gnu.org>
parents:
diff changeset
1063 minibuffer. Once the connection is established, talking to the other
Dave Love <fx@gnu.org>
parents:
diff changeset
1064 computer works like talking to a subshell: you can edit input with the
Dave Love <fx@gnu.org>
parents:
diff changeset
1065 usual Emacs commands, and send it a line at a time by typing @key{RET}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1066 The output is inserted in the Telnet buffer interspersed with the input.
Dave Love <fx@gnu.org>
parents:
diff changeset
1067
Dave Love <fx@gnu.org>
parents:
diff changeset
1068 @findex rlogin
Dave Love <fx@gnu.org>
parents:
diff changeset
1069 @vindex rlogin-explicit-args
Dave Love <fx@gnu.org>
parents:
diff changeset
1070 Use @kbd{M-x rlogin} to set up an Rlogin connection. Rlogin is
Dave Love <fx@gnu.org>
parents:
diff changeset
1071 another remote login communication protocol, essentially much like the
Dave Love <fx@gnu.org>
parents:
diff changeset
1072 Telnet protocol but incompatible with it, and supported only by certain
Dave Love <fx@gnu.org>
parents:
diff changeset
1073 systems. Rlogin's advantages are that you can arrange not to have to
Dave Love <fx@gnu.org>
parents:
diff changeset
1074 give your user name and password when communicating between two machines
Dave Love <fx@gnu.org>
parents:
diff changeset
1075 you frequently use, and that you can make an 8-bit-clean connection.
Dave Love <fx@gnu.org>
parents:
diff changeset
1076 (To do that in Emacs, set @code{rlogin-explicit-args} to @code{("-8")}
Dave Love <fx@gnu.org>
parents:
diff changeset
1077 before you run Rlogin.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1078
Dave Love <fx@gnu.org>
parents:
diff changeset
1079 @kbd{M-x rlogin} sets up the default file directory of the Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
1080 buffer to access the remote host via FTP (@pxref{File Names}), and it
Dave Love <fx@gnu.org>
parents:
diff changeset
1081 tracks the shell commands that change the current directory, just like
Dave Love <fx@gnu.org>
parents:
diff changeset
1082 Shell mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1083
Dave Love <fx@gnu.org>
parents:
diff changeset
1084 @findex rlogin-directory-tracking-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1085 There are two ways of doing directory tracking in an Rlogin
Dave Love <fx@gnu.org>
parents:
diff changeset
1086 buffer---either with remote directory names
Dave Love <fx@gnu.org>
parents:
diff changeset
1087 @file{/@var{host}:@var{dir}/} or with local names (that works if the
Dave Love <fx@gnu.org>
parents:
diff changeset
1088 ``remote'' machine shares file systems with your machine of origin).
Dave Love <fx@gnu.org>
parents:
diff changeset
1089 You can use the command @code{rlogin-directory-tracking-mode} to switch
Dave Love <fx@gnu.org>
parents:
diff changeset
1090 modes. No argument means use remote directory names, a positive
Dave Love <fx@gnu.org>
parents:
diff changeset
1091 argument means use local names, and a negative argument means turn
Dave Love <fx@gnu.org>
parents:
diff changeset
1092 off directory tracking.
Dave Love <fx@gnu.org>
parents:
diff changeset
1093
Dave Love <fx@gnu.org>
parents:
diff changeset
1094 @node Emacs Server, Hardcopy, Shell, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1095 @section Using Emacs as a Server
Dave Love <fx@gnu.org>
parents:
diff changeset
1096 @pindex emacsclient
Dave Love <fx@gnu.org>
parents:
diff changeset
1097 @cindex Emacs as a server
Dave Love <fx@gnu.org>
parents:
diff changeset
1098 @cindex server, using Emacs as
Dave Love <fx@gnu.org>
parents:
diff changeset
1099 @cindex @code{EDITOR} environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1100
Dave Love <fx@gnu.org>
parents:
diff changeset
1101 Various programs such as @code{mail} can invoke your choice of editor
Dave Love <fx@gnu.org>
parents:
diff changeset
1102 to edit a particular piece of text, such as a message that you are
Dave Love <fx@gnu.org>
parents:
diff changeset
1103 sending. By convention, most of these programs use the environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1104 variable @code{EDITOR} to specify which editor to run. If you set
Dave Love <fx@gnu.org>
parents:
diff changeset
1105 @code{EDITOR} to @samp{emacs}, they invoke Emacs---but in an
Dave Love <fx@gnu.org>
parents:
diff changeset
1106 inconvenient fashion, by starting a new, separate Emacs process. This
Dave Love <fx@gnu.org>
parents:
diff changeset
1107 is inconvenient because it takes time and because the new Emacs process
Dave Love <fx@gnu.org>
parents:
diff changeset
1108 doesn't share the buffers in the existing Emacs process.
Dave Love <fx@gnu.org>
parents:
diff changeset
1109
Dave Love <fx@gnu.org>
parents:
diff changeset
1110 You can arrange to use your existing Emacs process as the editor for
Dave Love <fx@gnu.org>
parents:
diff changeset
1111 programs like @code{mail} by using the Emacs client and Emacs server
Dave Love <fx@gnu.org>
parents:
diff changeset
1112 programs. Here is how.
Dave Love <fx@gnu.org>
parents:
diff changeset
1113
Dave Love <fx@gnu.org>
parents:
diff changeset
1114 @cindex @code{TEXEDIT} environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1115 First, the preparation. Within Emacs, call the function
Dave Love <fx@gnu.org>
parents:
diff changeset
1116 @code{server-start}. (Your @file{.emacs} file can do this automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
1117 if you add the expression @code{(server-start)} to it.) Then, outside
Dave Love <fx@gnu.org>
parents:
diff changeset
1118 Emacs, set the @code{EDITOR} environment variable to @samp{emacsclient}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1119 (Note that some programs use a different environment variable; for
Dave Love <fx@gnu.org>
parents:
diff changeset
1120 example, to make @TeX{} use @samp{emacsclient}, you should set the
Dave Love <fx@gnu.org>
parents:
diff changeset
1121 @code{TEXEDIT} environment variable to @samp{emacsclient +%d %s}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1122
Dave Love <fx@gnu.org>
parents:
diff changeset
1123 @kindex C-x #
Dave Love <fx@gnu.org>
parents:
diff changeset
1124 @findex server-edit
Dave Love <fx@gnu.org>
parents:
diff changeset
1125 Then, whenever any program invokes your specified @code{EDITOR}
Dave Love <fx@gnu.org>
parents:
diff changeset
1126 program, the effect is to send a message to your principal Emacs telling
Dave Love <fx@gnu.org>
parents:
diff changeset
1127 it to visit a file. (That's what the program @code{emacsclient} does.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1128 Emacs displays the buffer immediately and you can immediately begin
Dave Love <fx@gnu.org>
parents:
diff changeset
1129 editing it.
Dave Love <fx@gnu.org>
parents:
diff changeset
1130
Dave Love <fx@gnu.org>
parents:
diff changeset
1131 When you've finished editing that buffer, type @kbd{C-x #}
Dave Love <fx@gnu.org>
parents:
diff changeset
1132 (@code{server-edit}). This saves the file and sends a message back to
Dave Love <fx@gnu.org>
parents:
diff changeset
1133 the @code{emacsclient} program telling it to exit. The programs that
Dave Love <fx@gnu.org>
parents:
diff changeset
1134 use @code{EDITOR} wait for the ``editor'' (actually, @code{emacsclient})
Dave Love <fx@gnu.org>
parents:
diff changeset
1135 to exit. @kbd{C-x #} also checks for other pending external requests
Dave Love <fx@gnu.org>
parents:
diff changeset
1136 to edit various files, and selects the next such file.
Dave Love <fx@gnu.org>
parents:
diff changeset
1137
Dave Love <fx@gnu.org>
parents:
diff changeset
1138 You can switch to a server buffer manually if you wish; you don't have
Dave Love <fx@gnu.org>
parents:
diff changeset
1139 to arrive at it with @kbd{C-x #}. But @kbd{C-x #} is the only way to
Dave Love <fx@gnu.org>
parents:
diff changeset
1140 say that you are ``finished'' with one.
Dave Love <fx@gnu.org>
parents:
diff changeset
1141
Dave Love <fx@gnu.org>
parents:
diff changeset
1142 @vindex server-window
Dave Love <fx@gnu.org>
parents:
diff changeset
1143 If you set the variable @code{server-window} to a window or a frame,
Dave Love <fx@gnu.org>
parents:
diff changeset
1144 @kbd{C-x #} displays the server buffer in that window or in that frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
1145
Dave Love <fx@gnu.org>
parents:
diff changeset
1146 While @code{mail} or another application is waiting for
Dave Love <fx@gnu.org>
parents:
diff changeset
1147 @code{emacsclient} to finish, @code{emacsclient} does not read terminal
Dave Love <fx@gnu.org>
parents:
diff changeset
1148 input. So the terminal that @code{mail} was using is effectively
Dave Love <fx@gnu.org>
parents:
diff changeset
1149 blocked for the duration. In order to edit with your principal Emacs,
Dave Love <fx@gnu.org>
parents:
diff changeset
1150 you need to be able to use it without using that terminal. There are
Dave Love <fx@gnu.org>
parents:
diff changeset
1151 two ways to do this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1152
Dave Love <fx@gnu.org>
parents:
diff changeset
1153 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
1154 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1155 Using a window system, run @code{mail} and the principal Emacs in two
Dave Love <fx@gnu.org>
parents:
diff changeset
1156 separate windows. While @code{mail} is waiting for @code{emacsclient},
Dave Love <fx@gnu.org>
parents:
diff changeset
1157 the window where it was running is blocked, but you can use Emacs by
Dave Love <fx@gnu.org>
parents:
diff changeset
1158 switching windows.
Dave Love <fx@gnu.org>
parents:
diff changeset
1159
Dave Love <fx@gnu.org>
parents:
diff changeset
1160 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1161 Use Shell mode in Emacs to run the other program such as @code{mail};
Dave Love <fx@gnu.org>
parents:
diff changeset
1162 then, @code{emacsclient} blocks only the subshell under Emacs, and you
Dave Love <fx@gnu.org>
parents:
diff changeset
1163 can still use Emacs to edit the file.
Dave Love <fx@gnu.org>
parents:
diff changeset
1164 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
1165
Dave Love <fx@gnu.org>
parents:
diff changeset
1166 @vindex server-temp-file-regexp
Dave Love <fx@gnu.org>
parents:
diff changeset
1167 Some programs write temporary files for you to edit. After you edit
Dave Love <fx@gnu.org>
parents:
diff changeset
1168 the temporary file, the program reads it back and deletes it. If the
Dave Love <fx@gnu.org>
parents:
diff changeset
1169 Emacs server is later asked to edit the same file name, it should assume
Dave Love <fx@gnu.org>
parents:
diff changeset
1170 this has nothing to do with the previous occasion for that file name.
Dave Love <fx@gnu.org>
parents:
diff changeset
1171 The server accomplishes this by killing the temporary file's buffer when
Dave Love <fx@gnu.org>
parents:
diff changeset
1172 you finish with the file. Use the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1173 @code{server-temp-file-regexp} to specify which files are temporary in
Dave Love <fx@gnu.org>
parents:
diff changeset
1174 this sense; its value should be a regular expression that matches file
Dave Love <fx@gnu.org>
parents:
diff changeset
1175 names that are temporary.
Dave Love <fx@gnu.org>
parents:
diff changeset
1176
Dave Love <fx@gnu.org>
parents:
diff changeset
1177 If you run @code{emacsclient} with the option @samp{--no-wait}, it
Dave Love <fx@gnu.org>
parents:
diff changeset
1178 returns immediately without waiting for you to ``finish'' the buffer in
Dave Love <fx@gnu.org>
parents:
diff changeset
1179 Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
1180
27306
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1181 If you have forgotten to start Emacs, then the option
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1182 @samp{--alternate-editor=@var{command}} may be useful. It specifies a
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1183 command to run if @code{emacsclient} fails to contact Emacs. For
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1184 example, the following setting for the @var{EDITOR} environment variable
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1185 will always give an editor, even if Emacs is not running.
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1186
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1187 @example
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1188 EDITOR="emacsclient --alternate-editor vi +%d %s"
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1189 @end example
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1190
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1191 The environment variable @var{ALTERNATE_EDITOR} has the same effect, but
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1192 the value of the @samp{--alternate-editor} takes precedence.
e800c7e35912 New option --alternate-editor for emacsclient.
Gerd Moellmann <gerd@gnu.org>
parents: 27210
diff changeset
1193
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1194 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1195 * Invoking emacsclient::
Dave Love <fx@gnu.org>
parents:
diff changeset
1196 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1197
Dave Love <fx@gnu.org>
parents:
diff changeset
1198 @node Invoking emacsclient,, Emacs Server, Emacs Server
Dave Love <fx@gnu.org>
parents:
diff changeset
1199 @section Invoking @code{emacsclient}
Dave Love <fx@gnu.org>
parents:
diff changeset
1200
Dave Love <fx@gnu.org>
parents:
diff changeset
1201 To run the @code{emacsclient} program, specify file names as arguments,
Dave Love <fx@gnu.org>
parents:
diff changeset
1202 and optionally line numbers as well. Do it like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1203
Dave Love <fx@gnu.org>
parents:
diff changeset
1204 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1205 emacsclient @r{@{}@r{[}+@var{line}@r{]} @var{filename}@r{@}}@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1206 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1207
Dave Love <fx@gnu.org>
parents:
diff changeset
1208 This tells Emacs to visit each of the specified files; if you specify a
Dave Love <fx@gnu.org>
parents:
diff changeset
1209 line number for a certain file, Emacs moves to that line in the file.
Dave Love <fx@gnu.org>
parents:
diff changeset
1210
Dave Love <fx@gnu.org>
parents:
diff changeset
1211 Ordinarily, @code{emacsclient} does not return until you use the
Dave Love <fx@gnu.org>
parents:
diff changeset
1212 @kbd{C-x #} command on each of these buffers. When that happens, Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
1213 sends a message to the @code{emacsclient} program telling it to return.
Dave Love <fx@gnu.org>
parents:
diff changeset
1214
Dave Love <fx@gnu.org>
parents:
diff changeset
1215 But if you use the option @samp{-n} or @samp{--no-wait} when running
Dave Love <fx@gnu.org>
parents:
diff changeset
1216 @code{emacsclient}, then it returns immediately. (You can take as long
Dave Love <fx@gnu.org>
parents:
diff changeset
1217 as you like to edit the files in Emacs.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1218
Dave Love <fx@gnu.org>
parents:
diff changeset
1219
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1220 @node Hardcopy, PostScript, Emacs Server, Top
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1221 @section Hardcopy Output
Dave Love <fx@gnu.org>
parents:
diff changeset
1222 @cindex hardcopy
Dave Love <fx@gnu.org>
parents:
diff changeset
1223
Dave Love <fx@gnu.org>
parents:
diff changeset
1224 The Emacs commands for making hardcopy let you print either an entire
Dave Love <fx@gnu.org>
parents:
diff changeset
1225 buffer or just part of one, either with or without page headers.
Dave Love <fx@gnu.org>
parents:
diff changeset
1226 See also the hardcopy commands of Dired (@pxref{Misc File Ops})
Dave Love <fx@gnu.org>
parents:
diff changeset
1227 and the diary (@pxref{Diary Commands}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1228
Dave Love <fx@gnu.org>
parents:
diff changeset
1229 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1230 @item M-x print-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1231 Print hardcopy of current buffer with page headings containing the file
Dave Love <fx@gnu.org>
parents:
diff changeset
1232 name and page number.
Dave Love <fx@gnu.org>
parents:
diff changeset
1233 @item M-x lpr-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1234 Print hardcopy of current buffer without page headings.
Dave Love <fx@gnu.org>
parents:
diff changeset
1235 @item M-x print-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1236 Like @code{print-buffer} but print only the current region.
Dave Love <fx@gnu.org>
parents:
diff changeset
1237 @item M-x lpr-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1238 Like @code{lpr-buffer} but print only the current region.
Dave Love <fx@gnu.org>
parents:
diff changeset
1239 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1240
Dave Love <fx@gnu.org>
parents:
diff changeset
1241 @findex print-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1242 @findex print-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1243 @findex lpr-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1244 @findex lpr-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1245 @vindex lpr-switches
Dave Love <fx@gnu.org>
parents:
diff changeset
1246 The hardcopy commands (aside from the Postscript commands) pass extra
Dave Love <fx@gnu.org>
parents:
diff changeset
1247 switches to the @code{lpr} program based on the value of the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1248 @code{lpr-switches}. Its value should be a list of strings, each string
Dave Love <fx@gnu.org>
parents:
diff changeset
1249 an option starting with @samp{-}. For example, to specify a line width
Dave Love <fx@gnu.org>
parents:
diff changeset
1250 of 80 columns for all the printing you do in Emacs, set
Dave Love <fx@gnu.org>
parents:
diff changeset
1251 @code{lpr-switches} like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1252
Dave Love <fx@gnu.org>
parents:
diff changeset
1253 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1254 (setq lpr-switches '("-w80"))
Dave Love <fx@gnu.org>
parents:
diff changeset
1255 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1256
Dave Love <fx@gnu.org>
parents:
diff changeset
1257 @vindex printer-name
Dave Love <fx@gnu.org>
parents:
diff changeset
1258 You can specify the printer to use by setting the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1259 @code{printer-name}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1260
Dave Love <fx@gnu.org>
parents:
diff changeset
1261 @vindex lpr-headers-switches
Dave Love <fx@gnu.org>
parents:
diff changeset
1262 @vindex lpr-commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1263 @vindex lpr-add-switches
Dave Love <fx@gnu.org>
parents:
diff changeset
1264 The variable @code{lpr-command} specifies the name of the printer
Dave Love <fx@gnu.org>
parents:
diff changeset
1265 program to run; the default value depends on your operating system type.
Dave Love <fx@gnu.org>
parents:
diff changeset
1266 On most systems, the default is @code{"lpr"}. The variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1267 @code{lpr-headers-switches} similarly specifies the extra switches to
Dave Love <fx@gnu.org>
parents:
diff changeset
1268 use to make page headers. The variable @code{lpr-add-switches} controls
Dave Love <fx@gnu.org>
parents:
diff changeset
1269 whether to supply @samp{-T} and @samp{-J} options (suitable for
Dave Love <fx@gnu.org>
parents:
diff changeset
1270 @code{lpr}) to the printer program: @code{nil} means don't add them.
Dave Love <fx@gnu.org>
parents:
diff changeset
1271 @code{lpr-add-switches} should be @code{nil} if your printer program is
Dave Love <fx@gnu.org>
parents:
diff changeset
1272 not compatible with @code{lpr}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1273
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1274 @node PostScript, PostScript Variables, Hardcopy, Top
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1275 @section PostScript Hardcopy
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1276
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1277 These commands convert buffer contents to PostScript,
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1278 either printing it or leaving it in another Emacs buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1279
Dave Love <fx@gnu.org>
parents:
diff changeset
1280 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1281 @item M-x ps-print-buffer
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1282 Print hardcopy of the current buffer in PostScript form.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1283 @item M-x ps-print-region
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1284 Print hardcopy of the current region in PostScript form.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1285 @item M-x ps-print-buffer-with-faces
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1286 Print hardcopy of the current buffer in PostScript form, showing the
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1287 faces used in the text by means of PostScript features.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1288 @item M-x ps-print-region-with-faces
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1289 Print hardcopy of the current region in PostScript form, showing the
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1290 faces used in the text.
Dave Love <fx@gnu.org>
parents:
diff changeset
1291 @item M-x ps-spool-buffer
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1292 Generate PostScript for the current buffer text.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1293 @item M-x ps-spool-region
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1294 Generate PostScript for the current region.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1295 @item M-x ps-spool-buffer-with-faces
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1296 Generate PostScript for the current buffer, showing the faces used.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1297 @item M-x ps-spool-region-with-faces
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1298 Generate PostScript for the current region, showing the faces used.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1299 @item M-x handwrite
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1300 Generates/prints PostScript for the current buffer as if handwritten.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1301 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1302
Dave Love <fx@gnu.org>
parents:
diff changeset
1303 @findex ps-print-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1304 @findex ps-print-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1305 @findex ps-print-region-with-faces
Dave Love <fx@gnu.org>
parents:
diff changeset
1306 @findex ps-print-buffer-with-faces
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1307 The PostScript commands, @code{ps-print-buffer} and
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1308 @code{ps-print-region}, print buffer contents in PostScript form. One
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1309 command prints the entire buffer; the other, just the region. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1310 corresponding @samp{-with-faces} commands,
Dave Love <fx@gnu.org>
parents:
diff changeset
1311 @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
1312 use PostScript features to show the faces (fonts and colors) in the text
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1313 properties of the text being printed.
Dave Love <fx@gnu.org>
parents:
diff changeset
1314
Dave Love <fx@gnu.org>
parents:
diff changeset
1315 If you are using a color display, you can print a buffer of program
Dave Love <fx@gnu.org>
parents:
diff changeset
1316 code with color highlighting by turning on Font-Lock mode in that
Dave Love <fx@gnu.org>
parents:
diff changeset
1317 buffer, and using @code{ps-print-buffer-with-faces}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1318
Dave Love <fx@gnu.org>
parents:
diff changeset
1319 @findex ps-spool-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1320 @findex ps-spool-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1321 @findex ps-spool-region-with-faces
Dave Love <fx@gnu.org>
parents:
diff changeset
1322 @findex ps-spool-buffer-with-faces
Dave Love <fx@gnu.org>
parents:
diff changeset
1323 The commands whose names have @samp{spool} instead of @samp{print}
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1324 generate the PostScript output in an Emacs buffer instead of sending
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1325 it to the printer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1326
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1327 @findex handwrite
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1328 @cindex handwriting
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1329 @kbd{M-x handwrite} is more frivolous. It generates a PostScript
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1330 rendition of the current buffer as a cursive handwritten document. It
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1331 can be customized in group @code{handwrite}.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1332
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1333 @ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
1334 The following section describes variables for customizing these commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
1335 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
1336
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1337 @node PostScript Variables, Sorting, PostScript, Top
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1338 @section Variables for PostScript Hardcopy
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1339
Dave Love <fx@gnu.org>
parents:
diff changeset
1340 @vindex ps-lpr-command
Dave Love <fx@gnu.org>
parents:
diff changeset
1341 @vindex ps-lpr-switches
Dave Love <fx@gnu.org>
parents:
diff changeset
1342 @vindex ps-printer-name
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1343 All the PostScript hardcopy commands use the variables
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1344 @code{ps-lpr-command} and @code{ps-lpr-switches} to specify how to print
Dave Love <fx@gnu.org>
parents:
diff changeset
1345 the output. @code{ps-lpr-command} specifies the command name to run,
Dave Love <fx@gnu.org>
parents:
diff changeset
1346 @code{ps-lpr-switches} specifies command line options to use, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1347 @code{ps-printer-name} specifies the printer. If you don't set the
Dave Love <fx@gnu.org>
parents:
diff changeset
1348 first two variables yourself, they take their initial values from
Dave Love <fx@gnu.org>
parents:
diff changeset
1349 @code{lpr-command} and @code{lpr-switches}. If @code{ps-printer-name}
Dave Love <fx@gnu.org>
parents:
diff changeset
1350 is @code{nil}, @code{printer-name} is used.
Dave Love <fx@gnu.org>
parents:
diff changeset
1351
Dave Love <fx@gnu.org>
parents:
diff changeset
1352 @vindex ps-print-header
Dave Love <fx@gnu.org>
parents:
diff changeset
1353 @vindex ps-print-color-p
Dave Love <fx@gnu.org>
parents:
diff changeset
1354 The variable @code{ps-print-header} controls whether these commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1355 add header lines to each page---set it to @code{nil} to turn headers
Dave Love <fx@gnu.org>
parents:
diff changeset
1356 off. You can turn off color processing by setting
Dave Love <fx@gnu.org>
parents:
diff changeset
1357 @code{ps-print-color-p} to @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1358
Dave Love <fx@gnu.org>
parents:
diff changeset
1359 @vindex ps-paper-type
Dave Love <fx@gnu.org>
parents:
diff changeset
1360 @vindex ps-page-dimensions-database
Dave Love <fx@gnu.org>
parents:
diff changeset
1361 The variable @code{ps-paper-type} specifies which size of paper to
Dave Love <fx@gnu.org>
parents:
diff changeset
1362 format for; legitimate values include @code{a4}, @code{a3},
Dave Love <fx@gnu.org>
parents:
diff changeset
1363 @code{a4small}, @code{b4}, @code{b5}, @code{executive}, @code{ledger},
Dave Love <fx@gnu.org>
parents:
diff changeset
1364 @code{legal}, @code{letter}, @code{letter-small}, @code{statement},
Dave Love <fx@gnu.org>
parents:
diff changeset
1365 @code{tabloid}. The default is @code{letter}. You can define
Dave Love <fx@gnu.org>
parents:
diff changeset
1366 additional paper sizes by changing the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1367 @code{ps-page-dimensions-database}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1368
Dave Love <fx@gnu.org>
parents:
diff changeset
1369 @vindex ps-landscape-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1370 The variable @code{ps-landscape-mode} specifies the orientation of
Dave Love <fx@gnu.org>
parents:
diff changeset
1371 printing on the page. The default is @code{nil}, which stands for
Dave Love <fx@gnu.org>
parents:
diff changeset
1372 ``portrait'' mode. Any non-@code{nil} value specifies ``landscape''
Dave Love <fx@gnu.org>
parents:
diff changeset
1373 mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1374
Dave Love <fx@gnu.org>
parents:
diff changeset
1375 @vindex ps-number-of-columns
Dave Love <fx@gnu.org>
parents:
diff changeset
1376 The variable @code{ps-number-of-columns} specifies the number of
Dave Love <fx@gnu.org>
parents:
diff changeset
1377 columns; it takes effect in both landscape and portrait mode. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1378 default is 1.
Dave Love <fx@gnu.org>
parents:
diff changeset
1379
Dave Love <fx@gnu.org>
parents:
diff changeset
1380 @vindex ps-font-family
Dave Love <fx@gnu.org>
parents:
diff changeset
1381 @vindex ps-font-size
Dave Love <fx@gnu.org>
parents:
diff changeset
1382 @vindex ps-font-info-database
Dave Love <fx@gnu.org>
parents:
diff changeset
1383 The variable @code{ps-font-family} specifies which font family to use
Dave Love <fx@gnu.org>
parents:
diff changeset
1384 for printing ordinary text. Legitimate values include @code{Courier},
Dave Love <fx@gnu.org>
parents:
diff changeset
1385 @code{Helvetica}, @code{NewCenturySchlbk}, @code{Palatino} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1386 @code{Times}. The variable @code{ps-font-size} specifies the size of
Dave Love <fx@gnu.org>
parents:
diff changeset
1387 the font for ordinary text. It defaults to 8.5 points.
Dave Love <fx@gnu.org>
parents:
diff changeset
1388
Dave Love <fx@gnu.org>
parents:
diff changeset
1389 Many other customization variables for these commands are defined and
Dave Love <fx@gnu.org>
parents:
diff changeset
1390 described in the Lisp file @file{ps-print.el}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1391
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1392 @node Sorting, Narrowing, PostScript Variables, Top
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1393 @section Sorting Text
Dave Love <fx@gnu.org>
parents:
diff changeset
1394 @cindex sorting
Dave Love <fx@gnu.org>
parents:
diff changeset
1395
Dave Love <fx@gnu.org>
parents:
diff changeset
1396 Emacs provides several commands for sorting text in the buffer. All
Dave Love <fx@gnu.org>
parents:
diff changeset
1397 operate on the contents of the region (the text between point and the
Dave Love <fx@gnu.org>
parents:
diff changeset
1398 mark). They divide the text of the region into many @dfn{sort records},
Dave Love <fx@gnu.org>
parents:
diff changeset
1399 identify a @dfn{sort key} for each record, and then reorder the records
Dave Love <fx@gnu.org>
parents:
diff changeset
1400 into the order determined by the sort keys. The records are ordered so
Dave Love <fx@gnu.org>
parents:
diff changeset
1401 that their keys are in alphabetical order, or, for numeric sorting, in
Dave Love <fx@gnu.org>
parents:
diff changeset
1402 numeric order. In alphabetic sorting, all upper-case letters `A' through
Dave Love <fx@gnu.org>
parents:
diff changeset
1403 `Z' come before lower-case `a', in accord with the ASCII character
Dave Love <fx@gnu.org>
parents:
diff changeset
1404 sequence.
Dave Love <fx@gnu.org>
parents:
diff changeset
1405
Dave Love <fx@gnu.org>
parents:
diff changeset
1406 The various sort commands differ in how they divide the text into sort
Dave Love <fx@gnu.org>
parents:
diff changeset
1407 records and in which part of each record is used as the sort key. Most of
Dave Love <fx@gnu.org>
parents:
diff changeset
1408 the commands make each line a separate sort record, but some commands use
Dave Love <fx@gnu.org>
parents:
diff changeset
1409 paragraphs or pages as sort records. Most of the sort commands use each
Dave Love <fx@gnu.org>
parents:
diff changeset
1410 entire sort record as its own sort key, but some use only a portion of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1411 record as the sort key.
Dave Love <fx@gnu.org>
parents:
diff changeset
1412
Dave Love <fx@gnu.org>
parents:
diff changeset
1413 @findex sort-lines
Dave Love <fx@gnu.org>
parents:
diff changeset
1414 @findex sort-paragraphs
Dave Love <fx@gnu.org>
parents:
diff changeset
1415 @findex sort-pages
Dave Love <fx@gnu.org>
parents:
diff changeset
1416 @findex sort-fields
Dave Love <fx@gnu.org>
parents:
diff changeset
1417 @findex sort-numeric-fields
27469
98f24cb3efa5 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27306
diff changeset
1418 @vindex sort-numeric-base
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 @item M-x sort-lines
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 Divide the region into lines, and sort by comparing the entire
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 text of a line. A numeric argument means sort into descending order.
Dave Love <fx@gnu.org>
parents:
diff changeset
1423
Dave Love <fx@gnu.org>
parents:
diff changeset
1424 @item M-x sort-paragraphs
Dave Love <fx@gnu.org>
parents:
diff changeset
1425 Divide the region into paragraphs, and sort by comparing the entire
Dave Love <fx@gnu.org>
parents:
diff changeset
1426 text of a paragraph (except for leading blank lines). A numeric
Dave Love <fx@gnu.org>
parents:
diff changeset
1427 argument means sort into descending order.
Dave Love <fx@gnu.org>
parents:
diff changeset
1428
Dave Love <fx@gnu.org>
parents:
diff changeset
1429 @item M-x sort-pages
Dave Love <fx@gnu.org>
parents:
diff changeset
1430 Divide the region into pages, and sort by comparing the entire
Dave Love <fx@gnu.org>
parents:
diff changeset
1431 text of a page (except for leading blank lines). A numeric
Dave Love <fx@gnu.org>
parents:
diff changeset
1432 argument means sort into descending order.
Dave Love <fx@gnu.org>
parents:
diff changeset
1433
Dave Love <fx@gnu.org>
parents:
diff changeset
1434 @item M-x sort-fields
Dave Love <fx@gnu.org>
parents:
diff changeset
1435 Divide the region into lines, and sort by comparing the contents of
Dave Love <fx@gnu.org>
parents:
diff changeset
1436 one field in each line. Fields are defined as separated by
Dave Love <fx@gnu.org>
parents:
diff changeset
1437 whitespace, so the first run of consecutive non-whitespace characters
Dave Love <fx@gnu.org>
parents:
diff changeset
1438 in a line constitutes field 1, the second such run constitutes field
Dave Love <fx@gnu.org>
parents:
diff changeset
1439 2, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1440
Dave Love <fx@gnu.org>
parents:
diff changeset
1441 Specify which field to sort by with a numeric argument: 1 to sort by
Dave Love <fx@gnu.org>
parents:
diff changeset
1442 field 1, etc. A negative argument means count fields from the right
Dave Love <fx@gnu.org>
parents:
diff changeset
1443 instead of from the left; thus, minus 1 means sort by the last field.
Dave Love <fx@gnu.org>
parents:
diff changeset
1444 If several lines have identical contents in the field being sorted, they
Dave Love <fx@gnu.org>
parents:
diff changeset
1445 keep same relative order that they had in the original buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1446
Dave Love <fx@gnu.org>
parents:
diff changeset
1447 @item M-x sort-numeric-fields
Dave Love <fx@gnu.org>
parents:
diff changeset
1448 Like @kbd{M-x sort-fields} except the specified field is converted
Dave Love <fx@gnu.org>
parents:
diff changeset
1449 to an integer for each line, and the numbers are compared. @samp{10}
Dave Love <fx@gnu.org>
parents:
diff changeset
1450 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
1451 considered as a number. By default, numbers are interpreted according
98f24cb3efa5 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27306
diff changeset
1452 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
1453 @samp{0} are interpreted as hexadecimal and octal, respectively.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1454
Dave Love <fx@gnu.org>
parents:
diff changeset
1455 @item M-x sort-columns
Dave Love <fx@gnu.org>
parents:
diff changeset
1456 Like @kbd{M-x sort-fields} except that the text within each line
Dave Love <fx@gnu.org>
parents:
diff changeset
1457 used for comparison comes from a fixed range of columns. See below
Dave Love <fx@gnu.org>
parents:
diff changeset
1458 for an explanation.
Dave Love <fx@gnu.org>
parents:
diff changeset
1459
Dave Love <fx@gnu.org>
parents:
diff changeset
1460 @item M-x reverse-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1461 Reverse the order of the lines in the region. This is useful for
Dave Love <fx@gnu.org>
parents:
diff changeset
1462 sorting into descending order by fields or columns, since those sort
Dave Love <fx@gnu.org>
parents:
diff changeset
1463 commands do not have a feature for doing that.
Dave Love <fx@gnu.org>
parents:
diff changeset
1464 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1465
Dave Love <fx@gnu.org>
parents:
diff changeset
1466 For example, if the buffer contains this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1467
Dave Love <fx@gnu.org>
parents:
diff changeset
1468 @smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1469 On systems where clash detection (locking of files being edited) is
Dave Love <fx@gnu.org>
parents:
diff changeset
1470 implemented, Emacs also checks the first time you modify a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1471 whether the file has changed on disk since it was last visited or
Dave Love <fx@gnu.org>
parents:
diff changeset
1472 saved. If it has, you are asked to confirm that you want to change
Dave Love <fx@gnu.org>
parents:
diff changeset
1473 the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1474 @end smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1475
Dave Love <fx@gnu.org>
parents:
diff changeset
1476 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1477 applying @kbd{M-x sort-lines} to the entire buffer produces this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1478
Dave Love <fx@gnu.org>
parents:
diff changeset
1479 @smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1480 On systems where clash detection (locking of files being edited) is
Dave Love <fx@gnu.org>
parents:
diff changeset
1481 implemented, Emacs also checks the first time you modify a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1482 saved. If it has, you are asked to confirm that you want to change
Dave Love <fx@gnu.org>
parents:
diff changeset
1483 the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1484 whether the file has changed on disk since it was last visited or
Dave Love <fx@gnu.org>
parents:
diff changeset
1485 @end smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1486
Dave Love <fx@gnu.org>
parents:
diff changeset
1487 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1488 where the upper-case @samp{O} sorts before all lower-case letters. If
Dave Love <fx@gnu.org>
parents:
diff changeset
1489 you use @kbd{C-u 2 M-x sort-fields} instead, you get this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1490
Dave Love <fx@gnu.org>
parents:
diff changeset
1491 @smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1492 implemented, Emacs also checks the first time you modify a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1493 saved. If it has, you are asked to confirm that you want to change
Dave Love <fx@gnu.org>
parents:
diff changeset
1494 the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1495 On systems where clash detection (locking of files being edited) is
Dave Love <fx@gnu.org>
parents:
diff changeset
1496 whether the file has changed on disk since it was last visited or
Dave Love <fx@gnu.org>
parents:
diff changeset
1497 @end smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1498
Dave Love <fx@gnu.org>
parents:
diff changeset
1499 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1500 where the sort keys were @samp{Emacs}, @samp{If}, @samp{buffer},
Dave Love <fx@gnu.org>
parents:
diff changeset
1501 @samp{systems} and @samp{the}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1502
Dave Love <fx@gnu.org>
parents:
diff changeset
1503 @findex sort-columns
Dave Love <fx@gnu.org>
parents:
diff changeset
1504 @kbd{M-x sort-columns} requires more explanation. You specify the
Dave Love <fx@gnu.org>
parents:
diff changeset
1505 columns by putting point at one of the columns and the mark at the other
Dave Love <fx@gnu.org>
parents:
diff changeset
1506 column. Because this means you cannot put point or the mark at the
Dave Love <fx@gnu.org>
parents:
diff changeset
1507 beginning of the first line of the text you want to sort, this command
Dave Love <fx@gnu.org>
parents:
diff changeset
1508 uses an unusual definition of `region': all of the line point is in is
Dave Love <fx@gnu.org>
parents:
diff changeset
1509 considered part of the region, and so is all of the line the mark is in,
Dave Love <fx@gnu.org>
parents:
diff changeset
1510 as well as all the lines in between.
Dave Love <fx@gnu.org>
parents:
diff changeset
1511
Dave Love <fx@gnu.org>
parents:
diff changeset
1512 For example, to sort a table by information found in columns 10 to 15,
Dave Love <fx@gnu.org>
parents:
diff changeset
1513 you could put the mark on column 10 in the first line of the table, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1514 point on column 15 in the last line of the table, and then run
Dave Love <fx@gnu.org>
parents:
diff changeset
1515 @code{sort-columns}. Equivalently, you could run it with the mark on
Dave Love <fx@gnu.org>
parents:
diff changeset
1516 column 15 in the first line and point on column 10 in the last line.
Dave Love <fx@gnu.org>
parents:
diff changeset
1517
Dave Love <fx@gnu.org>
parents:
diff changeset
1518 This can be thought of as sorting the rectangle specified by point and
Dave Love <fx@gnu.org>
parents:
diff changeset
1519 the mark, except that the text on each line to the left or right of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1520 rectangle moves along with the text inside the rectangle.
Dave Love <fx@gnu.org>
parents:
diff changeset
1521 @xref{Rectangles}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1522
Dave Love <fx@gnu.org>
parents:
diff changeset
1523 @vindex sort-fold-case
Dave Love <fx@gnu.org>
parents:
diff changeset
1524 Many of the sort commands ignore case differences when comparing, if
Dave Love <fx@gnu.org>
parents:
diff changeset
1525 @code{sort-fold-case} is non-@code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1526
Dave Love <fx@gnu.org>
parents:
diff changeset
1527 @node Narrowing, Two-Column, Sorting, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1528 @section Narrowing
Dave Love <fx@gnu.org>
parents:
diff changeset
1529 @cindex widening
Dave Love <fx@gnu.org>
parents:
diff changeset
1530 @cindex restriction
Dave Love <fx@gnu.org>
parents:
diff changeset
1531 @cindex narrowing
Dave Love <fx@gnu.org>
parents:
diff changeset
1532 @cindex accessible portion
Dave Love <fx@gnu.org>
parents:
diff changeset
1533
Dave Love <fx@gnu.org>
parents:
diff changeset
1534 @dfn{Narrowing} means focusing in on some portion of the buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
1535 making the rest temporarily inaccessible. The portion which you can
Dave Love <fx@gnu.org>
parents:
diff changeset
1536 still get to is called the @dfn{accessible portion}. Canceling the
Dave Love <fx@gnu.org>
parents:
diff changeset
1537 narrowing, which makes the entire buffer once again accessible, is
Dave Love <fx@gnu.org>
parents:
diff changeset
1538 called @dfn{widening}. The amount of narrowing in effect in a buffer at
Dave Love <fx@gnu.org>
parents:
diff changeset
1539 any time is called the buffer's @dfn{restriction}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1540
Dave Love <fx@gnu.org>
parents:
diff changeset
1541 Narrowing can make it easier to concentrate on a single subroutine or
Dave Love <fx@gnu.org>
parents:
diff changeset
1542 paragraph by eliminating clutter. It can also be used to restrict the
Dave Love <fx@gnu.org>
parents:
diff changeset
1543 range of operation of a replace command or repeating keyboard macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1544
Dave Love <fx@gnu.org>
parents:
diff changeset
1545 @c WideCommands
Dave Love <fx@gnu.org>
parents:
diff changeset
1546 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1547 @item C-x n n
Dave Love <fx@gnu.org>
parents:
diff changeset
1548 Narrow down to between point and mark (@code{narrow-to-region}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1549 @item C-x n w
Dave Love <fx@gnu.org>
parents:
diff changeset
1550 Widen to make the entire buffer accessible again (@code{widen}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1551 @item C-x n p
Dave Love <fx@gnu.org>
parents:
diff changeset
1552 Narrow down to the current page (@code{narrow-to-page}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1553 @item C-x n d
Dave Love <fx@gnu.org>
parents:
diff changeset
1554 Narrow down to the current defun (@code{narrow-to-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1555 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1556
Dave Love <fx@gnu.org>
parents:
diff changeset
1557 When you have narrowed down to a part of the buffer, that part appears
Dave Love <fx@gnu.org>
parents:
diff changeset
1558 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
1559 (motion commands won't go outside the accessible part), you can't change
Dave Love <fx@gnu.org>
parents:
diff changeset
1560 it in any way. However, it is not gone, and if you save the file all
Dave Love <fx@gnu.org>
parents:
diff changeset
1561 the inaccessible text will be saved. The word @samp{Narrow} appears in
Dave Love <fx@gnu.org>
parents:
diff changeset
1562 the mode line whenever narrowing is in effect.
Dave Love <fx@gnu.org>
parents:
diff changeset
1563
Dave Love <fx@gnu.org>
parents:
diff changeset
1564 @kindex C-x n n
Dave Love <fx@gnu.org>
parents:
diff changeset
1565 @findex narrow-to-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1566 The primary narrowing command is @kbd{C-x n n} (@code{narrow-to-region}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1567 It sets the current buffer's restrictions so that the text in the current
Dave Love <fx@gnu.org>
parents:
diff changeset
1568 region remains accessible but all text before the region or after the region
Dave Love <fx@gnu.org>
parents:
diff changeset
1569 is inaccessible. Point and mark do not change.
Dave Love <fx@gnu.org>
parents:
diff changeset
1570
Dave Love <fx@gnu.org>
parents:
diff changeset
1571 @kindex C-x n p
Dave Love <fx@gnu.org>
parents:
diff changeset
1572 @findex narrow-to-page
Dave Love <fx@gnu.org>
parents:
diff changeset
1573 @kindex C-x n d
Dave Love <fx@gnu.org>
parents:
diff changeset
1574 @findex narrow-to-defun
Dave Love <fx@gnu.org>
parents:
diff changeset
1575 Alternatively, use @kbd{C-x n p} (@code{narrow-to-page}) to narrow
Dave Love <fx@gnu.org>
parents:
diff changeset
1576 down to the current page. @xref{Pages}, for the definition of a page.
Dave Love <fx@gnu.org>
parents:
diff changeset
1577 @kbd{C-x n d} (@code{narrow-to-defun}) narrows down to the defun
Dave Love <fx@gnu.org>
parents:
diff changeset
1578 containing point (@pxref{Defuns}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1579
Dave Love <fx@gnu.org>
parents:
diff changeset
1580 @kindex C-x n w
Dave Love <fx@gnu.org>
parents:
diff changeset
1581 @findex widen
Dave Love <fx@gnu.org>
parents:
diff changeset
1582 The way to cancel narrowing is to widen with @kbd{C-x n w}
Dave Love <fx@gnu.org>
parents:
diff changeset
1583 (@code{widen}). This makes all text in the buffer accessible again.
Dave Love <fx@gnu.org>
parents:
diff changeset
1584
Dave Love <fx@gnu.org>
parents:
diff changeset
1585 You can get information on what part of the buffer you are narrowed down
Dave Love <fx@gnu.org>
parents:
diff changeset
1586 to using the @kbd{C-x =} command. @xref{Position Info}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1587
Dave Love <fx@gnu.org>
parents:
diff changeset
1588 Because narrowing can easily confuse users who do not understand it,
Dave Love <fx@gnu.org>
parents:
diff changeset
1589 @code{narrow-to-region} is normally a disabled command. Attempting to use
Dave Love <fx@gnu.org>
parents:
diff changeset
1590 this command asks for confirmation and gives you the option of enabling it;
Dave Love <fx@gnu.org>
parents:
diff changeset
1591 if you enable the command, confirmation will no longer be required for
Dave Love <fx@gnu.org>
parents:
diff changeset
1592 it. @xref{Disabling}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1593
Dave Love <fx@gnu.org>
parents:
diff changeset
1594 @node Two-Column, Editing Binary Files, Narrowing, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1595 @section Two-Column Editing
Dave Love <fx@gnu.org>
parents:
diff changeset
1596 @cindex two-column editing
Dave Love <fx@gnu.org>
parents:
diff changeset
1597 @cindex splitting columns
Dave Love <fx@gnu.org>
parents:
diff changeset
1598 @cindex columns, splitting
Dave Love <fx@gnu.org>
parents:
diff changeset
1599
Dave Love <fx@gnu.org>
parents:
diff changeset
1600 Two-column mode lets you conveniently edit two side-by-side columns of
Dave Love <fx@gnu.org>
parents:
diff changeset
1601 text. It uses two side-by-side windows, each showing its own
Dave Love <fx@gnu.org>
parents:
diff changeset
1602 buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1603
Dave Love <fx@gnu.org>
parents:
diff changeset
1604 There are three ways to enter two-column mode:
Dave Love <fx@gnu.org>
parents:
diff changeset
1605
Dave Love <fx@gnu.org>
parents:
diff changeset
1606 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
1607 @item @kbd{@key{F2} 2} or @kbd{C-x 6 2}
Dave Love <fx@gnu.org>
parents:
diff changeset
1608 @kindex F2 2
Dave Love <fx@gnu.org>
parents:
diff changeset
1609 @kindex C-x 6 2
Dave Love <fx@gnu.org>
parents:
diff changeset
1610 @findex 2C-two-columns
Dave Love <fx@gnu.org>
parents:
diff changeset
1611 Enter two-column mode with the current buffer on the left, and on the
Dave Love <fx@gnu.org>
parents:
diff changeset
1612 right, a buffer whose name is based on the current buffer's name
Dave Love <fx@gnu.org>
parents:
diff changeset
1613 (@code{2C-two-columns}). If the right-hand buffer doesn't already
Dave Love <fx@gnu.org>
parents:
diff changeset
1614 exist, it starts out empty; the current buffer's contents are not
Dave Love <fx@gnu.org>
parents:
diff changeset
1615 changed.
Dave Love <fx@gnu.org>
parents:
diff changeset
1616
Dave Love <fx@gnu.org>
parents:
diff changeset
1617 This command is appropriate when the current buffer is empty or contains
Dave Love <fx@gnu.org>
parents:
diff changeset
1618 just one column and you want to add another column.
Dave Love <fx@gnu.org>
parents:
diff changeset
1619
Dave Love <fx@gnu.org>
parents:
diff changeset
1620 @item @kbd{@key{F2} s} or @kbd{C-x 6 s}
Dave Love <fx@gnu.org>
parents:
diff changeset
1621 @kindex F2 s
Dave Love <fx@gnu.org>
parents:
diff changeset
1622 @kindex C-x 6 s
Dave Love <fx@gnu.org>
parents:
diff changeset
1623 @findex 2C-split
Dave Love <fx@gnu.org>
parents:
diff changeset
1624 Split the current buffer, which contains two-column text, into two
Dave Love <fx@gnu.org>
parents:
diff changeset
1625 buffers, and display them side by side (@code{2C-split}). The current
Dave Love <fx@gnu.org>
parents:
diff changeset
1626 buffer becomes the left-hand buffer, but the text in the right-hand
Dave Love <fx@gnu.org>
parents:
diff changeset
1627 column is moved into the right-hand buffer. The current column
Dave Love <fx@gnu.org>
parents:
diff changeset
1628 specifies the split point. Splitting starts with the current line and
Dave Love <fx@gnu.org>
parents:
diff changeset
1629 continues to the end of the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1630
Dave Love <fx@gnu.org>
parents:
diff changeset
1631 This command is appropriate when you have a buffer that already contains
Dave Love <fx@gnu.org>
parents:
diff changeset
1632 two-column text, and you wish to separate the columns temporarily.
Dave Love <fx@gnu.org>
parents:
diff changeset
1633
Dave Love <fx@gnu.org>
parents:
diff changeset
1634 @item @kbd{@key{F2} b @var{buffer} @key{RET}}
Dave Love <fx@gnu.org>
parents:
diff changeset
1635 @itemx @kbd{C-x 6 b @var{buffer} @key{RET}}
Dave Love <fx@gnu.org>
parents:
diff changeset
1636 @kindex F2 b
Dave Love <fx@gnu.org>
parents:
diff changeset
1637 @kindex C-x 6 b
Dave Love <fx@gnu.org>
parents:
diff changeset
1638 @findex 2C-associate-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1639 Enter two-column mode using the current buffer as the left-hand buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
1640 and using buffer @var{buffer} as the right-hand buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1641 (@code{2C-associate-buffer}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1642 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1643
Dave Love <fx@gnu.org>
parents:
diff changeset
1644 @kbd{@key{F2} s} or @kbd{C-x 6 s} looks for a column separator, which
Dave Love <fx@gnu.org>
parents:
diff changeset
1645 is a string that appears on each line between the two columns. You can
Dave Love <fx@gnu.org>
parents:
diff changeset
1646 specify the width of the separator with a numeric argument to
Dave Love <fx@gnu.org>
parents:
diff changeset
1647 @kbd{@key{F2} s}; that many characters, before point, constitute the
Dave Love <fx@gnu.org>
parents:
diff changeset
1648 separator string. By default, the width is 1, so the column separator
Dave Love <fx@gnu.org>
parents:
diff changeset
1649 is the character before point.
Dave Love <fx@gnu.org>
parents:
diff changeset
1650
Dave Love <fx@gnu.org>
parents:
diff changeset
1651 When a line has the separator at the proper place, @kbd{@key{F2} s}
Dave Love <fx@gnu.org>
parents:
diff changeset
1652 puts the text after the separator into the right-hand buffer, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1653 deletes the separator. Lines that don't have the column separator at
Dave Love <fx@gnu.org>
parents:
diff changeset
1654 the proper place remain unsplit; they stay in the left-hand buffer, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1655 the right-hand buffer gets an empty line to correspond. (This is the
Dave Love <fx@gnu.org>
parents:
diff changeset
1656 way to write a line that ``spans both columns while in two-column
Dave Love <fx@gnu.org>
parents:
diff changeset
1657 mode'': write it in the left-hand buffer, and put an empty line in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1658 right-hand buffer.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1659
Dave Love <fx@gnu.org>
parents:
diff changeset
1660 @kindex F2 RET
Dave Love <fx@gnu.org>
parents:
diff changeset
1661 @kindex C-x 6 RET
Dave Love <fx@gnu.org>
parents:
diff changeset
1662 @findex 2C-newline
Dave Love <fx@gnu.org>
parents:
diff changeset
1663 The command @kbd{C-x 6 @key{RET}} or @kbd{@key{F2} @key{RET}}
Dave Love <fx@gnu.org>
parents:
diff changeset
1664 (@code{2C-newline}) inserts a newline in each of the two buffers at
Dave Love <fx@gnu.org>
parents:
diff changeset
1665 corresponding positions. This is the easiest way to add a new line to
Dave Love <fx@gnu.org>
parents:
diff changeset
1666 the two-column text while editing it in split buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
1667
Dave Love <fx@gnu.org>
parents:
diff changeset
1668 @kindex F2 1
Dave Love <fx@gnu.org>
parents:
diff changeset
1669 @kindex C-x 6 1
Dave Love <fx@gnu.org>
parents:
diff changeset
1670 @findex 2C-merge
Dave Love <fx@gnu.org>
parents:
diff changeset
1671 When you have edited both buffers as you wish, merge them with
Dave Love <fx@gnu.org>
parents:
diff changeset
1672 @kbd{@key{F2} 1} or @kbd{C-x 6 1} (@code{2C-merge}). This copies the
Dave Love <fx@gnu.org>
parents:
diff changeset
1673 text from the right-hand buffer as a second column in the other buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1674 To go back to two-column editing, use @kbd{@key{F2} s}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1675
Dave Love <fx@gnu.org>
parents:
diff changeset
1676 @kindex F2 d
Dave Love <fx@gnu.org>
parents:
diff changeset
1677 @kindex C-x 6 d
Dave Love <fx@gnu.org>
parents:
diff changeset
1678 @findex 2C-dissociate
Dave Love <fx@gnu.org>
parents:
diff changeset
1679 Use @kbd{@key{F2} d} or @kbd{C-x 6 d} to dissociate the two buffers,
Dave Love <fx@gnu.org>
parents:
diff changeset
1680 leaving each as it stands (@code{2C-dissociate}). If the other buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
1681 the one not current when you type @kbd{@key{F2} d}, is empty,
Dave Love <fx@gnu.org>
parents:
diff changeset
1682 @kbd{@key{F2} d} kills it.
Dave Love <fx@gnu.org>
parents:
diff changeset
1683
Dave Love <fx@gnu.org>
parents:
diff changeset
1684 @node Editing Binary Files, Saving Emacs Sessions, Two-Column, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1685 @section Editing Binary Files
Dave Love <fx@gnu.org>
parents:
diff changeset
1686
Dave Love <fx@gnu.org>
parents:
diff changeset
1687 @cindex Hexl mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1688 @cindex mode, Hexl
Dave Love <fx@gnu.org>
parents:
diff changeset
1689 @cindex editing binary files
Dave Love <fx@gnu.org>
parents:
diff changeset
1690 There is a special major mode for editing binary files: Hexl mode. To
Dave Love <fx@gnu.org>
parents:
diff changeset
1691 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
1692 the file. This command converts the file's contents to hexadecimal and
Dave Love <fx@gnu.org>
parents:
diff changeset
1693 lets you edit the translation. When you save the file, it is converted
Dave Love <fx@gnu.org>
parents:
diff changeset
1694 automatically back to binary.
Dave Love <fx@gnu.org>
parents:
diff changeset
1695
Dave Love <fx@gnu.org>
parents:
diff changeset
1696 You can also use @kbd{M-x hexl-mode} to translate an existing buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1697 into hex. This is useful if you visit a file normally and then discover
Dave Love <fx@gnu.org>
parents:
diff changeset
1698 it is a binary file.
Dave Love <fx@gnu.org>
parents:
diff changeset
1699
Dave Love <fx@gnu.org>
parents:
diff changeset
1700 Ordinary text characters overwrite in Hexl mode. This is to reduce
Dave Love <fx@gnu.org>
parents:
diff changeset
1701 the risk of accidentally spoiling the alignment of data in the file.
Dave Love <fx@gnu.org>
parents:
diff changeset
1702 There are special commands for insertion. Here is a list of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1703 commands of Hexl mode:
Dave Love <fx@gnu.org>
parents:
diff changeset
1704
Dave Love <fx@gnu.org>
parents:
diff changeset
1705 @c I don't think individual index entries for these commands are useful--RMS.
Dave Love <fx@gnu.org>
parents:
diff changeset
1706 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1707 @item C-M-d
Dave Love <fx@gnu.org>
parents:
diff changeset
1708 Insert a byte with a code typed in decimal.
Dave Love <fx@gnu.org>
parents:
diff changeset
1709
Dave Love <fx@gnu.org>
parents:
diff changeset
1710 @item C-M-o
Dave Love <fx@gnu.org>
parents:
diff changeset
1711 Insert a byte with a code typed in octal.
Dave Love <fx@gnu.org>
parents:
diff changeset
1712
Dave Love <fx@gnu.org>
parents:
diff changeset
1713 @item C-M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
1714 Insert a byte with a code typed in hex.
Dave Love <fx@gnu.org>
parents:
diff changeset
1715
Dave Love <fx@gnu.org>
parents:
diff changeset
1716 @item C-x [
Dave Love <fx@gnu.org>
parents:
diff changeset
1717 Move to the beginning of a 1k-byte ``page.''
Dave Love <fx@gnu.org>
parents:
diff changeset
1718
Dave Love <fx@gnu.org>
parents:
diff changeset
1719 @item C-x ]
Dave Love <fx@gnu.org>
parents:
diff changeset
1720 Move to the end of a 1k-byte ``page.''
Dave Love <fx@gnu.org>
parents:
diff changeset
1721
Dave Love <fx@gnu.org>
parents:
diff changeset
1722 @item M-g
Dave Love <fx@gnu.org>
parents:
diff changeset
1723 Move to an address specified in hex.
Dave Love <fx@gnu.org>
parents:
diff changeset
1724
Dave Love <fx@gnu.org>
parents:
diff changeset
1725 @item M-j
Dave Love <fx@gnu.org>
parents:
diff changeset
1726 Move to an address specified in decimal.
Dave Love <fx@gnu.org>
parents:
diff changeset
1727
Dave Love <fx@gnu.org>
parents:
diff changeset
1728 @item C-c C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
1729 Leave Hexl mode, going back to the major mode this buffer had before you
Dave Love <fx@gnu.org>
parents:
diff changeset
1730 invoked @code{hexl-mode}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1731 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1732
Dave Love <fx@gnu.org>
parents:
diff changeset
1733 @node Saving Emacs Sessions, Recursive Edit, Editing Binary Files, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1734 @section Saving Emacs Sessions
Dave Love <fx@gnu.org>
parents:
diff changeset
1735 @cindex saving sessions
Dave Love <fx@gnu.org>
parents:
diff changeset
1736 @cindex desktop
Dave Love <fx@gnu.org>
parents:
diff changeset
1737
Dave Love <fx@gnu.org>
parents:
diff changeset
1738 You can use the Desktop library to save the state of Emacs from one
Dave Love <fx@gnu.org>
parents:
diff changeset
1739 session to another. Saving the state means that Emacs starts up with
Dave Love <fx@gnu.org>
parents:
diff changeset
1740 the same set of buffers, major modes, buffer positions, and so on that
Dave Love <fx@gnu.org>
parents:
diff changeset
1741 the previous Emacs session had.
Dave Love <fx@gnu.org>
parents:
diff changeset
1742
Dave Love <fx@gnu.org>
parents:
diff changeset
1743 @vindex desktop-enable
Dave Love <fx@gnu.org>
parents:
diff changeset
1744 To use Desktop, you should use the Customization buffer (@pxref{Easy
Dave Love <fx@gnu.org>
parents:
diff changeset
1745 Customization}) to set @code{desktop-enable} to a non-@code{nil} value,
Dave Love <fx@gnu.org>
parents:
diff changeset
1746 or add these lines at the end of your @file{.emacs} file:
Dave Love <fx@gnu.org>
parents:
diff changeset
1747
Dave Love <fx@gnu.org>
parents:
diff changeset
1748 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1749 (desktop-load-default)
Dave Love <fx@gnu.org>
parents:
diff changeset
1750 (desktop-read)
Dave Love <fx@gnu.org>
parents:
diff changeset
1751 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1752
Dave Love <fx@gnu.org>
parents:
diff changeset
1753 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1754 @findex desktop-save
Dave Love <fx@gnu.org>
parents:
diff changeset
1755 The first time you save the state of the Emacs session, you must do it
Dave Love <fx@gnu.org>
parents:
diff changeset
1756 manually, with the command @kbd{M-x desktop-save}. Once you have done
Dave Love <fx@gnu.org>
parents:
diff changeset
1757 that, exiting Emacs will save the state again---not only the present
Dave Love <fx@gnu.org>
parents:
diff changeset
1758 Emacs session, but also subsequent sessions. You can also save the
Dave Love <fx@gnu.org>
parents:
diff changeset
1759 state at any time, without exiting Emacs, by typing @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
1760 desktop-save} again.
Dave Love <fx@gnu.org>
parents:
diff changeset
1761
Dave Love <fx@gnu.org>
parents:
diff changeset
1762 In order for Emacs to recover the state from a previous session, you
Dave Love <fx@gnu.org>
parents:
diff changeset
1763 must start it with the same current directory as you used when you
Dave Love <fx@gnu.org>
parents:
diff changeset
1764 started the previous session. This is because @code{desktop-read} looks
Dave Love <fx@gnu.org>
parents:
diff changeset
1765 in the current directory for the file to read. This means that you can
Dave Love <fx@gnu.org>
parents:
diff changeset
1766 have separate saved sessions in different directories; the directory in
Dave Love <fx@gnu.org>
parents:
diff changeset
1767 which you start Emacs will control which saved session to use.
Dave Love <fx@gnu.org>
parents:
diff changeset
1768
Dave Love <fx@gnu.org>
parents:
diff changeset
1769 @vindex desktop-files-not-to-save
Dave Love <fx@gnu.org>
parents:
diff changeset
1770 The variable @code{desktop-files-not-to-save} controls which files are
Dave Love <fx@gnu.org>
parents:
diff changeset
1771 excluded from state saving. Its value is a regular expression that
Dave Love <fx@gnu.org>
parents:
diff changeset
1772 matches the files to exclude. By default, remote (ftp-accessed) files
Dave Love <fx@gnu.org>
parents:
diff changeset
1773 are excluded; this is because visiting them again in the subsequent
Dave Love <fx@gnu.org>
parents:
diff changeset
1774 session would be slow. If you want to include these files in state
Dave Love <fx@gnu.org>
parents:
diff changeset
1775 saving, set @code{desktop-files-not-to-save} to @code{"^$"}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1776 @xref{Remote Files}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1777
Dave Love <fx@gnu.org>
parents:
diff changeset
1778 @node Recursive Edit, Emulation, Saving Emacs Sessions, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1779 @section Recursive Editing Levels
Dave Love <fx@gnu.org>
parents:
diff changeset
1780 @cindex recursive editing level
Dave Love <fx@gnu.org>
parents:
diff changeset
1781 @cindex editing level, recursive
Dave Love <fx@gnu.org>
parents:
diff changeset
1782
Dave Love <fx@gnu.org>
parents:
diff changeset
1783 A @dfn{recursive edit} is a situation in which you are using Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
1784 commands to perform arbitrary editing while in the middle of another
Dave Love <fx@gnu.org>
parents:
diff changeset
1785 Emacs command. For example, when you type @kbd{C-r} inside of a
Dave Love <fx@gnu.org>
parents:
diff changeset
1786 @code{query-replace}, you enter a recursive edit in which you can change
Dave Love <fx@gnu.org>
parents:
diff changeset
1787 the current buffer. On exiting from the recursive edit, you go back to
Dave Love <fx@gnu.org>
parents:
diff changeset
1788 the @code{query-replace}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1789
Dave Love <fx@gnu.org>
parents:
diff changeset
1790 @kindex C-M-c
Dave Love <fx@gnu.org>
parents:
diff changeset
1791 @findex exit-recursive-edit
Dave Love <fx@gnu.org>
parents:
diff changeset
1792 @cindex exiting recursive edit
Dave Love <fx@gnu.org>
parents:
diff changeset
1793 @dfn{Exiting} the recursive edit means returning to the unfinished
Dave Love <fx@gnu.org>
parents:
diff changeset
1794 command, which continues execution. The command to exit is @kbd{C-M-c}
Dave Love <fx@gnu.org>
parents:
diff changeset
1795 (@code{exit-recursive-edit}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1796
Dave Love <fx@gnu.org>
parents:
diff changeset
1797 You can also @dfn{abort} the recursive edit. This is like exiting,
Dave Love <fx@gnu.org>
parents:
diff changeset
1798 but also quits the unfinished command immediately. Use the command
Dave Love <fx@gnu.org>
parents:
diff changeset
1799 @kbd{C-]} (@code{abort-recursive-edit}) to do this. @xref{Quitting}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1800
Dave Love <fx@gnu.org>
parents:
diff changeset
1801 The mode line shows you when you are in a recursive edit by displaying
Dave Love <fx@gnu.org>
parents:
diff changeset
1802 square brackets around the parentheses that always surround the major and
Dave Love <fx@gnu.org>
parents:
diff changeset
1803 minor mode names. Every window's mode line shows this, in the same way,
Dave Love <fx@gnu.org>
parents:
diff changeset
1804 since being in a recursive edit is true of Emacs as a whole rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
1805 any particular window or buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1806
Dave Love <fx@gnu.org>
parents:
diff changeset
1807 It is possible to be in recursive edits within recursive edits. For
Dave Love <fx@gnu.org>
parents:
diff changeset
1808 example, after typing @kbd{C-r} in a @code{query-replace}, you may type a
Dave Love <fx@gnu.org>
parents:
diff changeset
1809 command that enters the debugger. This begins a recursive editing level
Dave Love <fx@gnu.org>
parents:
diff changeset
1810 for the debugger, within the recursive editing level for @kbd{C-r}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1811 Mode lines display a pair of square brackets for each recursive editing
Dave Love <fx@gnu.org>
parents:
diff changeset
1812 level currently in progress.
Dave Love <fx@gnu.org>
parents:
diff changeset
1813
Dave Love <fx@gnu.org>
parents:
diff changeset
1814 Exiting the inner recursive edit (such as, with the debugger @kbd{c}
Dave Love <fx@gnu.org>
parents:
diff changeset
1815 command) resumes the command running in the next level up. When that
Dave Love <fx@gnu.org>
parents:
diff changeset
1816 command finishes, you can then use @kbd{C-M-c} to exit another recursive
Dave Love <fx@gnu.org>
parents:
diff changeset
1817 editing level, and so on. Exiting applies to the innermost level only.
Dave Love <fx@gnu.org>
parents:
diff changeset
1818 Aborting also gets out of only one level of recursive edit; it returns
Dave Love <fx@gnu.org>
parents:
diff changeset
1819 immediately to the command level of the previous recursive edit. If you
Dave Love <fx@gnu.org>
parents:
diff changeset
1820 wish, you can then abort the next recursive editing level.
Dave Love <fx@gnu.org>
parents:
diff changeset
1821
Dave Love <fx@gnu.org>
parents:
diff changeset
1822 Alternatively, the command @kbd{M-x top-level} aborts all levels of
Dave Love <fx@gnu.org>
parents:
diff changeset
1823 recursive edits, returning immediately to the top-level command reader.
Dave Love <fx@gnu.org>
parents:
diff changeset
1824
Dave Love <fx@gnu.org>
parents:
diff changeset
1825 The text being edited inside the recursive edit need not be the same text
Dave Love <fx@gnu.org>
parents:
diff changeset
1826 that you were editing at top level. It depends on what the recursive edit
Dave Love <fx@gnu.org>
parents:
diff changeset
1827 is for. If the command that invokes the recursive edit selects a different
Dave Love <fx@gnu.org>
parents:
diff changeset
1828 buffer first, that is the buffer you will edit recursively. In any case,
Dave Love <fx@gnu.org>
parents:
diff changeset
1829 you can switch buffers within the recursive edit in the normal manner (as
Dave Love <fx@gnu.org>
parents:
diff changeset
1830 long as the buffer-switching keys have not been rebound). You could
Dave Love <fx@gnu.org>
parents:
diff changeset
1831 probably do all the rest of your editing inside the recursive edit,
Dave Love <fx@gnu.org>
parents:
diff changeset
1832 visiting files and all. But this could have surprising effects (such as
Dave Love <fx@gnu.org>
parents:
diff changeset
1833 stack overflow) from time to time. So remember to exit or abort the
Dave Love <fx@gnu.org>
parents:
diff changeset
1834 recursive edit when you no longer need it.
Dave Love <fx@gnu.org>
parents:
diff changeset
1835
Dave Love <fx@gnu.org>
parents:
diff changeset
1836 In general, we try to minimize the use of recursive editing levels in
Dave Love <fx@gnu.org>
parents:
diff changeset
1837 GNU Emacs. This is because they constrain you to ``go back'' in a
Dave Love <fx@gnu.org>
parents:
diff changeset
1838 particular order---from the innermost level toward the top level. When
Dave Love <fx@gnu.org>
parents:
diff changeset
1839 possible, we present different activities in separate buffers so that
Dave Love <fx@gnu.org>
parents:
diff changeset
1840 you can switch between them as you please. Some commands switch to a
Dave Love <fx@gnu.org>
parents:
diff changeset
1841 new major mode which provides a command to switch back. These
Dave Love <fx@gnu.org>
parents:
diff changeset
1842 approaches give you more flexibility to go back to unfinished tasks in
Dave Love <fx@gnu.org>
parents:
diff changeset
1843 the order you choose.
Dave Love <fx@gnu.org>
parents:
diff changeset
1844
Dave Love <fx@gnu.org>
parents:
diff changeset
1845 @node Emulation, Dissociated Press, Recursive Edit, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1846 @section Emulation
Dave Love <fx@gnu.org>
parents:
diff changeset
1847 @cindex emulating other editors
Dave Love <fx@gnu.org>
parents:
diff changeset
1848 @cindex other editors
Dave Love <fx@gnu.org>
parents:
diff changeset
1849 @cindex EDT
Dave Love <fx@gnu.org>
parents:
diff changeset
1850 @cindex vi
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1851 @cindex CRiSP
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1852 @cindex Brief
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1853 @cindex PC keybindings
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1854 @cindex scrolling all windows
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1855 @cindex PC selecion
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1856 @cindex Motif keybindings
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1857 @cindex Macintosh keybindings
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1858 @cindex WordStar
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1859
Dave Love <fx@gnu.org>
parents:
diff changeset
1860 GNU Emacs can be programmed to emulate (more or less) most other
Dave Love <fx@gnu.org>
parents:
diff changeset
1861 editors. Standard facilities can emulate these:
Dave Love <fx@gnu.org>
parents:
diff changeset
1862
Dave Love <fx@gnu.org>
parents:
diff changeset
1863 @table @asis
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1864 @item CRiSP/Brief (PC editor)
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1865 @findex crisp-mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1866 @vindex crisp-override-meta-x
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1867 @findex scroll-all-mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1868 Turn on keybindings to emulate the CRiSP/Brief editor with @kbd{M-x
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1869 crisp-mode}. Note that this rebinds @kbd{M-x} to exit Emacs unless you
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1870 change the user option @code{crisp-override-meta-x}. You can also load
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1871 the @code{scroll-all} package to emulate CRiSP's scroll-all feature
28125
b1d15e69d22c Typo, copyright fix.
Dave Love <fx@gnu.org>
parents: 27469
diff changeset
1872 (scrolling all windows together). Do this either with @kbd{M-x
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1873 scroll-all-mode} or set the user option @code{crisp-load-scroll-all} to
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1874 load it along with @code{crisp-mode}.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1875
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1876 @item EDT (DEC VMS editor)
Dave Love <fx@gnu.org>
parents:
diff changeset
1877 @findex edt-emulation-on
Dave Love <fx@gnu.org>
parents:
diff changeset
1878 @findex edt-emulation-off
Dave Love <fx@gnu.org>
parents:
diff changeset
1879 Turn on EDT emulation with @kbd{M-x edt-emulation-on}. @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
1880 edt-emulation-off} restores normal Emacs command bindings.
Dave Love <fx@gnu.org>
parents:
diff changeset
1881
Dave Love <fx@gnu.org>
parents:
diff changeset
1882 Most of the EDT emulation commands are keypad keys, and most standard
Dave Love <fx@gnu.org>
parents:
diff changeset
1883 Emacs key bindings are still available. The EDT emulation rebindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1884 are done in the global keymap, so there is no problem switching
Dave Love <fx@gnu.org>
parents:
diff changeset
1885 buffers or major modes while in EDT emulation.
Dave Love <fx@gnu.org>
parents:
diff changeset
1886
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1887 @item `PC' bindings
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1888 @findex pc-bindings-mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1889 @kbd{M-x pc-bindings-mode} sets up certain key bindings for `PC
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1890 compatibility'---what people are often used to on PCs---as follows:
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1891 @kbd{Delete} and its variants) delete forward instead of backward,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1892 @kbd{C-Backspace} kills backward a word (as @kbd{C-Delete} normally
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1893 would), @kbd{M-Backspace} does undo, @kbd{Home} and @kbd{End} move to
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1894 beginning and end of line, @kbd{C-Home} and @kbd{C-End} move to
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1895 beginning and end of buffer and @kbd{C-Escape} does @code{list-buffers}.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1896
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1897 @item PC selection mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1898 @findex pc-selection-mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1899 @kbd{M-x pc-selction-mode} emulates the mark, copy, cut and paste
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1900 look-and-feel of Motif programs (which is the same as the Macintosh GUI
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1901 and MS-Windows). It makes the keybindings of PC mode and also modifies
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1902 the bindings of the cursor keys and the @kbd{next}, @kbd{prior},
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1903 @kbd{home} and @kbd{end} keys. It does not provide the full set of CUA
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1904 keybindings---the fundamental Emacs keys @kbd{C-c}, @kbd{C-v} and
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1905 @kbd{C-x} are not rebound.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1906
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1907 The standard keys for moving around (@kbd{right}, @kbd{left}, @kbd{up},
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1908 @kbd{down}, @kbd{home}, @kbd{end}, @kbd{prior}, @kbd{next}, called
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1909 ``move-keys'') will always de-activate the mark. Using @kbd{Shift}
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1910 together with the ``move keys'' activates the region over which they
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1911 move. The copy, cut and paste functions (as in many other programs)
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1912 operate on the active region, bound to @kbd{C-insert}, @kbd{S-delete}
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1913 and @kbd{S-insert} respectively.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1914
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1915 The @code{s-region} package provides similar, but less complete,
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1916 facilities.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1917
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1918 @item vi (Berkeley editor)
Dave Love <fx@gnu.org>
parents:
diff changeset
1919 @findex viper-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1920 Viper is the newest emulator for vi. It implements several levels of
Dave Love <fx@gnu.org>
parents:
diff changeset
1921 emulation; level 1 is closest to vi itself, while level 5 departs
Dave Love <fx@gnu.org>
parents:
diff changeset
1922 somewhat from strict emulation to take advantage of the capabilities of
Dave Love <fx@gnu.org>
parents:
diff changeset
1923 Emacs. To invoke Viper, type @kbd{M-x viper-mode}; it will guide you
Dave Love <fx@gnu.org>
parents:
diff changeset
1924 the rest of the way and ask for the emulation level. @inforef{Top,
Dave Love <fx@gnu.org>
parents:
diff changeset
1925 Viper, viper}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1926
Dave Love <fx@gnu.org>
parents:
diff changeset
1927 @item vi (another emulator)
Dave Love <fx@gnu.org>
parents:
diff changeset
1928 @findex vi-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1929 @kbd{M-x vi-mode} enters a major mode that replaces the previously
Dave Love <fx@gnu.org>
parents:
diff changeset
1930 established major mode. All of the vi commands that, in real vi, enter
Dave Love <fx@gnu.org>
parents:
diff changeset
1931 ``input'' mode are programmed instead to return to the previous major
Dave Love <fx@gnu.org>
parents:
diff changeset
1932 mode. Thus, ordinary Emacs serves as vi's ``input'' mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1933
Dave Love <fx@gnu.org>
parents:
diff changeset
1934 Because vi emulation works through major modes, it does not work
Dave Love <fx@gnu.org>
parents:
diff changeset
1935 to switch buffers during emulation. Return to normal Emacs first.
Dave Love <fx@gnu.org>
parents:
diff changeset
1936
Dave Love <fx@gnu.org>
parents:
diff changeset
1937 If you plan to use vi emulation much, you probably want to bind a key
Dave Love <fx@gnu.org>
parents:
diff changeset
1938 to the @code{vi-mode} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
1939
Dave Love <fx@gnu.org>
parents:
diff changeset
1940 @item vi (alternate emulator)
Dave Love <fx@gnu.org>
parents:
diff changeset
1941 @findex vip-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1942 @kbd{M-x vip-mode} invokes another vi emulator, said to resemble real vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1943 more thoroughly than @kbd{M-x vi-mode}. ``Input'' mode in this emulator
Dave Love <fx@gnu.org>
parents:
diff changeset
1944 is changed from ordinary Emacs so you can use @key{ESC} to go back to
Dave Love <fx@gnu.org>
parents:
diff changeset
1945 emulated vi command mode. To get from emulated vi command mode back to
Dave Love <fx@gnu.org>
parents:
diff changeset
1946 ordinary Emacs, type @kbd{C-z}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1947
Dave Love <fx@gnu.org>
parents:
diff changeset
1948 This emulation does not work through major modes, and it is possible
Dave Love <fx@gnu.org>
parents:
diff changeset
1949 to switch buffers in various ways within the emulator. It is not
Dave Love <fx@gnu.org>
parents:
diff changeset
1950 so necessary to assign a key to the command @code{vip-mode} as
Dave Love <fx@gnu.org>
parents:
diff changeset
1951 it is with @code{vi-mode} because terminating insert mode does
Dave Love <fx@gnu.org>
parents:
diff changeset
1952 not use it.
Dave Love <fx@gnu.org>
parents:
diff changeset
1953
Dave Love <fx@gnu.org>
parents:
diff changeset
1954 @inforef{Top, VIP, vip}, for full information.
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1955
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1956 @item WordStar (old wordprocessor)
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1957 @findex wordstar-mode
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1958 @kbd{M-x wordstar-mode} provides a major mode with WordStar-like
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
1959 keybindings.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1960 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1961
Dave Love <fx@gnu.org>
parents:
diff changeset
1962 @node Dissociated Press, Amusements, Emulation, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1963 @section Dissociated Press
Dave Love <fx@gnu.org>
parents:
diff changeset
1964
Dave Love <fx@gnu.org>
parents:
diff changeset
1965 @findex dissociated-press
Dave Love <fx@gnu.org>
parents:
diff changeset
1966 @kbd{M-x dissociated-press} is a command for scrambling a file of text
Dave Love <fx@gnu.org>
parents:
diff changeset
1967 either word by word or character by character. Starting from a buffer of
Dave Love <fx@gnu.org>
parents:
diff changeset
1968 straight English, it produces extremely amusing output. The input comes
Dave Love <fx@gnu.org>
parents:
diff changeset
1969 from the current Emacs buffer. Dissociated Press writes its output in a
Dave Love <fx@gnu.org>
parents:
diff changeset
1970 buffer named @samp{*Dissociation*}, and redisplays that buffer after every
Dave Love <fx@gnu.org>
parents:
diff changeset
1971 couple of lines (approximately) so you can read the output as it comes out.
Dave Love <fx@gnu.org>
parents:
diff changeset
1972
Dave Love <fx@gnu.org>
parents:
diff changeset
1973 Dissociated Press asks every so often whether to continue generating
Dave Love <fx@gnu.org>
parents:
diff changeset
1974 output. Answer @kbd{n} to stop it. You can also stop at any time by
Dave Love <fx@gnu.org>
parents:
diff changeset
1975 typing @kbd{C-g}. The dissociation output remains in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1976 @samp{*Dissociation*} buffer for you to copy elsewhere if you wish.
Dave Love <fx@gnu.org>
parents:
diff changeset
1977
Dave Love <fx@gnu.org>
parents:
diff changeset
1978 @cindex presidentagon
Dave Love <fx@gnu.org>
parents:
diff changeset
1979 Dissociated Press operates by jumping at random from one point in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1980 buffer to another. In order to produce plausible output rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
1981 gibberish, it insists on a certain amount of overlap between the end of
Dave Love <fx@gnu.org>
parents:
diff changeset
1982 one run of consecutive words or characters and the start of the next.
Dave Love <fx@gnu.org>
parents:
diff changeset
1983 That is, if it has just printed out `president' and then decides to jump
Dave Love <fx@gnu.org>
parents:
diff changeset
1984 to a different point in the file, it might spot the `ent' in `pentagon'
Dave Love <fx@gnu.org>
parents:
diff changeset
1985 and continue from there, producing `presidentagon'.@footnote{This
Dave Love <fx@gnu.org>
parents:
diff changeset
1986 dissociword actually appeared during the Vietnam War, when it was very
Dave Love <fx@gnu.org>
parents:
diff changeset
1987 appropriate.} Long sample texts produce the best results.
Dave Love <fx@gnu.org>
parents:
diff changeset
1988
Dave Love <fx@gnu.org>
parents:
diff changeset
1989 @cindex againformation
Dave Love <fx@gnu.org>
parents:
diff changeset
1990 A positive argument to @kbd{M-x dissociated-press} tells it to operate
Dave Love <fx@gnu.org>
parents:
diff changeset
1991 character by character, and specifies the number of overlap characters. A
Dave Love <fx@gnu.org>
parents:
diff changeset
1992 negative argument tells it to operate word by word and specifies the number
Dave Love <fx@gnu.org>
parents:
diff changeset
1993 of overlap words. In this mode, whole words are treated as the elements to
Dave Love <fx@gnu.org>
parents:
diff changeset
1994 be permuted, rather than characters. No argument is equivalent to an
Dave Love <fx@gnu.org>
parents:
diff changeset
1995 argument of two. For your againformation, the output goes only into the
Dave Love <fx@gnu.org>
parents:
diff changeset
1996 buffer @samp{*Dissociation*}. The buffer you start with is not changed.
Dave Love <fx@gnu.org>
parents:
diff changeset
1997
Dave Love <fx@gnu.org>
parents:
diff changeset
1998 @cindex Markov chain
Dave Love <fx@gnu.org>
parents:
diff changeset
1999 @cindex ignoriginal
Dave Love <fx@gnu.org>
parents:
diff changeset
2000 @cindex techniquitous
Dave Love <fx@gnu.org>
parents:
diff changeset
2001 Dissociated Press produces nearly the same results as a Markov chain
Dave Love <fx@gnu.org>
parents:
diff changeset
2002 based on a frequency table constructed from the sample text. It is,
Dave Love <fx@gnu.org>
parents:
diff changeset
2003 however, an independent, ignoriginal invention. Dissociated Press
Dave Love <fx@gnu.org>
parents:
diff changeset
2004 techniquitously copies several consecutive characters from the sample
Dave Love <fx@gnu.org>
parents:
diff changeset
2005 between random choices, whereas a Markov chain would choose randomly for
Dave Love <fx@gnu.org>
parents:
diff changeset
2006 each word or character. This makes for more plausible sounding results,
Dave Love <fx@gnu.org>
parents:
diff changeset
2007 and runs faster.
Dave Love <fx@gnu.org>
parents:
diff changeset
2008
Dave Love <fx@gnu.org>
parents:
diff changeset
2009 @cindex outragedy
Dave Love <fx@gnu.org>
parents:
diff changeset
2010 @cindex buggestion
Dave Love <fx@gnu.org>
parents:
diff changeset
2011 @cindex properbose
Dave Love <fx@gnu.org>
parents:
diff changeset
2012 @cindex mustatement
Dave Love <fx@gnu.org>
parents:
diff changeset
2013 @cindex developediment
Dave Love <fx@gnu.org>
parents:
diff changeset
2014 @cindex userenced
Dave Love <fx@gnu.org>
parents:
diff changeset
2015 It is a mustatement that too much use of Dissociated Press can be a
Dave Love <fx@gnu.org>
parents:
diff changeset
2016 developediment to your real work. Sometimes to the point of outragedy.
Dave Love <fx@gnu.org>
parents:
diff changeset
2017 And keep dissociwords out of your documentation, if you want it to be well
Dave Love <fx@gnu.org>
parents:
diff changeset
2018 userenced and properbose. Have fun. Your buggestions are welcome.
Dave Love <fx@gnu.org>
parents:
diff changeset
2019
Dave Love <fx@gnu.org>
parents:
diff changeset
2020 @node Amusements, Customization, Dissociated Press, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2021 @section Other Amusements
Dave Love <fx@gnu.org>
parents:
diff changeset
2022 @cindex boredom
Dave Love <fx@gnu.org>
parents:
diff changeset
2023 @findex hanoi
Dave Love <fx@gnu.org>
parents:
diff changeset
2024 @findex yow
Dave Love <fx@gnu.org>
parents:
diff changeset
2025 @findex gomoku
Dave Love <fx@gnu.org>
parents:
diff changeset
2026 @cindex tower of Hanoi
Dave Love <fx@gnu.org>
parents:
diff changeset
2027
Dave Love <fx@gnu.org>
parents:
diff changeset
2028 If you are a little bit bored, you can try @kbd{M-x hanoi}. If you are
Dave Love <fx@gnu.org>
parents:
diff changeset
2029 considerably bored, give it a numeric argument. If you are very very
Dave Love <fx@gnu.org>
parents:
diff changeset
2030 bored, try an argument of 9. Sit back and watch.
Dave Love <fx@gnu.org>
parents:
diff changeset
2031
Dave Love <fx@gnu.org>
parents:
diff changeset
2032 @cindex Go Moku
Dave Love <fx@gnu.org>
parents:
diff changeset
2033 If you want a little more personal involvement, try @kbd{M-x gomoku},
Dave Love <fx@gnu.org>
parents:
diff changeset
2034 which plays the game Go Moku with you.
Dave Love <fx@gnu.org>
parents:
diff changeset
2035
Dave Love <fx@gnu.org>
parents:
diff changeset
2036 @findex blackbox
Dave Love <fx@gnu.org>
parents:
diff changeset
2037 @findex mpuz
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2038 @findex 5x5
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2039 @cindex puzzles
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2040 @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
2041 @code{blackbox} challenges you to determine the location of objects
Dave Love <fx@gnu.org>
parents:
diff changeset
2042 inside a box by tomography. @code{mpuz} displays a multiplication
Dave Love <fx@gnu.org>
parents:
diff changeset
2043 puzzle with letters standing for digits in a code that you must
Dave Love <fx@gnu.org>
parents:
diff changeset
2044 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
2045 stands for. The aim of @code{5x5} is to fill in all the squares.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2046
Dave Love <fx@gnu.org>
parents:
diff changeset
2047 @findex dunnet
Dave Love <fx@gnu.org>
parents:
diff changeset
2048 @kbd{M-x dunnet} runs an adventure-style exploration game, which is
Dave Love <fx@gnu.org>
parents:
diff changeset
2049 a bigger sort of puzzle.
Dave Love <fx@gnu.org>
parents:
diff changeset
2050
27210
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2051 @findex lm
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2052 @cindex landmark game
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2053 @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
2054 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
2055 unique olfactory cues from each of the four directions.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2056
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2057 @findex life
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2058 @cindex Life
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2059 @kbd{M-x life} runs Conway's `Life' cellular automaton.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2060
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2061 @findex solitaire
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2062 @cindex solitaire
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2063 @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
2064 across other pegs.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2065
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2066 @findex tetris
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2067 @cindex Tetris
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2068 @kbd{M-x tetris} runs an implementation of the well-known Tetris game.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2069 @findex snake
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2070 @cindex Snake
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2071 Likewise, @kbd{M-x snake} provides an implementation of Snake.
ac3a8cb1ce25 PostScript <- Postscript.
Dave Love <fx@gnu.org>
parents: 26290
diff changeset
2072
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2073 When you are frustrated, try the famous Eliza program. Just do
Dave Love <fx@gnu.org>
parents:
diff changeset
2074 @kbd{M-x doctor}. End each input by typing @key{RET} twice.
Dave Love <fx@gnu.org>
parents:
diff changeset
2075
Dave Love <fx@gnu.org>
parents:
diff changeset
2076 @cindex Zippy
Dave Love <fx@gnu.org>
parents:
diff changeset
2077 When you are feeling strange, type @kbd{M-x yow}.