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

   1 ;;; gnus.el --- a newsreader for GNU Emacs
   2
   3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
   4 ;;   2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
   5 ;;   Free Software Foundation, Inc.
   6
   7 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   8 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   9 ;; Keywords: news, mail
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software: you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation, either version 3 of the License, or
  16 ;; (at your option) any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (eval '(run-hooks 'gnus-load-hook))
  31
  32 ;; For Emacs < 22.2.
  33 (eval-and-compile
  34   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
  35
  36 (eval-when-compile (require 'cl))
  37 (require 'wid-edit)
  38 (require 'mm-util)
  39 (require 'nnheader)
  40
  41 ;; These are defined afterwards with gnus-define-group-parameter
  42 (defvar gnus-ham-process-destinations)
  43 (defvar gnus-parameter-ham-marks-alist)
  44 (defvar gnus-parameter-spam-marks-alist)
  45 (defvar gnus-spam-autodetect)
  46 (defvar gnus-spam-autodetect-methods)
  47 (defvar gnus-spam-newsgroup-contents)
  48 (defvar gnus-spam-process-destinations)
  49 (defvar gnus-spam-resend-to)
  50 (defvar gnus-ham-resend-to)
  51 (defvar gnus-spam-process-newsgroups)
  52
  53
  54 (defgroup gnus nil
  55   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
  56   :group 'news
  57   :group 'mail)
  58
  59 (defgroup gnus-start nil
  60   "Starting your favorite newsreader."
  61   :group 'gnus)
  62
  63 (defgroup gnus-format nil
  64   "Dealing with formatting issues."
  65   :group 'gnus)
  66
  67 (defgroup gnus-charset nil
  68   "Group character set issues."
  69   :link '(custom-manual "(gnus)Charsets")
  70   :version "21.1"
  71   :group 'gnus)
  72
  73 (defgroup gnus-cache nil
  74   "Cache interface."
  75   :link '(custom-manual "(gnus)Article Caching")
  76   :group 'gnus)
  77
  78 (defgroup gnus-registry nil
  79   "Article Registry."
  80   :group 'gnus)
  81
  82 (defgroup gnus-start-server nil
  83   "Server options at startup."
  84   :group 'gnus-start)
  85
  86 ;; These belong to gnus-group.el.
  87 (defgroup gnus-group nil
  88   "Group buffers."
  89   :link '(custom-manual "(gnus)Group Buffer")
  90   :group 'gnus)
  91
  92 (defgroup gnus-group-foreign nil
  93   "Foreign groups."
  94   :link '(custom-manual "(gnus)Foreign Groups")
  95   :group 'gnus-group)
  96
  97 (defgroup gnus-group-new nil
  98   "Automatic subscription of new groups."
  99   :group 'gnus-group)
 100
 101 (defgroup gnus-group-levels nil
 102   "Group levels."
 103   :link '(custom-manual "(gnus)Group Levels")
 104   :group 'gnus-group)
 105
 106 (defgroup gnus-group-select nil
 107   "Selecting a Group."
 108   :link '(custom-manual "(gnus)Selecting a Group")
 109   :group 'gnus-group)
 110
 111 (defgroup gnus-group-listing nil
 112   "Showing slices of the group list."
 113   :link '(custom-manual "(gnus)Listing Groups")
 114   :group 'gnus-group)
 115
 116 (defgroup gnus-group-visual nil
 117   "Sorting the group buffer."
 118   :link '(custom-manual "(gnus)Group Buffer Format")
 119   :group 'gnus-group
 120   :group 'gnus-visual)
 121
 122 (defgroup gnus-group-various nil
 123   "Various group options."
 124   :link '(custom-manual "(gnus)Scanning New Messages")
 125   :group 'gnus-group)
 126
 127 ;; These belong to gnus-sum.el.
 128 (defgroup gnus-summary nil
 129   "Summary buffers."
 130   :link '(custom-manual "(gnus)Summary Buffer")
 131   :group 'gnus)
 132
 133 (defgroup gnus-summary-exit nil
 134   "Leaving summary buffers."
 135   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
 136   :group 'gnus-summary)
 137
 138 (defgroup gnus-summary-marks nil
 139   "Marks used in summary buffers."
 140   :link '(custom-manual "(gnus)Marking Articles")
 141   :group 'gnus-summary)
 142
 143 (defgroup gnus-thread nil
 144   "Ordering articles according to replies."
 145   :link '(custom-manual "(gnus)Threading")
 146   :group 'gnus-summary)
 147
 148 (defgroup gnus-summary-format nil
 149   "Formatting of the summary buffer."
 150   :link '(custom-manual "(gnus)Summary Buffer Format")
 151   :group 'gnus-summary)
 152
 153 (defgroup gnus-summary-choose nil
 154   "Choosing Articles."
 155   :link '(custom-manual "(gnus)Choosing Articles")
 156   :group 'gnus-summary)
 157
 158 (defgroup gnus-summary-maneuvering nil
 159   "Summary movement commands."
 160   :link '(custom-manual "(gnus)Summary Maneuvering")
 161   :group 'gnus-summary)
 162
 163 (defgroup gnus-picon nil
 164   "Show pictures of people, domains, and newsgroups."
 165   :group 'gnus-visual)
 166
 167 (defgroup gnus-summary-mail nil
 168   "Mail group commands."
 169   :link '(custom-manual "(gnus)Mail Group Commands")
 170   :group 'gnus-summary)
 171
 172 (defgroup gnus-summary-sort nil
 173   "Sorting the summary buffer."
 174   :link '(custom-manual "(gnus)Sorting the Summary Buffer")
 175   :group 'gnus-summary)
 176
 177 (defgroup gnus-summary-visual nil
 178   "Highlighting and menus in the summary buffer."
 179   :link '(custom-manual "(gnus)Summary Highlighting")
 180   :group 'gnus-visual
 181   :group 'gnus-summary)
 182
 183 (defgroup gnus-summary-various nil
 184   "Various summary buffer options."
 185   :link '(custom-manual "(gnus)Various Summary Stuff")
 186   :group 'gnus-summary)
 187
 188 (defgroup gnus-summary-pick nil
 189   "Pick mode in the summary buffer."
 190   :link '(custom-manual "(gnus)Pick and Read")
 191   :prefix "gnus-pick-"
 192   :group 'gnus-summary)
 193
 194 (defgroup gnus-summary-tree nil
 195   "Tree display of threads in the summary buffer."
 196   :link '(custom-manual "(gnus)Tree Display")
 197   :prefix "gnus-tree-"
 198   :group 'gnus-summary)
 199
 200 ;; Belongs to gnus-uu.el
 201 (defgroup gnus-extract-view nil
 202   "Viewing extracted files."
 203   :link '(custom-manual "(gnus)Viewing Files")
 204   :group 'gnus-extract)
 205
 206 ;; Belongs to gnus-score.el
 207 (defgroup gnus-score nil
 208   "Score and kill file handling."
 209   :group 'gnus)
 210
 211 (defgroup gnus-score-kill nil
 212   "Kill files."
 213   :group 'gnus-score)
 214
 215 (defgroup gnus-score-adapt nil
 216   "Adaptive score files."
 217   :group 'gnus-score)
 218
 219 (defgroup gnus-score-default nil
 220   "Default values for score files."
 221   :group 'gnus-score)
 222
 223 (defgroup gnus-score-expire nil
 224   "Expiring score rules."
 225   :group 'gnus-score)
 226
 227 (defgroup gnus-score-decay nil
 228   "Decaying score rules."
 229   :group 'gnus-score)
 230
 231 (defgroup gnus-score-files nil
 232   "Score and kill file names."
 233   :group 'gnus-score
 234   :group 'gnus-files)
 235
 236 (defgroup gnus-score-various nil
 237   "Various scoring and killing options."
 238   :group 'gnus-score)
 239
 240 ;; Other
 241 (defgroup gnus-visual nil
 242   "Options controlling the visual fluff."
 243   :group 'gnus
 244   :group 'faces)
 245
 246 (defgroup gnus-agent nil
 247   "Offline support for Gnus."
 248   :group 'gnus)
 249
 250 (defgroup gnus-files nil
 251   "Files used by Gnus."
 252   :group 'gnus)
 253
 254 (defgroup gnus-dribble-file nil
 255   "Auto save file."
 256   :link '(custom-manual "(gnus)Auto Save")
 257   :group 'gnus-files)
 258
 259 (defgroup gnus-newsrc nil
 260   "Storing Gnus state."
 261   :group 'gnus-files)
 262
 263 (defgroup gnus-server nil
 264   "Options related to newsservers and other servers used by Gnus."
 265   :group 'gnus)
 266
 267 (defgroup gnus-server-visual nil
 268   "Highlighting and menus in the server buffer."
 269   :group 'gnus-visual
 270   :group 'gnus-server)
 271
 272 (defgroup gnus-message '((message custom-group))
 273   "Composing replies and followups in Gnus."
 274   :group 'gnus)
 275
 276 (defgroup gnus-meta nil
 277   "Meta variables controlling major portions of Gnus.
 278 In general, modifying these variables does not take affect until Gnus
 279 is restarted, and sometimes reloaded."
 280   :group 'gnus)
 281
 282 (defgroup gnus-various nil
 283   "Other Gnus options."
 284   :link '(custom-manual "(gnus)Various Various")
 285   :group 'gnus)
 286
 287 (defgroup gnus-exit nil
 288   "Exiting Gnus."
 289   :link '(custom-manual "(gnus)Exiting Gnus")
 290   :group 'gnus)
 291
 292 (defgroup gnus-fun nil
 293   "Frivolous Gnus extensions."
 294   :link '(custom-manual "(gnus)Exiting Gnus")
 295   :group 'gnus)
 296
 297 (defconst gnus-version-number "0.11"
 298   "Version number for this version of Gnus.")
 299
 300 (defconst gnus-version (format "No Gnus v%s" gnus-version-number)
 301   "Version string for this version of Gnus.")
 302
 303 (defcustom gnus-inhibit-startup-message nil
 304   "If non-nil, the startup message will not be displayed.
 305 This variable is used before `.gnus.el' is loaded, so it should
 306 be set in `.emacs' instead."
 307   :group 'gnus-start
 308   :type 'boolean)
 309
 310 (defcustom gnus-play-startup-jingle nil
 311   "If non-nil, play the Gnus jingle at startup."
 312   :group 'gnus-start
 313   :type 'boolean)
 314
 315 (unless (fboundp 'gnus-group-remove-excess-properties)
 316   (defalias 'gnus-group-remove-excess-properties 'ignore))
 317
 318 (unless (featurep 'gnus-xmas)
 319   (defalias 'gnus-make-overlay 'make-overlay)
 320   (defalias 'gnus-delete-overlay 'delete-overlay)
 321   (defalias 'gnus-overlay-put 'overlay-put)
 322   (defalias 'gnus-move-overlay 'move-overlay)
 323   (defalias 'gnus-overlay-buffer 'overlay-buffer)
 324   (defalias 'gnus-overlay-start 'overlay-start)
 325   (defalias 'gnus-overlay-end 'overlay-end)
 326   (defalias 'gnus-extent-detached-p 'ignore)
 327   (defalias 'gnus-extent-start-open 'ignore)
 328   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
 329   (defalias 'gnus-character-to-event 'identity)
 330   (defalias 'gnus-assq-delete-all 'assq-delete-all)
 331   (defalias 'gnus-add-text-properties 'add-text-properties)
 332   (defalias 'gnus-put-text-property 'put-text-property)
 333   (defvar gnus-mode-line-image-cache t)
 334   (if (fboundp 'find-image)
 335       (defun gnus-mode-line-buffer-identification (line)
 336         (let ((str (car-safe line))
 337               (load-path (mm-image-load-path)))
 338           (if (and (stringp str)
 339                    (string-match "^Gnus:" str))
 340               (progn (add-text-properties
 341                       0 5
 342                       (list 'display
 343                             (if (eq t gnus-mode-line-image-cache)
 344                                 (setq gnus-mode-line-image-cache
 345                                       (find-image
 346                                        '((:type xpm :file "gnus-pointer.xpm"
 347                                                 :ascent center)
 348                                          (:type xbm :file "gnus-pointer.xbm"
 349                                                 :ascent center))))
 350                               gnus-mode-line-image-cache)
 351                             'help-echo (format
 352                                         "This is %s, %s."
 353                                         gnus-version (gnus-emacs-version)))
 354                       str)
 355                      (list str))
 356             line)))
 357     (defalias 'gnus-mode-line-buffer-identification 'identity))
 358   (defalias 'gnus-characterp 'numberp)
 359   (defalias 'gnus-deactivate-mark 'deactivate-mark)
 360   (defalias 'gnus-window-edges 'window-edges)
 361   (defalias 'gnus-key-press-event-p 'numberp)
 362   ;;(defalias 'gnus-decode-rfc1522 'ignore)
 363   )
 364
 365 ;; We define these group faces here to avoid the display
 366 ;; update forced when creating new faces.
 367
 368 (defface gnus-group-news-1
 369   '((((class color)
 370       (background dark))
 371      (:foreground "PaleTurquoise" :bold t))
 372     (((class color)
 373       (background light))
 374      (:foreground "ForestGreen" :bold t))
 375     (t
 376      ()))
 377   "Level 1 newsgroup face."
 378   :group 'gnus-group)
 379 ;; backward-compatibility alias
 380 (put 'gnus-group-news-1-face 'face-alias 'gnus-group-news-1)
 381 (put 'gnus-group-news-1-face 'obsolete-face "22.1")
 382
 383 (defface gnus-group-news-1-empty
 384   '((((class color)
 385       (background dark))
 386      (:foreground "PaleTurquoise"))
 387     (((class color)
 388       (background light))
 389      (:foreground "ForestGreen"))
 390     (t
 391      ()))
 392   "Level 1 empty newsgroup face."
 393   :group 'gnus-group)
 394 ;; backward-compatibility alias
 395 (put 'gnus-group-news-1-empty-face 'face-alias 'gnus-group-news-1-empty)
 396 (put 'gnus-group-news-1-empty-face 'obsolete-face "22.1")
 397
 398 (defface gnus-group-news-2
 399   '((((class color)
 400       (background dark))
 401      (:foreground "turquoise" :bold t))
 402     (((class color)
 403       (background light))
 404      (:foreground "CadetBlue4" :bold t))
 405     (t
 406      ()))
 407   "Level 2 newsgroup face."
 408   :group 'gnus-group)
 409 ;; backward-compatibility alias
 410 (put 'gnus-group-news-2-face 'face-alias 'gnus-group-news-2)
 411 (put 'gnus-group-news-2-face 'obsolete-face "22.1")
 412
 413 (defface gnus-group-news-2-empty
 414   '((((class color)
 415       (background dark))
 416      (:foreground "turquoise"))
 417     (((class color)
 418       (background light))
 419      (:foreground "CadetBlue4"))
 420     (t
 421      ()))
 422   "Level 2 empty newsgroup face."
 423   :group 'gnus-group)
 424 ;; backward-compatibility alias
 425 (put 'gnus-group-news-2-empty-face 'face-alias 'gnus-group-news-2-empty)
 426 (put 'gnus-group-news-2-empty-face 'obsolete-face "22.1")
 427
 428 (defface gnus-group-news-3
 429   '((((class color)
 430       (background dark))
 431      (:bold t))
 432     (((class color)
 433       (background light))
 434      (:bold t))
 435     (t
 436      ()))
 437   "Level 3 newsgroup face."
 438   :group 'gnus-group)
 439 ;; backward-compatibility alias
 440 (put 'gnus-group-news-3-face 'face-alias 'gnus-group-news-3)
 441 (put 'gnus-group-news-3-face 'obsolete-face "22.1")
 442
 443 (defface gnus-group-news-3-empty
 444   '((((class color)
 445       (background dark))
 446      ())
 447     (((class color)
 448       (background light))
 449      ())
 450     (t
 451      ()))
 452   "Level 3 empty newsgroup face."
 453   :group 'gnus-group)
 454 ;; backward-compatibility alias
 455 (put 'gnus-group-news-3-empty-face 'face-alias 'gnus-group-news-3-empty)
 456 (put 'gnus-group-news-3-empty-face 'obsolete-face "22.1")
 457
 458 (defface gnus-group-news-4
 459   '((((class color)
 460       (background dark))
 461      (:bold t))
 462     (((class color)
 463       (background light))
 464      (:bold t))
 465     (t
 466      ()))
 467   "Level 4 newsgroup face."
 468   :group 'gnus-group)
 469 ;; backward-compatibility alias
 470 (put 'gnus-group-news-4-face 'face-alias 'gnus-group-news-4)
 471 (put 'gnus-group-news-4-face 'obsolete-face "22.1")
 472
 473 (defface gnus-group-news-4-empty
 474   '((((class color)
 475       (background dark))
 476      ())
 477     (((class color)
 478       (background light))
 479      ())
 480     (t
 481      ()))
 482   "Level 4 empty newsgroup face."
 483   :group 'gnus-group)
 484 ;; backward-compatibility alias
 485 (put 'gnus-group-news-4-empty-face 'face-alias 'gnus-group-news-4-empty)
 486 (put 'gnus-group-news-4-empty-face 'obsolete-face "22.1")
 487
 488 (defface gnus-group-news-5
 489   '((((class color)
 490       (background dark))
 491      (:bold t))
 492     (((class color)
 493       (background light))
 494      (:bold t))
 495     (t
 496      ()))
 497   "Level 5 newsgroup face."
 498   :group 'gnus-group)
 499 ;; backward-compatibility alias
 500 (put 'gnus-group-news-5-face 'face-alias 'gnus-group-news-5)
 501 (put 'gnus-group-news-5-face 'obsolete-face "22.1")
 502
 503 (defface gnus-group-news-5-empty
 504   '((((class color)
 505       (background dark))
 506      ())
 507     (((class color)
 508       (background light))
 509      ())
 510     (t
 511      ()))
 512   "Level 5 empty newsgroup face."
 513   :group 'gnus-group)
 514 ;; backward-compatibility alias
 515 (put 'gnus-group-news-5-empty-face 'face-alias 'gnus-group-news-5-empty)
 516 (put 'gnus-group-news-5-empty-face 'obsolete-face "22.1")
 517
 518 (defface gnus-group-news-6
 519   '((((class color)
 520       (background dark))
 521      (:bold t))
 522     (((class color)
 523       (background light))
 524      (:bold t))
 525     (t
 526      ()))
 527   "Level 6 newsgroup face."
 528   :group 'gnus-group)
 529 ;; backward-compatibility alias
 530 (put 'gnus-group-news-6-face 'face-alias 'gnus-group-news-6)
 531 (put 'gnus-group-news-6-face 'obsolete-face "22.1")
 532
 533 (defface gnus-group-news-6-empty
 534   '((((class color)
 535       (background dark))
 536      ())
 537     (((class color)
 538       (background light))
 539      ())
 540     (t
 541      ()))
 542   "Level 6 empty newsgroup face."
 543   :group 'gnus-group)
 544 ;; backward-compatibility alias
 545 (put 'gnus-group-news-6-empty-face 'face-alias 'gnus-group-news-6-empty)
 546 (put 'gnus-group-news-6-empty-face 'obsolete-face "22.1")
 547
 548 (defface gnus-group-news-low
 549   '((((class color)
 550       (background dark))
 551      (:foreground "DarkTurquoise" :bold t))
 552     (((class color)
 553       (background light))
 554      (:foreground "DarkGreen" :bold t))
 555     (t
 556      ()))
 557   "Low level newsgroup face."
 558   :group 'gnus-group)
 559 ;; backward-compatibility alias
 560 (put 'gnus-group-news-low-face 'face-alias 'gnus-group-news-low)
 561 (put 'gnus-group-news-low-face 'obsolete-face "22.1")
 562
 563 (defface gnus-group-news-low-empty
 564   '((((class color)
 565       (background dark))
 566      (:foreground "DarkTurquoise"))
 567     (((class color)
 568       (background light))
 569      (:foreground "DarkGreen"))
 570     (t
 571      ()))
 572   "Low level empty newsgroup face."
 573   :group 'gnus-group)
 574 ;; backward-compatibility alias
 575 (put 'gnus-group-news-low-empty-face 'face-alias 'gnus-group-news-low-empty)
 576 (put 'gnus-group-news-low-empty-face 'obsolete-face "22.1")
 577
 578 (defface gnus-group-mail-1
 579   '((((class color)
 580       (background dark))
 581      (:foreground "#e1ffe1" :bold t))
 582     (((class color)
 583       (background light))
 584      (:foreground "DeepPink3" :bold t))
 585     (t
 586      (:bold t)))
 587   "Level 1 mailgroup face."
 588   :group 'gnus-group)
 589 ;; backward-compatibility alias
 590 (put 'gnus-group-mail-1-face 'face-alias 'gnus-group-mail-1)
 591 (put 'gnus-group-mail-1-face 'obsolete-face "22.1")
 592
 593 (defface gnus-group-mail-1-empty
 594   '((((class color)
 595       (background dark))
 596      (:foreground "#e1ffe1"))
 597     (((class color)
 598       (background light))
 599      (:foreground "DeepPink3"))
 600     (t
 601      (:italic t :bold t)))
 602   "Level 1 empty mailgroup face."
 603   :group 'gnus-group)
 604 ;; backward-compatibility alias
 605 (put 'gnus-group-mail-1-empty-face 'face-alias 'gnus-group-mail-1-empty)
 606 (put 'gnus-group-mail-1-empty-face 'obsolete-face "22.1")
 607
 608 (defface gnus-group-mail-2
 609   '((((class color)
 610       (background dark))
 611      (:foreground "DarkSeaGreen1" :bold t))
 612     (((class color)
 613       (background light))
 614      (:foreground "HotPink3" :bold t))
 615     (t
 616      (:bold t)))
 617   "Level 2 mailgroup face."
 618   :group 'gnus-group)
 619 ;; backward-compatibility alias
 620 (put 'gnus-group-mail-2-face 'face-alias 'gnus-group-mail-2)
 621 (put 'gnus-group-mail-2-face 'obsolete-face "22.1")
 622
 623 (defface gnus-group-mail-2-empty
 624   '((((class color)
 625       (background dark))
 626      (:foreground "DarkSeaGreen1"))
 627     (((class color)
 628       (background light))
 629      (:foreground "HotPink3"))
 630     (t
 631      (:bold t)))
 632   "Level 2 empty mailgroup face."
 633   :group 'gnus-group)
 634 ;; backward-compatibility alias
 635 (put 'gnus-group-mail-2-empty-face 'face-alias 'gnus-group-mail-2-empty)
 636 (put 'gnus-group-mail-2-empty-face 'obsolete-face "22.1")
 637
 638 (defface gnus-group-mail-3
 639   '((((class color)
 640       (background dark))
 641      (:foreground "aquamarine1" :bold t))
 642     (((class color)
 643       (background light))
 644      (:foreground "magenta4" :bold t))
 645     (t
 646      (:bold t)))
 647   "Level 3 mailgroup face."
 648   :group 'gnus-group)
 649 ;; backward-compatibility alias
 650 (put 'gnus-group-mail-3-face 'face-alias 'gnus-group-mail-3)
 651 (put 'gnus-group-mail-3-face 'obsolete-face "22.1")
 652
 653 (defface gnus-group-mail-3-empty
 654   '((((class color)
 655       (background dark))
 656      (:foreground "aquamarine1"))
 657     (((class color)
 658       (background light))
 659      (:foreground "magenta4"))
 660     (t
 661      ()))
 662   "Level 3 empty mailgroup face."
 663   :group 'gnus-group)
 664 ;; backward-compatibility alias
 665 (put 'gnus-group-mail-3-empty-face 'face-alias 'gnus-group-mail-3-empty)
 666 (put 'gnus-group-mail-3-empty-face 'obsolete-face "22.1")
 667
 668 (defface gnus-group-mail-low
 669   '((((class color)
 670       (background dark))
 671      (:foreground "aquamarine2" :bold t))
 672     (((class color)
 673       (background light))
 674      (:foreground "DeepPink4" :bold t))
 675     (t
 676      (:bold t)))
 677   "Low level mailgroup face."
 678   :group 'gnus-group)
 679 ;; backward-compatibility alias
 680 (put 'gnus-group-mail-low-face 'face-alias 'gnus-group-mail-low)
 681 (put 'gnus-group-mail-low-face 'obsolete-face "22.1")
 682
 683 (defface gnus-group-mail-low-empty
 684   '((((class color)
 685       (background dark))
 686      (:foreground "aquamarine2"))
 687     (((class color)
 688       (background light))
 689      (:foreground "DeepPink4"))
 690     (t
 691      (:bold t)))
 692   "Low level empty mailgroup face."
 693   :group 'gnus-group)
 694 ;; backward-compatibility alias
 695 (put 'gnus-group-mail-low-empty-face 'face-alias 'gnus-group-mail-low-empty)
 696 (put 'gnus-group-mail-low-empty-face 'obsolete-face "22.1")
 697
 698 ;; Summary mode faces.
 699
 700 (defface gnus-summary-selected '((t (:underline t)))
 701   "Face used for selected articles."
 702   :group 'gnus-summary)
 703 ;; backward-compatibility alias
 704 (put 'gnus-summary-selected-face 'face-alias 'gnus-summary-selected)
 705 (put 'gnus-summary-selected-face 'obsolete-face "22.1")
 706
 707 (defface gnus-summary-cancelled
 708   '((((class color))
 709      (:foreground "yellow" :background "black")))
 710   "Face used for cancelled articles."
 711   :group 'gnus-summary)
 712 ;; backward-compatibility alias
 713 (put 'gnus-summary-cancelled-face 'face-alias 'gnus-summary-cancelled)
 714 (put 'gnus-summary-cancelled-face 'obsolete-face "22.1")
 715
 716 (defface gnus-summary-high-ticked
 717   '((((class color)
 718       (background dark))
 719      (:foreground "pink" :bold t))
 720     (((class color)
 721       (background light))
 722      (:foreground "firebrick" :bold t))
 723     (t
 724      (:bold t)))
 725   "Face used for high interest ticked articles."
 726   :group 'gnus-summary)
 727 ;; backward-compatibility alias
 728 (put 'gnus-summary-high-ticked-face 'face-alias 'gnus-summary-high-ticked)
 729 (put 'gnus-summary-high-ticked-face 'obsolete-face "22.1")
 730
 731 (defface gnus-summary-low-ticked
 732   '((((class color)
 733       (background dark))
 734      (:foreground "pink" :italic t))
 735     (((class color)
 736       (background light))
 737      (:foreground "firebrick" :italic t))
 738     (t
 739      (:italic t)))
 740   "Face used for low interest ticked articles."
 741   :group 'gnus-summary)
 742 ;; backward-compatibility alias
 743 (put 'gnus-summary-low-ticked-face 'face-alias 'gnus-summary-low-ticked)
 744 (put 'gnus-summary-low-ticked-face 'obsolete-face "22.1")
 745
 746 (defface gnus-summary-normal-ticked
 747   '((((class color)
 748       (background dark))
 749      (:foreground "pink"))
 750     (((class color)
 751       (background light))
 752      (:foreground "firebrick"))
 753     (t
 754      ()))
 755   "Face used for normal interest ticked articles."
 756   :group 'gnus-summary)
 757 ;; backward-compatibility alias
 758 (put 'gnus-summary-normal-ticked-face 'face-alias 'gnus-summary-normal-ticked)
 759 (put 'gnus-summary-normal-ticked-face 'obsolete-face "22.1")
 760
 761 (defface gnus-summary-high-ancient
 762   '((((class color)
 763       (background dark))
 764      (:foreground "SkyBlue" :bold t))
 765     (((class color)
 766       (background light))
 767      (:foreground "RoyalBlue" :bold t))
 768     (t
 769      (:bold t)))
 770   "Face used for high interest ancient articles."
 771   :group 'gnus-summary)
 772 ;; backward-compatibility alias
 773 (put 'gnus-summary-high-ancient-face 'face-alias 'gnus-summary-high-ancient)
 774 (put 'gnus-summary-high-ancient-face 'obsolete-face "22.1")
 775
 776 (defface gnus-summary-low-ancient
 777   '((((class color)
 778       (background dark))
 779      (:foreground "SkyBlue" :italic t))
 780     (((class color)
 781       (background light))
 782      (:foreground "RoyalBlue" :italic t))
 783     (t
 784      (:italic t)))
 785   "Face used for low interest ancient articles."
 786   :group 'gnus-summary)
 787 ;; backward-compatibility alias
 788 (put 'gnus-summary-low-ancient-face 'face-alias 'gnus-summary-low-ancient)
 789 (put 'gnus-summary-low-ancient-face 'obsolete-face "22.1")
 790
 791 (defface gnus-summary-normal-ancient
 792   '((((class color)
 793       (background dark))
 794      (:foreground "SkyBlue"))
 795     (((class color)
 796       (background light))
 797      (:foreground "RoyalBlue"))
 798     (t
 799      ()))
 800   "Face used for normal interest ancient articles."
 801   :group 'gnus-summary)
 802 ;; backward-compatibility alias
 803 (put 'gnus-summary-normal-ancient-face 'face-alias 'gnus-summary-normal-ancient)
 804 (put 'gnus-summary-normal-ancient-face 'obsolete-face "22.1")
 805
 806 (defface gnus-summary-high-undownloaded
 807    '((((class color)
 808        (background light))
 809       (:bold t :foreground "cyan4"))
 810      (((class color) (background dark))
 811       (:bold t :foreground "LightGray"))
 812      (t (:inverse-video t :bold t)))
 813   "Face used for high interest uncached articles."
 814   :group 'gnus-summary)
 815 ;; backward-compatibility alias
 816 (put 'gnus-summary-high-undownloaded-face 'face-alias 'gnus-summary-high-undownloaded)
 817 (put 'gnus-summary-high-undownloaded-face 'obsolete-face "22.1")
 818
 819 (defface gnus-summary-low-undownloaded
 820    '((((class color)
 821        (background light))
 822       (:italic t :foreground "cyan4" :bold nil))
 823      (((class color) (background dark))
 824       (:italic t :foreground "LightGray" :bold nil))
 825      (t (:inverse-video t :italic t)))
 826   "Face used for low interest uncached articles."
 827   :group 'gnus-summary)
 828 ;; backward-compatibility alias
 829 (put 'gnus-summary-low-undownloaded-face 'face-alias 'gnus-summary-low-undownloaded)
 830 (put 'gnus-summary-low-undownloaded-face 'obsolete-face "22.1")
 831
 832 (defface gnus-summary-normal-undownloaded
 833    '((((class color)
 834        (background light))
 835       (:foreground "cyan4" :bold nil))
 836      (((class color) (background dark))
 837       (:foreground "LightGray" :bold nil))
 838      (t (:inverse-video t)))
 839   "Face used for normal interest uncached articles."
 840   :group 'gnus-summary)
 841 ;; backward-compatibility alias
 842 (put 'gnus-summary-normal-undownloaded-face 'face-alias 'gnus-summary-normal-undownloaded)
 843 (put 'gnus-summary-normal-undownloaded-face 'obsolete-face "22.1")
 844
 845 (defface gnus-summary-high-unread
 846   '((t
 847      (:bold t)))
 848   "Face used for high interest unread articles."
 849   :group 'gnus-summary)
 850 ;; backward-compatibility alias
 851 (put 'gnus-summary-high-unread-face 'face-alias 'gnus-summary-high-unread)
 852 (put 'gnus-summary-high-unread-face 'obsolete-face "22.1")
 853
 854 (defface gnus-summary-low-unread
 855   '((t
 856      (:italic t)))
 857   "Face used for low interest unread articles."
 858   :group 'gnus-summary)
 859 ;; backward-compatibility alias
 860 (put 'gnus-summary-low-unread-face 'face-alias 'gnus-summary-low-unread)
 861 (put 'gnus-summary-low-unread-face 'obsolete-face "22.1")
 862
 863 (defface gnus-summary-normal-unread
 864   '((t
 865      ()))
 866   "Face used for normal interest unread articles."
 867   :group 'gnus-summary)
 868 ;; backward-compatibility alias
 869 (put 'gnus-summary-normal-unread-face 'face-alias 'gnus-summary-normal-unread)
 870 (put 'gnus-summary-normal-unread-face 'obsolete-face "22.1")
 871
 872 (defface gnus-summary-high-read
 873   '((((class color)
 874       (background dark))
 875      (:foreground "PaleGreen"
 876                   :bold t))
 877     (((class color)
 878       (background light))
 879      (:foreground "DarkGreen"
 880                   :bold t))
 881     (t
 882      (:bold t)))
 883   "Face used for high interest read articles."
 884   :group 'gnus-summary)
 885 ;; backward-compatibility alias
 886 (put 'gnus-summary-high-read-face 'face-alias 'gnus-summary-high-read)
 887 (put 'gnus-summary-high-read-face 'obsolete-face "22.1")
 888
 889 (defface gnus-summary-low-read
 890   '((((class color)
 891       (background dark))
 892      (:foreground "PaleGreen"
 893                   :italic t))
 894     (((class color)
 895       (background light))
 896      (:foreground "DarkGreen"
 897                   :italic t))
 898     (t
 899      (:italic t)))
 900   "Face used for low interest read articles."
 901   :group 'gnus-summary)
 902 ;; backward-compatibility alias
 903 (put 'gnus-summary-low-read-face 'face-alias 'gnus-summary-low-read)
 904 (put 'gnus-summary-low-read-face 'obsolete-face "22.1")
 905
 906 (defface gnus-summary-normal-read
 907   '((((class color)
 908       (background dark))
 909      (:foreground "PaleGreen"))
 910     (((class color)
 911       (background light))
 912      (:foreground "DarkGreen"))
 913     (t
 914      ()))
 915   "Face used for normal interest read articles."
 916   :group 'gnus-summary)
 917 ;; backward-compatibility alias
 918 (put 'gnus-summary-normal-read-face 'face-alias 'gnus-summary-normal-read)
 919 (put 'gnus-summary-normal-read-face 'obsolete-face "22.1")
 920
 921
 922 ;;;
 923 ;;; Gnus buffers
 924 ;;;
 925
 926 (defvar gnus-buffers nil)
 927
 928 (defun gnus-get-buffer-create (name)
 929   "Do the same as `get-buffer-create', but store the created buffer."
 930   (or (get-buffer name)
 931       (car (push (get-buffer-create name) gnus-buffers))))
 932
 933 (defun gnus-add-buffer ()
 934   "Add the current buffer to the list of Gnus buffers."
 935   (push (current-buffer) gnus-buffers))
 936
 937 (defmacro gnus-kill-buffer (buffer)
 938   "Kill BUFFER and remove from the list of Gnus buffers."
 939   `(let ((buf ,buffer))
 940      (when (gnus-buffer-exists-p buf)
 941        (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
 942        (kill-buffer buf))))
 943
 944 (defun gnus-buffers ()
 945   "Return a list of live Gnus buffers."
 946   (while (and gnus-buffers
 947               (not (buffer-name (car gnus-buffers))))
 948     (pop gnus-buffers))
 949   (let ((buffers gnus-buffers))
 950     (while (cdr buffers)
 951       (if (buffer-name (cadr buffers))
 952           (pop buffers)
 953         (setcdr buffers (cddr buffers)))))
 954   gnus-buffers)
 955
 956 ;;; Splash screen.
 957
 958 (defvar gnus-group-buffer "*Group*")
 959
 960 (autoload 'gnus-play-jingle "gnus-audio")
 961
 962 (defface gnus-splash
 963   '((((class color)
 964       (background dark))
 965      (:foreground "#cccccc"))
 966     (((class color)
 967       (background light))
 968      (:foreground "#888888"))
 969     (t
 970      ()))
 971   "Face for the splash screen."
 972   :group 'gnus-start)
 973 ;; backward-compatibility alias
 974 (put 'gnus-splash-face 'face-alias 'gnus-splash)
 975 (put 'gnus-splash-face 'obsolete-face "22.1")
 976
 977 (defun gnus-splash ()
 978   (save-excursion
 979     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
 980     (let ((buffer-read-only nil))
 981       (erase-buffer)
 982       (unless gnus-inhibit-startup-message
 983         (gnus-group-startup-message)
 984         (sit-for 0)
 985         (when gnus-play-startup-jingle
 986           (gnus-play-jingle))))))
 987
 988 (defun gnus-indent-rigidly (start end arg)
 989   "Indent rigidly using only spaces and no tabs."
 990   (save-excursion
 991     (save-restriction
 992       (narrow-to-region start end)
 993       (let ((tab-width 8))
 994         (indent-rigidly start end arg)
 995         ;; We translate tabs into spaces -- not everybody uses
 996         ;; an 8-character tab.
 997         (goto-char (point-min))
 998         (while (search-forward "\t" nil t)
 999           (replace-match "        " t t))))))
1000
1001 (defvar gnus-simple-splash nil)
1002
1003 ;;(format "%02x%02x%02x" 114 66 20) "724214"
1004
1005 (defvar gnus-logo-color-alist
1006   '((flame "#cc3300" "#ff2200")
1007     (pine "#c0cc93" "#f8ffb8")
1008     (moss "#a1cc93" "#d2ffb8")
1009     (irish "#04cc90" "#05ff97")
1010     (sky "#049acc" "#05deff")
1011     (tin "#6886cc" "#82b6ff")
1012     (velvet "#7c68cc" "#8c82ff")
1013     (grape "#b264cc" "#cf7df")
1014     (labia "#cc64c2" "#fd7dff")
1015     (berry "#cc6485" "#ff7db5")
1016     (dino "#724214" "#1e3f03")
1017     (oort "#cccccc" "#888888")
1018     (storm "#666699" "#99ccff")
1019     (pdino "#9999cc" "#99ccff")
1020     (purp "#9999cc" "#666699")
1021     (no "#ff0000" "#ffff00")
1022     (neutral "#b4b4b4" "#878787")
1023     (september "#bf9900" "#ffcc00"))
1024   "Color alist used for the Gnus logo.")
1025
1026 (defcustom gnus-logo-color-style 'no
1027   "*Color styles used for the Gnus logo."
1028   :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
1029                            gnus-logo-color-alist))
1030   :group 'gnus-xmas)
1031
1032 (defvar gnus-logo-colors
1033   (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
1034   "Colors used for the Gnus logo.")
1035
1036 (declare-function image-size "image.c" (spec &optional pixels frame))
1037
1038 (defun gnus-group-startup-message (&optional x y)
1039   "Insert startup message in current buffer."
1040   ;; Insert the message.
1041   (erase-buffer)
1042   (cond
1043    ((and
1044      (fboundp 'find-image)
1045      (display-graphic-p)
1046      ;; Make sure the library defining `image-load-path' is loaded
1047      ;; (`find-image' is autoloaded) (and discard the result).  Else, we may
1048      ;; get "defvar ignored because image-load-path is let-bound" when calling
1049      ;; `find-image' below.
1050      (or (find-image '(nil (:type xpm :file "gnus.xpm"))) t)
1051      (let* ((data-directory (nnheader-find-etc-directory "images/gnus"))
1052             (image-load-path (cond (data-directory
1053                                     (list data-directory))
1054                                    ((boundp 'image-load-path)
1055                                     (symbol-value 'image-load-path))
1056                                    (t load-path)))
1057             (image (find-image
1058                     `((:type svg :file "gnus.svg")
1059                       (:type png :file "gnus.png")
1060                       (:type xpm :file "gnus.xpm"
1061                              :color-symbols
1062                              (("thing" . ,(car gnus-logo-colors))
1063                               ("shadow" . ,(cadr gnus-logo-colors))
1064                               ("oort" . "#eeeeee")
1065                               ("background" . ,(face-background 'default))))
1066                       (:type pbm :file "gnus.pbm"
1067                              ;; Account for the pbm's blackground.
1068                              :background ,(face-foreground 'gnus-splash)
1069                              :foreground ,(face-background 'default))
1070                       (:type xbm :file "gnus.xbm"
1071                              ;; Account for the xbm's blackground.
1072                              :background ,(face-foreground 'gnus-splash)
1073                              :foreground ,(face-background 'default))))))
1074        (when image
1075          (let ((size (image-size image)))
1076            (insert-char ?\n (max 0 (round (- (window-height)
1077                                              (or y (cdr size)) 1) 2)))
1078            (insert-char ?\  (max 0 (round (- (window-width)
1079                                              (or x (car size))) 2)))
1080            (insert-image image))
1081          (setq gnus-simple-splash nil)
1082          t))))
1083    (t
1084     (insert
1085      (format "              %s
1086           _    ___ _             _
1087           _ ___ __ ___  __    _ ___
1088           __   _     ___    __  ___
1089               _           ___     _
1090              _  _ __             _
1091              ___   __            _
1092                    __           _
1093                     _      _   _
1094                    _      _    _
1095                       _  _    _
1096                   __  ___
1097                  _   _ _     _
1098                 _   _
1099               _    _
1100              _    _
1101             _
1102           __
1103
1104 "
1105              ""))
1106     ;; And then hack it.
1107     (gnus-indent-rigidly (point-min) (point-max)
1108                          (/ (max (- (window-width) (or x 46)) 0) 2))
1109     (goto-char (point-min))
1110     (forward-line 1)
1111     (let* ((pheight (count-lines (point-min) (point-max)))
1112            (wheight (window-height))
1113            (rest (- wheight pheight)))
1114       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
1115     ;; Fontify some.
1116     (put-text-property (point-min) (point-max) 'face 'gnus-splash)
1117     (setq gnus-simple-splash t)))
1118   (goto-char (point-min))
1119   (setq mode-line-buffer-identification (concat " " gnus-version))
1120   (set-buffer-modified-p t))
1121
1122 (eval-when (load)
1123   (let ((command (format "%s" this-command)))
1124     (when (string-match "gnus" command)
1125       (if (string-match "gnus-other-frame" command)
1126           (gnus-get-buffer-create gnus-group-buffer)
1127         (gnus-splash)))))
1128
1129 ;;; Do the rest.
1130
1131 (require 'gnus-util)
1132 (require 'nnheader)
1133
1134 (defcustom gnus-parameters nil
1135   "Alist of group parameters.
1136
1137 For example:
1138    ((\"mail\\\\..*\"  (gnus-show-threads nil)
1139                   (gnus-use-scoring nil)
1140                   (gnus-summary-line-format
1141                         \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
1142                   (gcc-self . t)
1143                   (display . all))
1144      (\"mail\\\\.me\" (gnus-use-scoring  t))
1145      (\"list\\\\..*\" (total-expire . t)
1146                   (broken-reply-to . t)))"
1147   :version "22.1"
1148   :group 'gnus-group-various
1149   :type '(repeat (cons regexp
1150                        (repeat sexp))))
1151
1152 (defcustom gnus-parameters-case-fold-search 'default
1153   "If it is t, ignore case of group names specified in `gnus-parameters'.
1154 If it is nil, don't ignore case.  If it is `default', which is for the
1155 backward compatibility, use the value of `case-fold-search'."
1156   :version "22.1"
1157   :group 'gnus-group-various
1158   :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
1159                  (const :tag "Use `case-fold-search'" default)
1160                  (const nil)
1161                  (const t)))
1162
1163 (defvar gnus-group-parameters-more nil)
1164
1165 (defmacro gnus-define-group-parameter (param &rest rest)
1166   "Define a group parameter PARAM.
1167 REST is a plist of following:
1168 :type               One of `bool', `list' or nil.
1169 :function           The name of the function.
1170 :function-document  The documentation of the function.
1171 :parameter-type     The type for customizing the parameter.
1172 :parameter-document The documentation for the parameter.
1173 :variable           The name of the variable.
1174 :variable-document  The documentation for the variable.
1175 :variable-group     The group for customizing the variable.
1176 :variable-type      The type for customizing the variable.
1177 :variable-default   The default value of the variable."
1178   (let* ((type (plist-get rest :type))
1179          (parameter-type (plist-get rest :parameter-type))
1180          (parameter-document (plist-get rest :parameter-document))
1181          (function (or (plist-get rest :function)
1182                        (intern (format "gnus-parameter-%s" param))))
1183          (function-document (or (plist-get rest :function-document) ""))
1184          (variable (or (plist-get rest :variable)
1185                        (intern (format "gnus-parameter-%s-alist" param))))
1186          (variable-document (or (plist-get rest :variable-document) ""))
1187          (variable-group (plist-get rest :variable-group))
1188          (variable-type (or (plist-get rest :variable-type)
1189                             `(quote (repeat
1190                                      (list (regexp :tag "Group")
1191                                            ,(car (cdr parameter-type)))))))
1192          (variable-default (plist-get rest :variable-default)))
1193     (list
1194      'progn
1195      `(defcustom ,variable ,variable-default
1196         ,variable-document
1197         :group 'gnus-group-parameter
1198         :group ',variable-group
1199         :type ,variable-type)
1200      `(setq gnus-group-parameters-more
1201             (delq (assq ',param gnus-group-parameters-more)
1202                   gnus-group-parameters-more))
1203      `(add-to-list 'gnus-group-parameters-more
1204                    (list ',param
1205                          ,parameter-type
1206                          ,parameter-document))
1207      (if (eq type 'bool)
1208          `(defun ,function (name)
1209             ,function-document
1210             (let ((params (gnus-group-find-parameter name))
1211                   val)
1212               (cond
1213                ((memq ',param params)
1214                 t)
1215                ((setq val (assq ',param params))
1216                 (cdr val))
1217                ((stringp ,variable)
1218                 (string-match ,variable name))
1219                (,variable
1220                 (let ((alist ,variable)
1221                       elem value)
1222                   (while (setq elem (pop alist))
1223                     (when (and name
1224                                (string-match (car elem) name))
1225                       (setq alist nil
1226                             value (cdr elem))))
1227                   (if (consp value) (car value) value))))))
1228        `(defun ,function (name)
1229           ,function-document
1230           (and name
1231                (or (gnus-group-find-parameter name ',param ,(and type t))
1232                    (let ((alist ,variable)
1233                          elem value)
1234                      (while (setq elem (pop alist))
1235                        (when (and name
1236                                   (string-match (car elem) name))
1237                          (setq alist nil
1238                                value (cdr elem))))
1239                      ,(if type
1240                           'value
1241                         '(if (consp value) (car value) value))))))))))
1242
1243 (defcustom gnus-home-directory "~/"
1244   "Directory variable that specifies the \"home\" directory.
1245 All other Gnus file and directory variables are initialized from this variable."
1246   :group 'gnus-files
1247   :type 'directory)
1248
1249 (defcustom gnus-directory (or (getenv "SAVEDIR")
1250                               (nnheader-concat gnus-home-directory "News/"))
1251   "*Directory variable from which all other Gnus file variables are derived.
1252
1253 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1254 This means that other directory variables that are initialized from
1255 this variable won't be set properly if you set this variable in `.gnus.el'.
1256 Set this variable in `.emacs' instead."
1257   :group 'gnus-files
1258   :type 'directory)
1259
1260 (defcustom gnus-default-directory nil
1261   "*Default directory for all Gnus buffers."
1262   :group 'gnus-files
1263   :type '(choice (const :tag "current" nil)
1264                  directory))
1265
1266 ;; Site dependent variables.  These variables should be defined in
1267 ;; paths.el.
1268
1269 (defvar gnus-default-nntp-server nil
1270   "Specify a default NNTP server.
1271 This variable should be defined in paths.el, and should never be set
1272 by the user.
1273 If you want to change servers, you should use `gnus-select-method'.
1274 See the documentation to that variable.")
1275
1276 ;; Don't touch this variable.
1277 (defvar gnus-nntp-service "nntp"
1278   "NNTP service name (\"nntp\" or 119).
1279 This is an obsolete variable, which is scarcely used.  If you use an
1280 nntp server for your newsgroup and want to change the port number
1281 used to 899, you would say something along these lines:
1282
1283  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1284
1285 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1286   "A file with only the name of the nntp server in it."
1287   :group 'gnus-files
1288   :group 'gnus-server
1289   :type 'file)
1290
1291 (defun gnus-getenv-nntpserver ()
1292   "Find default nntp server.
1293 Check the NNTPSERVER environment variable and the
1294 `gnus-nntpserver-file' file."
1295   (or (getenv "NNTPSERVER")
1296       (and (file-readable-p gnus-nntpserver-file)
1297            (with-temp-buffer
1298              (insert-file-contents gnus-nntpserver-file)
1299              (when (re-search-forward "[^ \t\n\r]+" nil t)
1300                (match-string 0))))))
1301
1302 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1303 ;; starting or even loading Gnus.
1304 ;;;###autoload(when (fboundp 'custom-autoload)
1305 ;;;###autoload  (custom-autoload 'gnus-select-method "gnus"))
1306
1307 (defcustom gnus-select-method
1308   (condition-case nil
1309       (nconc
1310        (list 'nntp (or (condition-case nil
1311                            (gnus-getenv-nntpserver)
1312                          (error nil))
1313                        (when (and gnus-default-nntp-server
1314                                   (not (string= gnus-default-nntp-server "")))
1315                          gnus-default-nntp-server)
1316                        "news"))
1317        (if (or (null gnus-nntp-service)
1318                (equal gnus-nntp-service "nntp"))
1319            nil
1320          (list gnus-nntp-service)))
1321     (error nil))
1322   "Default method for selecting a newsgroup.
1323 This variable should be a list, where the first element is how the
1324 news is to be fetched, the second is the address.
1325
1326 For instance, if you want to get your news via \"flab.flab.edu\" using
1327 NNTP, you could say:
1328
1329 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1330
1331 If you want to use your local spool, say:
1332
1333 \(setq gnus-select-method (list 'nnspool (system-name)))
1334
1335 If you use this variable, you must set `gnus-nntp-server' to nil.
1336
1337 There is a lot more to know about select methods and virtual servers -
1338 see the manual for details."
1339   :group 'gnus-server
1340   :group 'gnus-start
1341   :initialize 'custom-initialize-default
1342   :type 'gnus-select-method)
1343
1344 (defcustom gnus-message-archive-method "archive"
1345   "*Method used for archiving messages you've sent.
1346 This should be a mail method.
1347
1348 See also `gnus-update-message-archive-method'."
1349   :group 'gnus-server
1350   :group 'gnus-message
1351   :type '(choice (const :tag "Default archive method" "archive")
1352                  gnus-select-method))
1353
1354 (defcustom gnus-update-message-archive-method nil
1355   "Non-nil means always update the saved \"archive\" method.
1356
1357 The archive method is initially set according to the value of
1358 `gnus-message-archive-method' and is saved in the \"~/.newsrc.eld\" file
1359 so that it may be used as a real method of the server which is named
1360 \"archive\" ever since.  If it once has been saved, it will never be
1361 updated if the value of this variable is nil, even if you change the
1362 value of `gnus-message-archive-method' afterward.  If you want the
1363 saved \"archive\" method to be updated whenever you change the value of
1364 `gnus-message-archive-method', set this variable to a non-nil value."
1365   :version "23.1" ;; No Gnus
1366   :group 'gnus-server
1367   :group 'gnus-message
1368   :type 'boolean)
1369
1370 (defcustom gnus-message-archive-group nil
1371   "*Name of the group in which to save the messages you've written.
1372 This can either be a string; a list of strings; or an alist
1373 of regexps/functions/forms to be evaluated to return a string (or a list
1374 of strings).  The functions are called with the name of the current
1375 group (or nil) as a parameter.
1376
1377 If you want to save your mail in one group and the news articles you
1378 write in another group, you could say something like:
1379
1380  \(setq gnus-message-archive-group
1381         '((if (message-news-p)
1382               \"misc-news\"
1383             \"misc-mail\")))
1384
1385 Normally the group names returned by this variable should be
1386 unprefixed -- which implicitly means \"store on the archive server\".
1387 However, you may wish to store the message on some other server.  In
1388 that case, just return a fully prefixed name of the group --
1389 \"nnml+private:mail.misc\", for instance."
1390   :group 'gnus-message
1391   :type '(choice (const :tag "none" nil)
1392                  function
1393                  sexp
1394                  string))
1395
1396 (defcustom gnus-secondary-servers nil
1397   "List of NNTP servers that the user can choose between interactively.
1398 To make Gnus query you for a server, you have to give `gnus' a
1399 non-numeric prefix - `C-u M-x gnus', in short."
1400   :group 'gnus-server
1401   :type '(repeat string))
1402
1403 (defcustom gnus-nntp-server nil
1404   "*The name of the host running the NNTP server.
1405 This variable is semi-obsolete.  Use the `gnus-select-method'
1406 variable instead."
1407   :group 'gnus-server
1408   :type '(choice (const :tag "disable" nil)
1409                  string))
1410
1411 (defcustom gnus-secondary-select-methods nil
1412   "A list of secondary methods that will be used for reading news.
1413 This is a list where each element is a complete select method (see
1414 `gnus-select-method').
1415
1416 If, for instance, you want to read your mail with the nnml back end,
1417 you could set this variable:
1418
1419 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1420   :group 'gnus-server
1421   :type '(repeat gnus-select-method))
1422
1423 (defvar gnus-backup-default-subscribed-newsgroups
1424   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1425   "Default default new newsgroups the first time Gnus is run.
1426 Should be set in paths.el, and shouldn't be touched by the user.")
1427
1428 (defcustom gnus-local-domain nil
1429   "Local domain name without a host name.
1430 The DOMAINNAME environment variable is used instead if it is defined.
1431 If the function `system-name' returns the full Internet name, there is
1432 no need to set this variable."
1433   :group 'gnus-message
1434   :type '(choice (const :tag "default" nil)
1435                  string))
1436
1437 (defvar gnus-local-organization nil
1438   "String with a description of what organization (if any) the user belongs to.
1439 Obsolete variable; use `message-user-organization' instead.")
1440
1441 ;; Customization variables
1442
1443 (defcustom gnus-refer-article-method nil
1444   "Preferred method for fetching an article by Message-ID.
1445 If you are reading news from the local spool (with nnspool), fetching
1446 articles by Message-ID is painfully slow.  By setting this method to an
1447 nntp method, you might get acceptable results.
1448
1449 The value of this variable must be a valid select method as discussed
1450 in the documentation of `gnus-select-method'.
1451
1452 It can also be a list of select methods, as well as the special symbol
1453 `current', which means to use the current select method.  If it is a
1454 list, Gnus will try all the methods in the list until it finds a match."
1455   :group 'gnus-server
1456   :type '(choice (const :tag "default" nil)
1457                  (const current)
1458                  (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1459                  gnus-select-method
1460                  (repeat :menu-tag "Try multiple"
1461                          :tag "Multiple"
1462                          :value (current (nnweb "refer" (nnweb-type google)))
1463                          (choice :tag "Method"
1464                                  (const current)
1465                                  (const :tag "Google"
1466                                         (nnweb "refer" (nnweb-type google)))
1467                                  gnus-select-method))))
1468
1469 (defcustom gnus-group-faq-directory
1470   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1471     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1472     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1473     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1474     "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1475     "/ftp@rtfm.mit.edu:/pub/usenet/"
1476     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1477     "/ftp@ftp.sunet.se:/pub/usenet/"
1478     "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1479     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1480     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1481   "*Directory where the group FAQs are stored.
1482 This will most commonly be on a remote machine, and the file will be
1483 fetched by ange-ftp.
1484
1485 This variable can also be a list of directories.  In that case, the
1486 first element in the list will be used by default.  The others can
1487 be used when being prompted for a site.
1488
1489 Note that Gnus uses an aol machine as the default directory.  If this
1490 feels fundamentally unclean, just think of it as a way to finally get
1491 something of value back from them.
1492
1493 If the default site is too slow, try one of these:
1494
1495    North America: mirrors.aol.com                /pub/rtfm/usenet
1496                   ftp.seas.gwu.edu               /pub/rtfm
1497                   rtfm.mit.edu                   /pub/usenet
1498    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1499                   src.doc.ic.ac.uk               /usenet/news-FAQS
1500                   ftp.sunet.se                   /pub/usenet
1501                   ftp.pasteur.fr                 /pub/FAQ
1502    Asia:          nctuccca.nctu.edu.tw           /pub/Documents/rtfm/usenet-by-group/
1503                   hwarang.postech.ac.kr          /pub/usenet
1504                   ftp.hk.super.net               /mirror/faqs"
1505   :group 'gnus-group-various
1506   :type '(choice directory
1507                  (repeat directory)))
1508
1509 (defcustom gnus-group-charter-alist
1510   '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1511     ("de" . (concat "http://purl.net/charta/" name ".html"))
1512     ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1513     ("england" . (concat "http://england.news-admin.org/charters/" name))
1514     ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1515     ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1516                         (gnus-replace-in-string name "europa\\." "") ".html"))
1517     ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1518     ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1519     ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1520     ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1521     ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1522     ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1523     ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1524     ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1525                     (gnus-replace-in-string name "\\." "_") ".html"))
1526     ("milw" . (concat "http://usenet.mil.wi.us/"
1527                       (gnus-replace-in-string name "milw\\." "") "-charter"))
1528     ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1529     ("netins" . (concat "http://www.netins.net/usenet/charter/"
1530                         (gnus-replace-in-string name "\\." "-") "-charter.html")))
1531   "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1532 When FORM is evaluated `name' is bound to the name of the group."
1533   :version "22.1"
1534   :group 'gnus-group-various
1535   :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1536 (put 'gnus-group-charter-alist 'risky-local-variable t)
1537
1538 (defcustom gnus-group-fetch-control-use-browse-url nil
1539   "*Non-nil means that control messages are displayed using `browse-url'.
1540 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1541 group."
1542   :version "22.1"
1543   :group 'gnus-group-various
1544   :type 'boolean)
1545
1546 (defcustom gnus-use-cross-reference t
1547   "*Non-nil means that cross referenced articles will be marked as read.
1548 If nil, ignore cross references.  If t, mark articles as read in
1549 subscribed newsgroups.  If neither t nor nil, mark as read in all
1550 newsgroups."
1551   :group 'gnus-server
1552   :type '(choice (const :tag "off" nil)
1553                  (const :tag "subscribed" t)
1554                  (sexp :format "all"
1555                        :value always)))
1556
1557 (defcustom gnus-process-mark ?#
1558   "*Process mark."
1559   :group 'gnus-group-visual
1560   :group 'gnus-summary-marks
1561   :type 'character)
1562
1563 (defcustom gnus-large-newsgroup 200
1564   "*The number of articles which indicates a large newsgroup.
1565 If the number of articles in a newsgroup is greater than this value,
1566 confirmation is required for selecting the newsgroup.
1567 If it is nil, no confirmation is required."
1568   :group 'gnus-group-select
1569   :type '(choice (const :tag "No limit" nil)
1570                  integer))
1571
1572 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v)))
1573   "*Non-nil means that the default name of a file to save articles in is the group name.
1574 If it's nil, the directory form of the group name is used instead.
1575
1576 If this variable is a list, and the list contains the element
1577 `not-score', long file names will not be used for score files; if it
1578 contains the element `not-save', long file names will not be used for
1579 saving; and if it contains the element `not-kill', long file names
1580 will not be used for kill files.
1581
1582 Note that the default for this variable varies according to what system
1583 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1584 to nil while on all other systems it defaults to t."
1585   :group 'gnus-start
1586   :type '(radio (sexp :format "Non-nil\n"
1587                       :match (lambda (widget value)
1588                                (and value (not (listp value))))
1589                       :value t)
1590                 (const nil)
1591                 (checklist (const :format "%v " not-score)
1592                            (const :format "%v " not-save)
1593                            (const not-kill))))
1594
1595 (defcustom gnus-kill-files-directory gnus-directory
1596   "*Name of the directory where kill files will be stored (default \"~/News\")."
1597   :group 'gnus-score-files
1598   :group 'gnus-score-kill
1599   :type 'directory)
1600
1601 (defcustom gnus-save-score nil
1602   "*If non-nil, save group scoring info."
1603   :group 'gnus-score-various
1604   :group 'gnus-start
1605   :type 'boolean)
1606
1607 (defcustom gnus-use-undo t
1608   "*If non-nil, allow undoing in Gnus group mode buffers."
1609   :group 'gnus-meta
1610   :type 'boolean)
1611
1612 (defcustom gnus-use-adaptive-scoring nil
1613   "*If non-nil, use some adaptive scoring scheme.
1614 If a list, then the values `word' and `line' are meaningful.  The
1615 former will perform adaption on individual words in the subject
1616 header while `line' will perform adaption on several headers."
1617   :group 'gnus-meta
1618   :group 'gnus-score-adapt
1619   :type '(set (const word) (const line)))
1620
1621 (defcustom gnus-use-cache 'passive
1622   "*If nil, Gnus will ignore the article cache.
1623 If `passive', it will allow entering (and reading) articles
1624 explicitly entered into the cache.  If anything else, use the
1625 cache to the full extent of the law."
1626   :group 'gnus-meta
1627   :group 'gnus-cache
1628   :type '(choice (const :tag "off" nil)
1629                  (const :tag "passive" passive)
1630                  (const :tag "active" t)))
1631
1632 (defcustom gnus-use-trees nil
1633   "*If non-nil, display a thread tree buffer."
1634   :group 'gnus-meta
1635   :type 'boolean)
1636
1637 (defcustom gnus-keep-backlog 20
1638   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1639 If it is a number N, then Gnus will only keep the last N articles
1640 read.  If it is neither nil nor a number, Gnus will keep all read
1641 articles.  This is not a good idea."
1642   :group 'gnus-meta
1643   :type '(choice (const :tag "off" nil)
1644                  integer
1645                  (sexp :format "all"
1646                        :value t)))
1647
1648 (defcustom gnus-use-nocem nil
1649   "*If non-nil, Gnus will read NoCeM cancel messages.
1650 You can also set this variable to a positive number as a group level.
1651 In that case, Gnus scans NoCeM messages when checking new news if this
1652 value is not exceeding a group level that you specify as the prefix
1653 argument to some commands, e.g. `gnus', `gnus-group-get-new-news', etc.
1654 Otherwise, Gnus does not scan NoCeM messages if you specify a group
1655 level to those commands."
1656   :group 'gnus-meta
1657   :type '(choice
1658           (const :tag "off" nil)
1659           (const :tag "on" t)
1660           (list :convert-widget
1661                 (lambda (widget)
1662                   (list 'integer :tag "group level"
1663                         :value (if (boundp 'gnus-level-default-subscribed)
1664                                    gnus-level-default-subscribed
1665                                  3))))))
1666
1667 (defcustom gnus-suppress-duplicates nil
1668   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1669   :group 'gnus-meta
1670   :type 'boolean)
1671
1672 (defcustom gnus-use-scoring t
1673   "*If non-nil, enable scoring."
1674   :group 'gnus-meta
1675   :type 'boolean)
1676
1677 (defcustom gnus-summary-prepare-exit-hook
1678   '(gnus-summary-expire-articles)
1679   "*A hook called when preparing to exit from the summary buffer.
1680 It calls `gnus-summary-expire-articles' by default."
1681   :group 'gnus-summary-exit
1682   :type 'hook)
1683
1684 (defcustom gnus-novice-user t
1685   "*Non-nil means that you are a Usenet novice.
1686 If non-nil, verbose messages may be displayed and confirmations may be
1687 required."
1688   :group 'gnus-meta
1689   :type 'boolean)
1690
1691 (defcustom gnus-expert-user nil
1692   "*Non-nil means that you will never be asked for confirmation about anything.
1693 That doesn't mean *anything* anything; particularly destructive
1694 commands will still require prompting."
1695   :group 'gnus-meta
1696   :type 'boolean)
1697
1698 (defcustom gnus-interactive-catchup t
1699   "*If non-nil, require your confirmation when catching up a group."
1700   :group 'gnus-group-select
1701   :type 'boolean)
1702
1703 (defcustom gnus-interactive-exit t
1704   "*If non-nil, require your confirmation when exiting Gnus."
1705   :group 'gnus-exit
1706   :type 'boolean)
1707
1708 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1709   "*Function for extracting address components from a From header.
1710 Two pre-defined function exist: `gnus-extract-address-components',
1711 which is the default, quite fast, and too simplistic solution, and
1712 `mail-extract-address-components', which works much better, but is
1713 slower."
1714   :group 'gnus-summary-format
1715   :type '(radio (function-item gnus-extract-address-components)
1716                 (function-item mail-extract-address-components)
1717                 (function :tag "Other")))
1718
1719 (defcustom gnus-carpal nil
1720   "*If non-nil, display clickable icons."
1721   :group 'gnus-meta
1722   :type 'boolean)
1723
1724 (defcustom gnus-shell-command-separator ";"
1725   "String used to separate shell commands."
1726   :group 'gnus-files
1727   :type 'string)
1728
1729 (defcustom gnus-valid-select-methods
1730   '(("nntp" post address prompt-address physical-address)
1731     ("nnspool" post address)
1732     ("nnvirtual" post-mail virtual prompt-address)
1733     ("nnmbox" mail respool address)
1734     ("nnml" post-mail respool address)
1735     ("nnmh" mail respool address)
1736     ("nndir" post-mail prompt-address physical-address)
1737     ("nneething" none address prompt-address physical-address)
1738     ("nndoc" none address prompt-address)
1739     ("nnbabyl" mail address respool)
1740     ("nnkiboze" post virtual)
1741     ("nnsoup" post-mail address)
1742     ("nndraft" post-mail)
1743     ("nnfolder" mail respool address)
1744     ("nngateway" post-mail address prompt-address physical-address)
1745     ("nnweb" none)
1746     ("nngoogle" post)
1747     ("nnslashdot" post)
1748     ("nnultimate" none)
1749     ("nnrss" none)
1750     ("nnwfm" none)
1751     ("nnwarchive" none)
1752     ("nnlistserv" none)
1753     ("nnagent" post-mail)
1754     ("nnimap" post-mail address prompt-address physical-address)
1755     ("nnmaildir" mail respool address)
1756     ("nnnil" none))
1757   "*An alist of valid select methods.
1758 The first element of each list lists should be a string with the name
1759 of the select method.  The other elements may be the category of
1760 this method (i. e., `post', `mail', `none' or whatever) or other
1761 properties that this method has (like being respoolable).
1762 If you implement a new select method, all you should have to change is
1763 this variable.  I think."
1764   :group 'gnus-server
1765   :type '(repeat (group (string :tag "Name")
1766                         (radio-button-choice (const :format "%v " post)
1767                                              (const :format "%v " mail)
1768                                              (const :format "%v " none)
1769                                              (const post-mail))
1770                         (checklist :inline t
1771                                    (const :format "%v " address)
1772                                    (const :format "%v " prompt-address)
1773                                    (const :format "%v " physical-address)
1774                                    (const :format "%v " virtual)
1775                                    (const respool)))))
1776
1777 (defun gnus-redefine-select-method-widget ()
1778   "Recomputes the select-method widget based on the value of
1779 `gnus-valid-select-methods'."
1780   (define-widget 'gnus-select-method 'list
1781     "Widget for entering a select method."
1782     :value '(nntp "")
1783     :tag "Select Method"
1784     :args `((choice :tag "Method"
1785                     ,@(mapcar (lambda (entry)
1786                                 (list 'const :format "%v\n"
1787                                       (intern (car entry))))
1788                               gnus-valid-select-methods)
1789                     (symbol :tag "other"))
1790             (string :tag "Address")
1791             (repeat :tag "Options"
1792                     :inline t
1793                     (list :format "%v"
1794                           variable
1795                           (sexp :tag "Value"))))))
1796
1797 (gnus-redefine-select-method-widget)
1798
1799 (defcustom gnus-updated-mode-lines '(group article summary tree)
1800   "List of buffers that should update their mode lines.
1801 The list may contain the symbols `group', `article', `tree' and
1802 `summary'.  If the corresponding symbol is present, Gnus will keep
1803 that mode line updated with information that may be pertinent.
1804 If this variable is nil, screen refresh may be quicker."
1805   :group 'gnus-various
1806   :type '(set (const group)
1807               (const article)
1808               (const summary)
1809               (const tree)))
1810
1811 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1812 (defcustom gnus-mode-non-string-length nil
1813   "*Max length of mode-line non-string contents.
1814 If this is nil, Gnus will take space as is needed, leaving the rest
1815 of the mode line intact.  Note that the default of nil is unlikely
1816 to be desirable; see the manual for further details."
1817   :group 'gnus-various
1818   :type '(choice (const nil)
1819                  integer))
1820
1821 ;; There should be special validation for this.
1822 (define-widget 'gnus-email-address 'string
1823   "An email address.")
1824
1825 (gnus-define-group-parameter
1826  to-address
1827  :function-document
1828  "Return GROUP's to-address."
1829  :variable-document
1830  "*Alist of group regexps and correspondent to-addresses."
1831  :variable-group gnus-group-parameter
1832  :parameter-type '(gnus-email-address :tag "To Address")
1833  :parameter-document "\
1834 This will be used when doing followups and posts.
1835
1836 This is primarily useful in mail groups that represent closed
1837 mailing lists--mailing lists where it's expected that everybody that
1838 writes to the mailing list is subscribed to it.  Since using this
1839 parameter ensures that the mail only goes to the mailing list itself,
1840 it means that members won't receive two copies of your followups.
1841
1842 Using `to-address' will actually work whether the group is foreign or
1843 not.  Let's say there's a group on the server that is called
1844 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1845 articles from a mail-to-news gateway.  Posting directly to this group
1846 is therefore impossible--you have to send mail to the mailing list
1847 address instead.
1848
1849 The gnus-group-split mail splitting mechanism will behave as if this
1850 address was listed in gnus-group-split Addresses (see below).")
1851
1852 (gnus-define-group-parameter
1853  to-list
1854  :function-document
1855  "Return GROUP's to-list."
1856  :variable-document
1857  "*Alist of group regexps and correspondent to-lists."
1858  :variable-group gnus-group-parameter
1859  :parameter-type '(gnus-email-address :tag "To List")
1860  :parameter-document "\
1861 This address will be used when doing a `a' in the group.
1862
1863 It is totally ignored when doing a followup--except that if it is
1864 present in a news group, you'll get mail group semantics when doing
1865 `f'.
1866
1867 The gnus-group-split mail splitting mechanism will behave as if this
1868 address was listed in gnus-group-split Addresses (see below).")
1869
1870 (gnus-define-group-parameter
1871  subscribed
1872  :type bool
1873  :function-document
1874  "Return GROUP's subscription status."
1875  :variable-document
1876  "*Groups which are automatically considered subscribed."
1877  :variable-group gnus-group-parameter
1878  :parameter-type '(const :tag "Subscribed" t)
1879  :parameter-document "\
1880 Gnus assumed that you are subscribed to the To/List address.
1881
1882 When constructing a list of subscribed groups using
1883 `gnus-find-subscribed-addresses', Gnus includes the To address given
1884 above, or the list address (if the To address has not been set).")
1885
1886 (gnus-define-group-parameter
1887  auto-expire
1888  :type bool
1889  :function gnus-group-auto-expirable-p
1890  :function-document
1891  "Check whether GROUP is auto-expirable or not."
1892  :variable gnus-auto-expirable-newsgroups
1893  :variable-default nil
1894  :variable-document
1895  "*Groups in which to automatically mark read articles as expirable.
1896 If non-nil, this should be a regexp that should match all groups in
1897 which to perform auto-expiry.  This only makes sense for mail groups."
1898  :variable-group nnmail-expire
1899  :variable-type '(choice (const nil)
1900                          regexp)
1901  :parameter-type '(const :tag "Automatic Expire" t)
1902  :parameter-document
1903  "All articles that are read will be marked as expirable.")
1904
1905 (gnus-define-group-parameter
1906  total-expire
1907  :type bool
1908  :function gnus-group-total-expirable-p
1909  :function-document
1910  "Check whether GROUP is total-expirable or not."
1911  :variable gnus-total-expirable-newsgroups
1912  :variable-default nil
1913  :variable-document
1914  "*Groups in which to perform expiry of all read articles.
1915 Use with extreme caution.  All groups that match this regexp will be
1916 expiring - which means that all read articles will be deleted after
1917 \(say) one week.  (This only goes for mail groups and the like, of
1918 course.)"
1919  :variable-group nnmail-expire
1920  :variable-type '(choice (const nil)
1921                          regexp)
1922  :parameter-type '(const :tag "Total Expire" t)
1923  :parameter-document
1924  "All read articles will be put through the expiry process
1925
1926 This happens even if they are not marked as expirable.
1927 Use with caution.")
1928
1929 (gnus-define-group-parameter
1930  charset
1931  :function-document
1932  "Return the default charset of GROUP."
1933  :variable gnus-group-charset-alist
1934  :variable-default
1935  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1936    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1937    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1938    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1939    ("\\(^\\|:\\)relcom\\>" koi8-r)
1940    ("\\(^\\|:\\)fido7\\>" koi8-r)
1941    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1942    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1943    ("\\(^\\|:\\)han\\>" euc-kr)
1944    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1945    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1946    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1947  :variable-document
1948  "Alist of regexps (to match group names) and default charsets to be used when reading."
1949  :variable-group gnus-charset
1950  :variable-type '(repeat (list (regexp :tag "Group")
1951                                (symbol :tag "Charset")))
1952  :parameter-type '(symbol :tag "Charset")
1953  :parameter-document "\
1954 The default charset to use in the group.")
1955
1956 (gnus-define-group-parameter
1957  post-method
1958  :type list
1959  :function-document
1960  "Return a posting method for GROUP."
1961  :variable gnus-post-method-alist
1962  :variable-document
1963  "Alist of regexps (to match group names) and method to be used when
1964 posting an article."
1965  :variable-group gnus-group-foreign
1966  :parameter-type
1967  '(choice :tag "Posting Method"
1968           (const :tag "Use native server" native)
1969           (const :tag "Use current server" current)
1970           (list :convert-widget
1971                 (lambda (widget)
1972                   (list 'sexp :tag "Methods"
1973                         :value gnus-select-method))))
1974  :parameter-document
1975  "Posting method for this group.")
1976
1977 (gnus-define-group-parameter
1978  large-newsgroup-initial
1979  :type integer
1980  :function-document
1981  "Return GROUP's initial input of the number of articles."
1982  :variable-document
1983  "*Alist of group regexps and its initial input of the number of articles."
1984  :variable-group gnus-group-parameter
1985  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1986                           (const :tag "All" nil)
1987                           (integer))
1988  :parameter-document "\
1989
1990 This number will be prompted as the initial value of the number of
1991 articles to list when the group is a large newsgroup (see
1992 `gnus-large-newsgroup').  If it is nil, the default value is the
1993 total number of articles in the group.")
1994
1995 ;; The Gnus registry's ignored groups
1996 (gnus-define-group-parameter
1997  registry-ignore
1998  :type list
1999  :function-document
2000  "Whether this group should be ignored by the registry."
2001  :variable gnus-registry-ignored-groups
2002  :variable-default nil
2003  :variable-document
2004  "*Groups in which the registry should be turned off."
2005  :variable-group gnus-registry
2006  :variable-type '(repeat
2007                   (list
2008                    (regexp :tag "Group Name Regular Expression")
2009                    (boolean :tag "Ignored")))
2010
2011  :parameter-type '(boolean :tag "Group Ignored by the Registry")
2012  :parameter-document
2013  "Whether the Gnus Registry should ignore this group.")
2014
2015 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
2016 (defcustom gnus-install-group-spam-parameters t
2017   "*Disable the group parameters for spam detection.
2018 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
2019   :version "22.1"
2020   :type 'boolean
2021   :group 'gnus-start)
2022
2023 (when gnus-install-group-spam-parameters
2024   (defvar gnus-group-spam-classification-spam t
2025     "Spam group classification (requires spam.el).
2026 This group contains spam messages.  On summary entry, unread messages
2027 will be marked as spam.  On summary exit, the specified spam
2028 processors will be invoked on spam-marked messages, then those
2029 messages will be expired, so the spam processor will only see a
2030 spam-marked message once.")
2031
2032   (defvar gnus-group-spam-classification-ham 'ask
2033     "The ham value for the spam group parameter (requires spam.el).
2034 On summary exit, the specified ham processors will be invoked on
2035 ham-marked messages.  Exercise caution, since the ham processor will
2036 see the same message more than once because there is no ham message
2037 registry.")
2038
2039   (gnus-define-group-parameter
2040    spam-contents
2041    :type list
2042    :function-document
2043    "The spam type (spam, ham, or neither) of the group."
2044    :variable gnus-spam-newsgroup-contents
2045    :variable-default nil
2046    :variable-document
2047    "*Group classification (spam, ham, or neither).  Only
2048 meaningful when spam.el is loaded.  If non-nil, this should be a
2049 list of group name regexps associated with a classification for
2050 each one.  In spam groups, new articles are marked as spam on
2051 summary entry.  There is other behavior associated with ham and
2052 no classification when spam.el is loaded - see the manual."
2053    :variable-group spam
2054    :variable-type '(repeat
2055                     (list :tag "Group contents spam/ham classification"
2056                           (regexp :tag "Group")
2057                           (choice
2058                            (variable-item gnus-group-spam-classification-spam)
2059                            (variable-item gnus-group-spam-classification-ham)
2060                            (const :tag "Unclassified" nil))))
2061
2062    :parameter-type '(list :tag "Group contents spam/ham classification"
2063                           (choice :tag "Group contents classification for spam sorting"
2064                                   (variable-item gnus-group-spam-classification-spam)
2065                                   (variable-item gnus-group-spam-classification-ham)
2066                                   (const :tag "Unclassified" nil)))
2067    :parameter-document
2068    "The spam classification (spam, ham, or neither) of this group.
2069 When a spam group is entered, all unread articles are marked as
2070 spam.  There is other behavior associated with ham and no
2071 classification when spam.el is loaded - see the manual.")
2072
2073   (gnus-define-group-parameter
2074    spam-resend-to
2075    :type list
2076    :function-document
2077    "The address to get spam resent (through spam-report-resend)."
2078    :variable gnus-spam-resend-to
2079    :variable-default nil
2080    :variable-document
2081    "The address to get spam resent (through spam-report-resend)."
2082    :variable-group spam
2083    :variable-type '(repeat
2084                     (list :tag "Group address for resending spam"
2085                           (regexp :tag "Group")
2086                           (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2087    :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2088    :parameter-document
2089    "The address to get spam resent (through spam-report-resend).")
2090
2091   (gnus-define-group-parameter
2092    ham-resend-to
2093    :type list
2094    :function-document
2095    "The address to get ham resent (through spam-report-resend)."
2096    :variable gnus-ham-resend-to
2097    :variable-default nil
2098    :variable-document
2099    "The address to get ham resent (through spam-report-resend)."
2100    :variable-group spam
2101    :variable-type '(repeat
2102                     (list :tag "Group address for resending ham"
2103                           (regexp :tag "Group")
2104                           (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2105    :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2106    :parameter-document
2107    "The address to get ham resent (through spam-report-resend).")
2108
2109   (defvar gnus-group-spam-exit-processor-ifile "ifile"
2110     "OBSOLETE: The ifile summary exit spam processor.")
2111
2112   (defvar gnus-group-spam-exit-processor-stat "stat"
2113     "OBSOLETE: The spam-stat summary exit spam processor.")
2114
2115   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
2116     "OBSOLETE: The Bogofilter summary exit spam processor.")
2117
2118   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
2119     "OBSOLETE: The Blacklist summary exit spam processor.")
2120
2121   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
2122     "OBSOLETE: The Gmane reporting summary exit spam processor.
2123 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
2124
2125   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
2126     "OBSOLETE: The spamoracle summary exit spam processor.")
2127
2128   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
2129     "OBSOLETE: The ifile summary exit ham processor.
2130 Only applicable to non-spam (unclassified and ham) groups.")
2131
2132   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
2133     "OBSOLETE: The Bogofilter summary exit ham processor.
2134 Only applicable to non-spam (unclassified and ham) groups.")
2135
2136   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
2137     "OBSOLETE: The spam-stat summary exit ham processor.
2138 Only applicable to non-spam (unclassified and ham) groups.")
2139
2140   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
2141     "OBSOLETE: The whitelist summary exit ham processor.
2142 Only applicable to non-spam (unclassified and ham) groups.")
2143
2144   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
2145     "OBSOLETE: The BBDB summary exit ham processor.
2146 Only applicable to non-spam (unclassified and ham) groups.")
2147
2148   (defvar gnus-group-ham-exit-processor-copy "copy"
2149     "OBSOLETE: The ham copy exit ham processor.
2150 Only applicable to non-spam (unclassified and ham) groups.")
2151
2152   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
2153     "OBSOLETE: The spamoracle summary exit ham processor.
2154 Only applicable to non-spam (unclassified and ham) groups.")
2155
2156   (gnus-define-group-parameter
2157    spam-process
2158    :type list
2159    :parameter-type
2160    '(choice
2161      :tag "Spam Summary Exit Processor"
2162      :value nil
2163      (list :tag "Spam Summary Exit Processor Choices"
2164            (set
2165             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2166             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2167             (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2168             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2169             (const :tag "Spam: Resend Message"(spam spam-use-resend))
2170             (const :tag "Spam: ifile"         (spam spam-use-ifile))
2171             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2172             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2173             (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2174             (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2175             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2176             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2177             (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2178             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2179             (const :tag "Ham: Resend Message" (ham spam-use-resend))
2180             (const :tag "Ham: ifile"          (ham spam-use-ifile))
2181             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2182             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2183             (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2184             (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2185             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2186             (variable-item gnus-group-spam-exit-processor-ifile)
2187             (variable-item gnus-group-spam-exit-processor-stat)
2188             (variable-item gnus-group-spam-exit-processor-bogofilter)
2189             (variable-item gnus-group-spam-exit-processor-blacklist)
2190             (variable-item gnus-group-spam-exit-processor-spamoracle)
2191             (variable-item gnus-group-spam-exit-processor-report-gmane)
2192             (variable-item gnus-group-ham-exit-processor-bogofilter)
2193             (variable-item gnus-group-ham-exit-processor-ifile)
2194             (variable-item gnus-group-ham-exit-processor-stat)
2195             (variable-item gnus-group-ham-exit-processor-whitelist)
2196             (variable-item gnus-group-ham-exit-processor-BBDB)
2197             (variable-item gnus-group-ham-exit-processor-spamoracle)
2198             (variable-item gnus-group-ham-exit-processor-copy))))
2199    :function-document
2200    "Which spam or ham processors will be applied when the summary is exited."
2201    :variable gnus-spam-process-newsgroups
2202    :variable-default nil
2203    :variable-document
2204    "*Groups in which to automatically process spam or ham articles with
2205 a backend on summary exit.  If non-nil, this should be a list of group
2206 name regexps that should match all groups in which to do automatic
2207 spam processing, associated with the appropriate processor."
2208    :variable-group spam
2209    :variable-type
2210    '(repeat :tag "Spam/Ham Processors"
2211             (list :tag "Spam Summary Exit Processor Choices"
2212                   (regexp :tag "Group Regexp")
2213                   (set
2214                    :tag "Spam/Ham Summary Exit Processor"
2215                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2216                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2217                    (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2218                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2219                    (const :tag "Spam: Resend Message"(spam spam-use-resend))
2220                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
2221                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2222                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2223                    (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2224                    (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2225                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2226                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2227                    (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2228                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2229                    (const :tag "Ham: Resend Message" (ham spam-use-resend))
2230                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
2231                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2232                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2233                    (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2234                    (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2235                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2236                    (variable-item gnus-group-spam-exit-processor-ifile)
2237                    (variable-item gnus-group-spam-exit-processor-stat)
2238                    (variable-item gnus-group-spam-exit-processor-bogofilter)
2239                    (variable-item gnus-group-spam-exit-processor-blacklist)
2240                    (variable-item gnus-group-spam-exit-processor-spamoracle)
2241                    (variable-item gnus-group-spam-exit-processor-report-gmane)
2242                    (variable-item gnus-group-ham-exit-processor-bogofilter)
2243                    (variable-item gnus-group-ham-exit-processor-ifile)
2244                    (variable-item gnus-group-ham-exit-processor-stat)
2245                    (variable-item gnus-group-ham-exit-processor-whitelist)
2246                    (variable-item gnus-group-ham-exit-processor-BBDB)
2247                    (variable-item gnus-group-ham-exit-processor-spamoracle)
2248                    (variable-item gnus-group-ham-exit-processor-copy))))
2249
2250    :parameter-document
2251    "Which spam or ham processors will be applied when the summary is exited.")
2252
2253   (gnus-define-group-parameter
2254    spam-autodetect
2255    :type list
2256    :parameter-type
2257    '(boolean :tag "Spam autodetection")
2258    :function-document
2259    "Should spam be autodetected (with spam-split) in this group?"
2260    :variable gnus-spam-autodetect
2261    :variable-default nil
2262    :variable-document
2263    "*Groups in which spam should be autodetected when they are entered.
2264    Only unseen articles will be examined, unless
2265    spam-autodetect-recheck-messages is set."
2266    :variable-group spam
2267    :variable-type
2268    '(repeat
2269      :tag "Autodetection setting"
2270      (list
2271       (regexp :tag "Group Regexp")
2272       boolean))
2273    :parameter-document
2274    "Spam autodetection.
2275 Only unseen articles will be examined, unless
2276 spam-autodetect-recheck-messages is set.")
2277
2278   (gnus-define-group-parameter
2279    spam-autodetect-methods
2280    :type list
2281    :parameter-type
2282    '(choice :tag "Spam autodetection-specific methods"
2283      (const none)
2284      (const default)
2285      (set :tag "Use specific methods"
2286           (variable-item spam-use-blacklist)
2287           (variable-item spam-use-gmane-xref)
2288           (variable-item spam-use-regex-headers)
2289           (variable-item spam-use-regex-body)
2290           (variable-item spam-use-whitelist)
2291           (variable-item spam-use-BBDB)
2292           (variable-item spam-use-ifile)
2293           (variable-item spam-use-spamoracle)
2294           (variable-item spam-use-crm114)
2295           (variable-item spam-use-spamassassin)
2296           (variable-item spam-use-spamassassin-headers)
2297           (variable-item spam-use-bsfilter)
2298           (variable-item spam-use-bsfilter-headers)
2299           (variable-item spam-use-stat)
2300           (variable-item spam-use-blackholes)
2301           (variable-item spam-use-hashcash)
2302           (variable-item spam-use-bogofilter-headers)
2303           (variable-item spam-use-bogofilter)))
2304    :function-document
2305    "Methods to be used for autodetection in each group"
2306    :variable gnus-spam-autodetect-methods
2307    :variable-default nil
2308    :variable-document
2309    "*Methods for autodetecting spam per group.
2310 Requires the spam-autodetect parameter.  Only unseen articles
2311 will be examined, unless spam-autodetect-recheck-messages is
2312 set."
2313    :variable-group spam
2314    :variable-type
2315    '(repeat
2316      :tag "Autodetection methods"
2317      (list
2318       (regexp :tag "Group Regexp")
2319       (choice
2320        (const none)
2321        (const default)
2322        (set :tag "Use specific methods"
2323         (variable-item spam-use-blacklist)
2324         (variable-item spam-use-gmane-xref)
2325         (variable-item spam-use-regex-headers)
2326         (variable-item spam-use-regex-body)
2327         (variable-item spam-use-whitelist)
2328         (variable-item spam-use-BBDB)
2329         (variable-item spam-use-ifile)
2330         (variable-item spam-use-spamoracle)
2331         (variable-item spam-use-crm114)
2332         (variable-item spam-use-stat)
2333         (variable-item spam-use-blackholes)
2334         (variable-item spam-use-hashcash)
2335         (variable-item spam-use-spamassassin)
2336         (variable-item spam-use-spamassassin-headers)
2337         (variable-item spam-use-bsfilter)
2338         (variable-item spam-use-bsfilter-headers)
2339         (variable-item spam-use-bogofilter-headers)
2340         (variable-item spam-use-bogofilter)))))
2341      :parameter-document
2342    "Spam autodetection methods.
2343 Requires the spam-autodetect parameter.  Only unseen articles
2344 will be examined, unless spam-autodetect-recheck-messages is
2345 set.")
2346
2347   (gnus-define-group-parameter
2348    spam-process-destination
2349    :type list
2350    :parameter-type
2351    '(choice :tag "Destination for spam-processed articles at summary exit"
2352             (string :tag "Move to a group")
2353             (repeat :tag "Move to multiple groups"
2354                     (string :tag "Destination group"))
2355             (const :tag "Expire" nil))
2356    :function-document
2357    "Where spam-processed articles will go at summary exit."
2358    :variable gnus-spam-process-destinations
2359    :variable-default nil
2360    :variable-document
2361    "*Groups in which to explicitly send spam-processed articles to
2362 another group, or expire them (the default).  If non-nil, this should
2363 be a list of group name regexps that should match all groups in which
2364 to do spam-processed article moving, associated with the destination
2365 group or nil for explicit expiration.  This only makes sense for
2366 mail groups."
2367    :variable-group spam
2368    :variable-type
2369    '(repeat
2370      :tag "Spam-processed articles destination"
2371      (list
2372       (regexp :tag "Group Regexp")
2373       (choice
2374        :tag "Destination for spam-processed articles at summary exit"
2375        (string :tag "Move to a group")
2376        (repeat :tag "Move to multiple groups"
2377                (string :tag "Destination group"))
2378        (const :tag "Expire" nil))))
2379    :parameter-document
2380    "Where spam-processed articles will go at summary exit.")
2381
2382   (gnus-define-group-parameter
2383    ham-process-destination
2384    :type list
2385    :parameter-type
2386    '(choice
2387      :tag "Destination for ham articles at summary exit from a spam group"
2388      (string :tag "Move to a group")
2389      (repeat :tag "Move to multiple groups"
2390              (string :tag "Destination group"))
2391      (const :tag "Respool" respool)
2392      (const :tag "Do nothing" nil))
2393    :function-document
2394    "Where ham articles will go at summary exit from a spam group."
2395    :variable gnus-ham-process-destinations
2396    :variable-default nil
2397    :variable-document
2398    "*Groups in which to explicitly send ham articles to
2399 another group, or do nothing (the default).  If non-nil, this should
2400 be a list of group name regexps that should match all groups in which
2401 to do ham article moving, associated with the destination
2402 group or nil for explicit ignoring.  This only makes sense for
2403 mail groups, and only works in spam groups."
2404    :variable-group spam
2405    :variable-type
2406    '(repeat
2407      :tag "Ham articles destination"
2408      (list
2409       (regexp :tag "Group Regexp")
2410       (choice
2411        :tag "Destination for ham articles at summary exit from spam group"
2412        (string :tag "Move to a group")
2413        (repeat :tag "Move to multiple groups"
2414                 (string :tag "Destination group"))
2415        (const :tag "Respool" respool)
2416        (const :tag "Expire" nil))))
2417    :parameter-document
2418    "Where ham articles will go at summary exit from a spam group.")
2419
2420   (gnus-define-group-parameter
2421    ham-marks
2422    :type 'list
2423    :parameter-type '(list :tag "Ham mark choices"
2424                           (set
2425                            (variable-item gnus-del-mark)
2426                            (variable-item gnus-read-mark)
2427                            (variable-item gnus-ticked-mark)
2428                            (variable-item gnus-killed-mark)
2429                            (variable-item gnus-kill-file-mark)
2430                            (variable-item gnus-low-score-mark)))
2431
2432    :parameter-document
2433    "Marks considered ham (positively not spam).  Such articles will be
2434 processed as ham (non-spam) on group exit.  When nil, the global
2435 spam-ham-marks variable takes precedence."
2436    :variable-default '((".*" ((gnus-del-mark
2437                                gnus-read-mark
2438                                gnus-killed-mark
2439                                gnus-kill-file-mark
2440                                gnus-low-score-mark))))
2441    :variable-group spam
2442    :variable-document
2443    "*Groups in which to explicitly set the ham marks to some value.")
2444
2445   (gnus-define-group-parameter
2446    spam-marks
2447    :type 'list
2448    :parameter-type '(list :tag "Spam mark choices"
2449                           (set
2450                            (variable-item gnus-spam-mark)
2451                            (variable-item gnus-killed-mark)
2452                            (variable-item gnus-kill-file-mark)
2453                            (variable-item gnus-low-score-mark)))
2454
2455    :parameter-document
2456    "Marks considered spam.
2457 Such articles will be processed as spam on group exit.  When nil, the global
2458 spam-spam-marks variable takes precedence."
2459    :variable-default '((".*" ((gnus-spam-mark))))
2460    :variable-group spam
2461    :variable-document
2462    "*Groups in which to explicitly set the spam marks to some value."))
2463
2464 (defcustom gnus-group-uncollapsed-levels 1
2465   "Number of group name elements to leave alone when making a short group name."
2466   :group 'gnus-group-visual
2467   :type 'integer)
2468
2469 (defcustom gnus-group-use-permanent-levels nil
2470   "*If non-nil, once you set a level, Gnus will use this level."
2471   :group 'gnus-group-levels
2472   :type 'boolean)
2473
2474 ;; Hooks.
2475
2476 (defcustom gnus-load-hook nil
2477   "A hook run while Gnus is loaded."
2478   :group 'gnus-start
2479   :type 'hook)
2480
2481 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2482   "A hook called to apply kill files to a group.
2483 This hook is intended to apply a kill file to the selected newsgroup.
2484 The function `gnus-apply-kill-file' is called by default.
2485
2486 Since a general kill file is too heavy to use only for a few
2487 newsgroups, I recommend you to use a lighter hook function.  For
2488 example, if you'd like to apply a kill file to articles which contains
2489 a string `rmgroup' in subject in newsgroup `control', you can use the
2490 following hook:
2491
2492  (setq gnus-apply-kill-hook
2493       (list
2494         (lambda ()
2495           (cond ((string-match \"control\" gnus-newsgroup-name)
2496                  (gnus-kill \"Subject\" \"rmgroup\")
2497                  (gnus-expunge \"X\"))))))"
2498   :group 'gnus-score-kill
2499   :options '(gnus-apply-kill-file)
2500   :type 'hook)
2501
2502 (defcustom gnus-group-change-level-function nil
2503   "Function run when a group level is changed.
2504 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2505   :group 'gnus-group-levels
2506   :type '(choice (const nil)
2507                  function))
2508
2509 ;;; Face thingies.
2510
2511 (defcustom gnus-visual
2512   '(summary-highlight group-highlight article-highlight
2513                       mouse-face
2514                       summary-menu group-menu article-menu
2515                       tree-highlight menu highlight
2516                       browse-menu server-menu
2517                       page-marker tree-menu binary-menu pick-menu)
2518   "*Enable visual features.
2519 If `visual' is disabled, there will be no menus and few faces.  Most of
2520 the visual customization options below will be ignored.  Gnus will use
2521 less space and be faster as a result.
2522
2523 This variable can also be a list of visual elements to switch on.  For
2524 instance, to switch off all visual things except menus, you can say:
2525
2526    (setq gnus-visual '(menu))
2527
2528 Valid elements include `summary-highlight', `group-highlight',
2529 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2530 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2531 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2532   :group 'gnus-meta
2533   :group 'gnus-visual
2534   :type '(set (const summary-highlight)
2535               (const group-highlight)
2536               (const article-highlight)
2537               (const mouse-face)
2538               (const summary-menu)
2539               (const group-menu)
2540               (const article-menu)
2541               (const tree-highlight)
2542               (const menu)
2543               (const highlight)
2544               (const browse-menu)
2545               (const server-menu)
2546               (const page-marker)
2547               (const tree-menu)
2548               (const binary-menu)
2549               (const pick-menu)))
2550
2551 ;; Byte-compiler warning.
2552 (defvar gnus-visual)
2553 ;; Find out whether the gnus-visual TYPE is wanted.
2554 (defun gnus-visual-p (&optional type class)
2555   (and gnus-visual                      ; Has to be non-nil, at least.
2556        (if (not type)                   ; We don't care about type.
2557            gnus-visual
2558          (if (listp gnus-visual)        ; It's a list, so we check it.
2559              (or (memq type gnus-visual)
2560                  (memq class gnus-visual))
2561            t))))
2562
2563 (defcustom gnus-mouse-face
2564   (condition-case ()
2565       (if (gnus-visual-p 'mouse-face 'highlight)
2566           (if (boundp 'gnus-mouse-face)
2567               (or gnus-mouse-face 'highlight)
2568             'highlight)
2569         'default)
2570     (error 'highlight))
2571   "*Face used for group or summary buffer mouse highlighting.
2572 The line beneath the mouse pointer will be highlighted with this
2573 face."
2574   :group 'gnus-visual
2575   :type 'face)
2576
2577 (defcustom gnus-article-save-directory gnus-directory
2578   "*Name of the directory articles will be saved in (default \"~/News\")."
2579   :group 'gnus-article-saving
2580   :type 'directory)
2581
2582 (defvar gnus-plugged t
2583   "Whether Gnus is plugged or not.")
2584
2585 (defcustom gnus-agent-cache t
2586   "Controls use of the agent cache while plugged.
2587 When set, Gnus will prefer using the locally stored content rather
2588 than re-fetching it from the server.  You also need to enable
2589 `gnus-agent' for this to have any affect."
2590   :version "22.1"
2591   :group 'gnus-agent
2592   :type 'boolean)
2593
2594 (defcustom gnus-default-charset 'undecided
2595   "Default charset assumed to be used when viewing non-ASCII characters.
2596 This variable is overridden on a group-to-group basis by the
2597 `gnus-group-charset-alist' variable and is only used on groups not
2598 covered by that variable."
2599   :type 'symbol
2600   :group 'gnus-charset)
2601
2602 ;; Fixme: Doc reference to agent.
2603 (defcustom gnus-agent t
2604   "Whether we want to use the Gnus agent or not.
2605
2606 You may customize gnus-agent to disable its use.  However, some
2607 back ends have started to use the agent as a client-side cache.
2608 Disabling the agent may result in noticeable loss of performance."
2609   :version "22.1"
2610   :group 'gnus-agent
2611   :type 'boolean)
2612
2613 (defcustom gnus-other-frame-function 'gnus
2614   "Function called by the command `gnus-other-frame'."
2615   :group 'gnus-start
2616   :type '(choice (function-item gnus)
2617                  (function-item gnus-no-server)
2618                  (function-item gnus-slave)
2619                  (function-item gnus-slave-no-server)))
2620
2621 (defcustom gnus-other-frame-parameters nil
2622   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2623 This should be an alist for Emacs, or a plist for XEmacs."
2624   :group 'gnus-start
2625   :type (if (featurep 'xemacs)
2626             '(repeat (list :inline t :format "%v"
2627                            (symbol :tag "Property")
2628                            (sexp :tag "Value")))
2629           '(repeat (cons :format "%v"
2630                          (symbol :tag "Parameter")
2631                          (sexp :tag "Value")))))
2632
2633 (defcustom gnus-user-agent '(emacs gnus type)
2634   "Which information should be exposed in the User-Agent header.
2635
2636 Can be a list of symbols or a string.  Valid symbols are `gnus'
2637 \(show Gnus version\) and `emacs' \(show Emacs version\).  In
2638 addition to the Emacs version, you can add `codename' \(show
2639 \(S\)XEmacs codename\) or either `config' \(show system
2640 configuration\) or `type' \(show system type\).  If you set it to
2641 a string, be sure to use a valid format, see RFC 2616."
2642
2643   :version "22.1"
2644   :group 'gnus-message
2645   :type '(choice (list (set :inline t
2646                             (const gnus  :tag "Gnus version")
2647                             (const emacs :tag "Emacs version")
2648                             (choice :tag "system"
2649                                     (const type   :tag "system type")
2650                                     (const config :tag "system configuration"))
2651                             (const codename :tag "Emacs codename")))
2652                  (string)))
2653
2654 ;; Convert old (< 2005-01-10) symbol type values:
2655 (when (symbolp gnus-user-agent)
2656   (setq gnus-user-agent
2657         (cond ((eq gnus-user-agent 'emacs-gnus-config)
2658                '(emacs gnus config))
2659               ((eq gnus-user-agent 'emacs-gnus-type)
2660                '(emacs gnus type))
2661               ((eq gnus-user-agent 'emacs-gnus)
2662                '(emacs gnus))
2663               ((eq gnus-user-agent 'gnus)
2664                '(gnus))
2665               (t gnus-user-agent)))
2666   (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2667   (sit-for 1)
2668   (if (get 'gnus-user-agent 'saved-value)
2669       (customize-save-variable 'gnus-user-agent gnus-user-agent)
2670     (gnus-message 1 "Edit your init file to make this change permanent.")
2671     (sit-for 2)))
2672
2673 \f
2674 ;;; Internal variables
2675
2676 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2677 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2678 (defvar gnus-agent-method-p-cache nil
2679   ; Reset each time gnus-agent-covered-methods is changed else
2680   ; gnus-agent-method-p may mis-report a methods status.
2681   )
2682 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2683 (defvar gnus-draft-meta-information-header "X-Draft-From")
2684 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2685 (defvar gnus-original-article-buffer " *Original Article*")
2686 (defvar gnus-newsgroup-name nil)
2687 (defvar gnus-ephemeral-servers nil)
2688 (defvar gnus-server-method-cache nil)
2689
2690 (defvar gnus-agent-fetching nil
2691   "Whether Gnus agent is in fetching mode.")
2692
2693 (defvar gnus-agent-covered-methods nil
2694   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2695
2696 (defvar gnus-command-method nil
2697   "Dynamically bound variable that says what the current back end is.")
2698
2699 (defvar gnus-current-select-method nil
2700   "The current method for selecting a newsgroup.")
2701
2702 (defvar gnus-tree-buffer "*Tree*"
2703   "Buffer where Gnus thread trees are displayed.")
2704
2705 ;; Dummy variable.
2706 (defvar gnus-use-generic-from nil)
2707
2708 ;; Variable holding the user answers to all method prompts.
2709 (defvar gnus-method-history nil)
2710
2711 ;; Variable holding the user answers to all mail method prompts.
2712 (defvar gnus-mail-method-history nil)
2713
2714 ;; Variable holding the user answers to all group prompts.
2715 (defvar gnus-group-history nil)
2716
2717 (defvar gnus-server-alist nil
2718   "List of available servers.")
2719
2720 (defcustom gnus-cache-directory
2721   (nnheader-concat gnus-directory "cache/")
2722   "*The directory where cached articles will be stored."
2723   :group 'gnus-cache
2724   :type 'directory)
2725
2726 (defvar gnus-predefined-server-alist
2727   `(("cache"
2728      nnspool "cache"
2729      (nnspool-spool-directory ,gnus-cache-directory)
2730      (nnspool-nov-directory ,gnus-cache-directory)
2731      (nnspool-active-file
2732       ,(nnheader-concat gnus-cache-directory "active"))))
2733   "List of predefined (convenience) servers.")
2734
2735 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2736
2737 (defconst gnus-article-mark-lists
2738   '((marked . tick) (replied . reply)
2739     (expirable . expire) (killed . killed)
2740     (bookmarks . bookmark) (dormant . dormant)
2741     (scored . score) (saved . save)
2742     (cached . cache) (downloadable . download)
2743     (unsendable . unsend) (forwarded . forward)
2744     (recent . recent) (seen . seen)))
2745
2746 (defconst gnus-article-special-mark-lists
2747   '((seen range)
2748     (killed range)
2749     (bookmark tuple)
2750     (score tuple)))
2751
2752 ;; Propagate flags to server, with the following exceptions:
2753 ;; `seen' is private to each gnus installation
2754 ;; `cache' is a internal gnus flag for each gnus installation
2755 ;; `download' is a agent flag private to each gnus installation
2756 ;; `unsend' are for nndraft groups only
2757 ;; `score' is not a proper mark
2758 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2759 (defconst gnus-article-unpropagated-mark-lists
2760   '(seen cache download unsend score bookmark)
2761   "Marks that shouldn't be propagated to back ends.
2762 Typical marks are those that make no sense in a standalone back end,
2763 such as a mark that says whether an article is stored in the cache
2764 \(which doesn't make sense in a standalone back end).")
2765
2766 (defvar gnus-headers-retrieved-by nil)
2767 (defvar gnus-article-reply nil)
2768 (defvar gnus-override-method nil)
2769 (defvar gnus-opened-servers nil)
2770
2771 (defvar gnus-current-kill-article nil)
2772
2773 (defvar gnus-have-read-active-file nil)
2774
2775 (defconst gnus-maintainer
2776   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2777   "The mail address of the Gnus maintainers.")
2778
2779 (defvar gnus-info-nodes
2780   '((gnus-group-mode "(gnus)Group Buffer")
2781     (gnus-summary-mode "(gnus)Summary Buffer")
2782     (gnus-article-mode "(gnus)Article Buffer")
2783     (gnus-server-mode "(gnus)Server Buffer")
2784     (gnus-browse-mode "(gnus)Browse Foreign Server")
2785     (gnus-tree-mode "(gnus)Tree Display"))
2786   "Alist of major modes and related Info nodes.")
2787
2788 (defvar gnus-group-buffer "*Group*")
2789 (defvar gnus-summary-buffer "*Summary*")
2790 (defvar gnus-article-buffer "*Article*")
2791 (defvar gnus-server-buffer "*Server*")
2792
2793 (defvar gnus-slave nil
2794   "Whether this Gnus is a slave or not.")
2795
2796 (defvar gnus-batch-mode nil
2797   "Whether this Gnus is running in batch mode or not.")
2798
2799 (defvar gnus-variable-list
2800   '(gnus-newsrc-options gnus-newsrc-options-n
2801                         gnus-newsrc-last-checked-date
2802                         gnus-newsrc-alist gnus-server-alist
2803                         gnus-killed-list gnus-zombie-list
2804                         gnus-topic-topology gnus-topic-alist
2805                         gnus-format-specs)
2806   "Gnus variables saved in the quick startup file.")
2807
2808 (defvar gnus-newsrc-alist nil
2809   "Assoc list of read articles.
2810 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2811
2812 (defvar gnus-registry-alist nil
2813   "Assoc list of registry data.
2814 gnus-registry.el will populate this if it's loaded.")
2815
2816 (defvar gnus-newsrc-hashtb nil
2817   "Hashtable of `gnus-newsrc-alist'.")
2818
2819 (defvar gnus-killed-list nil
2820   "List of killed newsgroups.")
2821
2822 (defvar gnus-killed-hashtb nil
2823   "Hash table equivalent of `gnus-killed-list'.")
2824
2825 (defvar gnus-zombie-list nil
2826   "List of almost dead newsgroups.")
2827
2828 (defvar gnus-description-hashtb nil
2829   "Descriptions of newsgroups.")
2830
2831 (defvar gnus-list-of-killed-groups nil
2832   "List of newsgroups that have recently been killed by the user.")
2833
2834 (defvar gnus-active-hashtb nil
2835   "Hashtable of active articles.")
2836
2837 (defvar gnus-moderated-hashtb nil
2838   "Hashtable of moderated newsgroups.")
2839
2840 ;; Save window configuration.
2841 (defvar gnus-prev-winconf nil)
2842
2843 (defvar gnus-reffed-article-number nil)
2844
2845 (defvar gnus-dead-summary nil)
2846
2847 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2848   "Regexp matching invalid groups.")
2849
2850 (defvar gnus-other-frame-object nil
2851   "A frame object which will be created by `gnus-other-frame'.")
2852
2853 ;;; End of variables.
2854
2855 ;; Define some autoload functions Gnus might use.
2856 (eval-and-compile
2857
2858   ;; This little mapcar goes through the list below and marks the
2859   ;; symbols in question as autoloaded functions.
2860   (mapc
2861    (lambda (package)
2862      (let ((interactive (nth 1 (memq ':interactive package))))
2863        (mapcar
2864         (lambda (function)
2865           (let (keymap)
2866             (when (consp function)
2867               (setq keymap (car (memq 'keymap function)))
2868               (setq function (car function)))
2869             (unless (fboundp function)
2870               (autoload function (car package) nil interactive keymap))))
2871         (if (eq (nth 1 package) ':interactive)
2872             (nthcdr 3 package)
2873           (cdr package)))))
2874    '(("info" :interactive t Info-goto-node)
2875      ("pp" pp-to-string)
2876      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2877      ("ps-print" ps-print-preprint)
2878      ("message" :interactive t
2879       message-send-and-exit message-yank-original)
2880      ("babel" babel-as-string)
2881      ("nnmail" nnmail-split-fancy nnmail-article-group)
2882      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2883      ;; This is only used in message.el, which has an autoload.
2884      ("rmailout" rmail-output)
2885      ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2886      ("rmail" rmail-count-new-messages rmail-show-message
2887       ;; Next two only used in gnus-util.
2888       rmail-summary-exists rmail-select-summary)
2889      ;; Only used in gnus-util, which has an autoload.
2890      ("rmailsum" rmail-update-summary)
2891      ("gnus-audio" :interactive t gnus-audio-play)
2892      ("gnus-xmas" gnus-xmas-splash)
2893      ("gnus-soup" :interactive t
2894       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2895       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2896      ("nnsoup" nnsoup-pack-replies)
2897      ("score-mode" :interactive t gnus-score-mode)
2898      ("gnus-mh" gnus-summary-save-article-folder
2899       gnus-Folder-save-name gnus-folder-save-name)
2900      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2901      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2902       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2903       gnus-demon-add-disconnection gnus-demon-add-handler
2904       gnus-demon-remove-handler)
2905      ("gnus-demon" :interactive t
2906       gnus-demon-init gnus-demon-cancel)
2907      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2908       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2909       gnus-face-from-file)
2910      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2911       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2912      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2913       gnus-nocem-unwanted-article-p)
2914      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2915       gnus-server-server-name)
2916      ("gnus-srvr" gnus-browse-foreign-server)
2917      ("gnus-cite" :interactive t
2918       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2919       gnus-article-hide-citation gnus-article-fill-cited-article
2920       gnus-article-hide-citation-in-followups)
2921      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2922       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2923       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2924      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2925       gnus-cache-possibly-remove-articles gnus-cache-request-article
2926       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2927       gnus-cache-enter-remove-article gnus-cached-article-p
2928       gnus-cache-open gnus-cache-close gnus-cache-update-article
2929       gnus-cache-articles-in-group)
2930      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2931       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2932      ("gnus-score" :interactive t
2933       gnus-summary-increase-score gnus-summary-set-score
2934       gnus-summary-raise-thread gnus-summary-raise-same-subject
2935       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2936       gnus-summary-lower-thread gnus-summary-lower-same-subject
2937       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2938       gnus-summary-current-score gnus-score-delta-default
2939       gnus-score-flush-cache gnus-score-close
2940       gnus-possibly-score-headers gnus-score-followup-article
2941       gnus-score-followup-thread)
2942      ("gnus-score"
2943       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2944       gnus-current-score-file-nondirectory gnus-score-adaptive
2945       gnus-score-find-trace gnus-score-file-name)
2946      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2947      ("gnus-topic" :interactive t gnus-topic-mode)
2948      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2949       gnus-subscribe-topics)
2950      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2951      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2952      ("gnus-uu" :interactive t
2953       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2954       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2955       gnus-uu-mark-by-regexp gnus-uu-mark-all
2956       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2957       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2958       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2959       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2960       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2961       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2962       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2963       gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2964      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2965      ("gnus-msg" (gnus-summary-send-map keymap)
2966       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2967      ("gnus-msg" :interactive t
2968       gnus-group-post-news gnus-group-mail gnus-group-news
2969       gnus-summary-post-news gnus-summary-news-other-window
2970       gnus-summary-followup gnus-summary-followup-with-original
2971       gnus-summary-cancel-article gnus-summary-supersede-article
2972       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2973       gnus-summary-mail-forward gnus-summary-mail-other-window
2974       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2975       gnus-summary-wide-reply gnus-summary-followup-to-mail
2976       gnus-summary-followup-to-mail-with-original gnus-bug
2977       gnus-summary-wide-reply-with-original
2978       gnus-summary-post-forward gnus-summary-wide-reply-with-original
2979       gnus-summary-post-forward)
2980      ("gnus-picon" :interactive t gnus-treat-from-picon)
2981      ("smiley" :interactive t smiley-region)
2982      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2983      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2984       gnus-list-of-unread-articles gnus-list-of-read-articles
2985       gnus-offer-save-summaries gnus-make-thread-indent-array
2986       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2987       gnus-summary-skip-intangible gnus-summary-article-number
2988       gnus-data-header gnus-data-find)
2989      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2990       gnus-group-list-groups gnus-group-first-unread-group
2991       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2992       gnus-group-setup-buffer gnus-group-get-new-news
2993       gnus-group-make-help-group gnus-group-update-group
2994       gnus-group-iterate gnus-group-group-name)
2995      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2996       gnus-backlog-remove-article)
2997      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2998       gnus-article-prepare gnus-article-set-window-start
2999       gnus-article-next-page gnus-article-prev-page
3000       gnus-request-article-this-buffer gnus-article-mode
3001       gnus-article-setup-buffer gnus-narrow-to-page
3002       gnus-article-delete-invisible-text gnus-treat-article)
3003      ("gnus-art" :interactive t
3004       gnus-article-hide-headers gnus-article-hide-boring-headers
3005       gnus-article-treat-overstrike
3006       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
3007       gnus-article-display-x-face gnus-article-de-quoted-unreadable
3008       gnus-article-de-base64-unreadable
3009       gnus-article-decode-HZ
3010       gnus-article-wash-html
3011       gnus-article-unsplit-urls
3012       gnus-article-hide-pem gnus-article-hide-signature
3013       gnus-article-strip-leading-blank-lines gnus-article-date-local
3014       gnus-article-date-original gnus-article-date-lapsed
3015       ;;gnus-article-show-all-headers
3016       gnus-article-edit-mode gnus-article-edit-article
3017       gnus-article-edit-done gnus-article-decode-encoded-words
3018       gnus-start-date-timer gnus-stop-date-timer
3019       gnus-mime-view-all-parts)
3020      ("gnus-int" gnus-request-type)
3021      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
3022       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
3023       gnus-check-reasonable-setup)
3024      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
3025       gnus-dup-enter-articles)
3026      ("gnus-range" gnus-copy-sequence)
3027      ("gnus-eform" gnus-edit-form)
3028      ("gnus-move" :interactive t
3029       gnus-group-move-group-to-server gnus-change-server)
3030      ("gnus-logic" gnus-score-advanced)
3031      ("gnus-undo" gnus-undo-mode gnus-undo-register)
3032      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
3033       gnus-async-prefetch-article gnus-async-prefetch-remove-group
3034       gnus-async-halt-prefetch)
3035      ("gnus-agent" gnus-open-agent gnus-agent-get-function
3036       gnus-agent-save-active gnus-agent-method-p
3037       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
3038       gnus-summary-set-agent-mark gnus-agent-save-group-info
3039       gnus-agent-request-article gnus-agent-retrieve-headers)
3040      ("gnus-agent" :interactive t
3041       gnus-unplugged gnus-agentize gnus-agent-batch)
3042      ("gnus-vm" :interactive t gnus-summary-save-in-vm
3043       gnus-summary-save-article-vm)
3044      ("compface" uncompface)
3045      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
3046      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
3047      ("gnus-mlspl" :interactive t gnus-group-split-setup
3048       gnus-group-split-update)
3049      ("gnus-delay" gnus-delay-initialize))))
3050
3051 ;;; gnus-sum.el thingies
3052
3053
3054 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
3055   "*The format specification of the lines in the summary buffer.
3056
3057 It works along the same lines as a normal formatting string,
3058 with some simple extensions.
3059
3060 %N   Article number, left padded with spaces (string)
3061 %S   Subject (string)
3062 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
3063 %n   Name of the poster (string)
3064 %a   Extracted name of the poster (string)
3065 %A   Extracted address of the poster (string)
3066 %F   Contents of the From: header (string)
3067 %f   Contents of the From: or To: headers (string)
3068 %x   Contents of the Xref: header (string)
3069 %D   Date of the article (string)
3070 %d   Date of the article (string) in DD-MMM format
3071 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
3072 %M   Message-id of the article (string)
3073 %r   References of the article (string)
3074 %c   Number of characters in the article (integer)
3075 %k   Pretty-printed version of the above (string)
3076      For example, \"1.2k\" or \"0.4M\".
3077 %L   Number of lines in the article (integer)
3078 %I   Indentation based on thread level (a string of spaces)
3079 %B   A complex trn-style thread tree (string)
3080      The variables `gnus-sum-thread-*' can be used for customization.
3081 %T   A string with two possible values: 80 spaces if the article
3082      is on thread level two or larger and 0 spaces on level one
3083 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
3084 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
3085 %[   Opening bracket (character, \"[\" or \"<\")
3086 %]   Closing bracket (character, \"]\" or \">\")
3087 %>   Spaces of length thread-level (string)
3088 %<   Spaces of length (- 20 thread-level) (string)
3089 %i   Article score (number)
3090 %z   Article zcore (character)
3091 %t   Number of articles under the current thread (number).
3092 %e   Whether the thread is empty or not (character).
3093 %V   Total thread score (number).
3094 %P   The line number (number).
3095 %O   Download mark (character).
3096 %*   If present, indicates desired cursor position
3097      (instead of after first colon).
3098 %u   User defined specifier.  The next character in the format string should
3099      be a letter.  Gnus will call the function gnus-user-format-function-X,
3100      where X is the letter following %u.  The function will be passed the
3101      current header as argument.  The function should return a string, which
3102      will be inserted into the summary just like information from any other
3103      summary specifier.
3104
3105 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3106 with care.  For reasons of efficiency, Gnus will compute what column
3107 these characters will end up in, and \"hard-code\" that.  This means that
3108 it is invalid to have these specs after a variable-length spec.  Well,
3109 you might not be arrested, but your summary buffer will look strange,
3110 which is bad enough.
3111
3112 The smart choice is to have these specs as far to the left as
3113 possible.
3114
3115 This restriction may disappear in later versions of Gnus.
3116
3117 General format specifiers can also be used.
3118 See Info node `(gnus)Formatting Variables'."
3119   :link '(custom-manual "(gnus)Formatting Variables")
3120   :type 'string
3121   :group 'gnus-summary-format)
3122
3123 ;;;
3124 ;;; Skeleton keymaps
3125 ;;;
3126
3127 (defun gnus-suppress-keymap (keymap)
3128   (suppress-keymap keymap)
3129   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
3130     (while keys
3131       (define-key keymap (pop keys) 'undefined))))
3132
3133 (defvar gnus-article-mode-map
3134   (let ((keymap (make-sparse-keymap)))
3135     (gnus-suppress-keymap keymap)
3136     keymap))
3137 (defvar gnus-summary-mode-map
3138   (let ((keymap (make-keymap)))
3139     (gnus-suppress-keymap keymap)
3140     keymap))
3141 (defvar gnus-group-mode-map
3142   (let ((keymap (make-keymap)))
3143     (gnus-suppress-keymap keymap)
3144     keymap))
3145
3146 \f
3147
3148 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3149 ;; If you want the cursor to go somewhere else, set these two
3150 ;; functions in some startup hook to whatever you want.
3151 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3152 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3153
3154 ;;; Various macros and substs.
3155
3156 (defun gnus-header-from (header)
3157   (mail-header-from header))
3158
3159 (defmacro gnus-gethash (string hashtable)
3160   "Get hash value of STRING in HASHTABLE."
3161   `(symbol-value (intern-soft ,string ,hashtable)))
3162
3163 (defmacro gnus-gethash-safe (string hashtable)
3164   "Get hash value of STRING in HASHTABLE.
3165 Return nil if not defined."
3166   `(let ((sym (intern-soft ,string ,hashtable)))
3167      (and (boundp sym) (symbol-value sym))))
3168
3169 (defmacro gnus-sethash (string value hashtable)
3170   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
3171   `(set (intern ,string ,hashtable) ,value))
3172 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3173
3174 (defmacro gnus-group-unread (group)
3175   "Get the currently computed number of unread articles in GROUP."
3176   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3177
3178 (defmacro gnus-group-entry (group)
3179   "Get the newsrc entry for GROUP."
3180   `(gnus-gethash ,group gnus-newsrc-hashtb))
3181
3182 (defmacro gnus-active (group)
3183   "Get active info on GROUP."
3184   `(gnus-gethash ,group gnus-active-hashtb))
3185
3186 (defmacro gnus-set-active (group active)
3187   "Set GROUP's active info."
3188   `(gnus-sethash ,group ,active gnus-active-hashtb))
3189
3190 ;; Info access macros.
3191
3192 (defmacro gnus-info-group (info)
3193   `(nth 0 ,info))
3194 (defmacro gnus-info-rank (info)
3195   `(nth 1 ,info))
3196 (defmacro gnus-info-read (info)
3197   `(nth 2 ,info))
3198 (defmacro gnus-info-marks (info)
3199   `(nth 3 ,info))
3200 (defmacro gnus-info-method (info)
3201   `(nth 4 ,info))
3202 (defmacro gnus-info-params (info)
3203   `(nth 5 ,info))
3204
3205 (defmacro gnus-info-level (info)
3206   `(let ((rank (gnus-info-rank ,info)))
3207      (if (consp rank)
3208          (car rank)
3209        rank)))
3210 (defmacro gnus-info-score (info)
3211   `(let ((rank (gnus-info-rank ,info)))
3212      (or (and (consp rank) (cdr rank)) 0)))
3213
3214 (defmacro gnus-info-set-group (info group)
3215   `(setcar ,info ,group))
3216 (defmacro gnus-info-set-rank (info rank)
3217   `(setcar (nthcdr 1 ,info) ,rank))
3218 (defmacro gnus-info-set-read (info read)
3219   `(setcar (nthcdr 2 ,info) ,read))
3220 (defmacro gnus-info-set-marks (info marks &optional extend)
3221   (if extend
3222       `(gnus-info-set-entry ,info ,marks 3)
3223     `(setcar (nthcdr 3 ,info) ,marks)))
3224 (defmacro gnus-info-set-method (info method &optional extend)
3225   (if extend
3226       `(gnus-info-set-entry ,info ,method 4)
3227     `(setcar (nthcdr 4 ,info) ,method)))
3228 (defmacro gnus-info-set-params (info params &optional extend)
3229   (if extend
3230       `(gnus-info-set-entry ,info ,params 5)
3231     `(setcar (nthcdr 5 ,info) ,params)))
3232
3233 (defun gnus-info-set-entry (info entry number)
3234   ;; Extend the info until we have enough elements.
3235   (while (<= (length info) number)
3236     (nconc info (list nil)))
3237   ;; Set the entry.
3238   (setcar (nthcdr number info) entry))
3239
3240 (defmacro gnus-info-set-level (info level)
3241   `(let ((rank (cdr ,info)))
3242      (if (consp (car rank))
3243          (setcar (car rank) ,level)
3244        (setcar rank ,level))))
3245 (defmacro gnus-info-set-score (info score)
3246   `(let ((rank (cdr ,info)))
3247      (if (consp (car rank))
3248          (setcdr (car rank) ,score)
3249        (setcar rank (cons (car rank) ,score)))))
3250
3251 (defmacro gnus-get-info (group)
3252   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3253
3254 ;;; Load the compatibility functions.
3255
3256 (require 'gnus-ems)
3257
3258 \f
3259 ;;;
3260 ;;; Shutdown
3261 ;;;
3262
3263 (defvar gnus-shutdown-alist nil)
3264
3265 (defun gnus-add-shutdown (function &rest symbols)
3266   "Run FUNCTION whenever one of SYMBOLS is shut down."
3267   (push (cons function symbols) gnus-shutdown-alist))
3268
3269 (defun gnus-shutdown (symbol)
3270   "Shut down everything that waits for SYMBOL."
3271   (dolist (entry gnus-shutdown-alist)
3272     (when (memq symbol (cdr entry))
3273       (funcall (car entry)))))
3274
3275 \f
3276 ;;;
3277 ;;; Gnus Utility Functions
3278 ;;;
3279
3280 (defun gnus-find-subscribed-addresses ()
3281   "Return a regexp matching the addresses of all subscribed mail groups.
3282 It consists of the `to-address' or `to-list' parameter of all groups
3283 with a `subscribed' parameter."
3284   (let (group address addresses)
3285     (dolist (entry (cdr gnus-newsrc-alist))
3286       (setq group (car entry))
3287       (when (gnus-parameter-subscribed group)
3288         (setq address (mail-strip-quoted-names
3289                        (or (gnus-group-fast-parameter group 'to-address)
3290                            (gnus-group-fast-parameter group 'to-list))))
3291         (when address
3292           (add-to-list 'addresses address))))
3293     (when addresses
3294       (list (mapconcat 'regexp-quote addresses "\\|")))))
3295
3296 (defmacro gnus-string-or (&rest strings)
3297   "Return the first element of STRINGS that is a non-blank string.
3298 STRINGS will be evaluated in normal `or' order."
3299   `(gnus-string-or-1 ',strings))
3300
3301 (defun gnus-string-or-1 (strings)
3302   (let (string)
3303     (while strings
3304       (setq string (eval (pop strings)))
3305       (if (string-match "^[ \t]*$" string)
3306           (setq string nil)
3307         (setq strings nil)))
3308     string))
3309
3310 (defun gnus-version (&optional arg)
3311   "Version number of this version of Gnus.
3312 If ARG, insert string at point."
3313   (interactive "P")
3314   (if arg
3315       (insert (message gnus-version))
3316     (message gnus-version)))
3317
3318 (defun gnus-continuum-version (&optional version)
3319   "Return VERSION as a floating point number."
3320   (interactive)
3321   (unless version
3322     (setq version gnus-version))
3323   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3324             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3325     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3326           (number (match-string 2 version))
3327           major minor least)
3328       (unless (string-match
3329                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3330         (error "Invalid version string: %s" version))
3331       (setq major (string-to-number (match-string 1 number))
3332             minor (string-to-number (match-string 2 number))
3333             least (if (match-beginning 3)
3334                       (string-to-number (match-string 3 number))
3335                     0))
3336       (string-to-number
3337        (if (zerop major)
3338              (format "%s00%02d%02d"
3339                      (if (member alpha '("(ding)" "d"))
3340                          "4.99"
3341                        (+ 5 (* 0.02
3342                                (abs
3343                                 (- (mm-char-int (aref (downcase alpha) 0))
3344                                    (mm-char-int ?t))))
3345                           -0.01))
3346                      minor least)
3347          (format "%d.%02d%02d" major minor least))))))
3348
3349 (defun gnus-info-find-node (&optional nodename)
3350   "Find Info documentation of Gnus."
3351   (interactive)
3352   ;; Enlarge info window if needed.
3353   (let (gnus-info-buffer)
3354     (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3355     (setq gnus-info-buffer (current-buffer))
3356     (gnus-configure-windows 'info)))
3357
3358 ;;;
3359 ;;; gnus-interactive
3360 ;;;
3361
3362 (defvar gnus-current-prefix-symbol nil
3363   "Current prefix symbol.")
3364
3365 (defvar gnus-current-prefix-symbols nil
3366   "List of current prefix symbols.")
3367
3368 (defun gnus-interactive (string &optional params)
3369   "Return a list that can be fed to `interactive'.
3370 See `interactive' for full documentation.
3371
3372 Adds the following specs:
3373
3374 y -- The current symbolic prefix.
3375 Y -- A list of the current symbolic prefix(es).
3376 A -- Article number.
3377 H -- Article header.
3378 g -- Group name."
3379   (let ((i 0)
3380         out c prompt)
3381     (while (< i (length string))
3382       (string-match ".\\([^\n]*\\)\n?" string i)
3383       (setq c (aref string i))
3384       (when (match-end 1)
3385         (setq prompt (match-string 1 string)))
3386       (setq i (match-end 0))
3387       ;; We basically emulate just about everything that
3388       ;; `interactive' does, but add the specs listed above.
3389       (push
3390        (cond
3391         ((= c ?a)
3392          (completing-read prompt obarray 'fboundp t))
3393         ((= c ?b)
3394          (read-buffer prompt (current-buffer) t))
3395         ((= c ?B)
3396          (read-buffer prompt (other-buffer (current-buffer))))
3397         ((= c ?c)
3398          (read-char))
3399         ((= c ?C)
3400          (completing-read prompt obarray 'commandp t))
3401         ((= c ?d)
3402          (point))
3403         ((= c ?D)
3404          (read-file-name prompt nil default-directory 'lambda))
3405         ((= c ?f)
3406          (read-file-name prompt nil nil 'lambda))
3407         ((= c ?F)
3408          (read-file-name prompt))
3409         ((= c ?k)
3410          (read-key-sequence prompt))
3411         ((= c ?K)
3412          (error "Not implemented spec"))
3413         ((= c ?e)
3414          (error "Not implemented spec"))
3415         ((= c ?m)
3416          (mark))
3417         ((= c ?N)
3418          (error "Not implemented spec"))
3419         ((= c ?n)
3420          (string-to-number (read-from-minibuffer prompt)))
3421         ((= c ?p)
3422          (prefix-numeric-value current-prefix-arg))
3423         ((= c ?P)
3424          current-prefix-arg)
3425         ((= c ?r)
3426          'gnus-prefix-nil)
3427         ((= c ?s)
3428          (read-string prompt))
3429         ((= c ?S)
3430          (intern (read-string prompt)))
3431         ((= c ?v)
3432          (read-variable prompt))
3433         ((= c ?x)
3434          (read-minibuffer prompt))
3435         ((= c ?x)
3436          (eval-minibuffer prompt))
3437         ;; And here the new specs come.
3438         ((= c ?y)
3439          gnus-current-prefix-symbol)
3440         ((= c ?Y)
3441          gnus-current-prefix-symbols)
3442         ((= c ?g)
3443          (gnus-group-group-name))
3444         ((= c ?A)
3445          (gnus-summary-skip-intangible)
3446          (or (get-text-property (point) 'gnus-number)
3447              (gnus-summary-last-subject)))
3448         ((= c ?H)
3449          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3450         (t
3451          (error "Non-implemented spec")))
3452        out)
3453       (cond
3454        ((= c ?r)
3455         (push (if (< (point) (mark)) (point) (mark)) out)
3456         (push (if (> (point) (mark)) (point) (mark)) out))))
3457     (setq out (delq 'gnus-prefix-nil out))
3458     (nreverse out)))
3459
3460 (defun gnus-symbolic-argument (&optional arg)
3461   "Read a symbolic argument and a command, and then execute command."
3462   (interactive "P")
3463   (let* ((in-command (this-command-keys))
3464          (command in-command)
3465          gnus-current-prefix-symbols
3466          gnus-current-prefix-symbol
3467          syms)
3468     (while (equal in-command command)
3469       (message "%s-" (key-description (this-command-keys)))
3470       (push (intern (char-to-string (read-char))) syms)
3471       (setq command (read-key-sequence nil t)))
3472     (setq gnus-current-prefix-symbols (nreverse syms)
3473           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3474     (call-interactively (key-binding command t))))
3475
3476 ;;; More various functions.
3477
3478 (defsubst gnus-check-backend-function (func group)
3479   "Check whether GROUP supports function FUNC.
3480 GROUP can either be a string (a group name) or a select method."
3481   (ignore-errors
3482     (let ((method (if (stringp group)
3483                       (car (gnus-find-method-for-group group))
3484                     group)))
3485       (unless (featurep method)
3486         (require method))
3487       (fboundp (intern (format "%s-%s" method func))))))
3488
3489 (defun gnus-group-read-only-p (&optional group)
3490   "Check whether GROUP supports editing or not.
3491 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
3492 that that variable is buffer-local to the summary buffers."
3493   (let ((group (or group gnus-newsgroup-name)))
3494     (not (gnus-check-backend-function 'request-replace-article group))))
3495
3496 (defun gnus-virtual-group-p (group)
3497   "Say whether GROUP is virtual or not."
3498   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3499                         gnus-valid-select-methods)))
3500
3501 (defun gnus-news-group-p (group &optional article)
3502   "Return non-nil if GROUP (and ARTICLE) come from a news server."
3503   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3504          t)                             ;is news of course.
3505         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3506          nil)                           ;must be mail then.
3507         ((vectorp article)              ;Has header info.
3508          (eq (gnus-request-type group (mail-header-id article)) 'news))
3509         ((null article)                 ;Hasn't header info
3510          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3511         ((< article 0)                  ;Virtual message
3512          nil)                           ;we don't know, guess mail.
3513         (t                              ;Has positive number
3514          (eq (gnus-request-type group article) 'news)))) ;use it.
3515
3516 ;; Returns a list of writable groups.
3517 (defun gnus-writable-groups ()
3518   (let ((alist gnus-newsrc-alist)
3519         groups group)
3520     (while (setq group (car (pop alist)))
3521       (unless (gnus-group-read-only-p group)
3522         (push group groups)))
3523     (nreverse groups)))
3524
3525 ;; Check whether to use long file names.
3526 (defun gnus-use-long-file-name (symbol)
3527   ;; The variable has to be set...
3528   (and gnus-use-long-file-name
3529        ;; If it isn't a list, then we return t.
3530        (or (not (listp gnus-use-long-file-name))
3531            ;; If it is a list, and the list contains `symbol', we
3532            ;; return nil.
3533            (not (memq symbol gnus-use-long-file-name)))))
3534
3535 ;; Generate a unique new group name.
3536 (defun gnus-generate-new-group-name (leaf)
3537   (let ((name leaf)
3538         (num 0))
3539     (while (gnus-group-entry name)
3540       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3541     name))
3542
3543 (defun gnus-ephemeral-group-p (group)
3544   "Say whether GROUP is ephemeral or not."
3545   (gnus-group-get-parameter group 'quit-config t))
3546
3547 (defun gnus-group-quit-config (group)
3548   "Return the quit-config of GROUP."
3549   (gnus-group-get-parameter group 'quit-config t))
3550
3551 (defun gnus-kill-ephemeral-group (group)
3552   "Remove ephemeral GROUP from relevant structures."
3553   (gnus-sethash group nil gnus-newsrc-hashtb))
3554
3555 (defun gnus-simplify-mode-line ()
3556   "Make mode lines a bit simpler."
3557   (setq mode-line-modified (cdr gnus-mode-line-modified))
3558   (when (listp mode-line-format)
3559     (make-local-variable 'mode-line-format)
3560     (setq mode-line-format (copy-sequence mode-line-format))
3561     (when (equal (nth 3 mode-line-format) "   ")
3562       (setcar (nthcdr 3 mode-line-format) " "))))
3563
3564 ;;; Servers and groups.
3565
3566 (defsubst gnus-server-add-address (method)
3567   (let ((method-name (symbol-name (car method))))
3568     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3569              (not (assq (intern (concat method-name "-address")) method))
3570              (memq 'physical-address (assq (car method)
3571                                            gnus-valid-select-methods)))
3572         (append method (list (list (intern (concat method-name "-address"))
3573                                    (nth 1 method))))
3574       method)))
3575
3576 (defsubst gnus-method-to-server (method &optional nocache)
3577   (catch 'server-name
3578     (setq method (or method gnus-select-method))
3579
3580     ;; Perhaps it is already in the cache.
3581     (unless nocache
3582       (mapc (lambda (name-method)
3583               (if (equal (cdr name-method) method)
3584                   (throw 'server-name (car name-method))))
3585             gnus-server-method-cache))
3586
3587     (mapc
3588      (lambda (server-alist)
3589        (mapc (lambda (name-method)
3590                (when (gnus-methods-equal-p (cdr name-method) method)
3591                  (unless (member name-method gnus-server-method-cache)
3592                    (push name-method gnus-server-method-cache))
3593                  (throw 'server-name (car name-method))))
3594              server-alist))
3595      (list gnus-server-alist
3596            gnus-predefined-server-alist))
3597
3598     (let* ((name (if (member (cadr method) '(nil ""))
3599                      (format "%s" (car method))
3600                    (format "%s:%s" (car method) (cadr method))))
3601            (name-method (cons name method)))
3602       (unless (member name-method gnus-server-method-cache)
3603         (push name-method gnus-server-method-cache))
3604       name)))
3605
3606 (defsubst gnus-server-to-method (server)
3607   "Map virtual server names to select methods."
3608   (or (and server (listp server) server)
3609       (cdr (assoc server gnus-server-method-cache))
3610       (let ((result
3611              (or
3612               ;; Perhaps this is the native server?
3613               (and (equal server "native") gnus-select-method)
3614               ;; It should be in the server alist.
3615               (cdr (assoc server gnus-server-alist))
3616               ;; It could be in the predefined server alist.
3617               (cdr (assoc server gnus-predefined-server-alist))
3618               ;; If not, we look through all the opened server
3619               ;; to see whether we can find it there.
3620               (let ((opened gnus-opened-servers))
3621                 (while (and opened
3622                             (not (equal server (format "%s:%s" (caaar opened)
3623                                                        (cadaar opened)))))
3624                   (pop opened))
3625                 (caar opened))
3626               ;; It could be a named method, search all servers
3627               (let ((servers gnus-secondary-select-methods))
3628                 (while (and servers
3629                             (not (equal server (format "%s:%s" (caar servers)
3630                                                        (cadar servers)))))
3631                   (pop servers))
3632                 (car servers))
3633               ;; This could be some sort of foreign server that I
3634               ;; simply haven't opened (yet).  Do a brute-force scan
3635               ;; of the entire gnus-newsrc-alist for the server name
3636               ;; of every method.  As a side-effect, loads the
3637               ;; gnus-server-method-cache so this only happens once,
3638               ;; if at all.
3639               (let ((alist (cdr gnus-newsrc-alist))
3640                     method match)
3641                 (while alist
3642                   (setq method (gnus-info-method (pop alist)))
3643                   (when (and (not (stringp method))
3644                              (equal server (gnus-method-to-server method)))
3645                     (setq match method
3646                           alist nil)))
3647                 match))))
3648         (when result
3649           (push (cons server result) gnus-server-method-cache))
3650         result)))
3651
3652 (defsubst gnus-server-get-method (group method)
3653   ;; Input either a server name, and extended server name, or a
3654   ;; select method, and return a select method.
3655   (cond ((stringp method)
3656          (gnus-server-to-method method))
3657         ((equal method gnus-select-method)
3658          gnus-select-method)
3659         ((and (stringp (car method))
3660               group)
3661          (gnus-server-extend-method group method))
3662         ((and method
3663               (not group)
3664               (equal (cadr method) ""))
3665          method)
3666         (t
3667          (gnus-server-add-address method))))
3668
3669 (defmacro gnus-method-equal (ss1 ss2)
3670   "Say whether two servers are equal."
3671   `(let ((s1 ,ss1)
3672          (s2 ,ss2))
3673      (or (equal s1 s2)
3674          (and (= (length s1) (length s2))
3675               (progn
3676                 (while (and s1 (member (car s1) s2))
3677                   (setq s1 (cdr s1)))
3678                 (null s1))))))
3679
3680 (defun gnus-methods-equal-p (m1 m2)
3681   (let ((m1 (or m1 gnus-select-method))
3682         (m2 (or m2 gnus-select-method)))
3683     (or (equal m1 m2)
3684         (and (eq (car m1) (car m2))
3685              (or (not (memq 'address (assoc (symbol-name (car m1))
3686                                             gnus-valid-select-methods)))
3687                  (equal (nth 1 m1) (nth 1 m2)))))))
3688
3689 (defun gnus-server-equal (m1 m2)
3690   "Say whether two methods are equal."
3691   (let ((m1 (cond ((null m1) gnus-select-method)
3692                   ((stringp m1) (gnus-server-to-method m1))
3693                   (t m1)))
3694         (m2 (cond ((null m2) gnus-select-method)
3695                   ((stringp m2) (gnus-server-to-method m2))
3696                   (t m2))))
3697     (gnus-method-equal m1 m2)))
3698
3699 (defun gnus-servers-using-backend (backend)
3700   "Return a list of known servers using BACKEND."
3701   (let ((opened gnus-opened-servers)
3702         out)
3703     (while opened
3704       (when (eq backend (caaar opened))
3705         (push (caar opened) out))
3706       (pop opened))
3707     out))
3708
3709 (defun gnus-archive-server-wanted-p ()
3710   "Say whether the user wants to use the archive server."
3711   (cond
3712    ((or (not gnus-message-archive-method)
3713         (not gnus-message-archive-group))
3714     nil)
3715    ((and gnus-message-archive-method gnus-message-archive-group)
3716     t)
3717    (t
3718     (let ((active (cadr (assq 'nnfolder-active-file
3719                               gnus-message-archive-method))))
3720       (and active
3721            (file-exists-p active))))))
3722
3723 (defsubst gnus-method-to-server-name (method)
3724   (concat
3725    (format "%s" (car method))
3726    (when (and
3727           (or (assoc (format "%s" (car method))
3728                      (gnus-methods-using 'address))
3729               (gnus-server-equal method gnus-message-archive-method))
3730           (nth 1 method)
3731           (not (string= (nth 1 method) "")))
3732      (concat "+" (nth 1 method)))))
3733
3734 (defsubst gnus-method-to-full-server-name (method)
3735   (format "%s+%s" (car method) (nth 1 method)))
3736
3737 (defun gnus-group-prefixed-name (group method &optional full)
3738   "Return the whole name from GROUP and METHOD.
3739 Call with full set to get the fully qualified group name (even if the
3740 server is native)."
3741   (when (stringp method)
3742     (setq method (gnus-server-to-method method)))
3743   (if (or (not method)
3744           (and (not full) (gnus-server-equal method "native"))
3745           ;;;!!! This might not be right.  We'll see...
3746           ;(string-match ":" group)
3747           )
3748       group
3749     (concat (gnus-method-to-server-name method) ":" group)))
3750
3751 (defun gnus-group-guess-prefixed-name (group)
3752   "Guess the whole name from GROUP and METHOD."
3753   (gnus-group-prefixed-name group (gnus-find-method-for-group
3754                                group)))
3755
3756 (defun gnus-group-full-name (group method)
3757   "Return the full name from GROUP and METHOD, even if the method is native."
3758   (gnus-group-prefixed-name group method t))
3759
3760 (defun gnus-group-guess-full-name (group)
3761   "Guess the full name from GROUP, even if the method is native."
3762   (if (gnus-group-prefixed-p group)
3763       group
3764     (gnus-group-full-name group (gnus-find-method-for-group group))))
3765
3766 (defun gnus-group-guess-full-name-from-command-method (group)
3767   "Guess the full name from GROUP, even if the method is native."
3768   (if (gnus-group-prefixed-p group)
3769       group
3770     (gnus-group-full-name group gnus-command-method)))
3771
3772 (defun gnus-group-real-prefix (group)
3773   "Return the prefix of the current group name."
3774   (if (stringp group)
3775       (if (string-match "^[^:]+:" group)
3776           (substring group 0 (match-end 0))
3777         "")
3778     nil))
3779
3780 (defun gnus-group-short-name (group)
3781   "Return the short group name."
3782   (let ((prefix (gnus-group-real-prefix group)))
3783     (if (< 0 (length prefix))
3784         (substring group (length prefix) nil)
3785       group)))
3786
3787 (defun gnus-group-prefixed-p (group)
3788   "Return the prefix of the current group name."
3789   (< 0 (length (gnus-group-real-prefix group))))
3790
3791 (declare-function gnus-group-decoded-name "gnus-group" (string))
3792
3793 (defun gnus-summary-buffer-name (group)
3794   "Return the summary buffer name of GROUP."
3795   (concat "*Summary " (gnus-group-decoded-name group) "*"))
3796
3797 (defun gnus-group-method (group)
3798   "Return the server or method used for selecting GROUP.
3799 You should probably use `gnus-find-method-for-group' instead."
3800   (let ((prefix (gnus-group-real-prefix group)))
3801     (if (equal prefix "")
3802         gnus-select-method
3803       (let ((servers gnus-opened-servers)
3804             (server "")
3805             backend possible found)
3806         (if (string-match "^[^\\+]+\\+" prefix)
3807             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3808                   server (substring prefix (match-end 0) (1- (length prefix))))
3809           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3810         (while servers
3811           (when (eq (caaar servers) backend)
3812             (setq possible (caar servers))
3813             (when (equal (cadaar servers) server)
3814               (setq found (caar servers))))
3815           (pop servers))
3816         (or (car (rassoc found gnus-server-alist))
3817             found
3818             (car (rassoc possible gnus-server-alist))
3819             possible
3820             (list backend server))))))
3821
3822 (defsubst gnus-native-method-p (method)
3823   "Return whether METHOD is the native select method."
3824   (gnus-method-equal method gnus-select-method))
3825
3826 (defsubst gnus-secondary-method-p (method)
3827   "Return whether METHOD is a secondary select method."
3828   (let ((methods gnus-secondary-select-methods)
3829         (gmethod (inline (gnus-server-get-method nil method))))
3830     (while (and methods
3831                 (not (gnus-method-equal
3832                       (inline (gnus-server-get-method nil (car methods)))
3833                       gmethod)))
3834       (setq methods (cdr methods)))
3835     methods))
3836
3837 (defun gnus-method-simplify (method)
3838   "Return the shortest uniquely identifying string or method for METHOD."
3839   (cond ((stringp method)
3840          method)
3841         ((gnus-native-method-p method)
3842          nil)
3843         ((gnus-secondary-method-p method)
3844          (format "%s:%s" (nth 0 method) (nth 1 method)))
3845         (t
3846          method)))
3847
3848 (defun gnus-groups-from-server (server)
3849   "Return a list of all groups that are fetched from SERVER."
3850   (let ((alist (cdr gnus-newsrc-alist))
3851         info groups)
3852     (while (setq info (pop alist))
3853       (when (gnus-server-equal (gnus-info-method info) server)
3854         (push (gnus-info-group info) groups)))
3855     (sort groups 'string<)))
3856
3857 (defun gnus-group-foreign-p (group)
3858   "Say whether a group is foreign or not."
3859   (and (not (gnus-group-native-p group))
3860        (not (gnus-group-secondary-p group))))
3861
3862 (defun gnus-group-native-p (group)
3863   "Say whether the group is native or not."
3864   (not (string-match ":" group)))
3865
3866 (defun gnus-group-secondary-p (group)
3867   "Say whether the group is secondary or not."
3868   (gnus-secondary-method-p (gnus-find-method-for-group group)))
3869
3870 (defun gnus-parameters-get-parameter (group)
3871   "Return the group parameters for GROUP from `gnus-parameters'."
3872   (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3873                               case-fold-search
3874                             gnus-parameters-case-fold-search))
3875         params-list)
3876     (dolist (elem gnus-parameters)
3877       (when (string-match (car elem) group)
3878         (setq params-list
3879               (nconc (gnus-expand-group-parameters
3880                       (car elem) (cdr elem) group)
3881                      params-list))))
3882     params-list))
3883
3884 (defun gnus-expand-group-parameter (match value group)
3885   "Use MATCH to expand VALUE in GROUP."
3886   (with-temp-buffer
3887     (insert group)
3888     (goto-char (point-min))
3889     (while (re-search-forward match nil t)
3890       (replace-match value))
3891     (buffer-string)))
3892
3893 (defun gnus-expand-group-parameters (match parameters group)
3894   "Go through PARAMETERS and expand them according to the match data."
3895   (let (new)
3896     (dolist (elem parameters)
3897       (if (and (stringp (cdr elem))
3898                (string-match "\\\\[0-9&]" (cdr elem)))
3899           (push (cons (car elem)
3900                       (gnus-expand-group-parameter match (cdr elem) group))
3901                 new)
3902         (push elem new)))
3903     new))
3904
3905 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3906   "For GROUP, return the value of SYMBOL.
3907
3908 You should call this in the `gnus-group-buffer' buffer.
3909 The function `gnus-group-find-parameter' will do that for you."
3910   ;; The speed trick:  No cons'ing and quit early.
3911   (let* ((params (funcall gnus-group-get-parameter-function group))
3912          ;; Start easy, check the "real" group parameters.
3913          (simple-results
3914           (gnus-group-parameter-value params symbol allow-list t)))
3915     (if simple-results
3916         ;; Found results; return them.
3917         (car simple-results)
3918       ;; We didn't find it there, try `gnus-parameters'.
3919       (let ((result nil)
3920             (head nil)
3921             (tail gnus-parameters))
3922         ;; A good old-fashioned non-cl loop.
3923         (while tail
3924           (setq head (car tail)
3925                 tail (cdr tail))
3926           ;; The car is regexp matching for matching the group name.
3927           (when (string-match (car head) group)
3928             ;; The cdr is the parameters.
3929             (setq result (gnus-group-parameter-value (cdr head)
3930                                                      symbol allow-list))
3931             (when result
3932               ;; Expand if necessary.
3933               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3934                   (setq result (gnus-expand-group-parameter (car head)
3935                                                             result group)))
3936               ;; Exit the loop early.
3937               (setq tail nil))))
3938         ;; Done.
3939         result))))
3940
3941 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3942   "Return the group parameters for GROUP.
3943 If SYMBOL, return the value of that symbol in the group parameters.
3944
3945 If you call this function inside a loop, consider using the faster
3946 `gnus-group-fast-parameter' instead."
3947   (save-excursion
3948     (set-buffer gnus-group-buffer)
3949     (if symbol
3950         (gnus-group-fast-parameter group symbol allow-list)
3951       (nconc
3952        (copy-sequence
3953         (funcall gnus-group-get-parameter-function group))
3954        (gnus-parameters-get-parameter group)))))
3955
3956 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3957   "Return the group parameters for GROUP.
3958 If SYMBOL, return the value of that symbol in the group parameters.
3959 If ALLOW-LIST, also allow list as a result.
3960 Most functions should use `gnus-group-find-parameter', which
3961 also examines the topic parameters."
3962   (let ((params (gnus-info-params (gnus-get-info group))))
3963     (if symbol
3964         (gnus-group-parameter-value params symbol allow-list)
3965       params)))
3966
3967 (defun gnus-group-parameter-value (params symbol &optional
3968                                           allow-list present-p)
3969   "Return the value of SYMBOL in group PARAMS.
3970 If ALLOW-LIST, also allow list as a result."
3971   ;; We only wish to return group parameters (dotted lists) and
3972   ;; not local variables, which may have the same names.
3973   ;; But first we handle single elements...
3974   (or (car (memq symbol params))
3975       ;; Handle alist.
3976       (let (elem)
3977         (catch 'found
3978           (while (setq elem (pop params))
3979             (when (and (consp elem)
3980                        (eq (car elem) symbol)
3981                        (or allow-list
3982                            (atom (cdr elem))))
3983               (throw 'found (if present-p (list (cdr elem))
3984                               (cdr elem)))))))))
3985
3986 (defun gnus-group-add-parameter (group param)
3987   "Add parameter PARAM to GROUP."
3988   (let ((info (gnus-get-info group)))
3989     (when info
3990       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3991       ;; Cons the new param to the old one and update.
3992       (gnus-group-set-info (cons param (gnus-info-params info))
3993                            group 'params))))
3994
3995 (defun gnus-group-set-parameter (group name value)
3996   "Set parameter NAME to VALUE in GROUP."
3997   (let ((info (gnus-get-info group)))
3998     (when info
3999       (gnus-group-remove-parameter group name)
4000       (let ((old-params (gnus-info-params info))
4001             (new-params (list (cons name value))))
4002         (while old-params
4003           (when (or (not (listp (car old-params)))
4004                     (not (eq (caar old-params) name)))
4005             (setq new-params (append new-params (list (car old-params)))))
4006           (setq old-params (cdr old-params)))
4007         (gnus-group-set-info new-params group 'params)))))
4008
4009 (defun gnus-group-remove-parameter (group name)
4010   "Remove parameter NAME from GROUP."
4011   (let ((info (gnus-get-info group)))
4012     (when info
4013       (let ((params (gnus-info-params info)))
4014         (when params
4015           (setq params (delq name params))
4016           (while (assq name params)
4017             (gnus-pull name params))
4018           (gnus-info-set-params info params))))))
4019
4020 (defun gnus-group-add-score (group &optional score)
4021   "Add SCORE to the GROUP score.
4022 If SCORE is nil, add 1 to the score of GROUP."
4023   (let ((info (gnus-get-info group)))
4024     (when info
4025       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
4026
4027 (defun gnus-short-group-name (group &optional levels)
4028   "Collapse GROUP name LEVELS.
4029 Select methods are stripped and any remote host name is stripped down to
4030 just the host name."
4031   (let* ((name "")
4032          (foreign "")
4033          (depth 0)
4034          (skip 1)
4035          (levels (or levels
4036                      gnus-group-uncollapsed-levels
4037                      (progn
4038                        (while (string-match "\\." group skip)
4039                          (setq skip (match-end 0)
4040                                depth (+ depth 1)))
4041                        depth))))
4042     ;; Separate foreign select method from group name and collapse.
4043    ;; If method contains a server, collapse to non-domain server name,
4044     ;; otherwise collapse to select method.
4045     (let* ((colon (string-match ":" group))
4046            (server (and colon (substring group 0 colon)))
4047            (plus (and server (string-match "+" server))))
4048       (when server
4049         (if plus
4050             (setq foreign (substring server (+ 1 plus)
4051                                      (string-match "\\." server))
4052                   group (substring group (+ 1 colon)))
4053           (setq foreign server
4054                 group (substring group (+ 1 colon))))
4055         (setq foreign (concat foreign ":")))
4056       ;; Collapse group name leaving LEVELS uncollapsed elements
4057       (let* ((slist (split-string group "/"))
4058              (slen (length slist))
4059              (dlist (split-string group "\\."))
4060              (dlen (length dlist))
4061              glist
4062              glen
4063              gsep
4064              res)
4065         (if (> slen dlen)
4066             (setq glist slist
4067                   glen slen
4068                   gsep "/")
4069           (setq glist dlist
4070                 glen dlen
4071                 gsep "."))
4072         (setq levels (- glen levels))
4073         (dolist (g glist)
4074           (push (if (>= (decf levels) 0)
4075                     (if (zerop (length g))
4076                         ""
4077                       (substring g 0 1))
4078                   g)
4079                 res))
4080         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4081
4082 (defun gnus-narrow-to-body ()
4083   "Narrow to the body of an article."
4084   (narrow-to-region
4085    (progn
4086      (goto-char (point-min))
4087      (or (search-forward "\n\n" nil t)
4088          (point-max)))
4089    (point-max)))
4090
4091 \f
4092 ;;;
4093 ;;; Kill file handling.
4094 ;;;
4095
4096 (defun gnus-apply-kill-file ()
4097   "Apply a kill file to the current newsgroup.
4098 Returns the number of articles marked as read."
4099   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4100           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4101       (gnus-apply-kill-file-internal)
4102     0))
4103
4104 (defun gnus-kill-save-kill-buffer ()
4105   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4106     (when (get-file-buffer file)
4107       (save-excursion
4108         (set-buffer (get-file-buffer file))
4109         (when (buffer-modified-p)
4110           (save-buffer))
4111         (kill-buffer (current-buffer))))))
4112
4113 (defcustom gnus-kill-file-name "KILL"
4114   "Suffix of the kill files."
4115   :group 'gnus-score-kill
4116   :group 'gnus-score-files
4117   :type 'string)
4118
4119 (defun gnus-newsgroup-kill-file (newsgroup)
4120   "Return the name of a kill file name for NEWSGROUP.
4121 If NEWSGROUP is nil, return the global kill file name instead."
4122   (cond
4123    ;; The global KILL file is placed at top of the directory.
4124    ((or (null newsgroup)
4125         (string-equal newsgroup ""))
4126     (expand-file-name gnus-kill-file-name
4127                       gnus-kill-files-directory))
4128    ;; Append ".KILL" to newsgroup name.
4129    ((gnus-use-long-file-name 'not-kill)
4130     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4131                               "." gnus-kill-file-name)
4132                       gnus-kill-files-directory))
4133    ;; Place "KILL" under the hierarchical directory.
4134    (t
4135     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4136                               "/" gnus-kill-file-name)
4137                       gnus-kill-files-directory))))
4138
4139 ;;; Server things.
4140
4141 (defun gnus-member-of-valid (symbol group)
4142   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
4143   (memq symbol (assoc
4144                 (symbol-name (car (gnus-find-method-for-group group)))
4145                 gnus-valid-select-methods)))
4146
4147 (defun gnus-method-option-p (method option)
4148   "Return non-nil if select METHOD has OPTION as a parameter."
4149   (when (stringp method)
4150     (setq method (gnus-server-to-method method)))
4151   (memq option (assoc (format "%s" (car method))
4152                       gnus-valid-select-methods)))
4153
4154 (defun gnus-similar-server-opened (method)
4155   (let ((opened gnus-opened-servers))
4156     (while (and method opened)
4157       (when (and (equal (cadr method) (cadaar opened))
4158                  (equal (car method) (caaar opened))
4159                  (not (equal method (caar opened))))
4160         (setq method nil))
4161       (pop opened))
4162     (not method)))
4163
4164 (defun gnus-server-extend-method (group method)
4165   ;; This function "extends" a virtual server.  If the server is
4166   ;; "hello", and the select method is ("hello" (my-var "something"))
4167   ;; in the group "alt.alt", this will result in a new virtual server
4168   ;; called "hello+alt.alt".
4169   (if (or (not (inline (gnus-similar-server-opened method)))
4170           (not (cddr method)))
4171       method
4172     `(,(car method) ,(concat (cadr method) "+" group)
4173       (,(intern (format "%s-address" (car method))) ,(cadr method))
4174       ,@(cddr method))))
4175
4176 (defun gnus-server-status (method)
4177   "Return the status of METHOD."
4178   (nth 1 (assoc method gnus-opened-servers)))
4179
4180 (defun gnus-group-name-to-method (group)
4181   "Guess a select method based on GROUP."
4182   (if (string-match ":" group)
4183       (let ((server (substring group 0 (match-beginning 0))))
4184         (if (string-match "\\+" server)
4185             (list (intern (substring server 0 (match-beginning 0)))
4186                   (substring server (match-end 0)))
4187           (list (intern server) "")))
4188     gnus-select-method))
4189
4190 (defun gnus-server-string (server)
4191   "Return a readable string that describes SERVER."
4192   (let* ((server (gnus-server-to-method server))
4193          (address (nth 1 server)))
4194     (if (and address
4195              (not (zerop (length address))))
4196         (format "%s using %s" address (car server))
4197       (format "%s" (car server)))))
4198
4199 (defun gnus-find-method-for-group (group &optional info)
4200   "Find the select method that GROUP uses."
4201   (or gnus-override-method
4202       (and (not group)
4203            gnus-select-method)
4204       (and (not (gnus-group-entry group))
4205            ;; Killed or otherwise unknown group.
4206            (or
4207             ;; If we know a virtual server by that name, return its method.
4208             (gnus-server-to-method (gnus-group-server group))
4209             ;; Guess a new method as last resort.
4210             (gnus-group-name-to-method group)))
4211       (let ((info (or info (gnus-get-info group)))
4212             method)
4213         (if (or (not info)
4214                 (not (setq method (gnus-info-method info)))
4215                 (equal method "native"))
4216             gnus-select-method
4217           (setq method
4218                 (cond ((stringp method)
4219                        (inline (gnus-server-to-method method)))
4220                       ((stringp (cadr method))
4221                        (inline (gnus-server-extend-method group method)))
4222                       (t
4223                        method)))
4224           (cond ((equal (cadr method) "")
4225                  method)
4226                 ((null (cadr method))
4227                  (list (car method) ""))
4228                 (t
4229                  (gnus-server-add-address method)))))))
4230
4231 (defun gnus-methods-using (feature)
4232   "Find all methods that have FEATURE."
4233   (let ((valids gnus-valid-select-methods)
4234         outs)
4235     (while valids
4236       (when (memq feature (car valids))
4237         (push (car valids) outs))
4238       (setq valids (cdr valids)))
4239     outs))
4240
4241 (eval-and-compile
4242   (autoload 'message-y-or-n-p "message" nil nil 'macro))
4243
4244 (defun gnus-read-group (prompt &optional default)
4245   "Prompt the user for a group name.
4246 Disallow invalid group names."
4247   (let ((prefix "")
4248         group)
4249     (while (not group)
4250       (when (string-match
4251              gnus-invalid-group-regexp
4252              (setq group (read-string (concat prefix prompt)
4253                                       (cons (or default "") 0)
4254                                       'gnus-group-history)))
4255         (let ((match (match-string 0 group)))
4256           ;; Might be okay (e.g. for nnimap), so ask the user:
4257           (unless (and (not (string-match "^$\\|:" match))
4258                        (message-y-or-n-p
4259                         "Proceed and create group anyway? " t
4260 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4261
4262 Usually, it's dangerous to create a group with this name, because it's not
4263 supported by all back ends and servers.  On IMAP servers it should work,
4264 though.  If you are really sure, you can proceed anyway and create the group.
4265
4266 You may customize the variable `gnus-invalid-group-regexp', which currently is
4267 set to \"" gnus-invalid-group-regexp
4268 "\", if you want to get rid of this query permanently."))
4269             (setq prefix (format "Invalid group name: \"%s\".  " group)
4270                   group nil)))))
4271     group))
4272
4273 (defun gnus-read-method (prompt)
4274   "Prompt the user for a method.
4275 Allow completion over sensible values."
4276   (let* ((open-servers
4277           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4278                   gnus-opened-servers))
4279          (valid-methods
4280           (let (methods)
4281             (dolist (method gnus-valid-select-methods)
4282               (if (or (memq 'prompt-address method)
4283                       (not (assoc (format "%s:" (car method)) open-servers)))
4284                   (push method methods)))
4285             methods))
4286          (servers
4287           (append valid-methods
4288                   open-servers
4289                   gnus-predefined-server-alist
4290                   gnus-server-alist))
4291          (method
4292           (completing-read
4293            prompt servers
4294            nil t nil 'gnus-method-history)))
4295     (cond
4296      ((equal method "")
4297       (setq method gnus-select-method))
4298      ((assoc method gnus-valid-select-methods)
4299       (let ((address (if (memq 'prompt-address
4300                                (assoc method gnus-valid-select-methods))
4301                          (read-string "Address: ")
4302                        "")))
4303         (or (cadr (assoc (format "%s:%s" method address) open-servers))
4304             (list (intern method) address))))
4305      ((assoc method servers)
4306       method)
4307      (t
4308       (list (intern method) "")))))
4309
4310 ;;; Agent functions
4311
4312 (defun gnus-agent-method-p (method-or-server)
4313   "Say whether METHOD is covered by the agent."
4314   (or (eq (car gnus-agent-method-p-cache) method-or-server)
4315       (let* ((method (if (stringp method-or-server)
4316                          (gnus-server-to-method method-or-server)
4317                        method-or-server))
4318              (server (gnus-method-to-server method t)))
4319         (setq gnus-agent-method-p-cache
4320               (cons method-or-server
4321                     (member server gnus-agent-covered-methods)))))
4322   (cdr gnus-agent-method-p-cache))
4323
4324 (defun gnus-online (method)
4325   (not
4326    (if gnus-plugged
4327        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4328      (gnus-agent-method-p method))))
4329
4330 ;;; User-level commands.
4331
4332 ;;;###autoload
4333 (defun gnus-slave-no-server (&optional arg)
4334   "Read network news as a slave, without connecting to the local server."
4335   (interactive "P")
4336   (gnus-no-server arg t))
4337
4338 ;;;###autoload
4339 (defun gnus-no-server (&optional arg slave)
4340   "Read network news.
4341 If ARG is a positive number, Gnus will use that as the startup
4342 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
4343 non-nil and not a positive number, Gnus will prompt the user for the
4344 name of an NNTP server to use.
4345 As opposed to `gnus', this command will not connect to the local
4346 server."
4347   (interactive "P")
4348   (gnus-no-server-1 arg slave))
4349
4350 ;;;###autoload
4351 (defun gnus-slave (&optional arg)
4352   "Read news as a slave."
4353   (interactive "P")
4354   (gnus arg nil 'slave))
4355
4356 ;;;###autoload
4357 (defun gnus-other-frame (&optional arg display)
4358   "Pop up a frame to read news.
4359 This will call one of the Gnus commands which is specified by the user
4360 option `gnus-other-frame-function' (default `gnus') with the argument
4361 ARG if Gnus is not running, otherwise just pop up a Gnus frame.  The
4362 optional second argument DISPLAY should be a standard display string
4363 such as \"unix:0\" to specify where to pop up a frame.  If DISPLAY is
4364 omitted or the function `make-frame-on-display' is not available, the
4365 current display is used."
4366   (interactive "P")
4367   (if (fboundp 'make-frame-on-display)
4368       (unless display
4369         (setq display (gnus-frame-or-window-display-name (selected-frame))))
4370     (setq display nil))
4371   (let ((alive (gnus-alive-p)))
4372     (unless (and alive
4373                  (catch 'found
4374                    (walk-windows
4375                     (lambda (window)
4376                       (when (and (or (not display)
4377                                      (equal display
4378                                             (gnus-frame-or-window-display-name
4379                                              window)))
4380                                  (with-current-buffer (window-buffer window)
4381                                    (string-match "\\`gnus-"
4382                                                  (symbol-name major-mode))))
4383                         (gnus-select-frame-set-input-focus
4384                          (setq gnus-other-frame-object (window-frame window)))
4385                         (select-window window)
4386                         (throw 'found t)))
4387                     'ignore t)))
4388       (gnus-select-frame-set-input-focus
4389        (setq gnus-other-frame-object
4390              (if display
4391                  (make-frame-on-display display gnus-other-frame-parameters)
4392                (make-frame gnus-other-frame-parameters))))
4393       (if alive
4394           (switch-to-buffer gnus-group-buffer)
4395         (funcall gnus-other-frame-function arg)
4396         (add-hook 'gnus-exit-gnus-hook
4397                   '(lambda nil
4398                      (when (and (frame-live-p gnus-other-frame-object)
4399                                 (cdr (frame-list)))
4400                        (delete-frame gnus-other-frame-object))
4401                      (setq gnus-other-frame-object nil)))))))
4402
4403 ;;;###autoload
4404 (defun gnus (&optional arg dont-connect slave)
4405   "Read network news.
4406 If ARG is non-nil and a positive number, Gnus will use that as the
4407 startup level.  If ARG is non-nil and not a positive number, Gnus will
4408 prompt the user for the name of an NNTP server to use."
4409   (interactive "P")
4410   (unless (byte-code-function-p (symbol-function 'gnus))
4411     (message "You should byte-compile Gnus")
4412     (sit-for 2))
4413   (gnus-1 arg dont-connect slave))
4414
4415 ;; Allow redefinition of Gnus functions.
4416
4417 (gnus-ems-redefine)
4418
4419 (provide 'gnus)
4420
4421 ;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4422 ;;; gnus.el ends here