annotate doc/lispref/os.texi @ 97043:9592c50233ab remove-carbon

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