(initialization): Finish `defgroup' description with period.
[bpt/emacs.git] / lisp / startup.el
1 ;;; startup.el --- process Emacs shell arguments
2
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 ;; 2001, 2002, 2004, 2005 Free Software Foundation, Inc.
5
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8
9 ;; This file is part of GNU Emacs.
10
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.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
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.
25
26 ;;; Commentary:
27
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.
31
32 ;;; Code:
33
34 (setq top-level '(normal-top-level))
35
36 (defvar command-line-processed nil
37 "Non-nil once command line has been processed.")
38
39 (defgroup initialization nil
40 "Emacs start-up procedure."
41 :group 'internal)
42
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)
49
50 (defvaralias 'inhibit-splash-screen 'inhibit-startup-message)
51
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)
65
66 (defcustom inhibit-default-init nil
67 "*Non-nil inhibits loading the `default' library."
68 :type 'boolean
69 :group 'initialization)
70
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)
75
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'.")
81
82 (defvar command-line-args-left nil
83 "List of command-line args not yet processed.")
84
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.")
92
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.")
96
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).")
162
163 (defvar before-init-hook nil
164 "Normal hook run after handling urgent options but before loading init files.")
165
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.")
171
172 (defvar emacs-startup-hook nil
173 "Normal hook run after loading init files and handling the command line.")
174
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.")
180
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.")
184
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.")
190
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.")
195
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)
200
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.
205
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.
209
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.
213
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)
218
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'.
226
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.
233
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")))
243
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)
248
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".
254 "")
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)
260
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")
265 (t
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)
277
278 (defvar emacs-quick-startup nil)
279
280 (defvar emacs-basic-display nil)
281
282 (defvar init-file-debug nil)
283
284 (defvar init-file-had-error nil)
285
286 (defvar normal-top-level-add-subdirs-inode-list nil)
287
288 (defvar no-blinking-cursor nil)
289
290 (defvar default-frame-background-mode)
291
292 (defvar pure-space-overflow nil
293 "Non-nil if building Emacs overflowed pure space.")
294
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)))))
333
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))))))
352
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)
416 t)
417 (concat
418 (make-temp-name
419 (expand-file-name
420 auto-save-list-file-prefix))
421 "~"))
422 (t
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)))
432
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")))))
458
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)))))
467
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)))))))
476
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))
491
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")))
500
501 (defconst tool-bar-images-pixel-height 24
502 "Height in pixels of images in the tool bar.")
503
504 (defvar tool-bar-originally-present nil
505 "Non-nil if tool-bars are present before user and site init files are read.")
506
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)
547 i)
548 (setq argval (invocation-name))
549
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))
569 (t
570 (push argi rest)))))
571 (nreverse rest)))
572
573 (defun command-line ()
574 (setq command-line-default-directory default-directory)
575
576 ;; Choose a reasonable location for temporary files.
577 (custom-reevaluate-setting 'temporary-file-directory)
578 (custom-reevaluate-setting 'small-emporary-file-directory)
579 (custom-reevaluate-setting 'auto-save-file-name-transforms)
580
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))))
590
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))
596
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)")))
610
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)))
638
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)))
642
643 (set-locale-environment nil)
644
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)))
651
652 (let ((done nil)
653 (args (cdr command-line-args)))
654
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 ""))
662
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") ("--user")
668 ("--debug-init") ("--iconic") ("--icon-type")
669 ("--no-blinking-cursor") ("--bare-bones")))
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.
713 (t
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))))
719
720 ;; Re-attach the program name to the front of the arg list.
721 (and command-line-args
722 (setcdr command-line-args args)))
723
724 ;; Under X Window, this creates the X frame and deletes the terminal frame.
725 (when (fboundp 'frame-initialize)
726 (frame-initialize))
727
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))
736
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))
743
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))
750
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
756 ;; If you change the code below, you need to also change the
757 ;; corresponding code in the tooltip-mode defcustom. The two need
758 ;; to be equivalent under all conditions, or Custom will get confused.
759 (unless (or noninteractive
760 emacs-basic-display
761 (not (display-graphic-p))
762 (not (fboundp 'x-show-tip)))
763 (tooltip-mode 1))
764
765 ;; Register default TTY colors for the case the terminal hasn't a
766 ;; terminal init file.
767 (unless (memq window-system '(x w32))
768 ;; We do this regardles of whether the terminal supports colors
769 ;; or not, since they can switch that support on or off in
770 ;; mid-session by setting the tty-color-mode frame parameter.
771 (tty-register-default-colors))
772
773 ;; Record whether the tool-bar is present before the user and site
774 ;; init files are processed. frame-notice-user-settings uses this
775 ;; to determine if the tool-bar has been disabled by the init files,
776 ;; and the frame needs to be resized.
777 (when (fboundp 'frame-notice-user-settings)
778 (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
779 (assq 'tool-bar-lines default-frame-alist))))
780 (setq tool-bar-originally-present
781 (and tool-bar-lines
782 (cdr tool-bar-lines)
783 (not (eq 0 (cdr tool-bar-lines)))))))
784
785 (let ((old-scalable-fonts-allowed scalable-fonts-allowed)
786 (old-font-list-limit font-list-limit)
787 (old-face-ignored-fonts face-ignored-fonts))
788
789 (run-hooks 'before-init-hook)
790
791 ;; Run the site-start library if it exists. The point of this file is
792 ;; that it is run before .emacs. There is no point in doing this after
793 ;; .emacs; that is useless.
794 (if site-run-file
795 (load site-run-file t t))
796
797 ;; Sites should not disable this. Only individuals should disable
798 ;; the startup message.
799 (setq inhibit-startup-message nil)
800
801 ;; Warn for invalid user name.
802 (and init-file-user
803 (not (file-directory-p (expand-file-name (concat "~" init-file-user))))
804 (display-warning 'initialization
805 (format "User %s has no home directory"
806 init-file-user)
807 :error))
808
809 ;; Load that user's init file, or the default one, or none.
810 (let (debug-on-error-from-init-file
811 debug-on-error-should-be-set
812 (debug-on-error-initial
813 (if (eq init-file-debug t) 'startup init-file-debug))
814 (orig-enable-multibyte default-enable-multibyte-characters))
815 (let ((debug-on-error debug-on-error-initial)
816 ;; This function actually reads the init files.
817 (inner
818 (function
819 (lambda ()
820 (if init-file-user
821 (let ((user-init-file-1
822 (cond
823 ((eq system-type 'ms-dos)
824 (concat "~" init-file-user "/_emacs"))
825 ((eq system-type 'windows-nt)
826 ;; Prefer .emacs on Windows.
827 (if (directory-files "~" nil "^\\.emacs\\(\\.elc?\\)?$")
828 "~/.emacs"
829 ;; Also support _emacs for compatibility.
830 (if (directory-files "~" nil "^_emacs\\(\\.elc?\\)?$")
831 "~/_emacs"
832 ;; But default to .emacs if _emacs does not exist.
833 "~/.emacs")))
834 ((eq system-type 'vax-vms)
835 "sys$login:.emacs")
836 (t
837 (concat "~" init-file-user "/.emacs")))))
838 ;; This tells `load' to store the file name found
839 ;; into user-init-file.
840 (setq user-init-file t)
841 (load user-init-file-1 t t)
842
843 (when (eq user-init-file t)
844 ;; If we did not find ~/.emacs, try
845 ;; ~/.emacs.d/.emacs.
846 (let ((otherfile
847 (expand-file-name
848 (file-name-nondirectory user-init-file-1)
849 (file-name-as-directory
850 (expand-file-name
851 ".emacs.d"
852 (file-name-directory user-init-file-1))))))
853 (load otherfile t t)
854
855 ;; If we did not find the user's init file,
856 ;; set user-init-file conclusively.
857 ;; Don't let it be set from default.el.
858 (when (eq user-init-file t)
859 (setq user-init-file user-init-file-1))))
860
861 ;; If we loaded a compiled file, set
862 ;; `user-init-file' to the source version if that
863 ;; exists.
864 (when (and user-init-file
865 (equal (file-name-extension user-init-file)
866 "elc"))
867 (let* ((source (file-name-sans-extension user-init-file))
868 (alt (concat source ".el")))
869 (setq source (cond ((file-exists-p alt) alt)
870 ((file-exists-p source) source)
871 (t nil)))
872 (when source
873 (when (file-newer-than-file-p source user-init-file)
874 (message "Warning: %s is newer than %s"
875 source user-init-file)
876 (sit-for 1))
877 (setq user-init-file source))))
878
879 (unless inhibit-default-init
880 (let ((inhibit-startup-message nil))
881 ;; Users are supposed to be told their rights.
882 ;; (Plus how to get help and how to undo.)
883 ;; Don't you dare turn this off for anyone
884 ;; except yourself.
885 (load "default" t t)))))))))
886 (if init-file-debug
887 ;; Do this without a condition-case if the user wants to debug.
888 (funcall inner)
889 (condition-case error
890 (progn
891 (funcall inner)
892 (setq init-file-had-error nil))
893 (error
894 (let ((message-log-max nil))
895 (save-excursion
896 (set-buffer (get-buffer-create "*Messages*"))
897 (insert "\n\n"
898 (format "An error has occurred while loading `%s':\n\n"
899 user-init-file)
900 (format "%s%s%s"
901 (get (car error) 'error-message)
902 (if (cdr error) ": " "")
903 (mapconcat (lambda (s) (prin1-to-string s t)) (cdr error) ", "))
904 "\n\n"
905 "To ensure normal operation, you should investigate and remove the\n"
906 "cause of the error in your initialization file. Start Emacs with\n"
907 "the `--debug-init' option to view a complete error backtrace.\n\n"))
908 (message "Error in init file: %s%s%s"
909 (get (car error) 'error-message)
910 (if (cdr error) ": " "")
911 (mapconcat 'prin1-to-string (cdr error) ", "))
912 (let ((pop-up-windows nil))
913 (pop-to-buffer "*Messages*"))
914 (setq init-file-had-error t)))))
915
916 ;; If the user has a file of abbrevs, read it.
917 (if (file-exists-p abbrev-file-name)
918 (quietly-read-abbrev-file abbrev-file-name))
919
920 ;; If the abbrevs came entirely from the init file or the
921 ;; abbrevs file, they do not need saving.
922 (setq abbrevs-changed nil)
923
924 ;; If we can tell that the init file altered debug-on-error,
925 ;; arrange to preserve the value that it set up.
926 (or (eq debug-on-error debug-on-error-initial)
927 (setq debug-on-error-should-be-set t
928 debug-on-error-from-init-file debug-on-error)))
929 (if debug-on-error-should-be-set
930 (setq debug-on-error debug-on-error-from-init-file))
931 (unless (or default-enable-multibyte-characters
932 (eq orig-enable-multibyte default-enable-multibyte-characters))
933 ;; Init file changed to unibyte. Reset existing multibyte
934 ;; buffers (probably *scratch*, *Messages*, *Minibuff-0*).
935 ;; Arguably this should only be done if they're free of
936 ;; multibyte characters.
937 (mapcar (lambda (buffer)
938 (with-current-buffer buffer
939 (if enable-multibyte-characters
940 (set-buffer-multibyte nil))))
941 (buffer-list))
942 ;; Also re-set the language environment in case it was
943 ;; originally done before unibyte was set and is sensitive to
944 ;; unibyte (display table, terminal coding system &c).
945 (set-language-environment current-language-environment)))
946
947 ;; Do this here in case the init file sets mail-host-address.
948 (if (equal user-mail-address "")
949 (setq user-mail-address (concat (user-login-name) "@"
950 (or mail-host-address
951 (system-name)))))
952
953 ;; If parameter have been changed in the init file which influence
954 ;; face realization, clear the face cache so that new faces will
955 ;; be realized.
956 (unless (and (eq scalable-fonts-allowed old-scalable-fonts-allowed)
957 (eq font-list-limit old-font-list-limit)
958 (eq face-ignored-fonts old-face-ignored-fonts))
959 (clear-face-cache)))
960
961 (run-hooks 'after-init-hook)
962
963 ;; Decode all default-directory.
964 (if (and default-enable-multibyte-characters locale-coding-system)
965 (save-excursion
966 (dolist (elt (buffer-list))
967 (set-buffer elt)
968 (if default-directory
969 (setq default-directory
970 (decode-coding-string default-directory
971 locale-coding-system t))))
972 (setq command-line-default-directory
973 (decode-coding-string command-line-default-directory
974 locale-coding-system t))))
975
976 ;; If *scratch* exists and init file didn't change its mode, initialize it.
977 (if (get-buffer "*scratch*")
978 (with-current-buffer "*scratch*"
979 (if (eq major-mode 'fundamental-mode)
980 (funcall initial-major-mode))))
981
982 ;; Load library for our terminal type.
983 ;; User init file can set term-file-prefix to nil to prevent this.
984 (unless (or noninteractive
985 window-system
986 (null term-file-prefix))
987 (let ((term (getenv "TERM"))
988 hyphend)
989 (while (and term
990 (not (load (concat term-file-prefix term) t t)))
991 ;; Strip off last hyphen and what follows, then try again
992 (setq term
993 (if (setq hyphend (string-match "[-_][^-_]+$" term))
994 (substring term 0 hyphend)
995 nil)))))
996
997 ;; Update the out-of-memory error message based on user's key bindings
998 ;; for save-some-buffers.
999 (setq memory-signal-data
1000 (list 'error
1001 (substitute-command-keys "Memory exhausted--use \\[save-some-buffers] then exit and restart Emacs")))
1002
1003 ;; Process the remaining args.
1004 (command-line-1 (cdr command-line-args))
1005
1006 ;; If -batch, terminate after processing the command options.
1007 (if noninteractive (kill-emacs t))
1008
1009 ;; Run emacs-session-restore (session management) if started by
1010 ;; the session manager and we have a session manager connection.
1011 (if (and (boundp 'x-session-previous-id)
1012 (stringp x-session-previous-id))
1013 (with-no-warnings
1014 (emacs-session-restore x-session-previous-id))))
1015
1016 (defcustom initial-scratch-message (purecopy "\
1017 ;; This buffer is for notes you don't want to save, and for Lisp evaluation.
1018 ;; If you want to create a file, visit that file with C-x C-f,
1019 ;; then enter the text in that file's own buffer.
1020
1021 ")
1022 "Initial message displayed in *scratch* buffer at startup.
1023 If this is nil, no message will be displayed."
1024 :type '(choice (text :tag "Message")
1025 (const :tag "none" nil))
1026 :group 'initialization)
1027
1028 \f
1029 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1030 ;;; Fancy splash screen
1031 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1032
1033 (defvar fancy-splash-text
1034 '((:face variable-pitch
1035 "You can do basic editing with the menu bar and scroll bar \
1036 using the mouse.\n\n"
1037 :face (variable-pitch :weight bold)
1038 "Important Help menu items:\n"
1039 :face variable-pitch
1040 (lambda ()
1041 (let* ((en "TUTORIAL")
1042 (tut (or (get-language-info current-language-environment
1043 'tutorial)
1044 en))
1045 (title (with-temp-buffer
1046 (insert-file-contents
1047 (expand-file-name tut data-directory)
1048 nil 0 256)
1049 (search-forward ".")
1050 (buffer-substring (point-min) (1- (point))))))
1051 ;; If there is a specific tutorial for the current language
1052 ;; environment and it is not English, append its title.
1053 (concat
1054 "Emacs Tutorial\tLearn how to use Emacs efficiently"
1055 (if (string= en tut)
1056 ""
1057 (concat " (" title ")"))
1058 "\n")))
1059 :face variable-pitch "\
1060 Emacs FAQ\tFrequently asked questions and answers
1061 Read the Emacs Manual\tView the Emacs manual using Info
1062 \(Non)Warranty\tGNU Emacs comes with "
1063 :face (variable-pitch :slant oblique)
1064 "ABSOLUTELY NO WARRANTY\n"
1065 :face variable-pitch
1066 "\
1067 Copying Conditions\tConditions for redistributing and changing Emacs
1068 More Manuals / Ordering Manuals Buying printed manuals from the FSF\n")
1069 (:face variable-pitch
1070 "You can do basic editing with the menu bar and scroll bar \
1071 using the mouse.\n\n"
1072 :face (variable-pitch :weight bold)
1073 "Useful File menu items:\n"
1074 :face variable-pitch "\
1075 Exit Emacs\t(Or type Control-x followed by Control-c)
1076 Recover Crashed Session\tRecover files you were editing before a crash
1077
1078
1079
1080
1081 "
1082 ))
1083 "A list of texts to show in the middle part of splash screens.
1084 Each element in the list should be a list of strings or pairs
1085 `:face FACE', like `fancy-splash-insert' accepts them.")
1086
1087
1088 (defgroup fancy-splash-screen ()
1089 "Fancy splash screen when Emacs starts."
1090 :version "21.1"
1091 :group 'initialization)
1092
1093
1094 (defcustom fancy-splash-delay 7
1095 "*Delay in seconds between splash screens."
1096 :group 'fancy-splash-screen
1097 :type 'integer)
1098
1099
1100 (defcustom fancy-splash-max-time 30
1101 "*Show splash screens for at most this number of seconds.
1102 Values less than twice `fancy-splash-delay' are ignored."
1103 :group 'fancy-splash-screen
1104 :type 'integer)
1105
1106
1107 (defcustom fancy-splash-image nil
1108 "*The image to show in the splash screens, or nil for defaults."
1109 :group 'fancy-splash-screen
1110 :type '(choice (const :tag "Default" nil)
1111 (file :tag "File")))
1112
1113
1114 ;; These are temporary storage areas for the splash screen display.
1115
1116 (defvar fancy-current-text nil)
1117 (defvar fancy-splash-help-echo nil)
1118 (defvar fancy-splash-stop-time nil)
1119 (defvar fancy-splash-outer-buffer nil)
1120
1121 (defun fancy-splash-insert (&rest args)
1122 "Insert text into the current buffer, with faces.
1123 Arguments from ARGS should be either strings, functions called
1124 with no args that return a string, or pairs `:face FACE',
1125 where FACE is a valid face specification, as it can be used with
1126 `put-text-property'."
1127 (let ((current-face nil))
1128 (while args
1129 (if (eq (car args) :face)
1130 (setq args (cdr args) current-face (car args))
1131 (insert (propertize (let ((it (car args)))
1132 (if (functionp it)
1133 (funcall it)
1134 it))
1135 'face current-face
1136 'help-echo fancy-splash-help-echo)))
1137 (setq args (cdr args)))))
1138
1139
1140 (defun fancy-splash-head ()
1141 "Insert the head part of the splash screen into the current buffer."
1142 (let* ((image-file (cond ((stringp fancy-splash-image)
1143 fancy-splash-image)
1144 ((and (display-color-p)
1145 (image-type-available-p 'xpm))
1146 (if (and (fboundp 'x-display-planes)
1147 (= (funcall 'x-display-planes) 8))
1148 "splash8.xpm"
1149 "splash.xpm"))
1150 (t "splash.pbm")))
1151 (img (create-image image-file))
1152 (image-width (and img (car (image-size img))))
1153 (window-width (window-width (selected-window))))
1154 (when img
1155 (when (> window-width image-width)
1156 ;; Center the image in the window.
1157 (insert (propertize " " 'display
1158 `(space :align-to (+ center (-0.5 . ,img)))))
1159
1160 ;; Change the color of the XPM version of the splash image
1161 ;; so that it is visible with a dark frame background.
1162 (when (and (memq 'xpm img)
1163 (eq (frame-parameter nil 'background-mode) 'dark))
1164 (setq img (append img '(:color-symbols (("#000000" . "gray30"))))))
1165
1166 ;; Insert the image with a help-echo and a keymap.
1167 (let ((map (make-sparse-keymap))
1168 (help-echo "mouse-2: browse http://www.gnu.org/"))
1169 (define-key map [mouse-2]
1170 (lambda ()
1171 (interactive)
1172 (browse-url "http://www.gnu.org/")
1173 (throw 'exit nil)))
1174 (define-key map [down-mouse-2] 'ignore)
1175 (define-key map [up-mouse-2] 'ignore)
1176 (insert-image img (propertize "xxx" 'help-echo help-echo
1177 'keymap map)))
1178 (insert "\n"))))
1179 (fancy-splash-insert
1180 :face '(variable-pitch :foreground "red")
1181 (if (eq system-type 'gnu/linux)
1182 "GNU Emacs is one component of the GNU/Linux operating system."
1183 "GNU Emacs is one component of the GNU operating system."))
1184 (insert "\n")
1185 (unless (equal (buffer-name fancy-splash-outer-buffer) "*scratch*")
1186 (fancy-splash-insert :face 'variable-pitch
1187 (substitute-command-keys
1188 "Type \\[recenter] to begin editing your file.\n"))))
1189
1190
1191 (defun fancy-splash-tail ()
1192 "Insert the tail part of the splash screen into the current buffer."
1193 (let ((fg (if (eq (frame-parameter nil 'background-mode) 'dark)
1194 "cyan" "darkblue")))
1195 (fancy-splash-insert :face `(variable-pitch :foreground ,fg)
1196 "\nThis is "
1197 (emacs-version)
1198 "\n"
1199 :face '(variable-pitch :height 0.5)
1200 "Copyright (C) 2005 Free Software Foundation, Inc.")
1201 (and auto-save-list-file-prefix
1202 ;; Don't signal an error if the
1203 ;; directory for auto-save-list files
1204 ;; does not yet exist.
1205 (file-directory-p (file-name-directory
1206 auto-save-list-file-prefix))
1207 (directory-files
1208 (file-name-directory auto-save-list-file-prefix)
1209 nil
1210 (concat "\\`"
1211 (regexp-quote (file-name-nondirectory
1212 auto-save-list-file-prefix)))
1213 t)
1214 (fancy-splash-insert :face '(variable-pitch :foreground "red")
1215 "\n\nIf an Emacs session crashed recently, "
1216 "type M-x recover-session RET\nto recover"
1217 " the files you were editing."))))
1218
1219 (defun fancy-splash-screens-1 (buffer)
1220 "Timer function displaying a splash screen."
1221 (when (> (float-time) fancy-splash-stop-time)
1222 (throw 'stop-splashing nil))
1223 (unless fancy-current-text
1224 (setq fancy-current-text fancy-splash-text))
1225 (let ((text (car fancy-current-text)))
1226 (set-buffer buffer)
1227 (erase-buffer)
1228 (if pure-space-overflow
1229 (insert "Warning Warning Pure space overflow Warning Warning\n"))
1230 (fancy-splash-head)
1231 (apply #'fancy-splash-insert text)
1232 (fancy-splash-tail)
1233 (unless (current-message)
1234 (message fancy-splash-help-echo))
1235 (set-buffer-modified-p nil)
1236 (goto-char (point-min))
1237 (force-mode-line-update)
1238 (setq fancy-current-text (cdr fancy-current-text))))
1239
1240
1241 (defun fancy-splash-default-action ()
1242 "Stop displaying the splash screen buffer.
1243 This is an internal function used to turn off the splash screen after
1244 the user caused an input event by hitting a key or clicking with the
1245 mouse."
1246 (interactive)
1247 (push last-command-event unread-command-events)
1248 (throw 'exit nil))
1249
1250
1251 (defun fancy-splash-screens ()
1252 "Display fancy splash screens when Emacs starts."
1253 (setq fancy-splash-help-echo (startup-echo-area-message))
1254 (let ((old-hourglass display-hourglass)
1255 (fancy-splash-outer-buffer (current-buffer))
1256 splash-buffer
1257 (old-minor-mode-map-alist minor-mode-map-alist)
1258 (frame (fancy-splash-frame))
1259 timer)
1260 (save-selected-window
1261 (select-frame frame)
1262 (switch-to-buffer "GNU Emacs")
1263 (setq tab-width 20)
1264 (setq splash-buffer (current-buffer))
1265 (catch 'stop-splashing
1266 (unwind-protect
1267 (let ((map (make-sparse-keymap)))
1268 (use-local-map map)
1269 (define-key map [switch-frame] 'ignore)
1270 (define-key map [t] 'fancy-splash-default-action)
1271 (define-key map [mouse-movement] 'ignore)
1272 (define-key map [mode-line t] 'ignore)
1273 (setq cursor-type nil
1274 display-hourglass nil
1275 minor-mode-map-alist nil
1276 buffer-undo-list t
1277 mode-line-format (propertize "---- %b %-"
1278 'face '(:weight bold))
1279 fancy-splash-stop-time (+ (float-time)
1280 fancy-splash-max-time)
1281 timer (run-with-timer 0 fancy-splash-delay
1282 #'fancy-splash-screens-1
1283 splash-buffer))
1284 (recursive-edit))
1285 (cancel-timer timer)
1286 (setq display-hourglass old-hourglass
1287 minor-mode-map-alist old-minor-mode-map-alist)
1288 (kill-buffer splash-buffer))))))
1289
1290 (defun fancy-splash-frame ()
1291 "Return the frame to use for the fancy splash screen.
1292 Returning non-nil does not mean we should necessarily
1293 use the fancy splash screen, but if we do use it,
1294 we put it on this frame."
1295 (let (chosen-frame)
1296 (dolist (frame (append (frame-list) (list (selected-frame))))
1297 (if (and (frame-visible-p frame)
1298 (not (window-minibuffer-p (frame-selected-window frame))))
1299 (setq chosen-frame frame)))
1300 chosen-frame))
1301
1302 (defun use-fancy-splash-screens-p ()
1303 "Return t if fancy splash screens should be used."
1304 (when (and (display-graphic-p)
1305 (or (and (display-color-p)
1306 (image-type-available-p 'xpm))
1307 (image-type-available-p 'pbm)))
1308 (let ((frame (fancy-splash-frame)))
1309 (when frame
1310 (let* ((img (create-image (or fancy-splash-image
1311 (if (and (display-color-p)
1312 (image-type-available-p 'xpm))
1313 "splash.xpm" "splash.pbm"))))
1314 (image-height (and img (cdr (image-size img))))
1315 (window-height (1- (window-height (frame-selected-window frame)))))
1316 (> window-height (+ image-height 19)))))))
1317
1318
1319 (defun normal-splash-screen ()
1320 "Display splash screen when Emacs starts."
1321 (let ((prev-buffer (current-buffer)))
1322 (unwind-protect
1323 (with-current-buffer (get-buffer-create "GNU Emacs")
1324 (let ((tab-width 8)
1325 (mode-line-format (propertize "---- %b %-"
1326 'face '(:weight bold))))
1327
1328 (if pure-space-overflow
1329 (insert "Warning Warning Pure space overflow Warning Warning\n"))
1330
1331 ;; The convention for this piece of code is that
1332 ;; each piece of output starts with one or two newlines
1333 ;; and does not end with any newlines.
1334 (insert "Welcome to GNU Emacs")
1335 (insert
1336 (if (eq system-type 'gnu/linux)
1337 ", one component of the GNU/Linux operating system.\n"
1338 ", a part of the GNU operating system.\n"))
1339
1340 (unless (equal (buffer-name prev-buffer) "*scratch*")
1341 (insert (substitute-command-keys
1342 "\nType \\[recenter] to begin editing your file.\n")))
1343
1344 (if (display-mouse-p)
1345 ;; The user can use the mouse to activate menus
1346 ;; so give help in terms of menu items.
1347 (progn
1348 (insert "\
1349 You can do basic editing with the menu bar and scroll bar using the mouse.
1350
1351 Useful File menu items:
1352 Exit Emacs (or type Control-x followed by Control-c)
1353 Recover Session recover files you were editing before a crash
1354
1355 Important Help menu items:
1356 Emacs Tutorial Learn-by-doing tutorial for using Emacs efficiently.
1357 Emacs FAQ Frequently asked questions and answers
1358 Read the Emacs Manual View the Emacs manual using Info
1359 \(Non)Warranty GNU Emacs comes with ABSOLUTELY NO WARRANTY
1360 Copying Conditions Conditions for redistributing and changing Emacs.
1361 Getting New Versions How to obtain the latest version of Emacs.
1362 More Manuals / Ordering Manuals How to order printed manuals from the FSF.
1363 ")
1364 (insert "\n\n" (emacs-version)
1365 "
1366 Copyright (C) 2004 Free Software Foundation, Inc."))
1367
1368 ;; No mouse menus, so give help using kbd commands.
1369
1370 ;; If keys have their default meanings,
1371 ;; use precomputed string to save lots of time.
1372 (if (and (eq (key-binding "\C-h") 'help-command)
1373 (eq (key-binding "\C-xu") 'advertised-undo)
1374 (eq (key-binding "\C-x\C-c") 'save-buffers-kill-emacs)
1375 (eq (key-binding "\C-ht") 'help-with-tutorial)
1376 (eq (key-binding "\C-hi") 'info)
1377 (eq (key-binding "\C-hr") 'info-emacs-manual)
1378 (eq (key-binding "\C-h\C-n") 'view-emacs-news))
1379 (insert "
1380 Get help C-h (Hold down CTRL and press h)
1381 Emacs manual C-h r
1382 Emacs tutorial C-h t Undo changes C-x u
1383 Buy manuals C-h C-m Exit Emacs C-x C-c
1384 Browse manuals C-h i")
1385
1386 (insert (substitute-command-keys
1387 (format "\n
1388 Get help %s
1389 Emacs manual \\[info-emacs-manual]
1390 Emacs tutorial \\[help-with-tutorial]\tUndo changes\t\\[advertised-undo]
1391 Buy manuals \\[view-order-manuals]\tExit Emacs\t\\[save-buffers-kill-emacs]
1392 Browse manuals \\[info]"
1393 (let ((where (where-is-internal
1394 'help-command nil t)))
1395 (if where
1396 (key-description where)
1397 "M-x help"))))))
1398
1399 ;; Say how to use the menu bar with the keyboard.
1400 (if (and (eq (key-binding "\M-`") 'tmm-menubar)
1401 (eq (key-binding [f10]) 'tmm-menubar))
1402 (insert "
1403 Activate menubar F10 or ESC ` or M-`")
1404 (insert (substitute-command-keys "
1405 Activate menubar \\[tmm-menubar]")))
1406
1407 ;; Many users seem to have problems with these.
1408 (insert "
1409 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
1410 If you have no Meta key, you may instead type ESC followed by the character.)")
1411
1412 (insert "\n\n" (emacs-version)
1413 "
1414 Copyright (C) 2004 Free Software Foundation, Inc.")
1415
1416 (if (and (eq (key-binding "\C-h\C-c") 'describe-copying)
1417 (eq (key-binding "\C-h\C-d") 'describe-distribution)
1418 (eq (key-binding "\C-h\C-w") 'describe-no-warranty))
1419 (insert
1420 "\n
1421 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for full details.
1422 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
1423 of Emacs and modify it; type C-h C-c to see the conditions.
1424 Type C-h C-d for information on getting the latest version.")
1425 (insert (substitute-command-keys
1426 "\n
1427 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for full details.
1428 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
1429 of Emacs and modify it; type \\[describe-copying] to see the conditions.
1430 Type \\[describe-distribution] for information on getting the latest version."))))
1431
1432 ;; The rest of the startup screen is the same on all
1433 ;; kinds of terminals.
1434
1435 ;; Give information on recovering, if there was a crash.
1436 (and auto-save-list-file-prefix
1437 ;; Don't signal an error if the
1438 ;; directory for auto-save-list files
1439 ;; does not yet exist.
1440 (file-directory-p (file-name-directory
1441 auto-save-list-file-prefix))
1442 (directory-files
1443 (file-name-directory auto-save-list-file-prefix)
1444 nil
1445 (concat "\\`"
1446 (regexp-quote (file-name-nondirectory
1447 auto-save-list-file-prefix)))
1448 t)
1449 (insert "\n\nIf an Emacs session crashed recently, "
1450 "type M-x recover-session RET\nto recover"
1451 " the files you were editing."))
1452
1453 ;; Display the input that we set up in the buffer.
1454 (set-buffer-modified-p nil)
1455 (goto-char (point-min))
1456 (save-window-excursion
1457 (switch-to-buffer (current-buffer))
1458 (sit-for 120))))
1459 ;; Unwind ... ensure splash buffer is killed
1460 (kill-buffer "GNU Emacs"))))
1461
1462
1463 (defun startup-echo-area-message ()
1464 (if (eq (key-binding "\C-h\C-p") 'describe-project)
1465 "For information about the GNU Project and its goals, type C-h C-p."
1466 (substitute-command-keys
1467 "For information about the GNU Project and its goals, type \
1468 \\[describe-project].")))
1469
1470
1471 (defun display-startup-echo-area-message ()
1472 (let ((resize-mini-windows t))
1473 (message (startup-echo-area-message))))
1474
1475
1476 (defun display-splash-screen ()
1477 "Display splash screen according to display.
1478 Fancy splash screens are used on graphic displays,
1479 normal otherwise."
1480 (interactive)
1481 (if (use-fancy-splash-screens-p)
1482 (fancy-splash-screens)
1483 (normal-splash-screen)))
1484
1485
1486 (defun command-line-1 (command-line-args-left)
1487 (or noninteractive (input-pending-p) init-file-had-error
1488 ;; t if the init file says to inhibit the echo area startup message.
1489 (and inhibit-startup-echo-area-message
1490 user-init-file
1491 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
1492 (equal inhibit-startup-echo-area-message
1493 (if (equal init-file-user "")
1494 (user-login-name)
1495 init-file-user)))
1496 ;; Wasn't set with custom; see if .emacs has a setq.
1497 (let ((buffer (get-buffer-create " *temp*")))
1498 (prog1
1499 (condition-case nil
1500 (save-excursion
1501 (set-buffer buffer)
1502 (insert-file-contents user-init-file)
1503 (re-search-forward
1504 (concat
1505 "([ \t\n]*setq[ \t\n]+"
1506 "inhibit-startup-echo-area-message[ \t\n]+"
1507 (regexp-quote
1508 (prin1-to-string
1509 (if (equal init-file-user "")
1510 (user-login-name)
1511 init-file-user)))
1512 "[ \t\n]*)")
1513 nil t))
1514 (error nil))
1515 (kill-buffer buffer)))))
1516 ;; display-splash-screen at the end of command-line-1 calls
1517 ;; use-fancy-splash-screens-p. This can cause image.el to be
1518 ;; loaded, putting "Loading image... done" in the echo area.
1519 ;; This hides startup-echo-area-message. So
1520 ;; use-fancy-splash-screens-p is called here simply to get the
1521 ;; loading of image.el (if needed) out of the way before
1522 ;; display-startup-echo-area-message runs.
1523 (progn
1524 (use-fancy-splash-screens-p)
1525 (display-startup-echo-area-message)))
1526
1527 ;; Delay 2 seconds after an init file error message
1528 ;; was displayed, so user can read it.
1529 (when init-file-had-error
1530 (sit-for 2))
1531
1532 (when command-line-args-left
1533 ;; We have command args; process them.
1534 (let ((dir command-line-default-directory)
1535 (file-count 0)
1536 first-file-buffer
1537 tem
1538 ;; This approach loses for "-batch -L DIR --eval "(require foo)",
1539 ;; if foo is intended to be found in DIR.
1540 ;;
1541 ;; ;; The directories listed in --directory/-L options will *appear*
1542 ;; ;; at the front of `load-path' in the order they appear on the
1543 ;; ;; command-line. We cannot do this by *placing* them at the front
1544 ;; ;; in the order they appear, so we need this variable to hold them,
1545 ;; ;; temporarily.
1546 ;; extra-load-path
1547 ;;
1548 ;; To DTRT we keep track of the splice point and modify `load-path'
1549 ;; straight away upon any --directory/-L option.
1550 splice
1551 just-files ;; t if this follows the magic -- option.
1552 ;; This includes our standard options' long versions
1553 ;; and long versions of what's on command-switch-alist.
1554 (longopts
1555 (append '(("--funcall") ("--load") ("--insert") ("--kill")
1556 ("--directory") ("--eval") ("--execute") ("--no-splash")
1557 ("--find-file") ("--visit") ("--file"))
1558 (mapcar (lambda (elt)
1559 (list (concat "-" (car elt))))
1560 command-switch-alist)))
1561 (line 0)
1562 (column 0))
1563
1564 ;; Add the long X options to longopts.
1565 (dolist (tem command-line-x-option-alist)
1566 (if (string-match "^--" (car tem))
1567 (push (list (car tem)) longopts)))
1568
1569 ;; Loop, processing options.
1570 (while command-line-args-left
1571 (let* ((argi (car command-line-args-left))
1572 (orig-argi argi)
1573 argval completion)
1574 (setq command-line-args-left (cdr command-line-args-left))
1575
1576 ;; Do preliminary decoding of the option.
1577 (if just-files
1578 ;; After --, don't look for options; treat all args as files.
1579 (setq argi "")
1580 ;; Convert long options to ordinary options
1581 ;; and separate out an attached option argument into argval.
1582 (when (string-match "^\\(--[^=]*\\)=" argi)
1583 (setq argval (substring argi (match-end 0))
1584 argi (match-string 1 argi)))
1585 (if (equal argi "--")
1586 (setq completion nil)
1587 (setq completion (try-completion argi longopts)))
1588 (if (eq completion t)
1589 (setq argi (substring argi 1))
1590 (if (stringp completion)
1591 (let ((elt (assoc completion longopts)))
1592 (or elt
1593 (error "Option `%s' is ambiguous" argi))
1594 (setq argi (substring (car elt) 1)))
1595 (setq argval nil
1596 argi orig-argi))))
1597
1598 ;; Execute the option.
1599 (cond ((setq tem (assoc argi command-switch-alist))
1600 (if argval
1601 (let ((command-line-args-left
1602 (cons argval command-line-args-left)))
1603 (funcall (cdr tem) argi))
1604 (funcall (cdr tem) argi)))
1605
1606 ((equal argi "-no-splash")
1607 (setq inhibit-startup-message t))
1608
1609 ((member argi '("-f" ; what the manual claims
1610 "-funcall"
1611 "-e")) ; what the source used to say
1612 (setq tem (intern (or argval (pop command-line-args-left))))
1613 (if (commandp tem)
1614 (command-execute tem)
1615 (funcall tem)))
1616
1617 ((member argi '("-eval" "-execute"))
1618 (eval (read (or argval (pop command-line-args-left)))))
1619
1620 ((member argi '("-L" "-directory"))
1621 (setq tem (expand-file-name
1622 (command-line-normalize-file-name
1623 (or argval (pop command-line-args-left)))))
1624 (cond (splice (setcdr splice (cons tem (cdr splice)))
1625 (setq splice (cdr splice)))
1626 (t (setq load-path (cons tem load-path)
1627 splice load-path))))
1628
1629 ((member argi '("-l" "-load"))
1630 (let* ((file (command-line-normalize-file-name
1631 (or argval (pop command-line-args-left))))
1632 ;; Take file from default dir if it exists there;
1633 ;; otherwise let `load' search for it.
1634 (file-ex (expand-file-name file)))
1635 (when (file-exists-p file-ex)
1636 (setq file file-ex))
1637 (load file nil t)))
1638
1639 ((equal argi "-insert")
1640 (setq tem (or argval (pop command-line-args-left)))
1641 (or (stringp tem)
1642 (error "File name omitted from `-insert' option"))
1643 (insert-file-contents (command-line-normalize-file-name tem)))
1644
1645 ((equal argi "-kill")
1646 (kill-emacs t))
1647
1648 ((string-match "^\\+[0-9]+\\'" argi)
1649 (setq line (string-to-number argi)))
1650
1651 ((string-match "^\\+\\([0-9]+\\):\\([0-9]+\\)\\'" argi)
1652 (setq line (string-to-number (match-string 1 argi))
1653 column (string-to-number (match-string 2 argi))))
1654
1655 ((setq tem (assoc argi command-line-x-option-alist))
1656 ;; Ignore X-windows options and their args if not using X.
1657 (setq command-line-args-left
1658 (nthcdr (nth 1 tem) command-line-args-left)))
1659
1660 ((member argi '("-find-file" "-file" "-visit"))
1661 ;; An explicit option to specify visiting a file.
1662 (setq tem (or argval (pop command-line-args-left)))
1663 (unless (stringp tem)
1664 (error "File name omitted from `%s' option" argi))
1665 (setq file-count (1+ file-count))
1666 (let ((file (expand-file-name
1667 (command-line-normalize-file-name tem) dir)))
1668 (if (= file-count 1)
1669 (setq first-file-buffer (find-file file))
1670 (find-file-other-window file)))
1671 (or (zerop line)
1672 (goto-line line))
1673 (setq line 0)
1674 (unless (< column 1)
1675 (move-to-column (1- column)))
1676 (setq column 0))
1677
1678 ((equal argi "--")
1679 (setq just-files t))
1680 (t
1681 ;; We have almost exhausted our options. See if the
1682 ;; user has made any other command-line options available
1683 (let ((hooks command-line-functions) ;; lrs 7/31/89
1684 (did-hook nil))
1685 (while (and hooks
1686 (not (setq did-hook (funcall (car hooks)))))
1687 (setq hooks (cdr hooks)))
1688 (if (not did-hook)
1689 ;; Presume that the argument is a file name.
1690 (progn
1691 (if (string-match "\\`-" argi)
1692 (error "Unknown option `%s'" argi))
1693 (setq file-count (1+ file-count))
1694 (let ((file
1695 (expand-file-name
1696 (command-line-normalize-file-name orig-argi)
1697 dir)))
1698 (if (= file-count 1)
1699 (setq first-file-buffer (find-file file))
1700 (find-file-other-window file)))
1701 (or (zerop line)
1702 (goto-line line))
1703 (setq line 0)
1704 (unless (< column 1)
1705 (move-to-column (1- column)))
1706 (setq column 0))))))))
1707
1708 ;; If 3 or more files visited, and not all visible,
1709 ;; show user what they all are. But leave the last one current.
1710 (and (> file-count 2)
1711 (not noninteractive)
1712 (not inhibit-startup-buffer-menu)
1713 (or (get-buffer-window first-file-buffer)
1714 (list-buffers)))))
1715
1716 ;; Maybe display a startup screen.
1717 (unless (or inhibit-startup-message
1718 noninteractive
1719 emacs-quick-startup
1720 ;; Don't display startup screen if init file
1721 ;; has started some sort of server.
1722 (and (fboundp 'process-list)
1723 (process-list)))
1724 ;; Display a startup screen, after some preparations.
1725
1726 ;; If there are no switches to process, we might as well
1727 ;; run this hook now, and there may be some need to do it
1728 ;; before doing any output.
1729 (run-hooks 'emacs-startup-hook)
1730 (and term-setup-hook
1731 (run-hooks 'term-setup-hook))
1732 (setq inhibit-startup-hooks t)
1733
1734 ;; It's important to notice the user settings before we
1735 ;; display the startup message; otherwise, the settings
1736 ;; won't take effect until the user gives the first
1737 ;; keystroke, and that's distracting.
1738 (when (fboundp 'frame-notice-user-settings)
1739 (frame-notice-user-settings))
1740
1741 ;; If there are no switches to process, we might as well
1742 ;; run this hook now, and there may be some need to do it
1743 ;; before doing any output.
1744 (when window-setup-hook
1745 (run-hooks 'window-setup-hook)
1746 ;; Don't let the hook be run twice.
1747 (setq window-setup-hook nil))
1748
1749 ;; Do this now to avoid an annoying delay if the user
1750 ;; clicks the menu bar during the sit-for.
1751 (when (display-popup-menus-p)
1752 (precompute-menubar-bindings))
1753 (with-no-warnings
1754 (setq menubar-bindings-done t))
1755
1756 ;; If *scratch* is selected and it is empty, insert an
1757 ;; initial message saying not to create a file there.
1758 (when (and initial-scratch-message
1759 (equal (buffer-name) "*scratch*")
1760 (= 0 (buffer-size)))
1761 (insert initial-scratch-message)
1762 (set-buffer-modified-p nil))
1763
1764 ;; If user typed input during all that work,
1765 ;; abort the startup screen. Otherwise, display it now.
1766 (unless (input-pending-p)
1767 (display-splash-screen))))
1768
1769
1770 (defun command-line-normalize-file-name (file)
1771 "Collapse multiple slashes to one, to handle non-Emacs file names."
1772 (save-match-data
1773 ;; Use arg 1 so that we don't collapse // at the start of the file name.
1774 ;; That is significant on some systems.
1775 ;; However, /// at the beginning is supposed to mean just /, not //.
1776 (if (string-match "^///+" file)
1777 (setq file (replace-match "/" t t file)))
1778 (while (string-match "//+" file 1)
1779 (setq file (replace-match "/" t t file)))
1780 file))
1781
1782 ;; arch-tag: 7e294698-244d-4758-984b-4047f887a5db
1783 ;;; startup.el ends here