gnus-sum.el 467 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-2012 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
(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."
125
  :version "24.1"
126 127 128
  :group 'gnus-thread
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
(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
149
subject fields.  (Or rather, they will be printed with a string
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
150 151 152 153 154 155 156 157
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)))

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

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
(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)))

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

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

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
197
(defcustom gnus-simplify-ignored-prefixes nil
198
  "*Remove matches for this regexp from subject lines when simplifying fuzzily."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
  :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
216
  "*Function used for gathering loose threads.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
217 218 219 220 221
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
222 223 224
  :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
225 226 227 228 229 230 231 232

(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)

233
(defcustom gnus-summary-goto-unread nil
234 235 236 237 238 239
  "*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
240
\(they go to the next article instead).  If `never', commands that
241 242
usually go to the next unread article, will go to the next article,
whether it is read or not."
243
  :version "24.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257
  :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))

258 259 260 261
(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."
262
  :version "22.1"
263 264 265 266 267 268 269
  :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."
270
  :version "22.1"
271 272 273
  :group 'gnus-score-default
  :type 'integer)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
(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.
296
This can be a predicate specifier which says which threads to hide.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
297
If threads are hidden, you have to run the command
298
`gnus-summary-show-thread' by hand or select an article."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
299
  :group 'gnus-thread
300 301 302 303 304
  :type '(radio (sexp :format "Non-nil\n"
		      :match (lambda (widget value)
			       (not (or (consp value) (functionp value))))
		      :value t)
		(const nil)
305
		(sexp :tag "Predicate specifier")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
306 307 308 309 310 311

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

312 313 314 315
(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
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 343
  :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
344 345 346 347 348 349 350
  "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'.
351 352 353

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
354 355 356 357
  ;; 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
358 359
  :group 'gnus-group-select
  :type '(choice (const :tag "none" nil)
360 361
		 (sexp :menu-tag "first" t)))

362
(defcustom gnus-auto-select-subject 'unseen-or-unread
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
Paul Eggert's avatar
Paul Eggert committed
368
highest-scored article), `unseen' (place point on the subject line of
369
the first unseen article), `unseen-or-unread' (place point on the subject
370
line of the first unseen article or, if all articles have been seen, on the
371 372
subject line of the first unread article), or a function to be called to
place point on some subject line."
373
  :version "24.1"
374 375 376 377 378
  :group 'gnus-group-select
  :type '(choice (const best)
		 (const unread)
		 (const first)
		 (const unseen)
379 380
	         (const unseen-or-unread)
		 (function :tag "Function to call")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
381 382 383 384

(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
385 386
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
387 388 389 390
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.
391
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
392 393 394 395 396 397 398 399 400
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
401 402 403
  "*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
404 405 406
  :group 'gnus-summary-maneuvering
  :type 'boolean)

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
(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."
422
  :version "23.1" ;; No Gnus
423 424 425 426 427 428
  :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)))

429 430 431 432 433 434 435 436 437 438 439
(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."
440
  :version "22.1"
441 442 443 444 445 446
  :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
447 448 449 450 451 452 453
(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)

454 455
(defcustom gnus-auto-center-summary 
  (max (or (bound-and-true-p scroll-margin) 0) 2)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
456 457 458 459 460 461
  "*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)
462
		 (integer :tag "height")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
463 464
		 (sexp :menu-tag "both" t)))

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

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
470 471 472 473 474 475 476 477 478 479
(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)
480

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

