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