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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1996-2015 Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
4

5
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
6 7 8 9
;; Keywords: news

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
14 15 16

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

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
22 23 24 25 26

;;; Commentary:

;;; Code:

27
(eval-when-compile
Dan Nicolaescu's avatar
Dan Nicolaescu committed
28 29 30
  (require 'cl))
(defvar tool-bar-map)
(defvar w3m-minor-mode-map)
31

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

(autoload 'gnus-msg-mail "gnus-msg" nil t)
(autoload 'gnus-button-mailto "gnus-msg")
(autoload 'gnus-button-reply "gnus-msg" nil t)
49
(autoload 'parse-time-string "parse-time" nil nil)
50 51
(autoload 'ansi-color-apply-on-region "ansi-color")
(autoload 'mm-url-insert-file-contents-external "mm-url")
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
  (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"
156 157 158 159
     "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
     "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
     "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
     "Envelope-Sender" "Envelope-Recipients"))
160
  "*All headers that start with this regexp will be hidden.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
161 162
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."
163
  :type '(choice regexp
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
164 165 166 167
		 (repeat regexp))
  :group 'gnus-article-hiding)

(defcustom gnus-visible-headers
168
  "^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:"
169
  "*All headers that do not match this regexp will be hidden.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
170 171
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."
Miles Bader's avatar
Miles Bader committed
172 173 174 175 176 177 178 179 180
  :type '(choice
	  (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)
	  (const :tag "Use gnus-ignored-headers" nil)
	  regexp)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
181 182 183 184 185
  :group 'gnus-article-hiding)

(defcustom gnus-sorted-header-list
  '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
    "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
186
  "*This variable is a list of regular expressions.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
187 188 189 190 191 192 193 194
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.
195 196 197 198 199 200 201 202 203 204 205 206
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
207
  :type '(set (const :tag "Headers with no content." empty)
208 209 210 211 212 213
	      (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)
214
	      (const :tag "Date less than four days old." date)
215
	      (const :tag "To and/or Cc longer than 1024 characters." long-to)
216
	      (const :tag "Multiple To and/or Cc headers." many-to))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
217 218
  :group 'gnus-article-hiding)

219 220 221 222 223 224
(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'."
225
  :version "22.1"
226 227 228
  :type 'boolean
  :group 'gnus-article-hiding)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
229 230 231 232 233
(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."
234 235 236
  :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
		 (regexp)
		 (repeat :tag "List of regexp" regexp))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
237 238 239
  :group 'gnus-article-signature)

(defcustom gnus-signature-limit nil
240
  "Provide a limit to what is considered a signature.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
241 242 243 244 245
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
246 247 248
regexp.  If it matches, the text in question is not a signature.

This can also be a list of the above values."
249 250
  :type '(choice (const nil)
		 (integer :value 200)
251
		 (number :value 4.0)
Miles Bader's avatar
Miles Bader committed
252
		 function
253
		 (regexp :value ".*"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
254 255
  :group 'gnus-article-signature)

256 257 258 259 260 261 262
(defcustom gnus-hidden-properties
  (if (featurep 'xemacs)
      ;; `intangible' is evil, but I keep it here in case it's useful.
      '(invisible t intangible t)
    ;; Emacs's command loop moves point out of invisible text anyway, so
    ;; `intangible' is clearly not needed there.
    '(invisible t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
263 264 265 266
  "Property list to use for hiding text."
  :type 'sexp
  :group 'gnus-article-hiding)

267 268
;; 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
269
(defcustom gnus-article-x-face-command
270 271 272 273
  (if (featurep 'xemacs)
      (if (or (gnus-image-type-available-p 'xface)
	      (gnus-image-type-available-p 'pbm))
	  'gnus-display-x-face-in-from
274 275 276
	"{ echo \
'/* Format_version=1, Width=48, Height=48, Depth=1, Valid_bits_per_item=16 */'\
; uncompface; } | icontopbm | ee -")
277 278
    (if (gnus-image-type-available-p 'pbm)
	'gnus-display-x-face-in-from
279 280 281
      "{ echo \
'/* Format_version=1, Width=48, Height=48, Depth=1, Valid_bits_per_item=16 */'\
; uncompface; } | icontopbm | display -"))
282
  "*String or function to be executed to display an X-Face header.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
283
If it is a string, the command will be executed in a sub-shell
284
asynchronously.  The compressed face will be piped to this command."
285 286
  :type `(choice string
		 (function-item gnus-display-x-face-in-from)
287
		 function)
Dave Love's avatar
Dave Love committed
288
  :version "21.1"
289
  :group 'gnus-picon
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
290 291 292 293
  :group 'gnus-article-washing)

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

297 298
(defcustom gnus-article-banner-alist nil
  "Banner alist for stripping.
299
For example,
300
     ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
Dave Love's avatar
Dave Love committed
301
  :version "21.1"
302 303 304
  :type '(repeat (cons symbol regexp))
  :group 'gnus-article-washing)

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
(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))))
344
  :version "22.1"
345 346
  :group 'gnus-article-washing)

347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
(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
375
(defcustom gnus-emphasis-alist
376 377
  (let ((types
	 '(("\\*" "\\*" bold nil 2)
378
	   ("_" "_" underline)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
379 380 381 382 383
	   ("/" "/" italic)
	   ("_/" "/_" underline-italic)
	   ("_\\*" "\\*_" underline-bold)
	   ("\\*/" "/\\*" bold-italic)
	   ("_\\*/" "/\\*_" underline-bold-italic))))
384 385 386 387 388 389 390 391
    (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))
392 393 394 395 396 397
     '(;; 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)
398 399
       ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
	2 3 gnus-emphasis-underline))))
400
  "*Alist that says how to fontify certain phrases.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
401 402 403 404 405 406 407 408 409
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."
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
  :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))
429 430
	    regexp
	    (integer :format "Match group: %v")
431
	    (integer :format "Emphasize group: %v")
432 433 434 435
	    face)
     (group :tag "Simple"
	    :value (("_" . "_") nil default)
	    (cons :format "%v"
436 437
		  (regexp :format "Start regexp: %v")
		  (regexp :format "End regexp: %v"))
438 439 440 441 442 443 444 445 446
	    (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
447 448
  :group 'gnus-article-emphasis)

449 450 451 452 453
(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
454
  :version "21.1"
455 456 457
  :group 'gnus-article-emphasis
  :type 'regexp)

458
(defface gnus-emphasis-bold '((t (:bold t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
459 460 461
  "Face used for displaying strong emphasized text (*word*)."
  :group 'gnus-article-emphasis)

462
(defface gnus-emphasis-italic '((t (:italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
463 464 465 466 467 468 469
  "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)

470
(defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
471 472 473
  "Face used for displaying underlined bold emphasized text (_*word*_)."
  :group 'gnus-article-emphasis)

474
(defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
475
  "Face used for displaying underlined italic emphasized text (_/word/_)."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
476 477
  :group 'gnus-article-emphasis)

478
(defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
479 480 481 482
  "Face used for displaying bold italic emphasized text (/*word*/)."
  :group 'gnus-article-emphasis)

(defface gnus-emphasis-underline-bold-italic
483
  '((t (:bold t :italic t :underline t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
484
  "Face used for displaying underlined bold italic emphasized text.
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
485
Example: (_/*word*/_)."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
486 487
  :group 'gnus-article-emphasis)

488 489 490 491 492 493
(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)

494 495 496 497 498
(defface gnus-emphasis-highlight-words
  '((t (:background "black" :foreground "yellow")))
  "Face used for displaying highlighted words."
  :group 'gnus-article-emphasis)

499
(defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
500
  "Format for display of Date headers in article bodies.
501 502 503 504 505
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'."
506
  :type '(choice string function)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
507 508 509 510
  :link '(custom-manual "(gnus)Article Date")
  :group 'gnus-article-washing)

(defcustom gnus-save-all-headers t
Miles Bader's avatar
Miles Bader committed
511 512 513 514
  "*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
515 516 517 518 519 520 521 522 523 524 525 526 527 528
  :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)
529
		 (sexp :tag "once" :format "%t\n" :value t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
530 531 532 533 534

(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
535 536 537 538
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
539
  :group 'gnus-article-saving
540
  :type 'regexp)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
541

542
;; Note that "Rmail format" is mbox since Emacs 23, but Babyl before.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
543
(defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
Paul Eggert's avatar
Paul Eggert committed
544
  "A function to save articles in your favorite format.
Miles Bader's avatar
Miles Bader committed
545 546
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
547 548 549 550 551 552 553

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)
554
* gnus-summary-save-body-in-file (article body)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
555
* gnus-summary-save-in-vm (use VM's folder format)
Miles Bader's avatar
Miles Bader committed
556 557
* gnus-summary-write-to-file (article format -- overwrite)
* gnus-summary-write-body-to-file (article body -- overwrite)
Miles Bader's avatar
Miles Bader committed
558
* gnus-summary-save-in-pipe (article format)
Miles Bader's avatar
Miles Bader committed
559 560 561 562 563 564

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',
Miles Bader's avatar
Miles Bader committed
565 566
`gnus-summary-write-to-file', `gnus-summary-write-body-to-file', and
`gnus-summary-save-in-pipe'.
Miles Bader's avatar
Miles Bader committed
567 568 569 570 571 572 573 574 575 576 577 578 579

* :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
580 581 582 583 584
  :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)
585
		(function-item gnus-summary-save-body-in-file)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
586
		(function-item gnus-summary-save-in-vm)
587
		(function-item gnus-summary-write-to-file)
Miles Bader's avatar
Miles Bader committed
588
		(function-item gnus-summary-write-body-to-file)
Miles Bader's avatar
Miles Bader committed
589
		(function-item gnus-summary-save-in-pipe)
590
		(function)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
591

Miles Bader's avatar
Miles Bader committed
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
(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
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
(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))
660
  "*Variable used to suggest where articles are to be saved.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
661 662 663 664 665 666 667
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\"))

668 669 670
This variable is an alist where the key is the match and the
value is a list of possible files to save in if the match is
non-nil.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
671 672 673 674

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
Paul Eggert's avatar
Paul Eggert committed
675
parameter.  If it is a list, it will be evalled in the same buffer.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
676

677 678 679
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."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
680
  :group 'gnus-article-saving
681 682 683
  :type '(repeat (choice (list :value (fun) function)
			 (cons :value ("" "") regexp (repeat string))
			 (sexp :value nil))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
684 685 686 687 688 689 690 691

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

692
(defcustom gnus-article-mode-line-format "Gnus: %g %S%m"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
693
  "*The format specification for the article mode line.
694 695 696 697 698 699
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."
700
  :version "24.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
701 702 703 704 705 706 707 708
  :type 'string
  :group 'gnus-article-various)

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

709 710 711 712 713 714 715
(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
716 717 718 719 720 721
(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
722
  "*A hook called after an article has been prepared in the article buffer."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
723 724 725
  :type 'hook
  :group 'gnus-article-various)

726 727 728
(defcustom gnus-copy-article-ignored-headers nil
  "List of headers to be removed when copying an article.
Each element is a regular expression."
729
  :version "23.1" ;; No Gnus
730 731 732
  :type '(repeat regexp)
  :group 'gnus-article-various)

733
(make-obsolete-variable 'gnus-article-hide-pgp-hook nil
734
			"Gnus 5.10 (Emacs 22.1)")
735

736 737 738 739 740 741
(defface gnus-button
  '((t (:weight bold)))
  "Face used for highlighting a button in the article buffer."
  :group 'gnus-article-buttons)

(defcustom gnus-article-button-face 'gnus-button
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
  "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)

757
(defcustom gnus-signature-face 'gnus-signature
758
  "Face used for highlighting a signature in the article buffer.
759
Obsolete; use the face `gnus-signature' for customizations instead."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
760 761 762 763
  :type 'face
  :group 'gnus-article-highlight
  :group 'gnus-article-signature)

764
(defface gnus-signature
765
  '((t
766
     (:italic t)))
767 768 769
  "Face used for highlighting a signature in the article buffer."
  :group 'gnus-article-highlight
  :group 'gnus-article-signature)
770 771
;; backward-compatibility alias
(put 'gnus-signature-face 'face-alias 'gnus-signature)
772
(put 'gnus-signature-face 'obsolete-face "22.1")
773

774
(defface gnus-header-from
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
775 776
  '((((class color)
      (background dark))
777
     (:foreground "PaleGreen1"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
778 779
    (((class color)
      (background light))
780
     (:foreground "red3"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
781
    (t
782
     (:italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
783 784 785
  "Face used for displaying from headers."
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
786 787
;; backward-compatibility alias
(put 'gnus-header-from-face 'face-alias 'gnus-header-from)
788
(put 'gnus-header-from-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
789

790
(defface gnus-header-subject
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
791 792
  '((((class color)
      (background dark))
793
     (:foreground "SeaGreen1"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
794 795
    (((class color)
      (background light))
796
     (:foreground "red4"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
797
    (t
798
     (:bold t :italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
799 800 801
  "Face used for displaying subject headers."
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
802 803
;; backward-compatibility alias
(put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
804
(put 'gnus-header-subject-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
805

806
(defface gnus-header-newsgroups
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
807 808
  '((((class color)
      (background dark))
809
     (:foreground "yellow" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
810 811
    (((class color)
      (background light))
812
     (:foreground "MidnightBlue" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
813
    (t
814 815 816 817
     (: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
818 819
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
820 821
;; backward-compatibility alias
(put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
822
(put 'gnus-header-newsgroups-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
823

824
(defface gnus-header-name
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
825 826
  '((((class color)
      (background dark))
827
     (:foreground "SpringGreen2"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
828 829 830 831
    (((class color)
      (background light))
     (:foreground "maroon"))
    (t
832
     (:bold t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
833 834 835
  "Face used for displaying header names."
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
836 837
;; backward-compatibility alias
(put 'gnus-header-name-face 'face-alias 'gnus-header-name)
838
(put 'gnus-header-name-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
839

840
(defface gnus-header-content
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
841 842
  '((((class color)
      (background dark))
843
     (:foreground "SpringGreen1" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
844 845
    (((class color)
      (background light))
846
     (:foreground "indianred4" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
847
    (t
848
     (:italic t)))  "Face used for displaying header content."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
849 850
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
851 852
;; backward-compatibility alias
(put 'gnus-header-content-face 'face-alias 'gnus-header-content)
853
(put 'gnus-header-content-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
854 855

(defcustom gnus-header-face-alist
856 857 858 859
  '(("From" nil gnus-header-from)
    ("Subject" nil gnus-header-subject)
    ("Newsgroups:.*," nil gnus-header-newsgroups)
    ("" gnus-header-name gnus-header-content))
860
  "*Controls highlighting of article headers.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
861 862 863

An alist of the form (HEADER NAME CONTENT).

864 865
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
866 867

The name of each header field will be displayed using the face
868 869 870
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
871 872 873 874 875 876 877 878 879 880
  :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)))))

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
(defcustom gnus-face-properties-alist (if (featurep 'xemacs)
					  '((xface . (:face gnus-x-face)))
					'((pbm . (:face gnus-x-face))
					  (png . nil)))
  "Alist of image types and properties applied to Face and X-Face images.
Here are examples:

;; Specify the altitude of Face images in the From header.
\(setq gnus-face-properties-alist
      '((pbm . (:face gnus-x-face :ascent 80))
	(png . (:ascent 80))))

;; Show Face images as pressed buttons.
\(setq gnus-face-properties-alist
      '((pbm . (:face gnus-x-face :relief -2))
	(png . (:relief -2))))

See the manual for the valid properties for various image types.
Currently, `pbm' is used for X-Face images and `png' is used for Face
images in Emacs.  Only the `:face' property is effective on the `xface'
image type in XEmacs if it is built with the libcompface library."
902
  :version "23.1" ;; No Gnus
903 904 905
  :group 'gnus-article-headers
  :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))

906
(defcustom gnus-article-decode-hook
907 908
  '(article-decode-charset article-decode-encoded-words
			   article-decode-group-name article-decode-idna-rhs)
909 910 911 912 913 914 915 916 917 918 919 920
  "*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
921 922 923
(defvar gnus-decode-address-function 'mail-decode-encoded-address-region
  "Function used to decode addresses.")

924
(defvar gnus-article-dumbquotes-map
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
  '((?\200 "EUR")
    (?\202 ",")
    (?\203 "f")
    (?\204 ",,")
    (?\205 "...")
    (?\213 "<")
    (?\214 "OE")
    (?\221 "`")
    (?\222 "'")
    (?\223 "``")
    (?\224 "\"")
    (?\225 "*")
    (?\226 "-")
    (?\227 "--")
    (?\230 "~")
    (?\231 "(TM)")
    (?\233 ">")
    (?\234 "oe")
    (?\264 "'"))
944 945 946 947
  "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
948
  :version "21.1"
949 950 951 952
  :group 'gnus-article-mime
  :type '(repeat regexp))

(defcustom gnus-unbuttonized-mime-types '(".*/.*")
953 954 955 956 957 958 959 960 961 962 963
  "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
964 965 966
`(\"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'.
967
This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
968
  :version "22.1"
969 970 971
  :group 'gnus-article-mime
  :type '(repeat regexp))

972 973 974 975 976
(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'."
977
  :version "22.1"
978
  :group 'gnus-article-mime
979 980 981 982 983 984
  :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'."
985
  :version "22.1"
986 987 988 989
  :group 'gnus-article-various
  :type '(choice (item :tag "None" :value nil)
		 string))

990 991
(defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
				  "/usr/share/picons")
992 993 994
  "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"
995
  :version "22.1"
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
  :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))

1010 1011 1012 1013 1014
(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
1015 1016
  :type '(choice (const nil)
		 function))
1017 1018

(defcustom gnus-mime-multipart-functions nil
Dave Love's avatar
Dave Love committed
1019 1020 1021
  "An alist of MIME types to functions to display them."
  :version "21.1"
  :group 'gnus-article-mime
1022
  :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1023

1024
(defcustom gnus-article-date-headers '(combined-lapsed)
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
  "A list of Date header formats to display.
Valid formats are `ut' (universal time), `local' (local time
zone), `english' (readable English), `lapsed' (elapsed time),
`combined-lapsed' (both the original date and the elapsed time),
`original' (the original date header), `iso8601' (ISO8601
format), and `user-defined' (a user-defined format defined by the
`gnus-article-time-format' variable).

You have as many date headers as you want in the article buffer.
Some of these headers are updated automatically.  See
`gnus-article-update-date-headers' for details."
  :version "24.1"
1037
  :group 'gnus-article-headers
1038 1039 1040 1041 1042 1043 1044 1045 1046
  :type '(set
	  (const :tag "Universal time (UT)" ut)
	  (const :tag "Local time zone" local)
	  (const :tag "Readable English" english)
	  (const :tag "Elapsed time" lapsed)
	  (const :tag "Original and elapsed time" combined-lapsed)
	  (const :tag "Original date header" original)
	  (const :tag "ISO8601 format" iso8601)
	  (const :tag "User-defined" user-defined)))
1047

1048
(defcustom gnus-article-update-date-headers nil
1049
  "A number that says how often to update the date header (in seconds).
1050 1051 1052 1053 1054 1055 1056
If nil, don't update it at all."
  :version "24.1"
  :group 'gnus-article-headers
  :type '(choice
	  (item :tag "Don't update" :value nil)
	  integer))

1057 1058 1059
(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.
1060 1061 1062
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
1063
the function return t is used.  For nil, the first part is
1064
used."
Dave Love's avatar
Dave Love committed
1065
  :version "21.1"
1066
  :group 'gnus-article-mime
1067
  :type '(choice
1068 1069
	  (item :tag "first" :value nil)
	  (item :tag "undisplayed" :value undisplayed)
1070
	  (item :tag "undisplayed or alternative"
1071 1072 1073
		:value undisplayed-alternative)
	  (function)))

1074 1075
(defcustom gnus-mime-action-alist
  '(("save to file" . gnus-mime-save-part)
1076
    ("save and strip" . gnus-mime-save-part-and-strip)
1077
    ("replace with file" . gnus-mime-replace-part)
1078
    ("delete part" . gnus-mime-delete-part)
1079 1080 1081 1082
    ("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)
1083
    ("toggle display" . gnus-article-view-part-as-charset)
1084
    ("view as type" . gnus-mime-view-part-as-type)
1085 1086
    ("view internally" . gnus-mime-view-part-internally)
    ("view externally" . gnus-mime-view-part-externally))
1087 1088 1089 1090 1091
  "An alist of actions that run on the MIME attachment."
  :group 'gnus-article-mime
  :type '(repeat (cons (string :tag "name")
		       (function))))

1092 1093 1094 1095 1096 1097
(defcustom gnus-auto-select-part 1
  "Advance to next MIME part when deleting or stripping parts.

When 0, point will be placed on the same part as before.  When
positive (negative), move point forward (backwards) this many
parts.  When nil, redisplay article."
1098
  :version "23.1" ;; No Gnus
1099 1100 1101 1102 1103 1104
  :group 'gnus-article-mime
  :type '(choice (const nil :tag "Redisplay article.")
		 (const 1 :tag "Next part.")
		 (const 0 :tag "Current part.")
		 integer))

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
;;;
;;; 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)
1116
	   (const :tag "First" first)
1117 1118 1119 1120 1121 1122 1123 1124 1125
	   (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)))

1126
(defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
1127 1128
				   "text/x-patch" "text/html")
  "Part types eligible for treatment.")
1129 1130 1131 1132

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

1133
(defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1134
  "Highlight the signature.
1135 1136
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1137
  :group 'gnus-article-treat
1138
  :link '(custom-manual "(gnus)Customizing Articles")
1139 1140 1141 1142 1143
  :type gnus-article-treat-custom)
(put 'gnus-treat-highlight-signature 'highlight t)

(defcustom gnus-treat-buttonize 100000
  "Add buttons.
1144 1145
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1146
  :group 'gnus-article-treat
1147
  :link '(custom-manual "(gnus)Customizing Articles")
1148 1149 1150 1151 1152
  :type gnus-article-treat-custom)
(put 'gnus-treat-buttonize 'highlight t)

(defcustom gnus-treat-buttonize-head 'head
  "Add buttons to the head.
1153 1154
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1155
  :group 'gnus-article-treat
1156
  :link '(custom-manual "(gnus)Customizing Articles")
1157 1158 1159
  :type gnus-article-treat-head-custom)
(put 'gnus-treat-buttonize-head 'highlight t)

1160 1161 1162 1163 1164 1165 1166 1167 1168
(defcustom gnus-treat-date 'head
  "Display dates according to the `gnus-article-date-headers' variable.
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
  :version "24.1"
  :group 'gnus-article-treat
  :link '(custom-manual "(gnus)Customizing Articles")
  :type gnus-article-treat-head-custom)

Miles Bader's avatar
Miles Bader committed
1169
(defcustom gnus-treat-emphasize 50000
1170
  "Emphasize text.
1171 1172
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1173
  :group 'gnus-article-treat
1174
  :link '(custom-manual "(gnus)Customizing Articles")
1175 1176 1177 1178 1179
  :type gnus-article-treat-custom)
(put 'gnus-treat-emphasize 'highlight t)

(defcustom gnus-treat-strip-cr nil
  "Remove carriage returns.
1180 1181
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1182
  :version "22.1"
1183
  :group 'gnus-article-treat
1184 1185 1186 1187 1188
  :link '(custom-manual "(gnus)Customizing Articles")
  :type gnus-article-treat-custom)

(defcustom gnus-treat-unsplit-urls nil
  "Remove newlines from within URLs.
1189 1190
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1191
  :version "22.1"
1192 1193 1194 1195 1196 1197
  :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.
1198 1199
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1200
  :version "22.1"
1201 1202
  :group 'gnus-article-treat
  :link '(custom-manual "(gnus)Customizing Articles")
1203 1204 1205