1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
9 ;; Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
10 ;; Keywords: news, mail
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
33 (eval '(run-hooks 'gnus-load-hook))
35 (eval-when-compile (require 'cl))
36 (eval-when-compile (require 'static))
44 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
48 (defgroup gnus-format nil
49 "Dealing with formatting issues."
52 (defgroup gnus-charset nil
53 "Group character set issues."
54 :link '(custom-manual "(gnus)Charsets")
58 (defgroup gnus-cache nil
60 :link '(custom-manual "(gnus)Article Caching")
63 (defgroup gnus-registry nil
67 (defgroup gnus-start nil
68 "Starting your favorite newsreader."
71 (defgroup gnus-start-server nil
72 "Server options at startup."
75 ;; These belong to gnus-group.el.
76 (defgroup gnus-group nil
78 :link '(custom-manual "(gnus)The Group Buffer")
81 (defgroup gnus-group-foreign nil
83 :link '(custom-manual "(gnus)Foreign Groups")
86 (defgroup gnus-group-new nil
87 "Automatic subscription of new groups."
90 (defgroup gnus-group-levels nil
92 :link '(custom-manual "(gnus)Group Levels")
95 (defgroup gnus-group-select nil
97 :link '(custom-manual "(gnus)Selecting a Group")
100 (defgroup gnus-group-listing nil
101 "Showing slices of the group list."
102 :link '(custom-manual "(gnus)Listing Groups")
105 (defgroup gnus-group-visual nil
106 "Sorting the group buffer."
107 :link '(custom-manual "(gnus)Group Buffer Format")
111 (defgroup gnus-group-various nil
112 "Various group options."
113 :link '(custom-manual "(gnus)Scanning New Messages")
116 ;; These belong to gnus-sum.el.
117 (defgroup gnus-summary nil
119 :link '(custom-manual "(gnus)The Summary Buffer")
122 (defgroup gnus-summary-exit nil
123 "Leaving summary buffers."
124 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
125 :group 'gnus-summary)
127 (defgroup gnus-summary-marks nil
128 "Marks used in summary buffers."
129 :link '(custom-manual "(gnus)Marking Articles")
130 :group 'gnus-summary)
132 (defgroup gnus-thread nil
133 "Ordering articles according to replies."
134 :link '(custom-manual "(gnus)Threading")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-format nil
138 "Formatting of the summary buffer."
139 :link '(custom-manual "(gnus)Summary Buffer Format")
140 :group 'gnus-summary)
142 (defgroup gnus-summary-choose nil
144 :link '(custom-manual "(gnus)Choosing Articles")
145 :group 'gnus-summary)
147 (defgroup gnus-summary-maneuvering nil
148 "Summary movement commands."
149 :link '(custom-manual "(gnus)Summary Maneuvering")
150 :group 'gnus-summary)
152 (defgroup gnus-picon nil
153 "Show pictures of people, domains, and newsgroups."
156 (defgroup gnus-summary-mail nil
157 "Mail group commands."
158 :link '(custom-manual "(gnus)Mail Group Commands")
159 :group 'gnus-summary)
161 (defgroup gnus-summary-sort nil
162 "Sorting the summary buffer."
163 :link '(custom-manual "(gnus)Sorting")
164 :group 'gnus-summary)
166 (defgroup gnus-summary-visual nil
167 "Highlighting and menus in the summary buffer."
168 :link '(custom-manual "(gnus)Summary Highlighting")
170 :group 'gnus-summary)
172 (defgroup gnus-summary-various nil
173 "Various summary buffer options."
174 :link '(custom-manual "(gnus)Various Summary Stuff")
175 :group 'gnus-summary)
177 (defgroup gnus-summary-pick nil
178 "Pick mode in the summary buffer."
179 :link '(custom-manual "(gnus)Pick and Read")
181 :group 'gnus-summary)
183 (defgroup gnus-summary-tree nil
184 "Tree display of threads in the summary buffer."
185 :link '(custom-manual "(gnus)Tree Display")
187 :group 'gnus-summary)
189 ;; Belongs to gnus-uu.el
190 (defgroup gnus-extract-view nil
191 "Viewing extracted files."
192 :link '(custom-manual "(gnus)Viewing Files")
193 :group 'gnus-extract)
195 ;; Belongs to gnus-score.el
196 (defgroup gnus-score nil
197 "Score and kill file handling."
200 (defgroup gnus-score-kill nil
204 (defgroup gnus-score-adapt nil
205 "Adaptive score files."
208 (defgroup gnus-score-default nil
209 "Default values for score files."
212 (defgroup gnus-score-expire nil
213 "Expiring score rules."
216 (defgroup gnus-score-decay nil
217 "Decaying score rules."
220 (defgroup gnus-score-files nil
221 "Score and kill file names."
225 (defgroup gnus-score-various nil
226 "Various scoring and killing options."
230 (defgroup gnus-visual nil
231 "Options controlling the visual fluff."
235 (defgroup gnus-agent nil
236 "Offline support for Gnus."
239 (defgroup gnus-files nil
240 "Files used by Gnus."
243 (defgroup gnus-dribble-file nil
245 :link '(custom-manual "(gnus)Auto Save")
248 (defgroup gnus-newsrc nil
249 "Storing Gnus state."
252 (defgroup gnus-server nil
253 "Options related to newsservers and other servers used by Gnus."
256 (defgroup gnus-server-visual nil
257 "Highlighting and menus in the server buffer."
261 (defgroup gnus-message '((message custom-group))
262 "Composing replies and followups in Gnus."
265 (defgroup gnus-meta nil
266 "Meta variables controlling major portions of Gnus.
267 In general, modifying these variables does not take affect until Gnus
268 is restarted, and sometimes reloaded."
271 (defgroup gnus-various nil
272 "Other Gnus options."
273 :link '(custom-manual "(gnus)Various Various")
276 (defgroup gnus-mime nil
277 "Variables for controlling the Gnus MIME interface."
280 (defgroup gnus-exit nil
282 :link '(custom-manual "(gnus)Exiting Gnus")
285 (defgroup gnus-fun nil
286 "Frivolous Gnus extensions."
287 :link '(custom-manual "(gnus)Exiting Gnus")
290 (defcustom gnus-inhibit-startup-message nil
291 "If non-nil, the startup message will not be displayed.
292 This variable is used before `.gnus.el' is loaded, so it should
293 be set in `.emacs' instead."
297 (defcustom gnus-play-startup-jingle nil
298 "If non-nil, play the Gnus jingle at startup."
302 (unless (fboundp 'gnus-group-remove-excess-properties)
303 (defalias 'gnus-group-remove-excess-properties 'ignore))
305 (unless (fboundp 'gnus-set-text-properties)
306 (defalias 'gnus-set-text-properties 'set-text-properties))
308 (unless (featurep 'gnus-xmas)
309 (defalias 'gnus-make-overlay 'make-overlay)
310 (defalias 'gnus-delete-overlay 'delete-overlay)
311 (defalias 'gnus-overlay-put 'overlay-put)
312 (defalias 'gnus-move-overlay 'move-overlay)
313 (defalias 'gnus-overlay-buffer 'overlay-buffer)
314 (defalias 'gnus-overlay-start 'overlay-start)
315 (defalias 'gnus-overlay-end 'overlay-end)
316 (defalias 'gnus-extent-detached-p 'ignore)
317 (defalias 'gnus-extent-start-open 'ignore)
318 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
319 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
320 (defalias 'gnus-character-to-event 'identity)
321 (defalias 'gnus-assq-delete-all 'assq-delete-all)
322 (defalias 'gnus-add-text-properties 'add-text-properties)
323 (defalias 'gnus-put-text-property 'put-text-property)
324 (defvar gnus-mode-line-image-cache t)
325 (if (fboundp 'find-image)
326 (defun gnus-mode-line-buffer-identification (line)
327 (let ((str (car-safe line)))
328 (if (and (stringp str)
329 (string-match "^Gnus:" str))
330 (progn (add-text-properties
333 (if (eq t gnus-mode-line-image-cache)
334 (setq gnus-mode-line-image-cache
336 '((:type xpm :file "gnus-pointer.xpm"
338 (:type xbm :file "gnus-pointer.xbm"
340 gnus-mode-line-image-cache)
341 'help-echo "This is Gnus")
345 (defalias 'gnus-mode-line-buffer-identification 'identity))
346 (defalias 'gnus-characterp 'numberp)
347 (defalias 'gnus-deactivate-mark 'deactivate-mark)
348 (defalias 'gnus-window-edges 'window-edges)
349 (defalias 'gnus-key-press-event-p 'numberp)
350 ;;(defalias 'gnus-decode-rfc1522 'ignore)
353 ;; We define these group faces here to avoid the display
354 ;; update forced when creating new faces.
356 (defface gnus-group-news-1-face
359 (:foreground "PaleTurquoise" :bold t))
362 (:foreground "ForestGreen" :bold t))
365 "Level 1 newsgroup face.")
367 (defface gnus-group-news-1-empty-face
370 (:foreground "PaleTurquoise"))
373 (:foreground "ForestGreen"))
376 "Level 1 empty newsgroup face.")
378 (defface gnus-group-news-2-face
381 (:foreground "turquoise" :bold t))
384 (:foreground "CadetBlue4" :bold t))
387 "Level 2 newsgroup face.")
389 (defface gnus-group-news-2-empty-face
392 (:foreground "turquoise"))
395 (:foreground "CadetBlue4"))
398 "Level 2 empty newsgroup face.")
400 (defface gnus-group-news-3-face
409 "Level 3 newsgroup face.")
411 (defface gnus-group-news-3-empty-face
420 "Level 3 empty newsgroup face.")
422 (defface gnus-group-news-4-face
431 "Level 4 newsgroup face.")
433 (defface gnus-group-news-4-empty-face
442 "Level 4 empty newsgroup face.")
444 (defface gnus-group-news-5-face
453 "Level 5 newsgroup face.")
455 (defface gnus-group-news-5-empty-face
464 "Level 5 empty newsgroup face.")
466 (defface gnus-group-news-6-face
475 "Level 6 newsgroup face.")
477 (defface gnus-group-news-6-empty-face
486 "Level 6 empty newsgroup face.")
488 (defface gnus-group-news-low-face
491 (:foreground "DarkTurquoise" :bold t))
494 (:foreground "DarkGreen" :bold t))
497 "Low level newsgroup face.")
499 (defface gnus-group-news-low-empty-face
502 (:foreground "DarkTurquoise"))
505 (:foreground "DarkGreen"))
508 "Low level empty newsgroup face.")
510 (defface gnus-group-mail-1-face
513 (:foreground "aquamarine1" :bold t))
516 (:foreground "DeepPink3" :bold t))
519 "Level 1 mailgroup face.")
521 (defface gnus-group-mail-1-empty-face
524 (:foreground "aquamarine1"))
527 (:foreground "DeepPink3"))
529 (:italic t :bold t)))
530 "Level 1 empty mailgroup face.")
532 (defface gnus-group-mail-2-face
535 (:foreground "aquamarine2" :bold t))
538 (:foreground "HotPink3" :bold t))
541 "Level 2 mailgroup face.")
543 (defface gnus-group-mail-2-empty-face
546 (:foreground "aquamarine2"))
549 (:foreground "HotPink3"))
552 "Level 2 empty mailgroup face.")
554 (defface gnus-group-mail-3-face
557 (:foreground "aquamarine3" :bold t))
560 (:foreground "magenta4" :bold t))
563 "Level 3 mailgroup face.")
565 (defface gnus-group-mail-3-empty-face
568 (:foreground "aquamarine3"))
571 (:foreground "magenta4"))
574 "Level 3 empty mailgroup face.")
576 (defface gnus-group-mail-low-face
579 (:foreground "aquamarine4" :bold t))
582 (:foreground "DeepPink4" :bold t))
585 "Low level mailgroup face.")
587 (defface gnus-group-mail-low-empty-face
590 (:foreground "aquamarine4"))
593 (:foreground "DeepPink4"))
596 "Low level empty mailgroup face.")
598 ;; Summary mode faces.
600 (defface gnus-summary-selected-face '((t
602 "Face used for selected articles.")
604 (defface gnus-summary-cancelled-face
606 (:foreground "yellow" :background "black")))
607 "Face used for cancelled articles.")
609 (defface gnus-summary-high-ticked-face
612 (:foreground "pink" :bold t))
615 (:foreground "firebrick" :bold t))
618 "Face used for high interest ticked articles.")
620 (defface gnus-summary-low-ticked-face
623 (:foreground "pink" :italic t))
626 (:foreground "firebrick" :italic t))
629 "Face used for low interest ticked articles.")
631 (defface gnus-summary-normal-ticked-face
634 (:foreground "pink"))
637 (:foreground "firebrick"))
640 "Face used for normal interest ticked articles.")
642 (defface gnus-summary-high-ancient-face
645 (:foreground "SkyBlue" :bold t))
648 (:foreground "RoyalBlue" :bold t))
651 "Face used for high interest ancient articles.")
653 (defface gnus-summary-low-ancient-face
656 (:foreground "SkyBlue" :italic t))
659 (:foreground "RoyalBlue" :italic t))
662 "Face used for low interest ancient articles.")
664 (defface gnus-summary-normal-ancient-face
667 (:foreground "SkyBlue"))
670 (:foreground "RoyalBlue"))
673 "Face used for normal interest ancient articles.")
675 (defface gnus-summary-high-undownloaded-face
678 (:bold t :foreground "cyan4"))
679 (((class color) (background dark))
680 (:bold t :foreground "LightGray"))
681 (t (:inverse-video t :bold t)))
682 "Face used for high interest uncached articles.")
684 (defface gnus-summary-low-undownloaded-face
687 (:italic t :foreground "cyan4" :bold nil))
688 (((class color) (background dark))
689 (:italic t :foreground "LightGray" :bold nil))
690 (t (:inverse-video t :italic t)))
691 "Face used for low interest uncached articles.")
693 (defface gnus-summary-normal-undownloaded-face
696 (:foreground "cyan4" :bold nil))
697 (((class color) (background dark))
698 (:foreground "LightGray" :bold nil))
699 (t (:inverse-video t)))
700 "Face used for normal interest uncached articles.")
702 (defface gnus-summary-high-unread-face
705 "Face used for high interest unread articles.")
707 (defface gnus-summary-low-unread-face
710 "Face used for low interest unread articles.")
712 (defface gnus-summary-normal-unread-face
715 "Face used for normal interest unread articles.")
717 (defface gnus-summary-incorporated-face
720 "Face used for incorporated articles.")
722 (defface gnus-summary-high-read-face
725 (:foreground "PaleGreen"
729 (:foreground "DarkGreen"
733 "Face used for high interest read articles.")
735 (defface gnus-summary-low-read-face
738 (:foreground "PaleGreen"
742 (:foreground "DarkGreen"
746 "Face used for low interest read articles.")
748 (defface gnus-summary-normal-read-face
751 (:foreground "PaleGreen"))
754 (:foreground "DarkGreen"))
757 "Face used for normal interest read articles.")
764 (defvar gnus-buffers nil)
766 (defun gnus-get-buffer-create (name)
767 "Do the same as `get-buffer-create', but store the created buffer."
768 (or (get-buffer name)
769 (car (push (get-buffer-create name) gnus-buffers))))
771 (defun gnus-add-buffer ()
772 "Add the current buffer to the list of Gnus buffers."
773 (push (current-buffer) gnus-buffers))
775 (defmacro gnus-kill-buffer (buffer)
776 "Kill BUFFER and remove from the list of Gnus buffers."
777 `(let ((buf ,buffer))
778 (when (gnus-buffer-exists-p buf)
779 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
782 (defun gnus-buffers ()
783 "Return a list of live Gnus buffers."
784 (while (and gnus-buffers
785 (not (buffer-name (car gnus-buffers))))
787 (let ((buffers gnus-buffers))
789 (if (buffer-name (cadr buffers))
791 (setcdr buffers (cddr buffers)))))
796 (defvar gnus-group-buffer "*Group*")
799 (autoload 'gnus-play-jingle "gnus-audio"))
801 (defface gnus-splash-face
804 (:foreground "#888888"))
807 (:foreground "#888888"))
810 "Face for the splash screen.")
812 (defun gnus-splash ()
814 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
815 (let ((buffer-read-only nil))
817 (unless gnus-inhibit-startup-message
818 (gnus-group-startup-message)
820 (when gnus-play-startup-jingle
821 (gnus-play-jingle))))))
823 (defun gnus-indent-rigidly (start end arg)
824 "Indent rigidly using only spaces and no tabs."
827 (narrow-to-region start end)
829 (indent-rigidly start end arg)
830 ;; We translate tabs into spaces -- not everybody uses
831 ;; an 8-character tab.
832 (goto-char (point-min))
833 (while (search-forward "\t" nil t)
834 (replace-match " " t t))))))
836 (defvar gnus-simple-splash nil)
838 ;;(format "%02x%02x%02x" 114 66 20) "724214"
840 (defvar gnus-logo-color-alist
841 '((flame "#cc3300" "#ff2200")
842 (pine "#c0cc93" "#f8ffb8")
843 (moss "#a1cc93" "#d2ffb8")
844 (irish "#04cc90" "#05ff97")
845 (sky "#049acc" "#05deff")
846 (tin "#6886cc" "#82b6ff")
847 (velvet "#7c68cc" "#8c82ff")
848 (grape "#b264cc" "#cf7df")
849 (labia "#cc64c2" "#fd7dff")
850 (berry "#cc6485" "#ff7db5")
851 (dino "#724214" "#1e3f03")
852 (oort "#cccccc" "#888888")
853 (storm "#666699" "#99ccff")
854 (pdino "#9999cc" "#99ccff")
855 (purp "#9999cc" "#666699")
856 (no "#000000" "#ff0000")
857 (neutral "#b4b4b4" "#878787")
858 (september "#bf9900" "#ffcc00"))
859 "Color alist used for the Gnus logo.")
861 (defcustom gnus-logo-color-style 'oort
862 "*Color styles used for the Gnus logo."
863 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
864 gnus-logo-color-alist))
867 (defvar gnus-logo-colors
868 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
869 "Colors used for the Gnus logo.")
871 (defun gnus-group-startup-message (&optional x y)
872 "Insert startup message in current buffer."
873 ;; Insert the message.
876 ((and (fboundp 'find-image)
878 (let* ((bg (face-background 'default))
879 (fg (face-foreground 'gnus-splash-face))
880 (data-directory (nnheader-find-etc-directory "gnus"))
882 `((:type xpm :file "gnus.xpm"
884 (("thing" . ,(car gnus-logo-colors))
885 ("shadow" . ,(cadr gnus-logo-colors))
887 ("background" . ,bg)))
888 (:type pbm :file "gnus.pbm"
889 ;; Account for the pbm's blackground.
890 :background ,bg :foreground ,fg)
891 (:type xbm :file "gnus.xbm"
892 ;; Account for the xbm's blackground.
893 :background ,bg :foreground ,fg)))))
897 (concat gnus-product-name " " gnus-version-number
898 (if (zerop (string-to-number gnus-revision-number))
900 (concat " (r" gnus-revision-number ")"))
901 " based on " gnus-original-product-name " v"
902 gnus-original-version-number)
903 'face `(variable-pitch :background ,bg :foreground ,fg)))
904 (let ((fill-column (window-width)))
905 (center-region (point-min) (point)))
906 (let ((size (image-size image)))
907 (insert-char ?\n (max 1 (round (- (window-height)
908 (or y (cdr size))) 2)))
910 (propertize " " 'display
912 ,(max 0 (round (- (window-width)
913 (or x (car size))) 2)))))
914 (insert-image image))
915 (setq gnus-simple-splash nil)
920 _ ___ __ ___ __ _ ___
939 (goto-char (point-min))
940 (insert gnus-product-name " " gnus-version-number
941 (if (zerop (string-to-number gnus-revision-number))
943 (concat " (r" gnus-revision-number ")"))
944 " based on " gnus-original-product-name " v"
945 gnus-original-version-number)
946 (insert-char ?\ (prog1
947 (max 0 (/ (- (window-width) (point)) 2))
948 (goto-char (point-min))))
951 (gnus-indent-rigidly (point) (point-max)
952 (/ (max (- (window-width) (or x 46)) 0) 2))
953 (goto-char (point-min))
955 (let* ((pheight (count-lines (point-min) (point-max)))
956 (wheight (window-height))
957 (rest (- wheight pheight)))
958 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
960 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
961 (setq gnus-simple-splash t)))
962 (goto-char (point-min))
963 (setq mode-line-buffer-identification (concat " " gnus-version))
964 (set-buffer-modified-p t))
967 (let ((command (format "%s" this-command)))
968 (if (and (string-match "gnus" command)
969 (not (string-match "gnus-other-frame" command)))
971 (gnus-get-buffer-create gnus-group-buffer))))
978 (defcustom gnus-parameters nil
979 "Alist of group parameters.
982 ((\"mail\\\\..*\" (gnus-show-threads nil)
983 (gnus-use-scoring nil)
984 (gnus-summary-line-format
985 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
988 (\"mail\\\\.me\" (gnus-use-scoring t))
989 (\"list\\\\..*\" (total-expire . t)
990 (broken-reply-to . t)))"
991 :group 'gnus-group-various
992 :type '(repeat (cons regexp
995 (defvar gnus-group-parameters-more nil)
997 (defvar gnus-colon-keywords
999 (when (boundp 'dgnushack-colon-keywords)
1000 (symbol-value 'dgnushack-colon-keywords)))
1001 "List of the colon keywords should be bound at run-time. This variable
1002 defaults to a proper value only if this file is byte-compiled by make.")
1004 (dolist (keyword gnus-colon-keywords)
1005 (set keyword keyword))
1007 (defmacro gnus-define-group-parameter (param &rest rest)
1008 "Define a group parameter PARAM.
1009 REST is a plist of following:
1010 :type One of `bool', `list' or nil.
1011 :function The name of the function.
1012 :function-document The documentation of the function.
1013 :parameter-type The type for customizing the parameter.
1014 :parameter-document The documentation for the parameter.
1015 :variable The name of the variable.
1016 :variable-document The documentation for the variable.
1017 :variable-group The group for customizing the variable.
1018 :variable-type The type for customizing the variable.
1019 :variable-default The default value of the variable."
1020 (let* ((type (plist-get rest :type))
1021 (parameter-type (plist-get rest :parameter-type))
1022 (parameter-document (plist-get rest :parameter-document))
1023 (function (or (plist-get rest :function)
1024 (intern (format "gnus-parameter-%s" param))))
1025 (function-document (or (plist-get rest :function-document) ""))
1026 (variable (or (plist-get rest :variable)
1027 (intern (format "gnus-parameter-%s-alist" param))))
1028 (variable-document (or (plist-get rest :variable-document) ""))
1029 (variable-group (plist-get rest :variable-group))
1030 (variable-type (or (plist-get rest :variable-type)
1032 (list (regexp :tag "Group")
1033 ,(car (cdr parameter-type)))))))
1034 (variable-default (plist-get rest :variable-default)))
1037 `(defcustom ,variable ,variable-default
1039 :group 'gnus-group-parameter
1040 :group ',variable-group
1041 :type ,variable-type)
1042 `(setq gnus-group-parameters-more
1043 (delq (assq ',param gnus-group-parameters-more)
1044 gnus-group-parameters-more))
1045 `(add-to-list 'gnus-group-parameters-more
1048 ,parameter-document))
1050 `(defun ,function (name)
1052 (let ((params (gnus-group-find-parameter name))
1055 ((memq ',param params)
1057 ((setq val (assq ',param params))
1059 ((stringp ,variable)
1060 (string-match ,variable name))
1062 (let ((alist ,variable)
1064 (while (setq elem (pop alist))
1066 (string-match (car elem) name))
1069 (if (consp value) (car value) value))))))
1070 `(defun ,function (name)
1073 (or (gnus-group-find-parameter name ',param ,(and type t))
1074 (let ((alist ,variable)
1076 (while (setq elem (pop alist))
1078 (string-match (car elem) name))
1083 '(if (consp value) (car value) value))))))))))
1085 (defcustom gnus-home-directory "~/"
1086 "Directory variable that specifies the \"home\" directory.
1087 All other Gnus file and directory variables are initialized from this variable."
1091 (defcustom gnus-directory (or (getenv "SAVEDIR")
1092 (nnheader-concat gnus-home-directory "News/"))
1093 "*Directory variable from which all other Gnus file variables are derived.
1095 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1096 This means that other directory variables that are initialized from
1097 this variable won't be set properly if you set this variable in `.gnus.el'.
1098 Set this variable in `.emacs' instead."
1102 (defcustom gnus-default-directory nil
1103 "*Default directory for all Gnus buffers."
1105 :type '(choice (const :tag "current" nil)
1108 ;; Site dependent variables. These variables should be defined in
1111 (defvar gnus-default-nntp-server nil
1112 "Specify a default NNTP server.
1113 This variable should be defined in paths.el, and should never be set
1115 If you want to change servers, you should use `gnus-select-method'.
1116 See the documentation to that variable.")
1118 ;; Don't touch this variable.
1119 (defvar gnus-nntp-service "nntp"
1120 "NNTP service name (\"nntp\" or 119).
1121 This is an obsolete variable, which is scarcely used. If you use an
1122 nntp server for your newsgroup and want to change the port number
1123 used to 899, you would say something along these lines:
1125 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1127 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1128 "A file with only the name of the nntp server in it."
1133 ;; This function is used to check both the environment variable
1134 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
1135 ;; an nntp server name default.
1136 (defun gnus-getenv-nntpserver ()
1137 (or (getenv "NNTPSERVER")
1138 (and (file-readable-p gnus-nntpserver-file)
1140 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
1141 (insert-file-contents gnus-nntpserver-file)
1142 (let ((name (buffer-string)))
1144 (if (string-match "\\'[ \t\n]*$" name)
1147 (kill-buffer (current-buffer))))))))
1149 (defcustom gnus-select-method
1152 (list 'nntp (or (condition-case nil
1153 (gnus-getenv-nntpserver)
1155 (when (and gnus-default-nntp-server
1156 (not (string= gnus-default-nntp-server "")))
1157 gnus-default-nntp-server)
1159 (if (or (null gnus-nntp-service)
1160 (equal gnus-nntp-service "nntp"))
1162 (list gnus-nntp-service)))
1164 "Default method for selecting a newsgroup.
1165 This variable should be a list, where the first element is how the
1166 news is to be fetched, the second is the address.
1168 For instance, if you want to get your news via \"flab.flab.edu\" using
1169 NNTP, you could say:
1171 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1173 If you want to use your local spool, say:
1175 \(setq gnus-select-method (list 'nnspool (system-name)))
1177 If you use this variable, you must set `gnus-nntp-server' to nil.
1179 There is a lot more to know about select methods and virtual servers -
1180 see the manual for details."
1182 :type 'gnus-select-method)
1184 (defcustom gnus-message-archive-method "archive"
1185 "*Method used for archiving messages you've sent.
1186 This should be a mail method."
1188 :group 'gnus-message
1189 :type '(choice (const :tag "Default archive method" "archive")
1190 gnus-select-method))
1192 (defcustom gnus-message-archive-group nil
1193 "*Name of the group in which to save the messages you've written.
1194 This can either be a string; a list of strings; or an alist
1195 of regexps/functions/forms to be evaluated to return a string (or a list
1196 of strings). The functions are called with the name of the current
1197 group (or nil) as a parameter.
1199 If you want to save your mail in one group and the news articles you
1200 write in another group, you could say something like:
1202 \(setq gnus-message-archive-group
1203 '((if (message-news-p)
1207 Normally the group names returned by this variable should be
1208 unprefixed -- which implicitly means \"store on the archive server\".
1209 However, you may wish to store the message on some other server. In
1210 that case, just return a fully prefixed name of the group --
1211 \"nnml+private:mail.misc\", for instance."
1212 :group 'gnus-message
1213 :type '(choice (const :tag "none" nil)
1218 (defcustom gnus-secondary-servers nil
1219 "List of NNTP servers that the user can choose between interactively.
1220 To make Gnus query you for a server, you have to give `gnus' a
1221 non-numeric prefix - `C-u M-x gnus', in short."
1223 :type '(repeat string))
1225 (defcustom gnus-nntp-server nil
1226 "*The name of the host running the NNTP server.
1227 This variable is semi-obsolete. Use the `gnus-select-method'
1230 :type '(choice (const :tag "disable" nil)
1233 (defcustom gnus-secondary-select-methods nil
1234 "A list of secondary methods that will be used for reading news.
1235 This is a list where each element is a complete select method (see
1236 `gnus-select-method').
1238 If, for instance, you want to read your mail with the nnml back end,
1239 you could set this variable:
1241 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1243 :type '(repeat gnus-select-method))
1245 (defvar gnus-backup-default-subscribed-newsgroups
1246 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1247 "Default default new newsgroups the first time Gnus is run.
1248 Should be set in paths.el, and shouldn't be touched by the user.")
1250 (defcustom gnus-local-domain nil
1251 "Local domain name without a host name.
1252 The DOMAINNAME environment variable is used instead if it is defined.
1253 If the function `system-name' returns the full Internet name, there is
1254 no need to set this variable."
1255 :group 'gnus-message
1256 :type '(choice (const :tag "default" nil)
1259 (defvar gnus-local-organization nil
1260 "String with a description of what organization (if any) the user belongs to.
1261 Obsolete variable; use `message-user-organization' instead.")
1263 ;; Customization variables
1265 (defcustom gnus-refer-article-method nil
1266 "Preferred method for fetching an article by Message-ID.
1267 If you are reading news from the local spool (with nnspool), fetching
1268 articles by Message-ID is painfully slow. By setting this method to an
1269 nntp method, you might get acceptable results.
1271 The value of this variable must be a valid select method as discussed
1272 in the documentation of `gnus-select-method'.
1274 It can also be a list of select methods, as well as the special symbol
1275 `current', which means to use the current select method. If it is a
1276 list, Gnus will try all the methods in the list until it finds a match."
1278 :type '(choice (const :tag "default" nil)
1280 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1282 (repeat :menu-tag "Try multiple"
1284 :value (current (nnweb "refer" (nnweb-type google)))
1285 (choice :tag "Method"
1287 (const :tag "Google"
1288 (nnweb "refer" (nnweb-type google)))
1289 gnus-select-method))))
1291 (defcustom gnus-group-faq-directory
1292 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1293 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1294 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1295 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1296 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1297 "/ftp@rtfm.mit.edu:/pub/usenet/"
1298 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1299 "/ftp@ftp.sunet.se:/pub/usenet/"
1300 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1301 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1302 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1303 "*Directory where the group FAQs are stored.
1304 This will most commonly be on a remote machine, and the file will be
1305 fetched by ange-ftp.
1307 This variable can also be a list of directories. In that case, the
1308 first element in the list will be used by default. The others can
1309 be used when being prompted for a site.
1311 Note that Gnus uses an aol machine as the default directory. If this
1312 feels fundamentally unclean, just think of it as a way to finally get
1313 something of value back from them.
1315 If the default site is too slow, try one of these:
1317 North America: mirrors.aol.com /pub/rtfm/usenet
1318 ftp.seas.gwu.edu /pub/rtfm
1319 rtfm.mit.edu /pub/usenet
1320 Europe: ftp.uni-paderborn.de /pub/FAQ
1321 src.doc.ic.ac.uk /usenet/news-FAQS
1322 ftp.sunet.se /pub/usenet
1323 ftp.pasteur.fr /pub/FAQ
1324 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1325 hwarang.postech.ac.kr /pub/usenet
1326 ftp.hk.super.net /mirror/faqs"
1327 :group 'gnus-group-various
1328 :type '(choice directory
1329 (repeat directory)))
1331 (defcustom gnus-group-charter-alist
1332 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1333 ("de" . (concat "http://purl.net/charta/" name ".html"))
1334 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1335 ("england" . (concat "http://england.news-admin.org/charters/" name))
1336 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1337 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1338 (gnus-replace-in-string name "europa\\." "") ".html"))
1339 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1340 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1341 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1342 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1343 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1344 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1345 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1346 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1347 (gnus-replace-in-string name "\\." "_") ".html"))
1348 ("milw" . (concat "http://usenet.mil.wi.us/"
1349 (gnus-replace-in-string name "milw\\." "") "-charter"))
1350 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1351 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1352 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1353 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1354 When FORM is evaluated `name' is bound to the name of the group."
1355 :group 'gnus-group-various
1356 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1358 (defcustom gnus-group-fetch-control-use-browse-url nil
1359 "*Non-nil means that control messages are displayed using `browse-url'.
1360 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1362 :group 'gnus-group-various
1365 (defcustom gnus-use-cross-reference t
1366 "*Non-nil means that cross referenced articles will be marked as read.
1367 If nil, ignore cross references. If t, mark articles as read in
1368 subscribed newsgroups. If neither t nor nil, mark as read in all
1371 :type '(choice (const :tag "off" nil)
1372 (const :tag "subscribed" t)
1376 (defcustom gnus-process-mark ?#
1378 :group 'gnus-group-visual
1379 :group 'gnus-summary-marks
1382 (defcustom gnus-large-newsgroup 200
1383 "*The number of articles which indicates a large newsgroup.
1384 If the number of articles in a newsgroup is greater than this value,
1385 confirmation is required for selecting the newsgroup.
1386 If it is nil, no confirmation is required."
1387 :group 'gnus-group-select
1388 :type '(choice (const :tag "No limit" nil)
1391 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1392 "*Non-nil means that the default name of a file to save articles in is the group name.
1393 If it's nil, the directory form of the group name is used instead.
1395 If this variable is a list, and the list contains the element
1396 `not-score', long file names will not be used for score files; if it
1397 contains the element `not-save', long file names will not be used for
1398 saving; and if it contains the element `not-kill', long file names
1399 will not be used for kill files.
1401 Note that the default for this variable varies according to what system
1402 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1403 to nil while on all other systems it defaults to t."
1405 :type '(radio (sexp :format "Non-nil\n"
1406 :match (lambda (widget value)
1407 (and value (not (listp value))))
1410 (checklist (const :format "%v " not-score)
1411 (const :format "%v " not-save)
1414 (defcustom gnus-kill-files-directory gnus-directory
1415 "*Name of the directory where kill files will be stored (default \"~/News\")."
1416 :group 'gnus-score-files
1417 :group 'gnus-score-kill
1420 (defcustom gnus-save-score nil
1421 "*If non-nil, save group scoring info."
1422 :group 'gnus-score-various
1426 (defcustom gnus-use-undo t
1427 "*If non-nil, allow undoing in Gnus group mode buffers."
1431 (defcustom gnus-use-adaptive-scoring nil
1432 "*If non-nil, use some adaptive scoring scheme.
1433 If a list, then the values `word' and `line' are meaningful. The
1434 former will perform adaption on individual words in the subject
1435 header while `line' will perform adaption on several headers."
1437 :group 'gnus-score-adapt
1438 :type '(set (const word) (const line)))
1440 (defcustom gnus-use-cache 'passive
1441 "*If nil, Gnus will ignore the article cache.
1442 If `passive', it will allow entering (and reading) articles
1443 explicitly entered into the cache. If anything else, use the
1444 cache to the full extent of the law."
1447 :type '(choice (const :tag "off" nil)
1448 (const :tag "passive" passive)
1449 (const :tag "active" t)))
1451 (defcustom gnus-use-trees nil
1452 "*If non-nil, display a thread tree buffer."
1456 (defcustom gnus-use-grouplens nil
1457 "*If non-nil, use GroupLens ratings."
1461 (defcustom gnus-keep-backlog 20
1462 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1463 If it is a number N, then Gnus will only keep the last N articles
1464 read. If it is neither nil nor a number, Gnus will keep all read
1465 articles. This is not a good idea."
1467 :type '(choice (const :tag "off" nil)
1472 (defcustom gnus-use-nocem nil
1473 "*If non-nil, Gnus will read NoCeM cancel messages."
1477 (defcustom gnus-suppress-duplicates nil
1478 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1482 (defcustom gnus-use-scoring t
1483 "*If non-nil, enable scoring."
1487 (defcustom gnus-summary-prepare-exit-hook
1488 '(gnus-summary-expire-articles)
1489 "*A hook called when preparing to exit from the summary buffer.
1490 It calls `gnus-summary-expire-articles' by default."
1491 :group 'gnus-summary-exit
1494 (defcustom gnus-novice-user t
1495 "*Non-nil means that you are a Usenet novice.
1496 If non-nil, verbose messages may be displayed and confirmations may be
1501 (defcustom gnus-expert-user nil
1502 "*Non-nil means that you will never be asked for confirmation about anything.
1503 That doesn't mean *anything* anything; particularly destructive
1504 commands will still require prompting."
1508 (defcustom gnus-interactive-catchup t
1509 "*If non-nil, require your confirmation when catching up a group."
1510 :group 'gnus-group-select
1513 (defcustom gnus-interactive-exit t
1514 "*If non-nil, require your confirmation when exiting Gnus."
1518 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1519 "Function for extracting address components from a From header.
1520 Three pre-defined functions exist: `gnus-extract-address-components',
1521 which is the default, quite fast, and too simplistic solution,
1522 `mail-extract-address-components', which works much better, but is
1523 slower, and `std11-extract-address-components'."
1524 :group 'gnus-summary-format
1525 :type '(radio (function-item gnus-extract-address-components)
1526 (function-item mail-extract-address-components)
1527 (function-item std11-extract-address-components)
1528 (function :tag "Other")))
1530 (defcustom gnus-carpal nil
1531 "*If non-nil, display clickable icons."
1535 (defcustom gnus-shell-command-separator ";"
1536 "String used to separate shell commands."
1540 (defcustom gnus-valid-select-methods
1541 '(("nntp" post address prompt-address physical-address)
1542 ("nnspool" post address)
1543 ("nnvirtual" post-mail virtual prompt-address)
1544 ("nnmbox" mail respool address)
1545 ("nnml" post-mail respool address)
1546 ("nnmh" mail respool address)
1547 ("nndir" post-mail prompt-address physical-address)
1548 ("nneething" none address prompt-address physical-address)
1549 ("nndoc" none address prompt-address)
1550 ("nnbabyl" mail address respool)
1551 ("nnkiboze" post virtual)
1552 ("nnsoup" post-mail address)
1553 ("nndraft" post-mail)
1554 ("nnfolder" mail respool address)
1555 ("nngateway" post-mail address prompt-address physical-address)
1564 ("nnagent" post-mail)
1565 ("nnimap" post-mail address prompt-address physical-address)
1566 ("nnmaildir" mail respool address)
1568 "*An alist of valid select methods.
1569 The first element of each list lists should be a string with the name
1570 of the select method. The other elements may be the category of
1571 this method (i. e., `post', `mail', `none' or whatever) or other
1572 properties that this method has (like being respoolable).
1573 If you implement a new select method, all you should have to change is
1574 this variable. I think."
1576 :type '(repeat (group (string :tag "Name")
1577 (radio-button-choice (const :format "%v " post)
1578 (const :format "%v " mail)
1579 (const :format "%v " none)
1581 (checklist :inline t
1582 (const :format "%v " address)
1583 (const :format "%v " prompt-address)
1584 (const :format "%v " physical-address)
1585 (const :format "%v " virtual)
1588 (defun gnus-redefine-select-method-widget ()
1589 "Recomputes the select-method widget based on the value of
1590 `gnus-valid-select-methods'."
1591 (define-widget 'gnus-select-method 'list
1592 "Widget for entering a select method."
1594 :tag "Select Method"
1595 :args `((choice :tag "Method"
1596 ,@(mapcar (lambda (entry)
1597 (list 'const :format "%v\n"
1598 (intern (car entry))))
1599 gnus-valid-select-methods)
1600 (symbol :tag "other"))
1601 (string :tag "Address")
1602 (repeat :tag "Options"
1606 (sexp :tag "Value"))))))
1608 (gnus-redefine-select-method-widget)
1610 (defcustom gnus-updated-mode-lines '(group article summary tree)
1611 "List of buffers that should update their mode lines.
1612 The list may contain the symbols `group', `article', `tree' and
1613 `summary'. If the corresponding symbol is present, Gnus will keep
1614 that mode line updated with information that may be pertinent.
1615 If this variable is nil, screen refresh may be quicker."
1616 :group 'gnus-various
1617 :type '(set (const group)
1622 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1623 (defcustom gnus-mode-non-string-length nil
1624 "*Max length of mode-line non-string contents.
1625 If this is nil, Gnus will take space as is needed, leaving the rest
1626 of the mode line intact. Note that the default of nil is unlikely
1627 to be desirable; see the manual for further details."
1628 :group 'gnus-various
1629 :type '(choice (const nil)
1632 ;; There should be special validation for this.
1633 (define-widget 'gnus-email-address 'string
1634 "An email address.")
1636 (gnus-define-group-parameter
1639 "Return GROUP's to-address."
1641 "*Alist of group regexps and correspondent to-addresses."
1642 :parameter-type '(gnus-email-address :tag "To Address")
1643 :parameter-document "\
1644 This will be used when doing followups and posts.
1646 This is primarily useful in mail groups that represent closed
1647 mailing lists--mailing lists where it's expected that everybody that
1648 writes to the mailing list is subscribed to it. Since using this
1649 parameter ensures that the mail only goes to the mailing list itself,
1650 it means that members won't receive two copies of your followups.
1652 Using `to-address' will actually work whether the group is foreign or
1653 not. Let's say there's a group on the server that is called
1654 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1655 articles from a mail-to-news gateway. Posting directly to this group
1656 is therefore impossible--you have to send mail to the mailing list
1659 The gnus-group-split mail splitting mechanism will behave as if this
1660 address was listed in gnus-group-split Addresses (see below).")
1662 (gnus-define-group-parameter
1665 "Return GROUP's to-list."
1667 "*Alist of group regexps and correspondent to-lists."
1668 :parameter-type '(gnus-email-address :tag "To List")
1669 :parameter-document "\
1670 This address will be used when doing a `a' in the group.
1672 It is totally ignored when doing a followup--except that if it is
1673 present in a news group, you'll get mail group semantics when doing
1676 The gnus-group-split mail splitting mechanism will behave as if this
1677 address was listed in gnus-group-split Addresses (see below).")
1679 (gnus-define-group-parameter
1683 "Return GROUP's subscription status."
1685 "*Groups which are automatically considered subscribed."
1686 :parameter-type '(const :tag "Subscribed" t)
1687 :parameter-document "\
1688 Gnus assumed that you are subscribed to the To/List address.
1690 When constructing a list of subscribed groups using
1691 `gnus-find-subscribed-addresses', Gnus includes the To address given
1692 above, or the list address (if the To address has not been set).")
1694 (gnus-define-group-parameter
1697 :function gnus-group-auto-expirable-p
1699 "Check whether GROUP is auto-expirable or not."
1700 :variable gnus-auto-expirable-newsgroups
1701 :variable-default nil
1703 "*Groups in which to automatically mark read articles as expirable.
1704 If non-nil, this should be a regexp that should match all groups in
1705 which to perform auto-expiry. This only makes sense for mail groups."
1706 :variable-group nnmail-expire
1707 :variable-type '(choice (const nil)
1709 :parameter-type '(const :tag "Automatic Expire" t)
1711 "All articles that are read will be marked as expirable.")
1713 (gnus-define-group-parameter
1716 :function gnus-group-total-expirable-p
1718 "Check whether GROUP is total-expirable or not."
1719 :variable gnus-total-expirable-newsgroups
1720 :variable-default nil
1722 "*Groups in which to perform expiry of all read articles.
1723 Use with extreme caution. All groups that match this regexp will be
1724 expiring - which means that all read articles will be deleted after
1725 \(say) one week. (This only goes for mail groups and the like, of
1727 :variable-group nnmail-expire
1728 :variable-type '(choice (const nil)
1730 :parameter-type '(const :tag "Total Expire" t)
1732 "All read articles will be put through the expiry process
1734 This happens even if they are not marked as expirable.
1737 (gnus-define-group-parameter
1740 "Return the default charset of GROUP."
1741 :variable gnus-group-charset-alist
1743 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1744 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1745 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1746 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1747 ("\\(^\\|:\\)relcom\\>" koi8-r)
1748 ("\\(^\\|:\\)fido7\\>" koi8-r)
1749 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1750 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1751 ("\\(^\\|:\\)han\\>" euc-kr)
1752 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1753 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1754 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1756 "Alist of regexps (to match group names) and default charsets to be used when reading."
1757 :variable-group gnus-charset
1758 :variable-type '(repeat (list (regexp :tag "Group")
1759 (symbol :tag "Charset")))
1760 :parameter-type '(symbol :tag "Charset")
1761 :parameter-document "\
1762 The default charset to use in the group.")
1764 (gnus-define-group-parameter
1768 "Return a posting method for GROUP."
1769 :variable gnus-post-method-alist
1771 "Alist of regexps (to match group names) and method to be used when
1772 posting an article."
1773 :variable-group gnus-group-foreign
1775 '(choice :tag "Posting Method"
1776 (const :tag "Use native server" native)
1777 (const :tag "Use current server" current)
1778 (list :convert-widget
1780 (list 'sexp :tag "Methods"
1781 :value gnus-select-method))))
1783 "Posting method for this group.")
1785 (gnus-define-group-parameter
1786 large-newsgroup-initial
1789 "Return GROUP's initial input of the number of articles."
1791 "*Alist of group regexps and its initial input of the number of articles."
1792 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1793 (const :tag "All" nil)
1795 :parameter-document "\
1797 This number will be prompted as the initial value of the number of
1798 articles to list when the group is a large newsgroup (see
1799 `gnus-large-newsgroup'). If it is nil, the default value is the
1800 total number of articles in the group.")
1802 ;; The Gnus registry's ignored groups
1803 (gnus-define-group-parameter
1807 "Whether this group should be ignored by the registry."
1808 :variable gnus-registry-ignored-groups
1809 :variable-default nil
1811 "*Groups in which the registry should be turned off."
1812 :variable-group gnus-registry
1813 :variable-type '(repeat
1815 (regexp :tag "Group Name Regular Expression")
1816 (boolean :tag "Ignored")))
1818 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1820 "Whether the Gnus Registry should ignore this group.")
1822 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1823 (defcustom gnus-install-group-spam-parameters t
1824 "*Disable the group parameters for spam detection.
1825 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1829 (when gnus-install-group-spam-parameters
1830 (defvar gnus-group-spam-classification-spam t
1831 "Spam group classification (requires spam.el).
1832 This group contains spam messages. On summary entry, unread messages
1833 will be marked as spam. On summary exit, the specified spam
1834 processors will be invoked on spam-marked messages, then those
1835 messages will be expired, so the spam processor will only see a
1836 spam-marked message once.")
1838 (defvar gnus-group-spam-classification-ham 'ask
1839 "The ham value for the spam group parameter (requires spam.el).
1840 On summary exit, the specified ham processors will be invoked on
1841 ham-marked messages. Exercise caution, since the ham processor will
1842 see the same message more than once because there is no ham message
1845 (gnus-define-group-parameter
1849 "The spam type (spam, ham, or neither) of the group."
1850 :variable gnus-spam-newsgroup-contents
1851 :variable-default nil
1853 "*Groups in which to automatically mark new articles as spam on
1854 summary entry. If non-nil, this should be a list of group name
1855 regexps that should match all groups in which to do automatic spam
1856 tagging, associated with a classification (spam, ham, or neither).
1857 This only makes sense for mail groups."
1858 :variable-group spam
1859 :variable-type '(repeat
1860 (list :tag "Group contents spam/ham classification"
1861 (regexp :tag "Group")
1863 (variable-item gnus-group-spam-classification-spam)
1864 (variable-item gnus-group-spam-classification-ham)
1865 (const :tag "Unclassified" nil))))
1867 :parameter-type '(list :tag "Group contents spam/ham classification"
1868 (choice :tag "Group contents classification for spam sorting"
1869 (variable-item gnus-group-spam-classification-spam)
1870 (variable-item gnus-group-spam-classification-ham)
1871 (const :tag "Unclassified" nil)))
1873 "The spam classification (spam, ham, or neither) of this group.
1874 When a spam group is entered, all unread articles are marked as spam.")
1876 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1877 "The ifile summary exit spam processor.")
1879 (defvar gnus-group-spam-exit-processor-stat "stat"
1880 "The spam-stat summary exit spam processor.")
1882 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1883 "The Bogofilter summary exit spam processor.")
1885 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1886 "The Blacklist summary exit spam processor.")
1888 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1889 "The Gmane reporting summary exit spam processor.
1890 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1892 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1893 "The spamoracle summary exit spam processor.")
1895 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1896 "The ifile summary exit ham processor.
1897 Only applicable to non-spam (unclassified and ham) groups.")
1899 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1900 "The Bogofilter summary exit ham processor.
1901 Only applicable to non-spam (unclassified and ham) groups.")
1903 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1904 "The spam-stat summary exit ham processor.
1905 Only applicable to non-spam (unclassified and ham) groups.")
1907 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1908 "The whitelist summary exit ham processor.
1909 Only applicable to non-spam (unclassified and ham) groups.")
1911 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1912 "The BBDB summary exit ham processor.
1913 Only applicable to non-spam (unclassified and ham) groups.")
1915 (defvar gnus-group-ham-exit-processor-copy "copy"
1916 "The ham copy exit ham processor.
1917 Only applicable to non-spam (unclassified and ham) groups.")
1919 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1920 "The spamoracle summary exit ham processor.
1921 Only applicable to non-spam (unclassified and ham) groups.")
1923 (gnus-define-group-parameter
1928 :tag "Spam Summary Exit Processor"
1930 (list :tag "Spam Summary Exit Processor Choices"
1932 (variable-item gnus-group-spam-exit-processor-ifile)
1933 (variable-item gnus-group-spam-exit-processor-stat)
1934 (variable-item gnus-group-spam-exit-processor-bogofilter)
1935 (variable-item gnus-group-spam-exit-processor-blacklist)
1936 (variable-item gnus-group-spam-exit-processor-report-gmane)
1937 (variable-item gnus-group-spam-exit-processor-spamoracle)
1938 (variable-item gnus-group-ham-exit-processor-bogofilter)
1939 (variable-item gnus-group-ham-exit-processor-ifile)
1940 (variable-item gnus-group-ham-exit-processor-stat)
1941 (variable-item gnus-group-ham-exit-processor-whitelist)
1942 (variable-item gnus-group-ham-exit-processor-BBDB)
1943 (variable-item gnus-group-ham-exit-processor-copy)
1944 (variable-item gnus-group-ham-exit-processor-spamoracle))))
1946 "Which spam or ham processors will be applied when the summary is exited."
1947 :variable gnus-spam-process-newsgroups
1948 :variable-default nil
1950 "*Groups in which to automatically process spam or ham articles with
1951 a backend on summary exit. If non-nil, this should be a list of group
1952 name regexps that should match all groups in which to do automatic
1953 spam processing, associated with the appropriate processor."
1954 :variable-group spam
1956 '(repeat :tag "Spam/Ham Processors"
1957 (list :tag "Spam Summary Exit Processor Choices"
1958 (regexp :tag "Group Regexp")
1960 :tag "Spam/Ham Summary Exit Processor"
1961 (variable-item gnus-group-spam-exit-processor-ifile)
1962 (variable-item gnus-group-spam-exit-processor-stat)
1963 (variable-item gnus-group-spam-exit-processor-bogofilter)
1964 (variable-item gnus-group-spam-exit-processor-blacklist)
1965 (variable-item gnus-group-spam-exit-processor-spamoracle)
1966 (variable-item gnus-group-spam-exit-processor-report-gmane)
1967 (variable-item gnus-group-ham-exit-processor-bogofilter)
1968 (variable-item gnus-group-ham-exit-processor-ifile)
1969 (variable-item gnus-group-ham-exit-processor-stat)
1970 (variable-item gnus-group-ham-exit-processor-whitelist)
1971 (variable-item gnus-group-ham-exit-processor-BBDB)
1972 (variable-item gnus-group-ham-exit-processor-spamoracle)
1973 (variable-item gnus-group-ham-exit-processor-copy))))
1975 "Which spam or ham processors will be applied when the summary is exited.")
1977 (gnus-define-group-parameter
1978 spam-process-destination
1981 '(choice :tag "Destination for spam-processed articles at summary exit"
1982 (string :tag "Move to a group")
1983 (repeat :tag "Move to multiple groups"
1984 (string :tag "Destination group"))
1985 (const :tag "Expire" nil))
1987 "Where spam-processed articles will go at summary exit."
1988 :variable gnus-spam-process-destinations
1989 :variable-default nil
1991 "*Groups in which to explicitly send spam-processed articles to
1992 another group, or expire them (the default). If non-nil, this should
1993 be a list of group name regexps that should match all groups in which
1994 to do spam-processed article moving, associated with the destination
1995 group or nil for explicit expiration. This only makes sense for
1997 :variable-group spam
2000 :tag "Spam-processed articles destination"
2002 (regexp :tag "Group Regexp")
2004 :tag "Destination for spam-processed articles at summary exit"
2005 (string :tag "Move to a group")
2006 (repeat :tag "Move to multiple groups"
2007 (string :tag "Destination group"))
2008 (const :tag "Expire" nil))))
2010 "Where spam-processed articles will go at summary exit.")
2012 (gnus-define-group-parameter
2013 ham-process-destination
2017 :tag "Destination for ham articles at summary exit from a spam group"
2018 (string :tag "Move to a group")
2019 (repeat :tag "Move to multiple groups"
2020 (string :tag "Destination group"))
2021 (const :tag "Do nothing" nil))
2023 "Where ham articles will go at summary exit from a spam group."
2024 :variable gnus-ham-process-destinations
2025 :variable-default nil
2027 "*Groups in which to explicitly send ham articles to
2028 another group, or do nothing (the default). If non-nil, this should
2029 be a list of group name regexps that should match all groups in which
2030 to do ham article moving, associated with the destination
2031 group or nil for explicit ignoring. This only makes sense for
2032 mail groups, and only works in spam groups."
2033 :variable-group spam
2036 :tag "Ham articles destination"
2038 (regexp :tag "Group Regexp")
2040 :tag "Destination for ham articles at summary exit from spam group"
2041 (string :tag "Move to a group")
2042 (repeat :tag "Move to multiple groups"
2043 (string :tag "Destination group"))
2044 (const :tag "Expire" nil))))
2046 "Where ham articles will go at summary exit from a spam group.")
2048 (gnus-define-group-parameter
2051 :parameter-type '(list :tag "Ham mark choices"
2053 (variable-item gnus-del-mark)
2054 (variable-item gnus-read-mark)
2055 (variable-item gnus-ticked-mark)
2056 (variable-item gnus-killed-mark)
2057 (variable-item gnus-kill-file-mark)
2058 (variable-item gnus-low-score-mark)))
2061 "Marks considered ham (positively not spam). Such articles will be
2062 processed as ham (non-spam) on group exit. When nil, the global
2063 spam-ham-marks variable takes precedence."
2064 :variable-default '((".*" ((gnus-del-mark
2068 gnus-low-score-mark))))
2069 :variable-group spam
2071 "*Groups in which to explicitly set the ham marks to some value.")
2073 (gnus-define-group-parameter
2076 :parameter-type '(list :tag "Spam mark choices"
2078 (variable-item gnus-spam-mark)
2079 (variable-item gnus-killed-mark)
2080 (variable-item gnus-kill-file-mark)
2081 (variable-item gnus-low-score-mark)))
2084 "Marks considered spam.
2085 Such articles will be processed as spam on group exit. When nil, the global
2086 spam-spam-marks variable takes precedence."
2087 :variable-default '((".*" ((gnus-spam-mark))))
2088 :variable-group spam
2090 "*Groups in which to explicitly set the spam marks to some value."))
2092 (defcustom gnus-group-uncollapsed-levels 1
2093 "Number of group name elements to leave alone when making a short group name."
2094 :group 'gnus-group-visual
2097 (defcustom gnus-group-use-permanent-levels nil
2098 "*If non-nil, once you set a level, Gnus will use this level."
2099 :group 'gnus-group-levels
2104 (defcustom gnus-load-hook nil
2105 "A hook run while Gnus is loaded."
2109 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2110 "A hook called to apply kill files to a group.
2111 This hook is intended to apply a kill file to the selected newsgroup.
2112 The function `gnus-apply-kill-file' is called by default.
2114 Since a general kill file is too heavy to use only for a few
2115 newsgroups, I recommend you to use a lighter hook function. For
2116 example, if you'd like to apply a kill file to articles which contains
2117 a string `rmgroup' in subject in newsgroup `control', you can use the
2120 (setq gnus-apply-kill-hook
2123 (cond ((string-match \"control\" gnus-newsgroup-name)
2124 (gnus-kill \"Subject\" \"rmgroup\")
2125 (gnus-expunge \"X\"))))))"
2126 :group 'gnus-score-kill
2127 :options '(gnus-apply-kill-file)
2130 (defcustom gnus-group-change-level-function nil
2131 "Function run when a group level is changed.
2132 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2133 :group 'gnus-group-levels
2138 (defcustom gnus-visual
2139 '(summary-highlight group-highlight article-highlight
2141 summary-menu group-menu article-menu
2142 tree-highlight menu highlight
2143 browse-menu server-menu
2144 page-marker tree-menu binary-menu pick-menu
2146 "*Enable visual features.
2147 If `visual' is disabled, there will be no menus and few faces. Most of
2148 the visual customization options below will be ignored. Gnus will use
2149 less space and be faster as a result.
2151 This variable can also be a list of visual elements to switch on. For
2152 instance, to switch off all visual things except menus, you can say:
2154 (setq gnus-visual '(menu))
2156 Valid elements include `summary-highlight', `group-highlight',
2157 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2158 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2159 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2160 and `grouplens-menu'."
2163 :type '(set (const summary-highlight)
2164 (const group-highlight)
2165 (const article-highlight)
2167 (const summary-menu)
2169 (const article-menu)
2170 (const tree-highlight)
2179 (const grouplens-menu)))
2181 ;; Byte-compiler warning.
2182 (defvar gnus-visual)
2183 ;; Find out whether the gnus-visual TYPE is wanted.
2184 (defun gnus-visual-p (&optional type class)
2185 (and gnus-visual ; Has to be non-nil, at least.
2186 (if (not type) ; We don't care about type.
2188 (if (listp gnus-visual) ; It's a list, so we check it.
2189 (or (memq type gnus-visual)
2190 (memq class gnus-visual))
2193 (defcustom gnus-mouse-face
2195 (if (gnus-visual-p 'mouse-face 'highlight)
2196 (if (boundp 'gnus-mouse-face)
2197 (or gnus-mouse-face 'highlight)
2201 "*Face used for group or summary buffer mouse highlighting.
2202 The line beneath the mouse pointer will be highlighted with this
2207 (defcustom gnus-article-save-directory gnus-directory
2208 "*Name of the directory articles will be saved in (default \"~/News\")."
2209 :group 'gnus-article-saving
2212 (defvar gnus-plugged t
2213 "Whether Gnus is plugged or not.")
2215 (defcustom gnus-agent-cache t
2216 "Controls use of the agent cache while plugged.
2217 When set, Gnus will prefer using the locally stored content rather
2218 than re-fetching it from the server. You also need to enable
2219 `gnus-agent' for this to have any affect."
2224 (defcustom gnus-default-charset 'undecided
2225 "Default charset assumed to be used when viewing non-ASCII characters.
2226 This variable is overridden on a group-to-group basis by the
2227 `gnus-group-charset-alist' variable and is only used on groups not
2228 covered by that variable."
2230 :group 'gnus-charset)
2232 ;; Fixme: Doc reference to agent.
2233 (defcustom gnus-agent t
2234 "Whether we want to use the Gnus agent or not.
2236 You may customize gnus-agent to disable its use. However, some
2237 back ends have started to use the agent as a client-side cache.
2238 Disabling the agent may result in noticeable loss of performance."
2243 (defcustom gnus-other-frame-function 'gnus
2244 "Function called by the command `gnus-other-frame'."
2246 :type '(choice (function-item gnus)
2247 (function-item gnus-no-server)
2248 (function-item gnus-slave)
2249 (function-item gnus-slave-no-server)))
2251 (defcustom gnus-other-frame-parameters nil
2252 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2253 This should be an alist for Emacs, or a plist for XEmacs."
2255 :type (if (featurep 'xemacs)
2256 '(repeat (list :inline t :format "%v"
2257 (symbol :tag "Property")
2258 (sexp :tag "Value")))
2259 '(repeat (cons :format "%v"
2260 (symbol :tag "Parameter")
2261 (sexp :tag "Value")))))
2264 ;;; Internal variables
2266 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2267 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2268 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2269 (defvar gnus-draft-meta-information-header "X-Draft-From")
2270 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2271 (defvar gnus-original-article-buffer " *Original Article*")
2272 (defvar gnus-newsgroup-name nil)
2273 (defvar gnus-ephemeral-servers nil)
2274 (defvar gnus-server-method-cache nil)
2276 (defvar gnus-agent-fetching nil
2277 "Whether Gnus agent is in fetching mode.")
2279 (defvar gnus-agent-covered-methods nil)
2281 (defvar gnus-command-method nil
2282 "Dynamically bound variable that says what the current back end is.")
2284 (defvar gnus-current-select-method nil
2285 "The current method for selecting a newsgroup.")
2287 (defvar gnus-tree-buffer "*Tree*"
2288 "Buffer where Gnus thread trees are displayed.")
2291 (defvar gnus-use-generic-from nil)
2293 ;; Variable holding the user answers to all method prompts.
2294 (defvar gnus-method-history nil)
2296 ;; Variable holding the user answers to all mail method prompts.
2297 (defvar gnus-mail-method-history nil)
2299 ;; Variable holding the user answers to all group prompts.
2300 (defvar gnus-group-history nil)
2302 (defvar gnus-server-alist nil
2303 "List of available servers.")
2305 (defcustom gnus-cache-directory
2306 (nnheader-concat gnus-directory "cache/")
2307 "*The directory where cached articles will be stored."
2311 (defvar gnus-predefined-server-alist
2314 (nnspool-spool-directory ,gnus-cache-directory)
2315 (nnspool-nov-directory ,gnus-cache-directory)
2316 (nnspool-active-file
2317 ,(nnheader-concat gnus-cache-directory "active"))))
2318 "List of predefined (convenience) servers.")
2320 (defvar gnus-topic-indentation "");; Obsolete variable.
2322 (defconst gnus-article-mark-lists
2323 '((marked . tick) (replied . reply)
2324 (expirable . expire) (killed . killed)
2325 (bookmarks . bookmark) (dormant . dormant)
2326 (scored . score) (saved . save)
2327 (cached . cache) (downloadable . download)
2328 (unsendable . unsend) (forwarded . forward)
2329 (recent . recent) (seen . seen)))
2331 (defconst gnus-article-special-mark-lists
2337 ;; Propagate flags to server, with the following exceptions:
2338 ;; `seen' is private to each gnus installation
2339 ;; `cache' is a internal gnus flag for each gnus installation
2340 ;; `download' is a agent flag private to each gnus installation
2341 ;; `unsend' are for nndraft groups only
2342 ;; `score' is not a proper mark
2343 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2344 (defconst gnus-article-unpropagated-mark-lists
2345 '(seen cache download unsend score bookmark)
2346 "Marks that shouldn't be propagated to back ends.
2347 Typical marks are those that make no sense in a standalone back end,
2348 such as a mark that says whether an article is stored in the cache
2349 \(which doesn't make sense in a standalone back end).")
2351 (defvar gnus-headers-retrieved-by nil)
2352 (defvar gnus-article-reply nil)
2353 (defvar gnus-override-method nil)
2354 (defvar gnus-article-check-size nil)
2355 (defvar gnus-opened-servers nil)
2357 (defvar gnus-current-kill-article nil)
2359 (defvar gnus-have-read-active-file nil)
2361 (defconst gnus-maintainer
2362 "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2363 "The mail address of the T-gnus maintainers.")
2365 (defcustom gnus-info-filename nil
2366 "*Controls language of gnus Info.
2367 If nil and current-language-environment is Japanese, go to gnus-ja.
2368 Otherwise go to corresponding Info.
2369 This variable can be nil, gnus or gnus-ja."
2371 :type '(choice (const nil)
2372 (const :tag "English" gnus)
2373 (const :tag "Japanese" gnus-ja)))
2375 (defvar gnus-info-nodes
2376 '((gnus-group-mode "Group Buffer")
2377 (gnus-summary-mode "Summary Buffer")
2378 (gnus-article-mode "Article Buffer")
2379 (gnus-server-mode "Server Buffer")
2380 (gnus-browse-mode "Browse Foreign Server")
2381 (gnus-tree-mode "Tree Display"))
2382 "Alist of major modes and related Info nodes.")
2384 (defvar gnus-group-buffer "*Group*")
2385 (defvar gnus-summary-buffer "*Summary*")
2386 (defvar gnus-article-buffer "*Article*")
2387 (defvar gnus-server-buffer "*Server*")
2389 (defvar gnus-slave nil
2390 "Whether this Gnus is a slave or not.")
2392 (defvar gnus-batch-mode nil
2393 "Whether this Gnus is running in batch mode or not.")
2395 (defvar gnus-variable-list
2396 '(gnus-newsrc-options gnus-newsrc-options-n
2397 gnus-newsrc-last-checked-date
2398 gnus-newsrc-alist gnus-server-alist
2399 gnus-killed-list gnus-zombie-list
2400 gnus-topic-topology gnus-topic-alist
2401 gnus-agent-covered-methods)
2402 "Gnus variables saved in the quick startup file.")
2404 (defvar gnus-product-variable-file-list
2405 (let ((version (product-version (product-find 'gnus-vers)))
2406 (codesys (static-if (boundp 'MULE) '*ctext* 'ctext)))
2408 ((product-version ,version)
2410 (correct-string-widths))
2412 gnus-format-specs-compiled)
2414 ((product-version ,version)
2416 (correct-string-widths))
2418 gnus-format-specs)))
2419 "Alist of the methods for checking whether the contents of the T-gnus
2420 quick startup files are valid. One is for the byte-compiled format
2421 specifications, the other is for the source form. Each element should
2422 be a list which looks like follows:
2425 ((VARIABLE EXPECTED_VALUE_or_NIL)
2426 (VARIABLE EXPECTED_VALUE_or_NIL)
2428 CODING-SYSTEM_FOR_READING_FILE
2429 SYMBOL_OF_FORMAT_SPECS)")
2431 (defcustom gnus-compile-user-specs t
2432 "If non-nil, the user-defined format specs will be byte-compiled
2434 It has an effect on the values of `gnus-*-line-format-spec'."
2438 (defvar gnus-newsrc-alist nil
2439 "Assoc list of read articles.
2440 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2442 (defvar gnus-registry-alist nil
2443 "Assoc list of registry data.
2444 gnus-registry.el will populate this if it's loaded.")
2446 (defvar gnus-newsrc-hashtb nil
2447 "Hashtable of `gnus-newsrc-alist'.")
2449 (defvar gnus-killed-list nil
2450 "List of killed newsgroups.")
2452 (defvar gnus-killed-hashtb nil
2453 "Hash table equivalent of `gnus-killed-list'.")
2455 (defvar gnus-zombie-list nil
2456 "List of almost dead newsgroups.")
2458 (defvar gnus-description-hashtb nil
2459 "Descriptions of newsgroups.")
2461 (defvar gnus-list-of-killed-groups nil
2462 "List of newsgroups that have recently been killed by the user.")
2464 (defvar gnus-active-hashtb nil
2465 "Hashtable of active articles.")
2467 (defvar gnus-moderated-hashtb nil
2468 "Hashtable of moderated newsgroups.")
2470 ;; Save window configuration.
2471 (defvar gnus-prev-winconf nil)
2473 (defvar gnus-reffed-article-number nil)
2475 ;;; Let the byte-compiler know that we know about this variable.
2476 (defvar rmail-default-rmail-file)
2478 (defvar gnus-dead-summary nil)
2480 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2481 "Regexp matching invalid groups.")
2483 (defvar gnus-other-frame-object nil
2484 "A frame object which will be created by `gnus-other-frame'.")
2486 ;;; End of variables.
2488 ;; Define some autoload functions Gnus might use.
2491 ;; This little mapcar goes through the list below and marks the
2492 ;; symbols in question as autoloaded functions.
2495 (let ((interactive (nth 1 (memq ':interactive package))))
2499 (when (consp function)
2500 (setq keymap (car (memq 'keymap function)))
2501 (setq function (car function)))
2502 (unless (fboundp function)
2503 (autoload function (car package) nil interactive keymap))))
2504 (if (eq (nth 1 package) ':interactive)
2507 '(("info" :interactive t Info-goto-node)
2509 ("ps-print" ps-print-preprint)
2510 ("message" :interactive t
2511 message-send-and-exit message-yank-original)
2512 ("babel" babel-as-string)
2513 ("nnmail" nnmail-split-fancy nnmail-article-group)
2514 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2515 ("rmailout" rmail-output rmail-output-to-rmail-file)
2516 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2517 rmail-show-message rmail-summary-exists
2518 rmail-select-summary rmail-update-summary)
2519 ("gnus-audio" :interactive t gnus-audio-play)
2520 ("gnus-xmas" gnus-xmas-splash)
2521 ("gnus-soup" :interactive t
2522 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2523 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2524 ("nnsoup" nnsoup-pack-replies)
2525 ("score-mode" :interactive t gnus-score-mode)
2526 ("gnus-mh" gnus-summary-save-article-folder
2527 gnus-Folder-save-name gnus-folder-save-name)
2528 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2529 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2530 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2531 gnus-demon-add-disconnection gnus-demon-add-handler
2532 gnus-demon-remove-handler)
2533 ("gnus-demon" :interactive t
2534 gnus-demon-init gnus-demon-cancel)
2535 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2536 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2537 gnus-face-from-file)
2538 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2539 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2540 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2541 gnus-nocem-unwanted-article-p)
2542 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2543 gnus-server-server-name)
2544 ("gnus-srvr" gnus-browse-foreign-server)
2545 ("gnus-cite" :interactive t
2546 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2547 gnus-article-hide-citation gnus-article-fill-cited-article
2548 gnus-article-hide-citation-in-followups)
2549 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2550 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2551 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2552 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2553 gnus-cache-possibly-remove-articles gnus-cache-request-article
2554 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2555 gnus-cache-enter-remove-article gnus-cached-article-p
2556 gnus-cache-open gnus-cache-close gnus-cache-update-article
2557 gnus-cache-articles-in-group)
2558 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2559 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2560 ("gnus-score" :interactive t
2561 gnus-summary-increase-score gnus-summary-set-score
2562 gnus-summary-raise-thread gnus-summary-raise-same-subject
2563 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2564 gnus-summary-lower-thread gnus-summary-lower-same-subject
2565 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2566 gnus-summary-current-score gnus-score-delta-default
2567 gnus-score-flush-cache gnus-score-close
2568 gnus-possibly-score-headers gnus-score-followup-article
2569 gnus-score-followup-thread)
2571 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2572 gnus-current-score-file-nondirectory gnus-score-adaptive
2573 gnus-score-find-trace gnus-score-file-name)
2574 ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2575 gnus-score-customize)
2576 ("gnus-topic" :interactive t gnus-topic-mode)
2577 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2578 gnus-subscribe-topics)
2579 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2580 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2581 ("gnus-uu" :interactive t
2582 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2583 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2584 gnus-uu-mark-by-regexp gnus-uu-mark-all
2585 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2586 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2587 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2588 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2589 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2590 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2591 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2592 gnus-uu-mark-over gnus-uu-post-news)
2593 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2594 gnus-uu-unmark-thread)
2595 ("gnus-msg" (gnus-summary-send-map keymap)
2596 gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2597 ("gnus-msg" :interactive t
2598 gnus-group-post-news gnus-group-mail gnus-group-news
2599 gnus-summary-post-news gnus-summary-news-other-window
2600 gnus-summary-followup gnus-summary-followup-with-original
2601 gnus-summary-cancel-article gnus-summary-supersede-article
2602 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2603 gnus-summary-mail-forward gnus-summary-mail-other-window
2604 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2605 gnus-summary-wide-reply gnus-summary-followup-to-mail
2606 gnus-summary-followup-to-mail-with-original gnus-bug
2607 gnus-summary-wide-reply-with-original gnus-summary-post-forward
2608 gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2609 ("gnus-picon" :interactive t gnus-treat-from-picon)
2610 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2611 gnus-grouplens-mode)
2612 ("smiley" :interactive t smiley-region)
2613 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2614 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2615 gnus-list-of-unread-articles gnus-list-of-read-articles
2616 gnus-offer-save-summaries gnus-make-thread-indent-array
2617 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2618 gnus-summary-skip-intangible gnus-summary-article-number
2619 gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2620 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2621 gnus-group-list-groups gnus-group-first-unread-group
2622 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2623 gnus-group-setup-buffer gnus-group-get-new-news
2624 gnus-group-make-help-group gnus-group-update-group
2625 gnus-group-iterate gnus-group-group-name)
2626 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2627 gnus-backlog-remove-article)
2628 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2629 gnus-article-prepare gnus-article-set-window-start
2630 gnus-article-next-page gnus-article-prev-page
2631 gnus-request-article-this-buffer gnus-article-mode
2632 gnus-article-setup-buffer gnus-narrow-to-page
2633 gnus-article-delete-invisible-text gnus-treat-article)
2634 ("gnus-art" :interactive t
2635 gnus-article-hide-headers gnus-article-hide-boring-headers
2636 gnus-article-treat-overstrike
2637 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2638 gnus-article-display-x-face
2639 gnus-article-decode-HZ
2640 gnus-article-wash-html
2641 gnus-article-unsplit-urls
2642 gnus-article-hide-pem gnus-article-hide-signature
2643 gnus-article-strip-leading-blank-lines gnus-article-date-local
2644 gnus-article-date-original gnus-article-date-lapsed
2645 gnus-article-show-all-headers
2646 ;; gnus-article-show-all
2647 gnus-article-edit-mode gnus-article-edit-article
2648 gnus-article-edit-done article-decode-encoded-words
2649 gnus-start-date-timer gnus-stop-date-timer)
2650 ("gnus-int" gnus-request-type)
2651 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2652 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2653 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2654 gnus-dup-enter-articles)
2655 ("gnus-range" gnus-copy-sequence)
2656 ("gnus-eform" gnus-edit-form)
2657 ("gnus-move" :interactive t
2658 gnus-group-move-group-to-server gnus-change-server)
2659 ("gnus-logic" gnus-score-advanced)
2660 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2661 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2662 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2663 gnus-async-halt-prefetch)
2666 ("gnus-offline" :interactive t
2667 gnus-offline-toggle-plugged
2668 gnus-offline-set-unplugged-state
2669 gnus-offline-toggle-auto-hangup
2670 gnus-offline-toggle-on/off-send-mail
2671 gnus-offline-toggle-articles-to-fetch
2672 gnus-offline-set-interval-time
2673 gnus-offline-agent-expire)
2674 ("miee" :interactive t gnspool-get-news
2675 mail-spool-send news-spool-post)
2676 ("international/mw32misc" define-process-argument-editing
2677 general-process-argument-editing-function)
2678 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2679 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2680 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2681 gnus-summary-set-agent-mark gnus-agent-save-group-info
2682 gnus-agent-request-article gnus-agent-retrieve-headers)
2683 ("gnus-agent" :interactive t
2684 gnus-unplugged gnus-agentize gnus-agent-batch)
2685 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2686 gnus-summary-save-article-vm)
2687 ("compface" uncompface)
2688 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2689 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2690 ("gnus-mlspl" :interactive t gnus-group-split-setup
2691 gnus-group-split-update)
2692 ("gnus-delay" gnus-delay-initialize))))
2695 (unless (featurep 'xemacs)
2696 (if (>= emacs-major-version 21)
2697 (autoload 'x-face-decode-message-header "x-face-e21")
2698 (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule"))))
2700 (unless (and (fboundp 'base64-encode-string)
2701 (subrp (symbol-function 'base64-encode-string)))
2704 ;; To search articles with Namazu.
2705 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2706 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
2707 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
2708 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
2710 ;; To make nnir groups.
2711 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2713 ;; To make shimbun groups.
2714 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2716 ;; A tool for the developers.
2717 (autoload 'find-cl-run-time-functions "gnus-clfns" nil t)
2719 ;;; gnus-sum.el thingies
2722 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2723 "*The format specification of the lines in the summary buffer.
2725 It works along the same lines as a normal formatting string,
2726 with some simple extensions.
2728 %N Article number, left padded with spaces (string)
2730 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2731 %n Name of the poster (string)
2732 %a Extracted name of the poster (string)
2733 %A Extracted address of the poster (string)
2734 %F Contents of the From: header (string)
2735 %f Contents of the From: or To: headers (string)
2736 %x Contents of the Xref: header (string)
2737 %D Date of the article (string)
2738 %d Date of the article (string) in DD-MMM format
2739 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2740 %M Message-id of the article (string)
2741 %r References of the article (string)
2742 %c Number of characters in the article (integer)
2743 %k Pretty-printed version of the above (string)
2744 For example, \"1.2k\" or \"0.4M\".
2745 %L Number of lines in the article (integer)
2746 %I Indentation based on thread level (a string of spaces)
2747 %B A complex trn-style thread tree (string)
2748 The variables `gnus-sum-thread-*' can be used for customization.
2749 %T A string with two possible values: 80 spaces if the article
2750 is on thread level two or larger and 0 spaces on level one
2751 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2752 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2753 %[ Opening bracket (character, \"[\" or \"<\")
2754 %] Closing bracket (character, \"]\" or \">\")
2755 %> Spaces of length thread-level (string)
2756 %< Spaces of length (- 20 thread-level) (string)
2757 %i Article score (number)
2758 %z Article zcore (character)
2759 %t Number of articles under the current thread (number).
2760 %e Whether the thread is empty or not (character).
2761 %l GroupLens score (string).
2762 %V Total thread score (number).
2763 %P The line number (number).
2764 %O Download mark (character).
2765 %* If present, indicates desired cursor position
2766 (instead of after first colon).
2767 %u User defined specifier. The next character in the format string should
2768 be a letter. Gnus will call the function gnus-user-format-function-X,
2769 where X is the letter following %u. The function will be passed the
2770 current header as argument. The function should return a string, which
2771 will be inserted into the summary just like information from any other
2774 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2775 with care. For reasons of efficiency, Gnus will compute what column
2776 these characters will end up in, and \"hard-code\" that. This means that
2777 it is invalid to have these specs after a variable-length spec. Well,
2778 you might not be arrested, but your summary buffer will look strange,
2779 which is bad enough.
2781 The smart choice is to have these specs as far to the left as
2784 This restriction may disappear in later versions of Gnus.
2786 General format specifiers can also be used.
2787 See Info node `(gnus)Formatting Variables'."
2788 :link '(custom-manual "(gnus)Formatting Variables")
2790 :group 'gnus-summary-format)
2793 ;;; Skeleton keymaps
2796 (defun gnus-suppress-keymap (keymap)
2797 (suppress-keymap keymap)
2798 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2800 (define-key keymap (pop keys) 'undefined))))
2802 (defvar gnus-article-mode-map
2803 (let ((keymap (make-sparse-keymap)))
2804 (gnus-suppress-keymap keymap)
2806 (defvar gnus-summary-mode-map
2807 (let ((keymap (make-keymap)))
2808 (gnus-suppress-keymap keymap)
2810 (defvar gnus-group-mode-map
2811 (let ((keymap (make-keymap)))
2812 (gnus-suppress-keymap keymap)
2817 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2818 ;; If you want the cursor to go somewhere else, set these two
2819 ;; functions in some startup hook to whatever you want.
2820 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2821 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2823 ;;; Various macros and substs.
2825 (defun gnus-header-from (header)
2826 (mail-header-from header))
2828 (defmacro gnus-gethash (string hashtable)
2829 "Get hash value of STRING in HASHTABLE."
2830 `(symbol-value (intern-soft ,string ,hashtable)))
2832 (defmacro gnus-gethash-safe (string hashtable)
2833 "Get hash value of STRING in HASHTABLE.
2834 Return nil if not defined."
2835 `(let ((sym (intern-soft ,string ,hashtable)))
2836 (and (boundp sym) (symbol-value sym))))
2838 (defmacro gnus-sethash (string value hashtable)
2839 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2840 `(set (intern ,string ,hashtable) ,value))
2841 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2843 (defmacro gnus-group-unread (group)
2844 "Get the currently computed number of unread articles in GROUP."
2845 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2847 (defmacro gnus-group-entry (group)
2848 "Get the newsrc entry for GROUP."
2849 `(gnus-gethash ,group gnus-newsrc-hashtb))
2851 (defmacro gnus-active (group)
2852 "Get active info on GROUP."
2853 `(gnus-gethash ,group gnus-active-hashtb))
2855 (defmacro gnus-set-active (group active)
2856 "Set GROUP's active info."
2857 `(gnus-sethash ,group ,active gnus-active-hashtb))
2859 ;; Info access macros.
2861 (defmacro gnus-info-group (info)
2863 (defmacro gnus-info-rank (info)
2865 (defmacro gnus-info-read (info)
2867 (defmacro gnus-info-marks (info)
2869 (defmacro gnus-info-method (info)
2871 (defmacro gnus-info-params (info)
2874 (defmacro gnus-info-level (info)
2875 `(let ((rank (gnus-info-rank ,info)))
2879 (defmacro gnus-info-score (info)
2880 `(let ((rank (gnus-info-rank ,info)))
2881 (or (and (consp rank) (cdr rank)) 0)))
2883 (defmacro gnus-info-set-group (info group)
2884 `(setcar ,info ,group))
2885 (defmacro gnus-info-set-rank (info rank)
2886 `(setcar (nthcdr 1 ,info) ,rank))
2887 (defmacro gnus-info-set-read (info read)
2888 `(setcar (nthcdr 2 ,info) ,read))
2889 (defmacro gnus-info-set-marks (info marks &optional extend)
2891 `(gnus-info-set-entry ,info ,marks 3)
2892 `(setcar (nthcdr 3 ,info) ,marks)))
2893 (defmacro gnus-info-set-method (info method &optional extend)
2895 `(gnus-info-set-entry ,info ,method 4)
2896 `(setcar (nthcdr 4 ,info) ,method)))
2897 (defmacro gnus-info-set-params (info params &optional extend)
2899 `(gnus-info-set-entry ,info ,params 5)
2900 `(setcar (nthcdr 5 ,info) ,params)))
2902 (defun gnus-info-set-entry (info entry number)
2903 ;; Extend the info until we have enough elements.
2904 (while (<= (length info) number)
2905 (nconc info (list nil)))
2907 (setcar (nthcdr number info) entry))
2909 (defmacro gnus-info-set-level (info level)
2910 `(let ((rank (cdr ,info)))
2911 (if (consp (car rank))
2912 (setcar (car rank) ,level)
2913 (setcar rank ,level))))
2914 (defmacro gnus-info-set-score (info score)
2915 `(let ((rank (cdr ,info)))
2916 (if (consp (car rank))
2917 (setcdr (car rank) ,score)
2918 (setcar rank (cons (car rank) ,score)))))
2920 (defmacro gnus-get-info (group)
2921 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2923 ;;; Load the compatibility functions.
2932 (defvar gnus-shutdown-alist nil)
2934 (defun gnus-add-shutdown (function &rest symbols)
2935 "Run FUNCTION whenever one of SYMBOLS is shut down."
2936 (push (cons function symbols) gnus-shutdown-alist))
2938 (defun gnus-shutdown (symbol)
2939 "Shut down everything that waits for SYMBOL."
2940 (let ((alist gnus-shutdown-alist)
2942 (while (setq entry (pop alist))
2943 (when (memq symbol (cdr entry))
2944 (funcall (car entry))))))
2948 ;;; Gnus Utility Functions
2951 (defun gnus-find-subscribed-addresses ()
2952 "Return a regexp matching the addresses of all subscribed mail groups.
2953 It consists of the `to-address' or `to-list' parameter of all groups
2954 with a `subscribed' parameter."
2955 (let (group address addresses)
2956 (dolist (entry (cdr gnus-newsrc-alist))
2957 (setq group (car entry))
2958 (when (gnus-parameter-subscribed group)
2959 (setq address (mail-strip-quoted-names
2960 (or (gnus-group-fast-parameter group 'to-address)
2961 (gnus-group-fast-parameter group 'to-list))))
2963 (add-to-list 'addresses address))))
2965 (list (mapconcat 'regexp-quote addresses "\\|")))))
2967 (defmacro gnus-string-or (&rest strings)
2968 "Return the first element of STRINGS that is a non-blank string.
2969 STRINGS will be evaluated in normal `or' order."
2970 `(gnus-string-or-1 ',strings))
2972 (defun gnus-string-or-1 (strings)
2975 (setq string (eval (pop strings)))
2976 (if (string-match "^[ \t]*$" string)
2978 (setq strings nil)))
2981 (defun gnus-info-find-node (&optional nodename)
2982 "Find Info documentation of Gnus."
2984 ;; Enlarge info window if needed.
2985 (let (gnus-info-buffer)
2988 (or gnus-info-filename
2989 (get-language-info current-language-environment 'gnus-info)
2992 (cadr (assq major-mode gnus-info-nodes))
2993 (and (eq (current-buffer) (get-buffer gnus-article-buffer))
2994 (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
2995 (setq gnus-info-buffer (current-buffer))
2996 (gnus-configure-windows 'info)))
2999 ;;; gnus-interactive
3002 (defvar gnus-current-prefix-symbol nil
3003 "Current prefix symbol.")
3005 (defvar gnus-current-prefix-symbols nil
3006 "List of current prefix symbols.")
3008 (defun gnus-interactive (string &optional params)
3009 "Return a list that can be fed to `interactive'.
3010 See `interactive' for full documentation.
3012 Adds the following specs:
3014 y -- The current symbolic prefix.
3015 Y -- A list of the current symbolic prefix(es).
3016 A -- Article number.
3017 H -- Article header.
3021 (while (< i (length string))
3022 (string-match ".\\([^\n]*\\)\n?" string i)
3023 (setq c (aref string i))
3025 (setq prompt (match-string 1 string)))
3026 (setq i (match-end 0))
3027 ;; We basically emulate just about everything that
3028 ;; `interactive' does, but add the specs listed above.
3032 (completing-read prompt obarray 'fboundp t))
3034 (read-buffer prompt (current-buffer) t))
3036 (read-buffer prompt (other-buffer (current-buffer))))
3040 (completing-read prompt obarray 'commandp t))
3044 (read-file-name prompt nil default-directory 'lambda))
3046 (read-file-name prompt nil nil 'lambda))
3048 (read-file-name prompt))
3050 (read-key-sequence prompt))
3052 (error "Not implemented spec"))
3054 (error "Not implemented spec"))
3058 (error "Not implemented spec"))
3060 (string-to-number (read-from-minibuffer prompt)))
3062 (prefix-numeric-value current-prefix-arg))
3068 (read-string prompt))
3070 (intern (read-string prompt)))
3072 (read-variable prompt))
3074 (read-minibuffer prompt))
3076 (eval-minibuffer prompt))
3077 ;; And here the new specs come.
3079 gnus-current-prefix-symbol)
3081 gnus-current-prefix-symbols)
3083 (gnus-group-group-name))
3085 (gnus-summary-skip-intangible)
3086 (or (get-text-property (point) 'gnus-number)
3087 (gnus-summary-last-subject)))
3089 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3091 (error "Non-implemented spec")))
3095 (push (if (< (point) (mark)) (point) (mark)) out)
3096 (push (if (> (point) (mark)) (point) (mark)) out))))
3097 (setq out (delq 'gnus-prefix-nil out))
3100 (defun gnus-symbolic-argument (&optional arg)
3101 "Read a symbolic argument and a command, and then execute command."
3103 (let* ((in-command (this-command-keys))
3104 (command in-command)
3105 gnus-current-prefix-symbols
3106 gnus-current-prefix-symbol
3108 (while (equal in-command command)
3109 (message "%s-" (key-description (this-command-keys)))
3110 (push (intern (char-to-string (read-char))) syms)
3111 (setq command (read-key-sequence nil t)))
3112 (setq gnus-current-prefix-symbols (nreverse syms)
3113 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3114 (call-interactively (key-binding command t))))
3116 ;;; More various functions.
3118 (defsubst gnus-check-backend-function (func group)
3119 "Check whether GROUP supports function FUNC.
3120 GROUP can either be a string (a group name) or a select method."
3122 (let ((method (if (stringp group)
3123 (car (gnus-find-method-for-group group))
3125 (unless (featurep method)
3127 (fboundp (intern (format "%s-%s" method func))))))
3129 (defun gnus-group-read-only-p (&optional group)
3130 "Check whether GROUP supports editing or not.
3131 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3132 that that variable is buffer-local to the summary buffers."
3133 (let ((group (or group gnus-newsgroup-name)))
3134 (not (gnus-check-backend-function 'request-replace-article group))))
3136 (defun gnus-virtual-group-p (group)
3137 "Say whether GROUP is virtual or not."
3138 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3139 gnus-valid-select-methods)))
3141 (defun gnus-news-group-p (group &optional article)
3142 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3143 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3144 t) ;is news of course.
3145 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3146 nil) ;must be mail then.
3147 ((vectorp article) ;Has header info.
3148 (eq (gnus-request-type group (mail-header-id article)) 'news))
3149 ((null article) ;Hasn't header info
3150 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3151 ((< article 0) ;Virtual message
3152 nil) ;we don't know, guess mail.
3153 (t ;Has positive number
3154 (eq (gnus-request-type group article) 'news)))) ;use it.
3156 ;; Returns a list of writable groups.
3157 (defun gnus-writable-groups ()
3158 (let ((alist gnus-newsrc-alist)
3160 (while (setq group (car (pop alist)))
3161 (unless (gnus-group-read-only-p group)
3162 (push group groups)))
3165 ;; Check whether to use long file names.
3166 (defun gnus-use-long-file-name (symbol)
3167 ;; The variable has to be set...
3168 (and gnus-use-long-file-name
3169 ;; If it isn't a list, then we return t.
3170 (or (not (listp gnus-use-long-file-name))
3171 ;; If it is a list, and the list contains `symbol', we
3173 (not (memq symbol gnus-use-long-file-name)))))
3175 ;; Generate a unique new group name.
3176 (defun gnus-generate-new-group-name (leaf)
3179 (while (gnus-gethash name gnus-newsrc-hashtb)
3180 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3183 (defun gnus-ephemeral-group-p (group)
3184 "Say whether GROUP is ephemeral or not."
3185 (gnus-group-get-parameter group 'quit-config t))
3187 (defun gnus-group-quit-config (group)
3188 "Return the quit-config of GROUP."
3189 (gnus-group-get-parameter group 'quit-config t))
3191 (defun gnus-kill-ephemeral-group (group)
3192 "Remove ephemeral GROUP from relevant structures."
3193 (gnus-sethash group nil gnus-newsrc-hashtb))
3195 (defun gnus-simplify-mode-line ()
3196 "Make mode lines a bit simpler."
3197 (setq mode-line-modified (cdr gnus-mode-line-modified))
3198 (when (listp mode-line-format)
3199 (make-local-variable 'mode-line-format)
3200 (setq mode-line-format (copy-sequence mode-line-format))
3201 (when (equal (nth 3 mode-line-format) " ")
3202 (setcar (nthcdr 3 mode-line-format) " "))))
3204 ;;; Servers and groups.
3206 (defsubst gnus-server-add-address (method)
3207 (let ((method-name (symbol-name (car method))))
3208 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3209 (not (assq (intern (concat method-name "-address")) method))
3210 (memq 'physical-address (assq (car method)
3211 gnus-valid-select-methods)))
3212 (append method (list (list (intern (concat method-name "-address"))
3216 (defsubst gnus-server-to-method (server)
3217 "Map virtual server names to select methods."
3218 (or (and server (listp server) server)
3219 (cdr (assoc server gnus-server-method-cache))
3222 ;; Perhaps this is the native server?
3223 (and (equal server "native") gnus-select-method)
3224 ;; It should be in the server alist.
3225 (cdr (assoc server gnus-server-alist))
3226 ;; It could be in the predefined server alist.
3227 (cdr (assoc server gnus-predefined-server-alist))
3228 ;; If not, we look through all the opened server
3229 ;; to see whether we can find it there.
3230 (let ((opened gnus-opened-servers))
3232 (not (equal server (format "%s:%s" (caaar opened)
3236 ;; It could be a named method, search all servers
3237 (let ((servers gnus-secondary-select-methods))
3239 (not (equal server (format "%s:%s" (caar servers)
3243 (push (cons server result) gnus-server-method-cache)
3246 (defsubst gnus-server-get-method (group method)
3247 ;; Input either a server name, and extended server name, or a
3248 ;; select method, and return a select method.
3249 (cond ((stringp method)
3250 (gnus-server-to-method method))
3251 ((equal method gnus-select-method)
3253 ((and (stringp (car method))
3255 (gnus-server-extend-method group method))
3258 (equal (cadr method) ""))
3261 (gnus-server-add-address method))))
3263 (defmacro gnus-method-equal (ss1 ss2)
3264 "Say whether two servers are equal."
3268 (and (= (length s1) (length s2))
3270 (while (and s1 (member (car s1) s2))
3274 (defun gnus-methods-equal-p (m1 m2)
3275 (let ((m1 (or m1 gnus-select-method))
3276 (m2 (or m2 gnus-select-method)))
3278 (and (eq (car m1) (car m2))
3279 (or (not (memq 'address (assoc (symbol-name (car m1))
3280 gnus-valid-select-methods)))
3281 (equal (nth 1 m1) (nth 1 m2)))))))
3283 (defun gnus-server-equal (m1 m2)
3284 "Say whether two methods are equal."
3285 (let ((m1 (cond ((null m1) gnus-select-method)
3286 ((stringp m1) (gnus-server-to-method m1))
3288 (m2 (cond ((null m2) gnus-select-method)
3289 ((stringp m2) (gnus-server-to-method m2))
3291 (gnus-method-equal m1 m2)))
3293 (defun gnus-servers-using-backend (backend)
3294 "Return a list of known servers using BACKEND."
3295 (let ((opened gnus-opened-servers)
3298 (when (eq backend (caaar opened))
3299 (push (caar opened) out))
3303 (defun gnus-archive-server-wanted-p ()
3304 "Say whether the user wants to use the archive server."
3306 ((or (not gnus-message-archive-method)
3307 (not gnus-message-archive-group))
3309 ((and gnus-message-archive-method gnus-message-archive-group)
3312 (let ((active (cadr (assq 'nnfolder-active-file
3313 gnus-message-archive-method))))
3315 (file-exists-p active))))))
3317 (defsubst gnus-method-to-server-name (method)
3319 (format "%s" (car method))
3321 (or (assoc (format "%s" (car method))
3322 (gnus-methods-using 'address))
3323 (gnus-server-equal method gnus-message-archive-method))
3325 (not (string= (nth 1 method) "")))
3326 (concat "+" (nth 1 method)))))
3328 (defsubst gnus-method-to-full-server-name (method)
3329 (format "%s+%s" (car method) (nth 1 method)))
3331 (defun gnus-group-prefixed-name (group method &optional full)
3332 "Return the whole name from GROUP and METHOD.
3333 Call with full set to get the fully qualified group name (even if the
3335 (when (stringp method)
3336 (setq method (gnus-server-to-method method)))
3337 (if (or (not method)
3338 (and (not full) (gnus-server-equal method "native"))
3339 ;;;!!! This might not be right. We'll see...
3340 ;(string-match ":" group)
3343 (concat (gnus-method-to-server-name method) ":" group)))
3345 (defun gnus-group-guess-prefixed-name (group)
3346 "Guess the whole name from GROUP and METHOD."
3347 (gnus-group-prefixed-name group (gnus-find-method-for-group
3350 (defun gnus-group-full-name (group method)
3351 "Return the full name from GROUP and METHOD, even if the method is native."
3352 (gnus-group-prefixed-name group method t))
3354 (defun gnus-group-guess-full-name (group)
3355 "Guess the full name from GROUP, even if the method is native."
3356 (if (gnus-group-prefixed-p group)
3358 (gnus-group-full-name group (gnus-find-method-for-group group))))
3360 (defun gnus-group-guess-full-name-from-command-method (group)
3361 "Guess the full name from GROUP, even if the method is native."
3362 (if (gnus-group-prefixed-p group)
3364 (gnus-group-full-name group gnus-command-method)))
3366 (defun gnus-group-real-prefix (group)
3367 "Return the prefix of the current group name."
3369 (if (string-match "^[^:]+:" group)
3370 (substring group 0 (match-end 0))
3374 (defun gnus-group-short-name (group)
3375 "Return the short group name."
3376 (let ((prefix (gnus-group-real-prefix group)))
3377 (if (< 0 (length prefix))
3378 (substring group (length prefix) nil)
3381 (defun gnus-group-prefixed-p (group)
3382 "Return the prefix of the current group name."
3383 (< 0 (length (gnus-group-real-prefix group))))
3385 (defun gnus-summary-buffer-name (group)
3386 "Return the summary buffer name of GROUP."
3387 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3389 (defun gnus-group-method (group)
3390 "Return the server or method used for selecting GROUP.
3391 You should probably use `gnus-find-method-for-group' instead."
3392 (let ((prefix (gnus-group-real-prefix group)))
3393 (if (equal prefix "")
3395 (let ((servers gnus-opened-servers)
3397 backend possible found)
3398 (if (string-match "^[^\\+]+\\+" prefix)
3399 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3400 server (substring prefix (match-end 0) (1- (length prefix))))
3401 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3403 (when (eq (caaar servers) backend)
3404 (setq possible (caar servers))
3405 (when (equal (cadaar servers) server)
3406 (setq found (caar servers))))
3408 (or (car (rassoc found gnus-server-alist))
3410 (car (rassoc possible gnus-server-alist))
3412 (list backend server))))))
3414 (defsubst gnus-native-method-p (method)
3415 "Return whether METHOD is the native select method."
3416 (gnus-method-equal method gnus-select-method))
3418 (defsubst gnus-secondary-method-p (method)
3419 "Return whether METHOD is a secondary select method."
3420 (let ((methods gnus-secondary-select-methods)
3421 (gmethod (gnus-server-get-method nil method)))
3423 (not (gnus-method-equal
3424 (gnus-server-get-method nil (car methods))
3426 (setq methods (cdr methods)))
3429 (defun gnus-method-simplify (method)
3430 "Return the shortest uniquely identifying string or method for METHOD."
3431 (cond ((stringp method)
3433 ((gnus-native-method-p method)
3435 ((gnus-secondary-method-p method)
3436 (format "%s:%s" (nth 0 method) (nth 1 method)))
3440 (defun gnus-groups-from-server (server)
3441 "Return a list of all groups that are fetched from SERVER."
3442 (let ((alist (cdr gnus-newsrc-alist))
3444 (while (setq info (pop alist))
3445 (when (gnus-server-equal (gnus-info-method info) server)
3446 (push (gnus-info-group info) groups)))
3447 (sort groups 'string<)))
3449 (defun gnus-group-foreign-p (group)
3450 "Say whether a group is foreign or not."
3451 (and (not (gnus-group-native-p group))
3452 (not (gnus-group-secondary-p group))))
3454 (defun gnus-group-native-p (group)
3455 "Say whether the group is native or not."
3456 (not (string-match ":" group)))
3458 (defun gnus-group-secondary-p (group)
3459 "Say whether the group is secondary or not."
3460 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3462 (defun gnus-parameters-get-parameter (group)
3463 "Return the group parameters for GROUP from `gnus-parameters'."
3465 (dolist (elem gnus-parameters)
3466 (when (string-match (car elem) group)
3468 (nconc (gnus-expand-group-parameters
3469 (car elem) (cdr elem) group)
3473 (defun gnus-expand-group-parameter (match value group)
3474 "Use MATCH to expand VALUE in GROUP."
3477 (goto-char (point-min))
3478 (while (re-search-forward match nil t)
3479 (replace-match value))
3482 (defun gnus-expand-group-parameters (match parameters group)
3483 "Go through PARAMETERS and expand them according to the match data."
3485 (dolist (elem parameters)
3486 (if (and (stringp (cdr elem))
3487 (string-match "\\\\[0-9&]" (cdr elem)))
3488 (push (cons (car elem)
3489 (gnus-expand-group-parameter match (cdr elem) group))
3494 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3495 "For GROUP, return the value of SYMBOL.
3497 You should call this in the `gnus-group-buffer' buffer.
3498 The function `gnus-group-find-parameter' will do that for you."
3499 ;; The speed trick: No cons'ing and quit early.
3500 (let* ((params (funcall gnus-group-get-parameter-function group))
3501 ;; Start easy, check the "real" group parameters.
3503 (gnus-group-parameter-value params symbol allow-list t)))
3505 ;; Found results; return them.
3506 (car simple-results)
3507 ;; We didn't found it there, try `gnus-parameters'.
3510 (tail gnus-parameters))
3511 ;; A good old-fashioned non-cl loop.
3513 (setq head (car tail)
3515 ;; The car is regexp matching for matching the group name.
3516 (when (string-match (car head) group)
3517 ;; The cdr is the parameters.
3518 (setq result (gnus-group-parameter-value (cdr head)
3521 ;; Expand if necessary.
3522 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3523 (setq result (gnus-expand-group-parameter (car head)
3525 ;; Exit the loop early.
3530 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3531 "Return the group parameters for GROUP.
3532 If SYMBOL, return the value of that symbol in the group parameters.
3534 If you call this function inside a loop, consider using the faster
3535 `gnus-group-fast-parameter' instead."
3537 (set-buffer gnus-group-buffer)
3539 (gnus-group-fast-parameter group symbol allow-list)
3542 (funcall gnus-group-get-parameter-function group))
3543 (gnus-parameters-get-parameter group)))))
3545 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3546 "Return the group parameters for GROUP.
3547 If SYMBOL, return the value of that symbol in the group parameters.
3548 Most functions should use `gnus-group-find-parameter', which
3549 also examines the topic parameters."
3550 (let ((params (gnus-info-params (gnus-get-info group))))
3552 (gnus-group-parameter-value params symbol allow-list)
3555 (defun gnus-group-parameter-value (params symbol &optional
3556 allow-list present-p)
3557 "Return the value of SYMBOL in group PARAMS."
3558 ;; We only wish to return group parameters (dotted lists) and
3559 ;; not local variables, which may have the same names.
3560 ;; But first we handle single elements...
3561 (or (car (memq symbol params))
3565 (while (setq elem (pop params))
3566 (when (and (consp elem)
3567 (eq (car elem) symbol)
3570 (throw 'found (if present-p (list (cdr elem))
3573 (defun gnus-group-add-parameter (group param)
3574 "Add parameter PARAM to GROUP."
3575 (let ((info (gnus-get-info group)))
3577 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3578 ;; Cons the new param to the old one and update.
3579 (gnus-group-set-info (cons param (gnus-info-params info))
3582 (defun gnus-group-set-parameter (group name value)
3583 "Set parameter NAME to VALUE in GROUP."
3584 (let ((info (gnus-get-info group)))
3586 (gnus-group-remove-parameter group name)
3587 (let ((old-params (gnus-info-params info))
3588 (new-params (list (cons name value))))
3590 (when (or (not (listp (car old-params)))
3591 (not (eq (caar old-params) name)))
3592 (setq new-params (append new-params (list (car old-params)))))
3593 (setq old-params (cdr old-params)))
3594 (gnus-group-set-info new-params group 'params)))))
3596 (defun gnus-group-remove-parameter (group name)
3597 "Remove parameter NAME from GROUP."
3598 (let ((info (gnus-get-info group)))
3600 (let ((params (gnus-info-params info)))
3602 (setq params (delq name params))
3603 (while (assq name params)
3604 (gnus-pull name params))
3605 (gnus-info-set-params info params))))))
3607 (defun gnus-group-add-score (group &optional score)
3608 "Add SCORE to the GROUP score.
3609 If SCORE is nil, add 1 to the score of GROUP."
3610 (let ((info (gnus-get-info group)))
3612 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3614 (defun gnus-short-group-name (group &optional levels)
3615 "Collapse GROUP name LEVELS.
3616 Select methods are stripped and any remote host name is stripped down to
3617 just the host name."
3623 gnus-group-uncollapsed-levels
3625 (while (string-match "\\." group skip)
3626 (setq skip (match-end 0)
3629 ;; Separate foreign select method from group name and collapse.
3630 ;; If method contains a server, collapse to non-domain server name,
3631 ;; otherwise collapse to select method.
3632 (let* ((colon (string-match ":" group))
3633 (server (and colon (substring group 0 colon)))
3634 (plus (and server (string-match "+" server))))
3637 (setq foreign (substring server (+ 1 plus)
3638 (string-match "\\." server))
3639 group (substring group (+ 1 colon)))
3640 (setq foreign server
3641 group (substring group (+ 1 colon))))
3642 (setq foreign (concat foreign ":")))
3643 ;; Collapse group name leaving LEVELS uncollapsed elements
3644 (let* ((slist (split-string group "/"))
3645 (slen (length slist))
3646 (dlist (split-string group "\\."))
3647 (dlen (length dlist))
3659 (setq levels (- glen levels))
3661 (push (if (>= (decf levels) 0)
3662 (if (zerop (length g))
3667 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3669 (defun gnus-narrow-to-body ()
3670 "Narrow to the body of an article."
3673 (goto-char (point-min))
3674 (or (search-forward "\n\n" nil t)
3680 ;;; Kill file handling.
3683 (defun gnus-apply-kill-file ()
3684 "Apply a kill file to the current newsgroup.
3685 Returns the number of articles marked as read."
3686 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3687 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3688 (gnus-apply-kill-file-internal)
3691 (defun gnus-kill-save-kill-buffer ()
3692 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3693 (when (get-file-buffer file)
3695 (set-buffer (get-file-buffer file))
3696 (when (buffer-modified-p)
3698 (kill-buffer (current-buffer))))))
3700 (defcustom gnus-kill-file-name "KILL"
3701 "Suffix of the kill files."
3702 :group 'gnus-score-kill
3703 :group 'gnus-score-files
3706 (defun gnus-newsgroup-kill-file (newsgroup)
3707 "Return the name of a kill file name for NEWSGROUP.
3708 If NEWSGROUP is nil, return the global kill file name instead."
3710 ;; The global KILL file is placed at top of the directory.
3711 ((or (null newsgroup)
3712 (string-equal newsgroup ""))
3713 (expand-file-name gnus-kill-file-name
3714 gnus-kill-files-directory))
3715 ;; Append ".KILL" to newsgroup name.
3716 ((gnus-use-long-file-name 'not-kill)
3717 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3718 "." gnus-kill-file-name)
3719 gnus-kill-files-directory))
3720 ;; Place "KILL" under the hierarchical directory.
3722 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3723 "/" gnus-kill-file-name)
3724 gnus-kill-files-directory))))
3728 (defun gnus-member-of-valid (symbol group)
3729 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3731 (symbol-name (car (gnus-find-method-for-group group)))
3732 gnus-valid-select-methods)))
3734 (defun gnus-method-option-p (method option)
3735 "Return non-nil if select METHOD has OPTION as a parameter."
3736 (when (stringp method)
3737 (setq method (gnus-server-to-method method)))
3738 (memq option (assoc (format "%s" (car method))
3739 gnus-valid-select-methods)))
3741 (defun gnus-similar-server-opened (method)
3742 (let ((opened gnus-opened-servers))
3743 (while (and method opened)
3744 (when (and (equal (cadr method) (cadaar opened))
3745 (equal (car method) (caaar opened))
3746 (not (equal method (caar opened))))
3751 (defun gnus-server-extend-method (group method)
3752 ;; This function "extends" a virtual server. If the server is
3753 ;; "hello", and the select method is ("hello" (my-var "something"))
3754 ;; in the group "alt.alt", this will result in a new virtual server
3755 ;; called "hello+alt.alt".
3756 (if (or (not (inline (gnus-similar-server-opened method)))
3757 (not (cddr method)))
3759 `(,(car method) ,(concat (cadr method) "+" group)
3760 (,(intern (format "%s-address" (car method))) ,(cadr method))
3763 (defun gnus-server-status (method)
3764 "Return the status of METHOD."
3765 (nth 1 (assoc method gnus-opened-servers)))
3767 (defun gnus-group-name-to-method (group)
3768 "Guess a select method based on GROUP."
3769 (if (string-match ":" group)
3770 (let ((server (substring group 0 (match-beginning 0))))
3771 (if (string-match "\\+" server)
3772 (list (intern (substring server 0 (match-beginning 0)))
3773 (substring server (match-end 0)))
3774 (list (intern server) "")))
3775 gnus-select-method))
3777 (defun gnus-server-string (server)
3778 "Return a readable string that describes SERVER."
3779 (let* ((server (gnus-server-to-method server))
3780 (address (nth 1 server)))
3782 (not (zerop (length address))))
3783 (format "%s using %s" address (car server))
3784 (format "%s" (car server)))))
3786 (defun gnus-find-method-for-group (group &optional info)
3787 "Find the select method that GROUP uses."
3788 (or gnus-override-method
3791 (and (not (gnus-group-entry group));; a new group
3792 (gnus-group-name-to-method group))
3793 (let ((info (or info (gnus-get-info group)))
3796 (not (setq method (gnus-info-method info)))
3797 (equal method "native"))
3800 (cond ((stringp method)
3801 (inline (gnus-server-to-method method)))
3802 ((stringp (cadr method))
3803 (inline (gnus-server-extend-method group method)))
3806 (cond ((equal (cadr method) "")
3808 ((null (cadr method))
3809 (list (car method) ""))
3811 (gnus-server-add-address method)))))))
3813 (defun gnus-methods-using (feature)
3814 "Find all methods that have FEATURE."
3815 (let ((valids gnus-valid-select-methods)
3818 (when (memq feature (car valids))
3819 (push (car valids) outs))
3820 (setq valids (cdr valids)))
3823 (defun gnus-read-group (prompt &optional default)
3824 "Prompt the user for a group name.
3825 Disallow invalid group names."
3830 gnus-invalid-group-regexp
3831 (setq group (read-string (concat prefix prompt)
3832 (cons (or default "") 0)
3833 'gnus-group-history)))
3834 (let ((match (match-string 0 group)))
3835 ;; `/' may be okay (e.g. for nnimap), so ask the user:
3836 (unless (and (string-match "/" match)
3838 "Proceed and create group anyway? " t
3839 "The group name \"" group "\" contains a forbidden character: \"" match "\".
3841 Usually, it's dangerous to create a group with this name, because it's not
3842 supported by all back ends and servers. On some IMAP servers, it's valid to
3843 use the character \"/\".
3845 If you are really sure, you can proceed anyway and create the group.
3847 You may customize the variable `gnus-invalid-group-regexp', which currently is
3848 set to \"" gnus-invalid-group-regexp
3849 "\", if you want to get rid of this query."))
3850 (setq prefix (format "Invalid group name: \"%s\". " group)
3854 (defun gnus-read-method (prompt)
3855 "Prompt the user for a method.
3856 Allow completion over sensible values."
3857 (let* ((open-servers
3858 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3859 gnus-opened-servers))
3862 (dolist (method gnus-valid-select-methods)
3863 (if (or (memq 'prompt-address method)
3864 (not (assoc (format "%s:" (car method)) open-servers)))
3865 (push method methods)))
3868 (append valid-methods
3870 gnus-predefined-server-alist
3875 nil t nil 'gnus-method-history)))
3878 (setq method gnus-select-method))
3879 ((assoc method gnus-valid-select-methods)
3880 (let ((address (if (memq 'prompt-address
3881 (assoc method gnus-valid-select-methods))
3882 (read-string "Address: ")
3884 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3885 (list (intern method) address))))
3886 ((assoc method servers)
3889 (list (intern method) "")))))
3893 (defun gnus-agent-method-p (method)
3894 "Say whether METHOD is covered by the agent."
3895 (member method gnus-agent-covered-methods))
3897 (defun gnus-online (method)
3900 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3901 (gnus-agent-method-p method))))
3903 ;;; User-level commands.
3906 (defun gnus-slave-no-server (&optional arg)
3907 "Read network news as a slave, without connecting to the local server."
3909 (gnus-no-server arg t))
3912 (defun gnus-no-server (&optional arg slave)
3914 If ARG is a positive number, Gnus will use that as the startup
3915 level. If ARG is nil, Gnus will be started at level 2. If ARG is
3916 non-nil and not a positive number, Gnus will prompt the user for the
3917 name of an NNTP server to use.
3918 As opposed to `gnus', this command will not connect to the local
3921 (gnus-no-server-1 arg slave))
3924 (defun gnus-slave (&optional arg)
3925 "Read news as a slave."
3927 (gnus arg nil 'slave))
3929 (defcustom gnus-frame-properties nil
3930 "The properties of the frame in which gnus is displayed. Under XEmacs,
3931 the variable `toolbar-news-frame-plist' will be refered instead."
3932 :type '(repeat (cons :format "%v"
3933 (symbol :tag "Parameter")
3934 (sexp :tag "Value")))
3938 (defun gnus-other-frame (&optional arg display)
3939 "Pop up a frame to read news.
3940 This will call one of the Gnus commands which is specified by the user
3941 option `gnus-other-frame-function' (default `gnus') with the argument
3942 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
3943 optional second argument DISPLAY should be a standard display string
3944 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
3945 omitted or the function `make-frame-on-display' is not available, the
3946 current display is used."
3948 (if (fboundp 'make-frame-on-display)
3950 (setq display (gnus-frame-or-window-display-name (selected-frame))))
3952 (let ((alive (gnus-alive-p)))
3957 (when (and (or (not display)
3959 (gnus-frame-or-window-display-name
3961 (with-current-buffer (window-buffer window)
3962 (string-match "\\`gnus-"
3963 (symbol-name major-mode))))
3964 (gnus-select-frame-set-input-focus
3965 (setq gnus-other-frame-object (window-frame window)))
3966 (select-window window)
3969 (gnus-select-frame-set-input-focus
3970 (setq gnus-other-frame-object
3972 (make-frame-on-display display gnus-other-frame-parameters)
3973 (make-frame gnus-other-frame-parameters))))
3975 (switch-to-buffer gnus-group-buffer)
3976 (funcall gnus-other-frame-function arg)
3977 (add-hook 'gnus-exit-gnus-hook
3979 (when (and (frame-live-p gnus-other-frame-object)
3981 (delete-frame gnus-other-frame-object))
3982 (setq gnus-other-frame-object nil)))))))
3985 (defun gnus (&optional arg dont-connect slave)
3987 If ARG is non-nil and a positive number, Gnus will use that as the
3988 startup level. If ARG is non-nil and not a positive number, Gnus will
3989 prompt the user for the name of an NNTP server to use."
3991 (unless (byte-code-function-p (symbol-function 'gnus))
3992 (message "You should byte-compile Gnus")
3994 (gnus-1 arg dont-connect slave))
3996 ;; Allow redefinition of Gnus functions.
4000 (product-provide (provide 'gnus) 'gnus-vers)
4002 ;;; gnus.el ends here