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