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