(indent-for-tab-command): Doc fix.
[bpt/emacs.git] / lisp / startup.el
1 ;;; startup.el --- process Emacs shell arguments
2
3 ;; Copyright (C) 1985, 86, 92, 94, 95, 96, 97, 1998, 1999 Free Software Foundation, Inc.
4
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7
8 ;; This file is part of GNU Emacs.
9
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.
14
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.
19
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.
24
25 ;;; Commentary:
26
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.
32
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
45 ;;
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
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.
81 ;; --icon-type ICONTYPE This option is passed on to term/x-win.el
82 ;;
83 ;; -iconic Start Emacs iconified.
84 ;; --iconic This option is passed on to term/x-win.el
85 ;; -------------------------
86 ;; Various X 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.
91 ;; -visit FILE
92 ;; --visit FILE
93 ;; -file FILE
94 ;; --file FILE
95 ;;
96 ;; -L DIRNAME Add DIRNAME to load-path
97 ;; -directory DIRNAME
98 ;; --directory DIRNAME
99 ;;
100 ;; -l FILE Load and execute the Emacs lisp code
101 ;; -load FILE in FILE.
102 ;; --load FILE
103 ;;
104 ;; -f FUNC Execute Emacs lisp function FUNC with
105 ;; -funcall FUNC no arguments. The "-e" form is outdated
106 ;; --funcall FUNC and should not be used. (It's a typo
107 ;; -e FUNC promoted to a feature.)
108 ;;
109 ;; -eval FORM Execute Emacs lisp form FORM.
110 ;; --eval FORM
111 ;; -execute EXPR
112 ;; --execute EXPR
113 ;;
114 ;; -insert FILE Insert the contents of FILE into buffer.
115 ;; --insert FILE
116 ;; -------------------------
117 ;; -kill Kill (exit) Emacs right away.
118 ;; --kill
119 ;; -------------------------
120
121 ;;; Code:
122
123 (setq top-level '(normal-top-level))
124
125 (defvar command-line-processed nil
126 "Non-nil once command line has been processed")
127
128 (defgroup initialization nil
129 "Emacs start-up procedure"
130 :group 'internal)
131
132 (defcustom inhibit-startup-message nil
133 "*Non-nil inhibits the initial startup message.
134 This is for use in your personal init file, once you are familiar
135 with the contents of the startup message."
136 :type 'boolean
137 :group 'initialization)
138
139 (defcustom inhibit-startup-echo-area-message nil
140 "*Non-nil inhibits the initial startup echo area message.
141 Setting this variable takes effect
142 only if you do it with the customization buffer
143 or if your `.emacs' file contains a line of this form:
144 (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\")
145 If your `.emacs' file is byte-compiled, use the following form instead:
146 (eval '(setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\"))
147 Thus, someone else using a copy of your `.emacs' file will see
148 the startup message unless he personally acts to inhibit it."
149 :type '(choice (const :tag "Don't inhibit")
150 (string :tag "Enter your user name, to inhibit"))
151 :group 'initialization)
152
153 (defcustom inhibit-default-init nil
154 "*Non-nil inhibits loading the `default' library."
155 :type 'boolean
156 :group 'initialization)
157
158 (defvar command-switch-alist nil
159 "Alist of command-line switches.
160 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
161 HANDLER-FUNCTION receives switch name as sole arg;
162 remaining command-line args are in the variable `command-line-args-left'.")
163
164 (defvar command-line-args-left nil
165 "List of command-line args not yet processed.")
166
167 (defvar command-line-functions nil ;; lrs 7/31/89
168 "List of functions to process unrecognized command-line arguments.
169 Each function should access the dynamically bound variables
170 `argi' (the current argument) and `command-line-args-left' (the remaining
171 arguments). The function should return non-nil only if it recognizes and
172 processes `argi'. If it does so, it may consume successive arguments by
173 altering `command-line-args-left' to remove them.")
174
175 (defvar command-line-default-directory nil
176 "Default directory to use for command line arguments.
177 This is normally copied from `default-directory' when Emacs starts.")
178
179 ;;; This is here, rather than in x-win.el, so that we can ignore these
180 ;;; options when we are not using X.
181 (defconst command-line-x-option-alist
182 '(("-bw" 1 x-handle-numeric-switch border-width)
183 ("-d" 1 x-handle-display)
184 ("-display" 1 x-handle-display)
185 ("-name" 1 x-handle-name-switch)
186 ("-title" 1 x-handle-switch title)
187 ("-T" 1 x-handle-switch title)
188 ("-r" 0 x-handle-switch reverse t)
189 ("-rv" 0 x-handle-switch reverse t)
190 ("-reverse" 0 x-handle-switch reverse t)
191 ("-reverse-video" 0 x-handle-switch reverse t)
192 ("-fn" 1 x-handle-switch font)
193 ("-font" 1 x-handle-switch font)
194 ("-ib" 1 x-handle-numeric-switch internal-border-width)
195 ("-g" 1 x-handle-geometry)
196 ("-lsp" 1 x-handle-numeric-switch line-spacing)
197 ("-geometry" 1 x-handle-geometry)
198 ("-fg" 1 x-handle-switch foreground-color)
199 ("-foreground" 1 x-handle-switch foreground-color)
200 ("-bg" 1 x-handle-switch background-color)
201 ("-background" 1 x-handle-switch background-color)
202 ("-ms" 1 x-handle-switch mouse-color)
203 ("-itype" 0 x-handle-switch icon-type t)
204 ("-i" 0 x-handle-switch icon-type t)
205 ("-iconic" 0 x-handle-iconic)
206 ("-xrm" 1 x-handle-xrm-switch)
207 ("-cr" 1 x-handle-switch cursor-color)
208 ("-vb" 0 x-handle-switch vertical-scroll-bars t)
209 ("-hb" 0 x-handle-switch horizontal-scroll-bars t)
210 ("-bd" 1 x-handle-switch)
211 ("--border-width" 1 x-handle-numeric-switch border-width)
212 ("--display" 1 x-handle-display)
213 ("--name" 1 x-handle-name-switch)
214 ("--title" 1 x-handle-switch title)
215 ("--reverse-video" 0 x-handle-switch reverse t)
216 ("--font" 1 x-handle-switch font)
217 ("--internal-border" 1 x-handle-numeric-switch internal-border-width)
218 ("--geometry" 1 x-handle-geometry)
219 ("--foreground-color" 1 x-handle-switch foreground-color)
220 ("--background-color" 1 x-handle-switch background-color)
221 ("--mouse-color" 1 x-handle-switch mouse-color)
222 ("--icon-type" 0 x-handle-switch icon-type t)
223 ("--iconic" 0 x-handle-iconic)
224 ("--xrm" 1 x-handle-xrm-switch)
225 ("--cursor-color" 1 x-handle-switch cursor-color)
226 ("--vertical-scroll-bars" 0 x-handle-switch vertical-scroll-bars t)
227 ("--line-spacing" 1 x-handle-numeric-switch line-spacing)
228 ("--border-color" 1 x-handle-switch border-width))
229 "Alist of X Windows options.
230 Each element has the form
231 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
232 where NAME is the option name string, NUMARGS is the number of arguments
233 that the option accepts, HANDLER is a function to call to handle the option.
234 FRAME-PARAM (optional) is the frame parameter this option specifies,
235 and VALUE is the value which is given to that frame parameter
236 \(most options use the argument for this, so VALUE is not present).")
237
238 (defvar before-init-hook nil
239 "Normal hook run after handling urgent options but before loading init files.")
240
241 (defvar after-init-hook nil
242 "Normal hook run after loading the init files, `~/.emacs' and `default.el'.
243 There is no `condition-case' around the running of these functions;
244 therefore, if you set `debug-on-error' non-nil in `.emacs',
245 an error in one of these functions will invoke the debugger.")
246
247 (defvar emacs-startup-hook nil
248 "Normal hook run after loading init files and handling the command line.")
249
250 (defvar term-setup-hook nil
251 "Normal hook run after loading terminal-specific Lisp code.
252 It also follows `emacs-startup-hook'. This hook exists for users to set,
253 so as to override the definitions made by the terminal-specific file.
254 Emacs never sets this variable itself.")
255
256 (defvar keyboard-type nil
257 "The brand of keyboard you are using.
258 This variable is used to define
259 the proper function and keypad keys for use under X. It is used in a
260 fashion analogous to the environment variable TERM.")
261
262 (defvar window-setup-hook nil
263 "Normal hook run to initialize window system display.
264 Emacs runs this hook after processing the command line arguments and loading
265 the user's init file.")
266
267 (defcustom initial-major-mode 'lisp-interaction-mode
268 "Major mode command symbol to use for the initial *scratch* buffer."
269 :type 'function
270 :group 'initialization)
271
272 (defcustom init-file-user nil
273 "Identity of user whose `.emacs' file is or was read.
274 The value is nil if `-q' or `--no-init-file' was specified,
275 meaning do not load any init file.
276
277 Otherwise, the value may be the null string, meaning use the init file
278 for the user that originally logged in, or it may be a
279 string containing a user's name meaning use that person's init file.
280
281 In either of the latter cases, `(concat \"~\" init-file-user \"/\")'
282 evaluates to the name of the directory where the `.emacs' file was
283 looked for.
284
285 Setting `init-file-user' does not prevent Emacs from loading
286 `site-start.el'. The only way to do that is to use `--no-site-file'."
287 :type '(choice (const :tag "none" nil) string)
288 :group 'initialization)
289
290 (defcustom site-run-file "site-start"
291 "File containing site-wide run-time initializations.
292 This file is loaded at run-time before `~/.emacs'. It contains inits
293 that need to be in place for the entire site, but which, due to their
294 higher incidence of change, don't make sense to load into emacs'
295 dumped image. Thus, the run-time load order is: 1. file described in
296 this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.
297
298 Don't use the `site-start.el' file for things some users may not like.
299 Put them in `default.el' instead, so that users can more easily
300 override them. Users can prevent loading `default.el' with the `-q'
301 option or by setting `inhibit-default-init' in their own init files,
302 but inhibiting `site-start.el' requires `--no-site-file', which
303 is less convenient."
304 :type '(choice (const :tag "none" nil) string)
305 :group 'initialization)
306
307 (defcustom mail-host-address nil
308 "*Name of this machine, for purposes of naming users."
309 :type '(choice (const nil) string)
310 :group 'mail)
311
312 (defcustom user-mail-address nil
313 "*Full mailing address of this user.
314 This is initialized based on `mail-host-address',
315 after your init file is read, in case it sets `mail-host-address'."
316 :type 'string
317 :group 'mail)
318
319 (defcustom auto-save-list-file-prefix
320 (cond ((eq system-type 'ms-dos)
321 ;; MS-DOS cannot have initial dot, and allows only 8.3 names
322 "~/_emacs.d/auto-save.list/_s")
323 (t
324 "~/.emacs.d/auto-save-list/.saves-"))
325 "Prefix for generating `auto-save-list-file-name'.
326 This is used after reading your `.emacs' file to initialize
327 `auto-save-list-file-name', by appending Emacs's pid and the system name,
328 if you have not already set `auto-save-list-file-name' yourself.
329 Directories in the prefix will be created if necessary.
330 Set this to nil if you want to prevent `auto-save-list-file-name'
331 from being initialized."
332 :type '(choice (const :tag "Don't record a session's auto save list" nil)
333 string)
334 :group 'auto-save)
335
336 (defvar init-file-debug nil)
337
338 (defvar init-file-had-error nil)
339
340 (defvar normal-top-level-add-subdirs-inode-list nil)
341
342 (defun normal-top-level-add-subdirs-to-load-path ()
343 "Add all subdirectories of current directory to `load-path'.
344 More precisely, this uses only the subdirectories whose names
345 start with letters or digits; it excludes any subdirectory named `RCS'
346 or `CVS', and any subdirectory that contains a file named `.nosearch'."
347 (let (dirs
348 attrs
349 (pending (list default-directory)))
350 ;; This loop does a breadth-first tree walk on DIR's subtree,
351 ;; putting each subdir into DIRS as its contents are examined.
352 (while pending
353 (setq dirs (cons (car pending) dirs))
354 (setq pending (cdr pending))
355 (setq attrs (nthcdr 10 (file-attributes (car dirs))))
356 (let ((contents (directory-files (car dirs)))
357 (default-directory (car dirs)))
358 (unless (member attrs normal-top-level-add-subdirs-inode-list)
359 (setq normal-top-level-add-subdirs-inode-list
360 (cons attrs normal-top-level-add-subdirs-inode-list))
361 (while contents
362 (unless (member (car contents) '("." ".." "RCS" "CVS"))
363 (when (and (string-match "\\`[a-zA-Z0-9]" (car contents))
364 ;; Avoid doing a `stat' when it isn't necessary
365 ;; because that can cause trouble when an NFS server
366 ;; is down.
367 (not (string-match "\\.elc?\\'" (car contents)))
368 (file-directory-p (car contents)))
369 (let ((expanded (expand-file-name (car contents))))
370 (unless (file-exists-p (expand-file-name ".nosearch"
371 expanded))
372 (setq pending (nconc pending (list expanded)))))))
373 (setq contents (cdr contents))))))
374 (normal-top-level-add-to-load-path (cdr (nreverse dirs)))))
375
376 ;; This function is called from a subdirs.el file.
377 ;; It assumes that default-directory is the directory
378 ;; in which the subdirs.el file exists,
379 ;; and it adds to load-path the subdirs of that directory
380 ;; as specified in DIRS. Normally the elements of DIRS are relative.
381 (defun normal-top-level-add-to-load-path (dirs)
382 (let ((tail load-path)
383 (thisdir (directory-file-name default-directory)))
384 (while (and tail
385 ;;Don't go all the way to the nil terminator.
386 (cdr tail)
387 (not (equal thisdir (car tail)))
388 (not (and (memq system-type '(ms-dos windows-nt))
389 (equal (downcase thisdir) (downcase (car tail))))))
390 (setq tail (cdr tail)))
391 ;;Splice the new section in.
392 (when tail
393 (setcdr tail (append (mapcar 'expand-file-name dirs) (cdr tail))))))
394
395 (defun normal-top-level ()
396 (if command-line-processed
397 (message "Back to top level.")
398 (setq command-line-processed t)
399 ;; Give *Messages* the same default-directory as *scratch*,
400 ;; just to keep things predictable.
401 (let ((dir default-directory))
402 (save-excursion
403 (set-buffer (get-buffer "*Messages*"))
404 (setq default-directory dir)))
405 ;; For root, preserve owner and group when editing files.
406 (if (equal (user-uid) 0)
407 (setq backup-by-copying-when-mismatch t))
408 ;; Look in each dir in load-path for a subdirs.el file.
409 ;; If we find one, load it, which will add the appropriate subdirs
410 ;; of that dir into load-path,
411 (let ((tail load-path)
412 new)
413 (while tail
414 (setq new (cons (car tail) new))
415 (condition-case nil
416 (let ((default-directory (car tail)))
417 (load (expand-file-name "subdirs.el" (car tail)) t t t)))
418 (setq tail (cdr tail))))
419 (if (not (eq system-type 'vax-vms))
420 (progn
421 ;; If the PWD environment variable isn't accurate, delete it.
422 (let ((pwd (getenv "PWD")))
423 (and (stringp pwd)
424 ;; Use FOO/., so that if FOO is a symlink, file-attributes
425 ;; describes the directory linked to, not FOO itself.
426 (or (equal (file-attributes
427 (concat (file-name-as-directory pwd) "."))
428 (file-attributes
429 (concat (file-name-as-directory default-directory)
430 ".")))
431 (setq process-environment
432 (delete (concat "PWD=" pwd)
433 process-environment)))))))
434 (setq default-directory (abbreviate-file-name default-directory))
435 (let ((menubar-bindings-done nil))
436 (unwind-protect
437 (command-line)
438 ;; Do this again, in case .emacs defined more abbreviations.
439 (setq default-directory (abbreviate-file-name default-directory))
440 ;; Specify the file for recording all the auto save files of this session.
441 ;; This is used by recover-session.
442 (or auto-save-list-file-name
443 (and auto-save-list-file-prefix
444 (setq auto-save-list-file-name
445 ;; Under MS-DOS our PID is almost always reused between
446 ;; Emacs invocations. We need something more unique.
447 (cond ((eq system-type 'ms-dos)
448 ;; We are going to access the auto-save
449 ;; directory, so make sure it exists.
450 (make-directory
451 (file-name-directory auto-save-list-file-prefix)
452 t)
453 (concat
454 (make-temp-name
455 (expand-file-name
456 auto-save-list-file-prefix))
457 "~"))
458 (t
459 (expand-file-name
460 (format "%s%d-%s~"
461 auto-save-list-file-prefix
462 (emacs-pid)
463 (system-name))))))))
464 (run-hooks 'emacs-startup-hook)
465 (and term-setup-hook
466 (run-hooks 'term-setup-hook))
467 ;; Modify the initial frame based on what .emacs puts into
468 ;; ...-frame-alist.
469 (if (fboundp 'frame-notice-user-settings)
470 (frame-notice-user-settings))
471 ;; Now we know the user's default font, so add it to the menu.
472 (if (fboundp 'font-menu-add-default)
473 (font-menu-add-default))
474 (and window-setup-hook
475 (run-hooks 'window-setup-hook))
476 (or menubar-bindings-done
477 (if (memq window-system '(x w32))
478 (precompute-menubar-bindings)))))))
479
480 ;; Precompute the keyboard equivalents in the menu bar items.
481 (defun precompute-menubar-bindings ()
482 (let ((submap (lookup-key global-map [menu-bar])))
483 (while submap
484 (and (consp (car submap))
485 (symbolp (car (car submap)))
486 (stringp (car-safe (cdr (car submap))))
487 (keymapp (cdr (cdr (car submap))))
488 (progn
489 (x-popup-menu nil (cdr (cdr (car submap))))
490 (if purify-flag
491 (garbage-collect))))
492 (setq submap (cdr submap))))
493 (setq define-key-rebound-commands t))
494
495 (defun command-line ()
496 (setq command-line-default-directory default-directory)
497
498 ;; Choose a reasonable location for temporary files.
499 (setq temporary-file-directory
500 (file-name-as-directory
501 (cond ((memq system-type '(ms-dos windows-nt))
502 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
503 ((memq system-type '(vax-vms axp-vms))
504 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
505 (t
506 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp")))))
507 (setq small-temporary-file-directory
508 (if (eq system-type 'ms-dos)
509 (getenv "TMPDIR")))
510
511 ;; See if we should import version-control from the environment variable.
512 (let ((vc (getenv "VERSION_CONTROL")))
513 (cond ((eq vc nil)) ;don't do anything if not set
514 ((or (string= vc "t")
515 (string= vc "numbered"))
516 (setq version-control t))
517 ((or (string= vc "nil")
518 (string= vc "existing"))
519 (setq version-control nil))
520 ((or (string= vc "never")
521 (string= vc "simple"))
522 (setq version-control 'never))))
523
524 (set-locale-environment nil)
525
526 ;;! This has been commented out; I currently find the behavior when
527 ;;! split-window-keep-point is nil disturbing, but if I can get used
528 ;;! to it, then it would be better to eliminate the option.
529 ;;! ;; Choose a good default value for split-window-keep-point.
530 ;;! (setq split-window-keep-point (> baud-rate 2400))
531
532 ;; Set the default strings to display in mode line for
533 ;; end-of-line formats that aren't native to this platform.
534 (cond
535 ((memq system-type '(ms-dos windows-nt emx))
536 (setq eol-mnemonic-unix "(Unix)")
537 (setq eol-mnemonic-mac "(Mac)"))
538 ;; Mac-specific settings should come here, once there's a
539 ;; system-type symbol specific to MacOS.
540 (t ; this is for Unix/GNU/Linux systems
541 (setq eol-mnemonic-dos "(DOS)")
542 (setq eol-mnemonic-mac "(Mac)")))
543
544 ;; Read window system's init file if using a window system.
545 (condition-case error
546 (if (and window-system (not noninteractive))
547 (load (concat term-file-prefix
548 (symbol-name window-system)
549 "-win")
550 ;; Every window system should have a startup file;
551 ;; barf if we can't find it.
552 nil t))
553 ;; If we can't read it, print the error message and exit.
554 (error
555 (princ
556 (if (eq (car error) 'error)
557 (apply 'concat (cdr error))
558 (if (memq 'file-error (get (car error) 'error-conditions))
559 (format "%s: %s"
560 (nth 1 error)
561 (mapconcat (lambda (obj) (prin1-to-string obj t))
562 (cdr (cdr error)) ", "))
563 (format "%s: %s"
564 (get (car error) 'error-message)
565 (mapconcat (lambda (obj) (prin1-to-string obj t))
566 (cdr error) ", "))))
567 'external-debugging-output)
568 (setq window-system nil)
569 (kill-emacs)))
570
571 (let ((done nil)
572 (args (cdr command-line-args)))
573
574 ;; Figure out which user's init file to load,
575 ;; either from the environment or from the options.
576 (setq init-file-user (if noninteractive nil (user-login-name)))
577 ;; If user has not done su, use current $HOME to find .emacs.
578 (and init-file-user (string= init-file-user (user-real-login-name))
579 (setq init-file-user ""))
580
581 ;; Process the command-line args, and delete the arguments
582 ;; processed. This is consistent with the way main in emacs.c
583 ;; does things.
584 (while (and (not done) args)
585 (let ((longopts '(("--no-init-file") ("--no-site-file") ("--user")
586 ("--debug-init") ("--iconic") ("--icon-type")))
587 (argi (car args))
588 (argval nil))
589 ;; Handle --OPTION=VALUE format.
590 (if (and (string-match "\\`--" argi)
591 (string-match "=" argi))
592 (setq argval (substring argi (match-end 0))
593 argi (substring argi 0 (match-beginning 0))))
594 (or (equal argi "--")
595 (let ((completion (try-completion argi longopts)))
596 (if (eq completion t)
597 (setq argi (substring argi 1))
598 (if (stringp completion)
599 (let ((elt (assoc completion longopts)))
600 (or elt
601 (error "Option `%s' is ambiguous" argi))
602 (setq argi (substring (car elt) 1)))
603 (setq argval nil)))))
604 (cond
605 ((or (string-equal argi "-q")
606 (string-equal argi "-no-init-file"))
607 (setq init-file-user nil
608 args (cdr args)))
609 ((or (string-equal argi "-u")
610 (string-equal argi "-user"))
611 (or argval
612 (setq args (cdr args)
613 argval (car args)))
614 (setq init-file-user argval
615 argval nil
616 args (cdr args)))
617 ((string-equal argi "-no-site-file")
618 (setq site-run-file nil
619 args (cdr args)))
620 ((string-equal argi "-debug-init")
621 (setq init-file-debug t
622 args (cdr args)))
623 ((string-equal argi "-iconic")
624 (setq initial-frame-alist
625 (cons '(visibility . icon) initial-frame-alist))
626 (setq args (cdr args)))
627 ((or (string-equal argi "-icon-type")
628 (string-equal argi "-i")
629 (string-equal argi "-itype"))
630 (setq default-frame-alist
631 (cons '(icon-type . t) default-frame-alist))
632 (setq args (cdr args)))
633 (t (setq done t)))
634 ;; Was argval set but not used?
635 (and argval
636 (error "Option `%s' doesn't allow an argument" argi))))
637
638 ;; Re-attach the program name to the front of the arg list.
639 (and command-line-args (setcdr command-line-args args)))
640
641 ;; Under X Windows, this creates the X frame and deletes the terminal frame.
642 (if (fboundp 'frame-initialize)
643 (frame-initialize))
644 ;; If frame was created with a menu bar, set menu-bar-mode on.
645 (if (and (not noninteractive)
646 (or (not (memq window-system '(x w32)))
647 (> (cdr (assq 'menu-bar-lines (frame-parameters))) 0)))
648 (menu-bar-mode t))
649
650 ;; Can't do this init in defcustom because window-system isn't set.
651 (when (and (not noninteractive)
652 (not (eq system-type 'ms-dos))
653 (memq window-system '(x w32)))
654 (setq-default blink-cursor t)
655 (blink-cursor-mode 1))
656
657 (run-hooks 'before-init-hook)
658
659 ;; Run the site-start library if it exists. The point of this file is
660 ;; that it is run before .emacs. There is no point in doing this after
661 ;; .emacs; that is useless.
662 (if site-run-file
663 (load site-run-file t t))
664
665 ;; Register available input methods by loading LEIM list file.
666 (load "leim-list.el" 'noerror 'nomessage 'nosuffix)
667
668 ;; Sites should not disable this. Only individuals should disable
669 ;; the startup message.
670 (setq inhibit-startup-message nil)
671
672 ;; Load that user's init file, or the default one, or none.
673 (let (debug-on-error-from-init-file
674 debug-on-error-should-be-set
675 (debug-on-error-initial
676 (if (eq init-file-debug t) 'startup init-file-debug))
677 (orig-enable-multibyte default-enable-multibyte-characters))
678 (let ((debug-on-error debug-on-error-initial)
679 ;; This function actually reads the init files.
680 (inner
681 (function
682 (lambda ()
683 (if init-file-user
684 (let ((user-init-file-1
685 (cond
686 ((eq system-type 'ms-dos)
687 (concat "~" init-file-user "/_emacs"))
688 ((eq system-type 'windows-nt)
689 (if (directory-files "~" nil "^\\.emacs\\(\\.elc?\\)?$")
690 "~/.emacs"
691 "~/_emacs"))
692 ((eq system-type 'vax-vms)
693 "sys$login:.emacs")
694 (t
695 (concat "~" init-file-user "/.emacs")))))
696 ;; This tells `load' to store the file name found
697 ;; into user-init-file.
698 (setq user-init-file t)
699 (load user-init-file-1 t t)
700 ;; If we did not find the user's init file,
701 ;; set user-init-file conclusively to nil;
702 ;; don't let it be set from default.el.
703 (if (eq user-init-file t)
704 (setq user-init-file nil))
705 ;; If we loaded a compiled file, set
706 ;; `user-init-file' to the source version if that
707 ;; exists.
708 (when (and user-init-file
709 (equal (file-name-extension user-init-file)
710 "elc")
711 (file-exists-p user-init-file-1))
712 (when (file-newer-than-file-p
713 user-init-file-1 user-init-file)
714 (message "Warning: %s is newer than %s"
715 user-init-file-1 user-init-file)
716 (sit-for 1))
717 (setq user-init-file user-init-file-1))
718 (or inhibit-default-init
719 (let ((inhibit-startup-message nil))
720 ;; Users are supposed to be told their rights.
721 ;; (Plus how to get help and how to undo.)
722 ;; Don't you dare turn this off for anyone
723 ;; except yourself.
724 (load "default" t t)))))))))
725 (if init-file-debug
726 ;; Do this without a condition-case if the user wants to debug.
727 (funcall inner)
728 (condition-case error
729 (progn
730 (funcall inner)
731 (setq init-file-had-error nil))
732 (error (message "Error in init file: %s%s%s"
733 (get (car error) 'error-message)
734 (if (cdr error) ": " "")
735 (mapconcat 'prin1-to-string (cdr error) ", "))
736 (setq init-file-had-error t))))
737 ;; If we can tell that the init file altered debug-on-error,
738 ;; arrange to preserve the value that it set up.
739 (or (eq debug-on-error debug-on-error-initial)
740 (setq debug-on-error-should-be-set t
741 debug-on-error-from-init-file debug-on-error)))
742 (if debug-on-error-should-be-set
743 (setq debug-on-error debug-on-error-from-init-file))
744 (unless (or default-enable-multibyte-characters
745 (eq orig-enable-multibyte default-enable-multibyte-characters))
746 ;; Init file changed to unibyte. Reset existing multibyte
747 ;; buffers (probably *scratch*, *Messages*, *Minibuff-0*).
748 ;; Arguably this should only be done if they're free of
749 ;; multibyte characters.
750 (mapcar (lambda (buffer)
751 (with-current-buffer buffer
752 (if enable-multibyte-characters
753 (set-buffer-multibyte nil))))
754 (buffer-list))
755 ;; Also re-set the language environment in case it was
756 ;; originally done before unibyte was set and is sensitive to
757 ;; unibyte (display table, terminal coding system &c).
758 (set-language-environment current-language-environment)))
759
760 ;; Do this here in case the init file sets mail-host-address.
761 (or user-mail-address
762 (setq user-mail-address (concat (user-login-name) "@"
763 (or mail-host-address
764 (system-name)))))
765
766 (run-hooks 'after-init-hook)
767
768 ;; If *scratch* exists and init file didn't change its mode, initialize it.
769 (if (get-buffer "*scratch*")
770 (save-excursion
771 (set-buffer "*scratch*")
772 (if (eq major-mode 'fundamental-mode)
773 (funcall initial-major-mode))))
774
775 ;; Register default TTY colors for the case the terminal hasn't a
776 ;; terminal init file.
777 (or (memq window-system '(x w32))
778 (not (tty-display-color-p))
779 (let* ((colors (cond ((eq window-system 'pc)
780 msdos-color-values)
781 ((eq system-type 'windows-nt)
782 w32-tty-standard-colors)
783 (t tty-standard-colors)))
784 (color (car colors)))
785 (while colors
786 (tty-color-define (car color) (cadr color) (cddr color))
787 (setq colors (cdr colors) color (car colors)))))
788
789 ;; Load library for our terminal type.
790 ;; User init file can set term-file-prefix to nil to prevent this.
791 (and term-file-prefix (not noninteractive) (not window-system)
792 (let ((term (getenv "TERM"))
793 hyphend)
794 (while (and term
795 (not (load (concat term-file-prefix term) t t)))
796 ;; Strip off last hyphen and what follows, then try again
797 (if (setq hyphend (string-match "[-_][^-_]+$" term))
798 (setq term (substring term 0 hyphend))
799 (setq term nil)))))
800
801 ;; Process the remaining args.
802 (command-line-1 (cdr command-line-args))
803
804 ;; If -batch, terminate after processing the command options.
805 (if noninteractive (kill-emacs t)))
806
807 (defcustom initial-scratch-message (purecopy "\
808 ;; This buffer is for notes you don't want to save, and for Lisp evaluation.
809 ;; If you want to create a file, visit that file with C-x C-f,
810 ;; then enter the text in that file's own buffer.
811
812 ")
813 "Initial message displayed in *scratch* buffer at startup.
814 If this is nil, no message will be displayed."
815 :type 'string)
816
817 (defun command-line-1 (command-line-args-left)
818 (or noninteractive (input-pending-p) init-file-had-error
819 (and inhibit-startup-echo-area-message
820 user-init-file
821 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
822 (equal inhibit-startup-echo-area-message
823 (if (string= init-file-user "")
824 (user-login-name)
825 init-file-user)))
826 ;; Wasn't set with custom; see if .emacs has a setq.
827 (let ((buffer (get-buffer-create " *temp*")))
828 (prog1
829 (condition-case nil
830 (save-excursion
831 (set-buffer buffer)
832 (insert-file-contents user-init-file)
833 (re-search-forward
834 (concat
835 "([ \t\n]*setq[ \t\n]+"
836 "inhibit-startup-echo-area-message[ \t\n]+"
837 (regexp-quote
838 (prin1-to-string
839 (if (string= init-file-user "")
840 (user-login-name)
841 init-file-user)))
842 "[ \t\n]*)")
843 nil t))
844 (error nil))
845 (kill-buffer buffer)))))
846 (message (if (eq (key-binding "\C-h\C-p") 'describe-project)
847 "For information about the GNU Project and its goals, type C-h C-p."
848 (substitute-command-keys
849 "For information about the GNU Project and its goals, type \\[describe-project]."))))
850 (if (null command-line-args-left)
851 (cond ((and (not inhibit-startup-message) (not noninteractive)
852 ;; Don't clobber a non-scratch buffer if init file
853 ;; has selected it.
854 (string= (buffer-name) "*scratch*"))
855 ;; If there are no switches to process, we might as well
856 ;; run this hook now, and there may be some need to do it
857 ;; before doing any output.
858 (and term-setup-hook
859 (run-hooks 'term-setup-hook))
860 ;; Don't let the hook be run twice.
861 (setq term-setup-hook nil)
862
863 ;; It's important to notice the user settings before we
864 ;; display the startup message; otherwise, the settings
865 ;; won't take effect until the user gives the first
866 ;; keystroke, and that's distracting.
867 (if (fboundp 'frame-notice-user-settings)
868 (frame-notice-user-settings))
869
870 (and window-setup-hook
871 (run-hooks 'window-setup-hook))
872 (setq window-setup-hook nil)
873 ;; Do this now to avoid an annoying delay if the user
874 ;; clicks the menu bar during the sit-for.
875 (when (memq window-system '(x w32))
876 (precompute-menubar-bindings))
877 (setq menubar-bindings-done t)
878 (when (= (buffer-size) 0)
879 (let ((buffer-undo-list t))
880 (unwind-protect
881 (when (not (input-pending-p))
882 (goto-char (point-max))
883 ;; The convention for this piece of code is that
884 ;; each piece of output starts with one or two newlines
885 ;; and does not end with any newlines.
886 (insert "Welcome to GNU Emacs")
887 (if (eq system-type 'gnu/linux)
888 (insert ", one component of a Linux-based GNU system."))
889 (insert "\n")
890 (if (assq 'display (frame-parameters))
891 (progn
892 (insert "\
893 The menu bar and scroll bar are sufficient for basic editing with the mouse.
894
895 Useful Files menu items:
896 Exit Emacs (or type Control-x followed by Control-c)
897 Recover Session recover files you were editing before a crash
898
899 Important Help menu items:
900 Emacs Tutorial Learn-by-doing tutorial for using Emacs efficiently.
901 Emacs FAQ Frequently asked questions and answers
902 \(Non)Warranty GNU Emacs comes with ABSOLUTELY NO WARRANTY
903 Copying Conditions Conditions for redistributing and changing Emacs.
904 Getting New Versions How to obtain the latest version of Emacs.
905 ")
906 (insert "\n\n" (emacs-version)
907 "
908 Copyright (C) 2000 Free Software Foundation, Inc."))
909 ;; If keys have their default meanings,
910 ;; use precomputed string to save lots of time.
911 (if (and (eq (key-binding "\C-h") 'help-command)
912 (eq (key-binding "\C-xu") 'advertised-undo)
913 (eq (key-binding "\C-x\C-c") 'save-buffers-kill-emacs)
914 (eq (key-binding "\C-ht") 'help-with-tutorial)
915 (eq (key-binding "\C-hi") 'info)
916 (eq (key-binding "\C-h\C-n") 'view-emacs-news))
917 (insert "
918 Get help C-h (Hold down CTRL and press h)
919 Undo changes C-x u Exit Emacs C-x C-c
920 Get a tutorial C-h t Use Info to read docs C-h i")
921 (insert (substitute-command-keys
922 (format "\n
923 Get help %s
924 Undo changes \\[advertised-undo]
925 Exit Emacs \\[save-buffers-kill-emacs]
926 Get a tutorial \\[help-with-tutorial]
927 Use Info to read docs \\[info]"
928 (let ((where (where-is-internal
929 'help-command nil t)))
930 (if where
931 (key-description where)
932 "M-x help"))))))
933 ;; Say how to use the menu bar
934 ;; if that is not with the mouse.
935 (if (and (eq (key-binding "\M-`") 'tmm-menubar)
936 (eq (key-binding [f10]) 'tmm-menubar))
937 (insert "
938 Activate menubar F10 or ESC ` or M-`")
939 (insert (substitute-command-keys "
940 Activate menubar \\[tmm-menubar]")))
941
942 ;; Windows and MSDOS (currently) do not count as
943 ;; window systems, but do have mouse support.
944 (if window-system
945 (insert "
946 Mode-specific menu C-mouse-3 (third button, with CTRL)"))
947 ;; Many users seem to have problems with these.
948 (insert "
949 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
950 If you have no Meta key, you may instead type ESC followed by the character.)")
951 (and auto-save-list-file-prefix
952 ;; Don't signal an error if the
953 ;; directory for auto-save-list files
954 ;; does not yet exist.
955 (file-directory-p (file-name-directory
956 auto-save-list-file-prefix))
957 (directory-files
958 (file-name-directory auto-save-list-file-prefix)
959 nil
960 (concat "\\`"
961 (regexp-quote (file-name-nondirectory
962 auto-save-list-file-prefix)))
963 t)
964 (insert "\n\nIf an Emacs session crashed recently, "
965 "type M-x recover-session RET\nto recover"
966 " the files you were editing."))
967
968 (insert "\n\n" (emacs-version)
969 "
970 Copyright (C) 2000 Free Software Foundation, Inc.")
971 (if (and (eq (key-binding "\C-h\C-c") 'describe-copying)
972 (eq (key-binding "\C-h\C-d") 'describe-distribution)
973 (eq (key-binding "\C-h\C-w") 'describe-no-warranty))
974 (insert
975 "\n
976 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for full details.
977 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
978 of Emacs and modify it; type C-h C-c to see the conditions.
979 Type C-h C-d for information on getting the latest version.")
980 (insert (substitute-command-keys
981 "\n
982 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for full details.
983 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
984 of Emacs and modify it; type \\[describe-copying] to see the conditions.
985 Type \\[describe-distribution] for information on getting the latest version."))))
986 (goto-char (point-min))
987
988 (set-buffer-modified-p nil)
989 (sit-for 120))
990 (with-current-buffer (get-buffer "*scratch*")
991 (erase-buffer)
992 (and initial-scratch-message
993 (insert initial-scratch-message))
994 (set-buffer-modified-p nil)))))))
995 ;; Delay 2 seconds after the init file error message
996 ;; was displayed, so user can read it.
997 (if init-file-had-error
998 (sit-for 2))
999 (let ((dir command-line-default-directory)
1000 (file-count 0)
1001 first-file-buffer
1002 tem
1003 just-files ;; t if this follows the magic -- option.
1004 ;; This includes our standard options' long versions
1005 ;; and long versions of what's on command-switch-alist.
1006 (longopts
1007 (append '(("--funcall") ("--load") ("--insert") ("--kill")
1008 ("--directory") ("--eval") ("--execute")
1009 ("--find-file") ("--visit") ("--file"))
1010 (mapcar (lambda (elt)
1011 (list (concat "-" (car elt))))
1012 command-switch-alist)))
1013 (line 0))
1014
1015 ;; Add the long X options to longopts.
1016 (setq tem command-line-x-option-alist)
1017 (while tem
1018 (if (string-match "^--" (car (car tem)))
1019 (setq longopts (cons (list (car (car tem))) longopts)))
1020 (setq tem (cdr tem)))
1021
1022 ;; Loop, processing options.
1023 (while (and command-line-args-left)
1024 (let* ((argi (car command-line-args-left))
1025 (orig-argi argi)
1026 argval completion
1027 ;; List of directories specified in -L/--directory,
1028 ;; in reverse of the order specified.
1029 extra-load-path
1030 (initial-load-path load-path))
1031 (setq command-line-args-left (cdr command-line-args-left))
1032
1033 ;; Do preliminary decoding of the option.
1034 (if just-files
1035 ;; After --, don't look for options; treat all args as files.
1036 (setq argi "")
1037 ;; Convert long options to ordinary options
1038 ;; and separate out an attached option argument into argval.
1039 (if (string-match "^--[^=]*=" argi)
1040 (setq argval (substring argi (match-end 0))
1041 argi (substring argi 0 (1- (match-end 0)))))
1042 (if (equal argi "--")
1043 (setq completion nil)
1044 (setq completion (try-completion argi longopts)))
1045 (if (eq completion t)
1046 (setq argi (substring argi 1))
1047 (if (stringp completion)
1048 (let ((elt (assoc completion longopts)))
1049 (or elt
1050 (error "Option `%s' is ambiguous" argi))
1051 (setq argi (substring (car elt) 1)))
1052 (setq argval nil argi orig-argi))))
1053
1054 ;; Execute the option.
1055 (cond ((setq tem (assoc argi command-switch-alist))
1056 (if argval
1057 (let ((command-line-args-left
1058 (cons argval command-line-args-left)))
1059 (funcall (cdr tem) argi))
1060 (funcall (cdr tem) argi)))
1061
1062 ((or (string-equal argi "-f") ;what the manual claims
1063 (string-equal argi "-funcall")
1064 (string-equal argi "-e")) ; what the source used to say
1065 (if argval
1066 (setq tem (intern argval))
1067 (setq tem (intern (car command-line-args-left)))
1068 (setq command-line-args-left (cdr command-line-args-left)))
1069 (if (arrayp (symbol-function tem))
1070 (command-execute tem)
1071 (funcall tem)))
1072
1073 ((or (string-equal argi "-eval")
1074 (string-equal argi "-execute"))
1075 (if argval
1076 (setq tem argval)
1077 (setq tem (car command-line-args-left))
1078 (setq command-line-args-left (cdr command-line-args-left)))
1079 (eval (read tem)))
1080 ;; Set the default directory as specified in -L.
1081
1082 ((or (string-equal argi "-L")
1083 (string-equal argi "-directory"))
1084 (if argval
1085 (setq tem argval)
1086 (setq tem (car command-line-args-left)
1087 command-line-args-left (cdr command-line-args-left)))
1088 (setq tem (command-line-normalize-file-name tem))
1089 (setq extra-load-path
1090 (cons (expand-file-name tem) extra-load-path))
1091 (setq load-path (append (nreverse extra-load-path)
1092 initial-load-path)))
1093
1094 ((or (string-equal argi "-l")
1095 (string-equal argi "-load"))
1096 (if argval
1097 (setq tem argval)
1098 (setq tem (car command-line-args-left)
1099 command-line-args-left (cdr command-line-args-left)))
1100 (let ((file (command-line-normalize-file-name tem)))
1101 ;; Take file from default dir if it exists there;
1102 ;; otherwise let `load' search for it.
1103 (if (file-exists-p (expand-file-name file))
1104 (setq file (expand-file-name file)))
1105 (load file nil t)))
1106
1107 ((string-equal argi "-insert")
1108 (if argval
1109 (setq tem argval)
1110 (setq tem (car command-line-args-left)
1111 command-line-args-left (cdr command-line-args-left)))
1112 (or (stringp tem)
1113 (error "File name omitted from `-insert' option"))
1114 (insert-file-contents (command-line-normalize-file-name tem)))
1115
1116 ((string-equal argi "-kill")
1117 (kill-emacs t))
1118
1119 ((string-match "^\\+[0-9]+\\'" argi)
1120 (setq line (string-to-int argi)))
1121
1122 ((setq tem (assoc argi command-line-x-option-alist))
1123 ;; Ignore X-windows options and their args if not using X.
1124 (setq command-line-args-left
1125 (nthcdr (nth 1 tem) command-line-args-left)))
1126
1127 ((or (string-equal argi "-find-file")
1128 (string-equal argi "-file")
1129 (string-equal argi "-visit"))
1130 ;; An explicit option to specify visiting a file.
1131 (if argval
1132 (setq tem argval)
1133 (setq tem (car command-line-args-left)
1134 command-line-args-left (cdr command-line-args-left)))
1135 (unless (stringp tem)
1136 (error "File name omitted from `%s' option" argi))
1137 (setq file-count (1+ file-count))
1138 (let ((file (expand-file-name
1139 (command-line-normalize-file-name tem) dir)))
1140 (if (= file-count 1)
1141 (setq first-file-buffer (find-file file))
1142 (find-file-other-window file)))
1143 (or (zerop line)
1144 (goto-line line))
1145 (setq line 0))
1146
1147 ((equal argi "--")
1148 (setq just-files t))
1149 (t
1150 ;; We have almost exhausted our options. See if the
1151 ;; user has made any other command-line options available
1152 (let ((hooks command-line-functions);; lrs 7/31/89
1153 (did-hook nil))
1154 (while (and hooks
1155 (not (setq did-hook (funcall (car hooks)))))
1156 (setq hooks (cdr hooks)))
1157 (if (not did-hook)
1158 ;; Ok, presume that the argument is a file name
1159 (progn
1160 (if (string-match "\\`-" argi)
1161 (error "Unknown option `%s'" argi))
1162 (setq file-count (1+ file-count))
1163 (let ((file
1164 (expand-file-name
1165 (command-line-normalize-file-name orig-argi)
1166 dir)))
1167 (if (= file-count 1)
1168 (setq first-file-buffer (find-file file))
1169 (find-file-other-window file)))
1170 (or (zerop line)
1171 (goto-line line))
1172 (setq line 0))))))))
1173 ;; If 3 or more files visited, and not all visible,
1174 ;; show user what they all are.
1175 (and (> file-count 2)
1176 (not noninteractive)
1177 (or (get-buffer-window first-file-buffer)
1178 (progn (other-window 1)
1179 (buffer-menu)))))))
1180
1181 (defun command-line-normalize-file-name (file)
1182 "Collapse multiple slashes to one, to handle non-Emacs file names."
1183 (save-match-data
1184 ;; Use arg 1 so that we don't collapse // at the start of the file name.
1185 ;; That is significant on some systems.
1186 ;; However, /// at the beginning is supposed to mean just /, not //.
1187 (if (string-match "^///+" file)
1188 (setq file (replace-match "/" t t file)))
1189 (while (string-match "//+" file 1)
1190 (setq file (replace-match "/" t t file)))
1191 file))
1192
1193 ;;; startup.el ends here