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, 2005 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))
44 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
48 (defgroup gnus-format nil
49 "Dealing with formatting issues."
52 (defgroup gnus-charset nil
53 "Group character set issues."
54 :link '(custom-manual "(gnus)Charsets")
58 (defgroup gnus-cache nil
60 :link '(custom-manual "(gnus)Article Caching")
63 (defgroup gnus-registry nil
67 (defgroup gnus-start nil
68 "Starting your favorite newsreader."
71 (defgroup gnus-start-server nil
72 "Server options at startup."
75 ;; These belong to gnus-group.el.
76 (defgroup gnus-group nil
78 :link '(custom-manual "(gnus)Group Buffer")
81 (defgroup gnus-group-foreign nil
83 :link '(custom-manual "(gnus)Foreign Groups")
86 (defgroup gnus-group-new nil
87 "Automatic subscription of new groups."
90 (defgroup gnus-group-levels nil
92 :link '(custom-manual "(gnus)Group Levels")
95 (defgroup gnus-group-select nil
97 :link '(custom-manual "(gnus)Selecting a Group")
100 (defgroup gnus-group-listing nil
101 "Showing slices of the group list."
102 :link '(custom-manual "(gnus)Listing Groups")
105 (defgroup gnus-group-visual nil
106 "Sorting the group buffer."
107 :link '(custom-manual "(gnus)Group Buffer Format")
111 (defgroup gnus-group-various nil
112 "Various group options."
113 :link '(custom-manual "(gnus)Scanning New Messages")
116 ;; These belong to gnus-sum.el.
117 (defgroup gnus-summary nil
119 :link '(custom-manual "(gnus)Summary Buffer")
122 (defgroup gnus-summary-exit nil
123 "Leaving summary buffers."
124 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
125 :group 'gnus-summary)
127 (defgroup gnus-summary-marks nil
128 "Marks used in summary buffers."
129 :link '(custom-manual "(gnus)Marking Articles")
130 :group 'gnus-summary)
132 (defgroup gnus-thread nil
133 "Ordering articles according to replies."
134 :link '(custom-manual "(gnus)Threading")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-format nil
138 "Formatting of the summary buffer."
139 :link '(custom-manual "(gnus)Summary Buffer Format")
140 :group 'gnus-summary)
142 (defgroup gnus-summary-choose nil
144 :link '(custom-manual "(gnus)Choosing Articles")
145 :group 'gnus-summary)
147 (defgroup gnus-summary-maneuvering nil
148 "Summary movement commands."
149 :link '(custom-manual "(gnus)Summary Maneuvering")
150 :group 'gnus-summary)
152 (defgroup gnus-picon nil
153 "Show pictures of people, domains, and newsgroups."
156 (defgroup gnus-summary-mail nil
157 "Mail group commands."
158 :link '(custom-manual "(gnus)Mail Group Commands")
159 :group 'gnus-summary)
161 (defgroup gnus-summary-sort nil
162 "Sorting the summary buffer."
163 :link '(custom-manual "(gnus)Sorting the Summary Buffer")
164 :group 'gnus-summary)
166 (defgroup gnus-summary-visual nil
167 "Highlighting and menus in the summary buffer."
168 :link '(custom-manual "(gnus)Summary Highlighting")
170 :group 'gnus-summary)
172 (defgroup gnus-summary-various nil
173 "Various summary buffer options."
174 :link '(custom-manual "(gnus)Various Summary Stuff")
175 :group 'gnus-summary)
177 (defgroup gnus-summary-pick nil
178 "Pick mode in the summary buffer."
179 :link '(custom-manual "(gnus)Pick and Read")
181 :group 'gnus-summary)
183 (defgroup gnus-summary-tree nil
184 "Tree display of threads in the summary buffer."
185 :link '(custom-manual "(gnus)Tree Display")
187 :group 'gnus-summary)
189 ;; Belongs to gnus-uu.el
190 (defgroup gnus-extract-view nil
191 "Viewing extracted files."
192 :link '(custom-manual "(gnus)Viewing Files")
193 :group 'gnus-extract)
195 ;; Belongs to gnus-score.el
196 (defgroup gnus-score nil
197 "Score and kill file handling."
200 (defgroup gnus-score-kill nil
204 (defgroup gnus-score-adapt nil
205 "Adaptive score files."
208 (defgroup gnus-score-default nil
209 "Default values for score files."
212 (defgroup gnus-score-expire nil
213 "Expiring score rules."
216 (defgroup gnus-score-decay nil
217 "Decaying score rules."
220 (defgroup gnus-score-files nil
221 "Score and kill file names."
225 (defgroup gnus-score-various nil
226 "Various scoring and killing options."
230 (defgroup gnus-visual nil
231 "Options controlling the visual fluff."
235 (defgroup gnus-agent nil
236 "Offline support for Gnus."
239 (defgroup gnus-files nil
240 "Files used by Gnus."
243 (defgroup gnus-dribble-file nil
245 :link '(custom-manual "(gnus)Auto Save")
248 (defgroup gnus-newsrc nil
249 "Storing Gnus state."
252 (defgroup gnus-server nil
253 "Options related to newsservers and other servers used by Gnus."
256 (defgroup gnus-server-visual nil
257 "Highlighting and menus in the server buffer."
261 (defgroup gnus-message '((message custom-group))
262 "Composing replies and followups in Gnus."
265 (defgroup gnus-meta nil
266 "Meta variables controlling major portions of Gnus.
267 In general, modifying these variables does not take affect until Gnus
268 is restarted, and sometimes reloaded."
271 (defgroup gnus-various nil
272 "Other Gnus options."
273 :link '(custom-manual "(gnus)Various Various")
276 (defgroup gnus-mime nil
277 "Variables for controlling the Gnus MIME interface."
280 (defgroup gnus-exit nil
282 :link '(custom-manual "(gnus)Exiting Gnus")
285 (defgroup gnus-fun nil
286 "Frivolous Gnus extensions."
287 :link '(custom-manual "(gnus)Exiting Gnus")
290 (defcustom gnus-inhibit-startup-message nil
291 "If non-nil, the startup message will not be displayed.
292 This variable is used before `.gnus.el' is loaded, so it should
293 be set in `.emacs' instead."
297 (defcustom gnus-play-startup-jingle nil
298 "If non-nil, play the Gnus jingle at startup."
302 (unless (fboundp 'gnus-group-remove-excess-properties)
303 (defalias 'gnus-group-remove-excess-properties 'ignore))
305 (unless (featurep 'gnus-xmas)
306 (defalias 'gnus-make-overlay 'make-overlay)
307 (defalias 'gnus-delete-overlay 'delete-overlay)
308 (defalias 'gnus-overlay-put 'overlay-put)
309 (defalias 'gnus-move-overlay 'move-overlay)
310 (defalias 'gnus-overlay-buffer 'overlay-buffer)
311 (defalias 'gnus-overlay-start 'overlay-start)
312 (defalias 'gnus-overlay-end 'overlay-end)
313 (defalias 'gnus-extent-detached-p 'ignore)
314 (defalias 'gnus-extent-start-open 'ignore)
315 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
316 (defalias 'gnus-character-to-event 'identity)
317 (defalias 'gnus-assq-delete-all 'assq-delete-all)
318 (defalias 'gnus-add-text-properties 'add-text-properties)
319 (defalias 'gnus-put-text-property 'put-text-property)
320 (defvar gnus-mode-line-image-cache t)
321 (if (fboundp 'find-image)
322 (defun gnus-mode-line-buffer-identification (line)
323 (let ((str (car-safe line))
324 (load-path (mm-image-load-path)))
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."
367 (defface gnus-group-news-1-empty-face
370 (:foreground "PaleTurquoise"))
373 (:foreground "ForestGreen"))
376 "Level 1 empty newsgroup face."
379 (defface gnus-group-news-2-face
382 (:foreground "turquoise" :bold t))
385 (:foreground "CadetBlue4" :bold t))
388 "Level 2 newsgroup face."
391 (defface gnus-group-news-2-empty-face
394 (:foreground "turquoise"))
397 (:foreground "CadetBlue4"))
400 "Level 2 empty newsgroup face."
403 (defface gnus-group-news-3-face
412 "Level 3 newsgroup face."
415 (defface gnus-group-news-3-empty-face
424 "Level 3 empty newsgroup face."
427 (defface gnus-group-news-4-face
436 "Level 4 newsgroup face."
439 (defface gnus-group-news-4-empty-face
448 "Level 4 empty newsgroup face."
451 (defface gnus-group-news-5-face
460 "Level 5 newsgroup face."
463 (defface gnus-group-news-5-empty-face
472 "Level 5 empty newsgroup face."
475 (defface gnus-group-news-6-face
484 "Level 6 newsgroup face."
487 (defface gnus-group-news-6-empty-face
496 "Level 6 empty newsgroup face."
499 (defface gnus-group-news-low-face
502 (:foreground "DarkTurquoise" :bold t))
505 (:foreground "DarkGreen" :bold t))
508 "Low level newsgroup face."
511 (defface gnus-group-news-low-empty-face
514 (:foreground "DarkTurquoise"))
517 (:foreground "DarkGreen"))
520 "Low level empty newsgroup face."
523 (defface gnus-group-mail-1-face
526 (:foreground "aquamarine1" :bold t))
529 (:foreground "DeepPink3" :bold t))
532 "Level 1 mailgroup face."
535 (defface gnus-group-mail-1-empty-face
538 (:foreground "aquamarine1"))
541 (:foreground "DeepPink3"))
543 (:italic t :bold t)))
544 "Level 1 empty mailgroup face."
547 (defface gnus-group-mail-2-face
550 (:foreground "aquamarine2" :bold t))
553 (:foreground "HotPink3" :bold t))
556 "Level 2 mailgroup face."
559 (defface gnus-group-mail-2-empty-face
562 (:foreground "aquamarine2"))
565 (:foreground "HotPink3"))
568 "Level 2 empty mailgroup face."
571 (defface gnus-group-mail-3-face
574 (:foreground "aquamarine3" :bold t))
577 (:foreground "magenta4" :bold t))
580 "Level 3 mailgroup face."
583 (defface gnus-group-mail-3-empty-face
586 (:foreground "aquamarine3"))
589 (:foreground "magenta4"))
592 "Level 3 empty mailgroup face."
595 (defface gnus-group-mail-low-face
598 (:foreground "aquamarine4" :bold t))
601 (:foreground "DeepPink4" :bold t))
604 "Low level mailgroup face."
607 (defface gnus-group-mail-low-empty-face
610 (:foreground "aquamarine4"))
613 (:foreground "DeepPink4"))
616 "Low level empty mailgroup face."
619 ;; Summary mode faces.
621 (defface gnus-summary-selected-face '((t
623 "Face used for selected articles."
624 :group 'gnus-summary)
626 (defface gnus-summary-cancelled-face
628 (:foreground "yellow" :background "black")))
629 "Face used for cancelled articles."
630 :group 'gnus-summary)
632 (defface gnus-summary-high-ticked-face
635 (:foreground "pink" :bold t))
638 (:foreground "firebrick" :bold t))
641 "Face used for high interest ticked articles."
642 :group 'gnus-summary)
644 (defface gnus-summary-low-ticked-face
647 (:foreground "pink" :italic t))
650 (:foreground "firebrick" :italic t))
653 "Face used for low interest ticked articles."
654 :group 'gnus-summary)
656 (defface gnus-summary-normal-ticked-face
659 (:foreground "pink"))
662 (:foreground "firebrick"))
665 "Face used for normal interest ticked articles."
666 :group 'gnus-summary)
668 (defface gnus-summary-high-ancient-face
671 (:foreground "SkyBlue" :bold t))
674 (:foreground "RoyalBlue" :bold t))
677 "Face used for high interest ancient articles."
678 :group 'gnus-summary)
680 (defface gnus-summary-low-ancient-face
683 (:foreground "SkyBlue" :italic t))
686 (:foreground "RoyalBlue" :italic t))
689 "Face used for low interest ancient articles."
690 :group 'gnus-summary)
692 (defface gnus-summary-normal-ancient-face
695 (:foreground "SkyBlue"))
698 (:foreground "RoyalBlue"))
701 "Face used for normal interest ancient articles."
702 :group 'gnus-summary)
704 (defface gnus-summary-high-undownloaded-face
707 (:bold t :foreground "cyan4"))
708 (((class color) (background dark))
709 (:bold t :foreground "LightGray"))
710 (t (:inverse-video t :bold t)))
711 "Face used for high interest uncached articles."
712 :group 'gnus-summary)
714 (defface gnus-summary-low-undownloaded-face
717 (:italic t :foreground "cyan4" :bold nil))
718 (((class color) (background dark))
719 (:italic t :foreground "LightGray" :bold nil))
720 (t (:inverse-video t :italic t)))
721 "Face used for low interest uncached articles."
722 :group 'gnus-summary)
724 (defface gnus-summary-normal-undownloaded-face
727 (:foreground "cyan4" :bold nil))
728 (((class color) (background dark))
729 (:foreground "LightGray" :bold nil))
730 (t (:inverse-video t)))
731 "Face used for normal interest uncached articles."
732 :group 'gnus-summary)
734 (defface gnus-summary-high-unread-face
737 "Face used for high interest unread articles."
738 :group 'gnus-summary)
740 (defface gnus-summary-low-unread-face
743 "Face used for low interest unread articles."
744 :group 'gnus-summary)
746 (defface gnus-summary-normal-unread-face
749 "Face used for normal interest unread articles."
750 :group 'gnus-summary)
752 (defface gnus-summary-incorporated-face
755 "Face used for incorporated articles."
756 :group 'gnus-summary)
758 (defface gnus-summary-high-read-face
761 (:foreground "PaleGreen"
765 (:foreground "DarkGreen"
769 "Face used for high interest read articles."
770 :group 'gnus-summary)
772 (defface gnus-summary-low-read-face
775 (:foreground "PaleGreen"
779 (:foreground "DarkGreen"
783 "Face used for low interest read articles."
784 :group 'gnus-summary)
786 (defface gnus-summary-normal-read-face
789 (:foreground "PaleGreen"))
792 (:foreground "DarkGreen"))
795 "Face used for normal interest read articles."
796 :group 'gnus-summary)
803 (defvar gnus-buffers nil)
805 (defun gnus-get-buffer-create (name)
806 "Do the same as `get-buffer-create', but store the created buffer."
807 (or (get-buffer name)
808 (car (push (get-buffer-create name) gnus-buffers))))
810 (defun gnus-add-buffer ()
811 "Add the current buffer to the list of Gnus buffers."
812 (push (current-buffer) gnus-buffers))
814 (defmacro gnus-kill-buffer (buffer)
815 "Kill BUFFER and remove from the list of Gnus buffers."
816 `(let ((buf ,buffer))
817 (when (gnus-buffer-exists-p buf)
818 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
821 (defun gnus-buffers ()
822 "Return a list of live Gnus buffers."
823 (while (and gnus-buffers
824 (not (buffer-name (car gnus-buffers))))
826 (let ((buffers gnus-buffers))
828 (if (buffer-name (cadr buffers))
830 (setcdr buffers (cddr buffers)))))
835 (defvar gnus-group-buffer "*Group*")
838 (autoload 'gnus-play-jingle "gnus-audio"))
840 (defface gnus-splash-face
843 (:foreground "#888888"))
846 (:foreground "#888888"))
849 "Face for the splash screen."
852 (defun gnus-splash ()
854 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
855 (let ((buffer-read-only nil))
857 (unless gnus-inhibit-startup-message
858 (gnus-group-startup-message)
860 (when gnus-play-startup-jingle
861 (gnus-play-jingle))))))
863 (defun gnus-indent-rigidly (start end arg)
864 "Indent rigidly using only spaces and no tabs."
867 (narrow-to-region start end)
869 (indent-rigidly start end arg)
870 ;; We translate tabs into spaces -- not everybody uses
871 ;; an 8-character tab.
872 (goto-char (point-min))
873 (while (search-forward "\t" nil t)
874 (replace-match " " t t))))))
876 (defvar gnus-simple-splash nil)
878 ;;(format "%02x%02x%02x" 114 66 20) "724214"
880 (defvar gnus-logo-color-alist
881 '((flame "#cc3300" "#ff2200")
882 (pine "#c0cc93" "#f8ffb8")
883 (moss "#a1cc93" "#d2ffb8")
884 (irish "#04cc90" "#05ff97")
885 (sky "#049acc" "#05deff")
886 (tin "#6886cc" "#82b6ff")
887 (velvet "#7c68cc" "#8c82ff")
888 (grape "#b264cc" "#cf7df")
889 (labia "#cc64c2" "#fd7dff")
890 (berry "#cc6485" "#ff7db5")
891 (dino "#724214" "#1e3f03")
892 (oort "#cccccc" "#888888")
893 (storm "#666699" "#99ccff")
894 (pdino "#9999cc" "#99ccff")
895 (purp "#9999cc" "#666699")
896 (no "#ff0000" "#ffff00")
897 (neutral "#b4b4b4" "#878787")
898 (september "#bf9900" "#ffcc00"))
899 "Color alist used for the Gnus logo.")
901 (defcustom gnus-logo-color-style 'no
902 "*Color styles used for the Gnus logo."
903 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
904 gnus-logo-color-alist))
907 (defvar gnus-logo-colors
908 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
909 "Colors used for the Gnus logo.")
911 (defun gnus-group-startup-message (&optional x y)
912 "Insert startup message in current buffer."
913 ;; Insert the message.
916 ((and (fboundp 'find-image)
918 (let* ((bg (face-background 'default))
919 (fg (face-foreground 'gnus-splash-face))
920 (data-directory (nnheader-find-etc-directory "images/gnus"))
922 `((:type xpm :file "gnus.xpm"
924 (("thing" . ,(car gnus-logo-colors))
925 ("shadow" . ,(cadr gnus-logo-colors))
927 ("background" . ,bg)))
928 (:type pbm :file "gnus.pbm"
929 ;; Account for the pbm's blackground.
930 :background ,bg :foreground ,fg)
931 (:type xbm :file "gnus.xbm"
932 ;; Account for the xbm's blackground.
933 :background ,bg :foreground ,fg)))))
937 (concat gnus-product-name " " gnus-version-number
938 (if (zerop (string-to-number gnus-revision-number))
940 (concat " (r" gnus-revision-number ")"))
941 " based on " gnus-original-product-name " v"
942 gnus-original-version-number)
943 'face `(variable-pitch :background ,bg :foreground ,fg)))
944 (let ((fill-column (window-width)))
945 (center-region (point-min) (point)))
946 (let ((size (image-size image)))
947 (insert-char ?\n (max 1 (round (- (window-height)
948 (or y (cdr size))) 2)))
950 (propertize " " 'display
952 ,(max 0 (round (- (window-width)
953 (or x (car size))) 2)))))
954 (insert-image image))
955 (setq gnus-simple-splash nil)
960 _ ___ __ ___ __ _ ___
979 (goto-char (point-min))
980 (insert gnus-product-name " " gnus-version-number
981 (if (zerop (string-to-number gnus-revision-number))
983 (concat " (r" gnus-revision-number ")"))
984 " based on " gnus-original-product-name " v"
985 gnus-original-version-number)
986 (insert-char ?\ (prog1
987 (max 0 (/ (- (window-width) (point)) 2))
988 (goto-char (point-min))))
991 (gnus-indent-rigidly (point) (point-max)
992 (/ (max (- (window-width) (or x 46)) 0) 2))
993 (goto-char (point-min))
995 (let* ((pheight (count-lines (point-min) (point-max)))
996 (wheight (window-height))
997 (rest (- wheight pheight)))
998 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
1000 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
1001 (setq gnus-simple-splash t)))
1002 (goto-char (point-min))
1003 (setq mode-line-buffer-identification (concat " " gnus-version))
1004 (set-buffer-modified-p t))
1007 (let ((command (format "%s" this-command)))
1008 (when (string-match "gnus" command)
1009 (if (string-match "gnus-other-frame" command)
1010 (gnus-get-buffer-create gnus-group-buffer)
1015 (require 'gnus-util)
1018 (defcustom gnus-parameters nil
1019 "Alist of group parameters.
1022 ((\"mail\\\\..*\" (gnus-show-threads nil)
1023 (gnus-use-scoring nil)
1024 (gnus-summary-line-format
1025 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
1028 (\"mail\\\\.me\" (gnus-use-scoring t))
1029 (\"list\\\\..*\" (total-expire . t)
1030 (broken-reply-to . t)))"
1032 :group 'gnus-group-various
1033 :type '(repeat (cons regexp
1036 (defvar gnus-group-parameters-more nil)
1038 (defvar gnus-colon-keywords
1040 (when (boundp 'dgnushack-colon-keywords)
1041 (symbol-value 'dgnushack-colon-keywords)))
1042 "List of the colon keywords should be bound at run-time. This variable
1043 defaults to a proper value only if this file is byte-compiled by make.")
1045 (dolist (keyword gnus-colon-keywords)
1046 (set keyword keyword))
1048 (defmacro gnus-define-group-parameter (param &rest rest)
1049 "Define a group parameter PARAM.
1050 REST is a plist of following:
1051 :type One of `bool', `list' or nil.
1052 :function The name of the function.
1053 :function-document The documentation of the function.
1054 :parameter-type The type for customizing the parameter.
1055 :parameter-document The documentation for the parameter.
1056 :variable The name of the variable.
1057 :variable-document The documentation for the variable.
1058 :variable-group The group for customizing the variable.
1059 :variable-type The type for customizing the variable.
1060 :variable-default The default value of the variable."
1061 (let* ((type (plist-get rest :type))
1062 (parameter-type (plist-get rest :parameter-type))
1063 (parameter-document (plist-get rest :parameter-document))
1064 (function (or (plist-get rest :function)
1065 (intern (format "gnus-parameter-%s" param))))
1066 (function-document (or (plist-get rest :function-document) ""))
1067 (variable (or (plist-get rest :variable)
1068 (intern (format "gnus-parameter-%s-alist" param))))
1069 (variable-document (or (plist-get rest :variable-document) ""))
1070 (variable-group (plist-get rest :variable-group))
1071 (variable-type (or (plist-get rest :variable-type)
1073 (list (regexp :tag "Group")
1074 ,(car (cdr parameter-type)))))))
1075 (variable-default (plist-get rest :variable-default)))
1078 `(defcustom ,variable ,variable-default
1080 :group 'gnus-group-parameter
1081 :group ',variable-group
1082 :type ,variable-type)
1083 `(setq gnus-group-parameters-more
1084 (delq (assq ',param gnus-group-parameters-more)
1085 gnus-group-parameters-more))
1086 `(add-to-list 'gnus-group-parameters-more
1089 ,parameter-document))
1091 `(defun ,function (name)
1093 (let ((params (gnus-group-find-parameter name))
1096 ((memq ',param params)
1098 ((setq val (assq ',param params))
1100 ((stringp ,variable)
1101 (string-match ,variable name))
1103 (let ((alist ,variable)
1105 (while (setq elem (pop alist))
1107 (string-match (car elem) name))
1110 (if (consp value) (car value) value))))))
1111 `(defun ,function (name)
1114 (or (gnus-group-find-parameter name ',param ,(and type t))
1115 (let ((alist ,variable)
1117 (while (setq elem (pop alist))
1119 (string-match (car elem) name))
1124 '(if (consp value) (car value) value))))))))))
1126 (defcustom gnus-home-directory "~/"
1127 "Directory variable that specifies the \"home\" directory.
1128 All other Gnus file and directory variables are initialized from this variable."
1132 (defcustom gnus-directory (or (getenv "SAVEDIR")
1133 (nnheader-concat gnus-home-directory "News/"))
1134 "*Directory variable from which all other Gnus file variables are derived.
1136 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1137 This means that other directory variables that are initialized from
1138 this variable won't be set properly if you set this variable in `.gnus.el'.
1139 Set this variable in `.emacs' instead."
1143 (defcustom gnus-default-directory nil
1144 "*Default directory for all Gnus buffers."
1146 :type '(choice (const :tag "current" nil)
1149 ;; Site dependent variables. These variables should be defined in
1152 (defvar gnus-default-nntp-server nil
1153 "Specify a default NNTP server.
1154 This variable should be defined in paths.el, and should never be set
1156 If you want to change servers, you should use `gnus-select-method'.
1157 See the documentation to that variable.")
1159 ;; Don't touch this variable.
1160 (defvar gnus-nntp-service "nntp"
1161 "NNTP service name (\"nntp\" or 119).
1162 This is an obsolete variable, which is scarcely used. If you use an
1163 nntp server for your newsgroup and want to change the port number
1164 used to 899, you would say something along these lines:
1166 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1168 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1169 "A file with only the name of the nntp server in it."
1174 (defun gnus-getenv-nntpserver ()
1175 "Find default nntp server.
1176 Check the NNTPSERVER environment variable and the
1177 `gnus-nntpserver-file' file."
1178 (or (getenv "NNTPSERVER")
1179 (and (file-readable-p gnus-nntpserver-file)
1181 (insert-file-contents gnus-nntpserver-file)
1182 (when (re-search-forward "[^ \t\n\r]+" nil t)
1183 (match-string 0))))))
1185 (defcustom gnus-select-method
1188 (list 'nntp (or (condition-case nil
1189 (gnus-getenv-nntpserver)
1191 (when (and gnus-default-nntp-server
1192 (not (string= gnus-default-nntp-server "")))
1193 gnus-default-nntp-server)
1195 (if (or (null gnus-nntp-service)
1196 (equal gnus-nntp-service "nntp"))
1198 (list gnus-nntp-service)))
1200 "Default method for selecting a newsgroup.
1201 This variable should be a list, where the first element is how the
1202 news is to be fetched, the second is the address.
1204 For instance, if you want to get your news via \"flab.flab.edu\" using
1205 NNTP, you could say:
1207 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1209 If you want to use your local spool, say:
1211 \(setq gnus-select-method (list 'nnspool (system-name)))
1213 If you use this variable, you must set `gnus-nntp-server' to nil.
1215 There is a lot more to know about select methods and virtual servers -
1216 see the manual for details."
1218 :type 'gnus-select-method)
1220 (defcustom gnus-message-archive-method "archive"
1221 "*Method used for archiving messages you've sent.
1222 This should be a mail method."
1224 :group 'gnus-message
1225 :type '(choice (const :tag "Default archive method" "archive")
1226 gnus-select-method))
1228 (defcustom gnus-message-archive-group nil
1229 "*Name of the group in which to save the messages you've written.
1230 This can either be a string; a list of strings; or an alist
1231 of regexps/functions/forms to be evaluated to return a string (or a list
1232 of strings). The functions are called with the name of the current
1233 group (or nil) as a parameter.
1235 If you want to save your mail in one group and the news articles you
1236 write in another group, you could say something like:
1238 \(setq gnus-message-archive-group
1239 '((if (message-news-p)
1243 Normally the group names returned by this variable should be
1244 unprefixed -- which implicitly means \"store on the archive server\".
1245 However, you may wish to store the message on some other server. In
1246 that case, just return a fully prefixed name of the group --
1247 \"nnml+private:mail.misc\", for instance."
1248 :group 'gnus-message
1249 :type '(choice (const :tag "none" nil)
1254 (defcustom gnus-secondary-servers nil
1255 "List of NNTP servers that the user can choose between interactively.
1256 To make Gnus query you for a server, you have to give `gnus' a
1257 non-numeric prefix - `C-u M-x gnus', in short."
1259 :type '(repeat string))
1261 (defcustom gnus-nntp-server nil
1262 "*The name of the host running the NNTP server.
1263 This variable is semi-obsolete. Use the `gnus-select-method'
1266 :type '(choice (const :tag "disable" nil)
1269 (defcustom gnus-secondary-select-methods nil
1270 "A list of secondary methods that will be used for reading news.
1271 This is a list where each element is a complete select method (see
1272 `gnus-select-method').
1274 If, for instance, you want to read your mail with the nnml back end,
1275 you could set this variable:
1277 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1279 :type '(repeat gnus-select-method))
1281 (defvar gnus-backup-default-subscribed-newsgroups
1282 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1283 "Default default new newsgroups the first time Gnus is run.
1284 Should be set in paths.el, and shouldn't be touched by the user.")
1286 (defcustom gnus-local-domain nil
1287 "Local domain name without a host name.
1288 The DOMAINNAME environment variable is used instead if it is defined.
1289 If the function `system-name' returns the full Internet name, there is
1290 no need to set this variable."
1291 :group 'gnus-message
1292 :type '(choice (const :tag "default" nil)
1295 (defvar gnus-local-organization nil
1296 "String with a description of what organization (if any) the user belongs to.
1297 Obsolete variable; use `message-user-organization' instead.")
1299 ;; Customization variables
1301 (defcustom gnus-refer-article-method nil
1302 "Preferred method for fetching an article by Message-ID.
1303 If you are reading news from the local spool (with nnspool), fetching
1304 articles by Message-ID is painfully slow. By setting this method to an
1305 nntp method, you might get acceptable results.
1307 The value of this variable must be a valid select method as discussed
1308 in the documentation of `gnus-select-method'.
1310 It can also be a list of select methods, as well as the special symbol
1311 `current', which means to use the current select method. If it is a
1312 list, Gnus will try all the methods in the list until it finds a match."
1314 :type '(choice (const :tag "default" nil)
1316 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1318 (repeat :menu-tag "Try multiple"
1320 :value (current (nnweb "refer" (nnweb-type google)))
1321 (choice :tag "Method"
1323 (const :tag "Google"
1324 (nnweb "refer" (nnweb-type google)))
1325 gnus-select-method))))
1327 (defcustom gnus-group-faq-directory
1328 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1329 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1330 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1331 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1332 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1333 "/ftp@rtfm.mit.edu:/pub/usenet/"
1334 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1335 "/ftp@ftp.sunet.se:/pub/usenet/"
1336 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1337 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1338 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1339 "*Directory where the group FAQs are stored.
1340 This will most commonly be on a remote machine, and the file will be
1341 fetched by ange-ftp.
1343 This variable can also be a list of directories. In that case, the
1344 first element in the list will be used by default. The others can
1345 be used when being prompted for a site.
1347 Note that Gnus uses an aol machine as the default directory. If this
1348 feels fundamentally unclean, just think of it as a way to finally get
1349 something of value back from them.
1351 If the default site is too slow, try one of these:
1353 North America: mirrors.aol.com /pub/rtfm/usenet
1354 ftp.seas.gwu.edu /pub/rtfm
1355 rtfm.mit.edu /pub/usenet
1356 Europe: ftp.uni-paderborn.de /pub/FAQ
1357 src.doc.ic.ac.uk /usenet/news-FAQS
1358 ftp.sunet.se /pub/usenet
1359 ftp.pasteur.fr /pub/FAQ
1360 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1361 hwarang.postech.ac.kr /pub/usenet
1362 ftp.hk.super.net /mirror/faqs"
1363 :group 'gnus-group-various
1364 :type '(choice directory
1365 (repeat directory)))
1367 (defcustom gnus-group-charter-alist
1368 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1369 ("de" . (concat "http://purl.net/charta/" name ".html"))
1370 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1371 ("england" . (concat "http://england.news-admin.org/charters/" name))
1372 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1373 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1374 (gnus-replace-in-string name "europa\\." "") ".html"))
1375 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1376 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1377 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1378 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1379 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1380 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1381 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1382 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1383 (gnus-replace-in-string name "\\." "_") ".html"))
1384 ("milw" . (concat "http://usenet.mil.wi.us/"
1385 (gnus-replace-in-string name "milw\\." "") "-charter"))
1386 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1387 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1388 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1389 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1390 When FORM is evaluated `name' is bound to the name of the group."
1392 :group 'gnus-group-various
1393 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1395 (defcustom gnus-group-fetch-control-use-browse-url nil
1396 "*Non-nil means that control messages are displayed using `browse-url'.
1397 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1400 :group 'gnus-group-various
1403 (defcustom gnus-use-cross-reference t
1404 "*Non-nil means that cross referenced articles will be marked as read.
1405 If nil, ignore cross references. If t, mark articles as read in
1406 subscribed newsgroups. If neither t nor nil, mark as read in all
1409 :type '(choice (const :tag "off" nil)
1410 (const :tag "subscribed" t)
1414 (defcustom gnus-process-mark ?#
1416 :group 'gnus-group-visual
1417 :group 'gnus-summary-marks
1420 (defcustom gnus-large-newsgroup 200
1421 "*The number of articles which indicates a large newsgroup.
1422 If the number of articles in a newsgroup is greater than this value,
1423 confirmation is required for selecting the newsgroup.
1424 If it is nil, no confirmation is required."
1425 :group 'gnus-group-select
1426 :type '(choice (const :tag "No limit" nil)
1429 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1430 "*Non-nil means that the default name of a file to save articles in is the group name.
1431 If it's nil, the directory form of the group name is used instead.
1433 If this variable is a list, and the list contains the element
1434 `not-score', long file names will not be used for score files; if it
1435 contains the element `not-save', long file names will not be used for
1436 saving; and if it contains the element `not-kill', long file names
1437 will not be used for kill files.
1439 Note that the default for this variable varies according to what system
1440 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1441 to nil while on all other systems it defaults to t."
1443 :type '(radio (sexp :format "Non-nil\n"
1444 :match (lambda (widget value)
1445 (and value (not (listp value))))
1448 (checklist (const :format "%v " not-score)
1449 (const :format "%v " not-save)
1452 (defcustom gnus-kill-files-directory gnus-directory
1453 "*Name of the directory where kill files will be stored (default \"~/News\")."
1454 :group 'gnus-score-files
1455 :group 'gnus-score-kill
1458 (defcustom gnus-save-score nil
1459 "*If non-nil, save group scoring info."
1460 :group 'gnus-score-various
1464 (defcustom gnus-use-undo t
1465 "*If non-nil, allow undoing in Gnus group mode buffers."
1469 (defcustom gnus-use-adaptive-scoring nil
1470 "*If non-nil, use some adaptive scoring scheme.
1471 If a list, then the values `word' and `line' are meaningful. The
1472 former will perform adaption on individual words in the subject
1473 header while `line' will perform adaption on several headers."
1475 :group 'gnus-score-adapt
1476 :type '(set (const word) (const line)))
1478 (defcustom gnus-use-cache 'passive
1479 "*If nil, Gnus will ignore the article cache.
1480 If `passive', it will allow entering (and reading) articles
1481 explicitly entered into the cache. If anything else, use the
1482 cache to the full extent of the law."
1485 :type '(choice (const :tag "off" nil)
1486 (const :tag "passive" passive)
1487 (const :tag "active" t)))
1489 (defcustom gnus-use-trees nil
1490 "*If non-nil, display a thread tree buffer."
1494 (defcustom gnus-keep-backlog 20
1495 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1496 If it is a number N, then Gnus will only keep the last N articles
1497 read. If it is neither nil nor a number, Gnus will keep all read
1498 articles. This is not a good idea."
1500 :type '(choice (const :tag "off" nil)
1505 (defcustom gnus-use-nocem nil
1506 "*If non-nil, Gnus will read NoCeM cancel messages."
1510 (defcustom gnus-suppress-duplicates nil
1511 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1515 (defcustom gnus-use-scoring t
1516 "*If non-nil, enable scoring."
1520 (defcustom gnus-summary-prepare-exit-hook
1521 '(gnus-summary-expire-articles)
1522 "*A hook called when preparing to exit from the summary buffer.
1523 It calls `gnus-summary-expire-articles' by default."
1524 :group 'gnus-summary-exit
1527 (defcustom gnus-novice-user t
1528 "*Non-nil means that you are a Usenet novice.
1529 If non-nil, verbose messages may be displayed and confirmations may be
1534 (defcustom gnus-expert-user nil
1535 "*Non-nil means that you will never be asked for confirmation about anything.
1536 That doesn't mean *anything* anything; particularly destructive
1537 commands will still require prompting."
1541 (defcustom gnus-interactive-catchup t
1542 "*If non-nil, require your confirmation when catching up a group."
1543 :group 'gnus-group-select
1546 (defcustom gnus-interactive-exit t
1547 "*If non-nil, require your confirmation when exiting Gnus."
1551 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1552 "Function for extracting address components from a From header.
1553 Three pre-defined functions exist: `gnus-extract-address-components',
1554 which is the default, quite fast, and too simplistic solution,
1555 `mail-extract-address-components', which works much better, but is
1556 slower, and `std11-extract-address-components'."
1557 :group 'gnus-summary-format
1558 :type '(radio (function-item gnus-extract-address-components)
1559 (function-item mail-extract-address-components)
1560 (function-item std11-extract-address-components)
1561 (function :tag "Other")))
1563 (defcustom gnus-carpal nil
1564 "*If non-nil, display clickable icons."
1568 (defcustom gnus-shell-command-separator ";"
1569 "String used to separate shell commands."
1573 (defcustom gnus-valid-select-methods
1574 '(("nntp" post address prompt-address physical-address)
1575 ("nnspool" post address)
1576 ("nnvirtual" post-mail virtual prompt-address)
1577 ("nnmbox" mail respool address)
1578 ("nnml" post-mail respool address)
1579 ("nnmh" mail respool address)
1580 ("nndir" post-mail prompt-address physical-address)
1581 ("nneething" none address prompt-address physical-address)
1582 ("nndoc" none address prompt-address)
1583 ("nnbabyl" mail address respool)
1584 ("nnkiboze" post virtual)
1585 ("nnsoup" post-mail address)
1586 ("nndraft" post-mail)
1587 ("nnfolder" mail respool address)
1588 ("nngateway" post-mail address prompt-address physical-address)
1597 ("nnagent" post-mail)
1598 ("nnimap" post-mail address prompt-address physical-address)
1599 ("nnmaildir" mail respool address)
1601 "*An alist of valid select methods.
1602 The first element of each list lists should be a string with the name
1603 of the select method. The other elements may be the category of
1604 this method (i. e., `post', `mail', `none' or whatever) or other
1605 properties that this method has (like being respoolable).
1606 If you implement a new select method, all you should have to change is
1607 this variable. I think."
1609 :type '(repeat (group (string :tag "Name")
1610 (radio-button-choice (const :format "%v " post)
1611 (const :format "%v " mail)
1612 (const :format "%v " none)
1614 (checklist :inline t
1615 (const :format "%v " address)
1616 (const :format "%v " prompt-address)
1617 (const :format "%v " physical-address)
1618 (const :format "%v " virtual)
1621 (defun gnus-redefine-select-method-widget ()
1622 "Recomputes the select-method widget based on the value of
1623 `gnus-valid-select-methods'."
1624 (define-widget 'gnus-select-method 'list
1625 "Widget for entering a select method."
1627 :tag "Select Method"
1628 :args `((choice :tag "Method"
1629 ,@(mapcar (lambda (entry)
1630 (list 'const :format "%v\n"
1631 (intern (car entry))))
1632 gnus-valid-select-methods)
1633 (symbol :tag "other"))
1634 (string :tag "Address")
1635 (repeat :tag "Options"
1639 (sexp :tag "Value"))))))
1641 (gnus-redefine-select-method-widget)
1643 (defcustom gnus-updated-mode-lines '(group article summary tree)
1644 "List of buffers that should update their mode lines.
1645 The list may contain the symbols `group', `article', `tree' and
1646 `summary'. If the corresponding symbol is present, Gnus will keep
1647 that mode line updated with information that may be pertinent.
1648 If this variable is nil, screen refresh may be quicker."
1649 :group 'gnus-various
1650 :type '(set (const group)
1655 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1656 (defcustom gnus-mode-non-string-length nil
1657 "*Max length of mode-line non-string contents.
1658 If this is nil, Gnus will take space as is needed, leaving the rest
1659 of the mode line intact. Note that the default of nil is unlikely
1660 to be desirable; see the manual for further details."
1661 :group 'gnus-various
1662 :type '(choice (const nil)
1665 ;; There should be special validation for this.
1666 (define-widget 'gnus-email-address 'string
1667 "An email address.")
1669 (gnus-define-group-parameter
1672 "Return GROUP's to-address."
1674 "*Alist of group regexps and correspondent to-addresses."
1675 :variable-group gnus-group-parameter
1676 :parameter-type '(gnus-email-address :tag "To Address")
1677 :parameter-document "\
1678 This will be used when doing followups and posts.
1680 This is primarily useful in mail groups that represent closed
1681 mailing lists--mailing lists where it's expected that everybody that
1682 writes to the mailing list is subscribed to it. Since using this
1683 parameter ensures that the mail only goes to the mailing list itself,
1684 it means that members won't receive two copies of your followups.
1686 Using `to-address' will actually work whether the group is foreign or
1687 not. Let's say there's a group on the server that is called
1688 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1689 articles from a mail-to-news gateway. Posting directly to this group
1690 is therefore impossible--you have to send mail to the mailing list
1693 The gnus-group-split mail splitting mechanism will behave as if this
1694 address was listed in gnus-group-split Addresses (see below).")
1696 (gnus-define-group-parameter
1699 "Return GROUP's to-list."
1701 "*Alist of group regexps and correspondent to-lists."
1702 :variable-group gnus-group-parameter
1703 :parameter-type '(gnus-email-address :tag "To List")
1704 :parameter-document "\
1705 This address will be used when doing a `a' in the group.
1707 It is totally ignored when doing a followup--except that if it is
1708 present in a news group, you'll get mail group semantics when doing
1711 The gnus-group-split mail splitting mechanism will behave as if this
1712 address was listed in gnus-group-split Addresses (see below).")
1714 (gnus-define-group-parameter
1718 "Return GROUP's subscription status."
1720 "*Groups which are automatically considered subscribed."
1721 :variable-group gnus-group-parameter
1722 :parameter-type '(const :tag "Subscribed" t)
1723 :parameter-document "\
1724 Gnus assumed that you are subscribed to the To/List address.
1726 When constructing a list of subscribed groups using
1727 `gnus-find-subscribed-addresses', Gnus includes the To address given
1728 above, or the list address (if the To address has not been set).")
1730 (gnus-define-group-parameter
1733 :function gnus-group-auto-expirable-p
1735 "Check whether GROUP is auto-expirable or not."
1736 :variable gnus-auto-expirable-newsgroups
1737 :variable-default nil
1739 "*Groups in which to automatically mark read articles as expirable.
1740 If non-nil, this should be a regexp that should match all groups in
1741 which to perform auto-expiry. This only makes sense for mail groups."
1742 :variable-group nnmail-expire
1743 :variable-type '(choice (const nil)
1745 :parameter-type '(const :tag "Automatic Expire" t)
1747 "All articles that are read will be marked as expirable.")
1749 (gnus-define-group-parameter
1752 :function gnus-group-total-expirable-p
1754 "Check whether GROUP is total-expirable or not."
1755 :variable gnus-total-expirable-newsgroups
1756 :variable-default nil
1758 "*Groups in which to perform expiry of all read articles.
1759 Use with extreme caution. All groups that match this regexp will be
1760 expiring - which means that all read articles will be deleted after
1761 \(say) one week. (This only goes for mail groups and the like, of
1763 :variable-group nnmail-expire
1764 :variable-type '(choice (const nil)
1766 :parameter-type '(const :tag "Total Expire" t)
1768 "All read articles will be put through the expiry process
1770 This happens even if they are not marked as expirable.
1773 (gnus-define-group-parameter
1776 "Return the default charset of GROUP."
1777 :variable gnus-group-charset-alist
1779 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1780 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1781 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1782 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1783 ("\\(^\\|:\\)relcom\\>" koi8-r)
1784 ("\\(^\\|:\\)fido7\\>" koi8-r)
1785 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1786 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1787 ("\\(^\\|:\\)han\\>" euc-kr)
1788 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1789 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1790 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1792 "Alist of regexps (to match group names) and default charsets to be used when reading."
1793 :variable-group gnus-charset
1794 :variable-type '(repeat (list (regexp :tag "Group")
1795 (symbol :tag "Charset")))
1796 :parameter-type '(symbol :tag "Charset")
1797 :parameter-document "\
1798 The default charset to use in the group.")
1800 (gnus-define-group-parameter
1804 "Return a posting method for GROUP."
1805 :variable gnus-post-method-alist
1807 "Alist of regexps (to match group names) and method to be used when
1808 posting an article."
1809 :variable-group gnus-group-foreign
1811 '(choice :tag "Posting Method"
1812 (const :tag "Use native server" native)
1813 (const :tag "Use current server" current)
1814 (list :convert-widget
1816 (list 'sexp :tag "Methods"
1817 :value gnus-select-method))))
1819 "Posting method for this group.")
1821 (gnus-define-group-parameter
1822 large-newsgroup-initial
1825 "Return GROUP's initial input of the number of articles."
1827 "*Alist of group regexps and its initial input of the number of articles."
1828 :variable-group gnus-group-parameter
1829 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1830 (const :tag "All" nil)
1832 :parameter-document "\
1834 This number will be prompted as the initial value of the number of
1835 articles to list when the group is a large newsgroup (see
1836 `gnus-large-newsgroup'). If it is nil, the default value is the
1837 total number of articles in the group.")
1839 ;; The Gnus registry's ignored groups
1840 (gnus-define-group-parameter
1844 "Whether this group should be ignored by the registry."
1845 :variable gnus-registry-ignored-groups
1846 :variable-default nil
1848 "*Groups in which the registry should be turned off."
1849 :variable-group gnus-registry
1850 :variable-type '(repeat
1852 (regexp :tag "Group Name Regular Expression")
1853 (boolean :tag "Ignored")))
1855 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1857 "Whether the Gnus Registry should ignore this group.")
1859 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1860 (defcustom gnus-install-group-spam-parameters t
1861 "*Disable the group parameters for spam detection.
1862 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1867 (when gnus-install-group-spam-parameters
1868 (defvar gnus-group-spam-classification-spam t
1869 "Spam group classification (requires spam.el).
1870 This group contains spam messages. On summary entry, unread messages
1871 will be marked as spam. On summary exit, the specified spam
1872 processors will be invoked on spam-marked messages, then those
1873 messages will be expired, so the spam processor will only see a
1874 spam-marked message once.")
1876 (defvar gnus-group-spam-classification-ham 'ask
1877 "The ham value for the spam group parameter (requires spam.el).
1878 On summary exit, the specified ham processors will be invoked on
1879 ham-marked messages. Exercise caution, since the ham processor will
1880 see the same message more than once because there is no ham message
1883 (gnus-define-group-parameter
1887 "The spam type (spam, ham, or neither) of the group."
1888 :variable gnus-spam-newsgroup-contents
1889 :variable-default nil
1891 "*Group classification (spam, ham, or neither). Only
1892 meaningful when spam.el is loaded. If non-nil, this should be a
1893 list of group name regexps associated with a classification for
1894 each one. In spam groups, new articles are marked as spam on
1895 summary entry. There is other behavior associated with ham and
1896 no classification when spam.el is loaded - see the manual."
1897 :variable-group spam
1898 :variable-type '(repeat
1899 (list :tag "Group contents spam/ham classification"
1900 (regexp :tag "Group")
1902 (variable-item gnus-group-spam-classification-spam)
1903 (variable-item gnus-group-spam-classification-ham)
1904 (const :tag "Unclassified" nil))))
1906 :parameter-type '(list :tag "Group contents spam/ham classification"
1907 (choice :tag "Group contents classification for spam sorting"
1908 (variable-item gnus-group-spam-classification-spam)
1909 (variable-item gnus-group-spam-classification-ham)
1910 (const :tag "Unclassified" nil)))
1912 "The spam classification (spam, ham, or neither) of this group.
1913 When a spam group is entered, all unread articles are marked as
1914 spam. There is other behavior associated with ham and no
1915 classification when spam.el is loaded - see the manual.")
1917 (gnus-define-group-parameter
1921 "The address to get spam resent (through spam-report-resend)."
1922 :variable gnus-spam-resend-to
1923 :variable-default nil
1925 "The address to get spam resent (through spam-report-resend)."
1926 :variable-group spam
1927 :variable-type '(repeat
1928 (list :tag "Group address for resending spam"
1929 (regexp :tag "Group")
1930 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1931 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1933 "The address to get spam resent (through spam-report-resend).")
1935 (gnus-define-group-parameter
1939 "The address to get ham resent (through spam-report-resend)."
1940 :variable gnus-ham-resend-to
1941 :variable-default nil
1943 "The address to get ham resent (through spam-report-resend)."
1944 :variable-group spam
1945 :variable-type '(repeat
1946 (list :tag "Group address for resending ham"
1947 (regexp :tag "Group")
1948 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1949 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1951 "The address to get ham resent (through spam-report-resend).")
1953 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1954 "OBSOLETE: The ifile summary exit spam processor.")
1956 (defvar gnus-group-spam-exit-processor-stat "stat"
1957 "OBSOLETE: The spam-stat summary exit spam processor.")
1959 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1960 "OBSOLETE: The Bogofilter summary exit spam processor.")
1962 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1963 "OBSOLETE: The Blacklist summary exit spam processor.")
1965 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1966 "OBSOLETE: The Gmane reporting summary exit spam processor.
1967 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1969 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1970 "OBSOLETE: The spamoracle summary exit spam processor.")
1972 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1973 "OBSOLETE: The ifile summary exit ham processor.
1974 Only applicable to non-spam (unclassified and ham) groups.")
1976 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1977 "OBSOLETE: The Bogofilter summary exit ham processor.
1978 Only applicable to non-spam (unclassified and ham) groups.")
1980 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1981 "OBSOLETE: The spam-stat summary exit ham processor.
1982 Only applicable to non-spam (unclassified and ham) groups.")
1984 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1985 "OBSOLETE: The whitelist summary exit ham processor.
1986 Only applicable to non-spam (unclassified and ham) groups.")
1988 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1989 "OBSOLETE: The BBDB summary exit ham processor.
1990 Only applicable to non-spam (unclassified and ham) groups.")
1992 (defvar gnus-group-ham-exit-processor-copy "copy"
1993 "OBSOLETE: The ham copy exit ham processor.
1994 Only applicable to non-spam (unclassified and ham) groups.")
1996 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1997 "OBSOLETE: The spamoracle summary exit ham processor.
1998 Only applicable to non-spam (unclassified and ham) groups.")
2000 (gnus-define-group-parameter
2005 :tag "Spam Summary Exit Processor"
2007 (list :tag "Spam Summary Exit Processor Choices"
2009 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2010 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2011 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2012 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2013 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2014 (const :tag "Spam: ifile" (spam spam-use-ifile))
2015 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2016 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2017 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2018 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2019 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2020 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2021 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2022 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2023 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2024 (const :tag "Ham: ifile" (ham spam-use-ifile))
2025 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2026 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2027 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2028 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2029 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
2030 (variable-item gnus-group-spam-exit-processor-ifile)
2031 (variable-item gnus-group-spam-exit-processor-stat)
2032 (variable-item gnus-group-spam-exit-processor-bogofilter)
2033 (variable-item gnus-group-spam-exit-processor-blacklist)
2034 (variable-item gnus-group-spam-exit-processor-spamoracle)
2035 (variable-item gnus-group-spam-exit-processor-report-gmane)
2036 (variable-item gnus-group-ham-exit-processor-bogofilter)
2037 (variable-item gnus-group-ham-exit-processor-ifile)
2038 (variable-item gnus-group-ham-exit-processor-stat)
2039 (variable-item gnus-group-ham-exit-processor-whitelist)
2040 (variable-item gnus-group-ham-exit-processor-BBDB)
2041 (variable-item gnus-group-ham-exit-processor-spamoracle)
2042 (variable-item gnus-group-ham-exit-processor-copy))))
2044 "Which spam or ham processors will be applied when the summary is exited."
2045 :variable gnus-spam-process-newsgroups
2046 :variable-default nil
2048 "*Groups in which to automatically process spam or ham articles with
2049 a backend on summary exit. If non-nil, this should be a list of group
2050 name regexps that should match all groups in which to do automatic
2051 spam processing, associated with the appropriate processor."
2052 :variable-group spam
2054 '(repeat :tag "Spam/Ham Processors"
2055 (list :tag "Spam Summary Exit Processor Choices"
2056 (regexp :tag "Group Regexp")
2058 :tag "Spam/Ham Summary Exit Processor"
2059 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2060 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2061 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2062 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2063 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2064 (const :tag "Spam: ifile" (spam spam-use-ifile))
2065 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2066 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2067 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2068 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2069 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2070 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2071 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2072 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2073 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2074 (const :tag "Ham: ifile" (ham spam-use-ifile))
2075 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2076 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2077 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2078 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2079 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
2080 (variable-item gnus-group-spam-exit-processor-ifile)
2081 (variable-item gnus-group-spam-exit-processor-stat)
2082 (variable-item gnus-group-spam-exit-processor-bogofilter)
2083 (variable-item gnus-group-spam-exit-processor-blacklist)
2084 (variable-item gnus-group-spam-exit-processor-spamoracle)
2085 (variable-item gnus-group-spam-exit-processor-report-gmane)
2086 (variable-item gnus-group-ham-exit-processor-bogofilter)
2087 (variable-item gnus-group-ham-exit-processor-ifile)
2088 (variable-item gnus-group-ham-exit-processor-stat)
2089 (variable-item gnus-group-ham-exit-processor-whitelist)
2090 (variable-item gnus-group-ham-exit-processor-BBDB)
2091 (variable-item gnus-group-ham-exit-processor-spamoracle)
2092 (variable-item gnus-group-ham-exit-processor-copy))))
2095 "Which spam or ham processors will be applied when the summary is exited.")
2097 (gnus-define-group-parameter
2101 '(boolean :tag "Spam autodetection")
2103 "Should spam be autodetected (with spam-split) in this group?"
2104 :variable gnus-spam-autodetect
2105 :variable-default nil
2107 "*Groups in which spam should be autodetected when they are entered.
2108 Only unseen articles will be examined, unless
2109 spam-autodetect-recheck-messages is set."
2110 :variable-group spam
2113 :tag "Autodetection setting"
2115 (regexp :tag "Group Regexp")
2118 "Spam autodetection.
2119 Only unseen articles will be examined, unless
2120 spam-autodetect-recheck-messages is set.")
2122 (gnus-define-group-parameter
2123 spam-autodetect-methods
2126 '(choice :tag "Spam autodetection-specific methods"
2129 (set :tag "Use specific methods"
2130 (variable-item spam-use-blacklist)
2131 (variable-item spam-use-gmane-xref)
2132 (variable-item spam-use-regex-headers)
2133 (variable-item spam-use-regex-body)
2134 (variable-item spam-use-whitelist)
2135 (variable-item spam-use-BBDB)
2136 (variable-item spam-use-ifile)
2137 (variable-item spam-use-spamoracle)
2138 (variable-item spam-use-crm114)
2139 (variable-item spam-use-spamassassin)
2140 (variable-item spam-use-spamassassin-headers)
2141 (variable-item spam-use-bsfilter)
2142 (variable-item spam-use-bsfilter-headers)
2143 (variable-item spam-use-stat)
2144 (variable-item spam-use-blackholes)
2145 (variable-item spam-use-hashcash)
2146 (variable-item spam-use-bogofilter-headers)
2147 (variable-item spam-use-bogofilter)))
2149 "Methods to be used for autodetection in each group"
2150 :variable gnus-spam-autodetect-methods
2151 :variable-default nil
2153 "*Methods for autodetecting spam per group.
2154 Requires the spam-autodetect parameter. Only unseen articles
2155 will be examined, unless spam-autodetect-recheck-messages is
2157 :variable-group spam
2160 :tag "Autodetection methods"
2162 (regexp :tag "Group Regexp")
2166 (set :tag "Use specific methods"
2167 (variable-item spam-use-blacklist)
2168 (variable-item spam-use-gmane-xref)
2169 (variable-item spam-use-regex-headers)
2170 (variable-item spam-use-regex-body)
2171 (variable-item spam-use-whitelist)
2172 (variable-item spam-use-BBDB)
2173 (variable-item spam-use-ifile)
2174 (variable-item spam-use-spamoracle)
2175 (variable-item spam-use-crm114)
2176 (variable-item spam-use-stat)
2177 (variable-item spam-use-blackholes)
2178 (variable-item spam-use-hashcash)
2179 (variable-item spam-use-spamassassin)
2180 (variable-item spam-use-spamassassin-headers)
2181 (variable-item spam-use-bsfilter)
2182 (variable-item spam-use-bsfilter-headers)
2183 (variable-item spam-use-bogofilter-headers)
2184 (variable-item spam-use-bogofilter)))))
2186 "Spam autodetection methods.
2187 Requires the spam-autodetect parameter. Only unseen articles
2188 will be examined, unless spam-autodetect-recheck-messages is
2191 (gnus-define-group-parameter
2192 spam-process-destination
2195 '(choice :tag "Destination for spam-processed articles at summary exit"
2196 (string :tag "Move to a group")
2197 (repeat :tag "Move to multiple groups"
2198 (string :tag "Destination group"))
2199 (const :tag "Expire" nil))
2201 "Where spam-processed articles will go at summary exit."
2202 :variable gnus-spam-process-destinations
2203 :variable-default nil
2205 "*Groups in which to explicitly send spam-processed articles to
2206 another group, or expire them (the default). If non-nil, this should
2207 be a list of group name regexps that should match all groups in which
2208 to do spam-processed article moving, associated with the destination
2209 group or nil for explicit expiration. This only makes sense for
2211 :variable-group spam
2214 :tag "Spam-processed articles destination"
2216 (regexp :tag "Group Regexp")
2218 :tag "Destination for spam-processed articles at summary exit"
2219 (string :tag "Move to a group")
2220 (repeat :tag "Move to multiple groups"
2221 (string :tag "Destination group"))
2222 (const :tag "Expire" nil))))
2224 "Where spam-processed articles will go at summary exit.")
2226 (gnus-define-group-parameter
2227 ham-process-destination
2231 :tag "Destination for ham articles at summary exit from a spam group"
2232 (string :tag "Move to a group")
2233 (repeat :tag "Move to multiple groups"
2234 (string :tag "Destination group"))
2235 (const :tag "Respool" respool)
2236 (const :tag "Do nothing" nil))
2238 "Where ham articles will go at summary exit from a spam group."
2239 :variable gnus-ham-process-destinations
2240 :variable-default nil
2242 "*Groups in which to explicitly send ham articles to
2243 another group, or do nothing (the default). If non-nil, this should
2244 be a list of group name regexps that should match all groups in which
2245 to do ham article moving, associated with the destination
2246 group or nil for explicit ignoring. This only makes sense for
2247 mail groups, and only works in spam groups."
2248 :variable-group spam
2251 :tag "Ham articles destination"
2253 (regexp :tag "Group Regexp")
2255 :tag "Destination for ham articles at summary exit from spam group"
2256 (string :tag "Move to a group")
2257 (repeat :tag "Move to multiple groups"
2258 (string :tag "Destination group"))
2259 (const :tag "Respool" respool)
2260 (const :tag "Expire" nil))))
2262 "Where ham articles will go at summary exit from a spam group.")
2264 (gnus-define-group-parameter
2267 :parameter-type '(list :tag "Ham mark choices"
2269 (variable-item gnus-del-mark)
2270 (variable-item gnus-read-mark)
2271 (variable-item gnus-ticked-mark)
2272 (variable-item gnus-killed-mark)
2273 (variable-item gnus-kill-file-mark)
2274 (variable-item gnus-low-score-mark)))
2277 "Marks considered ham (positively not spam). Such articles will be
2278 processed as ham (non-spam) on group exit. When nil, the global
2279 spam-ham-marks variable takes precedence."
2280 :variable-default '((".*" ((gnus-del-mark
2284 gnus-low-score-mark))))
2285 :variable-group spam
2287 "*Groups in which to explicitly set the ham marks to some value.")
2289 (gnus-define-group-parameter
2292 :parameter-type '(list :tag "Spam mark choices"
2294 (variable-item gnus-spam-mark)
2295 (variable-item gnus-killed-mark)
2296 (variable-item gnus-kill-file-mark)
2297 (variable-item gnus-low-score-mark)))
2300 "Marks considered spam.
2301 Such articles will be processed as spam on group exit. When nil, the global
2302 spam-spam-marks variable takes precedence."
2303 :variable-default '((".*" ((gnus-spam-mark))))
2304 :variable-group spam
2306 "*Groups in which to explicitly set the spam marks to some value."))
2308 (defcustom gnus-group-uncollapsed-levels 1
2309 "Number of group name elements to leave alone when making a short group name."
2310 :group 'gnus-group-visual
2313 (defcustom gnus-group-use-permanent-levels nil
2314 "*If non-nil, once you set a level, Gnus will use this level."
2315 :group 'gnus-group-levels
2320 (defcustom gnus-load-hook nil
2321 "A hook run while Gnus is loaded."
2325 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2326 "A hook called to apply kill files to a group.
2327 This hook is intended to apply a kill file to the selected newsgroup.
2328 The function `gnus-apply-kill-file' is called by default.
2330 Since a general kill file is too heavy to use only for a few
2331 newsgroups, I recommend you to use a lighter hook function. For
2332 example, if you'd like to apply a kill file to articles which contains
2333 a string `rmgroup' in subject in newsgroup `control', you can use the
2336 (setq gnus-apply-kill-hook
2339 (cond ((string-match \"control\" gnus-newsgroup-name)
2340 (gnus-kill \"Subject\" \"rmgroup\")
2341 (gnus-expunge \"X\"))))))"
2342 :group 'gnus-score-kill
2343 :options '(gnus-apply-kill-file)
2346 (defcustom gnus-group-change-level-function nil
2347 "Function run when a group level is changed.
2348 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2349 :group 'gnus-group-levels
2354 (defcustom gnus-visual
2355 '(summary-highlight group-highlight article-highlight
2357 summary-menu group-menu article-menu
2358 tree-highlight menu highlight
2359 browse-menu server-menu
2360 page-marker tree-menu binary-menu pick-menu)
2361 "*Enable visual features.
2362 If `visual' is disabled, there will be no menus and few faces. Most of
2363 the visual customization options below will be ignored. Gnus will use
2364 less space and be faster as a result.
2366 This variable can also be a list of visual elements to switch on. For
2367 instance, to switch off all visual things except menus, you can say:
2369 (setq gnus-visual '(menu))
2371 Valid elements include `summary-highlight', `group-highlight',
2372 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2373 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2374 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2377 :type '(set (const summary-highlight)
2378 (const group-highlight)
2379 (const article-highlight)
2381 (const summary-menu)
2383 (const article-menu)
2384 (const tree-highlight)
2394 ;; Byte-compiler warning.
2395 (defvar gnus-visual)
2396 ;; Find out whether the gnus-visual TYPE is wanted.
2397 (defun gnus-visual-p (&optional type class)
2398 (and gnus-visual ; Has to be non-nil, at least.
2399 (if (not type) ; We don't care about type.
2401 (if (listp gnus-visual) ; It's a list, so we check it.
2402 (or (memq type gnus-visual)
2403 (memq class gnus-visual))
2406 (defcustom gnus-mouse-face
2408 (if (gnus-visual-p 'mouse-face 'highlight)
2409 (if (boundp 'gnus-mouse-face)
2410 (or gnus-mouse-face 'highlight)
2414 "*Face used for group or summary buffer mouse highlighting.
2415 The line beneath the mouse pointer will be highlighted with this
2420 (defcustom gnus-article-save-directory gnus-directory
2421 "*Name of the directory articles will be saved in (default \"~/News\")."
2422 :group 'gnus-article-saving
2425 (defvar gnus-plugged t
2426 "Whether Gnus is plugged or not.")
2428 (defcustom gnus-agent-cache t
2429 "Controls use of the agent cache while plugged.
2430 When set, Gnus will prefer using the locally stored content rather
2431 than re-fetching it from the server. You also need to enable
2432 `gnus-agent' for this to have any affect."
2437 (defcustom gnus-default-charset 'undecided
2438 "Default charset assumed to be used when viewing non-ASCII characters.
2439 This variable is overridden on a group-to-group basis by the
2440 `gnus-group-charset-alist' variable and is only used on groups not
2441 covered by that variable."
2443 :group 'gnus-charset)
2445 ;; Fixme: Doc reference to agent.
2446 (defcustom gnus-agent t
2447 "Whether we want to use the Gnus agent or not.
2449 You may customize gnus-agent to disable its use. However, some
2450 back ends have started to use the agent as a client-side cache.
2451 Disabling the agent may result in noticeable loss of performance."
2456 (defcustom gnus-other-frame-function 'gnus
2457 "Function called by the command `gnus-other-frame'."
2459 :type '(choice (function-item gnus)
2460 (function-item gnus-no-server)
2461 (function-item gnus-slave)
2462 (function-item gnus-slave-no-server)))
2464 (defcustom gnus-other-frame-parameters nil
2465 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2466 This should be an alist for Emacs, or a plist for XEmacs."
2468 :type (if (featurep 'xemacs)
2469 '(repeat (list :inline t :format "%v"
2470 (symbol :tag "Property")
2471 (sexp :tag "Value")))
2472 '(repeat (cons :format "%v"
2473 (symbol :tag "Parameter")
2474 (sexp :tag "Value")))))
2476 (defcustom gnus-user-agent '(emacs gnus mime config mule)
2477 "Which information should be exposed in the User-Agent header.
2479 Can be a list of symbols or a string. Valid symbols are `gnus' (show
2480 Gnus version), `emacs' (show Emacs version) and `mime' (show SEMI,
2481 FLIM and APEL versions). In addition to the Emacs version, you can
2482 add `codename' (show (S)XEmacs codename), `mule' (show Mule version
2483 and also Meadow version if it exists) or either `config' (show system
2484 configuration) or `type' (show system type). If you set it to a
2485 string, be sure to use a valid format, see RFC 2616."
2488 :group 'gnus-message
2489 :type '(choice (list (set :format "%v" :inline t
2490 (const gnus :tag "Gnus version")
2491 (const emacs :tag "Emacs version")
2492 (choice :tag "system"
2493 (const type :tag "system type")
2494 (const config :tag "system configuration"))
2495 (const codename :tag "Emacs codename")
2496 (const mime :tag "SEMI and FLIM versions")
2498 :tag "Mule version (and Meadow version)")))
2499 (string :format "%t:\n%v")))
2501 ;; Convert old (< 2005-01-10) symbol type values:
2502 (when (symbolp gnus-user-agent)
2503 (setq gnus-user-agent
2504 (cond ((eq gnus-user-agent 'gnus-mime-edit)
2505 '(emacs gnus mime config mule))
2506 ((eq gnus-user-agent 'emacs-gnus-config)
2507 '(emacs gnus config))
2508 ((eq gnus-user-agent 'emacs-gnus-type)
2510 ((eq gnus-user-agent 'emacs-gnus)
2512 ((eq gnus-user-agent 'gnus)
2514 (t gnus-user-agent)))
2515 (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2517 (if (get 'gnus-user-agent 'saved-value)
2518 (customize-save-variable 'gnus-user-agent gnus-user-agent)
2519 (gnus-message 1 "Edit your init file to make this change permanent.")
2523 ;;; Internal variables
2525 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2526 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2527 (defvar gnus-agent-method-p-cache nil
2528 ; Reset each time gnus-agent-covered-methods is changed else
2529 ; gnus-agent-method-p may mis-report a methods status.
2531 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2532 (defvar gnus-draft-meta-information-header "X-Draft-From")
2533 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2534 (defvar gnus-original-article-buffer " *Original Article*")
2535 (defvar gnus-newsgroup-name nil)
2536 (defvar gnus-ephemeral-servers nil)
2537 (defvar gnus-server-method-cache nil)
2539 (defvar gnus-agent-fetching nil
2540 "Whether Gnus agent is in fetching mode.")
2542 (defvar gnus-agent-covered-methods nil
2543 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2545 (defvar gnus-command-method nil
2546 "Dynamically bound variable that says what the current back end is.")
2548 (defvar gnus-current-select-method nil
2549 "The current method for selecting a newsgroup.")
2551 (defvar gnus-tree-buffer "*Tree*"
2552 "Buffer where Gnus thread trees are displayed.")
2555 (defvar gnus-use-generic-from nil)
2557 ;; Variable holding the user answers to all method prompts.
2558 (defvar gnus-method-history nil)
2560 ;; Variable holding the user answers to all mail method prompts.
2561 (defvar gnus-mail-method-history nil)
2563 ;; Variable holding the user answers to all group prompts.
2564 (defvar gnus-group-history nil)
2566 (defvar gnus-server-alist nil
2567 "List of available servers.")
2569 (defcustom gnus-cache-directory
2570 (nnheader-concat gnus-directory "cache/")
2571 "*The directory where cached articles will be stored."
2575 (defvar gnus-predefined-server-alist
2578 (nnspool-spool-directory ,gnus-cache-directory)
2579 (nnspool-nov-directory ,gnus-cache-directory)
2580 (nnspool-active-file
2581 ,(nnheader-concat gnus-cache-directory "active"))))
2582 "List of predefined (convenience) servers.")
2584 (defvar gnus-topic-indentation "");; Obsolete variable.
2586 (defconst gnus-article-mark-lists
2587 '((marked . tick) (replied . reply)
2588 (expirable . expire) (killed . killed)
2589 (bookmarks . bookmark) (dormant . dormant)
2590 (scored . score) (saved . save)
2591 (cached . cache) (downloadable . download)
2592 (unsendable . unsend) (forwarded . forward)
2593 (recent . recent) (seen . seen)))
2595 (defconst gnus-article-special-mark-lists
2601 ;; Propagate flags to server, with the following exceptions:
2602 ;; `seen' is private to each gnus installation
2603 ;; `cache' is a internal gnus flag for each gnus installation
2604 ;; `download' is a agent flag private to each gnus installation
2605 ;; `unsend' are for nndraft groups only
2606 ;; `score' is not a proper mark
2607 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2608 (defconst gnus-article-unpropagated-mark-lists
2609 '(seen cache download unsend score bookmark)
2610 "Marks that shouldn't be propagated to back ends.
2611 Typical marks are those that make no sense in a standalone back end,
2612 such as a mark that says whether an article is stored in the cache
2613 \(which doesn't make sense in a standalone back end).")
2615 (defvar gnus-headers-retrieved-by nil)
2616 (defvar gnus-article-reply nil)
2617 (defvar gnus-override-method nil)
2618 (defvar gnus-opened-servers nil)
2620 (defvar gnus-current-kill-article nil)
2622 (defvar gnus-have-read-active-file nil)
2624 (defconst gnus-maintainer
2625 "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2626 "The mail address of the T-gnus maintainers.")
2628 (defcustom gnus-info-filename nil
2629 "*Controls language of gnus Info.
2630 If nil and current-language-environment is Japanese, go to gnus-ja.
2631 Otherwise go to corresponding Info.
2632 This variable can be nil, gnus or gnus-ja."
2634 :type '(choice (const nil)
2635 (const :tag "English" gnus)
2636 (const :tag "Japanese" gnus-ja)))
2638 (defvar gnus-info-nodes
2639 '((gnus-group-mode "Group Buffer")
2640 (gnus-summary-mode "Summary Buffer")
2641 (gnus-article-mode "Article Buffer")
2642 (gnus-server-mode "Server Buffer")
2643 (gnus-browse-mode "Browse Foreign Server")
2644 (gnus-tree-mode "Tree Display"))
2645 "Alist of major modes and related Info nodes.")
2647 (defvar gnus-group-buffer "*Group*")
2648 (defvar gnus-summary-buffer "*Summary*")
2649 (defvar gnus-article-buffer "*Article*")
2650 (defvar gnus-server-buffer "*Server*")
2652 (defvar gnus-slave nil
2653 "Whether this Gnus is a slave or not.")
2655 (defvar gnus-batch-mode nil
2656 "Whether this Gnus is running in batch mode or not.")
2658 (defvar gnus-variable-list
2659 '(gnus-newsrc-options gnus-newsrc-options-n
2660 gnus-newsrc-last-checked-date
2661 gnus-newsrc-alist gnus-server-alist
2662 gnus-killed-list gnus-zombie-list
2663 gnus-topic-topology gnus-topic-alist)
2664 "Gnus variables saved in the quick startup file.")
2666 (defvar gnus-product-variable-file-list
2667 (let ((version (product-version (product-find 'gnus-vers))))
2669 ((product-version ,version)
2671 (correct-string-widths))
2673 gnus-format-specs-compiled)
2675 ((product-version ,version)
2677 (correct-string-widths))
2679 gnus-format-specs)))
2680 "Alist of the methods for checking whether the contents of the T-gnus
2681 quick startup files are valid. One is for the byte-compiled format
2682 specifications, the other is for the source form. Each element should
2683 be a list which looks like follows:
2686 ((VARIABLE EXPECTED_VALUE_or_NIL)
2687 (VARIABLE EXPECTED_VALUE_or_NIL)
2689 CODING-SYSTEM_FOR_READING_FILE
2690 SYMBOL_OF_FORMAT_SPECS)")
2692 (defcustom gnus-compile-user-specs t
2693 "If non-nil, the user-defined format specs will be byte-compiled
2695 It has an effect on the values of `gnus-*-line-format-spec'."
2699 (defvar gnus-newsrc-alist nil
2700 "Assoc list of read articles.
2701 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2703 (defvar gnus-registry-alist nil
2704 "Assoc list of registry data.
2705 gnus-registry.el will populate this if it's loaded.")
2707 (defvar gnus-newsrc-hashtb nil
2708 "Hashtable of `gnus-newsrc-alist'.")
2710 (defvar gnus-killed-list nil
2711 "List of killed newsgroups.")
2713 (defvar gnus-killed-hashtb nil
2714 "Hash table equivalent of `gnus-killed-list'.")
2716 (defvar gnus-zombie-list nil
2717 "List of almost dead newsgroups.")
2719 (defvar gnus-description-hashtb nil
2720 "Descriptions of newsgroups.")
2722 (defvar gnus-list-of-killed-groups nil
2723 "List of newsgroups that have recently been killed by the user.")
2725 (defvar gnus-active-hashtb nil
2726 "Hashtable of active articles.")
2728 (defvar gnus-moderated-hashtb nil
2729 "Hashtable of moderated newsgroups.")
2731 ;; Save window configuration.
2732 (defvar gnus-prev-winconf nil)
2734 (defvar gnus-reffed-article-number nil)
2736 ;;; Let the byte-compiler know that we know about this variable.
2737 (defvar rmail-default-rmail-file)
2739 (defvar gnus-dead-summary nil)
2741 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2742 "Regexp matching invalid groups.")
2744 (defvar gnus-other-frame-object nil
2745 "A frame object which will be created by `gnus-other-frame'.")
2747 ;;; End of variables.
2749 ;; Define some autoload functions Gnus might use.
2752 ;; This little mapcar goes through the list below and marks the
2753 ;; symbols in question as autoloaded functions.
2756 (let ((interactive (nth 1 (memq ':interactive package))))
2760 (when (consp function)
2761 (setq keymap (car (memq 'keymap function)))
2762 (setq function (car function)))
2763 (unless (fboundp function)
2764 (autoload function (car package) nil interactive keymap))))
2765 (if (eq (nth 1 package) ':interactive)
2768 '(("info" :interactive t Info-goto-node)
2770 ("ps-print" ps-print-preprint)
2771 ("message" :interactive t
2772 message-send-and-exit message-yank-original)
2773 ("babel" babel-as-string)
2774 ("nnmail" nnmail-split-fancy nnmail-article-group)
2775 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2776 ("rmailout" rmail-output rmail-output-to-rmail-file)
2777 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2778 rmail-show-message rmail-summary-exists
2779 rmail-select-summary rmail-update-summary)
2780 ("gnus-audio" :interactive t gnus-audio-play)
2781 ("gnus-xmas" gnus-xmas-splash)
2782 ("gnus-soup" :interactive t
2783 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2784 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2785 ("nnsoup" nnsoup-pack-replies)
2786 ("score-mode" :interactive t gnus-score-mode)
2787 ("gnus-mh" gnus-summary-save-article-folder
2788 gnus-Folder-save-name gnus-folder-save-name)
2789 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2790 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2791 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2792 gnus-demon-add-disconnection gnus-demon-add-handler
2793 gnus-demon-remove-handler)
2794 ("gnus-demon" :interactive t
2795 gnus-demon-init gnus-demon-cancel)
2796 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2797 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2798 gnus-face-from-file)
2799 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2800 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2801 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2802 gnus-nocem-unwanted-article-p)
2803 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2804 gnus-server-server-name)
2805 ("gnus-srvr" gnus-browse-foreign-server)
2806 ("gnus-cite" :interactive t
2807 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2808 gnus-article-hide-citation gnus-article-fill-cited-article
2809 gnus-article-hide-citation-in-followups)
2810 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2811 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2812 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2813 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2814 gnus-cache-possibly-remove-articles gnus-cache-request-article
2815 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2816 gnus-cache-enter-remove-article gnus-cached-article-p
2817 gnus-cache-open gnus-cache-close gnus-cache-update-article
2818 gnus-cache-articles-in-group)
2819 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2820 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2821 ("gnus-score" :interactive t
2822 gnus-summary-increase-score gnus-summary-set-score
2823 gnus-summary-raise-thread gnus-summary-raise-same-subject
2824 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2825 gnus-summary-lower-thread gnus-summary-lower-same-subject
2826 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2827 gnus-summary-current-score gnus-score-delta-default
2828 gnus-score-flush-cache gnus-score-close
2829 gnus-possibly-score-headers gnus-score-followup-article
2830 gnus-score-followup-thread)
2832 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2833 gnus-current-score-file-nondirectory gnus-score-adaptive
2834 gnus-score-find-trace gnus-score-file-name)
2835 ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2836 gnus-score-customize)
2837 ("gnus-topic" :interactive t gnus-topic-mode)
2838 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2839 gnus-subscribe-topics)
2840 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2841 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2842 ("gnus-uu" :interactive t
2843 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2844 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2845 gnus-uu-mark-by-regexp gnus-uu-mark-all
2846 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2847 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2848 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2849 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2850 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2851 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2852 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2853 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2854 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2855 gnus-uu-unmark-thread)
2856 ("gnus-msg" (gnus-summary-send-map keymap)
2857 gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2858 ("gnus-msg" :interactive t
2859 gnus-group-post-news gnus-group-mail gnus-group-news
2860 gnus-summary-post-news gnus-summary-news-other-window
2861 gnus-summary-followup gnus-summary-followup-with-original
2862 gnus-summary-cancel-article gnus-summary-supersede-article
2863 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2864 gnus-summary-mail-forward gnus-summary-mail-other-window
2865 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2866 gnus-summary-wide-reply gnus-summary-followup-to-mail
2867 gnus-summary-followup-to-mail-with-original gnus-bug
2868 gnus-summary-wide-reply-with-original gnus-summary-post-forward
2869 gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2870 ("gnus-picon" :interactive t gnus-treat-from-picon)
2871 ("smiley" :interactive t smiley-region)
2872 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2873 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2874 gnus-list-of-unread-articles gnus-list-of-read-articles
2875 gnus-offer-save-summaries gnus-make-thread-indent-array
2876 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2877 gnus-summary-skip-intangible gnus-summary-article-number
2878 gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2879 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2880 gnus-group-list-groups gnus-group-first-unread-group
2881 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2882 gnus-group-setup-buffer gnus-group-get-new-news
2883 gnus-group-make-help-group gnus-group-update-group
2884 gnus-group-iterate gnus-group-group-name)
2885 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2886 gnus-backlog-remove-article)
2887 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2888 gnus-article-prepare gnus-article-set-window-start
2889 gnus-article-next-page gnus-article-prev-page
2890 gnus-request-article-this-buffer gnus-article-mode
2891 gnus-article-setup-buffer gnus-narrow-to-page
2892 gnus-article-delete-invisible-text gnus-treat-article)
2893 ("gnus-art" :interactive t
2894 gnus-article-hide-headers gnus-article-hide-boring-headers
2895 gnus-article-treat-overstrike
2896 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2897 gnus-article-display-x-face
2898 gnus-article-decode-HZ
2899 gnus-article-wash-html
2900 gnus-article-unsplit-urls
2901 gnus-article-hide-pem gnus-article-hide-signature
2902 gnus-article-strip-leading-blank-lines gnus-article-date-local
2903 gnus-article-date-original gnus-article-date-lapsed
2904 gnus-article-show-all-headers
2905 ;; gnus-article-show-all
2906 gnus-article-edit-mode gnus-article-edit-article
2907 gnus-article-edit-done article-decode-encoded-words
2908 gnus-start-date-timer gnus-stop-date-timer)
2909 ("gnus-int" gnus-request-type)
2910 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2911 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2912 gnus-check-reasonable-setup)
2913 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2914 gnus-dup-enter-articles)
2915 ("gnus-range" gnus-copy-sequence)
2916 ("gnus-eform" gnus-edit-form)
2917 ("gnus-move" :interactive t
2918 gnus-group-move-group-to-server gnus-change-server)
2919 ("gnus-logic" gnus-score-advanced)
2920 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2921 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2922 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2923 gnus-async-halt-prefetch)
2926 ("gnus-offline" :interactive t
2927 gnus-offline-toggle-plugged
2928 gnus-offline-set-unplugged-state
2929 gnus-offline-toggle-auto-hangup
2930 gnus-offline-toggle-on/off-send-mail
2931 gnus-offline-toggle-articles-to-fetch
2932 gnus-offline-set-interval-time
2933 gnus-offline-agent-expire)
2934 ("miee" :interactive t gnspool-get-news
2935 mail-spool-send news-spool-post)
2936 ("international/mw32misc" define-process-argument-editing
2937 general-process-argument-editing-function)
2938 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2939 gnus-agent-save-active gnus-agent-method-p
2940 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2941 gnus-summary-set-agent-mark gnus-agent-save-group-info
2942 gnus-agent-request-article gnus-agent-retrieve-headers)
2943 ("gnus-agent" :interactive t
2944 gnus-unplugged gnus-agentize gnus-agent-batch)
2945 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2946 gnus-summary-save-article-vm)
2947 ("compface" uncompface)
2948 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2949 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2950 ("gnus-mlspl" :interactive t gnus-group-split-setup
2951 gnus-group-split-update)
2952 ("gnus-delay" gnus-delay-initialize))))
2955 (unless (featurep 'xemacs)
2956 (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
2958 (unless (and (fboundp 'base64-encode-string)
2959 (subrp (symbol-function 'base64-encode-string)))
2962 ;; To search articles with Namazu.
2963 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2964 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
2965 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
2966 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
2968 ;; To make nnir groups.
2969 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2971 ;; To make shimbun groups.
2972 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2974 ;;; gnus-sum.el thingies
2976 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2977 "*The format specification of the lines in the summary buffer.
2979 It works along the same lines as a normal formatting string,
2980 with some simple extensions.
2982 %N Article number, left padded with spaces (string)
2984 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2985 %n Name of the poster (string)
2986 %a Extracted name of the poster (string)
2987 %A Extracted address of the poster (string)
2988 %F Contents of the From: header (string)
2989 %f Contents of the From: or To: headers (string)
2990 %x Contents of the Xref: header (string)
2991 %D Date of the article (string)
2992 %d Date of the article (string) in DD-MMM format
2993 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2994 %M Message-id of the article (string)
2995 %r References of the article (string)
2996 %c Number of characters in the article (integer)
2997 %k Pretty-printed version of the above (string)
2998 For example, \"1.2k\" or \"0.4M\".
2999 %L Number of lines in the article (integer)
3000 %I Indentation based on thread level (a string of spaces)
3001 %B A complex trn-style thread tree (string)
3002 The variables `gnus-sum-thread-*' can be used for customization.
3003 %T A string with two possible values: 80 spaces if the article
3004 is on thread level two or larger and 0 spaces on level one
3005 %R \"A\" if this article has been replied to, \" \" otherwise (character)
3006 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
3007 %[ Opening bracket (character, \"[\" or \"<\")
3008 %] Closing bracket (character, \"]\" or \">\")
3009 %> Spaces of length thread-level (string)
3010 %< Spaces of length (- 20 thread-level) (string)
3011 %i Article score (number)
3012 %z Article zcore (character)
3013 %t Number of articles under the current thread (number).
3014 %e Whether the thread is empty or not (character).
3015 %V Total thread score (number).
3016 %P The line number (number).
3017 %O Download mark (character).
3018 %* If present, indicates desired cursor position
3019 (instead of after first colon).
3020 %u User defined specifier. The next character in the format string should
3021 be a letter. Gnus will call the function gnus-user-format-function-X,
3022 where X is the letter following %u. The function will be passed the
3023 current header as argument. The function should return a string, which
3024 will be inserted into the summary just like information from any other
3027 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3028 with care. For reasons of efficiency, Gnus will compute what column
3029 these characters will end up in, and \"hard-code\" that. This means that
3030 it is invalid to have these specs after a variable-length spec. Well,
3031 you might not be arrested, but your summary buffer will look strange,
3032 which is bad enough.
3034 The smart choice is to have these specs as far to the left as
3037 This restriction may disappear in later versions of Gnus.
3039 General format specifiers can also be used.
3040 See Info node `(gnus)Formatting Variables'."
3041 :link '(custom-manual "(gnus)Formatting Variables")
3043 :group 'gnus-summary-format)
3046 ;;; Skeleton keymaps
3049 (defun gnus-suppress-keymap (keymap)
3050 (suppress-keymap keymap)
3051 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
3053 (define-key keymap (pop keys) 'undefined))))
3055 (defvar gnus-article-mode-map
3056 (let ((keymap (make-sparse-keymap)))
3057 (gnus-suppress-keymap keymap)
3059 (defvar gnus-summary-mode-map
3060 (let ((keymap (make-keymap)))
3061 (gnus-suppress-keymap keymap)
3063 (defvar gnus-group-mode-map
3064 (let ((keymap (make-keymap)))
3065 (gnus-suppress-keymap keymap)
3070 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3071 ;; If you want the cursor to go somewhere else, set these two
3072 ;; functions in some startup hook to whatever you want.
3073 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3074 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3076 ;;; Various macros and substs.
3078 (defun gnus-header-from (header)
3079 (mail-header-from header))
3081 (defmacro gnus-gethash (string hashtable)
3082 "Get hash value of STRING in HASHTABLE."
3083 `(symbol-value (intern-soft ,string ,hashtable)))
3085 (defmacro gnus-gethash-safe (string hashtable)
3086 "Get hash value of STRING in HASHTABLE.
3087 Return nil if not defined."
3088 `(let ((sym (intern-soft ,string ,hashtable)))
3089 (and (boundp sym) (symbol-value sym))))
3091 (defmacro gnus-sethash (string value hashtable)
3092 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3093 `(set (intern ,string ,hashtable) ,value))
3094 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3096 (defmacro gnus-group-unread (group)
3097 "Get the currently computed number of unread articles in GROUP."
3098 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3100 (defmacro gnus-group-entry (group)
3101 "Get the newsrc entry for GROUP."
3102 `(gnus-gethash ,group gnus-newsrc-hashtb))
3104 (defmacro gnus-active (group)
3105 "Get active info on GROUP."
3106 `(gnus-gethash ,group gnus-active-hashtb))
3108 (defmacro gnus-set-active (group active)
3109 "Set GROUP's active info."
3110 `(gnus-sethash ,group ,active gnus-active-hashtb))
3112 ;; Info access macros.
3114 (defmacro gnus-info-group (info)
3116 (defmacro gnus-info-rank (info)
3118 (defmacro gnus-info-read (info)
3120 (defmacro gnus-info-marks (info)
3122 (defmacro gnus-info-method (info)
3124 (defmacro gnus-info-params (info)
3127 (defmacro gnus-info-level (info)
3128 `(let ((rank (gnus-info-rank ,info)))
3132 (defmacro gnus-info-score (info)
3133 `(let ((rank (gnus-info-rank ,info)))
3134 (or (and (consp rank) (cdr rank)) 0)))
3136 (defmacro gnus-info-set-group (info group)
3137 `(setcar ,info ,group))
3138 (defmacro gnus-info-set-rank (info rank)
3139 `(setcar (nthcdr 1 ,info) ,rank))
3140 (defmacro gnus-info-set-read (info read)
3141 `(setcar (nthcdr 2 ,info) ,read))
3142 (defmacro gnus-info-set-marks (info marks &optional extend)
3144 `(gnus-info-set-entry ,info ,marks 3)
3145 `(setcar (nthcdr 3 ,info) ,marks)))
3146 (defmacro gnus-info-set-method (info method &optional extend)
3148 `(gnus-info-set-entry ,info ,method 4)
3149 `(setcar (nthcdr 4 ,info) ,method)))
3150 (defmacro gnus-info-set-params (info params &optional extend)
3152 `(gnus-info-set-entry ,info ,params 5)
3153 `(setcar (nthcdr 5 ,info) ,params)))
3155 (defun gnus-info-set-entry (info entry number)
3156 ;; Extend the info until we have enough elements.
3157 (while (<= (length info) number)
3158 (nconc info (list nil)))
3160 (setcar (nthcdr number info) entry))
3162 (defmacro gnus-info-set-level (info level)
3163 `(let ((rank (cdr ,info)))
3164 (if (consp (car rank))
3165 (setcar (car rank) ,level)
3166 (setcar rank ,level))))
3167 (defmacro gnus-info-set-score (info score)
3168 `(let ((rank (cdr ,info)))
3169 (if (consp (car rank))
3170 (setcdr (car rank) ,score)
3171 (setcar rank (cons (car rank) ,score)))))
3173 (defmacro gnus-get-info (group)
3174 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3176 ;;; Load the compatibility functions.
3185 (defvar gnus-shutdown-alist nil)
3187 (defun gnus-add-shutdown (function &rest symbols)
3188 "Run FUNCTION whenever one of SYMBOLS is shut down."
3189 (push (cons function symbols) gnus-shutdown-alist))
3191 (defun gnus-shutdown (symbol)
3192 "Shut down everything that waits for SYMBOL."
3193 (dolist (entry gnus-shutdown-alist)
3194 (when (memq symbol (cdr entry))
3195 (funcall (car entry)))))
3199 ;;; Gnus Utility Functions
3202 (defun gnus-find-subscribed-addresses ()
3203 "Return a regexp matching the addresses of all subscribed mail groups.
3204 It consists of the `to-address' or `to-list' parameter of all groups
3205 with a `subscribed' parameter."
3206 (let (group address addresses)
3207 (dolist (entry (cdr gnus-newsrc-alist))
3208 (setq group (car entry))
3209 (when (gnus-parameter-subscribed group)
3210 (setq address (mail-strip-quoted-names
3211 (or (gnus-group-fast-parameter group 'to-address)
3212 (gnus-group-fast-parameter group 'to-list))))
3214 (add-to-list 'addresses address))))
3216 (list (mapconcat 'regexp-quote addresses "\\|")))))
3218 (defmacro gnus-string-or (&rest strings)
3219 "Return the first element of STRINGS that is a non-blank string.
3220 STRINGS will be evaluated in normal `or' order."
3221 `(gnus-string-or-1 ',strings))
3223 (defun gnus-string-or-1 (strings)
3226 (setq string (eval (pop strings)))
3227 (if (string-match "^[ \t]*$" string)
3229 (setq strings nil)))
3232 (defun gnus-info-find-node (&optional nodename)
3233 "Find Info documentation of Gnus."
3235 ;; Enlarge info window if needed.
3236 (let (gnus-info-buffer)
3239 (or gnus-info-filename
3240 (get-language-info current-language-environment 'gnus-info)
3243 (cadr (assq major-mode gnus-info-nodes))
3244 (and (eq (current-buffer) (get-buffer gnus-article-buffer))
3245 (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
3246 (setq gnus-info-buffer (current-buffer))
3247 (gnus-configure-windows 'info)))
3250 ;;; gnus-interactive
3253 (defvar gnus-current-prefix-symbol nil
3254 "Current prefix symbol.")
3256 (defvar gnus-current-prefix-symbols nil
3257 "List of current prefix symbols.")
3259 (defun gnus-interactive (string &optional params)
3260 "Return a list that can be fed to `interactive'.
3261 See `interactive' for full documentation.
3263 Adds the following specs:
3265 y -- The current symbolic prefix.
3266 Y -- A list of the current symbolic prefix(es).
3267 A -- Article number.
3268 H -- Article header.
3272 (while (< i (length string))
3273 (string-match ".\\([^\n]*\\)\n?" string i)
3274 (setq c (aref string i))
3276 (setq prompt (match-string 1 string)))
3277 (setq i (match-end 0))
3278 ;; We basically emulate just about everything that
3279 ;; `interactive' does, but add the specs listed above.
3283 (completing-read prompt obarray 'fboundp t))
3285 (read-buffer prompt (current-buffer) t))
3287 (read-buffer prompt (other-buffer (current-buffer))))
3291 (completing-read prompt obarray 'commandp t))
3295 (read-file-name prompt nil default-directory 'lambda))
3297 (read-file-name prompt nil nil 'lambda))
3299 (read-file-name prompt))
3301 (read-key-sequence prompt))
3303 (error "Not implemented spec"))
3305 (error "Not implemented spec"))
3309 (error "Not implemented spec"))
3311 (string-to-number (read-from-minibuffer prompt)))
3313 (prefix-numeric-value current-prefix-arg))
3319 (read-string prompt))
3321 (intern (read-string prompt)))
3323 (read-variable prompt))
3325 (read-minibuffer prompt))
3327 (eval-minibuffer prompt))
3328 ;; And here the new specs come.
3330 gnus-current-prefix-symbol)
3332 gnus-current-prefix-symbols)
3334 (gnus-group-group-name))
3336 (gnus-summary-skip-intangible)
3337 (or (get-text-property (point) 'gnus-number)
3338 (gnus-summary-last-subject)))
3340 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3342 (error "Non-implemented spec")))
3346 (push (if (< (point) (mark)) (point) (mark)) out)
3347 (push (if (> (point) (mark)) (point) (mark)) out))))
3348 (setq out (delq 'gnus-prefix-nil out))
3351 (defun gnus-symbolic-argument (&optional arg)
3352 "Read a symbolic argument and a command, and then execute command."
3354 (let* ((in-command (this-command-keys))
3355 (command in-command)
3356 gnus-current-prefix-symbols
3357 gnus-current-prefix-symbol
3359 (while (equal in-command command)
3360 (message "%s-" (key-description (this-command-keys)))
3361 (push (intern (char-to-string (read-char))) syms)
3362 (setq command (read-key-sequence nil t)))
3363 (setq gnus-current-prefix-symbols (nreverse syms)
3364 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3365 (call-interactively (key-binding command t))))
3367 ;;; More various functions.
3369 (defsubst gnus-check-backend-function (func group)
3370 "Check whether GROUP supports function FUNC.
3371 GROUP can either be a string (a group name) or a select method."
3373 (let ((method (if (stringp group)
3374 (car (gnus-find-method-for-group group))
3376 (unless (featurep method)
3378 (fboundp (intern (format "%s-%s" method func))))))
3380 (defun gnus-group-read-only-p (&optional group)
3381 "Check whether GROUP supports editing or not.
3382 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3383 that that variable is buffer-local to the summary buffers."
3384 (let ((group (or group gnus-newsgroup-name)))
3385 (not (gnus-check-backend-function 'request-replace-article group))))
3387 (defun gnus-virtual-group-p (group)
3388 "Say whether GROUP is virtual or not."
3389 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3390 gnus-valid-select-methods)))
3392 (defun gnus-news-group-p (group &optional article)
3393 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3394 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3395 t) ;is news of course.
3396 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3397 nil) ;must be mail then.
3398 ((vectorp article) ;Has header info.
3399 (eq (gnus-request-type group (mail-header-id article)) 'news))
3400 ((null article) ;Hasn't header info
3401 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3402 ((< article 0) ;Virtual message
3403 nil) ;we don't know, guess mail.
3404 (t ;Has positive number
3405 (eq (gnus-request-type group article) 'news)))) ;use it.
3407 ;; Returns a list of writable groups.
3408 (defun gnus-writable-groups ()
3409 (let ((alist gnus-newsrc-alist)
3411 (while (setq group (car (pop alist)))
3412 (unless (gnus-group-read-only-p group)
3413 (push group groups)))
3416 ;; Check whether to use long file names.
3417 (defun gnus-use-long-file-name (symbol)
3418 ;; The variable has to be set...
3419 (and gnus-use-long-file-name
3420 ;; If it isn't a list, then we return t.
3421 (or (not (listp gnus-use-long-file-name))
3422 ;; If it is a list, and the list contains `symbol', we
3424 (not (memq symbol gnus-use-long-file-name)))))
3426 ;; Generate a unique new group name.
3427 (defun gnus-generate-new-group-name (leaf)
3430 (while (gnus-group-entry name)
3431 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3434 (defun gnus-ephemeral-group-p (group)
3435 "Say whether GROUP is ephemeral or not."
3436 (gnus-group-get-parameter group 'quit-config t))
3438 (defun gnus-group-quit-config (group)
3439 "Return the quit-config of GROUP."
3440 (gnus-group-get-parameter group 'quit-config t))
3442 (defun gnus-kill-ephemeral-group (group)
3443 "Remove ephemeral GROUP from relevant structures."
3444 (gnus-sethash group nil gnus-newsrc-hashtb))
3446 (defun gnus-simplify-mode-line ()
3447 "Make mode lines a bit simpler."
3448 (setq mode-line-modified (cdr gnus-mode-line-modified))
3449 (when (listp mode-line-format)
3450 (make-local-variable 'mode-line-format)
3451 (setq mode-line-format (copy-sequence mode-line-format))
3452 (when (equal (nth 3 mode-line-format) " ")
3453 (setcar (nthcdr 3 mode-line-format) " "))))
3455 ;;; Servers and groups.
3457 (defsubst gnus-server-add-address (method)
3458 (let ((method-name (symbol-name (car method))))
3459 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3460 (not (assq (intern (concat method-name "-address")) method))
3461 (memq 'physical-address (assq (car method)
3462 gnus-valid-select-methods)))
3463 (append method (list (list (intern (concat method-name "-address"))
3467 (defsubst gnus-method-to-server (method)
3469 (setq method (or method gnus-select-method))
3471 ;; Perhaps it is already in the cache.
3472 (mapc (lambda (name-method)
3473 (if (equal (cdr name-method) method)
3474 (throw 'server-name (car name-method))))
3475 gnus-server-method-cache)
3478 (lambda (server-alist)
3479 (mapc (lambda (name-method)
3480 (when (gnus-methods-equal-p (cdr name-method) method)
3481 (unless (member name-method gnus-server-method-cache)
3482 (push name-method gnus-server-method-cache))
3483 (throw 'server-name (car name-method))))
3485 (let ((alists (list gnus-server-alist
3486 gnus-predefined-server-alist)))
3487 (if gnus-select-method
3488 (push (list (cons "native" gnus-select-method)) alists))
3491 (let* ((name (if (member (cadr method) '(nil ""))
3492 (format "%s" (car method))
3493 (format "%s:%s" (car method) (cadr method))))
3494 (name-method (cons name method)))
3495 (unless (member name-method gnus-server-method-cache)
3496 (push name-method gnus-server-method-cache))
3499 (defsubst gnus-server-to-method (server)
3500 "Map virtual server names to select methods."
3501 (or (and server (listp server) server)
3502 (cdr (assoc server gnus-server-method-cache))
3505 ;; Perhaps this is the native server?
3506 (and (equal server "native") gnus-select-method)
3507 ;; It should be in the server alist.
3508 (cdr (assoc server gnus-server-alist))
3509 ;; It could be in the predefined server alist.
3510 (cdr (assoc server gnus-predefined-server-alist))
3511 ;; If not, we look through all the opened server
3512 ;; to see whether we can find it there.
3513 (let ((opened gnus-opened-servers))
3515 (not (equal server (format "%s:%s" (caaar opened)
3519 ;; It could be a named method, search all servers
3520 (let ((servers gnus-secondary-select-methods))
3522 (not (equal server (format "%s:%s" (caar servers)
3526 ;; This could be some sort of foreign server that I
3527 ;; simply haven't opened (yet). Do a brute-force scan
3528 ;; of the entire gnus-newsrc-alist for the server name
3529 ;; of every method. As a side-effect, loads the
3530 ;; gnus-server-method-cache so this only happens once,
3535 (let ((info-method (gnus-info-method info)))
3536 (unless (stringp info-method)
3537 (let ((info-server (gnus-method-to-server info-method)))
3538 (when (equal server info-server)
3539 (setq match info-method))))))
3540 (cdr gnus-newsrc-alist))
3543 (push (cons server result) gnus-server-method-cache))
3546 (defsubst gnus-server-get-method (group method)
3547 ;; Input either a server name, and extended server name, or a
3548 ;; select method, and return a select method.
3549 (cond ((stringp method)
3550 (gnus-server-to-method method))
3551 ((equal method gnus-select-method)
3553 ((and (stringp (car method))
3555 (gnus-server-extend-method group method))
3558 (equal (cadr method) ""))
3561 (gnus-server-add-address method))))
3563 (defmacro gnus-method-equal (ss1 ss2)
3564 "Say whether two servers are equal."
3568 (and (= (length s1) (length s2))
3570 (while (and s1 (member (car s1) s2))
3574 (defun gnus-methods-equal-p (m1 m2)
3575 (let ((m1 (or m1 gnus-select-method))
3576 (m2 (or m2 gnus-select-method)))
3578 (and (eq (car m1) (car m2))
3579 (or (not (memq 'address (assoc (symbol-name (car m1))
3580 gnus-valid-select-methods)))
3581 (equal (nth 1 m1) (nth 1 m2)))))))
3583 (defun gnus-server-equal (m1 m2)
3584 "Say whether two methods are equal."
3585 (let ((m1 (cond ((null m1) gnus-select-method)
3586 ((stringp m1) (gnus-server-to-method m1))
3588 (m2 (cond ((null m2) gnus-select-method)
3589 ((stringp m2) (gnus-server-to-method m2))
3591 (gnus-method-equal m1 m2)))
3593 (defun gnus-servers-using-backend (backend)
3594 "Return a list of known servers using BACKEND."
3595 (let ((opened gnus-opened-servers)
3598 (when (eq backend (caaar opened))
3599 (push (caar opened) out))
3603 (defun gnus-archive-server-wanted-p ()
3604 "Say whether the user wants to use the archive server."
3606 ((or (not gnus-message-archive-method)
3607 (not gnus-message-archive-group))
3609 ((and gnus-message-archive-method gnus-message-archive-group)
3612 (let ((active (cadr (assq 'nnfolder-active-file
3613 gnus-message-archive-method))))
3615 (file-exists-p active))))))
3617 (defsubst gnus-method-to-server-name (method)
3619 (format "%s" (car method))
3621 (or (assoc (format "%s" (car method))
3622 (gnus-methods-using 'address))
3623 (gnus-server-equal method gnus-message-archive-method))
3625 (not (string= (nth 1 method) "")))
3626 (concat "+" (nth 1 method)))))
3628 (defsubst gnus-method-to-full-server-name (method)
3629 (format "%s+%s" (car method) (nth 1 method)))
3631 (defun gnus-group-prefixed-name (group method &optional full)
3632 "Return the whole name from GROUP and METHOD.
3633 Call with full set to get the fully qualified group name (even if the
3635 (when (stringp method)
3636 (setq method (gnus-server-to-method method)))
3637 (if (or (not method)
3638 (and (not full) (gnus-server-equal method "native"))
3639 ;;;!!! This might not be right. We'll see...
3640 ;(string-match ":" group)
3643 (concat (gnus-method-to-server-name method) ":" group)))
3645 (defun gnus-group-guess-prefixed-name (group)
3646 "Guess the whole name from GROUP and METHOD."
3647 (gnus-group-prefixed-name group (gnus-find-method-for-group
3650 (defun gnus-group-full-name (group method)
3651 "Return the full name from GROUP and METHOD, even if the method is native."
3652 (gnus-group-prefixed-name group method t))
3654 (defun gnus-group-guess-full-name (group)
3655 "Guess the full name from GROUP, even if the method is native."
3656 (if (gnus-group-prefixed-p group)
3658 (gnus-group-full-name group (gnus-find-method-for-group group))))
3660 (defun gnus-group-guess-full-name-from-command-method (group)
3661 "Guess the full name from GROUP, even if the method is native."
3662 (if (gnus-group-prefixed-p group)
3664 (gnus-group-full-name group gnus-command-method)))
3666 (defun gnus-group-real-prefix (group)
3667 "Return the prefix of the current group name."
3669 (if (string-match "^[^:]+:" group)
3670 (substring group 0 (match-end 0))
3674 (defun gnus-group-short-name (group)
3675 "Return the short group name."
3676 (let ((prefix (gnus-group-real-prefix group)))
3677 (if (< 0 (length prefix))
3678 (substring group (length prefix) nil)
3681 (defun gnus-group-prefixed-p (group)
3682 "Return the prefix of the current group name."
3683 (< 0 (length (gnus-group-real-prefix group))))
3685 (defun gnus-summary-buffer-name (group)
3686 "Return the summary buffer name of GROUP."
3687 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3689 (defun gnus-group-method (group)
3690 "Return the server or method used for selecting GROUP.
3691 You should probably use `gnus-find-method-for-group' instead."
3692 (let ((prefix (gnus-group-real-prefix group)))
3693 (if (equal prefix "")
3695 (let ((servers gnus-opened-servers)
3697 backend possible found)
3698 (if (string-match "^[^\\+]+\\+" prefix)
3699 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3700 server (substring prefix (match-end 0) (1- (length prefix))))
3701 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3703 (when (eq (caaar servers) backend)
3704 (setq possible (caar servers))
3705 (when (equal (cadaar servers) server)
3706 (setq found (caar servers))))
3708 (or (car (rassoc found gnus-server-alist))
3710 (car (rassoc possible gnus-server-alist))
3712 (list backend server))))))
3714 (defsubst gnus-native-method-p (method)
3715 "Return whether METHOD is the native select method."
3716 (gnus-method-equal method gnus-select-method))
3718 (defsubst gnus-secondary-method-p (method)
3719 "Return whether METHOD is a secondary select method."
3720 (let ((methods gnus-secondary-select-methods)
3721 (gmethod (inline (gnus-server-get-method nil method))))
3723 (not (gnus-method-equal
3724 (inline (gnus-server-get-method nil (car methods)))
3726 (setq methods (cdr methods)))
3729 (defun gnus-method-simplify (method)
3730 "Return the shortest uniquely identifying string or method for METHOD."
3731 (cond ((stringp method)
3733 ((gnus-native-method-p method)
3735 ((gnus-secondary-method-p method)
3736 (format "%s:%s" (nth 0 method) (nth 1 method)))
3740 (defun gnus-groups-from-server (server)
3741 "Return a list of all groups that are fetched from SERVER."
3742 (let ((alist (cdr gnus-newsrc-alist))
3744 (while (setq info (pop alist))
3745 (when (gnus-server-equal (gnus-info-method info) server)
3746 (push (gnus-info-group info) groups)))
3747 (sort groups 'string<)))
3749 (defun gnus-group-foreign-p (group)
3750 "Say whether a group is foreign or not."
3751 (and (not (gnus-group-native-p group))
3752 (not (gnus-group-secondary-p group))))
3754 (defun gnus-group-native-p (group)
3755 "Say whether the group is native or not."
3756 (not (string-match ":" group)))
3758 (defun gnus-group-secondary-p (group)
3759 "Say whether the group is secondary or not."
3760 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3762 (defun gnus-parameters-get-parameter (group)
3763 "Return the group parameters for GROUP from `gnus-parameters'."
3765 (dolist (elem gnus-parameters)
3766 (when (string-match (car elem) group)
3768 (nconc (gnus-expand-group-parameters
3769 (car elem) (cdr elem) group)
3773 (defun gnus-expand-group-parameter (match value group)
3774 "Use MATCH to expand VALUE in GROUP."
3777 (goto-char (point-min))
3778 (while (re-search-forward match nil t)
3779 (replace-match value))
3782 (defun gnus-expand-group-parameters (match parameters group)
3783 "Go through PARAMETERS and expand them according to the match data."
3785 (dolist (elem parameters)
3786 (if (and (stringp (cdr elem))
3787 (string-match "\\\\[0-9&]" (cdr elem)))
3788 (push (cons (car elem)
3789 (gnus-expand-group-parameter match (cdr elem) group))
3794 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3795 "For GROUP, return the value of SYMBOL.
3797 You should call this in the `gnus-group-buffer' buffer.
3798 The function `gnus-group-find-parameter' will do that for you."
3799 ;; The speed trick: No cons'ing and quit early.
3800 (let* ((params (funcall gnus-group-get-parameter-function group))
3801 ;; Start easy, check the "real" group parameters.
3803 (gnus-group-parameter-value params symbol allow-list t)))
3805 ;; Found results; return them.
3806 (car simple-results)
3807 ;; We didn't found it there, try `gnus-parameters'.
3810 (tail gnus-parameters))
3811 ;; A good old-fashioned non-cl loop.
3813 (setq head (car tail)
3815 ;; The car is regexp matching for matching the group name.
3816 (when (string-match (car head) group)
3817 ;; The cdr is the parameters.
3818 (setq result (gnus-group-parameter-value (cdr head)
3821 ;; Expand if necessary.
3822 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3823 (setq result (gnus-expand-group-parameter (car head)
3825 ;; Exit the loop early.
3830 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3831 "Return the group parameters for GROUP.
3832 If SYMBOL, return the value of that symbol in the group parameters.
3834 If you call this function inside a loop, consider using the faster
3835 `gnus-group-fast-parameter' instead."
3837 (set-buffer gnus-group-buffer)
3839 (gnus-group-fast-parameter group symbol allow-list)
3842 (funcall gnus-group-get-parameter-function group))
3843 (gnus-parameters-get-parameter group)))))
3845 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3846 "Return the group parameters for GROUP.
3847 If SYMBOL, return the value of that symbol in the group parameters.
3848 Most functions should use `gnus-group-find-parameter', which
3849 also examines the topic parameters."
3850 (let ((params (gnus-info-params (gnus-get-info group))))
3852 (gnus-group-parameter-value params symbol allow-list)
3855 (defun gnus-group-parameter-value (params symbol &optional
3856 allow-list present-p)
3857 "Return the value of SYMBOL in group PARAMS."
3858 ;; We only wish to return group parameters (dotted lists) and
3859 ;; not local variables, which may have the same names.
3860 ;; But first we handle single elements...
3861 (or (car (memq symbol params))
3865 (while (setq elem (pop params))
3866 (when (and (consp elem)
3867 (eq (car elem) symbol)
3870 (throw 'found (if present-p (list (cdr elem))
3873 (defun gnus-group-add-parameter (group param)
3874 "Add parameter PARAM to GROUP."
3875 (let ((info (gnus-get-info group)))
3877 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3878 ;; Cons the new param to the old one and update.
3879 (gnus-group-set-info (cons param (gnus-info-params info))
3882 (defun gnus-group-set-parameter (group name value)
3883 "Set parameter NAME to VALUE in GROUP."
3884 (let ((info (gnus-get-info group)))
3886 (gnus-group-remove-parameter group name)
3887 (let ((old-params (gnus-info-params info))
3888 (new-params (list (cons name value))))
3890 (when (or (not (listp (car old-params)))
3891 (not (eq (caar old-params) name)))
3892 (setq new-params (append new-params (list (car old-params)))))
3893 (setq old-params (cdr old-params)))
3894 (gnus-group-set-info new-params group 'params)))))
3896 (defun gnus-group-remove-parameter (group name)
3897 "Remove parameter NAME from GROUP."
3898 (let ((info (gnus-get-info group)))
3900 (let ((params (gnus-info-params info)))
3902 (setq params (delq name params))
3903 (while (assq name params)
3904 (gnus-pull name params))
3905 (gnus-info-set-params info params))))))
3907 (defun gnus-group-add-score (group &optional score)
3908 "Add SCORE to the GROUP score.
3909 If SCORE is nil, add 1 to the score of GROUP."
3910 (let ((info (gnus-get-info group)))
3912 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3914 (defun gnus-short-group-name (group &optional levels)
3915 "Collapse GROUP name LEVELS.
3916 Select methods are stripped and any remote host name is stripped down to
3917 just the host name."
3923 gnus-group-uncollapsed-levels
3925 (while (string-match "\\." group skip)
3926 (setq skip (match-end 0)
3929 ;; Separate foreign select method from group name and collapse.
3930 ;; If method contains a server, collapse to non-domain server name,
3931 ;; otherwise collapse to select method.
3932 (let* ((colon (string-match ":" group))
3933 (server (and colon (substring group 0 colon)))
3934 (plus (and server (string-match "+" server))))
3937 (setq foreign (substring server (+ 1 plus)
3938 (string-match "\\." server))
3939 group (substring group (+ 1 colon)))
3940 (setq foreign server
3941 group (substring group (+ 1 colon))))
3942 (setq foreign (concat foreign ":")))
3943 ;; Collapse group name leaving LEVELS uncollapsed elements
3944 (let* ((slist (split-string group "/"))
3945 (slen (length slist))
3946 (dlist (split-string group "\\."))
3947 (dlen (length dlist))
3959 (setq levels (- glen levels))
3961 (push (if (>= (decf levels) 0)
3962 (if (zerop (length g))
3967 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3969 (defun gnus-narrow-to-body ()
3970 "Narrow to the body of an article."
3973 (goto-char (point-min))
3974 (or (search-forward "\n\n" nil t)
3980 ;;; Kill file handling.
3983 (defun gnus-apply-kill-file ()
3984 "Apply a kill file to the current newsgroup.
3985 Returns the number of articles marked as read."
3986 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3987 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3988 (gnus-apply-kill-file-internal)
3991 (defun gnus-kill-save-kill-buffer ()
3992 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3993 (when (get-file-buffer file)
3995 (set-buffer (get-file-buffer file))
3996 (when (buffer-modified-p)
3998 (kill-buffer (current-buffer))))))
4000 (defcustom gnus-kill-file-name "KILL"
4001 "Suffix of the kill files."
4002 :group 'gnus-score-kill
4003 :group 'gnus-score-files
4006 (defun gnus-newsgroup-kill-file (newsgroup)
4007 "Return the name of a kill file name for NEWSGROUP.
4008 If NEWSGROUP is nil, return the global kill file name instead."
4010 ;; The global KILL file is placed at top of the directory.
4011 ((or (null newsgroup)
4012 (string-equal newsgroup ""))
4013 (expand-file-name gnus-kill-file-name
4014 gnus-kill-files-directory))
4015 ;; Append ".KILL" to newsgroup name.
4016 ((gnus-use-long-file-name 'not-kill)
4017 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4018 "." gnus-kill-file-name)
4019 gnus-kill-files-directory))
4020 ;; Place "KILL" under the hierarchical directory.
4022 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4023 "/" gnus-kill-file-name)
4024 gnus-kill-files-directory))))
4028 (defun gnus-member-of-valid (symbol group)
4029 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
4031 (symbol-name (car (gnus-find-method-for-group group)))
4032 gnus-valid-select-methods)))
4034 (defun gnus-method-option-p (method option)
4035 "Return non-nil if select METHOD has OPTION as a parameter."
4036 (when (stringp method)
4037 (setq method (gnus-server-to-method method)))
4038 (memq option (assoc (format "%s" (car method))
4039 gnus-valid-select-methods)))
4041 (defun gnus-similar-server-opened (method)
4042 (let ((opened gnus-opened-servers))
4043 (while (and method opened)
4044 (when (and (equal (cadr method) (cadaar opened))
4045 (equal (car method) (caaar opened))
4046 (not (equal method (caar opened))))
4051 (defun gnus-server-extend-method (group method)
4052 ;; This function "extends" a virtual server. If the server is
4053 ;; "hello", and the select method is ("hello" (my-var "something"))
4054 ;; in the group "alt.alt", this will result in a new virtual server
4055 ;; called "hello+alt.alt".
4056 (if (or (not (inline (gnus-similar-server-opened method)))
4057 (not (cddr method)))
4059 `(,(car method) ,(concat (cadr method) "+" group)
4060 (,(intern (format "%s-address" (car method))) ,(cadr method))
4063 (defun gnus-server-status (method)
4064 "Return the status of METHOD."
4065 (nth 1 (assoc method gnus-opened-servers)))
4067 (defun gnus-group-name-to-method (group)
4068 "Guess a select method based on GROUP."
4069 (if (string-match ":" group)
4070 (let ((server (substring group 0 (match-beginning 0))))
4071 (if (string-match "\\+" server)
4072 (list (intern (substring server 0 (match-beginning 0)))
4073 (substring server (match-end 0)))
4074 (list (intern server) "")))
4075 gnus-select-method))
4077 (defun gnus-server-string (server)
4078 "Return a readable string that describes SERVER."
4079 (let* ((server (gnus-server-to-method server))
4080 (address (nth 1 server)))
4082 (not (zerop (length address))))
4083 (format "%s using %s" address (car server))
4084 (format "%s" (car server)))))
4086 (defun gnus-find-method-for-group (group &optional info)
4087 "Find the select method that GROUP uses."
4088 (or gnus-override-method
4091 (and (not (gnus-group-entry group));; a new group
4092 (gnus-group-name-to-method group))
4093 (let ((info (or info (gnus-get-info group)))
4096 (not (setq method (gnus-info-method info)))
4097 (equal method "native"))
4100 (cond ((stringp method)
4101 (inline (gnus-server-to-method method)))
4102 ((stringp (cadr method))
4103 (inline (gnus-server-extend-method group method)))
4106 (cond ((equal (cadr method) "")
4108 ((null (cadr method))
4109 (list (car method) ""))
4111 (gnus-server-add-address method)))))))
4113 (defun gnus-methods-using (feature)
4114 "Find all methods that have FEATURE."
4115 (let ((valids gnus-valid-select-methods)
4118 (when (memq feature (car valids))
4119 (push (car valids) outs))
4120 (setq valids (cdr valids)))
4124 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4126 (defun gnus-read-group (prompt &optional default)
4127 "Prompt the user for a group name.
4128 Disallow invalid group names."
4133 gnus-invalid-group-regexp
4134 (setq group (read-string (concat prefix prompt)
4135 (cons (or default "") 0)
4136 'gnus-group-history)))
4137 (let ((match (match-string 0 group)))
4138 ;; Might be okay (e.g. for nnimap), so ask the user:
4139 (unless (and (not (string-match "^$\\|:" match))
4141 "Proceed and create group anyway? " t
4142 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4144 Usually, it's dangerous to create a group with this name, because it's not
4145 supported by all back ends and servers. On IMAP servers it should work,
4146 though. If you are really sure, you can proceed anyway and create the group.
4148 You may customize the variable `gnus-invalid-group-regexp', which currently is
4149 set to \"" gnus-invalid-group-regexp
4150 "\", if you want to get rid of this query permanently."))
4151 (setq prefix (format "Invalid group name: \"%s\". " group)
4155 (defun gnus-read-method (prompt)
4156 "Prompt the user for a method.
4157 Allow completion over sensible values."
4158 (let* ((open-servers
4159 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4160 gnus-opened-servers))
4163 (dolist (method gnus-valid-select-methods)
4164 (if (or (memq 'prompt-address method)
4165 (not (assoc (format "%s:" (car method)) open-servers)))
4166 (push method methods)))
4169 (append valid-methods
4171 gnus-predefined-server-alist
4176 nil t nil 'gnus-method-history)))
4179 (setq method gnus-select-method))
4180 ((assoc method gnus-valid-select-methods)
4181 (let ((address (if (memq 'prompt-address
4182 (assoc method gnus-valid-select-methods))
4183 (read-string "Address: ")
4185 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4186 (list (intern method) address))))
4187 ((assoc method servers)
4190 (list (intern method) "")))))
4194 (defun gnus-agent-method-p (method)
4195 "Say whether METHOD is covered by the agent."
4196 (or (eq (car gnus-agent-method-p-cache) method)
4197 (setq gnus-agent-method-p-cache
4199 (member (if (stringp method)
4201 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4202 (cdr gnus-agent-method-p-cache))
4204 (defun gnus-online (method)
4207 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4208 (gnus-agent-method-p method))))
4210 ;;; User-level commands.
4213 (defun gnus-slave-no-server (&optional arg)
4214 "Read network news as a slave, without connecting to the local server."
4216 (gnus-no-server arg t))
4219 (defun gnus-no-server (&optional arg slave)
4221 If ARG is a positive number, Gnus will use that as the startup
4222 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4223 non-nil and not a positive number, Gnus will prompt the user for the
4224 name of an NNTP server to use.
4225 As opposed to `gnus', this command will not connect to the local
4228 (gnus-no-server-1 arg slave))
4231 (defun gnus-slave (&optional arg)
4232 "Read news as a slave."
4234 (gnus arg nil 'slave))
4236 (defcustom gnus-frame-properties nil
4237 "The properties of the frame in which gnus is displayed. Under XEmacs,
4238 the variable `toolbar-news-frame-plist' will be refered instead."
4239 :type '(repeat (cons :format "%v"
4240 (symbol :tag "Parameter")
4241 (sexp :tag "Value")))
4245 (defun gnus-other-frame (&optional arg display)
4246 "Pop up a frame to read news.
4247 This will call one of the Gnus commands which is specified by the user
4248 option `gnus-other-frame-function' (default `gnus') with the argument
4249 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4250 optional second argument DISPLAY should be a standard display string
4251 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4252 omitted or the function `make-frame-on-display' is not available, the
4253 current display is used."
4255 (if (fboundp 'make-frame-on-display)
4257 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4259 (let ((alive (gnus-alive-p)))
4264 (when (and (or (not display)
4266 (gnus-frame-or-window-display-name
4268 (with-current-buffer (window-buffer window)
4269 (string-match "\\`gnus-"
4270 (symbol-name major-mode))))
4271 (gnus-select-frame-set-input-focus
4272 (setq gnus-other-frame-object (window-frame window)))
4273 (select-window window)
4276 (gnus-select-frame-set-input-focus
4277 (setq gnus-other-frame-object
4279 (make-frame-on-display display gnus-other-frame-parameters)
4280 (make-frame gnus-other-frame-parameters))))
4282 (switch-to-buffer gnus-group-buffer)
4283 (funcall gnus-other-frame-function arg)
4284 (add-hook 'gnus-exit-gnus-hook
4286 (when (and (frame-live-p gnus-other-frame-object)
4288 (delete-frame gnus-other-frame-object))
4289 (setq gnus-other-frame-object nil)))))))
4292 (defun gnus (&optional arg dont-connect slave)
4294 If ARG is non-nil and a positive number, Gnus will use that as the
4295 startup level. If ARG is non-nil and not a positive number, Gnus will
4296 prompt the user for the name of an NNTP server to use."
4298 (unless (byte-code-function-p (symbol-function 'gnus))
4299 (message "You should byte-compile Gnus")
4301 (gnus-1 arg dont-connect slave))
4303 ;; Allow redefinition of Gnus functions.
4307 (product-provide (provide 'gnus) 'gnus-vers)
4309 ;;; gnus.el ends here