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