Improve Emacs user manual in fixit.texi
[emacs.git] / lisp / startup.el
blob9d16b59defded3e31da116e6e57f8530f74a4c07
1 ;;; startup.el --- process Emacs shell arguments -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1986, 1992, 1994-2018 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 <https://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:
33 (setq top-level '(normal-top-level))
35 (defvar command-line-processed nil
36 "Non-nil once command line has been processed.")
38 (defgroup initialization nil
39 "Emacs start-up procedure."
40 :group 'environment)
42 (defcustom initial-buffer-choice nil
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."
55 :type '(choice
56 (const :tag "Startup screen" nil)
57 (directory :tag "Directory" :value "~/")
58 (file :tag "File" :value "~/.emacs")
59 ;; Note sure about hard-coding this as an option...
60 (const :tag "Remember Mode notes buffer" remember-notes)
61 (function :tag "Function")
62 (const :tag "Lisp scratch buffer" t))
63 :version "23.1"
64 :group 'initialization)
66 (defcustom inhibit-startup-screen nil
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."
71 :type 'boolean
72 :group 'initialization)
74 (defvaralias 'inhibit-splash-screen 'inhibit-startup-screen)
75 (defvaralias 'inhibit-startup-message 'inhibit-startup-screen)
77 (defvar startup-screen-inhibit-startup-screen nil)
79 ;; The mechanism used to ensure that only end users can disable this
80 ;; message is not complex. Clearly, it is possible for a determined
81 ;; system administrator to inhibit this message anyway, but at least
82 ;; they will do so with knowledge of why the Emacs developers think
83 ;; this is a bad idea.
84 (defcustom inhibit-startup-echo-area-message nil
85 "Non-nil inhibits the initial startup echo area message.
87 The startup message is in the echo area as it provides information
88 about GNU Emacs and the GNU system in general, which we want all
89 users to see. As this is the least intrusive startup message,
90 this variable gets specialized treatment to prevent the message
91 from being disabled site-wide by systems administrators, while
92 still allowing individual users to do so.
94 Setting this variable takes effect only if you do it with the
95 customization buffer or if your init file contains a line of this
96 form:
97 (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\")
98 If your init file is byte-compiled, use the following form
99 instead:
100 (eval \\='(setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\"))
101 Thus, someone else using a copy of your init file will see the
102 startup message unless he personally acts to inhibit it."
103 :type '(choice (const :tag "Don't inhibit")
104 (string :tag "Enter your user name, to inhibit"))
105 :group 'initialization)
107 (defcustom inhibit-default-init nil
108 "Non-nil inhibits loading the `default' library."
109 :type 'boolean
110 :group 'initialization)
112 (defcustom inhibit-startup-buffer-menu nil
113 "Non-nil inhibits display of buffer list when more than 2 files are loaded."
114 :type 'boolean
115 :group 'initialization)
117 (defvar command-switch-alist nil
118 "Alist of command-line switches.
119 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
120 HANDLER-FUNCTION receives the switch string as its sole argument;
121 the remaining command-line args are in the variable `command-line-args-left'.")
123 (defvar command-line-args-left nil
124 "List of command-line args not yet processed.")
126 (defvaralias 'argv 'command-line-args-left
127 "List of command-line args not yet processed.
128 This is a convenience alias, so that one can write \(pop argv)
129 inside of --eval command line arguments in order to access
130 following arguments.")
131 (internal-make-var-non-special 'argv)
133 (defvar argi nil
134 "Current command-line argument.")
135 (internal-make-var-non-special 'argi)
137 (defvar command-line-functions nil ;; lrs 7/31/89
138 "List of functions to process unrecognized command-line arguments.
139 Each function should access the dynamically bound variables
140 `argi' (the current argument) and `command-line-args-left' (the remaining
141 arguments). The function should return non-nil only if it recognizes and
142 processes `argi'. If it does so, it may consume successive arguments by
143 altering `command-line-args-left' to remove them.")
145 (defvar command-line-default-directory nil
146 "Default directory to use for command line arguments.
147 This is normally copied from `default-directory' when Emacs starts.")
149 ;; This is here, rather than in x-win.el, so that we can ignore these
150 ;; options when we are not using X.
151 (defconst command-line-x-option-alist
152 '(("-bw" 1 x-handle-numeric-switch border-width)
153 ("-d" 1 x-handle-display)
154 ("-display" 1 x-handle-display)
155 ("-name" 1 x-handle-name-switch)
156 ("-title" 1 x-handle-switch title)
157 ("-T" 1 x-handle-switch title)
158 ("-r" 0 x-handle-switch reverse t)
159 ("-rv" 0 x-handle-switch reverse t)
160 ("-reverse" 0 x-handle-switch reverse t)
161 ("-reverse-video" 0 x-handle-switch reverse t)
162 ("-fn" 1 x-handle-switch font)
163 ("-font" 1 x-handle-switch font)
164 ("-fs" 0 x-handle-initial-switch fullscreen fullboth)
165 ("-fw" 0 x-handle-initial-switch fullscreen fullwidth)
166 ("-fh" 0 x-handle-initial-switch fullscreen fullheight)
167 ("-mm" 0 x-handle-initial-switch fullscreen maximized)
168 ("-ib" 1 x-handle-numeric-switch internal-border-width)
169 ("-g" 1 x-handle-geometry)
170 ("-lsp" 1 x-handle-numeric-switch line-spacing)
171 ("-geometry" 1 x-handle-geometry)
172 ("-fg" 1 x-handle-switch foreground-color)
173 ("-foreground" 1 x-handle-switch foreground-color)
174 ("-bg" 1 x-handle-switch background-color)
175 ("-background" 1 x-handle-switch background-color)
176 ("-ms" 1 x-handle-switch mouse-color)
177 ("-nbi" 0 x-handle-switch icon-type nil)
178 ("-iconic" 0 x-handle-iconic)
179 ("-xrm" 1 x-handle-xrm-switch)
180 ("-cr" 1 x-handle-switch cursor-color)
181 ("-vb" 0 x-handle-switch vertical-scroll-bars t)
182 ("-hb" 0 x-handle-switch horizontal-scroll-bars t)
183 ("-bd" 1 x-handle-switch)
184 ("--border-width" 1 x-handle-numeric-switch border-width)
185 ("--display" 1 x-handle-display)
186 ("--name" 1 x-handle-name-switch)
187 ("--title" 1 x-handle-switch title)
188 ("--reverse-video" 0 x-handle-switch reverse t)
189 ("--font" 1 x-handle-switch font)
190 ("--fullscreen" 0 x-handle-initial-switch fullscreen fullboth)
191 ("--fullwidth" 0 x-handle-initial-switch fullscreen fullwidth)
192 ("--fullheight" 0 x-handle-initial-switch fullscreen fullheight)
193 ("--maximized" 0 x-handle-initial-switch fullscreen maximized)
194 ("--internal-border" 1 x-handle-numeric-switch internal-border-width)
195 ("--geometry" 1 x-handle-geometry)
196 ("--foreground-color" 1 x-handle-switch foreground-color)
197 ("--background-color" 1 x-handle-switch background-color)
198 ("--mouse-color" 1 x-handle-switch mouse-color)
199 ("--no-bitmap-icon" 0 x-handle-no-bitmap-icon)
200 ("--iconic" 0 x-handle-iconic)
201 ("--xrm" 1 x-handle-xrm-switch)
202 ("--cursor-color" 1 x-handle-switch cursor-color)
203 ("--vertical-scroll-bars" 0 x-handle-switch vertical-scroll-bars t)
204 ("--line-spacing" 1 x-handle-numeric-switch line-spacing)
205 ("--border-color" 1 x-handle-switch border-color)
206 ("--smid" 1 x-handle-smid)
207 ("--parent-id" 1 x-handle-parent-id))
208 "Alist of X Windows options.
209 Each element has the form
210 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
211 where NAME is the option name string, NUMARGS is the number of arguments
212 that the option accepts, HANDLER is a function to call to handle the option.
213 FRAME-PARAM (optional) is the frame parameter this option specifies,
214 and VALUE is the value which is given to that frame parameter
215 \(most options use the argument for this, so VALUE is not present).")
217 (defconst command-line-ns-option-alist
218 '(("-NSAutoLaunch" 1 ns-ignore-1-arg)
219 ("-NXAutoLaunch" 1 ns-ignore-1-arg)
220 ("-macosx" 0 ignore)
221 ("-NSHost" 1 ns-ignore-1-arg)
222 ("-_NSMachLaunch" 1 ns-ignore-1-arg)
223 ("-MachLaunch" 1 ns-ignore-1-arg)
224 ("-NXOpen" 1 ns-ignore-1-arg)
225 ("-NSOpen" 1 ns-handle-nxopen)
226 ("-NXOpenTemp" 1 ns-ignore-1-arg)
227 ("-NSOpenTemp" 1 ns-handle-nxopentemp)
228 ("-GSFilePath" 1 ns-handle-nxopen)
229 ;;("-bw" . x-handle-numeric-switch)
230 ;;("-d" . x-handle-display)
231 ;;("-display" . x-handle-display)
232 ("-name" 1 x-handle-name-switch)
233 ("-title" 1 x-handle-switch title)
234 ("-T" 1 x-handle-switch title)
235 ("-r" 0 x-handle-switch reverse t)
236 ("-rv" 0 x-handle-switch reverse t)
237 ("-reverse" 0 x-handle-switch reverse t)
238 ("-fn" 1 x-handle-switch font)
239 ("-font" 1 x-handle-switch font)
240 ("-ib" 1 x-handle-numeric-switch internal-border-width)
241 ("-g" 1 x-handle-geometry)
242 ("-geometry" 1 x-handle-geometry)
243 ("-fg" 1 x-handle-switch foreground-color)
244 ("-foreground" 1 x-handle-switch foreground-color)
245 ("-bg" 1 x-handle-switch background-color)
246 ("-background" 1 x-handle-switch background-color)
247 ; ("-ms" 1 x-handle-switch mouse-color)
248 ("-itype" 0 x-handle-switch icon-type t)
249 ("-i" 0 x-handle-switch icon-type t)
250 ("-iconic" 0 x-handle-iconic icon-type t)
251 ;;("-xrm" . x-handle-xrm-switch)
252 ("-cr" 1 x-handle-switch cursor-color)
253 ("-vb" 0 x-handle-switch vertical-scroll-bars t)
254 ("-hb" 0 x-handle-switch horizontal-scroll-bars t)
255 ("-bd" 1 x-handle-switch)
256 ;; ("--border-width" 1 x-handle-numeric-switch border-width)
257 ;; ("--display" 1 ns-handle-display)
258 ("--name" 1 x-handle-name-switch)
259 ("--title" 1 x-handle-switch title)
260 ("--reverse-video" 0 x-handle-switch reverse t)
261 ("--font" 1 x-handle-switch font)
262 ("--internal-border" 1 x-handle-numeric-switch internal-border-width)
263 ;; ("--geometry" 1 ns-handle-geometry)
264 ("--foreground-color" 1 x-handle-switch foreground-color)
265 ("--background-color" 1 x-handle-switch background-color)
266 ("--mouse-color" 1 x-handle-switch mouse-color)
267 ("--icon-type" 0 x-handle-switch icon-type t)
268 ("--iconic" 0 x-handle-iconic)
269 ;; ("--xrm" 1 ns-handle-xrm-switch)
270 ("--cursor-color" 1 x-handle-switch cursor-color)
271 ("--vertical-scroll-bars" 0 x-handle-switch vertical-scroll-bars t)
272 ("--border-color" 1 x-handle-switch border-width))
273 "Alist of NS options.
274 Each element has the form
275 (NAME NUMARGS HANDLER FRAME-PARAM VALUE)
276 where NAME is the option name string, NUMARGS is the number of arguments
277 that the option accepts, HANDLER is a function to call to handle the option.
278 FRAME-PARAM (optional) is the frame parameter this option specifies,
279 and VALUE is the value which is given to that frame parameter
280 \(most options use the argument for this, so VALUE is not present).")
283 (defvar before-init-hook nil
284 "Normal hook run after handling urgent options but before loading init files.")
286 (defvar after-init-hook nil
287 "Normal hook run after initializing the Emacs session.
288 It is run after Emacs loads the init file, `default' library, the
289 abbrevs file, and additional Lisp packages (if any), and setting
290 the value of `after-init-time'.
292 There is no `condition-case' around the running of this hook;
293 therefore, if `debug-on-error' is non-nil, an error in one of
294 these functions will invoke the debugger.")
296 (defvar emacs-startup-hook nil
297 "Normal hook run after loading init files and handling the command line.")
299 (defvar term-setup-hook nil
300 "Normal hook run immediately after `emacs-startup-hook'.
301 In new code, there is no reason to use this instead of `emacs-startup-hook'.
302 If you want to execute terminal-specific Lisp code, for example
303 to override the definitions made by the terminal-specific file,
304 see `tty-setup-hook'.")
306 (make-obsolete-variable 'term-setup-hook
307 "use either `emacs-startup-hook' or \
308 `tty-setup-hook' instead." "24.4")
310 (defvar inhibit-startup-hooks nil
311 "Non-nil means don't run some startup hooks, because we already did.
312 Currently this applies to: `emacs-startup-hook', `term-setup-hook',
313 and `window-setup-hook'.")
315 (defvar keyboard-type nil
316 "The brand of keyboard you are using.
317 This variable is used to define the proper function and keypad
318 keys for use under X. It is used in a fashion analogous to the
319 environment variable TERM.")
321 (defvar window-setup-hook nil
322 "Normal hook run after loading init files and handling the command line.
323 This is very similar to `emacs-startup-hook'. The only difference
324 is that this hook runs after frame parameters have been set up in
325 response to any settings from your init file. Unless this matters
326 to you, use `emacs-startup-hook' instead. (The name of this hook
327 is due to historical reasons, and does not reflect its purpose very well.)")
329 (defcustom initial-major-mode 'lisp-interaction-mode
330 "Major mode command symbol to use for the initial `*scratch*' buffer."
331 :type 'function
332 :group 'initialization)
334 (defvar init-file-user nil
335 "Identity of user whose init file is or was read.
336 The value is nil if `-q' or `--no-init-file' was specified,
337 meaning do not load any init file.
339 Otherwise, the value may be an empty string, meaning
340 use the init file for the user who originally logged in,
341 or it may be a string containing a user's name meaning
342 use that person's init file.
344 In either of the latter cases, `(concat \"~\" init-file-user \"/\")'
345 evaluates to the name of the directory where the init file was
346 looked for.
348 Setting `init-file-user' does not prevent Emacs from loading
349 `site-start.el'. The only way to do that is to use `--no-site-file'.")
351 (defcustom site-run-file (purecopy "site-start")
352 "File containing site-wide run-time initializations.
353 This file is loaded at run-time before `~/.emacs'. It contains inits
354 that need to be in place for the entire site, but which, due to their
355 higher incidence of change, don't make sense to load into Emacs's
356 dumped image. Thus, the run-time load order is: 1. file described in
357 this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.
359 Don't use the `site-start.el' file for things some users may not like.
360 Put them in `default.el' instead, so that users can more easily
361 override them. Users can prevent loading `default.el' with the `-q'
362 option or by setting `inhibit-default-init' in their own init files,
363 but inhibiting `site-start.el' requires `--no-site-file', which
364 is less convenient.
366 This variable is defined for customization so as to make
367 it visible in the relevant context. However, actually customizing it
368 is not allowed, since it would not work anyway. The only way to set
369 this variable usefully is to set it while building and dumping Emacs."
370 :type '(choice (const :tag "none" nil) string)
371 :group 'initialization
372 :initialize #'custom-initialize-default
373 :set (lambda (_variable _value)
374 (error "Customizing `site-run-file' does not work")))
376 (make-obsolete-variable 'system-name "use (system-name) instead" "25.1")
378 (defcustom mail-host-address nil
379 "The name of this machine, for use in constructing email addresses.
380 If this is nil, Emacs uses `system-name'."
381 :type '(choice (const nil) string)
382 :group 'mail)
384 (defcustom user-mail-address
385 (or (getenv "EMAIL")
386 (concat (user-login-name) "@" (or mail-host-address (system-name))))
387 "The email address of the current user.
388 This defaults to either: the value of EMAIL environment variable; or
389 user@host, using `user-login-name' and `mail-host-address' (or `system-name')."
390 :initialize 'custom-initialize-delay
391 :set-after '(mail-host-address)
392 :type 'string
393 :group 'mail)
395 (defcustom auto-save-list-file-prefix
396 (cond ((eq system-type 'ms-dos)
397 ;; MS-DOS cannot have initial dot, and allows only 8.3 names
398 (concat user-emacs-directory "auto-save.list/_s"))
400 (concat user-emacs-directory "auto-save-list/.saves-")))
401 "Prefix for generating `auto-save-list-file-name'.
402 This is used after reading your init file to initialize
403 `auto-save-list-file-name', by appending Emacs's pid and the system name,
404 if you have not already set `auto-save-list-file-name' yourself.
405 Directories in the prefix will be created if necessary.
406 Set this to nil if you want to prevent `auto-save-list-file-name'
407 from being initialized."
408 :type '(choice (const :tag "Don't record a session's auto save list" nil)
409 string)
410 :group 'auto-save)
412 (defvar emacs-basic-display nil)
414 (defvar init-file-debug nil)
416 (defvar init-file-had-error nil
417 "Non-nil if there was an error loading the user's init file.")
419 (defvar normal-top-level-add-subdirs-inode-list nil)
421 (defvar no-blinking-cursor nil)
423 (defvar pure-space-overflow nil
424 "Non-nil if building Emacs overflowed pure space.")
426 (defvar pure-space-overflow-message (purecopy "\
427 Warning Warning!!! Pure space overflow !!!Warning Warning
428 \(See the node Pure Storage in the Lisp manual for details.)\n"))
430 (defcustom tutorial-directory
431 (file-name-as-directory (expand-file-name "tutorials" data-directory))
432 "Directory containing the Emacs TUTORIAL files."
433 :group 'installation
434 :type 'directory
435 :initialize #'custom-initialize-delay)
437 (defun normal-top-level-add-subdirs-to-load-path ()
438 "Recursively add all subdirectories of `default-directory' to `load-path'.
439 More precisely, this uses only the subdirectories whose names
440 start with letters or digits; it excludes any subdirectory named `RCS'
441 or `CVS', and any subdirectory that contains a file named `.nosearch'."
442 (let (dirs
443 attrs
444 (pending (list default-directory)))
445 ;; This loop does a breadth-first tree walk on DIR's subtree,
446 ;; putting each subdir into DIRS as its contents are examined.
447 (while pending
448 (push (pop pending) dirs)
449 (let* ((this-dir (car dirs))
450 (contents (directory-files this-dir))
451 (default-directory this-dir)
452 (canonicalized (if (fboundp 'w32-untranslated-canonical-name)
453 (w32-untranslated-canonical-name this-dir))))
454 ;; The Windows version doesn't report meaningful inode numbers, so
455 ;; use the canonicalized absolute file name of the directory instead.
456 (setq attrs (or canonicalized
457 (nthcdr 10 (file-attributes this-dir))))
458 (unless (member attrs normal-top-level-add-subdirs-inode-list)
459 (push attrs normal-top-level-add-subdirs-inode-list)
460 (dolist (file contents)
461 (and (string-match "\\`[[:alnum:]]" file)
462 ;; The lower-case variants of RCS and CVS are for DOS/Windows.
463 (not (member file '("RCS" "CVS" "rcs" "cvs")))
464 ;; Avoid doing a `stat' when it isn't necessary because
465 ;; that can cause trouble when an NFS server is down.
466 (not (string-match "\\.elc?\\'" file))
467 (file-directory-p file)
468 (let ((expanded (expand-file-name file)))
469 (or (file-exists-p (expand-file-name ".nosearch" expanded))
470 (setq pending (nconc pending (list expanded))))))))))
471 (normal-top-level-add-to-load-path (cdr (nreverse dirs)))))
473 (defun normal-top-level-add-to-load-path (dirs)
474 "This function is called from a subdirs.el file.
475 It assumes that `default-directory' is the directory in which the
476 subdirs.el file exists, and it adds to `load-path' the subdirs of
477 that directory as specified in DIRS. Normally the elements of
478 DIRS are relative."
479 (let ((tail load-path)
480 (thisdir (directory-file-name default-directory)))
481 (while (and tail
482 ;;Don't go all the way to the nil terminator.
483 (cdr tail)
484 (not (equal thisdir (car tail)))
485 (not (and (memq system-type '(ms-dos windows-nt))
486 (equal (downcase thisdir) (downcase (car tail))))))
487 (setq tail (cdr tail)))
488 ;;Splice the new section in.
489 (when tail
490 (setcdr tail (append (mapcar 'expand-file-name dirs) (cdr tail))))))
492 (defun normal-top-level ()
493 "Emacs calls this function when it first starts up.
494 It sets `command-line-processed', processes the command-line,
495 reads the initialization files, etc.
496 It is the default value of the variable `top-level'."
497 (if command-line-processed
498 (message internal--top-level-message)
499 (setq command-line-processed t)
501 ;; Look in each dir in load-path for a subdirs.el file. If we
502 ;; find one, load it, which will add the appropriate subdirs of
503 ;; that dir into load-path. This needs to be done before setting
504 ;; the locale environment, because the latter might need to load
505 ;; some support files.
506 ;; Look for a leim-list.el file too. Loading it will register
507 ;; available input methods.
508 (let ((tail load-path)
509 (lispdir (expand-file-name "../lisp" data-directory))
510 dir)
511 (while tail
512 (setq dir (car tail))
513 (let ((default-directory dir))
514 (load (expand-file-name "subdirs.el") t t t))
515 ;; Do not scan standard directories that won't contain a leim-list.el.
516 ;; https://lists.gnu.org/r/emacs-devel/2009-10/msg00502.html
517 ;; (Except the preloaded one in lisp/leim.)
518 (or (string-prefix-p lispdir dir)
519 (let ((default-directory dir))
520 (load (expand-file-name "leim-list.el") t t t)))
521 ;; We don't use a dolist loop and we put this "setq-cdr" command at
522 ;; the end, because the subdirs.el files may add elements to the end
523 ;; of load-path and we want to take it into account.
524 (setq tail (cdr tail))))
526 ;; Set the default strings to display in mode line for end-of-line
527 ;; formats that aren't native to this platform. This should be
528 ;; done before calling set-locale-environment, as the latter might
529 ;; use these mnemonics.
530 (cond
531 ((memq system-type '(ms-dos windows-nt))
532 (setq eol-mnemonic-unix "(Unix)"
533 eol-mnemonic-mac "(Mac)"))
534 (t ; this is for Unix/GNU/Linux systems
535 (setq eol-mnemonic-dos "(DOS)"
536 eol-mnemonic-mac "(Mac)")))
538 (set-locale-environment nil)
539 ;; Decode all default-directory's (probably, only *scratch* exists
540 ;; at this point). default-directory of *scratch* is the basis
541 ;; for many other file-name variables and directory lists, so it
542 ;; is important to decode it ASAP.
543 (when locale-coding-system
544 (let ((coding (if (eq system-type 'windows-nt)
545 ;; MS-Windows build converts all file names to
546 ;; UTF-8 during startup.
547 'utf-8
548 locale-coding-system)))
549 (save-excursion
550 (dolist (elt (buffer-list))
551 (set-buffer elt)
552 (if default-directory
553 (setq default-directory
554 (if (eq system-type 'windows-nt)
555 ;; Convert backslashes to forward slashes.
556 (expand-file-name
557 (decode-coding-string default-directory coding t))
558 (decode-coding-string default-directory coding t))))))
560 ;; Decode all the important variables and directory lists, now
561 ;; that we know the locale's encoding. This is because the
562 ;; values of these variables are until here unibyte undecoded
563 ;; strings created by build_unibyte_string. data-directory in
564 ;; particular is used to construct many other standard
565 ;; directory names, so it must be decoded ASAP. Note that
566 ;; charset-map-path cannot be decoded here, since we could
567 ;; then be trapped in infinite recursion below, when we load
568 ;; subdirs.el, because encoding a directory name might need to
569 ;; load a charset map, which will want to encode
570 ;; charset-map-path, which will want to load the same charset
571 ;; map... So decoding of charset-map-path is delayed until
572 ;; further down below.
573 (dolist (pathsym '(load-path exec-path))
574 (let ((path (symbol-value pathsym)))
575 (if (listp path)
576 (set pathsym (mapcar (lambda (dir)
577 (decode-coding-string dir coding t))
578 path)))))
579 (dolist (filesym '(data-directory doc-directory exec-directory
580 installation-directory
581 invocation-directory invocation-name
582 source-directory
583 shared-game-score-directory))
584 (let ((file (symbol-value filesym)))
585 (if (stringp file)
586 (set filesym (decode-coding-string file coding t)))))))
588 (let ((dir default-directory))
589 (with-current-buffer "*Messages*"
590 (messages-buffer-mode)
591 ;; Make it easy to do like "tail -f".
592 (set (make-local-variable 'window-point-insertion-type) t)
593 ;; Give *Messages* the same default-directory as *scratch*,
594 ;; just to keep things predictable.
595 (setq default-directory (or dir (expand-file-name "~/")))))
596 ;; `user-full-name' is now known; reset its standard-value here.
597 (put 'user-full-name 'standard-value
598 (list (default-value 'user-full-name)))
599 ;; If the PWD environment variable isn't accurate, delete it.
600 (let ((pwd (getenv "PWD")))
601 (and (stringp pwd)
602 ;; Use FOO/., so that if FOO is a symlink, file-attributes
603 ;; describes the directory linked to, not FOO itself.
604 (or (and default-directory
605 (equal (file-attributes
606 (concat (file-name-as-directory pwd) "."))
607 (file-attributes
608 (concat (file-name-as-directory default-directory)
609 "."))))
610 (setq process-environment
611 (delete (concat "PWD=" pwd)
612 process-environment)))))
613 ;; Now, that other directories were searched, and any charsets we
614 ;; need for encoding them are already loaded, we are ready to
615 ;; decode charset-map-path.
616 (if (listp charset-map-path)
617 (let ((coding (if (eq system-type 'windows-nt)
618 'utf-8
619 locale-coding-system)))
620 (setq charset-map-path
621 (mapcar (lambda (dir)
622 (decode-coding-string dir coding t))
623 charset-map-path))))
624 (if default-directory
625 (setq default-directory (abbreviate-file-name default-directory))
626 (display-warning 'initialization "Error setting default-directory"))
627 (let ((old-face-font-rescale-alist face-font-rescale-alist))
628 (unwind-protect
629 (command-line)
630 ;; Do this again, in case .emacs defined more abbreviations.
631 (if default-directory
632 (setq default-directory (abbreviate-file-name default-directory)))
633 ;; Specify the file for recording all the auto save files of this session.
634 ;; This is used by recover-session.
635 (or auto-save-list-file-name
636 (and auto-save-list-file-prefix
637 (setq auto-save-list-file-name
638 ;; Under MS-DOS our PID is almost always reused between
639 ;; Emacs invocations. We need something more unique.
640 (cond ((eq system-type 'ms-dos)
641 ;; We are going to access the auto-save
642 ;; directory, so make sure it exists.
643 (make-directory
644 (file-name-directory auto-save-list-file-prefix)
646 (concat
647 (make-temp-name
648 (expand-file-name
649 auto-save-list-file-prefix))
650 "~"))
652 (expand-file-name
653 (format "%s%d-%s~"
654 auto-save-list-file-prefix
655 (emacs-pid)
656 (system-name))))))))
657 (unless inhibit-startup-hooks
658 (run-hooks 'emacs-startup-hook 'term-setup-hook))
660 ;; Don't do this if we failed to create the initial frame,
661 ;; for instance due to a dense colormap.
662 (when (or frame-initial-frame
663 ;; If frame-initial-frame has no meaning, do this anyway.
664 (not (and initial-window-system
665 (not noninteractive)
666 (not (eq initial-window-system 'pc)))))
668 ;; FIXME: The user's init file may change
669 ;; face-font-rescale-alist. However, the default face
670 ;; already has an assigned font object, which does not take
671 ;; face-font-rescale-alist into account. For such
672 ;; situations, we ought to have a way to find all font
673 ;; objects and regenerate them; currently we do not. As a
674 ;; workaround, we specifically reset te default face's :font
675 ;; attribute here. See bug#1785.
676 (unless (eq face-font-rescale-alist
677 old-face-font-rescale-alist)
678 (set-face-attribute 'default nil :font (font-spec)))
680 ;; Modify the initial frame based on what .emacs puts into
681 ;; ...-frame-alist.
682 (if (fboundp 'frame-notice-user-settings)
683 (frame-notice-user-settings))
684 ;; Set the faces for the initial background mode even if
685 ;; frame-notice-user-settings didn't (such as on a tty).
686 ;; frame-set-background-mode is idempotent, so it won't
687 ;; cause any harm if it's already been done.
688 (if (fboundp 'frame-set-background-mode)
689 (frame-set-background-mode (selected-frame))))
691 ;; Now we know the user's default font, so add it to the menu.
692 (if (fboundp 'font-menu-add-default)
693 (font-menu-add-default))
694 (unless inhibit-startup-hooks
695 (run-hooks 'window-setup-hook))))
696 ;; Subprocesses of Emacs do not have direct access to the terminal, so
697 ;; unless told otherwise they should only assume a dumb terminal.
698 ;; We are careful to do it late (after term-setup-hook), although the
699 ;; new multi-tty code does not use $TERM any more there anyway.
700 (setenv "TERM" "dumb")
701 ;; Remove DISPLAY from the process-environment as well. This allows
702 ;; `callproc.c' to give it a useful adaptive default which is either
703 ;; the value of the `display' frame-parameter or the DISPLAY value
704 ;; from initial-environment.
705 (let ((display (frame-parameter nil 'display)))
706 ;; Be careful which DISPLAY to remove from process-environment: follow
707 ;; the logic of `callproc.c'.
708 (if (stringp display) (setq display (concat "DISPLAY=" display))
709 (dolist (varval initial-environment)
710 (if (string-match "\\`DISPLAY=" varval)
711 (setq display varval))))
712 (when display
713 (delete display process-environment)))))
715 ;; Precompute the keyboard equivalents in the menu bar items.
716 ;; Command-line options supported by tty's:
717 (defconst tty-long-option-alist
718 '(("--name" . "-name")
719 ("--title" . "-T")
720 ("--reverse-video" . "-reverse")
721 ("--foreground-color" . "-fg")
722 ("--background-color" . "-bg")
723 ("--color" . "-color")))
725 (defconst tool-bar-images-pixel-height 24
726 "Height in pixels of images in the tool-bar.")
728 (cl-defgeneric handle-args-function (args)
729 "Method for processing window-system dependent command-line arguments.
730 Window system startup files should add their own function to this
731 method, which should parse the command line arguments. Those
732 pertaining to the window system should be processed and removed
733 from the returned command line.")
734 (cl-defmethod handle-args-function (args &context (window-system nil))
735 (tty-handle-args args))
737 (cl-defgeneric window-system-initialization (&optional _display)
738 "Method for window-system initialization.
739 Window-system startup files should add their own implementation
740 to this method. The function should initialize the window system environment
741 to prepare for opening the first frame (e.g. open a connection to an X server)."
742 nil)
744 (defun tty-handle-args (args)
745 "Handle the X-like command-line arguments \"-fg\", \"-bg\", \"-name\", etc."
746 (let (rest)
747 (while (and args
748 (not (equal (car args) "--")))
749 (let* ((argi (pop args))
750 (orig-argi argi)
751 argval completion)
752 ;; Check for long options with attached arguments
753 ;; and separate out the attached option argument into argval.
754 (when (string-match "^\\(--[^=]*\\)=" argi)
755 (setq argval (substring argi (match-end 0))
756 argi (match-string 1 argi)))
757 (when (string-match "^--" argi)
758 (setq completion (try-completion argi tty-long-option-alist))
759 (if (eq completion t)
760 ;; Exact match for long option.
761 (setq argi (cdr (assoc argi tty-long-option-alist)))
762 (if (stringp completion)
763 (let ((elt (assoc completion tty-long-option-alist)))
764 ;; Check for abbreviated long option.
765 (or elt
766 (error "Option `%s' is ambiguous" argi))
767 (setq argi (cdr elt)))
768 ;; Check for a short option.
769 (setq argval nil
770 argi orig-argi))))
771 (cond ((member argi '("-fg" "-foreground"))
772 (push (cons 'foreground-color (or argval (pop args)))
773 default-frame-alist))
774 ((member argi '("-bg" "-background"))
775 (push (cons 'background-color (or argval (pop args)))
776 default-frame-alist))
777 ((member argi '("-T" "-name"))
778 (unless argval (setq argval (pop args)))
779 (push (cons 'title
780 (if (stringp argval)
781 argval
782 (let ((case-fold-search t)
784 (setq argval (invocation-name))
786 ;; Change any . or * characters in name to
787 ;; hyphens, so as to emulate behavior on X.
788 (while
789 (setq i (string-match "[.*]" argval))
790 (aset argval i ?-))
791 argval)))
792 default-frame-alist))
793 ((member argi '("-r" "-rv" "-reverse"))
794 (push '(reverse . t)
795 default-frame-alist))
796 ((equal argi "-color")
797 (unless argval (setq argval 8)) ; default --color means 8 ANSI colors
798 (push (cons 'tty-color-mode
799 (cond
800 ((numberp argval) argval)
801 ((string-match "-?[0-9]+" argval)
802 (string-to-number argval))
803 (t (intern argval))))
804 default-frame-alist))
806 (push argi rest)))))
807 (nconc (nreverse rest) args)))
809 (declare-function x-get-resource "frame.c"
810 (attribute class &optional component subclass))
811 (declare-function tool-bar-mode "tool-bar" (&optional arg))
812 (declare-function tool-bar-setup "tool-bar")
814 (defvar server-name)
815 (defvar server-process)
817 (defun startup--setup-quote-display (&optional style)
818 "If needed, display ASCII approximations to curved quotes.
819 Do this by modifying `standard-display-table'. Optional STYLE
820 specifies the desired quoting style, as in `text-quoting-style'.
821 If STYLE is nil, display appropriately for the terminal."
822 (let ((repls (let ((style-repls (assq style '((grave . "`'\"\"")
823 (straight . "''\"\"")))))
824 (if style-repls (cdr style-repls) (make-vector 4 nil))))
825 glyph-count)
826 ;; REPLS is a sequence of the four replacements for "‘’“”", respectively.
827 ;; If STYLE is nil, infer REPLS from terminal characteristics.
828 (unless style
829 ;; On a terminal that supports glyph codes,
830 ;; GLYPH-COUNT[i] is the number of times that glyph code I
831 ;; represents either an ASCII character or one of the 4
832 ;; quote characters. This assumes glyph codes are valid
833 ;; Elisp characters, which is a safe assumption in practice.
834 (when (integerp (internal-char-font nil (max-char)))
835 (setq glyph-count (make-char-table nil 0))
836 (dotimes (i 132)
837 (let ((glyph (internal-char-font
838 nil (if (< i 128) i (aref "‘’“”" (- i 128))))))
839 (when (<= 0 glyph)
840 (aset glyph-count glyph (1+ (aref glyph-count glyph)))))))
841 (dotimes (i 2)
842 (let ((lq (aref "‘“" i)) (rq (aref "’”" i))
843 (lr (aref "`\"" i)) (rr (aref "'\"" i))
844 (i2 (* i 2)))
845 (unless (if glyph-count
846 ;; On a terminal that supports glyph codes, use
847 ;; ASCII replacements unless both quotes are displayable.
848 ;; If not using ASCII replacements, highlight
849 ;; quotes unless they are both unique among the
850 ;; 128 + 4 characters of concern.
851 (let ((lglyph (internal-char-font nil lq))
852 (rglyph (internal-char-font nil rq)))
853 (when (and (<= 0 lglyph) (<= 0 rglyph))
854 (setq lr lq rr rq)
855 (and (= 1 (aref glyph-count lglyph))
856 (= 1 (aref glyph-count rglyph)))))
857 ;; On a terminal that does not support glyph codes, use
858 ;; ASCII replacements unless both quotes are displayable.
859 (and (char-displayable-p lq)
860 (char-displayable-p rq)))
861 (aset repls i2 lr)
862 (aset repls (1+ i2) rr)))))
863 (dotimes (i 4)
864 (let ((char (aref "‘’“”" i))
865 (repl (aref repls i)))
866 (if repl
867 (aset (or standard-display-table
868 (setq standard-display-table (make-display-table)))
869 char (vector (make-glyph-code repl 'homoglyph)))
870 (when standard-display-table
871 (aset standard-display-table char nil)))))))
873 (defun command-line ()
874 "A subroutine of `normal-top-level'.
875 Amongst another things, it parses the command-line arguments."
876 (setq before-init-time (current-time)
877 after-init-time nil
878 command-line-default-directory default-directory)
880 ;; Force recomputation, in case it was computed during the dump.
881 (setq abbreviated-home-dir nil)
883 ;; See if we should import version-control from the environment variable.
884 (let ((vc (getenv "VERSION_CONTROL")))
885 (cond ((eq vc nil)) ;don't do anything if not set
886 ((member vc '("t" "numbered"))
887 (setq version-control t))
888 ((member vc '("nil" "existing"))
889 (setq version-control nil))
890 ((member vc '("never" "simple"))
891 (setq version-control 'never))))
893 ;;! This has been commented out; I currently find the behavior when
894 ;;! split-window-keep-point is nil disturbing, but if I can get used
895 ;;! to it, then it would be better to eliminate the option.
896 ;;! ;; Choose a good default value for split-window-keep-point.
897 ;;! (setq split-window-keep-point (> baud-rate 2400))
899 ;; Convert preloaded file names in load-history to absolute.
900 (let ((simple-file-name
901 ;; Look for simple.el or simple.elc and use their directory
902 ;; as the place where all Lisp files live.
903 (locate-file "simple" load-path (get-load-suffixes)))
904 lisp-dir)
905 ;; Don't abort if simple.el cannot be found, but print a warning.
906 ;; Although in most usage we are going to cryptically abort a moment
907 ;; later anyway, due to missing required bidi data files (eg bug#13430).
908 (if (null simple-file-name)
909 (let ((standard-output 'external-debugging-output)
910 (lispdir (expand-file-name "../lisp" data-directory)))
911 (princ "Warning: Could not find simple.el or simple.elc")
912 (terpri)
913 (when (getenv "EMACSLOADPATH")
914 (princ "The EMACSLOADPATH environment variable is set, \
915 please check its value")
916 (terpri))
917 (unless (file-readable-p lispdir)
918 (princ (format "Lisp directory %s not readable?" lispdir))
919 (terpri)))
920 (setq lisp-dir (file-truename (file-name-directory simple-file-name)))
921 (setq load-history
922 (mapcar (lambda (elt)
923 (if (and (stringp (car elt))
924 (not (file-name-absolute-p (car elt))))
925 (cons (concat lisp-dir
926 (car elt))
927 (cdr elt))
928 elt))
929 load-history))))
931 ;; Convert the arguments to Emacs internal representation.
932 (let ((args command-line-args))
933 (while args
934 (setcar args
935 (decode-coding-string (car args) locale-coding-system t))
936 (pop args)))
938 (let ((done nil)
939 (args (cdr command-line-args))
940 display-arg)
942 ;; Figure out which user's init file to load,
943 ;; either from the environment or from the options.
944 (setq init-file-user (if noninteractive nil (user-login-name)))
945 ;; If user has not done su, use current $HOME to find .emacs.
946 (and init-file-user
947 (equal init-file-user (user-real-login-name))
948 (setq init-file-user ""))
950 ;; Process the command-line args, and delete the arguments
951 ;; processed. This is consistent with the way main in emacs.c
952 ;; does things.
953 (while (and (not done) args)
954 (let* ((longopts '(("--no-init-file") ("--no-site-file")
955 ("--no-x-resources") ("--debug-init")
956 ("--user") ("--iconic") ("--icon-type") ("--quick")
957 ("--no-blinking-cursor") ("--basic-display")))
958 (argi (pop args))
959 (orig-argi argi)
960 argval)
961 ;; Handle --OPTION=VALUE format.
962 (when (string-match "\\`\\(--[^=]*\\)=" argi)
963 (setq argval (substring argi (match-end 0))
964 argi (match-string 1 argi)))
965 (when (string-match "\\`--." orig-argi)
966 (let ((completion (try-completion argi longopts)))
967 (cond ((eq completion t)
968 (setq argi (substring argi 1)))
969 ((stringp completion)
970 (let ((elt (assoc completion longopts)))
971 (unless elt
972 (error "Option `%s' is ambiguous" argi))
973 (setq argi (substring (car elt) 1))))
975 (setq argval nil
976 argi orig-argi)))))
977 (cond
978 ;; The --display arg is handled partly in C, partly in Lisp.
979 ;; When it shows up here, we just put it back to be handled
980 ;; by `command-line-1'.
981 ((member argi '("-d" "-display"))
982 (setq display-arg (list argi (pop args))))
983 ((member argi '("-Q" "-quick"))
984 (setq init-file-user nil
985 site-run-file nil
986 inhibit-x-resources t)
987 ;; Stop it showing up in emacs -Q's customize-rogue.
988 (put 'site-run-file 'standard-value '(nil)))
989 ((member argi '("-no-x-resources"))
990 (setq inhibit-x-resources t))
991 ((member argi '("-D" "-basic-display"))
992 (setq no-blinking-cursor t
993 emacs-basic-display t)
994 (push '(vertical-scroll-bars . nil) initial-frame-alist))
995 ((member argi '("-q" "-no-init-file"))
996 (setq init-file-user nil))
997 ((member argi '("-u" "-user"))
998 (setq init-file-user (or argval (pop args))
999 argval nil))
1000 ((equal argi "-no-site-file")
1001 (setq site-run-file nil)
1002 (put 'site-run-file 'standard-value '(nil)))
1003 ((equal argi "-debug-init")
1004 (setq init-file-debug t))
1005 ((equal argi "-iconic")
1006 (push '(visibility . icon) initial-frame-alist))
1007 ((member argi '("-nbc" "-no-blinking-cursor"))
1008 (setq no-blinking-cursor t))
1009 ;; Push the popped arg back on the list of arguments.
1011 (push argi args)
1012 (setq done t)))
1013 ;; Was argval set but not used?
1014 (and argval
1015 (error "Option `%s' doesn't allow an argument" argi))))
1017 ;; Re-attach the --display arg.
1018 (and display-arg (setq args (append display-arg args)))
1020 ;; Re-attach the program name to the front of the arg list.
1021 (and command-line-args
1022 (setcdr command-line-args args)))
1024 ;; Make sure window system's init file was loaded in loadup.el if
1025 ;; using a window system.
1026 ;; Initialize the window-system only after processing the command-line
1027 ;; args so that -Q can influence this initialization.
1028 (condition-case error
1029 (unless noninteractive
1030 (if (and initial-window-system
1031 (not (featurep
1032 (intern
1033 (concat (symbol-name initial-window-system) "-win")))))
1034 (error "Unsupported window system `%s'" initial-window-system))
1035 ;; Process window-system specific command line parameters.
1036 (setq command-line-args
1037 (let ((window-system initial-window-system)) ;Hack attack!
1038 (handle-args-function command-line-args)))
1039 ;; Initialize the window system. (Open connection, etc.)
1040 (let ((window-system initial-window-system)) ;Hack attack!
1041 (window-system-initialization))
1042 (put initial-window-system 'window-system-initialized t))
1043 ;; If there was an error, print the error message and exit.
1044 (error
1045 (princ
1046 (if (eq (car error) 'error)
1047 (apply 'concat (cdr error))
1048 (if (memq 'file-error (get (car error) 'error-conditions))
1049 (format "%s: %s"
1050 (nth 1 error)
1051 (mapconcat (lambda (obj) (prin1-to-string obj t))
1052 (cdr (cdr error)) ", "))
1053 (format "%s: %s"
1054 (get (car error) 'error-message)
1055 (mapconcat (lambda (obj) (prin1-to-string obj t))
1056 (cdr error) ", "))))
1057 'external-debugging-output)
1058 (terpri 'external-debugging-output)
1059 (setq initial-window-system nil)
1060 (kill-emacs)))
1062 (run-hooks 'before-init-hook)
1064 ;; Under X, create the X frame and delete the terminal frame.
1065 (unless (daemonp)
1066 (if (or noninteractive emacs-basic-display)
1067 (setq menu-bar-mode nil
1068 tool-bar-mode nil
1069 no-blinking-cursor t))
1070 (frame-initialize))
1072 (when (fboundp 'x-create-frame)
1073 ;; Set up the tool-bar (even in tty frames, since Emacs might open a
1074 ;; graphical frame later).
1075 (unless noninteractive
1076 (tool-bar-setup)))
1078 ;; Turn off blinking cursor if so specified in X resources. This is here
1079 ;; only because all other settings of no-blinking-cursor are here.
1080 (unless (or noninteractive
1081 emacs-basic-display
1082 (and (memq window-system '(x w32 ns))
1083 (not (member (x-get-resource "cursorBlink" "CursorBlink")
1084 '("no" "off" "false" "0")))))
1085 (setq no-blinking-cursor t))
1087 (unless noninteractive
1088 (startup--setup-quote-display)
1089 (setq internal--text-quoting-flag t))
1091 ;; Re-evaluate predefined variables whose initial value depends on
1092 ;; the runtime context.
1093 (let (current-load-list) ; c-r-s may call defvar, and hence LOADHIST_ATTACH
1094 (mapc 'custom-reevaluate-setting
1095 ;; Initialize them in the same order they were loaded, in case there
1096 ;; are dependencies between them.
1097 (prog1 (nreverse custom-delayed-init-variables)
1098 (setq custom-delayed-init-variables nil))))
1100 (normal-erase-is-backspace-setup-frame)
1102 ;; Register default TTY colors for the case the terminal hasn't a
1103 ;; terminal init file. We do this regardless of whether the terminal
1104 ;; supports colors or not and regardless the current display type,
1105 ;; since users can connect to color-capable terminals and also
1106 ;; switch color support on or off in mid-session by setting the
1107 ;; tty-color-mode frame parameter.
1108 ;; Exception: the `pc' ``window system'' has only 16 fixed colors,
1109 ;; and they are already set at this point by a suitable method of
1110 ;; window-system-initialization.
1111 (or (eq initial-window-system 'pc)
1112 (tty-register-default-colors))
1114 (let ((old-scalable-fonts-allowed scalable-fonts-allowed)
1115 (old-face-ignored-fonts face-ignored-fonts))
1117 ;; Run the site-start library if it exists. The point of this file is
1118 ;; that it is run before .emacs. There is no point in doing this after
1119 ;; .emacs; that is useless.
1120 ;; Note that user-init-file is nil at this point. Code that might
1121 ;; be loaded from site-run-file and wants to test if -q was given
1122 ;; should check init-file-user instead, since that is already set.
1123 ;; See cus-edit.el for an example.
1124 (if site-run-file
1125 (load site-run-file t t))
1127 ;; Sites should not disable this. Only individuals should disable
1128 ;; the startup screen.
1129 (setq inhibit-startup-screen nil)
1131 ;; Warn for invalid user name.
1132 (when init-file-user
1133 (if (string-match "[~/:\n]" init-file-user)
1134 (display-warning 'initialization
1135 (format "Invalid user name %s"
1136 init-file-user)
1137 :error)
1138 (if (file-directory-p (expand-file-name
1139 ;; We don't support ~USER on MS-Windows
1140 ;; and MS-DOS except for the current
1141 ;; user, and always load .emacs from
1142 ;; the current user's home directory
1143 ;; (see below). So always check "~",
1144 ;; even if invoked with "-u USER", or
1145 ;; if $USER or $LOGNAME are set to
1146 ;; something different.
1147 (if (memq system-type '(windows-nt ms-dos))
1149 (concat "~" init-file-user))))
1151 (display-warning 'initialization
1152 (format "User %s has no home directory"
1153 (if (equal init-file-user "")
1154 (user-real-login-name)
1155 init-file-user))
1156 :error))))
1158 ;; Load that user's init file, or the default one, or none.
1159 (let (debug-on-error-from-init-file
1160 debug-on-error-should-be-set
1161 (debug-on-error-initial
1162 (if (eq init-file-debug t) 'startup init-file-debug))
1163 (orig-enable-multibyte (default-value 'enable-multibyte-characters)))
1164 (let ((debug-on-error debug-on-error-initial)
1165 ;; This function actually reads the init files.
1166 (inner
1167 (function
1168 (lambda ()
1169 (if init-file-user
1170 (let ((user-init-file-1
1171 (cond
1172 ((eq system-type 'ms-dos)
1173 (concat "~" init-file-user "/_emacs"))
1174 ((not (eq system-type 'windows-nt))
1175 (concat "~" init-file-user "/.emacs"))
1176 ;; Else deal with the Windows situation
1177 ((directory-files "~" nil "^\\.emacs\\(\\.elc?\\)?$")
1178 ;; Prefer .emacs on Windows.
1179 "~/.emacs")
1180 ((directory-files "~" nil "^_emacs\\(\\.elc?\\)?$")
1181 ;; Also support _emacs for compatibility, but warn about it.
1182 (push `(initialization
1183 ,(format-message
1184 "`_emacs' init file is deprecated, please use `.emacs'"))
1185 delayed-warnings-list)
1186 "~/_emacs")
1187 (t ;; But default to .emacs if _emacs does not exist.
1188 "~/.emacs"))))
1189 ;; This tells `load' to store the file name found
1190 ;; into user-init-file.
1191 (setq user-init-file t)
1192 (load user-init-file-1 t t)
1194 (when (eq user-init-file t)
1195 ;; If we did not find ~/.emacs, try
1196 ;; ~/.emacs.d/init.el.
1197 (let ((otherfile
1198 (expand-file-name
1199 "init"
1200 (file-name-as-directory
1201 (concat "~" init-file-user "/.emacs.d")))))
1202 (load otherfile t t)
1204 ;; If we did not find the user's init file,
1205 ;; set user-init-file conclusively.
1206 ;; Don't let it be set from default.el.
1207 (when (eq user-init-file t)
1208 (setq user-init-file user-init-file-1))))
1210 ;; If we loaded a compiled file, set
1211 ;; `user-init-file' to the source version if that
1212 ;; exists.
1213 (when (and user-init-file
1214 (equal (file-name-extension user-init-file)
1215 "elc"))
1216 (let* ((source (file-name-sans-extension user-init-file))
1217 (alt (concat source ".el")))
1218 (setq source (cond ((file-exists-p alt) alt)
1219 ((file-exists-p source) source)
1220 (t nil)))
1221 (when source
1222 (when (file-newer-than-file-p source user-init-file)
1223 (message "Warning: %s is newer than %s"
1224 source user-init-file)
1225 (sit-for 1))
1226 (setq user-init-file source))))
1228 (unless inhibit-default-init
1229 (let ((inhibit-startup-screen nil))
1230 ;; Users are supposed to be told their rights.
1231 ;; (Plus how to get help and how to undo.)
1232 ;; Don't you dare turn this off for anyone
1233 ;; except yourself.
1234 (load "default" t t)))))))))
1235 (if init-file-debug
1236 ;; Do this without a condition-case if the user wants to debug.
1237 (funcall inner)
1238 (condition-case error
1239 (progn
1240 (funcall inner)
1241 (setq init-file-had-error nil))
1242 (error
1243 (display-warning
1244 'initialization
1245 (format-message "\
1246 An error occurred while loading `%s':\n\n%s%s%s\n\n\
1247 To ensure normal operation, you should investigate and remove the
1248 cause of the error in your initialization file. Start Emacs with
1249 the `--debug-init' option to view a complete error backtrace."
1250 user-init-file
1251 (get (car error) 'error-message)
1252 (if (cdr error) ": " "")
1253 (mapconcat (lambda (s) (prin1-to-string s t))
1254 (cdr error) ", "))
1255 :warning)
1256 (setq init-file-had-error t))))
1258 (if (and deactivate-mark transient-mark-mode)
1259 (with-current-buffer (window-buffer)
1260 (deactivate-mark)))
1262 ;; If the user has a file of abbrevs, read it (unless -batch).
1263 (when (and (not noninteractive)
1264 (file-exists-p abbrev-file-name)
1265 (file-readable-p abbrev-file-name))
1266 (quietly-read-abbrev-file abbrev-file-name))
1268 ;; If the abbrevs came entirely from the init file or the
1269 ;; abbrevs file, they do not need saving.
1270 (setq abbrevs-changed nil)
1272 ;; If we can tell that the init file altered debug-on-error,
1273 ;; arrange to preserve the value that it set up.
1274 (or (eq debug-on-error debug-on-error-initial)
1275 (setq debug-on-error-should-be-set t
1276 debug-on-error-from-init-file debug-on-error)))
1277 (if debug-on-error-should-be-set
1278 (setq debug-on-error debug-on-error-from-init-file))
1279 (unless (or (default-value 'enable-multibyte-characters)
1280 (eq orig-enable-multibyte (default-value
1281 'enable-multibyte-characters)))
1282 ;; Init file changed to unibyte. Reset existing multibyte
1283 ;; buffers (probably *scratch*, *Messages*, *Minibuf-0*).
1284 ;; Arguably this should only be done if they're free of
1285 ;; multibyte characters.
1286 (mapc (lambda (buffer)
1287 (with-current-buffer buffer
1288 (if enable-multibyte-characters
1289 (set-buffer-multibyte nil))))
1290 (buffer-list))
1291 ;; Also re-set the language environment in case it was
1292 ;; originally done before unibyte was set and is sensitive to
1293 ;; unibyte (display table, terminal coding system &c).
1294 (set-language-environment current-language-environment)))
1296 ;; Do this here in case the init file sets mail-host-address.
1297 (and mail-host-address
1298 ;; Check that user-mail-address has not been set by hand.
1299 ;; Yes, this is ugly, but slightly less so than leaving
1300 ;; user-mail-address uninitialized during init file processing.
1301 ;; Perhaps we should make :set-after do something like this?
1302 ;; Ie, extend it to also mean (re)initialize-after. See etc/TODO.
1303 (equal user-mail-address
1304 (let (mail-host-address)
1305 (ignore-errors
1306 (eval (car (get 'user-mail-address 'standard-value))))))
1307 (custom-reevaluate-setting 'user-mail-address))
1309 ;; If parameter have been changed in the init file which influence
1310 ;; face realization, clear the face cache so that new faces will
1311 ;; be realized.
1312 (unless (and (eq scalable-fonts-allowed old-scalable-fonts-allowed)
1313 (eq face-ignored-fonts old-face-ignored-fonts))
1314 (clear-face-cache)))
1316 ;; If any package directory exists, initialize the package system.
1317 (and user-init-file
1318 package-enable-at-startup
1319 (catch 'package-dir-found
1320 (let (dirs)
1321 (if (boundp 'package-directory-list)
1322 (setq dirs package-directory-list)
1323 (dolist (f load-path)
1324 (and (stringp f)
1325 (equal (file-name-nondirectory f) "site-lisp")
1326 (push (expand-file-name "elpa" f) dirs))))
1327 (push (if (boundp 'package-user-dir)
1328 package-user-dir
1329 (locate-user-emacs-file "elpa"))
1330 dirs)
1331 (dolist (dir dirs)
1332 (when (file-directory-p dir)
1333 (dolist (subdir (directory-files dir))
1334 (when (let ((subdir (expand-file-name subdir dir)))
1335 (and (file-directory-p subdir)
1336 (file-exists-p
1337 (expand-file-name
1338 (package--description-file subdir)
1339 subdir))))
1340 (throw 'package-dir-found t)))))))
1341 (package-initialize))
1343 (setq after-init-time (current-time))
1344 ;; Display any accumulated warnings after all functions in
1345 ;; `after-init-hook' like `desktop-read' have finalized possible
1346 ;; changes in the window configuration.
1347 (run-hooks 'after-init-hook 'delayed-warnings-hook)
1349 ;; If *scratch* exists and init file didn't change its mode, initialize it.
1350 (if (get-buffer "*scratch*")
1351 (with-current-buffer "*scratch*"
1352 (if (eq major-mode 'fundamental-mode)
1353 (funcall initial-major-mode))))
1355 ;; Load library for our terminal type.
1356 ;; User init file can set term-file-prefix to nil to prevent this.
1357 (unless (or noninteractive
1358 initial-window-system
1359 (daemonp))
1360 (tty-run-terminal-initialization (selected-frame) nil t))
1362 ;; Update the out-of-memory error message based on user's key bindings
1363 ;; for save-some-buffers.
1364 (setq memory-signal-data
1365 (list 'error
1366 (substitute-command-keys "Memory exhausted--use \\[save-some-buffers] then exit and restart Emacs")))
1368 ;; Process the remaining args.
1369 (command-line-1 (cdr command-line-args))
1371 ;; This is a problem because, e.g. if emacs.d/gnus.el exists,
1372 ;; trying to load gnus could load the wrong file.
1373 ;; OK, it would not matter if .emacs.d were at the end of load-path.
1374 ;; but for the sake of simplicity, we discourage it full-stop.
1375 ;; Ref eg https://lists.gnu.org/r/emacs-devel/2012-03/msg00056.html
1377 ;; A bad element could come from user-emacs-file, the command line,
1378 ;; or EMACSLOADPATH, so we basically always have to check.
1379 (let (warned)
1380 (dolist (dir load-path)
1381 (and (not warned)
1382 (stringp dir)
1383 (string-equal (file-name-as-directory (expand-file-name dir))
1384 (expand-file-name user-emacs-directory))
1385 (setq warned t)
1386 (display-warning 'initialization
1387 (format-message "\
1388 Your `load-path' seems to contain\n\
1389 your `.emacs.d' directory: %s\n\
1390 This is likely to cause problems...\n\
1391 Consider using a subdirectory instead, e.g.: %s"
1392 dir (expand-file-name
1393 "lisp" user-emacs-directory))
1394 :warning))))
1396 ;; If -batch, terminate after processing the command options.
1397 (if noninteractive (kill-emacs t))
1399 ;; In daemon mode, start the server to allow clients to connect.
1400 ;; This is done after loading the user's init file and after
1401 ;; processing all command line arguments to allow e.g. `server-name'
1402 ;; to be changed before the server starts.
1403 (let ((dn (daemonp)))
1404 (when dn
1405 (when (stringp dn) (setq server-name dn))
1406 (server-start)
1407 (if server-process
1408 (daemon-initialized)
1409 (if (stringp dn)
1410 (message
1411 "Unable to start daemon: Emacs server named %S already running"
1412 server-name)
1413 (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."))
1414 (kill-emacs 1))))
1416 ;; Run emacs-session-restore (session management) if started by
1417 ;; the session manager and we have a session manager connection.
1418 (if (and (boundp 'x-session-previous-id)
1419 (stringp x-session-previous-id))
1420 (with-no-warnings
1421 (emacs-session-restore x-session-previous-id))))
1423 (defun x-apply-session-resources ()
1424 "Apply X resources which specify initial values for Emacs variables.
1425 This is called from a window-system initialization function, such
1426 as `x-initialize-window-system' for X, either at startup (prior
1427 to reading the init file), or afterwards when the user first
1428 opens a graphical frame.
1430 This can set the values of `menu-bar-mode', `tool-bar-mode', and
1431 `no-blinking-cursor', as well as the `cursor' face. Changed
1432 settings will be marked as \"CHANGED outside of Customize\"."
1433 (let ((no-vals '("no" "off" "false" "0"))
1434 (settings '(("menuBar" "MenuBar" menu-bar-mode nil)
1435 ("toolBar" "ToolBar" tool-bar-mode nil)
1436 ("scrollBar" "ScrollBar" scroll-bar-mode nil)
1437 ("cursorBlink" "CursorBlink" no-blinking-cursor t))))
1438 (dolist (x settings)
1439 (if (member (x-get-resource (nth 0 x) (nth 1 x)) no-vals)
1440 (set (nth 2 x) (nth 3 x)))))
1441 (let ((color (x-get-resource "cursorColor" "Foreground")))
1442 (when color
1443 (put 'cursor 'theme-face
1444 `((changed ((t :background ,color)))))
1445 (put 'cursor 'face-modified t))))
1447 (defcustom initial-scratch-message (purecopy "\
1448 ;; This buffer is for text that is not saved, and for Lisp evaluation.
1449 ;; To create a file, visit it with \\[find-file] and enter text in its buffer.
1452 "Initial documentation displayed in *scratch* buffer at startup.
1453 If this is nil, no message will be displayed."
1454 :type '(choice (text :tag "Message")
1455 (const :tag "none" nil))
1456 :group 'initialization)
1459 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1460 ;;; Fancy splash screen
1461 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1463 (defconst fancy-startup-text
1464 `((:face (variable-pitch font-lock-comment-face)
1465 "Welcome to "
1466 :link ("GNU Emacs"
1467 ,(lambda (_button) (browse-url "https://www.gnu.org/software/emacs/"))
1468 "Browse https://www.gnu.org/software/emacs/")
1469 ", one component of the "
1470 :link
1471 ,(lambda ()
1472 (if (eq system-type 'gnu/linux)
1473 `("GNU/Linux"
1474 ,(lambda (_button) (browse-url "https://www.gnu.org/gnu/linux-and-gnu.html"))
1475 "Browse https://www.gnu.org/gnu/linux-and-gnu.html")
1476 `("GNU" ,(lambda (_button)
1477 (browse-url "https://www.gnu.org/gnu/thegnuproject.html"))
1478 "Browse https://www.gnu.org/gnu/thegnuproject.html")))
1479 " operating system.\n\n"
1480 :face variable-pitch
1481 :link ("Emacs Tutorial" ,(lambda (_button) (help-with-tutorial)))
1482 "\tLearn basic keystroke commands"
1483 ,(lambda ()
1484 (let* ((en "TUTORIAL")
1485 (tut (or (get-language-info current-language-environment
1486 'tutorial)
1487 en))
1488 (title (with-temp-buffer
1489 (insert-file-contents
1490 (expand-file-name tut tutorial-directory)
1491 ;; We used to read only the first 256 bytes of
1492 ;; the tutorial, but that prevents the coding:
1493 ;; setting, if any, in file-local variables
1494 ;; section to be seen by insert-file-contents,
1495 ;; and results in gibberish when the language
1496 ;; environment's preferred encoding is
1497 ;; different from what the file-local variable
1498 ;; says. One case in point is Hebrew.
1499 nil)
1500 (search-forward ".")
1501 (buffer-substring (point-min) (1- (point))))))
1502 ;; If there is a specific tutorial for the current language
1503 ;; environment and it is not English, append its title.
1504 (if (string= en tut)
1506 (concat " (" title ")"))))
1507 "\n"
1508 :link ("Emacs Guided Tour"
1509 ,(lambda (_button)
1510 (browse-url "https://www.gnu.org/software/emacs/tour/"))
1511 "Browse https://www.gnu.org/software/emacs/tour/")
1512 "\tOverview of Emacs features at gnu.org\n"
1513 :link ("View Emacs Manual" ,(lambda (_button) (info-emacs-manual)))
1514 "\tView the Emacs manual using Info\n"
1515 :link ("Absence of Warranty" ,(lambda (_button) (describe-no-warranty)))
1516 "\tGNU Emacs comes with "
1517 :face (variable-pitch (:slant oblique))
1518 "ABSOLUTELY NO WARRANTY\n"
1519 :face variable-pitch
1520 :link ("Copying Conditions" ,(lambda (_button) (describe-copying)))
1521 "\tConditions for redistributing and changing Emacs\n"
1522 :link ("Ordering Manuals" ,(lambda (_button) (view-order-manuals)))
1523 "\tPurchasing printed copies of manuals\n"
1524 "\n"))
1525 "A list of texts to show in the middle part of splash screens.
1526 Each element in the list should be a list of strings or pairs
1527 `:face FACE', like `fancy-splash-insert' accepts them.")
1529 (defconst fancy-about-text
1530 `((:face (variable-pitch font-lock-comment-face)
1531 "This is "
1532 :link ("GNU Emacs"
1533 ,(lambda (_button) (browse-url "https://www.gnu.org/software/emacs/"))
1534 "Browse https://www.gnu.org/software/emacs/")
1535 ", one component of the "
1536 :link
1537 ,(lambda ()
1538 (if (eq system-type 'gnu/linux)
1539 `("GNU/Linux"
1540 ,(lambda (_button)
1541 (browse-url "https://www.gnu.org/gnu/linux-and-gnu.html"))
1542 "Browse https://www.gnu.org/gnu/linux-and-gnu.html")
1543 `("GNU" ,(lambda (_button) (describe-gnu-project))
1544 "Display info on the GNU project.")))
1545 " operating system.\n"
1546 :face (variable-pitch font-lock-builtin-face)
1547 "\n"
1548 ,(lambda () (emacs-version))
1549 "\n"
1550 :face (variable-pitch (:height 0.8))
1551 ,(lambda () emacs-copyright)
1552 "\n\n"
1553 :face variable-pitch
1554 :link ("Authors"
1555 ,(lambda (_button)
1556 (view-file (expand-file-name "AUTHORS" data-directory))
1557 (goto-char (point-min))))
1558 "\tMany people have contributed code included in GNU Emacs\n"
1559 :link ("Contributing"
1560 ,(lambda (_button) (info "(emacs)Contributing")))
1561 "\tHow to contribute improvements to Emacs\n"
1562 "\n"
1563 :link ("GNU and Freedom" ,(lambda (_button) (describe-gnu-project)))
1564 "\tWhy we developed GNU Emacs, and the GNU operating system\n"
1565 :link ("Absence of Warranty" ,(lambda (_button) (describe-no-warranty)))
1566 "\tGNU Emacs comes with "
1567 :face (variable-pitch (:slant oblique))
1568 "ABSOLUTELY NO WARRANTY\n"
1569 :face variable-pitch
1570 :link ("Copying Conditions" ,(lambda (_button) (describe-copying)))
1571 "\tConditions for redistributing and changing Emacs\n"
1572 :link ("Getting New Versions" ,(lambda (_button) (describe-distribution)))
1573 "\tHow to obtain the latest version of Emacs\n"
1574 :link ("Ordering Manuals" ,(lambda (_button) (view-order-manuals)))
1575 "\tBuying printed manuals from the FSF\n"
1576 "\n"
1577 :link ("Emacs Tutorial" ,(lambda (_button) (help-with-tutorial)))
1578 "\tLearn basic Emacs keystroke commands"
1579 ,(lambda ()
1580 (let* ((en "TUTORIAL")
1581 (tut (or (get-language-info current-language-environment
1582 'tutorial)
1583 en))
1584 (title (with-temp-buffer
1585 (insert-file-contents
1586 (expand-file-name tut tutorial-directory)
1587 ;; Read the entire file, to make sure any
1588 ;; coding cookies and other local variables
1589 ;; get acted upon.
1590 nil)
1591 (search-forward ".")
1592 (buffer-substring (point-min) (1- (point))))))
1593 ;; If there is a specific tutorial for the current language
1594 ;; environment and it is not English, append its title.
1595 (if (string= en tut)
1597 (concat " (" title ")"))))
1598 "\n"
1599 :link ("Emacs Guided Tour"
1600 ,(lambda (_button)
1601 (browse-url "https://www.gnu.org/software/emacs/tour/"))
1602 "Browse https://www.gnu.org/software/emacs/tour/")
1603 "\tSee an overview of Emacs features at gnu.org"))
1604 "A list of texts to show in the middle part of the About screen.
1605 Each element in the list should be a list of strings or pairs
1606 `:face FACE', like `fancy-splash-insert' accepts them.")
1609 (defgroup fancy-splash-screen ()
1610 "Fancy splash screen when Emacs starts."
1611 :version "21.1"
1612 :group 'initialization)
1614 (defcustom fancy-splash-image nil
1615 "The image to show in the splash screens, or nil for defaults."
1616 :group 'fancy-splash-screen
1617 :type '(choice (const :tag "Default" nil)
1618 (file :tag "File")))
1621 (defvar splash-screen-keymap
1622 (let ((map (make-sparse-keymap)))
1623 (suppress-keymap map)
1624 (set-keymap-parent map button-buffer-map)
1625 (define-key map "\C-?" 'scroll-down-command)
1626 (define-key map [?\S-\ ] 'scroll-down-command)
1627 (define-key map " " 'scroll-up-command)
1628 (define-key map "q" 'exit-splash-screen)
1629 map)
1630 "Keymap for splash screen buffer.")
1632 ;; These are temporary storage areas for the splash screen display.
1634 (defun fancy-splash-insert (&rest args)
1635 "Insert text into the current buffer, with faces.
1636 Arguments from ARGS should be either strings; functions called
1637 with no args that return a string; pairs `:face FACE', where FACE
1638 is a face specification usable with `put-text-property'; or pairs
1639 `:link LINK' where LINK is a list of arguments to pass to
1640 `insert-button', of the form (LABEL ACTION [HELP-ECHO]), which
1641 specifies the button's label, `action' property and help-echo string.
1642 FACE and LINK can also be functions, which are evaluated to obtain
1643 a face or button specification."
1644 (let ((current-face nil))
1645 (while args
1646 (cond ((eq (car args) :face)
1647 (setq args (cdr args) current-face (car args))
1648 (if (functionp current-face)
1649 (setq current-face (funcall current-face))))
1650 ((eq (car args) :link)
1651 (setq args (cdr args))
1652 (let ((spec (car args)))
1653 (if (functionp spec)
1654 (setq spec (funcall spec)))
1655 (insert-button (car spec)
1656 'face (list 'link current-face)
1657 'action (cadr spec)
1658 'help-echo (concat "mouse-2, RET: "
1659 (or (nth 2 spec)
1660 "Follow this link"))
1661 'follow-link t)))
1662 (t (insert (propertize (let ((it (car args)))
1663 (if (functionp it)
1664 (funcall it)
1665 it))
1666 'face current-face
1667 'help-echo (startup-echo-area-message)))))
1668 (setq args (cdr args)))))
1670 (declare-function image-size "image.c" (spec &optional pixels frame))
1672 (defun fancy-splash-image-file ()
1673 (cond ((stringp fancy-splash-image) fancy-splash-image)
1674 ((display-color-p)
1675 (cond ((<= (display-planes) 8)
1676 (if (image-type-available-p 'xpm)
1677 "splash.xpm"
1678 "splash.pbm"))
1679 ((or (image-type-available-p 'svg)
1680 (image-type-available-p 'imagemagick))
1681 "splash.svg")
1682 ((image-type-available-p 'png)
1683 "splash.png")
1684 ((image-type-available-p 'xpm)
1685 "splash.xpm")
1686 (t "splash.pbm")))
1687 (t "splash.pbm")))
1689 (defun fancy-splash-head ()
1690 "Insert the head part of the splash screen into the current buffer."
1691 (let* ((image-file (fancy-splash-image-file))
1692 (img (create-image image-file))
1693 (image-width (and img (car (image-size img))))
1694 (window-width (window-width)))
1695 (when img
1696 (when (> window-width image-width)
1697 ;; Center the image in the window.
1698 (insert (propertize " " 'display
1699 `(space :align-to (+ center (-0.5 . ,img)))))
1701 ;; Change the color of the XPM version of the splash image
1702 ;; so that it is visible with a dark frame background.
1703 (when (and (memq 'xpm img)
1704 (eq (frame-parameter nil 'background-mode) 'dark))
1705 (setq img (append img '(:color-symbols (("#000000" . "gray30"))))))
1707 ;; Insert the image with a help-echo and a link.
1708 (make-button (prog1 (point) (insert-image img)) (point)
1709 'face 'default
1710 'help-echo "mouse-2, RET: Browse https://www.gnu.org/"
1711 'action (lambda (_button) (browse-url "https://www.gnu.org/"))
1712 'follow-link t)
1713 (insert "\n\n")))))
1715 (defun fancy-startup-tail (&optional concise)
1716 "Insert the tail part of the splash screen into the current buffer."
1717 (unless concise
1718 (fancy-splash-insert
1719 :face 'variable-pitch
1720 "\nTo start... "
1721 :link `("Open a File"
1722 ,(lambda (_button) (call-interactively 'find-file))
1723 "Specify a new file's name, to edit the file")
1725 :link `("Open Home Directory"
1726 ,(lambda (_button) (dired "~"))
1727 "Open your home directory, to operate on its files")
1729 :link `("Customize Startup"
1730 ,(lambda (_button) (customize-group 'initialization))
1731 "Change initialization settings including this screen")
1732 "\n"))
1733 (fancy-splash-insert
1734 :face 'variable-pitch "To quit a partially entered command, type "
1735 :face 'default "Control-g"
1736 :face 'variable-pitch ".\n")
1737 (fancy-splash-insert :face `(variable-pitch font-lock-builtin-face)
1738 "\nThis is "
1739 (emacs-version)
1740 "\n"
1741 :face '(variable-pitch (:height 0.8))
1742 emacs-copyright
1743 "\n")
1744 (when auto-save-list-file-prefix
1745 (let ((dir (file-name-directory auto-save-list-file-prefix))
1746 (name (file-name-nondirectory auto-save-list-file-prefix))
1747 files)
1748 ;; Don't warn if the directory for auto-save-list files does not
1749 ;; yet exist.
1750 (and (file-directory-p dir)
1751 (setq files (directory-files dir nil (concat "\\`" name) t))
1752 (fancy-splash-insert :face '(variable-pitch font-lock-comment-face)
1753 (if (= (length files) 1)
1754 "\nAn auto-save file list was found. "
1755 "\nAuto-save file lists were found. ")
1756 "If an Emacs session crashed recently,\ntype "
1757 :link `("M-x recover-session RET"
1758 ,(lambda (_button)
1759 (call-interactively
1760 'recover-session)))
1761 " to recover the files you were editing."))))
1763 (when concise
1764 (fancy-splash-insert
1765 :face 'variable-pitch "\n"
1766 :link `("Dismiss this startup screen"
1767 ,(lambda (_button)
1768 (when startup-screen-inhibit-startup-screen
1769 (customize-set-variable 'inhibit-startup-screen t)
1770 (customize-mark-to-save 'inhibit-startup-screen)
1771 (custom-save-all))
1772 (let ((w (get-buffer-window "*GNU Emacs*")))
1773 (and w (not (one-window-p)) (delete-window w)))
1774 (kill-buffer "*GNU Emacs*")))
1775 " ")
1776 (when (or user-init-file custom-file)
1777 (let ((checked (create-image "checked.xpm"
1778 nil nil :ascent 'center))
1779 (unchecked (create-image "unchecked.xpm"
1780 nil nil :ascent 'center)))
1781 (insert-button
1783 :on-glyph checked
1784 :off-glyph unchecked
1785 'checked nil 'display unchecked 'follow-link t
1786 'action (lambda (button)
1787 (if (overlay-get button 'checked)
1788 (progn (overlay-put button 'checked nil)
1789 (overlay-put button 'display
1790 (overlay-get button :off-glyph))
1791 (setq startup-screen-inhibit-startup-screen
1792 nil))
1793 (overlay-put button 'checked t)
1794 (overlay-put button 'display
1795 (overlay-get button :on-glyph))
1796 (setq startup-screen-inhibit-startup-screen t)))))
1797 (fancy-splash-insert :face '(variable-pitch (:height 0.9))
1798 " Never show it again."))))
1800 (defun exit-splash-screen ()
1801 "Stop displaying the splash screen buffer."
1802 (interactive)
1803 (quit-window t))
1805 (defun fancy-startup-screen (&optional concise)
1806 "Display fancy startup screen.
1807 If CONCISE is non-nil, display a concise version of the
1808 splash screen in another window."
1809 (let ((splash-buffer (get-buffer-create "*GNU Emacs*")))
1810 (with-current-buffer splash-buffer
1811 (let ((inhibit-read-only t))
1812 (erase-buffer)
1813 (setq default-directory command-line-default-directory)
1814 (make-local-variable 'startup-screen-inhibit-startup-screen)
1815 (if pure-space-overflow
1816 (insert pure-space-overflow-message))
1817 (unless concise
1818 (fancy-splash-head))
1819 (dolist (text fancy-startup-text)
1820 (apply #'fancy-splash-insert text)
1821 (insert "\n"))
1822 (skip-chars-backward "\n")
1823 (delete-region (point) (point-max))
1824 (insert "\n")
1825 (fancy-startup-tail concise))
1826 (use-local-map splash-screen-keymap)
1827 (setq-local browse-url-browser-function 'eww-browse-url)
1828 (setq tab-width 22
1829 buffer-read-only t)
1830 (set-buffer-modified-p nil)
1831 (if (and view-read-only (not view-mode))
1832 (view-mode-enter nil 'kill-buffer))
1833 (goto-char (point-min))
1834 (forward-line (if concise 2 4)))
1835 (if concise
1836 (progn
1837 (display-buffer splash-buffer)
1838 ;; If the splash screen is in a split window, fit it.
1839 (let ((window (get-buffer-window splash-buffer t)))
1840 (or (null window)
1841 (eq window (selected-window))
1842 (eq window (next-window window))
1843 (fit-window-to-buffer window))))
1844 (switch-to-buffer splash-buffer))))
1846 (defun fancy-about-screen ()
1847 "Display fancy About screen."
1848 (let ((frame (fancy-splash-frame)))
1849 (save-selected-window
1850 (select-frame frame)
1851 (switch-to-buffer "*About GNU Emacs*")
1852 (setq buffer-undo-list t)
1853 (let ((inhibit-read-only t))
1854 (erase-buffer)
1855 (if pure-space-overflow
1856 (insert pure-space-overflow-message))
1857 (fancy-splash-head)
1858 (dolist (text fancy-about-text)
1859 (apply #'fancy-splash-insert text)
1860 (insert "\n"))
1861 (set-buffer-modified-p nil)
1862 (goto-char (point-min))
1863 (force-mode-line-update))
1864 (use-local-map splash-screen-keymap)
1865 (setq-local browse-url-browser-function 'eww-browse-url)
1866 (setq tab-width 22)
1867 (setq buffer-read-only t)
1868 (goto-char (point-min))
1869 (forward-line 3))))
1871 (defun fancy-splash-frame ()
1872 "Return the frame to use for the fancy splash screen.
1873 Returning non-nil does not mean we should necessarily
1874 use the fancy splash screen, but if we do use it,
1875 we put it on this frame."
1876 (let (chosen-frame)
1877 ;; MS-Windows needs this to have a chance to make the initial
1878 ;; frame visible.
1879 (if (eq (window-system) 'w32)
1880 (sit-for 0 t))
1881 (dolist (frame (append (frame-list) (list (selected-frame))))
1882 (if (and (frame-visible-p frame)
1883 (not (window-minibuffer-p (frame-selected-window frame))))
1884 (setq chosen-frame frame)))
1885 chosen-frame))
1887 (defun use-fancy-splash-screens-p ()
1888 "Return t if fancy splash screens should be used."
1889 (when (and (display-graphic-p)
1890 (or (and (display-color-p)
1891 (image-type-available-p 'xpm))
1892 (image-type-available-p 'pbm)))
1893 (let ((frame (fancy-splash-frame)))
1894 (when frame
1895 (let* ((img (create-image (fancy-splash-image-file)))
1896 (image-height (and img (cdr (image-size img nil frame))))
1897 ;; We test frame-height and not window-height so that,
1898 ;; if the frame is split by displaying a warning, that
1899 ;; doesn't cause the normal splash screen to be used.
1900 ;; We subtract 2 from frame-height to account for the
1901 ;; echo area and the mode line.
1902 (frame-height (- (frame-height frame) 2)))
1903 (> frame-height (+ image-height 19)))))))
1906 (defun normal-splash-screen (&optional startup concise)
1907 "Display non-graphic splash screen.
1908 If optional argument STARTUP is non-nil, display the startup screen
1909 after Emacs starts. If STARTUP is nil, display the About screen.
1910 If CONCISE is non-nil, display a concise version of the
1911 splash screen in another window."
1912 (let ((splash-buffer (get-buffer-create "*About GNU Emacs*")))
1913 (with-current-buffer splash-buffer
1914 (setq buffer-read-only nil)
1915 (erase-buffer)
1916 (setq default-directory command-line-default-directory)
1917 (set (make-local-variable 'tab-width) 8)
1919 (if pure-space-overflow
1920 (insert pure-space-overflow-message))
1922 ;; The convention for this piece of code is that
1923 ;; each piece of output starts with one or two newlines
1924 ;; and does not end with any newlines.
1925 (insert (if startup "Welcome to GNU Emacs" "This is GNU Emacs"))
1926 (insert
1927 (if (eq system-type 'gnu/linux)
1928 ", one component of the GNU/Linux operating system.\n"
1929 ", a part of the GNU operating system.\n"))
1931 (if startup
1932 (if (display-mouse-p)
1933 ;; The user can use the mouse to activate menus
1934 ;; so give help in terms of menu items.
1935 (normal-mouse-startup-screen)
1937 ;; No mouse menus, so give help using kbd commands.
1938 (normal-no-mouse-startup-screen))
1940 (normal-about-screen))
1942 ;; The rest of the startup screen is the same on all
1943 ;; kinds of terminals.
1945 ;; Give information on recovering, if there was a crash.
1946 (and startup
1947 auto-save-list-file-prefix
1948 ;; Don't signal an error if the
1949 ;; directory for auto-save-list files
1950 ;; does not yet exist.
1951 (file-directory-p (file-name-directory
1952 auto-save-list-file-prefix))
1953 (directory-files
1954 (file-name-directory auto-save-list-file-prefix)
1956 (concat "\\`"
1957 (regexp-quote (file-name-nondirectory
1958 auto-save-list-file-prefix)))
1960 (insert "\n\nIf an Emacs session crashed recently, "
1961 "type M-x recover-session RET\nto recover"
1962 " the files you were editing.\n"))
1964 (use-local-map splash-screen-keymap)
1966 ;; Display the input that we set up in the buffer.
1967 (set-buffer-modified-p nil)
1968 (setq buffer-read-only t)
1969 (if (and view-read-only (not view-mode))
1970 (view-mode-enter nil 'kill-buffer))
1971 (if startup (rename-buffer "*GNU Emacs*" t))
1972 (goto-char (point-min)))
1973 (if concise
1974 (display-buffer splash-buffer)
1975 (switch-to-buffer splash-buffer))))
1977 (defun normal-mouse-startup-screen ()
1978 ;; The user can use the mouse to activate menus
1979 ;; so give help in terms of menu items.
1980 (insert "\
1981 To follow a link, click Mouse-1 on it, or move to it and type RET.
1982 To quit a partially entered command, type Control-g.\n")
1984 (insert "\nImportant Help menu items:\n")
1985 (insert-button "Emacs Tutorial"
1986 'action (lambda (_button) (help-with-tutorial))
1987 'follow-link t)
1988 (insert "\t\tLearn basic Emacs keystroke commands\n")
1989 (insert-button "Read the Emacs Manual"
1990 'action (lambda (_button) (info-emacs-manual))
1991 'follow-link t)
1992 (insert "\tView the Emacs manual using Info\n")
1993 (insert-button "(Non)Warranty"
1994 'action (lambda (_button) (describe-no-warranty))
1995 'follow-link t)
1996 (insert "\t\tGNU Emacs comes with ABSOLUTELY NO WARRANTY\n")
1997 (insert-button "Copying Conditions"
1998 'action (lambda (_button) (describe-copying))
1999 'follow-link t)
2000 (insert "\tConditions for redistributing and changing Emacs\n")
2001 (insert-button "More Manuals / Ordering Manuals"
2002 'action (lambda (_button) (view-order-manuals))
2003 'follow-link t)
2004 (insert " How to order printed manuals from the FSF\n")
2006 (insert "\nUseful tasks:\n")
2007 (insert-button "Visit New File"
2008 'action (lambda (_button) (call-interactively 'find-file))
2009 'follow-link t)
2010 (insert (substitute-command-keys
2011 "\t\tSpecify a new file's name, to edit the file\n"))
2012 (insert-button "Open Home Directory"
2013 'action (lambda (_button) (dired "~"))
2014 'follow-link t)
2015 (insert "\tOpen your home directory, to operate on its files\n")
2016 (insert-button "Customize Startup"
2017 'action (lambda (_button) (customize-group 'initialization))
2018 'follow-link t)
2019 (insert "\tChange initialization settings including this screen\n")
2021 (insert "\n" (emacs-version)
2022 "\n" emacs-copyright))
2024 (defun normal-no-mouse-startup-screen ()
2025 "Show a splash screen suitable for displays without mouse support."
2026 (let* ((c-h-accessible
2027 ;; If normal-erase-is-backspace is used on a tty, there's
2028 ;; no way to invoke C-h and you have to use F1 instead.
2029 (or (not (char-table-p keyboard-translate-table))
2030 (eq (aref keyboard-translate-table ?\C-h) ?\C-h)))
2031 (minor-mode-overriding-map-alist
2032 (cons (cons (not c-h-accessible)
2033 ;; If C-h can't be invoked, temporarily disable its
2034 ;; binding, so where-is uses alternative bindings.
2035 (let ((map (make-sparse-keymap)))
2036 (define-key map [?\C-h] 'undefined)
2037 map))
2038 minor-mode-overriding-map-alist)))
2040 (insert (format "\nGet help\t %s\n"
2041 (let ((where (where-is-internal 'help-command nil t)))
2042 (cond
2043 ((equal where [?\C-h])
2044 "C-h (Hold down CTRL and press h)")
2045 (where (key-description where))
2046 (t "M-x help")))))
2047 (insert-button "Emacs manual"
2048 'action (lambda (_button) (info-emacs-manual))
2049 'follow-link t)
2050 (insert (substitute-command-keys"\t \\[info-emacs-manual]\t"))
2051 (insert-button "Browse manuals"
2052 'action (lambda (_button) (Info-directory))
2053 'follow-link t)
2054 (insert (substitute-command-keys "\t \\[info]\n"))
2055 (insert-button "Emacs tutorial"
2056 'action (lambda (_button) (help-with-tutorial))
2057 'follow-link t)
2058 (insert (substitute-command-keys
2059 "\t \\[help-with-tutorial]\tUndo changes\t \\[undo]\n"))
2060 (insert-button "Buy manuals"
2061 'action (lambda (_button) (view-order-manuals))
2062 'follow-link t)
2063 (insert (substitute-command-keys
2064 "\t \\[view-order-manuals]\tExit Emacs\t \\[save-buffers-kill-terminal]")))
2066 ;; Say how to use the menu bar with the keyboard.
2067 (insert "\n")
2068 (insert-button "Activate menubar"
2069 'action (lambda (_button) (tmm-menubar))
2070 'follow-link t)
2071 (if (and (eq (key-binding "\M-`") 'tmm-menubar)
2072 (eq (key-binding [f10]) 'tmm-menubar))
2073 (insert " F10 or ESC ` or M-`")
2074 (insert (substitute-command-keys " \\[tmm-menubar]")))
2076 ;; Many users seem to have problems with these.
2077 (insert (substitute-command-keys "
2078 \(`C-' means use the CTRL key. `M-' means use the Meta (or Alt) key.
2079 If you have no Meta key, you may instead type ESC followed by the character.)"))
2081 ;; Insert links to useful tasks
2082 (insert "\nUseful tasks:\n")
2084 (insert-button "Visit New File"
2085 'action (lambda (_button) (call-interactively 'find-file))
2086 'follow-link t)
2087 (insert "\t\t\t")
2088 (insert-button "Open Home Directory"
2089 'action (lambda (_button) (dired "~"))
2090 'follow-link t)
2091 (insert "\n")
2093 (insert-button "Customize Startup"
2094 'action (lambda (_button) (customize-group 'initialization))
2095 'follow-link t)
2096 (insert "\t\t")
2097 (insert-button "Open *scratch* buffer"
2098 'action (lambda (_button) (switch-to-buffer
2099 (get-buffer-create "*scratch*")))
2100 'follow-link t)
2101 (insert "\n")
2102 (insert "\n" (emacs-version) "\n" emacs-copyright "\n")
2103 (insert (substitute-command-keys
2105 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for "))
2106 (insert-button "full details"
2107 'action (lambda (_button) (describe-no-warranty))
2108 'follow-link t)
2109 (insert (substitute-command-keys ".
2110 Emacs is Free Software--Free as in Freedom--so you can redistribute copies
2111 of Emacs and modify it; type \\[describe-copying] to see "))
2112 (insert-button "the conditions"
2113 'action (lambda (_button) (describe-copying))
2114 'follow-link t)
2115 (insert (substitute-command-keys".
2116 Type \\[describe-distribution] for information on "))
2117 (insert-button "getting the latest version"
2118 'action (lambda (_button) (describe-distribution))
2119 'follow-link t)
2120 (insert "."))
2122 (defun normal-about-screen ()
2123 (insert "\n" (emacs-version) "\n" emacs-copyright "\n\n")
2125 (insert "To follow a link, click Mouse-1 on it, or move to it and type RET.\n\n")
2127 (insert-button "Authors"
2128 'action
2129 (lambda (_button)
2130 (view-file (expand-file-name "AUTHORS" data-directory))
2131 (goto-char (point-min)))
2132 'follow-link t)
2133 (insert "\t\tMany people have contributed code included in GNU Emacs\n")
2135 (insert-button "Contributing"
2136 'action
2137 (lambda (_button) (info "(emacs)Contributing"))
2138 'follow-link t)
2139 (insert "\tHow to contribute improvements to Emacs\n\n")
2141 (insert-button "GNU and Freedom"
2142 'action (lambda (_button) (describe-gnu-project))
2143 'follow-link t)
2144 (insert "\t\tWhy we developed GNU Emacs and the GNU system\n")
2146 (insert-button "Absence of Warranty"
2147 'action (lambda (_button) (describe-no-warranty))
2148 'follow-link t)
2149 (insert "\tGNU Emacs comes with ABSOLUTELY NO WARRANTY\n")
2151 (insert-button "Copying Conditions"
2152 'action (lambda (_button) (describe-copying))
2153 'follow-link t)
2154 (insert "\tConditions for redistributing and changing Emacs\n")
2156 (insert-button "Getting New Versions"
2157 'action (lambda (_button) (describe-distribution))
2158 'follow-link t)
2159 (insert "\tHow to get the latest version of GNU Emacs\n")
2161 (insert-button "More Manuals / Ordering Manuals"
2162 'action (lambda (_button) (view-order-manuals))
2163 'follow-link t)
2164 (insert "\tBuying printed manuals from the FSF\n"))
2166 (defun startup-echo-area-message ()
2167 (if (daemonp)
2168 "Starting Emacs daemon."
2169 (substitute-command-keys
2170 "For information about GNU Emacs and the GNU system, type \
2171 \\[about-emacs].")))
2173 (defun display-startup-echo-area-message ()
2174 (let ((resize-mini-windows t))
2175 (or noninteractive ;(input-pending-p) init-file-had-error
2176 ;; t if the init file says to inhibit the echo area startup message.
2177 (and inhibit-startup-echo-area-message
2178 user-init-file
2179 (or (and (get 'inhibit-startup-echo-area-message 'saved-value)
2180 (equal inhibit-startup-echo-area-message
2181 (if (equal init-file-user "")
2182 (user-login-name)
2183 init-file-user)))
2184 ;; Wasn't set with custom; see if .emacs has a setq.
2185 (condition-case nil
2186 (with-temp-buffer
2187 (insert-file-contents user-init-file)
2188 (re-search-forward
2189 (concat
2190 "([ \t\n]*setq[ \t\n]+"
2191 "inhibit-startup-echo-area-message[ \t\n]+"
2192 (regexp-quote
2193 (prin1-to-string
2194 (if (equal init-file-user "")
2195 (user-login-name)
2196 init-file-user)))
2197 "[ \t\n]*)")
2198 nil t))
2199 (error nil))))
2200 (message "%s" (startup-echo-area-message)))))
2202 (defun display-startup-screen (&optional concise)
2203 "Display startup screen according to display.
2204 A fancy display is used on graphic displays, normal otherwise.
2206 If CONCISE is non-nil, display a concise version of the startup
2207 screen."
2208 ;; Prevent recursive calls from server-process-filter.
2209 (if (not (get-buffer "*GNU Emacs*"))
2210 (if (use-fancy-splash-screens-p)
2211 (fancy-startup-screen concise)
2212 (normal-splash-screen t concise))))
2214 (defun display-about-screen ()
2215 "Display the *About GNU Emacs* buffer.
2216 A fancy display is used on graphic displays, normal otherwise."
2217 (interactive)
2218 (if (use-fancy-splash-screens-p)
2219 (fancy-about-screen)
2220 (normal-splash-screen nil)))
2222 (defalias 'about-emacs 'display-about-screen)
2223 (defalias 'display-splash-screen 'display-startup-screen)
2225 (defun command-line-1 (args-left)
2226 "A subroutine of `command-line'."
2227 (display-startup-echo-area-message)
2228 (when (and pure-space-overflow
2229 (not noninteractive))
2230 (display-warning
2231 'initialization
2232 "Building Emacs overflowed pure space.\
2233 (See the node Pure Storage in the Lisp manual for details.)"
2234 :warning))
2236 ;; `displayable-buffers' is a list of buffers that may be displayed,
2237 ;; which includes files parsed from the command line arguments and
2238 ;; `initial-buffer-choice'. All of the display logic happens at the
2239 ;; end of this `let'. As files as processed from the command line
2240 ;; arguments, their buffers are prepended to `displayable-buffers'.
2241 ;; In order for options like "--eval" to work with the "--file" arg,
2242 ;; the file buffers are set as the current buffer as they are seen
2243 ;; on the command line (so "emacs --batch --file a --file b
2244 ;; --eval='(message "%s" (buffer-name))'" will print "b"), but this
2245 ;; does not affect the final displayed state of the buffers.
2246 (let ((displayable-buffers nil))
2247 ;; This `let' processes the command line arguments.
2248 (let ((command-line-args-left args-left))
2249 (when command-line-args-left
2250 ;; We have command args; process them.
2251 (let* ((dir command-line-default-directory)
2253 ;; This approach loses for "-batch -L DIR --eval "(require foo)",
2254 ;; if foo is intended to be found in DIR.
2256 ;; The directories listed in --directory/-L options will *appear*
2257 ;; at the front of `load-path' in the order they appear on the
2258 ;; command-line. We cannot do this by *placing* them at the front
2259 ;; in the order they appear, so we need this variable to hold them,
2260 ;; temporarily.
2262 ;; To DTRT we keep track of the splice point and modify `load-path'
2263 ;; straight away upon any --directory/-L option.
2264 splice
2265 just-files ;; t if this follows the magic -- option.
2266 ;; This includes our standard options' long versions
2267 ;; and long versions of what's on command-switch-alist.
2268 (longopts
2269 (append '("--funcall" "--load" "--insert" "--kill"
2270 "--directory" "--eval" "--execute" "--no-splash"
2271 "--find-file" "--visit" "--file" "--no-desktop")
2272 (mapcar (lambda (elt) (concat "-" (car elt)))
2273 command-switch-alist)))
2274 (line 0)
2275 (column 0)
2276 ;; `process-file-arg' opens a file buffer for `name',
2277 ;; sets that buffer as the current buffer without
2278 ;; displaying it, adds the buffer to
2279 ;; `displayable-buffers', and puts the point at
2280 ;; `line':`column'. `line' and `column' are both reset
2281 ;; to zero when `process-file-arg' returns.
2282 (process-file-arg
2283 (lambda (name)
2284 ;; This can only happen if PWD is deleted.
2285 (if (not (or dir (file-name-absolute-p name)))
2286 (message "Ignoring relative file name (%s) due to \
2287 nil default-directory" name)
2288 (let* ((file (expand-file-name
2289 (command-line-normalize-file-name name)
2290 dir))
2291 (buf (find-file-noselect file)))
2292 (setq displayable-buffers (cons buf displayable-buffers))
2293 ;; Set the file buffer to the current buffer so
2294 ;; that it will be used with "--eval" and
2295 ;; similar options.
2296 (set-buffer buf)
2297 ;; Put the point at `line':`column' in the file
2298 ;; buffer, and reset `line' and `column' to 0.
2299 (unless (zerop line)
2300 (goto-char (point-min))
2301 (forward-line (1- line)))
2302 (setq line 0)
2303 (unless (< column 1)
2304 (move-to-column (1- column)))
2305 (setq column 0))))))
2307 ;; Add the long X options to longopts.
2308 (dolist (tem command-line-x-option-alist)
2309 (if (string-match "^--" (car tem))
2310 (push (car tem) longopts)))
2312 ;; Add the long NS options to longopts.
2313 (dolist (tem command-line-ns-option-alist)
2314 (if (string-match "^--" (car tem))
2315 (push (list (car tem)) longopts)))
2317 ;; Loop, processing options.
2318 (while command-line-args-left
2319 (let* ((argi (car command-line-args-left))
2320 (orig-argi argi)
2321 argval completion)
2322 (setq command-line-args-left (cdr command-line-args-left))
2324 ;; Do preliminary decoding of the option.
2325 (if just-files
2326 ;; After --, don't look for options; treat all args as files.
2327 (setq argi "")
2328 ;; Convert long options to ordinary options
2329 ;; and separate out an attached option argument into argval.
2330 (when (string-match "\\`\\(--[^=]*\\)=" argi)
2331 (setq argval (substring argi (match-end 0))
2332 argi (match-string 1 argi)))
2333 (when (string-match "\\`--?[^-]" orig-argi)
2334 (setq completion (try-completion argi longopts))
2335 (if (eq completion t)
2336 (setq argi (substring argi 1))
2337 (if (stringp completion)
2338 (let ((elt (member completion longopts)))
2339 (or elt
2340 (error "Option `%s' is ambiguous" argi))
2341 (setq argi (substring (car elt) 1)))
2342 (setq argval nil
2343 argi orig-argi)))))
2345 ;; Execute the option.
2346 (cond ((setq tem (assoc argi command-switch-alist))
2347 (if argval
2348 (let ((command-line-args-left
2349 (cons argval command-line-args-left)))
2350 (funcall (cdr tem) argi))
2351 (funcall (cdr tem) argi)))
2353 ((equal argi "-no-splash")
2354 (setq inhibit-startup-screen t))
2356 ((member argi '("-f" ; what the manual claims
2357 "-funcall"
2358 "-e")) ; what the source used to say
2359 (setq inhibit-startup-screen t)
2360 (setq tem (intern (or argval (pop command-line-args-left))))
2361 (if (commandp tem)
2362 (command-execute tem)
2363 (funcall tem)))
2365 ((member argi '("-eval" "-execute"))
2366 (setq inhibit-startup-screen t)
2367 (let* ((str-expr (or argval (pop command-line-args-left)))
2368 (read-data (read-from-string str-expr))
2369 (expr (car read-data))
2370 (end (cdr read-data)))
2371 (unless (= end (length str-expr))
2372 (error "Trailing garbage following expression: %s"
2373 (substring str-expr end)))
2374 (eval expr)))
2376 ((member argi '("-L" "-directory"))
2377 ;; -L :/foo adds /foo to the _end_ of load-path.
2378 (let (append)
2379 (if (string-match-p
2380 (format "\\`%s" path-separator)
2381 (setq tem (or argval (pop command-line-args-left))))
2382 (setq tem (substring tem 1)
2383 append t))
2384 (setq tem (expand-file-name
2385 (command-line-normalize-file-name tem)))
2386 (cond (append (setq load-path
2387 (append load-path (list tem)))
2388 (if splice (setq splice load-path)))
2389 (splice (setcdr splice (cons tem (cdr splice)))
2390 (setq splice (cdr splice)))
2391 (t (setq load-path (cons tem load-path)
2392 splice load-path)))))
2394 ((member argi '("-l" "-load"))
2395 (let* ((file (command-line-normalize-file-name
2396 (or argval (pop command-line-args-left))))
2397 ;; Take file from default dir if it exists there;
2398 ;; otherwise let `load' search for it.
2399 (file-ex (expand-file-name file)))
2400 (when (file-regular-p file-ex)
2401 (setq file file-ex))
2402 (load file nil t)))
2404 ;; This is used to handle -script. It's not clear
2405 ;; we need to document it (it is totally internal).
2406 ((member argi '("-scriptload"))
2407 (let* ((file (command-line-normalize-file-name
2408 (or argval (pop command-line-args-left))))
2409 ;; Take file from default dir.
2410 (file-ex (expand-file-name file)))
2411 (load file-ex nil t t)))
2413 ((equal argi "-insert")
2414 (setq inhibit-startup-screen t)
2415 (setq tem (or argval (pop command-line-args-left)))
2416 (or (stringp tem)
2417 (error "File name omitted from `-insert' option"))
2418 (insert-file-contents (command-line-normalize-file-name tem)))
2420 ((equal argi "-kill")
2421 (kill-emacs t))
2423 ;; This is for when they use --no-desktop with -q, or
2424 ;; don't load Desktop in their .emacs. If desktop.el
2425 ;; _is_ loaded, it will handle this switch, and we
2426 ;; won't see it by the time we get here.
2427 ((equal argi "-no-desktop")
2428 (message "\"--no-desktop\" ignored because the Desktop package is not loaded"))
2430 ((string-match "^\\+[0-9]+\\'" argi)
2431 (setq line (string-to-number argi)))
2433 ((string-match "^\\+\\([0-9]+\\):\\([0-9]+\\)\\'" argi)
2434 (setq line (string-to-number (match-string 1 argi))
2435 column (string-to-number (match-string 2 argi))))
2437 ((setq tem (assoc orig-argi command-line-x-option-alist))
2438 ;; Ignore X-windows options and their args if not using X.
2439 (setq command-line-args-left
2440 (nthcdr (nth 1 tem) command-line-args-left)))
2442 ((setq tem (assoc orig-argi command-line-ns-option-alist))
2443 ;; Ignore NS-windows options and their args if not using NS.
2444 (setq command-line-args-left
2445 (nthcdr (nth 1 tem) command-line-args-left)))
2447 ((member argi '("-find-file" "-file" "-visit"))
2448 (setq inhibit-startup-screen t)
2449 ;; An explicit option to specify visiting a file.
2450 (setq tem (or argval (pop command-line-args-left)))
2451 (unless (stringp tem)
2452 (error "File name omitted from `%s' option" argi))
2453 (funcall process-file-arg tem))
2455 ;; These command lines now have no effect.
2456 ((string-match "\\`--?\\(no-\\)?\\(uni\\|multi\\)byte$" argi)
2457 (display-warning 'initialization
2458 (format "Ignoring obsolete arg %s" argi)))
2460 ((equal argi "--")
2461 (setq just-files t))
2463 ;; We have almost exhausted our options. See if the
2464 ;; user has made any other command-line options available
2465 (let ((hooks command-line-functions)
2466 (did-hook nil))
2467 (while (and hooks
2468 (not (setq did-hook (funcall (car hooks)))))
2469 (setq hooks (cdr hooks)))
2470 (unless did-hook
2471 ;; Presume that the argument is a file name.
2472 (if (string-match "\\`-" argi)
2473 (error "Unknown option `%s'" argi))
2474 ;; FIXME: Why do we only inhibit the startup
2475 ;; screen for -nw?
2476 (unless initial-window-system
2477 (setq inhibit-startup-screen t))
2478 (funcall process-file-arg orig-argi)))))
2480 ;; In unusual circumstances, the execution of Lisp code due
2481 ;; to command-line options can cause the last visible frame
2482 ;; to be deleted. In this case, kill emacs to avoid an
2483 ;; abort later.
2484 (unless (frame-live-p (selected-frame)) (kill-emacs nil)))))))
2486 (when (eq initial-buffer-choice t)
2487 ;; When `initial-buffer-choice' equals t make sure that *scratch*
2488 ;; exists.
2489 (get-buffer-create "*scratch*"))
2491 ;; If *scratch* exists and is empty, insert initial-scratch-message.
2492 ;; Do this before switching to *scratch* below to handle bug#9605.
2493 (and initial-scratch-message
2494 (get-buffer "*scratch*")
2495 (with-current-buffer "*scratch*"
2496 (when (zerop (buffer-size))
2497 (insert (substitute-command-keys initial-scratch-message))
2498 (set-buffer-modified-p nil))))
2500 ;; Prepend `initial-buffer-choice' to `displayable-buffers'.
2501 (when initial-buffer-choice
2502 (let ((buf
2503 (cond ((stringp initial-buffer-choice)
2504 (find-file-noselect initial-buffer-choice))
2505 ((functionp initial-buffer-choice)
2506 (funcall initial-buffer-choice))
2507 ((eq initial-buffer-choice t)
2508 (get-buffer-create "*scratch*"))
2510 (error "initial-buffer-choice must be a string, a function, or t.")))))
2511 (unless (buffer-live-p buf)
2512 (error "initial-buffer-choice is not a live buffer."))
2513 (setq displayable-buffers (cons buf displayable-buffers))))
2515 ;; Display the first two buffers in `displayable-buffers'. If
2516 ;; `initial-buffer-choice' is non-nil, its buffer will be the
2517 ;; first buffer in `displayable-buffers'. The first buffer will
2518 ;; be focused.
2519 (let ((displayable-buffers-len (length displayable-buffers))
2520 ;; `nondisplayed-buffers-p' is true if there exist buffers
2521 ;; in `displayable-buffers' that were not displayed to the
2522 ;; user.
2523 (nondisplayed-buffers-p nil))
2524 (when (> displayable-buffers-len 0)
2525 (switch-to-buffer (car displayable-buffers)))
2526 (when (> displayable-buffers-len 1)
2527 (switch-to-buffer-other-window (car (cdr displayable-buffers)))
2528 ;; Focus on the first buffer.
2529 (other-window -1))
2530 (when (> displayable-buffers-len 2)
2531 (setq nondisplayed-buffers-p t))
2533 (if (or inhibit-startup-screen
2534 initial-buffer-choice
2535 noninteractive
2536 (daemonp)
2537 inhibit-x-resources)
2539 ;; Not displaying a startup screen. Display *Buffer List* if
2540 ;; there exist buffers that were not displayed.
2541 (when (and nondisplayed-buffers-p
2542 (not noninteractive)
2543 (not inhibit-startup-buffer-menu))
2544 (list-buffers))
2546 ;; Display a startup screen, after some preparations.
2548 ;; If there are no switches to process, we might as well
2549 ;; run this hook now, and there may be some need to do it
2550 ;; before doing any output.
2551 (run-hooks 'emacs-startup-hook 'term-setup-hook)
2553 ;; It's important to notice the user settings before we
2554 ;; display the startup message; otherwise, the settings
2555 ;; won't take effect until the user gives the first
2556 ;; keystroke, and that's distracting.
2557 (when (fboundp 'frame-notice-user-settings)
2558 (frame-notice-user-settings))
2560 ;; If there are no switches to process, we might as well
2561 ;; run this hook now, and there may be some need to do it
2562 ;; before doing any output.
2563 (run-hooks 'window-setup-hook)
2565 (setq inhibit-startup-hooks t)
2567 ;; ;; Do this now to avoid an annoying delay if the user
2568 ;; ;; clicks the menu bar during the sit-for.
2569 ;; (when (display-popup-menus-p)
2570 ;; (precompute-menubar-bindings))
2571 ;; (with-no-warnings
2572 ;; (setq menubar-bindings-done t))
2574 (display-startup-screen (> displayable-buffers-len 0))))))
2576 (defun command-line-normalize-file-name (file)
2577 "Collapse multiple slashes to one, to handle non-Emacs file names."
2578 (save-match-data
2579 ;; Use arg 1 so that we don't collapse // at the start of the file name.
2580 ;; That is significant on some systems.
2581 ;; However, /// at the beginning is supposed to mean just /, not //.
2582 (if (string-match
2583 (if (memq system-type '(ms-dos windows-nt))
2584 "^\\([\\/][\\/][\\/]\\)+"
2585 "^///+")
2586 file)
2587 (setq file (replace-match "/" t t file)))
2588 (if (memq system-type '(ms-dos windows-nt))
2589 (while (string-match "\\([\\/][\\/]\\)+" file 1)
2590 (setq file (replace-match "/" t t file)))
2591 (while (string-match "//+" file 1)
2592 (setq file (replace-match "/" t t file))))
2593 file))
2595 ;;; startup.el ends here