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-summary-mail nil
148 "Mail group commands."
149 :link '(custom-manual "(gnus)Mail Group Commands")
150 :group 'gnus-summary)
152 (defgroup gnus-summary-sort nil
153 "Sorting the summary buffer."
154 :link '(custom-manual "(gnus)Sorting")
155 :group 'gnus-summary)
157 (defgroup gnus-summary-visual nil
158 "Highlighting and menus in the summary buffer."
159 :link '(custom-manual "(gnus)Summary Highlighting")
161 :group 'gnus-summary)
163 (defgroup gnus-summary-various nil
164 "Various summary buffer options."
165 :link '(custom-manual "(gnus)Various Summary Stuff")
166 :group 'gnus-summary)
168 (defgroup gnus-summary-pick nil
169 "Pick mode in the summary buffer."
170 :link '(custom-manual "(gnus)Pick and Read")
172 :group 'gnus-summary)
174 (defgroup gnus-summary-tree nil
175 "Tree display of threads in the summary buffer."
176 :link '(custom-manual "(gnus)Tree Display")
178 :group 'gnus-summary)
180 ;; Belongs to gnus-uu.el
181 (defgroup gnus-extract-view nil
182 "Viewing extracted files."
183 :link '(custom-manual "(gnus)Viewing Files")
184 :group 'gnus-extract)
186 ;; Belongs to gnus-score.el
187 (defgroup gnus-score nil
188 "Score and kill file handling."
191 (defgroup gnus-score-kill nil
195 (defgroup gnus-score-adapt nil
196 "Adaptive score files."
199 (defgroup gnus-score-default nil
200 "Default values for score files."
203 (defgroup gnus-score-expire nil
204 "Expiring score rules."
207 (defgroup gnus-score-decay nil
208 "Decaying score rules."
211 (defgroup gnus-score-files nil
212 "Score and kill file names."
216 (defgroup gnus-score-various nil
217 "Various scoring and killing options."
221 (defgroup gnus-visual nil
222 "Options controling the visual fluff."
226 (defgroup gnus-agent nil
227 "Offline support for Gnus."
230 (defgroup gnus-files nil
231 "Files used by Gnus."
234 (defgroup gnus-dribble-file nil
236 :link '(custom-manual "(gnus)Auto Save")
239 (defgroup gnus-newsrc nil
240 "Storing Gnus state."
243 (defgroup gnus-server nil
244 "Options related to newsservers and other servers used by Gnus."
247 (defgroup gnus-server-visual nil
248 "Highlighting and menus in the server buffer."
252 (defgroup gnus-message '((message custom-group))
253 "Composing replies and followups in Gnus."
256 (defgroup gnus-meta nil
257 "Meta variables controling major portions of Gnus.
258 In general, modifying these variables does not take affect until Gnus
259 is restarted, and sometimes reloaded."
262 (defgroup gnus-various nil
263 "Other Gnus options."
264 :link '(custom-manual "(gnus)Various Various")
267 (defgroup gnus-mime nil
268 "Variables for controlling the Gnus MIME interface."
271 (defgroup gnus-exit nil
273 :link '(custom-manual "(gnus)Exiting Gnus")
276 (defgroup gnus-fun nil
277 "Frivolous Gnus extensions."
278 :link '(custom-manual "(gnus)Exiting Gnus")
281 (defcustom gnus-inhibit-startup-message nil
282 "If non-nil, the startup message will not be displayed.
283 This variable is used before `.gnus.el' is loaded, so it should
284 be set in `.emacs' instead."
288 (defcustom gnus-play-startup-jingle nil
289 "If non-nil, play the Gnus jingle at startup."
293 (unless (fboundp 'gnus-group-remove-excess-properties)
294 (defalias 'gnus-group-remove-excess-properties 'ignore))
296 (unless (fboundp 'gnus-set-text-properties)
297 (defalias 'gnus-set-text-properties 'set-text-properties))
299 (unless (featurep 'gnus-xmas)
300 (defalias 'gnus-make-overlay 'make-overlay)
301 (defalias 'gnus-delete-overlay 'delete-overlay)
302 (defalias 'gnus-overlay-put 'overlay-put)
303 (defalias 'gnus-move-overlay 'move-overlay)
304 (defalias 'gnus-overlay-buffer 'overlay-buffer)
305 (defalias 'gnus-overlay-start 'overlay-start)
306 (defalias 'gnus-overlay-end 'overlay-end)
307 (defalias 'gnus-extent-detached-p 'ignore)
308 (defalias 'gnus-extent-start-open 'ignore)
309 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
310 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
311 (defalias 'gnus-character-to-event 'identity)
312 (defalias 'gnus-add-text-properties 'add-text-properties)
313 (defalias 'gnus-put-text-property 'put-text-property)
314 (defvar gnus-mode-line-image-cache t)
315 (if (fboundp 'find-image)
316 (defun gnus-mode-line-buffer-identification (line)
317 (let ((str (car-safe line)))
318 (if (and (stringp str)
319 (string-match "^Gnus:" str))
320 (progn (add-text-properties
323 (if (eq t gnus-mode-line-image-cache)
324 (setq gnus-mode-line-image-cache
326 '((:type xpm :file "gnus-pointer.xpm"
328 (:type xbm :file "gnus-pointer.xbm"
330 gnus-mode-line-image-cache)
331 'help-echo "This is Gnus")
335 (defalias 'gnus-mode-line-buffer-identification 'identity))
336 (defalias 'gnus-characterp 'numberp)
337 (defalias 'gnus-deactivate-mark 'deactivate-mark)
338 (defalias 'gnus-window-edges 'window-edges)
339 (defalias 'gnus-key-press-event-p 'numberp)
340 ;;(defalias 'gnus-decode-rfc1522 'ignore)
343 ;; We define these group faces here to avoid the display
344 ;; update forced when creating new faces.
346 (defface gnus-group-news-1-face
349 (:foreground "PaleTurquoise" :bold t))
352 (:foreground "ForestGreen" :bold t))
355 "Level 1 newsgroup face.")
357 (defface gnus-group-news-1-empty-face
360 (:foreground "PaleTurquoise"))
363 (:foreground "ForestGreen"))
366 "Level 1 empty newsgroup face.")
368 (defface gnus-group-news-2-face
371 (:foreground "turquoise" :bold t))
374 (:foreground "CadetBlue4" :bold t))
377 "Level 2 newsgroup face.")
379 (defface gnus-group-news-2-empty-face
382 (:foreground "turquoise"))
385 (:foreground "CadetBlue4"))
388 "Level 2 empty newsgroup face.")
390 (defface gnus-group-news-3-face
399 "Level 3 newsgroup face.")
401 (defface gnus-group-news-3-empty-face
410 "Level 3 empty newsgroup face.")
412 (defface gnus-group-news-4-face
421 "Level 4 newsgroup face.")
423 (defface gnus-group-news-4-empty-face
432 "Level 4 empty newsgroup face.")
434 (defface gnus-group-news-5-face
443 "Level 5 newsgroup face.")
445 (defface gnus-group-news-5-empty-face
454 "Level 5 empty newsgroup face.")
456 (defface gnus-group-news-6-face
465 "Level 6 newsgroup face.")
467 (defface gnus-group-news-6-empty-face
476 "Level 6 empty newsgroup face.")
478 (defface gnus-group-news-low-face
481 (:foreground "DarkTurquoise" :bold t))
484 (:foreground "DarkGreen" :bold t))
487 "Low level newsgroup face.")
489 (defface gnus-group-news-low-empty-face
492 (:foreground "DarkTurquoise"))
495 (:foreground "DarkGreen"))
498 "Low level empty newsgroup face.")
500 (defface gnus-group-mail-1-face
503 (:foreground "aquamarine1" :bold t))
506 (:foreground "DeepPink3" :bold t))
509 "Level 1 mailgroup face.")
511 (defface gnus-group-mail-1-empty-face
514 (:foreground "aquamarine1"))
517 (:foreground "DeepPink3"))
519 (:italic t :bold t)))
520 "Level 1 empty mailgroup face.")
522 (defface gnus-group-mail-2-face
525 (:foreground "aquamarine2" :bold t))
528 (:foreground "HotPink3" :bold t))
531 "Level 2 mailgroup face.")
533 (defface gnus-group-mail-2-empty-face
536 (:foreground "aquamarine2"))
539 (:foreground "HotPink3"))
542 "Level 2 empty mailgroup face.")
544 (defface gnus-group-mail-3-face
547 (:foreground "aquamarine3" :bold t))
550 (:foreground "magenta4" :bold t))
553 "Level 3 mailgroup face.")
555 (defface gnus-group-mail-3-empty-face
558 (:foreground "aquamarine3"))
561 (:foreground "magenta4"))
564 "Level 3 empty mailgroup face.")
566 (defface gnus-group-mail-low-face
569 (:foreground "aquamarine4" :bold t))
572 (:foreground "DeepPink4" :bold t))
575 "Low level mailgroup face.")
577 (defface gnus-group-mail-low-empty-face
580 (:foreground "aquamarine4"))
583 (:foreground "DeepPink4"))
586 "Low level empty mailgroup face.")
588 ;; Summary mode faces.
590 (defface gnus-summary-selected-face '((t
592 "Face used for selected articles.")
594 (defface gnus-summary-cancelled-face
596 (:foreground "yellow" :background "black")))
597 "Face used for cancelled articles.")
599 (defface gnus-summary-high-ticked-face
602 (:foreground "pink" :bold t))
605 (:foreground "firebrick" :bold t))
608 "Face used for high interest ticked articles.")
610 (defface gnus-summary-low-ticked-face
613 (:foreground "pink" :italic t))
616 (:foreground "firebrick" :italic t))
619 "Face used for low interest ticked articles.")
621 (defface gnus-summary-normal-ticked-face
624 (:foreground "pink"))
627 (:foreground "firebrick"))
630 "Face used for normal interest ticked articles.")
632 (defface gnus-summary-high-ancient-face
635 (:foreground "SkyBlue" :bold t))
638 (:foreground "RoyalBlue" :bold t))
641 "Face used for high interest ancient articles.")
643 (defface gnus-summary-low-ancient-face
646 (:foreground "SkyBlue" :italic t))
649 (:foreground "RoyalBlue" :italic t))
652 "Face used for low interest ancient articles.")
654 (defface gnus-summary-normal-ancient-face
657 (:foreground "SkyBlue"))
660 (:foreground "RoyalBlue"))
663 "Face used for normal interest ancient articles.")
665 (defface gnus-summary-high-unread-face
668 "Face used for high interest unread articles.")
670 (defface gnus-summary-low-unread-face
673 "Face used for low interest unread articles.")
675 (defface gnus-summary-normal-unread-face
678 "Face used for normal interest unread articles.")
680 (defface gnus-summary-incorporated-face
683 "Face used for incorporated articles.")
685 (defface gnus-summary-high-read-face
688 (:foreground "PaleGreen"
692 (:foreground "DarkGreen"
696 "Face used for high interest read articles.")
698 (defface gnus-summary-low-read-face
701 (:foreground "PaleGreen"
705 (:foreground "DarkGreen"
709 "Face used for low interest read articles.")
711 (defface gnus-summary-normal-read-face
714 (:foreground "PaleGreen"))
717 (:foreground "DarkGreen"))
720 "Face used for normal interest read articles.")
727 (defvar gnus-buffers nil)
729 (defun gnus-get-buffer-create (name)
730 "Do the same as `get-buffer-create', but store the created buffer."
731 (or (get-buffer name)
732 (car (push (get-buffer-create name) gnus-buffers))))
734 (defun gnus-add-buffer ()
735 "Add the current buffer to the list of Gnus buffers."
736 (push (current-buffer) gnus-buffers))
738 (defun gnus-buffers ()
739 "Return a list of live Gnus buffers."
740 (while (and gnus-buffers
741 (not (buffer-name (car gnus-buffers))))
743 (let ((buffers gnus-buffers))
745 (if (buffer-name (cadr buffers))
747 (setcdr buffers (cddr buffers)))))
752 (defvar gnus-group-buffer "*Group*")
755 (autoload 'gnus-play-jingle "gnus-audio"))
757 (defface gnus-splash-face
760 (:foreground "#888888"))
763 (:foreground "#888888"))
766 "Face for the splash screen.")
768 (defun gnus-splash ()
770 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
771 (let ((buffer-read-only nil))
773 (unless gnus-inhibit-startup-message
774 (gnus-group-startup-message)
776 (when gnus-play-startup-jingle
777 (gnus-play-jingle))))))
779 (defun gnus-indent-rigidly (start end arg)
780 "Indent rigidly using only spaces and no tabs."
783 (narrow-to-region start end)
785 (indent-rigidly start end arg)
786 ;; We translate tabs into spaces -- not everybody uses
787 ;; an 8-character tab.
788 (goto-char (point-min))
789 (while (search-forward "\t" nil t)
790 (replace-match " " t t))))))
792 (defvar gnus-simple-splash nil)
794 ;;(format "%02x%02x%02x" 114 66 20) "724214"
796 (defvar gnus-logo-color-alist
797 '((flame "#cc3300" "#ff2200")
798 (pine "#c0cc93" "#f8ffb8")
799 (moss "#a1cc93" "#d2ffb8")
800 (irish "#04cc90" "#05ff97")
801 (sky "#049acc" "#05deff")
802 (tin "#6886cc" "#82b6ff")
803 (velvet "#7c68cc" "#8c82ff")
804 (grape "#b264cc" "#cf7df")
805 (labia "#cc64c2" "#fd7dff")
806 (berry "#cc6485" "#ff7db5")
807 (dino "#724214" "#1e3f03")
808 (oort "#cccccc" "#888888")
809 (storm "#666699" "#99ccff")
810 (pdino "#9999cc" "#99ccff")
811 (purp "#9999cc" "#666699")
812 (neutral "#b4b4b4" "#878787")
813 (september "#bf9900" "#ffcc00"))
814 "Color alist used for the Gnus logo.")
816 (defcustom gnus-logo-color-style 'oort
817 "*Color styles used for the Gnus logo."
818 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
819 gnus-logo-color-alist))
822 (defvar gnus-logo-colors
823 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
824 "Colors used for the Gnus logo.")
826 (defun gnus-group-startup-message (&optional x y)
827 "Insert startup message in current buffer."
828 ;; Insert the message.
831 ((and (fboundp 'find-image)
833 (let* ((bg (face-background 'default))
834 (fg (face-foreground 'gnus-splash-face))
836 `((:type xpm :file "gnus.xpm"
838 (("thing" . ,(car gnus-logo-colors))
839 ("shadow" . ,(cadr gnus-logo-colors))
840 ("background" . ,bg)))
841 (:type pbm :file "gnus.pbm"
842 ;; Account for the pbm's blackground.
843 :background ,bg :foreground ,fg)
844 (:type xbm :file "gnus.xbm"
845 ;; Account for the xbm's blackground.
846 :background ,bg :foreground ,fg)))))
850 (concat gnus-product-name " " gnus-version-number
851 (if (zerop (string-to-number gnus-revision-number))
853 (concat " (r" gnus-revision-number ")"))
854 " based on " gnus-original-product-name " v"
855 gnus-original-version-number)
856 'face `(variable-pitch :background ,bg :foreground ,fg)))
857 (let ((fill-column (window-width)))
858 (center-region (point-min) (point)))
859 (let ((size (image-size image)))
860 (insert-char ?\n (max 1 (round (- (window-height)
861 (or y (cdr size))) 2)))
863 (propertize " " 'display
865 ,(max 0 (round (- (window-width)
866 (or x (car size))) 2)))))
867 (insert-image image))
868 (setq gnus-simple-splash nil)
873 _ ___ __ ___ __ _ ___
892 (goto-char (point-min))
893 (insert gnus-product-name " " gnus-version-number
894 (if (zerop (string-to-number gnus-revision-number))
896 (concat " (r" gnus-revision-number ")"))
897 " based on " gnus-original-product-name " v"
898 gnus-original-version-number)
899 (insert-char ?\ (prog1
900 (max 0 (/ (- (window-width) (point)) 2))
901 (goto-char (point-min))))
904 (gnus-indent-rigidly (point) (point-max)
905 (/ (max (- (window-width) (or x 46)) 0) 2))
906 (goto-char (point-min))
908 (let* ((pheight (count-lines (point-min) (point-max)))
909 (wheight (window-height))
910 (rest (- wheight pheight)))
911 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
913 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
914 (setq gnus-simple-splash t)))
915 (goto-char (point-min))
916 (setq mode-line-buffer-identification (concat " " gnus-version))
917 (set-buffer-modified-p t))
920 (let ((command (format "%s" this-command)))
921 (if (and (string-match "gnus" command)
922 (not (string-match "gnus-other-frame" command)))
924 (gnus-get-buffer-create gnus-group-buffer))))
931 (defcustom gnus-parameters nil
932 "Alist of group parameters.
935 ((\"mail\\\\..*\" (gnus-show-threads nil)
936 (gnus-use-scoring nil)
937 (gnus-summary-line-format
938 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
941 (\"mail\\\\.me\" (gnus-use-scoring t))
942 (\"list\\\\..*\" (total-expire . t)
943 (broken-reply-to . t)))"
944 :group 'gnus-group-various
945 :type '(repeat (cons regexp
948 (defvar gnus-group-parameters-more nil)
950 (defvar gnus-colon-keywords
952 (when (boundp 'dgnushack-colon-keywords)
953 (symbol-value 'dgnushack-colon-keywords)))
954 "List of the colon keywords should be bound at run-time. This variable
955 defaults to a proper value only if this file is byte-compiled by make.")
957 (dolist (keyword gnus-colon-keywords)
958 (set keyword keyword))
960 (defmacro gnus-define-group-parameter (param &rest rest)
961 "Define a group parameter PARAM.
962 REST is a plist of following:
963 :type One of `bool', `list' or `nil'.
964 :function The name of the function.
965 :function-document The documentation of the function.
966 :parameter-type The type for customizing the parameter.
967 :parameter-document The documentation for the parameter.
968 :variable The name of the variable.
969 :variable-document The documentation for the variable.
970 :variable-group The group for customizing the variable.
971 :variable-type The type for customizing the variable.
972 :variable-default The default value of the variable."
973 (let* ((type (plist-get rest :type))
974 (parameter-type (plist-get rest :parameter-type))
975 (parameter-document (plist-get rest :parameter-document))
976 (function (or (plist-get rest :function)
977 (intern (format "gnus-parameter-%s" param))))
978 (function-document (or (plist-get rest :function-document) ""))
979 (variable (or (plist-get rest :variable)
980 (intern (format "gnus-parameter-%s-alist" param))))
981 (variable-document (or (plist-get rest :variable-document) ""))
982 (variable-group (plist-get rest :variable-group))
983 (variable-type (or (plist-get rest :variable-type)
985 (list (regexp :tag "Group")
986 ,(car (cdr parameter-type)))))))
987 (variable-default (plist-get rest :variable-default)))
990 `(defcustom ,variable ,variable-default
992 :group 'gnus-group-parameter
993 :group ',variable-group
994 :type ,variable-type)
995 `(setq gnus-group-parameters-more
996 (delq (assq ',param gnus-group-parameters-more)
997 gnus-group-parameters-more))
998 `(add-to-list 'gnus-group-parameters-more
1001 ,parameter-document))
1003 `(defun ,function (name)
1005 (let ((params (gnus-group-find-parameter name))
1008 ((memq ',param params)
1010 ((setq val (assq ',param params))
1012 ((stringp ,variable)
1013 (string-match ,variable name))
1015 (let ((alist ,variable)
1017 (while (setq elem (pop alist))
1019 (string-match (car elem) name))
1022 (if (consp value) (car value) value))))))
1023 `(defun ,function (name)
1026 (or (gnus-group-find-parameter name ',param ,(and type t))
1027 (let ((alist ,variable)
1029 (while (setq elem (pop alist))
1031 (string-match (car elem) name))
1036 '(if (consp value) (car value) value))))))))))
1038 (defcustom gnus-home-directory "~/"
1039 "Directory variable that specifies the \"home\" directory.
1040 All other Gnus path variables are initialized from this variable."
1044 (defcustom gnus-directory (or (getenv "SAVEDIR")
1045 (nnheader-concat gnus-home-directory "News/"))
1046 "*Directory variable from which all other Gnus file variables are derived.
1048 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1049 This means that other directory variables that are initialized from
1050 this variable won't be set properly if you set this variable in `.gnus.el'.
1051 Set this variable in `.emacs' instead."
1055 (defcustom gnus-default-directory nil
1056 "*Default directory for all Gnus buffers."
1058 :type '(choice (const :tag "current" nil)
1061 ;; Site dependent variables. These variables should be defined in
1064 (defvar gnus-default-nntp-server nil
1065 "Specify a default NNTP server.
1066 This variable should be defined in paths.el, and should never be set
1068 If you want to change servers, you should use `gnus-select-method'.
1069 See the documentation to that variable.")
1071 ;; Don't touch this variable.
1072 (defvar gnus-nntp-service "nntp"
1073 "NNTP service name (\"nntp\" or 119).
1074 This is an obsolete variable, which is scarcely used. If you use an
1075 nntp server for your newsgroup and want to change the port number
1076 used to 899, you would say something along these lines:
1078 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1080 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1081 "A file with only the name of the nntp server in it."
1086 ;; This function is used to check both the environment variable
1087 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
1088 ;; an nntp server name default.
1089 (defun gnus-getenv-nntpserver ()
1090 (or (getenv "NNTPSERVER")
1091 (and (file-readable-p gnus-nntpserver-file)
1093 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
1094 (insert-file-contents gnus-nntpserver-file)
1095 (let ((name (buffer-string)))
1097 (if (string-match "\\'[ \t\n]*$" name)
1100 (kill-buffer (current-buffer))))))))
1102 (defcustom gnus-select-method
1105 (list 'nntp (or (condition-case nil
1106 (gnus-getenv-nntpserver)
1108 (when (and gnus-default-nntp-server
1109 (not (string= gnus-default-nntp-server "")))
1110 gnus-default-nntp-server)
1112 (if (or (null gnus-nntp-service)
1113 (equal gnus-nntp-service "nntp"))
1115 (list gnus-nntp-service)))
1117 "Default method for selecting a newsgroup.
1118 This variable should be a list, where the first element is how the
1119 news is to be fetched, the second is the address.
1121 For instance, if you want to get your news via NNTP from
1122 \"flab.flab.edu\", you could say:
1124 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1126 If you want to use your local spool, say:
1128 \(setq gnus-select-method (list 'nnspool (system-name)))
1130 If you use this variable, you must set `gnus-nntp-server' to nil.
1132 There is a lot more to know about select methods and virtual servers -
1133 see the manual for details."
1135 :type 'gnus-select-method)
1137 (defcustom gnus-message-archive-method "archive"
1138 "*Method used for archiving messages you've sent.
1139 This should be a mail method."
1141 :group 'gnus-message
1142 :type 'gnus-select-method)
1144 (defcustom gnus-message-archive-group nil
1145 "*Name of the group in which to save the messages you've written.
1146 This can either be a string; a list of strings; or an alist
1147 of regexps/functions/forms to be evaluated to return a string (or a list
1148 of strings). The functions are called with the name of the current
1149 group (or nil) as a parameter.
1151 If you want to save your mail in one group and the news articles you
1152 write in another group, you could say something like:
1154 \(setq gnus-message-archive-group
1155 '((if (message-news-p)
1159 Normally the group names returned by this variable should be
1160 unprefixed -- which implicitly means \"store on the archive server\".
1161 However, you may wish to store the message on some other server. In
1162 that case, just return a fully prefixed name of the group --
1163 \"nnml+private:mail.misc\", for instance."
1164 :group 'gnus-message
1165 :type '(choice (const :tag "none" nil)
1170 (defcustom gnus-secondary-servers nil
1171 "List of NNTP servers that the user can choose between interactively.
1172 To make Gnus query you for a server, you have to give `gnus' a
1173 non-numeric prefix - `C-u M-x gnus', in short."
1175 :type '(repeat string))
1177 (defcustom gnus-nntp-server nil
1178 "*The name of the host running the NNTP server.
1179 This variable is semi-obsolete. Use the `gnus-select-method'
1182 :type '(choice (const :tag "disable" nil)
1185 (defcustom gnus-secondary-select-methods nil
1186 "A list of secondary methods that will be used for reading news.
1187 This is a list where each element is a complete select method (see
1188 `gnus-select-method').
1190 If, for instance, you want to read your mail with the nnml backend,
1191 you could set this variable:
1193 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1195 :type '(repeat gnus-select-method))
1197 (defvar gnus-backup-default-subscribed-newsgroups
1198 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1199 "Default default new newsgroups the first time Gnus is run.
1200 Should be set in paths.el, and shouldn't be touched by the user.")
1202 (defcustom gnus-local-domain nil
1203 "Local domain name without a host name.
1204 The DOMAINNAME environment variable is used instead if it is defined.
1205 If the function `system-name' returns the full Internet name, there is
1206 no need to set this variable."
1207 :group 'gnus-message
1208 :type '(choice (const :tag "default" nil)
1211 (defvar gnus-local-organization nil
1212 "String with a description of what organization (if any) the user belongs to.
1213 Obsolete variable; use `message-user-organization' instead.")
1215 ;; Customization variables
1217 (defcustom gnus-refer-article-method nil
1218 "Preferred method for fetching an article by Message-ID.
1219 If you are reading news from the local spool (with nnspool), fetching
1220 articles by Message-ID is painfully slow. By setting this method to an
1221 nntp method, you might get acceptable results.
1223 The value of this variable must be a valid select method as discussed
1224 in the documentation of `gnus-select-method'.
1226 It can also be a list of select methods, as well as the special symbol
1227 `current', which means to use the current select method. If it is a
1228 list, Gnus will try all the methods in the list until it finds a match."
1230 :type '(choice (const :tag "default" nil)
1231 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1233 (repeat :menu-tag "Try multiple"
1235 :value (current (nnweb "refer" (nnweb-type dejanews)))
1236 (choice :tag "Method"
1238 (const :tag "DejaNews"
1239 (nnweb "refer" (nnweb-type dejanews)))
1240 gnus-select-method))))
1242 (defcustom gnus-group-faq-directory
1243 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1244 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1245 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1246 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1247 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1248 "/ftp@rtfm.mit.edu:/pub/usenet/"
1249 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1250 "/ftp@ftp.sunet.se:/pub/usenet/"
1251 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1252 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1253 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1254 "*Directory where the group FAQs are stored.
1255 This will most commonly be on a remote machine, and the file will be
1256 fetched by ange-ftp.
1258 This variable can also be a list of directories. In that case, the
1259 first element in the list will be used by default. The others can
1260 be used when being prompted for a site.
1262 Note that Gnus uses an aol machine as the default directory. If this
1263 feels fundamentally unclean, just think of it as a way to finally get
1264 something of value back from them.
1266 If the default site is too slow, try one of these:
1268 North America: mirrors.aol.com /pub/rtfm/usenet
1269 ftp.seas.gwu.edu /pub/rtfm
1270 rtfm.mit.edu /pub/usenet
1271 Europe: ftp.uni-paderborn.de /pub/FAQ
1272 src.doc.ic.ac.uk /usenet/news-FAQS
1273 ftp.sunet.se /pub/usenet
1274 ftp.pasteur.fr /pub/FAQ
1275 Asia: nctuccca.edu.tw /USENET/FAQ
1276 hwarang.postech.ac.kr /pub/usenet
1277 ftp.hk.super.net /mirror/faqs"
1278 :group 'gnus-group-various
1279 :type '(choice directory
1280 (repeat directory)))
1282 (defcustom gnus-use-cross-reference t
1283 "*Non-nil means that cross referenced articles will be marked as read.
1284 If nil, ignore cross references. If t, mark articles as read in
1285 subscribed newsgroups. If neither t nor nil, mark as read in all
1288 :type '(choice (const :tag "off" nil)
1289 (const :tag "subscribed" t)
1293 (defcustom gnus-process-mark ?#
1295 :group 'gnus-group-visual
1296 :group 'gnus-summary-marks
1299 (defcustom gnus-large-newsgroup 200
1300 "*The number of articles which indicates a large newsgroup.
1301 If the number of articles in a newsgroup is greater than this value,
1302 confirmation is required for selecting the newsgroup.
1303 If it is `nil', no confirmation is required."
1304 :group 'gnus-group-select
1307 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1308 "*Non-nil means that the default name of a file to save articles in is the group name.
1309 If it's nil, the directory form of the group name is used instead.
1311 If this variable is a list, and the list contains the element
1312 `not-score', long file names will not be used for score files; if it
1313 contains the element `not-save', long file names will not be used for
1314 saving; and if it contains the element `not-kill', long file names
1315 will not be used for kill files.
1317 Note that the default for this variable varies according to what system
1318 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1319 to nil while on all other systems it defaults to t."
1323 (defcustom gnus-kill-files-directory gnus-directory
1324 "*Name of the directory where kill files will be stored (default \"~/News\")."
1325 :group 'gnus-score-files
1326 :group 'gnus-score-kill
1329 (defcustom gnus-save-score nil
1330 "*If non-nil, save group scoring info."
1331 :group 'gnus-score-various
1335 (defcustom gnus-use-undo t
1336 "*If non-nil, allow undoing in Gnus group mode buffers."
1340 (defcustom gnus-use-adaptive-scoring nil
1341 "*If non-nil, use some adaptive scoring scheme.
1342 If a list, then the values `word' and `line' are meaningful. The
1343 former will perform adaption on individual words in the subject
1344 header while `line' will perform adaption on several headers."
1346 :group 'gnus-score-adapt
1347 :type '(set (const word) (const line)))
1349 (defcustom gnus-use-cache 'passive
1350 "*If nil, Gnus will ignore the article cache.
1351 If `passive', it will allow entering (and reading) articles
1352 explicitly entered into the cache. If anything else, use the
1353 cache to the full extent of the law."
1356 :type '(choice (const :tag "off" nil)
1357 (const :tag "passive" passive)
1358 (const :tag "active" t)))
1360 (defcustom gnus-use-trees nil
1361 "*If non-nil, display a thread tree buffer."
1365 (defcustom gnus-use-grouplens nil
1366 "*If non-nil, use GroupLens ratings."
1370 (defcustom gnus-keep-backlog nil
1371 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1372 If it is a number N, then Gnus will only keep the last N articles
1373 read. If it is neither nil nor a number, Gnus will keep all read
1374 articles. This is not a good idea."
1376 :type '(choice (const :tag "off" nil)
1381 (defcustom gnus-use-nocem nil
1382 "*If non-nil, Gnus will read NoCeM cancel messages."
1386 (defcustom gnus-suppress-duplicates nil
1387 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1391 (defcustom gnus-use-scoring t
1392 "*If non-nil, enable scoring."
1396 (defcustom gnus-summary-prepare-exit-hook
1397 '(gnus-summary-expire-articles)
1398 "*A hook called when preparing to exit from the summary buffer.
1399 It calls `gnus-summary-expire-articles' by default."
1400 :group 'gnus-summary-exit
1403 (defcustom gnus-novice-user t
1404 "*Non-nil means that you are a usenet novice.
1405 If non-nil, verbose messages may be displayed and confirmations may be
1410 (defcustom gnus-expert-user nil
1411 "*Non-nil means that you will never be asked for confirmation about anything.
1412 That doesn't mean *anything* anything; particularly destructive
1413 commands will still require prompting."
1417 (defcustom gnus-interactive-catchup t
1418 "*If non-nil, require your confirmation when catching up a group."
1419 :group 'gnus-group-select
1422 (defcustom gnus-interactive-exit t
1423 "*If non-nil, require your confirmation when exiting Gnus."
1427 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1428 "Function for extracting address components from a From header.
1429 Three pre-defined functions exist: `gnus-extract-address-components',
1430 which is the default, quite fast, and too simplistic solution,
1431 `mail-extract-address-components', which works much better, but is
1432 slower, and `std11-extract-address-components'."
1433 :group 'gnus-summary-format
1434 :type '(radio (function-item gnus-extract-address-components)
1435 (function-item mail-extract-address-components)
1436 (function-item std11-extract-address-components)
1437 (function :tag "Other")))
1439 (defcustom gnus-carpal nil
1440 "*If non-nil, display clickable icons."
1444 (defcustom gnus-shell-command-separator ";"
1445 "String used to separate to shell commands."
1449 (defcustom gnus-valid-select-methods
1450 '(("nntp" post address prompt-address physical-address)
1451 ("nnspool" post address)
1452 ("nnvirtual" post-mail virtual prompt-address)
1453 ("nnmbox" mail respool address)
1454 ("nnml" post-mail respool address)
1455 ("nnmh" mail respool address)
1456 ("nndir" post-mail prompt-address physical-address)
1457 ("nneething" none address prompt-address physical-address)
1458 ("nndoc" none address prompt-address)
1459 ("nnbabyl" mail address respool)
1460 ("nnkiboze" post virtual)
1461 ("nnsoup" post-mail address)
1462 ("nndraft" post-mail)
1463 ("nnfolder" mail respool address)
1464 ("nngateway" post-mail address prompt-address physical-address)
1472 ("nnagent" post-mail)
1473 ("nnimap" post-mail address prompt-address physical-address)
1474 ("nnmaildir" mail respool address))
1475 "*An alist of valid select methods.
1476 The first element of each list lists should be a string with the name
1477 of the select method. The other elements may be the category of
1478 this method (i. e., `post', `mail', `none' or whatever) or other
1479 properties that this method has (like being respoolable).
1480 If you implement a new select method, all you should have to change is
1481 this variable. I think."
1483 :type '(repeat (group (string :tag "Name")
1484 (radio-button-choice (const :format "%v " post)
1485 (const :format "%v " mail)
1486 (const :format "%v " none)
1488 (checklist :inline t
1489 (const :format "%v " address)
1490 (const :format "%v " prompt-address)
1491 (const :format "%v " physical-address)
1492 (const :format "%v " virtual)
1495 (defun gnus-redefine-select-method-widget ()
1496 "Recomputes the select-method widget based on the value of
1497 `gnus-valid-select-methods'."
1498 (define-widget 'gnus-select-method 'list
1499 "Widget for entering a select method."
1501 :tag "Select Method"
1502 :args `((choice :tag "Method"
1503 ,@(mapcar (lambda (entry)
1504 (list 'const :format "%v\n"
1505 (intern (car entry))))
1506 gnus-valid-select-methods)
1507 (symbol :tag "other"))
1508 (string :tag "Address")
1509 (repeat :tag "Options"
1513 (sexp :tag "Value"))))))
1515 (gnus-redefine-select-method-widget)
1517 (defcustom gnus-updated-mode-lines '(group article summary tree)
1518 "List of buffers that should update their mode lines.
1519 The list may contain the symbols `group', `article', `tree' and
1520 `summary'. If the corresponding symbol is present, Gnus will keep
1521 that mode line updated with information that may be pertinent.
1522 If this variable is nil, screen refresh may be quicker."
1523 :group 'gnus-various
1524 :type '(set (const group)
1529 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1530 (defcustom gnus-mode-non-string-length nil
1531 "*Max length of mode-line non-string contents.
1532 If this is nil, Gnus will take space as is needed, leaving the rest
1533 of the modeline intact. Note that the default of nil is unlikely
1534 to be desirable; see the manual for further details."
1535 :group 'gnus-various
1536 :type '(choice (const nil)
1539 ;; There should be special validation for this.
1540 (define-widget 'gnus-email-address 'string
1543 (gnus-define-group-parameter
1546 "Return GROUP's to-address."
1548 "*Alist of group regexps and correspondent to-addresses."
1549 :parameter-type '(gnus-email-address :tag "To Address")
1550 :parameter-document "\
1551 This will be used when doing followups and posts.
1553 This is primarily useful in mail groups that represent closed
1554 mailing lists--mailing lists where it's expected that everybody that
1555 writes to the mailing list is subscribed to it. Since using this
1556 parameter ensures that the mail only goes to the mailing list itself,
1557 it means that members won't receive two copies of your followups.
1559 Using `to-address' will actually work whether the group is foreign or
1560 not. Let's say there's a group on the server that is called
1561 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1562 articles from a mail-to-news gateway. Posting directly to this group
1563 is therefore impossible--you have to send mail to the mailing list
1566 The gnus-group-split mail splitting mechanism will behave as if this
1567 address was listed in gnus-group-split Addresses (see below).")
1569 (gnus-define-group-parameter
1572 "Return GROUP's to-list."
1574 "*Alist of group regexps and correspondent to-lists."
1575 :parameter-type '(gnus-email-address :tag "To List")
1576 :parameter-document "\
1577 This address will be used when doing a `a' in the group.
1579 It is totally ignored when doing a followup--except that if it is
1580 present in a news group, you'll get mail group semantics when doing
1583 The gnus-group-split mail splitting mechanism will behave as if this
1584 address was listed in gnus-group-split Addresses (see below).")
1586 (gnus-define-group-parameter
1589 :function gnus-group-auto-expirable-p
1591 "Check whether GROUP is auto-expirable or not."
1592 :variable gnus-auto-expirable-newsgroups
1593 :variable-default nil
1595 "*Groups in which to automatically mark read articles as expirable.
1596 If non-nil, this should be a regexp that should match all groups in
1597 which to perform auto-expiry. This only makes sense for mail groups."
1598 :variable-group nnmail-expire
1599 :variable-type '(choice (const nil)
1601 :parameter-type '(const :tag "Automatic Expire" t)
1603 "All articles that are read will be marked as expirable.")
1605 (gnus-define-group-parameter
1608 :function gnus-group-total-expirable-p
1610 "Check whether GROUP is total-expirable or not."
1611 :variable gnus-total-expirable-newsgroups
1612 :variable-default nil
1614 "*Groups in which to perform expiry of all read articles.
1615 Use with extreme caution. All groups that match this regexp will be
1616 expiring - which means that all read articles will be deleted after
1617 \(say) one week. (This only goes for mail groups and the like, of
1619 :variable-group nnmail-expire
1620 :variable-type '(choice (const nil)
1622 :parameter-type '(const :tag "Total Expire" t)
1624 "All read articles will be put through the expiry process
1626 This happens even if they are not marked as expirable.
1629 (gnus-define-group-parameter
1632 "Return the default charset of GROUP."
1633 :variable gnus-group-charset-alist
1635 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1636 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1637 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1638 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1639 ("\\(^\\|:\\)relcom\\>" koi8-r)
1640 ("\\(^\\|:\\)fido7\\>" koi8-r)
1641 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1642 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1643 ("\\(^\\|:\\)han\\>" euc-kr)
1644 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1645 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1646 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1)
1649 "Alist of regexps (to match group names) and default charsets to be used when reading."
1650 :variable-group gnus-charset
1651 :variable-type '(repeat (list (regexp :tag "Group")
1652 (symbol :tag "Charset")))
1653 :parameter-type '(symbol :tag "Charset")
1654 :parameter-document "\
1655 The default charset to use in the group.")
1657 (gnus-define-group-parameter
1661 "Return a posting method for GROUP."
1662 :variable gnus-post-method-alist
1664 "Alist of regexps (to match group names) and method to be used when
1665 posting an article."
1666 :variable-group gnus-group-foreign
1668 '(choice :tag "Posting Method"
1669 (const :tag "Use native server" native)
1670 (const :tag "Use current server" current)
1671 (list :convert-widget
1673 (list 'sexp :tag "Methods"
1674 :value gnus-select-method))))
1676 "Posting method for this group.")
1678 (defcustom gnus-group-uncollapsed-levels 1
1679 "Number of group name elements to leave alone when making a short group name."
1680 :group 'gnus-group-visual
1683 (defcustom gnus-group-use-permanent-levels nil
1684 "*If non-nil, once you set a level, Gnus will use this level."
1685 :group 'gnus-group-levels
1690 (defcustom gnus-load-hook nil
1691 "A hook run while Gnus is loaded."
1695 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1696 "A hook called to apply kill files to a group.
1697 This hook is intended to apply a kill file to the selected newsgroup.
1698 The function `gnus-apply-kill-file' is called by default.
1700 Since a general kill file is too heavy to use only for a few
1701 newsgroups, I recommend you to use a lighter hook function. For
1702 example, if you'd like to apply a kill file to articles which contains
1703 a string `rmgroup' in subject in newsgroup `control', you can use the
1706 (setq gnus-apply-kill-hook
1709 (cond ((string-match \"control\" gnus-newsgroup-name)
1710 (gnus-kill \"Subject\" \"rmgroup\")
1711 (gnus-expunge \"X\"))))))"
1712 :group 'gnus-score-kill
1713 :options '(gnus-apply-kill-file)
1716 (defcustom gnus-group-change-level-function nil
1717 "Function run when a group level is changed.
1718 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1719 :group 'gnus-group-levels
1724 (defcustom gnus-visual
1725 '(summary-highlight group-highlight article-highlight
1727 summary-menu group-menu article-menu
1728 tree-highlight menu highlight
1729 browse-menu server-menu
1730 page-marker tree-menu binary-menu pick-menu
1732 "*Enable visual features.
1733 If `visual' is disabled, there will be no menus and few faces. Most of
1734 the visual customization options below will be ignored. Gnus will use
1735 less space and be faster as a result.
1737 This variable can also be a list of visual elements to switch on. For
1738 instance, to switch off all visual things except menus, you can say:
1740 (setq gnus-visual '(menu))
1742 Valid elements include `summary-highlight', `group-highlight',
1743 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1744 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1745 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1746 and `grouplens-menu'."
1749 :type '(set (const summary-highlight)
1750 (const group-highlight)
1751 (const article-highlight)
1753 (const summary-menu)
1755 (const article-menu)
1756 (const tree-highlight)
1765 (const grouplens-menu)))
1767 ;; Byte-compiler warning.
1768 (defvar gnus-visual)
1769 ;; Find out whether the gnus-visual TYPE is wanted.
1770 (defun gnus-visual-p (&optional type class)
1771 (and gnus-visual ; Has to be non-nil, at least.
1772 (if (not type) ; We don't care about type.
1774 (if (listp gnus-visual) ; It's a list, so we check it.
1775 (or (memq type gnus-visual)
1776 (memq class gnus-visual))
1779 (defcustom gnus-mouse-face
1781 (if (gnus-visual-p 'mouse-face 'highlight)
1782 (if (boundp 'gnus-mouse-face)
1783 (or gnus-mouse-face 'highlight)
1787 "*Face used for group or summary buffer mouse highlighting.
1788 The line beneath the mouse pointer will be highlighted with this
1793 (defcustom gnus-article-save-directory gnus-directory
1794 "*Name of the directory articles will be saved in (default \"~/News\")."
1795 :group 'gnus-article-saving
1798 (defvar gnus-plugged t
1799 "Whether Gnus is plugged or not.")
1801 (defvar gnus-agent-cache t
1802 "Whether Gnus use agent cache.")
1804 (defcustom gnus-default-charset 'iso-8859-1
1805 "Default charset assumed to be used when viewing non-ASCII characters.
1806 This variable is overridden on a group-to-group basis by the
1807 gnus-group-charset-alist variable and is only used on groups not
1808 covered by that variable."
1810 :group 'gnus-charset)
1813 ;;; Internal variables
1815 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1816 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1817 (defvar gnus-draft-meta-information-header "X-Draft-From")
1818 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1819 (defvar gnus-original-article-buffer " *Original Article*")
1820 (defvar gnus-newsgroup-name nil)
1821 (defvar gnus-ephemeral-servers nil)
1823 (defvar gnus-agent nil
1824 "Whether we want to use the Gnus agent or not.")
1826 (defvar gnus-agent-fetching nil
1827 "Whether Gnus agent is in fetching mode.")
1829 (defvar gnus-command-method nil
1830 "Dynamically bound variable that says what the current backend is.")
1832 (defvar gnus-current-select-method nil
1833 "The current method for selecting a newsgroup.")
1835 (defvar gnus-tree-buffer "*Tree*"
1836 "Buffer where Gnus thread trees are displayed.")
1839 (defvar gnus-use-generic-from nil)
1841 ;; Variable holding the user answers to all method prompts.
1842 (defvar gnus-method-history nil)
1844 ;; Variable holding the user answers to all mail method prompts.
1845 (defvar gnus-mail-method-history nil)
1847 ;; Variable holding the user answers to all group prompts.
1848 (defvar gnus-group-history nil)
1850 (defvar gnus-server-alist nil
1851 "List of available servers.")
1853 (defcustom gnus-cache-directory
1854 (nnheader-concat gnus-directory "cache/")
1855 "*The directory where cached articles will be stored."
1859 (defvar gnus-predefined-server-alist
1862 (nnspool-spool-directory ,gnus-cache-directory)
1863 (nnspool-nov-directory ,gnus-cache-directory)
1864 (nnspool-active-file
1865 ,(nnheader-concat gnus-cache-directory "active"))))
1866 "List of predefined (convenience) servers.")
1868 (defvar gnus-topic-indentation "");; Obsolete variable.
1870 (defconst gnus-article-mark-lists
1871 '((marked . tick) (replied . reply)
1872 (expirable . expire) (killed . killed)
1873 (bookmarks . bookmark) (dormant . dormant)
1874 (scored . score) (saved . save)
1875 (cached . cache) (downloadable . download)
1876 (unsendable . unsend) (forwarded . forward)
1877 (recent . recent) (seen . seen)))
1879 (defconst gnus-article-special-mark-lists
1885 ;; Propagate flags to server, with the following exceptions:
1886 ;; `seen' is private to each gnus installation
1887 ;; `cache' is a internal gnus flag for each gnus installation
1888 ;; `download' is a agent flag private to each gnus installation
1889 ;; `unsend' are for nndraft groups only
1890 ;; `score' is not a proper mark
1891 (defconst gnus-article-unpropagated-mark-lists
1892 '(seen cache download unsend score)
1893 "Marks that shouldn't be propagated to backends.
1894 Typical marks are those that make no sense in a standalone backend,
1895 such as a mark that says whether an article is stored in the cache
1896 (which doesn't make sense in a standalone backend).")
1898 (defvar gnus-headers-retrieved-by nil)
1899 (defvar gnus-article-reply nil)
1900 (defvar gnus-override-method nil)
1901 (defvar gnus-article-check-size nil)
1902 (defvar gnus-opened-servers nil)
1904 (defvar gnus-current-kill-article nil)
1906 (defvar gnus-have-read-active-file nil)
1908 (defconst gnus-maintainer
1909 "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
1910 "The mail address of the T-gnus maintainers.")
1912 (defcustom gnus-info-filename nil
1913 "*Controls language of gnus Info.
1914 If nil and current-language-environment is Japanese, go to gnus-ja.
1915 Otherwise go to corresponding Info.
1916 This variable can be nil, gnus or gnus-ja."
1918 :type '(choice (const nil)
1919 (const :tag "English" gnus)
1920 (const :tag "Japanese" gnus-ja)))
1922 (defvar gnus-info-nodes
1923 '((gnus-group-mode "Group Buffer")
1924 (gnus-summary-mode "Summary Buffer")
1925 (gnus-article-mode "Article Buffer")
1926 (gnus-server-mode "Server Buffer")
1927 (gnus-browse-mode "Browse Foreign Server")
1928 (gnus-tree-mode "Tree Display"))
1929 "Alist of major modes and related Info nodes.")
1931 (defvar gnus-group-buffer "*Group*")
1932 (defvar gnus-summary-buffer "*Summary*")
1933 (defvar gnus-article-buffer "*Article*")
1934 (defvar gnus-server-buffer "*Server*")
1936 (defvar gnus-slave nil
1937 "Whether this Gnus is a slave or not.")
1939 (defvar gnus-batch-mode nil
1940 "Whether this Gnus is running in batch mode or not.")
1942 (defvar gnus-variable-list
1943 '(gnus-newsrc-options gnus-newsrc-options-n
1944 gnus-newsrc-last-checked-date
1945 gnus-newsrc-alist gnus-server-alist
1946 gnus-killed-list gnus-zombie-list
1947 gnus-topic-topology gnus-topic-alist)
1948 "Gnus variables saved in the quick startup file.")
1950 (defvar gnus-product-variable-file-list
1951 (let ((version (product-version (product-find 'gnus-vers)))
1952 (codesys (static-if (boundp 'MULE) '*ctext* 'ctext)))
1953 `(("strict-cache" ((product-version ,version) (emacs-version))
1955 gnus-format-specs-compiled)
1956 ("cache" ((product-version ,version) (emacs-version))
1958 gnus-format-specs)))
1959 "Gnus variables are saved in the produce depend quick startup files.")
1961 (defcustom gnus-compile-user-specs t
1962 "If non-nil, the user-defined format specs will be byte-compiled
1964 It has an effect on the values of `gnus-*-line-format-spec'."
1968 (defvar gnus-newsrc-alist nil
1969 "Assoc list of read articles.
1970 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1972 (defvar gnus-newsrc-hashtb nil
1973 "Hashtable of gnus-newsrc-alist.")
1975 (defvar gnus-killed-list nil
1976 "List of killed newsgroups.")
1978 (defvar gnus-killed-hashtb nil
1979 "Hash table equivalent of gnus-killed-list.")
1981 (defvar gnus-zombie-list nil
1982 "List of almost dead newsgroups.")
1984 (defvar gnus-description-hashtb nil
1985 "Descriptions of newsgroups.")
1987 (defvar gnus-list-of-killed-groups nil
1988 "List of newsgroups that have recently been killed by the user.")
1990 (defvar gnus-active-hashtb nil
1991 "Hashtable of active articles.")
1993 (defvar gnus-moderated-hashtb nil
1994 "Hashtable of moderated newsgroups.")
1996 ;; Save window configuration.
1997 (defvar gnus-prev-winconf nil)
1999 (defvar gnus-reffed-article-number nil)
2001 ;;; Let the byte-compiler know that we know about this variable.
2002 (defvar rmail-default-rmail-file)
2004 (defvar gnus-dead-summary nil)
2006 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2007 "Regexp matching invalid groups.")
2009 ;;; End of variables.
2011 ;; Define some autoload functions Gnus might use.
2014 ;; This little mapcar goes through the list below and marks the
2015 ;; symbols in question as autoloaded functions.
2018 (let ((interactive (nth 1 (memq ':interactive package))))
2022 (when (consp function)
2023 (setq keymap (car (memq 'keymap function)))
2024 (setq function (car function)))
2025 (unless (fboundp function)
2026 (autoload function (car package) nil interactive keymap))))
2027 (if (eq (nth 1 package) ':interactive)
2030 '(("info" :interactive t Info-goto-node)
2032 ("ps-print" ps-print-preprint)
2033 ("message" :interactive t
2034 message-send-and-exit message-yank-original)
2035 ("babel" babel-as-string)
2036 ("nnmail" nnmail-split-fancy nnmail-article-group)
2037 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2038 ("rmailout" rmail-output rmail-output-to-rmail-file)
2039 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2040 rmail-show-message rmail-summary-exists
2041 rmail-select-summary rmail-update-summary)
2042 ("gnus-audio" :interactive t gnus-audio-play)
2043 ("gnus-xmas" gnus-xmas-splash)
2044 ("gnus-soup" :interactive t
2045 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2046 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2047 ("nnsoup" nnsoup-pack-replies)
2048 ("score-mode" :interactive t gnus-score-mode)
2049 ("gnus-mh" gnus-summary-save-article-folder
2050 gnus-Folder-save-name gnus-folder-save-name)
2051 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2052 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2053 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2054 gnus-demon-add-disconnection gnus-demon-add-handler
2055 gnus-demon-remove-handler)
2056 ("gnus-demon" :interactive t
2057 gnus-demon-init gnus-demon-cancel)
2058 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2059 gnus-convert-image-to-gray-x-face)
2060 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2061 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2062 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2063 gnus-nocem-unwanted-article-p)
2064 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2065 gnus-server-server-name)
2066 ("gnus-srvr" gnus-browse-foreign-server)
2067 ("gnus-cite" :interactive t
2068 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2069 gnus-article-hide-citation gnus-article-fill-cited-article
2070 gnus-article-hide-citation-in-followups)
2071 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2072 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2073 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2074 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2075 gnus-cache-possibly-remove-articles gnus-cache-request-article
2076 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2077 gnus-cache-enter-remove-article gnus-cached-article-p
2078 gnus-cache-open gnus-cache-close gnus-cache-update-article
2079 gnus-cache-articles-in-group)
2080 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2081 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2082 ("gnus-score" :interactive t
2083 gnus-summary-increase-score gnus-summary-set-score
2084 gnus-summary-raise-thread gnus-summary-raise-same-subject
2085 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2086 gnus-summary-lower-thread gnus-summary-lower-same-subject
2087 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2088 gnus-summary-current-score gnus-score-delta-default
2089 gnus-score-flush-cache gnus-score-close
2090 gnus-possibly-score-headers gnus-score-followup-article
2091 gnus-score-followup-thread)
2093 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2094 gnus-current-score-file-nondirectory gnus-score-adaptive
2095 gnus-score-find-trace gnus-score-file-name)
2096 ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2097 gnus-score-customize)
2098 ("gnus-topic" :interactive t gnus-topic-mode)
2099 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2100 gnus-subscribe-topics)
2101 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2102 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2103 ("gnus-uu" :interactive t
2104 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2105 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2106 gnus-uu-mark-by-regexp gnus-uu-mark-all
2107 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2108 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2109 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2110 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2111 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2112 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2113 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2114 gnus-uu-mark-over gnus-uu-post-news)
2115 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2116 gnus-uu-unmark-thread)
2117 ("gnus-msg" (gnus-summary-send-map keymap)
2118 gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2119 ("gnus-msg" :interactive t
2120 gnus-group-post-news gnus-group-mail gnus-group-news
2121 gnus-summary-post-news gnus-summary-news-other-window
2122 gnus-summary-followup gnus-summary-followup-with-original
2123 gnus-summary-cancel-article gnus-summary-supersede-article
2124 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2125 gnus-summary-mail-forward gnus-summary-mail-other-window
2126 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2127 gnus-summary-wide-reply gnus-summary-followup-to-mail
2128 gnus-summary-followup-to-mail-with-original gnus-bug
2129 gnus-summary-wide-reply-with-original gnus-summary-post-forward
2130 gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2131 ("gnus-picon" :interactive t gnus-treat-from-picon)
2132 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2133 gnus-grouplens-mode)
2134 ("smiley" :interactive t smiley-region)
2135 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2136 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2137 gnus-list-of-unread-articles gnus-list-of-read-articles
2138 gnus-offer-save-summaries gnus-make-thread-indent-array
2139 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2140 gnus-summary-skip-intangible gnus-summary-article-number
2141 gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2142 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2143 gnus-group-list-groups gnus-group-first-unread-group
2144 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2145 gnus-group-setup-buffer gnus-group-get-new-news
2146 gnus-group-make-help-group gnus-group-update-group
2147 gnus-group-iterate gnus-group-group-name)
2148 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2149 gnus-backlog-remove-article)
2150 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2151 gnus-article-prepare gnus-article-set-window-start
2152 gnus-article-next-page gnus-article-prev-page
2153 gnus-request-article-this-buffer gnus-article-mode
2154 gnus-article-setup-buffer gnus-narrow-to-page
2155 gnus-article-delete-invisible-text gnus-treat-article)
2156 ("gnus-art" :interactive t
2157 gnus-article-hide-headers gnus-article-hide-boring-headers
2158 gnus-article-treat-overstrike
2159 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2160 gnus-article-display-x-face
2161 gnus-article-decode-HZ
2162 gnus-article-wash-html
2163 gnus-article-hide-pgp
2164 gnus-article-hide-pem gnus-article-hide-signature
2165 gnus-article-strip-leading-blank-lines gnus-article-date-local
2166 gnus-article-date-original gnus-article-date-lapsed
2167 gnus-article-show-all-headers gnus-article-show-all
2168 gnus-article-edit-mode gnus-article-edit-article
2169 gnus-article-edit-done article-decode-encoded-words
2170 gnus-start-date-timer gnus-stop-date-timer
2171 gnus-article-toggle-headers)
2172 ("gnus-int" gnus-request-type)
2173 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2174 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2175 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2176 gnus-dup-enter-articles)
2177 ("gnus-range" gnus-copy-sequence)
2178 ("gnus-eform" gnus-edit-form)
2179 ("gnus-move" :interactive t
2180 gnus-group-move-group-to-server gnus-change-server)
2181 ("gnus-logic" gnus-score-advanced)
2182 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2183 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2184 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2185 gnus-async-halt-prefetch)
2188 ("gnus-offline" :interactive t
2189 gnus-offline-toggle-plugged
2190 gnus-offline-set-unplugged-state
2191 gnus-offline-toggle-auto-hangup
2192 gnus-offline-toggle-on/off-send-mail
2193 gnus-offline-toggle-articles-to-fetch
2194 gnus-offline-set-interval-time
2195 gnus-offline-agent-expire)
2196 ("miee" :interactive t gnspool-get-news
2197 mail-spool-send news-spool-post)
2198 ("international/mw32misc" define-process-argument-editing
2199 general-process-argument-editing-function)
2200 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2201 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2202 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2203 gnus-summary-set-agent-mark gnus-agent-save-group-info
2204 gnus-agent-request-article gnus-agent-retrieve-headers)
2205 ("gnus-agent" :interactive t
2206 gnus-unplugged gnus-agentize gnus-agent-batch)
2207 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2208 gnus-summary-save-article-vm)
2209 ("compface" uncompface)
2210 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2211 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2212 ("gnus-mlspl" :interactive t gnus-group-split-setup
2213 gnus-group-split-update))))
2216 (unless (featurep 'xemacs)
2217 (if (>= emacs-major-version 21)
2218 (autoload 'x-face-decode-message-header "x-face-e21")
2219 (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule"))))
2221 (unless (and (fboundp 'base64-encode-string)
2222 (subrp (symbol-function 'base64-encode-string)))
2225 ;; To search articles with Namazu.
2226 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2228 ;; To make nnir groups.
2229 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2231 ;; To make shimbun groups.
2232 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2234 ;; A tool for the developers.
2235 (autoload 'find-cl-run-time-functions "gnus-clfns" nil t)
2237 ;;; gnus-sum.el thingies
2240 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2241 "*The format specification of the lines in the summary buffer.
2243 It works along the same lines as a normal formatting string,
2244 with some simple extensions.
2246 %N Article number, left padded with spaces (string)
2248 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2249 %n Name of the poster (string)
2250 %a Extracted name of the poster (string)
2251 %A Extracted address of the poster (string)
2252 %F Contents of the From: header (string)
2253 %f Contents of the From: or To: headers (string)
2254 %x Contents of the Xref: header (string)
2255 %D Date of the article (string)
2256 %d Date of the article (string) in DD-MMM format
2257 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2258 %M Message-id of the article (string)
2259 %r References of the article (string)
2260 %c Number of characters in the article (integer)
2261 %L Number of lines in the article (integer)
2262 %I Indentation based on thread level (a string of spaces)
2263 %B A complex trn-style thread tree (string)
2264 The variables `gnus-sum-thread-*' can be used for customization.
2265 %T A string with two possible values: 80 spaces if the article
2266 is on thread level two or larger and 0 spaces on level one
2267 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2268 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2269 %[ Opening bracket (character, \"[\" or \"<\")
2270 %] Closing bracket (character, \"]\" or \">\")
2271 %> Spaces of length thread-level (string)
2272 %< Spaces of length (- 20 thread-level) (string)
2273 %i Article score (number)
2274 %z Article zcore (character)
2275 %t Number of articles under the current thread (number).
2276 %e Whether the thread is empty or not (character).
2277 %l GroupLens score (string).
2278 %V Total thread score (number).
2279 %P The line number (number).
2280 %O Download mark (character).
2281 %u User defined specifier. The next character in the format string should
2282 be a letter. Gnus will call the function gnus-user-format-function-X,
2283 where X is the letter following %u. The function will be passed the
2284 current header as argument. The function should return a string, which
2285 will be inserted into the summary just like information from any other
2288 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2289 with care. For reasons of efficiency, Gnus will compute what column
2290 these characters will end up in, and \"hard-code\" that. This means that
2291 it is invalid to have these specs after a variable-length spec. Well,
2292 you might not be arrested, but your summary buffer will look strange,
2293 which is bad enough.
2295 The smart choice is to have these specs as far to the left as
2298 This restriction may disappear in later versions of Gnus.
2300 General format specifiers can also be used.
2301 See (gnus)Formatting Variables."
2302 :link '(custom-manual "(gnus)Formatting Variables")
2304 :group 'gnus-summary-format)
2307 ;;; Skeleton keymaps
2310 (defun gnus-suppress-keymap (keymap)
2311 (suppress-keymap keymap)
2312 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2314 (define-key keymap (pop keys) 'undefined))))
2316 (defvar gnus-article-mode-map
2317 (let ((keymap (make-sparse-keymap)))
2318 (gnus-suppress-keymap keymap)
2320 (defvar gnus-summary-mode-map
2321 (let ((keymap (make-keymap)))
2322 (gnus-suppress-keymap keymap)
2324 (defvar gnus-group-mode-map
2325 (let ((keymap (make-keymap)))
2326 (gnus-suppress-keymap keymap)
2331 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2332 ;; If you want the cursor to go somewhere else, set these two
2333 ;; functions in some startup hook to whatever you want.
2334 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2335 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2337 ;;; Various macros and substs.
2339 (defun gnus-header-from (header)
2340 (mail-header-from header))
2342 (defmacro gnus-gethash (string hashtable)
2343 "Get hash value of STRING in HASHTABLE."
2344 `(symbol-value (intern-soft ,string ,hashtable)))
2346 (defmacro gnus-sethash (string value hashtable)
2347 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2348 `(set (intern ,string ,hashtable) ,value))
2349 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2351 (defmacro gnus-group-unread (group)
2352 "Get the currently computed number of unread articles in GROUP."
2353 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2355 (defmacro gnus-group-entry (group)
2356 "Get the newsrc entry for GROUP."
2357 `(gnus-gethash ,group gnus-newsrc-hashtb))
2359 (defmacro gnus-active (group)
2360 "Get active info on GROUP."
2361 `(gnus-gethash ,group gnus-active-hashtb))
2363 (defmacro gnus-set-active (group active)
2364 "Set GROUP's active info."
2365 `(gnus-sethash ,group ,active gnus-active-hashtb))
2367 ;; Info access macros.
2369 (defmacro gnus-info-group (info)
2371 (defmacro gnus-info-rank (info)
2373 (defmacro gnus-info-read (info)
2375 (defmacro gnus-info-marks (info)
2377 (defmacro gnus-info-method (info)
2379 (defmacro gnus-info-params (info)
2382 (defmacro gnus-info-level (info)
2383 `(let ((rank (gnus-info-rank ,info)))
2387 (defmacro gnus-info-score (info)
2388 `(let ((rank (gnus-info-rank ,info)))
2389 (or (and (consp rank) (cdr rank)) 0)))
2391 (defmacro gnus-info-set-group (info group)
2392 `(setcar ,info ,group))
2393 (defmacro gnus-info-set-rank (info rank)
2394 `(setcar (nthcdr 1 ,info) ,rank))
2395 (defmacro gnus-info-set-read (info read)
2396 `(setcar (nthcdr 2 ,info) ,read))
2397 (defmacro gnus-info-set-marks (info marks &optional extend)
2399 `(gnus-info-set-entry ,info ,marks 3)
2400 `(setcar (nthcdr 3 ,info) ,marks)))
2401 (defmacro gnus-info-set-method (info method &optional extend)
2403 `(gnus-info-set-entry ,info ,method 4)
2404 `(setcar (nthcdr 4 ,info) ,method)))
2405 (defmacro gnus-info-set-params (info params &optional extend)
2407 `(gnus-info-set-entry ,info ,params 5)
2408 `(setcar (nthcdr 5 ,info) ,params)))
2410 (defun gnus-info-set-entry (info entry number)
2411 ;; Extend the info until we have enough elements.
2412 (while (<= (length info) number)
2413 (nconc info (list nil)))
2415 (setcar (nthcdr number info) entry))
2417 (defmacro gnus-info-set-level (info level)
2418 `(let ((rank (cdr ,info)))
2419 (if (consp (car rank))
2420 (setcar (car rank) ,level)
2421 (setcar rank ,level))))
2422 (defmacro gnus-info-set-score (info score)
2423 `(let ((rank (cdr ,info)))
2424 (if (consp (car rank))
2425 (setcdr (car rank) ,score)
2426 (setcar rank (cons (car rank) ,score)))))
2428 (defmacro gnus-get-info (group)
2429 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2431 ;;; Load the compatability functions.
2440 (defvar gnus-shutdown-alist nil)
2442 (defun gnus-add-shutdown (function &rest symbols)
2443 "Run FUNCTION whenever one of SYMBOLS is shut down."
2444 (push (cons function symbols) gnus-shutdown-alist))
2446 (defun gnus-shutdown (symbol)
2447 "Shut down everything that waits for SYMBOL."
2448 (let ((alist gnus-shutdown-alist)
2450 (while (setq entry (pop alist))
2451 (when (memq symbol (cdr entry))
2452 (funcall (car entry))))))
2456 ;;; Gnus Utility Functions
2459 (defun gnus-find-subscribed-addresses ()
2460 "Return a regexp matching the addresses of all subscribed mail groups.
2461 It consists of the `to-address' or `to-list' parameter of all groups
2462 with a `subscribed' parameter."
2463 (let (group address addresses)
2464 (dolist (entry (cdr gnus-newsrc-alist))
2465 (setq group (car entry))
2466 (when (gnus-group-find-parameter group 'subscribed)
2467 (setq address (or (gnus-group-fast-parameter group 'to-address)
2468 (gnus-group-fast-parameter group 'to-list)))
2470 (push address addresses))))
2471 (list (mapconcat 'regexp-quote addresses "\\|"))))
2473 (defmacro gnus-string-or (&rest strings)
2474 "Return the first element of STRINGS that is a non-blank string.
2475 STRINGS will be evaluated in normal `or' order."
2476 `(gnus-string-or-1 ',strings))
2478 (defun gnus-string-or-1 (strings)
2481 (setq string (eval (pop strings)))
2482 (if (string-match "^[ \t]*$" string)
2484 (setq strings nil)))
2487 (defun gnus-info-find-node (&optional nodename)
2488 "Find Info documentation of Gnus."
2490 ;; Enlarge info window if needed.
2491 (let (gnus-info-buffer)
2494 (or gnus-info-filename
2495 (get-language-info current-language-environment 'gnus-info)
2498 (cadr (assq major-mode gnus-info-nodes))
2499 (and (eq (current-buffer) (get-buffer gnus-article-buffer))
2500 (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
2501 (setq gnus-info-buffer (current-buffer))
2502 (gnus-configure-windows 'info)))
2505 ;;; gnus-interactive
2508 (defvar gnus-current-prefix-symbol nil
2509 "Current prefix symbol.")
2511 (defvar gnus-current-prefix-symbols nil
2512 "List of current prefix symbols.")
2514 (defun gnus-interactive (string &optional params)
2515 "Return a list that can be fed to `interactive'.
2516 See `interactive' for full documentation.
2518 Adds the following specs:
2520 y -- The current symbolic prefix.
2521 Y -- A list of the current symbolic prefix(es).
2522 A -- Article number.
2523 H -- Article header.
2527 (while (< i (length string))
2528 (string-match ".\\([^\n]*\\)\n?" string i)
2529 (setq c (aref string i))
2531 (setq prompt (match-string 1 string)))
2532 (setq i (match-end 0))
2533 ;; We basically emulate just about everything that
2534 ;; `interactive' does, but add the specs listed above.
2538 (completing-read prompt obarray 'fboundp t))
2540 (read-buffer prompt (current-buffer) t))
2542 (read-buffer prompt (other-buffer (current-buffer))))
2546 (completing-read prompt obarray 'commandp t))
2550 (read-file-name prompt nil default-directory 'lambda))
2552 (read-file-name prompt nil nil 'lambda))
2554 (read-file-name prompt))
2556 (read-key-sequence prompt))
2558 (error "Not implemented spec"))
2560 (error "Not implemented spec"))
2564 (error "Not implemented spec"))
2566 (string-to-number (read-from-minibuffer prompt)))
2568 (prefix-numeric-value current-prefix-arg))
2574 (read-string prompt))
2576 (intern (read-string prompt)))
2578 (read-variable prompt))
2580 (read-minibuffer prompt))
2582 (eval-minibuffer prompt))
2583 ;; And here the new specs come.
2585 gnus-current-prefix-symbol)
2587 gnus-current-prefix-symbols)
2589 (gnus-group-group-name))
2591 (gnus-summary-skip-intangible)
2592 (or (get-text-property (point) 'gnus-number)
2593 (gnus-summary-last-subject)))
2595 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2597 (error "Non-implemented spec")))
2601 (push (if (< (point) (mark)) (point) (mark)) out)
2602 (push (if (> (point) (mark)) (point) (mark)) out))))
2603 (setq out (delq 'gnus-prefix-nil out))
2606 (defun gnus-symbolic-argument (&optional arg)
2607 "Read a symbolic argument and a command, and then execute command."
2609 (let* ((in-command (this-command-keys))
2610 (command in-command)
2611 gnus-current-prefix-symbols
2612 gnus-current-prefix-symbol
2614 (while (equal in-command command)
2615 (message "%s-" (key-description (this-command-keys)))
2616 (push (intern (char-to-string (read-char))) syms)
2617 (setq command (read-key-sequence nil t)))
2618 (setq gnus-current-prefix-symbols (nreverse syms)
2619 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2620 (call-interactively (key-binding command t))))
2622 ;;; More various functions.
2624 (defsubst gnus-check-backend-function (func group)
2625 "Check whether GROUP supports function FUNC.
2626 GROUP can either be a string (a group name) or a select method."
2628 (let ((method (if (stringp group)
2629 (car (gnus-find-method-for-group group))
2631 (unless (featurep method)
2633 (fboundp (intern (format "%s-%s" method func))))))
2635 (defun gnus-group-read-only-p (&optional group)
2636 "Check whether GROUP supports editing or not.
2637 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2638 that that variable is buffer-local to the summary buffers."
2639 (let ((group (or group gnus-newsgroup-name)))
2640 (not (gnus-check-backend-function 'request-replace-article group))))
2642 (defun gnus-virtual-group-p (group)
2643 "Say whether GROUP is virtual or not."
2644 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2645 gnus-valid-select-methods)))
2647 (defun gnus-news-group-p (group &optional article)
2648 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2649 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
2650 t) ;is news of course.
2651 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
2652 nil) ;must be mail then.
2653 ((vectorp article) ;Has header info.
2654 (eq (gnus-request-type group (mail-header-id article)) 'news))
2655 ((null article) ;Hasn't header info
2656 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
2657 ((< article 0) ;Virtual message
2658 nil) ;we don't know, guess mail.
2659 (t ;Has positive number
2660 (eq (gnus-request-type group article) 'news)))) ;use it.
2662 ;; Returns a list of writable groups.
2663 (defun gnus-writable-groups ()
2664 (let ((alist gnus-newsrc-alist)
2666 (while (setq group (car (pop alist)))
2667 (unless (gnus-group-read-only-p group)
2668 (push group groups)))
2671 ;; Check whether to use long file names.
2672 (defun gnus-use-long-file-name (symbol)
2673 ;; The variable has to be set...
2674 (and gnus-use-long-file-name
2675 ;; If it isn't a list, then we return t.
2676 (or (not (listp gnus-use-long-file-name))
2677 ;; If it is a list, and the list contains `symbol', we
2679 (not (memq symbol gnus-use-long-file-name)))))
2681 ;; Generate a unique new group name.
2682 (defun gnus-generate-new-group-name (leaf)
2685 (while (gnus-gethash name gnus-newsrc-hashtb)
2686 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2689 (defun gnus-ephemeral-group-p (group)
2690 "Say whether GROUP is ephemeral or not."
2691 (gnus-group-get-parameter group 'quit-config t))
2693 (defun gnus-group-quit-config (group)
2694 "Return the quit-config of GROUP."
2695 (gnus-group-get-parameter group 'quit-config t))
2697 (defun gnus-kill-ephemeral-group (group)
2698 "Remove ephemeral GROUP from relevant structures."
2699 (gnus-sethash group nil gnus-newsrc-hashtb))
2701 (defun gnus-simplify-mode-line ()
2702 "Make mode lines a bit simpler."
2703 (setq mode-line-modified (cdr gnus-mode-line-modified))
2704 (when (listp mode-line-format)
2705 (make-local-variable 'mode-line-format)
2706 (setq mode-line-format (copy-sequence mode-line-format))
2707 (when (equal (nth 3 mode-line-format) " ")
2708 (setcar (nthcdr 3 mode-line-format) " "))))
2710 ;;; Servers and groups.
2712 (defsubst gnus-server-add-address (method)
2713 (let ((method-name (symbol-name (car method))))
2714 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2715 (not (assq (intern (concat method-name "-address")) method))
2716 (memq 'physical-address (assq (car method)
2717 gnus-valid-select-methods)))
2718 (append method (list (list (intern (concat method-name "-address"))
2722 (defsubst gnus-server-get-method (group method)
2723 ;; Input either a server name, and extended server name, or a
2724 ;; select method, and return a select method.
2725 (cond ((stringp method)
2726 (gnus-server-to-method method))
2727 ((equal method gnus-select-method)
2729 ((and (stringp (car method))
2731 (gnus-server-extend-method group method))
2734 (equal (cadr method) ""))
2737 (gnus-server-add-address method))))
2739 (defun gnus-server-to-method (server)
2740 "Map virtual server names to select methods."
2742 ;; Is this a method, perhaps?
2743 (and server (listp server) server)
2744 ;; Perhaps this is the native server?
2745 (and (equal server "native") gnus-select-method)
2746 ;; It should be in the server alist.
2747 (cdr (assoc server gnus-server-alist))
2748 ;; It could be in the predefined server alist.
2749 (cdr (assoc server gnus-predefined-server-alist))
2750 ;; If not, we look through all the opened server
2751 ;; to see whether we can find it there.
2752 (let ((opened gnus-opened-servers))
2754 (not (equal server (format "%s:%s" (caaar opened)
2758 ;; It could be a named method, search all servers
2759 (let ((servers gnus-secondary-select-methods))
2761 (not (equal server (format "%s:%s" (caar servers)
2766 (defmacro gnus-method-equal (ss1 ss2)
2767 "Say whether two servers are equal."
2771 (and (= (length s1) (length s2))
2773 (while (and s1 (member (car s1) s2))
2777 (defun gnus-methods-equal-p (m1 m2)
2778 (let ((m1 (or m1 gnus-select-method))
2779 (m2 (or m2 gnus-select-method)))
2781 (and (eq (car m1) (car m2))
2782 (or (not (memq 'address (assoc (symbol-name (car m1))
2783 gnus-valid-select-methods)))
2784 (equal (nth 1 m1) (nth 1 m2)))))))
2786 (defun gnus-server-equal (m1 m2)
2787 "Say whether two methods are equal."
2788 (let ((m1 (cond ((null m1) gnus-select-method)
2789 ((stringp m1) (gnus-server-to-method m1))
2791 (m2 (cond ((null m2) gnus-select-method)
2792 ((stringp m2) (gnus-server-to-method m2))
2794 (gnus-method-equal m1 m2)))
2796 (defun gnus-servers-using-backend (backend)
2797 "Return a list of known servers using BACKEND."
2798 (let ((opened gnus-opened-servers)
2801 (when (eq backend (caaar opened))
2802 (push (caar opened) out))
2806 (defun gnus-archive-server-wanted-p ()
2807 "Say whether the user wants to use the archive server."
2809 ((or (not gnus-message-archive-method)
2810 (not gnus-message-archive-group))
2812 ((and gnus-message-archive-method gnus-message-archive-group)
2815 (let ((active (cadr (assq 'nnfolder-active-file
2816 gnus-message-archive-method))))
2818 (file-exists-p active))))))
2820 (defsubst gnus-method-to-server-name (method)
2822 (format "%s" (car method))
2824 (or (assoc (format "%s" (car method))
2825 (gnus-methods-using 'address))
2826 (gnus-server-equal method gnus-message-archive-method))
2828 (not (string= (nth 1 method) "")))
2829 (concat "+" (nth 1 method)))))
2831 (defsubst gnus-method-to-full-server-name (method)
2832 (format "%s+%s" (car method) (nth 1 method)))
2834 (defun gnus-group-prefixed-name (group method)
2835 "Return the whole name from GROUP and METHOD."
2836 (and (stringp method) (setq method (gnus-server-to-method method)))
2837 (if (or (not method)
2838 (gnus-server-equal method "native")
2839 (string-match ":" group))
2841 (concat (gnus-method-to-server-name method) ":" group)))
2843 (defun gnus-group-real-prefix (group)
2844 "Return the prefix of the current group name."
2845 (if (string-match "^[^:]+:" group)
2846 (substring group 0 (match-end 0))
2849 (defun gnus-group-method (group)
2850 "Return the server or method used for selecting GROUP.
2851 You should probably use `gnus-find-method-for-group' instead."
2852 (let ((prefix (gnus-group-real-prefix group)))
2853 (if (equal prefix "")
2855 (let ((servers gnus-opened-servers)
2857 backend possible found)
2858 (if (string-match "^[^\\+]+\\+" prefix)
2859 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2860 server (substring prefix (match-end 0) (1- (length prefix))))
2861 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2863 (when (eq (caaar servers) backend)
2864 (setq possible (caar servers))
2865 (when (equal (cadaar servers) server)
2866 (setq found (caar servers))))
2868 (or (car (rassoc found gnus-server-alist))
2870 (car (rassoc possible gnus-server-alist))
2872 (list backend server))))))
2874 (defsubst gnus-native-method-p (method)
2875 "Return whether METHOD is the native select method."
2876 (gnus-method-equal method gnus-select-method))
2878 (defsubst gnus-secondary-method-p (method)
2879 "Return whether METHOD is a secondary select method."
2880 (let ((methods gnus-secondary-select-methods)
2881 (gmethod (gnus-server-get-method nil method)))
2883 (not (gnus-method-equal
2884 (gnus-server-get-method nil (car methods))
2886 (setq methods (cdr methods)))
2889 (defun gnus-method-simplify (method)
2890 "Return the shortest uniquely identifying string or method for METHOD."
2891 (cond ((stringp method)
2893 ((gnus-native-method-p method)
2895 ((gnus-secondary-method-p method)
2896 (format "%s:%s" (nth 0 method) (nth 1 method)))
2900 (defun gnus-groups-from-server (server)
2901 "Return a list of all groups that are fetched from SERVER."
2902 (let ((alist (cdr gnus-newsrc-alist))
2904 (while (setq info (pop alist))
2905 (when (gnus-server-equal (gnus-info-method info) server)
2906 (push (gnus-info-group info) groups)))
2907 (sort groups 'string<)))
2909 (defun gnus-group-foreign-p (group)
2910 "Say whether a group is foreign or not."
2911 (and (not (gnus-group-native-p group))
2912 (not (gnus-group-secondary-p group))))
2914 (defun gnus-group-native-p (group)
2915 "Say whether the group is native or not."
2916 (not (string-match ":" group)))
2918 (defun gnus-group-secondary-p (group)
2919 "Say whether the group is secondary or not."
2920 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2922 (defun gnus-parameters-get-parameter (group)
2923 "Return the group parameters for GROUP from `gnus-parameters'."
2925 (dolist (elem gnus-parameters)
2926 (when (string-match (car elem) group)
2928 (nconc (gnus-expand-group-parameters
2929 (car elem) (cdr elem) group)
2933 (defun gnus-expand-group-parameter (match value group)
2934 "Use MATCH to expand VALUE in GROUP."
2937 (goto-char (point-min))
2938 (while (re-search-forward match nil t)
2939 (replace-match value))
2942 (defun gnus-expand-group-parameters (match parameters group)
2943 "Go through PARAMETERS and expand them according to the match data."
2945 (dolist (elem parameters)
2946 (if (and (stringp (cdr elem))
2947 (string-match "\\\\[0-9&]" (cdr elem)))
2948 (push (cons (car elem)
2949 (gnus-expand-group-parameter match (cdr elem) group))
2954 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
2955 "For GROUP, return the value of SYMBOL.
2957 You should call this in the `gnus-group-buffer' buffer.
2958 The function `gnus-group-find-parameter' will do that for you."
2959 ;; The speed trick: No cons'ing and quit early.
2960 (or (let ((params (funcall gnus-group-get-parameter-function group)))
2961 ;; Start easy, check the "real" group parameters.
2962 (gnus-group-parameter-value params symbol allow-list))
2963 ;; We didn't found it there, try `gnus-parameters'.
2966 (tail gnus-parameters))
2967 ;; A good old-fashioned non-cl loop.
2969 (setq head (car tail)
2971 ;; The car is regexp matching for matching the group name.
2972 (when (string-match (car head) group)
2973 ;; The cdr is the parameters.
2974 (setq result (gnus-group-parameter-value (cdr head)
2977 ;; Expand if necessary.
2978 (if (and (stringp result) (string-match "\\\\" result))
2979 (setq result (gnus-expand-group-parameter (car head)
2981 ;; Exit the loop early.
2986 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2987 "Return the group parameters for GROUP.
2988 If SYMBOL, return the value of that symbol in the group parameters.
2990 If you call this function inside a loop, consider using the faster
2991 `gnus-group-fast-parameter' instead."
2993 (set-buffer gnus-group-buffer)
2995 (gnus-group-fast-parameter group symbol allow-list)
2999 (funcall gnus-group-get-parameter-function group))
3000 (gnus-parameters-get-parameter group))))
3003 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3004 "Return the group parameters for GROUP.
3005 If SYMBOL, return the value of that symbol in the group parameters.
3006 Most functions should use `gnus-group-find-parameter', which
3007 also examines the topic parameters."
3008 (let ((params (gnus-info-params (gnus-get-info group))))
3010 (gnus-group-parameter-value params symbol allow-list)
3013 (defun gnus-group-parameter-value (params symbol &optional allow-list)
3014 "Return the value of SYMBOL in group PARAMS."
3015 ;; We only wish to return group parameters (dotted lists) and
3016 ;; not local variables, which may have the same names.
3017 ;; But first we handle single elements...
3018 (or (car (memq symbol params))
3022 (while (setq elem (pop params))
3023 (when (and (consp elem)
3024 (eq (car elem) symbol)
3027 (throw 'found (cdr elem))))))))
3029 (defun gnus-group-add-parameter (group param)
3030 "Add parameter PARAM to GROUP."
3031 (let ((info (gnus-get-info group)))
3033 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3034 ;; Cons the new param to the old one and update.
3035 (gnus-group-set-info (cons param (gnus-info-params info))
3038 (defun gnus-group-set-parameter (group name value)
3039 "Set parameter NAME to VALUE in GROUP."
3040 (let ((info (gnus-get-info group)))
3042 (gnus-group-remove-parameter group name)
3043 (let ((old-params (gnus-info-params info))
3044 (new-params (list (cons name value))))
3046 (when (or (not (listp (car old-params)))
3047 (not (eq (caar old-params) name)))
3048 (setq new-params (append new-params (list (car old-params)))))
3049 (setq old-params (cdr old-params)))
3050 (gnus-group-set-info new-params group 'params)))))
3052 (defun gnus-group-remove-parameter (group name)
3053 "Remove parameter NAME from GROUP."
3054 (let ((info (gnus-get-info group)))
3056 (let ((params (gnus-info-params info)))
3058 (setq params (delq name params))
3059 (while (assq name params)
3060 (gnus-pull name params))
3061 (gnus-info-set-params info params))))))
3063 (defun gnus-group-add-score (group &optional score)
3064 "Add SCORE to the GROUP score.
3065 If SCORE is nil, add 1 to the score of GROUP."
3066 (let ((info (gnus-get-info group)))
3068 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3070 (defun gnus-short-group-name (group &optional levels)
3071 "Collapse GROUP name LEVELS.
3072 Select methods are stripped and any remote host name is stripped down to
3073 just the host name."
3079 gnus-group-uncollapsed-levels
3081 (while (string-match "\\." group skip)
3082 (setq skip (match-end 0)
3085 ;; Separate foreign select method from group name and collapse.
3086 ;; If method contains a server, collapse to non-domain server name,
3087 ;; otherwise collapse to select method.
3088 (let* ((colon (string-match ":" group))
3089 (server (and colon (substring group 0 colon)))
3090 (plus (and server (string-match "+" server))))
3093 (setq foreign (substring server (+ 1 plus)
3094 (string-match "\\." server))
3095 group (substring group (+ 1 colon)))
3096 (setq foreign server
3097 group (substring group (+ 1 colon))))
3098 (setq foreign (concat foreign ":")))
3099 ;; Collapse group name leaving LEVELS uncollapsed elements
3100 (let* ((slist (split-string group "/"))
3101 (slen (length slist))
3102 (dlist (split-string group "\\."))
3103 (dlen (length dlist))
3115 (setq levels (- glen levels))
3117 (push (if (>= (decf levels) 0)
3118 (if (zerop (length g))
3123 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3125 (defun gnus-narrow-to-body ()
3126 "Narrow to the body of an article."
3129 (goto-char (point-min))
3130 (or (search-forward "\n\n" nil t)
3136 ;;; Kill file handling.
3139 (defun gnus-apply-kill-file ()
3140 "Apply a kill file to the current newsgroup.
3141 Returns the number of articles marked as read."
3142 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3143 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3144 (gnus-apply-kill-file-internal)
3147 (defun gnus-kill-save-kill-buffer ()
3148 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3149 (when (get-file-buffer file)
3151 (set-buffer (get-file-buffer file))
3152 (when (buffer-modified-p)
3154 (kill-buffer (current-buffer))))))
3156 (defcustom gnus-kill-file-name "KILL"
3157 "Suffix of the kill files."
3158 :group 'gnus-score-kill
3159 :group 'gnus-score-files
3162 (defun gnus-newsgroup-kill-file (newsgroup)
3163 "Return the name of a kill file name for NEWSGROUP.
3164 If NEWSGROUP is nil, return the global kill file name instead."
3166 ;; The global KILL file is placed at top of the directory.
3167 ((or (null newsgroup)
3168 (string-equal newsgroup ""))
3169 (expand-file-name gnus-kill-file-name
3170 gnus-kill-files-directory))
3171 ;; Append ".KILL" to newsgroup name.
3172 ((gnus-use-long-file-name 'not-kill)
3173 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3174 "." gnus-kill-file-name)
3175 gnus-kill-files-directory))
3176 ;; Place "KILL" under the hierarchical directory.
3178 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3179 "/" gnus-kill-file-name)
3180 gnus-kill-files-directory))))
3184 (defun gnus-member-of-valid (symbol group)
3185 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3187 (symbol-name (car (gnus-find-method-for-group group)))
3188 gnus-valid-select-methods)))
3190 (defun gnus-method-option-p (method option)
3191 "Return non-nil if select METHOD has OPTION as a parameter."
3192 (when (stringp method)
3193 (setq method (gnus-server-to-method method)))
3194 (memq option (assoc (format "%s" (car method))
3195 gnus-valid-select-methods)))
3197 (defun gnus-similar-server-opened (method)
3198 (let ((opened gnus-opened-servers))
3199 (while (and method opened)
3200 (when (and (equal (cadr method) (cadaar opened))
3201 (equal (car method) (caaar opened))
3202 (not (equal method (caar opened))))
3207 (defun gnus-server-extend-method (group method)
3208 ;; This function "extends" a virtual server. If the server is
3209 ;; "hello", and the select method is ("hello" (my-var "something"))
3210 ;; in the group "alt.alt", this will result in a new virtual server
3211 ;; called "hello+alt.alt".
3212 (if (or (not (inline (gnus-similar-server-opened method)))
3213 (not (cddr method)))
3215 `(,(car method) ,(concat (cadr method) "+" group)
3216 (,(intern (format "%s-address" (car method))) ,(cadr method))
3219 (defun gnus-server-status (method)
3220 "Return the status of METHOD."
3221 (nth 1 (assoc method gnus-opened-servers)))
3223 (defun gnus-group-name-to-method (group)
3224 "Guess a select method based on GROUP."
3225 (if (string-match ":" group)
3226 (let ((server (substring group 0 (match-beginning 0))))
3227 (if (string-match "\\+" server)
3228 (list (intern (substring server 0 (match-beginning 0)))
3229 (substring server (match-end 0)))
3230 (list (intern server) "")))
3231 gnus-select-method))
3233 (defun gnus-server-string (server)
3234 "Return a readable string that describes SERVER."
3235 (let* ((server (gnus-server-to-method server))
3236 (address (nth 1 server)))
3238 (not (zerop (length address))))
3239 (format "%s via %s" address (car server))
3240 (format "%s" (car server)))))
3242 (defun gnus-find-method-for-group (group &optional info)
3243 "Find the select method that GROUP uses."
3244 (or gnus-override-method
3247 (and (not (gnus-group-entry group));; a new group
3248 (gnus-group-name-to-method group))
3249 (let ((info (or info (gnus-get-info group)))
3252 (not (setq method (gnus-info-method info)))
3253 (equal method "native"))
3256 (cond ((stringp method)
3257 (inline (gnus-server-to-method method)))
3258 ((stringp (cadr method))
3259 (inline (gnus-server-extend-method group method)))
3262 (cond ((equal (cadr method) "")
3264 ((null (cadr method))
3265 (list (car method) ""))
3267 (gnus-server-add-address method)))))))
3269 (defun gnus-methods-using (feature)
3270 "Find all methods that have FEATURE."
3271 (let ((valids gnus-valid-select-methods)
3274 (when (memq feature (car valids))
3275 (push (car valids) outs))
3276 (setq valids (cdr valids)))
3279 (defun gnus-read-group (prompt &optional default)
3280 "Prompt the user for a group name.
3281 Disallow invalid group names."
3286 gnus-invalid-group-regexp
3287 (setq group (read-string (concat prefix prompt)
3288 (cons (or default "") 0)
3289 'gnus-group-history)))
3290 (setq prefix (format "Invalid group name: \"%s\". " group)
3294 (defun gnus-read-method (prompt)
3295 "Prompt the user for a method.
3296 Allow completion over sensible values."
3297 (let* ((open-servers
3298 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3299 gnus-opened-servers))
3302 (dolist (method gnus-valid-select-methods)
3303 (if (or (memq 'prompt-address method)
3304 (not (assoc (format "%s:" (car method)) open-servers)))
3305 (push method methods)))
3308 (append valid-methods
3310 gnus-predefined-server-alist
3315 nil t nil 'gnus-method-history)))
3318 (setq method gnus-select-method))
3319 ((assoc method gnus-valid-select-methods)
3320 (let ((address (if (memq 'prompt-address
3321 (assoc method gnus-valid-select-methods))
3322 (read-string "Address: ")
3324 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3325 (list (intern method) address))))
3326 ((assoc method servers)
3329 (list (intern method) "")))))
3331 ;;; User-level commands.
3334 (defun gnus-slave-no-server (&optional arg)
3335 "Read network news as a slave, without connecting to local server."
3337 (gnus-no-server arg t))
3340 (defun gnus-no-server (&optional arg slave)
3342 If ARG is a positive number, Gnus will use that as the
3343 startup level. If ARG is nil, Gnus will be started at level 2.
3344 If ARG is non-nil and not a positive number, Gnus will
3345 prompt the user for the name of an NNTP server to use.
3346 As opposed to `gnus', this command will not connect to the local server."
3348 (gnus-no-server-1 arg slave))
3351 (defun gnus-slave (&optional arg)
3352 "Read news as a slave."
3354 (gnus arg nil 'slave))
3356 (defcustom gnus-frame-properties nil
3357 "The properties of the frame in which gnus is displayed. Under XEmacs,
3358 the variable `toolbar-news-frame-plist' will be refered instead."
3359 :type '(repeat (cons :format "%v"
3360 (symbol :tag "Parameter")
3361 (sexp :tag "Value")))
3364 (defvar gnus-frame nil
3365 "The frame in which gnus is displayed. It is not used under XEmacs.")
3368 (defun gnus-other-frame (&optional arg)
3369 "Pop up a frame to read news."
3371 (static-if (featurep 'xemacs)
3372 (let ((toolbar-news-use-separate-frame t))
3374 (if (frame-live-p gnus-frame)
3375 (raise-frame gnus-frame)
3376 (setq gnus-frame (make-frame gnus-frame-properties))
3377 (if (and (gnus-buffer-live-p gnus-group-buffer)
3378 (save-current-buffer
3379 (set-buffer gnus-group-buffer)
3380 (eq 'gnus-group-mode major-mode)))
3382 (select-frame gnus-frame)
3383 (switch-to-buffer gnus-group-buffer))
3384 (add-hook 'gnus-exit-gnus-hook
3386 (when (and (frame-live-p gnus-frame)
3388 (delete-frame gnus-frame))
3389 (setq gnus-frame nil)))
3390 (select-frame gnus-frame)
3394 (defun gnus (&optional arg dont-connect slave)
3396 If ARG is non-nil and a positive number, Gnus will use that as the
3397 startup level. If ARG is non-nil and not a positive number, Gnus will
3398 prompt the user for the name of an NNTP server to use."
3400 (unless (byte-code-function-p (symbol-function 'gnus))
3401 (message "You should byte-compile Gnus")
3403 (gnus-1 arg dont-connect slave))
3405 ;; Allow redefinition of Gnus functions.
3409 (product-provide (provide 'gnus) 'gnus-vers)
3411 ;;; gnus.el ends here