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

   1 ;;; gnus-sum.el --- summary mode commands for Gnus
   2
   3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 ;; For Emacs < 22.2.
  29 (eval-and-compile
  30   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
  31 (eval-when-compile
  32   (require 'cl))
  33 (eval-when-compile
  34   (when (featurep 'xemacs)
  35     (require 'easy-mmode))) ; for `define-minor-mode'
  36
  37 (defvar tool-bar-mode)
  38 (defvar gnus-tmp-header)
  39
  40 (require 'gnus)
  41 (require 'gnus-group)
  42 (require 'gnus-spec)
  43 (require 'gnus-range)
  44 (require 'gnus-int)
  45 (require 'gnus-undo)
  46 (require 'gnus-util)
  47 (require 'gmm-utils)
  48 (require 'mm-decode)
  49 (require 'nnoo)
  50
  51 (autoload 'gnus-summary-limit-include-cached "gnus-cache" nil t)
  52 (autoload 'gnus-cache-write-active "gnus-cache")
  53 (autoload 'gnus-mailing-list-insinuate "gnus-ml" nil t)
  54 (autoload 'turn-on-gnus-mailing-list-mode "gnus-ml" nil t)
  55 (autoload 'gnus-pick-line-number "gnus-salt" nil t)
  56 (autoload 'mm-uu-dissect "mm-uu")
  57 (autoload 'gnus-article-outlook-deuglify-article "deuglify"
  58   "Deuglify broken Outlook (Express) articles and redisplay."
  59   t)
  60 (autoload 'gnus-article-outlook-unwrap-lines "deuglify" nil t)
  61 (autoload 'gnus-article-outlook-repair-attribution "deuglify" nil t)
  62 (autoload 'gnus-article-outlook-rearrange-citation "deuglify" nil t)
  63
  64 (defcustom gnus-kill-summary-on-exit t
  65   "*If non-nil, kill the summary buffer when you exit from it.
  66 If nil, the summary will become a \"*Dead Summary*\" buffer, and
  67 it will be killed sometime later."
  68   :group 'gnus-summary-exit
  69   :type 'boolean)
  70
  71 (defcustom gnus-summary-next-group-on-exit t
  72   "If non-nil, go to the next unread newsgroup on summary exit.
  73 See `gnus-group-goto-unread'."
  74   :link '(custom-manual "(gnus)Group Maneuvering")
  75   :group 'gnus-summary-exit
  76   :version "23.1" ;; No Gnus
  77   :type 'boolean)
  78
  79 (defcustom gnus-summary-stop-at-end-of-message nil
  80   "If non-nil, don't select the next message when using `SPC'."
  81   :link '(custom-manual "(gnus)Group Maneuvering")
  82   :group 'gnus-summary-maneuvering
  83   :version "24.1"
  84   :type 'boolean)
  85
  86 (defcustom gnus-fetch-old-headers nil
  87   "*Non-nil means that Gnus will try to build threads by grabbing old headers.
  88 If an unread article in the group refers to an older, already
  89 read (or just marked as read) article, the old article will not
  90 normally be displayed in the Summary buffer.  If this variable is
  91 t, Gnus will attempt to grab the headers to the old articles, and
  92 thereby build complete threads.  If it has the value `some', all
  93 old headers will be fetched but only enough headers to connect
  94 otherwise loose threads will be displayed.  This variable can
  95 also be a number.  In that case, no more than that number of old
  96 headers will be fetched.  If it has the value `invisible', all
  97 old headers will be fetched, but none will be displayed.
  98
  99 The server has to support NOV for any of this to work.
 100
 101 This feature can seriously impact performance it ignores all
 102 locally cached header entries.  Setting it to t for groups for a
 103 server that doesn't expire articles (such as news.gmane.org),
 104 leads to very slow summary generation."
 105   :group 'gnus-thread
 106   :type '(choice (const :tag "off" nil)
 107                  (const :tag "on" t)
 108                  (const some)
 109                  (const invisible)
 110                  number
 111                  (sexp :menu-tag "other" t)))
 112
 113 (defcustom gnus-refer-thread-limit 500
 114   "*The number of old headers to fetch when doing \\<gnus-summary-mode-map>\\[gnus-summary-refer-thread].
 115 If t, fetch all the available old headers."
 116   :group 'gnus-thread
 117   :type '(choice number
 118                  (sexp :menu-tag "other" t)))
 119
 120 (defcustom gnus-summary-make-false-root 'adopt
 121   "*nil means that Gnus won't gather loose threads.
 122 If the root of a thread has expired or been read in a previous
 123 session, the information necessary to build a complete thread has been
 124 lost.  Instead of having many small sub-threads from this original thread
 125 scattered all over the summary buffer, Gnus can gather them.
 126
 127 If non-nil, Gnus will try to gather all loose sub-threads from an
 128 original thread into one large thread.
 129
 130 If this variable is non-nil, it should be one of `none', `adopt',
 131 `dummy' or `empty'.
 132
 133 If this variable is `none', Gnus will not make a false root, but just
 134 present the sub-threads after another.
 135 If this variable is `dummy', Gnus will create a dummy root that will
 136 have all the sub-threads as children.
 137 If this variable is `adopt', Gnus will make one of the \"children\"
 138 the parent and mark all the step-children as such.
 139 If this variable is `empty', the \"children\" are printed with empty
 140 subject fields.  (Or rather, they will be printed with a string
 141 given by the `gnus-summary-same-subject' variable.)"
 142   :group 'gnus-thread
 143   :type '(choice (const :tag "off" nil)
 144                  (const none)
 145                  (const dummy)
 146                  (const adopt)
 147                  (const empty)))
 148
 149 (defcustom gnus-summary-make-false-root-always nil
 150   "Always make a false dummy root."
 151   :version "22.1"
 152   :group 'gnus-thread
 153   :type 'boolean)
 154
 155 (defcustom gnus-summary-gather-exclude-subject "^ *$\\|^(none)$"
 156   "*A regexp to match subjects to be excluded from loose thread gathering.
 157 As loose thread gathering is done on subjects only, that means that
 158 there can be many false gatherings performed.  By rooting out certain
 159 common subjects, gathering might become saner."
 160   :group 'gnus-thread
 161   :type 'regexp)
 162
 163 (defcustom gnus-summary-gather-subject-limit nil
 164   "*Maximum length of subject comparisons when gathering loose threads.
 165 Use nil to compare full subjects.  Setting this variable to a low
 166 number will help gather threads that have been corrupted by
 167 newsreaders chopping off subject lines, but it might also mean that
 168 unrelated articles that have subject that happen to begin with the
 169 same few characters will be incorrectly gathered.
 170
 171 If this variable is `fuzzy', Gnus will use a fuzzy algorithm when
 172 comparing subjects."
 173   :group 'gnus-thread
 174   :type '(choice (const :tag "off" nil)
 175                  (const fuzzy)
 176                  (sexp :menu-tag "on" t)))
 177
 178 (defcustom gnus-simplify-subject-functions nil
 179   "List of functions taking a string argument that simplify subjects.
 180 The functions are applied recursively.
 181
 182 Useful functions to put in this list include:
 183 `gnus-simplify-subject-re', `gnus-simplify-subject-fuzzy',
 184 `gnus-simplify-whitespace', and `gnus-simplify-all-whitespace'."
 185   :group 'gnus-thread
 186   :type '(repeat function))
 187
 188 (defcustom gnus-simplify-ignored-prefixes nil
 189   "*Remove matches for this regexp from subject lines when simplifying fuzzily."
 190   :group 'gnus-thread
 191   :type '(choice (const :tag "off" nil)
 192                  regexp))
 193
 194 (defcustom gnus-build-sparse-threads nil
 195   "*If non-nil, fill in the gaps in threads.
 196 If `some', only fill in the gaps that are needed to tie loose threads
 197 together.  If `more', fill in all leaf nodes that Gnus can find.  If
 198 non-nil and non-`some', fill in all gaps that Gnus manages to guess."
 199   :group 'gnus-thread
 200   :type '(choice (const :tag "off" nil)
 201                  (const some)
 202                  (const more)
 203                  (sexp :menu-tag "all" t)))
 204
 205 (defcustom gnus-summary-thread-gathering-function
 206   'gnus-gather-threads-by-subject
 207   "*Function used for gathering loose threads.
 208 There are two pre-defined functions: `gnus-gather-threads-by-subject',
 209 which only takes Subjects into consideration; and
 210 `gnus-gather-threads-by-references', which compared the References
 211 headers of the articles to find matches."
 212   :group 'gnus-thread
 213   :type '(radio (function-item gnus-gather-threads-by-subject)
 214                 (function-item gnus-gather-threads-by-references)
 215                 (function :tag "other")))
 216
 217 (defcustom gnus-summary-same-subject ""
 218   "*String indicating that the current article has the same subject as the previous.
 219 This variable will only be used if the value of
 220 `gnus-summary-make-false-root' is `empty'."
 221   :group 'gnus-summary-format
 222   :type 'string)
 223
 224 (defcustom gnus-summary-goto-unread nil
 225   "*If t, many commands will go to the next unread article.
 226 This applies to marking commands as well as other commands that
 227 \"naturally\" select the next article, like, for instance, `SPC' at
 228 the end of an article.
 229
 230 If nil, the marking commands do NOT go to the next unread article
 231 \(they go to the next article instead).  If `never', commands that
 232 usually go to the next unread article, will go to the next article,
 233 whether it is read or not."
 234   :version "24.1"
 235   :group 'gnus-summary-marks
 236   :link '(custom-manual "(gnus)Setting Marks")
 237   :type '(choice (const :tag "off" nil)
 238                  (const never)
 239                  (sexp :menu-tag "on" t)))
 240
 241 (defcustom gnus-summary-default-score 0
 242   "*Default article score level.
 243 All scores generated by the score files will be added to this score.
 244 If this variable is nil, scoring will be disabled."
 245   :group 'gnus-score-default
 246   :type '(choice (const :tag "disable")
 247                  integer))
 248
 249 (defcustom gnus-summary-default-high-score 0
 250   "*Default threshold for a high scored article.
 251 An article will be highlighted as high scored if its score is greater
 252 than this score."
 253   :version "22.1"
 254   :group 'gnus-score-default
 255   :type 'integer)
 256
 257 (defcustom gnus-summary-default-low-score 0
 258   "*Default threshold for a low scored article.
 259 An article will be highlighted as low scored if its score is smaller
 260 than this score."
 261   :version "22.1"
 262   :group 'gnus-score-default
 263   :type 'integer)
 264
 265 (defcustom gnus-summary-zcore-fuzz 0
 266   "*Fuzziness factor for the zcore in the summary buffer.
 267 Articles with scores closer than this to `gnus-summary-default-score'
 268 will not be marked."
 269   :group 'gnus-summary-format
 270   :type 'integer)
 271
 272 (defcustom gnus-simplify-subject-fuzzy-regexp nil
 273   "*Strings to be removed when doing fuzzy matches.
 274 This can either be a regular expression or list of regular expressions
 275 that will be removed from subject strings if fuzzy subject
 276 simplification is selected."
 277   :group 'gnus-thread
 278   :type '(repeat regexp))
 279
 280 (defcustom gnus-show-threads t
 281   "*If non-nil, display threads in summary mode."
 282   :group 'gnus-thread
 283   :type 'boolean)
 284
 285 (defcustom gnus-thread-hide-subtree nil
 286   "*If non-nil, hide all threads initially.
 287 This can be a predicate specifier which says which threads to hide.
 288 If threads are hidden, you have to run the command
 289 `gnus-summary-show-thread' by hand or select an article."
 290   :group 'gnus-thread
 291   :type '(radio (sexp :format "Non-nil\n"
 292                       :match (lambda (widget value)
 293                                (not (or (consp value) (functionp value))))
 294                       :value t)
 295                 (const nil)
 296                 (sexp :tag "Predicate specifier")))
 297
 298 (defcustom gnus-thread-hide-killed t
 299   "*If non-nil, hide killed threads automatically."
 300   :group 'gnus-thread
 301   :type 'boolean)
 302
 303 (defcustom gnus-thread-ignore-subject t
 304   "*If non-nil, which is the default, ignore subjects and do all threading based on the Reference header.
 305 If nil, articles that have different subjects from their parents will
 306 start separate threads."
 307   :group 'gnus-thread
 308   :type 'boolean)
 309
 310 (defcustom gnus-thread-operation-ignore-subject t
 311   "*If non-nil, subjects will be ignored when doing thread commands.
 312 This affects commands like `gnus-summary-kill-thread' and
 313 `gnus-summary-lower-thread'.
 314
 315 If this variable is nil, articles in the same thread with different
 316 subjects will not be included in the operation in question.  If this
 317 variable is `fuzzy', only articles that have subjects that are fuzzily
 318 equal will be included."
 319   :group 'gnus-thread
 320   :type '(choice (const :tag "off" nil)
 321                  (const fuzzy)
 322                  (sexp :tag "on" t)))
 323
 324 (defcustom gnus-thread-indent-level 4
 325   "*Number that says how much each sub-thread should be indented."
 326   :group 'gnus-thread
 327   :type 'integer)
 328
 329 (defcustom gnus-auto-extend-newsgroup t
 330   "*If non-nil, extend newsgroup forward and backward when requested."
 331   :group 'gnus-summary-choose
 332   :type 'boolean)
 333
 334 (defcustom gnus-auto-select-first t
 335   "If non-nil, select an article on group entry.
 336 An article is selected automatically when entering a group
 337 e.g. with \\<gnus-group-mode-map>\\[gnus-group-read-group], or via `gnus-summary-next-page' or
 338 `gnus-summary-catchup-and-goto-next-group'.
 339
 340 Which article is selected is controlled by the variable
 341 `gnus-auto-select-subject'.
 342
 343 If you want to prevent automatic selection of articles in some
 344 newsgroups, set the variable to nil in `gnus-select-group-hook'."
 345   ;; Commands include...
 346   ;; \\<gnus-group-mode-map>\\[gnus-group-read-group]
 347   ;; \\<gnus-summary-mode-map>\\[gnus-summary-next-page]
 348   ;; \\<gnus-summary-mode-map>\\[gnus-summary-catchup-and-goto-next-group]
 349   :group 'gnus-group-select
 350   :type '(choice (const :tag "none" nil)
 351                  (sexp :menu-tag "first" t)))
 352
 353 (defcustom gnus-auto-select-subject 'unseen-or-unread
 354   "*Says what subject to place under point when entering a group.
 355
 356 This variable can either be the symbols `first' (place point on the
 357 first subject), `unread' (place point on the subject line of the first
 358 unread article), `best' (place point on the subject line of the
 359 higest-scored article), `unseen' (place point on the subject line of
 360 the first unseen article), `unseen-or-unread' (place point on the subject
 361 line of the first unseen article or, if all article have been seen, on the
 362 subject line of the first unread article), or a function to be called to
 363 place point on some subject line."
 364   :version "24.1"
 365   :group 'gnus-group-select
 366   :type '(choice (const best)
 367                  (const unread)
 368                  (const first)
 369                  (const unseen)
 370                  (const unseen-or-unread)))
 371
 372 (defcustom gnus-auto-select-next t
 373   "*If non-nil, offer to go to the next group from the end of the previous.
 374 If the value is t and the next newsgroup is empty, Gnus will exit
 375 summary mode and go back to group mode.  If the value is neither nil
 376 nor t, Gnus will select the following unread newsgroup.  In
 377 particular, if the value is the symbol `quietly', the next unread
 378 newsgroup will be selected without any confirmation, and if it is
 379 `almost-quietly', the next group will be selected without any
 380 confirmation if you are located on the last article in the group.
 381 Finally, if this variable is `slightly-quietly', the `\\<gnus-summary-mode-map>\\[gnus-summary-catchup-and-goto-next-group]' command
 382 will go to the next group without confirmation."
 383   :group 'gnus-summary-maneuvering
 384   :type '(choice (const :tag "off" nil)
 385                  (const quietly)
 386                  (const almost-quietly)
 387                  (const slightly-quietly)
 388                  (sexp :menu-tag "on" t)))
 389
 390 (defcustom gnus-auto-select-same nil
 391   "*If non-nil, select the next article with the same subject.
 392 If there are no more articles with the same subject, go to
 393 the first unread article."
 394   :group 'gnus-summary-maneuvering
 395   :type 'boolean)
 396
 397 (defcustom gnus-auto-select-on-ephemeral-exit 'next-noselect
 398   "What article should be selected after exiting an ephemeral group.
 399 Valid values include:
 400
 401 `next'
 402   Select the next article.
 403 `next-unread'
 404   Select the next unread article.
 405 `next-noselect'
 406   Move the cursor to the next article.  This is the default.
 407 `next-unread-noselect'
 408   Move the cursor to the next unread article.
 409
 410 If it has any other value or there is no next (unread) article, the
 411 article selected before entering to the ephemeral group will appear."
 412   :version "23.1" ;; No Gnus
 413   :group 'gnus-summary-maneuvering
 414   :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
 415                  (const next) (const next-unread)
 416                  (const next-noselect) (const next-unread-noselect)
 417                  (sexp :tag "other" :value nil)))
 418
 419 (defcustom gnus-auto-goto-ignores 'unfetched
 420   "*Says how to handle unfetched articles when maneuvering.
 421
 422 This variable can either be the symbols nil (maneuver to any
 423 article), `undownloaded' (maneuvering while unplugged ignores articles
 424 that have not been fetched), `always-undownloaded' (maneuvering always
 425 ignores articles that have not been fetched), `unfetched' (maneuvering
 426 ignores articles whose headers have not been fetched).
 427
 428 NOTE: The list of unfetched articles will always be nil when plugged
 429 and, when unplugged, a subset of the undownloaded article list."
 430   :version "22.1"
 431   :group 'gnus-summary-maneuvering
 432   :type '(choice (const :tag "None" nil)
 433                  (const :tag "Undownloaded when unplugged" undownloaded)
 434                  (const :tag "Undownloaded" always-undownloaded)
 435                  (const :tag "Unfetched" unfetched)))
 436
 437 (defcustom gnus-summary-check-current nil
 438   "*If non-nil, consider the current article when moving.
 439 The \"unread\" movement commands will stay on the same line if the
 440 current article is unread."
 441   :group 'gnus-summary-maneuvering
 442   :type 'boolean)
 443
 444 (defcustom gnus-auto-center-summary 2
 445   "*If non-nil, always center the current summary buffer.
 446 In particular, if `vertical' do only vertical recentering.  If non-nil
 447 and non-`vertical', do both horizontal and vertical recentering."
 448   :group 'gnus-summary-maneuvering
 449   :type '(choice (const :tag "none" nil)
 450                  (const vertical)
 451                  (integer :tag "height")
 452                  (sexp :menu-tag "both" t)))
 453
 454 (defcustom gnus-auto-center-group t
 455   "If non-nil, always center the group buffer."
 456   :group 'gnus-summary-maneuvering
 457   :type 'boolean)
 458
 459 (defcustom gnus-show-all-headers nil
 460   "*If non-nil, don't hide any headers."
 461   :group 'gnus-article-hiding
 462   :group 'gnus-article-headers
 463   :type 'boolean)
 464
 465 (defcustom gnus-summary-ignore-duplicates nil
 466   "*If non-nil, ignore articles with identical Message-ID headers."
 467   :group 'gnus-summary
 468   :type 'boolean)
 469
 470 (defcustom gnus-single-article-buffer nil
 471   "*If non-nil, display all articles in the same buffer.
 472 If nil, each group will get its own article buffer."
 473   :version "24.1"
 474   :group 'gnus-article-various
 475   :type 'boolean)
 476
 477 (defcustom gnus-widen-article-window nil
 478   "If non-nil, selecting the article buffer will display only the article buffer."
 479   :version "24.1"
 480   :group 'gnus-article-various
 481   :type 'boolean)
 482
 483 (defcustom gnus-break-pages t
 484   "*If non-nil, do page breaking on articles.
 485 The page delimiter is specified by the `gnus-page-delimiter'
 486 variable."
 487   :group 'gnus-article-various
 488   :type 'boolean)
 489
 490 (defcustom gnus-move-split-methods nil
 491   "*Variable used to suggest where articles are to be moved to.
 492 It uses the same syntax as the `gnus-split-methods' variable.
 493 However, whereas `gnus-split-methods' specifies file names as targets,
 494 this variable specifies group names."
 495   :group 'gnus-summary-mail
 496   :type '(repeat (choice (list :value (fun) function)
 497                          (cons :value ("" "") regexp (repeat string))
 498                          (sexp :value nil))))
 499
 500 (defcustom gnus-move-group-prefix-function 'gnus-group-real-prefix
 501   "Function used to compute default prefix for article move/copy/etc prompts.
 502 The function should take one argument, a group name, and return a
 503 string with the suggested prefix."
 504   :group 'gnus-summary-mail
 505   :type 'function)
 506
 507 ;; FIXME: Although the custom type is `character' for the following variables,
 508 ;; using multibyte characters (Latin-1, UTF-8) doesn't work.  -- rs
 509
 510 (defcustom gnus-unread-mark ?           ;Whitespace
 511   "*Mark used for unread articles."
 512   :group 'gnus-summary-marks
 513   :type 'character)
 514
 515 (defcustom gnus-ticked-mark ?!
 516   "*Mark used for ticked articles."
 517   :group 'gnus-summary-marks
 518   :type 'character)
 519
 520 (defcustom gnus-dormant-mark ??
 521   "*Mark used for dormant articles."
 522   :group 'gnus-summary-marks
 523   :type 'character)
 524
 525 (defcustom gnus-del-mark ?r
 526   "*Mark used for del'd articles."
 527   :group 'gnus-summary-marks
 528   :type 'character)
 529
 530 (defcustom gnus-read-mark ?R
 531   "*Mark used for read articles."
 532   :group 'gnus-summary-marks
 533   :type 'character)
 534
 535 (defcustom gnus-expirable-mark ?E
 536   "*Mark used for expirable articles."
 537   :group 'gnus-summary-marks
 538   :type 'character)
 539
 540 (defcustom gnus-killed-mark ?K
 541   "*Mark used for killed articles."
 542   :group 'gnus-summary-marks
 543   :type 'character)
 544
 545 (defcustom gnus-spam-mark ?$
 546   "*Mark used for spam articles."
 547   :version "22.1"
 548   :group 'gnus-summary-marks
 549   :type 'character)
 550
 551 (defcustom gnus-kill-file-mark ?X
 552   "*Mark used for articles killed by kill files."
 553   :group 'gnus-summary-marks
 554   :type 'character)
 555
 556 (defcustom gnus-low-score-mark ?Y
 557   "*Mark used for articles with a low score."
 558   :group 'gnus-summary-marks
 559   :type 'character)
 560
 561 (defcustom gnus-catchup-mark ?C
 562   "*Mark used for articles that are caught up."
 563   :group 'gnus-summary-marks
 564   :type 'character)
 565
 566 (defcustom gnus-replied-mark ?A
 567   "*Mark used for articles that have been replied to."
 568   :group 'gnus-summary-marks
 569   :type 'character)
 570
 571 (defcustom gnus-forwarded-mark ?F
 572   "*Mark used for articles that have been forwarded."
 573   :version "22.1"
 574   :group 'gnus-summary-marks
 575   :type 'character)
 576
 577 (defcustom gnus-recent-mark ?N
 578   "*Mark used for articles that are recent."
 579   :version "22.1"
 580   :group 'gnus-summary-marks
 581   :type 'character)
 582
 583 (defcustom gnus-cached-mark ?*
 584   "*Mark used for articles that are in the cache."
 585   :group 'gnus-summary-marks
 586   :type 'character)
 587
 588 (defcustom gnus-saved-mark ?S
 589   "*Mark used for articles that have been saved."
 590   :group 'gnus-summary-marks
 591   :type 'character)
 592
 593 (defcustom gnus-unseen-mark ?.
 594   "*Mark used for articles that haven't been seen."
 595   :version "22.1"
 596   :group 'gnus-summary-marks
 597   :type 'character)
 598
 599 (defcustom gnus-no-mark ?               ;Whitespace
 600   "*Mark used for articles that have no other secondary mark."
 601   :version "22.1"
 602   :group 'gnus-summary-marks
 603   :type 'character)
 604
 605 (defcustom gnus-ancient-mark ?O
 606   "*Mark used for ancient articles."
 607   :group 'gnus-summary-marks
 608   :type 'character)
 609
 610 (defcustom gnus-sparse-mark ?Q
 611   "*Mark used for sparsely reffed articles."
 612   :group 'gnus-summary-marks
 613   :type 'character)
 614
 615 (defcustom gnus-canceled-mark ?G
 616   "*Mark used for canceled articles."
 617   :group 'gnus-summary-marks
 618   :type 'character)
 619
 620 (defcustom gnus-duplicate-mark ?M
 621   "*Mark used for duplicate articles."
 622   :group 'gnus-summary-marks
 623   :type 'character)
 624
 625 (defcustom gnus-undownloaded-mark ?-
 626   "*Mark used for articles that weren't downloaded."
 627   :version "22.1"
 628   :group 'gnus-summary-marks
 629   :type 'character)
 630
 631 (defcustom gnus-downloaded-mark ?+
 632   "*Mark used for articles that were downloaded."
 633   :group 'gnus-summary-marks
 634   :type 'character)
 635
 636 (defcustom gnus-downloadable-mark ?%
 637   "*Mark used for articles that are to be downloaded."
 638   :group 'gnus-summary-marks
 639   :type 'character)
 640
 641 (defcustom gnus-unsendable-mark ?=
 642   "*Mark used for articles that won't be sent."
 643   :group 'gnus-summary-marks
 644   :type 'character)
 645
 646 (defcustom gnus-score-over-mark ?+
 647   "*Score mark used for articles with high scores."
 648   :group 'gnus-summary-marks
 649   :type 'character)
 650
 651 (defcustom gnus-score-below-mark ?-
 652   "*Score mark used for articles with low scores."
 653   :group 'gnus-summary-marks
 654   :type 'character)
 655
 656 (defcustom gnus-empty-thread-mark ?     ;Whitespace
 657   "*There is no thread under the article."
 658   :group 'gnus-summary-marks
 659   :type 'character)
 660
 661 (defcustom gnus-not-empty-thread-mark ?=
 662   "*There is a thread under the article."
 663   :group 'gnus-summary-marks
 664   :type 'character)
 665
 666 (defcustom gnus-view-pseudo-asynchronously nil
 667   "*If non-nil, Gnus will view pseudo-articles asynchronously."
 668   :group 'gnus-extract-view
 669   :type 'boolean)
 670
 671 (defcustom gnus-auto-expirable-marks
 672   (list gnus-killed-mark gnus-del-mark gnus-catchup-mark
 673         gnus-low-score-mark gnus-ancient-mark gnus-read-mark
 674         gnus-duplicate-mark)
 675   "*The list of marks converted into expiration if a group is auto-expirable."
 676   :version "24.1"
 677   :group 'gnus-summary
 678   :type '(repeat character))
 679
 680 (defcustom gnus-inhibit-user-auto-expire t
 681   "*If non-nil, user marking commands will not mark an article as expirable, even if the group has auto-expire turned on."
 682   :version "21.1"
 683   :group 'gnus-summary
 684   :type 'boolean)
 685
 686 (defcustom gnus-mark-copied-or-moved-articles-as-expirable nil
 687   "If non-nil, mark articles copied or moved to auto-expire group as expirable.
 688 If nil, the expirable marks will be unchanged except that the marks
 689 will be removed when copying or moving articles to a group that has
 690 not turned auto-expire on.  If non-nil, articles that have been read
 691 will be marked as expirable when being copied or moved to a group in
 692 which auto-expire is turned on."
 693   :version "23.2"
 694   :type 'boolean
 695   :group 'gnus-summary-marks)
 696
 697 (defcustom gnus-view-pseudos nil
 698   "*If `automatic', pseudo-articles will be viewed automatically.
 699 If `not-confirm', pseudos will be viewed automatically, and the user
 700 will not be asked to confirm the command."
 701   :group 'gnus-extract-view
 702   :type '(choice (const :tag "off" nil)
 703                  (const automatic)
 704                  (const not-confirm)))
 705
 706 (defcustom gnus-view-pseudos-separately t
 707   "*If non-nil, one pseudo-article will be created for each file to be viewed.
 708 If nil, all files that use the same viewing command will be given as a
 709 list of parameters to that command."
 710   :group 'gnus-extract-view
 711   :type 'boolean)
 712
 713 (defcustom gnus-insert-pseudo-articles t
 714   "*If non-nil, insert pseudo-articles when decoding articles."
 715   :group 'gnus-extract-view
 716   :type 'boolean)
 717
 718 (defcustom gnus-summary-dummy-line-format
 719   "   %(:                             :%) %S\n"
 720   "*The format specification for the dummy roots in the summary buffer.
 721 It works along the same lines as a normal formatting string,
 722 with some simple extensions.
 723
 724 %S  The subject
 725
 726 General format specifiers can also be used.
 727 See `(gnus)Formatting Variables'."
 728   :link '(custom-manual "(gnus)Formatting Variables")
 729   :group 'gnus-threading
 730   :type 'string)
 731
 732 (defcustom gnus-summary-mode-line-format "Gnus: %g [%A] %Z"
 733   "*The format specification for the summary mode line.
 734 It works along the same lines as a normal formatting string,
 735 with some simple extensions:
 736
 737 %G  Group name
 738 %p  Unprefixed group name
 739 %A  Current article number
 740 %z  Current article score
 741 %V  Gnus version
 742 %U  Number of unread articles in the group
 743 %e  Number of unselected articles in the group
 744 %Z  A string with unread/unselected article counts
 745 %g  Shortish group name
 746 %S  Subject of the current article
 747 %u  User-defined spec
 748 %s  Current score file name
 749 %d  Number of dormant articles
 750 %r  Number of articles that have been marked as read in this session
 751 %E  Number of articles expunged by the score files"
 752   :group 'gnus-summary-format
 753   :type 'string)
 754
 755 (defcustom gnus-list-identifiers nil
 756   "Regexp that matches list identifiers to be removed from subject.
 757 This can also be a list of regexps."
 758   :version "21.1"
 759   :group 'gnus-summary-format
 760   :group 'gnus-article-hiding
 761   :type '(choice (const :tag "none" nil)
 762                  (regexp :value ".*")
 763                  (repeat :value (".*") regexp)))
 764
 765 (defcustom gnus-summary-mark-below 0
 766   "*Mark all articles with a score below this variable as read.
 767 This variable is local to each summary buffer and usually set by the
 768 score file."
 769   :group 'gnus-score-default
 770   :type 'integer)
 771
 772 (defun gnus-widget-reversible-match (widget value)
 773   "Ignoring WIDGET, convert VALUE to internal form.
 774 VALUE should have the form `FOO' or `(not FOO)', where FOO is an symbol."
 775   ;; (debug value)
 776   (or (symbolp value)
 777       (and (listp value)
 778            (eq (length value) 2)
 779            (eq (nth 0 value) 'not)
 780            (symbolp (nth 1 value)))))
 781
 782 (defun gnus-widget-reversible-to-internal (widget value)
 783   "Ignoring WIDGET, convert VALUE to internal form.
 784 VALUE should have the form `FOO' or `(not FOO)', where FOO is an atom.
 785 FOO is converted to (FOO nil) and (not FOO) is converted to (FOO t)."
 786   ;; (debug value)
 787   (if (atom value)
 788       (list value nil)
 789     (list (nth 1 value) t)))
 790
 791 (defun gnus-widget-reversible-to-external (widget value)
 792   "Ignoring WIDGET, convert VALUE to external form.
 793 VALUE should have the form `(FOO nil)' or `(FOO t)', where FOO is an atom.
 794 \(FOO  nil) is converted to FOO and (FOO t) is converted to (not FOO)."
 795   ;; (debug value)
 796   (if (nth 1 value)
 797       (list 'not (nth 0 value))
 798     (nth 0 value)))
 799
 800 (define-widget 'gnus-widget-reversible 'group
 801   "A `group' that convert values."
 802   :match 'gnus-widget-reversible-match
 803   :value-to-internal 'gnus-widget-reversible-to-internal
 804   :value-to-external 'gnus-widget-reversible-to-external)
 805
 806 (defcustom gnus-article-sort-functions '(gnus-article-sort-by-number)
 807   "*List of functions used for sorting articles in the summary buffer.
 808
 809 Each function takes two articles and returns non-nil if the first
 810 article should be sorted before the other.  If you use more than one
 811 function, the primary sort function should be the last.  You should
 812 probably always include `gnus-article-sort-by-number' in the list of
 813 sorting functions -- preferably first.  Also note that sorting by date
 814 is often much slower than sorting by number, and the sorting order is
 815 very similar.  (Sorting by date means sorting by the time the message
 816 was sent, sorting by number means sorting by arrival time.)
 817
 818 Each item can also be a list `(not F)' where F is a function;
 819 this reverses the sort order.
 820
 821 Ready-made functions include `gnus-article-sort-by-number',
 822 `gnus-article-sort-by-author', `gnus-article-sort-by-subject',
 823 `gnus-article-sort-by-date', `gnus-article-sort-by-random'
 824 and `gnus-article-sort-by-score'.
 825
 826 When threading is turned on, the variable `gnus-thread-sort-functions'
 827 controls how articles are sorted."
 828   :group 'gnus-summary-sort
 829   :type '(repeat (gnus-widget-reversible
 830                   (choice (function-item gnus-article-sort-by-number)
 831                           (function-item gnus-article-sort-by-author)
 832                           (function-item gnus-article-sort-by-subject)
 833                           (function-item gnus-article-sort-by-date)
 834                           (function-item gnus-article-sort-by-score)
 835                           (function-item gnus-article-sort-by-random)
 836                           (function :tag "other"))
 837                   (boolean :tag "Reverse order"))))
 838
 839
 840 (defcustom gnus-thread-sort-functions '(gnus-thread-sort-by-number)
 841   "*List of functions used for sorting threads in the summary buffer.
 842 By default, threads are sorted by article number.
 843
 844 Each function takes two threads and returns non-nil if the first
 845 thread should be sorted before the other.  If you use more than one
 846 function, the primary sort function should be the last.  You should
 847 probably always include `gnus-thread-sort-by-number' in the list of
 848 sorting functions -- preferably first.  Also note that sorting by date
 849 is often much slower than sorting by number, and the sorting order is
 850 very similar.  (Sorting by date means sorting by the time the message
 851 was sent, sorting by number means sorting by arrival time.)
 852
 853 Each list item can also be a list `(not F)' where F is a
 854 function; this specifies reversed sort order.
 855
 856 Ready-made functions include `gnus-thread-sort-by-number',
 857 `gnus-thread-sort-by-author', `gnus-thread-sort-by-recipient'
 858 `gnus-thread-sort-by-subject', `gnus-thread-sort-by-date',
 859 `gnus-thread-sort-by-score', `gnus-thread-sort-by-most-recent-number',
 860 `gnus-thread-sort-by-most-recent-date', `gnus-thread-sort-by-random',
 861 and `gnus-thread-sort-by-total-score' (see
 862 `gnus-thread-score-function').
 863
 864 When threading is turned off, the variable
 865 `gnus-article-sort-functions' controls how articles are sorted."
 866   :group 'gnus-summary-sort
 867   :type '(repeat
 868           (gnus-widget-reversible
 869            (choice (function-item gnus-thread-sort-by-number)
 870                    (function-item gnus-thread-sort-by-author)
 871                    (function-item gnus-thread-sort-by-recipient)
 872                    (function-item gnus-thread-sort-by-subject)
 873                    (function-item gnus-thread-sort-by-date)
 874                    (function-item gnus-thread-sort-by-score)
 875                    (function-item gnus-thread-sort-by-most-recent-number)
 876                    (function-item gnus-thread-sort-by-most-recent-date)
 877                    (function-item gnus-thread-sort-by-random)
 878                    (function-item gnus-thread-sort-by-total-score)
 879                    (function :tag "other"))
 880            (boolean :tag "Reverse order"))))
 881
 882 (defcustom gnus-thread-score-function '+
 883   "*Function used for calculating the total score of a thread.
 884
 885 The function is called with the scores of the article and each
 886 subthread and should then return the score of the thread.
 887
 888 Some functions you can use are `+', `max', or `min'."
 889   :group 'gnus-summary-sort
 890   :type 'function)
 891
 892 (defcustom gnus-summary-expunge-below nil
 893   "All articles that have a score less than this variable will be expunged.
 894 This variable is local to the summary buffers."
 895   :group 'gnus-score-default
 896   :type '(choice (const :tag "off" nil)
 897                  integer))
 898
 899 (defcustom gnus-thread-expunge-below nil
 900   "All threads that have a total score less than this variable will be expunged.
 901 See `gnus-thread-score-function' for en explanation of what a
 902 \"thread score\" is.
 903
 904 This variable is local to the summary buffers."
 905   :group 'gnus-threading
 906   :group 'gnus-score-default
 907   :type '(choice (const :tag "off" nil)
 908                  integer))
 909
 910 (defcustom gnus-summary-mode-hook nil
 911   "*A hook for Gnus summary mode.
 912 This hook is run before any variables are set in the summary buffer."
 913   :options '(turn-on-gnus-mailing-list-mode gnus-pick-mode)
 914   :group 'gnus-summary-various
 915   :type 'hook)
 916
 917 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
 918 (when (featurep 'xemacs)
 919   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-summary-menu-add)
 920   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-setup-summary-toolbar)
 921   (add-hook 'gnus-summary-mode-hook
 922             'gnus-xmas-switch-horizontal-scrollbar-off))
 923
 924 (defcustom gnus-summary-menu-hook nil
 925   "*Hook run after the creation of the summary mode menu."
 926   :group 'gnus-summary-visual
 927   :type 'hook)
 928
 929 (defcustom gnus-summary-exit-hook nil
 930   "*A hook called on exit from the summary buffer.
 931 It will be called with point in the group buffer."
 932   :group 'gnus-summary-exit
 933   :type 'hook)
 934
 935 (defcustom gnus-summary-prepare-hook nil
 936   "*A hook called after the summary buffer has been generated.
 937 If you want to modify the summary buffer, you can use this hook."
 938   :group 'gnus-summary-various
 939   :type 'hook)
 940
 941 (defcustom gnus-summary-prepared-hook nil
 942   "*A hook called as the last thing after the summary buffer has been generated."
 943   :group 'gnus-summary-various
 944   :type 'hook)
 945
 946 (defcustom gnus-summary-generate-hook nil
 947   "*A hook run just before generating the summary buffer.
 948 This hook is commonly used to customize threading variables and the
 949 like."
 950   :group 'gnus-summary-various
 951   :type 'hook)
 952
 953 (defcustom gnus-select-group-hook nil
 954   "*A hook called when a newsgroup is selected.
 955
 956 If you'd like to simplify subjects like the
 957 `gnus-summary-next-same-subject' command does, you can use the
 958 following hook:
 959
 960  (add-hook gnus-select-group-hook
 961            (lambda ()
 962              (mapcar (lambda (header)
 963                        (mail-header-set-subject
 964                         header
 965                         (gnus-simplify-subject
 966                          (mail-header-subject header) 're-only)))
 967                      gnus-newsgroup-headers)))"
 968   :group 'gnus-group-select
 969   :type 'hook)
 970
 971 (defcustom gnus-select-article-hook nil
 972   "*A hook called when an article is selected."
 973   :group 'gnus-summary-choose
 974   :options '(gnus-agent-fetch-selected-article)
 975   :type 'hook)
 976
 977 (defcustom gnus-visual-mark-article-hook
 978   (list 'gnus-highlight-selected-summary)
 979   "*Hook run after selecting an article in the summary buffer.
 980 It is meant to be used for highlighting the article in some way.  It
 981 is not run if `gnus-visual' is nil."
 982   :group 'gnus-summary-visual
 983   :type 'hook)
 984
 985 (defcustom gnus-parse-headers-hook nil
 986   "*A hook called before parsing the headers."
 987   :group 'gnus-various
 988   :type 'hook)
 989
 990 (defcustom gnus-exit-group-hook nil
 991   "*A hook called when exiting summary mode.
 992 This hook is not called from the non-updating exit commands like `Q'."
 993   :group 'gnus-various
 994   :type 'hook)
 995
 996 (defcustom gnus-summary-update-hook nil
 997   "*A hook called when a summary line is changed.
 998 The hook will not be called if `gnus-visual' is nil.
 999
1000 The default function `gnus-summary-highlight-line' will
1001 highlight the line according to the `gnus-summary-highlight'
1002 variable."
1003   :group 'gnus-summary-visual
1004   :type 'hook)
1005
1006 (defcustom gnus-mark-article-hook '(gnus-summary-mark-read-and-unread-as-read)
1007   "*A hook called when an article is selected for the first time.
1008 The hook is intended to mark an article as read (or unread)
1009 automatically when it is selected."
1010   :group 'gnus-summary-choose
1011   :type 'hook)
1012
1013 (defcustom gnus-group-no-more-groups-hook nil
1014   "*A hook run when returning to group mode having no more (unread) groups."
1015   :group 'gnus-group-select
1016   :type 'hook)
1017
1018 (defcustom gnus-ps-print-hook nil
1019   "*A hook run before ps-printing something from Gnus."
1020   :group 'gnus-summary
1021   :type 'hook)
1022
1023 (defcustom gnus-summary-article-move-hook nil
1024   "*A hook called after an article is moved, copied, respooled, or crossposted."
1025   :version "22.1"
1026   :group 'gnus-summary
1027   :type 'hook)
1028
1029 (defcustom gnus-summary-article-delete-hook nil
1030   "*A hook called after an article is deleted."
1031   :version "22.1"
1032   :group 'gnus-summary
1033   :type 'hook)
1034
1035 (defcustom gnus-summary-article-expire-hook nil
1036   "*A hook called after an article is expired."
1037   :version "22.1"
1038   :group 'gnus-summary
1039   :type 'hook)
1040
1041 (defcustom gnus-summary-display-arrow
1042   (and (fboundp 'display-graphic-p)
1043        (display-graphic-p))
1044   "*If non-nil, display an arrow highlighting the current article."
1045   :version "22.1"
1046   :group 'gnus-summary
1047   :type 'boolean)
1048
1049 (defcustom gnus-summary-selected-face 'gnus-summary-selected
1050   "Face used for highlighting the current article in the summary buffer."
1051   :group 'gnus-summary-visual
1052   :type 'face)
1053
1054 (defvar gnus-tmp-downloaded nil)
1055
1056 (defcustom gnus-summary-highlight
1057   '(((eq mark gnus-canceled-mark)
1058      . gnus-summary-cancelled)
1059     ((and uncached (> score default-high))
1060      . gnus-summary-high-undownloaded)
1061     ((and uncached (< score default-low))
1062      . gnus-summary-low-undownloaded)
1063     (uncached
1064      . gnus-summary-normal-undownloaded)
1065     ((and (> score default-high)
1066           (or (eq mark gnus-dormant-mark)
1067               (eq mark gnus-ticked-mark)))
1068      . gnus-summary-high-ticked)
1069     ((and (< score default-low)
1070           (or (eq mark gnus-dormant-mark)
1071               (eq mark gnus-ticked-mark)))
1072      . gnus-summary-low-ticked)
1073     ((or (eq mark gnus-dormant-mark)
1074          (eq mark gnus-ticked-mark))
1075      . gnus-summary-normal-ticked)
1076     ((and (> score default-high) (eq mark gnus-ancient-mark))
1077      . gnus-summary-high-ancient)
1078     ((and (< score default-low) (eq mark gnus-ancient-mark))
1079      . gnus-summary-low-ancient)
1080     ((eq mark gnus-ancient-mark)
1081      . gnus-summary-normal-ancient)
1082     ((and (> score default-high) (eq mark gnus-unread-mark))
1083      . gnus-summary-high-unread)
1084     ((and (< score default-low) (eq mark gnus-unread-mark))
1085      . gnus-summary-low-unread)
1086     ((eq mark gnus-unread-mark)
1087      . gnus-summary-normal-unread)
1088     ((> score default-high)
1089      . gnus-summary-high-read)
1090     ((< score default-low)
1091      . gnus-summary-low-read)
1092     (t
1093      . gnus-summary-normal-read))
1094   "*Controls the highlighting of summary buffer lines.
1095
1096 A list of (FORM . FACE) pairs.  When deciding how a particular
1097 summary line should be displayed, each form is evaluated.  The content
1098 of the face field after the first true form is used.  You can change
1099 how those summary lines are displayed, by editing the face field.
1100
1101 You can use the following variables in the FORM field.
1102
1103 score:        The article's score.
1104 default:      The default article score.
1105 default-high: The default score for high scored articles.
1106 default-low:  The default score for low scored articles.
1107 below:        The score below which articles are automatically marked as read.
1108 mark:         The article's mark.
1109 uncached:     Non-nil if the article is uncached."
1110   :group 'gnus-summary-visual
1111   :type '(repeat (cons (sexp :tag "Form" nil)
1112                        face)))
1113 (put 'gnus-summary-highlight 'risky-local-variable t)
1114
1115 (defcustom gnus-alter-header-function nil
1116   "Function called to allow alteration of article header structures.
1117 The function is called with one parameter, the article header vector,
1118 which it may alter in any way."
1119   :type '(choice (const :tag "None" nil)
1120                  function)
1121   :group 'gnus-summary)
1122
1123 (defvar gnus-decode-encoded-word-function 'mail-decode-encoded-word-string
1124   "Function used to decode a string with encoded words.")
1125
1126 (defvar gnus-decode-encoded-address-function
1127   'mail-decode-encoded-address-string
1128   "Function used to decode addresses with encoded words.")
1129
1130 (defcustom gnus-extra-headers '(To Newsgroups)
1131   "*Extra headers to parse."
1132   :version "21.1"
1133   :group 'gnus-summary
1134   :type '(repeat symbol))
1135
1136 (defcustom gnus-ignored-from-addresses
1137   (and user-mail-address
1138        (not (string= user-mail-address ""))
1139        (regexp-quote user-mail-address))
1140   "*From headers that may be suppressed in favor of To headers.
1141 This can be a regexp or a list of regexps."
1142   :version "21.1"
1143   :group 'gnus-summary
1144   :type '(choice regexp
1145                  (repeat :tag "Regexp List" regexp)))
1146
1147 (defsubst gnus-ignored-from-addresses ()
1148   (gmm-regexp-concat gnus-ignored-from-addresses))
1149
1150 (defcustom gnus-summary-to-prefix "-> "
1151   "*String prefixed to the To field in the summary line when
1152 using `gnus-ignored-from-addresses'."
1153   :version "22.1"
1154   :group 'gnus-summary
1155   :type 'string)
1156
1157 (defcustom gnus-summary-newsgroup-prefix "=> "
1158   "*String prefixed to the Newsgroup field in the summary
1159 line when using `gnus-ignored-from-addresses'."
1160   :version "22.1"
1161   :group 'gnus-summary
1162   :type 'string)
1163
1164 (defcustom gnus-newsgroup-ignored-charsets '(unknown-8bit x-unknown)
1165   "List of charsets that should be ignored.
1166 When these charsets are used in the \"charset\" parameter, the
1167 default charset will be used instead."
1168   :version "21.1"
1169   :type '(repeat symbol)
1170   :group 'gnus-charset)
1171
1172 (defcustom gnus-newsgroup-maximum-articles nil
1173   "The maximum number of articles a newsgroup.
1174 If this is a number, old articles in a newsgroup exceeding this number
1175 are silently ignored.  If it is nil, no article is ignored.  Note that
1176 setting this variable to a number might prevent you from reading very
1177 old articles."
1178   :group 'gnus-group-select
1179   :version "22.2"
1180   :type '(choice (const :tag "No limit" nil)
1181                  integer))
1182
1183 (gnus-define-group-parameter
1184  ignored-charsets
1185  :type list
1186  :function-document
1187  "Return the ignored charsets of GROUP."
1188  :variable gnus-group-ignored-charsets-alist
1189  :variable-default
1190  '(("alt\\.chinese\\.text" iso-8859-1))
1191  :variable-document
1192  "Alist of regexps (to match group names) and charsets that should be ignored.
1193 When these charsets are used in the \"charset\" parameter, the
1194 default charset will be used instead."
1195  :variable-group gnus-charset
1196  :variable-type '(repeat (cons (regexp :tag "Group")
1197                                (repeat symbol)))
1198  :parameter-type '(choice :tag "Ignored charsets"
1199                           :value nil
1200                           (repeat (symbol)))
1201  :parameter-document       "\
1202 List of charsets that should be ignored.
1203
1204 When these charsets are used in the \"charset\" parameter, the
1205 default charset will be used instead.")
1206
1207 (defcustom gnus-group-highlight-words-alist nil
1208   "Alist of group regexps and highlight regexps.
1209 This variable uses the same syntax as `gnus-emphasis-alist'."
1210   :version "21.1"
1211   :type '(repeat (cons (regexp :tag "Group")
1212                        (repeat (list (regexp :tag "Highlight regexp")
1213                                      (number :tag "Group for entire word" 0)
1214                                      (number :tag "Group for displayed part" 0)
1215                                      (symbol :tag "Face"
1216                                              gnus-emphasis-highlight-words)))))
1217   :group 'gnus-summary-visual)
1218
1219 (defcustom gnus-summary-show-article-charset-alist
1220   nil
1221   "Alist of number and charset.
1222 The article will be shown with the charset corresponding to the
1223 numbered argument.
1224 For example: ((1 . cn-gb-2312) (2 . big5))."
1225   :version "21.1"
1226   :type '(repeat (cons (number :tag "Argument" 1)
1227                        (symbol :tag "Charset")))
1228   :group 'gnus-charset)
1229
1230 (defcustom gnus-preserve-marks t
1231   "Whether marks are preserved when moving, copying and respooling messages."
1232   :version "21.1"
1233   :type 'boolean
1234   :group 'gnus-summary-marks)
1235
1236 (defcustom gnus-propagate-marks t
1237   "If non-nil, do not propagate marks to the backends."
1238   :version "23.1" ;; No Gnus
1239   :type 'boolean
1240   :group 'gnus-summary-marks)
1241
1242 (defcustom gnus-alter-articles-to-read-function nil
1243   "Function to be called to alter the list of articles to be selected."
1244   :type '(choice (const nil) function)
1245   :group 'gnus-summary)
1246
1247 (defcustom gnus-orphan-score nil
1248   "*All orphans get this score added.  Set in the score file."
1249   :group 'gnus-score-default
1250   :type '(choice (const nil)
1251                  integer))
1252
1253 (defcustom gnus-summary-save-parts-default-mime "image/.*"
1254   "*A regexp to match MIME parts when saving multiple parts of a
1255 message with `gnus-summary-save-parts' (\\<gnus-summary-mode-map>\\[gnus-summary-save-parts]).
1256 This regexp will be used by default when prompting the user for which
1257 type of files to save."
1258   :group 'gnus-summary
1259   :type 'regexp)
1260
1261 (defcustom gnus-read-all-available-headers nil
1262   "Whether Gnus should parse all headers made available to it.
1263 This is mostly relevant for slow back ends where the user may
1264 wish to widen the summary buffer to include all headers
1265 that were fetched."
1266   :version "22.1"
1267   :group 'gnus-summary
1268   :type '(choice boolean regexp))
1269
1270 (defcustom gnus-summary-pipe-output-default-command nil
1271   "Command (and optional arguments) used to pipe article to subprocess.
1272 This will be used as the default command if it is non-nil.  The value
1273 will be updated if you modify it when executing the command
1274 `gnus-summary-pipe-output' or the function `gnus-summary-save-in-pipe'."
1275   :version "23.1" ;; No Gnus
1276   :group 'gnus-summary
1277   :type '(radio (const :tag "None" nil) (string :tag "Command")))
1278
1279 (defcustom gnus-summary-muttprint-program "muttprint"
1280   "Command (and optional arguments) used to run Muttprint.
1281 The value will be updated if you modify it when executing the command
1282 `gnus-summary-muttprint'."
1283   :version "22.1"
1284   :group 'gnus-summary
1285   :type 'string)
1286
1287 (defcustom gnus-article-loose-mime t
1288   "If non-nil, don't require MIME-Version header.
1289 Some brain-damaged MUA/MTA, e.g. Lotus Domino 5.0.6 clients, does not
1290 supply the MIME-Version header or deliberately strip it from the mail.
1291 If non-nil (the default), Gnus will treat some articles as MIME
1292 even if the MIME-Version header is missing."
1293   :version "22.1"
1294   :type 'boolean
1295   :group 'gnus-article-mime)
1296
1297 (defcustom gnus-article-emulate-mime t
1298   "If non-nil, use MIME emulation for uuencode and the like.
1299 This means that Gnus will search message bodies for text that look
1300 like uuencoded bits, yEncoded bits, and so on, and present that using
1301 the normal Gnus MIME machinery."
1302   :version "22.1"
1303   :type 'boolean
1304   :group 'gnus-article-mime)
1305
1306 ;;; Internal variables
1307
1308 (defvar gnus-summary-display-cache nil)
1309 (defvar gnus-article-mime-handles nil)
1310 (defvar gnus-article-decoded-p nil)
1311 (defvar gnus-article-charset nil)
1312 (defvar gnus-article-ignored-charsets nil)
1313 (defvar gnus-scores-exclude-files nil)
1314 (defvar gnus-page-broken nil)
1315
1316 (defvar gnus-original-article nil)
1317 (defvar gnus-article-internal-prepare-hook nil)
1318 (defvar gnus-newsgroup-process-stack nil)
1319
1320 (defvar gnus-thread-indent-array nil)
1321 (defvar gnus-thread-indent-array-level gnus-thread-indent-level)
1322 (defvar gnus-sort-gathered-threads-function 'gnus-thread-sort-by-number
1323   "Function called to sort the articles within a thread after it has been gathered together.")
1324
1325 (defvar gnus-summary-save-parts-type-history nil)
1326 (defvar gnus-summary-save-parts-last-directory mm-default-directory)
1327
1328 ;; Avoid highlighting in kill files.
1329 (defvar gnus-summary-inhibit-highlight nil)
1330 (defvar gnus-newsgroup-selected-overlay nil)
1331 (defvar gnus-inhibit-limiting nil)
1332 (defvar gnus-newsgroup-adaptive-score-file nil)
1333 (defvar gnus-current-score-file nil)
1334 (defvar gnus-current-move-group nil)
1335 (defvar gnus-current-copy-group nil)
1336 (defvar gnus-current-crosspost-group nil)
1337 (defvar gnus-newsgroup-display nil)
1338
1339 (defvar gnus-newsgroup-dependencies nil)
1340 (defvar gnus-newsgroup-adaptive nil)
1341 (defvar gnus-summary-display-article-function nil)
1342 (defvar gnus-summary-highlight-line-function nil
1343   "Function called after highlighting a summary line.")
1344
1345 (defvar gnus-summary-line-format-alist
1346   `((?N ,(macroexpand '(mail-header-number gnus-tmp-header)) ?d)
1347     (?S ,(macroexpand '(mail-header-subject gnus-tmp-header)) ?s)
1348     (?s gnus-tmp-subject-or-nil ?s)
1349     (?n gnus-tmp-name ?s)
1350     (?A (car (cdr (funcall gnus-extract-address-components gnus-tmp-from)))
1351         ?s)
1352     (?a (or (car (funcall gnus-extract-address-components gnus-tmp-from))
1353             gnus-tmp-from) ?s)
1354     (?F gnus-tmp-from ?s)
1355     (?x ,(macroexpand '(mail-header-xref gnus-tmp-header)) ?s)
1356     (?D ,(macroexpand '(mail-header-date gnus-tmp-header)) ?s)
1357     (?d (gnus-dd-mmm (mail-header-date gnus-tmp-header)) ?s)
1358     (?o (gnus-date-iso8601 (mail-header-date gnus-tmp-header)) ?s)
1359     (?M ,(macroexpand '(mail-header-id gnus-tmp-header)) ?s)
1360     (?r ,(macroexpand '(mail-header-references gnus-tmp-header)) ?s)
1361     (?c (or (mail-header-chars gnus-tmp-header) 0) ?d)
1362     (?k (gnus-summary-line-message-size gnus-tmp-header) ?s)
1363     (?L gnus-tmp-lines ?s)
1364     (?O gnus-tmp-downloaded ?c)
1365     (?I gnus-tmp-indentation ?s)
1366     (?T (if (= gnus-tmp-level 0) "" (make-string (frame-width) ? )) ?s)
1367     (?R gnus-tmp-replied ?c)
1368     (?\[ gnus-tmp-opening-bracket ?c)
1369     (?\] gnus-tmp-closing-bracket ?c)
1370     (?\> (make-string gnus-tmp-level ? ) ?s)
1371     (?\< (make-string (max 0 (- 20 gnus-tmp-level)) ? ) ?s)
1372     (?i gnus-tmp-score ?d)
1373     (?z gnus-tmp-score-char ?c)
1374     (?V (gnus-thread-total-score (and (boundp 'thread) (car thread))) ?d)
1375     (?U gnus-tmp-unread ?c)
1376     (?f (gnus-summary-from-or-to-or-newsgroups gnus-tmp-header gnus-tmp-from)
1377         ?s)
1378     (?t (gnus-summary-number-of-articles-in-thread
1379          (and (boundp 'thread) (car thread)) gnus-tmp-level)
1380         ?d)
1381     (?e (gnus-summary-number-of-articles-in-thread
1382          (and (boundp 'thread) (car thread)) gnus-tmp-level t)
1383         ?c)
1384     (?u gnus-tmp-user-defined ?s)
1385     (?P (gnus-pick-line-number) ?d)
1386     (?B gnus-tmp-thread-tree-header-string ?s)
1387     (user-date (gnus-user-date
1388                 ,(macroexpand '(mail-header-date gnus-tmp-header))) ?s))
1389   "An alist of format specifications that can appear in summary lines.
1390 These are paired with what variables they correspond with, along with
1391 the type of the variable (string, integer, character, etc).")
1392
1393 (defvar gnus-summary-dummy-line-format-alist
1394   `((?S gnus-tmp-subject ?s)
1395     (?N gnus-tmp-number ?d)
1396     (?u gnus-tmp-user-defined ?s)))
1397
1398 (defvar gnus-summary-mode-line-format-alist
1399   `((?G gnus-tmp-group-name ?s)
1400     (?g (gnus-short-group-name gnus-tmp-group-name) ?s)
1401     (?p (gnus-group-real-name gnus-tmp-group-name) ?s)
1402     (?A gnus-tmp-article-number ?d)
1403     (?Z gnus-tmp-unread-and-unselected ?s)
1404     (?V gnus-version ?s)
1405     (?U gnus-tmp-unread-and-unticked ?d)
1406     (?S gnus-tmp-subject ?s)
1407     (?e gnus-tmp-unselected ?d)
1408     (?u gnus-tmp-user-defined ?s)
1409     (?d (length gnus-newsgroup-dormant) ?d)
1410     (?t (length gnus-newsgroup-marked) ?d)
1411     (?h (length gnus-newsgroup-spam-marked) ?d)
1412     (?r (length gnus-newsgroup-reads) ?d)
1413     (?z (gnus-summary-article-score gnus-tmp-article-number) ?d)
1414     (?E gnus-newsgroup-expunged-tally ?d)
1415     (?s (gnus-current-score-file-nondirectory) ?s)))
1416
1417 ;; This is here rather than in gnus-art for compilation reasons.
1418 (defvar gnus-article-mode-line-format-alist
1419   (nconc '((?w (gnus-article-wash-status) ?s)
1420            (?m (gnus-article-mime-part-status) ?s))
1421          gnus-summary-mode-line-format-alist))
1422
1423 (defvar gnus-last-search-regexp nil
1424   "Default regexp for article search command.")
1425
1426 (defvar gnus-last-shell-command nil
1427   "Default shell command on article.")
1428
1429 (defvar gnus-newsgroup-agentized nil
1430   "Locally bound in each summary buffer to indicate whether the server has been agentized.")
1431 (defvar gnus-newsgroup-begin nil)
1432 (defvar gnus-newsgroup-end nil)
1433 (defvar gnus-newsgroup-last-rmail nil)
1434 (defvar gnus-newsgroup-last-mail nil)
1435 (defvar gnus-newsgroup-last-folder nil)
1436 (defvar gnus-newsgroup-last-file nil)
1437 (defvar gnus-newsgroup-last-directory nil)
1438 (defvar gnus-newsgroup-auto-expire nil)
1439 (defvar gnus-newsgroup-active nil)
1440 (defvar gnus-newsgroup-highest nil)
1441
1442 (defvar gnus-newsgroup-data nil)
1443 (defvar gnus-newsgroup-data-reverse nil)
1444 (defvar gnus-newsgroup-limit nil)
1445 (defvar gnus-newsgroup-limits nil)
1446 (defvar gnus-summary-use-undownloaded-faces nil)
1447
1448 (defvar gnus-newsgroup-unreads nil
1449   "Sorted list of unread articles in the current newsgroup.")
1450
1451 (defvar gnus-newsgroup-unselected nil
1452   "Sorted list of unselected unread articles in the current newsgroup.")
1453
1454 (defvar gnus-newsgroup-reads nil
1455   "Alist of read articles and article marks in the current newsgroup.")
1456
1457 (defvar gnus-newsgroup-expunged-tally nil)
1458
1459 (defvar gnus-newsgroup-marked nil
1460   "Sorted list of ticked articles in the current newsgroup (a subset of unread art).")
1461
1462 (defvar gnus-newsgroup-spam-marked nil
1463   "List of ranges of articles that have been marked as spam.")
1464
1465 (defvar gnus-newsgroup-killed nil
1466   "List of ranges of articles that have been through the scoring process.")
1467
1468 (defvar gnus-newsgroup-cached nil
1469   "Sorted list of articles that come from the article cache.")
1470
1471 (defvar gnus-newsgroup-saved nil
1472   "List of articles that have been saved.")
1473
1474 (defvar gnus-newsgroup-kill-headers nil)
1475
1476 (defvar gnus-newsgroup-replied nil
1477   "List of articles that have been replied to in the current newsgroup.")
1478
1479 (defvar gnus-newsgroup-forwarded nil
1480   "List of articles that have been forwarded in the current newsgroup.")
1481
1482 (defvar gnus-newsgroup-recent nil
1483   "List of articles that have are recent in the current newsgroup.")
1484
1485 (defvar gnus-newsgroup-expirable nil
1486   "Sorted list of articles in the current newsgroup that can be expired.")
1487
1488 (defvar gnus-newsgroup-processable nil
1489   "List of articles in the current newsgroup that can be processed.")
1490
1491 (defvar gnus-newsgroup-downloadable nil
1492   "Sorted list of articles in the current newsgroup that can be processed.")
1493
1494 (defvar gnus-newsgroup-unfetched nil
1495   "Sorted list of articles in the current newsgroup whose headers have
1496 not been fetched into the agent.
1497
1498 This list will always be a subset of gnus-newsgroup-undownloaded.")
1499
1500 (defvar gnus-newsgroup-undownloaded nil
1501   "List of articles in the current newsgroup that haven't been downloaded.")
1502
1503 (defvar gnus-newsgroup-unsendable nil
1504   "List of articles in the current newsgroup that won't be sent.")
1505
1506 (defvar gnus-newsgroup-bookmarks nil
1507   "List of articles in the current newsgroup that have bookmarks.")
1508
1509 (defvar gnus-newsgroup-dormant nil
1510   "Sorted list of dormant articles in the current newsgroup.")
1511
1512 (defvar gnus-newsgroup-unseen nil
1513   "List of unseen articles in the current newsgroup.")
1514
1515 (defvar gnus-newsgroup-seen nil
1516   "Range of seen articles in the current newsgroup.")
1517
1518 (defvar gnus-newsgroup-articles nil
1519   "List of articles in the current newsgroup.")
1520
1521 (defvar gnus-newsgroup-scored nil
1522   "List of scored articles in the current newsgroup.")
1523
1524 (defvar gnus-newsgroup-headers nil
1525   "List of article headers in the current newsgroup.")
1526
1527 (defvar gnus-newsgroup-threads nil)
1528
1529 (defvar gnus-newsgroup-prepared nil
1530   "Whether the current group has been prepared properly.")
1531
1532 (defvar gnus-newsgroup-ancient nil
1533   "List of `gnus-fetch-old-headers' articles in the current newsgroup.")
1534
1535 (defvar gnus-newsgroup-sparse nil)
1536
1537 (defvar gnus-current-article nil)
1538 (defvar gnus-article-current nil)
1539 (defvar gnus-current-headers nil)
1540 (defvar gnus-have-all-headers nil)
1541 (defvar gnus-last-article nil)
1542 (defvar gnus-newsgroup-history nil)
1543 (defvar gnus-newsgroup-charset nil)
1544 (defvar gnus-newsgroup-ephemeral-charset nil)
1545 (defvar gnus-newsgroup-ephemeral-ignored-charsets nil)
1546
1547 (defvar gnus-article-before-search nil)
1548
1549 (defvar gnus-summary-local-variables