lisp/paths.el

   1 ;;; paths.el --- define pathnames for use by various Emacs commands -*- no-byte-compile: t -*-
   2
   3 ;; Copyright (C) 1986, 1988, 1994, 1999, 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008  Free Software Foundation, Inc.
   5
   6 ;; Maintainer: FSF
   7 ;; Keywords: internal
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;; These are default settings for names of certain files and directories
  27 ;; that Emacs needs to refer to from time to time.
  28
  29 ;; If these settings are not right, override them with `setq'
  30 ;; in site-init.el.  Do not change this file.
  31
  32 ;;; Code:
  33
  34 ;; Docstrings in this file should, where reasonable, follow the
  35 ;; conventions described in bindings.el, so that they get put in the
  36 ;; DOC file rather than in memory.
  37
  38 (defun prune-directory-list (dirs &optional keep reject)
  39   "Returns a copy of DIRS with all non-existent directories removed.
  40 The optional argument KEEP is a list of directories to retain even if
  41 they don't exist, and REJECT is a list of directories to remove from
  42 DIRS, even if they exist; REJECT takes precedence over KEEP.
  43
  44 Note that membership in REJECT and KEEP is checked using simple string
  45 comparison."
  46   (apply #'nconc
  47          (mapcar (lambda (dir)
  48                    (and (not (member dir reject))
  49                         (or (member dir keep) (file-directory-p dir))
  50                         (list dir)))
  51                     dirs)))
  52
  53 (defvar Info-default-directory-list
  54   (let* ((config-dir
  55           (file-name-as-directory configure-info-directory))
  56          (config
  57           (list config-dir))
  58          (unpruned-prefixes
  59           ;; Directory trees that may not exist at installation time, and
  60           ;; so shouldn't be pruned based on existance.
  61           '("/usr/local/"))
  62          (prefixes
  63           ;; Directory trees in which to look for info subdirectories
  64           (prune-directory-list '("/usr/local/" "/usr/" "/opt/" "/")
  65                                 unpruned-prefixes))
  66          (suffixes
  67           ;; Subdirectories in each directory tree that may contain info
  68           ;; directories.
  69           '("share/" "" "gnu/" "gnu/lib/" "gnu/lib/emacs/"
  70             "emacs/" "lib/" "lib/emacs/"))
  71          (standard-info-dirs
  72           (apply #'nconc
  73                  (mapcar (lambda (pfx)
  74                            (let ((dirs
  75                                   (mapcar (lambda (sfx)
  76                                             (concat pfx sfx "info/"))
  77                                           suffixes)))
  78                              (if (member pfx unpruned-prefixes)
  79                                  dirs
  80                                (prune-directory-list dirs config))))
  81                          prefixes))))
  82     ;; If $(prefix)/share/info is not one of the standard info
  83     ;; directories, they are probably installing an experimental
  84     ;; version of Emacs, so make sure that experimental version's Info
  85     ;; files override the ones in standard directories.
  86     (if (member config-dir standard-info-dirs)
  87         (nconc standard-info-dirs config)
  88       (cons config-dir standard-info-dirs)))
  89   "Default list of directories to search for Info documentation files.
  90 They are searched in the order they are given in the list.
  91 Therefore, the directory of Info files that come with Emacs
  92 normally should come last (so that local files override standard ones),
  93 unless Emacs is installed into a non-standard directory.  In the latter
  94 case, the directory of Info files that come with Emacs should be
  95 first in this list.
  96
  97 Once Info is started, the list of directories to search
  98 comes from the variable `Info-directory-list'.
  99 This variable `Info-default-directory-list' is used as the default
 100 for initializing `Info-directory-list' when Info is started, unless
 101 the environment variable INFOPATH is set.")
 102
 103 (defvar news-directory
 104   (if (file-exists-p "/usr/spool/news/")
 105       "/usr/spool/news/"
 106     "/var/spool/news/")
 107   "The root directory below which all news files are stored.")
 108 (defvaralias 'news-path 'news-directory)
 109
 110 (defvar news-inews-program
 111   (cond ((file-exists-p "/usr/bin/inews") "/usr/bin/inews")
 112         ((file-exists-p "/usr/local/inews") "/usr/local/inews")
 113         ((file-exists-p "/usr/local/bin/inews") "/usr/local/bin/inews")
 114         ((file-exists-p "/usr/contrib/lib/news/inews") "/usr/contrib/lib/news/inews")
 115         ((file-exists-p "/usr/lib/news/inews") "/usr/lib/news/inews")
 116         (t "inews"))
 117   "Program to post news.")
 118
 119 ;; set this to your local server
 120 (defvar gnus-default-nntp-server "" "\
 121 The name of the host running an NNTP server.
 122 The null string means use the local host as the server site.")
 123
 124 (defvar gnus-nntp-service "nntp"
 125   "NNTP service name, usually \"nntp\" or 119).
 126 Go to a local news spool if its value is nil, in which case `gnus-nntp-server'
 127 should be set to `(system-name)'.")
 128
 129 (defvar gnus-local-organization nil "\
 130 *The name of your organization, as a string.
 131 The `ORGANIZATION' environment variable is used instead if defined.")
 132
 133 (defcustom rmail-file-name "~/RMAIL"
 134   "*Name of user's primary mail file."
 135   :type 'string
 136   :group 'rmail
 137   :version "21.1")
 138
 139 (defvar rmail-spool-directory
 140   (cond ((file-exists-p "/var/mail")
 141          ;; SVR4 and recent BSD are said to use this.
 142          ;; Rather than trying to know precisely which systems use it,
 143          ;; let's assume this dir is never used for anything else.
 144          "/var/mail/")
 145         ;; Many GNU/Linux systems use this name.
 146         ((file-exists-p "/var/spool/mail")
 147          "/var/spool/mail/")
 148         ((memq system-type '(hpux usg-unix-v irix))
 149          "/usr/mail/")
 150         (t "/usr/spool/mail/"))
 151   "Name of directory used by system mailer for delivering new mail.
 152 Its name should end with a slash.")
 153
 154 (defcustom remote-shell-program
 155   (cond
 156    ;; Some systems use rsh for the remote shell; others use that name for the
 157    ;; restricted shell and use remsh for the remote shell.  Let's try to guess
 158    ;; based on what we actually find out there.  The restricted shell is
 159    ;; almost certainly in /bin or /usr/bin, so it's probably safe to assume
 160    ;; that an rsh found elsewhere is the remote shell program.  The converse
 161    ;; is not true: /usr/bin/rsh could be either one, so check that last.
 162    ((file-exists-p "/usr/ucb/remsh") "/usr/ucb/remsh")
 163    ((file-exists-p "/usr/bsd/remsh") "/usr/bsd/remsh")
 164    ((file-exists-p "/bin/remsh") "/bin/remsh")
 165    ((file-exists-p "/usr/bin/remsh") "/usr/bin/remsh")
 166    ((file-exists-p "/usr/local/bin/remsh") "/usr/local/bin/remsh")
 167    ((file-exists-p "/usr/ucb/rsh") "/usr/ucb/rsh")
 168    ((file-exists-p "/usr/bsd/rsh") "/usr/bsd/rsh")
 169    ((file-exists-p "/usr/local/bin/rsh") "/usr/local/bin/rsh")
 170    ((file-exists-p "/usr/bin/rcmd") "/usr/bin/rcmd")
 171    ((file-exists-p "/bin/rcmd") "/bin/rcmd")
 172    ((file-exists-p "/bin/rsh") "/bin/rsh")
 173    ((file-exists-p "/usr/bin/rsh") "/usr/bin/rsh")
 174    (t "rsh"))
 175   "File name for remote-shell program (often rsh or remsh)."
 176   :group 'environment
 177   :type 'file)
 178
 179 (defvar term-file-prefix "term/" "\
 180 If non-nil, Emacs startup does (load (concat term-file-prefix (getenv \"TERM\")))
 181 You may set this variable to nil in your `.emacs' file if you do not wish
 182 the terminal-initialization file to be loaded.")
 183
 184 (defvar abbrev-file-name
 185   (convert-standard-filename "~/.abbrev_defs")
 186   "*Default name of file to read abbrevs from.")
 187
 188 ;; arch-tag: bae27ffb-9944-4c87-b569-30d4635a99e1
 189 ;;; paths.el ends here