annotate doc/lispref/os.texi @ 104499:d0cdad3e21eb

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