startup.el 58.6 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; startup.el --- process Emacs shell arguments

3 4
;; Copyright (C) 1985, 86, 92, 94, 95, 96, 97, 98, 99, 2000
;;   Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: internal
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Jim Blandy's avatar
Jim Blandy committed
9 10 11 12
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
13
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
14 15 16 17 18 19 20 21
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
25

Eric S. Raymond's avatar
Eric S. Raymond committed
26
;;; Commentary:
Jim Blandy's avatar
Jim Blandy committed
27

Richard M. Stallman's avatar
Richard M. Stallman committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
;; This file parses the command line and gets Emacs running.  Options on
;; the command line are handled in precedence order.  The order is the
;; one in the list below; first described means first handled.  Options
;; within each category (delimited by a bar) are handled in the order
;; encountered on the command line.

;; -------------------------
;; -version                  Print Emacs version to stderr, then exit
;; --version                 successfully right away.
;;                           This option is handled by emacs.c
;; -------------------------
;; -help                     Print a short usage description and exit
;; --help                    successfully right away.
;;                           This option is handled by emacs.c
;; -------------------------
;; -nl                       Do not use shared memory (for systems that
;; -no-shared-memory         support this) for the dumped Emacs data.
;;                           This option is handled by emacs.c
;;
;; -map                      For VMS.
;; --map-data                This option is handled by emacs.c
;; -------------------------
;; -t FILE                   Use FILE as the name of the terminal.
;; --terminal FILE           Using this implies "-nw" also.
;;                           This option is handled by emacs.c
;; -------------------------
54
;; -d DISPNAME               Use DISPNAME as the name of the X
Richard M. Stallman's avatar
Richard M. Stallman committed
55 56 57 58 59 60 61 62 63 64 65 66 67
;; -display DISPNAME         display for the initial frame.
;; --display DISPNAME        This option is handled by emacs.c
;; -------------------------
;; -nw                       Do not use a windows system (but use the
;; --no-windows              terminal instead.)
;;                           This option is handled by emacs.c
;; -------------------------
;; -batch                    Execute noninteractively (messages go to stdout,
;; --batch                   variable noninteractive set to t)
;;                           This option is handled by emacs.c
;; -------------------------
;; -q                        Do not load user's init file and do not load
;; -no-init-file             "default.el".  Regardless of this switch,
68
;; --no-init-file            "site-start" is still loaded.
Richard M. Stallman's avatar
Richard M. Stallman committed
69
;; -------------------------
70
;; -no-site-file             Do not load "site-start.el".  (This is the ONLY
Richard M. Stallman's avatar
Richard M. Stallman committed
71 72 73 74 75 76 77 78 79 80
;; --no-site-file            way to prevent loading that file.)
;; -------------------------
;; -u USER                   Load USER's init file instead of the init
;; -user USER                file belonging to the user starting Emacs.
;; --user USER
;; -------------------------
;; -debug-init               Don't catch errors in init files; let the
;; --debug-init              debugger run.
;; -------------------------
;; -i ICONTYPE               Set type of icon using when Emacs is
81
;; -itype ICONTYPE           iconified under X.
Richard M. Stallman's avatar
Richard M. Stallman committed
82 83
;; --icon-type ICONTYPE      This option is passed on to term/x-win.el
;;
84
;; -iconic                   Start Emacs iconified.
Richard M. Stallman's avatar
Richard M. Stallman committed
85 86
;; --iconic                  This option is passed on to term/x-win.el
;; -------------------------
87
;; Various X options for colors/fonts/geometry/title etc.
Richard M. Stallman's avatar
Richard M. Stallman committed
88 89 90 91
;; These options are passed on to term/x-win.el which see.  Certain
;; of these are also found in term/pc-win.el
;; -------------------------
;; FILE                      Visit FILE.
92 93 94 95
;; -visit FILE
;; --visit FILE
;; -file FILE
;; --file FILE
Richard M. Stallman's avatar
Richard M. Stallman committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109
;;
;; -L DIRNAME                Add DIRNAME to load-path
;; -directory DIRNAME
;; --directory DIRNAME
;;
;; -l FILE                   Load and execute the Emacs lisp code
;; -load FILE                in FILE.
;; --load FILE
;;
;; -f FUNC                   Execute Emacs lisp function FUNC with
;; -funcall FUNC             no arguments.  The "-e" form is outdated
;; --funcall FUNC            and should not be used.  (It's a typo
;; -e FUNC                   promoted to a feature.)
;;
110 111
;; -eval FORM                Execute Emacs lisp form FORM.
;; --eval FORM
112 113
;; -execute EXPR
;; --execute EXPR
114
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
115 116 117 118 119 120
;; -insert FILE              Insert the contents of FILE into buffer.
;; --insert FILE
;; -------------------------
;; -kill                     Kill (exit) Emacs right away.
;; --kill
;; -------------------------
Jim Blandy's avatar
Jim Blandy committed
121

