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 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
31 (eval '(run-hooks 'gnus-load-hook))
33 (eval-when-compile (require 'cl))
39 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
43 (defgroup gnus-format nil
44 "Dealing with formatting issues."
47 (defgroup gnus-charset nil
48 "Group character set issues."
49 :link '(custom-manual "(gnus)Charsets")
53 (defgroup gnus-cache nil
55 :link '(custom-manual "(gnus)Article Caching")
58 (defgroup gnus-registry nil
62 (defgroup gnus-start nil
63 "Starting your favorite newsreader."
66 (defgroup gnus-start-server nil
67 "Server options at startup."
70 ;; These belong to gnus-group.el.
71 (defgroup gnus-group nil
73 :link '(custom-manual "(gnus)The Group Buffer")
76 (defgroup gnus-group-foreign nil
78 :link '(custom-manual "(gnus)Foreign Groups")
81 (defgroup gnus-group-new nil
82 "Automatic subscription of new groups."
85 (defgroup gnus-group-levels nil
87 :link '(custom-manual "(gnus)Group Levels")
90 (defgroup gnus-group-select nil
92 :link '(custom-manual "(gnus)Selecting a Group")
95 (defgroup gnus-group-listing nil
96 "Showing slices of the group list."
97 :link '(custom-manual "(gnus)Listing Groups")
100 (defgroup gnus-group-visual nil
101 "Sorting the group buffer."
102 :link '(custom-manual "(gnus)Group Buffer Format")
106 (defgroup gnus-group-various nil
107 "Various group options."
108 :link '(custom-manual "(gnus)Scanning New Messages")
111 ;; These belong to gnus-sum.el.
112 (defgroup gnus-summary nil
114 :link '(custom-manual "(gnus)The Summary Buffer")
117 (defgroup gnus-summary-exit nil
118 "Leaving summary buffers."
119 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
120 :group 'gnus-summary)
122 (defgroup gnus-summary-marks nil
123 "Marks used in summary buffers."
124 :link '(custom-manual "(gnus)Marking Articles")
125 :group 'gnus-summary)
127 (defgroup gnus-thread nil
128 "Ordering articles according to replies."
129 :link '(custom-manual "(gnus)Threading")
130 :group 'gnus-summary)
132 (defgroup gnus-summary-format nil
133 "Formatting of the summary buffer."
134 :link '(custom-manual "(gnus)Summary Buffer Format")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-choose nil
139 :link '(custom-manual "(gnus)Choosing Articles")
140 :group 'gnus-summary)
142 (defgroup gnus-summary-maneuvering nil
143 "Summary movement commands."
144 :link '(custom-manual "(gnus)Summary Maneuvering")
145 :group 'gnus-summary)
147 (defgroup gnus-picon nil
148 "Show pictures of people, domains, and newsgroups."
151 (defgroup gnus-summary-mail nil
152 "Mail group commands."
153 :link '(custom-manual "(gnus)Mail Group Commands")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-sort nil
157 "Sorting the summary buffer."
158 :link '(custom-manual "(gnus)Sorting")
159 :group 'gnus-summary)
161 (defgroup gnus-summary-visual nil
162 "Highlighting and menus in the summary buffer."
163 :link '(custom-manual "(gnus)Summary Highlighting")
165 :group 'gnus-summary)
167 (defgroup gnus-summary-various nil
168 "Various summary buffer options."
169 :link '(custom-manual "(gnus)Various Summary Stuff")
170 :group 'gnus-summary)
172 (defgroup gnus-summary-pick nil
173 "Pick mode in the summary buffer."
174 :link '(custom-manual "(gnus)Pick and Read")
176 :group 'gnus-summary)
178 (defgroup gnus-summary-tree nil
179 "Tree display of threads in the summary buffer."
180 :link '(custom-manual "(gnus)Tree Display")
182 :group 'gnus-summary)
184 ;; Belongs to gnus-uu.el
185 (defgroup gnus-extract-view nil
186 "Viewing extracted files."
187 :link '(custom-manual "(gnus)Viewing Files")
188 :group 'gnus-extract)
190 ;; Belongs to gnus-score.el
191 (defgroup gnus-score nil
192 "Score and kill file handling."
195 (defgroup gnus-score-kill nil
199 (defgroup gnus-score-adapt nil
200 "Adaptive score files."
203 (defgroup gnus-score-default nil
204 "Default values for score files."
207 (defgroup gnus-score-expire nil
208 "Expiring score rules."
211 (defgroup gnus-score-decay nil
212 "Decaying score rules."
215 (defgroup gnus-score-files nil
216 "Score and kill file names."
220 (defgroup gnus-score-various nil
221 "Various scoring and killing options."
225 (defgroup gnus-visual nil
226 "Options controlling the visual fluff."
230 (defgroup gnus-agent nil
231 "Offline support for Gnus."
234 (defgroup gnus-files nil
235 "Files used by Gnus."
238 (defgroup gnus-dribble-file nil
240 :link '(custom-manual "(gnus)Auto Save")
243 (defgroup gnus-newsrc nil
244 "Storing Gnus state."
247 (defgroup gnus-server nil
248 "Options related to newsservers and other servers used by Gnus."
251 (defgroup gnus-server-visual nil
252 "Highlighting and menus in the server buffer."
256 (defgroup gnus-message '((message custom-group))
257 "Composing replies and followups in Gnus."
260 (defgroup gnus-meta nil
261 "Meta variables controlling major portions of Gnus.
262 In general, modifying these variables does not take affect until Gnus
263 is restarted, and sometimes reloaded."
266 (defgroup gnus-various nil
267 "Other Gnus options."
268 :link '(custom-manual "(gnus)Various Various")
271 (defgroup gnus-mime nil
272 "Variables for controlling the Gnus MIME interface."
275 (defgroup gnus-exit nil
277 :link '(custom-manual "(gnus)Exiting Gnus")
280 (defgroup gnus-fun nil
281 "Frivolous Gnus extensions."
282 :link '(custom-manual "(gnus)Exiting Gnus")
285 (defconst gnus-version-number "5.10.3"
286 "Version number for this version of Gnus.")
288 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
289 "Version string for this version of Gnus.")
291 (defcustom gnus-inhibit-startup-message nil
292 "If non-nil, the startup message will not be displayed.
293 This variable is used before `.gnus.el' is loaded, so it should
294 be set in `.emacs' instead."
298 (defcustom gnus-play-startup-jingle nil
299 "If non-nil, play the Gnus jingle at startup."
303 (unless (fboundp 'gnus-group-remove-excess-properties)
304 (defalias 'gnus-group-remove-excess-properties 'ignore))
306 (unless (fboundp 'gnus-set-text-properties)
307 (defalias 'gnus-set-text-properties 'set-text-properties))
309 (unless (featurep 'gnus-xmas)
310 (defalias 'gnus-make-overlay 'make-overlay)
311 (defalias 'gnus-delete-overlay 'delete-overlay)
312 (defalias 'gnus-overlay-put 'overlay-put)
313 (defalias 'gnus-move-overlay 'move-overlay)
314 (defalias 'gnus-overlay-buffer 'overlay-buffer)
315 (defalias 'gnus-overlay-start 'overlay-start)
316 (defalias 'gnus-overlay-end 'overlay-end)
317 (defalias 'gnus-extent-detached-p 'ignore)
318 (defalias 'gnus-extent-start-open 'ignore)
319 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
320 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
321 (defalias 'gnus-character-to-event 'identity)
322 (defalias 'gnus-assq-delete-all 'assq-delete-all)
323 (defalias 'gnus-add-text-properties 'add-text-properties)
324 (defalias 'gnus-put-text-property 'put-text-property)
325 (defvar gnus-mode-line-image-cache t)
326 (if (fboundp 'find-image)
327 (defun gnus-mode-line-buffer-identification (line)
328 (let ((str (car-safe line)))
329 (if (and (stringp str)
330 (string-match "^Gnus:" str))
331 (progn (add-text-properties
334 (if (eq t gnus-mode-line-image-cache)
335 (setq gnus-mode-line-image-cache
337 '((:type xpm :file "gnus-pointer.xpm"
339 (:type xbm :file "gnus-pointer.xbm"
341 gnus-mode-line-image-cache)
342 'help-echo "This is Gnus")
346 (defalias 'gnus-mode-line-buffer-identification 'identity))
347 (defalias 'gnus-characterp 'numberp)
348 (defalias 'gnus-deactivate-mark 'deactivate-mark)
349 (defalias 'gnus-window-edges 'window-edges)
350 (defalias 'gnus-key-press-event-p 'numberp)
351 ;;(defalias 'gnus-decode-rfc1522 'ignore)
354 ;; We define these group faces here to avoid the display
355 ;; update forced when creating new faces.
357 (defface gnus-group-news-1-face
360 (:foreground "PaleTurquoise" :bold t))
363 (:foreground "ForestGreen" :bold t))
366 "Level 1 newsgroup face.")
368 (defface gnus-group-news-1-empty-face
371 (:foreground "PaleTurquoise"))
374 (:foreground "ForestGreen"))
377 "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.")
390 (defface gnus-group-news-2-empty-face
393 (:foreground "turquoise"))
396 (:foreground "CadetBlue4"))
399 "Level 2 empty newsgroup face.")
401 (defface gnus-group-news-3-face
410 "Level 3 newsgroup face.")
412 (defface gnus-group-news-3-empty-face
421 "Level 3 empty newsgroup face.")
423 (defface gnus-group-news-4-face
432 "Level 4 newsgroup face.")
434 (defface gnus-group-news-4-empty-face
443 "Level 4 empty newsgroup face.")
445 (defface gnus-group-news-5-face
454 "Level 5 newsgroup face.")
456 (defface gnus-group-news-5-empty-face
465 "Level 5 empty newsgroup face.")
467 (defface gnus-group-news-6-face
476 "Level 6 newsgroup face.")
478 (defface gnus-group-news-6-empty-face
487 "Level 6 empty newsgroup face.")
489 (defface gnus-group-news-low-face
492 (:foreground "DarkTurquoise" :bold t))
495 (:foreground "DarkGreen" :bold t))
498 "Low level newsgroup face.")
500 (defface gnus-group-news-low-empty-face
503 (:foreground "DarkTurquoise"))
506 (:foreground "DarkGreen"))
509 "Low level empty newsgroup face.")
511 (defface gnus-group-mail-1-face
514 (:foreground "aquamarine1" :bold t))
517 (:foreground "DeepPink3" :bold t))
520 "Level 1 mailgroup face.")
522 (defface gnus-group-mail-1-empty-face
525 (:foreground "aquamarine1"))
528 (:foreground "DeepPink3"))
530 (:italic t :bold t)))
531 "Level 1 empty mailgroup face.")
533 (defface gnus-group-mail-2-face
536 (:foreground "aquamarine2" :bold t))
539 (:foreground "HotPink3" :bold t))
542 "Level 2 mailgroup face.")
544 (defface gnus-group-mail-2-empty-face
547 (:foreground "aquamarine2"))
550 (:foreground "HotPink3"))
553 "Level 2 empty mailgroup face.")
555 (defface gnus-group-mail-3-face
558 (:foreground "aquamarine3" :bold t))
561 (:foreground "magenta4" :bold t))
564 "Level 3 mailgroup face.")
566 (defface gnus-group-mail-3-empty-face
569 (:foreground "aquamarine3"))
572 (:foreground "magenta4"))
575 "Level 3 empty mailgroup face.")
577 (defface gnus-group-mail-low-face
580 (:foreground "aquamarine4" :bold t))
583 (:foreground "DeepPink4" :bold t))
586 "Low level mailgroup face.")
588 (defface gnus-group-mail-low-empty-face
591 (:foreground "aquamarine4"))
594 (:foreground "DeepPink4"))
597 "Low level empty mailgroup face.")
599 ;; Summary mode faces.
601 (defface gnus-summary-selected-face '((t
603 "Face used for selected articles.")
605 (defface gnus-summary-cancelled-face
607 (:foreground "yellow" :background "black")))
608 "Face used for cancelled articles.")
610 (defface gnus-summary-high-ticked-face
613 (:foreground "pink" :bold t))
616 (:foreground "firebrick" :bold t))
619 "Face used for high interest ticked articles.")
621 (defface gnus-summary-low-ticked-face
624 (:foreground "pink" :italic t))
627 (:foreground "firebrick" :italic t))
630 "Face used for low interest ticked articles.")
632 (defface gnus-summary-normal-ticked-face
635 (:foreground "pink"))
638 (:foreground "firebrick"))
641 "Face used for normal interest ticked articles.")
643 (defface gnus-summary-high-ancient-face
646 (:foreground "SkyBlue" :bold t))
649 (:foreground "RoyalBlue" :bold t))
652 "Face used for high interest ancient articles.")
654 (defface gnus-summary-low-ancient-face
657 (:foreground "SkyBlue" :italic t))
660 (:foreground "RoyalBlue" :italic t))
663 "Face used for low interest ancient articles.")
665 (defface gnus-summary-normal-ancient-face
668 (:foreground "SkyBlue"))
671 (:foreground "RoyalBlue"))
674 "Face used for normal interest ancient articles.")
676 (defface gnus-summary-high-undownloaded-face
679 (:bold t :foreground "cyan4"))
680 (((class color) (background dark))
681 (:bold t :foreground "LightGray"))
682 (t (:inverse-video t :bold t)))
683 "Face used for high interest uncached articles.")
685 (defface gnus-summary-low-undownloaded-face
688 (:italic t :foreground "cyan4" :bold nil))
689 (((class color) (background dark))
690 (:italic t :foreground "LightGray" :bold nil))
691 (t (:inverse-video t :italic t)))
692 "Face used for low interest uncached articles.")
694 (defface gnus-summary-normal-undownloaded-face
697 (:foreground "cyan4" :bold nil))
698 (((class color) (background dark))
699 (:foreground "LightGray" :bold nil))
700 (t (:inverse-video t)))
701 "Face used for normal interest uncached articles.")
703 (defface gnus-summary-high-unread-face
706 "Face used for high interest unread articles.")
708 (defface gnus-summary-low-unread-face
711 "Face used for low interest unread articles.")
713 (defface gnus-summary-normal-unread-face
716 "Face used for normal interest unread articles.")
718 (defface gnus-summary-high-read-face
721 (:foreground "PaleGreen"
725 (:foreground "DarkGreen"
729 "Face used for high interest read articles.")
731 (defface gnus-summary-low-read-face
734 (:foreground "PaleGreen"
738 (:foreground "DarkGreen"
742 "Face used for low interest read articles.")
744 (defface gnus-summary-normal-read-face
747 (:foreground "PaleGreen"))
750 (:foreground "DarkGreen"))
753 "Face used for normal interest read articles.")
760 (defvar gnus-buffers nil)
762 (defun gnus-get-buffer-create (name)
763 "Do the same as `get-buffer-create', but store the created buffer."
764 (or (get-buffer name)
765 (car (push (get-buffer-create name) gnus-buffers))))
767 (defun gnus-add-buffer ()
768 "Add the current buffer to the list of Gnus buffers."
769 (push (current-buffer) gnus-buffers))
771 (defmacro gnus-kill-buffer (buffer)
772 "Kill BUFFER and remove from the list of Gnus buffers."
773 `(let ((buf ,buffer))
774 (when (gnus-buffer-exists-p buf)
775 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
778 (defun gnus-buffers ()
779 "Return a list of live Gnus buffers."
780 (while (and gnus-buffers
781 (not (buffer-name (car gnus-buffers))))
783 (let ((buffers gnus-buffers))
785 (if (buffer-name (cadr buffers))
787 (setcdr buffers (cddr buffers)))))
792 (defvar gnus-group-buffer "*Group*")
795 (autoload 'gnus-play-jingle "gnus-audio"))
797 (defface gnus-splash-face
800 (:foreground "#888888"))
803 (:foreground "#888888"))
806 "Face for the splash screen.")
808 (defun gnus-splash ()
810 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
811 (let ((buffer-read-only nil))
813 (unless gnus-inhibit-startup-message
814 (gnus-group-startup-message)
816 (when gnus-play-startup-jingle
817 (gnus-play-jingle))))))
819 (defun gnus-indent-rigidly (start end arg)
820 "Indent rigidly using only spaces and no tabs."
823 (narrow-to-region start end)
825 (indent-rigidly start end arg)
826 ;; We translate tabs into spaces -- not everybody uses
827 ;; an 8-character tab.
828 (goto-char (point-min))
829 (while (search-forward "\t" nil t)
830 (replace-match " " t t))))))
832 (defvar gnus-simple-splash nil)
834 ;;(format "%02x%02x%02x" 114 66 20) "724214"
836 (defvar gnus-logo-color-alist
837 '((flame "#cc3300" "#ff2200")
838 (pine "#c0cc93" "#f8ffb8")
839 (moss "#a1cc93" "#d2ffb8")
840 (irish "#04cc90" "#05ff97")
841 (sky "#049acc" "#05deff")
842 (tin "#6886cc" "#82b6ff")
843 (velvet "#7c68cc" "#8c82ff")
844 (grape "#b264cc" "#cf7df")
845 (labia "#cc64c2" "#fd7dff")
846 (berry "#cc6485" "#ff7db5")
847 (dino "#724214" "#1e3f03")
848 (oort "#cccccc" "#888888")
849 (storm "#666699" "#99ccff")
850 (pdino "#9999cc" "#99ccff")
851 (purp "#9999cc" "#666699")
852 (no "#000000" "#ff0000")
853 (neutral "#b4b4b4" "#878787")
854 (september "#bf9900" "#ffcc00"))
855 "Color alist used for the Gnus logo.")
857 (defcustom gnus-logo-color-style 'oort
858 "*Color styles used for the Gnus logo."
859 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
860 gnus-logo-color-alist))
863 (defvar gnus-logo-colors
864 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
865 "Colors used for the Gnus logo.")
867 (defun gnus-group-startup-message (&optional x y)
868 "Insert startup message in current buffer."
869 ;; Insert the message.
873 (fboundp 'find-image)
875 (let* ((data-directory (nnheader-find-etc-directory "gnus"))
877 `((:type xpm :file "gnus.xpm"
879 (("thing" . ,(car gnus-logo-colors))
880 ("shadow" . ,(cadr gnus-logo-colors))
882 ("background" . ,(face-background 'default))))
883 (:type pbm :file "gnus.pbm"
884 ;; Account for the pbm's blackground.
885 :background ,(face-foreground 'gnus-splash-face)
886 :foreground ,(face-background 'default))
887 (:type xbm :file "gnus.xbm"
888 ;; Account for the xbm's blackground.
889 :background ,(face-foreground 'gnus-splash-face)
890 :foreground ,(face-background 'default))))))
892 (let ((size (image-size image)))
893 (insert-char ?\n (max 0 (round (- (window-height)
894 (or y (cdr size)) 1) 2)))
895 (insert-char ?\ (max 0 (round (- (window-width)
896 (or x (car size))) 2)))
897 (insert-image image))
898 (setq gnus-simple-splash nil)
904 _ ___ __ ___ __ _ ___
924 (gnus-indent-rigidly (point-min) (point-max)
925 (/ (max (- (window-width) (or x 46)) 0) 2))
926 (goto-char (point-min))
928 (let* ((pheight (count-lines (point-min) (point-max)))
929 (wheight (window-height))
930 (rest (- wheight pheight)))
931 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
933 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
934 (setq gnus-simple-splash t)))
935 (goto-char (point-min))
936 (setq mode-line-buffer-identification (concat " " gnus-version))
937 (set-buffer-modified-p t))
940 (let ((command (format "%s" this-command)))
941 (if (and (string-match "gnus" command)
942 (not (string-match "gnus-other-frame" command)))
944 (gnus-get-buffer-create gnus-group-buffer))))
951 (defcustom gnus-parameters nil
952 "Alist of group parameters.
955 ((\"mail\\\\..*\" (gnus-show-threads nil)
956 (gnus-use-scoring nil)
957 (gnus-summary-line-format
958 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
961 (\"mail\\\\.me\" (gnus-use-scoring t))
962 (\"list\\\\..*\" (total-expire . t)
963 (broken-reply-to . t)))"
964 :group 'gnus-group-various
965 :type '(repeat (cons regexp
968 (defvar gnus-group-parameters-more nil)
970 (defmacro gnus-define-group-parameter (param &rest rest)
971 "Define a group parameter PARAM.
972 REST is a plist of following:
973 :type One of `bool', `list' or nil.
974 :function The name of the function.
975 :function-document The documentation of the function.
976 :parameter-type The type for customizing the parameter.
977 :parameter-document The documentation for the parameter.
978 :variable The name of the variable.
979 :variable-document The documentation for the variable.
980 :variable-group The group for customizing the variable.
981 :variable-type The type for customizing the variable.
982 :variable-default The default value of the variable."
983 (let* ((type (plist-get rest :type))
984 (parameter-type (plist-get rest :parameter-type))
985 (parameter-document (plist-get rest :parameter-document))
986 (function (or (plist-get rest :function)
987 (intern (format "gnus-parameter-%s" param))))
988 (function-document (or (plist-get rest :function-document) ""))
989 (variable (or (plist-get rest :variable)
990 (intern (format "gnus-parameter-%s-alist" param))))
991 (variable-document (or (plist-get rest :variable-document) ""))
992 (variable-group (plist-get rest :variable-group))
993 (variable-type (or (plist-get rest :variable-type)
995 (list (regexp :tag "Group")
996 ,(car (cdr parameter-type)))))))
997 (variable-default (plist-get rest :variable-default)))
1000 `(defcustom ,variable ,variable-default
1002 :group 'gnus-group-parameter
1003 :group ',variable-group
1004 :type ,variable-type)
1005 `(setq gnus-group-parameters-more
1006 (delq (assq ',param gnus-group-parameters-more)
1007 gnus-group-parameters-more))
1008 `(add-to-list 'gnus-group-parameters-more
1011 ,parameter-document))
1013 `(defun ,function (name)
1015 (let ((params (gnus-group-find-parameter name))
1018 ((memq ',param params)
1020 ((setq val (assq ',param params))
1022 ((stringp ,variable)
1023 (string-match ,variable name))
1025 (let ((alist ,variable)
1027 (while (setq elem (pop alist))
1029 (string-match (car elem) name))
1032 (if (consp value) (car value) value))))))
1033 `(defun ,function (name)
1036 (or (gnus-group-find-parameter name ',param ,(and type t))
1037 (let ((alist ,variable)
1039 (while (setq elem (pop alist))
1041 (string-match (car elem) name))
1046 '(if (consp value) (car value) value))))))))))
1048 (defcustom gnus-home-directory "~/"
1049 "Directory variable that specifies the \"home\" directory.
1050 All other Gnus file and directory variables are initialized from this variable."
1054 (defcustom gnus-directory (or (getenv "SAVEDIR")
1055 (nnheader-concat gnus-home-directory "News/"))
1056 "*Directory variable from which all other Gnus file variables are derived.
1058 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1059 This means that other directory variables that are initialized from
1060 this variable won't be set properly if you set this variable in `.gnus.el'.
1061 Set this variable in `.emacs' instead."
1065 (defcustom gnus-default-directory nil
1066 "*Default directory for all Gnus buffers."
1068 :type '(choice (const :tag "current" nil)
1071 ;; Site dependent variables. These variables should be defined in
1074 (defvar gnus-default-nntp-server nil
1075 "Specify a default NNTP server.
1076 This variable should be defined in paths.el, and should never be set
1078 If you want to change servers, you should use `gnus-select-method'.
1079 See the documentation to that variable.")
1081 ;; Don't touch this variable.
1082 (defvar gnus-nntp-service "nntp"
1083 "NNTP service name (\"nntp\" or 119).
1084 This is an obsolete variable, which is scarcely used. If you use an
1085 nntp server for your newsgroup and want to change the port number
1086 used to 899, you would say something along these lines:
1088 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1090 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1091 "A file with only the name of the nntp server in it."
1096 (defun gnus-getenv-nntpserver ()
1097 "Find default nntp server.
1098 Check the NNTPSERVER environment variable and the
1099 `gnus-nntpserver-file' file."
1100 (or (getenv "NNTPSERVER")
1101 (and (file-readable-p gnus-nntpserver-file)
1103 (insert-file-contents gnus-nntpserver-file)
1104 (let ((name (buffer-string)))
1105 (unless (string-match "\\`[ \t\n]*$" name)
1108 (defcustom gnus-select-method
1111 (list 'nntp (or (condition-case nil
1112 (gnus-getenv-nntpserver)
1114 (when (and gnus-default-nntp-server
1115 (not (string= gnus-default-nntp-server "")))
1116 gnus-default-nntp-server)
1118 (if (or (null gnus-nntp-service)
1119 (equal gnus-nntp-service "nntp"))
1121 (list gnus-nntp-service)))
1123 "Default method for selecting a newsgroup.
1124 This variable should be a list, where the first element is how the
1125 news is to be fetched, the second is the address.
1127 For instance, if you want to get your news via \"flab.flab.edu\" using
1128 NNTP, you could say:
1130 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1132 If you want to use your local spool, say:
1134 \(setq gnus-select-method (list 'nnspool (system-name)))
1136 If you use this variable, you must set `gnus-nntp-server' to nil.
1138 There is a lot more to know about select methods and virtual servers -
1139 see the manual for details."
1141 :type 'gnus-select-method)
1143 (defcustom gnus-message-archive-method "archive"
1144 "*Method used for archiving messages you've sent.
1145 This should be a mail method."
1147 :group 'gnus-message
1148 :type '(choice (const :tag "Default archive method" "archive")
1149 gnus-select-method))
1151 (defcustom gnus-message-archive-group nil
1152 "*Name of the group in which to save the messages you've written.
1153 This can either be a string; a list of strings; or an alist
1154 of regexps/functions/forms to be evaluated to return a string (or a list
1155 of strings). The functions are called with the name of the current
1156 group (or nil) as a parameter.
1158 If you want to save your mail in one group and the news articles you
1159 write in another group, you could say something like:
1161 \(setq gnus-message-archive-group
1162 '((if (message-news-p)
1166 Normally the group names returned by this variable should be
1167 unprefixed -- which implicitly means \"store on the archive server\".
1168 However, you may wish to store the message on some other server. In
1169 that case, just return a fully prefixed name of the group --
1170 \"nnml+private:mail.misc\", for instance."
1171 :group 'gnus-message
1172 :type '(choice (const :tag "none" nil)
1177 (defcustom gnus-secondary-servers nil
1178 "List of NNTP servers that the user can choose between interactively.
1179 To make Gnus query you for a server, you have to give `gnus' a
1180 non-numeric prefix - `C-u M-x gnus', in short."
1182 :type '(repeat string))
1184 (defcustom gnus-nntp-server nil
1185 "*The name of the host running the NNTP server.
1186 This variable is semi-obsolete. Use the `gnus-select-method'
1189 :type '(choice (const :tag "disable" nil)
1192 (defcustom gnus-secondary-select-methods nil
1193 "A list of secondary methods that will be used for reading news.
1194 This is a list where each element is a complete select method (see
1195 `gnus-select-method').
1197 If, for instance, you want to read your mail with the nnml back end,
1198 you could set this variable:
1200 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1202 :type '(repeat gnus-select-method))
1204 (defvar gnus-backup-default-subscribed-newsgroups
1205 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1206 "Default default new newsgroups the first time Gnus is run.
1207 Should be set in paths.el, and shouldn't be touched by the user.")
1209 (defcustom gnus-local-domain nil
1210 "Local domain name without a host name.
1211 The DOMAINNAME environment variable is used instead if it is defined.
1212 If the function `system-name' returns the full Internet name, there is
1213 no need to set this variable."
1214 :group 'gnus-message
1215 :type '(choice (const :tag "default" nil)
1218 (defvar gnus-local-organization nil
1219 "String with a description of what organization (if any) the user belongs to.
1220 Obsolete variable; use `message-user-organization' instead.")
1222 ;; Customization variables
1224 (defcustom gnus-refer-article-method nil
1225 "Preferred method for fetching an article by Message-ID.
1226 If you are reading news from the local spool (with nnspool), fetching
1227 articles by Message-ID is painfully slow. By setting this method to an
1228 nntp method, you might get acceptable results.
1230 The value of this variable must be a valid select method as discussed
1231 in the documentation of `gnus-select-method'.
1233 It can also be a list of select methods, as well as the special symbol
1234 `current', which means to use the current select method. If it is a
1235 list, Gnus will try all the methods in the list until it finds a match."
1237 :type '(choice (const :tag "default" nil)
1239 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1241 (repeat :menu-tag "Try multiple"
1243 :value (current (nnweb "refer" (nnweb-type google)))
1244 (choice :tag "Method"
1246 (const :tag "Google"
1247 (nnweb "refer" (nnweb-type google)))
1248 gnus-select-method))))
1250 (defcustom gnus-group-faq-directory
1251 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1252 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1253 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1254 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1255 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1256 "/ftp@rtfm.mit.edu:/pub/usenet/"
1257 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1258 "/ftp@ftp.sunet.se:/pub/usenet/"
1259 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1260 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1261 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1262 "*Directory where the group FAQs are stored.
1263 This will most commonly be on a remote machine, and the file will be
1264 fetched by ange-ftp.
1266 This variable can also be a list of directories. In that case, the
1267 first element in the list will be used by default. The others can
1268 be used when being prompted for a site.
1270 Note that Gnus uses an aol machine as the default directory. If this
1271 feels fundamentally unclean, just think of it as a way to finally get
1272 something of value back from them.
1274 If the default site is too slow, try one of these:
1276 North America: mirrors.aol.com /pub/rtfm/usenet
1277 ftp.seas.gwu.edu /pub/rtfm
1278 rtfm.mit.edu /pub/usenet
1279 Europe: ftp.uni-paderborn.de /pub/FAQ
1280 src.doc.ic.ac.uk /usenet/news-FAQS
1281 ftp.sunet.se /pub/usenet
1282 ftp.pasteur.fr /pub/FAQ
1283 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1284 hwarang.postech.ac.kr /pub/usenet
1285 ftp.hk.super.net /mirror/faqs"
1286 :group 'gnus-group-various
1287 :type '(choice directory
1288 (repeat directory)))
1290 (defcustom gnus-group-charter-alist
1291 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1292 ("de" . (concat "http://purl.net/charta/" name ".html"))
1293 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1294 ("england" . (concat "http://england.news-admin.org/charters/" name))
1295 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1296 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1297 (gnus-replace-in-string name "europa\\." "") ".html"))
1298 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1299 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1300 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1301 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1302 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1303 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1304 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1305 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1306 (gnus-replace-in-string name "\\." "_") ".html"))
1307 ("milw" . (concat "http://usenet.mil.wi.us/"
1308 (gnus-replace-in-string name "milw\\." "") "-charter"))
1309 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1310 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1311 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1312 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1313 When FORM is evaluated `name' is bound to the name of the group."
1314 :group 'gnus-group-various
1315 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1317 (defcustom gnus-group-fetch-control-use-browse-url nil
1318 "*Non-nil means that control messages are displayed using `browse-url'.
1319 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1321 :group 'gnus-group-various
1324 (defcustom gnus-use-cross-reference t
1325 "*Non-nil means that cross referenced articles will be marked as read.
1326 If nil, ignore cross references. If t, mark articles as read in
1327 subscribed newsgroups. If neither t nor nil, mark as read in all
1330 :type '(choice (const :tag "off" nil)
1331 (const :tag "subscribed" t)
1335 (defcustom gnus-process-mark ?#
1337 :group 'gnus-group-visual
1338 :group 'gnus-summary-marks
1341 (defcustom gnus-large-newsgroup 200
1342 "*The number of articles which indicates a large newsgroup.
1343 If the number of articles in a newsgroup is greater than this value,
1344 confirmation is required for selecting the newsgroup.
1345 If it is nil, no confirmation is required."
1346 :group 'gnus-group-select
1347 :type '(choice (const :tag "No limit" nil)
1350 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1351 "*Non-nil means that the default name of a file to save articles in is the group name.
1352 If it's nil, the directory form of the group name is used instead.
1354 If this variable is a list, and the list contains the element
1355 `not-score', long file names will not be used for score files; if it
1356 contains the element `not-save', long file names will not be used for
1357 saving; and if it contains the element `not-kill', long file names
1358 will not be used for kill files.
1360 Note that the default for this variable varies according to what system
1361 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1362 to nil while on all other systems it defaults to t."
1364 :type '(radio (sexp :format "Non-nil\n"
1365 :match (lambda (widget value)
1366 (and value (not (listp value))))
1369 (checklist (const :format "%v " not-score)
1370 (const :format "%v " not-save)
1373 (defcustom gnus-kill-files-directory gnus-directory
1374 "*Name of the directory where kill files will be stored (default \"~/News\")."
1375 :group 'gnus-score-files
1376 :group 'gnus-score-kill
1379 (defcustom gnus-save-score nil
1380 "*If non-nil, save group scoring info."
1381 :group 'gnus-score-various
1385 (defcustom gnus-use-undo t
1386 "*If non-nil, allow undoing in Gnus group mode buffers."
1390 (defcustom gnus-use-adaptive-scoring nil
1391 "*If non-nil, use some adaptive scoring scheme.
1392 If a list, then the values `word' and `line' are meaningful. The
1393 former will perform adaption on individual words in the subject
1394 header while `line' will perform adaption on several headers."
1396 :group 'gnus-score-adapt
1397 :type '(set (const word) (const line)))
1399 (defcustom gnus-use-cache 'passive
1400 "*If nil, Gnus will ignore the article cache.
1401 If `passive', it will allow entering (and reading) articles
1402 explicitly entered into the cache. If anything else, use the
1403 cache to the full extent of the law."
1406 :type '(choice (const :tag "off" nil)
1407 (const :tag "passive" passive)
1408 (const :tag "active" t)))
1410 (defcustom gnus-use-trees nil
1411 "*If non-nil, display a thread tree buffer."
1415 (defcustom gnus-use-grouplens nil
1416 "*If non-nil, use GroupLens ratings."
1420 (defcustom gnus-keep-backlog 20
1421 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1422 If it is a number N, then Gnus will only keep the last N articles
1423 read. If it is neither nil nor a number, Gnus will keep all read
1424 articles. This is not a good idea."
1426 :type '(choice (const :tag "off" nil)
1431 (defcustom gnus-use-nocem nil
1432 "*If non-nil, Gnus will read NoCeM cancel messages."
1436 (defcustom gnus-suppress-duplicates nil
1437 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1441 (defcustom gnus-use-scoring t
1442 "*If non-nil, enable scoring."
1446 (defcustom gnus-summary-prepare-exit-hook
1447 '(gnus-summary-expire-articles)
1448 "*A hook called when preparing to exit from the summary buffer.
1449 It calls `gnus-summary-expire-articles' by default."
1450 :group 'gnus-summary-exit
1453 (defcustom gnus-novice-user t
1454 "*Non-nil means that you are a Usenet novice.
1455 If non-nil, verbose messages may be displayed and confirmations may be
1460 (defcustom gnus-expert-user nil
1461 "*Non-nil means that you will never be asked for confirmation about anything.
1462 That doesn't mean *anything* anything; particularly destructive
1463 commands will still require prompting."
1467 (defcustom gnus-interactive-catchup t
1468 "*If non-nil, require your confirmation when catching up a group."
1469 :group 'gnus-group-select
1472 (defcustom gnus-interactive-exit t
1473 "*If non-nil, require your confirmation when exiting Gnus."
1477 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1478 "*Function for extracting address components from a From header.
1479 Two pre-defined function exist: `gnus-extract-address-components',
1480 which is the default, quite fast, and too simplistic solution, and
1481 `mail-extract-address-components', which works much better, but is
1483 :group 'gnus-summary-format
1484 :type '(radio (function-item gnus-extract-address-components)
1485 (function-item mail-extract-address-components)
1486 (function :tag "Other")))
1488 (defcustom gnus-carpal nil
1489 "*If non-nil, display clickable icons."
1493 (defcustom gnus-shell-command-separator ";"
1494 "String used to separate shell commands."
1498 (defcustom gnus-valid-select-methods
1499 '(("nntp" post address prompt-address physical-address)
1500 ("nnspool" post address)
1501 ("nnvirtual" post-mail virtual prompt-address)
1502 ("nnmbox" mail respool address)
1503 ("nnml" post-mail respool address)
1504 ("nnmh" mail respool address)
1505 ("nndir" post-mail prompt-address physical-address)
1506 ("nneething" none address prompt-address physical-address)
1507 ("nndoc" none address prompt-address)
1508 ("nnbabyl" mail address respool)
1509 ("nnkiboze" post virtual)
1510 ("nnsoup" post-mail address)
1511 ("nndraft" post-mail)
1512 ("nnfolder" mail respool address)
1513 ("nngateway" post-mail address prompt-address physical-address)
1522 ("nnagent" post-mail)
1523 ("nnimap" post-mail address prompt-address physical-address)
1524 ("nnmaildir" mail respool address)
1526 "*An alist of valid select methods.
1527 The first element of each list lists should be a string with the name
1528 of the select method. The other elements may be the category of
1529 this method (i. e., `post', `mail', `none' or whatever) or other
1530 properties that this method has (like being respoolable).
1531 If you implement a new select method, all you should have to change is
1532 this variable. I think."
1534 :type '(repeat (group (string :tag "Name")
1535 (radio-button-choice (const :format "%v " post)
1536 (const :format "%v " mail)
1537 (const :format "%v " none)
1539 (checklist :inline t
1540 (const :format "%v " address)
1541 (const :format "%v " prompt-address)
1542 (const :format "%v " physical-address)
1543 (const :format "%v " virtual)
1546 (defun gnus-redefine-select-method-widget ()
1547 "Recomputes the select-method widget based on the value of
1548 `gnus-valid-select-methods'."
1549 (define-widget 'gnus-select-method 'list
1550 "Widget for entering a select method."
1552 :tag "Select Method"
1553 :args `((choice :tag "Method"
1554 ,@(mapcar (lambda (entry)
1555 (list 'const :format "%v\n"
1556 (intern (car entry))))
1557 gnus-valid-select-methods)
1558 (symbol :tag "other"))
1559 (string :tag "Address")
1560 (repeat :tag "Options"
1564 (sexp :tag "Value"))))))
1566 (gnus-redefine-select-method-widget)
1568 (defcustom gnus-updated-mode-lines '(group article summary tree)
1569 "List of buffers that should update their mode lines.
1570 The list may contain the symbols `group', `article', `tree' and
1571 `summary'. If the corresponding symbol is present, Gnus will keep
1572 that mode line updated with information that may be pertinent.
1573 If this variable is nil, screen refresh may be quicker."
1574 :group 'gnus-various
1575 :type '(set (const group)
1580 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1581 (defcustom gnus-mode-non-string-length nil
1582 "*Max length of mode-line non-string contents.
1583 If this is nil, Gnus will take space as is needed, leaving the rest
1584 of the mode line intact. Note that the default of nil is unlikely
1585 to be desirable; see the manual for further details."
1586 :group 'gnus-various
1587 :type '(choice (const nil)
1590 ;; There should be special validation for this.
1591 (define-widget 'gnus-email-address 'string
1592 "An email address.")
1594 (gnus-define-group-parameter
1597 "Return GROUP's to-address."
1599 "*Alist of group regexps and correspondent to-addresses."
1600 :parameter-type '(gnus-email-address :tag "To Address")
1601 :parameter-document "\
1602 This will be used when doing followups and posts.
1604 This is primarily useful in mail groups that represent closed
1605 mailing lists--mailing lists where it's expected that everybody that
1606 writes to the mailing list is subscribed to it. Since using this
1607 parameter ensures that the mail only goes to the mailing list itself,
1608 it means that members won't receive two copies of your followups.
1610 Using `to-address' will actually work whether the group is foreign or
1611 not. Let's say there's a group on the server that is called
1612 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1613 articles from a mail-to-news gateway. Posting directly to this group
1614 is therefore impossible--you have to send mail to the mailing list
1617 The gnus-group-split mail splitting mechanism will behave as if this
1618 address was listed in gnus-group-split Addresses (see below).")
1620 (gnus-define-group-parameter
1623 "Return GROUP's to-list."
1625 "*Alist of group regexps and correspondent to-lists."
1626 :parameter-type '(gnus-email-address :tag "To List")
1627 :parameter-document "\
1628 This address will be used when doing a `a' in the group.
1630 It is totally ignored when doing a followup--except that if it is
1631 present in a news group, you'll get mail group semantics when doing
1634 The gnus-group-split mail splitting mechanism will behave as if this
1635 address was listed in gnus-group-split Addresses (see below).")
1637 (gnus-define-group-parameter
1641 "Return GROUP's subscription status."
1643 "*Groups which are automatically considered subscribed."
1644 :parameter-type '(const :tag "Subscribed" t)
1645 :parameter-document "\
1646 Gnus assumed that you are subscribed to the To/List address.
1648 When constructing a list of subscribed groups using
1649 `gnus-find-subscribed-addresses', Gnus includes the To address given
1650 above, or the list address (if the To address has not been set).")
1652 (gnus-define-group-parameter
1655 :function gnus-group-auto-expirable-p
1657 "Check whether GROUP is auto-expirable or not."
1658 :variable gnus-auto-expirable-newsgroups
1659 :variable-default nil
1661 "*Groups in which to automatically mark read articles as expirable.
1662 If non-nil, this should be a regexp that should match all groups in
1663 which to perform auto-expiry. This only makes sense for mail groups."
1664 :variable-group nnmail-expire
1665 :variable-type '(choice (const nil)
1667 :parameter-type '(const :tag "Automatic Expire" t)
1669 "All articles that are read will be marked as expirable.")
1671 (gnus-define-group-parameter
1674 :function gnus-group-total-expirable-p
1676 "Check whether GROUP is total-expirable or not."
1677 :variable gnus-total-expirable-newsgroups
1678 :variable-default nil
1680 "*Groups in which to perform expiry of all read articles.
1681 Use with extreme caution. All groups that match this regexp will be
1682 expiring - which means that all read articles will be deleted after
1683 \(say) one week. (This only goes for mail groups and the like, of
1685 :variable-group nnmail-expire
1686 :variable-type '(choice (const nil)
1688 :parameter-type '(const :tag "Total Expire" t)
1690 "All read articles will be put through the expiry process
1692 This happens even if they are not marked as expirable.
1695 (gnus-define-group-parameter
1698 "Return the default charset of GROUP."
1699 :variable gnus-group-charset-alist
1701 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1702 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1703 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1704 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1705 ("\\(^\\|:\\)relcom\\>" koi8-r)
1706 ("\\(^\\|:\\)fido7\\>" koi8-r)
1707 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1708 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1709 ("\\(^\\|:\\)han\\>" euc-kr)
1710 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1711 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1712 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1714 "Alist of regexps (to match group names) and default charsets to be used when reading."
1715 :variable-group gnus-charset
1716 :variable-type '(repeat (list (regexp :tag "Group")
1717 (symbol :tag "Charset")))
1718 :parameter-type '(symbol :tag "Charset")
1719 :parameter-document "\
1720 The default charset to use in the group.")
1722 (gnus-define-group-parameter
1726 "Return a posting method for GROUP."
1727 :variable gnus-post-method-alist
1729 "Alist of regexps (to match group names) and method to be used when
1730 posting an article."
1731 :variable-group gnus-group-foreign
1733 '(choice :tag "Posting Method"
1734 (const :tag "Use native server" native)
1735 (const :tag "Use current server" current)
1736 (list :convert-widget
1738 (list 'sexp :tag "Methods"
1739 :value gnus-select-method))))
1741 "Posting method for this group.")
1743 (gnus-define-group-parameter
1744 large-newsgroup-initial
1747 "Return GROUP's initial input of the number of articles."
1749 "*Alist of group regexps and its initial input of the number of articles."
1750 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1751 (const :tag "All" nil)
1753 :parameter-document "\
1755 This number will be prompted as the initial value of the number of
1756 articles to list when the group is a large newsgroup (see
1757 `gnus-large-newsgroup'). If it is nil, the default value is the
1758 total number of articles in the group.")
1760 ;; The Gnus registry's ignored groups
1761 (gnus-define-group-parameter
1765 "Whether this group should be ignored by the registry."
1766 :variable gnus-registry-ignored-groups
1767 :variable-default nil
1769 "*Groups in which the registry should be turned off."
1770 :variable-group gnus-registry
1771 :variable-type '(repeat
1773 (regexp :tag "Group Name Regular Expression")
1774 (boolean :tag "Ignored")))
1776 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1778 "Whether the Gnus Registry should ignore this group.")
1780 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1781 (defcustom gnus-install-group-spam-parameters t
1782 "*Disable the group parameters for spam detection.
1783 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1787 (when gnus-install-group-spam-parameters
1788 (defvar gnus-group-spam-classification-spam t
1789 "Spam group classification (requires spam.el).
1790 This group contains spam messages. On summary entry, unread messages
1791 will be marked as spam. On summary exit, the specified spam
1792 processors will be invoked on spam-marked messages, then those
1793 messages will be expired, so the spam processor will only see a
1794 spam-marked message once.")
1796 (defvar gnus-group-spam-classification-ham 'ask
1797 "The ham value for the spam group parameter (requires spam.el).
1798 On summary exit, the specified ham processors will be invoked on
1799 ham-marked messages. Exercise caution, since the ham processor will
1800 see the same message more than once because there is no ham message
1803 (gnus-define-group-parameter
1807 "The spam type (spam, ham, or neither) of the group."
1808 :variable gnus-spam-newsgroup-contents
1809 :variable-default nil
1811 "*Groups in which to automatically mark new articles as spam on
1812 summary entry. If non-nil, this should be a list of group name
1813 regexps that should match all groups in which to do automatic spam
1814 tagging, associated with a classification (spam, ham, or neither).
1815 This only makes sense for mail groups."
1816 :variable-group spam
1817 :variable-type '(repeat
1818 (list :tag "Group contents spam/ham classification"
1819 (regexp :tag "Group")
1821 (variable-item gnus-group-spam-classification-spam)
1822 (variable-item gnus-group-spam-classification-ham)
1823 (const :tag "Unclassified" nil))))
1825 :parameter-type '(list :tag "Group contents spam/ham classification"
1826 (choice :tag "Group contents classification for spam sorting"
1827 (variable-item gnus-group-spam-classification-spam)
1828 (variable-item gnus-group-spam-classification-ham)
1829 (const :tag "Unclassified" nil)))
1831 "The spam classification (spam, ham, or neither) of this group.
1832 When a spam group is entered, all unread articles are marked as spam.")
1834 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1835 "OBSOLETE: The ifile summary exit spam processor.")
1837 (defvar gnus-group-spam-exit-processor-stat "stat"
1838 "OBSOLETE: The spam-stat summary exit spam processor.")
1840 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1841 "OBSOLETE: The Bogofilter summary exit spam processor.")
1843 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1844 "OBSOLETE: The Blacklist summary exit spam processor.")
1846 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1847 "OBSOLETE: The Gmane reporting summary exit spam processor.
1848 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1850 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1851 "OBSOLETE: The spamoracle summary exit spam processor.")
1853 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1854 "OBSOLETE: The ifile summary exit ham processor.
1855 Only applicable to non-spam (unclassified and ham) groups.")
1857 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1858 "OBSOLETE: The Bogofilter summary exit ham processor.
1859 Only applicable to non-spam (unclassified and ham) groups.")
1861 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1862 "OBSOLETE: The spam-stat summary exit ham processor.
1863 Only applicable to non-spam (unclassified and ham) groups.")
1865 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1866 "OBSOLETE: The whitelist summary exit ham processor.
1867 Only applicable to non-spam (unclassified and ham) groups.")
1869 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1870 "OBSOLETE: The BBDB summary exit ham processor.
1871 Only applicable to non-spam (unclassified and ham) groups.")
1873 (defvar gnus-group-ham-exit-processor-copy "copy"
1874 "OBSOLETE: The ham copy exit ham processor.
1875 Only applicable to non-spam (unclassified and ham) groups.")
1877 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1878 "OBSOLETE: The spamoracle summary exit ham processor.
1879 Only applicable to non-spam (unclassified and ham) groups.")
1881 (gnus-define-group-parameter
1886 :tag "Spam Summary Exit Processor"
1888 (list :tag "Spam Summary Exit Processor Choices"
1890 (variable-item gnus-group-spam-exit-processor-ifile)
1891 (variable-item gnus-group-spam-exit-processor-stat)
1892 (variable-item gnus-group-spam-exit-processor-bogofilter)
1893 (variable-item gnus-group-spam-exit-processor-blacklist)
1894 (variable-item gnus-group-spam-exit-processor-spamoracle)
1895 (variable-item gnus-group-spam-exit-processor-report-gmane)
1896 (variable-item gnus-group-ham-exit-processor-bogofilter)
1897 (variable-item gnus-group-ham-exit-processor-ifile)
1898 (variable-item gnus-group-ham-exit-processor-stat)
1899 (variable-item gnus-group-ham-exit-processor-whitelist)
1900 (variable-item gnus-group-ham-exit-processor-BBDB)
1901 (variable-item gnus-group-ham-exit-processor-spamoracle)
1902 (variable-item gnus-group-ham-exit-processor-copy)
1903 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1904 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1905 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1906 (const :tag "Spam: ifile" (spam spam-use-ifile))
1907 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1908 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1909 (const :tag "Ham: ifile" (ham spam-use-ifile))
1910 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1911 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1912 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1913 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1914 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1915 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1917 "Which spam or ham processors will be applied when the summary is exited."
1918 :variable gnus-spam-process-newsgroups
1919 :variable-default nil
1921 "*Groups in which to automatically process spam or ham articles with
1922 a backend on summary exit. If non-nil, this should be a list of group
1923 name regexps that should match all groups in which to do automatic
1924 spam processing, associated with the appropriate processor."
1925 :variable-group spam
1927 '(repeat :tag "Spam/Ham Processors"
1928 (list :tag "Spam Summary Exit Processor Choices"
1929 (regexp :tag "Group Regexp")
1931 :tag "Spam/Ham Summary Exit Processor"
1932 (variable-item gnus-group-spam-exit-processor-ifile)
1933 (variable-item gnus-group-spam-exit-processor-stat)
1934 (variable-item gnus-group-spam-exit-processor-bogofilter)
1935 (variable-item gnus-group-spam-exit-processor-blacklist)
1936 (variable-item gnus-group-spam-exit-processor-spamoracle)
1937 (variable-item gnus-group-spam-exit-processor-report-gmane)
1938 (variable-item gnus-group-ham-exit-processor-bogofilter)
1939 (variable-item gnus-group-ham-exit-processor-ifile)
1940 (variable-item gnus-group-ham-exit-processor-stat)
1941 (variable-item gnus-group-ham-exit-processor-whitelist)
1942 (variable-item gnus-group-ham-exit-processor-BBDB)
1943 (variable-item gnus-group-ham-exit-processor-spamoracle)
1944 (variable-item gnus-group-ham-exit-processor-copy)
1945 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1946 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1947 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1948 (const :tag "Spam: ifile" (spam spam-use-ifile))
1949 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1950 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1951 (const :tag "Ham: ifile" (ham spam-use-ifile))
1952 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1953 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1954 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1955 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1956 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1957 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1960 "Which spam or ham processors will be applied when the summary is exited.")
1962 (gnus-define-group-parameter
1966 '(boolean :tag "Spam autodetection")
1968 "Should spam be autodetected (with spam-split) in this group?"
1969 :variable gnus-spam-autodetect
1970 :variable-default nil
1972 "*Groups in which spam should be autodetected when they are entered.
1973 Only unseen articles will be examined, unless
1974 spam-autodetect-recheck-messages is set."
1975 :variable-group spam
1978 :tag "Autodetection setting"
1980 (regexp :tag "Group Regexp")
1983 "Spam autodetection.
1984 Only unseen articles will be examined, unless
1985 spam-autodetect-recheck-messages is set.")
1987 (gnus-define-group-parameter
1988 spam-autodetect-methods
1991 '(choice :tag "Spam autodetection-specific methods"
1994 (set :tag "Use specific methods"
1995 (variable-item spam-use-blacklist)
1996 (variable-item spam-use-regex-headers)
1997 (variable-item spam-use-regex-body)
1998 (variable-item spam-use-whitelist)
1999 (variable-item spam-use-BBDB)
2000 (variable-item spam-use-ifile)
2001 (variable-item spam-use-spamoracle)
2002 (variable-item spam-use-stat)
2003 (variable-item spam-use-blackholes)
2004 (variable-item spam-use-hashcash)
2005 (variable-item spam-use-bogofilter-headers)
2006 (variable-item spam-use-bogofilter)))
2008 "Methods to be used for autodetection in each group"
2009 :variable gnus-spam-autodetect-methods
2010 :variable-default nil
2012 "*Methods for autodetecting spam per group.
2013 Requires the spam-autodetect parameter. Only unseen articles
2014 will be examined, unless spam-autodetect-recheck-messages is
2016 :variable-group spam
2019 :tag "Autodetection methods"
2021 (regexp :tag "Group Regexp")
2025 (set :tag "Use specific methods"
2026 (variable-item spam-use-blacklist)
2027 (variable-item spam-use-regex-headers)
2028 (variable-item spam-use-regex-body)
2029 (variable-item spam-use-whitelist)
2030 (variable-item spam-use-BBDB)
2031 (variable-item spam-use-ifile)
2032 (variable-item spam-use-spamoracle)
2033 (variable-item spam-use-stat)
2034 (variable-item spam-use-blackholes)
2035 (variable-item spam-use-hashcash)
2036 (variable-item spam-use-bogofilter-headers)
2037 (variable-item spam-use-bogofilter)))))
2039 "Spam autodetection methods.
2040 Requires the spam-autodetect parameter. Only unseen articles
2041 will be examined, unless spam-autodetect-recheck-messages is
2044 (gnus-define-group-parameter
2045 spam-process-destination
2048 '(choice :tag "Destination for spam-processed articles at summary exit"
2049 (string :tag "Move to a group")
2050 (repeat :tag "Move to multiple groups"
2051 (string :tag "Destination group"))
2052 (const :tag "Expire" nil))
2054 "Where spam-processed articles will go at summary exit."
2055 :variable gnus-spam-process-destinations
2056 :variable-default nil
2058 "*Groups in which to explicitly send spam-processed articles to
2059 another group, or expire them (the default). If non-nil, this should
2060 be a list of group name regexps that should match all groups in which
2061 to do spam-processed article moving, associated with the destination
2062 group or nil for explicit expiration. This only makes sense for
2064 :variable-group spam
2067 :tag "Spam-processed articles destination"
2069 (regexp :tag "Group Regexp")
2071 :tag "Destination for spam-processed articles at summary exit"
2072 (string :tag "Move to a group")
2073 (repeat :tag "Move to multiple groups"
2074 (string :tag "Destination group"))
2075 (const :tag "Expire" nil))))
2077 "Where spam-processed articles will go at summary exit.")
2079 (gnus-define-group-parameter
2080 ham-process-destination
2084 :tag "Destination for ham articles at summary exit from a spam group"
2085 (string :tag "Move to a group")
2086 (repeat :tag "Move to multiple groups"
2087 (string :tag "Destination group"))
2088 (const :tag "Respool" respool)
2089 (const :tag "Do nothing" nil))
2091 "Where ham articles will go at summary exit from a spam group."
2092 :variable gnus-ham-process-destinations
2093 :variable-default nil
2095 "*Groups in which to explicitly send ham articles to
2096 another group, or do nothing (the default). If non-nil, this should
2097 be a list of group name regexps that should match all groups in which
2098 to do ham article moving, associated with the destination
2099 group or nil for explicit ignoring. This only makes sense for
2100 mail groups, and only works in spam groups."
2101 :variable-group spam
2104 :tag "Ham articles destination"
2106 (regexp :tag "Group Regexp")
2108 :tag "Destination for ham articles at summary exit from spam group"
2109 (string :tag "Move to a group")
2110 (repeat :tag "Move to multiple groups"
2111 (string :tag "Destination group"))
2112 (const :tag "Respool" respool)
2113 (const :tag "Expire" nil))))
2115 "Where ham articles will go at summary exit from a spam group.")
2117 (gnus-define-group-parameter
2120 :parameter-type '(list :tag "Ham mark choices"
2122 (variable-item gnus-del-mark)
2123 (variable-item gnus-read-mark)
2124 (variable-item gnus-ticked-mark)
2125 (variable-item gnus-killed-mark)
2126 (variable-item gnus-kill-file-mark)
2127 (variable-item gnus-low-score-mark)))
2130 "Marks considered ham (positively not spam). Such articles will be
2131 processed as ham (non-spam) on group exit. When nil, the global
2132 spam-ham-marks variable takes precedence."
2133 :variable-default '((".*" ((gnus-del-mark
2137 gnus-low-score-mark))))
2138 :variable-group spam
2140 "*Groups in which to explicitly set the ham marks to some value.")
2142 (gnus-define-group-parameter
2145 :parameter-type '(list :tag "Spam mark choices"
2147 (variable-item gnus-spam-mark)
2148 (variable-item gnus-killed-mark)
2149 (variable-item gnus-kill-file-mark)
2150 (variable-item gnus-low-score-mark)))
2153 "Marks considered spam.
2154 Such articles will be processed as spam on group exit. When nil, the global
2155 spam-spam-marks variable takes precedence."
2156 :variable-default '((".*" ((gnus-spam-mark))))
2157 :variable-group spam
2159 "*Groups in which to explicitly set the spam marks to some value."))
2161 (defcustom gnus-group-uncollapsed-levels 1
2162 "Number of group name elements to leave alone when making a short group name."
2163 :group 'gnus-group-visual
2166 (defcustom gnus-group-use-permanent-levels nil
2167 "*If non-nil, once you set a level, Gnus will use this level."
2168 :group 'gnus-group-levels
2173 (defcustom gnus-load-hook nil
2174 "A hook run while Gnus is loaded."
2178 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2179 "A hook called to apply kill files to a group.
2180 This hook is intended to apply a kill file to the selected newsgroup.
2181 The function `gnus-apply-kill-file' is called by default.
2183 Since a general kill file is too heavy to use only for a few
2184 newsgroups, I recommend you to use a lighter hook function. For
2185 example, if you'd like to apply a kill file to articles which contains
2186 a string `rmgroup' in subject in newsgroup `control', you can use the
2189 (setq gnus-apply-kill-hook
2192 (cond ((string-match \"control\" gnus-newsgroup-name)
2193 (gnus-kill \"Subject\" \"rmgroup\")
2194 (gnus-expunge \"X\"))))))"
2195 :group 'gnus-score-kill
2196 :options '(gnus-apply-kill-file)
2199 (defcustom gnus-group-change-level-function nil
2200 "Function run when a group level is changed.
2201 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2202 :group 'gnus-group-levels
2207 (defcustom gnus-visual
2208 '(summary-highlight group-highlight article-highlight
2210 summary-menu group-menu article-menu
2211 tree-highlight menu highlight
2212 browse-menu server-menu
2213 page-marker tree-menu binary-menu pick-menu
2215 "*Enable visual features.
2216 If `visual' is disabled, there will be no menus and few faces. Most of
2217 the visual customization options below will be ignored. Gnus will use
2218 less space and be faster as a result.
2220 This variable can also be a list of visual elements to switch on. For
2221 instance, to switch off all visual things except menus, you can say:
2223 (setq gnus-visual '(menu))
2225 Valid elements include `summary-highlight', `group-highlight',
2226 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2227 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2228 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2229 and `grouplens-menu'."
2232 :type '(set (const summary-highlight)
2233 (const group-highlight)
2234 (const article-highlight)
2236 (const summary-menu)
2238 (const article-menu)
2239 (const tree-highlight)
2248 (const grouplens-menu)))
2250 ;; Byte-compiler warning.
2251 (defvar gnus-visual)
2252 ;; Find out whether the gnus-visual TYPE is wanted.
2253 (defun gnus-visual-p (&optional type class)
2254 (and gnus-visual ; Has to be non-nil, at least.
2255 (if (not type) ; We don't care about type.
2257 (if (listp gnus-visual) ; It's a list, so we check it.
2258 (or (memq type gnus-visual)
2259 (memq class gnus-visual))
2262 (defcustom gnus-mouse-face
2264 (if (gnus-visual-p 'mouse-face 'highlight)
2265 (if (boundp 'gnus-mouse-face)
2266 (or gnus-mouse-face 'highlight)
2270 "*Face used for group or summary buffer mouse highlighting.
2271 The line beneath the mouse pointer will be highlighted with this
2276 (defcustom gnus-article-save-directory gnus-directory
2277 "*Name of the directory articles will be saved in (default \"~/News\")."
2278 :group 'gnus-article-saving
2281 (defvar gnus-plugged t
2282 "Whether Gnus is plugged or not.")
2284 (defcustom gnus-agent-cache t
2285 "Controls use of the agent cache while plugged.
2286 When set, Gnus will prefer using the locally stored content rather
2287 than re-fetching it from the server. You also need to enable
2288 `gnus-agent' for this to have any affect."
2293 (defcustom gnus-default-charset 'undecided
2294 "Default charset assumed to be used when viewing non-ASCII characters.
2295 This variable is overridden on a group-to-group basis by the
2296 `gnus-group-charset-alist' variable and is only used on groups not
2297 covered by that variable."
2299 :group 'gnus-charset)
2301 ;; Fixme: Doc reference to agent.
2302 (defcustom gnus-agent t
2303 "Whether we want to use the Gnus agent or not.
2305 You may customize gnus-agent to disable its use. However, some
2306 back ends have started to use the agent as a client-side cache.
2307 Disabling the agent may result in noticeable loss of performance."
2312 (defcustom gnus-other-frame-function 'gnus
2313 "Function called by the command `gnus-other-frame'."
2315 :type '(choice (function-item gnus)
2316 (function-item gnus-no-server)
2317 (function-item gnus-slave)
2318 (function-item gnus-slave-no-server)))
2320 (defcustom gnus-other-frame-parameters nil
2321 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2322 This should be an alist for Emacs, or a plist for XEmacs."
2324 :type (if (featurep 'xemacs)
2325 '(repeat (list :inline t :format "%v"
2326 (symbol :tag "Property")
2327 (sexp :tag "Value")))
2328 '(repeat (cons :format "%v"
2329 (symbol :tag "Parameter")
2330 (sexp :tag "Value")))))
2333 ;;; Internal variables
2335 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2336 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2337 (defvar gnus-agent-method-p-cache nil
2338 ; Reset each time gnus-agent-covered-methods is changed else
2339 ; gnus-agent-method-p may mis-report a methods status.
2341 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2342 (defvar gnus-draft-meta-information-header "X-Draft-From")
2343 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2344 (defvar gnus-original-article-buffer " *Original Article*")
2345 (defvar gnus-newsgroup-name nil)
2346 (defvar gnus-ephemeral-servers nil)
2347 (defvar gnus-server-method-cache nil)
2349 (defvar gnus-agent-fetching nil
2350 "Whether Gnus agent is in fetching mode.")
2352 (defvar gnus-agent-covered-methods nil
2353 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2355 (defvar gnus-command-method nil
2356 "Dynamically bound variable that says what the current back end is.")
2358 (defvar gnus-current-select-method nil
2359 "The current method for selecting a newsgroup.")
2361 (defvar gnus-tree-buffer "*Tree*"
2362 "Buffer where Gnus thread trees are displayed.")
2365 (defvar gnus-use-generic-from nil)
2367 ;; Variable holding the user answers to all method prompts.
2368 (defvar gnus-method-history nil)
2370 ;; Variable holding the user answers to all mail method prompts.
2371 (defvar gnus-mail-method-history nil)
2373 ;; Variable holding the user answers to all group prompts.
2374 (defvar gnus-group-history nil)
2376 (defvar gnus-server-alist nil
2377 "List of available servers.")
2379 (defcustom gnus-cache-directory
2380 (nnheader-concat gnus-directory "cache/")
2381 "*The directory where cached articles will be stored."
2385 (defvar gnus-predefined-server-alist
2388 (nnspool-spool-directory ,gnus-cache-directory)
2389 (nnspool-nov-directory ,gnus-cache-directory)
2390 (nnspool-active-file
2391 ,(nnheader-concat gnus-cache-directory "active"))))
2392 "List of predefined (convenience) servers.")
2394 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2396 (defconst gnus-article-mark-lists
2397 '((marked . tick) (replied . reply)
2398 (expirable . expire) (killed . killed)
2399 (bookmarks . bookmark) (dormant . dormant)
2400 (scored . score) (saved . save)
2401 (cached . cache) (downloadable . download)
2402 (unsendable . unsend) (forwarded . forward)
2403 (recent . recent) (seen . seen)))
2405 (defconst gnus-article-special-mark-lists
2411 ;; Propagate flags to server, with the following exceptions:
2412 ;; `seen' is private to each gnus installation
2413 ;; `cache' is a internal gnus flag for each gnus installation
2414 ;; `download' is a agent flag private to each gnus installation
2415 ;; `unsend' are for nndraft groups only
2416 ;; `score' is not a proper mark
2417 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2418 (defconst gnus-article-unpropagated-mark-lists
2419 '(seen cache download unsend score bookmark)
2420 "Marks that shouldn't be propagated to back ends.
2421 Typical marks are those that make no sense in a standalone back end,
2422 such as a mark that says whether an article is stored in the cache
2423 \(which doesn't make sense in a standalone back end).")
2425 (defvar gnus-headers-retrieved-by nil)
2426 (defvar gnus-article-reply nil)
2427 (defvar gnus-override-method nil)
2428 (defvar gnus-article-check-size nil)
2429 (defvar gnus-opened-servers nil)
2431 (defvar gnus-current-kill-article nil)
2433 (defvar gnus-have-read-active-file nil)
2435 (defconst gnus-maintainer
2436 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2437 "The mail address of the Gnus maintainers.")
2439 (defvar gnus-info-nodes
2440 '((gnus-group-mode "(gnus)Group Buffer")
2441 (gnus-summary-mode "(gnus)Summary Buffer")
2442 (gnus-article-mode "(gnus)Article Buffer")
2443 (gnus-server-mode "(gnus)Server Buffer")
2444 (gnus-browse-mode "(gnus)Browse Foreign Server")
2445 (gnus-tree-mode "(gnus)Tree Display"))
2446 "Alist of major modes and related Info nodes.")
2448 (defvar gnus-group-buffer "*Group*")
2449 (defvar gnus-summary-buffer "*Summary*")
2450 (defvar gnus-article-buffer "*Article*")
2451 (defvar gnus-server-buffer "*Server*")
2453 (defvar gnus-slave nil
2454 "Whether this Gnus is a slave or not.")
2456 (defvar gnus-batch-mode nil
2457 "Whether this Gnus is running in batch mode or not.")
2459 (defvar gnus-variable-list
2460 '(gnus-newsrc-options gnus-newsrc-options-n
2461 gnus-newsrc-last-checked-date
2462 gnus-newsrc-alist gnus-server-alist
2463 gnus-killed-list gnus-zombie-list
2464 gnus-topic-topology gnus-topic-alist
2466 "Gnus variables saved in the quick startup file.")
2468 (defvar gnus-newsrc-alist nil
2469 "Assoc list of read articles.
2470 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2472 (defvar gnus-registry-alist nil
2473 "Assoc list of registry data.
2474 gnus-registry.el will populate this if it's loaded.")
2476 (defvar gnus-newsrc-hashtb nil
2477 "Hashtable of `gnus-newsrc-alist'.")
2479 (defvar gnus-killed-list nil
2480 "List of killed newsgroups.")
2482 (defvar gnus-killed-hashtb nil
2483 "Hash table equivalent of `gnus-killed-list'.")
2485 (defvar gnus-zombie-list nil
2486 "List of almost dead newsgroups.")
2488 (defvar gnus-description-hashtb nil
2489 "Descriptions of newsgroups.")
2491 (defvar gnus-list-of-killed-groups nil
2492 "List of newsgroups that have recently been killed by the user.")
2494 (defvar gnus-active-hashtb nil
2495 "Hashtable of active articles.")
2497 (defvar gnus-moderated-hashtb nil
2498 "Hashtable of moderated newsgroups.")
2500 ;; Save window configuration.
2501 (defvar gnus-prev-winconf nil)
2503 (defvar gnus-reffed-article-number nil)
2505 ;;; Let the byte-compiler know that we know about this variable.
2506 (defvar rmail-default-rmail-file)
2508 (defvar gnus-dead-summary nil)
2510 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2511 "Regexp matching invalid groups.")
2513 (defvar gnus-other-frame-object nil
2514 "A frame object which will be created by `gnus-other-frame'.")
2516 ;;; End of variables.
2518 ;; Define some autoload functions Gnus might use.
2521 ;; This little mapcar goes through the list below and marks the
2522 ;; symbols in question as autoloaded functions.
2525 (let ((interactive (nth 1 (memq ':interactive package))))
2529 (when (consp function)
2530 (setq keymap (car (memq 'keymap function)))
2531 (setq function (car function)))
2532 (unless (fboundp function)
2533 (autoload function (car package) nil interactive keymap))))
2534 (if (eq (nth 1 package) ':interactive)
2537 '(("info" :interactive t Info-goto-node)
2539 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2540 ("ps-print" ps-print-preprint)
2541 ("message" :interactive t
2542 message-send-and-exit message-yank-original)
2543 ("babel" babel-as-string)
2544 ("nnmail" nnmail-split-fancy nnmail-article-group)
2545 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2546 ("rmailout" rmail-output rmail-output-to-rmail-file)
2547 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2548 rmail-show-message rmail-summary-exists
2549 rmail-select-summary rmail-update-summary)
2550 ("gnus-audio" :interactive t gnus-audio-play)
2551 ("gnus-xmas" gnus-xmas-splash)
2552 ("gnus-soup" :interactive t
2553 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2554 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2555 ("nnsoup" nnsoup-pack-replies)
2556 ("score-mode" :interactive t gnus-score-mode)
2557 ("gnus-mh" gnus-summary-save-article-folder
2558 gnus-Folder-save-name gnus-folder-save-name)
2559 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2560 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2561 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2562 gnus-demon-add-disconnection gnus-demon-add-handler
2563 gnus-demon-remove-handler)
2564 ("gnus-demon" :interactive t
2565 gnus-demon-init gnus-demon-cancel)
2566 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2567 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2568 gnus-face-from-file)
2569 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2570 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2571 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2572 gnus-nocem-unwanted-article-p)
2573 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2574 gnus-server-server-name)
2575 ("gnus-srvr" gnus-browse-foreign-server)
2576 ("gnus-cite" :interactive t
2577 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2578 gnus-article-hide-citation gnus-article-fill-cited-article
2579 gnus-article-hide-citation-in-followups)
2580 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2581 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2582 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2583 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2584 gnus-cache-possibly-remove-articles gnus-cache-request-article
2585 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2586 gnus-cache-enter-remove-article gnus-cached-article-p
2587 gnus-cache-open gnus-cache-close gnus-cache-update-article
2588 gnus-cache-articles-in-group)
2589 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2590 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2591 ("gnus-score" :interactive t
2592 gnus-summary-increase-score gnus-summary-set-score
2593 gnus-summary-raise-thread gnus-summary-raise-same-subject
2594 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2595 gnus-summary-lower-thread gnus-summary-lower-same-subject
2596 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2597 gnus-summary-current-score gnus-score-delta-default
2598 gnus-score-flush-cache gnus-score-close
2599 gnus-possibly-score-headers gnus-score-followup-article
2600 gnus-score-followup-thread)
2602 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2603 gnus-current-score-file-nondirectory gnus-score-adaptive
2604 gnus-score-find-trace gnus-score-file-name)
2605 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2606 ("gnus-topic" :interactive t gnus-topic-mode)
2607 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2608 gnus-subscribe-topics)
2609 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2610 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2611 ("gnus-uu" :interactive t
2612 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2613 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2614 gnus-uu-mark-by-regexp gnus-uu-mark-all
2615 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2616 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2617 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2618 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2619 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2620 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2621 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2622 gnus-uu-mark-over gnus-uu-post-news)
2623 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2624 ("gnus-msg" (gnus-summary-send-map keymap)
2625 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2626 ("gnus-msg" :interactive t
2627 gnus-group-post-news gnus-group-mail gnus-group-news
2628 gnus-summary-post-news gnus-summary-news-other-window
2629 gnus-summary-followup gnus-summary-followup-with-original
2630 gnus-summary-cancel-article gnus-summary-supersede-article
2631 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2632 gnus-summary-mail-forward gnus-summary-mail-other-window
2633 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2634 gnus-summary-wide-reply gnus-summary-followup-to-mail
2635 gnus-summary-followup-to-mail-with-original gnus-bug
2636 gnus-summary-wide-reply-with-original
2637 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2638 gnus-summary-post-forward)
2639 ("gnus-picon" :interactive t gnus-treat-from-picon)
2640 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2641 gnus-grouplens-mode)
2642 ("smiley" :interactive t smiley-region)
2643 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2644 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2645 gnus-list-of-unread-articles gnus-list-of-read-articles
2646 gnus-offer-save-summaries gnus-make-thread-indent-array
2647 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2648 gnus-summary-skip-intangible gnus-summary-article-number
2649 gnus-data-header gnus-data-find)
2650 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2651 gnus-group-list-groups gnus-group-first-unread-group
2652 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2653 gnus-group-setup-buffer gnus-group-get-new-news
2654 gnus-group-make-help-group gnus-group-update-group
2655 gnus-group-iterate gnus-group-group-name)
2656 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2657 gnus-backlog-remove-article)
2658 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2659 gnus-article-prepare gnus-article-set-window-start
2660 gnus-article-next-page gnus-article-prev-page
2661 gnus-request-article-this-buffer gnus-article-mode
2662 gnus-article-setup-buffer gnus-narrow-to-page
2663 gnus-article-delete-invisible-text gnus-treat-article)
2664 ("gnus-art" :interactive t
2665 gnus-article-hide-headers gnus-article-hide-boring-headers
2666 gnus-article-treat-overstrike
2667 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2668 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2669 gnus-article-de-base64-unreadable
2670 gnus-article-decode-HZ
2671 gnus-article-wash-html
2672 gnus-article-unsplit-urls
2673 gnus-article-hide-pem gnus-article-hide-signature
2674 gnus-article-strip-leading-blank-lines gnus-article-date-local
2675 gnus-article-date-original gnus-article-date-lapsed
2676 ;; gnus-article-show-all-headers
2677 gnus-article-edit-mode gnus-article-edit-article
2678 gnus-article-edit-done gnus-article-decode-encoded-words
2679 gnus-start-date-timer gnus-stop-date-timer
2680 gnus-mime-view-all-parts)
2681 ("gnus-int" gnus-request-type)
2682 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2683 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2684 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2685 gnus-dup-enter-articles)
2686 ("gnus-range" gnus-copy-sequence)
2687 ("gnus-eform" gnus-edit-form)
2688 ("gnus-move" :interactive t
2689 gnus-group-move-group-to-server gnus-change-server)
2690 ("gnus-logic" gnus-score-advanced)
2691 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2692 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2693 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2694 gnus-async-halt-prefetch)
2695 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2696 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2697 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2698 gnus-summary-set-agent-mark gnus-agent-save-group-info
2699 gnus-agent-request-article gnus-agent-retrieve-headers)
2700 ("gnus-agent" :interactive t
2701 gnus-unplugged gnus-agentize gnus-agent-batch)
2702 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2703 gnus-summary-save-article-vm)
2704 ("compface" uncompface)
2705 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2706 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2707 ("gnus-mlspl" :interactive t gnus-group-split-setup
2708 gnus-group-split-update)
2709 ("gnus-delay" gnus-delay-initialize))))
2711 ;;; gnus-sum.el thingies
2714 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2715 "*The format specification of the lines in the summary buffer.
2717 It works along the same lines as a normal formatting string,
2718 with some simple extensions.
2720 %N Article number, left padded with spaces (string)
2722 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2723 %n Name of the poster (string)
2724 %a Extracted name of the poster (string)
2725 %A Extracted address of the poster (string)
2726 %F Contents of the From: header (string)
2727 %f Contents of the From: or To: headers (string)
2728 %x Contents of the Xref: header (string)
2729 %D Date of the article (string)
2730 %d Date of the article (string) in DD-MMM format
2731 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2732 %M Message-id of the article (string)
2733 %r References of the article (string)
2734 %c Number of characters in the article (integer)
2735 %k Pretty-printed version of the above (string)
2736 For example, \"1.2k\" or \"0.4M\".
2737 %L Number of lines in the article (integer)
2738 %I Indentation based on thread level (a string of spaces)
2739 %B A complex trn-style thread tree (string)
2740 The variables `gnus-sum-thread-*' can be used for customization.
2741 %T A string with two possible values: 80 spaces if the article
2742 is on thread level two or larger and 0 spaces on level one
2743 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2744 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2745 %[ Opening bracket (character, \"[\" or \"<\")
2746 %] Closing bracket (character, \"]\" or \">\")
2747 %> Spaces of length thread-level (string)
2748 %< Spaces of length (- 20 thread-level) (string)
2749 %i Article score (number)
2750 %z Article zcore (character)
2751 %t Number of articles under the current thread (number).
2752 %e Whether the thread is empty or not (character).
2753 %l GroupLens score (string).
2754 %V Total thread score (number).
2755 %P The line number (number).
2756 %O Download mark (character).
2757 %* If present, indicates desired cursor position
2758 (instead of after first colon).
2759 %u User defined specifier. The next character in the format string should
2760 be a letter. Gnus will call the function gnus-user-format-function-X,
2761 where X is the letter following %u. The function will be passed the
2762 current header as argument. The function should return a string, which
2763 will be inserted into the summary just like information from any other
2766 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2767 with care. For reasons of efficiency, Gnus will compute what column
2768 these characters will end up in, and \"hard-code\" that. This means that
2769 it is invalid to have these specs after a variable-length spec. Well,
2770 you might not be arrested, but your summary buffer will look strange,
2771 which is bad enough.
2773 The smart choice is to have these specs as far to the left as
2776 This restriction may disappear in later versions of Gnus.
2778 General format specifiers can also be used.
2779 See Info node `(gnus)Formatting Variables'."
2780 :link '(custom-manual "(gnus)Formatting Variables")
2782 :group 'gnus-summary-format)
2785 ;;; Skeleton keymaps
2788 (defun gnus-suppress-keymap (keymap)
2789 (suppress-keymap keymap)
2790 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2792 (define-key keymap (pop keys) 'undefined))))
2794 (defvar gnus-article-mode-map
2795 (let ((keymap (make-sparse-keymap)))
2796 (gnus-suppress-keymap keymap)
2798 (defvar gnus-summary-mode-map
2799 (let ((keymap (make-keymap)))
2800 (gnus-suppress-keymap keymap)
2802 (defvar gnus-group-mode-map
2803 (let ((keymap (make-keymap)))
2804 (gnus-suppress-keymap keymap)
2809 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2810 ;; If you want the cursor to go somewhere else, set these two
2811 ;; functions in some startup hook to whatever you want.
2812 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2813 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2815 ;;; Various macros and substs.
2817 (defun gnus-header-from (header)
2818 (mail-header-from header))
2820 (defmacro gnus-gethash (string hashtable)
2821 "Get hash value of STRING in HASHTABLE."
2822 `(symbol-value (intern-soft ,string ,hashtable)))
2824 (defmacro gnus-gethash-safe (string hashtable)
2825 "Get hash value of STRING in HASHTABLE.
2826 Return nil if not defined."
2827 `(let ((sym (intern-soft ,string ,hashtable)))
2828 (and (boundp sym) (symbol-value sym))))
2830 (defmacro gnus-sethash (string value hashtable)
2831 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2832 `(set (intern ,string ,hashtable) ,value))
2833 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2835 (defmacro gnus-group-unread (group)
2836 "Get the currently computed number of unread articles in GROUP."
2837 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2839 (defmacro gnus-group-entry (group)
2840 "Get the newsrc entry for GROUP."
2841 `(gnus-gethash ,group gnus-newsrc-hashtb))
2843 (defmacro gnus-active (group)
2844 "Get active info on GROUP."
2845 `(gnus-gethash ,group gnus-active-hashtb))
2847 (defmacro gnus-set-active (group active)
2848 "Set GROUP's active info."
2849 `(gnus-sethash ,group ,active gnus-active-hashtb))
2851 ;; Info access macros.
2853 (defmacro gnus-info-group (info)
2855 (defmacro gnus-info-rank (info)
2857 (defmacro gnus-info-read (info)
2859 (defmacro gnus-info-marks (info)
2861 (defmacro gnus-info-method (info)
2863 (defmacro gnus-info-params (info)
2866 (defmacro gnus-info-level (info)
2867 `(let ((rank (gnus-info-rank ,info)))
2871 (defmacro gnus-info-score (info)
2872 `(let ((rank (gnus-info-rank ,info)))
2873 (or (and (consp rank) (cdr rank)) 0)))
2875 (defmacro gnus-info-set-group (info group)
2876 `(setcar ,info ,group))
2877 (defmacro gnus-info-set-rank (info rank)
2878 `(setcar (nthcdr 1 ,info) ,rank))
2879 (defmacro gnus-info-set-read (info read)
2880 `(setcar (nthcdr 2 ,info) ,read))
2881 (defmacro gnus-info-set-marks (info marks &optional extend)
2883 `(gnus-info-set-entry ,info ,marks 3)
2884 `(setcar (nthcdr 3 ,info) ,marks)))
2885 (defmacro gnus-info-set-method (info method &optional extend)
2887 `(gnus-info-set-entry ,info ,method 4)
2888 `(setcar (nthcdr 4 ,info) ,method)))
2889 (defmacro gnus-info-set-params (info params &optional extend)
2891 `(gnus-info-set-entry ,info ,params 5)
2892 `(setcar (nthcdr 5 ,info) ,params)))
2894 (defun gnus-info-set-entry (info entry number)
2895 ;; Extend the info until we have enough elements.
2896 (while (<= (length info) number)
2897 (nconc info (list nil)))
2899 (setcar (nthcdr number info) entry))
2901 (defmacro gnus-info-set-level (info level)
2902 `(let ((rank (cdr ,info)))
2903 (if (consp (car rank))
2904 (setcar (car rank) ,level)
2905 (setcar rank ,level))))
2906 (defmacro gnus-info-set-score (info score)
2907 `(let ((rank (cdr ,info)))
2908 (if (consp (car rank))
2909 (setcdr (car rank) ,score)
2910 (setcar rank (cons (car rank) ,score)))))
2912 (defmacro gnus-get-info (group)
2913 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2915 ;;; Load the compatibility functions.
2924 (defvar gnus-shutdown-alist nil)
2926 (defun gnus-add-shutdown (function &rest symbols)
2927 "Run FUNCTION whenever one of SYMBOLS is shut down."
2928 (push (cons function symbols) gnus-shutdown-alist))
2930 (defun gnus-shutdown (symbol)
2931 "Shut down everything that waits for SYMBOL."
2932 (let ((alist gnus-shutdown-alist)
2934 (while (setq entry (pop alist))
2935 (when (memq symbol (cdr entry))
2936 (funcall (car entry))))))
2940 ;;; Gnus Utility Functions
2943 (defun gnus-find-subscribed-addresses ()
2944 "Return a regexp matching the addresses of all subscribed mail groups.
2945 It consists of the `to-address' or `to-list' parameter of all groups
2946 with a `subscribed' parameter."
2947 (let (group address addresses)
2948 (dolist (entry (cdr gnus-newsrc-alist))
2949 (setq group (car entry))
2950 (when (gnus-parameter-subscribed group)
2951 (setq address (mail-strip-quoted-names
2952 (or (gnus-group-fast-parameter group 'to-address)
2953 (gnus-group-fast-parameter group 'to-list))))
2955 (add-to-list 'addresses address))))
2957 (list (mapconcat 'regexp-quote addresses "\\|")))))
2959 (defmacro gnus-string-or (&rest strings)
2960 "Return the first element of STRINGS that is a non-blank string.
2961 STRINGS will be evaluated in normal `or' order."
2962 `(gnus-string-or-1 ',strings))
2964 (defun gnus-string-or-1 (strings)
2967 (setq string (eval (pop strings)))
2968 (if (string-match "^[ \t]*$" string)
2970 (setq strings nil)))
2973 (defun gnus-version (&optional arg)
2974 "Version number of this version of Gnus.
2975 If ARG, insert string at point."
2978 (insert (message gnus-version))
2979 (message gnus-version)))
2981 (defun gnus-continuum-version (&optional version)
2982 "Return VERSION as a floating point number."
2985 (setq version gnus-version))
2986 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2987 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2988 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2989 (number (match-string 2 version))
2991 (unless (string-match
2992 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2993 (error "Invalid version string: %s" version))
2994 (setq major (string-to-number (match-string 1 number))
2995 minor (string-to-number (match-string 2 number))
2996 least (if (match-beginning 3)
2997 (string-to-number (match-string 3 number))
3001 (format "%s00%02d%02d"
3002 (if (member alpha '("(ding)" "d"))
3006 (- (mm-char-int (aref (downcase alpha) 0))
3010 (format "%d.%02d%02d" major minor least))))))
3012 (defun gnus-info-find-node (&optional nodename)
3013 "Find Info documentation of Gnus."
3015 ;; Enlarge info window if needed.
3016 (let (gnus-info-buffer)
3017 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3018 (setq gnus-info-buffer (current-buffer))
3019 (gnus-configure-windows 'info)))
3022 ;;; gnus-interactive
3025 (defvar gnus-current-prefix-symbol nil
3026 "Current prefix symbol.")
3028 (defvar gnus-current-prefix-symbols nil
3029 "List of current prefix symbols.")
3031 (defun gnus-interactive (string &optional params)
3032 "Return a list that can be fed to `interactive'.
3033 See `interactive' for full documentation.
3035 Adds the following specs:
3037 y -- The current symbolic prefix.
3038 Y -- A list of the current symbolic prefix(es).
3039 A -- Article number.
3040 H -- Article header.
3044 (while (< i (length string))
3045 (string-match ".\\([^\n]*\\)\n?" string i)
3046 (setq c (aref string i))
3048 (setq prompt (match-string 1 string)))
3049 (setq i (match-end 0))
3050 ;; We basically emulate just about everything that
3051 ;; `interactive' does, but add the specs listed above.
3055 (completing-read prompt obarray 'fboundp t))
3057 (read-buffer prompt (current-buffer) t))
3059 (read-buffer prompt (other-buffer (current-buffer))))
3063 (completing-read prompt obarray 'commandp t))
3067 (read-file-name prompt nil default-directory 'lambda))
3069 (read-file-name prompt nil nil 'lambda))
3071 (read-file-name prompt))
3073 (read-key-sequence prompt))
3075 (error "Not implemented spec"))
3077 (error "Not implemented spec"))
3081 (error "Not implemented spec"))
3083 (string-to-number (read-from-minibuffer prompt)))
3085 (prefix-numeric-value current-prefix-arg))
3091 (read-string prompt))
3093 (intern (read-string prompt)))
3095 (read-variable prompt))
3097 (read-minibuffer prompt))
3099 (eval-minibuffer prompt))
3100 ;; And here the new specs come.
3102 gnus-current-prefix-symbol)
3104 gnus-current-prefix-symbols)
3106 (gnus-group-group-name))
3108 (gnus-summary-skip-intangible)
3109 (or (get-text-property (point) 'gnus-number)
3110 (gnus-summary-last-subject)))
3112 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3114 (error "Non-implemented spec")))
3118 (push (if (< (point) (mark)) (point) (mark)) out)
3119 (push (if (> (point) (mark)) (point) (mark)) out))))
3120 (setq out (delq 'gnus-prefix-nil out))
3123 (defun gnus-symbolic-argument (&optional arg)
3124 "Read a symbolic argument and a command, and then execute command."
3126 (let* ((in-command (this-command-keys))
3127 (command in-command)
3128 gnus-current-prefix-symbols
3129 gnus-current-prefix-symbol
3131 (while (equal in-command command)
3132 (message "%s-" (key-description (this-command-keys)))
3133 (push (intern (char-to-string (read-char))) syms)
3134 (setq command (read-key-sequence nil t)))
3135 (setq gnus-current-prefix-symbols (nreverse syms)
3136 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3137 (call-interactively (key-binding command t))))
3139 ;;; More various functions.
3141 (defsubst gnus-check-backend-function (func group)
3142 "Check whether GROUP supports function FUNC.
3143 GROUP can either be a string (a group name) or a select method."
3145 (let ((method (if (stringp group)
3146 (car (gnus-find-method-for-group group))
3148 (unless (featurep method)
3150 (fboundp (intern (format "%s-%s" method func))))))
3152 (defun gnus-group-read-only-p (&optional group)
3153 "Check whether GROUP supports editing or not.
3154 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3155 that that variable is buffer-local to the summary buffers."
3156 (let ((group (or group gnus-newsgroup-name)))
3157 (not (gnus-check-backend-function 'request-replace-article group))))
3159 (defun gnus-virtual-group-p (group)
3160 "Say whether GROUP is virtual or not."
3161 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3162 gnus-valid-select-methods)))
3164 (defun gnus-news-group-p (group &optional article)
3165 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3166 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3167 t) ;is news of course.
3168 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3169 nil) ;must be mail then.
3170 ((vectorp article) ;Has header info.
3171 (eq (gnus-request-type group (mail-header-id article)) 'news))
3172 ((null article) ;Hasn't header info
3173 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3174 ((< article 0) ;Virtual message
3175 nil) ;we don't know, guess mail.
3176 (t ;Has positive number
3177 (eq (gnus-request-type group article) 'news)))) ;use it.
3179 ;; Returns a list of writable groups.
3180 (defun gnus-writable-groups ()
3181 (let ((alist gnus-newsrc-alist)
3183 (while (setq group (car (pop alist)))
3184 (unless (gnus-group-read-only-p group)
3185 (push group groups)))
3188 ;; Check whether to use long file names.
3189 (defun gnus-use-long-file-name (symbol)
3190 ;; The variable has to be set...
3191 (and gnus-use-long-file-name
3192 ;; If it isn't a list, then we return t.
3193 (or (not (listp gnus-use-long-file-name))
3194 ;; If it is a list, and the list contains `symbol', we
3196 (not (memq symbol gnus-use-long-file-name)))))
3198 ;; Generate a unique new group name.
3199 (defun gnus-generate-new-group-name (leaf)
3202 (while (gnus-gethash name gnus-newsrc-hashtb)
3203 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3206 (defun gnus-ephemeral-group-p (group)
3207 "Say whether GROUP is ephemeral or not."
3208 (gnus-group-get-parameter group 'quit-config t))
3210 (defun gnus-group-quit-config (group)
3211 "Return the quit-config of GROUP."
3212 (gnus-group-get-parameter group 'quit-config t))
3214 (defun gnus-kill-ephemeral-group (group)
3215 "Remove ephemeral GROUP from relevant structures."
3216 (gnus-sethash group nil gnus-newsrc-hashtb))
3218 (defun gnus-simplify-mode-line ()
3219 "Make mode lines a bit simpler."
3220 (setq mode-line-modified (cdr gnus-mode-line-modified))
3221 (when (listp mode-line-format)
3222 (make-local-variable 'mode-line-format)
3223 (setq mode-line-format (copy-sequence mode-line-format))
3224 (when (equal (nth 3 mode-line-format) " ")
3225 (setcar (nthcdr 3 mode-line-format) " "))))
3227 ;;; Servers and groups.
3229 (defsubst gnus-server-add-address (method)
3230 (let ((method-name (symbol-name (car method))))
3231 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3232 (not (assq (intern (concat method-name "-address")) method))
3233 (memq 'physical-address (assq (car method)
3234 gnus-valid-select-methods)))
3235 (append method (list (list (intern (concat method-name "-address"))
3239 (defsubst gnus-server-to-method (server)
3240 "Map virtual server names to select methods."
3241 (or (and server (listp server) server)
3242 (cdr (assoc server gnus-server-method-cache))
3245 ;; Perhaps this is the native server?
3246 (and (equal server "native") gnus-select-method)
3247 ;; It should be in the server alist.
3248 (cdr (assoc server gnus-server-alist))
3249 ;; It could be in the predefined server alist.
3250 (cdr (assoc server gnus-predefined-server-alist))
3251 ;; If not, we look through all the opened server
3252 ;; to see whether we can find it there.
3253 (let ((opened gnus-opened-servers))
3255 (not (equal server (format "%s:%s" (caaar opened)
3259 ;; It could be a named method, search all servers
3260 (let ((servers gnus-secondary-select-methods))
3262 (not (equal server (format "%s:%s" (caar servers)
3266 ;; This could be some sort of foreign server that I
3267 ;; simply haven't opened (yet). Do a brute-force scan
3268 ;; of the entire gnus-newsrc-alist for the server name
3269 ;; of every method. As a side-effect, loads the
3270 ;; gnus-server-method-cache so this only happens once,
3275 (let ((info-method (gnus-info-method info)))
3276 (unless (stringp info-method)
3277 (let ((info-server (gnus-method-to-server info-method)))
3278 (when (equal server info-server)
3279 (setq match info-method))))))
3280 (cdr gnus-newsrc-alist))
3283 (push (cons server result) gnus-server-method-cache))
3286 (defsubst gnus-method-to-server (method)
3288 (setq method (or method gnus-select-method))
3290 ;; Perhaps it is already in the cache.
3291 (mapc (lambda (name-method)
3292 (if (equal (cdr name-method) method)
3293 (throw 'server-name (car name-method))))
3294 gnus-server-method-cache)
3297 (lambda (server-alist)
3298 (mapc (lambda (name-method)
3299 (when (gnus-methods-equal-p (cdr name-method) method)
3300 (unless (member name-method gnus-server-method-cache)
3301 (push name-method gnus-server-method-cache))
3302 (throw 'server-name (car name-method))))
3304 (let ((alists (list gnus-server-alist
3305 gnus-predefined-server-alist)))
3306 (if gnus-select-method
3307 (push (list (cons "native" gnus-select-method)) alists))
3310 (let* ((name (if (member (cadr method) '(nil ""))
3311 (format "%s" (car method))
3312 (format "%s:%s" (car method) (cadr method))))
3313 (name-method (cons name method)))
3314 (unless (member name-method gnus-server-method-cache)
3315 (push name-method gnus-server-method-cache))
3318 (defsubst gnus-server-get-method (group method)
3319 ;; Input either a server name, and extended server name, or a
3320 ;; select method, and return a select method.
3321 (cond ((stringp method)
3322 (gnus-server-to-method method))
3323 ((equal method gnus-select-method)
3325 ((and (stringp (car method))
3327 (gnus-server-extend-method group method))
3330 (equal (cadr method) ""))
3333 (gnus-server-add-address method))))
3335 (defmacro gnus-method-equal (ss1 ss2)
3336 "Say whether two servers are equal."
3340 (and (= (length s1) (length s2))
3342 (while (and s1 (member (car s1) s2))
3346 (defun gnus-methods-equal-p (m1 m2)
3347 (let ((m1 (or m1 gnus-select-method))
3348 (m2 (or m2 gnus-select-method)))
3350 (and (eq (car m1) (car m2))
3351 (or (not (memq 'address (assoc (symbol-name (car m1))
3352 gnus-valid-select-methods)))
3353 (equal (nth 1 m1) (nth 1 m2)))))))
3355 (defun gnus-server-equal (m1 m2)
3356 "Say whether two methods are equal."
3357 (let ((m1 (cond ((null m1) gnus-select-method)
3358 ((stringp m1) (gnus-server-to-method m1))
3360 (m2 (cond ((null m2) gnus-select-method)
3361 ((stringp m2) (gnus-server-to-method m2))
3363 (gnus-method-equal m1 m2)))
3365 (defun gnus-servers-using-backend (backend)
3366 "Return a list of known servers using BACKEND."
3367 (let ((opened gnus-opened-servers)
3370 (when (eq backend (caaar opened))
3371 (push (caar opened) out))
3375 (defun gnus-archive-server-wanted-p ()
3376 "Say whether the user wants to use the archive server."
3378 ((or (not gnus-message-archive-method)
3379 (not gnus-message-archive-group))
3381 ((and gnus-message-archive-method gnus-message-archive-group)
3384 (let ((active (cadr (assq 'nnfolder-active-file
3385 gnus-message-archive-method))))
3387 (file-exists-p active))))))
3389 (defsubst gnus-method-to-server-name (method)
3391 (format "%s" (car method))
3393 (or (assoc (format "%s" (car method))
3394 (gnus-methods-using 'address))
3395 (gnus-server-equal method gnus-message-archive-method))
3397 (not (string= (nth 1 method) "")))
3398 (concat "+" (nth 1 method)))))
3400 (defsubst gnus-method-to-full-server-name (method)
3401 (format "%s+%s" (car method) (nth 1 method)))
3403 (defun gnus-group-prefixed-name (group method &optional full)
3404 "Return the whole name from GROUP and METHOD.
3405 Call with full set to get the fully qualified group name (even if the
3407 (when (stringp method)
3408 (setq method (gnus-server-to-method method)))
3409 (if (or (not method)
3410 (and (not full) (gnus-server-equal method "native"))
3411 ;;;!!! This might not be right. We'll see...
3412 ;(string-match ":" group)
3415 (concat (gnus-method-to-server-name method) ":" group)))
3417 (defun gnus-group-guess-prefixed-name (group)
3418 "Guess the whole name from GROUP and METHOD."
3419 (gnus-group-prefixed-name group (gnus-find-method-for-group
3422 (defun gnus-group-full-name (group method)
3423 "Return the full name from GROUP and METHOD, even if the method is native."
3424 (gnus-group-prefixed-name group method t))
3426 (defun gnus-group-guess-full-name (group)
3427 "Guess the full name from GROUP, even if the method is native."
3428 (if (gnus-group-prefixed-p group)
3430 (gnus-group-full-name group (gnus-find-method-for-group group))))
3432 (defun gnus-group-guess-full-name-from-command-method (group)
3433 "Guess the full name from GROUP, even if the method is native."
3434 (if (gnus-group-prefixed-p group)
3436 (gnus-group-full-name group gnus-command-method)))
3438 (defun gnus-group-real-prefix (group)
3439 "Return the prefix of the current group name."
3441 (if (string-match "^[^:]+:" group)
3442 (substring group 0 (match-end 0))
3446 (defun gnus-group-short-name (group)
3447 "Return the short group name."
3448 (let ((prefix (gnus-group-real-prefix group)))
3449 (if (< 0 (length prefix))
3450 (substring group (length prefix) nil)
3453 (defun gnus-group-prefixed-p (group)
3454 "Return the prefix of the current group name."
3455 (< 0 (length (gnus-group-real-prefix group))))
3457 (defun gnus-summary-buffer-name (group)
3458 "Return the summary buffer name of GROUP."
3459 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3461 (defun gnus-group-method (group)
3462 "Return the server or method used for selecting GROUP.
3463 You should probably use `gnus-find-method-for-group' instead."
3464 (let ((prefix (gnus-group-real-prefix group)))
3465 (if (equal prefix "")
3467 (let ((servers gnus-opened-servers)
3469 backend possible found)
3470 (if (string-match "^[^\\+]+\\+" prefix)
3471 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3472 server (substring prefix (match-end 0) (1- (length prefix))))
3473 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3475 (when (eq (caaar servers) backend)
3476 (setq possible (caar servers))
3477 (when (equal (cadaar servers) server)
3478 (setq found (caar servers))))
3480 (or (car (rassoc found gnus-server-alist))
3482 (car (rassoc possible gnus-server-alist))
3484 (list backend server))))))
3486 (defsubst gnus-native-method-p (method)
3487 "Return whether METHOD is the native select method."
3488 (gnus-method-equal method gnus-select-method))
3490 (defsubst gnus-secondary-method-p (method)
3491 "Return whether METHOD is a secondary select method."
3492 (let ((methods gnus-secondary-select-methods)
3493 (gmethod (gnus-server-get-method nil method)))
3495 (not (gnus-method-equal
3496 (gnus-server-get-method nil (car methods))
3498 (setq methods (cdr methods)))
3501 (defun gnus-method-simplify (method)
3502 "Return the shortest uniquely identifying string or method for METHOD."
3503 (cond ((stringp method)
3505 ((gnus-native-method-p method)
3507 ((gnus-secondary-method-p method)
3508 (format "%s:%s" (nth 0 method) (nth 1 method)))
3512 (defun gnus-groups-from-server (server)
3513 "Return a list of all groups that are fetched from SERVER."
3514 (let ((alist (cdr gnus-newsrc-alist))
3516 (while (setq info (pop alist))
3517 (when (gnus-server-equal (gnus-info-method info) server)
3518 (push (gnus-info-group info) groups)))
3519 (sort groups 'string<)))
3521 (defun gnus-group-foreign-p (group)
3522 "Say whether a group is foreign or not."
3523 (and (not (gnus-group-native-p group))
3524 (not (gnus-group-secondary-p group))))
3526 (defun gnus-group-native-p (group)
3527 "Say whether the group is native or not."
3528 (not (string-match ":" group)))
3530 (defun gnus-group-secondary-p (group)
3531 "Say whether the group is secondary or not."
3532 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3534 (defun gnus-parameters-get-parameter (group)
3535 "Return the group parameters for GROUP from `gnus-parameters'."
3537 (dolist (elem gnus-parameters)
3538 (when (string-match (car elem) group)
3540 (nconc (gnus-expand-group-parameters
3541 (car elem) (cdr elem) group)
3545 (defun gnus-expand-group-parameter (match value group)
3546 "Use MATCH to expand VALUE in GROUP."
3549 (goto-char (point-min))
3550 (while (re-search-forward match nil t)
3551 (replace-match value))
3554 (defun gnus-expand-group-parameters (match parameters group)
3555 "Go through PARAMETERS and expand them according to the match data."
3557 (dolist (elem parameters)
3558 (if (and (stringp (cdr elem))
3559 (string-match "\\\\[0-9&]" (cdr elem)))
3560 (push (cons (car elem)
3561 (gnus-expand-group-parameter match (cdr elem) group))
3566 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3567 "For GROUP, return the value of SYMBOL.
3569 You should call this in the `gnus-group-buffer' buffer.
3570 The function `gnus-group-find-parameter' will do that for you."
3571 ;; The speed trick: No cons'ing and quit early.
3572 (let* ((params (funcall gnus-group-get-parameter-function group))
3573 ;; Start easy, check the "real" group parameters.
3575 (gnus-group-parameter-value params symbol allow-list t)))
3577 ;; Found results; return them.
3578 (car simple-results)
3579 ;; We didn't found it there, try `gnus-parameters'.
3582 (tail gnus-parameters))
3583 ;; A good old-fashioned non-cl loop.
3585 (setq head (car tail)
3587 ;; The car is regexp matching for matching the group name.
3588 (when (string-match (car head) group)
3589 ;; The cdr is the parameters.
3590 (setq result (gnus-group-parameter-value (cdr head)
3593 ;; Expand if necessary.
3594 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3595 (setq result (gnus-expand-group-parameter (car head)
3597 ;; Exit the loop early.
3602 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3603 "Return the group parameters for GROUP.
3604 If SYMBOL, return the value of that symbol in the group parameters.
3606 If you call this function inside a loop, consider using the faster
3607 `gnus-group-fast-parameter' instead."
3609 (set-buffer gnus-group-buffer)
3611 (gnus-group-fast-parameter group symbol allow-list)
3614 (funcall gnus-group-get-parameter-function group))
3615 (gnus-parameters-get-parameter group)))))
3617 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3618 "Return the group parameters for GROUP.
3619 If SYMBOL, return the value of that symbol in the group parameters.
3620 Most functions should use `gnus-group-find-parameter', which
3621 also examines the topic parameters."
3622 (let ((params (gnus-info-params (gnus-get-info group))))
3624 (gnus-group-parameter-value params symbol allow-list)
3627 (defun gnus-group-parameter-value (params symbol &optional
3628 allow-list present-p)
3629 "Return the value of SYMBOL in group PARAMS."
3630 ;; We only wish to return group parameters (dotted lists) and
3631 ;; not local variables, which may have the same names.
3632 ;; But first we handle single elements...
3633 (or (car (memq symbol params))
3637 (while (setq elem (pop params))
3638 (when (and (consp elem)
3639 (eq (car elem) symbol)
3642 (throw 'found (if present-p (list (cdr elem))
3645 (defun gnus-group-add-parameter (group param)
3646 "Add parameter PARAM to GROUP."
3647 (let ((info (gnus-get-info group)))
3649 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3650 ;; Cons the new param to the old one and update.
3651 (gnus-group-set-info (cons param (gnus-info-params info))
3654 (defun gnus-group-set-parameter (group name value)
3655 "Set parameter NAME to VALUE in GROUP."
3656 (let ((info (gnus-get-info group)))
3658 (gnus-group-remove-parameter group name)
3659 (let ((old-params (gnus-info-params info))
3660 (new-params (list (cons name value))))
3662 (when (or (not (listp (car old-params)))
3663 (not (eq (caar old-params) name)))
3664 (setq new-params (append new-params (list (car old-params)))))
3665 (setq old-params (cdr old-params)))
3666 (gnus-group-set-info new-params group 'params)))))
3668 (defun gnus-group-remove-parameter (group name)
3669 "Remove parameter NAME from GROUP."
3670 (let ((info (gnus-get-info group)))
3672 (let ((params (gnus-info-params info)))
3674 (setq params (delq name params))
3675 (while (assq name params)
3676 (gnus-pull name params))
3677 (gnus-info-set-params info params))))))
3679 (defun gnus-group-add-score (group &optional score)
3680 "Add SCORE to the GROUP score.
3681 If SCORE is nil, add 1 to the score of GROUP."
3682 (let ((info (gnus-get-info group)))
3684 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3686 (defun gnus-short-group-name (group &optional levels)
3687 "Collapse GROUP name LEVELS.
3688 Select methods are stripped and any remote host name is stripped down to
3689 just the host name."
3695 gnus-group-uncollapsed-levels
3697 (while (string-match "\\." group skip)
3698 (setq skip (match-end 0)
3701 ;; Separate foreign select method from group name and collapse.
3702 ;; If method contains a server, collapse to non-domain server name,
3703 ;; otherwise collapse to select method.
3704 (let* ((colon (string-match ":" group))
3705 (server (and colon (substring group 0 colon)))
3706 (plus (and server (string-match "+" server))))
3709 (setq foreign (substring server (+ 1 plus)
3710 (string-match "\\." server))
3711 group (substring group (+ 1 colon)))
3712 (setq foreign server
3713 group (substring group (+ 1 colon))))
3714 (setq foreign (concat foreign ":")))
3715 ;; Collapse group name leaving LEVELS uncollapsed elements
3716 (let* ((slist (split-string group "/"))
3717 (slen (length slist))
3718 (dlist (split-string group "\\."))
3719 (dlen (length dlist))
3731 (setq levels (- glen levels))
3733 (push (if (>= (decf levels) 0)
3734 (if (zerop (length g))
3739 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3741 (defun gnus-narrow-to-body ()
3742 "Narrow to the body of an article."
3745 (goto-char (point-min))
3746 (or (search-forward "\n\n" nil t)
3752 ;;; Kill file handling.
3755 (defun gnus-apply-kill-file ()
3756 "Apply a kill file to the current newsgroup.
3757 Returns the number of articles marked as read."
3758 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3759 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3760 (gnus-apply-kill-file-internal)
3763 (defun gnus-kill-save-kill-buffer ()
3764 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3765 (when (get-file-buffer file)
3767 (set-buffer (get-file-buffer file))
3768 (when (buffer-modified-p)
3770 (kill-buffer (current-buffer))))))
3772 (defcustom gnus-kill-file-name "KILL"
3773 "Suffix of the kill files."
3774 :group 'gnus-score-kill
3775 :group 'gnus-score-files
3778 (defun gnus-newsgroup-kill-file (newsgroup)
3779 "Return the name of a kill file name for NEWSGROUP.
3780 If NEWSGROUP is nil, return the global kill file name instead."
3782 ;; The global KILL file is placed at top of the directory.
3783 ((or (null newsgroup)
3784 (string-equal newsgroup ""))
3785 (expand-file-name gnus-kill-file-name
3786 gnus-kill-files-directory))
3787 ;; Append ".KILL" to newsgroup name.
3788 ((gnus-use-long-file-name 'not-kill)
3789 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3790 "." gnus-kill-file-name)
3791 gnus-kill-files-directory))
3792 ;; Place "KILL" under the hierarchical directory.
3794 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3795 "/" gnus-kill-file-name)
3796 gnus-kill-files-directory))))
3800 (defun gnus-member-of-valid (symbol group)
3801 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3803 (symbol-name (car (gnus-find-method-for-group group)))
3804 gnus-valid-select-methods)))
3806 (defun gnus-method-option-p (method option)
3807 "Return non-nil if select METHOD has OPTION as a parameter."
3808 (when (stringp method)
3809 (setq method (gnus-server-to-method method)))
3810 (memq option (assoc (format "%s" (car method))
3811 gnus-valid-select-methods)))
3813 (defun gnus-similar-server-opened (method)
3814 (let ((opened gnus-opened-servers))
3815 (while (and method opened)
3816 (when (and (equal (cadr method) (cadaar opened))
3817 (equal (car method) (caaar opened))
3818 (not (equal method (caar opened))))
3823 (defun gnus-server-extend-method (group method)
3824 ;; This function "extends" a virtual server. If the server is
3825 ;; "hello", and the select method is ("hello" (my-var "something"))
3826 ;; in the group "alt.alt", this will result in a new virtual server
3827 ;; called "hello+alt.alt".
3828 (if (or (not (inline (gnus-similar-server-opened method)))
3829 (not (cddr method)))
3831 `(,(car method) ,(concat (cadr method) "+" group)
3832 (,(intern (format "%s-address" (car method))) ,(cadr method))
3835 (defun gnus-server-status (method)
3836 "Return the status of METHOD."
3837 (nth 1 (assoc method gnus-opened-servers)))
3839 (defun gnus-group-name-to-method (group)
3840 "Guess a select method based on GROUP."
3841 (if (string-match ":" group)
3842 (let ((server (substring group 0 (match-beginning 0))))
3843 (if (string-match "\\+" server)
3844 (list (intern (substring server 0 (match-beginning 0)))
3845 (substring server (match-end 0)))
3846 (list (intern server) "")))
3847 gnus-select-method))
3849 (defun gnus-server-string (server)
3850 "Return a readable string that describes SERVER."
3851 (let* ((server (gnus-server-to-method server))
3852 (address (nth 1 server)))
3854 (not (zerop (length address))))
3855 (format "%s using %s" address (car server))
3856 (format "%s" (car server)))))
3858 (defun gnus-find-method-for-group (group &optional info)
3859 "Find the select method that GROUP uses."
3860 (or gnus-override-method
3863 (and (not (gnus-group-entry group)) ;; a new group
3864 (gnus-group-name-to-method group))
3865 (let ((info (or info (gnus-get-info group)))
3868 (not (setq method (gnus-info-method info)))
3869 (equal method "native"))
3872 (cond ((stringp method)
3873 (inline (gnus-server-to-method method)))
3874 ((stringp (cadr method))
3875 (inline (gnus-server-extend-method group method)))
3878 (cond ((equal (cadr method) "")
3880 ((null (cadr method))
3881 (list (car method) ""))
3883 (gnus-server-add-address method)))))))
3885 (defun gnus-methods-using (feature)
3886 "Find all methods that have FEATURE."
3887 (let ((valids gnus-valid-select-methods)
3890 (when (memq feature (car valids))
3891 (push (car valids) outs))
3892 (setq valids (cdr valids)))
3895 (defun gnus-read-group (prompt &optional default)
3896 "Prompt the user for a group name.
3897 Disallow invalid group names."
3902 gnus-invalid-group-regexp
3903 (setq group (read-string (concat prefix prompt)
3904 (cons (or default "") 0)
3905 'gnus-group-history)))
3906 (let ((match (match-string 0 group)))
3907 ;; `/' may be okay (e.g. for nnimap), so ask the user:
3908 (unless (and (string-match "/" match)
3910 "Proceed and create group anyway? " t
3911 "The group name \"" group "\" contains a forbidden character: \"" match "\".
3913 Usually, it's dangerous to create a group with this name, because it's not
3914 supported by all back ends and servers. On some IMAP servers, it's valid to
3915 use the character \"/\".
3917 If you are really sure, you can proceed anyway and create the group.
3919 You may customize the variable `gnus-invalid-group-regexp', which currently is
3920 set to \"" gnus-invalid-group-regexp
3921 "\", if you want to get rid of this query."))
3922 (setq prefix (format "Invalid group name: \"%s\". " group)
3926 (defun gnus-read-method (prompt)
3927 "Prompt the user for a method.
3928 Allow completion over sensible values."
3929 (let* ((open-servers
3930 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3931 gnus-opened-servers))
3934 (dolist (method gnus-valid-select-methods)
3935 (if (or (memq 'prompt-address method)
3936 (not (assoc (format "%s:" (car method)) open-servers)))
3937 (push method methods)))
3940 (append valid-methods
3942 gnus-predefined-server-alist
3947 nil t nil 'gnus-method-history)))
3950 (setq method gnus-select-method))
3951 ((assoc method gnus-valid-select-methods)
3952 (let ((address (if (memq 'prompt-address
3953 (assoc method gnus-valid-select-methods))
3954 (read-string "Address: ")
3956 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3957 (list (intern method) address))))
3958 ((assoc method servers)
3961 (list (intern method) "")))))
3965 (defun gnus-agent-method-p (method)
3966 "Say whether METHOD is covered by the agent."
3967 (or (eq (car gnus-agent-method-p-cache) method)
3968 (setq gnus-agent-method-p-cache
3970 (member (if (stringp method)
3972 (gnus-method-to-server method)) gnus-agent-covered-methods))))
3973 (cdr gnus-agent-method-p-cache))
3975 (defun gnus-online (method)
3978 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3979 (gnus-agent-method-p method))))
3981 ;;; User-level commands.
3984 (defun gnus-slave-no-server (&optional arg)
3985 "Read network news as a slave, without connecting to the local server."
3987 (gnus-no-server arg t))
3990 (defun gnus-no-server (&optional arg slave)
3992 If ARG is a positive number, Gnus will use that as the startup
3993 level. If ARG is nil, Gnus will be started at level 2. If ARG is
3994 non-nil and not a positive number, Gnus will prompt the user for the
3995 name of an NNTP server to use.
3996 As opposed to `gnus', this command will not connect to the local
3999 (gnus-no-server-1 arg slave))
4002 (defun gnus-slave (&optional arg)
4003 "Read news as a slave."
4005 (gnus arg nil 'slave))
4008 (defun gnus-other-frame (&optional arg display)
4009 "Pop up a frame to read news.
4010 This will call one of the Gnus commands which is specified by the user
4011 option `gnus-other-frame-function' (default `gnus') with the argument
4012 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4013 optional second argument DISPLAY should be a standard display string
4014 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4015 omitted or the function `make-frame-on-display' is not available, the
4016 current display is used."
4018 (if (fboundp 'make-frame-on-display)
4020 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4022 (let ((alive (gnus-alive-p)))
4027 (when (and (or (not display)
4029 (gnus-frame-or-window-display-name
4031 (with-current-buffer (window-buffer window)
4032 (string-match "\\`gnus-"
4033 (symbol-name major-mode))))
4034 (gnus-select-frame-set-input-focus
4035 (setq gnus-other-frame-object (window-frame window)))
4036 (select-window window)
4039 (gnus-select-frame-set-input-focus
4040 (setq gnus-other-frame-object
4042 (make-frame-on-display display gnus-other-frame-parameters)
4043 (make-frame gnus-other-frame-parameters))))
4045 (switch-to-buffer gnus-group-buffer)
4046 (funcall gnus-other-frame-function arg)
4047 (add-hook 'gnus-exit-gnus-hook
4049 (when (and (frame-live-p gnus-other-frame-object)
4051 (delete-frame gnus-other-frame-object))
4052 (setq gnus-other-frame-object nil)))))))
4054 ;;(setq thing ? ; this is a comment
4058 (defun gnus (&optional arg dont-connect slave)
4060 If ARG is non-nil and a positive number, Gnus will use that as the
4061 startup level. If ARG is non-nil and not a positive number, Gnus will
4062 prompt the user for the name of an NNTP server to use."
4064 (unless (byte-code-function-p (symbol-function 'gnus))
4065 (message "You should byte-compile Gnus")
4067 (gnus-1 arg dont-connect slave))
4069 ;; Allow redefinition of Gnus functions.
4075 ;;; gnus.el ends here