1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 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., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
31 (eval '(run-hooks 'gnus-load-hook))
33 (eval-when-compile (require 'cl))
38 ;; These are defined afterwards with gnus-define-group-parameter
39 (defvar gnus-ham-process-destinations)
40 (defvar gnus-parameter-ham-marks-alist)
41 (defvar gnus-parameter-spam-marks-alist)
42 (defvar gnus-spam-autodetect)
43 (defvar gnus-spam-autodetect-methods)
44 (defvar gnus-spam-newsgroup-contents)
45 (defvar gnus-spam-process-destinations)
46 (defvar gnus-spam-process-newsgroups)
50 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
54 (defgroup gnus-format nil
55 "Dealing with formatting issues."
58 (defgroup gnus-charset nil
59 "Group character set issues."
60 :link '(custom-manual "(gnus)Charsets")
64 (defgroup gnus-cache nil
66 :link '(custom-manual "(gnus)Article Caching")
69 (defgroup gnus-registry nil
73 (defgroup gnus-start nil
74 "Starting your favorite newsreader."
77 (defgroup gnus-start-server nil
78 "Server options at startup."
81 ;; These belong to gnus-group.el.
82 (defgroup gnus-group nil
84 :link '(custom-manual "(gnus)Group Buffer")
87 (defgroup gnus-group-foreign nil
89 :link '(custom-manual "(gnus)Foreign Groups")
92 (defgroup gnus-group-new nil
93 "Automatic subscription of new groups."
96 (defgroup gnus-group-levels nil
98 :link '(custom-manual "(gnus)Group Levels")
101 (defgroup gnus-group-select nil
103 :link '(custom-manual "(gnus)Selecting a Group")
106 (defgroup gnus-group-listing nil
107 "Showing slices of the group list."
108 :link '(custom-manual "(gnus)Listing Groups")
111 (defgroup gnus-group-visual nil
112 "Sorting the group buffer."
113 :link '(custom-manual "(gnus)Group Buffer Format")
117 (defgroup gnus-group-various nil
118 "Various group options."
119 :link '(custom-manual "(gnus)Scanning New Messages")
122 ;; These belong to gnus-sum.el.
123 (defgroup gnus-summary nil
125 :link '(custom-manual "(gnus)Summary Buffer")
128 (defgroup gnus-summary-exit nil
129 "Leaving summary buffers."
130 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
131 :group 'gnus-summary)
133 (defgroup gnus-summary-marks nil
134 "Marks used in summary buffers."
135 :link '(custom-manual "(gnus)Marking Articles")
136 :group 'gnus-summary)
138 (defgroup gnus-thread nil
139 "Ordering articles according to replies."
140 :link '(custom-manual "(gnus)Threading")
141 :group 'gnus-summary)
143 (defgroup gnus-summary-format nil
144 "Formatting of the summary buffer."
145 :link '(custom-manual "(gnus)Summary Buffer Format")
146 :group 'gnus-summary)
148 (defgroup gnus-summary-choose nil
150 :link '(custom-manual "(gnus)Choosing Articles")
151 :group 'gnus-summary)
153 (defgroup gnus-summary-maneuvering nil
154 "Summary movement commands."
155 :link '(custom-manual "(gnus)Summary Maneuvering")
156 :group 'gnus-summary)
158 (defgroup gnus-picon nil
159 "Show pictures of people, domains, and newsgroups."
162 (defgroup gnus-summary-mail nil
163 "Mail group commands."
164 :link '(custom-manual "(gnus)Mail Group Commands")
165 :group 'gnus-summary)
167 (defgroup gnus-summary-sort nil
168 "Sorting the summary buffer."
169 :link '(custom-manual "(gnus)Sorting the Summary Buffer")
170 :group 'gnus-summary)
172 (defgroup gnus-summary-visual nil
173 "Highlighting and menus in the summary buffer."
174 :link '(custom-manual "(gnus)Summary Highlighting")
176 :group 'gnus-summary)
178 (defgroup gnus-summary-various nil
179 "Various summary buffer options."
180 :link '(custom-manual "(gnus)Various Summary Stuff")
181 :group 'gnus-summary)
183 (defgroup gnus-summary-pick nil
184 "Pick mode in the summary buffer."
185 :link '(custom-manual "(gnus)Pick and Read")
187 :group 'gnus-summary)
189 (defgroup gnus-summary-tree nil
190 "Tree display of threads in the summary buffer."
191 :link '(custom-manual "(gnus)Tree Display")
193 :group 'gnus-summary)
195 ;; Belongs to gnus-uu.el
196 (defgroup gnus-extract-view nil
197 "Viewing extracted files."
198 :link '(custom-manual "(gnus)Viewing Files")
199 :group 'gnus-extract)
201 ;; Belongs to gnus-score.el
202 (defgroup gnus-score nil
203 "Score and kill file handling."
206 (defgroup gnus-score-kill nil
210 (defgroup gnus-score-adapt nil
211 "Adaptive score files."
214 (defgroup gnus-score-default nil
215 "Default values for score files."
218 (defgroup gnus-score-expire nil
219 "Expiring score rules."
222 (defgroup gnus-score-decay nil
223 "Decaying score rules."
226 (defgroup gnus-score-files nil
227 "Score and kill file names."
231 (defgroup gnus-score-various nil
232 "Various scoring and killing options."
236 (defgroup gnus-visual nil
237 "Options controlling the visual fluff."
241 (defgroup gnus-agent nil
242 "Offline support for Gnus."
245 (defgroup gnus-files nil
246 "Files used by Gnus."
249 (defgroup gnus-dribble-file nil
251 :link '(custom-manual "(gnus)Auto Save")
254 (defgroup gnus-newsrc nil
255 "Storing Gnus state."
258 (defgroup gnus-server nil
259 "Options related to newsservers and other servers used by Gnus."
262 (defgroup gnus-server-visual nil
263 "Highlighting and menus in the server buffer."
267 (defgroup gnus-message '((message custom-group))
268 "Composing replies and followups in Gnus."
271 (defgroup gnus-meta nil
272 "Meta variables controlling major portions of Gnus.
273 In general, modifying these variables does not take affect until Gnus
274 is restarted, and sometimes reloaded."
277 (defgroup gnus-various nil
278 "Other Gnus options."
279 :link '(custom-manual "(gnus)Various Various")
282 (defgroup gnus-mime nil
283 "Variables for controlling the Gnus MIME interface."
286 (defgroup gnus-exit nil
288 :link '(custom-manual "(gnus)Exiting Gnus")
291 (defgroup gnus-fun nil
292 "Frivolous Gnus extensions."
293 :link '(custom-manual "(gnus)Exiting Gnus")
296 (defconst gnus-version-number "5.11"
297 "Version number for this version of Gnus.")
299 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
300 "Version string for this version of Gnus.")
302 (defcustom gnus-inhibit-startup-message nil
303 "If non-nil, the startup message will not be displayed.
304 This variable is used before `.gnus.el' is loaded, so it should
305 be set in `.emacs' instead."
309 (defcustom gnus-play-startup-jingle nil
310 "If non-nil, play the Gnus jingle at startup."
314 (unless (fboundp 'gnus-group-remove-excess-properties)
315 (defalias 'gnus-group-remove-excess-properties 'ignore))
317 (unless (fboundp 'gnus-set-text-properties)
318 (defalias 'gnus-set-text-properties 'set-text-properties))
320 (unless (featurep 'gnus-xmas)
321 (defalias 'gnus-make-overlay 'make-overlay)
322 (defalias 'gnus-delete-overlay 'delete-overlay)
323 (defalias 'gnus-overlay-put 'overlay-put)
324 (defalias 'gnus-move-overlay 'move-overlay)
325 (defalias 'gnus-overlay-buffer 'overlay-buffer)
326 (defalias 'gnus-overlay-start 'overlay-start)
327 (defalias 'gnus-overlay-end 'overlay-end)
328 (defalias 'gnus-extent-detached-p 'ignore)
329 (defalias 'gnus-extent-start-open 'ignore)
330 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
331 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
332 (defalias 'gnus-character-to-event 'identity)
333 (defalias 'gnus-assq-delete-all 'assq-delete-all)
334 (defalias 'gnus-add-text-properties 'add-text-properties)
335 (defalias 'gnus-put-text-property 'put-text-property)
336 (defvar gnus-mode-line-image-cache t)
337 (if (fboundp 'find-image)
338 (defun gnus-mode-line-buffer-identification (line)
339 (let ((str (car-safe line))
340 (load-path (mm-image-load-path)))
341 (if (and (stringp str)
342 (string-match "^Gnus:" str))
343 (progn (add-text-properties
346 (if (eq t gnus-mode-line-image-cache)
347 (setq gnus-mode-line-image-cache
349 '((:type xpm :file "gnus-pointer.xpm"
351 (:type xbm :file "gnus-pointer.xbm"
353 gnus-mode-line-image-cache)
356 gnus-version (gnus-emacs-version)))
360 (defalias 'gnus-mode-line-buffer-identification 'identity))
361 (defalias 'gnus-characterp 'numberp)
362 (defalias 'gnus-deactivate-mark 'deactivate-mark)
363 (defalias 'gnus-window-edges 'window-edges)
364 (defalias 'gnus-key-press-event-p 'numberp)
365 ;;(defalias 'gnus-decode-rfc1522 'ignore)
368 ;; We define these group faces here to avoid the display
369 ;; update forced when creating new faces.
371 (defface gnus-group-news-1
374 (:foreground "PaleTurquoise" :bold t))
377 (:foreground "ForestGreen" :bold t))
380 "Level 1 newsgroup face."
382 ;; backward-compatibility alias
383 (put 'gnus-group-news-1-face 'face-alias 'gnus-group-news-1)
385 (defface gnus-group-news-1-empty
388 (:foreground "PaleTurquoise"))
391 (:foreground "ForestGreen"))
394 "Level 1 empty newsgroup face."
396 ;; backward-compatibility alias
397 (put 'gnus-group-news-1-empty-face 'face-alias 'gnus-group-news-1-empty)
399 (defface gnus-group-news-2
402 (:foreground "turquoise" :bold t))
405 (:foreground "CadetBlue4" :bold t))
408 "Level 2 newsgroup face."
410 ;; backward-compatibility alias
411 (put 'gnus-group-news-2-face 'face-alias 'gnus-group-news-2)
413 (defface gnus-group-news-2-empty
416 (:foreground "turquoise"))
419 (:foreground "CadetBlue4"))
422 "Level 2 empty newsgroup face."
424 ;; backward-compatibility alias
425 (put 'gnus-group-news-2-empty-face 'face-alias 'gnus-group-news-2-empty)
427 (defface gnus-group-news-3
436 "Level 3 newsgroup face."
438 ;; backward-compatibility alias
439 (put 'gnus-group-news-3-face 'face-alias 'gnus-group-news-3)
441 (defface gnus-group-news-3-empty
450 "Level 3 empty newsgroup face."
452 ;; backward-compatibility alias
453 (put 'gnus-group-news-3-empty-face 'face-alias 'gnus-group-news-3-empty)
455 (defface gnus-group-news-4
464 "Level 4 newsgroup face."
466 ;; backward-compatibility alias
467 (put 'gnus-group-news-4-face 'face-alias 'gnus-group-news-4)
469 (defface gnus-group-news-4-empty
478 "Level 4 empty newsgroup face."
480 ;; backward-compatibility alias
481 (put 'gnus-group-news-4-empty-face 'face-alias 'gnus-group-news-4-empty)
483 (defface gnus-group-news-5
492 "Level 5 newsgroup face."
494 ;; backward-compatibility alias
495 (put 'gnus-group-news-5-face 'face-alias 'gnus-group-news-5)
497 (defface gnus-group-news-5-empty
506 "Level 5 empty newsgroup face."
508 ;; backward-compatibility alias
509 (put 'gnus-group-news-5-empty-face 'face-alias 'gnus-group-news-5-empty)
511 (defface gnus-group-news-6
520 "Level 6 newsgroup face."
522 ;; backward-compatibility alias
523 (put 'gnus-group-news-6-face 'face-alias 'gnus-group-news-6)
525 (defface gnus-group-news-6-empty
534 "Level 6 empty newsgroup face."
536 ;; backward-compatibility alias
537 (put 'gnus-group-news-6-empty-face 'face-alias 'gnus-group-news-6-empty)
539 (defface gnus-group-news-low
542 (:foreground "DarkTurquoise" :bold t))
545 (:foreground "DarkGreen" :bold t))
548 "Low level newsgroup face."
550 ;; backward-compatibility alias
551 (put 'gnus-group-news-low-face 'face-alias 'gnus-group-news-low)
553 (defface gnus-group-news-low-empty
556 (:foreground "DarkTurquoise"))
559 (:foreground "DarkGreen"))
562 "Low level empty newsgroup face."
564 ;; backward-compatibility alias
565 (put 'gnus-group-news-low-empty-face 'face-alias 'gnus-group-news-low-empty)
567 (defface gnus-group-mail-1
570 (:foreground "aquamarine1" :bold t))
573 (:foreground "DeepPink3" :bold t))
576 "Level 1 mailgroup face."
578 ;; backward-compatibility alias
579 (put 'gnus-group-mail-1-face 'face-alias 'gnus-group-mail-1)
581 (defface gnus-group-mail-1-empty
584 (:foreground "aquamarine1"))
587 (:foreground "DeepPink3"))
589 (:italic t :bold t)))
590 "Level 1 empty mailgroup face."
592 ;; backward-compatibility alias
593 (put 'gnus-group-mail-1-empty-face 'face-alias 'gnus-group-mail-1-empty)
595 (defface gnus-group-mail-2
598 (:foreground "aquamarine2" :bold t))
601 (:foreground "HotPink3" :bold t))
604 "Level 2 mailgroup face."
606 ;; backward-compatibility alias
607 (put 'gnus-group-mail-2-face 'face-alias 'gnus-group-mail-2)
609 (defface gnus-group-mail-2-empty
612 (:foreground "aquamarine2"))
615 (:foreground "HotPink3"))
618 "Level 2 empty mailgroup face."
620 ;; backward-compatibility alias
621 (put 'gnus-group-mail-2-empty-face 'face-alias 'gnus-group-mail-2-empty)
623 (defface gnus-group-mail-3
626 (:foreground "aquamarine3" :bold t))
629 (:foreground "magenta4" :bold t))
632 "Level 3 mailgroup face."
634 ;; backward-compatibility alias
635 (put 'gnus-group-mail-3-face 'face-alias 'gnus-group-mail-3)
637 (defface gnus-group-mail-3-empty
640 (:foreground "aquamarine3"))
643 (:foreground "magenta4"))
646 "Level 3 empty mailgroup face."
648 ;; backward-compatibility alias
649 (put 'gnus-group-mail-3-empty-face 'face-alias 'gnus-group-mail-3-empty)
651 (defface gnus-group-mail-low
654 (:foreground "aquamarine4" :bold t))
657 (:foreground "DeepPink4" :bold t))
660 "Low level mailgroup face."
662 ;; backward-compatibility alias
663 (put 'gnus-group-mail-low-face 'face-alias 'gnus-group-mail-low)
665 (defface gnus-group-mail-low-empty
668 (:foreground "aquamarine4"))
671 (:foreground "DeepPink4"))
674 "Low level empty mailgroup face."
676 ;; backward-compatibility alias
677 (put 'gnus-group-mail-low-empty-face 'face-alias 'gnus-group-mail-low-empty)
679 ;; Summary mode faces.
681 (defface gnus-summary-selected '((t (:underline t)))
682 "Face used for selected articles."
683 :group 'gnus-summary)
684 ;; backward-compatibility alias
685 (put 'gnus-summary-selected-face 'face-alias 'gnus-summary-selected)
687 (defface gnus-summary-cancelled
689 (:foreground "yellow" :background "black")))
690 "Face used for cancelled articles."
691 :group 'gnus-summary)
692 ;; backward-compatibility alias
693 (put 'gnus-summary-cancelled-face 'face-alias 'gnus-summary-cancelled)
695 (defface gnus-summary-high-ticked
698 (:foreground "pink" :bold t))
701 (:foreground "firebrick" :bold t))
704 "Face used for high interest ticked articles."
705 :group 'gnus-summary)
706 ;; backward-compatibility alias
707 (put 'gnus-summary-high-ticked-face 'face-alias 'gnus-summary-high-ticked)
709 (defface gnus-summary-low-ticked
712 (:foreground "pink" :italic t))
715 (:foreground "firebrick" :italic t))
718 "Face used for low interest ticked articles."
719 :group 'gnus-summary)
720 ;; backward-compatibility alias
721 (put 'gnus-summary-low-ticked-face 'face-alias 'gnus-summary-low-ticked)
723 (defface gnus-summary-normal-ticked
726 (:foreground "pink"))
729 (:foreground "firebrick"))
732 "Face used for normal interest ticked articles."
733 :group 'gnus-summary)
734 ;; backward-compatibility alias
735 (put 'gnus-summary-normal-ticked-face 'face-alias 'gnus-summary-normal-ticked)
737 (defface gnus-summary-high-ancient
740 (:foreground "SkyBlue" :bold t))
743 (:foreground "RoyalBlue" :bold t))
746 "Face used for high interest ancient articles."
747 :group 'gnus-summary)
748 ;; backward-compatibility alias
749 (put 'gnus-summary-high-ancient-face 'face-alias 'gnus-summary-high-ancient)
751 (defface gnus-summary-low-ancient
754 (:foreground "SkyBlue" :italic t))
757 (:foreground "RoyalBlue" :italic t))
760 "Face used for low interest ancient articles."
761 :group 'gnus-summary)
762 ;; backward-compatibility alias
763 (put 'gnus-summary-low-ancient-face 'face-alias 'gnus-summary-low-ancient)
765 (defface gnus-summary-normal-ancient
768 (:foreground "SkyBlue"))
771 (:foreground "RoyalBlue"))
774 "Face used for normal interest ancient articles."
775 :group 'gnus-summary)
776 ;; backward-compatibility alias
777 (put 'gnus-summary-normal-ancient-face 'face-alias 'gnus-summary-normal-ancient)
779 (defface gnus-summary-high-undownloaded
782 (:bold t :foreground "cyan4"))
783 (((class color) (background dark))
784 (:bold t :foreground "LightGray"))
785 (t (:inverse-video t :bold t)))
786 "Face used for high interest uncached articles."
787 :group 'gnus-summary)
788 ;; backward-compatibility alias
789 (put 'gnus-summary-high-undownloaded-face 'face-alias 'gnus-summary-high-undownloaded)
791 (defface gnus-summary-low-undownloaded
794 (:italic t :foreground "cyan4" :bold nil))
795 (((class color) (background dark))
796 (:italic t :foreground "LightGray" :bold nil))
797 (t (:inverse-video t :italic t)))
798 "Face used for low interest uncached articles."
799 :group 'gnus-summary)
800 ;; backward-compatibility alias
801 (put 'gnus-summary-low-undownloaded-face 'face-alias 'gnus-summary-low-undownloaded)
803 (defface gnus-summary-normal-undownloaded
806 (:foreground "cyan4" :bold nil))
807 (((class color) (background dark))
808 (:foreground "LightGray" :bold nil))
809 (t (:inverse-video t)))
810 "Face used for normal interest uncached articles."
811 :group 'gnus-summary)
812 ;; backward-compatibility alias
813 (put 'gnus-summary-normal-undownloaded-face 'face-alias 'gnus-summary-normal-undownloaded)
815 (defface gnus-summary-high-unread
818 "Face used for high interest unread articles."
819 :group 'gnus-summary)
820 ;; backward-compatibility alias
821 (put 'gnus-summary-high-unread-face 'face-alias 'gnus-summary-high-unread)
823 (defface gnus-summary-low-unread
826 "Face used for low interest unread articles."
827 :group 'gnus-summary)
828 ;; backward-compatibility alias
829 (put 'gnus-summary-low-unread-face 'face-alias 'gnus-summary-low-unread)
831 (defface gnus-summary-normal-unread
834 "Face used for normal interest unread articles."
835 :group 'gnus-summary)
836 ;; backward-compatibility alias
837 (put 'gnus-summary-normal-unread-face 'face-alias 'gnus-summary-normal-unread)
839 (defface gnus-summary-high-read
842 (:foreground "PaleGreen"
846 (:foreground "DarkGreen"
850 "Face used for high interest read articles."
851 :group 'gnus-summary)
852 ;; backward-compatibility alias
853 (put 'gnus-summary-high-read-face 'face-alias 'gnus-summary-high-read)
855 (defface gnus-summary-low-read
858 (:foreground "PaleGreen"
862 (:foreground "DarkGreen"
866 "Face used for low interest read articles."
867 :group 'gnus-summary)
868 ;; backward-compatibility alias
869 (put 'gnus-summary-low-read-face 'face-alias 'gnus-summary-low-read)
871 (defface gnus-summary-normal-read
874 (:foreground "PaleGreen"))
877 (:foreground "DarkGreen"))
880 "Face used for normal interest read articles."
881 :group 'gnus-summary)
882 ;; backward-compatibility alias
883 (put 'gnus-summary-normal-read-face 'face-alias 'gnus-summary-normal-read)
890 (defvar gnus-buffers nil)
892 (defun gnus-get-buffer-create (name)
893 "Do the same as `get-buffer-create', but store the created buffer."
894 (or (get-buffer name)
895 (car (push (get-buffer-create name) gnus-buffers))))
897 (defun gnus-add-buffer ()
898 "Add the current buffer to the list of Gnus buffers."
899 (push (current-buffer) gnus-buffers))
901 (defmacro gnus-kill-buffer (buffer)
902 "Kill BUFFER and remove from the list of Gnus buffers."
903 `(let ((buf ,buffer))
904 (when (gnus-buffer-exists-p buf)
905 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
908 (defun gnus-buffers ()
909 "Return a list of live Gnus buffers."
910 (while (and gnus-buffers
911 (not (buffer-name (car gnus-buffers))))
913 (let ((buffers gnus-buffers))
915 (if (buffer-name (cadr buffers))
917 (setcdr buffers (cddr buffers)))))
922 (defvar gnus-group-buffer "*Group*")
925 (autoload 'gnus-play-jingle "gnus-audio"))
930 (:foreground "#888888"))
933 (:foreground "#888888"))
936 "Face for the splash screen."
938 ;; backward-compatibility alias
939 (put 'gnus-splash-face 'face-alias 'gnus-splash)
941 (defun gnus-splash ()
943 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
944 (let ((buffer-read-only nil))
946 (unless gnus-inhibit-startup-message
947 (gnus-group-startup-message)
949 (when gnus-play-startup-jingle
950 (gnus-play-jingle))))))
952 (defun gnus-indent-rigidly (start end arg)
953 "Indent rigidly using only spaces and no tabs."
956 (narrow-to-region start end)
958 (indent-rigidly start end arg)
959 ;; We translate tabs into spaces -- not everybody uses
960 ;; an 8-character tab.
961 (goto-char (point-min))
962 (while (search-forward "\t" nil t)
963 (replace-match " " t t))))))
965 (defvar gnus-simple-splash nil)
967 ;;(format "%02x%02x%02x" 114 66 20) "724214"
969 (defvar gnus-logo-color-alist
970 '((flame "#cc3300" "#ff2200")
971 (pine "#c0cc93" "#f8ffb8")
972 (moss "#a1cc93" "#d2ffb8")
973 (irish "#04cc90" "#05ff97")
974 (sky "#049acc" "#05deff")
975 (tin "#6886cc" "#82b6ff")
976 (velvet "#7c68cc" "#8c82ff")
977 (grape "#b264cc" "#cf7df")
978 (labia "#cc64c2" "#fd7dff")
979 (berry "#cc6485" "#ff7db5")
980 (dino "#724214" "#1e3f03")
981 (oort "#cccccc" "#888888")
982 (storm "#666699" "#99ccff")
983 (pdino "#9999cc" "#99ccff")
984 (purp "#9999cc" "#666699")
985 (no "#000000" "#ff0000")
986 (neutral "#b4b4b4" "#878787")
987 (september "#bf9900" "#ffcc00"))
988 "Color alist used for the Gnus logo.")
990 (defcustom gnus-logo-color-style 'oort
991 "*Color styles used for the Gnus logo."
992 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
993 gnus-logo-color-alist))
996 (defvar gnus-logo-colors
997 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
998 "Colors used for the Gnus logo.")
1000 (defun gnus-group-startup-message (&optional x y)
1001 "Insert startup message in current buffer."
1002 ;; Insert the message.
1006 (fboundp 'find-image)
1008 (let* ((data-directory (nnheader-find-etc-directory "images/gnus"))
1009 (image-load-path (cond (data-directory
1010 (list data-directory))
1011 ((boundp 'image-load-path)
1012 (symbol-value 'image-load-path))
1015 `((:type xpm :file "gnus.xpm"
1017 (("thing" . ,(car gnus-logo-colors))
1018 ("shadow" . ,(cadr gnus-logo-colors))
1019 ("oort" . "#eeeeee")
1020 ("background" . ,(face-background 'default))))
1021 (:type pbm :file "gnus.pbm"
1022 ;; Account for the pbm's blackground.
1023 :background ,(face-foreground 'gnus-splash)
1024 :foreground ,(face-background 'default))
1025 (:type xbm :file "gnus.xbm"
1026 ;; Account for the xbm's blackground.
1027 :background ,(face-foreground 'gnus-splash)
1028 :foreground ,(face-background 'default))))))
1030 (let ((size (image-size image)))
1031 (insert-char ?\n (max 0 (round (- (window-height)
1032 (or y (cdr size)) 1) 2)))
1033 (insert-char ?\ (max 0 (round (- (window-width)
1034 (or x (car size))) 2)))
1035 (insert-image image))
1036 (setq gnus-simple-splash nil)
1042 _ ___ __ ___ __ _ ___
1061 ;; And then hack it.
1062 (gnus-indent-rigidly (point-min) (point-max)
1063 (/ (max (- (window-width) (or x 46)) 0) 2))
1064 (goto-char (point-min))
1066 (let* ((pheight (count-lines (point-min) (point-max)))
1067 (wheight (window-height))
1068 (rest (- wheight pheight)))
1069 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
1071 (put-text-property (point-min) (point-max) 'face 'gnus-splash)
1072 (setq gnus-simple-splash t)))
1073 (goto-char (point-min))
1074 (setq mode-line-buffer-identification (concat " " gnus-version))
1075 (set-buffer-modified-p t))
1078 (let ((command (format "%s" this-command)))
1079 (when (string-match "gnus" command)
1080 (if (string-match "gnus-other-frame" command)
1081 (gnus-get-buffer-create gnus-group-buffer)
1086 (require 'gnus-util)
1089 (defcustom gnus-parameters nil
1090 "Alist of group parameters.
1093 ((\"mail\\\\..*\" (gnus-show-threads nil)
1094 (gnus-use-scoring nil)
1095 (gnus-summary-line-format
1096 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
1099 (\"mail\\\\.me\" (gnus-use-scoring t))
1100 (\"list\\\\..*\" (total-expire . t)
1101 (broken-reply-to . t)))"
1103 :group 'gnus-group-various
1104 :type '(repeat (cons regexp
1107 (defvar gnus-group-parameters-more nil)
1109 (defmacro gnus-define-group-parameter (param &rest rest)
1110 "Define a group parameter PARAM.
1111 REST is a plist of following:
1112 :type One of `bool', `list' or nil.
1113 :function The name of the function.
1114 :function-document The documentation of the function.
1115 :parameter-type The type for customizing the parameter.
1116 :parameter-document The documentation for the parameter.
1117 :variable The name of the variable.
1118 :variable-document The documentation for the variable.
1119 :variable-group The group for customizing the variable.
1120 :variable-type The type for customizing the variable.
1121 :variable-default The default value of the variable."
1122 (let* ((type (plist-get rest :type))
1123 (parameter-type (plist-get rest :parameter-type))
1124 (parameter-document (plist-get rest :parameter-document))
1125 (function (or (plist-get rest :function)
1126 (intern (format "gnus-parameter-%s" param))))
1127 (function-document (or (plist-get rest :function-document) ""))
1128 (variable (or (plist-get rest :variable)
1129 (intern (format "gnus-parameter-%s-alist" param))))
1130 (variable-document (or (plist-get rest :variable-document) ""))
1131 (variable-group (plist-get rest :variable-group))
1132 (variable-type (or (plist-get rest :variable-type)
1134 (list (regexp :tag "Group")
1135 ,(car (cdr parameter-type)))))))
1136 (variable-default (plist-get rest :variable-default)))
1139 `(defcustom ,variable ,variable-default
1141 :group 'gnus-group-parameter
1142 :group ',variable-group
1143 :type ,variable-type)
1144 `(setq gnus-group-parameters-more
1145 (delq (assq ',param gnus-group-parameters-more)
1146 gnus-group-parameters-more))
1147 `(add-to-list 'gnus-group-parameters-more
1150 ,parameter-document))
1152 `(defun ,function (name)
1154 (let ((params (gnus-group-find-parameter name))
1157 ((memq ',param params)
1159 ((setq val (assq ',param params))
1161 ((stringp ,variable)
1162 (string-match ,variable name))
1164 (let ((alist ,variable)
1166 (while (setq elem (pop alist))
1168 (string-match (car elem) name))
1171 (if (consp value) (car value) value))))))
1172 `(defun ,function (name)
1175 (or (gnus-group-find-parameter name ',param ,(and type t))
1176 (let ((alist ,variable)
1178 (while (setq elem (pop alist))
1180 (string-match (car elem) name))
1185 '(if (consp value) (car value) value))))))))))
1187 (defcustom gnus-home-directory "~/"
1188 "Directory variable that specifies the \"home\" directory.
1189 All other Gnus file and directory variables are initialized from this variable."
1193 (defcustom gnus-directory (or (getenv "SAVEDIR")
1194 (nnheader-concat gnus-home-directory "News/"))
1195 "*Directory variable from which all other Gnus file variables are derived.
1197 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1198 This means that other directory variables that are initialized from
1199 this variable won't be set properly if you set this variable in `.gnus.el'.
1200 Set this variable in `.emacs' instead."
1204 (defcustom gnus-default-directory nil
1205 "*Default directory for all Gnus buffers."
1207 :type '(choice (const :tag "current" nil)
1210 ;; Site dependent variables. These variables should be defined in
1213 (defvar gnus-default-nntp-server nil
1214 "Specify a default NNTP server.
1215 This variable should be defined in paths.el, and should never be set
1217 If you want to change servers, you should use `gnus-select-method'.
1218 See the documentation to that variable.")
1220 ;; Don't touch this variable.
1221 (defvar gnus-nntp-service "nntp"
1222 "NNTP service name (\"nntp\" or 119).
1223 This is an obsolete variable, which is scarcely used. If you use an
1224 nntp server for your newsgroup and want to change the port number
1225 used to 899, you would say something along these lines:
1227 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1229 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1230 "A file with only the name of the nntp server in it."
1235 (defun gnus-getenv-nntpserver ()
1236 "Find default nntp server.
1237 Check the NNTPSERVER environment variable and the
1238 `gnus-nntpserver-file' file."
1239 (or (getenv "NNTPSERVER")
1240 (and (file-readable-p gnus-nntpserver-file)
1242 (insert-file-contents gnus-nntpserver-file)
1243 (when (re-search-forward "[^ \t\n\r]+" nil t)
1244 (match-string 0))))))
1246 (defcustom gnus-select-method
1249 (list 'nntp (or (condition-case nil
1250 (gnus-getenv-nntpserver)
1252 (when (and gnus-default-nntp-server
1253 (not (string= gnus-default-nntp-server "")))
1254 gnus-default-nntp-server)
1256 (if (or (null gnus-nntp-service)
1257 (equal gnus-nntp-service "nntp"))
1259 (list gnus-nntp-service)))
1261 "Default method for selecting a newsgroup.
1262 This variable should be a list, where the first element is how the
1263 news is to be fetched, the second is the address.
1265 For instance, if you want to get your news via \"flab.flab.edu\" using
1266 NNTP, you could say:
1268 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1270 If you want to use your local spool, say:
1272 \(setq gnus-select-method (list 'nnspool (system-name)))
1274 If you use this variable, you must set `gnus-nntp-server' to nil.
1276 There is a lot more to know about select methods and virtual servers -
1277 see the manual for details."
1279 :type 'gnus-select-method)
1281 (defcustom gnus-message-archive-method "archive"
1282 "*Method used for archiving messages you've sent.
1283 This should be a mail method."
1285 :group 'gnus-message
1286 :type '(choice (const :tag "Default archive method" "archive")
1287 gnus-select-method))
1289 (defcustom gnus-message-archive-group nil
1290 "*Name of the group in which to save the messages you've written.
1291 This can either be a string; a list of strings; or an alist
1292 of regexps/functions/forms to be evaluated to return a string (or a list
1293 of strings). The functions are called with the name of the current
1294 group (or nil) as a parameter.
1296 If you want to save your mail in one group and the news articles you
1297 write in another group, you could say something like:
1299 \(setq gnus-message-archive-group
1300 '((if (message-news-p)
1304 Normally the group names returned by this variable should be
1305 unprefixed -- which implicitly means \"store on the archive server\".
1306 However, you may wish to store the message on some other server. In
1307 that case, just return a fully prefixed name of the group --
1308 \"nnml+private:mail.misc\", for instance."
1309 :group 'gnus-message
1310 :type '(choice (const :tag "none" nil)
1315 (defcustom gnus-secondary-servers nil
1316 "List of NNTP servers that the user can choose between interactively.
1317 To make Gnus query you for a server, you have to give `gnus' a
1318 non-numeric prefix - `C-u M-x gnus', in short."
1320 :type '(repeat string))
1322 (defcustom gnus-nntp-server nil
1323 "*The name of the host running the NNTP server.
1324 This variable is semi-obsolete. Use the `gnus-select-method'
1327 :type '(choice (const :tag "disable" nil)
1330 (defcustom gnus-secondary-select-methods nil
1331 "A list of secondary methods that will be used for reading news.
1332 This is a list where each element is a complete select method (see
1333 `gnus-select-method').
1335 If, for instance, you want to read your mail with the nnml back end,
1336 you could set this variable:
1338 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1340 :type '(repeat gnus-select-method))
1342 (defvar gnus-backup-default-subscribed-newsgroups
1343 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1344 "Default default new newsgroups the first time Gnus is run.
1345 Should be set in paths.el, and shouldn't be touched by the user.")
1347 (defcustom gnus-local-domain nil
1348 "Local domain name without a host name.
1349 The DOMAINNAME environment variable is used instead if it is defined.
1350 If the function `system-name' returns the full Internet name, there is
1351 no need to set this variable."
1352 :group 'gnus-message
1353 :type '(choice (const :tag "default" nil)
1356 (defvar gnus-local-organization nil
1357 "String with a description of what organization (if any) the user belongs to.
1358 Obsolete variable; use `message-user-organization' instead.")
1360 ;; Customization variables
1362 (defcustom gnus-refer-article-method nil
1363 "Preferred method for fetching an article by Message-ID.
1364 If you are reading news from the local spool (with nnspool), fetching
1365 articles by Message-ID is painfully slow. By setting this method to an
1366 nntp method, you might get acceptable results.
1368 The value of this variable must be a valid select method as discussed
1369 in the documentation of `gnus-select-method'.
1371 It can also be a list of select methods, as well as the special symbol
1372 `current', which means to use the current select method. If it is a
1373 list, Gnus will try all the methods in the list until it finds a match."
1375 :type '(choice (const :tag "default" nil)
1377 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1379 (repeat :menu-tag "Try multiple"
1381 :value (current (nnweb "refer" (nnweb-type google)))
1382 (choice :tag "Method"
1384 (const :tag "Google"
1385 (nnweb "refer" (nnweb-type google)))
1386 gnus-select-method))))
1388 (defcustom gnus-group-faq-directory
1389 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1390 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1391 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1392 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1393 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1394 "/ftp@rtfm.mit.edu:/pub/usenet/"
1395 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1396 "/ftp@ftp.sunet.se:/pub/usenet/"
1397 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1398 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1399 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1400 "*Directory where the group FAQs are stored.
1401 This will most commonly be on a remote machine, and the file will be
1402 fetched by ange-ftp.
1404 This variable can also be a list of directories. In that case, the
1405 first element in the list will be used by default. The others can
1406 be used when being prompted for a site.
1408 Note that Gnus uses an aol machine as the default directory. If this
1409 feels fundamentally unclean, just think of it as a way to finally get
1410 something of value back from them.
1412 If the default site is too slow, try one of these:
1414 North America: mirrors.aol.com /pub/rtfm/usenet
1415 ftp.seas.gwu.edu /pub/rtfm
1416 rtfm.mit.edu /pub/usenet
1417 Europe: ftp.uni-paderborn.de /pub/FAQ
1418 src.doc.ic.ac.uk /usenet/news-FAQS
1419 ftp.sunet.se /pub/usenet
1420 ftp.pasteur.fr /pub/FAQ
1421 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1422 hwarang.postech.ac.kr /pub/usenet
1423 ftp.hk.super.net /mirror/faqs"
1424 :group 'gnus-group-various
1425 :type '(choice directory
1426 (repeat directory)))
1428 (defcustom gnus-group-charter-alist
1429 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1430 ("de" . (concat "http://purl.net/charta/" name ".html"))
1431 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1432 ("england" . (concat "http://england.news-admin.org/charters/" name))
1433 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1434 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1435 (gnus-replace-in-string name "europa\\." "") ".html"))
1436 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1437 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1438 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1439 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1440 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1441 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1442 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1443 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1444 (gnus-replace-in-string name "\\." "_") ".html"))
1445 ("milw" . (concat "http://usenet.mil.wi.us/"
1446 (gnus-replace-in-string name "milw\\." "") "-charter"))
1447 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1448 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1449 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1450 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1451 When FORM is evaluated `name' is bound to the name of the group."
1453 :group 'gnus-group-various
1454 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1456 (defcustom gnus-group-fetch-control-use-browse-url nil
1457 "*Non-nil means that control messages are displayed using `browse-url'.
1458 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1461 :group 'gnus-group-various
1464 (defcustom gnus-use-cross-reference t
1465 "*Non-nil means that cross referenced articles will be marked as read.
1466 If nil, ignore cross references. If t, mark articles as read in
1467 subscribed newsgroups. If neither t nor nil, mark as read in all
1470 :type '(choice (const :tag "off" nil)
1471 (const :tag "subscribed" t)
1475 (defcustom gnus-process-mark ?#
1477 :group 'gnus-group-visual
1478 :group 'gnus-summary-marks
1481 (defcustom gnus-large-newsgroup 200
1482 "*The number of articles which indicates a large newsgroup.
1483 If the number of articles in a newsgroup is greater than this value,
1484 confirmation is required for selecting the newsgroup.
1485 If it is nil, no confirmation is required."
1486 :group 'gnus-group-select
1487 :type '(choice (const :tag "No limit" nil)
1490 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1491 "*Non-nil means that the default name of a file to save articles in is the group name.
1492 If it's nil, the directory form of the group name is used instead.
1494 If this variable is a list, and the list contains the element
1495 `not-score', long file names will not be used for score files; if it
1496 contains the element `not-save', long file names will not be used for
1497 saving; and if it contains the element `not-kill', long file names
1498 will not be used for kill files.
1500 Note that the default for this variable varies according to what system
1501 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1502 to nil while on all other systems it defaults to t."
1504 :type '(radio (sexp :format "Non-nil\n"
1505 :match (lambda (widget value)
1506 (and value (not (listp value))))
1509 (checklist (const :format "%v " not-score)
1510 (const :format "%v " not-save)
1513 (defcustom gnus-kill-files-directory gnus-directory
1514 "*Name of the directory where kill files will be stored (default \"~/News\")."
1515 :group 'gnus-score-files
1516 :group 'gnus-score-kill
1519 (defcustom gnus-save-score nil
1520 "*If non-nil, save group scoring info."
1521 :group 'gnus-score-various
1525 (defcustom gnus-use-undo t
1526 "*If non-nil, allow undoing in Gnus group mode buffers."
1530 (defcustom gnus-use-adaptive-scoring nil
1531 "*If non-nil, use some adaptive scoring scheme.
1532 If a list, then the values `word' and `line' are meaningful. The
1533 former will perform adaption on individual words in the subject
1534 header while `line' will perform adaption on several headers."
1536 :group 'gnus-score-adapt
1537 :type '(set (const word) (const line)))
1539 (defcustom gnus-use-cache 'passive
1540 "*If nil, Gnus will ignore the article cache.
1541 If `passive', it will allow entering (and reading) articles
1542 explicitly entered into the cache. If anything else, use the
1543 cache to the full extent of the law."
1546 :type '(choice (const :tag "off" nil)
1547 (const :tag "passive" passive)
1548 (const :tag "active" t)))
1550 (defcustom gnus-use-trees nil
1551 "*If non-nil, display a thread tree buffer."
1555 (defcustom gnus-use-grouplens nil
1556 "*If non-nil, use GroupLens ratings."
1560 (defcustom gnus-keep-backlog 20
1561 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1562 If it is a number N, then Gnus will only keep the last N articles
1563 read. If it is neither nil nor a number, Gnus will keep all read
1564 articles. This is not a good idea."
1566 :type '(choice (const :tag "off" nil)
1571 (defcustom gnus-use-nocem nil
1572 "*If non-nil, Gnus will read NoCeM cancel messages."
1576 (defcustom gnus-suppress-duplicates nil
1577 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1581 (defcustom gnus-use-scoring t
1582 "*If non-nil, enable scoring."
1586 (defcustom gnus-summary-prepare-exit-hook
1587 '(gnus-summary-expire-articles)
1588 "*A hook called when preparing to exit from the summary buffer.
1589 It calls `gnus-summary-expire-articles' by default."
1590 :group 'gnus-summary-exit
1593 (defcustom gnus-novice-user t
1594 "*Non-nil means that you are a Usenet novice.
1595 If non-nil, verbose messages may be displayed and confirmations may be
1600 (defcustom gnus-expert-user nil
1601 "*Non-nil means that you will never be asked for confirmation about anything.
1602 That doesn't mean *anything* anything; particularly destructive
1603 commands will still require prompting."
1607 (defcustom gnus-interactive-catchup t
1608 "*If non-nil, require your confirmation when catching up a group."
1609 :group 'gnus-group-select
1612 (defcustom gnus-interactive-exit t
1613 "*If non-nil, require your confirmation when exiting Gnus."
1617 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1618 "*Function for extracting address components from a From header.
1619 Two pre-defined function exist: `gnus-extract-address-components',
1620 which is the default, quite fast, and too simplistic solution, and
1621 `mail-extract-address-components', which works much better, but is
1623 :group 'gnus-summary-format
1624 :type '(radio (function-item gnus-extract-address-components)
1625 (function-item mail-extract-address-components)
1626 (function :tag "Other")))
1628 (defcustom gnus-carpal nil
1629 "*If non-nil, display clickable icons."
1633 (defcustom gnus-shell-command-separator ";"
1634 "String used to separate shell commands."
1638 (defcustom gnus-valid-select-methods
1639 '(("nntp" post address prompt-address physical-address)
1640 ("nnspool" post address)
1641 ("nnvirtual" post-mail virtual prompt-address)
1642 ("nnmbox" mail respool address)
1643 ("nnml" post-mail respool address)
1644 ("nnmh" mail respool address)
1645 ("nndir" post-mail prompt-address physical-address)
1646 ("nneething" none address prompt-address physical-address)
1647 ("nndoc" none address prompt-address)
1648 ("nnbabyl" mail address respool)
1649 ("nnkiboze" post virtual)
1650 ("nnsoup" post-mail address)
1651 ("nndraft" post-mail)
1652 ("nnfolder" mail respool address)
1653 ("nngateway" post-mail address prompt-address physical-address)
1662 ("nnagent" post-mail)
1663 ("nnimap" post-mail address prompt-address physical-address)
1664 ("nnmaildir" mail respool address)
1666 "*An alist of valid select methods.
1667 The first element of each list lists should be a string with the name
1668 of the select method. The other elements may be the category of
1669 this method (i. e., `post', `mail', `none' or whatever) or other
1670 properties that this method has (like being respoolable).
1671 If you implement a new select method, all you should have to change is
1672 this variable. I think."
1674 :type '(repeat (group (string :tag "Name")
1675 (radio-button-choice (const :format "%v " post)
1676 (const :format "%v " mail)
1677 (const :format "%v " none)
1679 (checklist :inline t
1680 (const :format "%v " address)
1681 (const :format "%v " prompt-address)
1682 (const :format "%v " physical-address)
1683 (const :format "%v " virtual)
1686 (defun gnus-redefine-select-method-widget ()
1687 "Recomputes the select-method widget based on the value of
1688 `gnus-valid-select-methods'."
1689 (define-widget 'gnus-select-method 'list
1690 "Widget for entering a select method."
1692 :tag "Select Method"
1693 :args `((choice :tag "Method"
1694 ,@(mapcar (lambda (entry)
1695 (list 'const :format "%v\n"
1696 (intern (car entry))))
1697 gnus-valid-select-methods)
1698 (symbol :tag "other"))
1699 (string :tag "Address")
1700 (repeat :tag "Options"
1704 (sexp :tag "Value"))))))
1706 (gnus-redefine-select-method-widget)
1708 (defcustom gnus-updated-mode-lines '(group article summary tree)
1709 "List of buffers that should update their mode lines.
1710 The list may contain the symbols `group', `article', `tree' and
1711 `summary'. If the corresponding symbol is present, Gnus will keep
1712 that mode line updated with information that may be pertinent.
1713 If this variable is nil, screen refresh may be quicker."
1714 :group 'gnus-various
1715 :type '(set (const group)
1720 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1721 (defcustom gnus-mode-non-string-length nil
1722 "*Max length of mode-line non-string contents.
1723 If this is nil, Gnus will take space as is needed, leaving the rest
1724 of the mode line intact. Note that the default of nil is unlikely
1725 to be desirable; see the manual for further details."
1726 :group 'gnus-various
1727 :type '(choice (const nil)
1730 ;; There should be special validation for this.
1731 (define-widget 'gnus-email-address 'string
1732 "An email address.")
1734 (gnus-define-group-parameter
1737 "Return GROUP's to-address."
1739 "*Alist of group regexps and correspondent to-addresses."
1740 :variable-group gnus-group-parameter
1741 :parameter-type '(gnus-email-address :tag "To Address")
1742 :parameter-document "\
1743 This will be used when doing followups and posts.
1745 This is primarily useful in mail groups that represent closed
1746 mailing lists--mailing lists where it's expected that everybody that
1747 writes to the mailing list is subscribed to it. Since using this
1748 parameter ensures that the mail only goes to the mailing list itself,
1749 it means that members won't receive two copies of your followups.
1751 Using `to-address' will actually work whether the group is foreign or
1752 not. Let's say there's a group on the server that is called
1753 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1754 articles from a mail-to-news gateway. Posting directly to this group
1755 is therefore impossible--you have to send mail to the mailing list
1758 The gnus-group-split mail splitting mechanism will behave as if this
1759 address was listed in gnus-group-split Addresses (see below).")
1761 (gnus-define-group-parameter
1764 "Return GROUP's to-list."
1766 "*Alist of group regexps and correspondent to-lists."
1767 :variable-group gnus-group-parameter
1768 :parameter-type '(gnus-email-address :tag "To List")
1769 :parameter-document "\
1770 This address will be used when doing a `a' in the group.
1772 It is totally ignored when doing a followup--except that if it is
1773 present in a news group, you'll get mail group semantics when doing
1776 The gnus-group-split mail splitting mechanism will behave as if this
1777 address was listed in gnus-group-split Addresses (see below).")
1779 (gnus-define-group-parameter
1783 "Return GROUP's subscription status."
1785 "*Groups which are automatically considered subscribed."
1786 :variable-group gnus-group-parameter
1787 :parameter-type '(const :tag "Subscribed" t)
1788 :parameter-document "\
1789 Gnus assumed that you are subscribed to the To/List address.
1791 When constructing a list of subscribed groups using
1792 `gnus-find-subscribed-addresses', Gnus includes the To address given
1793 above, or the list address (if the To address has not been set).")
1795 (gnus-define-group-parameter
1798 :function gnus-group-auto-expirable-p
1800 "Check whether GROUP is auto-expirable or not."
1801 :variable gnus-auto-expirable-newsgroups
1802 :variable-default nil
1804 "*Groups in which to automatically mark read articles as expirable.
1805 If non-nil, this should be a regexp that should match all groups in
1806 which to perform auto-expiry. This only makes sense for mail groups."
1807 :variable-group nnmail-expire
1808 :variable-type '(choice (const nil)
1810 :parameter-type '(const :tag "Automatic Expire" t)
1812 "All articles that are read will be marked as expirable.")
1814 (gnus-define-group-parameter
1817 :function gnus-group-total-expirable-p
1819 "Check whether GROUP is total-expirable or not."
1820 :variable gnus-total-expirable-newsgroups
1821 :variable-default nil
1823 "*Groups in which to perform expiry of all read articles.
1824 Use with extreme caution. All groups that match this regexp will be
1825 expiring - which means that all read articles will be deleted after
1826 \(say) one week. (This only goes for mail groups and the like, of
1828 :variable-group nnmail-expire
1829 :variable-type '(choice (const nil)
1831 :parameter-type '(const :tag "Total Expire" t)
1833 "All read articles will be put through the expiry process
1835 This happens even if they are not marked as expirable.
1838 (gnus-define-group-parameter
1841 "Return the default charset of GROUP."
1842 :variable gnus-group-charset-alist
1844 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1845 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1846 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1847 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1848 ("\\(^\\|:\\)relcom\\>" koi8-r)
1849 ("\\(^\\|:\\)fido7\\>" koi8-r)
1850 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1851 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1852 ("\\(^\\|:\\)han\\>" euc-kr)
1853 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1854 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1855 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1857 "Alist of regexps (to match group names) and default charsets to be used when reading."
1858 :variable-group gnus-charset
1859 :variable-type '(repeat (list (regexp :tag "Group")
1860 (symbol :tag "Charset")))
1861 :parameter-type '(symbol :tag "Charset")
1862 :parameter-document "\
1863 The default charset to use in the group.")
1865 (gnus-define-group-parameter
1869 "Return a posting method for GROUP."
1870 :variable gnus-post-method-alist
1872 "Alist of regexps (to match group names) and method to be used when
1873 posting an article."
1874 :variable-group gnus-group-foreign
1876 '(choice :tag "Posting Method"
1877 (const :tag "Use native server" native)
1878 (const :tag "Use current server" current)
1879 (list :convert-widget
1881 (list 'sexp :tag "Methods"
1882 :value gnus-select-method))))
1884 "Posting method for this group.")
1886 (gnus-define-group-parameter
1887 large-newsgroup-initial
1890 "Return GROUP's initial input of the number of articles."
1892 "*Alist of group regexps and its initial input of the number of articles."
1893 :variable-group gnus-group-parameter
1894 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1895 (const :tag "All" nil)
1897 :parameter-document "\
1899 This number will be prompted as the initial value of the number of
1900 articles to list when the group is a large newsgroup (see
1901 `gnus-large-newsgroup'). If it is nil, the default value is the
1902 total number of articles in the group.")
1904 ;; The Gnus registry's ignored groups
1905 (gnus-define-group-parameter
1909 "Whether this group should be ignored by the registry."
1910 :variable gnus-registry-ignored-groups
1911 :variable-default nil
1913 "*Groups in which the registry should be turned off."
1914 :variable-group gnus-registry
1915 :variable-type '(repeat
1917 (regexp :tag "Group Name Regular Expression")
1918 (boolean :tag "Ignored")))
1920 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1922 "Whether the Gnus Registry should ignore this group.")
1924 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1925 (defcustom gnus-install-group-spam-parameters t
1926 "*Disable the group parameters for spam detection.
1927 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1932 (when gnus-install-group-spam-parameters
1933 (defvar gnus-group-spam-classification-spam t
1934 "Spam group classification (requires spam.el).
1935 This group contains spam messages. On summary entry, unread messages
1936 will be marked as spam. On summary exit, the specified spam
1937 processors will be invoked on spam-marked messages, then those
1938 messages will be expired, so the spam processor will only see a
1939 spam-marked message once.")
1941 (defvar gnus-group-spam-classification-ham 'ask
1942 "The ham value for the spam group parameter (requires spam.el).
1943 On summary exit, the specified ham processors will be invoked on
1944 ham-marked messages. Exercise caution, since the ham processor will
1945 see the same message more than once because there is no ham message
1948 (gnus-define-group-parameter
1952 "The spam type (spam, ham, or neither) of the group."
1953 :variable gnus-spam-newsgroup-contents
1954 :variable-default nil
1956 "*Group classification (spam, ham, or neither). Only
1957 meaningful when spam.el is loaded. If non-nil, this should be a
1958 list of group name regexps associated with a classification for
1959 each one. In spam groups, new articles are marked as spam on
1960 summary entry. There is other behavior associated with ham and
1961 no classification when spam.el is loaded - see the manual."
1962 :variable-group spam
1963 :variable-type '(repeat
1964 (list :tag "Group contents spam/ham classification"
1965 (regexp :tag "Group")
1967 (variable-item gnus-group-spam-classification-spam)
1968 (variable-item gnus-group-spam-classification-ham)
1969 (const :tag "Unclassified" nil))))
1971 :parameter-type '(list :tag "Group contents spam/ham classification"
1972 (choice :tag "Group contents classification for spam sorting"
1973 (variable-item gnus-group-spam-classification-spam)
1974 (variable-item gnus-group-spam-classification-ham)
1975 (const :tag "Unclassified" nil)))
1977 "The spam classification (spam, ham, or neither) of this group.
1978 When a spam group is entered, all unread articles are marked as
1979 spam. There is other behavior associated with ham and no
1980 classification when spam.el is loaded - see the manual.")
1982 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1983 "OBSOLETE: The ifile summary exit spam processor.")
1985 (defvar gnus-group-spam-exit-processor-stat "stat"
1986 "OBSOLETE: The spam-stat summary exit spam processor.")
1988 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1989 "OBSOLETE: The Bogofilter summary exit spam processor.")
1991 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1992 "OBSOLETE: The Blacklist summary exit spam processor.")
1994 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1995 "OBSOLETE: The Gmane reporting summary exit spam processor.
1996 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1998 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1999 "OBSOLETE: The spamoracle summary exit spam processor.")
2001 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
2002 "OBSOLETE: The ifile summary exit ham processor.
2003 Only applicable to non-spam (unclassified and ham) groups.")
2005 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
2006 "OBSOLETE: The Bogofilter summary exit ham processor.
2007 Only applicable to non-spam (unclassified and ham) groups.")
2009 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
2010 "OBSOLETE: The spam-stat summary exit ham processor.
2011 Only applicable to non-spam (unclassified and ham) groups.")
2013 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
2014 "OBSOLETE: The whitelist summary exit ham processor.
2015 Only applicable to non-spam (unclassified and ham) groups.")
2017 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
2018 "OBSOLETE: The BBDB summary exit ham processor.
2019 Only applicable to non-spam (unclassified and ham) groups.")
2021 (defvar gnus-group-ham-exit-processor-copy "copy"
2022 "OBSOLETE: The ham copy exit ham processor.
2023 Only applicable to non-spam (unclassified and ham) groups.")
2025 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
2026 "OBSOLETE: The spamoracle summary exit ham processor.
2027 Only applicable to non-spam (unclassified and ham) groups.")
2029 (gnus-define-group-parameter
2034 :tag "Spam Summary Exit Processor"
2036 (list :tag "Spam Summary Exit Processor Choices"
2038 (variable-item gnus-group-spam-exit-processor-ifile)
2039 (variable-item gnus-group-spam-exit-processor-stat)
2040 (variable-item gnus-group-spam-exit-processor-bogofilter)
2041 (variable-item gnus-group-spam-exit-processor-blacklist)
2042 (variable-item gnus-group-spam-exit-processor-spamoracle)
2043 (variable-item gnus-group-spam-exit-processor-report-gmane)
2044 (variable-item gnus-group-ham-exit-processor-bogofilter)
2045 (variable-item gnus-group-ham-exit-processor-ifile)
2046 (variable-item gnus-group-ham-exit-processor-stat)
2047 (variable-item gnus-group-ham-exit-processor-whitelist)
2048 (variable-item gnus-group-ham-exit-processor-BBDB)
2049 (variable-item gnus-group-ham-exit-processor-spamoracle)
2050 (variable-item gnus-group-ham-exit-processor-copy)
2051 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2052 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2053 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2054 (const :tag "Spam: ifile" (spam spam-use-ifile))
2055 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2056 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2057 (const :tag "Ham: ifile" (ham spam-use-ifile))
2058 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2059 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2060 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
2061 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2062 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2063 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
2065 "Which spam or ham processors will be applied when the summary is exited."
2066 :variable gnus-spam-process-newsgroups
2067 :variable-default nil
2069 "*Groups in which to automatically process spam or ham articles with
2070 a backend on summary exit. If non-nil, this should be a list of group
2071 name regexps that should match all groups in which to do automatic
2072 spam processing, associated with the appropriate processor."
2073 :variable-group spam
2075 '(repeat :tag "Spam/Ham Processors"
2076 (list :tag "Spam Summary Exit Processor Choices"
2077 (regexp :tag "Group Regexp")
2079 :tag "Spam/Ham Summary Exit Processor"
2080 (variable-item gnus-group-spam-exit-processor-ifile)
2081 (variable-item gnus-group-spam-exit-processor-stat)
2082 (variable-item gnus-group-spam-exit-processor-bogofilter)
2083 (variable-item gnus-group-spam-exit-processor-blacklist)
2084 (variable-item gnus-group-spam-exit-processor-spamoracle)
2085 (variable-item gnus-group-spam-exit-processor-report-gmane)
2086 (variable-item gnus-group-ham-exit-processor-bogofilter)
2087 (variable-item gnus-group-ham-exit-processor-ifile)
2088 (variable-item gnus-group-ham-exit-processor-stat)
2089 (variable-item gnus-group-ham-exit-processor-whitelist)
2090 (variable-item gnus-group-ham-exit-processor-BBDB)
2091 (variable-item gnus-group-ham-exit-processor-spamoracle)
2092 (variable-item gnus-group-ham-exit-processor-copy)
2093 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2094 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2095 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2096 (const :tag "Spam: ifile" (spam spam-use-ifile))
2097 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2098 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2099 (const :tag "Ham: ifile" (ham spam-use-ifile))
2100 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2101 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2102 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
2103 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2104 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2105 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
2108 "Which spam or ham processors will be applied when the summary is exited.")
2110 (gnus-define-group-parameter
2114 '(boolean :tag "Spam autodetection")
2116 "Should spam be autodetected (with spam-split) in this group?"
2117 :variable gnus-spam-autodetect
2118 :variable-default nil
2120 "*Groups in which spam should be autodetected when they are entered.
2121 Only unseen articles will be examined, unless
2122 spam-autodetect-recheck-messages is set."
2123 :variable-group spam
2126 :tag "Autodetection setting"
2128 (regexp :tag "Group Regexp")
2131 "Spam autodetection.
2132 Only unseen articles will be examined, unless
2133 spam-autodetect-recheck-messages is set.")
2135 (gnus-define-group-parameter
2136 spam-autodetect-methods
2139 '(choice :tag "Spam autodetection-specific methods"
2142 (set :tag "Use specific methods"
2143 (variable-item spam-use-blacklist)
2144 (variable-item spam-use-regex-headers)
2145 (variable-item spam-use-regex-body)
2146 (variable-item spam-use-whitelist)
2147 (variable-item spam-use-BBDB)
2148 (variable-item spam-use-ifile)
2149 (variable-item spam-use-spamoracle)
2150 (variable-item spam-use-stat)
2151 (variable-item spam-use-blackholes)
2152 (variable-item spam-use-hashcash)
2153 (variable-item spam-use-bogofilter-headers)
2154 (variable-item spam-use-bogofilter)))
2156 "Methods to be used for autodetection in each group"
2157 :variable gnus-spam-autodetect-methods
2158 :variable-default nil
2160 "*Methods for autodetecting spam per group.
2161 Requires the spam-autodetect parameter. Only unseen articles
2162 will be examined, unless spam-autodetect-recheck-messages is
2164 :variable-group spam
2167 :tag "Autodetection methods"
2169 (regexp :tag "Group Regexp")
2173 (set :tag "Use specific methods"
2174 (variable-item spam-use-blacklist)
2175 (variable-item spam-use-regex-headers)
2176 (variable-item spam-use-regex-body)
2177 (variable-item spam-use-whitelist)
2178 (variable-item spam-use-BBDB)
2179 (variable-item spam-use-ifile)
2180 (variable-item spam-use-spamoracle)
2181 (variable-item spam-use-stat)
2182 (variable-item spam-use-blackholes)
2183 (variable-item spam-use-hashcash)
2184 (variable-item spam-use-bogofilter-headers)
2185 (variable-item spam-use-bogofilter)))))
2187 "Spam autodetection methods.
2188 Requires the spam-autodetect parameter. Only unseen articles
2189 will be examined, unless spam-autodetect-recheck-messages is
2192 (gnus-define-group-parameter
2193 spam-process-destination
2196 '(choice :tag "Destination for spam-processed articles at summary exit"
2197 (string :tag "Move to a group")
2198 (repeat :tag "Move to multiple groups"
2199 (string :tag "Destination group"))
2200 (const :tag "Expire" nil))
2202 "Where spam-processed articles will go at summary exit."
2203 :variable gnus-spam-process-destinations
2204 :variable-default nil
2206 "*Groups in which to explicitly send spam-processed articles to
2207 another group, or expire them (the default). If non-nil, this should
2208 be a list of group name regexps that should match all groups in which
2209 to do spam-processed article moving, associated with the destination
2210 group or nil for explicit expiration. This only makes sense for
2212 :variable-group spam
2215 :tag "Spam-processed articles destination"
2217 (regexp :tag "Group Regexp")
2219 :tag "Destination for spam-processed articles at summary exit"
2220 (string :tag "Move to a group")
2221 (repeat :tag "Move to multiple groups"
2222 (string :tag "Destination group"))
2223 (const :tag "Expire" nil))))
2225 "Where spam-processed articles will go at summary exit.")
2227 (gnus-define-group-parameter
2228 ham-process-destination
2232 :tag "Destination for ham articles at summary exit from a spam group"
2233 (string :tag "Move to a group")
2234 (repeat :tag "Move to multiple groups"
2235 (string :tag "Destination group"))
2236 (const :tag "Respool" respool)
2237 (const :tag "Do nothing" nil))
2239 "Where ham articles will go at summary exit from a spam group."
2240 :variable gnus-ham-process-destinations
2241 :variable-default nil
2243 "*Groups in which to explicitly send ham articles to
2244 another group, or do nothing (the default). If non-nil, this should
2245 be a list of group name regexps that should match all groups in which
2246 to do ham article moving, associated with the destination
2247 group or nil for explicit ignoring. This only makes sense for
2248 mail groups, and only works in spam groups."
2249 :variable-group spam
2252 :tag "Ham articles destination"
2254 (regexp :tag "Group Regexp")
2256 :tag "Destination for ham articles at summary exit from spam group"
2257 (string :tag "Move to a group")
2258 (repeat :tag "Move to multiple groups"
2259 (string :tag "Destination group"))
2260 (const :tag "Respool" respool)
2261 (const :tag "Expire" nil))))
2263 "Where ham articles will go at summary exit from a spam group.")
2265 (gnus-define-group-parameter
2268 :parameter-type '(list :tag "Ham mark choices"
2270 (variable-item gnus-del-mark)
2271 (variable-item gnus-read-mark)
2272 (variable-item gnus-ticked-mark)
2273 (variable-item gnus-killed-mark)
2274 (variable-item gnus-kill-file-mark)
2275 (variable-item gnus-low-score-mark)))
2278 "Marks considered ham (positively not spam). Such articles will be
2279 processed as ham (non-spam) on group exit. When nil, the global
2280 spam-ham-marks variable takes precedence."
2281 :variable-default '((".*" ((gnus-del-mark
2285 gnus-low-score-mark))))
2286 :variable-group spam
2288 "*Groups in which to explicitly set the ham marks to some value.")
2290 (gnus-define-group-parameter
2293 :parameter-type '(list :tag "Spam mark choices"
2295 (variable-item gnus-spam-mark)
2296 (variable-item gnus-killed-mark)
2297 (variable-item gnus-kill-file-mark)
2298 (variable-item gnus-low-score-mark)))
2301 "Marks considered spam.
2302 Such articles will be processed as spam on group exit. When nil, the global
2303 spam-spam-marks variable takes precedence."
2304 :variable-default '((".*" ((gnus-spam-mark))))
2305 :variable-group spam
2307 "*Groups in which to explicitly set the spam marks to some value."))
2309 (defcustom gnus-group-uncollapsed-levels 1
2310 "Number of group name elements to leave alone when making a short group name."
2311 :group 'gnus-group-visual
2314 (defcustom gnus-group-use-permanent-levels nil
2315 "*If non-nil, once you set a level, Gnus will use this level."
2316 :group 'gnus-group-levels
2321 (defcustom gnus-load-hook nil
2322 "A hook run while Gnus is loaded."
2326 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2327 "A hook called to apply kill files to a group.
2328 This hook is intended to apply a kill file to the selected newsgroup.
2329 The function `gnus-apply-kill-file' is called by default.
2331 Since a general kill file is too heavy to use only for a few
2332 newsgroups, I recommend you to use a lighter hook function. For
2333 example, if you'd like to apply a kill file to articles which contains
2334 a string `rmgroup' in subject in newsgroup `control', you can use the
2337 (setq gnus-apply-kill-hook
2340 (cond ((string-match \"control\" gnus-newsgroup-name)
2341 (gnus-kill \"Subject\" \"rmgroup\")
2342 (gnus-expunge \"X\"))))))"
2343 :group 'gnus-score-kill
2344 :options '(gnus-apply-kill-file)
2347 (defcustom gnus-group-change-level-function nil
2348 "Function run when a group level is changed.
2349 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2350 :group 'gnus-group-levels
2351 :type '(choice (const nil)
2356 (defcustom gnus-visual
2357 '(summary-highlight group-highlight article-highlight
2359 summary-menu group-menu article-menu
2360 tree-highlight menu highlight
2361 browse-menu server-menu
2362 page-marker tree-menu binary-menu pick-menu
2364 "*Enable visual features.
2365 If `visual' is disabled, there will be no menus and few faces. Most of
2366 the visual customization options below will be ignored. Gnus will use
2367 less space and be faster as a result.
2369 This variable can also be a list of visual elements to switch on. For
2370 instance, to switch off all visual things except menus, you can say:
2372 (setq gnus-visual '(menu))
2374 Valid elements include `summary-highlight', `group-highlight',
2375 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2376 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2377 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2378 and `grouplens-menu'."
2381 :type '(set (const summary-highlight)
2382 (const group-highlight)
2383 (const article-highlight)
2385 (const summary-menu)
2387 (const article-menu)
2388 (const tree-highlight)
2397 (const grouplens-menu)))
2399 ;; Byte-compiler warning.
2400 (defvar gnus-visual)
2401 ;; Find out whether the gnus-visual TYPE is wanted.
2402 (defun gnus-visual-p (&optional type class)
2403 (and gnus-visual ; Has to be non-nil, at least.
2404 (if (not type) ; We don't care about type.
2406 (if (listp gnus-visual) ; It's a list, so we check it.
2407 (or (memq type gnus-visual)
2408 (memq class gnus-visual))
2411 (defcustom gnus-mouse-face
2413 (if (gnus-visual-p 'mouse-face 'highlight)
2414 (if (boundp 'gnus-mouse-face)
2415 (or gnus-mouse-face 'highlight)
2419 "*Face used for group or summary buffer mouse highlighting.
2420 The line beneath the mouse pointer will be highlighted with this
2425 (defcustom gnus-article-save-directory gnus-directory
2426 "*Name of the directory articles will be saved in (default \"~/News\")."
2427 :group 'gnus-article-saving
2430 (defvar gnus-plugged t
2431 "Whether Gnus is plugged or not.")
2433 (defcustom gnus-agent-cache t
2434 "Controls use of the agent cache while plugged.
2435 When set, Gnus will prefer using the locally stored content rather
2436 than re-fetching it from the server. You also need to enable
2437 `gnus-agent' for this to have any affect."
2442 (defcustom gnus-default-charset 'undecided
2443 "Default charset assumed to be used when viewing non-ASCII characters.
2444 This variable is overridden on a group-to-group basis by the
2445 `gnus-group-charset-alist' variable and is only used on groups not
2446 covered by that variable."
2448 :group 'gnus-charset)
2450 ;; Fixme: Doc reference to agent.
2451 (defcustom gnus-agent t
2452 "Whether we want to use the Gnus agent or not.
2454 You may customize gnus-agent to disable its use. However, some
2455 back ends have started to use the agent as a client-side cache.
2456 Disabling the agent may result in noticeable loss of performance."
2461 (defcustom gnus-other-frame-function 'gnus
2462 "Function called by the command `gnus-other-frame'."
2464 :type '(choice (function-item gnus)
2465 (function-item gnus-no-server)
2466 (function-item gnus-slave)
2467 (function-item gnus-slave-no-server)))
2469 (defcustom gnus-other-frame-parameters nil
2470 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2471 This should be an alist for Emacs, or a plist for XEmacs."
2473 :type (if (featurep 'xemacs)
2474 '(repeat (list :inline t :format "%v"
2475 (symbol :tag "Property")
2476 (sexp :tag "Value")))
2477 '(repeat (cons :format "%v"
2478 (symbol :tag "Parameter")
2479 (sexp :tag "Value")))))
2481 (defcustom gnus-user-agent '(emacs gnus type)
2482 "Which information should be exposed in the User-Agent header.
2484 Can be a list of symbols or a string. Valid symbols are `gnus'
2485 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2486 addition to the Emacs version, you can add `codename' \(show
2487 \(S\)XEmacs codename\) or either `config' \(show system
2488 configuration\) or `type' \(show system type\). If you set it to
2489 a string, be sure to use a valid format, see RFC 2616."
2492 :group 'gnus-message
2493 :type '(choice (list (set :inline t
2494 (const gnus :tag "Gnus version")
2495 (const emacs :tag "Emacs version")
2496 (choice :tag "system"
2497 (const type :tag "system type")
2498 (const config :tag "system configuration"))
2499 (const codename :tag "Emacs codename")))
2502 ;; Convert old (No Gnus < 2005-01-10, v5-10 < 2005-09-05) symbol type values:
2503 (when (symbolp gnus-user-agent)
2504 (setq gnus-user-agent
2505 (cond ((eq gnus-user-agent 'emacs-gnus-config)
2506 '(emacs gnus config))
2507 ((eq gnus-user-agent 'emacs-gnus-type)
2509 ((eq gnus-user-agent 'emacs-gnus)
2511 ((eq gnus-user-agent 'gnus)
2513 (t gnus-user-agent)))
2514 (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2516 (if (get 'gnus-user-agent 'saved-value)
2517 (customize-save-variable 'gnus-user-agent gnus-user-agent)
2518 (gnus-message 1 "Edit your init file to make this change permanent.")
2522 ;;; Internal variables
2524 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2525 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2526 (defvar gnus-agent-method-p-cache nil
2527 ; Reset each time gnus-agent-covered-methods is changed else
2528 ; gnus-agent-method-p may mis-report a methods status.
2530 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2531 (defvar gnus-draft-meta-information-header "X-Draft-From")
2532 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2533 (defvar gnus-original-article-buffer " *Original Article*")
2534 (defvar gnus-newsgroup-name nil)
2535 (defvar gnus-ephemeral-servers nil)
2536 (defvar gnus-server-method-cache nil)
2538 (defvar gnus-agent-fetching nil
2539 "Whether Gnus agent is in fetching mode.")
2541 (defvar gnus-agent-covered-methods nil
2542 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2544 (defvar gnus-command-method nil
2545 "Dynamically bound variable that says what the current back end is.")
2547 (defvar gnus-current-select-method nil
2548 "The current method for selecting a newsgroup.")
2550 (defvar gnus-tree-buffer "*Tree*"
2551 "Buffer where Gnus thread trees are displayed.")
2554 (defvar gnus-use-generic-from nil)
2556 ;; Variable holding the user answers to all method prompts.
2557 (defvar gnus-method-history nil)
2559 ;; Variable holding the user answers to all mail method prompts.
2560 (defvar gnus-mail-method-history nil)
2562 ;; Variable holding the user answers to all group prompts.
2563 (defvar gnus-group-history nil)
2565 (defvar gnus-server-alist nil
2566 "List of available servers.")
2568 (defcustom gnus-cache-directory
2569 (nnheader-concat gnus-directory "cache/")
2570 "*The directory where cached articles will be stored."
2574 (defvar gnus-predefined-server-alist
2577 (nnspool-spool-directory ,gnus-cache-directory)
2578 (nnspool-nov-directory ,gnus-cache-directory)
2579 (nnspool-active-file
2580 ,(nnheader-concat gnus-cache-directory "active"))))
2581 "List of predefined (convenience) servers.")
2583 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2585 (defconst gnus-article-mark-lists
2586 '((marked . tick) (replied . reply)
2587 (expirable . expire) (killed . killed)
2588 (bookmarks . bookmark) (dormant . dormant)
2589 (scored . score) (saved . save)
2590 (cached . cache) (downloadable . download)
2591 (unsendable . unsend) (forwarded . forward)
2592 (recent . recent) (seen . seen)))
2594 (defconst gnus-article-special-mark-lists
2600 ;; Propagate flags to server, with the following exceptions:
2601 ;; `seen' is private to each gnus installation
2602 ;; `cache' is a internal gnus flag for each gnus installation
2603 ;; `download' is a agent flag private to each gnus installation
2604 ;; `unsend' are for nndraft groups only
2605 ;; `score' is not a proper mark
2606 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2607 (defconst gnus-article-unpropagated-mark-lists
2608 '(seen cache download unsend score bookmark)
2609 "Marks that shouldn't be propagated to back ends.
2610 Typical marks are those that make no sense in a standalone back end,
2611 such as a mark that says whether an article is stored in the cache
2612 \(which doesn't make sense in a standalone back end).")
2614 (defvar gnus-headers-retrieved-by nil)
2615 (defvar gnus-article-reply nil)
2616 (defvar gnus-override-method nil)
2617 (defvar gnus-article-check-size nil)
2618 (defvar gnus-opened-servers nil)
2620 (defvar gnus-current-kill-article nil)
2622 (defvar gnus-have-read-active-file nil)
2624 (defconst gnus-maintainer
2625 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2626 "The mail address of the Gnus maintainers.")
2628 (defvar gnus-info-nodes
2629 '((gnus-group-mode "(gnus)Group Buffer")
2630 (gnus-summary-mode "(gnus)Summary Buffer")
2631 (gnus-article-mode "(gnus)Article Buffer")
2632 (gnus-server-mode "(gnus)Server Buffer")
2633 (gnus-browse-mode "(gnus)Browse Foreign Server")
2634 (gnus-tree-mode "(gnus)Tree Display"))
2635 "Alist of major modes and related Info nodes.")
2637 (defvar gnus-group-buffer "*Group*")
2638 (defvar gnus-summary-buffer "*Summary*")
2639 (defvar gnus-article-buffer "*Article*")
2640 (defvar gnus-server-buffer "*Server*")
2642 (defvar gnus-slave nil
2643 "Whether this Gnus is a slave or not.")
2645 (defvar gnus-batch-mode nil
2646 "Whether this Gnus is running in batch mode or not.")
2648 (defvar gnus-variable-list
2649 '(gnus-newsrc-options gnus-newsrc-options-n
2650 gnus-newsrc-last-checked-date
2651 gnus-newsrc-alist gnus-server-alist
2652 gnus-killed-list gnus-zombie-list
2653 gnus-topic-topology gnus-topic-alist
2655 "Gnus variables saved in the quick startup file.")
2657 (defvar gnus-newsrc-alist nil
2658 "Assoc list of read articles.
2659 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2661 (defvar gnus-registry-alist nil
2662 "Assoc list of registry data.
2663 gnus-registry.el will populate this if it's loaded.")
2665 (defvar gnus-newsrc-hashtb nil
2666 "Hashtable of `gnus-newsrc-alist'.")
2668 (defvar gnus-killed-list nil
2669 "List of killed newsgroups.")
2671 (defvar gnus-killed-hashtb nil
2672 "Hash table equivalent of `gnus-killed-list'.")
2674 (defvar gnus-zombie-list nil
2675 "List of almost dead newsgroups.")
2677 (defvar gnus-description-hashtb nil
2678 "Descriptions of newsgroups.")
2680 (defvar gnus-list-of-killed-groups nil
2681 "List of newsgroups that have recently been killed by the user.")
2683 (defvar gnus-active-hashtb nil
2684 "Hashtable of active articles.")
2686 (defvar gnus-moderated-hashtb nil
2687 "Hashtable of moderated newsgroups.")
2689 ;; Save window configuration.
2690 (defvar gnus-prev-winconf nil)
2692 (defvar gnus-reffed-article-number nil)
2694 ;;; Let the byte-compiler know that we know about this variable.
2695 (defvar rmail-default-rmail-file)
2697 (defvar gnus-dead-summary nil)
2699 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2700 "Regexp matching invalid groups.")
2702 (defvar gnus-other-frame-object nil
2703 "A frame object which will be created by `gnus-other-frame'.")
2705 ;;; End of variables.
2707 ;; Define some autoload functions Gnus might use.
2710 ;; This little mapcar goes through the list below and marks the
2711 ;; symbols in question as autoloaded functions.
2714 (let ((interactive (nth 1 (memq ':interactive package))))
2718 (when (consp function)
2719 (setq keymap (car (memq 'keymap function)))
2720 (setq function (car function)))
2721 (unless (fboundp function)
2722 (autoload function (car package) nil interactive keymap))))
2723 (if (eq (nth 1 package) ':interactive)
2726 '(("info" :interactive t Info-goto-node)
2728 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2729 ("ps-print" ps-print-preprint)
2730 ("message" :interactive t
2731 message-send-and-exit message-yank-original)
2732 ("babel" babel-as-string)
2733 ("nnmail" nnmail-split-fancy nnmail-article-group)
2734 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2735 ("rmailout" rmail-output rmail-output-to-rmail-file)
2736 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2737 rmail-show-message rmail-summary-exists
2738 rmail-select-summary rmail-update-summary)
2739 ("gnus-audio" :interactive t gnus-audio-play)
2740 ("gnus-xmas" gnus-xmas-splash)
2741 ("gnus-soup" :interactive t
2742 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2743 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2744 ("nnsoup" nnsoup-pack-replies)
2745 ("score-mode" :interactive t gnus-score-mode)
2746 ("gnus-mh" gnus-summary-save-article-folder
2747 gnus-Folder-save-name gnus-folder-save-name)
2748 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2749 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2750 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2751 gnus-demon-add-disconnection gnus-demon-add-handler
2752 gnus-demon-remove-handler)
2753 ("gnus-demon" :interactive t
2754 gnus-demon-init gnus-demon-cancel)
2755 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2756 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2757 gnus-face-from-file)
2758 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2759 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2760 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2761 gnus-nocem-unwanted-article-p)
2762 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2763 gnus-server-server-name)
2764 ("gnus-srvr" gnus-browse-foreign-server)
2765 ("gnus-cite" :interactive t
2766 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2767 gnus-article-hide-citation gnus-article-fill-cited-article
2768 gnus-article-hide-citation-in-followups)
2769 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2770 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2771 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2772 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2773 gnus-cache-possibly-remove-articles gnus-cache-request-article
2774 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2775 gnus-cache-enter-remove-article gnus-cached-article-p
2776 gnus-cache-open gnus-cache-close gnus-cache-update-article
2777 gnus-cache-articles-in-group)
2778 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2779 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2780 ("gnus-score" :interactive t
2781 gnus-summary-increase-score gnus-summary-set-score
2782 gnus-summary-raise-thread gnus-summary-raise-same-subject
2783 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2784 gnus-summary-lower-thread gnus-summary-lower-same-subject
2785 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2786 gnus-summary-current-score gnus-score-delta-default
2787 gnus-score-flush-cache gnus-score-close
2788 gnus-possibly-score-headers gnus-score-followup-article
2789 gnus-score-followup-thread)
2791 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2792 gnus-current-score-file-nondirectory gnus-score-adaptive
2793 gnus-score-find-trace gnus-score-file-name)
2794 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2795 ("gnus-topic" :interactive t gnus-topic-mode)
2796 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2797 gnus-subscribe-topics)
2798 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2799 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2800 ("gnus-uu" :interactive t
2801 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2802 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2803 gnus-uu-mark-by-regexp gnus-uu-mark-all
2804 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2805 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2806 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2807 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2808 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2809 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2810 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2811 gnus-uu-mark-over gnus-uu-post-news)
2812 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2813 ("gnus-msg" (gnus-summary-send-map keymap)
2814 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2815 ("gnus-msg" :interactive t
2816 gnus-group-post-news gnus-group-mail gnus-group-news
2817 gnus-summary-post-news gnus-summary-news-other-window
2818 gnus-summary-followup gnus-summary-followup-with-original
2819 gnus-summary-cancel-article gnus-summary-supersede-article
2820 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2821 gnus-summary-mail-forward gnus-summary-mail-other-window
2822 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2823 gnus-summary-wide-reply gnus-summary-followup-to-mail
2824 gnus-summary-followup-to-mail-with-original gnus-bug
2825 gnus-summary-wide-reply-with-original
2826 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2827 gnus-summary-post-forward)
2828 ("gnus-picon" :interactive t gnus-treat-from-picon)
2829 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2830 gnus-grouplens-mode)
2831 ("smiley" :interactive t smiley-region)
2832 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2833 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2834 gnus-list-of-unread-articles gnus-list-of-read-articles
2835 gnus-offer-save-summaries gnus-make-thread-indent-array
2836 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2837 gnus-summary-skip-intangible gnus-summary-article-number
2838 gnus-data-header gnus-data-find)
2839 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2840 gnus-group-list-groups gnus-group-first-unread-group
2841 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2842 gnus-group-setup-buffer gnus-group-get-new-news
2843 gnus-group-make-help-group gnus-group-update-group
2844 gnus-group-iterate gnus-group-group-name)
2845 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2846 gnus-backlog-remove-article)
2847 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2848 gnus-article-prepare gnus-article-set-window-start
2849 gnus-article-next-page gnus-article-prev-page
2850 gnus-request-article-this-buffer gnus-article-mode
2851 gnus-article-setup-buffer gnus-narrow-to-page
2852 gnus-article-delete-invisible-text gnus-treat-article)
2853 ("gnus-art" :interactive t
2854 gnus-article-hide-headers gnus-article-hide-boring-headers
2855 gnus-article-treat-overstrike
2856 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2857 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2858 gnus-article-de-base64-unreadable
2859 gnus-article-decode-HZ
2860 gnus-article-wash-html
2861 gnus-article-unsplit-urls
2862 gnus-article-hide-pem gnus-article-hide-signature
2863 gnus-article-strip-leading-blank-lines gnus-article-date-local
2864 gnus-article-date-original gnus-article-date-lapsed
2865 ;; gnus-article-show-all-headers
2866 gnus-article-edit-mode gnus-article-edit-article
2867 gnus-article-edit-done gnus-article-decode-encoded-words
2868 gnus-start-date-timer gnus-stop-date-timer
2869 gnus-mime-view-all-parts)
2870 ("gnus-int" gnus-request-type)
2871 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2872 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2873 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2874 gnus-dup-enter-articles)
2875 ("gnus-range" gnus-copy-sequence)
2876 ("gnus-eform" gnus-edit-form)
2877 ("gnus-move" :interactive t
2878 gnus-group-move-group-to-server gnus-change-server)
2879 ("gnus-logic" gnus-score-advanced)
2880 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2881 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2882 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2883 gnus-async-halt-prefetch)
2884 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2885 gnus-agent-save-active gnus-agent-method-p
2886 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2887 gnus-summary-set-agent-mark gnus-agent-save-group-info
2888 gnus-agent-request-article gnus-agent-retrieve-headers)
2889 ("gnus-agent" :interactive t
2890 gnus-unplugged gnus-agentize gnus-agent-batch)
2891 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2892 gnus-summary-save-article-vm)
2893 ("compface" uncompface)
2894 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2895 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2896 ("gnus-mlspl" :interactive t gnus-group-split-setup
2897 gnus-group-split-update)
2898 ("gnus-delay" gnus-delay-initialize))))
2900 ;;; gnus-sum.el thingies
2903 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2904 "*The format specification of the lines in the summary buffer.
2906 It works along the same lines as a normal formatting string,
2907 with some simple extensions.
2909 %N Article number, left padded with spaces (string)
2911 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2912 %n Name of the poster (string)
2913 %a Extracted name of the poster (string)
2914 %A Extracted address of the poster (string)
2915 %F Contents of the From: header (string)
2916 %f Contents of the From: or To: headers (string)
2917 %x Contents of the Xref: header (string)
2918 %D Date of the article (string)
2919 %d Date of the article (string) in DD-MMM format
2920 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2921 %M Message-id of the article (string)
2922 %r References of the article (string)
2923 %c Number of characters in the article (integer)
2924 %k Pretty-printed version of the above (string)
2925 For example, \"1.2k\" or \"0.4M\".
2926 %L Number of lines in the article (integer)
2927 %I Indentation based on thread level (a string of spaces)
2928 %B A complex trn-style thread tree (string)
2929 The variables `gnus-sum-thread-*' can be used for customization.
2930 %T A string with two possible values: 80 spaces if the article
2931 is on thread level two or larger and 0 spaces on level one
2932 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2933 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2934 %[ Opening bracket (character, \"[\" or \"<\")
2935 %] Closing bracket (character, \"]\" or \">\")
2936 %> Spaces of length thread-level (string)
2937 %< Spaces of length (- 20 thread-level) (string)
2938 %i Article score (number)
2939 %z Article zcore (character)
2940 %t Number of articles under the current thread (number).
2941 %e Whether the thread is empty or not (character).
2942 %l GroupLens score (string).
2943 %V Total thread score (number).
2944 %P The line number (number).
2945 %O Download mark (character).
2946 %* If present, indicates desired cursor position
2947 (instead of after first colon).
2948 %u User defined specifier. The next character in the format string should
2949 be a letter. Gnus will call the function gnus-user-format-function-X,
2950 where X is the letter following %u. The function will be passed the
2951 current header as argument. The function should return a string, which
2952 will be inserted into the summary just like information from any other
2955 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2956 with care. For reasons of efficiency, Gnus will compute what column
2957 these characters will end up in, and \"hard-code\" that. This means that
2958 it is invalid to have these specs after a variable-length spec. Well,
2959 you might not be arrested, but your summary buffer will look strange,
2960 which is bad enough.
2962 The smart choice is to have these specs as far to the left as
2965 This restriction may disappear in later versions of Gnus.
2967 General format specifiers can also be used.
2968 See Info node `(gnus)Formatting Variables'."
2969 :link '(custom-manual "(gnus)Formatting Variables")
2971 :group 'gnus-summary-format)
2974 ;;; Skeleton keymaps
2977 (defun gnus-suppress-keymap (keymap)
2978 (suppress-keymap keymap)
2979 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2981 (define-key keymap (pop keys) 'undefined))))
2983 (defvar gnus-article-mode-map
2984 (let ((keymap (make-sparse-keymap)))
2985 (gnus-suppress-keymap keymap)
2987 (defvar gnus-summary-mode-map
2988 (let ((keymap (make-keymap)))
2989 (gnus-suppress-keymap keymap)
2991 (defvar gnus-group-mode-map
2992 (let ((keymap (make-keymap)))
2993 (gnus-suppress-keymap keymap)
2998 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2999 ;; If you want the cursor to go somewhere else, set these two
3000 ;; functions in some startup hook to whatever you want.
3001 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3002 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3004 ;;; Various macros and substs.
3006 (defun gnus-header-from (header)
3007 (mail-header-from header))
3009 (defmacro gnus-gethash (string hashtable)
3010 "Get hash value of STRING in HASHTABLE."
3011 `(symbol-value (intern-soft ,string ,hashtable)))
3013 (defmacro gnus-gethash-safe (string hashtable)
3014 "Get hash value of STRING in HASHTABLE.
3015 Return nil if not defined."
3016 `(let ((sym (intern-soft ,string ,hashtable)))
3017 (and (boundp sym) (symbol-value sym))))
3019 (defmacro gnus-sethash (string value hashtable)
3020 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3021 `(set (intern ,string ,hashtable) ,value))
3022 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3024 (defmacro gnus-group-unread (group)
3025 "Get the currently computed number of unread articles in GROUP."
3026 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3028 (defmacro gnus-group-entry (group)
3029 "Get the newsrc entry for GROUP."
3030 `(gnus-gethash ,group gnus-newsrc-hashtb))
3032 (defmacro gnus-active (group)
3033 "Get active info on GROUP."
3034 `(gnus-gethash ,group gnus-active-hashtb))
3036 (defmacro gnus-set-active (group active)
3037 "Set GROUP's active info."
3038 `(gnus-sethash ,group ,active gnus-active-hashtb))
3040 ;; Info access macros.
3042 (defmacro gnus-info-group (info)
3044 (defmacro gnus-info-rank (info)
3046 (defmacro gnus-info-read (info)
3048 (defmacro gnus-info-marks (info)
3050 (defmacro gnus-info-method (info)
3052 (defmacro gnus-info-params (info)
3055 (defmacro gnus-info-level (info)
3056 `(let ((rank (gnus-info-rank ,info)))
3060 (defmacro gnus-info-score (info)
3061 `(let ((rank (gnus-info-rank ,info)))
3062 (or (and (consp rank) (cdr rank)) 0)))
3064 (defmacro gnus-info-set-group (info group)
3065 `(setcar ,info ,group))
3066 (defmacro gnus-info-set-rank (info rank)
3067 `(setcar (nthcdr 1 ,info) ,rank))
3068 (defmacro gnus-info-set-read (info read)
3069 `(setcar (nthcdr 2 ,info) ,read))
3070 (defmacro gnus-info-set-marks (info marks &optional extend)
3072 `(gnus-info-set-entry ,info ,marks 3)
3073 `(setcar (nthcdr 3 ,info) ,marks)))
3074 (defmacro gnus-info-set-method (info method &optional extend)
3076 `(gnus-info-set-entry ,info ,method 4)
3077 `(setcar (nthcdr 4 ,info) ,method)))
3078 (defmacro gnus-info-set-params (info params &optional extend)
3080 `(gnus-info-set-entry ,info ,params 5)
3081 `(setcar (nthcdr 5 ,info) ,params)))
3083 (defun gnus-info-set-entry (info entry number)
3084 ;; Extend the info until we have enough elements.
3085 (while (<= (length info) number)
3086 (nconc info (list nil)))
3088 (setcar (nthcdr number info) entry))
3090 (defmacro gnus-info-set-level (info level)
3091 `(let ((rank (cdr ,info)))
3092 (if (consp (car rank))
3093 (setcar (car rank) ,level)
3094 (setcar rank ,level))))
3095 (defmacro gnus-info-set-score (info score)
3096 `(let ((rank (cdr ,info)))
3097 (if (consp (car rank))
3098 (setcdr (car rank) ,score)
3099 (setcar rank (cons (car rank) ,score)))))
3101 (defmacro gnus-get-info (group)
3102 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3104 ;;; Load the compatibility functions.
3113 (defvar gnus-shutdown-alist nil)
3115 (defun gnus-add-shutdown (function &rest symbols)
3116 "Run FUNCTION whenever one of SYMBOLS is shut down."
3117 (push (cons function symbols) gnus-shutdown-alist))
3119 (defun gnus-shutdown (symbol)
3120 "Shut down everything that waits for SYMBOL."
3121 (let ((alist gnus-shutdown-alist)
3123 (while (setq entry (pop alist))
3124 (when (memq symbol (cdr entry))
3125 (funcall (car entry))))))
3129 ;;; Gnus Utility Functions
3132 (defun gnus-find-subscribed-addresses ()
3133 "Return a regexp matching the addresses of all subscribed mail groups.
3134 It consists of the `to-address' or `to-list' parameter of all groups
3135 with a `subscribed' parameter."
3136 (let (group address addresses)
3137 (dolist (entry (cdr gnus-newsrc-alist))
3138 (setq group (car entry))
3139 (when (gnus-parameter-subscribed group)
3140 (setq address (mail-strip-quoted-names
3141 (or (gnus-group-fast-parameter group 'to-address)
3142 (gnus-group-fast-parameter group 'to-list))))
3144 (add-to-list 'addresses address))))
3146 (list (mapconcat 'regexp-quote addresses "\\|")))))
3148 (defmacro gnus-string-or (&rest strings)
3149 "Return the first element of STRINGS that is a non-blank string.
3150 STRINGS will be evaluated in normal `or' order."
3151 `(gnus-string-or-1 ',strings))
3153 (defun gnus-string-or-1 (strings)
3156 (setq string (eval (pop strings)))
3157 (if (string-match "^[ \t]*$" string)
3159 (setq strings nil)))
3162 (defun gnus-version (&optional arg)
3163 "Version number of this version of Gnus.
3164 If ARG, insert string at point."
3167 (insert (message gnus-version))
3168 (message gnus-version)))
3170 (defun gnus-continuum-version (&optional version)
3171 "Return VERSION as a floating point number."
3174 (setq version gnus-version))
3175 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3176 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3177 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3178 (number (match-string 2 version))
3180 (unless (string-match
3181 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3182 (error "Invalid version string: %s" version))
3183 (setq major (string-to-number (match-string 1 number))
3184 minor (string-to-number (match-string 2 number))
3185 least (if (match-beginning 3)
3186 (string-to-number (match-string 3 number))
3190 (format "%s00%02d%02d"
3191 (if (member alpha '("(ding)" "d"))
3195 (- (mm-char-int (aref (downcase alpha) 0))
3199 (format "%d.%02d%02d" major minor least))))))
3201 (defun gnus-info-find-node (&optional nodename)
3202 "Find Info documentation of Gnus."
3204 ;; Enlarge info window if needed.
3205 (let (gnus-info-buffer)
3206 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3207 (setq gnus-info-buffer (current-buffer))
3208 (gnus-configure-windows 'info)))
3211 ;;; gnus-interactive
3214 (defvar gnus-current-prefix-symbol nil
3215 "Current prefix symbol.")
3217 (defvar gnus-current-prefix-symbols nil
3218 "List of current prefix symbols.")
3220 (defun gnus-interactive (string &optional params)
3221 "Return a list that can be fed to `interactive'.
3222 See `interactive' for full documentation.
3224 Adds the following specs:
3226 y -- The current symbolic prefix.
3227 Y -- A list of the current symbolic prefix(es).
3228 A -- Article number.
3229 H -- Article header.
3233 (while (< i (length string))
3234 (string-match ".\\([^\n]*\\)\n?" string i)
3235 (setq c (aref string i))
3237 (setq prompt (match-string 1 string)))
3238 (setq i (match-end 0))
3239 ;; We basically emulate just about everything that
3240 ;; `interactive' does, but add the specs listed above.
3244 (completing-read prompt obarray 'fboundp t))
3246 (read-buffer prompt (current-buffer) t))
3248 (read-buffer prompt (other-buffer (current-buffer))))
3252 (completing-read prompt obarray 'commandp t))
3256 (read-file-name prompt nil default-directory 'lambda))
3258 (read-file-name prompt nil nil 'lambda))
3260 (read-file-name prompt))
3262 (read-key-sequence prompt))
3264 (error "Not implemented spec"))
3266 (error "Not implemented spec"))
3270 (error "Not implemented spec"))
3272 (string-to-number (read-from-minibuffer prompt)))
3274 (prefix-numeric-value current-prefix-arg))
3280 (read-string prompt))
3282 (intern (read-string prompt)))
3284 (read-variable prompt))
3286 (read-minibuffer prompt))
3288 (eval-minibuffer prompt))
3289 ;; And here the new specs come.
3291 gnus-current-prefix-symbol)
3293 gnus-current-prefix-symbols)
3295 (gnus-group-group-name))
3297 (gnus-summary-skip-intangible)
3298 (or (get-text-property (point) 'gnus-number)
3299 (gnus-summary-last-subject)))
3301 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3303 (error "Non-implemented spec")))
3307 (push (if (< (point) (mark)) (point) (mark)) out)
3308 (push (if (> (point) (mark)) (point) (mark)) out))))
3309 (setq out (delq 'gnus-prefix-nil out))
3312 (defun gnus-symbolic-argument (&optional arg)
3313 "Read a symbolic argument and a command, and then execute command."
3315 (let* ((in-command (this-command-keys))
3316 (command in-command)
3317 gnus-current-prefix-symbols
3318 gnus-current-prefix-symbol
3320 (while (equal in-command command)
3321 (message "%s-" (key-description (this-command-keys)))
3322 (push (intern (char-to-string (read-char))) syms)
3323 (setq command (read-key-sequence nil t)))
3324 (setq gnus-current-prefix-symbols (nreverse syms)
3325 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3326 (call-interactively (key-binding command t))))
3328 ;;; More various functions.
3330 (defsubst gnus-check-backend-function (func group)
3331 "Check whether GROUP supports function FUNC.
3332 GROUP can either be a string (a group name) or a select method."
3334 (let ((method (if (stringp group)
3335 (car (gnus-find-method-for-group group))
3337 (unless (featurep method)
3339 (fboundp (intern (format "%s-%s" method func))))))
3341 (defun gnus-group-read-only-p (&optional group)
3342 "Check whether GROUP supports editing or not.
3343 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3344 that that variable is buffer-local to the summary buffers."
3345 (let ((group (or group gnus-newsgroup-name)))
3346 (not (gnus-check-backend-function 'request-replace-article group))))
3348 (defun gnus-virtual-group-p (group)
3349 "Say whether GROUP is virtual or not."
3350 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3351 gnus-valid-select-methods)))
3353 (defun gnus-news-group-p (group &optional article)
3354 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3355 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3356 t) ;is news of course.
3357 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3358 nil) ;must be mail then.
3359 ((vectorp article) ;Has header info.
3360 (eq (gnus-request-type group (mail-header-id article)) 'news))
3361 ((null article) ;Hasn't header info
3362 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3363 ((< article 0) ;Virtual message
3364 nil) ;we don't know, guess mail.
3365 (t ;Has positive number
3366 (eq (gnus-request-type group article) 'news)))) ;use it.
3368 ;; Returns a list of writable groups.
3369 (defun gnus-writable-groups ()
3370 (let ((alist gnus-newsrc-alist)
3372 (while (setq group (car (pop alist)))
3373 (unless (gnus-group-read-only-p group)
3374 (push group groups)))
3377 ;; Check whether to use long file names.
3378 (defun gnus-use-long-file-name (symbol)
3379 ;; The variable has to be set...
3380 (and gnus-use-long-file-name
3381 ;; If it isn't a list, then we return t.
3382 (or (not (listp gnus-use-long-file-name))
3383 ;; If it is a list, and the list contains `symbol', we
3385 (not (memq symbol gnus-use-long-file-name)))))
3387 ;; Generate a unique new group name.
3388 (defun gnus-generate-new-group-name (leaf)
3391 (while (gnus-gethash name gnus-newsrc-hashtb)
3392 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3395 (defun gnus-ephemeral-group-p (group)
3396 "Say whether GROUP is ephemeral or not."
3397 (gnus-group-get-parameter group 'quit-config t))
3399 (defun gnus-group-quit-config (group)
3400 "Return the quit-config of GROUP."
3401 (gnus-group-get-parameter group 'quit-config t))
3403 (defun gnus-kill-ephemeral-group (group)
3404 "Remove ephemeral GROUP from relevant structures."
3405 (gnus-sethash group nil gnus-newsrc-hashtb))
3407 (defun gnus-simplify-mode-line ()
3408 "Make mode lines a bit simpler."
3409 (setq mode-line-modified (cdr gnus-mode-line-modified))
3410 (when (listp mode-line-format)
3411 (make-local-variable 'mode-line-format)
3412 (setq mode-line-format (copy-sequence mode-line-format))
3413 (when (equal (nth 3 mode-line-format) " ")
3414 (setcar (nthcdr 3 mode-line-format) " "))))
3416 ;;; Servers and groups.
3418 (defsubst gnus-server-add-address (method)
3419 (let ((method-name (symbol-name (car method))))
3420 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3421 (not (assq (intern (concat method-name "-address")) method))
3422 (memq 'physical-address (assq (car method)
3423 gnus-valid-select-methods)))
3424 (append method (list (list (intern (concat method-name "-address"))
3428 (defsubst gnus-method-to-server (method)
3430 (setq method (or method gnus-select-method))
3432 ;; Perhaps it is already in the cache.
3433 (mapc (lambda (name-method)
3434 (if (equal (cdr name-method) method)
3435 (throw 'server-name (car name-method))))
3436 gnus-server-method-cache)
3439 (lambda (server-alist)
3440 (mapc (lambda (name-method)
3441 (when (gnus-methods-equal-p (cdr name-method) method)
3442 (unless (member name-method gnus-server-method-cache)
3443 (push name-method gnus-server-method-cache))
3444 (throw 'server-name (car name-method))))
3446 (let ((alists (list gnus-server-alist
3447 gnus-predefined-server-alist)))
3448 (if gnus-select-method
3449 (push (list (cons "native" gnus-select-method)) alists))
3452 (let* ((name (if (member (cadr method) '(nil ""))
3453 (format "%s" (car method))
3454 (format "%s:%s" (car method) (cadr method))))
3455 (name-method (cons name method)))
3456 (unless (member name-method gnus-server-method-cache)
3457 (push name-method gnus-server-method-cache))
3460 (defsubst gnus-server-to-method (server)
3461 "Map virtual server names to select methods."
3462 (or (and server (listp server) server)
3463 (cdr (assoc server gnus-server-method-cache))
3466 ;; Perhaps this is the native server?
3467 (and (equal server "native") gnus-select-method)
3468 ;; It should be in the server alist.
3469 (cdr (assoc server gnus-server-alist))
3470 ;; It could be in the predefined server alist.
3471 (cdr (assoc server gnus-predefined-server-alist))
3472 ;; If not, we look through all the opened server
3473 ;; to see whether we can find it there.
3474 (let ((opened gnus-opened-servers))
3476 (not (equal server (format "%s:%s" (caaar opened)
3480 ;; It could be a named method, search all servers
3481 (let ((servers gnus-secondary-select-methods))
3483 (not (equal server (format "%s:%s" (caar servers)
3487 ;; This could be some sort of foreign server that I
3488 ;; simply haven't opened (yet). Do a brute-force scan
3489 ;; of the entire gnus-newsrc-alist for the server name
3490 ;; of every method. As a side-effect, loads the
3491 ;; gnus-server-method-cache so this only happens once,
3496 (let ((info-method (gnus-info-method info)))
3497 (unless (stringp info-method)
3498 (let ((info-server (gnus-method-to-server info-method)))
3499 (when (equal server info-server)
3500 (setq match info-method))))))
3501 (cdr gnus-newsrc-alist))
3504 (push (cons server result) gnus-server-method-cache))
3507 (defsubst gnus-server-get-method (group method)
3508 ;; Input either a server name, and extended server name, or a
3509 ;; select method, and return a select method.
3510 (cond ((stringp method)
3511 (gnus-server-to-method method))
3512 ((equal method gnus-select-method)
3514 ((and (stringp (car method))
3516 (gnus-server-extend-method group method))
3519 (equal (cadr method) ""))
3522 (gnus-server-add-address method))))
3524 (defmacro gnus-method-equal (ss1 ss2)
3525 "Say whether two servers are equal."
3529 (and (= (length s1) (length s2))
3531 (while (and s1 (member (car s1) s2))
3535 (defun gnus-methods-equal-p (m1 m2)
3536 (let ((m1 (or m1 gnus-select-method))
3537 (m2 (or m2 gnus-select-method)))
3539 (and (eq (car m1) (car m2))
3540 (or (not (memq 'address (assoc (symbol-name (car m1))
3541 gnus-valid-select-methods)))
3542 (equal (nth 1 m1) (nth 1 m2)))))))
3544 (defun gnus-server-equal (m1 m2)
3545 "Say whether two methods are equal."
3546 (let ((m1 (cond ((null m1) gnus-select-method)
3547 ((stringp m1) (gnus-server-to-method m1))
3549 (m2 (cond ((null m2) gnus-select-method)
3550 ((stringp m2) (gnus-server-to-method m2))
3552 (gnus-method-equal m1 m2)))
3554 (defun gnus-servers-using-backend (backend)
3555 "Return a list of known servers using BACKEND."
3556 (let ((opened gnus-opened-servers)
3559 (when (eq backend (caaar opened))
3560 (push (caar opened) out))
3564 (defun gnus-archive-server-wanted-p ()
3565 "Say whether the user wants to use the archive server."
3567 ((or (not gnus-message-archive-method)
3568 (not gnus-message-archive-group))
3570 ((and gnus-message-archive-method gnus-message-archive-group)
3573 (let ((active (cadr (assq 'nnfolder-active-file
3574 gnus-message-archive-method))))
3576 (file-exists-p active))))))
3578 (defsubst gnus-method-to-server-name (method)
3580 (format "%s" (car method))
3582 (or (assoc (format "%s" (car method))
3583 (gnus-methods-using 'address))
3584 (gnus-server-equal method gnus-message-archive-method))
3586 (not (string= (nth 1 method) "")))
3587 (concat "+" (nth 1 method)))))
3589 (defsubst gnus-method-to-full-server-name (method)
3590 (format "%s+%s" (car method) (nth 1 method)))
3592 (defun gnus-group-prefixed-name (group method &optional full)
3593 "Return the whole name from GROUP and METHOD.
3594 Call with full set to get the fully qualified group name (even if the
3596 (when (stringp method)
3597 (setq method (gnus-server-to-method method)))
3598 (if (or (not method)
3599 (and (not full) (gnus-server-equal method "native"))
3600 ;;;!!! This might not be right. We'll see...
3601 ;(string-match ":" group)
3604 (concat (gnus-method-to-server-name method) ":" group)))
3606 (defun gnus-group-guess-prefixed-name (group)
3607 "Guess the whole name from GROUP and METHOD."
3608 (gnus-group-prefixed-name group (gnus-find-method-for-group
3611 (defun gnus-group-full-name (group method)
3612 "Return the full name from GROUP and METHOD, even if the method is native."
3613 (gnus-group-prefixed-name group method t))
3615 (defun gnus-group-guess-full-name (group)
3616 "Guess the full name from GROUP, even if the method is native."
3617 (if (gnus-group-prefixed-p group)
3619 (gnus-group-full-name group (gnus-find-method-for-group group))))
3621 (defun gnus-group-guess-full-name-from-command-method (group)
3622 "Guess the full name from GROUP, even if the method is native."
3623 (if (gnus-group-prefixed-p group)
3625 (gnus-group-full-name group gnus-command-method)))
3627 (defun gnus-group-real-prefix (group)
3628 "Return the prefix of the current group name."
3630 (if (string-match "^[^:]+:" group)
3631 (substring group 0 (match-end 0))
3635 (defun gnus-group-short-name (group)
3636 "Return the short group name."
3637 (let ((prefix (gnus-group-real-prefix group)))
3638 (if (< 0 (length prefix))
3639 (substring group (length prefix) nil)
3642 (defun gnus-group-prefixed-p (group)
3643 "Return the prefix of the current group name."
3644 (< 0 (length (gnus-group-real-prefix group))))
3646 (defun gnus-summary-buffer-name (group)
3647 "Return the summary buffer name of GROUP."
3648 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3650 (defun gnus-group-method (group)
3651 "Return the server or method used for selecting GROUP.
3652 You should probably use `gnus-find-method-for-group' instead."
3653 (let ((prefix (gnus-group-real-prefix group)))
3654 (if (equal prefix "")
3656 (let ((servers gnus-opened-servers)
3658 backend possible found)
3659 (if (string-match "^[^\\+]+\\+" prefix)
3660 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3661 server (substring prefix (match-end 0) (1- (length prefix))))
3662 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3664 (when (eq (caaar servers) backend)
3665 (setq possible (caar servers))
3666 (when (equal (cadaar servers) server)
3667 (setq found (caar servers))))
3669 (or (car (rassoc found gnus-server-alist))
3671 (car (rassoc possible gnus-server-alist))
3673 (list backend server))))))
3675 (defsubst gnus-native-method-p (method)
3676 "Return whether METHOD is the native select method."
3677 (gnus-method-equal method gnus-select-method))
3679 (defsubst gnus-secondary-method-p (method)
3680 "Return whether METHOD is a secondary select method."
3681 (let ((methods gnus-secondary-select-methods)
3682 (gmethod (inline (gnus-server-get-method nil method))))
3684 (not (gnus-method-equal
3685 (inline (gnus-server-get-method nil (car methods)))
3687 (setq methods (cdr methods)))
3690 (defun gnus-method-simplify (method)
3691 "Return the shortest uniquely identifying string or method for METHOD."
3692 (cond ((stringp method)
3694 ((gnus-native-method-p method)
3696 ((gnus-secondary-method-p method)
3697 (format "%s:%s" (nth 0 method) (nth 1 method)))
3701 (defun gnus-groups-from-server (server)
3702 "Return a list of all groups that are fetched from SERVER."
3703 (let ((alist (cdr gnus-newsrc-alist))
3705 (while (setq info (pop alist))
3706 (when (gnus-server-equal (gnus-info-method info) server)
3707 (push (gnus-info-group info) groups)))
3708 (sort groups 'string<)))
3710 (defun gnus-group-foreign-p (group)
3711 "Say whether a group is foreign or not."
3712 (and (not (gnus-group-native-p group))
3713 (not (gnus-group-secondary-p group))))
3715 (defun gnus-group-native-p (group)
3716 "Say whether the group is native or not."
3717 (not (string-match ":" group)))
3719 (defun gnus-group-secondary-p (group)
3720 "Say whether the group is secondary or not."
3721 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3723 (defun gnus-parameters-get-parameter (group)
3724 "Return the group parameters for GROUP from `gnus-parameters'."
3726 (dolist (elem gnus-parameters)
3727 (when (string-match (car elem) group)
3729 (nconc (gnus-expand-group-parameters
3730 (car elem) (cdr elem) group)
3734 (defun gnus-expand-group-parameter (match value group)
3735 "Use MATCH to expand VALUE in GROUP."
3738 (goto-char (point-min))
3739 (while (re-search-forward match nil t)
3740 (replace-match value))
3743 (defun gnus-expand-group-parameters (match parameters group)
3744 "Go through PARAMETERS and expand them according to the match data."
3746 (dolist (elem parameters)
3747 (if (and (stringp (cdr elem))
3748 (string-match "\\\\[0-9&]" (cdr elem)))
3749 (push (cons (car elem)
3750 (gnus-expand-group-parameter match (cdr elem) group))
3755 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3756 "For GROUP, return the value of SYMBOL.
3758 You should call this in the `gnus-group-buffer' buffer.
3759 The function `gnus-group-find-parameter' will do that for you."
3760 ;; The speed trick: No cons'ing and quit early.
3761 (let* ((params (funcall gnus-group-get-parameter-function group))
3762 ;; Start easy, check the "real" group parameters.
3764 (gnus-group-parameter-value params symbol allow-list t)))
3766 ;; Found results; return them.
3767 (car simple-results)
3768 ;; We didn't found it there, try `gnus-parameters'.
3771 (tail gnus-parameters))
3772 ;; A good old-fashioned non-cl loop.
3774 (setq head (car tail)
3776 ;; The car is regexp matching for matching the group name.
3777 (when (string-match (car head) group)
3778 ;; The cdr is the parameters.
3779 (setq result (gnus-group-parameter-value (cdr head)
3782 ;; Expand if necessary.
3783 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3784 (setq result (gnus-expand-group-parameter (car head)
3786 ;; Exit the loop early.
3791 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3792 "Return the group parameters for GROUP.
3793 If SYMBOL, return the value of that symbol in the group parameters.
3795 If you call this function inside a loop, consider using the faster
3796 `gnus-group-fast-parameter' instead."
3798 (set-buffer gnus-group-buffer)
3800 (gnus-group-fast-parameter group symbol allow-list)
3803 (funcall gnus-group-get-parameter-function group))
3804 (gnus-parameters-get-parameter group)))))
3806 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3807 "Return the group parameters for GROUP.
3808 If SYMBOL, return the value of that symbol in the group parameters.
3809 Most functions should use `gnus-group-find-parameter', which
3810 also examines the topic parameters."
3811 (let ((params (gnus-info-params (gnus-get-info group))))
3813 (gnus-group-parameter-value params symbol allow-list)
3816 (defun gnus-group-parameter-value (params symbol &optional
3817 allow-list present-p)
3818 "Return the value of SYMBOL in group PARAMS."
3819 ;; We only wish to return group parameters (dotted lists) and
3820 ;; not local variables, which may have the same names.
3821 ;; But first we handle single elements...
3822 (or (car (memq symbol params))
3826 (while (setq elem (pop params))
3827 (when (and (consp elem)
3828 (eq (car elem) symbol)
3831 (throw 'found (if present-p (list (cdr elem))
3834 (defun gnus-group-add-parameter (group param)
3835 "Add parameter PARAM to GROUP."
3836 (let ((info (gnus-get-info group)))
3838 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3839 ;; Cons the new param to the old one and update.
3840 (gnus-group-set-info (cons param (gnus-info-params info))
3843 (defun gnus-group-set-parameter (group name value)
3844 "Set parameter NAME to VALUE in GROUP."
3845 (let ((info (gnus-get-info group)))
3847 (gnus-group-remove-parameter group name)
3848 (let ((old-params (gnus-info-params info))
3849 (new-params (list (cons name value))))
3851 (when (or (not (listp (car old-params)))
3852 (not (eq (caar old-params) name)))
3853 (setq new-params (append new-params (list (car old-params)))))
3854 (setq old-params (cdr old-params)))
3855 (gnus-group-set-info new-params group 'params)))))
3857 (defun gnus-group-remove-parameter (group name)
3858 "Remove parameter NAME from GROUP."
3859 (let ((info (gnus-get-info group)))
3861 (let ((params (gnus-info-params info)))
3863 (setq params (delq name params))
3864 (while (assq name params)
3865 (gnus-pull name params))
3866 (gnus-info-set-params info params))))))
3868 (defun gnus-group-add-score (group &optional score)
3869 "Add SCORE to the GROUP score.
3870 If SCORE is nil, add 1 to the score of GROUP."
3871 (let ((info (gnus-get-info group)))
3873 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3875 (defun gnus-short-group-name (group &optional levels)
3876 "Collapse GROUP name LEVELS.
3877 Select methods are stripped and any remote host name is stripped down to
3878 just the host name."
3884 gnus-group-uncollapsed-levels
3886 (while (string-match "\\." group skip)
3887 (setq skip (match-end 0)
3890 ;; Separate foreign select method from group name and collapse.
3891 ;; If method contains a server, collapse to non-domain server name,
3892 ;; otherwise collapse to select method.
3893 (let* ((colon (string-match ":" group))
3894 (server (and colon (substring group 0 colon)))
3895 (plus (and server (string-match "+" server))))
3898 (setq foreign (substring server (+ 1 plus)
3899 (string-match "\\." server))
3900 group (substring group (+ 1 colon)))
3901 (setq foreign server
3902 group (substring group (+ 1 colon))))
3903 (setq foreign (concat foreign ":")))
3904 ;; Collapse group name leaving LEVELS uncollapsed elements
3905 (let* ((slist (split-string group "/"))
3906 (slen (length slist))
3907 (dlist (split-string group "\\."))
3908 (dlen (length dlist))
3920 (setq levels (- glen levels))
3922 (push (if (>= (decf levels) 0)
3923 (if (zerop (length g))
3928 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3930 (defun gnus-narrow-to-body ()
3931 "Narrow to the body of an article."
3934 (goto-char (point-min))
3935 (or (search-forward "\n\n" nil t)
3941 ;;; Kill file handling.
3944 (defun gnus-apply-kill-file ()
3945 "Apply a kill file to the current newsgroup.
3946 Returns the number of articles marked as read."
3947 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3948 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3949 (gnus-apply-kill-file-internal)
3952 (defun gnus-kill-save-kill-buffer ()
3953 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3954 (when (get-file-buffer file)
3956 (set-buffer (get-file-buffer file))
3957 (when (buffer-modified-p)
3959 (kill-buffer (current-buffer))))))
3961 (defcustom gnus-kill-file-name "KILL"
3962 "Suffix of the kill files."
3963 :group 'gnus-score-kill
3964 :group 'gnus-score-files
3967 (defun gnus-newsgroup-kill-file (newsgroup)
3968 "Return the name of a kill file name for NEWSGROUP.
3969 If NEWSGROUP is nil, return the global kill file name instead."
3971 ;; The global KILL file is placed at top of the directory.
3972 ((or (null newsgroup)
3973 (string-equal newsgroup ""))
3974 (expand-file-name gnus-kill-file-name
3975 gnus-kill-files-directory))
3976 ;; Append ".KILL" to newsgroup name.
3977 ((gnus-use-long-file-name 'not-kill)
3978 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3979 "." gnus-kill-file-name)
3980 gnus-kill-files-directory))
3981 ;; Place "KILL" under the hierarchical directory.
3983 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3984 "/" gnus-kill-file-name)
3985 gnus-kill-files-directory))))
3989 (defun gnus-member-of-valid (symbol group)
3990 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3992 (symbol-name (car (gnus-find-method-for-group group)))
3993 gnus-valid-select-methods)))
3995 (defun gnus-method-option-p (method option)
3996 "Return non-nil if select METHOD has OPTION as a parameter."
3997 (when (stringp method)
3998 (setq method (gnus-server-to-method method)))
3999 (memq option (assoc (format "%s" (car method))
4000 gnus-valid-select-methods)))
4002 (defun gnus-similar-server-opened (method)
4003 (let ((opened gnus-opened-servers))
4004 (while (and method opened)
4005 (when (and (equal (cadr method) (cadaar opened))
4006 (equal (car method) (caaar opened))
4007 (not (equal method (caar opened))))
4012 (defun gnus-server-extend-method (group method)
4013 ;; This function "extends" a virtual server. If the server is
4014 ;; "hello", and the select method is ("hello" (my-var "something"))
4015 ;; in the group "alt.alt", this will result in a new virtual server
4016 ;; called "hello+alt.alt".
4017 (if (or (not (inline (gnus-similar-server-opened method)))
4018 (not (cddr method)))
4020 `(,(car method) ,(concat (cadr method) "+" group)
4021 (,(intern (format "%s-address" (car method))) ,(cadr method))
4024 (defun gnus-server-status (method)
4025 "Return the status of METHOD."
4026 (nth 1 (assoc method gnus-opened-servers)))
4028 (defun gnus-group-name-to-method (group)
4029 "Guess a select method based on GROUP."
4030 (if (string-match ":" group)
4031 (let ((server (substring group 0 (match-beginning 0))))
4032 (if (string-match "\\+" server)
4033 (list (intern (substring server 0 (match-beginning 0)))
4034 (substring server (match-end 0)))
4035 (list (intern server) "")))
4036 gnus-select-method))
4038 (defun gnus-server-string (server)
4039 "Return a readable string that describes SERVER."
4040 (let* ((server (gnus-server-to-method server))
4041 (address (nth 1 server)))
4043 (not (zerop (length address))))
4044 (format "%s using %s" address (car server))
4045 (format "%s" (car server)))))
4047 (defun gnus-find-method-for-group (group &optional info)
4048 "Find the select method that GROUP uses."
4049 (or gnus-override-method
4052 (and (not (gnus-group-entry group)) ;; a new group
4053 (gnus-group-name-to-method group))
4054 (let ((info (or info (gnus-get-info group)))
4057 (not (setq method (gnus-info-method info)))
4058 (equal method "native"))
4061 (cond ((stringp method)
4062 (inline (gnus-server-to-method method)))
4063 ((stringp (cadr method))
4064 (inline (gnus-server-extend-method group method)))
4067 (cond ((equal (cadr method) "")
4069 ((null (cadr method))
4070 (list (car method) ""))
4072 (gnus-server-add-address method)))))))
4074 (defun gnus-methods-using (feature)
4075 "Find all methods that have FEATURE."
4076 (let ((valids gnus-valid-select-methods)
4079 (when (memq feature (car valids))
4080 (push (car valids) outs))
4081 (setq valids (cdr valids)))
4085 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4087 (defun gnus-read-group (prompt &optional default)
4088 "Prompt the user for a group name.
4089 Disallow invalid group names."
4094 gnus-invalid-group-regexp
4095 (setq group (read-string (concat prefix prompt)
4096 (cons (or default "") 0)
4097 'gnus-group-history)))
4098 (let ((match (match-string 0 group)))
4099 ;; Might be okay (e.g. for nnimap), so ask the user:
4100 (unless (and (not (string-match "^$\\|:" match))
4102 "Proceed and create group anyway? " t
4103 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4105 Usually, it's dangerous to create a group with this name, because it's not
4106 supported by all back ends and servers. On IMAP servers it should work,
4107 though. If you are really sure, you can proceed anyway and create the group.
4109 You may customize the variable `gnus-invalid-group-regexp', which currently is
4110 set to \"" gnus-invalid-group-regexp
4111 "\", if you want to get rid of this query permanently."))
4112 (setq prefix (format "Invalid group name: \"%s\". " group)
4116 (defun gnus-read-method (prompt)
4117 "Prompt the user for a method.
4118 Allow completion over sensible values."
4119 (let* ((open-servers
4120 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4121 gnus-opened-servers))
4124 (dolist (method gnus-valid-select-methods)
4125 (if (or (memq 'prompt-address method)
4126 (not (assoc (format "%s:" (car method)) open-servers)))
4127 (push method methods)))
4130 (append valid-methods
4132 gnus-predefined-server-alist
4137 nil t nil 'gnus-method-history)))
4140 (setq method gnus-select-method))
4141 ((assoc method gnus-valid-select-methods)
4142 (let ((address (if (memq 'prompt-address
4143 (assoc method gnus-valid-select-methods))
4144 (read-string "Address: ")
4146 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4147 (list (intern method) address))))
4148 ((assoc method servers)
4151 (list (intern method) "")))))
4155 (defun gnus-agent-method-p (method)
4156 "Say whether METHOD is covered by the agent."
4157 (or (eq (car gnus-agent-method-p-cache) method)
4158 (setq gnus-agent-method-p-cache
4160 (member (if (stringp method)
4162 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4163 (cdr gnus-agent-method-p-cache))
4165 (defun gnus-online (method)
4168 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4169 (gnus-agent-method-p method))))
4171 ;;; User-level commands.
4174 (defun gnus-slave-no-server (&optional arg)
4175 "Read network news as a slave, without connecting to the local server."
4177 (gnus-no-server arg t))
4180 (defun gnus-no-server (&optional arg slave)
4182 If ARG is a positive number, Gnus will use that as the startup
4183 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4184 non-nil and not a positive number, Gnus will prompt the user for the
4185 name of an NNTP server to use.
4186 As opposed to `gnus', this command will not connect to the local
4189 (gnus-no-server-1 arg slave))
4192 (defun gnus-slave (&optional arg)
4193 "Read news as a slave."
4195 (gnus arg nil 'slave))
4198 (defun gnus-other-frame (&optional arg display)
4199 "Pop up a frame to read news.
4200 This will call one of the Gnus commands which is specified by the user
4201 option `gnus-other-frame-function' (default `gnus') with the argument
4202 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4203 optional second argument DISPLAY should be a standard display string
4204 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4205 omitted or the function `make-frame-on-display' is not available, the
4206 current display is used."
4208 (if (fboundp 'make-frame-on-display)
4210 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4212 (let ((alive (gnus-alive-p)))
4217 (when (and (or (not display)
4219 (gnus-frame-or-window-display-name
4221 (with-current-buffer (window-buffer window)
4222 (string-match "\\`gnus-"
4223 (symbol-name major-mode))))
4224 (gnus-select-frame-set-input-focus
4225 (setq gnus-other-frame-object (window-frame window)))
4226 (select-window window)
4229 (gnus-select-frame-set-input-focus
4230 (setq gnus-other-frame-object
4232 (make-frame-on-display display gnus-other-frame-parameters)
4233 (make-frame gnus-other-frame-parameters))))
4235 (switch-to-buffer gnus-group-buffer)
4236 (funcall gnus-other-frame-function arg)
4237 (add-hook 'gnus-exit-gnus-hook
4239 (when (and (frame-live-p gnus-other-frame-object)
4241 (delete-frame gnus-other-frame-object))
4242 (setq gnus-other-frame-object nil)))))))
4244 ;;(setq thing ? ; this is a comment
4248 (defun gnus (&optional arg dont-connect slave)
4250 If ARG is non-nil and a positive number, Gnus will use that as the
4251 startup level. If ARG is non-nil and not a positive number, Gnus will
4252 prompt the user for the name of an NNTP server to use."
4254 (unless (byte-code-function-p (symbol-function 'gnus))
4255 (message "You should byte-compile Gnus")
4257 (gnus-1 arg dont-connect slave))
4259 ;; Allow redefinition of Gnus functions.
4265 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4266 ;;; gnus.el ends here