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