Message format spec fixes (1)
[emacs.git] / lisp / startup.el
blob450159b36f25209a2fbfd28dddc374078499006d
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 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., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, 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 the proper function and keypad
188 keys for use under X. It is used in a fashion analogous to the
189 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 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 default-frame-background-mode)
292 (defvar pure-space-overflow nil
293 "Non-nil if building Emacs overflowed pure space.")
295 (defun normal-top-level-add-subdirs-to-load-path ()
296 "Add all subdirectories of current directory to `load-path'.
297 More precisely, this uses only the subdirectories whose names
298 start with letters or digits; it excludes any subdirectory named `RCS'
299 or `CVS', and any subdirectory that contains a file named `.nosearch'."
300 (let (dirs
301 attrs
302 (pending (list default-directory)))
303 ;; This loop does a breadth-first tree walk on DIR's subtree,
304 ;; putting each subdir into DIRS as its contents are examined.
305 (while pending
306 (push (pop pending) dirs)
307 (let* ((this-dir (car dirs))
308 (contents (directory-files this-dir))
309 (default-directory this-dir)
310 (canonicalized (if (fboundp 'untranslated-canonical-name)
311 (untranslated-canonical-name this-dir))))
312 ;; The Windows version doesn't report meaningful inode
313 ;; numbers, so use the canonicalized absolute file name of the
314 ;; directory instead.
315 (setq attrs (or canonicalized
316 (nthcdr 10 (file-attributes this-dir))))
317 (unless (member attrs normal-top-level-add-subdirs-inode-list)
318 (push attrs normal-top-level-add-subdirs-inode-list)
319 (dolist (file contents)
320 ;; The lower-case variants of RCS and CVS are for DOS/Windows.
321 (unless (member file '("." ".." "RCS" "CVS" "rcs" "cvs"))
322 (when (and (string-match "\\`[[:alnum:]]" file)
323 ;; Avoid doing a `stat' when it isn't necessary
324 ;; because that can cause trouble when an NFS server
325 ;; is down.
326 (not (string-match "\\.elc?\\'" file))
327 (file-directory-p file))
328 (let ((expanded (expand-file-name file)))
329 (unless (file-exists-p (expand-file-name ".nosearch"
330 expanded))
331 (setq pending (nconc pending (list expanded)))))))))))
332 (normal-top-level-add-to-load-path (cdr (nreverse dirs)))))
334 ;; This function is called from a subdirs.el file.
335 ;; It assumes that default-directory is the directory
336 ;; in which the subdirs.el file exists,
337 ;; and it adds to load-path the subdirs of that directory
338 ;; as specified in DIRS. Normally the elements of DIRS are relative.
339 (defun normal-top-level-add-to-load-path (dirs)
340 (let ((tail load-path)
341 (thisdir (directory-file-name default-directory)))
342 (while (and tail
343 ;;Don't go all the way to the nil terminator.
344 (cdr tail)
345 (not (equal thisdir (car tail)))
346 (not (and (memq system-type '(ms-dos windows-nt))
347 (equal (downcase thisdir) (downcase (car tail))))))
348 (setq tail (cdr tail)))
349 ;;Splice the new section in.
350 (when tail
351 (setcdr tail (append (mapcar 'expand-file-name dirs) (cdr tail))))))
353 (defun normal-top-level ()
354 (if command-line-processed
355 (message "Back to top level.")
356 (setq command-line-processed t)
357 ;; Give *Messages* the same default-directory as *scratch*,
358 ;; just to keep things predictable.
359 (let ((dir default-directory))
360 (with-current-buffer "*Messages*"
361 (setq default-directory dir)))
362 ;; `user-full-name' is now known; reset its standard-value here.
363 (put 'user-full-name 'standard-value
364 (list (default-value 'user-full-name)))
365 ;; For root, preserve owner and group when editing files.
366 (if (equal (user-uid) 0)
367 (setq backup-by-copying-when-mismatch t))
368 ;; Look in each dir in load-path for a subdirs.el file.
369 ;; If we find one, load it, which will add the appropriate subdirs
370 ;; of that dir into load-path,
371 ;; Look for a leim-list.el file too. Loading it will register
372 ;; available input methods.
373 (let ((tail load-path) dir)
374 (while tail
375 (setq dir (car tail))
376 (let ((default-directory dir))
377 (load (expand-file-name "subdirs.el") t t t))
378 (let ((default-directory dir))
379 (load (expand-file-name "leim-list.el") t t t))
380 ;; We don't use a dolist loop and we put this "setq-cdr" command at
381 ;; the end, because the subdirs.el files may add elements to the end
382 ;; of load-path and we want to take it into account.
383 (setq tail (cdr tail))))
384 (unless (eq system-type 'vax-vms)
385 ;; If the PWD environment variable isn't accurate, delete it.
386 (let ((pwd (getenv "PWD")))
387 (and (stringp pwd)
388 ;; Use FOO/., so that if FOO is a symlink, file-attributes
389 ;; describes the directory linked to, not FOO itself.
390 (or (equal (file-attributes
391 (concat (file-name-as-directory pwd) "."))
392 (file-attributes
393 (concat (file-name-as-directory default-directory)
394 ".")))
395 (setq process-environment
396 (delete (concat "PWD=" pwd)
397 process-environment))))))
398 (setq default-directory (abbreviate-file-name default-directory))
399 (let ((menubar-bindings-done nil))
400 (unwind-protect
401 (command-line)
402 ;; Do this again, in case .emacs defined more abbreviations.
403 (setq default-directory (abbreviate-file-name default-directory))
404 ;; Specify the file for recording all the auto save files of this session.
405 ;; This is used by recover-session.
406 (or auto-save-list-file-name
407 (and auto-save-list-file-prefix
408 (setq auto-save-list-file-name
409 ;; Under MS-DOS our PID is almost always reused between
410 ;; Emacs invocations. We need something more unique.
411 (cond ((eq system-type 'ms-dos)
412 ;; We are going to access the auto-save
413 ;; directory, so make sure it exists.
414 (make-directory
415 (file-name-directory auto-save-list-file-prefix)
417 (concat
418 (make-temp-name
419 (expand-file-name
420 auto-save-list-file-prefix))
421 "~"))
423 (expand-file-name
424 (format "%s%d-%s~"
425 auto-save-list-file-prefix
426 (emacs-pid)
427 (system-name))))))))
428 (unless inhibit-startup-hooks
429 (run-hooks 'emacs-startup-hook)
430 (and term-setup-hook
431 (run-hooks 'term-setup-hook)))
433 ;; Don't do this if we failed to create the initial frame,
434 ;; for instance due to a dense colormap.
435 (when (or frame-initial-frame
436 ;; If frame-initial-frame has no meaning, do this anyway.
437 (not (and window-system
438 (not noninteractive)
439 (not (eq window-system 'pc)))))
440 ;; Modify the initial frame based on what .emacs puts into
441 ;; ...-frame-alist.
442 (if (fboundp 'frame-notice-user-settings)
443 (frame-notice-user-settings))
444 (if (fboundp 'frame-set-background-mode)
445 ;; Set the faces for the initial background mode even if
446 ;; frame-notice-user-settings didn't (such as on a tty).
447 ;; frame-set-background-mode is idempotent, so it won't
448 ;; cause any harm if it's already been done.
449 (let ((frame (selected-frame))
450 term)
451 (when (and (null window-system)
452 ;; Don't override default set by files in lisp/term.
453 (null default-frame-background-mode)
454 (let ((bg (frame-parameter frame 'background-color)))
455 (or (null bg)
456 (member bg '(unspecified "unspecified-bg"
457 "unspecified-fg")))))
459 (setq term (getenv "TERM"))
460 ;; Some files in lisp/term do a better job with the
461 ;; background mode, but we leave this here anyway, in
462 ;; case they remove those files.
463 (if (string-match "^\\(xterm\\|rxvt\\|dtterm\\|eterm\\)"
464 term)
465 (setq default-frame-background-mode 'light)))
466 (frame-set-background-mode (selected-frame)))))
468 ;; Now we know the user's default font, so add it to the menu.
469 (if (fboundp 'font-menu-add-default)
470 (font-menu-add-default))
471 (and window-setup-hook
472 (run-hooks 'window-setup-hook))
473 (or menubar-bindings-done
474 (if (display-popup-menus-p)
475 (precompute-menubar-bindings)))))))
477 ;; Precompute the keyboard equivalents in the menu bar items.
478 (defun precompute-menubar-bindings ()
479 (let ((submap (lookup-key global-map [menu-bar])))
480 (while submap
481 (and (consp (car submap))
482 (symbolp (car (car submap)))
483 (stringp (car-safe (cdr (car submap))))
484 (keymapp (cdr (cdr (car submap))))
485 (progn
486 (x-popup-menu nil (cdr (cdr (car submap))))
487 (if purify-flag
488 (garbage-collect))))
489 (setq submap (cdr submap))))
490 (setq define-key-rebound-commands t))
492 ;; Command-line options supported by tty's:
493 (defconst tty-long-option-alist
494 '(("--name" . "-name")
495 ("--title" . "-T")
496 ("--reverse-video" . "-reverse")
497 ("--foreground-color" . "-fg")
498 ("--background-color" . "-bg")
499 ("--color" . "-color")))
501 (defconst tool-bar-images-pixel-height 24
502 "Height in pixels of images in the tool bar.")
504 (defvar tool-bar-originally-present nil
505 "Non-nil if tool-bars are present before user and site init files are read.")
507 ;; Handle the X-like command-line arguments "-fg", "-bg", "-name", etc.
508 (defun tty-handle-args (args)
509 (let (rest)
510 (message "%s" args)
511 (while (and args
512 (not (equal (car args) "--")))
513 (let* ((argi (pop args))
514 (orig-argi argi)
515 argval completion)
516 ;; Check for long options with attached arguments
517 ;; and separate out the attached option argument into argval.
518 (when (string-match "^\\(--[^=]*\\)=" argi)
519 (setq argval (substring argi (match-end 0))
520 argi (match-string 1 argi)))
521 (when (string-match "^--" argi)
522 (setq completion (try-completion argi tty-long-option-alist))
523 (if (eq completion t)
524 ;; Exact match for long option.
525 (setq argi (cdr (assoc argi tty-long-option-alist)))
526 (if (stringp completion)
527 (let ((elt (assoc completion tty-long-option-alist)))
528 ;; Check for abbreviated long option.
529 (or elt
530 (error "Option `%s' is ambiguous" argi))
531 (setq argi (cdr elt)))
532 ;; Check for a short option.
533 (setq argval nil
534 argi orig-argi))))
535 (cond ((member argi '("-fg" "-foreground"))
536 (push (cons 'foreground-color (or argval (pop args)))
537 default-frame-alist))
538 ((member argi '("-bg" "-background"))
539 (push (cons 'background-color (or argval (pop args)))
540 default-frame-alist))
541 ((member argi '("-T" "-name"))
542 (unless argval (setq argval (pop args)))
543 (push (cons 'title
544 (if (stringp argval)
545 argval
546 (let ((case-fold-search t)
548 (setq argval (invocation-name))
550 ;; Change any . or * characters in name to
551 ;; hyphens, so as to emulate behavior on X.
552 (while
553 (setq i (string-match "[.*]" argval))
554 (aset argval i ?-))
555 argval)))
556 default-frame-alist))
557 ((member argi '("-r" "-rv" "-reverse"))
558 (push '(reverse . t)
559 default-frame-alist))
560 ((equal argi "-color")
561 (unless argval (setq argval 8)) ; default --color means 8 ANSI colors
562 (push (cons 'tty-color-mode
563 (cond
564 ((numberp argval) argval)
565 ((string-match "-?[0-9]+" argval)
566 (string-to-number argval))
567 (t (intern argval))))
568 default-frame-alist))
570 (push argi rest)))))
571 (nreverse rest)))
573 (defun command-line ()
574 (setq command-line-default-directory default-directory)
576 ;; Choose a reasonable location for temporary files.
577 (custom-reevaluate-setting 'temporary-file-directory)
578 (custom-reevaluate-setting 'small-temporary-file-directory)
579 (custom-reevaluate-setting 'auto-save-file-name-transforms)
581 ;; See if we should import version-control from the environment variable.
582 (let ((vc (getenv "VERSION_CONTROL")))
583 (cond ((eq vc nil)) ;don't do anything if not set
584 ((member vc '("t" "numbered"))
585 (setq version-control t))
586 ((member vc '("nil" "existing"))
587 (setq version-control nil))
588 ((member vc '("never" "simple"))
589 (setq version-control 'never))))
591 ;;! This has been commented out; I currently find the behavior when
592 ;;! split-window-keep-point is nil disturbing, but if I can get used
593 ;;! to it, then it would be better to eliminate the option.
594 ;;! ;; Choose a good default value for split-window-keep-point.
595 ;;! (setq split-window-keep-point (> baud-rate 2400))
597 ;; Set the default strings to display in mode line for
598 ;; end-of-line formats that aren't native to this platform.
599 (cond
600 ((memq system-type '(ms-dos windows-nt emx))
601 (setq eol-mnemonic-unix "(Unix)"
602 eol-mnemonic-mac "(Mac)"))
603 ;; Both Mac and Unix EOLs are now "native" on Mac OS so keep the
604 ;; abbreviated strings `/' and `:' set in coding.c for them.
605 ((eq system-type 'macos)
606 (setq eol-mnemonic-dos "(DOS)"))
607 (t ; this is for Unix/GNU/Linux systems
608 (setq eol-mnemonic-dos "(DOS)"
609 eol-mnemonic-mac "(Mac)")))
611 ;; Read window system's init file if using a window system.
612 (condition-case error
613 (if (and window-system (not noninteractive))
614 (load (concat term-file-prefix
615 (symbol-name window-system)
616 "-win")
617 ;; Every window system should have a startup file;
618 ;; barf if we can't find it.
619 nil t))
620 ;; If we can't read it, print the error message and exit.
621 (error
622 (princ
623 (if (eq (car error) 'error)
624 (apply 'concat (cdr error))
625 (if (memq 'file-error (get (car error) 'error-conditions))
626 (format "%s: %s"
627 (nth 1 error)
628 (mapconcat (lambda (obj) (prin1-to-string obj t))
629 (cdr (cdr error)) ", "))
630 (format "%s: %s"
631 (get (car error) 'error-message)
632 (mapconcat (lambda (obj) (prin1-to-string obj t))
633 (cdr error) ", "))))
634 'external-debugging-output)
635 (terpri 'external-debugging-output)
636 (setq window-system nil)
637 (kill-emacs)))
639 ;; Windowed displays do this inside their *-win.el.
640 (unless (or (display-graphic-p) noninteractive)
641 (setq command-line-args (tty-handle-args command-line-args)))
643 (set-locale-environment nil)
645 ;; Convert the arguments to Emacs internal representation.
646 (let ((args (cdr command-line-args)))
647 (while args
648 (setcar args
649 (decode-coding-string (car args) locale-coding-system t))
650 (pop args)))
652 (let ((done nil)
653 (args (cdr command-line-args)))
655 ;; Figure out which user's init file to load,
656 ;; either from the environment or from the options.
657 (setq init-file-user (if noninteractive nil (user-login-name)))
658 ;; If user has not done su, use current $HOME to find .emacs.
659 (and init-file-user
660 (equal init-file-user (user-real-login-name))
661 (setq init-file-user ""))
663 ;; Process the command-line args, and delete the arguments
664 ;; processed. This is consistent with the way main in emacs.c
665 ;; does things.
666 (while (and (not done) args)
667 (let* ((longopts '(("--no-init-file") ("--no-site-file") ("--debug-init")
668 ("--user") ("--iconic") ("--icon-type") ("--quick")
669 ("--no-blinking-cursor") ("--basic-display")))
670 (argi (pop args))
671 (orig-argi argi)
672 argval)
673 ;; Handle --OPTION=VALUE format.
674 (when (string-match "^\\(--[^=]*\\)=" argi)
675 (setq argval (substring argi (match-end 0))
676 argi (match-string 1 argi)))
677 (unless (equal argi "--")
678 (let ((completion (try-completion argi longopts)))
679 (if (eq completion t)
680 (setq argi (substring argi 1))
681 (if (stringp completion)
682 (let ((elt (assoc completion longopts)))
683 (or elt
684 (error "Option `%s' is ambiguous" argi))
685 (setq argi (substring (car elt) 1)))
686 (setq argval nil
687 argi orig-argi)))))
688 (cond
689 ((member argi '("-Q" "-quick"))
690 (setq init-file-user nil
691 site-run-file nil
692 emacs-quick-startup t))
693 ((member argi '("-D" "-basic-display"))
694 (setq no-blinking-cursor t
695 emacs-basic-display t)
696 (push '(vertical-scroll-bars . nil) initial-frame-alist))
697 ((member argi '("-q" "-no-init-file"))
698 (setq init-file-user nil))
699 ((member argi '("-u" "-user"))
700 (setq init-file-user (or argval (pop args))
701 argval nil))
702 ((equal argi "-no-site-file")
703 (setq site-run-file nil))
704 ((equal argi "-debug-init")
705 (setq init-file-debug t))
706 ((equal argi "-iconic")
707 (push '(visibility . icon) initial-frame-alist))
708 ((member argi '("-icon-type" "-i" "-itype"))
709 (push '(icon-type . t) default-frame-alist))
710 ((member argi '("-nbc" "-no-blinking-cursor"))
711 (setq no-blinking-cursor t))
712 ;; Push the popped arg back on the list of arguments.
714 (push argi args)
715 (setq done t)))
716 ;; Was argval set but not used?
717 (and argval
718 (error "Option `%s' doesn't allow an argument" argi))))
720 ;; Re-attach the program name to the front of the arg list.
721 (and command-line-args
722 (setcdr command-line-args args)))
724 ;; Under X Window, this creates the X frame and deletes the terminal frame.
725 (when (fboundp 'frame-initialize)
726 (frame-initialize))
728 ;; Turn off blinking cursor if so specified in X resources. This is here
729 ;; only because all other settings of no-blinking-cursor are here.
730 (unless (or noninteractive
731 emacs-basic-display
732 (and (memq window-system '(x w32 mac))
733 (not (member (x-get-resource "cursorBlink" "CursorBlink")
734 '("off" "false")))))
735 (setq no-blinking-cursor t))
737 ;; If frame was created with a menu bar, set menu-bar-mode on.
738 (unless (or noninteractive
739 emacs-basic-display
740 (and (memq window-system '(x w32))
741 (<= (frame-parameter nil 'menu-bar-lines) 0)))
742 (menu-bar-mode 1))
744 ;; If frame was created with a tool bar, switch tool-bar-mode on.
745 (unless (or noninteractive
746 emacs-basic-display
747 (not (display-graphic-p))
748 (<= (frame-parameter nil 'tool-bar-lines) 0))
749 (tool-bar-mode 1))
751 ;; Can't do this init in defcustom because the relevant variables
752 ;; are not set.
753 (custom-reevaluate-setting 'blink-cursor-mode)
754 (custom-reevaluate-setting 'normal-erase-is-backspace)
755 (custom-reevaluate-setting 'tooltip-mode)
757 ;; Register default TTY colors for the case the terminal hasn't a
758 ;; terminal init file.
759 (unless (memq window-system '(x w32))
760 ;; We do this regardles of whether the terminal supports colors
761 ;; or not, since they can switch that support on or off in
762 ;; mid-session by setting the tty-color-mode frame parameter.
763 (tty-register-default-colors))
765 ;; Record whether the tool-bar is present before the user and site
766 ;; init files are processed. frame-notice-user-settings uses this
767 ;; to determine if the tool-bar has been disabled by the init files,
768 ;; and the frame needs to be resized.
769 (when (fboundp 'frame-notice-user-settings)
770 (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
771 (assq 'tool-bar-lines default-frame-alist))))
772 (setq tool-bar-originally-present
773 (and tool-bar-lines
774 (cdr tool-bar-lines)
775 (not (eq 0 (cdr tool-bar-lines)))))))
777 (let ((old-scalable-fonts-allowed scalable-fonts-allowed)
778 (old-font-list-limit font-list-limit)
779 (old-face-ignored-fonts face-ignored-fonts))
781 (run-hooks 'before-init-hook)
783 ;; Run the site-start library if it exists. The point of this file is
784 ;; that it is run before .emacs. There is no point in doing this after
785 ;; .emacs; that is useless.
786 (if site-run-file
787 (load site-run-file t t))
789 ;; Sites should not disable this. Only individuals should disable
790 ;; the startup message.
791 (setq inhibit-startup-message nil)
793 ;; Warn for invalid user name.
794 (and init-file-user
795 (not (file-directory-p (expand-file-name (concat "~" init-file-user))))
796 (display-warning 'initialization
797 (format "User %s has no home directory"
798 init-file-user)
799 :error))
801 ;; Load that user's init file, or the default one, or none.
802 (let (debug-on-error-from-init-file
803 debug-on-error-should-be-set
804 (debug-on-error-initial
805 (if (eq init-file-debug t) 'startup init-file-debug))
806 (orig-enable-multibyte default-enable-multibyte-characters))
807 (let ((debug-on-error debug-on-error-initial)
808 ;; This function actually reads the init files.
809 (inner
810 (function
811 (lambda ()
812 (if init-file-user
813 (let ((user-init-file-1
814 (cond
815 ((eq system-type 'ms-dos)
816 (concat "~" init-file-user "/_emacs"))
817 ((eq system-type 'windows-nt)
818 ;; Prefer .emacs on Windows.
819 (if (directory-files "~" nil "^\\.emacs\\(\\.elc?\\)?$")
820 "~/.emacs"
821 ;; Also support _emacs for compatibility.
822 (if (directory-files "~" nil "^_emacs\\(\\.elc?\\)?$")
823 "~/_emacs"
824 ;; But default to .emacs if _emacs does not exist.
825 "~/.emacs")))
826 ((eq system-type 'vax-vms)
827 "sys$login:.emacs")
829 (concat "~" init-file-user "/.emacs")))))
830 ;; This tells `load' to store the file name found
831 ;; into user-init-file.
832 (setq user-init-file t)
833 (load user-init-file-1 t t)
835 (when (eq user-init-file t)
836 ;; If we did not find ~/.emacs, try
837 ;; ~/.emacs.d/.emacs.
838 (let ((otherfile
839 (expand-file-name
840 (file-name-nondirectory user-init-file-1)
841 (file-name-as-directory
842 (expand-file-name
843 ".emacs.d"
844 (file-name-directory user-init-file-1))))))
845 (load otherfile t t)
847 ;; If we did not find the user's init file,
848 ;; set user-init-file conclusively.
849 ;; Don't let it be set from default.el.
850 (when (eq user-init-file t)
851 (setq user-init-file user-init-file-1))))
853 ;; If we loaded a compiled file, set
854 ;; `user-init-file' to the source version if that
855 ;; exists.
856 (when (and user-init-file
857 (equal (file-name-extension user-init-file)
858 "elc"))
859 (let* ((source (file-name-sans-extension user-init-file))
860 (alt (concat source ".el")))
861 (setq source (cond ((file-exists-p alt) alt)
862 ((file-exists-p source) source)
863 (t nil)))
864 (when source
865 (when (file-newer-than-file-p source user-init-file)
866 (message "Warning: %s is newer than %s"
867 source user-init-file)
868 (sit-for 1))
869 (setq user-init-file source))))
871 (unless inhibit-default-init
872 (let ((inhibit-startup-message nil))
873 ;; Users are supposed to be told their rights.
874 ;; (Plus how to get help and how to undo.)
875 ;; Don't you dare turn this off for anyone
876 ;; except yourself.
877 (load "default" t t)))))))))
878 (if init-file-debug
879 ;; Do this without a condition-case if the user wants to debug.
880 (funcall inner)
881 (condition-case error
882 (progn
883 (funcall inner)
884 (setq init-file-had-error nil))
885 (error
886 (let ((message-log-max nil))
887 (save-excursion
888 (set-buffer (get-buffer-create "*Messages*"))
889 (insert "\n\n"
890 (format "An error has occurred while loading `%s':\n\n"
891 user-init-file)
892 (format "%s%s%s"
893 (get (car error) 'error-message)
894 (if (cdr error) ": " "")
895 (mapconcat (lambda (s) (prin1-to-string s t)) (cdr error) ", "))
896 "\n\n"
897 "To ensure normal operation, you should investigate and remove the\n"
898 "cause of the error in your initialization file. Start Emacs with\n"
899 "the `--debug-init' option to view a complete error backtrace.\n\n"))
900 (message "Error in init file: %s%s%s"
901 (get (car error) 'error-message)
902 (if (cdr error) ": " "")
903 (mapconcat 'prin1-to-string (cdr error) ", "))
904 (let ((pop-up-windows nil))
905 (pop-to-buffer "*Messages*"))
906 (setq init-file-had-error t)))))
908 ;; If the user has a file of abbrevs, read it.
909 (if (file-exists-p abbrev-file-name)
910 (quietly-read-abbrev-file abbrev-file-name))
912 ;; If the abbrevs came entirely from the init file or the
913 ;; abbrevs file, they do not need saving.
914 (setq abbrevs-changed nil)
916 ;; If we can tell that the init file altered debug-on-error,
917 ;; arrange to preserve the value that it set up.
918 (or (eq debug-on-error debug-on-error-initial)
919 (setq debug-on-error-should-be-set t
920 debug-on-error-from-init-file debug-on-error)))
921 (if debug-on-error-should-be-set
922 (setq debug-on-error debug-on-error-from-init-file))
923 (unless (or default-enable-multibyte-characters
924 (eq orig-enable-multibyte default-enable-multibyte-characters))
925 ;; Init file changed to unibyte. Reset existing multibyte
926 ;; buffers (probably *scratch*, *Messages*, *Minibuff-0*).
927 ;; Arguably this should only be done if they're free of
928 ;; multibyte characters.
929 (mapcar (lambda (buffer)
930 (with-current-buffer buffer
931 (if enable-multibyte-characters
932 (set-buffer-multibyte nil))))
933 (buffer-list))
934 ;; Also re-set the language environment in case it was
935 ;; originally done before unibyte was set and is sensitive to
936 ;; unibyte (display table, terminal coding system &c).
937 (set-language-environment current-language-environment)))
939 ;; Do this here in case the init file sets mail-host-address.
940 (if (equal user-mail-address "")
941 (setq user-mail-address (concat (user-login-name) "@"
942 (or mail-host-address
943 (system-name)))))
945 ;; If parameter have been changed in the init file which influence
946 ;; face realization, clear the face cache so that new faces will
947 ;; be realized.
948 (unless (and (eq scalable-fonts-allowed old-scalable-fonts-allowed)
949 (eq font-list-limit old-font-list-limit)
950 (eq face-ignored-fonts old-face-ignored-fonts))
951 (clear-face-cache)))
953 (run-hooks 'after-init-hook)
955 ;; Decode all default-directory.
956 (if (and default-enable-multibyte-characters locale-coding-system)
957 (save-excursion
958 (dolist (elt (buffer-list))
959 (set-buffer elt)
960 (if default-directory
961 (setq default-directory
962 (decode-coding-string default-directory
963 locale-coding-system t))))
964 (setq command-line-default-directory
965 (decode-coding-string command-line-default-directory
966 locale-coding-system t))))
968 ;; If *scratch* exists and init file didn't change its mode, initialize it.
969 (if (get-buffer "*scratch*")
970 (with-current-buffer "*scratch*"
971 (if (eq major-mode 'fundamental-mode)
972 (funcall initial-major-mode))))
974 ;; Load library for our terminal type.
975 ;; User init file can set term-file-prefix to nil to prevent this.
976 (unless (or noninteractive
977 window-system
978 (null term-file-prefix))
979 (let* ((TERM (getenv "TERM"))
980 (term TERM)
981 hyphend)
982 (while (and term
983 (not (load (concat term-file-prefix term) t t)))
984 ;; Strip off last hyphen and what follows, then try again
985 (setq term
986 (if (setq hyphend (string-match "[-_][^-_]+\\'" term))
987 (substring term 0 hyphend)
988 nil)))
989 (setq term TERM)
990 ;; The terminal file has been loaded, now call the terminal specific
991 ;; initialization function.
992 (while term
993 (let ((term-init-func (intern-soft (concat "terminal-init-" term))))
994 (if (not (fboundp term-init-func))
995 ;; Strip off last hyphen and what follows, then try again
996 (setq term
997 (if (setq hyphend (string-match "[-_][^-_]+\\'" term))
998 (substring term 0 hyphend)
999 nil))
1000 (setq term nil)
1001 (funcall term-init-func))))))
1003 ;; Update the out-of-memory error message based on user's key bindings
1004 ;; for save-some-buffers.
1005 (setq memory-signal-data
1006 (list 'error
1007 (substitute-command-keys "Memory exhausted--use \\[save-some-buffers] then exit and restart Emacs")))
1009 ;; Process the remaining args.
1010 (command-line-1 (cdr command-line-args))
1012 ;; If -batch, terminate after processing the command options.
1013 (if noninteractive (kill-emacs t))
1015 ;; Run emacs-session-restore (session management) if started by
1016 ;; the session manager and we have a session manager connection.
1017 (if (and (boundp 'x-session-previous-id)
1018 (stringp x-session-previous-id))
1019 (with-no-warnings
1020 (emacs-session-restore x-session-previous-id))))
1022 (defcustom initial-scratch-message (purecopy "\
1023 ;; This buffer is for notes you don't want to save, and for Lisp evaluation.
1024 ;; If you want to create a file, visit that file with C-x C-f,
1025 ;; then enter the text in that file's own buffer.
1028 "Initial message displayed in *scratch* buffer at startup.
1029 If this is nil, no message will be displayed."
1030 :type '(choice (text :tag "Message")
1031 (const :tag "none" nil))
1032 :group 'initialization)
1035 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1036 ;;; Fancy splash screen
1037 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1039 (defvar fancy-splash-text
1040 '((:face variable-pitch
1041 "You can do basic editing with the menu bar and scroll bar \
1042 using the mouse.\n\n"
1043 :face (variable-pitch :weight bold)
1044 "Important Help menu items:\n"
1045 :face variable-pitch
1046 (lambda ()
1047 (let* ((en "TUTORIAL")
1048 (tut (or (get-language-info current-language-environment
1049 'tutorial)
1050 en))
1051 (title (with-temp-buffer
1052 (insert-file-contents
1053 (expand-file-name tut data-directory)
1054 nil 0 256)
1055 (search-forward ".")
1056 (buffer-substring (point-min) (1- (point))))))
1057 ;; If there is a specific tutorial for the current language
1058 ;; environment and it is not English, append its title.
1059 (concat
1060 "Emacs Tutorial\tLearn how to use Emacs efficiently"
1061 (if (string= en tut)
1063 (concat " (" title ")"))
1064 "\n")))
1065 :face variable-pitch "\
1066 Emacs FAQ\tFrequently asked questions and answers
1067 Read the Emacs Manual\tView the Emacs manual using Info
1068 \(Non)Warranty\tGNU Emacs comes with "
1069 :face (variable-pitch :slant oblique)
1070 "ABSOLUTELY NO WARRANTY\n"
1071 :face variable-pitch
1073 Copying Conditions\tConditions for redistributing and changing Emacs
1074 Getting New Versions\tHow to obtain the latest version of Emacs
1075 More Manuals / Ordering Manuals Buying printed manuals from the FSF\n")
1076 (:face variable-pitch
1077 "You can do basic editing with the menu bar and scroll bar \
1078 using the mouse.\n\n"
1079 :face (variable-pitch :weight bold)
1080 "Useful File menu items:\n"
1081 :face variable-pitch "\
1082 Exit Emacs\t(Or type Control-x followed by Control-c)
1083 Recover Crashed Session\tRecover files you were editing before a crash
1090 "A list of texts to show in the middle part of splash screens.
1091 Each element in the list should be a list of strings or pairs
1092 `:face FACE', like `fancy-splash-insert' accepts them.")
1095 (defgroup fancy-splash-screen ()
1096 "Fancy splash screen when Emacs starts."
1097 :version "21.1"
1098 :group 'initialization)
1101 (defcustom fancy-splash-delay 7
1102 "*Delay in seconds between splash screens."
1103 :group 'fancy-splash-screen
1104 :type 'integer)
1107 (defcustom fancy-splash-max-time 30
1108 "*Show splash screens for at most this number of seconds.
1109 Values less than twice `fancy-splash-delay' are ignored."
1110 :group 'fancy-splash-screen
1111 :type 'integer)
1114 (defcustom fancy-splash-image nil
1115 "*The image to show in the splash screens, or nil for defaults."
1116 :group 'fancy-splash-screen
1117 :type '(choice (const :tag "Default" nil)
1118 (file :tag "File")))
1121 ;; These are temporary storage areas for the splash screen display.
1123 (defvar fancy-current-text nil)
1124 (defvar fancy-splash-help-echo nil)
1125 (defvar fancy-splash-stop-time nil)
1126 (defvar fancy-splash-outer-buffer nil)
1128 (defun fancy-splash-insert (&rest args)
1129 "Insert text into the current buffer, with faces.
1130 Arguments from ARGS should be either strings, functions called
1131 with no args that return a string, or pairs `:face FACE',
1132 where FACE is a valid face specification, as it can be used with
1133 `put-text-property'."
1134 (let ((current-face nil))
1135 (while args
1136 (if (eq (car args) :face)
1137 (setq args (cdr args) current-face (car args))
1138 (insert (propertize (let ((it (car args)))
1139 (if (functionp it)
1140 (funcall it)
1141 it))
1142 'face current-face
1143 'help-echo fancy-splash-help-echo)))
1144 (setq args (cdr args)))))
1147 (defun fancy-splash-head ()
1148 "Insert the head part of the splash screen into the current buffer."
1149 (let* ((image-file (cond ((stringp fancy-splash-image)
1150 fancy-splash-image)
1151 ((and (display-color-p)
1152 (image-type-available-p 'xpm))
1153 (if (and (fboundp 'x-display-planes)
1154 (= (funcall 'x-display-planes) 8))
1155 "splash8.xpm"
1156 "splash.xpm"))
1157 (t "splash.pbm")))
1158 (img (create-image image-file))
1159 (image-width (and img (car (image-size img))))
1160 (window-width (window-width (selected-window))))
1161 (when img
1162 (when (> window-width image-width)
1163 ;; Center the image in the window.
1164 (insert (propertize " " 'display
1165 `(space :align-to (+ center (-0.5 . ,img)))))
1167 ;; Change the color of the XPM version of the splash image
1168 ;; so that it is visible with a dark frame background.
1169 (when (and (memq 'xpm img)
1170 (eq (frame-parameter nil 'background-mode) 'dark))
1171 (setq img (append img '(:color-symbols (("#000000" . "gray30"))))))
1173 ;; Insert the image with a help-echo and a keymap.
1174 (let ((map (make-sparse-keymap))
1175 (help-echo "mouse-2: browse http://www.gnu.org/"))
1176 (define-key map [mouse-2]
1177 (lambda ()
1178 (interactive)
1179 (browse-url "http://www.gnu.org/")
1180 (throw 'exit nil)))
1181 (define-key map [down-mouse-2] 'ignore)
1182 (define-key map [up-mouse-2] 'ignore)
1183 (insert-image img (propertize "xxx" 'help-echo help-echo
1184 'keymap map)))
1185 (insert "\n"))))
1186 (fancy-splash-insert
1187 :face '(variable-pitch :foreground "red")
1188 (if (eq system-type 'gnu/linux)
1189 "GNU Emacs is one component of the GNU/Linux operating system."
1190 "GNU Emacs is one component of the GNU operating system."))
1191 (insert "\n")
1192 (unless (equal (buffer-name fancy-splash-outer-buffer) "*scratch*")
1193 (fancy-splash-insert :face 'variable-pitch
1194 (substitute-command-keys
1195 "Type \\[recenter] to begin editing your file.\n"))))
1198 (defun fancy-splash-tail ()
1199 "Insert the tail part of the splash screen into the current buffer."
1200 (let ((fg (if (eq (frame-parameter nil 'background-mode) 'dark)
1201 "cyan" "darkblue")))
1202 (fancy-splash-insert :face `(variable-pitch :foreground ,fg)
1203 "\nThis is "
1204 (emacs-version)
1205 "\n"
1206 :face '(variable-pitch :height 0.5)
1207 "Copyright (C) 2005 Free Software Foundation, Inc.")
1208 (and auto-save-list-file-prefix
1209 ;; Don't signal an error if the
1210 ;; directory for auto-save-list files
1211 ;; does not yet exist.
1212 (file-directory-p (file-name-directory
1213 auto-save-list-file-prefix))
1214 (directory-files
1215 (file-name-directory auto-save-list-file-prefix)
1217 (concat "\\`"
1218 (regexp-quote (file-name-nondirectory
1219 auto-save-list-file-prefix)))
1221 (fancy-splash-insert :face '(variable-pitch :foreground "red")
1222 "\n\nIf an Emacs session crashed recently, "
1223 "type M-x recover-session RET\nto recover"
1224 " the files you were editing."))))
1226 (defun fancy-splash-screens-1 (buffer)
1227 "Timer function displaying a splash screen."
1228 (when (> (float-time) fancy-splash-stop-time)
1229 (throw 'stop-splashing nil))
1230 (unless fancy-current-text
1231 (setq fancy-current-text fancy-splash-text))
1232 (let ((text (car fancy-current-text)))
1233 (set-buffer buffer)
1234 (erase-buffer)
1235 (if pure-space-overflow
1236 (insert "Warning Warning Pure space overflow Warning Warning\n"))
1237 (fancy-splash-head)
1238 (apply #'fancy-splash-insert text)
1239 (fancy-splash-tail)
1240 (unless (current-message)
1241 (message fancy-splash-help-echo))
1242 (set-buffer-modified-p nil)
1243 (goto-char (point-min))
1244 (force-mode-line-update)
1245 (setq fancy-current-text (cdr fancy-current-text))))
1248 (defun fancy-splash-default-action ()
1249 "Stop displaying the splash screen buffer.
1250 This is an internal function used to turn off the splash screen after
1251 the user caused an input event by hitting a key or clicking with the
1252 mouse."
1253 (interactive)
1254 (push last-command-event unread-command-events)
1255 (throw 'exit nil))
1258 (defun fancy-splash-screens ()
1259 "Display fancy splash screens when Emacs starts."
1260 (setq fancy-splash-help-echo (startup-echo-area-message))
1261 (let ((old-hourglass display-hourglass)
1262 (fancy-splash-outer-buffer (current-buffer))
1263 splash-buffer
1264 (old-minor-mode-map-alist minor-mode-map-alist)
1265 (frame (fancy-splash-frame))
1266 timer)
1267 (save-selected-window
1268 (select-frame frame)
1269 (switch-to-buffer "GNU Emacs")
1270 (setq tab-width 20)
1271 (setq splash-buffer (current-buffer))
1272 (catch 'stop-splashing
1273 (unwind-protect
1274 (let ((map (make-sparse-keymap)))
1275 (use-local-map map)
1276 (define-key map [switch-frame] 'ignore)
1277 (define-key map [t] 'fancy-splash-default-action)
1278 (define-key map [mouse-movement] 'ignore)
1279 (define-key map [mode-line t] 'ignore)
1280 (setq cursor-type nil
1281 display-hourglass nil
1282 minor-mode-map-alist nil
1283 buffer-undo-list t
1284 mode-line-format (propertize "---- %b %-"
1285 'face '(:weight bold))
1286 fancy-splash-stop-time (+ (float-time)
1287 fancy-splash-max-time)
1288 timer (run-with-timer 0 fancy-splash-delay
1289 #'fancy-splash-screens-1
1290 splash-buffer))
1291 (recursive-edit))
1292 (cancel-timer timer)
1293 (setq display-hourglass old-hourglass
1294 minor-mode-map-alist old-minor-mode-map-alist)
1295 (kill-buffer splash-buffer))))))
1297 (defun fancy-splash-frame ()
1298 "Return the frame to use for the fancy splash screen.
1299 Returning non-nil does not mean we should necessarily
1300 use the fancy splash screen, but if we do use it,
1301 we put it on this frame."
1302 (let (chosen-frame)
1303 (dolist (frame (append (frame-list) (list (selected-frame))))
1304 (if (and (frame-visible-p frame)
1305 (not (window-minibuffer-p (frame-selected-window frame))))
1306 (setq chosen-frame frame)))
1307 chosen-frame))
1309 (defun use-fancy-splash-screens-p ()
1310 "Return t if fancy splash screens should be used."
1311 (when (and (display-graphic-p)
1312 (or (and (display-color-p)
1313 (image-type-available-p 'xpm))
1314 (image-type-available-p 'pbm)))
1315 (let ((frame (fancy-splash-frame)))
1316 (when frame
1317 (let* ((img (create-image (or fancy-splash-image
1318 (if (and (display-color-p)
1319 (image-type-available-p 'xpm))
1320 "splash.xpm" "splash.pbm"))))
1321 (image-height (and img (cdr (image-size img))))
1322 (window-height (1- (window-height (frame-selected-window frame)))))
1323 (> window-height (+ image-height 19)))))))
1326 (defun normal-splash-screen ()
1327 "Display splash screen when Emacs starts."
1328 (let ((prev-buffer (current-buffer)))
1329 (unwind-protect
1330 (with-current-buffer (get-buffer-create "GNU Emacs")
1331 (let ((tab-width 8)
1332 (mode-line-format (propertize "---- %b %-"
1333 'face '(:weight bold))))
1335 (if pure-space-overflow
1336 (insert "Warning Warning Pure space overflow Warning Warning\n"))
1338 ;; The convention for this piece of code is that
1339 ;; each piece of output starts with one or two newlines
1340 ;; and does not end with any newlines.
1341 (insert "Welcome to GNU Emacs")
1342 (insert
1343 (if (eq system-type 'gnu/linux)
1344 ", one component of the GNU/Linux operating system.\n"
1345 ", a part of the GNU operating system.\n"))
1347 (unless (equal (buffer-name prev-buffer) "*scratch*")
1348 (insert (substitute-command-keys
1349 "\nType \\[recenter] to begin editing your file.\n")))
1351 (if (display-mouse-p)
1352 ;; The user can use the mouse to activate menus
1353 ;; so give help in terms of menu items.
1354 (progn
1355 (insert "\
1356 You can do basic editing with the menu bar and scroll bar using the mouse.
1358 Useful File menu items:
1359 Exit Emacs (or type Control-x followed by Control-c)
1360 Recover Crashed Session Recover files you were editing before a crash
1362 Important Help menu items:
1363 Emacs Tutorial Learn how to use Emacs efficiently
1364 Emacs FAQ Frequently asked questions and answers
1365 Read the Emacs Manual View the Emacs manual using Info
1366 \(Non)Warranty GNU Emacs comes with ABSOLUTELY NO WARRANTY
1367 Copying Conditions Conditions for redistributing and changing Emacs
1368 Getting New Versions How to obtain the latest version of Emacs
1369 More Manuals / Ordering Manuals How to order printed manuals from the FSF
1371 (insert "\n\n" (emacs-version)
1373 Copyright (C) 2005 Free Software Foundation, Inc."))
1375 ;; No mouse menus, so give help using kbd commands.
1377 ;; If keys have their default meanings,
1378 ;; use precomputed string to save lots of time.
1379 (if (and (eq (key-binding "\C-h") 'help-command)
1380 (eq (key-binding "\C-xu") 'advertised-undo)
1381 (eq (key-binding "\C-x\C-c") 'save-buffers-kill-emacs)
1382 (eq (key-binding "\C-ht") 'help-with-tutorial)
1383 (eq (key-binding "\C-hi") 'info)
1384 (eq (key-binding "\C-hr") 'info-emacs-manual)
1385 (eq (key-binding "\C-h\C-n") 'view-emacs-news))
1386 (insert "
1387 Get help C-h (Hold down CTRL and press h)
1388 Emacs manual C-h r
1389 Emacs tutorial C-h t Undo changes C-x u
1390 Buy manuals C-h C-m Exit Emacs C-x C-c
1391 Browse manuals C-h i")
1393 (insert (substitute-command-keys
1394 (format "\n
1395 Get help %s
1396 Emacs manual \\[info-emacs-manual]
1397 Emacs tutorial \\[help-with-tutorial]\tUndo changes\t\\[advertised-undo]
1398 Buy manuals \\[view-order-manuals]\tExit Emacs\t\\[save-buffers-kill-emacs]
1399 Browse manuals \\[info]"
1400 (let ((where (where-is-internal
1401 'help-command nil t)))
1402 (if where
1403 (key-description where)
1404 "M-x help"))))))
1406 ;; Say how to use the menu bar with the keyboard.
1407 (if (and (eq (key-binding "\M-`") 'tmm-menubar)
1408 (eq (key-binding [f10]) 'tmm-menubar))
1409 (insert "
1410 Activate menubar F10 or ESC ` or M-`")
1411 (insert (substitute-command-keys "
1412 Activate menubar \\[tmm-menubar]")))
1414 ;; Many users seem to have problems with these.
1415 (insert "
1416 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
1417 If you have no Meta key, you may instead type ESC followed by the character.)")
1419 (insert "\n\n" (emacs-version)
1421 Copyright (C) 2005 Free Software Foundation, Inc.")
1423 (if (and (eq (key-binding "\C-h\C-c") 'describe-copying)
1424 (eq (key-binding "\C-h\C-d") 'describe-distribution)
1425 (eq (key-binding "\C-h\C-w") 'describe-no-warranty))
1426 (insert
1428 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for full details.
1429 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
1430 of Emacs and modify it; type C-h C-c to see the conditions.
1431 Type C-h C-d for information on getting the latest version.")
1432 (insert (substitute-command-keys
1434 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for full details.
1435 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
1436 of Emacs and modify it; type \\[describe-copying] to see the conditions.
1437 Type \\[describe-distribution] for information on getting the latest version."))))
1439 ;; The rest of the startup screen is the same on all
1440 ;; kinds of terminals.
1442 ;; Give information on recovering, if there was a crash.
1443 (and auto-save-list-file-prefix
1444 ;; Don't signal an error if the
1445 ;; directory for auto-save-list files
1446 ;; does not yet exist.
1447 (file-directory-p (file-name-directory
1448 auto-save-list-file-prefix))
1449 (directory-files
1450 (file-name-directory auto-save-list-file-prefix)
1452 (concat "\\`"
1453 (regexp-quote (file-name-nondirectory
1454 auto-save-list-file-prefix)))
1456 (insert "\n\nIf an Emacs session crashed recently, "
1457 "type M-x recover-session RET\nto recover"
1458 " the files you were editing."))
1460 ;; Display the input that we set up in the buffer.
1461 (set-buffer-modified-p nil)
1462 (goto-char (point-min))
1463 (save-window-excursion
1464 (switch-to-buffer (current-buffer))
1465 (sit-for 120))))
1466 ;; Unwind ... ensure splash buffer is killed
1467 (kill-buffer "GNU Emacs"))))
1470 (defun startup-echo-area-message ()
1471 (if (eq (key-binding "\C-h\C-p") 'describe-project)
1472 "For information about the GNU Project and its goals, type C-h C-p."
1473 (substitute-command-keys
1474 "For information about the GNU Project and its goals, type \
1475 \\[describe-project].")))
1478 (defun display-startup-echo-area-message ()
1479 (let ((resize-mini-windows t))
1480 (message "%s" (startup-echo-area-message))))
1483 (defun display-splash-screen ()
1484 "Display splash screen according to display.
1485 Fancy splash screens are used on graphic displays,
1486 normal otherwise."
1487 (interactive)
1488 (if (use-fancy-splash-screens-p)
1489 (fancy-splash-screens)
1490 (normal-splash-screen)))
1493 (defun command-line-1 (command-line-args-left)
1494 (or noninteractive (input-pending-p) init-file-had-error
1495 ;; t if the init file says to inhibit the echo area startup message.
1496 (and inhibit-startup-echo-area-message
1497 user-init-file
1498 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
1499 (equal inhibit-startup-echo-area-message
1500 (if (equal init-file-user "")
1501 (user-login-name)
1502 init-file-user)))
1503 ;; Wasn't set with custom; see if .emacs has a setq.
1504 (let ((buffer (get-buffer-create " *temp*")))
1505 (prog1
1506 (condition-case nil
1507 (save-excursion
1508 (set-buffer buffer)
1509 (insert-file-contents user-init-file)
1510 (re-search-forward
1511 (concat
1512 "([ \t\n]*setq[ \t\n]+"
1513 "inhibit-startup-echo-area-message[ \t\n]+"
1514 (regexp-quote
1515 (prin1-to-string
1516 (if (equal init-file-user "")
1517 (user-login-name)
1518 init-file-user)))
1519 "[ \t\n]*)")
1520 nil t))
1521 (error nil))
1522 (kill-buffer buffer)))))
1523 ;; display-splash-screen at the end of command-line-1 calls
1524 ;; use-fancy-splash-screens-p. This can cause image.el to be
1525 ;; loaded, putting "Loading image... done" in the echo area.
1526 ;; This hides startup-echo-area-message. So
1527 ;; use-fancy-splash-screens-p is called here simply to get the
1528 ;; loading of image.el (if needed) out of the way before
1529 ;; display-startup-echo-area-message runs.
1530 (progn
1531 (use-fancy-splash-screens-p)
1532 (display-startup-echo-area-message)))
1534 ;; Delay 2 seconds after an init file error message
1535 ;; was displayed, so user can read it.
1536 (when init-file-had-error
1537 (sit-for 2))
1539 (when command-line-args-left
1540 ;; We have command args; process them.
1541 (let ((dir command-line-default-directory)
1542 (file-count 0)
1543 first-file-buffer
1545 ;; This approach loses for "-batch -L DIR --eval "(require foo)",
1546 ;; if foo is intended to be found in DIR.
1548 ;; ;; The directories listed in --directory/-L options will *appear*
1549 ;; ;; at the front of `load-path' in the order they appear on the
1550 ;; ;; command-line. We cannot do this by *placing* them at the front
1551 ;; ;; in the order they appear, so we need this variable to hold them,
1552 ;; ;; temporarily.
1553 ;; extra-load-path
1555 ;; To DTRT we keep track of the splice point and modify `load-path'
1556 ;; straight away upon any --directory/-L option.
1557 splice
1558 just-files ;; t if this follows the magic -- option.
1559 ;; This includes our standard options' long versions
1560 ;; and long versions of what's on command-switch-alist.
1561 (longopts
1562 (append '(("--funcall") ("--load") ("--insert") ("--kill")
1563 ("--directory") ("--eval") ("--execute") ("--no-splash")
1564 ("--find-file") ("--visit") ("--file"))
1565 (mapcar (lambda (elt)
1566 (list (concat "-" (car elt))))
1567 command-switch-alist)))
1568 (line 0)
1569 (column 0))
1571 ;; Add the long X options to longopts.
1572 (dolist (tem command-line-x-option-alist)
1573 (if (string-match "^--" (car tem))
1574 (push (list (car tem)) longopts)))
1576 ;; Loop, processing options.
1577 (while command-line-args-left
1578 (let* ((argi (car command-line-args-left))
1579 (orig-argi argi)
1580 argval completion)
1581 (setq command-line-args-left (cdr command-line-args-left))
1583 ;; Do preliminary decoding of the option.
1584 (if just-files
1585 ;; After --, don't look for options; treat all args as files.
1586 (setq argi "")
1587 ;; Convert long options to ordinary options
1588 ;; and separate out an attached option argument into argval.
1589 (when (string-match "^\\(--[^=]*\\)=" argi)
1590 (setq argval (substring argi (match-end 0))
1591 argi (match-string 1 argi)))
1592 (if (equal argi "--")
1593 (setq completion nil)
1594 (setq completion (try-completion argi longopts)))
1595 (if (eq completion t)
1596 (setq argi (substring argi 1))
1597 (if (stringp completion)
1598 (let ((elt (assoc completion longopts)))
1599 (or elt
1600 (error "Option `%s' is ambiguous" argi))
1601 (setq argi (substring (car elt) 1)))
1602 (setq argval nil
1603 argi orig-argi))))
1605 ;; Execute the option.
1606 (cond ((setq tem (assoc argi command-switch-alist))
1607 (if argval
1608 (let ((command-line-args-left
1609 (cons argval command-line-args-left)))
1610 (funcall (cdr tem) argi))
1611 (funcall (cdr tem) argi)))
1613 ((equal argi "-no-splash")
1614 (setq inhibit-startup-message t))
1616 ((member argi '("-f" ; what the manual claims
1617 "-funcall"
1618 "-e")) ; what the source used to say
1619 (setq tem (intern (or argval (pop command-line-args-left))))
1620 (if (commandp tem)
1621 (command-execute tem)
1622 (funcall tem)))
1624 ((member argi '("-eval" "-execute"))
1625 (eval (read (or argval (pop command-line-args-left)))))
1627 ((member argi '("-L" "-directory"))
1628 (setq tem (expand-file-name
1629 (command-line-normalize-file-name
1630 (or argval (pop command-line-args-left)))))
1631 (cond (splice (setcdr splice (cons tem (cdr splice)))
1632 (setq splice (cdr splice)))
1633 (t (setq load-path (cons tem load-path)
1634 splice load-path))))
1636 ((member argi '("-l" "-load"))
1637 (let* ((file (command-line-normalize-file-name
1638 (or argval (pop command-line-args-left))))
1639 ;; Take file from default dir if it exists there;
1640 ;; otherwise let `load' search for it.
1641 (file-ex (expand-file-name file)))
1642 (when (file-exists-p file-ex)
1643 (setq file file-ex))
1644 (load file nil t)))
1646 ;; This is used to handle -script. It's not clear
1647 ;; we need to document it.
1648 ((member argi '("-scriptload"))
1649 (let* ((file (command-line-normalize-file-name
1650 (or argval (pop command-line-args-left))))
1651 ;; Take file from default dir.
1652 (file-ex (expand-file-name file)))
1653 (load file-ex nil t t)))
1655 ((equal argi "-insert")
1656 (setq tem (or argval (pop command-line-args-left)))
1657 (or (stringp tem)
1658 (error "File name omitted from `-insert' option"))
1659 (insert-file-contents (command-line-normalize-file-name tem)))
1661 ((equal argi "-kill")
1662 (kill-emacs t))
1664 ((string-match "^\\+[0-9]+\\'" argi)
1665 (setq line (string-to-number argi)))
1667 ((string-match "^\\+\\([0-9]+\\):\\([0-9]+\\)\\'" argi)
1668 (setq line (string-to-number (match-string 1 argi))
1669 column (string-to-number (match-string 2 argi))))
1671 ((setq tem (assoc argi command-line-x-option-alist))
1672 ;; Ignore X-windows options and their args if not using X.
1673 (setq command-line-args-left
1674 (nthcdr (nth 1 tem) command-line-args-left)))
1676 ((member argi '("-find-file" "-file" "-visit"))
1677 ;; An explicit option to specify visiting a file.
1678 (setq tem (or argval (pop command-line-args-left)))
1679 (unless (stringp tem)
1680 (error "File name omitted from `%s' option" argi))
1681 (setq file-count (1+ file-count))
1682 (let ((file (expand-file-name
1683 (command-line-normalize-file-name tem) dir)))
1684 (if (= file-count 1)
1685 (setq first-file-buffer (find-file file))
1686 (find-file-other-window file)))
1687 (or (zerop line)
1688 (goto-line line))
1689 (setq line 0)
1690 (unless (< column 1)
1691 (move-to-column (1- column)))
1692 (setq column 0))
1694 ((equal argi "--")
1695 (setq just-files t))
1697 ;; We have almost exhausted our options. See if the
1698 ;; user has made any other command-line options available
1699 (let ((hooks command-line-functions) ;; lrs 7/31/89
1700 (did-hook nil))
1701 (while (and hooks
1702 (not (setq did-hook (funcall (car hooks)))))
1703 (setq hooks (cdr hooks)))
1704 (if (not did-hook)
1705 ;; Presume that the argument is a file name.
1706 (progn
1707 (if (string-match "\\`-" argi)
1708 (error "Unknown option `%s'" argi))
1709 (setq file-count (1+ file-count))
1710 (let ((file
1711 (expand-file-name
1712 (command-line-normalize-file-name orig-argi)
1713 dir)))
1714 (if (= file-count 1)
1715 (setq first-file-buffer (find-file file))
1716 (find-file-other-window file)))
1717 (or (zerop line)
1718 (goto-line line))
1719 (setq line 0)
1720 (unless (< column 1)
1721 (move-to-column (1- column)))
1722 (setq column 0))))))))
1724 ;; If 3 or more files visited, and not all visible,
1725 ;; show user what they all are. But leave the last one current.
1726 (and (> file-count 2)
1727 (not noninteractive)
1728 (not inhibit-startup-buffer-menu)
1729 (or (get-buffer-window first-file-buffer)
1730 (list-buffers)))))
1732 ;; Maybe display a startup screen.
1733 (unless (or inhibit-startup-message
1734 noninteractive
1735 emacs-quick-startup)
1736 ;; Display a startup screen, after some preparations.
1738 ;; If there are no switches to process, we might as well
1739 ;; run this hook now, and there may be some need to do it
1740 ;; before doing any output.
1741 (run-hooks 'emacs-startup-hook)
1742 (and term-setup-hook
1743 (run-hooks 'term-setup-hook))
1744 (setq inhibit-startup-hooks t)
1746 ;; It's important to notice the user settings before we
1747 ;; display the startup message; otherwise, the settings
1748 ;; won't take effect until the user gives the first
1749 ;; keystroke, and that's distracting.
1750 (when (fboundp 'frame-notice-user-settings)
1751 (frame-notice-user-settings))
1753 ;; If there are no switches to process, we might as well
1754 ;; run this hook now, and there may be some need to do it
1755 ;; before doing any output.
1756 (when window-setup-hook
1757 (run-hooks 'window-setup-hook)
1758 ;; Don't let the hook be run twice.
1759 (setq window-setup-hook nil))
1761 ;; Do this now to avoid an annoying delay if the user
1762 ;; clicks the menu bar during the sit-for.
1763 (when (display-popup-menus-p)
1764 (precompute-menubar-bindings))
1765 (with-no-warnings
1766 (setq menubar-bindings-done t))
1768 ;; If *scratch* is selected and it is empty, insert an
1769 ;; initial message saying not to create a file there.
1770 (when (and initial-scratch-message
1771 (equal (buffer-name) "*scratch*")
1772 (= 0 (buffer-size)))
1773 (insert initial-scratch-message)
1774 (set-buffer-modified-p nil))
1776 ;; If user typed input during all that work,
1777 ;; abort the startup screen. Otherwise, display it now.
1778 (unless (input-pending-p)
1779 (display-splash-screen))))
1782 (defun command-line-normalize-file-name (file)
1783 "Collapse multiple slashes to one, to handle non-Emacs file names."
1784 (save-match-data
1785 ;; Use arg 1 so that we don't collapse // at the start of the file name.
1786 ;; That is significant on some systems.
1787 ;; However, /// at the beginning is supposed to mean just /, not //.
1788 (if (string-match "^///+" file)
1789 (setq file (replace-match "/" t t file)))
1790 (while (string-match "//+" file 1)
1791 (setq file (replace-match "/" t t file)))
1792 file))
1794 ;; arch-tag: 7e294698-244d-4758-984b-4047f887a5db
1795 ;;; startup.el ends here