1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; 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)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)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)Summary 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 "0.3"
286 "Version number for this version of Gnus.")
288 (defconst gnus-version (format "No 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 (featurep 'gnus-xmas)
307 (defalias 'gnus-make-overlay 'make-overlay)
308 (defalias 'gnus-delete-overlay 'delete-overlay)
309 (defalias 'gnus-overlay-put 'overlay-put)
310 (defalias 'gnus-move-overlay 'move-overlay)
311 (defalias 'gnus-overlay-buffer 'overlay-buffer)
312 (defalias 'gnus-overlay-start 'overlay-start)
313 (defalias 'gnus-overlay-end 'overlay-end)
314 (defalias 'gnus-extent-detached-p 'ignore)
315 (defalias 'gnus-extent-start-open 'ignore)
316 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
317 (defalias 'gnus-character-to-event 'identity)
318 (defalias 'gnus-assq-delete-all 'assq-delete-all)
319 (defalias 'gnus-add-text-properties 'add-text-properties)
320 (defalias 'gnus-put-text-property 'put-text-property)
321 (defvar gnus-mode-line-image-cache t)
322 (if (fboundp 'find-image)
323 (defun gnus-mode-line-buffer-identification (line)
324 (let ((str (car-safe line)))
325 (if (and (stringp str)
326 (string-match "^Gnus:" str))
327 (progn (add-text-properties
330 (if (eq t gnus-mode-line-image-cache)
331 (setq gnus-mode-line-image-cache
333 '((:type xpm :file "gnus-pointer.xpm"
335 (:type xbm :file "gnus-pointer.xbm"
337 gnus-mode-line-image-cache)
340 gnus-version (gnus-emacs-version)))
344 (defalias 'gnus-mode-line-buffer-identification 'identity))
345 (defalias 'gnus-characterp 'numberp)
346 (defalias 'gnus-deactivate-mark 'deactivate-mark)
347 (defalias 'gnus-window-edges 'window-edges)
348 (defalias 'gnus-key-press-event-p 'numberp)
349 ;;(defalias 'gnus-decode-rfc1522 'ignore)
352 ;; We define these group faces here to avoid the display
353 ;; update forced when creating new faces.
355 (defface gnus-group-news-1-face
358 (:foreground "PaleTurquoise" :bold t))
361 (:foreground "ForestGreen" :bold t))
364 "Level 1 newsgroup face.")
366 (defface gnus-group-news-1-empty-face
369 (:foreground "PaleTurquoise"))
372 (:foreground "ForestGreen"))
375 "Level 1 empty newsgroup face.")
377 (defface gnus-group-news-2-face
380 (:foreground "turquoise" :bold t))
383 (:foreground "CadetBlue4" :bold t))
386 "Level 2 newsgroup face.")
388 (defface gnus-group-news-2-empty-face
391 (:foreground "turquoise"))
394 (:foreground "CadetBlue4"))
397 "Level 2 empty newsgroup face.")
399 (defface gnus-group-news-3-face
408 "Level 3 newsgroup face.")
410 (defface gnus-group-news-3-empty-face
419 "Level 3 empty newsgroup face.")
421 (defface gnus-group-news-4-face
430 "Level 4 newsgroup face.")
432 (defface gnus-group-news-4-empty-face
441 "Level 4 empty newsgroup face.")
443 (defface gnus-group-news-5-face
452 "Level 5 newsgroup face.")
454 (defface gnus-group-news-5-empty-face
463 "Level 5 empty newsgroup face.")
465 (defface gnus-group-news-6-face
474 "Level 6 newsgroup face.")
476 (defface gnus-group-news-6-empty-face
485 "Level 6 empty newsgroup face.")
487 (defface gnus-group-news-low-face
490 (:foreground "DarkTurquoise" :bold t))
493 (:foreground "DarkGreen" :bold t))
496 "Low level newsgroup face.")
498 (defface gnus-group-news-low-empty-face
501 (:foreground "DarkTurquoise"))
504 (:foreground "DarkGreen"))
507 "Low level empty newsgroup face.")
509 (defface gnus-group-mail-1-face
512 (:foreground "aquamarine1" :bold t))
515 (:foreground "DeepPink3" :bold t))
518 "Level 1 mailgroup face.")
520 (defface gnus-group-mail-1-empty-face
523 (:foreground "aquamarine1"))
526 (:foreground "DeepPink3"))
528 (:italic t :bold t)))
529 "Level 1 empty mailgroup face.")
531 (defface gnus-group-mail-2-face
534 (:foreground "aquamarine2" :bold t))
537 (:foreground "HotPink3" :bold t))
540 "Level 2 mailgroup face.")
542 (defface gnus-group-mail-2-empty-face
545 (:foreground "aquamarine2"))
548 (:foreground "HotPink3"))
551 "Level 2 empty mailgroup face.")
553 (defface gnus-group-mail-3-face
556 (:foreground "aquamarine3" :bold t))
559 (:foreground "magenta4" :bold t))
562 "Level 3 mailgroup face.")
564 (defface gnus-group-mail-3-empty-face
567 (:foreground "aquamarine3"))
570 (:foreground "magenta4"))
573 "Level 3 empty mailgroup face.")
575 (defface gnus-group-mail-low-face
578 (:foreground "aquamarine4" :bold t))
581 (:foreground "DeepPink4" :bold t))
584 "Low level mailgroup face.")
586 (defface gnus-group-mail-low-empty-face
589 (:foreground "aquamarine4"))
592 (:foreground "DeepPink4"))
595 "Low level empty mailgroup face.")
597 ;; Summary mode faces.
599 (defface gnus-summary-selected-face '((t
601 "Face used for selected articles.")
603 (defface gnus-summary-cancelled-face
605 (:foreground "yellow" :background "black")))
606 "Face used for cancelled articles.")
608 (defface gnus-summary-high-ticked-face
611 (:foreground "pink" :bold t))
614 (:foreground "firebrick" :bold t))
617 "Face used for high interest ticked articles.")
619 (defface gnus-summary-low-ticked-face
622 (:foreground "pink" :italic t))
625 (:foreground "firebrick" :italic t))
628 "Face used for low interest ticked articles.")
630 (defface gnus-summary-normal-ticked-face
633 (:foreground "pink"))
636 (:foreground "firebrick"))
639 "Face used for normal interest ticked articles.")
641 (defface gnus-summary-high-ancient-face
644 (:foreground "SkyBlue" :bold t))
647 (:foreground "RoyalBlue" :bold t))
650 "Face used for high interest ancient articles.")
652 (defface gnus-summary-low-ancient-face
655 (:foreground "SkyBlue" :italic t))
658 (:foreground "RoyalBlue" :italic t))
661 "Face used for low interest ancient articles.")
663 (defface gnus-summary-normal-ancient-face
666 (:foreground "SkyBlue"))
669 (:foreground "RoyalBlue"))
672 "Face used for normal interest ancient articles.")
674 (defface gnus-summary-high-undownloaded-face
677 (:bold t :foreground "cyan4"))
678 (((class color) (background dark))
679 (:bold t :foreground "LightGray"))
680 (t (:inverse-video t :bold t)))
681 "Face used for high interest uncached articles.")
683 (defface gnus-summary-low-undownloaded-face
686 (:italic t :foreground "cyan4" :bold nil))
687 (((class color) (background dark))
688 (:italic t :foreground "LightGray" :bold nil))
689 (t (:inverse-video t :italic t)))
690 "Face used for low interest uncached articles.")
692 (defface gnus-summary-normal-undownloaded-face
695 (:foreground "cyan4" :bold nil))
696 (((class color) (background dark))
697 (:foreground "LightGray" :bold nil))
698 (t (:inverse-video t)))
699 "Face used for normal interest uncached articles.")
701 (defface gnus-summary-high-unread-face
704 "Face used for high interest unread articles.")
706 (defface gnus-summary-low-unread-face
709 "Face used for low interest unread articles.")
711 (defface gnus-summary-normal-unread-face
714 "Face used for normal interest unread articles.")
716 (defface gnus-summary-high-read-face
719 (:foreground "PaleGreen"
723 (:foreground "DarkGreen"
727 "Face used for high interest read articles.")
729 (defface gnus-summary-low-read-face
732 (:foreground "PaleGreen"
736 (:foreground "DarkGreen"
740 "Face used for low interest read articles.")
742 (defface gnus-summary-normal-read-face
745 (:foreground "PaleGreen"))
748 (:foreground "DarkGreen"))
751 "Face used for normal interest read articles.")
758 (defvar gnus-buffers nil)
760 (defun gnus-get-buffer-create (name)
761 "Do the same as `get-buffer-create', but store the created buffer."
762 (or (get-buffer name)
763 (car (push (get-buffer-create name) gnus-buffers))))
765 (defun gnus-add-buffer ()
766 "Add the current buffer to the list of Gnus buffers."
767 (push (current-buffer) gnus-buffers))
769 (defmacro gnus-kill-buffer (buffer)
770 "Kill BUFFER and remove from the list of Gnus buffers."
771 `(let ((buf ,buffer))
772 (when (gnus-buffer-exists-p buf)
773 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
776 (defun gnus-buffers ()
777 "Return a list of live Gnus buffers."
778 (while (and gnus-buffers
779 (not (buffer-name (car gnus-buffers))))
781 (let ((buffers gnus-buffers))
783 (if (buffer-name (cadr buffers))
785 (setcdr buffers (cddr buffers)))))
790 (defvar gnus-group-buffer "*Group*")
793 (autoload 'gnus-play-jingle "gnus-audio"))
795 (defface gnus-splash-face
798 (:foreground "#888888"))
801 (:foreground "#888888"))
804 "Face for the splash screen.")
806 (defun gnus-splash ()
808 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
809 (let ((buffer-read-only nil))
811 (unless gnus-inhibit-startup-message
812 (gnus-group-startup-message)
814 (when gnus-play-startup-jingle
815 (gnus-play-jingle))))))
817 (defun gnus-indent-rigidly (start end arg)
818 "Indent rigidly using only spaces and no tabs."
821 (narrow-to-region start end)
823 (indent-rigidly start end arg)
824 ;; We translate tabs into spaces -- not everybody uses
825 ;; an 8-character tab.
826 (goto-char (point-min))
827 (while (search-forward "\t" nil t)
828 (replace-match " " t t))))))
830 (defvar gnus-simple-splash nil)
832 ;;(format "%02x%02x%02x" 114 66 20) "724214"
834 (defvar gnus-logo-color-alist
835 '((flame "#cc3300" "#ff2200")
836 (pine "#c0cc93" "#f8ffb8")
837 (moss "#a1cc93" "#d2ffb8")
838 (irish "#04cc90" "#05ff97")
839 (sky "#049acc" "#05deff")
840 (tin "#6886cc" "#82b6ff")
841 (velvet "#7c68cc" "#8c82ff")
842 (grape "#b264cc" "#cf7df")
843 (labia "#cc64c2" "#fd7dff")
844 (berry "#cc6485" "#ff7db5")
845 (dino "#724214" "#1e3f03")
846 (oort "#cccccc" "#888888")
847 (storm "#666699" "#99ccff")
848 (pdino "#9999cc" "#99ccff")
849 (purp "#9999cc" "#666699")
850 (no "#ff0000" "#ffff00")
851 (neutral "#b4b4b4" "#878787")
852 (september "#bf9900" "#ffcc00"))
853 "Color alist used for the Gnus logo.")
855 (defcustom gnus-logo-color-style 'no
856 "*Color styles used for the Gnus logo."
857 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
858 gnus-logo-color-alist))
861 (defvar gnus-logo-colors
862 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
863 "Colors used for the Gnus logo.")
865 (defun gnus-group-startup-message (&optional x y)
866 "Insert startup message in current buffer."
867 ;; Insert the message.
871 (fboundp 'find-image)
873 (let* ((data-directory (nnheader-find-etc-directory "gnus"))
875 `((:type xpm :file "gnus.xpm"
877 (("thing" . ,(car gnus-logo-colors))
878 ("shadow" . ,(cadr gnus-logo-colors))
880 ("background" . ,(face-background 'default))))
881 (:type pbm :file "gnus.pbm"
882 ;; Account for the pbm's blackground.
883 :background ,(face-foreground 'gnus-splash-face)
884 :foreground ,(face-background 'default))
885 (:type xbm :file "gnus.xbm"
886 ;; Account for the xbm's blackground.
887 :background ,(face-foreground 'gnus-splash-face)
888 :foreground ,(face-background 'default))))))
890 (let ((size (image-size image)))
891 (insert-char ?\n (max 0 (round (- (window-height)
892 (or y (cdr size)) 1) 2)))
893 (insert-char ?\ (max 0 (round (- (window-width)
894 (or x (car size))) 2)))
895 (insert-image image))
896 (setq gnus-simple-splash nil)
902 _ ___ __ ___ __ _ ___
922 (gnus-indent-rigidly (point-min) (point-max)
923 (/ (max (- (window-width) (or x 46)) 0) 2))
924 (goto-char (point-min))
926 (let* ((pheight (count-lines (point-min) (point-max)))
927 (wheight (window-height))
928 (rest (- wheight pheight)))
929 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
931 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
932 (setq gnus-simple-splash t)))
933 (goto-char (point-min))
934 (setq mode-line-buffer-identification (concat " " gnus-version))
935 (set-buffer-modified-p t))
938 (let ((command (format "%s" this-command)))
939 (when (string-match "gnus" command)
940 (if (string-match "gnus-other-frame" command)
941 (gnus-get-buffer-create gnus-group-buffer)
949 (defcustom gnus-parameters nil
950 "Alist of group parameters.
953 ((\"mail\\\\..*\" (gnus-show-threads nil)
954 (gnus-use-scoring nil)
955 (gnus-summary-line-format
956 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
959 (\"mail\\\\.me\" (gnus-use-scoring t))
960 (\"list\\\\..*\" (total-expire . t)
961 (broken-reply-to . t)))"
962 :group 'gnus-group-various
963 :type '(repeat (cons regexp
966 (defvar gnus-group-parameters-more nil)
968 (defmacro gnus-define-group-parameter (param &rest rest)
969 "Define a group parameter PARAM.
970 REST is a plist of following:
971 :type One of `bool', `list' or nil.
972 :function The name of the function.
973 :function-document The documentation of the function.
974 :parameter-type The type for customizing the parameter.
975 :parameter-document The documentation for the parameter.
976 :variable The name of the variable.
977 :variable-document The documentation for the variable.
978 :variable-group The group for customizing the variable.
979 :variable-type The type for customizing the variable.
980 :variable-default The default value of the variable."
981 (let* ((type (plist-get rest :type))
982 (parameter-type (plist-get rest :parameter-type))
983 (parameter-document (plist-get rest :parameter-document))
984 (function (or (plist-get rest :function)
985 (intern (format "gnus-parameter-%s" param))))
986 (function-document (or (plist-get rest :function-document) ""))
987 (variable (or (plist-get rest :variable)
988 (intern (format "gnus-parameter-%s-alist" param))))
989 (variable-document (or (plist-get rest :variable-document) ""))
990 (variable-group (plist-get rest :variable-group))
991 (variable-type (or (plist-get rest :variable-type)
993 (list (regexp :tag "Group")
994 ,(car (cdr parameter-type)))))))
995 (variable-default (plist-get rest :variable-default)))
998 `(defcustom ,variable ,variable-default
1000 :group 'gnus-group-parameter
1001 :group ',variable-group
1002 :type ,variable-type)
1003 `(setq gnus-group-parameters-more
1004 (delq (assq ',param gnus-group-parameters-more)
1005 gnus-group-parameters-more))
1006 `(add-to-list 'gnus-group-parameters-more
1009 ,parameter-document))
1011 `(defun ,function (name)
1013 (let ((params (gnus-group-find-parameter name))
1016 ((memq ',param params)
1018 ((setq val (assq ',param params))
1020 ((stringp ,variable)
1021 (string-match ,variable name))
1023 (let ((alist ,variable)
1025 (while (setq elem (pop alist))
1027 (string-match (car elem) name))
1030 (if (consp value) (car value) value))))))
1031 `(defun ,function (name)
1034 (or (gnus-group-find-parameter name ',param ,(and type t))
1035 (let ((alist ,variable)
1037 (while (setq elem (pop alist))
1039 (string-match (car elem) name))
1044 '(if (consp value) (car value) value))))))))))
1046 (defcustom gnus-home-directory "~/"
1047 "Directory variable that specifies the \"home\" directory.
1048 All other Gnus file and directory variables are initialized from this variable."
1052 (defcustom gnus-directory (or (getenv "SAVEDIR")
1053 (nnheader-concat gnus-home-directory "News/"))
1054 "*Directory variable from which all other Gnus file variables are derived.
1056 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1057 This means that other directory variables that are initialized from
1058 this variable won't be set properly if you set this variable in `.gnus.el'.
1059 Set this variable in `.emacs' instead."
1063 (defcustom gnus-default-directory nil
1064 "*Default directory for all Gnus buffers."
1066 :type '(choice (const :tag "current" nil)
1069 ;; Site dependent variables. These variables should be defined in
1072 (defvar gnus-default-nntp-server nil
1073 "Specify a default NNTP server.
1074 This variable should be defined in paths.el, and should never be set
1076 If you want to change servers, you should use `gnus-select-method'.
1077 See the documentation to that variable.")
1079 ;; Don't touch this variable.
1080 (defvar gnus-nntp-service "nntp"
1081 "NNTP service name (\"nntp\" or 119).
1082 This is an obsolete variable, which is scarcely used. If you use an
1083 nntp server for your newsgroup and want to change the port number
1084 used to 899, you would say something along these lines:
1086 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1088 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1089 "A file with only the name of the nntp server in it."
1094 (defun gnus-getenv-nntpserver ()
1095 "Find default nntp server.
1096 Check the NNTPSERVER environment variable and the
1097 `gnus-nntpserver-file' file."
1098 (or (getenv "NNTPSERVER")
1099 (and (file-readable-p gnus-nntpserver-file)
1101 (insert-file-contents gnus-nntpserver-file)
1102 (when (re-search-forward "[^ \t\n\r]+" nil t)
1103 (match-string 0))))))
1105 (defcustom gnus-select-method
1108 (list 'nntp (or (condition-case nil
1109 (gnus-getenv-nntpserver)
1111 (when (and gnus-default-nntp-server
1112 (not (string= gnus-default-nntp-server "")))
1113 gnus-default-nntp-server)
1115 (if (or (null gnus-nntp-service)
1116 (equal gnus-nntp-service "nntp"))
1118 (list gnus-nntp-service)))
1120 "Default method for selecting a newsgroup.
1121 This variable should be a list, where the first element is how the
1122 news is to be fetched, the second is the address.
1124 For instance, if you want to get your news via \"flab.flab.edu\" using
1125 NNTP, you could say:
1127 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1129 If you want to use your local spool, say:
1131 \(setq gnus-select-method (list 'nnspool (system-name)))
1133 If you use this variable, you must set `gnus-nntp-server' to nil.
1135 There is a lot more to know about select methods and virtual servers -
1136 see the manual for details."
1138 :type 'gnus-select-method)
1140 (defcustom gnus-message-archive-method "archive"
1141 "*Method used for archiving messages you've sent.
1142 This should be a mail method."
1144 :group 'gnus-message
1145 :type '(choice (const :tag "Default archive method" "archive")
1146 gnus-select-method))
1148 (defcustom gnus-message-archive-group nil
1149 "*Name of the group in which to save the messages you've written.
1150 This can either be a string; a list of strings; or an alist
1151 of regexps/functions/forms to be evaluated to return a string (or a list
1152 of strings). The functions are called with the name of the current
1153 group (or nil) as a parameter.
1155 If you want to save your mail in one group and the news articles you
1156 write in another group, you could say something like:
1158 \(setq gnus-message-archive-group
1159 '((if (message-news-p)
1163 Normally the group names returned by this variable should be
1164 unprefixed -- which implicitly means \"store on the archive server\".
1165 However, you may wish to store the message on some other server. In
1166 that case, just return a fully prefixed name of the group --
1167 \"nnml+private:mail.misc\", for instance."
1168 :group 'gnus-message
1169 :type '(choice (const :tag "none" nil)
1174 (defcustom gnus-secondary-servers nil
1175 "List of NNTP servers that the user can choose between interactively.
1176 To make Gnus query you for a server, you have to give `gnus' a
1177 non-numeric prefix - `C-u M-x gnus', in short."
1179 :type '(repeat string))
1181 (defcustom gnus-nntp-server nil
1182 "*The name of the host running the NNTP server.
1183 This variable is semi-obsolete. Use the `gnus-select-method'
1186 :type '(choice (const :tag "disable" nil)
1189 (defcustom gnus-secondary-select-methods nil
1190 "A list of secondary methods that will be used for reading news.
1191 This is a list where each element is a complete select method (see
1192 `gnus-select-method').
1194 If, for instance, you want to read your mail with the nnml back end,
1195 you could set this variable:
1197 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1199 :type '(repeat gnus-select-method))
1201 (defvar gnus-backup-default-subscribed-newsgroups
1202 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1203 "Default default new newsgroups the first time Gnus is run.
1204 Should be set in paths.el, and shouldn't be touched by the user.")
1206 (defcustom gnus-local-domain nil
1207 "Local domain name without a host name.
1208 The DOMAINNAME environment variable is used instead if it is defined.
1209 If the function `system-name' returns the full Internet name, there is
1210 no need to set this variable."
1211 :group 'gnus-message
1212 :type '(choice (const :tag "default" nil)
1215 (defvar gnus-local-organization nil
1216 "String with a description of what organization (if any) the user belongs to.
1217 Obsolete variable; use `message-user-organization' instead.")
1219 ;; Customization variables
1221 (defcustom gnus-refer-article-method nil
1222 "Preferred method for fetching an article by Message-ID.
1223 If you are reading news from the local spool (with nnspool), fetching
1224 articles by Message-ID is painfully slow. By setting this method to an
1225 nntp method, you might get acceptable results.
1227 The value of this variable must be a valid select method as discussed
1228 in the documentation of `gnus-select-method'.
1230 It can also be a list of select methods, as well as the special symbol
1231 `current', which means to use the current select method. If it is a
1232 list, Gnus will try all the methods in the list until it finds a match."
1234 :type '(choice (const :tag "default" nil)
1236 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1238 (repeat :menu-tag "Try multiple"
1240 :value (current (nnweb "refer" (nnweb-type google)))
1241 (choice :tag "Method"
1243 (const :tag "Google"
1244 (nnweb "refer" (nnweb-type google)))
1245 gnus-select-method))))
1247 (defcustom gnus-group-faq-directory
1248 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1249 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1250 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1251 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1252 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1253 "/ftp@rtfm.mit.edu:/pub/usenet/"
1254 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1255 "/ftp@ftp.sunet.se:/pub/usenet/"
1256 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1257 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1258 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1259 "*Directory where the group FAQs are stored.
1260 This will most commonly be on a remote machine, and the file will be
1261 fetched by ange-ftp.
1263 This variable can also be a list of directories. In that case, the
1264 first element in the list will be used by default. The others can
1265 be used when being prompted for a site.
1267 Note that Gnus uses an aol machine as the default directory. If this
1268 feels fundamentally unclean, just think of it as a way to finally get
1269 something of value back from them.
1271 If the default site is too slow, try one of these:
1273 North America: mirrors.aol.com /pub/rtfm/usenet
1274 ftp.seas.gwu.edu /pub/rtfm
1275 rtfm.mit.edu /pub/usenet
1276 Europe: ftp.uni-paderborn.de /pub/FAQ
1277 src.doc.ic.ac.uk /usenet/news-FAQS
1278 ftp.sunet.se /pub/usenet
1279 ftp.pasteur.fr /pub/FAQ
1280 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1281 hwarang.postech.ac.kr /pub/usenet
1282 ftp.hk.super.net /mirror/faqs"
1283 :group 'gnus-group-various
1284 :type '(choice directory
1285 (repeat directory)))
1287 (defcustom gnus-group-charter-alist
1288 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1289 ("de" . (concat "http://purl.net/charta/" name ".html"))
1290 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1291 ("england" . (concat "http://england.news-admin.org/charters/" name))
1292 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1293 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1294 (gnus-replace-in-string name "europa\\." "") ".html"))
1295 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1296 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1297 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1298 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1299 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1300 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1301 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1302 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1303 (gnus-replace-in-string name "\\." "_") ".html"))
1304 ("milw" . (concat "http://usenet.mil.wi.us/"
1305 (gnus-replace-in-string name "milw\\." "") "-charter"))
1306 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1307 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1308 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1309 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1310 When FORM is evaluated `name' is bound to the name of the group."
1311 :group 'gnus-group-various
1312 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1314 (defcustom gnus-group-fetch-control-use-browse-url nil
1315 "*Non-nil means that control messages are displayed using `browse-url'.
1316 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1318 :group 'gnus-group-various
1321 (defcustom gnus-use-cross-reference t
1322 "*Non-nil means that cross referenced articles will be marked as read.
1323 If nil, ignore cross references. If t, mark articles as read in
1324 subscribed newsgroups. If neither t nor nil, mark as read in all
1327 :type '(choice (const :tag "off" nil)
1328 (const :tag "subscribed" t)
1332 (defcustom gnus-process-mark ?#
1334 :group 'gnus-group-visual
1335 :group 'gnus-summary-marks
1338 (defcustom gnus-large-newsgroup 200
1339 "*The number of articles which indicates a large newsgroup.
1340 If the number of articles in a newsgroup is greater than this value,
1341 confirmation is required for selecting the newsgroup.
1342 If it is nil, no confirmation is required."
1343 :group 'gnus-group-select
1344 :type '(choice (const :tag "No limit" nil)
1347 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1348 "*Non-nil means that the default name of a file to save articles in is the group name.
1349 If it's nil, the directory form of the group name is used instead.
1351 If this variable is a list, and the list contains the element
1352 `not-score', long file names will not be used for score files; if it
1353 contains the element `not-save', long file names will not be used for
1354 saving; and if it contains the element `not-kill', long file names
1355 will not be used for kill files.
1357 Note that the default for this variable varies according to what system
1358 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1359 to nil while on all other systems it defaults to t."
1361 :type '(radio (sexp :format "Non-nil\n"
1362 :match (lambda (widget value)
1363 (and value (not (listp value))))
1366 (checklist (const :format "%v " not-score)
1367 (const :format "%v " not-save)
1370 (defcustom gnus-kill-files-directory gnus-directory
1371 "*Name of the directory where kill files will be stored (default \"~/News\")."
1372 :group 'gnus-score-files
1373 :group 'gnus-score-kill
1376 (defcustom gnus-save-score nil
1377 "*If non-nil, save group scoring info."
1378 :group 'gnus-score-various
1382 (defcustom gnus-use-undo t
1383 "*If non-nil, allow undoing in Gnus group mode buffers."
1387 (defcustom gnus-use-adaptive-scoring nil
1388 "*If non-nil, use some adaptive scoring scheme.
1389 If a list, then the values `word' and `line' are meaningful. The
1390 former will perform adaption on individual words in the subject
1391 header while `line' will perform adaption on several headers."
1393 :group 'gnus-score-adapt
1394 :type '(set (const word) (const line)))
1396 (defcustom gnus-use-cache 'passive
1397 "*If nil, Gnus will ignore the article cache.
1398 If `passive', it will allow entering (and reading) articles
1399 explicitly entered into the cache. If anything else, use the
1400 cache to the full extent of the law."
1403 :type '(choice (const :tag "off" nil)
1404 (const :tag "passive" passive)
1405 (const :tag "active" t)))
1407 (defcustom gnus-use-trees nil
1408 "*If non-nil, display a thread tree buffer."
1412 (defcustom gnus-keep-backlog 20
1413 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1414 If it is a number N, then Gnus will only keep the last N articles
1415 read. If it is neither nil nor a number, Gnus will keep all read
1416 articles. This is not a good idea."
1418 :type '(choice (const :tag "off" nil)
1423 (defcustom gnus-use-nocem nil
1424 "*If non-nil, Gnus will read NoCeM cancel messages."
1428 (defcustom gnus-suppress-duplicates nil
1429 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1433 (defcustom gnus-use-scoring t
1434 "*If non-nil, enable scoring."
1438 (defcustom gnus-summary-prepare-exit-hook
1439 '(gnus-summary-expire-articles)
1440 "*A hook called when preparing to exit from the summary buffer.
1441 It calls `gnus-summary-expire-articles' by default."
1442 :group 'gnus-summary-exit
1445 (defcustom gnus-novice-user t
1446 "*Non-nil means that you are a Usenet novice.
1447 If non-nil, verbose messages may be displayed and confirmations may be
1452 (defcustom gnus-expert-user nil
1453 "*Non-nil means that you will never be asked for confirmation about anything.
1454 That doesn't mean *anything* anything; particularly destructive
1455 commands will still require prompting."
1459 (defcustom gnus-interactive-catchup t
1460 "*If non-nil, require your confirmation when catching up a group."
1461 :group 'gnus-group-select
1464 (defcustom gnus-interactive-exit t
1465 "*If non-nil, require your confirmation when exiting Gnus."
1469 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1470 "*Function for extracting address components from a From header.
1471 Two pre-defined function exist: `gnus-extract-address-components',
1472 which is the default, quite fast, and too simplistic solution, and
1473 `mail-extract-address-components', which works much better, but is
1475 :group 'gnus-summary-format
1476 :type '(radio (function-item gnus-extract-address-components)
1477 (function-item mail-extract-address-components)
1478 (function :tag "Other")))
1480 (defcustom gnus-carpal nil
1481 "*If non-nil, display clickable icons."
1485 (defcustom gnus-shell-command-separator ";"
1486 "String used to separate shell commands."
1490 (defcustom gnus-valid-select-methods
1491 '(("nntp" post address prompt-address physical-address)
1492 ("nnspool" post address)
1493 ("nnvirtual" post-mail virtual prompt-address)
1494 ("nnmbox" mail respool address)
1495 ("nnml" post-mail respool address)
1496 ("nnmh" mail respool address)
1497 ("nndir" post-mail prompt-address physical-address)
1498 ("nneething" none address prompt-address physical-address)
1499 ("nndoc" none address prompt-address)
1500 ("nnbabyl" mail address respool)
1501 ("nnkiboze" post virtual)
1502 ("nnsoup" post-mail address)
1503 ("nndraft" post-mail)
1504 ("nnfolder" mail respool address)
1505 ("nngateway" post-mail address prompt-address physical-address)
1514 ("nnagent" post-mail)
1515 ("nnimap" post-mail address prompt-address physical-address)
1516 ("nnmaildir" mail respool address)
1518 "*An alist of valid select methods.
1519 The first element of each list lists should be a string with the name
1520 of the select method. The other elements may be the category of
1521 this method (i. e., `post', `mail', `none' or whatever) or other
1522 properties that this method has (like being respoolable).
1523 If you implement a new select method, all you should have to change is
1524 this variable. I think."
1526 :type '(repeat (group (string :tag "Name")
1527 (radio-button-choice (const :format "%v " post)
1528 (const :format "%v " mail)
1529 (const :format "%v " none)
1531 (checklist :inline t
1532 (const :format "%v " address)
1533 (const :format "%v " prompt-address)
1534 (const :format "%v " physical-address)
1535 (const :format "%v " virtual)
1538 (defun gnus-redefine-select-method-widget ()
1539 "Recomputes the select-method widget based on the value of
1540 `gnus-valid-select-methods'."
1541 (define-widget 'gnus-select-method 'list
1542 "Widget for entering a select method."
1544 :tag "Select Method"
1545 :args `((choice :tag "Method"
1546 ,@(mapcar (lambda (entry)
1547 (list 'const :format "%v\n"
1548 (intern (car entry))))
1549 gnus-valid-select-methods)
1550 (symbol :tag "other"))
1551 (string :tag "Address")
1552 (repeat :tag "Options"
1556 (sexp :tag "Value"))))))
1558 (gnus-redefine-select-method-widget)
1560 (defcustom gnus-updated-mode-lines '(group article summary tree)
1561 "List of buffers that should update their mode lines.
1562 The list may contain the symbols `group', `article', `tree' and
1563 `summary'. If the corresponding symbol is present, Gnus will keep
1564 that mode line updated with information that may be pertinent.
1565 If this variable is nil, screen refresh may be quicker."
1566 :group 'gnus-various
1567 :type '(set (const group)
1572 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1573 (defcustom gnus-mode-non-string-length nil
1574 "*Max length of mode-line non-string contents.
1575 If this is nil, Gnus will take space as is needed, leaving the rest
1576 of the mode line intact. Note that the default of nil is unlikely
1577 to be desirable; see the manual for further details."
1578 :group 'gnus-various
1579 :type '(choice (const nil)
1582 ;; There should be special validation for this.
1583 (define-widget 'gnus-email-address 'string
1584 "An email address.")
1586 (gnus-define-group-parameter
1589 "Return GROUP's to-address."
1591 "*Alist of group regexps and correspondent to-addresses."
1592 :parameter-type '(gnus-email-address :tag "To Address")
1593 :parameter-document "\
1594 This will be used when doing followups and posts.
1596 This is primarily useful in mail groups that represent closed
1597 mailing lists--mailing lists where it's expected that everybody that
1598 writes to the mailing list is subscribed to it. Since using this
1599 parameter ensures that the mail only goes to the mailing list itself,
1600 it means that members won't receive two copies of your followups.
1602 Using `to-address' will actually work whether the group is foreign or
1603 not. Let's say there's a group on the server that is called
1604 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1605 articles from a mail-to-news gateway. Posting directly to this group
1606 is therefore impossible--you have to send mail to the mailing list
1609 The gnus-group-split mail splitting mechanism will behave as if this
1610 address was listed in gnus-group-split Addresses (see below).")
1612 (gnus-define-group-parameter
1615 "Return GROUP's to-list."
1617 "*Alist of group regexps and correspondent to-lists."
1618 :parameter-type '(gnus-email-address :tag "To List")
1619 :parameter-document "\
1620 This address will be used when doing a `a' in the group.
1622 It is totally ignored when doing a followup--except that if it is
1623 present in a news group, you'll get mail group semantics when doing
1626 The gnus-group-split mail splitting mechanism will behave as if this
1627 address was listed in gnus-group-split Addresses (see below).")
1629 (gnus-define-group-parameter
1633 "Return GROUP's subscription status."
1635 "*Groups which are automatically considered subscribed."
1636 :parameter-type '(const :tag "Subscribed" t)
1637 :parameter-document "\
1638 Gnus assumed that you are subscribed to the To/List address.
1640 When constructing a list of subscribed groups using
1641 `gnus-find-subscribed-addresses', Gnus includes the To address given
1642 above, or the list address (if the To address has not been set).")
1644 (gnus-define-group-parameter
1647 :function gnus-group-auto-expirable-p
1649 "Check whether GROUP is auto-expirable or not."
1650 :variable gnus-auto-expirable-newsgroups
1651 :variable-default nil
1653 "*Groups in which to automatically mark read articles as expirable.
1654 If non-nil, this should be a regexp that should match all groups in
1655 which to perform auto-expiry. This only makes sense for mail groups."
1656 :variable-group nnmail-expire
1657 :variable-type '(choice (const nil)
1659 :parameter-type '(const :tag "Automatic Expire" t)
1661 "All articles that are read will be marked as expirable.")
1663 (gnus-define-group-parameter
1666 :function gnus-group-total-expirable-p
1668 "Check whether GROUP is total-expirable or not."
1669 :variable gnus-total-expirable-newsgroups
1670 :variable-default nil
1672 "*Groups in which to perform expiry of all read articles.
1673 Use with extreme caution. All groups that match this regexp will be
1674 expiring - which means that all read articles will be deleted after
1675 \(say) one week. (This only goes for mail groups and the like, of
1677 :variable-group nnmail-expire
1678 :variable-type '(choice (const nil)
1680 :parameter-type '(const :tag "Total Expire" t)
1682 "All read articles will be put through the expiry process
1684 This happens even if they are not marked as expirable.
1687 (gnus-define-group-parameter
1690 "Return the default charset of GROUP."
1691 :variable gnus-group-charset-alist
1693 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1694 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1695 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1696 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1697 ("\\(^\\|:\\)relcom\\>" koi8-r)
1698 ("\\(^\\|:\\)fido7\\>" koi8-r)
1699 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1700 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1701 ("\\(^\\|:\\)han\\>" euc-kr)
1702 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1703 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1704 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1706 "Alist of regexps (to match group names) and default charsets to be used when reading."
1707 :variable-group gnus-charset
1708 :variable-type '(repeat (list (regexp :tag "Group")
1709 (symbol :tag "Charset")))
1710 :parameter-type '(symbol :tag "Charset")
1711 :parameter-document "\
1712 The default charset to use in the group.")
1714 (gnus-define-group-parameter
1718 "Return a posting method for GROUP."
1719 :variable gnus-post-method-alist
1721 "Alist of regexps (to match group names) and method to be used when
1722 posting an article."
1723 :variable-group gnus-group-foreign
1725 '(choice :tag "Posting Method"
1726 (const :tag "Use native server" native)
1727 (const :tag "Use current server" current)
1728 (list :convert-widget
1730 (list 'sexp :tag "Methods"
1731 :value gnus-select-method))))
1733 "Posting method for this group.")
1735 (gnus-define-group-parameter
1736 large-newsgroup-initial
1739 "Return GROUP's initial input of the number of articles."
1741 "*Alist of group regexps and its initial input of the number of articles."
1742 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1743 (const :tag "All" nil)
1745 :parameter-document "\
1747 This number will be prompted as the initial value of the number of
1748 articles to list when the group is a large newsgroup (see
1749 `gnus-large-newsgroup'). If it is nil, the default value is the
1750 total number of articles in the group.")
1752 ;; The Gnus registry's ignored groups
1753 (gnus-define-group-parameter
1757 "Whether this group should be ignored by the registry."
1758 :variable gnus-registry-ignored-groups
1759 :variable-default nil
1761 "*Groups in which the registry should be turned off."
1762 :variable-group gnus-registry
1763 :variable-type '(repeat
1765 (regexp :tag "Group Name Regular Expression")
1766 (boolean :tag "Ignored")))
1768 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1770 "Whether the Gnus Registry should ignore this group.")
1772 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1773 (defcustom gnus-install-group-spam-parameters t
1774 "*Disable the group parameters for spam detection.
1775 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1779 (when gnus-install-group-spam-parameters
1780 (defvar gnus-group-spam-classification-spam t
1781 "Spam group classification (requires spam.el).
1782 This group contains spam messages. On summary entry, unread messages
1783 will be marked as spam. On summary exit, the specified spam
1784 processors will be invoked on spam-marked messages, then those
1785 messages will be expired, so the spam processor will only see a
1786 spam-marked message once.")
1788 (defvar gnus-group-spam-classification-ham 'ask
1789 "The ham value for the spam group parameter (requires spam.el).
1790 On summary exit, the specified ham processors will be invoked on
1791 ham-marked messages. Exercise caution, since the ham processor will
1792 see the same message more than once because there is no ham message
1795 (gnus-define-group-parameter
1799 "The spam type (spam, ham, or neither) of the group."
1800 :variable gnus-spam-newsgroup-contents
1801 :variable-default nil
1803 "*Groups in which to automatically mark new articles as spam on
1804 summary entry. If non-nil, this should be a list of group name
1805 regexps that should match all groups in which to do automatic spam
1806 tagging, associated with a classification (spam, ham, or neither).
1807 This only makes sense for mail groups."
1808 :variable-group spam
1809 :variable-type '(repeat
1810 (list :tag "Group contents spam/ham classification"
1811 (regexp :tag "Group")
1813 (variable-item gnus-group-spam-classification-spam)
1814 (variable-item gnus-group-spam-classification-ham)
1815 (const :tag "Unclassified" nil))))
1817 :parameter-type '(list :tag "Group contents spam/ham classification"
1818 (choice :tag "Group contents classification for spam sorting"
1819 (variable-item gnus-group-spam-classification-spam)
1820 (variable-item gnus-group-spam-classification-ham)
1821 (const :tag "Unclassified" nil)))
1823 "The spam classification (spam, ham, or neither) of this group.
1824 When a spam group is entered, all unread articles are marked as spam.")
1826 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1827 "OBSOLETE: The ifile summary exit spam processor.")
1829 (defvar gnus-group-spam-exit-processor-stat "stat"
1830 "OBSOLETE: The spam-stat summary exit spam processor.")
1832 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1833 "OBSOLETE: The Bogofilter summary exit spam processor.")
1835 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1836 "OBSOLETE: The Blacklist summary exit spam processor.")
1838 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1839 "OBSOLETE: The Gmane reporting summary exit spam processor.
1840 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1842 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1843 "OBSOLETE: The spamoracle summary exit spam processor.")
1845 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1846 "OBSOLETE: The ifile summary exit ham processor.
1847 Only applicable to non-spam (unclassified and ham) groups.")
1849 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1850 "OBSOLETE: The Bogofilter summary exit ham processor.
1851 Only applicable to non-spam (unclassified and ham) groups.")
1853 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1854 "OBSOLETE: The spam-stat summary exit ham processor.
1855 Only applicable to non-spam (unclassified and ham) groups.")
1857 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1858 "OBSOLETE: The whitelist summary exit ham processor.
1859 Only applicable to non-spam (unclassified and ham) groups.")
1861 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1862 "OBSOLETE: The BBDB summary exit ham processor.
1863 Only applicable to non-spam (unclassified and ham) groups.")
1865 (defvar gnus-group-ham-exit-processor-copy "copy"
1866 "OBSOLETE: The ham copy exit ham processor.
1867 Only applicable to non-spam (unclassified and ham) groups.")
1869 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1870 "OBSOLETE: The spamoracle summary exit ham processor.
1871 Only applicable to non-spam (unclassified and ham) groups.")
1873 (gnus-define-group-parameter
1878 :tag "Spam Summary Exit Processor"
1880 (list :tag "Spam Summary Exit Processor Choices"
1882 (variable-item gnus-group-spam-exit-processor-ifile)
1883 (variable-item gnus-group-spam-exit-processor-stat)
1884 (variable-item gnus-group-spam-exit-processor-bogofilter)
1885 (variable-item gnus-group-spam-exit-processor-blacklist)
1886 (variable-item gnus-group-spam-exit-processor-spamoracle)
1887 (variable-item gnus-group-spam-exit-processor-report-gmane)
1888 (variable-item gnus-group-ham-exit-processor-bogofilter)
1889 (variable-item gnus-group-ham-exit-processor-ifile)
1890 (variable-item gnus-group-ham-exit-processor-stat)
1891 (variable-item gnus-group-ham-exit-processor-whitelist)
1892 (variable-item gnus-group-ham-exit-processor-BBDB)
1893 (variable-item gnus-group-ham-exit-processor-spamoracle)
1894 (variable-item gnus-group-ham-exit-processor-copy)
1895 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1896 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1897 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
1898 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1899 (const :tag "Spam: ifile" (spam spam-use-ifile))
1900 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1901 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1902 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1903 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1904 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1905 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
1906 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1907 (const :tag "Ham: ifile" (ham spam-use-ifile))
1908 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
1909 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1910 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1911 (const :tag "Ham: Whitelist" (ham spam-use-whitelist)))))
1913 "Which spam or ham processors will be applied when the summary is exited."
1914 :variable gnus-spam-process-newsgroups
1915 :variable-default nil
1917 "*Groups in which to automatically process spam or ham articles with
1918 a backend on summary exit. If non-nil, this should be a list of group
1919 name regexps that should match all groups in which to do automatic
1920 spam processing, associated with the appropriate processor."
1921 :variable-group spam
1923 '(repeat :tag "Spam/Ham Processors"
1924 (list :tag "Spam Summary Exit Processor Choices"
1925 (regexp :tag "Group Regexp")
1927 :tag "Spam/Ham Summary Exit Processor"
1928 (variable-item gnus-group-spam-exit-processor-ifile)
1929 (variable-item gnus-group-spam-exit-processor-stat)
1930 (variable-item gnus-group-spam-exit-processor-bogofilter)
1931 (variable-item gnus-group-spam-exit-processor-blacklist)
1932 (variable-item gnus-group-spam-exit-processor-spamoracle)
1933 (variable-item gnus-group-spam-exit-processor-report-gmane)
1934 (variable-item gnus-group-ham-exit-processor-bogofilter)
1935 (variable-item gnus-group-ham-exit-processor-ifile)
1936 (variable-item gnus-group-ham-exit-processor-stat)
1937 (variable-item gnus-group-ham-exit-processor-whitelist)
1938 (variable-item gnus-group-ham-exit-processor-BBDB)
1939 (variable-item gnus-group-ham-exit-processor-spamoracle)
1940 (variable-item gnus-group-ham-exit-processor-copy)
1941 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1942 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1943 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
1944 (const :tag "Spam: ifile" (spam spam-use-ifile))
1945 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1946 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1947 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1948 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1949 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1950 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1951 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
1952 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1953 (const :tag "Ham: ifile" (ham spam-use-ifile))
1954 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1955 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
1956 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1957 (const :tag "Ham: Whitelist" (ham spam-use-whitelist)))))
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-gmane-xref)
1997 (variable-item spam-use-regex-headers)
1998 (variable-item spam-use-regex-body)
1999 (variable-item spam-use-whitelist)
2000 (variable-item spam-use-BBDB)
2001 (variable-item spam-use-ifile)
2002 (variable-item spam-use-spamoracle)
2003 (variable-item spam-use-spamassassin)
2004 (variable-item spam-use-spamassassin-headers)
2005 (variable-item spam-use-bsfilter)
2006 (variable-item spam-use-bsfilter-headers)
2007 (variable-item spam-use-stat)
2008 (variable-item spam-use-blackholes)
2009 (variable-item spam-use-hashcash)
2010 (variable-item spam-use-bogofilter-headers)
2011 (variable-item spam-use-bogofilter)))
2013 "Methods to be used for autodetection in each group"
2014 :variable gnus-spam-autodetect-methods
2015 :variable-default nil
2017 "*Methods for autodetecting spam per group.
2018 Requires the spam-autodetect parameter. Only unseen articles
2019 will be examined, unless spam-autodetect-recheck-messages is
2021 :variable-group spam
2024 :tag "Autodetection methods"
2026 (regexp :tag "Group Regexp")
2030 (set :tag "Use specific methods"
2031 (variable-item spam-use-blacklist)
2032 (variable-item spam-use-gmane-xref)
2033 (variable-item spam-use-regex-headers)
2034 (variable-item spam-use-regex-body)
2035 (variable-item spam-use-whitelist)
2036 (variable-item spam-use-BBDB)
2037 (variable-item spam-use-ifile)
2038 (variable-item spam-use-spamoracle)
2039 (variable-item spam-use-stat)
2040 (variable-item spam-use-blackholes)
2041 (variable-item spam-use-hashcash)
2042 (variable-item spam-use-spamassassin)
2043 (variable-item spam-use-spamassassin-headers)
2044 (variable-item spam-use-bsfilter)
2045 (variable-item spam-use-bsfilter-headers)
2046 (variable-item spam-use-bogofilter-headers)
2047 (variable-item spam-use-bogofilter)))))
2049 "Spam autodetection methods.
2050 Requires the spam-autodetect parameter. Only unseen articles
2051 will be examined, unless spam-autodetect-recheck-messages is
2054 (gnus-define-group-parameter
2055 spam-process-destination
2058 '(choice :tag "Destination for spam-processed articles at summary exit"
2059 (string :tag "Move to a group")
2060 (repeat :tag "Move to multiple groups"
2061 (string :tag "Destination group"))
2062 (const :tag "Expire" nil))
2064 "Where spam-processed articles will go at summary exit."
2065 :variable gnus-spam-process-destinations
2066 :variable-default nil
2068 "*Groups in which to explicitly send spam-processed articles to
2069 another group, or expire them (the default). If non-nil, this should
2070 be a list of group name regexps that should match all groups in which
2071 to do spam-processed article moving, associated with the destination
2072 group or nil for explicit expiration. This only makes sense for
2074 :variable-group spam
2077 :tag "Spam-processed articles destination"
2079 (regexp :tag "Group Regexp")
2081 :tag "Destination for spam-processed articles at summary exit"
2082 (string :tag "Move to a group")
2083 (repeat :tag "Move to multiple groups"
2084 (string :tag "Destination group"))
2085 (const :tag "Expire" nil))))
2087 "Where spam-processed articles will go at summary exit.")
2089 (gnus-define-group-parameter
2090 ham-process-destination
2094 :tag "Destination for ham articles at summary exit from a spam group"
2095 (string :tag "Move to a group")
2096 (repeat :tag "Move to multiple groups"
2097 (string :tag "Destination group"))
2098 (const :tag "Respool" respool)
2099 (const :tag "Do nothing" nil))
2101 "Where ham articles will go at summary exit from a spam group."
2102 :variable gnus-ham-process-destinations
2103 :variable-default nil
2105 "*Groups in which to explicitly send ham articles to
2106 another group, or do nothing (the default). If non-nil, this should
2107 be a list of group name regexps that should match all groups in which
2108 to do ham article moving, associated with the destination
2109 group or nil for explicit ignoring. This only makes sense for
2110 mail groups, and only works in spam groups."
2111 :variable-group spam
2114 :tag "Ham articles destination"
2116 (regexp :tag "Group Regexp")
2118 :tag "Destination for ham articles at summary exit from spam group"
2119 (string :tag "Move to a group")
2120 (repeat :tag "Move to multiple groups"
2121 (string :tag "Destination group"))
2122 (const :tag "Respool" respool)
2123 (const :tag "Expire" nil))))
2125 "Where ham articles will go at summary exit from a spam group.")
2127 (gnus-define-group-parameter
2130 :parameter-type '(list :tag "Ham mark choices"
2132 (variable-item gnus-del-mark)
2133 (variable-item gnus-read-mark)
2134 (variable-item gnus-ticked-mark)
2135 (variable-item gnus-killed-mark)
2136 (variable-item gnus-kill-file-mark)
2137 (variable-item gnus-low-score-mark)))
2140 "Marks considered ham (positively not spam). Such articles will be
2141 processed as ham (non-spam) on group exit. When nil, the global
2142 spam-ham-marks variable takes precedence."
2143 :variable-default '((".*" ((gnus-del-mark
2147 gnus-low-score-mark))))
2148 :variable-group spam
2150 "*Groups in which to explicitly set the ham marks to some value.")
2152 (gnus-define-group-parameter
2155 :parameter-type '(list :tag "Spam mark choices"
2157 (variable-item gnus-spam-mark)
2158 (variable-item gnus-killed-mark)
2159 (variable-item gnus-kill-file-mark)
2160 (variable-item gnus-low-score-mark)))
2163 "Marks considered spam.
2164 Such articles will be processed as spam on group exit. When nil, the global
2165 spam-spam-marks variable takes precedence."
2166 :variable-default '((".*" ((gnus-spam-mark))))
2167 :variable-group spam
2169 "*Groups in which to explicitly set the spam marks to some value."))
2171 (defcustom gnus-group-uncollapsed-levels 1
2172 "Number of group name elements to leave alone when making a short group name."
2173 :group 'gnus-group-visual
2176 (defcustom gnus-group-use-permanent-levels nil
2177 "*If non-nil, once you set a level, Gnus will use this level."
2178 :group 'gnus-group-levels
2183 (defcustom gnus-load-hook nil
2184 "A hook run while Gnus is loaded."
2188 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2189 "A hook called to apply kill files to a group.
2190 This hook is intended to apply a kill file to the selected newsgroup.
2191 The function `gnus-apply-kill-file' is called by default.
2193 Since a general kill file is too heavy to use only for a few
2194 newsgroups, I recommend you to use a lighter hook function. For
2195 example, if you'd like to apply a kill file to articles which contains
2196 a string `rmgroup' in subject in newsgroup `control', you can use the
2199 (setq gnus-apply-kill-hook
2202 (cond ((string-match \"control\" gnus-newsgroup-name)
2203 (gnus-kill \"Subject\" \"rmgroup\")
2204 (gnus-expunge \"X\"))))))"
2205 :group 'gnus-score-kill
2206 :options '(gnus-apply-kill-file)
2209 (defcustom gnus-group-change-level-function nil
2210 "Function run when a group level is changed.
2211 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2212 :group 'gnus-group-levels
2217 (defcustom gnus-visual
2218 '(summary-highlight group-highlight article-highlight
2220 summary-menu group-menu article-menu
2221 tree-highlight menu highlight
2222 browse-menu server-menu
2223 page-marker tree-menu binary-menu pick-menu)
2224 "*Enable visual features.
2225 If `visual' is disabled, there will be no menus and few faces. Most of
2226 the visual customization options below will be ignored. Gnus will use
2227 less space and be faster as a result.
2229 This variable can also be a list of visual elements to switch on. For
2230 instance, to switch off all visual things except menus, you can say:
2232 (setq gnus-visual '(menu))
2234 Valid elements include `summary-highlight', `group-highlight',
2235 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2236 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2237 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2240 :type '(set (const summary-highlight)
2241 (const group-highlight)
2242 (const article-highlight)
2244 (const summary-menu)
2246 (const article-menu)
2247 (const tree-highlight)
2257 ;; Byte-compiler warning.
2258 (defvar gnus-visual)
2259 ;; Find out whether the gnus-visual TYPE is wanted.
2260 (defun gnus-visual-p (&optional type class)
2261 (and gnus-visual ; Has to be non-nil, at least.
2262 (if (not type) ; We don't care about type.
2264 (if (listp gnus-visual) ; It's a list, so we check it.
2265 (or (memq type gnus-visual)
2266 (memq class gnus-visual))
2269 (defcustom gnus-mouse-face
2271 (if (gnus-visual-p 'mouse-face 'highlight)
2272 (if (boundp 'gnus-mouse-face)
2273 (or gnus-mouse-face 'highlight)
2277 "*Face used for group or summary buffer mouse highlighting.
2278 The line beneath the mouse pointer will be highlighted with this
2283 (defcustom gnus-article-save-directory gnus-directory
2284 "*Name of the directory articles will be saved in (default \"~/News\")."
2285 :group 'gnus-article-saving
2288 (defvar gnus-plugged t
2289 "Whether Gnus is plugged or not.")
2291 (defcustom gnus-agent-cache t
2292 "Controls use of the agent cache while plugged.
2293 When set, Gnus will prefer using the locally stored content rather
2294 than re-fetching it from the server. You also need to enable
2295 `gnus-agent' for this to have any affect."
2300 (defcustom gnus-default-charset 'undecided
2301 "Default charset assumed to be used when viewing non-ASCII characters.
2302 This variable is overridden on a group-to-group basis by the
2303 `gnus-group-charset-alist' variable and is only used on groups not
2304 covered by that variable."
2306 :group 'gnus-charset)
2308 ;; Fixme: Doc reference to agent.
2309 (defcustom gnus-agent t
2310 "Whether we want to use the Gnus agent or not.
2312 You may customize gnus-agent to disable its use. However, some
2313 back ends have started to use the agent as a client-side cache.
2314 Disabling the agent may result in noticeable loss of performance."
2319 (defcustom gnus-other-frame-function 'gnus
2320 "Function called by the command `gnus-other-frame'."
2322 :type '(choice (function-item gnus)
2323 (function-item gnus-no-server)
2324 (function-item gnus-slave)
2325 (function-item gnus-slave-no-server)))
2327 (defcustom gnus-other-frame-parameters nil
2328 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2329 This should be an alist for Emacs, or a plist for XEmacs."
2331 :type (if (featurep 'xemacs)
2332 '(repeat (list :inline t :format "%v"
2333 (symbol :tag "Property")
2334 (sexp :tag "Value")))
2335 '(repeat (cons :format "%v"
2336 (symbol :tag "Parameter")
2337 (sexp :tag "Value")))))
2339 (defcustom gnus-user-agent 'emacs-gnus-type
2340 "Which information should be exposed in the User-Agent header.
2342 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2343 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2344 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2345 `emacs-gnus' plus system type\) or a custom string. If you set it to a
2346 string, be sure to use a valid format, see RFC 2616."
2347 :group 'gnus-message
2349 (item :tag "Show Gnus and Emacs versions and system type"
2351 (item :tag "Show Gnus and Emacs versions and system configuration"
2353 (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2354 (item :tag "Show only Gnus version" gnus)
2355 (string :tag "Other")))
2358 ;;; Internal variables
2360 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2361 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2362 (defvar gnus-agent-method-p-cache nil
2363 ; Reset each time gnus-agent-covered-methods is changed else
2364 ; gnus-agent-method-p may mis-report a methods status.
2366 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2367 (defvar gnus-draft-meta-information-header "X-Draft-From")
2368 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2369 (defvar gnus-original-article-buffer " *Original Article*")
2370 (defvar gnus-newsgroup-name nil)
2371 (defvar gnus-ephemeral-servers nil)
2372 (defvar gnus-server-method-cache nil)
2374 (defvar gnus-agent-fetching nil
2375 "Whether Gnus agent is in fetching mode.")
2377 (defvar gnus-agent-covered-methods nil
2378 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2380 (defvar gnus-command-method nil
2381 "Dynamically bound variable that says what the current back end is.")
2383 (defvar gnus-current-select-method nil
2384 "The current method for selecting a newsgroup.")
2386 (defvar gnus-tree-buffer "*Tree*"
2387 "Buffer where Gnus thread trees are displayed.")
2390 (defvar gnus-use-generic-from nil)
2392 ;; Variable holding the user answers to all method prompts.
2393 (defvar gnus-method-history nil)
2395 ;; Variable holding the user answers to all mail method prompts.
2396 (defvar gnus-mail-method-history nil)
2398 ;; Variable holding the user answers to all group prompts.
2399 (defvar gnus-group-history nil)
2401 (defvar gnus-server-alist nil
2402 "List of available servers.")
2404 (defcustom gnus-cache-directory
2405 (nnheader-concat gnus-directory "cache/")
2406 "*The directory where cached articles will be stored."
2410 (defvar gnus-predefined-server-alist
2413 (nnspool-spool-directory ,gnus-cache-directory)
2414 (nnspool-nov-directory ,gnus-cache-directory)
2415 (nnspool-active-file
2416 ,(nnheader-concat gnus-cache-directory "active"))))
2417 "List of predefined (convenience) servers.")
2419 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2421 (defconst gnus-article-mark-lists
2422 '((marked . tick) (replied . reply)
2423 (expirable . expire) (killed . killed)
2424 (bookmarks . bookmark) (dormant . dormant)
2425 (scored . score) (saved . save)
2426 (cached . cache) (downloadable . download)
2427 (unsendable . unsend) (forwarded . forward)
2428 (recent . recent) (seen . seen)))
2430 (defconst gnus-article-special-mark-lists
2436 ;; Propagate flags to server, with the following exceptions:
2437 ;; `seen' is private to each gnus installation
2438 ;; `cache' is a internal gnus flag for each gnus installation
2439 ;; `download' is a agent flag private to each gnus installation
2440 ;; `unsend' are for nndraft groups only
2441 ;; `score' is not a proper mark
2442 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2443 (defconst gnus-article-unpropagated-mark-lists
2444 '(seen cache download unsend score bookmark)
2445 "Marks that shouldn't be propagated to back ends.
2446 Typical marks are those that make no sense in a standalone back end,
2447 such as a mark that says whether an article is stored in the cache
2448 \(which doesn't make sense in a standalone back end).")
2450 (defvar gnus-headers-retrieved-by nil)
2451 (defvar gnus-article-reply nil)
2452 (defvar gnus-override-method nil)
2453 (defvar gnus-article-check-size nil)
2454 (defvar gnus-opened-servers nil)
2456 (defvar gnus-current-kill-article nil)
2458 (defvar gnus-have-read-active-file nil)
2460 (defconst gnus-maintainer
2461 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2462 "The mail address of the Gnus maintainers.")
2464 (defvar gnus-info-nodes
2465 '((gnus-group-mode "(gnus)Group Buffer")
2466 (gnus-summary-mode "(gnus)Summary Buffer")
2467 (gnus-article-mode "(gnus)Article Buffer")
2468 (gnus-server-mode "(gnus)Server Buffer")
2469 (gnus-browse-mode "(gnus)Browse Foreign Server")
2470 (gnus-tree-mode "(gnus)Tree Display"))
2471 "Alist of major modes and related Info nodes.")
2473 (defvar gnus-group-buffer "*Group*")
2474 (defvar gnus-summary-buffer "*Summary*")
2475 (defvar gnus-article-buffer "*Article*")
2476 (defvar gnus-server-buffer "*Server*")
2478 (defvar gnus-slave nil
2479 "Whether this Gnus is a slave or not.")
2481 (defvar gnus-batch-mode nil
2482 "Whether this Gnus is running in batch mode or not.")
2484 (defvar gnus-variable-list
2485 '(gnus-newsrc-options gnus-newsrc-options-n
2486 gnus-newsrc-last-checked-date
2487 gnus-newsrc-alist gnus-server-alist
2488 gnus-killed-list gnus-zombie-list
2489 gnus-topic-topology gnus-topic-alist
2491 "Gnus variables saved in the quick startup file.")
2493 (defvar gnus-newsrc-alist nil
2494 "Assoc list of read articles.
2495 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2497 (defvar gnus-registry-alist nil
2498 "Assoc list of registry data.
2499 gnus-registry.el will populate this if it's loaded.")
2501 (defvar gnus-newsrc-hashtb nil
2502 "Hashtable of `gnus-newsrc-alist'.")
2504 (defvar gnus-killed-list nil
2505 "List of killed newsgroups.")
2507 (defvar gnus-killed-hashtb nil
2508 "Hash table equivalent of `gnus-killed-list'.")
2510 (defvar gnus-zombie-list nil
2511 "List of almost dead newsgroups.")
2513 (defvar gnus-description-hashtb nil
2514 "Descriptions of newsgroups.")
2516 (defvar gnus-list-of-killed-groups nil
2517 "List of newsgroups that have recently been killed by the user.")
2519 (defvar gnus-active-hashtb nil
2520 "Hashtable of active articles.")
2522 (defvar gnus-moderated-hashtb nil
2523 "Hashtable of moderated newsgroups.")
2525 ;; Save window configuration.
2526 (defvar gnus-prev-winconf nil)
2528 (defvar gnus-reffed-article-number nil)
2530 ;;; Let the byte-compiler know that we know about this variable.
2531 (defvar rmail-default-rmail-file)
2533 (defvar gnus-dead-summary nil)
2535 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2536 "Regexp matching invalid groups.")
2538 (defvar gnus-other-frame-object nil
2539 "A frame object which will be created by `gnus-other-frame'.")
2541 ;;; End of variables.
2543 ;; Define some autoload functions Gnus might use.
2546 ;; This little mapcar goes through the list below and marks the
2547 ;; symbols in question as autoloaded functions.
2550 (let ((interactive (nth 1 (memq ':interactive package))))
2554 (when (consp function)
2555 (setq keymap (car (memq 'keymap function)))
2556 (setq function (car function)))
2557 (unless (fboundp function)
2558 (autoload function (car package) nil interactive keymap))))
2559 (if (eq (nth 1 package) ':interactive)
2562 '(("info" :interactive t Info-goto-node)
2564 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2565 ("ps-print" ps-print-preprint)
2566 ("message" :interactive t
2567 message-send-and-exit message-yank-original)
2568 ("babel" babel-as-string)
2569 ("nnmail" nnmail-split-fancy nnmail-article-group)
2570 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2571 ("rmailout" rmail-output rmail-output-to-rmail-file)
2572 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2573 rmail-show-message rmail-summary-exists
2574 rmail-select-summary rmail-update-summary)
2575 ("gnus-audio" :interactive t gnus-audio-play)
2576 ("gnus-xmas" gnus-xmas-splash)
2577 ("gnus-soup" :interactive t
2578 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2579 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2580 ("nnsoup" nnsoup-pack-replies)
2581 ("score-mode" :interactive t gnus-score-mode)
2582 ("gnus-mh" gnus-summary-save-article-folder
2583 gnus-Folder-save-name gnus-folder-save-name)
2584 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2585 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2586 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2587 gnus-demon-add-disconnection gnus-demon-add-handler
2588 gnus-demon-remove-handler)
2589 ("gnus-demon" :interactive t
2590 gnus-demon-init gnus-demon-cancel)
2591 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2592 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2593 gnus-face-from-file)
2594 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2595 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2596 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2597 gnus-nocem-unwanted-article-p)
2598 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2599 gnus-server-server-name)
2600 ("gnus-srvr" gnus-browse-foreign-server)
2601 ("gnus-cite" :interactive t
2602 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2603 gnus-article-hide-citation gnus-article-fill-cited-article
2604 gnus-article-hide-citation-in-followups)
2605 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2606 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2607 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2608 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2609 gnus-cache-possibly-remove-articles gnus-cache-request-article
2610 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2611 gnus-cache-enter-remove-article gnus-cached-article-p
2612 gnus-cache-open gnus-cache-close gnus-cache-update-article
2613 gnus-cache-articles-in-group)
2614 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2615 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2616 ("gnus-score" :interactive t
2617 gnus-summary-increase-score gnus-summary-set-score
2618 gnus-summary-raise-thread gnus-summary-raise-same-subject
2619 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2620 gnus-summary-lower-thread gnus-summary-lower-same-subject
2621 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2622 gnus-summary-current-score gnus-score-delta-default
2623 gnus-score-flush-cache gnus-score-close
2624 gnus-possibly-score-headers gnus-score-followup-article
2625 gnus-score-followup-thread)
2627 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2628 gnus-current-score-file-nondirectory gnus-score-adaptive
2629 gnus-score-find-trace gnus-score-file-name)
2630 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2631 ("gnus-topic" :interactive t gnus-topic-mode)
2632 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2633 gnus-subscribe-topics)
2634 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2635 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2636 ("gnus-uu" :interactive t
2637 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2638 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2639 gnus-uu-mark-by-regexp gnus-uu-mark-all
2640 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2641 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2642 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2643 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2644 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2645 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2646 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2647 gnus-uu-mark-over gnus-uu-post-news)
2648 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2649 ("gnus-msg" (gnus-summary-send-map keymap)
2650 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2651 ("gnus-msg" :interactive t
2652 gnus-group-post-news gnus-group-mail gnus-group-news
2653 gnus-summary-post-news gnus-summary-news-other-window
2654 gnus-summary-followup gnus-summary-followup-with-original
2655 gnus-summary-cancel-article gnus-summary-supersede-article
2656 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2657 gnus-summary-mail-forward gnus-summary-mail-other-window
2658 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2659 gnus-summary-wide-reply gnus-summary-followup-to-mail
2660 gnus-summary-followup-to-mail-with-original gnus-bug
2661 gnus-summary-wide-reply-with-original
2662 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2663 gnus-summary-post-forward)
2664 ("gnus-picon" :interactive t gnus-treat-from-picon)
2665 ("smiley" :interactive t smiley-region)
2666 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2667 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2668 gnus-list-of-unread-articles gnus-list-of-read-articles
2669 gnus-offer-save-summaries gnus-make-thread-indent-array
2670 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2671 gnus-summary-skip-intangible gnus-summary-article-number
2672 gnus-data-header gnus-data-find)
2673 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2674 gnus-group-list-groups gnus-group-first-unread-group
2675 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2676 gnus-group-setup-buffer gnus-group-get-new-news
2677 gnus-group-make-help-group gnus-group-update-group
2678 gnus-group-iterate gnus-group-group-name)
2679 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2680 gnus-backlog-remove-article)
2681 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2682 gnus-article-prepare gnus-article-set-window-start
2683 gnus-article-next-page gnus-article-prev-page
2684 gnus-request-article-this-buffer gnus-article-mode
2685 gnus-article-setup-buffer gnus-narrow-to-page
2686 gnus-article-delete-invisible-text gnus-treat-article)
2687 ("gnus-art" :interactive t
2688 gnus-article-hide-headers gnus-article-hide-boring-headers
2689 gnus-article-treat-overstrike
2690 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2691 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2692 gnus-article-de-base64-unreadable
2693 gnus-article-decode-HZ
2694 gnus-article-wash-html
2695 gnus-article-unsplit-urls
2696 gnus-article-hide-pem gnus-article-hide-signature
2697 gnus-article-strip-leading-blank-lines gnus-article-date-local
2698 gnus-article-date-original gnus-article-date-lapsed
2699 ;; gnus-article-show-all-headers
2700 gnus-article-edit-mode gnus-article-edit-article
2701 gnus-article-edit-done gnus-article-decode-encoded-words
2702 gnus-start-date-timer gnus-stop-date-timer
2703 gnus-mime-view-all-parts)
2704 ("gnus-int" gnus-request-type)
2705 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2706 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2707 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2708 gnus-dup-enter-articles)
2709 ("gnus-range" gnus-copy-sequence)
2710 ("gnus-eform" gnus-edit-form)
2711 ("gnus-move" :interactive t
2712 gnus-group-move-group-to-server gnus-change-server)
2713 ("gnus-logic" gnus-score-advanced)
2714 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2715 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2716 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2717 gnus-async-halt-prefetch)
2718 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2719 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2720 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2721 gnus-summary-set-agent-mark gnus-agent-save-group-info
2722 gnus-agent-request-article gnus-agent-retrieve-headers)
2723 ("gnus-agent" :interactive t
2724 gnus-unplugged gnus-agentize gnus-agent-batch)
2725 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2726 gnus-summary-save-article-vm)
2727 ("compface" uncompface)
2728 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2729 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2730 ("gnus-mlspl" :interactive t gnus-group-split-setup
2731 gnus-group-split-update)
2732 ("gnus-delay" gnus-delay-initialize))))
2734 ;;; gnus-sum.el thingies
2737 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2738 "*The format specification of the lines in the summary buffer.
2740 It works along the same lines as a normal formatting string,
2741 with some simple extensions.
2743 %N Article number, left padded with spaces (string)
2745 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2746 %n Name of the poster (string)
2747 %a Extracted name of the poster (string)
2748 %A Extracted address of the poster (string)
2749 %F Contents of the From: header (string)
2750 %f Contents of the From: or To: headers (string)
2751 %x Contents of the Xref: header (string)
2752 %D Date of the article (string)
2753 %d Date of the article (string) in DD-MMM format
2754 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2755 %M Message-id of the article (string)
2756 %r References of the article (string)
2757 %c Number of characters in the article (integer)
2758 %k Pretty-printed version of the above (string)
2759 For example, \"1.2k\" or \"0.4M\".
2760 %L Number of lines in the article (integer)
2761 %I Indentation based on thread level (a string of spaces)
2762 %B A complex trn-style thread tree (string)
2763 The variables `gnus-sum-thread-*' can be used for customization.
2764 %T A string with two possible values: 80 spaces if the article
2765 is on thread level two or larger and 0 spaces on level one
2766 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2767 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2768 %[ Opening bracket (character, \"[\" or \"<\")
2769 %] Closing bracket (character, \"]\" or \">\")
2770 %> Spaces of length thread-level (string)
2771 %< Spaces of length (- 20 thread-level) (string)
2772 %i Article score (number)
2773 %z Article zcore (character)
2774 %t Number of articles under the current thread (number).
2775 %e Whether the thread is empty or not (character).
2776 %V Total thread score (number).
2777 %P The line number (number).
2778 %O Download mark (character).
2779 %* If present, indicates desired cursor position
2780 (instead of after first colon).
2781 %u User defined specifier. The next character in the format string should
2782 be a letter. Gnus will call the function gnus-user-format-function-X,
2783 where X is the letter following %u. The function will be passed the
2784 current header as argument. The function should return a string, which
2785 will be inserted into the summary just like information from any other
2788 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2789 with care. For reasons of efficiency, Gnus will compute what column
2790 these characters will end up in, and \"hard-code\" that. This means that
2791 it is invalid to have these specs after a variable-length spec. Well,
2792 you might not be arrested, but your summary buffer will look strange,
2793 which is bad enough.
2795 The smart choice is to have these specs as far to the left as
2798 This restriction may disappear in later versions of Gnus.
2800 General format specifiers can also be used.
2801 See Info node `(gnus)Formatting Variables'."
2802 :link '(custom-manual "(gnus)Formatting Variables")
2804 :group 'gnus-summary-format)
2807 ;;; Skeleton keymaps
2810 (defun gnus-suppress-keymap (keymap)
2811 (suppress-keymap keymap)
2812 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2814 (define-key keymap (pop keys) 'undefined))))
2816 (defvar gnus-article-mode-map
2817 (let ((keymap (make-sparse-keymap)))
2818 (gnus-suppress-keymap keymap)
2820 (defvar gnus-summary-mode-map
2821 (let ((keymap (make-keymap)))
2822 (gnus-suppress-keymap keymap)
2824 (defvar gnus-group-mode-map
2825 (let ((keymap (make-keymap)))
2826 (gnus-suppress-keymap keymap)
2831 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2832 ;; If you want the cursor to go somewhere else, set these two
2833 ;; functions in some startup hook to whatever you want.
2834 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2835 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2837 ;;; Various macros and substs.
2839 (defun gnus-header-from (header)
2840 (mail-header-from header))
2842 (defmacro gnus-gethash (string hashtable)
2843 "Get hash value of STRING in HASHTABLE."
2844 `(symbol-value (intern-soft ,string ,hashtable)))
2846 (defmacro gnus-gethash-safe (string hashtable)
2847 "Get hash value of STRING in HASHTABLE.
2848 Return nil if not defined."
2849 `(let ((sym (intern-soft ,string ,hashtable)))
2850 (and (boundp sym) (symbol-value sym))))
2852 (defmacro gnus-sethash (string value hashtable)
2853 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2854 `(set (intern ,string ,hashtable) ,value))
2855 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2857 (defmacro gnus-group-unread (group)
2858 "Get the currently computed number of unread articles in GROUP."
2859 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2861 (defmacro gnus-group-entry (group)
2862 "Get the newsrc entry for GROUP."
2863 `(gnus-gethash ,group gnus-newsrc-hashtb))
2865 (defmacro gnus-active (group)
2866 "Get active info on GROUP."
2867 `(gnus-gethash ,group gnus-active-hashtb))
2869 (defmacro gnus-set-active (group active)
2870 "Set GROUP's active info."
2871 `(gnus-sethash ,group ,active gnus-active-hashtb))
2873 ;; Info access macros.
2875 (defmacro gnus-info-group (info)
2877 (defmacro gnus-info-rank (info)
2879 (defmacro gnus-info-read (info)
2881 (defmacro gnus-info-marks (info)
2883 (defmacro gnus-info-method (info)
2885 (defmacro gnus-info-params (info)
2888 (defmacro gnus-info-level (info)
2889 `(let ((rank (gnus-info-rank ,info)))
2893 (defmacro gnus-info-score (info)
2894 `(let ((rank (gnus-info-rank ,info)))
2895 (or (and (consp rank) (cdr rank)) 0)))
2897 (defmacro gnus-info-set-group (info group)
2898 `(setcar ,info ,group))
2899 (defmacro gnus-info-set-rank (info rank)
2900 `(setcar (nthcdr 1 ,info) ,rank))
2901 (defmacro gnus-info-set-read (info read)
2902 `(setcar (nthcdr 2 ,info) ,read))
2903 (defmacro gnus-info-set-marks (info marks &optional extend)
2905 `(gnus-info-set-entry ,info ,marks 3)
2906 `(setcar (nthcdr 3 ,info) ,marks)))
2907 (defmacro gnus-info-set-method (info method &optional extend)
2909 `(gnus-info-set-entry ,info ,method 4)
2910 `(setcar (nthcdr 4 ,info) ,method)))
2911 (defmacro gnus-info-set-params (info params &optional extend)
2913 `(gnus-info-set-entry ,info ,params 5)
2914 `(setcar (nthcdr 5 ,info) ,params)))
2916 (defun gnus-info-set-entry (info entry number)
2917 ;; Extend the info until we have enough elements.
2918 (while (<= (length info) number)
2919 (nconc info (list nil)))
2921 (setcar (nthcdr number info) entry))
2923 (defmacro gnus-info-set-level (info level)
2924 `(let ((rank (cdr ,info)))
2925 (if (consp (car rank))
2926 (setcar (car rank) ,level)
2927 (setcar rank ,level))))
2928 (defmacro gnus-info-set-score (info score)
2929 `(let ((rank (cdr ,info)))
2930 (if (consp (car rank))
2931 (setcdr (car rank) ,score)
2932 (setcar rank (cons (car rank) ,score)))))
2934 (defmacro gnus-get-info (group)
2935 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2937 ;;; Load the compatibility functions.
2946 (defvar gnus-shutdown-alist nil)
2948 (defun gnus-add-shutdown (function &rest symbols)
2949 "Run FUNCTION whenever one of SYMBOLS is shut down."
2950 (push (cons function symbols) gnus-shutdown-alist))
2952 (defun gnus-shutdown (symbol)
2953 "Shut down everything that waits for SYMBOL."
2954 (let ((alist gnus-shutdown-alist)
2956 (while (setq entry (pop alist))
2957 (when (memq symbol (cdr entry))
2958 (funcall (car entry))))))
2962 ;;; Gnus Utility Functions
2965 (defun gnus-find-subscribed-addresses ()
2966 "Return a regexp matching the addresses of all subscribed mail groups.
2967 It consists of the `to-address' or `to-list' parameter of all groups
2968 with a `subscribed' parameter."
2969 (let (group address addresses)
2970 (dolist (entry (cdr gnus-newsrc-alist))
2971 (setq group (car entry))
2972 (when (gnus-parameter-subscribed group)
2973 (setq address (mail-strip-quoted-names
2974 (or (gnus-group-fast-parameter group 'to-address)
2975 (gnus-group-fast-parameter group 'to-list))))
2977 (add-to-list 'addresses address))))
2979 (list (mapconcat 'regexp-quote addresses "\\|")))))
2981 (defmacro gnus-string-or (&rest strings)
2982 "Return the first element of STRINGS that is a non-blank string.
2983 STRINGS will be evaluated in normal `or' order."
2984 `(gnus-string-or-1 ',strings))
2986 (defun gnus-string-or-1 (strings)
2989 (setq string (eval (pop strings)))
2990 (if (string-match "^[ \t]*$" string)
2992 (setq strings nil)))
2995 (defun gnus-version (&optional arg)
2996 "Version number of this version of Gnus.
2997 If ARG, insert string at point."
3000 (insert (message gnus-version))
3001 (message gnus-version)))
3003 (defun gnus-continuum-version (&optional version)
3004 "Return VERSION as a floating point number."
3007 (setq version gnus-version))
3008 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3009 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3010 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3011 (number (match-string 2 version))
3013 (unless (string-match
3014 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3015 (error "Invalid version string: %s" version))
3016 (setq major (string-to-number (match-string 1 number))
3017 minor (string-to-number (match-string 2 number))
3018 least (if (match-beginning 3)
3019 (string-to-number (match-string 3 number))
3023 (format "%s00%02d%02d"
3024 (if (member alpha '("(ding)" "d"))
3028 (- (mm-char-int (aref (downcase alpha) 0))
3032 (format "%d.%02d%02d" major minor least))))))
3034 (defun gnus-info-find-node (&optional nodename)
3035 "Find Info documentation of Gnus."
3037 ;; Enlarge info window if needed.
3038 (let (gnus-info-buffer)
3039 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3040 (setq gnus-info-buffer (current-buffer))
3041 (gnus-configure-windows 'info)))
3044 ;;; gnus-interactive
3047 (defvar gnus-current-prefix-symbol nil
3048 "Current prefix symbol.")
3050 (defvar gnus-current-prefix-symbols nil
3051 "List of current prefix symbols.")
3053 (defun gnus-interactive (string &optional params)
3054 "Return a list that can be fed to `interactive'.
3055 See `interactive' for full documentation.
3057 Adds the following specs:
3059 y -- The current symbolic prefix.
3060 Y -- A list of the current symbolic prefix(es).
3061 A -- Article number.
3062 H -- Article header.
3066 (while (< i (length string))
3067 (string-match ".\\([^\n]*\\)\n?" string i)
3068 (setq c (aref string i))
3070 (setq prompt (match-string 1 string)))
3071 (setq i (match-end 0))
3072 ;; We basically emulate just about everything that
3073 ;; `interactive' does, but add the specs listed above.
3077 (completing-read prompt obarray 'fboundp t))
3079 (read-buffer prompt (current-buffer) t))
3081 (read-buffer prompt (other-buffer (current-buffer))))
3085 (completing-read prompt obarray 'commandp t))
3089 (read-file-name prompt nil default-directory 'lambda))
3091 (read-file-name prompt nil nil 'lambda))
3093 (read-file-name prompt))
3095 (read-key-sequence prompt))
3097 (error "Not implemented spec"))
3099 (error "Not implemented spec"))
3103 (error "Not implemented spec"))
3105 (string-to-number (read-from-minibuffer prompt)))
3107 (prefix-numeric-value current-prefix-arg))
3113 (read-string prompt))
3115 (intern (read-string prompt)))
3117 (read-variable prompt))
3119 (read-minibuffer prompt))
3121 (eval-minibuffer prompt))
3122 ;; And here the new specs come.
3124 gnus-current-prefix-symbol)
3126 gnus-current-prefix-symbols)
3128 (gnus-group-group-name))
3130 (gnus-summary-skip-intangible)
3131 (or (get-text-property (point) 'gnus-number)
3132 (gnus-summary-last-subject)))
3134 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3136 (error "Non-implemented spec")))
3140 (push (if (< (point) (mark)) (point) (mark)) out)
3141 (push (if (> (point) (mark)) (point) (mark)) out))))
3142 (setq out (delq 'gnus-prefix-nil out))
3145 (defun gnus-symbolic-argument (&optional arg)
3146 "Read a symbolic argument and a command, and then execute command."
3148 (let* ((in-command (this-command-keys))
3149 (command in-command)
3150 gnus-current-prefix-symbols
3151 gnus-current-prefix-symbol
3153 (while (equal in-command command)
3154 (message "%s-" (key-description (this-command-keys)))
3155 (push (intern (char-to-string (read-char))) syms)
3156 (setq command (read-key-sequence nil t)))
3157 (setq gnus-current-prefix-symbols (nreverse syms)
3158 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3159 (call-interactively (key-binding command t))))
3161 ;;; More various functions.
3163 (defsubst gnus-check-backend-function (func group)
3164 "Check whether GROUP supports function FUNC.
3165 GROUP can either be a string (a group name) or a select method."
3167 (let ((method (if (stringp group)
3168 (car (gnus-find-method-for-group group))
3170 (unless (featurep method)
3172 (fboundp (intern (format "%s-%s" method func))))))
3174 (defun gnus-group-read-only-p (&optional group)
3175 "Check whether GROUP supports editing or not.
3176 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3177 that that variable is buffer-local to the summary buffers."
3178 (let ((group (or group gnus-newsgroup-name)))
3179 (not (gnus-check-backend-function 'request-replace-article group))))
3181 (defun gnus-virtual-group-p (group)
3182 "Say whether GROUP is virtual or not."
3183 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3184 gnus-valid-select-methods)))
3186 (defun gnus-news-group-p (group &optional article)
3187 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3188 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3189 t) ;is news of course.
3190 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3191 nil) ;must be mail then.
3192 ((vectorp article) ;Has header info.
3193 (eq (gnus-request-type group (mail-header-id article)) 'news))
3194 ((null article) ;Hasn't header info
3195 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3196 ((< article 0) ;Virtual message
3197 nil) ;we don't know, guess mail.
3198 (t ;Has positive number
3199 (eq (gnus-request-type group article) 'news)))) ;use it.
3201 ;; Returns a list of writable groups.
3202 (defun gnus-writable-groups ()
3203 (let ((alist gnus-newsrc-alist)
3205 (while (setq group (car (pop alist)))
3206 (unless (gnus-group-read-only-p group)
3207 (push group groups)))
3210 ;; Check whether to use long file names.
3211 (defun gnus-use-long-file-name (symbol)
3212 ;; The variable has to be set...
3213 (and gnus-use-long-file-name
3214 ;; If it isn't a list, then we return t.
3215 (or (not (listp gnus-use-long-file-name))
3216 ;; If it is a list, and the list contains `symbol', we
3218 (not (memq symbol gnus-use-long-file-name)))))
3220 ;; Generate a unique new group name.
3221 (defun gnus-generate-new-group-name (leaf)
3224 (while (gnus-group-entry name)
3225 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3228 (defun gnus-ephemeral-group-p (group)
3229 "Say whether GROUP is ephemeral or not."
3230 (gnus-group-get-parameter group 'quit-config t))
3232 (defun gnus-group-quit-config (group)
3233 "Return the quit-config of GROUP."
3234 (gnus-group-get-parameter group 'quit-config t))
3236 (defun gnus-kill-ephemeral-group (group)
3237 "Remove ephemeral GROUP from relevant structures."
3238 (gnus-sethash group nil gnus-newsrc-hashtb))
3240 (defun gnus-simplify-mode-line ()
3241 "Make mode lines a bit simpler."
3242 (setq mode-line-modified (cdr gnus-mode-line-modified))
3243 (when (listp mode-line-format)
3244 (make-local-variable 'mode-line-format)
3245 (setq mode-line-format (copy-sequence mode-line-format))
3246 (when (equal (nth 3 mode-line-format) " ")
3247 (setcar (nthcdr 3 mode-line-format) " "))))
3249 ;;; Servers and groups.
3251 (defsubst gnus-server-add-address (method)
3252 (let ((method-name (symbol-name (car method))))
3253 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3254 (not (assq (intern (concat method-name "-address")) method))
3255 (memq 'physical-address (assq (car method)
3256 gnus-valid-select-methods)))
3257 (append method (list (list (intern (concat method-name "-address"))
3261 (defsubst gnus-method-to-server (method)
3263 (setq method (or method gnus-select-method))
3265 ;; Perhaps it is already in the cache.
3266 (mapc (lambda (name-method)
3267 (if (equal (cdr name-method) method)
3268 (throw 'server-name (car name-method))))
3269 gnus-server-method-cache)
3272 (lambda (server-alist)
3273 (mapc (lambda (name-method)
3274 (when (gnus-methods-equal-p (cdr name-method) method)
3275 (unless (member name-method gnus-server-method-cache)
3276 (push name-method gnus-server-method-cache))
3277 (throw 'server-name (car name-method))))
3279 (let ((alists (list gnus-server-alist
3280 gnus-predefined-server-alist)))
3281 (if gnus-select-method
3282 (push (list (cons "native" gnus-select-method)) alists))
3285 (let* ((name (if (member (cadr method) '(nil ""))
3286 (format "%s" (car method))
3287 (format "%s:%s" (car method) (cadr method))))
3288 (name-method (cons name method)))
3289 (unless (member name-method gnus-server-method-cache)
3290 (push name-method gnus-server-method-cache))
3293 (defsubst gnus-server-to-method (server)
3294 "Map virtual server names to select methods."
3295 (or (and server (listp server) server)
3296 (cdr (assoc server gnus-server-method-cache))
3299 ;; Perhaps this is the native server?
3300 (and (equal server "native") gnus-select-method)
3301 ;; It should be in the server alist.
3302 (cdr (assoc server gnus-server-alist))
3303 ;; It could be in the predefined server alist.
3304 (cdr (assoc server gnus-predefined-server-alist))
3305 ;; If not, we look through all the opened server
3306 ;; to see whether we can find it there.
3307 (let ((opened gnus-opened-servers))
3309 (not (equal server (format "%s:%s" (caaar opened)
3313 ;; It could be a named method, search all servers
3314 (let ((servers gnus-secondary-select-methods))
3316 (not (equal server (format "%s:%s" (caar servers)
3320 ;; This could be some sort of foreign server that I
3321 ;; simply haven't opened (yet). Do a brute-force scan
3322 ;; of the entire gnus-newsrc-alist for the server name
3323 ;; of every method. As a side-effect, loads the
3324 ;; gnus-server-method-cache so this only happens once,
3329 (let ((info-method (gnus-info-method info)))
3330 (unless (stringp info-method)
3331 (let ((info-server (gnus-method-to-server info-method)))
3332 (when (equal server info-server)
3333 (setq match info-method))))))
3334 (cdr gnus-newsrc-alist))
3337 (push (cons server result) gnus-server-method-cache))
3340 (defsubst gnus-server-get-method (group method)
3341 ;; Input either a server name, and extended server name, or a
3342 ;; select method, and return a select method.
3343 (cond ((stringp method)
3344 (gnus-server-to-method method))
3345 ((equal method gnus-select-method)
3347 ((and (stringp (car method))
3349 (gnus-server-extend-method group method))
3352 (equal (cadr method) ""))
3355 (gnus-server-add-address method))))
3357 (defmacro gnus-method-equal (ss1 ss2)
3358 "Say whether two servers are equal."
3362 (and (= (length s1) (length s2))
3364 (while (and s1 (member (car s1) s2))
3368 (defun gnus-methods-equal-p (m1 m2)
3369 (let ((m1 (or m1 gnus-select-method))
3370 (m2 (or m2 gnus-select-method)))
3372 (and (eq (car m1) (car m2))
3373 (or (not (memq 'address (assoc (symbol-name (car m1))
3374 gnus-valid-select-methods)))
3375 (equal (nth 1 m1) (nth 1 m2)))))))
3377 (defun gnus-server-equal (m1 m2)
3378 "Say whether two methods are equal."
3379 (let ((m1 (cond ((null m1) gnus-select-method)
3380 ((stringp m1) (gnus-server-to-method m1))
3382 (m2 (cond ((null m2) gnus-select-method)
3383 ((stringp m2) (gnus-server-to-method m2))
3385 (gnus-method-equal m1 m2)))
3387 (defun gnus-servers-using-backend (backend)
3388 "Return a list of known servers using BACKEND."
3389 (let ((opened gnus-opened-servers)
3392 (when (eq backend (caaar opened))
3393 (push (caar opened) out))
3397 (defun gnus-archive-server-wanted-p ()
3398 "Say whether the user wants to use the archive server."
3400 ((or (not gnus-message-archive-method)
3401 (not gnus-message-archive-group))
3403 ((and gnus-message-archive-method gnus-message-archive-group)
3406 (let ((active (cadr (assq 'nnfolder-active-file
3407 gnus-message-archive-method))))
3409 (file-exists-p active))))))
3411 (defsubst gnus-method-to-server-name (method)
3413 (format "%s" (car method))
3415 (or (assoc (format "%s" (car method))
3416 (gnus-methods-using 'address))
3417 (gnus-server-equal method gnus-message-archive-method))
3419 (not (string= (nth 1 method) "")))
3420 (concat "+" (nth 1 method)))))
3422 (defsubst gnus-method-to-full-server-name (method)
3423 (format "%s+%s" (car method) (nth 1 method)))
3425 (defun gnus-group-prefixed-name (group method &optional full)
3426 "Return the whole name from GROUP and METHOD.
3427 Call with full set to get the fully qualified group name (even if the
3429 (when (stringp method)
3430 (setq method (gnus-server-to-method method)))
3431 (if (or (not method)
3432 (and (not full) (gnus-server-equal method "native"))
3433 ;;;!!! This might not be right. We'll see...
3434 ;(string-match ":" group)
3437 (concat (gnus-method-to-server-name method) ":" group)))
3439 (defun gnus-group-guess-prefixed-name (group)
3440 "Guess the whole name from GROUP and METHOD."
3441 (gnus-group-prefixed-name group (gnus-find-method-for-group
3444 (defun gnus-group-full-name (group method)
3445 "Return the full name from GROUP and METHOD, even if the method is native."
3446 (gnus-group-prefixed-name group method t))
3448 (defun gnus-group-guess-full-name (group)
3449 "Guess the full name from GROUP, even if the method is native."
3450 (if (gnus-group-prefixed-p group)
3452 (gnus-group-full-name group (gnus-find-method-for-group group))))
3454 (defun gnus-group-guess-full-name-from-command-method (group)
3455 "Guess the full name from GROUP, even if the method is native."
3456 (if (gnus-group-prefixed-p group)
3458 (gnus-group-full-name group gnus-command-method)))
3460 (defun gnus-group-real-prefix (group)
3461 "Return the prefix of the current group name."
3463 (if (string-match "^[^:]+:" group)
3464 (substring group 0 (match-end 0))
3468 (defun gnus-group-short-name (group)
3469 "Return the short group name."
3470 (let ((prefix (gnus-group-real-prefix group)))
3471 (if (< 0 (length prefix))
3472 (substring group (length prefix) nil)
3475 (defun gnus-group-prefixed-p (group)
3476 "Return the prefix of the current group name."
3477 (< 0 (length (gnus-group-real-prefix group))))
3479 (defun gnus-summary-buffer-name (group)
3480 "Return the summary buffer name of GROUP."
3481 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3483 (defun gnus-group-method (group)
3484 "Return the server or method used for selecting GROUP.
3485 You should probably use `gnus-find-method-for-group' instead."
3486 (let ((prefix (gnus-group-real-prefix group)))
3487 (if (equal prefix "")
3489 (let ((servers gnus-opened-servers)
3491 backend possible found)
3492 (if (string-match "^[^\\+]+\\+" prefix)
3493 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3494 server (substring prefix (match-end 0) (1- (length prefix))))
3495 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3497 (when (eq (caaar servers) backend)
3498 (setq possible (caar servers))
3499 (when (equal (cadaar servers) server)
3500 (setq found (caar servers))))
3502 (or (car (rassoc found gnus-server-alist))
3504 (car (rassoc possible gnus-server-alist))
3506 (list backend server))))))
3508 (defsubst gnus-native-method-p (method)
3509 "Return whether METHOD is the native select method."
3510 (gnus-method-equal method gnus-select-method))
3512 (defsubst gnus-secondary-method-p (method)
3513 "Return whether METHOD is a secondary select method."
3514 (let ((methods gnus-secondary-select-methods)
3515 (gmethod (inline (gnus-server-get-method nil method))))
3517 (not (gnus-method-equal
3518 (inline (gnus-server-get-method nil (car methods)))
3520 (setq methods (cdr methods)))
3523 (defun gnus-method-simplify (method)
3524 "Return the shortest uniquely identifying string or method for METHOD."
3525 (cond ((stringp method)
3527 ((gnus-native-method-p method)
3529 ((gnus-secondary-method-p method)
3530 (format "%s:%s" (nth 0 method) (nth 1 method)))
3534 (defun gnus-groups-from-server (server)
3535 "Return a list of all groups that are fetched from SERVER."
3536 (let ((alist (cdr gnus-newsrc-alist))
3538 (while (setq info (pop alist))
3539 (when (gnus-server-equal (gnus-info-method info) server)
3540 (push (gnus-info-group info) groups)))
3541 (sort groups 'string<)))
3543 (defun gnus-group-foreign-p (group)
3544 "Say whether a group is foreign or not."
3545 (and (not (gnus-group-native-p group))
3546 (not (gnus-group-secondary-p group))))
3548 (defun gnus-group-native-p (group)
3549 "Say whether the group is native or not."
3550 (not (string-match ":" group)))
3552 (defun gnus-group-secondary-p (group)
3553 "Say whether the group is secondary or not."
3554 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3556 (defun gnus-parameters-get-parameter (group)
3557 "Return the group parameters for GROUP from `gnus-parameters'."
3559 (dolist (elem gnus-parameters)
3560 (when (string-match (car elem) group)
3562 (nconc (gnus-expand-group-parameters
3563 (car elem) (cdr elem) group)
3567 (defun gnus-expand-group-parameter (match value group)
3568 "Use MATCH to expand VALUE in GROUP."
3571 (goto-char (point-min))
3572 (while (re-search-forward match nil t)
3573 (replace-match value))
3576 (defun gnus-expand-group-parameters (match parameters group)
3577 "Go through PARAMETERS and expand them according to the match data."
3579 (dolist (elem parameters)
3580 (if (and (stringp (cdr elem))
3581 (string-match "\\\\[0-9&]" (cdr elem)))
3582 (push (cons (car elem)
3583 (gnus-expand-group-parameter match (cdr elem) group))
3588 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3589 "For GROUP, return the value of SYMBOL.
3591 You should call this in the `gnus-group-buffer' buffer.
3592 The function `gnus-group-find-parameter' will do that for you."
3593 ;; The speed trick: No cons'ing and quit early.
3594 (let* ((params (funcall gnus-group-get-parameter-function group))
3595 ;; Start easy, check the "real" group parameters.
3597 (gnus-group-parameter-value params symbol allow-list t)))
3599 ;; Found results; return them.
3600 (car simple-results)
3601 ;; We didn't found it there, try `gnus-parameters'.
3604 (tail gnus-parameters))
3605 ;; A good old-fashioned non-cl loop.
3607 (setq head (car tail)
3609 ;; The car is regexp matching for matching the group name.
3610 (when (string-match (car head) group)
3611 ;; The cdr is the parameters.
3612 (setq result (gnus-group-parameter-value (cdr head)
3615 ;; Expand if necessary.
3616 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3617 (setq result (gnus-expand-group-parameter (car head)
3619 ;; Exit the loop early.
3624 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3625 "Return the group parameters for GROUP.
3626 If SYMBOL, return the value of that symbol in the group parameters.
3628 If you call this function inside a loop, consider using the faster
3629 `gnus-group-fast-parameter' instead."
3631 (set-buffer gnus-group-buffer)
3633 (gnus-group-fast-parameter group symbol allow-list)
3636 (funcall gnus-group-get-parameter-function group))
3637 (gnus-parameters-get-parameter group)))))
3639 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3640 "Return the group parameters for GROUP.
3641 If SYMBOL, return the value of that symbol in the group parameters.
3642 Most functions should use `gnus-group-find-parameter', which
3643 also examines the topic parameters."
3644 (let ((params (gnus-info-params (gnus-get-info group))))
3646 (gnus-group-parameter-value params symbol allow-list)
3649 (defun gnus-group-parameter-value (params symbol &optional
3650 allow-list present-p)
3651 "Return the value of SYMBOL in group PARAMS."
3652 ;; We only wish to return group parameters (dotted lists) and
3653 ;; not local variables, which may have the same names.
3654 ;; But first we handle single elements...
3655 (or (car (memq symbol params))
3659 (while (setq elem (pop params))
3660 (when (and (consp elem)
3661 (eq (car elem) symbol)
3664 (throw 'found (if present-p (list (cdr elem))
3667 (defun gnus-group-add-parameter (group param)
3668 "Add parameter PARAM to GROUP."
3669 (let ((info (gnus-get-info group)))
3671 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3672 ;; Cons the new param to the old one and update.
3673 (gnus-group-set-info (cons param (gnus-info-params info))
3676 (defun gnus-group-set-parameter (group name value)
3677 "Set parameter NAME to VALUE in GROUP."
3678 (let ((info (gnus-get-info group)))
3680 (gnus-group-remove-parameter group name)
3681 (let ((old-params (gnus-info-params info))
3682 (new-params (list (cons name value))))
3684 (when (or (not (listp (car old-params)))
3685 (not (eq (caar old-params) name)))
3686 (setq new-params (append new-params (list (car old-params)))))
3687 (setq old-params (cdr old-params)))
3688 (gnus-group-set-info new-params group 'params)))))
3690 (defun gnus-group-remove-parameter (group name)
3691 "Remove parameter NAME from GROUP."
3692 (let ((info (gnus-get-info group)))
3694 (let ((params (gnus-info-params info)))
3696 (setq params (delq name params))
3697 (while (assq name params)
3698 (gnus-pull name params))
3699 (gnus-info-set-params info params))))))
3701 (defun gnus-group-add-score (group &optional score)
3702 "Add SCORE to the GROUP score.
3703 If SCORE is nil, add 1 to the score of GROUP."
3704 (let ((info (gnus-get-info group)))
3706 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3708 (defun gnus-short-group-name (group &optional levels)
3709 "Collapse GROUP name LEVELS.
3710 Select methods are stripped and any remote host name is stripped down to
3711 just the host name."
3717 gnus-group-uncollapsed-levels
3719 (while (string-match "\\." group skip)
3720 (setq skip (match-end 0)
3723 ;; Separate foreign select method from group name and collapse.
3724 ;; If method contains a server, collapse to non-domain server name,
3725 ;; otherwise collapse to select method.
3726 (let* ((colon (string-match ":" group))
3727 (server (and colon (substring group 0 colon)))
3728 (plus (and server (string-match "+" server))))
3731 (setq foreign (substring server (+ 1 plus)
3732 (string-match "\\." server))
3733 group (substring group (+ 1 colon)))
3734 (setq foreign server
3735 group (substring group (+ 1 colon))))
3736 (setq foreign (concat foreign ":")))
3737 ;; Collapse group name leaving LEVELS uncollapsed elements
3738 (let* ((slist (split-string group "/"))
3739 (slen (length slist))
3740 (dlist (split-string group "\\."))
3741 (dlen (length dlist))
3753 (setq levels (- glen levels))
3755 (push (if (>= (decf levels) 0)
3756 (if (zerop (length g))
3761 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3763 (defun gnus-narrow-to-body ()
3764 "Narrow to the body of an article."
3767 (goto-char (point-min))
3768 (or (search-forward "\n\n" nil t)
3774 ;;; Kill file handling.
3777 (defun gnus-apply-kill-file ()
3778 "Apply a kill file to the current newsgroup.
3779 Returns the number of articles marked as read."
3780 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3781 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3782 (gnus-apply-kill-file-internal)
3785 (defun gnus-kill-save-kill-buffer ()
3786 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3787 (when (get-file-buffer file)
3789 (set-buffer (get-file-buffer file))
3790 (when (buffer-modified-p)
3792 (kill-buffer (current-buffer))))))
3794 (defcustom gnus-kill-file-name "KILL"
3795 "Suffix of the kill files."
3796 :group 'gnus-score-kill
3797 :group 'gnus-score-files
3800 (defun gnus-newsgroup-kill-file (newsgroup)
3801 "Return the name of a kill file name for NEWSGROUP.
3802 If NEWSGROUP is nil, return the global kill file name instead."
3804 ;; The global KILL file is placed at top of the directory.
3805 ((or (null newsgroup)
3806 (string-equal newsgroup ""))
3807 (expand-file-name gnus-kill-file-name
3808 gnus-kill-files-directory))
3809 ;; Append ".KILL" to newsgroup name.
3810 ((gnus-use-long-file-name 'not-kill)
3811 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3812 "." gnus-kill-file-name)
3813 gnus-kill-files-directory))
3814 ;; Place "KILL" under the hierarchical directory.
3816 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3817 "/" gnus-kill-file-name)
3818 gnus-kill-files-directory))))
3822 (defun gnus-member-of-valid (symbol group)
3823 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3825 (symbol-name (car (gnus-find-method-for-group group)))
3826 gnus-valid-select-methods)))
3828 (defun gnus-method-option-p (method option)
3829 "Return non-nil if select METHOD has OPTION as a parameter."
3830 (when (stringp method)
3831 (setq method (gnus-server-to-method method)))
3832 (memq option (assoc (format "%s" (car method))
3833 gnus-valid-select-methods)))
3835 (defun gnus-similar-server-opened (method)
3836 (let ((opened gnus-opened-servers))
3837 (while (and method opened)
3838 (when (and (equal (cadr method) (cadaar opened))
3839 (equal (car method) (caaar opened))
3840 (not (equal method (caar opened))))
3845 (defun gnus-server-extend-method (group method)
3846 ;; This function "extends" a virtual server. If the server is
3847 ;; "hello", and the select method is ("hello" (my-var "something"))
3848 ;; in the group "alt.alt", this will result in a new virtual server
3849 ;; called "hello+alt.alt".
3850 (if (or (not (inline (gnus-similar-server-opened method)))
3851 (not (cddr method)))
3853 `(,(car method) ,(concat (cadr method) "+" group)
3854 (,(intern (format "%s-address" (car method))) ,(cadr method))
3857 (defun gnus-server-status (method)
3858 "Return the status of METHOD."
3859 (nth 1 (assoc method gnus-opened-servers)))
3861 (defun gnus-group-name-to-method (group)
3862 "Guess a select method based on GROUP."
3863 (if (string-match ":" group)
3864 (let ((server (substring group 0 (match-beginning 0))))
3865 (if (string-match "\\+" server)
3866 (list (intern (substring server 0 (match-beginning 0)))
3867 (substring server (match-end 0)))
3868 (list (intern server) "")))
3869 gnus-select-method))
3871 (defun gnus-server-string (server)
3872 "Return a readable string that describes SERVER."
3873 (let* ((server (gnus-server-to-method server))
3874 (address (nth 1 server)))
3876 (not (zerop (length address))))
3877 (format "%s using %s" address (car server))
3878 (format "%s" (car server)))))
3880 (defun gnus-find-method-for-group (group &optional info)
3881 "Find the select method that GROUP uses."
3882 (or gnus-override-method
3885 (and (not (gnus-group-entry group)) ;; a new group
3886 (gnus-group-name-to-method group))
3887 (let ((info (or info (gnus-get-info group)))
3890 (not (setq method (gnus-info-method info)))
3891 (equal method "native"))
3894 (cond ((stringp method)
3895 (inline (gnus-server-to-method method)))
3896 ((stringp (cadr method))
3897 (inline (gnus-server-extend-method group method)))
3900 (cond ((equal (cadr method) "")
3902 ((null (cadr method))
3903 (list (car method) ""))
3905 (gnus-server-add-address method)))))))
3907 (defun gnus-methods-using (feature)
3908 "Find all methods that have FEATURE."
3909 (let ((valids gnus-valid-select-methods)
3912 (when (memq feature (car valids))
3913 (push (car valids) outs))
3914 (setq valids (cdr valids)))
3918 (autoload 'message-y-or-n-p "message" nil nil 'macro))
3920 (defun gnus-read-group (prompt &optional default)
3921 "Prompt the user for a group name.
3922 Disallow invalid group names."
3927 gnus-invalid-group-regexp
3928 (setq group (read-string (concat prefix prompt)
3929 (cons (or default "") 0)
3930 'gnus-group-history)))
3931 (let ((match (match-string 0 group)))
3932 ;; Might be okay (e.g. for nnimap), so ask the user:
3933 (unless (and (not (string-match "^$\\|:" match))
3935 "Proceed and create group anyway? " t
3936 "The group name \"" group "\" contains a forbidden character: \"" match "\".
3938 Usually, it's dangerous to create a group with this name, because it's not
3939 supported by all back ends and servers. On IMAP servers it should work,
3940 though. If you are really sure, you can proceed anyway and create the group.
3942 You may customize the variable `gnus-invalid-group-regexp', which currently is
3943 set to \"" gnus-invalid-group-regexp
3944 "\", if you want to get rid of this query permanently."))
3945 (setq prefix (format "Invalid group name: \"%s\". " group)
3949 (defun gnus-read-method (prompt)
3950 "Prompt the user for a method.
3951 Allow completion over sensible values."
3952 (let* ((open-servers
3953 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3954 gnus-opened-servers))
3957 (dolist (method gnus-valid-select-methods)
3958 (if (or (memq 'prompt-address method)
3959 (not (assoc (format "%s:" (car method)) open-servers)))
3960 (push method methods)))
3963 (append valid-methods
3965 gnus-predefined-server-alist
3970 nil t nil 'gnus-method-history)))
3973 (setq method gnus-select-method))
3974 ((assoc method gnus-valid-select-methods)
3975 (let ((address (if (memq 'prompt-address
3976 (assoc method gnus-valid-select-methods))
3977 (read-string "Address: ")
3979 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3980 (list (intern method) address))))
3981 ((assoc method servers)
3984 (list (intern method) "")))))
3988 (defun gnus-agent-method-p (method)
3989 "Say whether METHOD is covered by the agent."
3990 (or (eq (car gnus-agent-method-p-cache) method)
3991 (setq gnus-agent-method-p-cache
3993 (member (if (stringp method)
3995 (gnus-method-to-server method)) gnus-agent-covered-methods))))
3996 (cdr gnus-agent-method-p-cache))
3998 (defun gnus-online (method)
4001 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4002 (gnus-agent-method-p method))))
4004 ;;; User-level commands.
4007 (defun gnus-slave-no-server (&optional arg)
4008 "Read network news as a slave, without connecting to the local server."
4010 (gnus-no-server arg t))
4013 (defun gnus-no-server (&optional arg slave)
4015 If ARG is a positive number, Gnus will use that as the startup
4016 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4017 non-nil and not a positive number, Gnus will prompt the user for the
4018 name of an NNTP server to use.
4019 As opposed to `gnus', this command will not connect to the local
4022 (gnus-no-server-1 arg slave))
4025 (defun gnus-slave (&optional arg)
4026 "Read news as a slave."
4028 (gnus arg nil 'slave))
4031 (defun gnus-other-frame (&optional arg display)
4032 "Pop up a frame to read news.
4033 This will call one of the Gnus commands which is specified by the user
4034 option `gnus-other-frame-function' (default `gnus') with the argument
4035 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4036 optional second argument DISPLAY should be a standard display string
4037 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4038 omitted or the function `make-frame-on-display' is not available, the
4039 current display is used."
4041 (if (fboundp 'make-frame-on-display)
4043 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4045 (let ((alive (gnus-alive-p)))
4050 (when (and (or (not display)
4052 (gnus-frame-or-window-display-name
4054 (with-current-buffer (window-buffer window)
4055 (string-match "\\`gnus-"
4056 (symbol-name major-mode))))
4057 (gnus-select-frame-set-input-focus
4058 (setq gnus-other-frame-object (window-frame window)))
4059 (select-window window)
4062 (gnus-select-frame-set-input-focus
4063 (setq gnus-other-frame-object
4065 (make-frame-on-display display gnus-other-frame-parameters)
4066 (make-frame gnus-other-frame-parameters))))
4068 (switch-to-buffer gnus-group-buffer)
4069 (funcall gnus-other-frame-function arg)
4070 (add-hook 'gnus-exit-gnus-hook
4072 (when (and (frame-live-p gnus-other-frame-object)
4074 (delete-frame gnus-other-frame-object))
4075 (setq gnus-other-frame-object nil)))))))
4077 ;;(setq thing ? ; this is a comment
4081 (defun gnus (&optional arg dont-connect slave)
4083 If ARG is non-nil and a positive number, Gnus will use that as the
4084 startup level. If ARG is non-nil and not a positive number, Gnus will
4085 prompt the user for the name of an NNTP server to use."
4087 (unless (byte-code-function-p (symbol-function 'gnus))
4088 (message "You should byte-compile Gnus")
4090 (gnus-1 arg dont-connect slave))
4092 ;; Allow redefinition of Gnus functions.
4098 ;;; gnus.el ends here