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

   1 ;;; gnus-sum.el --- summary mode commands for Gnus
   2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002
   3 ;;        Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-when-compile (require 'cl))
  30
  31 (require 'gnus)
  32 (require 'gnus-group)
  33 (require 'gnus-spec)
  34 (require 'gnus-range)
  35 (require 'gnus-int)
  36 (require 'gnus-undo)
  37 (require 'gnus-util)
  38 (require 'mm-decode)
  39 (require 'nnoo)
  40
  41 (autoload 'gnus-summary-limit-include-cached "gnus-cache" nil t)
  42 (autoload 'gnus-cache-write-active "gnus-cache")
  43 (autoload 'gnus-mailing-list-insinuate "gnus-ml" nil t)
  44 (autoload 'turn-on-gnus-mailing-list-mode "gnus-ml" nil t)
  45 (autoload 'mm-uu-dissect "mm-uu")
  46 (autoload 'gnus-article-outlook-deuglify-article "deuglify"
  47   "Deuglify broken Outlook (Express) articles and redisplay."
  48   t)
  49
  50 (defcustom gnus-kill-summary-on-exit t
  51   "*If non-nil, kill the summary buffer when you exit from it.
  52 If nil, the summary will become a \"*Dead Summary*\" buffer, and
  53 it will be killed sometime later."
  54   :group 'gnus-summary-exit
  55   :type 'boolean)
  56
  57 (defcustom gnus-fetch-old-headers nil
  58   "*Non-nil means that Gnus will try to build threads by grabbing old headers.
  59 If an unread article in the group refers to an older, already read (or
  60 just marked as read) article, the old article will not normally be
  61 displayed in the Summary buffer.  If this variable is non-nil, Gnus
  62 will attempt to grab the headers to the old articles, and thereby
  63 build complete threads.  If it has the value `some', only enough
  64 headers to connect otherwise loose threads will be displayed.  This
  65 variable can also be a number.  In that case, no more than that number
  66 of old headers will be fetched.  If it has the value `invisible', all
  67 old headers will be fetched, but none will be displayed.
  68
  69 The server has to support NOV for any of this to work."
  70   :group 'gnus-thread
  71   :type '(choice (const :tag "off" nil)
  72                  (const some)
  73                  number
  74                  (sexp :menu-tag "other" t)))
  75
  76 (defcustom gnus-refer-thread-limit 200
  77   "*The number of old headers to fetch when doing \\<gnus-summary-mode-map>\\[gnus-summary-refer-thread].
  78 If t, fetch all the available old headers."
  79   :group 'gnus-thread
  80   :type '(choice number
  81                  (sexp :menu-tag "other" t)))
  82
  83 (defcustom gnus-summary-make-false-root 'adopt
  84   "*nil means that Gnus won't gather loose threads.
  85 If the root of a thread has expired or been read in a previous
  86 session, the information necessary to build a complete thread has been
  87 lost.  Instead of having many small sub-threads from this original thread
  88 scattered all over the summary buffer, Gnus can gather them.
  89
  90 If non-nil, Gnus will try to gather all loose sub-threads from an
  91 original thread into one large thread.
  92
  93 If this variable is non-nil, it should be one of `none', `adopt',
  94 `dummy' or `empty'.
  95
  96 If this variable is `none', Gnus will not make a false root, but just
  97 present the sub-threads after another.
  98 If this variable is `dummy', Gnus will create a dummy root that will
  99 have all the sub-threads as children.
 100 If this variable is `adopt', Gnus will make one of the \"children\"
 101 the parent and mark all the step-children as such.
 102 If this variable is `empty', the \"children\" are printed with empty
 103 subject fields.  (Or rather, they will be printed with a string
 104 given by the `gnus-summary-same-subject' variable.)"
 105   :group 'gnus-thread
 106   :type '(choice (const :tag "off" nil)
 107                  (const none)
 108                  (const dummy)
 109                  (const adopt)
 110                  (const empty)))
 111
 112 (defcustom gnus-summary-make-false-root-always t
 113   "Always make a false dummy root."
 114   :group 'gnus-thread
 115   :type 'boolean)
 116
 117 (defcustom gnus-summary-gather-exclude-subject "^ *$\\|^(none)$"
 118   "*A regexp to match subjects to be excluded from loose thread gathering.
 119 As loose thread gathering is done on subjects only, that means that
 120 there can be many false gatherings performed.  By rooting out certain
 121 common subjects, gathering might become saner."
 122   :group 'gnus-thread
 123   :type 'regexp)
 124
 125 (defcustom gnus-summary-gather-subject-limit nil
 126   "*Maximum length of subject comparisons when gathering loose threads.
 127 Use nil to compare full subjects.  Setting this variable to a low
 128 number will help gather threads that have been corrupted by
 129 newsreaders chopping off subject lines, but it might also mean that
 130 unrelated articles that have subject that happen to begin with the
 131 same few characters will be incorrectly gathered.
 132
 133 If this variable is `fuzzy', Gnus will use a fuzzy algorithm when
 134 comparing subjects."
 135   :group 'gnus-thread
 136   :type '(choice (const :tag "off" nil)
 137                  (const fuzzy)
 138                  (sexp :menu-tag "on" t)))
 139
 140 (defcustom gnus-simplify-subject-functions nil
 141   "List of functions taking a string argument that simplify subjects.
 142 The functions are applied recursively.
 143
 144 Useful functions to put in this list include:
 145 `gnus-simplify-subject-re', `gnus-simplify-subject-fuzzy',
 146 `gnus-simplify-whitespace', and `gnus-simplify-all-whitespace'."
 147   :group 'gnus-thread
 148   :type '(repeat function))
 149
 150 (defcustom gnus-simplify-ignored-prefixes nil
 151   "*Remove matches for this regexp from subject lines when simplifying fuzzily."
 152   :group 'gnus-thread
 153   :type '(choice (const :tag "off" nil)
 154                  regexp))
 155
 156 (defcustom gnus-build-sparse-threads nil
 157   "*If non-nil, fill in the gaps in threads.
 158 If `some', only fill in the gaps that are needed to tie loose threads
 159 together.  If `more', fill in all leaf nodes that Gnus can find.  If
 160 non-nil and non-`some', fill in all gaps that Gnus manages to guess."
 161   :group 'gnus-thread
 162   :type '(choice (const :tag "off" nil)
 163                  (const some)
 164                  (const more)
 165                  (sexp :menu-tag "all" t)))
 166
 167 (defcustom gnus-summary-thread-gathering-function
 168   'gnus-gather-threads-by-subject
 169   "*Function used for gathering loose threads.
 170 There are two pre-defined functions: `gnus-gather-threads-by-subject',
 171 which only takes Subjects into consideration; and
 172 `gnus-gather-threads-by-references', which compared the References
 173 headers of the articles to find matches."
 174   :group 'gnus-thread
 175   :type '(radio (function-item gnus-gather-threads-by-subject)
 176                 (function-item gnus-gather-threads-by-references)
 177                 (function :tag "other")))
 178
 179 (defcustom gnus-summary-same-subject ""
 180   "*String indicating that the current article has the same subject as the previous.
 181 This variable will only be used if the value of
 182 `gnus-summary-make-false-root' is `empty'."
 183   :group 'gnus-summary-format
 184   :type 'string)
 185
 186 (defcustom gnus-summary-goto-unread t
 187   "*If t, many commands will go to the next unread article.
 188 This applies to marking commands as well as other commands that
 189 \"naturally\" select the next article, like, for instance, `SPC' at
 190 the end of an article.
 191
 192 If nil, the marking commands do NOT go to the next unread article
 193 \(they go to the next article instead).  If `never', commands that
 194 usually go to the next unread article, will go to the next article,
 195 whether it is read or not."
 196   :group 'gnus-summary-marks
 197   :link '(custom-manual "(gnus)Setting Marks")
 198   :type '(choice (const :tag "off" nil)
 199                  (const never)
 200                  (sexp :menu-tag "on" t)))
 201
 202 (defcustom gnus-summary-default-score 0
 203   "*Default article score level.
 204 All scores generated by the score files will be added to this score.
 205 If this variable is nil, scoring will be disabled."
 206   :group 'gnus-score-default
 207   :type '(choice (const :tag "disable")
 208                  integer))
 209
 210 (defcustom gnus-summary-default-high-score 0
 211   "*Default threshold for a high scored article.
 212 An article will be highlighted as high scored if its score is greater
 213 than this score."
 214   :group 'gnus-score-default
 215   :type 'integer)
 216
 217 (defcustom gnus-summary-default-low-score 0
 218   "*Default threshold for a low scored article.
 219 An article will be highlighted as low scored if its score is smaller
 220 than this score."
 221   :group 'gnus-score-default
 222   :type 'integer)
 223
 224 (defcustom gnus-summary-zcore-fuzz 0
 225   "*Fuzziness factor for the zcore in the summary buffer.
 226 Articles with scores closer than this to `gnus-summary-default-score'
 227 will not be marked."
 228   :group 'gnus-summary-format
 229   :type 'integer)
 230
 231 (defcustom gnus-simplify-subject-fuzzy-regexp nil
 232   "*Strings to be removed when doing fuzzy matches.
 233 This can either be a regular expression or list of regular expressions
 234 that will be removed from subject strings if fuzzy subject
 235 simplification is selected."
 236   :group 'gnus-thread
 237   :type '(repeat regexp))
 238
 239 (defcustom gnus-show-threads t
 240   "*If non-nil, display threads in summary mode."
 241   :group 'gnus-thread
 242   :type 'boolean)
 243
 244 (defcustom gnus-thread-hide-subtree nil
 245   "*If non-nil, hide all threads initially.
 246 This can be a predicate specifier which says which threads to hide.
 247 If threads are hidden, you have to run the command
 248 `gnus-summary-show-thread' by hand or use `gnus-select-article-hook'
 249 to expose hidden threads."
 250   :group 'gnus-thread
 251   :type 'boolean)
 252
 253 (defcustom gnus-thread-hide-killed t
 254   "*If non-nil, hide killed threads automatically."
 255   :group 'gnus-thread
 256   :type 'boolean)
 257
 258 (defcustom gnus-thread-ignore-subject t
 259   "*If non-nil, which is the default, ignore subjects and do all threading based on the Reference header.
 260 If nil, articles that have different subjects from their parents will
 261 start separate threads."
 262   :group 'gnus-thread
 263   :type 'boolean)
 264
 265 (defcustom gnus-thread-operation-ignore-subject t
 266   "*If non-nil, subjects will be ignored when doing thread commands.
 267 This affects commands like `gnus-summary-kill-thread' and
 268 `gnus-summary-lower-thread'.
 269
 270 If this variable is nil, articles in the same thread with different
 271 subjects will not be included in the operation in question.  If this
 272 variable is `fuzzy', only articles that have subjects that are fuzzily
 273 equal will be included."
 274   :group 'gnus-thread
 275   :type '(choice (const :tag "off" nil)
 276                  (const fuzzy)
 277                  (sexp :tag "on" t)))
 278
 279 (defcustom gnus-thread-indent-level 4
 280   "*Number that says how much each sub-thread should be indented."
 281   :group 'gnus-thread
 282   :type 'integer)
 283
 284 (defcustom gnus-auto-extend-newsgroup t
 285   "*If non-nil, extend newsgroup forward and backward when requested."
 286   :group 'gnus-summary-choose
 287   :type 'boolean)
 288
 289 (defcustom gnus-auto-select-first t
 290   "*If non-nil, select the article under point.
 291 Which article this is is controlled by the `gnus-auto-select-subject'
 292 variable.
 293
 294 If you want to prevent automatic selection of articles in some
 295 newsgroups, set the variable to nil in `gnus-select-group-hook'."
 296   :group 'gnus-group-select
 297   :type '(choice (const :tag "none" nil)
 298                  (sexp :menu-tag "first" t)))
 299
 300 (defcustom gnus-auto-select-subject 'unread
 301   "*Says what subject to place under point when entering a group.
 302
 303 This variable can either be the symbols `first' (place point on the
 304 first subject), `unread' (place point on the subject line of the first
 305 unread article), `best' (place point on the subject line of the
 306 higest-scored article), `unseen' (place point on the subject line of
 307 the first unseen article), 'unseen-or-unread' (place point on the subject
 308 line of the first unseen article or, if all article have been seen, on the
 309 subject line of the first unread article), or a function to be called to
 310 place point on some subject line."
 311   :group 'gnus-group-select
 312   :type '(choice (const best)
 313                  (const unread)
 314                  (const first)
 315                  (const unseen)
 316                  (const unseen-or-unread)))
 317
 318 (defcustom gnus-auto-select-next t
 319   "*If non-nil, offer to go to the next group from the end of the previous.
 320 If the value is t and the next newsgroup is empty, Gnus will exit
 321 summary mode and go back to group mode.  If the value is neither nil
 322 nor t, Gnus will select the following unread newsgroup.  In
 323 particular, if the value is the symbol `quietly', the next unread
 324 newsgroup will be selected without any confirmation, and if it is
 325 `almost-quietly', the next group will be selected without any
 326 confirmation if you are located on the last article in the group.
 327 Finally, if this variable is `slightly-quietly', the `Z n' command
 328 will go to the next group without confirmation."
 329   :group 'gnus-summary-maneuvering
 330   :type '(choice (const :tag "off" nil)
 331                  (const quietly)
 332                  (const almost-quietly)
 333                  (const slightly-quietly)
 334                  (sexp :menu-tag "on" t)))
 335
 336 (defcustom gnus-auto-select-same nil
 337   "*If non-nil, select the next article with the same subject.
 338 If there are no more articles with the same subject, go to
 339 the first unread article."
 340   :group 'gnus-summary-maneuvering
 341   :type 'boolean)
 342
 343 (defcustom gnus-summary-check-current nil
 344   "*If non-nil, consider the current article when moving.
 345 The \"unread\" movement commands will stay on the same line if the
 346 current article is unread."
 347   :group 'gnus-summary-maneuvering
 348   :type 'boolean)
 349
 350 (defcustom gnus-auto-center-summary t
 351   "*If non-nil, always center the current summary buffer.
 352 In particular, if `vertical' do only vertical recentering.  If non-nil
 353 and non-`vertical', do both horizontal and vertical recentering."
 354   :group 'gnus-summary-maneuvering
 355   :type '(choice (const :tag "none" nil)
 356                  (const vertical)
 357                  (integer :tag "height")
 358                  (sexp :menu-tag "both" t)))
 359
 360 (defcustom gnus-show-all-headers nil
 361   "*If non-nil, don't hide any headers."
 362   :group 'gnus-article-hiding
 363   :group 'gnus-article-headers
 364   :type 'boolean)
 365
 366 (defcustom gnus-summary-ignore-duplicates nil
 367   "*If non-nil, ignore articles with identical Message-ID headers."
 368   :group 'gnus-summary
 369   :type 'boolean)
 370
 371 (defcustom gnus-single-article-buffer t
 372   "*If non-nil, display all articles in the same buffer.
 373 If nil, each group will get its own article buffer."
 374   :group 'gnus-article-various
 375   :type 'boolean)
 376
 377 (defcustom gnus-break-pages t
 378   "*If non-nil, do page breaking on articles.
 379 The page delimiter is specified by the `gnus-page-delimiter'
 380 variable."
 381   :group 'gnus-article-various
 382   :type 'boolean)
 383
 384 (defcustom gnus-move-split-methods nil
 385   "*Variable used to suggest where articles are to be moved to.
 386 It uses the same syntax as the `gnus-split-methods' variable.
 387 However, whereas `gnus-split-methods' specifies file names as targets,
 388 this variable specifies group names."
 389   :group 'gnus-summary-mail
 390   :type '(repeat (choice (list :value (fun) function)
 391                          (cons :value ("" "") regexp (repeat string))
 392                          (sexp :value nil))))
 393
 394 (defcustom gnus-unread-mark ?           ;Whitespace
 395   "*Mark used for unread articles."
 396   :group 'gnus-summary-marks
 397   :type 'character)
 398
 399 (defcustom gnus-ticked-mark ?!
 400   "*Mark used for ticked articles."
 401   :group 'gnus-summary-marks
 402   :type 'character)
 403
 404 (defcustom gnus-dormant-mark ??
 405   "*Mark used for dormant articles."
 406   :group 'gnus-summary-marks
 407   :type 'character)
 408
 409 (defcustom gnus-del-mark ?r
 410   "*Mark used for del'd articles."
 411   :group 'gnus-summary-marks
 412   :type 'character)
 413
 414 (defcustom gnus-read-mark ?R
 415   "*Mark used for read articles."
 416   :group 'gnus-summary-marks
 417   :type 'character)
 418
 419 (defcustom gnus-expirable-mark ?E
 420   "*Mark used for expirable articles."
 421   :group 'gnus-summary-marks
 422   :type 'character)
 423
 424 (defcustom gnus-killed-mark ?K
 425   "*Mark used for killed articles."
 426   :group 'gnus-summary-marks
 427   :type 'character)
 428
 429 (defcustom gnus-spam-mark ?H
 430   "*Mark used for spam articles."
 431   :group 'gnus-summary-marks
 432   :type 'character)
 433
 434 (defcustom gnus-souped-mark ?F
 435   "*Mark used for souped articles."
 436   :group 'gnus-summary-marks
 437   :type 'character)
 438
 439 (defcustom gnus-kill-file-mark ?X
 440   "*Mark used for articles killed by kill files."
 441   :group 'gnus-summary-marks
 442   :type 'character)
 443
 444 (defcustom gnus-low-score-mark ?Y
 445   "*Mark used for articles with a low score."
 446   :group 'gnus-summary-marks
 447   :type 'character)
 448
 449 (defcustom gnus-catchup-mark ?C
 450   "*Mark used for articles that are caught up."
 451   :group 'gnus-summary-marks
 452   :type 'character)
 453
 454 (defcustom gnus-replied-mark ?A
 455   "*Mark used for articles that have been replied to."
 456   :group 'gnus-summary-marks
 457   :type 'character)
 458
 459 (defcustom gnus-forwarded-mark ?F
 460   "*Mark used for articles that have been forwarded."
 461   :group 'gnus-summary-marks
 462   :type 'character)
 463
 464 (defcustom gnus-recent-mark ?N
 465   "*Mark used for articles that are recent."
 466   :group 'gnus-summary-marks
 467   :type 'character)
 468
 469 (defcustom gnus-cached-mark ?*
 470   "*Mark used for articles that are in the cache."
 471   :group 'gnus-summary-marks
 472   :type 'character)
 473
 474 (defcustom gnus-saved-mark ?S
 475   "*Mark used for articles that have been saved."
 476   :group 'gnus-summary-marks
 477   :type 'character)
 478
 479 (defcustom gnus-unseen-mark ?.
 480   "*Mark used for articles that haven't been seen."
 481   :group 'gnus-summary-marks
 482   :type 'character)
 483
 484 (defcustom gnus-no-mark ?               ;Whitespace
 485   "*Mark used for articles that have no other secondary mark."
 486   :group 'gnus-summary-marks
 487   :type 'character)
 488
 489 (defcustom gnus-ancient-mark ?O
 490   "*Mark used for ancient articles."
 491   :group 'gnus-summary-marks
 492   :type 'character)
 493
 494 (defcustom gnus-sparse-mark ?Q
 495   "*Mark used for sparsely reffed articles."
 496   :group 'gnus-summary-marks
 497   :type 'character)
 498
 499 (defcustom gnus-canceled-mark ?G
 500   "*Mark used for canceled articles."
 501   :group 'gnus-summary-marks
 502   :type 'character)
 503
 504 (defcustom gnus-duplicate-mark ?M
 505   "*Mark used for duplicate articles."
 506   :group 'gnus-summary-marks
 507   :type 'character)
 508
 509 (defcustom gnus-undownloaded-mark ?-
 510   "*Mark used for articles that weren't downloaded."
 511   :group 'gnus-summary-marks
 512   :type 'character)
 513
 514 (defcustom gnus-downloaded-mark ?+
 515   "*Mark used for articles that were downloaded."
 516   :group 'gnus-summary-marks
 517   :type 'character)
 518
 519 (defcustom gnus-downloadable-mark ?%
 520   "*Mark used for articles that are to be downloaded."
 521   :group 'gnus-summary-marks
 522   :type 'character)
 523
 524 (defcustom gnus-unsendable-mark ?=
 525   "*Mark used for articles that won't be sent."
 526   :group 'gnus-summary-marks
 527   :type 'character)
 528
 529 (defcustom gnus-score-over-mark ?+
 530   "*Score mark used for articles with high scores."
 531   :group 'gnus-summary-marks
 532   :type 'character)
 533
 534 (defcustom gnus-score-below-mark ?-
 535   "*Score mark used for articles with low scores."
 536   :group 'gnus-summary-marks
 537   :type 'character)
 538
 539 (defcustom gnus-empty-thread-mark ?     ;Whitespace
 540   "*There is no thread under the article."
 541   :group 'gnus-summary-marks
 542   :type 'character)
 543
 544 (defcustom gnus-not-empty-thread-mark ?=
 545   "*There is a thread under the article."
 546   :group 'gnus-summary-marks
 547   :type 'character)
 548
 549 (defcustom gnus-view-pseudo-asynchronously nil
 550   "*If non-nil, Gnus will view pseudo-articles asynchronously."
 551   :group 'gnus-extract-view
 552   :type 'boolean)
 553
 554 (defcustom gnus-auto-expirable-marks
 555   (list gnus-killed-mark gnus-del-mark gnus-catchup-mark
 556         gnus-low-score-mark gnus-ancient-mark gnus-read-mark
 557         gnus-souped-mark gnus-duplicate-mark)
 558   "*The list of marks converted into expiration if a group is auto-expirable."
 559   :version "21.1"
 560   :group 'gnus-summary
 561   :type '(repeat character))
 562
 563 (defcustom gnus-inhibit-user-auto-expire t
 564   "*If non-nil, user marking commands will not mark an article as expirable, even if the group has auto-expire turned on."
 565   :version "21.1"
 566   :group 'gnus-summary
 567   :type 'boolean)
 568
 569 (defcustom gnus-view-pseudos nil
 570   "*If `automatic', pseudo-articles will be viewed automatically.
 571 If `not-confirm', pseudos will be viewed automatically, and the user
 572 will not be asked to confirm the command."
 573   :group 'gnus-extract-view
 574   :type '(choice (const :tag "off" nil)
 575                  (const automatic)
 576                  (const not-confirm)))
 577
 578 (defcustom gnus-view-pseudos-separately t
 579   "*If non-nil, one pseudo-article will be created for each file to be viewed.
 580 If nil, all files that use the same viewing command will be given as a
 581 list of parameters to that command."
 582   :group 'gnus-extract-view
 583   :type 'boolean)
 584
 585 (defcustom gnus-insert-pseudo-articles t
 586   "*If non-nil, insert pseudo-articles when decoding articles."
 587   :group 'gnus-extract-view
 588   :type 'boolean)
 589
 590 (defcustom gnus-summary-dummy-line-format
 591   "   %(:                             :%) %S\n"
 592   "*The format specification for the dummy roots in the summary buffer.
 593 It works along the same lines as a normal formatting string,
 594 with some simple extensions.
 595
 596 %S  The subject
 597
 598 General format specifiers can also be used.
 599 See `(gnus)Formatting Variables'."
 600   :link '(custom-manual "(gnus)Formatting Variables")
 601   :group 'gnus-threading
 602   :type 'string)
 603
 604 (defcustom gnus-summary-mode-line-format "Gnus: %g [%A] %Z"
 605   "*The format specification for the summary mode line.
 606 It works along the same lines as a normal formatting string,
 607 with some simple extensions:
 608
 609 %G  Group name
 610 %p  Unprefixed group name
 611 %A  Current article number
 612 %z  Current article score
 613 %V  Gnus version
 614 %U  Number of unread articles in the group
 615 %e  Number of unselected articles in the group
 616 %Z  A string with unread/unselected article counts
 617 %g  Shortish group name
 618 %S  Subject of the current article
 619 %u  User-defined spec
 620 %s  Current score file name
 621 %d  Number of dormant articles
 622 %r  Number of articles that have been marked as read in this session
 623 %E  Number of articles expunged by the score files"
 624   :group 'gnus-summary-format
 625   :type 'string)
 626
 627 (defcustom gnus-list-identifiers nil
 628   "Regexp that matches list identifiers to be removed from subject.
 629 This can also be a list of regexps."
 630   :version "21.1"
 631   :group 'gnus-summary-format
 632   :group 'gnus-article-hiding
 633   :type '(choice (const :tag "none" nil)
 634                  (regexp :value ".*")
 635                  (repeat :value (".*") regexp)))
 636
 637 (defcustom gnus-summary-mark-below 0
 638   "*Mark all articles with a score below this variable as read.
 639 This variable is local to each summary buffer and usually set by the
 640 score file."
 641   :group 'gnus-score-default
 642   :type 'integer)
 643
 644 (defcustom gnus-article-sort-functions '(gnus-article-sort-by-number)
 645   "*List of functions used for sorting articles in the summary buffer.
 646
 647 Each function takes two articles and returns non-nil if the first
 648 article should be sorted before the other.  If you use more than one
 649 function, the primary sort function should be the last.  You should
 650 probably always include `gnus-article-sort-by-number' in the list of
 651 sorting functions -- preferably first.  Also note that sorting by date
 652 is often much slower than sorting by number, and the sorting order is
 653 very similar.  (Sorting by date means sorting by the time the message
 654 was sent, sorting by number means sorting by arrival time.)
 655
 656 Ready-made functions include `gnus-article-sort-by-number',
 657 `gnus-article-sort-by-author', `gnus-article-sort-by-subject',
 658 `gnus-article-sort-by-date', `gnus-article-sort-by-random'
 659 and `gnus-article-sort-by-score'.
 660
 661 When threading is turned on, the variable `gnus-thread-sort-functions'
 662 controls how articles are sorted."
 663   :group 'gnus-summary-sort
 664   :type '(repeat (choice (function-item gnus-article-sort-by-number)
 665                          (function-item gnus-article-sort-by-author)
 666                          (function-item gnus-article-sort-by-subject)
 667                          (function-item gnus-article-sort-by-date)
 668                          (function-item gnus-article-sort-by-score)
 669                          (function-item gnus-article-sort-by-random)
 670                          (function :tag "other"))))
 671
 672 (defcustom gnus-thread-sort-functions '(gnus-thread-sort-by-number)
 673   "*List of functions used for sorting threads in the summary buffer.
 674 By default, threads are sorted by article number.
 675
 676 Each function takes two threads and returns non-nil if the first
 677 thread should be sorted before the other.  If you use more than one
 678 function, the primary sort function should be the last.  You should
 679 probably always include `gnus-thread-sort-by-number' in the list of
 680 sorting functions -- preferably first.  Also note that sorting by date
 681 is often much slower than sorting by number, and the sorting order is
 682 very similar.  (Sorting by date means sorting by the time the message
 683 was sent, sorting by number means sorting by arrival time.)
 684
 685 Ready-made functions include `gnus-thread-sort-by-number',
 686 `gnus-thread-sort-by-author', `gnus-thread-sort-by-subject',
 687 `gnus-thread-sort-by-date', `gnus-thread-sort-by-score',
 688 `gnus-thread-sort-by-most-recent-number',
 689 `gnus-thread-sort-by-most-recent-date',
 690 `gnus-thread-sort-by-random', and
 691 `gnus-thread-sort-by-total-score' (see `gnus-thread-score-function').
 692
 693 When threading is turned off, the variable
 694 `gnus-article-sort-functions' controls how articles are sorted."
 695   :group 'gnus-summary-sort
 696   :type '(repeat (choice (function-item gnus-thread-sort-by-number)
 697                          (function-item gnus-thread-sort-by-author)
 698                          (function-item gnus-thread-sort-by-subject)
 699                          (function-item gnus-thread-sort-by-date)
 700                          (function-item gnus-thread-sort-by-score)
 701                          (function-item gnus-thread-sort-by-total-score)
 702                          (function-item gnus-thread-sort-by-random)
 703                          (function :tag "other"))))
 704
 705 (defcustom gnus-thread-score-function '+
 706   "*Function used for calculating the total score of a thread.
 707
 708 The function is called with the scores of the article and each
 709 subthread and should then return the score of the thread.
 710
 711 Some functions you can use are `+', `max', or `min'."
 712   :group 'gnus-summary-sort
 713   :type 'function)
 714
 715 (defcustom gnus-summary-expunge-below nil
 716   "All articles that have a score less than this variable will be expunged.
 717 This variable is local to the summary buffers."
 718   :group 'gnus-score-default
 719   :type '(choice (const :tag "off" nil)
 720                  integer))
 721
 722 (defcustom gnus-thread-expunge-below nil
 723   "All threads that have a total score less than this variable will be expunged.
 724 See `gnus-thread-score-function' for en explanation of what a
 725 \"thread score\" is.
 726
 727 This variable is local to the summary buffers."
 728   :group 'gnus-threading
 729   :group 'gnus-score-default
 730   :type '(choice (const :tag "off" nil)
 731                  integer))
 732
 733 (defcustom gnus-summary-mode-hook nil
 734   "*A hook for Gnus summary mode.
 735 This hook is run before any variables are set in the summary buffer."
 736   :options '(turn-on-gnus-mailing-list-mode gnus-pick-mode)
 737   :group 'gnus-summary-various
 738   :type 'hook)
 739
 740 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
 741 (when (featurep 'xemacs)
 742   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-summary-menu-add)
 743   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-setup-summary-toolbar)
 744   (add-hook 'gnus-summary-mode-hook
 745             'gnus-xmas-switch-horizontal-scrollbar-off))
 746
 747 (defcustom gnus-summary-menu-hook nil
 748   "*Hook run after the creation of the summary mode menu."
 749   :group 'gnus-summary-visual
 750   :type 'hook)
 751
 752 (defcustom gnus-summary-exit-hook nil
 753   "*A hook called on exit from the summary buffer.
 754 It will be called with point in the group buffer."
 755   :group 'gnus-summary-exit
 756   :type 'hook)
 757
 758 (defcustom gnus-summary-prepare-hook nil
 759   "*A hook called after the summary buffer has been generated.
 760 If you want to modify the summary buffer, you can use this hook."
 761   :group 'gnus-summary-various
 762   :type 'hook)
 763
 764 (defcustom gnus-summary-prepared-hook nil
 765   "*A hook called as the last thing after the summary buffer has been generated."
 766   :group 'gnus-summary-various
 767   :type 'hook)
 768
 769 (defcustom gnus-summary-generate-hook nil
 770   "*A hook run just before generating the summary buffer.
 771 This hook is commonly used to customize threading variables and the
 772 like."
 773   :group 'gnus-summary-various
 774   :type 'hook)
 775
 776 (defcustom gnus-select-group-hook nil
 777   "*A hook called when a newsgroup is selected.
 778
 779 If you'd like to simplify subjects like the
 780 `gnus-summary-next-same-subject' command does, you can use the
 781 following hook:
 782
 783  (add-hook gnus-select-group-hook
 784            (lambda ()
 785              (mapcar (lambda (header)
 786                        (mail-header-set-subject
 787                         header
 788                         (gnus-simplify-subject
 789                          (mail-header-subject header) 're-only)))
 790                      gnus-newsgroup-headers)))"
 791   :group 'gnus-group-select
 792   :type 'hook)
 793
 794 (defcustom gnus-select-article-hook nil
 795   "*A hook called when an article is selected."
 796   :group 'gnus-summary-choose
 797   :type 'hook)
 798
 799 (defcustom gnus-visual-mark-article-hook
 800   (list 'gnus-highlight-selected-summary)
 801   "*Hook run after selecting an article in the summary buffer.
 802 It is meant to be used for highlighting the article in some way.  It
 803 is not run if `gnus-visual' is nil."
 804   :group 'gnus-summary-visual
 805   :type 'hook)
 806
 807 (defcustom gnus-parse-headers-hook nil
 808   "*A hook called before parsing the headers."
 809   :group 'gnus-various
 810   :type 'hook)
 811
 812 (defcustom gnus-exit-group-hook nil
 813   "*A hook called when exiting summary mode.
 814 This hook is not called from the non-updating exit commands like `Q'."
 815   :group 'gnus-various
 816   :type 'hook)
 817
 818 (defcustom gnus-summary-update-hook
 819   (list 'gnus-summary-highlight-line)
 820   "*A hook called when a summary line is changed.
 821 The hook will not be called if `gnus-visual' is nil.
 822
 823 The default function `gnus-summary-highlight-line' will
 824 highlight the line according to the `gnus-summary-highlight'
 825 variable."
 826   :group 'gnus-summary-visual
 827   :type 'hook)
 828
 829 (defcustom gnus-mark-article-hook '(gnus-summary-mark-read-and-unread-as-read)
 830   "*A hook called when an article is selected for the first time.
 831 The hook is intended to mark an article as read (or unread)
 832 automatically when it is selected."
 833   :group 'gnus-summary-choose
 834   :type 'hook)
 835
 836 (defcustom gnus-group-no-more-groups-hook nil
 837   "*A hook run when returning to group mode having no more (unread) groups."
 838   :group 'gnus-group-select
 839   :type 'hook)
 840
 841 (defcustom gnus-ps-print-hook nil
 842   "*A hook run before ps-printing something from Gnus."
 843   :group 'gnus-summary
 844   :type 'hook)
 845
 846 (defcustom gnus-summary-display-arrow
 847   (and (fboundp 'display-graphic-p)
 848        (display-graphic-p))
 849   "*If non-nil, display an arrow highlighting the current article."
 850   :version "21.1"
 851   :group 'gnus-summary
 852   :type 'boolean)
 853
 854 (defcustom gnus-summary-selected-face 'gnus-summary-selected-face
 855   "Face used for highlighting the current article in the summary buffer."
 856   :group 'gnus-summary-visual
 857   :type 'face)
 858
 859 (defvar gnus-tmp-downloaded nil)
 860
 861 (defcustom gnus-summary-highlight
 862   '(((eq mark gnus-canceled-mark)
 863      . gnus-summary-cancelled-face)
 864     ((and uncached (> score default-high))
 865      . gnus-summary-high-uncached-face)
 866     ((and uncached (< score default-low))
 867      . gnus-summary-low-uncached-face)
 868     (uncached
 869      . gnus-summary-normal-uncached-face)
 870     ((and (> score default-high)
 871           (or (eq mark gnus-dormant-mark)
 872               (eq mark gnus-ticked-mark)))
 873      . gnus-summary-high-ticked-face)
 874     ((and (< score default-low)
 875           (or (eq mark gnus-dormant-mark)
 876               (eq mark gnus-ticked-mark)))
 877      . gnus-summary-low-ticked-face)
 878     ((or (eq mark gnus-dormant-mark)
 879          (eq mark gnus-ticked-mark))
 880      . gnus-summary-normal-ticked-face)
 881     ((and (> score default-high) (eq mark gnus-ancient-mark))
 882      . gnus-summary-high-ancient-face)
 883     ((and (< score default-low) (eq mark gnus-ancient-mark))
 884      . gnus-summary-low-ancient-face)
 885     ((eq mark gnus-ancient-mark)
 886      . gnus-summary-normal-ancient-face)
 887     ((and (> score default-high) (eq mark gnus-unread-mark))
 888      . gnus-summary-high-unread-face)
 889     ((and (< score default-low) (eq mark gnus-unread-mark))
 890      . gnus-summary-low-unread-face)
 891     ((eq mark gnus-unread-mark)
 892      . gnus-summary-normal-unread-face)
 893     ((> score default-high)
 894      . gnus-summary-high-read-face)
 895     ((< score default-low)
 896      . gnus-summary-low-read-face)
 897     (t
 898      . gnus-summary-normal-read-face))
 899   "*Controls the highlighting of summary buffer lines.
 900
 901 A list of (FORM . FACE) pairs.  When deciding how a a particular
 902 summary line should be displayed, each form is evaluated.  The content
 903 of the face field after the first true form is used.  You can change
 904 how those summary lines are displayed, by editing the face field.
 905
 906 You can use the following variables in the FORM field.
 907
 908 score:        The article's score
 909 default:      The default article score.
 910 default-high: The default score for high scored articles.
 911 default-low:  The default score for low scored articles.
 912 below:        The score below which articles are automatically marked as read.
 913 mark:         The articles mark."
 914   :group 'gnus-summary-visual
 915   :type '(repeat (cons (sexp :tag "Form" nil)
 916                        face)))
 917
 918 (defcustom gnus-alter-header-function nil
 919   "Function called to allow alteration of article header structures.
 920 The function is called with one parameter, the article header vector,
 921 which it may alter in any way.")
 922
 923 (defvar gnus-decode-encoded-word-function 'mail-decode-encoded-word-string
 924   "Variable that says which function should be used to decode a string with encoded words.")
 925
 926 (defcustom gnus-extra-headers '(To Newsgroups)
 927   "*Extra headers to parse."
 928   :version "21.1"
 929   :group 'gnus-summary
 930   :type '(repeat symbol))
 931
 932 (defcustom gnus-ignored-from-addresses
 933   (and user-mail-address (regexp-quote user-mail-address))
 934   "*Regexp of From headers that may be suppressed in favor of To headers."
 935   :version "21.1"
 936   :group 'gnus-summary
 937   :type 'regexp)
 938
 939 (defcustom gnus-newsgroup-ignored-charsets '(unknown-8bit x-unknown)
 940   "List of charsets that should be ignored.
 941 When these charsets are used in the \"charset\" parameter, the
 942 default charset will be used instead."
 943   :version "21.1"
 944   :type '(repeat symbol)
 945   :group 'gnus-charset)
 946
 947 (gnus-define-group-parameter
 948  ignored-charsets
 949  :type list
 950  :function-document
 951  "Return the ignored charsets of GROUP."
 952  :variable gnus-group-ignored-charsets-alist
 953  :variable-default
 954  '(("alt\\.chinese\\.text" iso-8859-1))
 955  :variable-document
 956  "Alist of regexps (to match group names) and charsets that should be ignored.
 957 When these charsets are used in the \"charset\" parameter, the
 958 default charset will be used instead."
 959  :variable-group gnus-charset
 960  :variable-type '(repeat (cons (regexp :tag "Group")
 961                                (repeat symbol)))
 962  :parameter-type '(choice :tag "Ignored charsets"
 963                           :value nil
 964                           (repeat (symbol)))
 965  :parameter-document       "\
 966 List of charsets that should be ignored.
 967
 968 When these charsets are used in the \"charset\" parameter, the
 969 default charset will be used instead.")
 970
 971 (defcustom gnus-group-highlight-words-alist nil
 972   "Alist of group regexps and highlight regexps.
 973 This variable uses the same syntax as `gnus-emphasis-alist'."
 974   :version "21.1"
 975   :type '(repeat (cons (regexp :tag "Group")
 976                        (repeat (list (regexp :tag "Highlight regexp")
 977                                      (number :tag "Group for entire word" 0)
 978                                      (number :tag "Group for displayed part" 0)
 979                                      (symbol :tag "Face"
 980                                              gnus-emphasis-highlight-words)))))
 981   :group 'gnus-summary-visual)
 982
 983 (defcustom gnus-summary-show-article-charset-alist
 984   nil
 985   "Alist of number and charset.
 986 The article will be shown with the charset corresponding to the
 987 numbered argument.
 988 For example: ((1 . cn-gb-2312) (2 . big5))."
 989   :version "21.1"
 990   :type '(repeat (cons (number :tag "Argument" 1)
 991                        (symbol :tag "Charset")))
 992   :group 'gnus-charset)
 993
 994 (defcustom gnus-preserve-marks t
 995   "Whether marks are preserved when moving, copying and respooling messages."
 996   :version "21.1"
 997   :type 'boolean
 998   :group 'gnus-summary-marks)
 999
1000 (defcustom gnus-alter-articles-to-read-function nil
1001   "Function to be called to alter the list of articles to be selected."
1002   :type '(choice (const nil) function)
1003   :group 'gnus-summary)
1004
1005 (defcustom gnus-orphan-score nil
1006   "*All orphans get this score added.  Set in the score file."
1007   :group 'gnus-score-default
1008   :type '(choice (const nil)
1009                  integer))
1010
1011 (defcustom gnus-summary-save-parts-default-mime "image/.*"
1012   "*A regexp to match MIME parts when saving multiple parts of a message
1013 with gnus-summary-save-parts (X m). This regexp will be used by default
1014 when prompting the user for which type of files to save."
1015   :group 'gnus-summary
1016   :type 'regexp)
1017
1018 (defcustom gnus-read-all-available-headers nil
1019   "Whether Gnus should parse all headers made available to it.
1020 This is mostly relevant for slow backends where the user may
1021 wish to widen the summary buffer to include all headers
1022 that were fetched.  Say, for nnultimate groups."
1023   :group 'gnus-summary
1024   :type '(choice boolean regexp))
1025
1026 (defcustom gnus-summary-muttprint-program "muttprint"
1027   "Command (and optional arguments) used to run Muttprint."
1028   :version "21.3"
1029   :group 'gnus-summary
1030   :type 'string)
1031
1032 (defcustom gnus-article-loose-mime nil
1033   "If non-nil, don't require MIME-Version header.
1034 Some brain-damaged MUA/MTA, e.g. Lotus Domino 5.0.6 clients, does not
1035 supply the MIME-Version header or deliberately strip it From the mail.
1036 Set it to non-nil, Gnus will treat some articles as MIME even if
1037 the MIME-Version header is missed."
1038   :version "21.3"
1039   :type 'boolean
1040   :group 'gnus-article)
1041
1042 ;;; Internal variables
1043
1044 (defvar gnus-summary-display-cache nil)
1045 (defvar gnus-article-mime-handles nil)
1046 (defvar gnus-article-decoded-p nil)
1047 (defvar gnus-article-charset nil)
1048 (defvar gnus-article-ignored-charsets nil)
1049 (defvar gnus-scores-exclude-files nil)
1050 (defvar gnus-page-broken nil)
1051
1052 (defvar gnus-original-article nil)
1053 (defvar gnus-article-internal-prepare-hook nil)
1054 (defvar gnus-newsgroup-process-stack nil)
1055
1056 (defvar gnus-thread-indent-array nil)
1057 (defvar gnus-thread-indent-array-level gnus-thread-indent-level)
1058 (defvar gnus-sort-gathered-threads-function 'gnus-thread-sort-by-number
1059   "Function called to sort the articles within a thread after it has been gathered together.")
1060
1061 (defvar gnus-summary-save-parts-type-history nil)
1062 (defvar gnus-summary-save-parts-last-directory nil)
1063
1064 ;; Avoid highlighting in kill files.
1065 (defvar gnus-summary-inhibit-highlight nil)
1066 (defvar gnus-newsgroup-selected-overlay nil)
1067 (defvar gnus-inhibit-limiting nil)
1068 (defvar gnus-newsgroup-adaptive-score-file nil)
1069 (defvar gnus-current-score-file nil)
1070 (defvar gnus-current-move-group nil)
1071 (defvar gnus-current-copy-group nil)
1072 (defvar gnus-current-crosspost-group nil)