1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
9 ;; Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
10 ;; Keywords: news, mail
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
33 (eval '(run-hooks 'gnus-load-hook))
35 (eval-when-compile (require 'cl))
36 (eval-when-compile (require 'static))
40 (autoload 'message-y-or-n-p "message" nil nil 'macro)
45 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
49 (defgroup gnus-format nil
50 "Dealing with formatting issues."
53 (defgroup gnus-charset nil
54 "Group character set issues."
55 :link '(custom-manual "(gnus)Charsets")
59 (defgroup gnus-cache nil
61 :link '(custom-manual "(gnus)Article Caching")
64 (defgroup gnus-registry nil
68 (defgroup gnus-start nil
69 "Starting your favorite newsreader."
72 (defgroup gnus-start-server nil
73 "Server options at startup."
76 ;; These belong to gnus-group.el.
77 (defgroup gnus-group nil
79 :link '(custom-manual "(gnus)Group Buffer")
82 (defgroup gnus-group-foreign nil
84 :link '(custom-manual "(gnus)Foreign Groups")
87 (defgroup gnus-group-new nil
88 "Automatic subscription of new groups."
91 (defgroup gnus-group-levels nil
93 :link '(custom-manual "(gnus)Group Levels")
96 (defgroup gnus-group-select nil
98 :link '(custom-manual "(gnus)Selecting a Group")
101 (defgroup gnus-group-listing nil
102 "Showing slices of the group list."
103 :link '(custom-manual "(gnus)Listing Groups")
106 (defgroup gnus-group-visual nil
107 "Sorting the group buffer."
108 :link '(custom-manual "(gnus)Group Buffer Format")
112 (defgroup gnus-group-various nil
113 "Various group options."
114 :link '(custom-manual "(gnus)Scanning New Messages")
117 ;; These belong to gnus-sum.el.
118 (defgroup gnus-summary nil
120 :link '(custom-manual "(gnus)Summary Buffer")
123 (defgroup gnus-summary-exit nil
124 "Leaving summary buffers."
125 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
126 :group 'gnus-summary)
128 (defgroup gnus-summary-marks nil
129 "Marks used in summary buffers."
130 :link '(custom-manual "(gnus)Marking Articles")
131 :group 'gnus-summary)
133 (defgroup gnus-thread nil
134 "Ordering articles according to replies."
135 :link '(custom-manual "(gnus)Threading")
136 :group 'gnus-summary)
138 (defgroup gnus-summary-format nil
139 "Formatting of the summary buffer."
140 :link '(custom-manual "(gnus)Summary Buffer Format")
141 :group 'gnus-summary)
143 (defgroup gnus-summary-choose nil
145 :link '(custom-manual "(gnus)Choosing Articles")
146 :group 'gnus-summary)
148 (defgroup gnus-summary-maneuvering nil
149 "Summary movement commands."
150 :link '(custom-manual "(gnus)Summary Maneuvering")
151 :group 'gnus-summary)
153 (defgroup gnus-picon nil
154 "Show pictures of people, domains, and newsgroups."
157 (defgroup gnus-summary-mail nil
158 "Mail group commands."
159 :link '(custom-manual "(gnus)Mail Group Commands")
160 :group 'gnus-summary)
162 (defgroup gnus-summary-sort nil
163 "Sorting the summary buffer."
164 :link '(custom-manual "(gnus)Sorting the Summary Buffer")
165 :group 'gnus-summary)
167 (defgroup gnus-summary-visual nil
168 "Highlighting and menus in the summary buffer."
169 :link '(custom-manual "(gnus)Summary Highlighting")
171 :group 'gnus-summary)
173 (defgroup gnus-summary-various nil
174 "Various summary buffer options."
175 :link '(custom-manual "(gnus)Various Summary Stuff")
176 :group 'gnus-summary)
178 (defgroup gnus-summary-pick nil
179 "Pick mode in the summary buffer."
180 :link '(custom-manual "(gnus)Pick and Read")
182 :group 'gnus-summary)
184 (defgroup gnus-summary-tree nil
185 "Tree display of threads in the summary buffer."
186 :link '(custom-manual "(gnus)Tree Display")
188 :group 'gnus-summary)
190 ;; Belongs to gnus-uu.el
191 (defgroup gnus-extract-view nil
192 "Viewing extracted files."
193 :link '(custom-manual "(gnus)Viewing Files")
194 :group 'gnus-extract)
196 ;; Belongs to gnus-score.el
197 (defgroup gnus-score nil
198 "Score and kill file handling."
201 (defgroup gnus-score-kill nil
205 (defgroup gnus-score-adapt nil
206 "Adaptive score files."
209 (defgroup gnus-score-default nil
210 "Default values for score files."
213 (defgroup gnus-score-expire nil
214 "Expiring score rules."
217 (defgroup gnus-score-decay nil
218 "Decaying score rules."
221 (defgroup gnus-score-files nil
222 "Score and kill file names."
226 (defgroup gnus-score-various nil
227 "Various scoring and killing options."
231 (defgroup gnus-visual nil
232 "Options controlling the visual fluff."
236 (defgroup gnus-agent nil
237 "Offline support for Gnus."
240 (defgroup gnus-files nil
241 "Files used by Gnus."
244 (defgroup gnus-dribble-file nil
246 :link '(custom-manual "(gnus)Auto Save")
249 (defgroup gnus-newsrc nil
250 "Storing Gnus state."
253 (defgroup gnus-server nil
254 "Options related to newsservers and other servers used by Gnus."
257 (defgroup gnus-server-visual nil
258 "Highlighting and menus in the server buffer."
262 (defgroup gnus-message '((message custom-group))
263 "Composing replies and followups in Gnus."
266 (defgroup gnus-meta nil
267 "Meta variables controlling major portions of Gnus.
268 In general, modifying these variables does not take affect until Gnus
269 is restarted, and sometimes reloaded."
272 (defgroup gnus-various nil
273 "Other Gnus options."
274 :link '(custom-manual "(gnus)Various Various")
277 (defgroup gnus-mime nil
278 "Variables for controlling the Gnus MIME interface."
281 (defgroup gnus-exit nil
283 :link '(custom-manual "(gnus)Exiting Gnus")
286 (defgroup gnus-fun nil
287 "Frivolous Gnus extensions."
288 :link '(custom-manual "(gnus)Exiting Gnus")
291 (defcustom gnus-inhibit-startup-message nil
292 "If non-nil, the startup message will not be displayed.
293 This variable is used before `.gnus.el' is loaded, so it should
294 be set in `.emacs' instead."
298 (defcustom gnus-play-startup-jingle nil
299 "If non-nil, play the Gnus jingle at startup."
303 (unless (fboundp 'gnus-group-remove-excess-properties)
304 (defalias 'gnus-group-remove-excess-properties 'ignore))
306 (unless (featurep 'gnus-xmas)
307 (defalias 'gnus-make-overlay 'make-overlay)
308 (defalias 'gnus-delete-overlay 'delete-overlay)
309 (defalias 'gnus-overlay-put 'overlay-put)
310 (defalias 'gnus-move-overlay 'move-overlay)
311 (defalias 'gnus-overlay-buffer 'overlay-buffer)
312 (defalias 'gnus-overlay-start 'overlay-start)
313 (defalias 'gnus-overlay-end 'overlay-end)
314 (defalias 'gnus-extent-detached-p 'ignore)
315 (defalias 'gnus-extent-start-open 'ignore)
316 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
317 (defalias 'gnus-character-to-event 'identity)
318 (defalias 'gnus-assq-delete-all 'assq-delete-all)
319 (defalias 'gnus-add-text-properties 'add-text-properties)
320 (defalias 'gnus-put-text-property 'put-text-property)
321 (defvar gnus-mode-line-image-cache t)
322 (if (fboundp 'find-image)
323 (defun gnus-mode-line-buffer-identification (line)
324 (let ((str (car-safe line)))
325 (if (and (stringp str)
326 (string-match "^Gnus:" str))
327 (progn (add-text-properties
330 (if (eq t gnus-mode-line-image-cache)
331 (setq gnus-mode-line-image-cache
333 '((:type xpm :file "gnus-pointer.xpm"
335 (:type xbm :file "gnus-pointer.xbm"
337 gnus-mode-line-image-cache)
340 gnus-version (gnus-emacs-version)))
344 (defalias 'gnus-mode-line-buffer-identification 'identity))
345 (defalias 'gnus-characterp 'numberp)
346 (defalias 'gnus-deactivate-mark 'deactivate-mark)
347 (defalias 'gnus-window-edges 'window-edges)
348 (defalias 'gnus-key-press-event-p 'numberp)
349 ;;(defalias 'gnus-decode-rfc1522 'ignore)
352 ;; We define these group faces here to avoid the display
353 ;; update forced when creating new faces.
355 (defface gnus-group-news-1-face
358 (:foreground "PaleTurquoise" :bold t))
361 (:foreground "ForestGreen" :bold t))
364 "Level 1 newsgroup face.")
366 (defface gnus-group-news-1-empty-face
369 (:foreground "PaleTurquoise"))
372 (:foreground "ForestGreen"))
375 "Level 1 empty newsgroup face.")
377 (defface gnus-group-news-2-face
380 (:foreground "turquoise" :bold t))
383 (:foreground "CadetBlue4" :bold t))
386 "Level 2 newsgroup face.")
388 (defface gnus-group-news-2-empty-face
391 (:foreground "turquoise"))
394 (:foreground "CadetBlue4"))
397 "Level 2 empty newsgroup face.")
399 (defface gnus-group-news-3-face
408 "Level 3 newsgroup face.")
410 (defface gnus-group-news-3-empty-face
419 "Level 3 empty newsgroup face.")
421 (defface gnus-group-news-4-face
430 "Level 4 newsgroup face.")
432 (defface gnus-group-news-4-empty-face
441 "Level 4 empty newsgroup face.")
443 (defface gnus-group-news-5-face
452 "Level 5 newsgroup face.")
454 (defface gnus-group-news-5-empty-face
463 "Level 5 empty newsgroup face.")
465 (defface gnus-group-news-6-face
474 "Level 6 newsgroup face.")
476 (defface gnus-group-news-6-empty-face
485 "Level 6 empty newsgroup face.")
487 (defface gnus-group-news-low-face
490 (:foreground "DarkTurquoise" :bold t))
493 (:foreground "DarkGreen" :bold t))
496 "Low level newsgroup face.")
498 (defface gnus-group-news-low-empty-face
501 (:foreground "DarkTurquoise"))
504 (:foreground "DarkGreen"))
507 "Low level empty newsgroup face.")
509 (defface gnus-group-mail-1-face
512 (:foreground "aquamarine1" :bold t))
515 (:foreground "DeepPink3" :bold t))
518 "Level 1 mailgroup face.")
520 (defface gnus-group-mail-1-empty-face
523 (:foreground "aquamarine1"))
526 (:foreground "DeepPink3"))
528 (:italic t :bold t)))
529 "Level 1 empty mailgroup face.")
531 (defface gnus-group-mail-2-face
534 (:foreground "aquamarine2" :bold t))
537 (:foreground "HotPink3" :bold t))
540 "Level 2 mailgroup face.")
542 (defface gnus-group-mail-2-empty-face
545 (:foreground "aquamarine2"))
548 (:foreground "HotPink3"))
551 "Level 2 empty mailgroup face.")
553 (defface gnus-group-mail-3-face
556 (:foreground "aquamarine3" :bold t))
559 (:foreground "magenta4" :bold t))
562 "Level 3 mailgroup face.")
564 (defface gnus-group-mail-3-empty-face
567 (:foreground "aquamarine3"))
570 (:foreground "magenta4"))
573 "Level 3 empty mailgroup face.")
575 (defface gnus-group-mail-low-face
578 (:foreground "aquamarine4" :bold t))
581 (:foreground "DeepPink4" :bold t))
584 "Low level mailgroup face.")
586 (defface gnus-group-mail-low-empty-face
589 (:foreground "aquamarine4"))
592 (:foreground "DeepPink4"))
595 "Low level empty mailgroup face.")
597 ;; Summary mode faces.
599 (defface gnus-summary-selected-face '((t
601 "Face used for selected articles.")
603 (defface gnus-summary-cancelled-face
605 (:foreground "yellow" :background "black")))
606 "Face used for cancelled articles.")
608 (defface gnus-summary-high-ticked-face
611 (:foreground "pink" :bold t))
614 (:foreground "firebrick" :bold t))
617 "Face used for high interest ticked articles.")
619 (defface gnus-summary-low-ticked-face
622 (:foreground "pink" :italic t))
625 (:foreground "firebrick" :italic t))
628 "Face used for low interest ticked articles.")
630 (defface gnus-summary-normal-ticked-face
633 (:foreground "pink"))
636 (:foreground "firebrick"))
639 "Face used for normal interest ticked articles.")
641 (defface gnus-summary-high-ancient-face
644 (:foreground "SkyBlue" :bold t))
647 (:foreground "RoyalBlue" :bold t))
650 "Face used for high interest ancient articles.")
652 (defface gnus-summary-low-ancient-face
655 (:foreground "SkyBlue" :italic t))
658 (:foreground "RoyalBlue" :italic t))
661 "Face used for low interest ancient articles.")
663 (defface gnus-summary-normal-ancient-face
666 (:foreground "SkyBlue"))
669 (:foreground "RoyalBlue"))
672 "Face used for normal interest ancient articles.")
674 (defface gnus-summary-high-undownloaded-face
677 (:bold t :foreground "cyan4"))
678 (((class color) (background dark))
679 (:bold t :foreground "LightGray"))
680 (t (:inverse-video t :bold t)))
681 "Face used for high interest uncached articles.")
683 (defface gnus-summary-low-undownloaded-face
686 (:italic t :foreground "cyan4" :bold nil))
687 (((class color) (background dark))
688 (:italic t :foreground "LightGray" :bold nil))
689 (t (:inverse-video t :italic t)))
690 "Face used for low interest uncached articles.")
692 (defface gnus-summary-normal-undownloaded-face
695 (:foreground "cyan4" :bold nil))
696 (((class color) (background dark))
697 (:foreground "LightGray" :bold nil))
698 (t (:inverse-video t)))
699 "Face used for normal interest uncached articles.")
701 (defface gnus-summary-high-unread-face
704 "Face used for high interest unread articles.")
706 (defface gnus-summary-low-unread-face
709 "Face used for low interest unread articles.")
711 (defface gnus-summary-normal-unread-face
714 "Face used for normal interest unread articles.")
716 (defface gnus-summary-incorporated-face
719 "Face used for incorporated articles.")
721 (defface gnus-summary-high-read-face
724 (:foreground "PaleGreen"
728 (:foreground "DarkGreen"
732 "Face used for high interest read articles.")
734 (defface gnus-summary-low-read-face
737 (:foreground "PaleGreen"
741 (:foreground "DarkGreen"
745 "Face used for low interest read articles.")
747 (defface gnus-summary-normal-read-face
750 (:foreground "PaleGreen"))
753 (:foreground "DarkGreen"))
756 "Face used for normal interest read articles.")
763 (defvar gnus-buffers nil)
765 (defun gnus-get-buffer-create (name)
766 "Do the same as `get-buffer-create', but store the created buffer."
767 (or (get-buffer name)
768 (car (push (get-buffer-create name) gnus-buffers))))
770 (defun gnus-add-buffer ()
771 "Add the current buffer to the list of Gnus buffers."
772 (push (current-buffer) gnus-buffers))
774 (defmacro gnus-kill-buffer (buffer)
775 "Kill BUFFER and remove from the list of Gnus buffers."
776 `(let ((buf ,buffer))
777 (when (gnus-buffer-exists-p buf)
778 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
781 (defun gnus-buffers ()
782 "Return a list of live Gnus buffers."
783 (while (and gnus-buffers
784 (not (buffer-name (car gnus-buffers))))
786 (let ((buffers gnus-buffers))
788 (if (buffer-name (cadr buffers))
790 (setcdr buffers (cddr buffers)))))
795 (defvar gnus-group-buffer "*Group*")
798 (autoload 'gnus-play-jingle "gnus-audio"))
800 (defface gnus-splash-face
803 (:foreground "#888888"))
806 (:foreground "#888888"))
809 "Face for the splash screen.")
811 (defun gnus-splash ()
813 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
814 (let ((buffer-read-only nil))
816 (unless gnus-inhibit-startup-message
817 (gnus-group-startup-message)
819 (when gnus-play-startup-jingle
820 (gnus-play-jingle))))))
822 (defun gnus-indent-rigidly (start end arg)
823 "Indent rigidly using only spaces and no tabs."
826 (narrow-to-region start end)
828 (indent-rigidly start end arg)
829 ;; We translate tabs into spaces -- not everybody uses
830 ;; an 8-character tab.
831 (goto-char (point-min))
832 (while (search-forward "\t" nil t)
833 (replace-match " " t t))))))
835 (defvar gnus-simple-splash nil)
837 ;;(format "%02x%02x%02x" 114 66 20) "724214"
839 (defvar gnus-logo-color-alist
840 '((flame "#cc3300" "#ff2200")
841 (pine "#c0cc93" "#f8ffb8")
842 (moss "#a1cc93" "#d2ffb8")
843 (irish "#04cc90" "#05ff97")
844 (sky "#049acc" "#05deff")
845 (tin "#6886cc" "#82b6ff")
846 (velvet "#7c68cc" "#8c82ff")
847 (grape "#b264cc" "#cf7df")
848 (labia "#cc64c2" "#fd7dff")
849 (berry "#cc6485" "#ff7db5")
850 (dino "#724214" "#1e3f03")
851 (oort "#cccccc" "#888888")
852 (storm "#666699" "#99ccff")
853 (pdino "#9999cc" "#99ccff")
854 (purp "#9999cc" "#666699")
855 (no "#ff0000" "#ffff00")
856 (neutral "#b4b4b4" "#878787")
857 (september "#bf9900" "#ffcc00"))
858 "Color alist used for the Gnus logo.")
860 (defcustom gnus-logo-color-style 'no
861 "*Color styles used for the Gnus logo."
862 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
863 gnus-logo-color-alist))
866 (defvar gnus-logo-colors
867 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
868 "Colors used for the Gnus logo.")
870 (defun gnus-group-startup-message (&optional x y)
871 "Insert startup message in current buffer."
872 ;; Insert the message.
875 ((and (fboundp 'find-image)
877 (let* ((bg (face-background 'default))
878 (fg (face-foreground 'gnus-splash-face))
879 (data-directory (nnheader-find-etc-directory "gnus"))
881 `((:type xpm :file "gnus.xpm"
883 (("thing" . ,(car gnus-logo-colors))
884 ("shadow" . ,(cadr gnus-logo-colors))
886 ("background" . ,bg)))
887 (:type pbm :file "gnus.pbm"
888 ;; Account for the pbm's blackground.
889 :background ,bg :foreground ,fg)
890 (:type xbm :file "gnus.xbm"
891 ;; Account for the xbm's blackground.
892 :background ,bg :foreground ,fg)))))
896 (concat gnus-product-name " " gnus-version-number
897 (if (zerop (string-to-number gnus-revision-number))
899 (concat " (r" gnus-revision-number ")"))
900 " based on " gnus-original-product-name " v"
901 gnus-original-version-number)
902 'face `(variable-pitch :background ,bg :foreground ,fg)))
903 (let ((fill-column (window-width)))
904 (center-region (point-min) (point)))
905 (let ((size (image-size image)))
906 (insert-char ?\n (max 1 (round (- (window-height)
907 (or y (cdr size))) 2)))
909 (propertize " " 'display
911 ,(max 0 (round (- (window-width)
912 (or x (car size))) 2)))))
913 (insert-image image))
914 (setq gnus-simple-splash nil)
919 _ ___ __ ___ __ _ ___
938 (goto-char (point-min))
939 (insert gnus-product-name " " gnus-version-number
940 (if (zerop (string-to-number gnus-revision-number))
942 (concat " (r" gnus-revision-number ")"))
943 " based on " gnus-original-product-name " v"
944 gnus-original-version-number)
945 (insert-char ?\ (prog1
946 (max 0 (/ (- (window-width) (point)) 2))
947 (goto-char (point-min))))
950 (gnus-indent-rigidly (point) (point-max)
951 (/ (max (- (window-width) (or x 46)) 0) 2))
952 (goto-char (point-min))
954 (let* ((pheight (count-lines (point-min) (point-max)))
955 (wheight (window-height))
956 (rest (- wheight pheight)))
957 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
959 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
960 (setq gnus-simple-splash t)))
961 (goto-char (point-min))
962 (setq mode-line-buffer-identification (concat " " gnus-version))
963 (set-buffer-modified-p t))
966 (let ((command (format "%s" this-command)))
967 (when (string-match "gnus" command)
968 (if (string-match "gnus-other-frame" command)
969 (gnus-get-buffer-create gnus-group-buffer)
977 (defcustom gnus-parameters nil
978 "Alist of group parameters.
981 ((\"mail\\\\..*\" (gnus-show-threads nil)
982 (gnus-use-scoring nil)
983 (gnus-summary-line-format
984 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
987 (\"mail\\\\.me\" (gnus-use-scoring t))
988 (\"list\\\\..*\" (total-expire . t)
989 (broken-reply-to . t)))"
991 :group 'gnus-group-various
992 :type '(repeat (cons regexp
995 (defvar gnus-group-parameters-more nil)
997 (defvar gnus-colon-keywords
999 (when (boundp 'dgnushack-colon-keywords)
1000 (symbol-value 'dgnushack-colon-keywords)))
1001 "List of the colon keywords should be bound at run-time. This variable
1002 defaults to a proper value only if this file is byte-compiled by make.")
1004 (dolist (keyword gnus-colon-keywords)
1005 (set keyword keyword))
1007 (defmacro gnus-define-group-parameter (param &rest rest)
1008 "Define a group parameter PARAM.
1009 REST is a plist of following:
1010 :type One of `bool', `list' or nil.
1011 :function The name of the function.
1012 :function-document The documentation of the function.
1013 :parameter-type The type for customizing the parameter.
1014 :parameter-document The documentation for the parameter.
1015 :variable The name of the variable.
1016 :variable-document The documentation for the variable.
1017 :variable-group The group for customizing the variable.
1018 :variable-type The type for customizing the variable.
1019 :variable-default The default value of the variable."
1020 (let* ((type (plist-get rest :type))
1021 (parameter-type (plist-get rest :parameter-type))
1022 (parameter-document (plist-get rest :parameter-document))
1023 (function (or (plist-get rest :function)
1024 (intern (format "gnus-parameter-%s" param))))
1025 (function-document (or (plist-get rest :function-document) ""))
1026 (variable (or (plist-get rest :variable)
1027 (intern (format "gnus-parameter-%s-alist" param))))
1028 (variable-document (or (plist-get rest :variable-document) ""))
1029 (variable-group (plist-get rest :variable-group))
1030 (variable-type (or (plist-get rest :variable-type)
1032 (list (regexp :tag "Group")
1033 ,(car (cdr parameter-type)))))))
1034 (variable-default (plist-get rest :variable-default)))
1037 `(defcustom ,variable ,variable-default
1039 :group 'gnus-group-parameter
1040 :group ',variable-group
1041 :type ,variable-type)
1042 `(setq gnus-group-parameters-more
1043 (delq (assq ',param gnus-group-parameters-more)
1044 gnus-group-parameters-more))
1045 `(add-to-list 'gnus-group-parameters-more
1048 ,parameter-document))
1050 `(defun ,function (name)
1052 (let ((params (gnus-group-find-parameter name))
1055 ((memq ',param params)
1057 ((setq val (assq ',param params))
1059 ((stringp ,variable)
1060 (string-match ,variable name))
1062 (let ((alist ,variable)
1064 (while (setq elem (pop alist))
1066 (string-match (car elem) name))
1069 (if (consp value) (car value) value))))))
1070 `(defun ,function (name)
1073 (or (gnus-group-find-parameter name ',param ,(and type t))
1074 (let ((alist ,variable)
1076 (while (setq elem (pop alist))
1078 (string-match (car elem) name))
1083 '(if (consp value) (car value) value))))))))))
1085 (defcustom gnus-home-directory "~/"
1086 "Directory variable that specifies the \"home\" directory.
1087 All other Gnus file and directory variables are initialized from this variable."
1091 (defcustom gnus-directory (or (getenv "SAVEDIR")
1092 (nnheader-concat gnus-home-directory "News/"))
1093 "*Directory variable from which all other Gnus file variables are derived.
1095 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1096 This means that other directory variables that are initialized from
1097 this variable won't be set properly if you set this variable in `.gnus.el'.
1098 Set this variable in `.emacs' instead."
1102 (defcustom gnus-default-directory nil
1103 "*Default directory for all Gnus buffers."
1105 :type '(choice (const :tag "current" nil)
1108 ;; Site dependent variables. These variables should be defined in
1111 (defvar gnus-default-nntp-server nil
1112 "Specify a default NNTP server.
1113 This variable should be defined in paths.el, and should never be set
1115 If you want to change servers, you should use `gnus-select-method'.
1116 See the documentation to that variable.")
1118 ;; Don't touch this variable.
1119 (defvar gnus-nntp-service "nntp"
1120 "NNTP service name (\"nntp\" or 119).
1121 This is an obsolete variable, which is scarcely used. If you use an
1122 nntp server for your newsgroup and want to change the port number
1123 used to 899, you would say something along these lines:
1125 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1127 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1128 "A file with only the name of the nntp server in it."
1133 (defun gnus-getenv-nntpserver ()
1134 "Find default nntp server.
1135 Check the NNTPSERVER environment variable and the
1136 `gnus-nntpserver-file' file."
1137 (or (getenv "NNTPSERVER")
1138 (and (file-readable-p gnus-nntpserver-file)
1140 (insert-file-contents gnus-nntpserver-file)
1141 (when (re-search-forward "[^ \t\n\r]+" nil t)
1142 (match-string 0))))))
1144 (defcustom gnus-select-method
1147 (list 'nntp (or (condition-case nil
1148 (gnus-getenv-nntpserver)
1150 (when (and gnus-default-nntp-server
1151 (not (string= gnus-default-nntp-server "")))
1152 gnus-default-nntp-server)
1154 (if (or (null gnus-nntp-service)
1155 (equal gnus-nntp-service "nntp"))
1157 (list gnus-nntp-service)))
1159 "Default method for selecting a newsgroup.
1160 This variable should be a list, where the first element is how the
1161 news is to be fetched, the second is the address.
1163 For instance, if you want to get your news via \"flab.flab.edu\" using
1164 NNTP, you could say:
1166 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1168 If you want to use your local spool, say:
1170 \(setq gnus-select-method (list 'nnspool (system-name)))
1172 If you use this variable, you must set `gnus-nntp-server' to nil.
1174 There is a lot more to know about select methods and virtual servers -
1175 see the manual for details."
1177 :type 'gnus-select-method)
1179 (defcustom gnus-message-archive-method "archive"
1180 "*Method used for archiving messages you've sent.
1181 This should be a mail method."
1183 :group 'gnus-message
1184 :type '(choice (const :tag "Default archive method" "archive")
1185 gnus-select-method))
1187 (defcustom gnus-message-archive-group nil
1188 "*Name of the group in which to save the messages you've written.
1189 This can either be a string; a list of strings; or an alist
1190 of regexps/functions/forms to be evaluated to return a string (or a list
1191 of strings). The functions are called with the name of the current
1192 group (or nil) as a parameter.
1194 If you want to save your mail in one group and the news articles you
1195 write in another group, you could say something like:
1197 \(setq gnus-message-archive-group
1198 '((if (message-news-p)
1202 Normally the group names returned by this variable should be
1203 unprefixed -- which implicitly means \"store on the archive server\".
1204 However, you may wish to store the message on some other server. In
1205 that case, just return a fully prefixed name of the group --
1206 \"nnml+private:mail.misc\", for instance."
1207 :group 'gnus-message
1208 :type '(choice (const :tag "none" nil)
1213 (defcustom gnus-secondary-servers nil
1214 "List of NNTP servers that the user can choose between interactively.
1215 To make Gnus query you for a server, you have to give `gnus' a
1216 non-numeric prefix - `C-u M-x gnus', in short."
1218 :type '(repeat string))
1220 (defcustom gnus-nntp-server nil
1221 "*The name of the host running the NNTP server.
1222 This variable is semi-obsolete. Use the `gnus-select-method'
1225 :type '(choice (const :tag "disable" nil)
1228 (defcustom gnus-secondary-select-methods nil
1229 "A list of secondary methods that will be used for reading news.
1230 This is a list where each element is a complete select method (see
1231 `gnus-select-method').
1233 If, for instance, you want to read your mail with the nnml back end,
1234 you could set this variable:
1236 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1238 :type '(repeat gnus-select-method))
1240 (defvar gnus-backup-default-subscribed-newsgroups
1241 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1242 "Default default new newsgroups the first time Gnus is run.
1243 Should be set in paths.el, and shouldn't be touched by the user.")
1245 (defcustom gnus-local-domain nil
1246 "Local domain name without a host name.
1247 The DOMAINNAME environment variable is used instead if it is defined.
1248 If the function `system-name' returns the full Internet name, there is
1249 no need to set this variable."
1250 :group 'gnus-message
1251 :type '(choice (const :tag "default" nil)
1254 (defvar gnus-local-organization nil
1255 "String with a description of what organization (if any) the user belongs to.
1256 Obsolete variable; use `message-user-organization' instead.")
1258 ;; Customization variables
1260 (defcustom gnus-refer-article-method nil
1261 "Preferred method for fetching an article by Message-ID.
1262 If you are reading news from the local spool (with nnspool), fetching
1263 articles by Message-ID is painfully slow. By setting this method to an
1264 nntp method, you might get acceptable results.
1266 The value of this variable must be a valid select method as discussed
1267 in the documentation of `gnus-select-method'.
1269 It can also be a list of select methods, as well as the special symbol
1270 `current', which means to use the current select method. If it is a
1271 list, Gnus will try all the methods in the list until it finds a match."
1273 :type '(choice (const :tag "default" nil)
1275 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1277 (repeat :menu-tag "Try multiple"
1279 :value (current (nnweb "refer" (nnweb-type google)))
1280 (choice :tag "Method"
1282 (const :tag "Google"
1283 (nnweb "refer" (nnweb-type google)))
1284 gnus-select-method))))
1286 (defcustom gnus-group-faq-directory
1287 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1288 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1289 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1290 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1291 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1292 "/ftp@rtfm.mit.edu:/pub/usenet/"
1293 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1294 "/ftp@ftp.sunet.se:/pub/usenet/"
1295 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1296 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1297 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1298 "*Directory where the group FAQs are stored.
1299 This will most commonly be on a remote machine, and the file will be
1300 fetched by ange-ftp.
1302 This variable can also be a list of directories. In that case, the
1303 first element in the list will be used by default. The others can
1304 be used when being prompted for a site.
1306 Note that Gnus uses an aol machine as the default directory. If this
1307 feels fundamentally unclean, just think of it as a way to finally get
1308 something of value back from them.
1310 If the default site is too slow, try one of these:
1312 North America: mirrors.aol.com /pub/rtfm/usenet
1313 ftp.seas.gwu.edu /pub/rtfm
1314 rtfm.mit.edu /pub/usenet
1315 Europe: ftp.uni-paderborn.de /pub/FAQ
1316 src.doc.ic.ac.uk /usenet/news-FAQS
1317 ftp.sunet.se /pub/usenet
1318 ftp.pasteur.fr /pub/FAQ
1319 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1320 hwarang.postech.ac.kr /pub/usenet
1321 ftp.hk.super.net /mirror/faqs"
1322 :group 'gnus-group-various
1323 :type '(choice directory
1324 (repeat directory)))
1326 (defcustom gnus-group-charter-alist
1327 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1328 ("de" . (concat "http://purl.net/charta/" name ".html"))
1329 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1330 ("england" . (concat "http://england.news-admin.org/charters/" name))
1331 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1332 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1333 (gnus-replace-in-string name "europa\\." "") ".html"))
1334 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1335 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1336 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1337 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1338 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1339 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1340 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1341 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1342 (gnus-replace-in-string name "\\." "_") ".html"))
1343 ("milw" . (concat "http://usenet.mil.wi.us/"
1344 (gnus-replace-in-string name "milw\\." "") "-charter"))
1345 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1346 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1347 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1348 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1349 When FORM is evaluated `name' is bound to the name of the group."
1350 :group 'gnus-group-various
1351 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1353 (defcustom gnus-group-fetch-control-use-browse-url nil
1354 "*Non-nil means that control messages are displayed using `browse-url'.
1355 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1357 :group 'gnus-group-various
1360 (defcustom gnus-use-cross-reference t
1361 "*Non-nil means that cross referenced articles will be marked as read.
1362 If nil, ignore cross references. If t, mark articles as read in
1363 subscribed newsgroups. If neither t nor nil, mark as read in all
1366 :type '(choice (const :tag "off" nil)
1367 (const :tag "subscribed" t)
1371 (defcustom gnus-process-mark ?#
1373 :group 'gnus-group-visual
1374 :group 'gnus-summary-marks
1377 (defcustom gnus-large-newsgroup 200
1378 "*The number of articles which indicates a large newsgroup.
1379 If the number of articles in a newsgroup is greater than this value,
1380 confirmation is required for selecting the newsgroup.
1381 If it is nil, no confirmation is required."
1382 :group 'gnus-group-select
1383 :type '(choice (const :tag "No limit" nil)
1386 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1387 "*Non-nil means that the default name of a file to save articles in is the group name.
1388 If it's nil, the directory form of the group name is used instead.
1390 If this variable is a list, and the list contains the element
1391 `not-score', long file names will not be used for score files; if it
1392 contains the element `not-save', long file names will not be used for
1393 saving; and if it contains the element `not-kill', long file names
1394 will not be used for kill files.
1396 Note that the default for this variable varies according to what system
1397 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1398 to nil while on all other systems it defaults to t."
1400 :type '(radio (sexp :format "Non-nil\n"
1401 :match (lambda (widget value)
1402 (and value (not (listp value))))
1405 (checklist (const :format "%v " not-score)
1406 (const :format "%v " not-save)
1409 (defcustom gnus-kill-files-directory gnus-directory
1410 "*Name of the directory where kill files will be stored (default \"~/News\")."
1411 :group 'gnus-score-files
1412 :group 'gnus-score-kill
1415 (defcustom gnus-save-score nil
1416 "*If non-nil, save group scoring info."
1417 :group 'gnus-score-various
1421 (defcustom gnus-use-undo t
1422 "*If non-nil, allow undoing in Gnus group mode buffers."
1426 (defcustom gnus-use-adaptive-scoring nil
1427 "*If non-nil, use some adaptive scoring scheme.
1428 If a list, then the values `word' and `line' are meaningful. The
1429 former will perform adaption on individual words in the subject
1430 header while `line' will perform adaption on several headers."
1432 :group 'gnus-score-adapt
1433 :type '(set (const word) (const line)))
1435 (defcustom gnus-use-cache 'passive
1436 "*If nil, Gnus will ignore the article cache.
1437 If `passive', it will allow entering (and reading) articles
1438 explicitly entered into the cache. If anything else, use the
1439 cache to the full extent of the law."
1442 :type '(choice (const :tag "off" nil)
1443 (const :tag "passive" passive)
1444 (const :tag "active" t)))
1446 (defcustom gnus-use-trees nil
1447 "*If non-nil, display a thread tree buffer."
1451 (defcustom gnus-keep-backlog 20
1452 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1453 If it is a number N, then Gnus will only keep the last N articles
1454 read. If it is neither nil nor a number, Gnus will keep all read
1455 articles. This is not a good idea."
1457 :type '(choice (const :tag "off" nil)
1462 (defcustom gnus-use-nocem nil
1463 "*If non-nil, Gnus will read NoCeM cancel messages."
1467 (defcustom gnus-suppress-duplicates nil
1468 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1472 (defcustom gnus-use-scoring t
1473 "*If non-nil, enable scoring."
1477 (defcustom gnus-summary-prepare-exit-hook
1478 '(gnus-summary-expire-articles)
1479 "*A hook called when preparing to exit from the summary buffer.
1480 It calls `gnus-summary-expire-articles' by default."
1481 :group 'gnus-summary-exit
1484 (defcustom gnus-novice-user t
1485 "*Non-nil means that you are a Usenet novice.
1486 If non-nil, verbose messages may be displayed and confirmations may be
1491 (defcustom gnus-expert-user nil
1492 "*Non-nil means that you will never be asked for confirmation about anything.
1493 That doesn't mean *anything* anything; particularly destructive
1494 commands will still require prompting."
1498 (defcustom gnus-interactive-catchup t
1499 "*If non-nil, require your confirmation when catching up a group."
1500 :group 'gnus-group-select
1503 (defcustom gnus-interactive-exit t
1504 "*If non-nil, require your confirmation when exiting Gnus."
1508 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1509 "Function for extracting address components from a From header.
1510 Three pre-defined functions exist: `gnus-extract-address-components',
1511 which is the default, quite fast, and too simplistic solution,
1512 `mail-extract-address-components', which works much better, but is
1513 slower, and `std11-extract-address-components'."
1514 :group 'gnus-summary-format
1515 :type '(radio (function-item gnus-extract-address-components)
1516 (function-item mail-extract-address-components)
1517 (function-item std11-extract-address-components)
1518 (function :tag "Other")))
1520 (defcustom gnus-carpal nil
1521 "*If non-nil, display clickable icons."
1525 (defcustom gnus-shell-command-separator ";"
1526 "String used to separate shell commands."
1530 (defcustom gnus-valid-select-methods
1531 '(("nntp" post address prompt-address physical-address)
1532 ("nnspool" post address)
1533 ("nnvirtual" post-mail virtual prompt-address)
1534 ("nnmbox" mail respool address)
1535 ("nnml" post-mail respool address)
1536 ("nnmh" mail respool address)
1537 ("nndir" post-mail prompt-address physical-address)
1538 ("nneething" none address prompt-address physical-address)
1539 ("nndoc" none address prompt-address)
1540 ("nnbabyl" mail address respool)
1541 ("nnkiboze" post virtual)
1542 ("nnsoup" post-mail address)
1543 ("nndraft" post-mail)
1544 ("nnfolder" mail respool address)
1545 ("nngateway" post-mail address prompt-address physical-address)
1554 ("nnagent" post-mail)
1555 ("nnimap" post-mail address prompt-address physical-address)
1556 ("nnmaildir" mail respool address)
1558 "*An alist of valid select methods.
1559 The first element of each list lists should be a string with the name
1560 of the select method. The other elements may be the category of
1561 this method (i. e., `post', `mail', `none' or whatever) or other
1562 properties that this method has (like being respoolable).
1563 If you implement a new select method, all you should have to change is
1564 this variable. I think."
1566 :type '(repeat (group (string :tag "Name")
1567 (radio-button-choice (const :format "%v " post)
1568 (const :format "%v " mail)
1569 (const :format "%v " none)
1571 (checklist :inline t
1572 (const :format "%v " address)
1573 (const :format "%v " prompt-address)
1574 (const :format "%v " physical-address)
1575 (const :format "%v " virtual)
1578 (defun gnus-redefine-select-method-widget ()
1579 "Recomputes the select-method widget based on the value of
1580 `gnus-valid-select-methods'."
1581 (define-widget 'gnus-select-method 'list
1582 "Widget for entering a select method."
1584 :tag "Select Method"
1585 :args `((choice :tag "Method"
1586 ,@(mapcar (lambda (entry)
1587 (list 'const :format "%v\n"
1588 (intern (car entry))))
1589 gnus-valid-select-methods)
1590 (symbol :tag "other"))
1591 (string :tag "Address")
1592 (repeat :tag "Options"
1596 (sexp :tag "Value"))))))
1598 (gnus-redefine-select-method-widget)
1600 (defcustom gnus-updated-mode-lines '(group article summary tree)
1601 "List of buffers that should update their mode lines.
1602 The list may contain the symbols `group', `article', `tree' and
1603 `summary'. If the corresponding symbol is present, Gnus will keep
1604 that mode line updated with information that may be pertinent.
1605 If this variable is nil, screen refresh may be quicker."
1606 :group 'gnus-various
1607 :type '(set (const group)
1612 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1613 (defcustom gnus-mode-non-string-length nil
1614 "*Max length of mode-line non-string contents.
1615 If this is nil, Gnus will take space as is needed, leaving the rest
1616 of the mode line intact. Note that the default of nil is unlikely
1617 to be desirable; see the manual for further details."
1618 :group 'gnus-various
1619 :type '(choice (const nil)
1622 ;; There should be special validation for this.
1623 (define-widget 'gnus-email-address 'string
1624 "An email address.")
1626 (gnus-define-group-parameter
1629 "Return GROUP's to-address."
1631 "*Alist of group regexps and correspondent to-addresses."
1632 :variable-group gnus-group-parameter
1633 :parameter-type '(gnus-email-address :tag "To Address")
1634 :parameter-document "\
1635 This will be used when doing followups and posts.
1637 This is primarily useful in mail groups that represent closed
1638 mailing lists--mailing lists where it's expected that everybody that
1639 writes to the mailing list is subscribed to it. Since using this
1640 parameter ensures that the mail only goes to the mailing list itself,
1641 it means that members won't receive two copies of your followups.
1643 Using `to-address' will actually work whether the group is foreign or
1644 not. Let's say there's a group on the server that is called
1645 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1646 articles from a mail-to-news gateway. Posting directly to this group
1647 is therefore impossible--you have to send mail to the mailing list
1650 The gnus-group-split mail splitting mechanism will behave as if this
1651 address was listed in gnus-group-split Addresses (see below).")
1653 (gnus-define-group-parameter
1656 "Return GROUP's to-list."
1658 "*Alist of group regexps and correspondent to-lists."
1659 :variable-group gnus-group-parameter
1660 :parameter-type '(gnus-email-address :tag "To List")
1661 :parameter-document "\
1662 This address will be used when doing a `a' in the group.
1664 It is totally ignored when doing a followup--except that if it is
1665 present in a news group, you'll get mail group semantics when doing
1668 The gnus-group-split mail splitting mechanism will behave as if this
1669 address was listed in gnus-group-split Addresses (see below).")
1671 (gnus-define-group-parameter
1675 "Return GROUP's subscription status."
1677 "*Groups which are automatically considered subscribed."
1678 :variable-group gnus-group-parameter
1679 :parameter-type '(const :tag "Subscribed" t)
1680 :parameter-document "\
1681 Gnus assumed that you are subscribed to the To/List address.
1683 When constructing a list of subscribed groups using
1684 `gnus-find-subscribed-addresses', Gnus includes the To address given
1685 above, or the list address (if the To address has not been set).")
1687 (gnus-define-group-parameter
1690 :function gnus-group-auto-expirable-p
1692 "Check whether GROUP is auto-expirable or not."
1693 :variable gnus-auto-expirable-newsgroups
1694 :variable-default nil
1696 "*Groups in which to automatically mark read articles as expirable.
1697 If non-nil, this should be a regexp that should match all groups in
1698 which to perform auto-expiry. This only makes sense for mail groups."
1699 :variable-group nnmail-expire
1700 :variable-type '(choice (const nil)
1702 :parameter-type '(const :tag "Automatic Expire" t)
1704 "All articles that are read will be marked as expirable.")
1706 (gnus-define-group-parameter
1709 :function gnus-group-total-expirable-p
1711 "Check whether GROUP is total-expirable or not."
1712 :variable gnus-total-expirable-newsgroups
1713 :variable-default nil
1715 "*Groups in which to perform expiry of all read articles.
1716 Use with extreme caution. All groups that match this regexp will be
1717 expiring - which means that all read articles will be deleted after
1718 \(say) one week. (This only goes for mail groups and the like, of
1720 :variable-group nnmail-expire
1721 :variable-type '(choice (const nil)
1723 :parameter-type '(const :tag "Total Expire" t)
1725 "All read articles will be put through the expiry process
1727 This happens even if they are not marked as expirable.
1730 (gnus-define-group-parameter
1733 "Return the default charset of GROUP."
1734 :variable gnus-group-charset-alist
1736 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1737 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1738 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1739 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1740 ("\\(^\\|:\\)relcom\\>" koi8-r)
1741 ("\\(^\\|:\\)fido7\\>" koi8-r)
1742 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1743 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1744 ("\\(^\\|:\\)han\\>" euc-kr)
1745 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1746 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1747 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1749 "Alist of regexps (to match group names) and default charsets to be used when reading."
1750 :variable-group gnus-charset
1751 :variable-type '(repeat (list (regexp :tag "Group")
1752 (symbol :tag "Charset")))
1753 :parameter-type '(symbol :tag "Charset")
1754 :parameter-document "\
1755 The default charset to use in the group.")
1757 (gnus-define-group-parameter
1761 "Return a posting method for GROUP."
1762 :variable gnus-post-method-alist
1764 "Alist of regexps (to match group names) and method to be used when
1765 posting an article."
1766 :variable-group gnus-group-foreign
1768 '(choice :tag "Posting Method"
1769 (const :tag "Use native server" native)
1770 (const :tag "Use current server" current)
1771 (list :convert-widget
1773 (list 'sexp :tag "Methods"
1774 :value gnus-select-method))))
1776 "Posting method for this group.")
1778 (gnus-define-group-parameter
1779 large-newsgroup-initial
1782 "Return GROUP's initial input of the number of articles."
1784 "*Alist of group regexps and its initial input of the number of articles."
1785 :variable-group gnus-group-parameter
1786 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1787 (const :tag "All" nil)
1789 :parameter-document "\
1791 This number will be prompted as the initial value of the number of
1792 articles to list when the group is a large newsgroup (see
1793 `gnus-large-newsgroup'). If it is nil, the default value is the
1794 total number of articles in the group.")
1796 ;; The Gnus registry's ignored groups
1797 (gnus-define-group-parameter
1801 "Whether this group should be ignored by the registry."
1802 :variable gnus-registry-ignored-groups
1803 :variable-default nil
1805 "*Groups in which the registry should be turned off."
1806 :variable-group gnus-registry
1807 :variable-type '(repeat
1809 (regexp :tag "Group Name Regular Expression")
1810 (boolean :tag "Ignored")))
1812 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1814 "Whether the Gnus Registry should ignore this group.")
1816 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1817 (defcustom gnus-install-group-spam-parameters t
1818 "*Disable the group parameters for spam detection.
1819 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1823 (when gnus-install-group-spam-parameters
1824 (defvar gnus-group-spam-classification-spam t
1825 "Spam group classification (requires spam.el).
1826 This group contains spam messages. On summary entry, unread messages
1827 will be marked as spam. On summary exit, the specified spam
1828 processors will be invoked on spam-marked messages, then those
1829 messages will be expired, so the spam processor will only see a
1830 spam-marked message once.")
1832 (defvar gnus-group-spam-classification-ham 'ask
1833 "The ham value for the spam group parameter (requires spam.el).
1834 On summary exit, the specified ham processors will be invoked on
1835 ham-marked messages. Exercise caution, since the ham processor will
1836 see the same message more than once because there is no ham message
1839 (gnus-define-group-parameter
1843 "The spam type (spam, ham, or neither) of the group."
1844 :variable gnus-spam-newsgroup-contents
1845 :variable-default nil
1847 "*Groups in which to automatically mark new articles as spam on
1848 summary entry. If non-nil, this should be a list of group name
1849 regexps that should match all groups in which to do automatic spam
1850 tagging, associated with a classification (spam, ham, or neither).
1851 This only makes sense for mail groups."
1852 :variable-group spam
1853 :variable-type '(repeat
1854 (list :tag "Group contents spam/ham classification"
1855 (regexp :tag "Group")
1857 (variable-item gnus-group-spam-classification-spam)
1858 (variable-item gnus-group-spam-classification-ham)
1859 (const :tag "Unclassified" nil))))
1861 :parameter-type '(list :tag "Group contents spam/ham classification"
1862 (choice :tag "Group contents classification for spam sorting"
1863 (variable-item gnus-group-spam-classification-spam)
1864 (variable-item gnus-group-spam-classification-ham)
1865 (const :tag "Unclassified" nil)))
1867 "The spam classification (spam, ham, or neither) of this group.
1868 When a spam group is entered, all unread articles are marked as spam.")
1870 (gnus-define-group-parameter
1874 "The address to get spam resent (through spam-report-resend)."
1875 :variable gnus-spam-resend-to
1876 :variable-default nil
1878 "The address to get spam resent (through spam-report-resend)."
1879 :variable-group spam
1880 :variable-type '(repeat
1881 (list :tag "Group address for resending spam"
1882 (regexp :tag "Group")
1883 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1884 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1886 "The address to get spam resent (through spam-report-resend).")
1888 (gnus-define-group-parameter
1892 "The address to get ham resent (through spam-report-resend)."
1893 :variable gnus-ham-resend-to
1894 :variable-default nil
1896 "The address to get ham resent (through spam-report-resend)."
1897 :variable-group spam
1898 :variable-type '(repeat
1899 (list :tag "Group address for resending ham"
1900 (regexp :tag "Group")
1901 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1902 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1904 "The address to get ham resent (through spam-report-resend).")
1906 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1907 "OBSOLETE: The ifile summary exit spam processor.")
1909 (defvar gnus-group-spam-exit-processor-stat "stat"
1910 "OBSOLETE: The spam-stat summary exit spam processor.")
1912 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1913 "OBSOLETE: The Bogofilter summary exit spam processor.")
1915 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1916 "OBSOLETE: The Blacklist summary exit spam processor.")
1918 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1919 "OBSOLETE: The Gmane reporting summary exit spam processor.
1920 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1922 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1923 "OBSOLETE: The spamoracle summary exit spam processor.")
1925 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1926 "OBSOLETE: The ifile summary exit ham processor.
1927 Only applicable to non-spam (unclassified and ham) groups.")
1929 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1930 "OBSOLETE: The Bogofilter summary exit ham processor.
1931 Only applicable to non-spam (unclassified and ham) groups.")
1933 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1934 "OBSOLETE: The spam-stat summary exit ham processor.
1935 Only applicable to non-spam (unclassified and ham) groups.")
1937 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1938 "OBSOLETE: The whitelist summary exit ham processor.
1939 Only applicable to non-spam (unclassified and ham) groups.")
1941 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1942 "OBSOLETE: The BBDB summary exit ham processor.
1943 Only applicable to non-spam (unclassified and ham) groups.")
1945 (defvar gnus-group-ham-exit-processor-copy "copy"
1946 "OBSOLETE: The ham copy exit ham processor.
1947 Only applicable to non-spam (unclassified and ham) groups.")
1949 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1950 "OBSOLETE: The spamoracle summary exit ham processor.
1951 Only applicable to non-spam (unclassified and ham) groups.")
1953 (gnus-define-group-parameter
1958 :tag "Spam Summary Exit Processor"
1960 (list :tag "Spam Summary Exit Processor Choices"
1962 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1963 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1964 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
1965 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1966 (const :tag "Spam: Resend Message"(spam spam-use-resend))
1967 (const :tag "Spam: ifile" (spam spam-use-ifile))
1968 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1969 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1970 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1971 (const :tag "Spam: CRM114" (spam spam-use-crm114))
1972 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1973 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1974 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
1975 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1976 (const :tag "Ham: Resend Message" (ham spam-use-resend))
1977 (const :tag "Ham: ifile" (ham spam-use-ifile))
1978 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
1979 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1980 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1981 (const :tag "Ham: CRM114" (ham spam-use-crm114))
1982 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1983 (variable-item gnus-group-spam-exit-processor-ifile)
1984 (variable-item gnus-group-spam-exit-processor-stat)
1985 (variable-item gnus-group-spam-exit-processor-bogofilter)
1986 (variable-item gnus-group-spam-exit-processor-blacklist)
1987 (variable-item gnus-group-spam-exit-processor-spamoracle)
1988 (variable-item gnus-group-spam-exit-processor-report-gmane)
1989 (variable-item gnus-group-ham-exit-processor-bogofilter)
1990 (variable-item gnus-group-ham-exit-processor-ifile)
1991 (variable-item gnus-group-ham-exit-processor-stat)
1992 (variable-item gnus-group-ham-exit-processor-whitelist)
1993 (variable-item gnus-group-ham-exit-processor-BBDB)
1994 (variable-item gnus-group-ham-exit-processor-spamoracle)
1995 (variable-item gnus-group-ham-exit-processor-copy))))
1997 "Which spam or ham processors will be applied when the summary is exited."
1998 :variable gnus-spam-process-newsgroups
1999 :variable-default nil
2001 "*Groups in which to automatically process spam or ham articles with
2002 a backend on summary exit. If non-nil, this should be a list of group
2003 name regexps that should match all groups in which to do automatic
2004 spam processing, associated with the appropriate processor."
2005 :variable-group spam
2007 '(repeat :tag "Spam/Ham Processors"
2008 (list :tag "Spam Summary Exit Processor Choices"
2009 (regexp :tag "Group Regexp")
2011 :tag "Spam/Ham Summary Exit Processor"
2012 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2013 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2014 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2015 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2016 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2017 (const :tag "Spam: ifile" (spam spam-use-ifile))
2018 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2019 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2020 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2021 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2022 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2023 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2024 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2025 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2026 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2027 (const :tag "Ham: ifile" (ham spam-use-ifile))
2028 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2029 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2030 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2031 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2032 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
2033 (variable-item gnus-group-spam-exit-processor-ifile)
2034 (variable-item gnus-group-spam-exit-processor-stat)
2035 (variable-item gnus-group-spam-exit-processor-bogofilter)
2036 (variable-item gnus-group-spam-exit-processor-blacklist)
2037 (variable-item gnus-group-spam-exit-processor-spamoracle)
2038 (variable-item gnus-group-spam-exit-processor-report-gmane)
2039 (variable-item gnus-group-ham-exit-processor-bogofilter)
2040 (variable-item gnus-group-ham-exit-processor-ifile)
2041 (variable-item gnus-group-ham-exit-processor-stat)
2042 (variable-item gnus-group-ham-exit-processor-whitelist)
2043 (variable-item gnus-group-ham-exit-processor-BBDB)
2044 (variable-item gnus-group-ham-exit-processor-spamoracle)
2045 (variable-item gnus-group-ham-exit-processor-copy))))
2048 "Which spam or ham processors will be applied when the summary is exited.")
2050 (gnus-define-group-parameter
2054 '(boolean :tag "Spam autodetection")
2056 "Should spam be autodetected (with spam-split) in this group?"
2057 :variable gnus-spam-autodetect
2058 :variable-default nil
2060 "*Groups in which spam should be autodetected when they are entered.
2061 Only unseen articles will be examined, unless
2062 spam-autodetect-recheck-messages is set."
2063 :variable-group spam
2066 :tag "Autodetection setting"
2068 (regexp :tag "Group Regexp")
2071 "Spam autodetection.
2072 Only unseen articles will be examined, unless
2073 spam-autodetect-recheck-messages is set.")
2075 (gnus-define-group-parameter
2076 spam-autodetect-methods
2079 '(choice :tag "Spam autodetection-specific methods"
2082 (set :tag "Use specific methods"
2083 (variable-item spam-use-blacklist)
2084 (variable-item spam-use-gmane-xref)
2085 (variable-item spam-use-regex-headers)
2086 (variable-item spam-use-regex-body)
2087 (variable-item spam-use-whitelist)
2088 (variable-item spam-use-BBDB)
2089 (variable-item spam-use-ifile)
2090 (variable-item spam-use-spamoracle)
2091 (variable-item spam-use-crm114)
2092 (variable-item spam-use-spamassassin)
2093 (variable-item spam-use-spamassassin-headers)
2094 (variable-item spam-use-bsfilter)
2095 (variable-item spam-use-bsfilter-headers)
2096 (variable-item spam-use-stat)
2097 (variable-item spam-use-blackholes)
2098 (variable-item spam-use-hashcash)
2099 (variable-item spam-use-bogofilter-headers)
2100 (variable-item spam-use-bogofilter)))
2102 "Methods to be used for autodetection in each group"
2103 :variable gnus-spam-autodetect-methods
2104 :variable-default nil
2106 "*Methods for autodetecting spam per group.
2107 Requires the spam-autodetect parameter. Only unseen articles
2108 will be examined, unless spam-autodetect-recheck-messages is
2110 :variable-group spam
2113 :tag "Autodetection methods"
2115 (regexp :tag "Group Regexp")
2119 (set :tag "Use specific methods"
2120 (variable-item spam-use-blacklist)
2121 (variable-item spam-use-gmane-xref)
2122 (variable-item spam-use-regex-headers)
2123 (variable-item spam-use-regex-body)
2124 (variable-item spam-use-whitelist)
2125 (variable-item spam-use-BBDB)
2126 (variable-item spam-use-ifile)
2127 (variable-item spam-use-spamoracle)
2128 (variable-item spam-use-crm114)
2129 (variable-item spam-use-stat)
2130 (variable-item spam-use-blackholes)
2131 (variable-item spam-use-hashcash)
2132 (variable-item spam-use-spamassassin)
2133 (variable-item spam-use-spamassassin-headers)
2134 (variable-item spam-use-bsfilter)
2135 (variable-item spam-use-bsfilter-headers)
2136 (variable-item spam-use-bogofilter-headers)
2137 (variable-item spam-use-bogofilter)))))
2139 "Spam autodetection methods.
2140 Requires the spam-autodetect parameter. Only unseen articles
2141 will be examined, unless spam-autodetect-recheck-messages is
2144 (gnus-define-group-parameter
2145 spam-process-destination
2148 '(choice :tag "Destination for spam-processed articles at summary exit"
2149 (string :tag "Move to a group")
2150 (repeat :tag "Move to multiple groups"
2151 (string :tag "Destination group"))
2152 (const :tag "Expire" nil))
2154 "Where spam-processed articles will go at summary exit."
2155 :variable gnus-spam-process-destinations
2156 :variable-default nil
2158 "*Groups in which to explicitly send spam-processed articles to
2159 another group, or expire them (the default). If non-nil, this should
2160 be a list of group name regexps that should match all groups in which
2161 to do spam-processed article moving, associated with the destination
2162 group or nil for explicit expiration. This only makes sense for
2164 :variable-group spam
2167 :tag "Spam-processed articles destination"
2169 (regexp :tag "Group Regexp")
2171 :tag "Destination for spam-processed articles at summary exit"
2172 (string :tag "Move to a group")
2173 (repeat :tag "Move to multiple groups"
2174 (string :tag "Destination group"))
2175 (const :tag "Expire" nil))))
2177 "Where spam-processed articles will go at summary exit.")
2179 (gnus-define-group-parameter
2180 ham-process-destination
2184 :tag "Destination for ham articles at summary exit from a spam group"
2185 (string :tag "Move to a group")
2186 (repeat :tag "Move to multiple groups"
2187 (string :tag "Destination group"))
2188 (const :tag "Respool" respool)
2189 (const :tag "Do nothing" nil))
2191 "Where ham articles will go at summary exit from a spam group."
2192 :variable gnus-ham-process-destinations
2193 :variable-default nil
2195 "*Groups in which to explicitly send ham articles to
2196 another group, or do nothing (the default). If non-nil, this should
2197 be a list of group name regexps that should match all groups in which
2198 to do ham article moving, associated with the destination
2199 group or nil for explicit ignoring. This only makes sense for
2200 mail groups, and only works in spam groups."
2201 :variable-group spam
2204 :tag "Ham articles destination"
2206 (regexp :tag "Group Regexp")
2208 :tag "Destination for ham articles at summary exit from spam group"
2209 (string :tag "Move to a group")
2210 (repeat :tag "Move to multiple groups"
2211 (string :tag "Destination group"))
2212 (const :tag "Respool" respool)
2213 (const :tag "Expire" nil))))
2215 "Where ham articles will go at summary exit from a spam group.")
2217 (gnus-define-group-parameter
2220 :parameter-type '(list :tag "Ham mark choices"
2222 (variable-item gnus-del-mark)
2223 (variable-item gnus-read-mark)
2224 (variable-item gnus-ticked-mark)
2225 (variable-item gnus-killed-mark)
2226 (variable-item gnus-kill-file-mark)
2227 (variable-item gnus-low-score-mark)))
2230 "Marks considered ham (positively not spam). Such articles will be
2231 processed as ham (non-spam) on group exit. When nil, the global
2232 spam-ham-marks variable takes precedence."
2233 :variable-default '((".*" ((gnus-del-mark
2237 gnus-low-score-mark))))
2238 :variable-group spam
2240 "*Groups in which to explicitly set the ham marks to some value.")
2242 (gnus-define-group-parameter
2245 :parameter-type '(list :tag "Spam mark choices"
2247 (variable-item gnus-spam-mark)
2248 (variable-item gnus-killed-mark)
2249 (variable-item gnus-kill-file-mark)
2250 (variable-item gnus-low-score-mark)))
2253 "Marks considered spam.
2254 Such articles will be processed as spam on group exit. When nil, the global
2255 spam-spam-marks variable takes precedence."
2256 :variable-default '((".*" ((gnus-spam-mark))))
2257 :variable-group spam
2259 "*Groups in which to explicitly set the spam marks to some value."))
2261 (defcustom gnus-group-uncollapsed-levels 1
2262 "Number of group name elements to leave alone when making a short group name."
2263 :group 'gnus-group-visual
2266 (defcustom gnus-group-use-permanent-levels nil
2267 "*If non-nil, once you set a level, Gnus will use this level."
2268 :group 'gnus-group-levels
2273 (defcustom gnus-load-hook nil
2274 "A hook run while Gnus is loaded."
2278 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2279 "A hook called to apply kill files to a group.
2280 This hook is intended to apply a kill file to the selected newsgroup.
2281 The function `gnus-apply-kill-file' is called by default.
2283 Since a general kill file is too heavy to use only for a few
2284 newsgroups, I recommend you to use a lighter hook function. For
2285 example, if you'd like to apply a kill file to articles which contains
2286 a string `rmgroup' in subject in newsgroup `control', you can use the
2289 (setq gnus-apply-kill-hook
2292 (cond ((string-match \"control\" gnus-newsgroup-name)
2293 (gnus-kill \"Subject\" \"rmgroup\")
2294 (gnus-expunge \"X\"))))))"
2295 :group 'gnus-score-kill
2296 :options '(gnus-apply-kill-file)
2299 (defcustom gnus-group-change-level-function nil
2300 "Function run when a group level is changed.
2301 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2302 :group 'gnus-group-levels
2307 (defcustom gnus-visual
2308 '(summary-highlight group-highlight article-highlight
2310 summary-menu group-menu article-menu
2311 tree-highlight menu highlight
2312 browse-menu server-menu
2313 page-marker tree-menu binary-menu pick-menu)
2314 "*Enable visual features.
2315 If `visual' is disabled, there will be no menus and few faces. Most of
2316 the visual customization options below will be ignored. Gnus will use
2317 less space and be faster as a result.
2319 This variable can also be a list of visual elements to switch on. For
2320 instance, to switch off all visual things except menus, you can say:
2322 (setq gnus-visual '(menu))
2324 Valid elements include `summary-highlight', `group-highlight',
2325 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2326 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2327 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2330 :type '(set (const summary-highlight)
2331 (const group-highlight)
2332 (const article-highlight)
2334 (const summary-menu)
2336 (const article-menu)
2337 (const tree-highlight)
2347 ;; Byte-compiler warning.
2348 (defvar gnus-visual)
2349 ;; Find out whether the gnus-visual TYPE is wanted.
2350 (defun gnus-visual-p (&optional type class)
2351 (and gnus-visual ; Has to be non-nil, at least.
2352 (if (not type) ; We don't care about type.
2354 (if (listp gnus-visual) ; It's a list, so we check it.
2355 (or (memq type gnus-visual)
2356 (memq class gnus-visual))
2359 (defcustom gnus-mouse-face
2361 (if (gnus-visual-p 'mouse-face 'highlight)
2362 (if (boundp 'gnus-mouse-face)
2363 (or gnus-mouse-face 'highlight)
2367 "*Face used for group or summary buffer mouse highlighting.
2368 The line beneath the mouse pointer will be highlighted with this
2373 (defcustom gnus-article-save-directory gnus-directory
2374 "*Name of the directory articles will be saved in (default \"~/News\")."
2375 :group 'gnus-article-saving
2378 (defvar gnus-plugged t
2379 "Whether Gnus is plugged or not.")
2381 (defcustom gnus-agent-cache t
2382 "Controls use of the agent cache while plugged.
2383 When set, Gnus will prefer using the locally stored content rather
2384 than re-fetching it from the server. You also need to enable
2385 `gnus-agent' for this to have any affect."
2390 (defcustom gnus-default-charset 'undecided
2391 "Default charset assumed to be used when viewing non-ASCII characters.
2392 This variable is overridden on a group-to-group basis by the
2393 `gnus-group-charset-alist' variable and is only used on groups not
2394 covered by that variable."
2396 :group 'gnus-charset)
2398 ;; Fixme: Doc reference to agent.
2399 (defcustom gnus-agent t
2400 "Whether we want to use the Gnus agent or not.
2402 You may customize gnus-agent to disable its use. However, some
2403 back ends have started to use the agent as a client-side cache.
2404 Disabling the agent may result in noticeable loss of performance."
2409 (defcustom gnus-other-frame-function 'gnus
2410 "Function called by the command `gnus-other-frame'."
2412 :type '(choice (function-item gnus)
2413 (function-item gnus-no-server)
2414 (function-item gnus-slave)
2415 (function-item gnus-slave-no-server)))
2417 (defcustom gnus-other-frame-parameters nil
2418 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2419 This should be an alist for Emacs, or a plist for XEmacs."
2421 :type (if (featurep 'xemacs)
2422 '(repeat (list :inline t :format "%v"
2423 (symbol :tag "Property")
2424 (sexp :tag "Value")))
2425 '(repeat (cons :format "%v"
2426 (symbol :tag "Parameter")
2427 (sexp :tag "Value")))))
2429 (defcustom gnus-user-agent 'gnus-mime-edit
2430 "Which information should be exposed in the User-Agent header.
2432 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2433 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2434 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2435 `emacs-gnus' plus system type\), `gnus-mime-edit' \(show Gnus version and
2436 MIME Edit User-Agent\) or a custom string. If you set it to a string,
2437 be sure to use a valid format, see RFC 2616."
2439 :group 'gnus-message
2441 (item :tag "Show Gnus version and MIME Edit User-Agent"
2443 (item :tag "Show Gnus and Emacs versions and system type"
2445 (item :tag "Show Gnus and Emacs versions and system configuration"
2447 (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2448 (item :tag "Show only Gnus version" gnus)
2449 (string :tag "Other")))
2452 ;;; Internal variables
2454 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2455 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2456 (defvar gnus-agent-method-p-cache nil
2457 ; Reset each time gnus-agent-covered-methods is changed else
2458 ; gnus-agent-method-p may mis-report a methods status.
2460 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2461 (defvar gnus-draft-meta-information-header "X-Draft-From")
2462 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2463 (defvar gnus-original-article-buffer " *Original Article*")
2464 (defvar gnus-newsgroup-name nil)
2465 (defvar gnus-ephemeral-servers nil)
2466 (defvar gnus-server-method-cache nil)
2468 (defvar gnus-agent-fetching nil
2469 "Whether Gnus agent is in fetching mode.")
2471 (defvar gnus-agent-covered-methods nil
2472 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2474 (defvar gnus-command-method nil
2475 "Dynamically bound variable that says what the current back end is.")
2477 (defvar gnus-current-select-method nil
2478 "The current method for selecting a newsgroup.")
2480 (defvar gnus-tree-buffer "*Tree*"
2481 "Buffer where Gnus thread trees are displayed.")
2484 (defvar gnus-use-generic-from nil)
2486 ;; Variable holding the user answers to all method prompts.
2487 (defvar gnus-method-history nil)
2489 ;; Variable holding the user answers to all mail method prompts.
2490 (defvar gnus-mail-method-history nil)
2492 ;; Variable holding the user answers to all group prompts.
2493 (defvar gnus-group-history nil)
2495 (defvar gnus-server-alist nil
2496 "List of available servers.")
2498 (defcustom gnus-cache-directory
2499 (nnheader-concat gnus-directory "cache/")
2500 "*The directory where cached articles will be stored."
2504 (defvar gnus-predefined-server-alist
2507 (nnspool-spool-directory ,gnus-cache-directory)
2508 (nnspool-nov-directory ,gnus-cache-directory)
2509 (nnspool-active-file
2510 ,(nnheader-concat gnus-cache-directory "active"))))
2511 "List of predefined (convenience) servers.")
2513 (defvar gnus-topic-indentation "");; Obsolete variable.
2515 (defconst gnus-article-mark-lists
2516 '((marked . tick) (replied . reply)
2517 (expirable . expire) (killed . killed)
2518 (bookmarks . bookmark) (dormant . dormant)
2519 (scored . score) (saved . save)
2520 (cached . cache) (downloadable . download)
2521 (unsendable . unsend) (forwarded . forward)
2522 (recent . recent) (seen . seen)))
2524 (defconst gnus-article-special-mark-lists
2530 ;; Propagate flags to server, with the following exceptions:
2531 ;; `seen' is private to each gnus installation
2532 ;; `cache' is a internal gnus flag for each gnus installation
2533 ;; `download' is a agent flag private to each gnus installation
2534 ;; `unsend' are for nndraft groups only
2535 ;; `score' is not a proper mark
2536 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2537 (defconst gnus-article-unpropagated-mark-lists
2538 '(seen cache download unsend score bookmark)
2539 "Marks that shouldn't be propagated to back ends.
2540 Typical marks are those that make no sense in a standalone back end,
2541 such as a mark that says whether an article is stored in the cache
2542 \(which doesn't make sense in a standalone back end).")
2544 (defvar gnus-headers-retrieved-by nil)
2545 (defvar gnus-article-reply nil)
2546 (defvar gnus-override-method nil)
2547 (defvar gnus-opened-servers nil)
2549 (defvar gnus-current-kill-article nil)
2551 (defvar gnus-have-read-active-file nil)
2553 (defconst gnus-maintainer
2554 "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2555 "The mail address of the T-gnus maintainers.")
2557 (defcustom gnus-info-filename nil
2558 "*Controls language of gnus Info.
2559 If nil and current-language-environment is Japanese, go to gnus-ja.
2560 Otherwise go to corresponding Info.
2561 This variable can be nil, gnus or gnus-ja."
2563 :type '(choice (const nil)
2564 (const :tag "English" gnus)
2565 (const :tag "Japanese" gnus-ja)))
2567 (defvar gnus-info-nodes
2568 '((gnus-group-mode "Group Buffer")
2569 (gnus-summary-mode "Summary Buffer")
2570 (gnus-article-mode "Article Buffer")
2571 (gnus-server-mode "Server Buffer")
2572 (gnus-browse-mode "Browse Foreign Server")
2573 (gnus-tree-mode "Tree Display"))
2574 "Alist of major modes and related Info nodes.")
2576 (defvar gnus-group-buffer "*Group*")
2577 (defvar gnus-summary-buffer "*Summary*")
2578 (defvar gnus-article-buffer "*Article*")
2579 (defvar gnus-server-buffer "*Server*")
2581 (defvar gnus-slave nil
2582 "Whether this Gnus is a slave or not.")
2584 (defvar gnus-batch-mode nil
2585 "Whether this Gnus is running in batch mode or not.")
2587 (defvar gnus-variable-list
2588 '(gnus-newsrc-options gnus-newsrc-options-n
2589 gnus-newsrc-last-checked-date
2590 gnus-newsrc-alist gnus-server-alist
2591 gnus-killed-list gnus-zombie-list
2592 gnus-topic-topology gnus-topic-alist)
2593 "Gnus variables saved in the quick startup file.")
2595 (defvar gnus-product-variable-file-list
2596 (let ((version (product-version (product-find 'gnus-vers))))
2598 ((product-version ,version)
2600 (correct-string-widths))
2602 gnus-format-specs-compiled)
2604 ((product-version ,version)
2606 (correct-string-widths))
2608 gnus-format-specs)))
2609 "Alist of the methods for checking whether the contents of the T-gnus
2610 quick startup files are valid. One is for the byte-compiled format
2611 specifications, the other is for the source form. Each element should
2612 be a list which looks like follows:
2615 ((VARIABLE EXPECTED_VALUE_or_NIL)
2616 (VARIABLE EXPECTED_VALUE_or_NIL)
2618 CODING-SYSTEM_FOR_READING_FILE
2619 SYMBOL_OF_FORMAT_SPECS)")
2621 (defcustom gnus-compile-user-specs t
2622 "If non-nil, the user-defined format specs will be byte-compiled
2624 It has an effect on the values of `gnus-*-line-format-spec'."
2628 (defvar gnus-newsrc-alist nil
2629 "Assoc list of read articles.
2630 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2632 (defvar gnus-registry-alist nil
2633 "Assoc list of registry data.
2634 gnus-registry.el will populate this if it's loaded.")
2636 (defvar gnus-newsrc-hashtb nil
2637 "Hashtable of `gnus-newsrc-alist'.")
2639 (defvar gnus-killed-list nil
2640 "List of killed newsgroups.")
2642 (defvar gnus-killed-hashtb nil
2643 "Hash table equivalent of `gnus-killed-list'.")
2645 (defvar gnus-zombie-list nil
2646 "List of almost dead newsgroups.")
2648 (defvar gnus-description-hashtb nil
2649 "Descriptions of newsgroups.")
2651 (defvar gnus-list-of-killed-groups nil
2652 "List of newsgroups that have recently been killed by the user.")
2654 (defvar gnus-active-hashtb nil
2655 "Hashtable of active articles.")
2657 (defvar gnus-moderated-hashtb nil
2658 "Hashtable of moderated newsgroups.")
2660 ;; Save window configuration.
2661 (defvar gnus-prev-winconf nil)
2663 (defvar gnus-reffed-article-number nil)
2665 ;;; Let the byte-compiler know that we know about this variable.
2666 (defvar rmail-default-rmail-file)
2668 (defvar gnus-dead-summary nil)
2670 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2671 "Regexp matching invalid groups.")
2673 (defvar gnus-other-frame-object nil
2674 "A frame object which will be created by `gnus-other-frame'.")
2676 ;;; End of variables.
2678 ;; Define some autoload functions Gnus might use.
2681 ;; This little mapcar goes through the list below and marks the
2682 ;; symbols in question as autoloaded functions.
2685 (let ((interactive (nth 1 (memq ':interactive package))))
2689 (when (consp function)
2690 (setq keymap (car (memq 'keymap function)))
2691 (setq function (car function)))
2692 (unless (fboundp function)
2693 (autoload function (car package) nil interactive keymap))))
2694 (if (eq (nth 1 package) ':interactive)
2697 '(("info" :interactive t Info-goto-node)
2699 ("ps-print" ps-print-preprint)
2700 ("message" :interactive t
2701 message-send-and-exit message-yank-original)
2702 ("babel" babel-as-string)
2703 ("nnmail" nnmail-split-fancy nnmail-article-group)
2704 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2705 ("rmailout" rmail-output rmail-output-to-rmail-file)
2706 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2707 rmail-show-message rmail-summary-exists
2708 rmail-select-summary rmail-update-summary)
2709 ("gnus-audio" :interactive t gnus-audio-play)
2710 ("gnus-xmas" gnus-xmas-splash)
2711 ("gnus-soup" :interactive t
2712 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2713 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2714 ("nnsoup" nnsoup-pack-replies)
2715 ("score-mode" :interactive t gnus-score-mode)
2716 ("gnus-mh" gnus-summary-save-article-folder
2717 gnus-Folder-save-name gnus-folder-save-name)
2718 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2719 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2720 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2721 gnus-demon-add-disconnection gnus-demon-add-handler
2722 gnus-demon-remove-handler)
2723 ("gnus-demon" :interactive t
2724 gnus-demon-init gnus-demon-cancel)
2725 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2726 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2727 gnus-face-from-file)
2728 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2729 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2730 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2731 gnus-nocem-unwanted-article-p)
2732 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2733 gnus-server-server-name)
2734 ("gnus-srvr" gnus-browse-foreign-server)
2735 ("gnus-cite" :interactive t
2736 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2737 gnus-article-hide-citation gnus-article-fill-cited-article
2738 gnus-article-hide-citation-in-followups)
2739 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2740 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2741 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2742 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2743 gnus-cache-possibly-remove-articles gnus-cache-request-article
2744 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2745 gnus-cache-enter-remove-article gnus-cached-article-p
2746 gnus-cache-open gnus-cache-close gnus-cache-update-article
2747 gnus-cache-articles-in-group)
2748 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2749 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2750 ("gnus-score" :interactive t
2751 gnus-summary-increase-score gnus-summary-set-score
2752 gnus-summary-raise-thread gnus-summary-raise-same-subject
2753 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2754 gnus-summary-lower-thread gnus-summary-lower-same-subject
2755 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2756 gnus-summary-current-score gnus-score-delta-default
2757 gnus-score-flush-cache gnus-score-close
2758 gnus-possibly-score-headers gnus-score-followup-article
2759 gnus-score-followup-thread)
2761 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2762 gnus-current-score-file-nondirectory gnus-score-adaptive
2763 gnus-score-find-trace gnus-score-file-name)
2764 ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2765 gnus-score-customize)
2766 ("gnus-topic" :interactive t gnus-topic-mode)
2767 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2768 gnus-subscribe-topics)
2769 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2770 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2771 ("gnus-uu" :interactive t
2772 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2773 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2774 gnus-uu-mark-by-regexp gnus-uu-mark-all
2775 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2776 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2777 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2778 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2779 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2780 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2781 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2782 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2783 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2784 gnus-uu-unmark-thread)
2785 ("gnus-msg" (gnus-summary-send-map keymap)
2786 gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2787 ("gnus-msg" :interactive t
2788 gnus-group-post-news gnus-group-mail gnus-group-news
2789 gnus-summary-post-news gnus-summary-news-other-window
2790 gnus-summary-followup gnus-summary-followup-with-original
2791 gnus-summary-cancel-article gnus-summary-supersede-article
2792 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2793 gnus-summary-mail-forward gnus-summary-mail-other-window
2794 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2795 gnus-summary-wide-reply gnus-summary-followup-to-mail
2796 gnus-summary-followup-to-mail-with-original gnus-bug
2797 gnus-summary-wide-reply-with-original gnus-summary-post-forward
2798 gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2799 ("gnus-picon" :interactive t gnus-treat-from-picon)
2800 ("smiley" :interactive t smiley-region)
2801 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2802 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2803 gnus-list-of-unread-articles gnus-list-of-read-articles
2804 gnus-offer-save-summaries gnus-make-thread-indent-array
2805 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2806 gnus-summary-skip-intangible gnus-summary-article-number
2807 gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2808 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2809 gnus-group-list-groups gnus-group-first-unread-group
2810 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2811 gnus-group-setup-buffer gnus-group-get-new-news
2812 gnus-group-make-help-group gnus-group-update-group
2813 gnus-group-iterate gnus-group-group-name)
2814 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2815 gnus-backlog-remove-article)
2816 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2817 gnus-article-prepare gnus-article-set-window-start
2818 gnus-article-next-page gnus-article-prev-page
2819 gnus-request-article-this-buffer gnus-article-mode
2820 gnus-article-setup-buffer gnus-narrow-to-page
2821 gnus-article-delete-invisible-text gnus-treat-article)
2822 ("gnus-art" :interactive t
2823 gnus-article-hide-headers gnus-article-hide-boring-headers
2824 gnus-article-treat-overstrike
2825 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2826 gnus-article-display-x-face
2827 gnus-article-decode-HZ
2828 gnus-article-wash-html
2829 gnus-article-unsplit-urls
2830 gnus-article-hide-pem gnus-article-hide-signature
2831 gnus-article-strip-leading-blank-lines gnus-article-date-local
2832 gnus-article-date-original gnus-article-date-lapsed
2833 gnus-article-show-all-headers
2834 ;; gnus-article-show-all
2835 gnus-article-edit-mode gnus-article-edit-article
2836 gnus-article-edit-done article-decode-encoded-words
2837 gnus-start-date-timer gnus-stop-date-timer)
2838 ("gnus-int" gnus-request-type)
2839 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2840 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2841 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2842 gnus-dup-enter-articles)
2843 ("gnus-range" gnus-copy-sequence)
2844 ("gnus-eform" gnus-edit-form)
2845 ("gnus-move" :interactive t
2846 gnus-group-move-group-to-server gnus-change-server)
2847 ("gnus-logic" gnus-score-advanced)
2848 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2849 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2850 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2851 gnus-async-halt-prefetch)
2854 ("gnus-offline" :interactive t
2855 gnus-offline-toggle-plugged
2856 gnus-offline-set-unplugged-state
2857 gnus-offline-toggle-auto-hangup
2858 gnus-offline-toggle-on/off-send-mail
2859 gnus-offline-toggle-articles-to-fetch
2860 gnus-offline-set-interval-time
2861 gnus-offline-agent-expire)
2862 ("miee" :interactive t gnspool-get-news
2863 mail-spool-send news-spool-post)
2864 ("international/mw32misc" define-process-argument-editing
2865 general-process-argument-editing-function)
2866 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2867 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2868 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2869 gnus-summary-set-agent-mark gnus-agent-save-group-info
2870 gnus-agent-request-article gnus-agent-retrieve-headers)
2871 ("gnus-agent" :interactive t
2872 gnus-unplugged gnus-agentize gnus-agent-batch)
2873 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2874 gnus-summary-save-article-vm)
2875 ("compface" uncompface)
2876 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2877 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2878 ("gnus-mlspl" :interactive t gnus-group-split-setup
2879 gnus-group-split-update)
2880 ("gnus-delay" gnus-delay-initialize))))
2883 (unless (featurep 'xemacs)
2884 (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
2886 (unless (and (fboundp 'base64-encode-string)
2887 (subrp (symbol-function 'base64-encode-string)))
2890 ;; To search articles with Namazu.
2891 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2892 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
2893 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
2894 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
2896 ;; To make nnir groups.
2897 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2899 ;; To make shimbun groups.
2900 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2902 ;;; gnus-sum.el thingies
2904 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2905 "*The format specification of the lines in the summary buffer.
2907 It works along the same lines as a normal formatting string,
2908 with some simple extensions.
2910 %N Article number, left padded with spaces (string)
2912 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2913 %n Name of the poster (string)
2914 %a Extracted name of the poster (string)
2915 %A Extracted address of the poster (string)
2916 %F Contents of the From: header (string)
2917 %f Contents of the From: or To: headers (string)
2918 %x Contents of the Xref: header (string)
2919 %D Date of the article (string)
2920 %d Date of the article (string) in DD-MMM format
2921 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2922 %M Message-id of the article (string)
2923 %r References of the article (string)
2924 %c Number of characters in the article (integer)
2925 %k Pretty-printed version of the above (string)
2926 For example, \"1.2k\" or \"0.4M\".
2927 %L Number of lines in the article (integer)
2928 %I Indentation based on thread level (a string of spaces)
2929 %B A complex trn-style thread tree (string)
2930 The variables `gnus-sum-thread-*' can be used for customization.
2931 %T A string with two possible values: 80 spaces if the article
2932 is on thread level two or larger and 0 spaces on level one
2933 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2934 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2935 %[ Opening bracket (character, \"[\" or \"<\")
2936 %] Closing bracket (character, \"]\" or \">\")
2937 %> Spaces of length thread-level (string)
2938 %< Spaces of length (- 20 thread-level) (string)
2939 %i Article score (number)
2940 %z Article zcore (character)
2941 %t Number of articles under the current thread (number).
2942 %e Whether the thread is empty or not (character).
2943 %V Total thread score (number).
2944 %P The line number (number).
2945 %O Download mark (character).
2946 %* If present, indicates desired cursor position
2947 (instead of after first colon).
2948 %u User defined specifier. The next character in the format string should
2949 be a letter. Gnus will call the function gnus-user-format-function-X,
2950 where X is the letter following %u. The function will be passed the
2951 current header as argument. The function should return a string, which
2952 will be inserted into the summary just like information from any other
2955 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2956 with care. For reasons of efficiency, Gnus will compute what column
2957 these characters will end up in, and \"hard-code\" that. This means that
2958 it is invalid to have these specs after a variable-length spec. Well,
2959 you might not be arrested, but your summary buffer will look strange,
2960 which is bad enough.
2962 The smart choice is to have these specs as far to the left as
2965 This restriction may disappear in later versions of Gnus.
2967 General format specifiers can also be used.
2968 See Info node `(gnus)Formatting Variables'."
2969 :link '(custom-manual "(gnus)Formatting Variables")
2971 :group 'gnus-summary-format)
2974 ;;; Skeleton keymaps
2977 (defun gnus-suppress-keymap (keymap)
2978 (suppress-keymap keymap)
2979 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2981 (define-key keymap (pop keys) 'undefined))))
2983 (defvar gnus-article-mode-map
2984 (let ((keymap (make-sparse-keymap)))
2985 (gnus-suppress-keymap keymap)
2987 (defvar gnus-summary-mode-map
2988 (let ((keymap (make-keymap)))
2989 (gnus-suppress-keymap keymap)
2991 (defvar gnus-group-mode-map
2992 (let ((keymap (make-keymap)))
2993 (gnus-suppress-keymap keymap)
2998 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2999 ;; If you want the cursor to go somewhere else, set these two
3000 ;; functions in some startup hook to whatever you want.
3001 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3002 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3004 ;;; Various macros and substs.
3006 (defun gnus-header-from (header)
3007 (mail-header-from header))
3009 (defmacro gnus-gethash (string hashtable)
3010 "Get hash value of STRING in HASHTABLE."
3011 `(symbol-value (intern-soft ,string ,hashtable)))
3013 (defmacro gnus-gethash-safe (string hashtable)
3014 "Get hash value of STRING in HASHTABLE.
3015 Return nil if not defined."
3016 `(let ((sym (intern-soft ,string ,hashtable)))
3017 (and (boundp sym) (symbol-value sym))))
3019 (defmacro gnus-sethash (string value hashtable)
3020 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3021 `(set (intern ,string ,hashtable) ,value))
3022 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3024 (defmacro gnus-group-unread (group)
3025 "Get the currently computed number of unread articles in GROUP."
3026 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3028 (defmacro gnus-group-entry (group)
3029 "Get the newsrc entry for GROUP."
3030 `(gnus-gethash ,group gnus-newsrc-hashtb))
3032 (defmacro gnus-active (group)
3033 "Get active info on GROUP."
3034 `(gnus-gethash ,group gnus-active-hashtb))
3036 (defmacro gnus-set-active (group active)
3037 "Set GROUP's active info."
3038 `(gnus-sethash ,group ,active gnus-active-hashtb))
3040 ;; Info access macros.
3042 (defmacro gnus-info-group (info)
3044 (defmacro gnus-info-rank (info)
3046 (defmacro gnus-info-read (info)
3048 (defmacro gnus-info-marks (info)
3050 (defmacro gnus-info-method (info)
3052 (defmacro gnus-info-params (info)
3055 (defmacro gnus-info-level (info)
3056 `(let ((rank (gnus-info-rank ,info)))
3060 (defmacro gnus-info-score (info)
3061 `(let ((rank (gnus-info-rank ,info)))
3062 (or (and (consp rank) (cdr rank)) 0)))
3064 (defmacro gnus-info-set-group (info group)
3065 `(setcar ,info ,group))
3066 (defmacro gnus-info-set-rank (info rank)
3067 `(setcar (nthcdr 1 ,info) ,rank))
3068 (defmacro gnus-info-set-read (info read)
3069 `(setcar (nthcdr 2 ,info) ,read))
3070 (defmacro gnus-info-set-marks (info marks &optional extend)
3072 `(gnus-info-set-entry ,info ,marks 3)
3073 `(setcar (nthcdr 3 ,info) ,marks)))
3074 (defmacro gnus-info-set-method (info method &optional extend)
3076 `(gnus-info-set-entry ,info ,method 4)
3077 `(setcar (nthcdr 4 ,info) ,method)))
3078 (defmacro gnus-info-set-params (info params &optional extend)
3080 `(gnus-info-set-entry ,info ,params 5)
3081 `(setcar (nthcdr 5 ,info) ,params)))
3083 (defun gnus-info-set-entry (info entry number)
3084 ;; Extend the info until we have enough elements.
3085 (while (<= (length info) number)
3086 (nconc info (list nil)))
3088 (setcar (nthcdr number info) entry))
3090 (defmacro gnus-info-set-level (info level)
3091 `(let ((rank (cdr ,info)))
3092 (if (consp (car rank))
3093 (setcar (car rank) ,level)
3094 (setcar rank ,level))))
3095 (defmacro gnus-info-set-score (info score)
3096 `(let ((rank (cdr ,info)))
3097 (if (consp (car rank))
3098 (setcdr (car rank) ,score)
3099 (setcar rank (cons (car rank) ,score)))))
3101 (defmacro gnus-get-info (group)
3102 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3104 ;;; Load the compatibility functions.
3113 (defvar gnus-shutdown-alist nil)
3115 (defun gnus-add-shutdown (function &rest symbols)
3116 "Run FUNCTION whenever one of SYMBOLS is shut down."
3117 (push (cons function symbols) gnus-shutdown-alist))
3119 (defun gnus-shutdown (symbol)
3120 "Shut down everything that waits for SYMBOL."
3121 (dolist (entry gnus-shutdown-alist)
3122 (when (memq symbol (cdr entry))
3123 (funcall (car entry)))))
3127 ;;; Gnus Utility Functions
3130 (defun gnus-find-subscribed-addresses ()
3131 "Return a regexp matching the addresses of all subscribed mail groups.
3132 It consists of the `to-address' or `to-list' parameter of all groups
3133 with a `subscribed' parameter."
3134 (let (group address addresses)
3135 (dolist (entry (cdr gnus-newsrc-alist))
3136 (setq group (car entry))
3137 (when (gnus-parameter-subscribed group)
3138 (setq address (mail-strip-quoted-names
3139 (or (gnus-group-fast-parameter group 'to-address)
3140 (gnus-group-fast-parameter group 'to-list))))
3142 (add-to-list 'addresses address))))
3144 (list (mapconcat 'regexp-quote addresses "\\|")))))
3146 (defmacro gnus-string-or (&rest strings)
3147 "Return the first element of STRINGS that is a non-blank string.
3148 STRINGS will be evaluated in normal `or' order."
3149 `(gnus-string-or-1 ',strings))
3151 (defun gnus-string-or-1 (strings)
3154 (setq string (eval (pop strings)))
3155 (if (string-match "^[ \t]*$" string)
3157 (setq strings nil)))
3160 (defun gnus-info-find-node (&optional nodename)
3161 "Find Info documentation of Gnus."
3163 ;; Enlarge info window if needed.
3164 (let (gnus-info-buffer)
3167 (or gnus-info-filename
3168 (get-language-info current-language-environment 'gnus-info)
3171 (cadr (assq major-mode gnus-info-nodes))
3172 (and (eq (current-buffer) (get-buffer gnus-article-buffer))
3173 (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
3174 (setq gnus-info-buffer (current-buffer))
3175 (gnus-configure-windows 'info)))
3178 ;;; gnus-interactive
3181 (defvar gnus-current-prefix-symbol nil
3182 "Current prefix symbol.")
3184 (defvar gnus-current-prefix-symbols nil
3185 "List of current prefix symbols.")
3187 (defun gnus-interactive (string &optional params)
3188 "Return a list that can be fed to `interactive'.
3189 See `interactive' for full documentation.
3191 Adds the following specs:
3193 y -- The current symbolic prefix.
3194 Y -- A list of the current symbolic prefix(es).
3195 A -- Article number.
3196 H -- Article header.
3200 (while (< i (length string))
3201 (string-match ".\\([^\n]*\\)\n?" string i)
3202 (setq c (aref string i))
3204 (setq prompt (match-string 1 string)))
3205 (setq i (match-end 0))
3206 ;; We basically emulate just about everything that
3207 ;; `interactive' does, but add the specs listed above.
3211 (completing-read prompt obarray 'fboundp t))
3213 (read-buffer prompt (current-buffer) t))
3215 (read-buffer prompt (other-buffer (current-buffer))))
3219 (completing-read prompt obarray 'commandp t))
3223 (read-file-name prompt nil default-directory 'lambda))
3225 (read-file-name prompt nil nil 'lambda))
3227 (read-file-name prompt))
3229 (read-key-sequence prompt))
3231 (error "Not implemented spec"))
3233 (error "Not implemented spec"))
3237 (error "Not implemented spec"))
3239 (string-to-number (read-from-minibuffer prompt)))
3241 (prefix-numeric-value current-prefix-arg))
3247 (read-string prompt))
3249 (intern (read-string prompt)))
3251 (read-variable prompt))
3253 (read-minibuffer prompt))
3255 (eval-minibuffer prompt))
3256 ;; And here the new specs come.
3258 gnus-current-prefix-symbol)
3260 gnus-current-prefix-symbols)
3262 (gnus-group-group-name))
3264 (gnus-summary-skip-intangible)
3265 (or (get-text-property (point) 'gnus-number)
3266 (gnus-summary-last-subject)))
3268 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3270 (error "Non-implemented spec")))
3274 (push (if (< (point) (mark)) (point) (mark)) out)
3275 (push (if (> (point) (mark)) (point) (mark)) out))))
3276 (setq out (delq 'gnus-prefix-nil out))
3279 (defun gnus-symbolic-argument (&optional arg)
3280 "Read a symbolic argument and a command, and then execute command."
3282 (let* ((in-command (this-command-keys))
3283 (command in-command)
3284 gnus-current-prefix-symbols
3285 gnus-current-prefix-symbol
3287 (while (equal in-command command)
3288 (message "%s-" (key-description (this-command-keys)))
3289 (push (intern (char-to-string (read-char))) syms)
3290 (setq command (read-key-sequence nil t)))
3291 (setq gnus-current-prefix-symbols (nreverse syms)
3292 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3293 (call-interactively (key-binding command t))))
3295 ;;; More various functions.
3297 (defsubst gnus-check-backend-function (func group)
3298 "Check whether GROUP supports function FUNC.
3299 GROUP can either be a string (a group name) or a select method."
3301 (let ((method (if (stringp group)
3302 (car (gnus-find-method-for-group group))
3304 (unless (featurep method)
3306 (fboundp (intern (format "%s-%s" method func))))))
3308 (defun gnus-group-read-only-p (&optional group)
3309 "Check whether GROUP supports editing or not.
3310 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3311 that that variable is buffer-local to the summary buffers."
3312 (let ((group (or group gnus-newsgroup-name)))
3313 (not (gnus-check-backend-function 'request-replace-article group))))
3315 (defun gnus-virtual-group-p (group)
3316 "Say whether GROUP is virtual or not."
3317 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3318 gnus-valid-select-methods)))
3320 (defun gnus-news-group-p (group &optional article)
3321 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3322 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3323 t) ;is news of course.
3324 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3325 nil) ;must be mail then.
3326 ((vectorp article) ;Has header info.
3327 (eq (gnus-request-type group (mail-header-id article)) 'news))
3328 ((null article) ;Hasn't header info
3329 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3330 ((< article 0) ;Virtual message
3331 nil) ;we don't know, guess mail.
3332 (t ;Has positive number
3333 (eq (gnus-request-type group article) 'news)))) ;use it.
3335 ;; Returns a list of writable groups.
3336 (defun gnus-writable-groups ()
3337 (let ((alist gnus-newsrc-alist)
3339 (while (setq group (car (pop alist)))
3340 (unless (gnus-group-read-only-p group)
3341 (push group groups)))
3344 ;; Check whether to use long file names.
3345 (defun gnus-use-long-file-name (symbol)
3346 ;; The variable has to be set...
3347 (and gnus-use-long-file-name
3348 ;; If it isn't a list, then we return t.
3349 (or (not (listp gnus-use-long-file-name))
3350 ;; If it is a list, and the list contains `symbol', we
3352 (not (memq symbol gnus-use-long-file-name)))))
3354 ;; Generate a unique new group name.
3355 (defun gnus-generate-new-group-name (leaf)
3358 (while (gnus-group-entry name)
3359 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3362 (defun gnus-ephemeral-group-p (group)
3363 "Say whether GROUP is ephemeral or not."
3364 (gnus-group-get-parameter group 'quit-config t))
3366 (defun gnus-group-quit-config (group)
3367 "Return the quit-config of GROUP."
3368 (gnus-group-get-parameter group 'quit-config t))
3370 (defun gnus-kill-ephemeral-group (group)
3371 "Remove ephemeral GROUP from relevant structures."
3372 (gnus-sethash group nil gnus-newsrc-hashtb))
3374 (defun gnus-simplify-mode-line ()
3375 "Make mode lines a bit simpler."
3376 (setq mode-line-modified (cdr gnus-mode-line-modified))
3377 (when (listp mode-line-format)
3378 (make-local-variable 'mode-line-format)
3379 (setq mode-line-format (copy-sequence mode-line-format))
3380 (when (equal (nth 3 mode-line-format) " ")
3381 (setcar (nthcdr 3 mode-line-format) " "))))
3383 ;;; Servers and groups.
3385 (defsubst gnus-server-add-address (method)
3386 (let ((method-name (symbol-name (car method))))
3387 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3388 (not (assq (intern (concat method-name "-address")) method))
3389 (memq 'physical-address (assq (car method)
3390 gnus-valid-select-methods)))
3391 (append method (list (list (intern (concat method-name "-address"))
3395 (defsubst gnus-method-to-server (method)
3397 (setq method (or method gnus-select-method))
3399 ;; Perhaps it is already in the cache.
3400 (mapc (lambda (name-method)
3401 (if (equal (cdr name-method) method)
3402 (throw 'server-name (car name-method))))
3403 gnus-server-method-cache)
3406 (lambda (server-alist)
3407 (mapc (lambda (name-method)
3408 (when (gnus-methods-equal-p (cdr name-method) method)
3409 (unless (member name-method gnus-server-method-cache)
3410 (push name-method gnus-server-method-cache))
3411 (throw 'server-name (car name-method))))
3413 (let ((alists (list gnus-server-alist
3414 gnus-predefined-server-alist)))
3415 (if gnus-select-method
3416 (push (list (cons "native" gnus-select-method)) alists))
3419 (let* ((name (if (member (cadr method) '(nil ""))
3420 (format "%s" (car method))
3421 (format "%s:%s" (car method) (cadr method))))
3422 (name-method (cons name method)))
3423 (unless (member name-method gnus-server-method-cache)
3424 (push name-method gnus-server-method-cache))
3427 (defsubst gnus-server-to-method (server)
3428 "Map virtual server names to select methods."
3429 (or (and server (listp server) server)
3430 (cdr (assoc server gnus-server-method-cache))
3433 ;; Perhaps this is the native server?
3434 (and (equal server "native") gnus-select-method)
3435 ;; It should be in the server alist.
3436 (cdr (assoc server gnus-server-alist))
3437 ;; It could be in the predefined server alist.
3438 (cdr (assoc server gnus-predefined-server-alist))
3439 ;; If not, we look through all the opened server
3440 ;; to see whether we can find it there.
3441 (let ((opened gnus-opened-servers))
3443 (not (equal server (format "%s:%s" (caaar opened)
3447 ;; It could be a named method, search all servers
3448 (let ((servers gnus-secondary-select-methods))
3450 (not (equal server (format "%s:%s" (caar servers)
3454 ;; This could be some sort of foreign server that I
3455 ;; simply haven't opened (yet). Do a brute-force scan
3456 ;; of the entire gnus-newsrc-alist for the server name
3457 ;; of every method. As a side-effect, loads the
3458 ;; gnus-server-method-cache so this only happens once,
3463 (let ((info-method (gnus-info-method info)))
3464 (unless (stringp info-method)
3465 (let ((info-server (gnus-method-to-server info-method)))
3466 (when (equal server info-server)
3467 (setq match info-method))))))
3468 (cdr gnus-newsrc-alist))
3471 (push (cons server result) gnus-server-method-cache))
3474 (defsubst gnus-server-get-method (group method)
3475 ;; Input either a server name, and extended server name, or a
3476 ;; select method, and return a select method.
3477 (cond ((stringp method)
3478 (gnus-server-to-method method))
3479 ((equal method gnus-select-method)
3481 ((and (stringp (car method))
3483 (gnus-server-extend-method group method))
3486 (equal (cadr method) ""))
3489 (gnus-server-add-address method))))
3491 (defmacro gnus-method-equal (ss1 ss2)
3492 "Say whether two servers are equal."
3496 (and (= (length s1) (length s2))
3498 (while (and s1 (member (car s1) s2))
3502 (defun gnus-methods-equal-p (m1 m2)
3503 (let ((m1 (or m1 gnus-select-method))
3504 (m2 (or m2 gnus-select-method)))
3506 (and (eq (car m1) (car m2))
3507 (or (not (memq 'address (assoc (symbol-name (car m1))
3508 gnus-valid-select-methods)))
3509 (equal (nth 1 m1) (nth 1 m2)))))))
3511 (defun gnus-server-equal (m1 m2)
3512 "Say whether two methods are equal."
3513 (let ((m1 (cond ((null m1) gnus-select-method)
3514 ((stringp m1) (gnus-server-to-method m1))
3516 (m2 (cond ((null m2) gnus-select-method)
3517 ((stringp m2) (gnus-server-to-method m2))
3519 (gnus-method-equal m1 m2)))
3521 (defun gnus-servers-using-backend (backend)
3522 "Return a list of known servers using BACKEND."
3523 (let ((opened gnus-opened-servers)
3526 (when (eq backend (caaar opened))
3527 (push (caar opened) out))
3531 (defun gnus-archive-server-wanted-p ()
3532 "Say whether the user wants to use the archive server."
3534 ((or (not gnus-message-archive-method)
3535 (not gnus-message-archive-group))
3537 ((and gnus-message-archive-method gnus-message-archive-group)
3540 (let ((active (cadr (assq 'nnfolder-active-file
3541 gnus-message-archive-method))))
3543 (file-exists-p active))))))
3545 (defsubst gnus-method-to-server-name (method)
3547 (format "%s" (car method))
3549 (or (assoc (format "%s" (car method))
3550 (gnus-methods-using 'address))
3551 (gnus-server-equal method gnus-message-archive-method))
3553 (not (string= (nth 1 method) "")))
3554 (concat "+" (nth 1 method)))))
3556 (defsubst gnus-method-to-full-server-name (method)
3557 (format "%s+%s" (car method) (nth 1 method)))
3559 (defun gnus-group-prefixed-name (group method &optional full)
3560 "Return the whole name from GROUP and METHOD.
3561 Call with full set to get the fully qualified group name (even if the
3563 (when (stringp method)
3564 (setq method (gnus-server-to-method method)))
3565 (if (or (not method)
3566 (and (not full) (gnus-server-equal method "native"))
3567 ;;;!!! This might not be right. We'll see...
3568 ;(string-match ":" group)
3571 (concat (gnus-method-to-server-name method) ":" group)))
3573 (defun gnus-group-guess-prefixed-name (group)
3574 "Guess the whole name from GROUP and METHOD."
3575 (gnus-group-prefixed-name group (gnus-find-method-for-group
3578 (defun gnus-group-full-name (group method)
3579 "Return the full name from GROUP and METHOD, even if the method is native."
3580 (gnus-group-prefixed-name group method t))
3582 (defun gnus-group-guess-full-name (group)
3583 "Guess the full name from GROUP, even if the method is native."
3584 (if (gnus-group-prefixed-p group)
3586 (gnus-group-full-name group (gnus-find-method-for-group group))))
3588 (defun gnus-group-guess-full-name-from-command-method (group)
3589 "Guess the full name from GROUP, even if the method is native."
3590 (if (gnus-group-prefixed-p group)
3592 (gnus-group-full-name group gnus-command-method)))
3594 (defun gnus-group-real-prefix (group)
3595 "Return the prefix of the current group name."
3597 (if (string-match "^[^:]+:" group)
3598 (substring group 0 (match-end 0))
3602 (defun gnus-group-short-name (group)
3603 "Return the short group name."
3604 (let ((prefix (gnus-group-real-prefix group)))
3605 (if (< 0 (length prefix))
3606 (substring group (length prefix) nil)
3609 (defun gnus-group-prefixed-p (group)
3610 "Return the prefix of the current group name."
3611 (< 0 (length (gnus-group-real-prefix group))))
3613 (defun gnus-summary-buffer-name (group)
3614 "Return the summary buffer name of GROUP."
3615 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3617 (defun gnus-group-method (group)
3618 "Return the server or method used for selecting GROUP.
3619 You should probably use `gnus-find-method-for-group' instead."
3620 (let ((prefix (gnus-group-real-prefix group)))
3621 (if (equal prefix "")
3623 (let ((servers gnus-opened-servers)
3625 backend possible found)
3626 (if (string-match "^[^\\+]+\\+" prefix)
3627 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3628 server (substring prefix (match-end 0) (1- (length prefix))))
3629 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3631 (when (eq (caaar servers) backend)
3632 (setq possible (caar servers))
3633 (when (equal (cadaar servers) server)
3634 (setq found (caar servers))))
3636 (or (car (rassoc found gnus-server-alist))
3638 (car (rassoc possible gnus-server-alist))
3640 (list backend server))))))
3642 (defsubst gnus-native-method-p (method)
3643 "Return whether METHOD is the native select method."
3644 (gnus-method-equal method gnus-select-method))
3646 (defsubst gnus-secondary-method-p (method)
3647 "Return whether METHOD is a secondary select method."
3648 (let ((methods gnus-secondary-select-methods)
3649 (gmethod (inline (gnus-server-get-method nil method))))
3651 (not (gnus-method-equal
3652 (inline (gnus-server-get-method nil (car methods)))
3654 (setq methods (cdr methods)))
3657 (defun gnus-method-simplify (method)
3658 "Return the shortest uniquely identifying string or method for METHOD."
3659 (cond ((stringp method)
3661 ((gnus-native-method-p method)
3663 ((gnus-secondary-method-p method)
3664 (format "%s:%s" (nth 0 method) (nth 1 method)))
3668 (defun gnus-groups-from-server (server)
3669 "Return a list of all groups that are fetched from SERVER."
3670 (let ((alist (cdr gnus-newsrc-alist))
3672 (while (setq info (pop alist))
3673 (when (gnus-server-equal (gnus-info-method info) server)
3674 (push (gnus-info-group info) groups)))
3675 (sort groups 'string<)))
3677 (defun gnus-group-foreign-p (group)
3678 "Say whether a group is foreign or not."
3679 (and (not (gnus-group-native-p group))
3680 (not (gnus-group-secondary-p group))))
3682 (defun gnus-group-native-p (group)
3683 "Say whether the group is native or not."
3684 (not (string-match ":" group)))
3686 (defun gnus-group-secondary-p (group)
3687 "Say whether the group is secondary or not."
3688 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3690 (defun gnus-parameters-get-parameter (group)
3691 "Return the group parameters for GROUP from `gnus-parameters'."
3693 (dolist (elem gnus-parameters)
3694 (when (string-match (car elem) group)
3696 (nconc (gnus-expand-group-parameters
3697 (car elem) (cdr elem) group)
3701 (defun gnus-expand-group-parameter (match value group)
3702 "Use MATCH to expand VALUE in GROUP."
3705 (goto-char (point-min))
3706 (while (re-search-forward match nil t)
3707 (replace-match value))
3710 (defun gnus-expand-group-parameters (match parameters group)
3711 "Go through PARAMETERS and expand them according to the match data."
3713 (dolist (elem parameters)
3714 (if (and (stringp (cdr elem))
3715 (string-match "\\\\[0-9&]" (cdr elem)))
3716 (push (cons (car elem)
3717 (gnus-expand-group-parameter match (cdr elem) group))
3722 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3723 "For GROUP, return the value of SYMBOL.
3725 You should call this in the `gnus-group-buffer' buffer.
3726 The function `gnus-group-find-parameter' will do that for you."
3727 ;; The speed trick: No cons'ing and quit early.
3728 (let* ((params (funcall gnus-group-get-parameter-function group))
3729 ;; Start easy, check the "real" group parameters.
3731 (gnus-group-parameter-value params symbol allow-list t)))
3733 ;; Found results; return them.
3734 (car simple-results)
3735 ;; We didn't found it there, try `gnus-parameters'.
3738 (tail gnus-parameters))
3739 ;; A good old-fashioned non-cl loop.
3741 (setq head (car tail)
3743 ;; The car is regexp matching for matching the group name.
3744 (when (string-match (car head) group)
3745 ;; The cdr is the parameters.
3746 (setq result (gnus-group-parameter-value (cdr head)
3749 ;; Expand if necessary.
3750 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3751 (setq result (gnus-expand-group-parameter (car head)
3753 ;; Exit the loop early.
3758 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3759 "Return the group parameters for GROUP.
3760 If SYMBOL, return the value of that symbol in the group parameters.
3762 If you call this function inside a loop, consider using the faster
3763 `gnus-group-fast-parameter' instead."
3765 (set-buffer gnus-group-buffer)
3767 (gnus-group-fast-parameter group symbol allow-list)
3770 (funcall gnus-group-get-parameter-function group))
3771 (gnus-parameters-get-parameter group)))))
3773 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3774 "Return the group parameters for GROUP.
3775 If SYMBOL, return the value of that symbol in the group parameters.
3776 Most functions should use `gnus-group-find-parameter', which
3777 also examines the topic parameters."
3778 (let ((params (gnus-info-params (gnus-get-info group))))
3780 (gnus-group-parameter-value params symbol allow-list)
3783 (defun gnus-group-parameter-value (params symbol &optional
3784 allow-list present-p)
3785 "Return the value of SYMBOL in group PARAMS."
3786 ;; We only wish to return group parameters (dotted lists) and
3787 ;; not local variables, which may have the same names.
3788 ;; But first we handle single elements...
3789 (or (car (memq symbol params))
3793 (while (setq elem (pop params))
3794 (when (and (consp elem)
3795 (eq (car elem) symbol)
3798 (throw 'found (if present-p (list (cdr elem))
3801 (defun gnus-group-add-parameter (group param)
3802 "Add parameter PARAM to GROUP."
3803 (let ((info (gnus-get-info group)))
3805 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3806 ;; Cons the new param to the old one and update.
3807 (gnus-group-set-info (cons param (gnus-info-params info))
3810 (defun gnus-group-set-parameter (group name value)
3811 "Set parameter NAME to VALUE in GROUP."
3812 (let ((info (gnus-get-info group)))
3814 (gnus-group-remove-parameter group name)
3815 (let ((old-params (gnus-info-params info))
3816 (new-params (list (cons name value))))
3818 (when (or (not (listp (car old-params)))
3819 (not (eq (caar old-params) name)))
3820 (setq new-params (append new-params (list (car old-params)))))
3821 (setq old-params (cdr old-params)))
3822 (gnus-group-set-info new-params group 'params)))))
3824 (defun gnus-group-remove-parameter (group name)
3825 "Remove parameter NAME from GROUP."
3826 (let ((info (gnus-get-info group)))
3828 (let ((params (gnus-info-params info)))
3830 (setq params (delq name params))
3831 (while (assq name params)
3832 (gnus-pull name params))
3833 (gnus-info-set-params info params))))))
3835 (defun gnus-group-add-score (group &optional score)
3836 "Add SCORE to the GROUP score.
3837 If SCORE is nil, add 1 to the score of GROUP."
3838 (let ((info (gnus-get-info group)))
3840 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3842 (defun gnus-short-group-name (group &optional levels)
3843 "Collapse GROUP name LEVELS.
3844 Select methods are stripped and any remote host name is stripped down to
3845 just the host name."
3851 gnus-group-uncollapsed-levels
3853 (while (string-match "\\." group skip)
3854 (setq skip (match-end 0)
3857 ;; Separate foreign select method from group name and collapse.
3858 ;; If method contains a server, collapse to non-domain server name,
3859 ;; otherwise collapse to select method.
3860 (let* ((colon (string-match ":" group))
3861 (server (and colon (substring group 0 colon)))
3862 (plus (and server (string-match "+" server))))
3865 (setq foreign (substring server (+ 1 plus)
3866 (string-match "\\." server))
3867 group (substring group (+ 1 colon)))
3868 (setq foreign server
3869 group (substring group (+ 1 colon))))
3870 (setq foreign (concat foreign ":")))
3871 ;; Collapse group name leaving LEVELS uncollapsed elements
3872 (let* ((slist (split-string group "/"))
3873 (slen (length slist))
3874 (dlist (split-string group "\\."))
3875 (dlen (length dlist))
3887 (setq levels (- glen levels))
3889 (push (if (>= (decf levels) 0)
3890 (if (zerop (length g))
3895 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3897 (defun gnus-narrow-to-body ()
3898 "Narrow to the body of an article."
3901 (goto-char (point-min))
3902 (or (search-forward "\n\n" nil t)
3908 ;;; Kill file handling.
3911 (defun gnus-apply-kill-file ()
3912 "Apply a kill file to the current newsgroup.
3913 Returns the number of articles marked as read."
3914 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3915 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3916 (gnus-apply-kill-file-internal)
3919 (defun gnus-kill-save-kill-buffer ()
3920 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3921 (when (get-file-buffer file)
3923 (set-buffer (get-file-buffer file))
3924 (when (buffer-modified-p)
3926 (kill-buffer (current-buffer))))))
3928 (defcustom gnus-kill-file-name "KILL"
3929 "Suffix of the kill files."
3930 :group 'gnus-score-kill
3931 :group 'gnus-score-files
3934 (defun gnus-newsgroup-kill-file (newsgroup)
3935 "Return the name of a kill file name for NEWSGROUP.
3936 If NEWSGROUP is nil, return the global kill file name instead."
3938 ;; The global KILL file is placed at top of the directory.
3939 ((or (null newsgroup)
3940 (string-equal newsgroup ""))
3941 (expand-file-name gnus-kill-file-name
3942 gnus-kill-files-directory))
3943 ;; Append ".KILL" to newsgroup name.
3944 ((gnus-use-long-file-name 'not-kill)
3945 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3946 "." gnus-kill-file-name)
3947 gnus-kill-files-directory))
3948 ;; Place "KILL" under the hierarchical directory.
3950 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3951 "/" gnus-kill-file-name)
3952 gnus-kill-files-directory))))
3956 (defun gnus-member-of-valid (symbol group)
3957 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3959 (symbol-name (car (gnus-find-method-for-group group)))
3960 gnus-valid-select-methods)))
3962 (defun gnus-method-option-p (method option)
3963 "Return non-nil if select METHOD has OPTION as a parameter."
3964 (when (stringp method)
3965 (setq method (gnus-server-to-method method)))
3966 (memq option (assoc (format "%s" (car method))
3967 gnus-valid-select-methods)))
3969 (defun gnus-similar-server-opened (method)
3970 (let ((opened gnus-opened-servers))
3971 (while (and method opened)
3972 (when (and (equal (cadr method) (cadaar opened))
3973 (equal (car method) (caaar opened))
3974 (not (equal method (caar opened))))
3979 (defun gnus-server-extend-method (group method)
3980 ;; This function "extends" a virtual server. If the server is
3981 ;; "hello", and the select method is ("hello" (my-var "something"))
3982 ;; in the group "alt.alt", this will result in a new virtual server
3983 ;; called "hello+alt.alt".
3984 (if (or (not (inline (gnus-similar-server-opened method)))
3985 (not (cddr method)))
3987 `(,(car method) ,(concat (cadr method) "+" group)
3988 (,(intern (format "%s-address" (car method))) ,(cadr method))
3991 (defun gnus-server-status (method)
3992 "Return the status of METHOD."
3993 (nth 1 (assoc method gnus-opened-servers)))
3995 (defun gnus-group-name-to-method (group)
3996 "Guess a select method based on GROUP."
3997 (if (string-match ":" group)
3998 (let ((server (substring group 0 (match-beginning 0))))
3999 (if (string-match "\\+" server)
4000 (list (intern (substring server 0 (match-beginning 0)))
4001 (substring server (match-end 0)))
4002 (list (intern server) "")))
4003 gnus-select-method))
4005 (defun gnus-server-string (server)
4006 "Return a readable string that describes SERVER."
4007 (let* ((server (gnus-server-to-method server))
4008 (address (nth 1 server)))
4010 (not (zerop (length address))))
4011 (format "%s using %s" address (car server))
4012 (format "%s" (car server)))))
4014 (defun gnus-find-method-for-group (group &optional info)
4015 "Find the select method that GROUP uses."
4016 (or gnus-override-method
4019 (and (not (gnus-group-entry group));; a new group
4020 (gnus-group-name-to-method group))
4021 (let ((info (or info (gnus-get-info group)))
4024 (not (setq method (gnus-info-method info)))
4025 (equal method "native"))
4028 (cond ((stringp method)
4029 (inline (gnus-server-to-method method)))
4030 ((stringp (cadr method))
4031 (inline (gnus-server-extend-method group method)))
4034 (cond ((equal (cadr method) "")
4036 ((null (cadr method))
4037 (list (car method) ""))
4039 (gnus-server-add-address method)))))))
4041 (defun gnus-methods-using (feature)
4042 "Find all methods that have FEATURE."
4043 (let ((valids gnus-valid-select-methods)
4046 (when (memq feature (car valids))
4047 (push (car valids) outs))
4048 (setq valids (cdr valids)))
4052 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4054 (defun gnus-read-group (prompt &optional default)
4055 "Prompt the user for a group name.
4056 Disallow invalid group names."
4061 gnus-invalid-group-regexp
4062 (setq group (read-string (concat prefix prompt)
4063 (cons (or default "") 0)
4064 'gnus-group-history)))
4065 (let ((match (match-string 0 group)))
4066 ;; Might be okay (e.g. for nnimap), so ask the user:
4067 (unless (and (not (string-match "^$\\|:" match))
4069 "Proceed and create group anyway? " t
4070 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4072 Usually, it's dangerous to create a group with this name, because it's not
4073 supported by all back ends and servers. On IMAP servers it should work,
4074 though. If you are really sure, you can proceed anyway and create the group.
4076 You may customize the variable `gnus-invalid-group-regexp', which currently is
4077 set to \"" gnus-invalid-group-regexp
4078 "\", if you want to get rid of this query permanently."))
4079 (setq prefix (format "Invalid group name: \"%s\". " group)
4083 (defun gnus-read-method (prompt)
4084 "Prompt the user for a method.
4085 Allow completion over sensible values."
4086 (let* ((open-servers
4087 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4088 gnus-opened-servers))
4091 (dolist (method gnus-valid-select-methods)
4092 (if (or (memq 'prompt-address method)
4093 (not (assoc (format "%s:" (car method)) open-servers)))
4094 (push method methods)))
4097 (append valid-methods
4099 gnus-predefined-server-alist
4104 nil t nil 'gnus-method-history)))
4107 (setq method gnus-select-method))
4108 ((assoc method gnus-valid-select-methods)
4109 (let ((address (if (memq 'prompt-address
4110 (assoc method gnus-valid-select-methods))
4111 (read-string "Address: ")
4113 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4114 (list (intern method) address))))
4115 ((assoc method servers)
4118 (list (intern method) "")))))
4122 (defun gnus-agent-method-p (method)
4123 "Say whether METHOD is covered by the agent."
4124 (or (eq (car gnus-agent-method-p-cache) method)
4125 (setq gnus-agent-method-p-cache
4127 (member (if (stringp method)
4129 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4130 (cdr gnus-agent-method-p-cache))
4132 (defun gnus-online (method)
4135 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4136 (gnus-agent-method-p method))))
4138 ;;; User-level commands.
4141 (defun gnus-slave-no-server (&optional arg)
4142 "Read network news as a slave, without connecting to the local server."
4144 (gnus-no-server arg t))
4147 (defun gnus-no-server (&optional arg slave)
4149 If ARG is a positive number, Gnus will use that as the startup
4150 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4151 non-nil and not a positive number, Gnus will prompt the user for the
4152 name of an NNTP server to use.
4153 As opposed to `gnus', this command will not connect to the local
4156 (gnus-no-server-1 arg slave))
4159 (defun gnus-slave (&optional arg)
4160 "Read news as a slave."
4162 (gnus arg nil 'slave))
4164 (defcustom gnus-frame-properties nil
4165 "The properties of the frame in which gnus is displayed. Under XEmacs,
4166 the variable `toolbar-news-frame-plist' will be refered instead."
4167 :type '(repeat (cons :format "%v"
4168 (symbol :tag "Parameter")
4169 (sexp :tag "Value")))
4173 (defun gnus-other-frame (&optional arg display)
4174 "Pop up a frame to read news.
4175 This will call one of the Gnus commands which is specified by the user
4176 option `gnus-other-frame-function' (default `gnus') with the argument
4177 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4178 optional second argument DISPLAY should be a standard display string
4179 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4180 omitted or the function `make-frame-on-display' is not available, the
4181 current display is used."
4183 (if (fboundp 'make-frame-on-display)
4185 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4187 (let ((alive (gnus-alive-p)))
4192 (when (and (or (not display)
4194 (gnus-frame-or-window-display-name
4196 (with-current-buffer (window-buffer window)
4197 (string-match "\\`gnus-"
4198 (symbol-name major-mode))))
4199 (gnus-select-frame-set-input-focus
4200 (setq gnus-other-frame-object (window-frame window)))
4201 (select-window window)
4204 (gnus-select-frame-set-input-focus
4205 (setq gnus-other-frame-object
4207 (make-frame-on-display display gnus-other-frame-parameters)
4208 (make-frame gnus-other-frame-parameters))))
4210 (switch-to-buffer gnus-group-buffer)
4211 (funcall gnus-other-frame-function arg)
4212 (add-hook 'gnus-exit-gnus-hook
4214 (when (and (frame-live-p gnus-other-frame-object)
4216 (delete-frame gnus-other-frame-object))
4217 (setq gnus-other-frame-object nil)))))))
4220 (defun gnus (&optional arg dont-connect slave)
4222 If ARG is non-nil and a positive number, Gnus will use that as the
4223 startup level. If ARG is non-nil and not a positive number, Gnus will
4224 prompt the user for the name of an NNTP server to use."
4226 (unless (byte-code-function-p (symbol-function 'gnus))
4227 (message "You should byte-compile Gnus")
4229 (gnus-1 arg dont-connect slave))
4231 ;; Allow redefinition of Gnus functions.
4235 (product-provide (provide 'gnus) 'gnus-vers)
4237 ;;; gnus.el ends here