]> code.delx.au - gnu-emacs/blobdiff - lisp/paths.el
(normal-splash-screen, fancy-splash-screens-1): Add a reference to the Lisp
[gnu-emacs] / lisp / paths.el
index f2284fc8443761a3cbad6d98e971b078bda57f07..846f91793d146f7690236e5cc543094cfcba3e85 100644 (file)
@@ -1,6 +1,7 @@
-;;; paths.el --- define pathnames for use by various Emacs commands.
+;;; paths.el --- define pathnames for use by various Emacs commands -*- no-byte-compile: t -*-
 
-;; Copyright (C) 1986, 1988, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1986, 1988, 1994, 1999, 2000, 2002, 2003,
+;;   2004, 2005, 2006 Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: internal
@@ -19,8 +20,8 @@
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
 
 ;;; Commentary:
 
 
 ;;; Code:
 
+;; Docstrings in this file should, where reasonable, follow the
+;; conventions described in bindings.el, so that they get put in the
+;; DOC file rather than in memory.
+
+(defun prune-directory-list (dirs &optional keep reject)
+  "Returns a copy of DIRS with all non-existent directories removed.
+The optional argument KEEP is a list of directories to retain even if
+they don't exist, and REJECT is a list of directories to remove from
+DIRS, even if they exist; REJECT takes precedence over KEEP.
+
+Note that membership in REJECT and KEEP is checked using simple string
+comparison."
+  (apply #'nconc
+        (mapcar (lambda (dir)
+                  (and (not (member dir reject))
+                       (or (member dir keep) (file-directory-p dir))
+                       (list dir)))
+                   dirs)))
+
 (defvar Info-default-directory-list
-  (let* ((start (list "/usr/local/lib/info/"
-                     ;; This comes second so that, if it is the same
-                     ;; as configure-info-directory (which is usually true)
-                     ;; and Emacs has been installed (also usually true)
-                     ;; then the list will end with two copies of this;
-                     ;; which means that the last dir file Info-insert-dir
-                     ;; finds will be the one in this directory.
-                     "/usr/local/info/"))
-        ;; Typically on a GNU system, installed info files are found
-        ;; in /usr/info, but the default prefix is /usr/local.
-        ;; (Standalone info has a long list of alternative
-        ;; directories to search; perhaps we should try to be more
-        ;; consistent.)
-        (usrdir "/usr/info")
-        (sysdir (and (file-directory-p usrdir)
-                     (not (string= configure-info-directory usrdir))
-                     (list usrdir)))
-        (configdir (file-name-as-directory configure-info-directory)))
-    ;; configdir comes last so that we can identify it as such, but we
-    ;; also we override sysdir, hence the two occurrences.
-    (setq start (nconc start (list configdir) sysdir (list configdir)))
-    start)
+  (let* ((config-dir
+         (file-name-as-directory configure-info-directory))
+        (config
+         (list config-dir))
+        (unpruned-prefixes
+         ;; Directory trees that may not exist at installation time, and
+         ;; so shouldn't be pruned based on existance.
+         '("/usr/local/"))
+        (prefixes
+         ;; Directory trees in which to look for info subdirectories
+         (prune-directory-list '("/usr/local/" "/usr/" "/opt/" "/")
+                               unpruned-prefixes))
+        (suffixes
+         ;; Subdirectories in each directory tree that may contain info
+         ;; directories.
+         '("" "share/" "gnu/" "gnu/lib/" "gnu/lib/emacs/"
+           "emacs/" "lib/" "lib/emacs/"))
+        (standard-info-dirs
+         (apply #'nconc
+                (mapcar (lambda (pfx)
+                          (let ((dirs
+                                 (mapcar (lambda (sfx)
+                                           (concat pfx sfx "info/"))
+                                         suffixes)))
+                            (if (member pfx unpruned-prefixes)
+                                dirs
+                              (prune-directory-list dirs config))))
+                        prefixes))))
+    ;; If $(prefix)/info is not one of the standard info directories,
+    ;; they are probably installing an experimental version of Emacs,
+    ;; so make sure that experimental version's Info files override
+    ;; the ones in standard directories.
+    (if (member config-dir standard-info-dirs)
+       (nconc standard-info-dirs config)
+      (cons config-dir standard-info-dirs)))
   "Default list of directories to search for Info documentation files.
 They are searched in the order they are given in the list.
 Therefore, the directory of Info files that come with Emacs
-normally should come last (so that local files override standard ones).
+normally should come last (so that local files override standard ones),
+unless Emacs is installed into a non-standard directory.  In the latter
+case, the directory of Info files that come with Emacs should be
+first in this list.
 
 Once Info is started, the list of directories to search
 comes from the variable `Info-directory-list'.
 This variable `Info-default-directory-list' is used as the default
-for initializing `Info-directory-list' when Info is started.")
+for initializing `Info-directory-list' when Info is started, unless
+the environment variable INFOPATH is set.")
 
-(defvar news-path
+(defvar news-directory
   (if (file-exists-p "/usr/spool/news/")
       "/usr/spool/news/"
     "/var/spool/news/")
   "The root directory below which all news files are stored.")
+(defvaralias 'news-path 'news-directory)
 
 (defvar news-inews-program
   (cond ((file-exists-p "/usr/bin/inews") "/usr/bin/inews")
@@ -80,9 +118,9 @@ for initializing `Info-directory-list' when Info is started.")
        (t "inews"))
   "Program to post news.")
 
-(defvar gnus-default-nntp-server ""
-  ;; set this to your local server
-  "The name of the host running an NNTP server.
+;; set this to your local server
+(defvar gnus-default-nntp-server "" "\
+The name of the host running an NNTP server.
 The null string means use the local host as the server site.")
 
 (defvar gnus-nntp-service "nntp"
@@ -90,21 +128,20 @@ The null string means use the local host as the server site.")
 Go to a local news spool if its value is nil, in which case `gnus-nntp-server'
 should be set to `(system-name)'.")
 
-(defvar gnus-local-organization nil
-  "*The name of your organization, as a string.
+(defvar gnus-local-organization nil "\
+*The name of your organization, as a string.
 The `ORGANIZATION' environment variable is used instead if defined.")
 
-(defvar gnus-startup-file "~/.newsrc"
-  "The file listing groups to which user is subscribed.
-Will use `gnus-startup-file'-SERVER instead if exists.")
-
-(defvar rmail-file-name "~/RMAIL"
-  "Name of user's primary mail file.")
+(defcustom rmail-file-name "~/RMAIL"
+  "*Name of user's primary mail file."
+  :type 'string
+  :group 'rmail
+  :version "21.1")
 
-(defconst rmail-spool-directory
+(defvar rmail-spool-directory
   (cond ((string-match "^[^-]+-[^-]+-sco3.2v4" system-configuration)
         "/usr/spool/mail/")
-       ;; On The Bull DPX/2 /usr/spool/mail is used although 
+       ;; On The Bull DPX/2 /usr/spool/mail is used although
        ;; it is usg-unix-v.
        ((string-match "^m68k-bull-sysv3" system-configuration)
         "/usr/spool/mail/")
@@ -122,15 +159,17 @@ Will use `gnus-startup-file'-SERVER instead if exists.")
   "Name of directory used by system mailer for delivering new mail.
 Its name should end with a slash.")
 
-(defconst sendmail-program
+(defcustom sendmail-program
   (cond
     ((file-exists-p "/usr/sbin/sendmail") "/usr/sbin/sendmail")
     ((file-exists-p "/usr/lib/sendmail") "/usr/lib/sendmail")
     ((file-exists-p "/usr/ucblib/sendmail") "/usr/ucblib/sendmail")
     (t "fakemail"))                    ;In ../etc, to interface to /bin/mail.
-  "Program used to send messages.")
+  "Program used to send messages."
+  :group 'mail
+  :type 'file)
 
-(defconst remote-shell-program
+(defcustom remote-shell-program
   (cond
    ;; Some systems use rsh for the remote shell; others use that name for the
    ;; restricted shell and use remsh for the remote shell.  Let's try to guess
@@ -150,17 +189,21 @@ Its name should end with a slash.")
    ((file-exists-p "/bin/rcmd") "/bin/rcmd")
    ((file-exists-p "/bin/rsh") "/bin/rsh")
    ((file-exists-p "/usr/bin/rsh") "/usr/bin/rsh")
-   (t "rsh")))
+   (t "rsh"))
+  "File name for remote-shell program (often rsh or remsh)."
+  :group 'environment
+  :type 'file)
 
-(defconst term-file-prefix (if (eq system-type 'vax-vms) "[.term]" "term/")
-  "If non-nil, Emacs startup does (load (concat term-file-prefix (getenv \"TERM\")))
+(defvar term-file-prefix (if (eq system-type 'vax-vms) "[.term]" "term/") "\
+If non-nil, Emacs startup does (load (concat term-file-prefix (getenv \"TERM\")))
 You may set this variable to nil in your `.emacs' file if you do not wish
 the terminal-initialization file to be loaded.")
 
-(defconst abbrev-file-name 
+(defvar abbrev-file-name
   (if (eq system-type 'vax-vms)
       "~/abbrev.def"
     (convert-standard-filename "~/.abbrev_defs"))
   "*Default name of file to read abbrevs from.")
 
+;;; arch-tag: bae27ffb-9944-4c87-b569-30d4635a99e1
 ;;; paths.el ends here