*** empty log message ***
[emacs.git] / lisp / startup.el
blob6af6e748ee5a71819bdc1fb49d8fe0d688d30e65
1 ;;; startup.el --- process Emacs shell arguments
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 ;; 2001, 2002, 2004, 2005 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
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.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;; This file parses the command line and gets Emacs running. Options
29 ;; on the command line are handled in precedence order. For priorities
30 ;; see the structure standard_args in the emacs.c file.
32 ;;; Code:
34 (setq top-level '(normal-top-level))
36 (defvar command-line-processed nil
37 "Non-nil once command line has been processed.")
39 (defgroup initialization nil
40 "Emacs start-up procedure"
41 :group 'internal)
43 (defcustom inhibit-startup-message nil
44 "*Non-nil inhibits the initial startup message.
45 This is for use in your personal init file, once you are familiar
46 with the contents of the startup message."
47 :type 'boolean
48 :group 'initialization)
50 (defvaralias 'inhibit-splash-screen 'inhibit-startup-message)
52 (defcustom inhibit-startup-echo-area-message nil
53 "*Non-nil inhibits the initial startup echo area message.
54 Setting this variable takes effect
55 only if you do it with the customization buffer
56 or if your `.emacs' file contains a line of this form:
57 (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\")
58 If your `.emacs' file is byte-compiled, use the following form instead:
59 (eval '(setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\"))
60 Thus, someone else using a copy of your `.emacs' file will see
61 the startup message unless he personally acts to inhibit it."
62 :type '(choice (const :tag "Don't inhibit")
63 (string :tag "Enter your user name, to inhibit"))
64 :group 'initialization)
66 (defcustom inhibit-default-init nil
67 "*Non-nil inhibits loading the `default' library."
68 :type 'boolean
69 :group 'initialization)
71 (defcustom inhibit-startup-buffer-menu nil
72 "*Non-nil inhibits display of buffer list when more than 2 files are loaded."
73 :type 'boolean
74 :group 'initialization)
76 (defvar command-switch-alist nil
77 "Alist of command-line switches.
78 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
79 HANDLER-FUNCTION receives the switch string as its sole argument;
80 the remaining command-line args are in the variable `command-line-args-left'.")
82 (defvar command-line-args-left nil
83 "List of command-line args not yet processed.")
85 (defvar command-line-functions nil ;; lrs 7/31/89
86 "List of functions to process unrecognized command-line arguments.
87 Each function should access the dynamically bound variables
88 `argi' (the current argument) and `command-line-args-left' (the remaining
89 arguments). The function should return non-nil only if it recognizes and
90 processes `argi'. If it does so, it may consume successive arguments by
91 altering `command-line-args-left' to remove them.")
93 (defvar command-line-default-directory nil
94 "Default directory to use for command line arguments.
95 This is normally copied from `default-directory' when Emacs starts.")
97 ;;; This is here, rather than in x-win.el, so that we can ignore these
98 ;;; options when we are not using X.
99 (defconst command-line-x-option-alist
100 '(("-bw" 1 x-handle-numeric-switch border-width)
101 ("-d" 1 x-handle-display)
102 ("-display" 1 x-handle-display)
103 ("-name" 1 x-handle-name-switch)
104 ("-title" 1 x-handle-switch title)
105 ("-T" 1 x-handle-switch title)
106 ("-r" 0 x-handle-switch reverse t)
107 ("-rv" 0 x-handle-switch reverse t)
108 ("-reverse" 0 x-handle-switch reverse t)
109 ("-reverse-video" 0 x-handle-switch reverse t)
110 ("-fn" 1 x-handle-switch font)
111 ("-font" 1 x-handle-switch font)
112 ("-fs" 0 x-handle-initial-switch fullscreen fullboth)
113 ("-fw" 0 x-handle-initial-switch fullscreen fullwidth)
114 ("-fh" 0 x-handle-initial-switch fullscreen fullheight)
115 ("-ib" 1 x-handle-numeric-switch internal-border-width)
116 ("-g" 1 x-handle-geometry)
117 ("-lsp" 1 x-handle-numeric-switch line-spacing)
118 ("-geometry" 1 x-handle-geometry)
119 ("-fg" 1 x-handle-switch foreground-color)
120 ("-foreground" 1 x-handle-switch foreground-color)
121 ("-bg" 1 x-handle-switch background-color)
122 ("-background" 1 x-handle-switch background-color)
123 ("-ms" 1 x-handle-switch mouse-color)
124 ("-itype" 0 x-handle-switch icon-type t)
125 ("-i" 0 x-handle-switch icon-type t)
126 ("-iconic" 0 x-handle-iconic)
127 ("-xrm" 1 x-handle-xrm-switch)
128 ("-cr" 1 x-handle-switch cursor-color)
129 ("-vb" 0 x-handle-switch vertical-scroll-bars t)
130 ("-hb" 0 x-handle-switch horizontal-scroll-bars t)
131 ("-bd" 1 x-handle-switch)
132 ("--border-width" 1 x-handle-numeric-switch border-width)
133 ("--display" 1 x-handle-display)
134 ("--name" 1 x-handle-name-switch)
135 ("--title" 1 x-handle-switch title)
136 ("--reverse-video" 0 x-handle-switch reverse t)
137 ("--font" 1 x-handle-switch font)
138 ("--fullscreen" 0 x-handle-initial-switch fullscreen fullboth)
139 ("--fullwidth" 0 x-handle-initial-switch fullscreen fullwidth)
140 ("--fullheight" 0 x-handle-initial-switch fullscreen fullheight)
141 ("--internal-border" 1 x-handle-numeric-switch internal-border-width)
142 ("--geometry" 1 x-handle-geometry)
143 ("--foreground-color" 1 x-handle-switch foreground-color)
144 ("--background-color" 1 x-handle-switch background-color)
145 ("--mouse-color" 1 x-handle-switch mouse-color)
146 ("--icon-type" 0 x-handle-switch icon-type t)
147 ("--iconic" 0 x-handle-iconic)
148 ("--xrm" 1 x-handle-xrm-switch)
149 ("--cursor-color" 1 x-handle-switch cursor-color)
150 ("--vertical-scroll-bars" 0 x-handle-switch vertical-scroll-bars t)
151 ("--line-spacing" 1 x-handle-numeric-switch line-spacing)
152 ("--border-color" 1 x-handle-switch border-color)
153 ("--smid" 1 x-handle-smid))
154 "Alist of X Windows options.
155 Each element has the form
156 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
157 where NAME is the option name string, NUMARGS is the number of arguments
158 that the option accepts, HANDLER is a function to call to handle the option.
159 FRAME-PARAM (optional) is the frame parameter this option specifies,
160 and VALUE is the value which is given to that frame parameter
161 \(most options use the argument for this, so VALUE is not present).")
163 (defvar before-init-hook nil
164 "Normal hook run after handling urgent options but before loading init files.")
166 (defvar after-init-hook nil
167 "Normal hook run after loading the init files, `~/.emacs' and `default.el'.
168 There is no `condition-case' around the running of these functions;
169 therefore, if you set `debug-on-error' non-nil in `.emacs',
170 an error in one of these functions will invoke the debugger.")
172 (defvar emacs-startup-hook nil
173 "Normal hook run after loading init files and handling the command line.")
175 (defvar term-setup-hook nil
176 "Normal hook run after loading terminal-specific Lisp code.
177 It also follows `emacs-startup-hook'. This hook exists for users to set,
178 so as to override the definitions made by the terminal-specific file.
179 Emacs never sets this variable itself.")
181 (defvar inhibit-startup-hooks nil
182 "Non-nil means don't run `term-setup-hook' and `emacs-startup-hook'.
183 This is because we already did so.")
185 (defvar keyboard-type nil
186 "The brand of keyboard you are using.
187 This variable is used to define
188 the proper function and keypad keys for use under X. It is used in a
189 fashion analogous to the environment variable TERM.")
191 (defvar window-setup-hook nil
192 "Normal hook run to initialize window system display.
193 Emacs runs this hook after processing the command line arguments and loading
194 the user's init file.")
196 (defcustom initial-major-mode 'lisp-interaction-mode
197 "Major mode command symbol to use for the initial *scratch* buffer."
198 :type 'function
199 :group 'initialization)
201 (defcustom init-file-user nil
202 "Identity of user whose `.emacs' file is or was read.
203 The value is nil if `-q' or `--no-init-file' was specified,
204 meaning do not load any init file.
206 Otherwise, the value may be the null string, meaning use the init file
207 for the user that originally logged in, or it may be a
208 string containing a user's name meaning use that person's init file.
210 In either of the latter cases, `(concat \"~\" init-file-user \"/\")'
211 evaluates to the name of the directory where the `.emacs' file was
212 looked for.
214 Setting `init-file-user' does not prevent Emacs from loading
215 `site-start.el'. The only way to do that is to use `--no-site-file'."
216 :type '(choice (const :tag "none" nil) string)
217 :group 'initialization)
219 (defcustom site-run-file "site-start"
220 "File containing site-wide run-time initializations.
221 This file is loaded at run-time before `~/.emacs'. It contains inits
222 that need to be in place for the entire site, but which, due to their
223 higher incidence of change, don't make sense to load into Emacs's
224 dumped image. Thus, the run-time load order is: 1. file described in
225 this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.
227 Don't use the `site-start.el' file for things some users may not like.
228 Put them in `default.el' instead, so that users can more easily
229 override them. Users can prevent loading `default.el' with the `-q'
230 option or by setting `inhibit-default-init' in their own init files,
231 but inhibiting `site-start.el' requires `--no-site-file', which
232 is less convenient.
234 This variable is defined for customization so as to make
235 it visible in the relevant context. However, actually customizing it
236 is not allowed, since it would not work anyway. The only way to set
237 this variable usefully is to set it during while building and dumping Emacs."
238 :type '(choice (const :tag "none" nil) string)
239 :group 'initialization
240 :initialize 'custom-initialize-default
241 :set '(lambda (variable value)
242 (error "Customizing `site-run-file' does not work")))
244 (defcustom mail-host-address nil
245 "*Name of this machine, for purposes of naming users."
246 :type '(choice (const nil) string)
247 :group 'mail)
249 (defcustom user-mail-address (if command-line-processed
250 (concat (user-login-name) "@"
251 (or mail-host-address
252 (system-name)))
253 ;; Empty string means "not set yet".
255 "*Full mailing address of this user.
256 This is initialized based on `mail-host-address',
257 after your init file is read, in case it sets `mail-host-address'."
258 :type 'string
259 :group 'mail)
261 (defcustom auto-save-list-file-prefix
262 (cond ((eq system-type 'ms-dos)
263 ;; MS-DOS cannot have initial dot, and allows only 8.3 names
264 "~/_emacs.d/auto-save.list/_s")
266 "~/.emacs.d/auto-save-list/.saves-"))
267 "Prefix for generating `auto-save-list-file-name'.
268 This is used after reading your `.emacs' file to initialize
269 `auto-save-list-file-name', by appending Emacs's pid and the system name,
270 if you have not already set `auto-save-list-file-name' yourself.
271 Directories in the prefix will be created if necessary.
272 Set this to nil if you want to prevent `auto-save-list-file-name'
273 from being initialized."
274 :type '(choice (const :tag "Don't record a session's auto save list" nil)
275 string)
276 :group 'auto-save)
278 (defvar emacs-quick-startup nil)
280 (defvar emacs-basic-display nil)
282 (defvar init-file-debug nil)
284 (defvar init-file-had-error nil)
286 (defvar normal-top-level-add-subdirs-inode-list nil)
288 (defvar no-blinking-cursor nil)
290 (defvar pure-space-overflow nil
291 "Non-nil if building Emacs overflowed pure space.")
293 (defun normal-top-level-add-subdirs-to-load-path ()
294 "Add all subdirectories of current directory to `load-path'.
295 More precisely, this uses only the subdirectories whose names
296 start with letters or digits; it excludes any subdirectory named `RCS'
297 or `CVS', and any subdirectory that contains a file named `.nosearch'."
298 (let (dirs
299 attrs
300 (pending (list default-directory)))
301 ;; This loop does a breadth-first tree walk on DIR's subtree,
302 ;; putting each subdir into DIRS as its contents are examined.
303 (while pending
304 (push (pop pending) dirs)
305 (let* ((this-dir (car dirs))
306 (contents (directory-files this-dir))
307 (default-directory this-dir)
308 (canonicalized (if (fboundp 'untranslated-canonical-name)
309 (untranslated-canonical-name this-dir))))
310 ;; The Windows version doesn't report meaningful inode
311 ;; numbers, so use the canonicalized absolute file name of the
312 ;; directory instead.
313 (setq attrs (or canonicalized
314 (nthcdr 10 (file-attributes this-dir))))
315 (unless (member attrs normal-top-level-add-subdirs-inode-list)
316 (push attrs normal-top-level-add-subdirs-inode-list)
317 (dolist (file contents)
318 ;; The lower-case variants of RCS and CVS are for DOS/Windows.
319 (unless (member file '("." ".." "RCS" "CVS" "rcs" "cvs"))
320 (when (and (string-match "\\`[[:alnum:]]" file)
321 ;; Avoid doing a `stat' when it isn't necessary
322 ;; because that can cause trouble when an NFS server
323 ;; is down.
324 (not (string-match "\\.elc?\\'" file))
325 (file-directory-p file))
326 (let ((expanded (expand-file-name file)))
327 (unless (file-exists-p (expand-file-name ".nosearch"
328 expanded))
329 (setq pending (nconc pending (list expanded)))))))))))
330 (normal-top-level-add-to-load-path (cdr (nreverse dirs)))))
332 ;; This function is called from a subdirs.el file.
333 ;; It assumes that default-directory is the directory
334 ;; in which the subdirs.el file exists,
335 ;; and it adds to load-path the subdirs of that directory
336 ;; as specified in DIRS. Normally the elements of DIRS are relative.
337 (defun normal-top-level-add-to-load-path (dirs)
338 (let ((tail load-path)
339 (thisdir (directory-file-name default-directory)))
340 (while (and tail
341 ;;Don't go all the way to the nil terminator.
342 (cdr tail)
343 (not (equal thisdir (car tail)))
344 (not (and (memq system-type '(ms-dos windows-nt))
345 (equal (downcase thisdir) (downcase (car tail))))))
346 (setq tail (cdr tail)))
347 ;;Splice the new section in.
348 (when tail
349 (setcdr tail (append (mapcar 'expand-file-name dirs) (cdr tail))))))
351 (defun normal-top-level ()
352 (if command-line-processed
353 (message "Back to top level.")
354 (setq command-line-processed t)
355 ;; Give *Messages* the same default-directory as *scratch*,
356 ;; just to keep things predictable.
357 (let ((dir default-directory))
358 (with-current-buffer "*Messages*"
359 (setq default-directory dir)))
360 ;; `user-full-name' is now known; reset its standard-value here.
361 (put 'user-full-name 'standard-value
362 (list (default-value 'user-full-name)))
363 ;; For root, preserve owner and group when editing files.
364 (if (equal (user-uid) 0)
365 (setq backup-by-copying-when-mismatch t))
366 ;; Look in each dir in load-path for a subdirs.el file.
367 ;; If we find one, load it, which will add the appropriate subdirs
368 ;; of that dir into load-path,
369 ;; Look for a leim-list.el file too. Loading it will register
370 ;; available input methods.
371 (let ((tail load-path) dir)
372 (while tail
373 (setq dir (car tail))
374 (let ((default-directory dir))
375 (load (expand-file-name "subdirs.el") t t t))
376 (let ((default-directory dir))
377 (load (expand-file-name "leim-list.el") t t t))
378 ;; We don't use a dolist loop and we put this "setq-cdr" command at
379 ;; the end, because the subdirs.el files may add elements to the end
380 ;; of load-path and we want to take it into account.
381 (setq tail (cdr tail))))
382 (unless (eq system-type 'vax-vms)
383 ;; If the PWD environment variable isn't accurate, delete it.
384 (let ((pwd (getenv "PWD")))
385 (and (stringp pwd)
386 ;; Use FOO/., so that if FOO is a symlink, file-attributes
387 ;; describes the directory linked to, not FOO itself.
388 (or (equal (file-attributes
389 (concat (file-name-as-directory pwd) "."))
390 (file-attributes
391 (concat (file-name-as-directory default-directory)
392 ".")))
393 (setq process-environment
394 (delete (concat "PWD=" pwd)
395 process-environment))))))
396 (setq default-directory (abbreviate-file-name default-directory))
397 (let ((menubar-bindings-done nil))
398 (unwind-protect
399 (command-line)
400 ;; Do this again, in case .emacs defined more abbreviations.
401 (setq default-directory (abbreviate-file-name default-directory))
402 ;; Specify the file for recording all the auto save files of this session.
403 ;; This is used by recover-session.
404 (or auto-save-list-file-name
405 (and auto-save-list-file-prefix
406 (setq auto-save-list-file-name
407 ;; Under MS-DOS our PID is almost always reused between
408 ;; Emacs invocations. We need something more unique.
409 (cond ((eq system-type 'ms-dos)
410 ;; We are going to access the auto-save
411 ;; directory, so make sure it exists.
412 (make-directory
413 (file-name-directory auto-save-list-file-prefix)
415 (concat
416 (make-temp-name
417 (expand-file-name
418 auto-save-list-file-prefix))
419 "~"))
421 (expand-file-name
422 (format "%s%d-%s~"
423 auto-save-list-file-prefix
424 (emacs-pid)
425 (system-name))))))))
426 (unless inhibit-startup-hooks
427 (run-hooks 'emacs-startup-hook)
428 (and term-setup-hook
429 (run-hooks 'term-setup-hook)))
431 ;; Don't do this if we failed to create the initial frame,
432 ;; for instance due to a dense colormap.
433 (when (or frame-initial-frame
434 ;; If frame-initial-frame has no meaning, do this anyway.
435 (not (and window-system
436 (not noninteractive)
437 (not (eq window-system 'pc)))))
438 ;; Modify the initial frame based on what .emacs puts into
439 ;; ...-frame-alist.
440 (if (fboundp 'frame-notice-user-settings)
441 (frame-notice-user-settings))
442 (if (fboundp 'frame-set-background-mode)
443 ;; Set the faces for the initial background mode even if
444 ;; frame-notice-user-settings didn't (such as on a tty).
445 ;; frame-set-background-mode is idempotent, so it won't
446 ;; cause any harm if it's already been done.
447 (let ((frame-background-mode frame-background-mode)
448 (frame (selected-frame))
449 term)
450 (when (and (null window-system)
451 ;; Don't override a possibly customized value.
452 (null frame-background-mode)
453 ;; Don't override user specifications.
454 (null (frame-parameter frame 'reverse))
455 (let ((bg (frame-parameter frame 'background-color)))
456 (or (null bg)
457 (member bg '(unspecified "unspecified-bg")))))
458 (setq term (getenv "TERM"))
459 ;; Some files in lisp/term do a better job with the
460 ;; background mode, but we leave this here anyway, in
461 ;; case they remove those files.
462 (if (string-match "^\\(xterm\\|rxvt\\|dtterm\\|eterm\\)"
463 term)
464 (setq frame-background-mode 'light)))
465 (frame-set-background-mode (selected-frame)))))
467 ;; Now we know the user's default font, so add it to the menu.
468 (if (fboundp 'font-menu-add-default)
469 (font-menu-add-default))
470 (and window-setup-hook
471 (run-hooks 'window-setup-hook))
472 (or menubar-bindings-done
473 (if (display-popup-menus-p)
474 (precompute-menubar-bindings)))))))
476 ;; Precompute the keyboard equivalents in the menu bar items.
477 (defun precompute-menubar-bindings ()
478 (let ((submap (lookup-key global-map [menu-bar])))
479 (while submap
480 (and (consp (car submap))
481 (symbolp (car (car submap)))
482 (stringp (car-safe (cdr (car submap))))
483 (keymapp (cdr (cdr (car submap))))
484 (progn
485 (x-popup-menu nil (cdr (cdr (car submap))))
486 (if purify-flag
487 (garbage-collect))))
488 (setq submap (cdr submap))))
489 (setq define-key-rebound-commands t))
491 ;; Command-line options supported by tty's:
492 (defconst tty-long-option-alist
493 '(("--name" . "-name")
494 ("--title" . "-T")
495 ("--reverse-video" . "-reverse")
496 ("--foreground-color" . "-fg")
497 ("--background-color" . "-bg")
498 ("--color" . "-color")))
500 (defconst tool-bar-images-pixel-height 24
501 "Height in pixels of images in the tool bar.")
503 (defvar tool-bar-originally-present nil
504 "Non-nil if tool-bars are present before user and site init files are read.")
506 ;; Handle the X-like command-line arguments "-fg", "-bg", "-name", etc.
507 (defun tty-handle-args (args)
508 (let (rest)
509 (message "%s" args)
510 (while (and args
511 (not (equal (car args) "--")))
512 (let* ((argi (pop args))
513 (orig-argi argi)
514 argval completion)
515 ;; Check for long options with attached arguments
516 ;; and separate out the attached option argument into argval.
517 (when (string-match "^\\(--[^=]*\\)=" argi)
518 (setq argval (substring argi (match-end 0))
519 argi (match-string 1 argi)))
520 (when (string-match "^--" argi)
521 (setq completion (try-completion argi tty-long-option-alist))
522 (if (eq completion t)
523 ;; Exact match for long option.
524 (setq argi (cdr (assoc argi tty-long-option-alist)))
525 (if (stringp completion)
526 (let ((elt (assoc completion tty-long-option-alist)))
527 ;; Check for abbreviated long option.
528 (or elt
529 (error "Option `%s' is ambiguous" argi))
530 (setq argi (cdr elt)))
531 ;; Check for a short option.
532 (setq argval nil
533 argi orig-argi))))
534 (cond ((member argi '("-fg" "-foreground"))
535 (push (cons 'foreground-color (or argval (pop args)))
536 default-frame-alist))
537 ((member argi '("-bg" "-background"))
538 (push (cons 'background-color (or argval (pop args)))
539 default-frame-alist))
540 ((member argi '("-T" "-name"))
541 (unless argval (setq argval (pop args)))
542 (push (cons 'title
543 (if (stringp argval)
544 argval
545 (let ((case-fold-search t)
547 (setq argval (invocation-name))
549 ;; Change any . or * characters in name to
550 ;; hyphens, so as to emulate behavior on X.
551 (while
552 (setq i (string-match "[.*]" argval))
553 (aset argval i ?-))
554 argval)))
555 default-frame-alist))
556 ((member argi '("-r" "-rv" "-reverse"))
557 (push '(reverse . t)
558 default-frame-alist))
559 ((equal argi "-color")
560 (unless argval (setq argval 8)) ; default --color means 8 ANSI colors
561 (push (cons 'tty-color-mode
562 (cond
563 ((numberp argval) argval)
564 ((string-match "-?[0-9]+" argval)
565 (string-to-number argval))
566 (t (intern argval))))
567 default-frame-alist))
569 (push argi rest)))))
570 (nreverse rest)))
572 (defun command-line ()
573 (setq command-line-default-directory default-directory)
575 ;; Choose a reasonable location for temporary files.
576 (custom-reevaluate-setting 'temporary-file-directory)
577 (custom-reevaluate-setting 'small-emporary-file-directory)
578 (custom-reevaluate-setting 'auto-save-file-name-transforms)
580 ;; See if we should import version-control from the environment variable.
581 (let ((vc (getenv "VERSION_CONTROL")))
582 (cond ((eq vc nil)) ;don't do anything if not set
583 ((member vc '("t" "numbered"))
584 (setq version-control t))
585 ((member vc '("nil" "existing"))
586 (setq version-control nil))
587 ((member vc '("never" "simple"))
588 (setq version-control 'never))))
590 ;;! This has been commented out; I currently find the behavior when
591 ;;! split-window-keep-point is nil disturbing, but if I can get used
592 ;;! to it, then it would be better to eliminate the option.
593 ;;! ;; Choose a good default value for split-window-keep-point.
594 ;;! (setq split-window-keep-point (> baud-rate 2400))
596 ;; Set the default strings to display in mode line for
597 ;; end-of-line formats that aren't native to this platform.
598 (cond
599 ((memq system-type '(ms-dos windows-nt emx))
600 (setq eol-mnemonic-unix "(Unix)"
601 eol-mnemonic-mac "(Mac)"))
602 ;; Both Mac and Unix EOLs are now "native" on Mac OS so keep the
603 ;; abbreviated strings `/' and `:' set in coding.c for them.
604 ((eq system-type 'macos)
605 (setq eol-mnemonic-dos "(DOS)"))
606 (t ; this is for Unix/GNU/Linux systems
607 (setq eol-mnemonic-dos "(DOS)"
608 eol-mnemonic-mac "(Mac)")))
610 ;; Read window system's init file if using a window system.
611 (condition-case error
612 (if (and window-system (not noninteractive))
613 (load (concat term-file-prefix
614 (symbol-name window-system)
615 "-win")
616 ;; Every window system should have a startup file;
617 ;; barf if we can't find it.
618 nil t))
619 ;; If we can't read it, print the error message and exit.
620 (error
621 (princ
622 (if (eq (car error) 'error)
623 (apply 'concat (cdr error))
624 (if (memq 'file-error (get (car error) 'error-conditions))
625 (format "%s: %s"
626 (nth 1 error)
627 (mapconcat (lambda (obj) (prin1-to-string obj t))
628 (cdr (cdr error)) ", "))
629 (format "%s: %s"
630 (get (car error) 'error-message)
631 (mapconcat (lambda (obj) (prin1-to-string obj t))
632 (cdr error) ", "))))
633 'external-debugging-output)
634 (terpri 'external-debugging-output)
635 (setq window-system nil)
636 (kill-emacs)))
638 ;; Windowed displays do this inside their *-win.el.
639 (unless (or (display-graphic-p) noninteractive)
640 (setq command-line-args (tty-handle-args command-line-args)))
642 (set-locale-environment nil)
644 ;; Convert the arguments to Emacs internal representation.
645 (let ((args (cdr command-line-args)))
646 (while args
647 (setcar args
648 (decode-coding-string (car args) locale-coding-system t))
649 (pop args)))
651 (let ((done nil)
652 (args (cdr command-line-args)))
654 ;; Figure out which user's init file to load,
655 ;; either from the environment or from the options.
656 (setq init-file-user (if noninteractive nil (user-login-name)))
657 ;; If user has not done su, use current $HOME to find .emacs.
658 (and init-file-user
659 (equal init-file-user (user-real-login-name))
660 (setq init-file-user ""))
662 ;; Process the command-line args, and delete the arguments
663 ;; processed. This is consistent with the way main in emacs.c
664 ;; does things.
665 (while (and (not done) args)
666 (let* ((longopts '(("--no-init-file") ("--no-site-file") ("--user")
667 ("--debug-init") ("--iconic") ("--icon-type")
668 ("--no-blinking-cursor") ("--bare-bones")))
669 (argi (pop args))
670 (orig-argi argi)
671 argval)
672 ;; Handle --OPTION=VALUE format.
673 (when (string-match "^\\(--[^=]*\\)=" argi)
674 (setq argval (substring argi (match-end 0))
675 argi (match-string 1 argi)))
676 (unless (equal argi "--")
677 (let ((completion (try-completion argi longopts)))
678 (if (eq completion t)
679 (setq argi (substring argi 1))
680 (if (stringp completion)
681 (let ((elt (assoc completion longopts)))
682 (or elt
683 (error "Option `%s' is ambiguous" argi))
684 (setq argi (substring (car elt) 1)))
685 (setq argval nil
686 argi orig-argi)))))
687 (cond
688 ((member argi '("-Q" "-quick"))
689 (setq init-file-user nil
690 site-run-file nil
691 emacs-quick-startup t))
692 ((member argi '("-D" "-basic-display"))
693 (setq no-blinking-cursor t
694 emacs-basic-display t)
695 (push '(vertical-scroll-bars . nil) initial-frame-alist))
696 ((member argi '("-q" "-no-init-file"))
697 (setq init-file-user nil))
698 ((member argi '("-u" "-user"))
699 (setq init-file-user (or argval (pop args))
700 argval nil))
701 ((equal argi "-no-site-file")
702 (setq site-run-file nil))
703 ((equal argi "-debug-init")
704 (setq init-file-debug t))
705 ((equal argi "-iconic")
706 (push '(visibility . icon) initial-frame-alist))
707 ((member argi '("-icon-type" "-i" "-itype"))
708 (push '(icon-type . t) default-frame-alist))
709 ((member argi '("-nbc" "-no-blinking-cursor"))
710 (setq no-blinking-cursor t))
711 ;; Push the popped arg back on the list of arguments.
713 (push argi args)
714 (setq done t)))
715 ;; Was argval set but not used?
716 (and argval
717 (error "Option `%s' doesn't allow an argument" argi))))
719 ;; Re-attach the program name to the front of the arg list.
720 (and command-line-args
721 (setcdr command-line-args args)))
723 ;; Under X Window, this creates the X frame and deletes the terminal frame.
724 (when (fboundp 'frame-initialize)
725 (frame-initialize))
727 ;; Turn off blinking cursor if so specified in X resources. This is here
728 ;; only because all other settings of no-blinking-cursor are here.
729 (unless (or noninteractive
730 emacs-basic-display
731 (and (memq window-system '(x w32 mac))
732 (not (member (x-get-resource "cursorBlink" "CursorBlink")
733 '("off" "false")))))
734 (setq no-blinking-cursor t))
736 ;; If frame was created with a menu bar, set menu-bar-mode on.
737 (unless (or noninteractive
738 emacs-basic-display
739 (and (memq window-system '(x w32))
740 (<= (frame-parameter nil 'menu-bar-lines) 0)))
741 (menu-bar-mode 1))
743 ;; If frame was created with a tool bar, switch tool-bar-mode on.
744 (unless (or noninteractive
745 emacs-basic-display
746 (not (display-graphic-p))
747 (<= (frame-parameter nil 'tool-bar-lines) 0))
748 (tool-bar-mode 1))
750 ;; Can't do this init in defcustom because the relevant variables
751 ;; are not set.
752 (custom-reevaluate-setting 'blink-cursor-mode)
753 (custom-reevaluate-setting 'normal-erase-is-backspace)
755 ;; If you change the code below, you need to also change the
756 ;; corresponding code in the tooltip-mode defcustom. The two need
757 ;; to be equivalent under all conditions, or Custom will get confused.
758 (unless (or noninteractive
759 emacs-basic-display
760 (not (display-graphic-p))
761 (not (fboundp 'x-show-tip)))
762 (tooltip-mode 1))
764 ;; Register default TTY colors for the case the terminal hasn't a
765 ;; terminal init file.
766 (unless (memq window-system '(x w32))
767 ;; We do this regardles of whether the terminal supports colors
768 ;; or not, since they can switch that support on or off in
769 ;; mid-session by setting the tty-color-mode frame parameter.
770 (tty-register-default-colors))
772 ;; Record whether the tool-bar is present before the user and site
773 ;; init files are processed. frame-notice-user-settings uses this
774 ;; to determine if the tool-bar has been disabled by the init files,
775 ;; and the frame needs to be resized.
776 (when (fboundp 'frame-notice-user-settings)
777 (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
778 (assq 'tool-bar-lines default-frame-alist))))
779 (setq tool-bar-originally-present
780 (and tool-bar-lines
781 (cdr tool-bar-lines)
782 (not (eq 0 (cdr tool-bar-lines)))))))
784 (let ((old-scalable-fonts-allowed scalable-fonts-allowed)
785 (old-font-list-limit font-list-limit)
786 (old-face-ignored-fonts face-ignored-fonts))
788 (run-hooks 'before-init-hook)
790 ;; Run the site-start library if it exists. The point of this file is
791 ;; that it is run before .emacs. There is no point in doing this after
792 ;; .emacs; that is useless.
793 (if site-run-file
794 (load site-run-file t t))
796 ;; Sites should not disable this. Only individuals should disable
797 ;; the startup message.
798 (setq inhibit-startup-message nil)
800 ;; Warn for invalid user name.
801 (and init-file-user
802 (not (file-directory-p (expand-file-name (concat "~" init-file-user))))
803 (display-warning 'initialization
804 (format "User %s has no home directory"
805 init-file-user)
806 :error))
808 ;; Load that user's init file, or the default one, or none.
809 (let (debug-on-error-from-init-file
810 debug-on-error-should-be-set
811 (debug-on-error-initial
812 (if (eq init-file-debug t) 'startup init-file-debug))
813 (orig-enable-multibyte default-enable-multibyte-characters))
814 (let ((debug-on-error debug-on-error-initial)
815 ;; This function actually reads the init files.
816 (inner
817 (function
818 (lambda ()
819 (if init-file-user
820 (let ((user-init-file-1
821 (cond
822 ((eq system-type 'ms-dos)
823 (concat "~" init-file-user "/_emacs"))
824 ((eq system-type 'windows-nt)
825 ;; Prefer .emacs on Windows.
826 (if (directory-files "~" nil "^\\.emacs\\(\\.elc?\\)?$")
827 "~/.emacs"
828 ;; Also support _emacs for compatibility.
829 (if (directory-files "~" nil "^_emacs\\(\\.elc?\\)?$")
830 "~/_emacs"
831 ;; But default to .emacs if _emacs does not exist.
832 "~/.emacs")))
833 ((eq system-type 'vax-vms)
834 "sys$login:.emacs")
836 (concat "~" init-file-user "/.emacs")))))
837 ;; This tells `load' to store the file name found
838 ;; into user-init-file.
839 (setq user-init-file t)
840 (load user-init-file-1 t t)
842 (when (eq user-init-file t)
843 ;; If we did not find ~/.emacs, try
844 ;; ~/.emacs.d/.emacs.
845 (let ((otherfile
846 (expand-file-name
847 (file-name-nondirectory user-init-file-1)
848 (file-name-as-directory
849 (expand-file-name
850 ".emacs.d"
851 (file-name-directory user-init-file-1))))))
852 (load otherfile t t)
854 ;; If we did not find the user's init file,
855 ;; set user-init-file conclusively.
856 ;; Don't let it be set from default.el.
857 (when (eq user-init-file t)
858 (setq user-init-file user-init-file-1))))
860 ;; If we loaded a compiled file, set
861 ;; `user-init-file' to the source version if that
862 ;; exists.
863 (when (and user-init-file
864 (equal (file-name-extension user-init-file)
865 "elc"))
866 (let* ((source (file-name-sans-extension user-init-file))
867 (alt (concat source ".el")))
868 (setq source (cond ((file-exists-p alt) alt)
869 ((file-exists-p source) source)
870 (t nil)))
871 (when source
872 (when (file-newer-than-file-p source user-init-file)
873 (message "Warning: %s is newer than %s"
874 source user-init-file)
875 (sit-for 1))
876 (setq user-init-file source))))
878 (unless inhibit-default-init
879 (let ((inhibit-startup-message nil))
880 ;; Users are supposed to be told their rights.
881 ;; (Plus how to get help and how to undo.)
882 ;; Don't you dare turn this off for anyone
883 ;; except yourself.
884 (load "default" t t)))))))))
885 (if init-file-debug
886 ;; Do this without a condition-case if the user wants to debug.
887 (funcall inner)
888 (condition-case error
889 (progn
890 (funcall inner)
891 (setq init-file-had-error nil))
892 (error
893 (let ((message-log-max nil))
894 (save-excursion
895 (set-buffer (get-buffer-create "*Messages*"))
896 (insert "\n\n"
897 (format "An error has occurred while loading `%s':\n\n"
898 user-init-file)
899 (format "%s%s%s"
900 (get (car error) 'error-message)
901 (if (cdr error) ": " "")
902 (mapconcat (lambda (s) (prin1-to-string s t)) (cdr error) ", "))
903 "\n\n"
904 "To ensure normal operation, you should investigate and remove the\n"
905 "cause of the error in your initialization file. Start Emacs with\n"
906 "the `--debug-init' option to view a complete error backtrace.\n\n"))
907 (message "Error in init file: %s%s%s"
908 (get (car error) 'error-message)
909 (if (cdr error) ": " "")
910 (mapconcat 'prin1-to-string (cdr error) ", "))
911 (let ((pop-up-windows nil))
912 (pop-to-buffer "*Messages*"))
913 (setq init-file-had-error t)))))
915 ;; If the user has a file of abbrevs, read it.
916 (if (file-exists-p abbrev-file-name)
917 (quietly-read-abbrev-file abbrev-file-name))
919 ;; If the abbrevs came entirely from the init file or the
920 ;; abbrevs file, they do not need saving.
921 (setq abbrevs-changed nil)
923 ;; If we can tell that the init file altered debug-on-error,
924 ;; arrange to preserve the value that it set up.
925 (or (eq debug-on-error debug-on-error-initial)
926 (setq debug-on-error-should-be-set t
927 debug-on-error-from-init-file debug-on-error)))
928 (if debug-on-error-should-be-set
929 (setq debug-on-error debug-on-error-from-init-file))
930 (unless (or default-enable-multibyte-characters
931 (eq orig-enable-multibyte default-enable-multibyte-characters))
932 ;; Init file changed to unibyte. Reset existing multibyte
933 ;; buffers (probably *scratch*, *Messages*, *Minibuff-0*).
934 ;; Arguably this should only be done if they're free of
935 ;; multibyte characters.
936 (mapcar (lambda (buffer)
937 (with-current-buffer buffer
938 (if enable-multibyte-characters
939 (set-buffer-multibyte nil))))
940 (buffer-list))
941 ;; Also re-set the language environment in case it was
942 ;; originally done before unibyte was set and is sensitive to
943 ;; unibyte (display table, terminal coding system &c).
944 (set-language-environment current-language-environment)))
946 ;; Do this here in case the init file sets mail-host-address.
947 (if (equal user-mail-address "")
948 (setq user-mail-address (concat (user-login-name) "@"
949 (or mail-host-address
950 (system-name)))))
952 ;; If parameter have been changed in the init file which influence
953 ;; face realization, clear the face cache so that new faces will
954 ;; be realized.
955 (unless (and (eq scalable-fonts-allowed old-scalable-fonts-allowed)
956 (eq font-list-limit old-font-list-limit)
957 (eq face-ignored-fonts old-face-ignored-fonts))
958 (clear-face-cache)))
960 (run-hooks 'after-init-hook)
962 ;; Decode all default-directory.
963 (if (and default-enable-multibyte-characters locale-coding-system)
964 (save-excursion
965 (dolist (elt (buffer-list))
966 (set-buffer elt)
967 (if default-directory
968 (setq default-directory
969 (decode-coding-string default-directory
970 locale-coding-system t))))
971 (setq command-line-default-directory
972 (decode-coding-string command-line-default-directory
973 locale-coding-system t))))
975 ;; If *scratch* exists and init file didn't change its mode, initialize it.
976 (if (get-buffer "*scratch*")
977 (with-current-buffer "*scratch*"
978 (if (eq major-mode 'fundamental-mode)
979 (funcall initial-major-mode))))
981 ;; Load library for our terminal type.
982 ;; User init file can set term-file-prefix to nil to prevent this.
983 (unless (or noninteractive
984 window-system
985 (null term-file-prefix))
986 (let ((term (getenv "TERM"))
987 hyphend)
988 (while (and term
989 (not (load (concat term-file-prefix term) t t)))
990 ;; Strip off last hyphen and what follows, then try again
991 (setq term
992 (if (setq hyphend (string-match "[-_][^-_]+$" term))
993 (substring term 0 hyphend)
994 nil)))))
996 ;; Update the out-of-memory error message based on user's key bindings
997 ;; for save-some-buffers.
998 (setq memory-signal-data
999 (list 'error
1000 (substitute-command-keys "Memory exhausted--use \\[save-some-buffers] then exit and restart Emacs")))
1002 ;; Process the remaining args.
1003 (command-line-1 (cdr command-line-args))
1005 ;; If -batch, terminate after processing the command options.
1006 (if noninteractive (kill-emacs t))
1008 ;; Run emacs-session-restore (session management) if started by
1009 ;; the session manager and we have a session manager connection.
1010 (if (and (boundp 'x-session-previous-id)
1011 (stringp x-session-previous-id))
1012 (with-no-warnings
1013 (emacs-session-restore x-session-previous-id))))
1015 (defcustom initial-scratch-message (purecopy "\
1016 ;; This buffer is for notes you don't want to save, and for Lisp evaluation.
1017 ;; If you want to create a file, visit that file with C-x C-f,
1018 ;; then enter the text in that file's own buffer.
1021 "Initial message displayed in *scratch* buffer at startup.
1022 If this is nil, no message will be displayed."
1023 :type '(choice (text :tag "Message")
1024 (const :tag "none" nil))
1025 :group 'initialization)
1028 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1029 ;;; Fancy splash screen
1030 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1032 (defvar fancy-splash-text
1033 '((:face variable-pitch
1034 "You can do basic editing with the menu bar and scroll bar \
1035 using the mouse.\n\n"
1036 :face (variable-pitch :weight bold)
1037 "Important Help menu items:\n"
1038 :face variable-pitch
1039 (lambda ()
1040 (let* ((en "TUTORIAL")
1041 (tut (or (get-language-info current-language-environment
1042 'tutorial)
1043 en))
1044 (title (with-temp-buffer
1045 (insert-file-contents
1046 (expand-file-name tut data-directory)
1047 nil 0 256)
1048 (search-forward ".")
1049 (buffer-substring (point-min) (1- (point))))))
1050 ;; If there is a specific tutorial for the current language
1051 ;; environment and it is not English, append its title.
1052 (concat
1053 "Emacs Tutorial\tLearn how to use Emacs efficiently"
1054 (if (string= en tut)
1056 (concat " (" title ")"))
1057 "\n")))
1058 :face variable-pitch "\
1059 Emacs FAQ\tFrequently asked questions and answers
1060 Read the Emacs Manual\tView the Emacs manual using Info
1061 \(Non)Warranty\tGNU Emacs comes with "
1062 :face (variable-pitch :slant oblique)
1063 "ABSOLUTELY NO WARRANTY\n"
1064 :face variable-pitch
1066 Copying Conditions\tConditions for redistributing and changing Emacs
1067 More Manuals / Ordering Manuals Buying printed manuals from the FSF\n")
1068 (:face variable-pitch
1069 "You can do basic editing with the menu bar and scroll bar \
1070 using the mouse.\n\n"
1071 :face (variable-pitch :weight bold)
1072 "Useful File menu items:\n"
1073 :face variable-pitch "\
1074 Exit Emacs\t(Or type Control-x followed by Control-c)
1075 Recover Crashed Session\tRecover files you were editing before a crash
1082 "A list of texts to show in the middle part of splash screens.
1083 Each element in the list should be a list of strings or pairs
1084 `:face FACE', like `fancy-splash-insert' accepts them.")
1087 (defgroup fancy-splash-screen ()
1088 "Fancy splash screen when Emacs starts."
1089 :version "21.1"
1090 :group 'initialization)
1093 (defcustom fancy-splash-delay 7
1094 "*Delay in seconds between splash screens."
1095 :group 'fancy-splash-screen
1096 :type 'integer)
1099 (defcustom fancy-splash-max-time 30
1100 "*Show splash screens for at most this number of seconds.
1101 Values less than twice `fancy-splash-delay' are ignored."
1102 :group 'fancy-splash-screen
1103 :type 'integer)
1106 (defcustom fancy-splash-image nil
1107 "*The image to show in the splash screens, or nil for defaults."
1108 :group 'fancy-splash-screen
1109 :type '(choice (const :tag "Default" nil)
1110 (file :tag "File")))
1113 ;; These are temporary storage areas for the splash screen display.
1115 (defvar fancy-current-text nil)
1116 (defvar fancy-splash-help-echo nil)
1117 (defvar fancy-splash-stop-time nil)
1118 (defvar fancy-splash-outer-buffer nil)
1120 (defun fancy-splash-insert (&rest args)
1121 "Insert text into the current buffer, with faces.
1122 Arguments from ARGS should be either strings, functions called
1123 with no args that return a string, or pairs `:face FACE',
1124 where FACE is a valid face specification, as it can be used with
1125 `put-text-property'."
1126 (let ((current-face nil))
1127 (while args
1128 (if (eq (car args) :face)
1129 (setq args (cdr args) current-face (car args))
1130 (insert (propertize (let ((it (car args)))
1131 (if (functionp it)
1132 (funcall it)
1133 it))
1134 'face current-face
1135 'help-echo fancy-splash-help-echo)))
1136 (setq args (cdr args)))))
1139 (defun fancy-splash-head ()
1140 "Insert the head part of the splash screen into the current buffer."
1141 (let* ((image-file (cond ((stringp fancy-splash-image)
1142 fancy-splash-image)
1143 ((and (display-color-p)
1144 (image-type-available-p 'xpm))
1145 (if (and (fboundp 'x-display-planes)
1146 (= (funcall 'x-display-planes) 8))
1147 "splash8.xpm"
1148 "splash.xpm"))
1149 (t "splash.pbm")))
1150 (img (create-image image-file))
1151 (image-width (and img (car (image-size img))))
1152 (window-width (window-width (selected-window))))
1153 (when img
1154 (when (> window-width image-width)
1155 ;; Center the image in the window.
1156 (insert (propertize " " 'display
1157 `(space :align-to (+ center (-0.5 . ,img)))))
1159 ;; Change the color of the XPM version of the splash image
1160 ;; so that it is visible with a dark frame background.
1161 (when (and (memq 'xpm img)
1162 (eq (frame-parameter nil 'background-mode) 'dark))
1163 (setq img (append img '(:color-symbols (("#000000" . "gray30"))))))
1165 ;; Insert the image with a help-echo and a keymap.
1166 (let ((map (make-sparse-keymap))
1167 (help-echo "mouse-2: browse http://www.gnu.org/"))
1168 (define-key map [mouse-2]
1169 (lambda ()
1170 (interactive)
1171 (browse-url "http://www.gnu.org/")
1172 (throw 'exit nil)))
1173 (define-key map [down-mouse-2] 'ignore)
1174 (define-key map [up-mouse-2] 'ignore)
1175 (insert-image img (propertize "xxx" 'help-echo help-echo
1176 'keymap map)))
1177 (insert "\n"))))
1178 (fancy-splash-insert
1179 :face '(variable-pitch :foreground "red")
1180 (if (eq system-type 'gnu/linux)
1181 "GNU Emacs is one component of the GNU/Linux operating system."
1182 "GNU Emacs is one component of the GNU operating system."))
1183 (insert "\n")
1184 (unless (equal (buffer-name fancy-splash-outer-buffer) "*scratch*")
1185 (fancy-splash-insert :face 'variable-pitch
1186 (substitute-command-keys
1187 "Type \\[recenter] to begin editing your file.\n"))))
1190 (defun fancy-splash-tail ()
1191 "Insert the tail part of the splash screen into the current buffer."
1192 (let ((fg (if (eq (frame-parameter nil 'background-mode) 'dark)
1193 "cyan" "darkblue")))
1194 (fancy-splash-insert :face `(variable-pitch :foreground ,fg)
1195 "\nThis is "
1196 (emacs-version)
1197 "\n"
1198 :face '(variable-pitch :height 0.5)
1199 "Copyright (C) 2005 Free Software Foundation, Inc.")
1200 (and auto-save-list-file-prefix
1201 ;; Don't signal an error if the
1202 ;; directory for auto-save-list files
1203 ;; does not yet exist.
1204 (file-directory-p (file-name-directory
1205 auto-save-list-file-prefix))
1206 (directory-files
1207 (file-name-directory auto-save-list-file-prefix)
1209 (concat "\\`"
1210 (regexp-quote (file-name-nondirectory
1211 auto-save-list-file-prefix)))
1213 (fancy-splash-insert :face '(variable-pitch :foreground "red")
1214 "\n\nIf an Emacs session crashed recently, "
1215 "type M-x recover-session RET\nto recover"
1216 " the files you were editing."))))
1218 (defun fancy-splash-screens-1 (buffer)
1219 "Timer function displaying a splash screen."
1220 (when (> (float-time) fancy-splash-stop-time)
1221 (throw 'stop-splashing nil))
1222 (unless fancy-current-text
1223 (setq fancy-current-text fancy-splash-text))
1224 (let ((text (car fancy-current-text)))
1225 (set-buffer buffer)
1226 (erase-buffer)
1227 (if pure-space-overflow
1228 (insert "Warning Warning Pure space overflow Warning Warning\n"))
1229 (fancy-splash-head)
1230 (apply #'fancy-splash-insert text)
1231 (fancy-splash-tail)
1232 (unless (current-message)
1233 (message fancy-splash-help-echo))
1234 (set-buffer-modified-p nil)
1235 (goto-char (point-min))
1236 (force-mode-line-update)
1237 (setq fancy-current-text (cdr fancy-current-text))))
1240 (defun fancy-splash-default-action ()
1241 "Stop displaying the splash screen buffer.
1242 This is an internal function used to turn off the splash screen after
1243 the user caused an input event by hitting a key or clicking with the
1244 mouse."
1245 (interactive)
1246 (push last-command-event unread-command-events)
1247 (throw 'exit nil))
1250 (defun fancy-splash-screens ()
1251 "Display fancy splash screens when Emacs starts."
1252 (setq fancy-splash-help-echo (startup-echo-area-message))
1253 (let ((old-hourglass display-hourglass)
1254 (fancy-splash-outer-buffer (current-buffer))
1255 splash-buffer
1256 (old-minor-mode-map-alist minor-mode-map-alist)
1257 (frame (fancy-splash-frame))
1258 timer)
1259 (save-selected-window
1260 (select-frame frame)
1261 (switch-to-buffer "GNU Emacs")
1262 (setq tab-width 20)
1263 (setq splash-buffer (current-buffer))
1264 (catch 'stop-splashing
1265 (unwind-protect
1266 (let ((map (make-sparse-keymap)))
1267 (use-local-map map)
1268 (define-key map [switch-frame] 'ignore)
1269 (define-key map [t] 'fancy-splash-default-action)
1270 (define-key map [mouse-movement] 'ignore)
1271 (define-key map [mode-line t] 'ignore)
1272 (setq cursor-type nil
1273 display-hourglass nil
1274 minor-mode-map-alist nil
1275 buffer-undo-list t
1276 mode-line-format (propertize "---- %b %-"
1277 'face '(:weight bold))
1278 fancy-splash-stop-time (+ (float-time)
1279 fancy-splash-max-time)
1280 timer (run-with-timer 0 fancy-splash-delay
1281 #'fancy-splash-screens-1
1282 splash-buffer))
1283 (recursive-edit))
1284 (cancel-timer timer)
1285 (setq display-hourglass old-hourglass
1286 minor-mode-map-alist old-minor-mode-map-alist)
1287 (kill-buffer splash-buffer))))))
1289 (defun fancy-splash-frame ()
1290 "Return the frame to use for the fancy splash screen.
1291 Returning non-nil does not mean we should necessarily
1292 use the fancy splash screen, but if we do use it,
1293 we put it on this frame."
1294 (let (chosen-frame)
1295 (dolist (frame (append (frame-list) (list (selected-frame))))
1296 (if (and (frame-visible-p frame)
1297 (not (window-minibuffer-p (frame-selected-window frame))))
1298 (setq chosen-frame frame)))
1299 chosen-frame))
1301 (defun use-fancy-splash-screens-p ()
1302 "Return t if fancy splash screens should be used."
1303 (when (and (display-graphic-p)
1304 (or (and (display-color-p)
1305 (image-type-available-p 'xpm))
1306 (image-type-available-p 'pbm)))
1307 (let ((frame (fancy-splash-frame)))
1308 (when frame
1309 (let* ((img (create-image (or fancy-splash-image
1310 (if (and (display-color-p)
1311 (image-type-available-p 'xpm))
1312 "splash.xpm" "splash.pbm"))))
1313 (image-height (and img (cdr (image-size img))))
1314 (window-height (1- (window-height (frame-selected-window frame)))))
1315 (> window-height (+ image-height 19)))))))
1318 (defun normal-splash-screen ()
1319 "Display splash screen when Emacs starts."
1320 (let ((prev-buffer (current-buffer)))
1321 (unwind-protect
1322 (with-current-buffer (get-buffer-create "GNU Emacs")
1323 (let ((tab-width 8)
1324 (mode-line-format (propertize "---- %b %-"
1325 'face '(:weight bold))))
1327 (if pure-space-overflow
1328 (insert "Warning Warning Pure space overflow Warning Warning\n"))
1330 ;; The convention for this piece of code is that
1331 ;; each piece of output starts with one or two newlines
1332 ;; and does not end with any newlines.
1333 (insert "Welcome to GNU Emacs")
1334 (insert
1335 (if (eq system-type 'gnu/linux)
1336 ", one component of the GNU/Linux operating system.\n"
1337 ", a part of the GNU operating system.\n"))
1339 (unless (equal (buffer-name prev-buffer) "*scratch*")
1340 (insert (substitute-command-keys
1341 "\nType \\[recenter] to begin editing your file.\n")))
1343 (if (display-mouse-p)
1344 ;; The user can use the mouse to activate menus
1345 ;; so give help in terms of menu items.
1346 (progn
1347 (insert "\
1348 You can do basic editing with the menu bar and scroll bar using the mouse.
1350 Useful File menu items:
1351 Exit Emacs (or type Control-x followed by Control-c)
1352 Recover Session recover files you were editing before a crash
1354 Important Help menu items:
1355 Emacs Tutorial Learn-by-doing tutorial for using Emacs efficiently.
1356 Emacs FAQ Frequently asked questions and answers
1357 Read the Emacs Manual View the Emacs manual using Info
1358 \(Non)Warranty GNU Emacs comes with ABSOLUTELY NO WARRANTY
1359 Copying Conditions Conditions for redistributing and changing Emacs.
1360 Getting New Versions How to obtain the latest version of Emacs.
1361 More Manuals / Ordering Manuals How to order printed manuals from the FSF.
1363 (insert "\n\n" (emacs-version)
1365 Copyright (C) 2004 Free Software Foundation, Inc."))
1367 ;; No mouse menus, so give help using kbd commands.
1369 ;; If keys have their default meanings,
1370 ;; use precomputed string to save lots of time.
1371 (if (and (eq (key-binding "\C-h") 'help-command)
1372 (eq (key-binding "\C-xu") 'advertised-undo)
1373 (eq (key-binding "\C-x\C-c") 'save-buffers-kill-emacs)
1374 (eq (key-binding "\C-ht") 'help-with-tutorial)
1375 (eq (key-binding "\C-hi") 'info)
1376 (eq (key-binding "\C-hr") 'info-emacs-manual)
1377 (eq (key-binding "\C-h\C-n") 'view-emacs-news))
1378 (insert "
1379 Get help C-h (Hold down CTRL and press h)
1380 Emacs manual C-h r
1381 Emacs tutorial C-h t Undo changes C-x u
1382 Buy manuals C-h C-m Exit Emacs C-x C-c
1383 Browse manuals C-h i")
1385 (insert (substitute-command-keys
1386 (format "\n
1387 Get help %s
1388 Emacs manual \\[info-emacs-manual]
1389 Emacs tutorial \\[help-with-tutorial]\tUndo changes\t\\[advertised-undo]
1390 Buy manuals \\[view-order-manuals]\tExit Emacs\t\\[save-buffers-kill-emacs]
1391 Browse manuals \\[info]"
1392 (let ((where (where-is-internal
1393 'help-command nil t)))
1394 (if where
1395 (key-description where)
1396 "M-x help"))))))
1398 ;; Say how to use the menu bar with the keyboard.
1399 (if (and (eq (key-binding "\M-`") 'tmm-menubar)
1400 (eq (key-binding [f10]) 'tmm-menubar))
1401 (insert "
1402 Activate menubar F10 or ESC ` or M-`")
1403 (insert (substitute-command-keys "
1404 Activate menubar \\[tmm-menubar]")))
1406 ;; Many users seem to have problems with these.
1407 (insert "
1408 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
1409 If you have no Meta key, you may instead type ESC followed by the character.)")
1411 (insert "\n\n" (emacs-version)
1413 Copyright (C) 2004 Free Software Foundation, Inc.")
1415 (if (and (eq (key-binding "\C-h\C-c") 'describe-copying)
1416 (eq (key-binding "\C-h\C-d") 'describe-distribution)
1417 (eq (key-binding "\C-h\C-w") 'describe-no-warranty))
1418 (insert
1420 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for full details.
1421 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
1422 of Emacs and modify it; type C-h C-c to see the conditions.
1423 Type C-h C-d for information on getting the latest version.")
1424 (insert (substitute-command-keys
1426 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for full details.
1427 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
1428 of Emacs and modify it; type \\[describe-copying] to see the conditions.
1429 Type \\[describe-distribution] for information on getting the latest version."))))
1431 ;; The rest of the startup screen is the same on all
1432 ;; kinds of terminals.
1434 ;; Give information on recovering, if there was a crash.
1435 (and auto-save-list-file-prefix
1436 ;; Don't signal an error if the
1437 ;; directory for auto-save-list files
1438 ;; does not yet exist.
1439 (file-directory-p (file-name-directory
1440 auto-save-list-file-prefix))
1441 (directory-files
1442 (file-name-directory auto-save-list-file-prefix)
1444 (concat "\\`"
1445 (regexp-quote (file-name-nondirectory
1446 auto-save-list-file-prefix)))
1448 (insert "\n\nIf an Emacs session crashed recently, "
1449 "type M-x recover-session RET\nto recover"
1450 " the files you were editing."))
1452 ;; Display the input that we set up in the buffer.
1453 (set-buffer-modified-p nil)
1454 (goto-char (point-min))
1455 (save-window-excursion
1456 (switch-to-buffer (current-buffer))
1457 (sit-for 120))))
1458 ;; Unwind ... ensure splash buffer is killed
1459 (kill-buffer "GNU Emacs"))))
1462 (defun startup-echo-area-message ()
1463 (if (eq (key-binding "\C-h\C-p") 'describe-project)
1464 "For information about the GNU Project and its goals, type C-h C-p."
1465 (substitute-command-keys
1466 "For information about the GNU Project and its goals, type \
1467 \\[describe-project].")))
1470 (defun display-startup-echo-area-message ()
1471 (let ((resize-mini-windows t))
1472 (message (startup-echo-area-message))))
1475 (defun display-splash-screen ()
1476 "Display splash screen according to display.
1477 Fancy splash screens are used on graphic displays,
1478 normal otherwise."
1479 (interactive)
1480 (if (use-fancy-splash-screens-p)
1481 (fancy-splash-screens)
1482 (normal-splash-screen)))
1485 (defun command-line-1 (command-line-args-left)
1486 (or noninteractive (input-pending-p) init-file-had-error
1487 ;; t if the init file says to inhibit the echo area startup message.
1488 (and inhibit-startup-echo-area-message
1489 user-init-file
1490 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
1491 (equal inhibit-startup-echo-area-message
1492 (if (equal init-file-user "")
1493 (user-login-name)
1494 init-file-user)))
1495 ;; Wasn't set with custom; see if .emacs has a setq.
1496 (let ((buffer (get-buffer-create " *temp*")))
1497 (prog1
1498 (condition-case nil
1499 (save-excursion
1500 (set-buffer buffer)
1501 (insert-file-contents user-init-file)
1502 (re-search-forward
1503 (concat
1504 "([ \t\n]*setq[ \t\n]+"
1505 "inhibit-startup-echo-area-message[ \t\n]+"
1506 (regexp-quote
1507 (prin1-to-string
1508 (if (equal init-file-user "")
1509 (user-login-name)
1510 init-file-user)))
1511 "[ \t\n]*)")
1512 nil t))
1513 (error nil))
1514 (kill-buffer buffer)))))
1515 ;; display-splash-screen at the end of command-line-1 calls
1516 ;; use-fancy-splash-screens-p. This can cause image.el to be
1517 ;; loaded, putting "Loading image... done" in the echo area.
1518 ;; This hides startup-echo-area-message. So
1519 ;; use-fancy-splash-screens-p is called here simply to get the
1520 ;; loading of image.el (if needed) out of the way before
1521 ;; display-startup-echo-area-message runs.
1522 (progn
1523 (use-fancy-splash-screens-p)
1524 (display-startup-echo-area-message)))
1526 ;; Delay 2 seconds after an init file error message
1527 ;; was displayed, so user can read it.
1528 (when init-file-had-error
1529 (sit-for 2))
1531 (when command-line-args-left
1532 ;; We have command args; process them.
1533 (let ((dir command-line-default-directory)
1534 (file-count 0)
1535 first-file-buffer
1537 ;; This approach loses for "-batch -L DIR --eval "(require foo)",
1538 ;; if foo is intended to be found in DIR.
1540 ;; ;; The directories listed in --directory/-L options will *appear*
1541 ;; ;; at the front of `load-path' in the order they appear on the
1542 ;; ;; command-line. We cannot do this by *placing* them at the front
1543 ;; ;; in the order they appear, so we need this variable to hold them,
1544 ;; ;; temporarily.
1545 ;; extra-load-path
1547 ;; To DTRT we keep track of the splice point and modify `load-path'
1548 ;; straight away upon any --directory/-L option.
1549 splice
1550 just-files ;; t if this follows the magic -- option.
1551 ;; This includes our standard options' long versions
1552 ;; and long versions of what's on command-switch-alist.
1553 (longopts
1554 (append '(("--funcall") ("--load") ("--insert") ("--kill")
1555 ("--directory") ("--eval") ("--execute") ("--no-splash")
1556 ("--find-file") ("--visit") ("--file"))
1557 (mapcar (lambda (elt)
1558 (list (concat "-" (car elt))))
1559 command-switch-alist)))
1560 (line 0)
1561 (column 0))
1563 ;; Add the long X options to longopts.
1564 (dolist (tem command-line-x-option-alist)
1565 (if (string-match "^--" (car tem))
1566 (push (list (car tem)) longopts)))
1568 ;; Loop, processing options.
1569 (while command-line-args-left
1570 (let* ((argi (car command-line-args-left))
1571 (orig-argi argi)
1572 argval completion)
1573 (setq command-line-args-left (cdr command-line-args-left))
1575 ;; Do preliminary decoding of the option.
1576 (if just-files
1577 ;; After --, don't look for options; treat all args as files.
1578 (setq argi "")
1579 ;; Convert long options to ordinary options
1580 ;; and separate out an attached option argument into argval.
1581 (when (string-match "^\\(--[^=]*\\)=" argi)
1582 (setq argval (substring argi (match-end 0))
1583 argi (match-string 1 argi)))
1584 (if (equal argi "--")
1585 (setq completion nil)
1586 (setq completion (try-completion argi longopts)))
1587 (if (eq completion t)
1588 (setq argi (substring argi 1))
1589 (if (stringp completion)
1590 (let ((elt (assoc completion longopts)))
1591 (or elt
1592 (error "Option `%s' is ambiguous" argi))
1593 (setq argi (substring (car elt) 1)))
1594 (setq argval nil
1595 argi orig-argi))))
1597 ;; Execute the option.
1598 (cond ((setq tem (assoc argi command-switch-alist))
1599 (if argval
1600 (let ((command-line-args-left
1601 (cons argval command-line-args-left)))
1602 (funcall (cdr tem) argi))
1603 (funcall (cdr tem) argi)))
1605 ((equal argi "-no-splash")
1606 (setq inhibit-startup-message t))
1608 ((member argi '("-f" ; what the manual claims
1609 "-funcall"
1610 "-e")) ; what the source used to say
1611 (setq tem (intern (or argval (pop command-line-args-left))))
1612 (if (commandp tem)
1613 (command-execute tem)
1614 (funcall tem)))
1616 ((member argi '("-eval" "-execute"))
1617 (eval (read (or argval (pop command-line-args-left)))))
1619 ((member argi '("-L" "-directory"))
1620 (setq tem (expand-file-name
1621 (command-line-normalize-file-name
1622 (or argval (pop command-line-args-left)))))
1623 (cond (splice (setcdr splice (cons tem (cdr splice)))
1624 (setq splice (cdr splice)))
1625 (t (setq load-path (cons tem load-path)
1626 splice load-path))))
1628 ((member argi '("-l" "-load"))
1629 (let* ((file (command-line-normalize-file-name
1630 (or argval (pop command-line-args-left))))
1631 ;; Take file from default dir if it exists there;
1632 ;; otherwise let `load' search for it.
1633 (file-ex (expand-file-name file)))
1634 (when (file-exists-p file-ex)
1635 (setq file file-ex))
1636 (load file nil t)))
1638 ((equal argi "-insert")
1639 (setq tem (or argval (pop command-line-args-left)))
1640 (or (stringp tem)
1641 (error "File name omitted from `-insert' option"))
1642 (insert-file-contents (command-line-normalize-file-name tem)))
1644 ((equal argi "-kill")
1645 (kill-emacs t))
1647 ((string-match "^\\+[0-9]+\\'" argi)
1648 (setq line (string-to-number argi)))
1650 ((string-match "^\\+\\([0-9]+\\):\\([0-9]+\\)\\'" argi)
1651 (setq line (string-to-number (match-string 1 argi))
1652 column (string-to-number (match-string 2 argi))))
1654 ((setq tem (assoc argi command-line-x-option-alist))
1655 ;; Ignore X-windows options and their args if not using X.
1656 (setq command-line-args-left
1657 (nthcdr (nth 1 tem) command-line-args-left)))
1659 ((member argi '("-find-file" "-file" "-visit"))
1660 ;; An explicit option to specify visiting a file.
1661 (setq tem (or argval (pop command-line-args-left)))
1662 (unless (stringp tem)
1663 (error "File name omitted from `%s' option" argi))
1664 (setq file-count (1+ file-count))
1665 (let ((file (expand-file-name
1666 (command-line-normalize-file-name tem) dir)))
1667 (if (= file-count 1)
1668 (setq first-file-buffer (find-file file))
1669 (find-file-other-window file)))
1670 (or (zerop line)
1671 (goto-line line))
1672 (setq line 0)
1673 (unless (< column 1)
1674 (move-to-column (1- column)))
1675 (setq column 0))
1677 ((equal argi "--")
1678 (setq just-files t))
1680 ;; We have almost exhausted our options. See if the
1681 ;; user has made any other command-line options available
1682 (let ((hooks command-line-functions) ;; lrs 7/31/89
1683 (did-hook nil))
1684 (while (and hooks
1685 (not (setq did-hook (funcall (car hooks)))))
1686 (setq hooks (cdr hooks)))
1687 (if (not did-hook)
1688 ;; Presume that the argument is a file name.
1689 (progn
1690 (if (string-match "\\`-" argi)
1691 (error "Unknown option `%s'" argi))
1692 (setq file-count (1+ file-count))
1693 (let ((file
1694 (expand-file-name
1695 (command-line-normalize-file-name orig-argi)
1696 dir)))
1697 (if (= file-count 1)
1698 (setq first-file-buffer (find-file file))
1699 (find-file-other-window file)))
1700 (or (zerop line)
1701 (goto-line line))
1702 (setq line 0)
1703 (unless (< column 1)
1704 (move-to-column (1- column)))
1705 (setq column 0))))))))
1707 ;; If 3 or more files visited, and not all visible,
1708 ;; show user what they all are. But leave the last one current.
1709 (and (> file-count 2)
1710 (not noninteractive)
1711 (not inhibit-startup-buffer-menu)
1712 (or (get-buffer-window first-file-buffer)
1713 (list-buffers)))))
1715 ;; Maybe display a startup screen.
1716 (unless (or inhibit-startup-message
1717 noninteractive
1718 emacs-quick-startup
1719 ;; Don't display startup screen if init file
1720 ;; has started some sort of server.
1721 (and (fboundp 'process-list)
1722 (process-list)))
1723 ;; Display a startup screen, after some preparations.
1725 ;; If there are no switches to process, we might as well
1726 ;; run this hook now, and there may be some need to do it
1727 ;; before doing any output.
1728 (run-hooks 'emacs-startup-hook)
1729 (and term-setup-hook
1730 (run-hooks 'term-setup-hook))
1731 (setq inhibit-startup-hooks t)
1733 ;; It's important to notice the user settings before we
1734 ;; display the startup message; otherwise, the settings
1735 ;; won't take effect until the user gives the first
1736 ;; keystroke, and that's distracting.
1737 (when (fboundp 'frame-notice-user-settings)
1738 (frame-notice-user-settings))
1740 ;; If there are no switches to process, we might as well
1741 ;; run this hook now, and there may be some need to do it
1742 ;; before doing any output.
1743 (when window-setup-hook
1744 (run-hooks 'window-setup-hook)
1745 ;; Don't let the hook be run twice.
1746 (setq window-setup-hook nil))
1748 ;; Do this now to avoid an annoying delay if the user
1749 ;; clicks the menu bar during the sit-for.
1750 (when (display-popup-menus-p)
1751 (precompute-menubar-bindings))
1752 (with-no-warnings
1753 (setq menubar-bindings-done t))
1755 ;; If *scratch* is selected and it is empty, insert an
1756 ;; initial message saying not to create a file there.
1757 (when (and initial-scratch-message
1758 (equal (buffer-name) "*scratch*")
1759 (= 0 (buffer-size)))
1760 (insert initial-scratch-message)
1761 (set-buffer-modified-p nil))
1763 ;; If user typed input during all that work,
1764 ;; abort the startup screen. Otherwise, display it now.
1765 (unless (input-pending-p)
1766 (display-splash-screen))))
1769 (defun command-line-normalize-file-name (file)
1770 "Collapse multiple slashes to one, to handle non-Emacs file names."
1771 (save-match-data
1772 ;; Use arg 1 so that we don't collapse // at the start of the file name.
1773 ;; That is significant on some systems.
1774 ;; However, /// at the beginning is supposed to mean just /, not //.
1775 (if (string-match "^///+" file)
1776 (setq file (replace-match "/" t t file)))
1777 (while (string-match "//+" file 1)
1778 (setq file (replace-match "/" t t file)))
1779 file))
1781 ;; arch-tag: 7e294698-244d-4758-984b-4047f887a5db
1782 ;;; startup.el ends here