| blob | 8e981bbc64aacf3267f6bfd59dc348d5f9bb8599 |
1 ;;; startup.el --- process Emacs shell arguments -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-2014 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This file parses the command line and gets Emacs running. Options
27 ;; on the command line are handled in precedence order. For priorities
28 ;; see the structure standard_args in the emacs.c file.
30 ;;; Code:
38 "Emacs start-up procedure."
42 "Buffer to show after starting Emacs.
43 If the value is nil and `inhibit-startup-screen' is nil, show the
44 startup screen. If the value is a string, switch to a buffer
45 visiting the file or directory that the string specifies. If the
46 value is a function, call it with no arguments and switch to the buffer
47 that it returns. If t, open the `*scratch*' buffer.
49 If you use `emacsclient' with no target file, then it obeys any
50 string or function value that this variable has."
55 ;; Note sure about hard-coding this as an option...
63 "Non-nil inhibits the startup screen.
65 This is for use in your personal init file (but NOT site-start.el),
66 once you are familiar with the contents of the startup screen."
75 ;; FIXME? Why does this get such weirdly extreme treatment, when the
76 ;; more important inhibit-startup-screen does not.
78 "Non-nil inhibits the initial startup echo area message.
79 Setting this variable takes effect
80 only if you do it with the customization buffer
81 or if your init file contains a line of this form:
83 If your init file is byte-compiled, use the following form
84 instead:
86 Thus, someone else using a copy of your init file will see the
87 startup message unless he personally acts to inhibit it."
93 "Non-nil inhibits loading the `default' library."
98 "Non-nil inhibits display of buffer list when more than 2 files are loaded."
103 "Alist of command-line switches.
104 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
105 HANDLER-FUNCTION receives the switch string as its sole argument;
112 "List of command-line args not yet processed.
113 This is a convenience alias, so that one can write \(pop argv\)
114 inside of --eval command line arguments in order to access
123 "List of functions to process unrecognized command-line arguments.
124 Each function should access the dynamically bound variables
125 `argi' (the current argument) and `command-line-args-left' (the remaining
126 arguments). The function should return non-nil only if it recognizes and
127 processes `argi'. If it does so, it may consume successive arguments by
131 "Default directory to use for command line arguments.
134 ;; This is here, rather than in x-win.el, so that we can ignore these
135 ;; options when we are not using X.
193 "Alist of X Windows options.
194 Each element has the form
195 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
196 where NAME is the option name string, NUMARGS is the number of arguments
197 that the option accepts, HANDLER is a function to call to handle the option.
198 FRAME-PARAM (optional) is the frame parameter this option specifies,
199 and VALUE is the value which is given to that frame parameter
214 ;;("-bw" . x-handle-numeric-switch)
215 ;;("-d" . x-handle-display)
216 ;;("-display" . x-handle-display)
232 ; ("-ms" 1 x-handle-switch mouse-color)
236 ;;("-xrm" . x-handle-xrm-switch)
241 ;; ("--border-width" 1 x-handle-numeric-switch border-width)
242 ;; ("--display" 1 ns-handle-display)
248 ;; ("--geometry" 1 ns-handle-geometry)
254 ;; ("--xrm" 1 ns-handle-xrm-switch)
258 "Alist of NS options.
259 Each element has the form
260 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
261 where NAME is the option name string, NUMARGS is the number of arguments
262 that the option accepts, HANDLER is a function to call to handle the option.
263 FRAME-PARAM (optional) is the frame parameter this option specifies,
264 and VALUE is the value which is given to that frame parameter
272 "Normal hook run after initializing the Emacs session.
273 It is run after Emacs loads the init file, `default' library, the
274 abbrevs file, and additional Lisp packages (if any), and setting
275 the value of `after-init-time'.
277 There is no `condition-case' around the running of this hook;
278 therefore, if `debug-on-error' is non-nil, an error in one of
285 "Normal hook run immediately after `emacs-startup-hook'.
286 In new code, there is no reason to use this instead of `emacs-startup-hook'.
287 If you want to execute terminal-specific Lisp code, for example
288 to override the definitions made by the terminal-specific file,
292 "use either `emacs-startup-hook' or \
296 "Non-nil means don't run some startup hooks, because we already did.
297 Currently this applies to: `emacs-startup-hook', `term-setup-hook',
301 "The brand of keyboard you are using.
302 This variable is used to define the proper function and keypad
303 keys for use under X. It is used in a fashion analogous to the
307 "Normal hook run after loading init files and handling the command line.
308 This is very similar to `emacs-startup-hook'. The only difference
309 is that this hook runs after frame parameters have been set up in
310 response to any settings from your init file. Unless this matters
311 to you, use `emacs-startup-hook' instead. (The name of this hook
315 "Major mode command symbol to use for the initial `*scratch*' buffer."
320 "Identity of user whose init file is or was read.
321 The value is nil if `-q' or `--no-init-file' was specified,
322 meaning do not load any init file.
324 Otherwise, the value may be an empty string, meaning
325 use the init file for the user who originally logged in,
326 or it may be a string containing a user's name meaning
327 use that person's init file.
330 evaluates to the name of the directory where the init file was
331 looked for.
333 Setting `init-file-user' does not prevent Emacs from loading
337 "File containing site-wide run-time initializations.
338 This file is loaded at run-time before `~/.emacs'. It contains inits
339 that need to be in place for the entire site, but which, due to their
340 higher incidence of change, don't make sense to load into Emacs's
341 dumped image. Thus, the run-time load order is: 1. file described in
342 this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.
344 Don't use the `site-start.el' file for things some users may not like.
345 Put them in `default.el' instead, so that users can more easily
346 override them. Users can prevent loading `default.el' with the `-q'
347 option or by setting `inhibit-default-init' in their own init files,
348 but inhibiting `site-start.el' requires `--no-site-file', which
349 is less convenient.
351 This variable is defined for customization so as to make
352 it visible in the relevant context. However, actually customizing it
353 is not allowed, since it would not work anyway. The only way to set
354 this variable usefully is to set it while building and dumping Emacs."
362 "Name of this machine, for purposes of naming users.
363 If non-nil, Emacs uses this instead of `system-name' when constructing
364 email addresses."
373 ;; Empty string means "not set yet".
375 "Full mailing address of this user.
376 This is initialized with environment variable `EMAIL' or, as a
377 fallback, using `mail-host-address'. This is done after your
378 init file is read, in case it sets `mail-host-address'."
384 ;; MS-DOS cannot have initial dot, and allows only 8.3 names
388 "Prefix for generating `auto-save-list-file-name'.
389 This is used after reading your init file to initialize
390 `auto-save-list-file-name', by appending Emacs's pid and the system name,
391 if you have not already set `auto-save-list-file-name' yourself.
392 Directories in the prefix will be created if necessary.
393 Set this to nil if you want to prevent `auto-save-list-file-name'
394 from being initialized."
396 string)
414 Warning Warning!!! Pure space overflow !!!Warning Warning
419 "Directory containing the Emacs TUTORIAL files."
425 "Add all subdirectories of `default-directory' to `load-path'.
426 More precisely, this uses only the subdirectories whose names
427 start with letters or digits; it excludes any subdirectory named `RCS'
428 or `CVS', and any subdirectory that contains a file named `.nosearch'."
430 attrs
432 ;; This loop does a breadth-first tree walk on DIR's subtree,
433 ;; putting each subdir into DIRS as its contents are examined.
441 ;; The Windows version doesn't report meaningful inode numbers, so
442 ;; use the canonicalized absolute file name of the directory instead.
449 ;; The lower-case variants of RCS and CVS are for DOS/Windows.
451 ;; Avoid doing a `stat' when it isn't necessary because
452 ;; that can cause trouble when an NFS server is down.
461 "This function is called from a subdirs.el file.
462 It assumes that `default-directory' is the directory in which the
463 subdirs.el file exists, and it adds to `load-path' the subdirs of
464 that directory as specified in DIRS. Normally the elements of
465 DIRS are relative."
469 ;;Don't go all the way to the nil terminator.
475 ;;Splice the new section in.
480 "Emacs calls this function when it first starts up.
481 It sets `command-line-processed', processes the command-line,
482 reads the initialization files, etc.
483 It is the default value of the variable `top-level'."
488 ;; Look in each dir in load-path for a subdirs.el file. If we
489 ;; find one, load it, which will add the appropriate subdirs of
490 ;; that dir into load-path. This needs to be done before setting
491 ;; the locale environment, because the latter might need to load
492 ;; some support files.
493 ;; Look for a leim-list.el file too. Loading it will register
494 ;; available input methods.
497 dir)
502 ;; Do not scan standard directories that won't contain a leim-list.el.
503 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-10/msg00502.html
504 ;; (Except the preloaded one in lisp/leim.)
508 ;; We don't use a dolist loop and we put this "setq-cdr" command at
509 ;; the end, because the subdirs.el files may add elements to the end
510 ;; of load-path and we want to take it into account.
513 ;; Set the default strings to display in mode line for end-of-line
514 ;; formats that aren't native to this platform. This should be
515 ;; done before calling set-locale-environment, as the latter might
516 ;; use these mnemonics.
526 ;; Decode all default-directory's (probably, only *scratch* exists
527 ;; at this point). default-directory of *scratch* is the basis
528 ;; for many other file-name variables and directory lists, so it
529 ;; is important to decode it ASAP.
532 ;; MS-Windows build converts all file names to
533 ;; UTF-8 during startup.
534 'utf-8
535 locale-coding-system)))
543 ;; Decode all the important variables and directory lists, now
544 ;; that we know the locale's encoding. This is because the
545 ;; values of these variables are until here unibyte undecoded
546 ;; strings created by build_unibyte_string. data-directory in
547 ;; particular is used to construct many other standard
548 ;; directory names, so it must be decoded ASAP. Note that
549 ;; charset-map-path cannot be decoded here, since we could
550 ;; then be trapped in infinite recursion below, when we load
551 ;; subdirs.el, because encoding a directory name might need to
552 ;; load a charset map, which will want to encode
553 ;; charset-map-path, which will want to load the same charset
554 ;; map... So decoding of charset-map-path is delayed until
555 ;; further down below.
561 path)))))
563 installation-directory
564 invocation-directory invocation-name
565 source-directory
566 shared-game-score-directory))
574 ;; Make it easy to do like "tail -f".
576 ;; Give *Messages* the same default-directory as *scratch*,
577 ;; just to keep things predictable.
579 ;; `user-full-name' is now known; reset its standard-value here.
582 ;; If the PWD environment variable isn't accurate, delete it.
585 ;; Use FOO/., so that if FOO is a symlink, file-attributes
586 ;; describes the directory linked to, not FOO itself.
594 process-environment)))))
595 ;; Now, that other directories were searched, and any charsets we
596 ;; need for encoding them are already loaded, we are ready to
597 ;; decode charset-map-path.
600 'utf-8
601 locale-coding-system)))
605 charset-map-path))))
610 ;; Do this again, in case .emacs defined more abbreviations.
612 ;; Specify the file for recording all the auto save files of this session.
613 ;; This is used by recover-session.
617 ;; Under MS-DOS our PID is almost always reused between
618 ;; Emacs invocations. We need something more unique.
620 ;; We are going to access the auto-save
621 ;; directory, so make sure it exists.
624 t)
628 auto-save-list-file-prefix))
633 auto-save-list-file-prefix
639 ;; Don't do this if we failed to create the initial frame,
640 ;; for instance due to a dense colormap.
642 ;; If frame-initial-frame has no meaning, do this anyway.
647 ;; FIXME: The user's init file may change
648 ;; face-font-rescale-alist. However, the default face
649 ;; already has an assigned font object, which does not take
650 ;; face-font-rescale-alist into account. For such
651 ;; situations, we ought to have a way to find all font
652 ;; objects and regenerate them; currently we do not. As a
653 ;; workaround, we specifically reset te default face's :font
654 ;; attribute here. See bug#1785.
656 old-face-font-rescale-alist)
659 ;; Modify the initial frame based on what .emacs puts into
660 ;; ...-frame-alist.
663 ;; Set the faces for the initial background mode even if
664 ;; frame-notice-user-settings didn't (such as on a tty).
665 ;; frame-set-background-mode is idempotent, so it won't
666 ;; cause any harm if it's already been done.
670 ;; Now we know the user's default font, so add it to the menu.
675 ;; Subprocesses of Emacs do not have direct access to the terminal, so
676 ;; unless told otherwise they should only assume a dumb terminal.
677 ;; We are careful to do it late (after term-setup-hook), although the
678 ;; new multi-tty code does not use $TERM any more there anyway.
680 ;; Remove DISPLAY from the process-environment as well. This allows
681 ;; `callproc.c' to give it a useful adaptive default which is either
682 ;; the value of the `display' frame-parameter or the DISPLAY value
683 ;; from initial-environment.
685 ;; Be careful which DISPLAY to remove from process-environment: follow
686 ;; the logic of `callproc.c'.
694 ;; Precompute the keyboard equivalents in the menu bar items.
695 ;; Command-line options supported by tty's:
708 "Method for processing window-system dependent command-line arguments.
709 Window system startup files should add their own function to this
710 method, which should parse the command line arguments. Those
711 pertaining to the window system should be processed and removed
715 "Method for window-system initialization.
716 Window-system startup files should add their own implementation
717 to this method. The function should take no arguments,
718 and initialize the window system environment to prepare for
728 argval completion)
729 ;; Check for long options with attached arguments
730 ;; and separate out the attached option argument into argval.
737 ;; Exact match for long option.
741 ;; Check for abbreviated long option.
745 ;; Check for a short option.
747 argi orig-argi))))
750 default-frame-alist))
753 default-frame-alist))
758 argval
760 i)
763 ;; Change any . or * characters in name to
764 ;; hyphens, so as to emulate behavior on X.
768 argval)))
769 default-frame-alist))
772 default-frame-alist))
781 default-frame-alist))
795 "A subroutine of `normal-top-level'.
796 Amongst another things, it parses the command-line arguments."
798 after-init-time nil
799 command-line-default-directory default-directory)
801 ;; Force recomputation, in case it was computed during the dump.
804 ;; See if we should import version-control from the environment variable.
814 ;;! This has been commented out; I currently find the behavior when
815 ;;! split-window-keep-point is nil disturbing, but if I can get used
816 ;;! to it, then it would be better to eliminate the option.
817 ;;! ;; Choose a good default value for split-window-keep-point.
818 ;;! (setq split-window-keep-point (> baud-rate 2400))
820 ;; Convert preloaded file names in load-history to absolute.
822 ;; Look for simple.el or simple.elc and use their directory
823 ;; as the place where all Lisp files live.
825 lisp-dir)
826 ;; Don't abort if simple.el cannot be found, but print a warning.
827 ;; Although in most usage we are going to cryptically abort a moment
828 ;; later anyway, due to missing required bidi data files (eg bug#13430).
849 elt))
850 load-history))))
852 ;; Convert the arguments to Emacs internal representation.
861 display-arg)
863 ;; Figure out which user's init file to load,
864 ;; either from the environment or from the options.
866 ;; If user has not done su, use current $HOME to find .emacs.
871 ;; Process the command-line args, and delete the arguments
872 ;; processed. This is consistent with the way main in emacs.c
873 ;; does things.
880 argval)
881 ;; Handle --OPTION=VALUE format.
896 argi orig-argi)))))
898 ;; The --display arg is handled partly in C, partly in Lisp.
899 ;; When it shows up here, we just put it back to be handled
900 ;; by `command-line-1'.
905 site-run-file nil
906 inhibit-x-resources t))
909 emacs-basic-display t)
915 argval nil))
924 ;; Push the popped arg back on the list of arguments.
928 ;; Was argval set but not used?
932 ;; Re-attach the --display arg.
935 ;; Re-attach the program name to the front of the arg list.
939 ;; Make sure window system's init file was loaded in loadup.el if
940 ;; using a window system.
941 ;; Initialize the window-system only after processing the command-line
942 ;; args so that -Q can influence this initialization.
950 ;; Process window-system specific command line parameters.
954 command-line-args))
955 ;; Initialize the window system. (Open connection, etc.)
959 ;; If there was an error, print the error message and exit.
980 ;; Under X, create the X frame and delete the terminal frame.
984 tool-bar-mode nil
985 no-blinking-cursor t))
989 ;; Set up the tool-bar (even in tty frames, since Emacs might open a
990 ;; graphical frame later).
994 ;; Turn off blinking cursor if so specified in X resources. This is here
995 ;; only because all other settings of no-blinking-cursor are here.
997 emacs-basic-display
1003 ;; Re-evaluate predefined variables whose initial value depends on
1004 ;; the runtime context.
1006 ;; Initialize them in the same order they were loaded, in case there
1007 ;; are dependencies between them.
1013 ;; Register default TTY colors for the case the terminal hasn't a
1014 ;; terminal init file. We do this regardless of whether the terminal
1015 ;; supports colors or not and regardless the current display type,
1016 ;; since users can connect to color-capable terminals and also
1017 ;; switch color support on or off in mid-session by setting the
1018 ;; tty-color-mode frame parameter.
1019 ;; Exception: the `pc' ``window system'' has only 16 fixed colors,
1020 ;; and they are already set at this point by a suitable function in
1021 ;; window-system-initialization-alist.
1028 ;; Run the site-start library if it exists. The point of this file is
1029 ;; that it is run before .emacs. There is no point in doing this after
1030 ;; .emacs; that is useless.
1031 ;; Note that user-init-file is nil at this point. Code that might
1032 ;; be loaded from site-run-file and wants to test if -q was given
1033 ;; should check init-file-user instead, since that is already set.
1034 ;; See cus-edit.el for an example.
1038 ;; Sites should not disable this. Only individuals should disable
1039 ;; the startup screen.
1042 ;; Warn for invalid user name.
1047 init-file-user)
1050 ;; We don't support ~USER on MS-Windows
1051 ;; and MS-DOS except for the current
1052 ;; user, and always load .emacs from
1053 ;; the current user's home directory
1054 ;; (see below). So always check "~",
1055 ;; even if invoked with "-u USER", or
1056 ;; if $USER or $LOGNAME are set to
1057 ;; something different.
1059 "~"
1061 nil
1066 init-file-user))
1069 ;; Load that user's init file, or the default one, or none.
1071 debug-on-error-should-be-set
1076 ;; This function actually reads the init files.
1087 ;; Else deal with the Windows situation
1089 ;; Prefer .emacs on Windows.
1092 ;; Also support _emacs for compatibility, but warn about it.
1095 delayed-warnings-list)
1099 ;; This tells `load' to store the file name found
1100 ;; into user-init-file.
1105 ;; If we did not find ~/.emacs, try
1106 ;; ~/.emacs.d/init.el.
1109 "init"
1114 ;; If we did not find the user's init file,
1115 ;; set user-init-file conclusively.
1116 ;; Don't let it be set from default.el.
1120 ;; If we loaded a compiled file, set
1121 ;; `user-init-file' to the source version if that
1122 ;; exists.
1134 source user-init-file)
1140 ;; Users are supposed to be told their rights.
1141 ;; (Plus how to get help and how to undo.)
1142 ;; Don't you dare turn this off for anyone
1143 ;; except yourself.
1146 ;; Do this without a condition-case if the user wants to debug.
1153 ;; Postpone displaying the warning until all hooks
1154 ;; in `after-init-hook' like `desktop-read' will finalize
1155 ;; possible changes in the window configuration.
1157 'after-init-hook
1160 'initialization
1162 To ensure normal operation, you should investigate and remove the
1163 cause of the error in your initialization file. Start Emacs with
1164 the `--debug-init' option to view a complete error backtrace."
1165 user-init-file
1171 t)
1178 ;; If the user has a file of abbrevs, read it (unless -batch).
1184 ;; If the abbrevs came entirely from the init file or the
1185 ;; abbrevs file, they do not need saving.
1188 ;; If we can tell that the init file altered debug-on-error,
1189 ;; arrange to preserve the value that it set up.
1192 debug-on-error-from-init-file debug-on-error)))
1198 ;; Init file changed to unibyte. Reset existing multibyte
1199 ;; buffers (probably *scratch*, *Messages*, *Minibuf-0*).
1200 ;; Arguably this should only be done if they're free of
1201 ;; multibyte characters.
1207 ;; Also re-set the language environment in case it was
1208 ;; originally done before unibyte was set and is sensitive to
1209 ;; unibyte (display table, terminal coding system &c).
1212 ;; Do this here in case the init file sets mail-host-address.
1219 ;; If parameter have been changed in the init file which influence
1220 ;; face realization, clear the face cache so that new faces will
1221 ;; be realized.
1226 ;; If any package directory exists, initialize the package system.
1228 package-enable-at-startup
1238 package-user-dir
1240 dirs)
1249 subdir))))
1256 ;; If *scratch* exists and init file didn't change its mode, initialize it.
1262 ;; Load library for our terminal type.
1263 ;; User init file can set term-file-prefix to nil to prevent this.
1265 initial-window-system
1269 ;; Update the out-of-memory error message based on user's key bindings
1270 ;; for save-some-buffers.
1273 (substitute-command-keys "Memory exhausted--use \\[save-some-buffers] then exit and restart Emacs")))
1275 ;; Process the remaining args.
1278 ;; This is a problem because, e.g. if emacs.d/gnus.el exists,
1279 ;; trying to load gnus could load the wrong file.
1280 ;; OK, it would not matter if .emacs.d were at the end of load-path.
1281 ;; but for the sake of simplicity, we discourage it full-stop.
1282 ;; Ref eg http://lists.gnu.org/archive/html/emacs-devel/2012-03/msg00056.html
1283 ;;
1284 ;; A bad element could come from user-emacs-file, the command line,
1285 ;; or EMACSLOADPATH, so we basically always have to check.
1297 Consider using a subdirectory instead, e.g.: %s"
1302 ;; If -batch, terminate after processing the command options.
1305 ;; In daemon mode, start the server to allow clients to connect.
1306 ;; This is done after loading the user's init file and after
1307 ;; processing all command line arguments to allow e.g. `server-name'
1308 ;; to be changed before the server starts.
1317 "Unable to start daemon: Emacs server named %S already running"
1318 server-name)
1319 (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."))
1322 ;; Run emacs-session-restore (session management) if started by
1323 ;; the session manager and we have a session manager connection.
1330 "Apply X resources which specify initial values for Emacs variables.
1331 This is called from a window-system initialization function, such
1332 as `x-initialize-window-system' for X, either at startup (prior
1333 to reading the init file), or afterwards when the user first
1334 opens a graphical frame.
1336 This can set the values of `menu-bar-mode', `tool-bar-mode', and
1337 `no-blinking-cursor', as well as the `cursor' face. Changed
1353 ;; This buffer is for notes you don't want to save, and for Lisp evaluation.
1354 ;; If you want to create a file, visit that file with C-x C-f,
1355 ;; then enter the text in that file's own buffer.
1358 "Initial message displayed in *scratch* buffer at startup.
1359 If this is nil, no message will be displayed."
1364 \f
1365 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1366 ;;; Fancy splash screen
1367 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1371 "Welcome to "
1375 ", one component of the "
1376 :link
1386 :face variable-pitch
1393 en))
1397 ;; We used to read only the first 256 bytes of
1398 ;; the tutorial, but that prevents the coding:
1399 ;; setting, if any, in file-local variables
1400 ;; section to be seen by insert-file-contents,
1401 ;; and results in gibberish when the language
1402 ;; environment's preferred encoding is
1403 ;; different from what the file-local variable
1404 ;; says. One case in point is Hebrew.
1405 nil)
1408 ;; If there is a specific tutorial for the current language
1409 ;; environment and it is not English, append its title.
1411 ""
1425 :face variable-pitch
1431 "A list of texts to show in the middle part of splash screens.
1432 Each element in the list should be a list of strings or pairs
1437 "This is "
1441 ", one component of the "
1442 :link
1459 :face variable-pitch
1475 :face variable-pitch
1489 en))
1493 ;; Read the entire file, to make sure any
1494 ;; coding cookies and other local variables
1495 ;; get acted upon.
1496 nil)
1499 ;; If there is a specific tutorial for the current language
1500 ;; environment and it is not English, append its title.
1502 ""
1510 "A list of texts to show in the middle part of the About screen.
1511 Each element in the list should be a list of strings or pairs
1516 "Fancy splash screen when Emacs starts."
1521 "The image to show in the splash screens, or nil for defaults."
1535 map)
1538 ;; These are temporary storage areas for the splash screen display.
1541 "Insert text into the current buffer, with faces.
1542 Arguments from ARGS should be either strings; functions called
1543 with no args that return a string; pairs `:face FACE', where FACE
1544 is a face specification usable with `put-text-property'; or pairs
1545 `:link LINK' where LINK is a list of arguments to pass to
1546 `insert-button', of the form (LABEL ACTION [HELP-ECHO]), which
1547 specifies the button's label, `action' property and help-echo string.
1548 FACE and LINK can also be functions, which are evaluated to obtain
1549 a face or button specification."
1571 it))
1572 'face current-face
1583 "splash.xpm"
1596 "Insert the head part of the splash screen into the current buffer."
1603 ;; Center the image in the window.
1607 ;; Change the color of the XPM version of the splash image
1608 ;; so that it is visible with a dark frame background.
1613 ;; Insert the image with a help-echo and a link.
1622 "Insert the tail part of the splash screen into the current buffer."
1630 " "
1634 " "
1648 emacs-copyright
1653 files)
1654 ;; Don't warn if the directory for auto-save-list files does not
1655 ;; yet exist.
1688 " "
1689 :on-glyph checked
1690 :off-glyph unchecked
1698 nil))
1707 "Stop displaying the splash screen buffer."
1712 "Display fancy startup screen.
1713 If CONCISE is non-nil, display a concise version of the
1714 splash screen in another window."
1735 buffer-read-only t)
1744 ;; If the splash screen is in a split window, fit it.
1753 "Display fancy About screen."
1778 "Return the frame to use for the fancy splash screen.
1779 Returning non-nil does not mean we should necessarily
1780 use the fancy splash screen, but if we do use it,
1781 we put it on this frame."
1783 ;; MS-Windows needs this to have a chance to make the initial
1784 ;; frame visible.
1791 chosen-frame))
1794 "Return t if fancy splash screens should be used."
1803 ;; We test frame-height so that, if the frame is split
1804 ;; by displaying a warning, that doesn't cause the normal
1805 ;; splash screen to be used.
1811 "Display non-graphic splash screen.
1812 If optional argument STARTUP is non-nil, display the startup screen
1813 after Emacs starts. If STARTUP is nil, display the About screen.
1814 If CONCISE is non-nil, display a concise version of the
1815 splash screen in another window."
1826 ;; The convention for this piece of code is that
1827 ;; each piece of output starts with one or two newlines
1828 ;; and does not end with any newlines.
1837 ;; The user can use the mouse to activate menus
1838 ;; so give help in terms of menu items.
1841 ;; No mouse menus, so give help using kbd commands.
1846 ;; The rest of the startup screen is the same on all
1847 ;; kinds of terminals.
1849 ;; Give information on recovering, if there was a crash.
1851 auto-save-list-file-prefix
1852 ;; Don't signal an error if the
1853 ;; directory for auto-save-list files
1854 ;; does not yet exist.
1856 auto-save-list-file-prefix))
1859 nil
1862 auto-save-list-file-prefix)))
1863 t)
1870 ;; Display the input that we set up in the buffer.
1882 ;; The user can use the mouse to activate menus
1883 ;; so give help in terms of menu items.
1885 To follow a link, click Mouse-1 on it, or move to it and type RET.
1928 "Show a splash screen suitable for displays without mouse support."
1930 ;; If normal-erase-is-backspace is used on a tty, there's
1931 ;; no way to invoke C-h and you have to use F1 instead.
1936 ;; If C-h can't be invoked, temporarily disable its
1937 ;; binding, so where-is uses alternative bindings.
1940 map))
1941 minor-mode-overriding-map-alist)))
1969 ;; Say how to use the menu bar with the keyboard.
1976 (insert " F10 or ESC ` or M-`")
1979 ;; Many users seem to have problems with these.
1980 (insert "
1981 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
1982 If you have no Meta key, you may instead type ESC followed by the character.)")
1984 ;; Insert links to useful tasks
1987 (insert-button "Visit New File"
1988 'action (lambda (_button) (call-interactively 'find-file))
1989 'follow-link t)
1991 (insert-button "Open Home Directory"
1992 'action (lambda (_button) (dired "~"))
1993 'follow-link t)
1996 (insert-button "Customize Startup"
1997 'action (lambda (_button) (customize-group 'initialization))
1998 'follow-link t)
2000 (insert-button "Open *scratch* buffer"
2001 'action (lambda (_button) (switch-to-buffer
2002 (get-buffer-create "*scratch*")))
2003 'follow-link t)
2006 (insert (substitute-command-keys
2007 "
2009 (insert-button "full details"
2010 'action (lambda (_button) (describe-no-warranty))
2011 'follow-link t)
2012 (insert (substitute-command-keys ".
2013 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
2015 (insert-button "the conditions"
2016 'action (lambda (_button) (describe-copying))
2017 'follow-link t)
2018 (insert (substitute-command-keys".
2020 (insert-button "getting the latest version"
2021 'action (lambda (_button) (describe-distribution))
2022 'follow-link t)
2023 (insert "."))
2025 (defun normal-about-screen ()
2030 (insert-button "Authors"
2031 'action
2032 (lambda (_button)
2033 (view-file (expand-file-name "AUTHORS" data-directory))
2034 (goto-char (point-min)))
2035 'follow-link t)
2038 (insert-button "Contributing"
2039 'action
2040 (lambda (_button) (info "(emacs)Contributing"))
2041 'follow-link t)
2044 (insert-button "GNU and Freedom"
2045 'action (lambda (_button) (describe-gnu-project))
2046 'follow-link t)
2049 (insert-button "Absence of Warranty"
2050 'action (lambda (_button) (describe-no-warranty))
2051 'follow-link t)
2054 (insert-button "Copying Conditions"
2055 'action (lambda (_button) (describe-copying))
2056 'follow-link t)
2059 (insert-button "Getting New Versions"
2060 'action (lambda (_button) (describe-distribution))
2061 'follow-link t)
2064 (insert-button "More Manuals / Ordering Manuals"
2065 'action (lambda (_button) (view-order-manuals))
2066 'follow-link t)
2069 (defun startup-echo-area-message ()
2070 (if (daemonp)
2071 "Starting Emacs daemon."
2072 (substitute-command-keys
2073 "For information about GNU Emacs and the GNU system, type \
2076 (defun display-startup-echo-area-message ()
2077 (let ((resize-mini-windows t))
2078 (or noninteractive ;(input-pending-p) init-file-had-error
2079 ;; t if the init file says to inhibit the echo area startup message.
2080 (and inhibit-startup-echo-area-message
2081 user-init-file
2082 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
2083 (equal inhibit-startup-echo-area-message
2084 (if (equal init-file-user "")
2085 (user-login-name)
2086 init-file-user)))
2087 ;; Wasn't set with custom; see if .emacs has a setq.
2088 (condition-case nil
2089 (with-temp-buffer
2090 (insert-file-contents user-init-file)
2091 (re-search-forward
2092 (concat
2095 (regexp-quote
2096 (prin1-to-string
2097 (if (equal init-file-user "")
2098 (user-login-name)
2099 init-file-user)))
2101 nil t))
2102 (error nil))))
2103 (message "%s" (startup-echo-area-message)))))
2105 (defun display-startup-screen (&optional concise)
2106 "Display startup screen according to display.
2107 A fancy display is used on graphic displays, normal otherwise.
2109 If CONCISE is non-nil, display a concise version of the startup
2110 screen."
2111 ;; Prevent recursive calls from server-process-filter.
2112 (if (not (get-buffer "*GNU Emacs*"))
2113 (if (use-fancy-splash-screens-p)
2114 (fancy-startup-screen concise)
2115 (normal-splash-screen t concise))))
2117 (defun display-about-screen ()
2118 "Display the *About GNU Emacs* buffer.
2119 A fancy display is used on graphic displays, normal otherwise."
2120 (interactive)
2121 (if (use-fancy-splash-screens-p)
2122 (fancy-about-screen)
2123 (normal-splash-screen nil)))
2125 (defalias 'about-emacs 'display-about-screen)
2126 (defalias 'display-splash-screen 'display-startup-screen)
2128 (defun command-line-1 (args-left)
2129 "A subroutine of `command-line'."
2130 (display-startup-echo-area-message)
2131 (when (and pure-space-overflow
2132 (not noninteractive))
2133 (display-warning
2134 'initialization
2135 "Building Emacs overflowed pure space.\
2136 (See the node Pure Storage in the Lisp manual for details.)"
2137 :warning))
2139 (let ((file-count 0)
2140 (command-line-args-left args-left)
2141 first-file-buffer)
2142 (when command-line-args-left
2143 ;; We have command args; process them.
2144 (let ((dir command-line-default-directory)
2145 tem
2146 ;; This approach loses for "-batch -L DIR --eval "(require foo)",
2147 ;; if foo is intended to be found in DIR.
2148 ;;
2149 ;; The directories listed in --directory/-L options will *appear*
2150 ;; at the front of `load-path' in the order they appear on the
2151 ;; command-line. We cannot do this by *placing* them at the front
2152 ;; in the order they appear, so we need this variable to hold them,
2153 ;; temporarily.
2154 ;;
2155 ;; To DTRT we keep track of the splice point and modify `load-path'
2156 ;; straight away upon any --directory/-L option.
2157 splice
2158 just-files ;; t if this follows the magic -- option.
2159 ;; This includes our standard options' long versions
2160 ;; and long versions of what's on command-switch-alist.
2161 (longopts
2162 (append '("--funcall" "--load" "--insert" "--kill"
2163 "--directory" "--eval" "--execute" "--no-splash"
2164 "--find-file" "--visit" "--file" "--no-desktop")
2165 (mapcar (lambda (elt) (concat "-" (car elt)))
2166 command-switch-alist)))
2167 (line 0)
2168 (column 0))
2170 ;; Add the long X options to longopts.
2171 (dolist (tem command-line-x-option-alist)
2172 (if (string-match "^--" (car tem))
2173 (push (car tem) longopts)))
2175 ;; Add the long NS options to longopts.
2176 (dolist (tem command-line-ns-option-alist)
2177 (if (string-match "^--" (car tem))
2178 (push (list (car tem)) longopts)))
2180 ;; Loop, processing options.
2181 (while command-line-args-left
2182 (let* ((argi (car command-line-args-left))
2183 (orig-argi argi)
2184 argval completion)
2185 (setq command-line-args-left (cdr command-line-args-left))
2187 ;; Do preliminary decoding of the option.
2188 (if just-files
2189 ;; After --, don't look for options; treat all args as files.
2190 (setq argi "")
2191 ;; Convert long options to ordinary options
2192 ;; and separate out an attached option argument into argval.
2194 (setq argval (substring argi (match-end 0))
2195 argi (match-string 1 argi)))
2197 (setq completion (try-completion argi longopts))
2198 (if (eq completion t)
2199 (setq argi (substring argi 1))
2200 (if (stringp completion)
2201 (let ((elt (member completion longopts)))
2202 (or elt
2203 (error "Option `%s' is ambiguous" argi))
2204 (setq argi (substring (car elt) 1)))
2205 (setq argval nil
2206 argi orig-argi)))))
2208 ;; Execute the option.
2209 (cond ((setq tem (assoc argi command-switch-alist))
2210 (if argval
2211 (let ((command-line-args-left
2212 (cons argval command-line-args-left)))
2213 (funcall (cdr tem) argi))
2214 (funcall (cdr tem) argi)))
2216 ((equal argi "-no-splash")
2217 (setq inhibit-startup-screen t))
2219 ((member argi '("-f" ; what the manual claims
2220 "-funcall"
2221 "-e")) ; what the source used to say
2222 (setq inhibit-startup-screen t)
2223 (setq tem (intern (or argval (pop command-line-args-left))))
2224 (if (commandp tem)
2225 (command-execute tem)
2226 (funcall tem)))
2228 ((member argi '("-eval" "-execute"))
2229 (setq inhibit-startup-screen t)
2230 (eval (read (or argval (pop command-line-args-left)))))
2232 ((member argi '("-L" "-directory"))
2233 ;; -L :/foo adds /foo to the _end_ of load-path.
2234 (let (append)
2235 (if (string-match-p
2237 (setq tem (or argval (pop command-line-args-left))))
2238 (setq tem (substring tem 1)
2239 append t))
2240 (setq tem (expand-file-name
2241 (command-line-normalize-file-name tem)))
2242 (cond (append (setq load-path
2243 (append load-path (list tem)))
2244 (if splice (setq splice load-path)))
2245 (splice (setcdr splice (cons tem (cdr splice)))
2246 (setq splice (cdr splice)))
2247 (t (setq load-path (cons tem load-path)
2248 splice load-path)))))
2250 ((member argi '("-l" "-load"))
2251 (let* ((file (command-line-normalize-file-name
2252 (or argval (pop command-line-args-left))))
2253 ;; Take file from default dir if it exists there;
2254 ;; otherwise let `load' search for it.
2255 (file-ex (expand-file-name file)))
2256 (when (file-exists-p file-ex)
2257 (setq file file-ex))
2258 (load file nil t)))
2260 ;; This is used to handle -script. It's not clear
2261 ;; we need to document it (it is totally internal).
2262 ((member argi '("-scriptload"))
2263 (let* ((file (command-line-normalize-file-name
2264 (or argval (pop command-line-args-left))))
2265 ;; Take file from default dir.
2266 (file-ex (expand-file-name file)))
2267 (load file-ex nil t t)))
2269 ((equal argi "-insert")
2270 (setq inhibit-startup-screen t)
2271 (setq tem (or argval (pop command-line-args-left)))
2272 (or (stringp tem)
2273 (error "File name omitted from `-insert' option"))
2274 (insert-file-contents (command-line-normalize-file-name tem)))
2276 ((equal argi "-kill")
2277 (kill-emacs t))
2279 ;; This is for when they use --no-desktop with -q, or
2280 ;; don't load Desktop in their .emacs. If desktop.el
2281 ;; _is_ loaded, it will handle this switch, and we
2282 ;; won't see it by the time we get here.
2283 ((equal argi "-no-desktop")
2287 (setq line (string-to-number argi)))
2290 (setq line (string-to-number (match-string 1 argi))
2291 column (string-to-number (match-string 2 argi))))
2293 ((setq tem (assoc orig-argi command-line-x-option-alist))
2294 ;; Ignore X-windows options and their args if not using X.
2295 (setq command-line-args-left
2296 (nthcdr (nth 1 tem) command-line-args-left)))
2298 ((setq tem (assoc orig-argi command-line-ns-option-alist))
2299 ;; Ignore NS-windows options and their args if not using NS.
2300 (setq command-line-args-left
2301 (nthcdr (nth 1 tem) command-line-args-left)))
2303 ((member argi '("-find-file" "-file" "-visit"))
2304 (setq inhibit-startup-screen t)
2305 ;; An explicit option to specify visiting a file.
2306 (setq tem (or argval (pop command-line-args-left)))
2307 (unless (stringp tem)
2308 (error "File name omitted from `%s' option" argi))
2309 (setq file-count (1+ file-count))
2310 (let ((file (expand-file-name
2311 (command-line-normalize-file-name tem)
2312 dir)))
2313 (if (= file-count 1)
2314 (setq first-file-buffer (find-file file))
2315 (find-file-other-window file)))
2316 (unless (zerop line)
2317 (goto-char (point-min))
2318 (forward-line (1- line)))
2319 (setq line 0)
2320 (unless (< column 1)
2321 (move-to-column (1- column)))
2322 (setq column 0))
2324 ;; These command lines now have no effect.
2326 (display-warning 'initialization
2327 (format "Ignoring obsolete arg %s" argi)))
2329 ((equal argi "--")
2330 (setq just-files t))
2331 (t
2332 ;; We have almost exhausted our options. See if the
2333 ;; user has made any other command-line options available
2334 (let ((hooks command-line-functions)
2335 (did-hook nil))
2336 (while (and hooks
2337 (not (setq did-hook (funcall (car hooks)))))
2338 (setq hooks (cdr hooks)))
2339 (if (not did-hook)
2340 ;; Presume that the argument is a file name.
2341 (progn
2343 (error "Unknown option `%s'" argi))
2344 (unless initial-window-system
2345 (setq inhibit-startup-screen t))
2346 (setq file-count (1+ file-count))
2347 (let ((file
2348 (expand-file-name
2349 (command-line-normalize-file-name orig-argi)
2350 dir)))
2351 (cond ((= file-count 1)
2352 (setq first-file-buffer (find-file file)))
2353 (inhibit-startup-screen
2354 (find-file-other-window file))
2355 (t (find-file file))))
2356 (unless (zerop line)
2357 (goto-char (point-min))
2358 (forward-line (1- line)))
2359 (setq line 0)
2360 (unless (< column 1)
2361 (move-to-column (1- column)))
2362 (setq column 0))))))
2363 ;; In unusual circumstances, the execution of Lisp code due
2364 ;; to command-line options can cause the last visible frame
2365 ;; to be deleted. In this case, kill emacs to avoid an
2366 ;; abort later.
2367 (unless (frame-live-p (selected-frame)) (kill-emacs nil))))))
2369 (when (eq initial-buffer-choice t)
2370 ;; When initial-buffer-choice equals t make sure that *scratch*
2371 ;; exists.
2372 (get-buffer-create "*scratch*"))
2374 ;; If *scratch* exists and is empty, insert initial-scratch-message.
2375 ;; Do this before switching to *scratch* below to handle bug#9605.
2376 (and initial-scratch-message
2377 (get-buffer "*scratch*")
2378 (with-current-buffer "*scratch*"
2379 (when (zerop (buffer-size))
2380 (insert initial-scratch-message)
2381 (set-buffer-modified-p nil))))
2383 (when initial-buffer-choice
2384 (let ((buf
2385 (cond ((stringp initial-buffer-choice)
2386 (find-file-noselect initial-buffer-choice))
2387 ((functionp initial-buffer-choice)
2388 (funcall initial-buffer-choice)))))
2389 (switch-to-buffer
2390 (if (buffer-live-p buf) buf (get-buffer-create "*scratch*"))
2391 'norecord)))
2393 (if (or inhibit-startup-screen
2394 initial-buffer-choice
2395 noninteractive
2396 (daemonp)
2397 inhibit-x-resources)
2399 ;; Not displaying a startup screen. If 3 or more files
2400 ;; visited, and not all visible, show user what they all are.
2401 (and (> file-count 2)
2402 (not noninteractive)
2403 (not inhibit-startup-buffer-menu)
2404 (or (get-buffer-window first-file-buffer)
2405 (list-buffers)))
2407 ;; Display a startup screen, after some preparations.
2409 ;; If there are no switches to process, we might as well
2410 ;; run this hook now, and there may be some need to do it
2411 ;; before doing any output.
2412 (run-hooks 'emacs-startup-hook 'term-setup-hook)
2414 ;; It's important to notice the user settings before we
2415 ;; display the startup message; otherwise, the settings
2416 ;; won't take effect until the user gives the first
2417 ;; keystroke, and that's distracting.
2418 (when (fboundp 'frame-notice-user-settings)
2419 (frame-notice-user-settings))
2421 ;; If there are no switches to process, we might as well
2422 ;; run this hook now, and there may be some need to do it
2423 ;; before doing any output.
2424 (run-hooks 'window-setup-hook)
2426 (setq inhibit-startup-hooks t)
2428 ;; ;; Do this now to avoid an annoying delay if the user
2429 ;; ;; clicks the menu bar during the sit-for.
2430 ;; (when (display-popup-menus-p)
2431 ;; (precompute-menubar-bindings))
2432 ;; (with-no-warnings
2433 ;; (setq menubar-bindings-done t))
2435 (display-startup-screen (> file-count 0)))))
2437 (defun command-line-normalize-file-name (file)
2438 "Collapse multiple slashes to one, to handle non-Emacs file names."
2439 (save-match-data
2440 ;; Use arg 1 so that we don't collapse // at the start of the file name.
2441 ;; That is significant on some systems.
2442 ;; However, /// at the beginning is supposed to mean just /, not //.
2443 (if (string-match
2444 (if (memq system-type '(ms-dos windows-nt))
2446 "^///+")
2447 file)
2448 (setq file (replace-match "/" t t file)))
2449 (if (memq system-type '(ms-dos windows-nt))
2451 (setq file (replace-match "/" t t file)))
2452 (while (string-match "//+" file 1)
2453 (setq file (replace-match "/" t t file))))
2454 file))
2456 ;;; startup.el ends here