Mercurial > emacs
annotate lispref/os.texi @ 88821:690d527d1ad2
(access_keymap): Remove generic char code.
(push_key_description): Use CHARACTERP.
author | Dave Love <fx@gnu.org> |
---|---|
date | Wed, 03 Jul 2002 22:01:54 +0000 |
parents | 2f863ec2724c |
children | 340b4384f4ac |
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 |
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. |
35476 | 31 * Special Keysyms:: Defining system-specific key symbols for X. |
6558 | 32 * Flow Control:: How to turn output flow control on or off. |
33 * Batch Mode:: Running Emacs without terminal interaction. | |
34 @end menu | |
35 | |
36 @node Starting Up | |
37 @section Starting Up Emacs | |
38 | |
39 This section describes what Emacs does when it is started, and how you | |
40 can customize these actions. | |
41 | |
42 @menu | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
43 * Startup Summary:: Sequence of actions Emacs performs at startup. |
6558 | 44 * Init File:: Details on reading the init file (@file{.emacs}). |
45 * 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
|
46 * Command-Line Arguments:: How command-line arguments are processed, |
6558 | 47 and how you can customize them. |
48 @end menu | |
49 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
50 @node Startup Summary |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
51 @subsection Summary: Sequence of Actions at Startup |
6558 | 52 @cindex initialization |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
53 @cindex startup of Emacs |
6558 | 54 @cindex @file{startup.el} |
55 | |
56 The order of operations performed (in @file{startup.el}) by Emacs when | |
57 it is started up is as follows: | |
58 | |
59 @enumerate | |
60 @item | |
28603
cb9db16dba12
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27765
diff
changeset
|
61 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
|
62 @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
|
63 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
|
64 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
|
65 generated automatically by Emacs installation. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
66 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
67 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
68 It sets the language environment and the terminal coding system, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
69 if requested by environment variables such as @code{LANG}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
70 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
71 @item |
6558 | 72 It loads the initialization library for the window system, if you are |
73 using a window system. This library's name is | |
74 @file{term/@var{windowsystem}-win.el}. | |
75 | |
76 @item | |
12098 | 77 It processes the initial options. (Some of them are handled |
78 even earlier than this.) | |
79 | |
80 @item | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
81 It initializes the window frame and faces, if appropriate. |
6558 | 82 |
83 @item | |
84 It runs the normal hook @code{before-init-hook}. | |
85 | |
86 @item | |
87 It loads the library @file{site-start}, unless the option | |
88 @samp{-no-site-file} was specified. The library's file name is usually | |
89 @file{site-start.el}. | |
90 @cindex @file{site-start.el} | |
91 | |
92 @item | |
26242 | 93 It loads your init file (usually @file{~/.emacs}), unless @samp{-q}, |
94 @samp{-no-init-file}, or @samp{-batch} was specified on the command line. | |
95 The @samp{-u} option can specify another user whose home directory | |
96 should be used instead of @file{~}. | |
6558 | 97 |
98 @item | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
99 It loads the library @file{default}, unless @code{inhibit-default-init} |
6558 | 100 is non-@code{nil}. (This is not done in @samp{-batch} mode or if |
9009 | 101 @samp{-q} was specified on the command line.) The library's file name |
102 is usually @file{default.el}. | |
6558 | 103 @cindex @file{default.el} |
104 | |
105 @item | |
106 It runs the normal hook @code{after-init-hook}. | |
107 | |
108 @item | |
109 It sets the major mode according to @code{initial-major-mode}, provided | |
110 the buffer @samp{*scratch*} is still current and still in Fundamental | |
111 mode. | |
112 | |
113 @item | |
114 It loads the terminal-specific Lisp file, if any, except when in batch | |
115 mode or using a window system. | |
116 | |
117 @item | |
118 It displays the initial echo area message, unless you have suppressed | |
119 that with @code{inhibit-startup-echo-area-message}. | |
120 | |
121 @item | |
12098 | 122 It processes the action arguments from the command line. |
6558 | 123 |
124 @item | |
27353
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
125 It runs @code{emacs-startup-hook} and then @code{term-setup-hook}. |
6558 | 126 |
127 @item | |
128 It calls @code{frame-notice-user-settings}, which modifies the | |
129 parameters of the selected frame according to whatever the init files | |
130 specify. | |
131 | |
132 @item | |
133 It runs @code{window-setup-hook}. @xref{Window Systems}. | |
134 | |
135 @item | |
9009 | 136 It displays copyleft, nonwarranty, and basic use information, provided |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
137 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
|
138 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
|
139 buffer is still empty. |
6558 | 140 @end enumerate |
141 | |
142 @defopt inhibit-startup-message | |
143 This variable inhibits the initial startup messages (the nonwarranty, | |
144 etc.). If it is non-@code{nil}, then the messages are not printed. | |
145 | |
146 This variable exists so you can set it in your personal init file, once | |
147 you are familiar with the contents of the startup message. Do not set | |
148 this variable in the init file of a new user, or in a way that affects | |
149 more than one user, because that would prevent new users from receiving | |
150 the information they are supposed to see. | |
151 @end defopt | |
152 | |
153 @defopt inhibit-startup-echo-area-message | |
154 This variable controls the display of the startup echo area message. | |
155 You can suppress the startup echo area message by adding text with this | |
25875 | 156 form to your init file: |
6558 | 157 |
158 @example | |
159 (setq inhibit-startup-echo-area-message | |
160 "@var{your-login-name}") | |
161 @end example | |
162 | |
25875 | 163 Emacs explicitly checks for an expression as shown above in your init |
164 file; your login name must appear in the expression as a Lisp string | |
165 constant. Other methods of setting | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
166 @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
|
167 inhibit the startup message. |
6558 | 168 |
169 This way, you can easily inhibit the message for yourself if you wish, | |
25875 | 170 but thoughtless copying of your init file will not inhibit the message |
171 for someone else. | |
6558 | 172 @end defopt |
173 | |
174 @node Init File | |
25875 | 175 @subsection The Init File, @file{.emacs} |
6558 | 176 @cindex init file |
177 @cindex @file{.emacs} | |
178 | |
25875 | 179 When you start Emacs, it normally attempts to load your @dfn{init |
180 file}, a file in your home directory. Its normal name is @file{.emacs}, | |
181 but you can alternatively call it @file{.emacs.el}, which enables you to | |
182 byte-compile it (@pxref{Byte Compilation}); then the actual file loaded | |
183 will be @file{.emacs.elc}. | |
184 | |
185 The command-line switches @samp{-q} and @samp{-u} control whether and | |
186 where to find the init file; @samp{-q} says not to load an init file, | |
187 and @samp{-u @var{user}} says to load @var{user}'s init file instead of | |
188 yours. @xref{Entering Emacs,,, emacs, The GNU Emacs Manual}. If | |
189 neither option is specified, Emacs uses the @code{LOGNAME} environment | |
190 variable, or the @code{USER} (most systems) or @code{USERNAME} (MS | |
191 systems) variable, to find your home directory and thus your init file; | |
192 this way, even if you have su'd, Emacs still loads your own init file. | |
193 If those environment variables are absent, though, Emacs uses your | |
194 user-id to find your home directory. | |
6558 | 195 |
196 @cindex default init file | |
197 A site may have a @dfn{default init file}, which is the library named | |
198 @file{default.el}. Emacs finds the @file{default.el} file through the | |
199 standard search path for libraries (@pxref{How Programs Do Loading}). | |
200 The Emacs distribution does not come with this file; sites may provide | |
201 one for local customizations. If the default init file exists, it is | |
202 loaded whenever you start Emacs, except in batch mode or if @samp{-q} is | |
203 specified. But your own personal init file, if any, is loaded first; if | |
204 it sets @code{inhibit-default-init} to a non-@code{nil} value, then | |
205 Emacs does not subsequently load the @file{default.el} file. | |
206 | |
207 Another file for site-customization is @file{site-start.el}. Emacs | |
208 loads this @emph{before} the user's init file. You can inhibit the | |
209 loading of this file with the option @samp{-no-site-file}. | |
210 | |
12098 | 211 @defvar site-run-file |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
212 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
|
213 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
|
214 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
|
215 Emacs. |
12098 | 216 @end defvar |
217 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
218 @xref{Init File Examples,,, emacs, The GNU Emacs Manual}, for |
6558 | 219 examples of how to make various commonly desired customizations in your |
220 @file{.emacs} file. | |
221 | |
222 @defopt inhibit-default-init | |
223 This variable prevents Emacs from loading the default initialization | |
224 library file for your session of Emacs. If its value is non-@code{nil}, | |
225 then the default library is not loaded. The default value is | |
226 @code{nil}. | |
227 @end defopt | |
228 | |
229 @defvar before-init-hook | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
230 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
|
231 (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
|
232 (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
|
233 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
234 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
235 @defvar after-init-hook |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
236 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
|
237 (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
|
238 before loading the terminal-specific library and processing the |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
239 command-line arguments. |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
240 @end defvar |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
241 |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
242 @defvar emacs-startup-hook |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
243 @tindex emacs-startup-hook |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
244 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
|
245 arguments, just before @code{term-setup-hook}. |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
246 @end defvar |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
247 |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
248 @defvar user-init-file |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
249 @tindex user-init-file |
611b3854d888
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
250 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
|
251 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
|
252 the value refers to the corresponding source file. |
6558 | 253 @end defvar |
254 | |
255 @node Terminal-Specific | |
256 @subsection Terminal-Specific Initialization | |
257 @cindex terminal-specific initialization | |
258 | |
259 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
|
260 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
|
261 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
|
262 terminal type (specified by the environment variable @code{TERM}). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
263 Normally, @code{term-file-prefix} has the value |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
264 @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
|
265 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
|
266 trying the @samp{.elc} and @samp{.el} suffixes. |
6558 | 267 |
268 The usual function of a terminal-specific library is to enable special | |
269 keys to send sequences that Emacs can recognize. It may also need to | |
270 set or add to @code{function-key-map} if the Termcap entry does not | |
271 specify all the terminal's function keys. @xref{Terminal Input}. | |
272 | |
273 @cindex Termcap | |
274 When the name of the terminal type contains a hyphen, only the part of | |
275 the name before the first hyphen is significant in choosing the library | |
276 name. Thus, terminal types @samp{aaa-48} and @samp{aaa-30-rv} both use | |
277 the @file{term/aaa} library. If necessary, the library can evaluate | |
278 @code{(getenv "TERM")} to find the full name of the terminal | |
279 type.@refill | |
280 | |
25875 | 281 Your init file can prevent the loading of the |
6558 | 282 terminal-specific library by setting the variable |
283 @code{term-file-prefix} to @code{nil}. This feature is useful when | |
284 experimenting with your own peculiar customizations. | |
285 | |
286 You can also arrange to override some of the actions of the | |
287 terminal-specific library by setting the variable | |
288 @code{term-setup-hook}. This is a normal hook which Emacs runs using | |
289 @code{run-hooks} at the end of Emacs initialization, after loading both | |
25875 | 290 your init file and any terminal-specific libraries. You can |
6558 | 291 use this variable to define initializations for terminals that do not |
292 have their own libraries. @xref{Hooks}. | |
293 | |
294 @defvar term-file-prefix | |
295 @cindex @code{TERM} environment variable | |
296 If the @code{term-file-prefix} variable is non-@code{nil}, Emacs loads | |
297 a terminal-specific initialization file as follows: | |
298 | |
299 @example | |
300 (load (concat term-file-prefix (getenv "TERM"))) | |
301 @end example | |
302 | |
303 @noindent | |
304 You may set the @code{term-file-prefix} variable to @code{nil} in your | |
25875 | 305 init file if you do not wish to load the |
6558 | 306 terminal-initialization file. To do this, put the following in |
25875 | 307 your init file: @code{(setq term-file-prefix nil)}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
308 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
309 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
|
310 uses @samp{internal} as the terminal type. |
6558 | 311 @end defvar |
312 | |
313 @defvar term-setup-hook | |
9009 | 314 This variable is a normal hook that Emacs runs after loading your |
25875 | 315 init file, the default initialization file (if any) and the |
6558 | 316 terminal-specific Lisp file. |
317 | |
318 You can use @code{term-setup-hook} to override the definitions made by a | |
319 terminal-specific file. | |
320 @end defvar | |
321 | |
322 See @code{window-setup-hook} in @ref{Window Systems}, for a related | |
323 feature. | |
324 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
325 @node Command-Line Arguments |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
326 @subsection Command-Line Arguments |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
327 @cindex command-line arguments |
6558 | 328 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
329 You can use command-line arguments to request various actions when you |
6558 | 330 start Emacs. Since you do not need to start Emacs more than once per |
331 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
|
332 command-line arguments are hardly ever used. As a practical matter, it |
6558 | 333 is best to avoid making the habit of using them, since this habit would |
334 encourage you to kill and restart Emacs unnecessarily often. These | |
335 options exist for two reasons: to be compatible with other editors (for | |
336 invocation by other programs) and to enable shell scripts to run | |
337 specific Lisp programs. | |
338 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
339 This section describes how Emacs processes command-line arguments, |
6558 | 340 and how you can customize them. |
341 | |
342 @ignore | |
343 (Note that some other editors require you to start afresh each time | |
344 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
|
345 specify the file as a command-line argument. The recommended way to |
6558 | 346 use GNU Emacs is to start it only once, just after you log in, and do |
347 all your editing in the same Emacs process. Each time you want to edit | |
348 a different file, you visit it with the existing Emacs, which eventually | |
349 comes to have many files in it ready for editing. Usually you do not | |
350 kill the Emacs until you are about to log out.) | |
351 @end ignore | |
352 | |
353 @defun command-line | |
9009 | 354 This function parses the command line that Emacs was called with, |
25875 | 355 processes it, loads the user's init file and displays the |
9009 | 356 startup messages. |
6558 | 357 @end defun |
358 | |
359 @defvar command-line-processed | |
360 The value of this variable is @code{t} once the command line has been | |
361 processed. | |
362 | |
363 If you redump Emacs by calling @code{dump-emacs}, you may wish to set | |
364 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
|
365 to process its new command-line arguments. |
6558 | 366 @end defvar |
367 | |
368 @defvar command-switch-alist | |
369 @cindex switches on command line | |
370 @cindex options on command line | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
371 @cindex command-line options |
6558 | 372 The value of this variable is an alist of user-defined command-line |
373 options and associated handler functions. This variable exists so you | |
374 can add elements to it. | |
375 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
376 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
|
377 has the form: |
6558 | 378 |
379 @example | |
380 -@var{option} | |
381 @end example | |
382 | |
383 The elements of the @code{command-switch-alist} look like this: | |
384 | |
385 @example | |
386 (@var{option} . @var{handler-function}) | |
387 @end example | |
388 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
389 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
|
390 option (not including the initial hyphen). The @var{handler-function} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
391 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
|
392 sole argument. |
6558 | 393 |
394 In some cases, the option is followed in the command line by an | |
395 argument. In these cases, the @var{handler-function} can find all the | |
396 remaining command-line arguments in the variable | |
397 @code{command-line-args-left}. (The entire list of command-line | |
398 arguments is in @code{command-line-args}.) | |
399 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
400 The command-line arguments are parsed by the @code{command-line-1} |
6558 | 401 function in the @file{startup.el} file. See also @ref{Command |
402 Switches, , Command Line Switches and Arguments, emacs, The GNU Emacs | |
403 Manual}. | |
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 | |
487 this hook. | |
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 | |
12098 | 615 @item dgux |
616 Data General DGUX operating system. | |
617 | |
618 @item gnu | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
619 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
|
620 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
621 @item gnu/linux |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
622 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
|
623 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
|
624 actually Linux is just the kernel, not the whole system.) |
12098 | 625 |
6558 | 626 @item hpux |
12098 | 627 Hewlett-Packard HPUX operating system. |
6558 | 628 |
629 @item irix | |
630 Silicon Graphics Irix system. | |
631 | |
12098 | 632 @item ms-dos |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
633 Microsoft MS-DOS ``operating system.'' Emacs compiled with DJGPP for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
634 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
|
635 MS-Windows. |
12098 | 636 |
637 @item next-mach | |
638 NeXT Mach-based system. | |
7277
6a2af30d33fe
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
639 |
6558 | 640 @item rtu |
641 Masscomp RTU, UCB universe. | |
642 | |
643 @item unisoft-unix | |
644 UniSoft UniPlus. | |
645 | |
646 @item usg-unix-v | |
647 AT&T System V. | |
648 | |
649 @item vax-vms | |
650 VAX VMS. | |
651 | |
12098 | 652 @item windows-nt |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
653 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
|
654 value of @code{system-type} is @code{windows-nt} in either case. |
12098 | 655 |
6558 | 656 @item xenix |
657 SCO Xenix 386. | |
658 @end table | |
659 | |
660 We do not wish to add new symbols to make finer distinctions unless it | |
661 is absolutely necessary! In fact, we hope to eliminate some of these | |
662 alternatives in the future. We recommend using | |
663 @code{system-configuration} to distinguish between different operating | |
664 systems. | |
665 @end defvar | |
666 | |
667 @defun system-name | |
668 This function returns the name of the machine you are running on. | |
669 @example | |
670 (system-name) | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
671 @result{} "www.gnu.org" |
6558 | 672 @end example |
673 @end defun | |
674 | |
12067 | 675 The symbol @code{system-name} is a variable as well as a function. In |
676 fact, the function returns whatever value the variable | |
677 @code{system-name} currently holds. Thus, you can set the variable | |
678 @code{system-name} in case Emacs is confused about the name of your | |
679 system. The variable is also useful for constructing frame titles | |
680 (@pxref{Frame Titles}). | |
681 | |
682 @defvar mail-host-address | |
683 If this variable is non-@code{nil}, it is used instead of | |
684 @code{system-name} for purposes of generating email addresses. For | |
685 example, it is used when constructing the default value of | |
686 @code{user-mail-address}. @xref{User Identification}. (Since this is | |
687 done when Emacs starts up, the value actually used is the one saved when | |
688 Emacs was dumped. @xref{Building Emacs}.) | |
689 @end defvar | |
690 | |
32839 | 691 @deffn Command getenv var |
6558 | 692 @cindex environment variable access |
693 This function returns the value of the environment variable @var{var}, | |
694 as a string. Within Emacs, the environment variable values are kept in | |
695 the Lisp variable @code{process-environment}. | |
696 | |
697 @example | |
698 @group | |
699 (getenv "USER") | |
700 @result{} "lewis" | |
701 @end group | |
702 | |
703 @group | |
704 lewis@@slug[10] % printenv | |
705 PATH=.:/user/lewis/bin:/usr/bin:/usr/local/bin | |
706 USER=lewis | |
707 @end group | |
708 @group | |
709 TERM=ibmapa16 | |
710 SHELL=/bin/csh | |
711 HOME=/user/lewis | |
712 @end group | |
713 @end example | |
32924 | 714 @end deffn |
6558 | 715 |
716 @c Emacs 19 feature | |
717 @deffn Command setenv variable value | |
718 This command sets the value of the environment variable named | |
719 @var{variable} to @var{value}. Both arguments should be strings. This | |
720 function works by modifying @code{process-environment}; binding that | |
721 variable with @code{let} is also reasonable practice. | |
722 @end deffn | |
723 | |
724 @defvar process-environment | |
725 This variable is a list of strings, each describing one environment | |
726 variable. The functions @code{getenv} and @code{setenv} work by means | |
727 of this variable. | |
728 | |
729 @smallexample | |
730 @group | |
731 process-environment | |
732 @result{} ("l=/usr/stanford/lib/gnuemacs/lisp" | |
733 "PATH=.:/user/lewis/bin:/usr/class:/nfsusr/local/bin" | |
734 "USER=lewis" | |
735 @end group | |
736 @group | |
737 "TERM=ibmapa16" | |
738 "SHELL=/bin/csh" | |
739 "HOME=/user/lewis") | |
740 @end group | |
741 @end smallexample | |
40311
a3a9223b152f
Clarify what happens with duplicates in process-environment.
Richard M. Stallman <rms@gnu.org>
parents:
39221
diff
changeset
|
742 |
a3a9223b152f
Clarify what happens with duplicates in process-environment.
Richard M. Stallman <rms@gnu.org>
parents:
39221
diff
changeset
|
743 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
|
744 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
|
745 specifies the variable, and the other ``duplicates'' are ignored. |
6558 | 746 @end defvar |
747 | |
12098 | 748 @defvar path-separator |
749 This variable holds a string which says which character separates | |
750 directories in a search path (as found in an environment variable). Its | |
751 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
|
752 and MS-Windows. |
12098 | 753 @end defvar |
754 | |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
755 @defun parse-colon-path path |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
756 @tindex parse-colon-path |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
757 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
|
758 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
|
759 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
|
760 ``use the current directory.'' Although the function's name says |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
761 ``colon,'' it actually uses the value of @code{path-separator}. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
762 |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
763 @example |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
764 (parse-colon-path ":/foo:/bar") |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
765 @result{} (nil "/foo/" "/bar/") |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
766 @end example |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
767 @end defun |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28603
diff
changeset
|
768 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
769 @defvar invocation-name |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
770 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
|
771 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
|
772 @end defvar |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
773 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
774 @defvar invocation-directory |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
775 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
|
776 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
|
777 @end defvar |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
778 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
779 @defvar installation-directory |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
780 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
|
781 @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
|
782 when Emacs can't find those directories in their standard installed |
9009 | 783 locations, but can find them in a directory related somehow to the one |
784 containing the Emacs executable. | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
785 @end defvar |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
786 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
787 @defun load-average &optional use-float |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
788 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
|
789 averages, in a list. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
790 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
791 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
|
792 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
|
793 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
|
794 as floating point numbers and without multiplying by 100. |
6558 | 795 |
796 @example | |
797 @group | |
798 (load-average) | |
799 @result{} (169 48 36) | |
800 @end group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
801 @group |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
802 (load-average t) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
803 @result{} (1.69 0.48 0.36) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
804 @end group |
6558 | 805 |
806 @group | |
807 lewis@@rocky[5] % uptime | |
808 11:55am up 1 day, 19:37, 3 users, | |
809 load average: 1.69, 0.48, 0.36 | |
810 @end group | |
811 @end example | |
812 @end defun | |
813 | |
814 @defun emacs-pid | |
815 This function returns the process @sc{id} of the Emacs process. | |
816 @end defun | |
817 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
818 @defvar tty-erase-char |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
819 This variable holds the erase character that was selected |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
820 in the system's terminal driver, before Emacs was started. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
821 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
822 |
6558 | 823 @defun setprv privilege-name &optional setp getprv |
824 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
|
825 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
|
826 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
|
827 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
|
828 @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
|
829 otherwise. |
6558 | 830 |
831 If the third argument, @var{getprv}, is non-@code{nil}, @code{setprv} | |
832 does not change the privilege, but returns @code{t} or @code{nil} | |
833 indicating whether the privilege is currently enabled. | |
834 @end defun | |
835 | |
836 @node User Identification | |
837 @section User Identification | |
838 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
839 @defvar init-file-user |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
840 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
|
841 @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
|
842 @samp{-q} or @samp{-u @var{user}}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
843 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
844 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
|
845 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
|
846 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
|
847 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
|
848 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
|
849 files or user profile. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
850 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
851 |
12067 | 852 @defvar user-mail-address |
853 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
|
854 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
|
855 init files, but not if you have already set it. So you can set the |
25875 | 856 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
|
857 want to use the default value. |
12067 | 858 @end defvar |
859 | |
860 @defun user-login-name &optional uid | |
861 If you don't specify @var{uid}, this function returns the name under | |
862 which the user is logged in. If the environment variable @code{LOGNAME} | |
863 is set, that value is used. Otherwise, if the environment variable | |
864 @code{USER} is set, that value is used. Otherwise, the value is based | |
865 on the effective @sc{uid}, not the real @sc{uid}. | |
866 | |
867 If you specify @var{uid}, the value is the user name that corresponds | |
868 to @var{uid} (which should be an integer). | |
6558 | 869 |
870 @example | |
871 @group | |
872 (user-login-name) | |
873 @result{} "lewis" | |
874 @end group | |
875 @end example | |
876 @end defun | |
877 | |
878 @defun user-real-login-name | |
879 This function returns the user name corresponding to Emacs's real | |
880 @sc{uid}. This ignores the effective @sc{uid} and ignores the | |
881 environment variables @code{LOGNAME} and @code{USER}. | |
882 @end defun | |
883 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
884 @defun user-full-name &optional uid |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
885 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
|
886 of the environment variable @code{NAME}, if that is set. |
6558 | 887 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
888 @c "Bil" is the correct spelling. |
6558 | 889 @example |
890 @group | |
891 (user-full-name) | |
892 @result{} "Bil Lewis" | |
893 @end group | |
894 @end example | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
895 |
24848 | 896 If the Emacs job's user-id does not correspond to any known user (and |
897 provided @code{NAME} is not set), the value is @code{"unknown"}. | |
898 | |
899 If @var{uid} is non-@code{nil}, then it should be an integer (a user-id) | |
900 or a string (a login name). Then @code{user-full-name} returns the full | |
901 name corresponding to that user-id or login name. If you specify a | |
902 user-id or login name that isn't defined, it returns @code{nil}. | |
6558 | 903 @end defun |
904 | |
12067 | 905 @vindex user-full-name |
906 @vindex user-real-login-name | |
907 @vindex user-login-name | |
908 The symbols @code{user-login-name}, @code{user-real-login-name} and | |
909 @code{user-full-name} are variables as well as functions. The functions | |
910 return the same values that the variables hold. These variables allow | |
911 you to ``fake out'' Emacs by telling the functions what to return. The | |
912 variables are also useful for constructing frame titles (@pxref{Frame | |
913 Titles}). | |
914 | |
6558 | 915 @defun user-real-uid |
916 This function returns the real @sc{uid} of the user. | |
917 | |
918 @example | |
919 @group | |
920 (user-real-uid) | |
921 @result{} 19 | |
922 @end group | |
923 @end example | |
924 @end defun | |
925 | |
926 @defun user-uid | |
927 This function returns the effective @sc{uid} of the user. | |
928 @end defun | |
929 | |
930 @node Time of Day | |
931 @section Time of Day | |
932 | |
933 This section explains how to determine the current time and the time | |
934 zone. | |
935 | |
936 @defun current-time-string &optional time-value | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
937 This function returns the current time and date as a human-readable |
6558 | 938 string. The format of the string is unvarying; the number of characters |
939 used for each part is always the same, so you can reliably use | |
12098 | 940 @code{substring} to extract pieces of it. It is wise to count the |
941 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
|
942 additional information may some day be added at the end. |
6558 | 943 |
944 @c Emacs 19 feature | |
945 The argument @var{time-value}, if given, specifies a time to format | |
12098 | 946 instead of the current time. The argument should be a list whose first |
947 two elements are integers. Thus, you can use times obtained from | |
948 @code{current-time} (see below) and from @code{file-attributes} | |
949 (@pxref{File Attributes}). | |
6558 | 950 |
951 @example | |
952 @group | |
953 (current-time-string) | |
954 @result{} "Wed Oct 14 22:21:05 1987" | |
955 @end group | |
956 @end example | |
957 @end defun | |
958 | |
959 @c Emacs 19 feature | |
960 @defun current-time | |
961 This function returns the system's time value as a list of three | |
962 integers: @code{(@var{high} @var{low} @var{microsec})}. The integers | |
963 @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
|
964 0:00 January 1, 1970 (local time), which is |
27193 | 965 @ifnottex |
6558 | 966 @var{high} * 2**16 + @var{low}. |
27193 | 967 @end ifnottex |
6558 | 968 @tex |
9009 | 969 $high*2^{16}+low$. |
6558 | 970 @end tex |
971 | |
972 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
|
973 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
|
974 the resolution of only one second). |
6558 | 975 |
976 The first two elements can be compared with file time values such as you | |
977 get with the function @code{file-attributes}. @xref{File Attributes}. | |
978 @end defun | |
979 | |
980 @c Emacs 19 feature | |
981 @defun current-time-zone &optional time-value | |
982 This function returns a list describing the time zone that the user is | |
983 in. | |
984 | |
985 The value has the form @code{(@var{offset} @var{name})}. Here | |
986 @var{offset} is an integer giving the number of seconds ahead of UTC | |
987 (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
|
988 second element, @var{name}, is a string giving the name of the time |
6558 | 989 zone. Both elements change when daylight savings time begins or ends; |
990 if the user has specified a time zone that does not use a seasonal time | |
991 adjustment, then the value is constant through time. | |
992 | |
993 If the operating system doesn't supply all the information necessary to | |
994 compute the value, both elements of the list are @code{nil}. | |
995 | |
996 The argument @var{time-value}, if given, specifies a time to analyze | |
997 instead of the current time. The argument should be a cons cell | |
998 containing two integers, or a list whose first two elements are | |
999 integers. Thus, you can use times obtained from @code{current-time} | |
12067 | 1000 (see above) and from @code{file-attributes} (@pxref{File Attributes}). |
1001 @end defun | |
1002 | |
39202
557aaff6fb23
(Time of Day): Document float-time.
Eli Zaretskii <eliz@gnu.org>
parents:
36873
diff
changeset
|
1003 @defun float-time &optional time-value |
557aaff6fb23
(Time of Day): Document float-time.
Eli Zaretskii <eliz@gnu.org>
parents:
36873
diff
changeset
|
1004 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
|
1005 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
|
1006 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
|
1007 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
|
1008 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
|
1009 @code{file-attributes}. |
557aaff6fb23
(Time of Day): Document float-time.
Eli Zaretskii <eliz@gnu.org>
parents:
36873
diff
changeset
|
1010 |
557aaff6fb23
(Time of Day): Document float-time.
Eli Zaretskii <eliz@gnu.org>
parents:
36873
diff
changeset
|
1011 @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
|
1012 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
|
1013 @end defun |
557aaff6fb23
(Time of Day): Document float-time.
Eli Zaretskii <eliz@gnu.org>
parents:
36873
diff
changeset
|
1014 |
12067 | 1015 @node Time Conversion |
1016 @section Time Conversion | |
1017 | |
1018 These functions convert time values (lists of two or three integers) | |
1019 to strings or to calendrical information. There is also a function to | |
1020 convert calendrical information to a time value. You can get time | |
1021 values from the functions @code{current-time} (@pxref{Time of Day}) and | |
1022 @code{file-attributes} (@pxref{File Attributes}). | |
1023 | |
15778
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
1024 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
|
1025 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
|
1026 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
|
1027 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
|
1028 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
|
1029 |
c96cee4f8be8
Explain range of time values, and what negative year numbers mean.
Richard M. Stallman <rms@gnu.org>
parents:
15762
diff
changeset
|
1030 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
|
1031 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
|
1032 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
|
1033 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
|
1034 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
|
1035 |
43037
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1036 @defun date-to-time string |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1037 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
|
1038 corresponding time value. |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1039 @end defun |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1040 |
26242 | 1041 @defun format-time-string format-string &optional time universal |
1042 This function converts @var{time} (or the current time, if @var{time} is | |
1043 omitted) to a string according to @var{format-string}. The argument | |
1044 @var{format-string} may contain @samp{%}-sequences which say to | |
1045 substitute parts of the time. Here is a table of what the | |
1046 @samp{%}-sequences mean: | |
12067 | 1047 |
1048 @table @samp | |
1049 @item %a | |
1050 This stands for the abbreviated name of the day of week. | |
1051 @item %A | |
1052 This stands for the full name of the day of week. | |
1053 @item %b | |
1054 This stands for the abbreviated name of the month. | |
1055 @item %B | |
1056 This stands for the full name of the month. | |
1057 @item %c | |
1058 This is a synonym for @samp{%x %X}. | |
1059 @item %C | |
12098 | 1060 This has a locale-specific meaning. In the default locale (named C), it |
1061 is equivalent to @samp{%A, %B %e, %Y}. | |
12067 | 1062 @item %d |
1063 This stands for the day of month, zero-padded. | |
1064 @item %D | |
1065 This is a synonym for @samp{%m/%d/%y}. | |
1066 @item %e | |
1067 This stands for the day of month, blank-padded. | |
1068 @item %h | |
1069 This is a synonym for @samp{%b}. | |
1070 @item %H | |
1071 This stands for the hour (00-23). | |
1072 @item %I | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1073 This stands for the hour (01-12). |
12067 | 1074 @item %j |
1075 This stands for the day of the year (001-366). | |
1076 @item %k | |
1077 This stands for the hour (0-23), blank padded. | |
1078 @item %l | |
1079 This stands for the hour (1-12), blank padded. | |
1080 @item %m | |
1081 This stands for the month (01-12). | |
1082 @item %M | |
1083 This stands for the minute (00-59). | |
1084 @item %n | |
1085 This stands for a newline. | |
1086 @item %p | |
1087 This stands for @samp{AM} or @samp{PM}, as appropriate. | |
1088 @item %r | |
1089 This is a synonym for @samp{%I:%M:%S %p}. | |
1090 @item %R | |
1091 This is a synonym for @samp{%H:%M}. | |
1092 @item %S | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1093 This stands for the seconds (00-59). |
12067 | 1094 @item %t |
1095 This stands for a tab character. | |
1096 @item %T | |
1097 This is a synonym for @samp{%H:%M:%S}. | |
1098 @item %U | |
1099 This stands for the week of the year (01-52), assuming that weeks | |
1100 start on Sunday. | |
1101 @item %w | |
1102 This stands for the numeric day of week (0-6). Sunday is day 0. | |
1103 @item %W | |
1104 This stands for the week of the year (01-52), assuming that weeks | |
1105 start on Monday. | |
1106 @item %x | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1107 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
|
1108 @samp{C}), it is equivalent to @samp{%D}. |
12067 | 1109 @item %X |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1110 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
|
1111 @samp{C}), it is equivalent to @samp{%T}. |
12067 | 1112 @item %y |
1113 This stands for the year without century (00-99). | |
1114 @item %Y | |
1115 This stands for the year with century. | |
1116 @item %Z | |
1117 This stands for the time zone abbreviation. | |
1118 @end table | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1119 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1120 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
|
1121 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
|
1122 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
|
1123 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
|
1124 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
|
1125 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1126 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
|
1127 @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
|
1128 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
|
1129 because that is how @samp{%S} normally pads to two positions. |
26242 | 1130 |
1131 The characters @samp{E} and @samp{O} act as modifiers when used between | |
1132 @samp{%} and one of the letters in the table above. @samp{E} specifies | |
26288 | 1133 using the current locale's ``alternative'' version of the date and time. |
1134 In a Japanese locale, for example, @code{%Ex} might yield a date format | |
1135 based on the Japanese Emperors' reigns. @samp{E} is allowed in | |
1136 @samp{%Ec}, @samp{%EC}, @samp{%Ex}, @samp{%EX}, @samp{%Ey}, and | |
1137 @samp{%EY}. | |
26242 | 1138 |
26288 | 1139 @samp{O} means to use the current locale's ``alternative'' |
1140 representation of numbers, instead of the ordinary decimal digits. This | |
1141 is allowed with most letters, all the ones that output numbers. | |
26242 | 1142 |
1143 If @var{universal} is non-@code{nil}, that means to describe the time as | |
1144 Universal Time; @code{nil} means describe it using what Emacs believes | |
1145 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
|
1146 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1147 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
|
1148 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
|
1149 its argument using the coding system specified by |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1150 @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
|
1151 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
|
1152 string using that same coding system. |
12067 | 1153 @end defun |
1154 | |
43037
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1155 @defun seconds-to-time seconds |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1156 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
|
1157 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
|
1158 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
|
1159 @end defun |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1160 |
12067 | 1161 @defun decode-time time |
12098 | 1162 This function converts a time value into calendrical information. The |
1163 return value is a list of nine elements, as follows: | |
12067 | 1164 |
1165 @example | |
1166 (@var{seconds} @var{minutes} @var{hour} @var{day} @var{month} @var{year} @var{dow} @var{dst} @var{zone}) | |
1167 @end example | |
1168 | |
1169 Here is what the elements mean: | |
1170 | |
1171 @table @var | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1172 @item seconds |
12067 | 1173 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
|
1174 @item minutes |
12067 | 1175 The number of minutes past the hour, as an integer between 0 and 59. |
1176 @item hour | |
1177 The hour of the day, as an integer between 0 and 23. | |
1178 @item day | |
1179 The day of the month, as an integer between 1 and 31. | |
1180 @item month | |
1181 The month of the year, as an integer between 1 and 12. | |
1182 @item year | |
1183 The year, an integer typically greater than 1900. | |
1184 @item dow | |
1185 The day of week, as an integer between 0 and 6, where 0 stands for | |
1186 Sunday. | |
1187 @item dst | |
1188 @code{t} if daylight savings time is effect, otherwise @code{nil}. | |
1189 @item zone | |
12098 | 1190 An integer indicating the time zone, as the number of seconds east of |
1191 Greenwich. | |
12067 | 1192 @end table |
1193 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1194 @strong{Common Lisp Note:} Common Lisp has different meanings for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1195 @var{dow} and @var{zone}. |
12067 | 1196 @end defun |
1197 | |
27765
277138d0f9f1
Remove @dots from encode-time header.
Dave Love <fx@gnu.org>
parents:
27370
diff
changeset
|
1198 @defun encode-time seconds minutes hour day month year &optional zone |
12067 | 1199 This function is the inverse of @code{decode-time}. It converts seven |
12098 | 1200 items of calendrical data into a time value. For the meanings of the |
1201 arguments, see the table above under @code{decode-time}. | |
12067 | 1202 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1203 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
|
1204 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
|
1205 yourself before you call @code{encode-time}. |
12067 | 1206 |
1207 The optional argument @var{zone} defaults to the current time zone and | |
1208 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
|
1209 (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
|
1210 @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
|
1211 @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
|
1212 alteration for daylight savings time. |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1213 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1214 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
|
1215 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
|
1216 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
|
1217 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
|
1218 @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
|
1219 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1220 @example |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1221 (apply 'encode-time (decode-time @dots{})) |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1222 @end example |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1223 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1224 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
|
1225 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
|
1226 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
|
1227 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1228 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
|
1229 if you try to encode a time that is out of range, an error results. |
6558 | 1230 @end defun |
1231 | |
43037
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1232 @node Time Calculations |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1233 @section Time Calculations |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1234 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1235 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
|
1236 (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
|
1237 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1238 @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
|
1239 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
|
1240 @var{t2}. |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1241 @end defun |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1242 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1243 @defun time-subtract t1 t2 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1244 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
|
1245 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
|
1246 @end defun |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1247 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1248 @defun time-add t1 t2 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1249 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
|
1250 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
|
1251 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
|
1252 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1253 @example |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1254 (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
|
1255 @end example |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1256 @end defun |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1257 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1258 @defun time-to-days time |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1259 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
|
1260 1 and @var{time}. |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1261 @end defun |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1262 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1263 @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
|
1264 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
|
1265 @end defun |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1266 |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1267 @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
|
1268 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
|
1269 @end defun |
2f863ec2724c
Document date-to-time and seconds-to-time.
Richard M. Stallman <rms@gnu.org>
parents:
40311
diff
changeset
|
1270 |
6558 | 1271 @node Timers |
12098 | 1272 @section Timers for Delayed Execution |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1273 @cindex timer |
6558 | 1274 |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1275 You can set up a @dfn{timer} to call a function at a specified future time or |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1276 after a certain length of idleness. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1277 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1278 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
|
1279 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
|
1280 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
|
1281 @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
|
1282 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
|
1283 execution is very precise if Emacs is idle. |
6558 | 1284 |
1285 @defun run-at-time time repeat function &rest args | |
1286 This function arranges to call @var{function} with arguments @var{args} | |
1287 at time @var{time}. The argument @var{function} is a function to call | |
1288 later, and @var{args} are the arguments to give it when it is called. | |
1289 The time @var{time} is specified as a string. | |
1290 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1291 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
|
1292 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
|
1293 formats include these two, |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1294 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1295 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1296 @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
|
1297 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1298 @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
|
1299 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1300 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1301 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1302 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
|
1303 @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
|
1304 as well. |
6558 | 1305 |
1306 To specify a relative time, use numbers followed by units. | |
1307 For example: | |
1308 | |
1309 @table @samp | |
1310 @item 1 min | |
1311 denotes 1 minute from now. | |
1312 @item 1 min 5 sec | |
1313 denotes 65 seconds from now. | |
1314 @item 1 min 2 sec 3 hour 4 day 5 week 6 fortnight 7 month 8 year | |
1315 denotes exactly 103 months, 123 days, and 10862 seconds from now. | |
1316 @end table | |
1317 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1318 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
|
1319 days, and a year to be exactly 365.25 days. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1320 |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1321 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
|
1322 relative time measured in seconds. |
6558 | 1323 |
1324 The argument @var{repeat} specifies how often to repeat the call. If | |
1325 @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
|
1326 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
|
1327 specifies a repetition period measured in seconds. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1328 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1329 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
|
1330 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
|
1331 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
|
1332 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
|
1333 functions like @code{display-time}. |
9009 | 1334 |
1335 The function @code{run-at-time} returns a timer value that identifies | |
1336 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
|
1337 @code{cancel-timer} (see below). |
6558 | 1338 @end defun |
1339 | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1340 @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
|
1341 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
|
1342 @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
|
1343 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
|
1344 @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
|
1345 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
|
1346 of them. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1347 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1348 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
|
1349 @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
|
1350 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
|
1351 executes @var{timeout-forms}. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1352 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1353 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
|
1354 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
|
1355 @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
|
1356 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
|
1357 @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
|
1358 @end defmac |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1359 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1360 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
|
1361 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
|
1362 Queries}. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1363 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1364 @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
|
1365 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
|
1366 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
|
1367 number. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1368 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1369 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
|
1370 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
|
1371 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
|
1372 remains idle for @var{secs} seconds. |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1373 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1374 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
|
1375 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
|
1376 @end defun |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1377 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1378 @cindex idleness |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1379 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
|
1380 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
|
1381 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
|
1382 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
|
1383 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
|
1384 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
|
1385 seconds again. |
15762
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 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
|
1388 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
|
1389 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
|
1390 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
|
1391 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
|
1392 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
|
1393 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
|
1394 |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1395 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
|
1396 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
|
1397 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
|
1398 |
6558 | 1399 @defun cancel-timer timer |
1400 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
|
1401 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
|
1402 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
|
1403 of the specified time will not cause anything special to happen. |
6558 | 1404 @end defun |
1405 | |
1406 @node Terminal Input | |
1407 @section Terminal Input | |
1408 @cindex terminal input | |
1409 | |
1410 This section describes functions and variables for recording or | |
1411 manipulating terminal input. See @ref{Display}, for related | |
1412 functions. | |
1413 | |
1414 @menu | |
1415 * Input Modes:: Options for how input is processed. | |
1416 * Translating Input:: Low level conversion of some characters or events | |
1417 into others. | |
1418 * Recording Input:: Saving histories of recent or all input events. | |
1419 @end menu | |
1420 | |
1421 @node Input Modes | |
1422 @subsection Input Modes | |
1423 @cindex input modes | |
1424 @cindex terminal input modes | |
1425 | |
1426 @defun set-input-mode interrupt flow meta quit-char | |
1427 This function sets the mode for reading keyboard input. If | |
1428 @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
|
1429 @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
|
1430 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
|
1431 of what is specified. |
6558 | 1432 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1433 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
|
1434 uses interrupts if that is the way it knows how to communicate. |
6558 | 1435 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1436 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
|
1437 (@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
|
1438 has no effect except in @sc{cbreak} mode. @xref{Flow Control}. |
6558 | 1439 |
1440 @c Emacs 19 feature | |
1441 The argument @var{meta} controls support for input character codes | |
1442 above 127. If @var{meta} is @code{t}, Emacs converts characters with | |
1443 the 8th bit set into Meta characters. If @var{meta} is @code{nil}, | |
1444 Emacs disregards the 8th bit; this is necessary when the terminal uses | |
1445 it as a parity bit. If @var{meta} is neither @code{t} nor @code{nil}, | |
1446 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
|
1447 that use 8-bit character sets. |
6558 | 1448 |
1449 @c Emacs 19 feature | |
1450 If @var{quit-char} is non-@code{nil}, it specifies the character to | |
1451 use for quitting. Normally this character is @kbd{C-g}. | |
1452 @xref{Quitting}. | |
1453 @end defun | |
1454 | |
1455 The @code{current-input-mode} function returns the input mode settings | |
1456 Emacs is currently using. | |
1457 | |
1458 @c Emacs 19 feature | |
1459 @defun current-input-mode | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1460 This function returns the current mode for reading keyboard input. It |
6558 | 1461 returns a list, corresponding to the arguments of @code{set-input-mode}, |
1462 of the form @code{(@var{interrupt} @var{flow} @var{meta} @var{quit})} in | |
1463 which: | |
1464 @table @var | |
1465 @item interrupt | |
1466 is non-@code{nil} when Emacs is using interrupt-driven input. If | |
1467 @code{nil}, Emacs is using @sc{cbreak} mode. | |
1468 @item flow | |
1469 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
|
1470 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
|
1471 when @var{interrupt} is @code{nil}. |
6558 | 1472 @item meta |
12098 | 1473 is @code{t} if Emacs treats the eighth bit of input characters as |
6558 | 1474 the meta bit; @code{nil} means Emacs clears the eighth bit of every |
1475 input character; any other value means Emacs uses all eight bits as the | |
1476 basic character code. | |
1477 @item quit | |
1478 is the character Emacs currently uses for quitting, usually @kbd{C-g}. | |
1479 @end table | |
1480 @end defun | |
1481 | |
1482 @node Translating Input | |
1483 @subsection Translating Input Events | |
1484 @cindex translating input events | |
1485 | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1486 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
|
1487 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
|
1488 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
|
1489 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
|
1490 then translated through @code{keyboard-translate-table} (if applicable), |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1491 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
|
1492 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
|
1493 being read; then subsequences containing it are checked first with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1494 @code{function-key-map} and then with @code{key-translation-map}. |
6558 | 1495 |
1496 @c Emacs 19 feature | |
1497 @defvar extra-keyboard-modifiers | |
1498 This variable lets Lisp programs ``press'' the modifier keys on the | |
1499 keyboard. The value is a bit mask: | |
1500 | |
1501 @table @asis | |
1502 @item 1 | |
1503 The @key{SHIFT} key. | |
1504 @item 2 | |
1505 The @key{LOCK} key. | |
1506 @item 4 | |
1507 The @key{CTL} key. | |
1508 @item 8 | |
1509 The @key{META} key. | |
1510 @end table | |
1511 | |
1512 Each time the user types a keyboard key, it is altered as if the | |
1513 modifier keys specified in the bit mask were held down. | |
1514 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1515 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
|
1516 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
|
1517 keys can be virtually pressed. |
6558 | 1518 @end defvar |
1519 | |
1520 @defvar keyboard-translate-table | |
1521 This variable is the translate table for keyboard characters. It lets | |
1522 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
|
1523 bindings. Its value is normally a char-table, or else @code{nil}. |
6558 | 1524 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1525 If @code{keyboard-translate-table} is a char-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1526 (@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
|
1527 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
|
1528 non-@code{nil}, then it is used instead of the actual input character. |
6558 | 1529 |
1530 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
|
1531 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
|
1532 @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
|
1533 typing @kbd{C-\} has all the usual effects of typing @kbd{C-s}, and vice |
25479 | 1534 versa. (@xref{Flow Control}, for more information on this subject.) |
6558 | 1535 |
1536 @cindex flow control example | |
1537 @example | |
1538 @group | |
1539 (defun evade-flow-control () | |
1540 "Replace C-s with C-\ and C-q with C-^." | |
1541 (interactive) | |
1542 @end group | |
1543 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1544 (setq keyboard-translate-table |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1545 (make-char-table 'keyboard-translate-table nil)) |
6558 | 1546 @end group |
1547 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1548 ;; @r{Swap @kbd{C-s} and @kbd{C-\}.} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1549 (aset keyboard-translate-table ?\034 ?\^s) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1550 (aset keyboard-translate-table ?\^s ?\034) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1551 @end group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1552 @group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1553 ;; @r{Swap @kbd{C-q} and @kbd{C-^}.} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1554 (aset keyboard-translate-table ?\036 ?\^q) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1555 (aset keyboard-translate-table ?\^q ?\036)) |
6558 | 1556 @end group |
1557 @end example | |
1558 | |
1559 Note that this translation is the first thing that happens to a | |
1560 character after it is read from the terminal. Record-keeping features | |
1561 such as @code{recent-keys} and dribble files record the characters after | |
1562 translation. | |
1563 @end defvar | |
1564 | |
1565 @defun keyboard-translate from to | |
1566 This function modifies @code{keyboard-translate-table} to translate | |
1567 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
|
1568 the keyboard translate table if necessary. |
6558 | 1569 @end defun |
1570 | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1571 The remaining translation features translate subsequences of key |
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1572 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
|
1573 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
|
1574 |
6558 | 1575 @defvar function-key-map |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1576 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
|
1577 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
|
1578 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
|
1579 translations to make while reading key sequences, rather than bindings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1580 for key sequences. |
6558 | 1581 |
1582 If @code{function-key-map} ``binds'' a key sequence @var{k} to a vector | |
1583 @var{v}, then when @var{k} appears as a subsequence @emph{anywhere} in a | |
1584 key sequence, it is replaced with the events in @var{v}. | |
1585 | |
1586 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
|
1587 keypad @key{PF1} key is pressed. Therefore, we want Emacs to translate |
6558 | 1588 that sequence of events into the single event @code{pf1}. We accomplish |
1589 this by ``binding'' @kbd{@key{ESC} O P} to @code{[pf1]} in | |
1590 @code{function-key-map}, when using a VT100. | |
1591 | |
1592 Thus, typing @kbd{C-c @key{PF1}} sends the character sequence @kbd{C-c | |
1593 @key{ESC} O P}; later the function @code{read-key-sequence} translates | |
1594 this back into @kbd{C-c @key{PF1}}, which it returns as the vector | |
1595 @code{[?\C-c pf1]}. | |
1596 | |
1597 Entries in @code{function-key-map} are ignored if they conflict with | |
1598 bindings made in the minor mode, local, or global keymaps. The intent | |
1599 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
|
1600 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
|
1601 bindings take priority. |
6558 | 1602 |
1603 The value of @code{function-key-map} is usually set up automatically | |
1604 according to the terminal's Terminfo or Termcap entry, but sometimes | |
1605 those need help from terminal-specific Lisp files. Emacs comes with | |
1606 terminal-specific files for many common terminals; their main purpose is | |
1607 to make entries in @code{function-key-map} beyond those that can be | |
1608 deduced from Termcap and Terminfo. @xref{Terminal-Specific}. | |
1609 @end defvar | |
1610 | |
1611 @defvar key-translation-map | |
1612 This variable is another keymap used just like @code{function-key-map} | |
1613 to translate input events into other events. It differs from | |
1614 @code{function-key-map} in two ways: | |
1615 | |
1616 @itemize @bullet | |
1617 @item | |
1618 @code{key-translation-map} goes to work after @code{function-key-map} is | |
1619 finished; it receives the results of translation by | |
1620 @code{function-key-map}. | |
1621 | |
1622 @item | |
15762
9305e83c313d
Lots of timer feature updates.
Richard M. Stallman <rms@gnu.org>
parents:
13367
diff
changeset
|
1623 @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
|
1624 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
|
1625 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
|
1626 in the global map. |
6558 | 1627 @end itemize |
1628 | |
1629 The intent of @code{key-translation-map} is for users to map one | |
1630 character set to another, including ordinary characters normally bound | |
1631 to @code{self-insert-command}. | |
1632 @end defvar | |
1633 | |
1634 @cindex key translation function | |
1635 You can use @code{function-key-map} or @code{key-translation-map} for | |
1636 more than simple aliases, by using a function, instead of a key | |
1637 sequence, as the ``translation'' of a key. Then this function is called | |
1638 to compute the translation of that key. | |
1639 | |
1640 The key translation function receives one argument, which is the prompt | |
1641 that was specified in @code{read-key-sequence}---or @code{nil} if the | |
1642 key sequence is being read by the editor command loop. In most cases | |
1643 you can ignore the prompt value. | |
1644 | |
1645 If the function reads input itself, it can have the effect of altering | |
1646 the event that follows. For example, here's how to define @kbd{C-c h} | |
1647 to turn the character that follows into a Hyper character: | |
1648 | |
1649 @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
|
1650 @group |
6558 | 1651 (defun hyperify (prompt) |
1652 (let ((e (read-event))) | |
1653 (vector (if (numberp e) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1654 (logior (lsh 1 24) e) |
6558 | 1655 (if (memq 'hyper (event-modifiers e)) |
1656 e | |
1657 (add-event-modifier "H-" e)))))) | |
1658 | |
1659 (defun add-event-modifier (string e) | |
1660 (let ((symbol (if (symbolp e) e (car e)))) | |
1661 (setq symbol (intern (concat string | |
1662 (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
|
1663 @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
|
1664 @group |
6558 | 1665 (if (symbolp e) |
1666 symbol | |
1667 (cons symbol (cdr e))))) | |
1668 | |
1669 (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
|
1670 @end group |
6558 | 1671 @end example |
1672 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1673 Finally, if you have enabled keyboard character set decoding using |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1674 @code{set-keyboard-coding-system}, decoding is done after the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1675 translations listed above. @xref{Specifying Coding Systems}. In future |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1676 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
|
1677 translations. |
6558 | 1678 |
1679 @node Recording Input | |
1680 @subsection Recording Input | |
1681 | |
1682 @defun recent-keys | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1683 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
|
1684 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
|
1685 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
|
1686 100 input events, not counting events generated by keyboard macros. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1687 (These are excluded because they are less interesting for debugging; it |
9009 | 1688 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
|
1689 |
557aaff6fb23
(Time of Day): Document float-time.
Eli Zaretskii <eliz@gnu.org>
parents:
36873
diff
changeset
|
1690 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
|
1691 causes this function to return an empty vector immediately afterward. |
6558 | 1692 @end defun |
1693 | |
26242 | 1694 @deffn Command open-dribble-file filename |
6558 | 1695 @cindex dribble file |
1696 This function opens a @dfn{dribble file} named @var{filename}. When a | |
1697 dribble file is open, each input event from the keyboard or mouse (but | |
1698 not those from keyboard macros) is written in that file. A | |
1699 non-character event is expressed using its printed representation | |
1700 surrounded by @samp{<@dots{}>}. | |
1701 | |
1702 You close the dribble file by calling this function with an argument | |
1703 of @code{nil}. | |
1704 | |
1705 This function is normally used to record the input necessary to | |
1706 trigger an Emacs bug, for the sake of a bug report. | |
1707 | |
1708 @example | |
1709 @group | |
1710 (open-dribble-file "~/dribble") | |
1711 @result{} nil | |
1712 @end group | |
1713 @end example | |
1714 @end deffn | |
1715 | |
1716 See also the @code{open-termscript} function (@pxref{Terminal Output}). | |
1717 | |
1718 @node Terminal Output | |
1719 @section Terminal Output | |
1720 @cindex terminal output | |
1721 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1722 The terminal output functions send output to the terminal, or keep |
6558 | 1723 track of output sent to the terminal. The variable @code{baud-rate} |
1724 tells you what Emacs thinks is the output speed of the terminal. | |
1725 | |
1726 @defvar baud-rate | |
1727 This variable's value is the output speed of the terminal, as far as | |
1728 Emacs knows. Setting this variable does not change the speed of actual | |
1729 data transmission, but the value is used for calculations such as | |
1730 padding. It also affects decisions about whether to scroll part of the | |
9009 | 1731 screen or repaint---even when using a window system. (We designed it |
6558 | 1732 this way despite the fact that a window system has no true ``output |
1733 speed'', to give you a way to tune these decisions.) | |
1734 | |
1735 The value is measured in baud. | |
1736 @end defvar | |
1737 | |
1738 If you are running across a network, and different parts of the | |
1739 network work at different baud rates, the value returned by Emacs may be | |
1740 different from the value used by your local terminal. Some network | |
1741 protocols communicate the local terminal speed to the remote machine, so | |
1742 that Emacs and other programs can get the proper value, but others do | |
1743 not. If Emacs has the wrong value, it makes decisions that are less | |
1744 than optimal. To fix the problem, set @code{baud-rate}. | |
1745 | |
1746 @defun baud-rate | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1747 This obsolete function returns the value of the variable |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1748 @code{baud-rate}. |
6558 | 1749 @end defun |
1750 | |
1751 @defun send-string-to-terminal string | |
1752 This function sends @var{string} to the terminal without alteration. | |
1753 Control characters in @var{string} have terminal-dependent effects. | |
1754 | |
1755 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
|
1756 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
|
1757 certain terminals) to define function key 4 to move forward four |
6558 | 1758 characters (by transmitting the characters @kbd{C-u C-f} to the |
1759 computer): | |
1760 | |
1761 @example | |
1762 @group | |
1763 (send-string-to-terminal "\eF4\^U\^F") | |
1764 @result{} nil | |
1765 @end group | |
1766 @end example | |
1767 @end defun | |
1768 | |
1769 @deffn Command open-termscript filename | |
1770 @cindex termscript file | |
1771 This function is used to open a @dfn{termscript file} that will record | |
1772 all the characters sent by Emacs to the terminal. It returns | |
1773 @code{nil}. Termscript files are useful for investigating problems | |
1774 where Emacs garbles the screen, problems that are due to incorrect | |
1775 Termcap entries or to undesirable settings of terminal options more | |
1776 often than to actual Emacs bugs. Once you are certain which characters | |
1777 were actually output, you can determine reliably whether they correspond | |
1778 to the Termcap specifications in use. | |
1779 | |
1780 See also @code{open-dribble-file} in @ref{Terminal Input}. | |
1781 | |
1782 @example | |
1783 @group | |
1784 (open-termscript "../junk/termscript") | |
1785 @result{} nil | |
1786 @end group | |
1787 @end example | |
1788 @end deffn | |
1789 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1790 @node Sound Output |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1791 @section Sound Output |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1792 @cindex sound |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1793 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1794 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
|
1795 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
|
1796 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
|
1797 earlier did not support sound at all. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1798 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1799 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
|
1800 or Sun Audio format (@samp{.au}). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1801 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1802 @tindex play-sound |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1803 @defun play-sound sound |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1804 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
|
1805 the form @code{(sound @var{properties}...)}, where the @var{properties} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1806 consist of alternating keywords (particular symbols recognized |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1807 specially) and values corresponding to them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1808 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1809 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
|
1810 @var{sound}, and their meanings: |
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 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1813 @item :file @var{file} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1814 This specifies the file containing the sound to play. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1815 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
|
1816 the directory @code{data-directory}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1817 |
27259
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
1818 @item :data @var{data} |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
1819 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
|
1820 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
|
1821 sound file. We recommend using a unibyte string. |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
1822 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1823 @item :volume @var{volume} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1824 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
|
1825 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
|
1826 specified before. |
33951
ac7551c36926
Doc play-sound-file and sound :device.
Dave Love <fx@gnu.org>
parents:
32924
diff
changeset
|
1827 |
ac7551c36926
Doc play-sound-file and sound :device.
Dave Love <fx@gnu.org>
parents:
32924
diff
changeset
|
1828 @item :device @var{device} |
ac7551c36926
Doc play-sound-file and sound :device.
Dave Love <fx@gnu.org>
parents:
32924
diff
changeset
|
1829 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
|
1830 string. The default device is system-dependent. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1831 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1832 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1833 Before actually playing the sound, @code{play-sound} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1834 calls the functions in the list @code{play-sound-functions}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1835 Each function is called with one argument, @var{sound}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1836 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1837 |
33951
ac7551c36926
Doc play-sound-file and sound :device.
Dave Love <fx@gnu.org>
parents:
32924
diff
changeset
|
1838 @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
|
1839 @tindex play-sound-file |
ac7551c36926
Doc play-sound-file and sound :device.
Dave Love <fx@gnu.org>
parents:
32924
diff
changeset
|
1840 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
|
1841 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
|
1842 @end defun |
ac7551c36926
Doc play-sound-file and sound :device.
Dave Love <fx@gnu.org>
parents:
32924
diff
changeset
|
1843 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1844 @tindex play-sound-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1845 @defvar play-sound-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1846 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
|
1847 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
|
1848 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1849 |
6558 | 1850 @node Special Keysyms |
1851 @section System-Specific X11 Keysyms | |
1852 | |
1853 To define system-specific X11 keysyms, set the variable | |
1854 @code{system-key-alist}. | |
1855 | |
1856 @defvar system-key-alist | |
1857 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
|
1858 system-specific keysym. Each element has the form @code{(@var{code} |
6558 | 1859 . @var{symbol})}, where @var{code} is the numeric keysym code (not |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1860 including the ``vendor specific'' bit, |
27193 | 1861 @ifnottex |
24934 | 1862 -2**28), |
27193 | 1863 @end ifnottex |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1864 @tex |
24934 | 1865 $-2^{28}$), |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1866 @end tex |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1867 and @var{symbol} is the name for the function key. |
6558 | 1868 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1869 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
|
1870 by HP X servers) whose numeric code is |
27193 | 1871 @ifnottex |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1872 -2**28 |
27193 | 1873 @end ifnottex |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1874 @tex |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1875 $-2^{28}$ |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1876 @end tex |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1877 + 168. |
6558 | 1878 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1879 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
|
1880 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
|
1881 used by the X server actually in use. |
12067 | 1882 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1883 The variable is always local to the current terminal, and cannot be |
12067 | 1884 buffer-local. @xref{Multiple Displays}. |
6558 | 1885 @end defvar |
1886 | |
1887 @node Flow Control | |
1888 @section Flow Control | |
1889 @cindex flow control characters | |
1890 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1891 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
|
1892 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
|
1893 view on this issue, read the comments on flow control in the |
6558 | 1894 @file{emacs/INSTALL} file from the distribution; for help with Termcap |
1895 entries and DEC terminal concentrators, see @file{emacs/etc/TERMS}. | |
1896 | |
1897 @cindex @kbd{C-s} | |
1898 @cindex @kbd{C-q} | |
1899 At one time, most terminals did not need flow control, and none used | |
1900 @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
|
1901 @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
|
1902 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
|
1903 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
|
1904 control characters. |
6558 | 1905 |
1906 Later, some terminals were introduced which required these characters | |
1907 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
|
1908 editing, so Emacs maintainers ignored them. In later years, flow |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1909 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
|
1910 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
|
1911 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
|
1912 mnemonic key bindings for the sake of flow control. |
6558 | 1913 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1914 So which usage is ``right''---Emacs's or that of some terminal and |
6558 | 1915 concentrator manufacturers? This question has no simple answer. |
1916 | |
1917 One reason why we are reluctant to cater to the problems caused by | |
1918 @kbd{C-s} and @kbd{C-q} is that they are gratuitous. There are other | |
1919 techniques (albeit less common in practice) for flow control that | |
1920 preserve transparency of the character stream. Note also that their use | |
1921 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
|
1922 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
|
1923 @kbd{C-q} were sent by the computer to turn the punch on and off! |
6558 | 1924 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1925 As window systems and PC terminal emulators replace character-only |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1926 terminals, the flow control problem is gradually disappearing. For the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1927 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
|
1928 you want it: call the function @code{enable-flow-control}. |
6558 | 1929 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
20103
diff
changeset
|
1930 @deffn Command enable-flow-control |
6558 | 1931 This function enables use of @kbd{C-s} and @kbd{C-q} for output flow |
1932 control, and provides the characters @kbd{C-\} and @kbd{C-^} as aliases | |
1933 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
|
1934 @end deffn |
6558 | 1935 |
1936 You can use the function @code{enable-flow-control-on} in your | |
25875 | 1937 init file to enable flow control automatically on certain |
6558 | 1938 terminal types. |
1939 | |
1940 @defun enable-flow-control-on &rest termtypes | |
1941 This function enables flow control, and the aliases @kbd{C-\} and @kbd{C-^}, | |
1942 if the terminal type is one of @var{termtypes}. For example: | |
1943 | |
1944 @smallexample | |
1945 (enable-flow-control-on "vt200" "vt300" "vt101" "vt131") | |
1946 @end smallexample | |
1947 @end defun | |
1948 | |
1949 Here is how @code{enable-flow-control} does its job: | |
1950 | |
1951 @enumerate | |
1952 @item | |
1953 @cindex @sc{cbreak} | |
1954 It sets @sc{cbreak} mode for terminal input, and tells the operating | |
1955 system to handle flow control, with @code{(set-input-mode nil t)}. | |
1956 | |
1957 @item | |
1958 It sets up @code{keyboard-translate-table} to translate @kbd{C-\} and | |
9009 | 1959 @kbd{C-^} into @kbd{C-s} and @kbd{C-q}. Except at its very |
6558 | 1960 lowest level, Emacs never knows that the characters typed were anything |
1961 but @kbd{C-s} and @kbd{C-q}, so you can in effect type them as @kbd{C-\} | |
1962 and @kbd{C-^} even when they are input for other commands. | |
1963 @xref{Translating Input}. | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1964 @end enumerate |
6558 | 1965 |
1966 If the terminal is the source of the flow control characters, then once | |
1967 you enable kernel flow control handling, you probably can make do with | |
1968 less padding than normal for that terminal. You can reduce the amount | |
1969 of padding by customizing the Termcap entry. You can also reduce it by | |
1970 setting @code{baud-rate} to a smaller value so that Emacs uses a smaller | |
1971 speed when calculating the padding needed. @xref{Terminal Output}. | |
1972 | |
1973 @node Batch Mode | |
1974 @section Batch Mode | |
1975 @cindex batch mode | |
1976 @cindex noninteractive use | |
1977 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25479
diff
changeset
|
1978 The command-line option @samp{-batch} causes Emacs to run |
6558 | 1979 noninteractively. In this mode, Emacs does not read commands from the |
1980 terminal, it does not alter the terminal modes, and it does not expect | |
1981 to be outputting to an erasable screen. The idea is that you specify | |
1982 Lisp programs to run; when they are finished, Emacs should exit. The | |
1983 way to specify the programs to run is with @samp{-l @var{file}}, which | |
1984 loads the library named @var{file}, and @samp{-f @var{function}}, which | |
1985 calls @var{function} with no arguments. | |
1986 | |
1987 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
|
1988 either using @code{message}, or using @code{prin1}, etc., with @code{t} |
12098 | 1989 as the stream, goes instead to Emacs's standard error descriptor when |
36873 | 1990 in batch mode. Similarly, input that would normally come from the |
1991 minibuffer is read from the standard input descriptor. | |
1992 Thus, Emacs behaves much like a noninteractive | |
6558 | 1993 application program. (The echo area output that Emacs itself normally |
1994 generates, such as command echoing, is suppressed entirely.) | |
1995 | |
1996 @defvar noninteractive | |
1997 This variable is non-@code{nil} when Emacs is running in batch mode. | |
1998 @end defvar |