Mercurial > emacs
annotate lispref/os.texi @ 23209:601bf7681009
(comint-arguments): Ignore backslashes when using
w32 shells that expect backslashes as the directory separator.
author | Geoff Voelker <voelker@cs.washington.edu> |
---|---|
date | Mon, 07 Sep 1998 23:39:23 +0000 |
parents | ad9732e88e90 |
children | ca34063731fc |
rev | line source |
---|---|
6558 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6558 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/os | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
6 @node System Interface, Tips, Calendar, Top |
6558 | 7 @chapter Operating System Interface |
8 | |
9 This chapter is about starting and getting out of Emacs, access to | |
9009 | 10 values in the operating system environment, and terminal input, output, |
6558 | 11 and flow control. |
12 | |
13 @xref{Building Emacs}, for related information. See also | |
14 @ref{Display}, for additional operating system status information | |
15 pertaining to the terminal and the screen. | |
16 | |
17 @menu | |
18 * Starting Up:: Customizing Emacs start-up processing. | |
19 * Getting Out:: How exiting works (permanent or temporary). | |
20 * System Environment:: Distinguish the name and kind of system. | |
21 * User Identification:: Finding the name and user id of the user. | |
22 * Time of Day:: Getting the current time. | |
12067 | 23 * Time Conversion:: Converting a time from numeric form to a string, or |
24 to calendrical data (or vice versa). | |
6558 | 25 * Timers:: Setting a timer to call a function at a certain time. |
26 * Terminal Input:: Recording terminal input for debugging. | |
27 * Terminal Output:: Recording terminal output for debugging. | |
28 * Special Keysyms:: Defining system-specific key symbols for X windows. | |
29 * Flow Control:: How to turn output flow control on or off. | |
30 * Batch Mode:: Running Emacs without terminal interaction. | |
31 @end menu | |
32 | |
33 @node Starting Up | |
34 @section Starting Up Emacs | |
35 | |
36 This section describes what Emacs does when it is started, and how you | |
37 can customize these actions. | |
38 | |
39 @menu | |
40 * Start-up Summary:: Sequence of actions Emacs performs at start-up. | |
41 * Init File:: Details on reading the init file (@file{.emacs}). | |
42 * Terminal-Specific:: How the terminal-specific Lisp file is read. | |
43 * Command Line Arguments:: How command line arguments are processed, | |
44 and how you can customize them. | |
45 @end menu | |
46 | |
47 @node Start-up Summary | |
48 @subsection Summary: Sequence of Actions at Start Up | |
49 @cindex initialization | |
50 @cindex start up of Emacs | |
51 @cindex @file{startup.el} | |
52 | |
53 The order of operations performed (in @file{startup.el}) by Emacs when | |
54 it is started up is as follows: | |
55 | |
56 @enumerate | |
57 @item | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
58 It adds subdirectories to @code{load-path}, by running the file |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
59 named @file{subdirs.el} in each directory that is listed. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
60 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
61 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
62 It sets the language environment and the terminal coding system, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
63 if requested by environment variables such as @code{LANG}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
64 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
65 @item |
6558 | 66 It loads the initialization library for the window system, if you are |
67 using a window system. This library's name is | |
68 @file{term/@var{windowsystem}-win.el}. | |
69 | |
70 @item | |
12098 | 71 It processes the initial options. (Some of them are handled |
72 even earlier than this.) | |
73 | |
74 @item | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
75 It initializes the window frame and faces, if appropriate. |
6558 | 76 |
77 @item | |
78 It runs the normal hook @code{before-init-hook}. | |
79 | |
80 @item | |
81 It loads the library @file{site-start}, unless the option | |
82 @samp{-no-site-file} was specified. The library's file name is usually | |
83 @file{site-start.el}. | |
84 @cindex @file{site-start.el} | |
85 | |
86 @item | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
87 It loads the file @file{~/.emacs}, unless @samp{-q} or @samp{-batch} was |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
88 specified on the command line. The @samp{-u} option can specify another |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
89 user name whose home directory should be used instead of @file{~}. |
6558 | 90 |
91 @item | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
92 It loads the library @file{default}, unless @code{inhibit-default-init} |
6558 | 93 is non-@code{nil}. (This is not done in @samp{-batch} mode or if |
9009 | 94 @samp{-q} was specified on the command line.) The library's file name |
95 is usually @file{default.el}. | |
6558 | 96 @cindex @file{default.el} |
97 | |
98 @item | |
99 It runs the normal hook @code{after-init-hook}. | |
100 | |
101 @item | |
102 It sets the major mode according to @code{initial-major-mode}, provided | |
103 the buffer @samp{*scratch*} is still current and still in Fundamental | |
104 mode. | |
105 | |
106 @item | |
107 It loads the terminal-specific Lisp file, if any, except when in batch | |
108 mode or using a window system. | |
109 | |
110 @item | |
111 It displays the initial echo area message, unless you have suppressed | |
112 that with @code{inhibit-startup-echo-area-message}. | |
113 | |
114 @item | |
12098 | 115 It processes the action arguments from the command line. |
6558 | 116 |
117 @item | |
118 It runs @code{term-setup-hook}. | |
119 | |
120 @item | |
121 It calls @code{frame-notice-user-settings}, which modifies the | |
122 parameters of the selected frame according to whatever the init files | |
123 specify. | |
124 | |
125 @item | |
126 It runs @code{window-setup-hook}. @xref{Window Systems}. | |
127 | |
128 @item | |
9009 | 129 It displays copyleft, nonwarranty, and basic use information, provided |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
130 there were no remaining command line arguments (a few steps above), |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
131 the value of @code{inhibit-startup-message} is @code{nil}, and the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
132 buffer is still empty. |
6558 | 133 @end enumerate |
134 | |
135 @defopt inhibit-startup-message | |
136 This variable inhibits the initial startup messages (the nonwarranty, | |
137 etc.). If it is non-@code{nil}, then the messages are not printed. | |
138 | |
139 This variable exists so you can set it in your personal init file, once | |
140 you are familiar with the contents of the startup message. Do not set | |
141 this variable in the init file of a new user, or in a way that affects | |
142 more than one user, because that would prevent new users from receiving | |
143 the information they are supposed to see. | |
144 @end defopt | |
145 | |
146 @defopt inhibit-startup-echo-area-message | |
147 This variable controls the display of the startup echo area message. | |
148 You can suppress the startup echo area message by adding text with this | |
149 form to your @file{.emacs} file: | |
150 | |
151 @example | |
152 (setq inhibit-startup-echo-area-message | |
153 "@var{your-login-name}") | |
154 @end example | |
155 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
156 Emacs explicitly checks for an expression as shown above in your |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
157 @file{.emacs} file; your login name must appear in the expression as a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
158 Lisp string constant. Other methods of setting |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
159 @code{inhibit-startup-echo-area-message} to the same value do not |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
160 inhibit the startup message. |
6558 | 161 |
162 This way, you can easily inhibit the message for yourself if you wish, | |
163 but thoughtless copying of your @file{.emacs} file will not inhibit the | |
164 message for someone else. | |
165 @end defopt | |
166 | |
167 @node Init File | |
168 @subsection The Init File: @file{.emacs} | |
169 @cindex init file | |
170 @cindex @file{.emacs} | |
171 | |
172 When you start Emacs, it normally attempts to load the file | |
173 @file{.emacs} from your home directory. This file, if it exists, must | |
174 contain Lisp code. It is called your @dfn{init file}. The command line | |
175 switches @samp{-q} and @samp{-u} affect the use of the init file; | |
176 @samp{-q} says not to load an init file, and @samp{-u} says to load a | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
177 specified user's init file instead of yours. @xref{Entering Emacs,,, |
6558 | 178 emacs, The GNU Emacs Manual}. |
179 | |
180 @cindex default init file | |
181 A site may have a @dfn{default init file}, which is the library named | |
182 @file{default.el}. Emacs finds the @file{default.el} file through the | |
183 standard search path for libraries (@pxref{How Programs Do Loading}). | |
184 The Emacs distribution does not come with this file; sites may provide | |
185 one for local customizations. If the default init file exists, it is | |
186 loaded whenever you start Emacs, except in batch mode or if @samp{-q} is | |
187 specified. But your own personal init file, if any, is loaded first; if | |
188 it sets @code{inhibit-default-init} to a non-@code{nil} value, then | |
189 Emacs does not subsequently load the @file{default.el} file. | |
190 | |
191 Another file for site-customization is @file{site-start.el}. Emacs | |
192 loads this @emph{before} the user's init file. You can inhibit the | |
193 loading of this file with the option @samp{-no-site-file}. | |
194 | |
12098 | 195 @defvar site-run-file |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
196 This variable specifies the site-customization file to load before the |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
197 user's init file. Its normal value is @code{"site-start"}. The only |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
198 way you can change it with real effect is to do so before dumping |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
199 Emacs. |
12098 | 200 @end defvar |
201 | |
6558 | 202 If there is a great deal of code in your @file{.emacs} file, you |
203 should move it into another file named @file{@var{something}.el}, | |
204 byte-compile it (@pxref{Byte Compilation}), and make your @file{.emacs} | |
205 file load the other file using @code{load} (@pxref{Loading}). | |
206 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
207 @xref{Init File Examples,,, emacs, The GNU Emacs Manual}, for |
6558 | 208 examples of how to make various commonly desired customizations in your |
209 @file{.emacs} file. | |
210 | |
211 @defopt inhibit-default-init | |
212 This variable prevents Emacs from loading the default initialization | |
213 library file for your session of Emacs. If its value is non-@code{nil}, | |
214 then the default library is not loaded. The default value is | |
215 @code{nil}. | |
216 @end defopt | |
217 | |
218 @defvar before-init-hook | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
219 This normal hook is run, once, just before loading all the init files |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
220 (the user's init file, @file{default.el}, and/or @file{site-start.el}). |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
221 (The only way to change it with real effect is before dumping Emacs.) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
222 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
223 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
224 @defvar after-init-hook |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
225 This normal hook is run, once, just after loading all the init files |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
226 (the user's init file, @file{default.el}, and/or @file{site-start.el}), |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
227 before the terminal-specific initialization. |
6558 | 228 @end defvar |
229 | |
230 @node Terminal-Specific | |
231 @subsection Terminal-Specific Initialization | |
232 @cindex terminal-specific initialization | |
233 | |
234 Each terminal type can have its own Lisp library that Emacs loads when | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
235 run on that type of terminal. The library's name is constructed by |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
236 concatenating the value of the variable @code{term-file-prefix} and the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
237 terminal type. Normally, @code{term-file-prefix} has the value |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
238 @code{"term/"}; changing this is not recommended. Emacs finds the file |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
239 in the normal manner, by searching the @code{load-path} directories, and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
240 trying the @samp{.elc} and @samp{.el} suffixes. |
6558 | 241 |
242 The usual function of a terminal-specific library is to enable special | |
243 keys to send sequences that Emacs can recognize. It may also need to | |
244 set or add to @code{function-key-map} if the Termcap entry does not | |
245 specify all the terminal's function keys. @xref{Terminal Input}. | |
246 | |
247 @cindex Termcap | |
248 When the name of the terminal type contains a hyphen, only the part of | |
249 the name before the first hyphen is significant in choosing the library | |
250 name. Thus, terminal types @samp{aaa-48} and @samp{aaa-30-rv} both use | |
251 the @file{term/aaa} library. If necessary, the library can evaluate | |
252 @code{(getenv "TERM")} to find the full name of the terminal | |
253 type.@refill | |
254 | |
255 Your @file{.emacs} file can prevent the loading of the | |
256 terminal-specific library by setting the variable | |
257 @code{term-file-prefix} to @code{nil}. This feature is useful when | |
258 experimenting with your own peculiar customizations. | |
259 | |
260 You can also arrange to override some of the actions of the | |
261 terminal-specific library by setting the variable | |
262 @code{term-setup-hook}. This is a normal hook which Emacs runs using | |
263 @code{run-hooks} at the end of Emacs initialization, after loading both | |
264 your @file{.emacs} file and any terminal-specific libraries. You can | |
265 use this variable to define initializations for terminals that do not | |
266 have their own libraries. @xref{Hooks}. | |
267 | |
268 @defvar term-file-prefix | |
269 @cindex @code{TERM} environment variable | |
270 If the @code{term-file-prefix} variable is non-@code{nil}, Emacs loads | |
271 a terminal-specific initialization file as follows: | |
272 | |
273 @example | |
274 (load (concat term-file-prefix (getenv "TERM"))) | |
275 @end example | |
276 | |
277 @noindent | |
278 You may set the @code{term-file-prefix} variable to @code{nil} in your | |
279 @file{.emacs} file if you do not wish to load the | |
280 terminal-initialization file. To do this, put the following in | |
281 your @file{.emacs} file: @code{(setq term-file-prefix nil)}. | |
282 @end defvar | |
283 | |
284 @defvar term-setup-hook | |
9009 | 285 This variable is a normal hook that Emacs runs after loading your |
6558 | 286 @file{.emacs} file, the default initialization file (if any) and the |
287 terminal-specific Lisp file. | |
288 | |
289 You can use @code{term-setup-hook} to override the definitions made by a | |
290 terminal-specific file. | |
291 @end defvar | |
292 | |
293 See @code{window-setup-hook} in @ref{Window Systems}, for a related | |
294 feature. | |
295 | |
296 @node Command Line Arguments | |
297 @subsection Command Line Arguments | |
298 @cindex command line arguments | |
299 | |
300 You can use command line arguments to request various actions when you | |
301 start Emacs. Since you do not need to start Emacs more than once per | |
302 day, and will often leave your Emacs session running longer than that, | |
303 command line arguments are hardly ever used. As a practical matter, it | |
304 is best to avoid making the habit of using them, since this habit would | |
305 encourage you to kill and restart Emacs unnecessarily often. These | |
306 options exist for two reasons: to be compatible with other editors (for | |
307 invocation by other programs) and to enable shell scripts to run | |
308 specific Lisp programs. | |
309 | |
310 This section describes how Emacs processes command line arguments, | |
311 and how you can customize them. | |
312 | |
313 @ignore | |
314 (Note that some other editors require you to start afresh each time | |
315 you want to edit a file. With this kind of editor, you will probably | |
316 specify the file as a command line argument. The recommended way to | |
317 use GNU Emacs is to start it only once, just after you log in, and do | |
318 all your editing in the same Emacs process. Each time you want to edit | |
319 a different file, you visit it with the existing Emacs, which eventually | |
320 comes to have many files in it ready for editing. Usually you do not | |
321 kill the Emacs until you are about to log out.) | |
322 @end ignore | |
323 | |
324 @defun command-line | |
9009 | 325 This function parses the command line that Emacs was called with, |
6558 | 326 processes it, loads the user's @file{.emacs} file and displays the |
9009 | 327 startup messages. |
6558 | 328 @end defun |
329 | |
330 @defvar command-line-processed | |
331 The value of this variable is @code{t} once the command line has been | |
332 processed. | |
333 | |
334 If you redump Emacs by calling @code{dump-emacs}, you may wish to set | |
335 this variable to @code{nil} first in order to cause the new dumped Emacs | |
336 to process its new command line arguments. | |
337 @end defvar | |
338 | |
339 @defvar command-switch-alist | |
340 @cindex switches on command line | |
341 @cindex options on command line | |
342 @cindex command line options | |
343 The value of this variable is an alist of user-defined command-line | |
344 options and associated handler functions. This variable exists so you | |
345 can add elements to it. | |
346 | |
347 A @dfn{command line option} is an argument on the command line of the | |
348 form: | |
349 | |
350 @example | |
351 -@var{option} | |
352 @end example | |
353 | |
354 The elements of the @code{command-switch-alist} look like this: | |
355 | |
356 @example | |
357 (@var{option} . @var{handler-function}) | |
358 @end example | |
359 | |
360 The @var{handler-function} is called to handle @var{option} and receives | |
361 the option name as its sole argument. | |
362 | |
363 In some cases, the option is followed in the command line by an | |
364 argument. In these cases, the @var{handler-function} can find all the | |
365 remaining command-line arguments in the variable | |
366 @code{command-line-args-left}. (The entire list of command-line | |
367 arguments is in @code{command-line-args}.) | |
368 | |
369 The command line arguments are parsed by the @code{command-line-1} | |
370 function in the @file{startup.el} file. See also @ref{Command | |
371 Switches, , Command Line Switches and Arguments, emacs, The GNU Emacs | |
372 Manual}. | |
373 @end defvar | |
374 | |
375 @defvar command-line-args | |
376 The value of this variable is the list of command line arguments passed | |
377 to Emacs. | |
378 @end defvar | |
379 | |
380 @defvar command-line-functions | |
381 This variable's value is a list of functions for handling an | |
382 unrecognized command-line argument. Each time the next argument to be | |
383 processed has no special meaning, the functions in this list are called, | |
9009 | 384 in order of appearance, until one of them returns a non-@code{nil} |
6558 | 385 value. |
386 | |
387 These functions are called with no arguments. They can access the | |
388 command-line argument under consideration through the variable | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
389 @code{argi}, which is bound temporarily at this point. The remaining |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
390 arguments (not including the current one) are in the variable |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
391 @code{command-line-args-left}. |
6558 | 392 |
393 When a function recognizes and processes the argument in @code{argi}, it | |
394 should return a non-@code{nil} value to say it has dealt with that | |
395 argument. If it has also dealt with some of the following arguments, it | |
396 can indicate that by deleting them from @code{command-line-args-left}. | |
397 | |
398 If all of these functions return @code{nil}, then the argument is used | |
399 as a file name to visit. | |
400 @end defvar | |
401 | |
402 @node Getting Out | |
403 @section Getting Out of Emacs | |
404 @cindex exiting Emacs | |
405 | |
406 There are two ways to get out of Emacs: you can kill the Emacs job, | |
407 which exits permanently, or you can suspend it, which permits you to | |
408 reenter the Emacs process later. As a practical matter, you seldom kill | |
409 Emacs---only when you are about to log out. Suspending is much more | |
410 common. | |
411 | |
412 @menu | |
413 * Killing Emacs:: Exiting Emacs irreversibly. | |
414 * Suspending Emacs:: Exiting Emacs reversibly. | |
415 @end menu | |
416 | |
417 @node Killing Emacs | |
418 @comment node-name, next, previous, up | |
419 @subsection Killing Emacs | |
420 @cindex killing Emacs | |
421 | |
422 Killing Emacs means ending the execution of the Emacs process. The | |
423 parent process normally resumes control. The low-level primitive for | |
424 killing Emacs is @code{kill-emacs}. | |
425 | |
426 @defun kill-emacs &optional exit-data | |
427 This function exits the Emacs process and kills it. | |
428 | |
429 If @var{exit-data} is an integer, then it is used as the exit status | |
430 of the Emacs process. (This is useful primarily in batch operation; see | |
431 @ref{Batch Mode}.) | |
432 | |
433 If @var{exit-data} is a string, its contents are stuffed into the | |
434 terminal input buffer so that the shell (or whatever program next reads | |
435 input) can read them. | |
436 @end defun | |
437 | |
438 All the information in the Emacs process, aside from files that have | |
439 been saved, is lost when the Emacs is killed. Because killing Emacs | |
440 inadvertently can lose a lot of work, Emacs queries for confirmation | |
441 before actually terminating if you have buffers that need saving or | |
442 subprocesses that are running. This is done in the function | |
443 @code{save-buffers-kill-emacs}. | |
444 | |
445 @defvar kill-emacs-query-functions | |
446 After asking the standard questions, @code{save-buffers-kill-emacs} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
447 calls the functions in the list @code{kill-emacs-query-functions}, in |
6558 | 448 order of appearance, with no arguments. These functions can ask for |
449 additional confirmation from the user. If any of them returns | |
20103
7867bb9ff46a
Elements of kill-emacs-query-functions return nil, not non-nil,
Karl Heuer <kwzh@gnu.org>
parents:
15778
diff
changeset
|
450 @code{nil}, Emacs is not killed. |
6558 | 451 @end defvar |
452 | |
453 @defvar kill-emacs-hook | |
454 This variable is a normal hook; once @code{save-buffers-kill-emacs} is | |
455 finished with all file saving and confirmation, it runs the functions in | |
456 this hook. | |
457 @end defvar | |
458 | |
459 @node Suspending Emacs | |
460 @subsection Suspending Emacs | |
461 @cindex suspending Emacs | |
462 | |
463 @dfn{Suspending Emacs} means stopping Emacs temporarily and returning | |
464 control to its superior process, which is usually the shell. This | |
465 allows you to resume editing later in the same Emacs process, with the | |
466 same buffers, the same kill ring, the same undo history, and so on. To | |
467 resume Emacs, use the appropriate command in the parent shell---most | |
468 likely @code{fg}. | |
469 | |
470 Some operating systems do not support suspension of jobs; on these | |
471 systems, ``suspension'' actually creates a new shell temporarily as a | |
472 subprocess of Emacs. Then you would exit the shell to return to Emacs. | |
473 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
474 Suspension is not useful with window systems, because the Emacs job |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
475 may not have a parent that can resume it again, and in any case you can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
476 give input to some other job such as a shell merely by moving to a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
477 different window. Therefore, suspending is not allowed when Emacs is using |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
478 a window system. |
6558 | 479 |
480 @defun suspend-emacs string | |
481 This function stops Emacs and returns control to the superior process. | |
482 If and when the superior process resumes Emacs, @code{suspend-emacs} | |
483 returns @code{nil} to its caller in Lisp. | |
484 | |
485 If @var{string} is non-@code{nil}, its characters are sent to be read | |
486 as terminal input by Emacs's superior shell. The characters in | |
487 @var{string} are not echoed by the superior shell; only the results | |
488 appear. | |
489 | |
490 Before suspending, @code{suspend-emacs} runs the normal hook | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
491 @code{suspend-hook}. |
6558 | 492 |
9009 | 493 After the user resumes Emacs, @code{suspend-emacs} runs the normal hook |
6558 | 494 @code{suspend-resume-hook}. @xref{Hooks}. |
495 | |
496 The next redisplay after resumption will redraw the entire screen, | |
497 unless the variable @code{no-redraw-on-reenter} is non-@code{nil} | |
498 (@pxref{Refresh Screen}). | |
499 | |
500 In the following example, note that @samp{pwd} is not echoed after | |
501 Emacs is suspended. But it is read and executed by the shell. | |
502 | |
503 @smallexample | |
504 @group | |
505 (suspend-emacs) | |
506 @result{} nil | |
507 @end group | |
508 | |
509 @group | |
510 (add-hook 'suspend-hook | |
511 (function (lambda () | |
512 (or (y-or-n-p | |
513 "Really suspend? ") | |
514 (error "Suspend cancelled"))))) | |
515 @result{} (lambda nil | |
516 (or (y-or-n-p "Really suspend? ") | |
517 (error "Suspend cancelled"))) | |
518 @end group | |
519 @group | |
520 (add-hook 'suspend-resume-hook | |
521 (function (lambda () (message "Resumed!")))) | |
522 @result{} (lambda nil (message "Resumed!")) | |
523 @end group | |
524 @group | |
525 (suspend-emacs "pwd") | |
526 @result{} nil | |
527 @end group | |
528 @group | |
529 ---------- Buffer: Minibuffer ---------- | |
530 Really suspend? @kbd{y} | |
531 ---------- Buffer: Minibuffer ---------- | |
532 @end group | |
533 | |
534 @group | |
535 ---------- Parent Shell ---------- | |
536 lewis@@slug[23] % /user/lewis/manual | |
537 lewis@@slug[24] % fg | |
538 @end group | |
539 | |
540 @group | |
541 ---------- Echo Area ---------- | |
542 Resumed! | |
543 @end group | |
544 @end smallexample | |
545 @end defun | |
546 | |
547 @defvar suspend-hook | |
548 This variable is a normal hook run before suspending. | |
549 @end defvar | |
550 | |
551 @defvar suspend-resume-hook | |
552 This variable is a normal hook run after suspending. | |
553 @end defvar | |
554 | |
555 @node System Environment | |
556 @section Operating System Environment | |
557 @cindex operating system environment | |
558 | |
559 Emacs provides access to variables in the operating system environment | |
560 through various functions. These variables include the name of the | |
561 system, the user's @sc{uid}, and so on. | |
562 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
563 @defvar system-configuration |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
564 This variable holds the GNU configuration name for the hardware/software |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
565 configuration of your system, as a string. The convenient way to test |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
566 parts of this string is with @code{string-match}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
567 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
568 |
6558 | 569 @defvar system-type |
12098 | 570 The value of this variable is a symbol indicating the type of operating |
571 system Emacs is operating on. Here is a table of the possible values: | |
6558 | 572 |
573 @table @code | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
574 @item alpha-vms |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
575 VMS on the Alpha. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
576 |
6558 | 577 @item aix-v3 |
578 AIX. | |
579 | |
580 @item berkeley-unix | |
581 Berkeley BSD. | |
582 | |
12098 | 583 @item dgux |
584 Data General DGUX operating system. | |
585 | |
586 @item gnu | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
587 the GNU system (using the GNU kernel, which consists of the HURD and Mach). |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
588 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
589 @item gnu/linux |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
590 A GNU/Linux system---that is, a variant GNU system, using the Linux |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
591 kernel. (These systems are the ones people often call ``Linux,'' but |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
592 actually Linux is just the kernel, not the whole system.) |
12098 | 593 |
6558 | 594 @item hpux |
12098 | 595 Hewlett-Packard HPUX operating system. |
6558 | 596 |
597 @item irix | |
598 Silicon Graphics Irix system. | |
599 | |
12098 | 600 @item ms-dos |
601 Microsoft MS-DOS ``operating system.'' | |
602 | |
603 @item next-mach | |
604 NeXT Mach-based system. | |
7277
6a2af30d33fe
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
605 |
6558 | 606 @item rtu |
607 Masscomp RTU, UCB universe. | |
608 | |
609 @item unisoft-unix | |
610 UniSoft UniPlus. | |
611 | |
612 @item usg-unix-v | |
613 AT&T System V. | |
614 | |
615 @item vax-vms | |
616 VAX VMS. | |
617 | |
12098 | 618 @item windows-nt |
619 Microsoft windows NT. | |
620 | |
6558 | 621 @item xenix |
622 SCO Xenix 386. | |
623 @end table | |
624 | |
625 We do not wish to add new symbols to make finer distinctions unless it | |
626 is absolutely necessary! In fact, we hope to eliminate some of these | |
627 alternatives in the future. We recommend using | |
628 @code{system-configuration} to distinguish between different operating | |
629 systems. | |
630 @end defvar | |
631 | |
632 @defun system-name | |
633 This function returns the name of the machine you are running on. | |
634 @example | |
635 (system-name) | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
636 @result{} "www.gnu.org" |
6558 | 637 @end example |
638 @end defun | |
639 | |
12067 | 640 The symbol @code{system-name} is a variable as well as a function. In |
641 fact, the function returns whatever value the variable | |
642 @code{system-name} currently holds. Thus, you can set the variable | |
643 @code{system-name} in case Emacs is confused about the name of your | |
644 system. The variable is also useful for constructing frame titles | |
645 (@pxref{Frame Titles}). | |
646 | |
647 @defvar mail-host-address | |
648 If this variable is non-@code{nil}, it is used instead of | |
649 @code{system-name} for purposes of generating email addresses. For | |
650 example, it is used when constructing the default value of | |
651 @code{user-mail-address}. @xref{User Identification}. (Since this is | |
652 done when Emacs starts up, the value actually used is the one saved when | |
653 Emacs was dumped. @xref{Building Emacs}.) | |
654 @end defvar | |
655 | |
6558 | 656 @defun getenv var |
657 @cindex environment variable access | |
658 This function returns the value of the environment variable @var{var}, | |
659 as a string. Within Emacs, the environment variable values are kept in | |
660 the Lisp variable @code{process-environment}. | |
661 | |
662 @example | |
663 @group | |
664 (getenv "USER") | |
665 @result{} "lewis" | |
666 @end group | |
667 | |
668 @group | |
669 lewis@@slug[10] % printenv | |
670 PATH=.:/user/lewis/bin:/usr/bin:/usr/local/bin | |
671 USER=lewis | |
672 @end group | |
673 @group | |
674 TERM=ibmapa16 | |
675 SHELL=/bin/csh | |
676 HOME=/user/lewis | |
677 @end group | |
678 @end example | |
679 @end defun | |
680 | |
681 @c Emacs 19 feature | |
682 @deffn Command setenv variable value | |
683 This command sets the value of the environment variable named | |
684 @var{variable} to @var{value}. Both arguments should be strings. This | |
685 function works by modifying @code{process-environment}; binding that | |
686 variable with @code{let} is also reasonable practice. | |
687 @end deffn | |
688 | |
689 @defvar process-environment | |
690 This variable is a list of strings, each describing one environment | |
691 variable. The functions @code{getenv} and @code{setenv} work by means | |
692 of this variable. | |
693 | |
694 @smallexample | |
695 @group | |
696 process-environment | |
697 @result{} ("l=/usr/stanford/lib/gnuemacs/lisp" | |
698 "PATH=.:/user/lewis/bin:/usr/class:/nfsusr/local/bin" | |
699 "USER=lewis" | |
700 @end group | |
701 @group | |
702 "TERM=ibmapa16" | |
703 "SHELL=/bin/csh" | |
704 "HOME=/user/lewis") | |
705 @end group | |
706 @end smallexample | |
707 @end defvar | |
708 | |
12098 | 709 @defvar path-separator |
710 This variable holds a string which says which character separates | |
711 directories in a search path (as found in an environment variable). Its | |
712 value is @code{":"} for Unix and GNU systems, and @code{";"} for MS-DOS | |
713 and Windows NT. | |
714 @end defvar | |
715 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
716 @defvar invocation-name |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
717 This variable holds the program name under which Emacs was invoked. The |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
718 value is a string, and does not include a directory name. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
719 @end defvar |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
720 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
721 @defvar invocation-directory |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
722 This variable holds the directory from which the Emacs executable was |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
723 invoked, or perhaps @code{nil} if that directory cannot be determined. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
724 @end defvar |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
725 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
726 @defvar installation-directory |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
727 If non-@code{nil}, this is a directory within which to look for the |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
728 @file{lib-src} and @file{etc} subdirectories. This is non-@code{nil} |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
729 when Emacs can't find those directories in their standard installed |
9009 | 730 locations, but can find them in a directory related somehow to the one |
731 containing the Emacs executable. | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
732 @end defvar |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
733 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
734 @defun load-average &optional use-float |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
735 This function returns the current 1-minute, 5-minute, and 15-minute load |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
736 averages, in a list. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
737 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
738 By default, the values are integers that are 100 times the system load |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
739 averages, which indicate the average number of processes trying to run. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
740 If @var{use-float} is non-@code{nil}, then they are returned |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
741 as floating point numbers and without multiplying by 100. |
6558 | 742 |
743 @example | |
744 @group | |
745 (load-average) | |
746 @result{} (169 48 36) | |
747 @end group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
748 @group |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
749 (load-average t) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
750 @result{} (1.69 0.48 0.36) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
751 @end group |
6558 | 752 |
753 @group | |
754 lewis@@rocky[5] % uptime | |
755 11:55am up 1 day, 19:37, 3 users, | |
756 load average: 1.69, 0.48, 0.36 | |
757 @end group | |
758 @end example | |
759 @end defun | |
760 | |
761 @defun emacs-pid | |
762 This function returns the process @sc{id} of the Emacs process. | |
763 @end defun | |
764 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
765 @defvar tty-erase-char |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
766 @tindex tty-erase-char |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
767 This variable holds the erase character that was selected |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
768 in the system's terminal driver, before Emacs was started. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
769 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
770 |
6558 | 771 @defun setprv privilege-name &optional setp getprv |
772 This function sets or resets a VMS privilege. (It does not exist on | |
773 Unix.) The first arg is the privilege name, as a string. The second | |
774 argument, @var{setp}, is @code{t} or @code{nil}, indicating whether the | |
775 privilege is to be turned on or off. Its default is @code{nil}. The | |
776 function returns @code{t} if successful, @code{nil} otherwise. | |
777 | |
778 If the third argument, @var{getprv}, is non-@code{nil}, @code{setprv} | |
779 does not change the privilege, but returns @code{t} or @code{nil} | |
780 indicating whether the privilege is currently enabled. | |
781 @end defun | |
782 | |
783 @node User Identification | |
784 @section User Identification | |
785 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
786 @defvar init-file-user |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
787 This variable says which user's init files should be used by Emacs---or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
788 @code{nil} if none. The value reflects command line options such as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
789 @samp{-q} or @samp{-u @var{user}}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
790 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
791 Lisp packages that load files of customizations, or any other sort of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
792 user profile, should obey this variable in deciding where to find it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
793 They should load the profile of the user name found in this variable. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
794 If @code{init-file-user} is @code{nil}, meaning that the @samp{-q} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
795 option was used, then Lisp packages should not load any customization |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
796 files or user profile. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
797 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
798 |
12067 | 799 @defvar user-mail-address |
800 This holds the nominal email address of the user who is using Emacs. | |
13367
a3e8c1d2492f
Explain when user-mail-address is set.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
801 Emacs normally sets this variable to a default value after reading your |
a3e8c1d2492f
Explain when user-mail-address is set.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
802 init files, but not if you have already set it. So you can set the |
a3e8c1d2492f
Explain when user-mail-address is set.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
803 variable to some other value in your @file{~/.emacs} file if you do not |
a3e8c1d2492f
Explain when user-mail-address is set.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
804 want to use the default value. |
12067 | 805 @end defvar |
806 | |
807 @defun user-login-name &optional uid | |
808 If you don't specify @var{uid}, this function returns the name under | |
809 which the user is logged in. If the environment variable @code{LOGNAME} | |
810 is set, that value is used. Otherwise, if the environment variable | |
811 @code{USER} is set, that value is used. Otherwise, the value is based | |
812 on the effective @sc{uid}, not the real @sc{uid}. | |
813 | |
814 If you specify @var{uid}, the value is the user name that corresponds | |
815 to @var{uid} (which should be an integer). | |
6558 | 816 |
817 @example | |
818 @group | |
819 (user-login-name) | |
820 @result{} "lewis" | |
821 @end group | |
822 @end example | |
823 @end defun | |
824 | |
825 @defun user-real-login-name | |
826 This function returns the user name corresponding to Emacs's real | |
827 @sc{uid}. This ignores the effective @sc{uid} and ignores the | |
828 environment variables @code{LOGNAME} and @code{USER}. | |
829 @end defun | |
830 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
831 @defun user-full-name &optional uid |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
832 This function returns the full name of the logged-in user---or the value |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
833 of the environment variables @code{NAME}, if that is set. |
6558 | 834 |
835 @example | |
836 @group | |
837 (user-full-name) | |
838 @result{} "Bil Lewis" | |
839 @end group | |
840 @end example | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
841 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
842 If @var{uid} is non-@code{nil}, then it should be an integer, a user-id, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
843 or a string, a login name. Then @code{user-full-name} returns the full |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
844 name corresponding to that user-id or login name. |
6558 | 845 @end defun |
846 | |
12067 | 847 @vindex user-full-name |
848 @vindex user-real-login-name | |
849 @vindex user-login-name | |
850 The symbols @code{user-login-name}, @code{user-real-login-name} and | |
851 @code{user-full-name} are variables as well as functions. The functions | |
852 return the same values that the variables hold. These variables allow | |
853 you to ``fake out'' Emacs by telling the functions what to return. The | |
854 variables are also useful for constructing frame titles (@pxref{Frame | |
855 Titles}). | |
856 | |
6558 | 857 @defun user-real-uid |
858 This function returns the real @sc{uid} of the user. | |
859 | |
860 @example | |
861 @group | |
862 (user-real-uid) | |
863 @result{} 19 | |
864 @end group | |
865 @end example | |
866 @end defun | |
867 | |
868 @defun user-uid | |
869 This function returns the effective @sc{uid} of the user. | |
870 @end defun | |
871 | |
872 @node Time of Day | |
873 @section Time of Day | |
874 | |
875 This section explains how to determine the current time and the time | |
876 zone. | |
877 | |
878 @defun current-time-string &optional time-value | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
879 This function returns the current time and date as a human-readable |
6558 | 880 string. The format of the string is unvarying; the number of characters |
881 used for each part is always the same, so you can reliably use | |
12098 | 882 @code{substring} to extract pieces of it. It is wise to count the |
883 characters from the beginning of the string rather than from the end, as | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
884 additional information may some day be added at the end. |
6558 | 885 |
886 @c Emacs 19 feature | |
887 The argument @var{time-value}, if given, specifies a time to format | |
12098 | 888 instead of the current time. The argument should be a list whose first |
889 two elements are integers. Thus, you can use times obtained from | |
890 @code{current-time} (see below) and from @code{file-attributes} | |
891 (@pxref{File Attributes}). | |
6558 | 892 |
893 @example | |
894 @group | |
895 (current-time-string) | |
896 @result{} "Wed Oct 14 22:21:05 1987" | |
897 @end group | |
898 @end example | |
899 @end defun | |
900 | |
901 @c Emacs 19 feature | |
902 @defun current-time | |
903 This function returns the system's time value as a list of three | |
904 integers: @code{(@var{high} @var{low} @var{microsec})}. The integers | |
905 @var{high} and @var{low} combine to give the number of seconds since | |
906 0:00 January 1, 1970, which is | |
907 @ifinfo | |
908 @var{high} * 2**16 + @var{low}. | |
909 @end ifinfo | |
910 @tex | |
9009 | 911 $high*2^{16}+low$. |
6558 | 912 @end tex |
913 | |
914 The third element, @var{microsec}, gives the microseconds since the | |
915 start of the current second (or 0 for systems that return time only on | |
916 the resolution of a second). | |
917 | |
918 The first two elements can be compared with file time values such as you | |
919 get with the function @code{file-attributes}. @xref{File Attributes}. | |
920 @end defun | |
921 | |
922 @c Emacs 19 feature | |
923 @defun current-time-zone &optional time-value | |
924 This function returns a list describing the time zone that the user is | |
925 in. | |
926 | |
927 The value has the form @code{(@var{offset} @var{name})}. Here | |
928 @var{offset} is an integer giving the number of seconds ahead of UTC | |
929 (east of Greenwich). A negative value means west of Greenwich. The | |
930 second element, @var{name} is a string giving the name of the time | |
931 zone. Both elements change when daylight savings time begins or ends; | |
932 if the user has specified a time zone that does not use a seasonal time | |
933 adjustment, then the value is constant through time. | |
934 | |
935 If the operating system doesn't supply all the information necessary to | |
936 compute the value, both elements of the list are @code{nil}. | |
937 | |
938 The argument @var{time-value}, if given, specifies a time to analyze | |
939 instead of the current time. The argument should be a cons cell | |
940 containing two integers, or a list whose first two elements are | |
941 integers. Thus, you can use times obtained from @code{current-time} | |
12067 | 942 (see above) and from @code{file-attributes} (@pxref{File Attributes}). |
943 @end defun | |
944 | |
945 @node Time Conversion | |
946 @section Time Conversion | |
947 | |
948 These functions convert time values (lists of two or three integers) | |
949 to strings or to calendrical information. There is also a function to | |
950 convert calendrical information to a time value. You can get time | |
951 values from the functions @code{current-time} (@pxref{Time of Day}) and | |
952 @code{file-attributes} (@pxref{File Attributes}). | |
953 | |
15778
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
954 Many operating systems are limited to time values that contain 32 bits |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
955 of information; these systems typically handle only the times from |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
956 1901-12-13 20:45:52 UTC through 2038-01-19 03:14:07 UTC. However, some |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
957 operating systems have larger time values, and can represent times far |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
958 in the past or future. |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
959 |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
960 Time conversion functions always use the Gregorian calendar, even for |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
961 dates before the Gregorian calendar was introduced. Year numbers count |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
962 the number of years since the year 1 B.C., and do not skip zero as |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
963 traditional Gregorian years do; for example, the year number @minus{}37 |
15778
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
964 represents the Gregorian year 38 B.C@. |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
965 |
12067 | 966 @defun format-time-string format-string time |
967 This function converts @var{time} to a string according to | |
968 @var{format-string}. The argument @var{format-string} may contain | |
969 @samp{%}-sequences which say to substitute parts of the time. Here is a | |
970 table of what the @samp{%}-sequences mean: | |
971 | |
972 @table @samp | |
973 @item %a | |
974 This stands for the abbreviated name of the day of week. | |
975 @item %A | |
976 This stands for the full name of the day of week. | |
977 @item %b | |
978 This stands for the abbreviated name of the month. | |
979 @item %B | |
980 This stands for the full name of the month. | |
981 @item %c | |
982 This is a synonym for @samp{%x %X}. | |
983 @item %C | |
12098 | 984 This has a locale-specific meaning. In the default locale (named C), it |
985 is equivalent to @samp{%A, %B %e, %Y}. | |
12067 | 986 @item %d |
987 This stands for the day of month, zero-padded. | |
988 @item %D | |
989 This is a synonym for @samp{%m/%d/%y}. | |
990 @item %e | |
991 This stands for the day of month, blank-padded. | |
992 @item %h | |
993 This is a synonym for @samp{%b}. | |
994 @item %H | |
995 This stands for the hour (00-23). | |
996 @item %I | |
997 This stands for the hour (00-12). | |
998 @item %j | |
999 This stands for the day of the year (001-366). | |
1000 @item %k | |
1001 This stands for the hour (0-23), blank padded. | |
1002 @item %l | |
1003 This stands for the hour (1-12), blank padded. | |
1004 @item %m | |
1005 This stands for the month (01-12). | |
1006 @item %M | |
1007 This stands for the minute (00-59). | |
1008 @item %n | |
1009 This stands for a newline. | |
1010 @item %p | |
1011 This stands for @samp{AM} or @samp{PM}, as appropriate. | |
1012 @item %r | |
1013 This is a synonym for @samp{%I:%M:%S %p}. | |
1014 @item %R | |
1015 This is a synonym for @samp{%H:%M}. | |
1016 @item %S | |
1017 This stands for the seconds (00-60). | |
1018 @item %t | |
1019 This stands for a tab character. | |
1020 @item %T | |
1021 This is a synonym for @samp{%H:%M:%S}. | |
1022 @item %U | |
1023 This stands for the week of the year (01-52), assuming that weeks | |
1024 start on Sunday. | |
1025 @item %w | |
1026 This stands for the numeric day of week (0-6). Sunday is day 0. | |
1027 @item %W | |
1028 This stands for the week of the year (01-52), assuming that weeks | |
1029 start on Monday. | |
1030 @item %x | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1031 This has a locale-specific meaning. In the default locale (named |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1032 @samp{C}), it is equivalent to @samp{%D}. |
12067 | 1033 @item %X |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1034 This has a locale-specific meaning. In the default locale (named |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1035 @samp{C}), it is equivalent to @samp{%T}. |
12067 | 1036 @item %y |
1037 This stands for the year without century (00-99). | |
1038 @item %Y | |
1039 This stands for the year with century. | |
1040 @item %Z | |
1041 This stands for the time zone abbreviation. | |
1042 @end table | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1043 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1044 You can also specify the field width and type of padding for any of |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1045 these @samp{%}-sequences. This works as in @code{printf}: you write |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1046 the field width as digits in the middle of a @samp{%}-sequences. If you |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1047 start the field width with @samp{0}, it means to pad with zeros. If you |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1048 start the field width with @samp{_}, it means to pad with spaces. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1049 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1050 For example, @samp{%S} specifies the number of seconds since the minute; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1051 @samp{%03S} means to pad this with zeros to 3 positions, @samp{%_3S} to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1052 pad with spaces to 3 positions. Plain @samp{%3S} pads with zeros, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1053 because that is how @samp{%S} normally pads to two positions. |
12067 | 1054 @end defun |
1055 | |
1056 @defun decode-time time | |
12098 | 1057 This function converts a time value into calendrical information. The |
1058 return value is a list of nine elements, as follows: | |
12067 | 1059 |
1060 @example | |
1061 (@var{seconds} @var{minutes} @var{hour} @var{day} @var{month} @var{year} @var{dow} @var{dst} @var{zone}) | |
1062 @end example | |
1063 | |
1064 Here is what the elements mean: | |
1065 | |
1066 @table @var | |
1067 @item sec | |
1068 The number of seconds past the minute, as an integer between 0 and 59. | |
1069 @item minute | |
1070 The number of minutes past the hour, as an integer between 0 and 59. | |
1071 @item hour | |
1072 The hour of the day, as an integer between 0 and 23. | |
1073 @item day | |
1074 The day of the month, as an integer between 1 and 31. | |
1075 @item month | |
1076 The month of the year, as an integer between 1 and 12. | |
1077 @item year | |
1078 The year, an integer typically greater than 1900. | |
1079 @item dow | |
1080 The day of week, as an integer between 0 and 6, where 0 stands for | |
1081 Sunday. | |
1082 @item dst | |
1083 @code{t} if daylight savings time is effect, otherwise @code{nil}. | |
1084 @item zone | |
12098 | 1085 An integer indicating the time zone, as the number of seconds east of |
1086 Greenwich. | |
12067 | 1087 @end table |
1088 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1089 @strong{Common Lisp Note:} Common Lisp has different meanings for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1090 @var{dow} and @var{zone}. |
12067 | 1091 @end defun |
1092 | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1093 @defun encode-time seconds minutes hour day month year &optional @dots{}zone |
12067 | 1094 This function is the inverse of @code{decode-time}. It converts seven |
12098 | 1095 items of calendrical data into a time value. For the meanings of the |
1096 arguments, see the table above under @code{decode-time}. | |
12067 | 1097 |
1098 Year numbers less than 100 are treated just like other year numbers. If | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
1099 you want them to stand for years above 1900, you must alter them yourself |
12067 | 1100 before you call @code{encode-time}. |
1101 | |
1102 The optional argument @var{zone} defaults to the current time zone and | |
1103 its daylight savings time rules. If specified, it can be either a list | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1104 (as you would get from @code{current-time-zone}), a string as in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1105 @code{TZ} environment variable, or an integer (as you would get from |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1106 @code{decode-time}). The specified zone is used without any further |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1107 alteration for daylight savings time. |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1108 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1109 If you pass more than seven arguments to @code{encode-time}, the first |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1110 six are used as @var{seconds} through @var{year}, the last argument is |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1111 used as @var{zone}, and the arguments in between are ignored. This |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1112 feature makes it possible to use the elements of a list returned by |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1113 @code{decode-time} as the arguments to @code{encode-time}, like this: |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1114 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1115 @example |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1116 (apply 'encode-time (decode-time @dots{})) |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1117 @end example |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1118 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1119 You can perform simple date arithmetic by using out-of-range values for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1120 the @var{sec}, @var{minute}, @var{hour}, @var{day}, and @var{month} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1121 arguments; for example, day 0 means the day preceding the given month. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1122 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1123 The operating system puts limits on the range of possible time values; |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1124 if you try to encode a time that is out of range, an error results. |
6558 | 1125 @end defun |
1126 | |
1127 @node Timers | |
12098 | 1128 @section Timers for Delayed Execution |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1129 @cindex timer |
6558 | 1130 |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1131 You can set up a @dfn{timer} to call a function at a specified future time or |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1132 after a certain length of idleness. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1133 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1134 Emacs cannot run timers at any arbitrary point in a Lisp program; it |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1135 can run them only when Emacs could accept output from a subprocess: |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1136 namely, while waiting or inside certain primitive functions such as |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1137 @code{sit-for} or @code{read-event} which @emph{can} wait. Therefore, a |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1138 timer's execution may be delayed if Emacs is busy. However, the time of |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1139 execution is very precise if Emacs is idle. |
6558 | 1140 |
1141 @defun run-at-time time repeat function &rest args | |
1142 This function arranges to call @var{function} with arguments @var{args} | |
1143 at time @var{time}. The argument @var{function} is a function to call | |
1144 later, and @var{args} are the arguments to give it when it is called. | |
1145 The time @var{time} is specified as a string. | |
1146 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1147 Absolute times may be specified in a wide variety of formats; this |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1148 function tries to accept all the commonly used date formats. Valid |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1149 formats include these two, |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1150 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1151 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1152 @var{year}-@var{month}-@var{day} @var{hour}:@var{min}:@var{sec} @var{timezone} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1153 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1154 @var{hour}:@var{min}:@var{sec} @var{timezone} @var{month}/@var{day}/@var{year} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1155 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1156 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1157 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1158 where in both examples all fields are numbers; the format that |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1159 @code{current-time-string} returns is also allowed, and many others |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1160 as well. |
6558 | 1161 |
1162 To specify a relative time, use numbers followed by units. | |
1163 For example: | |
1164 | |
1165 @table @samp | |
1166 @item 1 min | |
1167 denotes 1 minute from now. | |
1168 @item 1 min 5 sec | |
1169 denotes 65 seconds from now. | |
1170 @item 1 min 2 sec 3 hour 4 day 5 week 6 fortnight 7 month 8 year | |
1171 denotes exactly 103 months, 123 days, and 10862 seconds from now. | |
1172 @end table | |
1173 | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1174 If @var{time} is a number (integer or floating point), that specifies a |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1175 relative time measured in seconds. |
6558 | 1176 |
1177 The argument @var{repeat} specifies how often to repeat the call. If | |
1178 @var{repeat} is @code{nil}, there are no repetitions; @var{function} is | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1179 called just once, at @var{time}. If @var{repeat} is a number, it |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1180 specifies a repetition period measured in seconds. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1181 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1182 In most cases, @var{repeat} has no effect on when @emph{first} call |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1183 takes place---@var{time} alone specifies that. There is one exception: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1184 if @var{time} is @code{t}, then the timer runs whenever the time is a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1185 multiple of @var{repeat} seconds after the epoch. This is useful for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1186 functions like @code{display-time}. |
9009 | 1187 |
1188 The function @code{run-at-time} returns a timer value that identifies | |
1189 the particular scheduled future action. You can use this value to call | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1190 @code{cancel-timer} (see below). |
6558 | 1191 @end defun |
1192 | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1193 @defmac with-timeout (seconds timeout-forms@dots{}) body@dots{} |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1194 Execute @var{body}, but give up after @var{seconds} seconds. If |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1195 @var{body} finishes before the time is up, @code{with-timeout} returns |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1196 the value of the last form in @var{body}. If, however, the execution of |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1197 @var{body} is cut short by the timeout, then @code{with-timeout} |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1198 executes all the @var{timeout-forms} and returns the value of the last |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1199 of them. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1200 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1201 This macro works by setting a timer to run after @var{seconds} seconds. If |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1202 @var{body} finishes before that time, it cancels the timer. If the |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1203 timer actually runs, it terminates execution of @var{body}, then |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1204 executes @var{timeout-forms}. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1205 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1206 Since timers can run within a Lisp program only when the program calls a |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1207 primitive that can wait, @code{with-timeout} cannot stop executing |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1208 @var{body} while it is in the midst of a computation---only when it |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1209 calls one of those primitives. So use @code{with-timeout} only with a |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1210 @var{body} that waits for input, not one that does a long computation. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1211 @end defmac |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1212 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1213 The function @code{y-or-n-p-with-timeout} provides a simple way to use |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1214 a timer to avoid waiting too long for an answer. @xref{Yes-or-No |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1215 Queries}. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1216 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1217 @defun run-with-idle-timer secs repeat function &rest args |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1218 Set up a timer which runs when Emacs has been idle for @var{secs} |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1219 seconds. The value of @var{secs} may be an integer or a floating point |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1220 number. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1221 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1222 If @var{repeat} is @code{nil}, the timer runs just once, the first time |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1223 Emacs remains idle for a long enough time. More often @var{repeat} is |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1224 non-@code{nil}, which means to run the timer @emph{each time} Emacs |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1225 remains idle for @var{secs} seconds. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1226 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1227 The function @code{run-with-idle-timer} returns a timer value which you |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1228 can use in calling @code{cancel-timer} (see below). |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1229 @end defun |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1230 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1231 @cindex idleness |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1232 Emacs becomes ``idle'' when it starts waiting for user input, and it |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1233 remains idle until the user provides some input. If a timer is set for |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1234 five seconds of idleness, it runs approximately five seconds after Emacs |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1235 first became idle. Even if its @var{repeat} is true, this timer will |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1236 not run again as long as Emacs remains idle, because the duration of |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1237 idleness will continue to increase and will not go down to five seconds |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1238 again. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1239 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1240 Emacs can do various things while idle: garbage collect, autosave or |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1241 handle data from a subprocess. But these interludes during idleness do |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1242 not interfere with idle timers, because they do not reset the clock of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1243 idleness to zero. An idle timer set for 600 seconds will run when ten |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1244 minutes have elapsed since the last user command was finished, even if |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1245 subprocess output has been accepted thousands of times within those ten |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1246 minutes, even if there have been garbage collections and autosaves. |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1247 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1248 When the user supplies input, Emacs becomes non-idle while executing the |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1249 input. Then it becomes idle again, and all the idle timers that are |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1250 set up to repeat will subsequently run another time, one by one. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1251 |
6558 | 1252 @defun cancel-timer timer |
1253 Cancel the requested action for @var{timer}, which should be a value | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1254 previously returned by @code{run-at-time} or @code{run-with-idle-timer}. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1255 This cancels the effect of that call to @code{run-at-time}; the arrival |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1256 of the specified time will not cause anything special to happen. |
6558 | 1257 @end defun |
1258 | |
1259 @node Terminal Input | |
1260 @section Terminal Input | |
1261 @cindex terminal input | |
1262 | |
1263 This section describes functions and variables for recording or | |
1264 manipulating terminal input. See @ref{Display}, for related | |
1265 functions. | |
1266 | |
1267 @menu | |
1268 * Input Modes:: Options for how input is processed. | |
1269 * Translating Input:: Low level conversion of some characters or events | |
1270 into others. | |
1271 * Recording Input:: Saving histories of recent or all input events. | |
1272 @end menu | |
1273 | |
1274 @node Input Modes | |
1275 @subsection Input Modes | |
1276 @cindex input modes | |
1277 @cindex terminal input modes | |
1278 | |
1279 @defun set-input-mode interrupt flow meta quit-char | |
1280 This function sets the mode for reading keyboard input. If | |
1281 @var{interrupt} is non-null, then Emacs uses input interrupts. If it is | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1282 @code{nil}, then it uses @sc{cbreak} mode. The default setting is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1283 system dependent. Some systems always use @sc{cbreak} mode regardless |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1284 of what is specified. |
6558 | 1285 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1286 When Emacs communicates directly with X, it ignores this argument and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1287 uses interrupts if that is the way it knows how to communicate. |
6558 | 1288 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1289 If @var{flow} is non-@code{nil}, then Emacs uses @sc{xon/xoff} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1290 (@kbd{C-q}, @kbd{C-s}) flow control for output to the terminal. This |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1291 has no effect except in @sc{cbreak} mode. @xref{Flow Control}. |
6558 | 1292 |
1293 @c Emacs 19 feature | |
1294 The argument @var{meta} controls support for input character codes | |
1295 above 127. If @var{meta} is @code{t}, Emacs converts characters with | |
1296 the 8th bit set into Meta characters. If @var{meta} is @code{nil}, | |
1297 Emacs disregards the 8th bit; this is necessary when the terminal uses | |
1298 it as a parity bit. If @var{meta} is neither @code{t} nor @code{nil}, | |
1299 Emacs uses all 8 bits of input unchanged. This is good for terminals | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1300 that use 8-bit character sets. |
6558 | 1301 |
1302 @c Emacs 19 feature | |
1303 If @var{quit-char} is non-@code{nil}, it specifies the character to | |
1304 use for quitting. Normally this character is @kbd{C-g}. | |
1305 @xref{Quitting}. | |
1306 @end defun | |
1307 | |
1308 The @code{current-input-mode} function returns the input mode settings | |
1309 Emacs is currently using. | |
1310 | |
1311 @c Emacs 19 feature | |
1312 @defun current-input-mode | |
1313 This function returns current mode for reading keyboard input. It | |
1314 returns a list, corresponding to the arguments of @code{set-input-mode}, | |
1315 of the form @code{(@var{interrupt} @var{flow} @var{meta} @var{quit})} in | |
1316 which: | |
1317 @table @var | |
1318 @item interrupt | |
1319 is non-@code{nil} when Emacs is using interrupt-driven input. If | |
1320 @code{nil}, Emacs is using @sc{cbreak} mode. | |
1321 @item flow | |
1322 is non-@code{nil} if Emacs uses @sc{xon/xoff} (@kbd{C-q}, @kbd{C-s}) | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1323 flow control for output to the terminal. This value is meaningful only |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1324 when @var{interrupt} is @code{nil}. |
6558 | 1325 @item meta |
12098 | 1326 is @code{t} if Emacs treats the eighth bit of input characters as |
6558 | 1327 the meta bit; @code{nil} means Emacs clears the eighth bit of every |
1328 input character; any other value means Emacs uses all eight bits as the | |
1329 basic character code. | |
1330 @item quit | |
1331 is the character Emacs currently uses for quitting, usually @kbd{C-g}. | |
1332 @end table | |
1333 @end defun | |
1334 | |
1335 @node Translating Input | |
1336 @subsection Translating Input Events | |
1337 @cindex translating input events | |
1338 | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1339 This section describes features for translating input events into |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1340 other input events before they become part of key sequences. These |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1341 features apply to each event in the order they are described here: each |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1342 event is first modified according to @code{extra-keyboard-modifiers}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1343 then translated through @code{keyboard-translate-table} (if applicable), |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1344 and finally decoded with the specified keyboard coding system. If it is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1345 being read as part of a key sequence, it is then added to the sequence |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1346 being read; then subsequences containing it are checked first with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1347 @code{function-key-map} and then with @code{key-translation-map}. |
6558 | 1348 |
1349 @c Emacs 19 feature | |
1350 @defvar extra-keyboard-modifiers | |
1351 This variable lets Lisp programs ``press'' the modifier keys on the | |
1352 keyboard. The value is a bit mask: | |
1353 | |
1354 @table @asis | |
1355 @item 1 | |
1356 The @key{SHIFT} key. | |
1357 @item 2 | |
1358 The @key{LOCK} key. | |
1359 @item 4 | |
1360 The @key{CTL} key. | |
1361 @item 8 | |
1362 The @key{META} key. | |
1363 @end table | |
1364 | |
1365 Each time the user types a keyboard key, it is altered as if the | |
1366 modifier keys specified in the bit mask were held down. | |
1367 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1368 When using a window system, the program can ``press'' any of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1369 modifier keys in this way. Otherwise, only the @key{CTL} and @key{META} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1370 keys can be virtually pressed. |
6558 | 1371 @end defvar |
1372 | |
1373 @defvar keyboard-translate-table | |
1374 This variable is the translate table for keyboard characters. It lets | |
1375 you reshuffle the keys on the keyboard without changing any command | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1376 bindings. Its value is normally a char-table, or else @code{nil}. |
6558 | 1377 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1378 If @code{keyboard-translate-table} is a char-table, then each character |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1379 read from the keyboard is looked up in this character. If the value |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1380 found there is non-@code{nil}, then it is used instead of the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1381 actual input character. |
6558 | 1382 |
1383 In the example below, we set @code{keyboard-translate-table} to a | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1384 char-table. Then we fill it in to swap the characters @kbd{C-s} and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1385 @kbd{C-\} and the characters @kbd{C-q} and @kbd{C-^}. Subsequently, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1386 typing @kbd{C-\} has all the usual effects of typing @kbd{C-s}, and vice |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1387 versa. (@xref{Flow Control} for more information on this subject.) |
6558 | 1388 |
1389 @cindex flow control example | |
1390 @example | |
1391 @group | |
1392 (defun evade-flow-control () | |
1393 "Replace C-s with C-\ and C-q with C-^." | |
1394 (interactive) | |
1395 @end group | |
1396 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1397 (setq keyboard-translate-table |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1398 (make-char-table 'keyboard-translate-table nil)) |
6558 | 1399 @end group |
1400 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1401 ;; @r{Swap @kbd{C-s} and @kbd{C-\}.} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1402 (aset keyboard-translate-table ?\034 ?\^s) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1403 (aset keyboard-translate-table ?\^s ?\034) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1404 @end group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1405 @group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1406 ;; @r{Swap @kbd{C-q} and @kbd{C-^}.} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1407 (aset keyboard-translate-table ?\036 ?\^q) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1408 (aset keyboard-translate-table ?\^q ?\036)) |
6558 | 1409 @end group |
1410 @end example | |
1411 | |
1412 Note that this translation is the first thing that happens to a | |
1413 character after it is read from the terminal. Record-keeping features | |
1414 such as @code{recent-keys} and dribble files record the characters after | |
1415 translation. | |
1416 @end defvar | |
1417 | |
1418 @defun keyboard-translate from to | |
1419 This function modifies @code{keyboard-translate-table} to translate | |
1420 character code @var{from} into character code @var{to}. It creates | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1421 the keyboard translate table if necessary. |
6558 | 1422 @end defun |
1423 | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1424 The remaining translation features translate subsequences of key |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1425 sequences being read. They are implemented in @code{read-key-sequence} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1426 and have no effect on input read with @code{read-event}. |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1427 |
6558 | 1428 @defvar function-key-map |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1429 This variable holds a keymap that describes the character sequences sent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1430 by function keys on an ordinary character terminal. This keymap has the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1431 same structure as other keymaps, but is used differently: it specifies |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1432 translations to make while reading key sequences, rather than bindings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1433 for key sequences. |
6558 | 1434 |
1435 If @code{function-key-map} ``binds'' a key sequence @var{k} to a vector | |
1436 @var{v}, then when @var{k} appears as a subsequence @emph{anywhere} in a | |
1437 key sequence, it is replaced with the events in @var{v}. | |
1438 | |
1439 For example, VT100 terminals send @kbd{@key{ESC} O P} when the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1440 keypad @key{PF1} key is pressed. Therefore, we want Emacs to translate |
6558 | 1441 that sequence of events into the single event @code{pf1}. We accomplish |
1442 this by ``binding'' @kbd{@key{ESC} O P} to @code{[pf1]} in | |
1443 @code{function-key-map}, when using a VT100. | |
1444 | |
1445 Thus, typing @kbd{C-c @key{PF1}} sends the character sequence @kbd{C-c | |
1446 @key{ESC} O P}; later the function @code{read-key-sequence} translates | |
1447 this back into @kbd{C-c @key{PF1}}, which it returns as the vector | |
1448 @code{[?\C-c pf1]}. | |
1449 | |
1450 Entries in @code{function-key-map} are ignored if they conflict with | |
1451 bindings made in the minor mode, local, or global keymaps. The intent | |
1452 is that the character sequences that function keys send should not have | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1453 command bindings in their own right---but if they do, the ordinary |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1454 bindings take priority. |
6558 | 1455 |
1456 The value of @code{function-key-map} is usually set up automatically | |
1457 according to the terminal's Terminfo or Termcap entry, but sometimes | |
1458 those need help from terminal-specific Lisp files. Emacs comes with | |
1459 terminal-specific files for many common terminals; their main purpose is | |
1460 to make entries in @code{function-key-map} beyond those that can be | |
1461 deduced from Termcap and Terminfo. @xref{Terminal-Specific}. | |
1462 @end defvar | |
1463 | |
1464 @defvar key-translation-map | |
1465 This variable is another keymap used just like @code{function-key-map} | |
1466 to translate input events into other events. It differs from | |
1467 @code{function-key-map} in two ways: | |
1468 | |
1469 @itemize @bullet | |
1470 @item | |
1471 @code{key-translation-map} goes to work after @code{function-key-map} is | |
1472 finished; it receives the results of translation by | |
1473 @code{function-key-map}. | |
1474 | |
1475 @item | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1476 @code{key-translation-map} overrides actual key bindings. For example, |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1477 if @kbd{C-x f} has a binding in @code{key-translation-map}, that |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1478 translation takes effect even though @kbd{C-x f} also has a key binding |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1479 in the global map. |
6558 | 1480 @end itemize |
1481 | |
1482 The intent of @code{key-translation-map} is for users to map one | |
1483 character set to another, including ordinary characters normally bound | |
1484 to @code{self-insert-command}. | |
1485 @end defvar | |
1486 | |
1487 @cindex key translation function | |
1488 You can use @code{function-key-map} or @code{key-translation-map} for | |
1489 more than simple aliases, by using a function, instead of a key | |
1490 sequence, as the ``translation'' of a key. Then this function is called | |
1491 to compute the translation of that key. | |
1492 | |
1493 The key translation function receives one argument, which is the prompt | |
1494 that was specified in @code{read-key-sequence}---or @code{nil} if the | |
1495 key sequence is being read by the editor command loop. In most cases | |
1496 you can ignore the prompt value. | |
1497 | |
1498 If the function reads input itself, it can have the effect of altering | |
1499 the event that follows. For example, here's how to define @kbd{C-c h} | |
1500 to turn the character that follows into a Hyper character: | |
1501 | |
1502 @example | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
1503 @group |
6558 | 1504 (defun hyperify (prompt) |
1505 (let ((e (read-event))) | |
1506 (vector (if (numberp e) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1507 (logior (lsh 1 24) e) |
6558 | 1508 (if (memq 'hyper (event-modifiers e)) |
1509 e | |
1510 (add-event-modifier "H-" e)))))) | |
1511 | |
1512 (defun add-event-modifier (string e) | |
1513 (let ((symbol (if (symbolp e) e (car e)))) | |
1514 (setq symbol (intern (concat string | |
1515 (symbol-name symbol)))) | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
1516 @end group |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
1517 @group |
6558 | 1518 (if (symbolp e) |
1519 symbol | |
1520 (cons symbol (cdr e))))) | |
1521 | |
1522 (define-key function-key-map "\C-ch" 'hyperify) | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
1523 @end group |
6558 | 1524 @end example |
1525 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1526 Finally, if you have enabled keyboard character set decoding using |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1527 @code{set-keyboard-coding-system}, decoding is done after the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1528 translations listed above. @xref{Specifying Coding Systems}. In future |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1529 Emacs versions, character set decoding may be done before the other |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1530 translations. |
6558 | 1531 |
1532 @node Recording Input | |
1533 @subsection Recording Input | |
1534 | |
1535 @defun recent-keys | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1536 This function returns a vector containing the last 100 input events from |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1537 the keyboard or mouse. All input events are included, whether or not |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1538 they were used as parts of key sequences. Thus, you always get the last |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1539 100 input events, not counting events generated by keyboard macros. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1540 (These are excluded because they are less interesting for debugging; it |
9009 | 1541 should be enough to see the events that invoked the macros.) |
6558 | 1542 @end defun |
1543 | |
1544 @deffn Command open-dribble-file filename | |
1545 @cindex dribble file | |
1546 This function opens a @dfn{dribble file} named @var{filename}. When a | |
1547 dribble file is open, each input event from the keyboard or mouse (but | |
1548 not those from keyboard macros) is written in that file. A | |
1549 non-character event is expressed using its printed representation | |
1550 surrounded by @samp{<@dots{}>}. | |
1551 | |
1552 You close the dribble file by calling this function with an argument | |
1553 of @code{nil}. | |
1554 | |
1555 This function is normally used to record the input necessary to | |
1556 trigger an Emacs bug, for the sake of a bug report. | |
1557 | |
1558 @example | |
1559 @group | |
1560 (open-dribble-file "~/dribble") | |
1561 @result{} nil | |
1562 @end group | |
1563 @end example | |
1564 @end deffn | |
1565 | |
1566 See also the @code{open-termscript} function (@pxref{Terminal Output}). | |
1567 | |
1568 @node Terminal Output | |
1569 @section Terminal Output | |
1570 @cindex terminal output | |
1571 | |
1572 The terminal output functions send output to the terminal or keep | |
1573 track of output sent to the terminal. The variable @code{baud-rate} | |
1574 tells you what Emacs thinks is the output speed of the terminal. | |
1575 | |
1576 @defvar baud-rate | |
1577 This variable's value is the output speed of the terminal, as far as | |
1578 Emacs knows. Setting this variable does not change the speed of actual | |
1579 data transmission, but the value is used for calculations such as | |
1580 padding. It also affects decisions about whether to scroll part of the | |
9009 | 1581 screen or repaint---even when using a window system. (We designed it |
6558 | 1582 this way despite the fact that a window system has no true ``output |
1583 speed'', to give you a way to tune these decisions.) | |
1584 | |
1585 The value is measured in baud. | |
1586 @end defvar | |
1587 | |
1588 If you are running across a network, and different parts of the | |
1589 network work at different baud rates, the value returned by Emacs may be | |
1590 different from the value used by your local terminal. Some network | |
1591 protocols communicate the local terminal speed to the remote machine, so | |
1592 that Emacs and other programs can get the proper value, but others do | |
1593 not. If Emacs has the wrong value, it makes decisions that are less | |
1594 than optimal. To fix the problem, set @code{baud-rate}. | |
1595 | |
1596 @defun baud-rate | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1597 This obsolete function returns the value of the variable |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1598 @code{baud-rate}. |
6558 | 1599 @end defun |
1600 | |
1601 @defun send-string-to-terminal string | |
1602 This function sends @var{string} to the terminal without alteration. | |
1603 Control characters in @var{string} have terminal-dependent effects. | |
1604 | |
1605 One use of this function is to define function keys on terminals that | |
1606 have downloadable function key definitions. For example, this is how on | |
1607 certain terminals to define function key 4 to move forward four | |
1608 characters (by transmitting the characters @kbd{C-u C-f} to the | |
1609 computer): | |
1610 | |
1611 @example | |
1612 @group | |
1613 (send-string-to-terminal "\eF4\^U\^F") | |
1614 @result{} nil | |
1615 @end group | |
1616 @end example | |
1617 @end defun | |
1618 | |
1619 @deffn Command open-termscript filename | |
1620 @cindex termscript file | |
1621 This function is used to open a @dfn{termscript file} that will record | |
1622 all the characters sent by Emacs to the terminal. It returns | |
1623 @code{nil}. Termscript files are useful for investigating problems | |
1624 where Emacs garbles the screen, problems that are due to incorrect | |
1625 Termcap entries or to undesirable settings of terminal options more | |
1626 often than to actual Emacs bugs. Once you are certain which characters | |
1627 were actually output, you can determine reliably whether they correspond | |
1628 to the Termcap specifications in use. | |
1629 | |
1630 See also @code{open-dribble-file} in @ref{Terminal Input}. | |
1631 | |
1632 @example | |
1633 @group | |
1634 (open-termscript "../junk/termscript") | |
1635 @result{} nil | |
1636 @end group | |
1637 @end example | |
1638 @end deffn | |
1639 | |
1640 @node Special Keysyms | |
1641 @section System-Specific X11 Keysyms | |
1642 | |
1643 To define system-specific X11 keysyms, set the variable | |
1644 @code{system-key-alist}. | |
1645 | |
1646 @defvar system-key-alist | |
1647 This variable's value should be an alist with one element for each | |
1648 system-specific keysym. An element has this form: @code{(@var{code} | |
1649 . @var{symbol})}, where @var{code} is the numeric keysym code (not | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1650 including the ``vendor specific'' bit, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1651 @ifinfo |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1652 -2**28, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1653 @end ifinfo |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1654 @tex |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1655 $-2^{28}$, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1656 @end tex |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1657 and @var{symbol} is the name for the function key. |
6558 | 1658 |
1659 For example @code{(168 . mute-acute)} defines a system-specific key used | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1660 by HP X servers whose numeric code is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1661 @ifinfo |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1662 -2**28 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1663 @end ifinfo |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1664 @tex |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1665 $-2^{28}$ |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1666 @end tex |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1667 + 168. |
6558 | 1668 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1669 It is not crucial to exclude from the alist the keysyms of other X |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1670 servers; those do no harm, as long as they don't conflict with the ones |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1671 used by the X server actually in use. |
12067 | 1672 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1673 The variable is always local to the current terminal, and cannot be |
12067 | 1674 buffer-local. @xref{Multiple Displays}. |
6558 | 1675 @end defvar |
1676 | |
1677 @node Flow Control | |
1678 @section Flow Control | |
1679 @cindex flow control characters | |
1680 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1681 This section attempts to answer the question ``Why does Emacs use |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1682 flow-control characters in its command character set?'' For a second |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1683 view on this issue, read the comments on flow control in the |
6558 | 1684 @file{emacs/INSTALL} file from the distribution; for help with Termcap |
1685 entries and DEC terminal concentrators, see @file{emacs/etc/TERMS}. | |
1686 | |
1687 @cindex @kbd{C-s} | |
1688 @cindex @kbd{C-q} | |
1689 At one time, most terminals did not need flow control, and none used | |
1690 @code{C-s} and @kbd{C-q} for flow control. Therefore, the choice of | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1691 @kbd{C-s} and @kbd{C-q} as command characters for searching and quoting |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1692 was natural and uncontroversial. With so many commands needing key |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1693 assignments, of course we assigned meanings to nearly all @sc{ASCII} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1694 control characters. |
6558 | 1695 |
1696 Later, some terminals were introduced which required these characters | |
1697 for flow control. They were not very good terminals for full-screen | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1698 editing, so Emacs maintainers ignored them. In later years, flow |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1699 control with @kbd{C-s} and @kbd{C-q} became widespread among terminals, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1700 but by this time it was usually an option. And the majority of Emacs |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1701 users, who can turn flow control off, did not want to switch to less |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1702 mnemonic key bindings for the sake of flow control. |
6558 | 1703 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1704 So which usage is ``right''---Emacs's or that of some terminal and |
6558 | 1705 concentrator manufacturers? This question has no simple answer. |
1706 | |
1707 One reason why we are reluctant to cater to the problems caused by | |
1708 @kbd{C-s} and @kbd{C-q} is that they are gratuitous. There are other | |
1709 techniques (albeit less common in practice) for flow control that | |
1710 preserve transparency of the character stream. Note also that their use | |
1711 for flow control is not an official standard. Interestingly, on the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1712 model 33 teletype with a paper tape punch (around 1970), @kbd{C-s} and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1713 @kbd{C-q} were sent by the computer to turn the punch on and off! |
6558 | 1714 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1715 As window systems and PC terminal emulators replace character-only |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1716 terminals, the flow control problem is gradually disappearing. For the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1717 mean time, Emacs provides a convenient way of enabling flow control if |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1718 you want it: call the function @code{enable-flow-control}. |
6558 | 1719 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1720 @deffn Command enable-flow-control |
6558 | 1721 This function enables use of @kbd{C-s} and @kbd{C-q} for output flow |
1722 control, and provides the characters @kbd{C-\} and @kbd{C-^} as aliases | |
1723 for them using @code{keyboard-translate-table} (@pxref{Translating Input}). | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1724 @end deffn |
6558 | 1725 |
1726 You can use the function @code{enable-flow-control-on} in your | |
1727 @file{.emacs} file to enable flow control automatically on certain | |
1728 terminal types. | |
1729 | |
1730 @defun enable-flow-control-on &rest termtypes | |
1731 This function enables flow control, and the aliases @kbd{C-\} and @kbd{C-^}, | |
1732 if the terminal type is one of @var{termtypes}. For example: | |
1733 | |
1734 @smallexample | |
1735 (enable-flow-control-on "vt200" "vt300" "vt101" "vt131") | |
1736 @end smallexample | |
1737 @end defun | |
1738 | |
1739 Here is how @code{enable-flow-control} does its job: | |
1740 | |
1741 @enumerate | |
1742 @item | |
1743 @cindex @sc{cbreak} | |
1744 It sets @sc{cbreak} mode for terminal input, and tells the operating | |
1745 system to handle flow control, with @code{(set-input-mode nil t)}. | |
1746 | |
1747 @item | |
1748 It sets up @code{keyboard-translate-table} to translate @kbd{C-\} and | |
9009 | 1749 @kbd{C-^} into @kbd{C-s} and @kbd{C-q}. Except at its very |
6558 | 1750 lowest level, Emacs never knows that the characters typed were anything |
1751 but @kbd{C-s} and @kbd{C-q}, so you can in effect type them as @kbd{C-\} | |
1752 and @kbd{C-^} even when they are input for other commands. | |
1753 @xref{Translating Input}. | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1754 @end enumerate |
6558 | 1755 |
1756 If the terminal is the source of the flow control characters, then once | |
1757 you enable kernel flow control handling, you probably can make do with | |
1758 less padding than normal for that terminal. You can reduce the amount | |
1759 of padding by customizing the Termcap entry. You can also reduce it by | |
1760 setting @code{baud-rate} to a smaller value so that Emacs uses a smaller | |
1761 speed when calculating the padding needed. @xref{Terminal Output}. | |
1762 | |
1763 @node Batch Mode | |
1764 @section Batch Mode | |
1765 @cindex batch mode | |
1766 @cindex noninteractive use | |
1767 | |
1768 The command line option @samp{-batch} causes Emacs to run | |
1769 noninteractively. In this mode, Emacs does not read commands from the | |
1770 terminal, it does not alter the terminal modes, and it does not expect | |
1771 to be outputting to an erasable screen. The idea is that you specify | |
1772 Lisp programs to run; when they are finished, Emacs should exit. The | |
1773 way to specify the programs to run is with @samp{-l @var{file}}, which | |
1774 loads the library named @var{file}, and @samp{-f @var{function}}, which | |
1775 calls @var{function} with no arguments. | |
1776 | |
1777 Any Lisp program output that would normally go to the echo area, | |
1778 either using @code{message} or using @code{prin1}, etc., with @code{t} | |
12098 | 1779 as the stream, goes instead to Emacs's standard error descriptor when |
6558 | 1780 in batch mode. Thus, Emacs behaves much like a noninteractive |
1781 application program. (The echo area output that Emacs itself normally | |
1782 generates, such as command echoing, is suppressed entirely.) | |
1783 | |
1784 @defvar noninteractive | |
1785 This variable is non-@code{nil} when Emacs is running in batch mode. | |
1786 @end defvar |