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