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 (gnus-define-group-parameter
1830 "The address to get spam resent (through spam-report-resend)."
1831 :variable gnus-spam-resend-to
1832 :variable-default nil
1834 "The address to get spam resent (through spam-report-resend)."
1835 :variable-group spam
1836 :variable-type '(repeat
1837 (list :tag "Group address for resending spam"
1838 (regexp :tag "Group")
1839 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1840 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1842 "The address to get spam resent (through spam-report-resend).")
1844 (gnus-define-group-parameter
1848 "The address to get ham resent (through spam-report-resend)."
1849 :variable gnus-ham-resend-to
1850 :variable-default nil
1852 "The address to get ham resent (through spam-report-resend)."
1853 :variable-group spam
1854 :variable-type '(repeat
1855 (list :tag "Group address for resending ham"
1856 (regexp :tag "Group")
1857 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1858 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1860 "The address to get ham resent (through spam-report-resend).")
1862 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1863 "OBSOLETE: The ifile summary exit spam processor.")
1865 (defvar gnus-group-spam-exit-processor-stat "stat"
1866 "OBSOLETE: The spam-stat summary exit spam processor.")
1868 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1869 "OBSOLETE: The Bogofilter summary exit spam processor.")
1871 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1872 "OBSOLETE: The Blacklist summary exit spam processor.")
1874 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1875 "OBSOLETE: The Gmane reporting summary exit spam processor.
1876 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1878 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1879 "OBSOLETE: The spamoracle summary exit spam processor.")
1881 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1882 "OBSOLETE: The ifile summary exit ham processor.
1883 Only applicable to non-spam (unclassified and ham) groups.")
1885 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1886 "OBSOLETE: The Bogofilter summary exit ham processor.
1887 Only applicable to non-spam (unclassified and ham) groups.")
1889 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1890 "OBSOLETE: The spam-stat summary exit ham processor.
1891 Only applicable to non-spam (unclassified and ham) groups.")
1893 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1894 "OBSOLETE: The whitelist summary exit ham processor.
1895 Only applicable to non-spam (unclassified and ham) groups.")
1897 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1898 "OBSOLETE: The BBDB summary exit ham processor.
1899 Only applicable to non-spam (unclassified and ham) groups.")
1901 (defvar gnus-group-ham-exit-processor-copy "copy"
1902 "OBSOLETE: The ham copy exit ham processor.
1903 Only applicable to non-spam (unclassified and ham) groups.")
1905 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1906 "OBSOLETE: The spamoracle summary exit ham processor.
1907 Only applicable to non-spam (unclassified and ham) groups.")
1909 (gnus-define-group-parameter
1914 :tag "Spam Summary Exit Processor"
1916 (list :tag "Spam Summary Exit Processor Choices"
1918 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1919 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1920 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
1921 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1922 (const :tag "Spam: Resend Message"(spam spam-use-resend))
1923 (const :tag "Spam: ifile" (spam spam-use-ifile))
1924 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1925 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1926 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1927 (const :tag "Spam: CRM114" (spam spam-use-crm114))
1928 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1929 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1930 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
1931 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1932 (const :tag "Ham: Resend Message" (ham spam-use-resend))
1933 (const :tag "Ham: ifile" (ham spam-use-ifile))
1934 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
1935 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1936 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1937 (const :tag "Ham: CRM114" (ham spam-use-crm114))
1938 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1939 (variable-item gnus-group-spam-exit-processor-ifile)
1940 (variable-item gnus-group-spam-exit-processor-stat)
1941 (variable-item gnus-group-spam-exit-processor-bogofilter)
1942 (variable-item gnus-group-spam-exit-processor-blacklist)
1943 (variable-item gnus-group-spam-exit-processor-spamoracle)
1944 (variable-item gnus-group-spam-exit-processor-report-gmane)
1945 (variable-item gnus-group-ham-exit-processor-bogofilter)
1946 (variable-item gnus-group-ham-exit-processor-ifile)
1947 (variable-item gnus-group-ham-exit-processor-stat)
1948 (variable-item gnus-group-ham-exit-processor-whitelist)
1949 (variable-item gnus-group-ham-exit-processor-BBDB)
1950 (variable-item gnus-group-ham-exit-processor-spamoracle)
1951 (variable-item gnus-group-ham-exit-processor-copy))))
1953 "Which spam or ham processors will be applied when the summary is exited."
1954 :variable gnus-spam-process-newsgroups
1955 :variable-default nil
1957 "*Groups in which to automatically process spam or ham articles with
1958 a backend on summary exit. If non-nil, this should be a list of group
1959 name regexps that should match all groups in which to do automatic
1960 spam processing, associated with the appropriate processor."
1961 :variable-group spam
1963 '(repeat :tag "Spam/Ham Processors"
1964 (list :tag "Spam Summary Exit Processor Choices"
1965 (regexp :tag "Group Regexp")
1967 :tag "Spam/Ham Summary Exit Processor"
1968 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1969 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1970 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
1971 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1972 (const :tag "Spam: Resend Message"(spam spam-use-resend))
1973 (const :tag "Spam: ifile" (spam spam-use-ifile))
1974 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1975 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1976 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1977 (const :tag "Spam: CRM114" (spam spam-use-crm114))
1978 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1979 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1980 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
1981 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1982 (const :tag "Ham: Resend Message" (ham spam-use-resend))
1983 (const :tag "Ham: ifile" (ham spam-use-ifile))
1984 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1985 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
1986 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1987 (const :tag "Ham: CRM114" (ham spam-use-crm114))
1988 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1989 (variable-item gnus-group-spam-exit-processor-ifile)
1990 (variable-item gnus-group-spam-exit-processor-stat)
1991 (variable-item gnus-group-spam-exit-processor-bogofilter)
1992 (variable-item gnus-group-spam-exit-processor-blacklist)
1993 (variable-item gnus-group-spam-exit-processor-spamoracle)
1994 (variable-item gnus-group-spam-exit-processor-report-gmane)
1995 (variable-item gnus-group-ham-exit-processor-bogofilter)
1996 (variable-item gnus-group-ham-exit-processor-ifile)
1997 (variable-item gnus-group-ham-exit-processor-stat)
1998 (variable-item gnus-group-ham-exit-processor-whitelist)
1999 (variable-item gnus-group-ham-exit-processor-BBDB)
2000 (variable-item gnus-group-ham-exit-processor-spamoracle)
2001 (variable-item gnus-group-ham-exit-processor-copy))))
2004 "Which spam or ham processors will be applied when the summary is exited.")
2006 (gnus-define-group-parameter
2010 '(boolean :tag "Spam autodetection")
2012 "Should spam be autodetected (with spam-split) in this group?"
2013 :variable gnus-spam-autodetect
2014 :variable-default nil
2016 "*Groups in which spam should be autodetected when they are entered.
2017 Only unseen articles will be examined, unless
2018 spam-autodetect-recheck-messages is set."
2019 :variable-group spam
2022 :tag "Autodetection setting"
2024 (regexp :tag "Group Regexp")
2027 "Spam autodetection.
2028 Only unseen articles will be examined, unless
2029 spam-autodetect-recheck-messages is set.")
2031 (gnus-define-group-parameter
2032 spam-autodetect-methods
2035 '(choice :tag "Spam autodetection-specific methods"
2038 (set :tag "Use specific methods"
2039 (variable-item spam-use-blacklist)
2040 (variable-item spam-use-gmane-xref)
2041 (variable-item spam-use-regex-headers)
2042 (variable-item spam-use-regex-body)
2043 (variable-item spam-use-whitelist)
2044 (variable-item spam-use-BBDB)
2045 (variable-item spam-use-ifile)
2046 (variable-item spam-use-spamoracle)
2047 (variable-item spam-use-crm114)
2048 (variable-item spam-use-spamassassin)
2049 (variable-item spam-use-spamassassin-headers)
2050 (variable-item spam-use-bsfilter)
2051 (variable-item spam-use-bsfilter-headers)
2052 (variable-item spam-use-stat)
2053 (variable-item spam-use-blackholes)
2054 (variable-item spam-use-hashcash)
2055 (variable-item spam-use-bogofilter-headers)
2056 (variable-item spam-use-bogofilter)))
2058 "Methods to be used for autodetection in each group"
2059 :variable gnus-spam-autodetect-methods
2060 :variable-default nil
2062 "*Methods for autodetecting spam per group.
2063 Requires the spam-autodetect parameter. Only unseen articles
2064 will be examined, unless spam-autodetect-recheck-messages is
2066 :variable-group spam
2069 :tag "Autodetection methods"
2071 (regexp :tag "Group Regexp")
2075 (set :tag "Use specific methods"
2076 (variable-item spam-use-blacklist)
2077 (variable-item spam-use-gmane-xref)
2078 (variable-item spam-use-regex-headers)
2079 (variable-item spam-use-regex-body)
2080 (variable-item spam-use-whitelist)
2081 (variable-item spam-use-BBDB)
2082 (variable-item spam-use-ifile)
2083 (variable-item spam-use-spamoracle)
2084 (variable-item spam-use-crm114)
2085 (variable-item spam-use-stat)
2086 (variable-item spam-use-blackholes)
2087 (variable-item spam-use-hashcash)
2088 (variable-item spam-use-spamassassin)
2089 (variable-item spam-use-spamassassin-headers)
2090 (variable-item spam-use-bsfilter)
2091 (variable-item spam-use-bsfilter-headers)
2092 (variable-item spam-use-bogofilter-headers)
2093 (variable-item spam-use-bogofilter)))))
2095 "Spam autodetection methods.
2096 Requires the spam-autodetect parameter. Only unseen articles
2097 will be examined, unless spam-autodetect-recheck-messages is
2100 (gnus-define-group-parameter
2101 spam-process-destination
2104 '(choice :tag "Destination for spam-processed articles at summary exit"
2105 (string :tag "Move to a group")
2106 (repeat :tag "Move to multiple groups"
2107 (string :tag "Destination group"))
2108 (const :tag "Expire" nil))
2110 "Where spam-processed articles will go at summary exit."
2111 :variable gnus-spam-process-destinations
2112 :variable-default nil
2114 "*Groups in which to explicitly send spam-processed articles to
2115 another group, or expire them (the default). If non-nil, this should
2116 be a list of group name regexps that should match all groups in which
2117 to do spam-processed article moving, associated with the destination
2118 group or nil for explicit expiration. This only makes sense for
2120 :variable-group spam
2123 :tag "Spam-processed articles destination"
2125 (regexp :tag "Group Regexp")
2127 :tag "Destination for spam-processed articles at summary exit"
2128 (string :tag "Move to a group")
2129 (repeat :tag "Move to multiple groups"
2130 (string :tag "Destination group"))
2131 (const :tag "Expire" nil))))
2133 "Where spam-processed articles will go at summary exit.")
2135 (gnus-define-group-parameter
2136 ham-process-destination
2140 :tag "Destination for ham articles at summary exit from a spam group"
2141 (string :tag "Move to a group")
2142 (repeat :tag "Move to multiple groups"
2143 (string :tag "Destination group"))
2144 (const :tag "Respool" respool)
2145 (const :tag "Do nothing" nil))
2147 "Where ham articles will go at summary exit from a spam group."
2148 :variable gnus-ham-process-destinations
2149 :variable-default nil
2151 "*Groups in which to explicitly send ham articles to
2152 another group, or do nothing (the default). If non-nil, this should
2153 be a list of group name regexps that should match all groups in which
2154 to do ham article moving, associated with the destination
2155 group or nil for explicit ignoring. This only makes sense for
2156 mail groups, and only works in spam groups."
2157 :variable-group spam
2160 :tag "Ham articles destination"
2162 (regexp :tag "Group Regexp")
2164 :tag "Destination for ham articles at summary exit from spam group"
2165 (string :tag "Move to a group")
2166 (repeat :tag "Move to multiple groups"
2167 (string :tag "Destination group"))
2168 (const :tag "Respool" respool)
2169 (const :tag "Expire" nil))))
2171 "Where ham articles will go at summary exit from a spam group.")
2173 (gnus-define-group-parameter
2176 :parameter-type '(list :tag "Ham mark choices"
2178 (variable-item gnus-del-mark)
2179 (variable-item gnus-read-mark)
2180 (variable-item gnus-ticked-mark)
2181 (variable-item gnus-killed-mark)
2182 (variable-item gnus-kill-file-mark)
2183 (variable-item gnus-low-score-mark)))
2186 "Marks considered ham (positively not spam). Such articles will be
2187 processed as ham (non-spam) on group exit. When nil, the global
2188 spam-ham-marks variable takes precedence."
2189 :variable-default '((".*" ((gnus-del-mark
2193 gnus-low-score-mark))))
2194 :variable-group spam
2196 "*Groups in which to explicitly set the ham marks to some value.")
2198 (gnus-define-group-parameter
2201 :parameter-type '(list :tag "Spam mark choices"
2203 (variable-item gnus-spam-mark)
2204 (variable-item gnus-killed-mark)
2205 (variable-item gnus-kill-file-mark)
2206 (variable-item gnus-low-score-mark)))
2209 "Marks considered spam.
2210 Such articles will be processed as spam on group exit. When nil, the global
2211 spam-spam-marks variable takes precedence."
2212 :variable-default '((".*" ((gnus-spam-mark))))
2213 :variable-group spam
2215 "*Groups in which to explicitly set the spam marks to some value."))
2217 (defcustom gnus-group-uncollapsed-levels 1
2218 "Number of group name elements to leave alone when making a short group name."
2219 :group 'gnus-group-visual
2222 (defcustom gnus-group-use-permanent-levels nil
2223 "*If non-nil, once you set a level, Gnus will use this level."
2224 :group 'gnus-group-levels
2229 (defcustom gnus-load-hook nil
2230 "A hook run while Gnus is loaded."
2234 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2235 "A hook called to apply kill files to a group.
2236 This hook is intended to apply a kill file to the selected newsgroup.
2237 The function `gnus-apply-kill-file' is called by default.
2239 Since a general kill file is too heavy to use only for a few
2240 newsgroups, I recommend you to use a lighter hook function. For
2241 example, if you'd like to apply a kill file to articles which contains
2242 a string `rmgroup' in subject in newsgroup `control', you can use the
2245 (setq gnus-apply-kill-hook
2248 (cond ((string-match \"control\" gnus-newsgroup-name)
2249 (gnus-kill \"Subject\" \"rmgroup\")
2250 (gnus-expunge \"X\"))))))"
2251 :group 'gnus-score-kill
2252 :options '(gnus-apply-kill-file)
2255 (defcustom gnus-group-change-level-function nil
2256 "Function run when a group level is changed.
2257 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2258 :group 'gnus-group-levels
2263 (defcustom gnus-visual
2264 '(summary-highlight group-highlight article-highlight
2266 summary-menu group-menu article-menu
2267 tree-highlight menu highlight
2268 browse-menu server-menu
2269 page-marker tree-menu binary-menu pick-menu)
2270 "*Enable visual features.
2271 If `visual' is disabled, there will be no menus and few faces. Most of
2272 the visual customization options below will be ignored. Gnus will use
2273 less space and be faster as a result.
2275 This variable can also be a list of visual elements to switch on. For
2276 instance, to switch off all visual things except menus, you can say:
2278 (setq gnus-visual '(menu))
2280 Valid elements include `summary-highlight', `group-highlight',
2281 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2282 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2283 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2286 :type '(set (const summary-highlight)
2287 (const group-highlight)
2288 (const article-highlight)
2290 (const summary-menu)
2292 (const article-menu)
2293 (const tree-highlight)
2303 ;; Byte-compiler warning.
2304 (defvar gnus-visual)
2305 ;; Find out whether the gnus-visual TYPE is wanted.
2306 (defun gnus-visual-p (&optional type class)
2307 (and gnus-visual ; Has to be non-nil, at least.
2308 (if (not type) ; We don't care about type.
2310 (if (listp gnus-visual) ; It's a list, so we check it.
2311 (or (memq type gnus-visual)
2312 (memq class gnus-visual))
2315 (defcustom gnus-mouse-face
2317 (if (gnus-visual-p 'mouse-face 'highlight)
2318 (if (boundp 'gnus-mouse-face)
2319 (or gnus-mouse-face 'highlight)
2323 "*Face used for group or summary buffer mouse highlighting.
2324 The line beneath the mouse pointer will be highlighted with this
2329 (defcustom gnus-article-save-directory gnus-directory
2330 "*Name of the directory articles will be saved in (default \"~/News\")."
2331 :group 'gnus-article-saving
2334 (defvar gnus-plugged t
2335 "Whether Gnus is plugged or not.")
2337 (defcustom gnus-agent-cache t
2338 "Controls use of the agent cache while plugged.
2339 When set, Gnus will prefer using the locally stored content rather
2340 than re-fetching it from the server. You also need to enable
2341 `gnus-agent' for this to have any affect."
2346 (defcustom gnus-default-charset 'undecided
2347 "Default charset assumed to be used when viewing non-ASCII characters.
2348 This variable is overridden on a group-to-group basis by the
2349 `gnus-group-charset-alist' variable and is only used on groups not
2350 covered by that variable."
2352 :group 'gnus-charset)
2354 ;; Fixme: Doc reference to agent.
2355 (defcustom gnus-agent t
2356 "Whether we want to use the Gnus agent or not.
2358 You may customize gnus-agent to disable its use. However, some
2359 back ends have started to use the agent as a client-side cache.
2360 Disabling the agent may result in noticeable loss of performance."
2365 (defcustom gnus-other-frame-function 'gnus
2366 "Function called by the command `gnus-other-frame'."
2368 :type '(choice (function-item gnus)
2369 (function-item gnus-no-server)
2370 (function-item gnus-slave)
2371 (function-item gnus-slave-no-server)))
2373 (defcustom gnus-other-frame-parameters nil
2374 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2375 This should be an alist for Emacs, or a plist for XEmacs."
2377 :type (if (featurep 'xemacs)
2378 '(repeat (list :inline t :format "%v"
2379 (symbol :tag "Property")
2380 (sexp :tag "Value")))
2381 '(repeat (cons :format "%v"
2382 (symbol :tag "Parameter")
2383 (sexp :tag "Value")))))
2385 (defcustom gnus-user-agent 'emacs-gnus-type
2386 "Which information should be exposed in the User-Agent header.
2388 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2389 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2390 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2391 `emacs-gnus' plus system type\) or a custom string. If you set it to a
2392 string, be sure to use a valid format, see RFC 2616."
2393 :group 'gnus-message
2395 (item :tag "Show Gnus and Emacs versions and system type"
2397 (item :tag "Show Gnus and Emacs versions and system configuration"
2399 (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2400 (item :tag "Show only Gnus version" gnus)
2401 (string :tag "Other")))
2404 ;;; Internal variables
2406 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2407 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2408 (defvar gnus-agent-method-p-cache nil
2409 ; Reset each time gnus-agent-covered-methods is changed else
2410 ; gnus-agent-method-p may mis-report a methods status.
2412 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2413 (defvar gnus-draft-meta-information-header "X-Draft-From")
2414 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2415 (defvar gnus-original-article-buffer " *Original Article*")
2416 (defvar gnus-newsgroup-name nil)
2417 (defvar gnus-ephemeral-servers nil)
2418 (defvar gnus-server-method-cache nil)
2420 (defvar gnus-agent-fetching nil
2421 "Whether Gnus agent is in fetching mode.")
2423 (defvar gnus-agent-covered-methods nil
2424 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2426 (defvar gnus-command-method nil
2427 "Dynamically bound variable that says what the current back end is.")
2429 (defvar gnus-current-select-method nil
2430 "The current method for selecting a newsgroup.")
2432 (defvar gnus-tree-buffer "*Tree*"
2433 "Buffer where Gnus thread trees are displayed.")
2436 (defvar gnus-use-generic-from nil)
2438 ;; Variable holding the user answers to all method prompts.
2439 (defvar gnus-method-history nil)
2441 ;; Variable holding the user answers to all mail method prompts.
2442 (defvar gnus-mail-method-history nil)
2444 ;; Variable holding the user answers to all group prompts.
2445 (defvar gnus-group-history nil)
2447 (defvar gnus-server-alist nil
2448 "List of available servers.")
2450 (defcustom gnus-cache-directory
2451 (nnheader-concat gnus-directory "cache/")
2452 "*The directory where cached articles will be stored."
2456 (defvar gnus-predefined-server-alist
2459 (nnspool-spool-directory ,gnus-cache-directory)
2460 (nnspool-nov-directory ,gnus-cache-directory)
2461 (nnspool-active-file
2462 ,(nnheader-concat gnus-cache-directory "active"))))
2463 "List of predefined (convenience) servers.")
2465 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2467 (defconst gnus-article-mark-lists
2468 '((marked . tick) (replied . reply)
2469 (expirable . expire) (killed . killed)
2470 (bookmarks . bookmark) (dormant . dormant)
2471 (scored . score) (saved . save)
2472 (cached . cache) (downloadable . download)
2473 (unsendable . unsend) (forwarded . forward)
2474 (recent . recent) (seen . seen)))
2476 (defconst gnus-article-special-mark-lists
2482 ;; Propagate flags to server, with the following exceptions:
2483 ;; `seen' is private to each gnus installation
2484 ;; `cache' is a internal gnus flag for each gnus installation
2485 ;; `download' is a agent flag private to each gnus installation
2486 ;; `unsend' are for nndraft groups only
2487 ;; `score' is not a proper mark
2488 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2489 (defconst gnus-article-unpropagated-mark-lists
2490 '(seen cache download unsend score bookmark)
2491 "Marks that shouldn't be propagated to back ends.
2492 Typical marks are those that make no sense in a standalone back end,
2493 such as a mark that says whether an article is stored in the cache
2494 \(which doesn't make sense in a standalone back end).")
2496 (defvar gnus-headers-retrieved-by nil)
2497 (defvar gnus-article-reply nil)
2498 (defvar gnus-override-method nil)
2499 (defvar gnus-opened-servers nil)
2501 (defvar gnus-current-kill-article nil)
2503 (defvar gnus-have-read-active-file nil)
2505 (defconst gnus-maintainer
2506 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2507 "The mail address of the Gnus maintainers.")
2509 (defvar gnus-info-nodes
2510 '((gnus-group-mode "(gnus)Group Buffer")
2511 (gnus-summary-mode "(gnus)Summary Buffer")
2512 (gnus-article-mode "(gnus)Article Buffer")
2513 (gnus-server-mode "(gnus)Server Buffer")
2514 (gnus-browse-mode "(gnus)Browse Foreign Server")
2515 (gnus-tree-mode "(gnus)Tree Display"))
2516 "Alist of major modes and related Info nodes.")
2518 (defvar gnus-group-buffer "*Group*")
2519 (defvar gnus-summary-buffer "*Summary*")
2520 (defvar gnus-article-buffer "*Article*")
2521 (defvar gnus-server-buffer "*Server*")
2523 (defvar gnus-slave nil
2524 "Whether this Gnus is a slave or not.")
2526 (defvar gnus-batch-mode nil
2527 "Whether this Gnus is running in batch mode or not.")
2529 (defvar gnus-variable-list
2530 '(gnus-newsrc-options gnus-newsrc-options-n
2531 gnus-newsrc-last-checked-date
2532 gnus-newsrc-alist gnus-server-alist
2533 gnus-killed-list gnus-zombie-list
2534 gnus-topic-topology gnus-topic-alist
2536 "Gnus variables saved in the quick startup file.")
2538 (defvar gnus-newsrc-alist nil
2539 "Assoc list of read articles.
2540 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2542 (defvar gnus-registry-alist nil
2543 "Assoc list of registry data.
2544 gnus-registry.el will populate this if it's loaded.")
2546 (defvar gnus-newsrc-hashtb nil
2547 "Hashtable of `gnus-newsrc-alist'.")
2549 (defvar gnus-killed-list nil
2550 "List of killed newsgroups.")
2552 (defvar gnus-killed-hashtb nil
2553 "Hash table equivalent of `gnus-killed-list'.")
2555 (defvar gnus-zombie-list nil
2556 "List of almost dead newsgroups.")
2558 (defvar gnus-description-hashtb nil
2559 "Descriptions of newsgroups.")
2561 (defvar gnus-list-of-killed-groups nil
2562 "List of newsgroups that have recently been killed by the user.")
2564 (defvar gnus-active-hashtb nil
2565 "Hashtable of active articles.")
2567 (defvar gnus-moderated-hashtb nil
2568 "Hashtable of moderated newsgroups.")
2570 ;; Save window configuration.
2571 (defvar gnus-prev-winconf nil)
2573 (defvar gnus-reffed-article-number nil)
2575 ;;; Let the byte-compiler know that we know about this variable.
2576 (defvar rmail-default-rmail-file)
2578 (defvar gnus-dead-summary nil)
2580 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2581 "Regexp matching invalid groups.")
2583 (defvar gnus-other-frame-object nil
2584 "A frame object which will be created by `gnus-other-frame'.")
2586 ;;; End of variables.
2588 ;; Define some autoload functions Gnus might use.
2591 ;; This little mapcar goes through the list below and marks the
2592 ;; symbols in question as autoloaded functions.
2595 (let ((interactive (nth 1 (memq ':interactive package))))
2599 (when (consp function)
2600 (setq keymap (car (memq 'keymap function)))
2601 (setq function (car function)))
2602 (unless (fboundp function)
2603 (autoload function (car package) nil interactive keymap))))
2604 (if (eq (nth 1 package) ':interactive)
2607 '(("info" :interactive t Info-goto-node)
2609 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2610 ("ps-print" ps-print-preprint)
2611 ("message" :interactive t
2612 message-send-and-exit message-yank-original)
2613 ("babel" babel-as-string)
2614 ("nnmail" nnmail-split-fancy nnmail-article-group)
2615 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2616 ("rmailout" rmail-output rmail-output-to-rmail-file)
2617 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2618 rmail-show-message rmail-summary-exists
2619 rmail-select-summary rmail-update-summary)
2620 ("gnus-audio" :interactive t gnus-audio-play)
2621 ("gnus-xmas" gnus-xmas-splash)
2622 ("gnus-soup" :interactive t
2623 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2624 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2625 ("nnsoup" nnsoup-pack-replies)
2626 ("score-mode" :interactive t gnus-score-mode)
2627 ("gnus-mh" gnus-summary-save-article-folder
2628 gnus-Folder-save-name gnus-folder-save-name)
2629 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2630 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2631 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2632 gnus-demon-add-disconnection gnus-demon-add-handler
2633 gnus-demon-remove-handler)
2634 ("gnus-demon" :interactive t
2635 gnus-demon-init gnus-demon-cancel)
2636 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2637 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2638 gnus-face-from-file)
2639 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2640 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2641 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2642 gnus-nocem-unwanted-article-p)
2643 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2644 gnus-server-server-name)
2645 ("gnus-srvr" gnus-browse-foreign-server)
2646 ("gnus-cite" :interactive t
2647 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2648 gnus-article-hide-citation gnus-article-fill-cited-article
2649 gnus-article-hide-citation-in-followups)
2650 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2651 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2652 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2653 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2654 gnus-cache-possibly-remove-articles gnus-cache-request-article
2655 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2656 gnus-cache-enter-remove-article gnus-cached-article-p
2657 gnus-cache-open gnus-cache-close gnus-cache-update-article
2658 gnus-cache-articles-in-group)
2659 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2660 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2661 ("gnus-score" :interactive t
2662 gnus-summary-increase-score gnus-summary-set-score
2663 gnus-summary-raise-thread gnus-summary-raise-same-subject
2664 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2665 gnus-summary-lower-thread gnus-summary-lower-same-subject
2666 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2667 gnus-summary-current-score gnus-score-delta-default
2668 gnus-score-flush-cache gnus-score-close
2669 gnus-possibly-score-headers gnus-score-followup-article
2670 gnus-score-followup-thread)
2672 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2673 gnus-current-score-file-nondirectory gnus-score-adaptive
2674 gnus-score-find-trace gnus-score-file-name)
2675 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2676 ("gnus-topic" :interactive t gnus-topic-mode)
2677 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2678 gnus-subscribe-topics)
2679 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2680 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2681 ("gnus-uu" :interactive t
2682 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2683 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2684 gnus-uu-mark-by-regexp gnus-uu-mark-all
2685 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2686 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2687 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2688 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2689 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2690 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2691 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2692 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2693 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2694 ("gnus-msg" (gnus-summary-send-map keymap)
2695 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2696 ("gnus-msg" :interactive t
2697 gnus-group-post-news gnus-group-mail gnus-group-news
2698 gnus-summary-post-news gnus-summary-news-other-window
2699 gnus-summary-followup gnus-summary-followup-with-original
2700 gnus-summary-cancel-article gnus-summary-supersede-article
2701 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2702 gnus-summary-mail-forward gnus-summary-mail-other-window
2703 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2704 gnus-summary-wide-reply gnus-summary-followup-to-mail
2705 gnus-summary-followup-to-mail-with-original gnus-bug
2706 gnus-summary-wide-reply-with-original
2707 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2708 gnus-summary-post-forward)
2709 ("gnus-picon" :interactive t gnus-treat-from-picon)
2710 ("smiley" :interactive t smiley-region)
2711 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2712 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2713 gnus-list-of-unread-articles gnus-list-of-read-articles
2714 gnus-offer-save-summaries gnus-make-thread-indent-array
2715 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2716 gnus-summary-skip-intangible gnus-summary-article-number
2717 gnus-data-header gnus-data-find)
2718 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2719 gnus-group-list-groups gnus-group-first-unread-group
2720 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2721 gnus-group-setup-buffer gnus-group-get-new-news
2722 gnus-group-make-help-group gnus-group-update-group
2723 gnus-group-iterate gnus-group-group-name)
2724 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2725 gnus-backlog-remove-article)
2726 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2727 gnus-article-prepare gnus-article-set-window-start
2728 gnus-article-next-page gnus-article-prev-page
2729 gnus-request-article-this-buffer gnus-article-mode
2730 gnus-article-setup-buffer gnus-narrow-to-page
2731 gnus-article-delete-invisible-text gnus-treat-article)
2732 ("gnus-art" :interactive t
2733 gnus-article-hide-headers gnus-article-hide-boring-headers
2734 gnus-article-treat-overstrike
2735 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2736 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2737 gnus-article-de-base64-unreadable
2738 gnus-article-decode-HZ
2739 gnus-article-wash-html
2740 gnus-article-unsplit-urls
2741 gnus-article-hide-pem gnus-article-hide-signature
2742 gnus-article-strip-leading-blank-lines gnus-article-date-local
2743 gnus-article-date-original gnus-article-date-lapsed
2744 ;; gnus-article-show-all-headers
2745 gnus-article-edit-mode gnus-article-edit-article
2746 gnus-article-edit-done gnus-article-decode-encoded-words
2747 gnus-start-date-timer gnus-stop-date-timer
2748 gnus-mime-view-all-parts)
2749 ("gnus-int" gnus-request-type)
2750 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2751 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2752 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2753 gnus-dup-enter-articles)
2754 ("gnus-range" gnus-copy-sequence)
2755 ("gnus-eform" gnus-edit-form)
2756 ("gnus-move" :interactive t
2757 gnus-group-move-group-to-server gnus-change-server)
2758 ("gnus-logic" gnus-score-advanced)
2759 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2760 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2761 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2762 gnus-async-halt-prefetch)
2763 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2764 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2765 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2766 gnus-summary-set-agent-mark gnus-agent-save-group-info
2767 gnus-agent-request-article gnus-agent-retrieve-headers)
2768 ("gnus-agent" :interactive t
2769 gnus-unplugged gnus-agentize gnus-agent-batch)
2770 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2771 gnus-summary-save-article-vm)
2772 ("compface" uncompface)
2773 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2774 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2775 ("gnus-mlspl" :interactive t gnus-group-split-setup
2776 gnus-group-split-update)
2777 ("gnus-delay" gnus-delay-initialize))))
2779 ;;; gnus-sum.el thingies
2782 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2783 "*The format specification of the lines in the summary buffer.
2785 It works along the same lines as a normal formatting string,
2786 with some simple extensions.
2788 %N Article number, left padded with spaces (string)
2790 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2791 %n Name of the poster (string)
2792 %a Extracted name of the poster (string)
2793 %A Extracted address of the poster (string)
2794 %F Contents of the From: header (string)
2795 %f Contents of the From: or To: headers (string)
2796 %x Contents of the Xref: header (string)
2797 %D Date of the article (string)
2798 %d Date of the article (string) in DD-MMM format
2799 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2800 %M Message-id of the article (string)
2801 %r References of the article (string)
2802 %c Number of characters in the article (integer)
2803 %k Pretty-printed version of the above (string)
2804 For example, \"1.2k\" or \"0.4M\".
2805 %L Number of lines in the article (integer)
2806 %I Indentation based on thread level (a string of spaces)
2807 %B A complex trn-style thread tree (string)
2808 The variables `gnus-sum-thread-*' can be used for customization.
2809 %T A string with two possible values: 80 spaces if the article
2810 is on thread level two or larger and 0 spaces on level one
2811 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2812 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2813 %[ Opening bracket (character, \"[\" or \"<\")
2814 %] Closing bracket (character, \"]\" or \">\")
2815 %> Spaces of length thread-level (string)
2816 %< Spaces of length (- 20 thread-level) (string)
2817 %i Article score (number)
2818 %z Article zcore (character)
2819 %t Number of articles under the current thread (number).
2820 %e Whether the thread is empty or not (character).
2821 %V Total thread score (number).
2822 %P The line number (number).
2823 %O Download mark (character).
2824 %* If present, indicates desired cursor position
2825 (instead of after first colon).
2826 %u User defined specifier. The next character in the format string should
2827 be a letter. Gnus will call the function gnus-user-format-function-X,
2828 where X is the letter following %u. The function will be passed the
2829 current header as argument. The function should return a string, which
2830 will be inserted into the summary just like information from any other
2833 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2834 with care. For reasons of efficiency, Gnus will compute what column
2835 these characters will end up in, and \"hard-code\" that. This means that
2836 it is invalid to have these specs after a variable-length spec. Well,
2837 you might not be arrested, but your summary buffer will look strange,
2838 which is bad enough.
2840 The smart choice is to have these specs as far to the left as
2843 This restriction may disappear in later versions of Gnus.
2845 General format specifiers can also be used.
2846 See Info node `(gnus)Formatting Variables'."
2847 :link '(custom-manual "(gnus)Formatting Variables")
2849 :group 'gnus-summary-format)
2852 ;;; Skeleton keymaps
2855 (defun gnus-suppress-keymap (keymap)
2856 (suppress-keymap keymap)
2857 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2859 (define-key keymap (pop keys) 'undefined))))
2861 (defvar gnus-article-mode-map
2862 (let ((keymap (make-sparse-keymap)))
2863 (gnus-suppress-keymap keymap)
2865 (defvar gnus-summary-mode-map
2866 (let ((keymap (make-keymap)))
2867 (gnus-suppress-keymap keymap)
2869 (defvar gnus-group-mode-map
2870 (let ((keymap (make-keymap)))
2871 (gnus-suppress-keymap keymap)
2876 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2877 ;; If you want the cursor to go somewhere else, set these two
2878 ;; functions in some startup hook to whatever you want.
2879 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2880 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2882 ;;; Various macros and substs.
2884 (defun gnus-header-from (header)
2885 (mail-header-from header))
2887 (defmacro gnus-gethash (string hashtable)
2888 "Get hash value of STRING in HASHTABLE."
2889 `(symbol-value (intern-soft ,string ,hashtable)))
2891 (defmacro gnus-gethash-safe (string hashtable)
2892 "Get hash value of STRING in HASHTABLE.
2893 Return nil if not defined."
2894 `(let ((sym (intern-soft ,string ,hashtable)))
2895 (and (boundp sym) (symbol-value sym))))
2897 (defmacro gnus-sethash (string value hashtable)
2898 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2899 `(set (intern ,string ,hashtable) ,value))
2900 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2902 (defmacro gnus-group-unread (group)
2903 "Get the currently computed number of unread articles in GROUP."
2904 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2906 (defmacro gnus-group-entry (group)
2907 "Get the newsrc entry for GROUP."
2908 `(gnus-gethash ,group gnus-newsrc-hashtb))
2910 (defmacro gnus-active (group)
2911 "Get active info on GROUP."
2912 `(gnus-gethash ,group gnus-active-hashtb))
2914 (defmacro gnus-set-active (group active)
2915 "Set GROUP's active info."
2916 `(gnus-sethash ,group ,active gnus-active-hashtb))
2918 ;; Info access macros.
2920 (defmacro gnus-info-group (info)
2922 (defmacro gnus-info-rank (info)
2924 (defmacro gnus-info-read (info)
2926 (defmacro gnus-info-marks (info)
2928 (defmacro gnus-info-method (info)
2930 (defmacro gnus-info-params (info)
2933 (defmacro gnus-info-level (info)
2934 `(let ((rank (gnus-info-rank ,info)))
2938 (defmacro gnus-info-score (info)
2939 `(let ((rank (gnus-info-rank ,info)))
2940 (or (and (consp rank) (cdr rank)) 0)))
2942 (defmacro gnus-info-set-group (info group)
2943 `(setcar ,info ,group))
2944 (defmacro gnus-info-set-rank (info rank)
2945 `(setcar (nthcdr 1 ,info) ,rank))
2946 (defmacro gnus-info-set-read (info read)
2947 `(setcar (nthcdr 2 ,info) ,read))
2948 (defmacro gnus-info-set-marks (info marks &optional extend)
2950 `(gnus-info-set-entry ,info ,marks 3)
2951 `(setcar (nthcdr 3 ,info) ,marks)))
2952 (defmacro gnus-info-set-method (info method &optional extend)
2954 `(gnus-info-set-entry ,info ,method 4)
2955 `(setcar (nthcdr 4 ,info) ,method)))
2956 (defmacro gnus-info-set-params (info params &optional extend)
2958 `(gnus-info-set-entry ,info ,params 5)
2959 `(setcar (nthcdr 5 ,info) ,params)))
2961 (defun gnus-info-set-entry (info entry number)
2962 ;; Extend the info until we have enough elements.
2963 (while (<= (length info) number)
2964 (nconc info (list nil)))
2966 (setcar (nthcdr number info) entry))
2968 (defmacro gnus-info-set-level (info level)
2969 `(let ((rank (cdr ,info)))
2970 (if (consp (car rank))
2971 (setcar (car rank) ,level)
2972 (setcar rank ,level))))
2973 (defmacro gnus-info-set-score (info score)
2974 `(let ((rank (cdr ,info)))
2975 (if (consp (car rank))
2976 (setcdr (car rank) ,score)
2977 (setcar rank (cons (car rank) ,score)))))
2979 (defmacro gnus-get-info (group)
2980 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2982 ;;; Load the compatibility functions.
2991 (defvar gnus-shutdown-alist nil)
2993 (defun gnus-add-shutdown (function &rest symbols)
2994 "Run FUNCTION whenever one of SYMBOLS is shut down."
2995 (push (cons function symbols) gnus-shutdown-alist))
2997 (defun gnus-shutdown (symbol)
2998 "Shut down everything that waits for SYMBOL."
2999 (let ((alist gnus-shutdown-alist)
3001 (while (setq entry (pop alist))
3002 (when (memq symbol (cdr entry))
3003 (funcall (car entry))))))
3007 ;;; Gnus Utility Functions
3010 (defun gnus-find-subscribed-addresses ()
3011 "Return a regexp matching the addresses of all subscribed mail groups.
3012 It consists of the `to-address' or `to-list' parameter of all groups
3013 with a `subscribed' parameter."
3014 (let (group address addresses)
3015 (dolist (entry (cdr gnus-newsrc-alist))
3016 (setq group (car entry))
3017 (when (gnus-parameter-subscribed group)
3018 (setq address (mail-strip-quoted-names
3019 (or (gnus-group-fast-parameter group 'to-address)
3020 (gnus-group-fast-parameter group 'to-list))))
3022 (add-to-list 'addresses address))))
3024 (list (mapconcat 'regexp-quote addresses "\\|")))))
3026 (defmacro gnus-string-or (&rest strings)
3027 "Return the first element of STRINGS that is a non-blank string.
3028 STRINGS will be evaluated in normal `or' order."
3029 `(gnus-string-or-1 ',strings))
3031 (defun gnus-string-or-1 (strings)
3034 (setq string (eval (pop strings)))
3035 (if (string-match "^[ \t]*$" string)
3037 (setq strings nil)))
3040 (defun gnus-version (&optional arg)
3041 "Version number of this version of Gnus.
3042 If ARG, insert string at point."
3045 (insert (message gnus-version))
3046 (message gnus-version)))
3048 (defun gnus-continuum-version (&optional version)
3049 "Return VERSION as a floating point number."
3052 (setq version gnus-version))
3053 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3054 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3055 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3056 (number (match-string 2 version))
3058 (unless (string-match
3059 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3060 (error "Invalid version string: %s" version))
3061 (setq major (string-to-number (match-string 1 number))
3062 minor (string-to-number (match-string 2 number))
3063 least (if (match-beginning 3)
3064 (string-to-number (match-string 3 number))
3068 (format "%s00%02d%02d"
3069 (if (member alpha '("(ding)" "d"))
3073 (- (mm-char-int (aref (downcase alpha) 0))
3077 (format "%d.%02d%02d" major minor least))))))
3079 (defun gnus-info-find-node (&optional nodename)
3080 "Find Info documentation of Gnus."
3082 ;; Enlarge info window if needed.
3083 (let (gnus-info-buffer)
3084 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3085 (setq gnus-info-buffer (current-buffer))
3086 (gnus-configure-windows 'info)))
3089 ;;; gnus-interactive
3092 (defvar gnus-current-prefix-symbol nil
3093 "Current prefix symbol.")
3095 (defvar gnus-current-prefix-symbols nil
3096 "List of current prefix symbols.")
3098 (defun gnus-interactive (string &optional params)
3099 "Return a list that can be fed to `interactive'.
3100 See `interactive' for full documentation.
3102 Adds the following specs:
3104 y -- The current symbolic prefix.
3105 Y -- A list of the current symbolic prefix(es).
3106 A -- Article number.
3107 H -- Article header.
3111 (while (< i (length string))
3112 (string-match ".\\([^\n]*\\)\n?" string i)
3113 (setq c (aref string i))
3115 (setq prompt (match-string 1 string)))
3116 (setq i (match-end 0))
3117 ;; We basically emulate just about everything that
3118 ;; `interactive' does, but add the specs listed above.
3122 (completing-read prompt obarray 'fboundp t))
3124 (read-buffer prompt (current-buffer) t))
3126 (read-buffer prompt (other-buffer (current-buffer))))
3130 (completing-read prompt obarray 'commandp t))
3134 (read-file-name prompt nil default-directory 'lambda))
3136 (read-file-name prompt nil nil 'lambda))
3138 (read-file-name prompt))
3140 (read-key-sequence prompt))
3142 (error "Not implemented spec"))
3144 (error "Not implemented spec"))
3148 (error "Not implemented spec"))
3150 (string-to-number (read-from-minibuffer prompt)))
3152 (prefix-numeric-value current-prefix-arg))
3158 (read-string prompt))
3160 (intern (read-string prompt)))
3162 (read-variable prompt))
3164 (read-minibuffer prompt))
3166 (eval-minibuffer prompt))
3167 ;; And here the new specs come.
3169 gnus-current-prefix-symbol)
3171 gnus-current-prefix-symbols)
3173 (gnus-group-group-name))
3175 (gnus-summary-skip-intangible)
3176 (or (get-text-property (point) 'gnus-number)
3177 (gnus-summary-last-subject)))
3179 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3181 (error "Non-implemented spec")))
3185 (push (if (< (point) (mark)) (point) (mark)) out)
3186 (push (if (> (point) (mark)) (point) (mark)) out))))
3187 (setq out (delq 'gnus-prefix-nil out))
3190 (defun gnus-symbolic-argument (&optional arg)
3191 "Read a symbolic argument and a command, and then execute command."
3193 (let* ((in-command (this-command-keys))
3194 (command in-command)
3195 gnus-current-prefix-symbols
3196 gnus-current-prefix-symbol
3198 (while (equal in-command command)
3199 (message "%s-" (key-description (this-command-keys)))
3200 (push (intern (char-to-string (read-char))) syms)
3201 (setq command (read-key-sequence nil t)))
3202 (setq gnus-current-prefix-symbols (nreverse syms)
3203 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3204 (call-interactively (key-binding command t))))
3206 ;;; More various functions.
3208 (defsubst gnus-check-backend-function (func group)
3209 "Check whether GROUP supports function FUNC.
3210 GROUP can either be a string (a group name) or a select method."
3212 (let ((method (if (stringp group)
3213 (car (gnus-find-method-for-group group))
3215 (unless (featurep method)
3217 (fboundp (intern (format "%s-%s" method func))))))
3219 (defun gnus-group-read-only-p (&optional group)
3220 "Check whether GROUP supports editing or not.
3221 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3222 that that variable is buffer-local to the summary buffers."
3223 (let ((group (or group gnus-newsgroup-name)))
3224 (not (gnus-check-backend-function 'request-replace-article group))))
3226 (defun gnus-virtual-group-p (group)
3227 "Say whether GROUP is virtual or not."
3228 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3229 gnus-valid-select-methods)))
3231 (defun gnus-news-group-p (group &optional article)
3232 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3233 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3234 t) ;is news of course.
3235 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3236 nil) ;must be mail then.
3237 ((vectorp article) ;Has header info.
3238 (eq (gnus-request-type group (mail-header-id article)) 'news))
3239 ((null article) ;Hasn't header info
3240 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3241 ((< article 0) ;Virtual message
3242 nil) ;we don't know, guess mail.
3243 (t ;Has positive number
3244 (eq (gnus-request-type group article) 'news)))) ;use it.
3246 ;; Returns a list of writable groups.
3247 (defun gnus-writable-groups ()
3248 (let ((alist gnus-newsrc-alist)
3250 (while (setq group (car (pop alist)))
3251 (unless (gnus-group-read-only-p group)
3252 (push group groups)))
3255 ;; Check whether to use long file names.
3256 (defun gnus-use-long-file-name (symbol)
3257 ;; The variable has to be set...
3258 (and gnus-use-long-file-name
3259 ;; If it isn't a list, then we return t.
3260 (or (not (listp gnus-use-long-file-name))
3261 ;; If it is a list, and the list contains `symbol', we
3263 (not (memq symbol gnus-use-long-file-name)))))
3265 ;; Generate a unique new group name.
3266 (defun gnus-generate-new-group-name (leaf)
3269 (while (gnus-group-entry name)
3270 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3273 (defun gnus-ephemeral-group-p (group)
3274 "Say whether GROUP is ephemeral or not."
3275 (gnus-group-get-parameter group 'quit-config t))
3277 (defun gnus-group-quit-config (group)
3278 "Return the quit-config of GROUP."
3279 (gnus-group-get-parameter group 'quit-config t))
3281 (defun gnus-kill-ephemeral-group (group)
3282 "Remove ephemeral GROUP from relevant structures."
3283 (gnus-sethash group nil gnus-newsrc-hashtb))
3285 (defun gnus-simplify-mode-line ()
3286 "Make mode lines a bit simpler."
3287 (setq mode-line-modified (cdr gnus-mode-line-modified))
3288 (when (listp mode-line-format)
3289 (make-local-variable 'mode-line-format)
3290 (setq mode-line-format (copy-sequence mode-line-format))
3291 (when (equal (nth 3 mode-line-format) " ")
3292 (setcar (nthcdr 3 mode-line-format) " "))))
3294 ;;; Servers and groups.
3296 (defsubst gnus-server-add-address (method)
3297 (let ((method-name (symbol-name (car method))))
3298 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3299 (not (assq (intern (concat method-name "-address")) method))
3300 (memq 'physical-address (assq (car method)
3301 gnus-valid-select-methods)))
3302 (append method (list (list (intern (concat method-name "-address"))
3306 (defsubst gnus-method-to-server (method)
3308 (setq method (or method gnus-select-method))
3310 ;; Perhaps it is already in the cache.
3311 (mapc (lambda (name-method)
3312 (if (equal (cdr name-method) method)
3313 (throw 'server-name (car name-method))))
3314 gnus-server-method-cache)
3317 (lambda (server-alist)
3318 (mapc (lambda (name-method)
3319 (when (gnus-methods-equal-p (cdr name-method) method)
3320 (unless (member name-method gnus-server-method-cache)
3321 (push name-method gnus-server-method-cache))
3322 (throw 'server-name (car name-method))))
3324 (let ((alists (list gnus-server-alist
3325 gnus-predefined-server-alist)))
3326 (if gnus-select-method
3327 (push (list (cons "native" gnus-select-method)) alists))
3330 (let* ((name (if (member (cadr method) '(nil ""))
3331 (format "%s" (car method))
3332 (format "%s:%s" (car method) (cadr method))))
3333 (name-method (cons name method)))
3334 (unless (member name-method gnus-server-method-cache)
3335 (push name-method gnus-server-method-cache))
3338 (defsubst gnus-server-to-method (server)
3339 "Map virtual server names to select methods."
3340 (or (and server (listp server) server)
3341 (cdr (assoc server gnus-server-method-cache))
3344 ;; Perhaps this is the native server?
3345 (and (equal server "native") gnus-select-method)
3346 ;; It should be in the server alist.
3347 (cdr (assoc server gnus-server-alist))
3348 ;; It could be in the predefined server alist.
3349 (cdr (assoc server gnus-predefined-server-alist))
3350 ;; If not, we look through all the opened server
3351 ;; to see whether we can find it there.
3352 (let ((opened gnus-opened-servers))
3354 (not (equal server (format "%s:%s" (caaar opened)
3358 ;; It could be a named method, search all servers
3359 (let ((servers gnus-secondary-select-methods))
3361 (not (equal server (format "%s:%s" (caar servers)
3365 ;; This could be some sort of foreign server that I
3366 ;; simply haven't opened (yet). Do a brute-force scan
3367 ;; of the entire gnus-newsrc-alist for the server name
3368 ;; of every method. As a side-effect, loads the
3369 ;; gnus-server-method-cache so this only happens once,
3374 (let ((info-method (gnus-info-method info)))
3375 (unless (stringp info-method)
3376 (let ((info-server (gnus-method-to-server info-method)))
3377 (when (equal server info-server)
3378 (setq match info-method))))))
3379 (cdr gnus-newsrc-alist))
3382 (push (cons server result) gnus-server-method-cache))
3385 (defsubst gnus-server-get-method (group method)
3386 ;; Input either a server name, and extended server name, or a
3387 ;; select method, and return a select method.
3388 (cond ((stringp method)
3389 (gnus-server-to-method method))
3390 ((equal method gnus-select-method)
3392 ((and (stringp (car method))
3394 (gnus-server-extend-method group method))
3397 (equal (cadr method) ""))
3400 (gnus-server-add-address method))))
3402 (defmacro gnus-method-equal (ss1 ss2)
3403 "Say whether two servers are equal."
3407 (and (= (length s1) (length s2))
3409 (while (and s1 (member (car s1) s2))
3413 (defun gnus-methods-equal-p (m1 m2)
3414 (let ((m1 (or m1 gnus-select-method))
3415 (m2 (or m2 gnus-select-method)))
3417 (and (eq (car m1) (car m2))
3418 (or (not (memq 'address (assoc (symbol-name (car m1))
3419 gnus-valid-select-methods)))
3420 (equal (nth 1 m1) (nth 1 m2)))))))
3422 (defun gnus-server-equal (m1 m2)
3423 "Say whether two methods are equal."
3424 (let ((m1 (cond ((null m1) gnus-select-method)
3425 ((stringp m1) (gnus-server-to-method m1))
3427 (m2 (cond ((null m2) gnus-select-method)
3428 ((stringp m2) (gnus-server-to-method m2))
3430 (gnus-method-equal m1 m2)))
3432 (defun gnus-servers-using-backend (backend)
3433 "Return a list of known servers using BACKEND."
3434 (let ((opened gnus-opened-servers)
3437 (when (eq backend (caaar opened))
3438 (push (caar opened) out))
3442 (defun gnus-archive-server-wanted-p ()
3443 "Say whether the user wants to use the archive server."
3445 ((or (not gnus-message-archive-method)
3446 (not gnus-message-archive-group))
3448 ((and gnus-message-archive-method gnus-message-archive-group)
3451 (let ((active (cadr (assq 'nnfolder-active-file
3452 gnus-message-archive-method))))
3454 (file-exists-p active))))))
3456 (defsubst gnus-method-to-server-name (method)
3458 (format "%s" (car method))
3460 (or (assoc (format "%s" (car method))
3461 (gnus-methods-using 'address))
3462 (gnus-server-equal method gnus-message-archive-method))
3464 (not (string= (nth 1 method) "")))
3465 (concat "+" (nth 1 method)))))
3467 (defsubst gnus-method-to-full-server-name (method)
3468 (format "%s+%s" (car method) (nth 1 method)))
3470 (defun gnus-group-prefixed-name (group method &optional full)
3471 "Return the whole name from GROUP and METHOD.
3472 Call with full set to get the fully qualified group name (even if the
3474 (when (stringp method)
3475 (setq method (gnus-server-to-method method)))
3476 (if (or (not method)
3477 (and (not full) (gnus-server-equal method "native"))
3478 ;;;!!! This might not be right. We'll see...
3479 ;(string-match ":" group)
3482 (concat (gnus-method-to-server-name method) ":" group)))
3484 (defun gnus-group-guess-prefixed-name (group)
3485 "Guess the whole name from GROUP and METHOD."
3486 (gnus-group-prefixed-name group (gnus-find-method-for-group
3489 (defun gnus-group-full-name (group method)
3490 "Return the full name from GROUP and METHOD, even if the method is native."
3491 (gnus-group-prefixed-name group method t))
3493 (defun gnus-group-guess-full-name (group)
3494 "Guess the full name from GROUP, even if the method is native."
3495 (if (gnus-group-prefixed-p group)
3497 (gnus-group-full-name group (gnus-find-method-for-group group))))
3499 (defun gnus-group-guess-full-name-from-command-method (group)
3500 "Guess the full name from GROUP, even if the method is native."
3501 (if (gnus-group-prefixed-p group)
3503 (gnus-group-full-name group gnus-command-method)))
3505 (defun gnus-group-real-prefix (group)
3506 "Return the prefix of the current group name."
3508 (if (string-match "^[^:]+:" group)
3509 (substring group 0 (match-end 0))
3513 (defun gnus-group-short-name (group)
3514 "Return the short group name."
3515 (let ((prefix (gnus-group-real-prefix group)))
3516 (if (< 0 (length prefix))
3517 (substring group (length prefix) nil)
3520 (defun gnus-group-prefixed-p (group)
3521 "Return the prefix of the current group name."
3522 (< 0 (length (gnus-group-real-prefix group))))
3524 (defun gnus-summary-buffer-name (group)
3525 "Return the summary buffer name of GROUP."
3526 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3528 (defun gnus-group-method (group)
3529 "Return the server or method used for selecting GROUP.
3530 You should probably use `gnus-find-method-for-group' instead."
3531 (let ((prefix (gnus-group-real-prefix group)))
3532 (if (equal prefix "")
3534 (let ((servers gnus-opened-servers)
3536 backend possible found)
3537 (if (string-match "^[^\\+]+\\+" prefix)
3538 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3539 server (substring prefix (match-end 0) (1- (length prefix))))
3540 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3542 (when (eq (caaar servers) backend)
3543 (setq possible (caar servers))
3544 (when (equal (cadaar servers) server)
3545 (setq found (caar servers))))
3547 (or (car (rassoc found gnus-server-alist))
3549 (car (rassoc possible gnus-server-alist))
3551 (list backend server))))))
3553 (defsubst gnus-native-method-p (method)
3554 "Return whether METHOD is the native select method."
3555 (gnus-method-equal method gnus-select-method))
3557 (defsubst gnus-secondary-method-p (method)
3558 "Return whether METHOD is a secondary select method."
3559 (let ((methods gnus-secondary-select-methods)
3560 (gmethod (inline (gnus-server-get-method nil method))))
3562 (not (gnus-method-equal
3563 (inline (gnus-server-get-method nil (car methods)))
3565 (setq methods (cdr methods)))
3568 (defun gnus-method-simplify (method)
3569 "Return the shortest uniquely identifying string or method for METHOD."
3570 (cond ((stringp method)
3572 ((gnus-native-method-p method)
3574 ((gnus-secondary-method-p method)
3575 (format "%s:%s" (nth 0 method) (nth 1 method)))
3579 (defun gnus-groups-from-server (server)
3580 "Return a list of all groups that are fetched from SERVER."
3581 (let ((alist (cdr gnus-newsrc-alist))
3583 (while (setq info (pop alist))
3584 (when (gnus-server-equal (gnus-info-method info) server)
3585 (push (gnus-info-group info) groups)))
3586 (sort groups 'string<)))
3588 (defun gnus-group-foreign-p (group)
3589 "Say whether a group is foreign or not."
3590 (and (not (gnus-group-native-p group))
3591 (not (gnus-group-secondary-p group))))
3593 (defun gnus-group-native-p (group)
3594 "Say whether the group is native or not."
3595 (not (string-match ":" group)))
3597 (defun gnus-group-secondary-p (group)
3598 "Say whether the group is secondary or not."
3599 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3601 (defun gnus-parameters-get-parameter (group)
3602 "Return the group parameters for GROUP from `gnus-parameters'."
3604 (dolist (elem gnus-parameters)
3605 (when (string-match (car elem) group)
3607 (nconc (gnus-expand-group-parameters
3608 (car elem) (cdr elem) group)
3612 (defun gnus-expand-group-parameter (match value group)
3613 "Use MATCH to expand VALUE in GROUP."
3616 (goto-char (point-min))
3617 (while (re-search-forward match nil t)
3618 (replace-match value))
3621 (defun gnus-expand-group-parameters (match parameters group)
3622 "Go through PARAMETERS and expand them according to the match data."
3624 (dolist (elem parameters)
3625 (if (and (stringp (cdr elem))
3626 (string-match "\\\\[0-9&]" (cdr elem)))
3627 (push (cons (car elem)
3628 (gnus-expand-group-parameter match (cdr elem) group))
3633 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3634 "For GROUP, return the value of SYMBOL.
3636 You should call this in the `gnus-group-buffer' buffer.
3637 The function `gnus-group-find-parameter' will do that for you."
3638 ;; The speed trick: No cons'ing and quit early.
3639 (let* ((params (funcall gnus-group-get-parameter-function group))
3640 ;; Start easy, check the "real" group parameters.
3642 (gnus-group-parameter-value params symbol allow-list t)))
3644 ;; Found results; return them.
3645 (car simple-results)
3646 ;; We didn't found it there, try `gnus-parameters'.
3649 (tail gnus-parameters))
3650 ;; A good old-fashioned non-cl loop.
3652 (setq head (car tail)
3654 ;; The car is regexp matching for matching the group name.
3655 (when (string-match (car head) group)
3656 ;; The cdr is the parameters.
3657 (setq result (gnus-group-parameter-value (cdr head)
3660 ;; Expand if necessary.
3661 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3662 (setq result (gnus-expand-group-parameter (car head)
3664 ;; Exit the loop early.
3669 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3670 "Return the group parameters for GROUP.
3671 If SYMBOL, return the value of that symbol in the group parameters.
3673 If you call this function inside a loop, consider using the faster
3674 `gnus-group-fast-parameter' instead."
3676 (set-buffer gnus-group-buffer)
3678 (gnus-group-fast-parameter group symbol allow-list)
3681 (funcall gnus-group-get-parameter-function group))
3682 (gnus-parameters-get-parameter group)))))
3684 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3685 "Return the group parameters for GROUP.
3686 If SYMBOL, return the value of that symbol in the group parameters.
3687 Most functions should use `gnus-group-find-parameter', which
3688 also examines the topic parameters."
3689 (let ((params (gnus-info-params (gnus-get-info group))))
3691 (gnus-group-parameter-value params symbol allow-list)
3694 (defun gnus-group-parameter-value (params symbol &optional
3695 allow-list present-p)
3696 "Return the value of SYMBOL in group PARAMS."
3697 ;; We only wish to return group parameters (dotted lists) and
3698 ;; not local variables, which may have the same names.
3699 ;; But first we handle single elements...
3700 (or (car (memq symbol params))
3704 (while (setq elem (pop params))
3705 (when (and (consp elem)
3706 (eq (car elem) symbol)
3709 (throw 'found (if present-p (list (cdr elem))
3712 (defun gnus-group-add-parameter (group param)
3713 "Add parameter PARAM to GROUP."
3714 (let ((info (gnus-get-info group)))
3716 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3717 ;; Cons the new param to the old one and update.
3718 (gnus-group-set-info (cons param (gnus-info-params info))
3721 (defun gnus-group-set-parameter (group name value)
3722 "Set parameter NAME to VALUE in GROUP."
3723 (let ((info (gnus-get-info group)))
3725 (gnus-group-remove-parameter group name)
3726 (let ((old-params (gnus-info-params info))
3727 (new-params (list (cons name value))))
3729 (when (or (not (listp (car old-params)))
3730 (not (eq (caar old-params) name)))
3731 (setq new-params (append new-params (list (car old-params)))))
3732 (setq old-params (cdr old-params)))
3733 (gnus-group-set-info new-params group 'params)))))
3735 (defun gnus-group-remove-parameter (group name)
3736 "Remove parameter NAME from GROUP."
3737 (let ((info (gnus-get-info group)))
3739 (let ((params (gnus-info-params info)))
3741 (setq params (delq name params))
3742 (while (assq name params)
3743 (gnus-pull name params))
3744 (gnus-info-set-params info params))))))
3746 (defun gnus-group-add-score (group &optional score)
3747 "Add SCORE to the GROUP score.
3748 If SCORE is nil, add 1 to the score of GROUP."
3749 (let ((info (gnus-get-info group)))
3751 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3753 (defun gnus-short-group-name (group &optional levels)
3754 "Collapse GROUP name LEVELS.
3755 Select methods are stripped and any remote host name is stripped down to
3756 just the host name."
3762 gnus-group-uncollapsed-levels
3764 (while (string-match "\\." group skip)
3765 (setq skip (match-end 0)
3768 ;; Separate foreign select method from group name and collapse.
3769 ;; If method contains a server, collapse to non-domain server name,
3770 ;; otherwise collapse to select method.
3771 (let* ((colon (string-match ":" group))
3772 (server (and colon (substring group 0 colon)))
3773 (plus (and server (string-match "+" server))))
3776 (setq foreign (substring server (+ 1 plus)
3777 (string-match "\\." server))
3778 group (substring group (+ 1 colon)))
3779 (setq foreign server
3780 group (substring group (+ 1 colon))))
3781 (setq foreign (concat foreign ":")))
3782 ;; Collapse group name leaving LEVELS uncollapsed elements
3783 (let* ((slist (split-string group "/"))
3784 (slen (length slist))
3785 (dlist (split-string group "\\."))
3786 (dlen (length dlist))
3798 (setq levels (- glen levels))
3800 (push (if (>= (decf levels) 0)
3801 (if (zerop (length g))
3806 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3808 (defun gnus-narrow-to-body ()
3809 "Narrow to the body of an article."
3812 (goto-char (point-min))
3813 (or (search-forward "\n\n" nil t)
3819 ;;; Kill file handling.
3822 (defun gnus-apply-kill-file ()
3823 "Apply a kill file to the current newsgroup.
3824 Returns the number of articles marked as read."
3825 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3826 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3827 (gnus-apply-kill-file-internal)
3830 (defun gnus-kill-save-kill-buffer ()
3831 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3832 (when (get-file-buffer file)
3834 (set-buffer (get-file-buffer file))
3835 (when (buffer-modified-p)
3837 (kill-buffer (current-buffer))))))
3839 (defcustom gnus-kill-file-name "KILL"
3840 "Suffix of the kill files."
3841 :group 'gnus-score-kill
3842 :group 'gnus-score-files
3845 (defun gnus-newsgroup-kill-file (newsgroup)
3846 "Return the name of a kill file name for NEWSGROUP.
3847 If NEWSGROUP is nil, return the global kill file name instead."
3849 ;; The global KILL file is placed at top of the directory.
3850 ((or (null newsgroup)
3851 (string-equal newsgroup ""))
3852 (expand-file-name gnus-kill-file-name
3853 gnus-kill-files-directory))
3854 ;; Append ".KILL" to newsgroup name.
3855 ((gnus-use-long-file-name 'not-kill)
3856 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3857 "." gnus-kill-file-name)
3858 gnus-kill-files-directory))
3859 ;; Place "KILL" under the hierarchical directory.
3861 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3862 "/" gnus-kill-file-name)
3863 gnus-kill-files-directory))))
3867 (defun gnus-member-of-valid (symbol group)
3868 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3870 (symbol-name (car (gnus-find-method-for-group group)))
3871 gnus-valid-select-methods)))
3873 (defun gnus-method-option-p (method option)
3874 "Return non-nil if select METHOD has OPTION as a parameter."
3875 (when (stringp method)
3876 (setq method (gnus-server-to-method method)))
3877 (memq option (assoc (format "%s" (car method))
3878 gnus-valid-select-methods)))
3880 (defun gnus-similar-server-opened (method)
3881 (let ((opened gnus-opened-servers))
3882 (while (and method opened)
3883 (when (and (equal (cadr method) (cadaar opened))
3884 (equal (car method) (caaar opened))
3885 (not (equal method (caar opened))))
3890 (defun gnus-server-extend-method (group method)
3891 ;; This function "extends" a virtual server. If the server is
3892 ;; "hello", and the select method is ("hello" (my-var "something"))
3893 ;; in the group "alt.alt", this will result in a new virtual server
3894 ;; called "hello+alt.alt".
3895 (if (or (not (inline (gnus-similar-server-opened method)))
3896 (not (cddr method)))
3898 `(,(car method) ,(concat (cadr method) "+" group)
3899 (,(intern (format "%s-address" (car method))) ,(cadr method))
3902 (defun gnus-server-status (method)
3903 "Return the status of METHOD."
3904 (nth 1 (assoc method gnus-opened-servers)))
3906 (defun gnus-group-name-to-method (group)
3907 "Guess a select method based on GROUP."
3908 (if (string-match ":" group)
3909 (let ((server (substring group 0 (match-beginning 0))))
3910 (if (string-match "\\+" server)
3911 (list (intern (substring server 0 (match-beginning 0)))
3912 (substring server (match-end 0)))
3913 (list (intern server) "")))
3914 gnus-select-method))
3916 (defun gnus-server-string (server)
3917 "Return a readable string that describes SERVER."
3918 (let* ((server (gnus-server-to-method server))
3919 (address (nth 1 server)))
3921 (not (zerop (length address))))
3922 (format "%s using %s" address (car server))
3923 (format "%s" (car server)))))
3925 (defun gnus-find-method-for-group (group &optional info)
3926 "Find the select method that GROUP uses."
3927 (or gnus-override-method
3930 (and (not (gnus-group-entry group)) ;; a new group
3931 (gnus-group-name-to-method group))
3932 (let ((info (or info (gnus-get-info group)))
3935 (not (setq method (gnus-info-method info)))
3936 (equal method "native"))
3939 (cond ((stringp method)
3940 (inline (gnus-server-to-method method)))
3941 ((stringp (cadr method))
3942 (inline (gnus-server-extend-method group method)))
3945 (cond ((equal (cadr method) "")
3947 ((null (cadr method))
3948 (list (car method) ""))
3950 (gnus-server-add-address method)))))))
3952 (defun gnus-methods-using (feature)
3953 "Find all methods that have FEATURE."
3954 (let ((valids gnus-valid-select-methods)
3957 (when (memq feature (car valids))
3958 (push (car valids) outs))
3959 (setq valids (cdr valids)))
3963 (autoload 'message-y-or-n-p "message" nil nil 'macro))
3965 (defun gnus-read-group (prompt &optional default)
3966 "Prompt the user for a group name.
3967 Disallow invalid group names."
3972 gnus-invalid-group-regexp
3973 (setq group (read-string (concat prefix prompt)
3974 (cons (or default "") 0)
3975 'gnus-group-history)))
3976 (let ((match (match-string 0 group)))
3977 ;; Might be okay (e.g. for nnimap), so ask the user:
3978 (unless (and (not (string-match "^$\\|:" match))
3980 "Proceed and create group anyway? " t
3981 "The group name \"" group "\" contains a forbidden character: \"" match "\".
3983 Usually, it's dangerous to create a group with this name, because it's not
3984 supported by all back ends and servers. On IMAP servers it should work,
3985 though. If you are really sure, you can proceed anyway and create the group.
3987 You may customize the variable `gnus-invalid-group-regexp', which currently is
3988 set to \"" gnus-invalid-group-regexp
3989 "\", if you want to get rid of this query permanently."))
3990 (setq prefix (format "Invalid group name: \"%s\". " group)
3994 (defun gnus-read-method (prompt)
3995 "Prompt the user for a method.
3996 Allow completion over sensible values."
3997 (let* ((open-servers
3998 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3999 gnus-opened-servers))
4002 (dolist (method gnus-valid-select-methods)
4003 (if (or (memq 'prompt-address method)
4004 (not (assoc (format "%s:" (car method)) open-servers)))
4005 (push method methods)))
4008 (append valid-methods
4010 gnus-predefined-server-alist
4015 nil t nil 'gnus-method-history)))
4018 (setq method gnus-select-method))
4019 ((assoc method gnus-valid-select-methods)
4020 (let ((address (if (memq 'prompt-address
4021 (assoc method gnus-valid-select-methods))
4022 (read-string "Address: ")
4024 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4025 (list (intern method) address))))
4026 ((assoc method servers)
4029 (list (intern method) "")))))
4033 (defun gnus-agent-method-p (method)
4034 "Say whether METHOD is covered by the agent."
4035 (or (eq (car gnus-agent-method-p-cache) method)
4036 (setq gnus-agent-method-p-cache
4038 (member (if (stringp method)
4040 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4041 (cdr gnus-agent-method-p-cache))
4043 (defun gnus-online (method)
4046 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4047 (gnus-agent-method-p method))))
4049 ;;; User-level commands.
4052 (defun gnus-slave-no-server (&optional arg)
4053 "Read network news as a slave, without connecting to the local server."
4055 (gnus-no-server arg t))
4058 (defun gnus-no-server (&optional arg slave)
4060 If ARG is a positive number, Gnus will use that as the startup
4061 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4062 non-nil and not a positive number, Gnus will prompt the user for the
4063 name of an NNTP server to use.
4064 As opposed to `gnus', this command will not connect to the local
4067 (gnus-no-server-1 arg slave))
4070 (defun gnus-slave (&optional arg)
4071 "Read news as a slave."
4073 (gnus arg nil 'slave))
4076 (defun gnus-other-frame (&optional arg display)
4077 "Pop up a frame to read news.
4078 This will call one of the Gnus commands which is specified by the user
4079 option `gnus-other-frame-function' (default `gnus') with the argument
4080 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4081 optional second argument DISPLAY should be a standard display string
4082 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4083 omitted or the function `make-frame-on-display' is not available, the
4084 current display is used."
4086 (if (fboundp 'make-frame-on-display)
4088 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4090 (let ((alive (gnus-alive-p)))
4095 (when (and (or (not display)
4097 (gnus-frame-or-window-display-name
4099 (with-current-buffer (window-buffer window)
4100 (string-match "\\`gnus-"
4101 (symbol-name major-mode))))
4102 (gnus-select-frame-set-input-focus
4103 (setq gnus-other-frame-object (window-frame window)))
4104 (select-window window)
4107 (gnus-select-frame-set-input-focus
4108 (setq gnus-other-frame-object
4110 (make-frame-on-display display gnus-other-frame-parameters)
4111 (make-frame gnus-other-frame-parameters))))
4113 (switch-to-buffer gnus-group-buffer)
4114 (funcall gnus-other-frame-function arg)
4115 (add-hook 'gnus-exit-gnus-hook
4117 (when (and (frame-live-p gnus-other-frame-object)
4119 (delete-frame gnus-other-frame-object))
4120 (setq gnus-other-frame-object nil)))))))
4122 ;;(setq thing ? ; this is a comment
4126 (defun gnus (&optional arg dont-connect slave)
4128 If ARG is non-nil and a positive number, Gnus will use that as the
4129 startup level. If ARG is non-nil and not a positive number, Gnus will
4130 prompt the user for the name of an NNTP server to use."
4132 (unless (byte-code-function-p (symbol-function 'gnus))
4133 (message "You should byte-compile Gnus")
4135 (gnus-1 arg dont-connect slave))
4137 ;; Allow redefinition of Gnus functions.
4143 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4144 ;;; gnus.el ends here