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