1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
9 ;; Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
10 ;; Keywords: news, mail
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
33 (eval '(run-hooks 'gnus-load-hook))
35 (eval-when-compile (require 'cl))
36 (eval-when-compile (require 'static))
43 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
47 (defgroup gnus-format nil
48 "Dealing with formatting issues."
52 (defgroup gnus-charset nil
53 "Group character set issues."
54 :link '(custom-manual "(gnus)Charsets")
58 (defgroup gnus-cache nil
62 (defgroup gnus-start nil
63 "Starting your favorite newsreader."
66 (defgroup gnus-start-server nil
67 "Server options at startup."
70 ;; These belong to gnus-group.el.
71 (defgroup gnus-group nil
73 :link '(custom-manual "(gnus)The Group Buffer")
76 (defgroup gnus-group-foreign nil
78 :link '(custom-manual "(gnus)Foreign Groups")
81 (defgroup gnus-group-new nil
82 "Automatic subscription of new groups."
85 (defgroup gnus-group-levels nil
87 :link '(custom-manual "(gnus)Group Levels")
90 (defgroup gnus-group-select nil
92 :link '(custom-manual "(gnus)Selecting a Group")
95 (defgroup gnus-group-listing nil
96 "Showing slices of the group list."
97 :link '(custom-manual "(gnus)Listing Groups")
100 (defgroup gnus-group-visual nil
101 "Sorting the group buffer."
102 :link '(custom-manual "(gnus)Group Buffer Format")
106 (defgroup gnus-group-various nil
107 "Various group options."
108 :link '(custom-manual "(gnus)Scanning New Messages")
111 ;; These belong to gnus-sum.el.
112 (defgroup gnus-summary nil
114 :link '(custom-manual "(gnus)The Summary Buffer")
117 (defgroup gnus-summary-exit nil
118 "Leaving summary buffers."
119 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
120 :group 'gnus-summary)
122 (defgroup gnus-summary-marks nil
123 "Marks used in summary buffers."
124 :link '(custom-manual "(gnus)Marking Articles")
125 :group 'gnus-summary)
127 (defgroup gnus-thread nil
128 "Ordering articles according to replies."
129 :link '(custom-manual "(gnus)Threading")
130 :group 'gnus-summary)
132 (defgroup gnus-summary-format nil
133 "Formatting of the summary buffer."
134 :link '(custom-manual "(gnus)Summary Buffer Format")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-choose nil
139 :link '(custom-manual "(gnus)Choosing Articles")
140 :group 'gnus-summary)
142 (defgroup gnus-summary-maneuvering nil
143 "Summary movement commands."
144 :link '(custom-manual "(gnus)Summary Maneuvering")
145 :group 'gnus-summary)
147 (defgroup gnus-picon nil
148 "Show pictures of people, domains, and newsgroups."
151 (defgroup gnus-summary-mail nil
152 "Mail group commands."
153 :link '(custom-manual "(gnus)Mail Group Commands")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-sort nil
157 "Sorting the summary buffer."
158 :link '(custom-manual "(gnus)Sorting")
159 :group 'gnus-summary)
161 (defgroup gnus-summary-visual nil
162 "Highlighting and menus in the summary buffer."
163 :link '(custom-manual "(gnus)Summary Highlighting")
165 :group 'gnus-summary)
167 (defgroup gnus-summary-various nil
168 "Various summary buffer options."
169 :link '(custom-manual "(gnus)Various Summary Stuff")
170 :group 'gnus-summary)
172 (defgroup gnus-summary-pick nil
173 "Pick mode in the summary buffer."
174 :link '(custom-manual "(gnus)Pick and Read")
176 :group 'gnus-summary)
178 (defgroup gnus-summary-tree nil
179 "Tree display of threads in the summary buffer."
180 :link '(custom-manual "(gnus)Tree Display")
182 :group 'gnus-summary)
184 ;; Belongs to gnus-uu.el
185 (defgroup gnus-extract-view nil
186 "Viewing extracted files."
187 :link '(custom-manual "(gnus)Viewing Files")
188 :group 'gnus-extract)
190 ;; Belongs to gnus-score.el
191 (defgroup gnus-score nil
192 "Score and kill file handling."
195 (defgroup gnus-score-kill nil
199 (defgroup gnus-score-adapt nil
200 "Adaptive score files."
203 (defgroup gnus-score-default nil
204 "Default values for score files."
207 (defgroup gnus-score-expire nil
208 "Expiring score rules."
211 (defgroup gnus-score-decay nil
212 "Decaying score rules."
215 (defgroup gnus-score-files nil
216 "Score and kill file names."
220 (defgroup gnus-score-various nil
221 "Various scoring and killing options."
225 (defgroup gnus-visual nil
226 "Options controling the visual fluff."
230 (defgroup gnus-agent nil
231 "Offline support for Gnus."
234 (defgroup gnus-files nil
235 "Files used by Gnus."
238 (defgroup gnus-dribble-file nil
240 :link '(custom-manual "(gnus)Auto Save")
243 (defgroup gnus-newsrc nil
244 "Storing Gnus state."
247 (defgroup gnus-server nil
248 "Options related to newsservers and other servers used by Gnus."
251 (defgroup gnus-server-visual nil
252 "Highlighting and menus in the server buffer."
256 (defgroup gnus-message '((message custom-group))
257 "Composing replies and followups in Gnus."
260 (defgroup gnus-meta nil
261 "Meta variables controling major portions of Gnus.
262 In general, modifying these variables does not take affect until Gnus
263 is restarted, and sometimes reloaded."
266 (defgroup gnus-various nil
267 "Other Gnus options."
268 :link '(custom-manual "(gnus)Various Various")
271 (defgroup gnus-mime nil
272 "Variables for controlling the Gnus MIME interface."
275 (defgroup gnus-exit nil
277 :link '(custom-manual "(gnus)Exiting Gnus")
280 (defgroup gnus-fun nil
281 "Frivolous Gnus extensions."
282 :link '(custom-manual "(gnus)Exiting Gnus")
285 (defcustom gnus-inhibit-startup-message nil
286 "If non-nil, the startup message will not be displayed.
287 This variable is used before `.gnus.el' is loaded, so it should
288 be set in `.emacs' instead."
292 (defcustom gnus-play-startup-jingle nil
293 "If non-nil, play the Gnus jingle at startup."
297 (unless (fboundp 'gnus-group-remove-excess-properties)
298 (defalias 'gnus-group-remove-excess-properties 'ignore))
300 (unless (fboundp 'gnus-set-text-properties)
301 (defalias 'gnus-set-text-properties 'set-text-properties))
303 (unless (featurep 'gnus-xmas)
304 (defalias 'gnus-make-overlay 'make-overlay)
305 (defalias 'gnus-delete-overlay 'delete-overlay)
306 (defalias 'gnus-overlay-put 'overlay-put)
307 (defalias 'gnus-move-overlay 'move-overlay)
308 (defalias 'gnus-overlay-buffer 'overlay-buffer)
309 (defalias 'gnus-overlay-start 'overlay-start)
310 (defalias 'gnus-overlay-end 'overlay-end)
311 (defalias 'gnus-extent-detached-p 'ignore)
312 (defalias 'gnus-extent-start-open 'ignore)
313 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
314 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
315 (defalias 'gnus-character-to-event 'identity)
316 (defalias 'gnus-add-text-properties 'add-text-properties)
317 (defalias 'gnus-put-text-property 'put-text-property)
318 (defvar gnus-mode-line-image-cache t)
319 (if (fboundp 'find-image)
320 (defun gnus-mode-line-buffer-identification (line)
321 (let ((str (car-safe line)))
322 (if (and (stringp str)
323 (string-match "^Gnus:" str))
324 (progn (add-text-properties
327 (if (eq t gnus-mode-line-image-cache)
328 (setq gnus-mode-line-image-cache
330 '((:type xpm :file "gnus-pointer.xpm"
332 (:type xbm :file "gnus-pointer.xbm"
334 gnus-mode-line-image-cache)
335 'help-echo "This is Gnus")
339 (defalias 'gnus-mode-line-buffer-identification 'identity))
340 (defalias 'gnus-characterp 'numberp)
341 (defalias 'gnus-deactivate-mark 'deactivate-mark)
342 (defalias 'gnus-window-edges 'window-edges)
343 (defalias 'gnus-key-press-event-p 'numberp)
344 ;;(defalias 'gnus-decode-rfc1522 'ignore)
347 ;; We define these group faces here to avoid the display
348 ;; update forced when creating new faces.
350 (defface gnus-group-news-1-face
353 (:foreground "PaleTurquoise" :bold t))
356 (:foreground "ForestGreen" :bold t))
359 "Level 1 newsgroup face.")
361 (defface gnus-group-news-1-empty-face
364 (:foreground "PaleTurquoise"))
367 (:foreground "ForestGreen"))
370 "Level 1 empty newsgroup face.")
372 (defface gnus-group-news-2-face
375 (:foreground "turquoise" :bold t))
378 (:foreground "CadetBlue4" :bold t))
381 "Level 2 newsgroup face.")
383 (defface gnus-group-news-2-empty-face
386 (:foreground "turquoise"))
389 (:foreground "CadetBlue4"))
392 "Level 2 empty newsgroup face.")
394 (defface gnus-group-news-3-face
403 "Level 3 newsgroup face.")
405 (defface gnus-group-news-3-empty-face
414 "Level 3 empty newsgroup face.")
416 (defface gnus-group-news-4-face
425 "Level 4 newsgroup face.")
427 (defface gnus-group-news-4-empty-face
436 "Level 4 empty newsgroup face.")
438 (defface gnus-group-news-5-face
447 "Level 5 newsgroup face.")
449 (defface gnus-group-news-5-empty-face
458 "Level 5 empty newsgroup face.")
460 (defface gnus-group-news-6-face
469 "Level 6 newsgroup face.")
471 (defface gnus-group-news-6-empty-face
480 "Level 6 empty newsgroup face.")
482 (defface gnus-group-news-low-face
485 (:foreground "DarkTurquoise" :bold t))
488 (:foreground "DarkGreen" :bold t))
491 "Low level newsgroup face.")
493 (defface gnus-group-news-low-empty-face
496 (:foreground "DarkTurquoise"))
499 (:foreground "DarkGreen"))
502 "Low level empty newsgroup face.")
504 (defface gnus-group-mail-1-face
507 (:foreground "aquamarine1" :bold t))
510 (:foreground "DeepPink3" :bold t))
513 "Level 1 mailgroup face.")
515 (defface gnus-group-mail-1-empty-face
518 (:foreground "aquamarine1"))
521 (:foreground "DeepPink3"))
523 (:italic t :bold t)))
524 "Level 1 empty mailgroup face.")
526 (defface gnus-group-mail-2-face
529 (:foreground "aquamarine2" :bold t))
532 (:foreground "HotPink3" :bold t))
535 "Level 2 mailgroup face.")
537 (defface gnus-group-mail-2-empty-face
540 (:foreground "aquamarine2"))
543 (:foreground "HotPink3"))
546 "Level 2 empty mailgroup face.")
548 (defface gnus-group-mail-3-face
551 (:foreground "aquamarine3" :bold t))
554 (:foreground "magenta4" :bold t))
557 "Level 3 mailgroup face.")
559 (defface gnus-group-mail-3-empty-face
562 (:foreground "aquamarine3"))
565 (:foreground "magenta4"))
568 "Level 3 empty mailgroup face.")
570 (defface gnus-group-mail-low-face
573 (:foreground "aquamarine4" :bold t))
576 (:foreground "DeepPink4" :bold t))
579 "Low level mailgroup face.")
581 (defface gnus-group-mail-low-empty-face
584 (:foreground "aquamarine4"))
587 (:foreground "DeepPink4"))
590 "Low level empty mailgroup face.")
592 ;; Summary mode faces.
594 (defface gnus-summary-selected-face '((t
596 "Face used for selected articles.")
598 (defface gnus-summary-cancelled-face
600 (:foreground "yellow" :background "black")))
601 "Face used for cancelled articles.")
603 (defface gnus-summary-high-ticked-face
606 (:foreground "pink" :bold t))
609 (:foreground "firebrick" :bold t))
612 "Face used for high interest ticked articles.")
614 (defface gnus-summary-low-ticked-face
617 (:foreground "pink" :italic t))
620 (:foreground "firebrick" :italic t))
623 "Face used for low interest ticked articles.")
625 (defface gnus-summary-normal-ticked-face
628 (:foreground "pink"))
631 (:foreground "firebrick"))
634 "Face used for normal interest ticked articles.")
636 (defface gnus-summary-high-ancient-face
639 (:foreground "SkyBlue" :bold t))
642 (:foreground "RoyalBlue" :bold t))
645 "Face used for high interest ancient articles.")
647 (defface gnus-summary-low-ancient-face
650 (:foreground "SkyBlue" :italic t))
653 (:foreground "RoyalBlue" :italic t))
656 "Face used for low interest ancient articles.")
658 (defface gnus-summary-normal-ancient-face
661 (:foreground "SkyBlue"))
664 (:foreground "RoyalBlue"))
667 "Face used for normal interest ancient articles.")
669 (defface gnus-summary-high-unread-face
672 "Face used for high interest unread articles.")
674 (defface gnus-summary-low-unread-face
677 "Face used for low interest unread articles.")
679 (defface gnus-summary-normal-unread-face
682 "Face used for normal interest unread articles.")
684 (defface gnus-summary-incorporated-face
687 "Face used for incorporated articles.")
689 (defface gnus-summary-high-read-face
692 (:foreground "PaleGreen"
696 (:foreground "DarkGreen"
700 "Face used for high interest read articles.")
702 (defface gnus-summary-low-read-face
705 (:foreground "PaleGreen"
709 (:foreground "DarkGreen"
713 "Face used for low interest read articles.")
715 (defface gnus-summary-normal-read-face
718 (:foreground "PaleGreen"))
721 (:foreground "DarkGreen"))
724 "Face used for normal interest read articles.")
731 (defvar gnus-buffers nil)
733 (defun gnus-get-buffer-create (name)
734 "Do the same as `get-buffer-create', but store the created buffer."
735 (or (get-buffer name)
736 (car (push (get-buffer-create name) gnus-buffers))))
738 (defun gnus-add-buffer ()
739 "Add the current buffer to the list of Gnus buffers."
740 (push (current-buffer) gnus-buffers))
742 (defun gnus-buffers ()
743 "Return a list of live Gnus buffers."
744 (while (and gnus-buffers
745 (not (buffer-name (car gnus-buffers))))
747 (let ((buffers gnus-buffers))
749 (if (buffer-name (cadr buffers))
751 (setcdr buffers (cddr buffers)))))
756 (defvar gnus-group-buffer "*Group*")
759 (autoload 'gnus-play-jingle "gnus-audio"))
761 (defface gnus-splash-face
764 (:foreground "#888888"))
767 (:foreground "#888888"))
770 "Face for the splash screen.")
772 (defun gnus-splash ()
774 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
775 (let ((buffer-read-only nil))
777 (unless gnus-inhibit-startup-message
778 (gnus-group-startup-message)
780 (when gnus-play-startup-jingle
781 (gnus-play-jingle))))))
783 (defun gnus-indent-rigidly (start end arg)
784 "Indent rigidly using only spaces and no tabs."
787 (narrow-to-region start end)
789 (indent-rigidly start end arg)
790 ;; We translate tabs into spaces -- not everybody uses
791 ;; an 8-character tab.
792 (goto-char (point-min))
793 (while (search-forward "\t" nil t)
794 (replace-match " " t t))))))
796 (defvar gnus-simple-splash nil)
798 ;;(format "%02x%02x%02x" 114 66 20) "724214"
800 (defvar gnus-logo-color-alist
801 '((flame "#cc3300" "#ff2200")
802 (pine "#c0cc93" "#f8ffb8")
803 (moss "#a1cc93" "#d2ffb8")
804 (irish "#04cc90" "#05ff97")
805 (sky "#049acc" "#05deff")
806 (tin "#6886cc" "#82b6ff")
807 (velvet "#7c68cc" "#8c82ff")
808 (grape "#b264cc" "#cf7df")
809 (labia "#cc64c2" "#fd7dff")
810 (berry "#cc6485" "#ff7db5")
811 (dino "#724214" "#1e3f03")
812 (oort "#cccccc" "#888888")
813 (storm "#666699" "#99ccff")
814 (pdino "#9999cc" "#99ccff")
815 (purp "#9999cc" "#666699")
816 (neutral "#b4b4b4" "#878787")
817 (september "#bf9900" "#ffcc00"))
818 "Color alist used for the Gnus logo.")
820 (defcustom gnus-logo-color-style 'oort
821 "*Color styles used for the Gnus logo."
822 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
823 gnus-logo-color-alist))
826 (defvar gnus-logo-colors
827 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
828 "Colors used for the Gnus logo.")
830 (defun gnus-group-startup-message (&optional x y)
831 "Insert startup message in current buffer."
832 ;; Insert the message.
835 ((and (fboundp 'find-image)
837 (let* ((bg (face-background 'default))
838 (fg (face-foreground 'gnus-splash-face))
840 `((:type xpm :file "gnus.xpm"
842 (("thing" . ,(car gnus-logo-colors))
843 ("shadow" . ,(cadr gnus-logo-colors))
844 ("background" . ,bg)))
845 (:type pbm :file "gnus.pbm"
846 ;; Account for the pbm's blackground.
847 :background ,bg :foreground ,fg)
848 (:type xbm :file "gnus.xbm"
849 ;; Account for the xbm's blackground.
850 :background ,bg :foreground ,fg)))))
854 (concat gnus-product-name " " gnus-version-number
855 (if (zerop (string-to-number gnus-revision-number))
857 (concat " (r" gnus-revision-number ")"))
858 " based on " gnus-original-product-name " v"
859 gnus-original-version-number)
860 'face `(variable-pitch :background ,bg :foreground ,fg)))
861 (let ((fill-column (window-width)))
862 (center-region (point-min) (point)))
863 (let ((size (image-size image)))
864 (insert-char ?\n (max 1 (round (- (window-height)
865 (or y (cdr size))) 2)))
867 (propertize " " 'display
869 ,(max 0 (round (- (window-width)
870 (or x (car size))) 2)))))
871 (insert-image image))
872 (setq gnus-simple-splash nil)
877 _ ___ __ ___ __ _ ___
896 (goto-char (point-min))
897 (insert gnus-product-name " " gnus-version-number
898 (if (zerop (string-to-number gnus-revision-number))
900 (concat " (r" gnus-revision-number ")"))
901 " based on " gnus-original-product-name " v"
902 gnus-original-version-number)
903 (insert-char ?\ (prog1
904 (max 0 (/ (- (window-width) (point)) 2))
905 (goto-char (point-min))))
908 (gnus-indent-rigidly (point) (point-max)
909 (/ (max (- (window-width) (or x 46)) 0) 2))
910 (goto-char (point-min))
912 (let* ((pheight (count-lines (point-min) (point-max)))
913 (wheight (window-height))
914 (rest (- wheight pheight)))
915 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
917 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
918 (setq gnus-simple-splash t)))
919 (goto-char (point-min))
920 (setq mode-line-buffer-identification (concat " " gnus-version))
921 (set-buffer-modified-p t))
924 (let ((command (format "%s" this-command)))
925 (if (and (string-match "gnus" command)
926 (not (string-match "gnus-other-frame" command)))
928 (gnus-get-buffer-create gnus-group-buffer))))
935 (defcustom gnus-parameters nil
936 "Alist of group parameters.
939 ((\"mail\\\\..*\" (gnus-show-threads nil)
940 (gnus-use-scoring nil)
941 (gnus-summary-line-format
942 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
945 (\"mail\\\\.me\" (gnus-use-scoring t))
946 (\"list\\\\..*\" (total-expire . t)
947 (broken-reply-to . t)))"
948 :group 'gnus-group-various
949 :type '(repeat (cons regexp
952 (defvar gnus-group-parameters-more nil)
954 (defvar gnus-colon-keywords
956 (when (boundp 'dgnushack-colon-keywords)
957 (symbol-value 'dgnushack-colon-keywords)))
958 "List of the colon keywords should be bound at run-time. This variable
959 defaults to a proper value only if this file is byte-compiled by make.")
961 (dolist (keyword gnus-colon-keywords)
962 (set keyword keyword))
964 (defmacro gnus-define-group-parameter (param &rest rest)
965 "Define a group parameter PARAM.
966 REST is a plist of following:
967 :type One of `bool', `list' or `nil'.
968 :function The name of the function.
969 :function-document The documentation of the function.
970 :parameter-type The type for customizing the parameter.
971 :parameter-document The documentation for the parameter.
972 :variable The name of the variable.
973 :variable-document The documentation for the variable.
974 :variable-group The group for customizing the variable.
975 :variable-type The type for customizing the variable.
976 :variable-default The default value of the variable."
977 (let* ((type (plist-get rest :type))
978 (parameter-type (plist-get rest :parameter-type))
979 (parameter-document (plist-get rest :parameter-document))
980 (function (or (plist-get rest :function)
981 (intern (format "gnus-parameter-%s" param))))
982 (function-document (or (plist-get rest :function-document) ""))
983 (variable (or (plist-get rest :variable)
984 (intern (format "gnus-parameter-%s-alist" param))))
985 (variable-document (or (plist-get rest :variable-document) ""))
986 (variable-group (plist-get rest :variable-group))
987 (variable-type (or (plist-get rest :variable-type)
989 (list (regexp :tag "Group")
990 ,(car (cdr parameter-type)))))))
991 (variable-default (plist-get rest :variable-default)))
994 `(defcustom ,variable ,variable-default
996 :group 'gnus-group-parameter
997 :group ',variable-group
998 :type ,variable-type)
999 `(setq gnus-group-parameters-more
1000 (delq (assq ',param gnus-group-parameters-more)
1001 gnus-group-parameters-more))
1002 `(add-to-list 'gnus-group-parameters-more
1005 ,parameter-document))
1007 `(defun ,function (name)
1009 (let ((params (gnus-group-find-parameter name))
1012 ((memq ',param params)
1014 ((setq val (assq ',param params))
1016 ((stringp ,variable)
1017 (string-match ,variable name))
1019 (let ((alist ,variable)
1021 (while (setq elem (pop alist))
1023 (string-match (car elem) name))
1026 (if (consp value) (car value) value))))))
1027 `(defun ,function (name)
1030 (or (gnus-group-find-parameter name ',param ,(and type t))
1031 (let ((alist ,variable)
1033 (while (setq elem (pop alist))
1035 (string-match (car elem) name))
1040 '(if (consp value) (car value) value))))))))))
1042 (defcustom gnus-home-directory "~/"
1043 "Directory variable that specifies the \"home\" directory.
1044 All other Gnus path variables are initialized from this variable."
1048 (defcustom gnus-directory (or (getenv "SAVEDIR")
1049 (nnheader-concat gnus-home-directory "News/"))
1050 "*Directory variable from which all other Gnus file variables are derived.
1052 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1053 This means that other directory variables that are initialized from
1054 this variable won't be set properly if you set this variable in `.gnus.el'.
1055 Set this variable in `.emacs' instead."
1059 (defcustom gnus-default-directory nil
1060 "*Default directory for all Gnus buffers."
1062 :type '(choice (const :tag "current" nil)
1065 ;; Site dependent variables. These variables should be defined in
1068 (defvar gnus-default-nntp-server nil
1069 "Specify a default NNTP server.
1070 This variable should be defined in paths.el, and should never be set
1072 If you want to change servers, you should use `gnus-select-method'.
1073 See the documentation to that variable.")
1075 ;; Don't touch this variable.
1076 (defvar gnus-nntp-service "nntp"
1077 "NNTP service name (\"nntp\" or 119).
1078 This is an obsolete variable, which is scarcely used. If you use an
1079 nntp server for your newsgroup and want to change the port number
1080 used to 899, you would say something along these lines:
1082 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1084 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1085 "A file with only the name of the nntp server in it."
1090 ;; This function is used to check both the environment variable
1091 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
1092 ;; an nntp server name default.
1093 (defun gnus-getenv-nntpserver ()
1094 (or (getenv "NNTPSERVER")
1095 (and (file-readable-p gnus-nntpserver-file)
1097 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
1098 (insert-file-contents gnus-nntpserver-file)
1099 (let ((name (buffer-string)))
1101 (if (string-match "\\'[ \t\n]*$" name)
1104 (kill-buffer (current-buffer))))))))
1106 (defcustom gnus-select-method
1109 (list 'nntp (or (condition-case nil
1110 (gnus-getenv-nntpserver)
1112 (when (and gnus-default-nntp-server
1113 (not (string= gnus-default-nntp-server "")))
1114 gnus-default-nntp-server)
1116 (if (or (null gnus-nntp-service)
1117 (equal gnus-nntp-service "nntp"))
1119 (list gnus-nntp-service)))
1121 "Default method for selecting a newsgroup.
1122 This variable should be a list, where the first element is how the
1123 news is to be fetched, the second is the address.
1125 For instance, if you want to get your news via \"flab.flab.edu\" using
1126 NNTP, you could say:
1128 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1130 If you want to use your local spool, say:
1132 \(setq gnus-select-method (list 'nnspool (system-name)))
1134 If you use this variable, you must set `gnus-nntp-server' to nil.
1136 There is a lot more to know about select methods and virtual servers -
1137 see the manual for details."
1139 :type 'gnus-select-method)
1141 (defcustom gnus-message-archive-method "archive"
1142 "*Method used for archiving messages you've sent.
1143 This should be a mail method."
1145 :group 'gnus-message
1146 :type 'gnus-select-method)
1148 (defcustom gnus-message-archive-group nil
1149 "*Name of the group in which to save the messages you've written.
1150 This can either be a string; a list of strings; or an alist
1151 of regexps/functions/forms to be evaluated to return a string (or a list
1152 of strings). The functions are called with the name of the current
1153 group (or nil) as a parameter.
1155 If you want to save your mail in one group and the news articles you
1156 write in another group, you could say something like:
1158 \(setq gnus-message-archive-group
1159 '((if (message-news-p)
1163 Normally the group names returned by this variable should be
1164 unprefixed -- which implicitly means \"store on the archive server\".
1165 However, you may wish to store the message on some other server. In
1166 that case, just return a fully prefixed name of the group --
1167 \"nnml+private:mail.misc\", for instance."
1168 :group 'gnus-message
1169 :type '(choice (const :tag "none" nil)
1174 (defcustom gnus-secondary-servers nil
1175 "List of NNTP servers that the user can choose between interactively.
1176 To make Gnus query you for a server, you have to give `gnus' a
1177 non-numeric prefix - `C-u M-x gnus', in short."
1179 :type '(repeat string))
1181 (defcustom gnus-nntp-server nil
1182 "*The name of the host running the NNTP server.
1183 This variable is semi-obsolete. Use the `gnus-select-method'
1186 :type '(choice (const :tag "disable" nil)
1189 (defcustom gnus-secondary-select-methods nil
1190 "A list of secondary methods that will be used for reading news.
1191 This is a list where each element is a complete select method (see
1192 `gnus-select-method').
1194 If, for instance, you want to read your mail with the nnml back end,
1195 you could set this variable:
1197 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1199 :type '(repeat gnus-select-method))
1201 (defvar gnus-backup-default-subscribed-newsgroups
1202 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1203 "Default default new newsgroups the first time Gnus is run.
1204 Should be set in paths.el, and shouldn't be touched by the user.")
1206 (defcustom gnus-local-domain nil
1207 "Local domain name without a host name.
1208 The DOMAINNAME environment variable is used instead if it is defined.
1209 If the function `system-name' returns the full Internet name, there is
1210 no need to set this variable."
1211 :group 'gnus-message
1212 :type '(choice (const :tag "default" nil)
1215 (defvar gnus-local-organization nil
1216 "String with a description of what organization (if any) the user belongs to.
1217 Obsolete variable; use `message-user-organization' instead.")
1219 ;; Customization variables
1221 (defcustom gnus-refer-article-method nil
1222 "Preferred method for fetching an article by Message-ID.
1223 If you are reading news from the local spool (with nnspool), fetching
1224 articles by Message-ID is painfully slow. By setting this method to an
1225 nntp method, you might get acceptable results.
1227 The value of this variable must be a valid select method as discussed
1228 in the documentation of `gnus-select-method'.
1230 It can also be a list of select methods, as well as the special symbol
1231 `current', which means to use the current select method. If it is a
1232 list, Gnus will try all the methods in the list until it finds a match."
1234 :type '(choice (const :tag "default" nil)
1235 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1237 (repeat :menu-tag "Try multiple"
1239 :value (current (nnweb "refer" (nnweb-type google)))
1240 (choice :tag "Method"
1242 (const :tag "Google"
1243 (nnweb "refer" (nnweb-type google)))
1244 gnus-select-method))))
1246 (defcustom gnus-group-faq-directory
1247 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1248 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1249 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1250 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1251 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1252 "/ftp@rtfm.mit.edu:/pub/usenet/"
1253 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1254 "/ftp@ftp.sunet.se:/pub/usenet/"
1255 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1256 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1257 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1258 "*Directory where the group FAQs are stored.
1259 This will most commonly be on a remote machine, and the file will be
1260 fetched by ange-ftp.
1262 This variable can also be a list of directories. In that case, the
1263 first element in the list will be used by default. The others can
1264 be used when being prompted for a site.
1266 Note that Gnus uses an aol machine as the default directory. If this
1267 feels fundamentally unclean, just think of it as a way to finally get
1268 something of value back from them.
1270 If the default site is too slow, try one of these:
1272 North America: mirrors.aol.com /pub/rtfm/usenet
1273 ftp.seas.gwu.edu /pub/rtfm
1274 rtfm.mit.edu /pub/usenet
1275 Europe: ftp.uni-paderborn.de /pub/FAQ
1276 src.doc.ic.ac.uk /usenet/news-FAQS
1277 ftp.sunet.se /pub/usenet
1278 ftp.pasteur.fr /pub/FAQ
1279 Asia: nctuccca.edu.tw /USENET/FAQ
1280 hwarang.postech.ac.kr /pub/usenet
1281 ftp.hk.super.net /mirror/faqs"
1282 :group 'gnus-group-various
1283 :type '(choice directory
1284 (repeat directory)))
1286 (defcustom gnus-use-cross-reference t
1287 "*Non-nil means that cross referenced articles will be marked as read.
1288 If nil, ignore cross references. If t, mark articles as read in
1289 subscribed newsgroups. If neither t nor nil, mark as read in all
1292 :type '(choice (const :tag "off" nil)
1293 (const :tag "subscribed" t)
1297 (defcustom gnus-process-mark ?#
1299 :group 'gnus-group-visual
1300 :group 'gnus-summary-marks
1303 (defcustom gnus-large-newsgroup 200
1304 "*The number of articles which indicates a large newsgroup.
1305 If the number of articles in a newsgroup is greater than this value,
1306 confirmation is required for selecting the newsgroup.
1307 If it is `nil', no confirmation is required."
1308 :group 'gnus-group-select
1309 :type '(choice (const :tag "No limit" nil)
1312 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1313 "*Non-nil means that the default name of a file to save articles in is the group name.
1314 If it's nil, the directory form of the group name is used instead.
1316 If this variable is a list, and the list contains the element
1317 `not-score', long file names will not be used for score files; if it
1318 contains the element `not-save', long file names will not be used for
1319 saving; and if it contains the element `not-kill', long file names
1320 will not be used for kill files.
1322 Note that the default for this variable varies according to what system
1323 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1324 to nil while on all other systems it defaults to t."
1328 (defcustom gnus-kill-files-directory gnus-directory
1329 "*Name of the directory where kill files will be stored (default \"~/News\")."
1330 :group 'gnus-score-files
1331 :group 'gnus-score-kill
1334 (defcustom gnus-save-score nil
1335 "*If non-nil, save group scoring info."
1336 :group 'gnus-score-various
1340 (defcustom gnus-use-undo t
1341 "*If non-nil, allow undoing in Gnus group mode buffers."
1345 (defcustom gnus-use-adaptive-scoring nil
1346 "*If non-nil, use some adaptive scoring scheme.
1347 If a list, then the values `word' and `line' are meaningful. The
1348 former will perform adaption on individual words in the subject
1349 header while `line' will perform adaption on several headers."
1351 :group 'gnus-score-adapt
1352 :type '(set (const word) (const line)))
1354 (defcustom gnus-use-cache 'passive
1355 "*If nil, Gnus will ignore the article cache.
1356 If `passive', it will allow entering (and reading) articles
1357 explicitly entered into the cache. If anything else, use the
1358 cache to the full extent of the law."
1361 :type '(choice (const :tag "off" nil)
1362 (const :tag "passive" passive)
1363 (const :tag "active" t)))
1365 (defcustom gnus-use-trees nil
1366 "*If non-nil, display a thread tree buffer."
1370 (defcustom gnus-use-grouplens nil
1371 "*If non-nil, use GroupLens ratings."
1375 (defcustom gnus-keep-backlog nil
1376 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1377 If it is a number N, then Gnus will only keep the last N articles
1378 read. If it is neither nil nor a number, Gnus will keep all read
1379 articles. This is not a good idea."
1381 :type '(choice (const :tag "off" nil)
1386 (defcustom gnus-use-nocem nil
1387 "*If non-nil, Gnus will read NoCeM cancel messages."
1391 (defcustom gnus-suppress-duplicates nil
1392 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1396 (defcustom gnus-use-scoring t
1397 "*If non-nil, enable scoring."
1401 (defcustom gnus-summary-prepare-exit-hook
1402 '(gnus-summary-expire-articles)
1403 "*A hook called when preparing to exit from the summary buffer.
1404 It calls `gnus-summary-expire-articles' by default."
1405 :group 'gnus-summary-exit
1408 (defcustom gnus-novice-user t
1409 "*Non-nil means that you are a usenet novice.
1410 If non-nil, verbose messages may be displayed and confirmations may be
1415 (defcustom gnus-expert-user nil
1416 "*Non-nil means that you will never be asked for confirmation about anything.
1417 That doesn't mean *anything* anything; particularly destructive
1418 commands will still require prompting."
1422 (defcustom gnus-interactive-catchup t
1423 "*If non-nil, require your confirmation when catching up a group."
1424 :group 'gnus-group-select
1427 (defcustom gnus-interactive-exit t
1428 "*If non-nil, require your confirmation when exiting Gnus."
1432 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1433 "Function for extracting address components from a From header.
1434 Three pre-defined functions exist: `gnus-extract-address-components',
1435 which is the default, quite fast, and too simplistic solution,
1436 `mail-extract-address-components', which works much better, but is
1437 slower, and `std11-extract-address-components'."
1438 :group 'gnus-summary-format
1439 :type '(radio (function-item gnus-extract-address-components)
1440 (function-item mail-extract-address-components)
1441 (function-item std11-extract-address-components)
1442 (function :tag "Other")))
1444 (defcustom gnus-carpal nil
1445 "*If non-nil, display clickable icons."
1449 (defcustom gnus-shell-command-separator ";"
1450 "String used to separate to shell commands."
1454 (defcustom gnus-valid-select-methods
1455 '(("nntp" post address prompt-address physical-address)
1456 ("nnspool" post address)
1457 ("nnvirtual" post-mail virtual prompt-address)
1458 ("nnmbox" mail respool address)
1459 ("nnml" post-mail respool address)
1460 ("nnmh" mail respool address)
1461 ("nndir" post-mail prompt-address physical-address)
1462 ("nneething" none address prompt-address physical-address)
1463 ("nndoc" none address prompt-address)
1464 ("nnbabyl" mail address respool)
1465 ("nnkiboze" post virtual)
1466 ("nnsoup" post-mail address)
1467 ("nndraft" post-mail)
1468 ("nnfolder" mail respool address)
1469 ("nngateway" post-mail address prompt-address physical-address)
1478 ("nnagent" post-mail)
1479 ("nnimap" post-mail address prompt-address physical-address)
1480 ("nnmaildir" mail respool address)
1482 "*An alist of valid select methods.
1483 The first element of each list lists should be a string with the name
1484 of the select method. The other elements may be the category of
1485 this method (i. e., `post', `mail', `none' or whatever) or other
1486 properties that this method has (like being respoolable).
1487 If you implement a new select method, all you should have to change is
1488 this variable. I think."
1490 :type '(repeat (group (string :tag "Name")
1491 (radio-button-choice (const :format "%v " post)
1492 (const :format "%v " mail)
1493 (const :format "%v " none)
1495 (checklist :inline t
1496 (const :format "%v " address)
1497 (const :format "%v " prompt-address)
1498 (const :format "%v " physical-address)
1499 (const :format "%v " virtual)
1502 (defun gnus-redefine-select-method-widget ()
1503 "Recomputes the select-method widget based on the value of
1504 `gnus-valid-select-methods'."
1505 (define-widget 'gnus-select-method 'list
1506 "Widget for entering a select method."
1508 :tag "Select Method"
1509 :args `((choice :tag "Method"
1510 ,@(mapcar (lambda (entry)
1511 (list 'const :format "%v\n"
1512 (intern (car entry))))
1513 gnus-valid-select-methods)
1514 (symbol :tag "other"))
1515 (string :tag "Address")
1516 (repeat :tag "Options"
1520 (sexp :tag "Value"))))))
1522 (gnus-redefine-select-method-widget)
1524 (defcustom gnus-updated-mode-lines '(group article summary tree)
1525 "List of buffers that should update their mode lines.
1526 The list may contain the symbols `group', `article', `tree' and
1527 `summary'. If the corresponding symbol is present, Gnus will keep
1528 that mode line updated with information that may be pertinent.
1529 If this variable is nil, screen refresh may be quicker."
1530 :group 'gnus-various
1531 :type '(set (const group)
1536 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1537 (defcustom gnus-mode-non-string-length nil
1538 "*Max length of mode-line non-string contents.
1539 If this is nil, Gnus will take space as is needed, leaving the rest
1540 of the modeline intact. Note that the default of nil is unlikely
1541 to be desirable; see the manual for further details."
1542 :group 'gnus-various
1543 :type '(choice (const nil)
1546 ;; There should be special validation for this.
1547 (define-widget 'gnus-email-address 'string
1550 (gnus-define-group-parameter
1553 "Return GROUP's to-address."
1555 "*Alist of group regexps and correspondent to-addresses."
1556 :parameter-type '(gnus-email-address :tag "To Address")
1557 :parameter-document "\
1558 This will be used when doing followups and posts.
1560 This is primarily useful in mail groups that represent closed
1561 mailing lists--mailing lists where it's expected that everybody that
1562 writes to the mailing list is subscribed to it. Since using this
1563 parameter ensures that the mail only goes to the mailing list itself,
1564 it means that members won't receive two copies of your followups.
1566 Using `to-address' will actually work whether the group is foreign or
1567 not. Let's say there's a group on the server that is called
1568 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1569 articles from a mail-to-news gateway. Posting directly to this group
1570 is therefore impossible--you have to send mail to the mailing list
1573 The gnus-group-split mail splitting mechanism will behave as if this
1574 address was listed in gnus-group-split Addresses (see below).")
1576 (gnus-define-group-parameter
1579 "Return GROUP's to-list."
1581 "*Alist of group regexps and correspondent to-lists."
1582 :parameter-type '(gnus-email-address :tag "To List")
1583 :parameter-document "\
1584 This address will be used when doing a `a' in the group.
1586 It is totally ignored when doing a followup--except that if it is
1587 present in a news group, you'll get mail group semantics when doing
1590 The gnus-group-split mail splitting mechanism will behave as if this
1591 address was listed in gnus-group-split Addresses (see below).")
1593 (gnus-define-group-parameter
1597 "Return GROUP's subscription status."
1599 "*Groups which are automatically considered subscribed."
1600 :parameter-type '(const :tag "Subscribed" t)
1601 :parameter-document "\
1602 Gnus assumed that you are subscribed to the To/List address.
1604 When constructing a list of subscribed groups using
1605 `gnus-find-subscribed-addresses', Gnus includes the To address given
1606 above, or the list address (if the To address has not been set).")
1608 (gnus-define-group-parameter
1611 :function gnus-group-auto-expirable-p
1613 "Check whether GROUP is auto-expirable or not."
1614 :variable gnus-auto-expirable-newsgroups
1615 :variable-default nil
1617 "*Groups in which to automatically mark read articles as expirable.
1618 If non-nil, this should be a regexp that should match all groups in
1619 which to perform auto-expiry. This only makes sense for mail groups."
1620 :variable-group nnmail-expire
1621 :variable-type '(choice (const nil)
1623 :parameter-type '(const :tag "Automatic Expire" t)
1625 "All articles that are read will be marked as expirable.")
1627 (gnus-define-group-parameter
1630 :function gnus-group-total-expirable-p
1632 "Check whether GROUP is total-expirable or not."
1633 :variable gnus-total-expirable-newsgroups
1634 :variable-default nil
1636 "*Groups in which to perform expiry of all read articles.
1637 Use with extreme caution. All groups that match this regexp will be
1638 expiring - which means that all read articles will be deleted after
1639 \(say) one week. (This only goes for mail groups and the like, of
1641 :variable-group nnmail-expire
1642 :variable-type '(choice (const nil)
1644 :parameter-type '(const :tag "Total Expire" t)
1646 "All read articles will be put through the expiry process
1648 This happens even if they are not marked as expirable.
1651 (gnus-define-group-parameter
1654 "Return the default charset of GROUP."
1655 :variable gnus-group-charset-alist
1657 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1658 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1659 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1660 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1661 ("\\(^\\|:\\)relcom\\>" koi8-r)
1662 ("\\(^\\|:\\)fido7\\>" koi8-r)
1663 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1664 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1665 ("\\(^\\|:\\)han\\>" euc-kr)
1666 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1667 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1668 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1670 "Alist of regexps (to match group names) and default charsets to be used when reading."
1671 :variable-group gnus-charset
1672 :variable-type '(repeat (list (regexp :tag "Group")
1673 (symbol :tag "Charset")))
1674 :parameter-type '(symbol :tag "Charset")
1675 :parameter-document "\
1676 The default charset to use in the group.")
1678 (gnus-define-group-parameter
1682 "Return a posting method for GROUP."
1683 :variable gnus-post-method-alist
1685 "Alist of regexps (to match group names) and method to be used when
1686 posting an article."
1687 :variable-group gnus-group-foreign
1689 '(choice :tag "Posting Method"
1690 (const :tag "Use native server" native)
1691 (const :tag "Use current server" current)
1692 (list :convert-widget
1694 (list 'sexp :tag "Methods"
1695 :value gnus-select-method))))
1697 "Posting method for this group.")
1699 (gnus-define-group-parameter
1700 large-newsgroup-initial
1703 "Return GROUP's initial input of the number of articles."
1705 "*Alist of group regexps and its initial input of the number of articles."
1706 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1707 (const :tag "All" nil)
1709 :parameter-document "\
1711 This number will be prompted as the initial value of the number of
1712 articles to list when the group is a large newsgroup (see
1713 `gnus-large-newsgroup'). If it is `nil', the default value is the
1714 total number of articles in the group.")
1716 (defcustom gnus-group-uncollapsed-levels 1
1717 "Number of group name elements to leave alone when making a short group name."
1718 :group 'gnus-group-visual
1721 (defcustom gnus-group-use-permanent-levels nil
1722 "*If non-nil, once you set a level, Gnus will use this level."
1723 :group 'gnus-group-levels
1728 (defcustom gnus-load-hook nil
1729 "A hook run while Gnus is loaded."
1733 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1734 "A hook called to apply kill files to a group.
1735 This hook is intended to apply a kill file to the selected newsgroup.
1736 The function `gnus-apply-kill-file' is called by default.
1738 Since a general kill file is too heavy to use only for a few
1739 newsgroups, I recommend you to use a lighter hook function. For
1740 example, if you'd like to apply a kill file to articles which contains
1741 a string `rmgroup' in subject in newsgroup `control', you can use the
1744 (setq gnus-apply-kill-hook
1747 (cond ((string-match \"control\" gnus-newsgroup-name)
1748 (gnus-kill \"Subject\" \"rmgroup\")
1749 (gnus-expunge \"X\"))))))"
1750 :group 'gnus-score-kill
1751 :options '(gnus-apply-kill-file)
1754 (defcustom gnus-group-change-level-function nil
1755 "Function run when a group level is changed.
1756 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1757 :group 'gnus-group-levels
1762 (defcustom gnus-visual
1763 '(summary-highlight group-highlight article-highlight
1765 summary-menu group-menu article-menu
1766 tree-highlight menu highlight
1767 browse-menu server-menu
1768 page-marker tree-menu binary-menu pick-menu
1770 "*Enable visual features.
1771 If `visual' is disabled, there will be no menus and few faces. Most of
1772 the visual customization options below will be ignored. Gnus will use
1773 less space and be faster as a result.
1775 This variable can also be a list of visual elements to switch on. For
1776 instance, to switch off all visual things except menus, you can say:
1778 (setq gnus-visual '(menu))
1780 Valid elements include `summary-highlight', `group-highlight',
1781 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1782 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1783 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1784 and `grouplens-menu'."
1787 :type '(set (const summary-highlight)
1788 (const group-highlight)
1789 (const article-highlight)
1791 (const summary-menu)
1793 (const article-menu)
1794 (const tree-highlight)
1803 (const grouplens-menu)))
1805 ;; Byte-compiler warning.
1806 (defvar gnus-visual)
1807 ;; Find out whether the gnus-visual TYPE is wanted.
1808 (defun gnus-visual-p (&optional type class)
1809 (and gnus-visual ; Has to be non-nil, at least.
1810 (if (not type) ; We don't care about type.
1812 (if (listp gnus-visual) ; It's a list, so we check it.
1813 (or (memq type gnus-visual)
1814 (memq class gnus-visual))
1817 (defcustom gnus-mouse-face
1819 (if (gnus-visual-p 'mouse-face 'highlight)
1820 (if (boundp 'gnus-mouse-face)
1821 (or gnus-mouse-face 'highlight)
1825 "*Face used for group or summary buffer mouse highlighting.
1826 The line beneath the mouse pointer will be highlighted with this
1831 (defcustom gnus-article-save-directory gnus-directory
1832 "*Name of the directory articles will be saved in (default \"~/News\")."
1833 :group 'gnus-article-saving
1836 (defvar gnus-plugged t
1837 "Whether Gnus is plugged or not.")
1839 (defcustom gnus-agent-cache t
1840 "Whether Gnus use agent cache.
1841 You also need to enable `gnus-agent'."
1846 (defcustom gnus-default-charset (mm-guess-mime-charset)
1847 "Default charset assumed to be used when viewing non-ASCII characters.
1848 This variable is overridden on a group-to-group basis by the
1849 gnus-group-charset-alist variable and is only used on groups not
1850 covered by that variable."
1852 :group 'gnus-charset)
1854 (defcustom gnus-agent t
1855 "Whether we want to use the Gnus agent or not.
1856 Putting (gnus-agentize) in ~/.gnus is obsolete by (setq gnus-agent t)."
1862 ;;; Internal variables
1864 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1865 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1866 (defvar gnus-draft-meta-information-header "X-Draft-From")
1867 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1868 (defvar gnus-original-article-buffer " *Original Article*")
1869 (defvar gnus-newsgroup-name nil)
1870 (defvar gnus-ephemeral-servers nil)
1871 (defvar gnus-server-method-cache nil)
1873 (defvar gnus-agent-fetching nil
1874 "Whether Gnus agent is in fetching mode.")
1876 (defvar gnus-agent-covered-methods nil)
1878 (defvar gnus-command-method nil
1879 "Dynamically bound variable that says what the current back end is.")
1881 (defvar gnus-current-select-method nil
1882 "The current method for selecting a newsgroup.")
1884 (defvar gnus-tree-buffer "*Tree*"
1885 "Buffer where Gnus thread trees are displayed.")
1888 (defvar gnus-use-generic-from nil)
1890 ;; Variable holding the user answers to all method prompts.
1891 (defvar gnus-method-history nil)
1893 ;; Variable holding the user answers to all mail method prompts.
1894 (defvar gnus-mail-method-history nil)
1896 ;; Variable holding the user answers to all group prompts.
1897 (defvar gnus-group-history nil)
1899 (defvar gnus-server-alist nil
1900 "List of available servers.")
1902 (defcustom gnus-cache-directory
1903 (nnheader-concat gnus-directory "cache/")
1904 "*The directory where cached articles will be stored."
1908 (defvar gnus-predefined-server-alist
1911 (nnspool-spool-directory ,gnus-cache-directory)
1912 (nnspool-nov-directory ,gnus-cache-directory)
1913 (nnspool-active-file
1914 ,(nnheader-concat gnus-cache-directory "active"))))
1915 "List of predefined (convenience) servers.")
1917 (defvar gnus-topic-indentation "");; Obsolete variable.
1919 (defconst gnus-article-mark-lists
1920 '((marked . tick) (replied . reply)
1921 (expirable . expire) (killed . killed)
1922 (bookmarks . bookmark) (dormant . dormant)
1923 (scored . score) (saved . save)
1924 (cached . cache) (downloadable . download)
1925 (unsendable . unsend) (forwarded . forward)
1926 (recent . recent) (seen . seen)))
1928 (defconst gnus-article-special-mark-lists
1934 ;; Propagate flags to server, with the following exceptions:
1935 ;; `seen' is private to each gnus installation
1936 ;; `cache' is a internal gnus flag for each gnus installation
1937 ;; `download' is a agent flag private to each gnus installation
1938 ;; `unsend' are for nndraft groups only
1939 ;; `score' is not a proper mark
1940 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
1941 (defconst gnus-article-unpropagated-mark-lists
1942 '(seen cache download unsend score bookmark)
1943 "Marks that shouldn't be propagated to back ends.
1944 Typical marks are those that make no sense in a standalone back end,
1945 such as a mark that says whether an article is stored in the cache
1946 \(which doesn't make sense in a standalone back end).")
1948 (defvar gnus-headers-retrieved-by nil)
1949 (defvar gnus-article-reply nil)
1950 (defvar gnus-override-method nil)
1951 (defvar gnus-article-check-size nil)
1952 (defvar gnus-opened-servers nil)
1954 (defvar gnus-current-kill-article nil)
1956 (defvar gnus-have-read-active-file nil)
1958 (defconst gnus-maintainer
1959 "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
1960 "The mail address of the T-gnus maintainers.")
1962 (defcustom gnus-info-filename nil
1963 "*Controls language of gnus Info.
1964 If nil and current-language-environment is Japanese, go to gnus-ja.
1965 Otherwise go to corresponding Info.
1966 This variable can be nil, gnus or gnus-ja."
1968 :type '(choice (const nil)
1969 (const :tag "English" gnus)
1970 (const :tag "Japanese" gnus-ja)))
1972 (defvar gnus-info-nodes
1973 '((gnus-group-mode "Group Buffer")
1974 (gnus-summary-mode "Summary Buffer")
1975 (gnus-article-mode "Article Buffer")
1976 (gnus-server-mode "Server Buffer")
1977 (gnus-browse-mode "Browse Foreign Server")
1978 (gnus-tree-mode "Tree Display"))
1979 "Alist of major modes and related Info nodes.")
1981 (defvar gnus-group-buffer "*Group*")
1982 (defvar gnus-summary-buffer "*Summary*")
1983 (defvar gnus-article-buffer "*Article*")
1984 (defvar gnus-server-buffer "*Server*")
1986 (defvar gnus-slave nil
1987 "Whether this Gnus is a slave or not.")
1989 (defvar gnus-batch-mode nil
1990 "Whether this Gnus is running in batch mode or not.")
1992 (defvar gnus-variable-list
1993 '(gnus-newsrc-options gnus-newsrc-options-n
1994 gnus-newsrc-last-checked-date
1995 gnus-newsrc-alist gnus-server-alist
1996 gnus-killed-list gnus-zombie-list
1997 gnus-topic-topology gnus-topic-alist)
1998 "Gnus variables saved in the quick startup file.")
2000 (defvar gnus-product-variable-file-list
2001 (let ((version (product-version (product-find 'gnus-vers)))
2002 (codesys (static-if (boundp 'MULE) '*ctext* 'ctext)))
2004 ((product-version ,version)
2006 (correct-string-widths))
2008 gnus-format-specs-compiled)
2010 ((product-version ,version)
2012 (correct-string-widths))
2014 gnus-format-specs)))
2015 "Alist of the methods for checking whether the contents of the T-gnus
2016 quick startup files are valid. One is for the byte-compiled format
2017 specifications, the other is for the source form. Each element should
2018 be a list which looks like follows:
2021 ((VARIABLE EXPECTED_VALUE_or_NIL)
2022 (VARIABLE EXPECTED_VALUE_or_NIL)
2024 CODING-SYSTEM_FOR_READING_FILE
2025 SYMBOL_OF_FORMAT_SPECS)")
2027 (defcustom gnus-compile-user-specs t
2028 "If non-nil, the user-defined format specs will be byte-compiled
2030 It has an effect on the values of `gnus-*-line-format-spec'."
2034 (defvar gnus-newsrc-alist nil
2035 "Assoc list of read articles.
2036 gnus-newsrc-hashtb should be kept so that both hold the same information.")
2038 (defvar gnus-newsrc-hashtb nil
2039 "Hashtable of gnus-newsrc-alist.")
2041 (defvar gnus-killed-list nil
2042 "List of killed newsgroups.")
2044 (defvar gnus-killed-hashtb nil
2045 "Hash table equivalent of gnus-killed-list.")
2047 (defvar gnus-zombie-list nil
2048 "List of almost dead newsgroups.")
2050 (defvar gnus-description-hashtb nil
2051 "Descriptions of newsgroups.")
2053 (defvar gnus-list-of-killed-groups nil
2054 "List of newsgroups that have recently been killed by the user.")
2056 (defvar gnus-active-hashtb nil
2057 "Hashtable of active articles.")
2059 (defvar gnus-moderated-hashtb nil
2060 "Hashtable of moderated newsgroups.")
2062 ;; Save window configuration.
2063 (defvar gnus-prev-winconf nil)
2065 (defvar gnus-reffed-article-number nil)
2067 ;;; Let the byte-compiler know that we know about this variable.
2068 (defvar rmail-default-rmail-file)
2070 (defvar gnus-dead-summary nil)
2072 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2073 "Regexp matching invalid groups.")
2075 ;;; End of variables.
2077 ;; Define some autoload functions Gnus might use.
2080 ;; This little mapcar goes through the list below and marks the
2081 ;; symbols in question as autoloaded functions.
2084 (let ((interactive (nth 1 (memq ':interactive package))))
2088 (when (consp function)
2089 (setq keymap (car (memq 'keymap function)))
2090 (setq function (car function)))
2091 (unless (fboundp function)
2092 (autoload function (car package) nil interactive keymap))))
2093 (if (eq (nth 1 package) ':interactive)
2096 '(("info" :interactive t Info-goto-node)
2098 ("ps-print" ps-print-preprint)
2099 ("message" :interactive t
2100 message-send-and-exit message-yank-original)
2101 ("babel" babel-as-string)
2102 ("nnmail" nnmail-split-fancy nnmail-article-group)
2103 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2104 ("rmailout" rmail-output rmail-output-to-rmail-file)
2105 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2106 rmail-show-message rmail-summary-exists
2107 rmail-select-summary rmail-update-summary)
2108 ("gnus-audio" :interactive t gnus-audio-play)
2109 ("gnus-xmas" gnus-xmas-splash)
2110 ("gnus-soup" :interactive t
2111 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2112 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2113 ("nnsoup" nnsoup-pack-replies)
2114 ("score-mode" :interactive t gnus-score-mode)
2115 ("gnus-mh" gnus-summary-save-article-folder
2116 gnus-Folder-save-name gnus-folder-save-name)
2117 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2118 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2119 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2120 gnus-demon-add-disconnection gnus-demon-add-handler
2121 gnus-demon-remove-handler)
2122 ("gnus-demon" :interactive t
2123 gnus-demon-init gnus-demon-cancel)
2124 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2125 gnus-convert-image-to-gray-x-face)
2126 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2127 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2128 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2129 gnus-nocem-unwanted-article-p)
2130 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2131 gnus-server-server-name)
2132 ("gnus-srvr" gnus-browse-foreign-server)
2133 ("gnus-cite" :interactive t
2134 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2135 gnus-article-hide-citation gnus-article-fill-cited-article
2136 gnus-article-hide-citation-in-followups)
2137 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2138 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2139 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2140 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2141 gnus-cache-possibly-remove-articles gnus-cache-request-article
2142 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2143 gnus-cache-enter-remove-article gnus-cached-article-p
2144 gnus-cache-open gnus-cache-close gnus-cache-update-article
2145 gnus-cache-articles-in-group)
2146 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2147 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2148 ("gnus-score" :interactive t
2149 gnus-summary-increase-score gnus-summary-set-score
2150 gnus-summary-raise-thread gnus-summary-raise-same-subject
2151 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2152 gnus-summary-lower-thread gnus-summary-lower-same-subject
2153 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2154 gnus-summary-current-score gnus-score-delta-default
2155 gnus-score-flush-cache gnus-score-close
2156 gnus-possibly-score-headers gnus-score-followup-article
2157 gnus-score-followup-thread)
2159 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2160 gnus-current-score-file-nondirectory gnus-score-adaptive
2161 gnus-score-find-trace gnus-score-file-name)
2162 ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2163 gnus-score-customize)
2164 ("gnus-topic" :interactive t gnus-topic-mode)
2165 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2166 gnus-subscribe-topics)
2167 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2168 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2169 ("gnus-uu" :interactive t
2170 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2171 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2172 gnus-uu-mark-by-regexp gnus-uu-mark-all
2173 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2174 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2175 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2176 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2177 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2178 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2179 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2180 gnus-uu-mark-over gnus-uu-post-news)
2181 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2182 gnus-uu-unmark-thread)
2183 ("gnus-msg" (gnus-summary-send-map keymap)
2184 gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2185 ("gnus-msg" :interactive t
2186 gnus-group-post-news gnus-group-mail gnus-group-news
2187 gnus-summary-post-news gnus-summary-news-other-window
2188 gnus-summary-followup gnus-summary-followup-with-original
2189 gnus-summary-cancel-article gnus-summary-supersede-article
2190 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2191 gnus-summary-mail-forward gnus-summary-mail-other-window
2192 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2193 gnus-summary-wide-reply gnus-summary-followup-to-mail
2194 gnus-summary-followup-to-mail-with-original gnus-bug
2195 gnus-summary-wide-reply-with-original gnus-summary-post-forward
2196 gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2197 ("gnus-picon" :interactive t gnus-treat-from-picon)
2198 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2199 gnus-grouplens-mode)
2200 ("smiley" :interactive t smiley-region)
2201 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2202 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2203 gnus-list-of-unread-articles gnus-list-of-read-articles
2204 gnus-offer-save-summaries gnus-make-thread-indent-array
2205 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2206 gnus-summary-skip-intangible gnus-summary-article-number
2207 gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2208 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2209 gnus-group-list-groups gnus-group-first-unread-group
2210 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2211 gnus-group-setup-buffer gnus-group-get-new-news
2212 gnus-group-make-help-group gnus-group-update-group
2213 gnus-group-iterate gnus-group-group-name)
2214 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2215 gnus-backlog-remove-article)
2216 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2217 gnus-article-prepare gnus-article-set-window-start
2218 gnus-article-next-page gnus-article-prev-page
2219 gnus-request-article-this-buffer gnus-article-mode
2220 gnus-article-setup-buffer gnus-narrow-to-page
2221 gnus-article-delete-invisible-text gnus-treat-article)
2222 ("gnus-art" :interactive t
2223 gnus-article-hide-headers gnus-article-hide-boring-headers
2224 gnus-article-treat-overstrike
2225 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2226 gnus-article-display-x-face
2227 gnus-article-decode-HZ
2228 gnus-article-wash-html
2229 gnus-article-unsplit-urls
2230 gnus-article-hide-pgp
2231 gnus-article-hide-pem gnus-article-hide-signature
2232 gnus-article-strip-leading-blank-lines gnus-article-date-local
2233 gnus-article-date-original gnus-article-date-lapsed
2234 gnus-article-show-all-headers
2235 ;; gnus-article-show-all
2236 gnus-article-edit-mode gnus-article-edit-article
2237 gnus-article-edit-done article-decode-encoded-words
2238 gnus-start-date-timer gnus-stop-date-timer)
2239 ("gnus-int" gnus-request-type)
2240 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2241 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2242 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2243 gnus-dup-enter-articles)
2244 ("gnus-range" gnus-copy-sequence)
2245 ("gnus-eform" gnus-edit-form)
2246 ("gnus-move" :interactive t
2247 gnus-group-move-group-to-server gnus-change-server)
2248 ("gnus-logic" gnus-score-advanced)
2249 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2250 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2251 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2252 gnus-async-halt-prefetch)
2255 ("gnus-offline" :interactive t
2256 gnus-offline-toggle-plugged
2257 gnus-offline-set-unplugged-state
2258 gnus-offline-toggle-auto-hangup
2259 gnus-offline-toggle-on/off-send-mail
2260 gnus-offline-toggle-articles-to-fetch
2261 gnus-offline-set-interval-time
2262 gnus-offline-agent-expire)
2263 ("miee" :interactive t gnspool-get-news
2264 mail-spool-send news-spool-post)
2265 ("international/mw32misc" define-process-argument-editing
2266 general-process-argument-editing-function)
2267 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2268 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2269 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2270 gnus-summary-set-agent-mark gnus-agent-save-group-info
2271 gnus-agent-request-article gnus-agent-retrieve-headers)
2272 ("gnus-agent" :interactive t
2273 gnus-unplugged gnus-agentize gnus-agent-batch)
2274 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2275 gnus-summary-save-article-vm)
2276 ("compface" uncompface)
2277 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2278 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2279 ("gnus-mlspl" :interactive t gnus-group-split-setup
2280 gnus-group-split-update))))
2283 (unless (featurep 'xemacs)
2284 (if (>= emacs-major-version 21)
2285 (autoload 'x-face-decode-message-header "x-face-e21")
2286 (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule"))))
2288 (unless (and (fboundp 'base64-encode-string)
2289 (subrp (symbol-function 'base64-encode-string)))
2292 ;; To search articles with Namazu.
2293 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2295 ;; To make nnir groups.
2296 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2298 ;; To make shimbun groups.
2299 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2301 ;; A tool for the developers.
2302 (autoload 'find-cl-run-time-functions "gnus-clfns" nil t)
2304 ;;; gnus-sum.el thingies
2307 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2308 "*The format specification of the lines in the summary buffer.
2310 It works along the same lines as a normal formatting string,
2311 with some simple extensions.
2313 %N Article number, left padded with spaces (string)
2315 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2316 %n Name of the poster (string)
2317 %a Extracted name of the poster (string)
2318 %A Extracted address of the poster (string)
2319 %F Contents of the From: header (string)
2320 %f Contents of the From: or To: headers (string)
2321 %x Contents of the Xref: header (string)
2322 %D Date of the article (string)
2323 %d Date of the article (string) in DD-MMM format
2324 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2325 %M Message-id of the article (string)
2326 %r References of the article (string)
2327 %c Number of characters in the article (integer)
2328 %L Number of lines in the article (integer)
2329 %I Indentation based on thread level (a string of spaces)
2330 %B A complex trn-style thread tree (string)
2331 The variables `gnus-sum-thread-*' can be used for customization.
2332 %T A string with two possible values: 80 spaces if the article
2333 is on thread level two or larger and 0 spaces on level one
2334 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2335 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2336 %[ Opening bracket (character, \"[\" or \"<\")
2337 %] Closing bracket (character, \"]\" or \">\")
2338 %> Spaces of length thread-level (string)
2339 %< Spaces of length (- 20 thread-level) (string)
2340 %i Article score (number)
2341 %z Article zcore (character)
2342 %t Number of articles under the current thread (number).
2343 %e Whether the thread is empty or not (character).
2344 %l GroupLens score (string).
2345 %V Total thread score (number).
2346 %P The line number (number).
2347 %O Download mark (character).
2348 %u User defined specifier. The next character in the format string should
2349 be a letter. Gnus will call the function gnus-user-format-function-X,
2350 where X is the letter following %u. The function will be passed the
2351 current header as argument. The function should return a string, which
2352 will be inserted into the summary just like information from any other
2355 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2356 with care. For reasons of efficiency, Gnus will compute what column
2357 these characters will end up in, and \"hard-code\" that. This means that
2358 it is invalid to have these specs after a variable-length spec. Well,
2359 you might not be arrested, but your summary buffer will look strange,
2360 which is bad enough.
2362 The smart choice is to have these specs as far to the left as
2365 This restriction may disappear in later versions of Gnus.
2367 General format specifiers can also be used.
2368 See `(gnus)Formatting Variables'."
2369 :link '(custom-manual "(gnus)Formatting Variables")
2371 :group 'gnus-summary-format)
2374 ;;; Skeleton keymaps
2377 (defun gnus-suppress-keymap (keymap)
2378 (suppress-keymap keymap)
2379 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2381 (define-key keymap (pop keys) 'undefined))))
2383 (defvar gnus-article-mode-map
2384 (let ((keymap (make-sparse-keymap)))
2385 (gnus-suppress-keymap keymap)
2387 (defvar gnus-summary-mode-map
2388 (let ((keymap (make-keymap)))
2389 (gnus-suppress-keymap keymap)
2391 (defvar gnus-group-mode-map
2392 (let ((keymap (make-keymap)))
2393 (gnus-suppress-keymap keymap)
2398 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2399 ;; If you want the cursor to go somewhere else, set these two
2400 ;; functions in some startup hook to whatever you want.
2401 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2402 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2404 ;;; Various macros and substs.
2406 (defun gnus-header-from (header)
2407 (mail-header-from header))
2409 (defmacro gnus-gethash (string hashtable)
2410 "Get hash value of STRING in HASHTABLE."
2411 `(symbol-value (intern-soft ,string ,hashtable)))
2413 (defmacro gnus-gethash-safe (string hashtable)
2414 "Get hash value of STRING in HASHTABLE.
2415 Return nil if not defined."
2416 `(let ((sym (intern-soft ,string ,hashtable)))
2417 (and (boundp sym) (symbol-value sym))))
2419 (defmacro gnus-sethash (string value hashtable)
2420 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2421 `(set (intern ,string ,hashtable) ,value))
2422 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2424 (defmacro gnus-group-unread (group)
2425 "Get the currently computed number of unread articles in GROUP."
2426 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2428 (defmacro gnus-group-entry (group)
2429 "Get the newsrc entry for GROUP."
2430 `(gnus-gethash ,group gnus-newsrc-hashtb))
2432 (defmacro gnus-active (group)
2433 "Get active info on GROUP."
2434 `(gnus-gethash ,group gnus-active-hashtb))
2436 (defmacro gnus-set-active (group active)
2437 "Set GROUP's active info."
2438 `(gnus-sethash ,group ,active gnus-active-hashtb))
2440 ;; Info access macros.
2442 (defmacro gnus-info-group (info)
2444 (defmacro gnus-info-rank (info)
2446 (defmacro gnus-info-read (info)
2448 (defmacro gnus-info-marks (info)
2450 (defmacro gnus-info-method (info)
2452 (defmacro gnus-info-params (info)
2455 (defmacro gnus-info-level (info)
2456 `(let ((rank (gnus-info-rank ,info)))
2460 (defmacro gnus-info-score (info)
2461 `(let ((rank (gnus-info-rank ,info)))
2462 (or (and (consp rank) (cdr rank)) 0)))
2464 (defmacro gnus-info-set-group (info group)
2465 `(setcar ,info ,group))
2466 (defmacro gnus-info-set-rank (info rank)
2467 `(setcar (nthcdr 1 ,info) ,rank))
2468 (defmacro gnus-info-set-read (info read)
2469 `(setcar (nthcdr 2 ,info) ,read))
2470 (defmacro gnus-info-set-marks (info marks &optional extend)
2472 `(gnus-info-set-entry ,info ,marks 3)
2473 `(setcar (nthcdr 3 ,info) ,marks)))
2474 (defmacro gnus-info-set-method (info method &optional extend)
2476 `(gnus-info-set-entry ,info ,method 4)
2477 `(setcar (nthcdr 4 ,info) ,method)))
2478 (defmacro gnus-info-set-params (info params &optional extend)
2480 `(gnus-info-set-entry ,info ,params 5)
2481 `(setcar (nthcdr 5 ,info) ,params)))
2483 (defun gnus-info-set-entry (info entry number)
2484 ;; Extend the info until we have enough elements.
2485 (while (<= (length info) number)
2486 (nconc info (list nil)))
2488 (setcar (nthcdr number info) entry))
2490 (defmacro gnus-info-set-level (info level)
2491 `(let ((rank (cdr ,info)))
2492 (if (consp (car rank))
2493 (setcar (car rank) ,level)
2494 (setcar rank ,level))))
2495 (defmacro gnus-info-set-score (info score)
2496 `(let ((rank (cdr ,info)))
2497 (if (consp (car rank))
2498 (setcdr (car rank) ,score)
2499 (setcar rank (cons (car rank) ,score)))))
2501 (defmacro gnus-get-info (group)
2502 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2504 ;;; Load the compatability functions.
2513 (defvar gnus-shutdown-alist nil)
2515 (defun gnus-add-shutdown (function &rest symbols)
2516 "Run FUNCTION whenever one of SYMBOLS is shut down."
2517 (push (cons function symbols) gnus-shutdown-alist))
2519 (defun gnus-shutdown (symbol)
2520 "Shut down everything that waits for SYMBOL."
2521 (let ((alist gnus-shutdown-alist)
2523 (while (setq entry (pop alist))
2524 (when (memq symbol (cdr entry))
2525 (funcall (car entry))))))
2529 ;;; Gnus Utility Functions
2532 (defun gnus-find-subscribed-addresses ()
2533 "Return a regexp matching the addresses of all subscribed mail groups.
2534 It consists of the `to-address' or `to-list' parameter of all groups
2535 with a `subscribed' parameter."
2536 (let (group address addresses)
2537 (dolist (entry (cdr gnus-newsrc-alist))
2538 (setq group (car entry))
2539 (when (gnus-parameter-subscribed group)
2540 (setq address (mail-strip-quoted-names
2541 (or (gnus-group-fast-parameter group 'to-address)
2542 (gnus-group-fast-parameter group 'to-list))))
2544 (add-to-list 'addresses address))))
2546 (list (mapconcat 'regexp-quote addresses "\\|")))))
2548 (defmacro gnus-string-or (&rest strings)
2549 "Return the first element of STRINGS that is a non-blank string.
2550 STRINGS will be evaluated in normal `or' order."
2551 `(gnus-string-or-1 ',strings))
2553 (defun gnus-string-or-1 (strings)
2556 (setq string (eval (pop strings)))
2557 (if (string-match "^[ \t]*$" string)
2559 (setq strings nil)))
2562 (defun gnus-info-find-node (&optional nodename)
2563 "Find Info documentation of Gnus."
2565 ;; Enlarge info window if needed.
2566 (let (gnus-info-buffer)
2569 (or gnus-info-filename
2570 (get-language-info current-language-environment 'gnus-info)
2573 (cadr (assq major-mode gnus-info-nodes))
2574 (and (eq (current-buffer) (get-buffer gnus-article-buffer))
2575 (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
2576 (setq gnus-info-buffer (current-buffer))
2577 (gnus-configure-windows 'info)))
2580 ;;; gnus-interactive
2583 (defvar gnus-current-prefix-symbol nil
2584 "Current prefix symbol.")
2586 (defvar gnus-current-prefix-symbols nil
2587 "List of current prefix symbols.")
2589 (defun gnus-interactive (string &optional params)
2590 "Return a list that can be fed to `interactive'.
2591 See `interactive' for full documentation.
2593 Adds the following specs:
2595 y -- The current symbolic prefix.
2596 Y -- A list of the current symbolic prefix(es).
2597 A -- Article number.
2598 H -- Article header.
2602 (while (< i (length string))
2603 (string-match ".\\([^\n]*\\)\n?" string i)
2604 (setq c (aref string i))
2606 (setq prompt (match-string 1 string)))
2607 (setq i (match-end 0))
2608 ;; We basically emulate just about everything that
2609 ;; `interactive' does, but add the specs listed above.
2613 (completing-read prompt obarray 'fboundp t))
2615 (read-buffer prompt (current-buffer) t))
2617 (read-buffer prompt (other-buffer (current-buffer))))
2621 (completing-read prompt obarray 'commandp t))
2625 (read-file-name prompt nil default-directory 'lambda))
2627 (read-file-name prompt nil nil 'lambda))
2629 (read-file-name prompt))
2631 (read-key-sequence prompt))
2633 (error "Not implemented spec"))
2635 (error "Not implemented spec"))
2639 (error "Not implemented spec"))
2641 (string-to-number (read-from-minibuffer prompt)))
2643 (prefix-numeric-value current-prefix-arg))
2649 (read-string prompt))
2651 (intern (read-string prompt)))
2653 (read-variable prompt))
2655 (read-minibuffer prompt))
2657 (eval-minibuffer prompt))
2658 ;; And here the new specs come.
2660 gnus-current-prefix-symbol)
2662 gnus-current-prefix-symbols)
2664 (gnus-group-group-name))
2666 (gnus-summary-skip-intangible)
2667 (or (get-text-property (point) 'gnus-number)
2668 (gnus-summary-last-subject)))
2670 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2672 (error "Non-implemented spec")))
2676 (push (if (< (point) (mark)) (point) (mark)) out)
2677 (push (if (> (point) (mark)) (point) (mark)) out))))
2678 (setq out (delq 'gnus-prefix-nil out))
2681 (defun gnus-symbolic-argument (&optional arg)
2682 "Read a symbolic argument and a command, and then execute command."
2684 (let* ((in-command (this-command-keys))
2685 (command in-command)
2686 gnus-current-prefix-symbols
2687 gnus-current-prefix-symbol
2689 (while (equal in-command command)
2690 (message "%s-" (key-description (this-command-keys)))
2691 (push (intern (char-to-string (read-char))) syms)
2692 (setq command (read-key-sequence nil t)))
2693 (setq gnus-current-prefix-symbols (nreverse syms)
2694 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2695 (call-interactively (key-binding command t))))
2697 ;;; More various functions.
2699 (defsubst gnus-check-backend-function (func group)
2700 "Check whether GROUP supports function FUNC.
2701 GROUP can either be a string (a group name) or a select method."
2703 (let ((method (if (stringp group)
2704 (car (gnus-find-method-for-group group))
2706 (unless (featurep method)
2708 (fboundp (intern (format "%s-%s" method func))))))
2710 (defun gnus-group-read-only-p (&optional group)
2711 "Check whether GROUP supports editing or not.
2712 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2713 that that variable is buffer-local to the summary buffers."
2714 (let ((group (or group gnus-newsgroup-name)))
2715 (not (gnus-check-backend-function 'request-replace-article group))))
2717 (defun gnus-virtual-group-p (group)
2718 "Say whether GROUP is virtual or not."
2719 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2720 gnus-valid-select-methods)))
2722 (defun gnus-news-group-p (group &optional article)
2723 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2724 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
2725 t) ;is news of course.
2726 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
2727 nil) ;must be mail then.
2728 ((vectorp article) ;Has header info.
2729 (eq (gnus-request-type group (mail-header-id article)) 'news))
2730 ((null article) ;Hasn't header info
2731 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
2732 ((< article 0) ;Virtual message
2733 nil) ;we don't know, guess mail.
2734 (t ;Has positive number
2735 (eq (gnus-request-type group article) 'news)))) ;use it.
2737 ;; Returns a list of writable groups.
2738 (defun gnus-writable-groups ()
2739 (let ((alist gnus-newsrc-alist)
2741 (while (setq group (car (pop alist)))
2742 (unless (gnus-group-read-only-p group)
2743 (push group groups)))
2746 ;; Check whether to use long file names.
2747 (defun gnus-use-long-file-name (symbol)
2748 ;; The variable has to be set...
2749 (and gnus-use-long-file-name
2750 ;; If it isn't a list, then we return t.
2751 (or (not (listp gnus-use-long-file-name))
2752 ;; If it is a list, and the list contains `symbol', we
2754 (not (memq symbol gnus-use-long-file-name)))))
2756 ;; Generate a unique new group name.
2757 (defun gnus-generate-new-group-name (leaf)
2760 (while (gnus-gethash name gnus-newsrc-hashtb)
2761 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2764 (defun gnus-ephemeral-group-p (group)
2765 "Say whether GROUP is ephemeral or not."
2766 (gnus-group-get-parameter group 'quit-config t))
2768 (defun gnus-group-quit-config (group)
2769 "Return the quit-config of GROUP."
2770 (gnus-group-get-parameter group 'quit-config t))
2772 (defun gnus-kill-ephemeral-group (group)
2773 "Remove ephemeral GROUP from relevant structures."
2774 (gnus-sethash group nil gnus-newsrc-hashtb))
2776 (defun gnus-simplify-mode-line ()
2777 "Make mode lines a bit simpler."
2778 (setq mode-line-modified (cdr gnus-mode-line-modified))
2779 (when (listp mode-line-format)
2780 (make-local-variable 'mode-line-format)
2781 (setq mode-line-format (copy-sequence mode-line-format))
2782 (when (equal (nth 3 mode-line-format) " ")
2783 (setcar (nthcdr 3 mode-line-format) " "))))
2785 ;;; Servers and groups.
2787 (defsubst gnus-server-add-address (method)
2788 (let ((method-name (symbol-name (car method))))
2789 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2790 (not (assq (intern (concat method-name "-address")) method))
2791 (memq 'physical-address (assq (car method)
2792 gnus-valid-select-methods)))
2793 (append method (list (list (intern (concat method-name "-address"))
2797 (defsubst gnus-server-to-method (server)
2798 "Map virtual server names to select methods."
2799 (or (and server (listp server) server)
2800 (cdr (assoc server gnus-server-method-cache))
2803 ;; Perhaps this is the native server?
2804 (and (equal server "native") gnus-select-method)
2805 ;; It should be in the server alist.
2806 (cdr (assoc server gnus-server-alist))
2807 ;; It could be in the predefined server alist.
2808 (cdr (assoc server gnus-predefined-server-alist))
2809 ;; If not, we look through all the opened server
2810 ;; to see whether we can find it there.
2811 (let ((opened gnus-opened-servers))
2813 (not (equal server (format "%s:%s" (caaar opened)
2817 ;; It could be a named method, search all servers
2818 (let ((servers gnus-secondary-select-methods))
2820 (not (equal server (format "%s:%s" (caar servers)
2824 (push (cons server result) gnus-server-method-cache)
2827 (defsubst gnus-server-get-method (group method)
2828 ;; Input either a server name, and extended server name, or a
2829 ;; select method, and return a select method.
2830 (cond ((stringp method)
2831 (gnus-server-to-method method))
2832 ((equal method gnus-select-method)
2834 ((and (stringp (car method))
2836 (gnus-server-extend-method group method))
2839 (equal (cadr method) ""))
2842 (gnus-server-add-address method))))
2844 (defmacro gnus-method-equal (ss1 ss2)
2845 "Say whether two servers are equal."
2849 (and (= (length s1) (length s2))
2851 (while (and s1 (member (car s1) s2))
2855 (defun gnus-methods-equal-p (m1 m2)
2856 (let ((m1 (or m1 gnus-select-method))
2857 (m2 (or m2 gnus-select-method)))
2859 (and (eq (car m1) (car m2))
2860 (or (not (memq 'address (assoc (symbol-name (car m1))
2861 gnus-valid-select-methods)))
2862 (equal (nth 1 m1) (nth 1 m2)))))))
2864 (defun gnus-server-equal (m1 m2)
2865 "Say whether two methods are equal."
2866 (let ((m1 (cond ((null m1) gnus-select-method)
2867 ((stringp m1) (gnus-server-to-method m1))
2869 (m2 (cond ((null m2) gnus-select-method)
2870 ((stringp m2) (gnus-server-to-method m2))
2872 (gnus-method-equal m1 m2)))
2874 (defun gnus-servers-using-backend (backend)
2875 "Return a list of known servers using BACKEND."
2876 (let ((opened gnus-opened-servers)
2879 (when (eq backend (caaar opened))
2880 (push (caar opened) out))
2884 (defun gnus-archive-server-wanted-p ()
2885 "Say whether the user wants to use the archive server."
2887 ((or (not gnus-message-archive-method)
2888 (not gnus-message-archive-group))
2890 ((and gnus-message-archive-method gnus-message-archive-group)
2893 (let ((active (cadr (assq 'nnfolder-active-file
2894 gnus-message-archive-method))))
2896 (file-exists-p active))))))
2898 (defsubst gnus-method-to-server-name (method)
2900 (format "%s" (car method))
2902 (or (assoc (format "%s" (car method))
2903 (gnus-methods-using 'address))
2904 (gnus-server-equal method gnus-message-archive-method))
2906 (not (string= (nth 1 method) "")))
2907 (concat "+" (nth 1 method)))))
2909 (defsubst gnus-method-to-full-server-name (method)
2910 (format "%s+%s" (car method) (nth 1 method)))
2912 (defun gnus-group-prefixed-name (group method)
2913 "Return the whole name from GROUP and METHOD."
2914 (and (stringp method) (setq method (gnus-server-to-method method)))
2915 (if (or (not method)
2916 (gnus-server-equal method "native")
2917 (string-match ":" group))
2919 (concat (gnus-method-to-server-name method) ":" group)))
2921 (defun gnus-group-real-prefix (group)
2922 "Return the prefix of the current group name."
2923 (if (string-match "^[^:]+:" group)
2924 (substring group 0 (match-end 0))
2927 (defun gnus-group-method (group)
2928 "Return the server or method used for selecting GROUP.
2929 You should probably use `gnus-find-method-for-group' instead."
2930 (let ((prefix (gnus-group-real-prefix group)))
2931 (if (equal prefix "")
2933 (let ((servers gnus-opened-servers)
2935 backend possible found)
2936 (if (string-match "^[^\\+]+\\+" prefix)
2937 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2938 server (substring prefix (match-end 0) (1- (length prefix))))
2939 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2941 (when (eq (caaar servers) backend)
2942 (setq possible (caar servers))
2943 (when (equal (cadaar servers) server)
2944 (setq found (caar servers))))
2946 (or (car (rassoc found gnus-server-alist))
2948 (car (rassoc possible gnus-server-alist))
2950 (list backend server))))))
2952 (defsubst gnus-native-method-p (method)
2953 "Return whether METHOD is the native select method."
2954 (gnus-method-equal method gnus-select-method))
2956 (defsubst gnus-secondary-method-p (method)
2957 "Return whether METHOD is a secondary select method."
2958 (let ((methods gnus-secondary-select-methods)
2959 (gmethod (gnus-server-get-method nil method)))
2961 (not (gnus-method-equal
2962 (gnus-server-get-method nil (car methods))
2964 (setq methods (cdr methods)))
2967 (defun gnus-method-simplify (method)
2968 "Return the shortest uniquely identifying string or method for METHOD."
2969 (cond ((stringp method)
2971 ((gnus-native-method-p method)
2973 ((gnus-secondary-method-p method)
2974 (format "%s:%s" (nth 0 method) (nth 1 method)))
2978 (defun gnus-groups-from-server (server)
2979 "Return a list of all groups that are fetched from SERVER."
2980 (let ((alist (cdr gnus-newsrc-alist))
2982 (while (setq info (pop alist))
2983 (when (gnus-server-equal (gnus-info-method info) server)
2984 (push (gnus-info-group info) groups)))
2985 (sort groups 'string<)))
2987 (defun gnus-group-foreign-p (group)
2988 "Say whether a group is foreign or not."
2989 (and (not (gnus-group-native-p group))
2990 (not (gnus-group-secondary-p group))))
2992 (defun gnus-group-native-p (group)
2993 "Say whether the group is native or not."
2994 (not (string-match ":" group)))
2996 (defun gnus-group-secondary-p (group)
2997 "Say whether the group is secondary or not."
2998 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3000 (defun gnus-parameters-get-parameter (group)
3001 "Return the group parameters for GROUP from `gnus-parameters'."
3003 (dolist (elem gnus-parameters)
3004 (when (string-match (car elem) group)
3006 (nconc (gnus-expand-group-parameters
3007 (car elem) (cdr elem) group)
3011 (defun gnus-expand-group-parameter (match value group)
3012 "Use MATCH to expand VALUE in GROUP."
3015 (goto-char (point-min))
3016 (while (re-search-forward match nil t)
3017 (replace-match value))
3020 (defun gnus-expand-group-parameters (match parameters group)
3021 "Go through PARAMETERS and expand them according to the match data."
3023 (dolist (elem parameters)
3024 (if (and (stringp (cdr elem))
3025 (string-match "\\\\[0-9&]" (cdr elem)))
3026 (push (cons (car elem)
3027 (gnus-expand-group-parameter match (cdr elem) group))
3032 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3033 "For GROUP, return the value of SYMBOL.
3035 You should call this in the `gnus-group-buffer' buffer.
3036 The function `gnus-group-find-parameter' will do that for you."
3037 ;; The speed trick: No cons'ing and quit early.
3038 (or (let ((params (funcall gnus-group-get-parameter-function group)))
3039 ;; Start easy, check the "real" group parameters.
3040 (gnus-group-parameter-value params symbol allow-list))
3041 ;; We didn't found it there, try `gnus-parameters'.
3044 (tail gnus-parameters))
3045 ;; A good old-fashioned non-cl loop.
3047 (setq head (car tail)
3049 ;; The car is regexp matching for matching the group name.
3050 (when (string-match (car head) group)
3051 ;; The cdr is the parameters.
3052 (setq result (gnus-group-parameter-value (cdr head)
3055 ;; Expand if necessary.
3056 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3057 (setq result (gnus-expand-group-parameter (car head)
3059 ;; Exit the loop early.
3064 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3065 "Return the group parameters for GROUP.
3066 If SYMBOL, return the value of that symbol in the group parameters.
3068 If you call this function inside a loop, consider using the faster
3069 `gnus-group-fast-parameter' instead."
3071 (set-buffer gnus-group-buffer)
3073 (gnus-group-fast-parameter group symbol allow-list)
3076 (funcall gnus-group-get-parameter-function group))
3077 (gnus-parameters-get-parameter group)))))
3079 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3080 "Return the group parameters for GROUP.
3081 If SYMBOL, return the value of that symbol in the group parameters.
3082 Most functions should use `gnus-group-find-parameter', which
3083 also examines the topic parameters."
3084 (let ((params (gnus-info-params (gnus-get-info group))))
3086 (gnus-group-parameter-value params symbol allow-list)
3089 (defun gnus-group-parameter-value (params symbol &optional allow-list)
3090 "Return the value of SYMBOL in group PARAMS."
3091 ;; We only wish to return group parameters (dotted lists) and
3092 ;; not local variables, which may have the same names.
3093 ;; But first we handle single elements...
3094 (or (car (memq symbol params))
3098 (while (setq elem (pop params))
3099 (when (and (consp elem)
3100 (eq (car elem) symbol)
3103 (throw 'found (cdr elem))))))))
3105 (defun gnus-group-add-parameter (group param)
3106 "Add parameter PARAM to GROUP."
3107 (let ((info (gnus-get-info group)))
3109 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3110 ;; Cons the new param to the old one and update.
3111 (gnus-group-set-info (cons param (gnus-info-params info))
3114 (defun gnus-group-set-parameter (group name value)
3115 "Set parameter NAME to VALUE in GROUP."
3116 (let ((info (gnus-get-info group)))
3118 (gnus-group-remove-parameter group name)
3119 (let ((old-params (gnus-info-params info))
3120 (new-params (list (cons name value))))
3122 (when (or (not (listp (car old-params)))
3123 (not (eq (caar old-params) name)))
3124 (setq new-params (append new-params (list (car old-params)))))
3125 (setq old-params (cdr old-params)))
3126 (gnus-group-set-info new-params group 'params)))))
3128 (defun gnus-group-remove-parameter (group name)
3129 "Remove parameter NAME from GROUP."
3130 (let ((info (gnus-get-info group)))
3132 (let ((params (gnus-info-params info)))
3134 (setq params (delq name params))
3135 (while (assq name params)
3136 (gnus-pull name params))
3137 (gnus-info-set-params info params))))))
3139 (defun gnus-group-add-score (group &optional score)
3140 "Add SCORE to the GROUP score.
3141 If SCORE is nil, add 1 to the score of GROUP."
3142 (let ((info (gnus-get-info group)))
3144 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3146 (defun gnus-short-group-name (group &optional levels)
3147 "Collapse GROUP name LEVELS.
3148 Select methods are stripped and any remote host name is stripped down to
3149 just the host name."
3155 gnus-group-uncollapsed-levels
3157 (while (string-match "\\." group skip)
3158 (setq skip (match-end 0)
3161 ;; Separate foreign select method from group name and collapse.
3162 ;; If method contains a server, collapse to non-domain server name,
3163 ;; otherwise collapse to select method.
3164 (let* ((colon (string-match ":" group))
3165 (server (and colon (substring group 0 colon)))
3166 (plus (and server (string-match "+" server))))
3169 (setq foreign (substring server (+ 1 plus)
3170 (string-match "\\." server))
3171 group (substring group (+ 1 colon)))
3172 (setq foreign server
3173 group (substring group (+ 1 colon))))
3174 (setq foreign (concat foreign ":")))
3175 ;; Collapse group name leaving LEVELS uncollapsed elements
3176 (let* ((slist (split-string group "/"))
3177 (slen (length slist))
3178 (dlist (split-string group "\\."))
3179 (dlen (length dlist))
3191 (setq levels (- glen levels))
3193 (push (if (>= (decf levels) 0)
3194 (if (zerop (length g))
3199 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3201 (defun gnus-narrow-to-body ()
3202 "Narrow to the body of an article."
3205 (goto-char (point-min))
3206 (or (search-forward "\n\n" nil t)
3212 ;;; Kill file handling.
3215 (defun gnus-apply-kill-file ()
3216 "Apply a kill file to the current newsgroup.
3217 Returns the number of articles marked as read."
3218 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3219 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3220 (gnus-apply-kill-file-internal)
3223 (defun gnus-kill-save-kill-buffer ()
3224 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3225 (when (get-file-buffer file)
3227 (set-buffer (get-file-buffer file))
3228 (when (buffer-modified-p)
3230 (kill-buffer (current-buffer))))))
3232 (defcustom gnus-kill-file-name "KILL"
3233 "Suffix of the kill files."
3234 :group 'gnus-score-kill
3235 :group 'gnus-score-files
3238 (defun gnus-newsgroup-kill-file (newsgroup)
3239 "Return the name of a kill file name for NEWSGROUP.
3240 If NEWSGROUP is nil, return the global kill file name instead."
3242 ;; The global KILL file is placed at top of the directory.
3243 ((or (null newsgroup)
3244 (string-equal newsgroup ""))
3245 (expand-file-name gnus-kill-file-name
3246 gnus-kill-files-directory))
3247 ;; Append ".KILL" to newsgroup name.
3248 ((gnus-use-long-file-name 'not-kill)
3249 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3250 "." gnus-kill-file-name)
3251 gnus-kill-files-directory))
3252 ;; Place "KILL" under the hierarchical directory.
3254 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3255 "/" gnus-kill-file-name)
3256 gnus-kill-files-directory))))
3260 (defun gnus-member-of-valid (symbol group)
3261 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3263 (symbol-name (car (gnus-find-method-for-group group)))
3264 gnus-valid-select-methods)))
3266 (defun gnus-method-option-p (method option)
3267 "Return non-nil if select METHOD has OPTION as a parameter."
3268 (when (stringp method)
3269 (setq method (gnus-server-to-method method)))
3270 (memq option (assoc (format "%s" (car method))
3271 gnus-valid-select-methods)))
3273 (defun gnus-similar-server-opened (method)
3274 (let ((opened gnus-opened-servers))
3275 (while (and method opened)
3276 (when (and (equal (cadr method) (cadaar opened))
3277 (equal (car method) (caaar opened))
3278 (not (equal method (caar opened))))
3283 (defun gnus-server-extend-method (group method)
3284 ;; This function "extends" a virtual server. If the server is
3285 ;; "hello", and the select method is ("hello" (my-var "something"))
3286 ;; in the group "alt.alt", this will result in a new virtual server
3287 ;; called "hello+alt.alt".
3288 (if (or (not (inline (gnus-similar-server-opened method)))
3289 (not (cddr method)))
3291 `(,(car method) ,(concat (cadr method) "+" group)
3292 (,(intern (format "%s-address" (car method))) ,(cadr method))
3295 (defun gnus-server-status (method)
3296 "Return the status of METHOD."
3297 (nth 1 (assoc method gnus-opened-servers)))
3299 (defun gnus-group-name-to-method (group)
3300 "Guess a select method based on GROUP."
3301 (if (string-match ":" group)
3302 (let ((server (substring group 0 (match-beginning 0))))
3303 (if (string-match "\\+" server)
3304 (list (intern (substring server 0 (match-beginning 0)))
3305 (substring server (match-end 0)))
3306 (list (intern server) "")))
3307 gnus-select-method))
3309 (defun gnus-server-string (server)
3310 "Return a readable string that describes SERVER."
3311 (let* ((server (gnus-server-to-method server))
3312 (address (nth 1 server)))
3314 (not (zerop (length address))))
3315 (format "%s using %s" address (car server))
3316 (format "%s" (car server)))))
3318 (defun gnus-find-method-for-group (group &optional info)
3319 "Find the select method that GROUP uses."
3320 (or gnus-override-method
3323 (and (not (gnus-group-entry group));; a new group
3324 (gnus-group-name-to-method group))
3325 (let ((info (or info (gnus-get-info group)))
3328 (not (setq method (gnus-info-method info)))
3329 (equal method "native"))
3332 (cond ((stringp method)
3333 (inline (gnus-server-to-method method)))
3334 ((stringp (cadr method))
3335 (inline (gnus-server-extend-method group method)))
3338 (cond ((equal (cadr method) "")
3340 ((null (cadr method))
3341 (list (car method) ""))
3343 (gnus-server-add-address method)))))))
3345 (defun gnus-methods-using (feature)
3346 "Find all methods that have FEATURE."
3347 (let ((valids gnus-valid-select-methods)
3350 (when (memq feature (car valids))
3351 (push (car valids) outs))
3352 (setq valids (cdr valids)))
3355 (defun gnus-read-group (prompt &optional default)
3356 "Prompt the user for a group name.
3357 Disallow invalid group names."
3362 gnus-invalid-group-regexp
3363 (setq group (read-string (concat prefix prompt)
3364 (cons (or default "") 0)
3365 'gnus-group-history)))
3366 (setq prefix (format "Invalid group name: \"%s\". " group)
3370 (defun gnus-read-method (prompt)
3371 "Prompt the user for a method.
3372 Allow completion over sensible values."
3373 (let* ((open-servers
3374 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3375 gnus-opened-servers))
3378 (dolist (method gnus-valid-select-methods)
3379 (if (or (memq 'prompt-address method)
3380 (not (assoc (format "%s:" (car method)) open-servers)))
3381 (push method methods)))
3384 (append valid-methods
3386 gnus-predefined-server-alist
3391 nil t nil 'gnus-method-history)))
3394 (setq method gnus-select-method))
3395 ((assoc method gnus-valid-select-methods)
3396 (let ((address (if (memq 'prompt-address
3397 (assoc method gnus-valid-select-methods))
3398 (read-string "Address: ")
3400 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3401 (list (intern method) address))))
3402 ((assoc method servers)
3405 (list (intern method) "")))))
3409 (defun gnus-agent-method-p (method)
3410 "Say whether METHOD is covered by the agent."
3411 (member method gnus-agent-covered-methods))
3413 (defun gnus-online (method)
3416 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3417 (gnus-agent-method-p method))))
3419 ;;; User-level commands.
3422 (defun gnus-slave-no-server (&optional arg)
3423 "Read network news as a slave, without connecting to the local server."
3425 (gnus-no-server arg t))
3428 (defun gnus-no-server (&optional arg slave)
3430 If ARG is a positive number, Gnus will use that as the startup
3431 level. If ARG is nil, Gnus will be started at level 2. If ARG is
3432 non-nil and not a positive number, Gnus will prompt the user for the
3433 name of an NNTP server to use.
3434 As opposed to `gnus', this command will not connect to the local
3437 (gnus-no-server-1 arg slave))
3440 (defun gnus-slave (&optional arg)
3441 "Read news as a slave."
3443 (gnus arg nil 'slave))
3445 (defcustom gnus-frame-properties nil
3446 "The properties of the frame in which gnus is displayed. Under XEmacs,
3447 the variable `toolbar-news-frame-plist' will be refered instead."
3448 :type '(repeat (cons :format "%v"
3449 (symbol :tag "Parameter")
3450 (sexp :tag "Value")))
3453 (defvar gnus-frame nil
3454 "The frame in which gnus is displayed. It is not used under XEmacs.")
3457 (defun gnus-other-frame (&optional arg)
3458 "Pop up a frame to read news."
3460 (static-if (featurep 'xemacs)
3461 (let ((toolbar-news-use-separate-frame t))
3463 (if (frame-live-p gnus-frame)
3464 (raise-frame gnus-frame)
3465 (setq gnus-frame (make-frame gnus-frame-properties))
3466 (if (and (gnus-buffer-live-p gnus-group-buffer)
3467 (save-current-buffer
3468 (set-buffer gnus-group-buffer)
3469 (eq 'gnus-group-mode major-mode)))
3471 (select-frame gnus-frame)
3472 (switch-to-buffer gnus-group-buffer))
3473 (add-hook 'gnus-exit-gnus-hook
3475 (when (and (frame-live-p gnus-frame)
3477 (delete-frame gnus-frame))
3478 (setq gnus-frame nil)))
3479 (select-frame gnus-frame)
3483 (defun gnus (&optional arg dont-connect slave)
3485 If ARG is non-nil and a positive number, Gnus will use that as the
3486 startup level. If ARG is non-nil and not a positive number, Gnus will
3487 prompt the user for the name of an NNTP server to use."
3489 (unless (byte-code-function-p (symbol-function 'gnus))
3490 (message "You should byte-compile Gnus")
3492 (gnus-1 arg dont-connect slave))
3494 ;; Allow redefinition of Gnus functions.
3498 (product-provide (provide 'gnus) 'gnus-vers)
3500 ;;; gnus.el ends here