1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987,88,89,90,93,94,95,96,97,98 Free Software Foundation, Inc.
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
7 ;; Yoshiki Hayashi <g740685@komaba.ecc.u-tokyo.ac.jp>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
31 (eval '(run-hooks 'gnus-load-hook))
33 (eval-when-compile (require 'cl))
37 (if (< emacs-major-version 20)
38 (require 'gnus-load)))
42 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
46 (defgroup gnus-cache nil
50 (defgroup gnus-start nil
51 "Starting your favorite newsreader."
54 (defgroup gnus-start-server nil
55 "Server options at startup."
58 ;; These belong to gnus-group.el.
59 (defgroup gnus-group nil
61 :link '(custom-manual "(gnus)The Group Buffer")
64 (defgroup gnus-group-foreign nil
66 :link '(custom-manual "(gnus)Foreign Groups")
69 (defgroup gnus-group-new nil
70 "Automatic subscription of new groups."
73 (defgroup gnus-group-levels nil
75 :link '(custom-manual "(gnus)Group Levels")
78 (defgroup gnus-group-select nil
80 :link '(custom-manual "(gnus)Selecting a Group")
83 (defgroup gnus-group-listing nil
84 "Showing slices of the group list."
85 :link '(custom-manual "(gnus)Listing Groups")
88 (defgroup gnus-group-visual nil
89 "Sorting the group buffer."
90 :link '(custom-manual "(gnus)Group Buffer Format")
94 (defgroup gnus-group-various nil
95 "Various group options."
96 :link '(custom-manual "(gnus)Scanning New Messages")
99 ;; These belong to gnus-sum.el.
100 (defgroup gnus-summary nil
102 :link '(custom-manual "(gnus)The Summary Buffer")
105 (defgroup gnus-summary-exit nil
106 "Leaving summary buffers."
107 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
108 :group 'gnus-summary)
110 (defgroup gnus-summary-marks nil
111 "Marks used in summary buffers."
112 :link '(custom-manual "(gnus)Marking Articles")
113 :group 'gnus-summary)
115 (defgroup gnus-thread nil
116 "Ordering articles according to replies."
117 :link '(custom-manual "(gnus)Threading")
118 :group 'gnus-summary)
120 (defgroup gnus-summary-format nil
121 "Formatting of the summary buffer."
122 :link '(custom-manual "(gnus)Summary Buffer Format")
123 :group 'gnus-summary)
125 (defgroup gnus-summary-choose nil
127 :link '(custom-manual "(gnus)Choosing Articles")
128 :group 'gnus-summary)
130 (defgroup gnus-summary-maneuvering nil
131 "Summary movement commands."
132 :link '(custom-manual "(gnus)Summary Maneuvering")
133 :group 'gnus-summary)
135 (defgroup gnus-summary-mail nil
136 "Mail group commands."
137 :link '(custom-manual "(gnus)Mail Group Commands")
138 :group 'gnus-summary)
140 (defgroup gnus-summary-sort nil
141 "Sorting the summary buffer."
142 :link '(custom-manual "(gnus)Sorting")
143 :group 'gnus-summary)
145 (defgroup gnus-summary-visual nil
146 "Highlighting and menus in the summary buffer."
147 :link '(custom-manual "(gnus)Summary Highlighting")
149 :group 'gnus-summary)
151 (defgroup gnus-summary-various nil
152 "Various summary buffer options."
153 :link '(custom-manual "(gnus)Various Summary Stuff")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-pick nil
157 "Pick mode in the summary buffer."
158 :link '(custom-manual "(gnus)Pick and Read")
160 :group 'gnus-summary)
162 (defgroup gnus-summary-tree nil
163 "Tree display of threads in the summary buffer."
164 :link '(custom-manual "(gnus)Tree Display")
166 :group 'gnus-summary)
168 ;; Belongs to gnus-uu.el
169 (defgroup gnus-extract-view nil
170 "Viewing extracted files."
171 :link '(custom-manual "(gnus)Viewing Files")
172 :group 'gnus-extract)
174 ;; Belongs to gnus-score.el
175 (defgroup gnus-score nil
176 "Score and kill file handling."
179 (defgroup gnus-score-kill nil
183 (defgroup gnus-score-adapt nil
184 "Adaptive score files."
187 (defgroup gnus-score-default nil
188 "Default values for score files."
191 (defgroup gnus-score-expire nil
192 "Expiring score rules."
195 (defgroup gnus-score-decay nil
196 "Decaying score rules."
199 (defgroup gnus-score-files nil
200 "Score and kill file names."
204 (defgroup gnus-score-various nil
205 "Various scoring and killing options."
209 (defgroup gnus-visual nil
210 "Options controling the visual fluff."
214 (defgroup gnus-agent nil
215 "Offline support for Gnus."
218 (defgroup gnus-files nil
219 "Files used by Gnus."
222 (defgroup gnus-dribble-file nil
224 :link '(custom-manual "(gnus)Auto Save")
227 (defgroup gnus-newsrc nil
228 "Storing Gnus state."
231 (defgroup gnus-server nil
232 "Options related to newsservers and other servers used by Gnus."
235 (defgroup gnus-message '((message custom-group))
236 "Composing replies and followups in Gnus."
239 (defgroup gnus-meta nil
240 "Meta variables controling major portions of Gnus.
241 In general, modifying these variables does not take affect until Gnus
242 is restarted, and sometimes reloaded."
245 (defgroup gnus-various nil
246 "Other Gnus options."
247 :link '(custom-manual "(gnus)Various Various")
250 (defgroup gnus-mime nil
251 "Variables for controlling the Gnus MIME interface."
254 (defgroup gnus-exit nil
256 :link '(custom-manual "(gnus)Exiting Gnus")
259 (defconst gnus-product-name "T-gnus"
260 "Product name of this version of gnus.")
262 (defconst gnus-version-number "6.10.027"
263 "Version number for this version of gnus.")
265 (defconst gnus-original-version-number "0.40"
266 "Version number for this version of Gnus.")
268 (defconst gnus-original-product-name "Pterodactyl Gnus"
269 "Product name of the original version of Gnus.")
271 (defconst gnus-version
272 (format "%s %s (based on %s %s ; for SEMI 1.10, FLIM 1.11)"
273 gnus-product-name gnus-version-number
274 gnus-original-product-name gnus-original-version-number)
275 "Version string for this version of gnus.")
277 (defcustom gnus-inhibit-startup-message nil
278 "If non-nil, the startup message will not be displayed.
279 This variable is used before `.gnus.el' is loaded, so it should
280 be set in `.emacs' instead."
284 (defcustom gnus-play-startup-jingle nil
285 "If non-nil, play the Gnus jingle at startup."
289 (unless (featurep 'gnus-xmas)
290 (defalias 'gnus-make-overlay 'make-overlay)
291 (defalias 'gnus-delete-overlay 'delete-overlay)
292 (defalias 'gnus-overlay-put 'overlay-put)
293 (defalias 'gnus-move-overlay 'move-overlay)
294 (defalias 'gnus-overlay-end 'overlay-end)
295 (defalias 'gnus-extent-detached-p 'ignore)
296 (defalias 'gnus-extent-start-open 'ignore)
297 (defalias 'gnus-set-text-properties 'set-text-properties)
298 (defalias 'gnus-group-remove-excess-properties 'ignore)
299 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
300 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
301 (defalias 'gnus-character-to-event 'identity)
302 (defalias 'gnus-add-text-properties 'add-text-properties)
303 (defalias 'gnus-put-text-property 'put-text-property)
304 (defalias 'gnus-mode-line-buffer-identification 'identity)
305 (defalias 'gnus-characterp 'numberp)
306 (defalias 'gnus-deactivate-mark 'deactivate-mark)
307 (defalias 'gnus-window-edges 'window-edges)
308 (defalias 'gnus-key-press-event-p 'numberp)
309 (defalias 'gnus-annotation-in-region-p 'ignore)
310 (defalias 'gnus-decode-rfc1522 'ignore))
312 ;; We define these group faces here to avoid the display
313 ;; update forced when creating new faces.
315 (defface gnus-group-news-1-face
318 (:foreground "PaleTurquoise" :bold t))
321 (:foreground "ForestGreen" :bold t))
324 "Level 1 newsgroup face.")
326 (defface gnus-group-news-1-empty-face
329 (:foreground "PaleTurquoise"))
332 (:foreground "ForestGreen"))
335 "Level 1 empty newsgroup face.")
337 (defface gnus-group-news-2-face
340 (:foreground "turquoise" :bold t))
343 (:foreground "CadetBlue4" :bold t))
346 "Level 2 newsgroup face.")
348 (defface gnus-group-news-2-empty-face
351 (:foreground "turquoise"))
354 (:foreground "CadetBlue4"))
357 "Level 2 empty newsgroup face.")
359 (defface gnus-group-news-3-face
368 "Level 3 newsgroup face.")
370 (defface gnus-group-news-3-empty-face
379 "Level 3 empty newsgroup face.")
381 (defface gnus-group-news-4-face
390 "Level 4 newsgroup face.")
392 (defface gnus-group-news-4-empty-face
401 "Level 4 empty newsgroup face.")
403 (defface gnus-group-news-5-face
412 "Level 5 newsgroup face.")
414 (defface gnus-group-news-5-empty-face
423 "Level 5 empty newsgroup face.")
425 (defface gnus-group-news-6-face
434 "Level 6 newsgroup face.")
436 (defface gnus-group-news-6-empty-face
445 "Level 6 empty newsgroup face.")
447 (defface gnus-group-news-low-face
450 (:foreground "DarkTurquoise" :bold t))
453 (:foreground "DarkGreen" :bold t))
456 "Low level newsgroup face.")
458 (defface gnus-group-news-low-empty-face
461 (:foreground "DarkTurquoise"))
464 (:foreground "DarkGreen"))
467 "Low level empty newsgroup face.")
469 (defface gnus-group-mail-1-face
472 (:foreground "aquamarine1" :bold t))
475 (:foreground "DeepPink3" :bold t))
478 "Level 1 mailgroup face.")
480 (defface gnus-group-mail-1-empty-face
483 (:foreground "aquamarine1"))
486 (:foreground "DeepPink3"))
488 (:italic t :bold t)))
489 "Level 1 empty mailgroup face.")
491 (defface gnus-group-mail-2-face
494 (:foreground "aquamarine2" :bold t))
497 (:foreground "HotPink3" :bold t))
500 "Level 2 mailgroup face.")
502 (defface gnus-group-mail-2-empty-face
505 (:foreground "aquamarine2"))
508 (:foreground "HotPink3"))
511 "Level 2 empty mailgroup face.")
513 (defface gnus-group-mail-3-face
516 (:foreground "aquamarine3" :bold t))
519 (:foreground "magenta4" :bold t))
522 "Level 3 mailgroup face.")
524 (defface gnus-group-mail-3-empty-face
527 (:foreground "aquamarine3"))
530 (:foreground "magenta4"))
533 "Level 3 empty mailgroup face.")
535 (defface gnus-group-mail-low-face
538 (:foreground "aquamarine4" :bold t))
541 (:foreground "DeepPink4" :bold t))
544 "Low level mailgroup face.")
546 (defface gnus-group-mail-low-empty-face
549 (:foreground "aquamarine4"))
552 (:foreground "DeepPink4"))
555 "Low level empty mailgroup face.")
557 ;; Summary mode faces.
559 (defface gnus-summary-selected-face '((t
561 "Face used for selected articles.")
563 (defface gnus-summary-cancelled-face
565 (:foreground "yellow" :background "black")))
566 "Face used for cancelled articles.")
568 (defface gnus-summary-high-ticked-face
571 (:foreground "pink" :bold t))
574 (:foreground "firebrick" :bold t))
577 "Face used for high interest ticked articles.")
579 (defface gnus-summary-low-ticked-face
582 (:foreground "pink" :italic t))
585 (:foreground "firebrick" :italic t))
588 "Face used for low interest ticked articles.")
590 (defface gnus-summary-normal-ticked-face
593 (:foreground "pink"))
596 (:foreground "firebrick"))
599 "Face used for normal interest ticked articles.")
601 (defface gnus-summary-high-ancient-face
604 (:foreground "SkyBlue" :bold t))
607 (:foreground "RoyalBlue" :bold t))
610 "Face used for high interest ancient articles.")
612 (defface gnus-summary-low-ancient-face
615 (:foreground "SkyBlue" :italic t))
618 (:foreground "RoyalBlue" :italic t))
621 "Face used for low interest ancient articles.")
623 (defface gnus-summary-normal-ancient-face
626 (:foreground "SkyBlue"))
629 (:foreground "RoyalBlue"))
632 "Face used for normal interest ancient articles.")
634 (defface gnus-summary-high-unread-face
637 "Face used for high interest unread articles.")
639 (defface gnus-summary-low-unread-face
642 "Face used for low interest unread articles.")
644 (defface gnus-summary-normal-unread-face
647 "Face used for normal interest unread articles.")
649 (defface gnus-summary-high-read-face
652 (:foreground "PaleGreen"
656 (:foreground "DarkGreen"
660 "Face used for high interest read articles.")
662 (defface gnus-summary-low-read-face
665 (:foreground "PaleGreen"
669 (:foreground "DarkGreen"
673 "Face used for low interest read articles.")
675 (defface gnus-summary-normal-read-face
678 (:foreground "PaleGreen"))
681 (:foreground "DarkGreen"))
684 "Face used for normal interest read articles.")
691 (defvar gnus-buffers nil)
693 (defun gnus-get-buffer-create (name)
694 "Do the same as `get-buffer-create', but store the created buffer."
695 (or (get-buffer name)
696 (car (push (get-buffer-create name) gnus-buffers))))
698 (defun gnus-add-buffer ()
699 "Add the current buffer to the list of Gnus buffers."
700 (push (current-buffer) gnus-buffers))
702 (defun gnus-buffers ()
703 "Return a list of live Gnus buffers."
704 (while (and gnus-buffers
705 (not (buffer-name (car gnus-buffers))))
707 (let ((buffers gnus-buffers))
709 (if (buffer-name (cadr buffers))
711 (setcdr buffers (cddr buffers)))))
716 (defvar gnus-group-buffer "*Group*")
719 (autoload 'gnus-play-jingle "gnus-audio"))
721 (defface gnus-splash-face
724 (:foreground "Brown"))
727 (:foreground "Brown"))
730 "Face of the splash screen.")
732 (defun gnus-splash ()
734 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
735 (let ((buffer-read-only nil))
737 (unless gnus-inhibit-startup-message
738 (gnus-group-startup-message)
740 (when gnus-play-startup-jingle
741 (gnus-play-jingle))))))
743 (defun gnus-indent-rigidly (start end arg)
744 "Indent rigidly using only spaces and no tabs."
747 (narrow-to-region start end)
749 (indent-rigidly start end arg)
750 ;; We translate tabs into spaces -- not everybody uses
751 ;; an 8-character tab.
752 (goto-char (point-min))
753 (while (search-forward "\t" nil t)
754 (replace-match " " t t))))))
756 (defvar gnus-simple-splash nil)
758 (defun gnus-group-startup-message (&optional x y)
759 "Insert startup message in current buffer."
760 ;; Insert the message.
765 _ ___ __ ___ __ _ ___
785 (gnus-indent-rigidly (point-min) (point-max)
786 (/ (max (- (window-width) (or x 46)) 0) 2))
787 (goto-char (point-min))
789 (let* ((pheight (count-lines (point-min) (point-max)))
790 (wheight (window-height))
791 (rest (- wheight pheight)))
792 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
794 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
795 (goto-char (point-min))
796 (setq mode-line-buffer-identification (concat " " gnus-version))
797 (setq gnus-simple-splash t)
798 (set-buffer-modified-p t))
801 (let ((command (format "%s" this-command)))
802 (if (and (string-match "gnus" command)
803 (not (string-match "gnus-other-frame" command)))
805 (gnus-get-buffer-create gnus-group-buffer))))
813 (defcustom gnus-home-directory "~/"
814 "Directory variable that specifies the \"home\" directory.
815 All other Gnus path variables are initialized from this variable."
819 (defcustom gnus-directory (or (getenv "SAVEDIR")
820 (nnheader-concat gnus-home-directory "News/"))
821 "*Directory variable from which all other Gnus file variables are derived.
823 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
824 This means that other directory variables that are initialized from
825 this variable won't be set properly if you set this variable in `.gnus.el'.
826 Set this variable in `.emacs' instead."
830 (defcustom gnus-default-directory nil
831 "*Default directory for all Gnus buffers."
833 :type '(choice (const :tag "current" nil)
836 ;; Site dependent variables. These variables should be defined in
839 (defvar gnus-default-nntp-server nil
840 "Specify a default NNTP server.
841 This variable should be defined in paths.el, and should never be set
843 If you want to change servers, you should use `gnus-select-method'.
844 See the documentation to that variable.")
846 ;; Don't touch this variable.
847 (defvar gnus-nntp-service "nntp"
848 "NNTP service name (\"nntp\" or 119).
849 This is an obsolete variable, which is scarcely used. If you use an
850 nntp server for your newsgroup and want to change the port number
851 used to 899, you would say something along these lines:
853 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
855 (defcustom gnus-nntpserver-file "/etc/nntpserver"
856 "A file with only the name of the nntp server in it."
861 ;; This function is used to check both the environment variable
862 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
863 ;; an nntp server name default.
864 (defun gnus-getenv-nntpserver ()
865 (or (getenv "NNTPSERVER")
866 (and (file-readable-p gnus-nntpserver-file)
868 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
869 (insert-file-contents gnus-nntpserver-file)
870 (let ((name (buffer-string)))
872 (if (string-match "^[ \t\n]*$" name)
875 (kill-buffer (current-buffer))))))))
877 (defcustom gnus-select-method
880 (list 'nntp (or (condition-case nil
881 (gnus-getenv-nntpserver)
883 (when (and gnus-default-nntp-server
884 (not (string= gnus-default-nntp-server "")))
885 gnus-default-nntp-server)
887 (if (or (null gnus-nntp-service)
888 (equal gnus-nntp-service "nntp"))
890 (list gnus-nntp-service)))
892 "*Default method for selecting a newsgroup.
893 This variable should be a list, where the first element is how the
894 news is to be fetched, the second is the address.
896 For instance, if you want to get your news via NNTP from
897 \"flab.flab.edu\", you could say:
899 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
901 If you want to use your local spool, say:
903 \(setq gnus-select-method (list 'nnspool (system-name)))
905 If you use this variable, you must set `gnus-nntp-server' to nil.
907 There is a lot more to know about select methods and virtual servers -
908 see the manual for details."
910 :type 'gnus-select-method)
912 (defcustom gnus-message-archive-method
915 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
916 (nnfolder-active-file
917 ,(nnheader-concat message-directory "archive/active"))
918 (nnfolder-get-new-mail nil)
919 (nnfolder-inhibit-expiry t))
920 "*Method used for archiving messages you've sent.
921 This should be a mail method.
923 It's probably not a very effective to change this variable once you've
924 run Gnus once. After doing that, you must edit this server from the
928 :type 'gnus-select-method)
930 (defcustom gnus-message-archive-group nil
931 "*Name of the group in which to save the messages you've written.
932 This can either be a string; a list of strings; or an alist
933 of regexps/functions/forms to be evaluated to return a string (or a list
934 of strings). The functions are called with the name of the current
935 group (or nil) as a parameter.
937 If you want to save your mail in one group and the news articles you
938 write in another group, you could say something like:
940 \(setq gnus-message-archive-group
941 '((if (message-news-p)
945 Normally the group names returned by this variable should be
946 unprefixed -- which implicitly means \"store on the archive server\".
947 However, you may wish to store the message on some other server. In
948 that case, just return a fully prefixed name of the group --
949 \"nnml+private:mail.misc\", for instance."
951 :type '(choice (const :tag "none" nil)
954 (defcustom gnus-secondary-servers nil
955 "List of NNTP servers that the user can choose between interactively.
956 To make Gnus query you for a server, you have to give `gnus' a
957 non-numeric prefix - `C-u M-x gnus', in short."
959 :type '(repeat string))
961 (defcustom gnus-nntp-server nil
962 "*The name of the host running the NNTP server.
963 This variable is semi-obsolete. Use the `gnus-select-method'
966 :type '(choice (const :tag "disable" nil)
969 (defcustom gnus-secondary-select-methods nil
970 "A list of secondary methods that will be used for reading news.
971 This is a list where each element is a complete select method (see
972 `gnus-select-method').
974 If, for instance, you want to read your mail with the nnml backend,
975 you could set this variable:
977 \(setq gnus-secondary-select-methods '((nnml \"\")))"
979 :type '(repeat gnus-select-method))
981 (defvar gnus-backup-default-subscribed-newsgroups
982 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
983 "Default default new newsgroups the first time Gnus is run.
984 Should be set in paths.el, and shouldn't be touched by the user.")
986 (defcustom gnus-local-domain nil
987 "Local domain name without a host name.
988 The DOMAINNAME environment variable is used instead if it is defined.
989 If the `system-name' function returns the full Internet name, there is
990 no need to set this variable."
992 :type '(choice (const :tag "default" nil)
995 (defvar gnus-local-organization nil
996 "String with a description of what organization (if any) the user belongs to.
997 Obsolete variable; use `message-user-organization' instead.")
999 ;; Customization variables
1001 (defcustom gnus-refer-article-method nil
1002 "Preferred method for fetching an article by Message-ID.
1003 If you are reading news from the local spool (with nnspool), fetching
1004 articles by Message-ID is painfully slow. By setting this method to an
1005 nntp method, you might get acceptable results.
1007 The value of this variable must be a valid select method as discussed
1008 in the documentation of `gnus-select-method'."
1010 :type '(choice (const :tag "default" nil)
1011 gnus-select-method))
1013 (defcustom gnus-group-faq-directory
1014 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1015 "/ftp@sunsite.auc.dk:/pub/usenet/"
1016 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1017 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1018 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1019 "/ftp@rtfm.mit.edu:/pub/usenet/"
1020 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1021 "/ftp@ftp.sunet.se:/pub/usenet/"
1022 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1023 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1024 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1025 "*Directory where the group FAQs are stored.
1026 This will most commonly be on a remote machine, and the file will be
1027 fetched by ange-ftp.
1029 This variable can also be a list of directories. In that case, the
1030 first element in the list will be used by default. The others can
1031 be used when being prompted for a site.
1033 Note that Gnus uses an aol machine as the default directory. If this
1034 feels fundamentally unclean, just think of it as a way to finally get
1035 something of value back from them.
1037 If the default site is too slow, try one of these:
1039 North America: mirrors.aol.com /pub/rtfm/usenet
1040 ftp.seas.gwu.edu /pub/rtfm
1041 rtfm.mit.edu /pub/usenet
1042 Europe: ftp.uni-paderborn.de /pub/FAQ
1043 src.doc.ic.ac.uk /usenet/news-FAQS
1044 ftp.sunet.se /pub/usenet
1045 sunsite.auc.dk /pub/usenet
1046 Asia: nctuccca.edu.tw /USENET/FAQ
1047 hwarang.postech.ac.kr /pub/usenet
1048 ftp.hk.super.net /mirror/faqs"
1049 :group 'gnus-group-various
1050 :type '(choice directory
1051 (repeat directory)))
1053 (defcustom gnus-use-cross-reference t
1054 "*Non-nil means that cross referenced articles will be marked as read.
1055 If nil, ignore cross references. If t, mark articles as read in
1056 subscribed newsgroups. If neither t nor nil, mark as read in all
1059 :type '(choice (const :tag "off" nil)
1060 (const :tag "subscribed" t)
1064 (defcustom gnus-process-mark ?#
1066 :group 'gnus-group-visual
1067 :group 'gnus-summary-marks
1070 (defcustom gnus-asynchronous nil
1071 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1072 :group 'gnus-asynchronous
1075 (defcustom gnus-large-newsgroup 200
1076 "*The number of articles which indicates a large newsgroup.
1077 If the number of articles in a newsgroup is greater than this value,
1078 confirmation is required for selecting the newsgroup."
1079 :group 'gnus-group-select
1082 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1083 "*Non-nil means that the default name of a file to save articles in is the group name.
1084 If it's nil, the directory form of the group name is used instead.
1086 If this variable is a list, and the list contains the element
1087 `not-score', long file names will not be used for score files; if it
1088 contains the element `not-save', long file names will not be used for
1089 saving; and if it contains the element `not-kill', long file names
1090 will not be used for kill files.
1092 Note that the default for this variable varies according to what system
1093 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1094 to nil while on all other systems it defaults to t."
1098 (defcustom gnus-kill-files-directory gnus-directory
1099 "*Name of the directory where kill files will be stored (default \"~/News\")."
1100 :group 'gnus-score-files
1101 :group 'gnus-score-kill
1104 (defcustom gnus-save-score nil
1105 "*If non-nil, save group scoring info."
1106 :group 'gnus-score-various
1110 (defcustom gnus-use-undo t
1111 "*If non-nil, allow undoing in Gnus group mode buffers."
1115 (defcustom gnus-use-adaptive-scoring nil
1116 "*If non-nil, use some adaptive scoring scheme.
1117 If a list, then the values `word' and `line' are meaningful. The
1118 former will perform adaption on individual words in the subject
1119 header while `line' will perform adaption on several headers."
1121 :group 'gnus-score-adapt
1122 :type '(set (const word) (const line)))
1124 (defcustom gnus-use-cache 'passive
1125 "*If nil, Gnus will ignore the article cache.
1126 If `passive', it will allow entering (and reading) articles
1127 explicitly entered into the cache. If anything else, use the
1128 cache to the full extent of the law."
1131 :type '(choice (const :tag "off" nil)
1132 (const :tag "passive" passive)
1133 (const :tag "active" t)))
1135 (defcustom gnus-use-trees nil
1136 "*If non-nil, display a thread tree buffer."
1140 (defcustom gnus-use-grouplens nil
1141 "*If non-nil, use GroupLens ratings."
1145 (defcustom gnus-keep-backlog nil
1146 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1147 If it is a number N, then Gnus will only keep the last N articles
1148 read. If it is neither nil nor a number, Gnus will keep all read
1149 articles. This is not a good idea."
1151 :type '(choice (const :tag "off" nil)
1156 (defcustom gnus-use-nocem nil
1157 "*If non-nil, Gnus will read NoCeM cancel messages."
1161 (defcustom gnus-suppress-duplicates nil
1162 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1166 (defcustom gnus-use-demon nil
1167 "If non-nil, Gnus might use some demons."
1171 (defcustom gnus-use-scoring t
1172 "*If non-nil, enable scoring."
1176 (defcustom gnus-use-picons nil
1177 "*If non-nil, display picons."
1181 (defcustom gnus-summary-prepare-exit-hook
1182 '(gnus-summary-expire-articles)
1183 "*A hook called when preparing to exit from the summary buffer.
1184 It calls `gnus-summary-expire-articles' by default."
1185 :group 'gnus-summary-exit
1188 (defcustom gnus-novice-user t
1189 "*Non-nil means that you are a usenet novice.
1190 If non-nil, verbose messages may be displayed and confirmations may be
1195 (defcustom gnus-expert-user nil
1196 "*Non-nil means that you will never be asked for confirmation about anything.
1197 That doesn't mean *anything* anything; particularly destructive
1198 commands will still require prompting."
1202 (defcustom gnus-interactive-catchup t
1203 "*If non-nil, require your confirmation when catching up a group."
1204 :group 'gnus-group-select
1207 (defcustom gnus-interactive-exit t
1208 "*If non-nil, require your confirmation when exiting Gnus."
1212 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1213 "*Function for extracting address components from a From header.
1214 Two pre-defined function exist: `gnus-extract-address-components',
1215 which is the default, quite fast, and too simplistic solution, and
1216 `mail-extract-address-components', which works much better, but is
1218 :group 'gnus-summary-format
1219 :type '(radio (function-item gnus-extract-address-components)
1220 (function-item mail-extract-address-components)
1221 (function-item std11-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)
1252 ("nnagent" post-mail))
1253 "*An alist of valid select methods.
1254 The first element of each list lists should be a string with the name
1255 of the select method. The other elements may be the category of
1256 this method (i. e., `post', `mail', `none' or whatever) or other
1257 properties that this method has (like being respoolable).
1258 If you implement a new select method, all you should have to change is
1259 this variable. I think."
1261 :type '(repeat (group (string :tag "Name")
1262 (radio-button-choice (const :format "%v " post)
1263 (const :format "%v " mail)
1264 (const :format "%v " none)
1266 (checklist :inline t
1267 (const :format "%v " address)
1268 (const :format "%v " prompt-address)
1269 (const :format "%v " physical-address)
1270 (const :format "%v " virtual)
1273 (define-widget 'gnus-select-method 'list
1274 "Widget for entering a select method."
1275 :args `((choice :tag "Method"
1276 ,@(mapcar (lambda (entry)
1277 (list 'const :format "%v\n"
1278 (intern (car entry))))
1279 gnus-valid-select-methods))
1280 (string :tag "Address")
1281 (editable-list :inline t
1284 (sexp :tag "Value")))))
1286 (defcustom gnus-updated-mode-lines '(group article summary tree)
1287 "List of buffers that should update their mode lines.
1288 The list may contain the symbols `group', `article', `tree' and
1289 `summary'. If the corresponding symbol is present, Gnus will keep
1290 that mode line updated with information that may be pertinent.
1291 If this variable is nil, screen refresh may be quicker."
1292 :group 'gnus-various
1293 :type '(set (const group)
1298 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1299 (defcustom gnus-mode-non-string-length nil
1300 "*Max length of mode-line non-string contents.
1301 If this is nil, Gnus will take space as is needed, leaving the rest
1302 of the modeline intact. Note that the default of nil is unlikely
1303 to be desirable; see the manual for further details."
1304 :group 'gnus-various
1305 :type '(choice (const nil)
1308 (defcustom gnus-auto-expirable-newsgroups nil
1309 "*Groups in which to automatically mark read articles as expirable.
1310 If non-nil, this should be a regexp that should match all groups in
1311 which to perform auto-expiry. This only makes sense for mail groups."
1312 :group 'nnmail-expire
1313 :type '(choice (const nil)
1316 (defcustom gnus-total-expirable-newsgroups nil
1317 "*Groups in which to perform expiry of all read articles.
1318 Use with extreme caution. All groups that match this regexp will be
1319 expiring - which means that all read articles will be deleted after
1320 \(say) one week. (This only goes for mail groups and the like, of
1322 :group 'nnmail-expire
1323 :type '(choice (const nil)
1326 (defcustom gnus-group-uncollapsed-levels 1
1327 "Number of group name elements to leave alone when making a short group name."
1328 :group 'gnus-group-visual
1331 (defcustom gnus-group-use-permanent-levels nil
1332 "*If non-nil, once you set a level, Gnus will use this level."
1333 :group 'gnus-group-levels
1338 (defcustom gnus-load-hook nil
1339 "A hook run while Gnus is loaded."
1343 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1344 "A hook called to apply kill files to a group.
1345 This hook is intended to apply a kill file to the selected newsgroup.
1346 The function `gnus-apply-kill-file' is called by default.
1348 Since a general kill file is too heavy to use only for a few
1349 newsgroups, I recommend you to use a lighter hook function. For
1350 example, if you'd like to apply a kill file to articles which contains
1351 a string `rmgroup' in subject in newsgroup `control', you can use the
1354 (setq gnus-apply-kill-hook
1357 (cond ((string-match \"control\" gnus-newsgroup-name)
1358 (gnus-kill \"Subject\" \"rmgroup\")
1359 (gnus-expunge \"X\"))))))"
1360 :group 'gnus-score-kill
1361 :options '(gnus-apply-kill-file)
1364 (defcustom gnus-group-change-level-function nil
1365 "Function run when a group level is changed.
1366 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1367 :group 'gnus-group-level
1372 (defcustom gnus-visual
1373 '(summary-highlight group-highlight article-highlight
1375 summary-menu group-menu article-menu
1376 tree-highlight menu highlight
1377 browse-menu server-menu
1378 page-marker tree-menu binary-menu pick-menu
1380 "*Enable visual features.
1381 If `visual' is disabled, there will be no menus and few faces. Most of
1382 the visual customization options below will be ignored. Gnus will use
1383 less space and be faster as a result.
1385 This variable can also be a list of visual elements to switch on. For
1386 instance, to switch off all visual things except menus, you can say:
1388 (setq gnus-visual '(menu))
1390 Valid elements include `summary-highlight', `group-highlight',
1391 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1392 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1393 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1394 and `grouplens-menu'."
1397 :type '(set (const summary-highlight)
1398 (const group-highlight)
1399 (const article-highlight)
1401 (const summary-menu)
1403 (const article-menu)
1404 (const tree-highlight)
1413 (const grouplens-menu)))
1415 (defcustom gnus-mouse-face
1417 (if (gnus-visual-p 'mouse-face 'highlight)
1418 (if (boundp 'gnus-mouse-face)
1419 (or gnus-mouse-face 'highlight)
1423 "*Face used for group or summary buffer mouse highlighting.
1424 The line beneath the mouse pointer will be highlighted with this
1429 (defcustom gnus-article-display-hook
1430 (if (and (string-match "XEmacs" emacs-version)
1432 '(gnus-article-hide-headers-if-wanted
1433 gnus-article-hide-boring-headers
1434 gnus-article-treat-overstrike
1435 gnus-article-maybe-highlight
1436 gnus-article-display-x-face)
1437 '(gnus-article-hide-headers-if-wanted
1438 gnus-article-hide-boring-headers
1439 gnus-article-treat-overstrike
1440 gnus-article-maybe-highlight))
1441 "*Controls how the article buffer will look.
1443 If you leave the list empty, the article will appear exactly as it is
1444 stored on the disk. The list entries will hide or highlight various
1445 parts of the article, making it easier to find the information you
1447 :group 'gnus-article-highlight
1450 :options '(gnus-article-add-buttons
1451 gnus-article-add-buttons-to-head
1452 gnus-article-emphasize
1453 gnus-article-fill-cited-article
1454 gnus-article-remove-cr
1455 gnus-summary-stop-page-breaking
1456 ;; gnus-summary-caesar-message
1457 ;; gnus-summary-verbose-headers
1458 gnus-summary-toggle-mime
1460 gnus-article-hide-headers
1461 gnus-article-hide-boring-headers
1462 gnus-article-hide-signature
1463 gnus-article-hide-citation
1464 gnus-article-hide-pgp
1465 gnus-article-hide-pem
1466 gnus-article-highlight
1467 gnus-article-highlight-headers
1468 gnus-article-highlight-citation
1469 gnus-article-highlight-signature
1470 gnus-article-date-ut
1471 gnus-article-date-local
1472 gnus-article-date-lapsed
1473 gnus-article-date-original
1474 gnus-article-remove-trailing-blank-lines
1475 gnus-article-strip-leading-blank-lines
1476 gnus-article-strip-multiple-blank-lines
1477 gnus-article-strip-blank-lines
1478 gnus-article-treat-overstrike
1479 gnus-article-display-x-face
1480 gnus-smiley-display))
1482 (defcustom gnus-article-save-directory gnus-directory
1483 "*Name of the directory articles will be saved in (default \"~/News\")."
1484 :group 'gnus-article-saving
1487 (defvar gnus-plugged t
1488 "Whether Gnus is plugged or not.")
1491 ;;; Internal variables
1493 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1494 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1495 (defvar gnus-original-article-buffer " *Original Article*")
1496 (defvar gnus-newsgroup-name nil)
1497 (defvar gnus-ephemeral-servers nil)
1499 (defvar gnus-agent nil
1500 "Whether we want to use the Gnus agent or not.")
1502 (defvar gnus-command-method nil
1503 "Dynamically bound variable that says what the current backend is.")
1505 (defvar gnus-current-select-method nil
1506 "The current method for selecting a newsgroup.")
1508 (defvar gnus-tree-buffer "*Tree*"
1509 "Buffer where Gnus thread trees are displayed.")
1512 (defvar gnus-use-generic-from nil)
1514 ;; Variable holding the user answers to all method prompts.
1515 (defvar gnus-method-history nil)
1517 ;; Variable holding the user answers to all mail method prompts.
1518 (defvar gnus-mail-method-history nil)
1520 ;; Variable holding the user answers to all group prompts.
1521 (defvar gnus-group-history nil)
1523 (defvar gnus-server-alist nil
1524 "List of available servers.")
1526 (defcustom gnus-cache-directory
1527 (nnheader-concat gnus-directory "cache/")
1528 "*The directory where cached articles will be stored."
1532 (defvar gnus-predefined-server-alist
1535 (nnspool-spool-directory ,gnus-cache-directory)
1536 (nnspool-nov-directory ,gnus-cache-directory)
1537 (nnspool-active-file
1538 ,(nnheader-concat gnus-cache-directory "active"))))
1539 "List of predefined (convenience) servers.")
1541 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1543 (defconst gnus-article-mark-lists
1544 '((marked . tick) (replied . reply)
1545 (expirable . expire) (killed . killed)
1546 (bookmarks . bookmark) (dormant . dormant)
1547 (scored . score) (saved . save)
1548 (cached . cache) (downloadable . download)
1549 (unsendable . unsend)))
1551 (defvar gnus-headers-retrieved-by nil)
1552 (defvar gnus-article-reply nil)
1553 (defvar gnus-override-method nil)
1554 (defvar gnus-article-check-size nil)
1555 (defvar gnus-opened-servers nil)
1557 (defvar gnus-current-kill-article nil)
1559 (defvar gnus-have-read-active-file nil)
1561 (defconst gnus-maintainer
1562 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1563 "The mail address of the Gnus maintainers.")
1565 (defconst semi-gnus-developers
1566 "Semi-gnus Developers:
1567 semi-gnus-en@meadow.scphys.kyoto-u.ac.jp (In English),\
1568 semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (In Japanese);"
1569 "The mail address of the Semi-gnus developers.")
1571 (defcustom gnus-info-filename nil
1572 "*Controls language of gnus Info.
1573 If nil and current-language-environment is Japanese, go to gnus-ja.
1574 Otherwise go to corresponding Info.
1575 This variable can be nil, gnus or gnus-ja."
1577 :type '(choice (const nil)
1578 (const :tag "English" gnus)
1579 (const :tag "Japanese" gnus-ja)))
1581 (defvar gnus-info-nodes
1582 '((gnus-group-mode "The Group Buffer")
1583 (gnus-summary-mode "The Summary Buffer")
1584 (gnus-article-mode "The Article Buffer")
1585 (gnus-server-mode "The Server Buffer")
1586 (gnus-browse-mode "Browse Foreign Server")
1587 (gnus-tree-mode "Tree Display"))
1588 "Alist of major modes and related Info nodes.")
1590 (defvar gnus-group-buffer "*Group*")
1591 (defvar gnus-summary-buffer "*Summary*")
1592 (defvar gnus-article-buffer "*Article*")
1593 (defvar gnus-server-buffer "*Server*")
1595 (defvar gnus-slave nil
1596 "Whether this Gnus is a slave or not.")
1598 (defvar gnus-batch-mode nil
1599 "Whether this Gnus is running in batch mode or not.")
1601 (defvar gnus-variable-list
1602 '(gnus-newsrc-options gnus-newsrc-options-n
1603 gnus-newsrc-last-checked-date
1604 gnus-newsrc-alist gnus-server-alist
1605 gnus-killed-list gnus-zombie-list
1606 gnus-topic-topology gnus-topic-alist
1608 "Gnus variables saved in the quick startup file.")
1610 (defvar gnus-newsrc-alist nil
1611 "Assoc list of read articles.
1612 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1614 (defvar gnus-newsrc-hashtb nil
1615 "Hashtable of gnus-newsrc-alist.")
1617 (defvar gnus-killed-list nil
1618 "List of killed newsgroups.")
1620 (defvar gnus-killed-hashtb nil
1621 "Hash table equivalent of gnus-killed-list.")
1623 (defvar gnus-zombie-list nil
1624 "List of almost dead newsgroups.")
1626 (defvar gnus-description-hashtb nil
1627 "Descriptions of newsgroups.")
1629 (defvar gnus-list-of-killed-groups nil
1630 "List of newsgroups that have recently been killed by the user.")
1632 (defvar gnus-active-hashtb nil
1633 "Hashtable of active articles.")
1635 (defvar gnus-moderated-hashtb nil
1636 "Hashtable of moderated newsgroups.")
1638 ;; Save window configuration.
1639 (defvar gnus-prev-winconf nil)
1641 (defvar gnus-reffed-article-number nil)
1643 ;;; Let the byte-compiler know that we know about this variable.
1644 (defvar rmail-default-rmail-file)
1646 (defvar gnus-dead-summary nil)
1648 ;;; End of variables.
1650 ;; Define some autoload functions Gnus might use.
1653 ;; This little mapcar goes through the list below and marks the
1654 ;; symbols in question as autoloaded functions.
1657 (let ((interactive (nth 1 (memq ':interactive package))))
1661 (when (consp function)
1662 (setq keymap (car (memq 'keymap function)))
1663 (setq function (car function)))
1664 (autoload function (car package) nil interactive keymap)))
1665 (if (eq (nth 1 package) ':interactive)
1668 '(("info" Info-goto-node)
1669 ("pp" pp pp-to-string pp-eval-expression)
1670 ("ps-print" ps-print-preprint)
1671 ("mail-extr" mail-extract-address-components)
1672 ("browse-url" browse-url)
1673 ("message" :interactive t
1674 message-send-and-exit message-yank-original)
1675 ("nnmail" nnmail-split-fancy nnmail-article-group)
1676 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1677 ("rmailout" rmail-output rmail-output-to-rmail-file)
1678 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1680 ("gnus-audio" :interactive t gnus-audio-play)
1681 ("gnus-xmas" gnus-xmas-splash)
1682 ("gnus-soup" :interactive t
1683 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1684 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1685 ("nnsoup" nnsoup-pack-replies)
1686 ("score-mode" :interactive t gnus-score-mode)
1687 ("gnus-mh" gnus-summary-save-article-folder
1688 gnus-Folder-save-name gnus-folder-save-name)
1689 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1690 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1691 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1692 gnus-demon-add-disconnection gnus-demon-add-handler
1693 gnus-demon-remove-handler)
1694 ("gnus-demon" :interactive t
1695 gnus-demon-init gnus-demon-cancel)
1696 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1697 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1698 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1699 gnus-nocem-unwanted-article-p)
1700 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1701 gnus-server-server-name)
1702 ("gnus-srvr" gnus-browse-foreign-server)
1703 ("gnus-cite" :interactive t
1704 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1705 gnus-article-hide-citation gnus-article-fill-cited-article
1706 gnus-article-hide-citation-in-followups)
1707 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1708 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1709 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1710 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1711 gnus-cache-possibly-remove-articles gnus-cache-request-article
1712 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1713 gnus-cache-enter-remove-article gnus-cached-article-p
1714 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1715 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1716 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1717 ("gnus-score" :interactive t
1718 gnus-summary-increase-score gnus-summary-set-score
1719 gnus-summary-raise-thread gnus-summary-raise-same-subject
1720 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1721 gnus-summary-lower-thread gnus-summary-lower-same-subject
1722 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1723 gnus-summary-current-score gnus-score-default
1724 gnus-score-flush-cache gnus-score-close
1725 gnus-possibly-score-headers gnus-score-followup-article
1726 gnus-score-followup-thread)
1728 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1729 gnus-current-score-file-nondirectory gnus-score-adaptive
1730 gnus-score-find-trace gnus-score-file-name)
1731 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1732 ("gnus-topic" :interactive t gnus-topic-mode)
1733 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1734 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1735 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1736 ("gnus-uu" :interactive t
1737 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1738 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1739 gnus-uu-mark-by-regexp gnus-uu-mark-all
1740 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1741 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1742 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1743 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1744 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1745 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1746 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1747 gnus-uu-mark-over gnus-uu-post-news)
1748 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1749 gnus-uu-unmark-thread)
1750 ("gnus-msg" (gnus-summary-send-map keymap)
1751 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1752 ("gnus-msg" :interactive t
1753 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1754 gnus-summary-followup gnus-summary-followup-with-original
1755 gnus-summary-cancel-article gnus-summary-supersede-article
1756 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1757 gnus-summary-mail-forward gnus-summary-mail-other-window
1758 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1759 gnus-summary-wide-reply gnus-summary-followup-to-mail
1760 gnus-summary-followup-to-mail-with-original gnus-bug
1761 gnus-summary-wide-reply-with-original
1762 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1763 gnus-summary-post-forward)
1764 ("gnus-picon" :interactive t gnus-article-display-picons
1765 gnus-group-display-picons gnus-picons-article-display-x-face
1766 gnus-picons-display-x-face)
1767 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1768 gnus-grouplens-mode)
1769 ("smiley" :interactive t gnus-smiley-display)
1770 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1771 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1772 gnus-list-of-unread-articles gnus-list-of-read-articles
1773 gnus-offer-save-summaries gnus-make-thread-indent-array
1774 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1775 gnus-summary-skip-intangible gnus-summary-article-number
1776 gnus-data-header gnus-data-find)
1777 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1778 gnus-group-list-groups gnus-group-first-unread-group
1779 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1780 gnus-group-setup-buffer gnus-group-get-new-news
1781 gnus-group-make-help-group gnus-group-update-group
1782 gnus-clear-inboxes-moved gnus-group-iterate
1783 gnus-group-group-name)
1784 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1785 gnus-backlog-remove-article)
1786 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1787 gnus-article-prepare gnus-article-set-window-start
1788 gnus-article-next-page gnus-article-prev-page
1789 gnus-request-article-this-buffer gnus-article-mode
1790 gnus-article-setup-buffer gnus-narrow-to-page
1791 gnus-article-delete-invisible-text)
1792 ("gnus-art" :interactive t
1793 gnus-article-hide-headers gnus-article-hide-boring-headers
1794 gnus-article-treat-overstrike gnus-article-word-wrap
1795 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1796 gnus-article-display-x-face
1797 gnus-article-hide-pgp
1798 gnus-article-hide-pem gnus-article-hide-signature
1799 gnus-article-strip-leading-blank-lines gnus-article-date-local
1800 gnus-article-date-original gnus-article-date-lapsed
1801 gnus-article-show-all-headers
1802 gnus-article-edit-mode gnus-article-edit-article
1803 gnus-article-edit-done article-decode-encoded-words
1804 gnus-start-date-timer gnus-stop-date-timer)
1805 ("gnus-int" gnus-request-type)
1806 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1807 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1808 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1809 gnus-dup-enter-articles)
1810 ("gnus-range" gnus-copy-sequence)
1811 ("gnus-eform" gnus-edit-form)
1812 ("gnus-move" :interactive t
1813 gnus-group-move-group-to-server gnus-change-server)
1814 ("gnus-logic" gnus-score-advanced)
1815 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1816 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1817 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1818 gnus-async-halt-prefetch)
1819 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1820 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1821 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1822 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1823 ("gnus-agent" :interactive t
1824 gnus-unplugged gnus-agentize gnus-agent-batch)
1825 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1826 gnus-summary-save-article-vm)
1827 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1829 ;;; gnus-sum.el thingies
1832 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1833 "*The format specification of the lines in the summary buffer.
1835 It works along the same lines as a normal formatting string,
1836 with some simple extensions.
1838 %N Article number, left padded with spaces (string)
1840 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1841 %n Name of the poster (string)
1842 %a Extracted name of the poster (string)
1843 %A Extracted address of the poster (string)
1844 %F Contents of the From: header (string)
1845 %f Contents of the From: or To: headers (string)
1846 %x Contents of the Xref: header (string)
1847 %D Date of the article (string)
1848 %d Date of the article (string) in DD-MMM format
1849 %M Message-id of the article (string)
1850 %r References of the article (string)
1851 %c Number of characters in the article (integer)
1852 %L Number of lines in the article (integer)
1853 %I Indentation based on thread level (a string of spaces)
1854 %T A string with two possible values: 80 spaces if the article
1855 is on thread level two or larger and 0 spaces on level one
1856 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1857 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1858 %[ Opening bracket (character, \"[\" or \"<\")
1859 %] Closing bracket (character, \"]\" or \">\")
1860 %> Spaces of length thread-level (string)
1861 %< Spaces of length (- 20 thread-level) (string)
1862 %i Article score (number)
1863 %z Article zcore (character)
1864 %t Number of articles under the current thread (number).
1865 %e Whether the thread is empty or not (character).
1866 %l GroupLens score (string).
1867 %V Total thread score (number).
1868 %P The line number (number).
1869 %O Download mark (character).
1870 %u User defined specifier. The next character in the format string should
1871 be a letter. Gnus will call the function gnus-user-format-function-X,
1872 where X is the letter following %u. The function will be passed the
1873 current header as argument. The function should return a string, which
1874 will be inserted into the summary just like information from any other
1877 Text between %( and %) will be highlighted with `gnus-mouse-face'
1878 when the mouse point is placed inside the area. There can only be one
1881 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1882 with care. For reasons of efficiency, Gnus will compute what column
1883 these characters will end up in, and \"hard-code\" that. This means that
1884 it is illegal to have these specs after a variable-length spec. Well,
1885 you might not be arrested, but your summary buffer will look strange,
1886 which is bad enough.
1888 The smart choice is to have these specs as for to the left as
1891 This restriction may disappear in later versions of Gnus."
1893 :group 'gnus-summary-format)
1896 ;;; Skeleton keymaps
1899 (defun gnus-suppress-keymap (keymap)
1900 (suppress-keymap keymap)
1901 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1903 (define-key keymap (pop keys) 'undefined))))
1905 (defvar gnus-article-mode-map
1906 (let ((keymap (make-sparse-keymap)))
1907 (gnus-suppress-keymap keymap)
1909 (defvar gnus-summary-mode-map
1910 (let ((keymap (make-keymap)))
1911 (gnus-suppress-keymap keymap)
1913 (defvar gnus-group-mode-map
1914 (let ((keymap (make-keymap)))
1915 (gnus-suppress-keymap keymap)
1920 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1921 ;; If you want the cursor to go somewhere else, set these two
1922 ;; functions in some startup hook to whatever you want.
1923 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1924 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1926 ;;; Various macros and substs.
1928 (defun gnus-header-from (header)
1929 (mail-header-from header))
1931 (defmacro gnus-gethash (string hashtable)
1932 "Get hash value of STRING in HASHTABLE."
1933 `(symbol-value (intern-soft ,string ,hashtable)))
1935 (defmacro gnus-sethash (string value hashtable)
1936 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1937 `(set (intern ,string ,hashtable) ,value))
1938 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1940 (defmacro gnus-group-unread (group)
1941 "Get the currently computed number of unread articles in GROUP."
1942 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1944 (defmacro gnus-group-entry (group)
1945 "Get the newsrc entry for GROUP."
1946 `(gnus-gethash ,group gnus-newsrc-hashtb))
1948 (defmacro gnus-active (group)
1949 "Get active info on GROUP."
1950 `(gnus-gethash ,group gnus-active-hashtb))
1952 (defmacro gnus-set-active (group active)
1953 "Set GROUP's active info."
1954 `(gnus-sethash ,group ,active gnus-active-hashtb))
1956 ;; Info access macros.
1958 (defmacro gnus-info-group (info)
1960 (defmacro gnus-info-rank (info)
1962 (defmacro gnus-info-read (info)
1964 (defmacro gnus-info-marks (info)
1966 (defmacro gnus-info-method (info)
1968 (defmacro gnus-info-params (info)
1971 (defmacro gnus-info-level (info)
1972 `(let ((rank (gnus-info-rank ,info)))
1976 (defmacro gnus-info-score (info)
1977 `(let ((rank (gnus-info-rank ,info)))
1978 (or (and (consp rank) (cdr rank)) 0)))
1980 (defmacro gnus-info-set-group (info group)
1981 `(setcar ,info ,group))
1982 (defmacro gnus-info-set-rank (info rank)
1983 `(setcar (nthcdr 1 ,info) ,rank))
1984 (defmacro gnus-info-set-read (info read)
1985 `(setcar (nthcdr 2 ,info) ,read))
1986 (defmacro gnus-info-set-marks (info marks &optional extend)
1988 `(gnus-info-set-entry ,info ,marks 3)
1989 `(setcar (nthcdr 3 ,info) ,marks)))
1990 (defmacro gnus-info-set-method (info method &optional extend)
1992 `(gnus-info-set-entry ,info ,method 4)
1993 `(setcar (nthcdr 4 ,info) ,method)))
1994 (defmacro gnus-info-set-params (info params &optional extend)
1996 `(gnus-info-set-entry ,info ,params 5)
1997 `(setcar (nthcdr 5 ,info) ,params)))
1999 (defun gnus-info-set-entry (info entry number)
2000 ;; Extend the info until we have enough elements.
2001 (while (<= (length info) number)
2002 (nconc info (list nil)))
2004 (setcar (nthcdr number info) entry))
2006 (defmacro gnus-info-set-level (info level)
2007 `(let ((rank (cdr ,info)))
2008 (if (consp (car rank))
2009 (setcar (car rank) ,level)
2010 (setcar rank ,level))))
2011 (defmacro gnus-info-set-score (info score)
2012 `(let ((rank (cdr ,info)))
2013 (if (consp (car rank))
2014 (setcdr (car rank) ,score)
2015 (setcar rank (cons (car rank) ,score)))))
2017 (defmacro gnus-get-info (group)
2018 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2020 ;; Byte-compiler warning.
2021 (defvar gnus-visual)
2022 ;; Find out whether the gnus-visual TYPE is wanted.
2023 (defun gnus-visual-p (&optional type class)
2024 (and gnus-visual ; Has to be non-nil, at least.
2025 (if (not type) ; We don't care about type.
2027 (if (listp gnus-visual) ; It's a list, so we check it.
2028 (or (memq type gnus-visual)
2029 (memq class gnus-visual))
2032 ;;; Load the compatability functions.
2041 (defvar gnus-shutdown-alist nil)
2043 (defun gnus-add-shutdown (function &rest symbols)
2044 "Run FUNCTION whenever one of SYMBOLS is shut down."
2045 (push (cons function symbols) gnus-shutdown-alist))
2047 (defun gnus-shutdown (symbol)
2048 "Shut down everything that waits for SYMBOL."
2049 (let ((alist gnus-shutdown-alist)
2051 (while (setq entry (pop alist))
2052 (when (memq symbol (cdr entry))
2053 (funcall (car entry))))))
2057 ;;; Gnus Utility Functions
2061 (defmacro gnus-string-or (&rest strings)
2062 "Return the first element of STRINGS that is a non-blank string.
2063 STRINGS will be evaluated in normal `or' order."
2064 `(gnus-string-or-1 ',strings))
2066 (defun gnus-string-or-1 (strings)
2069 (setq string (eval (pop strings)))
2070 (if (string-match "^[ \t]*$" string)
2072 (setq strings nil)))
2075 (defun gnus-version (&optional arg)
2076 "Version number of this version of Gnus.
2077 If ARG, insert string at point."
2080 (insert (message gnus-version))
2081 (message gnus-version)))
2083 (defun gnus-continuum-version (version)
2084 "Return VERSION as a floating point number."
2085 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2086 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2087 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2088 (number (match-string 2 version))
2090 (unless (string-match
2091 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2092 (error "Invalid version string: %s" version))
2093 (setq major (string-to-number (match-string 1 number))
2094 minor (string-to-number (match-string 2 number))
2095 least (if (match-beginning 3)
2096 (string-to-number (match-string 3 number))
2100 (format "%s00%02d%02d"
2101 (if (member alpha '("(ding)" "d"))
2105 (- (char-int (aref (downcase alpha) 0))
2109 (format "%d.%02d%02d" major minor least))))))
2111 (defun gnus-info-find-node ()
2112 "Find Info documentation of Gnus."
2114 ;; Enlarge info window if needed.
2115 (let (gnus-info-buffer)
2118 (or gnus-info-filename
2119 (get-language-info current-language-environment 'gnus-info)
2121 (cadr (assq major-mode gnus-info-nodes))))
2122 (setq gnus-info-buffer (current-buffer))
2123 (gnus-configure-windows 'info)))
2126 ;;; gnus-interactive
2129 (defvar gnus-current-prefix-symbol nil
2130 "Current prefix symbol.")
2132 (defvar gnus-current-prefix-symbols nil
2133 "List of current prefix symbols.")
2135 (defun gnus-interactive (string &optional params)
2136 "Return a list that can be fed to `interactive'.
2137 See `interactive' for full documentation.
2139 Adds the following specs:
2141 y -- The current symbolic prefix.
2142 Y -- A list of the current symbolic prefix(es).
2143 A -- Article number.
2144 H -- Article header.
2148 (while (< i (length string))
2149 (string-match ".\\([^\n]*\\)\n?" string i)
2150 (setq c (aref string i))
2152 (setq prompt (match-string 1 string)))
2153 (setq i (match-end 0))
2154 ;; We basically emulate just about everything that
2155 ;; `interactive' does, but add the specs listed above.
2159 (completing-read prompt obarray 'fboundp t))
2161 (read-buffer prompt (current-buffer) t))
2163 (read-buffer prompt (other-buffer (current-buffer))))
2167 (completing-read prompt obarray 'commandp t))
2171 (read-file-name prompt nil default-directory 'lambda))
2173 (read-file-name prompt nil nil 'lambda))
2175 (read-file-name prompt))
2177 (read-key-sequence prompt))
2179 (error "Not implemented spec"))
2181 (error "Not implemented spec"))
2185 (error "Not implemented spec"))
2187 (string-to-number (read-from-minibuffer prompt)))
2189 (prefix-numeric-value current-prefix-arg))
2195 (read-string prompt))
2197 (intern (read-string prompt)))
2199 (read-variable prompt))
2201 (read-minibuffer prompt))
2203 (eval-minibuffer prompt))
2204 ;; And here the new specs come.
2206 gnus-current-prefix-symbol)
2208 gnus-current-prefix-symbols)
2210 (gnus-group-group-name))
2212 (gnus-summary-skip-intangible)
2213 (or (get-text-property (point) 'gnus-number)
2214 (gnus-summary-last-subject)))
2216 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2218 (error "Non-implemented spec")))
2222 (push (if (< (point) (mark) (point) (mark))) out)
2223 (push (if (> (point) (mark) (point) (mark))) out))))
2224 (setq out (delq 'gnus-prefix-nil out))
2227 (defun gnus-symbolic-argument (&optional arg)
2228 "Read a symbolic argument and a command, and then execute command."
2230 (let* ((in-command (this-command-keys))
2231 (command in-command)
2232 gnus-current-prefix-symbols
2233 gnus-current-prefix-symbol
2235 (while (equal in-command command)
2236 (message "%s-" (key-description (this-command-keys)))
2237 (push (intern (char-to-string (read-char))) syms)
2238 (setq command (read-key-sequence nil t)))
2239 (setq gnus-current-prefix-symbols (nreverse syms)
2240 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2241 (call-interactively (key-binding command t))))
2243 ;;; More various functions.
2245 (defsubst gnus-check-backend-function (func group)
2246 "Check whether GROUP supports function FUNC.
2247 GROUP can either be a string (a group name) or a select method."
2249 (let ((method (if (stringp group)
2250 (car (gnus-find-method-for-group group))
2252 (unless (featurep method)
2254 (fboundp (intern (format "%s-%s" method func))))))
2256 (defun gnus-group-read-only-p (&optional group)
2257 "Check whether GROUP supports editing or not.
2258 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2259 that that variable is buffer-local to the summary buffers."
2260 (let ((group (or group gnus-newsgroup-name)))
2261 (not (gnus-check-backend-function 'request-replace-article group))))
2263 (defun gnus-group-total-expirable-p (group)
2264 "Check whether GROUP is total-expirable or not."
2265 (let ((params (gnus-group-find-parameter group))
2268 ((memq 'total-expire params)
2270 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2272 (gnus-total-expirable-newsgroups ; Check var.
2273 (string-match gnus-total-expirable-newsgroups group)))))
2275 (defun gnus-group-auto-expirable-p (group)
2276 "Check whether GROUP is auto-expirable or not."
2277 (let ((params (gnus-group-find-parameter group))
2280 ((memq 'auto-expire params)
2282 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2284 (gnus-auto-expirable-newsgroups ; Check var.
2285 (string-match gnus-auto-expirable-newsgroups group)))))
2287 (defun gnus-virtual-group-p (group)
2288 "Say whether GROUP is virtual or not."
2289 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2290 gnus-valid-select-methods)))
2292 (defun gnus-news-group-p (group &optional article)
2293 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2294 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2295 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2296 (eq (gnus-request-type group article) 'news))))
2298 ;; Returns a list of writable groups.
2299 (defun gnus-writable-groups ()
2300 (let ((alist gnus-newsrc-alist)
2302 (while (setq group (car (pop alist)))
2303 (unless (gnus-group-read-only-p group)
2304 (push group groups)))
2307 ;; Check whether to use long file names.
2308 (defun gnus-use-long-file-name (symbol)
2309 ;; The variable has to be set...
2310 (and gnus-use-long-file-name
2311 ;; If it isn't a list, then we return t.
2312 (or (not (listp gnus-use-long-file-name))
2313 ;; If it is a list, and the list contains `symbol', we
2315 (not (memq symbol gnus-use-long-file-name)))))
2317 ;; Generate a unique new group name.
2318 (defun gnus-generate-new-group-name (leaf)
2321 (while (gnus-gethash name gnus-newsrc-hashtb)
2322 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2325 (defun gnus-ephemeral-group-p (group)
2326 "Say whether GROUP is ephemeral or not."
2327 (gnus-group-get-parameter group 'quit-config t))
2329 (defun gnus-group-quit-config (group)
2330 "Return the quit-config of GROUP."
2331 (gnus-group-get-parameter group 'quit-config t))
2333 (defun gnus-kill-ephemeral-group (group)
2334 "Remove ephemeral GROUP from relevant structures."
2335 (gnus-sethash group nil gnus-newsrc-hashtb))
2337 (defun gnus-simplify-mode-line ()
2338 "Make mode lines a bit simpler."
2339 (setq mode-line-modified (cdr gnus-mode-line-modified))
2340 (when (listp mode-line-format)
2341 (make-local-variable 'mode-line-format)
2342 (setq mode-line-format (copy-sequence mode-line-format))
2343 (when (equal (nth 3 mode-line-format) " ")
2344 (setcar (nthcdr 3 mode-line-format) " "))))
2346 ;;; Servers and groups.
2348 (defsubst gnus-server-add-address (method)
2349 (let ((method-name (symbol-name (car method))))
2350 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2351 (not (assq (intern (concat method-name "-address")) method))
2352 (memq 'physical-address (assq (car method)
2353 gnus-valid-select-methods)))
2354 (append method (list (list (intern (concat method-name "-address"))
2358 (defsubst gnus-server-get-method (group method)
2359 ;; Input either a server name, and extended server name, or a
2360 ;; select method, and return a select method.
2361 (cond ((stringp method)
2362 (gnus-server-to-method method))
2363 ((equal method gnus-select-method)
2365 ((and (stringp (car method))
2367 (gnus-server-extend-method group method))
2370 (equal (cadr method) ""))
2373 (gnus-server-add-address method))))
2375 (defun gnus-server-to-method (server)
2376 "Map virtual server names to select methods."
2378 ;; Is this a method, perhaps?
2379 (and server (listp server) server)
2380 ;; Perhaps this is the native server?
2381 (and (equal server "native") gnus-select-method)
2382 ;; It should be in the server alist.
2383 (cdr (assoc server gnus-server-alist))
2384 ;; It could be in the predefined server alist.
2385 (cdr (assoc server gnus-predefined-server-alist))
2386 ;; If not, we look through all the opened server
2387 ;; to see whether we can find it there.
2388 (let ((opened gnus-opened-servers))
2390 (not (equal server (format "%s:%s" (caaar opened)
2395 (defmacro gnus-method-equal (ss1 ss2)
2396 "Say whether two servers are equal."
2400 (and (= (length s1) (length s2))
2402 (while (and s1 (member (car s1) s2))
2406 (defun gnus-server-equal (m1 m2)
2407 "Say whether two methods are equal."
2408 (let ((m1 (cond ((null m1) gnus-select-method)
2409 ((stringp m1) (gnus-server-to-method m1))
2411 (m2 (cond ((null m2) gnus-select-method)
2412 ((stringp m2) (gnus-server-to-method m2))
2414 (gnus-method-equal m1 m2)))
2416 (defun gnus-servers-using-backend (backend)
2417 "Return a list of known servers using BACKEND."
2418 (let ((opened gnus-opened-servers)
2421 (when (eq backend (caaar opened))
2422 (push (caar opened) out))
2426 (defun gnus-archive-server-wanted-p ()
2427 "Say whether the user wants to use the archive server."
2429 ((or (not gnus-message-archive-method)
2430 (not gnus-message-archive-group))
2432 ((and gnus-message-archive-method gnus-message-archive-group)
2435 (let ((active (cadr (assq 'nnfolder-active-file
2436 gnus-message-archive-method))))
2438 (file-exists-p active))))))
2440 (defun gnus-group-prefixed-name (group method)
2441 "Return the whole name from GROUP and METHOD."
2442 (and (stringp method) (setq method (gnus-server-to-method method)))
2443 (if (or (not method)
2444 (gnus-server-equal method "native"))
2446 (concat (format "%s" (car method))
2448 (or (assoc (format "%s" (car method))
2449 (gnus-methods-using 'address))
2450 (gnus-server-equal method gnus-message-archive-method))
2452 (not (string= (nth 1 method) "")))
2453 (concat "+" (nth 1 method)))
2456 (defun gnus-group-real-prefix (group)
2457 "Return the prefix of the current group name."
2458 (if (string-match "^[^:]+:" group)
2459 (substring group 0 (match-end 0))
2462 (defun gnus-group-method (group)
2463 "Return the server or method used for selecting GROUP.
2464 You should probably use `gnus-find-method-for-group' instead."
2465 (let ((prefix (gnus-group-real-prefix group)))
2466 (if (equal prefix "")
2468 (let ((servers gnus-opened-servers)
2470 backend possible found)
2471 (if (string-match "^[^\\+]+\\+" prefix)
2472 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2473 server (substring prefix (match-end 0) (1- (length prefix))))
2474 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2476 (when (eq (caaar servers) backend)
2477 (setq possible (caar servers))
2478 (when (equal (cadaar servers) server)
2479 (setq found (caar servers))))
2481 (or (car (rassoc found gnus-server-alist))
2483 (car (rassoc possible gnus-server-alist))
2485 (list backend server))))))
2487 (defsubst gnus-secondary-method-p (method)
2488 "Return whether METHOD is a secondary select method."
2489 (let ((methods gnus-secondary-select-methods)
2490 (gmethod (gnus-server-get-method nil method)))
2492 (not (equal (gnus-server-get-method nil (car methods))
2494 (setq methods (cdr methods)))
2497 (defun gnus-groups-from-server (server)
2498 "Return a list of all groups that are fetched from SERVER."
2499 (let ((alist (cdr gnus-newsrc-alist))
2501 (while (setq info (pop alist))
2502 (when (gnus-server-equal (gnus-info-method info) server)
2503 (push (gnus-info-group info) groups)))
2504 (sort groups 'string<)))
2506 (defun gnus-group-foreign-p (group)
2507 "Say whether a group is foreign or not."
2508 (and (not (gnus-group-native-p group))
2509 (not (gnus-group-secondary-p group))))
2511 (defun gnus-group-native-p (group)
2512 "Say whether the group is native or not."
2513 (not (string-match ":" group)))
2515 (defun gnus-group-secondary-p (group)
2516 "Say whether the group is secondary or not."
2517 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2519 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2520 "Return the group parameters for GROUP.
2521 If SYMBOL, return the value of that symbol in the group parameters."
2523 (set-buffer gnus-group-buffer)
2524 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2526 (gnus-group-parameter-value parameters symbol allow-list)
2529 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2530 "Return the group parameters for GROUP.
2531 If SYMBOL, return the value of that symbol in the group parameters.
2532 Most functions should use `gnus-group-find-parameter', which
2533 also examines the topic parameters."
2534 (let ((params (gnus-info-params (gnus-get-info group))))
2536 (gnus-group-parameter-value params symbol allow-list)
2539 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2540 "Return the value of SYMBOL in group PARAMS."
2541 ;; We only wish to return group parameters (dotted lists) and
2542 ;; not local variables, which may have the same names.
2543 ;; But first we handle single elements...
2544 (or (car (memq symbol params))
2548 (while (setq elem (pop params))
2549 (when (and (consp elem)
2550 (eq (car elem) symbol)
2553 (throw 'found (cdr elem))))))))
2555 (defun gnus-group-add-parameter (group param)
2556 "Add parameter PARAM to GROUP."
2557 (let ((info (gnus-get-info group)))
2559 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2560 ;; Cons the new param to the old one and update.
2561 (gnus-group-set-info (cons param (gnus-info-params info))
2564 (defun gnus-group-set-parameter (group name value)
2565 "Set parameter NAME to VALUE in GROUP."
2566 (let ((info (gnus-get-info group)))
2568 (gnus-group-remove-parameter group name)
2569 (let ((old-params (gnus-info-params info))
2570 (new-params (list (cons name value))))
2572 (when (or (not (listp (car old-params)))
2573 (not (eq (caar old-params) name)))
2574 (setq new-params (append new-params (list (car old-params)))))
2575 (setq old-params (cdr old-params)))
2576 (gnus-group-set-info new-params group 'params)))))
2578 (defun gnus-group-remove-parameter (group name)
2579 "Remove parameter NAME from GROUP."
2580 (let ((info (gnus-get-info group)))
2582 (let ((params (gnus-info-params info)))
2584 (setq params (delq name params))
2585 (while (assq name params)
2586 (gnus-pull name params))
2587 (gnus-info-set-params info params))))))
2589 (defun gnus-group-add-score (group &optional score)
2590 "Add SCORE to the GROUP score.
2591 If SCORE is nil, add 1 to the score of GROUP."
2592 (let ((info (gnus-get-info group)))
2594 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2596 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2597 (defun gnus-short-group-name (group &optional levels)
2598 "Collapse GROUP name LEVELS.
2599 Select methods are stripped and any remote host name is stripped down to
2600 just the host name."
2607 (while (string-match "\\." group skip)
2608 (setq skip (match-end 0)
2611 ;; separate foreign select method from group name and collapse.
2612 ;; if method contains a server, collapse to non-domain server name,
2613 ;; otherwise collapse to select method
2614 (when (string-match ":" group)
2615 (cond ((string-match "+" group)
2616 (let* ((plus (string-match "+" group))
2617 (colon (string-match ":" group (or plus 0)))
2618 (dot (string-match "\\." group)))
2619 (setq foreign (concat
2620 (substring group (+ 1 plus)
2621 (cond ((null dot) colon)
2622 ((< colon dot) colon)
2623 ((< dot colon) dot)))
2625 group (substring group (+ 1 colon)))))
2627 (let* ((colon (string-match ":" group)))
2628 (setq foreign (concat (substring group 0 (+ 1 colon)))
2629 group (substring group (+ 1 colon)))))))
2630 ;; collapse group name leaving LEVELS uncollapsed elements
2632 (if (and (string-match "\\." group) (> levels 0))
2633 (setq name (concat name (substring group 0 1))
2634 group (substring group (match-end 0))
2636 name (concat name "."))
2637 (setq name (concat foreign name group)
2641 (defun gnus-narrow-to-body ()
2642 "Narrow to the body of an article."
2645 (goto-char (point-min))
2646 (or (search-forward "\n\n" nil t)
2652 ;;; Kill file handling.
2655 (defun gnus-apply-kill-file ()
2656 "Apply a kill file to the current newsgroup.
2657 Returns the number of articles marked as read."
2658 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2659 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2660 (gnus-apply-kill-file-internal)
2663 (defun gnus-kill-save-kill-buffer ()
2664 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2665 (when (get-file-buffer file)
2667 (set-buffer (get-file-buffer file))
2668 (when (buffer-modified-p)
2670 (kill-buffer (current-buffer))))))
2672 (defcustom gnus-kill-file-name "KILL"
2673 "Suffix of the kill files."
2674 :group 'gnus-score-kill
2675 :group 'gnus-score-files
2678 (defun gnus-newsgroup-kill-file (newsgroup)
2679 "Return the name of a kill file name for NEWSGROUP.
2680 If NEWSGROUP is nil, return the global kill file name instead."
2682 ;; The global KILL file is placed at top of the directory.
2683 ((or (null newsgroup)
2684 (string-equal newsgroup ""))
2685 (expand-file-name gnus-kill-file-name
2686 gnus-kill-files-directory))
2687 ;; Append ".KILL" to newsgroup name.
2688 ((gnus-use-long-file-name 'not-kill)
2689 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2690 "." gnus-kill-file-name)
2691 gnus-kill-files-directory))
2692 ;; Place "KILL" under the hierarchical directory.
2694 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2695 "/" gnus-kill-file-name)
2696 gnus-kill-files-directory))))
2700 (defun gnus-member-of-valid (symbol group)
2701 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2703 (symbol-name (car (gnus-find-method-for-group group)))
2704 gnus-valid-select-methods)))
2706 (defun gnus-method-option-p (method option)
2707 "Return non-nil if select METHOD has OPTION as a parameter."
2708 (when (stringp method)
2709 (setq method (gnus-server-to-method method)))
2710 (memq option (assoc (format "%s" (car method))
2711 gnus-valid-select-methods)))
2713 (defun gnus-similar-server-opened (method)
2714 (let ((opened gnus-opened-servers))
2715 (while (and method opened)
2716 (when (and (equal (cadr method) (cadaar opened))
2717 (not (equal method (caar opened))))
2722 (defun gnus-server-extend-method (group method)
2723 ;; This function "extends" a virtual server. If the server is
2724 ;; "hello", and the select method is ("hello" (my-var "something"))
2725 ;; in the group "alt.alt", this will result in a new virtual server
2726 ;; called "hello+alt.alt".
2727 (if (or (not (inline (gnus-similar-server-opened method)))
2728 (not (cddr method)))
2730 `(,(car method) ,(concat (cadr method) "+" group)
2731 (,(intern (format "%s-address" (car method))) ,(cadr method))
2734 (defun gnus-server-status (method)
2735 "Return the status of METHOD."
2736 (nth 1 (assoc method gnus-opened-servers)))
2738 (defun gnus-group-name-to-method (group)
2739 "Guess a select method based on GROUP."
2740 (if (string-match ":" group)
2741 (let ((server (substring group 0 (match-beginning 0))))
2742 (if (string-match "\\+" server)
2743 (list (intern (substring server 0 (match-beginning 0)))
2744 (substring server (match-end 0)))
2745 (list (intern server) "")))
2746 gnus-select-method))
2748 (defun gnus-find-method-for-group (group &optional info)
2749 "Find the select method that GROUP uses."
2750 (or gnus-override-method
2753 (let ((info (or info (gnus-get-info group)))
2756 (not (setq method (gnus-info-method info)))
2757 (equal method "native"))
2760 (cond ((stringp method)
2761 (inline (gnus-server-to-method method)))
2762 ((stringp (cadr method))
2763 (inline (gnus-server-extend-method group method)))
2766 (cond ((equal (cadr method) "")
2768 ((null (cadr method))
2769 (list (car method) ""))
2771 (gnus-server-add-address method)))))))
2773 (defun gnus-methods-using (feature)
2774 "Find all methods that have FEATURE."
2775 (let ((valids gnus-valid-select-methods)
2778 (when (memq feature (car valids))
2779 (push (car valids) outs))
2780 (setq valids (cdr valids)))
2783 (defun gnus-read-group (prompt &optional default)
2784 "Prompt the user for a group name.
2785 Disallow illegal group names."
2791 (setq group (read-string (concat prefix prompt)
2792 (cons (or default "") 0)
2793 'gnus-group-history)))
2794 (setq prefix (format "Illegal group name: \"%s\". " group)
2798 (defun gnus-read-method (prompt)
2799 "Prompt the user for a method.
2800 Allow completion over sensible values."
2802 (append gnus-valid-select-methods
2803 gnus-predefined-server-alist
2808 nil t nil 'gnus-method-history)))
2811 (setq method gnus-select-method))
2812 ((assoc method gnus-valid-select-methods)
2813 (list (intern method)
2814 (if (memq 'prompt-address
2815 (assoc method gnus-valid-select-methods))
2816 (read-string "Address: ")
2818 ((assoc method servers)
2821 (list (intern method) "")))))
2823 ;;; User-level commands.
2826 (defun gnus-slave-no-server (&optional arg)
2827 "Read network news as a slave, without connecting to local server."
2829 (gnus-no-server arg t))
2832 (defun gnus-no-server (&optional arg slave)
2834 If ARG is a positive number, Gnus will use that as the
2835 startup level. If ARG is nil, Gnus will be started at level 2.
2836 If ARG is non-nil and not a positive number, Gnus will
2837 prompt the user for the name of an NNTP server to use.
2838 As opposed to `gnus', this command will not connect to the local server."
2840 (gnus-no-server-1 arg slave))
2843 (defun gnus-slave (&optional arg)
2844 "Read news as a slave."
2846 (gnus arg nil 'slave))
2849 (defun gnus-other-frame (&optional arg)
2850 "Pop up a frame to read news."
2852 (let ((window (get-buffer-window gnus-group-buffer)))
2854 (select-frame (window-frame window)))
2855 ((= (length (frame-list)) 1)
2856 (select-frame (make-frame)))
2862 (defun gnus (&optional arg dont-connect slave)
2864 If ARG is non-nil and a positive number, Gnus will use that as the
2865 startup level. If ARG is non-nil and not a positive number, Gnus will
2866 prompt the user for the name of an NNTP server to use."
2868 (gnus-1 arg dont-connect slave))
2870 ;; Allow redefinition of Gnus functions.
2876 ;;; gnus.el ends here