1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
3 ;; 1997, 1998, 2000 Free Software Foundation, Inc.
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news, mail
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
30 (eval '(run-hooks 'gnus-load-hook))
32 (eval-when-compile (require 'cl))
36 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
40 (defgroup gnus-charset nil
41 "Group character set issues."
42 :link '(custom-manual "(gnus)Charsets")
46 (defgroup gnus-cache nil
50 (defgroup gnus-start nil
51 "Starting your favorite newsreader."
54 (defgroup gnus-start-server nil
55 "Server options at startup."
58 ;; These belong to gnus-group.el.
59 (defgroup gnus-group nil
61 :link '(custom-manual "(gnus)The Group Buffer")
64 (defgroup gnus-group-foreign nil
66 :link '(custom-manual "(gnus)Foreign Groups")
69 (defgroup gnus-group-new nil
70 "Automatic subscription of new groups."
73 (defgroup gnus-group-levels nil
75 :link '(custom-manual "(gnus)Group Levels")
78 (defgroup gnus-group-select nil
80 :link '(custom-manual "(gnus)Selecting a Group")
83 (defgroup gnus-group-listing nil
84 "Showing slices of the group list."
85 :link '(custom-manual "(gnus)Listing Groups")
88 (defgroup gnus-group-visual nil
89 "Sorting the group buffer."
90 :link '(custom-manual "(gnus)Group Buffer Format")
94 (defgroup gnus-group-various nil
95 "Various group options."
96 :link '(custom-manual "(gnus)Scanning New Messages")
99 ;; These belong to gnus-sum.el.
100 (defgroup gnus-summary nil
102 :link '(custom-manual "(gnus)The Summary Buffer")
105 (defgroup gnus-summary-exit nil
106 "Leaving summary buffers."
107 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
108 :group 'gnus-summary)
110 (defgroup gnus-summary-marks nil
111 "Marks used in summary buffers."
112 :link '(custom-manual "(gnus)Marking Articles")
113 :group 'gnus-summary)
115 (defgroup gnus-thread nil
116 "Ordering articles according to replies."
117 :link '(custom-manual "(gnus)Threading")
118 :group 'gnus-summary)
120 (defgroup gnus-summary-format nil
121 "Formatting of the summary buffer."
122 :link '(custom-manual "(gnus)Summary Buffer Format")
123 :group 'gnus-summary)
125 (defgroup gnus-summary-choose nil
127 :link '(custom-manual "(gnus)Choosing Articles")
128 :group 'gnus-summary)
130 (defgroup gnus-summary-maneuvering nil
131 "Summary movement commands."
132 :link '(custom-manual "(gnus)Summary Maneuvering")
133 :group 'gnus-summary)
135 (defgroup gnus-summary-mail nil
136 "Mail group commands."
137 :link '(custom-manual "(gnus)Mail Group Commands")
138 :group 'gnus-summary)
140 (defgroup gnus-summary-sort nil
141 "Sorting the summary buffer."
142 :link '(custom-manual "(gnus)Sorting")
143 :group 'gnus-summary)
145 (defgroup gnus-summary-visual nil
146 "Highlighting and menus in the summary buffer."
147 :link '(custom-manual "(gnus)Summary Highlighting")
149 :group 'gnus-summary)
151 (defgroup gnus-summary-various nil
152 "Various summary buffer options."
153 :link '(custom-manual "(gnus)Various Summary Stuff")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-pick nil
157 "Pick mode in the summary buffer."
158 :link '(custom-manual "(gnus)Pick and Read")
160 :group 'gnus-summary)
162 (defgroup gnus-summary-tree nil
163 "Tree display of threads in the summary buffer."
164 :link '(custom-manual "(gnus)Tree Display")
166 :group 'gnus-summary)
168 ;; Belongs to gnus-uu.el
169 (defgroup gnus-extract-view nil
170 "Viewing extracted files."
171 :link '(custom-manual "(gnus)Viewing Files")
172 :group 'gnus-extract)
174 ;; Belongs to gnus-score.el
175 (defgroup gnus-score nil
176 "Score and kill file handling."
179 (defgroup gnus-score-kill nil
183 (defgroup gnus-score-adapt nil
184 "Adaptive score files."
187 (defgroup gnus-score-default nil
188 "Default values for score files."
191 (defgroup gnus-score-expire nil
192 "Expiring score rules."
195 (defgroup gnus-score-decay nil
196 "Decaying score rules."
199 (defgroup gnus-score-files nil
200 "Score and kill file names."
204 (defgroup gnus-score-various nil
205 "Various scoring and killing options."
209 (defgroup gnus-visual nil
210 "Options controling the visual fluff."
214 (defgroup gnus-agent nil
215 "Offline support for Gnus."
218 (defgroup gnus-files nil
219 "Files used by Gnus."
222 (defgroup gnus-dribble-file nil
224 :link '(custom-manual "(gnus)Auto Save")
227 (defgroup gnus-newsrc nil
228 "Storing Gnus state."
231 (defgroup gnus-server nil
232 "Options related to newsservers and other servers used by Gnus."
235 (defgroup gnus-message '((message custom-group))
236 "Composing replies and followups in Gnus."
239 (defgroup gnus-meta nil
240 "Meta variables controling major portions of Gnus.
241 In general, modifying these variables does not take affect until Gnus
242 is restarted, and sometimes reloaded."
245 (defgroup gnus-various nil
246 "Other Gnus options."
247 :link '(custom-manual "(gnus)Various Various")
250 (defgroup gnus-mime nil
251 "Variables for controlling the Gnus MIME interface."
254 (defgroup gnus-exit nil
256 :link '(custom-manual "(gnus)Exiting Gnus")
259 (defconst gnus-version-number "0.01"
260 "Version number for this version of Gnus.")
262 (defconst gnus-version (format "Oort Gnus v%s" gnus-version-number)
263 "Version string for this version of Gnus.")
265 (defcustom gnus-inhibit-startup-message nil
266 "If non-nil, the startup message will not be displayed.
267 This variable is used before `.gnus.el' is loaded, so it should
268 be set in `.emacs' instead."
272 (defcustom gnus-play-startup-jingle nil
273 "If non-nil, play the Gnus jingle at startup."
277 (unless (fboundp 'gnus-group-remove-excess-properties)
278 (defalias 'gnus-group-remove-excess-properties 'ignore))
280 (unless (featurep 'gnus-xmas)
281 (defalias 'gnus-make-overlay 'make-overlay)
282 (defalias 'gnus-delete-overlay 'delete-overlay)
283 (defalias 'gnus-overlay-put 'overlay-put)
284 (defalias 'gnus-move-overlay 'move-overlay)
285 (defalias 'gnus-overlay-buffer 'overlay-buffer)
286 (defalias 'gnus-overlay-start 'overlay-start)
287 (defalias 'gnus-overlay-end 'overlay-end)
288 (defalias 'gnus-extent-detached-p 'ignore)
289 (defalias 'gnus-extent-start-open 'ignore)
290 (defalias 'gnus-set-text-properties 'set-text-properties)
291 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
292 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
293 (defalias 'gnus-character-to-event 'identity)
294 (defalias 'gnus-add-text-properties 'add-text-properties)
295 (defalias 'gnus-put-text-property 'put-text-property)
296 (defvar gnus-mode-line-image-cache t)
297 (if (fboundp 'find-image)
298 (defun gnus-mode-line-buffer-identification (line)
299 (let ((str (car-safe line)))
300 (if (and (stringp str)
301 (string-match "^Gnus:" str))
302 (progn (add-text-properties
305 (if (eq t gnus-mode-line-image-cache)
306 (setq gnus-mode-line-image-cache
308 '((:type xpm :file "gnus-pointer.xpm"
310 (:type xbm :file "gnus-pointer.xbm"
312 gnus-mode-line-image-cache)
313 'help-echo "This is Gnus")
317 (defalias 'gnus-mode-line-buffer-identification 'identity))
318 (defalias 'gnus-characterp 'numberp)
319 (defalias 'gnus-deactivate-mark 'deactivate-mark)
320 (defalias 'gnus-window-edges 'window-edges)
321 (defalias 'gnus-key-press-event-p 'numberp)
322 (defalias 'gnus-decode-rfc1522 'ignore))
324 ;; We define these group faces here to avoid the display
325 ;; update forced when creating new faces.
327 (defface gnus-group-news-1-face
330 (:foreground "PaleTurquoise" :bold t))
333 (:foreground "ForestGreen" :bold t))
336 "Level 1 newsgroup face.")
338 (defface gnus-group-news-1-empty-face
341 (:foreground "PaleTurquoise"))
344 (:foreground "ForestGreen"))
347 "Level 1 empty newsgroup face.")
349 (defface gnus-group-news-2-face
352 (:foreground "turquoise" :bold t))
355 (:foreground "CadetBlue4" :bold t))
358 "Level 2 newsgroup face.")
360 (defface gnus-group-news-2-empty-face
363 (:foreground "turquoise"))
366 (:foreground "CadetBlue4"))
369 "Level 2 empty newsgroup face.")
371 (defface gnus-group-news-3-face
380 "Level 3 newsgroup face.")
382 (defface gnus-group-news-3-empty-face
391 "Level 3 empty newsgroup face.")
393 (defface gnus-group-news-4-face
402 "Level 4 newsgroup face.")
404 (defface gnus-group-news-4-empty-face
413 "Level 4 empty newsgroup face.")
415 (defface gnus-group-news-5-face
424 "Level 5 newsgroup face.")
426 (defface gnus-group-news-5-empty-face
435 "Level 5 empty newsgroup face.")
437 (defface gnus-group-news-6-face
446 "Level 6 newsgroup face.")
448 (defface gnus-group-news-6-empty-face
457 "Level 6 empty newsgroup face.")
459 (defface gnus-group-news-low-face
462 (:foreground "DarkTurquoise" :bold t))
465 (:foreground "DarkGreen" :bold t))
468 "Low level newsgroup face.")
470 (defface gnus-group-news-low-empty-face
473 (:foreground "DarkTurquoise"))
476 (:foreground "DarkGreen"))
479 "Low level empty newsgroup face.")
481 (defface gnus-group-mail-1-face
484 (:foreground "aquamarine1" :bold t))
487 (:foreground "DeepPink3" :bold t))
490 "Level 1 mailgroup face.")
492 (defface gnus-group-mail-1-empty-face
495 (:foreground "aquamarine1"))
498 (:foreground "DeepPink3"))
500 (:italic t :bold t)))
501 "Level 1 empty mailgroup face.")
503 (defface gnus-group-mail-2-face
506 (:foreground "aquamarine2" :bold t))
509 (:foreground "HotPink3" :bold t))
512 "Level 2 mailgroup face.")
514 (defface gnus-group-mail-2-empty-face
517 (:foreground "aquamarine2"))
520 (:foreground "HotPink3"))
523 "Level 2 empty mailgroup face.")
525 (defface gnus-group-mail-3-face
528 (:foreground "aquamarine3" :bold t))
531 (:foreground "magenta4" :bold t))
534 "Level 3 mailgroup face.")
536 (defface gnus-group-mail-3-empty-face
539 (:foreground "aquamarine3"))
542 (:foreground "magenta4"))
545 "Level 3 empty mailgroup face.")
547 (defface gnus-group-mail-low-face
550 (:foreground "aquamarine4" :bold t))
553 (:foreground "DeepPink4" :bold t))
556 "Low level mailgroup face.")
558 (defface gnus-group-mail-low-empty-face
561 (:foreground "aquamarine4"))
564 (:foreground "DeepPink4"))
567 "Low level empty mailgroup face.")
569 ;; Summary mode faces.
571 (defface gnus-summary-selected-face '((t
573 "Face used for selected articles.")
575 (defface gnus-summary-cancelled-face
577 (:foreground "yellow" :background "black")))
578 "Face used for cancelled articles.")
580 (defface gnus-summary-high-ticked-face
583 (:foreground "pink" :bold t))
586 (:foreground "firebrick" :bold t))
589 "Face used for high interest ticked articles.")
591 (defface gnus-summary-low-ticked-face
594 (:foreground "pink" :italic t))
597 (:foreground "firebrick" :italic t))
600 "Face used for low interest ticked articles.")
602 (defface gnus-summary-normal-ticked-face
605 (:foreground "pink"))
608 (:foreground "firebrick"))
611 "Face used for normal interest ticked articles.")
613 (defface gnus-summary-high-ancient-face
616 (:foreground "SkyBlue" :bold t))
619 (:foreground "RoyalBlue" :bold t))
622 "Face used for high interest ancient articles.")
624 (defface gnus-summary-low-ancient-face
627 (:foreground "SkyBlue" :italic t))
630 (:foreground "RoyalBlue" :italic t))
633 "Face used for low interest ancient articles.")
635 (defface gnus-summary-normal-ancient-face
638 (:foreground "SkyBlue"))
641 (:foreground "RoyalBlue"))
644 "Face used for normal interest ancient articles.")
646 (defface gnus-summary-high-unread-face
649 "Face used for high interest unread articles.")
651 (defface gnus-summary-low-unread-face
654 "Face used for low interest unread articles.")
656 (defface gnus-summary-normal-unread-face
659 "Face used for normal interest unread articles.")
661 (defface gnus-summary-high-read-face
664 (:foreground "PaleGreen"
668 (:foreground "DarkGreen"
672 "Face used for high interest read articles.")
674 (defface gnus-summary-low-read-face
677 (:foreground "PaleGreen"
681 (:foreground "DarkGreen"
685 "Face used for low interest read articles.")
687 (defface gnus-summary-normal-read-face
690 (:foreground "PaleGreen"))
693 (:foreground "DarkGreen"))
696 "Face used for normal interest read articles.")
703 (defvar gnus-buffers nil)
705 (defun gnus-get-buffer-create (name)
706 "Do the same as `get-buffer-create', but store the created buffer."
707 (or (get-buffer name)
708 (car (push (get-buffer-create name) gnus-buffers))))
710 (defun gnus-add-buffer ()
711 "Add the current buffer to the list of Gnus buffers."
712 (push (current-buffer) gnus-buffers))
714 (defun gnus-buffers ()
715 "Return a list of live Gnus buffers."
716 (while (and gnus-buffers
717 (not (buffer-name (car gnus-buffers))))
719 (let ((buffers gnus-buffers))
721 (if (buffer-name (cadr buffers))
723 (setcdr buffers (cddr buffers)))))
728 (defvar gnus-group-buffer "*Group*")
731 (autoload 'gnus-play-jingle "gnus-audio"))
733 (defface gnus-splash-face
736 (:foreground "Brown"))
739 (:foreground "Brown"))
742 "Face of the splash screen.")
744 (defun gnus-splash ()
746 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
747 (let ((buffer-read-only nil))
749 (unless gnus-inhibit-startup-message
750 (gnus-group-startup-message)
752 (when gnus-play-startup-jingle
753 (gnus-play-jingle))))))
755 (defun gnus-indent-rigidly (start end arg)
756 "Indent rigidly using only spaces and no tabs."
759 (narrow-to-region start end)
761 (indent-rigidly start end arg)
762 ;; We translate tabs into spaces -- not everybody uses
763 ;; an 8-character tab.
764 (goto-char (point-min))
765 (while (search-forward "\t" nil t)
766 (replace-match " " t t))))))
768 (defvar gnus-simple-splash nil)
770 (defun gnus-group-startup-message (&optional x y)
771 "Insert startup message in current buffer."
772 ;; Insert the message.
776 (fboundp 'find-image)
778 (let ((image (find-image
779 `((:type xpm :file "gnus.xpm")
780 (:type pbm :file "gnus.pbm"
781 ;; Account for the pbm's blackground.
782 :background ,(face-foreground 'gnus-splash-face)
783 :foreground ,(face-background 'default))
784 (:type xbm :file "gnus.xbm"
785 ;; Account for the xbm's blackground.
786 :background ,(face-foreground 'gnus-splash-face)
787 :foreground ,(face-background 'default))))))
789 (let ((size (image-size image)))
790 (insert-char ?\n (max 0 (round (- (window-height)
791 (or y (cdr size)) 1) 2)))
792 (insert-char ?\ (max 0 (round (- (window-width)
793 (or x (car size))) 2)))
794 (insert-image image))
795 (setq gnus-simple-splash nil)
801 _ ___ __ ___ __ _ ___
821 (gnus-indent-rigidly (point-min) (point-max)
822 (/ (max (- (window-width) (or x 46)) 0) 2))
823 (goto-char (point-min))
825 (let* ((pheight (count-lines (point-min) (point-max)))
826 (wheight (window-height))
827 (rest (- wheight pheight)))
828 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
830 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
831 (setq gnus-simple-splash t)))
832 (goto-char (point-min))
833 (setq mode-line-buffer-identification (concat " " gnus-version))
834 (set-buffer-modified-p t))
837 (let ((command (format "%s" this-command)))
838 (if (and (string-match "gnus" command)
839 (not (string-match "gnus-other-frame" command)))
841 (gnus-get-buffer-create gnus-group-buffer))))
848 (defcustom gnus-home-directory "~/"
849 "Directory variable that specifies the \"home\" directory.
850 All other Gnus path variables are initialized from this variable."
854 (defcustom gnus-directory (or (getenv "SAVEDIR")
855 (nnheader-concat gnus-home-directory "News/"))
856 "*Directory variable from which all other Gnus file variables are derived.
858 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
859 This means that other directory variables that are initialized from
860 this variable won't be set properly if you set this variable in `.gnus.el'.
861 Set this variable in `.emacs' instead."
865 (defcustom gnus-default-directory nil
866 "*Default directory for all Gnus buffers."
868 :type '(choice (const :tag "current" nil)
871 ;; Site dependent variables. These variables should be defined in
874 (defvar gnus-default-nntp-server nil
875 "Specify a default NNTP server.
876 This variable should be defined in paths.el, and should never be set
878 If you want to change servers, you should use `gnus-select-method'.
879 See the documentation to that variable.")
881 ;; Don't touch this variable.
882 (defvar gnus-nntp-service "nntp"
883 "NNTP service name (\"nntp\" or 119).
884 This is an obsolete variable, which is scarcely used. If you use an
885 nntp server for your newsgroup and want to change the port number
886 used to 899, you would say something along these lines:
888 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
890 (defcustom gnus-nntpserver-file "/etc/nntpserver"
891 "A file with only the name of the nntp server in it."
896 ;; This function is used to check both the environment variable
897 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
898 ;; an nntp server name default.
899 (defun gnus-getenv-nntpserver ()
900 (or (getenv "NNTPSERVER")
901 (and (file-readable-p gnus-nntpserver-file)
903 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
904 (insert-file-contents gnus-nntpserver-file)
905 (let ((name (buffer-string)))
907 (if (string-match "\\'[ \t\n]*$" name)
910 (kill-buffer (current-buffer))))))))
912 (defcustom gnus-select-method
915 (list 'nntp (or (condition-case nil
916 (gnus-getenv-nntpserver)
918 (when (and gnus-default-nntp-server
919 (not (string= gnus-default-nntp-server "")))
920 gnus-default-nntp-server)
922 (if (or (null gnus-nntp-service)
923 (equal gnus-nntp-service "nntp"))
925 (list gnus-nntp-service)))
927 "Default method for selecting a newsgroup.
928 This variable should be a list, where the first element is how the
929 news is to be fetched, the second is the address.
931 For instance, if you want to get your news via NNTP from
932 \"flab.flab.edu\", you could say:
934 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
936 If you want to use your local spool, say:
938 \(setq gnus-select-method (list 'nnspool (system-name)))
940 If you use this variable, you must set `gnus-nntp-server' to nil.
942 There is a lot more to know about select methods and virtual servers -
943 see the manual for details."
945 :type 'gnus-select-method)
947 (defcustom gnus-message-archive-method
949 ;; Don't require it at top level to avoid circularity.
953 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
954 (nnfolder-active-file
955 ,(nnheader-concat message-directory "archive/active"))
956 (nnfolder-get-new-mail nil)
957 (nnfolder-inhibit-expiry t)))
958 "*Method used for archiving messages you've sent.
959 This should be a mail method.
961 It's probably not very effective to change this variable once you've
962 run Gnus once. After doing that, you must edit this server from the
966 :type 'gnus-select-method)
968 (defcustom gnus-message-archive-group nil
969 "*Name of the group in which to save the messages you've written.
970 This can either be a string; a list of strings; or an alist
971 of regexps/functions/forms to be evaluated to return a string (or a list
972 of strings). The functions are called with the name of the current
973 group (or nil) as a parameter.
975 If you want to save your mail in one group and the news articles you
976 write in another group, you could say something like:
978 \(setq gnus-message-archive-group
979 '((if (message-news-p)
983 Normally the group names returned by this variable should be
984 unprefixed -- which implicitly means \"store on the archive server\".
985 However, you may wish to store the message on some other server. In
986 that case, just return a fully prefixed name of the group --
987 \"nnml+private:mail.misc\", for instance."
989 :type '(choice (const :tag "none" nil)
994 (defcustom gnus-secondary-servers nil
995 "List of NNTP servers that the user can choose between interactively.
996 To make Gnus query you for a server, you have to give `gnus' a
997 non-numeric prefix - `C-u M-x gnus', in short."
999 :type '(repeat string))
1001 (defcustom gnus-nntp-server nil
1002 "*The name of the host running the NNTP server.
1003 This variable is semi-obsolete. Use the `gnus-select-method'
1006 :type '(choice (const :tag "disable" nil)
1009 (defcustom gnus-secondary-select-methods nil
1010 "A list of secondary methods that will be used for reading news.
1011 This is a list where each element is a complete select method (see
1012 `gnus-select-method').
1014 If, for instance, you want to read your mail with the nnml backend,
1015 you could set this variable:
1017 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1019 :type '(repeat gnus-select-method))
1021 (defvar gnus-backup-default-subscribed-newsgroups
1022 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1023 "Default default new newsgroups the first time Gnus is run.
1024 Should be set in paths.el, and shouldn't be touched by the user.")
1026 (defcustom gnus-local-domain nil
1027 "Local domain name without a host name.
1028 The DOMAINNAME environment variable is used instead if it is defined.
1029 If the `system-name' function returns the full Internet name, there is
1030 no need to set this variable."
1031 :group 'gnus-message
1032 :type '(choice (const :tag "default" nil)
1035 (defvar gnus-local-organization nil
1036 "String with a description of what organization (if any) the user belongs to.
1037 Obsolete variable; use `message-user-organization' instead.")
1039 ;; Customization variables
1041 (defcustom gnus-refer-article-method nil
1042 "Preferred method for fetching an article by Message-ID.
1043 If you are reading news from the local spool (with nnspool), fetching
1044 articles by Message-ID is painfully slow. By setting this method to an
1045 nntp method, you might get acceptable results.
1047 The value of this variable must be a valid select method as discussed
1048 in the documentation of `gnus-select-method'.
1050 It can also be a list of select methods, as well as the special symbol
1051 `current', which means to use the current select method. If it is a
1052 list, Gnus will try all the methods in the list until it finds a match."
1054 :type '(choice (const :tag "default" nil)
1055 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1057 (repeat :menu-tag "Try multiple"
1059 :value (current (nnweb "refer" (nnweb-type dejanews)))
1060 (choice :tag "Method"
1062 (const :tag "DejaNews"
1063 (nnweb "refer" (nnweb-type dejanews)))
1064 gnus-select-method))))
1066 (defcustom gnus-group-faq-directory
1067 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1068 "/ftp@sunsite.auc.dk:/pub/usenet/"
1069 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1070 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1071 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1072 "/ftp@rtfm.mit.edu:/pub/usenet/"
1073 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1074 "/ftp@ftp.sunet.se:/pub/usenet/"
1075 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1076 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1077 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1078 "*Directory where the group FAQs are stored.
1079 This will most commonly be on a remote machine, and the file will be
1080 fetched by ange-ftp.
1082 This variable can also be a list of directories. In that case, the
1083 first element in the list will be used by default. The others can
1084 be used when being prompted for a site.
1086 Note that Gnus uses an aol machine as the default directory. If this
1087 feels fundamentally unclean, just think of it as a way to finally get
1088 something of value back from them.
1090 If the default site is too slow, try one of these:
1092 North America: mirrors.aol.com /pub/rtfm/usenet
1093 ftp.seas.gwu.edu /pub/rtfm
1094 rtfm.mit.edu /pub/usenet
1095 Europe: ftp.uni-paderborn.de /pub/FAQ
1096 src.doc.ic.ac.uk /usenet/news-FAQS
1097 ftp.sunet.se /pub/usenet
1098 sunsite.auc.dk /pub/usenet
1099 Asia: nctuccca.edu.tw /USENET/FAQ
1100 hwarang.postech.ac.kr /pub/usenet
1101 ftp.hk.super.net /mirror/faqs"
1102 :group 'gnus-group-various
1103 :type '(choice directory
1104 (repeat directory)))
1106 (defcustom gnus-use-cross-reference t
1107 "*Non-nil means that cross referenced articles will be marked as read.
1108 If nil, ignore cross references. If t, mark articles as read in
1109 subscribed newsgroups. If neither t nor nil, mark as read in all
1112 :type '(choice (const :tag "off" nil)
1113 (const :tag "subscribed" t)
1117 (defcustom gnus-process-mark ?#
1119 :group 'gnus-group-visual
1120 :group 'gnus-summary-marks
1123 (defcustom gnus-large-newsgroup 200
1124 "*The number of articles which indicates a large newsgroup.
1125 If the number of articles in a newsgroup is greater than this value,
1126 confirmation is required for selecting the newsgroup."
1127 :group 'gnus-group-select
1130 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1131 "*Non-nil means that the default name of a file to save articles in is the group name.
1132 If it's nil, the directory form of the group name is used instead.
1134 If this variable is a list, and the list contains the element
1135 `not-score', long file names will not be used for score files; if it
1136 contains the element `not-save', long file names will not be used for
1137 saving; and if it contains the element `not-kill', long file names
1138 will not be used for kill files.
1140 Note that the default for this variable varies according to what system
1141 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1142 to nil while on all other systems it defaults to t."
1146 (defcustom gnus-kill-files-directory gnus-directory
1147 "*Name of the directory where kill files will be stored (default \"~/News\")."
1148 :group 'gnus-score-files
1149 :group 'gnus-score-kill
1152 (defcustom gnus-save-score nil
1153 "*If non-nil, save group scoring info."
1154 :group 'gnus-score-various
1158 (defcustom gnus-use-undo t
1159 "*If non-nil, allow undoing in Gnus group mode buffers."
1163 (defcustom gnus-use-adaptive-scoring nil
1164 "*If non-nil, use some adaptive scoring scheme.
1165 If a list, then the values `word' and `line' are meaningful. The
1166 former will perform adaption on individual words in the subject
1167 header while `line' will perform adaption on several headers."
1169 :group 'gnus-score-adapt
1170 :type '(set (const word) (const line)))
1172 (defcustom gnus-use-cache 'passive
1173 "*If nil, Gnus will ignore the article cache.
1174 If `passive', it will allow entering (and reading) articles
1175 explicitly entered into the cache. If anything else, use the
1176 cache to the full extent of the law."
1179 :type '(choice (const :tag "off" nil)
1180 (const :tag "passive" passive)
1181 (const :tag "active" t)))
1183 (defcustom gnus-use-trees nil
1184 "*If non-nil, display a thread tree buffer."
1188 (defcustom gnus-use-grouplens nil
1189 "*If non-nil, use GroupLens ratings."
1193 (defcustom gnus-keep-backlog nil
1194 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1195 If it is a number N, then Gnus will only keep the last N articles
1196 read. If it is neither nil nor a number, Gnus will keep all read
1197 articles. This is not a good idea."
1199 :type '(choice (const :tag "off" nil)
1204 (defcustom gnus-use-nocem nil
1205 "*If non-nil, Gnus will read NoCeM cancel messages."
1209 (defcustom gnus-suppress-duplicates nil
1210 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1214 (defcustom gnus-use-scoring t
1215 "*If non-nil, enable scoring."
1219 (defcustom gnus-use-picons nil
1220 "*If non-nil, display picons in a frame of their own."
1224 (defcustom gnus-summary-prepare-exit-hook
1225 '(gnus-summary-expire-articles)
1226 "*A hook called when preparing to exit from the summary buffer.
1227 It calls `gnus-summary-expire-articles' by default."
1228 :group 'gnus-summary-exit
1231 (defcustom gnus-novice-user t
1232 "*Non-nil means that you are a usenet novice.
1233 If non-nil, verbose messages may be displayed and confirmations may be
1238 (defcustom gnus-expert-user nil
1239 "*Non-nil means that you will never be asked for confirmation about anything.
1240 That doesn't mean *anything* anything; particularly destructive
1241 commands will still require prompting."
1245 (defcustom gnus-interactive-catchup t
1246 "*If non-nil, require your confirmation when catching up a group."
1247 :group 'gnus-group-select
1250 (defcustom gnus-interactive-exit t
1251 "*If non-nil, require your confirmation when exiting Gnus."
1255 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1256 "*Function for extracting address components from a From header.
1257 Two pre-defined function exist: `gnus-extract-address-components',
1258 which is the default, quite fast, and too simplistic solution, and
1259 `mail-extract-address-components', which works much better, but is
1261 :group 'gnus-summary-format
1262 :type '(radio (function-item gnus-extract-address-components)
1263 (function-item mail-extract-address-components)
1264 (function :tag "Other")))
1266 (defcustom gnus-carpal nil
1267 "*If non-nil, display clickable icons."
1271 (defcustom gnus-shell-command-separator ";"
1272 "String used to separate to shell commands."
1276 (defcustom gnus-valid-select-methods
1277 '(("nntp" post address prompt-address physical-address)
1278 ("nnspool" post address)
1279 ("nnvirtual" post-mail virtual prompt-address)
1280 ("nnmbox" mail respool address)
1281 ("nnml" mail respool address)
1282 ("nnmh" mail respool address)
1283 ("nndir" post-mail prompt-address physical-address)
1284 ("nneething" none address prompt-address physical-address)
1285 ("nndoc" none address prompt-address)
1286 ("nnbabyl" mail address respool)
1287 ("nnkiboze" post virtual)
1288 ("nnsoup" post-mail address)
1289 ("nndraft" post-mail)
1290 ("nnfolder" mail respool address)
1291 ("nngateway" post-mail address prompt-address physical-address)
1298 ("nnagent" post-mail)
1299 ("nnimap" post-mail address prompt-address physical-address))
1300 "*An alist of valid select methods.
1301 The first element of each list lists should be a string with the name
1302 of the select method. The other elements may be the category of
1303 this method (i. e., `post', `mail', `none' or whatever) or other
1304 properties that this method has (like being respoolable).
1305 If you implement a new select method, all you should have to change is
1306 this variable. I think."
1308 :type '(repeat (group (string :tag "Name")
1309 (radio-button-choice (const :format "%v " post)
1310 (const :format "%v " mail)
1311 (const :format "%v " none)
1313 (checklist :inline t
1314 (const :format "%v " address)
1315 (const :format "%v " prompt-address)
1316 (const :format "%v " physical-address)
1317 (const :format "%v " virtual)
1320 (defun gnus-redefine-select-method-widget ()
1321 "Recomputes the select-method widget based on the value of
1322 `gnus-valid-select-methods'."
1323 (define-widget 'gnus-select-method 'list
1324 "Widget for entering a select method."
1326 :tag "Select Method"
1327 :args `((choice :tag "Method"
1328 ,@(mapcar (lambda (entry)
1329 (list 'const :format "%v\n"
1330 (intern (car entry))))
1331 gnus-valid-select-methods)
1332 (symbol :tag "other"))
1333 (string :tag "Address")
1334 (repeat :tag "Options"
1338 (sexp :tag "Value"))))))
1340 (gnus-redefine-select-method-widget)
1342 (defcustom gnus-updated-mode-lines '(group article summary tree)
1343 "List of buffers that should update their mode lines.
1344 The list may contain the symbols `group', `article', `tree' and
1345 `summary'. If the corresponding symbol is present, Gnus will keep
1346 that mode line updated with information that may be pertinent.
1347 If this variable is nil, screen refresh may be quicker."
1348 :group 'gnus-various
1349 :type '(set (const group)
1354 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1355 (defcustom gnus-mode-non-string-length nil
1356 "*Max length of mode-line non-string contents.
1357 If this is nil, Gnus will take space as is needed, leaving the rest
1358 of the modeline intact. Note that the default of nil is unlikely
1359 to be desirable; see the manual for further details."
1360 :group 'gnus-various
1361 :type '(choice (const nil)
1364 (defcustom gnus-auto-expirable-newsgroups nil
1365 "*Groups in which to automatically mark read articles as expirable.
1366 If non-nil, this should be a regexp that should match all groups in
1367 which to perform auto-expiry. This only makes sense for mail groups."
1368 :group 'nnmail-expire
1369 :type '(choice (const nil)
1372 (defcustom gnus-total-expirable-newsgroups nil
1373 "*Groups in which to perform expiry of all read articles.
1374 Use with extreme caution. All groups that match this regexp will be
1375 expiring - which means that all read articles will be deleted after
1376 \(say) one week. (This only goes for mail groups and the like, of
1378 :group 'nnmail-expire
1379 :type '(choice (const nil)
1382 (defcustom gnus-group-uncollapsed-levels 1
1383 "Number of group name elements to leave alone when making a short group name."
1384 :group 'gnus-group-visual
1387 (defcustom gnus-group-use-permanent-levels nil
1388 "*If non-nil, once you set a level, Gnus will use this level."
1389 :group 'gnus-group-levels
1394 (defcustom gnus-load-hook nil
1395 "A hook run while Gnus is loaded."
1399 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1400 "A hook called to apply kill files to a group.
1401 This hook is intended to apply a kill file to the selected newsgroup.
1402 The function `gnus-apply-kill-file' is called by default.
1404 Since a general kill file is too heavy to use only for a few
1405 newsgroups, I recommend you to use a lighter hook function. For
1406 example, if you'd like to apply a kill file to articles which contains
1407 a string `rmgroup' in subject in newsgroup `control', you can use the
1410 (setq gnus-apply-kill-hook
1413 (cond ((string-match \"control\" gnus-newsgroup-name)
1414 (gnus-kill \"Subject\" \"rmgroup\")
1415 (gnus-expunge \"X\"))))))"
1416 :group 'gnus-score-kill
1417 :options '(gnus-apply-kill-file)
1420 (defcustom gnus-group-change-level-function nil
1421 "Function run when a group level is changed.
1422 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1423 :group 'gnus-group-levels
1428 (defcustom gnus-visual
1429 '(summary-highlight group-highlight article-highlight
1431 summary-menu group-menu article-menu
1432 tree-highlight menu highlight
1433 browse-menu server-menu
1434 page-marker tree-menu binary-menu pick-menu
1436 "*Enable visual features.
1437 If `visual' is disabled, there will be no menus and few faces. Most of
1438 the visual customization options below will be ignored. Gnus will use
1439 less space and be faster as a result.
1441 This variable can also be a list of visual elements to switch on. For
1442 instance, to switch off all visual things except menus, you can say:
1444 (setq gnus-visual '(menu))
1446 Valid elements include `summary-highlight', `group-highlight',
1447 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1448 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1449 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1450 and `grouplens-menu'."
1453 :type '(set (const summary-highlight)
1454 (const group-highlight)
1455 (const article-highlight)
1457 (const summary-menu)
1459 (const article-menu)
1460 (const tree-highlight)
1469 (const grouplens-menu)))
1471 (defcustom gnus-mouse-face
1473 (if (gnus-visual-p 'mouse-face 'highlight)
1474 (if (boundp 'gnus-mouse-face)
1475 (or gnus-mouse-face 'highlight)
1479 "*Face used for group or summary buffer mouse highlighting.
1480 The line beneath the mouse pointer will be highlighted with this
1485 (defcustom gnus-article-save-directory gnus-directory
1486 "*Name of the directory articles will be saved in (default \"~/News\")."
1487 :group 'gnus-article-saving
1490 (defvar gnus-plugged t
1491 "Whether Gnus is plugged or not.")
1493 (defcustom gnus-default-charset 'iso-8859-1
1494 "Default charset assumed to be used when viewing non-ASCII characters.
1495 This variable is overridden on a group-to-group basis by the
1496 gnus-group-charset-alist variable and is only used on groups not
1497 covered by that variable."
1499 :group 'gnus-charset)
1501 (defcustom gnus-default-posting-charset nil
1502 "Default charset assumed to be used when posting non-ASCII characters.
1503 This variable is overridden on a group-to-group basis by the
1504 gnus-group-posting-charset-alist variable and is only used on groups not
1505 covered by that variable.
1506 If nil, no default charset is assumed when posting."
1508 :group 'gnus-charset)
1511 ;;; Internal variables
1513 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1514 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1515 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1516 (defvar gnus-original-article-buffer " *Original Article*")
1517 (defvar gnus-newsgroup-name nil)
1518 (defvar gnus-ephemeral-servers nil)
1520 (defvar gnus-agent nil
1521 "Whether we want to use the Gnus agent or not.")
1523 (defvar gnus-agent-fetching nil
1524 "Whether Gnus agent is in fetching mode.")
1526 (defvar gnus-agent-fetching nil
1527 "Whether Gnus agent is in fetching mode.")
1529 (defvar gnus-command-method nil
1530 "Dynamically bound variable that says what the current backend is.")
1532 (defvar gnus-current-select-method nil
1533 "The current method for selecting a newsgroup.")
1535 (defvar gnus-tree-buffer "*Tree*"
1536 "Buffer where Gnus thread trees are displayed.")
1539 (defvar gnus-use-generic-from nil)
1541 ;; Variable holding the user answers to all method prompts.
1542 (defvar gnus-method-history nil)
1544 ;; Variable holding the user answers to all mail method prompts.
1545 (defvar gnus-mail-method-history nil)
1547 ;; Variable holding the user answers to all group prompts.
1548 (defvar gnus-group-history nil)
1550 (defvar gnus-server-alist nil
1551 "List of available servers.")
1553 (defcustom gnus-cache-directory
1554 (nnheader-concat gnus-directory "cache/")
1555 "*The directory where cached articles will be stored."
1559 (defvar gnus-predefined-server-alist
1562 (nnspool-spool-directory ,gnus-cache-directory)
1563 (nnspool-nov-directory ,gnus-cache-directory)
1564 (nnspool-active-file
1565 ,(nnheader-concat gnus-cache-directory "active"))))
1566 "List of predefined (convenience) servers.")
1568 (defvar gnus-topic-indentation "");; Obsolete variable.
1570 (defconst gnus-article-mark-lists
1571 '((marked . tick) (replied . reply)
1572 (expirable . expire) (killed . killed)
1573 (bookmarks . bookmark) (dormant . dormant)
1574 (scored . score) (saved . save)
1575 (cached . cache) (downloadable . download)
1576 (unsendable . unsend)))
1578 (defvar gnus-headers-retrieved-by nil)
1579 (defvar gnus-article-reply nil)
1580 (defvar gnus-override-method nil)
1581 (defvar gnus-article-check-size nil)
1582 (defvar gnus-opened-servers nil)
1584 (defvar gnus-current-kill-article nil)
1586 (defvar gnus-have-read-active-file nil)
1588 (defconst gnus-maintainer
1589 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1590 "The mail address of the Gnus maintainers.")
1592 (defvar gnus-info-nodes
1593 '((gnus-group-mode "(gnus)The Group Buffer")
1594 (gnus-summary-mode "(gnus)The Summary Buffer")
1595 (gnus-article-mode "(gnus)The Article Buffer")
1596 (gnus-server-mode "(gnus)The Server Buffer")
1597 (gnus-browse-mode "(gnus)Browse Foreign Server")
1598 (gnus-tree-mode "(gnus)Tree Display"))
1599 "Alist of major modes and related Info nodes.")
1601 (defvar gnus-group-buffer "*Group*")
1602 (defvar gnus-summary-buffer "*Summary*")
1603 (defvar gnus-article-buffer "*Article*")
1604 (defvar gnus-server-buffer "*Server*")
1606 (defvar gnus-slave nil
1607 "Whether this Gnus is a slave or not.")
1609 (defvar gnus-batch-mode nil
1610 "Whether this Gnus is running in batch mode or not.")
1612 (defvar gnus-variable-list
1613 '(gnus-newsrc-options gnus-newsrc-options-n
1614 gnus-newsrc-last-checked-date
1615 gnus-newsrc-alist gnus-server-alist
1616 gnus-killed-list gnus-zombie-list
1617 gnus-topic-topology gnus-topic-alist
1619 "Gnus variables saved in the quick startup file.")
1621 (defvar gnus-newsrc-alist nil
1622 "Assoc list of read articles.
1623 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1625 (defvar gnus-newsrc-hashtb nil
1626 "Hashtable of gnus-newsrc-alist.")
1628 (defvar gnus-killed-list nil
1629 "List of killed newsgroups.")
1631 (defvar gnus-killed-hashtb nil
1632 "Hash table equivalent of gnus-killed-list.")
1634 (defvar gnus-zombie-list nil
1635 "List of almost dead newsgroups.")
1637 (defvar gnus-description-hashtb nil
1638 "Descriptions of newsgroups.")
1640 (defvar gnus-list-of-killed-groups nil
1641 "List of newsgroups that have recently been killed by the user.")
1643 (defvar gnus-active-hashtb nil
1644 "Hashtable of active articles.")
1646 (defvar gnus-moderated-hashtb nil
1647 "Hashtable of moderated newsgroups.")
1649 ;; Save window configuration.
1650 (defvar gnus-prev-winconf nil)
1652 (defvar gnus-reffed-article-number nil)
1654 ;;; Let the byte-compiler know that we know about this variable.
1655 (defvar rmail-default-rmail-file)
1657 (defvar gnus-dead-summary nil)
1659 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1660 "Regexp matching invalid groups.")
1662 ;;; End of variables.
1664 ;; Define some autoload functions Gnus might use.
1667 ;; This little mapcar goes through the list below and marks the
1668 ;; symbols in question as autoloaded functions.
1671 (let ((interactive (nth 1 (memq ':interactive package))))
1675 (when (consp function)
1676 (setq keymap (car (memq 'keymap function)))
1677 (setq function (car function)))
1678 (unless (fboundp function)
1679 (autoload function (car package) nil interactive keymap))))
1680 (if (eq (nth 1 package) ':interactive)
1683 '(("info" :interactive t Info-goto-node)
1685 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1686 ("ps-print" ps-print-preprint)
1687 ("message" :interactive t
1688 message-send-and-exit message-yank-original)
1689 ("babel" babel-as-string)
1690 ("nnmail" nnmail-split-fancy nnmail-article-group)
1691 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1692 ("rmailout" rmail-output rmail-output-to-rmail-file)
1693 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1694 rmail-show-message rmail-summary-exists
1695 rmail-select-summary rmail-update-summary)
1696 ("gnus-audio" :interactive t gnus-audio-play)
1697 ("gnus-xmas" gnus-xmas-splash)
1698 ("gnus-soup" :interactive t
1699 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1700 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1701 ("nnsoup" nnsoup-pack-replies)
1702 ("score-mode" :interactive t gnus-score-mode)
1703 ("gnus-mh" gnus-summary-save-article-folder
1704 gnus-Folder-save-name gnus-folder-save-name)
1705 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1706 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1707 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1708 gnus-demon-add-disconnection gnus-demon-add-handler
1709 gnus-demon-remove-handler)
1710 ("gnus-demon" :interactive t
1711 gnus-demon-init gnus-demon-cancel)
1712 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1713 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1714 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1715 gnus-nocem-unwanted-article-p)
1716 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1717 gnus-server-server-name)
1718 ("gnus-srvr" gnus-browse-foreign-server)
1719 ("gnus-cite" :interactive t
1720 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1721 gnus-article-hide-citation gnus-article-fill-cited-article
1722 gnus-article-hide-citation-in-followups)
1723 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1724 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1725 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1726 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1727 gnus-cache-possibly-remove-articles gnus-cache-request-article
1728 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1729 gnus-cache-enter-remove-article gnus-cached-article-p
1730 gnus-cache-open gnus-cache-close gnus-cache-update-article
1731 gnus-cache-articles-in-group)
1732 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1733 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1734 ("gnus-score" :interactive t
1735 gnus-summary-increase-score gnus-summary-set-score
1736 gnus-summary-raise-thread gnus-summary-raise-same-subject
1737 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1738 gnus-summary-lower-thread gnus-summary-lower-same-subject
1739 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1740 gnus-summary-current-score gnus-score-delta-default
1741 gnus-score-flush-cache gnus-score-close
1742 gnus-possibly-score-headers gnus-score-followup-article
1743 gnus-score-followup-thread)
1745 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1746 gnus-current-score-file-nondirectory gnus-score-adaptive
1747 gnus-score-find-trace gnus-score-file-name)
1748 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1749 ("gnus-topic" :interactive t gnus-topic-mode)
1750 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1751 gnus-subscribe-topics)
1752 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1753 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1754 ("gnus-uu" :interactive t
1755 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1756 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1757 gnus-uu-mark-by-regexp gnus-uu-mark-all
1758 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1759 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1760 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1761 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1762 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1763 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1764 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1765 gnus-uu-mark-over gnus-uu-post-news)
1766 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1767 ("gnus-msg" (gnus-summary-send-map keymap)
1768 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1769 ("gnus-msg" :interactive t
1770 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1771 gnus-summary-followup gnus-summary-followup-with-original
1772 gnus-summary-cancel-article gnus-summary-supersede-article
1773 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1774 gnus-summary-mail-forward gnus-summary-mail-other-window
1775 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1776 gnus-summary-wide-reply gnus-summary-followup-to-mail
1777 gnus-summary-followup-to-mail-with-original gnus-bug
1778 gnus-summary-wide-reply-with-original
1779 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1780 gnus-summary-post-forward)
1781 ("gnus-picon" :interactive t gnus-article-display-picons
1782 gnus-group-display-picons gnus-picons-article-display-x-face
1783 gnus-picons-display-x-face)
1784 ("gnus-picon" gnus-picons-buffer-name)
1785 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1786 gnus-grouplens-mode)
1787 ("smiley" :interactive t gnus-smiley-display)
1788 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1789 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1790 gnus-list-of-unread-articles gnus-list-of-read-articles
1791 gnus-offer-save-summaries gnus-make-thread-indent-array
1792 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1793 gnus-summary-skip-intangible gnus-summary-article-number
1794 gnus-data-header gnus-data-find)
1795 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1796 gnus-group-list-groups gnus-group-first-unread-group
1797 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1798 gnus-group-setup-buffer gnus-group-get-new-news
1799 gnus-group-make-help-group gnus-group-update-group
1800 gnus-group-iterate gnus-group-group-name)
1801 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1802 gnus-backlog-remove-article)
1803 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1804 gnus-article-prepare gnus-article-set-window-start
1805 gnus-article-next-page gnus-article-prev-page
1806 gnus-request-article-this-buffer gnus-article-mode
1807 gnus-article-setup-buffer gnus-narrow-to-page
1808 gnus-article-delete-invisible-text gnus-treat-article)
1809 ("gnus-art" :interactive t
1810 gnus-article-hide-headers gnus-article-hide-boring-headers
1811 gnus-article-treat-overstrike
1812 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1813 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1814 gnus-article-de-base64-unreadable
1815 gnus-article-decode-HZ
1816 gnus-article-wash-html
1817 gnus-article-hide-pgp
1818 gnus-article-hide-pem gnus-article-hide-signature
1819 gnus-article-strip-leading-blank-lines gnus-article-date-local
1820 gnus-article-date-original gnus-article-date-lapsed
1821 gnus-article-show-all-headers
1822 gnus-article-edit-mode gnus-article-edit-article
1823 gnus-article-edit-done gnus-article-decode-encoded-words
1824 gnus-start-date-timer gnus-stop-date-timer
1825 gnus-mime-view-all-parts)
1826 ("gnus-int" gnus-request-type)
1827 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1828 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1829 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1830 gnus-dup-enter-articles)
1831 ("gnus-range" gnus-copy-sequence)
1832 ("gnus-eform" gnus-edit-form)
1833 ("gnus-move" :interactive t
1834 gnus-group-move-group-to-server gnus-change-server)
1835 ("gnus-logic" gnus-score-advanced)
1836 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1837 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1838 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1839 gnus-async-halt-prefetch)
1840 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1841 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1842 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1843 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1844 ("gnus-agent" :interactive t
1845 gnus-unplugged gnus-agentize gnus-agent-batch)
1846 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1847 gnus-summary-save-article-vm)
1848 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1849 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1850 ("gnus-mlspl" :interactive t gnus-group-split-setup
1851 gnus-group-split-update))))
1853 ;;; gnus-sum.el thingies
1856 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1857 "*The format specification of the lines in the summary buffer.
1859 It works along the same lines as a normal formatting string,
1860 with some simple extensions.
1862 %N Article number, left padded with spaces (string)
1864 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1865 %n Name of the poster (string)
1866 %a Extracted name of the poster (string)
1867 %A Extracted address of the poster (string)
1868 %F Contents of the From: header (string)
1869 %f Contents of the From: or To: headers (string)
1870 %x Contents of the Xref: header (string)
1871 %D Date of the article (string)
1872 %d Date of the article (string) in DD-MMM format
1873 %M Message-id of the article (string)
1874 %r References of the article (string)
1875 %c Number of characters in the article (integer)
1876 %L Number of lines in the article (integer)
1877 %I Indentation based on thread level (a string of spaces)
1878 %T A string with two possible values: 80 spaces if the article
1879 is on thread level two or larger and 0 spaces on level one
1880 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1881 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1882 %[ Opening bracket (character, \"[\" or \"<\")
1883 %] Closing bracket (character, \"]\" or \">\")
1884 %> Spaces of length thread-level (string)
1885 %< Spaces of length (- 20 thread-level) (string)
1886 %i Article score (number)
1887 %z Article zcore (character)
1888 %t Number of articles under the current thread (number).
1889 %e Whether the thread is empty or not (character).
1890 %l GroupLens score (string).
1891 %V Total thread score (number).
1892 %P The line number (number).
1893 %O Download mark (character).
1894 %u User defined specifier. The next character in the format string should
1895 be a letter. Gnus will call the function gnus-user-format-function-X,
1896 where X is the letter following %u. The function will be passed the
1897 current header as argument. The function should return a string, which
1898 will be inserted into the summary just like information from any other
1901 Text between %( and %) will be highlighted with `gnus-mouse-face'
1902 when the mouse point is placed inside the area. There can only be one
1905 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1906 with care. For reasons of efficiency, Gnus will compute what column
1907 these characters will end up in, and \"hard-code\" that. This means that
1908 it is invalid to have these specs after a variable-length spec. Well,
1909 you might not be arrested, but your summary buffer will look strange,
1910 which is bad enough.
1912 The smart choice is to have these specs as for to the left as
1915 This restriction may disappear in later versions of Gnus."
1917 :group 'gnus-summary-format)
1920 ;;; Skeleton keymaps
1923 (defun gnus-suppress-keymap (keymap)
1924 (suppress-keymap keymap)
1925 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1927 (define-key keymap (pop keys) 'undefined))))
1929 (defvar gnus-article-mode-map
1930 (let ((keymap (make-sparse-keymap)))
1931 (gnus-suppress-keymap keymap)
1933 (defvar gnus-summary-mode-map
1934 (let ((keymap (make-keymap)))
1935 (gnus-suppress-keymap keymap)
1937 (defvar gnus-group-mode-map
1938 (let ((keymap (make-keymap)))
1939 (gnus-suppress-keymap keymap)
1944 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1945 ;; If you want the cursor to go somewhere else, set these two
1946 ;; functions in some startup hook to whatever you want.
1947 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1948 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1950 ;;; Various macros and substs.
1952 (defun gnus-header-from (header)
1953 (mail-header-from header))
1955 (defmacro gnus-gethash (string hashtable)
1956 "Get hash value of STRING in HASHTABLE."
1957 `(symbol-value (intern-soft ,string ,hashtable)))
1959 (defmacro gnus-sethash (string value hashtable)
1960 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1961 `(set (intern ,string ,hashtable) ,value))
1962 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1964 (defmacro gnus-group-unread (group)
1965 "Get the currently computed number of unread articles in GROUP."
1966 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1968 (defmacro gnus-group-entry (group)
1969 "Get the newsrc entry for GROUP."
1970 `(gnus-gethash ,group gnus-newsrc-hashtb))
1972 (defmacro gnus-active (group)
1973 "Get active info on GROUP."
1974 `(gnus-gethash ,group gnus-active-hashtb))
1976 (defmacro gnus-set-active (group active)
1977 "Set GROUP's active info."
1978 `(gnus-sethash ,group ,active gnus-active-hashtb))
1980 ;; Info access macros.
1982 (defmacro gnus-info-group (info)
1984 (defmacro gnus-info-rank (info)
1986 (defmacro gnus-info-read (info)
1988 (defmacro gnus-info-marks (info)
1990 (defmacro gnus-info-method (info)
1992 (defmacro gnus-info-params (info)
1995 (defmacro gnus-info-level (info)
1996 `(let ((rank (gnus-info-rank ,info)))
2000 (defmacro gnus-info-score (info)
2001 `(let ((rank (gnus-info-rank ,info)))
2002 (or (and (consp rank) (cdr rank)) 0)))
2004 (defmacro gnus-info-set-group (info group)
2005 `(setcar ,info ,group))
2006 (defmacro gnus-info-set-rank (info rank)
2007 `(setcar (nthcdr 1 ,info) ,rank))
2008 (defmacro gnus-info-set-read (info read)
2009 `(setcar (nthcdr 2 ,info) ,read))
2010 (defmacro gnus-info-set-marks (info marks &optional extend)
2012 `(gnus-info-set-entry ,info ,marks 3)
2013 `(setcar (nthcdr 3 ,info) ,marks)))
2014 (defmacro gnus-info-set-method (info method &optional extend)
2016 `(gnus-info-set-entry ,info ,method 4)
2017 `(setcar (nthcdr 4 ,info) ,method)))
2018 (defmacro gnus-info-set-params (info params &optional extend)
2020 `(gnus-info-set-entry ,info ,params 5)
2021 `(setcar (nthcdr 5 ,info) ,params)))
2023 (defun gnus-info-set-entry (info entry number)
2024 ;; Extend the info until we have enough elements.
2025 (while (<= (length info) number)
2026 (nconc info (list nil)))
2028 (setcar (nthcdr number info) entry))
2030 (defmacro gnus-info-set-level (info level)
2031 `(let ((rank (cdr ,info)))
2032 (if (consp (car rank))
2033 (setcar (car rank) ,level)
2034 (setcar rank ,level))))
2035 (defmacro gnus-info-set-score (info score)
2036 `(let ((rank (cdr ,info)))
2037 (if (consp (car rank))
2038 (setcdr (car rank) ,score)
2039 (setcar rank (cons (car rank) ,score)))))
2041 (defmacro gnus-get-info (group)
2042 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2044 ;; Byte-compiler warning.
2045 (defvar gnus-visual)
2046 ;; Find out whether the gnus-visual TYPE is wanted.
2047 (defun gnus-visual-p (&optional type class)
2048 (and gnus-visual ; Has to be non-nil, at least.
2049 (if (not type) ; We don't care about type.
2051 (if (listp gnus-visual) ; It's a list, so we check it.
2052 (or (memq type gnus-visual)
2053 (memq class gnus-visual))
2056 ;;; Load the compatability functions.
2065 (defvar gnus-shutdown-alist nil)
2067 (defun gnus-add-shutdown (function &rest symbols)
2068 "Run FUNCTION whenever one of SYMBOLS is shut down."
2069 (push (cons function symbols) gnus-shutdown-alist))
2071 (defun gnus-shutdown (symbol)
2072 "Shut down everything that waits for SYMBOL."
2073 (let ((alist gnus-shutdown-alist)
2075 (while (setq entry (pop alist))
2076 (when (memq symbol (cdr entry))
2077 (funcall (car entry))))))
2081 ;;; Gnus Utility Functions
2085 (defmacro gnus-string-or (&rest strings)
2086 "Return the first element of STRINGS that is a non-blank string.
2087 STRINGS will be evaluated in normal `or' order."
2088 `(gnus-string-or-1 ',strings))
2090 (defun gnus-string-or-1 (strings)
2093 (setq string (eval (pop strings)))
2094 (if (string-match "^[ \t]*$" string)
2096 (setq strings nil)))
2099 (defun gnus-version (&optional arg)
2100 "Version number of this version of Gnus.
2101 If ARG, insert string at point."
2104 (insert (message gnus-version))
2105 (message gnus-version)))
2107 (defun gnus-continuum-version (version)
2108 "Return VERSION as a floating point number."
2109 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2110 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2111 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2112 (number (match-string 2 version))
2114 (unless (string-match
2115 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2116 (error "Invalid version string: %s" version))
2117 (setq major (string-to-number (match-string 1 number))
2118 minor (string-to-number (match-string 2 number))
2119 least (if (match-beginning 3)
2120 (string-to-number (match-string 3 number))
2124 (format "%s00%02d%02d"
2125 (if (member alpha '("(ding)" "d"))
2129 (- (mm-char-int (aref (downcase alpha) 0))
2133 (format "%d.%02d%02d" major minor least))))))
2135 (defun gnus-info-find-node ()
2136 "Find Info documentation of Gnus."
2138 ;; Enlarge info window if needed.
2139 (let (gnus-info-buffer)
2140 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2141 (setq gnus-info-buffer (current-buffer))
2142 (gnus-configure-windows 'info)))
2145 ;;; gnus-interactive
2148 (defvar gnus-current-prefix-symbol nil
2149 "Current prefix symbol.")
2151 (defvar gnus-current-prefix-symbols nil
2152 "List of current prefix symbols.")
2154 (defun gnus-interactive (string &optional params)
2155 "Return a list that can be fed to `interactive'.
2156 See `interactive' for full documentation.
2158 Adds the following specs:
2160 y -- The current symbolic prefix.
2161 Y -- A list of the current symbolic prefix(es).
2162 A -- Article number.
2163 H -- Article header.
2167 (while (< i (length string))
2168 (string-match ".\\([^\n]*\\)\n?" string i)
2169 (setq c (aref string i))
2171 (setq prompt (match-string 1 string)))
2172 (setq i (match-end 0))
2173 ;; We basically emulate just about everything that
2174 ;; `interactive' does, but add the specs listed above.
2178 (completing-read prompt obarray 'fboundp t))
2180 (read-buffer prompt (current-buffer) t))
2182 (read-buffer prompt (other-buffer (current-buffer))))
2186 (completing-read prompt obarray 'commandp t))
2190 (read-file-name prompt nil default-directory 'lambda))
2192 (read-file-name prompt nil nil 'lambda))
2194 (read-file-name prompt))
2196 (read-key-sequence prompt))
2198 (error "Not implemented spec"))
2200 (error "Not implemented spec"))
2204 (error "Not implemented spec"))
2206 (string-to-number (read-from-minibuffer prompt)))
2208 (prefix-numeric-value current-prefix-arg))
2214 (read-string prompt))
2216 (intern (read-string prompt)))
2218 (read-variable prompt))
2220 (read-minibuffer prompt))
2222 (eval-minibuffer prompt))
2223 ;; And here the new specs come.
2225 gnus-current-prefix-symbol)
2227 gnus-current-prefix-symbols)
2229 (gnus-group-group-name))
2231 (gnus-summary-skip-intangible)
2232 (or (get-text-property (point) 'gnus-number)
2233 (gnus-summary-last-subject)))
2235 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2237 (error "Non-implemented spec")))
2241 (push (if (< (point) (mark) (point) (mark))) out)
2242 (push (if (> (point) (mark) (point) (mark))) out))))
2243 (setq out (delq 'gnus-prefix-nil out))
2246 (defun gnus-symbolic-argument (&optional arg)
2247 "Read a symbolic argument and a command, and then execute command."
2249 (let* ((in-command (this-command-keys))
2250 (command in-command)
2251 gnus-current-prefix-symbols
2252 gnus-current-prefix-symbol
2254 (while (equal in-command command)
2255 (message "%s-" (key-description (this-command-keys)))
2256 (push (intern (char-to-string (read-char))) syms)
2257 (setq command (read-key-sequence nil t)))
2258 (setq gnus-current-prefix-symbols (nreverse syms)
2259 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2260 (call-interactively (key-binding command t))))
2262 ;;; More various functions.
2264 (defsubst gnus-check-backend-function (func group)
2265 "Check whether GROUP supports function FUNC.
2266 GROUP can either be a string (a group name) or a select method."
2268 (let ((method (if (stringp group)
2269 (car (gnus-find-method-for-group group))
2271 (unless (featurep method)
2273 (fboundp (intern (format "%s-%s" method func))))))
2275 (defun gnus-group-read-only-p (&optional group)
2276 "Check whether GROUP supports editing or not.
2277 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2278 that that variable is buffer-local to the summary buffers."
2279 (let ((group (or group gnus-newsgroup-name)))
2280 (not (gnus-check-backend-function 'request-replace-article group))))
2282 (defun gnus-group-total-expirable-p (group)
2283 "Check whether GROUP is total-expirable or not."
2284 (let ((params (gnus-group-find-parameter group))
2287 ((memq 'total-expire params)
2289 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2291 (gnus-total-expirable-newsgroups ; Check var.
2292 (string-match gnus-total-expirable-newsgroups group)))))
2294 (defun gnus-group-auto-expirable-p (group)
2295 "Check whether GROUP is auto-expirable or not."
2296 (let ((params (gnus-group-find-parameter group))
2299 ((memq 'auto-expire params)
2301 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2303 (gnus-auto-expirable-newsgroups ; Check var.
2304 (string-match gnus-auto-expirable-newsgroups group)))))
2306 (defun gnus-virtual-group-p (group)
2307 "Say whether GROUP is virtual or not."
2308 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2309 gnus-valid-select-methods)))
2311 (defun gnus-news-group-p (group &optional article)
2312 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2313 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2314 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2315 (if (or (null article)
2316 (not (< article 0)))
2317 (eq (gnus-request-type group article) 'news)
2318 (if (not (vectorp article))
2320 ;; It's a real article.
2321 (eq (gnus-request-type group (mail-header-id article))
2324 ;; Returns a list of writable groups.
2325 (defun gnus-writable-groups ()
2326 (let ((alist gnus-newsrc-alist)
2328 (while (setq group (car (pop alist)))
2329 (unless (gnus-group-read-only-p group)
2330 (push group groups)))
2333 ;; Check whether to use long file names.
2334 (defun gnus-use-long-file-name (symbol)
2335 ;; The variable has to be set...
2336 (and gnus-use-long-file-name
2337 ;; If it isn't a list, then we return t.
2338 (or (not (listp gnus-use-long-file-name))
2339 ;; If it is a list, and the list contains `symbol', we
2341 (not (memq symbol gnus-use-long-file-name)))))
2343 ;; Generate a unique new group name.
2344 (defun gnus-generate-new-group-name (leaf)
2347 (while (gnus-gethash name gnus-newsrc-hashtb)
2348 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2351 (defun gnus-ephemeral-group-p (group)
2352 "Say whether GROUP is ephemeral or not."
2353 (gnus-group-get-parameter group 'quit-config t))
2355 (defun gnus-group-quit-config (group)
2356 "Return the quit-config of GROUP."
2357 (gnus-group-get-parameter group 'quit-config t))
2359 (defun gnus-kill-ephemeral-group (group)
2360 "Remove ephemeral GROUP from relevant structures."
2361 (gnus-sethash group nil gnus-newsrc-hashtb))
2363 (defun gnus-simplify-mode-line ()
2364 "Make mode lines a bit simpler."
2365 (setq mode-line-modified (cdr gnus-mode-line-modified))
2366 (when (listp mode-line-format)
2367 (make-local-variable 'mode-line-format)
2368 (setq mode-line-format (copy-sequence mode-line-format))
2369 (when (equal (nth 3 mode-line-format) " ")
2370 (setcar (nthcdr 3 mode-line-format) " "))))
2372 ;;; Servers and groups.
2374 (defsubst gnus-server-add-address (method)
2375 (let ((method-name (symbol-name (car method))))
2376 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2377 (not (assq (intern (concat method-name "-address")) method))
2378 (memq 'physical-address (assq (car method)
2379 gnus-valid-select-methods)))
2380 (append method (list (list (intern (concat method-name "-address"))
2384 (defsubst gnus-server-get-method (group method)
2385 ;; Input either a server name, and extended server name, or a
2386 ;; select method, and return a select method.
2387 (cond ((stringp method)
2388 (gnus-server-to-method method))
2389 ((equal method gnus-select-method)
2391 ((and (stringp (car method))
2393 (gnus-server-extend-method group method))
2396 (equal (cadr method) ""))
2399 (gnus-server-add-address method))))
2401 (defun gnus-server-to-method (server)
2402 "Map virtual server names to select methods."
2404 ;; Is this a method, perhaps?
2405 (and server (listp server) server)
2406 ;; Perhaps this is the native server?
2407 (and (equal server "native") gnus-select-method)
2408 ;; It should be in the server alist.
2409 (cdr (assoc server gnus-server-alist))
2410 ;; It could be in the predefined server alist.
2411 (cdr (assoc server gnus-predefined-server-alist))
2412 ;; If not, we look through all the opened server
2413 ;; to see whether we can find it there.
2414 (let ((opened gnus-opened-servers))
2416 (not (equal server (format "%s:%s" (caaar opened)
2420 ;; It could be a named method, search all servers
2421 (let ((servers gnus-secondary-select-methods))
2423 (not (equal server (format "%s:%s" (caar servers)
2428 (defmacro gnus-method-equal (ss1 ss2)
2429 "Say whether two servers are equal."
2433 (and (= (length s1) (length s2))
2435 (while (and s1 (member (car s1) s2))
2439 (defun gnus-methods-equal-p (m1 m2)
2440 (let ((m1 (or m1 gnus-select-method))
2441 (m2 (or m2 gnus-select-method)))
2443 (and (eq (car m1) (car m2))
2444 (or (not (memq 'address (assoc (symbol-name (car m1))
2445 gnus-valid-select-methods)))
2446 (equal (nth 1 m1) (nth 1 m2)))))))
2448 (defun gnus-server-equal (m1 m2)
2449 "Say whether two methods are equal."
2450 (let ((m1 (cond ((null m1) gnus-select-method)
2451 ((stringp m1) (gnus-server-to-method m1))
2453 (m2 (cond ((null m2) gnus-select-method)
2454 ((stringp m2) (gnus-server-to-method m2))
2456 (gnus-method-equal m1 m2)))
2458 (defun gnus-servers-using-backend (backend)
2459 "Return a list of known servers using BACKEND."
2460 (let ((opened gnus-opened-servers)
2463 (when (eq backend (caaar opened))
2464 (push (caar opened) out))
2468 (defun gnus-archive-server-wanted-p ()
2469 "Say whether the user wants to use the archive server."
2471 ((or (not gnus-message-archive-method)
2472 (not gnus-message-archive-group))
2474 ((and gnus-message-archive-method gnus-message-archive-group)
2477 (let ((active (cadr (assq 'nnfolder-active-file
2478 gnus-message-archive-method))))
2480 (file-exists-p active))))))
2482 (defun gnus-group-prefixed-name (group method)
2483 "Return the whole name from GROUP and METHOD."
2484 (and (stringp method) (setq method (gnus-server-to-method method)))
2485 (if (or (not method)
2486 (gnus-server-equal method "native"))
2488 (concat (format "%s" (car method))
2490 (or (assoc (format "%s" (car method))
2491 (gnus-methods-using 'address))
2492 (gnus-server-equal method gnus-message-archive-method))
2494 (not (string= (nth 1 method) "")))
2495 (concat "+" (nth 1 method)))
2498 (defun gnus-group-real-prefix (group)
2499 "Return the prefix of the current group name."
2500 (if (string-match "^[^:]+:" group)
2501 (substring group 0 (match-end 0))
2504 (defun gnus-group-method (group)
2505 "Return the server or method used for selecting GROUP.
2506 You should probably use `gnus-find-method-for-group' instead."
2507 (let ((prefix (gnus-group-real-prefix group)))
2508 (if (equal prefix "")
2510 (let ((servers gnus-opened-servers)
2512 backend possible found)
2513 (if (string-match "^[^\\+]+\\+" prefix)
2514 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2515 server (substring prefix (match-end 0) (1- (length prefix))))
2516 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2518 (when (eq (caaar servers) backend)
2519 (setq possible (caar servers))
2520 (when (equal (cadaar servers) server)
2521 (setq found (caar servers))))
2523 (or (car (rassoc found gnus-server-alist))
2525 (car (rassoc possible gnus-server-alist))
2527 (list backend server))))))
2529 (defsubst gnus-native-method-p (method)
2530 "Return whether METHOD is the native select method."
2531 (gnus-method-equal method gnus-select-method))
2533 (defsubst gnus-secondary-method-p (method)
2534 "Return whether METHOD is a secondary select method."
2535 (let ((methods gnus-secondary-select-methods)
2536 (gmethod (gnus-server-get-method nil method)))
2538 (not (gnus-method-equal
2539 (gnus-server-get-method nil (car methods))
2541 (setq methods (cdr methods)))
2544 (defun gnus-method-simplify (method)
2545 "Return the shortest uniquely identifying string or method for METHOD."
2546 (cond ((stringp method)
2548 ((gnus-native-method-p method)
2550 ((gnus-secondary-method-p method)
2551 (format "%s:%s" (nth 0 method) (nth 1 method)))
2555 (defun gnus-groups-from-server (server)
2556 "Return a list of all groups that are fetched from SERVER."
2557 (let ((alist (cdr gnus-newsrc-alist))
2559 (while (setq info (pop alist))
2560 (when (gnus-server-equal (gnus-info-method info) server)
2561 (push (gnus-info-group info) groups)))
2562 (sort groups 'string<)))
2564 (defun gnus-group-foreign-p (group)
2565 "Say whether a group is foreign or not."
2566 (and (not (gnus-group-native-p group))
2567 (not (gnus-group-secondary-p group))))
2569 (defun gnus-group-native-p (group)
2570 "Say whether the group is native or not."
2571 (not (string-match ":" group)))
2573 (defun gnus-group-secondary-p (group)
2574 "Say whether the group is secondary or not."
2575 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2577 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2578 "Return the group parameters for GROUP.
2579 If SYMBOL, return the value of that symbol in the group parameters."
2581 (set-buffer gnus-group-buffer)
2582 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2584 (gnus-group-parameter-value parameters symbol allow-list)
2587 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2588 "Return the group parameters for GROUP.
2589 If SYMBOL, return the value of that symbol in the group parameters.
2590 Most functions should use `gnus-group-find-parameter', which
2591 also examines the topic parameters."
2592 (let ((params (gnus-info-params (gnus-get-info group))))
2594 (gnus-group-parameter-value params symbol allow-list)
2597 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2598 "Return the value of SYMBOL in group PARAMS."
2599 ;; We only wish to return group parameters (dotted lists) and
2600 ;; not local variables, which may have the same names.
2601 ;; But first we handle single elements...
2602 (or (car (memq symbol params))
2606 (while (setq elem (pop params))
2607 (when (and (consp elem)
2608 (eq (car elem) symbol)
2611 (throw 'found (cdr elem))))))))
2613 (defun gnus-group-add-parameter (group param)
2614 "Add parameter PARAM to GROUP."
2615 (let ((info (gnus-get-info group)))
2617 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2618 ;; Cons the new param to the old one and update.
2619 (gnus-group-set-info (cons param (gnus-info-params info))
2622 (defun gnus-group-set-parameter (group name value)
2623 "Set parameter NAME to VALUE in GROUP."
2624 (let ((info (gnus-get-info group)))
2626 (gnus-group-remove-parameter group name)
2627 (let ((old-params (gnus-info-params info))
2628 (new-params (list (cons name value))))
2630 (when (or (not (listp (car old-params)))
2631 (not (eq (caar old-params) name)))
2632 (setq new-params (append new-params (list (car old-params)))))
2633 (setq old-params (cdr old-params)))
2634 (gnus-group-set-info new-params group 'params)))))
2636 (defun gnus-group-remove-parameter (group name)
2637 "Remove parameter NAME from GROUP."
2638 (let ((info (gnus-get-info group)))
2640 (let ((params (gnus-info-params info)))
2642 (setq params (delq name params))
2643 (while (assq name params)
2644 (gnus-pull name params))
2645 (gnus-info-set-params info params))))))
2647 (defun gnus-group-add-score (group &optional score)
2648 "Add SCORE to the GROUP score.
2649 If SCORE is nil, add 1 to the score of GROUP."
2650 (let ((info (gnus-get-info group)))
2652 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2654 (defun gnus-short-group-name (group &optional levels)
2655 "Collapse GROUP name LEVELS.
2656 Select methods are stripped and any remote host name is stripped down to
2657 just the host name."
2663 gnus-group-uncollapsed-levels
2665 (while (string-match "\\." group skip)
2666 (setq skip (match-end 0)
2669 ;; Separate foreign select method from group name and collapse.
2670 ;; If method contains a server, collapse to non-domain server name,
2671 ;; otherwise collapse to select method.
2672 (let* ((colon (string-match ":" group))
2673 (server (and colon (substring group 0 colon)))
2674 (plus (and server (string-match "+" server))))
2677 (setq foreign (substring server (+ 1 plus)
2678 (string-match "\\." server))
2679 group (substring group (+ 1 colon)))
2680 (setq foreign server
2681 group (substring group (+ 1 colon))))
2682 (setq foreign (concat foreign ":")))
2683 ;; Collapse group name leaving LEVELS uncollapsed elements
2684 (let* ((slist (split-string group "/"))
2685 (slen (length slist))
2686 (dlist (split-string group "\\."))
2687 (dlen (length dlist))
2699 (setq levels (- glen levels))
2701 (push (if (>= (decf levels) 0)
2702 (if (zerop (length g))
2707 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
2709 (defun gnus-narrow-to-body ()
2710 "Narrow to the body of an article."
2713 (goto-char (point-min))
2714 (or (search-forward "\n\n" nil t)
2720 ;;; Kill file handling.
2723 (defun gnus-apply-kill-file ()
2724 "Apply a kill file to the current newsgroup.
2725 Returns the number of articles marked as read."
2726 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2727 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2728 (gnus-apply-kill-file-internal)
2731 (defun gnus-kill-save-kill-buffer ()
2732 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2733 (when (get-file-buffer file)
2735 (set-buffer (get-file-buffer file))
2736 (when (buffer-modified-p)
2738 (kill-buffer (current-buffer))))))
2740 (defcustom gnus-kill-file-name "KILL"
2741 "Suffix of the kill files."
2742 :group 'gnus-score-kill
2743 :group 'gnus-score-files
2746 (defun gnus-newsgroup-kill-file (newsgroup)
2747 "Return the name of a kill file name for NEWSGROUP.
2748 If NEWSGROUP is nil, return the global kill file name instead."
2750 ;; The global KILL file is placed at top of the directory.
2751 ((or (null newsgroup)
2752 (string-equal newsgroup ""))
2753 (expand-file-name gnus-kill-file-name
2754 gnus-kill-files-directory))
2755 ;; Append ".KILL" to newsgroup name.
2756 ((gnus-use-long-file-name 'not-kill)
2757 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2758 "." gnus-kill-file-name)
2759 gnus-kill-files-directory))
2760 ;; Place "KILL" under the hierarchical directory.
2762 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2763 "/" gnus-kill-file-name)
2764 gnus-kill-files-directory))))
2768 (defun gnus-member-of-valid (symbol group)
2769 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2771 (symbol-name (car (gnus-find-method-for-group group)))
2772 gnus-valid-select-methods)))
2774 (defun gnus-method-option-p (method option)
2775 "Return non-nil if select METHOD has OPTION as a parameter."
2776 (when (stringp method)
2777 (setq method (gnus-server-to-method method)))
2778 (memq option (assoc (format "%s" (car method))
2779 gnus-valid-select-methods)))
2781 (defun gnus-similar-server-opened (method)
2782 (let ((opened gnus-opened-servers))
2783 (while (and method opened)
2784 (when (and (equal (cadr method) (cadaar opened))
2785 (equal (car method) (caaar opened))
2786 (not (equal method (caar opened))))
2791 (defun gnus-server-extend-method (group method)
2792 ;; This function "extends" a virtual server. If the server is
2793 ;; "hello", and the select method is ("hello" (my-var "something"))
2794 ;; in the group "alt.alt", this will result in a new virtual server
2795 ;; called "hello+alt.alt".
2796 (if (or (not (inline (gnus-similar-server-opened method)))
2797 (not (cddr method)))
2799 `(,(car method) ,(concat (cadr method) "+" group)
2800 (,(intern (format "%s-address" (car method))) ,(cadr method))
2803 (defun gnus-server-status (method)
2804 "Return the status of METHOD."
2805 (nth 1 (assoc method gnus-opened-servers)))
2807 (defun gnus-group-name-to-method (group)
2808 "Guess a select method based on GROUP."
2809 (if (string-match ":" group)
2810 (let ((server (substring group 0 (match-beginning 0))))
2811 (if (string-match "\\+" server)
2812 (list (intern (substring server 0 (match-beginning 0)))
2813 (substring server (match-end 0)))
2814 (list (intern server) "")))
2815 gnus-select-method))
2817 (defun gnus-find-method-for-group (group &optional info)
2818 "Find the select method that GROUP uses."
2819 (or gnus-override-method
2822 (and (not (gnus-group-entry group));; a new group
2823 (gnus-group-name-to-method group))
2824 (let ((info (or info (gnus-get-info group)))
2827 (not (setq method (gnus-info-method info)))
2828 (equal method "native"))
2831 (cond ((stringp method)
2832 (inline (gnus-server-to-method method)))
2833 ((stringp (cadr method))
2834 (inline (gnus-server-extend-method group method)))
2837 (cond ((equal (cadr method) "")
2839 ((null (cadr method))
2840 (list (car method) ""))
2842 (gnus-server-add-address method)))))))
2844 (defun gnus-methods-using (feature)
2845 "Find all methods that have FEATURE."
2846 (let ((valids gnus-valid-select-methods)
2849 (when (memq feature (car valids))
2850 (push (car valids) outs))
2851 (setq valids (cdr valids)))
2854 (defun gnus-read-group (prompt &optional default)
2855 "Prompt the user for a group name.
2856 Disallow invalid group names."
2861 gnus-invalid-group-regexp
2862 (setq group (read-string (concat prefix prompt)
2863 (cons (or default "") 0)
2864 'gnus-group-history)))
2865 (setq prefix (format "Invalid group name: \"%s\". " group)
2869 (defun gnus-read-method (prompt)
2870 "Prompt the user for a method.
2871 Allow completion over sensible values."
2873 (append gnus-valid-select-methods
2874 (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2876 gnus-opened-servers)
2877 gnus-predefined-server-alist
2882 nil t nil 'gnus-method-history)))
2885 (setq method gnus-select-method))
2886 ((assoc method gnus-valid-select-methods)
2887 (let ((address (if (memq 'prompt-address
2888 (assoc method gnus-valid-select-methods))
2889 (read-string "Address: ")
2891 (or (let ((opened gnus-opened-servers))
2893 (not (equal (format "%s:%s" method address)
2894 (format "%s:%s" (caaar opened)
2898 (list (intern method) address))))
2899 ((assoc method servers)
2902 (list (intern method) "")))))
2904 ;;; User-level commands.
2907 (defun gnus-slave-no-server (&optional arg)
2908 "Read network news as a slave, without connecting to local server."
2910 (gnus-no-server arg t))
2913 (defun gnus-no-server (&optional arg slave)
2915 If ARG is a positive number, Gnus will use that as the
2916 startup level. If ARG is nil, Gnus will be started at level 2.
2917 If ARG is non-nil and not a positive number, Gnus will
2918 prompt the user for the name of an NNTP server to use.
2919 As opposed to `gnus', this command will not connect to the local server."
2921 (gnus-no-server-1 arg slave))
2924 (defun gnus-slave (&optional arg)
2925 "Read news as a slave."
2927 (gnus arg nil 'slave))
2930 (defun gnus-other-frame (&optional arg)
2931 "Pop up a frame to read news."
2933 (let ((window (get-buffer-window gnus-group-buffer)))
2935 (select-frame (window-frame window)))
2937 (select-frame (make-frame)))))
2940 ;;(setq thing ? ; this is a comment
2944 (defun gnus (&optional arg dont-connect slave)
2946 If ARG is non-nil and a positive number, Gnus will use that as the
2947 startup level. If ARG is non-nil and not a positive number, Gnus will
2948 prompt the user for the name of an NNTP server to use."
2950 (gnus-1 arg dont-connect slave))
2952 ;; Allow redefinition of Gnus functions.
2958 ;;; gnus.el ends here