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-2011  Free Software Foundation, Inc.
   4
   5 ;; Maintainer: FSF
   6 ;; Keywords: internal
   7 ;; Package: emacs
   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 make-docfile, 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   "\
  40 Return a copy of DIRS with all non-existent directories removed.
  41 The optional argument KEEP is a list of directories to retain even if
  42 they don't exist, and REJECT is a list of directories to remove from
  43 DIRS, even if they exist; REJECT takes precedence over KEEP.
  44
  45 Note that membership in REJECT and KEEP is checked using simple string
  46 comparison."
  47   (apply #'nconc
  48          (mapcar (lambda (dir)
  49                    (and (not (member dir reject))
  50                         (or (member dir keep) (file-directory-p dir))
  51                         (list dir)))
  52                     dirs)))
  53
  54 (defvar Info-default-directory-list
  55   (let* ((config-dir
  56           (file-name-as-directory configure-info-directory))
  57          (config
  58           (list config-dir))
  59          (unpruned-prefixes
  60           ;; Directory trees that may not exist at installation time, and
  61           ;; so shouldn't be pruned based on existence.
  62           '("/usr/local/"))
  63          (prefixes
  64           ;; Directory trees in which to look for info subdirectories
  65           (prune-directory-list '("/usr/local/" "/usr/" "/opt/" "/")
  66                                 unpruned-prefixes))
  67          (suffixes
  68           ;; Subdirectories in each directory tree that may contain info
  69           ;; directories.
  70           '("share/" "" "gnu/" "gnu/lib/" "gnu/lib/emacs/"
  71             "emacs/" "lib/" "lib/emacs/"))
  72          (standard-info-dirs
  73           (apply #'nconc
  74                  (mapcar (lambda (pfx)
  75                            (let ((dirs
  76                                   (mapcar (lambda (sfx)
  77                                             (concat pfx sfx "info/"))
  78                                           suffixes)))
  79                              (if (member pfx unpruned-prefixes)
  80                                  dirs
  81                                (prune-directory-list dirs config))))
  82                          prefixes))))
  83     ;; If $(prefix)/share/info is not one of the standard info
  84     ;; directories, they are probably installing an experimental
  85     ;; version of Emacs, so make sure that experimental version's Info
  86     ;; files override the ones in standard directories.
  87     (if (member config-dir standard-info-dirs)
  88         (nconc standard-info-dirs config)
  89       (cons config-dir standard-info-dirs)))
  90   "Default list of directories to search for Info documentation files.
  91 They are searched in the order they are given in the list.
  92 Therefore, the directory of Info files that come with Emacs
  93 normally should come last (so that local files override standard ones),
  94 unless Emacs is installed into a non-standard directory.  In the latter
  95 case, the directory of Info files that come with Emacs should be
  96 first in this list.
  97
  98 Once Info is started, the list of directories to search
  99 comes from the variable `Info-directory-list'.
 100 This variable `Info-default-directory-list' is used as the default
 101 for initializing `Info-directory-list' when Info is started, unless
 102 the environment variable INFOPATH is set.")
 103
 104 (defvar news-directory
 105   (purecopy (if (file-exists-p "/usr/spool/news/")
 106       "/usr/spool/news/"
 107     "/var/spool/news/"))
 108   "The root directory below which all news files are stored.")
 109 (defvaralias 'news-path 'news-directory)
 110
 111 (defvar news-inews-program
 112   (purecopy
 113   (cond ((file-exists-p "/usr/bin/inews") "/usr/bin/inews")
 114         ((file-exists-p "/usr/local/inews") "/usr/local/inews")
 115         ((file-exists-p "/usr/local/bin/inews") "/usr/local/bin/inews")
 116         ((file-exists-p "/usr/contrib/lib/news/inews") "/usr/contrib/lib/news/inews")
 117         ((file-exists-p "/usr/lib/news/inews") "/usr/lib/news/inews")
 118         (t "inews")))
 119   "Program to post news.")
 120
 121 ;; set this to your local server
 122 (defvar gnus-default-nntp-server (purecopy "") "\
 123 The name of the host running an NNTP server.
 124 The null string means use the local host as the server site.")
 125
 126 (defvar gnus-nntp-service (purecopy "nntp") "\
 127 NNTP service name, usually \"nntp\" or 119.
 128 Go to a local news spool if its value is nil, in which case `gnus-nntp-server'
 129 should be set to `(system-name)'.")
 130
 131 (defvar gnus-local-organization nil "\
 132 *The name of your organization, as a string.
 133 The `ORGANIZATION' environment variable is used instead if defined.")
 134
 135 (defcustom rmail-file-name (purecopy "~/RMAIL") "\
 136 Name of user's primary mail file."
 137   :type 'string
 138   :group 'rmail
 139   :version "21.1")
 140
 141 (defvar rmail-spool-directory
 142   (purecopy
 143   (cond ((file-exists-p "/var/mail")
 144          ;; SVR4 and recent BSD are said to use this.
 145          ;; Rather than trying to know precisely which systems use it,
 146          ;; let's assume this dir is never used for anything else.
 147          "/var/mail/")
 148         ;; Many GNU/Linux systems use this name.
 149         ((file-exists-p "/var/spool/mail")
 150          "/var/spool/mail/")
 151         ((memq system-type '(hpux usg-unix-v irix))
 152          "/usr/mail/")
 153         (t "/usr/spool/mail/")))
 154   "Name of directory used by system mailer for delivering new mail.
 155 Its name should end with a slash.")
 156
 157 (defcustom remote-shell-program
 158   (purecopy
 159   (cond
 160    ;; Some systems use rsh for the remote shell; others use that name for the
 161    ;; restricted shell and use remsh for the remote shell.  Let's try to guess
 162    ;; based on what we actually find out there.  The restricted shell is
 163    ;; almost certainly in /bin or /usr/bin, so it's probably safe to assume
 164    ;; that an rsh found elsewhere is the remote shell program.  The converse
 165    ;; is not true: /usr/bin/rsh could be either one, so check that last.
 166    ((file-exists-p "/usr/ucb/remsh") "/usr/ucb/remsh")
 167    ((file-exists-p "/usr/bsd/remsh") "/usr/bsd/remsh")
 168    ((file-exists-p "/bin/remsh") "/bin/remsh")
 169    ((file-exists-p "/usr/bin/remsh") "/usr/bin/remsh")
 170    ((file-exists-p "/usr/local/bin/remsh") "/usr/local/bin/remsh")
 171    ((file-exists-p "/usr/ucb/rsh") "/usr/ucb/rsh")
 172    ((file-exists-p "/usr/bsd/rsh") "/usr/bsd/rsh")
 173    ((file-exists-p "/usr/local/bin/rsh") "/usr/local/bin/rsh")
 174    ((file-exists-p "/usr/bin/rcmd") "/usr/bin/rcmd")
 175    ((file-exists-p "/bin/rcmd") "/bin/rcmd")
 176    ((file-exists-p "/bin/rsh") "/bin/rsh")
 177    ((file-exists-p "/usr/bin/rsh") "/usr/bin/rsh")
 178    (t "rsh")))
 179   "File name for remote-shell program (often rsh or remsh)."
 180   :group 'environment
 181   :type 'file)
 182
 183 (defvar term-file-prefix (purecopy "term/") "\
 184 If non-nil, Emacs startup does (load (concat term-file-prefix (getenv \"TERM\")))
 185 You may set this variable to nil in your `.emacs' file if you do not wish
 186 the terminal-initialization file to be loaded.")
 187
 188 ;;; paths.el ends here