1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
31 (eval '(run-hooks 'gnus-load-hook))
33 (eval-when-compile (require 'cl))
39 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
43 (defgroup gnus-format nil
44 "Dealing with formatting issues."
47 (defgroup gnus-charset nil
48 "Group character set issues."
49 :link '(custom-manual "(gnus)Charsets")
53 (defgroup gnus-cache nil
55 :link '(custom-manual "(gnus)Article Caching")
58 (defgroup gnus-registry nil
62 (defgroup gnus-start nil
63 "Starting your favorite newsreader."
66 (defgroup gnus-start-server nil
67 "Server options at startup."
70 ;; These belong to gnus-group.el.
71 (defgroup gnus-group nil
73 :link '(custom-manual "(gnus)Group Buffer")
76 (defgroup gnus-group-foreign nil
78 :link '(custom-manual "(gnus)Foreign Groups")
81 (defgroup gnus-group-new nil
82 "Automatic subscription of new groups."
85 (defgroup gnus-group-levels nil
87 :link '(custom-manual "(gnus)Group Levels")
90 (defgroup gnus-group-select nil
92 :link '(custom-manual "(gnus)Selecting a Group")
95 (defgroup gnus-group-listing nil
96 "Showing slices of the group list."
97 :link '(custom-manual "(gnus)Listing Groups")
100 (defgroup gnus-group-visual nil
101 "Sorting the group buffer."
102 :link '(custom-manual "(gnus)Group Buffer Format")
106 (defgroup gnus-group-various nil
107 "Various group options."
108 :link '(custom-manual "(gnus)Scanning New Messages")
111 ;; These belong to gnus-sum.el.
112 (defgroup gnus-summary nil
114 :link '(custom-manual "(gnus)Summary Buffer")
117 (defgroup gnus-summary-exit nil
118 "Leaving summary buffers."
119 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
120 :group 'gnus-summary)
122 (defgroup gnus-summary-marks nil
123 "Marks used in summary buffers."
124 :link '(custom-manual "(gnus)Marking Articles")
125 :group 'gnus-summary)
127 (defgroup gnus-thread nil
128 "Ordering articles according to replies."
129 :link '(custom-manual "(gnus)Threading")
130 :group 'gnus-summary)
132 (defgroup gnus-summary-format nil
133 "Formatting of the summary buffer."
134 :link '(custom-manual "(gnus)Summary Buffer Format")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-choose nil
139 :link '(custom-manual "(gnus)Choosing Articles")
140 :group 'gnus-summary)
142 (defgroup gnus-summary-maneuvering nil
143 "Summary movement commands."
144 :link '(custom-manual "(gnus)Summary Maneuvering")
145 :group 'gnus-summary)
147 (defgroup gnus-picon nil
148 "Show pictures of people, domains, and newsgroups."
151 (defgroup gnus-summary-mail nil
152 "Mail group commands."
153 :link '(custom-manual "(gnus)Mail Group Commands")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-sort nil
157 "Sorting the summary buffer."
158 :link '(custom-manual "(gnus)Sorting the Summary Buffer")
159 :group 'gnus-summary)
161 (defgroup gnus-summary-visual nil
162 "Highlighting and menus in the summary buffer."
163 :link '(custom-manual "(gnus)Summary Highlighting")
165 :group 'gnus-summary)
167 (defgroup gnus-summary-various nil
168 "Various summary buffer options."
169 :link '(custom-manual "(gnus)Various Summary Stuff")
170 :group 'gnus-summary)
172 (defgroup gnus-summary-pick nil
173 "Pick mode in the summary buffer."
174 :link '(custom-manual "(gnus)Pick and Read")
176 :group 'gnus-summary)
178 (defgroup gnus-summary-tree nil
179 "Tree display of threads in the summary buffer."
180 :link '(custom-manual "(gnus)Tree Display")
182 :group 'gnus-summary)
184 ;; Belongs to gnus-uu.el
185 (defgroup gnus-extract-view nil
186 "Viewing extracted files."
187 :link '(custom-manual "(gnus)Viewing Files")
188 :group 'gnus-extract)
190 ;; Belongs to gnus-score.el
191 (defgroup gnus-score nil
192 "Score and kill file handling."
195 (defgroup gnus-score-kill nil
199 (defgroup gnus-score-adapt nil
200 "Adaptive score files."
203 (defgroup gnus-score-default nil
204 "Default values for score files."
207 (defgroup gnus-score-expire nil
208 "Expiring score rules."
211 (defgroup gnus-score-decay nil
212 "Decaying score rules."
215 (defgroup gnus-score-files nil
216 "Score and kill file names."
220 (defgroup gnus-score-various nil
221 "Various scoring and killing options."
225 (defgroup gnus-visual nil
226 "Options controlling the visual fluff."
230 (defgroup gnus-agent nil
231 "Offline support for Gnus."
234 (defgroup gnus-files nil
235 "Files used by Gnus."
238 (defgroup gnus-dribble-file nil
240 :link '(custom-manual "(gnus)Auto Save")
243 (defgroup gnus-newsrc nil
244 "Storing Gnus state."
247 (defgroup gnus-server nil
248 "Options related to newsservers and other servers used by Gnus."
251 (defgroup gnus-server-visual nil
252 "Highlighting and menus in the server buffer."
256 (defgroup gnus-message '((message custom-group))
257 "Composing replies and followups in Gnus."
260 (defgroup gnus-meta nil
261 "Meta variables controlling major portions of Gnus.
262 In general, modifying these variables does not take affect until Gnus
263 is restarted, and sometimes reloaded."
266 (defgroup gnus-various nil
267 "Other Gnus options."
268 :link '(custom-manual "(gnus)Various Various")
271 (defgroup gnus-mime nil
272 "Variables for controlling the Gnus MIME interface."
275 (defgroup gnus-exit nil
277 :link '(custom-manual "(gnus)Exiting Gnus")
280 (defgroup gnus-fun nil
281 "Frivolous Gnus extensions."
282 :link '(custom-manual "(gnus)Exiting Gnus")
285 (defconst gnus-version-number "5.11"
286 "Version number for this version of Gnus.")
288 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
289 "Version string for this version of Gnus.")
291 (defcustom gnus-inhibit-startup-message nil
292 "If non-nil, the startup message will not be displayed.
293 This variable is used before `.gnus.el' is loaded, so it should
294 be set in `.emacs' instead."
298 (defcustom gnus-play-startup-jingle nil
299 "If non-nil, play the Gnus jingle at startup."
303 (unless (fboundp 'gnus-group-remove-excess-properties)
304 (defalias 'gnus-group-remove-excess-properties 'ignore))
306 (unless (fboundp 'gnus-set-text-properties)
307 (defalias 'gnus-set-text-properties 'set-text-properties))
309 (unless (featurep 'gnus-xmas)
310 (defalias 'gnus-make-overlay 'make-overlay)
311 (defalias 'gnus-delete-overlay 'delete-overlay)
312 (defalias 'gnus-overlay-put 'overlay-put)
313 (defalias 'gnus-move-overlay 'move-overlay)
314 (defalias 'gnus-overlay-buffer 'overlay-buffer)
315 (defalias 'gnus-overlay-start 'overlay-start)
316 (defalias 'gnus-overlay-end 'overlay-end)
317 (defalias 'gnus-extent-detached-p 'ignore)
318 (defalias 'gnus-extent-start-open 'ignore)
319 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
320 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
321 (defalias 'gnus-character-to-event 'identity)
322 (defalias 'gnus-assq-delete-all 'assq-delete-all)
323 (defalias 'gnus-add-text-properties 'add-text-properties)
324 (defalias 'gnus-put-text-property 'put-text-property)
325 (defvar gnus-mode-line-image-cache t)
326 (if (fboundp 'find-image)
327 (defun gnus-mode-line-buffer-identification (line)
328 (let ((str (car-safe line))
329 (load-path (mm-image-load-path)))
330 (if (and (stringp str)
331 (string-match "^Gnus:" str))
332 (progn (add-text-properties
335 (if (eq t gnus-mode-line-image-cache)
336 (setq gnus-mode-line-image-cache
338 '((:type xpm :file "gnus-pointer.xpm"
340 (:type xbm :file "gnus-pointer.xbm"
342 gnus-mode-line-image-cache)
345 gnus-version (gnus-emacs-version)))
349 (defalias 'gnus-mode-line-buffer-identification 'identity))
350 (defalias 'gnus-characterp 'numberp)
351 (defalias 'gnus-deactivate-mark 'deactivate-mark)
352 (defalias 'gnus-window-edges 'window-edges)
353 (defalias 'gnus-key-press-event-p 'numberp)
354 ;;(defalias 'gnus-decode-rfc1522 'ignore)
357 ;; We define these group faces here to avoid the display
358 ;; update forced when creating new faces.
360 (defface gnus-group-news-1
363 (:foreground "PaleTurquoise" :bold t))
366 (:foreground "ForestGreen" :bold t))
369 "Level 1 newsgroup face."
371 ;; backward-compatibility alias
372 (put 'gnus-group-news-1-face 'face-alias 'gnus-group-news-1)
374 (defface gnus-group-news-1-empty
377 (:foreground "PaleTurquoise"))
380 (:foreground "ForestGreen"))
383 "Level 1 empty newsgroup face."
385 ;; backward-compatibility alias
386 (put 'gnus-group-news-1-empty-face 'face-alias 'gnus-group-news-1-empty)
388 (defface gnus-group-news-2
391 (:foreground "turquoise" :bold t))
394 (:foreground "CadetBlue4" :bold t))
397 "Level 2 newsgroup face."
399 ;; backward-compatibility alias
400 (put 'gnus-group-news-2-face 'face-alias 'gnus-group-news-2)
402 (defface gnus-group-news-2-empty
405 (:foreground "turquoise"))
408 (:foreground "CadetBlue4"))
411 "Level 2 empty newsgroup face."
413 ;; backward-compatibility alias
414 (put 'gnus-group-news-2-empty-face 'face-alias 'gnus-group-news-2-empty)
416 (defface gnus-group-news-3
425 "Level 3 newsgroup face."
427 ;; backward-compatibility alias
428 (put 'gnus-group-news-3-face 'face-alias 'gnus-group-news-3)
430 (defface gnus-group-news-3-empty
439 "Level 3 empty newsgroup face."
441 ;; backward-compatibility alias
442 (put 'gnus-group-news-3-empty-face 'face-alias 'gnus-group-news-3-empty)
444 (defface gnus-group-news-4
453 "Level 4 newsgroup face."
455 ;; backward-compatibility alias
456 (put 'gnus-group-news-4-face 'face-alias 'gnus-group-news-4)
458 (defface gnus-group-news-4-empty
467 "Level 4 empty newsgroup face."
469 ;; backward-compatibility alias
470 (put 'gnus-group-news-4-empty-face 'face-alias 'gnus-group-news-4-empty)
472 (defface gnus-group-news-5
481 "Level 5 newsgroup face."
483 ;; backward-compatibility alias
484 (put 'gnus-group-news-5-face 'face-alias 'gnus-group-news-5)
486 (defface gnus-group-news-5-empty
495 "Level 5 empty newsgroup face."
497 ;; backward-compatibility alias
498 (put 'gnus-group-news-5-empty-face 'face-alias 'gnus-group-news-5-empty)
500 (defface gnus-group-news-6
509 "Level 6 newsgroup face."
511 ;; backward-compatibility alias
512 (put 'gnus-group-news-6-face 'face-alias 'gnus-group-news-6)
514 (defface gnus-group-news-6-empty
523 "Level 6 empty newsgroup face."
525 ;; backward-compatibility alias
526 (put 'gnus-group-news-6-empty-face 'face-alias 'gnus-group-news-6-empty)
528 (defface gnus-group-news-low
531 (:foreground "DarkTurquoise" :bold t))
534 (:foreground "DarkGreen" :bold t))
537 "Low level newsgroup face."
539 ;; backward-compatibility alias
540 (put 'gnus-group-news-low-face 'face-alias 'gnus-group-news-low)
542 (defface gnus-group-news-low-empty
545 (:foreground "DarkTurquoise"))
548 (:foreground "DarkGreen"))
551 "Low level empty newsgroup face."
553 ;; backward-compatibility alias
554 (put 'gnus-group-news-low-empty-face 'face-alias 'gnus-group-news-low-empty)
556 (defface gnus-group-mail-1
559 (:foreground "aquamarine1" :bold t))
562 (:foreground "DeepPink3" :bold t))
565 "Level 1 mailgroup face."
567 ;; backward-compatibility alias
568 (put 'gnus-group-mail-1-face 'face-alias 'gnus-group-mail-1)
570 (defface gnus-group-mail-1-empty
573 (:foreground "aquamarine1"))
576 (:foreground "DeepPink3"))
578 (:italic t :bold t)))
579 "Level 1 empty mailgroup face."
581 ;; backward-compatibility alias
582 (put 'gnus-group-mail-1-empty-face 'face-alias 'gnus-group-mail-1-empty)
584 (defface gnus-group-mail-2
587 (:foreground "aquamarine2" :bold t))
590 (:foreground "HotPink3" :bold t))
593 "Level 2 mailgroup face."
595 ;; backward-compatibility alias
596 (put 'gnus-group-mail-2-face 'face-alias 'gnus-group-mail-2)
598 (defface gnus-group-mail-2-empty
601 (:foreground "aquamarine2"))
604 (:foreground "HotPink3"))
607 "Level 2 empty mailgroup face."
609 ;; backward-compatibility alias
610 (put 'gnus-group-mail-2-empty-face 'face-alias 'gnus-group-mail-2-empty)
612 (defface gnus-group-mail-3
615 (:foreground "aquamarine3" :bold t))
618 (:foreground "magenta4" :bold t))
621 "Level 3 mailgroup face."
623 ;; backward-compatibility alias
624 (put 'gnus-group-mail-3-face 'face-alias 'gnus-group-mail-3)
626 (defface gnus-group-mail-3-empty
629 (:foreground "aquamarine3"))
632 (:foreground "magenta4"))
635 "Level 3 empty mailgroup face."
637 ;; backward-compatibility alias
638 (put 'gnus-group-mail-3-empty-face 'face-alias 'gnus-group-mail-3-empty)
640 (defface gnus-group-mail-low
643 (:foreground "aquamarine4" :bold t))
646 (:foreground "DeepPink4" :bold t))
649 "Low level mailgroup face."
651 ;; backward-compatibility alias
652 (put 'gnus-group-mail-low-face 'face-alias 'gnus-group-mail-low)
654 (defface gnus-group-mail-low-empty
657 (:foreground "aquamarine4"))
660 (:foreground "DeepPink4"))
663 "Low level empty mailgroup face."
665 ;; backward-compatibility alias
666 (put 'gnus-group-mail-low-empty-face 'face-alias 'gnus-group-mail-low-empty)
668 ;; Summary mode faces.
670 (defface gnus-summary-selected '((t (:underline t)))
671 "Face used for selected articles."
672 :group 'gnus-summary)
673 ;; backward-compatibility alias
674 (put 'gnus-summary-selected-face 'face-alias 'gnus-summary-selected)
676 (defface gnus-summary-cancelled
678 (:foreground "yellow" :background "black")))
679 "Face used for cancelled articles."
680 :group 'gnus-summary)
681 ;; backward-compatibility alias
682 (put 'gnus-summary-cancelled-face 'face-alias 'gnus-summary-cancelled)
684 (defface gnus-summary-high-ticked
687 (:foreground "pink" :bold t))
690 (:foreground "firebrick" :bold t))
693 "Face used for high interest ticked articles."
694 :group 'gnus-summary)
695 ;; backward-compatibility alias
696 (put 'gnus-summary-high-ticked-face 'face-alias 'gnus-summary-high-ticked)
698 (defface gnus-summary-low-ticked
701 (:foreground "pink" :italic t))
704 (:foreground "firebrick" :italic t))
707 "Face used for low interest ticked articles."
708 :group 'gnus-summary)
709 ;; backward-compatibility alias
710 (put 'gnus-summary-low-ticked-face 'face-alias 'gnus-summary-low-ticked)
712 (defface gnus-summary-normal-ticked
715 (:foreground "pink"))
718 (:foreground "firebrick"))
721 "Face used for normal interest ticked articles."
722 :group 'gnus-summary)
723 ;; backward-compatibility alias
724 (put 'gnus-summary-normal-ticked-face 'face-alias 'gnus-summary-normal-ticked)
726 (defface gnus-summary-high-ancient
729 (:foreground "SkyBlue" :bold t))
732 (:foreground "RoyalBlue" :bold t))
735 "Face used for high interest ancient articles."
736 :group 'gnus-summary)
737 ;; backward-compatibility alias
738 (put 'gnus-summary-high-ancient-face 'face-alias 'gnus-summary-high-ancient)
740 (defface gnus-summary-low-ancient
743 (:foreground "SkyBlue" :italic t))
746 (:foreground "RoyalBlue" :italic t))
749 "Face used for low interest ancient articles."
750 :group 'gnus-summary)
751 ;; backward-compatibility alias
752 (put 'gnus-summary-low-ancient-face 'face-alias 'gnus-summary-low-ancient)
754 (defface gnus-summary-normal-ancient
757 (:foreground "SkyBlue"))
760 (:foreground "RoyalBlue"))
763 "Face used for normal interest ancient articles."
764 :group 'gnus-summary)
765 ;; backward-compatibility alias
766 (put 'gnus-summary-normal-ancient-face 'face-alias 'gnus-summary-normal-ancient)
768 (defface gnus-summary-high-undownloaded
771 (:bold t :foreground "cyan4"))
772 (((class color) (background dark))
773 (:bold t :foreground "LightGray"))
774 (t (:inverse-video t :bold t)))
775 "Face used for high interest uncached articles."
776 :group 'gnus-summary)
777 ;; backward-compatibility alias
778 (put 'gnus-summary-high-undownloaded-face 'face-alias 'gnus-summary-high-undownloaded)
780 (defface gnus-summary-low-undownloaded
783 (:italic t :foreground "cyan4" :bold nil))
784 (((class color) (background dark))
785 (:italic t :foreground "LightGray" :bold nil))
786 (t (:inverse-video t :italic t)))
787 "Face used for low interest uncached articles."
788 :group 'gnus-summary)
789 ;; backward-compatibility alias
790 (put 'gnus-summary-low-undownloaded-face 'face-alias 'gnus-summary-low-undownloaded)
792 (defface gnus-summary-normal-undownloaded
795 (:foreground "cyan4" :bold nil))
796 (((class color) (background dark))
797 (:foreground "LightGray" :bold nil))
798 (t (:inverse-video t)))
799 "Face used for normal interest uncached articles."
800 :group 'gnus-summary)
801 ;; backward-compatibility alias
802 (put 'gnus-summary-normal-undownloaded-face 'face-alias 'gnus-summary-normal-undownloaded)
804 (defface gnus-summary-high-unread
807 "Face used for high interest unread articles."
808 :group 'gnus-summary)
809 ;; backward-compatibility alias
810 (put 'gnus-summary-high-unread-face 'face-alias 'gnus-summary-high-unread)
812 (defface gnus-summary-low-unread
815 "Face used for low interest unread articles."
816 :group 'gnus-summary)
817 ;; backward-compatibility alias
818 (put 'gnus-summary-low-unread-face 'face-alias 'gnus-summary-low-unread)
820 (defface gnus-summary-normal-unread
823 "Face used for normal interest unread articles."
824 :group 'gnus-summary)
825 ;; backward-compatibility alias
826 (put 'gnus-summary-normal-unread-face 'face-alias 'gnus-summary-normal-unread)
828 (defface gnus-summary-high-read
831 (:foreground "PaleGreen"
835 (:foreground "DarkGreen"
839 "Face used for high interest read articles."
840 :group 'gnus-summary)
841 ;; backward-compatibility alias
842 (put 'gnus-summary-high-read-face 'face-alias 'gnus-summary-high-read)
844 (defface gnus-summary-low-read
847 (:foreground "PaleGreen"
851 (:foreground "DarkGreen"
855 "Face used for low interest read articles."
856 :group 'gnus-summary)
857 ;; backward-compatibility alias
858 (put 'gnus-summary-low-read-face 'face-alias 'gnus-summary-low-read)
860 (defface gnus-summary-normal-read
863 (:foreground "PaleGreen"))
866 (:foreground "DarkGreen"))
869 "Face used for normal interest read articles."
870 :group 'gnus-summary)
871 ;; backward-compatibility alias
872 (put 'gnus-summary-normal-read-face 'face-alias 'gnus-summary-normal-read)
879 (defvar gnus-buffers nil)
881 (defun gnus-get-buffer-create (name)
882 "Do the same as `get-buffer-create', but store the created buffer."
883 (or (get-buffer name)
884 (car (push (get-buffer-create name) gnus-buffers))))
886 (defun gnus-add-buffer ()
887 "Add the current buffer to the list of Gnus buffers."
888 (push (current-buffer) gnus-buffers))
890 (defmacro gnus-kill-buffer (buffer)
891 "Kill BUFFER and remove from the list of Gnus buffers."
892 `(let ((buf ,buffer))
893 (when (gnus-buffer-exists-p buf)
894 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
897 (defun gnus-buffers ()
898 "Return a list of live Gnus buffers."
899 (while (and gnus-buffers
900 (not (buffer-name (car gnus-buffers))))
902 (let ((buffers gnus-buffers))
904 (if (buffer-name (cadr buffers))
906 (setcdr buffers (cddr buffers)))))
911 (defvar gnus-group-buffer "*Group*")
914 (autoload 'gnus-play-jingle "gnus-audio"))
919 (:foreground "#888888"))
922 (:foreground "#888888"))
925 "Face for the splash screen."
927 ;; backward-compatibility alias
928 (put 'gnus-splash-face 'face-alias 'gnus-splash)
930 (defun gnus-splash ()
932 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
933 (let ((buffer-read-only nil))
935 (unless gnus-inhibit-startup-message
936 (gnus-group-startup-message)
938 (when gnus-play-startup-jingle
939 (gnus-play-jingle))))))
941 (defun gnus-indent-rigidly (start end arg)
942 "Indent rigidly using only spaces and no tabs."
945 (narrow-to-region start end)
947 (indent-rigidly start end arg)
948 ;; We translate tabs into spaces -- not everybody uses
949 ;; an 8-character tab.
950 (goto-char (point-min))
951 (while (search-forward "\t" nil t)
952 (replace-match " " t t))))))
954 (defvar gnus-simple-splash nil)
956 ;;(format "%02x%02x%02x" 114 66 20) "724214"
958 (defvar gnus-logo-color-alist
959 '((flame "#cc3300" "#ff2200")
960 (pine "#c0cc93" "#f8ffb8")
961 (moss "#a1cc93" "#d2ffb8")
962 (irish "#04cc90" "#05ff97")
963 (sky "#049acc" "#05deff")
964 (tin "#6886cc" "#82b6ff")
965 (velvet "#7c68cc" "#8c82ff")
966 (grape "#b264cc" "#cf7df")
967 (labia "#cc64c2" "#fd7dff")
968 (berry "#cc6485" "#ff7db5")
969 (dino "#724214" "#1e3f03")
970 (oort "#cccccc" "#888888")
971 (storm "#666699" "#99ccff")
972 (pdino "#9999cc" "#99ccff")
973 (purp "#9999cc" "#666699")
974 (no "#000000" "#ff0000")
975 (neutral "#b4b4b4" "#878787")
976 (september "#bf9900" "#ffcc00"))
977 "Color alist used for the Gnus logo.")
979 (defcustom gnus-logo-color-style 'oort
980 "*Color styles used for the Gnus logo."
981 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
982 gnus-logo-color-alist))
985 (defvar gnus-logo-colors
986 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
987 "Colors used for the Gnus logo.")
989 (defun gnus-group-startup-message (&optional x y)
990 "Insert startup message in current buffer."
991 ;; Insert the message.
995 (fboundp 'find-image)
997 (let* ((data-directory (nnheader-find-etc-directory "images/gnus"))
999 `((:type xpm :file "gnus.xpm"
1001 (("thing" . ,(car gnus-logo-colors))
1002 ("shadow" . ,(cadr gnus-logo-colors))
1003 ("oort" . "#eeeeee")
1004 ("background" . ,(face-background 'default))))
1005 (:type pbm :file "gnus.pbm"
1006 ;; Account for the pbm's blackground.
1007 :background ,(face-foreground 'gnus-splash)
1008 :foreground ,(face-background 'default))
1009 (:type xbm :file "gnus.xbm"
1010 ;; Account for the xbm's blackground.
1011 :background ,(face-foreground 'gnus-splash)
1012 :foreground ,(face-background 'default))))))
1014 (let ((size (image-size image)))
1015 (insert-char ?\n (max 0 (round (- (window-height)
1016 (or y (cdr size)) 1) 2)))
1017 (insert-char ?\ (max 0 (round (- (window-width)
1018 (or x (car size))) 2)))
1019 (insert-image image))
1020 (setq gnus-simple-splash nil)
1026 _ ___ __ ___ __ _ ___
1045 ;; And then hack it.
1046 (gnus-indent-rigidly (point-min) (point-max)
1047 (/ (max (- (window-width) (or x 46)) 0) 2))
1048 (goto-char (point-min))
1050 (let* ((pheight (count-lines (point-min) (point-max)))
1051 (wheight (window-height))
1052 (rest (- wheight pheight)))
1053 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
1055 (put-text-property (point-min) (point-max) 'face 'gnus-splash)
1056 (setq gnus-simple-splash t)))
1057 (goto-char (point-min))
1058 (setq mode-line-buffer-identification (concat " " gnus-version))
1059 (set-buffer-modified-p t))
1062 (let ((command (format "%s" this-command)))
1063 (when (string-match "gnus" command)
1064 (if (string-match "gnus-other-frame" command)
1065 (gnus-get-buffer-create gnus-group-buffer)
1070 (require 'gnus-util)
1073 (defcustom gnus-parameters nil
1074 "Alist of group parameters.
1077 ((\"mail\\\\..*\" (gnus-show-threads nil)
1078 (gnus-use-scoring nil)
1079 (gnus-summary-line-format
1080 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
1083 (\"mail\\\\.me\" (gnus-use-scoring t))
1084 (\"list\\\\..*\" (total-expire . t)
1085 (broken-reply-to . t)))"
1087 :group 'gnus-group-various
1088 :type '(repeat (cons regexp
1091 (defvar gnus-group-parameters-more nil)
1093 (defmacro gnus-define-group-parameter (param &rest rest)
1094 "Define a group parameter PARAM.
1095 REST is a plist of following:
1096 :type One of `bool', `list' or nil.
1097 :function The name of the function.
1098 :function-document The documentation of the function.
1099 :parameter-type The type for customizing the parameter.
1100 :parameter-document The documentation for the parameter.
1101 :variable The name of the variable.
1102 :variable-document The documentation for the variable.
1103 :variable-group The group for customizing the variable.
1104 :variable-type The type for customizing the variable.
1105 :variable-default The default value of the variable."
1106 (let* ((type (plist-get rest :type))
1107 (parameter-type (plist-get rest :parameter-type))
1108 (parameter-document (plist-get rest :parameter-document))
1109 (function (or (plist-get rest :function)
1110 (intern (format "gnus-parameter-%s" param))))
1111 (function-document (or (plist-get rest :function-document) ""))
1112 (variable (or (plist-get rest :variable)
1113 (intern (format "gnus-parameter-%s-alist" param))))
1114 (variable-document (or (plist-get rest :variable-document) ""))
1115 (variable-group (plist-get rest :variable-group))
1116 (variable-type (or (plist-get rest :variable-type)
1118 (list (regexp :tag "Group")
1119 ,(car (cdr parameter-type)))))))
1120 (variable-default (plist-get rest :variable-default)))
1123 `(defcustom ,variable ,variable-default
1125 :group 'gnus-group-parameter
1126 :group ',variable-group
1127 :type ,variable-type)
1128 `(setq gnus-group-parameters-more
1129 (delq (assq ',param gnus-group-parameters-more)
1130 gnus-group-parameters-more))
1131 `(add-to-list 'gnus-group-parameters-more
1134 ,parameter-document))
1136 `(defun ,function (name)
1138 (let ((params (gnus-group-find-parameter name))
1141 ((memq ',param params)
1143 ((setq val (assq ',param params))
1145 ((stringp ,variable)
1146 (string-match ,variable name))
1148 (let ((alist ,variable)
1150 (while (setq elem (pop alist))
1152 (string-match (car elem) name))
1155 (if (consp value) (car value) value))))))
1156 `(defun ,function (name)
1159 (or (gnus-group-find-parameter name ',param ,(and type t))
1160 (let ((alist ,variable)
1162 (while (setq elem (pop alist))
1164 (string-match (car elem) name))
1169 '(if (consp value) (car value) value))))))))))
1171 (defcustom gnus-home-directory "~/"
1172 "Directory variable that specifies the \"home\" directory.
1173 All other Gnus file and directory variables are initialized from this variable."
1177 (defcustom gnus-directory (or (getenv "SAVEDIR")
1178 (nnheader-concat gnus-home-directory "News/"))
1179 "*Directory variable from which all other Gnus file variables are derived.
1181 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1182 This means that other directory variables that are initialized from
1183 this variable won't be set properly if you set this variable in `.gnus.el'.
1184 Set this variable in `.emacs' instead."
1188 (defcustom gnus-default-directory nil
1189 "*Default directory for all Gnus buffers."
1191 :type '(choice (const :tag "current" nil)
1194 ;; Site dependent variables. These variables should be defined in
1197 (defvar gnus-default-nntp-server nil
1198 "Specify a default NNTP server.
1199 This variable should be defined in paths.el, and should never be set
1201 If you want to change servers, you should use `gnus-select-method'.
1202 See the documentation to that variable.")
1204 ;; Don't touch this variable.
1205 (defvar gnus-nntp-service "nntp"
1206 "NNTP service name (\"nntp\" or 119).
1207 This is an obsolete variable, which is scarcely used. If you use an
1208 nntp server for your newsgroup and want to change the port number
1209 used to 899, you would say something along these lines:
1211 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1213 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1214 "A file with only the name of the nntp server in it."
1219 (defun gnus-getenv-nntpserver ()
1220 "Find default nntp server.
1221 Check the NNTPSERVER environment variable and the
1222 `gnus-nntpserver-file' file."
1223 (or (getenv "NNTPSERVER")
1224 (and (file-readable-p gnus-nntpserver-file)
1226 (insert-file-contents gnus-nntpserver-file)
1227 (when (re-search-forward "[^ \t\n\r]+" nil t)
1228 (match-string 0))))))
1230 (defcustom gnus-select-method
1233 (list 'nntp (or (condition-case nil
1234 (gnus-getenv-nntpserver)
1236 (when (and gnus-default-nntp-server
1237 (not (string= gnus-default-nntp-server "")))
1238 gnus-default-nntp-server)
1240 (if (or (null gnus-nntp-service)
1241 (equal gnus-nntp-service "nntp"))
1243 (list gnus-nntp-service)))
1245 "Default method for selecting a newsgroup.
1246 This variable should be a list, where the first element is how the
1247 news is to be fetched, the second is the address.
1249 For instance, if you want to get your news via \"flab.flab.edu\" using
1250 NNTP, you could say:
1252 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1254 If you want to use your local spool, say:
1256 \(setq gnus-select-method (list 'nnspool (system-name)))
1258 If you use this variable, you must set `gnus-nntp-server' to nil.
1260 There is a lot more to know about select methods and virtual servers -
1261 see the manual for details."
1263 :type 'gnus-select-method)
1265 (defcustom gnus-message-archive-method "archive"
1266 "*Method used for archiving messages you've sent.
1267 This should be a mail method."
1269 :group 'gnus-message
1270 :type '(choice (const :tag "Default archive method" "archive")
1271 gnus-select-method))
1273 (defcustom gnus-message-archive-group nil
1274 "*Name of the group in which to save the messages you've written.
1275 This can either be a string; a list of strings; or an alist
1276 of regexps/functions/forms to be evaluated to return a string (or a list
1277 of strings). The functions are called with the name of the current
1278 group (or nil) as a parameter.
1280 If you want to save your mail in one group and the news articles you
1281 write in another group, you could say something like:
1283 \(setq gnus-message-archive-group
1284 '((if (message-news-p)
1288 Normally the group names returned by this variable should be
1289 unprefixed -- which implicitly means \"store on the archive server\".
1290 However, you may wish to store the message on some other server. In
1291 that case, just return a fully prefixed name of the group --
1292 \"nnml+private:mail.misc\", for instance."
1293 :group 'gnus-message
1294 :type '(choice (const :tag "none" nil)
1299 (defcustom gnus-secondary-servers nil
1300 "List of NNTP servers that the user can choose between interactively.
1301 To make Gnus query you for a server, you have to give `gnus' a
1302 non-numeric prefix - `C-u M-x gnus', in short."
1304 :type '(repeat string))
1306 (defcustom gnus-nntp-server nil
1307 "*The name of the host running the NNTP server.
1308 This variable is semi-obsolete. Use the `gnus-select-method'
1311 :type '(choice (const :tag "disable" nil)
1314 (defcustom gnus-secondary-select-methods nil
1315 "A list of secondary methods that will be used for reading news.
1316 This is a list where each element is a complete select method (see
1317 `gnus-select-method').
1319 If, for instance, you want to read your mail with the nnml back end,
1320 you could set this variable:
1322 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1324 :type '(repeat gnus-select-method))
1326 (defvar gnus-backup-default-subscribed-newsgroups
1327 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1328 "Default default new newsgroups the first time Gnus is run.
1329 Should be set in paths.el, and shouldn't be touched by the user.")
1331 (defcustom gnus-local-domain nil
1332 "Local domain name without a host name.
1333 The DOMAINNAME environment variable is used instead if it is defined.
1334 If the function `system-name' returns the full Internet name, there is
1335 no need to set this variable."
1336 :group 'gnus-message
1337 :type '(choice (const :tag "default" nil)
1340 (defvar gnus-local-organization nil
1341 "String with a description of what organization (if any) the user belongs to.
1342 Obsolete variable; use `message-user-organization' instead.")
1344 ;; Customization variables
1346 (defcustom gnus-refer-article-method nil
1347 "Preferred method for fetching an article by Message-ID.
1348 If you are reading news from the local spool (with nnspool), fetching
1349 articles by Message-ID is painfully slow. By setting this method to an
1350 nntp method, you might get acceptable results.
1352 The value of this variable must be a valid select method as discussed
1353 in the documentation of `gnus-select-method'.
1355 It can also be a list of select methods, as well as the special symbol
1356 `current', which means to use the current select method. If it is a
1357 list, Gnus will try all the methods in the list until it finds a match."
1359 :type '(choice (const :tag "default" nil)
1361 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1363 (repeat :menu-tag "Try multiple"
1365 :value (current (nnweb "refer" (nnweb-type google)))
1366 (choice :tag "Method"
1368 (const :tag "Google"
1369 (nnweb "refer" (nnweb-type google)))
1370 gnus-select-method))))
1372 (defcustom gnus-group-faq-directory
1373 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1374 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1375 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1376 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1377 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1378 "/ftp@rtfm.mit.edu:/pub/usenet/"
1379 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1380 "/ftp@ftp.sunet.se:/pub/usenet/"
1381 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1382 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1383 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1384 "*Directory where the group FAQs are stored.
1385 This will most commonly be on a remote machine, and the file will be
1386 fetched by ange-ftp.
1388 This variable can also be a list of directories. In that case, the
1389 first element in the list will be used by default. The others can
1390 be used when being prompted for a site.
1392 Note that Gnus uses an aol machine as the default directory. If this
1393 feels fundamentally unclean, just think of it as a way to finally get
1394 something of value back from them.
1396 If the default site is too slow, try one of these:
1398 North America: mirrors.aol.com /pub/rtfm/usenet
1399 ftp.seas.gwu.edu /pub/rtfm
1400 rtfm.mit.edu /pub/usenet
1401 Europe: ftp.uni-paderborn.de /pub/FAQ
1402 src.doc.ic.ac.uk /usenet/news-FAQS
1403 ftp.sunet.se /pub/usenet
1404 ftp.pasteur.fr /pub/FAQ
1405 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1406 hwarang.postech.ac.kr /pub/usenet
1407 ftp.hk.super.net /mirror/faqs"
1408 :group 'gnus-group-various
1409 :type '(choice directory
1410 (repeat directory)))
1412 (defcustom gnus-group-charter-alist
1413 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1414 ("de" . (concat "http://purl.net/charta/" name ".html"))
1415 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1416 ("england" . (concat "http://england.news-admin.org/charters/" name))
1417 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1418 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1419 (gnus-replace-in-string name "europa\\." "") ".html"))
1420 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1421 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1422 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1423 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1424 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1425 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1426 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1427 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1428 (gnus-replace-in-string name "\\." "_") ".html"))
1429 ("milw" . (concat "http://usenet.mil.wi.us/"
1430 (gnus-replace-in-string name "milw\\." "") "-charter"))
1431 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1432 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1433 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1434 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1435 When FORM is evaluated `name' is bound to the name of the group."
1437 :group 'gnus-group-various
1438 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1440 (defcustom gnus-group-fetch-control-use-browse-url nil
1441 "*Non-nil means that control messages are displayed using `browse-url'.
1442 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1445 :group 'gnus-group-various
1448 (defcustom gnus-use-cross-reference t
1449 "*Non-nil means that cross referenced articles will be marked as read.
1450 If nil, ignore cross references. If t, mark articles as read in
1451 subscribed newsgroups. If neither t nor nil, mark as read in all
1454 :type '(choice (const :tag "off" nil)
1455 (const :tag "subscribed" t)
1459 (defcustom gnus-process-mark ?#
1461 :group 'gnus-group-visual
1462 :group 'gnus-summary-marks
1465 (defcustom gnus-large-newsgroup 200
1466 "*The number of articles which indicates a large newsgroup.
1467 If the number of articles in a newsgroup is greater than this value,
1468 confirmation is required for selecting the newsgroup.
1469 If it is nil, no confirmation is required."
1470 :group 'gnus-group-select
1471 :type '(choice (const :tag "No limit" nil)
1474 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1475 "*Non-nil means that the default name of a file to save articles in is the group name.
1476 If it's nil, the directory form of the group name is used instead.
1478 If this variable is a list, and the list contains the element
1479 `not-score', long file names will not be used for score files; if it
1480 contains the element `not-save', long file names will not be used for
1481 saving; and if it contains the element `not-kill', long file names
1482 will not be used for kill files.
1484 Note that the default for this variable varies according to what system
1485 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1486 to nil while on all other systems it defaults to t."
1488 :type '(radio (sexp :format "Non-nil\n"
1489 :match (lambda (widget value)
1490 (and value (not (listp value))))
1493 (checklist (const :format "%v " not-score)
1494 (const :format "%v " not-save)
1497 (defcustom gnus-kill-files-directory gnus-directory
1498 "*Name of the directory where kill files will be stored (default \"~/News\")."
1499 :group 'gnus-score-files
1500 :group 'gnus-score-kill
1503 (defcustom gnus-save-score nil
1504 "*If non-nil, save group scoring info."
1505 :group 'gnus-score-various
1509 (defcustom gnus-use-undo t
1510 "*If non-nil, allow undoing in Gnus group mode buffers."
1514 (defcustom gnus-use-adaptive-scoring nil
1515 "*If non-nil, use some adaptive scoring scheme.
1516 If a list, then the values `word' and `line' are meaningful. The
1517 former will perform adaption on individual words in the subject
1518 header while `line' will perform adaption on several headers."
1520 :group 'gnus-score-adapt
1521 :type '(set (const word) (const line)))
1523 (defcustom gnus-use-cache 'passive
1524 "*If nil, Gnus will ignore the article cache.
1525 If `passive', it will allow entering (and reading) articles
1526 explicitly entered into the cache. If anything else, use the
1527 cache to the full extent of the law."
1530 :type '(choice (const :tag "off" nil)
1531 (const :tag "passive" passive)
1532 (const :tag "active" t)))
1534 (defcustom gnus-use-trees nil
1535 "*If non-nil, display a thread tree buffer."
1539 (defcustom gnus-use-grouplens nil
1540 "*If non-nil, use GroupLens ratings."
1544 (defcustom gnus-keep-backlog 20
1545 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1546 If it is a number N, then Gnus will only keep the last N articles
1547 read. If it is neither nil nor a number, Gnus will keep all read
1548 articles. This is not a good idea."
1550 :type '(choice (const :tag "off" nil)
1555 (defcustom gnus-use-nocem nil
1556 "*If non-nil, Gnus will read NoCeM cancel messages."
1560 (defcustom gnus-suppress-duplicates nil
1561 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1565 (defcustom gnus-use-scoring t
1566 "*If non-nil, enable scoring."
1570 (defcustom gnus-summary-prepare-exit-hook
1571 '(gnus-summary-expire-articles)
1572 "*A hook called when preparing to exit from the summary buffer.
1573 It calls `gnus-summary-expire-articles' by default."
1574 :group 'gnus-summary-exit
1577 (defcustom gnus-novice-user t
1578 "*Non-nil means that you are a Usenet novice.
1579 If non-nil, verbose messages may be displayed and confirmations may be
1584 (defcustom gnus-expert-user nil
1585 "*Non-nil means that you will never be asked for confirmation about anything.
1586 That doesn't mean *anything* anything; particularly destructive
1587 commands will still require prompting."
1591 (defcustom gnus-interactive-catchup t
1592 "*If non-nil, require your confirmation when catching up a group."
1593 :group 'gnus-group-select
1596 (defcustom gnus-interactive-exit t
1597 "*If non-nil, require your confirmation when exiting Gnus."
1601 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1602 "*Function for extracting address components from a From header.
1603 Two pre-defined function exist: `gnus-extract-address-components',
1604 which is the default, quite fast, and too simplistic solution, and
1605 `mail-extract-address-components', which works much better, but is
1607 :group 'gnus-summary-format
1608 :type '(radio (function-item gnus-extract-address-components)
1609 (function-item mail-extract-address-components)
1610 (function :tag "Other")))
1612 (defcustom gnus-carpal nil
1613 "*If non-nil, display clickable icons."
1617 (defcustom gnus-shell-command-separator ";"
1618 "String used to separate shell commands."
1622 (defcustom gnus-valid-select-methods
1623 '(("nntp" post address prompt-address physical-address)
1624 ("nnspool" post address)
1625 ("nnvirtual" post-mail virtual prompt-address)
1626 ("nnmbox" mail respool address)
1627 ("nnml" post-mail respool address)
1628 ("nnmh" mail respool address)
1629 ("nndir" post-mail prompt-address physical-address)
1630 ("nneething" none address prompt-address physical-address)
1631 ("nndoc" none address prompt-address)
1632 ("nnbabyl" mail address respool)
1633 ("nnkiboze" post virtual)
1634 ("nnsoup" post-mail address)
1635 ("nndraft" post-mail)
1636 ("nnfolder" mail respool address)
1637 ("nngateway" post-mail address prompt-address physical-address)
1646 ("nnagent" post-mail)
1647 ("nnimap" post-mail address prompt-address physical-address)
1648 ("nnmaildir" mail respool address)
1650 "*An alist of valid select methods.
1651 The first element of each list lists should be a string with the name
1652 of the select method. The other elements may be the category of
1653 this method (i. e., `post', `mail', `none' or whatever) or other
1654 properties that this method has (like being respoolable).
1655 If you implement a new select method, all you should have to change is
1656 this variable. I think."
1658 :type '(repeat (group (string :tag "Name")
1659 (radio-button-choice (const :format "%v " post)
1660 (const :format "%v " mail)
1661 (const :format "%v " none)
1663 (checklist :inline t
1664 (const :format "%v " address)
1665 (const :format "%v " prompt-address)
1666 (const :format "%v " physical-address)
1667 (const :format "%v " virtual)
1670 (defun gnus-redefine-select-method-widget ()
1671 "Recomputes the select-method widget based on the value of
1672 `gnus-valid-select-methods'."
1673 (define-widget 'gnus-select-method 'list
1674 "Widget for entering a select method."
1676 :tag "Select Method"
1677 :args `((choice :tag "Method"
1678 ,@(mapcar (lambda (entry)
1679 (list 'const :format "%v\n"
1680 (intern (car entry))))
1681 gnus-valid-select-methods)
1682 (symbol :tag "other"))
1683 (string :tag "Address")
1684 (repeat :tag "Options"
1688 (sexp :tag "Value"))))))
1690 (gnus-redefine-select-method-widget)
1692 (defcustom gnus-updated-mode-lines '(group article summary tree)
1693 "List of buffers that should update their mode lines.
1694 The list may contain the symbols `group', `article', `tree' and
1695 `summary'. If the corresponding symbol is present, Gnus will keep
1696 that mode line updated with information that may be pertinent.
1697 If this variable is nil, screen refresh may be quicker."
1698 :group 'gnus-various
1699 :type '(set (const group)
1704 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1705 (defcustom gnus-mode-non-string-length nil
1706 "*Max length of mode-line non-string contents.
1707 If this is nil, Gnus will take space as is needed, leaving the rest
1708 of the mode line intact. Note that the default of nil is unlikely
1709 to be desirable; see the manual for further details."
1710 :group 'gnus-various
1711 :type '(choice (const nil)
1714 ;; There should be special validation for this.
1715 (define-widget 'gnus-email-address 'string
1716 "An email address.")
1718 (gnus-define-group-parameter
1721 "Return GROUP's to-address."
1723 "*Alist of group regexps and correspondent to-addresses."
1724 :variable-group gnus-group-parameter
1725 :parameter-type '(gnus-email-address :tag "To Address")
1726 :parameter-document "\
1727 This will be used when doing followups and posts.
1729 This is primarily useful in mail groups that represent closed
1730 mailing lists--mailing lists where it's expected that everybody that
1731 writes to the mailing list is subscribed to it. Since using this
1732 parameter ensures that the mail only goes to the mailing list itself,
1733 it means that members won't receive two copies of your followups.
1735 Using `to-address' will actually work whether the group is foreign or
1736 not. Let's say there's a group on the server that is called
1737 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1738 articles from a mail-to-news gateway. Posting directly to this group
1739 is therefore impossible--you have to send mail to the mailing list
1742 The gnus-group-split mail splitting mechanism will behave as if this
1743 address was listed in gnus-group-split Addresses (see below).")
1745 (gnus-define-group-parameter
1748 "Return GROUP's to-list."
1750 "*Alist of group regexps and correspondent to-lists."
1751 :variable-group gnus-group-parameter
1752 :parameter-type '(gnus-email-address :tag "To List")
1753 :parameter-document "\
1754 This address will be used when doing a `a' in the group.
1756 It is totally ignored when doing a followup--except that if it is
1757 present in a news group, you'll get mail group semantics when doing
1760 The gnus-group-split mail splitting mechanism will behave as if this
1761 address was listed in gnus-group-split Addresses (see below).")
1763 (gnus-define-group-parameter
1767 "Return GROUP's subscription status."
1769 "*Groups which are automatically considered subscribed."
1770 :variable-group gnus-group-parameter
1771 :parameter-type '(const :tag "Subscribed" t)
1772 :parameter-document "\
1773 Gnus assumed that you are subscribed to the To/List address.
1775 When constructing a list of subscribed groups using
1776 `gnus-find-subscribed-addresses', Gnus includes the To address given
1777 above, or the list address (if the To address has not been set).")
1779 (gnus-define-group-parameter
1782 :function gnus-group-auto-expirable-p
1784 "Check whether GROUP is auto-expirable or not."
1785 :variable gnus-auto-expirable-newsgroups
1786 :variable-default nil
1788 "*Groups in which to automatically mark read articles as expirable.
1789 If non-nil, this should be a regexp that should match all groups in
1790 which to perform auto-expiry. This only makes sense for mail groups."
1791 :variable-group nnmail-expire
1792 :variable-type '(choice (const nil)
1794 :parameter-type '(const :tag "Automatic Expire" t)
1796 "All articles that are read will be marked as expirable.")
1798 (gnus-define-group-parameter
1801 :function gnus-group-total-expirable-p
1803 "Check whether GROUP is total-expirable or not."
1804 :variable gnus-total-expirable-newsgroups
1805 :variable-default nil
1807 "*Groups in which to perform expiry of all read articles.
1808 Use with extreme caution. All groups that match this regexp will be
1809 expiring - which means that all read articles will be deleted after
1810 \(say) one week. (This only goes for mail groups and the like, of
1812 :variable-group nnmail-expire
1813 :variable-type '(choice (const nil)
1815 :parameter-type '(const :tag "Total Expire" t)
1817 "All read articles will be put through the expiry process
1819 This happens even if they are not marked as expirable.
1822 (gnus-define-group-parameter
1825 "Return the default charset of GROUP."
1826 :variable gnus-group-charset-alist
1828 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1829 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1830 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1831 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1832 ("\\(^\\|:\\)relcom\\>" koi8-r)
1833 ("\\(^\\|:\\)fido7\\>" koi8-r)
1834 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1835 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1836 ("\\(^\\|:\\)han\\>" euc-kr)
1837 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1838 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1839 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1841 "Alist of regexps (to match group names) and default charsets to be used when reading."
1842 :variable-group gnus-charset
1843 :variable-type '(repeat (list (regexp :tag "Group")
1844 (symbol :tag "Charset")))
1845 :parameter-type '(symbol :tag "Charset")
1846 :parameter-document "\
1847 The default charset to use in the group.")
1849 (gnus-define-group-parameter
1853 "Return a posting method for GROUP."
1854 :variable gnus-post-method-alist
1856 "Alist of regexps (to match group names) and method to be used when
1857 posting an article."
1858 :variable-group gnus-group-foreign
1860 '(choice :tag "Posting Method"
1861 (const :tag "Use native server" native)
1862 (const :tag "Use current server" current)
1863 (list :convert-widget
1865 (list 'sexp :tag "Methods"
1866 :value gnus-select-method))))
1868 "Posting method for this group.")
1870 (gnus-define-group-parameter
1871 large-newsgroup-initial
1874 "Return GROUP's initial input of the number of articles."
1876 "*Alist of group regexps and its initial input of the number of articles."
1877 :variable-group gnus-group-parameter
1878 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1879 (const :tag "All" nil)
1881 :parameter-document "\
1883 This number will be prompted as the initial value of the number of
1884 articles to list when the group is a large newsgroup (see
1885 `gnus-large-newsgroup'). If it is nil, the default value is the
1886 total number of articles in the group.")
1888 ;; The Gnus registry's ignored groups
1889 (gnus-define-group-parameter
1893 "Whether this group should be ignored by the registry."
1894 :variable gnus-registry-ignored-groups
1895 :variable-default nil
1897 "*Groups in which the registry should be turned off."
1898 :variable-group gnus-registry
1899 :variable-type '(repeat
1901 (regexp :tag "Group Name Regular Expression")
1902 (boolean :tag "Ignored")))
1904 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1906 "Whether the Gnus Registry should ignore this group.")
1908 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1909 (defcustom gnus-install-group-spam-parameters t
1910 "*Disable the group parameters for spam detection.
1911 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1916 (when gnus-install-group-spam-parameters
1917 (defvar gnus-group-spam-classification-spam t
1918 "Spam group classification (requires spam.el).
1919 This group contains spam messages. On summary entry, unread messages
1920 will be marked as spam. On summary exit, the specified spam
1921 processors will be invoked on spam-marked messages, then those
1922 messages will be expired, so the spam processor will only see a
1923 spam-marked message once.")
1925 (defvar gnus-group-spam-classification-ham 'ask
1926 "The ham value for the spam group parameter (requires spam.el).
1927 On summary exit, the specified ham processors will be invoked on
1928 ham-marked messages. Exercise caution, since the ham processor will
1929 see the same message more than once because there is no ham message
1932 (gnus-define-group-parameter
1936 "The spam type (spam, ham, or neither) of the group."
1937 :variable gnus-spam-newsgroup-contents
1938 :variable-default nil
1940 "*Group classification (spam, ham, or neither). Only
1941 meaningful when spam.el is loaded. If non-nil, this should be a
1942 list of group name regexps associated with a classification for
1943 each one. In spam groups, new articles are marked as spam on
1944 summary entry. There is other behavior associated with ham and
1945 no classification when spam.el is loaded - see the manual."
1946 :variable-group spam
1947 :variable-type '(repeat
1948 (list :tag "Group contents spam/ham classification"
1949 (regexp :tag "Group")
1951 (variable-item gnus-group-spam-classification-spam)
1952 (variable-item gnus-group-spam-classification-ham)
1953 (const :tag "Unclassified" nil))))
1955 :parameter-type '(list :tag "Group contents spam/ham classification"
1956 (choice :tag "Group contents classification for spam sorting"
1957 (variable-item gnus-group-spam-classification-spam)
1958 (variable-item gnus-group-spam-classification-ham)
1959 (const :tag "Unclassified" nil)))
1961 "The spam classification (spam, ham, or neither) of this group.
1962 When a spam group is entered, all unread articles are marked as
1963 spam. There is other behavior associated with ham and no
1964 classification when spam.el is loaded - see the manual.")
1966 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1967 "OBSOLETE: The ifile summary exit spam processor.")
1969 (defvar gnus-group-spam-exit-processor-stat "stat"
1970 "OBSOLETE: The spam-stat summary exit spam processor.")
1972 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1973 "OBSOLETE: The Bogofilter summary exit spam processor.")
1975 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1976 "OBSOLETE: The Blacklist summary exit spam processor.")
1978 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1979 "OBSOLETE: The Gmane reporting summary exit spam processor.
1980 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1982 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1983 "OBSOLETE: The spamoracle summary exit spam processor.")
1985 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1986 "OBSOLETE: The ifile summary exit ham processor.
1987 Only applicable to non-spam (unclassified and ham) groups.")
1989 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1990 "OBSOLETE: The Bogofilter summary exit ham processor.
1991 Only applicable to non-spam (unclassified and ham) groups.")
1993 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1994 "OBSOLETE: The spam-stat summary exit ham processor.
1995 Only applicable to non-spam (unclassified and ham) groups.")
1997 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1998 "OBSOLETE: The whitelist summary exit ham processor.
1999 Only applicable to non-spam (unclassified and ham) groups.")
2001 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
2002 "OBSOLETE: The BBDB summary exit ham processor.
2003 Only applicable to non-spam (unclassified and ham) groups.")
2005 (defvar gnus-group-ham-exit-processor-copy "copy"
2006 "OBSOLETE: The ham copy exit ham processor.
2007 Only applicable to non-spam (unclassified and ham) groups.")
2009 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
2010 "OBSOLETE: The spamoracle summary exit ham processor.
2011 Only applicable to non-spam (unclassified and ham) groups.")
2013 (gnus-define-group-parameter
2018 :tag "Spam Summary Exit Processor"
2020 (list :tag "Spam Summary Exit Processor Choices"
2022 (variable-item gnus-group-spam-exit-processor-ifile)
2023 (variable-item gnus-group-spam-exit-processor-stat)
2024 (variable-item gnus-group-spam-exit-processor-bogofilter)
2025 (variable-item gnus-group-spam-exit-processor-blacklist)
2026 (variable-item gnus-group-spam-exit-processor-spamoracle)
2027 (variable-item gnus-group-spam-exit-processor-report-gmane)
2028 (variable-item gnus-group-ham-exit-processor-bogofilter)
2029 (variable-item gnus-group-ham-exit-processor-ifile)
2030 (variable-item gnus-group-ham-exit-processor-stat)
2031 (variable-item gnus-group-ham-exit-processor-whitelist)
2032 (variable-item gnus-group-ham-exit-processor-BBDB)
2033 (variable-item gnus-group-ham-exit-processor-spamoracle)
2034 (variable-item gnus-group-ham-exit-processor-copy)
2035 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2036 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2037 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2038 (const :tag "Spam: ifile" (spam spam-use-ifile))
2039 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2040 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2041 (const :tag "Ham: ifile" (ham spam-use-ifile))
2042 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2043 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2044 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
2045 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2046 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2047 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
2049 "Which spam or ham processors will be applied when the summary is exited."
2050 :variable gnus-spam-process-newsgroups
2051 :variable-default nil
2053 "*Groups in which to automatically process spam or ham articles with
2054 a backend on summary exit. If non-nil, this should be a list of group
2055 name regexps that should match all groups in which to do automatic
2056 spam processing, associated with the appropriate processor."
2057 :variable-group spam
2059 '(repeat :tag "Spam/Ham Processors"
2060 (list :tag "Spam Summary Exit Processor Choices"
2061 (regexp :tag "Group Regexp")
2063 :tag "Spam/Ham Summary Exit Processor"
2064 (variable-item gnus-group-spam-exit-processor-ifile)
2065 (variable-item gnus-group-spam-exit-processor-stat)
2066 (variable-item gnus-group-spam-exit-processor-bogofilter)
2067 (variable-item gnus-group-spam-exit-processor-blacklist)
2068 (variable-item gnus-group-spam-exit-processor-spamoracle)
2069 (variable-item gnus-group-spam-exit-processor-report-gmane)
2070 (variable-item gnus-group-ham-exit-processor-bogofilter)
2071 (variable-item gnus-group-ham-exit-processor-ifile)
2072 (variable-item gnus-group-ham-exit-processor-stat)
2073 (variable-item gnus-group-ham-exit-processor-whitelist)
2074 (variable-item gnus-group-ham-exit-processor-BBDB)
2075 (variable-item gnus-group-ham-exit-processor-spamoracle)
2076 (variable-item gnus-group-ham-exit-processor-copy)
2077 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2078 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2079 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2080 (const :tag "Spam: ifile" (spam spam-use-ifile))
2081 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2082 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2083 (const :tag "Ham: ifile" (ham spam-use-ifile))
2084 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2085 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2086 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
2087 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2088 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2089 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
2092 "Which spam or ham processors will be applied when the summary is exited.")
2094 (gnus-define-group-parameter
2098 '(boolean :tag "Spam autodetection")
2100 "Should spam be autodetected (with spam-split) in this group?"
2101 :variable gnus-spam-autodetect
2102 :variable-default nil
2104 "*Groups in which spam should be autodetected when they are entered.
2105 Only unseen articles will be examined, unless
2106 spam-autodetect-recheck-messages is set."
2107 :variable-group spam
2110 :tag "Autodetection setting"
2112 (regexp :tag "Group Regexp")
2115 "Spam autodetection.
2116 Only unseen articles will be examined, unless
2117 spam-autodetect-recheck-messages is set.")
2119 (gnus-define-group-parameter
2120 spam-autodetect-methods
2123 '(choice :tag "Spam autodetection-specific methods"
2126 (set :tag "Use specific methods"
2127 (variable-item spam-use-blacklist)
2128 (variable-item spam-use-regex-headers)
2129 (variable-item spam-use-regex-body)
2130 (variable-item spam-use-whitelist)
2131 (variable-item spam-use-BBDB)
2132 (variable-item spam-use-ifile)
2133 (variable-item spam-use-spamoracle)
2134 (variable-item spam-use-stat)
2135 (variable-item spam-use-blackholes)
2136 (variable-item spam-use-hashcash)
2137 (variable-item spam-use-bogofilter-headers)
2138 (variable-item spam-use-bogofilter)))
2140 "Methods to be used for autodetection in each group"
2141 :variable gnus-spam-autodetect-methods
2142 :variable-default nil
2144 "*Methods for autodetecting spam per group.
2145 Requires the spam-autodetect parameter. Only unseen articles
2146 will be examined, unless spam-autodetect-recheck-messages is
2148 :variable-group spam
2151 :tag "Autodetection methods"
2153 (regexp :tag "Group Regexp")
2157 (set :tag "Use specific methods"
2158 (variable-item spam-use-blacklist)
2159 (variable-item spam-use-regex-headers)
2160 (variable-item spam-use-regex-body)
2161 (variable-item spam-use-whitelist)
2162 (variable-item spam-use-BBDB)
2163 (variable-item spam-use-ifile)
2164 (variable-item spam-use-spamoracle)
2165 (variable-item spam-use-stat)
2166 (variable-item spam-use-blackholes)
2167 (variable-item spam-use-hashcash)
2168 (variable-item spam-use-bogofilter-headers)
2169 (variable-item spam-use-bogofilter)))))
2171 "Spam autodetection methods.
2172 Requires the spam-autodetect parameter. Only unseen articles
2173 will be examined, unless spam-autodetect-recheck-messages is
2176 (gnus-define-group-parameter
2177 spam-process-destination
2180 '(choice :tag "Destination for spam-processed articles at summary exit"
2181 (string :tag "Move to a group")
2182 (repeat :tag "Move to multiple groups"
2183 (string :tag "Destination group"))
2184 (const :tag "Expire" nil))
2186 "Where spam-processed articles will go at summary exit."
2187 :variable gnus-spam-process-destinations
2188 :variable-default nil
2190 "*Groups in which to explicitly send spam-processed articles to
2191 another group, or expire them (the default). If non-nil, this should
2192 be a list of group name regexps that should match all groups in which
2193 to do spam-processed article moving, associated with the destination
2194 group or nil for explicit expiration. This only makes sense for
2196 :variable-group spam
2199 :tag "Spam-processed articles destination"
2201 (regexp :tag "Group Regexp")
2203 :tag "Destination for spam-processed articles at summary exit"
2204 (string :tag "Move to a group")
2205 (repeat :tag "Move to multiple groups"
2206 (string :tag "Destination group"))
2207 (const :tag "Expire" nil))))
2209 "Where spam-processed articles will go at summary exit.")
2211 (gnus-define-group-parameter
2212 ham-process-destination
2216 :tag "Destination for ham articles at summary exit from a spam group"
2217 (string :tag "Move to a group")
2218 (repeat :tag "Move to multiple groups"
2219 (string :tag "Destination group"))
2220 (const :tag "Respool" respool)
2221 (const :tag "Do nothing" nil))
2223 "Where ham articles will go at summary exit from a spam group."
2224 :variable gnus-ham-process-destinations
2225 :variable-default nil
2227 "*Groups in which to explicitly send ham articles to
2228 another group, or do nothing (the default). If non-nil, this should
2229 be a list of group name regexps that should match all groups in which
2230 to do ham article moving, associated with the destination
2231 group or nil for explicit ignoring. This only makes sense for
2232 mail groups, and only works in spam groups."
2233 :variable-group spam
2236 :tag "Ham articles destination"
2238 (regexp :tag "Group Regexp")
2240 :tag "Destination for ham articles at summary exit from spam group"
2241 (string :tag "Move to a group")
2242 (repeat :tag "Move to multiple groups"
2243 (string :tag "Destination group"))
2244 (const :tag "Respool" respool)
2245 (const :tag "Expire" nil))))
2247 "Where ham articles will go at summary exit from a spam group.")
2249 (gnus-define-group-parameter
2252 :parameter-type '(list :tag "Ham mark choices"
2254 (variable-item gnus-del-mark)
2255 (variable-item gnus-read-mark)
2256 (variable-item gnus-ticked-mark)
2257 (variable-item gnus-killed-mark)
2258 (variable-item gnus-kill-file-mark)
2259 (variable-item gnus-low-score-mark)))
2262 "Marks considered ham (positively not spam). Such articles will be
2263 processed as ham (non-spam) on group exit. When nil, the global
2264 spam-ham-marks variable takes precedence."
2265 :variable-default '((".*" ((gnus-del-mark
2269 gnus-low-score-mark))))
2270 :variable-group spam
2272 "*Groups in which to explicitly set the ham marks to some value.")
2274 (gnus-define-group-parameter
2277 :parameter-type '(list :tag "Spam mark choices"
2279 (variable-item gnus-spam-mark)
2280 (variable-item gnus-killed-mark)
2281 (variable-item gnus-kill-file-mark)
2282 (variable-item gnus-low-score-mark)))
2285 "Marks considered spam.
2286 Such articles will be processed as spam on group exit. When nil, the global
2287 spam-spam-marks variable takes precedence."
2288 :variable-default '((".*" ((gnus-spam-mark))))
2289 :variable-group spam
2291 "*Groups in which to explicitly set the spam marks to some value."))
2293 (defcustom gnus-group-uncollapsed-levels 1
2294 "Number of group name elements to leave alone when making a short group name."
2295 :group 'gnus-group-visual
2298 (defcustom gnus-group-use-permanent-levels nil
2299 "*If non-nil, once you set a level, Gnus will use this level."
2300 :group 'gnus-group-levels
2305 (defcustom gnus-load-hook nil
2306 "A hook run while Gnus is loaded."
2310 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2311 "A hook called to apply kill files to a group.
2312 This hook is intended to apply a kill file to the selected newsgroup.
2313 The function `gnus-apply-kill-file' is called by default.
2315 Since a general kill file is too heavy to use only for a few
2316 newsgroups, I recommend you to use a lighter hook function. For
2317 example, if you'd like to apply a kill file to articles which contains
2318 a string `rmgroup' in subject in newsgroup `control', you can use the
2321 (setq gnus-apply-kill-hook
2324 (cond ((string-match \"control\" gnus-newsgroup-name)
2325 (gnus-kill \"Subject\" \"rmgroup\")
2326 (gnus-expunge \"X\"))))))"
2327 :group 'gnus-score-kill
2328 :options '(gnus-apply-kill-file)
2331 (defcustom gnus-group-change-level-function nil
2332 "Function run when a group level is changed.
2333 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2334 :group 'gnus-group-levels
2339 (defcustom gnus-visual
2340 '(summary-highlight group-highlight article-highlight
2342 summary-menu group-menu article-menu
2343 tree-highlight menu highlight
2344 browse-menu server-menu
2345 page-marker tree-menu binary-menu pick-menu
2347 "*Enable visual features.
2348 If `visual' is disabled, there will be no menus and few faces. Most of
2349 the visual customization options below will be ignored. Gnus will use
2350 less space and be faster as a result.
2352 This variable can also be a list of visual elements to switch on. For
2353 instance, to switch off all visual things except menus, you can say:
2355 (setq gnus-visual '(menu))
2357 Valid elements include `summary-highlight', `group-highlight',
2358 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2359 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2360 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2361 and `grouplens-menu'."
2364 :type '(set (const summary-highlight)
2365 (const group-highlight)
2366 (const article-highlight)
2368 (const summary-menu)
2370 (const article-menu)
2371 (const tree-highlight)
2380 (const grouplens-menu)))
2382 ;; Byte-compiler warning.
2383 (defvar gnus-visual)
2384 ;; Find out whether the gnus-visual TYPE is wanted.
2385 (defun gnus-visual-p (&optional type class)
2386 (and gnus-visual ; Has to be non-nil, at least.
2387 (if (not type) ; We don't care about type.
2389 (if (listp gnus-visual) ; It's a list, so we check it.
2390 (or (memq type gnus-visual)
2391 (memq class gnus-visual))
2394 (defcustom gnus-mouse-face
2396 (if (gnus-visual-p 'mouse-face 'highlight)
2397 (if (boundp 'gnus-mouse-face)
2398 (or gnus-mouse-face 'highlight)
2402 "*Face used for group or summary buffer mouse highlighting.
2403 The line beneath the mouse pointer will be highlighted with this
2408 (defcustom gnus-article-save-directory gnus-directory
2409 "*Name of the directory articles will be saved in (default \"~/News\")."
2410 :group 'gnus-article-saving
2413 (defvar gnus-plugged t
2414 "Whether Gnus is plugged or not.")
2416 (defcustom gnus-agent-cache t
2417 "Controls use of the agent cache while plugged.
2418 When set, Gnus will prefer using the locally stored content rather
2419 than re-fetching it from the server. You also need to enable
2420 `gnus-agent' for this to have any affect."
2425 (defcustom gnus-default-charset 'undecided
2426 "Default charset assumed to be used when viewing non-ASCII characters.
2427 This variable is overridden on a group-to-group basis by the
2428 `gnus-group-charset-alist' variable and is only used on groups not
2429 covered by that variable."
2431 :group 'gnus-charset)
2433 ;; Fixme: Doc reference to agent.
2434 (defcustom gnus-agent t
2435 "Whether we want to use the Gnus agent or not.
2437 You may customize gnus-agent to disable its use. However, some
2438 back ends have started to use the agent as a client-side cache.
2439 Disabling the agent may result in noticeable loss of performance."
2444 (defcustom gnus-other-frame-function 'gnus
2445 "Function called by the command `gnus-other-frame'."
2447 :type '(choice (function-item gnus)
2448 (function-item gnus-no-server)
2449 (function-item gnus-slave)
2450 (function-item gnus-slave-no-server)))
2452 (defcustom gnus-other-frame-parameters nil
2453 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2454 This should be an alist for Emacs, or a plist for XEmacs."
2456 :type (if (featurep 'xemacs)
2457 '(repeat (list :inline t :format "%v"
2458 (symbol :tag "Property")
2459 (sexp :tag "Value")))
2460 '(repeat (cons :format "%v"
2461 (symbol :tag "Parameter")
2462 (sexp :tag "Value")))))
2464 (defcustom gnus-user-agent 'emacs-gnus-type
2465 "Which information should be exposed in the User-Agent header.
2467 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2468 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2469 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2470 `emacs-gnus' plus system type\) or a custom string. If you set it to a
2471 string, be sure to use a valid format, see RFC 2616."
2473 :group 'gnus-message
2475 (item :tag "Show Gnus and Emacs versions and system type"
2477 (item :tag "Show Gnus and Emacs versions and system configuration"
2479 (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2480 (item :tag "Show only Gnus version" gnus)
2481 (string :tag "Other")))
2484 ;;; Internal variables
2486 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2487 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2488 (defvar gnus-agent-method-p-cache nil
2489 ; Reset each time gnus-agent-covered-methods is changed else
2490 ; gnus-agent-method-p may mis-report a methods status.
2492 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2493 (defvar gnus-draft-meta-information-header "X-Draft-From")
2494 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2495 (defvar gnus-original-article-buffer " *Original Article*")
2496 (defvar gnus-newsgroup-name nil)
2497 (defvar gnus-ephemeral-servers nil)
2498 (defvar gnus-server-method-cache nil)
2500 (defvar gnus-agent-fetching nil
2501 "Whether Gnus agent is in fetching mode.")
2503 (defvar gnus-agent-covered-methods nil
2504 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2506 (defvar gnus-command-method nil
2507 "Dynamically bound variable that says what the current back end is.")
2509 (defvar gnus-current-select-method nil
2510 "The current method for selecting a newsgroup.")
2512 (defvar gnus-tree-buffer "*Tree*"
2513 "Buffer where Gnus thread trees are displayed.")
2516 (defvar gnus-use-generic-from nil)
2518 ;; Variable holding the user answers to all method prompts.
2519 (defvar gnus-method-history nil)
2521 ;; Variable holding the user answers to all mail method prompts.
2522 (defvar gnus-mail-method-history nil)
2524 ;; Variable holding the user answers to all group prompts.
2525 (defvar gnus-group-history nil)
2527 (defvar gnus-server-alist nil
2528 "List of available servers.")
2530 (defcustom gnus-cache-directory
2531 (nnheader-concat gnus-directory "cache/")
2532 "*The directory where cached articles will be stored."
2536 (defvar gnus-predefined-server-alist
2539 (nnspool-spool-directory ,gnus-cache-directory)
2540 (nnspool-nov-directory ,gnus-cache-directory)
2541 (nnspool-active-file
2542 ,(nnheader-concat gnus-cache-directory "active"))))
2543 "List of predefined (convenience) servers.")
2545 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2547 (defconst gnus-article-mark-lists
2548 '((marked . tick) (replied . reply)
2549 (expirable . expire) (killed . killed)
2550 (bookmarks . bookmark) (dormant . dormant)
2551 (scored . score) (saved . save)
2552 (cached . cache) (downloadable . download)
2553 (unsendable . unsend) (forwarded . forward)
2554 (recent . recent) (seen . seen)))
2556 (defconst gnus-article-special-mark-lists
2562 ;; Propagate flags to server, with the following exceptions:
2563 ;; `seen' is private to each gnus installation
2564 ;; `cache' is a internal gnus flag for each gnus installation
2565 ;; `download' is a agent flag private to each gnus installation
2566 ;; `unsend' are for nndraft groups only
2567 ;; `score' is not a proper mark
2568 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2569 (defconst gnus-article-unpropagated-mark-lists
2570 '(seen cache download unsend score bookmark)
2571 "Marks that shouldn't be propagated to back ends.
2572 Typical marks are those that make no sense in a standalone back end,
2573 such as a mark that says whether an article is stored in the cache
2574 \(which doesn't make sense in a standalone back end).")
2576 (defvar gnus-headers-retrieved-by nil)
2577 (defvar gnus-article-reply nil)
2578 (defvar gnus-override-method nil)
2579 (defvar gnus-article-check-size nil)
2580 (defvar gnus-opened-servers nil)
2582 (defvar gnus-current-kill-article nil)
2584 (defvar gnus-have-read-active-file nil)
2586 (defconst gnus-maintainer
2587 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2588 "The mail address of the Gnus maintainers.")
2590 (defvar gnus-info-nodes
2591 '((gnus-group-mode "(gnus)Group Buffer")
2592 (gnus-summary-mode "(gnus)Summary Buffer")
2593 (gnus-article-mode "(gnus)Article Buffer")
2594 (gnus-server-mode "(gnus)Server Buffer")
2595 (gnus-browse-mode "(gnus)Browse Foreign Server")
2596 (gnus-tree-mode "(gnus)Tree Display"))
2597 "Alist of major modes and related Info nodes.")
2599 (defvar gnus-group-buffer "*Group*")
2600 (defvar gnus-summary-buffer "*Summary*")
2601 (defvar gnus-article-buffer "*Article*")
2602 (defvar gnus-server-buffer "*Server*")
2604 (defvar gnus-slave nil
2605 "Whether this Gnus is a slave or not.")
2607 (defvar gnus-batch-mode nil
2608 "Whether this Gnus is running in batch mode or not.")
2610 (defvar gnus-variable-list
2611 '(gnus-newsrc-options gnus-newsrc-options-n
2612 gnus-newsrc-last-checked-date
2613 gnus-newsrc-alist gnus-server-alist
2614 gnus-killed-list gnus-zombie-list
2615 gnus-topic-topology gnus-topic-alist
2617 "Gnus variables saved in the quick startup file.")
2619 (defvar gnus-newsrc-alist nil
2620 "Assoc list of read articles.
2621 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2623 (defvar gnus-registry-alist nil
2624 "Assoc list of registry data.
2625 gnus-registry.el will populate this if it's loaded.")
2627 (defvar gnus-newsrc-hashtb nil
2628 "Hashtable of `gnus-newsrc-alist'.")
2630 (defvar gnus-killed-list nil
2631 "List of killed newsgroups.")
2633 (defvar gnus-killed-hashtb nil
2634 "Hash table equivalent of `gnus-killed-list'.")
2636 (defvar gnus-zombie-list nil
2637 "List of almost dead newsgroups.")
2639 (defvar gnus-description-hashtb nil
2640 "Descriptions of newsgroups.")
2642 (defvar gnus-list-of-killed-groups nil
2643 "List of newsgroups that have recently been killed by the user.")
2645 (defvar gnus-active-hashtb nil
2646 "Hashtable of active articles.")
2648 (defvar gnus-moderated-hashtb nil
2649 "Hashtable of moderated newsgroups.")
2651 ;; Save window configuration.
2652 (defvar gnus-prev-winconf nil)
2654 (defvar gnus-reffed-article-number nil)
2656 ;;; Let the byte-compiler know that we know about this variable.
2657 (defvar rmail-default-rmail-file)
2659 (defvar gnus-dead-summary nil)
2661 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2662 "Regexp matching invalid groups.")
2664 (defvar gnus-other-frame-object nil
2665 "A frame object which will be created by `gnus-other-frame'.")
2667 ;;; End of variables.
2669 ;; Define some autoload functions Gnus might use.
2672 ;; This little mapcar goes through the list below and marks the
2673 ;; symbols in question as autoloaded functions.
2676 (let ((interactive (nth 1 (memq ':interactive package))))
2680 (when (consp function)
2681 (setq keymap (car (memq 'keymap function)))
2682 (setq function (car function)))
2683 (unless (fboundp function)
2684 (autoload function (car package) nil interactive keymap))))
2685 (if (eq (nth 1 package) ':interactive)
2688 '(("info" :interactive t Info-goto-node)
2690 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2691 ("ps-print" ps-print-preprint)
2692 ("message" :interactive t
2693 message-send-and-exit message-yank-original)
2694 ("babel" babel-as-string)
2695 ("nnmail" nnmail-split-fancy nnmail-article-group)
2696 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2697 ("rmailout" rmail-output rmail-output-to-rmail-file)
2698 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2699 rmail-show-message rmail-summary-exists
2700 rmail-select-summary rmail-update-summary)
2701 ("gnus-audio" :interactive t gnus-audio-play)
2702 ("gnus-xmas" gnus-xmas-splash)
2703 ("gnus-soup" :interactive t
2704 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2705 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2706 ("nnsoup" nnsoup-pack-replies)
2707 ("score-mode" :interactive t gnus-score-mode)
2708 ("gnus-mh" gnus-summary-save-article-folder
2709 gnus-Folder-save-name gnus-folder-save-name)
2710 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2711 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2712 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2713 gnus-demon-add-disconnection gnus-demon-add-handler
2714 gnus-demon-remove-handler)
2715 ("gnus-demon" :interactive t
2716 gnus-demon-init gnus-demon-cancel)
2717 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2718 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2719 gnus-face-from-file)
2720 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2721 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2722 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2723 gnus-nocem-unwanted-article-p)
2724 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2725 gnus-server-server-name)
2726 ("gnus-srvr" gnus-browse-foreign-server)
2727 ("gnus-cite" :interactive t
2728 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2729 gnus-article-hide-citation gnus-article-fill-cited-article
2730 gnus-article-hide-citation-in-followups)
2731 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2732 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2733 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2734 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2735 gnus-cache-possibly-remove-articles gnus-cache-request-article
2736 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2737 gnus-cache-enter-remove-article gnus-cached-article-p
2738 gnus-cache-open gnus-cache-close gnus-cache-update-article
2739 gnus-cache-articles-in-group)
2740 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2741 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2742 ("gnus-score" :interactive t
2743 gnus-summary-increase-score gnus-summary-set-score
2744 gnus-summary-raise-thread gnus-summary-raise-same-subject
2745 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2746 gnus-summary-lower-thread gnus-summary-lower-same-subject
2747 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2748 gnus-summary-current-score gnus-score-delta-default
2749 gnus-score-flush-cache gnus-score-close
2750 gnus-possibly-score-headers gnus-score-followup-article
2751 gnus-score-followup-thread)
2753 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2754 gnus-current-score-file-nondirectory gnus-score-adaptive
2755 gnus-score-find-trace gnus-score-file-name)
2756 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2757 ("gnus-topic" :interactive t gnus-topic-mode)
2758 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2759 gnus-subscribe-topics)
2760 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2761 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2762 ("gnus-uu" :interactive t
2763 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2764 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2765 gnus-uu-mark-by-regexp gnus-uu-mark-all
2766 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2767 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2768 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2769 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2770 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2771 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2772 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2773 gnus-uu-mark-over gnus-uu-post-news)
2774 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2775 ("gnus-msg" (gnus-summary-send-map keymap)
2776 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2777 ("gnus-msg" :interactive t
2778 gnus-group-post-news gnus-group-mail gnus-group-news
2779 gnus-summary-post-news gnus-summary-news-other-window
2780 gnus-summary-followup gnus-summary-followup-with-original
2781 gnus-summary-cancel-article gnus-summary-supersede-article
2782 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2783 gnus-summary-mail-forward gnus-summary-mail-other-window
2784 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2785 gnus-summary-wide-reply gnus-summary-followup-to-mail
2786 gnus-summary-followup-to-mail-with-original gnus-bug
2787 gnus-summary-wide-reply-with-original
2788 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2789 gnus-summary-post-forward)
2790 ("gnus-picon" :interactive t gnus-treat-from-picon)
2791 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2792 gnus-grouplens-mode)
2793 ("smiley" :interactive t smiley-region)
2794 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2795 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2796 gnus-list-of-unread-articles gnus-list-of-read-articles
2797 gnus-offer-save-summaries gnus-make-thread-indent-array
2798 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2799 gnus-summary-skip-intangible gnus-summary-article-number
2800 gnus-data-header gnus-data-find)
2801 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2802 gnus-group-list-groups gnus-group-first-unread-group
2803 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2804 gnus-group-setup-buffer gnus-group-get-new-news
2805 gnus-group-make-help-group gnus-group-update-group
2806 gnus-group-iterate gnus-group-group-name)
2807 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2808 gnus-backlog-remove-article)
2809 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2810 gnus-article-prepare gnus-article-set-window-start
2811 gnus-article-next-page gnus-article-prev-page
2812 gnus-request-article-this-buffer gnus-article-mode
2813 gnus-article-setup-buffer gnus-narrow-to-page
2814 gnus-article-delete-invisible-text gnus-treat-article)
2815 ("gnus-art" :interactive t
2816 gnus-article-hide-headers gnus-article-hide-boring-headers
2817 gnus-article-treat-overstrike
2818 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2819 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2820 gnus-article-de-base64-unreadable
2821 gnus-article-decode-HZ
2822 gnus-article-wash-html
2823 gnus-article-unsplit-urls
2824 gnus-article-hide-pem gnus-article-hide-signature
2825 gnus-article-strip-leading-blank-lines gnus-article-date-local
2826 gnus-article-date-original gnus-article-date-lapsed
2827 ;; gnus-article-show-all-headers
2828 gnus-article-edit-mode gnus-article-edit-article
2829 gnus-article-edit-done gnus-article-decode-encoded-words
2830 gnus-start-date-timer gnus-stop-date-timer
2831 gnus-mime-view-all-parts)
2832 ("gnus-int" gnus-request-type)
2833 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2834 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2835 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2836 gnus-dup-enter-articles)
2837 ("gnus-range" gnus-copy-sequence)
2838 ("gnus-eform" gnus-edit-form)
2839 ("gnus-move" :interactive t
2840 gnus-group-move-group-to-server gnus-change-server)
2841 ("gnus-logic" gnus-score-advanced)
2842 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2843 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2844 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2845 gnus-async-halt-prefetch)
2846 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2847 gnus-agent-save-active gnus-agent-method-p
2848 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2849 gnus-summary-set-agent-mark gnus-agent-save-group-info
2850 gnus-agent-request-article gnus-agent-retrieve-headers)
2851 ("gnus-agent" :interactive t
2852 gnus-unplugged gnus-agentize gnus-agent-batch)
2853 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2854 gnus-summary-save-article-vm)
2855 ("compface" uncompface)
2856 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2857 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2858 ("gnus-mlspl" :interactive t gnus-group-split-setup
2859 gnus-group-split-update)
2860 ("gnus-delay" gnus-delay-initialize))))
2862 ;;; gnus-sum.el thingies
2865 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2866 "*The format specification of the lines in the summary buffer.
2868 It works along the same lines as a normal formatting string,
2869 with some simple extensions.
2871 %N Article number, left padded with spaces (string)
2873 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2874 %n Name of the poster (string)
2875 %a Extracted name of the poster (string)
2876 %A Extracted address of the poster (string)
2877 %F Contents of the From: header (string)
2878 %f Contents of the From: or To: headers (string)
2879 %x Contents of the Xref: header (string)
2880 %D Date of the article (string)
2881 %d Date of the article (string) in DD-MMM format
2882 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2883 %M Message-id of the article (string)
2884 %r References of the article (string)
2885 %c Number of characters in the article (integer)
2886 %k Pretty-printed version of the above (string)
2887 For example, \"1.2k\" or \"0.4M\".
2888 %L Number of lines in the article (integer)
2889 %I Indentation based on thread level (a string of spaces)
2890 %B A complex trn-style thread tree (string)
2891 The variables `gnus-sum-thread-*' can be used for customization.
2892 %T A string with two possible values: 80 spaces if the article
2893 is on thread level two or larger and 0 spaces on level one
2894 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2895 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2896 %[ Opening bracket (character, \"[\" or \"<\")
2897 %] Closing bracket (character, \"]\" or \">\")
2898 %> Spaces of length thread-level (string)
2899 %< Spaces of length (- 20 thread-level) (string)
2900 %i Article score (number)
2901 %z Article zcore (character)
2902 %t Number of articles under the current thread (number).
2903 %e Whether the thread is empty or not (character).
2904 %l GroupLens score (string).
2905 %V Total thread score (number).
2906 %P The line number (number).
2907 %O Download mark (character).
2908 %* If present, indicates desired cursor position
2909 (instead of after first colon).
2910 %u User defined specifier. The next character in the format string should
2911 be a letter. Gnus will call the function gnus-user-format-function-X,
2912 where X is the letter following %u. The function will be passed the
2913 current header as argument. The function should return a string, which
2914 will be inserted into the summary just like information from any other
2917 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2918 with care. For reasons of efficiency, Gnus will compute what column
2919 these characters will end up in, and \"hard-code\" that. This means that
2920 it is invalid to have these specs after a variable-length spec. Well,
2921 you might not be arrested, but your summary buffer will look strange,
2922 which is bad enough.
2924 The smart choice is to have these specs as far to the left as
2927 This restriction may disappear in later versions of Gnus.
2929 General format specifiers can also be used.
2930 See Info node `(gnus)Formatting Variables'."
2931 :link '(custom-manual "(gnus)Formatting Variables")
2933 :group 'gnus-summary-format)
2936 ;;; Skeleton keymaps
2939 (defun gnus-suppress-keymap (keymap)
2940 (suppress-keymap keymap)
2941 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2943 (define-key keymap (pop keys) 'undefined))))
2945 (defvar gnus-article-mode-map
2946 (let ((keymap (make-sparse-keymap)))
2947 (gnus-suppress-keymap keymap)
2949 (defvar gnus-summary-mode-map
2950 (let ((keymap (make-keymap)))
2951 (gnus-suppress-keymap keymap)
2953 (defvar gnus-group-mode-map
2954 (let ((keymap (make-keymap)))
2955 (gnus-suppress-keymap keymap)
2960 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2961 ;; If you want the cursor to go somewhere else, set these two
2962 ;; functions in some startup hook to whatever you want.
2963 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2964 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2966 ;;; Various macros and substs.
2968 (defun gnus-header-from (header)
2969 (mail-header-from header))
2971 (defmacro gnus-gethash (string hashtable)
2972 "Get hash value of STRING in HASHTABLE."
2973 `(symbol-value (intern-soft ,string ,hashtable)))
2975 (defmacro gnus-gethash-safe (string hashtable)
2976 "Get hash value of STRING in HASHTABLE.
2977 Return nil if not defined."
2978 `(let ((sym (intern-soft ,string ,hashtable)))
2979 (and (boundp sym) (symbol-value sym))))
2981 (defmacro gnus-sethash (string value hashtable)
2982 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2983 `(set (intern ,string ,hashtable) ,value))
2984 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2986 (defmacro gnus-group-unread (group)
2987 "Get the currently computed number of unread articles in GROUP."
2988 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2990 (defmacro gnus-group-entry (group)
2991 "Get the newsrc entry for GROUP."
2992 `(gnus-gethash ,group gnus-newsrc-hashtb))
2994 (defmacro gnus-active (group)
2995 "Get active info on GROUP."
2996 `(gnus-gethash ,group gnus-active-hashtb))
2998 (defmacro gnus-set-active (group active)
2999 "Set GROUP's active info."
3000 `(gnus-sethash ,group ,active gnus-active-hashtb))
3002 ;; Info access macros.
3004 (defmacro gnus-info-group (info)
3006 (defmacro gnus-info-rank (info)
3008 (defmacro gnus-info-read (info)
3010 (defmacro gnus-info-marks (info)
3012 (defmacro gnus-info-method (info)
3014 (defmacro gnus-info-params (info)
3017 (defmacro gnus-info-level (info)
3018 `(let ((rank (gnus-info-rank ,info)))
3022 (defmacro gnus-info-score (info)
3023 `(let ((rank (gnus-info-rank ,info)))
3024 (or (and (consp rank) (cdr rank)) 0)))
3026 (defmacro gnus-info-set-group (info group)
3027 `(setcar ,info ,group))
3028 (defmacro gnus-info-set-rank (info rank)
3029 `(setcar (nthcdr 1 ,info) ,rank))
3030 (defmacro gnus-info-set-read (info read)
3031 `(setcar (nthcdr 2 ,info) ,read))
3032 (defmacro gnus-info-set-marks (info marks &optional extend)
3034 `(gnus-info-set-entry ,info ,marks 3)
3035 `(setcar (nthcdr 3 ,info) ,marks)))
3036 (defmacro gnus-info-set-method (info method &optional extend)
3038 `(gnus-info-set-entry ,info ,method 4)
3039 `(setcar (nthcdr 4 ,info) ,method)))
3040 (defmacro gnus-info-set-params (info params &optional extend)
3042 `(gnus-info-set-entry ,info ,params 5)
3043 `(setcar (nthcdr 5 ,info) ,params)))
3045 (defun gnus-info-set-entry (info entry number)
3046 ;; Extend the info until we have enough elements.
3047 (while (<= (length info) number)
3048 (nconc info (list nil)))
3050 (setcar (nthcdr number info) entry))
3052 (defmacro gnus-info-set-level (info level)
3053 `(let ((rank (cdr ,info)))
3054 (if (consp (car rank))
3055 (setcar (car rank) ,level)
3056 (setcar rank ,level))))
3057 (defmacro gnus-info-set-score (info score)
3058 `(let ((rank (cdr ,info)))
3059 (if (consp (car rank))
3060 (setcdr (car rank) ,score)
3061 (setcar rank (cons (car rank) ,score)))))
3063 (defmacro gnus-get-info (group)
3064 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3066 ;;; Load the compatibility functions.
3075 (defvar gnus-shutdown-alist nil)
3077 (defun gnus-add-shutdown (function &rest symbols)
3078 "Run FUNCTION whenever one of SYMBOLS is shut down."
3079 (push (cons function symbols) gnus-shutdown-alist))
3081 (defun gnus-shutdown (symbol)
3082 "Shut down everything that waits for SYMBOL."
3083 (let ((alist gnus-shutdown-alist)
3085 (while (setq entry (pop alist))
3086 (when (memq symbol (cdr entry))
3087 (funcall (car entry))))))
3091 ;;; Gnus Utility Functions
3094 (defun gnus-find-subscribed-addresses ()
3095 "Return a regexp matching the addresses of all subscribed mail groups.
3096 It consists of the `to-address' or `to-list' parameter of all groups
3097 with a `subscribed' parameter."
3098 (let (group address addresses)
3099 (dolist (entry (cdr gnus-newsrc-alist))
3100 (setq group (car entry))
3101 (when (gnus-parameter-subscribed group)
3102 (setq address (mail-strip-quoted-names
3103 (or (gnus-group-fast-parameter group 'to-address)
3104 (gnus-group-fast-parameter group 'to-list))))
3106 (add-to-list 'addresses address))))
3108 (list (mapconcat 'regexp-quote addresses "\\|")))))
3110 (defmacro gnus-string-or (&rest strings)
3111 "Return the first element of STRINGS that is a non-blank string.
3112 STRINGS will be evaluated in normal `or' order."
3113 `(gnus-string-or-1 ',strings))
3115 (defun gnus-string-or-1 (strings)
3118 (setq string (eval (pop strings)))
3119 (if (string-match "^[ \t]*$" string)
3121 (setq strings nil)))
3124 (defun gnus-version (&optional arg)
3125 "Version number of this version of Gnus.
3126 If ARG, insert string at point."
3129 (insert (message gnus-version))
3130 (message gnus-version)))
3132 (defun gnus-continuum-version (&optional version)
3133 "Return VERSION as a floating point number."
3136 (setq version gnus-version))
3137 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3138 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3139 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3140 (number (match-string 2 version))
3142 (unless (string-match
3143 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3144 (error "Invalid version string: %s" version))
3145 (setq major (string-to-number (match-string 1 number))
3146 minor (string-to-number (match-string 2 number))
3147 least (if (match-beginning 3)
3148 (string-to-number (match-string 3 number))
3152 (format "%s00%02d%02d"
3153 (if (member alpha '("(ding)" "d"))
3157 (- (mm-char-int (aref (downcase alpha) 0))
3161 (format "%d.%02d%02d" major minor least))))))
3163 (defun gnus-info-find-node (&optional nodename)
3164 "Find Info documentation of Gnus."
3166 ;; Enlarge info window if needed.
3167 (let (gnus-info-buffer)
3168 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3169 (setq gnus-info-buffer (current-buffer))
3170 (gnus-configure-windows 'info)))
3173 ;;; gnus-interactive
3176 (defvar gnus-current-prefix-symbol nil
3177 "Current prefix symbol.")
3179 (defvar gnus-current-prefix-symbols nil
3180 "List of current prefix symbols.")
3182 (defun gnus-interactive (string &optional params)
3183 "Return a list that can be fed to `interactive'.
3184 See `interactive' for full documentation.
3186 Adds the following specs:
3188 y -- The current symbolic prefix.
3189 Y -- A list of the current symbolic prefix(es).
3190 A -- Article number.
3191 H -- Article header.
3195 (while (< i (length string))
3196 (string-match ".\\([^\n]*\\)\n?" string i)
3197 (setq c (aref string i))
3199 (setq prompt (match-string 1 string)))
3200 (setq i (match-end 0))
3201 ;; We basically emulate just about everything that
3202 ;; `interactive' does, but add the specs listed above.
3206 (completing-read prompt obarray 'fboundp t))
3208 (read-buffer prompt (current-buffer) t))
3210 (read-buffer prompt (other-buffer (current-buffer))))
3214 (completing-read prompt obarray 'commandp t))
3218 (read-file-name prompt nil default-directory 'lambda))
3220 (read-file-name prompt nil nil 'lambda))
3222 (read-file-name prompt))
3224 (read-key-sequence prompt))
3226 (error "Not implemented spec"))
3228 (error "Not implemented spec"))
3232 (error "Not implemented spec"))
3234 (string-to-number (read-from-minibuffer prompt)))
3236 (prefix-numeric-value current-prefix-arg))
3242 (read-string prompt))
3244 (intern (read-string prompt)))
3246 (read-variable prompt))
3248 (read-minibuffer prompt))
3250 (eval-minibuffer prompt))
3251 ;; And here the new specs come.
3253 gnus-current-prefix-symbol)
3255 gnus-current-prefix-symbols)
3257 (gnus-group-group-name))
3259 (gnus-summary-skip-intangible)
3260 (or (get-text-property (point) 'gnus-number)
3261 (gnus-summary-last-subject)))
3263 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3265 (error "Non-implemented spec")))
3269 (push (if (< (point) (mark)) (point) (mark)) out)
3270 (push (if (> (point) (mark)) (point) (mark)) out))))
3271 (setq out (delq 'gnus-prefix-nil out))
3274 (defun gnus-symbolic-argument (&optional arg)
3275 "Read a symbolic argument and a command, and then execute command."
3277 (let* ((in-command (this-command-keys))
3278 (command in-command)
3279 gnus-current-prefix-symbols
3280 gnus-current-prefix-symbol
3282 (while (equal in-command command)
3283 (message "%s-" (key-description (this-command-keys)))
3284 (push (intern (char-to-string (read-char))) syms)
3285 (setq command (read-key-sequence nil t)))
3286 (setq gnus-current-prefix-symbols (nreverse syms)
3287 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3288 (call-interactively (key-binding command t))))
3290 ;;; More various functions.
3292 (defsubst gnus-check-backend-function (func group)
3293 "Check whether GROUP supports function FUNC.
3294 GROUP can either be a string (a group name) or a select method."
3296 (let ((method (if (stringp group)
3297 (car (gnus-find-method-for-group group))
3299 (unless (featurep method)
3301 (fboundp (intern (format "%s-%s" method func))))))
3303 (defun gnus-group-read-only-p (&optional group)
3304 "Check whether GROUP supports editing or not.
3305 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3306 that that variable is buffer-local to the summary buffers."
3307 (let ((group (or group gnus-newsgroup-name)))
3308 (not (gnus-check-backend-function 'request-replace-article group))))
3310 (defun gnus-virtual-group-p (group)
3311 "Say whether GROUP is virtual or not."
3312 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3313 gnus-valid-select-methods)))
3315 (defun gnus-news-group-p (group &optional article)
3316 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3317 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3318 t) ;is news of course.
3319 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3320 nil) ;must be mail then.
3321 ((vectorp article) ;Has header info.
3322 (eq (gnus-request-type group (mail-header-id article)) 'news))
3323 ((null article) ;Hasn't header info
3324 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3325 ((< article 0) ;Virtual message
3326 nil) ;we don't know, guess mail.
3327 (t ;Has positive number
3328 (eq (gnus-request-type group article) 'news)))) ;use it.
3330 ;; Returns a list of writable groups.
3331 (defun gnus-writable-groups ()
3332 (let ((alist gnus-newsrc-alist)
3334 (while (setq group (car (pop alist)))
3335 (unless (gnus-group-read-only-p group)
3336 (push group groups)))
3339 ;; Check whether to use long file names.
3340 (defun gnus-use-long-file-name (symbol)
3341 ;; The variable has to be set...
3342 (and gnus-use-long-file-name
3343 ;; If it isn't a list, then we return t.
3344 (or (not (listp gnus-use-long-file-name))
3345 ;; If it is a list, and the list contains `symbol', we
3347 (not (memq symbol gnus-use-long-file-name)))))
3349 ;; Generate a unique new group name.
3350 (defun gnus-generate-new-group-name (leaf)
3353 (while (gnus-gethash name gnus-newsrc-hashtb)
3354 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3357 (defun gnus-ephemeral-group-p (group)
3358 "Say whether GROUP is ephemeral or not."
3359 (gnus-group-get-parameter group 'quit-config t))
3361 (defun gnus-group-quit-config (group)
3362 "Return the quit-config of GROUP."
3363 (gnus-group-get-parameter group 'quit-config t))
3365 (defun gnus-kill-ephemeral-group (group)
3366 "Remove ephemeral GROUP from relevant structures."
3367 (gnus-sethash group nil gnus-newsrc-hashtb))
3369 (defun gnus-simplify-mode-line ()
3370 "Make mode lines a bit simpler."
3371 (setq mode-line-modified (cdr gnus-mode-line-modified))
3372 (when (listp mode-line-format)
3373 (make-local-variable 'mode-line-format)
3374 (setq mode-line-format (copy-sequence mode-line-format))
3375 (when (equal (nth 3 mode-line-format) " ")
3376 (setcar (nthcdr 3 mode-line-format) " "))))
3378 ;;; Servers and groups.
3380 (defsubst gnus-server-add-address (method)
3381 (let ((method-name (symbol-name (car method))))
3382 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3383 (not (assq (intern (concat method-name "-address")) method))
3384 (memq 'physical-address (assq (car method)
3385 gnus-valid-select-methods)))
3386 (append method (list (list (intern (concat method-name "-address"))
3390 (defsubst gnus-method-to-server (method)
3392 (setq method (or method gnus-select-method))
3394 ;; Perhaps it is already in the cache.
3395 (mapc (lambda (name-method)
3396 (if (equal (cdr name-method) method)
3397 (throw 'server-name (car name-method))))
3398 gnus-server-method-cache)
3401 (lambda (server-alist)
3402 (mapc (lambda (name-method)
3403 (when (gnus-methods-equal-p (cdr name-method) method)
3404 (unless (member name-method gnus-server-method-cache)
3405 (push name-method gnus-server-method-cache))
3406 (throw 'server-name (car name-method))))
3408 (let ((alists (list gnus-server-alist
3409 gnus-predefined-server-alist)))
3410 (if gnus-select-method
3411 (push (list (cons "native" gnus-select-method)) alists))
3414 (let* ((name (if (member (cadr method) '(nil ""))
3415 (format "%s" (car method))
3416 (format "%s:%s" (car method) (cadr method))))
3417 (name-method (cons name method)))
3418 (unless (member name-method gnus-server-method-cache)
3419 (push name-method gnus-server-method-cache))
3422 (defsubst gnus-server-to-method (server)
3423 "Map virtual server names to select methods."
3424 (or (and server (listp server) server)
3425 (cdr (assoc server gnus-server-method-cache))
3428 ;; Perhaps this is the native server?
3429 (and (equal server "native") gnus-select-method)
3430 ;; It should be in the server alist.
3431 (cdr (assoc server gnus-server-alist))
3432 ;; It could be in the predefined server alist.
3433 (cdr (assoc server gnus-predefined-server-alist))
3434 ;; If not, we look through all the opened server
3435 ;; to see whether we can find it there.
3436 (let ((opened gnus-opened-servers))
3438 (not (equal server (format "%s:%s" (caaar opened)
3442 ;; It could be a named method, search all servers
3443 (let ((servers gnus-secondary-select-methods))
3445 (not (equal server (format "%s:%s" (caar servers)
3449 ;; This could be some sort of foreign server that I
3450 ;; simply haven't opened (yet). Do a brute-force scan
3451 ;; of the entire gnus-newsrc-alist for the server name
3452 ;; of every method. As a side-effect, loads the
3453 ;; gnus-server-method-cache so this only happens once,
3458 (let ((info-method (gnus-info-method info)))
3459 (unless (stringp info-method)
3460 (let ((info-server (gnus-method-to-server info-method)))
3461 (when (equal server info-server)
3462 (setq match info-method))))))
3463 (cdr gnus-newsrc-alist))
3466 (push (cons server result) gnus-server-method-cache))
3469 (defsubst gnus-server-get-method (group method)
3470 ;; Input either a server name, and extended server name, or a
3471 ;; select method, and return a select method.
3472 (cond ((stringp method)
3473 (gnus-server-to-method method))
3474 ((equal method gnus-select-method)
3476 ((and (stringp (car method))
3478 (gnus-server-extend-method group method))
3481 (equal (cadr method) ""))
3484 (gnus-server-add-address method))))
3486 (defmacro gnus-method-equal (ss1 ss2)
3487 "Say whether two servers are equal."
3491 (and (= (length s1) (length s2))
3493 (while (and s1 (member (car s1) s2))
3497 (defun gnus-methods-equal-p (m1 m2)
3498 (let ((m1 (or m1 gnus-select-method))
3499 (m2 (or m2 gnus-select-method)))
3501 (and (eq (car m1) (car m2))
3502 (or (not (memq 'address (assoc (symbol-name (car m1))
3503 gnus-valid-select-methods)))
3504 (equal (nth 1 m1) (nth 1 m2)))))))
3506 (defun gnus-server-equal (m1 m2)
3507 "Say whether two methods are equal."
3508 (let ((m1 (cond ((null m1) gnus-select-method)
3509 ((stringp m1) (gnus-server-to-method m1))
3511 (m2 (cond ((null m2) gnus-select-method)
3512 ((stringp m2) (gnus-server-to-method m2))
3514 (gnus-method-equal m1 m2)))
3516 (defun gnus-servers-using-backend (backend)
3517 "Return a list of known servers using BACKEND."
3518 (let ((opened gnus-opened-servers)
3521 (when (eq backend (caaar opened))
3522 (push (caar opened) out))
3526 (defun gnus-archive-server-wanted-p ()
3527 "Say whether the user wants to use the archive server."
3529 ((or (not gnus-message-archive-method)
3530 (not gnus-message-archive-group))
3532 ((and gnus-message-archive-method gnus-message-archive-group)
3535 (let ((active (cadr (assq 'nnfolder-active-file
3536 gnus-message-archive-method))))
3538 (file-exists-p active))))))
3540 (defsubst gnus-method-to-server-name (method)
3542 (format "%s" (car method))
3544 (or (assoc (format "%s" (car method))
3545 (gnus-methods-using 'address))
3546 (gnus-server-equal method gnus-message-archive-method))
3548 (not (string= (nth 1 method) "")))
3549 (concat "+" (nth 1 method)))))
3551 (defsubst gnus-method-to-full-server-name (method)
3552 (format "%s+%s" (car method) (nth 1 method)))
3554 (defun gnus-group-prefixed-name (group method &optional full)
3555 "Return the whole name from GROUP and METHOD.
3556 Call with full set to get the fully qualified group name (even if the
3558 (when (stringp method)
3559 (setq method (gnus-server-to-method method)))
3560 (if (or (not method)
3561 (and (not full) (gnus-server-equal method "native"))
3562 ;;;!!! This might not be right. We'll see...
3563 ;(string-match ":" group)
3566 (concat (gnus-method-to-server-name method) ":" group)))
3568 (defun gnus-group-guess-prefixed-name (group)
3569 "Guess the whole name from GROUP and METHOD."
3570 (gnus-group-prefixed-name group (gnus-find-method-for-group
3573 (defun gnus-group-full-name (group method)
3574 "Return the full name from GROUP and METHOD, even if the method is native."
3575 (gnus-group-prefixed-name group method t))
3577 (defun gnus-group-guess-full-name (group)
3578 "Guess the full name from GROUP, even if the method is native."
3579 (if (gnus-group-prefixed-p group)
3581 (gnus-group-full-name group (gnus-find-method-for-group group))))
3583 (defun gnus-group-guess-full-name-from-command-method (group)
3584 "Guess the full name from GROUP, even if the method is native."
3585 (if (gnus-group-prefixed-p group)
3587 (gnus-group-full-name group gnus-command-method)))
3589 (defun gnus-group-real-prefix (group)
3590 "Return the prefix of the current group name."
3592 (if (string-match "^[^:]+:" group)
3593 (substring group 0 (match-end 0))
3597 (defun gnus-group-short-name (group)
3598 "Return the short group name."
3599 (let ((prefix (gnus-group-real-prefix group)))
3600 (if (< 0 (length prefix))
3601 (substring group (length prefix) nil)
3604 (defun gnus-group-prefixed-p (group)
3605 "Return the prefix of the current group name."
3606 (< 0 (length (gnus-group-real-prefix group))))
3608 (defun gnus-summary-buffer-name (group)
3609 "Return the summary buffer name of GROUP."
3610 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3612 (defun gnus-group-method (group)
3613 "Return the server or method used for selecting GROUP.
3614 You should probably use `gnus-find-method-for-group' instead."
3615 (let ((prefix (gnus-group-real-prefix group)))
3616 (if (equal prefix "")
3618 (let ((servers gnus-opened-servers)
3620 backend possible found)
3621 (if (string-match "^[^\\+]+\\+" prefix)
3622 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3623 server (substring prefix (match-end 0) (1- (length prefix))))
3624 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3626 (when (eq (caaar servers) backend)
3627 (setq possible (caar servers))
3628 (when (equal (cadaar servers) server)
3629 (setq found (caar servers))))
3631 (or (car (rassoc found gnus-server-alist))
3633 (car (rassoc possible gnus-server-alist))
3635 (list backend server))))))
3637 (defsubst gnus-native-method-p (method)
3638 "Return whether METHOD is the native select method."
3639 (gnus-method-equal method gnus-select-method))
3641 (defsubst gnus-secondary-method-p (method)
3642 "Return whether METHOD is a secondary select method."
3643 (let ((methods gnus-secondary-select-methods)
3644 (gmethod (inline (gnus-server-get-method nil method))))
3646 (not (gnus-method-equal
3647 (inline (gnus-server-get-method nil (car methods)))
3649 (setq methods (cdr methods)))
3652 (defun gnus-method-simplify (method)
3653 "Return the shortest uniquely identifying string or method for METHOD."
3654 (cond ((stringp method)
3656 ((gnus-native-method-p method)
3658 ((gnus-secondary-method-p method)
3659 (format "%s:%s" (nth 0 method) (nth 1 method)))
3663 (defun gnus-groups-from-server (server)
3664 "Return a list of all groups that are fetched from SERVER."
3665 (let ((alist (cdr gnus-newsrc-alist))
3667 (while (setq info (pop alist))
3668 (when (gnus-server-equal (gnus-info-method info) server)
3669 (push (gnus-info-group info) groups)))
3670 (sort groups 'string<)))
3672 (defun gnus-group-foreign-p (group)
3673 "Say whether a group is foreign or not."
3674 (and (not (gnus-group-native-p group))
3675 (not (gnus-group-secondary-p group))))
3677 (defun gnus-group-native-p (group)
3678 "Say whether the group is native or not."
3679 (not (string-match ":" group)))
3681 (defun gnus-group-secondary-p (group)
3682 "Say whether the group is secondary or not."
3683 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3685 (defun gnus-parameters-get-parameter (group)
3686 "Return the group parameters for GROUP from `gnus-parameters'."
3688 (dolist (elem gnus-parameters)
3689 (when (string-match (car elem) group)
3691 (nconc (gnus-expand-group-parameters
3692 (car elem) (cdr elem) group)
3696 (defun gnus-expand-group-parameter (match value group)
3697 "Use MATCH to expand VALUE in GROUP."
3700 (goto-char (point-min))
3701 (while (re-search-forward match nil t)
3702 (replace-match value))
3705 (defun gnus-expand-group-parameters (match parameters group)
3706 "Go through PARAMETERS and expand them according to the match data."
3708 (dolist (elem parameters)
3709 (if (and (stringp (cdr elem))
3710 (string-match "\\\\[0-9&]" (cdr elem)))
3711 (push (cons (car elem)
3712 (gnus-expand-group-parameter match (cdr elem) group))
3717 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3718 "For GROUP, return the value of SYMBOL.
3720 You should call this in the `gnus-group-buffer' buffer.
3721 The function `gnus-group-find-parameter' will do that for you."
3722 ;; The speed trick: No cons'ing and quit early.
3723 (let* ((params (funcall gnus-group-get-parameter-function group))
3724 ;; Start easy, check the "real" group parameters.
3726 (gnus-group-parameter-value params symbol allow-list t)))
3728 ;; Found results; return them.
3729 (car simple-results)
3730 ;; We didn't found it there, try `gnus-parameters'.
3733 (tail gnus-parameters))
3734 ;; A good old-fashioned non-cl loop.
3736 (setq head (car tail)
3738 ;; The car is regexp matching for matching the group name.
3739 (when (string-match (car head) group)
3740 ;; The cdr is the parameters.
3741 (setq result (gnus-group-parameter-value (cdr head)
3744 ;; Expand if necessary.
3745 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3746 (setq result (gnus-expand-group-parameter (car head)
3748 ;; Exit the loop early.
3753 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3754 "Return the group parameters for GROUP.
3755 If SYMBOL, return the value of that symbol in the group parameters.
3757 If you call this function inside a loop, consider using the faster
3758 `gnus-group-fast-parameter' instead."
3760 (set-buffer gnus-group-buffer)
3762 (gnus-group-fast-parameter group symbol allow-list)
3765 (funcall gnus-group-get-parameter-function group))
3766 (gnus-parameters-get-parameter group)))))
3768 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3769 "Return the group parameters for GROUP.
3770 If SYMBOL, return the value of that symbol in the group parameters.
3771 Most functions should use `gnus-group-find-parameter', which
3772 also examines the topic parameters."
3773 (let ((params (gnus-info-params (gnus-get-info group))))
3775 (gnus-group-parameter-value params symbol allow-list)
3778 (defun gnus-group-parameter-value (params symbol &optional
3779 allow-list present-p)
3780 "Return the value of SYMBOL in group PARAMS."
3781 ;; We only wish to return group parameters (dotted lists) and
3782 ;; not local variables, which may have the same names.
3783 ;; But first we handle single elements...
3784 (or (car (memq symbol params))
3788 (while (setq elem (pop params))
3789 (when (and (consp elem)
3790 (eq (car elem) symbol)
3793 (throw 'found (if present-p (list (cdr elem))
3796 (defun gnus-group-add-parameter (group param)
3797 "Add parameter PARAM to GROUP."
3798 (let ((info (gnus-get-info group)))
3800 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3801 ;; Cons the new param to the old one and update.
3802 (gnus-group-set-info (cons param (gnus-info-params info))
3805 (defun gnus-group-set-parameter (group name value)
3806 "Set parameter NAME to VALUE in GROUP."
3807 (let ((info (gnus-get-info group)))
3809 (gnus-group-remove-parameter group name)
3810 (let ((old-params (gnus-info-params info))
3811 (new-params (list (cons name value))))
3813 (when (or (not (listp (car old-params)))
3814 (not (eq (caar old-params) name)))
3815 (setq new-params (append new-params (list (car old-params)))))
3816 (setq old-params (cdr old-params)))
3817 (gnus-group-set-info new-params group 'params)))))
3819 (defun gnus-group-remove-parameter (group name)
3820 "Remove parameter NAME from GROUP."
3821 (let ((info (gnus-get-info group)))
3823 (let ((params (gnus-info-params info)))
3825 (setq params (delq name params))
3826 (while (assq name params)
3827 (gnus-pull name params))
3828 (gnus-info-set-params info params))))))
3830 (defun gnus-group-add-score (group &optional score)
3831 "Add SCORE to the GROUP score.
3832 If SCORE is nil, add 1 to the score of GROUP."
3833 (let ((info (gnus-get-info group)))
3835 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3837 (defun gnus-short-group-name (group &optional levels)
3838 "Collapse GROUP name LEVELS.
3839 Select methods are stripped and any remote host name is stripped down to
3840 just the host name."
3846 gnus-group-uncollapsed-levels
3848 (while (string-match "\\." group skip)
3849 (setq skip (match-end 0)
3852 ;; Separate foreign select method from group name and collapse.
3853 ;; If method contains a server, collapse to non-domain server name,
3854 ;; otherwise collapse to select method.
3855 (let* ((colon (string-match ":" group))
3856 (server (and colon (substring group 0 colon)))
3857 (plus (and server (string-match "+" server))))
3860 (setq foreign (substring server (+ 1 plus)
3861 (string-match "\\." server))
3862 group (substring group (+ 1 colon)))
3863 (setq foreign server
3864 group (substring group (+ 1 colon))))
3865 (setq foreign (concat foreign ":")))
3866 ;; Collapse group name leaving LEVELS uncollapsed elements
3867 (let* ((slist (split-string group "/"))
3868 (slen (length slist))
3869 (dlist (split-string group "\\."))
3870 (dlen (length dlist))
3882 (setq levels (- glen levels))
3884 (push (if (>= (decf levels) 0)
3885 (if (zerop (length g))
3890 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3892 (defun gnus-narrow-to-body ()
3893 "Narrow to the body of an article."
3896 (goto-char (point-min))
3897 (or (search-forward "\n\n" nil t)
3903 ;;; Kill file handling.
3906 (defun gnus-apply-kill-file ()
3907 "Apply a kill file to the current newsgroup.
3908 Returns the number of articles marked as read."
3909 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3910 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3911 (gnus-apply-kill-file-internal)
3914 (defun gnus-kill-save-kill-buffer ()
3915 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3916 (when (get-file-buffer file)
3918 (set-buffer (get-file-buffer file))
3919 (when (buffer-modified-p)
3921 (kill-buffer (current-buffer))))))
3923 (defcustom gnus-kill-file-name "KILL"
3924 "Suffix of the kill files."
3925 :group 'gnus-score-kill
3926 :group 'gnus-score-files
3929 (defun gnus-newsgroup-kill-file (newsgroup)
3930 "Return the name of a kill file name for NEWSGROUP.
3931 If NEWSGROUP is nil, return the global kill file name instead."
3933 ;; The global KILL file is placed at top of the directory.
3934 ((or (null newsgroup)
3935 (string-equal newsgroup ""))
3936 (expand-file-name gnus-kill-file-name
3937 gnus-kill-files-directory))
3938 ;; Append ".KILL" to newsgroup name.
3939 ((gnus-use-long-file-name 'not-kill)
3940 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3941 "." gnus-kill-file-name)
3942 gnus-kill-files-directory))
3943 ;; Place "KILL" under the hierarchical directory.
3945 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3946 "/" gnus-kill-file-name)
3947 gnus-kill-files-directory))))
3951 (defun gnus-member-of-valid (symbol group)
3952 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3954 (symbol-name (car (gnus-find-method-for-group group)))
3955 gnus-valid-select-methods)))
3957 (defun gnus-method-option-p (method option)
3958 "Return non-nil if select METHOD has OPTION as a parameter."
3959 (when (stringp method)
3960 (setq method (gnus-server-to-method method)))
3961 (memq option (assoc (format "%s" (car method))
3962 gnus-valid-select-methods)))
3964 (defun gnus-similar-server-opened (method)
3965 (let ((opened gnus-opened-servers))
3966 (while (and method opened)
3967 (when (and (equal (cadr method) (cadaar opened))
3968 (equal (car method) (caaar opened))
3969 (not (equal method (caar opened))))
3974 (defun gnus-server-extend-method (group method)
3975 ;; This function "extends" a virtual server. If the server is
3976 ;; "hello", and the select method is ("hello" (my-var "something"))
3977 ;; in the group "alt.alt", this will result in a new virtual server
3978 ;; called "hello+alt.alt".
3979 (if (or (not (inline (gnus-similar-server-opened method)))
3980 (not (cddr method)))
3982 `(,(car method) ,(concat (cadr method) "+" group)
3983 (,(intern (format "%s-address" (car method))) ,(cadr method))
3986 (defun gnus-server-status (method)
3987 "Return the status of METHOD."
3988 (nth 1 (assoc method gnus-opened-servers)))
3990 (defun gnus-group-name-to-method (group)
3991 "Guess a select method based on GROUP."
3992 (if (string-match ":" group)
3993 (let ((server (substring group 0 (match-beginning 0))))
3994 (if (string-match "\\+" server)
3995 (list (intern (substring server 0 (match-beginning 0)))
3996 (substring server (match-end 0)))
3997 (list (intern server) "")))
3998 gnus-select-method))
4000 (defun gnus-server-string (server)
4001 "Return a readable string that describes SERVER."
4002 (let* ((server (gnus-server-to-method server))
4003 (address (nth 1 server)))
4005 (not (zerop (length address))))
4006 (format "%s using %s" address (car server))
4007 (format "%s" (car server)))))
4009 (defun gnus-find-method-for-group (group &optional info)
4010 "Find the select method that GROUP uses."
4011 (or gnus-override-method
4014 (and (not (gnus-group-entry group)) ;; a new group
4015 (gnus-group-name-to-method group))
4016 (let ((info (or info (gnus-get-info group)))
4019 (not (setq method (gnus-info-method info)))
4020 (equal method "native"))
4023 (cond ((stringp method)
4024 (inline (gnus-server-to-method method)))
4025 ((stringp (cadr method))
4026 (inline (gnus-server-extend-method group method)))
4029 (cond ((equal (cadr method) "")
4031 ((null (cadr method))
4032 (list (car method) ""))
4034 (gnus-server-add-address method)))))))
4036 (defun gnus-methods-using (feature)
4037 "Find all methods that have FEATURE."
4038 (let ((valids gnus-valid-select-methods)
4041 (when (memq feature (car valids))
4042 (push (car valids) outs))
4043 (setq valids (cdr valids)))
4047 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4049 (defun gnus-read-group (prompt &optional default)
4050 "Prompt the user for a group name.
4051 Disallow invalid group names."
4056 gnus-invalid-group-regexp
4057 (setq group (read-string (concat prefix prompt)
4058 (cons (or default "") 0)
4059 'gnus-group-history)))
4060 (let ((match (match-string 0 group)))
4061 ;; Might be okay (e.g. for nnimap), so ask the user:
4062 (unless (and (not (string-match "^$\\|:" match))
4064 "Proceed and create group anyway? " t
4065 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4067 Usually, it's dangerous to create a group with this name, because it's not
4068 supported by all back ends and servers. On IMAP servers it should work,
4069 though. If you are really sure, you can proceed anyway and create the group.
4071 You may customize the variable `gnus-invalid-group-regexp', which currently is
4072 set to \"" gnus-invalid-group-regexp
4073 "\", if you want to get rid of this query permanently."))
4074 (setq prefix (format "Invalid group name: \"%s\". " group)
4078 (defun gnus-read-method (prompt)
4079 "Prompt the user for a method.
4080 Allow completion over sensible values."
4081 (let* ((open-servers
4082 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4083 gnus-opened-servers))
4086 (dolist (method gnus-valid-select-methods)
4087 (if (or (memq 'prompt-address method)
4088 (not (assoc (format "%s:" (car method)) open-servers)))
4089 (push method methods)))
4092 (append valid-methods
4094 gnus-predefined-server-alist
4099 nil t nil 'gnus-method-history)))
4102 (setq method gnus-select-method))
4103 ((assoc method gnus-valid-select-methods)
4104 (let ((address (if (memq 'prompt-address
4105 (assoc method gnus-valid-select-methods))
4106 (read-string "Address: ")
4108 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4109 (list (intern method) address))))
4110 ((assoc method servers)
4113 (list (intern method) "")))))
4117 (defun gnus-agent-method-p (method)
4118 "Say whether METHOD is covered by the agent."
4119 (or (eq (car gnus-agent-method-p-cache) method)
4120 (setq gnus-agent-method-p-cache
4122 (member (if (stringp method)
4124 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4125 (cdr gnus-agent-method-p-cache))
4127 (defun gnus-online (method)
4130 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4131 (gnus-agent-method-p method))))
4133 ;;; User-level commands.
4136 (defun gnus-slave-no-server (&optional arg)
4137 "Read network news as a slave, without connecting to the local server."
4139 (gnus-no-server arg t))
4142 (defun gnus-no-server (&optional arg slave)
4144 If ARG is a positive number, Gnus will use that as the startup
4145 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4146 non-nil and not a positive number, Gnus will prompt the user for the
4147 name of an NNTP server to use.
4148 As opposed to `gnus', this command will not connect to the local
4151 (gnus-no-server-1 arg slave))
4154 (defun gnus-slave (&optional arg)
4155 "Read news as a slave."
4157 (gnus arg nil 'slave))
4160 (defun gnus-other-frame (&optional arg display)
4161 "Pop up a frame to read news.
4162 This will call one of the Gnus commands which is specified by the user
4163 option `gnus-other-frame-function' (default `gnus') with the argument
4164 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4165 optional second argument DISPLAY should be a standard display string
4166 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4167 omitted or the function `make-frame-on-display' is not available, the
4168 current display is used."
4170 (if (fboundp 'make-frame-on-display)
4172 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4174 (let ((alive (gnus-alive-p)))
4179 (when (and (or (not display)
4181 (gnus-frame-or-window-display-name
4183 (with-current-buffer (window-buffer window)
4184 (string-match "\\`gnus-"
4185 (symbol-name major-mode))))
4186 (gnus-select-frame-set-input-focus
4187 (setq gnus-other-frame-object (window-frame window)))
4188 (select-window window)
4191 (gnus-select-frame-set-input-focus
4192 (setq gnus-other-frame-object
4194 (make-frame-on-display display gnus-other-frame-parameters)
4195 (make-frame gnus-other-frame-parameters))))
4197 (switch-to-buffer gnus-group-buffer)
4198 (funcall gnus-other-frame-function arg)
4199 (add-hook 'gnus-exit-gnus-hook
4201 (when (and (frame-live-p gnus-other-frame-object)
4203 (delete-frame gnus-other-frame-object))
4204 (setq gnus-other-frame-object nil)))))))
4206 ;;(setq thing ? ; this is a comment
4210 (defun gnus (&optional arg dont-connect slave)
4212 If ARG is non-nil and a positive number, Gnus will use that as the
4213 startup level. If ARG is non-nil and not a positive number, Gnus will
4214 prompt the user for the name of an NNTP server to use."
4216 (unless (byte-code-function-p (symbol-function 'gnus))
4217 (message "You should byte-compile Gnus")
4219 (gnus-1 arg dont-connect slave))
4221 ;; Allow redefinition of Gnus functions.
4227 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4228 ;;; gnus.el ends here