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

Eric S. Raymond's avatar
Eric S. Raymond committed
3 4
;; Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.

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

Jim Blandy's avatar
Jim Blandy committed
8 9 10 11
;; 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
12
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
13 14 15 16 17 18 19 20 21 22 23
;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

Eric S. Raymond's avatar
Eric S. Raymond committed
24
;;; Commentary:
Jim Blandy's avatar
Jim Blandy committed
25 26 27 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

; These are processed only at the beginning of the argument list.
; -batch		execute noninteractively (messages go to stdout,
;			 variable noninteractive set to t)
;			 This option must be the first in the arglist.
;			 Processed by `main' in emacs.c -- never seen by lisp
; -t file		Specify to use file rather than stdin/stdout
;			 as the terminal.
;			 This option must be the first in the arglist.
;			 Processed by `main' in emacs.c -- never seen by lisp
; -nw			Inhibit the use of any window-system-specific display
;			 code; use the current virtual terminal.
;			 This option must be the first in the arglist.
;			 Processed by `main' in emacs.c -- never seen by lisp
; -q			load no init file
; -no-init-file		same
; -u user		load user's init file
; -user user		same
; -debug-init		Don't catch errors in init file; let debugger run.

; These are processed in the order encountered.
; -f function		execute function
; -funcall function	same
; -l file		load file
; -load file		same
; -insert file		same
; file			visit file
; -kill			kill (exit) emacs

Eric S. Raymond's avatar
Eric S. Raymond committed
54 55
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
(setq top-level '(normal-top-level))

(defvar command-line-processed nil "t once command line has been processed")

(defconst inhibit-startup-message nil
  "*Non-nil inhibits the initial startup messages.
This is for use in your personal init file, once you are familiar
with the contents of the startup message.")

(defconst inhibit-default-init nil
  "*Non-nil inhibits loading the `default' library.")

(defconst command-switch-alist nil
  "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'.")

