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