| blob | 8c63ed263c2f7cd18d84177b5ba2925847a4a109 |
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 When `initial-buffer-choice' is non-nil, the startup screen is
51 inhibited.
53 If you use `emacsclient' with no target file, then it obeys any
54 string or function value that this variable has."
59 ;; Note sure about hard-coding this as an option...
67 "Non-nil inhibits the startup screen.
69 This is for use in your personal init file (but NOT site-start.el),
70 once you are familiar with the contents of the startup screen."
79 ;; FIXME? Why does this get such weirdly extreme treatment, when the
80 ;; more important inhibit-startup-screen does not.
82 "Non-nil inhibits the initial startup echo area message.
83 Setting this variable takes effect
84 only if you do it with the customization buffer
85 or if your init file contains a line of this form:
87 If your init file is byte-compiled, use the following form
88 instead:
90 Thus, someone else using a copy of your init file will see the
91 startup message unless he personally acts to inhibit it."
97 "Non-nil inhibits loading the `default' library."
102 "Non-nil inhibits display of buffer list when more than 2 files are loaded."
107 "Alist of command-line switches.
108 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
109 HANDLER-FUNCTION receives the switch string as its sole argument;
116 "List of command-line args not yet processed.
117 This is a convenience alias, so that one can write \(pop argv\)
118 inside of --eval command line arguments in order to access
127 "List of functions to process unrecognized command-line arguments.
128 Each function should access the dynamically bound variables
129 `argi' (the current argument) and `command-line-args-left' (the remaining
130 arguments). The function should return non-nil only if it recognizes and
131 processes `argi'. If it does so, it may consume successive arguments by
135 "Default directory to use for command line arguments.
138 ;; This is here, rather than in x-win.el, so that we can ignore these
139 ;; options when we are not using X.
197 "Alist of X Windows options.
198 Each element has the form
199 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
200 where NAME is the option name string, NUMARGS is the number of arguments
201 that the option accepts, HANDLER is a function to call to handle the option.
202 FRAME-PARAM (optional) is the frame parameter this option specifies,
203 and VALUE is the value which is given to that frame parameter
218 ;;("-bw" . x-handle-numeric-switch)
219 ;;("-d" . x-handle-display)
220 ;;("-display" . x-handle-display)
236 ; ("-ms" 1 x-handle-switch mouse-color)
240 ;;("-xrm" . x-handle-xrm-switch)
245 ;; ("--border-width" 1 x-handle-numeric-switch border-width)
246 ;; ("--display" 1 ns-handle-display)
252 ;; ("--geometry" 1 ns-handle-geometry)
258 ;; ("--xrm" 1 ns-handle-xrm-switch)
262 "Alist of NS options.
263 Each element has the form
264 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
265 where NAME is the option name string, NUMARGS is the number of arguments
266 that the option accepts, HANDLER is a function to call to handle the option.
267 FRAME-PARAM (optional) is the frame parameter this option specifies,
268 and VALUE is the value which is given to that frame parameter
276 "Normal hook run after initializing the Emacs session.
277 It is run after Emacs loads the init file, `default' library, the
278 abbrevs file, and additional Lisp packages (if any), and setting
279 the value of `after-init-time'.
281 There is no `condition-case' around the running of this hook;
282 therefore, if `debug-on-error' is non-nil, an error in one of
289 "Normal hook run immediately after `emacs-startup-hook'.
290 In new code, there is no reason to use this instead of `emacs-startup-hook'.
291 If you want to execute terminal-specific Lisp code, for example
292 to override the definitions made by the terminal-specific file,
296 "use either `emacs-startup-hook' or \
300 "Non-nil means don't run some startup hooks, because we already did.
301 Currently this applies to: `emacs-startup-hook', `term-setup-hook',
305 "The brand of keyboard you are using.
306 This variable is used to define the proper function and keypad
307 keys for use under X. It is used in a fashion analogous to the
311 "Normal hook run after loading init files and handling the command line.
312 This is very similar to `emacs-startup-hook'. The only difference
313 is that this hook runs after frame parameters have been set up in
314 response to any settings from your init file. Unless this matters
315 to you, use `emacs-startup-hook' instead. (The name of this hook
319 "Major mode command symbol to use for the initial `*scratch*' buffer."
324 "Identity of user whose init file is or was read.
325 The value is nil if `-q' or `--no-init-file' was specified,
326 meaning do not load any init file.
328 Otherwise, the value may be an empty string, meaning
329 use the init file for the user who originally logged in,
330 or it may be a string containing a user's name meaning
331 use that person's init file.
334 evaluates to the name of the directory where the init file was
335 looked for.
337 Setting `init-file-user' does not prevent Emacs from loading
341 "File containing site-wide run-time initializations.
342 This file is loaded at run-time before `~/.emacs'. It contains inits
343 that need to be in place for the entire site, but which, due to their
344 higher incidence of change, don't make sense to load into Emacs's
345 dumped image. Thus, the run-time load order is: 1. file described in
346 this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.
348 Don't use the `site-start.el' file for things some users may not like.
349 Put them in `default.el' instead, so that users can more easily
350 override them. Users can prevent loading `default.el' with the `-q'
351 option or by setting `inhibit-default-init' in their own init files,
352 but inhibiting `site-start.el' requires `--no-site-file', which
353 is less convenient.
355 This variable is defined for customization so as to make
356 it visible in the relevant context. However, actually customizing it
357 is not allowed, since it would not work anyway. The only way to set
358 this variable usefully is to set it while building and dumping Emacs."
368 "Name of this machine, for purposes of naming users.
369 If non-nil, Emacs uses this instead of `system-name' when constructing
370 email addresses."
379 ;; Empty string means "not set yet".
381 "Full mailing address of this user.
382 This is initialized with environment variable `EMAIL' or, as a
383 fallback, using `mail-host-address'. This is done after your
384 init file is read, in case it sets `mail-host-address'."
390 ;; MS-DOS cannot have initial dot, and allows only 8.3 names
394 "Prefix for generating `auto-save-list-file-name'.
395 This is used after reading your init file to initialize
396 `auto-save-list-file-name', by appending Emacs's pid and the system name,
397 if you have not already set `auto-save-list-file-name' yourself.
398 Directories in the prefix will be created if necessary.
399 Set this to nil if you want to prevent `auto-save-list-file-name'
400 from being initialized."
402 string)
420 Warning Warning!!! Pure space overflow !!!Warning Warning
425 "Directory containing the Emacs TUTORIAL files."
431 "Add all subdirectories of `default-directory' to `load-path'.
432 More precisely, this uses only the subdirectories whose names
433 start with letters or digits; it excludes any subdirectory named `RCS'
434 or `CVS', and any subdirectory that contains a file named `.nosearch'."
436 attrs
438 ;; This loop does a breadth-first tree walk on DIR's subtree,
439 ;; putting each subdir into DIRS as its contents are examined.
447 ;; The Windows version doesn't report meaningful inode numbers, so
448 ;; use the canonicalized absolute file name of the directory instead.
455 ;; The lower-case variants of RCS and CVS are for DOS/Windows.
457 ;; Avoid doing a `stat' when it isn't necessary because
458 ;; that can cause trouble when an NFS server is down.
467 "This function is called from a subdirs.el file.
468 It assumes that `default-directory' is the directory in which the
469 subdirs.el file exists, and it adds to `load-path' the subdirs of
470 that directory as specified in DIRS. Normally the elements of
471 DIRS are relative."
475 ;;Don't go all the way to the nil terminator.
481 ;;Splice the new section in.
486 "Emacs calls this function when it first starts up.
487 It sets `command-line-processed', processes the command-line,
488 reads the initialization files, etc.
489 It is the default value of the variable `top-level'."
494 ;; Look in each dir in load-path for a subdirs.el file. If we
495 ;; find one, load it, which will add the appropriate subdirs of
496 ;; that dir into load-path. This needs to be done before setting
497 ;; the locale environment, because the latter might need to load
498 ;; some support files.
499 ;; Look for a leim-list.el file too. Loading it will register
500 ;; available input methods.
503 dir)
508 ;; Do not scan standard directories that won't contain a leim-list.el.
509 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-10/msg00502.html
510 ;; (Except the preloaded one in lisp/leim.)
514 ;; We don't use a dolist loop and we put this "setq-cdr" command at
515 ;; the end, because the subdirs.el files may add elements to the end
516 ;; of load-path and we want to take it into account.
519 ;; Set the default strings to display in mode line for end-of-line
520 ;; formats that aren't native to this platform. This should be
521 ;; done before calling set-locale-environment, as the latter might
522 ;; use these mnemonics.
532 ;; Decode all default-directory's (probably, only *scratch* exists
533 ;; at this point). default-directory of *scratch* is the basis
534 ;; for many other file-name variables and directory lists, so it
535 ;; is important to decode it ASAP.
538 ;; MS-Windows build converts all file names to
539 ;; UTF-8 during startup.
540 'utf-8
541 locale-coding-system)))
549 ;; Decode all the important variables and directory lists, now
550 ;; that we know the locale's encoding. This is because the
551 ;; values of these variables are until here unibyte undecoded
552 ;; strings created by build_unibyte_string. data-directory in
553 ;; particular is used to construct many other standard
554 ;; directory names, so it must be decoded ASAP. Note that
555 ;; charset-map-path cannot be decoded here, since we could
556 ;; then be trapped in infinite recursion below, when we load
557 ;; subdirs.el, because encoding a directory name might need to
558 ;; load a charset map, which will want to encode
559 ;; charset-map-path, which will want to load the same charset
560 ;; map... So decoding of charset-map-path is delayed until
561 ;; further down below.
567 path)))))
569 installation-directory
570 invocation-directory invocation-name
571 source-directory
572 shared-game-score-directory))
580 ;; Make it easy to do like "tail -f".
582 ;; Give *Messages* the same default-directory as *scratch*,
583 ;; just to keep things predictable.
585 ;; `user-full-name' is now known; reset its standard-value here.
588 ;; If the PWD environment variable isn't accurate, delete it.
591 ;; Use FOO/., so that if FOO is a symlink, file-attributes
592 ;; describes the directory linked to, not FOO itself.
601 process-environment)))))
602 ;; Now, that other directories were searched, and any charsets we
603 ;; need for encoding them are already loaded, we are ready to
604 ;; decode charset-map-path.
607 'utf-8
608 locale-coding-system)))
612 charset-map-path))))
619 ;; Do this again, in case .emacs defined more abbreviations.
622 ;; Specify the file for recording all the auto save files of this session.
623 ;; This is used by recover-session.
627 ;; Under MS-DOS our PID is almost always reused between
628 ;; Emacs invocations. We need something more unique.
630 ;; We are going to access the auto-save
631 ;; directory, so make sure it exists.
634 t)
638 auto-save-list-file-prefix))
643 auto-save-list-file-prefix
649 ;; Don't do this if we failed to create the initial frame,
650 ;; for instance due to a dense colormap.
652 ;; If frame-initial-frame has no meaning, do this anyway.
657 ;; FIXME: The user's init file may change
658 ;; face-font-rescale-alist. However, the default face
659 ;; already has an assigned font object, which does not take
660 ;; face-font-rescale-alist into account. For such
661 ;; situations, we ought to have a way to find all font
662 ;; objects and regenerate them; currently we do not. As a
663 ;; workaround, we specifically reset te default face's :font
664 ;; attribute here. See bug#1785.
666 old-face-font-rescale-alist)
669 ;; Modify the initial frame based on what .emacs puts into
670 ;; ...-frame-alist.
673 ;; Set the faces for the initial background mode even if
674 ;; frame-notice-user-settings didn't (such as on a tty).
675 ;; frame-set-background-mode is idempotent, so it won't
676 ;; cause any harm if it's already been done.
680 ;; Now we know the user's default font, so add it to the menu.
685 ;; Subprocesses of Emacs do not have direct access to the terminal, so
686 ;; unless told otherwise they should only assume a dumb terminal.
687 ;; We are careful to do it late (after term-setup-hook), although the
688 ;; new multi-tty code does not use $TERM any more there anyway.
690 ;; Remove DISPLAY from the process-environment as well. This allows
691 ;; `callproc.c' to give it a useful adaptive default which is either
692 ;; the value of the `display' frame-parameter or the DISPLAY value
693 ;; from initial-environment.
695 ;; Be careful which DISPLAY to remove from process-environment: follow
696 ;; the logic of `callproc.c'.
704 ;; Precompute the keyboard equivalents in the menu bar items.
705 ;; Command-line options supported by tty's:
718 "Method for processing window-system dependent command-line arguments.
719 Window system startup files should add their own function to this
720 method, which should parse the command line arguments. Those
721 pertaining to the window system should be processed and removed
727 "Method for window-system initialization.
728 Window-system startup files should add their own implementation
729 to this method. The function should initialize the window system environment
730 to prepare for opening the first frame (e.g. open a connection to an X server)."
731 nil)
740 argval completion)
741 ;; Check for long options with attached arguments
742 ;; and separate out the attached option argument into argval.
749 ;; Exact match for long option.
753 ;; Check for abbreviated long option.
757 ;; Check for a short option.
759 argi orig-argi))))
762 default-frame-alist))
765 default-frame-alist))
770 argval
772 i)
775 ;; Change any . or * characters in name to
776 ;; hyphens, so as to emulate behavior on X.
780 argval)))
781 default-frame-alist))
784 default-frame-alist))
793 default-frame-alist))
807 "A subroutine of `normal-top-level'.
808 Amongst another things, it parses the command-line arguments."
810 after-init-time nil
811 command-line-default-directory default-directory)
813 ;; Force recomputation, in case it was computed during the dump.
816 ;; See if we should import version-control from the environment variable.
826 ;;! This has been commented out; I currently find the behavior when
827 ;;! split-window-keep-point is nil disturbing, but if I can get used
828 ;;! to it, then it would be better to eliminate the option.
829 ;;! ;; Choose a good default value for split-window-keep-point.
830 ;;! (setq split-window-keep-point (> baud-rate 2400))
832 ;; Convert preloaded file names in load-history to absolute.
834 ;; Look for simple.el or simple.elc and use their directory
835 ;; as the place where all Lisp files live.
837 lisp-dir)
838 ;; Don't abort if simple.el cannot be found, but print a warning.
839 ;; Although in most usage we are going to cryptically abort a moment
840 ;; later anyway, due to missing required bidi data files (eg bug#13430).
861 elt))
862 load-history))))
864 ;; Convert the arguments to Emacs internal representation.
873 display-arg)
875 ;; Figure out which user's init file to load,
876 ;; either from the environment or from the options.
878 ;; If user has not done su, use current $HOME to find .emacs.
883 ;; Process the command-line args, and delete the arguments
884 ;; processed. This is consistent with the way main in emacs.c
885 ;; does things.
893 argval)
894 ;; Handle --OPTION=VALUE format.
909 argi orig-argi)))))
911 ;; The --display arg is handled partly in C, partly in Lisp.
912 ;; When it shows up here, we just put it back to be handled
913 ;; by `command-line-1'.
918 site-run-file nil
919 inhibit-x-resources t)
920 ;; Stop it showing up in emacs -Q's customize-rogue.
926 emacs-basic-display t)
932 argval nil))
942 ;; Push the popped arg back on the list of arguments.
946 ;; Was argval set but not used?
950 ;; Re-attach the --display arg.
953 ;; Re-attach the program name to the front of the arg list.
957 ;; Make sure window system's init file was loaded in loadup.el if
958 ;; using a window system.
959 ;; Initialize the window-system only after processing the command-line
960 ;; args so that -Q can influence this initialization.
968 ;; Process window-system specific command line parameters.
972 ;; Initialize the window system. (Open connection, etc.)
976 ;; If there was an error, print the error message and exit.
997 ;; Under X, create the X frame and delete the terminal frame.
1001 tool-bar-mode nil
1002 no-blinking-cursor t))
1006 ;; Set up the tool-bar (even in tty frames, since Emacs might open a
1007 ;; graphical frame later).
1011 ;; Turn off blinking cursor if so specified in X resources. This is here
1012 ;; only because all other settings of no-blinking-cursor are here.
1014 emacs-basic-display
1020 ;; If curved quotes don't work, display ASCII approximations.
1028 ;; Re-evaluate predefined variables whose initial value depends on
1029 ;; the runtime context.
1031 ;; Initialize them in the same order they were loaded, in case there
1032 ;; are dependencies between them.
1038 ;; Register default TTY colors for the case the terminal hasn't a
1039 ;; terminal init file. We do this regardless of whether the terminal
1040 ;; supports colors or not and regardless the current display type,
1041 ;; since users can connect to color-capable terminals and also
1042 ;; switch color support on or off in mid-session by setting the
1043 ;; tty-color-mode frame parameter.
1044 ;; Exception: the `pc' ``window system'' has only 16 fixed colors,
1045 ;; and they are already set at this point by a suitable method of
1046 ;; window-system-initialization.
1053 ;; Run the site-start library if it exists. The point of this file is
1054 ;; that it is run before .emacs. There is no point in doing this after
1055 ;; .emacs; that is useless.
1056 ;; Note that user-init-file is nil at this point. Code that might
1057 ;; be loaded from site-run-file and wants to test if -q was given
1058 ;; should check init-file-user instead, since that is already set.
1059 ;; See cus-edit.el for an example.
1063 ;; Sites should not disable this. Only individuals should disable
1064 ;; the startup screen.
1067 ;; Warn for invalid user name.
1072 init-file-user)
1075 ;; We don't support ~USER on MS-Windows
1076 ;; and MS-DOS except for the current
1077 ;; user, and always load .emacs from
1078 ;; the current user's home directory
1079 ;; (see below). So always check "~",
1080 ;; even if invoked with "-u USER", or
1081 ;; if $USER or $LOGNAME are set to
1082 ;; something different.
1084 "~"
1086 nil
1091 init-file-user))
1094 ;; Load that user's init file, or the default one, or none.
1096 debug-on-error-should-be-set
1101 ;; This function actually reads the init files.
1112 ;; Else deal with the Windows situation
1114 ;; Prefer .emacs on Windows.
1117 ;; Also support _emacs for compatibility, but warn about it.
1121 delayed-warnings-list)
1125 ;; This tells `load' to store the file name found
1126 ;; into user-init-file.
1131 ;; If we did not find ~/.emacs, try
1132 ;; ~/.emacs.d/init.el.
1135 "init"
1140 ;; If we did not find the user's init file,
1141 ;; set user-init-file conclusively.
1142 ;; Don't let it be set from default.el.
1146 ;; If we loaded a compiled file, set
1147 ;; `user-init-file' to the source version if that
1148 ;; exists.
1160 source user-init-file)
1166 ;; Users are supposed to be told their rights.
1167 ;; (Plus how to get help and how to undo.)
1168 ;; Don't you dare turn this off for anyone
1169 ;; except yourself.
1172 ;; Do this without a condition-case if the user wants to debug.
1180 'initialization
1183 To ensure normal operation, you should investigate and remove the
1184 cause of the error in your initialization file. Start Emacs with
1185 the ‘--debug-init’ option to view a complete error backtrace."
1186 user-init-file
1198 ;; If the user has a file of abbrevs, read it (unless -batch).
1204 ;; If the abbrevs came entirely from the init file or the
1205 ;; abbrevs file, they do not need saving.
1208 ;; If we can tell that the init file altered debug-on-error,
1209 ;; arrange to preserve the value that it set up.
1212 debug-on-error-from-init-file debug-on-error)))
1218 ;; Init file changed to unibyte. Reset existing multibyte
1219 ;; buffers (probably *scratch*, *Messages*, *Minibuf-0*).
1220 ;; Arguably this should only be done if they're free of
1221 ;; multibyte characters.
1227 ;; Also re-set the language environment in case it was
1228 ;; originally done before unibyte was set and is sensitive to
1229 ;; unibyte (display table, terminal coding system &c).
1232 ;; Do this here in case the init file sets mail-host-address.
1239 ;; If parameter have been changed in the init file which influence
1240 ;; face realization, clear the face cache so that new faces will
1241 ;; be realized.
1246 ;; If any package directory exists, initialize the package system.
1248 package-enable-at-startup
1258 package-user-dir
1260 dirs)
1269 subdir))))
1274 ;; Display any accumulated warnings after all functions in
1275 ;; `after-init-hook' like `desktop-read' have finalized possible
1276 ;; changes in the window configuration.
1279 ;; If *scratch* exists and init file didn't change its mode, initialize it.
1285 ;; Load library for our terminal type.
1286 ;; User init file can set term-file-prefix to nil to prevent this.
1288 initial-window-system
1292 ;; Update the out-of-memory error message based on user's key bindings
1293 ;; for save-some-buffers.
1296 (substitute-command-keys "Memory exhausted--use \\[save-some-buffers] then exit and restart Emacs")))
1298 ;; Process the remaining args.
1301 ;; This is a problem because, e.g. if emacs.d/gnus.el exists,
1302 ;; trying to load gnus could load the wrong file.
1303 ;; OK, it would not matter if .emacs.d were at the end of load-path.
1304 ;; but for the sake of simplicity, we discourage it full-stop.
1305 ;; Ref eg http://lists.gnu.org/archive/html/emacs-devel/2012-03/msg00056.html
1306 ;;
1307 ;; A bad element could come from user-emacs-file, the command line,
1308 ;; or EMACSLOADPATH, so we basically always have to check.
1321 Consider using a subdirectory instead, e.g.: %s"
1326 ;; If -batch, terminate after processing the command options.
1329 ;; In daemon mode, start the server to allow clients to connect.
1330 ;; This is done after loading the user's init file and after
1331 ;; processing all command line arguments to allow e.g. `server-name'
1332 ;; to be changed before the server starts.
1341 "Unable to start daemon: Emacs server named %S already running"
1342 server-name)
1343 (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."))
1346 ;; Run emacs-session-restore (session management) if started by
1347 ;; the session manager and we have a session manager connection.
1354 "Apply X resources which specify initial values for Emacs variables.
1355 This is called from a window-system initialization function, such
1356 as `x-initialize-window-system' for X, either at startup (prior
1357 to reading the init file), or afterwards when the user first
1358 opens a graphical frame.
1360 This can set the values of `menu-bar-mode', `tool-bar-mode', and
1361 `no-blinking-cursor', as well as the `cursor' face. Changed
1377 ;; This buffer is for notes you don't want to save, and for Lisp evaluation.
1378 ;; If you want to create a file, visit that file with C-x C-f,
1379 ;; then enter the text in that file's own buffer.
1382 "Initial message displayed in *scratch* buffer at startup.
1383 If this is nil, no message will be displayed."
1388 \f
1389 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1390 ;;; Fancy splash screen
1391 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1395 "Welcome to "
1399 ", one component of the "
1400 :link
1410 :face variable-pitch
1417 en))
1421 ;; We used to read only the first 256 bytes of
1422 ;; the tutorial, but that prevents the coding:
1423 ;; setting, if any, in file-local variables
1424 ;; section to be seen by insert-file-contents,
1425 ;; and results in gibberish when the language
1426 ;; environment's preferred encoding is
1427 ;; different from what the file-local variable
1428 ;; says. One case in point is Hebrew.
1429 nil)
1432 ;; If there is a specific tutorial for the current language
1433 ;; environment and it is not English, append its title.
1435 ""
1449 :face variable-pitch
1455 "A list of texts to show in the middle part of splash screens.
1456 Each element in the list should be a list of strings or pairs
1461 "This is "
1465 ", one component of the "
1466 :link
1483 :face variable-pitch
1499 :face variable-pitch
1513 en))
1517 ;; Read the entire file, to make sure any
1518 ;; coding cookies and other local variables
1519 ;; get acted upon.
1520 nil)
1523 ;; If there is a specific tutorial for the current language
1524 ;; environment and it is not English, append its title.
1526 ""
1534 "A list of texts to show in the middle part of the About screen.
1535 Each element in the list should be a list of strings or pairs
1540 "Fancy splash screen when Emacs starts."
1545 "The image to show in the splash screens, or nil for defaults."
1559 map)
1562 ;; These are temporary storage areas for the splash screen display.
1565 "Insert text into the current buffer, with faces.
1566 Arguments from ARGS should be either strings; functions called
1567 with no args that return a string; pairs `:face FACE', where FACE
1568 is a face specification usable with `put-text-property'; or pairs
1569 `:link LINK' where LINK is a list of arguments to pass to
1570 `insert-button', of the form (LABEL ACTION [HELP-ECHO]), which
1571 specifies the button's label, `action' property and help-echo string.
1572 FACE and LINK can also be functions, which are evaluated to obtain
1573 a face or button specification."
1595 it))
1596 'face current-face
1607 "splash.xpm"
1620 "Insert the head part of the splash screen into the current buffer."
1627 ;; Center the image in the window.
1631 ;; Change the color of the XPM version of the splash image
1632 ;; so that it is visible with a dark frame background.
1637 ;; Insert the image with a help-echo and a link.
1646 "Insert the tail part of the splash screen into the current buffer."
1654 " "
1658 " "
1672 emacs-copyright
1677 files)
1678 ;; Don't warn if the directory for auto-save-list files does not
1679 ;; yet exist.
1712 " "
1713 :on-glyph checked
1714 :off-glyph unchecked
1722 nil))
1731 "Stop displaying the splash screen buffer."
1736 "Display fancy startup screen.
1737 If CONCISE is non-nil, display a concise version of the
1738 splash screen in another window."
1759 buffer-read-only t)
1768 ;; If the splash screen is in a split window, fit it.
1777 "Display fancy About screen."
1802 "Return the frame to use for the fancy splash screen.
1803 Returning non-nil does not mean we should necessarily
1804 use the fancy splash screen, but if we do use it,
1805 we put it on this frame."
1807 ;; MS-Windows needs this to have a chance to make the initial
1808 ;; frame visible.
1815 chosen-frame))
1818 "Return t if fancy splash screens should be used."
1827 ;; We test frame-height so that, if the frame is split
1828 ;; by displaying a warning, that doesn't cause the normal
1829 ;; splash screen to be used.
1835 "Display non-graphic splash screen.
1836 If optional argument STARTUP is non-nil, display the startup screen
1837 after Emacs starts. If STARTUP is nil, display the About screen.
1838 If CONCISE is non-nil, display a concise version of the
1839 splash screen in another window."
1850 ;; The convention for this piece of code is that
1851 ;; each piece of output starts with one or two newlines
1852 ;; and does not end with any newlines.
1861 ;; The user can use the mouse to activate menus
1862 ;; so give help in terms of menu items.
1865 ;; No mouse menus, so give help using kbd commands.
1870 ;; The rest of the startup screen is the same on all
1871 ;; kinds of terminals.
1873 ;; Give information on recovering, if there was a crash.
1875 auto-save-list-file-prefix
1876 ;; Don't signal an error if the
1877 ;; directory for auto-save-list files
1878 ;; does not yet exist.
1880 auto-save-list-file-prefix))
1883 nil
1886 auto-save-list-file-prefix)))
1887 t)
1894 ;; Display the input that we set up in the buffer.
1906 ;; The user can use the mouse to activate menus
1907 ;; so give help in terms of menu items.
1909 To follow a link, click Mouse-1 on it, or move to it and type RET.
1953 "Show a splash screen suitable for displays without mouse support."
1955 ;; If normal-erase-is-backspace is used on a tty, there's
1956 ;; no way to invoke C-h and you have to use F1 instead.
1961 ;; If C-h can't be invoked, temporarily disable its
1962 ;; binding, so where-is uses alternative bindings.
1965 map))
1966 minor-mode-overriding-map-alist)))
1994 ;; Say how to use the menu bar with the keyboard.
2001 (insert " F10 or ESC ` or M-`")
2004 ;; Many users seem to have problems with these.
2005 (insert (substitute-command-keys "
2006 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
2007 If you have no Meta key, you may instead type ESC followed by the character.)"))
2009 ;; Insert links to useful tasks
2012 (insert-button "Visit New File"
2013 'action (lambda (_button) (call-interactively 'find-file))
2014 'follow-link t)
2016 (insert-button "Open Home Directory"
2017 'action (lambda (_button) (dired "~"))
2018 'follow-link t)
2021 (insert-button "Customize Startup"
2022 'action (lambda (_button) (customize-group 'initialization))
2023 'follow-link t)
2025 (insert-button "Open *scratch* buffer"
2026 'action (lambda (_button) (switch-to-buffer
2027 (get-buffer-create "*scratch*")))
2028 'follow-link t)
2031 (insert (substitute-command-keys
2032 "
2034 (insert-button "full details"
2035 'action (lambda (_button) (describe-no-warranty))
2036 'follow-link t)
2037 (insert (substitute-command-keys ".
2038 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
2040 (insert-button "the conditions"
2041 'action (lambda (_button) (describe-copying))
2042 'follow-link t)
2043 (insert (substitute-command-keys".
2045 (insert-button "getting the latest version"
2046 'action (lambda (_button) (describe-distribution))
2047 'follow-link t)
2048 (insert "."))
2050 (defun normal-about-screen ()
2055 (insert-button "Authors"
2056 'action
2057 (lambda (_button)
2058 (view-file (expand-file-name "AUTHORS" data-directory))
2059 (goto-char (point-min)))
2060 'follow-link t)
2063 (insert-button "Contributing"
2064 'action
2065 (lambda (_button) (info "(emacs)Contributing"))
2066 'follow-link t)
2069 (insert-button "GNU and Freedom"
2070 'action (lambda (_button) (describe-gnu-project))
2071 'follow-link t)
2074 (insert-button "Absence of Warranty"
2075 'action (lambda (_button) (describe-no-warranty))
2076 'follow-link t)
2079 (insert-button "Copying Conditions"
2080 'action (lambda (_button) (describe-copying))
2081 'follow-link t)
2084 (insert-button "Getting New Versions"
2085 'action (lambda (_button) (describe-distribution))
2086 'follow-link t)
2089 (insert-button "More Manuals / Ordering Manuals"
2090 'action (lambda (_button) (view-order-manuals))
2091 'follow-link t)
2094 (defun startup-echo-area-message ()
2095 (if (daemonp)
2096 "Starting Emacs daemon."
2097 (substitute-command-keys
2098 "For information about GNU Emacs and the GNU system, type \
2101 (defun display-startup-echo-area-message ()
2102 (let ((resize-mini-windows t))
2103 (or noninteractive ;(input-pending-p) init-file-had-error
2104 ;; t if the init file says to inhibit the echo area startup message.
2105 (and inhibit-startup-echo-area-message
2106 user-init-file
2107 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
2108 (equal inhibit-startup-echo-area-message
2109 (if (equal init-file-user "")
2110 (user-login-name)
2111 init-file-user)))
2112 ;; Wasn't set with custom; see if .emacs has a setq.
2113 (condition-case nil
2114 (with-temp-buffer
2115 (insert-file-contents user-init-file)
2116 (re-search-forward
2117 (concat
2120 (regexp-quote
2121 (prin1-to-string
2122 (if (equal init-file-user "")
2123 (user-login-name)
2124 init-file-user)))
2126 nil t))
2127 (error nil))))
2128 (message "%s" (startup-echo-area-message)))))
2130 (defun display-startup-screen (&optional concise)
2131 "Display startup screen according to display.
2132 A fancy display is used on graphic displays, normal otherwise.
2134 If CONCISE is non-nil, display a concise version of the startup
2135 screen."
2136 ;; Prevent recursive calls from server-process-filter.
2137 (if (not (get-buffer "*GNU Emacs*"))
2138 (if (use-fancy-splash-screens-p)
2139 (fancy-startup-screen concise)
2140 (normal-splash-screen t concise))))
2142 (defun display-about-screen ()
2143 "Display the *About GNU Emacs* buffer.
2144 A fancy display is used on graphic displays, normal otherwise."
2145 (interactive)
2146 (if (use-fancy-splash-screens-p)
2147 (fancy-about-screen)
2148 (normal-splash-screen nil)))
2150 (defalias 'about-emacs 'display-about-screen)
2151 (defalias 'display-splash-screen 'display-startup-screen)
2153 (defun command-line-1 (args-left)
2154 "A subroutine of `command-line'."
2155 (display-startup-echo-area-message)
2156 (when (and pure-space-overflow
2157 (not noninteractive))
2158 (display-warning
2159 'initialization
2160 "Building Emacs overflowed pure space.\
2161 (See the node Pure Storage in the Lisp manual for details.)"
2162 :warning))
2164 ;; `displayable-buffers' is a list of buffers that may be displayed,
2165 ;; which includes files parsed from the command line arguments and
2166 ;; `initial-buffer-choice'. All of the display logic happens at the
2167 ;; end of this `let'. As files as processed from the command line
2168 ;; arguments, their buffers are prepended to `displayable-buffers'.
2169 ;; In order for options like "--eval" to work with the "--file" arg,
2170 ;; the file buffers are set as the current buffer as they are seen
2171 ;; on the command line (so "emacs --batch --file a --file b
2172 ;; --eval='(message "%s" (buffer-name))'" will print "b"), but this
2173 ;; does not affect the final displayed state of the buffers.
2174 (let ((displayable-buffers nil))
2175 ;; This `let' processes the command line arguments.
2176 (let ((command-line-args-left args-left))
2177 (when command-line-args-left
2178 ;; We have command args; process them.
2179 (let* ((dir command-line-default-directory)
2180 tem
2181 ;; This approach loses for "-batch -L DIR --eval "(require foo)",
2182 ;; if foo is intended to be found in DIR.
2183 ;;
2184 ;; The directories listed in --directory/-L options will *appear*
2185 ;; at the front of `load-path' in the order they appear on the
2186 ;; command-line. We cannot do this by *placing* them at the front
2187 ;; in the order they appear, so we need this variable to hold them,
2188 ;; temporarily.
2189 ;;
2190 ;; To DTRT we keep track of the splice point and modify `load-path'
2191 ;; straight away upon any --directory/-L option.
2192 splice
2193 just-files ;; t if this follows the magic -- option.
2194 ;; This includes our standard options' long versions
2195 ;; and long versions of what's on command-switch-alist.
2196 (longopts
2197 (append '("--funcall" "--load" "--insert" "--kill"
2198 "--directory" "--eval" "--execute" "--no-splash"
2199 "--find-file" "--visit" "--file" "--no-desktop")
2200 (mapcar (lambda (elt) (concat "-" (car elt)))
2201 command-switch-alist)))
2202 (line 0)
2203 (column 0)
2204 ;; `process-file-arg' opens a file buffer for `name',
2205 ;; sets that buffer as the current buffer without
2206 ;; displaying it, adds the buffer to
2207 ;; `displayable-buffers', and puts the point at
2208 ;; `line':`column'. `line' and `column' are both reset
2209 ;; to zero when `process-file-arg' returns.
2210 (process-file-arg
2211 (lambda (name)
2212 ;; This can only happen if PWD is deleted.
2213 (if (not (or dir (file-name-absolute-p name)))
2214 (message "Ignoring relative file name (%s) due to \
2215 nil default-directory" name)
2216 (let* ((file (expand-file-name
2217 (command-line-normalize-file-name name)
2218 dir))
2219 (buf (find-file-noselect file)))
2220 (setq displayable-buffers (cons buf displayable-buffers))
2221 ;; Set the file buffer to the current buffer so
2222 ;; that it will be used with "--eval" and
2223 ;; similar options.
2224 (set-buffer buf)
2225 ;; Put the point at `line':`column' in the file
2226 ;; buffer, and reset `line' and `column' to 0.
2227 (unless (zerop line)
2228 (goto-char (point-min))
2229 (forward-line (1- line)))
2230 (setq line 0)
2231 (unless (< column 1)
2232 (move-to-column (1- column)))
2233 (setq column 0))))))
2235 ;; Add the long X options to longopts.
2236 (dolist (tem command-line-x-option-alist)
2237 (if (string-match "^--" (car tem))
2238 (push (car tem) longopts)))
2240 ;; Add the long NS options to longopts.
2241 (dolist (tem command-line-ns-option-alist)
2242 (if (string-match "^--" (car tem))
2243 (push (list (car tem)) longopts)))
2245 ;; Loop, processing options.
2246 (while command-line-args-left
2247 (let* ((argi (car command-line-args-left))
2248 (orig-argi argi)
2249 argval completion)
2250 (setq command-line-args-left (cdr command-line-args-left))
2252 ;; Do preliminary decoding of the option.
2253 (if just-files
2254 ;; After --, don't look for options; treat all args as files.
2255 (setq argi "")
2256 ;; Convert long options to ordinary options
2257 ;; and separate out an attached option argument into argval.
2259 (setq argval (substring argi (match-end 0))
2260 argi (match-string 1 argi)))
2262 (setq completion (try-completion argi longopts))
2263 (if (eq completion t)
2264 (setq argi (substring argi 1))
2265 (if (stringp completion)
2266 (let ((elt (member completion longopts)))
2267 (or elt
2268 (error "Option ‘%s’ is ambiguous" argi))
2269 (setq argi (substring (car elt) 1)))
2270 (setq argval nil
2271 argi orig-argi)))))
2273 ;; Execute the option.
2274 (cond ((setq tem (assoc argi command-switch-alist))
2275 (if argval
2276 (let ((command-line-args-left
2277 (cons argval command-line-args-left)))
2278 (funcall (cdr tem) argi))
2279 (funcall (cdr tem) argi)))
2281 ((equal argi "-no-splash")
2282 (setq inhibit-startup-screen t))
2284 ((member argi '("-f" ; what the manual claims
2285 "-funcall"
2286 "-e")) ; what the source used to say
2287 (setq inhibit-startup-screen t)
2288 (setq tem (intern (or argval (pop command-line-args-left))))
2289 (if (commandp tem)
2290 (command-execute tem)
2291 (funcall tem)))
2293 ((member argi '("-eval" "-execute"))
2294 (setq inhibit-startup-screen t)
2295 (eval (read (or argval (pop command-line-args-left)))))
2297 ((member argi '("-L" "-directory"))
2298 ;; -L :/foo adds /foo to the _end_ of load-path.
2299 (let (append)
2300 (if (string-match-p
2302 (setq tem (or argval (pop command-line-args-left))))
2303 (setq tem (substring tem 1)
2304 append t))
2305 (setq tem (expand-file-name
2306 (command-line-normalize-file-name tem)))
2307 (cond (append (setq load-path
2308 (append load-path (list tem)))
2309 (if splice (setq splice load-path)))
2310 (splice (setcdr splice (cons tem (cdr splice)))
2311 (setq splice (cdr splice)))
2312 (t (setq load-path (cons tem load-path)
2313 splice load-path)))))
2315 ((member argi '("-l" "-load"))
2316 (let* ((file (command-line-normalize-file-name
2317 (or argval (pop command-line-args-left))))
2318 ;; Take file from default dir if it exists there;
2319 ;; otherwise let `load' search for it.
2320 (file-ex (expand-file-name file)))
2321 (when (file-exists-p file-ex)
2322 (setq file file-ex))
2323 (load file nil t)))
2325 ;; This is used to handle -script. It's not clear
2326 ;; we need to document it (it is totally internal).
2327 ((member argi '("-scriptload"))
2328 (let* ((file (command-line-normalize-file-name
2329 (or argval (pop command-line-args-left))))
2330 ;; Take file from default dir.
2331 (file-ex (expand-file-name file)))
2332 (load file-ex nil t t)))
2334 ((equal argi "-insert")
2335 (setq inhibit-startup-screen t)
2336 (setq tem (or argval (pop command-line-args-left)))
2337 (or (stringp tem)
2338 (error "File name omitted from ‘-insert’ option"))
2339 (insert-file-contents (command-line-normalize-file-name tem)))
2341 ((equal argi "-kill")
2342 (kill-emacs t))
2344 ;; This is for when they use --no-desktop with -q, or
2345 ;; don't load Desktop in their .emacs. If desktop.el
2346 ;; _is_ loaded, it will handle this switch, and we
2347 ;; won't see it by the time we get here.
2348 ((equal argi "-no-desktop")
2352 (setq line (string-to-number argi)))
2355 (setq line (string-to-number (match-string 1 argi))
2356 column (string-to-number (match-string 2 argi))))
2358 ((setq tem (assoc orig-argi command-line-x-option-alist))
2359 ;; Ignore X-windows options and their args if not using X.
2360 (setq command-line-args-left
2361 (nthcdr (nth 1 tem) command-line-args-left)))
2363 ((setq tem (assoc orig-argi command-line-ns-option-alist))
2364 ;; Ignore NS-windows options and their args if not using NS.
2365 (setq command-line-args-left
2366 (nthcdr (nth 1 tem) command-line-args-left)))
2368 ((member argi '("-find-file" "-file" "-visit"))
2369 (setq inhibit-startup-screen t)
2370 ;; An explicit option to specify visiting a file.
2371 (setq tem (or argval (pop command-line-args-left)))
2372 (unless (stringp tem)
2373 (error "File name omitted from ‘%s’ option" argi))
2374 (funcall process-file-arg tem))
2376 ;; These command lines now have no effect.
2378 (display-warning 'initialization
2379 (format "Ignoring obsolete arg %s" argi)))
2381 ((equal argi "--")
2382 (setq just-files t))
2383 (t
2384 ;; We have almost exhausted our options. See if the
2385 ;; user has made any other command-line options available
2386 (let ((hooks command-line-functions)
2387 (did-hook nil))
2388 (while (and hooks
2389 (not (setq did-hook (funcall (car hooks)))))
2390 (setq hooks (cdr hooks)))
2391 (unless did-hook
2392 ;; Presume that the argument is a file name.
2394 (error "Unknown option ‘%s’" argi))
2395 ;; FIXME: Why do we only inhibit the startup
2396 ;; screen for -nw?
2397 (unless initial-window-system
2398 (setq inhibit-startup-screen t))
2399 (funcall process-file-arg orig-argi)))))
2401 ;; In unusual circumstances, the execution of Lisp code due
2402 ;; to command-line options can cause the last visible frame
2403 ;; to be deleted. In this case, kill emacs to avoid an
2404 ;; abort later.
2405 (unless (frame-live-p (selected-frame)) (kill-emacs nil)))))))
2407 (when (eq initial-buffer-choice t)
2408 ;; When `initial-buffer-choice' equals t make sure that *scratch*
2409 ;; exists.
2410 (get-buffer-create "*scratch*"))
2412 ;; If *scratch* exists and is empty, insert initial-scratch-message.
2413 ;; Do this before switching to *scratch* below to handle bug#9605.
2414 (and initial-scratch-message
2415 (get-buffer "*scratch*")
2416 (with-current-buffer "*scratch*"
2417 (when (zerop (buffer-size))
2418 (insert initial-scratch-message)
2419 (set-buffer-modified-p nil))))
2421 ;; Prepend `initial-buffer-choice' to `displayable-buffers'.
2422 (when initial-buffer-choice
2423 (let ((buf
2424 (cond ((stringp initial-buffer-choice)
2425 (find-file-noselect initial-buffer-choice))
2426 ((functionp initial-buffer-choice)
2427 (funcall initial-buffer-choice))
2428 ((eq initial-buffer-choice t)
2429 (get-buffer-create "*scratch*"))
2430 (t
2431 (error "initial-buffer-choice must be a string, a function, or t.")))))
2432 (unless (buffer-live-p buf)
2433 (error "initial-buffer-choice is not a live buffer."))
2434 (setq displayable-buffers (cons buf displayable-buffers))))
2436 ;; Display the first two buffers in `displayable-buffers'. If
2437 ;; `initial-buffer-choice' is non-nil, its buffer will be the
2438 ;; first buffer in `displayable-buffers'. The first buffer will
2439 ;; be focused.
2440 (let ((displayable-buffers-len (length displayable-buffers))
2441 ;; `nondisplayed-buffers-p' is true if there exist buffers
2442 ;; in `displayable-buffers' that were not displayed to the
2443 ;; user.
2444 (nondisplayed-buffers-p nil))
2445 (when (> displayable-buffers-len 0)
2446 (switch-to-buffer (car displayable-buffers)))
2447 (when (> displayable-buffers-len 1)
2448 (switch-to-buffer-other-window (car (cdr displayable-buffers)))
2449 ;; Focus on the first buffer.
2450 (other-window -1))
2451 (when (> displayable-buffers-len 2)
2452 (setq nondisplayed-buffers-p t))
2454 (if (or inhibit-startup-screen
2455 initial-buffer-choice
2456 noninteractive
2457 (daemonp)
2458 inhibit-x-resources)
2460 ;; Not displaying a startup screen. Display *Buffer List* if
2461 ;; there exist buffers that were not displayed.
2462 (when (and nondisplayed-buffers-p
2463 (not noninteractive)
2464 (not inhibit-startup-buffer-menu))
2465 (list-buffers))
2467 ;; Display a startup screen, after some preparations.
2469 ;; If there are no switches to process, we might as well
2470 ;; run this hook now, and there may be some need to do it
2471 ;; before doing any output.
2472 (run-hooks 'emacs-startup-hook 'term-setup-hook)
2474 ;; It's important to notice the user settings before we
2475 ;; display the startup message; otherwise, the settings
2476 ;; won't take effect until the user gives the first
2477 ;; keystroke, and that's distracting.
2478 (when (fboundp 'frame-notice-user-settings)
2479 (frame-notice-user-settings))
2481 ;; If there are no switches to process, we might as well
2482 ;; run this hook now, and there may be some need to do it
2483 ;; before doing any output.
2484 (run-hooks 'window-setup-hook)
2486 (setq inhibit-startup-hooks t)
2488 ;; ;; Do this now to avoid an annoying delay if the user
2489 ;; ;; clicks the menu bar during the sit-for.
2490 ;; (when (display-popup-menus-p)
2491 ;; (precompute-menubar-bindings))
2492 ;; (with-no-warnings
2493 ;; (setq menubar-bindings-done t))
2495 (display-startup-screen (> displayable-buffers-len 0))))))
2497 (defun command-line-normalize-file-name (file)
2498 "Collapse multiple slashes to one, to handle non-Emacs file names."
2499 (save-match-data
2500 ;; Use arg 1 so that we don't collapse // at the start of the file name.
2501 ;; That is significant on some systems.
2502 ;; However, /// at the beginning is supposed to mean just /, not //.
2503 (if (string-match
2504 (if (memq system-type '(ms-dos windows-nt))
2506 "^///+")
2507 file)
2508 (setq file (replace-match "/" t t file)))
2509 (if (memq system-type '(ms-dos windows-nt))
2511 (setq file (replace-match "/" t t file)))
2512 (while (string-match "//+" file 1)
2513 (setq file (replace-match "/" t t file))))
2514 file))
2516 ;;; startup.el ends here