1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987-1990,1993-1999 Free Software Foundation, Inc.
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 (eval '(run-hooks 'gnus-load-hook))
31 (eval-when-compile (require 'cl))
36 (if (< emacs-major-version 20)
37 (require 'gnus-load)))
41 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
45 (defgroup gnus-charset nil
46 "Group character set issues."
47 :link '(custom-manual "(gnus)Charsets")
50 (defgroup gnus-cache nil
54 (defgroup gnus-start nil
55 "Starting your favorite newsreader."
58 (defgroup gnus-start-server nil
59 "Server options at startup."
62 ;; These belong to gnus-group.el.
63 (defgroup gnus-group nil
65 :link '(custom-manual "(gnus)The Group Buffer")
68 (defgroup gnus-group-foreign nil
70 :link '(custom-manual "(gnus)Foreign Groups")
73 (defgroup gnus-group-new nil
74 "Automatic subscription of new groups."
77 (defgroup gnus-group-levels nil
79 :link '(custom-manual "(gnus)Group Levels")
82 (defgroup gnus-group-select nil
84 :link '(custom-manual "(gnus)Selecting a Group")
87 (defgroup gnus-group-listing nil
88 "Showing slices of the group list."
89 :link '(custom-manual "(gnus)Listing Groups")
92 (defgroup gnus-group-visual nil
93 "Sorting the group buffer."
94 :link '(custom-manual "(gnus)Group Buffer Format")
98 (defgroup gnus-group-various nil
99 "Various group options."
100 :link '(custom-manual "(gnus)Scanning New Messages")
103 ;; These belong to gnus-sum.el.
104 (defgroup gnus-summary nil
106 :link '(custom-manual "(gnus)The Summary Buffer")
109 (defgroup gnus-summary-exit nil
110 "Leaving summary buffers."
111 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
112 :group 'gnus-summary)
114 (defgroup gnus-summary-marks nil
115 "Marks used in summary buffers."
116 :link '(custom-manual "(gnus)Marking Articles")
117 :group 'gnus-summary)
119 (defgroup gnus-thread nil
120 "Ordering articles according to replies."
121 :link '(custom-manual "(gnus)Threading")
122 :group 'gnus-summary)
124 (defgroup gnus-summary-format nil
125 "Formatting of the summary buffer."
126 :link '(custom-manual "(gnus)Summary Buffer Format")
127 :group 'gnus-summary)
129 (defgroup gnus-summary-choose nil
131 :link '(custom-manual "(gnus)Choosing Articles")
132 :group 'gnus-summary)
134 (defgroup gnus-summary-maneuvering nil
135 "Summary movement commands."
136 :link '(custom-manual "(gnus)Summary Maneuvering")
137 :group 'gnus-summary)
139 (defgroup gnus-summary-mail nil
140 "Mail group commands."
141 :link '(custom-manual "(gnus)Mail Group Commands")
142 :group 'gnus-summary)
144 (defgroup gnus-summary-sort nil
145 "Sorting the summary buffer."
146 :link '(custom-manual "(gnus)Sorting")
147 :group 'gnus-summary)
149 (defgroup gnus-summary-visual nil
150 "Highlighting and menus in the summary buffer."
151 :link '(custom-manual "(gnus)Summary Highlighting")
153 :group 'gnus-summary)
155 (defgroup gnus-summary-various nil
156 "Various summary buffer options."
157 :link '(custom-manual "(gnus)Various Summary Stuff")
158 :group 'gnus-summary)
160 (defgroup gnus-summary-pick nil
161 "Pick mode in the summary buffer."
162 :link '(custom-manual "(gnus)Pick and Read")
164 :group 'gnus-summary)
166 (defgroup gnus-summary-tree nil
167 "Tree display of threads in the summary buffer."
168 :link '(custom-manual "(gnus)Tree Display")
170 :group 'gnus-summary)
172 ;; Belongs to gnus-uu.el
173 (defgroup gnus-extract-view nil
174 "Viewing extracted files."
175 :link '(custom-manual "(gnus)Viewing Files")
176 :group 'gnus-extract)
178 ;; Belongs to gnus-score.el
179 (defgroup gnus-score nil
180 "Score and kill file handling."
183 (defgroup gnus-score-kill nil
187 (defgroup gnus-score-adapt nil
188 "Adaptive score files."
191 (defgroup gnus-score-default nil
192 "Default values for score files."
195 (defgroup gnus-score-expire nil
196 "Expiring score rules."
199 (defgroup gnus-score-decay nil
200 "Decaying score rules."
203 (defgroup gnus-score-files nil
204 "Score and kill file names."
208 (defgroup gnus-score-various nil
209 "Various scoring and killing options."
213 (defgroup gnus-visual nil
214 "Options controling the visual fluff."
218 (defgroup gnus-agent nil
219 "Offline support for Gnus."
222 (defgroup gnus-files nil
223 "Files used by Gnus."
226 (defgroup gnus-dribble-file nil
228 :link '(custom-manual "(gnus)Auto Save")
231 (defgroup gnus-newsrc nil
232 "Storing Gnus state."
235 (defgroup gnus-server nil
236 "Options related to newsservers and other servers used by Gnus."
239 (defgroup gnus-message '((message custom-group))
240 "Composing replies and followups in Gnus."
243 (defgroup gnus-meta nil
244 "Meta variables controling major portions of Gnus.
245 In general, modifying these variables does not take affect until Gnus
246 is restarted, and sometimes reloaded."
249 (defgroup gnus-various nil
250 "Other Gnus options."
251 :link '(custom-manual "(gnus)Various Various")
254 (defgroup gnus-mime nil
255 "Variables for controlling the Gnus MIME interface."
258 (defgroup gnus-exit nil
260 :link '(custom-manual "(gnus)Exiting Gnus")
263 (defconst gnus-version-number "5.8.3"
264 "Version number for this version of Gnus.")
266 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
267 "Version string for this version of Gnus.")
269 (defcustom gnus-inhibit-startup-message nil
270 "If non-nil, the startup message will not be displayed.
271 This variable is used before `.gnus.el' is loaded, so it should
272 be set in `.emacs' instead."
276 (defcustom gnus-play-startup-jingle nil
277 "If non-nil, play the Gnus jingle at startup."
281 (unless (featurep 'gnus-xmas)
282 (defalias 'gnus-make-overlay 'make-overlay)
283 (defalias 'gnus-delete-overlay 'delete-overlay)
284 (defalias 'gnus-overlay-put 'overlay-put)
285 (defalias 'gnus-move-overlay 'move-overlay)
286 (defalias 'gnus-overlay-end 'overlay-end)
287 (defalias 'gnus-extent-detached-p 'ignore)
288 (defalias 'gnus-extent-start-open 'ignore)
289 (defalias 'gnus-set-text-properties 'set-text-properties)
290 (defalias 'gnus-group-remove-excess-properties 'ignore)
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 (defalias 'gnus-mode-line-buffer-identification 'identity)
297 (defalias 'gnus-characterp 'numberp)
298 (defalias 'gnus-deactivate-mark 'deactivate-mark)
299 (defalias 'gnus-window-edges 'window-edges)
300 (defalias 'gnus-key-press-event-p 'numberp)
301 (defalias 'gnus-decode-rfc1522 'ignore))
303 ;; We define these group faces here to avoid the display
304 ;; update forced when creating new faces.
306 (defface gnus-group-news-1-face
309 (:foreground "PaleTurquoise" :bold t))
312 (:foreground "ForestGreen" :bold t))
315 "Level 1 newsgroup face.")
317 (defface gnus-group-news-1-empty-face
320 (:foreground "PaleTurquoise"))
323 (:foreground "ForestGreen"))
326 "Level 1 empty newsgroup face.")
328 (defface gnus-group-news-2-face
331 (:foreground "turquoise" :bold t))
334 (:foreground "CadetBlue4" :bold t))
337 "Level 2 newsgroup face.")
339 (defface gnus-group-news-2-empty-face
342 (:foreground "turquoise"))
345 (:foreground "CadetBlue4"))
348 "Level 2 empty newsgroup face.")
350 (defface gnus-group-news-3-face
359 "Level 3 newsgroup face.")
361 (defface gnus-group-news-3-empty-face
370 "Level 3 empty newsgroup face.")
372 (defface gnus-group-news-4-face
381 "Level 4 newsgroup face.")
383 (defface gnus-group-news-4-empty-face
392 "Level 4 empty newsgroup face.")
394 (defface gnus-group-news-5-face
403 "Level 5 newsgroup face.")
405 (defface gnus-group-news-5-empty-face
414 "Level 5 empty newsgroup face.")
416 (defface gnus-group-news-6-face
425 "Level 6 newsgroup face.")
427 (defface gnus-group-news-6-empty-face
436 "Level 6 empty newsgroup face.")
438 (defface gnus-group-news-low-face
441 (:foreground "DarkTurquoise" :bold t))
444 (:foreground "DarkGreen" :bold t))
447 "Low level newsgroup face.")
449 (defface gnus-group-news-low-empty-face
452 (:foreground "DarkTurquoise"))
455 (:foreground "DarkGreen"))
458 "Low level empty newsgroup face.")
460 (defface gnus-group-mail-1-face
463 (:foreground "aquamarine1" :bold t))
466 (:foreground "DeepPink3" :bold t))
469 "Level 1 mailgroup face.")
471 (defface gnus-group-mail-1-empty-face
474 (:foreground "aquamarine1"))
477 (:foreground "DeepPink3"))
479 (:italic t :bold t)))
480 "Level 1 empty mailgroup face.")
482 (defface gnus-group-mail-2-face
485 (:foreground "aquamarine2" :bold t))
488 (:foreground "HotPink3" :bold t))
491 "Level 2 mailgroup face.")
493 (defface gnus-group-mail-2-empty-face
496 (:foreground "aquamarine2"))
499 (:foreground "HotPink3"))
502 "Level 2 empty mailgroup face.")
504 (defface gnus-group-mail-3-face
507 (:foreground "aquamarine3" :bold t))
510 (:foreground "magenta4" :bold t))
513 "Level 3 mailgroup face.")
515 (defface gnus-group-mail-3-empty-face
518 (:foreground "aquamarine3"))
521 (:foreground "magenta4"))
524 "Level 3 empty mailgroup face.")
526 (defface gnus-group-mail-low-face
529 (:foreground "aquamarine4" :bold t))
532 (:foreground "DeepPink4" :bold t))
535 "Low level mailgroup face.")
537 (defface gnus-group-mail-low-empty-face
540 (:foreground "aquamarine4"))
543 (:foreground "DeepPink4"))
546 "Low level empty mailgroup face.")
548 ;; Summary mode faces.
550 (defface gnus-summary-selected-face '((t
552 "Face used for selected articles.")
554 (defface gnus-summary-cancelled-face
556 (:foreground "yellow" :background "black")))
557 "Face used for cancelled articles.")
559 (defface gnus-summary-high-ticked-face
562 (:foreground "pink" :bold t))
565 (:foreground "firebrick" :bold t))
568 "Face used for high interest ticked articles.")
570 (defface gnus-summary-low-ticked-face
573 (:foreground "pink" :italic t))
576 (:foreground "firebrick" :italic t))
579 "Face used for low interest ticked articles.")
581 (defface gnus-summary-normal-ticked-face
584 (:foreground "pink"))
587 (:foreground "firebrick"))
590 "Face used for normal interest ticked articles.")
592 (defface gnus-summary-high-ancient-face
595 (:foreground "SkyBlue" :bold t))
598 (:foreground "RoyalBlue" :bold t))
601 "Face used for high interest ancient articles.")
603 (defface gnus-summary-low-ancient-face
606 (:foreground "SkyBlue" :italic t))
609 (:foreground "RoyalBlue" :italic t))
612 "Face used for low interest ancient articles.")
614 (defface gnus-summary-normal-ancient-face
617 (:foreground "SkyBlue"))
620 (:foreground "RoyalBlue"))
623 "Face used for normal interest ancient articles.")
625 (defface gnus-summary-high-unread-face
628 "Face used for high interest unread articles.")
630 (defface gnus-summary-low-unread-face
633 "Face used for low interest unread articles.")
635 (defface gnus-summary-normal-unread-face
638 "Face used for normal interest unread articles.")
640 (defface gnus-summary-high-read-face
643 (:foreground "PaleGreen"
647 (:foreground "DarkGreen"
651 "Face used for high interest read articles.")
653 (defface gnus-summary-low-read-face
656 (:foreground "PaleGreen"
660 (:foreground "DarkGreen"
664 "Face used for low interest read articles.")
666 (defface gnus-summary-normal-read-face
669 (:foreground "PaleGreen"))
672 (:foreground "DarkGreen"))
675 "Face used for normal interest read articles.")
682 (defvar gnus-buffers nil)
684 (defun gnus-get-buffer-create (name)
685 "Do the same as `get-buffer-create', but store the created buffer."
686 (or (get-buffer name)
687 (car (push (get-buffer-create name) gnus-buffers))))
689 (defun gnus-add-buffer ()
690 "Add the current buffer to the list of Gnus buffers."
691 (push (current-buffer) gnus-buffers))
693 (defun gnus-buffers ()
694 "Return a list of live Gnus buffers."
695 (while (and gnus-buffers
696 (not (buffer-name (car gnus-buffers))))
698 (let ((buffers gnus-buffers))
700 (if (buffer-name (cadr buffers))
702 (setcdr buffers (cddr buffers)))))
707 (defvar gnus-group-buffer "*Group*")
710 (autoload 'gnus-play-jingle "gnus-audio"))
712 (defface gnus-splash-face
715 (:foreground "Brown"))
718 (:foreground "Brown"))
721 "Face of the splash screen.")
723 (defun gnus-splash ()
725 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
726 (let ((buffer-read-only nil))
728 (unless gnus-inhibit-startup-message
729 (gnus-group-startup-message)
731 (when gnus-play-startup-jingle
732 (gnus-play-jingle))))))
734 (defun gnus-indent-rigidly (start end arg)
735 "Indent rigidly using only spaces and no tabs."
738 (narrow-to-region start end)
740 (indent-rigidly start end arg)
741 ;; We translate tabs into spaces -- not everybody uses
742 ;; an 8-character tab.
743 (goto-char (point-min))
744 (while (search-forward "\t" nil t)
745 (replace-match " " t t))))))
747 (defvar gnus-simple-splash nil)
749 (defun gnus-group-startup-message (&optional x y)
750 "Insert startup message in current buffer."
751 ;; Insert the message.
756 _ ___ __ ___ __ _ ___
776 (gnus-indent-rigidly (point-min) (point-max)
777 (/ (max (- (window-width) (or x 46)) 0) 2))
778 (goto-char (point-min))
780 (let* ((pheight (count-lines (point-min) (point-max)))
781 (wheight (window-height))
782 (rest (- wheight pheight)))
783 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
785 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
786 (goto-char (point-min))
787 (setq mode-line-buffer-identification (concat " " gnus-version))
788 (setq gnus-simple-splash t)
789 (set-buffer-modified-p t))
792 (let ((command (format "%s" this-command)))
793 (if (and (string-match "gnus" command)
794 (not (string-match "gnus-other-frame" command)))
796 (gnus-get-buffer-create gnus-group-buffer))))
804 (defcustom gnus-home-directory "~/"
805 "Directory variable that specifies the \"home\" directory.
806 All other Gnus path variables are initialized from this variable."
810 (defcustom gnus-directory (or (getenv "SAVEDIR")
811 (nnheader-concat gnus-home-directory "News/"))
812 "*Directory variable from which all other Gnus file variables are derived.
814 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
815 This means that other directory variables that are initialized from
816 this variable won't be set properly if you set this variable in `.gnus.el'.
817 Set this variable in `.emacs' instead."
821 (defcustom gnus-default-directory nil
822 "*Default directory for all Gnus buffers."
824 :type '(choice (const :tag "current" nil)
827 ;; Site dependent variables. These variables should be defined in
830 (defvar gnus-default-nntp-server nil
831 "Specify a default NNTP server.
832 This variable should be defined in paths.el, and should never be set
834 If you want to change servers, you should use `gnus-select-method'.
835 See the documentation to that variable.")
837 ;; Don't touch this variable.
838 (defvar gnus-nntp-service "nntp"
839 "NNTP service name (\"nntp\" or 119).
840 This is an obsolete variable, which is scarcely used. If you use an
841 nntp server for your newsgroup and want to change the port number
842 used to 899, you would say something along these lines:
844 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
846 (defcustom gnus-nntpserver-file "/etc/nntpserver"
847 "A file with only the name of the nntp server in it."
852 ;; This function is used to check both the environment variable
853 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
854 ;; an nntp server name default.
855 (defun gnus-getenv-nntpserver ()
856 (or (getenv "NNTPSERVER")
857 (and (file-readable-p gnus-nntpserver-file)
859 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
860 (insert-file-contents gnus-nntpserver-file)
861 (let ((name (buffer-string)))
863 (if (string-match "\\'[ \t\n]*$" name)
866 (kill-buffer (current-buffer))))))))
868 (defcustom gnus-select-method
871 (list 'nntp (or (condition-case nil
872 (gnus-getenv-nntpserver)
874 (when (and gnus-default-nntp-server
875 (not (string= gnus-default-nntp-server "")))
876 gnus-default-nntp-server)
878 (if (or (null gnus-nntp-service)
879 (equal gnus-nntp-service "nntp"))
881 (list gnus-nntp-service)))
883 "Default method for selecting a newsgroup.
884 This variable should be a list, where the first element is how the
885 news is to be fetched, the second is the address.
887 For instance, if you want to get your news via NNTP from
888 \"flab.flab.edu\", you could say:
890 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
892 If you want to use your local spool, say:
894 \(setq gnus-select-method (list 'nnspool (system-name)))
896 If you use this variable, you must set `gnus-nntp-server' to nil.
898 There is a lot more to know about select methods and virtual servers -
899 see the manual for details."
901 :type 'gnus-select-method)
903 (defcustom gnus-message-archive-method
906 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
907 (nnfolder-active-file
908 ,(nnheader-concat message-directory "archive/active"))
909 (nnfolder-get-new-mail nil)
910 (nnfolder-inhibit-expiry t))
911 "*Method used for archiving messages you've sent.
912 This should be a mail method.
914 It's probably not a very effective to change this variable once you've
915 run Gnus once. After doing that, you must edit this server from the
919 :type 'gnus-select-method)
921 (defcustom gnus-message-archive-group nil
922 "*Name of the group in which to save the messages you've written.
923 This can either be a string; a list of strings; or an alist
924 of regexps/functions/forms to be evaluated to return a string (or a list
925 of strings). The functions are called with the name of the current
926 group (or nil) as a parameter.
928 If you want to save your mail in one group and the news articles you
929 write in another group, you could say something like:
931 \(setq gnus-message-archive-group
932 '((if (message-news-p)
936 Normally the group names returned by this variable should be
937 unprefixed -- which implicitly means \"store on the archive server\".
938 However, you may wish to store the message on some other server. In
939 that case, just return a fully prefixed name of the group --
940 \"nnml+private:mail.misc\", for instance."
942 :type '(choice (const :tag "none" nil)
947 (defcustom gnus-secondary-servers nil
948 "List of NNTP servers that the user can choose between interactively.
949 To make Gnus query you for a server, you have to give `gnus' a
950 non-numeric prefix - `C-u M-x gnus', in short."
952 :type '(repeat string))
954 (defcustom gnus-nntp-server nil
955 "*The name of the host running the NNTP server.
956 This variable is semi-obsolete. Use the `gnus-select-method'
959 :type '(choice (const :tag "disable" nil)
962 (defcustom gnus-secondary-select-methods nil
963 "A list of secondary methods that will be used for reading news.
964 This is a list where each element is a complete select method (see
965 `gnus-select-method').
967 If, for instance, you want to read your mail with the nnml backend,
968 you could set this variable:
970 \(setq gnus-secondary-select-methods '((nnml \"\")))"
972 :type '(repeat gnus-select-method))
974 (defvar gnus-backup-default-subscribed-newsgroups
975 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
976 "Default default new newsgroups the first time Gnus is run.
977 Should be set in paths.el, and shouldn't be touched by the user.")
979 (defcustom gnus-local-domain nil
980 "Local domain name without a host name.
981 The DOMAINNAME environment variable is used instead if it is defined.
982 If the `system-name' function returns the full Internet name, there is
983 no need to set this variable."
985 :type '(choice (const :tag "default" nil)
988 (defvar gnus-local-organization nil
989 "String with a description of what organization (if any) the user belongs to.
990 Obsolete variable; use `message-user-organization' instead.")
992 ;; Customization variables
994 (defcustom gnus-refer-article-method nil
995 "Preferred method for fetching an article by Message-ID.
996 If you are reading news from the local spool (with nnspool), fetching
997 articles by Message-ID is painfully slow. By setting this method to an
998 nntp method, you might get acceptable results.
1000 The value of this variable must be a valid select method as discussed
1001 in the documentation of `gnus-select-method'.
1003 It can also be a list of select methods, as well as the special symbol
1004 `current', which means to use the current select method. If it is a
1005 list, Gnus will try all the methods in the list until it finds a match."
1007 :type '(choice (const :tag "default" nil)
1008 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1010 (repeat :menu-tag "Try multiple"
1012 :value (current (nnweb "refer" (nnweb-type dejanews)))
1013 (choice :tag "Method"
1015 (const :tag "DejaNews"
1016 (nnweb "refer" (nnweb-type dejanews)))
1017 gnus-select-method))))
1019 (defcustom gnus-group-faq-directory
1020 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1021 "/ftp@sunsite.auc.dk:/pub/usenet/"
1022 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1023 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1024 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1025 "/ftp@rtfm.mit.edu:/pub/usenet/"
1026 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1027 "/ftp@ftp.sunet.se:/pub/usenet/"
1028 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1029 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1030 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1031 "*Directory where the group FAQs are stored.
1032 This will most commonly be on a remote machine, and the file will be
1033 fetched by ange-ftp.
1035 This variable can also be a list of directories. In that case, the
1036 first element in the list will be used by default. The others can
1037 be used when being prompted for a site.
1039 Note that Gnus uses an aol machine as the default directory. If this
1040 feels fundamentally unclean, just think of it as a way to finally get
1041 something of value back from them.
1043 If the default site is too slow, try one of these:
1045 North America: mirrors.aol.com /pub/rtfm/usenet
1046 ftp.seas.gwu.edu /pub/rtfm
1047 rtfm.mit.edu /pub/usenet
1048 Europe: ftp.uni-paderborn.de /pub/FAQ
1049 src.doc.ic.ac.uk /usenet/news-FAQS
1050 ftp.sunet.se /pub/usenet
1051 sunsite.auc.dk /pub/usenet
1052 Asia: nctuccca.edu.tw /USENET/FAQ
1053 hwarang.postech.ac.kr /pub/usenet
1054 ftp.hk.super.net /mirror/faqs"
1055 :group 'gnus-group-various
1056 :type '(choice directory
1057 (repeat directory)))
1059 (defcustom gnus-use-cross-reference t
1060 "*Non-nil means that cross referenced articles will be marked as read.
1061 If nil, ignore cross references. If t, mark articles as read in
1062 subscribed newsgroups. If neither t nor nil, mark as read in all
1065 :type '(choice (const :tag "off" nil)
1066 (const :tag "subscribed" t)
1070 (defcustom gnus-process-mark ?#
1072 :group 'gnus-group-visual
1073 :group 'gnus-summary-marks
1076 (defcustom gnus-asynchronous nil
1077 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1078 :group 'gnus-asynchronous
1081 (defcustom gnus-large-newsgroup 200
1082 "*The number of articles which indicates a large newsgroup.
1083 If the number of articles in a newsgroup is greater than this value,
1084 confirmation is required for selecting the newsgroup."
1085 :group 'gnus-group-select
1088 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1089 "*Non-nil means that the default name of a file to save articles in is the group name.
1090 If it's nil, the directory form of the group name is used instead.
1092 If this variable is a list, and the list contains the element
1093 `not-score', long file names will not be used for score files; if it
1094 contains the element `not-save', long file names will not be used for
1095 saving; and if it contains the element `not-kill', long file names
1096 will not be used for kill files.
1098 Note that the default for this variable varies according to what system
1099 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1100 to nil while on all other systems it defaults to t."
1104 (defcustom gnus-kill-files-directory gnus-directory
1105 "*Name of the directory where kill files will be stored (default \"~/News\")."
1106 :group 'gnus-score-files
1107 :group 'gnus-score-kill
1110 (defcustom gnus-save-score nil
1111 "*If non-nil, save group scoring info."
1112 :group 'gnus-score-various
1116 (defcustom gnus-use-undo t
1117 "*If non-nil, allow undoing in Gnus group mode buffers."
1121 (defcustom gnus-use-adaptive-scoring nil
1122 "*If non-nil, use some adaptive scoring scheme.
1123 If a list, then the values `word' and `line' are meaningful. The
1124 former will perform adaption on individual words in the subject
1125 header while `line' will perform adaption on several headers."
1127 :group 'gnus-score-adapt
1128 :type '(set (const word) (const line)))
1130 (defcustom gnus-use-cache 'passive
1131 "*If nil, Gnus will ignore the article cache.
1132 If `passive', it will allow entering (and reading) articles
1133 explicitly entered into the cache. If anything else, use the
1134 cache to the full extent of the law."
1137 :type '(choice (const :tag "off" nil)
1138 (const :tag "passive" passive)
1139 (const :tag "active" t)))
1141 (defcustom gnus-use-trees nil
1142 "*If non-nil, display a thread tree buffer."
1146 (defcustom gnus-use-grouplens nil
1147 "*If non-nil, use GroupLens ratings."
1151 (defcustom gnus-keep-backlog nil
1152 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1153 If it is a number N, then Gnus will only keep the last N articles
1154 read. If it is neither nil nor a number, Gnus will keep all read
1155 articles. This is not a good idea."
1157 :type '(choice (const :tag "off" nil)
1162 (defcustom gnus-use-nocem nil
1163 "*If non-nil, Gnus will read NoCeM cancel messages."
1167 (defcustom gnus-suppress-duplicates nil
1168 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1172 (defcustom gnus-use-scoring t
1173 "*If non-nil, enable scoring."
1177 (defcustom gnus-use-picons nil
1178 "*If non-nil, display picons in a frame of their own."
1182 (defcustom gnus-summary-prepare-exit-hook
1183 '(gnus-summary-expire-articles)
1184 "*A hook called when preparing to exit from the summary buffer.
1185 It calls `gnus-summary-expire-articles' by default."
1186 :group 'gnus-summary-exit
1189 (defcustom gnus-novice-user t
1190 "*Non-nil means that you are a usenet novice.
1191 If non-nil, verbose messages may be displayed and confirmations may be
1196 (defcustom gnus-expert-user nil
1197 "*Non-nil means that you will never be asked for confirmation about anything.
1198 That doesn't mean *anything* anything; particularly destructive
1199 commands will still require prompting."
1203 (defcustom gnus-interactive-catchup t
1204 "*If non-nil, require your confirmation when catching up a group."
1205 :group 'gnus-group-select
1208 (defcustom gnus-interactive-exit t
1209 "*If non-nil, require your confirmation when exiting Gnus."
1213 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1214 "*Function for extracting address components from a From header.
1215 Two pre-defined function exist: `gnus-extract-address-components',
1216 which is the default, quite fast, and too simplistic solution, and
1217 `mail-extract-address-components', which works much better, but is
1219 :group 'gnus-summary-format
1220 :type '(radio (function-item gnus-extract-address-components)
1221 (function-item mail-extract-address-components)
1222 (function :tag "Other")))
1224 (defcustom gnus-carpal nil
1225 "*If non-nil, display clickable icons."
1229 (defcustom gnus-shell-command-separator ";"
1230 "String used to separate to shell commands."
1234 (defcustom gnus-valid-select-methods
1235 '(("nntp" post address prompt-address physical-address)
1236 ("nnspool" post address)
1237 ("nnvirtual" post-mail virtual prompt-address)
1238 ("nnmbox" mail respool address)
1239 ("nnml" mail respool address)
1240 ("nnmh" mail respool address)
1241 ("nndir" post-mail prompt-address physical-address)
1242 ("nneething" none address prompt-address physical-address)
1243 ("nndoc" none address prompt-address)
1244 ("nnbabyl" mail address respool)
1245 ("nnkiboze" post virtual)
1246 ("nnsoup" post-mail address)
1247 ("nndraft" post-mail)
1248 ("nnfolder" mail respool address)
1249 ("nngateway" post-mail address prompt-address physical-address)
1255 ("nnagent" post-mail)
1256 ("nnimap" post-mail address prompt-address physical-address))
1257 "*An alist of valid select methods.
1258 The first element of each list lists should be a string with the name
1259 of the select method. The other elements may be the category of
1260 this method (i. e., `post', `mail', `none' or whatever) or other
1261 properties that this method has (like being respoolable).
1262 If you implement a new select method, all you should have to change is
1263 this variable. I think."
1265 :type '(repeat (group (string :tag "Name")
1266 (radio-button-choice (const :format "%v " post)
1267 (const :format "%v " mail)
1268 (const :format "%v " none)
1270 (checklist :inline t
1271 (const :format "%v " address)
1272 (const :format "%v " prompt-address)
1273 (const :format "%v " physical-address)
1274 (const :format "%v " virtual)
1277 (define-widget 'gnus-select-method 'list
1278 "Widget for entering a select method."
1280 :tag "Select Method"
1281 :args `((choice :tag "Method"
1282 ,@(mapcar (lambda (entry)
1283 (list 'const :format "%v\n"
1284 (intern (car entry))))
1285 gnus-valid-select-methods))
1286 (string :tag "Address")
1287 (repeat :tag "Options"
1291 (sexp :tag "Value")))))
1293 (defcustom gnus-updated-mode-lines '(group article summary tree)
1294 "List of buffers that should update their mode lines.
1295 The list may contain the symbols `group', `article', `tree' and
1296 `summary'. If the corresponding symbol is present, Gnus will keep
1297 that mode line updated with information that may be pertinent.
1298 If this variable is nil, screen refresh may be quicker."
1299 :group 'gnus-various
1300 :type '(set (const group)
1305 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1306 (defcustom gnus-mode-non-string-length nil
1307 "*Max length of mode-line non-string contents.
1308 If this is nil, Gnus will take space as is needed, leaving the rest
1309 of the modeline intact. Note that the default of nil is unlikely
1310 to be desirable; see the manual for further details."
1311 :group 'gnus-various
1312 :type '(choice (const nil)
1315 (defcustom gnus-auto-expirable-newsgroups nil
1316 "*Groups in which to automatically mark read articles as expirable.
1317 If non-nil, this should be a regexp that should match all groups in
1318 which to perform auto-expiry. This only makes sense for mail groups."
1319 :group 'nnmail-expire
1320 :type '(choice (const nil)
1323 (defcustom gnus-total-expirable-newsgroups nil
1324 "*Groups in which to perform expiry of all read articles.
1325 Use with extreme caution. All groups that match this regexp will be
1326 expiring - which means that all read articles will be deleted after
1327 \(say) one week. (This only goes for mail groups and the like, of
1329 :group 'nnmail-expire
1330 :type '(choice (const nil)
1333 (defcustom gnus-group-uncollapsed-levels 1
1334 "Number of group name elements to leave alone when making a short group name."
1335 :group 'gnus-group-visual
1338 (defcustom gnus-group-use-permanent-levels nil
1339 "*If non-nil, once you set a level, Gnus will use this level."
1340 :group 'gnus-group-levels
1345 (defcustom gnus-load-hook nil
1346 "A hook run while Gnus is loaded."
1350 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1351 "A hook called to apply kill files to a group.
1352 This hook is intended to apply a kill file to the selected newsgroup.
1353 The function `gnus-apply-kill-file' is called by default.
1355 Since a general kill file is too heavy to use only for a few
1356 newsgroups, I recommend you to use a lighter hook function. For
1357 example, if you'd like to apply a kill file to articles which contains
1358 a string `rmgroup' in subject in newsgroup `control', you can use the
1361 (setq gnus-apply-kill-hook
1364 (cond ((string-match \"control\" gnus-newsgroup-name)
1365 (gnus-kill \"Subject\" \"rmgroup\")
1366 (gnus-expunge \"X\"))))))"
1367 :group 'gnus-score-kill
1368 :options '(gnus-apply-kill-file)
1371 (defcustom gnus-group-change-level-function nil
1372 "Function run when a group level is changed.
1373 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1374 :group 'gnus-group-levels
1379 (defcustom gnus-visual
1380 '(summary-highlight group-highlight article-highlight
1382 summary-menu group-menu article-menu
1383 tree-highlight menu highlight
1384 browse-menu server-menu
1385 page-marker tree-menu binary-menu pick-menu
1387 "*Enable visual features.
1388 If `visual' is disabled, there will be no menus and few faces. Most of
1389 the visual customization options below will be ignored. Gnus will use
1390 less space and be faster as a result.
1392 This variable can also be a list of visual elements to switch on. For
1393 instance, to switch off all visual things except menus, you can say:
1395 (setq gnus-visual '(menu))
1397 Valid elements include `summary-highlight', `group-highlight',
1398 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1399 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1400 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1401 and `grouplens-menu'."
1404 :type '(set (const summary-highlight)
1405 (const group-highlight)
1406 (const article-highlight)
1408 (const summary-menu)
1410 (const article-menu)
1411 (const tree-highlight)
1420 (const grouplens-menu)))
1422 (defcustom gnus-mouse-face
1424 (if (gnus-visual-p 'mouse-face 'highlight)
1425 (if (boundp 'gnus-mouse-face)
1426 (or gnus-mouse-face 'highlight)
1430 "*Face used for group or summary buffer mouse highlighting.
1431 The line beneath the mouse pointer will be highlighted with this
1436 (defcustom gnus-article-save-directory gnus-directory
1437 "*Name of the directory articles will be saved in (default \"~/News\")."
1438 :group 'gnus-article-saving
1441 (defvar gnus-plugged t
1442 "Whether Gnus is plugged or not.")
1444 (defcustom gnus-default-charset 'iso-8859-1
1445 "Default charset assumed to be used when viewing non-ASCII characters.
1446 This variable is overridden on a group-to-group basis by the
1447 gnus-group-charset-alist variable and is only used on groups not
1448 covered by that variable."
1450 :group 'gnus-charset)
1452 (defcustom gnus-default-posting-charset nil
1453 "Default charset assumed to be used when posting non-ASCII characters.
1454 This variable is overridden on a group-to-group basis by the
1455 gnus-group-posting-charset-alist variable and is only used on groups not
1456 covered by that variable.
1457 If nil, no default charset is assumed when posting."
1459 :group 'gnus-charset)
1462 ;;; Internal variables
1464 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1465 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1466 (defvar gnus-original-article-buffer " *Original Article*")
1467 (defvar gnus-newsgroup-name nil)
1468 (defvar gnus-ephemeral-servers nil)
1470 (defvar gnus-agent nil
1471 "Whether we want to use the Gnus agent or not.")
1473 (defvar gnus-command-method nil
1474 "Dynamically bound variable that says what the current backend is.")
1476 (defvar gnus-current-select-method nil
1477 "The current method for selecting a newsgroup.")
1479 (defvar gnus-tree-buffer "*Tree*"
1480 "Buffer where Gnus thread trees are displayed.")
1483 (defvar gnus-use-generic-from nil)
1485 ;; Variable holding the user answers to all method prompts.
1486 (defvar gnus-method-history nil)
1488 ;; Variable holding the user answers to all mail method prompts.
1489 (defvar gnus-mail-method-history nil)
1491 ;; Variable holding the user answers to all group prompts.
1492 (defvar gnus-group-history nil)
1494 (defvar gnus-server-alist nil
1495 "List of available servers.")
1497 (defcustom gnus-cache-directory
1498 (nnheader-concat gnus-directory "cache/")
1499 "*The directory where cached articles will be stored."
1503 (defvar gnus-predefined-server-alist
1506 (nnspool-spool-directory ,gnus-cache-directory)
1507 (nnspool-nov-directory ,gnus-cache-directory)
1508 (nnspool-active-file
1509 ,(nnheader-concat gnus-cache-directory "active"))))
1510 "List of predefined (convenience) servers.")
1512 (defvar gnus-topic-indentation "");; Obsolete variable.
1514 (defconst gnus-article-mark-lists
1515 '((marked . tick) (replied . reply)
1516 (expirable . expire) (killed . killed)
1517 (bookmarks . bookmark) (dormant . dormant)
1518 (scored . score) (saved . save)
1519 (cached . cache) (downloadable . download)
1520 (unsendable . unsend)))
1522 (defvar gnus-headers-retrieved-by nil)
1523 (defvar gnus-article-reply nil)
1524 (defvar gnus-override-method nil)
1525 (defvar gnus-article-check-size nil)
1526 (defvar gnus-opened-servers nil)
1528 (defvar gnus-current-kill-article nil)
1530 (defvar gnus-have-read-active-file nil)
1532 (defconst gnus-maintainer
1533 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1534 "The mail address of the Gnus maintainers.")
1536 (defvar gnus-info-nodes
1537 '((gnus-group-mode "(gnus)The Group Buffer")
1538 (gnus-summary-mode "(gnus)The Summary Buffer")
1539 (gnus-article-mode "(gnus)The Article Buffer")
1540 (gnus-server-mode "(gnus)The Server Buffer")
1541 (gnus-browse-mode "(gnus)Browse Foreign Server")
1542 (gnus-tree-mode "(gnus)Tree Display"))
1543 "Alist of major modes and related Info nodes.")
1545 (defvar gnus-group-buffer "*Group*")
1546 (defvar gnus-summary-buffer "*Summary*")
1547 (defvar gnus-article-buffer "*Article*")
1548 (defvar gnus-server-buffer "*Server*")
1550 (defvar gnus-slave nil
1551 "Whether this Gnus is a slave or not.")
1553 (defvar gnus-batch-mode nil
1554 "Whether this Gnus is running in batch mode or not.")
1556 (defvar gnus-variable-list
1557 '(gnus-newsrc-options gnus-newsrc-options-n
1558 gnus-newsrc-last-checked-date
1559 gnus-newsrc-alist gnus-server-alist
1560 gnus-killed-list gnus-zombie-list
1561 gnus-topic-topology gnus-topic-alist
1563 "Gnus variables saved in the quick startup file.")
1565 (defvar gnus-newsrc-alist nil
1566 "Assoc list of read articles.
1567 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1569 (defvar gnus-newsrc-hashtb nil
1570 "Hashtable of gnus-newsrc-alist.")
1572 (defvar gnus-killed-list nil
1573 "List of killed newsgroups.")
1575 (defvar gnus-killed-hashtb nil
1576 "Hash table equivalent of gnus-killed-list.")
1578 (defvar gnus-zombie-list nil
1579 "List of almost dead newsgroups.")
1581 (defvar gnus-description-hashtb nil
1582 "Descriptions of newsgroups.")
1584 (defvar gnus-list-of-killed-groups nil
1585 "List of newsgroups that have recently been killed by the user.")
1587 (defvar gnus-active-hashtb nil
1588 "Hashtable of active articles.")
1590 (defvar gnus-moderated-hashtb nil
1591 "Hashtable of moderated newsgroups.")
1593 ;; Save window configuration.
1594 (defvar gnus-prev-winconf nil)
1596 (defvar gnus-reffed-article-number nil)
1598 ;;; Let the byte-compiler know that we know about this variable.
1599 (defvar rmail-default-rmail-file)
1601 (defvar gnus-dead-summary nil)
1603 ;;; End of variables.
1605 ;; Define some autoload functions Gnus might use.
1608 ;; This little mapcar goes through the list below and marks the
1609 ;; symbols in question as autoloaded functions.
1612 (let ((interactive (nth 1 (memq ':interactive package))))
1616 (when (consp function)
1617 (setq keymap (car (memq 'keymap function)))
1618 (setq function (car function)))
1619 (autoload function (car package) nil interactive keymap)))
1620 (if (eq (nth 1 package) ':interactive)
1623 '(("metamail" metamail-buffer)
1624 ("info" Info-goto-node)
1625 ("pp" pp pp-to-string pp-eval-expression)
1626 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1627 ("ps-print" ps-print-preprint)
1628 ("mail-extr" mail-extract-address-components)
1629 ("browse-url" browse-url)
1630 ("message" :interactive t
1631 message-send-and-exit message-yank-original)
1632 ("babel" babel-as-string)
1633 ("nnmail" nnmail-split-fancy nnmail-article-group)
1634 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1635 ("rmailout" rmail-output rmail-output-to-rmail-file)
1636 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1637 rmail-show-message rmail-summary-exists
1638 rmail-select-summary rmail-update-summary)
1639 ("gnus-audio" :interactive t gnus-audio-play)
1640 ("gnus-xmas" gnus-xmas-splash)
1641 ("gnus-soup" :interactive t
1642 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1643 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1644 ("nnsoup" nnsoup-pack-replies)
1645 ("score-mode" :interactive t gnus-score-mode)
1646 ("gnus-mh" gnus-summary-save-article-folder
1647 gnus-Folder-save-name gnus-folder-save-name)
1648 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1649 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1650 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1651 gnus-demon-add-disconnection gnus-demon-add-handler
1652 gnus-demon-remove-handler)
1653 ("gnus-demon" :interactive t
1654 gnus-demon-init gnus-demon-cancel)
1655 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1656 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1657 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1658 gnus-nocem-unwanted-article-p)
1659 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1660 gnus-server-server-name)
1661 ("gnus-srvr" gnus-browse-foreign-server)
1662 ("gnus-cite" :interactive t
1663 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1664 gnus-article-hide-citation gnus-article-fill-cited-article
1665 gnus-article-hide-citation-in-followups)
1666 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1667 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1668 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1669 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1670 gnus-cache-possibly-remove-articles gnus-cache-request-article
1671 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1672 gnus-cache-enter-remove-article gnus-cached-article-p
1673 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1674 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1675 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1676 ("gnus-score" :interactive t
1677 gnus-summary-increase-score gnus-summary-set-score
1678 gnus-summary-raise-thread gnus-summary-raise-same-subject
1679 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1680 gnus-summary-lower-thread gnus-summary-lower-same-subject
1681 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1682 gnus-summary-current-score gnus-score-default
1683 gnus-score-flush-cache gnus-score-close
1684 gnus-possibly-score-headers gnus-score-followup-article
1685 gnus-score-followup-thread)
1687 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1688 gnus-current-score-file-nondirectory gnus-score-adaptive
1689 gnus-score-find-trace gnus-score-file-name)
1690 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1691 ("gnus-topic" :interactive t gnus-topic-mode)
1692 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1693 gnus-subscribe-topics)
1694 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1695 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1696 ("gnus-uu" :interactive t
1697 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1698 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1699 gnus-uu-mark-by-regexp gnus-uu-mark-all
1700 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1701 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1702 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1703 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1704 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1705 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1706 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1707 gnus-uu-mark-over gnus-uu-post-news)
1708 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1709 ("gnus-msg" (gnus-summary-send-map keymap)
1710 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1711 ("gnus-msg" :interactive t
1712 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1713 gnus-summary-followup gnus-summary-followup-with-original
1714 gnus-summary-cancel-article gnus-summary-supersede-article
1715 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1716 gnus-summary-mail-forward gnus-summary-mail-other-window
1717 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1718 gnus-summary-wide-reply gnus-summary-followup-to-mail
1719 gnus-summary-followup-to-mail-with-original gnus-bug
1720 gnus-summary-wide-reply-with-original
1721 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1722 gnus-summary-post-forward)
1723 ("gnus-picon" :interactive t gnus-article-display-picons
1724 gnus-group-display-picons gnus-picons-article-display-x-face
1725 gnus-picons-display-x-face)
1726 ("gnus-picon" gnus-picons-buffer-name)
1727 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1728 gnus-grouplens-mode)
1729 ("smiley" :interactive t gnus-smiley-display)
1730 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1731 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1732 gnus-list-of-unread-articles gnus-list-of-read-articles
1733 gnus-offer-save-summaries gnus-make-thread-indent-array
1734 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1735 gnus-summary-skip-intangible gnus-summary-article-number
1736 gnus-data-header gnus-data-find)
1737 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1738 gnus-group-list-groups gnus-group-first-unread-group
1739 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1740 gnus-group-setup-buffer gnus-group-get-new-news
1741 gnus-group-make-help-group gnus-group-update-group
1742 gnus-group-iterate gnus-group-group-name)
1743 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1744 gnus-backlog-remove-article)
1745 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1746 gnus-article-prepare gnus-article-set-window-start
1747 gnus-article-next-page gnus-article-prev-page
1748 gnus-request-article-this-buffer gnus-article-mode
1749 gnus-article-setup-buffer gnus-narrow-to-page
1750 gnus-article-delete-invisible-text gnus-treat-article)
1751 ("gnus-art" :interactive t
1752 gnus-article-hide-headers gnus-article-hide-boring-headers
1753 gnus-article-treat-overstrike
1754 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1755 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1756 gnus-article-decode-HZ
1757 gnus-article-hide-pgp
1758 gnus-article-hide-pem gnus-article-hide-signature
1759 gnus-article-strip-leading-blank-lines gnus-article-date-local
1760 gnus-article-date-original gnus-article-date-lapsed
1761 gnus-article-show-all-headers
1762 gnus-article-edit-mode gnus-article-edit-article
1763 gnus-article-edit-done gnus-article-decode-encoded-words
1764 gnus-start-date-timer gnus-stop-date-timer
1765 gnus-mime-view-all-parts)
1766 ("gnus-int" gnus-request-type)
1767 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1768 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1769 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1770 gnus-dup-enter-articles)
1771 ("gnus-range" gnus-copy-sequence)
1772 ("gnus-eform" gnus-edit-form)
1773 ("gnus-move" :interactive t
1774 gnus-group-move-group-to-server gnus-change-server)
1775 ("gnus-logic" gnus-score-advanced)
1776 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1777 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1778 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1779 gnus-async-halt-prefetch)
1780 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1781 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1782 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1783 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1784 ("gnus-agent" :interactive t
1785 gnus-unplugged gnus-agentize gnus-agent-batch)
1786 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1787 gnus-summary-save-article-vm)
1788 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1789 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1790 ("gnus-mlspl" :interactive t gnus-group-split-setup
1791 gnus-group-split-update))))
1793 ;;; gnus-sum.el thingies
1796 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1797 "*The format specification of the lines in the summary buffer.
1799 It works along the same lines as a normal formatting string,
1800 with some simple extensions.
1802 %N Article number, left padded with spaces (string)
1804 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1805 %n Name of the poster (string)
1806 %a Extracted name of the poster (string)
1807 %A Extracted address of the poster (string)
1808 %F Contents of the From: header (string)
1809 %f Contents of the From: or To: headers (string)
1810 %x Contents of the Xref: header (string)
1811 %D Date of the article (string)
1812 %d Date of the article (string) in DD-MMM format
1813 %M Message-id of the article (string)
1814 %r References of the article (string)
1815 %c Number of characters in the article (integer)
1816 %L Number of lines in the article (integer)
1817 %I Indentation based on thread level (a string of spaces)
1818 %T A string with two possible values: 80 spaces if the article
1819 is on thread level two or larger and 0 spaces on level one
1820 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1821 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1822 %[ Opening bracket (character, \"[\" or \"<\")
1823 %] Closing bracket (character, \"]\" or \">\")
1824 %> Spaces of length thread-level (string)
1825 %< Spaces of length (- 20 thread-level) (string)
1826 %i Article score (number)
1827 %z Article zcore (character)
1828 %t Number of articles under the current thread (number).
1829 %e Whether the thread is empty or not (character).
1830 %l GroupLens score (string).
1831 %V Total thread score (number).
1832 %P The line number (number).
1833 %O Download mark (character).
1834 %u User defined specifier. The next character in the format string should
1835 be a letter. Gnus will call the function gnus-user-format-function-X,
1836 where X is the letter following %u. The function will be passed the
1837 current header as argument. The function should return a string, which
1838 will be inserted into the summary just like information from any other
1841 Text between %( and %) will be highlighted with `gnus-mouse-face'
1842 when the mouse point is placed inside the area. There can only be one
1845 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1846 with care. For reasons of efficiency, Gnus will compute what column
1847 these characters will end up in, and \"hard-code\" that. This means that
1848 it is invalid to have these specs after a variable-length spec. Well,
1849 you might not be arrested, but your summary buffer will look strange,
1850 which is bad enough.
1852 The smart choice is to have these specs as for to the left as
1855 This restriction may disappear in later versions of Gnus."
1857 :group 'gnus-summary-format)
1860 ;;; Skeleton keymaps
1863 (defun gnus-suppress-keymap (keymap)
1864 (suppress-keymap keymap)
1865 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1867 (define-key keymap (pop keys) 'undefined))))
1869 (defvar gnus-article-mode-map
1870 (let ((keymap (make-sparse-keymap)))
1871 (gnus-suppress-keymap keymap)
1873 (defvar gnus-summary-mode-map
1874 (let ((keymap (make-keymap)))
1875 (gnus-suppress-keymap keymap)
1877 (defvar gnus-group-mode-map
1878 (let ((keymap (make-keymap)))
1879 (gnus-suppress-keymap keymap)
1884 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1885 ;; If you want the cursor to go somewhere else, set these two
1886 ;; functions in some startup hook to whatever you want.
1887 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1888 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1890 ;;; Various macros and substs.
1892 (defun gnus-header-from (header)
1893 (mail-header-from header))
1895 (defmacro gnus-gethash (string hashtable)
1896 "Get hash value of STRING in HASHTABLE."
1897 `(symbol-value (intern-soft ,string ,hashtable)))
1899 (defmacro gnus-sethash (string value hashtable)
1900 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1901 `(set (intern ,string ,hashtable) ,value))
1902 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1904 (defmacro gnus-group-unread (group)
1905 "Get the currently computed number of unread articles in GROUP."
1906 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1908 (defmacro gnus-group-entry (group)
1909 "Get the newsrc entry for GROUP."
1910 `(gnus-gethash ,group gnus-newsrc-hashtb))
1912 (defmacro gnus-active (group)
1913 "Get active info on GROUP."
1914 `(gnus-gethash ,group gnus-active-hashtb))
1916 (defmacro gnus-set-active (group active)
1917 "Set GROUP's active info."
1918 `(gnus-sethash ,group ,active gnus-active-hashtb))
1920 ;; Info access macros.
1922 (defmacro gnus-info-group (info)
1924 (defmacro gnus-info-rank (info)
1926 (defmacro gnus-info-read (info)
1928 (defmacro gnus-info-marks (info)
1930 (defmacro gnus-info-method (info)
1932 (defmacro gnus-info-params (info)
1935 (defmacro gnus-info-level (info)
1936 `(let ((rank (gnus-info-rank ,info)))
1940 (defmacro gnus-info-score (info)
1941 `(let ((rank (gnus-info-rank ,info)))
1942 (or (and (consp rank) (cdr rank)) 0)))
1944 (defmacro gnus-info-set-group (info group)
1945 `(setcar ,info ,group))
1946 (defmacro gnus-info-set-rank (info rank)
1947 `(setcar (nthcdr 1 ,info) ,rank))
1948 (defmacro gnus-info-set-read (info read)
1949 `(setcar (nthcdr 2 ,info) ,read))
1950 (defmacro gnus-info-set-marks (info marks &optional extend)
1952 `(gnus-info-set-entry ,info ,marks 3)
1953 `(setcar (nthcdr 3 ,info) ,marks)))
1954 (defmacro gnus-info-set-method (info method &optional extend)
1956 `(gnus-info-set-entry ,info ,method 4)
1957 `(setcar (nthcdr 4 ,info) ,method)))
1958 (defmacro gnus-info-set-params (info params &optional extend)
1960 `(gnus-info-set-entry ,info ,params 5)
1961 `(setcar (nthcdr 5 ,info) ,params)))
1963 (defun gnus-info-set-entry (info entry number)
1964 ;; Extend the info until we have enough elements.
1965 (while (<= (length info) number)
1966 (nconc info (list nil)))
1968 (setcar (nthcdr number info) entry))
1970 (defmacro gnus-info-set-level (info level)
1971 `(let ((rank (cdr ,info)))
1972 (if (consp (car rank))
1973 (setcar (car rank) ,level)
1974 (setcar rank ,level))))
1975 (defmacro gnus-info-set-score (info score)
1976 `(let ((rank (cdr ,info)))
1977 (if (consp (car rank))
1978 (setcdr (car rank) ,score)
1979 (setcar rank (cons (car rank) ,score)))))
1981 (defmacro gnus-get-info (group)
1982 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1984 ;; Byte-compiler warning.
1985 (defvar gnus-visual)
1986 ;; Find out whether the gnus-visual TYPE is wanted.
1987 (defun gnus-visual-p (&optional type class)
1988 (and gnus-visual ; Has to be non-nil, at least.
1989 (if (not type) ; We don't care about type.
1991 (if (listp gnus-visual) ; It's a list, so we check it.
1992 (or (memq type gnus-visual)
1993 (memq class gnus-visual))
1996 ;;; Load the compatability functions.
2005 (defvar gnus-shutdown-alist nil)
2007 (defun gnus-add-shutdown (function &rest symbols)
2008 "Run FUNCTION whenever one of SYMBOLS is shut down."
2009 (push (cons function symbols) gnus-shutdown-alist))
2011 (defun gnus-shutdown (symbol)
2012 "Shut down everything that waits for SYMBOL."
2013 (let ((alist gnus-shutdown-alist)
2015 (while (setq entry (pop alist))
2016 (when (memq symbol (cdr entry))
2017 (funcall (car entry))))))
2021 ;;; Gnus Utility Functions
2025 (defmacro gnus-string-or (&rest strings)
2026 "Return the first element of STRINGS that is a non-blank string.
2027 STRINGS will be evaluated in normal `or' order."
2028 `(gnus-string-or-1 ',strings))
2030 (defun gnus-string-or-1 (strings)
2033 (setq string (eval (pop strings)))
2034 (if (string-match "^[ \t]*$" string)
2036 (setq strings nil)))
2039 (defun gnus-version (&optional arg)
2040 "Version number of this version of Gnus.
2041 If ARG, insert string at point."
2044 (insert (message gnus-version))
2045 (message gnus-version)))
2047 (defun gnus-continuum-version (version)
2048 "Return VERSION as a floating point number."
2049 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2050 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2051 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2052 (number (match-string 2 version))
2054 (unless (string-match
2055 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2056 (error "Invalid version string: %s" version))
2057 (setq major (string-to-number (match-string 1 number))
2058 minor (string-to-number (match-string 2 number))
2059 least (if (match-beginning 3)
2060 (string-to-number (match-string 3 number))
2064 (format "%s00%02d%02d"
2065 (if (member alpha '("(ding)" "d"))
2069 (- (mm-char-int (aref (downcase alpha) 0))
2073 (format "%d.%02d%02d" major minor least))))))
2075 (defun gnus-info-find-node ()
2076 "Find Info documentation of Gnus."
2078 ;; Enlarge info window if needed.
2079 (let (gnus-info-buffer)
2080 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2081 (setq gnus-info-buffer (current-buffer))
2082 (gnus-configure-windows 'info)))
2085 ;;; gnus-interactive
2088 (defvar gnus-current-prefix-symbol nil
2089 "Current prefix symbol.")
2091 (defvar gnus-current-prefix-symbols nil
2092 "List of current prefix symbols.")
2094 (defun gnus-interactive (string &optional params)
2095 "Return a list that can be fed to `interactive'.
2096 See `interactive' for full documentation.
2098 Adds the following specs:
2100 y -- The current symbolic prefix.
2101 Y -- A list of the current symbolic prefix(es).
2102 A -- Article number.
2103 H -- Article header.
2107 (while (< i (length string))
2108 (string-match ".\\([^\n]*\\)\n?" string i)
2109 (setq c (aref string i))
2111 (setq prompt (match-string 1 string)))
2112 (setq i (match-end 0))
2113 ;; We basically emulate just about everything that
2114 ;; `interactive' does, but add the specs listed above.
2118 (completing-read prompt obarray 'fboundp t))
2120 (read-buffer prompt (current-buffer) t))
2122 (read-buffer prompt (other-buffer (current-buffer))))
2126 (completing-read prompt obarray 'commandp t))
2130 (read-file-name prompt nil default-directory 'lambda))
2132 (read-file-name prompt nil nil 'lambda))
2134 (read-file-name prompt))
2136 (read-key-sequence prompt))
2138 (error "Not implemented spec"))
2140 (error "Not implemented spec"))
2144 (error "Not implemented spec"))
2146 (string-to-number (read-from-minibuffer prompt)))
2148 (prefix-numeric-value current-prefix-arg))
2154 (read-string prompt))
2156 (intern (read-string prompt)))
2158 (read-variable prompt))
2160 (read-minibuffer prompt))
2162 (eval-minibuffer prompt))
2163 ;; And here the new specs come.
2165 gnus-current-prefix-symbol)
2167 gnus-current-prefix-symbols)
2169 (gnus-group-group-name))
2171 (gnus-summary-skip-intangible)
2172 (or (get-text-property (point) 'gnus-number)
2173 (gnus-summary-last-subject)))
2175 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2177 (error "Non-implemented spec")))
2181 (push (if (< (point) (mark) (point) (mark))) out)
2182 (push (if (> (point) (mark) (point) (mark))) out))))
2183 (setq out (delq 'gnus-prefix-nil out))
2186 (defun gnus-symbolic-argument (&optional arg)
2187 "Read a symbolic argument and a command, and then execute command."
2189 (let* ((in-command (this-command-keys))
2190 (command in-command)
2191 gnus-current-prefix-symbols
2192 gnus-current-prefix-symbol
2194 (while (equal in-command command)
2195 (message "%s-" (key-description (this-command-keys)))
2196 (push (intern (char-to-string (read-char))) syms)
2197 (setq command (read-key-sequence nil t)))
2198 (setq gnus-current-prefix-symbols (nreverse syms)
2199 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2200 (call-interactively (key-binding command t))))
2202 ;;; More various functions.
2204 (defsubst gnus-check-backend-function (func group)
2205 "Check whether GROUP supports function FUNC.
2206 GROUP can either be a string (a group name) or a select method."
2208 (let ((method (if (stringp group)
2209 (car (gnus-find-method-for-group group))
2211 (unless (featurep method)
2213 (fboundp (intern (format "%s-%s" method func))))))
2215 (defun gnus-group-read-only-p (&optional group)
2216 "Check whether GROUP supports editing or not.
2217 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2218 that that variable is buffer-local to the summary buffers."
2219 (let ((group (or group gnus-newsgroup-name)))
2220 (not (gnus-check-backend-function 'request-replace-article group))))
2222 (defun gnus-group-total-expirable-p (group)
2223 "Check whether GROUP is total-expirable or not."
2224 (let ((params (gnus-group-find-parameter group))
2227 ((memq 'total-expire params)
2229 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2231 (gnus-total-expirable-newsgroups ; Check var.
2232 (string-match gnus-total-expirable-newsgroups group)))))
2234 (defun gnus-group-auto-expirable-p (group)
2235 "Check whether GROUP is auto-expirable or not."
2236 (let ((params (gnus-group-find-parameter group))
2239 ((memq 'auto-expire params)
2241 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2243 (gnus-auto-expirable-newsgroups ; Check var.
2244 (string-match gnus-auto-expirable-newsgroups group)))))
2246 (defun gnus-virtual-group-p (group)
2247 "Say whether GROUP is virtual or not."
2248 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2249 gnus-valid-select-methods)))
2251 (defun gnus-news-group-p (group &optional article)
2252 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2253 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2254 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2255 (if (or (null article)
2256 (not (< article 0)))
2257 (eq (gnus-request-type group article) 'news)
2258 (if (not (vectorp article))
2260 ;; It's a real article.
2261 (eq (gnus-request-type group (mail-header-id article))
2264 ;; Returns a list of writable groups.
2265 (defun gnus-writable-groups ()
2266 (let ((alist gnus-newsrc-alist)
2268 (while (setq group (car (pop alist)))
2269 (unless (gnus-group-read-only-p group)
2270 (push group groups)))
2273 ;; Check whether to use long file names.
2274 (defun gnus-use-long-file-name (symbol)
2275 ;; The variable has to be set...
2276 (and gnus-use-long-file-name
2277 ;; If it isn't a list, then we return t.
2278 (or (not (listp gnus-use-long-file-name))
2279 ;; If it is a list, and the list contains `symbol', we
2281 (not (memq symbol gnus-use-long-file-name)))))
2283 ;; Generate a unique new group name.
2284 (defun gnus-generate-new-group-name (leaf)
2287 (while (gnus-gethash name gnus-newsrc-hashtb)
2288 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2291 (defun gnus-ephemeral-group-p (group)
2292 "Say whether GROUP is ephemeral or not."
2293 (gnus-group-get-parameter group 'quit-config t))
2295 (defun gnus-group-quit-config (group)
2296 "Return the quit-config of GROUP."
2297 (gnus-group-get-parameter group 'quit-config t))
2299 (defun gnus-kill-ephemeral-group (group)
2300 "Remove ephemeral GROUP from relevant structures."
2301 (gnus-sethash group nil gnus-newsrc-hashtb))
2303 (defun gnus-simplify-mode-line ()
2304 "Make mode lines a bit simpler."
2305 (setq mode-line-modified (cdr gnus-mode-line-modified))
2306 (when (listp mode-line-format)
2307 (make-local-variable 'mode-line-format)
2308 (setq mode-line-format (copy-sequence mode-line-format))
2309 (when (equal (nth 3 mode-line-format) " ")
2310 (setcar (nthcdr 3 mode-line-format) " "))))
2312 ;;; Servers and groups.
2314 (defsubst gnus-server-add-address (method)
2315 (let ((method-name (symbol-name (car method))))
2316 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2317 (not (assq (intern (concat method-name "-address")) method))
2318 (memq 'physical-address (assq (car method)
2319 gnus-valid-select-methods)))
2320 (append method (list (list (intern (concat method-name "-address"))
2324 (defsubst gnus-server-get-method (group method)
2325 ;; Input either a server name, and extended server name, or a
2326 ;; select method, and return a select method.
2327 (cond ((stringp method)
2328 (gnus-server-to-method method))
2329 ((equal method gnus-select-method)
2331 ((and (stringp (car method))
2333 (gnus-server-extend-method group method))
2336 (equal (cadr method) ""))
2339 (gnus-server-add-address method))))
2341 (defun gnus-server-to-method (server)
2342 "Map virtual server names to select methods."
2344 ;; Is this a method, perhaps?
2345 (and server (listp server) server)
2346 ;; Perhaps this is the native server?
2347 (and (equal server "native") gnus-select-method)
2348 ;; It should be in the server alist.
2349 (cdr (assoc server gnus-server-alist))
2350 ;; It could be in the predefined server alist.
2351 (cdr (assoc server gnus-predefined-server-alist))
2352 ;; If not, we look through all the opened server
2353 ;; to see whether we can find it there.
2354 (let ((opened gnus-opened-servers))
2356 (not (equal server (format "%s:%s" (caaar opened)
2360 ;; It could be a named method, search all servers
2361 (let ((servers gnus-secondary-select-methods))
2363 (not (equal server (format "%s:%s" (caar servers)
2368 (defmacro gnus-method-equal (ss1 ss2)
2369 "Say whether two servers are equal."
2373 (and (= (length s1) (length s2))
2375 (while (and s1 (member (car s1) s2))
2379 (defun gnus-methods-equal-p (m1 m2)
2380 (let ((m1 (or m1 gnus-select-method))
2381 (m2 (or m2 gnus-select-method)))
2383 (and (eq (car m1) (car m2))
2384 (or (not (memq 'address (assoc (symbol-name (car m1))
2385 gnus-valid-select-methods)))
2386 (equal (nth 1 m1) (nth 1 m2)))))))
2388 (defun gnus-server-equal (m1 m2)
2389 "Say whether two methods are equal."
2390 (let ((m1 (cond ((null m1) gnus-select-method)
2391 ((stringp m1) (gnus-server-to-method m1))
2393 (m2 (cond ((null m2) gnus-select-method)
2394 ((stringp m2) (gnus-server-to-method m2))
2396 (gnus-method-equal m1 m2)))
2398 (defun gnus-servers-using-backend (backend)
2399 "Return a list of known servers using BACKEND."
2400 (let ((opened gnus-opened-servers)
2403 (when (eq backend (caaar opened))
2404 (push (caar opened) out))
2408 (defun gnus-archive-server-wanted-p ()
2409 "Say whether the user wants to use the archive server."
2411 ((or (not gnus-message-archive-method)
2412 (not gnus-message-archive-group))
2414 ((and gnus-message-archive-method gnus-message-archive-group)
2417 (let ((active (cadr (assq 'nnfolder-active-file
2418 gnus-message-archive-method))))
2420 (file-exists-p active))))))
2422 (defun gnus-group-prefixed-name (group method)
2423 "Return the whole name from GROUP and METHOD."
2424 (and (stringp method) (setq method (gnus-server-to-method method)))
2425 (if (or (not method)
2426 (gnus-server-equal method "native"))
2428 (concat (format "%s" (car method))
2430 (or (assoc (format "%s" (car method))
2431 (gnus-methods-using 'address))
2432 (gnus-server-equal method gnus-message-archive-method))
2434 (not (string= (nth 1 method) "")))
2435 (concat "+" (nth 1 method)))
2438 (defun gnus-group-real-prefix (group)
2439 "Return the prefix of the current group name."
2440 (if (string-match "^[^:]+:" group)
2441 (substring group 0 (match-end 0))
2444 (defun gnus-group-method (group)
2445 "Return the server or method used for selecting GROUP.
2446 You should probably use `gnus-find-method-for-group' instead."
2447 (let ((prefix (gnus-group-real-prefix group)))
2448 (if (equal prefix "")
2450 (let ((servers gnus-opened-servers)
2452 backend possible found)
2453 (if (string-match "^[^\\+]+\\+" prefix)
2454 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2455 server (substring prefix (match-end 0) (1- (length prefix))))
2456 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2458 (when (eq (caaar servers) backend)
2459 (setq possible (caar servers))
2460 (when (equal (cadaar servers) server)
2461 (setq found (caar servers))))
2463 (or (car (rassoc found gnus-server-alist))
2465 (car (rassoc possible gnus-server-alist))
2467 (list backend server))))))
2469 (defsubst gnus-native-method-p (method)
2470 "Return whether METHOD is the native select method."
2471 (gnus-method-equal method gnus-select-method))
2473 (defsubst gnus-secondary-method-p (method)
2474 "Return whether METHOD is a secondary select method."
2475 (let ((methods gnus-secondary-select-methods)
2476 (gmethod (gnus-server-get-method nil method)))
2478 (not (gnus-method-equal
2479 (gnus-server-get-method nil (car methods))
2481 (setq methods (cdr methods)))
2484 (defun gnus-method-simplify (method)
2485 "Return the shortest uniquely identifying string or method for METHOD."
2486 (cond ((stringp method)
2488 ((gnus-native-method-p method)
2490 ((gnus-secondary-method-p method)
2491 (format "%s:%s" (nth 0 method) (nth 1 method)))
2495 (defun gnus-groups-from-server (server)
2496 "Return a list of all groups that are fetched from SERVER."
2497 (let ((alist (cdr gnus-newsrc-alist))
2499 (while (setq info (pop alist))
2500 (when (gnus-server-equal (gnus-info-method info) server)
2501 (push (gnus-info-group info) groups)))
2502 (sort groups 'string<)))
2504 (defun gnus-group-foreign-p (group)
2505 "Say whether a group is foreign or not."
2506 (and (not (gnus-group-native-p group))
2507 (not (gnus-group-secondary-p group))))
2509 (defun gnus-group-native-p (group)
2510 "Say whether the group is native or not."
2511 (not (string-match ":" group)))
2513 (defun gnus-group-secondary-p (group)
2514 "Say whether the group is secondary or not."
2515 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2517 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2518 "Return the group parameters for GROUP.
2519 If SYMBOL, return the value of that symbol in the group parameters."
2521 (set-buffer gnus-group-buffer)
2522 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2524 (gnus-group-parameter-value parameters symbol allow-list)
2527 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2528 "Return the group parameters for GROUP.
2529 If SYMBOL, return the value of that symbol in the group parameters.
2530 Most functions should use `gnus-group-find-parameter', which
2531 also examines the topic parameters."
2532 (let ((params (gnus-info-params (gnus-get-info group))))
2534 (gnus-group-parameter-value params symbol allow-list)
2537 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2538 "Return the value of SYMBOL in group PARAMS."
2539 ;; We only wish to return group parameters (dotted lists) and
2540 ;; not local variables, which may have the same names.
2541 ;; But first we handle single elements...
2542 (or (car (memq symbol params))
2546 (while (setq elem (pop params))
2547 (when (and (consp elem)
2548 (eq (car elem) symbol)
2551 (throw 'found (cdr elem))))))))
2553 (defun gnus-group-add-parameter (group param)
2554 "Add parameter PARAM to GROUP."
2555 (let ((info (gnus-get-info group)))
2557 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2558 ;; Cons the new param to the old one and update.
2559 (gnus-group-set-info (cons param (gnus-info-params info))
2562 (defun gnus-group-set-parameter (group name value)
2563 "Set parameter NAME to VALUE in GROUP."
2564 (let ((info (gnus-get-info group)))
2566 (gnus-group-remove-parameter group name)
2567 (let ((old-params (gnus-info-params info))
2568 (new-params (list (cons name value))))
2570 (when (or (not (listp (car old-params)))
2571 (not (eq (caar old-params) name)))
2572 (setq new-params (append new-params (list (car old-params)))))
2573 (setq old-params (cdr old-params)))
2574 (gnus-group-set-info new-params group 'params)))))
2576 (defun gnus-group-remove-parameter (group name)
2577 "Remove parameter NAME from GROUP."
2578 (let ((info (gnus-get-info group)))
2580 (let ((params (gnus-info-params info)))
2582 (setq params (delq name params))
2583 (while (assq name params)
2584 (gnus-pull name params))
2585 (gnus-info-set-params info params))))))
2587 (defun gnus-group-add-score (group &optional score)
2588 "Add SCORE to the GROUP score.
2589 If SCORE is nil, add 1 to the score of GROUP."
2590 (let ((info (gnus-get-info group)))
2592 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2594 (defun gnus-short-group-name (group &optional levels)
2595 "Collapse GROUP name LEVELS.
2596 Select methods are stripped and any remote host name is stripped down to
2597 just the host name."
2603 gnus-group-uncollapsed-levels
2605 (while (string-match "\\." group skip)
2606 (setq skip (match-end 0)
2609 ;; Separate foreign select method from group name and collapse.
2610 ;; If method contains a server, collapse to non-domain server name,
2611 ;; otherwise collapse to select method.
2612 (let* ((colon (string-match ":" group))
2613 (server (and colon (substring group 0 colon)))
2614 (plus (and server (string-match "+" server))))
2617 (setq foreign (substring server (+ 1 plus)
2618 (string-match "\\." server))
2619 group (substring group (+ 1 colon)))
2620 (setq foreign server
2621 group (substring group (+ 1 colon))))
2622 (setq foreign (concat foreign ":")))
2623 ;; Collapse group name leaving LEVELS uncollapsed elements
2624 (let* ((glist (split-string group "\\."))
2625 (glen (length glist))
2627 (setq levels (- glen levels))
2629 (push (if (>= (decf levels) 0)
2630 (if (zerop (length g))
2635 (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2637 (defun gnus-narrow-to-body ()
2638 "Narrow to the body of an article."
2641 (goto-char (point-min))
2642 (or (search-forward "\n\n" nil t)
2648 ;;; Kill file handling.
2651 (defun gnus-apply-kill-file ()
2652 "Apply a kill file to the current newsgroup.
2653 Returns the number of articles marked as read."
2654 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2655 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2656 (gnus-apply-kill-file-internal)
2659 (defun gnus-kill-save-kill-buffer ()
2660 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2661 (when (get-file-buffer file)
2663 (set-buffer (get-file-buffer file))
2664 (when (buffer-modified-p)
2666 (kill-buffer (current-buffer))))))
2668 (defcustom gnus-kill-file-name "KILL"
2669 "Suffix of the kill files."
2670 :group 'gnus-score-kill
2671 :group 'gnus-score-files
2674 (defun gnus-newsgroup-kill-file (newsgroup)
2675 "Return the name of a kill file name for NEWSGROUP.
2676 If NEWSGROUP is nil, return the global kill file name instead."
2678 ;; The global KILL file is placed at top of the directory.
2679 ((or (null newsgroup)
2680 (string-equal newsgroup ""))
2681 (expand-file-name gnus-kill-file-name
2682 gnus-kill-files-directory))
2683 ;; Append ".KILL" to newsgroup name.
2684 ((gnus-use-long-file-name 'not-kill)
2685 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2686 "." gnus-kill-file-name)
2687 gnus-kill-files-directory))
2688 ;; Place "KILL" under the hierarchical directory.
2690 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2691 "/" gnus-kill-file-name)
2692 gnus-kill-files-directory))))
2696 (defun gnus-member-of-valid (symbol group)
2697 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2699 (symbol-name (car (gnus-find-method-for-group group)))
2700 gnus-valid-select-methods)))
2702 (defun gnus-method-option-p (method option)
2703 "Return non-nil if select METHOD has OPTION as a parameter."
2704 (when (stringp method)
2705 (setq method (gnus-server-to-method method)))
2706 (memq option (assoc (format "%s" (car method))
2707 gnus-valid-select-methods)))
2709 (defun gnus-similar-server-opened (method)
2710 (let ((opened gnus-opened-servers))
2711 (while (and method opened)
2712 (when (and (equal (cadr method) (cadaar opened))
2713 (equal (car method) (caaar opened))
2714 (not (equal method (caar opened))))
2719 (defun gnus-server-extend-method (group method)
2720 ;; This function "extends" a virtual server. If the server is
2721 ;; "hello", and the select method is ("hello" (my-var "something"))
2722 ;; in the group "alt.alt", this will result in a new virtual server
2723 ;; called "hello+alt.alt".
2724 (if (or (not (inline (gnus-similar-server-opened method)))
2725 (not (cddr method)))
2727 `(,(car method) ,(concat (cadr method) "+" group)
2728 (,(intern (format "%s-address" (car method))) ,(cadr method))
2731 (defun gnus-server-status (method)
2732 "Return the status of METHOD."
2733 (nth 1 (assoc method gnus-opened-servers)))
2735 (defun gnus-group-name-to-method (group)
2736 "Guess a select method based on GROUP."
2737 (if (string-match ":" group)
2738 (let ((server (substring group 0 (match-beginning 0))))
2739 (if (string-match "\\+" server)
2740 (list (intern (substring server 0 (match-beginning 0)))
2741 (substring server (match-end 0)))
2742 (list (intern server) "")))
2743 gnus-select-method))
2745 (defun gnus-find-method-for-group (group &optional info)
2746 "Find the select method that GROUP uses."
2747 (or gnus-override-method
2750 (and (not (gnus-group-entry group));; a new group
2751 (gnus-group-name-to-method group))
2752 (let ((info (or info (gnus-get-info group)))
2755 (not (setq method (gnus-info-method info)))
2756 (equal method "native"))
2759 (cond ((stringp method)
2760 (inline (gnus-server-to-method method)))
2761 ((stringp (cadr method))
2762 (inline (gnus-server-extend-method group method)))
2765 (cond ((equal (cadr method) "")
2767 ((null (cadr method))
2768 (list (car method) ""))
2770 (gnus-server-add-address method)))))))
2772 (defun gnus-methods-using (feature)
2773 "Find all methods that have FEATURE."
2774 (let ((valids gnus-valid-select-methods)
2777 (when (memq feature (car valids))
2778 (push (car valids) outs))
2779 (setq valids (cdr valids)))
2782 (defun gnus-read-group (prompt &optional default)
2783 "Prompt the user for a group name.
2784 Disallow invalid group names."
2790 (setq group (read-string (concat prefix prompt)
2791 (cons (or default "") 0)
2792 'gnus-group-history)))
2793 (setq prefix (format "Invalid group name: \"%s\". " group)
2797 (defun gnus-read-method (prompt)
2798 "Prompt the user for a method.
2799 Allow completion over sensible values."
2801 (append gnus-valid-select-methods
2802 (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2804 gnus-opened-servers)
2805 gnus-predefined-server-alist
2810 nil t nil 'gnus-method-history)))
2813 (setq method gnus-select-method))
2814 ((assoc method gnus-valid-select-methods)
2815 (let ((address (if (memq 'prompt-address
2816 (assoc method gnus-valid-select-methods))
2817 (read-string "Address: ")
2819 (or (let ((opened gnus-opened-servers))
2821 (not (equal (format "%s:%s" method address)
2822 (format "%s:%s" (caaar opened)
2826 (list (intern method) address))))
2827 ((assoc method servers)
2830 (list (intern method) "")))))
2832 ;;; User-level commands.
2835 (defun gnus-slave-no-server (&optional arg)
2836 "Read network news as a slave, without connecting to local server."
2838 (gnus-no-server arg t))
2841 (defun gnus-no-server (&optional arg slave)
2843 If ARG is a positive number, Gnus will use that as the
2844 startup level. If ARG is nil, Gnus will be started at level 2.
2845 If ARG is non-nil and not a positive number, Gnus will
2846 prompt the user for the name of an NNTP server to use.
2847 As opposed to `gnus', this command will not connect to the local server."
2849 (gnus-no-server-1 arg slave))
2852 (defun gnus-slave (&optional arg)
2853 "Read news as a slave."
2855 (gnus arg nil 'slave))
2858 (defun gnus-other-frame (&optional arg)
2859 "Pop up a frame to read news."
2861 (let ((window (get-buffer-window gnus-group-buffer)))
2863 (select-frame (window-frame window)))
2869 (defun gnus (&optional arg dont-connect slave)
2871 If ARG is non-nil and a positive number, Gnus will use that as the
2872 startup level. If ARG is non-nil and not a positive number, Gnus will
2873 prompt the user for the name of an NNTP server to use."
2875 (gnus-1 arg dont-connect slave))
2877 ;; Allow redefinition of Gnus functions.
2883 ;;; gnus.el ends here