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