(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
argi (the current argument) and command-line-args-left (the remaining
arguments).  The function should return non-nil only if it recognizes and
processes argi.  If it does so, it may consume successive arguments by
altering command-line-args-left to remove them.")

Roland McGrath's avatar
Roland McGrath committed
82
(defvar before-init-hook nil
Jim Blandy's avatar
Jim Blandy committed
83
  "Functions to call after handling urgent options but before loading init file.
Jim Blandy's avatar
Jim Blandy committed
84
The frame system uses this to open frames to display messages while
Jim Blandy's avatar
Jim Blandy committed
85 86
Emacs loads the user's initialization file.")

Roland McGrath's avatar
Roland McGrath committed
87
(defvar after-init-hook nil
Richard M. Stallman's avatar
Richard M. Stallman committed
88
  "Functions to call after loading the init file (`~/.emacs').
Roland McGrath's avatar
Roland McGrath committed
89
The call is not protected by a condition-case, so you can set `debug-on-error'
Richard M. Stallman's avatar
Richard M. Stallman committed
90
in `.emacs', and put all the actual code on `after-init-hook'.")
Roland McGrath's avatar
Roland McGrath committed
91

Jim Blandy's avatar
Jim Blandy committed
92
(defvar term-setup-hook nil
Roland McGrath's avatar
Roland McGrath committed
93 94
  "Functions to be called after loading terminal-specific lisp code.
See `run-hooks'.  This variable exists for users to set,
Jim Blandy's avatar
Jim Blandy committed
95 96 97 98 99 100 101 102 103
so as to override the definitions made by the terminal-specific file.
Emacs never sets this variable itself.")

(defvar keyboard-type nil
  "The brand of keyboard you are using.  This variable is used to define
the proper function and keypad keys for use under X.  It is used in a
fashion analogous to the environment value TERM.")

(defvar window-setup-hook nil
Jim Blandy's avatar
Jim Blandy committed
104 105 106 107
  "Function called to initialize window system display.
Emacs calls this after processing the command line arguments and loading
the user's init file.

Jim Blandy's avatar
Jim Blandy committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121
Users should not set this variable; use term-setup-hook instead.")

(defconst initial-major-mode 'lisp-interaction-mode
  "Major mode command symbol to use for the initial *scratch* buffer.")

(defvar init-file-user nil
  "Identity of user whose `.emacs' file is or was read.
The value may be the null string or a string containing a user's name.
If the value is a null string, it means that the init file was taken from
the user that originally logged in.

In all cases, `(concat \"~\" init-file-user \"/\")' evaluates to the
directory name of the directory where the `.emacs' file was looked for.")

122 123 124 125 126 127 128 129
(defvar site-run-file "site-start"
  "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
this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.")

Jim Blandy's avatar
Jim Blandy committed
130 131
(defvar init-file-debug nil)

132 133
(defvar init-file-had-error nil)

Jim Blandy's avatar
Jim Blandy committed
134 135 136 137
(defun normal-top-level ()
  (if command-line-processed
      (message "Back to top level.")
    (setq command-line-processed t)
Jim Blandy's avatar
Jim Blandy committed
138
    (if (not (eq system-type 'vax-vms))
139 140 141 142 143 144 145 146 147 148 149 150 151 152
	(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
153
    (setq default-directory (abbreviate-file-name default-directory))
Jim Blandy's avatar
Jim Blandy committed
154 155
    (unwind-protect
	(command-line)
156 157
      ;; Do this again, in case .emacs defined more abbreviations.
      (setq default-directory (abbreviate-file-name default-directory))
Jim Blandy's avatar
Jim Blandy committed
158 159 160
      (run-hooks 'emacs-startup-hook)
      (and term-setup-hook
	   (run-hooks 'term-setup-hook))
161 162
      ;; Modify the initial frame based on what .emacs puts into
      ;; ...-frame-alist.
163 164
      (if (fboundp 'frame-notice-user-settings)
	  (frame-notice-user-settings))
165 166 167
      ;; Now we know the user's default font, so add it to the menu.
      (if (fboundp 'font-menu-add-default)
	  (font-menu-add-default))
Jim Blandy's avatar
Jim Blandy committed
168 169 170 171
      (and window-setup-hook
	   (run-hooks 'window-setup-hook)))))

(defun command-line ()
Roland McGrath's avatar
Roland McGrath committed
172
  ;; See if we should import version-control from the environment variable.
Jim Blandy's avatar
Jim Blandy committed
173 174 175 176 177 178 179 180 181 182 183 184
  (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
185 186 187 188 189
  ;;! 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
190

Jim Blandy's avatar
Jim Blandy committed
191 192
  ;; Read window system's init file if using a window system.
  (if (and window-system (not noninteractive))
Jim Blandy's avatar
Jim Blandy committed
193 194 195 196 197 198
      (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))
Jim Blandy's avatar
Jim Blandy committed
199

Jim Blandy's avatar
Jim Blandy committed
200 201 202
  (let ((done nil)
	(args (cdr command-line-args)))

Jim Blandy's avatar
Jim Blandy committed
203 204 205 206 207 208
    ;; 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
209 210 211 212

    ;; 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
213 214 215 216 217 218 219 220 221 222 223 224
    (while (and (not done) args)
      (let ((argi (car args)))
	(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"))
	  (setq args (cdr args)
		init-file-user (car args)
		args (cdr args)))
225 226 227
	 ((string-equal argi "-no-site-file")
	  (setq site-run-file nil
		args (cdr args)))
Jim Blandy's avatar
Jim Blandy committed
228 229 230
	 ((string-equal argi "-debug-init")
	  (setq init-file-debug t
		args (cdr args)))
Jim Blandy's avatar
Jim Blandy committed
231 232 233 234
	 (t (setq done t)))))
    
    ;; Re-attach the program name to the front of the arg list.
    (setcdr command-line-args args))
Jim Blandy's avatar
Jim Blandy committed
235

236
  ;; Under X Windows, this creates the X frame and deletes the terminal frame.
237 238 239 240
  (if (fboundp 'frame-initialize)
      (frame-initialize))
  (if (fboundp 'face-initialize)
      (face-initialize))
241

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

Roland McGrath's avatar
Roland McGrath committed
244 245 246
  ;; 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.
247 248
  (if site-run-file 
      (load site-run-file t t))
Roland McGrath's avatar
Roland McGrath committed
249

250 251 252 253
  ;; Sites should not disable this.  Only individuals should disable
  ;; the startup message.
  (setq inhibit-startup-message nil)

Jim Blandy's avatar
Jim Blandy committed
254
  ;; Load that user's init file, or the default one, or none.
255 256 257 258 259 260 261 262 263 264
  (let (debug-on-error-from-init-file
	debug-on-error-should-be-set
	(debug-on-error-initial
	 (if (eq init-file-debug t) 'startup init-file-debug)))
    (let ((debug-on-error debug-on-error-initial)
	  ;; This function actually reads the init files.
	  (inner
	   (function
	    (lambda ()
	      (if init-file-user
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
		  (progn
		    (setq user-init-file 
			  (cond 
			   ((eq system-type 'ms-dos)
			    (concat "~" init-file-user "/_emacs"))
			   ((eq system-type 'vax-vms) 
			    "sys$login:.emacs")
			   (t 
			    (concat "~" init-file-user "/.emacs"))))
		    (load user-init-file t t t)
		    (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)))))))))
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
      (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))
	  (error (message "Error in init file: %s%s%s"
			  (get (car error) 'error-message)
			  (if (cdr error) ": ")
			  (mapconcat 'prin1-to-string (cdr error) ", "))
		 (setq init-file-had-error t))))
      ;; If we can tell that the init file altered debug-on-error.,
      ;; 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
	(setq debug-on-error debug-on-error-from-init-file)))
Jim Blandy's avatar
Jim Blandy committed
301

Roland McGrath's avatar
Roland McGrath committed
302 303
  (run-hooks 'after-init-hook)

Jim Blandy's avatar
Jim Blandy committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
  ;; 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))))
  ;; 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
322
  ;; Process the remaining args.
Jim Blandy's avatar
Jim Blandy committed
323 324 325 326 327 328
  (command-line-1 (cdr command-line-args))

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

(defun command-line-1 (command-line-args-left)
329
  (or noninteractive (input-pending-p) init-file-had-error
330 331
      (if (eq (key-binding "\C-h\C-p") 'describe-project)
	  (message "For more about the GNU Project, of which GNU Emacs is part, type C-h C-p.")))
Jim Blandy's avatar
Jim Blandy committed
332 333 334 335 336 337 338 339 340 341 342 343 344
  (if (null command-line-args-left)
      (cond ((and (not inhibit-startup-message) (not noninteractive)
		  ;; Don't clobber a non-scratch buffer if init file
		  ;; has selected it.
		  (string= (buffer-name) "*scratch*")
		  (not (input-pending-p)))
	     ;; If there are no switches to process, we might as well
	     ;; run this hook now, and there may be some need to do it
	     ;; before doing any output.
	     (and term-setup-hook
		  (run-hooks 'term-setup-hook))
	     ;; Don't let the hook be run twice.
	     (setq term-setup-hook nil)
345 346 347 348 349 350 351 352

	     ;; It's important to notice the user settings before we
	     ;; display the startup message; otherwise, the settings
	     ;; won't take effect until the user gives the first
	     ;; keystroke, and that's distracting.
	     (if (fboundp 'frame-notice-user-settings)
		 (frame-notice-user-settings))

Jim Blandy's avatar
Jim Blandy committed
353 354 355 356 357 358 359
	     (and window-setup-hook
		  (run-hooks 'window-setup-hook))
	     (setq window-setup-hook nil)
	     (unwind-protect
		 (progn
		   (insert (emacs-version)
			   "
360
Copyright (C) 1993 Free Software Foundation, Inc.\n\n")
Jim Blandy's avatar
Jim Blandy committed
361 362 363 364 365 366 367 368 369 370 371 372 373
		   ;; If keys have their default meanings,
		   ;; use precomputed string to save lots of time.
		   (if (and (eq (key-binding "\C-h") 'help-command)
			    (eq (key-binding "\C-xu") 'advertised-undo)
			    (eq (key-binding "\C-x\C-c") 'save-buffers-kill-emacs)
			    (eq (key-binding "\C-h\C-c") 'describe-copying)
			    (eq (key-binding "\C-h\C-d") 'describe-distribution)
			    (eq (key-binding "\C-h\C-w") 'describe-no-warranty)
			    (eq (key-binding "\C-ht") 'help-with-tutorial))
		       (insert 
       "Type C-h for help; C-x u to undo changes.  (`C-' means use CTRL key.)
To kill the Emacs job, type C-x C-c.
Type C-h t for a tutorial on using Emacs.
Richard M. Stallman's avatar
Richard M. Stallman committed
374
Type C-h i to enter Info, which you can use to read GNU documentation.
Jim Blandy's avatar
Jim Blandy committed
375 376 377 378 379 380 381 382

GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for full details.
You may give out copies of Emacs; type C-h C-c to see the conditions.
Type C-h C-d for information on getting the latest version.")
		     (insert (substitute-command-keys
       "Type \\[help-command] for help; \\[advertised-undo] to undo changes.  (`C-' means use CTRL key.)
To kill the Emacs job, type \\[save-buffers-kill-emacs].
Type \\[help-with-tutorial] for a tutorial on using Emacs.
Richard M. Stallman's avatar
Richard M. Stallman committed
383
Type \\[info] to enter Info, which you can use to read GNU documentation.
Jim Blandy's avatar
Jim Blandy committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for full details.
You may give out copies of Emacs; type \\[describe-copying] to see the conditions.
Type \\[describe-distribution] for information on getting the latest version.")))
		   (set-buffer-modified-p nil)
		   (sit-for 120))
	       (save-excursion
		 ;; In case the Emacs server has already selected
		 ;; another buffer, erase the one our message is in.
		 (set-buffer (get-buffer "*scratch*"))
		 (erase-buffer)
		 (set-buffer-modified-p nil)))))
    (let ((dir default-directory)
	  (file-count 0)
	  first-file-buffer
	  (line 0))
      (while command-line-args-left
	(let ((argi (car command-line-args-left))
	      tem)
	  (setq command-line-args-left (cdr command-line-args-left))
	  (cond ((setq tem (assoc argi command-switch-alist))
		 (funcall (cdr tem) argi))
		((or (string-equal argi "-f")  ;what the manual claims
		     (string-equal argi "-funcall")
		     (string-equal argi "-e")) ; what the source used to say
		 (setq tem (intern (car command-line-args-left)))
		 (setq command-line-args-left (cdr command-line-args-left))
		 (funcall tem))
		((or (string-equal argi "-l")
		     (string-equal argi "-load"))
		 (let ((file (car command-line-args-left)))
		   ;; Take file from default dir if it exists there;
		   ;; otherwise let `load' search for it.
		   (if (file-exists-p (expand-file-name file))
		       (setq file (expand-file-name file)))
		   (load file nil t))
		 (setq command-line-args-left (cdr command-line-args-left)))
421
		((string-equal argi "-insert")
Jim Blandy's avatar
Jim Blandy committed
422
		 (or (stringp (car command-line-args-left))
423
		     (error "filename omitted from `-insert' option"))
Jim Blandy's avatar
Jim Blandy committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
		 (insert-file-contents (car command-line-args-left))
		 (setq command-line-args-left (cdr command-line-args-left)))
		((string-equal argi "-kill")
		 (kill-emacs t))
		((string-match "^\\+[0-9]+\\'" argi)
		 (setq line (string-to-int argi)))
		(t
		 ;; We have almost exhausted our options. See if the
		 ;; user has made any other command-line options available
		 (let ((hooks command-line-functions);; lrs 7/31/89
		       (did-hook nil))
		   (while (and hooks
			       (not (setq did-hook (funcall (car hooks)))))
		     (setq hooks (cdr hooks)))
		   (if (not did-hook)
		       ;; Ok, presume that the argument is a file name
		       (progn
			 (setq file-count (1+ file-count))
			 (cond ((= file-count 1)
				(setq first-file-buffer
				      (find-file (expand-file-name argi dir))))
			       (t
				(find-file-other-window (expand-file-name argi dir))))
			 (or (zerop line)
			     (goto-line line))
			 (setq line 0))))))))
      ;; If 3 or more files visited, and not all visible,
      ;; show user what they all are.
      (if (> file-count 2)
	  (or (get-buffer-window first-file-buffer)
454
	      (progn (other-window 1)
455
		     (buffer-menu)))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
456 457

;;; startup.el ends here