Relocate NEWS entry from 24.3 section to 24.4 where it belongs
[bpt/emacs.git] / lisp / startup.el
CommitLineData
06788a55 1;;; startup.el --- process Emacs shell arguments -*- lexical-binding: t -*-
c88ab9ce 2
ab422c4d
PE
3;; Copyright (C) 1985-1986, 1992, 1994-2013 Free Software Foundation,
4;; Inc.
eea8d4ef 5
630cc463 6;; Maintainer: FSF
d7b4d18f 7;; Keywords: internal
bd78fa1d 8;; Package: emacs
630cc463 9
a726e0d1
JB
10;; This file is part of GNU Emacs.
11
eb3fa2cf 12;; GNU Emacs is free software: you can redistribute it and/or modify
a726e0d1 13;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
a726e0d1
JB
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
eb3fa2cf 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
a726e0d1 24
630cc463 25;;; Commentary:
a726e0d1 26
6b61353c
KH
27;; This file parses the command line and gets Emacs running. Options
28;; on the command line are handled in precedence order. For priorities
29;; see the structure standard_args in the emacs.c file.
a726e0d1 30
630cc463
ER
31;;; Code:
32
a726e0d1
JB
33(setq top-level '(normal-top-level))
34
42a3e6fa 35(defvar command-line-processed nil
2879a13b 36 "Non-nil once command line has been processed.")
a726e0d1 37
42a3e6fa 38(defgroup initialization nil
ca3685a3 39 "Emacs start-up procedure."
26cdce23
JL
40 :group 'environment)
41
42(defcustom initial-buffer-choice nil
43 "Buffer to show after starting Emacs.
490a1ad6 44If the value is nil and `inhibit-startup-screen' is nil, show the
dc646358
CK
45startup screen. If the value is a string, switch to a buffer
46visiting the file or directory specified by that string. If the
47value is a function, switch to the buffer returned by that
48function. If t, open the `*scratch*' buffer.
48de8b12
CY
49
50A string value also causes emacsclient to open the specified file
51or directory when no target file is specified."
26cdce23 52 :type '(choice
490a1ad6 53 (const :tag "Startup screen" nil)
26cdce23 54 (directory :tag "Directory" :value "~/")
85b84319 55 (file :tag "File" :value "~/.emacs")
dc646358 56 (function :tag "Function")
621ef9ab 57 (const :tag "Lisp scratch buffer" t))
dc646358 58 :version "24.4"
26cdce23 59 :group 'initialization)
42a3e6fa 60
490a1ad6 61(defcustom inhibit-startup-screen nil
249d9683 62 "Non-nil inhibits the startup screen.
249d9683 63
eeaa563e
JB
64This is for use in your personal init file (but NOT site-start.el),
65once you are familiar with the contents of the startup screen."
42a3e6fa
RS
66 :type 'boolean
67 :group 'initialization)
a726e0d1 68
490a1ad6
JL
69(defvaralias 'inhibit-splash-screen 'inhibit-startup-screen)
70(defvaralias 'inhibit-startup-message 'inhibit-startup-screen)
1b207153 71
22a58255 72(defvar startup-screen-inhibit-startup-screen nil)
1b207153 73
33da7b16
GM
74;; FIXME? Why does this get such weirdly extreme treatment, when the
75;; more important inhibit-startup-screen does not.
42a3e6fa 76(defcustom inhibit-startup-echo-area-message nil
ea6c930a 77 "Non-nil inhibits the initial startup echo area message.
42a3e6fa
RS
78Setting this variable takes effect
79only if you do it with the customization buffer
865fe16f 80or if your init file contains a line of this form:
54a003f7 81 (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\")
865fe16f
CY
82If your init file is byte-compiled, use the following form
83instead:
e5575c06 84 (eval '(setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\"))
865fe16f
CY
85Thus, someone else using a copy of your init file will see the
86startup message unless he personally acts to inhibit it."
42a3e6fa
RS
87 :type '(choice (const :tag "Don't inhibit")
88 (string :tag "Enter your user name, to inhibit"))
89 :group 'initialization)
1d7da582 90
42a3e6fa 91(defcustom inhibit-default-init nil
ea6c930a 92 "Non-nil inhibits loading the `default' library."
42a3e6fa
RS
93 :type 'boolean
94 :group 'initialization)
a726e0d1 95
802a980a 96(defcustom inhibit-startup-buffer-menu nil
ea6c930a 97 "Non-nil inhibits display of buffer list when more than 2 files are loaded."
802a980a
GM
98 :type 'boolean
99 :group 'initialization)
100
d7fa5aa2 101(defvar command-switch-alist nil
a726e0d1
JB
102 "Alist of command-line switches.
103Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
6b61353c
KH
104HANDLER-FUNCTION receives the switch string as its sole argument;
105the remaining command-line args are in the variable `command-line-args-left'.")
a726e0d1 106
860befc8
RS
107(defvar command-line-args-left nil
108 "List of command-line args not yet processed.")
109
aa5310e4
DK
110(defvaralias 'argv 'command-line-args-left
111 "List of command-line args not yet processed.
112This is a convenience alias, so that one can write \(pop argv\)
113inside of --eval command line arguments in order to access
114following arguments.")
513749ee 115(internal-make-var-non-special 'argv)
aa5310e4 116
513749ee
SM
117(defvar argi nil
118 "Current command-line argument.")
119(internal-make-var-non-special 'argi)
62f1ca49 120
a726e0d1
JB
121(defvar command-line-functions nil ;; lrs 7/31/89
122 "List of functions to process unrecognized command-line arguments.
123Each function should access the dynamically bound variables
b4484ea8 124`argi' (the current argument) and `command-line-args-left' (the remaining
a726e0d1 125arguments). The function should return non-nil only if it recognizes and
b4484ea8
RS
126processes `argi'. If it does so, it may consume successive arguments by
127altering `command-line-args-left' to remove them.")
a726e0d1 128
09a1077c
RS
129(defvar command-line-default-directory nil
130 "Default directory to use for command line arguments.
131This is normally copied from `default-directory' when Emacs starts.")
132
36cec983
SM
133;; This is here, rather than in x-win.el, so that we can ignore these
134;; options when we are not using X.
46cfd295 135(defconst command-line-x-option-alist
b3afdeb8
RS
136 '(("-bw" 1 x-handle-numeric-switch border-width)
137 ("-d" 1 x-handle-display)
138 ("-display" 1 x-handle-display)
5676ab57 139 ("-name" 1 x-handle-name-switch)
2c3fef40
RS
140 ("-title" 1 x-handle-switch title)
141 ("-T" 1 x-handle-switch title)
b3afdeb8
RS
142 ("-r" 0 x-handle-switch reverse t)
143 ("-rv" 0 x-handle-switch reverse t)
144 ("-reverse" 0 x-handle-switch reverse t)
145 ("-reverse-video" 0 x-handle-switch reverse t)
146 ("-fn" 1 x-handle-switch font)
147 ("-font" 1 x-handle-switch font)
188b6a5e
EZ
148 ("-fs" 0 x-handle-initial-switch fullscreen fullboth)
149 ("-fw" 0 x-handle-initial-switch fullscreen fullwidth)
150 ("-fh" 0 x-handle-initial-switch fullscreen fullheight)
3f1c6666 151 ("-mm" 0 x-handle-initial-switch fullscreen maximized)
b3afdeb8 152 ("-ib" 1 x-handle-numeric-switch internal-border-width)
1f7f78f1 153 ("-g" 1 x-handle-geometry)
9ff6bda1 154 ("-lsp" 1 x-handle-numeric-switch line-spacing)
1f7f78f1 155 ("-geometry" 1 x-handle-geometry)
b3afdeb8
RS
156 ("-fg" 1 x-handle-switch foreground-color)
157 ("-foreground" 1 x-handle-switch foreground-color)
158 ("-bg" 1 x-handle-switch background-color)
159 ("-background" 1 x-handle-switch background-color)
160 ("-ms" 1 x-handle-switch mouse-color)
c755acf3 161 ("-nbi" 0 x-handle-switch icon-type nil)
b3afdeb8
RS
162 ("-iconic" 0 x-handle-iconic)
163 ("-xrm" 1 x-handle-xrm-switch)
164 ("-cr" 1 x-handle-switch cursor-color)
165 ("-vb" 0 x-handle-switch vertical-scroll-bars t)
166 ("-hb" 0 x-handle-switch horizontal-scroll-bars t)
167 ("-bd" 1 x-handle-switch)
168 ("--border-width" 1 x-handle-numeric-switch border-width)
169 ("--display" 1 x-handle-display)
5676ab57 170 ("--name" 1 x-handle-name-switch)
7775acb8 171 ("--title" 1 x-handle-switch title)
b3afdeb8
RS
172 ("--reverse-video" 0 x-handle-switch reverse t)
173 ("--font" 1 x-handle-switch font)
188b6a5e
EZ
174 ("--fullscreen" 0 x-handle-initial-switch fullscreen fullboth)
175 ("--fullwidth" 0 x-handle-initial-switch fullscreen fullwidth)
176 ("--fullheight" 0 x-handle-initial-switch fullscreen fullheight)
3f1c6666 177 ("--maximized" 0 x-handle-initial-switch fullscreen maximized)
b3afdeb8 178 ("--internal-border" 1 x-handle-numeric-switch internal-border-width)
1f7f78f1 179 ("--geometry" 1 x-handle-geometry)
b3afdeb8
RS
180 ("--foreground-color" 1 x-handle-switch foreground-color)
181 ("--background-color" 1 x-handle-switch background-color)
182 ("--mouse-color" 1 x-handle-switch mouse-color)
bb1f0f78 183 ("--no-bitmap-icon" 0 x-handle-no-bitmap-icon)
b3afdeb8
RS
184 ("--iconic" 0 x-handle-iconic)
185 ("--xrm" 1 x-handle-xrm-switch)
186 ("--cursor-color" 1 x-handle-switch cursor-color)
187 ("--vertical-scroll-bars" 0 x-handle-switch vertical-scroll-bars t)
9ff6bda1 188 ("--line-spacing" 1 x-handle-numeric-switch line-spacing)
7f944e8e 189 ("--border-color" 1 x-handle-switch border-color)
c434f203
JD
190 ("--smid" 1 x-handle-smid)
191 ("--parent-id" 1 x-handle-parent-id))
b3afdeb8
RS
192 "Alist of X Windows options.
193Each element has the form
194 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
195where NAME is the option name string, NUMARGS is the number of arguments
196that the option accepts, HANDLER is a function to call to handle the option.
197FRAME-PARAM (optional) is the frame parameter this option specifies,
198and VALUE is the value which is given to that frame parameter
199\(most options use the argument for this, so VALUE is not present).")
200
edfda783
AR
201(defconst command-line-ns-option-alist
202 '(("-NSAutoLaunch" 1 ns-ignore-1-arg)
203 ("-NXAutoLaunch" 1 ns-ignore-1-arg)
55e8d9a5 204 ("-macosx" 0 ignore)
edfda783
AR
205 ("-NSHost" 1 ns-ignore-1-arg)
206 ("-_NSMachLaunch" 1 ns-ignore-1-arg)
207 ("-MachLaunch" 1 ns-ignore-1-arg)
208 ("-NXOpen" 1 ns-ignore-1-arg)
209 ("-NSOpen" 1 ns-handle-nxopen)
210 ("-NXOpenTemp" 1 ns-ignore-1-arg)
211 ("-NSOpenTemp" 1 ns-handle-nxopentemp)
212 ("-GSFilePath" 1 ns-handle-nxopen)
213 ;;("-bw" . x-handle-numeric-switch)
214 ;;("-d" . x-handle-display)
215 ;;("-display" . x-handle-display)
d7d8c62a
GM
216 ("-name" 1 x-handle-name-switch)
217 ("-title" 1 x-handle-switch title)
218 ("-T" 1 x-handle-switch title)
219 ("-r" 0 x-handle-switch reverse t)
220 ("-rv" 0 x-handle-switch reverse t)
221 ("-reverse" 0 x-handle-switch reverse t)
222 ("-fn" 1 x-handle-switch font)
223 ("-font" 1 x-handle-switch font)
224 ("-ib" 1 x-handle-numeric-switch internal-border-width)
e543ae91
JD
225 ("-g" 1 x-handle-geometry)
226 ("-geometry" 1 x-handle-geometry)
d7d8c62a
GM
227 ("-fg" 1 x-handle-switch foreground-color)
228 ("-foreground" 1 x-handle-switch foreground-color)
229 ("-bg" 1 x-handle-switch background-color)
230 ("-background" 1 x-handle-switch background-color)
231; ("-ms" 1 x-handle-switch mouse-color)
232 ("-itype" 0 x-handle-switch icon-type t)
233 ("-i" 0 x-handle-switch icon-type t)
234 ("-iconic" 0 x-handle-iconic icon-type t)
edfda783 235 ;;("-xrm" . x-handle-xrm-switch)
d7d8c62a
GM
236 ("-cr" 1 x-handle-switch cursor-color)
237 ("-vb" 0 x-handle-switch vertical-scroll-bars t)
238 ("-hb" 0 x-handle-switch horizontal-scroll-bars t)
239 ("-bd" 1 x-handle-switch)
240 ;; ("--border-width" 1 x-handle-numeric-switch border-width)
edfda783 241 ;; ("--display" 1 ns-handle-display)
d7d8c62a
GM
242 ("--name" 1 x-handle-name-switch)
243 ("--title" 1 x-handle-switch title)
244 ("--reverse-video" 0 x-handle-switch reverse t)
245 ("--font" 1 x-handle-switch font)
246 ("--internal-border" 1 x-handle-numeric-switch internal-border-width)
edfda783 247 ;; ("--geometry" 1 ns-handle-geometry)
d7d8c62a
GM
248 ("--foreground-color" 1 x-handle-switch foreground-color)
249 ("--background-color" 1 x-handle-switch background-color)
250 ("--mouse-color" 1 x-handle-switch mouse-color)
251 ("--icon-type" 0 x-handle-switch icon-type t)
252 ("--iconic" 0 x-handle-iconic)
edfda783 253 ;; ("--xrm" 1 ns-handle-xrm-switch)
d7d8c62a
GM
254 ("--cursor-color" 1 x-handle-switch cursor-color)
255 ("--vertical-scroll-bars" 0 x-handle-switch vertical-scroll-bars t)
256 ("--border-color" 1 x-handle-switch border-width))
edfda783
AR
257 "Alist of NS options.
258Each element has the form
259 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
260where NAME is the option name string, NUMARGS is the number of arguments
261that the option accepts, HANDLER is a function to call to handle the option.
262FRAME-PARAM (optional) is the frame parameter this option specifies,
263and VALUE is the value which is given to that frame parameter
264\(most options use the argument for this, so VALUE is not present).")
265
266
e3bd99f5 267(defvar before-init-hook nil
db3f571a 268 "Normal hook run after handling urgent options but before loading init files.")
3fc958a4 269
e3bd99f5 270(defvar after-init-hook nil
865fe16f
CY
271 "Normal hook run after initializing the Emacs session.
272It is run after Emacs loads the init file, `default' library, the
273abbrevs file, and additional Lisp packages (if any), and setting
274the value of `after-init-time'.
275
276There is no `condition-case' around the running of this hook;
277therefore, if `debug-on-error' is non-nil, an error in one of
278these functions will invoke the debugger.")
db3f571a
KH
279
280(defvar emacs-startup-hook nil
281 "Normal hook run after loading init files and handling the command line.")
e3bd99f5 282
a726e0d1 283(defvar term-setup-hook nil
db3f571a
KH
284 "Normal hook run after loading terminal-specific Lisp code.
285It also follows `emacs-startup-hook'. This hook exists for users to set,
a726e0d1
JB
286so as to override the definitions made by the terminal-specific file.
287Emacs never sets this variable itself.")
288
deebb0e9
RS
289(defvar inhibit-startup-hooks nil
290 "Non-nil means don't run `term-setup-hook' and `emacs-startup-hook'.
291This is because we already did so.")
292
a726e0d1 293(defvar keyboard-type nil
b4484ea8 294 "The brand of keyboard you are using.
9ab281f0
JB
295This variable is used to define the proper function and keypad
296keys for use under X. It is used in a fashion analogous to the
297environment variable TERM.")
a726e0d1
JB
298
299(defvar window-setup-hook nil
b4484ea8
RS
300 "Normal hook run to initialize window system display.
301Emacs runs this hook after processing the command line arguments and loading
302the user's init file.")
a726e0d1 303
42a3e6fa 304(defcustom initial-major-mode 'lisp-interaction-mode
ab863ac2 305 "Major mode command symbol to use for the initial `*scratch*' buffer."
ce2f921e 306 :type 'function
42a3e6fa 307 :group 'initialization)
a726e0d1 308
ecbff273 309(defvar init-file-user nil
865fe16f 310 "Identity of user whose init file is or was read.
d7fa5aa2
RS
311The value is nil if `-q' or `--no-init-file' was specified,
312meaning do not load any init file.
313
d3a81eee
EZ
314Otherwise, the value may be an empty string, meaning
315use the init file for the user who originally logged in,
316or it may be a string containing a user's name meaning
317use that person's init file.
a726e0d1 318
2bdfaa42 319In either of the latter cases, `(concat \"~\" init-file-user \"/\")'
865fe16f 320evaluates to the name of the directory where the init file was
13fce4e6
RS
321looked for.
322
323Setting `init-file-user' does not prevent Emacs from loading
ecbff273 324`site-start.el'. The only way to do that is to use `--no-site-file'.")
a726e0d1 325
1e8780b1 326(defcustom site-run-file (purecopy "site-start")
b7444d31
RS
327 "File containing site-wide run-time initializations.
328This file is loaded at run-time before `~/.emacs'. It contains inits
329that need to be in place for the entire site, but which, due to their
fcaf7de9 330higher incidence of change, don't make sense to load into Emacs's
b7444d31 331dumped image. Thus, the run-time load order is: 1. file described in
13fce4e6
RS
332this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.
333
334Don't use the `site-start.el' file for things some users may not like.
335Put them in `default.el' instead, so that users can more easily
336override them. Users can prevent loading `default.el' with the `-q'
337option or by setting `inhibit-default-init' in their own init files,
338but inhibiting `site-start.el' requires `--no-site-file', which
842a1eac
RS
339is less convenient.
340
341This variable is defined for customization so as to make
342it visible in the relevant context. However, actually customizing it
343is not allowed, since it would not work anyway. The only way to set
9ab281f0 344this variable usefully is to set it while building and dumping Emacs."
93812130 345 :type '(choice (const :tag "none" nil) string)
842a1eac
RS
346 :group 'initialization
347 :initialize 'custom-initialize-default
06788a55 348 :set (lambda (_variable _value)
842a1eac 349 (error "Customizing `site-run-file' does not work")))
b7444d31 350
42a3e6fa 351(defcustom mail-host-address nil
b4fa35fa
GM
352 "Name of this machine, for purposes of naming users.
353If non-nil, Emacs uses this instead of `system-name' when constructing
354email addresses."
42a3e6fa
RS
355 :type '(choice (const nil) string)
356 :group 'mail)
c13fbb62 357
680ebfa6 358(defcustom user-mail-address (if command-line-processed
cee0c996
EZ
359 (or (getenv "EMAIL")
360 (concat (user-login-name) "@"
361 (or mail-host-address
362 (system-name))))
680ebfa6
RS
363 ;; Empty string means "not set yet".
364 "")
ea6c930a 365 "Full mailing address of this user.
cee0c996 366This is initialized with environment variable `EMAIL' or, as a
eeaa563e 367fallback, using `mail-host-address'. This is done after your
cee0c996 368init file is read, in case it sets `mail-host-address'."
42a3e6fa
RS
369 :type 'string
370 :group 'mail)
c10d1f06 371
42a3e6fa 372(defcustom auto-save-list-file-prefix
73f13e5a
GM
373 (cond ((eq system-type 'ms-dos)
374 ;; MS-DOS cannot have initial dot, and allows only 8.3 names
945a0a0c 375 (concat user-emacs-directory "auto-save.list/_s"))
73f13e5a 376 (t
945a0a0c 377 (concat user-emacs-directory "auto-save-list/.saves-")))
cdee38c3 378 "Prefix for generating `auto-save-list-file-name'.
865fe16f 379This is used after reading your init file to initialize
cdee38c3
KH
380`auto-save-list-file-name', by appending Emacs's pid and the system name,
381if you have not already set `auto-save-list-file-name' yourself.
73f13e5a 382Directories in the prefix will be created if necessary.
cdee38c3 383Set this to nil if you want to prevent `auto-save-list-file-name'
42a3e6fa 384from being initialized."
3671f444
KH
385 :type '(choice (const :tag "Don't record a session's auto save list" nil)
386 string)
42a3e6fa 387 :group 'auto-save)
2e05d063 388
dc58296d
RS
389(defvar emacs-basic-display nil)
390
a726e0d1
JB
391(defvar init-file-debug nil)
392
5b309ebf
RS
393(defvar init-file-had-error nil
394 "Non-nil if there was an error loading the user's init file.")
52320897 395
95eada65
RS
396(defvar normal-top-level-add-subdirs-inode-list nil)
397
178b4542
JL
398(defvar no-blinking-cursor nil)
399
0a480f3d
RS
400(defvar default-frame-background-mode)
401
b693e375
RS
402(defvar pure-space-overflow nil
403 "Non-nil if building Emacs overflowed pure space.")
404
ca0a881a 405(defvar pure-space-overflow-message (purecopy "\
22a58255 406Warning Warning!!! Pure space overflow !!!Warning Warning
ca0a881a 407\(See the node Pure Storage in the Lisp manual for details.)\n"))
22a58255 408
45448e64
SM
409(defcustom tutorial-directory
410 (file-name-as-directory (expand-file-name "tutorials" data-directory))
411 "Directory containing the Emacs TUTORIAL files."
412 :group 'installation
413 :type 'directory
414 :initialize 'custom-initialize-delay)
5f5ba825 415
4525ce3e
CY
416(defconst package-subdirectory-regexp
417 "\\([^.].*?\\)-\\([0-9]+\\(?:[.][0-9]+\\|\\(?:pre\\|beta\\|alpha\\)[0-9]+\\)*\\)"
418 "Regular expression matching the name of a package subdirectory.
419The first subexpression is the package name.
420The second subexpression is the version string.
421
422The regexp should not contain a starting \"\\`\" or a trailing
423 \"\\'\"; those are added automatically by callers.")
424
859e15c1 425(defun normal-top-level-add-subdirs-to-load-path ()
04ed2e9c 426 "Add all subdirectories of `default-directory' to `load-path'.
0412d833 427More precisely, this uses only the subdirectories whose names
f734a13e
DL
428start with letters or digits; it excludes any subdirectory named `RCS'
429or `CVS', and any subdirectory that contains a file named `.nosearch'."
f1180544 430 (let (dirs
95eada65 431 attrs
859e15c1
KH
432 (pending (list default-directory)))
433 ;; This loop does a breadth-first tree walk on DIR's subtree,
434 ;; putting each subdir into DIRS as its contents are examined.
435 (while pending
4e0a3971 436 (push (pop pending) dirs)
722a451d
EZ
437 (let* ((this-dir (car dirs))
438 (contents (directory-files this-dir))
439 (default-directory this-dir)
fcaf7de9
SM
440 (canonicalized (if (fboundp 'untranslated-canonical-name)
441 (untranslated-canonical-name this-dir))))
ad961a00
GM
442 ;; The Windows version doesn't report meaningful inode numbers, so
443 ;; use the canonicalized absolute file name of the directory instead.
722a451d
EZ
444 (setq attrs (or canonicalized
445 (nthcdr 10 (file-attributes this-dir))))
95eada65 446 (unless (member attrs normal-top-level-add-subdirs-inode-list)
4e0a3971
SM
447 (push attrs normal-top-level-add-subdirs-inode-list)
448 (dolist (file contents)
ad961a00
GM
449 (and (string-match "\\`[[:alnum:]]" file)
450 ;; The lower-case variants of RCS and CVS are for DOS/Windows.
451 (not (member file '("RCS" "CVS" "rcs" "cvs")))
452 ;; Avoid doing a `stat' when it isn't necessary because
453 ;; that can cause trouble when an NFS server is down.
454 (not (string-match "\\.elc?\\'" file))
455 (file-directory-p file)
456 (let ((expanded (expand-file-name file)))
457 (or (file-exists-p (expand-file-name ".nosearch" expanded))
458 (setq pending (nconc pending (list expanded))))))))))
bb15e81a 459 (normal-top-level-add-to-load-path (cdr (nreverse dirs)))))
859e15c1 460
e87a7309 461(defun normal-top-level-add-to-load-path (dirs)
ad961a00
GM
462 "This function is called from a subdirs.el file.
463It assumes that `default-directory' is the directory in which the
464subdirs.el file exists, and it adds to `load-path' the subdirs of
465that directory as specified in DIRS. Normally the elements of
466DIRS are relative."
cd1c10f6
RS
467 (let ((tail load-path)
468 (thisdir (directory-file-name default-directory)))
469 (while (and tail
138e541f
GM
470 ;;Don't go all the way to the nil terminator.
471 (cdr tail)
cd1c10f6
RS
472 (not (equal thisdir (car tail)))
473 (not (and (memq system-type '(ms-dos windows-nt))
474 (equal (downcase thisdir) (downcase (car tail))))))
475 (setq tail (cdr tail)))
138e541f
GM
476 ;;Splice the new section in.
477 (when tail
478 (setcdr tail (append (mapcar 'expand-file-name dirs) (cdr tail))))))
e87a7309 479
a726e0d1 480(defun normal-top-level ()
33da7b16
GM
481 "Emacs calls this function when it first starts up.
482It sets `command-line-processed', processes the command-line,
483reads the initialization files, etc.
484It is the default value of the variable `top-level'."
a726e0d1
JB
485 (if command-line-processed
486 (message "Back to top level.")
487 (setq command-line-processed t)
8d4c2221 488 (let ((dir default-directory))
fcaf7de9 489 (with-current-buffer "*Messages*"
a1562258
SM
490 ;; Make it easy to do like "tail -f".
491 (set (make-local-variable 'window-point-insertion-type) t)
492 ;; Give *Messages* the same default-directory as *scratch*,
493 ;; just to keep things predictable.
8d4c2221 494 (setq default-directory dir)))
9715399e
MR
495 ;; `user-full-name' is now known; reset its standard-value here.
496 (put 'user-full-name 'standard-value
497 (list (default-value 'user-full-name)))
e87a7309
RS
498 ;; Look in each dir in load-path for a subdirs.el file.
499 ;; If we find one, load it, which will add the appropriate subdirs
500 ;; of that dir into load-path,
357438eb
KH
501 ;; Look for a leim-list.el file too. Loading it will register
502 ;; available input methods.
e5fcdb5e
GM
503 (let ((tail load-path)
504 (lispdir (expand-file-name "../lisp" data-directory))
505 ;; For out-of-tree builds, leim-list is generated in the build dir.
506;;; (leimdir (expand-file-name "../leim" doc-directory))
507 dir)
b6666b5f
SM
508 (while tail
509 (setq dir (car tail))
510 (let ((default-directory dir))
511 (load (expand-file-name "subdirs.el") t t t))
e5fcdb5e
GM
512 ;; Do not scan standard directories that won't contain a leim-list.el.
513 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-10/msg00502.html
514 (or (string-match (concat "\\`" lispdir) dir)
515 (let ((default-directory dir))
516 (load (expand-file-name "leim-list.el") t t t)))
b6666b5f
SM
517 ;; We don't use a dolist loop and we put this "setq-cdr" command at
518 ;; the end, because the subdirs.el files may add elements to the end
519 ;; of load-path and we want to take it into account.
520 (setq tail (cdr tail))))
7c2fb837
DN
521 ;; If the PWD environment variable isn't accurate, delete it.
522 (let ((pwd (getenv "PWD")))
523 (and (stringp pwd)
524 ;; Use FOO/., so that if FOO is a symlink, file-attributes
525 ;; describes the directory linked to, not FOO itself.
526 (or (equal (file-attributes
527 (concat (file-name-as-directory pwd) "."))
528 (file-attributes
529 (concat (file-name-as-directory default-directory)
530 ".")))
531 (setq process-environment
532 (delete (concat "PWD=" pwd)
533 process-environment)))))
492878e4 534 (setq default-directory (abbreviate-file-name default-directory))
50d4ba39 535 (let ((old-face-font-rescale-alist face-font-rescale-alist))
6f2c86fa
KH
536 (unwind-protect
537 (command-line)
538 ;; Do this again, in case .emacs defined more abbreviations.
539 (setq default-directory (abbreviate-file-name default-directory))
b3c7c12c
RS
540 ;; Specify the file for recording all the auto save files of this session.
541 ;; This is used by recover-session.
cdee38c3
KH
542 (or auto-save-list-file-name
543 (and auto-save-list-file-prefix
544 (setq auto-save-list-file-name
1f7f78f1
RS
545 ;; Under MS-DOS our PID is almost always reused between
546 ;; Emacs invocations. We need something more unique.
4b33deaa
EZ
547 (cond ((eq system-type 'ms-dos)
548 ;; We are going to access the auto-save
549 ;; directory, so make sure it exists.
550 (make-directory
551 (file-name-directory auto-save-list-file-prefix)
552 t)
f1180544 553 (concat
4b33deaa
EZ
554 (make-temp-name
555 (expand-file-name
556 auto-save-list-file-prefix))
557 "~"))
558 (t
559 (expand-file-name
560 (format "%s%d-%s~"
561 auto-save-list-file-prefix
562 (emacs-pid)
563 (system-name))))))))
deebb0e9
RS
564 (unless inhibit-startup-hooks
565 (run-hooks 'emacs-startup-hook)
566 (and term-setup-hook
567 (run-hooks 'term-setup-hook)))
6a1e7d67
GM
568
569 ;; Don't do this if we failed to create the initial frame,
570 ;; for instance due to a dense colormap.
538ef02a
GM
571 (when (or frame-initial-frame
572 ;; If frame-initial-frame has no meaning, do this anyway.
2246281f 573 (not (and initial-window-system
538ef02a 574 (not noninteractive)
2246281f 575 (not (eq initial-window-system 'pc)))))
4a0c0061
CY
576
577 ;; FIXME: The user's init file may change
578 ;; face-font-rescale-alist. However, the default face
579 ;; already has an assigned font object, which does not take
580 ;; face-font-rescale-alist into account. For such
581 ;; situations, we ought to have a way to find all font
582 ;; objects and regenerate them; currently we do not. As a
583 ;; workaround, we specifically reset te default face's :font
584 ;; attribute here. See bug#1785.
585 (unless (eq face-font-rescale-alist
586 old-face-font-rescale-alist)
587 (set-face-attribute 'default nil :font (font-spec)))
588
6a1e7d67
GM
589 ;; Modify the initial frame based on what .emacs puts into
590 ;; ...-frame-alist.
591 (if (fboundp 'frame-notice-user-settings)
592 (frame-notice-user-settings))
2666355c
KL
593 ;; Set the faces for the initial background mode even if
594 ;; frame-notice-user-settings didn't (such as on a tty).
595 ;; frame-set-background-mode is idempotent, so it won't
596 ;; cause any harm if it's already been done.
6a1e7d67 597 (if (fboundp 'frame-set-background-mode)
2666355c 598 (frame-set-background-mode (selected-frame))))
13ab33c4 599
6f2c86fa
KH
600 ;; Now we know the user's default font, so add it to the menu.
601 (if (fboundp 'font-menu-add-default)
602 (font-menu-add-default))
603 (and window-setup-hook
50d4ba39 604 (run-hooks 'window-setup-hook))))
fdb88463
SM
605 ;; Subprocesses of Emacs do not have direct access to the terminal, so
606 ;; unless told otherwise they should only assume a dumb terminal.
607 ;; We are careful to do it late (after term-setup-hook), although the
608 ;; new multi-tty code does not use $TERM any more there anyway.
4bbfda32
SM
609 (setenv "TERM" "dumb")
610 ;; Remove DISPLAY from the process-environment as well. This allows
611 ;; `callproc.c' to give it a useful adaptive default which is either
612 ;; the value of the `display' frame-parameter or the DISPLAY value
613 ;; from initial-environment.
614 (let ((display (frame-parameter nil 'display)))
615 ;; Be careful which DISPLAY to remove from process-environment: follow
616 ;; the logic of `callproc.c'.
617 (if (stringp display) (setq display (concat "DISPLAY=" display))
618 (dolist (varval initial-environment)
619 (if (string-match "\\`DISPLAY=" varval)
620 (setq display varval))))
621 (when display
4bbfda32 622 (delete display process-environment)))))
6f2c86fa
KH
623
624;; Precompute the keyboard equivalents in the menu bar items.
c381f482
EZ
625;; Command-line options supported by tty's:
626(defconst tty-long-option-alist
8957d2bf
EZ
627 '(("--name" . "-name")
628 ("--title" . "-T")
629 ("--reverse-video" . "-reverse")
c381f482 630 ("--foreground-color" . "-fg")
8957d2bf
EZ
631 ("--background-color" . "-bg")
632 ("--color" . "-color")))
c381f482 633
b66b6aeb 634(defconst tool-bar-images-pixel-height 24
eeaa563e 635 "Height in pixels of images in the tool-bar.")
b66b6aeb 636
3a55d3d0
JR
637(defvar tool-bar-originally-present nil
638 "Non-nil if tool-bars are present before user and site init files are read.")
639
e9cda827
KL
640(defvar handle-args-function-alist '((nil . tty-handle-args))
641 "Functions for processing window-system dependent command-line arguments.
642Window system startup files should add their own function to this
643alist, which should parse the command line arguments. Those
644pertaining to the window system should be processed and removed
645from the returned command line.")
646
647(defvar window-system-initialization-alist '((nil . ignore))
648 "Alist of window-system initialization functions.
649Window-system startup files should add their own initialization
650function to this list. The function should take no arguments,
651and initialize the window system environment to prepare for
2bb819d5 652opening the first frame (e.g. open a connection to an X server).")
e9cda827 653
c381f482 654(defun tty-handle-args (args)
ad961a00 655 "Handle the X-like command-line arguments \"-fg\", \"-bg\", \"-name\", etc."
bca8c7be 656 (let (rest)
ae8bf5ab 657 (message "%S" args)
c381f482
EZ
658 (while (and args
659 (not (equal (car args) "--")))
bca8c7be
MS
660 (let* ((argi (pop args))
661 (orig-argi argi)
662 argval completion)
c381f482
EZ
663 ;; Check for long options with attached arguments
664 ;; and separate out the attached option argument into argval.
bca8c7be
MS
665 (when (string-match "^\\(--[^=]*\\)=" argi)
666 (setq argval (substring argi (match-end 0))
667 argi (match-string 1 argi)))
668 (when (string-match "^--" argi)
669 (setq completion (try-completion argi tty-long-option-alist))
c381f482
EZ
670 (if (eq completion t)
671 ;; Exact match for long option.
bca8c7be 672 (setq argi (cdr (assoc argi tty-long-option-alist)))
c381f482
EZ
673 (if (stringp completion)
674 (let ((elt (assoc completion tty-long-option-alist)))
675 ;; Check for abbreviated long option.
676 (or elt
bca8c7be
MS
677 (error "Option `%s' is ambiguous" argi))
678 (setq argi (cdr elt)))
c381f482 679 ;; Check for a short option.
bca8c7be
MS
680 (setq argval nil
681 argi orig-argi))))
682 (cond ((member argi '("-fg" "-foreground"))
683 (push (cons 'foreground-color (or argval (pop args)))
684 default-frame-alist))
685 ((member argi '("-bg" "-background"))
686 (push (cons 'background-color (or argval (pop args)))
687 default-frame-alist))
688 ((member argi '("-T" "-name"))
689 (unless argval (setq argval (pop args)))
690 (push (cons 'title
691 (if (stringp argval)
692 argval
693 (let ((case-fold-search t)
694 i)
695 (setq argval (invocation-name))
696
697 ;; Change any . or * characters in name to
698 ;; hyphens, so as to emulate behavior on X.
699 (while
700 (setq i (string-match "[.*]" argval))
701 (aset argval i ?-))
702 argval)))
703 default-frame-alist))
704 ((member argi '("-r" "-rv" "-reverse"))
705 (push '(reverse . t)
706 default-frame-alist))
707 ((equal argi "-color")
708 (unless argval (setq argval 8)) ; default --color means 8 ANSI colors
709 (push (cons 'tty-color-mode
710 (cond
711 ((numberp argval) argval)
712 ((string-match "-?[0-9]+" argval)
713 (string-to-number argval))
714 (t (intern argval))))
715 default-frame-alist))
716 (t
717 (push argi rest)))))
718 (nreverse rest)))
c381f482 719
aa360da1
GM
720(declare-function x-get-resource "frame.c"
721 (attribute class &optional component subclass))
722(declare-function tool-bar-mode "tool-bar" (&optional arg))
d2b2930a 723(declare-function tool-bar-setup "tool-bar")
aa360da1 724
4ff029f6 725(defvar server-name)
35f372ca 726(defvar server-process)
4ff029f6 727
a726e0d1 728(defun command-line ()
33da7b16
GM
729 "A subroutine of `normal-top-level'.
730Amongst another things, it parses the command-line arguments."
5c9fad41 731 (setq before-init-time (current-time)
981c5d1d 732 after-init-time nil
238cbdf8 733 command-line-default-directory default-directory)
09a1077c 734
2aa0e5bf
SM
735 ;; Force recomputation, in case it was computed during the dump.
736 (setq abbreviated-home-dir nil)
849eedba 737
74f2ab06 738 ;; See if we should import version-control from the environment variable.
a726e0d1
JB
739 (let ((vc (getenv "VERSION_CONTROL")))
740 (cond ((eq vc nil)) ;don't do anything if not set
bca8c7be 741 ((member vc '("t" "numbered"))
a726e0d1 742 (setq version-control t))
bca8c7be 743 ((member vc '("nil" "existing"))
a726e0d1 744 (setq version-control nil))
bca8c7be 745 ((member vc '("never" "simple"))
a726e0d1
JB
746 (setq version-control 'never))))
747
79058860
JB
748 ;;! This has been commented out; I currently find the behavior when
749 ;;! split-window-keep-point is nil disturbing, but if I can get used
750 ;;! to it, then it would be better to eliminate the option.
751 ;;! ;; Choose a good default value for split-window-keep-point.
752 ;;! (setq split-window-keep-point (> baud-rate 2400))
f35fe3c6 753
d4308a4d
EZ
754 ;; Set the default strings to display in mode line for
755 ;; end-of-line formats that aren't native to this platform.
756 (cond
a3374680 757 ((memq system-type '(ms-dos windows-nt))
bca8c7be
MS
758 (setq eol-mnemonic-unix "(Unix)"
759 eol-mnemonic-mac "(Mac)"))
bca8c7be
MS
760 (t ; this is for Unix/GNU/Linux systems
761 (setq eol-mnemonic-dos "(DOS)"
762 eol-mnemonic-mac "(Mac)")))
d4308a4d 763
640a9cdd
JR
764 (set-locale-environment nil)
765
735895f1
EZ
766 ;; Convert preloaded file names in load-history to absolute.
767 (let ((simple-file-name
3b61abfe
EZ
768 ;; Look for simple.el or simple.elc and use their directory
769 ;; as the place where all Lisp files live.
735895f1
EZ
770 (locate-file "simple" load-path (get-load-suffixes)))
771 lisp-dir)
772 ;; Don't abort if simple.el cannot be found, but print a warning.
773 (if (null simple-file-name)
774 (progn
775 (princ "Warning: Could not find simple.el nor simple.elc"
776 'external-debugging-output)
777 (terpri 'external-debugging-output))
778 (setq lisp-dir (file-truename (file-name-directory simple-file-name)))
779 (setq load-history
780 (mapcar (lambda (elt)
781 (if (and (stringp (car elt))
782 (not (file-name-absolute-p (car elt))))
783 (cons (concat lisp-dir
784 (car elt))
785 (cdr elt))
786 elt))
787 load-history))))
4b816985 788
c16eb7b0
RS
789 ;; Convert the arguments to Emacs internal representation.
790 (let ((args (cdr command-line-args)))
791 (while args
792 (setcar args
793 (decode-coding-string (car args) locale-coding-system t))
bca8c7be 794 (pop args)))
c16eb7b0 795
03e3c30a 796 (let ((done nil)
4fe22cdf
CY
797 (args (cdr command-line-args))
798 display-arg)
03e3c30a 799
a726e0d1
JB
800 ;; Figure out which user's init file to load,
801 ;; either from the environment or from the options.
802 (setq init-file-user (if noninteractive nil (user-login-name)))
803 ;; If user has not done su, use current $HOME to find .emacs.
bca8c7be
MS
804 (and init-file-user
805 (equal init-file-user (user-real-login-name))
a726e0d1 806 (setq init-file-user ""))
03e3c30a
JB
807
808 ;; Process the command-line args, and delete the arguments
809 ;; processed. This is consistent with the way main in emacs.c
810 ;; does things.
a726e0d1 811 (while (and (not done) args)
9ab281f0
JB
812 (let* ((longopts '(("--no-init-file") ("--no-site-file") ("--debug-init")
813 ("--user") ("--iconic") ("--icon-type") ("--quick")
814 ("--no-blinking-cursor") ("--basic-display")))
bca8c7be
MS
815 (argi (pop args))
816 (orig-argi argi)
817 argval)
452e9090 818 ;; Handle --OPTION=VALUE format.
7b704afe 819 (when (string-match "\\`\\(--[^=]*\\)=" argi)
1b207153 820 (setq argval (substring argi (match-end 0))
bca8c7be 821 argi (match-string 1 argi)))
7b704afe 822 (when (string-match "\\`--." orig-argi)
1b207153 823 (let ((completion (try-completion argi longopts)))
198a7a97
CY
824 (cond ((eq completion t)
825 (setq argi (substring argi 1)))
826 ((stringp completion)
827 (let ((elt (assoc completion longopts)))
828 (unless elt
829 (error "Option `%s' is ambiguous" argi))
830 (setq argi (substring (car elt) 1))))
831 (t
832 (setq argval nil
833 argi orig-argi)))))
a726e0d1 834 (cond
4fe22cdf
CY
835 ;; The --display arg is handled partly in C, partly in Lisp.
836 ;; When it shows up here, we just put it back to be handled
837 ;; by `command-line-1'.
838 ((member argi '("-d" "-display"))
839 (setq display-arg (list argi (pop args))))
dc58296d 840 ((member argi '("-Q" "-quick"))
6b61353c
KH
841 (setq init-file-user nil
842 site-run-file nil
8686ac71 843 inhibit-x-resources t))
dc58296d
RS
844 ((member argi '("-D" "-basic-display"))
845 (setq no-blinking-cursor t
846 emacs-basic-display t)
6b61353c 847 (push '(vertical-scroll-bars . nil) initial-frame-alist))
4e0a3971
SM
848 ((member argi '("-q" "-no-init-file"))
849 (setq init-file-user nil))
850 ((member argi '("-u" "-user"))
bca8c7be 851 (setq init-file-user (or argval (pop args))
4e0a3971 852 argval nil))
bca8c7be 853 ((equal argi "-no-site-file")
4e0a3971 854 (setq site-run-file nil))
bca8c7be 855 ((equal argi "-debug-init")
4e0a3971 856 (setq init-file-debug t))
bca8c7be 857 ((equal argi "-iconic")
4e0a3971 858 (push '(visibility . icon) initial-frame-alist))
178b4542
JL
859 ((member argi '("-nbc" "-no-blinking-cursor"))
860 (setq no-blinking-cursor t))
4e0a3971 861 ;; Push the popped arg back on the list of arguments.
bca8c7be
MS
862 (t
863 (push argi args)
864 (setq done t)))
096b7031
KH
865 ;; Was argval set but not used?
866 (and argval
867 (error "Option `%s' doesn't allow an argument" argi))))
868
4fe22cdf
CY
869 ;; Re-attach the --display arg.
870 (and display-arg (setq args (append display-arg args)))
871
03e3c30a 872 ;; Re-attach the program name to the front of the arg list.
bca8c7be
MS
873 (and command-line-args
874 (setcdr command-line-args args)))
a726e0d1 875
d2fd733e
SM
876 ;; Make sure window system's init file was loaded in loadup.el if
877 ;; using a window system.
878 ;; Initialize the window-system only after processing the command-line
879 ;; args so that -Q can influence this initialization.
880 (condition-case error
881 (unless noninteractive
882 (if (and initial-window-system
883 (not (featurep
884 (intern
885 (concat (symbol-name initial-window-system) "-win")))))
886 (error "Unsupported window system `%s'" initial-window-system))
887 ;; Process window-system specific command line parameters.
888 (setq command-line-args
889 (funcall
890 (or (cdr (assq initial-window-system handle-args-function-alist))
891 (error "Unsupported window system `%s'" initial-window-system))
892 command-line-args))
893 ;; Initialize the window system. (Open connection, etc.)
894 (funcall
895 (or (cdr (assq initial-window-system window-system-initialization-alist))
efc3dd3c
DC
896 (error "Unsupported window system `%s'" initial-window-system)))
897 (put initial-window-system 'window-system-initialized t))
d2fd733e
SM
898 ;; If there was an error, print the error message and exit.
899 (error
900 (princ
901 (if (eq (car error) 'error)
902 (apply 'concat (cdr error))
903 (if (memq 'file-error (get (car error) 'error-conditions))
904 (format "%s: %s"
905 (nth 1 error)
906 (mapconcat (lambda (obj) (prin1-to-string obj t))
907 (cdr (cdr error)) ", "))
908 (format "%s: %s"
909 (get (car error) 'error-message)
910 (mapconcat (lambda (obj) (prin1-to-string obj t))
911 (cdr error) ", "))))
912 'external-debugging-output)
913 (terpri 'external-debugging-output)
914 (setq initial-window-system nil)
915 (kill-emacs)))
916
ce98f555
RS
917 (run-hooks 'before-init-hook)
918
15cd8efd 919 ;; Under X, create the X frame and delete the terminal frame.
7581ba40 920 (unless (daemonp)
15cd8efd
CY
921 (if (or noninteractive emacs-basic-display)
922 (setq menu-bar-mode nil
923 tool-bar-mode nil
924 no-blinking-cursor t))
9ba6e7d4 925 (frame-initialize))
14f16b9c 926
55702e89
AS
927 (when (fboundp 'x-create-frame)
928 ;; Set up the tool-bar (even in tty frames, since Emacs might open a
929 ;; graphical frame later).
930 (unless noninteractive
931 (tool-bar-setup)))
6431f2e6 932
ed0fb1f1 933 ;; Turn off blinking cursor if so specified in X resources. This is here
b08cb5a6 934 ;; only because all other settings of no-blinking-cursor are here.
ed0fb1f1
JD
935 (unless (or noninteractive
936 emacs-basic-display
9e2a2647 937 (and (memq window-system '(x w32 ns))
ed0fb1f1 938 (not (member (x-get-resource "cursorBlink" "CursorBlink")
04877ddb 939 '("no" "off" "false" "0")))))
ed0fb1f1
JD
940 (setq no-blinking-cursor t))
941
790d0270
SM
942 ;; Re-evaluate predefined variables whose initial value depends on
943 ;; the runtime context.
944 (mapc 'custom-reevaluate-setting
945 ;; Initialize them in the same order they were loaded, in case there
946 ;; are dependencies between them.
947 (prog1 (nreverse custom-delayed-init-variables)
948 (setq custom-delayed-init-variables nil)))
3b73087e 949
30a2fded
KL
950 (normal-erase-is-backspace-setup-frame)
951
1592c1ef 952 ;; Register default TTY colors for the case the terminal hasn't a
40ba43b4 953 ;; terminal init file. We do this regardless of whether the terminal
79c3172f
KL
954 ;; supports colors or not and regardless the current display type,
955 ;; since users can connect to color-capable terminals and also
956 ;; switch color support on or off in mid-session by setting the
957 ;; tty-color-mode frame parameter.
a5b5acaf
EZ
958 ;; Exception: the `pc' ``window system'' has only 16 fixed colors,
959 ;; and they are already set at this point by a suitable function in
960 ;; window-system-initialization-alist.
961 (or (eq initial-window-system 'pc)
962 (tty-register-default-colors))
1592c1ef 963
3a55d3d0
JR
964 ;; Record whether the tool-bar is present before the user and site
965 ;; init files are processed. frame-notice-user-settings uses this
966 ;; to determine if the tool-bar has been disabled by the init files,
967 ;; and the frame needs to be resized.
968 (when (fboundp 'frame-notice-user-settings)
969 (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
970 (assq 'tool-bar-lines default-frame-alist))))
971 (setq tool-bar-originally-present
bca8c7be
MS
972 (and tool-bar-lines
973 (cdr tool-bar-lines)
974 (not (eq 0 (cdr tool-bar-lines)))))))
3a55d3d0 975
752ef254 976 (let ((old-scalable-fonts-allowed scalable-fonts-allowed)
752ef254
GM
977 (old-face-ignored-fonts face-ignored-fonts))
978
752ef254
GM
979 ;; Run the site-start library if it exists. The point of this file is
980 ;; that it is run before .emacs. There is no point in doing this after
981 ;; .emacs; that is useless.
5f144784
GM
982 ;; Note that user-init-file is nil at this point. Code that might
983 ;; be loaded from site-run-file and wants to test if -q was given
984 ;; should check init-file-user instead, since that is already set.
985 ;; See cus-edit.el for an example.
f1180544 986 (if site-run-file
752ef254
GM
987 (load site-run-file t t))
988
989 ;; Sites should not disable this. Only individuals should disable
1cff9ad1
JL
990 ;; the startup screen.
991 (setq inhibit-startup-screen nil)
752ef254 992
f963ea40 993 ;; Warn for invalid user name.
ce98f555
RS
994 (when init-file-user
995 (if (string-match "[~/:\n]" init-file-user)
996 (display-warning 'initialization
997 (format "Invalid user name %s"
998 init-file-user)
999 :error)
1df1e49e 1000 (if (file-directory-p (expand-file-name
5463218c
EZ
1001 ;; We don't support ~USER on MS-Windows
1002 ;; and MS-DOS except for the current
1003 ;; user, and always load .emacs from
1004 ;; the current user's home directory
1005 ;; (see below). So always check "~",
1006 ;; even if invoked with "-u USER", or
1007 ;; if $USER or $LOGNAME are set to
1008 ;; something different.
1009 (if (memq system-type '(windows-nt ms-dos))
1df1e49e
EZ
1010 "~"
1011 (concat "~" init-file-user))))
ce98f555
RS
1012 nil
1013 (display-warning 'initialization
1014 (format "User %s has no home directory"
ec1b09b1
EZ
1015 (if (equal init-file-user "")
1016 (user-real-login-name)
1017 init-file-user))
ce98f555 1018 :error))))
f963ea40 1019
752ef254
GM
1020 ;; Load that user's init file, or the default one, or none.
1021 (let (debug-on-error-from-init-file
1022 debug-on-error-should-be-set
1023 (debug-on-error-initial
1024 (if (eq init-file-debug t) 'startup init-file-debug))
597e2240 1025 (orig-enable-multibyte (default-value 'enable-multibyte-characters)))
752ef254
GM
1026 (let ((debug-on-error debug-on-error-initial)
1027 ;; This function actually reads the init files.
1028 (inner
1029 (function
1030 (lambda ()
1031 (if init-file-user
1032 (let ((user-init-file-1
4e0a3971 1033 (cond
8a05b668
JB
1034 ((eq system-type 'ms-dos)
1035 (concat "~" init-file-user "/_emacs"))
1036 ((not (eq system-type 'windows-nt))
1037 (concat "~" init-file-user "/.emacs"))
1038 ;; Else deal with the Windows situation
1039 ((directory-files "~" nil "^\\.emacs\\(\\.elc?\\)?$")
1040 ;; Prefer .emacs on Windows.
1041 "~/.emacs")
1042 ((directory-files "~" nil "^_emacs\\(\\.elc?\\)?$")
1043 ;; Also support _emacs for compatibility, but warn about it.
50f84510
JB
1044 (push '(initialization
1045 "`_emacs' init file is deprecated, please use `.emacs'")
1046 delayed-warnings-list)
8a05b668
JB
1047 "~/_emacs")
1048 (t ;; But default to .emacs if _emacs does not exist.
1049 "~/.emacs"))))
752ef254
GM
1050 ;; This tells `load' to store the file name found
1051 ;; into user-init-file.
1052 (setq user-init-file t)
1053 (load user-init-file-1 t t)
f1180544 1054
a04d5983
RS
1055 (when (eq user-init-file t)
1056 ;; If we did not find ~/.emacs, try
c3ab3701 1057 ;; ~/.emacs.d/init.el.
a04d5983
RS
1058 (let ((otherfile
1059 (expand-file-name
c3ab3701 1060 "init"
a04d5983 1061 (file-name-as-directory
c3ab3701 1062 (concat "~" init-file-user "/.emacs.d")))))
a04d5983
RS
1063 (load otherfile t t)
1064
1065 ;; If we did not find the user's init file,
1066 ;; set user-init-file conclusively.
1067 ;; Don't let it be set from default.el.
1068 (when (eq user-init-file t)
1069 (setq user-init-file user-init-file-1))))
f1180544 1070
752ef254
GM
1071 ;; If we loaded a compiled file, set
1072 ;; `user-init-file' to the source version if that
1073 ;; exists.
1074 (when (and user-init-file
1075 (equal (file-name-extension user-init-file)
1076 "elc"))
1077 (let* ((source (file-name-sans-extension user-init-file))
1078 (alt (concat source ".el")))
1079 (setq source (cond ((file-exists-p alt) alt)
1080 ((file-exists-p source) source)
1081 (t nil)))
1082 (when source
1083 (when (file-newer-than-file-p source user-init-file)
1084 (message "Warning: %s is newer than %s"
1085 source user-init-file)
1086 (sit-for 1))
1087 (setq user-init-file source))))
f1180544 1088
bca8c7be 1089 (unless inhibit-default-init
1cff9ad1 1090 (let ((inhibit-startup-screen nil))
bca8c7be
MS
1091 ;; Users are supposed to be told their rights.
1092 ;; (Plus how to get help and how to undo.)
1093 ;; Don't you dare turn this off for anyone
1094 ;; except yourself.
1095 (load "default" t t)))))))))
752ef254
GM
1096 (if init-file-debug
1097 ;; Do this without a condition-case if the user wants to debug.
1098 (funcall inner)
1099 (condition-case error
1100 (progn
1101 (funcall inner)
1102 (setq init-file-had-error nil))
1103 (error
f2602864
CY
1104 (display-warning
1105 'initialization
1106 (format "An error occurred while loading `%s':\n\n%s%s%s\n\n\
1107To ensure normal operation, you should investigate and remove the
1108cause of the error in your initialization file. Start Emacs with
1109the `--debug-init' option to view a complete error backtrace."
1110 user-init-file
1111 (get (car error) 'error-message)
1112 (if (cdr error) ": " "")
9dba2c64
SM
1113 (mapconcat (lambda (s) (prin1-to-string s t))
1114 (cdr error) ", "))
f2602864
CY
1115 :warning)
1116 (setq init-file-had-error t))))
1117
1118 (if (and deactivate-mark transient-mark-mode)
9c8b2150
RS
1119 (with-current-buffer (window-buffer)
1120 (deactivate-mark)))
1121
d5bd2558
GM
1122 ;; If the user has a file of abbrevs, read it (unless -batch).
1123 (when (and (not noninteractive)
1124 (file-exists-p abbrev-file-name)
2863a9be 1125 (file-readable-p abbrev-file-name))
ac3186fd
RS
1126 (quietly-read-abbrev-file abbrev-file-name))
1127
70b199c3
RS
1128 ;; If the abbrevs came entirely from the init file or the
1129 ;; abbrevs file, they do not need saving.
1130 (setq abbrevs-changed nil)
1131
752ef254
GM
1132 ;; If we can tell that the init file altered debug-on-error,
1133 ;; arrange to preserve the value that it set up.
1134 (or (eq debug-on-error debug-on-error-initial)
1135 (setq debug-on-error-should-be-set t
1136 debug-on-error-from-init-file debug-on-error)))
1137 (if debug-on-error-should-be-set
1138 (setq debug-on-error debug-on-error-from-init-file))
597e2240
GM
1139 (unless (or (default-value 'enable-multibyte-characters)
1140 (eq orig-enable-multibyte (default-value
1141 'enable-multibyte-characters)))
752ef254 1142 ;; Init file changed to unibyte. Reset existing multibyte
09e80d9f 1143 ;; buffers (probably *scratch*, *Messages*, *Minibuf-0*).
752ef254
GM
1144 ;; Arguably this should only be done if they're free of
1145 ;; multibyte characters.
e18c18e8
JB
1146 (mapc (lambda (buffer)
1147 (with-current-buffer buffer
1148 (if enable-multibyte-characters
1149 (set-buffer-multibyte nil))))
1150 (buffer-list))
752ef254
GM
1151 ;; Also re-set the language environment in case it was
1152 ;; originally done before unibyte was set and is sensitive to
1153 ;; unibyte (display table, terminal coding system &c).
1154 (set-language-environment current-language-environment)))
f1180544 1155
752ef254 1156 ;; Do this here in case the init file sets mail-host-address.
5b88a2c5 1157 (if (equal user-mail-address "")
cee0c996
EZ
1158 (setq user-mail-address (or (getenv "EMAIL")
1159 (concat (user-login-name) "@"
1160 (or mail-host-address
1161 (system-name))))))
752ef254
GM
1162
1163 ;; If parameter have been changed in the init file which influence
1164 ;; face realization, clear the face cache so that new faces will
1165 ;; be realized.
1166 (unless (and (eq scalable-fonts-allowed old-scalable-fonts-allowed)
752ef254
GM
1167 (eq face-ignored-fonts old-face-ignored-fonts))
1168 (clear-face-cache)))
f1180544 1169
8a500a91
CY
1170 ;; If any package directory exists, initialize the package system.
1171 (and user-init-file
1172 package-enable-at-startup
1173 (catch 'package-dir-found
1174 (let (dirs)
1175 (if (boundp 'package-directory-list)
1176 (setq dirs package-directory-list)
1177 (dolist (f load-path)
1178 (and (stringp f)
1179 (equal (file-name-nondirectory f) "site-lisp")
1180 (push (expand-file-name "elpa" f) dirs))))
1181 (push (if (boundp 'package-user-dir)
1182 package-user-dir
1183 (locate-user-emacs-file "elpa"))
1184 dirs)
1185 (dolist (dir dirs)
1186 (when (file-directory-p dir)
1187 (dolist (subdir (directory-files dir))
1188 (when (and (file-directory-p (expand-file-name subdir dir))
4525ce3e
CY
1189 (string-match
1190 (concat "\\`" package-subdirectory-regexp "\\'")
1191 subdir))
8a500a91
CY
1192 (throw 'package-dir-found t)))))))
1193 (package-initialize))
44198b6e 1194
5ab0e67e 1195 (setq after-init-time (current-time))
e3bd99f5
RM
1196 (run-hooks 'after-init-hook)
1197
1fc67c11 1198 ;; Decode all default-directory.
597e2240 1199 (if (and (default-value 'enable-multibyte-characters) locale-coding-system)
cea927ed
KH
1200 (save-excursion
1201 (dolist (elt (buffer-list))
1202 (set-buffer elt)
1203 (if default-directory
1204 (setq default-directory
1205 (decode-coding-string default-directory
1206 locale-coding-system t))))
1207 (setq command-line-default-directory
1208 (decode-coding-string command-line-default-directory
1209 locale-coding-system t))))
1210
a726e0d1
JB
1211 ;; If *scratch* exists and init file didn't change its mode, initialize it.
1212 (if (get-buffer "*scratch*")
694210c4 1213 (with-current-buffer "*scratch*"
a726e0d1 1214 (if (eq major-mode 'fundamental-mode)
26cdce23 1215 (funcall initial-major-mode))))
f1180544 1216
a726e0d1
JB
1217 ;; Load library for our terminal type.
1218 ;; User init file can set term-file-prefix to nil to prevent this.
bca8c7be 1219 (unless (or noninteractive
cd85984a
KL
1220 initial-window-system)
1221 (tty-run-terminal-initialization (selected-frame)))
a726e0d1 1222
5777a167
RS
1223 ;; Update the out-of-memory error message based on user's key bindings
1224 ;; for save-some-buffers.
1225 (setq memory-signal-data
1226 (list 'error
1227 (substitute-command-keys "Memory exhausted--use \\[save-some-buffers] then exit and restart Emacs")))
1228
03e3c30a 1229 ;; Process the remaining args.
a726e0d1
JB
1230 (command-line-1 (cdr command-line-args))
1231
1232 ;; If -batch, terminate after processing the command options.
ca57f55d
JD
1233 (if noninteractive (kill-emacs t))
1234
7581ba40
RF
1235 ;; In daemon mode, start the server to allow clients to connect.
1236 ;; This is done after loading the user's init file and after
1237 ;; processing all command line arguments to allow e.g. `server-name'
1238 ;; to be changed before the server starts.
4ff029f6
DN
1239 (let ((dn (daemonp)))
1240 (when dn
1241 (when (stringp dn) (setq server-name dn))
1242 (server-start)
35f372ca
JB
1243 (if server-process
1244 (daemon-initialized)
fd95644b
DN
1245 (if (stringp dn)
1246 (message
1247 "Unable to start daemon: Emacs server named %S already running"
1248 server-name)
1249 (message "Unable to start the daemon.\nAnother instance of Emacs is running the server, either as daemon or interactively.\nYou can use emacsclient to connect to that Emacs process."))
35f372ca 1250 (kill-emacs 1))))
7581ba40 1251
ca57f55d
JD
1252 ;; Run emacs-session-restore (session management) if started by
1253 ;; the session manager and we have a session manager connection.
bca8c7be
MS
1254 (if (and (boundp 'x-session-previous-id)
1255 (stringp x-session-previous-id))
a99df87d
RS
1256 (with-no-warnings
1257 (emacs-session-restore x-session-previous-id))))
a726e0d1 1258
15cd8efd
CY
1259(defun x-apply-session-resources ()
1260 "Apply X resources which specify initial values for Emacs variables.
1261This is called from a window-system initialization function, such
1262as `x-initialize-window-system' for X, either at startup (prior
1263to reading the init file), or afterwards when the user first
1264opens a graphical frame.
1265
1266This can set the values of `menu-bar-mode', `tool-bar-mode', and
1267`no-blinking-cursor', as well as the `cursor' face. Changed
1268settings will be marked as \"CHANGED outside of Customize\"."
1269 (let ((no-vals '("no" "off" "false" "0"))
1270 (settings '(("menuBar" "MenuBar" menu-bar-mode nil)
1271 ("toolBar" "ToolBar" tool-bar-mode nil)
1272 ("cursorBlink" "CursorBlink" no-blinking-cursor t))))
1273 (dolist (x settings)
1274 (if (member (x-get-resource (nth 0 x) (nth 1 x)) no-vals)
1275 (set (nth 2 x) (nth 3 x)))))
1276 (let ((color (x-get-resource "cursorColor" "Foreground")))
1277 (when color
1278 (put 'cursor 'theme-face
1279 `((changed ((t :background ,color)))))
1280 (put 'cursor 'face-modified t))))
1281
46cfd295 1282(defcustom initial-scratch-message (purecopy "\
3b79c219
GM
1283;; This buffer is for notes you don't want to save, and for Lisp evaluation.
1284;; If you want to create a file, visit that file with C-x C-f,
1285;; then enter the text in that file's own buffer.
9fe3219e 1286
46cfd295 1287")
9fe3219e 1288 "Initial message displayed in *scratch* buffer at startup.
9bc6f805 1289If this is nil, no message will be displayed."
fa071a47
RS
1290 :type '(choice (text :tag "Message")
1291 (const :tag "none" nil))
1292 :group 'initialization)
9fe3219e 1293
ce9ded5d
GM
1294\f
1295;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1296;;; Fancy splash screen
1297;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1298
a7610c52 1299(defconst fancy-startup-text
fa7c3228 1300 `((:face (variable-pitch font-lock-comment-face)
22a58255 1301 "Welcome to "
6e0cfad3 1302 :link ("GNU Emacs"
9dba2c64 1303 ,(lambda (_button) (browse-url "http://www.gnu.org/software/emacs/"))
6e0cfad3 1304 "Browse http://www.gnu.org/software/emacs/")
22a58255
CY
1305 ", one component of the "
1306 :link
9dba2c64 1307 ,(lambda ()
22a58255 1308 (if (eq system-type 'gnu/linux)
9dba2c64
SM
1309 `("GNU/Linux"
1310 ,(lambda (_button) (browse-url "http://www.gnu.org/gnu/linux-and-gnu.html"))
6e0cfad3 1311 "Browse http://www.gnu.org/gnu/linux-and-gnu.html")
9dba2c64 1312 `("GNU" ,(lambda (_button) (describe-gnu-project))
6e0cfad3 1313 "Display info on the GNU project")))
bb398779 1314 " operating system.\n\n"
ca267291 1315 :face variable-pitch
9dba2c64 1316 :link ("Emacs Tutorial" ,(lambda (_button) (help-with-tutorial)))
22a58255 1317 "\tLearn basic keystroke commands"
9dba2c64 1318 ,(lambda ()
fad930b6
RS
1319 (let* ((en "TUTORIAL")
1320 (tut (or (get-language-info current-language-environment
1321 'tutorial)
1322 en))
1323 (title (with-temp-buffer
1324 (insert-file-contents
1325 (expand-file-name tut tutorial-directory)
87ab808f
EZ
1326 ;; We used to read only the first 256 bytes of
1327 ;; the tutorial, but that prevents the coding:
1328 ;; setting, if any, in file-local variables
1329 ;; section to be seen by insert-file-contents,
1330 ;; and results in gibberish when the language
1331 ;; environment's preferred encoding is
1332 ;; different from what the file-local variable
1333 ;; says. One case in point is Hebrew.
1334 nil)
fad930b6
RS
1335 (search-forward ".")
1336 (buffer-substring (point-min) (1- (point))))))
1337 ;; If there is a specific tutorial for the current language
1338 ;; environment and it is not English, append its title.
1339 (if (string= en tut)
1340 ""
1341 (concat " (" title ")"))))
1342 "\n"
fad930b6 1343 :link ("Emacs Guided Tour"
9dba2c64
SM
1344 ,(lambda (_button)
1345 (browse-url "http://www.gnu.org/software/emacs/tour/"))
6e0cfad3 1346 "Browse http://www.gnu.org/software/emacs/tour/")
bb398779 1347 "\tOverview of Emacs features at gnu.org\n"
9dba2c64 1348 :link ("View Emacs Manual" ,(lambda (_button) (info-emacs-manual)))
490a1ad6 1349 "\tView the Emacs manual using Info\n"
9dba2c64 1350 :link ("Absence of Warranty" ,(lambda (_button) (describe-no-warranty)))
fad930b6 1351 "\tGNU Emacs comes with "
422abbfd 1352 :face (variable-pitch (:slant oblique))
fad930b6
RS
1353 "ABSOLUTELY NO WARRANTY\n"
1354 :face variable-pitch
9dba2c64 1355 :link ("Copying Conditions" ,(lambda (_button) (describe-copying)))
fad930b6 1356 "\tConditions for redistributing and changing Emacs\n"
9dba2c64 1357 :link ("Ordering Manuals" ,(lambda (_button) (view-order-manuals)))
22a58255 1358 "\tPurchasing printed copies of manuals\n"
fad930b6 1359 "\n"))
ce9ded5d
GM
1360 "A list of texts to show in the middle part of splash screens.
1361Each element in the list should be a list of strings or pairs
1362`:face FACE', like `fancy-splash-insert' accepts them.")
1363
a7610c52 1364(defconst fancy-about-text
91064207 1365 `((:face (variable-pitch font-lock-comment-face)
22a58255 1366 "This is "
6e0cfad3 1367 :link ("GNU Emacs"
9dba2c64 1368 ,(lambda (_button) (browse-url "http://www.gnu.org/software/emacs/"))
6e0cfad3 1369 "Browse http://www.gnu.org/software/emacs/")
22a58255
CY
1370 ", one component of the "
1371 :link
9dba2c64 1372 ,(lambda ()
22a58255 1373 (if (eq system-type 'gnu/linux)
9dba2c64
SM
1374 `("GNU/Linux"
1375 ,(lambda (_button)
1376 (browse-url "http://www.gnu.org/gnu/linux-and-gnu.html"))
6e0cfad3 1377 "Browse http://www.gnu.org/gnu/linux-and-gnu.html")
9dba2c64 1378 `("GNU" ,(lambda (_button) (describe-gnu-project))
6e0cfad3 1379 "Display info on the GNU project.")))
22a58255 1380 " operating system.\n"
fa7c3228 1381 :face (variable-pitch font-lock-builtin-face)
22a58255 1382 "\n"
9dba2c64 1383 ,(lambda () (emacs-version))
22a58255 1384 "\n"
245a7698 1385 :face (variable-pitch (:height 0.8))
9dba2c64 1386 ,(lambda () emacs-copyright)
22a58255
CY
1387 "\n\n"
1388 :face variable-pitch
490a1ad6 1389 :link ("Authors"
9dba2c64 1390 ,(lambda (_button)
490a1ad6
JL
1391 (view-file (expand-file-name "AUTHORS" data-directory))
1392 (goto-char (point-min))))
1393 "\tMany people have contributed code included in GNU Emacs\n"
1394 :link ("Contributing"
9dba2c64 1395 ,(lambda (_button)
490a1ad6
JL
1396 (view-file (expand-file-name "CONTRIBUTE" data-directory))
1397 (goto-char (point-min))))
1398 "\tHow to contribute improvements to Emacs\n"
1399 "\n"
9dba2c64 1400 :link ("GNU and Freedom" ,(lambda (_button) (describe-gnu-project)))
fad930b6 1401 "\tWhy we developed GNU Emacs, and the GNU operating system\n"
9dba2c64 1402 :link ("Absence of Warranty" ,(lambda (_button) (describe-no-warranty)))
fad930b6 1403 "\tGNU Emacs comes with "
422abbfd 1404 :face (variable-pitch (:slant oblique))
fad930b6
RS
1405 "ABSOLUTELY NO WARRANTY\n"
1406 :face variable-pitch
9dba2c64 1407 :link ("Copying Conditions" ,(lambda (_button) (describe-copying)))
fad930b6 1408 "\tConditions for redistributing and changing Emacs\n"
9dba2c64 1409 :link ("Getting New Versions" ,(lambda (_button) (describe-distribution)))
fad930b6 1410 "\tHow to obtain the latest version of Emacs\n"
9dba2c64 1411 :link ("Ordering Manuals" ,(lambda (_button) (view-order-manuals)))
1cff9ad1 1412 "\tBuying printed manuals from the FSF\n"
fad930b6 1413 "\n"
9dba2c64 1414 :link ("Emacs Tutorial" ,(lambda (_button) (help-with-tutorial)))
fad930b6 1415 "\tLearn basic Emacs keystroke commands"
9dba2c64 1416 ,(lambda ()
fad930b6
RS
1417 (let* ((en "TUTORIAL")
1418 (tut (or (get-language-info current-language-environment
1419 'tutorial)
1420 en))
1421 (title (with-temp-buffer
1422 (insert-file-contents
1423 (expand-file-name tut tutorial-directory)
1424 nil 0 256)
1425 (search-forward ".")
1426 (buffer-substring (point-min) (1- (point))))))
1427 ;; If there is a specific tutorial for the current language
1428 ;; environment and it is not English, append its title.
1429 (if (string= en tut)
1430 ""
1431 (concat " (" title ")"))))
1432 "\n"
1433 :link ("Emacs Guided Tour"
9dba2c64
SM
1434 ,(lambda (_button)
1435 (browse-url "http://www.gnu.org/software/emacs/tour/"))
6e0cfad3 1436 "Browse http://www.gnu.org/software/emacs/tour/")
fa7c3228 1437 "\tSee an overview of Emacs features at gnu.org"))
1d865f15
JL
1438 "A list of texts to show in the middle part of the About screen.
1439Each element in the list should be a list of strings or pairs
1440`:face FACE', like `fancy-splash-insert' accepts them.")
1441
ce9ded5d 1442
fb275c02 1443(defgroup fancy-splash-screen ()
a01bb1db 1444 "Fancy splash screen when Emacs starts."
fb275c02 1445 :version "21.1"
a01bb1db
GM
1446 :group 'initialization)
1447
8ad8561b 1448(defcustom fancy-splash-image nil
ea6c930a 1449 "The image to show in the splash screens, or nil for defaults."
a01bb1db 1450 :group 'fancy-splash-screen
8ad8561b
GM
1451 :type '(choice (const :tag "Default" nil)
1452 (file :tag "File")))
ce9ded5d
GM
1453
1454
aeb6faec 1455(defvar splash-screen-keymap
26cdce23
JL
1456 (let ((map (make-sparse-keymap)))
1457 (suppress-keymap map)
1458 (set-keymap-parent map button-buffer-map)
ce3cefcc
CY
1459 (define-key map "\C-?" 'scroll-down-command)
1460 (define-key map " " 'scroll-up-command)
aeb6faec 1461 (define-key map "q" 'exit-splash-screen)
26cdce23
JL
1462 map)
1463 "Keymap for splash screen buffer.")
1464
f645586f
GM
1465;; These are temporary storage areas for the splash screen display.
1466
ce9ded5d
GM
1467(defun fancy-splash-insert (&rest args)
1468 "Insert text into the current buffer, with faces.
22a58255
CY
1469Arguments from ARGS should be either strings; functions called
1470with no args that return a string; pairs `:face FACE', where FACE
1471is a face specification usable with `put-text-property'; or pairs
1472`:link LINK' where LINK is a list of arguments to pass to
6e0cfad3
JL
1473`insert-button', of the form (LABEL ACTION [HELP-ECHO]), which
1474specifies the button's label, `action' property and help-echo string.
1475FACE and LINK can also be functions, which are evaluated to obtain
1476a face or button specification."
ce9ded5d
GM
1477 (let ((current-face nil))
1478 (while args
26cdce23 1479 (cond ((eq (car args) :face)
22a58255
CY
1480 (setq args (cdr args) current-face (car args))
1481 (if (functionp current-face)
1482 (setq current-face (funcall current-face))))
26cdce23
JL
1483 ((eq (car args) :link)
1484 (setq args (cdr args))
1485 (let ((spec (car args)))
22a58255
CY
1486 (if (functionp spec)
1487 (setq spec (funcall spec)))
26cdce23
JL
1488 (insert-button (car spec)
1489 'face (list 'link current-face)
1490 'action (cadr spec)
6e0cfad3
JL
1491 'help-echo (concat "mouse-2, RET: "
1492 (or (nth 2 spec)
1493 "Follow this link"))
26cdce23
JL
1494 'follow-link t)))
1495 (t (insert (propertize (let ((it (car args)))
1496 (if (functionp it)
1497 (funcall it)
1498 it))
1499 'face current-face
d4a629de 1500 'help-echo (startup-echo-area-message)))))
ce9ded5d
GM
1501 (setq args (cdr args)))))
1502
aa360da1 1503(declare-function image-size "image.c" (spec &optional pixels frame))
ce9ded5d
GM
1504
1505(defun fancy-splash-head ()
1506 "Insert the head part of the splash screen into the current buffer."
51e8cfdd
GM
1507 (let* ((image-file (cond ((stringp fancy-splash-image)
1508 fancy-splash-image)
68548459 1509 ((display-color-p)
555b0992
JB
1510 (cond ((<= (display-planes) 8)
1511 (if (image-type-available-p 'xpm)
1512 "splash.xpm"
1513 "splash.pbm"))
a6674402
CY
1514 ((or (image-type-available-p 'svg)
1515 (image-type-available-p 'imagemagick))
68548459
JB
1516 "splash.svg")
1517 ((image-type-available-p 'png)
1518 "splash.png")
1519 ((image-type-available-p 'xpm)
555b0992
JB
1520 "splash.xpm")
1521 (t "splash.pbm")))
68548459 1522 (t "splash.pbm")))
51e8cfdd 1523 (img (create-image image-file))
ce9ded5d
GM
1524 (image-width (and img (car (image-size img))))
1525 (window-width (window-width (selected-window))))
1526 (when img
1527 (when (> window-width image-width)
f645586f 1528 ;; Center the image in the window.
6b61353c
KH
1529 (insert (propertize " " 'display
1530 `(space :align-to (+ center (-0.5 . ,img)))))
f645586f 1531
e7f3afa9
MB
1532 ;; Change the color of the XPM version of the splash image
1533 ;; so that it is visible with a dark frame background.
1534 (when (and (memq 'xpm img)
1535 (eq (frame-parameter nil 'background-mode) 'dark))
1536 (setq img (append img '(:color-symbols (("#000000" . "gray30"))))))
1537
aeb6faec
JL
1538 ;; Insert the image with a help-echo and a link.
1539 (make-button (prog1 (point) (insert-image img)) (point)
1540 'face 'default
6e0cfad3 1541 'help-echo "mouse-2, RET: Browse http://www.gnu.org/"
06788a55 1542 'action (lambda (_button) (browse-url "http://www.gnu.org/"))
aeb6faec 1543 'follow-link t)
22a58255
CY
1544 (insert "\n\n")))))
1545
1cff9ad1 1546(defun fancy-startup-tail (&optional concise)
ce9ded5d 1547 "Insert the tail part of the splash screen into the current buffer."
fa7c3228 1548 (unless concise
bb398779 1549 (fancy-splash-insert
fa7c3228
CY
1550 :face 'variable-pitch
1551 "\nTo start... "
1552 :link `("Open a File"
1553 ,(lambda (_button) (call-interactively 'find-file))
1554 "Specify a new file's name, to edit the file")
1555 " "
1556 :link `("Open Home Directory"
1557 ,(lambda (_button) (dired "~"))
1558 "Open your home directory, to operate on its files")
1559 " "
1560 :link `("Customize Startup"
1561 ,(lambda (_button) (customize-group 'initialization))
1562 "Change initialization settings including this screen")
1563 "\n"))
1564 (fancy-splash-insert
1565 :face 'variable-pitch "To quit a partially entered command, type "
1566 :face 'default "Control-g"
1567 :face 'variable-pitch ".\n")
1568 (fancy-splash-insert :face `(variable-pitch font-lock-builtin-face)
1569 "\nThis is "
1570 (emacs-version)
1571 "\n"
1572 :face '(variable-pitch (:height 0.8))
1573 emacs-copyright
1574 "\n")
c01bf73e
CY
1575 (when auto-save-list-file-prefix
1576 (let ((dir (file-name-directory auto-save-list-file-prefix))
1577 (name (file-name-nondirectory auto-save-list-file-prefix))
1578 files)
1579 ;; Don't warn if the directory for auto-save-list files does not
1580 ;; yet exist.
1581 (and (file-directory-p dir)
1582 (setq files (directory-files dir nil (concat "\\`" name) t))
1583 (fancy-splash-insert :face '(variable-pitch font-lock-comment-face)
1584 (if (= (length files) 1)
1585 "\nAn auto-save file list was found. "
1586 "\nAuto-save file lists were found. ")
1587 "If an Emacs session crashed recently,\ntype "
f0b6ae63
KS
1588 :link `("M-x recover-session RET"
1589 ,(lambda (_button)
1590 (call-interactively
1591 'recover-session)))
c01bf73e 1592 " to recover the files you were editing."))))
fa7c3228
CY
1593
1594 (when concise
1595 (fancy-splash-insert
1596 :face 'variable-pitch "\n"
1597 :link `("Dismiss this startup screen"
1598 ,(lambda (_button)
1599 (when startup-screen-inhibit-startup-screen
1600 (customize-set-variable 'inhibit-startup-screen t)
1601 (customize-mark-to-save 'inhibit-startup-screen)
1602 (custom-save-all))
1603 (let ((w (get-buffer-window "*GNU Emacs*")))
1604 (and w (not (one-window-p)) (delete-window w)))
1605 (kill-buffer "*GNU Emacs*")))
1606 " ")
1607 (when (or user-init-file custom-file)
1608 (let ((checked (create-image "checked.xpm"
1609 nil nil :ascent 'center))
1610 (unchecked (create-image "unchecked.xpm"
1611 nil nil :ascent 'center)))
1612 (insert-button
1613 " "
1614 :on-glyph checked
1615 :off-glyph unchecked
1616 'checked nil 'display unchecked 'follow-link t
1617 'action (lambda (button)
1618 (if (overlay-get button 'checked)
1619 (progn (overlay-put button 'checked nil)
1620 (overlay-put button 'display
1621 (overlay-get button :off-glyph))
1622 (setq startup-screen-inhibit-startup-screen
1623 nil))
1624 (overlay-put button 'checked t)
1625 (overlay-put button 'display
1626 (overlay-get button :on-glyph))
1627 (setq startup-screen-inhibit-startup-screen t)))))
1628 (fancy-splash-insert :face '(variable-pitch (:height 0.9))
1629 " Never show it again."))))
f645586f 1630
aeb6faec 1631(defun exit-splash-screen ()
26cdce23 1632 "Stop displaying the splash screen buffer."
f645586f 1633 (interactive)
1d865f15
JL
1634 (quit-window t))
1635
1cff9ad1 1636(defun fancy-startup-screen (&optional concise)
22a58255 1637 "Display fancy startup screen.
1cff9ad1
JL
1638If CONCISE is non-nil, display a concise version of the
1639splash screen in another window."
3d9d55e6 1640 (let ((splash-buffer (get-buffer-create "*GNU Emacs*")))
09723615 1641 (with-current-buffer splash-buffer
3d9d55e6
CY
1642 (let ((inhibit-read-only t))
1643 (erase-buffer)
4222d0a4 1644 (setq default-directory command-line-default-directory)
3d9d55e6
CY
1645 (make-local-variable 'startup-screen-inhibit-startup-screen)
1646 (if pure-space-overflow
1647 (insert pure-space-overflow-message))
1648 (unless concise
1649 (fancy-splash-head))
1650 (dolist (text fancy-startup-text)
1651 (apply #'fancy-splash-insert text)
1652 (insert "\n"))
1653 (skip-chars-backward "\n")
1654 (delete-region (point) (point-max))
1655 (insert "\n")
1656 (fancy-startup-tail concise))
1657 (use-local-map splash-screen-keymap)
1658 (setq tab-width 22
1659 buffer-read-only t)
1660 (set-buffer-modified-p nil)
1661 (if (and view-read-only (not view-mode))
1662 (view-mode-enter nil 'kill-buffer))
09723615
JL
1663 (goto-char (point-min))
1664 (forward-line (if concise 2 4)))
3d9d55e6
CY
1665 (if concise
1666 (progn
1667 (display-buffer splash-buffer)
1668 ;; If the splash screen is in a split window, fit it.
1669 (let ((window (get-buffer-window splash-buffer t)))
1670 (or (null window)
1671 (eq window (selected-window))
1672 (eq window (next-window window))
1673 (fit-window-to-buffer window))))
1674 (switch-to-buffer splash-buffer))))
22a58255
CY
1675
1676(defun fancy-about-screen ()
1677 "Display fancy About screen."
1678 (let ((frame (fancy-splash-frame)))
1679 (save-selected-window
1680 (select-frame frame)
1681 (switch-to-buffer "*About GNU Emacs*")
6a639b16 1682 (setq buffer-undo-list t)
22a58255
CY
1683 (let ((inhibit-read-only t))
1684 (erase-buffer)
1685 (if pure-space-overflow
1686 (insert pure-space-overflow-message))
1687 (fancy-splash-head)
1688 (dolist (text fancy-about-text)
1689 (apply #'fancy-splash-insert text)
1690 (insert "\n"))
22a58255
CY
1691 (set-buffer-modified-p nil)
1692 (goto-char (point-min))
1693 (force-mode-line-update))
aeb6faec 1694 (use-local-map splash-screen-keymap)
cb3fe757 1695 (setq tab-width 22)
08326816 1696 (setq buffer-read-only t)
09723615
JL
1697 (goto-char (point-min))
1698 (forward-line 3))))
6b20fb8e
RS
1699
1700(defun fancy-splash-frame ()
1701 "Return the frame to use for the fancy splash screen.
1702Returning non-nil does not mean we should necessarily
1703use the fancy splash screen, but if we do use it,
1704we put it on this frame."
1705 (let (chosen-frame)
3a321ddb 1706 (dolist (frame (append (frame-list) (list (selected-frame))))
6b20fb8e
RS
1707 (if (and (frame-visible-p frame)
1708 (not (window-minibuffer-p (frame-selected-window frame))))
1709 (setq chosen-frame frame)))
1710 chosen-frame))
f645586f 1711
285991dc
GM
1712(defun use-fancy-splash-screens-p ()
1713 "Return t if fancy splash screens should be used."
6b61353c
KH
1714 (when (and (display-graphic-p)
1715 (or (and (display-color-p)
285991dc 1716 (image-type-available-p 'xpm))
6b61353c 1717 (image-type-available-p 'pbm)))
16d2fae9
JPW
1718 (let ((frame (fancy-splash-frame)))
1719 (when frame
1720 (let* ((img (create-image (or fancy-splash-image
1721 (if (and (display-color-p)
1722 (image-type-available-p 'xpm))
1723 "splash.xpm" "splash.pbm"))))
a68ccb40
RS
1724 (image-height (and img (cdr (image-size img nil frame))))
1725 ;; We test frame-height so that, if the frame is split
1726 ;; by displaying a warning, that doesn't cause the normal
1727 ;; splash screen to be used.
1728 (frame-height (1- (frame-height frame))))
1729 (> frame-height (+ image-height 19)))))))
285991dc
GM
1730
1731
79b1c79c 1732(defun normal-splash-screen (&optional startup concise)
1d865f15
JL
1733 "Display non-graphic splash screen.
1734If optional argument STARTUP is non-nil, display the startup screen
79b1c79c
JL
1735after Emacs starts. If STARTUP is nil, display the About screen.
1736If CONCISE is non-nil, display a concise version of the
1737splash screen in another window."
1738 (let ((splash-buffer (get-buffer-create "*About GNU Emacs*")))
1739 (with-current-buffer splash-buffer
1d865f15
JL
1740 (setq buffer-read-only nil)
1741 (erase-buffer)
4222d0a4 1742 (setq default-directory command-line-default-directory)
1d865f15 1743 (set (make-local-variable 'tab-width) 8)
1d865f15
JL
1744
1745 (if pure-space-overflow
22a58255 1746 (insert pure-space-overflow-message))
260a5020 1747
1d865f15
JL
1748 ;; The convention for this piece of code is that
1749 ;; each piece of output starts with one or two newlines
1750 ;; and does not end with any newlines.
22a58255 1751 (insert (if startup "Welcome to GNU Emacs" "This is GNU Emacs"))
1d865f15
JL
1752 (insert
1753 (if (eq system-type 'gnu/linux)
1754 ", one component of the GNU/Linux operating system.\n"
1755 ", a part of the GNU operating system.\n"))
1756
1757 (if startup
1758 (if (display-mouse-p)
1759 ;; The user can use the mouse to activate menus
1760 ;; so give help in terms of menu items.
fad930b6 1761 (normal-mouse-startup-screen)
c61453ea 1762
e349ae3b 1763 ;; No mouse menus, so give help using kbd commands.
fad930b6 1764 (normal-no-mouse-startup-screen))
e349ae3b 1765
fad930b6 1766 (normal-about-screen))
1d865f15
JL
1767
1768 ;; The rest of the startup screen is the same on all
1769 ;; kinds of terminals.
1770
1771 ;; Give information on recovering, if there was a crash.
1772 (and startup
1773 auto-save-list-file-prefix
1774 ;; Don't signal an error if the
1775 ;; directory for auto-save-list files
1776 ;; does not yet exist.
1777 (file-directory-p (file-name-directory
1778 auto-save-list-file-prefix))
1779 (directory-files
1780 (file-name-directory auto-save-list-file-prefix)
1781 nil
1782 (concat "\\`"
1783 (regexp-quote (file-name-nondirectory
1784 auto-save-list-file-prefix)))
1785 t)
1786 (insert "\n\nIf an Emacs session crashed recently, "
1787 "type Meta-x recover-session RET\nto recover"
1788 " the files you were editing.\n"))
26cdce23 1789
1d865f15 1790 (use-local-map splash-screen-keymap)
e349ae3b 1791
1d865f15
JL
1792 ;; Display the input that we set up in the buffer.
1793 (set-buffer-modified-p nil)
1794 (setq buffer-read-only t)
1795 (if (and view-read-only (not view-mode))
1796 (view-mode-enter nil 'kill-buffer))
1d865f15 1797 (if startup (rename-buffer "*GNU Emacs*" t))
79b1c79c
JL
1798 (goto-char (point-min)))
1799 (if concise
1800 (display-buffer splash-buffer)
1801 (switch-to-buffer splash-buffer))))
82e736c1 1802
fad930b6
RS
1803(defun normal-mouse-startup-screen ()
1804 ;; The user can use the mouse to activate menus
1805 ;; so give help in terms of menu items.
1806 (insert "\
09723615 1807To follow a link, click Mouse-1 on it, or move to it and type RET.
26cdce23
JL
1808To quit a partially entered command, type Control-g.\n")
1809
fad930b6
RS
1810 (insert "\nImportant Help menu items:\n")
1811 (insert-button "Emacs Tutorial"
06788a55 1812 'action (lambda (_button) (help-with-tutorial))
fad930b6
RS
1813 'follow-link t)
1814 (insert "\t\tLearn basic Emacs keystroke commands\n")
1815 (insert-button "Read the Emacs Manual"
06788a55 1816 'action (lambda (_button) (info-emacs-manual))
fad930b6
RS
1817 'follow-link t)
1818 (insert "\tView the Emacs manual using Info\n")
1819 (insert-button "\(Non)Warranty"
06788a55 1820 'action (lambda (_button) (describe-no-warranty))
fad930b6
RS
1821 'follow-link t)
1822 (insert "\t\tGNU Emacs comes with ABSOLUTELY NO WARRANTY\n")
1823 (insert-button "Copying Conditions"
06788a55 1824 'action (lambda (_button) (describe-copying))
fad930b6
RS
1825 'follow-link t)
1826 (insert "\tConditions for redistributing and changing Emacs\n")
1827 (insert-button "More Manuals / Ordering Manuals"
06788a55 1828 'action (lambda (_button) (view-order-manuals))
fad930b6
RS
1829 'follow-link t)
1830 (insert " How to order printed manuals from the FSF\n")
1831
1832 (insert "\nUseful tasks:\n")
1833 (insert-button "Visit New File"
06788a55 1834 'action (lambda (_button) (call-interactively 'find-file))
fad930b6
RS
1835 'follow-link t)
1836 (insert "\t\tSpecify a new file's name, to edit the file\n")
1837 (insert-button "Open Home Directory"
06788a55 1838 'action (lambda (_button) (dired "~"))
fad930b6
RS
1839 'follow-link t)
1840 (insert "\tOpen your home directory, to operate on its files\n")
1841 (insert-button "Customize Startup"
06788a55 1842 'action (lambda (_button) (customize-group 'initialization))
fad930b6
RS
1843 'follow-link t)
1844 (insert "\tChange initialization settings including this screen\n")
1845
1846 (insert "\n" (emacs-version)
1847 "\n" emacs-copyright))
1848
1849;; No mouse menus, so give help using kbd commands.
1850(defun normal-no-mouse-startup-screen ()
1851
1852 ;; If keys have their default meanings,
1853 ;; use precomputed string to save lots of time.
2aa0e5bf
SM
1854 (let* ((c-h-accessible
1855 ;; If normal-erase-is-backspace is used on a tty, there's
1856 ;; no way to invoke C-h and you have to use F1 instead.
1857 (or (not (char-table-p keyboard-translate-table))
1858 (eq (aref keyboard-translate-table ?\C-h) ?\C-h)))
1859 (minor-mode-overriding-map-alist
1860 (cons (cons (not c-h-accessible)
1861 ;; If C-h can't be invoked, temporarily disable its
1862 ;; binding, so where-is uses alternative bindings.
1863 (let ((map (make-sparse-keymap)))
1864 (define-key map [?\C-h] 'undefined)
1865 map))
1866 minor-mode-overriding-map-alist)))
1867
1868 (insert (format "\nGet help\t %s\n"
1869 (let ((where (where-is-internal 'help-command nil t)))
1870 (cond
1871 ((equal where [?\C-h])
1872 "C-h (Hold down CTRL and press h)")
1873 (where (key-description where))
1874 (t "M-x help")))))
1875 (insert-button "Emacs manual"
06788a55 1876 'action (lambda (_button) (info-emacs-manual))
2aa0e5bf
SM
1877 'follow-link t)
1878 (insert (substitute-command-keys"\t \\[info-emacs-manual]\t"))
1879 (insert-button "Browse manuals"
06788a55 1880 'action (lambda (_button) (Info-directory))
2aa0e5bf
SM
1881 'follow-link t)
1882 (insert (substitute-command-keys "\t \\[info]\n"))
1883 (insert-button "Emacs tutorial"
06788a55 1884 'action (lambda (_button) (help-with-tutorial))
2aa0e5bf
SM
1885 'follow-link t)
1886 (insert (substitute-command-keys
8cb95edf 1887 "\t \\[help-with-tutorial]\tUndo changes\t \\[undo]\n"))
2aa0e5bf 1888 (insert-button "Buy manuals"
06788a55 1889 'action (lambda (_button) (view-order-manuals))
2aa0e5bf
SM
1890 'follow-link t)
1891 (insert (substitute-command-keys
1892 "\t \\[view-order-manuals]\tExit Emacs\t \\[save-buffers-kill-terminal]")))
fad930b6
RS
1893
1894 ;; Say how to use the menu bar with the keyboard.
1895 (insert "\n")
1896 (insert-button "Activate menubar"
06788a55 1897 'action (lambda (_button) (tmm-menubar))
fad930b6
RS
1898 'follow-link t)
1899 (if (and (eq (key-binding "\M-`") 'tmm-menubar)
1900 (eq (key-binding [f10]) 'tmm-menubar))
1901 (insert " F10 or ESC ` or M-`")
1902 (insert (substitute-command-keys " \\[tmm-menubar]")))
1903
1904 ;; Many users seem to have problems with these.
1905 (insert "
c61453ea
PJ
1906\(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
1907If you have no Meta key, you may instead type ESC followed by the character.)")
1908
fad930b6
RS
1909 ;; Insert links to useful tasks
1910 (insert "\nUseful tasks:\n")
1911
1912 (insert-button "Visit New File"
06788a55 1913 'action (lambda (_button) (call-interactively 'find-file))
fad930b6
RS
1914 'follow-link t)
1915 (insert "\t\t\t")
1916 (insert-button "Open Home Directory"
06788a55 1917 'action (lambda (_button) (dired "~"))
fad930b6
RS
1918 'follow-link t)
1919 (insert "\n")
1920
1921 (insert-button "Customize Startup"
06788a55 1922 'action (lambda (_button) (customize-group 'initialization))
fad930b6
RS
1923 'follow-link t)
1924 (insert "\t\t")
1925 (insert-button "Open *scratch* buffer"
06788a55
SM
1926 'action (lambda (_button) (switch-to-buffer
1927 (get-buffer-create "*scratch*")))
fad930b6
RS
1928 'follow-link t)
1929 (insert "\n")
1930 (insert "\n" (emacs-version) "\n" emacs-copyright "\n")
1931
1932 (if (and (eq (key-binding "\C-h\C-c") 'describe-copying)
1933 (eq (key-binding "\C-h\C-d") 'describe-distribution)
1934 (eq (key-binding "\C-h\C-w") 'describe-no-warranty))
1935 (progn
1936 (insert
490a1ad6 1937 "
cd6ab24f 1938GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for ")
fad930b6 1939 (insert-button "full details"
9dba2c64 1940 'action (lambda (_button) (describe-no-warranty))
fad930b6
RS
1941 'follow-link t)
1942 (insert ".
c61453ea 1943Emacs is Free Software--Free as in Freedom--so you can redistribute copies
cd6ab24f 1944of Emacs and modify it; type C-h C-c to see ")
fad930b6 1945 (insert-button "the conditions"
9dba2c64 1946 'action (lambda (_button) (describe-copying))
fad930b6
RS
1947 'follow-link t)
1948 (insert ".
cd6ab24f 1949Type C-h C-d for information on ")
fad930b6 1950 (insert-button "getting the latest version"
9dba2c64 1951 'action (lambda (_button) (describe-distribution))
fad930b6
RS
1952 'follow-link t)
1953 (insert "."))
1954 (insert (substitute-command-keys
490a1ad6 1955 "
cd6ab24f 1956GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for "))
fad930b6 1957 (insert-button "full details"
9dba2c64 1958 'action (lambda (_button) (describe-no-warranty))
fad930b6
RS
1959 'follow-link t)
1960 (insert (substitute-command-keys ".
c61453ea 1961Emacs is Free Software--Free as in Freedom--so you can redistribute copies
cd6ab24f 1962of Emacs and modify it; type \\[describe-copying] to see "))
fad930b6 1963 (insert-button "the conditions"
9dba2c64 1964 'action (lambda (_button) (describe-copying))
fad930b6
RS
1965 'follow-link t)
1966 (insert (substitute-command-keys".
cd6ab24f 1967Type \\[describe-distribution] for information on "))
fad930b6 1968 (insert-button "getting the latest version"
9dba2c64 1969 'action (lambda (_button) (describe-distribution))
fad930b6
RS
1970 'follow-link t)
1971 (insert ".")))
1972
1973(defun normal-about-screen ()
1974 (insert "\n" (emacs-version) "\n" emacs-copyright "\n\n")
1975
1976 (insert "To follow a link, click Mouse-1 on it, or move to it and type RET.\n\n")
1977
490a1ad6
JL
1978 (insert-button "Authors"
1979 'action
06788a55 1980 (lambda (_button)
490a1ad6
JL
1981 (view-file (expand-file-name "AUTHORS" data-directory))
1982 (goto-char (point-min)))
1983 'follow-link t)
1984 (insert "\t\tMany people have contributed code included in GNU Emacs\n")
1985
1986 (insert-button "Contributing"
1987 'action
06788a55 1988 (lambda (_button)
490a1ad6
JL
1989 (view-file (expand-file-name "CONTRIBUTE" data-directory))
1990 (goto-char (point-min)))
1991 'follow-link t)
1992 (insert "\tHow to contribute improvements to Emacs\n\n")
1993
fad930b6 1994 (insert-button "GNU and Freedom"
06788a55 1995 'action (lambda (_button) (describe-gnu-project))
fad930b6
RS
1996 'follow-link t)
1997 (insert "\t\tWhy we developed GNU Emacs and the GNU system\n")
1998
1999 (insert-button "Absence of Warranty"
06788a55 2000 'action (lambda (_button) (describe-no-warranty))
fad930b6
RS
2001 'follow-link t)
2002 (insert "\tGNU Emacs comes with ABSOLUTELY NO WARRANTY\n")
2003
2004 (insert-button "Copying Conditions"
06788a55 2005 'action (lambda (_button) (describe-copying))
fad930b6
RS
2006 'follow-link t)
2007 (insert "\tConditions for redistributing and changing Emacs\n")
2008
2009 (insert-button "Getting New Versions"
06788a55 2010 'action (lambda (_button) (describe-distribution))
fad930b6
RS
2011 'follow-link t)
2012 (insert "\tHow to get the latest version of GNU Emacs\n")
2013
2014 (insert-button "More Manuals / Ordering Manuals"
06788a55 2015 'action (lambda (_button) (view-order-manuals))
fad930b6
RS
2016 'follow-link t)
2017 (insert "\tBuying printed manuals from the FSF\n"))
c61453ea 2018
2230fa5b
CY
2019(defun startup-echo-area-message ()
2020 (cond ((daemonp)
2eb92184
CY
2021 "Starting Emacs daemon.")
2022 ((eq (key-binding "\C-h\C-a") 'about-emacs)
2023 "For information about GNU Emacs and the GNU system, type C-h C-a.")
2024 (t
2025 (substitute-command-keys
2026 "For information about GNU Emacs and the GNU system, type \
2027\\[about-emacs]."))))
ce9ded5d 2028
49939379 2029(defun display-startup-echo-area-message ()
15fa6db0 2030 (let ((resize-mini-windows t))
8dabbfd6 2031 (or noninteractive ;(input-pending-p) init-file-had-error
f1be5774
KL
2032 ;; t if the init file says to inhibit the echo area startup message.
2033 (and inhibit-startup-echo-area-message
2034 user-init-file
2035 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
2036 (equal inhibit-startup-echo-area-message
2037 (if (equal init-file-user "")
2038 (user-login-name)
2039 init-file-user)))
2040 ;; Wasn't set with custom; see if .emacs has a setq.
8dabbfd6
SM
2041 (condition-case nil
2042 (with-temp-buffer
2043 (insert-file-contents user-init-file)
2044 (re-search-forward
2045 (concat
2046 "([ \t\n]*setq[ \t\n]+"
2047 "inhibit-startup-echo-area-message[ \t\n]+"
2048 (regexp-quote
2049 (prin1-to-string
2050 (if (equal init-file-user "")
2051 (user-login-name)
2052 init-file-user)))
2053 "[ \t\n]*)")
2054 nil t))
2055 (error nil))))
1d865f15 2056 (message "%s" (startup-echo-area-message)))))
f645586f 2057
1cff9ad1 2058(defun display-startup-screen (&optional concise)
22a58255
CY
2059 "Display startup screen according to display.
2060A fancy display is used on graphic displays, normal otherwise.
49939379 2061
22a58255
CY
2062If CONCISE is non-nil, display a concise version of the startup
2063screen."
526039df 2064 ;; Prevent recursive calls from server-process-filter.
1cff9ad1 2065 (if (not (get-buffer "*GNU Emacs*"))
526039df 2066 (if (use-fancy-splash-screens-p)
22a58255 2067 (fancy-startup-screen concise)
79b1c79c 2068 (normal-splash-screen t concise))))
22a58255
CY
2069
2070(defun display-about-screen ()
2071 "Display the *About GNU Emacs* buffer.
2072A fancy display is used on graphic displays, normal otherwise."
2073 (interactive)
6b61353c 2074 (if (use-fancy-splash-screens-p)
1cff9ad1
JL
2075 (fancy-about-screen)
2076 (normal-splash-screen nil)))
c61453ea 2077
22a58255 2078(defalias 'about-emacs 'display-about-screen)
1cff9ad1 2079(defalias 'display-splash-screen 'display-startup-screen)
c61453ea 2080
06788a55 2081(defun command-line-1 (args-left)
33da7b16 2082 "A subroutine of `command-line'."
f1be5774 2083 (display-startup-echo-area-message)
cb58ea33
RS
2084 (when (and pure-space-overflow
2085 (not noninteractive))
2086 (display-warning
2087 'initialization
f2602864
CY
2088 "Building Emacs overflowed pure space.\
2089 (See the node Pure Storage in the Lisp manual for details.)"
cb58ea33
RS
2090 :warning))
2091
22a58255 2092 (let ((file-count 0)
06788a55 2093 (command-line-args-left args-left)
22a58255
CY
2094 first-file-buffer)
2095 (when command-line-args-left
2096 ;; We have command args; process them.
06788a55
SM
2097 (let ((dir command-line-default-directory)
2098 tem
22a58255
CY
2099 ;; This approach loses for "-batch -L DIR --eval "(require foo)",
2100 ;; if foo is intended to be found in DIR.
2101 ;;
2102 ;; ;; The directories listed in --directory/-L options will *appear*
2103 ;; ;; at the front of `load-path' in the order they appear on the
2104 ;; ;; command-line. We cannot do this by *placing* them at the front
2105 ;; ;; in the order they appear, so we need this variable to hold them,
2106 ;; ;; temporarily.
2107 ;; extra-load-path
2108 ;;
2109 ;; To DTRT we keep track of the splice point and modify `load-path'
2110 ;; straight away upon any --directory/-L option.
2111 splice
2112 just-files ;; t if this follows the magic -- option.
2113 ;; This includes our standard options' long versions
2114 ;; and long versions of what's on command-switch-alist.
2115 (longopts
2aa0e5bf
SM
2116 (append '("--funcall" "--load" "--insert" "--kill"
2117 "--directory" "--eval" "--execute" "--no-splash"
2118 "--find-file" "--visit" "--file" "--no-desktop")
2119 (mapcar (lambda (elt) (concat "-" (car elt)))
22a58255 2120 command-switch-alist)))
06788a55
SM
2121 (line 0)
2122 (column 0))
22a58255
CY
2123
2124 ;; Add the long X options to longopts.
4f6cc6b5
GM
2125 (dolist (tem command-line-x-option-alist)
2126 (if (string-match "^--" (car tem))
2127 (push (car tem) longopts)))
22a58255 2128
122e9f8f 2129 ;; Add the long NS options to longopts.
4f6cc6b5
GM
2130 (dolist (tem command-line-ns-option-alist)
2131 (if (string-match "^--" (car tem))
2132 (push (list (car tem)) longopts)))
edfda783 2133
22a58255
CY
2134 ;; Loop, processing options.
2135 (while command-line-args-left
2136 (let* ((argi (car command-line-args-left))
2137 (orig-argi argi)
2138 argval completion)
2139 (setq command-line-args-left (cdr command-line-args-left))
2140
2141 ;; Do preliminary decoding of the option.
2142 (if just-files
2143 ;; After --, don't look for options; treat all args as files.
2144 (setq argi "")
2145 ;; Convert long options to ordinary options
2146 ;; and separate out an attached option argument into argval.
7b704afe 2147 (when (string-match "\\`\\(--[^=]*\\)=" argi)
22a58255
CY
2148 (setq argval (substring argi (match-end 0))
2149 argi (match-string 1 argi)))
ce3a988d 2150 (when (string-match "\\`--?[^-]" orig-argi)
7b704afe
AS
2151 (setq completion (try-completion argi longopts))
2152 (if (eq completion t)
2153 (setq argi (substring argi 1))
2154 (if (stringp completion)
2aa0e5bf 2155 (let ((elt (member completion longopts)))
7b704afe
AS
2156 (or elt
2157 (error "Option `%s' is ambiguous" argi))
2158 (setq argi (substring (car elt) 1)))
2159 (setq argval nil
2160 argi orig-argi)))))
22a58255
CY
2161
2162 ;; Execute the option.
06788a55 2163 (cond ((setq tem (assoc argi command-switch-alist))
22a58255
CY
2164 (if argval
2165 (let ((command-line-args-left
2166 (cons argval command-line-args-left)))
06788a55
SM
2167 (funcall (cdr tem) argi))
2168 (funcall (cdr tem) argi)))
22a58255
CY
2169
2170 ((equal argi "-no-splash")
1cff9ad1 2171 (setq inhibit-startup-screen t))
22a58255
CY
2172
2173 ((member argi '("-f" ; what the manual claims
2174 "-funcall"
2175 "-e")) ; what the source used to say
1cff9ad1 2176 (setq inhibit-startup-screen t)
06788a55
SM
2177 (setq tem (intern (or argval (pop command-line-args-left))))
2178 (if (commandp tem)
2179 (command-execute tem)
2180 (funcall tem)))
22a58255
CY
2181
2182 ((member argi '("-eval" "-execute"))
1cff9ad1 2183 (setq inhibit-startup-screen t)
22a58255
CY
2184 (eval (read (or argval (pop command-line-args-left)))))
2185
2186 ((member argi '("-L" "-directory"))
06788a55 2187 (setq tem (expand-file-name
22a58255
CY
2188 (command-line-normalize-file-name
2189 (or argval (pop command-line-args-left)))))
06788a55 2190 (cond (splice (setcdr splice (cons tem (cdr splice)))
22a58255 2191 (setq splice (cdr splice)))
06788a55 2192 (t (setq load-path (cons tem load-path)
22a58255
CY
2193 splice load-path))))
2194
2195 ((member argi '("-l" "-load"))
2196 (let* ((file (command-line-normalize-file-name
2197 (or argval (pop command-line-args-left))))
2198 ;; Take file from default dir if it exists there;
2199 ;; otherwise let `load' search for it.
2200 (file-ex (expand-file-name file)))
2201 (when (file-exists-p file-ex)
2202 (setq file file-ex))
2203 (load file nil t)))
2204
2205 ;; This is used to handle -script. It's not clear
f71d844b 2206 ;; we need to document it (it is totally internal).
1d1100d7 2207 ((member argi '("-scriptload"))
22a58255
CY
2208 (let* ((file (command-line-normalize-file-name
2209 (or argval (pop command-line-args-left))))
2210 ;; Take file from default dir.
2211 (file-ex (expand-file-name file)))
2212 (load file-ex nil t t)))
2213
2214 ((equal argi "-insert")
1cff9ad1 2215 (setq inhibit-startup-screen t)
06788a55
SM
2216 (setq tem (or argval (pop command-line-args-left)))
2217 (or (stringp tem)
22a58255 2218 (error "File name omitted from `-insert' option"))
06788a55 2219 (insert-file-contents (command-line-normalize-file-name tem)))
22a58255
CY
2220
2221 ((equal argi "-kill")
2222 (kill-emacs t))
2223
2224 ;; This is for when they use --no-desktop with -q, or
2225 ;; don't load Desktop in their .emacs. If desktop.el
2226 ;; _is_ loaded, it will handle this switch, and we
2227 ;; won't see it by the time we get here.
2228 ((equal argi "-no-desktop")
2229 (message "\"--no-desktop\" ignored because the Desktop package is not loaded"))
2230
2231 ((string-match "^\\+[0-9]+\\'" argi)
06788a55 2232 (setq line (string-to-number argi)))
22a58255
CY
2233
2234 ((string-match "^\\+\\([0-9]+\\):\\([0-9]+\\)\\'" argi)
06788a55
SM
2235 (setq line (string-to-number (match-string 1 argi))
2236 column (string-to-number (match-string 2 argi))))
22a58255 2237
06788a55 2238 ((setq tem (assoc orig-argi command-line-x-option-alist))
22a58255
CY
2239 ;; Ignore X-windows options and their args if not using X.
2240 (setq command-line-args-left
06788a55 2241 (nthcdr (nth 1 tem) command-line-args-left)))
22a58255 2242
06788a55 2243 ((setq tem (assoc orig-argi command-line-ns-option-alist))
3000e3f4
DN
2244 ;; Ignore NS-windows options and their args if not using NS.
2245 (setq command-line-args-left
06788a55 2246 (nthcdr (nth 1 tem) command-line-args-left)))
edfda783 2247
22a58255 2248 ((member argi '("-find-file" "-file" "-visit"))
1cff9ad1 2249 (setq inhibit-startup-screen t)
22a58255 2250 ;; An explicit option to specify visiting a file.
06788a55
SM
2251 (setq tem (or argval (pop command-line-args-left)))
2252 (unless (stringp tem)
22a58255
CY
2253 (error "File name omitted from `%s' option" argi))
2254 (setq file-count (1+ file-count))
2255 (let ((file (expand-file-name
06788a55
SM
2256 (command-line-normalize-file-name tem)
2257 dir)))
22a58255
CY
2258 (if (= file-count 1)
2259 (setq first-file-buffer (find-file file))
2260 (find-file-other-window file)))
06788a55 2261 (unless (zerop line)
e6ce8c42 2262 (goto-char (point-min))
06788a55
SM
2263 (forward-line (1- line)))
2264 (setq line 0)
2265 (unless (< column 1)
2266 (move-to-column (1- column)))
2267 (setq column 0))
22a58255 2268
198a7a97
CY
2269 ;; These command lines now have no effect.
2270 ((string-match "\\`--?\\(no-\\)?\\(uni\\|multi\\)byte$" argi)
2271 (display-warning 'initialization
2272 (format "Ignoring obsolete arg %s" argi)))
2273
22a58255
CY
2274 ((equal argi "--")
2275 (setq just-files t))
2276 (t
2277 ;; We have almost exhausted our options. See if the
2278 ;; user has made any other command-line options available
2279 (let ((hooks command-line-functions)
2280 (did-hook nil))
2281 (while (and hooks
2282 (not (setq did-hook (funcall (car hooks)))))
2283 (setq hooks (cdr hooks)))
2284 (if (not did-hook)
2285 ;; Presume that the argument is a file name.
2286 (progn
2287 (if (string-match "\\`-" argi)
2288 (error "Unknown option `%s'" argi))
1cff9ad1
JL
2289 (unless initial-window-system
2290 (setq inhibit-startup-screen t))
22a58255
CY
2291 (setq file-count (1+ file-count))
2292 (let ((file
2293 (expand-file-name
2294 (command-line-normalize-file-name orig-argi)
06788a55 2295 dir)))
3d9d55e6
CY
2296 (cond ((= file-count 1)
2297 (setq first-file-buffer (find-file file)))
2298 (inhibit-startup-screen
2299 (find-file-other-window file))
2300 (t (find-file file))))
06788a55 2301 (unless (zerop line)
e6ce8c42 2302 (goto-char (point-min))
06788a55
SM
2303 (forward-line (1- line)))
2304 (setq line 0)
2305 (unless (< column 1)
2306 (move-to-column (1- column)))
2307 (setq column 0))))))
22a58255
CY
2308 ;; In unusual circumstances, the execution of Lisp code due
2309 ;; to command-line options can cause the last visible frame
2310 ;; to be deleted. In this case, kill emacs to avoid an
2311 ;; abort later.
2312 (unless (frame-live-p (selected-frame)) (kill-emacs nil))))))
2313
199e4c7e
MR
2314 (when (eq initial-buffer-choice t)
2315 ;; When initial-buffer-choice equals t make sure that *scratch*
2316 ;; exists.
2317 (get-buffer-create "*scratch*"))
22a58255 2318
8d86c6da 2319 ;; If *scratch* exists and is empty, insert initial-scratch-message.
199e4c7e 2320 ;; Do this before switching to *scratch* below to handle bug#9605.
8d86c6da
JL
2321 (and initial-scratch-message
2322 (get-buffer "*scratch*")
2323 (with-current-buffer "*scratch*"
2324 (when (zerop (buffer-size))
199e4c7e 2325 (insert initial-scratch-message)
8d86c6da
JL
2326 (set-buffer-modified-p nil))))
2327
199e4c7e 2328 (when initial-buffer-choice
dc646358
CK
2329 (let ((buf
2330 (cond ((stringp initial-buffer-choice)
2331 (find-file-noselect initial-buffer-choice))
2332 ((functionp initial-buffer-choice)
2333 (funcall initial-buffer-choice)))))
2334 (switch-to-buffer
2335 (if (buffer-live-p buf) buf (get-buffer-create "*scratch*"))
2336 'norecord)))
199e4c7e 2337
1cff9ad1 2338 (if (or inhibit-startup-screen
22a58255
CY
2339 initial-buffer-choice
2340 noninteractive
ede141ac 2341 (daemonp)
8686ac71 2342 inhibit-x-resources)
22a58255
CY
2343
2344 ;; Not displaying a startup screen. If 3 or more files
2345 ;; visited, and not all visible, show user what they all are.
2346 (and (> file-count 2)
2347 (not noninteractive)
2348 (not inhibit-startup-buffer-menu)
2349 (or (get-buffer-window first-file-buffer)
2350 (list-buffers)))
2351
2352 ;; Display a startup screen, after some preparations.
2353
2354 ;; If there are no switches to process, we might as well
2355 ;; run this hook now, and there may be some need to do it
2356 ;; before doing any output.
2357 (run-hooks 'emacs-startup-hook)
2358 (and term-setup-hook
2359 (run-hooks 'term-setup-hook))
2360 (setq inhibit-startup-hooks t)
2361
2362 ;; It's important to notice the user settings before we
2363 ;; display the startup message; otherwise, the settings
2364 ;; won't take effect until the user gives the first
2365 ;; keystroke, and that's distracting.
2366 (when (fboundp 'frame-notice-user-settings)
2367 (frame-notice-user-settings))
2368
2369 ;; If there are no switches to process, we might as well
2370 ;; run this hook now, and there may be some need to do it
2371 ;; before doing any output.
2372 (when window-setup-hook
2373 (run-hooks 'window-setup-hook)
2374 ;; Don't let the hook be run twice.
2375 (setq window-setup-hook nil))
2376
04ef2618
CY
2377 ;; ;; Do this now to avoid an annoying delay if the user
2378 ;; ;; clicks the menu bar during the sit-for.
2379 ;; (when (display-popup-menus-p)
2380 ;; (precompute-menubar-bindings))
2381 ;; (with-no-warnings
2382 ;; (setq menubar-bindings-done t))
22a58255 2383
ede141ac 2384 (display-startup-screen (> file-count 0)))))
49939379 2385
47c7adae
RS
2386(defun command-line-normalize-file-name (file)
2387 "Collapse multiple slashes to one, to handle non-Emacs file names."
6b9e794f
RS
2388 (save-match-data
2389 ;; Use arg 1 so that we don't collapse // at the start of the file name.
2390 ;; That is significant on some systems.
2391 ;; However, /// at the beginning is supposed to mean just /, not //.
2392 (if (string-match "^///+" file)
2393 (setq file (replace-match "/" t t file)))
50405cd0
JB
2394 (and (memq system-type '(ms-dos windows-nt))
2395 (string-match "^[A-Za-z]:\\(\\\\[\\\\/]\\)" file) ; C:\/ or C:\\
2396 (setq file (replace-match "/" t t file 1)))
6b9e794f
RS
2397 (while (string-match "//+" file 1)
2398 (setq file (replace-match "/" t t file)))
2399 file))
47c7adae 2400
c88ab9ce 2401;;; startup.el ends here