Various docstring and commentary fixes, including
[emacs.git] / lisp / startup.el
bloba5786239380b134073c1bf8064a6673ee8348894
1 ;;; startup.el --- process Emacs shell arguments
3 ;; Copyright (C) 1985, 86, 92, 94, 95, 96, 97, 1998 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; This file parses the command line and gets Emacs running. Options on
28 ;; the command line are handled in precedence order. The order is the
29 ;; one in the list below; first described means first handled. Options
30 ;; within each category (delimited by a bar) are handled in the order
31 ;; encountered on the command line.
33 ;; -------------------------
34 ;; -version Print Emacs version to stderr, then exit
35 ;; --version successfully right away.
36 ;; This option is handled by emacs.c
37 ;; -------------------------
38 ;; -help Print a short usage description and exit
39 ;; --help successfully right away.
40 ;; This option is handled by emacs.c
41 ;; -------------------------
42 ;; -nl Do not use shared memory (for systems that
43 ;; -no-shared-memory support this) for the dumped Emacs data.
44 ;; This option is handled by emacs.c
46 ;; -map For VMS.
47 ;; --map-data This option is handled by emacs.c
48 ;; -------------------------
49 ;; -t FILE Use FILE as the name of the terminal.
50 ;; --terminal FILE Using this implies "-nw" also.
51 ;; This option is handled by emacs.c
52 ;; -------------------------
53 ;; -d DISPNAME Use DISPNAME as the name of the X-windows
54 ;; -display DISPNAME display for the initial frame.
55 ;; --display DISPNAME This option is handled by emacs.c
56 ;; -------------------------
57 ;; -nw Do not use a windows system (but use the
58 ;; --no-windows terminal instead.)
59 ;; This option is handled by emacs.c
60 ;; -------------------------
61 ;; -batch Execute noninteractively (messages go to stdout,
62 ;; --batch variable noninteractive set to t)
63 ;; This option is handled by emacs.c
64 ;; -------------------------
65 ;; -q Do not load user's init file and do not load
66 ;; -no-init-file "default.el". Regardless of this switch,
67 ;; --no-init-file "site-start" is still loaded.
68 ;; -------------------------
69 ;; -no-site-file Do not load "site-start.el". (This is the ONLY
70 ;; --no-site-file way to prevent loading that file.)
71 ;; -------------------------
72 ;; -u USER Load USER's init file instead of the init
73 ;; -user USER file belonging to the user starting Emacs.
74 ;; --user USER
75 ;; -------------------------
76 ;; -debug-init Don't catch errors in init files; let the
77 ;; --debug-init debugger run.
78 ;; -------------------------
79 ;; -i ICONTYPE Set type of icon using when Emacs is
80 ;; -itype ICONTYPE iconified under X-windows.
81 ;; --icon-type ICONTYPE This option is passed on to term/x-win.el
83 ;; -iconic Start Emacs iconified under X-windows.
84 ;; --iconic This option is passed on to term/x-win.el
85 ;; -------------------------
86 ;; Various X-windows options for colors/fonts/geometry/title etc.
87 ;; These options are passed on to term/x-win.el which see. Certain
88 ;; of these are also found in term/pc-win.el
89 ;; -------------------------
90 ;; FILE Visit FILE.
92 ;; -L DIRNAME Add DIRNAME to load-path
93 ;; -directory DIRNAME
94 ;; --directory DIRNAME
96 ;; -l FILE Load and execute the Emacs lisp code
97 ;; -load FILE in FILE.
98 ;; --load FILE
100 ;; -f FUNC Execute Emacs lisp function FUNC with
101 ;; -funcall FUNC no arguments. The "-e" form is outdated
102 ;; --funcall FUNC and should not be used. (It's a typo
103 ;; -e FUNC promoted to a feature.)
105 ;; -eval FORM Execute Emacs lisp form FORM.
106 ;; --eval FORM
108 ;; -insert FILE Insert the contents of FILE into buffer.
109 ;; --insert FILE
110 ;; -------------------------
111 ;; -kill Kill (exit) Emacs right away.
112 ;; --kill
113 ;; -------------------------
115 ;;; Code:
117 (setq top-level '(normal-top-level))
119 (defvar command-line-processed nil
120 "Non-nil once command line has been processed")
122 (defgroup initialization nil
123 "Emacs start-up procedure"
124 :group 'internal)
126 (defcustom inhibit-startup-message nil
127 "*Non-nil inhibits the initial startup message.
128 This is for use in your personal init file, once you are familiar
129 with the contents of the startup message."
130 :type 'boolean
131 :group 'initialization)
133 (defcustom inhibit-startup-echo-area-message nil
134 "*Non-nil inhibits the initial startup echo area message.
135 Setting this variable takes effect
136 only if you do it with the customization buffer
137 or it your `.emacs' file contains a line of this form:
138 (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\")
139 If your `.emacs' file is byte-compiled, use the following form instead:
140 (eval '(setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\"))
141 Thus, someone else using a copy of your `.emacs' file will see
142 the startup message unless he personally acts to inhibit it."
143 :type '(choice (const :tag "Don't inhibit")
144 (string :tag "Enter your user name, to inhibit"))
145 :group 'initialization)
147 (defcustom inhibit-default-init nil
148 "*Non-nil inhibits loading the `default' library."
149 :type 'boolean
150 :group 'initialization)
152 (defvar command-switch-alist nil
153 "Alist of command-line switches.
154 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
155 HANDLER-FUNCTION receives switch name as sole arg;
156 remaining command-line args are in the variable `command-line-args-left'.")
158 (defvar command-line-args-left nil
159 "List of command-line args not yet processed.")
161 (defvar command-line-functions nil ;; lrs 7/31/89
162 "List of functions to process unrecognized command-line arguments.
163 Each function should access the dynamically bound variables
164 `argi' (the current argument) and `command-line-args-left' (the remaining
165 arguments). The function should return non-nil only if it recognizes and
166 processes `argi'. If it does so, it may consume successive arguments by
167 altering `command-line-args-left' to remove them.")
169 (defvar command-line-default-directory nil
170 "Default directory to use for command line arguments.
171 This is normally copied from `default-directory' when Emacs starts.")
173 ;;; This is here, rather than in x-win.el, so that we can ignore these
174 ;;; options when we are not using X.
175 (defvar command-line-x-option-alist
176 '(("-bw" 1 x-handle-numeric-switch border-width)
177 ("-d" 1 x-handle-display)
178 ("-display" 1 x-handle-display)
179 ("-name" 1 x-handle-name-switch)
180 ("-title" 1 x-handle-switch title)
181 ("-T" 1 x-handle-switch title)
182 ("-r" 0 x-handle-switch reverse t)
183 ("-rv" 0 x-handle-switch reverse t)
184 ("-reverse" 0 x-handle-switch reverse t)
185 ("-reverse-video" 0 x-handle-switch reverse t)
186 ("-fn" 1 x-handle-switch font)
187 ("-font" 1 x-handle-switch font)
188 ("-ib" 1 x-handle-numeric-switch internal-border-width)
189 ("-g" 1 x-handle-geometry)
190 ("-geometry" 1 x-handle-geometry)
191 ("-fg" 1 x-handle-switch foreground-color)
192 ("-foreground" 1 x-handle-switch foreground-color)
193 ("-bg" 1 x-handle-switch background-color)
194 ("-background" 1 x-handle-switch background-color)
195 ("-ms" 1 x-handle-switch mouse-color)
196 ("-itype" 0 x-handle-switch icon-type t)
197 ("-i" 0 x-handle-switch icon-type t)
198 ("-iconic" 0 x-handle-iconic)
199 ("-xrm" 1 x-handle-xrm-switch)
200 ("-cr" 1 x-handle-switch cursor-color)
201 ("-vb" 0 x-handle-switch vertical-scroll-bars t)
202 ("-hb" 0 x-handle-switch horizontal-scroll-bars t)
203 ("-bd" 1 x-handle-switch)
204 ("--border-width" 1 x-handle-numeric-switch border-width)
205 ("--display" 1 x-handle-display)
206 ("--name" 1 x-handle-name-switch)
207 ("--title" 1 x-handle-switch title)
208 ("--reverse-video" 0 x-handle-switch reverse t)
209 ("--font" 1 x-handle-switch font)
210 ("--internal-border" 1 x-handle-numeric-switch internal-border-width)
211 ("--geometry" 1 x-handle-geometry)
212 ("--foreground-color" 1 x-handle-switch foreground-color)
213 ("--background-color" 1 x-handle-switch background-color)
214 ("--mouse-color" 1 x-handle-switch mouse-color)
215 ("--icon-type" 0 x-handle-switch icon-type t)
216 ("--iconic" 0 x-handle-iconic)
217 ("--xrm" 1 x-handle-xrm-switch)
218 ("--cursor-color" 1 x-handle-switch cursor-color)
219 ("--vertical-scroll-bars" 0 x-handle-switch vertical-scroll-bars t)
220 ("--border-color" 1 x-handle-switch border-width))
221 "Alist of X Windows options.
222 Each element has the form
223 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
224 where NAME is the option name string, NUMARGS is the number of arguments
225 that the option accepts, HANDLER is a function to call to handle the option.
226 FRAME-PARAM (optional) is the frame parameter this option specifies,
227 and VALUE is the value which is given to that frame parameter
228 \(most options use the argument for this, so VALUE is not present).")
230 (defvar before-init-hook nil
231 "Normal hook run after handling urgent options but before loading init files.")
233 (defvar after-init-hook nil
234 "Normal hook run after loading the init files, `~/.emacs' and `default.el'.
235 There is no `condition-case' around the running of these functions;
236 therefore, if you set `debug-on-error' non-nil in `.emacs',
237 an error in one of these functions will invoke the debugger.")
239 (defvar emacs-startup-hook nil
240 "Normal hook run after loading init files and handling the command line.")
242 (defvar term-setup-hook nil
243 "Normal hook run after loading terminal-specific Lisp code.
244 It also follows `emacs-startup-hook'. This hook exists for users to set,
245 so as to override the definitions made by the terminal-specific file.
246 Emacs never sets this variable itself.")
248 (defvar keyboard-type nil
249 "The brand of keyboard you are using.
250 This variable is used to define
251 the proper function and keypad keys for use under X. It is used in a
252 fashion analogous to the environment value TERM.")
254 (defvar window-setup-hook nil
255 "Normal hook run to initialize window system display.
256 Emacs runs this hook after processing the command line arguments and loading
257 the user's init file.")
259 (defcustom initial-major-mode 'lisp-interaction-mode
260 "Major mode command symbol to use for the initial *scratch* buffer."
261 :type 'function
262 :group 'initialization)
264 (defcustom init-file-user nil
265 "Identity of user whose `.emacs' file is or was read.
266 The value is nil if `-q' or `--no-init-file' was specified,
267 meaning do not load any init file.
269 Otherwise, the value may be the null string, meaning use the init file
270 for the user that originally logged in, or it may be a
271 string containing a user's name meaning use that person's init file.
273 In either of the latter cases, `(concat \"~\" init-file-user \"/\")'
274 evaluates to the name of the directory where the `.emacs' file was
275 looked for.
277 Setting `init-file-user' does not prevent Emacs from loading
278 `site-start.el'. The only way to do that is to use `--no-site-file'."
279 :type '(choice (const :tag "none" nil) string)
280 :group 'initialization)
282 (defcustom site-run-file "site-start"
283 "File containing site-wide run-time initializations.
284 This file is loaded at run-time before `~/.emacs'. It contains inits
285 that need to be in place for the entire site, but which, due to their
286 higher incidence of change, don't make sense to load into emacs'
287 dumped image. Thus, the run-time load order is: 1. file described in
288 this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.
290 Don't use the `site-start.el' file for things some users may not like.
291 Put them in `default.el' instead, so that users can more easily
292 override them. Users can prevent loading `default.el' with the `-q'
293 option or by setting `inhibit-default-init' in their own init files,
294 but inhibiting `site-start.el' requires `--no-site-file', which
295 is less convenient."
296 :type 'string
297 :group 'initialization)
299 (defconst iso-8859-n-locale-regexp "8859[-_]?\\([1-49]\\)"
300 "Regexp that specifies when to enable an ISO 8859-N character set.
301 We do that if this regexp matches the locale name
302 specified by the LC_ALL, LC_CTYPE and LANG environment variables.
303 The paren group in the regexp should match the specific character
304 set number, N.")
306 (defcustom mail-host-address nil
307 "*Name of this machine, for purposes of naming users."
308 :type '(choice (const nil) string)
309 :group 'mail)
311 (defcustom user-mail-address nil
312 "*Full mailing address of this user.
313 This is initialized based on `mail-host-address',
314 after your init file is read, in case it sets `mail-host-address'."
315 :type 'string
316 :group 'mail)
318 (defcustom auto-save-list-file-prefix
319 (if (eq system-type 'ms-dos)
320 "~/_s" ; MS-DOS cannot have initial dot, and allows only 8.3 names
321 "~/.saves-")
322 "Prefix for generating `auto-save-list-file-name'.
323 This is used after reading your `.emacs' file to initialize
324 `auto-save-list-file-name', by appending Emacs's pid and the system name,
325 if you have not already set `auto-save-list-file-name' yourself.
326 Set this to nil if you want to prevent `auto-save-list-file-name'
327 from being initialized."
328 :type '(choice (const :tag "Don't record a session's auto save list" nil)
329 string)
330 :group 'auto-save)
332 (defvar init-file-debug nil)
334 (defvar init-file-had-error nil)
336 ;; This function is called from the subdirs.el file.
337 (defun normal-top-level-add-to-load-path (dirs)
338 (let ((tail load-path)
339 (thisdir (directory-file-name default-directory)))
340 (while (and tail
341 (not (equal thisdir (car tail)))
342 (not (and (memq system-type '(ms-dos windows-nt))
343 (equal (downcase thisdir) (downcase (car tail))))))
344 (setq tail (cdr tail)))
345 (setcdr tail (append (mapcar 'expand-file-name dirs) (cdr tail)))))
347 (defun normal-top-level ()
348 (if command-line-processed
349 (message "Back to top level.")
350 (setq command-line-processed t)
351 ;; Give *Messages* the same default-directory as *scratch*,
352 ;; just to keep things predictable.
353 (let ((dir default-directory))
354 (save-excursion
355 (set-buffer (get-buffer "*Messages*"))
356 (setq default-directory dir)))
357 ;; Look in each dir in load-path for a subdirs.el file.
358 ;; If we find one, load it, which will add the appropriate subdirs
359 ;; of that dir into load-path,
360 (let ((tail load-path)
361 new)
362 (while tail
363 (setq new (cons (car tail) new))
364 (let ((default-directory (car tail)))
365 (load (expand-file-name "subdirs.el" (car tail)) t t t))
366 (setq tail (cdr tail))))
367 (if (not (eq system-type 'vax-vms))
368 (progn
369 ;; If the PWD environment variable isn't accurate, delete it.
370 (let ((pwd (getenv "PWD")))
371 (and (stringp pwd)
372 ;; Use FOO/., so that if FOO is a symlink, file-attributes
373 ;; describes the directory linked to, not FOO itself.
374 (or (equal (file-attributes
375 (concat (file-name-as-directory pwd) "."))
376 (file-attributes
377 (concat (file-name-as-directory default-directory)
378 ".")))
379 (setq process-environment
380 (delete (concat "PWD=" pwd)
381 process-environment)))))))
382 (setq default-directory (abbreviate-file-name default-directory))
383 (let ((menubar-bindings-done nil))
384 (unwind-protect
385 (command-line)
386 ;; Do this again, in case .emacs defined more abbreviations.
387 (setq default-directory (abbreviate-file-name default-directory))
388 ;; Specify the file for recording all the auto save files of this session.
389 ;; This is used by recover-session.
390 (or auto-save-list-file-name
391 (and auto-save-list-file-prefix
392 (setq auto-save-list-file-name
393 ;; Under MS-DOS our PID is almost always reused between
394 ;; Emacs invocations. We need something more unique.
395 (if (eq system-type 'ms-dos)
396 (concat
397 (make-temp-name
398 (expand-file-name auto-save-list-file-prefix))
399 "~")
401 (expand-file-name (format "%s%d-%s~"
402 auto-save-list-file-prefix
403 (emacs-pid)
404 (system-name)))))))
405 (run-hooks 'emacs-startup-hook)
406 (and term-setup-hook
407 (run-hooks 'term-setup-hook))
408 ;; Modify the initial frame based on what .emacs puts into
409 ;; ...-frame-alist.
410 (if (fboundp 'frame-notice-user-settings)
411 (frame-notice-user-settings))
412 ;; Now we know the user's default font, so add it to the menu.
413 (if (fboundp 'font-menu-add-default)
414 (font-menu-add-default))
415 (and window-setup-hook
416 (run-hooks 'window-setup-hook))
417 (or menubar-bindings-done
418 (if (memq window-system '(x w32))
419 (precompute-menubar-bindings)))))))
421 ;; Precompute the keyboard equivalents in the menu bar items.
422 (defun precompute-menubar-bindings ()
423 (let ((submap (lookup-key global-map [menu-bar])))
424 (while submap
425 (and (consp (car submap))
426 (symbolp (car (car submap)))
427 (stringp (car-safe (cdr (car submap))))
428 (keymapp (cdr (cdr (car submap))))
429 (progn
430 (x-popup-menu nil (cdr (cdr (car submap))))
431 (if purify-flag
432 (garbage-collect))))
433 (setq submap (cdr submap))))
434 (setq define-key-rebound-commands t))
436 (defun command-line ()
437 (setq command-line-default-directory default-directory)
439 ;; See if we should import version-control from the environment variable.
440 (let ((vc (getenv "VERSION_CONTROL")))
441 (cond ((eq vc nil)) ;don't do anything if not set
442 ((or (string= vc "t")
443 (string= vc "numbered"))
444 (setq version-control t))
445 ((or (string= vc "nil")
446 (string= vc "existing"))
447 (setq version-control nil))
448 ((or (string= vc "never")
449 (string= vc "simple"))
450 (setq version-control 'never))))
452 (let ((ctype
453 ;; Use the first of these three envvars that has a nonempty value.
454 (or (let ((string (getenv "LC_ALL")))
455 (and (not (equal string "")) string))
456 (let ((string (getenv "LC_CTYPE")))
457 (and (not (equal string "")) string))
458 (let ((string (getenv "LANG")))
459 (and (not (equal string "")) string)))))
460 (when (and ctype
461 (string-match iso-8859-n-locale-regexp ctype))
462 (let (charset (which (match-string 1 ctype)))
463 (if (equal "5" which)
464 (setq which "9"))
465 (setq charset (concat "latin-" which))
466 ;; Set up for this character set in multibyte mode.
467 (if (string-match "latin-[12345]" charset)
468 (set-language-environment charset))
469 (standard-display-european t charset))))
471 ;;! This has been commented out; I currently find the behavior when
472 ;;! split-window-keep-point is nil disturbing, but if I can get used
473 ;;! to it, then it would be better to eliminate the option.
474 ;;! ;; Choose a good default value for split-window-keep-point.
475 ;;! (setq split-window-keep-point (> baud-rate 2400))
477 ;; Read window system's init file if using a window system.
478 (condition-case error
479 (if (and window-system (not noninteractive))
480 (load (concat term-file-prefix
481 (symbol-name window-system)
482 "-win")
483 ;; Every window system should have a startup file;
484 ;; barf if we can't find it.
485 nil t))
486 ;; If we can't read it, print the error message and exit.
487 (error
488 (princ
489 (if (eq (car error) 'error)
490 (apply 'concat (cdr error))
491 (if (memq 'file-error (get (car error) 'error-conditions))
492 (format "%s: %s"
493 (nth 1 error)
494 (mapconcat '(lambda (obj) (prin1-to-string obj t))
495 (cdr (cdr error)) ", "))
496 (format "%s: %s"
497 (get (car error) 'error-message)
498 (mapconcat '(lambda (obj) (prin1-to-string obj t))
499 (cdr error) ", "))))
500 'external-debugging-output)
501 (setq window-system nil)
502 (kill-emacs)))
504 (let ((done nil)
505 (args (cdr command-line-args)))
507 ;; Figure out which user's init file to load,
508 ;; either from the environment or from the options.
509 (setq init-file-user (if noninteractive nil (user-login-name)))
510 ;; If user has not done su, use current $HOME to find .emacs.
511 (and init-file-user (string= init-file-user (user-real-login-name))
512 (setq init-file-user ""))
514 ;; Process the command-line args, and delete the arguments
515 ;; processed. This is consistent with the way main in emacs.c
516 ;; does things.
517 (while (and (not done) args)
518 (let ((longopts '(("--no-init-file") ("--no-site-file") ("--user")
519 ("--debug-init") ("--iconic") ("--icon-type")))
520 (argi (car args))
521 (argval nil))
522 ;; Handle --OPTION=VALUE format.
523 (if (and (string-match "\\`--" argi)
524 (string-match "=" argi))
525 (setq argval (substring argi (match-end 0))
526 argi (substring argi 0 (match-beginning 0))))
527 (or (equal argi "--")
528 (let ((completion (try-completion argi longopts)))
529 (if (eq completion t)
530 (setq argi (substring argi 1))
531 (if (stringp completion)
532 (let ((elt (assoc completion longopts)))
533 (or elt
534 (error "Option `%s' is ambiguous" argi))
535 (setq argi (substring (car elt) 1)))
536 (setq argval nil)))))
537 (cond
538 ((or (string-equal argi "-q")
539 (string-equal argi "-no-init-file"))
540 (setq init-file-user nil
541 args (cdr args)))
542 ((or (string-equal argi "-u")
543 (string-equal argi "-user"))
544 (or argval
545 (setq args (cdr args)
546 argval (car args)))
547 (setq init-file-user argval
548 argval nil
549 args (cdr args)))
550 ((string-equal argi "-no-site-file")
551 (setq site-run-file nil
552 args (cdr args)))
553 ((string-equal argi "-debug-init")
554 (setq init-file-debug t
555 args (cdr args)))
556 ((string-equal argi "-iconic")
557 (setq initial-frame-alist
558 (cons '(visibility . icon) initial-frame-alist))
559 (setq args (cdr args)))
560 ((or (string-equal argi "-icon-type")
561 (string-equal argi "-i")
562 (string-equal argi "-itype"))
563 (setq default-frame-alist
564 (cons '(icon-type . t) default-frame-alist))
565 (setq args (cdr args)))
566 (t (setq done t)))
567 ;; Was argval set but not used?
568 (and argval
569 (error "Option `%s' doesn't allow an argument" argi))))
571 ;; Re-attach the program name to the front of the arg list.
572 (and command-line-args (setcdr command-line-args args)))
574 ;; Under X Windows, this creates the X frame and deletes the terminal frame.
575 (if (fboundp 'frame-initialize)
576 (frame-initialize))
577 ;; If frame was created with a menu bar, set menu-bar-mode on.
578 (if (or (not (memq window-system '(x w32)))
579 (> (cdr (assq 'menu-bar-lines (frame-parameters))) 0))
580 (menu-bar-mode t))
582 (run-hooks 'before-init-hook)
584 ;; Run the site-start library if it exists. The point of this file is
585 ;; that it is run before .emacs. There is no point in doing this after
586 ;; .emacs; that is useless.
587 (if site-run-file
588 (load site-run-file t t))
590 ;; Register avairable input methods by loading LEIM list file.
591 (load "leim-list.el" 'noerror 'nomessage 'nosuffix)
593 ;; Sites should not disable this. Only individuals should disable
594 ;; the startup message.
595 (setq inhibit-startup-message nil)
597 ;; Load that user's init file, or the default one, or none.
598 (let (debug-on-error-from-init-file
599 debug-on-error-should-be-set
600 (debug-on-error-initial
601 (if (eq init-file-debug t) 'startup init-file-debug)))
602 (let ((debug-on-error debug-on-error-initial)
603 ;; This function actually reads the init files.
604 (inner
605 (function
606 (lambda ()
607 (if init-file-user
608 (progn
609 (setq user-init-file
610 (cond
611 ((eq system-type 'ms-dos)
612 (concat "~" init-file-user "/_emacs"))
613 ((eq system-type 'windows-nt)
614 (if (file-exists-p "~/.emacs")
615 "~/.emacs"
616 "~/_emacs"))
617 ((eq system-type 'vax-vms)
618 "sys$login:.emacs")
620 (concat "~" init-file-user "/.emacs"))))
621 (load user-init-file t t)
622 (or inhibit-default-init
623 (let ((inhibit-startup-message nil))
624 ;; Users are supposed to be told their rights.
625 ;; (Plus how to get help and how to undo.)
626 ;; Don't you dare turn this off for anyone
627 ;; except yourself.
628 (load "default" t t)))))))))
629 (if init-file-debug
630 ;; Do this without a condition-case if the user wants to debug.
631 (funcall inner)
632 (condition-case error
633 (progn
634 (funcall inner)
635 (setq init-file-had-error nil))
636 (error (message "Error in init file: %s%s%s"
637 (get (car error) 'error-message)
638 (if (cdr error) ": " "")
639 (mapconcat 'prin1-to-string (cdr error) ", "))
640 (setq init-file-had-error t))))
641 ;; If we can tell that the init file altered debug-on-error,
642 ;; arrange to preserve the value that it set up.
643 (or (eq debug-on-error debug-on-error-initial)
644 (setq debug-on-error-should-be-set t
645 debug-on-error-from-init-file debug-on-error)))
646 (if debug-on-error-should-be-set
647 (setq debug-on-error debug-on-error-from-init-file)))
649 ;; Do this here in case the init file sets mail-host-address.
650 (or user-mail-address
651 (setq user-mail-address (concat (user-login-name) "@"
652 (or mail-host-address
653 (system-name)))))
655 (run-hooks 'after-init-hook)
657 ;; If *scratch* exists and init file didn't change its mode, initialize it.
658 (if (get-buffer "*scratch*")
659 (save-excursion
660 (set-buffer "*scratch*")
661 (if (eq major-mode 'fundamental-mode)
662 (funcall initial-major-mode))))
663 ;; Load library for our terminal type.
664 ;; User init file can set term-file-prefix to nil to prevent this.
665 (and term-file-prefix (not noninteractive) (not window-system)
666 (let ((term (getenv "TERM"))
667 hyphend)
668 (while (and term
669 (not (load (concat term-file-prefix term) t t)))
670 ;; Strip off last hyphen and what follows, then try again
671 (if (setq hyphend (string-match "[-_][^-_]+$" term))
672 (setq term (substring term 0 hyphend))
673 (setq term nil)))))
675 ;; Process the remaining args.
676 (command-line-1 (cdr command-line-args))
678 ;; If -batch, terminate after processing the command options.
679 (if noninteractive (kill-emacs t)))
681 (defcustom initial-scratch-message "\
682 This buffer is for notes you don't want to save, and for Lisp evaluation.
683 If you want to create a file, visit that file with C-x C-f,
684 then enter the text in that file's own buffer.
687 "Initial message displayed in *scratch* buffer at startup.
688 If this is nil, no message will be displayed."
689 :type 'string)
691 (defun command-line-1 (command-line-args-left)
692 (or noninteractive (input-pending-p) init-file-had-error
693 (and inhibit-startup-echo-area-message
694 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
695 (equal inhibit-startup-echo-area-message
696 (if (string= init-file-user "")
697 (user-login-name)
698 init-file-user)))
699 ;; Wasn't set with custom; see if .emacs has a setq.
700 (let ((buffer (get-buffer-create " *temp*")))
701 (prog1
702 (condition-case nil
703 (save-excursion
704 (set-buffer buffer)
705 (insert-file-contents user-init-file)
706 (re-search-forward
707 (concat
708 "([ \t\n]*setq[ \t\n]+"
709 "inhibit-startup-echo-area-message[ \t\n]+"
710 (regexp-quote
711 (prin1-to-string
712 (if (string= init-file-user "")
713 (user-login-name)
714 init-file-user)))
715 "[ \t\n]*)")
716 nil t))
717 (error nil))
718 (kill-buffer buffer)))))
719 (message (if (eq (key-binding "\C-h\C-p") 'describe-project)
720 "For information about the GNU Project and its goals, type C-h C-p."
721 (substitute-command-keys
722 "For information about the GNU Project and its goals, type \\[describe-project]."))))
723 (if (null command-line-args-left)
724 (cond ((and (not inhibit-startup-message) (not noninteractive)
725 ;; Don't clobber a non-scratch buffer if init file
726 ;; has selected it.
727 (string= (buffer-name) "*scratch*"))
728 ;; If there are no switches to process, we might as well
729 ;; run this hook now, and there may be some need to do it
730 ;; before doing any output.
731 (and term-setup-hook
732 (run-hooks 'term-setup-hook))
733 ;; Don't let the hook be run twice.
734 (setq term-setup-hook nil)
736 ;; It's important to notice the user settings before we
737 ;; display the startup message; otherwise, the settings
738 ;; won't take effect until the user gives the first
739 ;; keystroke, and that's distracting.
740 (if (fboundp 'frame-notice-user-settings)
741 (frame-notice-user-settings))
743 (and window-setup-hook
744 (run-hooks 'window-setup-hook))
745 (setq window-setup-hook nil)
746 ;; Do this now to avoid an annoying delay if the user
747 ;; clicks the menu bar during the sit-for.
748 (if (memq window-system '(x w32))
749 (precompute-menubar-bindings))
750 (setq menubar-bindings-done t)
751 (when (= (buffer-size) 0)
752 (let ((buffer-undo-list t))
753 (unwind-protect
754 (when (not (input-pending-p))
755 (goto-char (point-max))
756 ;; The convention for this piece of code is that
757 ;; each piece of output starts with one or two newlines
758 ;; and does not end with any newlines.
759 (insert "Welcome to GNU Emacs")
760 (if (eq system-type 'gnu/linux)
761 (insert ", one component of a Linux-based GNU system."))
762 (insert "\n")
763 (if (assq 'display (frame-parameters))
764 (progn
765 (insert "\
766 The menu bar menus above are sufficient for basic editing with the mouse,
768 Useful Files menu items:
769 Exit Emacs (or type Control-x followed by Control-c)
770 Recover Session recover files you were editing before a crash
772 Important Help menu items:
773 Emacs Tutorial Learn-by-doing tutorial for using Emacs efficiently.
774 \(Non)Warranty GNU Emacs comes with ABSOLUTELY NO WARRANTY
775 Copying Conditions Conditions for redistributing and changing Emacs.
776 Getting New Versions How to obtain the latest version of Emacs.
778 (insert "\n\n" (emacs-version)
780 Copyright (C) 1998 Free Software Foundation, Inc."))
781 ;; If keys have their default meanings,
782 ;; use precomputed string to save lots of time.
783 (if (and (eq (key-binding "\C-h") 'help-command)
784 (eq (key-binding "\C-xu") 'advertised-undo)
785 (eq (key-binding "\C-x\C-c") 'save-buffers-kill-emacs)
786 (eq (key-binding "\C-ht") 'help-with-tutorial)
787 (eq (key-binding "\C-hi") 'info)
788 (eq (key-binding "\C-h\C-n") 'view-emacs-news))
789 (insert "
790 Get help C-h (Hold down CTRL and press h)
791 Undo changes C-x u Exit Emacs C-x C-c
792 Get a tutorial C-h t Use Info to read docs C-h i")
793 (insert (substitute-command-keys
794 (format "\n
795 Get help %s
796 Undo changes \\[advertised-undo]
797 Exit Emacs \\[save-buffers-kill-emacs]
798 Get a tutorial \\[help-with-tutorial]
799 Use Info to read docs \\[info]"
800 (let ((where (where-is-internal
801 'help-command nil t)))
802 (if where
803 (key-description where)
804 "M-x help"))))))
805 ;; Say how to use the menu bar
806 ;; if that is not with the mouse.
807 (if (and (eq (key-binding "\M-`") 'tmm-menubar)
808 (eq (key-binding [f10]) 'tmm-menubar))
809 (insert "
810 Activate menubar F10 or ESC ` or M-`")
811 (insert (substitute-command-keys "
812 Activate menubar \\[tmm-menubar]")))
814 ;; Windows and MSDOS (currently) do not count as
815 ;; window systems, but do have mouse support.
816 (if window-system
817 (insert "
818 Mode-specific menu C-mouse-3 (third button, with CTRL)"))
819 ;; Many users seem to have problems with these.
820 (insert "
821 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
822 If you have no Meta key, you may instead type ESC followed by the character.)")
823 (and auto-save-list-file-prefix
824 (directory-files
825 (file-name-directory auto-save-list-file-prefix)
827 (concat "\\`"
828 (regexp-quote (file-name-nondirectory
829 auto-save-list-file-prefix)))
831 (insert "\n\nIf an Emacs session crashed recently, "
832 "type M-x recover-session RET\nto recover"
833 " the files you were editing."))
835 (insert "\n\n" (emacs-version)
837 Copyright (C) 1998 Free Software Foundation, Inc.")
838 (if (and (eq (key-binding "\C-h\C-c") 'describe-copying)
839 (eq (key-binding "\C-h\C-d") 'describe-distribution)
840 (eq (key-binding "\C-h\C-w") 'describe-no-warranty))
841 (insert
843 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for full details.
844 You may give out copies of Emacs; type C-h C-c to see the conditions.
845 Type C-h C-d for information on getting the latest version.")
846 (insert (substitute-command-keys
848 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for full details.
849 You may give out copies of Emacs; type \\[describe-copying] to see the conditions.
850 Type \\[describe-distribution] for information on getting the latest version."))))
851 (goto-char (point-min))
853 (set-buffer-modified-p nil)
854 (sit-for 120))
855 (with-current-buffer (get-buffer "*scratch*")
856 (erase-buffer)
857 (and initial-scratch-message
858 (insert initial-scratch-message))
859 (set-buffer-modified-p nil)))))))
860 ;; Delay 2 seconds after the init file error message
861 ;; was displayed, so user can read it.
862 (if init-file-had-error
863 (sit-for 2))
864 (let ((dir command-line-default-directory)
865 (file-count 0)
866 first-file-buffer
868 just-files ;; t if this follows the magic -- option.
869 ;; This includes our standard options' long versions
870 ;; and long versions of what's on command-switch-alist.
871 (longopts
872 (append '(("--funcall") ("--load") ("--insert") ("--kill")
873 ("--directory") ("--eval") ("--find-file") ("--visit"))
874 (mapcar '(lambda (elt)
875 (list (concat "-" (car elt))))
876 command-switch-alist)))
877 (line 0))
879 ;; Add the long X options to longopts.
880 (setq tem command-line-x-option-alist)
881 (while tem
882 (if (string-match "^--" (car (car tem)))
883 (setq longopts (cons (list (car (car tem))) longopts)))
884 (setq tem (cdr tem)))
886 ;; Loop, processing options.
887 (while (and command-line-args-left)
888 (let* ((argi (car command-line-args-left))
889 (orig-argi argi)
890 argval completion
891 ;; List of directories specified in -L/--directory,
892 ;; in reverse of the order specified.
893 extra-load-path
894 (initial-load-path load-path))
895 (setq command-line-args-left (cdr command-line-args-left))
897 ;; Do preliminary decoding of the option.
898 (if just-files
899 ;; After --, don't look for options; treat all args as files.
900 (setq argi "")
901 ;; Convert long options to ordinary options
902 ;; and separate out an attached option argument into argval.
903 (if (string-match "^--[^=]*=" argi)
904 (setq argval (substring argi (match-end 0))
905 argi (substring argi 0 (1- (match-end 0)))))
906 (if (equal argi "--")
907 (setq completion nil)
908 (setq completion (try-completion argi longopts)))
909 (if (eq completion t)
910 (setq argi (substring argi 1))
911 (if (stringp completion)
912 (let ((elt (assoc completion longopts)))
913 (or elt
914 (error "Option `%s' is ambiguous" argi))
915 (setq argi (substring (car elt) 1)))
916 (setq argval nil argi orig-argi))))
918 ;; Execute the option.
919 (cond ((setq tem (assoc argi command-switch-alist))
920 (if argval
921 (let ((command-line-args-left
922 (cons argval command-line-args-left)))
923 (funcall (cdr tem) argi))
924 (funcall (cdr tem) argi)))
925 ((or (string-equal argi "-f") ;what the manual claims
926 (string-equal argi "-funcall")
927 (string-equal argi "-e")) ; what the source used to say
928 (if argval
929 (setq tem (intern argval))
930 (setq tem (intern (car command-line-args-left)))
931 (setq command-line-args-left (cdr command-line-args-left)))
932 (if (arrayp (symbol-function tem))
933 (command-execute tem)
934 (funcall tem)))
935 ((string-equal argi "-eval")
936 (if argval
937 (setq tem argval)
938 (setq tem (car command-line-args-left))
939 (setq command-line-args-left (cdr command-line-args-left)))
940 (eval (read tem)))
941 ;; Set the default directory as specified in -L.
942 ((or (string-equal argi "-L")
943 (string-equal argi "-directory"))
944 (if argval
945 (setq tem argval)
946 (setq tem (car command-line-args-left)
947 command-line-args-left (cdr command-line-args-left)))
948 (setq tem (command-line-normalize-file-name tem))
949 (setq extra-load-path
950 (cons (expand-file-name tem) extra-load-path))
951 (setq load-path (append (nreverse extra-load-path)
952 initial-load-path)))
953 ((or (string-equal argi "-l")
954 (string-equal argi "-load"))
955 (if argval
956 (setq tem argval)
957 (setq tem (car command-line-args-left)
958 command-line-args-left (cdr command-line-args-left)))
959 (let ((file (command-line-normalize-file-name tem)))
960 ;; Take file from default dir if it exists there;
961 ;; otherwise let `load' search for it.
962 (if (file-exists-p (expand-file-name file))
963 (setq file (expand-file-name file)))
964 (load file nil t)))
965 ((string-equal argi "-insert")
966 (if argval
967 (setq tem argval)
968 (setq tem (car command-line-args-left)
969 command-line-args-left (cdr command-line-args-left)))
970 (or (stringp tem)
971 (error "File name omitted from `-insert' option"))
972 (insert-file-contents (command-line-normalize-file-name tem)))
973 ((string-equal argi "-kill")
974 (kill-emacs t))
975 ((string-match "^\\+[0-9]+\\'" argi)
976 (setq line (string-to-int argi)))
977 ((setq tem (assoc argi command-line-x-option-alist))
978 ;; Ignore X-windows options and their args if not using X.
979 (setq command-line-args-left
980 (nthcdr (nth 1 tem) command-line-args-left)))
981 ((or (string-equal argi "-find-file")
982 (string-equal argi "-visit"))
983 ;; An explicit option to specify visiting a file.
984 (setq file-count (1+ file-count))
985 (let ((file
986 (expand-file-name
987 (command-line-normalize-file-name orig-argi)
988 dir)))
989 (if (= file-count 1)
990 (setq first-file-buffer (find-file file))
991 (find-file-other-window file)))
992 (or (zerop line)
993 (goto-line line))
994 (setq line 0))
995 ((equal argi "--")
996 (setq just-files t))
998 ;; We have almost exhausted our options. See if the
999 ;; user has made any other command-line options available
1000 (let ((hooks command-line-functions);; lrs 7/31/89
1001 (did-hook nil))
1002 (while (and hooks
1003 (not (setq did-hook (funcall (car hooks)))))
1004 (setq hooks (cdr hooks)))
1005 (if (not did-hook)
1006 ;; Ok, presume that the argument is a file name
1007 (progn
1008 (if (string-match "\\`-" argi)
1009 (error "Unknown option `%s'" argi))
1010 (setq file-count (1+ file-count))
1011 (let ((file
1012 (expand-file-name
1013 (command-line-normalize-file-name orig-argi)
1014 dir)))
1015 (if (= file-count 1)
1016 (setq first-file-buffer (find-file file))
1017 (find-file-other-window file)))
1018 (or (zerop line)
1019 (goto-line line))
1020 (setq line 0))))))))
1021 ;; If 3 or more files visited, and not all visible,
1022 ;; show user what they all are.
1023 (and (> file-count 2)
1024 (not noninteractive)
1025 (or (get-buffer-window first-file-buffer)
1026 (progn (other-window 1)
1027 (buffer-menu)))))))
1029 (defun command-line-normalize-file-name (file)
1030 "Collapse multiple slashes to one, to handle non-Emacs file names."
1031 (save-match-data
1032 ;; Use arg 1 so that we don't collapse // at the start of the file name.
1033 ;; That is significant on some systems.
1034 ;; However, /// at the beginning is supposed to mean just /, not //.
1035 (if (string-match "^///+" file)
1036 (setq file (replace-match "/" t t file)))
1037 (while (string-match "//+" file 1)
1038 (setq file (replace-match "/" t t file)))
1039 file))
1041 ;;; startup.el ends here