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))
38 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
42 (defgroup gnus-charset nil
43 "Group character set issues."
44 :link '(custom-manual "(gnus)Charsets")
47 (defgroup gnus-cache nil
51 (defgroup gnus-start nil
52 "Starting your favorite newsreader."
55 (defgroup gnus-start-server nil
56 "Server options at startup."
59 ;; These belong to gnus-group.el.
60 (defgroup gnus-group nil
62 :link '(custom-manual "(gnus)The Group Buffer")
65 (defgroup gnus-group-foreign nil
67 :link '(custom-manual "(gnus)Foreign Groups")
70 (defgroup gnus-group-new nil
71 "Automatic subscription of new groups."
74 (defgroup gnus-group-levels nil
76 :link '(custom-manual "(gnus)Group Levels")
79 (defgroup gnus-group-select nil
81 :link '(custom-manual "(gnus)Selecting a Group")
84 (defgroup gnus-group-listing nil
85 "Showing slices of the group list."
86 :link '(custom-manual "(gnus)Listing Groups")
89 (defgroup gnus-group-visual nil
90 "Sorting the group buffer."
91 :link '(custom-manual "(gnus)Group Buffer Format")
95 (defgroup gnus-group-various nil
96 "Various group options."
97 :link '(custom-manual "(gnus)Scanning New Messages")
100 ;; These belong to gnus-sum.el.
101 (defgroup gnus-summary nil
103 :link '(custom-manual "(gnus)The Summary Buffer")
106 (defgroup gnus-summary-exit nil
107 "Leaving summary buffers."
108 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
109 :group 'gnus-summary)
111 (defgroup gnus-summary-marks nil
112 "Marks used in summary buffers."
113 :link '(custom-manual "(gnus)Marking Articles")
114 :group 'gnus-summary)
116 (defgroup gnus-thread nil
117 "Ordering articles according to replies."
118 :link '(custom-manual "(gnus)Threading")
119 :group 'gnus-summary)
121 (defgroup gnus-summary-format nil
122 "Formatting of the summary buffer."
123 :link '(custom-manual "(gnus)Summary Buffer Format")
124 :group 'gnus-summary)
126 (defgroup gnus-summary-choose nil
128 :link '(custom-manual "(gnus)Choosing Articles")
129 :group 'gnus-summary)
131 (defgroup gnus-summary-maneuvering nil
132 "Summary movement commands."
133 :link '(custom-manual "(gnus)Summary Maneuvering")
134 :group 'gnus-summary)
136 (defgroup gnus-summary-mail nil
137 "Mail group commands."
138 :link '(custom-manual "(gnus)Mail Group Commands")
139 :group 'gnus-summary)
141 (defgroup gnus-summary-sort nil
142 "Sorting the summary buffer."
143 :link '(custom-manual "(gnus)Sorting")
144 :group 'gnus-summary)
146 (defgroup gnus-summary-visual nil
147 "Highlighting and menus in the summary buffer."
148 :link '(custom-manual "(gnus)Summary Highlighting")
150 :group 'gnus-summary)
152 (defgroup gnus-summary-various nil
153 "Various summary buffer options."
154 :link '(custom-manual "(gnus)Various Summary Stuff")
155 :group 'gnus-summary)
157 (defgroup gnus-summary-pick nil
158 "Pick mode in the summary buffer."
159 :link '(custom-manual "(gnus)Pick and Read")
161 :group 'gnus-summary)
163 (defgroup gnus-summary-tree nil
164 "Tree display of threads in the summary buffer."
165 :link '(custom-manual "(gnus)Tree Display")
167 :group 'gnus-summary)
169 ;; Belongs to gnus-uu.el
170 (defgroup gnus-extract-view nil
171 "Viewing extracted files."
172 :link '(custom-manual "(gnus)Viewing Files")
173 :group 'gnus-extract)
175 ;; Belongs to gnus-score.el
176 (defgroup gnus-score nil
177 "Score and kill file handling."
180 (defgroup gnus-score-kill nil
184 (defgroup gnus-score-adapt nil
185 "Adaptive score files."
188 (defgroup gnus-score-default nil
189 "Default values for score files."
192 (defgroup gnus-score-expire nil
193 "Expiring score rules."
196 (defgroup gnus-score-decay nil
197 "Decaying score rules."
200 (defgroup gnus-score-files nil
201 "Score and kill file names."
205 (defgroup gnus-score-various nil
206 "Various scoring and killing options."
210 (defgroup gnus-visual nil
211 "Options controling the visual fluff."
215 (defgroup gnus-agent nil
216 "Offline support for Gnus."
219 (defgroup gnus-files nil
220 "Files used by Gnus."
223 (defgroup gnus-dribble-file nil
225 :link '(custom-manual "(gnus)Auto Save")
228 (defgroup gnus-newsrc nil
229 "Storing Gnus state."
232 (defgroup gnus-server nil
233 "Options related to newsservers and other servers used by Gnus."
236 (defgroup gnus-message '((message custom-group))
237 "Composing replies and followups in Gnus."
240 (defgroup gnus-meta nil
241 "Meta variables controling major portions of Gnus.
242 In general, modifying these variables does not take affect until Gnus
243 is restarted, and sometimes reloaded."
246 (defgroup gnus-various nil
247 "Other Gnus options."
248 :link '(custom-manual "(gnus)Various Various")
251 (defgroup gnus-mime nil
252 "Variables for controlling the Gnus MIME interface."
255 (defgroup gnus-exit nil
257 :link '(custom-manual "(gnus)Exiting Gnus")
260 (defconst gnus-version-number "5.8.7"
261 "Version number for this version of Gnus.")
263 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
264 "Version string for this version of Gnus.")
266 (defcustom gnus-inhibit-startup-message nil
267 "If non-nil, the startup message will not be displayed.
268 This variable is used before `.gnus.el' is loaded, so it should
269 be set in `.emacs' instead."
273 (defcustom gnus-play-startup-jingle nil
274 "If non-nil, play the Gnus jingle at startup."
278 (unless (featurep 'gnus-xmas)
279 (defalias 'gnus-make-overlay 'make-overlay)
280 (defalias 'gnus-delete-overlay 'delete-overlay)
281 (defalias 'gnus-overlay-put 'overlay-put)
282 (defalias 'gnus-move-overlay 'move-overlay)
283 (defalias 'gnus-overlay-end 'overlay-end)
284 (defalias 'gnus-extent-detached-p 'ignore)
285 (defalias 'gnus-extent-start-open 'ignore)
286 (defalias 'gnus-set-text-properties 'set-text-properties)
287 (defalias 'gnus-group-remove-excess-properties 'ignore)
288 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
289 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
290 (defalias 'gnus-character-to-event 'identity)
291 (defalias 'gnus-add-text-properties 'add-text-properties)
292 (defalias 'gnus-put-text-property 'put-text-property)
293 (defalias 'gnus-mode-line-buffer-identification 'identity)
294 (defalias 'gnus-characterp 'numberp)
295 (defalias 'gnus-deactivate-mark 'deactivate-mark)
296 (defalias 'gnus-window-edges 'window-edges)
297 (defalias 'gnus-key-press-event-p 'numberp)
298 (defalias 'gnus-decode-rfc1522 'ignore))
300 ;; We define these group faces here to avoid the display
301 ;; update forced when creating new faces.
303 (defface gnus-group-news-1-face
306 (:foreground "PaleTurquoise" :bold t))
309 (:foreground "ForestGreen" :bold t))
312 "Level 1 newsgroup face.")
314 (defface gnus-group-news-1-empty-face
317 (:foreground "PaleTurquoise"))
320 (:foreground "ForestGreen"))
323 "Level 1 empty newsgroup face.")
325 (defface gnus-group-news-2-face
328 (:foreground "turquoise" :bold t))
331 (:foreground "CadetBlue4" :bold t))
334 "Level 2 newsgroup face.")
336 (defface gnus-group-news-2-empty-face
339 (:foreground "turquoise"))
342 (:foreground "CadetBlue4"))
345 "Level 2 empty newsgroup face.")
347 (defface gnus-group-news-3-face
356 "Level 3 newsgroup face.")
358 (defface gnus-group-news-3-empty-face
367 "Level 3 empty newsgroup face.")
369 (defface gnus-group-news-4-face
378 "Level 4 newsgroup face.")
380 (defface gnus-group-news-4-empty-face
389 "Level 4 empty newsgroup face.")
391 (defface gnus-group-news-5-face
400 "Level 5 newsgroup face.")
402 (defface gnus-group-news-5-empty-face
411 "Level 5 empty newsgroup face.")
413 (defface gnus-group-news-6-face
422 "Level 6 newsgroup face.")
424 (defface gnus-group-news-6-empty-face
433 "Level 6 empty newsgroup face.")
435 (defface gnus-group-news-low-face
438 (:foreground "DarkTurquoise" :bold t))
441 (:foreground "DarkGreen" :bold t))
444 "Low level newsgroup face.")
446 (defface gnus-group-news-low-empty-face
449 (:foreground "DarkTurquoise"))
452 (:foreground "DarkGreen"))
455 "Low level empty newsgroup face.")
457 (defface gnus-group-mail-1-face
460 (:foreground "aquamarine1" :bold t))
463 (:foreground "DeepPink3" :bold t))
466 "Level 1 mailgroup face.")
468 (defface gnus-group-mail-1-empty-face
471 (:foreground "aquamarine1"))
474 (:foreground "DeepPink3"))
476 (:italic t :bold t)))
477 "Level 1 empty mailgroup face.")
479 (defface gnus-group-mail-2-face
482 (:foreground "aquamarine2" :bold t))
485 (:foreground "HotPink3" :bold t))
488 "Level 2 mailgroup face.")
490 (defface gnus-group-mail-2-empty-face
493 (:foreground "aquamarine2"))
496 (:foreground "HotPink3"))
499 "Level 2 empty mailgroup face.")
501 (defface gnus-group-mail-3-face
504 (:foreground "aquamarine3" :bold t))
507 (:foreground "magenta4" :bold t))
510 "Level 3 mailgroup face.")
512 (defface gnus-group-mail-3-empty-face
515 (:foreground "aquamarine3"))
518 (:foreground "magenta4"))
521 "Level 3 empty mailgroup face.")
523 (defface gnus-group-mail-low-face
526 (:foreground "aquamarine4" :bold t))
529 (:foreground "DeepPink4" :bold t))
532 "Low level mailgroup face.")
534 (defface gnus-group-mail-low-empty-face
537 (:foreground "aquamarine4"))
540 (:foreground "DeepPink4"))
543 "Low level empty mailgroup face.")
545 ;; Summary mode faces.
547 (defface gnus-summary-selected-face '((t
549 "Face used for selected articles.")
551 (defface gnus-summary-cancelled-face
553 (:foreground "yellow" :background "black")))
554 "Face used for cancelled articles.")
556 (defface gnus-summary-high-ticked-face
559 (:foreground "pink" :bold t))
562 (:foreground "firebrick" :bold t))
565 "Face used for high interest ticked articles.")
567 (defface gnus-summary-low-ticked-face
570 (:foreground "pink" :italic t))
573 (:foreground "firebrick" :italic t))
576 "Face used for low interest ticked articles.")
578 (defface gnus-summary-normal-ticked-face
581 (:foreground "pink"))
584 (:foreground "firebrick"))
587 "Face used for normal interest ticked articles.")
589 (defface gnus-summary-high-ancient-face
592 (:foreground "SkyBlue" :bold t))
595 (:foreground "RoyalBlue" :bold t))
598 "Face used for high interest ancient articles.")
600 (defface gnus-summary-low-ancient-face
603 (:foreground "SkyBlue" :italic t))
606 (:foreground "RoyalBlue" :italic t))
609 "Face used for low interest ancient articles.")
611 (defface gnus-summary-normal-ancient-face
614 (:foreground "SkyBlue"))
617 (:foreground "RoyalBlue"))
620 "Face used for normal interest ancient articles.")
622 (defface gnus-summary-high-unread-face
625 "Face used for high interest unread articles.")
627 (defface gnus-summary-low-unread-face
630 "Face used for low interest unread articles.")
632 (defface gnus-summary-normal-unread-face
635 "Face used for normal interest unread articles.")
637 (defface gnus-summary-high-read-face
640 (:foreground "PaleGreen"
644 (:foreground "DarkGreen"
648 "Face used for high interest read articles.")
650 (defface gnus-summary-low-read-face
653 (:foreground "PaleGreen"
657 (:foreground "DarkGreen"
661 "Face used for low interest read articles.")
663 (defface gnus-summary-normal-read-face
666 (:foreground "PaleGreen"))
669 (:foreground "DarkGreen"))
672 "Face used for normal interest read articles.")
679 (defvar gnus-buffers nil)
681 (defun gnus-get-buffer-create (name)
682 "Do the same as `get-buffer-create', but store the created buffer."
683 (or (get-buffer name)
684 (car (push (get-buffer-create name) gnus-buffers))))
686 (defun gnus-add-buffer ()
687 "Add the current buffer to the list of Gnus buffers."
688 (push (current-buffer) gnus-buffers))
690 (defun gnus-buffers ()
691 "Return a list of live Gnus buffers."
692 (while (and gnus-buffers
693 (not (buffer-name (car gnus-buffers))))
695 (let ((buffers gnus-buffers))
697 (if (buffer-name (cadr buffers))
699 (setcdr buffers (cddr buffers)))))
704 (defvar gnus-group-buffer "*Group*")
707 (autoload 'gnus-play-jingle "gnus-audio"))
709 (defface gnus-splash-face
712 (:foreground "Brown"))
715 (:foreground "Brown"))
718 "Face of the splash screen.")
720 (defun gnus-splash ()
722 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
723 (let ((buffer-read-only nil))
725 (unless gnus-inhibit-startup-message
726 (gnus-group-startup-message)
728 (when gnus-play-startup-jingle
729 (gnus-play-jingle))))))
731 (defun gnus-indent-rigidly (start end arg)
732 "Indent rigidly using only spaces and no tabs."
735 (narrow-to-region start end)
737 (indent-rigidly start end arg)
738 ;; We translate tabs into spaces -- not everybody uses
739 ;; an 8-character tab.
740 (goto-char (point-min))
741 (while (search-forward "\t" nil t)
742 (replace-match " " t t))))))
744 (defvar gnus-simple-splash nil)
746 (defun gnus-group-startup-message (&optional x y)
747 "Insert startup message in current buffer."
748 ;; Insert the message.
751 ((and (fboundp 'find-image)
753 (let ((image (find-image '((:type xpm :file "gnus.xpm")
754 (:type xbm :file "gnus.xbm")))))
756 (newline) ; Have somewhere for cursor to
757 ; go, not stretched over image.
759 (goto-char (point-min))
761 (insert (make-string (/ (max (- (window-width) (or x 35)) 0) 2)
764 (setq gnus-simple-splash nil)
770 _ ___ __ ___ __ _ ___
790 (gnus-indent-rigidly (point-min) (point-max)
791 (/ (max (- (window-width) (or x 46)) 0) 2))
792 (goto-char (point-min))
794 (let* ((pheight (count-lines (point-min) (point-max)))
795 (wheight (window-height))
796 (rest (- wheight pheight)))
797 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
799 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
800 (setq gnus-simple-splash t)))
801 (goto-char (point-min))
802 (setq mode-line-buffer-identification (concat " " gnus-version))
803 (set-buffer-modified-p t))
806 (let ((command (format "%s" this-command)))
807 (if (and (string-match "gnus" command)
808 (not (string-match "gnus-other-frame" command)))
810 (gnus-get-buffer-create gnus-group-buffer))))
818 (defcustom gnus-home-directory "~/"
819 "Directory variable that specifies the \"home\" directory.
820 All other Gnus path variables are initialized from this variable."
824 (defcustom gnus-directory (or (getenv "SAVEDIR")
825 (nnheader-concat gnus-home-directory "News/"))
826 "*Directory variable from which all other Gnus file variables are derived.
828 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
829 This means that other directory variables that are initialized from
830 this variable won't be set properly if you set this variable in `.gnus.el'.
831 Set this variable in `.emacs' instead."
835 (defcustom gnus-default-directory nil
836 "*Default directory for all Gnus buffers."
838 :type '(choice (const :tag "current" nil)
841 ;; Site dependent variables. These variables should be defined in
844 (defvar gnus-default-nntp-server nil
845 "Specify a default NNTP server.
846 This variable should be defined in paths.el, and should never be set
848 If you want to change servers, you should use `gnus-select-method'.
849 See the documentation to that variable.")
851 ;; Don't touch this variable.
852 (defvar gnus-nntp-service "nntp"
853 "NNTP service name (\"nntp\" or 119).
854 This is an obsolete variable, which is scarcely used. If you use an
855 nntp server for your newsgroup and want to change the port number
856 used to 899, you would say something along these lines:
858 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
860 (defcustom gnus-nntpserver-file "/etc/nntpserver"
861 "A file with only the name of the nntp server in it."
866 ;; This function is used to check both the environment variable
867 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
868 ;; an nntp server name default.
869 (defun gnus-getenv-nntpserver ()
870 (or (getenv "NNTPSERVER")
871 (and (file-readable-p gnus-nntpserver-file)
873 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
874 (insert-file-contents gnus-nntpserver-file)
875 (let ((name (buffer-string)))
877 (if (string-match "\\'[ \t\n]*$" name)
880 (kill-buffer (current-buffer))))))))
882 (defcustom gnus-select-method
885 (list 'nntp (or (condition-case nil
886 (gnus-getenv-nntpserver)
888 (when (and gnus-default-nntp-server
889 (not (string= gnus-default-nntp-server "")))
890 gnus-default-nntp-server)
892 (if (or (null gnus-nntp-service)
893 (equal gnus-nntp-service "nntp"))
895 (list gnus-nntp-service)))
897 "Default method for selecting a newsgroup.
898 This variable should be a list, where the first element is how the
899 news is to be fetched, the second is the address.
901 For instance, if you want to get your news via NNTP from
902 \"flab.flab.edu\", you could say:
904 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
906 If you want to use your local spool, say:
908 \(setq gnus-select-method (list 'nnspool (system-name)))
910 If you use this variable, you must set `gnus-nntp-server' to nil.
912 There is a lot more to know about select methods and virtual servers -
913 see the manual for details."
915 :type 'gnus-select-method)
917 (defcustom gnus-message-archive-method
920 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
921 (nnfolder-active-file
922 ,(nnheader-concat message-directory "archive/active"))
923 (nnfolder-get-new-mail nil)
924 (nnfolder-inhibit-expiry t))
925 "*Method used for archiving messages you've sent.
926 This should be a mail method.
928 It's probably not very effective to change this variable once you've
929 run Gnus once. After doing that, you must edit this server from the
933 :type 'gnus-select-method)
935 (defcustom gnus-message-archive-group nil
936 "*Name of the group in which to save the messages you've written.
937 This can either be a string; a list of strings; or an alist
938 of regexps/functions/forms to be evaluated to return a string (or a list
939 of strings). The functions are called with the name of the current
940 group (or nil) as a parameter.
942 If you want to save your mail in one group and the news articles you
943 write in another group, you could say something like:
945 \(setq gnus-message-archive-group
946 '((if (message-news-p)
950 Normally the group names returned by this variable should be
951 unprefixed -- which implicitly means \"store on the archive server\".
952 However, you may wish to store the message on some other server. In
953 that case, just return a fully prefixed name of the group --
954 \"nnml+private:mail.misc\", for instance."
956 :type '(choice (const :tag "none" nil)
961 (defcustom gnus-secondary-servers nil
962 "List of NNTP servers that the user can choose between interactively.
963 To make Gnus query you for a server, you have to give `gnus' a
964 non-numeric prefix - `C-u M-x gnus', in short."
966 :type '(repeat string))
968 (defcustom gnus-nntp-server nil
969 "*The name of the host running the NNTP server.
970 This variable is semi-obsolete. Use the `gnus-select-method'
973 :type '(choice (const :tag "disable" nil)
976 (defcustom gnus-secondary-select-methods nil
977 "A list of secondary methods that will be used for reading news.
978 This is a list where each element is a complete select method (see
979 `gnus-select-method').
981 If, for instance, you want to read your mail with the nnml backend,
982 you could set this variable:
984 \(setq gnus-secondary-select-methods '((nnml \"\")))"
986 :type '(repeat gnus-select-method))
988 (defvar gnus-backup-default-subscribed-newsgroups
989 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
990 "Default default new newsgroups the first time Gnus is run.
991 Should be set in paths.el, and shouldn't be touched by the user.")
993 (defcustom gnus-local-domain nil
994 "Local domain name without a host name.
995 The DOMAINNAME environment variable is used instead if it is defined.
996 If the `system-name' function returns the full Internet name, there is
997 no need to set this variable."
999 :type '(choice (const :tag "default" nil)
1002 (defvar gnus-local-organization nil
1003 "String with a description of what organization (if any) the user belongs to.
1004 Obsolete variable; use `message-user-organization' instead.")
1006 ;; Customization variables
1008 (defcustom gnus-refer-article-method nil
1009 "Preferred method for fetching an article by Message-ID.
1010 If you are reading news from the local spool (with nnspool), fetching
1011 articles by Message-ID is painfully slow. By setting this method to an
1012 nntp method, you might get acceptable results.
1014 The value of this variable must be a valid select method as discussed
1015 in the documentation of `gnus-select-method'.
1017 It can also be a list of select methods, as well as the special symbol
1018 `current', which means to use the current select method. If it is a
1019 list, Gnus will try all the methods in the list until it finds a match."
1021 :type '(choice (const :tag "default" nil)
1022 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1024 (repeat :menu-tag "Try multiple"
1026 :value (current (nnweb "refer" (nnweb-type dejanews)))
1027 (choice :tag "Method"
1029 (const :tag "DejaNews"
1030 (nnweb "refer" (nnweb-type dejanews)))
1031 gnus-select-method))))
1033 (defcustom gnus-group-faq-directory
1034 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1035 "/ftp@sunsite.auc.dk:/pub/usenet/"
1036 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1037 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1038 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1039 "/ftp@rtfm.mit.edu:/pub/usenet/"
1040 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1041 "/ftp@ftp.sunet.se:/pub/usenet/"
1042 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1043 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1044 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1045 "*Directory where the group FAQs are stored.
1046 This will most commonly be on a remote machine, and the file will be
1047 fetched by ange-ftp.
1049 This variable can also be a list of directories. In that case, the
1050 first element in the list will be used by default. The others can
1051 be used when being prompted for a site.
1053 Note that Gnus uses an aol machine as the default directory. If this
1054 feels fundamentally unclean, just think of it as a way to finally get
1055 something of value back from them.
1057 If the default site is too slow, try one of these:
1059 North America: mirrors.aol.com /pub/rtfm/usenet
1060 ftp.seas.gwu.edu /pub/rtfm
1061 rtfm.mit.edu /pub/usenet
1062 Europe: ftp.uni-paderborn.de /pub/FAQ
1063 src.doc.ic.ac.uk /usenet/news-FAQS
1064 ftp.sunet.se /pub/usenet
1065 sunsite.auc.dk /pub/usenet
1066 Asia: nctuccca.edu.tw /USENET/FAQ
1067 hwarang.postech.ac.kr /pub/usenet
1068 ftp.hk.super.net /mirror/faqs"
1069 :group 'gnus-group-various
1070 :type '(choice directory
1071 (repeat directory)))
1073 (defcustom gnus-use-cross-reference t
1074 "*Non-nil means that cross referenced articles will be marked as read.
1075 If nil, ignore cross references. If t, mark articles as read in
1076 subscribed newsgroups. If neither t nor nil, mark as read in all
1079 :type '(choice (const :tag "off" nil)
1080 (const :tag "subscribed" t)
1084 (defcustom gnus-process-mark ?#
1086 :group 'gnus-group-visual
1087 :group 'gnus-summary-marks
1090 (defcustom gnus-asynchronous nil
1091 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1092 :group 'gnus-asynchronous
1095 (defcustom gnus-large-newsgroup 200
1096 "*The number of articles which indicates a large newsgroup.
1097 If the number of articles in a newsgroup is greater than this value,
1098 confirmation is required for selecting the newsgroup."
1099 :group 'gnus-group-select
1102 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1103 "*Non-nil means that the default name of a file to save articles in is the group name.
1104 If it's nil, the directory form of the group name is used instead.
1106 If this variable is a list, and the list contains the element
1107 `not-score', long file names will not be used for score files; if it
1108 contains the element `not-save', long file names will not be used for
1109 saving; and if it contains the element `not-kill', long file names
1110 will not be used for kill files.
1112 Note that the default for this variable varies according to what system
1113 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1114 to nil while on all other systems it defaults to t."
1118 (defcustom gnus-kill-files-directory gnus-directory
1119 "*Name of the directory where kill files will be stored (default \"~/News\")."
1120 :group 'gnus-score-files
1121 :group 'gnus-score-kill
1124 (defcustom gnus-save-score nil
1125 "*If non-nil, save group scoring info."
1126 :group 'gnus-score-various
1130 (defcustom gnus-use-undo t
1131 "*If non-nil, allow undoing in Gnus group mode buffers."
1135 (defcustom gnus-use-adaptive-scoring nil
1136 "*If non-nil, use some adaptive scoring scheme.
1137 If a list, then the values `word' and `line' are meaningful. The
1138 former will perform adaption on individual words in the subject
1139 header while `line' will perform adaption on several headers."
1141 :group 'gnus-score-adapt
1142 :type '(set (const word) (const line)))
1144 (defcustom gnus-use-cache 'passive
1145 "*If nil, Gnus will ignore the article cache.
1146 If `passive', it will allow entering (and reading) articles
1147 explicitly entered into the cache. If anything else, use the
1148 cache to the full extent of the law."
1151 :type '(choice (const :tag "off" nil)
1152 (const :tag "passive" passive)
1153 (const :tag "active" t)))
1155 (defcustom gnus-use-trees nil
1156 "*If non-nil, display a thread tree buffer."
1160 (defcustom gnus-use-grouplens nil
1161 "*If non-nil, use GroupLens ratings."
1165 (defcustom gnus-keep-backlog nil
1166 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1167 If it is a number N, then Gnus will only keep the last N articles
1168 read. If it is neither nil nor a number, Gnus will keep all read
1169 articles. This is not a good idea."
1171 :type '(choice (const :tag "off" nil)
1176 (defcustom gnus-use-nocem nil
1177 "*If non-nil, Gnus will read NoCeM cancel messages."
1181 (defcustom gnus-suppress-duplicates nil
1182 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1186 (defcustom gnus-use-scoring t
1187 "*If non-nil, enable scoring."
1191 (defcustom gnus-use-picons nil
1192 "*If non-nil, display picons in a frame of their own."
1196 (defcustom gnus-summary-prepare-exit-hook
1197 '(gnus-summary-expire-articles)
1198 "*A hook called when preparing to exit from the summary buffer.
1199 It calls `gnus-summary-expire-articles' by default."
1200 :group 'gnus-summary-exit
1203 (defcustom gnus-novice-user t
1204 "*Non-nil means that you are a usenet novice.
1205 If non-nil, verbose messages may be displayed and confirmations may be
1210 (defcustom gnus-expert-user nil
1211 "*Non-nil means that you will never be asked for confirmation about anything.
1212 That doesn't mean *anything* anything; particularly destructive
1213 commands will still require prompting."
1217 (defcustom gnus-interactive-catchup t
1218 "*If non-nil, require your confirmation when catching up a group."
1219 :group 'gnus-group-select
1222 (defcustom gnus-interactive-exit t
1223 "*If non-nil, require your confirmation when exiting Gnus."
1227 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1228 "*Function for extracting address components from a From header.
1229 Two pre-defined function exist: `gnus-extract-address-components',
1230 which is the default, quite fast, and too simplistic solution, and
1231 `mail-extract-address-components', which works much better, but is
1233 :group 'gnus-summary-format
1234 :type '(radio (function-item gnus-extract-address-components)
1235 (function-item mail-extract-address-components)
1236 (function :tag "Other")))
1238 (defcustom gnus-carpal nil
1239 "*If non-nil, display clickable icons."
1243 (defcustom gnus-shell-command-separator ";"
1244 "String used to separate to shell commands."
1248 (defcustom gnus-valid-select-methods
1249 '(("nntp" post address prompt-address physical-address)
1250 ("nnspool" post address)
1251 ("nnvirtual" post-mail virtual prompt-address)
1252 ("nnmbox" mail respool address)
1253 ("nnml" mail respool address)
1254 ("nnmh" mail respool address)
1255 ("nndir" post-mail prompt-address physical-address)
1256 ("nneething" none address prompt-address physical-address)
1257 ("nndoc" none address prompt-address)
1258 ("nnbabyl" mail address respool)
1259 ("nnkiboze" post virtual)
1260 ("nnsoup" post-mail address)
1261 ("nndraft" post-mail)
1262 ("nnfolder" mail respool address)
1263 ("nngateway" post-mail address prompt-address physical-address)
1269 ("nnagent" post-mail)
1270 ("nnimap" post-mail address prompt-address physical-address))
1271 "*An alist of valid select methods.
1272 The first element of each list lists should be a string with the name
1273 of the select method. The other elements may be the category of
1274 this method (i. e., `post', `mail', `none' or whatever) or other
1275 properties that this method has (like being respoolable).
1276 If you implement a new select method, all you should have to change is
1277 this variable. I think."
1279 :type '(repeat (group (string :tag "Name")
1280 (radio-button-choice (const :format "%v " post)
1281 (const :format "%v " mail)
1282 (const :format "%v " none)
1284 (checklist :inline t
1285 (const :format "%v " address)
1286 (const :format "%v " prompt-address)
1287 (const :format "%v " physical-address)
1288 (const :format "%v " virtual)
1291 (defun gnus-redefine-select-method-widget ()
1292 "Recomputes the select-method widget based on the value of
1293 `gnus-valid-select-methods'."
1294 (define-widget 'gnus-select-method 'list
1295 "Widget for entering a select method."
1297 :tag "Select Method"
1298 :args `((choice :tag "Method"
1299 ,@(mapcar (lambda (entry)
1300 (list 'const :format "%v\n"
1301 (intern (car entry))))
1302 gnus-valid-select-methods)
1303 (symbol :tag "other"))
1304 (string :tag "Address")
1305 (repeat :tag "Options"
1309 (sexp :tag "Value"))))
1312 (gnus-redefine-select-method-widget)
1314 (defcustom gnus-updated-mode-lines '(group article summary tree)
1315 "List of buffers that should update their mode lines.
1316 The list may contain the symbols `group', `article', `tree' and
1317 `summary'. If the corresponding symbol is present, Gnus will keep
1318 that mode line updated with information that may be pertinent.
1319 If this variable is nil, screen refresh may be quicker."
1320 :group 'gnus-various
1321 :type '(set (const group)
1326 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1327 (defcustom gnus-mode-non-string-length nil
1328 "*Max length of mode-line non-string contents.
1329 If this is nil, Gnus will take space as is needed, leaving the rest
1330 of the modeline intact. Note that the default of nil is unlikely
1331 to be desirable; see the manual for further details."
1332 :group 'gnus-various
1333 :type '(choice (const nil)
1336 (defcustom gnus-auto-expirable-newsgroups nil
1337 "*Groups in which to automatically mark read articles as expirable.
1338 If non-nil, this should be a regexp that should match all groups in
1339 which to perform auto-expiry. This only makes sense for mail groups."
1340 :group 'nnmail-expire
1341 :type '(choice (const nil)
1344 (defcustom gnus-total-expirable-newsgroups nil
1345 "*Groups in which to perform expiry of all read articles.
1346 Use with extreme caution. All groups that match this regexp will be
1347 expiring - which means that all read articles will be deleted after
1348 \(say) one week. (This only goes for mail groups and the like, of
1350 :group 'nnmail-expire
1351 :type '(choice (const nil)
1354 (defcustom gnus-group-uncollapsed-levels 1
1355 "Number of group name elements to leave alone when making a short group name."
1356 :group 'gnus-group-visual
1359 (defcustom gnus-group-use-permanent-levels nil
1360 "*If non-nil, once you set a level, Gnus will use this level."
1361 :group 'gnus-group-levels
1366 (defcustom gnus-load-hook nil
1367 "A hook run while Gnus is loaded."
1371 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1372 "A hook called to apply kill files to a group.
1373 This hook is intended to apply a kill file to the selected newsgroup.
1374 The function `gnus-apply-kill-file' is called by default.
1376 Since a general kill file is too heavy to use only for a few
1377 newsgroups, I recommend you to use a lighter hook function. For
1378 example, if you'd like to apply a kill file to articles which contains
1379 a string `rmgroup' in subject in newsgroup `control', you can use the
1382 (setq gnus-apply-kill-hook
1385 (cond ((string-match \"control\" gnus-newsgroup-name)
1386 (gnus-kill \"Subject\" \"rmgroup\")
1387 (gnus-expunge \"X\"))))))"
1388 :group 'gnus-score-kill
1389 :options '(gnus-apply-kill-file)
1392 (defcustom gnus-group-change-level-function nil
1393 "Function run when a group level is changed.
1394 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1395 :group 'gnus-group-levels
1400 (defcustom gnus-visual
1401 '(summary-highlight group-highlight article-highlight
1403 summary-menu group-menu article-menu
1404 tree-highlight menu highlight
1405 browse-menu server-menu
1406 page-marker tree-menu binary-menu pick-menu
1408 "*Enable visual features.
1409 If `visual' is disabled, there will be no menus and few faces. Most of
1410 the visual customization options below will be ignored. Gnus will use
1411 less space and be faster as a result.
1413 This variable can also be a list of visual elements to switch on. For
1414 instance, to switch off all visual things except menus, you can say:
1416 (setq gnus-visual '(menu))
1418 Valid elements include `summary-highlight', `group-highlight',
1419 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1420 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1421 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1422 and `grouplens-menu'."
1425 :type '(set (const summary-highlight)
1426 (const group-highlight)
1427 (const article-highlight)
1429 (const summary-menu)
1431 (const article-menu)
1432 (const tree-highlight)
1441 (const grouplens-menu)))
1443 (defcustom gnus-mouse-face
1445 (if (gnus-visual-p 'mouse-face 'highlight)
1446 (if (boundp 'gnus-mouse-face)
1447 (or gnus-mouse-face 'highlight)
1451 "*Face used for group or summary buffer mouse highlighting.
1452 The line beneath the mouse pointer will be highlighted with this
1457 (defcustom gnus-article-save-directory gnus-directory
1458 "*Name of the directory articles will be saved in (default \"~/News\")."
1459 :group 'gnus-article-saving
1462 (defvar gnus-plugged t
1463 "Whether Gnus is plugged or not.")
1465 (defcustom gnus-default-charset 'iso-8859-1
1466 "Default charset assumed to be used when viewing non-ASCII characters.
1467 This variable is overridden on a group-to-group basis by the
1468 gnus-group-charset-alist variable and is only used on groups not
1469 covered by that variable."
1471 :group 'gnus-charset)
1473 (defcustom gnus-default-posting-charset nil
1474 "Default charset assumed to be used when posting non-ASCII characters.
1475 This variable is overridden on a group-to-group basis by the
1476 gnus-group-posting-charset-alist variable and is only used on groups not
1477 covered by that variable.
1478 If nil, no default charset is assumed when posting."
1480 :group 'gnus-charset)
1483 ;;; Internal variables
1485 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1486 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1487 (defvar gnus-original-article-buffer " *Original Article*")
1488 (defvar gnus-newsgroup-name nil)
1489 (defvar gnus-ephemeral-servers nil)
1491 (defvar gnus-agent nil
1492 "Whether we want to use the Gnus agent or not.")
1494 (defvar gnus-command-method nil
1495 "Dynamically bound variable that says what the current backend is.")
1497 (defvar gnus-current-select-method nil
1498 "The current method for selecting a newsgroup.")
1500 (defvar gnus-tree-buffer "*Tree*"
1501 "Buffer where Gnus thread trees are displayed.")
1504 (defvar gnus-use-generic-from nil)
1506 ;; Variable holding the user answers to all method prompts.
1507 (defvar gnus-method-history nil)
1509 ;; Variable holding the user answers to all mail method prompts.
1510 (defvar gnus-mail-method-history nil)
1512 ;; Variable holding the user answers to all group prompts.
1513 (defvar gnus-group-history nil)
1515 (defvar gnus-server-alist nil
1516 "List of available servers.")
1518 (defcustom gnus-cache-directory
1519 (nnheader-concat gnus-directory "cache/")
1520 "*The directory where cached articles will be stored."
1524 (defvar gnus-predefined-server-alist
1527 (nnspool-spool-directory ,gnus-cache-directory)
1528 (nnspool-nov-directory ,gnus-cache-directory)
1529 (nnspool-active-file
1530 ,(nnheader-concat gnus-cache-directory "active"))))
1531 "List of predefined (convenience) servers.")
1533 (defvar gnus-topic-indentation "");; Obsolete variable.
1535 (defconst gnus-article-mark-lists
1536 '((marked . tick) (replied . reply)
1537 (expirable . expire) (killed . killed)
1538 (bookmarks . bookmark) (dormant . dormant)
1539 (scored . score) (saved . save)
1540 (cached . cache) (downloadable . download)
1541 (unsendable . unsend)))
1543 (defvar gnus-headers-retrieved-by nil)
1544 (defvar gnus-article-reply nil)
1545 (defvar gnus-override-method nil)
1546 (defvar gnus-article-check-size nil)
1547 (defvar gnus-opened-servers nil)
1549 (defvar gnus-current-kill-article nil)
1551 (defvar gnus-have-read-active-file nil)
1553 (defconst gnus-maintainer
1554 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1555 "The mail address of the Gnus maintainers.")
1557 (defvar gnus-info-nodes
1558 '((gnus-group-mode "(gnus)The Group Buffer")
1559 (gnus-summary-mode "(gnus)The Summary Buffer")
1560 (gnus-article-mode "(gnus)The Article Buffer")
1561 (gnus-server-mode "(gnus)The Server Buffer")
1562 (gnus-browse-mode "(gnus)Browse Foreign Server")
1563 (gnus-tree-mode "(gnus)Tree Display"))
1564 "Alist of major modes and related Info nodes.")
1566 (defvar gnus-group-buffer "*Group*")
1567 (defvar gnus-summary-buffer "*Summary*")
1568 (defvar gnus-article-buffer "*Article*")
1569 (defvar gnus-server-buffer "*Server*")
1571 (defvar gnus-slave nil
1572 "Whether this Gnus is a slave or not.")
1574 (defvar gnus-batch-mode nil
1575 "Whether this Gnus is running in batch mode or not.")
1577 (defvar gnus-variable-list
1578 '(gnus-newsrc-options gnus-newsrc-options-n
1579 gnus-newsrc-last-checked-date
1580 gnus-newsrc-alist gnus-server-alist
1581 gnus-killed-list gnus-zombie-list
1582 gnus-topic-topology gnus-topic-alist
1584 "Gnus variables saved in the quick startup file.")
1586 (defvar gnus-newsrc-alist nil
1587 "Assoc list of read articles.
1588 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1590 (defvar gnus-newsrc-hashtb nil
1591 "Hashtable of gnus-newsrc-alist.")
1593 (defvar gnus-killed-list nil
1594 "List of killed newsgroups.")
1596 (defvar gnus-killed-hashtb nil
1597 "Hash table equivalent of gnus-killed-list.")
1599 (defvar gnus-zombie-list nil
1600 "List of almost dead newsgroups.")
1602 (defvar gnus-description-hashtb nil
1603 "Descriptions of newsgroups.")
1605 (defvar gnus-list-of-killed-groups nil
1606 "List of newsgroups that have recently been killed by the user.")
1608 (defvar gnus-active-hashtb nil
1609 "Hashtable of active articles.")
1611 (defvar gnus-moderated-hashtb nil
1612 "Hashtable of moderated newsgroups.")
1614 ;; Save window configuration.
1615 (defvar gnus-prev-winconf nil)
1617 (defvar gnus-reffed-article-number nil)
1619 ;;; Let the byte-compiler know that we know about this variable.
1620 (defvar rmail-default-rmail-file)
1622 (defvar gnus-dead-summary nil)
1624 ;;; End of variables.
1626 ;; Define some autoload functions Gnus might use.
1629 ;; This little mapcar goes through the list below and marks the
1630 ;; symbols in question as autoloaded functions.
1633 (let ((interactive (nth 1 (memq ':interactive package))))
1637 (when (consp function)
1638 (setq keymap (car (memq 'keymap function)))
1639 (setq function (car function)))
1640 (unless (fboundp function)
1641 (autoload function (car package) nil interactive keymap))))
1642 (if (eq (nth 1 package) ':interactive)
1645 '(("info" :interactive t Info-goto-node)
1646 ("pp" pp pp-to-string pp-eval-expression)
1647 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1648 ("ps-print" ps-print-preprint)
1649 ("browse-url" :interactive t browse-url)
1650 ("message" :interactive t
1651 message-send-and-exit message-yank-original)
1652 ("babel" babel-as-string)
1653 ("nnmail" nnmail-split-fancy nnmail-article-group)
1654 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1655 ("rmailout" rmail-output rmail-output-to-rmail-file)
1656 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1657 rmail-show-message rmail-summary-exists
1658 rmail-select-summary rmail-update-summary)
1659 ("gnus-audio" :interactive t gnus-audio-play)
1660 ("gnus-xmas" gnus-xmas-splash)
1661 ("gnus-soup" :interactive t
1662 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1663 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1664 ("nnsoup" nnsoup-pack-replies)
1665 ("score-mode" :interactive t gnus-score-mode)
1666 ("gnus-mh" gnus-summary-save-article-folder
1667 gnus-Folder-save-name gnus-folder-save-name)
1668 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1669 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1670 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1671 gnus-demon-add-disconnection gnus-demon-add-handler
1672 gnus-demon-remove-handler)
1673 ("gnus-demon" :interactive t
1674 gnus-demon-init gnus-demon-cancel)
1675 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1676 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1677 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1678 gnus-nocem-unwanted-article-p)
1679 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1680 gnus-server-server-name)
1681 ("gnus-srvr" gnus-browse-foreign-server)
1682 ("gnus-cite" :interactive t
1683 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1684 gnus-article-hide-citation gnus-article-fill-cited-article
1685 gnus-article-hide-citation-in-followups)
1686 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1687 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1688 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1689 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1690 gnus-cache-possibly-remove-articles gnus-cache-request-article
1691 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1692 gnus-cache-enter-remove-article gnus-cached-article-p
1693 gnus-cache-open gnus-cache-close gnus-cache-update-article
1694 gnus-cache-articles-in-group)
1695 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1696 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1697 ("gnus-score" :interactive t
1698 gnus-summary-increase-score gnus-summary-set-score
1699 gnus-summary-raise-thread gnus-summary-raise-same-subject
1700 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1701 gnus-summary-lower-thread gnus-summary-lower-same-subject
1702 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1703 gnus-summary-current-score gnus-score-delta-default
1704 gnus-score-flush-cache gnus-score-close
1705 gnus-possibly-score-headers gnus-score-followup-article
1706 gnus-score-followup-thread)
1708 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1709 gnus-current-score-file-nondirectory gnus-score-adaptive
1710 gnus-score-find-trace gnus-score-file-name)
1711 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1712 ("gnus-topic" :interactive t gnus-topic-mode)
1713 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1714 gnus-subscribe-topics)
1715 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1716 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1717 ("gnus-uu" :interactive t
1718 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1719 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1720 gnus-uu-mark-by-regexp gnus-uu-mark-all
1721 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1722 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1723 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1724 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1725 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1726 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1727 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1728 gnus-uu-mark-over gnus-uu-post-news)
1729 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1730 ("gnus-msg" (gnus-summary-send-map keymap)
1731 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1732 ("gnus-msg" :interactive t
1733 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1734 gnus-summary-followup gnus-summary-followup-with-original
1735 gnus-summary-cancel-article gnus-summary-supersede-article
1736 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1737 gnus-summary-mail-forward gnus-summary-mail-other-window
1738 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1739 gnus-summary-wide-reply gnus-summary-followup-to-mail
1740 gnus-summary-followup-to-mail-with-original gnus-bug
1741 gnus-summary-wide-reply-with-original
1742 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1743 gnus-summary-post-forward)
1744 ("gnus-picon" :interactive t gnus-article-display-picons
1745 gnus-group-display-picons gnus-picons-article-display-x-face
1746 gnus-picons-display-x-face)
1747 ("gnus-picon" gnus-picons-buffer-name)
1748 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1749 gnus-grouplens-mode)
1750 ("smiley" :interactive t gnus-smiley-display)
1751 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1752 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1753 gnus-list-of-unread-articles gnus-list-of-read-articles
1754 gnus-offer-save-summaries gnus-make-thread-indent-array
1755 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1756 gnus-summary-skip-intangible gnus-summary-article-number
1757 gnus-data-header gnus-data-find)
1758 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1759 gnus-group-list-groups gnus-group-first-unread-group
1760 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1761 gnus-group-setup-buffer gnus-group-get-new-news
1762 gnus-group-make-help-group gnus-group-update-group
1763 gnus-group-iterate gnus-group-group-name)
1764 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1765 gnus-backlog-remove-article)
1766 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1767 gnus-article-prepare gnus-article-set-window-start
1768 gnus-article-next-page gnus-article-prev-page
1769 gnus-request-article-this-buffer gnus-article-mode
1770 gnus-article-setup-buffer gnus-narrow-to-page
1771 gnus-article-delete-invisible-text gnus-treat-article)
1772 ("gnus-art" :interactive t
1773 gnus-article-hide-headers gnus-article-hide-boring-headers
1774 gnus-article-treat-overstrike
1775 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1776 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1777 gnus-article-de-base64-unreadable
1778 gnus-article-decode-HZ
1779 gnus-article-wash-html
1780 gnus-article-hide-pgp
1781 gnus-article-hide-pem gnus-article-hide-signature
1782 gnus-article-strip-leading-blank-lines gnus-article-date-local
1783 gnus-article-date-original gnus-article-date-lapsed
1784 gnus-article-show-all-headers
1785 gnus-article-edit-mode gnus-article-edit-article
1786 gnus-article-edit-done gnus-article-decode-encoded-words
1787 gnus-start-date-timer gnus-stop-date-timer
1788 gnus-mime-view-all-parts)
1789 ("gnus-int" gnus-request-type)
1790 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1791 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1792 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1793 gnus-dup-enter-articles)
1794 ("gnus-range" gnus-copy-sequence)
1795 ("gnus-eform" gnus-edit-form)
1796 ("gnus-move" :interactive t
1797 gnus-group-move-group-to-server gnus-change-server)
1798 ("gnus-logic" gnus-score-advanced)
1799 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1800 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1801 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1802 gnus-async-halt-prefetch)
1803 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1804 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1805 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1806 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1807 ("gnus-agent" :interactive t
1808 gnus-unplugged gnus-agentize gnus-agent-batch)
1809 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1810 gnus-summary-save-article-vm)
1811 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1812 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1813 ("gnus-mlspl" :interactive t gnus-group-split-setup
1814 gnus-group-split-update))))
1816 ;;; gnus-sum.el thingies
1819 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1820 "*The format specification of the lines in the summary buffer.
1822 It works along the same lines as a normal formatting string,
1823 with some simple extensions.
1825 %N Article number, left padded with spaces (string)
1827 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1828 %n Name of the poster (string)
1829 %a Extracted name of the poster (string)
1830 %A Extracted address of the poster (string)
1831 %F Contents of the From: header (string)
1832 %f Contents of the From: or To: headers (string)
1833 %x Contents of the Xref: header (string)
1834 %D Date of the article (string)
1835 %d Date of the article (string) in DD-MMM format
1836 %M Message-id of the article (string)
1837 %r References of the article (string)
1838 %c Number of characters in the article (integer)
1839 %L Number of lines in the article (integer)
1840 %I Indentation based on thread level (a string of spaces)
1841 %T A string with two possible values: 80 spaces if the article
1842 is on thread level two or larger and 0 spaces on level one
1843 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1844 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1845 %[ Opening bracket (character, \"[\" or \"<\")
1846 %] Closing bracket (character, \"]\" or \">\")
1847 %> Spaces of length thread-level (string)
1848 %< Spaces of length (- 20 thread-level) (string)
1849 %i Article score (number)
1850 %z Article zcore (character)
1851 %t Number of articles under the current thread (number).
1852 %e Whether the thread is empty or not (character).
1853 %l GroupLens score (string).
1854 %V Total thread score (number).
1855 %P The line number (number).
1856 %O Download mark (character).
1857 %u User defined specifier. The next character in the format string should
1858 be a letter. Gnus will call the function gnus-user-format-function-X,
1859 where X is the letter following %u. The function will be passed the
1860 current header as argument. The function should return a string, which
1861 will be inserted into the summary just like information from any other
1864 Text between %( and %) will be highlighted with `gnus-mouse-face'
1865 when the mouse point is placed inside the area. There can only be one
1868 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1869 with care. For reasons of efficiency, Gnus will compute what column
1870 these characters will end up in, and \"hard-code\" that. This means that
1871 it is invalid to have these specs after a variable-length spec. Well,
1872 you might not be arrested, but your summary buffer will look strange,
1873 which is bad enough.
1875 The smart choice is to have these specs as for to the left as
1878 This restriction may disappear in later versions of Gnus."
1880 :group 'gnus-summary-format)
1883 ;;; Skeleton keymaps
1886 (defun gnus-suppress-keymap (keymap)
1887 (suppress-keymap keymap)
1888 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1890 (define-key keymap (pop keys) 'undefined))))
1892 (defvar gnus-article-mode-map
1893 (let ((keymap (make-sparse-keymap)))
1894 (gnus-suppress-keymap keymap)
1896 (defvar gnus-summary-mode-map
1897 (let ((keymap (make-keymap)))
1898 (gnus-suppress-keymap keymap)
1900 (defvar gnus-group-mode-map
1901 (let ((keymap (make-keymap)))
1902 (gnus-suppress-keymap keymap)
1907 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1908 ;; If you want the cursor to go somewhere else, set these two
1909 ;; functions in some startup hook to whatever you want.
1910 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1911 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1913 ;;; Various macros and substs.
1915 (defun gnus-header-from (header)
1916 (mail-header-from header))
1918 (defmacro gnus-gethash (string hashtable)
1919 "Get hash value of STRING in HASHTABLE."
1920 `(symbol-value (intern-soft ,string ,hashtable)))
1922 (defmacro gnus-sethash (string value hashtable)
1923 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1924 `(set (intern ,string ,hashtable) ,value))
1925 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1927 (defmacro gnus-group-unread (group)
1928 "Get the currently computed number of unread articles in GROUP."
1929 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1931 (defmacro gnus-group-entry (group)
1932 "Get the newsrc entry for GROUP."
1933 `(gnus-gethash ,group gnus-newsrc-hashtb))
1935 (defmacro gnus-active (group)
1936 "Get active info on GROUP."
1937 `(gnus-gethash ,group gnus-active-hashtb))
1939 (defmacro gnus-set-active (group active)
1940 "Set GROUP's active info."
1941 `(gnus-sethash ,group ,active gnus-active-hashtb))
1943 ;; Info access macros.
1945 (defmacro gnus-info-group (info)
1947 (defmacro gnus-info-rank (info)
1949 (defmacro gnus-info-read (info)
1951 (defmacro gnus-info-marks (info)
1953 (defmacro gnus-info-method (info)
1955 (defmacro gnus-info-params (info)
1958 (defmacro gnus-info-level (info)
1959 `(let ((rank (gnus-info-rank ,info)))
1963 (defmacro gnus-info-score (info)
1964 `(let ((rank (gnus-info-rank ,info)))
1965 (or (and (consp rank) (cdr rank)) 0)))
1967 (defmacro gnus-info-set-group (info group)
1968 `(setcar ,info ,group))
1969 (defmacro gnus-info-set-rank (info rank)
1970 `(setcar (nthcdr 1 ,info) ,rank))
1971 (defmacro gnus-info-set-read (info read)
1972 `(setcar (nthcdr 2 ,info) ,read))
1973 (defmacro gnus-info-set-marks (info marks &optional extend)
1975 `(gnus-info-set-entry ,info ,marks 3)
1976 `(setcar (nthcdr 3 ,info) ,marks)))
1977 (defmacro gnus-info-set-method (info method &optional extend)
1979 `(gnus-info-set-entry ,info ,method 4)
1980 `(setcar (nthcdr 4 ,info) ,method)))
1981 (defmacro gnus-info-set-params (info params &optional extend)
1983 `(gnus-info-set-entry ,info ,params 5)
1984 `(setcar (nthcdr 5 ,info) ,params)))
1986 (defun gnus-info-set-entry (info entry number)
1987 ;; Extend the info until we have enough elements.
1988 (while (<= (length info) number)
1989 (nconc info (list nil)))
1991 (setcar (nthcdr number info) entry))
1993 (defmacro gnus-info-set-level (info level)
1994 `(let ((rank (cdr ,info)))
1995 (if (consp (car rank))
1996 (setcar (car rank) ,level)
1997 (setcar rank ,level))))
1998 (defmacro gnus-info-set-score (info score)
1999 `(let ((rank (cdr ,info)))
2000 (if (consp (car rank))
2001 (setcdr (car rank) ,score)
2002 (setcar rank (cons (car rank) ,score)))))
2004 (defmacro gnus-get-info (group)
2005 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2007 ;; Byte-compiler warning.
2008 (defvar gnus-visual)
2009 ;; Find out whether the gnus-visual TYPE is wanted.
2010 (defun gnus-visual-p (&optional type class)
2011 (and gnus-visual ; Has to be non-nil, at least.
2012 (if (not type) ; We don't care about type.
2014 (if (listp gnus-visual) ; It's a list, so we check it.
2015 (or (memq type gnus-visual)
2016 (memq class gnus-visual))
2019 ;;; Load the compatability functions.
2028 (defvar gnus-shutdown-alist nil)
2030 (defun gnus-add-shutdown (function &rest symbols)
2031 "Run FUNCTION whenever one of SYMBOLS is shut down."
2032 (push (cons function symbols) gnus-shutdown-alist))
2034 (defun gnus-shutdown (symbol)
2035 "Shut down everything that waits for SYMBOL."
2036 (let ((alist gnus-shutdown-alist)
2038 (while (setq entry (pop alist))
2039 (when (memq symbol (cdr entry))
2040 (funcall (car entry))))))
2044 ;;; Gnus Utility Functions
2048 (defmacro gnus-string-or (&rest strings)
2049 "Return the first element of STRINGS that is a non-blank string.
2050 STRINGS will be evaluated in normal `or' order."
2051 `(gnus-string-or-1 ',strings))
2053 (defun gnus-string-or-1 (strings)
2056 (setq string (eval (pop strings)))
2057 (if (string-match "^[ \t]*$" string)
2059 (setq strings nil)))
2062 (defun gnus-version (&optional arg)
2063 "Version number of this version of Gnus.
2064 If ARG, insert string at point."
2067 (insert (message gnus-version))
2068 (message gnus-version)))
2070 (defun gnus-continuum-version (version)
2071 "Return VERSION as a floating point number."
2072 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2073 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2074 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2075 (number (match-string 2 version))
2077 (unless (string-match
2078 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2079 (error "Invalid version string: %s" version))
2080 (setq major (string-to-number (match-string 1 number))
2081 minor (string-to-number (match-string 2 number))
2082 least (if (match-beginning 3)
2083 (string-to-number (match-string 3 number))
2087 (format "%s00%02d%02d"
2088 (if (member alpha '("(ding)" "d"))
2092 (- (mm-char-int (aref (downcase alpha) 0))
2096 (format "%d.%02d%02d" major minor least))))))
2098 (defun gnus-info-find-node ()
2099 "Find Info documentation of Gnus."
2101 ;; Enlarge info window if needed.
2102 (let (gnus-info-buffer)
2103 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2104 (setq gnus-info-buffer (current-buffer))
2105 (gnus-configure-windows 'info)))
2108 ;;; gnus-interactive
2111 (defvar gnus-current-prefix-symbol nil
2112 "Current prefix symbol.")
2114 (defvar gnus-current-prefix-symbols nil
2115 "List of current prefix symbols.")
2117 (defun gnus-interactive (string &optional params)
2118 "Return a list that can be fed to `interactive'.
2119 See `interactive' for full documentation.
2121 Adds the following specs:
2123 y -- The current symbolic prefix.
2124 Y -- A list of the current symbolic prefix(es).
2125 A -- Article number.
2126 H -- Article header.
2130 (while (< i (length string))
2131 (string-match ".\\([^\n]*\\)\n?" string i)
2132 (setq c (aref string i))
2134 (setq prompt (match-string 1 string)))
2135 (setq i (match-end 0))
2136 ;; We basically emulate just about everything that
2137 ;; `interactive' does, but add the specs listed above.
2141 (completing-read prompt obarray 'fboundp t))
2143 (read-buffer prompt (current-buffer) t))
2145 (read-buffer prompt (other-buffer (current-buffer))))
2149 (completing-read prompt obarray 'commandp t))
2153 (read-file-name prompt nil default-directory 'lambda))
2155 (read-file-name prompt nil nil 'lambda))
2157 (read-file-name prompt))
2159 (read-key-sequence prompt))
2161 (error "Not implemented spec"))
2163 (error "Not implemented spec"))
2167 (error "Not implemented spec"))
2169 (string-to-number (read-from-minibuffer prompt)))
2171 (prefix-numeric-value current-prefix-arg))
2177 (read-string prompt))
2179 (intern (read-string prompt)))
2181 (read-variable prompt))
2183 (read-minibuffer prompt))
2185 (eval-minibuffer prompt))
2186 ;; And here the new specs come.
2188 gnus-current-prefix-symbol)
2190 gnus-current-prefix-symbols)
2192 (gnus-group-group-name))
2194 (gnus-summary-skip-intangible)
2195 (or (get-text-property (point) 'gnus-number)
2196 (gnus-summary-last-subject)))
2198 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2200 (error "Non-implemented spec")))
2204 (push (if (< (point) (mark) (point) (mark))) out)
2205 (push (if (> (point) (mark) (point) (mark))) out))))
2206 (setq out (delq 'gnus-prefix-nil out))
2209 (defun gnus-symbolic-argument (&optional arg)
2210 "Read a symbolic argument and a command, and then execute command."
2212 (let* ((in-command (this-command-keys))
2213 (command in-command)
2214 gnus-current-prefix-symbols
2215 gnus-current-prefix-symbol
2217 (while (equal in-command command)
2218 (message "%s-" (key-description (this-command-keys)))
2219 (push (intern (char-to-string (read-char))) syms)
2220 (setq command (read-key-sequence nil t)))
2221 (setq gnus-current-prefix-symbols (nreverse syms)
2222 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2223 (call-interactively (key-binding command t))))
2225 ;;; More various functions.
2227 (defsubst gnus-check-backend-function (func group)
2228 "Check whether GROUP supports function FUNC.
2229 GROUP can either be a string (a group name) or a select method."
2231 (let ((method (if (stringp group)
2232 (car (gnus-find-method-for-group group))
2234 (unless (featurep method)
2236 (fboundp (intern (format "%s-%s" method func))))))
2238 (defun gnus-group-read-only-p (&optional group)
2239 "Check whether GROUP supports editing or not.
2240 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2241 that that variable is buffer-local to the summary buffers."
2242 (let ((group (or group gnus-newsgroup-name)))
2243 (not (gnus-check-backend-function 'request-replace-article group))))
2245 (defun gnus-group-total-expirable-p (group)
2246 "Check whether GROUP is total-expirable or not."
2247 (let ((params (gnus-group-find-parameter group))
2250 ((memq 'total-expire params)
2252 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2254 (gnus-total-expirable-newsgroups ; Check var.
2255 (string-match gnus-total-expirable-newsgroups group)))))
2257 (defun gnus-group-auto-expirable-p (group)
2258 "Check whether GROUP is auto-expirable or not."
2259 (let ((params (gnus-group-find-parameter group))
2262 ((memq 'auto-expire params)
2264 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2266 (gnus-auto-expirable-newsgroups ; Check var.
2267 (string-match gnus-auto-expirable-newsgroups group)))))
2269 (defun gnus-virtual-group-p (group)
2270 "Say whether GROUP is virtual or not."
2271 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2272 gnus-valid-select-methods)))
2274 (defun gnus-news-group-p (group &optional article)
2275 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2276 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2277 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2278 (if (or (null article)
2279 (not (< article 0)))
2280 (eq (gnus-request-type group article) 'news)
2281 (if (not (vectorp article))
2283 ;; It's a real article.
2284 (eq (gnus-request-type group (mail-header-id article))
2287 ;; Returns a list of writable groups.
2288 (defun gnus-writable-groups ()
2289 (let ((alist gnus-newsrc-alist)
2291 (while (setq group (car (pop alist)))
2292 (unless (gnus-group-read-only-p group)
2293 (push group groups)))
2296 ;; Check whether to use long file names.
2297 (defun gnus-use-long-file-name (symbol)
2298 ;; The variable has to be set...
2299 (and gnus-use-long-file-name
2300 ;; If it isn't a list, then we return t.
2301 (or (not (listp gnus-use-long-file-name))
2302 ;; If it is a list, and the list contains `symbol', we
2304 (not (memq symbol gnus-use-long-file-name)))))
2306 ;; Generate a unique new group name.
2307 (defun gnus-generate-new-group-name (leaf)
2310 (while (gnus-gethash name gnus-newsrc-hashtb)
2311 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2314 (defun gnus-ephemeral-group-p (group)
2315 "Say whether GROUP is ephemeral or not."
2316 (gnus-group-get-parameter group 'quit-config t))
2318 (defun gnus-group-quit-config (group)
2319 "Return the quit-config of GROUP."
2320 (gnus-group-get-parameter group 'quit-config t))
2322 (defun gnus-kill-ephemeral-group (group)
2323 "Remove ephemeral GROUP from relevant structures."
2324 (gnus-sethash group nil gnus-newsrc-hashtb))
2326 (defun gnus-simplify-mode-line ()
2327 "Make mode lines a bit simpler."
2328 (setq mode-line-modified (cdr gnus-mode-line-modified))
2329 (when (listp mode-line-format)
2330 (make-local-variable 'mode-line-format)
2331 (setq mode-line-format (copy-sequence mode-line-format))
2332 (when (equal (nth 3 mode-line-format) " ")
2333 (setcar (nthcdr 3 mode-line-format) " "))))
2335 ;;; Servers and groups.
2337 (defsubst gnus-server-add-address (method)
2338 (let ((method-name (symbol-name (car method))))
2339 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2340 (not (assq (intern (concat method-name "-address")) method))
2341 (memq 'physical-address (assq (car method)
2342 gnus-valid-select-methods)))
2343 (append method (list (list (intern (concat method-name "-address"))
2347 (defsubst gnus-server-get-method (group method)
2348 ;; Input either a server name, and extended server name, or a
2349 ;; select method, and return a select method.
2350 (cond ((stringp method)
2351 (gnus-server-to-method method))
2352 ((equal method gnus-select-method)
2354 ((and (stringp (car method))
2356 (gnus-server-extend-method group method))
2359 (equal (cadr method) ""))
2362 (gnus-server-add-address method))))
2364 (defun gnus-server-to-method (server)
2365 "Map virtual server names to select methods."
2367 ;; Is this a method, perhaps?
2368 (and server (listp server) server)
2369 ;; Perhaps this is the native server?
2370 (and (equal server "native") gnus-select-method)
2371 ;; It should be in the server alist.
2372 (cdr (assoc server gnus-server-alist))
2373 ;; It could be in the predefined server alist.
2374 (cdr (assoc server gnus-predefined-server-alist))
2375 ;; If not, we look through all the opened server
2376 ;; to see whether we can find it there.
2377 (let ((opened gnus-opened-servers))
2379 (not (equal server (format "%s:%s" (caaar opened)
2383 ;; It could be a named method, search all servers
2384 (let ((servers gnus-secondary-select-methods))
2386 (not (equal server (format "%s:%s" (caar servers)
2391 (defmacro gnus-method-equal (ss1 ss2)
2392 "Say whether two servers are equal."
2396 (and (= (length s1) (length s2))
2398 (while (and s1 (member (car s1) s2))
2402 (defun gnus-methods-equal-p (m1 m2)
2403 (let ((m1 (or m1 gnus-select-method))
2404 (m2 (or m2 gnus-select-method)))
2406 (and (eq (car m1) (car m2))
2407 (or (not (memq 'address (assoc (symbol-name (car m1))
2408 gnus-valid-select-methods)))
2409 (equal (nth 1 m1) (nth 1 m2)))))))
2411 (defun gnus-server-equal (m1 m2)
2412 "Say whether two methods are equal."
2413 (let ((m1 (cond ((null m1) gnus-select-method)
2414 ((stringp m1) (gnus-server-to-method m1))
2416 (m2 (cond ((null m2) gnus-select-method)
2417 ((stringp m2) (gnus-server-to-method m2))
2419 (gnus-method-equal m1 m2)))
2421 (defun gnus-servers-using-backend (backend)
2422 "Return a list of known servers using BACKEND."
2423 (let ((opened gnus-opened-servers)
2426 (when (eq backend (caaar opened))
2427 (push (caar opened) out))
2431 (defun gnus-archive-server-wanted-p ()
2432 "Say whether the user wants to use the archive server."
2434 ((or (not gnus-message-archive-method)
2435 (not gnus-message-archive-group))
2437 ((and gnus-message-archive-method gnus-message-archive-group)
2440 (let ((active (cadr (assq 'nnfolder-active-file
2441 gnus-message-archive-method))))
2443 (file-exists-p active))))))
2445 (defun gnus-group-prefixed-name (group method)
2446 "Return the whole name from GROUP and METHOD."
2447 (and (stringp method) (setq method (gnus-server-to-method method)))
2448 (if (or (not method)
2449 (gnus-server-equal method "native"))
2451 (concat (format "%s" (car method))
2453 (or (assoc (format "%s" (car method))
2454 (gnus-methods-using 'address))
2455 (gnus-server-equal method gnus-message-archive-method))
2457 (not (string= (nth 1 method) "")))
2458 (concat "+" (nth 1 method)))
2461 (defun gnus-group-real-prefix (group)
2462 "Return the prefix of the current group name."
2463 (if (string-match "^[^:]+:" group)
2464 (substring group 0 (match-end 0))
2467 (defun gnus-group-method (group)
2468 "Return the server or method used for selecting GROUP.
2469 You should probably use `gnus-find-method-for-group' instead."
2470 (let ((prefix (gnus-group-real-prefix group)))
2471 (if (equal prefix "")
2473 (let ((servers gnus-opened-servers)
2475 backend possible found)
2476 (if (string-match "^[^\\+]+\\+" prefix)
2477 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2478 server (substring prefix (match-end 0) (1- (length prefix))))
2479 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2481 (when (eq (caaar servers) backend)
2482 (setq possible (caar servers))
2483 (when (equal (cadaar servers) server)
2484 (setq found (caar servers))))
2486 (or (car (rassoc found gnus-server-alist))
2488 (car (rassoc possible gnus-server-alist))
2490 (list backend server))))))
2492 (defsubst gnus-native-method-p (method)
2493 "Return whether METHOD is the native select method."
2494 (gnus-method-equal method gnus-select-method))
2496 (defsubst gnus-secondary-method-p (method)
2497 "Return whether METHOD is a secondary select method."
2498 (let ((methods gnus-secondary-select-methods)
2499 (gmethod (gnus-server-get-method nil method)))
2501 (not (gnus-method-equal
2502 (gnus-server-get-method nil (car methods))
2504 (setq methods (cdr methods)))
2507 (defun gnus-method-simplify (method)
2508 "Return the shortest uniquely identifying string or method for METHOD."
2509 (cond ((stringp method)
2511 ((gnus-native-method-p method)
2513 ((gnus-secondary-method-p method)
2514 (format "%s:%s" (nth 0 method) (nth 1 method)))
2518 (defun gnus-groups-from-server (server)
2519 "Return a list of all groups that are fetched from SERVER."
2520 (let ((alist (cdr gnus-newsrc-alist))
2522 (while (setq info (pop alist))
2523 (when (gnus-server-equal (gnus-info-method info) server)
2524 (push (gnus-info-group info) groups)))
2525 (sort groups 'string<)))
2527 (defun gnus-group-foreign-p (group)
2528 "Say whether a group is foreign or not."
2529 (and (not (gnus-group-native-p group))
2530 (not (gnus-group-secondary-p group))))
2532 (defun gnus-group-native-p (group)
2533 "Say whether the group is native or not."
2534 (not (string-match ":" group)))
2536 (defun gnus-group-secondary-p (group)
2537 "Say whether the group is secondary or not."
2538 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2540 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2541 "Return the group parameters for GROUP.
2542 If SYMBOL, return the value of that symbol in the group parameters."
2544 (set-buffer gnus-group-buffer)
2545 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2547 (gnus-group-parameter-value parameters symbol allow-list)
2550 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2551 "Return the group parameters for GROUP.
2552 If SYMBOL, return the value of that symbol in the group parameters.
2553 Most functions should use `gnus-group-find-parameter', which
2554 also examines the topic parameters."
2555 (let ((params (gnus-info-params (gnus-get-info group))))
2557 (gnus-group-parameter-value params symbol allow-list)
2560 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2561 "Return the value of SYMBOL in group PARAMS."
2562 ;; We only wish to return group parameters (dotted lists) and
2563 ;; not local variables, which may have the same names.
2564 ;; But first we handle single elements...
2565 (or (car (memq symbol params))
2569 (while (setq elem (pop params))
2570 (when (and (consp elem)
2571 (eq (car elem) symbol)
2574 (throw 'found (cdr elem))))))))
2576 (defun gnus-group-add-parameter (group param)
2577 "Add parameter PARAM to GROUP."
2578 (let ((info (gnus-get-info group)))
2580 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2581 ;; Cons the new param to the old one and update.
2582 (gnus-group-set-info (cons param (gnus-info-params info))
2585 (defun gnus-group-set-parameter (group name value)
2586 "Set parameter NAME to VALUE in GROUP."
2587 (let ((info (gnus-get-info group)))
2589 (gnus-group-remove-parameter group name)
2590 (let ((old-params (gnus-info-params info))
2591 (new-params (list (cons name value))))
2593 (when (or (not (listp (car old-params)))
2594 (not (eq (caar old-params) name)))
2595 (setq new-params (append new-params (list (car old-params)))))
2596 (setq old-params (cdr old-params)))
2597 (gnus-group-set-info new-params group 'params)))))
2599 (defun gnus-group-remove-parameter (group name)
2600 "Remove parameter NAME from GROUP."
2601 (let ((info (gnus-get-info group)))
2603 (let ((params (gnus-info-params info)))
2605 (setq params (delq name params))
2606 (while (assq name params)
2607 (gnus-pull name params))
2608 (gnus-info-set-params info params))))))
2610 (defun gnus-group-add-score (group &optional score)
2611 "Add SCORE to the GROUP score.
2612 If SCORE is nil, add 1 to the score of GROUP."
2613 (let ((info (gnus-get-info group)))
2615 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2617 (defun gnus-short-group-name (group &optional levels)
2618 "Collapse GROUP name LEVELS.
2619 Select methods are stripped and any remote host name is stripped down to
2620 just the host name."
2626 gnus-group-uncollapsed-levels
2628 (while (string-match "\\." group skip)
2629 (setq skip (match-end 0)
2632 ;; Separate foreign select method from group name and collapse.
2633 ;; If method contains a server, collapse to non-domain server name,
2634 ;; otherwise collapse to select method.
2635 (let* ((colon (string-match ":" group))
2636 (server (and colon (substring group 0 colon)))
2637 (plus (and server (string-match "+" server))))
2640 (setq foreign (substring server (+ 1 plus)
2641 (string-match "\\." server))
2642 group (substring group (+ 1 colon)))
2643 (setq foreign server
2644 group (substring group (+ 1 colon))))
2645 (setq foreign (concat foreign ":")))
2646 ;; Collapse group name leaving LEVELS uncollapsed elements
2647 (let* ((glist (split-string group "\\."))
2648 (glen (length glist))
2650 (setq levels (- glen levels))
2652 (push (if (>= (decf levels) 0)
2653 (if (zerop (length g))
2658 (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2660 (defun gnus-narrow-to-body ()
2661 "Narrow to the body of an article."
2664 (goto-char (point-min))
2665 (or (search-forward "\n\n" nil t)
2671 ;;; Kill file handling.
2674 (defun gnus-apply-kill-file ()
2675 "Apply a kill file to the current newsgroup.
2676 Returns the number of articles marked as read."
2677 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2678 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2679 (gnus-apply-kill-file-internal)
2682 (defun gnus-kill-save-kill-buffer ()
2683 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2684 (when (get-file-buffer file)
2686 (set-buffer (get-file-buffer file))
2687 (when (buffer-modified-p)
2689 (kill-buffer (current-buffer))))))
2691 (defcustom gnus-kill-file-name "KILL"
2692 "Suffix of the kill files."
2693 :group 'gnus-score-kill
2694 :group 'gnus-score-files
2697 (defun gnus-newsgroup-kill-file (newsgroup)
2698 "Return the name of a kill file name for NEWSGROUP.
2699 If NEWSGROUP is nil, return the global kill file name instead."
2701 ;; The global KILL file is placed at top of the directory.
2702 ((or (null newsgroup)
2703 (string-equal newsgroup ""))
2704 (expand-file-name gnus-kill-file-name
2705 gnus-kill-files-directory))
2706 ;; Append ".KILL" to newsgroup name.
2707 ((gnus-use-long-file-name 'not-kill)
2708 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2709 "." gnus-kill-file-name)
2710 gnus-kill-files-directory))
2711 ;; Place "KILL" under the hierarchical directory.
2713 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2714 "/" gnus-kill-file-name)
2715 gnus-kill-files-directory))))
2719 (defun gnus-member-of-valid (symbol group)
2720 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2722 (symbol-name (car (gnus-find-method-for-group group)))
2723 gnus-valid-select-methods)))
2725 (defun gnus-method-option-p (method option)
2726 "Return non-nil if select METHOD has OPTION as a parameter."
2727 (when (stringp method)
2728 (setq method (gnus-server-to-method method)))
2729 (memq option (assoc (format "%s" (car method))
2730 gnus-valid-select-methods)))
2732 (defun gnus-similar-server-opened (method)
2733 (let ((opened gnus-opened-servers))
2734 (while (and method opened)
2735 (when (and (equal (cadr method) (cadaar opened))
2736 (equal (car method) (caaar opened))
2737 (not (equal method (caar opened))))
2742 (defun gnus-server-extend-method (group method)
2743 ;; This function "extends" a virtual server. If the server is
2744 ;; "hello", and the select method is ("hello" (my-var "something"))
2745 ;; in the group "alt.alt", this will result in a new virtual server
2746 ;; called "hello+alt.alt".
2747 (if (or (not (inline (gnus-similar-server-opened method)))
2748 (not (cddr method)))
2750 `(,(car method) ,(concat (cadr method) "+" group)
2751 (,(intern (format "%s-address" (car method))) ,(cadr method))
2754 (defun gnus-server-status (method)
2755 "Return the status of METHOD."
2756 (nth 1 (assoc method gnus-opened-servers)))
2758 (defun gnus-group-name-to-method (group)
2759 "Guess a select method based on GROUP."
2760 (if (string-match ":" group)
2761 (let ((server (substring group 0 (match-beginning 0))))
2762 (if (string-match "\\+" server)
2763 (list (intern (substring server 0 (match-beginning 0)))
2764 (substring server (match-end 0)))
2765 (list (intern server) "")))
2766 gnus-select-method))
2768 (defun gnus-find-method-for-group (group &optional info)
2769 "Find the select method that GROUP uses."
2770 (or gnus-override-method
2773 (and (not (gnus-group-entry group));; a new group
2774 (gnus-group-name-to-method group))
2775 (let ((info (or info (gnus-get-info group)))
2778 (not (setq method (gnus-info-method info)))
2779 (equal method "native"))
2782 (cond ((stringp method)
2783 (inline (gnus-server-to-method method)))
2784 ((stringp (cadr method))
2785 (inline (gnus-server-extend-method group method)))
2788 (cond ((equal (cadr method) "")
2790 ((null (cadr method))
2791 (list (car method) ""))
2793 (gnus-server-add-address method)))))))
2795 (defun gnus-methods-using (feature)
2796 "Find all methods that have FEATURE."
2797 (let ((valids gnus-valid-select-methods)
2800 (when (memq feature (car valids))
2801 (push (car valids) outs))
2802 (setq valids (cdr valids)))
2805 (defun gnus-read-group (prompt &optional default)
2806 "Prompt the user for a group name.
2807 Disallow invalid group names."
2813 (setq group (read-string (concat prefix prompt)
2814 (cons (or default "") 0)
2815 'gnus-group-history)))
2816 (setq prefix (format "Invalid group name: \"%s\". " group)
2820 (defun gnus-read-method (prompt)
2821 "Prompt the user for a method.
2822 Allow completion over sensible values."
2824 (append gnus-valid-select-methods
2825 (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2827 gnus-opened-servers)
2828 gnus-predefined-server-alist
2833 nil t nil 'gnus-method-history)))
2836 (setq method gnus-select-method))
2837 ((assoc method gnus-valid-select-methods)
2838 (let ((address (if (memq 'prompt-address
2839 (assoc method gnus-valid-select-methods))
2840 (read-string "Address: ")
2842 (or (let ((opened gnus-opened-servers))
2844 (not (equal (format "%s:%s" method address)
2845 (format "%s:%s" (caaar opened)
2849 (list (intern method) address))))
2850 ((assoc method servers)
2853 (list (intern method) "")))))
2855 ;;; User-level commands.
2858 (defun gnus-slave-no-server (&optional arg)
2859 "Read network news as a slave, without connecting to local server."
2861 (gnus-no-server arg t))
2864 (defun gnus-no-server (&optional arg slave)
2866 If ARG is a positive number, Gnus will use that as the
2867 startup level. If ARG is nil, Gnus will be started at level 2.
2868 If ARG is non-nil and not a positive number, Gnus will
2869 prompt the user for the name of an NNTP server to use.
2870 As opposed to `gnus', this command will not connect to the local server."
2872 (gnus-no-server-1 arg slave))
2875 (defun gnus-slave (&optional arg)
2876 "Read news as a slave."
2878 (gnus arg nil 'slave))
2881 (defun gnus-other-frame (&optional arg)
2882 "Pop up a frame to read news."
2884 (let ((window (get-buffer-window gnus-group-buffer)))
2886 (select-frame (window-frame window)))
2888 (select-frame (make-frame)))))
2891 ;;(setq thing ? ; this is a comment
2895 (defun gnus (&optional arg dont-connect slave)
2897 If ARG is non-nil and a positive number, Gnus will use that as the
2898 startup level. If ARG is non-nil and not a positive number, Gnus will
2899 prompt the user for the name of an NNTP server to use."
2901 (gnus-1 arg dont-connect slave))
2903 ;; Allow redefinition of Gnus functions.
2909 ;;; gnus.el ends here