gnus-art.el 268 KB
Newer Older
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1
;;; gnus-art.el --- article mode commands for Gnus
2 3

;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007 Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
5

6
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
7 8 9 10 11 12 13 14 15 16 17
;; Keywords: news

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

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

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
25 26 27 28 29

;;; Commentary:

;;; Code:

30 31
(eval-when-compile
  (require 'cl)
32 33
  (defvar tool-bar-map)
  (defvar w3m-minor-mode-map))
34

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
35 36 37 38
(require 'gnus)
(require 'gnus-sum)
(require 'gnus-spec)
(require 'gnus-int)
39
(require 'gnus-win)
40 41 42 43 44 45
(require 'mm-bodies)
(require 'mail-parse)
(require 'mm-decode)
(require 'mm-view)
(require 'wid-edit)
(require 'mm-uu)
46 47 48 49 50
(require 'message)

(autoload 'gnus-msg-mail "gnus-msg" nil t)
(autoload 'gnus-button-mailto "gnus-msg")
(autoload 'gnus-button-reply "gnus-msg" nil t)
51
(autoload 'parse-time-string "parse-time" nil nil)
52
(autoload 'mm-extern-cache-contents "mm-extern")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
53 54 55

(defgroup gnus-article nil
  "Article display."
56
  :link '(custom-manual "(gnus)Article Buffer")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
57 58
  :group 'gnus)

59 60 61 62 63
(defgroup gnus-article-treat nil
  "Treating article parts."
  :link '(custom-manual "(gnus)Article Hiding")
  :group 'gnus-article)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
(defgroup gnus-article-hiding nil
  "Hiding article parts."
  :link '(custom-manual "(gnus)Article Hiding")
  :group 'gnus-article)

(defgroup gnus-article-highlight nil
  "Article highlighting."
  :link '(custom-manual "(gnus)Article Highlighting")
  :group 'gnus-article
  :group 'gnus-visual)

(defgroup gnus-article-signature nil
  "Article signatures."
  :link '(custom-manual "(gnus)Article Signature")
  :group 'gnus-article)

(defgroup gnus-article-headers nil
  "Article headers."
  :link '(custom-manual "(gnus)Hiding Headers")
  :group 'gnus-article)

(defgroup gnus-article-washing nil
  "Special commands on articles."
  :link '(custom-manual "(gnus)Article Washing")
  :group 'gnus-article)

(defgroup gnus-article-emphasis nil
  "Fontisizing articles."
  :link '(custom-manual "(gnus)Article Fontisizing")
  :group 'gnus-article)

(defgroup gnus-article-saving nil
  "Saving articles."
  :link '(custom-manual "(gnus)Saving Articles")
  :group 'gnus-article)

(defgroup gnus-article-mime nil
  "Worshiping the MIME wonder."
  :link '(custom-manual "(gnus)Using MIME")
  :group 'gnus-article)

(defgroup gnus-article-buttons nil
  "Pushable buttons in the article buffer."
  :link '(custom-manual "(gnus)Article Buttons")
  :group 'gnus-article)

(defgroup gnus-article-various nil
  "Other article options."
  :link '(custom-manual "(gnus)Misc Article")
  :group 'gnus-article)

(defcustom gnus-ignored-headers
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
  (mapcar
   (lambda (header)
     (concat "^" header ":"))
   '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
     "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
     "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
     "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
     "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
     "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
     "X-Attribution" "X-Originating-IP" "Delivered-To"
     "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
     "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
     "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
     "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
     "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
     "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
     "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
     "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
     "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
     "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
     "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
     "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
     "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
     "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
     "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
     "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
     "List-[A-Za-z]+" "X-Listprocessor-Version"
     "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
     "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
     "X-Received" "Content-length" "X-precedence"
     "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
     "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
     "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
     "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
     "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
     "X-Content-length" "X-Posting-Agent" "Original-Received"
     "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
     "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
     "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
     "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
     "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"))
157
  "*All headers that start with this regexp will be hidden.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
158 159 160 161 162 163 164 165
This variable can also be a list of regexps of headers to be ignored.
If `gnus-visible-headers' is non-nil, this variable will be ignored."
  :type '(choice :custom-show nil
		 regexp
		 (repeat regexp))
  :group 'gnus-article-hiding)

(defcustom gnus-visible-headers
166
  "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^[BGF]?Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Mail-Followup-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From:\\|^X-Sent:"
167
  "*All headers that do not match this regexp will be hidden.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
168 169 170 171 172 173 174 175 176 177 178 179 180
This variable can also be a list of regexp of headers to remain visible.
If this variable is non-nil, `gnus-ignored-headers' will be ignored."
  :type '(repeat :value-to-internal (lambda (widget value)
				      (custom-split-regexp-maybe value))
		 :match (lambda (widget value)
			  (or (stringp value)
			      (widget-editable-list-match widget value)))
		 regexp)
  :group 'gnus-article-hiding)

(defcustom gnus-sorted-header-list
  '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
    "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
181
  "*This variable is a list of regular expressions.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
182 183 184 185 186 187 188 189
If it is non-nil, headers that match the regular expressions will
be placed first in the article buffer in the sequence specified by
this list."
  :type '(repeat regexp)
  :group 'gnus-article-hiding)

(defcustom gnus-boring-article-headers '(empty followup-to reply-to)
  "Headers that are only to be displayed if they have interesting data.
190 191 192 193 194 195 196 197 198 199 200 201
Possible values in this list are:

  'empty       Headers with no content.
  'newsgroups  Newsgroup identical to Gnus group.
  'to-address  To identical to To-address.
  'to-list     To identical to To-list.
  'cc-list     CC identical to To-list.
  'followup-to Followup-to identical to Newsgroups.
  'reply-to    Reply-to identical to From.
  'date        Date less than four days old.
  'long-to     To and/or Cc longer than 1024 characters.
  'many-to     Multiple To and/or Cc."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
202
  :type '(set (const :tag "Headers with no content." empty)
203 204 205 206 207 208
	      (const :tag "Newsgroups identical to Gnus group." newsgroups)
	      (const :tag "To identical to To-address." to-address)
	      (const :tag "To identical to To-list." to-list)
	      (const :tag "CC identical to To-list." cc-list)
	      (const :tag "Followup-to identical to Newsgroups." followup-to)
	      (const :tag "Reply-to identical to From." reply-to)
209
	      (const :tag "Date less than four days old." date)
210
	      (const :tag "To and/or Cc longer than 1024 characters." long-to)
211
	      (const :tag "Multiple To and/or Cc headers." many-to))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
212 213
  :group 'gnus-article-hiding)

214 215 216 217 218 219
(defcustom gnus-article-skip-boring nil
  "Skip over text that is not worth reading.
By default, if you set this t, then Gnus will display citations and
signatures, but will never scroll down to show you a page consisting
only of boring text.  Boring text is controlled by
`gnus-article-boring-faces'."
220
  :version "22.1"
221 222 223
  :type 'boolean
  :group 'gnus-article-hiding)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
224 225 226 227 228
(defcustom gnus-signature-separator '("^-- $" "^-- *$")
  "Regexp matching signature separator.
This can also be a list of regexps.  In that case, it will be checked
from head to tail looking for a separator.  Searches will be done from
the end of the buffer."
229 230 231
  :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
		 (regexp)
		 (repeat :tag "List of regexp" regexp))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
232 233 234
  :group 'gnus-article-signature)

(defcustom gnus-signature-limit nil
235
  "Provide a limit to what is considered a signature.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
236 237 238 239 240 241
If it is a number, no signature may not be longer (in characters) than
that number.  If it is a floating point number, no signature may be
longer (in lines) than that number.  If it is a function, the function
will be called without any parameters, and if it returns nil, there is
no signature in the buffer.  If it is a string, it will be used as a
regexp.  If it matches, the text in question is not a signature."
242 243
  :type '(choice (const nil)
		 (integer :value 200)
244 245 246
		 (number :value 4.0)
		 (function :value fun)
		 (regexp :value ".*"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
247 248 249 250 251 252 253
  :group 'gnus-article-signature)

(defcustom gnus-hidden-properties '(invisible t intangible t)
  "Property list to use for hiding text."
  :type 'sexp
  :group 'gnus-article-hiding)

254 255
;; Fixme: This isn't the right thing for mixed graphical and non-graphical
;; frames in a session.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
256
(defcustom gnus-article-x-face-command
257 258 259 260 261 262 263
  (if (featurep 'xemacs)
      (if (or (gnus-image-type-available-p 'xface)
	      (gnus-image-type-available-p 'pbm))
	  'gnus-display-x-face-in-from
	"{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | ee -")
    (if (gnus-image-type-available-p 'pbm)
	'gnus-display-x-face-in-from
264 265
      "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | \
display -"))
266
  "*String or function to be executed to display an X-Face header.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
267
If it is a string, the command will be executed in a sub-shell
268
asynchronously.  The compressed face will be piped to this command."
269 270
  :type `(choice string
		 (function-item gnus-display-x-face-in-from)
271
		 function)
Dave Love's avatar
Dave Love committed
272
  :version "21.1"
273
  :group 'gnus-picon
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
274 275 276 277
  :group 'gnus-article-washing)

(defcustom gnus-article-x-face-too-ugly nil
  "Regexp matching posters whose face shouldn't be shown automatically."
278
  :type '(choice regexp (const nil))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
279 280
  :group 'gnus-article-washing)

281 282
(defcustom gnus-article-banner-alist nil
  "Banner alist for stripping.
283
For example,
284
     ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
Dave Love's avatar
Dave Love committed
285
  :version "21.1"
286 287 288
  :type '(repeat (cons symbol regexp))
  :group 'gnus-article-washing)

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
(gnus-define-group-parameter
 banner
 :variable-document
 "Alist of regexps (to match group names) and banner."
 :variable-group gnus-article-washing
 :parameter-type
 '(choice :tag "Banner"
	  :value nil
	  (const :tag "Remove signature" signature)
	  (symbol :tag "Item in `gnus-article-banner-alist'" none)
	  regexp
	  (const :tag "None" nil))
 :parameter-document
 "If non-nil, specify how to remove `banners' from articles.

Symbol `signature' means to remove signatures delimited by
`gnus-signature-separator'.  Any other symbol is used to look up a
regular expression to match the banner in `gnus-article-banner-alist'.
A string is used as a regular expression to match the banner
directly.")

(defcustom gnus-article-address-banner-alist nil
  "Alist of mail addresses and banners.
Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
to match a mail address in the From: header, BANNER is one of a symbol
`signature', an item in `gnus-article-banner-alist', a regexp and nil.
If ADDRESS matches author's mail address, it will remove things like
advertisements.  For example:

\((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
"
  :type '(repeat
	  (cons
	   (regexp :tag "Address")
	   (choice :tag "Banner" :value nil
		   (const :tag "Remove signature" signature)
		   (symbol :tag "Item in `gnus-article-banner-alist'" none)
		   regexp
		   (const :tag "None" nil))))
328
  :version "22.1"
329 330
  :group 'gnus-article-washing)

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
(defmacro gnus-emphasis-custom-with-format (&rest body)
  `(let ((format "\
\\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
\\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
     ,@body))

(defun gnus-emphasis-custom-value-to-external (value)
  (gnus-emphasis-custom-with-format
   (if (consp (car value))
       (list (format format (car (car value)) (cdr (car value)))
	     2
	     (if (nth 1 value) 2 3)
	     (nth 2 value))
     value)))

(defun gnus-emphasis-custom-value-to-internal (value)
  (gnus-emphasis-custom-with-format
   (let ((regexp (concat "\\`"
			 (format (regexp-quote format)
				 "\\([^()]+\\)" "\\([^()]+\\)")
			 "\\'"))
	 pattern)
     (if (string-match regexp (setq pattern (car value)))
	 (list (cons (match-string 1 pattern) (match-string 2 pattern))
	       (= (nth 2 value) 2)
	       (nth 3 value))
       value))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
359
(defcustom gnus-emphasis-alist
360 361
  (let ((types
	 '(("\\*" "\\*" bold nil 2)
362
	   ("_" "_" underline)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
363 364 365 366 367
	   ("/" "/" italic)
	   ("_/" "/_" underline-italic)
	   ("_\\*" "\\*_" underline-bold)
	   ("\\*/" "/\\*" bold-italic)
	   ("_\\*/" "/\\*_" underline-bold-italic))))
368 369 370 371 372 373 374 375
    (nconc
     (gnus-emphasis-custom-with-format
      (mapcar (lambda (spec)
		(list (format format (car spec) (cadr spec))
		      (or (nth 3 spec) 2)
		      (or (nth 4 spec) 3)
		      (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
	      types))
376 377 378 379 380 381
     '(;; I've never seen anyone use this strikethru convention whereas I've
       ;; several times seen it triggered by normal text.  --Stef
       ;; Miles suggests that this form is sometimes used but for italics,
       ;; so maybe we should map it to `italic'.
       ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
       ;; 2 3 gnus-emphasis-strikethru)
382 383
       ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
	2 3 gnus-emphasis-underline))))
384
  "*Alist that says how to fontify certain phrases.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
385 386 387 388 389 390 391 392 393
Each item looks like this:

  (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)

The first element is a regular expression to be matched.  The second
is a number that says what regular expression grouping used to find
the entire emphasized word.  The third is a number that says what
regexp grouping should be displayed and highlighted.  The fourth
is the face used for highlighting."
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
  :type
  '(repeat
    (menu-choice
     :format "%[Customizing Style%]\n%v"
     :indent 2
     (group :tag "Default"
	    :value ("" 0 0 default)
	    :value-create
	    (lambda (widget)
	      (let ((value (widget-get
			    (cadr (widget-get (widget-get widget :parent)
					      :args))
			    :value)))
		(if (not (eq (nth 2 value) 'default))
		    (widget-put
		     widget
		     :value
		     (gnus-emphasis-custom-value-to-external value))))
	      (widget-group-value-create widget))
413 414 415
	    regexp
	    (integer :format "Match group: %v")
	    (integer  :format "Emphasize group: %v")
416 417 418 419
	    face)
     (group :tag "Simple"
	    :value (("_" . "_") nil default)
	    (cons :format "%v"
420 421
		  (regexp :format "Start regexp: %v")
		  (regexp :format "End regexp: %v"))
422 423 424 425 426 427 428 429 430
	    (boolean :format "Show start and end patterns: %[%v%]\n"
		     :on " On " :off " Off ")
	    face)))
  :get (lambda (symbol)
	 (mapcar 'gnus-emphasis-custom-value-to-internal
		 (default-value symbol)))
  :set (lambda (symbol value)
	 (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
				     value)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
431 432
  :group 'gnus-article-emphasis)

433 434 435 436 437
(defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
  "A regexp to describe whitespace which should not be emphasized.
Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
The former avoids underlining of leading and trailing whitespace,
and the latter avoids underlining any whitespace at all."
Dave Love's avatar
Dave Love committed
438
  :version "21.1"
439 440 441
  :group 'gnus-article-emphasis
  :type 'regexp)

442
(defface gnus-emphasis-bold '((t (:bold t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
443 444 445
  "Face used for displaying strong emphasized text (*word*)."
  :group 'gnus-article-emphasis)

446
(defface gnus-emphasis-italic '((t (:italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
447 448 449 450 451 452 453
  "Face used for displaying italic emphasized text (/word/)."
  :group 'gnus-article-emphasis)

(defface gnus-emphasis-underline '((t (:underline t)))
  "Face used for displaying underlined emphasized text (_word_)."
  :group 'gnus-article-emphasis)

454
(defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
455 456 457
  "Face used for displaying underlined bold emphasized text (_*word*_)."
  :group 'gnus-article-emphasis)

458
(defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
459
  "Face used for displaying underlined italic emphasized text (_/word/_)."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
460 461
  :group 'gnus-article-emphasis)

462
(defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
463 464 465 466
  "Face used for displaying bold italic emphasized text (/*word*/)."
  :group 'gnus-article-emphasis)

(defface gnus-emphasis-underline-bold-italic
467
  '((t (:bold t :italic t :underline t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
468
  "Face used for displaying underlined bold italic emphasized text.
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
469
Example: (_/*word*/_)."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
470 471
  :group 'gnus-article-emphasis)

472 473 474 475 476 477
(defface gnus-emphasis-strikethru (if (featurep 'xemacs)
				      '((t (:strikethru t)))
				    '((t (:strike-through t))))
  "Face used for displaying strike-through text (-word-)."
  :group 'gnus-article-emphasis)

478 479 480 481 482
(defface gnus-emphasis-highlight-words
  '((t (:background "black" :foreground "yellow")))
  "Face used for displaying highlighted words."
  :group 'gnus-article-emphasis)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
483 484
(defcustom gnus-article-time-format "%a, %b %d %Y %T %Z"
  "Format for display of Date headers in article bodies.
485 486 487 488 489 490
See `format-time-string' for the possible values.

The variable can also be function, which should return a complete Date
header.  The function is called with one argument, the time, which can
be fed to `format-time-string'."
  :type '(choice string symbol)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
491 492 493 494
  :link '(custom-manual "(gnus)Article Date")
  :group 'gnus-article-washing)

(defcustom gnus-save-all-headers t
Miles Bader's avatar
Miles Bader committed
495 496 497 498
  "*If non-nil, don't remove any headers before saving.
This will be overridden by the `:headers' property that the symbol of
the saver function, which is specified by `gnus-default-article-saver',
might have."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
499 500 501 502 503 504 505 506 507 508 509 510 511 512
  :group 'gnus-article-saving
  :type 'boolean)

(defcustom gnus-prompt-before-saving 'always
  "*This variable says how much prompting is to be done when saving articles.
If it is nil, no prompting will be done, and the articles will be
saved to the default files.  If this variable is `always', each and
every article that is saved will be preceded by a prompt, even when
saving large batches of articles.  If this variable is neither nil not
`always', there the user will be prompted once for a file name for
each invocation of the saving commands."
  :group 'gnus-article-saving
  :type '(choice (item always)
		 (item :tag "never" nil)
513
		 (sexp :tag "once" :format "%t\n" :value t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
514 515 516 517 518

(defcustom gnus-saved-headers gnus-visible-headers
  "Headers to keep if `gnus-save-all-headers' is nil.
If `gnus-save-all-headers' is non-nil, this variable will be ignored.
If that variable is nil, however, all headers that match this regexp
Miles Bader's avatar
Miles Bader committed
519 520 521 522
will be kept while the rest will be deleted before saving.  This and
`gnus-save-all-headers' will be overridden by the `:headers' property
that the symbol of the saver function, which is specified by
`gnus-default-article-saver', might have."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
523
  :group 'gnus-article-saving
524
  :type 'regexp)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
525 526 527

(defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
  "A function to save articles in your favourite format.
Miles Bader's avatar
Miles Bader committed
528 529
The function will be called by way of the `gnus-summary-save-article'
command, and friends such as `gnus-summary-save-article-rmail'.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
530 531 532 533 534 535 536

Gnus provides the following functions:

* gnus-summary-save-in-rmail (Rmail format)
* gnus-summary-save-in-mail (Unix mail format)
* gnus-summary-save-in-folder (MH folder)
* gnus-summary-save-in-file (article format)
537
* gnus-summary-save-body-in-file (article body)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
538
* gnus-summary-save-in-vm (use VM's folder format)
Miles Bader's avatar
Miles Bader committed
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
* gnus-summary-write-to-file (article format -- overwrite)
* gnus-summary-write-body-to-file (article body -- overwrite)

The symbol of each function may have the following properties:

* :decode
The value non-nil means save decoded articles.  This is meaningful
only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
`gnus-summary-write-to-file', and `gnus-summary-write-body-to-file'.

* :function
The value specifies an alternative function which appends, not
overwrites, articles to a file.  This implies that when saving many
articles at a time, `gnus-prompt-before-saving' is bound to t and all
articles are saved in a single file.  This is meaningful only with
`gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.

* :headers
The value specifies the symbol of a variable of which the value
specifies headers to be saved.  If it is omitted,
`gnus-save-all-headers' and `gnus-saved-headers' control what
headers should be saved."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
561 562 563 564 565
  :group 'gnus-article-saving
  :type '(radio (function-item gnus-summary-save-in-rmail)
		(function-item gnus-summary-save-in-mail)
		(function-item gnus-summary-save-in-folder)
		(function-item gnus-summary-save-in-file)
566
		(function-item gnus-summary-save-body-in-file)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
567
		(function-item gnus-summary-save-in-vm)
568
		(function-item gnus-summary-write-to-file)
Miles Bader's avatar
Miles Bader committed
569
		(function-item gnus-summary-write-body-to-file)
570
		(function)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
571

Miles Bader's avatar
Miles Bader committed
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
(defcustom gnus-article-save-coding-system
  (or (and (mm-coding-system-p 'utf-8) 'utf-8)
      (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
      (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
      (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
  "Coding system used to save decoded articles to a file.

The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
which can safely encode any characters in text.  This is used by the
commands including:

* gnus-summary-save-article-file
* gnus-summary-save-article-body-file
* gnus-summary-write-article-file
* gnus-summary-write-article-body-file

and the functions to which you may set `gnus-default-article-saver':

* gnus-summary-save-in-file
* gnus-summary-save-body-in-file
* gnus-summary-write-to-file
* gnus-summary-write-body-to-file

Those commands and functions save just text displayed in the article
buffer to a file if the value of this variable is non-nil.  Note that
buttonized MIME parts will be lost in a saved file in that case.
Otherwise, raw articles will be saved."
  :group 'gnus-article-saving
  :type `(choice
	  :format "%{%t%}:\n %[Value Menu%] %v"
	  (const :tag "Save raw articles" nil)
	  ,@(delq nil
		  (mapcar
		   (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
		   '((const :tag "UTF-8" utf-8)
		     (const :tag "iso-2022-7bit" iso-2022-7bit)
		     (const :tag "Emacs internal" emacs-mule)
		     (const :tag "escape-quoted" escape-quoted))))
	  (symbol :tag "Coding system")))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
(defcustom gnus-rmail-save-name 'gnus-plain-save-name
  "A function generating a file name to save articles in Rmail format.
The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
  :group 'gnus-article-saving
  :type 'function)

(defcustom gnus-mail-save-name 'gnus-plain-save-name
  "A function generating a file name to save articles in Unix mail format.
The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
  :group 'gnus-article-saving
  :type 'function)

(defcustom gnus-folder-save-name 'gnus-folder-save-name
  "A function generating a file name to save articles in MH folder.
The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
  :group 'gnus-article-saving
  :type 'function)

(defcustom gnus-file-save-name 'gnus-numeric-save-name
  "A function generating a file name to save articles in article format.
The function is called with NEWSGROUP, HEADERS, and optional
LAST-FILE."
  :group 'gnus-article-saving
  :type 'function)

(defcustom gnus-split-methods
  '((gnus-article-archive-name)
    (gnus-article-nndoc-name))
640
  "*Variable used to suggest where articles are to be saved.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
For instance, if you would like to save articles related to Gnus in
the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
you could set this variable to something like:

 '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
   (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))

This variable is an alist where the where the key is the match and the
value is a list of possible files to save in if the match is non-nil.

If the match is a string, it is used as a regexp match on the
article.  If the match is a symbol, that symbol will be funcalled
from the buffer of the article to be saved with the newsgroup as the
parameter.  If it is a list, it will be evaled in the same buffer.

If this form or function returns a string, this string will be used as
a possible file name; and if it returns a non-nil list, that list will
be used as possible file names."
  :group 'gnus-article-saving
660 661 662
  :type '(repeat (choice (list :value (fun) function)
			 (cons :value ("" "") regexp (repeat string))
			 (sexp :value nil))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
663 664 665 666 667 668 669 670

(defcustom gnus-page-delimiter "^\^L"
  "*Regexp describing what to use as article page delimiters.
The default value is \"^\^L\", which is a form linefeed at the
beginning of a line."
  :type 'regexp
  :group 'gnus-article-various)

671
(defcustom gnus-article-mode-line-format "Gnus: %g [%w] %S%m"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
672
  "*The format specification for the article mode line.
673 674 675 676 677 678
See `gnus-summary-mode-line-format' for a closer description.

The following additional specs are available:

%w  The article washing status.
%m  The number of MIME parts in the article."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
679 680 681 682 683 684 685 686
  :type 'string
  :group 'gnus-article-various)

(defcustom gnus-article-mode-hook nil
  "*A hook for Gnus article mode."
  :type 'hook
  :group 'gnus-article-various)

687 688 689 690 691 692 693
(when (featurep 'xemacs)
  ;; Extracted from gnus-xmas-define in order to preserve user settings
  (when (fboundp 'turn-off-scroll-in-place)
    (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
  ;; Extracted from gnus-xmas-redefine in order to preserve user settings
  (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
694 695 696 697 698 699
(defcustom gnus-article-menu-hook nil
  "*Hook run after the creation of the article mode menu."
  :type 'hook
  :group 'gnus-article-various)

(defcustom gnus-article-prepare-hook nil
700
  "*A hook called after an article has been prepared in the article buffer."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
701 702 703
  :type 'hook
  :group 'gnus-article-various)

704 705
(make-obsolete-variable 'gnus-article-hide-pgp-hook
			"This variable is obsolete in Gnus 5.10.")
706

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
(defcustom gnus-article-button-face 'bold
  "Face used for highlighting buttons in the article buffer.

An article button is a piece of text that you can activate by pressing
`RET' or `mouse-2' above it."
  :type 'face
  :group 'gnus-article-buttons)

(defcustom gnus-article-mouse-face 'highlight
  "Face used for mouse highlighting in the article buffer.

Article buttons will be displayed in this face when the cursor is
above them."
  :type 'face
  :group 'gnus-article-buttons)

723
(defcustom gnus-signature-face 'gnus-signature
724
  "Face used for highlighting a signature in the article buffer.
725
Obsolete; use the face `gnus-signature' for customizations instead."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
726 727 728 729
  :type 'face
  :group 'gnus-article-highlight
  :group 'gnus-article-signature)

730
(defface gnus-signature
731
  '((t
732
     (:italic t)))
733 734 735
  "Face used for highlighting a signature in the article buffer."
  :group 'gnus-article-highlight
  :group 'gnus-article-signature)
736 737
;; backward-compatibility alias
(put 'gnus-signature-face 'face-alias 'gnus-signature)
738

739
(defface gnus-header-from
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
740 741
  '((((class color)
      (background dark))
742
     (:foreground "spring green"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
743 744
    (((class color)
      (background light))
745
     (:foreground "red3"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
746
    (t
747
     (:italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
748 749 750
  "Face used for displaying from headers."
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
751 752
;; backward-compatibility alias
(put 'gnus-header-from-face 'face-alias 'gnus-header-from)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
753

754
(defface gnus-header-subject
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
755 756
  '((((class color)
      (background dark))
757
     (:foreground "SeaGreen3"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
758 759
    (((class color)
      (background light))
760
     (:foreground "red4"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
761
    (t
762
     (:bold t :italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
763 764 765
  "Face used for displaying subject headers."
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
766 767
;; backward-compatibility alias
(put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
768

769
(defface gnus-header-newsgroups
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
770 771
  '((((class color)
      (background dark))
772
     (:foreground "yellow" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
773 774
    (((class color)
      (background light))
775
     (:foreground "MidnightBlue" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
776
    (t
777 778 779 780
     (:italic t)))
  "Face used for displaying newsgroups headers.
In the default setup this face is only used for crossposted
articles."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
781 782
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
783 784
;; backward-compatibility alias
(put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
785

786
(defface gnus-header-name
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
787 788 789 790 791 792 793
  '((((class color)
      (background dark))
     (:foreground "SeaGreen"))
    (((class color)
      (background light))
     (:foreground "maroon"))
    (t
794
     (:bold t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
795 796 797
  "Face used for displaying header names."
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
798 799
;; backward-compatibility alias
(put 'gnus-header-name-face 'face-alias 'gnus-header-name)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
800

801
(defface gnus-header-content
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
802 803
  '((((class color)
      (background dark))
804
     (:foreground "forest green" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
805 806
    (((class color)
      (background light))
807
     (:foreground "indianred4" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
808
    (t
809
     (:italic t)))  "Face used for displaying header content."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
810 811
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
812 813
;; backward-compatibility alias
(put 'gnus-header-content-face 'face-alias 'gnus-header-content)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
814 815

(defcustom gnus-header-face-alist
816 817 818 819
  '(("From" nil gnus-header-from)
    ("Subject" nil gnus-header-subject)
    ("Newsgroups:.*," nil gnus-header-newsgroups)
    ("" gnus-header-name gnus-header-content))
820
  "*Controls highlighting of article headers.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
821 822 823

An alist of the form (HEADER NAME CONTENT).

824 825
HEADER is a regular expression which should match the name of a
header and NAME and CONTENT are either face names or nil.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
826 827

The name of each header field will be displayed using the face
828 829 830
specified by the first element in the list where HEADER matches
the header name and NAME is non-nil.  Similarly, the content will
be displayed by the first non-nil matching CONTENT face."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
831 832 833 834 835 836 837 838 839 840
  :group 'gnus-article-headers
  :group 'gnus-article-highlight
  :type '(repeat (list (regexp :tag "Header")
		       (choice :tag "Name"
			       (item :tag "skip" nil)
			       (face :value default))
		       (choice :tag "Content"
			       (item :tag "skip" nil)
			       (face :value default)))))

841
(defcustom gnus-article-decode-hook
842 843
  '(article-decode-charset article-decode-encoded-words
			   article-decode-group-name article-decode-idna-rhs)
844 845 846 847 848 849 850 851 852 853 854 855
  "*Hook run to decode charsets in articles."
  :group 'gnus-article-headers
  :type 'hook)

(defcustom gnus-display-mime-function 'gnus-display-mime
  "Function to display MIME articles."
  :group 'gnus-article-mime
  :type 'function)

(defvar gnus-decode-header-function 'mail-decode-encoded-word-region
  "Function used to decode headers.")

Miles Bader's avatar
Miles Bader committed
856 857 858
(defvar gnus-decode-address-function 'mail-decode-encoded-address-region
  "Function used to decode addresses.")

859
(defvar gnus-article-dumbquotes-map
860 861
  '(("\200" "EUR")
    ("\202" ",")
862 863 864 865 866 867 868 869 870 871
    ("\203" "f")
    ("\204" ",,")
    ("\205" "...")
    ("\213" "<")
    ("\214" "OE")
    ("\221" "`")
    ("\222" "'")
    ("\223" "``")
    ("\224" "\"")
    ("\225" "*")
872 873
    ("\226" "-")
    ("\227" "--")
874
    ("\230" "~")
875 876 877 878 879 880 881 882
    ("\231" "(TM)")
    ("\233" ">")
    ("\234" "oe")
    ("\264" "'"))
  "Table for MS-to-Latin1 translation.")

(defcustom gnus-ignored-mime-types nil
  "List of MIME types that should be ignored by Gnus."
Dave Love's avatar
Dave Love committed
883
  :version "21.1"
884 885 886 887
  :group 'gnus-article-mime
  :type '(repeat regexp))

(defcustom gnus-unbuttonized-mime-types '(".*/.*")
888 889 890 891 892 893 894 895 896 897 898
  "List of MIME types that should not be given buttons when rendered inline.
See also `gnus-buttonized-mime-types' which may override this variable.
This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
  :version "21.1"
  :group 'gnus-article-mime
  :type '(repeat regexp))

(defcustom gnus-buttonized-mime-types nil
  "List of MIME types that should be given buttons when rendered inline.
If set, this variable overrides `gnus-unbuttonized-mime-types'.
To see e.g. security buttons you could set this to
899 900 901
`(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
this list to display radio buttons that allow you to choose one of two
media types those mails include.  See also `mm-discouraged-alternatives'.
902
This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
903
  :version "22.1"
904 905 906
  :group 'gnus-article-mime
  :type '(repeat regexp))

907 908 909 910 911
(defcustom gnus-inhibit-mime-unbuttonizing nil
  "If non-nil, all MIME parts get buttons.
When nil (the default value), then some MIME parts do not get buttons,
as described by the variables `gnus-buttonized-mime-types' and
`gnus-unbuttonized-mime-types'."
912
  :version "22.1"
913
  :group 'gnus-article-mime
914 915 916 917 918 919
  :type 'boolean)

(defcustom gnus-body-boundary-delimiter "_"
  "String used to delimit header and body.
This variable is used by `gnus-article-treat-body-boundary' which can
be controlled by `gnus-treat-body-boundary'."
920
  :version "22.1"
921 922 923 924
  :group 'gnus-article-various
  :type '(choice (item :tag "None" :value nil)
		 string))

925 926
(defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
				  "/usr/share/picons")
927 928 929
  "Defines the location of the faces database.
For information on obtaining this database of pretty pictures, please
see http://www.cs.indiana.edu/picons/ftp/index.html"
930
  :version "22.1"
931 932 933 934 935 936 937 938 939 940 941 942 943 944
  :type '(repeat directory)
  :link '(url-link :tag "download"
		   "http://www.cs.indiana.edu/picons/ftp/index.html")
  :link '(custom-manual "(gnus)Picons")
  :group 'gnus-picon)

(defun gnus-picons-installed-p ()
  "Say whether picons are installed on your machine."
  (let ((installed nil))
    (dolist (database gnus-picon-databases)
      (when (file-exists-p database)
	(setq installed t)))
    installed))

945 946 947 948 949
(defcustom gnus-article-mime-part-function nil
  "Function called with a MIME handle as the argument.
This is meant for people who want to do something automatic based
on parts -- for instance, adding Vcard info to a database."
  :group 'gnus-article-mime
950 951
  :type '(choice (const nil)
		 function))
952 953

(defcustom gnus-mime-multipart-functions nil
Dave Love's avatar
Dave Love committed
954 955 956 957
  "An alist of MIME types to functions to display them."
  :version "21.1"
  :group 'gnus-article-mime
  :type 'alist)
958 959 960 961 962 963

(defcustom gnus-article-date-lapsed-new-header nil
  "Whether the X-Sent and Date headers can coexist.
When using `gnus-treat-date-lapsed', the \"X-Sent:\" header will
either replace the old \"Date:\" header (if this variable is nil), or
be added below it (otherwise)."
Dave Love's avatar
Dave Love committed
964
  :version "21.1"
965 966 967 968 969 970
  :group 'gnus-article-headers
  :type 'boolean)

(defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
  "Function called with a MIME handle as the argument.
This is meant for people who want to view first matched part.
971 972 973
For `undisplayed-alternative' (default), the first undisplayed
part or alternative part is used.  For `undisplayed', the first
undisplayed part is used.  For a function, the first part which
974
the function return t is used.  For nil, the first part is
975
used."
Dave Love's avatar
Dave Love committed
976
  :version "21.1"
977
  :group 'gnus-article-mime
978
  :type '(choice
979 980
	  (item :tag "first" :value nil)
	  (item :tag "undisplayed" :value undisplayed)
981
	  (item :tag "undisplayed or alternative"
982 983 984
		:value undisplayed-alternative)
	  (function)))

985 986
(defcustom gnus-mime-action-alist
  '(("save to file" . gnus-mime-save-part)
987 988
    ("save and strip" . gnus-mime-save-part-and-strip)
    ("delete part" . gnus-mime-delete-part)
989 990 991 992
    ("display as text" . gnus-mime-inline-part)
    ("view the part" . gnus-mime-view-part)
    ("pipe to command" . gnus-mime-pipe-part)
    ("toggle display" . gnus-article-press-button)
993
    ("toggle display" . gnus-article-view-part-as-charset)
994
    ("view as type" . gnus-mime-view-part-as-type)
995 996
    ("view internally" . gnus-mime-view-part-internally)
    ("view externally" . gnus-mime-view-part-externally))
997 998 999 1000 1001
  "An alist of actions that run on the MIME attachment."
  :group 'gnus-article-mime
  :type '(repeat (cons (string :tag "name")
		       (function))))

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
;;;
;;; The treatment variables
;;;

(defvar gnus-part-display-hook nil
  "Hook called on parts that are to receive treatment.")

(defvar gnus-article-treat-custom
  '(choice (const :tag "Off" nil)
	   (const :tag "On" t)
	   (const :tag "Header" head)
	   (const :tag "Last" last)
	   (integer :tag "Less")
	   (repeat :tag "Groups" regexp)
	   (sexp :tag "Predicate")))

(defvar gnus-article-treat-head-custom
  '(choice (const :tag "Off" nil)
	   (const :tag "Header" head)))

(defvar gnus-article-treat-types '("text/plain")
  "Parts to treat.")

(defvar gnus-inhibit-treatment nil
  "Whether to inhibit treatment.")

1028
(defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1029 1030
  "Highlight the signature.
Valid values are nil, t, `head', `last', an integer or a predicate.
1031
See Info node `(gnus)Customizing Articles'."
1032
  :group 'gnus-article-treat
1033
  :link '(custom-manual "(gnus)Customizing Articles")
1034 1035 1036 1037 1038 1039
  :type gnus-article-treat-custom)
(put 'gnus-treat-highlight-signature 'highlight t)

(defcustom gnus-treat-buttonize 100000
  "Add buttons.
Valid values are nil, t, `head', `last', an integer or a predicate.
1040
See Info node `(gnus)Customizing Articles'."
1041
  :group 'gnus-article-treat
1042
  :link '(custom-manual "(gnus)Customizing Articles")
1043 1044 1045 1046 1047 1048
  :type gnus-article-treat-custom)
(put 'gnus-treat-buttonize 'highlight t)

(defcustom gnus-treat-buttonize-head 'head
  "Add buttons to the head.
Valid values are nil, t, `head', `last', an integer or a predicate.
1049
See Info node `(gnus)Customizing Articles' for details."
1050
  :group 'gnus-article-treat
1051
  :link '(custom-manual "(gnus)Customizing Articles")
1052 1053 1054
  :type gnus-article-treat-head-custom)
(put 'gnus-treat-buttonize-head 'highlight t)

1055
(defcustom gnus-treat-emphasize
1056 1057 1058 1059
  (and (or window-system
	   (featurep 'xemacs)
	   (>= (string-to-number emacs-version) 21))
       50000)
1060 1061
  "Emphasize text.
Valid values are nil, t, `head', `last', an integer or a predicate.
1062
See Info node `(gnus)Customizing Articles' for details."
1063
  :group 'gnus-article-treat
1064
  :link '(custom-manual "(gnus)Customizing Articles")
1065 1066 1067 1068 1069 1070
  :type gnus-article-treat-custom)
(put 'gnus-treat-emphasize 'highlight t)

(defcustom gnus-treat-strip-cr nil
  "Remove carriage returns.
Valid values are nil, t, `head', `last', an integer or a predicate.
1071
See Info node `(gnus)Customizing Articles' for details."
1072
  :version "22.1"
1073
  :group 'gnus-article-treat
1074 1075 1076 1077 1078 1079 1080
  :link '(custom-manual "(gnus)Customizing Articles")
  :type gnus-article-treat-custom)

(defcustom gnus-treat-unsplit-urls nil
  "Remove newlines from within URLs.
Valid values are nil, t, `head', `last', an integer or a predicate.
See Info node `(gnus)Customizing Articles' for details."
1081
  :version "22.1"
1082 1083 1084 1085 1086 1087 1088 1089
  :group 'gnus-article-treat
  :link '(custom-manual "(gnus)Customizing Articles")
  :type gnus-article-treat-custom)

(defcustom gnus-treat-leading-whitespace nil
  "Remove leading whitespace in headers.
Valid values are nil, t, `head', `last', an integer or a predicate.
See Info node `(gnus)Customizing Articles' for details."
1090
  :version "22.1"
1091 1092
  :group 'gnus-article-treat
  :link '(custom-manual "(gnus)Customizing Articles")
1093 1094 1095 1096 1097
  :type gnus-article-treat-custom)

(defcustom gnus-treat-hide-headers 'head
  "Hide headers.
Valid values are nil, t, `head', `last', an integer or a predicate.
1098
See Info node `(gnus)Customizing Articles' for details."
1099
  :group 'gnus-article-treat
1100
  :link '(custom-manual "(gnus)Customizing Articles")
1101 1102 1103 1104 1105
  :type gnus-article-treat-head-custom)

(defcustom gnus-treat-hide-boring-headers nil
  "Hide boring headers.
Valid values are nil, t, `head', `last', an integer or a predicate.
1106
See Info node `(gnus)Customizing Articles' for details."
1107
  :group 'gnus-article-treat
1108
  :link '(custom-manual "(gnus)Customizing Articles")
1109 1110 1111 1112 1113
  :type gnus-article-treat-head-custom)

(defcustom gnus-treat-hide-signature nil
  "Hide the signature.
Valid values are nil, t, `head', `last', an integer or a predicate.
1114
See Info node `(gnus)Customizing Articles' for details."
1115
  :group 'gnus-article-treat
1116
  :link '(custom-manual "(gnus)Customizing Articles")
1117 1118 1119 1120 1121
  :type gnus-article-treat-custom)

(defcustom gnus-treat-fill-article nil
  "Fill the article.
Valid values are nil, t, `head', `last', an integer or a predicate.
1122
See Info node `(gnus)Customizing Articles' for details."
1123
  :group 'gnus-article-treat
1124
  :link '(custom-manual "(gnus)Customizing Articles")
1125 1126 1127 1128 1129
  :type gnus-article-treat-custom)

(defcustom gnus-treat-hide-citation nil
  "Hide cited text.
Valid values are nil, t, `head', `last', an integer or a predicate.
1130
See Info node `(gnus)Customizing Articles' for details."
1131
  :group 'gnus-article-treat
1132
  :link '(custom-manual "(gnus)Customizing Articles")
1133 1134
  :type gnus-article-treat-custom)

1135 1136 1137
(defcustom gnus-treat-hide-citation-maybe nil
  "Hide cited text.
Valid values are nil, t, `head', `last', an integer or a predicate.
1138
See Info node `(gnus)Customizing Articles' for details."
1139
  :group 'gnus-article-treat
1140
  :link '(custom-manual "(gnus)Customizing Articles")
1141 1142
  :type gnus-article-treat-custom)

1143 1144 1145
(defcustom gnus-treat-strip-list-identifiers 'head
  "Strip list identifiers from `gnus-list-identifiers`.
Valid values are nil, t, `head', `last', an integer or a predicate.
1146
See Info node `(gnus)Customizing Articles' for details."
Dave Love's avatar
Dave Love committed
1147
  :version "21.1"
1148
  :group 'gnus-article-treat
1149
  :link '(custom-manual "(gnus)Customizing Articles")
1150 1151
  :type gnus-article-treat-custom)

1152 1153
(make-obsolete-variable 'gnus-treat-strip-pgp
			"This option is obsolete in Gnus 5.10.")
1154 1155 1156 1157

(defcustom gnus-treat-strip-pem nil
  "Strip PEM signatures.
Valid values are nil, t, `head', `last', an integer or a predicate.
1158
See Info node `(gnus)Customizing Articles' for details."
1159
  :group 'gnus-article-treat
1160
  :link '(custom-manual "(gnus)Customizing Articles")
1161 1162 1163 1164 1165 1166
  :type gnus-article-treat-custom)

(defcustom gnus-treat-strip-banner t
  "Strip banners from articles.
The banner to be stripped is specified in the `banner' group parameter.
Valid values are nil, t, `head', `last', an integer or a predicate.
1167
See Info node `(gnus)Customizing Articles' for details."
1168
  :group 'gnus-article-treat
1169
  :link '(custom-manual "(gnus)Customizing Articles")
1170 1171 1172 1173 1174
  :type gnus-article-treat-custom)

(defcustom gnus-treat-highlight-headers 'head
  "Highlight the headers.
Valid values are nil, t, `head', `last', an integer or a predicate.
1175
See Info node `(gnus)Customizing Articles' for details."
1176
  :group 'gnus-article-treat
1177
  :link '(custom-manual "(gnus)Customizing Articles")
1178 1179 1180 1181 1182 1183
  :type gnus-article-treat-head-custom)
(put 'gnus-treat-highlight-headers 'highlight t)

(defcustom gnus-treat-highlight-citation t
  "Highlight cited text.
Valid values are nil, t, `head', `last', an integer or a predicate.
1184
See Info node `(gnus)Customizing Articles' for details."
1185
  :group 'gnus-article-treat
1186
  :link '(custom-manual "(gnus)Customizing Articles")
1187 1188 1189 1190 1191 1192
  :type gnus-article-treat-custom)
(put 'gnus-treat-highlight-citation 'highlight t)

(defcustom gnus-treat-date-ut nil
  "Display the Date in UT (GMT).
Valid values are nil, t, `head', `last', an integer or a predicate.
1193
See Info node `(gnus)Customizing Articles' for details."
1194
  :group 'gnus-article-treat
1195
  :link '(custom-manual "(gnus)Customizing Articles")
1196 1197 1198 1199 1200
  :type gnus-article-treat-head-custom)

(defcustom gnus-treat-date-local nil
  "Display the Date in the local timezone.
Valid values are nil, t, `head', `last', an integer or a predicate.
1201 1202 1203 1204 1205 1206 1207 1208 1209
See Info node `(gnus)Customizing Articles' for details."
  :group 'gnus-article-treat
  :link '(custom-manual "(gnus)Customizing Articles")
  :type gnus-article-treat-head-custom)

(defcustom gnus-treat-date-english nil
  "Display the Date in a format that can be read aloud in English.
Valid values are nil, t, `head', `last', an integer or a predicate.
See Info node `(gnus)Customizing Articles' for details."
1210
  :version "22.1"
1211
  :group 'gnus-article-treat
1212
  :link '(custom-manual "(gnus)Customizing Articles")
1213 1214 1215 1216 1217
  :type gnus-article-treat-head-custom)

(defcustom gnus-treat-date-lapsed nil
  "Display the Date header in a way that says how much time has elapsed.
Valid values are nil, t, `head', `last', an integer or a predicate.
1218
See Info node `(gnus)Customizing Articles' for details."
1219
  :group 'gnus-article-treat
1220
  :link '(custom-manual "(gnus)Customizing Articles")
1221 1222 1223 1224 1225
  :type gnus-article-treat-head-custom)

(defcustom gnus-treat-date-original nil
  "Display the date in the original timezone.
Valid values are nil, t, `head', `last', an integer or a predicate.
1226
See Info node `(gnus)Customizing Articles' for details."
1227
  :group 'gnus-article-treat
1228
  :link '(custom-manual "(gnus)Customizing Articles")
Gerd Moellmann's avatar