Eric S. Raymond's avatar
Eric S. Raymond committed
122 123
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
124 125
(setq top-level '(normal-top-level))

Richard M. Stallman's avatar
Richard M. Stallman committed
126 127
(defvar command-line-processed nil
  "Non-nil once command line has been processed")
Jim Blandy's avatar
Jim Blandy committed
128

Richard M. Stallman's avatar
Richard M. Stallman committed
129 130 131 132 133
(defgroup initialization nil
  "Emacs start-up procedure"
  :group 'internal)

(defcustom inhibit-startup-message nil
134
  "*Non-nil inhibits the initial startup message.
Jim Blandy's avatar
Jim Blandy committed
135
This is for use in your personal init file, once you are familiar
Richard M. Stallman's avatar
Richard M. Stallman committed
136 137 138
with the contents of the startup message."
  :type 'boolean
  :group 'initialization)
Jim Blandy's avatar
Jim Blandy committed
139

Richard M. Stallman's avatar
Richard M. Stallman committed
140
(defcustom inhibit-startup-echo-area-message nil
141
  "*Non-nil inhibits the initial startup echo area message.
Richard M. Stallman's avatar
Richard M. Stallman committed
142 143
Setting this variable takes effect
only if you do it with the customization buffer
Karl Heuer's avatar
Karl Heuer committed
144
or if your `.emacs' file contains a line of this form:
145
 (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\")
146 147
If your `.emacs' file is byte-compiled, use the following form instead:
 (eval '(setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\"))
148
Thus, someone else using a copy of your `.emacs' file will see
Richard M. Stallman's avatar
Richard M. Stallman committed
149 150 151 152
the startup message unless he personally acts to inhibit it."
  :type '(choice (const :tag "Don't inhibit")
		 (string :tag "Enter your user name, to inhibit"))
  :group 'initialization)
153

Richard M. Stallman's avatar
Richard M. Stallman committed
154 155 156 157
(defcustom inhibit-default-init nil
  "*Non-nil inhibits loading the `default' library."
  :type 'boolean
  :group 'initialization)
Jim Blandy's avatar
Jim Blandy committed
158

159
(defvar command-switch-alist nil
Jim Blandy's avatar
Jim Blandy committed
160 161 162 163 164
  "Alist of command-line switches.
Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
HANDLER-FUNCTION receives switch name as sole arg;
remaining command-line args are in the variable `command-line-args-left'.")

165 166 167
(defvar command-line-args-left nil
  "List of command-line args not yet processed.")

Jim Blandy's avatar
Jim Blandy committed
168 169 170
(defvar command-line-functions nil    ;; lrs 7/31/89
  "List of functions to process unrecognized command-line arguments.
Each function should access the dynamically bound variables
Richard M. Stallman's avatar
Richard M. Stallman committed
171
`argi' (the current argument) and `command-line-args-left' (the remaining
Jim Blandy's avatar
Jim Blandy committed
172
arguments).  The function should return non-nil only if it recognizes and
Richard M. Stallman's avatar
Richard M. Stallman committed
173 174
processes `argi'.  If it does so, it may consume successive arguments by
altering `command-line-args-left' to remove them.")
Jim Blandy's avatar
Jim Blandy committed
175

176 177 178 179
(defvar command-line-default-directory nil
  "Default directory to use for command line arguments.
This is normally copied from `default-directory' when Emacs starts.")

180 181
;;; This is here, rather than in x-win.el, so that we can ignore these
;;; options when we are not using X.
182
(defconst command-line-x-option-alist
183 184 185
  '(("-bw" 1 x-handle-numeric-switch border-width)
    ("-d" 1 x-handle-display)
    ("-display" 1 x-handle-display)
186
    ("-name" 1 x-handle-name-switch)
187 188
    ("-title" 1 x-handle-switch title)
    ("-T" 1 x-handle-switch title)
189 190 191 192 193 194 195
    ("-r" 0 x-handle-switch reverse t)
    ("-rv" 0 x-handle-switch reverse t)
    ("-reverse" 0 x-handle-switch reverse t)
    ("-reverse-video" 0 x-handle-switch reverse t)
    ("-fn" 1 x-handle-switch font)
    ("-font" 1 x-handle-switch font)
    ("-ib" 1 x-handle-numeric-switch internal-border-width)
196
    ("-g" 1 x-handle-geometry)
197
    ("-lsp" 1 x-handle-numeric-switch line-spacing)
198
    ("-geometry" 1 x-handle-geometry)
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
    ("-fg" 1 x-handle-switch foreground-color)
    ("-foreground" 1 x-handle-switch foreground-color)
    ("-bg" 1 x-handle-switch background-color)
    ("-background" 1 x-handle-switch background-color)
    ("-ms" 1 x-handle-switch mouse-color)
    ("-itype" 0 x-handle-switch icon-type t)
    ("-i" 0 x-handle-switch icon-type t)
    ("-iconic" 0 x-handle-iconic)
    ("-xrm" 1 x-handle-xrm-switch)
    ("-cr" 1 x-handle-switch cursor-color)
    ("-vb" 0 x-handle-switch vertical-scroll-bars t)
    ("-hb" 0 x-handle-switch horizontal-scroll-bars t)
    ("-bd" 1 x-handle-switch)
    ("--border-width" 1 x-handle-numeric-switch border-width)
    ("--display" 1 x-handle-display)
214
    ("--name" 1 x-handle-name-switch)
215
    ("--title" 1 x-handle-switch title)
216 217 218
    ("--reverse-video" 0 x-handle-switch reverse t)
    ("--font" 1 x-handle-switch font)
    ("--internal-border" 1 x-handle-numeric-switch internal-border-width)
219
    ("--geometry" 1 x-handle-geometry)
220 221 222 223 224 225 226 227
    ("--foreground-color" 1 x-handle-switch foreground-color)
    ("--background-color" 1 x-handle-switch background-color)
    ("--mouse-color" 1 x-handle-switch mouse-color)
    ("--icon-type" 0 x-handle-switch icon-type t)
    ("--iconic" 0 x-handle-iconic)
    ("--xrm" 1 x-handle-xrm-switch)
    ("--cursor-color" 1 x-handle-switch cursor-color)
    ("--vertical-scroll-bars" 0 x-handle-switch vertical-scroll-bars t)
228
    ("--line-spacing" 1 x-handle-numeric-switch line-spacing)
229 230 231 232 233 234 235 236 237 238
    ("--border-color" 1 x-handle-switch border-width))
  "Alist of X Windows options.
Each element has the form
  (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
where NAME is the option name string, NUMARGS is the number of arguments
that the option accepts, HANDLER is a function to call to handle the option.
FRAME-PARAM (optional) is the frame parameter this option specifies,
and VALUE is the value which is given to that frame parameter
\(most options use the argument for this, so VALUE is not present).")

Roland McGrath's avatar
Roland McGrath committed
239
(defvar before-init-hook nil
240
  "Normal hook run after handling urgent options but before loading init files.")
Jim Blandy's avatar
Jim Blandy committed
241

Roland McGrath's avatar
Roland McGrath committed
242
(defvar after-init-hook nil
243 244 245 246 247 248 249
  "Normal hook run after loading the init files, `~/.emacs' and `default.el'.
There is no `condition-case' around the running of these functions;
therefore, if you set `debug-on-error' non-nil in `.emacs',
an error in one of these functions will invoke the debugger.")

(defvar emacs-startup-hook nil
  "Normal hook run after loading init files and handling the command line.")
Roland McGrath's avatar
Roland McGrath committed
250

Jim Blandy's avatar
Jim Blandy committed
251
(defvar term-setup-hook nil
252 253
  "Normal hook run after loading terminal-specific Lisp code.
It also follows `emacs-startup-hook'.  This hook exists for users to set,
Jim Blandy's avatar
Jim Blandy committed
254 255 256 257
so as to override the definitions made by the terminal-specific file.
Emacs never sets this variable itself.")

(defvar keyboard-type nil
Richard M. Stallman's avatar
Richard M. Stallman committed
258 259
  "The brand of keyboard you are using.
This variable is used to define
Jim Blandy's avatar
Jim Blandy committed
260
the proper function and keypad keys for use under X.  It is used in a
Karl Heuer's avatar
Karl Heuer committed
261
fashion analogous to the environment variable TERM.")
Jim Blandy's avatar
Jim Blandy committed
262 263

(defvar window-setup-hook nil
Richard M. Stallman's avatar
Richard M. Stallman committed
264 265 266
  "Normal hook run to initialize window system display.
Emacs runs this hook after processing the command line arguments and loading
the user's init file.")
Jim Blandy's avatar
Jim Blandy committed
267

Richard M. Stallman's avatar
Richard M. Stallman committed
268 269
(defcustom initial-major-mode 'lisp-interaction-mode
  "Major mode command symbol to use for the initial *scratch* buffer."
270
  :type 'function
Richard M. Stallman's avatar
Richard M. Stallman committed
271
  :group 'initialization)
Jim Blandy's avatar
Jim Blandy committed
272

Richard M. Stallman's avatar
Richard M. Stallman committed
273
(defcustom init-file-user nil
Jim Blandy's avatar
Jim Blandy committed
274
  "Identity of user whose `.emacs' file is or was read.
275 276 277 278 279 280
The value is nil if `-q' or `--no-init-file' was specified,
meaning do not load any init file.

Otherwise, the value may be the null string, meaning use the init file
for the user that originally logged in, or it may be a
string containing a user's name meaning use that person's init file.
Jim Blandy's avatar
Jim Blandy committed
281

Karl Heuer's avatar
Karl Heuer committed
282 283
In either of the latter cases, `(concat \"~\" init-file-user \"/\")'
evaluates to the name of the directory where the `.emacs' file was
284 285 286
looked for.

Setting `init-file-user' does not prevent Emacs from loading
Richard M. Stallman's avatar
Richard M. Stallman committed
287 288 289
`site-start.el'.  The only way to do that is to use `--no-site-file'."
  :type '(choice (const :tag "none" nil) string)
  :group 'initialization)
Jim Blandy's avatar
Jim Blandy committed
290

Richard M. Stallman's avatar
Richard M. Stallman committed
291
(defcustom site-run-file "site-start"
292 293 294 295 296
  "File containing site-wide run-time initializations.
This file is loaded at run-time before `~/.emacs'.  It contains inits
that need to be in place for the entire site, but which, due to their
higher incidence of change, don't make sense to load into emacs'
dumped image.  Thus, the run-time load order is: 1. file described in
297 298 299 300 301 302 303
this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.

Don't use the `site-start.el' file for things some users may not like.
Put them in `default.el' instead, so that users can more easily
override them.  Users can prevent loading `default.el' with the `-q'
option or by setting `inhibit-default-init' in their own init files,
but inhibiting `site-start.el' requires `--no-site-file', which
Richard M. Stallman's avatar
Richard M. Stallman committed
304
is less convenient."
305
  :type '(choice (const :tag "none" nil) string)
Richard M. Stallman's avatar
Richard M. Stallman committed
306
  :group 'initialization)
307

Richard M. Stallman's avatar
Richard M. Stallman committed
308 309 310 311
(defcustom mail-host-address nil
  "*Name of this machine, for purposes of naming users."
  :type '(choice (const nil) string)
  :group 'mail)
312

Richard M. Stallman's avatar
Richard M. Stallman committed
313
(defcustom user-mail-address nil
314 315
  "*Full mailing address of this user.
This is initialized based on `mail-host-address',
Richard M. Stallman's avatar
Richard M. Stallman committed
316 317 318
after your init file is read, in case it sets `mail-host-address'."
  :type 'string
  :group 'mail)
319

Richard M. Stallman's avatar
Richard M. Stallman committed
320
(defcustom auto-save-list-file-prefix
321 322
  (cond ((eq system-type 'ms-dos)
	 ;; MS-DOS cannot have initial dot, and allows only 8.3 names
323
	 "~/_emacs.d/auto-save.list/_s")
324 325
	(t
	 "~/.emacs.d/auto-save-list/.saves-"))
326 327 328 329
  "Prefix for generating `auto-save-list-file-name'.
This is used after reading your `.emacs' file to initialize
`auto-save-list-file-name', by appending Emacs's pid and the system name,
if you have not already set `auto-save-list-file-name' yourself.
330
Directories in the prefix will be created if necessary.
331
Set this to nil if you want to prevent `auto-save-list-file-name'
Richard M. Stallman's avatar
Richard M. Stallman committed
332
from being initialized."
333 334
  :type '(choice (const :tag "Don't record a session's auto save list" nil)
		 string)
Richard M. Stallman's avatar
Richard M. Stallman committed
335
  :group 'auto-save)
336

Jim Blandy's avatar
Jim Blandy committed
337 338
(defvar init-file-debug nil)

339 340
(defvar init-file-had-error nil)

341 342
(defvar normal-top-level-add-subdirs-inode-list nil)

343
(defun normal-top-level-add-subdirs-to-load-path ()
344 345
  "Add all subdirectories of current directory to `load-path'.
More precisely, this uses only the subdirectories whose names
346 347
start with letters or digits; it excludes any subdirectory named `RCS'
or `CVS', and any subdirectory that contains a file named `.nosearch'."
348
  (let (dirs 
349
	attrs
350 351 352 353 354 355
	(pending (list default-directory)))
    ;; This loop does a breadth-first tree walk on DIR's subtree,
    ;; putting each subdir into DIRS as its contents are examined.
    (while pending
      (setq dirs (cons (car pending) dirs))
      (setq pending (cdr pending))
356
      (setq attrs (nthcdr 10 (file-attributes (car dirs))))
357 358
      (let ((contents (directory-files (car dirs)))
	    (default-directory (car dirs)))
359 360 361 362
	(unless (member attrs normal-top-level-add-subdirs-inode-list)
	  (setq normal-top-level-add-subdirs-inode-list
		(cons attrs normal-top-level-add-subdirs-inode-list))
	  (while contents
363 364
	    ;; The lower-case variants of RCS and CVS are for DOS/Windows.
	    (unless (member (car contents) '("." ".." "RCS" "CVS" "rcs" "cvs"))
365
	      (when (and (string-match "\\`[[:alnum:]]" (car contents))
366 367 368 369
			 ;; Avoid doing a `stat' when it isn't necessary
			 ;; because that can cause trouble when an NFS server
			 ;; is down.
			 (not (string-match "\\.elc?\\'" (car contents)))
370 371 372 373 374 375
			 (file-directory-p (car contents)))
		(let ((expanded (expand-file-name (car contents))))
		  (unless (file-exists-p (expand-file-name ".nosearch"
							   expanded))
		    (setq pending (nconc pending (list expanded)))))))
	    (setq contents (cdr contents))))))
376
    (normal-top-level-add-to-load-path (cdr (nreverse dirs)))))
377

Richard M. Stallman's avatar
Richard M. Stallman committed
378 379 380 381 382
;; This function is called from a subdirs.el file.
;; It assumes that default-directory is the directory
;; in which the subdirs.el file exists,
;; and it adds to load-path the subdirs of that directory
;; as specified in DIRS.  Normally the elements of DIRS are relative.
383
(defun normal-top-level-add-to-load-path (dirs)
384 385 386
  (let ((tail load-path)
	(thisdir (directory-file-name default-directory)))
    (while (and tail
387 388
		;;Don't go all the way to the nil terminator.
		(cdr tail)
389 390 391 392
		(not (equal thisdir (car tail)))
		(not (and (memq system-type '(ms-dos windows-nt))
			  (equal (downcase thisdir) (downcase (car tail))))))
      (setq tail (cdr tail)))
393 394 395
    ;;Splice the new section in.
    (when tail
      (setcdr tail (append (mapcar 'expand-file-name dirs) (cdr tail))))))
396

Jim Blandy's avatar
Jim Blandy committed
397 398 399 400
(defun normal-top-level ()
  (if command-line-processed
      (message "Back to top level.")
    (setq command-line-processed t)
401 402 403 404 405 406
    ;; Give *Messages* the same default-directory as *scratch*,
    ;; just to keep things predictable.
    (let ((dir default-directory))
      (save-excursion
	(set-buffer (get-buffer "*Messages*"))
	(setq default-directory dir)))
Karl Heuer's avatar
Karl Heuer committed
407 408 409
    ;; For root, preserve owner and group when editing files.
    (if (equal (user-uid) 0)
	(setq backup-by-copying-when-mismatch t))
410 411 412
    ;; Look in each dir in load-path for a subdirs.el file.
    ;; If we find one, load it, which will add the appropriate subdirs
    ;; of that dir into load-path,
413 414
    ;; Look for a leim-list.el file too.  Loading it will register
    ;; available input methods.
415 416 417 418
    (let ((tail load-path)
	  new)
      (while tail
	(setq new (cons (car tail) new))
419 420 421
	(condition-case nil
	    (let ((default-directory (car tail)))
	      (load (expand-file-name "subdirs.el" (car tail)) t t t)))
422 423 424
	(condition-case nil
	    (let ((default-directory (car tail)))
	      (load (expand-file-name "leim-list.el" (car tail)) t t t)))
425
	(setq tail (cdr tail))))
Jim Blandy's avatar
Jim Blandy committed
426
    (if (not (eq system-type 'vax-vms))
427 428 429 430 431 432 433 434 435 436 437 438 439 440
	(progn
	  ;; If the PWD environment variable isn't accurate, delete it.
	  (let ((pwd (getenv "PWD")))
	    (and (stringp pwd)
		 ;; Use FOO/., so that if FOO is a symlink, file-attributes
		 ;; describes the directory linked to, not FOO itself.
		 (or (equal (file-attributes
			     (concat (file-name-as-directory pwd) "."))
			    (file-attributes
			     (concat (file-name-as-directory default-directory)
				     ".")))
		     (setq process-environment
			   (delete (concat "PWD=" pwd)
				   process-environment)))))))
Jim Blandy's avatar
Jim Blandy committed
441
    (setq default-directory (abbreviate-file-name default-directory))
442 443 444 445 446
    (let ((menubar-bindings-done nil))
      (unwind-protect
	  (command-line)
	;; Do this again, in case .emacs defined more abbreviations.
	(setq default-directory (abbreviate-file-name default-directory))
447 448
	;; Specify the file for recording all the auto save files of this session.
	;; This is used by recover-session.
449 450 451
	(or auto-save-list-file-name
	    (and auto-save-list-file-prefix
		 (setq auto-save-list-file-name
452 453
		       ;; Under MS-DOS our PID is almost always reused between
		       ;; Emacs invocations.  We need something more unique.
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
		       (cond ((eq system-type 'ms-dos)
			      ;; We are going to access the auto-save
			      ;; directory, so make sure it exists.
			      (make-directory
			       (file-name-directory auto-save-list-file-prefix)
			       t)
			      (concat 
			       (make-temp-name
				(expand-file-name
				 auto-save-list-file-prefix))
			       "~"))
			     (t
			      (expand-file-name
			       (format "%s%d-%s~"
				       auto-save-list-file-prefix
				       (emacs-pid)
				       (system-name))))))))
471 472 473 474 475 476 477
	(run-hooks 'emacs-startup-hook)
	(and term-setup-hook
	     (run-hooks 'term-setup-hook))
	;; Modify the initial frame based on what .emacs puts into
	;; ...-frame-alist.
	(if (fboundp 'frame-notice-user-settings)
	    (frame-notice-user-settings))
Miles Bader's avatar
Miles Bader committed
478 479 480 481 482
	(if (fboundp 'frame-set-background-mode)
	    ;; Set the faces for the initial background mode even if
	    ;; frame-notice-user-settings didn't (such as on a tty).
	    ;; frame-set-background-mode is idempotent, so it won't
	    ;; cause any harm if it's already been done.
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
	    (let ((frame-background-mode frame-background-mode)
		  (frame (selected-frame))
		  term)
	      (when (and (null window-system)
			 ;; Don't override a possibly customized value.
			 (null frame-background-mode)
			 ;; Don't override user specifications.
			 (null (frame-parameter frame 'reverse))
			 (let ((bg (frame-parameter frame 'background-color)))
			   (or (null bg)
			       (member bg '(unspecified "unspecified-bg")))))
		(setq term (getenv "TERM"))
		(if (string-match "^\\(xterm\\|rxvt\\|dtterm\\|eterm\\)"
				  term)
		    (setq frame-background-mode 'light)))
	      (frame-set-background-mode (selected-frame))))
Miles Bader's avatar
Miles Bader committed
499

500 501 502 503 504 505
	;; Now we know the user's default font, so add it to the menu.
	(if (fboundp 'font-menu-add-default)
	    (font-menu-add-default))
	(and window-setup-hook
	     (run-hooks 'window-setup-hook))
	(or menubar-bindings-done
506 507
	    (if (display-popup-menus-p)
		(precompute-menubar-bindings)))))))
508 509 510

;; Precompute the keyboard equivalents in the menu bar items.
(defun precompute-menubar-bindings ()
511 512 513 514 515 516
  (let ((submap (lookup-key global-map [menu-bar])))
    (while submap
      (and (consp (car submap))
	   (symbolp (car (car submap)))
	   (stringp (car-safe (cdr (car submap))))
	   (keymapp (cdr (cdr (car submap))))
517 518 519 520
	   (progn
	     (x-popup-menu nil (cdr (cdr (car submap))))
	     (if purify-flag
		 (garbage-collect))))
521
      (setq submap (cdr submap))))
522
    (setq define-key-rebound-commands t))
Jim Blandy's avatar
Jim Blandy committed
523

524 525 526 527 528 529 530 531
;; Command-line options supported by tty's:
(defconst tty-long-option-alist
  '(("--name" .		"-name")
    ("--title" .	"-T")
    ("--reverse-video" . "-reverse")
    ("--foreground-color" . "-fg")
    ("--background-color" . "-bg")))

532 533 534
(defconst tool-bar-images-pixel-height 24
  "Height in pixels of images in the tool bar.")

535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
;; Handle the X-like command line parameters "-fg", "-bg", "-name", etc.
(defun tty-handle-args (args)
  (let ((rest nil))
    (message "%s" args)
    (while (and args
		(not (equal (car args) "--")))
      (let* ((this (car args))
	     (orig-this this)
	     completion argval)
	(setq args (cdr args))
	;; Check for long options with attached arguments
	;; and separate out the attached option argument into argval.
	(if (string-match "^--[^=]*=" this)
	    (setq argval (substring this (match-end 0))
		  this (substring this 0 (1- (match-end 0)))))
	(when (string-match "^--" this)
	  (setq completion (try-completion this tty-long-option-alist))
	  (if (eq completion t)
	      ;; Exact match for long option.
	      (setq this (cdr (assoc this tty-long-option-alist)))
	    (if (stringp completion)
		(let ((elt (assoc completion tty-long-option-alist)))
		  ;; Check for abbreviated long option.
		  (or elt
		      (error "Option `%s' is ambiguous" this))
		  (setq this (cdr elt)))
	      ;; Check for a short option.
	      (setq argval nil this orig-this))))
	(cond ((or (string= this "-fg") (string= this "-foreground"))
	       (or argval (setq argval (car args) args (cdr args)))
	       (setq default-frame-alist
		     (cons (cons 'foreground-color argval)
			   default-frame-alist)))
	      ((or (string= this "-bg") (string= this "-background"))
	       (or argval (setq argval (car args) args (cdr args)))
	       (setq default-frame-alist
		     (cons (cons 'background-color argval)
			   default-frame-alist)))
	      ((or (string= this "-T") (string= this "-name"))
	       (or argval (setq argval (car args) args (cdr args)))
	       (setq default-frame-alist
		     (cons
		      (cons 'title
			    (if (stringp argval)
				argval
			      (let ((case-fold-search t)
				    i)
				(setq argval (invocation-name))

				;; Change any . or * characters in name to
				;; hyphens, so as to emulate behavior on X.
				(while
				    (setq i (string-match "[.*]" argval))
				  (aset argval i ?-))
				argval)))
		      default-frame-alist)))
	      ((or (string= this "-r")
		   (string= this "-rv")
		   (string= this "-reverse"))
	       (setq default-frame-alist
		     (cons '(reverse . t)
			   default-frame-alist)))
	      (t (setq rest (cons this rest))))))
      (nreverse rest)))

Jim Blandy's avatar
Jim Blandy committed
600
(defun command-line ()
601 602
  (setq command-line-default-directory default-directory)

603 604 605 606 607 608 609 610 611
  ;; Choose a reasonable location for temporary files.
  (setq temporary-file-directory
	(file-name-as-directory
	 (cond ((memq system-type '(ms-dos windows-nt))
		(or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
	       ((memq system-type '(vax-vms axp-vms))
		(or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
	       (t
		(or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp")))))
612 613
  (setq small-temporary-file-directory
	(if (eq system-type 'ms-dos)
614
	    (getenv "TMPDIR")))
615

Roland McGrath's avatar
Roland McGrath committed
616
  ;; See if we should import version-control from the environment variable.
Jim Blandy's avatar
Jim Blandy committed
617 618 619 620 621 622 623 624 625 626 627 628
  (let ((vc (getenv "VERSION_CONTROL")))
    (cond ((eq vc nil))			;don't do anything if not set
	  ((or (string= vc "t")
	       (string= vc "numbered"))
	   (setq version-control t))
	  ((or (string= vc "nil")
	       (string= vc "existing"))
	   (setq version-control nil))
	  ((or (string= vc "never")
	       (string= vc "simple"))
	   (setq version-control 'never))))

Jim Blandy's avatar
Jim Blandy committed
629 630 631 632 633
  ;;! This has been commented out; I currently find the behavior when
  ;;! split-window-keep-point is nil disturbing, but if I can get used
  ;;! to it, then it would be better to eliminate the option.
  ;;! ;; Choose a good default value for split-window-keep-point.
  ;;! (setq split-window-keep-point (> baud-rate 2400))
Jim Blandy's avatar
Jim Blandy committed
634

635 636 637 638 639 640 641 642 643 644 645 646
  ;; Set the default strings to display in mode line for
  ;; end-of-line formats that aren't native to this platform.
  (cond
   ((memq system-type '(ms-dos windows-nt emx))
    (setq eol-mnemonic-unix "(Unix)")
    (setq eol-mnemonic-mac  "(Mac)"))
   ;; Mac-specific settings should come here, once there's a
   ;; system-type symbol specific to MacOS.
   (t	; this is for Unix/GNU/Linux systems
    (setq eol-mnemonic-dos  "(DOS)")
    (setq eol-mnemonic-mac  "(Mac)")))

Jim Blandy's avatar
Jim Blandy committed
647
  ;; Read window system's init file if using a window system.
648 649 650 651 652 653 654 655 656 657
  (condition-case error
      (if (and window-system (not noninteractive))
	  (load (concat term-file-prefix
			(symbol-name window-system)
			"-win")
		;; Every window system should have a startup file;
		;; barf if we can't find it.
		nil t))
    ;; If we can't read it, print the error message and exit.
    (error
658 659 660 661 662 663
     (princ
      (if (eq (car error) 'error)
	  (apply 'concat (cdr error))
	(if (memq 'file-error (get (car error) 'error-conditions))
	    (format "%s: %s"
		     (nth 1 error)
664
		     (mapconcat (lambda (obj) (prin1-to-string obj t))
665 666 667
				(cdr (cdr error)) ", "))
	  (format "%s: %s"
		   (get (car error) 'error-message)
668
		   (mapconcat (lambda (obj) (prin1-to-string obj t))
669 670 671
			      (cdr error) ", "))))
      'external-debugging-output)
     (setq window-system nil)
672
     (kill-emacs)))
Jim Blandy's avatar
Jim Blandy committed
673

674 675 676 677 678
  ;; Windowed displays do this inside their *-win.el.
  (when (and (not (display-graphic-p))
	     (not noninteractive))
    (setq command-line-args (tty-handle-args command-line-args)))

679 680
  (set-locale-environment nil)

Jim Blandy's avatar
Jim Blandy committed
681 682 683
  (let ((done nil)
	(args (cdr command-line-args)))

Jim Blandy's avatar
Jim Blandy committed
684 685 686 687 688 689
    ;; Figure out which user's init file to load,
    ;; either from the environment or from the options.
    (setq init-file-user (if noninteractive nil (user-login-name)))
    ;; If user has not done su, use current $HOME to find .emacs.
    (and init-file-user (string= init-file-user (user-real-login-name))
	 (setq init-file-user ""))
Jim Blandy's avatar
Jim Blandy committed
690 691 692 693

    ;; Process the command-line args, and delete the arguments
    ;; processed.  This is consistent with the way main in emacs.c
    ;; does things.
Jim Blandy's avatar
Jim Blandy committed
694
    (while (and (not done) args)
695
      (let ((longopts '(("--no-init-file") ("--no-site-file") ("--user")
696
			("--debug-init") ("--iconic") ("--icon-type")))
697 698
	    (argi (car args))
	    (argval nil))
699 700 701
	;; Handle --OPTION=VALUE format.
	(if (and (string-match "\\`--" argi)
		 (string-match "=" argi))
702 703
	    (setq argval (substring argi (match-end 0))
		  argi (substring argi 0 (match-beginning 0))))
704 705 706 707 708 709 710 711 712 713
	(or (equal argi "--")
	    (let ((completion (try-completion argi longopts)))
	      (if (eq completion t)
		  (setq argi (substring argi 1))
		(if (stringp completion)
		    (let ((elt (assoc completion longopts)))
		      (or elt
			  (error "Option `%s' is ambiguous" argi))
		      (setq argi (substring (car elt) 1)))
		  (setq argval nil)))))
Jim Blandy's avatar
Jim Blandy committed
714 715 716 717 718 719 720
	(cond
	 ((or (string-equal argi "-q")
	      (string-equal argi "-no-init-file"))
	  (setq init-file-user nil
		args (cdr args)))
	 ((or (string-equal argi "-u")
	      (string-equal argi "-user"))
721
	  (or argval
722 723
	      (setq args (cdr args)
		    argval (car args)))
724 725
	  (setq init-file-user argval
		argval nil
Jim Blandy's avatar
Jim Blandy committed
726
		args (cdr args)))
727 728 729
	 ((string-equal argi "-no-site-file")
	  (setq site-run-file nil
		args (cdr args)))
Jim Blandy's avatar
Jim Blandy committed
730 731 732
	 ((string-equal argi "-debug-init")
	  (setq init-file-debug t
		args (cdr args)))
733 734 735 736 737 738 739 740 741 742
	 ((string-equal argi "-iconic")
	  (setq initial-frame-alist
		(cons '(visibility . icon) initial-frame-alist))
	  (setq args (cdr args)))
	 ((or (string-equal argi "-icon-type")
	      (string-equal argi "-i")
	      (string-equal argi "-itype"))
	  (setq default-frame-alist
		(cons '(icon-type . t) default-frame-alist))
	  (setq args (cdr args)))
743 744 745 746 747
	 (t (setq done t)))
	;; Was argval set but not used?
	(and argval
	     (error "Option `%s' doesn't allow an argument" argi))))

Jim Blandy's avatar
Jim Blandy committed
748
    ;; Re-attach the program name to the front of the arg list.
749
    (and command-line-args (setcdr command-line-args args)))
Jim Blandy's avatar
Jim Blandy committed
750

751
  ;; Under X Windows, this creates the X frame and deletes the terminal frame.
752 753
  (if (fboundp 'frame-initialize)
      (frame-initialize))
754
  ;; If frame was created with a menu bar, set menu-bar-mode on.
755 756 757
  (if (and (not noninteractive)
	   (or (not (memq window-system '(x w32)))
	       (> (cdr (assq 'menu-bar-lines (frame-parameters))) 0)))
758
      (menu-bar-mode t))
759

760 761
  ;; If frame was created with a tool bar, switch tool-bar-mode on.
  (when (and (not noninteractive)
762
	     (display-graphic-p)
763
	     (> (frame-parameter nil 'tool-bar-lines) 0))
764
    (tool-bar-mode 1))
765

766 767 768 769 770 771 772
  ;; Can't do this init in defcustom because window-system isn't set.
  (when (and (not noninteractive)
	     (not (eq system-type 'ms-dos))
	     (memq window-system '(x w32)))
    (setq-default blink-cursor t)
    (blink-cursor-mode 1))

773
  (when (and (not noninteractive)
774 775 776 777 778 779 780
	     ;; DOS/Windows systems have a PC-type keyboard which has both
	     ;; <delete> and <backspace> keys.
	     (or (memq system-type '(ms-dos windows-nt))
		 (memq window-system '(x))))
    (setq-default delete-key-deletes-forward
		  (or (not (fboundp 'x-backspace-delete-keys-p))
		      (x-backspace-delete-keys-p)))
781 782
    (delete-key-deletes-forward-mode 1))

783 784 785 786 787 788
  (when (and (not noninteractive)
	     (display-graphic-p)
	     (fboundp 'x-show-tip))
    (setq-default tooltip-mode t)
    (tooltip-mode 1))

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
  ;; Register default TTY colors for the case the terminal hasn't a
  ;; terminal init file.
  (or (memq window-system '(x w32))
      (not (tty-display-color-p))
      (let* ((colors (cond ((eq window-system 'pc)
                            msdos-color-values)
                           ((eq system-type 'windows-nt)
                            w32-tty-standard-colors)
                           (t tty-standard-colors)))
	     (color (car colors)))
	(while colors
	  (tty-color-define (car color) (cadr color) (cddr color))
	  (setq colors (cdr colors) color (car colors)))
	;; Modifying color mappings means realized faces don't
	;; use the right colors, so clear them.
	(clear-face-cache)))

Roland McGrath's avatar
Roland McGrath committed
806
  (run-hooks 'before-init-hook)
Jim Blandy's avatar
Jim Blandy committed
807

Roland McGrath's avatar
Roland McGrath committed
808 809 810
  ;; Run the site-start library if it exists.  The point of this file is
  ;; that it is run before .emacs.  There is no point in doing this after
  ;; .emacs; that is useless.
811 812
  (if site-run-file 
      (load site-run-file t t))
Roland McGrath's avatar
Roland McGrath committed
813

814 815 816 817
  ;; Sites should not disable this.  Only individuals should disable
  ;; the startup message.
  (setq inhibit-startup-message nil)

Jim Blandy's avatar
Jim Blandy committed
818
  ;; Load that user's init file, or the default one, or none.
819 820 821
  (let (debug-on-error-from-init-file
	debug-on-error-should-be-set
	(debug-on-error-initial
822 823
	 (if (eq init-file-debug t) 'startup init-file-debug))
	(orig-enable-multibyte default-enable-multibyte-characters))
824 825 826 827 828 829
    (let ((debug-on-error debug-on-error-initial)
	  ;; This function actually reads the init files.
	  (inner
	   (function
	    (lambda ()
	      (if init-file-user
830
		  (let ((user-init-file-1
831 832 833
			  (cond 
			   ((eq system-type 'ms-dos)
			    (concat "~" init-file-user "/_emacs"))
834
			   ((eq system-type 'windows-nt)
835
			    (if (directory-files "~" nil "^\\.emacs\\(\\.elc?\\)?$")
836 837
				"~/.emacs"
			      "~/_emacs"))
838 839 840
			   ((eq system-type 'vax-vms) 
			    "sys$login:.emacs")
			   (t 
841 842 843 844 845
			    (concat "~" init-file-user "/.emacs")))))
		    ;; This tells `load' to store the file name found
		    ;; into user-init-file.
		    (setq user-init-file t)
		    (load user-init-file-1 t t)
846

847 848 849 850 851
		    ;; If we did not find the user's init file,
		    ;; set user-init-file conclusively to nil;
		    ;; don't let it be set from default.el.
		    (if (eq user-init-file t)
			(setq user-init-file nil))
852

853 854 855
		    ;; If we loaded a compiled file, set
		    ;; `user-init-file' to the source version if that
		    ;; exists.
856 857
		    (when (and user-init-file
			       (equal (file-name-extension user-init-file)
858 859 860 861 862 863 864 865 866 867 868 869 870
				      "elc"))
		      (let* ((source (file-name-sans-extension user-init-file))
			     (alt (concat source ".el")))
			(setq source (cond ((file-exists-p alt) alt)
					   ((file-exists-p source) source)
					   (t nil)))
			(when source
			  (when (file-newer-than-file-p source user-init-file)
			    (message "Warning: %s is newer than %s"
				     source user-init-file)
			    (sit-for 1))
			  (setq user-init-file source))))

871 872 873 874 875 876 877
		    (or inhibit-default-init
			(let ((inhibit-startup-message nil))
			  ;; Users are supposed to be told their rights.
			  ;; (Plus how to get help and how to undo.)
			  ;; Don't you dare turn this off for anyone
			  ;; except yourself.
			  (load "default" t t)))))))))
878 879 880 881 882 883 884
      (if init-file-debug
	  ;; Do this without a condition-case if the user wants to debug.
	  (funcall inner)
	(condition-case error
	    (progn
	      (funcall inner)
	      (setq init-file-had-error nil))
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
	  (error
	   (let ((message-log-max nil))
	     (save-excursion
	       (set-buffer (get-buffer-create "*Messages*"))
	       (insert "\n\n"
		       (format "An error has occurred while loading `%s':\n\n"
			       user-init-file)
		       (format "%s%s%s"
			       (get (car error) 'error-message)
			       (if (cdr error) ": " "")
			       (mapconcat 'prin1-to-string (cdr error) ", "))
		       "\n\n"
		       "To ensure normal operation, you should investigate the cause\n"
		       "of the error in your initialization file and remove it.  Start\n"
		       "Emacs with the `--debug-init' option to view a complete error\n"
		       "backtrace\n"))
	     (message "Error in init file: %s%s%s"
		      (get (car error) 'error-message)
		      (if (cdr error) ": " "")
		      (mapconcat 'prin1-to-string (cdr error) ", "))
	     (pop-to-buffer "*Messages*")
	     (setq init-file-had-error t)))))
907
      ;; If we can tell that the init file altered debug-on-error,
908 909 910 911 912
      ;; arrange to preserve the value that it set up.
      (or (eq debug-on-error debug-on-error-initial)
	  (setq debug-on-error-should-be-set t
		debug-on-error-from-init-file debug-on-error)))
    (if debug-on-error-should-be-set
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
	(setq debug-on-error debug-on-error-from-init-file))
    (unless (or default-enable-multibyte-characters
		(eq orig-enable-multibyte default-enable-multibyte-characters))
      ;; Init file changed to unibyte.  Reset existing multibyte
      ;; buffers (probably *scratch*, *Messages*, *Minibuff-0*).
      ;; Arguably this should only be done if they're free of
      ;; multibyte characters.
      (mapcar (lambda (buffer)
		(with-current-buffer buffer
		  (if enable-multibyte-characters
		      (set-buffer-multibyte nil))))
	      (buffer-list))
      ;; Also re-set the language environment in case it was
      ;; originally done before unibyte was set and is sensitive to
      ;; unibyte (display table, terminal coding system &c).
      (set-language-environment current-language-environment)))
Jim Blandy's avatar
Jim Blandy committed
929

930 931 932 933 934 935
  ;; Do this here in case the init file sets mail-host-address.
  (or user-mail-address
      (setq user-mail-address (concat (user-login-name) "@"
				      (or mail-host-address
					  (system-name)))))

Roland McGrath's avatar
Roland McGrath committed
936 937
  (run-hooks 'after-init-hook)

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
  ;; When the tool-bar is on, increase the frame's height by the
  ;; number of lines it usually occupies.  The normal height of images
  ;; in the tool bar is assumed to be `tool-bar-images-pixel-height'.
  (when tool-bar-mode
    (let* ((char-height (frame-char-height))
	   (bar-height (+ tool-bar-images-pixel-height
			  tool-bar-button-margin
			  tool-bar-button-relief))
	   (lines (/ (+ bar-height (1- char-height)) char-height)))
      (set-frame-height nil (+ (frame-height) lines))))

  ;; Now, make the frame visible.  If we make it visible before this
  ;; point, ugly flickering can happens because of possibly changing
  ;; frame heights.  Note that any message or error make the frame
  ;; visible automatically.
  (make-frame-visible)

Jim Blandy's avatar
Jim Blandy committed
955 956 957 958 959 960
  ;; If *scratch* exists and init file didn't change its mode, initialize it.
  (if (get-buffer "*scratch*")
      (save-excursion
	(set-buffer "*scratch*")
	(if (eq major-mode 'fundamental-mode)
	    (funcall initial-major-mode))))
961
  
Jim Blandy's avatar
Jim Blandy committed
962 963 964 965 966 967 968 969 970 971 972 973
  ;; Load library for our terminal type.
  ;; User init file can set term-file-prefix to nil to prevent this.
  (and term-file-prefix (not noninteractive) (not window-system)
       (let ((term (getenv "TERM"))
	     hyphend)
	 (while (and term
		     (not (load (concat term-file-prefix term) t t)))
	   ;; Strip off last hyphen and what follows, then try again
	   (if (setq hyphend (string-match "[-_][^-_]+$" term))
	       (setq term (substring term 0 hyphend))
	     (setq term nil)))))

Jim Blandy's avatar
Jim Blandy committed
974
  ;; Process the remaining args.
Jim Blandy's avatar
Jim Blandy committed
975 976 977 978 979
  (command-line-1 (cdr command-line-args))

  ;; If -batch, terminate after processing the command options.
  (if noninteractive (kill-emacs t)))

980
(defcustom initial-scratch-message (purecopy "\
981 982 983
;; This buffer is for notes you don't want to save, and for Lisp evaluation.
;; If you want to create a file, visit that file with C-x C-f,
;; then enter the text in that file's own buffer.
984

985
")
986 987 988 989
  "Initial message displayed in *scratch* buffer at startup.
If this is nil, no message will be displayed."
  :type 'string)

990 991 992 993 994 995

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Fancy splash screen
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defvar fancy-splash-text
996
  '((:face variable-pitch
997 998
	   "You can do basic editing with the menu bar and scroll bar \
using the mouse.\n\n"
999
	   :face (variable-pitch :weight bold)
1000
	   "Useful File menu items:\n"
1001
	   :face variable-pitch "\
1002 1003
Exit Emacs\t(or type Control-x followed by Control-c)
Recover Session\trecover files you were editing before a crash
1004 1005 1006 1007


"
	   )
1008
  (:face variable-pitch
1009 1010
	   "You can do basic editing with the menu bar and scroll bar \
using the mouse.\n\n"
1011
	   :face (variable-pitch :weight bold)
1012
	   "Important Help menu items:\n"
1013
	   :face variable-pitch "\
1014 1015 1016
Emacs Tutorial\tLearn-by-doing tutorial for using Emacs efficiently.
Emacs FAQ\tFrequently asked questions and answers
\(Non)Warranty\tGNU Emacs comes with "
1017
	   :face (variable-pitch :slant oblique)
1018
	   "ABSOLUTELY NO WARRANTY\n"
1019
	   :face variable-pitch
1020
	   "\
1021
Copying Conditions\tConditions for redistributing and changing Emacs\n"))
1022 1023 1024 1025 1026
  "A list of texts to show in the middle part of splash screens.
Each element in the list should be a list of strings or pairs
`:face FACE', like `fancy-splash-insert' accepts them.")


1027
(defgroup fancy-splash-screen ()
1028
  "Fancy splash screen when Emacs starts."
1029
  :version "21.1"
1030 1031 1032
  :group 'initialization)


1033
(defcustom fancy-splash-delay 10
1034
  "*Delay in seconds between splash screens."
1035
  :group 'fancy-splash-screen
1036 1037 1038
  :type 'integer)


1039 1040 1041 1042 1043 1044 1045
(defcustom fancy-splash-max-time 60
  "*Show splash screens for at most this number of seconds.
Values less than 60 seconds are ignored."
  :group 'fancy-splash-screen
  :type 'integer)


1046 1047
(defcustom fancy-splash-image nil
  "*The image to show in the splash screens, or nil for defaults."
1048
  :group 'fancy-splash-screen
1049 1050
  :type '(choice (const :tag "Default" nil)
		 (file :tag "File")))
1051 1052


1053 1054 1055 1056
;; These are temporary storage areas for the splash screen display.

(defvar fancy-current-text nil)
(defvar fancy-splash-help-echo nil)
1057
(defvar fancy-splash-stop-time nil)
1058 1059


1060 1061 1062 1063 1064 1065 1066 1067 1068
(defun fancy-splash-insert (&rest args)
  "Insert text into the current buffer, with faces.
Arguments from ARGS should be either strings or pairs `:face FACE',
where FACE is a valid face specification, as it can be used with
`put-text-properties'."
  (let ((current-face nil))
    (while args
      (if (eq (car args) :face)
	  (setq args (cdr args) current-face (car args))
1069 1070 1071
	(insert (propertize (car args)
			    'face current-face
			    'help-echo fancy-splash-help-echo)))
1072 1073 1074 1075 1076
      (setq args (cdr args)))))


(defun fancy-splash-head ()
  "Insert the head part of the splash screen into the current buffer."
1077
  (let* ((img (create-image (or fancy-splash-image