cgit.sxemacs.org Git - gnus/blob - lisp/gnus-start.el

   1 ;;; gnus-start.el --- startup functions for Gnus
   2
   3 ;; Copyright (C) 1996-2014 Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;;; Code:
  26
  27 (require 'gnus)
  28 (require 'gnus-win)
  29 (require 'gnus-int)
  30 (require 'gnus-spec)
  31 (require 'gnus-range)
  32 (require 'gnus-util)
  33 (require 'gnus-cloud)
  34 (autoload 'message-make-date "message")
  35 (autoload 'gnus-agent-read-servers-validate "gnus-agent")
  36 (autoload 'gnus-agent-save-local "gnus-agent")
  37 (autoload 'gnus-agent-possibly-alter-active "gnus-agent")
  38
  39 (eval-when-compile
  40   (require 'cl))
  41
  42 (defvar gnus-agent-covered-methods)
  43 (defvar gnus-agent-file-loading-local)
  44 (defvar gnus-agent-file-loading-cache)
  45
  46 (defcustom gnus-startup-file (nnheader-concat gnus-home-directory ".newsrc")
  47   "Your `.newsrc' file.
  48 `.newsrc-SERVER' will be used instead if that exists."
  49   :group 'gnus-start
  50   :type 'file)
  51
  52 (defcustom gnus-backup-startup-file 'never
  53   "Control use of version numbers for backups of `gnus-startup-file'.
  54 This variable takes the same values as the `version-control'
  55 variable."
  56   :version "22.1"
  57   :group 'gnus-start
  58   :type '(choice (const :tag "Never" never)
  59                  (const :tag "If existing" nil)
  60                  (other :tag "Always" t)))
  61
  62 (defcustom gnus-save-startup-file-via-temp-buffer t
  63   "Whether to write the startup file contents to a buffer then save
  64 the buffer or write directly to the file.  The buffer is faster
  65 because all of the contents are written at once.  The direct write
  66 uses considerably less memory."
  67   :version "22.1"
  68   :group 'gnus-start
  69   :type '(choice (const :tag "Write via buffer" t)
  70                  (const :tag "Write directly to file" nil)))
  71
  72 (defcustom gnus-init-file (nnheader-concat gnus-home-directory ".gnus")
  73   "Your Gnus Emacs-Lisp startup file name.
  74 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
  75   :group 'gnus-start
  76   :type 'file)
  77
  78 (defcustom gnus-site-init-file
  79   (condition-case nil
  80       (concat (file-name-directory
  81                (directory-file-name installation-directory))
  82               "site-lisp/gnus-init")
  83     (error nil))
  84   "The site-wide Gnus Emacs-Lisp startup file name, or nil if none.
  85 If a file with the `.el' or `.elc' suffixes exists, it will be read instead."
  86   :group 'gnus-start
  87   :type '(choice file (const nil)))
  88
  89 (defcustom gnus-use-dribble-file t
  90   "*Non-nil means that Gnus will use a dribble file to store user updates.
  91 If Emacs should crash without saving the .newsrc files, complete
  92 information can be restored from the dribble file."
  93   :group 'gnus-dribble-file
  94   :type 'boolean)
  95
  96 (defcustom gnus-dribble-directory nil
  97   "*The directory where dribble files will be saved.
  98 If this variable is nil, the directory where the .newsrc files are
  99 saved will be used."
 100   :group 'gnus-dribble-file
 101   :type '(choice directory (const nil)))
 102
 103 (defcustom gnus-check-new-newsgroups 'ask-server
 104   "*Non-nil means that Gnus will run `gnus-find-new-newsgroups' at startup.
 105 This normally finds new newsgroups by comparing the active groups the
 106 servers have already reported with those Gnus already knows, either alive
 107 or killed.
 108
 109 When any of the following are true, `gnus-find-new-newsgroups' will instead
 110 ask the servers (primary, secondary, and archive servers) to list new
 111 groups since the last time it checked:
 112   1. This variable is `ask-server'.
 113   2. This variable is a list of select methods (see below).
 114   3. Option `gnus-read-active-file' is nil or `some'.
 115   4. A prefix argument is given to `gnus-find-new-newsgroups' interactively.
 116
 117 Thus, if this variable is `ask-server' or a list of select methods or
 118 `gnus-read-active-file' is nil or `some', then the killed list is no
 119 longer necessary, so you could safely set `gnus-save-killed-list' to nil.
 120
 121 This variable can be a list of select methods which Gnus will query with
 122 the `ask-server' method in addition to the primary, secondary, and archive
 123 servers.
 124
 125 E.g.:
 126   (setq gnus-check-new-newsgroups
 127         '((nntp \"some.server\") (nntp \"other.server\")))
 128
 129 If this variable is nil, then you have to tell Gnus explicitly to
 130 check for new newsgroups with \\<gnus-group-mode-map>\\[gnus-find-new-newsgroups]."
 131   :group 'gnus-start
 132   :type '(choice (const :tag "no" nil)
 133                  (const :tag "by brute force" t)
 134                  (const :tag "ask servers" ask-server)
 135                  (repeat :menu-tag "ask additional servers"
 136                          :tag "ask additional servers"
 137                          :value ((nntp ""))
 138                          (sexp :format "%v"))))
 139
 140 (defcustom gnus-check-bogus-newsgroups nil
 141   "*Non-nil means that Gnus will check and remove bogus newsgroup at startup.
 142 If this variable is nil, then you have to tell Gnus explicitly to
 143 check for bogus newsgroups with \\<gnus-group-mode-map>\\[gnus-group-check-bogus-groups]."
 144   :group 'gnus-start-server
 145   :type 'boolean)
 146
 147 (defcustom gnus-read-active-file 'some
 148   "*Non-nil means that Gnus will read the entire active file at startup.
 149 If this variable is nil, Gnus will only know about the groups in your
 150 `.newsrc' file.
 151
 152 If this variable is `some', Gnus will try to only read the relevant
 153 parts of the active file from the server.  Not all servers support
 154 this, and it might be quite slow with other servers, but this should
 155 generally be faster than both the t and nil value.
 156
 157 If you set this variable to nil or `some', you probably still want to
 158 be told about new newsgroups that arrive.  To do that, set
 159 `gnus-check-new-newsgroups' to `ask-server'.  This may not work
 160 properly with all servers."
 161   :group 'gnus-start-server
 162   :type '(choice (const nil)
 163                  (const some)
 164                  (const t)))
 165
 166 (defconst gnus-level-subscribed 5
 167   "Groups with levels less than or equal to this variable are subscribed.")
 168
 169 (defconst gnus-level-unsubscribed 7
 170   "Groups with levels less than or equal to this variable are unsubscribed.
 171
 172 Groups with levels less than `gnus-level-subscribed', which
 173 should be less than this variable, are subscribed.  Groups with
 174 levels from `gnus-level-subscribed' (exclusive) upto this
 175 variable (inclusive) are unsubscribed.  See also
 176 `gnus-level-zombie', `gnus-level-killed' and the Info node `(gnus)Group
 177 Levels' for details.")
 178
 179 (defconst gnus-level-zombie 8
 180   "Groups with this level are zombie groups.")
 181
 182 (defconst gnus-level-killed 9
 183   "Groups with this level are killed.")
 184
 185 (defcustom gnus-level-default-subscribed 3
 186   "*New subscribed groups will be subscribed at this level."
 187   :group 'gnus-group-levels
 188   :type 'integer)
 189
 190 (defcustom gnus-level-default-unsubscribed 6
 191   "*New unsubscribed groups will be unsubscribed at this level."
 192   :group 'gnus-group-levels
 193   :type 'integer)
 194
 195 (defcustom gnus-activate-level (1+ gnus-level-subscribed)
 196   "*Groups higher than this level won't be activated on startup.
 197 Setting this variable to something low might save lots of time when
 198 you have many groups that you aren't interested in."
 199   :group 'gnus-group-levels
 200   :type 'integer)
 201
 202 (defcustom gnus-activate-foreign-newsgroups 4
 203   "*If nil, Gnus will not check foreign newsgroups at startup.
 204 If it is non-nil, it should be a number between one and nine.  Foreign
 205 newsgroups that have a level lower or equal to this number will be
 206 activated on startup.  For instance, if you want to active all
 207 subscribed newsgroups, but not the rest, you'd set this variable to
 208 `gnus-level-subscribed'.
 209
 210 If you subscribe to lots of newsgroups from different servers, startup
 211 might take a while.  By setting this variable to nil, you'll save time,
 212 but you won't be told how many unread articles there are in the
 213 groups."
 214   :group 'gnus-group-levels
 215   :type '(choice integer
 216                  (const :tag "none" nil)))
 217
 218 (defcustom gnus-read-newsrc-file t
 219   "*Non-nil means that Gnus will read the `.newsrc' file.
 220 Gnus always reads its own startup file, which is called
 221 \".newsrc.eld\".  The file called \".newsrc\" is in a format that can
 222 be readily understood by other newsreaders.  If you don't plan on
 223 using other newsreaders, set this variable to nil to save some time on
 224 entry."
 225   :version "21.1"
 226   :group 'gnus-newsrc
 227   :type 'boolean)
 228
 229 (defcustom gnus-save-newsrc-file t
 230   "*Non-nil means that Gnus will save the `.newsrc' file.
 231 Gnus always saves its own startup file, which is called
 232 \".newsrc.eld\".  The file called \".newsrc\" is in a format that can
 233 be readily understood by other newsreaders.  If you don't plan on
 234 using other newsreaders, set this variable to nil to save some time on
 235 exit."
 236   :group 'gnus-newsrc
 237   :type 'boolean)
 238
 239 (defcustom gnus-save-killed-list t
 240   "*If non-nil, save the list of killed groups to the startup file.
 241 If you set this variable to nil, you'll save both time (when starting
 242 and quitting) and space (both memory and disk), but it will also mean
 243 that Gnus has no record of which groups are new and which are old, so
 244 the automatic new newsgroups subscription methods become meaningless.
 245
 246 You should always set `gnus-check-new-newsgroups' to `ask-server' or
 247 nil if you set this variable to nil.
 248
 249 This variable can also be a regexp.  In that case, all groups that do
 250 not match this regexp will be removed before saving the list."
 251   :group 'gnus-newsrc
 252   :type '(radio (sexp :format "Non-nil\n"
 253                       :match (lambda (widget value)
 254                                (and value (not (stringp value))))
 255                       :value t)
 256                 (const nil)
 257                 regexp))
 258
 259 (defcustom gnus-ignored-newsgroups
 260   (mapconcat 'identity
 261              '("^to\\."                 ; not "real" groups
 262                "^[0-9. \t]+\\( \\|$\\)" ; all digits in name
 263                "^[\"][\"#'()]"  ; bogus characters
 264                )
 265              "\\|")
 266   "*A regexp to match uninteresting newsgroups in the active file.
 267 Any lines in the active file matching this regular expression are
 268 removed from the newsgroup list before anything else is done to it,
 269 thus making them effectively non-existent."
 270   :group 'gnus-group-new
 271   :type 'regexp)
 272
 273 (defcustom gnus-subscribe-newsgroup-method 'gnus-subscribe-zombies
 274   "*Function(s) called with a group name when new group is detected.
 275 A few pre-made functions are supplied: `gnus-subscribe-randomly'
 276 inserts new groups at the beginning of the list of groups;
 277 `gnus-subscribe-alphabetically' inserts new groups in strict
 278 alphabetic order; `gnus-subscribe-hierarchically' inserts new groups
 279 in hierarchical newsgroup order; `gnus-subscribe-interactively' asks
 280 for your decision; `gnus-subscribe-killed' kills all new groups;
 281 `gnus-subscribe-zombies' will make all new groups into zombies;
 282 `gnus-subscribe-topics' will enter groups into the topics that
 283 claim them."
 284   :group 'gnus-group-new
 285   :type '(radio (function-item gnus-subscribe-randomly)
 286                 (function-item gnus-subscribe-alphabetically)
 287                 (function-item gnus-subscribe-hierarchically)
 288                 (function-item gnus-subscribe-interactively)
 289                 (function-item gnus-subscribe-killed)
 290                 (function-item gnus-subscribe-zombies)
 291                 (function-item gnus-subscribe-topics)
 292                 function
 293                 (repeat function)))
 294
 295 (define-obsolete-variable-al