| blob | 7fa929a659d2423c9f13cca8490e8d50f33d08cf |
1 ;;; startup.el --- process Emacs shell arguments -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-2015 Free Software Foundation,
4 ;; Inc.
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; This file parses the command line and gets Emacs running. Options
28 ;; on the command line are handled in precedence order. For priorities
29 ;; see the structure standard_args in the emacs.c file.
31 ;;; Code:
39 "Emacs start-up procedure."
43 "Buffer to show after starting Emacs.
44 If the value is nil and `inhibit-startup-screen' is nil, show the
45 startup screen. If the value is a string, switch to a buffer
46 visiting the file or directory that the string specifies. If the
47 value is a function, call it with no arguments and switch to the buffer
48 that it returns. If t, open the `*scratch*' buffer.
50 If you use `emacsclient' with no target file, then it obeys any
51 string or function value that this variable has."
56 ;; Note sure about hard-coding this as an option...
64 "Non-nil inhibits the startup screen.
66 This is for use in your personal init file (but NOT site-start.el),
67 once you are familiar with the contents of the startup screen."
76 ;; FIXME? Why does this get such weirdly extreme treatment, when the
77 ;; more important inhibit-startup-screen does not.
79 "Non-nil inhibits the initial startup echo area message.
80 Setting this variable takes effect
81 only if you do it with the customization buffer
82 or if your init file contains a line of this form:
84 If your init file is byte-compiled, use the following form
85 instead:
87 Thus, someone else using a copy of your init file will see the
88 startup message unless he personally acts to inhibit it."
94 "Non-nil inhibits loading the `default' library."
99 "Non-nil inhibits display of buffer list when more than 2 files are loaded."
104 "Alist of command-line switches.
105 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
106 HANDLER-FUNCTION receives the switch string as its sole argument;
113 "List of command-line args not yet processed.
114 This is a convenience alias, so that one can write \(pop argv\)
115 inside of --eval command line arguments in order to access
124 "List of functions to process unrecognized command-line arguments.
125 Each function should access the dynamically bound variables
126 `argi' (the current argument) and `command-line-args-left' (the remaining
127 arguments). The function should return non-nil only if it recognizes and
128 processes `argi'. If it does so, it may consume successive arguments by
132 "Default directory to use for command line arguments.
135 ;; This is here, rather than in x-win.el, so that we can ignore these
136 ;; options when we are not using X.
194 "Alist of X Windows options.
195 Each element has the form
196 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
197 where NAME is the option name string, NUMARGS is the number of arguments
198 that the option accepts, HANDLER is a function to call to handle the option.
199 FRAME-PARAM (optional) is the frame parameter this option specifies,
200 and VALUE is the value which is given to that frame parameter
215 ;;("-bw" . x-handle-numeric-switch)
216 ;;("-d" . x-handle-display)
217 ;;("-display" . x-handle-display)
233 ; ("-ms" 1 x-handle-switch mouse-color)
237 ;;("-xrm" . x-handle-xrm-switch)
242 ;; ("--border-width" 1 x-handle-numeric-switch border-width)
243 ;; ("--display" 1 ns-handle-display)
249 ;; ("--geometry" 1 ns-handle-geometry)
255 ;; ("--xrm" 1 ns-handle-xrm-switch)
259 "Alist of NS options.
260 Each element has the form
261 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
262 where NAME is the option name string, NUMARGS is the number of arguments
263 that the option accepts, HANDLER is a function to call to handle the option.
264 FRAME-PARAM (optional) is the frame parameter this option specifies,
265 and VALUE is the value which is given to that frame parameter
273 "Normal hook run after initializing the Emacs session.
274 It is run after Emacs loads the init file, `default' library, the
275 abbrevs file, and additional Lisp packages (if any), and setting
276 the value of `after-init-time'.
278 There is no `condition-case' around the running of this hook;
279 therefore, if `debug-on-error' is non-nil, an error in one of
286 "Normal hook run immediately after `emacs-startup-hook'.
287 In new code, there is no reason to use this instead of `emacs-startup-hook'.
288 If you want to execute terminal-specific Lisp code, for example
289 to override the definitions made by the terminal-specific file,
293 "use either `emacs-startup-hook' or \
297 "Non-nil means don't run some startup hooks, because we already did.
298 Currently this applies to: `emacs-startup-hook', `term-setup-hook',
302 "The brand of keyboard you are using.
303 This variable is used to define the proper function and keypad
304 keys for use under X. It is used in a fashion analogous to the
308 "Normal hook run after loading init files and handling the command line.
309 This is very similar to `emacs-startup-hook'. The only difference
310 is that this hook runs after frame parameters have been set up in
311 response to any settings from your init file. Unless this matters
312 to you, use `emacs-startup-hook' instead. (The name of this hook
316 "Major mode command symbol to use for the initial `*scratch*' buffer."
321 "Identity of user whose init file is or was read.
322 The value is nil if `-q' or `--no-init-file' was specified,
323 meaning do not load any init file.
325 Otherwise, the value may be an empty string, meaning
326 use the init file for the user who originally logged in,
327 or it may be a string containing a user's name meaning
328 use that person's init file.
331 evaluates to the name of the directory where the init file was
332 looked for.
334 Setting `init-file-user' does not prevent Emacs from loading
338 "File containing site-wide run-time initializations.
339 This file is loaded at run-time before `~/.emacs'. It contains inits
340 that need to be in place for the entire site, but which, due to their
341 higher incidence of change, don't make sense to load into Emacs's
342 dumped image. Thus, the run-time load order is: 1. file described in
343 this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.
345 Don't use the `site-start.el' file for things some users may not like.
346 Put them in `default.el' instead, so that users can more easily
347 override them. Users can prevent loading `default.el' with the `-q'
348 option or by setting `inhibit-default-init' in their own init files,
349 but inhibiting `site-start.el' requires `--no-site-file', which
350 is less convenient.
352 This variable is defined for customization so as to make
353 it visible in the relevant context. However, actually customizing it
354 is not allowed, since it would not work anyway. The only way to set
355 this variable usefully is to set it while building and dumping Emacs."
365 "Name of this machine, for purposes of naming users.
366 If non-nil, Emacs uses this instead of `system-name' when constructing
367 email addresses."
376 ;; Empty string means "not set yet".
378 "Full mailing address of this user.
379 This is initialized with environment variable `EMAIL' or, as a
380 fallback, using `mail-host-address'. This is done after your
381 init file is read, in case it sets `mail-host-address'."
387 ;; MS-DOS cannot have initial dot, and allows only 8.3 names
391 "Prefix for generating `auto-save-list-file-name'.
392 This is used after reading your init file to initialize
393 `auto-save-list-file-name', by appending Emacs's pid and the system name,
394 if you have not already set `auto-save-list-file-name' yourself.
395 Directories in the prefix will be created if necessary.
396 Set this to nil if you want to prevent `auto-save-list-file-name'
397 from being initialized."
399 string)
417 Warning Warning!!! Pure space overflow !!!Warning Warning
422 "Directory containing the Emacs TUTORIAL files."
428 "Add all subdirectories of `default-directory' to `load-path'.
429 More precisely, this uses only the subdirectories whose names
430 start with letters or digits; it excludes any subdirectory named `RCS'
431 or `CVS', and any subdirectory that contains a file named `.nosearch'."
433 attrs
435 ;; This loop does a breadth-first tree walk on DIR's subtree,
436 ;; putting each subdir into DIRS as its contents are examined.
444 ;; The Windows version doesn't report meaningful inode numbers, so
445 ;; use the canonicalized absolute file name of the directory instead.
452 ;; The lower-case variants of RCS and CVS are for DOS/Windows.
454 ;; Avoid doing a `stat' when it isn't necessary because
455 ;; that can cause trouble when an NFS server is down.
464 "This function is called from a subdirs.el file.
465 It assumes that `default-directory' is the directory in which the
466 subdirs.el file exists, and it adds to `load-path' the subdirs of
467 that directory as specified in DIRS. Normally the elements of
468 DIRS are relative."
472 ;;Don't go all the way to the nil terminator.
478 ;;Splice the new section in.
483 "Emacs calls this function when it first starts up.
484 It sets `command-line-processed', processes the command-line,
485 reads the initialization files, etc.
486 It is the default value of the variable `top-level'."
491 ;; Look in each dir in load-path for a subdirs.el file. If we
492 ;; find one, load it, which will add the appropriate subdirs of
493 ;; that dir into load-path. This needs to be done before setting
494 ;; the locale environment, because the latter might need to load
495 ;; some support files.
496 ;; Look for a leim-list.el file too. Loading it will register
497 ;; available input methods.
500 dir)
505 ;; Do not scan standard directories that won't contain a leim-list.el.
506 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-10/msg00502.html
507 ;; (Except the preloaded one in lisp/leim.)
511 ;; We don't use a dolist loop and we put this "setq-cdr" command at
512 ;; the end, because the subdirs.el files may add elements to the end
513 ;; of load-path and we want to take it into account.
516 ;; Set the default strings to display in mode line for end-of-line
517 ;; formats that aren't native to this platform. This should be
518 ;; done before calling set-locale-environment, as the latter might
519 ;; use these mnemonics.
529 ;; Decode all default-directory's (probably, only *scratch* exists
530 ;; at this point). default-directory of *scratch* is the basis
531 ;; for many other file-name variables and directory lists, so it
532 ;; is important to decode it ASAP.
535 ;; MS-Windows build converts all file names to
536 ;; UTF-8 during startup.
537 'utf-8
538 locale-coding-system)))
546 ;; Decode all the important variables and directory lists, now
547 ;; that we know the locale's encoding. This is because the
548 ;; values of these variables are until here unibyte undecoded
549 ;; strings created by build_unibyte_string. data-directory in
550 ;; particular is used to construct many other standard
551 ;; directory names, so it must be decoded ASAP. Note that
552 ;; charset-map-path cannot be decoded here, since we could
553 ;; then be trapped in infinite recursion below, when we load
554 ;; subdirs.el, because encoding a directory name might need to
555 ;; load a charset map, which will want to encode
556 ;; charset-map-path, which will want to load the same charset
557 ;; map... So decoding of charset-map-path is delayed until
558 ;; further down below.
564 path)))))
566 installation-directory
567 invocation-directory invocation-name
568 source-directory
569 shared-game-score-directory))
577 ;; Make it easy to do like "tail -f".
579 ;; Give *Messages* the same default-directory as *scratch*,
580 ;; just to keep things predictable.
582 ;; `user-full-name' is now known; reset its standard-value here.
585 ;; If the PWD environment variable isn't accurate, delete it.
588 ;; Use FOO/., so that if FOO is a symlink, file-attributes
589 ;; describes the directory linked to, not FOO itself.
597 process-environment)))))
598 ;; Now, that other directories were searched, and any charsets we
599 ;; need for encoding them are already loaded, we are ready to
600 ;; decode charset-map-path.
603 'utf-8
604 locale-coding-system)))
608 charset-map-path))))
613 ;; Do this again, in case .emacs defined more abbreviations.
615 ;; Specify the file for recording all the auto save files of this session.
616 ;; This is used by recover-session.
620 ;; Under MS-DOS our PID is almost always reused between
621 ;; Emacs invocations. We need something more unique.
623 ;; We are going to access the auto-save
624 ;; directory, so make sure it exists.
627 t)
631 auto-save-list-file-prefix))
636 auto-save-list-file-prefix
642 ;; Don't do this if we failed to create the initial frame,
643 ;; for instance due to a dense colormap.
645 ;; If frame-initial-frame has no meaning, do this anyway.
650 ;; FIXME: The user's init file may change
651 ;; face-font-rescale-alist. However, the default face
652 ;; already has an assigned font object, which does not take
653 ;; face-font-rescale-alist into account. For such
654 ;; situations, we ought to have a way to find all font
655 ;; objects and regenerate them; currently we do not. As a
656 ;; workaround, we specifically reset te default face's :font
657 ;; attribute here. See bug#1785.
659 old-face-font-rescale-alist)
662 ;; Modify the initial frame based on what .emacs puts into
663 ;; ...-frame-alist.
666 ;; Set the faces for the initial background mode even if
667 ;; frame-notice-user-settings didn't (such as on a tty).
668 ;; frame-set-background-mode is idempotent, so it won't
669 ;; cause any harm if it's already been done.
673 ;; Now we know the user's default font, so add it to the menu.
678 ;; Subprocesses of Emacs do not have direct access to the terminal, so
679 ;; unless told otherwise they should only assume a dumb terminal.
680 ;; We are careful to do it late (after term-setup-hook), although the
681 ;; new multi-tty code does not use $TERM any more there anyway.
683 ;; Remove DISPLAY from the process-environment as well. This allows
684 ;; `callproc.c' to give it a useful adaptive default which is either
685 ;; the value of the `display' frame-parameter or the DISPLAY value
686 ;; from initial-environment.
688 ;; Be careful which DISPLAY to remove from process-environment: follow
689 ;; the logic of `callproc.c'.
697 ;; Precompute the keyboard equivalents in the menu bar items.
698 ;; Command-line options supported by tty's:
711 "Method for processing window-system dependent command-line arguments.
712 Window system startup files should add their own function to this
713 method, which should parse the command line arguments. Those
714 pertaining to the window system should be processed and removed
718 "Method for window-system initialization.
719 Window-system startup files should add their own implementation
720 to this method. The function should take no arguments,
721 and initialize the window system environment to prepare for
731 argval completion)
732 ;; Check for long options with attached arguments
733 ;; and separate out the attached option argument into argval.
740 ;; Exact match for long option.
744 ;; Check for abbreviated long option.
748 ;; Check for a short option.
750 argi orig-argi))))
753 default-frame-alist))
756 default-frame-alist))
761 argval
763 i)
766 ;; Change any . or * characters in name to
767 ;; hyphens, so as to emulate behavior on X.
771 argval)))
772 default-frame-alist))
775 default-frame-alist))
784 default-frame-alist))
798 "A subroutine of `normal-top-level'.
799 Amongst another things, it parses the command-line arguments."
801 after-init-time nil
802 command-line-default-directory default-directory)
804 ;; Force recomputation, in case it was computed during the dump.
807 ;; See if we should import version-control from the environment variable.
817 ;;! This has been commented out; I currently find the behavior when
818 ;;! split-window-keep-point is nil disturbing, but if I can get used
819 ;;! to it, then it would be better to eliminate the option.
820 ;;! ;; Choose a good default value for split-window-keep-point.
821 ;;! (setq split-window-keep-point (> baud-rate 2400))
823 ;; Convert preloaded file names in load-history to absolute.
825 ;; Look for simple.el or simple.elc and use their directory
826 ;; as the place where all Lisp files live.
828 lisp-dir)
829 ;; Don't abort if simple.el cannot be found, but print a warning.
830 ;; Although in most usage we are going to cryptically abort a moment
831 ;; later anyway, due to missing required bidi data files (eg bug#13430).
852 elt))
853 load-history))))
855 ;; Convert the arguments to Emacs internal representation.
864 display-arg)
866 ;; Figure out which user's init file to load,
867 ;; either from the environment or from the options.
869 ;; If user has not done su, use current $HOME to find .emacs.
874 ;; Process the command-line args, and delete the arguments
875 ;; processed. This is consistent with the way main in emacs.c
876 ;; does things.
884 argval)
885 ;; Handle --OPTION=VALUE format.
900 argi orig-argi)))))
902 ;; The --display arg is handled partly in C, partly in Lisp.
903 ;; When it shows up here, we just put it back to be handled
904 ;; by `command-line-1'.
909 site-run-file nil
910 inhibit-x-resources t))
915 emacs-basic-display t)
921 argval nil))
930 ;; Push the popped arg back on the list of arguments.
934 ;; Was argval set but not used?
938 ;; Re-attach the --display arg.
941 ;; Re-attach the program name to the front of the arg list.
945 ;; Make sure window system's init file was loaded in loadup.el if
946 ;; using a window system.
947 ;; Initialize the window-system only after processing the command-line
948 ;; args so that -Q can influence this initialization.
956 ;; Process window-system specific command line parameters.
960 command-line-args))
961 ;; Initialize the window system. (Open connection, etc.)
965 ;; If there was an error, print the error message and exit.
986 ;; Under X, create the X frame and delete the terminal frame.
990 tool-bar-mode nil
991 no-blinking-cursor t))
995 ;; Set up the tool-bar (even in tty frames, since Emacs might open a
996 ;; graphical frame later).
1000 ;; Turn off blinking cursor if so specified in X resources. This is here
1001 ;; only because all other settings of no-blinking-cursor are here.
1003 emacs-basic-display
1009 ;; Re-evaluate predefined variables whose initial value depends on
1010 ;; the runtime context.
1012 ;; Initialize them in the same order they were loaded, in case there
1013 ;; are dependencies between them.
1019 ;; Register default TTY colors for the case the terminal hasn't a
1020 ;; terminal init file. We do this regardless of whether the terminal
1021 ;; supports colors or not and regardless the current display type,
1022 ;; since users can connect to color-capable terminals and also
1023 ;; switch color support on or off in mid-session by setting the
1024 ;; tty-color-mode frame parameter.
1025 ;; Exception: the `pc' ``window system'' has only 16 fixed colors,
1026 ;; and they are already set at this point by a suitable function in
1027 ;; window-system-initialization-alist.
1034 ;; Run the site-start library if it exists. The point of this file is
1035 ;; that it is run before .emacs. There is no point in doing this after
1036 ;; .emacs; that is useless.
1037 ;; Note that user-init-file is nil at this point. Code that might
1038 ;; be loaded from site-run-file and wants to test if -q was given
1039 ;; should check init-file-user instead, since that is already set.
1040 ;; See cus-edit.el for an example.
1044 ;; Sites should not disable this. Only individuals should disable
1045 ;; the startup screen.
1048 ;; Warn for invalid user name.
1053 init-file-user)
1056 ;; We don't support ~USER on MS-Windows
1057 ;; and MS-DOS except for the current
1058 ;; user, and always load .emacs from
1059 ;; the current user's home directory
1060 ;; (see below). So always check "~",
1061 ;; even if invoked with "-u USER", or
1062 ;; if $USER or $LOGNAME are set to
1063 ;; something different.
1065 "~"
1067 nil
1072 init-file-user))
1075 ;; Load that user's init file, or the default one, or none.
1077 debug-on-error-should-be-set
1082 ;; This function actually reads the init files.
1093 ;; Else deal with the Windows situation
1095 ;; Prefer .emacs on Windows.
1098 ;; Also support _emacs for compatibility, but warn about it.
1101 delayed-warnings-list)
1105 ;; This tells `load' to store the file name found
1106 ;; into user-init-file.
1111 ;; If we did not find ~/.emacs, try
1112 ;; ~/.emacs.d/init.el.
1115 "init"
1120 ;; If we did not find the user's init file,
1121 ;; set user-init-file conclusively.
1122 ;; Don't let it be set from default.el.
1126 ;; If we loaded a compiled file, set
1127 ;; `user-init-file' to the source version if that
1128 ;; exists.
1140 source user-init-file)
1146 ;; Users are supposed to be told their rights.
1147 ;; (Plus how to get help and how to undo.)
1148 ;; Don't you dare turn this off for anyone
1149 ;; except yourself.
1152 ;; Do this without a condition-case if the user wants to debug.
1159 ;; Postpone displaying the warning until all hooks
1160 ;; in `after-init-hook' like `desktop-read' will finalize
1161 ;; possible changes in the window configuration.
1163 'after-init-hook
1166 'initialization
1168 To ensure normal operation, you should investigate and remove the
1169 cause of the error in your initialization file. Start Emacs with
1170 the `--debug-init' option to view a complete error backtrace."
1171 user-init-file
1177 t)
1184 ;; If the user has a file of abbrevs, read it (unless -batch).
1190 ;; If the abbrevs came entirely from the init file or the
1191 ;; abbrevs file, they do not need saving.
1194 ;; If we can tell that the init file altered debug-on-error,
1195 ;; arrange to preserve the value that it set up.
1198 debug-on-error-from-init-file debug-on-error)))
1204 ;; Init file changed to unibyte. Reset existing multibyte
1205 ;; buffers (probably *scratch*, *Messages*, *Minibuf-0*).
1206 ;; Arguably this should only be done if they're free of
1207 ;; multibyte characters.
1213 ;; Also re-set the language environment in case it was
1214 ;; originally done before unibyte was set and is sensitive to
1215 ;; unibyte (display table, terminal coding system &c).
1218 ;; Do this here in case the init file sets mail-host-address.
1225 ;; If parameter have been changed in the init file which influence
1226 ;; face realization, clear the face cache so that new faces will
1227 ;; be realized.
1232 ;; If any package directory exists, initialize the package system.
1234 package-enable-at-startup
1244 package-user-dir
1246 dirs)
1255 subdir))))
1262 ;; If *scratch* exists and init file didn't change its mode, initialize it.
1268 ;; Load library for our terminal type.
1269 ;; User init file can set term-file-prefix to nil to prevent this.
1271 initial-window-system
1275 ;; Update the out-of-memory error message based on user's key bindings
1276 ;; for save-some-buffers.
1279 (substitute-command-keys "Memory exhausted--use \\[save-some-buffers] then exit and restart Emacs")))
1281 ;; Process the remaining args.
1284 ;; This is a problem because, e.g. if emacs.d/gnus.el exists,
1285 ;; trying to load gnus could load the wrong file.
1286 ;; OK, it would not matter if .emacs.d were at the end of load-path.
1287 ;; but for the sake of simplicity, we discourage it full-stop.
1288 ;; Ref eg http://lists.gnu.org/archive/html/emacs-devel/2012-03/msg00056.html
1289 ;;
1290 ;; A bad element could come from user-emacs-file, the command line,
1291 ;; or EMACSLOADPATH, so we basically always have to check.
1303 Consider using a subdirectory instead, e.g.: %s"
1308 ;; If -batch, terminate after processing the command options.
1311 ;; In daemon mode, start the server to allow clients to connect.
1312 ;; This is done after loading the user's init file and after
1313 ;; processing all command line arguments to allow e.g. `server-name'
1314 ;; to be changed before the server starts.
1323 "Unable to start daemon: Emacs server named %S already running"
1324 server-name)
1325 (message "Unable to start the daemon.\nAnother instance of Emacs is running the server, either as daemon or interactively.\nYou can use emacsclient to connect to that Emacs process."))
1328 ;; Run emacs-session-restore (session management) if started by
1329 ;; the session manager and we have a session manager connection.
1336 "Apply X resources which specify initial values for Emacs variables.
1337 This is called from a window-system initialization function, such
1338 as `x-initialize-window-system' for X, either at startup (prior
1339 to reading the init file), or afterwards when the user first
1340 opens a graphical frame.
1342 This can set the values of `menu-bar-mode', `tool-bar-mode', and
1343 `no-blinking-cursor', as well as the `cursor' face. Changed
1359 ;; This buffer is for notes you don't want to save, and for Lisp evaluation.
1360 ;; If you want to create a file, visit that file with C-x C-f,
1361 ;; then enter the text in that file's own buffer.
1364 "Initial message displayed in *scratch* buffer at startup.
1365 If this is nil, no message will be displayed."
1370 \f
1371 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1372 ;;; Fancy splash screen
1373 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1377 "Welcome to "
1381 ", one component of the "
1382 :link
1392 :face variable-pitch
1399 en))
1403 ;; We used to read only the first 256 bytes of
1404 ;; the tutorial, but that prevents the coding:
1405 ;; setting, if any, in file-local variables
1406 ;; section to be seen by insert-file-contents,
1407 ;; and results in gibberish when the language
1408 ;; environment's preferred encoding is
1409 ;; different from what the file-local variable
1410 ;; says. One case in point is Hebrew.
1411 nil)
1414 ;; If there is a specific tutorial for the current language
1415 ;; environment and it is not English, append its title.
1417 ""
1431 :face variable-pitch
1437 "A list of texts to show in the middle part of splash screens.
1438 Each element in the list should be a list of strings or pairs
1443 "This is "
1447 ", one component of the "
1448 :link
1465 :face variable-pitch
1481 :face variable-pitch
1495 en))
1499 ;; Read the entire file, to make sure any
1500 ;; coding cookies and other local variables
1501 ;; get acted upon.
1502 nil)
1505 ;; If there is a specific tutorial for the current language
1506 ;; environment and it is not English, append its title.
1508 ""
1516 "A list of texts to show in the middle part of the About screen.
1517 Each element in the list should be a list of strings or pairs
1522 "Fancy splash screen when Emacs starts."
1527 "The image to show in the splash screens, or nil for defaults."
1541 map)
1544 ;; These are temporary storage areas for the splash screen display.
1547 "Insert text into the current buffer, with faces.
1548 Arguments from ARGS should be either strings; functions called
1549 with no args that return a string; pairs `:face FACE', where FACE
1550 is a face specification usable with `put-text-property'; or pairs
1551 `:link LINK' where LINK is a list of arguments to pass to
1552 `insert-button', of the form (LABEL ACTION [HELP-ECHO]), which
1553 specifies the button's label, `action' property and help-echo string.
1554 FACE and LINK can also be functions, which are evaluated to obtain
1555 a face or button specification."
1577 it))
1578 'face current-face
1589 "splash.xpm"
1602 "Insert the head part of the splash screen into the current buffer."
1609 ;; Center the image in the window.
1613 ;; Change the color of the XPM version of the splash image
1614 ;; so that it is visible with a dark frame background.
1619 ;; Insert the image with a help-echo and a link.
1628 "Insert the tail part of the splash screen into the current buffer."
1636 " "
1640 " "
1654 emacs-copyright
1659 files)
1660 ;; Don't warn if the directory for auto-save-list files does not
1661 ;; yet exist.
1694 " "
1695 :on-glyph checked
1696 :off-glyph unchecked
1704 nil))
1713 "Stop displaying the splash screen buffer."
1718 "Display fancy startup screen.
1719 If CONCISE is non-nil, display a concise version of the
1720 splash screen in another window."
1741 buffer-read-only t)
1750 ;; If the splash screen is in a split window, fit it.
1759 "Display fancy About screen."
1784 "Return the frame to use for the fancy splash screen.
1785 Returning non-nil does not mean we should necessarily
1786 use the fancy splash screen, but if we do use it,
1787 we put it on this frame."
1789 ;; MS-Windows needs this to have a chance to make the initial
1790 ;; frame visible.
1797 chosen-frame))
1800 "Return t if fancy splash screens should be used."
1809 ;; We test frame-height so that, if the frame is split
1810 ;; by displaying a warning, that doesn't cause the normal
1811 ;; splash screen to be used.
1817 "Display non-graphic splash screen.
1818 If optional argument STARTUP is non-nil, display the startup screen
1819 after Emacs starts. If STARTUP is nil, display the About screen.
1820 If CONCISE is non-nil, display a concise version of the
1821 splash screen in another window."
1832 ;; The convention for this piece of code is that
1833 ;; each piece of output starts with one or two newlines
1834 ;; and does not end with any newlines.
1843 ;; The user can use the mouse to activate menus
1844 ;; so give help in terms of menu items.
1847 ;; No mouse menus, so give help using kbd commands.
1852 ;; The rest of the startup screen is the same on all
1853 ;; kinds of terminals.
1855 ;; Give information on recovering, if there was a crash.
1857 auto-save-list-file-prefix
1858 ;; Don't signal an error if the
1859 ;; directory for auto-save-list files
1860 ;; does not yet exist.
1862 auto-save-list-file-prefix))
1865 nil
1868 auto-save-list-file-prefix)))
1869 t)
1876 ;; Display the input that we set up in the buffer.
1888 ;; The user can use the mouse to activate menus
1889 ;; so give help in terms of menu items.
1891 To follow a link, click Mouse-1 on it, or move to it and type RET.
1934 "Show a splash screen suitable for displays without mouse support."
1936 ;; If normal-erase-is-backspace is used on a tty, there's
1937 ;; no way to invoke C-h and you have to use F1 instead.
1942 ;; If C-h can't be invoked, temporarily disable its
1943 ;; binding, so where-is uses alternative bindings.
1946 map))
1947 minor-mode-overriding-map-alist)))
1975 ;; Say how to use the menu bar with the keyboard.
1982 (insert " F10 or ESC ` or M-`")
1985 ;; Many users seem to have problems with these.
1986 (insert "
1987 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
1988 If you have no Meta key, you may instead type ESC followed by the character.)")
1990 ;; Insert links to useful tasks
1993 (insert-button "Visit New File"
1994 'action (lambda (_button) (call-interactively 'find-file))
1995 'follow-link t)
1997 (insert-button "Open Home Directory"
1998 'action (lambda (_button) (dired "~"))
1999 'follow-link t)
2002 (insert-button "Customize Startup"
2003 'action (lambda (_button) (customize-group 'initialization))
2004 'follow-link t)
2006 (insert-button "Open *scratch* buffer"
2007 'action (lambda (_button) (switch-to-buffer
2008 (get-buffer-create "*scratch*")))
2009 'follow-link t)
2012 (insert (substitute-command-keys
2013 "
2015 (insert-button "full details"
2016 'action (lambda (_button) (describe-no-warranty))
2017 'follow-link t)
2018 (insert (substitute-command-keys ".
2019 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
2021 (insert-button "the conditions"
2022 'action (lambda (_button) (describe-copying))
2023 'follow-link t)
2024 (insert (substitute-command-keys".
2026 (insert-button "getting the latest version"
2027 'action (lambda (_button) (describe-distribution))
2028 'follow-link t)
2029 (insert "."))
2031 (defun normal-about-screen ()
2036 (insert-button "Authors"
2037 'action
2038 (lambda (_button)
2039 (view-file (expand-file-name "AUTHORS" data-directory))
2040 (goto-char (point-min)))
2041 'follow-link t)
2044 (insert-button "Contributing"
2045 'action
2046 (lambda (_button) (info "(emacs)Contributing"))
2047 'follow-link t)
2050 (insert-button "GNU and Freedom"
2051 'action (lambda (_button) (describe-gnu-project))
2052 'follow-link t)
2055 (insert-button "Absence of Warranty"
2056 'action (lambda (_button) (describe-no-warranty))
2057 'follow-link t)
2060 (insert-button "Copying Conditions"
2061 'action (lambda (_button) (describe-copying))
2062 'follow-link t)
2065 (insert-button "Getting New Versions"
2066 'action (lambda (_button) (describe-distribution))
2067 'follow-link t)
2070 (insert-button "More Manuals / Ordering Manuals"
2071 'action (lambda (_button) (view-order-manuals))
2072 'follow-link t)
2075 (defun startup-echo-area-message ()
2076 (if (daemonp)
2077 "Starting Emacs daemon."
2078 (substitute-command-keys
2079 "For information about GNU Emacs and the GNU system, type \
2082 (defun display-startup-echo-area-message ()
2083 (let ((resize-mini-windows t))
2084 (or noninteractive ;(input-pending-p) init-file-had-error
2085 ;; t if the init file says to inhibit the echo area startup message.
2086 (and inhibit-startup-echo-area-message
2087 user-init-file
2088 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
2089 (equal inhibit-startup-echo-area-message
2090 (if (equal init-file-user "")
2091 (user-login-name)
2092 init-file-user)))
2093 ;; Wasn't set with custom; see if .emacs has a setq.
2094 (condition-case nil
2095 (with-temp-buffer
2096 (insert-file-contents user-init-file)
2097 (re-search-forward
2098 (concat
2101 (regexp-quote
2102 (prin1-to-string
2103 (if (equal init-file-user "")
2104 (user-login-name)
2105 init-file-user)))
2107 nil t))
2108 (error nil))))
2109 (message "%s" (startup-echo-area-message)))))
2111 (defun display-startup-screen (&optional concise)
2112 "Display startup screen according to display.
2113 A fancy display is used on graphic displays, normal otherwise.
2115 If CONCISE is non-nil, display a concise version of the startup
2116 screen."
2117 ;; Prevent recursive calls from server-process-filter.
2118 (if (not (get-buffer "*GNU Emacs*"))
2119 (if (use-fancy-splash-screens-p)
2120 (fancy-startup-screen concise)
2121 (normal-splash-screen t concise))))
2123 (defun display-about-screen ()
2124 "Display the *About GNU Emacs* buffer.
2125 A fancy display is used on graphic displays, normal otherwise."
2126 (interactive)
2127 (if (use-fancy-splash-screens-p)
2128 (fancy-about-screen)
2129 (normal-splash-screen nil)))
2131 (defalias 'about-emacs 'display-about-screen)
2132 (defalias 'display-splash-screen 'display-startup-screen)
2134 (defun command-line-1 (args-left)
2135 "A subroutine of `command-line'."
2136 (display-startup-echo-area-message)
2137 (when (and pure-space-overflow
2138 (not noninteractive))
2139 (display-warning
2140 'initialization
2141 "Building Emacs overflowed pure space.\
2142 (See the node Pure Storage in the Lisp manual for details.)"
2143 :warning))
2145 (let ((file-count 0)
2146 (command-line-args-left args-left)
2147 first-file-buffer)
2148 (when command-line-args-left
2149 ;; We have command args; process them.
2150 (let ((dir command-line-default-directory)
2151 tem
2152 ;; This approach loses for "-batch -L DIR --eval "(require foo)",
2153 ;; if foo is intended to be found in DIR.
2154 ;;
2155 ;; The directories listed in --directory/-L options will *appear*
2156 ;; at the front of `load-path' in the order they appear on the
2157 ;; command-line. We cannot do this by *placing* them at the front
2158 ;; in the order they appear, so we need this variable to hold them,
2159 ;; temporarily.
2160 ;;
2161 ;; To DTRT we keep track of the splice point and modify `load-path'
2162 ;; straight away upon any --directory/-L option.
2163 splice
2164 just-files ;; t if this follows the magic -- option.
2165 ;; This includes our standard options' long versions
2166 ;; and long versions of what's on command-switch-alist.
2167 (longopts
2168 (append '("--funcall" "--load" "--insert" "--kill"
2169 "--directory" "--eval" "--execute" "--no-splash"
2170 "--find-file" "--visit" "--file" "--no-desktop")
2171 (mapcar (lambda (elt) (concat "-" (car elt)))
2172 command-switch-alist)))
2173 (line 0)
2174 (column 0))
2176 ;; Add the long X options to longopts.
2177 (dolist (tem command-line-x-option-alist)
2178 (if (string-match "^--" (car tem))
2179 (push (car tem) longopts)))
2181 ;; Add the long NS options to longopts.
2182 (dolist (tem command-line-ns-option-alist)
2183 (if (string-match "^--" (car tem))
2184 (push (list (car tem)) longopts)))
2186 ;; Loop, processing options.
2187 (while command-line-args-left
2188 (let* ((argi (car command-line-args-left))
2189 (orig-argi argi)
2190 argval completion)
2191 (setq command-line-args-left (cdr command-line-args-left))
2193 ;; Do preliminary decoding of the option.
2194 (if just-files
2195 ;; After --, don't look for options; treat all args as files.
2196 (setq argi "")
2197 ;; Convert long options to ordinary options
2198 ;; and separate out an attached option argument into argval.
2200 (setq argval (substring argi (match-end 0))
2201 argi (match-string 1 argi)))
2203 (setq completion (try-completion argi longopts))
2204 (if (eq completion t)
2205 (setq argi (substring argi 1))
2206 (if (stringp completion)
2207 (let ((elt (member completion longopts)))
2208 (or elt
2209 (error "Option `%s' is ambiguous" argi))
2210 (setq argi (substring (car elt) 1)))
2211 (setq argval nil
2212 argi orig-argi)))))
2214 ;; Execute the option.
2215 (cond ((setq tem (assoc argi command-switch-alist))
2216 (if argval
2217 (let ((command-line-args-left
2218 (cons argval command-line-args-left)))
2219 (funcall (cdr tem) argi))
2220 (funcall (cdr tem) argi)))
2222 ((equal argi "-no-splash")
2223 (setq inhibit-startup-screen t))
2225 ((member argi '("-f" ; what the manual claims
2226 "-funcall"
2227 "-e")) ; what the source used to say
2228 (setq inhibit-startup-screen t)
2229 (setq tem (intern (or argval (pop command-line-args-left))))
2230 (if (commandp tem)
2231 (command-execute tem)
2232 (funcall tem)))
2234 ((member argi '("-eval" "-execute"))
2235 (setq inhibit-startup-screen t)
2236 (eval (read (or argval (pop command-line-args-left)))))
2238 ((member argi '("-L" "-directory"))
2239 ;; -L :/foo adds /foo to the _end_ of load-path.
2240 (let (append)
2241 (if (string-match-p
2243 (setq tem (or argval (pop command-line-args-left))))
2244 (setq tem (substring tem 1)
2245 append t))
2246 (setq tem (expand-file-name
2247 (command-line-normalize-file-name tem)))
2248 (cond (append (setq load-path
2249 (append load-path (list tem)))
2250 (if splice (setq splice load-path)))
2251 (splice (setcdr splice (cons tem (cdr splice)))
2252 (setq splice (cdr splice)))
2253 (t (setq load-path (cons tem load-path)
2254 splice load-path)))))
2256 ((member argi '("-l" "-load"))
2257 (let* ((file (command-line-normalize-file-name
2258 (or argval (pop command-line-args-left))))
2259 ;; Take file from default dir if it exists there;
2260 ;; otherwise let `load' search for it.
2261 (file-ex (expand-file-name file)))
2262 (when (file-exists-p file-ex)
2263 (setq file file-ex))
2264 (load file nil t)))
2266 ;; This is used to handle -script. It's not clear
2267 ;; we need to document it (it is totally internal).
2268 ((member argi '("-scriptload"))
2269 (let* ((file (command-line-normalize-file-name
2270 (or argval (pop command-line-args-left))))
2271 ;; Take file from default dir.
2272 (file-ex (expand-file-name file)))
2273 (load file-ex nil t t)))
2275 ((equal argi "-insert")
2276 (setq inhibit-startup-screen t)
2277 (setq tem (or argval (pop command-line-args-left)))
2278 (or (stringp tem)
2279 (error "File name omitted from `-insert' option"))
2280 (insert-file-contents (command-line-normalize-file-name tem)))
2282 ((equal argi "-kill")
2283 (kill-emacs t))
2285 ;; This is for when they use --no-desktop with -q, or
2286 ;; don't load Desktop in their .emacs. If desktop.el
2287 ;; _is_ loaded, it will handle this switch, and we
2288 ;; won't see it by the time we get here.
2289 ((equal argi "-no-desktop")
2293 (setq line (string-to-number argi)))
2296 (setq line (string-to-number (match-string 1 argi))
2297 column (string-to-number (match-string 2 argi))))
2299 ((setq tem (assoc orig-argi command-line-x-option-alist))
2300 ;; Ignore X-windows options and their args if not using X.
2301 (setq command-line-args-left
2302 (nthcdr (nth 1 tem) command-line-args-left)))
2304 ((setq tem (assoc orig-argi command-line-ns-option-alist))
2305 ;; Ignore NS-windows options and their args if not using NS.
2306 (setq command-line-args-left
2307 (nthcdr (nth 1 tem) command-line-args-left)))
2309 ((member argi '("-find-file" "-file" "-visit"))
2310 (setq inhibit-startup-screen t)
2311 ;; An explicit option to specify visiting a file.
2312 (setq tem (or argval (pop command-line-args-left)))
2313 (unless (stringp tem)
2314 (error "File name omitted from `%s' option" argi))
2315 (setq file-count (1+ file-count))
2316 (let ((file (expand-file-name
2317 (command-line-normalize-file-name tem)
2318 dir)))
2319 (if (= file-count 1)
2320 (setq first-file-buffer (find-file file))
2321 (find-file-other-window file)))
2322 (unless (zerop line)
2323 (goto-char (point-min))
2324 (forward-line (1- line)))
2325 (setq line 0)
2326 (unless (< column 1)
2327 (move-to-column (1- column)))
2328 (setq column 0))
2330 ;; These command lines now have no effect.
2332 (display-warning 'initialization
2333 (format "Ignoring obsolete arg %s" argi)))
2335 ((equal argi "--")
2336 (setq just-files t))
2337 (t
2338 ;; We have almost exhausted our options. See if the
2339 ;; user has made any other command-line options available
2340 (let ((hooks command-line-functions)
2341 (did-hook nil))
2342 (while (and hooks
2343 (not (setq did-hook (funcall (car hooks)))))
2344 (setq hooks (cdr hooks)))
2345 (if (not did-hook)
2346 ;; Presume that the argument is a file name.
2347 (progn
2349 (error "Unknown option `%s'" argi))
2350 (unless initial-window-system
2351 (setq inhibit-startup-screen t))
2352 (setq file-count (1+ file-count))
2353 (let ((file
2354 (expand-file-name
2355 (command-line-normalize-file-name orig-argi)
2356 dir)))
2357 (cond ((= file-count 1)
2358 (setq first-file-buffer (find-file file)))
2359 (inhibit-startup-screen
2360 (find-file-other-window file))
2361 (t (find-file file))))
2362 (unless (zerop line)
2363 (goto-char (point-min))
2364 (forward-line (1- line)))
2365 (setq line 0)
2366 (unless (< column 1)
2367 (move-to-column (1- column)))
2368 (setq column 0))))))
2369 ;; In unusual circumstances, the execution of Lisp code due
2370 ;; to command-line options can cause the last visible frame
2371 ;; to be deleted. In this case, kill emacs to avoid an
2372 ;; abort later.
2373 (unless (frame-live-p (selected-frame)) (kill-emacs nil))))))
2375 (when (eq initial-buffer-choice t)
2376 ;; When initial-buffer-choice equals t make sure that *scratch*
2377 ;; exists.
2378 (get-buffer-create "*scratch*"))
2380 ;; If *scratch* exists and is empty, insert initial-scratch-message.
2381 ;; Do this before switching to *scratch* below to handle bug#9605.
2382 (and initial-scratch-message
2383 (get-buffer "*scratch*")
2384 (with-current-buffer "*scratch*"
2385 (when (zerop (buffer-size))
2386 (insert initial-scratch-message)
2387 (set-buffer-modified-p nil))))
2389 (when initial-buffer-choice
2390 (let ((buf
2391 (cond ((stringp initial-buffer-choice)
2392 (find-file-noselect initial-buffer-choice))
2393 ((functionp initial-buffer-choice)
2394 (funcall initial-buffer-choice)))))
2395 (switch-to-buffer
2396 (if (buffer-live-p buf) buf (get-buffer-create "*scratch*"))
2397 'norecord)))
2399 (if (or inhibit-startup-screen
2400 initial-buffer-choice
2401 noninteractive
2402 (daemonp)
2403 inhibit-x-resources)
2405 ;; Not displaying a startup screen. If 3 or more files
2406 ;; visited, and not all visible, show user what they all are.
2407 (and (> file-count 2)
2408 (not noninteractive)
2409 (not inhibit-startup-buffer-menu)
2410 (or (get-buffer-window first-file-buffer)
2411 (list-buffers)))
2413 ;; Display a startup screen, after some preparations.
2415 ;; If there are no switches to process, we might as well
2416 ;; run this hook now, and there may be some need to do it
2417 ;; before doing any output.
2418 (run-hooks 'emacs-startup-hook 'term-setup-hook)
2420 ;; It's important to notice the user settings before we
2421 ;; display the startup message; otherwise, the settings
2422 ;; won't take effect until the user gives the first
2423 ;; keystroke, and that's distracting.
2424 (when (fboundp 'frame-notice-user-settings)
2425 (frame-notice-user-settings))
2427 ;; If there are no switches to process, we might as well
2428 ;; run this hook now, and there may be some need to do it
2429 ;; before doing any output.
2430 (run-hooks 'window-setup-hook)
2432 (setq inhibit-startup-hooks t)
2434 ;; ;; Do this now to avoid an annoying delay if the user
2435 ;; ;; clicks the menu bar during the sit-for.
2436 ;; (when (display-popup-menus-p)
2437 ;; (precompute-menubar-bindings))
2438 ;; (with-no-warnings
2439 ;; (setq menubar-bindings-done t))
2441 (display-startup-screen (> file-count 0)))))
2443 (defun command-line-normalize-file-name (file)
2444 "Collapse multiple slashes to one, to handle non-Emacs file names."
2445 (save-match-data
2446 ;; Use arg 1 so that we don't collapse // at the start of the file name.
2447 ;; That is significant on some systems.
2448 ;; However, /// at the beginning is supposed to mean just /, not //.
2449 (if (string-match
2450 (if (memq system-type '(ms-dos windows-nt))
2452 "^///+")
2453 file)
2454 (setq file (replace-match "/" t t file)))
2455 (if (memq system-type '(ms-dos windows-nt))
2457 (setq file (replace-match "/" t t file)))
2458 (while (string-match "//+" file 1)
2459 (setq file (replace-match "/" t t file))))
2460 file))
2462 ;;; startup.el ends here