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