1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 2002,
3 ;; 1997, 1998, 2000, 2001, 2002 Free Software Foundation, Inc.
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news, mail
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
30 (eval '(run-hooks 'gnus-load-hook))
32 (eval-when-compile (require 'cl))
37 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
41 (defgroup gnus-format nil
42 "Dealing with formatting issues."
46 (defgroup gnus-charset nil
47 "Group character set issues."
48 :link '(custom-manual "(gnus)Charsets")
52 (defgroup gnus-cache nil
56 (defgroup gnus-start nil
57 "Starting your favorite newsreader."
60 (defgroup gnus-start-server nil
61 "Server options at startup."
64 ;; These belong to gnus-group.el.
65 (defgroup gnus-group nil
67 :link '(custom-manual "(gnus)The Group Buffer")
70 (defgroup gnus-group-foreign nil
72 :link '(custom-manual "(gnus)Foreign Groups")
75 (defgroup gnus-group-new nil
76 "Automatic subscription of new groups."
79 (defgroup gnus-group-levels nil
81 :link '(custom-manual "(gnus)Group Levels")
84 (defgroup gnus-group-select nil
86 :link '(custom-manual "(gnus)Selecting a Group")
89 (defgroup gnus-group-listing nil
90 "Showing slices of the group list."
91 :link '(custom-manual "(gnus)Listing Groups")
94 (defgroup gnus-group-visual nil
95 "Sorting the group buffer."
96 :link '(custom-manual "(gnus)Group Buffer Format")
100 (defgroup gnus-group-various nil
101 "Various group options."
102 :link '(custom-manual "(gnus)Scanning New Messages")
105 ;; These belong to gnus-sum.el.
106 (defgroup gnus-summary nil
108 :link '(custom-manual "(gnus)The Summary Buffer")
111 (defgroup gnus-summary-exit nil
112 "Leaving summary buffers."
113 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
114 :group 'gnus-summary)
116 (defgroup gnus-summary-marks nil
117 "Marks used in summary buffers."
118 :link '(custom-manual "(gnus)Marking Articles")
119 :group 'gnus-summary)
121 (defgroup gnus-thread nil
122 "Ordering articles according to replies."
123 :link '(custom-manual "(gnus)Threading")
124 :group 'gnus-summary)
126 (defgroup gnus-summary-format nil
127 "Formatting of the summary buffer."
128 :link '(custom-manual "(gnus)Summary Buffer Format")
129 :group 'gnus-summary)
131 (defgroup gnus-summary-choose nil
133 :link '(custom-manual "(gnus)Choosing Articles")
134 :group 'gnus-summary)
136 (defgroup gnus-summary-maneuvering nil
137 "Summary movement commands."
138 :link '(custom-manual "(gnus)Summary Maneuvering")
139 :group 'gnus-summary)
141 (defgroup gnus-summary-mail nil
142 "Mail group commands."
143 :link '(custom-manual "(gnus)Mail Group Commands")
144 :group 'gnus-summary)
146 (defgroup gnus-summary-sort nil
147 "Sorting the summary buffer."
148 :link '(custom-manual "(gnus)Sorting")
149 :group 'gnus-summary)
151 (defgroup gnus-summary-visual nil
152 "Highlighting and menus in the summary buffer."
153 :link '(custom-manual "(gnus)Summary Highlighting")
155 :group 'gnus-summary)
157 (defgroup gnus-summary-various nil
158 "Various summary buffer options."
159 :link '(custom-manual "(gnus)Various Summary Stuff")
160 :group 'gnus-summary)
162 (defgroup gnus-summary-pick nil
163 "Pick mode in the summary buffer."
164 :link '(custom-manual "(gnus)Pick and Read")
166 :group 'gnus-summary)
168 (defgroup gnus-summary-tree nil
169 "Tree display of threads in the summary buffer."
170 :link '(custom-manual "(gnus)Tree Display")
172 :group 'gnus-summary)
174 ;; Belongs to gnus-uu.el
175 (defgroup gnus-extract-view nil
176 "Viewing extracted files."
177 :link '(custom-manual "(gnus)Viewing Files")
178 :group 'gnus-extract)
180 ;; Belongs to gnus-score.el
181 (defgroup gnus-score nil
182 "Score and kill file handling."
185 (defgroup gnus-score-kill nil
189 (defgroup gnus-score-adapt nil
190 "Adaptive score files."
193 (defgroup gnus-score-default nil
194 "Default values for score files."
197 (defgroup gnus-score-expire nil
198 "Expiring score rules."
201 (defgroup gnus-score-decay nil
202 "Decaying score rules."
205 (defgroup gnus-score-files nil
206 "Score and kill file names."
210 (defgroup gnus-score-various nil
211 "Various scoring and killing options."
215 (defgroup gnus-visual nil
216 "Options controling the visual fluff."
220 (defgroup gnus-agent nil
221 "Offline support for Gnus."
224 (defgroup gnus-files nil
225 "Files used by Gnus."
228 (defgroup gnus-dribble-file nil
230 :link '(custom-manual "(gnus)Auto Save")
233 (defgroup gnus-newsrc nil
234 "Storing Gnus state."
237 (defgroup gnus-server nil
238 "Options related to newsservers and other servers used by Gnus."
241 (defgroup gnus-server-visual nil
242 "Highlighting and menus in the server buffer."
246 (defgroup gnus-message '((message custom-group))
247 "Composing replies and followups in Gnus."
250 (defgroup gnus-meta nil
251 "Meta variables controling major portions of Gnus.
252 In general, modifying these variables does not take affect until Gnus
253 is restarted, and sometimes reloaded."
256 (defgroup gnus-various nil
257 "Other Gnus options."
258 :link '(custom-manual "(gnus)Various Various")
261 (defgroup gnus-mime nil
262 "Variables for controlling the Gnus MIME interface."
265 (defgroup gnus-exit nil
267 :link '(custom-manual "(gnus)Exiting Gnus")
270 (defgroup gnus-fun nil
271 "Frivolous Gnus extensions."
272 :link '(custom-manual "(gnus)Exiting Gnus")
275 (defconst gnus-version-number "0.05"
276 "Version number for this version of Gnus.")
278 (defconst gnus-version (format "Oort Gnus v%s" gnus-version-number)
279 "Version string for this version of 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-high-read-face
683 (:foreground "PaleGreen"
687 (:foreground "DarkGreen"
691 "Face used for high interest read articles.")
693 (defface gnus-summary-low-read-face
696 (:foreground "PaleGreen"
700 (:foreground "DarkGreen"
704 "Face used for low interest read articles.")
706 (defface gnus-summary-normal-read-face
709 (:foreground "PaleGreen"))
712 (:foreground "DarkGreen"))
715 "Face used for normal interest read articles.")
722 (defvar gnus-buffers nil)
724 (defun gnus-get-buffer-create (name)
725 "Do the same as `get-buffer-create', but store the created buffer."
726 (or (get-buffer name)
727 (car (push (get-buffer-create name) gnus-buffers))))
729 (defun gnus-add-buffer ()
730 "Add the current buffer to the list of Gnus buffers."
731 (push (current-buffer) gnus-buffers))
733 (defun gnus-buffers ()
734 "Return a list of live Gnus buffers."
735 (while (and gnus-buffers
736 (not (buffer-name (car gnus-buffers))))
738 (let ((buffers gnus-buffers))
740 (if (buffer-name (cadr buffers))
742 (setcdr buffers (cddr buffers)))))
747 (defvar gnus-group-buffer "*Group*")
750 (autoload 'gnus-play-jingle "gnus-audio"))
752 (defface gnus-splash-face
755 (:foreground "#888888"))
758 (:foreground "#888888"))
761 "Face for the splash screen.")
763 (defun gnus-splash ()
765 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
766 (let ((buffer-read-only nil))
768 (unless gnus-inhibit-startup-message
769 (gnus-group-startup-message)
771 (when gnus-play-startup-jingle
772 (gnus-play-jingle))))))
774 (defun gnus-indent-rigidly (start end arg)
775 "Indent rigidly using only spaces and no tabs."
778 (narrow-to-region start end)
780 (indent-rigidly start end arg)
781 ;; We translate tabs into spaces -- not everybody uses
782 ;; an 8-character tab.
783 (goto-char (point-min))
784 (while (search-forward "\t" nil t)
785 (replace-match " " t t))))))
787 (defvar gnus-simple-splash nil)
789 ;;(format "%02x%02x%02x" 114 66 20) "724214"
791 (defvar gnus-logo-color-alist
792 '((flame "#cc3300" "#ff2200")
793 (pine "#c0cc93" "#f8ffb8")
794 (moss "#a1cc93" "#d2ffb8")
795 (irish "#04cc90" "#05ff97")
796 (sky "#049acc" "#05deff")
797 (tin "#6886cc" "#82b6ff")
798 (velvet "#7c68cc" "#8c82ff")
799 (grape "#b264cc" "#cf7df")
800 (labia "#cc64c2" "#fd7dff")
801 (berry "#cc6485" "#ff7db5")
802 (dino "#724214" "#1e3f03")
803 (oort "#cccccc" "#888888")
804 (storm "#666699" "#99ccff")
805 (pdino "#9999cc" "#99ccff")
806 (purp "#9999cc" "#666699")
807 (neutral "#b4b4b4" "#878787")
808 (september "#bf9900" "#ffcc00"))
809 "Color alist used for the Gnus logo.")
811 (defcustom gnus-logo-color-style 'oort
812 "*Color styles used for the Gnus logo."
813 :type '(choice (const flame) (const pine) (const moss)
814 (const irish) (const sky) (const tin)
815 (const velvet) (const grape) (const labia)
816 (const berry) (const neutral) (const september)
820 (defvar gnus-logo-colors
821 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
822 "Colors used for the Gnus logo.")
824 (defun gnus-group-startup-message (&optional x y)
825 "Insert startup message in current buffer."
826 ;; Insert the message.
830 (fboundp 'find-image)
832 (let ((image (find-image
833 `((:type xpm :file "gnus.xpm"
835 (("thing" . ,(car gnus-logo-colors))
836 ("shadow" . ,(cadr gnus-logo-colors))
837 ("background" . ,(face-background 'default))))
838 (:type pbm :file "gnus.pbm"
839 ;; Account for the pbm's blackground.
840 :background ,(face-foreground 'gnus-splash-face)
841 :foreground ,(face-background 'default))
842 (:type xbm :file "gnus.xbm"
843 ;; Account for the xbm's blackground.
844 :background ,(face-foreground 'gnus-splash-face)
845 :foreground ,(face-background 'default))))))
847 (let ((size (image-size image)))
848 (insert-char ?\n (max 0 (round (- (window-height)
849 (or y (cdr size)) 1) 2)))
850 (insert-char ?\ (max 0 (round (- (window-width)
851 (or x (car size))) 2)))
852 (insert-image image))
853 (setq gnus-simple-splash nil)
859 _ ___ __ ___ __ _ ___
879 (gnus-indent-rigidly (point-min) (point-max)
880 (/ (max (- (window-width) (or x 46)) 0) 2))
881 (goto-char (point-min))
883 (let* ((pheight (count-lines (point-min) (point-max)))
884 (wheight (window-height))
885 (rest (- wheight pheight)))
886 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
888 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
889 (setq gnus-simple-splash t)))
890 (goto-char (point-min))
891 (setq mode-line-buffer-identification (concat " " gnus-version))
892 (set-buffer-modified-p t))
895 (let ((command (format "%s" this-command)))
896 (if (and (string-match "gnus" command)
897 (not (string-match "gnus-other-frame" command)))
899 (gnus-get-buffer-create gnus-group-buffer))))
906 (defcustom gnus-parameters nil
907 "Alist of group parameters.
910 ((\"mail\\\\..*\" (gnus-show-threads nil)
911 (gnus-use-scoring nil)
912 (gnus-summary-line-format
913 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
916 (\"mail\\\\.me\" (gnus-use-scoring t))
917 (\"list\\\\..*\" (total-expire . t)
918 (broken-reply-to . t)))"
919 :group 'gnus-group-various
920 :type '(repeat (cons regexp
923 (defvar gnus-group-parameters-more nil)
925 (defmacro gnus-define-group-parameter (param &rest rest)
926 "Define a group parameter PARAM.
927 REST is a plist of following:
928 :type One of `bool', `list' or `nil'.
929 :function The name of the function.
930 :function-document The documentation of the function.
931 :parameter-type The type for customizing the parameter.
932 :parameter-document The documentation for the parameter.
933 :variable The name of the variable.
934 :variable-document The documentation for the variable.
935 :variable-group The group for customizing the variable.
936 :variable-type The type for customizing the variable.
937 :variable-default The default value of the variable."
938 (let* ((type (plist-get rest :type))
939 (parameter-type (plist-get rest :parameter-type))
940 (parameter-document (plist-get rest :parameter-document))
941 (function (or (plist-get rest :function)
942 (intern (format "gnus-parameter-%s" param))))
943 (function-document (or (plist-get rest :function-document) ""))
944 (variable (or (plist-get rest :variable)
945 (intern (format "gnus-parameter-%s-alist" param))))
946 (variable-document (or (plist-get rest :variable-document) ""))
947 (variable-group (plist-get rest :variable-group))
948 (variable-type (or (plist-get rest :variable-type)
950 (list (regexp :tag "Group")
951 ,(car (cdr parameter-type)))))))
952 (variable-default (plist-get rest :variable-default)))
955 `(defcustom ,variable ,variable-default
957 :group 'gnus-group-parameter
958 :group ',variable-group
959 :type ,variable-type)
960 `(setq gnus-group-parameters-more
961 (delq (assq ',param gnus-group-parameters-more)
962 gnus-group-parameters-more))
963 `(add-to-list 'gnus-group-parameters-more
966 ,parameter-document))
968 `(defun ,function (name)
970 (let ((params (gnus-group-find-parameter name))
973 ((memq ',param params)
975 ((setq val (assq ',param params))
978 (string-match ,variable name))
980 (let ((alist ,variable)
982 (while (setq elem (pop alist))
984 (string-match (car elem) name))
987 (if (consp value) (car value) value))))))
988 `(defun ,function (name)
991 (or (gnus-group-find-parameter name ',param ,(and type t))
992 (let ((alist ,variable)
994 (while (setq elem (pop alist))
996 (string-match (car elem) name))
1001 '(if (consp value) (car value) value))))))))))
1003 (defcustom gnus-home-directory "~/"
1004 "Directory variable that specifies the \"home\" directory.
1005 All other Gnus path variables are initialized from this variable."
1009 (defcustom gnus-directory (or (getenv "SAVEDIR")
1010 (nnheader-concat gnus-home-directory "News/"))
1011 "*Directory variable from which all other Gnus file variables are derived.
1013 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1014 This means that other directory variables that are initialized from
1015 this variable won't be set properly if you set this variable in `.gnus.el'.
1016 Set this variable in `.emacs' instead."
1020 (defcustom gnus-default-directory nil
1021 "*Default directory for all Gnus buffers."
1023 :type '(choice (const :tag "current" nil)
1026 ;; Site dependent variables. These variables should be defined in
1029 (defvar gnus-default-nntp-server nil
1030 "Specify a default NNTP server.
1031 This variable should be defined in paths.el, and should never be set
1033 If you want to change servers, you should use `gnus-select-method'.
1034 See the documentation to that variable.")
1036 ;; Don't touch this variable.
1037 (defvar gnus-nntp-service "nntp"
1038 "NNTP service name (\"nntp\" or 119).
1039 This is an obsolete variable, which is scarcely used. If you use an
1040 nntp server for your newsgroup and want to change the port number
1041 used to 899, you would say something along these lines:
1043 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1045 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1046 "A file with only the name of the nntp server in it."
1051 ;; This function is used to check both the environment variable
1052 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
1053 ;; an nntp server name default.
1054 (defun gnus-getenv-nntpserver ()
1055 (or (getenv "NNTPSERVER")
1056 (and (file-readable-p gnus-nntpserver-file)
1058 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
1059 (insert-file-contents gnus-nntpserver-file)
1060 (let ((name (buffer-string)))
1062 (if (string-match "\\'[ \t\n]*$" name)
1065 (kill-buffer (current-buffer))))))))
1067 (defcustom gnus-select-method
1070 (list 'nntp (or (condition-case nil
1071 (gnus-getenv-nntpserver)
1073 (when (and gnus-default-nntp-server
1074 (not (string= gnus-default-nntp-server "")))
1075 gnus-default-nntp-server)
1077 (if (or (null gnus-nntp-service)
1078 (equal gnus-nntp-service "nntp"))
1080 (list gnus-nntp-service)))
1082 "Default method for selecting a newsgroup.
1083 This variable should be a list, where the first element is how the
1084 news is to be fetched, the second is the address.
1086 For instance, if you want to get your news via NNTP from
1087 \"flab.flab.edu\", you could say:
1089 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1091 If you want to use your local spool, say:
1093 \(setq gnus-select-method (list 'nnspool (system-name)))
1095 If you use this variable, you must set `gnus-nntp-server' to nil.
1097 There is a lot more to know about select methods and virtual servers -
1098 see the manual for details."
1100 :type 'gnus-select-method)
1102 (defcustom gnus-message-archive-method "archive"
1103 "*Method used for archiving messages you've sent.
1104 This should be a mail method."
1106 :group 'gnus-message
1107 :type 'gnus-select-method)
1109 (defcustom gnus-message-archive-group nil
1110 "*Name of the group in which to save the messages you've written.
1111 This can either be a string; a list of strings; or an alist
1112 of regexps/functions/forms to be evaluated to return a string (or a list
1113 of strings). The functions are called with the name of the current
1114 group (or nil) as a parameter.
1116 If you want to save your mail in one group and the news articles you
1117 write in another group, you could say something like:
1119 \(setq gnus-message-archive-group
1120 '((if (message-news-p)
1124 Normally the group names returned by this variable should be
1125 unprefixed -- which implicitly means \"store on the archive server\".
1126 However, you may wish to store the message on some other server. In
1127 that case, just return a fully prefixed name of the group --
1128 \"nnml+private:mail.misc\", for instance."
1129 :group 'gnus-message
1130 :type '(choice (const :tag "none" nil)
1135 (defcustom gnus-secondary-servers nil
1136 "List of NNTP servers that the user can choose between interactively.
1137 To make Gnus query you for a server, you have to give `gnus' a
1138 non-numeric prefix - `C-u M-x gnus', in short."
1140 :type '(repeat string))
1142 (defcustom gnus-nntp-server nil
1143 "*The name of the host running the NNTP server.
1144 This variable is semi-obsolete. Use the `gnus-select-method'
1147 :type '(choice (const :tag "disable" nil)
1150 (defcustom gnus-secondary-select-methods nil
1151 "A list of secondary methods that will be used for reading news.
1152 This is a list where each element is a complete select method (see
1153 `gnus-select-method').
1155 If, for instance, you want to read your mail with the nnml backend,
1156 you could set this variable:
1158 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1160 :type '(repeat gnus-select-method))
1162 (defvar gnus-backup-default-subscribed-newsgroups
1163 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1164 "Default default new newsgroups the first time Gnus is run.
1165 Should be set in paths.el, and shouldn't be touched by the user.")
1167 (defcustom gnus-local-domain nil
1168 "Local domain name without a host name.
1169 The DOMAINNAME environment variable is used instead if it is defined.
1170 If the function `system-name' returns the full Internet name, there is
1171 no need to set this variable."
1172 :group 'gnus-message
1173 :type '(choice (const :tag "default" nil)
1176 (defvar gnus-local-organization nil
1177 "String with a description of what organization (if any) the user belongs to.
1178 Obsolete variable; use `message-user-organization' instead.")
1180 ;; Customization variables
1182 (defcustom gnus-refer-article-method nil
1183 "Preferred method for fetching an article by Message-ID.
1184 If you are reading news from the local spool (with nnspool), fetching
1185 articles by Message-ID is painfully slow. By setting this method to an
1186 nntp method, you might get acceptable results.
1188 The value of this variable must be a valid select method as discussed
1189 in the documentation of `gnus-select-method'.
1191 It can also be a list of select methods, as well as the special symbol
1192 `current', which means to use the current select method. If it is a
1193 list, Gnus will try all the methods in the list until it finds a match."
1195 :type '(choice (const :tag "default" nil)
1196 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1198 (repeat :menu-tag "Try multiple"
1200 :value (current (nnweb "refer" (nnweb-type dejanews)))
1201 (choice :tag "Method"
1203 (const :tag "DejaNews"
1204 (nnweb "refer" (nnweb-type dejanews)))
1205 gnus-select-method))))
1207 (defcustom gnus-group-faq-directory
1208 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1209 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1210 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1211 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1212 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1213 "/ftp@rtfm.mit.edu:/pub/usenet/"
1214 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1215 "/ftp@ftp.sunet.se:/pub/usenet/"
1216 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1217 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1218 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1219 "*Directory where the group FAQs are stored.
1220 This will most commonly be on a remote machine, and the file will be
1221 fetched by ange-ftp.
1223 This variable can also be a list of directories. In that case, the
1224 first element in the list will be used by default. The others can
1225 be used when being prompted for a site.
1227 Note that Gnus uses an aol machine as the default directory. If this
1228 feels fundamentally unclean, just think of it as a way to finally get
1229 something of value back from them.
1231 If the default site is too slow, try one of these:
1233 North America: mirrors.aol.com /pub/rtfm/usenet
1234 ftp.seas.gwu.edu /pub/rtfm
1235 rtfm.mit.edu /pub/usenet
1236 Europe: ftp.uni-paderborn.de /pub/FAQ
1237 src.doc.ic.ac.uk /usenet/news-FAQS
1238 ftp.sunet.se /pub/usenet
1239 ftp.pasteur.fr /pub/FAQ
1240 Asia: nctuccca.edu.tw /USENET/FAQ
1241 hwarang.postech.ac.kr /pub/usenet
1242 ftp.hk.super.net /mirror/faqs"
1243 :group 'gnus-group-various
1244 :type '(choice directory
1245 (repeat directory)))
1247 (defcustom gnus-use-cross-reference t
1248 "*Non-nil means that cross referenced articles will be marked as read.
1249 If nil, ignore cross references. If t, mark articles as read in
1250 subscribed newsgroups. If neither t nor nil, mark as read in all
1253 :type '(choice (const :tag "off" nil)
1254 (const :tag "subscribed" t)
1258 (defcustom gnus-process-mark ?#
1260 :group 'gnus-group-visual
1261 :group 'gnus-summary-marks
1264 (defcustom gnus-large-newsgroup 200
1265 "*The number of articles which indicates a large newsgroup.
1266 If the number of articles in a newsgroup is greater than this value,
1267 confirmation is required for selecting the newsgroup.
1268 If it is `nil', no confirmation is required."
1269 :group 'gnus-group-select
1272 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1273 "*Non-nil means that the default name of a file to save articles in is the group name.
1274 If it's nil, the directory form of the group name is used instead.
1276 If this variable is a list, and the list contains the element
1277 `not-score', long file names will not be used for score files; if it
1278 contains the element `not-save', long file names will not be used for
1279 saving; and if it contains the element `not-kill', long file names
1280 will not be used for kill files.
1282 Note that the default for this variable varies according to what system
1283 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1284 to nil while on all other systems it defaults to t."
1288 (defcustom gnus-kill-files-directory gnus-directory
1289 "*Name of the directory where kill files will be stored (default \"~/News\")."
1290 :group 'gnus-score-files
1291 :group 'gnus-score-kill
1294 (defcustom gnus-save-score nil
1295 "*If non-nil, save group scoring info."
1296 :group 'gnus-score-various
1300 (defcustom gnus-use-undo t
1301 "*If non-nil, allow undoing in Gnus group mode buffers."
1305 (defcustom gnus-use-adaptive-scoring nil
1306 "*If non-nil, use some adaptive scoring scheme.
1307 If a list, then the values `word' and `line' are meaningful. The
1308 former will perform adaption on individual words in the subject
1309 header while `line' will perform adaption on several headers."
1311 :group 'gnus-score-adapt
1312 :type '(set (const word) (const line)))
1314 (defcustom gnus-use-cache 'passive
1315 "*If nil, Gnus will ignore the article cache.
1316 If `passive', it will allow entering (and reading) articles
1317 explicitly entered into the cache. If anything else, use the
1318 cache to the full extent of the law."
1321 :type '(choice (const :tag "off" nil)
1322 (const :tag "passive" passive)
1323 (const :tag "active" t)))
1325 (defcustom gnus-use-trees nil
1326 "*If non-nil, display a thread tree buffer."
1330 (defcustom gnus-use-grouplens nil
1331 "*If non-nil, use GroupLens ratings."
1335 (defcustom gnus-keep-backlog nil
1336 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1337 If it is a number N, then Gnus will only keep the last N articles
1338 read. If it is neither nil nor a number, Gnus will keep all read
1339 articles. This is not a good idea."
1341 :type '(choice (const :tag "off" nil)
1346 (defcustom gnus-use-nocem nil
1347 "*If non-nil, Gnus will read NoCeM cancel messages."
1351 (defcustom gnus-suppress-duplicates nil
1352 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1356 (defcustom gnus-use-scoring t
1357 "*If non-nil, enable scoring."
1361 (defcustom gnus-summary-prepare-exit-hook
1362 '(gnus-summary-expire-articles)
1363 "*A hook called when preparing to exit from the summary buffer.
1364 It calls `gnus-summary-expire-articles' by default."
1365 :group 'gnus-summary-exit
1368 (defcustom gnus-novice-user t
1369 "*Non-nil means that you are a usenet novice.
1370 If non-nil, verbose messages may be displayed and confirmations may be
1375 (defcustom gnus-expert-user nil
1376 "*Non-nil means that you will never be asked for confirmation about anything.
1377 That doesn't mean *anything* anything; particularly destructive
1378 commands will still require prompting."
1382 (defcustom gnus-interactive-catchup t
1383 "*If non-nil, require your confirmation when catching up a group."
1384 :group 'gnus-group-select
1387 (defcustom gnus-interactive-exit t
1388 "*If non-nil, require your confirmation when exiting Gnus."
1392 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1393 "*Function for extracting address components from a From header.
1394 Two pre-defined function exist: `gnus-extract-address-components',
1395 which is the default, quite fast, and too simplistic solution, and
1396 `mail-extract-address-components', which works much better, but is
1398 :group 'gnus-summary-format
1399 :type '(radio (function-item gnus-extract-address-components)
1400 (function-item mail-extract-address-components)
1401 (function :tag "Other")))
1403 (defcustom gnus-carpal nil
1404 "*If non-nil, display clickable icons."
1408 (defcustom gnus-shell-command-separator ";"
1409 "String used to separate to shell commands."
1413 (defcustom gnus-valid-select-methods
1414 '(("nntp" post address prompt-address physical-address)
1415 ("nnspool" post address)
1416 ("nnvirtual" post-mail virtual prompt-address)
1417 ("nnmbox" mail respool address)
1418 ("nnml" post-mail respool address)
1419 ("nnmh" mail respool address)
1420 ("nndir" post-mail prompt-address physical-address)
1421 ("nneething" none address prompt-address physical-address)
1422 ("nndoc" none address prompt-address)
1423 ("nnbabyl" mail address respool)
1424 ("nnkiboze" post virtual)
1425 ("nnsoup" post-mail address)
1426 ("nndraft" post-mail)
1427 ("nnfolder" mail respool address)
1428 ("nngateway" post-mail address prompt-address physical-address)
1436 ("nnagent" post-mail)
1437 ("nnimap" post-mail address prompt-address physical-address)
1438 ("nnmaildir" mail respool address))
1439 "*An alist of valid select methods.
1440 The first element of each list lists should be a string with the name
1441 of the select method. The other elements may be the category of
1442 this method (i. e., `post', `mail', `none' or whatever) or other
1443 properties that this method has (like being respoolable).
1444 If you implement a new select method, all you should have to change is
1445 this variable. I think."
1447 :type '(repeat (group (string :tag "Name")
1448 (radio-button-choice (const :format "%v " post)
1449 (const :format "%v " mail)
1450 (const :format "%v " none)
1452 (checklist :inline t
1453 (const :format "%v " address)
1454 (const :format "%v " prompt-address)
1455 (const :format "%v " physical-address)
1456 (const :format "%v " virtual)
1459 (defun gnus-redefine-select-method-widget ()
1460 "Recomputes the select-method widget based on the value of
1461 `gnus-valid-select-methods'."
1462 (define-widget 'gnus-select-method 'list
1463 "Widget for entering a select method."
1465 :tag "Select Method"
1466 :args `((choice :tag "Method"
1467 ,@(mapcar (lambda (entry)
1468 (list 'const :format "%v\n"
1469 (intern (car entry))))
1470 gnus-valid-select-methods)
1471 (symbol :tag "other"))
1472 (string :tag "Address")
1473 (repeat :tag "Options"
1477 (sexp :tag "Value"))))))
1479 (gnus-redefine-select-method-widget)
1481 (defcustom gnus-updated-mode-lines '(group article summary tree)
1482 "List of buffers that should update their mode lines.
1483 The list may contain the symbols `group', `article', `tree' and
1484 `summary'. If the corresponding symbol is present, Gnus will keep
1485 that mode line updated with information that may be pertinent.
1486 If this variable is nil, screen refresh may be quicker."
1487 :group 'gnus-various
1488 :type '(set (const group)
1493 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1494 (defcustom gnus-mode-non-string-length nil
1495 "*Max length of mode-line non-string contents.
1496 If this is nil, Gnus will take space as is needed, leaving the rest
1497 of the modeline intact. Note that the default of nil is unlikely
1498 to be desirable; see the manual for further details."
1499 :group 'gnus-various
1500 :type '(choice (const nil)
1503 ;; There should be special validation for this.
1504 (define-widget 'gnus-email-address 'string
1507 (gnus-define-group-parameter
1510 "Return GROUP's to-address."
1512 "*Alist of group regexps and correspondent to-addresses."
1513 :parameter-type '(gnus-email-address :tag "To Address")
1514 :parameter-document "\
1515 This will be used when doing followups and posts.
1517 This is primarily useful in mail groups that represent closed
1518 mailing lists--mailing lists where it's expected that everybody that
1519 writes to the mailing list is subscribed to it. Since using this
1520 parameter ensures that the mail only goes to the mailing list itself,
1521 it means that members won't receive two copies of your followups.
1523 Using `to-address' will actually work whether the group is foreign or
1524 not. Let's say there's a group on the server that is called
1525 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1526 articles from a mail-to-news gateway. Posting directly to this group
1527 is therefore impossible--you have to send mail to the mailing list
1530 The gnus-group-split mail splitting mechanism will behave as if this
1531 address was listed in gnus-group-split Addresses (see below).")
1533 (gnus-define-group-parameter
1536 "Return GROUP's to-list."
1538 "*Alist of group regexps and correspondent to-lists."
1539 :parameter-type '(gnus-email-address :tag "To List")
1540 :parameter-document "\
1541 This address will be used when doing a `a' in the group.
1543 It is totally ignored when doing a followup--except that if it is
1544 present in a news group, you'll get mail group semantics when doing
1547 The gnus-group-split mail splitting mechanism will behave as if this
1548 address was listed in gnus-group-split Addresses (see below).")
1550 (gnus-define-group-parameter
1553 :function gnus-group-auto-expirable-p
1555 "Check whether GROUP is auto-expirable or not."
1556 :variable gnus-auto-expirable-newsgroups
1557 :variable-default nil
1559 "*Groups in which to automatically mark read articles as expirable.
1560 If non-nil, this should be a regexp that should match all groups in
1561 which to perform auto-expiry. This only makes sense for mail groups."
1562 :variable-group nnmail-expire
1563 :variable-type '(choice (const nil)
1565 :parameter-type '(const :tag "Automatic Expire" t)
1567 "All articles that are read will be marked as expirable.")
1569 (gnus-define-group-parameter
1572 :function gnus-group-total-expirable-p
1574 "Check whether GROUP is total-expirable or not."
1575 :variable gnus-total-expirable-newsgroups
1576 :variable-default nil
1578 "*Groups in which to perform expiry of all read articles.
1579 Use with extreme caution. All groups that match this regexp will be
1580 expiring - which means that all read articles will be deleted after
1581 \(say) one week. (This only goes for mail groups and the like, of
1583 :variable-group nnmail-expire
1584 :variable-type '(choice (const nil)
1586 :parameter-type '(const :tag "Total Expire" t)
1588 "All read articles will be put through the expiry process
1590 This happens even if they are not marked as expirable.
1593 (gnus-define-group-parameter
1596 "Return the default charset of GROUP."
1597 :variable gnus-group-charset-alist
1599 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1600 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1601 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1602 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1603 ("\\(^\\|:\\)relcom\\>" koi8-r)
1604 ("\\(^\\|:\\)fido7\\>" koi8-r)
1605 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1606 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1607 ("\\(^\\|:\\)han\\>" euc-kr)
1608 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1609 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1610 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1)
1613 "Alist of regexps (to match group names) and default charsets to be used when reading."
1614 :variable-group gnus-charset
1615 :variable-type '(repeat (list (regexp :tag "Group")
1616 (symbol :tag "Charset")))
1617 :parameter-type '(symbol :tag "Charset")
1618 :parameter-document "\
1619 The default charset to use in the group.")
1621 (gnus-define-group-parameter
1625 "Return a posting method for GROUP."
1626 :variable gnus-post-method-alist
1628 "Alist of regexps (to match group names) and method to be used when
1629 posting an article."
1630 :variable-group gnus-group-foreign
1632 '(choice :tag "Posting Method"
1633 (const :tag "Use native server" native)
1634 (const :tag "Use current server" current)
1635 (list :convert-widget
1637 (list 'sexp :tag "Methods"
1638 :value gnus-select-method))))
1640 "Posting method for this group.")
1642 (defcustom gnus-group-uncollapsed-levels 1
1643 "Number of group name elements to leave alone when making a short group name."
1644 :group 'gnus-group-visual
1647 (defcustom gnus-group-use-permanent-levels nil
1648 "*If non-nil, once you set a level, Gnus will use this level."
1649 :group 'gnus-group-levels
1654 (defcustom gnus-load-hook nil
1655 "A hook run while Gnus is loaded."
1659 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1660 "A hook called to apply kill files to a group.
1661 This hook is intended to apply a kill file to the selected newsgroup.
1662 The function `gnus-apply-kill-file' is called by default.
1664 Since a general kill file is too heavy to use only for a few
1665 newsgroups, I recommend you to use a lighter hook function. For
1666 example, if you'd like to apply a kill file to articles which contains
1667 a string `rmgroup' in subject in newsgroup `control', you can use the
1670 (setq gnus-apply-kill-hook
1673 (cond ((string-match \"control\" gnus-newsgroup-name)
1674 (gnus-kill \"Subject\" \"rmgroup\")
1675 (gnus-expunge \"X\"))))))"
1676 :group 'gnus-score-kill
1677 :options '(gnus-apply-kill-file)
1680 (defcustom gnus-group-change-level-function nil
1681 "Function run when a group level is changed.
1682 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1683 :group 'gnus-group-levels
1688 (defcustom gnus-visual
1689 '(summary-highlight group-highlight article-highlight
1691 summary-menu group-menu article-menu
1692 tree-highlight menu highlight
1693 browse-menu server-menu
1694 page-marker tree-menu binary-menu pick-menu
1696 "*Enable visual features.
1697 If `visual' is disabled, there will be no menus and few faces. Most of
1698 the visual customization options below will be ignored. Gnus will use
1699 less space and be faster as a result.
1701 This variable can also be a list of visual elements to switch on. For
1702 instance, to switch off all visual things except menus, you can say:
1704 (setq gnus-visual '(menu))
1706 Valid elements include `summary-highlight', `group-highlight',
1707 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1708 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1709 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1710 and `grouplens-menu'."
1713 :type '(set (const summary-highlight)
1714 (const group-highlight)
1715 (const article-highlight)
1717 (const summary-menu)
1719 (const article-menu)
1720 (const tree-highlight)
1729 (const grouplens-menu)))
1731 ;; Byte-compiler warning.
1732 (defvar gnus-visual)
1733 ;; Find out whether the gnus-visual TYPE is wanted.
1734 (defun gnus-visual-p (&optional type class)
1735 (and gnus-visual ; Has to be non-nil, at least.
1736 (if (not type) ; We don't care about type.
1738 (if (listp gnus-visual) ; It's a list, so we check it.
1739 (or (memq type gnus-visual)
1740 (memq class gnus-visual))
1743 (defcustom gnus-mouse-face
1745 (if (gnus-visual-p 'mouse-face 'highlight)
1746 (if (boundp 'gnus-mouse-face)
1747 (or gnus-mouse-face 'highlight)
1751 "*Face used for group or summary buffer mouse highlighting.
1752 The line beneath the mouse pointer will be highlighted with this
1757 (defcustom gnus-article-save-directory gnus-directory
1758 "*Name of the directory articles will be saved in (default \"~/News\")."
1759 :group 'gnus-article-saving
1762 (defvar gnus-plugged t
1763 "Whether Gnus is plugged or not.")
1765 (defcustom gnus-default-charset 'iso-8859-1
1766 "Default charset assumed to be used when viewing non-ASCII characters.
1767 This variable is overridden on a group-to-group basis by the
1768 gnus-group-charset-alist variable and is only used on groups not
1769 covered by that variable."
1771 :group 'gnus-charset)
1774 ;;; Internal variables
1776 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1777 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1778 (defvar gnus-draft-meta-information-header "X-Draft-From")
1779 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1780 (defvar gnus-original-article-buffer " *Original Article*")
1781 (defvar gnus-newsgroup-name nil)
1782 (defvar gnus-ephemeral-servers nil)
1784 (defvar gnus-agent nil
1785 "Whether we want to use the Gnus agent or not.")
1787 (defvar gnus-agent-fetching nil
1788 "Whether Gnus agent is in fetching mode.")
1790 (defvar gnus-command-method nil
1791 "Dynamically bound variable that says what the current backend is.")
1793 (defvar gnus-current-select-method nil
1794 "The current method for selecting a newsgroup.")
1796 (defvar gnus-tree-buffer "*Tree*"
1797 "Buffer where Gnus thread trees are displayed.")
1800 (defvar gnus-use-generic-from nil)
1802 ;; Variable holding the user answers to all method prompts.
1803 (defvar gnus-method-history nil)
1805 ;; Variable holding the user answers to all mail method prompts.
1806 (defvar gnus-mail-method-history nil)
1808 ;; Variable holding the user answers to all group prompts.
1809 (defvar gnus-group-history nil)
1811 (defvar gnus-server-alist nil
1812 "List of available servers.")
1814 (defcustom gnus-cache-directory
1815 (nnheader-concat gnus-directory "cache/")
1816 "*The directory where cached articles will be stored."
1820 (defvar gnus-predefined-server-alist
1823 (nnspool-spool-directory ,gnus-cache-directory)
1824 (nnspool-nov-directory ,gnus-cache-directory)
1825 (nnspool-active-file
1826 ,(nnheader-concat gnus-cache-directory "active"))))
1827 "List of predefined (convenience) servers.")
1829 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1831 (defconst gnus-article-mark-lists
1832 '((marked . tick) (replied . reply)
1833 (expirable . expire) (killed . killed)
1834 (bookmarks . bookmark) (dormant . dormant)
1835 (scored . score) (saved . save)
1836 (cached . cache) (downloadable . download)
1837 (unsendable . unsend) (forwarded . forward)
1838 (recent . recent) (seen . seen)))
1840 (defconst gnus-article-special-mark-lists
1846 ;; Propagate flags to server, with the following exceptions:
1847 ;; `seen' is private to each gnus installation
1848 ;; `cache' is a internal gnus flag for each gnus installation
1849 ;; `download' is a agent flag private to each gnus installation
1850 ;; `unsend' are for nndraft groups only
1851 ;; `score' is not a proper mark
1852 (defconst gnus-article-unpropagated-mark-lists
1853 '(seen cache download unsend score)
1854 "Marks that shouldn't be propagated to backends.
1855 Typical marks are those that make no sense in a standalone backend,
1856 such as a mark that says whether an article is stored in the cache
1857 (which doesn't make sense in a standalone backend).")
1859 (defvar gnus-headers-retrieved-by nil)
1860 (defvar gnus-article-reply nil)
1861 (defvar gnus-override-method nil)
1862 (defvar gnus-article-check-size nil)
1863 (defvar gnus-opened-servers nil)
1865 (defvar gnus-current-kill-article nil)
1867 (defvar gnus-have-read-active-file nil)
1869 (defconst gnus-maintainer
1870 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1871 "The mail address of the Gnus maintainers.")
1873 (defvar gnus-info-nodes
1874 '((gnus-group-mode "(gnus)Group Buffer")
1875 (gnus-summary-mode "(gnus)Summary Buffer")
1876 (gnus-article-mode "(gnus)Article Buffer")
1877 (gnus-server-mode "(gnus)Server Buffer")
1878 (gnus-browse-mode "(gnus)Browse Foreign Server")
1879 (gnus-tree-mode "(gnus)Tree Display"))
1880 "Alist of major modes and related Info nodes.")
1882 (defvar gnus-group-buffer "*Group*")
1883 (defvar gnus-summary-buffer "*Summary*")
1884 (defvar gnus-article-buffer "*Article*")
1885 (defvar gnus-server-buffer "*Server*")
1887 (defvar gnus-slave nil
1888 "Whether this Gnus is a slave or not.")
1890 (defvar gnus-batch-mode nil
1891 "Whether this Gnus is running in batch mode or not.")
1893 (defvar gnus-variable-list
1894 '(gnus-newsrc-options gnus-newsrc-options-n
1895 gnus-newsrc-last-checked-date
1896 gnus-newsrc-alist gnus-server-alist
1897 gnus-killed-list gnus-zombie-list
1898 gnus-topic-topology gnus-topic-alist
1900 "Gnus variables saved in the quick startup file.")
1902 (defvar gnus-newsrc-alist nil
1903 "Assoc list of read articles.
1904 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1906 (defvar gnus-newsrc-hashtb nil
1907 "Hashtable of gnus-newsrc-alist.")
1909 (defvar gnus-killed-list nil
1910 "List of killed newsgroups.")
1912 (defvar gnus-killed-hashtb nil
1913 "Hash table equivalent of gnus-killed-list.")
1915 (defvar gnus-zombie-list nil
1916 "List of almost dead newsgroups.")
1918 (defvar gnus-description-hashtb nil
1919 "Descriptions of newsgroups.")
1921 (defvar gnus-list-of-killed-groups nil
1922 "List of newsgroups that have recently been killed by the user.")
1924 (defvar gnus-active-hashtb nil
1925 "Hashtable of active articles.")
1927 (defvar gnus-moderated-hashtb nil
1928 "Hashtable of moderated newsgroups.")
1930 ;; Save window configuration.
1931 (defvar gnus-prev-winconf nil)
1933 (defvar gnus-reffed-article-number nil)
1935 ;;; Let the byte-compiler know that we know about this variable.
1936 (defvar rmail-default-rmail-file)
1938 (defvar gnus-dead-summary nil)
1940 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1941 "Regexp matching invalid groups.")
1943 ;;; End of variables.
1945 ;; Define some autoload functions Gnus might use.
1948 ;; This little mapcar goes through the list below and marks the
1949 ;; symbols in question as autoloaded functions.
1952 (let ((interactive (nth 1 (memq ':interactive package))))
1956 (when (consp function)
1957 (setq keymap (car (memq 'keymap function)))
1958 (setq function (car function)))
1959 (unless (fboundp function)
1960 (autoload function (car package) nil interactive keymap))))
1961 (if (eq (nth 1 package) ':interactive)
1964 '(("info" :interactive t Info-goto-node)
1966 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1967 ("ps-print" ps-print-preprint)
1968 ("message" :interactive t
1969 message-send-and-exit message-yank-original)
1970 ("babel" babel-as-string)
1971 ("nnmail" nnmail-split-fancy nnmail-article-group)
1972 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1973 ("rmailout" rmail-output rmail-output-to-rmail-file)
1974 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1975 rmail-show-message rmail-summary-exists
1976 rmail-select-summary rmail-update-summary)
1977 ("gnus-audio" :interactive t gnus-audio-play)
1978 ("gnus-xmas" gnus-xmas-splash)
1979 ("gnus-soup" :interactive t
1980 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1981 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1982 ("nnsoup" nnsoup-pack-replies)
1983 ("score-mode" :interactive t gnus-score-mode)
1984 ("gnus-mh" gnus-summary-save-article-folder
1985 gnus-Folder-save-name gnus-folder-save-name)
1986 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1987 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1988 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1989 gnus-demon-add-disconnection gnus-demon-add-handler
1990 gnus-demon-remove-handler)
1991 ("gnus-demon" :interactive t
1992 gnus-demon-init gnus-demon-cancel)
1993 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
1994 gnus-convert-image-to-gray-x-face)
1995 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1996 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1997 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1998 gnus-nocem-unwanted-article-p)
1999 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2000 gnus-server-server-name)
2001 ("gnus-srvr" gnus-browse-foreign-server)
2002 ("gnus-cite" :interactive t
2003 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2004 gnus-article-hide-citation gnus-article-fill-cited-article
2005 gnus-article-hide-citation-in-followups)
2006 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2007 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2008 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2009 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2010 gnus-cache-possibly-remove-articles gnus-cache-request-article
2011 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2012 gnus-cache-enter-remove-article gnus-cached-article-p
2013 gnus-cache-open gnus-cache-close gnus-cache-update-article
2014 gnus-cache-articles-in-group)
2015 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2016 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2017 ("gnus-score" :interactive t
2018 gnus-summary-increase-score gnus-summary-set-score
2019 gnus-summary-raise-thread gnus-summary-raise-same-subject
2020 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2021 gnus-summary-lower-thread gnus-summary-lower-same-subject
2022 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2023 gnus-summary-current-score gnus-score-delta-default
2024 gnus-score-flush-cache gnus-score-close
2025 gnus-possibly-score-headers gnus-score-followup-article
2026 gnus-score-followup-thread)
2028 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2029 gnus-current-score-file-nondirectory gnus-score-adaptive
2030 gnus-score-find-trace gnus-score-file-name)
2031 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2032 ("gnus-topic" :interactive t gnus-topic-mode)
2033 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2034 gnus-subscribe-topics)
2035 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2036 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2037 ("gnus-uu" :interactive t
2038 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2039 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2040 gnus-uu-mark-by-regexp gnus-uu-mark-all
2041 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2042 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2043 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2044 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2045 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2046 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2047 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2048 gnus-uu-mark-over gnus-uu-post-news)
2049 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2050 ("gnus-msg" (gnus-summary-send-map keymap)
2051 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2052 ("gnus-msg" :interactive t
2053 gnus-group-post-news gnus-group-mail gnus-group-news
2054 gnus-summary-post-news gnus-summary-news-other-window
2055 gnus-summary-followup gnus-summary-followup-with-original
2056 gnus-summary-cancel-article gnus-summary-supersede-article
2057 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2058 gnus-summary-mail-forward gnus-summary-mail-other-window
2059 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2060 gnus-summary-wide-reply gnus-summary-followup-to-mail
2061 gnus-summary-followup-to-mail-with-original gnus-bug
2062 gnus-summary-wide-reply-with-original
2063 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2064 gnus-summary-post-forward)
2065 ("gnus-picon" :interactive t gnus-treat-from-picon)
2066 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2067 gnus-grouplens-mode)
2068 ("smiley" :interactive t smiley-region)
2069 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2070 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2071 gnus-list-of-unread-articles gnus-list-of-read-articles
2072 gnus-offer-save-summaries gnus-make-thread-indent-array
2073 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2074 gnus-summary-skip-intangible gnus-summary-article-number
2075 gnus-data-header gnus-data-find)
2076 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2077 gnus-group-list-groups gnus-group-first-unread-group
2078 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2079 gnus-group-setup-buffer gnus-group-get-new-news
2080 gnus-group-make-help-group gnus-group-update-group
2081 gnus-group-iterate gnus-group-group-name)
2082 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2083 gnus-backlog-remove-article)
2084 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2085 gnus-article-prepare gnus-article-set-window-start
2086 gnus-article-next-page gnus-article-prev-page
2087 gnus-request-article-this-buffer gnus-article-mode
2088 gnus-article-setup-buffer gnus-narrow-to-page
2089 gnus-article-delete-invisible-text gnus-treat-article)
2090 ("gnus-art" :interactive t
2091 gnus-article-hide-headers gnus-article-hide-boring-headers
2092 gnus-article-treat-overstrike
2093 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2094 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2095 gnus-article-de-base64-unreadable
2096 gnus-article-decode-HZ
2097 gnus-article-wash-html
2098 gnus-article-hide-pgp
2099 gnus-article-hide-pem gnus-article-hide-signature
2100 gnus-article-strip-leading-blank-lines gnus-article-date-local
2101 gnus-article-date-original gnus-article-date-lapsed
2102 gnus-article-show-all-headers
2103 gnus-article-edit-mode gnus-article-edit-article
2104 gnus-article-edit-done gnus-article-decode-encoded-words
2105 gnus-start-date-timer gnus-stop-date-timer
2106 gnus-mime-view-all-parts)
2107 ("gnus-int" gnus-request-type)
2108 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2109 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2110 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2111 gnus-dup-enter-articles)
2112 ("gnus-range" gnus-copy-sequence)
2113 ("gnus-eform" gnus-edit-form)
2114 ("gnus-move" :interactive t
2115 gnus-group-move-group-to-server gnus-change-server)
2116 ("gnus-logic" gnus-score-advanced)
2117 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2118 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2119 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2120 gnus-async-halt-prefetch)
2121 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2122 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2123 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2124 gnus-summary-set-agent-mark gnus-agent-save-group-info)
2125 ("gnus-agent" :interactive t
2126 gnus-unplugged gnus-agentize gnus-agent-batch)
2127 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2128 gnus-summary-save-article-vm)
2129 ("compface" uncompface)
2130 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2131 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2132 ("gnus-mlspl" :interactive t gnus-group-split-setup
2133 gnus-group-split-update))))
2135 ;;; gnus-sum.el thingies
2138 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2139 "*The format specification of the lines in the summary buffer.
2141 It works along the same lines as a normal formatting string,
2142 with some simple extensions.
2144 %N Article number, left padded with spaces (string)
2146 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2147 %n Name of the poster (string)
2148 %a Extracted name of the poster (string)
2149 %A Extracted address of the poster (string)
2150 %F Contents of the From: header (string)
2151 %f Contents of the From: or To: headers (string)
2152 %x Contents of the Xref: header (string)
2153 %D Date of the article (string)
2154 %d Date of the article (string) in DD-MMM format
2155 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2156 %M Message-id of the article (string)
2157 %r References of the article (string)
2158 %c Number of characters in the article (integer)
2159 %L Number of lines in the article (integer)
2160 %I Indentation based on thread level (a string of spaces)
2161 %B A complex trn-style thread tree (string)
2162 The variables `gnus-sum-thread-*' can be used for customization.
2163 %T A string with two possible values: 80 spaces if the article
2164 is on thread level two or larger and 0 spaces on level one
2165 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2166 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2167 %[ Opening bracket (character, \"[\" or \"<\")
2168 %] Closing bracket (character, \"]\" or \">\")
2169 %> Spaces of length thread-level (string)
2170 %< Spaces of length (- 20 thread-level) (string)
2171 %i Article score (number)
2172 %z Article zcore (character)
2173 %t Number of articles under the current thread (number).
2174 %e Whether the thread is empty or not (character).
2175 %l GroupLens score (string).
2176 %V Total thread score (number).
2177 %P The line number (number).
2178 %O Download mark (character).
2179 %u User defined specifier. The next character in the format string should
2180 be a letter. Gnus will call the function gnus-user-format-function-X,
2181 where X is the letter following %u. The function will be passed the
2182 current header as argument. The function should return a string, which
2183 will be inserted into the summary just like information from any other
2186 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2187 with care. For reasons of efficiency, Gnus will compute what column
2188 these characters will end up in, and \"hard-code\" that. This means that
2189 it is invalid to have these specs after a variable-length spec. Well,
2190 you might not be arrested, but your summary buffer will look strange,
2191 which is bad enough.
2193 The smart choice is to have these specs as far to the left as
2196 This restriction may disappear in later versions of Gnus.
2198 General format specifiers can also be used.
2199 See (gnus)Formatting Variables."
2200 :link '(custom-manual "(gnus)Formatting Variables")
2202 :group 'gnus-summary-format)
2205 ;;; Skeleton keymaps
2208 (defun gnus-suppress-keymap (keymap)
2209 (suppress-keymap keymap)
2210 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2212 (define-key keymap (pop keys) 'undefined))))
2214 (defvar gnus-article-mode-map
2215 (let ((keymap (make-sparse-keymap)))
2216 (gnus-suppress-keymap keymap)
2218 (defvar gnus-summary-mode-map
2219 (let ((keymap (make-keymap)))
2220 (gnus-suppress-keymap keymap)
2222 (defvar gnus-group-mode-map
2223 (let ((keymap (make-keymap)))
2224 (gnus-suppress-keymap keymap)
2229 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2230 ;; If you want the cursor to go somewhere else, set these two
2231 ;; functions in some startup hook to whatever you want.
2232 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2233 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2235 ;;; Various macros and substs.
2237 (defun gnus-header-from (header)
2238 (mail-header-from header))
2240 (defmacro gnus-gethash (string hashtable)
2241 "Get hash value of STRING in HASHTABLE."
2242 `(symbol-value (intern-soft ,string ,hashtable)))
2244 (defmacro gnus-sethash (string value hashtable)
2245 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2246 `(set (intern ,string ,hashtable) ,value))
2247 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2249 (defmacro gnus-group-unread (group)
2250 "Get the currently computed number of unread articles in GROUP."
2251 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2253 (defmacro gnus-group-entry (group)
2254 "Get the newsrc entry for GROUP."
2255 `(gnus-gethash ,group gnus-newsrc-hashtb))
2257 (defmacro gnus-active (group)
2258 "Get active info on GROUP."
2259 `(gnus-gethash ,group gnus-active-hashtb))
2261 (defmacro gnus-set-active (group active)
2262 "Set GROUP's active info."
2263 `(gnus-sethash ,group ,active gnus-active-hashtb))
2265 ;; Info access macros.
2267 (defmacro gnus-info-group (info)
2269 (defmacro gnus-info-rank (info)
2271 (defmacro gnus-info-read (info)
2273 (defmacro gnus-info-marks (info)
2275 (defmacro gnus-info-method (info)
2277 (defmacro gnus-info-params (info)
2280 (defmacro gnus-info-level (info)
2281 `(let ((rank (gnus-info-rank ,info)))
2285 (defmacro gnus-info-score (info)
2286 `(let ((rank (gnus-info-rank ,info)))
2287 (or (and (consp rank) (cdr rank)) 0)))
2289 (defmacro gnus-info-set-group (info group)
2290 `(setcar ,info ,group))
2291 (defmacro gnus-info-set-rank (info rank)
2292 `(setcar (nthcdr 1 ,info) ,rank))
2293 (defmacro gnus-info-set-read (info read)
2294 `(setcar (nthcdr 2 ,info) ,read))
2295 (defmacro gnus-info-set-marks (info marks &optional extend)
2297 `(gnus-info-set-entry ,info ,marks 3)
2298 `(setcar (nthcdr 3 ,info) ,marks)))
2299 (defmacro gnus-info-set-method (info method &optional extend)
2301 `(gnus-info-set-entry ,info ,method 4)
2302 `(setcar (nthcdr 4 ,info) ,method)))
2303 (defmacro gnus-info-set-params (info params &optional extend)
2305 `(gnus-info-set-entry ,info ,params 5)
2306 `(setcar (nthcdr 5 ,info) ,params)))
2308 (defun gnus-info-set-entry (info entry number)
2309 ;; Extend the info until we have enough elements.
2310 (while (<= (length info) number)
2311 (nconc info (list nil)))
2313 (setcar (nthcdr number info) entry))
2315 (defmacro gnus-info-set-level (info level)
2316 `(let ((rank (cdr ,info)))
2317 (if (consp (car rank))
2318 (setcar (car rank) ,level)
2319 (setcar rank ,level))))
2320 (defmacro gnus-info-set-score (info score)
2321 `(let ((rank (cdr ,info)))
2322 (if (consp (car rank))
2323 (setcdr (car rank) ,score)
2324 (setcar rank (cons (car rank) ,score)))))
2326 (defmacro gnus-get-info (group)
2327 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2329 ;;; Load the compatability functions.
2338 (defvar gnus-shutdown-alist nil)
2340 (defun gnus-add-shutdown (function &rest symbols)
2341 "Run FUNCTION whenever one of SYMBOLS is shut down."
2342 (push (cons function symbols) gnus-shutdown-alist))
2344 (defun gnus-shutdown (symbol)
2345 "Shut down everything that waits for SYMBOL."
2346 (let ((alist gnus-shutdown-alist)
2348 (while (setq entry (pop alist))
2349 (when (memq symbol (cdr entry))
2350 (funcall (car entry))))))
2354 ;;; Gnus Utility Functions
2357 (defun gnus-find-subscribed-addresses ()
2358 "Return a regexp matching the addresses of all subscribed mail groups.
2359 It consists of the `to-address' or `to-list' parameter of all groups
2360 with a `subscribed' parameter."
2361 (let (group address addresses)
2362 (dolist (entry (cdr gnus-newsrc-alist))
2363 (setq group (car entry))
2364 (when (gnus-group-find-parameter group 'subscribed)
2365 (setq address (or (gnus-group-fast-parameter group 'to-address)
2366 (gnus-group-fast-parameter group 'to-list)))
2368 (push address addresses))))
2369 (list (mapconcat 'regexp-quote addresses "\\|"))))
2371 (defmacro gnus-string-or (&rest strings)
2372 "Return the first element of STRINGS that is a non-blank string.
2373 STRINGS will be evaluated in normal `or' order."
2374 `(gnus-string-or-1 ',strings))
2376 (defun gnus-string-or-1 (strings)
2379 (setq string (eval (pop strings)))
2380 (if (string-match "^[ \t]*$" string)
2382 (setq strings nil)))
2385 (defun gnus-version (&optional arg)
2386 "Version number of this version of Gnus.
2387 If ARG, insert string at point."
2390 (insert (message gnus-version))
2391 (message gnus-version)))
2393 (defun gnus-continuum-version (&optional version)
2394 "Return VERSION as a floating point number."
2397 (setq version gnus-version))
2398 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2399 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2400 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2401 (number (match-string 2 version))
2403 (unless (string-match
2404 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2405 (error "Invalid version string: %s" version))
2406 (setq major (string-to-number (match-string 1 number))
2407 minor (string-to-number (match-string 2 number))
2408 least (if (match-beginning 3)
2409 (string-to-number (match-string 3 number))
2413 (format "%s00%02d%02d"
2414 (if (member alpha '("(ding)" "d"))
2418 (- (mm-char-int (aref (downcase alpha) 0))
2422 (format "%d.%02d%02d" major minor least))))))
2424 (defun gnus-info-find-node (&optional nodename)
2425 "Find Info documentation of Gnus."
2427 ;; Enlarge info window if needed.
2428 (let (gnus-info-buffer)
2429 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
2430 (setq gnus-info-buffer (current-buffer))
2431 (gnus-configure-windows 'info)))
2434 ;;; gnus-interactive
2437 (defvar gnus-current-prefix-symbol nil
2438 "Current prefix symbol.")
2440 (defvar gnus-current-prefix-symbols nil
2441 "List of current prefix symbols.")
2443 (defun gnus-interactive (string &optional params)
2444 "Return a list that can be fed to `interactive'.
2445 See `interactive' for full documentation.
2447 Adds the following specs:
2449 y -- The current symbolic prefix.
2450 Y -- A list of the current symbolic prefix(es).
2451 A -- Article number.
2452 H -- Article header.
2456 (while (< i (length string))
2457 (string-match ".\\([^\n]*\\)\n?" string i)
2458 (setq c (aref string i))
2460 (setq prompt (match-string 1 string)))
2461 (setq i (match-end 0))
2462 ;; We basically emulate just about everything that
2463 ;; `interactive' does, but add the specs listed above.
2467 (completing-read prompt obarray 'fboundp t))
2469 (read-buffer prompt (current-buffer) t))
2471 (read-buffer prompt (other-buffer (current-buffer))))
2475 (completing-read prompt obarray 'commandp t))
2479 (read-file-name prompt nil default-directory 'lambda))
2481 (read-file-name prompt nil nil 'lambda))
2483 (read-file-name prompt))
2485 (read-key-sequence prompt))
2487 (error "Not implemented spec"))
2489 (error "Not implemented spec"))
2493 (error "Not implemented spec"))
2495 (string-to-number (read-from-minibuffer prompt)))
2497 (prefix-numeric-value current-prefix-arg))
2503 (read-string prompt))
2505 (intern (read-string prompt)))
2507 (read-variable prompt))
2509 (read-minibuffer prompt))
2511 (eval-minibuffer prompt))
2512 ;; And here the new specs come.
2514 gnus-current-prefix-symbol)
2516 gnus-current-prefix-symbols)
2518 (gnus-group-group-name))
2520 (gnus-summary-skip-intangible)
2521 (or (get-text-property (point) 'gnus-number)
2522 (gnus-summary-last-subject)))
2524 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2526 (error "Non-implemented spec")))
2530 (push (if (< (point) (mark)) (point) (mark)) out)
2531 (push (if (> (point) (mark)) (point) (mark)) out))))
2532 (setq out (delq 'gnus-prefix-nil out))
2535 (defun gnus-symbolic-argument (&optional arg)
2536 "Read a symbolic argument and a command, and then execute command."
2538 (let* ((in-command (this-command-keys))
2539 (command in-command)
2540 gnus-current-prefix-symbols
2541 gnus-current-prefix-symbol
2543 (while (equal in-command command)
2544 (message "%s-" (key-description (this-command-keys)))
2545 (push (intern (char-to-string (read-char))) syms)
2546 (setq command (read-key-sequence nil t)))
2547 (setq gnus-current-prefix-symbols (nreverse syms)
2548 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2549 (call-interactively (key-binding command t))))
2551 ;;; More various functions.
2553 (defsubst gnus-check-backend-function (func group)
2554 "Check whether GROUP supports function FUNC.
2555 GROUP can either be a string (a group name) or a select method."
2557 (let ((method (if (stringp group)
2558 (car (gnus-find-method-for-group group))
2560 (unless (featurep method)
2562 (fboundp (intern (format "%s-%s" method func))))))
2564 (defun gnus-group-read-only-p (&optional group)
2565 "Check whether GROUP supports editing or not.
2566 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2567 that that variable is buffer-local to the summary buffers."
2568 (let ((group (or group gnus-newsgroup-name)))
2569 (not (gnus-check-backend-function 'request-replace-article group))))
2571 (defun gnus-virtual-group-p (group)
2572 "Say whether GROUP is virtual or not."
2573 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2574 gnus-valid-select-methods)))
2576 (defun gnus-news-group-p (group &optional article)
2577 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2578 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
2579 t) ;is news of course.
2580 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
2581 nil) ;must be mail then.
2582 ((vectorp article) ;Has header info.
2583 (eq (gnus-request-type group (mail-header-id article)) 'news))
2584 ((null article) ;Hasn't header info
2585 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
2586 ((< article 0) ;Virtual message
2587 nil) ;we don't know, guess mail.
2588 (t ;Has positive number
2589 (eq (gnus-request-type group article) 'news)))) ;use it.
2591 ;; Returns a list of writable groups.
2592 (defun gnus-writable-groups ()
2593 (let ((alist gnus-newsrc-alist)
2595 (while (setq group (car (pop alist)))
2596 (unless (gnus-group-read-only-p group)
2597 (push group groups)))
2600 ;; Check whether to use long file names.
2601 (defun gnus-use-long-file-name (symbol)
2602 ;; The variable has to be set...
2603 (and gnus-use-long-file-name
2604 ;; If it isn't a list, then we return t.
2605 (or (not (listp gnus-use-long-file-name))
2606 ;; If it is a list, and the list contains `symbol', we
2608 (not (memq symbol gnus-use-long-file-name)))))
2610 ;; Generate a unique new group name.
2611 (defun gnus-generate-new-group-name (leaf)
2614 (while (gnus-gethash name gnus-newsrc-hashtb)
2615 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2618 (defun gnus-ephemeral-group-p (group)
2619 "Say whether GROUP is ephemeral or not."
2620 (gnus-group-get-parameter group 'quit-config t))
2622 (defun gnus-group-quit-config (group)
2623 "Return the quit-config of GROUP."
2624 (gnus-group-get-parameter group 'quit-config t))
2626 (defun gnus-kill-ephemeral-group (group)
2627 "Remove ephemeral GROUP from relevant structures."
2628 (gnus-sethash group nil gnus-newsrc-hashtb))
2630 (defun gnus-simplify-mode-line ()
2631 "Make mode lines a bit simpler."
2632 (setq mode-line-modified (cdr gnus-mode-line-modified))
2633 (when (listp mode-line-format)
2634 (make-local-variable 'mode-line-format)
2635 (setq mode-line-format (copy-sequence mode-line-format))
2636 (when (equal (nth 3 mode-line-format) " ")
2637 (setcar (nthcdr 3 mode-line-format) " "))))
2639 ;;; Servers and groups.
2641 (defsubst gnus-server-add-address (method)
2642 (let ((method-name (symbol-name (car method))))
2643 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2644 (not (assq (intern (concat method-name "-address")) method))
2645 (memq 'physical-address (assq (car method)
2646 gnus-valid-select-methods)))
2647 (append method (list (list (intern (concat method-name "-address"))
2651 (defsubst gnus-server-get-method (group method)
2652 ;; Input either a server name, and extended server name, or a
2653 ;; select method, and return a select method.
2654 (cond ((stringp method)
2655 (gnus-server-to-method method))
2656 ((equal method gnus-select-method)
2658 ((and (stringp (car method))
2660 (gnus-server-extend-method group method))
2663 (equal (cadr method) ""))
2666 (gnus-server-add-address method))))
2668 (defun gnus-server-to-method (server)
2669 "Map virtual server names to select methods."
2671 ;; Is this a method, perhaps?
2672 (and server (listp server) server)
2673 ;; Perhaps this is the native server?
2674 (and (equal server "native") gnus-select-method)
2675 ;; It should be in the server alist.
2676 (cdr (assoc server gnus-server-alist))
2677 ;; It could be in the predefined server alist.
2678 (cdr (assoc server gnus-predefined-server-alist))
2679 ;; If not, we look through all the opened server
2680 ;; to see whether we can find it there.
2681 (let ((opened gnus-opened-servers))
2683 (not (equal server (format "%s:%s" (caaar opened)
2687 ;; It could be a named method, search all servers
2688 (let ((servers gnus-secondary-select-methods))
2690 (not (equal server (format "%s:%s" (caar servers)
2695 (defmacro gnus-method-equal (ss1 ss2)
2696 "Say whether two servers are equal."
2700 (and (= (length s1) (length s2))
2702 (while (and s1 (member (car s1) s2))
2706 (defun gnus-methods-equal-p (m1 m2)
2707 (let ((m1 (or m1 gnus-select-method))
2708 (m2 (or m2 gnus-select-method)))
2710 (and (eq (car m1) (car m2))
2711 (or (not (memq 'address (assoc (symbol-name (car m1))
2712 gnus-valid-select-methods)))
2713 (equal (nth 1 m1) (nth 1 m2)))))))
2715 (defun gnus-server-equal (m1 m2)
2716 "Say whether two methods are equal."
2717 (let ((m1 (cond ((null m1) gnus-select-method)
2718 ((stringp m1) (gnus-server-to-method m1))
2720 (m2 (cond ((null m2) gnus-select-method)
2721 ((stringp m2) (gnus-server-to-method m2))
2723 (gnus-method-equal m1 m2)))
2725 (defun gnus-servers-using-backend (backend)
2726 "Return a list of known servers using BACKEND."
2727 (let ((opened gnus-opened-servers)
2730 (when (eq backend (caaar opened))
2731 (push (caar opened) out))
2735 (defun gnus-archive-server-wanted-p ()
2736 "Say whether the user wants to use the archive server."
2738 ((or (not gnus-message-archive-method)
2739 (not gnus-message-archive-group))
2741 ((and gnus-message-archive-method gnus-message-archive-group)
2744 (let ((active (cadr (assq 'nnfolder-active-file
2745 gnus-message-archive-method))))
2747 (file-exists-p active))))))
2749 (defsubst gnus-method-to-server-name (method)
2751 (format "%s" (car method))
2753 (or (assoc (format "%s" (car method))
2754 (gnus-methods-using 'address))
2755 (gnus-server-equal method gnus-message-archive-method))
2757 (not (string= (nth 1 method) "")))
2758 (concat "+" (nth 1 method)))))
2760 (defsubst gnus-method-to-full-server-name (method)
2761 (format "%s+%s" (car method) (nth 1 method)))
2763 (defun gnus-group-prefixed-name (group method)
2764 "Return the whole name from GROUP and METHOD."
2765 (and (stringp method) (setq method (gnus-server-to-method method)))
2766 (if (or (not method)
2767 (gnus-server-equal method "native")
2768 (string-match ":" group))
2770 (concat (gnus-method-to-server-name method) ":" group)))
2772 (defun gnus-group-real-prefix (group)
2773 "Return the prefix of the current group name."
2774 (if (string-match "^[^:]+:" group)
2775 (substring group 0 (match-end 0))
2778 (defun gnus-group-method (group)
2779 "Return the server or method used for selecting GROUP.
2780 You should probably use `gnus-find-method-for-group' instead."
2781 (let ((prefix (gnus-group-real-prefix group)))
2782 (if (equal prefix "")
2784 (let ((servers gnus-opened-servers)
2786 backend possible found)
2787 (if (string-match "^[^\\+]+\\+" prefix)
2788 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2789 server (substring prefix (match-end 0) (1- (length prefix))))
2790 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2792 (when (eq (caaar servers) backend)
2793 (setq possible (caar servers))
2794 (when (equal (cadaar servers) server)
2795 (setq found (caar servers))))
2797 (or (car (rassoc found gnus-server-alist))
2799 (car (rassoc possible gnus-server-alist))
2801 (list backend server))))))
2803 (defsubst gnus-native-method-p (method)
2804 "Return whether METHOD is the native select method."
2805 (gnus-method-equal method gnus-select-method))
2807 (defsubst gnus-secondary-method-p (method)
2808 "Return whether METHOD is a secondary select method."
2809 (let ((methods gnus-secondary-select-methods)
2810 (gmethod (gnus-server-get-method nil method)))
2812 (not (gnus-method-equal
2813 (gnus-server-get-method nil (car methods))
2815 (setq methods (cdr methods)))
2818 (defun gnus-method-simplify (method)
2819 "Return the shortest uniquely identifying string or method for METHOD."
2820 (cond ((stringp method)
2822 ((gnus-native-method-p method)
2824 ((gnus-secondary-method-p method)
2825 (format "%s:%s" (nth 0 method) (nth 1 method)))
2829 (defun gnus-groups-from-server (server)
2830 "Return a list of all groups that are fetched from SERVER."
2831 (let ((alist (cdr gnus-newsrc-alist))
2833 (while (setq info (pop alist))
2834 (when (gnus-server-equal (gnus-info-method info) server)
2835 (push (gnus-info-group info) groups)))
2836 (sort groups 'string<)))
2838 (defun gnus-group-foreign-p (group)
2839 "Say whether a group is foreign or not."
2840 (and (not (gnus-group-native-p group))
2841 (not (gnus-group-secondary-p group))))
2843 (defun gnus-group-native-p (group)
2844 "Say whether the group is native or not."
2845 (not (string-match ":" group)))
2847 (defun gnus-group-secondary-p (group)
2848 "Say whether the group is secondary or not."
2849 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2851 (defun gnus-parameters-get-parameter (group)
2852 "Return the group parameters for GROUP from `gnus-parameters'."
2854 (dolist (elem gnus-parameters)
2855 (when (string-match (car elem) group)
2857 (nconc (gnus-expand-group-parameters
2858 (car elem) (cdr elem) group)
2862 (defun gnus-expand-group-parameter (match value group)
2863 "Use MATCH to expand VALUE in GROUP."
2866 (goto-char (point-min))
2867 (while (re-search-forward match nil t)
2868 (replace-match value))
2871 (defun gnus-expand-group-parameters (match parameters group)
2872 "Go through PARAMETERS and expand them according to the match data."
2874 (dolist (elem parameters)
2875 (if (and (stringp (cdr elem))
2876 (string-match "\\\\" (cdr elem)))
2877 (push (cons (car elem)
2878 (gnus-expand-group-parameter match (cdr elem) group))
2883 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
2884 "For GROUP, return the value of SYMBOL.
2886 You should call this in the `gnus-group-buffer' buffer.
2887 The function `gnus-group-find-parameter' will do that for you."
2888 ;; The speed trick: No cons'ing and quit early.
2889 (or (let ((params (funcall gnus-group-get-parameter-function group)))
2890 ;; Start easy, check the "real" group parameters.
2891 (gnus-group-parameter-value params symbol allow-list))
2892 ;; We didn't found it there, try `gnus-parameters'.
2895 (tail gnus-parameters))
2896 ;; A good old-fashioned non-cl loop.
2898 (setq head (car tail)
2900 ;; The car is regexp matching for matching the group name.
2901 (when (string-match (car head) group)
2902 ;; The cdr is the parameters.
2903 (setq result (gnus-group-parameter-value (cdr head)
2906 ;; Expand if necessary.
2907 (if (and (stringp result) (string-match "\\\\" result))
2908 (setq result (gnus-expand-group-parameter (car head)
2910 ;; Exit the loop early.
2915 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2916 "Return the group parameters for GROUP.
2917 If SYMBOL, return the value of that symbol in the group parameters.
2919 If you call this function inside a loop, consider using the faster
2920 `gnus-group-fast-parameter' instead."
2922 (set-buffer gnus-group-buffer)
2924 (gnus-group-fast-parameter group symbol allow-list)
2928 (funcall gnus-group-get-parameter-function group))
2929 (gnus-parameters-get-parameter group))))
2932 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2933 "Return the group parameters for GROUP.
2934 If SYMBOL, return the value of that symbol in the group parameters.
2935 Most functions should use `gnus-group-find-parameter', which
2936 also examines the topic parameters."
2937 (let ((params (gnus-info-params (gnus-get-info group))))
2939 (gnus-group-parameter-value params symbol allow-list)
2942 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2943 "Return the value of SYMBOL in group PARAMS."
2944 ;; We only wish to return group parameters (dotted lists) and
2945 ;; not local variables, which may have the same names.
2946 ;; But first we handle single elements...
2947 (or (car (memq symbol params))
2951 (while (setq elem (pop params))
2952 (when (and (consp elem)
2953 (eq (car elem) symbol)
2956 (throw 'found (cdr elem))))))))
2958 (defun gnus-group-add-parameter (group param)
2959 "Add parameter PARAM to GROUP."
2960 (let ((info (gnus-get-info group)))
2962 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2963 ;; Cons the new param to the old one and update.
2964 (gnus-group-set-info (cons param (gnus-info-params info))
2967 (defun gnus-group-set-parameter (group name value)
2968 "Set parameter NAME to VALUE in GROUP."
2969 (let ((info (gnus-get-info group)))
2971 (gnus-group-remove-parameter group name)
2972 (let ((old-params (gnus-info-params info))
2973 (new-params (list (cons name value))))
2975 (when (or (not (listp (car old-params)))
2976 (not (eq (caar old-params) name)))
2977 (setq new-params (append new-params (list (car old-params)))))
2978 (setq old-params (cdr old-params)))
2979 (gnus-group-set-info new-params group 'params)))))
2981 (defun gnus-group-remove-parameter (group name)
2982 "Remove parameter NAME from GROUP."
2983 (let ((info (gnus-get-info group)))
2985 (let ((params (gnus-info-params info)))
2987 (setq params (delq name params))
2988 (while (assq name params)
2989 (gnus-pull name params))
2990 (gnus-info-set-params info params))))))
2992 (defun gnus-group-add-score (group &optional score)
2993 "Add SCORE to the GROUP score.
2994 If SCORE is nil, add 1 to the score of GROUP."
2995 (let ((info (gnus-get-info group)))
2997 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2999 (defun gnus-short-group-name (group &optional levels)
3000 "Collapse GROUP name LEVELS.
3001 Select methods are stripped and any remote host name is stripped down to
3002 just the host name."
3008 gnus-group-uncollapsed-levels
3010 (while (string-match "\\." group skip)
3011 (setq skip (match-end 0)
3014 ;; Separate foreign select method from group name and collapse.
3015 ;; If method contains a server, collapse to non-domain server name,
3016 ;; otherwise collapse to select method.
3017 (let* ((colon (string-match ":" group))
3018 (server (and colon (substring group 0 colon)))
3019 (plus (and server (string-match "+" server))))
3022 (setq foreign (substring server (+ 1 plus)
3023 (string-match "\\." server))
3024 group (substring group (+ 1 colon)))
3025 (setq foreign server
3026 group (substring group (+ 1 colon))))
3027 (setq foreign (concat foreign ":")))
3028 ;; Collapse group name leaving LEVELS uncollapsed elements
3029 (let* ((slist (split-string group "/"))
3030 (slen (length slist))
3031 (dlist (split-string group "\\."))
3032 (dlen (length dlist))
3044 (setq levels (- glen levels))
3046 (push (if (>= (decf levels) 0)
3047 (if (zerop (length g))
3052 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3054 (defun gnus-narrow-to-body ()
3055 "Narrow to the body of an article."
3058 (goto-char (point-min))
3059 (or (search-forward "\n\n" nil t)
3065 ;;; Kill file handling.
3068 (defun gnus-apply-kill-file ()
3069 "Apply a kill file to the current newsgroup.
3070 Returns the number of articles marked as read."
3071 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3072 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3073 (gnus-apply-kill-file-internal)
3076 (defun gnus-kill-save-kill-buffer ()
3077 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3078 (when (get-file-buffer file)
3080 (set-buffer (get-file-buffer file))
3081 (when (buffer-modified-p)
3083 (kill-buffer (current-buffer))))))
3085 (defcustom gnus-kill-file-name "KILL"
3086 "Suffix of the kill files."
3087 :group 'gnus-score-kill
3088 :group 'gnus-score-files
3091 (defun gnus-newsgroup-kill-file (newsgroup)
3092 "Return the name of a kill file name for NEWSGROUP.
3093 If NEWSGROUP is nil, return the global kill file name instead."
3095 ;; The global KILL file is placed at top of the directory.
3096 ((or (null newsgroup)
3097 (string-equal newsgroup ""))
3098 (expand-file-name gnus-kill-file-name
3099 gnus-kill-files-directory))
3100 ;; Append ".KILL" to newsgroup name.
3101 ((gnus-use-long-file-name 'not-kill)
3102 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3103 "." gnus-kill-file-name)
3104 gnus-kill-files-directory))
3105 ;; Place "KILL" under the hierarchical directory.
3107 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3108 "/" gnus-kill-file-name)
3109 gnus-kill-files-directory))))
3113 (defun gnus-member-of-valid (symbol group)
3114 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3116 (symbol-name (car (gnus-find-method-for-group group)))
3117 gnus-valid-select-methods)))
3119 (defun gnus-method-option-p (method option)
3120 "Return non-nil if select METHOD has OPTION as a parameter."
3121 (when (stringp method)
3122 (setq method (gnus-server-to-method method)))
3123 (memq option (assoc (format "%s" (car method))
3124 gnus-valid-select-methods)))
3126 (defun gnus-similar-server-opened (method)
3127 (let ((opened gnus-opened-servers))
3128 (while (and method opened)
3129 (when (and (equal (cadr method) (cadaar opened))
3130 (equal (car method) (caaar opened))
3131 (not (equal method (caar opened))))
3136 (defun gnus-server-extend-method (group method)
3137 ;; This function "extends" a virtual server. If the server is
3138 ;; "hello", and the select method is ("hello" (my-var "something"))
3139 ;; in the group "alt.alt", this will result in a new virtual server
3140 ;; called "hello+alt.alt".
3141 (if (or (not (inline (gnus-similar-server-opened method)))
3142 (not (cddr method)))
3144 `(,(car method) ,(concat (cadr method) "+" group)
3145 (,(intern (format "%s-address" (car method))) ,(cadr method))
3148 (defun gnus-server-status (method)
3149 "Return the status of METHOD."
3150 (nth 1 (assoc method gnus-opened-servers)))
3152 (defun gnus-group-name-to-method (group)
3153 "Guess a select method based on GROUP."
3154 (if (string-match ":" group)
3155 (let ((server (substring group 0 (match-beginning 0))))
3156 (if (string-match "\\+" server)
3157 (list (intern (substring server 0 (match-beginning 0)))
3158 (substring server (match-end 0)))
3159 (list (intern server) "")))
3160 gnus-select-method))
3162 (defun gnus-server-string (server)
3163 "Return a readable string that describes SERVER."
3164 (let* ((server (gnus-server-to-method server))
3165 (address (nth 1 server)))
3167 (not (zerop (length address))))
3168 (format "%s via %s" address (car server))
3169 (format "%s" (car server)))))
3171 (defun gnus-find-method-for-group (group &optional info)
3172 "Find the select method that GROUP uses."
3173 (or gnus-override-method
3176 (and (not (gnus-group-entry group)) ;; a new group
3177 (gnus-group-name-to-method group))
3178 (let ((info (or info (gnus-get-info group)))
3181 (not (setq method (gnus-info-method info)))
3182 (equal method "native"))
3185 (cond ((stringp method)
3186 (inline (gnus-server-to-method method)))
3187 ((stringp (cadr method))
3188 (inline (gnus-server-extend-method group method)))
3191 (cond ((equal (cadr method) "")
3193 ((null (cadr method))
3194 (list (car method) ""))
3196 (gnus-server-add-address method)))))))
3198 (defun gnus-methods-using (feature)
3199 "Find all methods that have FEATURE."
3200 (let ((valids gnus-valid-select-methods)
3203 (when (memq feature (car valids))
3204 (push (car valids) outs))
3205 (setq valids (cdr valids)))
3208 (defun gnus-read-group (prompt &optional default)
3209 "Prompt the user for a group name.
3210 Disallow invalid group names."
3215 gnus-invalid-group-regexp
3216 (setq group (read-string (concat prefix prompt)
3217 (cons (or default "") 0)
3218 'gnus-group-history)))
3219 (setq prefix (format "Invalid group name: \"%s\". " group)
3223 (defun gnus-read-method (prompt)
3224 "Prompt the user for a method.
3225 Allow completion over sensible values."
3226 (let* ((open-servers
3227 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3228 gnus-opened-servers))
3231 (dolist (method gnus-valid-select-methods)
3232 (if (or (memq 'prompt-address method)
3233 (not (assoc (format "%s:" (car method)) open-servers)))
3234 (push method methods)))
3237 (append valid-methods
3239 gnus-predefined-server-alist
3244 nil t nil 'gnus-method-history)))
3247 (setq method gnus-select-method))
3248 ((assoc method gnus-valid-select-methods)
3249 (let ((address (if (memq 'prompt-address
3250 (assoc method gnus-valid-select-methods))
3251 (read-string "Address: ")
3253 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3254 (list (intern method) address))))
3255 ((assoc method servers)
3258 (list (intern method) "")))))
3260 ;;; User-level commands.
3263 (defun gnus-slave-no-server (&optional arg)
3264 "Read network news as a slave, without connecting to local server."
3266 (gnus-no-server arg t))
3269 (defun gnus-no-server (&optional arg slave)
3271 If ARG is a positive number, Gnus will use that as the
3272 startup level. If ARG is nil, Gnus will be started at level 2.
3273 If ARG is non-nil and not a positive number, Gnus will
3274 prompt the user for the name of an NNTP server to use.
3275 As opposed to `gnus', this command will not connect to the local server."
3277 (gnus-no-server-1 arg slave))
3280 (defun gnus-slave (&optional arg)
3281 "Read news as a slave."
3283 (gnus arg nil 'slave))
3286 (defun gnus-other-frame (&optional arg)
3287 "Pop up a frame to read news."
3289 (let ((window (get-buffer-window gnus-group-buffer)))
3291 (select-frame (window-frame window)))
3293 (select-frame (make-frame)))))
3296 ;;(setq thing ? ; this is a comment
3300 (defun gnus (&optional arg dont-connect slave)
3302 If ARG is non-nil and a positive number, Gnus will use that as the
3303 startup level. If ARG is non-nil and not a positive number, Gnus will
3304 prompt the user for the name of an NNTP server to use."
3306 (unless (byte-code-function-p (symbol-function 'gnus))
3307 (message "You should byte-compile Gnus")
3309 (gnus-1 arg dont-connect slave))
3311 ;; Allow redefinition of Gnus functions.
3317 ;;; gnus.el ends here