annotate lispref/os.texi @ 63832:d367f23e6db1

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