488 489 490 491 492 493
(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
494 495 496 497 498 499 500 501 502
(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.
503 504 505
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
506
  :group 'gnus-summary-mail
507 508 509
  :type '(repeat (choice (list :value (fun) function)
			 (cons :value ("" "") regexp (repeat string))
			 (sexp :value nil))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
510

511 512 513 514 515 516 517
(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)

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

521
(defcustom gnus-unread-mark ?           ;Whitespace
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
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 554 555
  "*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)

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

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
(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)

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

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

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

(defcustom gnus-saved-mark ?S
600 601 602 603 604 605
  "*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."
606
  :version "22.1"
607 608 609 610 611
  :group 'gnus-summary-marks
  :type 'character)

(defcustom gnus-no-mark ?               ;Whitespace
  "*Mark used for articles that have no other secondary mark."
612
  :version "22.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
  :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)

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

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

647 648 649 650 651 652 653 654 655 656
(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
657 658 659 660 661 662 663 664 665 666
(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)

667
(defcustom gnus-empty-thread-mark ?     ;Whitespace
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
668 669 670 671 672 673 674 675 676 677 678 679 680 681
  "*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)

682 683 684
(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
685
	gnus-duplicate-mark)
686
  "*The list of marks converted into expiration if a group is auto-expirable."
687
  :version "24.1"
688 689 690 691 692
  :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
693
  :version "21.1"
694 695 696
  :group 'gnus-summary
  :type 'boolean)

Miles Bader's avatar
Miles Bader committed
697 698 699 700 701 702 703 704 705 706 707
(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
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
(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
730
  "   %(:                             :%) %S\n"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
731 732 733 734
  "*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.

735 736 737 738 739
%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
740 741 742
  :group 'gnus-threading
  :type 'string)

743
(defcustom gnus-summary-mode-line-format "Gnus: %g [%A] %Z"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
744 745 746 747 748 749 750
  "*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
751
%z  Current article score
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765
%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)

766 767 768
(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
769
  :version "21.1"
770 771 772 773 774 775
  :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
776 777 778 779 780 781 782
(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)

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 815 816
(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
817 818
(defcustom gnus-article-sort-functions '(gnus-article-sort-by-number)
  "*List of functions used for sorting articles in the summary buffer.
819 820 821 822 823 824 825 826 827 828

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.)

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

832 833 834 835 836 837 838
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
839
  :group 'gnus-summary-sort
840 841 842 843 844 845 846 847 848 849
  :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
850 851 852 853 854

(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.

855 856 857 858 859 860 861 862
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
863

864 865 866
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
867
Ready-made functions include `gnus-thread-sort-by-number',
868 869 870 871 872 873
`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').
874 875 876

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
877
  :group 'gnus-summary-sort
878 879 880 881 882 883 884 885 886 887 888 889 890 891
  :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
892 893 894 895 896 897 898 899 900 901 902 903

(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
904 905
  "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
906 907 908 909 910 911 912
  :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
913 914 915
\"thread score\" is.

This variable is local to the summary buffers."
916
  :group 'gnus-threading
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
917 918 919 920 921 922 923
  :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."
924
  :options '(turn-on-gnus-mailing-list-mode gnus-pick-mode)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
925 926 927
  :group 'gnus-summary-various
  :type 'hook)

928 929 930 931 932 933 934
;; 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
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
(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)

952 953 954 955 956
(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
957 958 959 960 961 962 963 964 965 966 967 968 969 970
(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:

971 972 973 974 975 976 977 978
 (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
979 980 981 982 983 984
  :group 'gnus-group-select
  :type 'hook)

(defcustom gnus-select-article-hook nil
  "*A hook called when an article is selected."
  :group 'gnus-summary-choose
985
  :options '(gnus-agent-fetch-selected-article)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
986 987 988 989 990 991 992 993 994 995
  :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)

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

(defcustom gnus-exit-group-hook nil
1002 1003
  "*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
1004 1005 1006
  :group 'gnus-various
  :type 'hook)

1007
(defcustom gnus-summary-update-hook nil
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
  "*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)

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

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

(defcustom gnus-summary-article-expire-hook nil
  "*A hook called after an article is expired."
1048
  :version "22.1"
1049 1050 1051 1052 1053 1054 1055
  :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."
1056
  :version "22.1"
1057 1058 1059
  :group 'gnus-summary
  :type 'boolean)

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

1065 1066
(defvar gnus-tmp-downloaded nil)

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

1107
A list of (FORM . FACE) pairs.  When deciding how a particular
1108 1109 1110
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
1111 1112 1113

You can use the following variables in the FORM field.

1114
score:        The article's score.
1115 1116 1117 1118 1119 1120
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
1121 1122 1123
  :group 'gnus-summary-visual
  :type '(repeat (cons (sexp :tag "Form" nil)
		       face)))
Miles Bader's avatar
Miles Bader committed
1124
(put 'gnus-summary-highlight 'risky-local-variable t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1125

1126 1127 1128
(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,
1129 1130 1131 1132
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
1133

1134
(defvar gnus-decode-encoded-word-function 'mail-decode-encoded-word-string
Miles Bader's avatar
Miles Bader committed
1135 1136 1137 1138 1139
  "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.")
1140

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

(defcustom gnus-ignored-from-addresses
Miles Bader's avatar
Miles Bader committed
1148
  (and user-mail-address
1149 1150
       (not (string= user-mail-address ""))
       (regexp-quote user-mail-address))
1151 1152
  "*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
1153
  :version "21.1"
1154
  :group 'gnus-summary
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
  :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)
1174 1175 1176 1177 1178

(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
1179
  :version "21.1"
1180 1181 1182
  :type '(repeat symbol)
  :group 'gnus-charset)

Miles Bader's avatar
Miles Bader committed
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
(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))

1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
(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.
1204 1205
When these charsets are used in the \"charset\" parameter, the
default charset will be used instead."
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
 :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.")
1217 1218 1219 1220

(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
1221
  :version "21.1"
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
  :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
1236
  :version "21.1"
1237 1238 1239 1240 1241 1242
  :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
1243
  :version "21.1"
1244 1245 1246 1247 1248
  :type 'boolean
  :group 'gnus-summary-marks)

(defcustom gnus-alter-articles-to-read-function nil
  "Function to be called to alter the list of articles to be selected."
1249
  :type '(choice (const nil) function)
1250 1251 1252 1253 1254 1255 1256 1257
  :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
1258
(defcustom gnus-summary-save-parts-default-mime "image/.*"
1259 1260 1261 1262
  "*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
1263 1264 1265
  :group 'gnus-summary
  :type 'regexp)

1266 1267 1268 1269
(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
1270
that were fetched."
1271
  :version "22.1"
1272 1273 1274
  :group 'gnus-summary
  :type '(choice boolean regexp))

Miles Bader's avatar
Miles Bader committed
1275 1276 1277 1278 1279 1280 1281 1282 1283
(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")))

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

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

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1311 1312
;;; Internal variables