1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
31 (eval '(run-hooks 'gnus-load-hook))
33 (eval-when-compile (require 'cl))
38 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
42 (defgroup gnus-format nil
43 "Dealing with formatting issues."
47 (defgroup gnus-charset nil
48 "Group character set issues."
49 :link '(custom-manual "(gnus)Charsets")
53 (defgroup gnus-cache nil
57 (defgroup gnus-start nil
58 "Starting your favorite newsreader."
61 (defgroup gnus-start-server nil
62 "Server options at startup."
65 ;; These belong to gnus-group.el.
66 (defgroup gnus-group nil
68 :link '(custom-manual "(gnus)The Group Buffer")
71 (defgroup gnus-group-foreign nil
73 :link '(custom-manual "(gnus)Foreign Groups")
76 (defgroup gnus-group-new nil
77 "Automatic subscription of new groups."
80 (defgroup gnus-group-levels nil
82 :link '(custom-manual "(gnus)Group Levels")
85 (defgroup gnus-group-select nil
87 :link '(custom-manual "(gnus)Selecting a Group")
90 (defgroup gnus-group-listing nil
91 "Showing slices of the group list."
92 :link '(custom-manual "(gnus)Listing Groups")
95 (defgroup gnus-group-visual nil
96 "Sorting the group buffer."
97 :link '(custom-manual "(gnus)Group Buffer Format")
101 (defgroup gnus-group-various nil
102 "Various group options."
103 :link '(custom-manual "(gnus)Scanning New Messages")
106 ;; These belong to gnus-sum.el.
107 (defgroup gnus-summary nil
109 :link '(custom-manual "(gnus)The Summary Buffer")
112 (defgroup gnus-summary-exit nil
113 "Leaving summary buffers."
114 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
115 :group 'gnus-summary)
117 (defgroup gnus-summary-marks nil
118 "Marks used in summary buffers."
119 :link '(custom-manual "(gnus)Marking Articles")
120 :group 'gnus-summary)
122 (defgroup gnus-thread nil
123 "Ordering articles according to replies."
124 :link '(custom-manual "(gnus)Threading")
125 :group 'gnus-summary)
127 (defgroup gnus-summary-format nil
128 "Formatting of the summary buffer."
129 :link '(custom-manual "(gnus)Summary Buffer Format")
130 :group 'gnus-summary)
132 (defgroup gnus-summary-choose nil
134 :link '(custom-manual "(gnus)Choosing Articles")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-maneuvering nil
138 "Summary movement commands."
139 :link '(custom-manual "(gnus)Summary Maneuvering")
140 :group 'gnus-summary)
142 (defgroup gnus-picon nil
143 "Show pictures of people, domains, and newsgroups."
146 (defgroup gnus-summary-mail nil
147 "Mail group commands."
148 :link '(custom-manual "(gnus)Mail Group Commands")
149 :group 'gnus-summary)
151 (defgroup gnus-summary-sort nil
152 "Sorting the summary buffer."
153 :link '(custom-manual "(gnus)Sorting")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-visual nil
157 "Highlighting and menus in the summary buffer."
158 :link '(custom-manual "(gnus)Summary Highlighting")
160 :group 'gnus-summary)
162 (defgroup gnus-summary-various nil
163 "Various summary buffer options."
164 :link '(custom-manual "(gnus)Various Summary Stuff")
165 :group 'gnus-summary)
167 (defgroup gnus-summary-pick nil
168 "Pick mode in the summary buffer."
169 :link '(custom-manual "(gnus)Pick and Read")
171 :group 'gnus-summary)
173 (defgroup gnus-summary-tree nil
174 "Tree display of threads in the summary buffer."
175 :link '(custom-manual "(gnus)Tree Display")
177 :group 'gnus-summary)
179 ;; Belongs to gnus-uu.el
180 (defgroup gnus-extract-view nil
181 "Viewing extracted files."
182 :link '(custom-manual "(gnus)Viewing Files")
183 :group 'gnus-extract)
185 ;; Belongs to gnus-score.el
186 (defgroup gnus-score nil
187 "Score and kill file handling."
190 (defgroup gnus-score-kill nil
194 (defgroup gnus-score-adapt nil
195 "Adaptive score files."
198 (defgroup gnus-score-default nil
199 "Default values for score files."
202 (defgroup gnus-score-expire nil
203 "Expiring score rules."
206 (defgroup gnus-score-decay nil
207 "Decaying score rules."
210 (defgroup gnus-score-files nil
211 "Score and kill file names."
215 (defgroup gnus-score-various nil
216 "Various scoring and killing options."
220 (defgroup gnus-visual nil
221 "Options controling the visual fluff."
225 (defgroup gnus-agent nil
226 "Offline support for Gnus."
229 (defgroup gnus-files nil
230 "Files used by Gnus."
233 (defgroup gnus-dribble-file nil
235 :link '(custom-manual "(gnus)Auto Save")
238 (defgroup gnus-newsrc nil
239 "Storing Gnus state."
242 (defgroup gnus-server nil
243 "Options related to newsservers and other servers used by Gnus."
246 (defgroup gnus-server-visual nil
247 "Highlighting and menus in the server buffer."
251 (defgroup gnus-message '((message custom-group))
252 "Composing replies and followups in Gnus."
255 (defgroup gnus-meta nil
256 "Meta variables controling major portions of Gnus.
257 In general, modifying these variables does not take affect until Gnus
258 is restarted, and sometimes reloaded."
261 (defgroup gnus-various nil
262 "Other Gnus options."
263 :link '(custom-manual "(gnus)Various Various")
266 (defgroup gnus-mime nil
267 "Variables for controlling the Gnus MIME interface."
270 (defgroup gnus-exit nil
272 :link '(custom-manual "(gnus)Exiting Gnus")
275 (defgroup gnus-fun nil
276 "Frivolous Gnus extensions."
277 :link '(custom-manual "(gnus)Exiting Gnus")
280 (defconst gnus-version-number "0.06"
281 "Version number for this version of Gnus.")
283 (defconst gnus-version (format "Oort Gnus v%s" gnus-version-number)
284 "Version string for this version of Gnus.")
286 (defcustom gnus-inhibit-startup-message nil
287 "If non-nil, the startup message will not be displayed.
288 This variable is used before `.gnus.el' is loaded, so it should
289 be set in `.emacs' instead."
293 (defcustom gnus-play-startup-jingle nil
294 "If non-nil, play the Gnus jingle at startup."
298 (unless (fboundp 'gnus-group-remove-excess-properties)
299 (defalias 'gnus-group-remove-excess-properties 'ignore))
301 (unless (fboundp 'gnus-set-text-properties)
302 (defalias 'gnus-set-text-properties 'set-text-properties))
304 (unless (featurep 'gnus-xmas)
305 (defalias 'gnus-make-overlay 'make-overlay)
306 (defalias 'gnus-delete-overlay 'delete-overlay)
307 (defalias 'gnus-overlay-put 'overlay-put)
308 (defalias 'gnus-move-overlay 'move-overlay)
309 (defalias 'gnus-overlay-buffer 'overlay-buffer)
310 (defalias 'gnus-overlay-start 'overlay-start)
311 (defalias 'gnus-overlay-end 'overlay-end)
312 (defalias 'gnus-extent-detached-p 'ignore)
313 (defalias 'gnus-extent-start-open 'ignore)
314 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
315 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
316 (defalias 'gnus-character-to-event 'identity)
317 (defalias 'gnus-add-text-properties 'add-text-properties)
318 (defalias 'gnus-put-text-property 'put-text-property)
319 (defvar gnus-mode-line-image-cache t)
320 (if (fboundp 'find-image)
321 (defun gnus-mode-line-buffer-identification (line)
322 (let ((str (car-safe line)))
323 (if (and (stringp str)
324 (string-match "^Gnus:" str))
325 (progn (add-text-properties
328 (if (eq t gnus-mode-line-image-cache)
329 (setq gnus-mode-line-image-cache
331 '((:type xpm :file "gnus-pointer.xpm"
333 (:type xbm :file "gnus-pointer.xbm"
335 gnus-mode-line-image-cache)
336 'help-echo "This is Gnus")
340 (defalias 'gnus-mode-line-buffer-identification 'identity))
341 (defalias 'gnus-characterp 'numberp)
342 (defalias 'gnus-deactivate-mark 'deactivate-mark)
343 (defalias 'gnus-window-edges 'window-edges)
344 (defalias 'gnus-key-press-event-p 'numberp)
345 ;;(defalias 'gnus-decode-rfc1522 'ignore)
348 ;; We define these group faces here to avoid the display
349 ;; update forced when creating new faces.
351 (defface gnus-group-news-1-face
354 (:foreground "PaleTurquoise" :bold t))
357 (:foreground "ForestGreen" :bold t))
360 "Level 1 newsgroup face.")
362 (defface gnus-group-news-1-empty-face
365 (:foreground "PaleTurquoise"))
368 (:foreground "ForestGreen"))
371 "Level 1 empty newsgroup face.")
373 (defface gnus-group-news-2-face
376 (:foreground "turquoise" :bold t))
379 (:foreground "CadetBlue4" :bold t))
382 "Level 2 newsgroup face.")
384 (defface gnus-group-news-2-empty-face
387 (:foreground "turquoise"))
390 (:foreground "CadetBlue4"))
393 "Level 2 empty newsgroup face.")
395 (defface gnus-group-news-3-face
404 "Level 3 newsgroup face.")
406 (defface gnus-group-news-3-empty-face
415 "Level 3 empty newsgroup face.")
417 (defface gnus-group-news-4-face
426 "Level 4 newsgroup face.")
428 (defface gnus-group-news-4-empty-face
437 "Level 4 empty newsgroup face.")
439 (defface gnus-group-news-5-face
448 "Level 5 newsgroup face.")
450 (defface gnus-group-news-5-empty-face
459 "Level 5 empty newsgroup face.")
461 (defface gnus-group-news-6-face
470 "Level 6 newsgroup face.")
472 (defface gnus-group-news-6-empty-face
481 "Level 6 empty newsgroup face.")
483 (defface gnus-group-news-low-face
486 (:foreground "DarkTurquoise" :bold t))
489 (:foreground "DarkGreen" :bold t))
492 "Low level newsgroup face.")
494 (defface gnus-group-news-low-empty-face
497 (:foreground "DarkTurquoise"))
500 (:foreground "DarkGreen"))
503 "Low level empty newsgroup face.")
505 (defface gnus-group-mail-1-face
508 (:foreground "aquamarine1" :bold t))
511 (:foreground "DeepPink3" :bold t))
514 "Level 1 mailgroup face.")
516 (defface gnus-group-mail-1-empty-face
519 (:foreground "aquamarine1"))
522 (:foreground "DeepPink3"))
524 (:italic t :bold t)))
525 "Level 1 empty mailgroup face.")
527 (defface gnus-group-mail-2-face
530 (:foreground "aquamarine2" :bold t))
533 (:foreground "HotPink3" :bold t))
536 "Level 2 mailgroup face.")
538 (defface gnus-group-mail-2-empty-face
541 (:foreground "aquamarine2"))
544 (:foreground "HotPink3"))
547 "Level 2 empty mailgroup face.")
549 (defface gnus-group-mail-3-face
552 (:foreground "aquamarine3" :bold t))
555 (:foreground "magenta4" :bold t))
558 "Level 3 mailgroup face.")
560 (defface gnus-group-mail-3-empty-face
563 (:foreground "aquamarine3"))
566 (:foreground "magenta4"))
569 "Level 3 empty mailgroup face.")
571 (defface gnus-group-mail-low-face
574 (:foreground "aquamarine4" :bold t))
577 (:foreground "DeepPink4" :bold t))
580 "Low level mailgroup face.")
582 (defface gnus-group-mail-low-empty-face
585 (:foreground "aquamarine4"))
588 (:foreground "DeepPink4"))
591 "Low level empty mailgroup face.")
593 ;; Summary mode faces.
595 (defface gnus-summary-selected-face '((t
597 "Face used for selected articles.")
599 (defface gnus-summary-cancelled-face
601 (:foreground "yellow" :background "black")))
602 "Face used for cancelled articles.")
604 (defface gnus-summary-high-ticked-face
607 (:foreground "pink" :bold t))
610 (:foreground "firebrick" :bold t))
613 "Face used for high interest ticked articles.")
615 (defface gnus-summary-low-ticked-face
618 (:foreground "pink" :italic t))
621 (:foreground "firebrick" :italic t))
624 "Face used for low interest ticked articles.")
626 (defface gnus-summary-normal-ticked-face
629 (:foreground "pink"))
632 (:foreground "firebrick"))
635 "Face used for normal interest ticked articles.")
637 (defface gnus-summary-high-ancient-face
640 (:foreground "SkyBlue" :bold t))
643 (:foreground "RoyalBlue" :bold t))
646 "Face used for high interest ancient articles.")
648 (defface gnus-summary-low-ancient-face
651 (:foreground "SkyBlue" :italic t))
654 (:foreground "RoyalBlue" :italic t))
657 "Face used for low interest ancient articles.")
659 (defface gnus-summary-normal-ancient-face
662 (:foreground "SkyBlue"))
665 (:foreground "RoyalBlue"))
668 "Face used for normal interest ancient articles.")
670 (defface gnus-summary-high-unread-face
673 "Face used for high interest unread articles.")
675 (defface gnus-summary-low-unread-face
678 "Face used for low interest unread articles.")
680 (defface gnus-summary-normal-unread-face
683 "Face used for normal interest unread articles.")
685 (defface gnus-summary-high-read-face
688 (:foreground "PaleGreen"
692 (:foreground "DarkGreen"
696 "Face used for high interest read articles.")
698 (defface gnus-summary-low-read-face
701 (:foreground "PaleGreen"
705 (:foreground "DarkGreen"
709 "Face used for low interest read articles.")
711 (defface gnus-summary-normal-read-face
714 (:foreground "PaleGreen"))
717 (:foreground "DarkGreen"))
720 "Face used for normal interest read articles.")
727 (defvar gnus-buffers nil)
729 (defun gnus-get-buffer-create (name)
730 "Do the same as `get-buffer-create', but store the created buffer."
731 (or (get-buffer name)
732 (car (push (get-buffer-create name) gnus-buffers))))
734 (defun gnus-add-buffer ()
735 "Add the current buffer to the list of Gnus buffers."
736 (push (current-buffer) gnus-buffers))
738 (defun gnus-buffers ()
739 "Return a list of live Gnus buffers."
740 (while (and gnus-buffers
741 (not (buffer-name (car gnus-buffers))))
743 (let ((buffers gnus-buffers))
745 (if (buffer-name (cadr buffers))
747 (setcdr buffers (cddr buffers)))))
752 (defvar gnus-group-buffer "*Group*")
755 (autoload 'gnus-play-jingle "gnus-audio"))
757 (defface gnus-splash-face
760 (:foreground "#888888"))
763 (:foreground "#888888"))
766 "Face for the splash screen.")
768 (defun gnus-splash ()
770 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
771 (let ((buffer-read-only nil))
773 (unless gnus-inhibit-startup-message
774 (gnus-group-startup-message)
776 (when gnus-play-startup-jingle
777 (gnus-play-jingle))))))
779 (defun gnus-indent-rigidly (start end arg)
780 "Indent rigidly using only spaces and no tabs."
783 (narrow-to-region start end)
785 (indent-rigidly start end arg)
786 ;; We translate tabs into spaces -- not everybody uses
787 ;; an 8-character tab.
788 (goto-char (point-min))
789 (while (search-forward "\t" nil t)
790 (replace-match " " t t))))))
792 (defvar gnus-simple-splash nil)
794 ;;(format "%02x%02x%02x" 114 66 20) "724214"
796 (defvar gnus-logo-color-alist
797 '((flame "#cc3300" "#ff2200")
798 (pine "#c0cc93" "#f8ffb8")
799 (moss "#a1cc93" "#d2ffb8")
800 (irish "#04cc90" "#05ff97")
801 (sky "#049acc" "#05deff")
802 (tin "#6886cc" "#82b6ff")
803 (velvet "#7c68cc" "#8c82ff")
804 (grape "#b264cc" "#cf7df")
805 (labia "#cc64c2" "#fd7dff")
806 (berry "#cc6485" "#ff7db5")
807 (dino "#724214" "#1e3f03")
808 (oort "#cccccc" "#888888")
809 (storm "#666699" "#99ccff")
810 (pdino "#9999cc" "#99ccff")
811 (purp "#9999cc" "#666699")
812 (neutral "#b4b4b4" "#878787")
813 (september "#bf9900" "#ffcc00"))
814 "Color alist used for the Gnus logo.")
816 (defcustom gnus-logo-color-style 'oort
817 "*Color styles used for the Gnus logo."
818 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
819 gnus-logo-color-alist))
822 (defvar gnus-logo-colors
823 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
824 "Colors used for the Gnus logo.")
826 (defun gnus-group-startup-message (&optional x y)
827 "Insert startup message in current buffer."
828 ;; Insert the message.
832 (fboundp 'find-image)
834 (let ((image (find-image
835 `((:type xpm :file "gnus.xpm"
837 (("thing" . ,(car gnus-logo-colors))
838 ("shadow" . ,(cadr gnus-logo-colors))
839 ("background" . ,(face-background 'default))))
840 (:type pbm :file "gnus.pbm"
841 ;; Account for the pbm's blackground.
842 :background ,(face-foreground 'gnus-splash-face)
843 :foreground ,(face-background 'default))
844 (:type xbm :file "gnus.xbm"
845 ;; Account for the xbm's blackground.
846 :background ,(face-foreground 'gnus-splash-face)
847 :foreground ,(face-background 'default))))))
849 (let ((size (image-size image)))
850 (insert-char ?\n (max 0 (round (- (window-height)
851 (or y (cdr size)) 1) 2)))
852 (insert-char ?\ (max 0 (round (- (window-width)
853 (or x (car size))) 2)))
854 (insert-image image))
855 (setq gnus-simple-splash nil)
861 _ ___ __ ___ __ _ ___
881 (gnus-indent-rigidly (point-min) (point-max)
882 (/ (max (- (window-width) (or x 46)) 0) 2))
883 (goto-char (point-min))
885 (let* ((pheight (count-lines (point-min) (point-max)))
886 (wheight (window-height))
887 (rest (- wheight pheight)))
888 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
890 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
891 (setq gnus-simple-splash t)))
892 (goto-char (point-min))
893 (setq mode-line-buffer-identification (concat " " gnus-version))
894 (set-buffer-modified-p t))
897 (let ((command (format "%s" this-command)))
898 (if (and (string-match "gnus" command)
899 (not (string-match "gnus-other-frame" command)))
901 (gnus-get-buffer-create gnus-group-buffer))))
908 (defcustom gnus-parameters nil
909 "Alist of group parameters.
912 ((\"mail\\\\..*\" (gnus-show-threads nil)
913 (gnus-use-scoring nil)
914 (gnus-summary-line-format
915 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
918 (\"mail\\\\.me\" (gnus-use-scoring t))
919 (\"list\\\\..*\" (total-expire . t)
920 (broken-reply-to . t)))"
921 :group 'gnus-group-various
922 :type '(repeat (cons regexp
925 (defvar gnus-group-parameters-more nil)
927 (defmacro gnus-define-group-parameter (param &rest rest)
928 "Define a group parameter PARAM.
929 REST is a plist of following:
930 :type One of `bool', `list' or `nil'.
931 :function The name of the function.
932 :function-document The documentation of the function.
933 :parameter-type The type for customizing the parameter.
934 :parameter-document The documentation for the parameter.
935 :variable The name of the variable.
936 :variable-document The documentation for the variable.
937 :variable-group The group for customizing the variable.
938 :variable-type The type for customizing the variable.
939 :variable-default The default value of the variable."
940 (let* ((type (plist-get rest :type))
941 (parameter-type (plist-get rest :parameter-type))
942 (parameter-document (plist-get rest :parameter-document))
943 (function (or (plist-get rest :function)
944 (intern (format "gnus-parameter-%s" param))))
945 (function-document (or (plist-get rest :function-document) ""))
946 (variable (or (plist-get rest :variable)
947 (intern (format "gnus-parameter-%s-alist" param))))
948 (variable-document (or (plist-get rest :variable-document) ""))
949 (variable-group (plist-get rest :variable-group))
950 (variable-type (or (plist-get rest :variable-type)
952 (list (regexp :tag "Group")
953 ,(car (cdr parameter-type)))))))
954 (variable-default (plist-get rest :variable-default)))
957 `(defcustom ,variable ,variable-default
959 :group 'gnus-group-parameter
960 :group ',variable-group
961 :type ,variable-type)
962 `(setq gnus-group-parameters-more
963 (delq (assq ',param gnus-group-parameters-more)
964 gnus-group-parameters-more))
965 `(add-to-list 'gnus-group-parameters-more
968 ,parameter-document))
970 `(defun ,function (name)
972 (let ((params (gnus-group-find-parameter name))
975 ((memq ',param params)
977 ((setq val (assq ',param params))
980 (string-match ,variable name))
982 (let ((alist ,variable)
984 (while (setq elem (pop alist))
986 (string-match (car elem) name))
989 (if (consp value) (car value) value))))))
990 `(defun ,function (name)
993 (or (gnus-group-find-parameter name ',param ,(and type t))
994 (let ((alist ,variable)
996 (while (setq elem (pop alist))
998 (string-match (car elem) name))
1003 '(if (consp value) (car value) value))))))))))
1005 (defcustom gnus-home-directory "~/"
1006 "Directory variable that specifies the \"home\" directory.
1007 All other Gnus path variables are initialized from this variable."
1011 (defcustom gnus-directory (or (getenv "SAVEDIR")
1012 (nnheader-concat gnus-home-directory "News/"))
1013 "*Directory variable from which all other Gnus file variables are derived.
1015 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1016 This means that other directory variables that are initialized from
1017 this variable won't be set properly if you set this variable in `.gnus.el'.
1018 Set this variable in `.emacs' instead."
1022 (defcustom gnus-default-directory nil
1023 "*Default directory for all Gnus buffers."
1025 :type '(choice (const :tag "current" nil)
1028 ;; Site dependent variables. These variables should be defined in
1031 (defvar gnus-default-nntp-server nil
1032 "Specify a default NNTP server.
1033 This variable should be defined in paths.el, and should never be set
1035 If you want to change servers, you should use `gnus-select-method'.
1036 See the documentation to that variable.")
1038 ;; Don't touch this variable.
1039 (defvar gnus-nntp-service "nntp"
1040 "NNTP service name (\"nntp\" or 119).
1041 This is an obsolete variable, which is scarcely used. If you use an
1042 nntp server for your newsgroup and want to change the port number
1043 used to 899, you would say something along these lines:
1045 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1047 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1048 "A file with only the name of the nntp server in it."
1053 ;; This function is used to check both the environment variable
1054 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
1055 ;; an nntp server name default.
1056 (defun gnus-getenv-nntpserver ()
1057 (or (getenv "NNTPSERVER")
1058 (and (file-readable-p gnus-nntpserver-file)
1060 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
1061 (insert-file-contents gnus-nntpserver-file)
1062 (let ((name (buffer-string)))
1064 (if (string-match "\\'[ \t\n]*$" name)
1067 (kill-buffer (current-buffer))))))))
1069 (defcustom gnus-select-method
1072 (list 'nntp (or (condition-case nil
1073 (gnus-getenv-nntpserver)
1075 (when (and gnus-default-nntp-server
1076 (not (string= gnus-default-nntp-server "")))
1077 gnus-default-nntp-server)
1079 (if (or (null gnus-nntp-service)
1080 (equal gnus-nntp-service "nntp"))
1082 (list gnus-nntp-service)))
1084 "Default method for selecting a newsgroup.
1085 This variable should be a list, where the first element is how the
1086 news is to be fetched, the second is the address.
1088 For instance, if you want to get your news via NNTP from
1089 \"flab.flab.edu\", you could say:
1091 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1093 If you want to use your local spool, say:
1095 \(setq gnus-select-method (list 'nnspool (system-name)))
1097 If you use this variable, you must set `gnus-nntp-server' to nil.
1099 There is a lot more to know about select methods and virtual servers -
1100 see the manual for details."
1102 :type 'gnus-select-method)
1104 (defcustom gnus-message-archive-method "archive"
1105 "*Method used for archiving messages you've sent.
1106 This should be a mail method."
1108 :group 'gnus-message
1109 :type 'gnus-select-method)
1111 (defcustom gnus-message-archive-group nil
1112 "*Name of the group in which to save the messages you've written.
1113 This can either be a string; a list of strings; or an alist
1114 of regexps/functions/forms to be evaluated to return a string (or a list
1115 of strings). The functions are called with the name of the current
1116 group (or nil) as a parameter.
1118 If you want to save your mail in one group and the news articles you
1119 write in another group, you could say something like:
1121 \(setq gnus-message-archive-group
1122 '((if (message-news-p)
1126 Normally the group names returned by this variable should be
1127 unprefixed -- which implicitly means \"store on the archive server\".
1128 However, you may wish to store the message on some other server. In
1129 that case, just return a fully prefixed name of the group --
1130 \"nnml+private:mail.misc\", for instance."
1131 :group 'gnus-message
1132 :type '(choice (const :tag "none" nil)
1137 (defcustom gnus-secondary-servers nil
1138 "List of NNTP servers that the user can choose between interactively.
1139 To make Gnus query you for a server, you have to give `gnus' a
1140 non-numeric prefix - `C-u M-x gnus', in short."
1142 :type '(repeat string))
1144 (defcustom gnus-nntp-server nil
1145 "*The name of the host running the NNTP server.
1146 This variable is semi-obsolete. Use the `gnus-select-method'
1149 :type '(choice (const :tag "disable" nil)
1152 (defcustom gnus-secondary-select-methods nil
1153 "A list of secondary methods that will be used for reading news.
1154 This is a list where each element is a complete select method (see
1155 `gnus-select-method').
1157 If, for instance, you want to read your mail with the nnml backend,
1158 you could set this variable:
1160 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1162 :type '(repeat gnus-select-method))
1164 (defvar gnus-backup-default-subscribed-newsgroups
1165 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1166 "Default default new newsgroups the first time Gnus is run.
1167 Should be set in paths.el, and shouldn't be touched by the user.")
1169 (defcustom gnus-local-domain nil
1170 "Local domain name without a host name.
1171 The DOMAINNAME environment variable is used instead if it is defined.
1172 If the function `system-name' returns the full Internet name, there is
1173 no need to set this variable."
1174 :group 'gnus-message
1175 :type '(choice (const :tag "default" nil)
1178 (defvar gnus-local-organization nil
1179 "String with a description of what organization (if any) the user belongs to.
1180 Obsolete variable; use `message-user-organization' instead.")
1182 ;; Customization variables
1184 (defcustom gnus-refer-article-method nil
1185 "Preferred method for fetching an article by Message-ID.
1186 If you are reading news from the local spool (with nnspool), fetching
1187 articles by Message-ID is painfully slow. By setting this method to an
1188 nntp method, you might get acceptable results.
1190 The value of this variable must be a valid select method as discussed
1191 in the documentation of `gnus-select-method'.
1193 It can also be a list of select methods, as well as the special symbol
1194 `current', which means to use the current select method. If it is a
1195 list, Gnus will try all the methods in the list until it finds a match."
1197 :type '(choice (const :tag "default" nil)
1198 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1200 (repeat :menu-tag "Try multiple"
1202 :value (current (nnweb "refer" (nnweb-type dejanews)))
1203 (choice :tag "Method"
1205 (const :tag "DejaNews"
1206 (nnweb "refer" (nnweb-type dejanews)))
1207 gnus-select-method))))
1209 (defcustom gnus-group-faq-directory
1210 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1211 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1212 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1213 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1214 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1215 "/ftp@rtfm.mit.edu:/pub/usenet/"
1216 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1217 "/ftp@ftp.sunet.se:/pub/usenet/"
1218 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1219 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1220 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1221 "*Directory where the group FAQs are stored.
1222 This will most commonly be on a remote machine, and the file will be
1223 fetched by ange-ftp.
1225 This variable can also be a list of directories. In that case, the
1226 first element in the list will be used by default. The others can
1227 be used when being prompted for a site.
1229 Note that Gnus uses an aol machine as the default directory. If this
1230 feels fundamentally unclean, just think of it as a way to finally get
1231 something of value back from them.
1233 If the default site is too slow, try one of these:
1235 North America: mirrors.aol.com /pub/rtfm/usenet
1236 ftp.seas.gwu.edu /pub/rtfm
1237 rtfm.mit.edu /pub/usenet
1238 Europe: ftp.uni-paderborn.de /pub/FAQ
1239 src.doc.ic.ac.uk /usenet/news-FAQS
1240 ftp.sunet.se /pub/usenet
1241 ftp.pasteur.fr /pub/FAQ
1242 Asia: nctuccca.edu.tw /USENET/FAQ
1243 hwarang.postech.ac.kr /pub/usenet
1244 ftp.hk.super.net /mirror/faqs"
1245 :group 'gnus-group-various
1246 :type '(choice directory
1247 (repeat directory)))
1249 (defcustom gnus-use-cross-reference t
1250 "*Non-nil means that cross referenced articles will be marked as read.
1251 If nil, ignore cross references. If t, mark articles as read in
1252 subscribed newsgroups. If neither t nor nil, mark as read in all
1255 :type '(choice (const :tag "off" nil)
1256 (const :tag "subscribed" t)
1260 (defcustom gnus-process-mark ?#
1262 :group 'gnus-group-visual
1263 :group 'gnus-summary-marks
1266 (defcustom gnus-large-newsgroup 200
1267 "*The number of articles which indicates a large newsgroup.
1268 If the number of articles in a newsgroup is greater than this value,
1269 confirmation is required for selecting the newsgroup.
1270 If it is `nil', no confirmation is required."
1271 :group 'gnus-group-select
1274 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1275 "*Non-nil means that the default name of a file to save articles in is the group name.
1276 If it's nil, the directory form of the group name is used instead.
1278 If this variable is a list, and the list contains the element
1279 `not-score', long file names will not be used for score files; if it
1280 contains the element `not-save', long file names will not be used for
1281 saving; and if it contains the element `not-kill', long file names
1282 will not be used for kill files.
1284 Note that the default for this variable varies according to what system
1285 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1286 to nil while on all other systems it defaults to t."
1290 (defcustom gnus-kill-files-directory gnus-directory
1291 "*Name of the directory where kill files will be stored (default \"~/News\")."
1292 :group 'gnus-score-files
1293 :group 'gnus-score-kill
1296 (defcustom gnus-save-score nil
1297 "*If non-nil, save group scoring info."
1298 :group 'gnus-score-various
1302 (defcustom gnus-use-undo t
1303 "*If non-nil, allow undoing in Gnus group mode buffers."
1307 (defcustom gnus-use-adaptive-scoring nil
1308 "*If non-nil, use some adaptive scoring scheme.
1309 If a list, then the values `word' and `line' are meaningful. The
1310 former will perform adaption on individual words in the subject
1311 header while `line' will perform adaption on several headers."
1313 :group 'gnus-score-adapt
1314 :type '(set (const word) (const line)))
1316 (defcustom gnus-use-cache 'passive
1317 "*If nil, Gnus will ignore the article cache.
1318 If `passive', it will allow entering (and reading) articles
1319 explicitly entered into the cache. If anything else, use the
1320 cache to the full extent of the law."
1323 :type '(choice (const :tag "off" nil)
1324 (const :tag "passive" passive)
1325 (const :tag "active" t)))
1327 (defcustom gnus-use-trees nil
1328 "*If non-nil, display a thread tree buffer."
1332 (defcustom gnus-use-grouplens nil
1333 "*If non-nil, use GroupLens ratings."
1337 (defcustom gnus-keep-backlog nil
1338 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1339 If it is a number N, then Gnus will only keep the last N articles
1340 read. If it is neither nil nor a number, Gnus will keep all read
1341 articles. This is not a good idea."
1343 :type '(choice (const :tag "off" nil)
1348 (defcustom gnus-use-nocem nil
1349 "*If non-nil, Gnus will read NoCeM cancel messages."
1353 (defcustom gnus-suppress-duplicates nil
1354 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1358 (defcustom gnus-use-scoring t
1359 "*If non-nil, enable scoring."
1363 (defcustom gnus-summary-prepare-exit-hook
1364 '(gnus-summary-expire-articles)
1365 "*A hook called when preparing to exit from the summary buffer.
1366 It calls `gnus-summary-expire-articles' by default."
1367 :group 'gnus-summary-exit
1370 (defcustom gnus-novice-user t
1371 "*Non-nil means that you are a usenet novice.
1372 If non-nil, verbose messages may be displayed and confirmations may be
1377 (defcustom gnus-expert-user nil
1378 "*Non-nil means that you will never be asked for confirmation about anything.
1379 That doesn't mean *anything* anything; particularly destructive
1380 commands will still require prompting."
1384 (defcustom gnus-interactive-catchup t
1385 "*If non-nil, require your confirmation when catching up a group."
1386 :group 'gnus-group-select
1389 (defcustom gnus-interactive-exit t
1390 "*If non-nil, require your confirmation when exiting Gnus."
1394 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1395 "*Function for extracting address components from a From header.
1396 Two pre-defined function exist: `gnus-extract-address-components',
1397 which is the default, quite fast, and too simplistic solution, and
1398 `mail-extract-address-components', which works much better, but is
1400 :group 'gnus-summary-format
1401 :type '(radio (function-item gnus-extract-address-components)
1402 (function-item mail-extract-address-components)
1403 (function :tag "Other")))
1405 (defcustom gnus-carpal nil
1406 "*If non-nil, display clickable icons."
1410 (defcustom gnus-shell-command-separator ";"
1411 "String used to separate to shell commands."
1415 (defcustom gnus-valid-select-methods
1416 '(("nntp" post address prompt-address physical-address)
1417 ("nnspool" post address)
1418 ("nnvirtual" post-mail virtual prompt-address)
1419 ("nnmbox" mail respool address)
1420 ("nnml" post-mail respool address)
1421 ("nnmh" mail respool address)
1422 ("nndir" post-mail prompt-address physical-address)
1423 ("nneething" none address prompt-address physical-address)
1424 ("nndoc" none address prompt-address)
1425 ("nnbabyl" mail address respool)
1426 ("nnkiboze" post virtual)
1427 ("nnsoup" post-mail address)
1428 ("nndraft" post-mail)
1429 ("nnfolder" mail respool address)
1430 ("nngateway" post-mail address prompt-address physical-address)
1439 ("nnagent" post-mail)
1440 ("nnimap" post-mail address prompt-address physical-address)
1441 ("nnmaildir" mail respool address))
1442 "*An alist of valid select methods.
1443 The first element of each list lists should be a string with the name
1444 of the select method. The other elements may be the category of
1445 this method (i. e., `post', `mail', `none' or whatever) or other
1446 properties that this method has (like being respoolable).
1447 If you implement a new select method, all you should have to change is
1448 this variable. I think."
1450 :type '(repeat (group (string :tag "Name")
1451 (radio-button-choice (const :format "%v " post)
1452 (const :format "%v " mail)
1453 (const :format "%v " none)
1455 (checklist :inline t
1456 (const :format "%v " address)
1457 (const :format "%v " prompt-address)
1458 (const :format "%v " physical-address)
1459 (const :format "%v " virtual)
1462 (defun gnus-redefine-select-method-widget ()
1463 "Recomputes the select-method widget based on the value of
1464 `gnus-valid-select-methods'."
1465 (define-widget 'gnus-select-method 'list
1466 "Widget for entering a select method."
1468 :tag "Select Method"
1469 :args `((choice :tag "Method"
1470 ,@(mapcar (lambda (entry)
1471 (list 'const :format "%v\n"
1472 (intern (car entry))))
1473 gnus-valid-select-methods)
1474 (symbol :tag "other"))
1475 (string :tag "Address")
1476 (repeat :tag "Options"
1480 (sexp :tag "Value"))))))
1482 (gnus-redefine-select-method-widget)
1484 (defcustom gnus-updated-mode-lines '(group article summary tree)
1485 "List of buffers that should update their mode lines.
1486 The list may contain the symbols `group', `article', `tree' and
1487 `summary'. If the corresponding symbol is present, Gnus will keep
1488 that mode line updated with information that may be pertinent.
1489 If this variable is nil, screen refresh may be quicker."
1490 :group 'gnus-various
1491 :type '(set (const group)
1496 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1497 (defcustom gnus-mode-non-string-length nil
1498 "*Max length of mode-line non-string contents.
1499 If this is nil, Gnus will take space as is needed, leaving the rest
1500 of the modeline intact. Note that the default of nil is unlikely
1501 to be desirable; see the manual for further details."
1502 :group 'gnus-various
1503 :type '(choice (const nil)
1506 ;; There should be special validation for this.
1507 (define-widget 'gnus-email-address 'string
1510 (gnus-define-group-parameter
1513 "Return GROUP's to-address."
1515 "*Alist of group regexps and correspondent to-addresses."
1516 :parameter-type '(gnus-email-address :tag "To Address")
1517 :parameter-document "\
1518 This will be used when doing followups and posts.
1520 This is primarily useful in mail groups that represent closed
1521 mailing lists--mailing lists where it's expected that everybody that
1522 writes to the mailing list is subscribed to it. Since using this
1523 parameter ensures that the mail only goes to the mailing list itself,
1524 it means that members won't receive two copies of your followups.
1526 Using `to-address' will actually work whether the group is foreign or
1527 not. Let's say there's a group on the server that is called
1528 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1529 articles from a mail-to-news gateway. Posting directly to this group
1530 is therefore impossible--you have to send mail to the mailing list
1533 The gnus-group-split mail splitting mechanism will behave as if this
1534 address was listed in gnus-group-split Addresses (see below).")
1536 (gnus-define-group-parameter
1539 "Return GROUP's to-list."
1541 "*Alist of group regexps and correspondent to-lists."
1542 :parameter-type '(gnus-email-address :tag "To List")
1543 :parameter-document "\
1544 This address will be used when doing a `a' in the group.
1546 It is totally ignored when doing a followup--except that if it is
1547 present in a news group, you'll get mail group semantics when doing
1550 The gnus-group-split mail splitting mechanism will behave as if this
1551 address was listed in gnus-group-split Addresses (see below).")
1553 (gnus-define-group-parameter
1556 :function gnus-group-auto-expirable-p
1558 "Check whether GROUP is auto-expirable or not."
1559 :variable gnus-auto-expirable-newsgroups
1560 :variable-default nil
1562 "*Groups in which to automatically mark read articles as expirable.
1563 If non-nil, this should be a regexp that should match all groups in
1564 which to perform auto-expiry. This only makes sense for mail groups."
1565 :variable-group nnmail-expire
1566 :variable-type '(choice (const nil)
1568 :parameter-type '(const :tag "Automatic Expire" t)
1570 "All articles that are read will be marked as expirable.")
1572 (gnus-define-group-parameter
1575 :function gnus-group-total-expirable-p
1577 "Check whether GROUP is total-expirable or not."
1578 :variable gnus-total-expirable-newsgroups
1579 :variable-default nil
1581 "*Groups in which to perform expiry of all read articles.
1582 Use with extreme caution. All groups that match this regexp will be
1583 expiring - which means that all read articles will be deleted after
1584 \(say) one week. (This only goes for mail groups and the like, of
1586 :variable-group nnmail-expire
1587 :variable-type '(choice (const nil)
1589 :parameter-type '(const :tag "Total Expire" t)
1591 "All read articles will be put through the expiry process
1593 This happens even if they are not marked as expirable.
1596 (gnus-define-group-parameter
1599 "Return the default charset of GROUP."
1600 :variable gnus-group-charset-alist
1602 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1603 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1604 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1605 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1606 ("\\(^\\|:\\)relcom\\>" koi8-r)
1607 ("\\(^\\|:\\)fido7\\>" koi8-r)
1608 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1609 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1610 ("\\(^\\|:\\)han\\>" euc-kr)
1611 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1612 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1613 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1)
1616 "Alist of regexps (to match group names) and default charsets to be used when reading."
1617 :variable-group gnus-charset
1618 :variable-type '(repeat (list (regexp :tag "Group")
1619 (symbol :tag "Charset")))
1620 :parameter-type '(symbol :tag "Charset")
1621 :parameter-document "\
1622 The default charset to use in the group.")
1624 (gnus-define-group-parameter
1628 "Return a posting method for GROUP."
1629 :variable gnus-post-method-alist
1631 "Alist of regexps (to match group names) and method to be used when
1632 posting an article."
1633 :variable-group gnus-group-foreign
1635 '(choice :tag "Posting Method"
1636 (const :tag "Use native server" native)
1637 (const :tag "Use current server" current)
1638 (list :convert-widget
1640 (list 'sexp :tag "Methods"
1641 :value gnus-select-method))))
1643 "Posting method for this group.")
1645 (defcustom gnus-group-uncollapsed-levels 1
1646 "Number of group name elements to leave alone when making a short group name."
1647 :group 'gnus-group-visual
1650 (defcustom gnus-group-use-permanent-levels nil
1651 "*If non-nil, once you set a level, Gnus will use this level."
1652 :group 'gnus-group-levels
1657 (defcustom gnus-load-hook nil
1658 "A hook run while Gnus is loaded."
1662 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1663 "A hook called to apply kill files to a group.
1664 This hook is intended to apply a kill file to the selected newsgroup.
1665 The function `gnus-apply-kill-file' is called by default.
1667 Since a general kill file is too heavy to use only for a few
1668 newsgroups, I recommend you to use a lighter hook function. For
1669 example, if you'd like to apply a kill file to articles which contains
1670 a string `rmgroup' in subject in newsgroup `control', you can use the
1673 (setq gnus-apply-kill-hook
1676 (cond ((string-match \"control\" gnus-newsgroup-name)
1677 (gnus-kill \"Subject\" \"rmgroup\")
1678 (gnus-expunge \"X\"))))))"
1679 :group 'gnus-score-kill
1680 :options '(gnus-apply-kill-file)
1683 (defcustom gnus-group-change-level-function nil
1684 "Function run when a group level is changed.
1685 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1686 :group 'gnus-group-levels
1691 (defcustom gnus-visual
1692 '(summary-highlight group-highlight article-highlight
1694 summary-menu group-menu article-menu
1695 tree-highlight menu highlight
1696 browse-menu server-menu
1697 page-marker tree-menu binary-menu pick-menu
1699 "*Enable visual features.
1700 If `visual' is disabled, there will be no menus and few faces. Most of
1701 the visual customization options below will be ignored. Gnus will use
1702 less space and be faster as a result.
1704 This variable can also be a list of visual elements to switch on. For
1705 instance, to switch off all visual things except menus, you can say:
1707 (setq gnus-visual '(menu))
1709 Valid elements include `summary-highlight', `group-highlight',
1710 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1711 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1712 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1713 and `grouplens-menu'."
1716 :type '(set (const summary-highlight)
1717 (const group-highlight)
1718 (const article-highlight)
1720 (const summary-menu)
1722 (const article-menu)
1723 (const tree-highlight)
1732 (const grouplens-menu)))
1734 ;; Byte-compiler warning.
1735 (defvar gnus-visual)
1736 ;; Find out whether the gnus-visual TYPE is wanted.
1737 (defun gnus-visual-p (&optional type class)
1738 (and gnus-visual ; Has to be non-nil, at least.
1739 (if (not type) ; We don't care about type.
1741 (if (listp gnus-visual) ; It's a list, so we check it.
1742 (or (memq type gnus-visual)
1743 (memq class gnus-visual))
1746 (defcustom gnus-mouse-face
1748 (if (gnus-visual-p 'mouse-face 'highlight)
1749 (if (boundp 'gnus-mouse-face)
1750 (or gnus-mouse-face 'highlight)
1754 "*Face used for group or summary buffer mouse highlighting.
1755 The line beneath the mouse pointer will be highlighted with this
1760 (defcustom gnus-article-save-directory gnus-directory
1761 "*Name of the directory articles will be saved in (default \"~/News\")."
1762 :group 'gnus-article-saving
1765 (defvar gnus-plugged t
1766 "Whether Gnus is plugged or not.")
1768 (defcustom gnus-agent-cache t
1769 "Whether Gnus use agent cache."
1774 (defcustom gnus-default-charset 'iso-8859-1
1775 "Default charset assumed to be used when viewing non-ASCII characters.
1776 This variable is overridden on a group-to-group basis by the
1777 gnus-group-charset-alist variable and is only used on groups not
1778 covered by that variable."
1780 :group 'gnus-charset)
1782 (defcustom gnus-agent nil
1783 "Whether we want to use the Gnus agent or not.
1784 Putting (gnus-agentize) in ~/.gnus is obsolete by (setq gnus-agent t)."
1790 ;;; Internal variables
1792 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1793 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1794 (defvar gnus-draft-meta-information-header "X-Draft-From")
1795 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1796 (defvar gnus-original-article-buffer " *Original Article*")
1797 (defvar gnus-newsgroup-name nil)
1798 (defvar gnus-ephemeral-servers nil)
1799 (defvar gnus-server-method-cache nil)
1801 (defvar gnus-agent-fetching nil
1802 "Whether Gnus agent is in fetching mode.")
1804 (defvar gnus-agent-covered-methods nil)
1806 (defvar gnus-command-method nil
1807 "Dynamically bound variable that says what the current backend is.")
1809 (defvar gnus-current-select-method nil
1810 "The current method for selecting a newsgroup.")
1812 (defvar gnus-tree-buffer "*Tree*"
1813 "Buffer where Gnus thread trees are displayed.")
1816 (defvar gnus-use-generic-from nil)
1818 ;; Variable holding the user answers to all method prompts.
1819 (defvar gnus-method-history nil)
1821 ;; Variable holding the user answers to all mail method prompts.
1822 (defvar gnus-mail-method-history nil)
1824 ;; Variable holding the user answers to all group prompts.
1825 (defvar gnus-group-history nil)
1827 (defvar gnus-server-alist nil
1828 "List of available servers.")
1830 (defcustom gnus-cache-directory
1831 (nnheader-concat gnus-directory "cache/")
1832 "*The directory where cached articles will be stored."
1836 (defvar gnus-predefined-server-alist
1839 (nnspool-spool-directory ,gnus-cache-directory)
1840 (nnspool-nov-directory ,gnus-cache-directory)
1841 (nnspool-active-file
1842 ,(nnheader-concat gnus-cache-directory "active"))))
1843 "List of predefined (convenience) servers.")
1845 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1847 (defconst gnus-article-mark-lists
1848 '((marked . tick) (replied . reply)
1849 (expirable . expire) (killed . killed)
1850 (bookmarks . bookmark) (dormant . dormant)
1851 (scored . score) (saved . save)
1852 (cached . cache) (downloadable . download)
1853 (unsendable . unsend) (forwarded . forward)
1854 (recent . recent) (seen . seen)))
1856 (defconst gnus-article-special-mark-lists
1862 ;; Propagate flags to server, with the following exceptions:
1863 ;; `seen' is private to each gnus installation
1864 ;; `cache' is a internal gnus flag for each gnus installation
1865 ;; `download' is a agent flag private to each gnus installation
1866 ;; `unsend' are for nndraft groups only
1867 ;; `score' is not a proper mark
1868 (defconst gnus-article-unpropagated-mark-lists
1869 '(seen cache download unsend score)
1870 "Marks that shouldn't be propagated to backends.
1871 Typical marks are those that make no sense in a standalone backend,
1872 such as a mark that says whether an article is stored in the cache
1873 \(which doesn't make sense in a standalone backend).")
1875 (defvar gnus-headers-retrieved-by nil)
1876 (defvar gnus-article-reply nil)
1877 (defvar gnus-override-method nil)
1878 (defvar gnus-article-check-size nil)
1879 (defvar gnus-opened-servers nil)
1881 (defvar gnus-current-kill-article nil)
1883 (defvar gnus-have-read-active-file nil)
1885 (defconst gnus-maintainer
1886 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1887 "The mail address of the Gnus maintainers.")
1889 (defvar gnus-info-nodes
1890 '((gnus-group-mode "(gnus)Group Buffer")
1891 (gnus-summary-mode "(gnus)Summary Buffer")
1892 (gnus-article-mode "(gnus)Article Buffer")
1893 (gnus-server-mode "(gnus)Server Buffer")
1894 (gnus-browse-mode "(gnus)Browse Foreign Server")
1895 (gnus-tree-mode "(gnus)Tree Display"))
1896 "Alist of major modes and related Info nodes.")
1898 (defvar gnus-group-buffer "*Group*")
1899 (defvar gnus-summary-buffer "*Summary*")
1900 (defvar gnus-article-buffer "*Article*")
1901 (defvar gnus-server-buffer "*Server*")
1903 (defvar gnus-slave nil
1904 "Whether this Gnus is a slave or not.")
1906 (defvar gnus-batch-mode nil
1907 "Whether this Gnus is running in batch mode or not.")
1909 (defvar gnus-variable-list
1910 '(gnus-newsrc-options gnus-newsrc-options-n
1911 gnus-newsrc-last-checked-date
1912 gnus-newsrc-alist gnus-server-alist
1913 gnus-killed-list gnus-zombie-list
1914 gnus-topic-topology gnus-topic-alist
1916 "Gnus variables saved in the quick startup file.")
1918 (defvar gnus-newsrc-alist nil
1919 "Assoc list of read articles.
1920 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1922 (defvar gnus-newsrc-hashtb nil
1923 "Hashtable of gnus-newsrc-alist.")
1925 (defvar gnus-killed-list nil
1926 "List of killed newsgroups.")
1928 (defvar gnus-killed-hashtb nil
1929 "Hash table equivalent of gnus-killed-list.")
1931 (defvar gnus-zombie-list nil
1932 "List of almost dead newsgroups.")
1934 (defvar gnus-description-hashtb nil
1935 "Descriptions of newsgroups.")
1937 (defvar gnus-list-of-killed-groups nil
1938 "List of newsgroups that have recently been killed by the user.")
1940 (defvar gnus-active-hashtb nil
1941 "Hashtable of active articles.")
1943 (defvar gnus-moderated-hashtb nil
1944 "Hashtable of moderated newsgroups.")
1946 ;; Save window configuration.
1947 (defvar gnus-prev-winconf nil)
1949 (defvar gnus-reffed-article-number nil)
1951 ;;; Let the byte-compiler know that we know about this variable.
1952 (defvar rmail-default-rmail-file)
1954 (defvar gnus-dead-summary nil)
1956 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1957 "Regexp matching invalid groups.")
1959 ;;; End of variables.
1961 ;; Define some autoload functions Gnus might use.
1964 ;; This little mapcar goes through the list below and marks the
1965 ;; symbols in question as autoloaded functions.
1968 (let ((interactive (nth 1 (memq ':interactive package))))
1972 (when (consp function)
1973 (setq keymap (car (memq 'keymap function)))
1974 (setq function (car function)))
1975 (unless (fboundp function)
1976 (autoload function (car package) nil interactive keymap))))
1977 (if (eq (nth 1 package) ':interactive)
1980 '(("info" :interactive t Info-goto-node)
1982 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1983 ("ps-print" ps-print-preprint)
1984 ("message" :interactive t
1985 message-send-and-exit message-yank-original)
1986 ("babel" babel-as-string)
1987 ("nnmail" nnmail-split-fancy nnmail-article-group)
1988 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1989 ("rmailout" rmail-output rmail-output-to-rmail-file)
1990 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1991 rmail-show-message rmail-summary-exists
1992 rmail-select-summary rmail-update-summary)
1993 ("gnus-audio" :interactive t gnus-audio-play)
1994 ("gnus-xmas" gnus-xmas-splash)
1995 ("gnus-soup" :interactive t
1996 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1997 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1998 ("nnsoup" nnsoup-pack-replies)
1999 ("score-mode" :interactive t gnus-score-mode)
2000 ("gnus-mh" gnus-summary-save-article-folder
2001 gnus-Folder-save-name gnus-folder-save-name)
2002 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2003 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2004 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2005 gnus-demon-add-disconnection gnus-demon-add-handler
2006 gnus-demon-remove-handler)
2007 ("gnus-demon" :interactive t
2008 gnus-demon-init gnus-demon-cancel)
2009 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2010 gnus-convert-image-to-gray-x-face)
2011 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2012 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2013 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2014 gnus-nocem-unwanted-article-p)
2015 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2016 gnus-server-server-name)
2017 ("gnus-srvr" gnus-browse-foreign-server)
2018 ("gnus-cite" :interactive t
2019 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2020 gnus-article-hide-citation gnus-article-fill-cited-article
2021 gnus-article-hide-citation-in-followups)
2022 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2023 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2024 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2025 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2026 gnus-cache-possibly-remove-articles gnus-cache-request-article
2027 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2028 gnus-cache-enter-remove-article gnus-cached-article-p
2029 gnus-cache-open gnus-cache-close gnus-cache-update-article
2030 gnus-cache-articles-in-group)
2031 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2032 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2033 ("gnus-score" :interactive t
2034 gnus-summary-increase-score gnus-summary-set-score
2035 gnus-summary-raise-thread gnus-summary-raise-same-subject
2036 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2037 gnus-summary-lower-thread gnus-summary-lower-same-subject
2038 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2039 gnus-summary-current-score gnus-score-delta-default
2040 gnus-score-flush-cache gnus-score-close
2041 gnus-possibly-score-headers gnus-score-followup-article
2042 gnus-score-followup-thread)
2044 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2045 gnus-current-score-file-nondirectory gnus-score-adaptive
2046 gnus-score-find-trace gnus-score-file-name)
2047 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2048 ("gnus-topic" :interactive t gnus-topic-mode)
2049 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2050 gnus-subscribe-topics)
2051 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2052 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2053 ("gnus-uu" :interactive t
2054 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2055 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2056 gnus-uu-mark-by-regexp gnus-uu-mark-all
2057 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2058 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2059 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2060 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2061 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2062 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2063 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2064 gnus-uu-mark-over gnus-uu-post-news)
2065 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2066 ("gnus-msg" (gnus-summary-send-map keymap)
2067 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2068 ("gnus-msg" :interactive t
2069 gnus-group-post-news gnus-group-mail gnus-group-news
2070 gnus-summary-post-news gnus-summary-news-other-window
2071 gnus-summary-followup gnus-summary-followup-with-original
2072 gnus-summary-cancel-article gnus-summary-supersede-article
2073 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2074 gnus-summary-mail-forward gnus-summary-mail-other-window
2075 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2076 gnus-summary-wide-reply gnus-summary-followup-to-mail
2077 gnus-summary-followup-to-mail-with-original gnus-bug
2078 gnus-summary-wide-reply-with-original
2079 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2080 gnus-summary-post-forward)
2081 ("gnus-picon" :interactive t gnus-treat-from-picon)
2082 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2083 gnus-grouplens-mode)
2084 ("smiley" :interactive t smiley-region)
2085 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2086 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2087 gnus-list-of-unread-articles gnus-list-of-read-articles
2088 gnus-offer-save-summaries gnus-make-thread-indent-array
2089 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2090 gnus-summary-skip-intangible gnus-summary-article-number
2091 gnus-data-header gnus-data-find)
2092 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2093 gnus-group-list-groups gnus-group-first-unread-group
2094 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2095 gnus-group-setup-buffer gnus-group-get-new-news
2096 gnus-group-make-help-group gnus-group-update-group
2097 gnus-group-iterate gnus-group-group-name)
2098 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2099 gnus-backlog-remove-article)
2100 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2101 gnus-article-prepare gnus-article-set-window-start
2102 gnus-article-next-page gnus-article-prev-page
2103 gnus-request-article-this-buffer gnus-article-mode
2104 gnus-article-setup-buffer gnus-narrow-to-page
2105 gnus-article-delete-invisible-text gnus-treat-article)
2106 ("gnus-art" :interactive t
2107 gnus-article-hide-headers gnus-article-hide-boring-headers
2108 gnus-article-treat-overstrike
2109 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2110 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2111 gnus-article-de-base64-unreadable
2112 gnus-article-decode-HZ
2113 gnus-article-wash-html
2114 gnus-article-unsplit-urls
2115 gnus-article-hide-pgp
2116 gnus-article-hide-pem gnus-article-hide-signature
2117 gnus-article-strip-leading-blank-lines gnus-article-date-local
2118 gnus-article-date-original gnus-article-date-lapsed
2119 ;; gnus-article-show-all-headers
2120 gnus-article-edit-mode gnus-article-edit-article
2121 gnus-article-edit-done gnus-article-decode-encoded-words
2122 gnus-start-date-timer gnus-stop-date-timer
2123 gnus-mime-view-all-parts)
2124 ("gnus-int" gnus-request-type)
2125 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2126 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2127 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2128 gnus-dup-enter-articles)
2129 ("gnus-range" gnus-copy-sequence)
2130 ("gnus-eform" gnus-edit-form)
2131 ("gnus-move" :interactive t
2132 gnus-group-move-group-to-server gnus-change-server)
2133 ("gnus-logic" gnus-score-advanced)
2134 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2135 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2136 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2137 gnus-async-halt-prefetch)
2138 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2139 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2140 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2141 gnus-summary-set-agent-mark gnus-agent-save-group-info
2142 gnus-agent-request-article gnus-agent-retrieve-headers)
2143 ("gnus-agent" :interactive t
2144 gnus-unplugged gnus-agentize gnus-agent-batch)
2145 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2146 gnus-summary-save-article-vm)
2147 ("compface" uncompface)
2148 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2149 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2150 ("gnus-mlspl" :interactive t gnus-group-split-setup
2151 gnus-group-split-update))))
2153 ;;; gnus-sum.el thingies
2156 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2157 "*The format specification of the lines in the summary buffer.
2159 It works along the same lines as a normal formatting string,
2160 with some simple extensions.
2162 %N Article number, left padded with spaces (string)
2164 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2165 %n Name of the poster (string)
2166 %a Extracted name of the poster (string)
2167 %A Extracted address of the poster (string)
2168 %F Contents of the From: header (string)
2169 %f Contents of the From: or To: headers (string)
2170 %x Contents of the Xref: header (string)
2171 %D Date of the article (string)
2172 %d Date of the article (string) in DD-MMM format
2173 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2174 %M Message-id of the article (string)
2175 %r References of the article (string)
2176 %c Number of characters in the article (integer)
2177 %L Number of lines in the article (integer)
2178 %I Indentation based on thread level (a string of spaces)
2179 %B A complex trn-style thread tree (string)
2180 The variables `gnus-sum-thread-*' can be used for customization.
2181 %T A string with two possible values: 80 spaces if the article
2182 is on thread level two or larger and 0 spaces on level one
2183 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2184 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2185 %[ Opening bracket (character, \"[\" or \"<\")
2186 %] Closing bracket (character, \"]\" or \">\")
2187 %> Spaces of length thread-level (string)
2188 %< Spaces of length (- 20 thread-level) (string)
2189 %i Article score (number)
2190 %z Article zcore (character)
2191 %t Number of articles under the current thread (number).
2192 %e Whether the thread is empty or not (character).
2193 %l GroupLens score (string).
2194 %V Total thread score (number).
2195 %P The line number (number).
2196 %O Download mark (character).
2197 %u User defined specifier. The next character in the format string should
2198 be a letter. Gnus will call the function gnus-user-format-function-X,
2199 where X is the letter following %u. The function will be passed the
2200 current header as argument. The function should return a string, which
2201 will be inserted into the summary just like information from any other
2204 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2205 with care. For reasons of efficiency, Gnus will compute what column
2206 these characters will end up in, and \"hard-code\" that. This means that
2207 it is invalid to have these specs after a variable-length spec. Well,
2208 you might not be arrested, but your summary buffer will look strange,
2209 which is bad enough.
2211 The smart choice is to have these specs as far to the left as
2214 This restriction may disappear in later versions of Gnus.
2216 General format specifiers can also be used.
2217 See (gnus)Formatting Variables."
2218 :link '(custom-manual "(gnus)Formatting Variables")
2220 :group 'gnus-summary-format)
2223 ;;; Skeleton keymaps
2226 (defun gnus-suppress-keymap (keymap)
2227 (suppress-keymap keymap)
2228 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2230 (define-key keymap (pop keys) 'undefined))))
2232 (defvar gnus-article-mode-map
2233 (let ((keymap (make-sparse-keymap)))
2234 (gnus-suppress-keymap keymap)
2236 (defvar gnus-summary-mode-map
2237 (let ((keymap (make-keymap)))
2238 (gnus-suppress-keymap keymap)
2240 (defvar gnus-group-mode-map
2241 (let ((keymap (make-keymap)))
2242 (gnus-suppress-keymap keymap)
2247 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2248 ;; If you want the cursor to go somewhere else, set these two
2249 ;; functions in some startup hook to whatever you want.
2250 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2251 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2253 ;;; Various macros and substs.
2255 (defun gnus-header-from (header)
2256 (mail-header-from header))
2258 (defmacro gnus-gethash (string hashtable)
2259 "Get hash value of STRING in HASHTABLE."
2260 `(symbol-value (intern-soft ,string ,hashtable)))
2262 (defmacro gnus-gethash-safe (string hashtable)
2263 "Get hash value of STRING in HASHTABLE.
2264 Return nil if not defined."
2265 `(let ((sym (intern-soft ,string ,hashtable)))
2266 (and (boundp sym) (symbol-value sym))))
2268 (defmacro gnus-sethash (string value hashtable)
2269 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2270 `(set (intern ,string ,hashtable) ,value))
2271 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2273 (defmacro gnus-group-unread (group)
2274 "Get the currently computed number of unread articles in GROUP."
2275 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2277 (defmacro gnus-group-entry (group)
2278 "Get the newsrc entry for GROUP."
2279 `(gnus-gethash ,group gnus-newsrc-hashtb))
2281 (defmacro gnus-active (group)
2282 "Get active info on GROUP."
2283 `(gnus-gethash ,group gnus-active-hashtb))
2285 (defmacro gnus-set-active (group active)
2286 "Set GROUP's active info."
2287 `(gnus-sethash ,group ,active gnus-active-hashtb))
2289 ;; Info access macros.
2291 (defmacro gnus-info-group (info)
2293 (defmacro gnus-info-rank (info)
2295 (defmacro gnus-info-read (info)
2297 (defmacro gnus-info-marks (info)
2299 (defmacro gnus-info-method (info)
2301 (defmacro gnus-info-params (info)
2304 (defmacro gnus-info-level (info)
2305 `(let ((rank (gnus-info-rank ,info)))
2309 (defmacro gnus-info-score (info)
2310 `(let ((rank (gnus-info-rank ,info)))
2311 (or (and (consp rank) (cdr rank)) 0)))
2313 (defmacro gnus-info-set-group (info group)
2314 `(setcar ,info ,group))
2315 (defmacro gnus-info-set-rank (info rank)
2316 `(setcar (nthcdr 1 ,info) ,rank))
2317 (defmacro gnus-info-set-read (info read)
2318 `(setcar (nthcdr 2 ,info) ,read))
2319 (defmacro gnus-info-set-marks (info marks &optional extend)
2321 `(gnus-info-set-entry ,info ,marks 3)
2322 `(setcar (nthcdr 3 ,info) ,marks)))
2323 (defmacro gnus-info-set-method (info method &optional extend)
2325 `(gnus-info-set-entry ,info ,method 4)
2326 `(setcar (nthcdr 4 ,info) ,method)))
2327 (defmacro gnus-info-set-params (info params &optional extend)
2329 `(gnus-info-set-entry ,info ,params 5)
2330 `(setcar (nthcdr 5 ,info) ,params)))
2332 (defun gnus-info-set-entry (info entry number)
2333 ;; Extend the info until we have enough elements.
2334 (while (<= (length info) number)
2335 (nconc info (list nil)))
2337 (setcar (nthcdr number info) entry))
2339 (defmacro gnus-info-set-level (info level)
2340 `(let ((rank (cdr ,info)))
2341 (if (consp (car rank))
2342 (setcar (car rank) ,level)
2343 (setcar rank ,level))))
2344 (defmacro gnus-info-set-score (info score)
2345 `(let ((rank (cdr ,info)))
2346 (if (consp (car rank))
2347 (setcdr (car rank) ,score)
2348 (setcar rank (cons (car rank) ,score)))))
2350 (defmacro gnus-get-info (group)
2351 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2353 ;;; Load the compatability functions.
2362 (defvar gnus-shutdown-alist nil)
2364 (defun gnus-add-shutdown (function &rest symbols)
2365 "Run FUNCTION whenever one of SYMBOLS is shut down."
2366 (push (cons function symbols) gnus-shutdown-alist))
2368 (defun gnus-shutdown (symbol)
2369 "Shut down everything that waits for SYMBOL."
2370 (let ((alist gnus-shutdown-alist)
2372 (while (setq entry (pop alist))
2373 (when (memq symbol (cdr entry))
2374 (funcall (car entry))))))
2378 ;;; Gnus Utility Functions
2381 (defun gnus-find-subscribed-addresses ()
2382 "Return a regexp matching the addresses of all subscribed mail groups.
2383 It consists of the `to-address' or `to-list' parameter of all groups
2384 with a `subscribed' parameter."
2385 (let (group address addresses)
2386 (dolist (entry (cdr gnus-newsrc-alist))
2387 (setq group (car entry))
2388 (when (gnus-group-find-parameter group 'subscribed)
2389 (setq address (or (gnus-group-fast-parameter group 'to-address)
2390 (gnus-group-fast-parameter group 'to-list)))
2392 (push address addresses))))
2393 (list (mapconcat 'regexp-quote addresses "\\|"))))
2395 (defmacro gnus-string-or (&rest strings)
2396 "Return the first element of STRINGS that is a non-blank string.
2397 STRINGS will be evaluated in normal `or' order."
2398 `(gnus-string-or-1 ',strings))
2400 (defun gnus-string-or-1 (strings)
2403 (setq string (eval (pop strings)))
2404 (if (string-match "^[ \t]*$" string)
2406 (setq strings nil)))
2409 (defun gnus-version (&optional arg)
2410 "Version number of this version of Gnus.
2411 If ARG, insert string at point."
2414 (insert (message gnus-version))
2415 (message gnus-version)))
2417 (defun gnus-continuum-version (&optional version)
2418 "Return VERSION as a floating point number."
2421 (setq version gnus-version))
2422 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2423 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2424 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2425 (number (match-string 2 version))
2427 (unless (string-match
2428 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2429 (error "Invalid version string: %s" version))
2430 (setq major (string-to-number (match-string 1 number))
2431 minor (string-to-number (match-string 2 number))
2432 least (if (match-beginning 3)
2433 (string-to-number (match-string 3 number))
2437 (format "%s00%02d%02d"
2438 (if (member alpha '("(ding)" "d"))
2442 (- (mm-char-int (aref (downcase alpha) 0))
2446 (format "%d.%02d%02d" major minor least))))))
2448 (defun gnus-info-find-node (&optional nodename)
2449 "Find Info documentation of Gnus."
2451 ;; Enlarge info window if needed.
2452 (let (gnus-info-buffer)
2453 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
2454 (setq gnus-info-buffer (current-buffer))
2455 (gnus-configure-windows 'info)))
2458 ;;; gnus-interactive
2461 (defvar gnus-current-prefix-symbol nil
2462 "Current prefix symbol.")
2464 (defvar gnus-current-prefix-symbols nil
2465 "List of current prefix symbols.")
2467 (defun gnus-interactive (string &optional params)
2468 "Return a list that can be fed to `interactive'.
2469 See `interactive' for full documentation.
2471 Adds the following specs:
2473 y -- The current symbolic prefix.
2474 Y -- A list of the current symbolic prefix(es).
2475 A -- Article number.
2476 H -- Article header.
2480 (while (< i (length string))
2481 (string-match ".\\([^\n]*\\)\n?" string i)
2482 (setq c (aref string i))
2484 (setq prompt (match-string 1 string)))
2485 (setq i (match-end 0))
2486 ;; We basically emulate just about everything that
2487 ;; `interactive' does, but add the specs listed above.
2491 (completing-read prompt obarray 'fboundp t))
2493 (read-buffer prompt (current-buffer) t))
2495 (read-buffer prompt (other-buffer (current-buffer))))
2499 (completing-read prompt obarray 'commandp t))
2503 (read-file-name prompt nil default-directory 'lambda))
2505 (read-file-name prompt nil nil 'lambda))
2507 (read-file-name prompt))
2509 (read-key-sequence prompt))
2511 (error "Not implemented spec"))
2513 (error "Not implemented spec"))
2517 (error "Not implemented spec"))
2519 (string-to-number (read-from-minibuffer prompt)))
2521 (prefix-numeric-value current-prefix-arg))
2527 (read-string prompt))
2529 (intern (read-string prompt)))
2531 (read-variable prompt))
2533 (read-minibuffer prompt))
2535 (eval-minibuffer prompt))
2536 ;; And here the new specs come.
2538 gnus-current-prefix-symbol)
2540 gnus-current-prefix-symbols)
2542 (gnus-group-group-name))
2544 (gnus-summary-skip-intangible)
2545 (or (get-text-property (point) 'gnus-number)
2546 (gnus-summary-last-subject)))
2548 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2550 (error "Non-implemented spec")))
2554 (push (if (< (point) (mark)) (point) (mark)) out)
2555 (push (if (> (point) (mark)) (point) (mark)) out))))
2556 (setq out (delq 'gnus-prefix-nil out))
2559 (defun gnus-symbolic-argument (&optional arg)
2560 "Read a symbolic argument and a command, and then execute command."
2562 (let* ((in-command (this-command-keys))
2563 (command in-command)
2564 gnus-current-prefix-symbols
2565 gnus-current-prefix-symbol
2567 (while (equal in-command command)
2568 (message "%s-" (key-description (this-command-keys)))
2569 (push (intern (char-to-string (read-char))) syms)
2570 (setq command (read-key-sequence nil t)))
2571 (setq gnus-current-prefix-symbols (nreverse syms)
2572 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2573 (call-interactively (key-binding command t))))
2575 ;;; More various functions.
2577 (defsubst gnus-check-backend-function (func group)
2578 "Check whether GROUP supports function FUNC.
2579 GROUP can either be a string (a group name) or a select method."
2581 (let ((method (if (stringp group)
2582 (car (gnus-find-method-for-group group))
2584 (unless (featurep method)
2586 (fboundp (intern (format "%s-%s" method func))))))
2588 (defun gnus-group-read-only-p (&optional group)
2589 "Check whether GROUP supports editing or not.
2590 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2591 that that variable is buffer-local to the summary buffers."
2592 (let ((group (or group gnus-newsgroup-name)))
2593 (not (gnus-check-backend-function 'request-replace-article group))))
2595 (defun gnus-virtual-group-p (group)
2596 "Say whether GROUP is virtual or not."
2597 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2598 gnus-valid-select-methods)))
2600 (defun gnus-news-group-p (group &optional article)
2601 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2602 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
2603 t) ;is news of course.
2604 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
2605 nil) ;must be mail then.
2606 ((vectorp article) ;Has header info.
2607 (eq (gnus-request-type group (mail-header-id article)) 'news))
2608 ((null article) ;Hasn't header info
2609 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
2610 ((< article 0) ;Virtual message
2611 nil) ;we don't know, guess mail.
2612 (t ;Has positive number
2613 (eq (gnus-request-type group article) 'news)))) ;use it.
2615 ;; Returns a list of writable groups.
2616 (defun gnus-writable-groups ()
2617 (let ((alist gnus-newsrc-alist)
2619 (while (setq group (car (pop alist)))
2620 (unless (gnus-group-read-only-p group)
2621 (push group groups)))
2624 ;; Check whether to use long file names.
2625 (defun gnus-use-long-file-name (symbol)
2626 ;; The variable has to be set...
2627 (and gnus-use-long-file-name
2628 ;; If it isn't a list, then we return t.
2629 (or (not (listp gnus-use-long-file-name))
2630 ;; If it is a list, and the list contains `symbol', we
2632 (not (memq symbol gnus-use-long-file-name)))))
2634 ;; Generate a unique new group name.
2635 (defun gnus-generate-new-group-name (leaf)
2638 (while (gnus-gethash name gnus-newsrc-hashtb)
2639 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2642 (defun gnus-ephemeral-group-p (group)
2643 "Say whether GROUP is ephemeral or not."
2644 (gnus-group-get-parameter group 'quit-config t))
2646 (defun gnus-group-quit-config (group)
2647 "Return the quit-config of GROUP."
2648 (gnus-group-get-parameter group 'quit-config t))
2650 (defun gnus-kill-ephemeral-group (group)
2651 "Remove ephemeral GROUP from relevant structures."
2652 (gnus-sethash group nil gnus-newsrc-hashtb))
2654 (defun gnus-simplify-mode-line ()
2655 "Make mode lines a bit simpler."
2656 (setq mode-line-modified (cdr gnus-mode-line-modified))
2657 (when (listp mode-line-format)
2658 (make-local-variable 'mode-line-format)
2659 (setq mode-line-format (copy-sequence mode-line-format))
2660 (when (equal (nth 3 mode-line-format) " ")
2661 (setcar (nthcdr 3 mode-line-format) " "))))
2663 ;;; Servers and groups.
2665 (defsubst gnus-server-add-address (method)
2666 (let ((method-name (symbol-name (car method))))
2667 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2668 (not (assq (intern (concat method-name "-address")) method))
2669 (memq 'physical-address (assq (car method)
2670 gnus-valid-select-methods)))
2671 (append method (list (list (intern (concat method-name "-address"))
2675 (defsubst gnus-server-to-method (server)
2676 "Map virtual server names to select methods."
2677 (or (and server (listp server) server)
2678 (cdr (assoc server gnus-server-method-cache))
2681 ;; Perhaps this is the native server?
2682 (and (equal server "native") gnus-select-method)
2683 ;; It should be in the server alist.
2684 (cdr (assoc server gnus-server-alist))
2685 ;; It could be in the predefined server alist.
2686 (cdr (assoc server gnus-predefined-server-alist))
2687 ;; If not, we look through all the opened server
2688 ;; to see whether we can find it there.
2689 (let ((opened gnus-opened-servers))
2691 (not (equal server (format "%s:%s" (caaar opened)
2695 ;; It could be a named method, search all servers
2696 (let ((servers gnus-secondary-select-methods))
2698 (not (equal server (format "%s:%s" (caar servers)
2702 (push (cons server result) gnus-server-method-cache)
2705 (defsubst gnus-server-get-method (group method)
2706 ;; Input either a server name, and extended server name, or a
2707 ;; select method, and return a select method.
2708 (cond ((stringp method)
2709 (gnus-server-to-method method))
2710 ((equal method gnus-select-method)
2712 ((and (stringp (car method))
2714 (gnus-server-extend-method group method))
2717 (equal (cadr method) ""))
2720 (gnus-server-add-address method))))
2722 (defmacro gnus-method-equal (ss1 ss2)
2723 "Say whether two servers are equal."
2727 (and (= (length s1) (length s2))
2729 (while (and s1 (member (car s1) s2))
2733 (defun gnus-methods-equal-p (m1 m2)
2734 (let ((m1 (or m1 gnus-select-method))
2735 (m2 (or m2 gnus-select-method)))
2737 (and (eq (car m1) (car m2))
2738 (or (not (memq 'address (assoc (symbol-name (car m1))
2739 gnus-valid-select-methods)))
2740 (equal (nth 1 m1) (nth 1 m2)))))))
2742 (defun gnus-server-equal (m1 m2)
2743 "Say whether two methods are equal."
2744 (let ((m1 (cond ((null m1) gnus-select-method)
2745 ((stringp m1) (gnus-server-to-method m1))
2747 (m2 (cond ((null m2) gnus-select-method)
2748 ((stringp m2) (gnus-server-to-method m2))
2750 (gnus-method-equal m1 m2)))
2752 (defun gnus-servers-using-backend (backend)
2753 "Return a list of known servers using BACKEND."
2754 (let ((opened gnus-opened-servers)
2757 (when (eq backend (caaar opened))
2758 (push (caar opened) out))
2762 (defun gnus-archive-server-wanted-p ()
2763 "Say whether the user wants to use the archive server."
2765 ((or (not gnus-message-archive-method)
2766 (not gnus-message-archive-group))
2768 ((and gnus-message-archive-method gnus-message-archive-group)
2771 (let ((active (cadr (assq 'nnfolder-active-file
2772 gnus-message-archive-method))))
2774 (file-exists-p active))))))
2776 (defsubst gnus-method-to-server-name (method)
2778 (format "%s" (car method))
2780 (or (assoc (format "%s" (car method))
2781 (gnus-methods-using 'address))
2782 (gnus-server-equal method gnus-message-archive-method))
2784 (not (string= (nth 1 method) "")))
2785 (concat "+" (nth 1 method)))))
2787 (defsubst gnus-method-to-full-server-name (method)
2788 (format "%s+%s" (car method) (nth 1 method)))
2790 (defun gnus-group-prefixed-name (group method)
2791 "Return the whole name from GROUP and METHOD."
2792 (and (stringp method) (setq method (gnus-server-to-method method)))
2793 (if (or (not method)
2794 (gnus-server-equal method "native")
2795 (string-match ":" group))
2797 (concat (gnus-method-to-server-name method) ":" group)))
2799 (defun gnus-group-real-prefix (group)
2800 "Return the prefix of the current group name."
2801 (if (string-match "^[^:]+:" group)
2802 (substring group 0 (match-end 0))
2805 (defun gnus-group-method (group)
2806 "Return the server or method used for selecting GROUP.
2807 You should probably use `gnus-find-method-for-group' instead."
2808 (let ((prefix (gnus-group-real-prefix group)))
2809 (if (equal prefix "")
2811 (let ((servers gnus-opened-servers)
2813 backend possible found)
2814 (if (string-match "^[^\\+]+\\+" prefix)
2815 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2816 server (substring prefix (match-end 0) (1- (length prefix))))
2817 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2819 (when (eq (caaar servers) backend)
2820 (setq possible (caar servers))
2821 (when (equal (cadaar servers) server)
2822 (setq found (caar servers))))
2824 (or (car (rassoc found gnus-server-alist))
2826 (car (rassoc possible gnus-server-alist))
2828 (list backend server))))))
2830 (defsubst gnus-native-method-p (method)
2831 "Return whether METHOD is the native select method."
2832 (gnus-method-equal method gnus-select-method))
2834 (defsubst gnus-secondary-method-p (method)
2835 "Return whether METHOD is a secondary select method."
2836 (let ((methods gnus-secondary-select-methods)
2837 (gmethod (gnus-server-get-method nil method)))
2839 (not (gnus-method-equal
2840 (gnus-server-get-method nil (car methods))
2842 (setq methods (cdr methods)))
2845 (defun gnus-method-simplify (method)
2846 "Return the shortest uniquely identifying string or method for METHOD."
2847 (cond ((stringp method)
2849 ((gnus-native-method-p method)
2851 ((gnus-secondary-method-p method)
2852 (format "%s:%s" (nth 0 method) (nth 1 method)))
2856 (defun gnus-groups-from-server (server)
2857 "Return a list of all groups that are fetched from SERVER."
2858 (let ((alist (cdr gnus-newsrc-alist))
2860 (while (setq info (pop alist))
2861 (when (gnus-server-equal (gnus-info-method info) server)
2862 (push (gnus-info-group info) groups)))
2863 (sort groups 'string<)))
2865 (defun gnus-group-foreign-p (group)
2866 "Say whether a group is foreign or not."
2867 (and (not (gnus-group-native-p group))
2868 (not (gnus-group-secondary-p group))))
2870 (defun gnus-group-native-p (group)
2871 "Say whether the group is native or not."
2872 (not (string-match ":" group)))
2874 (defun gnus-group-secondary-p (group)
2875 "Say whether the group is secondary or not."
2876 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2878 (defun gnus-parameters-get-parameter (group)
2879 "Return the group parameters for GROUP from `gnus-parameters'."
2881 (dolist (elem gnus-parameters)
2882 (when (string-match (car elem) group)
2884 (nconc (gnus-expand-group-parameters
2885 (car elem) (cdr elem) group)
2889 (defun gnus-expand-group-parameter (match value group)
2890 "Use MATCH to expand VALUE in GROUP."
2893 (goto-char (point-min))
2894 (while (re-search-forward match nil t)
2895 (replace-match value))
2898 (defun gnus-expand-group-parameters (match parameters group)
2899 "Go through PARAMETERS and expand them according to the match data."
2901 (dolist (elem parameters)
2902 (if (and (stringp (cdr elem))
2903 (string-match "\\\\[0-9&]" (cdr elem)))
2904 (push (cons (car elem)
2905 (gnus-expand-group-parameter match (cdr elem) group))
2910 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
2911 "For GROUP, return the value of SYMBOL.
2913 You should call this in the `gnus-group-buffer' buffer.
2914 The function `gnus-group-find-parameter' will do that for you."
2915 ;; The speed trick: No cons'ing and quit early.
2916 (or (let ((params (funcall gnus-group-get-parameter-function group)))
2917 ;; Start easy, check the "real" group parameters.
2918 (gnus-group-parameter-value params symbol allow-list))
2919 ;; We didn't found it there, try `gnus-parameters'.
2922 (tail gnus-parameters))
2923 ;; A good old-fashioned non-cl loop.
2925 (setq head (car tail)
2927 ;; The car is regexp matching for matching the group name.
2928 (when (string-match (car head) group)
2929 ;; The cdr is the parameters.
2930 (setq result (gnus-group-parameter-value (cdr head)
2933 ;; Expand if necessary.
2934 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
2935 (setq result (gnus-expand-group-parameter (car head)
2937 ;; Exit the loop early.
2942 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2943 "Return the group parameters for GROUP.
2944 If SYMBOL, return the value of that symbol in the group parameters.
2946 If you call this function inside a loop, consider using the faster
2947 `gnus-group-fast-parameter' instead."
2949 (set-buffer gnus-group-buffer)
2951 (gnus-group-fast-parameter group symbol allow-list)
2954 (funcall gnus-group-get-parameter-function group))
2955 (gnus-parameters-get-parameter group)))))
2957 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2958 "Return the group parameters for GROUP.
2959 If SYMBOL, return the value of that symbol in the group parameters.
2960 Most functions should use `gnus-group-find-parameter', which
2961 also examines the topic parameters."
2962 (let ((params (gnus-info-params (gnus-get-info group))))
2964 (gnus-group-parameter-value params symbol allow-list)
2967 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2968 "Return the value of SYMBOL in group PARAMS."
2969 ;; We only wish to return group parameters (dotted lists) and
2970 ;; not local variables, which may have the same names.
2971 ;; But first we handle single elements...
2972 (or (car (memq symbol params))
2976 (while (setq elem (pop params))
2977 (when (and (consp elem)
2978 (eq (car elem) symbol)
2981 (throw 'found (cdr elem))))))))
2983 (defun gnus-group-add-parameter (group param)
2984 "Add parameter PARAM to GROUP."
2985 (let ((info (gnus-get-info group)))
2987 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2988 ;; Cons the new param to the old one and update.
2989 (gnus-group-set-info (cons param (gnus-info-params info))
2992 (defun gnus-group-set-parameter (group name value)
2993 "Set parameter NAME to VALUE in GROUP."
2994 (let ((info (gnus-get-info group)))
2996 (gnus-group-remove-parameter group name)
2997 (let ((old-params (gnus-info-params info))
2998 (new-params (list (cons name value))))
3000 (when (or (not (listp (car old-params)))
3001 (not (eq (caar old-params) name)))
3002 (setq new-params (append new-params (list (car old-params)))))
3003 (setq old-params (cdr old-params)))
3004 (gnus-group-set-info new-params group 'params)))))
3006 (defun gnus-group-remove-parameter (group name)
3007 "Remove parameter NAME from GROUP."
3008 (let ((info (gnus-get-info group)))
3010 (let ((params (gnus-info-params info)))
3012 (setq params (delq name params))
3013 (while (assq name params)
3014 (gnus-pull name params))
3015 (gnus-info-set-params info params))))))
3017 (defun gnus-group-add-score (group &optional score)
3018 "Add SCORE to the GROUP score.
3019 If SCORE is nil, add 1 to the score of GROUP."
3020 (let ((info (gnus-get-info group)))
3022 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3024 (defun gnus-short-group-name (group &optional levels)
3025 "Collapse GROUP name LEVELS.
3026 Select methods are stripped and any remote host name is stripped down to
3027 just the host name."
3033 gnus-group-uncollapsed-levels
3035 (while (string-match "\\." group skip)
3036 (setq skip (match-end 0)
3039 ;; Separate foreign select method from group name and collapse.
3040 ;; If method contains a server, collapse to non-domain server name,
3041 ;; otherwise collapse to select method.
3042 (let* ((colon (string-match ":" group))
3043 (server (and colon (substring group 0 colon)))
3044 (plus (and server (string-match "+" server))))
3047 (setq foreign (substring server (+ 1 plus)
3048 (string-match "\\." server))
3049 group (substring group (+ 1 colon)))
3050 (setq foreign server
3051 group (substring group (+ 1 colon))))
3052 (setq foreign (concat foreign ":")))
3053 ;; Collapse group name leaving LEVELS uncollapsed elements
3054 (let* ((slist (split-string group "/"))
3055 (slen (length slist))
3056 (dlist (split-string group "\\."))
3057 (dlen (length dlist))
3069 (setq levels (- glen levels))
3071 (push (if (>= (decf levels) 0)
3072 (if (zerop (length g))
3077 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3079 (defun gnus-narrow-to-body ()
3080 "Narrow to the body of an article."
3083 (goto-char (point-min))
3084 (or (search-forward "\n\n" nil t)
3090 ;;; Kill file handling.
3093 (defun gnus-apply-kill-file ()
3094 "Apply a kill file to the current newsgroup.
3095 Returns the number of articles marked as read."
3096 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3097 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3098 (gnus-apply-kill-file-internal)
3101 (defun gnus-kill-save-kill-buffer ()
3102 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3103 (when (get-file-buffer file)
3105 (set-buffer (get-file-buffer file))
3106 (when (buffer-modified-p)
3108 (kill-buffer (current-buffer))))))
3110 (defcustom gnus-kill-file-name "KILL"
3111 "Suffix of the kill files."
3112 :group 'gnus-score-kill
3113 :group 'gnus-score-files
3116 (defun gnus-newsgroup-kill-file (newsgroup)
3117 "Return the name of a kill file name for NEWSGROUP.
3118 If NEWSGROUP is nil, return the global kill file name instead."
3120 ;; The global KILL file is placed at top of the directory.
3121 ((or (null newsgroup)
3122 (string-equal newsgroup ""))
3123 (expand-file-name gnus-kill-file-name
3124 gnus-kill-files-directory))
3125 ;; Append ".KILL" to newsgroup name.
3126 ((gnus-use-long-file-name 'not-kill)
3127 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3128 "." gnus-kill-file-name)
3129 gnus-kill-files-directory))
3130 ;; Place "KILL" under the hierarchical directory.
3132 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3133 "/" gnus-kill-file-name)
3134 gnus-kill-files-directory))))
3138 (defun gnus-member-of-valid (symbol group)
3139 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3141 (symbol-name (car (gnus-find-method-for-group group)))
3142 gnus-valid-select-methods)))
3144 (defun gnus-method-option-p (method option)
3145 "Return non-nil if select METHOD has OPTION as a parameter."
3146 (when (stringp method)
3147 (setq method (gnus-server-to-method method)))
3148 (memq option (assoc (format "%s" (car method))
3149 gnus-valid-select-methods)))
3151 (defun gnus-similar-server-opened (method)
3152 (let ((opened gnus-opened-servers))
3153 (while (and method opened)
3154 (when (and (equal (cadr method) (cadaar opened))
3155 (equal (car method) (caaar opened))
3156 (not (equal method (caar opened))))
3161 (defun gnus-server-extend-method (group method)
3162 ;; This function "extends" a virtual server. If the server is
3163 ;; "hello", and the select method is ("hello" (my-var "something"))
3164 ;; in the group "alt.alt", this will result in a new virtual server
3165 ;; called "hello+alt.alt".
3166 (if (or (not (inline (gnus-similar-server-opened method)))
3167 (not (cddr method)))
3169 `(,(car method) ,(concat (cadr method) "+" group)
3170 (,(intern (format "%s-address" (car method))) ,(cadr method))
3173 (defun gnus-server-status (method)
3174 "Return the status of METHOD."
3175 (nth 1 (assoc method gnus-opened-servers)))
3177 (defun gnus-group-name-to-method (group)
3178 "Guess a select method based on GROUP."
3179 (if (string-match ":" group)
3180 (let ((server (substring group 0 (match-beginning 0))))
3181 (if (string-match "\\+" server)
3182 (list (intern (substring server 0 (match-beginning 0)))
3183 (substring server (match-end 0)))
3184 (list (intern server) "")))
3185 gnus-select-method))
3187 (defun gnus-server-string (server)
3188 "Return a readable string that describes SERVER."
3189 (let* ((server (gnus-server-to-method server))
3190 (address (nth 1 server)))
3192 (not (zerop (length address))))
3193 (format "%s via %s" address (car server))
3194 (format "%s" (car server)))))
3196 (defun gnus-find-method-for-group (group &optional info)
3197 "Find the select method that GROUP uses."
3198 (or gnus-override-method
3201 (and (not (gnus-group-entry group)) ;; a new group
3202 (gnus-group-name-to-method group))
3203 (let ((info (or info (gnus-get-info group)))
3206 (not (setq method (gnus-info-method info)))
3207 (equal method "native"))
3210 (cond ((stringp method)
3211 (inline (gnus-server-to-method method)))
3212 ((stringp (cadr method))
3213 (inline (gnus-server-extend-method group method)))
3216 (cond ((equal (cadr method) "")
3218 ((null (cadr method))
3219 (list (car method) ""))
3221 (gnus-server-add-address method)))))))
3223 (defun gnus-methods-using (feature)
3224 "Find all methods that have FEATURE."
3225 (let ((valids gnus-valid-select-methods)
3228 (when (memq feature (car valids))
3229 (push (car valids) outs))
3230 (setq valids (cdr valids)))
3233 (defun gnus-read-group (prompt &optional default)
3234 "Prompt the user for a group name.
3235 Disallow invalid group names."
3240 gnus-invalid-group-regexp
3241 (setq group (read-string (concat prefix prompt)
3242 (cons (or default "") 0)
3243 'gnus-group-history)))
3244 (setq prefix (format "Invalid group name: \"%s\". " group)
3248 (defun gnus-read-method (prompt)
3249 "Prompt the user for a method.
3250 Allow completion over sensible values."
3251 (let* ((open-servers
3252 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3253 gnus-opened-servers))
3256 (dolist (method gnus-valid-select-methods)
3257 (if (or (memq 'prompt-address method)
3258 (not (assoc (format "%s:" (car method)) open-servers)))
3259 (push method methods)))
3262 (append valid-methods
3264 gnus-predefined-server-alist
3269 nil t nil 'gnus-method-history)))
3272 (setq method gnus-select-method))
3273 ((assoc method gnus-valid-select-methods)
3274 (let ((address (if (memq 'prompt-address
3275 (assoc method gnus-valid-select-methods))
3276 (read-string "Address: ")
3278 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3279 (list (intern method) address))))
3280 ((assoc method servers)
3283 (list (intern method) "")))))
3287 (defun gnus-agent-method-p (method)
3288 "Say whether METHOD is covered by the agent."
3289 (member method gnus-agent-covered-methods))
3291 (defun gnus-online (method)
3294 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3295 (gnus-agent-method-p method))))
3297 ;;; User-level commands.
3300 (defun gnus-slave-no-server (&optional arg)
3301 "Read network news as a slave, without connecting to the local server."
3303 (gnus-no-server arg t))
3306 (defun gnus-no-server (&optional arg slave)
3308 If ARG is a positive number, Gnus will use that as the startup
3309 level. If ARG is nil, Gnus will be started at level 2. If ARG is
3310 non-nil and not a positive number, Gnus will prompt the user for the
3311 name of an NNTP server to use.
3312 As opposed to `gnus', this command will not connect to the local
3315 (gnus-no-server-1 arg slave))
3318 (defun gnus-slave (&optional arg)
3319 "Read news as a slave."
3321 (gnus arg nil 'slave))
3324 (defun gnus-other-frame (&optional arg)
3325 "Pop up a frame to read news."
3327 (let ((window (get-buffer-window gnus-group-buffer)))
3329 (select-frame (window-frame window)))
3331 (select-frame (make-frame)))))
3334 ;;(setq thing ? ; this is a comment
3338 (defun gnus (&optional arg dont-connect slave)
3340 If ARG is non-nil and a positive number, Gnus will use that as the
3341 startup level. If ARG is non-nil and not a positive number, Gnus will
3342 prompt the user for the name of an NNTP server to use."
3344 (unless (byte-code-function-p (symbol-function 'gnus))
3345 (message "You should byte-compile Gnus")
3347 (gnus-1 arg dont-connect slave))
3349 ;; Allow redefinition of Gnus functions.
3355 ;;; gnus.el ends here