]> code.delx.au - gnu-emacs/blob - lisp/startup.el
Merge from emacs--devo--0
[gnu-emacs] / lisp / startup.el
1 ;;; startup.el --- process Emacs shell arguments
2
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
6
7 ;; Maintainer: FSF
8 ;; Keywords: internal
9
10 ;; This file is part of GNU Emacs.
11
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.
16
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.
21
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.
26
27 ;;; Commentary:
28
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.
32
33 ;;; Code:
34
35 (setq top-level '(normal-top-level))
36
37 (defvar command-line-processed nil
38 "Non-nil once command line has been processed.")
39
40 (defgroup initialization nil
41 "Emacs start-up procedure."
42 :group 'environment)
43
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)
56
57 (defcustom inhibit-startup-screen nil
58 "Non-nil inhibits the startup screen.
59 It also inhibits display of the initial message in the `*scratch*' buffer.
60
61 This is for use in your personal init file (but NOT site-start.el), once
62 you are familiar with the contents of the startup screen."
63 :type 'boolean
64 :group 'initialization)
65
66 (defvaralias 'inhibit-splash-screen 'inhibit-startup-screen)
67 (defvaralias 'inhibit-startup-message 'inhibit-startup-screen)
68
69 (defvar startup-screen-inhibit-startup-screen nil)
70
71 (defcustom inhibit-startup-echo-area-message nil
72 "*Non-nil inhibits the initial startup echo area message.
73 Setting this variable takes effect
74 only if you do it with the customization buffer
75 or if your `.emacs' file contains a line of this form:
76 (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\")
77 If your `.emacs' file is byte-compiled, use the following form instead:
78 (eval '(setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\"))
79 Thus, someone else using a copy of your `.emacs' file will see
80 the startup message unless he personally acts to inhibit it."
81 :type '(choice (const :tag "Don't inhibit")
82 (string :tag "Enter your user name, to inhibit"))
83 :group 'initialization)
84
85 (defcustom inhibit-default-init nil
86 "*Non-nil inhibits loading the `default' library."
87 :type 'boolean
88 :group 'initialization)
89
90 (defcustom inhibit-startup-buffer-menu nil
91 "*Non-nil inhibits display of buffer list when more than 2 files are loaded."
92 :type 'boolean
93 :group 'initialization)
94
95 (defvar command-switch-alist nil
96 "Alist of command-line switches.
97 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
98 HANDLER-FUNCTION receives the switch string as its sole argument;
99 the remaining command-line args are in the variable `command-line-args-left'.")
100
101 (defvar command-line-args-left nil
102 "List of command-line args not yet processed.")
103
104 (defvaralias 'argv 'command-line-args-left
105 "List of command-line args not yet processed.
106 This is a convenience alias, so that one can write \(pop argv\)
107 inside of --eval command line arguments in order to access
108 following arguments.")
109
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.")
117
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.")
121
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).")
186
187 (defvar before-init-hook nil
188 "Normal hook run after handling urgent options but before loading init files.")
189
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.")
195
196 (defvar emacs-startup-hook nil
197 "Normal hook run after loading init files and handling the command line.")
198
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.")
204
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.")
208
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.")
214
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.")
219
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)
224
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.
229
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.
234
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.
238
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'.")
241
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'.
249
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.
256
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")))
266
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)
271
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".
278 "")
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)
285
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"))
290 (t
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)
302
303 (defvar emacs-quick-startup nil)
304
305 (defvar emacs-basic-display nil)
306
307 (defvar init-file-debug nil)
308
309 (defvar init-file-had-error nil
310 "Non-nil if there was an error loading the user's init file.")
311
312 (defvar normal-top-level-add-subdirs-inode-list nil)
313
314 (defvar no-blinking-cursor nil)
315
316 (defvar default-frame-background-mode)
317
318 (defvar pure-space-overflow nil
319 "Non-nil if building Emacs overflowed pure space.")
320
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")
324
325 (defvar tutorial-directory nil
326 "Directory containing the Emacs TUTORIAL files.")
327
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))))
332
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)))))
371
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))))))
390
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)
454 t)
455 (concat
456 (make-temp-name
457 (expand-file-name
458 auto-save-list-file-prefix))
459 "~"))
460 (t
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)))
470
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))))
488
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)))))
515
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))
530
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")))
539
540 (defconst tool-bar-images-pixel-height 24
541 "Height in pixels of images in the tool bar.")
542
543 (defvar tool-bar-originally-present nil
544 "Non-nil if tool-bars are present before user and site init files are read.")
545
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.")
552
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).")
559
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)
600 i)
601 (setq argval (invocation-name))
602
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))
622 (t
623 (push argi rest)))))
624 (nreverse rest)))
625
626 (defun command-line ()
627 (setq command-line-default-directory default-directory)
628
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)
633
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))))
643
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))
649
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)")))
663
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)))
697
698 (set-locale-environment nil)
699
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))))
722
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)))
729
730 (let ((done nil)
731 (args (cdr command-line-args)))
732
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 ""))
740
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.
791 (t
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))))
797
798 ;; Re-attach the program name to the front of the arg list.
799 (and command-line-args
800 (setcdr command-line-args args)))
801
802 (run-hooks 'before-init-hook)
803
804 ;; Under X Window, this creates the X frame and deletes the terminal frame.
805 (when (fboundp 'frame-initialize)
806 (frame-initialize))
807
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))
816
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))
823
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))
830
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)
841 (custom-reevaluate-setting 'global-auto-composition-mode)
842
843 (normal-erase-is-backspace-setup-frame)
844
845 ;; Register default TTY colors for the case the terminal hasn't a
846 ;; terminal init file. We do this regardles of whether the terminal
847 ;; supports colors or not and regardless the current display type,
848 ;; since users can connect to color-capable terminals and also
849 ;; switch color support on or off in mid-session by setting the
850 ;; tty-color-mode frame parameter.
851 (tty-register-default-colors)
852
853 ;; Record whether the tool-bar is present before the user and site
854 ;; init files are processed. frame-notice-user-settings uses this
855 ;; to determine if the tool-bar has been disabled by the init files,
856 ;; and the frame needs to be resized.
857 (when (fboundp 'frame-notice-user-settings)
858 (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
859 (assq 'tool-bar-lines default-frame-alist))))
860 (setq tool-bar-originally-present
861 (and tool-bar-lines
862 (cdr tool-bar-lines)
863 (not (eq 0 (cdr tool-bar-lines)))))))
864
865 (let ((old-scalable-fonts-allowed scalable-fonts-allowed)
866 (old-font-list-limit font-list-limit)
867 (old-face-ignored-fonts face-ignored-fonts))
868
869 ;; Run the site-start library if it exists. The point of this file is
870 ;; that it is run before .emacs. There is no point in doing this after
871 ;; .emacs; that is useless.
872 ;; Note that user-init-file is nil at this point. Code that might
873 ;; be loaded from site-run-file and wants to test if -q was given
874 ;; should check init-file-user instead, since that is already set.
875 ;; See cus-edit.el for an example.
876 (if site-run-file
877 (load site-run-file t t))
878
879 ;; Sites should not disable this. Only individuals should disable
880 ;; the startup screen.
881 (setq inhibit-startup-screen nil)
882
883 ;; Warn for invalid user name.
884 (when init-file-user
885 (if (string-match "[~/:\n]" init-file-user)
886 (display-warning 'initialization
887 (format "Invalid user name %s"
888 init-file-user)
889 :error)
890 (if (file-directory-p (expand-file-name
891 ;; We don't support ~USER on MS-Windows except
892 ;; for the current user, and always load .emacs
893 ;; from the current user's home directory (see
894 ;; below). So always check "~", even if invoked
895 ;; with "-u USER", or if $USER or $LOGNAME are
896 ;; set to something different.
897 (if (eq system-type 'windows-nt)
898 "~"
899 (concat "~" init-file-user))))
900 nil
901 (display-warning 'initialization
902 (format "User %s has no home directory"
903 init-file-user)
904 :error))))
905
906 ;; Load that user's init file, or the default one, or none.
907 (let (debug-on-error-from-init-file
908 debug-on-error-should-be-set
909 (debug-on-error-initial
910 (if (eq init-file-debug t) 'startup init-file-debug))
911 (orig-enable-multibyte default-enable-multibyte-characters))
912 (let ((debug-on-error debug-on-error-initial)
913 ;; This function actually reads the init files.
914 (inner
915 (function
916 (lambda ()
917 (if init-file-user
918 (let ((user-init-file-1
919 (cond
920 ((eq system-type 'ms-dos)
921 (concat "~" init-file-user "/_emacs"))
922 ((eq system-type 'windows-nt)
923 ;; Prefer .emacs on Windows.
924 (if (directory-files "~" nil "^\\.emacs\\(\\.elc?\\)?$")
925 "~/.emacs"
926 ;; Also support _emacs for compatibility.
927 (if (directory-files "~" nil "^_emacs\\(\\.elc?\\)?$")
928 "~/_emacs"
929 ;; But default to .emacs if _emacs does not exist.
930 "~/.emacs")))
931 ((eq system-type 'vax-vms)
932 "sys$login:.emacs")
933 (t
934 (concat "~" init-file-user "/.emacs")))))
935 ;; This tells `load' to store the file name found
936 ;; into user-init-file.
937 (setq user-init-file t)
938 (load user-init-file-1 t t)
939
940 (when (eq user-init-file t)
941 ;; If we did not find ~/.emacs, try
942 ;; ~/.emacs.d/init.el.
943 (let ((otherfile
944 (expand-file-name
945 "init"
946 (file-name-as-directory
947 (concat "~" init-file-user "/.emacs.d")))))
948 (load otherfile t t)
949
950 ;; If we did not find the user's init file,
951 ;; set user-init-file conclusively.
952 ;; Don't let it be set from default.el.
953 (when (eq user-init-file t)
954 (setq user-init-file user-init-file-1))))
955
956 ;; If we loaded a compiled file, set
957 ;; `user-init-file' to the source version if that
958 ;; exists.
959 (when (and user-init-file
960 (equal (file-name-extension user-init-file)
961 "elc"))
962 (let* ((source (file-name-sans-extension user-init-file))
963 (alt (concat source ".el")))
964 (setq source (cond ((file-exists-p alt) alt)
965 ((file-exists-p source) source)
966 (t nil)))
967 (when source
968 (when (file-newer-than-file-p source user-init-file)
969 (message "Warning: %s is newer than %s"
970 source user-init-file)
971 (sit-for 1))
972 (setq user-init-file source))))
973
974 (unless inhibit-default-init
975 (let ((inhibit-startup-screen nil))
976 ;; Users are supposed to be told their rights.
977 ;; (Plus how to get help and how to undo.)
978 ;; Don't you dare turn this off for anyone
979 ;; except yourself.
980 (load "default" t t)))))))))
981 (if init-file-debug
982 ;; Do this without a condition-case if the user wants to debug.
983 (funcall inner)
984 (condition-case error
985 (progn
986 (funcall inner)
987 (setq init-file-had-error nil))
988 (error
989 (let ((message-log-max nil))
990 (save-excursion
991 (set-buffer (get-buffer-create "*Messages*"))
992 (insert "\n\n"
993 (format "An error has occurred while loading `%s':\n\n"
994 user-init-file)
995 (format "%s%s%s"
996 (get (car error) 'error-message)
997 (if (cdr error) ": " "")
998 (mapconcat (lambda (s) (prin1-to-string s t)) (cdr error) ", "))
999 "\n\n"
1000 "To ensure normal operation, you should investigate and remove the\n"
1001 "cause of the error in your initialization file. Start Emacs with\n"
1002 "the `--debug-init' option to view a complete error backtrace.\n\n"))
1003 (message "Error in init file: %s%s%s"
1004 (get (car error) 'error-message)
1005 (if (cdr error) ": " "")
1006 (mapconcat 'prin1-to-string (cdr error) ", "))
1007 (let ((pop-up-windows nil))
1008 (pop-to-buffer "*Messages*"))
1009 (setq init-file-had-error t)))))
1010
1011 (if (and deactivate-mark transient-mark-mode)
1012 (with-current-buffer (window-buffer)
1013 (deactivate-mark)))
1014
1015 ;; If the user has a file of abbrevs, read it (unless -batch).
1016 (when (and (not noninteractive)
1017 (file-exists-p abbrev-file-name)
1018 (file-readable-p abbrev-file-name))
1019 (quietly-read-abbrev-file abbrev-file-name))
1020
1021 ;; If the abbrevs came entirely from the init file or the
1022 ;; abbrevs file, they do not need saving.
1023 (setq abbrevs-changed nil)
1024
1025 ;; If we can tell that the init file altered debug-on-error,
1026 ;; arrange to preserve the value that it set up.
1027 (or (eq debug-on-error debug-on-error-initial)
1028 (setq debug-on-error-should-be-set t
1029 debug-on-error-from-init-file debug-on-error)))
1030 (if debug-on-error-should-be-set
1031 (setq debug-on-error debug-on-error-from-init-file))
1032 (unless (or default-enable-multibyte-characters
1033 (eq orig-enable-multibyte default-enable-multibyte-characters))
1034 ;; Init file changed to unibyte. Reset existing multibyte
1035 ;; buffers (probably *scratch*, *Messages*, *Minibuff-0*).
1036 ;; Arguably this should only be done if they're free of
1037 ;; multibyte characters.
1038 (mapc (lambda (buffer)
1039 (with-current-buffer buffer
1040 (if enable-multibyte-characters
1041 (set-buffer-multibyte nil))))
1042 (buffer-list))
1043 ;; Also re-set the language environment in case it was
1044 ;; originally done before unibyte was set and is sensitive to
1045 ;; unibyte (display table, terminal coding system &c).
1046 (set-language-environment current-language-environment)))
1047
1048 ;; Do this here in case the init file sets mail-host-address.
1049 (if (equal user-mail-address "")
1050 (setq user-mail-address (or (getenv "EMAIL")
1051 (concat (user-login-name) "@"
1052 (or mail-host-address
1053 (system-name))))))
1054
1055 ;; Originally face attributes were specified via
1056 ;; `font-lock-face-attributes'. Users then changed the default
1057 ;; face attributes by setting that variable. However, we try and
1058 ;; be back-compatible and respect its value if set except for
1059 ;; faces where M-x customize has been used to save changes for the
1060 ;; face.
1061 (when (boundp 'font-lock-face-attributes)
1062 (let ((face-attributes font-lock-face-attributes))
1063 (while face-attributes
1064 (let* ((face-attribute (pop face-attributes))
1065 (face (car face-attribute)))
1066 ;; Rustle up a `defface' SPEC from a
1067 ;; `font-lock-face-attributes' entry.
1068 (unless (get face 'saved-face)
1069 (let ((foreground (nth 1 face-attribute))
1070 (background (nth 2 face-attribute))
1071 (bold-p (nth 3 face-attribute))
1072 (italic-p (nth 4 face-attribute))
1073 (underline-p (nth 5 face-attribute))
1074 face-spec)
1075 (when foreground
1076 (setq face-spec (cons ':foreground (cons foreground face-spec))))
1077 (when background
1078 (setq face-spec (cons ':background (cons background face-spec))))
1079 (when bold-p
1080 (setq face-spec (append '(:weight bold) face-spec)))
1081 (when italic-p
1082 (setq face-spec (append '(:slant italic) face-spec)))
1083 (when underline-p
1084 (setq face-spec (append '(:underline t) face-spec)))
1085 (face-spec-set face (list (list t face-spec)) nil)))))))
1086
1087 ;; If parameter have been changed in the init file which influence
1088 ;; face realization, clear the face cache so that new faces will
1089 ;; be realized.
1090 (unless (and (eq scalable-fonts-allowed old-scalable-fonts-allowed)
1091 (eq font-list-limit old-font-list-limit)
1092 (eq face-ignored-fonts old-face-ignored-fonts))
1093 (clear-face-cache)))
1094
1095 (run-hooks 'after-init-hook)
1096
1097 ;; Decode all default-directory.
1098 (if (and default-enable-multibyte-characters locale-coding-system)
1099 (save-excursion
1100 (dolist (elt (buffer-list))
1101 (set-buffer elt)
1102 (if default-directory
1103 (setq default-directory
1104 (decode-coding-string default-directory
1105 locale-coding-system t))))
1106 (setq command-line-default-directory
1107 (decode-coding-string command-line-default-directory
1108 locale-coding-system t))))
1109
1110 ;; If *scratch* exists and init file didn't change its mode, initialize it.
1111 (if (get-buffer "*scratch*")
1112 (with-current-buffer "*scratch*"
1113 (if (eq major-mode 'fundamental-mode)
1114 (funcall initial-major-mode))))
1115
1116 ;; Load library for our terminal type.
1117 ;; User init file can set term-file-prefix to nil to prevent this.
1118 (unless (or noninteractive
1119 initial-window-system)
1120 (tty-run-terminal-initialization (selected-frame)))
1121
1122 ;; Update the out-of-memory error message based on user's key bindings
1123 ;; for save-some-buffers.
1124 (setq memory-signal-data
1125 (list 'error
1126 (substitute-command-keys "Memory exhausted--use \\[save-some-buffers] then exit and restart Emacs")))
1127
1128 ;; Process the remaining args.
1129 (command-line-1 (cdr command-line-args))
1130
1131 ;; If -batch, terminate after processing the command options.
1132 (if noninteractive (kill-emacs t))
1133
1134 ;; Run emacs-session-restore (session management) if started by
1135 ;; the session manager and we have a session manager connection.
1136 (if (and (boundp 'x-session-previous-id)
1137 (stringp x-session-previous-id))
1138 (with-no-warnings
1139 (emacs-session-restore x-session-previous-id))))
1140
1141 (defcustom initial-scratch-message (purecopy "\
1142 ;; This buffer is for notes you don't want to save, and for Lisp evaluation.
1143 ;; If you want to create a file, visit that file with C-x C-f,
1144 ;; then enter the text in that file's own buffer.
1145
1146 ")
1147 "Initial message displayed in *scratch* buffer at startup.
1148 If this is nil, no message will be displayed.
1149 If `inhibit-startup-screen' is non-nil, then no message is displayed,
1150 regardless of the value of this variable."
1151 :type '(choice (text :tag "Message")
1152 (const :tag "none" nil))
1153 :group 'initialization)
1154
1155 \f
1156 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1157 ;;; Fancy splash screen
1158 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1159
1160 (defvar fancy-startup-text
1161 '((:face (variable-pitch (:foreground "red"))
1162 "Welcome to "
1163 :link ("GNU Emacs"
1164 (lambda (button) (browse-url "http://www.gnu.org/software/emacs/"))
1165 "Browse http://www.gnu.org/software/emacs/")
1166 ", one component of the "
1167 :link
1168 (lambda ()
1169 (if (eq system-type 'gnu/linux)
1170 '("GNU/Linux"
1171 (lambda (button) (browse-url "http://www.gnu.org/gnu/linux-and-gnu.html"))
1172 "Browse http://www.gnu.org/gnu/linux-and-gnu.html")
1173 '("GNU" (lambda (button) (describe-project))
1174 "Display info on the GNU project")))
1175 " operating system.\n"
1176 :face variable-pitch "To quit a partially entered command, type "
1177 :face default "Control-g"
1178 :face variable-pitch ".\n\n"
1179 :link ("Emacs Tutorial" (lambda (button) (help-with-tutorial)))
1180 "\tLearn basic keystroke commands"
1181 (lambda ()
1182 (let* ((en "TUTORIAL")
1183 (tut (or (get-language-info current-language-environment
1184 'tutorial)
1185 en))
1186 (title (with-temp-buffer
1187 (insert-file-contents
1188 (expand-file-name tut tutorial-directory)
1189 nil 0 256)
1190 (search-forward ".")
1191 (buffer-substring (point-min) (1- (point))))))
1192 ;; If there is a specific tutorial for the current language
1193 ;; environment and it is not English, append its title.
1194 (if (string= en tut)
1195 ""
1196 (concat " (" title ")"))))
1197 "\n"
1198 :face variable-pitch
1199 :link ("Emacs Guided Tour"
1200 (lambda (button) (browse-url "http://www.gnu.org/software/emacs/tour/"))
1201 "Browse http://www.gnu.org/software/emacs/tour/")
1202 "\tOverview of Emacs features\n"
1203 :link ("View Emacs Manual" (lambda (button) (info-emacs-manual)))
1204 "\tView the Emacs manual using Info\n"
1205 :link ("Absence of Warranty" (lambda (button) (describe-no-warranty)))
1206 "\tGNU Emacs comes with "
1207 :face (variable-pitch (:slant oblique))
1208 "ABSOLUTELY NO WARRANTY\n"
1209 :face variable-pitch
1210 :link ("Copying Conditions" (lambda (button) (describe-copying)))
1211 "\tConditions for redistributing and changing Emacs\n"
1212 :link ("Ordering Manuals" (lambda (button) (view-order-manuals)))
1213 "\tPurchasing printed copies of manuals\n"
1214 "\n"))
1215 "A list of texts to show in the middle part of splash screens.
1216 Each element in the list should be a list of strings or pairs
1217 `:face FACE', like `fancy-splash-insert' accepts them.")
1218
1219 (defvar fancy-about-text
1220 '((:face (variable-pitch (:foreground "red"))
1221 "This is "
1222 :link ("GNU Emacs"
1223 (lambda (button) (browse-url "http://www.gnu.org/software/emacs/"))
1224 "Browse http://www.gnu.org/software/emacs/")
1225 ", one component of the "
1226 :link
1227 (lambda ()
1228 (if (eq system-type 'gnu/linux)
1229 '("GNU/Linux"
1230 (lambda (button) (browse-url "http://www.gnu.org/gnu/linux-and-gnu.html"))
1231 "Browse http://www.gnu.org/gnu/linux-and-gnu.html")
1232 '("GNU" (lambda (button) (describe-project))
1233 "Display info on the GNU project.")))
1234 " operating system.\n"
1235 :face (lambda ()
1236 (list 'variable-pitch
1237 (list :foreground
1238 (if (eq (frame-parameter nil 'background-mode) 'dark)
1239 "cyan" "darkblue"))))
1240 "\n"
1241 (lambda () (emacs-version))
1242 "\n"
1243 :face (variable-pitch (:height 0.5))
1244 (lambda () emacs-copyright)
1245 "\n\n"
1246 :face variable-pitch
1247 :link ("Authors"
1248 (lambda (button)
1249 (view-file (expand-file-name "AUTHORS" data-directory))
1250 (goto-char (point-min))))
1251 "\tMany people have contributed code included in GNU Emacs\n"
1252 :link ("Contributing"
1253 (lambda (button)
1254 (view-file (expand-file-name "CONTRIBUTE" data-directory))
1255 (goto-char (point-min))))
1256 "\tHow to contribute improvements to Emacs\n"
1257 "\n"
1258 :link ("GNU and Freedom" (lambda (button) (describe-project)))
1259 "\tWhy we developed GNU Emacs, and the GNU operating system\n"
1260 :link ("Absence of Warranty" (lambda (button) (describe-no-warranty)))
1261 "\tGNU Emacs comes with "
1262 :face (variable-pitch (:slant oblique))
1263 "ABSOLUTELY NO WARRANTY\n"
1264 :face variable-pitch
1265 :link ("Copying Conditions" (lambda (button) (describe-copying)))
1266 "\tConditions for redistributing and changing Emacs\n"
1267 :link ("Getting New Versions" (lambda (button) (describe-distribution)))
1268 "\tHow to obtain the latest version of Emacs\n"
1269 :link ("Ordering Manuals" (lambda (button) (view-order-manuals)))
1270 "\tBuying printed manuals from the FSF\n"
1271 "\n"
1272 :link ("Emacs Tutorial" (lambda (button) (help-with-tutorial)))
1273 "\tLearn basic Emacs keystroke commands"
1274 (lambda ()
1275 (let* ((en "TUTORIAL")
1276 (tut (or (get-language-info current-language-environment
1277 'tutorial)
1278 en))
1279 (title (with-temp-buffer
1280 (insert-file-contents
1281 (expand-file-name tut tutorial-directory)
1282 nil 0 256)
1283 (search-forward ".")
1284 (buffer-substring (point-min) (1- (point))))))
1285 ;; If there is a specific tutorial for the current language
1286 ;; environment and it is not English, append its title.
1287 (if (string= en tut)
1288 ""
1289 (concat " (" title ")"))))
1290 "\n"
1291 :link ("Emacs Guided Tour"
1292 (lambda (button) (browse-url "http://www.gnu.org/software/emacs/tour/"))
1293 "Browse http://www.gnu.org/software/emacs/tour/")
1294 "\tSee an overview of the many facilities of GNU Emacs"
1295 ))
1296 "A list of texts to show in the middle part of the About screen.
1297 Each element in the list should be a list of strings or pairs
1298 `:face FACE', like `fancy-splash-insert' accepts them.")
1299
1300
1301 (defgroup fancy-splash-screen ()
1302 "Fancy splash screen when Emacs starts."
1303 :version "21.1"
1304 :group 'initialization)
1305
1306 (defcustom fancy-splash-image nil
1307 "*The image to show in the splash screens, or nil for defaults."
1308 :group 'fancy-splash-screen
1309 :type '(choice (const :tag "Default" nil)
1310 (file :tag "File")))
1311
1312
1313 (defvar splash-screen-keymap
1314 (let ((map (make-sparse-keymap)))
1315 (suppress-keymap map)
1316 (set-keymap-parent map button-buffer-map)
1317 (define-key map "\C-?" 'scroll-down)
1318 (define-key map " " 'scroll-up)
1319 (define-key map "q" 'exit-splash-screen)
1320 map)
1321 "Keymap for splash screen buffer.")
1322
1323 ;; These are temporary storage areas for the splash screen display.
1324
1325 (defun fancy-splash-insert (&rest args)
1326 "Insert text into the current buffer, with faces.
1327 Arguments from ARGS should be either strings; functions called
1328 with no args that return a string; pairs `:face FACE', where FACE
1329 is a face specification usable with `put-text-property'; or pairs
1330 `:link LINK' where LINK is a list of arguments to pass to
1331 `insert-button', of the form (LABEL ACTION [HELP-ECHO]), which
1332 specifies the button's label, `action' property and help-echo string.
1333 FACE and LINK can also be functions, which are evaluated to obtain
1334 a face or button specification."
1335 (let ((current-face nil))
1336 (while args
1337 (cond ((eq (car args) :face)
1338 (setq args (cdr args) current-face (car args))
1339 (if (functionp current-face)
1340 (setq current-face (funcall current-face))))
1341 ((eq (car args) :link)
1342 (setq args (cdr args))
1343 (let ((spec (car args)))
1344 (if (functionp spec)
1345 (setq spec (funcall spec)))
1346 (insert-button (car spec)
1347 'face (list 'link current-face)
1348 'action (cadr spec)
1349 'help-echo (concat "mouse-2, RET: "
1350 (or (nth 2 spec)
1351 "Follow this link"))
1352 'follow-link t)))
1353 (t (insert (propertize (let ((it (car args)))
1354 (if (functionp it)
1355 (funcall it)
1356 it))
1357 'face current-face
1358 'help-echo (startup-echo-area-message)))))
1359 (setq args (cdr args)))))
1360
1361
1362 (defun fancy-splash-head ()
1363 "Insert the head part of the splash screen into the current buffer."
1364 (let* ((image-file (cond ((stringp fancy-splash-image)
1365 fancy-splash-image)
1366 ((and (display-color-p)
1367 (image-type-available-p 'xpm))
1368 (if (and (fboundp 'x-display-planes)
1369 (= (funcall 'x-display-planes) 8))
1370 "splash8.xpm"
1371 "splash.xpm"))
1372 (t "splash.pbm")))
1373 (img (create-image image-file))
1374 (image-width (and img (car (image-size img))))
1375 (window-width (window-width (selected-window))))
1376 (when img
1377 (when (> window-width image-width)
1378 ;; Center the image in the window.
1379 (insert (propertize " " 'display
1380 `(space :align-to (+ center (-0.5 . ,img)))))
1381
1382 ;; Change the color of the XPM version of the splash image
1383 ;; so that it is visible with a dark frame background.
1384 (when (and (memq 'xpm img)
1385 (eq (frame-parameter nil 'background-mode) 'dark))
1386 (setq img (append img '(:color-symbols (("#000000" . "gray30"))))))
1387
1388 ;; Insert the image with a help-echo and a link.
1389 (make-button (prog1 (point) (insert-image img)) (point)
1390 'face 'default
1391 'help-echo "mouse-2, RET: Browse http://www.gnu.org/"
1392 'action (lambda (button) (browse-url "http://www.gnu.org/"))
1393 'follow-link t)
1394 (insert "\n\n")))))
1395
1396 (defun fancy-startup-tail (&optional concise)
1397 "Insert the tail part of the splash screen into the current buffer."
1398 (let ((fg (if (eq (frame-parameter nil 'background-mode) 'dark)
1399 "cyan" "darkblue")))
1400 (unless concise
1401 (fancy-splash-insert
1402 :face 'variable-pitch
1403 "\nTo start... "
1404 :link '("Open a File"
1405 (lambda (button) (call-interactively 'find-file))
1406 "Specify a new file's name, to edit the file")
1407 " "
1408 :link '("Open Home Directory"
1409 (lambda (button) (dired "~"))
1410 "Open your home directory, to operate on its files")
1411 " "
1412 :link '("Customize Startup"
1413 (lambda (button) (customize-group 'initialization))
1414 "Change initialization settings including this screen")
1415 "\n"))
1416 (fancy-splash-insert :face `(variable-pitch (:foreground ,fg))
1417 "\nThis is "
1418 (emacs-version)
1419 "\n"
1420 :face '(variable-pitch (:height 0.5))
1421 emacs-copyright
1422 "\n")
1423 (and auto-save-list-file-prefix
1424 ;; Don't signal an error if the
1425 ;; directory for auto-save-list files
1426 ;; does not yet exist.
1427 (file-directory-p (file-name-directory
1428 auto-save-list-file-prefix))
1429 (directory-files
1430 (file-name-directory auto-save-list-file-prefix)
1431 nil
1432 (concat "\\`"
1433 (regexp-quote (file-name-nondirectory
1434 auto-save-list-file-prefix)))
1435 t)
1436 (fancy-splash-insert :face '(variable-pitch (:foreground "red"))
1437 "\nIf an Emacs session crashed recently, "
1438 "type "
1439 :face '(fixed-pitch :foreground "red")
1440 "Meta-x recover-session RET"
1441 :face '(variable-pitch (:foreground "red"))
1442 "\nto recover"
1443 " the files you were editing."))
1444
1445 (when concise
1446 (fancy-splash-insert
1447 :face 'variable-pitch "\n"
1448 :link '("Dismiss this startup screen"
1449 (lambda (button)
1450 (when startup-screen-inhibit-startup-screen
1451 (customize-set-variable 'inhibit-startup-screen t)
1452 (customize-mark-to-save 'inhibit-startup-screen)
1453 (custom-save-all))
1454 (let ((w (get-buffer-window "*GNU Emacs*")))
1455 (and w (not (one-window-p)) (delete-window w)))
1456 (kill-buffer "*GNU Emacs*")))
1457 " ")
1458 (when (or user-init-file custom-file)
1459 (let ((checked (create-image "\300\300\141\143\067\076\034\030"
1460 'xbm t :width 8 :height 8 :background "grey75"
1461 :foreground "black" :relief -2 :ascent 'center))
1462 (unchecked (create-image (make-string 8 0)
1463 'xbm t :width 8 :height 8 :background "grey75"
1464 :foreground "black" :relief -2 :ascent 'center)))
1465 (insert-button
1466 " " :on-glyph checked :off-glyph unchecked 'checked nil
1467 'display unchecked 'follow-link t
1468 'action (lambda (button)
1469 (if (overlay-get button 'checked)
1470 (progn (overlay-put button 'checked nil)
1471 (overlay-put button 'display (overlay-get button :off-glyph))
1472 (setq startup-screen-inhibit-startup-screen nil))
1473 (overlay-put button 'checked t)
1474 (overlay-put button 'display (overlay-get button :on-glyph))
1475 (setq startup-screen-inhibit-startup-screen t)))))
1476 (fancy-splash-insert :face '(variable-pitch (:height 0.9))
1477 " Never show it again.")))))
1478
1479 (defun exit-splash-screen ()
1480 "Stop displaying the splash screen buffer."
1481 (interactive)
1482 (quit-window t))
1483
1484 (defun fancy-startup-screen (&optional concise)
1485 "Display fancy startup screen.
1486 If CONCISE is non-nil, display a concise version of the
1487 splash screen in another window."
1488 (let ((splash-buffer (get-buffer-create "*GNU Emacs*")))
1489 (with-current-buffer splash-buffer
1490 (let ((inhibit-read-only t))
1491 (erase-buffer)
1492 (make-local-variable 'startup-screen-inhibit-startup-screen)
1493 (if pure-space-overflow
1494 (insert pure-space-overflow-message))
1495 (unless concise
1496 (fancy-splash-head))
1497 (dolist (text fancy-startup-text)
1498 (apply #'fancy-splash-insert text)
1499 (insert "\n"))
1500 (skip-chars-backward "\n")
1501 (delete-region (point) (point-max))
1502 (insert "\n")
1503 (fancy-startup-tail concise))
1504 (use-local-map splash-screen-keymap)
1505 (setq tab-width 22
1506 buffer-read-only t)
1507 (set-buffer-modified-p nil)
1508 (if (and view-read-only (not view-mode))
1509 (view-mode-enter nil 'kill-buffer))
1510 (goto-char (point-min))
1511 (forward-line (if concise 2 4)))
1512 (if concise
1513 (progn
1514 (display-buffer splash-buffer)
1515 ;; If the splash screen is in a split window, fit it.
1516 (let ((window (get-buffer-window splash-buffer t)))
1517 (or (null window)
1518 (eq window (selected-window))
1519 (eq window (next-window window))
1520 (fit-window-to-buffer window))))
1521 (switch-to-buffer splash-buffer))))
1522
1523 (defun fancy-about-screen ()
1524 "Display fancy About screen."
1525 (let ((frame (fancy-splash-frame)))
1526 (save-selected-window
1527 (select-frame frame)
1528 (switch-to-buffer "*About GNU Emacs*")
1529 (setq buffer-undo-list t
1530 mode-line-format (propertize "---- %b %-"
1531 'face 'mode-line-buffer-id))
1532 (let ((inhibit-read-only t))
1533 (erase-buffer)
1534 (if pure-space-overflow
1535 (insert pure-space-overflow-message))
1536 (fancy-splash-head)
1537 (dolist (text fancy-about-text)
1538 (apply #'fancy-splash-insert text)
1539 (insert "\n"))
1540 (set-buffer-modified-p nil)
1541 (goto-char (point-min))
1542 (force-mode-line-update))
1543 (use-local-map splash-screen-keymap)
1544 (setq tab-width 22)
1545 (message "%s" (startup-echo-area-message))
1546 (setq buffer-read-only t)
1547 (goto-char (point-min))
1548 (forward-line 3))))
1549
1550 (defun fancy-splash-frame ()
1551 "Return the frame to use for the fancy splash screen.
1552 Returning non-nil does not mean we should necessarily
1553 use the fancy splash screen, but if we do use it,
1554 we put it on this frame."
1555 (let (chosen-frame)
1556 (dolist (frame (append (frame-list) (list (selected-frame))))
1557 (if (and (frame-visible-p frame)
1558 (not (window-minibuffer-p (frame-selected-window frame))))
1559 (setq chosen-frame frame)))
1560 chosen-frame))
1561
1562 (defun use-fancy-splash-screens-p ()
1563 "Return t if fancy splash screens should be used."
1564 (when (and (display-graphic-p)
1565 (or (and (display-color-p)
1566 (image-type-available-p 'xpm))
1567 (image-type-available-p 'pbm)))
1568 (let ((frame (fancy-splash-frame)))
1569 (when frame
1570 (let* ((img (create-image (or fancy-splash-image
1571 (if (and (display-color-p)
1572 (image-type-available-p 'xpm))
1573 "splash.xpm" "splash.pbm"))))
1574 (image-height (and img (cdr (image-size img nil frame))))
1575 ;; We test frame-height so that, if the frame is split
1576 ;; by displaying a warning, that doesn't cause the normal
1577 ;; splash screen to be used.
1578 (frame-height (1- (frame-height frame))))
1579 (> frame-height (+ image-height 19)))))))
1580
1581
1582 (defun normal-splash-screen (&optional startup)
1583 "Display non-graphic splash screen.
1584 If optional argument STARTUP is non-nil, display the startup screen
1585 after Emacs starts. If STARTUP is nil, display the About screen."
1586 (let ((prev-buffer (current-buffer)))
1587 (with-current-buffer (get-buffer-create "*About GNU Emacs*")
1588 (setq buffer-read-only nil)
1589 (erase-buffer)
1590 (set (make-local-variable 'tab-width) 8)
1591 (if (not startup)
1592 (set (make-local-variable 'mode-line-format)
1593 (propertize "---- %b %-" 'face 'mode-line-buffer-id)))
1594
1595 (if pure-space-overflow
1596 (insert pure-space-overflow-message))
1597
1598 ;; The convention for this piece of code is that
1599 ;; each piece of output starts with one or two newlines
1600 ;; and does not end with any newlines.
1601 (insert (if startup "Welcome to GNU Emacs" "This is GNU Emacs"))
1602 (insert
1603 (if (eq system-type 'gnu/linux)
1604 ", one component of the GNU/Linux operating system.\n"
1605 ", a part of the GNU operating system.\n"))
1606
1607 (if startup
1608 (if (display-mouse-p)
1609 ;; The user can use the mouse to activate menus
1610 ;; so give help in terms of menu items.
1611 (normal-mouse-startup-screen)
1612
1613 ;; No mouse menus, so give help using kbd commands.
1614 (normal-no-mouse-startup-screen))
1615
1616 (normal-about-screen))
1617
1618 ;; The rest of the startup screen is the same on all
1619 ;; kinds of terminals.
1620
1621 ;; Give information on recovering, if there was a crash.
1622 (and startup
1623 auto-save-list-file-prefix
1624 ;; Don't signal an error if the
1625 ;; directory for auto-save-list files
1626 ;; does not yet exist.
1627 (file-directory-p (file-name-directory
1628 auto-save-list-file-prefix))
1629 (directory-files
1630 (file-name-directory auto-save-list-file-prefix)
1631 nil
1632 (concat "\\`"
1633 (regexp-quote (file-name-nondirectory
1634 auto-save-list-file-prefix)))
1635 t)
1636 (insert "\n\nIf an Emacs session crashed recently, "
1637 "type Meta-x recover-session RET\nto recover"
1638 " the files you were editing.\n"))
1639
1640 (use-local-map splash-screen-keymap)
1641
1642 ;; Display the input that we set up in the buffer.
1643 (set-buffer-modified-p nil)
1644 (setq buffer-read-only t)
1645 (if (and view-read-only (not view-mode))
1646 (view-mode-enter nil 'kill-buffer))
1647 (switch-to-buffer "*About GNU Emacs*")
1648 (if startup (rename-buffer "*GNU Emacs*" t))
1649 (goto-char (point-min)))))
1650
1651 (defun normal-mouse-startup-screen ()
1652 ;; The user can use the mouse to activate menus
1653 ;; so give help in terms of menu items.
1654 (insert "\
1655 To follow a link, click Mouse-1 on it, or move to it and type RET.
1656 To quit a partially entered command, type Control-g.\n")
1657
1658 (insert "\nImportant Help menu items:\n")
1659 (insert-button "Emacs Tutorial"
1660 'action (lambda (button) (help-with-tutorial))
1661 'follow-link t)
1662 (insert "\t\tLearn basic Emacs keystroke commands\n")
1663 (insert-button "Read the Emacs Manual"
1664 'action (lambda (button) (info-emacs-manual))
1665 'follow-link t)
1666 (insert "\tView the Emacs manual using Info\n")
1667 (insert-button "\(Non)Warranty"
1668 'action (lambda (button) (describe-no-warranty))
1669 'follow-link t)
1670 (insert "\t\tGNU Emacs comes with ABSOLUTELY NO WARRANTY\n")
1671 (insert-button "Copying Conditions"
1672 'action (lambda (button) (describe-copying))
1673 'follow-link t)
1674 (insert "\tConditions for redistributing and changing Emacs\n")
1675 (insert-button "More Manuals / Ordering Manuals"
1676 'action (lambda (button) (view-order-manuals))
1677 'follow-link t)
1678 (insert " How to order printed manuals from the FSF\n")
1679
1680 (insert "\nUseful tasks:\n")
1681 (insert-button "Visit New File"
1682 'action (lambda (button) (call-interactively 'find-file))
1683 'follow-link t)
1684 (insert "\t\tSpecify a new file's name, to edit the file\n")
1685 (insert-button "Open Home Directory"
1686 'action (lambda (button) (dired "~"))
1687 'follow-link t)
1688 (insert "\tOpen your home directory, to operate on its files\n")
1689 (insert-button "Customize Startup"
1690 'action (lambda (button) (customize-group 'initialization))
1691 'follow-link t)
1692 (insert "\tChange initialization settings including this screen\n")
1693
1694 (insert "\n" (emacs-version)
1695 "\n" emacs-copyright))
1696
1697 ;; No mouse menus, so give help using kbd commands.
1698 (defun normal-no-mouse-startup-screen ()
1699
1700 ;; If keys have their default meanings,
1701 ;; use precomputed string to save lots of time.
1702 (if (and (eq (key-binding "\C-h") 'help-command)
1703 (eq (key-binding "\C-xu") 'advertised-undo)
1704 (eq (key-binding "\C-x\C-c") 'save-buffers-kill-terminal)
1705 (eq (key-binding "\C-ht") 'help-with-tutorial)
1706 (eq (key-binding "\C-hi") 'info)
1707 (eq (key-binding "\C-hr") 'info-emacs-manual)
1708 (eq (key-binding "\C-h\C-n") 'view-emacs-news))
1709 (progn
1710 (insert "
1711 Get help\t C-h (Hold down CTRL and press h)
1712 ")
1713 (insert-button "Emacs manual"
1714 'action (lambda (button) (info-emacs-manual))
1715 'follow-link t)
1716 (insert " C-h r\t")
1717 (insert-button "Browse manuals"
1718 'action (lambda (button) (Info-directory))
1719 'follow-link t)
1720 (insert "\t C-h i
1721 ")
1722 (insert-button "Emacs tutorial"
1723 'action (lambda (button) (help-with-tutorial))
1724 'follow-link t)
1725 (insert " C-h t\tUndo changes\t C-x u
1726 ")
1727 (insert-button "Buy manuals"
1728 'action (lambda (button) (view-order-manuals))
1729 'follow-link t)
1730 (insert "\t C-h C-m\tExit Emacs\t C-x C-c"))
1731
1732 (insert (format "
1733 Get help\t %s
1734 "
1735 (let ((where (where-is-internal
1736 'help-command nil t)))
1737 (if where
1738 (key-description where)
1739 "M-x help"))))
1740 (insert-button "Emacs manual"
1741 'action (lambda (button) (info-emacs-manual))
1742 'follow-link t)
1743 (insert (substitute-command-keys"\t \\[info-emacs-manual]\t"))
1744 (insert-button "Browse manuals"
1745 'action (lambda (button) (Info-directory))
1746 'follow-link t)
1747 (insert (substitute-command-keys "\t \\[info]
1748 "))
1749 (insert-button "Emacs tutorial"
1750 'action (lambda (button) (help-with-tutorial))
1751 'follow-link t)
1752 (insert (substitute-command-keys
1753 "\t \\[help-with-tutorial]\tUndo changes\t \\[advertised-undo]
1754 "))
1755 (insert-button "Buy manuals"
1756 'action (lambda (button) (view-order-manuals))
1757 'follow-link t)
1758 (insert (substitute-command-keys
1759 "\t \\[view-order-manuals]\tExit Emacs\t \\[save-buffers-kill-terminal]")))
1760
1761 ;; Say how to use the menu bar with the keyboard.
1762 (insert "\n")
1763 (insert-button "Activate menubar"
1764 'action (lambda (button) (tmm-menubar))
1765 'follow-link t)
1766 (if (and (eq (key-binding "\M-`") 'tmm-menubar)
1767 (eq (key-binding [f10]) 'tmm-menubar))
1768 (insert " F10 or ESC ` or M-`")
1769 (insert (substitute-command-keys " \\[tmm-menubar]")))
1770
1771 ;; Many users seem to have problems with these.
1772 (insert "
1773 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
1774 If you have no Meta key, you may instead type ESC followed by the character.)")
1775
1776 ;; Insert links to useful tasks
1777 (insert "\nUseful tasks:\n")
1778
1779 (insert-button "Visit New File"
1780 'action (lambda (button) (call-interactively 'find-file))
1781 'follow-link t)
1782 (insert "\t\t\t")
1783 (insert-button "Open Home Directory"
1784 'action (lambda (button) (dired "~"))
1785 'follow-link t)
1786 (insert "\n")
1787
1788 (insert-button "Customize Startup"
1789 'action (lambda (button) (customize-group 'initialization))
1790 'follow-link t)
1791 (insert "\t\t")
1792 (insert-button "Open *scratch* buffer"
1793 'action (lambda (button) (switch-to-buffer
1794 (get-buffer-create "*scratch*")))
1795 'follow-link t)
1796 (insert "\n")
1797 (insert "\n" (emacs-version) "\n" emacs-copyright "\n")
1798
1799 (if (and (eq (key-binding "\C-h\C-c") 'describe-copying)
1800 (eq (key-binding "\C-h\C-d") 'describe-distribution)
1801 (eq (key-binding "\C-h\C-w") 'describe-no-warranty))
1802 (progn
1803 (insert
1804 "
1805 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for ")
1806 (insert-button "full details"
1807 'action (lambda (button) (describe-no-warranty))
1808 'follow-link t)
1809 (insert ".
1810 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
1811 of Emacs and modify it; type C-h C-c to see ")
1812 (insert-button "the conditions"
1813 'action (lambda (button) (describe-copying))
1814 'follow-link t)
1815 (insert ".
1816 Type C-h C-d for information on ")
1817 (insert-button "getting the latest version"
1818 'action (lambda (button) (describe-distribution))
1819 'follow-link t)
1820 (insert "."))
1821 (insert (substitute-command-keys
1822 "
1823 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for "))
1824 (insert-button "full details"
1825 'action (lambda (button) (describe-no-warranty))
1826 'follow-link t)
1827 (insert (substitute-command-keys ".
1828 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
1829 of Emacs and modify it; type \\[describe-copying] to see "))
1830 (insert-button "the conditions"
1831 'action (lambda (button) (describe-copying))
1832 'follow-link t)
1833 (insert (substitute-command-keys".
1834 Type \\[describe-distribution] for information on "))
1835 (insert-button "getting the latest version"
1836 'action (lambda (button) (describe-distribution))
1837 'follow-link t)
1838 (insert ".")))
1839
1840 (defun normal-about-screen ()
1841 (insert "\n" (emacs-version) "\n" emacs-copyright "\n\n")
1842
1843 (insert "To follow a link, click Mouse-1 on it, or move to it and type RET.\n\n")
1844
1845 (insert-button "Authors"
1846 'action
1847 (lambda (button)
1848 (view-file (expand-file-name "AUTHORS" data-directory))
1849 (goto-char (point-min)))
1850 'follow-link t)
1851 (insert "\t\tMany people have contributed code included in GNU Emacs\n")
1852
1853 (insert-button "Contributing"
1854 'action
1855 (lambda (button)
1856 (view-file (expand-file-name "CONTRIBUTE" data-directory))
1857 (goto-char (point-min)))
1858 'follow-link t)
1859 (insert "\tHow to contribute improvements to Emacs\n\n")
1860
1861 (insert-button "GNU and Freedom"
1862 'action (lambda (button) (describe-project))
1863 'follow-link t)
1864 (insert "\t\tWhy we developed GNU Emacs and the GNU system\n")
1865
1866 (insert-button "Absence of Warranty"
1867 'action (lambda (button) (describe-no-warranty))
1868 'follow-link t)
1869 (insert "\tGNU Emacs comes with ABSOLUTELY NO WARRANTY\n")
1870
1871 (insert-button "Copying Conditions"
1872 'action (lambda (button) (describe-copying))
1873 'follow-link t)
1874 (insert "\tConditions for redistributing and changing Emacs\n")
1875
1876 (insert-button "Getting New Versions"
1877 'action (lambda (button) (describe-distribution))
1878 'follow-link t)
1879 (insert "\tHow to get the latest version of GNU Emacs\n")
1880
1881 (insert-button "More Manuals / Ordering Manuals"
1882 'action (lambda (button) (view-order-manuals))
1883 'follow-link t)
1884 (insert "\tBuying printed manuals from the FSF\n"))
1885
1886 (defun startup-echo-area-message ()
1887 (if (eq (key-binding "\C-h\C-p") 'describe-project)
1888 "For information about GNU Emacs and the GNU system, type C-h C-a."
1889 (substitute-command-keys
1890 "For information about GNU Emacs and the GNU system, type \
1891 \\[about-emacs].")))
1892
1893
1894 (defun display-startup-echo-area-message ()
1895 (let ((resize-mini-windows t))
1896 (or noninteractive ;(input-pending-p) init-file-had-error
1897 ;; t if the init file says to inhibit the echo area startup message.
1898 (and inhibit-startup-echo-area-message
1899 user-init-file
1900 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
1901 (equal inhibit-startup-echo-area-message
1902 (if (equal init-file-user "")
1903 (user-login-name)
1904 init-file-user)))
1905 ;; Wasn't set with custom; see if .emacs has a setq.
1906 (let ((buffer (get-buffer-create " *temp*")))
1907 (prog1
1908 (condition-case nil
1909 (save-excursion
1910 (set-buffer buffer)
1911 (insert-file-contents user-init-file)
1912 (re-search-forward
1913 (concat
1914 "([ \t\n]*setq[ \t\n]+"
1915 "inhibit-startup-echo-area-message[ \t\n]+"
1916 (regexp-quote
1917 (prin1-to-string
1918 (if (equal init-file-user "")
1919 (user-login-name)
1920 init-file-user)))
1921 "[ \t\n]*)")
1922 nil t))
1923 (error nil))
1924 (kill-buffer buffer)))))
1925 (message "%s" (startup-echo-area-message)))))
1926
1927 (defun display-startup-screen (&optional concise)
1928 "Display startup screen according to display.
1929 A fancy display is used on graphic displays, normal otherwise.
1930
1931 If CONCISE is non-nil, display a concise version of the startup
1932 screen."
1933 ;; Prevent recursive calls from server-process-filter.
1934 (if (not (get-buffer "*GNU Emacs*"))
1935 (if (use-fancy-splash-screens-p)
1936 (fancy-startup-screen concise)
1937 (normal-splash-screen t))))
1938
1939 (defun display-about-screen ()
1940 "Display the *About GNU Emacs* buffer.
1941 A fancy display is used on graphic displays, normal otherwise."
1942 (interactive)
1943 (if (use-fancy-splash-screens-p)
1944 (fancy-about-screen)
1945 (normal-splash-screen nil)))
1946
1947 (defalias 'about-emacs 'display-about-screen)
1948 (defalias 'display-splash-screen 'display-startup-screen)
1949
1950 (defun command-line-1 (command-line-args-left)
1951 (display-startup-echo-area-message)
1952
1953 ;; Delay 2 seconds after an init file error message
1954 ;; was displayed, so user can read it.
1955 (when init-file-had-error
1956 (sit-for 2))
1957
1958 (when (and pure-space-overflow
1959 (not noninteractive))
1960 (display-warning
1961 'initialization
1962 "Building Emacs overflowed pure space. (See the node Pure Storage in the Lisp manual for details.)"
1963 :warning))
1964
1965 (let ((file-count 0)
1966 first-file-buffer)
1967 (when command-line-args-left
1968 ;; We have command args; process them.
1969 (let ((dir command-line-default-directory)
1970 tem
1971 ;; This approach loses for "-batch -L DIR --eval "(require foo)",
1972 ;; if foo is intended to be found in DIR.
1973 ;;
1974 ;; ;; The directories listed in --directory/-L options will *appear*
1975 ;; ;; at the front of `load-path' in the order they appear on the
1976 ;; ;; command-line. We cannot do this by *placing* them at the front
1977 ;; ;; in the order they appear, so we need this variable to hold them,
1978 ;; ;; temporarily.
1979 ;; extra-load-path
1980 ;;
1981 ;; To DTRT we keep track of the splice point and modify `load-path'
1982 ;; straight away upon any --directory/-L option.
1983 splice
1984 just-files ;; t if this follows the magic -- option.
1985 ;; This includes our standard options' long versions
1986 ;; and long versions of what's on command-switch-alist.
1987 (longopts
1988 (append '(("--funcall") ("--load") ("--insert") ("--kill")
1989 ("--directory") ("--eval") ("--execute") ("--no-splash")
1990 ("--find-file") ("--visit") ("--file") ("--no-desktop"))
1991 (mapcar (lambda (elt)
1992 (list (concat "-" (car elt))))
1993 command-switch-alist)))
1994 (line 0)
1995 (column 0))
1996
1997 ;; Add the long X options to longopts.
1998 (dolist (tem command-line-x-option-alist)
1999 (if (string-match "^--" (car tem))
2000 (push (list (car tem)) longopts)))
2001
2002 ;; Loop, processing options.
2003 (while command-line-args-left
2004 (let* ((argi (car command-line-args-left))
2005 (orig-argi argi)
2006 argval completion)
2007 (setq command-line-args-left (cdr command-line-args-left))
2008
2009 ;; Do preliminary decoding of the option.
2010 (if just-files
2011 ;; After --, don't look for options; treat all args as files.
2012 (setq argi "")
2013 ;; Convert long options to ordinary options
2014 ;; and separate out an attached option argument into argval.
2015 (when (string-match "^\\(--[^=]*\\)=" argi)
2016 (setq argval (substring argi (match-end 0))
2017 argi (match-string 1 argi)))
2018 (if (equal argi "--")
2019 (setq completion nil)
2020 (setq completion (try-completion argi longopts)))
2021 (if (eq completion t)
2022 (setq argi (substring argi 1))
2023 (if (stringp completion)
2024 (let ((elt (assoc completion longopts)))
2025 (or elt
2026 (error "Option `%s' is ambiguous" argi))
2027 (setq argi (substring (car elt) 1)))
2028 (setq argval nil
2029 argi orig-argi))))
2030
2031 ;; Execute the option.
2032 (cond ((setq tem (assoc argi command-switch-alist))
2033 (if argval
2034 (let ((command-line-args-left
2035 (cons argval command-line-args-left)))
2036 (funcall (cdr tem) argi))
2037 (funcall (cdr tem) argi)))
2038
2039 ((equal argi "-no-splash")
2040 (setq inhibit-startup-screen t))
2041
2042 ((member argi '("-f" ; what the manual claims
2043 "-funcall"
2044 "-e")) ; what the source used to say
2045 (setq inhibit-startup-screen t)
2046 (setq tem (intern (or argval (pop command-line-args-left))))
2047 (if (commandp tem)
2048 (command-execute tem)
2049 (funcall tem)))
2050
2051 ((member argi '("-eval" "-execute"))
2052 (setq inhibit-startup-screen t)
2053 (eval (read (or argval (pop command-line-args-left)))))
2054
2055 ((member argi '("-L" "-directory"))
2056 (setq tem (expand-file-name
2057 (command-line-normalize-file-name
2058 (or argval (pop command-line-args-left)))))
2059 (cond (splice (setcdr splice (cons tem (cdr splice)))
2060 (setq splice (cdr splice)))
2061 (t (setq load-path (cons tem load-path)
2062 splice load-path))))
2063
2064 ((member argi '("-l" "-load"))
2065 (let* ((file (command-line-normalize-file-name
2066 (or argval (pop command-line-args-left))))
2067 ;; Take file from default dir if it exists there;
2068 ;; otherwise let `load' search for it.
2069 (file-ex (expand-file-name file)))
2070 (when (file-exists-p file-ex)
2071 (setq file file-ex))
2072 (load file nil t)))
2073
2074 ;; This is used to handle -script. It's not clear
2075 ;; we need to document it.
2076 ((member argi '("-scriptload"))
2077 (let* ((file (command-line-normalize-file-name
2078 (or argval (pop command-line-args-left))))
2079 ;; Take file from default dir.
2080 (file-ex (expand-file-name file)))
2081 (load file-ex nil t t)))
2082
2083 ((equal argi "-insert")
2084 (setq inhibit-startup-screen t)
2085 (setq tem (or argval (pop command-line-args-left)))
2086 (or (stringp tem)
2087 (error "File name omitted from `-insert' option"))
2088 (insert-file-contents (command-line-normalize-file-name tem)))
2089
2090 ((equal argi "-kill")
2091 (kill-emacs t))
2092
2093 ;; This is for when they use --no-desktop with -q, or
2094 ;; don't load Desktop in their .emacs. If desktop.el
2095 ;; _is_ loaded, it will handle this switch, and we
2096 ;; won't see it by the time we get here.
2097 ((equal argi "-no-desktop")
2098 (message "\"--no-desktop\" ignored because the Desktop package is not loaded"))
2099
2100 ((string-match "^\\+[0-9]+\\'" argi)
2101 (setq line (string-to-number argi)))
2102
2103 ((string-match "^\\+\\([0-9]+\\):\\([0-9]+\\)\\'" argi)
2104 (setq line (string-to-number (match-string 1 argi))
2105 column (string-to-number (match-string 2 argi))))
2106
2107 ((setq tem (assoc argi command-line-x-option-alist))
2108 ;; Ignore X-windows options and their args if not using X.
2109 (setq command-line-args-left
2110 (nthcdr (nth 1 tem) command-line-args-left)))
2111
2112 ((member argi '("-find-file" "-file" "-visit"))
2113 (setq inhibit-startup-screen t)
2114 ;; An explicit option to specify visiting a file.
2115 (setq tem (or argval (pop command-line-args-left)))
2116 (unless (stringp tem)
2117 (error "File name omitted from `%s' option" argi))
2118 (setq file-count (1+ file-count))
2119 (let ((file (expand-file-name
2120 (command-line-normalize-file-name tem) dir)))
2121 (if (= file-count 1)
2122 (setq first-file-buffer (find-file file))
2123 (find-file-other-window file)))
2124 (or (zerop line)
2125 (goto-line line))
2126 (setq line 0)
2127 (unless (< column 1)
2128 (move-to-column (1- column)))
2129 (setq column 0))
2130
2131 ((equal argi "--")
2132 (setq just-files t))
2133 (t
2134 ;; We have almost exhausted our options. See if the
2135 ;; user has made any other command-line options available
2136 (let ((hooks command-line-functions)
2137 (did-hook nil))
2138 (while (and hooks
2139 (not (setq did-hook (funcall (car hooks)))))
2140 (setq hooks (cdr hooks)))
2141 (if (not did-hook)
2142 ;; Presume that the argument is a file name.
2143 (progn
2144 (if (string-match "\\`-" argi)
2145 (error "Unknown option `%s'" argi))
2146 (unless initial-window-system
2147 (setq inhibit-startup-screen t))
2148 (setq file-count (1+ file-count))
2149 (let ((file
2150 (expand-file-name
2151 (command-line-normalize-file-name orig-argi)
2152 dir)))
2153 (cond ((= file-count 1)
2154 (setq first-file-buffer (find-file file)))
2155 (inhibit-startup-screen
2156 (find-file-other-window file))
2157 (t (find-file file))))
2158 (or (zerop line)
2159 (goto-line line))
2160 (setq line 0)
2161 (unless (< column 1)
2162 (move-to-column (1- column)))
2163 (setq column 0))))))
2164 ;; In unusual circumstances, the execution of Lisp code due
2165 ;; to command-line options can cause the last visible frame
2166 ;; to be deleted. In this case, kill emacs to avoid an
2167 ;; abort later.
2168 (unless (frame-live-p (selected-frame)) (kill-emacs nil))))))
2169
2170 (when initial-buffer-choice
2171 (cond ((eq initial-buffer-choice t)
2172 (switch-to-buffer (get-buffer-create "*scratch*")))
2173 ((stringp initial-buffer-choice)
2174 (find-file initial-buffer-choice))))
2175
2176 (if (or inhibit-startup-screen
2177 initial-buffer-choice
2178 noninteractive
2179 emacs-quick-startup)
2180
2181 ;; Not displaying a startup screen. If 3 or more files
2182 ;; visited, and not all visible, show user what they all are.
2183 (and (> file-count 2)
2184 (not noninteractive)
2185 (not inhibit-startup-buffer-menu)
2186 (or (get-buffer-window first-file-buffer)
2187 (list-buffers)))
2188
2189 ;; Display a startup screen, after some preparations.
2190
2191 ;; If there are no switches to process, we might as well
2192 ;; run this hook now, and there may be some need to do it
2193 ;; before doing any output.
2194 (run-hooks 'emacs-startup-hook)
2195 (and term-setup-hook
2196 (run-hooks 'term-setup-hook))
2197 (setq inhibit-startup-hooks t)
2198
2199 ;; It's important to notice the user settings before we
2200 ;; display the startup message; otherwise, the settings
2201 ;; won't take effect until the user gives the first
2202 ;; keystroke, and that's distracting.
2203 (when (fboundp 'frame-notice-user-settings)
2204 (frame-notice-user-settings))
2205
2206 ;; If there are no switches to process, we might as well
2207 ;; run this hook now, and there may be some need to do it
2208 ;; before doing any output.
2209 (when window-setup-hook
2210 (run-hooks 'window-setup-hook)
2211 ;; Don't let the hook be run twice.
2212 (setq window-setup-hook nil))
2213
2214 ;; ;; Do this now to avoid an annoying delay if the user
2215 ;; ;; clicks the menu bar during the sit-for.
2216 ;; (when (display-popup-menus-p)
2217 ;; (precompute-menubar-bindings))
2218 ;; (with-no-warnings
2219 ;; (setq menubar-bindings-done t))
2220
2221 ;; If *scratch* exists and is empty, insert initial-scratch-message.
2222 (and initial-scratch-message
2223 (get-buffer "*scratch*")
2224 (with-current-buffer "*scratch*"
2225 (when (zerop (buffer-size))
2226 (insert initial-scratch-message)
2227 (set-buffer-modified-p nil))))
2228
2229 (if (> file-count 0)
2230 (display-startup-screen t)
2231 (display-startup-screen nil)))))
2232
2233 (defun command-line-normalize-file-name (file)
2234 "Collapse multiple slashes to one, to handle non-Emacs file names."
2235 (save-match-data
2236 ;; Use arg 1 so that we don't collapse // at the start of the file name.
2237 ;; That is significant on some systems.
2238 ;; However, /// at the beginning is supposed to mean just /, not //.
2239 (if (string-match "^///+" file)
2240 (setq file (replace-match "/" t t file)))
2241 (while (string-match "//+" file 1)
2242 (setq file (replace-match "/" t t file)))
2243 file))
2244
2245 ;; arch-tag: 7e294698-244d-4758-984b-4047f887a5db
2246 ;;; startup.el ends here