gnus-sum.el 466 KB
Newer Older
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1
;;; gnus-sum.el --- summary mode commands for Gnus
2

3
;; Copyright (C) 1996-2011 Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
4

5
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
6 7 8 9
;; Keywords: news

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
14 15 16

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
18 19 20
;; GNU General Public License for more details.

;; 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/>.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
22 23 24 25 26

;;; Commentary:

;;; Code:

27
;; For Emacs <22.2 and XEmacs.
28 29
(eval-and-compile
  (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
30
(eval-when-compile
Dan Nicolaescu's avatar
Dan Nicolaescu committed
31
  (require 'cl))
32 33 34
(eval-when-compile
  (when (featurep 'xemacs)
    (require 'easy-mmode))) ; for `define-minor-mode'
Dan Nicolaescu's avatar
Dan Nicolaescu committed
35 36 37

(defvar tool-bar-mode)
(defvar gnus-tmp-header)
38

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
39 40 41 42 43 44
(require 'gnus)
(require 'gnus-group)
(require 'gnus-spec)
(require 'gnus-range)
(require 'gnus-int)
(require 'gnus-undo)
45
(require 'gnus-util)
46
(require 'gmm-utils)
47
(require 'mm-decode)
Dave Love's avatar
Dave Love committed
48
(require 'nnoo)
49

50
(autoload 'gnus-summary-limit-include-cached "gnus-cache" nil t)
51
(autoload 'gnus-cache-write-active "gnus-cache")
52 53
(autoload 'gnus-mailing-list-insinuate "gnus-ml" nil t)
(autoload 'turn-on-gnus-mailing-list-mode "gnus-ml" nil t)
54
(autoload 'gnus-pick-line-number "gnus-salt" nil t)
Dave Love's avatar
Dave Love committed
55
(autoload 'mm-uu-dissect "mm-uu")
56 57 58 59 60 61
(autoload 'gnus-article-outlook-deuglify-article "deuglify"
  "Deuglify broken Outlook (Express) articles and redisplay."
  t)
(autoload 'gnus-article-outlook-unwrap-lines "deuglify" nil t)
(autoload 'gnus-article-outlook-repair-attribution "deuglify" nil t)
(autoload 'gnus-article-outlook-rearrange-citation "deuglify" nil t)
62 63
(autoload 'nnir-article-rsv "nnir" nil nil 'macro)
(autoload 'nnir-article-group "nnir" nil nil 'macro)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
64 65 66 67 68 69 70 71

(defcustom gnus-kill-summary-on-exit t
  "*If non-nil, kill the summary buffer when you exit from it.
If nil, the summary will become a \"*Dead Summary*\" buffer, and
it will be killed sometime later."
  :group 'gnus-summary-exit
  :type 'boolean)

72 73 74 75 76
(defcustom gnus-summary-next-group-on-exit t
  "If non-nil, go to the next unread newsgroup on summary exit.
See `gnus-group-goto-unread'."
  :link '(custom-manual "(gnus)Group Maneuvering")
  :group 'gnus-summary-exit
77
  :version "23.1" ;; No Gnus
78 79
  :type 'boolean)

80 81 82 83
(defcustom gnus-summary-stop-at-end-of-message nil
  "If non-nil, don't select the next message when using `SPC'."
  :link '(custom-manual "(gnus)Group Maneuvering")
  :group 'gnus-summary-maneuvering
84
  :version "24.1"
85 86
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
87 88
(defcustom gnus-fetch-old-headers nil
  "*Non-nil means that Gnus will try to build threads by grabbing old headers.
89 90 91 92 93 94 95 96 97
If an unread article in the group refers to an older, already
read (or just marked as read) article, the old article will not
normally be displayed in the Summary buffer.  If this variable is
t, Gnus will attempt to grab the headers to the old articles, and
thereby build complete threads.  If it has the value `some', all
old headers will be fetched but only enough headers to connect
otherwise loose threads will be displayed.  This variable can
also be a number.  In that case, no more than that number of old
headers will be fetched.  If it has the value `invisible', all
98
old headers will be fetched, but none will be displayed.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
99

100 101 102
The server has to support NOV for any of this to work.

This feature can seriously impact performance it ignores all
Miles Bader's avatar
Miles Bader committed
103 104 105
locally cached header entries.  Setting it to t for groups for a
server that doesn't expire articles (such as news.gmane.org),
leads to very slow summary generation."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
106 107
  :group 'gnus-thread
  :type '(choice (const :tag "off" nil)
108
		 (const :tag "on" t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
109
		 (const some)
110
		 (const invisible)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
111 112 113
		 number
		 (sexp :menu-tag "other" t)))

114
(defcustom gnus-refer-thread-limit 500
115 116 117 118 119 120
  "*The number of old headers to fetch when doing \\<gnus-summary-mode-map>\\[gnus-summary-refer-thread].
If t, fetch all the available old headers."
  :group 'gnus-thread
  :type '(choice number
		 (sexp :menu-tag "other" t)))

121 122 123 124 125 126 127
(defcustom gnus-refer-thread-use-nnir nil
  "*Use nnir to search an entire server when referring threads. A
nil value will only search for thread-related articles in the
current group."
  :group 'gnus-thread
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
(defcustom gnus-summary-make-false-root 'adopt
  "*nil means that Gnus won't gather loose threads.
If the root of a thread has expired or been read in a previous
session, the information necessary to build a complete thread has been
lost.  Instead of having many small sub-threads from this original thread
scattered all over the summary buffer, Gnus can gather them.

If non-nil, Gnus will try to gather all loose sub-threads from an
original thread into one large thread.

If this variable is non-nil, it should be one of `none', `adopt',
`dummy' or `empty'.

If this variable is `none', Gnus will not make a false root, but just
present the sub-threads after another.
If this variable is `dummy', Gnus will create a dummy root that will
have all the sub-threads as children.
If this variable is `adopt', Gnus will make one of the \"children\"
the parent and mark all the step-children as such.
If this variable is `empty', the \"children\" are printed with empty
148
subject fields.  (Or rather, they will be printed with a string
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
149 150 151 152 153 154 155 156
given by the `gnus-summary-same-subject' variable.)"
  :group 'gnus-thread
  :type '(choice (const :tag "off" nil)
		 (const none)
		 (const dummy)
		 (const adopt)
		 (const empty)))

157 158
(defcustom gnus-summary-make-false-root-always nil
  "Always make a false dummy root."
159
  :version "22.1"
160 161 162
  :group 'gnus-thread
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
(defcustom gnus-summary-gather-exclude-subject "^ *$\\|^(none)$"
  "*A regexp to match subjects to be excluded from loose thread gathering.
As loose thread gathering is done on subjects only, that means that
there can be many false gatherings performed.  By rooting out certain
common subjects, gathering might become saner."
  :group 'gnus-thread
  :type 'regexp)

(defcustom gnus-summary-gather-subject-limit nil
  "*Maximum length of subject comparisons when gathering loose threads.
Use nil to compare full subjects.  Setting this variable to a low
number will help gather threads that have been corrupted by
newsreaders chopping off subject lines, but it might also mean that
unrelated articles that have subject that happen to begin with the
same few characters will be incorrectly gathered.

If this variable is `fuzzy', Gnus will use a fuzzy algorithm when
comparing subjects."
  :group 'gnus-thread
  :type '(choice (const :tag "off" nil)
		 (const fuzzy)
		 (sexp :menu-tag "on" t)))

186 187 188 189
(defcustom gnus-simplify-subject-functions nil
  "List of functions taking a string argument that simplify subjects.
The functions are applied recursively.

190 191 192
Useful functions to put in this list include:
`gnus-simplify-subject-re', `gnus-simplify-subject-fuzzy',
`gnus-simplify-whitespace', and `gnus-simplify-all-whitespace'."
193 194 195
  :group 'gnus-thread
  :type '(repeat function))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
196
(defcustom gnus-simplify-ignored-prefixes nil
197
  "*Remove matches for this regexp from subject lines when simplifying fuzzily."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
  :group 'gnus-thread
  :type '(choice (const :tag "off" nil)
		 regexp))

(defcustom gnus-build-sparse-threads nil
  "*If non-nil, fill in the gaps in threads.
If `some', only fill in the gaps that are needed to tie loose threads
together.  If `more', fill in all leaf nodes that Gnus can find.  If
non-nil and non-`some', fill in all gaps that Gnus manages to guess."
  :group 'gnus-thread
  :type '(choice (const :tag "off" nil)
		 (const some)
		 (const more)
		 (sexp :menu-tag "all" t)))

(defcustom gnus-summary-thread-gathering-function
  'gnus-gather-threads-by-subject
215
  "*Function used for gathering loose threads.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
216 217 218 219 220
There are two pre-defined functions: `gnus-gather-threads-by-subject',
which only takes Subjects into consideration; and
`gnus-gather-threads-by-references', which compared the References
headers of the articles to find matches."
  :group 'gnus-thread
221 222 223
  :type '(radio (function-item gnus-gather-threads-by-subject)
		(function-item gnus-gather-threads-by-references)
		(function :tag "other")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
224 225 226 227 228 229 230 231

(defcustom gnus-summary-same-subject ""
  "*String indicating that the current article has the same subject as the previous.
This variable will only be used if the value of
`gnus-summary-make-false-root' is `empty'."
  :group 'gnus-summary-format
  :type 'string)

232
(defcustom gnus-summary-goto-unread nil
233 234 235 236 237 238
  "*If t, many commands will go to the next unread article.
This applies to marking commands as well as other commands that
\"naturally\" select the next article, like, for instance, `SPC' at
the end of an article.

If nil, the marking commands do NOT go to the next unread article
239
\(they go to the next article instead).  If `never', commands that
240 241
usually go to the next unread article, will go to the next article,
whether it is read or not."
242
  :version "24.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256
  :group 'gnus-summary-marks
  :link '(custom-manual "(gnus)Setting Marks")
  :type '(choice (const :tag "off" nil)
		 (const never)
		 (sexp :menu-tag "on" t)))

(defcustom gnus-summary-default-score 0
  "*Default article score level.
All scores generated by the score files will be added to this score.
If this variable is nil, scoring will be disabled."
  :group 'gnus-score-default
  :type '(choice (const :tag "disable")
		 integer))

257 258 259 260
(defcustom gnus-summary-default-high-score 0
  "*Default threshold for a high scored article.
An article will be highlighted as high scored if its score is greater
than this score."
261
  :version "22.1"
262 263 264 265 266 267 268
  :group 'gnus-score-default
  :type 'integer)

(defcustom gnus-summary-default-low-score 0
  "*Default threshold for a low scored article.
An article will be highlighted as low scored if its score is smaller
than this score."
269
  :version "22.1"
270 271 272
  :group 'gnus-score-default
  :type 'integer)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
(defcustom gnus-summary-zcore-fuzz 0
  "*Fuzziness factor for the zcore in the summary buffer.
Articles with scores closer than this to `gnus-summary-default-score'
will not be marked."
  :group 'gnus-summary-format
  :type 'integer)

(defcustom gnus-simplify-subject-fuzzy-regexp nil
  "*Strings to be removed when doing fuzzy matches.
This can either be a regular expression or list of regular expressions
that will be removed from subject strings if fuzzy subject
simplification is selected."
  :group 'gnus-thread
  :type '(repeat regexp))

(defcustom gnus-show-threads t
  "*If non-nil, display threads in summary mode."
  :group 'gnus-thread
  :type 'boolean)

(defcustom gnus-thread-hide-subtree nil
  "*If non-nil, hide all threads initially.
295
This can be a predicate specifier which says which threads to hide.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
296
If threads are hidden, you have to run the command
297
`gnus-summary-show-thread' by hand or select an article."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
298
  :group 'gnus-thread
299 300 301 302 303
  :type '(radio (sexp :format "Non-nil\n"
		      :match (lambda (widget value)
			       (not (or (consp value) (functionp value))))
		      :value t)
		(const nil)
304
		(sexp :tag "Predicate specifier")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
305 306 307 308 309 310

(defcustom gnus-thread-hide-killed t
  "*If non-nil, hide killed threads automatically."
  :group 'gnus-thread
  :type 'boolean)

311 312 313 314
(defcustom gnus-thread-ignore-subject t
  "*If non-nil, which is the default, ignore subjects and do all threading based on the Reference header.
If nil, articles that have different subjects from their parents will
start separate threads."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
  :group 'gnus-thread
  :type 'boolean)

(defcustom gnus-thread-operation-ignore-subject t
  "*If non-nil, subjects will be ignored when doing thread commands.
This affects commands like `gnus-summary-kill-thread' and
`gnus-summary-lower-thread'.

If this variable is nil, articles in the same thread with different
subjects will not be included in the operation in question.  If this
variable is `fuzzy', only articles that have subjects that are fuzzily
equal will be included."
  :group 'gnus-thread
  :type '(choice (const :tag "off" nil)
		 (const fuzzy)
		 (sexp :tag "on" t)))

(defcustom gnus-thread-indent-level 4
  "*Number that says how much each sub-thread should be indented."
  :group 'gnus-thread
  :type 'integer)

(defcustom gnus-auto-extend-newsgroup t
  "*If non-nil, extend newsgroup forward and backward when requested."
  :group 'gnus-summary-choose
  :type 'boolean)

(defcustom gnus-auto-select-first t
Miles Bader's avatar
Miles Bader committed
343 344 345 346 347 348 349
  "If non-nil, select an article on group entry.
An article is selected automatically when entering a group
e.g. with \\<gnus-group-mode-map>\\[gnus-group-read-group], or via `gnus-summary-next-page' or
`gnus-summary-catchup-and-goto-next-group'.

Which article is selected is controlled by the variable
`gnus-auto-select-subject'.
350 351 352

If you want to prevent automatic selection of articles in some
newsgroups, set the variable to nil in `gnus-select-group-hook'."
Miles Bader's avatar
Miles Bader committed
353 354 355 356
  ;; Commands include...
  ;; \\<gnus-group-mode-map>\\[gnus-group-read-group]
  ;; \\<gnus-summary-mode-map>\\[gnus-summary-next-page]
  ;; \\<gnus-summary-mode-map>\\[gnus-summary-catchup-and-goto-next-group]
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
357 358
  :group 'gnus-group-select
  :type '(choice (const :tag "none" nil)
359 360
		 (sexp :menu-tag "first" t)))

361
(defcustom gnus-auto-select-subject 'unseen-or-unread
362 363 364 365 366 367
  "*Says what subject to place under point when entering a group.

This variable can either be the symbols `first' (place point on the
first subject), `unread' (place point on the subject line of the first
unread article), `best' (place point on the subject line of the
higest-scored article), `unseen' (place point on the subject line of
368
the first unseen article), `unseen-or-unread' (place point on the subject
369
line of the first unseen article or, if all articles have been seen, on the
370 371
subject line of the first unread article), or a function to be called to
place point on some subject line."
372
  :version "24.1"
373 374 375 376 377
  :group 'gnus-group-select
  :type '(choice (const best)
		 (const unread)
		 (const first)
		 (const unseen)
378 379
	         (const unseen-or-unread)
		 (function :tag "Function to call")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
380 381 382 383

(defcustom gnus-auto-select-next t
  "*If non-nil, offer to go to the next group from the end of the previous.
If the value is t and the next newsgroup is empty, Gnus will exit
384 385
summary mode and go back to group mode.  If the value is neither nil
nor t, Gnus will select the following unread newsgroup.  In
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
386 387 388 389
particular, if the value is the symbol `quietly', the next unread
newsgroup will be selected without any confirmation, and if it is
`almost-quietly', the next group will be selected without any
confirmation if you are located on the last article in the group.
390
Finally, if this variable is `slightly-quietly', the `\\<gnus-summary-mode-map>\\[gnus-summary-catchup-and-goto-next-group]' command
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
391 392 393 394 395 396 397 398 399
will go to the next group without confirmation."
  :group 'gnus-summary-maneuvering
  :type '(choice (const :tag "off" nil)
		 (const quietly)
		 (const almost-quietly)
		 (const slightly-quietly)
		 (sexp :menu-tag "on" t)))

(defcustom gnus-auto-select-same nil
400 401 402
  "*If non-nil, select the next article with the same subject.
If there are no more articles with the same subject, go to
the first unread article."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
403 404 405
  :group 'gnus-summary-maneuvering
  :type 'boolean)

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
(defcustom gnus-auto-select-on-ephemeral-exit 'next-noselect
  "What article should be selected after exiting an ephemeral group.
Valid values include:

`next'
  Select the next article.
`next-unread'
  Select the next unread article.
`next-noselect'
  Move the cursor to the next article.  This is the default.
`next-unread-noselect'
  Move the cursor to the next unread article.

If it has any other value or there is no next (unread) article, the
article selected before entering to the ephemeral group will appear."
421
  :version "23.1" ;; No Gnus
422 423 424 425 426 427
  :group 'gnus-summary-maneuvering
  :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
		 (const next) (const next-unread)
		 (const next-noselect) (const next-unread-noselect)
		 (sexp :tag "other" :value nil)))

428 429 430 431 432 433 434 435 436 437 438
(defcustom gnus-auto-goto-ignores 'unfetched
  "*Says how to handle unfetched articles when maneuvering.

This variable can either be the symbols nil (maneuver to any
article), `undownloaded' (maneuvering while unplugged ignores articles
that have not been fetched), `always-undownloaded' (maneuvering always
ignores articles that have not been fetched), `unfetched' (maneuvering
ignores articles whose headers have not been fetched).

NOTE: The list of unfetched articles will always be nil when plugged
and, when unplugged, a subset of the undownloaded article list."
439
  :version "22.1"
440 441 442 443 444 445
  :group 'gnus-summary-maneuvering
  :type '(choice (const :tag "None" nil)
                 (const :tag "Undownloaded when unplugged" undownloaded)
                 (const :tag "Undownloaded" always-undownloaded)
                 (const :tag "Unfetched" unfetched)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
446 447 448 449 450 451 452
(defcustom gnus-summary-check-current nil
  "*If non-nil, consider the current article when moving.
The \"unread\" movement commands will stay on the same line if the
current article is unread."
  :group 'gnus-summary-maneuvering
  :type 'boolean)

453
(defcustom gnus-auto-center-summary 2
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
454 455 456 457 458 459
  "*If non-nil, always center the current summary buffer.
In particular, if `vertical' do only vertical recentering.  If non-nil
and non-`vertical', do both horizontal and vertical recentering."
  :group 'gnus-summary-maneuvering
  :type '(choice (const :tag "none" nil)
		 (const vertical)
460
		 (integer :tag "height")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
461 462
		 (sexp :menu-tag "both" t)))

463 464 465 466
(defcustom gnus-auto-center-group t
  "If non-nil, always center the group buffer."
  :group 'gnus-summary-maneuvering
  :type 'boolean)
467

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
468 469 470 471 472 473 474 475 476 477
(defcustom gnus-show-all-headers nil
  "*If non-nil, don't hide any headers."
  :group 'gnus-article-hiding
  :group 'gnus-article-headers
  :type 'boolean)

(defcustom gnus-summary-ignore-duplicates nil
  "*If non-nil, ignore articles with identical Message-ID headers."
  :group 'gnus-summary
  :type 'boolean)
478

479
(defcustom gnus-single-article-buffer nil
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
480 481
  "*If non-nil, display all articles in the same buffer.
If nil, each group will get its own article buffer."
482
  :version "24.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
483 484 485
  :group 'gnus-article-various
  :type 'boolean)

486 487 488 489 490 491
(defcustom gnus-widen-article-window nil
  "If non-nil, selecting the article buffer will display only the article buffer."
  :version "24.1"
  :group 'gnus-article-various
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
492 493 494 495 496 497 498 499 500
(defcustom gnus-break-pages t
  "*If non-nil, do page breaking on articles.
The page delimiter is specified by the `gnus-page-delimiter'
variable."
  :group 'gnus-article-various
  :type 'boolean)

(defcustom gnus-move-split-methods nil
  "*Variable used to suggest where articles are to be moved to.
501 502 503
It uses the same syntax as the `gnus-split-methods' variable.
However, whereas `gnus-split-methods' specifies file names as targets,
this variable specifies group names."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
504
  :group 'gnus-summary-mail
505 506 507
  :type '(repeat (choice (list :value (fun) function)
			 (cons :value ("" "") regexp (repeat string))
			 (sexp :value nil))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
508

509 510 511 512 513 514 515
(defcustom gnus-move-group-prefix-function 'gnus-group-real-prefix
  "Function used to compute default prefix for article move/copy/etc prompts.
The function should take one argument, a group name, and return a
string with the suggested prefix."
  :group 'gnus-summary-mail
  :type 'function)

516 517 518
;; FIXME: Although the custom type is `character' for the following variables,
;; using multibyte characters (Latin-1, UTF-8) doesn't work.  -- rs

519
(defcustom gnus-unread-mark ?           ;Whitespace
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
  "*Mark used for unread articles."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-ticked-mark ?!
  "*Mark used for ticked articles."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-dormant-mark ??
  "*Mark used for dormant articles."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-del-mark ?r
  "*Mark used for del'd articles."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-read-mark ?R
  "*Mark used for read articles."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-expirable-mark ?E
  "*Mark used for expirable articles."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-killed-mark ?K
  "*Mark used for killed articles."
  :group 'gnus-summary-marks
  :type 'character)

554 555
(defcustom gnus-spam-mark ?$
  "*Mark used for spam articles."
556
  :version "22.1"
557 558 559
  :group 'gnus-summary-marks
  :type 'character)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
(defcustom gnus-kill-file-mark ?X
  "*Mark used for articles killed by kill files."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-low-score-mark ?Y
  "*Mark used for articles with a low score."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-catchup-mark ?C
  "*Mark used for articles that are caught up."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-replied-mark ?A
  "*Mark used for articles that have been replied to."
  :group 'gnus-summary-marks
  :type 'character)

580 581
(defcustom gnus-forwarded-mark ?F
  "*Mark used for articles that have been forwarded."
582
  :version "22.1"
583 584 585 586 587
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-recent-mark ?N
  "*Mark used for articles that are recent."
588
  :version "22.1"
589 590 591
  :group 'gnus-summary-marks
  :type 'character)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
592 593 594 595 596 597
(defcustom gnus-cached-mark ?*
  "*Mark used for articles that are in the cache."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-saved-mark ?S
598 599 600 601 602 603
  "*Mark used for articles that have been saved."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-unseen-mark ?.
  "*Mark used for articles that haven't been seen."
604
  :version "22.1"
605 606 607 608 609
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-no-mark ?               ;Whitespace
  "*Mark used for articles that have no other secondary mark."
610
  :version "22.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-ancient-mark ?O
  "*Mark used for ancient articles."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-sparse-mark ?Q
  "*Mark used for sparsely reffed articles."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-canceled-mark ?G
  "*Mark used for canceled articles."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-duplicate-mark ?M
  "*Mark used for duplicate articles."
  :group 'gnus-summary-marks
  :type 'character)

634
(defcustom gnus-undownloaded-mark ?-
635
  "*Mark used for articles that weren't downloaded."
636
  :version "22.1"
637 638 639
  :group 'gnus-summary-marks
  :type 'character)

640 641 642 643 644
(defcustom gnus-downloaded-mark ?+
  "*Mark used for articles that were downloaded."
  :group 'gnus-summary-marks
  :type 'character)

645 646 647 648 649 650 651 652 653 654
(defcustom gnus-downloadable-mark ?%
  "*Mark used for articles that are to be downloaded."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-unsendable-mark ?=
  "*Mark used for articles that won't be sent."
  :group 'gnus-summary-marks
  :type 'character)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
655 656 657 658 659 660 661 662 663 664
(defcustom gnus-score-over-mark ?+
  "*Score mark used for articles with high scores."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-score-below-mark ?-
  "*Score mark used for articles with low scores."
  :group 'gnus-summary-marks
  :type 'character)

665
(defcustom gnus-empty-thread-mark ?     ;Whitespace
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
666 667 668 669 670 671 672 673 674 675 676 677 678 679
  "*There is no thread under the article."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-not-empty-thread-mark ?=
  "*There is a thread under the article."
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-view-pseudo-asynchronously nil
  "*If non-nil, Gnus will view pseudo-articles asynchronously."
  :group 'gnus-extract-view
  :type 'boolean)

680 681 682
(defcustom gnus-auto-expirable-marks
  (list gnus-killed-mark gnus-del-mark gnus-catchup-mark
	gnus-low-score-mark gnus-ancient-mark gnus-read-mark
683
	gnus-duplicate-mark)
684
  "*The list of marks converted into expiration if a group is auto-expirable."
685
  :version "24.1"
686 687 688 689 690
  :group 'gnus-summary
  :type '(repeat character))

(defcustom gnus-inhibit-user-auto-expire t
  "*If non-nil, user marking commands will not mark an article as expirable, even if the group has auto-expire turned on."
Dave Love's avatar
Dave Love committed
691
  :version "21.1"
692 693 694
  :group 'gnus-summary
  :type 'boolean)

Miles Bader's avatar
Miles Bader committed
695 696 697 698 699 700 701 702 703 704 705
(defcustom gnus-mark-copied-or-moved-articles-as-expirable nil
  "If non-nil, mark articles copied or moved to auto-expire group as expirable.
If nil, the expirable marks will be unchanged except that the marks
will be removed when copying or moving articles to a group that has
not turned auto-expire on.  If non-nil, articles that have been read
will be marked as expirable when being copied or moved to a group in
which auto-expire is turned on."
  :version "23.2"
  :type 'boolean
  :group 'gnus-summary-marks)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
(defcustom gnus-view-pseudos nil
  "*If `automatic', pseudo-articles will be viewed automatically.
If `not-confirm', pseudos will be viewed automatically, and the user
will not be asked to confirm the command."
  :group 'gnus-extract-view
  :type '(choice (const :tag "off" nil)
		 (const automatic)
		 (const not-confirm)))

(defcustom gnus-view-pseudos-separately t
  "*If non-nil, one pseudo-article will be created for each file to be viewed.
If nil, all files that use the same viewing command will be given as a
list of parameters to that command."
  :group 'gnus-extract-view
  :type 'boolean)

(defcustom gnus-insert-pseudo-articles t
  "*If non-nil, insert pseudo-articles when decoding articles."
  :group 'gnus-extract-view
  :type 'boolean)

(defcustom gnus-summary-dummy-line-format
728
  "   %(:                             :%) %S\n"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
729 730 731 732
  "*The format specification for the dummy roots in the summary buffer.
It works along the same lines as a normal formatting string,
with some simple extensions.

733 734 735 736 737
%S  The subject

General format specifiers can also be used.
See `(gnus)Formatting Variables'."
  :link '(custom-manual "(gnus)Formatting Variables")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
738 739 740
  :group 'gnus-threading
  :type 'string)

741
(defcustom gnus-summary-mode-line-format "Gnus: %g [%A] %Z"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
742 743 744 745 746 747 748
  "*The format specification for the summary mode line.
It works along the same lines as a normal formatting string,
with some simple extensions:

%G  Group name
%p  Unprefixed group name
%A  Current article number
749
%z  Current article score
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
750 751 752 753 754 755 756 757 758 759 760 761 762 763
%V  Gnus version
%U  Number of unread articles in the group
%e  Number of unselected articles in the group
%Z  A string with unread/unselected article counts
%g  Shortish group name
%S  Subject of the current article
%u  User-defined spec
%s  Current score file name
%d  Number of dormant articles
%r  Number of articles that have been marked as read in this session
%E  Number of articles expunged by the score files"
  :group 'gnus-summary-format
  :type 'string)

764 765 766
(defcustom gnus-list-identifiers nil
  "Regexp that matches list identifiers to be removed from subject.
This can also be a list of regexps."
Dave Love's avatar
Dave Love committed
767
  :version "21.1"
768 769 770 771 772 773
  :group 'gnus-summary-format
  :group 'gnus-article-hiding
  :type '(choice (const :tag "none" nil)
		 (regexp :value ".*")
		 (repeat :value (".*") regexp)))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
774 775 776 777 778 779 780
(defcustom gnus-summary-mark-below 0
  "*Mark all articles with a score below this variable as read.
This variable is local to each summary buffer and usually set by the
score file."
  :group 'gnus-score-default
  :type 'integer)

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
(defun gnus-widget-reversible-match (widget value)
  "Ignoring WIDGET, convert VALUE to internal form.
VALUE should have the form `FOO' or `(not FOO)', where FOO is an symbol."
  ;; (debug value)
  (or (symbolp value)
      (and (listp value)
           (eq (length value) 2)
           (eq (nth 0 value) 'not)
           (symbolp (nth 1 value)))))

(defun gnus-widget-reversible-to-internal (widget value)
  "Ignoring WIDGET, convert VALUE to internal form.
VALUE should have the form `FOO' or `(not FOO)', where FOO is an atom.
FOO is converted to (FOO nil) and (not FOO) is converted to (FOO t)."
  ;; (debug value)
  (if (atom value)
      (list value nil)
    (list (nth 1 value) t)))

(defun gnus-widget-reversible-to-external (widget value)
  "Ignoring WIDGET, convert VALUE to external form.
VALUE should have the form `(FOO nil)' or `(FOO t)', where FOO is an atom.
\(FOO  nil) is converted to FOO and (FOO t) is converted to (not FOO)."
  ;; (debug value)
  (if (nth 1 value)
      (list 'not (nth 0 value))
    (nth 0 value)))

(define-widget 'gnus-widget-reversible 'group
  "A `group' that convert values."
  :match 'gnus-widget-reversible-match
  :value-to-internal 'gnus-widget-reversible-to-internal
  :value-to-external 'gnus-widget-reversible-to-external)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
815 816
(defcustom gnus-article-sort-functions '(gnus-article-sort-by-number)
  "*List of functions used for sorting articles in the summary buffer.
817 818 819 820 821 822 823 824 825 826

Each function takes two articles and returns non-nil if the first
article should be sorted before the other.  If you use more than one
function, the primary sort function should be the last.  You should
probably always include `gnus-article-sort-by-number' in the list of
sorting functions -- preferably first.  Also note that sorting by date
is often much slower than sorting by number, and the sorting order is
very similar.  (Sorting by date means sorting by the time the message
was sent, sorting by number means sorting by arrival time.)

827 828 829
Each item can also be a list `(not F)' where F is a function;
this reverses the sort order.

830 831 832 833 834 835 836
Ready-made functions include `gnus-article-sort-by-number',
`gnus-article-sort-by-author', `gnus-article-sort-by-subject',
`gnus-article-sort-by-date', `gnus-article-sort-by-random'
and `gnus-article-sort-by-score'.

When threading is turned on, the variable `gnus-thread-sort-functions'
controls how articles are sorted."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
837
  :group 'gnus-summary-sort
838 839 840 841 842 843 844 845 846 847
  :type '(repeat (gnus-widget-reversible
                  (choice (function-item gnus-article-sort-by-number)
                          (function-item gnus-article-sort-by-author)
                          (function-item gnus-article-sort-by-subject)
                          (function-item gnus-article-sort-by-date)
                          (function-item gnus-article-sort-by-score)
                          (function-item gnus-article-sort-by-random)
                          (function :tag "other"))
                  (boolean :tag "Reverse order"))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
848 849 850 851 852

(defcustom gnus-thread-sort-functions '(gnus-thread-sort-by-number)
  "*List of functions used for sorting threads in the summary buffer.
By default, threads are sorted by article number.

853 854 855 856 857 858 859 860
Each function takes two threads and returns non-nil if the first
thread should be sorted before the other.  If you use more than one
function, the primary sort function should be the last.  You should
probably always include `gnus-thread-sort-by-number' in the list of
sorting functions -- preferably first.  Also note that sorting by date
is often much slower than sorting by number, and the sorting order is
very similar.  (Sorting by date means sorting by the time the message
was sent, sorting by number means sorting by arrival time.)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
861

862 863 864
Each list item can also be a list `(not F)' where F is a
function; this specifies reversed sort order.

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
865
Ready-made functions include `gnus-thread-sort-by-number',
866 867 868 869 870 871
`gnus-thread-sort-by-author', `gnus-thread-sort-by-recipient'
`gnus-thread-sort-by-subject', `gnus-thread-sort-by-date',
`gnus-thread-sort-by-score', `gnus-thread-sort-by-most-recent-number',
`gnus-thread-sort-by-most-recent-date', `gnus-thread-sort-by-random',
and `gnus-thread-sort-by-total-score' (see
`gnus-thread-score-function').
872 873 874

When threading is turned off, the variable
`gnus-article-sort-functions' controls how articles are sorted."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
875
  :group 'gnus-summary-sort
876 877 878 879 880 881 882 883 884 885 886 887 888 889
  :type '(repeat
          (gnus-widget-reversible
           (choice (function-item gnus-thread-sort-by-number)
                   (function-item gnus-thread-sort-by-author)
                   (function-item gnus-thread-sort-by-recipient)
                   (function-item gnus-thread-sort-by-subject)
                   (function-item gnus-thread-sort-by-date)
                   (function-item gnus-thread-sort-by-score)
                   (function-item gnus-thread-sort-by-most-recent-number)
                   (function-item gnus-thread-sort-by-most-recent-date)
                   (function-item gnus-thread-sort-by-random)
                   (function-item gnus-thread-sort-by-total-score)
                   (function :tag "other"))
           (boolean :tag "Reverse order"))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
890 891 892 893 894 895 896 897 898 899 900 901

(defcustom gnus-thread-score-function '+
  "*Function used for calculating the total score of a thread.

The function is called with the scores of the article and each
subthread and should then return the score of the thread.

Some functions you can use are `+', `max', or `min'."
  :group 'gnus-summary-sort
  :type 'function)

(defcustom gnus-summary-expunge-below nil
902 903
  "All articles that have a score less than this variable will be expunged.
This variable is local to the summary buffers."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
904 905 906 907 908 909 910
  :group 'gnus-score-default
  :type '(choice (const :tag "off" nil)
		 integer))

(defcustom gnus-thread-expunge-below nil
  "All threads that have a total score less than this variable will be expunged.
See `gnus-thread-score-function' for en explanation of what a
911 912 913
\"thread score\" is.

This variable is local to the summary buffers."
914
  :group 'gnus-threading
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
915 916 917 918 919 920 921
  :group 'gnus-score-default
  :type '(choice (const :tag "off" nil)
		 integer))

(defcustom gnus-summary-mode-hook nil
  "*A hook for Gnus summary mode.
This hook is run before any variables are set in the summary buffer."
922
  :options '(turn-on-gnus-mailing-list-mode gnus-pick-mode)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
923 924 925
  :group 'gnus-summary-various
  :type 'hook)

926 927 928 929 930 931 932
;; Extracted from gnus-xmas-redefine in order to preserve user settings
(when (featurep 'xemacs)
  (add-hook 'gnus-summary-mode-hook 'gnus-xmas-summary-menu-add)
  (add-hook 'gnus-summary-mode-hook 'gnus-xmas-setup-summary-toolbar)
  (add-hook 'gnus-summary-mode-hook
	    'gnus-xmas-switch-horizontal-scrollbar-off))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
(defcustom gnus-summary-menu-hook nil
  "*Hook run after the creation of the summary mode menu."
  :group 'gnus-summary-visual
  :type 'hook)

(defcustom gnus-summary-exit-hook nil
  "*A hook called on exit from the summary buffer.
It will be called with point in the group buffer."
  :group 'gnus-summary-exit
  :type 'hook)

(defcustom gnus-summary-prepare-hook nil
  "*A hook called after the summary buffer has been generated.
If you want to modify the summary buffer, you can use this hook."
  :group 'gnus-summary-various
  :type 'hook)

950 951 952 953 954
(defcustom gnus-summary-prepared-hook nil
  "*A hook called as the last thing after the summary buffer has been generated."
  :group 'gnus-summary-various
  :type 'hook)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
955 956 957 958 959 960 961 962 963 964 965 966 967 968
(defcustom gnus-summary-generate-hook nil
  "*A hook run just before generating the summary buffer.
This hook is commonly used to customize threading variables and the
like."
  :group 'gnus-summary-various
  :type 'hook)

(defcustom gnus-select-group-hook nil
  "*A hook called when a newsgroup is selected.

If you'd like to simplify subjects like the
`gnus-summary-next-same-subject' command does, you can use the
following hook:

969 970 971 972 973 974 975 976
 (add-hook gnus-select-group-hook
	   (lambda ()
	     (mapcar (lambda (header)
		       (mail-header-set-subject
			header
			(gnus-simplify-subject
			 (mail-header-subject header) 're-only)))
		     gnus-newsgroup-headers)))"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
977 978 979 980 981 982
  :group 'gnus-group-select
  :type 'hook)

(defcustom gnus-select-article-hook nil
  "*A hook called when an article is selected."
  :group 'gnus-summary-choose
983
  :options '(gnus-agent-fetch-selected-article)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
984 985 986 987 988 989 990 991 992 993
  :type 'hook)

(defcustom gnus-visual-mark-article-hook
  (list 'gnus-highlight-selected-summary)
  "*Hook run after selecting an article in the summary buffer.
It is meant to be used for highlighting the article in some way.  It
is not run if `gnus-visual' is nil."
  :group 'gnus-summary-visual
  :type 'hook)

994
(defcustom gnus-parse-headers-hook nil
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
995 996 997 998 999
  "*A hook called before parsing the headers."
  :group 'gnus-various
  :type 'hook)

(defcustom gnus-exit-group-hook nil
1000 1001
  "*A hook called when exiting summary mode.
This hook is not called from the non-updating exit commands like `Q'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1002 1003 1004
  :group 'gnus-various
  :type 'hook)

1005
(defcustom gnus-summary-update-hook nil
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
  "*A hook called when a summary line is changed.
The hook will not be called if `gnus-visual' is nil.

The default function `gnus-summary-highlight-line' will
highlight the line according to the `gnus-summary-highlight'
variable."
  :group 'gnus-summary-visual
  :type 'hook)

(defcustom gnus-mark-article-hook '(gnus-summary-mark-read-and-unread-as-read)
  "*A hook called when an article is selected for the first time.
The hook is intended to mark an article as read (or unread)
automatically when it is selected."
  :group 'gnus-summary-choose
  :type 'hook)

(defcustom gnus-group-no-more-groups-hook nil
  "*A hook run when returning to group mode having no more (unread) groups."
  :group 'gnus-group-select
  :type 'hook)

(defcustom gnus-ps-print-hook nil
  "*A hook run before ps-printing something from Gnus."
  :group 'gnus-summary
  :type 'hook)

1032 1033
(defcustom gnus-summary-article-move-hook nil
  "*A hook called after an article is moved, copied, respooled, or crossposted."
1034
  :version "22.1"
1035 1036 1037 1038 1039
  :group 'gnus-summary
  :type 'hook)

(defcustom gnus-summary-article-delete-hook nil
  "*A hook called after an article is deleted."
1040
  :version "22.1"
1041 1042 1043 1044 1045
  :group 'gnus-summary
  :type 'hook)

(defcustom gnus-summary-article-expire-hook nil
  "*A hook called after an article is expired."
1046
  :version "22.1"
1047 1048 1049 1050 1051 1052 1053
  :group 'gnus-summary
  :type 'hook)

(defcustom gnus-summary-display-arrow
  (and (fboundp 'display-graphic-p)
       (display-graphic-p))
  "*If non-nil, display an arrow highlighting the current article."
1054
  :version "22.1"
1055 1056 1057
  :group 'gnus-summary
  :type 'boolean)

1058
(defcustom gnus-summary-selected-face 'gnus-summary-selected
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1059 1060 1061 1062
  "Face used for highlighting the current article in the summary buffer."
  :group 'gnus-summary-visual
  :type 'face)

1063 1064
(defvar gnus-tmp-downloaded nil)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1065
(defcustom gnus-summary-highlight
1066
  '(((eq mark gnus-canceled-mark)
1067
     . gnus-summary-cancelled)
1068
    ((and uncached (> score default-high))
1069
     . gnus-summary-high-undownloaded)
1070
    ((and uncached (< score default-low))
1071
     . gnus-summary-low-undownloaded)
1072
    (uncached
1073
     . gnus-summary-normal-undownloaded)
1074 1075 1076
    ((and (> score default-high)
	  (or (eq mark gnus-dormant-mark)
	      (eq mark gnus-ticked-mark)))
1077
     . gnus-summary-high-ticked)
1078 1079 1080
    ((and (< score default-low)
	  (or (eq mark gnus-dormant-mark)
	      (eq mark gnus-ticked-mark)))
1081
     . gnus-summary-low-ticked)
1082 1083
    ((or (eq mark gnus-dormant-mark)
	 (eq mark gnus-ticked-mark))
1084
     . gnus-summary-normal-ticked)
1085
    ((and (> score default-high) (eq mark gnus-ancient-mark))
1086
     . gnus-summary-high-ancient)
1087
    ((and (< score default-low) (eq mark gnus-ancient-mark))
1088
     . gnus-summary-low-ancient)
1089
    ((eq mark gnus-ancient-mark)
1090
     . gnus-summary-normal-ancient)
1091
    ((and (> score default-high) (eq mark gnus-unread-mark))
1092
     . gnus-summary-high-unread)
1093
    ((and (< score default-low) (eq mark gnus-unread-mark))
1094
     . gnus-summary-low-unread)
1095
    ((eq mark gnus-unread-mark)
1096
     . gnus-summary-normal-unread)
1097
    ((> score default-high)
1098
     . gnus-summary-high-read)
1099
    ((< score default-low)
1100
     . gnus-summary-low-read)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1101
    (t
1102
     . gnus-summary-normal-read))
1103
  "*Controls the highlighting of summary buffer lines.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1104

1105
A list of (FORM . FACE) pairs.  When deciding how a particular
1106 1107 1108
summary line should be displayed, each form is evaluated.  The content
of the face field after the first true form is used.  You can change
how those summary lines are displayed, by editing the face field.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1109 1110 1111

You can use the following variables in the FORM field.

1112
score:        The article's score.
1113 1114 1115 1116 1117 1118
default:      The default article score.
default-high: The default score for high scored articles.
default-low:  The default score for low scored articles.
below:        The score below which articles are automatically marked as read.
mark:         The article's mark.
uncached:     Non-nil if the article is uncached."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1119 1120 1121
  :group 'gnus-summary-visual
  :type '(repeat (cons (sexp :tag "Form" nil)
		       face)))
Miles Bader's avatar
Miles Bader committed
1122
(put 'gnus-summary-highlight 'risky-local-variable t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1123

1124 1125 1126
(defcustom gnus-alter-header-function nil
  "Function called to allow alteration of article header structures.
The function is called with one parameter, the article header vector,
1127 1128 1129 1130
which it may alter in any way."
  :type '(choice (const :tag "None" nil)
		 function)
  :group 'gnus-summary)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1131

1132
(defvar gnus-decode-encoded-word-function 'mail-decode-encoded-word-string
Miles Bader's avatar
Miles Bader committed
1133 1134 1135 1136 1137
  "Function used to decode a string with encoded words.")

(defvar gnus-decode-encoded-address-function
  'mail-decode-encoded-address-string
  "Function used to decode addresses with encoded words.")
1138

1139
(defcustom gnus-extra-headers '(To Cc Keywords Gcc Newsgroups)
1140
  "*Extra headers to parse."
1141
  :version "24.1"                       ; added Cc Keywords Gcc
1142 1143 1144 1145
  :group 'gnus-summary
  :type '(repeat symbol))

(defcustom gnus-ignored-from-addresses
Miles Bader's avatar
Miles Bader committed
1146
  (and user-mail-address
1147 1148
       (not (string= user-mail-address ""))
       (regexp-quote user-mail-address))
1149 1150
  "*From headers that may be suppressed in favor of To headers.
This can be a regexp or a list of regexps."
Dave Love's avatar
Dave Love committed
1151
  :version "21.1"
1152
  :group 'gnus-summary
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
  :type '(choice regexp
		 (repeat :tag "Regexp List" regexp)))

(defsubst gnus-ignored-from-addresses ()
  (gmm-regexp-concat gnus-ignored-from-addresses))

(defcustom gnus-summary-to-prefix "-> "
  "*String prefixed to the To field in the summary line when
using `gnus-ignored-from-addresses'."
  :version "22.1"
  :group 'gnus-summary
  :type 'string)

(defcustom gnus-summary-newsgroup-prefix "=> "
  "*String prefixed to the Newsgroup field in the summary
line when using `gnus-ignored-from-addresses'."
  :version "22.1"
  :group 'gnus-summary
  :type 'string)
1172 1173 1174 1175 1176

(defcustom gnus-newsgroup-ignored-charsets '(unknown-8bit x-unknown)
  "List of charsets that should be ignored.
When these charsets are used in the \"charset\" parameter, the
default charset will be used instead."
Dave Love's avatar
Dave Love committed
1177
  :version "21.1"
1178 1179 1180
  :type '(repeat symbol)
  :group 'gnus-charset)

Miles Bader's avatar
Miles Bader committed
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
(defcustom gnus-newsgroup-maximum-articles nil
  "The maximum number of articles a newsgroup.
If this is a number, old articles in a newsgroup exceeding this number
are silently ignored.  If it is nil, no article is ignored.  Note that
setting this variable to a number might prevent you from reading very
old articles."
  :group 'gnus-group-select
  :version "22.2"
  :type '(choice (const :tag "No limit" nil)
		 integer))

1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
(gnus-define-group-parameter
 ignored-charsets
 :type list
 :function-document
 "Return the ignored charsets of GROUP."
 :variable gnus-group-ignored-charsets-alist
 :variable-default
 '(("alt\\.chinese\\.text" iso-8859-1))
 :variable-document
 "Alist of regexps (to match group names) and charsets that should be ignored.
1202 1203
When these charsets are used in the \"charset\" parameter, the
default charset will be used instead."
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
 :variable-group gnus-charset
 :variable-type '(repeat (cons (regexp :tag "Group")
			       (repeat symbol)))
 :parameter-type '(choice :tag "Ignored charsets"
			  :value nil
			  (repeat (symbol)))
 :parameter-document       "\
List of charsets that should be ignored.

When these charsets are used in the \"charset\" parameter, the
default charset will be used instead.")
1215 1216 1217 1218

(defcustom gnus-group-highlight-words-alist nil
  "Alist of group regexps and highlight regexps.
This variable uses the same syntax as `gnus-emphasis-alist'."
Dave Love's avatar
Dave Love committed
1219
  :version "21.1"
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
  :type '(repeat (cons (regexp :tag "Group")
		       (repeat (list (regexp :tag "Highlight regexp")
				     (number :tag "Group for entire word" 0)
				     (number :tag "Group for displayed part" 0)
				     (symbol :tag "Face"
					     gnus-emphasis-highlight-words)))))
  :group 'gnus-summary-visual)

(defcustom gnus-summary-show-article-charset-alist
  nil
  "Alist of number and charset.
The article will be shown with the charset corresponding to the
numbered argument.
For example: ((1 . cn-gb-2312) (2 . big5))."
Dave Love's avatar
Dave Love committed
1234
  :version "21.1"
1235 1236 1237 1238 1239 1240
  :type '(repeat (cons (number :tag "Argument" 1)
		       (symbol :tag "Charset")))
  :group 'gnus-charset)

(defcustom gnus-preserve-marks t
  "Whether marks are preserved when moving, copying and respooling messages."
Dave Love's avatar
Dave Love committed
1241
  :version "21.1"
1242 1243 1244
  :type 'boolean
  :group 'gnus-summary-marks)

1245
(defcustom gnus-propagate-marks nil
1246 1247 1248
  "If non-nil, Gnus will store and retrieve marks from the backends.
This means that marks will be stored both in .newsrc.eld and in
the backend, and will slow operation down somewhat."
Miles Bader's avatar
Miles Bader committed
1249 1250 1251
  :type 'boolean
  :group 'gnus-summary-marks)

1252 1253
(defcustom gnus-alter-articles-to-read-function nil
  "Function to be called to alter the list of articles to be selected."
1254
  :type '(choice (const nil) function)
1255 1256 1257 1258 1259 1260 1261 1262
  :group 'gnus-summary)

(defcustom gnus-orphan-score nil
  "*All orphans get this score added.  Set in the score file."
  :group 'gnus-score-default
  :type '(choice (const nil)
		 integer))

Dave Love's avatar
Dave Love committed
1263
(defcustom gnus-summary-save-parts-default-mime "image/.*"
1264 1265 1266 1267
  "*A regexp to match MIME parts when saving multiple parts of a
message with `gnus-summary-save-parts' (\\<gnus-summary-mode-map>\\[gnus-summary-save-parts]).
This regexp will be used by default when prompting the user for which
type of files to save."
Dave Love's avatar
Dave Love committed
1268 1269 1270
  :group 'gnus-summary
  :type 'regexp)

1271 1272 1273 1274
(defcustom gnus-read-all-available-headers nil
  "Whether Gnus should parse all headers made available to it.
This is mostly relevant for slow back ends where the user may
wish to widen the summary buffer to include all headers
1275
that were fetched."
1276
  :version "22.1"
1277 1278 1279
  :group 'gnus-summary
  :type '(choice boolean regexp))

Miles Bader's avatar
Miles Bader committed
1280 1281 1282 1283 1284 1285 1286 1287 1288
(defcustom gnus-summary-pipe-output-default-command nil
  "Command (and optional arguments) used to pipe article to subprocess.
This will be used as the default command if it is non-nil.  The value
will be updated if you modify it when executing the command
`gnus-summary-pipe-output' or the function `gnus-summary-save-in-pipe'."
  :version "23.1" ;; No Gnus
  :group 'gnus-summary
  :type '(radio (const :tag "None" nil) (string :tag "Command")))

1289
(defcustom gnus-summary-muttprint-program "muttprint"
Miles Bader's avatar
Miles Bader committed
1290 1291 1292
  "Command (and optional arguments) used to run Muttprint.
The value will be updated if you modify it when executing the command
`gnus-summary-muttprint'."
1293
  :version "22.1"
1294 1295 1296
  :group 'gnus-summary
  :type 'string)

1297
(defcustom gnus-article-loose-mime t
1298 1299
  "If non-nil, don't require MIME-Version header.
Some brain-damaged MUA/MTA, e.g. Lotus Domino 5.0.6 clients, does not
1300
supply the MIME-Version header or deliberately strip it from the mail.
1301 1302
If non-nil (the default), Gnus will treat some articles as MIME
even if the MIME-Version header is missing."
1303
  :version "22.1"
1304 1305 1306 1307 1308 1309 1310 1311
  :type 'boolean
  :group 'gnus-article-mime)

(defcustom gnus-article-emulate-mime t
  "If non-nil, use MIME emulation for uuencode and the like.
This means that Gnus will search message bodies for text that look
like uuencoded bits, yEncoded bits, and so on, and present that using
the normal Gnus MIME machinery."
1312
  :version "22.1"
1313 1314
  :type 'boolean
  :group 'gnus-article-mime)
Dave Love's avatar
Dave Love committed
1315