2 @c This is part of the GNU Emacs Lisp Reference Manual.
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
5 @c See the file elisp.texi for copying conditions.
6 @setfilename ../../info/os
7 @node System Interface, Antinews, Display, Top
8 @chapter Operating System Interface
10 This chapter is about starting and getting out of Emacs, access to
11 values in the operating system environment, and terminal input, output,
14 @xref{Building Emacs}, for related information. @xref{Display}, for
15 additional operating system status information pertaining to the
16 terminal and the screen.
19 * Starting Up:: Customizing Emacs startup processing.
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.
24 * Time Conversion:: Converting a time from numeric form to
25 calendrical data and vice versa.
26 * Time Parsing:: Converting a time from numeric form to text
28 * Processor Run Time:: Getting the run time used by Emacs.
29 * Time Calculations:: Adding, subtracting, comparing times, etc.
30 * Timers:: Setting a timer to call a function at a certain time.
31 * Idle Timers:: Setting a timer to call a function when Emacs has
32 been idle for a certain length of time.
33 * Terminal Input:: Accessing and recording terminal input.
34 * Terminal Output:: Controlling and recording terminal output.
35 * Sound Output:: Playing sounds on the computer's speaker.
36 * X11 Keysyms:: Operating on key symbols for X Windows.
37 * Batch Mode:: Running Emacs without terminal interaction.
38 * Session Management:: Saving and restoring state with X Session Management.
42 @section Starting Up Emacs
44 This section describes what Emacs does when it is started, and how you
45 can customize these actions.
48 * Startup Summary:: Sequence of actions Emacs performs at startup.
49 * Init File:: Details on reading the init file.
50 * Terminal-Specific:: How the terminal-specific Lisp file is read.
51 * Command-Line Arguments:: How command-line arguments are processed,
52 and how you can customize them.
56 @subsection Summary: Sequence of Actions at Startup
57 @cindex initialization of Emacs
58 @cindex startup of Emacs
59 @cindex @file{startup.el}
61 When Emacs is started up, it performs the following operations
62 (which are defined in @file{startup.el}):
66 It adds subdirectories to @code{load-path}, by running the file named
67 @file{subdirs.el} in each directory in the list. Normally, this file
68 adds the directory's subdirectories to the list, and those are scanned
69 in their turn. The files @file{subdirs.el} are normally generated
70 automatically when Emacs is installed.
72 @vindex before-init-time
74 It sets the variable @code{before-init-time} to the value of
75 @code{current-time} (@pxref{Time of Day}). It also sets
76 @code{after-init-time} to @code{nil}, which signals to Lisp programs
77 that Emacs is being initialized.
79 @vindex initial-window-system@r{, and startup}
80 @vindex window-system-initialization-alist
82 It loads the initialization library for the window system specified by
83 the variable @code{initial-window-system} (@pxref{Window Systems,
84 initial-window-system}). This library's name is
85 @file{term/@var{windowsystem}-win.el}, where @var{windowsystem} is the
86 value of @code{initial-window-system}. From that library, it calls
87 the appropriate initialization function. The initialization function
88 for each supported window system is specified by
89 @code{window-system-initialization-alist}.
92 It sets the language environment and the terminal coding system,
93 if requested by environment variables such as @code{LANG}.
96 It processes the initial options. (Some of them are handled
97 even earlier than this.)
100 It runs the normal hook @code{before-init-hook}.
103 It initializes the window frame and faces, if appropriate, and turns
104 on the menu bar and tool bar, if the initial frame needs them.
107 It loads the library @file{site-start}, if it exists. This is not
108 done if the options @samp{-Q} or @samp{--no-site-file} were specified.
109 @cindex @file{site-start.el}
112 It loads your init file (@pxref{Init File}). This is not done if the
113 options @samp{-q}, @samp{-Q}, or @samp{--batch} were specified. If
114 the @samp{-u} option was specified, Emacs looks for the init file in
115 that user's home directory instead.
118 It loads the library @file{default}, if it exists. This is not done
119 if @code{inhibit-default-init} is non-@code{nil}, nor if the options
120 @samp{-q}, @samp{-Q}, or @samp{--batch} were specified.
121 @cindex @file{default.el}
124 It loads your abbrevs from the file specified by
125 @code{abbrev-file-name}, if that file exists and can be read
126 (@pxref{Abbrev Files, abbrev-file-name}). This is not done if the
127 option @samp{--batch} was specified.
129 @vindex after-init-time
131 It sets the variable @code{after-init-time} to the value of
132 @code{current-time}. This variable was set to @code{nil} earlier;
133 setting it to the current time signals that the initialization phase
134 is over, and, together with @code{before-init-time}, provides the
135 measurement of how long it took.
138 It runs the normal hook @code{after-init-hook}.
141 If the buffer @samp{*scratch*} exists and is still in Fundamental mode
142 (as it should be by default), it sets its major mode according to
143 @code{initial-major-mode}.
146 If started on a text-only terminal, it loads the terminal-specific
147 Lisp library, which is specified by the variable
148 @code{term-file-prefix} (@pxref{Terminal-Specific}). This is not done
149 in @code{--batch} mode, nor if @code{term-file-prefix} is @code{nil}.
152 It displays the initial echo area message, unless you have suppressed
153 that with @code{inhibit-startup-echo-area-message}.
156 It processes the action arguments from the command line.
159 It now exits if the option @code{--batch} was specified.
162 If @code{initial-buffer-choice} is a string, it visits the file with
163 that name. Furthermore, if the @samp{*scratch*} buffer exists and is
164 empty, it inserts @code{initial-scratch-message} into that buffer.
167 It runs @code{emacs-startup-hook} and then @code{term-setup-hook}.
170 It calls @code{frame-notice-user-settings}, which modifies the
171 parameters of the selected frame according to whatever the init files
175 It runs @code{window-setup-hook}. @xref{Window Systems}.
178 If the option @code{--daemon} was specified, it calls
179 @code{server-start} and detaches from the controlling terminal.
180 @xref{Emacs Server,,, emacs, The GNU Emacs Manual}.
183 It displays the @dfn{startup screen}, which is a special buffer that
184 contains information about copyleft and basic Emacs usage. This is
185 not done if @code{initial-buffer-choice} or
186 @code{inhibit-startup-screen} are @code{nil}, nor if the
187 @samp{--no-splash} or @samp{-Q} command-line options were specified.
190 If started by the X session manager, it calls
191 @code{emacs-session-restore} passing it as argument the ID of the
192 previous session. @xref{Session Management}.
195 @defopt inhibit-startup-screen
196 This variable, if non-@code{nil}, inhibits the startup screen. In
197 that case, Emacs typically displays the @samp{*scratch*} buffer; but
198 see @code{initial-buffer-choice}, below.
200 Do not set this variable in the init file of a new user, or in a way
201 that affects more than one user, as that would prevent new users from
202 receiving information about copyleft and basic Emacs usage.
204 @code{inhibit-startup-message} and @code{inhibit-splash-screen} are
205 aliases for this variable.
208 @defopt initial-buffer-choice
209 This variable, if non-@code{nil}, determines a file or buffer for
210 Emacs to display after starting up, instead of the startup screen. If
211 its value is @code{t}, Emacs displays the @samp{*scratch*} buffer. If
212 its value is a string, that specifies the name of a file for Emacs to
216 @defopt inhibit-startup-echo-area-message
217 This variable controls the display of the startup echo area message.
218 You can suppress the startup echo area message by adding text with this
219 form to your init file:
222 (setq inhibit-startup-echo-area-message
223 "@var{your-login-name}")
226 Emacs explicitly checks for an expression as shown above in your init
227 file; your login name must appear in the expression as a Lisp string
228 constant. Other methods of setting
229 @code{inhibit-startup-echo-area-message} to the same value do not
230 inhibit the startup message. This way, you can easily inhibit the
231 message for yourself if you wish, but thoughtless copying of your init
232 file will not inhibit the message for someone else.
235 @defopt initial-scratch-message
236 This variable, if non-@code{nil}, should be a string, which is
237 inserted into the @samp{*scratch*} buffer when Emacs starts up. If it
238 is @code{nil}, the @samp{*scratch*} buffer is empty.
242 @subsection The Init File, @file{.emacs}
244 @cindex @file{.emacs}
246 When you start Emacs, it normally attempts to load your @dfn{init
247 file}. This is either a file named @file{.emacs} or @file{.emacs.el}
248 in your home directory, or a file named @file{init.el} in a
249 subdirectory named @file{.emacs.d} in your home directory. Whichever
250 place you use, you can also compile the file (@pxref{Byte
251 Compilation}); then the actual file loaded will be @file{.emacs.elc}
254 The command-line switches @samp{-q}, @samp{-Q}, and @samp{-u}
255 control whether and where to find the init file; @samp{-q} (and the
256 stronger @samp{-Q}) says not to load an init file, while @samp{-u
257 @var{user}} says to load @var{user}'s init file instead of yours.
258 @xref{Entering Emacs,,, emacs, The GNU Emacs Manual}. If neither
259 option is specified, Emacs uses the @code{LOGNAME} environment
260 variable, or the @code{USER} (most systems) or @code{USERNAME} (MS
261 systems) variable, to find your home directory and thus your init
262 file; this way, even if you have su'd, Emacs still loads your own init
263 file. If those environment variables are absent, though, Emacs uses
264 your user-id to find your home directory.
266 @cindex default init file
267 A site may have a @dfn{default init file}, which is the library
268 named @file{default.el}. Emacs finds the @file{default.el} file
269 through the standard search path for libraries (@pxref{How Programs Do
270 Loading}). The Emacs distribution does not come with this file; sites
271 may provide one for local customizations. If the default init file
272 exists, it is loaded whenever you start Emacs, except in batch mode or
273 if @samp{-q} (or @samp{-Q}) is specified. But your own personal init
274 file, if any, is loaded first; if it sets @code{inhibit-default-init}
275 to a non-@code{nil} value, then Emacs does not subsequently load the
276 @file{default.el} file.
278 Another file for site-customization is @file{site-start.el}. Emacs
279 loads this @emph{before} the user's init file. You can inhibit the
280 loading of this file with the option @samp{--no-site-file}.
282 @defopt site-run-file
283 This variable specifies the site-customization file to load before the
284 user's init file. Its normal value is @code{"site-start"}. The only
285 way you can change it with real effect is to do so before dumping
289 @xref{Init Examples,, Init File Examples, emacs, The GNU Emacs Manual}, for
290 examples of how to make various commonly desired customizations in your
293 @defopt inhibit-default-init
294 This variable prevents Emacs from loading the default initialization
295 library file for your session of Emacs. If its value is non-@code{nil},
296 then the default library is not loaded. The default value is
300 @defvar before-init-hook
301 This normal hook is run, once, just before loading all the init files
302 (the user's init file, @file{default.el}, and/or @file{site-start.el}).
303 (The only way to change it with real effect is before dumping Emacs.)
306 @defvar after-init-hook
307 This normal hook is run, once, just after loading all the init files
308 (the user's init file, @file{default.el}, and/or @file{site-start.el}),
309 before loading the terminal-specific library and processing the
310 command-line action arguments.
313 @defvar emacs-startup-hook
314 This normal hook is run, once, just after handling the command line
315 arguments, just before @code{term-setup-hook}.
318 @defvar user-init-file
319 This variable holds the absolute file name of the user's init file. If the
320 actual init file loaded is a compiled file, such as @file{.emacs.elc},
321 the value refers to the corresponding source file.
324 @defvar user-emacs-directory
325 This variable holds the name of the @file{.emacs.d} directory. It is
326 ordinarily @file{~/.emacs.d}, but differs on some platforms.
329 @node Terminal-Specific
330 @subsection Terminal-Specific Initialization
331 @cindex terminal-specific initialization
333 Each terminal type can have its own Lisp library that Emacs loads when
334 run on that type of terminal. The library's name is constructed by
335 concatenating the value of the variable @code{term-file-prefix} and the
336 terminal type (specified by the environment variable @code{TERM}).
337 Normally, @code{term-file-prefix} has the value
338 @code{"term/"}; changing this is not recommended. Emacs finds the file
339 in the normal manner, by searching the @code{load-path} directories, and
340 trying the @samp{.elc} and @samp{.el} suffixes.
343 The usual function of a terminal-specific library is to enable
344 special keys to send sequences that Emacs can recognize. It may also
345 need to set or add to @code{input-decode-map} if the Termcap or
346 Terminfo entry does not specify all the terminal's function keys.
347 @xref{Terminal Input}.
349 When the name of the terminal type contains a hyphen, and no library
350 is found whose name is identical to the terminal's name, Emacs strips
351 from the terminal's name the last hyphen and everything that follows
352 it, and tries again. This process is repeated until Emacs finds a
353 matching library or until there are no more hyphens in the name (the
354 latter means the terminal doesn't have any library specific to it).
355 Thus, for example, if there are no @samp{aaa-48} and @samp{aaa-30}
356 libraries, Emacs will try the same library @file{term/aaa.el} for
357 terminal types @samp{aaa-48} and @samp{aaa-30-rv}. If necessary, the
358 library can evaluate @code{(getenv "TERM")} to find the full name of
359 the terminal type.@refill
361 Your init file can prevent the loading of the
362 terminal-specific library by setting the variable
363 @code{term-file-prefix} to @code{nil}. This feature is useful when
364 experimenting with your own peculiar customizations.
366 You can also arrange to override some of the actions of the
367 terminal-specific library by setting the variable
368 @code{term-setup-hook}. This is a normal hook which Emacs runs using
369 @code{run-hooks} at the end of Emacs initialization, after loading both
370 your init file and any terminal-specific libraries. You can
371 use this variable to define initializations for terminals that do not
372 have their own libraries. @xref{Hooks}.
374 @defvar term-file-prefix
375 @cindex @code{TERM} environment variable
376 If the @code{term-file-prefix} variable is non-@code{nil}, Emacs loads
377 a terminal-specific initialization file as follows:
380 (load (concat term-file-prefix (getenv "TERM")))
384 You may set the @code{term-file-prefix} variable to @code{nil} in your
385 init file if you do not wish to load the
386 terminal-initialization file. To do this, put the following in
387 your init file: @code{(setq term-file-prefix nil)}.
389 On MS-DOS, if the environment variable @code{TERM} is not set, Emacs
390 uses @samp{internal} as the terminal type.
393 @defvar term-setup-hook
394 This variable is a normal hook that Emacs runs after loading your
395 init file, the default initialization file (if any) and the
396 terminal-specific Lisp file.
398 You can use @code{term-setup-hook} to override the definitions made by a
399 terminal-specific file.
402 See @code{window-setup-hook} in @ref{Window Systems}, for a related
405 @node Command-Line Arguments
406 @subsection Command-Line Arguments
407 @cindex command-line arguments
409 You can use command-line arguments to request various actions when you
410 start Emacs. Since you do not need to start Emacs more than once per
411 day, and will often leave your Emacs session running longer than that,
412 command-line arguments are hardly ever used. As a practical matter, it
413 is best to avoid making the habit of using them, since this habit would
414 encourage you to kill and restart Emacs unnecessarily often. These
415 options exist for two reasons: to be compatible with other editors (for
416 invocation by other programs) and to enable shell scripts to run
417 specific Lisp programs.
419 This section describes how Emacs processes command-line arguments,
420 and how you can customize them.
423 (Note that some other editors require you to start afresh each time
424 you want to edit a file. With this kind of editor, you will probably
425 specify the file as a command-line argument. The recommended way to
426 use GNU Emacs is to start it only once, just after you log in, and do
427 all your editing in the same Emacs process. Each time you want to edit
428 a different file, you visit it with the existing Emacs, which eventually
429 comes to have many files in it ready for editing. Usually you do not
430 kill the Emacs until you are about to log out.)
434 This function parses the command line that Emacs was called with,
435 processes it, loads the user's init file and displays the
439 @defvar command-line-processed
440 The value of this variable is @code{t} once the command line has been
443 If you redump Emacs by calling @code{dump-emacs}, you may wish to set
444 this variable to @code{nil} first in order to cause the new dumped Emacs
445 to process its new command-line arguments.
448 @defvar command-switch-alist
449 @cindex switches on command line
450 @cindex options on command line
451 @cindex command-line options
452 The value of this variable is an alist of user-defined command-line
453 options and associated handler functions. This variable exists so you
454 can add elements to it.
456 A @dfn{command-line option} is an argument on the command line, which
463 The elements of the @code{command-switch-alist} look like this:
466 (@var{option} . @var{handler-function})
469 The @sc{car}, @var{option}, is a string, the name of a command-line
470 option (not including the initial hyphen). The @var{handler-function}
471 is called to handle @var{option}, and receives the option name as its
474 In some cases, the option is followed in the command line by an
475 argument. In these cases, the @var{handler-function} can find all the
476 remaining command-line arguments in the variable
477 @code{command-line-args-left}. (The entire list of command-line
478 arguments is in @code{command-line-args}.)
480 The command-line arguments are parsed by the @code{command-line-1}
481 function in the @file{startup.el} file. See also @ref{Emacs
482 Invocation, , Command Line Arguments for Emacs Invocation, emacs, The
486 @defvar command-line-args
487 The value of this variable is the list of command-line arguments passed
491 @defvar command-line-args-left
492 The value of this variable is the list of command-line arguments that
493 have not yet been processed. @code{argv} is an alias for this.
496 @defvar command-line-functions
497 This variable's value is a list of functions for handling an
498 unrecognized command-line argument. Each time the next argument to be
499 processed has no special meaning, the functions in this list are called,
500 in order of appearance, until one of them returns a non-@code{nil}
503 These functions are called with no arguments. They can access the
504 command-line argument under consideration through the variable
505 @code{argi}, which is bound temporarily at this point. The remaining
506 arguments (not including the current one) are in the variable
507 @code{command-line-args-left}.
509 When a function recognizes and processes the argument in @code{argi}, it
510 should return a non-@code{nil} value to say it has dealt with that
511 argument. If it has also dealt with some of the following arguments, it
512 can indicate that by deleting them from @code{command-line-args-left}.
514 If all of these functions return @code{nil}, then the argument is used
515 as a file name to visit.
519 @section Getting Out of Emacs
520 @cindex exiting Emacs
522 There are two ways to get out of Emacs: you can kill the Emacs job,
523 which exits permanently, or you can suspend it, which permits you to
524 reenter the Emacs process later. As a practical matter, you seldom kill
525 Emacs---only when you are about to log out. Suspending is much more
529 * Killing Emacs:: Exiting Emacs irreversibly.
530 * Suspending Emacs:: Exiting Emacs reversibly.
534 @comment node-name, next, previous, up
535 @subsection Killing Emacs
536 @cindex killing Emacs
538 Killing Emacs means ending the execution of the Emacs process. The
539 parent process normally resumes control. The low-level primitive for
540 killing Emacs is @code{kill-emacs}.
542 @deffn Command kill-emacs &optional exit-data
543 This command exits the Emacs process and kills it.
545 If @var{exit-data} is an integer, then it is used as the exit status
546 of the Emacs process. (This is useful primarily in batch operation; see
549 If @var{exit-data} is a string, its contents are stuffed into the
550 terminal input buffer so that the shell (or whatever program next reads
551 input) can read them.
554 All the information in the Emacs process, aside from files that have
555 been saved, is lost when the Emacs process is killed. Because killing
556 Emacs inadvertently can lose a lot of work, Emacs queries for
557 confirmation before actually terminating if you have buffers that need
558 saving or subprocesses that are running. This is done in the function
559 @code{save-buffers-kill-emacs}, the higher level function from which
560 @code{kill-emacs} is usually called.
562 @defvar kill-emacs-query-functions
563 After asking the standard questions, @code{save-buffers-kill-emacs}
564 calls the functions in the list @code{kill-emacs-query-functions}, in
565 order of appearance, with no arguments. These functions can ask for
566 additional confirmation from the user. If any of them returns
567 @code{nil}, @code{save-buffers-kill-emacs} does not kill Emacs, and
568 does not run the remaining functions in this hook. Calling
569 @code{kill-emacs} directly does not run this hook.
572 @defvar kill-emacs-hook
573 This variable is a normal hook; once @code{save-buffers-kill-emacs} is
574 finished with all file saving and confirmation, it calls
575 @code{kill-emacs} which runs the functions in this hook.
576 @code{kill-emacs} does not run this hook in batch mode.
578 @code{kill-emacs} may be invoked directly (that is not via
579 @code{save-buffers-kill-emacs}) if the terminal is disconnected, or in
580 similar situations where interaction with the user is not possible.
581 Thus, if your hook needs to interact with the user, put it on
582 @code{kill-emacs-query-functions}; if it needs to run regardless of
583 how Emacs is killed, put it on @code{kill-emacs-hook}.
586 @node Suspending Emacs
587 @subsection Suspending Emacs
588 @cindex suspending Emacs
590 On text-only terminals, it is possible to @dfn{suspend Emacs}, which
591 means stopping Emacs temporarily and returning control to its superior
592 process, which is usually the shell. This allows you to resume
593 editing later in the same Emacs process, with the same buffers, the
594 same kill ring, the same undo history, and so on. To resume Emacs,
595 use the appropriate command in the parent shell---most likely
598 @cindex controlling terminal
599 Suspending works only on a terminal device from which the Emacs
600 session was started. We call that device the @dfn{controlling
601 terminal} of the session. Suspending is not allowed if the
602 controlling terminal is a graphical terminal.
604 Some operating systems do not support suspension of jobs; on these
605 systems, ``suspension'' actually creates a new shell temporarily as a
606 subprocess of Emacs. Then you would exit the shell to return to Emacs.
608 @deffn Command suspend-emacs &optional string
609 This function stops Emacs and returns control to the superior process.
610 If and when the superior process resumes Emacs, @code{suspend-emacs}
611 returns @code{nil} to its caller in Lisp.
613 This function works only on the controlling terminal of the Emacs
614 session; to relinquish control of other tty devices, use
615 @code{suspend-tty} (see below). If the Emacs session uses more than
616 one terminal, you must delete the frames on all the other terminals
617 before suspending Emacs, or this function signals an error.
618 @xref{Multiple Terminals}.
620 If @var{string} is non-@code{nil}, its characters are sent to Emacs's
621 superior shell, to be read as terminal input. The characters in
622 @var{string} are not echoed by the superior shell; only the results
625 Before suspending, @code{suspend-emacs} runs the normal hook
626 @code{suspend-hook}. After the user resumes Emacs,
627 @code{suspend-emacs} runs the normal hook @code{suspend-resume-hook}.
630 The next redisplay after resumption will redraw the entire screen,
631 unless the variable @code{no-redraw-on-reenter} is non-@code{nil}.
632 @xref{Refresh Screen}.
634 In the following example, note that @samp{pwd} is not echoed after
635 Emacs is suspended. But it is read and executed by the shell.
644 (add-hook 'suspend-hook
648 (error "Suspend canceled")))))
649 @result{} (lambda nil
650 (or (y-or-n-p "Really suspend? ")
651 (error "Suspend canceled")))
654 (add-hook 'suspend-resume-hook
655 (function (lambda () (message "Resumed!"))))
656 @result{} (lambda nil (message "Resumed!"))
659 (suspend-emacs "pwd")
663 ---------- Buffer: Minibuffer ----------
664 Really suspend? @kbd{y}
665 ---------- Buffer: Minibuffer ----------
669 ---------- Parent Shell ----------
670 lewis@@slug[23] % /user/lewis/manual
675 ---------- Echo Area ----------
682 This variable is a normal hook that Emacs runs before suspending.
685 @defvar suspend-resume-hook
686 This variable is a normal hook that Emacs runs on resuming
690 @defun suspend-tty &optional tty
691 If @var{tty} specifies a terminal device used by Emacs, this function
692 relinquishes the device and restores it to its prior state. Frames
693 that used the device continue to exist, but are not updated and Emacs
694 doesn't read input from them. @var{tty} can be a terminal object, a
695 frame (meaning the terminal for that frame), or @code{nil} (meaning
696 the terminal for the selected frame). @xref{Multiple Terminals}.
698 If @var{tty} is already suspended, this function does nothing.
700 This function runs the hook @code{suspend-tty-functions}, passing the
701 terminal object as an argument to each function.
704 @defun resume-tty &optional tty
705 This function resumes the previously suspended terminal device
706 @var{tty}; @var{tty} can be a terminal object, a frame (meaning the
707 terminal for that frame), or @code{nil} (meaning the terminal for the
710 This function reopens the terminal device, re-initializes it, and
711 redraws its with that terminal's selected frame. It then runs the
712 hook @code{resume-tty-functions}, passing the terminal object as an
713 argument to each function.
715 If the same device is already used by another Emacs terminal, this
716 function signals an error.
719 @defun controlling-tty-p &optional terminal
720 This function returns non-@code{nil} if @var{terminal} is the
721 controlling terminal of the Emacs session; @code{terminal} can be a
722 terminal object, a frame (meaning the terminal for that frame), or
723 @code{nil} (meaning the terminal for the selected frame).
726 @deffn Command suspend-frame
727 This command @dfn{suspends} a frame. For GUI frames, it calls
728 @code{iconify-frame} (@pxref{Visibility of Frames}); for text-only
729 frames, it calls either @code{suspend-emacs} or @code{suspend-tty},
730 depending on whether the frame is displayed on the controlling
731 terminal device or not.
734 @node System Environment
735 @section Operating System Environment
736 @cindex operating system environment
738 Emacs provides access to variables in the operating system environment
739 through various functions. These variables include the name of the
740 system, the user's @acronym{UID}, and so on.
742 @defvar system-configuration
743 This variable holds the standard GNU configuration name for the
744 hardware/software configuration of your system, as a string. The
745 convenient way to test parts of this string is with
749 @cindex system type and name
751 The value of this variable is a symbol indicating the type of operating
752 system Emacs is operating on. Here is a table of the possible values:
759 Berkeley BSD and its variants.
762 Cygwin, a Posix layer on top of MS-Windows.
768 The GNU system (using the GNU kernel, which consists of the HURD and Mach).
771 A GNU/Linux system---that is, a variant GNU system, using the Linux
772 kernel. (These systems are the ones people often call ``Linux,'' but
773 actually Linux is just the kernel, not the whole system.)
776 A GNU (glibc-based) system with a FreeBSD kernel.
779 Hewlett-Packard HPUX operating system.
782 Silicon Graphics Irix system.
788 Microsoft MS-DOS ``operating system.'' Emacs compiled with DJGPP for
789 MS-DOS binds @code{system-type} to @code{ms-dos} even when you run it on
796 Microsoft Windows NT and later. The same executable supports Windows
797 9X, but the value of @code{system-type} is @code{windows-nt} in either
802 We do not wish to add new symbols to make finer distinctions unless it
803 is absolutely necessary! In fact, we hope to eliminate some of these
804 alternatives in the future. We recommend using
805 @code{system-configuration} to distinguish between different operating
810 This function returns the name of the machine you are running on.
813 @result{} "www.gnu.org"
817 The symbol @code{system-name} is a variable as well as a function. In
818 fact, the function returns whatever value the variable
819 @code{system-name} currently holds. Thus, you can set the variable
820 @code{system-name} in case Emacs is confused about the name of your
821 system. The variable is also useful for constructing frame titles
822 (@pxref{Frame Titles}).
824 @defopt mail-host-address
825 If this variable is non-@code{nil}, it is used instead of
826 @code{system-name} for purposes of generating email addresses. For
827 example, it is used when constructing the default value of
828 @code{user-mail-address}. @xref{User Identification}. (Since this is
829 done when Emacs starts up, the value actually used is the one saved when
830 Emacs was dumped. @xref{Building Emacs}.)
833 @deffn Command getenv var &optional frame
834 @cindex environment variable access
835 This function returns the value of the environment variable @var{var},
836 as a string. @var{var} should be a string. If @var{var} is undefined
837 in the environment, @code{getenv} returns @code{nil}. If returns
838 @samp{""} if @var{var} is set but null. Within Emacs, the environment
839 variable values are kept in the Lisp variable @code{process-environment}.
848 lewis@@slug[10] % printenv
849 PATH=.:/user/lewis/bin:/usr/bin:/usr/local/bin
861 @deffn Command setenv variable &optional value
862 This command sets the value of the environment variable named
863 @var{variable} to @var{value}. @var{variable} should be a string.
864 Internally, Emacs Lisp can handle any string. However, normally
865 @var{variable} should be a valid shell identifier, that is, a sequence
866 of letters, digits and underscores, starting with a letter or
867 underscore. Otherwise, errors may occur if subprocesses of Emacs try
868 to access the value of @var{variable}. If @var{value} is omitted or
869 @code{nil}, @code{setenv} removes @var{variable} from the environment.
870 Otherwise, @var{value} should be a string.
872 @code{setenv} works by modifying @code{process-environment}; binding
873 that variable with @code{let} is also reasonable practice.
875 @code{setenv} returns the new value of @var{variable}, or @code{nil}
876 if it removed @var{variable} from the environment.
879 @defvar process-environment
880 This variable is a list of strings, each describing one environment
881 variable. The functions @code{getenv} and @code{setenv} work by means
887 @result{} ("l=/usr/stanford/lib/gnuemacs/lisp"
888 "PATH=.:/user/lewis/bin:/usr/class:/nfsusr/local/bin"
898 If @code{process-environment} contains ``duplicate'' elements that
899 specify the same environment variable, the first of these elements
900 specifies the variable, and the other ``duplicates'' are ignored.
903 @defvar initial-environment
904 This variable holds the list of environment variables Emacs inherited
905 from its parent process. It is computed during startup, see
906 @ref{Startup Summary}.
909 @defvar path-separator
910 This variable holds a string which says which character separates
911 directories in a search path (as found in an environment variable). Its
912 value is @code{":"} for Unix and GNU systems, and @code{";"} for MS-DOS
916 @defun parse-colon-path path
917 This function takes a search path string such as would be the value of
918 the @code{PATH} environment variable, and splits it at the separators,
919 returning a list of directory names. @code{nil} in this list stands for
920 ``use the current directory.'' Although the function's name says
921 ``colon,'' it actually uses the value of @code{path-separator}.
924 (parse-colon-path ":/foo:/bar")
925 @result{} (nil "/foo/" "/bar/")
929 @defvar invocation-name
930 This variable holds the program name under which Emacs was invoked. The
931 value is a string, and does not include a directory name.
934 @defvar invocation-directory
935 This variable holds the directory from which the Emacs executable was
936 invoked, or perhaps @code{nil} if that directory cannot be determined.
939 @defvar installation-directory
940 If non-@code{nil}, this is a directory within which to look for the
941 @file{lib-src} and @file{etc} subdirectories. This is non-@code{nil}
942 when Emacs can't find those directories in their standard installed
943 locations, but can find them in a directory related somehow to the one
944 containing the Emacs executable.
947 @defun load-average &optional use-float
948 This function returns the current 1-minute, 5-minute, and 15-minute load
951 By default, the values are integers that are 100 times the system load
952 averages, which indicate the average number of processes trying to run.
953 If @var{use-float} is non-@code{nil}, then they are returned
954 as floating point numbers and without multiplying by 100.
956 If it is impossible to obtain the load average, this function signals
957 an error. On some platforms, access to load averages requires
958 installing Emacs as setuid or setgid so that it can read kernel
959 information, and that usually isn't advisable.
961 If the 1-minute load average is available, but the 5- or 15-minute
962 averages are not, this function returns a shortened list containing
963 the available averages.
968 @result{} (169 48 36)
972 @result{} (1.69 0.48 0.36)
976 lewis@@rocky[5] % uptime
977 11:55am up 1 day, 19:37, 3 users,
978 load average: 1.69, 0.48, 0.36
984 This function returns the process @acronym{ID} of the Emacs process,
988 @defvar tty-erase-char
989 This variable holds the erase character that was selected
990 in the system's terminal driver, before Emacs was started.
991 The value is @code{nil} if Emacs is running under a window system.
994 @node User Identification
995 @section User Identification
996 @cindex user identification
998 @defvar init-file-user
999 This variable says which user's init files should be used by
1000 Emacs---or @code{nil} if none. @code{""} stands for the user who
1001 originally logged in. The value reflects command-line options such as
1002 @samp{-q} or @samp{-u @var{user}}.
1004 Lisp packages that load files of customizations, or any other sort of
1005 user profile, should obey this variable in deciding where to find it.
1006 They should load the profile of the user name found in this variable.
1007 If @code{init-file-user} is @code{nil}, meaning that the @samp{-q}
1008 option was used, then Lisp packages should not load any customization
1009 files or user profile.
1012 @defopt user-mail-address
1013 This holds the nominal email address of the user who is using Emacs.
1014 Emacs normally sets this variable to a default value after reading your
1015 init files, but not if you have already set it. So you can set the
1016 variable to some other value in your init file if you do not
1017 want to use the default value.
1020 @defun user-login-name &optional uid
1021 If you don't specify @var{uid}, this function returns the name under
1022 which the user is logged in. If the environment variable @code{LOGNAME}
1023 is set, that value is used. Otherwise, if the environment variable
1024 @code{USER} is set, that value is used. Otherwise, the value is based
1025 on the effective @acronym{UID}, not the real @acronym{UID}.
1027 If you specify @var{uid}, the value is the user name that corresponds
1028 to @var{uid} (which should be an integer), or @code{nil} if there is
1039 @defun user-real-login-name
1040 This function returns the user name corresponding to Emacs's real
1041 @acronym{UID}. This ignores the effective @acronym{UID} and ignores the
1042 environment variables @code{LOGNAME} and @code{USER}.
1045 @defun user-full-name &optional uid
1046 This function returns the full name of the logged-in user---or the value
1047 of the environment variable @code{NAME}, if that is set.
1049 @c "Bil" is the correct spelling.
1053 @result{} "Bil Lewis"
1057 If the Emacs job's user-id does not correspond to any known user (and
1058 provided @code{NAME} is not set), the value is @code{"unknown"}.
1060 If @var{uid} is non-@code{nil}, then it should be a number (a user-id)
1061 or a string (a login name). Then @code{user-full-name} returns the full
1062 name corresponding to that user-id or login name. If you specify a
1063 user-id or login name that isn't defined, it returns @code{nil}.
1066 @vindex user-full-name
1067 @vindex user-real-login-name
1068 @vindex user-login-name
1069 The symbols @code{user-login-name}, @code{user-real-login-name} and
1070 @code{user-full-name} are variables as well as functions. The functions
1071 return the same values that the variables hold. These variables allow
1072 you to ``fake out'' Emacs by telling the functions what to return. The
1073 variables are also useful for constructing frame titles (@pxref{Frame
1076 @defun user-real-uid
1077 This function returns the real @acronym{UID} of the user.
1078 The value may be a floating point number.
1089 This function returns the effective @acronym{UID} of the user.
1090 The value may be a floating point number.
1094 @section Time of Day
1096 This section explains how to determine the current time and the time
1099 @defun current-time-string &optional time-value
1100 This function returns the current time and date as a human-readable
1101 string. The format of the string is unvarying; the number of characters
1102 used for each part is always the same, so you can reliably use
1103 @code{substring} to extract pieces of it. It is wise to count the
1104 characters from the beginning of the string rather than from the end, as
1105 additional information may some day be added at the end.
1107 The argument @var{time-value}, if given, specifies a time to format
1108 instead of the current time. This argument should have the same form
1109 as the times obtained from @code{current-time} (see below) and from
1110 @code{file-attributes} (@pxref{Definition of file-attributes}). It
1111 should be a list whose first two elements are integers; a third
1112 (microsecond) element, if present, is ignored. @var{time-value} can
1113 also be a cons of two integers, but this usage is obsolete.
1117 (current-time-string)
1118 @result{} "Wed Oct 14 22:21:05 1987"
1124 This function returns the system's time value as a list of three
1125 integers: @code{(@var{high} @var{low} @var{microsec})}. The integers
1126 @var{high} and @var{low} combine to give the number of seconds since
1127 0:00 January 1, 1970 UTC (Coordinated Universal Time), which is
1129 @var{high} * 2**16 + @var{low}.
1135 The third element, @var{microsec}, gives the microseconds since the
1136 start of the current second (or 0 for systems that return time with
1137 the resolution of only one second).
1139 The first two elements can be compared with file time values such as you
1140 get with the function @code{file-attributes}.
1141 @xref{Definition of file-attributes}.
1144 @defun current-time-zone &optional time-value
1145 This function returns a list describing the time zone that the user is
1148 The value has the form @code{(@var{offset} @var{name})}. Here
1149 @var{offset} is an integer giving the number of seconds ahead of UTC
1150 (east of Greenwich). A negative value means west of Greenwich. The
1151 second element, @var{name}, is a string giving the name of the time
1152 zone. Both elements change when daylight saving time begins or ends;
1153 if the user has specified a time zone that does not use a seasonal time
1154 adjustment, then the value is constant through time.
1156 If the operating system doesn't supply all the information necessary to
1157 compute the value, the unknown elements of the list are @code{nil}.
1159 The argument @var{time-value}, if given, specifies a time to analyze
1160 instead of the current time. The argument should have the same form
1161 as for @code{current-time-string} (see above). Thus, you can use
1162 times obtained from @code{current-time} (see above) and from
1163 @code{file-attributes}. @xref{Definition of file-attributes}.
1166 @defun set-time-zone-rule tz
1167 This function specifies the local time zone according to @var{tz}. If
1168 @var{tz} is @code{nil}, that means to use an implementation-defined
1169 default time zone. If @var{tz} is @code{t}, that means to use
1170 Universal Time. Otherwise, @var{tz} should be a string specifying a
1174 @defun float-time &optional time-value
1175 This function returns the current time as a floating-point number of
1176 seconds since the epoch. The argument @var{time-value}, if given,
1177 specifies a time to convert instead of the current time. The argument
1178 should have the same form as for @code{current-time-string} (see
1179 above). Thus, it accepts the output of @code{current-time} and
1180 @code{file-attributes} (@pxref{Definition of file-attributes}).
1182 @emph{Warning}: Since the result is floating point, it may not be
1183 exact. Do not use this function if precise time stamps are required.
1186 @node Time Conversion
1187 @section Time Conversion
1189 These functions convert time values (lists of two or three integers)
1190 to calendrical information and vice versa. You can get time values
1191 from the functions @code{current-time} (@pxref{Time of Day}) and
1192 @code{file-attributes} (@pxref{Definition of file-attributes}).
1194 Many operating systems are limited to time values that contain 32 bits
1195 of information; these systems typically handle only the times from
1196 1901-12-13 20:45:52 UTC through 2038-01-19 03:14:07 UTC. However, some
1197 operating systems have larger time values, and can represent times far
1198 in the past or future.
1200 Time conversion functions always use the Gregorian calendar, even
1201 for dates before the Gregorian calendar was introduced. Year numbers
1202 count the number of years since the year 1 B.C., and do not skip zero
1203 as traditional Gregorian years do; for example, the year number
1204 @minus{}37 represents the Gregorian year 38 B.C@.
1206 @defun decode-time &optional time
1207 This function converts a time value into calendrical information. If
1208 you don't specify @var{time}, it decodes the current time. The return
1209 value is a list of nine elements, as follows:
1212 (@var{seconds} @var{minutes} @var{hour} @var{day} @var{month} @var{year} @var{dow} @var{dst} @var{zone})
1215 Here is what the elements mean:
1219 The number of seconds past the minute, as an integer between 0 and 59.
1220 On some operating systems, this is 60 for leap seconds.
1222 The number of minutes past the hour, as an integer between 0 and 59.
1224 The hour of the day, as an integer between 0 and 23.
1226 The day of the month, as an integer between 1 and 31.
1228 The month of the year, as an integer between 1 and 12.
1230 The year, an integer typically greater than 1900.
1232 The day of week, as an integer between 0 and 6, where 0 stands for
1235 @code{t} if daylight saving time is effect, otherwise @code{nil}.
1237 An integer indicating the time zone, as the number of seconds east of
1241 @strong{Common Lisp Note:} Common Lisp has different meanings for
1242 @var{dow} and @var{zone}.
1245 @defun encode-time seconds minutes hour day month year &optional zone
1246 This function is the inverse of @code{decode-time}. It converts seven
1247 items of calendrical data into a time value. For the meanings of the
1248 arguments, see the table above under @code{decode-time}.
1250 Year numbers less than 100 are not treated specially. If you want them
1251 to stand for years above 1900, or years above 2000, you must alter them
1252 yourself before you call @code{encode-time}.
1254 The optional argument @var{zone} defaults to the current time zone and
1255 its daylight saving time rules. If specified, it can be either a list
1256 (as you would get from @code{current-time-zone}), a string as in the
1257 @code{TZ} environment variable, @code{t} for Universal Time, or an
1258 integer (as you would get from @code{decode-time}). The specified
1259 zone is used without any further alteration for daylight saving time.
1261 If you pass more than seven arguments to @code{encode-time}, the first
1262 six are used as @var{seconds} through @var{year}, the last argument is
1263 used as @var{zone}, and the arguments in between are ignored. This
1264 feature makes it possible to use the elements of a list returned by
1265 @code{decode-time} as the arguments to @code{encode-time}, like this:
1268 (apply 'encode-time (decode-time @dots{}))
1271 You can perform simple date arithmetic by using out-of-range values for
1272 the @var{seconds}, @var{minutes}, @var{hour}, @var{day}, and @var{month}
1273 arguments; for example, day 0 means the day preceding the given month.
1275 The operating system puts limits on the range of possible time values;
1276 if you try to encode a time that is out of range, an error results.
1277 For instance, years before 1970 do not work on some systems;
1278 on others, years as early as 1901 do work.
1282 @section Parsing and Formatting Times
1284 These functions convert time values (lists of two or three integers)
1285 to text in a string, and vice versa.
1287 @defun date-to-time string
1288 This function parses the time-string @var{string} and returns the
1289 corresponding time value.
1292 @defun format-time-string format-string &optional time universal
1293 This function converts @var{time} (or the current time, if @var{time} is
1294 omitted) to a string according to @var{format-string}. The argument
1295 @var{format-string} may contain @samp{%}-sequences which say to
1296 substitute parts of the time. Here is a table of what the
1297 @samp{%}-sequences mean:
1301 This stands for the abbreviated name of the day of week.
1303 This stands for the full name of the day of week.
1305 This stands for the abbreviated name of the month.
1307 This stands for the full name of the month.
1309 This is a synonym for @samp{%x %X}.
1311 This has a locale-specific meaning. In the default locale (named C), it
1312 is equivalent to @samp{%A, %B %e, %Y}.
1314 This stands for the day of month, zero-padded.
1316 This is a synonym for @samp{%m/%d/%y}.
1318 This stands for the day of month, blank-padded.
1320 This is a synonym for @samp{%b}.
1322 This stands for the hour (00-23).
1324 This stands for the hour (01-12).
1326 This stands for the day of the year (001-366).
1328 This stands for the hour (0-23), blank padded.
1330 This stands for the hour (1-12), blank padded.
1332 This stands for the month (01-12).
1334 This stands for the minute (00-59).
1336 This stands for a newline.
1338 This stands for @samp{AM} or @samp{PM}, as appropriate.
1340 This is a synonym for @samp{%I:%M:%S %p}.
1342 This is a synonym for @samp{%H:%M}.
1344 This stands for the seconds (00-59).
1346 This stands for a tab character.
1348 This is a synonym for @samp{%H:%M:%S}.
1350 This stands for the week of the year (01-52), assuming that weeks
1353 This stands for the numeric day of week (0-6). Sunday is day 0.
1355 This stands for the week of the year (01-52), assuming that weeks
1358 This has a locale-specific meaning. In the default locale (named
1359 @samp{C}), it is equivalent to @samp{%D}.
1361 This has a locale-specific meaning. In the default locale (named
1362 @samp{C}), it is equivalent to @samp{%T}.
1364 This stands for the year without century (00-99).
1366 This stands for the year with century.
1368 This stands for the time zone abbreviation (e.g., @samp{EST}).
1370 This stands for the time zone numerical offset (e.g., @samp{-0500}).
1373 You can also specify the field width and type of padding for any of
1374 these @samp{%}-sequences. This works as in @code{printf}: you write
1375 the field width as digits in the middle of a @samp{%}-sequences. If you
1376 start the field width with @samp{0}, it means to pad with zeros. If you
1377 start the field width with @samp{_}, it means to pad with spaces.
1379 For example, @samp{%S} specifies the number of seconds since the minute;
1380 @samp{%03S} means to pad this with zeros to 3 positions, @samp{%_3S} to
1381 pad with spaces to 3 positions. Plain @samp{%3S} pads with zeros,
1382 because that is how @samp{%S} normally pads to two positions.
1384 The characters @samp{E} and @samp{O} act as modifiers when used between
1385 @samp{%} and one of the letters in the table above. @samp{E} specifies
1386 using the current locale's ``alternative'' version of the date and time.
1387 In a Japanese locale, for example, @code{%Ex} might yield a date format
1388 based on the Japanese Emperors' reigns. @samp{E} is allowed in
1389 @samp{%Ec}, @samp{%EC}, @samp{%Ex}, @samp{%EX}, @samp{%Ey}, and
1392 @samp{O} means to use the current locale's ``alternative''
1393 representation of numbers, instead of the ordinary decimal digits. This
1394 is allowed with most letters, all the ones that output numbers.
1396 If @var{universal} is non-@code{nil}, that means to describe the time as
1397 Universal Time; @code{nil} means describe it using what Emacs believes
1398 is the local time zone (see @code{current-time-zone}).
1400 This function uses the C library function @code{strftime}
1401 (@pxref{Formatting Calendar Time,,, libc, The GNU C Library Reference
1402 Manual}) to do most of the work. In order to communicate with that
1403 function, it first encodes its argument using the coding system
1404 specified by @code{locale-coding-system} (@pxref{Locales}); after
1405 @code{strftime} returns the resulting string,
1406 @code{format-time-string} decodes the string using that same coding
1410 @defun seconds-to-time seconds
1411 This function converts @var{seconds}, a floating point number of
1412 seconds since the epoch, to a time value and returns that. To perform
1413 the inverse conversion, use @code{float-time}.
1416 @defun format-seconds format-string seconds
1417 This function converts its argument @var{seconds} into a string of
1418 years, days, hours, etc., according to @var{format-string}. The
1419 argument @var{format-string} may contain @samp{%}-sequences which
1420 control the conversion. Here is a table of what the
1421 @samp{%}-sequences mean:
1426 The integer number of 365-day years.
1429 The integer number of days.
1432 The integer number of hours.
1435 The integer number of minutes.
1438 The integer number of seconds.
1440 Non-printing control flag. When it is used, other specifiers must be
1441 given in the order of decreasing size, i.e.@: years before days, hours
1442 before minutes, etc. Nothing will be produced in the result string to
1443 the left of @samp{%z} until the first non-zero conversion is
1444 encountered. For example, the default format used by
1445 @code{emacs-uptime} (@pxref{Processor Run Time, emacs-uptime})
1446 @w{@code{"%Y, %D, %H, %M, %z%S"}} means that the number of seconds
1447 will always be produced, but years, days, hours, and minutes will only
1448 be shown if they are non-zero.
1450 Produces a literal @samp{%}.
1453 Upper-case format sequences produce the units in addition to the
1454 numbers, lower-case formats produce only the numbers.
1456 You can also specify the field width by following the @samp{%} with a
1457 number; shorter numbers will be padded with blanks. An optional
1458 period before the width requests zero-padding instead. For example,
1459 @code{"%.3Y"} might produce @code{"004 years"}.
1461 @emph{Warning:} This function works only with values of @var{seconds}
1462 that don't exceed @code{most-positive-fixnum} (@pxref{Integer Basics,
1463 most-positive-fixnum}).
1466 @node Processor Run Time
1467 @section Processor Run time
1468 @cindex processor run time
1469 @cindex Emacs process run time
1471 Emacs provides several functions and primitives that return time,
1472 both elapsed and processor time, used by the Emacs process.
1474 @deffn Command emacs-uptime &optional format
1475 This function returns a string representing the Emacs
1476 @dfn{uptime}---the elapsed wall-clock time this instance of Emacs is
1477 running. The string is formatted by @code{format-seconds} according
1478 to the optional argument @var{format}. For the available format
1479 descriptors, see @ref{Time Parsing, format-seconds}. If @var{format}
1480 is @code{nil} or omitted, it defaults to @code{"%Y, %D, %H, %M,
1483 When called interactively, it prints the uptime in the echo area.
1486 @defun get-internal-run-time
1487 This function returns the processor run time used by Emacs as a list
1488 of three integers: @code{(@var{high} @var{low} @var{microsec})}. The
1489 integers @var{high} and @var{low} combine to give the number of
1492 @var{high} * 2**16 + @var{low}.
1498 The third element, @var{microsec}, gives the microseconds (or 0 for
1499 systems that return time with the resolution of only one second).
1501 Note that the time returned by this function excludes the time Emacs
1502 was not using the processor, and if the Emacs process has several
1503 threads, the returned value is the sum of the processor times used up
1504 by all Emacs threads.
1506 If the system doesn't provide a way to determine the processor run
1507 time, @code{get-internal-run-time} returns the same time as
1508 @code{current-time}.
1511 @deffn Command emacs-init-time
1512 This function returns the duration of the Emacs initialization
1513 (@pxref{Startup Summary}) in seconds, as a string. When called
1514 interactively, it prints the duration in the echo area.
1517 @node Time Calculations
1518 @section Time Calculations
1520 These functions perform calendrical computations using time values
1521 (the kind of list that @code{current-time} returns).
1523 @defun time-less-p t1 t2
1524 This returns @code{t} if time value @var{t1} is less than time value
1528 @defun time-subtract t1 t2
1529 This returns the time difference @var{t1} @minus{} @var{t2} between
1530 two time values, in the same format as a time value.
1533 @defun time-add t1 t2
1534 This returns the sum of two time values, one of which ought to
1535 represent a time difference rather than a point in time.
1536 Here is how to add a number of seconds to a time value:
1539 (time-add @var{time} (seconds-to-time @var{seconds}))
1543 @defun time-to-days time
1544 This function returns the number of days between the beginning of year
1548 @defun time-to-day-in-year time
1549 This returns the day number within the year corresponding to @var{time}.
1552 @defun date-leap-year-p year
1553 This function returns @code{t} if @var{year} is a leap year.
1557 @section Timers for Delayed Execution
1560 You can set up a @dfn{timer} to call a function at a specified
1561 future time or after a certain length of idleness.
1563 Emacs cannot run timers at any arbitrary point in a Lisp program; it
1564 can run them only when Emacs could accept output from a subprocess:
1565 namely, while waiting or inside certain primitive functions such as
1566 @code{sit-for} or @code{read-event} which @emph{can} wait. Therefore, a
1567 timer's execution may be delayed if Emacs is busy. However, the time of
1568 execution is very precise if Emacs is idle.
1570 Emacs binds @code{inhibit-quit} to @code{t} before calling the timer
1571 function, because quitting out of many timer functions can leave
1572 things in an inconsistent state. This is normally unproblematical
1573 because most timer functions don't do a lot of work. Indeed, for a
1574 timer to call a function that takes substantial time to run is likely
1575 to be annoying. If a timer function needs to allow quitting, it
1576 should use @code{with-local-quit} (@pxref{Quitting}). For example, if
1577 a timer function calls @code{accept-process-output} to receive output
1578 from an external process, that call should be wrapped inside
1579 @code{with-local-quit}, to ensure that @kbd{C-g} works if the external
1582 It is usually a bad idea for timer functions to alter buffer
1583 contents. When they do, they usually should call @code{undo-boundary}
1584 both before and after changing the buffer, to separate the timer's
1585 changes from user commands' changes and prevent a single undo entry
1586 from growing to be quite large.
1588 Timer functions should also avoid calling functions that cause Emacs
1589 to wait, such as @code{sit-for} (@pxref{Waiting}). This can lead to
1590 unpredictable effects, since other timers (or even the same timer) can
1591 run while waiting. If a timer function needs to perform an action
1592 after a certain time has elapsed, it can do this by scheduling a new
1595 If a timer function calls functions that can change the match data,
1596 it should save and restore the match data. @xref{Saving Match Data}.
1598 @deffn Command run-at-time time repeat function &rest args
1599 This sets up a timer that calls the function @var{function} with
1600 arguments @var{args} at time @var{time}. If @var{repeat} is a number
1601 (integer or floating point), the timer is scheduled to run again every
1602 @var{repeat} seconds after @var{time}. If @var{repeat} is @code{nil},
1603 the timer runs only once.
1605 @var{time} may specify an absolute or a relative time.
1607 Absolute times may be specified using a string with a limited variety
1608 of formats, and are taken to be times @emph{today}, even if already in
1609 the past. The recognized forms are @samp{@var{xxxx}},
1610 @samp{@var{x}:@var{xx}}, or @samp{@var{xx}:@var{xx}} (military time),
1611 and @samp{@var{xx}am}, @samp{@var{xx}AM}, @samp{@var{xx}pm},
1612 @samp{@var{xx}PM}, @samp{@var{xx}:@var{xx}am},
1613 @samp{@var{xx}:@var{xx}AM}, @samp{@var{xx}:@var{xx}pm}, or
1614 @samp{@var{xx}:@var{xx}PM}. A period can be used instead of a colon
1615 to separate the hour and minute parts.
1617 To specify a relative time as a string, use numbers followed by units.
1622 denotes 1 minute from now.
1624 denotes 65 seconds from now.
1625 @item 1 min 2 sec 3 hour 4 day 5 week 6 fortnight 7 month 8 year
1626 denotes exactly 103 months, 123 days, and 10862 seconds from now.
1629 For relative time values, Emacs considers a month to be exactly thirty
1630 days, and a year to be exactly 365.25 days.
1632 Not all convenient formats are strings. If @var{time} is a number
1633 (integer or floating point), that specifies a relative time measured in
1634 seconds. The result of @code{encode-time} can also be used to specify
1635 an absolute value for @var{time}.
1637 In most cases, @var{repeat} has no effect on when @emph{first} call
1638 takes place---@var{time} alone specifies that. There is one exception:
1639 if @var{time} is @code{t}, then the timer runs whenever the time is a
1640 multiple of @var{repeat} seconds after the epoch. This is useful for
1641 functions like @code{display-time}.
1643 The function @code{run-at-time} returns a timer value that identifies
1644 the particular scheduled future action. You can use this value to call
1645 @code{cancel-timer} (see below).
1648 A repeating timer nominally ought to run every @var{repeat} seconds,
1649 but remember that any invocation of a timer can be late. Lateness of
1650 one repetition has no effect on the scheduled time of the next
1651 repetition. For instance, if Emacs is busy computing for long enough
1652 to cover three scheduled repetitions of the timer, and then starts to
1653 wait, it will immediately call the timer function three times in
1654 immediate succession (presuming no other timers trigger before or
1655 between them). If you want a timer to run again no less than @var{n}
1656 seconds after the last invocation, don't use the @var{repeat} argument.
1657 Instead, the timer function should explicitly reschedule the timer.
1659 @defvar timer-max-repeats
1660 This variable's value specifies the maximum number of times to repeat
1661 calling a timer function in a row, when many previously scheduled
1662 calls were unavoidably delayed.
1665 @defmac with-timeout (seconds timeout-forms@dots{}) body@dots{}
1666 Execute @var{body}, but give up after @var{seconds} seconds. If
1667 @var{body} finishes before the time is up, @code{with-timeout} returns
1668 the value of the last form in @var{body}. If, however, the execution of
1669 @var{body} is cut short by the timeout, then @code{with-timeout}
1670 executes all the @var{timeout-forms} and returns the value of the last
1673 This macro works by setting a timer to run after @var{seconds} seconds. If
1674 @var{body} finishes before that time, it cancels the timer. If the
1675 timer actually runs, it terminates execution of @var{body}, then
1676 executes @var{timeout-forms}.
1678 Since timers can run within a Lisp program only when the program calls a
1679 primitive that can wait, @code{with-timeout} cannot stop executing
1680 @var{body} while it is in the midst of a computation---only when it
1681 calls one of those primitives. So use @code{with-timeout} only with a
1682 @var{body} that waits for input, not one that does a long computation.
1685 The function @code{y-or-n-p-with-timeout} provides a simple way to use
1686 a timer to avoid waiting too long for an answer. @xref{Yes-or-No
1689 @defun cancel-timer timer
1690 This cancels the requested action for @var{timer}, which should be a
1691 timer---usually, one previously returned by @code{run-at-time} or
1692 @code{run-with-idle-timer}. This cancels the effect of that call to
1693 one of these functions; the arrival of the specified time will not
1694 cause anything special to happen.
1698 @section Idle Timers
1700 Here is how to set up a timer that runs when Emacs is idle for a
1701 certain length of time. Aside from how to set them up, idle timers
1702 work just like ordinary timers.
1704 @deffn Command run-with-idle-timer secs repeat function &rest args
1705 Set up a timer which runs when Emacs has been idle for @var{secs}
1706 seconds. The value of @var{secs} may be an integer or a floating point
1707 number; a value of the type returned by @code{current-idle-time}
1710 If @var{repeat} is @code{nil}, the timer runs just once, the first time
1711 Emacs remains idle for a long enough time. More often @var{repeat} is
1712 non-@code{nil}, which means to run the timer @emph{each time} Emacs
1713 remains idle for @var{secs} seconds.
1715 The function @code{run-with-idle-timer} returns a timer value which you
1716 can use in calling @code{cancel-timer} (@pxref{Timers}).
1720 Emacs becomes ``idle'' when it starts waiting for user input, and it
1721 remains idle until the user provides some input. If a timer is set for
1722 five seconds of idleness, it runs approximately five seconds after Emacs
1723 first becomes idle. Even if @var{repeat} is non-@code{nil}, this timer
1724 will not run again as long as Emacs remains idle, because the duration
1725 of idleness will continue to increase and will not go down to five
1728 Emacs can do various things while idle: garbage collect, autosave or
1729 handle data from a subprocess. But these interludes during idleness do
1730 not interfere with idle timers, because they do not reset the clock of
1731 idleness to zero. An idle timer set for 600 seconds will run when ten
1732 minutes have elapsed since the last user command was finished, even if
1733 subprocess output has been accepted thousands of times within those ten
1734 minutes, and even if there have been garbage collections and autosaves.
1736 When the user supplies input, Emacs becomes non-idle while executing the
1737 input. Then it becomes idle again, and all the idle timers that are
1738 set up to repeat will subsequently run another time, one by one.
1741 @defun current-idle-time
1742 If Emacs is idle, this function returns the length of time Emacs has
1743 been idle, as a list of three integers: @code{(@var{high} @var{low}
1744 @var{microsec})}. The integers @var{high} and @var{low} combine to
1745 give the number of seconds of idleness, which is
1747 @var{high} * 2**16 + @var{low}.
1753 The third element, @var{microsec}, gives the microseconds since the
1754 start of the current second (or 0 for systems that return time with
1755 the resolution of only one second).
1757 When Emacs is not idle, @code{current-idle-time} returns @code{nil}.
1758 This is a convenient way to test whether Emacs is idle.
1760 The main use of this function is when an idle timer function wants to
1761 ``take a break'' for a while. It can set up another idle timer to
1762 call the same function again, after a few seconds more idleness.
1766 (defvar resume-timer nil
1767 "Timer that `timer-function' used to reschedule itself, or nil.")
1769 (defun timer-function ()
1770 ;; @r{If the user types a command while @code{resume-timer}}
1771 ;; @r{is active, the next time this function is called from}
1772 ;; @r{its main idle timer, deactivate @code{resume-timer}.}
1774 (cancel-timer resume-timer))
1775 ...@var{do the work for a while}...
1776 (when @var{taking-a-break}
1778 (run-with-idle-timer
1779 ;; Compute an idle time @var{break-length}
1780 ;; more than the current value.
1781 (time-add (current-idle-time)
1782 (seconds-to-time @var{break-length}))
1788 Some idle timer functions in user Lisp packages have a loop that
1789 does a certain amount of processing each time around, and exits when
1790 @code{(input-pending-p)} is non-@code{nil}. That approach seems very
1791 natural but has two problems:
1795 It blocks out all process output (since Emacs accepts process output
1796 only while waiting).
1799 It blocks out any idle timers that ought to run during that time.
1803 To avoid these problems, don't use that technique. Instead, write
1804 such idle timers to reschedule themselves after a brief pause, using
1805 the method in the @code{timer-function} example above.
1807 @node Terminal Input
1808 @section Terminal Input
1809 @cindex terminal input
1811 This section describes functions and variables for recording or
1812 manipulating terminal input. See @ref{Display}, for related
1816 * Input Modes:: Options for how input is processed.
1817 * Recording Input:: Saving histories of recent or all input events.
1821 @subsection Input Modes
1823 @cindex terminal input modes
1825 @defun set-input-mode interrupt flow meta &optional quit-char
1826 This function sets the mode for reading keyboard input. If
1827 @var{interrupt} is non-null, then Emacs uses input interrupts. If it is
1828 @code{nil}, then it uses @sc{cbreak} mode. The default setting is
1829 system-dependent. Some systems always use @sc{cbreak} mode regardless
1830 of what is specified.
1832 When Emacs communicates directly with X, it ignores this argument and
1833 uses interrupts if that is the way it knows how to communicate.
1835 If @var{flow} is non-@code{nil}, then Emacs uses @sc{xon/xoff}
1836 (@kbd{C-q}, @kbd{C-s}) flow control for output to the terminal. This
1837 has no effect except in @sc{cbreak} mode.
1840 The argument @var{meta} controls support for input character codes
1841 above 127. If @var{meta} is @code{t}, Emacs converts characters with
1842 the 8th bit set into Meta characters. If @var{meta} is @code{nil},
1843 Emacs disregards the 8th bit; this is necessary when the terminal uses
1844 it as a parity bit. If @var{meta} is neither @code{t} nor @code{nil},
1845 Emacs uses all 8 bits of input unchanged. This is good for terminals
1846 that use 8-bit character sets.
1849 If @var{quit-char} is non-@code{nil}, it specifies the character to
1850 use for quitting. Normally this character is @kbd{C-g}.
1854 The @code{current-input-mode} function returns the input mode settings
1855 Emacs is currently using.
1858 @defun current-input-mode
1859 This function returns the current mode for reading keyboard input. It
1860 returns a list, corresponding to the arguments of @code{set-input-mode},
1861 of the form @code{(@var{interrupt} @var{flow} @var{meta} @var{quit})} in
1865 is non-@code{nil} when Emacs is using interrupt-driven input. If
1866 @code{nil}, Emacs is using @sc{cbreak} mode.
1868 is non-@code{nil} if Emacs uses @sc{xon/xoff} (@kbd{C-q}, @kbd{C-s})
1869 flow control for output to the terminal. This value is meaningful only
1870 when @var{interrupt} is @code{nil}.
1872 is @code{t} if Emacs treats the eighth bit of input characters as
1873 the meta bit; @code{nil} means Emacs clears the eighth bit of every
1874 input character; any other value means Emacs uses all eight bits as the
1875 basic character code.
1877 is the character Emacs currently uses for quitting, usually @kbd{C-g}.
1881 @node Recording Input
1882 @subsection Recording Input
1883 @cindex recording input
1886 This function returns a vector containing the last 300 input events from
1887 the keyboard or mouse. All input events are included, whether or not
1888 they were used as parts of key sequences. Thus, you always get the last
1889 100 input events, not counting events generated by keyboard macros.
1890 (These are excluded because they are less interesting for debugging; it
1891 should be enough to see the events that invoked the macros.)
1893 A call to @code{clear-this-command-keys} (@pxref{Command Loop Info})
1894 causes this function to return an empty vector immediately afterward.
1897 @deffn Command open-dribble-file filename
1898 @cindex dribble file
1899 This function opens a @dfn{dribble file} named @var{filename}. When a
1900 dribble file is open, each input event from the keyboard or mouse (but
1901 not those from keyboard macros) is written in that file. A
1902 non-character event is expressed using its printed representation
1903 surrounded by @samp{<@dots{}>}.
1905 You close the dribble file by calling this function with an argument
1908 This function is normally used to record the input necessary to
1909 trigger an Emacs bug, for the sake of a bug report.
1913 (open-dribble-file "~/dribble")
1919 See also the @code{open-termscript} function (@pxref{Terminal Output}).
1921 @node Terminal Output
1922 @section Terminal Output
1923 @cindex terminal output
1925 The terminal output functions send output to a text terminal, or keep
1926 track of output sent to the terminal. The variable @code{baud-rate}
1927 tells you what Emacs thinks is the output speed of the terminal.
1930 This variable's value is the output speed of the terminal, as far as
1931 Emacs knows. Setting this variable does not change the speed of actual
1932 data transmission, but the value is used for calculations such as
1935 It also affects decisions about whether to scroll part of the
1936 screen or repaint on text terminals. @xref{Forcing Redisplay},
1937 for the corresponding functionality on graphical terminals.
1939 The value is measured in baud.
1942 If you are running across a network, and different parts of the
1943 network work at different baud rates, the value returned by Emacs may be
1944 different from the value used by your local terminal. Some network
1945 protocols communicate the local terminal speed to the remote machine, so
1946 that Emacs and other programs can get the proper value, but others do
1947 not. If Emacs has the wrong value, it makes decisions that are less
1948 than optimal. To fix the problem, set @code{baud-rate}.
1950 @defun send-string-to-terminal string &optional terminal
1951 This function sends @var{string} to @var{terminal} without alteration.
1952 Control characters in @var{string} have terminal-dependent effects.
1953 This function operates only on text terminals. @var{terminal} may be
1954 a terminal object, a frame, or @code{nil} for the selected frame's
1955 terminal. In batch mode, @var{string} is sent to @code{stdout} when
1956 @var{terminal} is @code{nil}.
1958 One use of this function is to define function keys on terminals that
1959 have downloadable function key definitions. For example, this is how (on
1960 certain terminals) to define function key 4 to move forward four
1961 characters (by transmitting the characters @kbd{C-u C-f} to the
1966 (send-string-to-terminal "\eF4\^U\^F")
1972 @deffn Command open-termscript filename
1973 @cindex termscript file
1974 This function is used to open a @dfn{termscript file} that will record
1975 all the characters sent by Emacs to the terminal. It returns
1976 @code{nil}. Termscript files are useful for investigating problems
1977 where Emacs garbles the screen, problems that are due to incorrect
1978 Termcap entries or to undesirable settings of terminal options more
1979 often than to actual Emacs bugs. Once you are certain which characters
1980 were actually output, you can determine reliably whether they correspond
1981 to the Termcap specifications in use.
1983 You close the termscript file by calling this function with an
1984 argument of @code{nil}.
1986 See also @code{open-dribble-file} in @ref{Recording Input}.
1990 (open-termscript "../junk/termscript")
1997 @section Sound Output
2000 To play sound using Emacs, use the function @code{play-sound}. Only
2001 certain systems are supported; if you call @code{play-sound} on a system
2002 which cannot really do the job, it gives an error. Emacs version 20 and
2003 earlier did not support sound at all.
2005 The sound must be stored as a file in RIFF-WAVE format (@samp{.wav})
2006 or Sun Audio format (@samp{.au}).
2008 @defun play-sound sound
2009 This function plays a specified sound. The argument, @var{sound}, has
2010 the form @code{(sound @var{properties}...)}, where the @var{properties}
2011 consist of alternating keywords (particular symbols recognized
2012 specially) and values corresponding to them.
2014 Here is a table of the keywords that are currently meaningful in
2015 @var{sound}, and their meanings:
2018 @item :file @var{file}
2019 This specifies the file containing the sound to play.
2020 If the file name is not absolute, it is expanded against
2021 the directory @code{data-directory}.
2023 @item :data @var{data}
2024 This specifies the sound to play without need to refer to a file. The
2025 value, @var{data}, should be a string containing the same bytes as a
2026 sound file. We recommend using a unibyte string.
2028 @item :volume @var{volume}
2029 This specifies how loud to play the sound. It should be a number in the
2030 range of 0 to 1. The default is to use whatever volume has been
2033 @item :device @var{device}
2034 This specifies the system device on which to play the sound, as a
2035 string. The default device is system-dependent.
2038 Before actually playing the sound, @code{play-sound}
2039 calls the functions in the list @code{play-sound-functions}.
2040 Each function is called with one argument, @var{sound}.
2043 @defun play-sound-file file &optional volume device
2044 This function is an alternative interface to playing a sound @var{file}
2045 specifying an optional @var{volume} and @var{device}.
2048 @defvar play-sound-functions
2049 A list of functions to be called before playing a sound. Each function
2050 is called with one argument, a property list that describes the sound.
2054 @section Operating on X11 Keysyms
2057 To define system-specific X11 keysyms, set the variable
2058 @code{system-key-alist}.
2060 @defvar system-key-alist
2061 This variable's value should be an alist with one element for each
2062 system-specific keysym. Each element has the form @code{(@var{code}
2063 . @var{symbol})}, where @var{code} is the numeric keysym code (not
2064 including the ``vendor specific'' bit,
2071 and @var{symbol} is the name for the function key.
2073 For example @code{(168 . mute-acute)} defines a system-specific key (used
2074 by HP X servers) whose numeric code is
2083 It is not crucial to exclude from the alist the keysyms of other X
2084 servers; those do no harm, as long as they don't conflict with the ones
2085 used by the X server actually in use.
2087 The variable is always local to the current terminal, and cannot be
2088 buffer-local. @xref{Multiple Terminals}.
2091 You can specify which keysyms Emacs should use for the Meta, Alt, Hyper, and Super modifiers by setting these variables:
2093 @defvar x-alt-keysym
2094 @defvarx x-meta-keysym
2095 @defvarx x-hyper-keysym
2096 @defvarx x-super-keysym
2097 The name of the keysym that should stand for the Alt modifier
2098 (respectively, for Meta, Hyper, and Super). For example, here is
2099 how to swap the Meta and Alt modifiers within Emacs:
2101 (setq x-alt-keysym 'meta)
2102 (setq x-meta-keysym 'alt)
2110 The command-line option @samp{-batch} causes Emacs to run
2111 noninteractively. In this mode, Emacs does not read commands from the
2112 terminal, it does not alter the terminal modes, and it does not expect
2113 to be outputting to an erasable screen. The idea is that you specify
2114 Lisp programs to run; when they are finished, Emacs should exit. The
2115 way to specify the programs to run is with @samp{-l @var{file}}, which
2116 loads the library named @var{file}, or @samp{-f @var{function}}, which
2117 calls @var{function} with no arguments, or @samp{--eval @var{form}}.
2119 Any Lisp program output that would normally go to the echo area,
2120 either using @code{message}, or using @code{prin1}, etc., with @code{t}
2121 as the stream, goes instead to Emacs's standard error descriptor when
2122 in batch mode. Similarly, input that would normally come from the
2123 minibuffer is read from the standard input descriptor.
2124 Thus, Emacs behaves much like a noninteractive
2125 application program. (The echo area output that Emacs itself normally
2126 generates, such as command echoing, is suppressed entirely.)
2128 @defvar noninteractive
2129 This variable is non-@code{nil} when Emacs is running in batch mode.
2132 @node Session Management
2133 @section Session Management
2134 @cindex session manager
2136 Emacs supports the X Session Management Protocol, which is used to
2137 suspend and restart applications. In the X Window System, a program
2138 called the @dfn{session manager} is responsible for keeping track of
2139 the applications that are running. When the X server shuts down, the
2140 session manager asks applications to save their state, and delays the
2141 actual shutdown until they respond. An application can also cancel
2144 When the session manager restarts a suspended session, it directs
2145 these applications to individually reload their saved state. It does
2146 this by specifying a special command-line argument that says what
2147 saved session to restore. For Emacs, this argument is @samp{--smid
2150 @defvar emacs-save-session-functions
2151 Emacs supports saving state via a hook called
2152 @code{emacs-save-session-functions}. Emacs runs this hook when the
2153 session manager tells it that the window system is shutting down. The
2154 functions are called with no arguments, and with the current buffer
2155 set to a temporary buffer. Each function can use @code{insert} to add
2156 Lisp code to this buffer. At the end, Emacs saves the buffer in a
2157 file, called the @dfn{session file}.
2159 @findex emacs-session-restore
2160 Subsequently, when the session manager restarts Emacs, it loads the
2161 session file automatically (@pxref{Loading}). This is performed by a
2162 function named @code{emacs-session-restore}, which is called during
2163 startup. @xref{Startup Summary}.
2165 If a function in @code{emacs-save-session-functions} returns
2166 non-@code{nil}, Emacs tells the session manager to cancel the
2170 Here is an example that just inserts some text into @samp{*scratch*} when
2171 Emacs is restarted by the session manager.
2175 (add-hook 'emacs-save-session-functions 'save-yourself-test)
2179 (defun save-yourself-test ()
2180 (insert "(save-excursion
2181 (switch-to-buffer \"*scratch*\")
2182 (insert \"I am restored\"))")
2188 arch-tag: 8378814a-30d7-467c-9615-74a80b9988a7