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 ;; 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-charset nil
47 "Group character set issues."
48 :link '(custom-manual "(gnus)Charsets")
51 (defgroup gnus-cache nil
55 (defgroup gnus-start nil
56 "Starting your favorite newsreader."
59 (defgroup gnus-start-server nil
60 "Server options at startup."
63 ;; These belong to gnus-group.el.
64 (defgroup gnus-group nil
66 :link '(custom-manual "(gnus)The Group Buffer")
69 (defgroup gnus-group-foreign nil
71 :link '(custom-manual "(gnus)Foreign Groups")
74 (defgroup gnus-group-new nil
75 "Automatic subscription of new groups."
78 (defgroup gnus-group-levels nil
80 :link '(custom-manual "(gnus)Group Levels")
83 (defgroup gnus-group-select nil
85 :link '(custom-manual "(gnus)Selecting a Group")
88 (defgroup gnus-group-listing nil
89 "Showing slices of the group list."
90 :link '(custom-manual "(gnus)Listing Groups")
93 (defgroup gnus-group-visual nil
94 "Sorting the group buffer."
95 :link '(custom-manual "(gnus)Group Buffer Format")
99 (defgroup gnus-group-various nil
100 "Various group options."
101 :link '(custom-manual "(gnus)Scanning New Messages")
104 ;; These belong to gnus-sum.el.
105 (defgroup gnus-summary nil
107 :link '(custom-manual "(gnus)The Summary Buffer")
110 (defgroup gnus-summary-exit nil
111 "Leaving summary buffers."
112 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
113 :group 'gnus-summary)
115 (defgroup gnus-summary-marks nil
116 "Marks used in summary buffers."
117 :link '(custom-manual "(gnus)Marking Articles")
118 :group 'gnus-summary)
120 (defgroup gnus-thread nil
121 "Ordering articles according to replies."
122 :link '(custom-manual "(gnus)Threading")
123 :group 'gnus-summary)
125 (defgroup gnus-summary-format nil
126 "Formatting of the summary buffer."
127 :link '(custom-manual "(gnus)Summary Buffer Format")
128 :group 'gnus-summary)
130 (defgroup gnus-summary-choose nil
132 :link '(custom-manual "(gnus)Choosing Articles")
133 :group 'gnus-summary)
135 (defgroup gnus-summary-maneuvering nil
136 "Summary movement commands."
137 :link '(custom-manual "(gnus)Summary Maneuvering")
138 :group 'gnus-summary)
140 (defgroup gnus-summary-mail nil
141 "Mail group commands."
142 :link '(custom-manual "(gnus)Mail Group Commands")
143 :group 'gnus-summary)
145 (defgroup gnus-summary-sort nil
146 "Sorting the summary buffer."
147 :link '(custom-manual "(gnus)Sorting")
148 :group 'gnus-summary)
150 (defgroup gnus-summary-visual nil
151 "Highlighting and menus in the summary buffer."
152 :link '(custom-manual "(gnus)Summary Highlighting")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-various nil
157 "Various summary buffer options."
158 :link '(custom-manual "(gnus)Various Summary Stuff")
159 :group 'gnus-summary)
161 (defgroup gnus-summary-pick nil
162 "Pick mode in the summary buffer."
163 :link '(custom-manual "(gnus)Pick and Read")
165 :group 'gnus-summary)
167 (defgroup gnus-summary-tree nil
168 "Tree display of threads in the summary buffer."
169 :link '(custom-manual "(gnus)Tree Display")
171 :group 'gnus-summary)
173 ;; Belongs to gnus-uu.el
174 (defgroup gnus-extract-view nil
175 "Viewing extracted files."
176 :link '(custom-manual "(gnus)Viewing Files")
177 :group 'gnus-extract)
179 ;; Belongs to gnus-score.el
180 (defgroup gnus-score nil
181 "Score and kill file handling."
184 (defgroup gnus-score-kill nil
188 (defgroup gnus-score-adapt nil
189 "Adaptive score files."
192 (defgroup gnus-score-default nil
193 "Default values for score files."
196 (defgroup gnus-score-expire nil
197 "Expiring score rules."
200 (defgroup gnus-score-decay nil
201 "Decaying score rules."
204 (defgroup gnus-score-files nil
205 "Score and kill file names."
209 (defgroup gnus-score-various nil
210 "Various scoring and killing options."
214 (defgroup gnus-visual nil
215 "Options controling the visual fluff."
219 (defgroup gnus-agent nil
220 "Offline support for Gnus."
223 (defgroup gnus-files nil
224 "Files used by Gnus."
227 (defgroup gnus-dribble-file nil
229 :link '(custom-manual "(gnus)Auto Save")
232 (defgroup gnus-newsrc nil
233 "Storing Gnus state."
236 (defgroup gnus-server nil
237 "Options related to newsservers and other servers used by Gnus."
240 (defgroup gnus-message '((message custom-group))
241 "Composing replies and followups in Gnus."
244 (defgroup gnus-meta nil
245 "Meta variables controling major portions of Gnus.
246 In general, modifying these variables does not take affect until Gnus
247 is restarted, and sometimes reloaded."
250 (defgroup gnus-various nil
251 "Other Gnus options."
252 :link '(custom-manual "(gnus)Various Various")
255 (defgroup gnus-mime nil
256 "Variables for controlling the Gnus MIME interface."
259 (defgroup gnus-exit nil
261 :link '(custom-manual "(gnus)Exiting Gnus")
264 (defconst gnus-product-name "T-gnus"
265 "Product name of this version of gnus.")
267 (defconst gnus-version-number "6.10.056"
268 "Version number for this version of gnus.")
270 (defconst gnus-original-version-number "0.74"
271 "Version number for this version of Gnus.")
273 (provide 'running-pterodactyl-gnus-0_73-or-later)
275 (defconst gnus-original-product-name "Pterodactyl Gnus"
276 "Product name of the original version of Gnus.")
278 (defconst gnus-version
279 (format "%s %s (based on %s v%s ; for SEMI 1.12, FLIM 1.12)"
280 gnus-product-name gnus-version-number
281 gnus-original-product-name gnus-original-version-number)
282 "Version string for this version of gnus.")
284 (defcustom gnus-inhibit-startup-message nil
285 "If non-nil, the startup message will not be displayed.
286 This variable is used before `.gnus.el' is loaded, so it should
287 be set in `.emacs' instead."
291 (defcustom gnus-play-startup-jingle nil
292 "If non-nil, play the Gnus jingle at startup."
296 (unless (featurep 'gnus-xmas)
297 (defalias 'gnus-make-overlay 'make-overlay)
298 (defalias 'gnus-delete-overlay 'delete-overlay)
299 (defalias 'gnus-overlay-put 'overlay-put)
300 (defalias 'gnus-move-overlay 'move-overlay)
301 (defalias 'gnus-overlay-end 'overlay-end)
302 (defalias 'gnus-extent-detached-p 'ignore)
303 (defalias 'gnus-extent-start-open 'ignore)
304 (defalias 'gnus-set-text-properties 'set-text-properties)
305 (defalias 'gnus-group-remove-excess-properties 'ignore)
306 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
307 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
308 (defalias 'gnus-character-to-event 'identity)
309 (defalias 'gnus-add-text-properties 'add-text-properties)
310 (defalias 'gnus-put-text-property 'put-text-property)
311 (defalias 'gnus-mode-line-buffer-identification 'identity)
312 (defalias 'gnus-characterp 'numberp)
313 (defalias 'gnus-deactivate-mark 'deactivate-mark)
314 (defalias 'gnus-window-edges 'window-edges)
315 (defalias 'gnus-key-press-event-p 'numberp)
316 (defalias 'gnus-decode-rfc1522 'ignore))
318 ;; We define these group faces here to avoid the display
319 ;; update forced when creating new faces.
321 (defface gnus-group-news-1-face
324 (:foreground "PaleTurquoise" :bold t))
327 (:foreground "ForestGreen" :bold t))
330 "Level 1 newsgroup face.")
332 (defface gnus-group-news-1-empty-face
335 (:foreground "PaleTurquoise"))
338 (:foreground "ForestGreen"))
341 "Level 1 empty newsgroup face.")
343 (defface gnus-group-news-2-face
346 (:foreground "turquoise" :bold t))
349 (:foreground "CadetBlue4" :bold t))
352 "Level 2 newsgroup face.")
354 (defface gnus-group-news-2-empty-face
357 (:foreground "turquoise"))
360 (:foreground "CadetBlue4"))
363 "Level 2 empty newsgroup face.")
365 (defface gnus-group-news-3-face
374 "Level 3 newsgroup face.")
376 (defface gnus-group-news-3-empty-face
385 "Level 3 empty newsgroup face.")
387 (defface gnus-group-news-4-face
396 "Level 4 newsgroup face.")
398 (defface gnus-group-news-4-empty-face
407 "Level 4 empty newsgroup face.")
409 (defface gnus-group-news-5-face
418 "Level 5 newsgroup face.")
420 (defface gnus-group-news-5-empty-face
429 "Level 5 empty newsgroup face.")
431 (defface gnus-group-news-6-face
440 "Level 6 newsgroup face.")
442 (defface gnus-group-news-6-empty-face
451 "Level 6 empty newsgroup face.")
453 (defface gnus-group-news-low-face
456 (:foreground "DarkTurquoise" :bold t))
459 (:foreground "DarkGreen" :bold t))
462 "Low level newsgroup face.")
464 (defface gnus-group-news-low-empty-face
467 (:foreground "DarkTurquoise"))
470 (:foreground "DarkGreen"))
473 "Low level empty newsgroup face.")
475 (defface gnus-group-mail-1-face
478 (:foreground "aquamarine1" :bold t))
481 (:foreground "DeepPink3" :bold t))
484 "Level 1 mailgroup face.")
486 (defface gnus-group-mail-1-empty-face
489 (:foreground "aquamarine1"))
492 (:foreground "DeepPink3"))
494 (:italic t :bold t)))
495 "Level 1 empty mailgroup face.")
497 (defface gnus-group-mail-2-face
500 (:foreground "aquamarine2" :bold t))
503 (:foreground "HotPink3" :bold t))
506 "Level 2 mailgroup face.")
508 (defface gnus-group-mail-2-empty-face
511 (:foreground "aquamarine2"))
514 (:foreground "HotPink3"))
517 "Level 2 empty mailgroup face.")
519 (defface gnus-group-mail-3-face
522 (:foreground "aquamarine3" :bold t))
525 (:foreground "magenta4" :bold t))
528 "Level 3 mailgroup face.")
530 (defface gnus-group-mail-3-empty-face
533 (:foreground "aquamarine3"))
536 (:foreground "magenta4"))
539 "Level 3 empty mailgroup face.")
541 (defface gnus-group-mail-low-face
544 (:foreground "aquamarine4" :bold t))
547 (:foreground "DeepPink4" :bold t))
550 "Low level mailgroup face.")
552 (defface gnus-group-mail-low-empty-face
555 (:foreground "aquamarine4"))
558 (:foreground "DeepPink4"))
561 "Low level empty mailgroup face.")
563 ;; Summary mode faces.
565 (defface gnus-summary-selected-face '((t
567 "Face used for selected articles.")
569 (defface gnus-summary-cancelled-face
571 (:foreground "yellow" :background "black")))
572 "Face used for cancelled articles.")
574 (defface gnus-summary-high-ticked-face
577 (:foreground "pink" :bold t))
580 (:foreground "firebrick" :bold t))
583 "Face used for high interest ticked articles.")
585 (defface gnus-summary-low-ticked-face
588 (:foreground "pink" :italic t))
591 (:foreground "firebrick" :italic t))
594 "Face used for low interest ticked articles.")
596 (defface gnus-summary-normal-ticked-face
599 (:foreground "pink"))
602 (:foreground "firebrick"))
605 "Face used for normal interest ticked articles.")
607 (defface gnus-summary-high-ancient-face
610 (:foreground "SkyBlue" :bold t))
613 (:foreground "RoyalBlue" :bold t))
616 "Face used for high interest ancient articles.")
618 (defface gnus-summary-low-ancient-face
621 (:foreground "SkyBlue" :italic t))
624 (:foreground "RoyalBlue" :italic t))
627 "Face used for low interest ancient articles.")
629 (defface gnus-summary-normal-ancient-face
632 (:foreground "SkyBlue"))
635 (:foreground "RoyalBlue"))
638 "Face used for normal interest ancient articles.")
640 (defface gnus-summary-high-unread-face
643 "Face used for high interest unread articles.")
645 (defface gnus-summary-low-unread-face
648 "Face used for low interest unread articles.")
650 (defface gnus-summary-normal-unread-face
653 "Face used for normal interest unread articles.")
655 (defface gnus-summary-high-read-face
658 (:foreground "PaleGreen"
662 (:foreground "DarkGreen"
666 "Face used for high interest read articles.")
668 (defface gnus-summary-low-read-face
671 (:foreground "PaleGreen"
675 (:foreground "DarkGreen"
679 "Face used for low interest read articles.")
681 (defface gnus-summary-normal-read-face
684 (:foreground "PaleGreen"))
687 (:foreground "DarkGreen"))
690 "Face used for normal interest read articles.")
697 (defvar gnus-buffers nil)
699 (defun gnus-get-buffer-create (name)
700 "Do the same as `get-buffer-create', but store the created buffer."
701 (or (get-buffer name)
702 (car (push (get-buffer-create name) gnus-buffers))))
704 (defun gnus-add-buffer ()
705 "Add the current buffer to the list of Gnus buffers."
706 (push (current-buffer) gnus-buffers))
708 (defun gnus-buffers ()
709 "Return a list of live Gnus buffers."
710 (while (and gnus-buffers
711 (not (buffer-name (car gnus-buffers))))
713 (let ((buffers gnus-buffers))
715 (if (buffer-name (cadr buffers))
717 (setcdr buffers (cddr buffers)))))
722 (defvar gnus-group-buffer "*Group*")
725 (autoload 'gnus-play-jingle "gnus-audio"))
727 (defface gnus-splash-face
730 (:foreground "Brown"))
733 (:foreground "Brown"))
736 "Face of the splash screen.")
738 (defun gnus-splash ()
740 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
741 (let ((buffer-read-only nil))
743 (unless gnus-inhibit-startup-message
744 (gnus-group-startup-message)
746 (when gnus-play-startup-jingle
747 (gnus-play-jingle))))))
749 (defun gnus-indent-rigidly (start end arg)
750 "Indent rigidly using only spaces and no tabs."
753 (narrow-to-region start end)
755 (indent-rigidly start end arg)
756 ;; We translate tabs into spaces -- not everybody uses
757 ;; an 8-character tab.
758 (goto-char (point-min))
759 (while (search-forward "\t" nil t)
760 (replace-match " " t t))))))
762 (defvar gnus-simple-splash nil)
764 (defun gnus-group-startup-message (&optional x y)
765 "Insert startup message in current buffer."
766 ;; Insert the message.
771 _ ___ __ ___ __ _ ___
791 (gnus-indent-rigidly (point-min) (point-max)
792 (/ (max (- (window-width) (or x 46)) 0) 2))
793 (goto-char (point-min))
795 (let* ((pheight (count-lines (point-min) (point-max)))
796 (wheight (window-height))
797 (rest (- wheight pheight)))
798 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
800 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
801 (goto-char (point-min))
802 (setq mode-line-buffer-identification (concat " " gnus-version))
803 (setq gnus-simple-splash t)
804 (set-buffer-modified-p t))
807 (let ((command (format "%s" this-command)))
808 (if (and (string-match "gnus" command)
809 (not (string-match "gnus-other-frame" command)))
811 (gnus-get-buffer-create gnus-group-buffer))))
819 (defcustom gnus-home-directory "~/"
820 "Directory variable that specifies the \"home\" directory.
821 All other Gnus path variables are initialized from this variable."
825 (defcustom gnus-directory (or (getenv "SAVEDIR")
826 (nnheader-concat gnus-home-directory "News/"))
827 "*Directory variable from which all other Gnus file variables are derived.
829 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
830 This means that other directory variables that are initialized from
831 this variable won't be set properly if you set this variable in `.gnus.el'.
832 Set this variable in `.emacs' instead."
836 (defcustom gnus-default-directory nil
837 "*Default directory for all Gnus buffers."
839 :type '(choice (const :tag "current" nil)
842 ;; Site dependent variables. These variables should be defined in
845 (defvar gnus-default-nntp-server nil
846 "Specify a default NNTP server.
847 This variable should be defined in paths.el, and should never be set
849 If you want to change servers, you should use `gnus-select-method'.
850 See the documentation to that variable.")
852 ;; Don't touch this variable.
853 (defvar gnus-nntp-service "nntp"
854 "NNTP service name (\"nntp\" or 119).
855 This is an obsolete variable, which is scarcely used. If you use an
856 nntp server for your newsgroup and want to change the port number
857 used to 899, you would say something along these lines:
859 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
861 (defcustom gnus-nntpserver-file "/etc/nntpserver"
862 "A file with only the name of the nntp server in it."
867 ;; This function is used to check both the environment variable
868 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
869 ;; an nntp server name default.
870 (defun gnus-getenv-nntpserver ()
871 (or (getenv "NNTPSERVER")
872 (and (file-readable-p gnus-nntpserver-file)
874 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
875 (insert-file-contents gnus-nntpserver-file)
876 (let ((name (buffer-string)))
878 (if (string-match "^[ \t\n]*$" name)
881 (kill-buffer (current-buffer))))))))
883 (defcustom gnus-select-method
886 (list 'nntp (or (condition-case nil
887 (gnus-getenv-nntpserver)
889 (when (and gnus-default-nntp-server
890 (not (string= gnus-default-nntp-server "")))
891 gnus-default-nntp-server)
893 (if (or (null gnus-nntp-service)
894 (equal gnus-nntp-service "nntp"))
896 (list gnus-nntp-service)))
898 "*Default method for selecting a newsgroup.
899 This variable should be a list, where the first element is how the
900 news is to be fetched, the second is the address.
902 For instance, if you want to get your news via NNTP from
903 \"flab.flab.edu\", you could say:
905 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
907 If you want to use your local spool, say:
909 \(setq gnus-select-method (list 'nnspool (system-name)))
911 If you use this variable, you must set `gnus-nntp-server' to nil.
913 There is a lot more to know about select methods and virtual servers -
914 see the manual for details."
916 :type 'gnus-select-method)
918 (defcustom gnus-message-archive-method
921 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
922 (nnfolder-active-file
923 ,(nnheader-concat message-directory "archive/active"))
924 (nnfolder-get-new-mail nil)
925 (nnfolder-inhibit-expiry t))
926 "*Method used for archiving messages you've sent.
927 This should be a mail method.
929 It's probably not a very effective to change this variable once you've
930 run Gnus once. After doing that, you must edit this server from the
934 :type 'gnus-select-method)
936 (defcustom gnus-message-archive-group nil
937 "*Name of the group in which to save the messages you've written.
938 This can either be a string; a list of strings; or an alist
939 of regexps/functions/forms to be evaluated to return a string (or a list
940 of strings). The functions are called with the name of the current
941 group (or nil) as a parameter.
943 If you want to save your mail in one group and the news articles you
944 write in another group, you could say something like:
946 \(setq gnus-message-archive-group
947 '((if (message-news-p)
951 Normally the group names returned by this variable should be
952 unprefixed -- which implicitly means \"store on the archive server\".
953 However, you may wish to store the message on some other server. In
954 that case, just return a fully prefixed name of the group --
955 \"nnml+private:mail.misc\", for instance."
957 :type '(choice (const :tag "none" nil)
962 (defcustom gnus-secondary-servers nil
963 "List of NNTP servers that the user can choose between interactively.
964 To make Gnus query you for a server, you have to give `gnus' a
965 non-numeric prefix - `C-u M-x gnus', in short."
967 :type '(repeat string))
969 (defcustom gnus-nntp-server nil
970 "*The name of the host running the NNTP server.
971 This variable is semi-obsolete. Use the `gnus-select-method'
974 :type '(choice (const :tag "disable" nil)
977 (defcustom gnus-secondary-select-methods nil
978 "A list of secondary methods that will be used for reading news.
979 This is a list where each element is a complete select method (see
980 `gnus-select-method').
982 If, for instance, you want to read your mail with the nnml backend,
983 you could set this variable:
985 \(setq gnus-secondary-select-methods '((nnml \"\")))"
987 :type '(repeat gnus-select-method))
989 (defvar gnus-backup-default-subscribed-newsgroups
990 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
991 "Default default new newsgroups the first time Gnus is run.
992 Should be set in paths.el, and shouldn't be touched by the user.")
994 (defcustom gnus-local-domain nil
995 "Local domain name without a host name.
996 The DOMAINNAME environment variable is used instead if it is defined.
997 If the `system-name' function returns the full Internet name, there is
998 no need to set this variable."
1000 :type '(choice (const :tag "default" nil)
1003 (defvar gnus-local-organization nil
1004 "String with a description of what organization (if any) the user belongs to.
1005 Obsolete variable; use `message-user-organization' instead.")
1007 ;; Customization variables
1009 (defcustom gnus-refer-article-method nil
1010 "Preferred method for fetching an article by Message-ID.
1011 If you are reading news from the local spool (with nnspool), fetching
1012 articles by Message-ID is painfully slow. By setting this method to an
1013 nntp method, you might get acceptable results.
1015 The value of this variable must be a valid select method as discussed
1016 in the documentation of `gnus-select-method'."
1018 :type '(choice (const :tag "default" nil)
1019 gnus-select-method))
1021 (defcustom gnus-group-faq-directory
1022 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1023 "/ftp@sunsite.auc.dk:/pub/usenet/"
1024 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1025 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1026 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1027 "/ftp@rtfm.mit.edu:/pub/usenet/"
1028 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1029 "/ftp@ftp.sunet.se:/pub/usenet/"
1030 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1031 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1032 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1033 "*Directory where the group FAQs are stored.
1034 This will most commonly be on a remote machine, and the file will be
1035 fetched by ange-ftp.
1037 This variable can also be a list of directories. In that case, the
1038 first element in the list will be used by default. The others can
1039 be used when being prompted for a site.
1041 Note that Gnus uses an aol machine as the default directory. If this
1042 feels fundamentally unclean, just think of it as a way to finally get
1043 something of value back from them.
1045 If the default site is too slow, try one of these:
1047 North America: mirrors.aol.com /pub/rtfm/usenet
1048 ftp.seas.gwu.edu /pub/rtfm
1049 rtfm.mit.edu /pub/usenet
1050 Europe: ftp.uni-paderborn.de /pub/FAQ
1051 src.doc.ic.ac.uk /usenet/news-FAQS
1052 ftp.sunet.se /pub/usenet
1053 sunsite.auc.dk /pub/usenet
1054 Asia: nctuccca.edu.tw /USENET/FAQ
1055 hwarang.postech.ac.kr /pub/usenet
1056 ftp.hk.super.net /mirror/faqs"
1057 :group 'gnus-group-various
1058 :type '(choice directory
1059 (repeat directory)))
1061 (defcustom gnus-use-cross-reference t
1062 "*Non-nil means that cross referenced articles will be marked as read.
1063 If nil, ignore cross references. If t, mark articles as read in
1064 subscribed newsgroups. If neither t nor nil, mark as read in all
1067 :type '(choice (const :tag "off" nil)
1068 (const :tag "subscribed" t)
1072 (defcustom gnus-process-mark ?#
1074 :group 'gnus-group-visual
1075 :group 'gnus-summary-marks
1078 (defcustom gnus-asynchronous nil
1079 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1080 :group 'gnus-asynchronous
1083 (defcustom gnus-large-newsgroup 200
1084 "*The number of articles which indicates a large newsgroup.
1085 If the number of articles in a newsgroup is greater than this value,
1086 confirmation is required for selecting the newsgroup."
1087 :group 'gnus-group-select
1090 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1091 "*Non-nil means that the default name of a file to save articles in is the group name.
1092 If it's nil, the directory form of the group name is used instead.
1094 If this variable is a list, and the list contains the element
1095 `not-score', long file names will not be used for score files; if it
1096 contains the element `not-save', long file names will not be used for
1097 saving; and if it contains the element `not-kill', long file names
1098 will not be used for kill files.
1100 Note that the default for this variable varies according to what system
1101 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1102 to nil while on all other systems it defaults to t."
1106 (defcustom gnus-kill-files-directory gnus-directory
1107 "*Name of the directory where kill files will be stored (default \"~/News\")."
1108 :group 'gnus-score-files
1109 :group 'gnus-score-kill
1112 (defcustom gnus-save-score nil
1113 "*If non-nil, save group scoring info."
1114 :group 'gnus-score-various
1118 (defcustom gnus-use-undo t
1119 "*If non-nil, allow undoing in Gnus group mode buffers."
1123 (defcustom gnus-use-adaptive-scoring nil
1124 "*If non-nil, use some adaptive scoring scheme.
1125 If a list, then the values `word' and `line' are meaningful. The
1126 former will perform adaption on individual words in the subject
1127 header while `line' will perform adaption on several headers."
1129 :group 'gnus-score-adapt
1130 :type '(set (const word) (const line)))
1132 (defcustom gnus-use-cache 'passive
1133 "*If nil, Gnus will ignore the article cache.
1134 If `passive', it will allow entering (and reading) articles
1135 explicitly entered into the cache. If anything else, use the
1136 cache to the full extent of the law."
1139 :type '(choice (const :tag "off" nil)
1140 (const :tag "passive" passive)
1141 (const :tag "active" t)))
1143 (defcustom gnus-use-trees nil
1144 "*If non-nil, display a thread tree buffer."
1148 (defcustom gnus-use-grouplens nil
1149 "*If non-nil, use GroupLens ratings."
1153 (defcustom gnus-keep-backlog nil
1154 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1155 If it is a number N, then Gnus will only keep the last N articles
1156 read. If it is neither nil nor a number, Gnus will keep all read
1157 articles. This is not a good idea."
1159 :type '(choice (const :tag "off" nil)
1164 (defcustom gnus-use-nocem nil
1165 "*If non-nil, Gnus will read NoCeM cancel messages."
1169 (defcustom gnus-suppress-duplicates nil
1170 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1174 (defcustom gnus-use-scoring t
1175 "*If non-nil, enable scoring."
1179 (defcustom gnus-use-picons nil
1180 "*If non-nil, display picons."
1184 (defcustom gnus-summary-prepare-exit-hook
1185 '(gnus-summary-expire-articles)
1186 "*A hook called when preparing to exit from the summary buffer.
1187 It calls `gnus-summary-expire-articles' by default."
1188 :group 'gnus-summary-exit
1191 (defcustom gnus-novice-user t
1192 "*Non-nil means that you are a usenet novice.
1193 If non-nil, verbose messages may be displayed and confirmations may be
1198 (defcustom gnus-expert-user nil
1199 "*Non-nil means that you will never be asked for confirmation about anything.
1200 That doesn't mean *anything* anything; particularly destructive
1201 commands will still require prompting."
1205 (defcustom gnus-interactive-catchup t
1206 "*If non-nil, require your confirmation when catching up a group."
1207 :group 'gnus-group-select
1210 (defcustom gnus-interactive-exit t
1211 "*If non-nil, require your confirmation when exiting Gnus."
1215 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1216 "*Function for extracting address components from a From header.
1217 Two pre-defined function exist: `gnus-extract-address-components',
1218 which is the default, quite fast, and too simplistic solution, and
1219 `mail-extract-address-components', which works much better, but is
1221 :group 'gnus-summary-format
1222 :type '(radio (function-item gnus-extract-address-components)
1223 (function-item mail-extract-address-components)
1224 (function-item std11-extract-address-components)
1225 (function :tag "Other")))
1227 (defcustom gnus-carpal nil
1228 "*If non-nil, display clickable icons."
1232 (defcustom gnus-shell-command-separator ";"
1233 "String used to separate to shell commands."
1237 (defcustom gnus-valid-select-methods
1238 '(("nntp" post address prompt-address physical-address)
1239 ("nnspool" post address)
1240 ("nnvirtual" post-mail virtual prompt-address)
1241 ("nnmbox" mail respool address)
1242 ("nnml" mail respool address)
1243 ("nnmh" mail respool address)
1244 ("nndir" post-mail prompt-address physical-address)
1245 ("nneething" none address prompt-address physical-address)
1246 ("nndoc" none address prompt-address)
1247 ("nnbabyl" mail address respool)
1248 ("nnkiboze" post virtual)
1249 ("nnsoup" post-mail address)
1250 ("nndraft" post-mail)
1251 ("nnfolder" mail respool address)
1252 ("nngateway" post-mail address prompt-address physical-address)
1255 ("nnagent" post-mail))
1256 "*An alist of valid select methods.
1257 The first element of each list lists should be a string with the name
1258 of the select method. The other elements may be the category of
1259 this method (i. e., `post', `mail', `none' or whatever) or other
1260 properties that this method has (like being respoolable).
1261 If you implement a new select method, all you should have to change is
1262 this variable. I think."
1264 :type '(repeat (group (string :tag "Name")
1265 (radio-button-choice (const :format "%v " post)
1266 (const :format "%v " mail)
1267 (const :format "%v " none)
1269 (checklist :inline t
1270 (const :format "%v " address)
1271 (const :format "%v " prompt-address)
1272 (const :format "%v " physical-address)
1273 (const :format "%v " virtual)
1276 (define-widget 'gnus-select-method 'list
1277 "Widget for entering a select method."
1278 :args `((choice :tag "Method"
1279 ,@(mapcar (lambda (entry)
1280 (list 'const :format "%v\n"
1281 (intern (car entry))))
1282 gnus-valid-select-methods))
1283 (string :tag "Address")
1284 (editable-list :inline t
1287 (sexp :tag "Value")))))
1289 (defcustom gnus-updated-mode-lines '(group article summary tree)
1290 "List of buffers that should update their mode lines.
1291 The list may contain the symbols `group', `article', `tree' and
1292 `summary'. If the corresponding symbol is present, Gnus will keep
1293 that mode line updated with information that may be pertinent.
1294 If this variable is nil, screen refresh may be quicker."
1295 :group 'gnus-various
1296 :type '(set (const group)
1301 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1302 (defcustom gnus-mode-non-string-length nil
1303 "*Max length of mode-line non-string contents.
1304 If this is nil, Gnus will take space as is needed, leaving the rest
1305 of the modeline intact. Note that the default of nil is unlikely
1306 to be desirable; see the manual for further details."
1307 :group 'gnus-various
1308 :type '(choice (const nil)
1311 (defcustom gnus-auto-expirable-newsgroups nil
1312 "*Groups in which to automatically mark read articles as expirable.
1313 If non-nil, this should be a regexp that should match all groups in
1314 which to perform auto-expiry. This only makes sense for mail groups."
1315 :group 'nnmail-expire
1316 :type '(choice (const nil)
1319 (defcustom gnus-total-expirable-newsgroups nil
1320 "*Groups in which to perform expiry of all read articles.
1321 Use with extreme caution. All groups that match this regexp will be
1322 expiring - which means that all read articles will be deleted after
1323 \(say) one week. (This only goes for mail groups and the like, of
1325 :group 'nnmail-expire
1326 :type '(choice (const nil)
1329 (defcustom gnus-group-uncollapsed-levels 1
1330 "Number of group name elements to leave alone when making a short group name."
1331 :group 'gnus-group-visual
1334 (defcustom gnus-group-use-permanent-levels nil
1335 "*If non-nil, once you set a level, Gnus will use this level."
1336 :group 'gnus-group-levels
1341 (defcustom gnus-load-hook nil
1342 "A hook run while Gnus is loaded."
1346 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1347 "A hook called to apply kill files to a group.
1348 This hook is intended to apply a kill file to the selected newsgroup.
1349 The function `gnus-apply-kill-file' is called by default.
1351 Since a general kill file is too heavy to use only for a few
1352 newsgroups, I recommend you to use a lighter hook function. For
1353 example, if you'd like to apply a kill file to articles which contains
1354 a string `rmgroup' in subject in newsgroup `control', you can use the
1357 (setq gnus-apply-kill-hook
1360 (cond ((string-match \"control\" gnus-newsgroup-name)
1361 (gnus-kill \"Subject\" \"rmgroup\")
1362 (gnus-expunge \"X\"))))))"
1363 :group 'gnus-score-kill
1364 :options '(gnus-apply-kill-file)
1367 (defcustom gnus-group-change-level-function nil
1368 "Function run when a group level is changed.
1369 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1370 :group 'gnus-group-level
1375 (defcustom gnus-visual
1376 '(summary-highlight group-highlight article-highlight
1378 summary-menu group-menu article-menu
1379 tree-highlight menu highlight
1380 browse-menu server-menu
1381 page-marker tree-menu binary-menu pick-menu
1383 "*Enable visual features.
1384 If `visual' is disabled, there will be no menus and few faces. Most of
1385 the visual customization options below will be ignored. Gnus will use
1386 less space and be faster as a result.
1388 This variable can also be a list of visual elements to switch on. For
1389 instance, to switch off all visual things except menus, you can say:
1391 (setq gnus-visual '(menu))
1393 Valid elements include `summary-highlight', `group-highlight',
1394 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1395 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1396 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1397 and `grouplens-menu'."
1400 :type '(set (const summary-highlight)
1401 (const group-highlight)
1402 (const article-highlight)
1404 (const summary-menu)
1406 (const article-menu)
1407 (const tree-highlight)
1416 (const grouplens-menu)))
1418 (defcustom gnus-mouse-face
1420 (if (gnus-visual-p 'mouse-face 'highlight)
1421 (if (boundp 'gnus-mouse-face)
1422 (or gnus-mouse-face 'highlight)
1426 "*Face used for group or summary buffer mouse highlighting.
1427 The line beneath the mouse pointer will be highlighted with this
1432 (defcustom gnus-article-display-hook
1433 (if (and (string-match "XEmacs" emacs-version)
1435 '(gnus-article-hide-headers-if-wanted
1436 gnus-article-hide-boring-headers
1437 gnus-article-treat-overstrike
1438 gnus-article-maybe-highlight
1439 gnus-article-display-x-face)
1440 '(gnus-article-hide-headers-if-wanted
1441 gnus-article-hide-boring-headers
1442 gnus-article-treat-overstrike
1443 gnus-article-maybe-highlight))
1444 "*Controls how the article buffer will look.
1446 If you leave the list empty, the article will appear exactly as it is
1447 stored on the disk. The list entries will hide or highlight various
1448 parts of the article, making it easier to find the information you
1450 :group 'gnus-article-highlight
1453 :options '(gnus-article-add-buttons
1454 gnus-article-add-buttons-to-head
1455 gnus-article-emphasize
1456 gnus-article-fill-cited-article
1457 gnus-article-remove-cr
1458 gnus-summary-stop-page-breaking
1459 ;; gnus-summary-caesar-message
1460 ;; gnus-summary-verbose-headers
1461 gnus-summary-toggle-mime
1463 gnus-article-hide-headers
1464 gnus-article-hide-boring-headers
1465 gnus-article-hide-signature
1466 gnus-article-hide-citation
1467 gnus-article-hide-pgp
1468 gnus-article-hide-pem
1469 gnus-article-highlight
1470 gnus-article-highlight-headers
1471 gnus-article-highlight-citation
1472 gnus-article-highlight-signature
1473 gnus-article-date-ut
1474 gnus-article-date-local
1475 gnus-article-date-lapsed
1476 gnus-article-date-original
1477 gnus-article-remove-trailing-blank-lines
1478 gnus-article-strip-leading-blank-lines
1479 gnus-article-strip-multiple-blank-lines
1480 gnus-article-strip-blank-lines
1481 gnus-article-treat-overstrike
1482 gnus-article-display-x-face
1483 gnus-smiley-display))
1485 (defcustom gnus-article-save-directory gnus-directory
1486 "*Name of the directory articles will be saved in (default \"~/News\")."
1487 :group 'gnus-article-saving
1490 (defvar gnus-plugged t
1491 "Whether Gnus is plugged or not.")
1493 (defcustom gnus-default-charset 'iso-8859-1
1494 "Default charset assumed to be used when viewing non-ASCII characters.
1495 This variable is overridden on a group-to-group basis by the
1496 gnus-group-charset-alist variable and is only used on groups not
1497 covered by that variable."
1499 :group 'gnus-charset)
1501 (defcustom gnus-default-posting-charset nil
1502 "Default charset assumed to be used when posting non-ASCII characters.
1503 This variable is overridden on a group-to-group basis by the
1504 gnus-group-posting-charset-alist variable and is only used on groups not
1505 covered by that variable.
1506 If nil, no default charset is assumed when posting."
1508 :group 'gnus-charset)
1511 ;;; Internal variables
1513 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1514 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1515 (defvar gnus-original-article-buffer " *Original Article*")
1516 (defvar gnus-newsgroup-name nil)
1517 (defvar gnus-ephemeral-servers nil)
1519 (defvar gnus-agent nil
1520 "Whether we want to use the Gnus agent or not.")
1522 (defvar gnus-command-method nil
1523 "Dynamically bound variable that says what the current backend is.")
1525 (defvar gnus-current-select-method nil
1526 "The current method for selecting a newsgroup.")
1528 (defvar gnus-tree-buffer "*Tree*"
1529 "Buffer where Gnus thread trees are displayed.")
1532 (defvar gnus-use-generic-from nil)
1534 ;; Variable holding the user answers to all method prompts.
1535 (defvar gnus-method-history nil)
1537 ;; Variable holding the user answers to all mail method prompts.
1538 (defvar gnus-mail-method-history nil)
1540 ;; Variable holding the user answers to all group prompts.
1541 (defvar gnus-group-history nil)
1543 (defvar gnus-server-alist nil
1544 "List of available servers.")
1546 (defcustom gnus-cache-directory
1547 (nnheader-concat gnus-directory "cache/")
1548 "*The directory where cached articles will be stored."
1552 (defvar gnus-predefined-server-alist
1555 (nnspool-spool-directory ,gnus-cache-directory)
1556 (nnspool-nov-directory ,gnus-cache-directory)
1557 (nnspool-active-file
1558 ,(nnheader-concat gnus-cache-directory "active"))))
1559 "List of predefined (convenience) servers.")
1561 (defvar gnus-topic-indentation "");; Obsolete variable.
1563 (defconst gnus-article-mark-lists
1564 '((marked . tick) (replied . reply)
1565 (expirable . expire) (killed . killed)
1566 (bookmarks . bookmark) (dormant . dormant)
1567 (scored . score) (saved . save)
1568 (cached . cache) (downloadable . download)
1569 (unsendable . unsend)))
1571 (defvar gnus-headers-retrieved-by nil)
1572 (defvar gnus-article-reply nil)
1573 (defvar gnus-override-method nil)
1574 (defvar gnus-article-check-size nil)
1575 (defvar gnus-opened-servers nil)
1577 (defvar gnus-current-kill-article nil)
1579 (defvar gnus-have-read-active-file nil)
1581 (defconst gnus-maintainer
1582 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1583 "The mail address of the Gnus maintainers.")
1585 (defconst semi-gnus-developers
1586 "Semi-gnus Developers:
1587 semi-gnus-en@meadow.scphys.kyoto-u.ac.jp (In English),\
1588 semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (In Japanese);"
1589 "The mail address of the Semi-gnus developers.")
1591 (defcustom gnus-info-filename nil
1592 "*Controls language of gnus Info.
1593 If nil and current-language-environment is Japanese, go to gnus-ja.
1594 Otherwise go to corresponding Info.
1595 This variable can be nil, gnus or gnus-ja."
1597 :type '(choice (const nil)
1598 (const :tag "English" gnus)
1599 (const :tag "Japanese" gnus-ja)))
1601 (defvar gnus-info-nodes
1602 '((gnus-group-mode "The Group Buffer")
1603 (gnus-summary-mode "The Summary Buffer")
1604 (gnus-article-mode "The Article Buffer")
1605 (gnus-server-mode "The Server Buffer")
1606 (gnus-browse-mode "Browse Foreign Server")
1607 (gnus-tree-mode "Tree Display"))
1608 "Alist of major modes and related Info nodes.")
1610 (defvar gnus-group-buffer "*Group*")
1611 (defvar gnus-summary-buffer "*Summary*")
1612 (defvar gnus-article-buffer "*Article*")
1613 (defvar gnus-server-buffer "*Server*")
1615 (defvar gnus-slave nil
1616 "Whether this Gnus is a slave or not.")
1618 (defvar gnus-batch-mode nil
1619 "Whether this Gnus is running in batch mode or not.")
1621 (defvar gnus-variable-list
1622 '(gnus-newsrc-options gnus-newsrc-options-n
1623 gnus-newsrc-last-checked-date
1624 gnus-newsrc-alist gnus-server-alist
1625 gnus-killed-list gnus-zombie-list
1626 gnus-topic-topology gnus-topic-alist
1628 "Gnus variables saved in the quick startup file.")
1630 (defvar gnus-newsrc-alist nil
1631 "Assoc list of read articles.
1632 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1634 (defvar gnus-newsrc-hashtb nil
1635 "Hashtable of gnus-newsrc-alist.")
1637 (defvar gnus-killed-list nil
1638 "List of killed newsgroups.")
1640 (defvar gnus-killed-hashtb nil
1641 "Hash table equivalent of gnus-killed-list.")
1643 (defvar gnus-zombie-list nil
1644 "List of almost dead newsgroups.")
1646 (defvar gnus-description-hashtb nil
1647 "Descriptions of newsgroups.")
1649 (defvar gnus-list-of-killed-groups nil
1650 "List of newsgroups that have recently been killed by the user.")
1652 (defvar gnus-active-hashtb nil
1653 "Hashtable of active articles.")
1655 (defvar gnus-moderated-hashtb nil
1656 "Hashtable of moderated newsgroups.")
1658 ;; Save window configuration.
1659 (defvar gnus-prev-winconf nil)
1661 (defvar gnus-reffed-article-number nil)
1663 ;;; Let the byte-compiler know that we know about this variable.
1664 (defvar rmail-default-rmail-file)
1666 (defvar gnus-dead-summary nil)
1668 ;;; End of variables.
1670 ;; Define some autoload functions Gnus might use.
1673 ;; This little mapcar goes through the list below and marks the
1674 ;; symbols in question as autoloaded functions.
1677 (let ((interactive (nth 1 (memq ':interactive package))))
1681 (when (consp function)
1682 (setq keymap (car (memq 'keymap function)))
1683 (setq function (car function)))
1684 (autoload function (car package) nil interactive keymap)))
1685 (if (eq (nth 1 package) ':interactive)
1688 '(("info" Info-goto-node)
1689 ("pp" pp pp-to-string pp-eval-expression)
1690 ("ps-print" ps-print-preprint)
1691 ("mail-extr" mail-extract-address-components)
1692 ("browse-url" browse-url)
1693 ("message" :interactive t
1694 message-send-and-exit message-yank-original)
1695 ("nnmail" nnmail-split-fancy nnmail-article-group)
1696 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1697 ("rmailout" rmail-output rmail-output-to-rmail-file)
1698 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1699 rmail-show-message rmail-summary-exists
1700 rmail-select-summary rmail-update-summary)
1701 ("gnus-audio" :interactive t gnus-audio-play)
1702 ("gnus-xmas" gnus-xmas-splash)
1703 ("gnus-soup" :interactive t
1704 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1705 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1706 ("nnsoup" nnsoup-pack-replies)
1707 ("score-mode" :interactive t gnus-score-mode)
1708 ("gnus-mh" gnus-summary-save-article-folder
1709 gnus-Folder-save-name gnus-folder-save-name)
1710 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1711 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1712 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1713 gnus-demon-add-disconnection gnus-demon-add-handler
1714 gnus-demon-remove-handler)
1715 ("gnus-demon" :interactive t
1716 gnus-demon-init gnus-demon-cancel)
1717 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1718 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1719 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1720 gnus-nocem-unwanted-article-p)
1721 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1722 gnus-server-server-name)
1723 ("gnus-srvr" gnus-browse-foreign-server)
1724 ("gnus-cite" :interactive t
1725 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1726 gnus-article-hide-citation gnus-article-fill-cited-article
1727 gnus-article-hide-citation-in-followups)
1728 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1729 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1730 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1731 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1732 gnus-cache-possibly-remove-articles gnus-cache-request-article
1733 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1734 gnus-cache-enter-remove-article gnus-cached-article-p
1735 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1736 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1737 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1738 ("gnus-score" :interactive t
1739 gnus-summary-increase-score gnus-summary-set-score
1740 gnus-summary-raise-thread gnus-summary-raise-same-subject
1741 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1742 gnus-summary-lower-thread gnus-summary-lower-same-subject
1743 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1744 gnus-summary-current-score gnus-score-default
1745 gnus-score-flush-cache gnus-score-close
1746 gnus-possibly-score-headers gnus-score-followup-article
1747 gnus-score-followup-thread)
1749 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1750 gnus-current-score-file-nondirectory gnus-score-adaptive
1751 gnus-score-find-trace gnus-score-file-name)
1752 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1753 ("gnus-topic" :interactive t gnus-topic-mode)
1754 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1755 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1756 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1757 ("gnus-uu" :interactive t
1758 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1759 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1760 gnus-uu-mark-by-regexp gnus-uu-mark-all
1761 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1762 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1763 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1764 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1765 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1766 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1767 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1768 gnus-uu-mark-over gnus-uu-post-news)
1769 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1770 gnus-uu-unmark-thread)
1771 ("gnus-msg" (gnus-summary-send-map keymap)
1772 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1773 ("gnus-msg" :interactive t
1774 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1775 gnus-summary-followup gnus-summary-followup-with-original
1776 gnus-summary-cancel-article gnus-summary-supersede-article
1777 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1778 gnus-summary-mail-forward gnus-summary-mail-other-window
1779 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1780 gnus-summary-wide-reply gnus-summary-followup-to-mail
1781 gnus-summary-followup-to-mail-with-original gnus-bug
1782 gnus-summary-wide-reply-with-original
1783 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1784 gnus-summary-post-forward)
1785 ("gnus-picon" :interactive t gnus-article-display-picons
1786 gnus-group-display-picons gnus-picons-article-display-x-face
1787 gnus-picons-display-x-face)
1788 ("gnus-picon" gnus-picons-buffer-name)
1789 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1790 gnus-grouplens-mode)
1791 ("smiley" :interactive t gnus-smiley-display)
1792 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1793 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1794 gnus-list-of-unread-articles gnus-list-of-read-articles
1795 gnus-offer-save-summaries gnus-make-thread-indent-array
1796 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1797 gnus-summary-skip-intangible gnus-summary-article-number
1798 gnus-data-header gnus-data-find)
1799 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1800 gnus-group-list-groups gnus-group-first-unread-group
1801 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1802 gnus-group-setup-buffer gnus-group-get-new-news
1803 gnus-group-make-help-group gnus-group-update-group
1804 gnus-group-iterate gnus-group-group-name)
1805 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1806 gnus-backlog-remove-article)
1807 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1808 gnus-article-prepare gnus-article-set-window-start
1809 gnus-article-next-page gnus-article-prev-page
1810 gnus-request-article-this-buffer gnus-article-mode
1811 gnus-article-setup-buffer gnus-narrow-to-page
1812 gnus-article-delete-invisible-text gnus-treat-article)
1813 ("gnus-art" :interactive t
1814 gnus-article-hide-headers gnus-article-hide-boring-headers
1815 gnus-article-treat-overstrike gnus-article-word-wrap
1816 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1817 gnus-article-display-x-face
1818 gnus-article-hide-pgp
1819 gnus-article-hide-pem gnus-article-hide-signature
1820 gnus-article-strip-leading-blank-lines gnus-article-date-local
1821 gnus-article-date-original gnus-article-date-lapsed
1822 gnus-article-show-all-headers
1823 gnus-article-edit-mode gnus-article-edit-article
1824 gnus-article-edit-done article-decode-encoded-words
1825 gnus-start-date-timer gnus-stop-date-timer)
1826 ("gnus-int" gnus-request-type)
1827 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1828 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1829 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1830 gnus-dup-enter-articles)
1831 ("gnus-range" gnus-copy-sequence)
1832 ("gnus-eform" gnus-edit-form)
1833 ("gnus-move" :interactive t
1834 gnus-group-move-group-to-server gnus-change-server)
1835 ("gnus-logic" gnus-score-advanced)
1836 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1837 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1838 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1839 gnus-async-halt-prefetch)
1842 ("gnus-offline" :interactive t
1843 gnus-offline-toggle-plugged
1844 gnus-offline-set-unplugged-state
1845 gnus-offline-toggle-auto-hangup
1846 gnus-offline-toggle-on/off-send-mail
1847 gnus-offline-toggle-articles-to-fetch
1848 gnus-offline-toggle-movemail-program
1849 gnus-offline-set-interval-time
1850 gnus-offline-agent-expire)
1851 ("pop3-fma" :interactive t
1852 pop3-fma-set-pop3-password)
1853 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1854 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1855 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1856 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1857 ("gnus-agent" :interactive t
1858 gnus-unplugged gnus-agentize gnus-agent-batch)
1859 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1860 gnus-summary-save-article-vm)
1861 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1863 ;;; gnus-sum.el thingies
1866 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1867 "*The format specification of the lines in the summary buffer.
1869 It works along the same lines as a normal formatting string,
1870 with some simple extensions.
1872 %N Article number, left padded with spaces (string)
1874 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1875 %n Name of the poster (string)
1876 %a Extracted name of the poster (string)
1877 %A Extracted address of the poster (string)
1878 %F Contents of the From: header (string)
1879 %f Contents of the From: or To: headers (string)
1880 %x Contents of the Xref: header (string)
1881 %D Date of the article (string)
1882 %d Date of the article (string) in DD-MMM format
1883 %M Message-id of the article (string)
1884 %r References of the article (string)
1885 %c Number of characters in the article (integer)
1886 %L Number of lines in the article (integer)
1887 %I Indentation based on thread level (a string of spaces)
1888 %T A string with two possible values: 80 spaces if the article
1889 is on thread level two or larger and 0 spaces on level one
1890 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1891 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1892 %[ Opening bracket (character, \"[\" or \"<\")
1893 %] Closing bracket (character, \"]\" or \">\")
1894 %> Spaces of length thread-level (string)
1895 %< Spaces of length (- 20 thread-level) (string)
1896 %i Article score (number)
1897 %z Article zcore (character)
1898 %t Number of articles under the current thread (number).
1899 %e Whether the thread is empty or not (character).
1900 %l GroupLens score (string).
1901 %V Total thread score (number).
1902 %P The line number (number).
1903 %O Download mark (character).
1904 %u User defined specifier. The next character in the format string should
1905 be a letter. Gnus will call the function gnus-user-format-function-X,
1906 where X is the letter following %u. The function will be passed the
1907 current header as argument. The function should return a string, which
1908 will be inserted into the summary just like information from any other
1911 Text between %( and %) will be highlighted with `gnus-mouse-face'
1912 when the mouse point is placed inside the area. There can only be one
1915 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1916 with care. For reasons of efficiency, Gnus will compute what column
1917 these characters will end up in, and \"hard-code\" that. This means that
1918 it is invalid to have these specs after a variable-length spec. Well,
1919 you might not be arrested, but your summary buffer will look strange,
1920 which is bad enough.
1922 The smart choice is to have these specs as for to the left as
1925 This restriction may disappear in later versions of Gnus."
1927 :group 'gnus-summary-format)
1930 ;;; Skeleton keymaps
1933 (defun gnus-suppress-keymap (keymap)
1934 (suppress-keymap keymap)
1935 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1937 (define-key keymap (pop keys) 'undefined))))
1939 (defvar gnus-article-mode-map
1940 (let ((keymap (make-sparse-keymap)))
1941 (gnus-suppress-keymap keymap)
1943 (defvar gnus-summary-mode-map
1944 (let ((keymap (make-keymap)))
1945 (gnus-suppress-keymap keymap)
1947 (defvar gnus-group-mode-map
1948 (let ((keymap (make-keymap)))
1949 (gnus-suppress-keymap keymap)
1954 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1955 ;; If you want the cursor to go somewhere else, set these two
1956 ;; functions in some startup hook to whatever you want.
1957 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1958 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1960 ;;; Various macros and substs.
1962 (defun gnus-header-from (header)
1963 (mail-header-from header))
1965 (defmacro gnus-gethash (string hashtable)
1966 "Get hash value of STRING in HASHTABLE."
1967 `(symbol-value (intern-soft ,string ,hashtable)))
1969 (defmacro gnus-sethash (string value hashtable)
1970 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1971 `(set (intern ,string ,hashtable) ,value))
1972 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1974 (defmacro gnus-group-unread (group)
1975 "Get the currently computed number of unread articles in GROUP."
1976 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1978 (defmacro gnus-group-entry (group)
1979 "Get the newsrc entry for GROUP."
1980 `(gnus-gethash ,group gnus-newsrc-hashtb))
1982 (defmacro gnus-active (group)
1983 "Get active info on GROUP."
1984 `(gnus-gethash ,group gnus-active-hashtb))
1986 (defmacro gnus-set-active (group active)
1987 "Set GROUP's active info."
1988 `(gnus-sethash ,group ,active gnus-active-hashtb))
1990 ;; Info access macros.
1992 (defmacro gnus-info-group (info)
1994 (defmacro gnus-info-rank (info)
1996 (defmacro gnus-info-read (info)
1998 (defmacro gnus-info-marks (info)
2000 (defmacro gnus-info-method (info)
2002 (defmacro gnus-info-params (info)
2005 (defmacro gnus-info-level (info)
2006 `(let ((rank (gnus-info-rank ,info)))
2010 (defmacro gnus-info-score (info)
2011 `(let ((rank (gnus-info-rank ,info)))
2012 (or (and (consp rank) (cdr rank)) 0)))
2014 (defmacro gnus-info-set-group (info group)
2015 `(setcar ,info ,group))
2016 (defmacro gnus-info-set-rank (info rank)
2017 `(setcar (nthcdr 1 ,info) ,rank))
2018 (defmacro gnus-info-set-read (info read)
2019 `(setcar (nthcdr 2 ,info) ,read))
2020 (defmacro gnus-info-set-marks (info marks &optional extend)
2022 `(gnus-info-set-entry ,info ,marks 3)
2023 `(setcar (nthcdr 3 ,info) ,marks)))
2024 (defmacro gnus-info-set-method (info method &optional extend)
2026 `(gnus-info-set-entry ,info ,method 4)
2027 `(setcar (nthcdr 4 ,info) ,method)))
2028 (defmacro gnus-info-set-params (info params &optional extend)
2030 `(gnus-info-set-entry ,info ,params 5)
2031 `(setcar (nthcdr 5 ,info) ,params)))
2033 (defun gnus-info-set-entry (info entry number)
2034 ;; Extend the info until we have enough elements.
2035 (while (<= (length info) number)
2036 (nconc info (list nil)))
2038 (setcar (nthcdr number info) entry))
2040 (defmacro gnus-info-set-level (info level)
2041 `(let ((rank (cdr ,info)))
2042 (if (consp (car rank))
2043 (setcar (car rank) ,level)
2044 (setcar rank ,level))))
2045 (defmacro gnus-info-set-score (info score)
2046 `(let ((rank (cdr ,info)))
2047 (if (consp (car rank))
2048 (setcdr (car rank) ,score)
2049 (setcar rank (cons (car rank) ,score)))))
2051 (defmacro gnus-get-info (group)
2052 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2054 ;; Byte-compiler warning.
2055 (defvar gnus-visual)
2056 ;; Find out whether the gnus-visual TYPE is wanted.
2057 (defun gnus-visual-p (&optional type class)
2058 (and gnus-visual ; Has to be non-nil, at least.
2059 (if (not type) ; We don't care about type.
2061 (if (listp gnus-visual) ; It's a list, so we check it.
2062 (or (memq type gnus-visual)
2063 (memq class gnus-visual))
2066 ;;; Load the compatability functions.
2075 (defvar gnus-shutdown-alist nil)
2077 (defun gnus-add-shutdown (function &rest symbols)
2078 "Run FUNCTION whenever one of SYMBOLS is shut down."
2079 (push (cons function symbols) gnus-shutdown-alist))
2081 (defun gnus-shutdown (symbol)
2082 "Shut down everything that waits for SYMBOL."
2083 (let ((alist gnus-shutdown-alist)
2085 (while (setq entry (pop alist))
2086 (when (memq symbol (cdr entry))
2087 (funcall (car entry))))))
2091 ;;; Gnus Utility Functions
2095 (defmacro gnus-string-or (&rest strings)
2096 "Return the first element of STRINGS that is a non-blank string.
2097 STRINGS will be evaluated in normal `or' order."
2098 `(gnus-string-or-1 ',strings))
2100 (defun gnus-string-or-1 (strings)
2103 (setq string (eval (pop strings)))
2104 (if (string-match "^[ \t]*$" string)
2106 (setq strings nil)))
2109 (defun gnus-version (&optional arg)
2110 "Version number of this version of Gnus.
2111 If ARG, insert string at point."
2114 (insert (message gnus-version))
2115 (message gnus-version)))
2117 (defun gnus-continuum-version (version)
2118 "Return VERSION as a floating point number."
2119 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2120 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2121 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2122 (number (match-string 2 version))
2124 (unless (string-match
2125 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2126 (error "Invalid version string: %s" version))
2127 (setq major (string-to-number (match-string 1 number))
2128 minor (string-to-number (match-string 2 number))
2129 least (if (match-beginning 3)
2130 (string-to-number (match-string 3 number))
2134 (format "%s00%02d%02d"
2135 (if (member alpha '("(ding)" "d"))
2139 (- (char-int (aref (downcase alpha) 0))
2143 (format "%d.%02d%02d" major minor least))))))
2145 (defun gnus-info-find-node ()
2146 "Find Info documentation of Gnus."
2148 ;; Enlarge info window if needed.
2149 (let (gnus-info-buffer)
2152 (or gnus-info-filename
2153 (get-language-info current-language-environment 'gnus-info)
2155 (cadr (assq major-mode gnus-info-nodes))))
2156 (setq gnus-info-buffer (current-buffer))
2157 (gnus-configure-windows 'info)))
2160 ;;; gnus-interactive
2163 (defvar gnus-current-prefix-symbol nil
2164 "Current prefix symbol.")
2166 (defvar gnus-current-prefix-symbols nil
2167 "List of current prefix symbols.")
2169 (defun gnus-interactive (string &optional params)
2170 "Return a list that can be fed to `interactive'.
2171 See `interactive' for full documentation.
2173 Adds the following specs:
2175 y -- The current symbolic prefix.
2176 Y -- A list of the current symbolic prefix(es).
2177 A -- Article number.
2178 H -- Article header.
2182 (while (< i (length string))
2183 (string-match ".\\([^\n]*\\)\n?" string i)
2184 (setq c (aref string i))
2186 (setq prompt (match-string 1 string)))
2187 (setq i (match-end 0))
2188 ;; We basically emulate just about everything that
2189 ;; `interactive' does, but add the specs listed above.
2193 (completing-read prompt obarray 'fboundp t))
2195 (read-buffer prompt (current-buffer) t))
2197 (read-buffer prompt (other-buffer (current-buffer))))
2201 (completing-read prompt obarray 'commandp t))
2205 (read-file-name prompt nil default-directory 'lambda))
2207 (read-file-name prompt nil nil 'lambda))
2209 (read-file-name prompt))
2211 (read-key-sequence prompt))
2213 (error "Not implemented spec"))
2215 (error "Not implemented spec"))
2219 (error "Not implemented spec"))
2221 (string-to-number (read-from-minibuffer prompt)))
2223 (prefix-numeric-value current-prefix-arg))
2229 (read-string prompt))
2231 (intern (read-string prompt)))
2233 (read-variable prompt))
2235 (read-minibuffer prompt))
2237 (eval-minibuffer prompt))
2238 ;; And here the new specs come.
2240 gnus-current-prefix-symbol)
2242 gnus-current-prefix-symbols)
2244 (gnus-group-group-name))
2246 (gnus-summary-skip-intangible)
2247 (or (get-text-property (point) 'gnus-number)
2248 (gnus-summary-last-subject)))
2250 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2252 (error "Non-implemented spec")))
2256 (push (if (< (point) (mark) (point) (mark))) out)
2257 (push (if (> (point) (mark) (point) (mark))) out))))
2258 (setq out (delq 'gnus-prefix-nil out))
2261 (defun gnus-symbolic-argument (&optional arg)
2262 "Read a symbolic argument and a command, and then execute command."
2264 (let* ((in-command (this-command-keys))
2265 (command in-command)
2266 gnus-current-prefix-symbols
2267 gnus-current-prefix-symbol
2269 (while (equal in-command command)
2270 (message "%s-" (key-description (this-command-keys)))
2271 (push (intern (char-to-string (read-char))) syms)
2272 (setq command (read-key-sequence nil t)))
2273 (setq gnus-current-prefix-symbols (nreverse syms)
2274 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2275 (call-interactively (key-binding command t))))
2277 ;;; More various functions.
2279 (defsubst gnus-check-backend-function (func group)
2280 "Check whether GROUP supports function FUNC.
2281 GROUP can either be a string (a group name) or a select method."
2283 (let ((method (if (stringp group)
2284 (car (gnus-find-method-for-group group))
2286 (unless (featurep method)
2288 (fboundp (intern (format "%s-%s" method func))))))
2290 (defun gnus-group-read-only-p (&optional group)
2291 "Check whether GROUP supports editing or not.
2292 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2293 that that variable is buffer-local to the summary buffers."
2294 (let ((group (or group gnus-newsgroup-name)))
2295 (not (gnus-check-backend-function 'request-replace-article group))))
2297 (defun gnus-group-total-expirable-p (group)
2298 "Check whether GROUP is total-expirable or not."
2299 (let ((params (gnus-group-find-parameter group))
2302 ((memq 'total-expire params)
2304 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2306 (gnus-total-expirable-newsgroups ; Check var.
2307 (string-match gnus-total-expirable-newsgroups group)))))
2309 (defun gnus-group-auto-expirable-p (group)
2310 "Check whether GROUP is auto-expirable or not."
2311 (let ((params (gnus-group-find-parameter group))
2314 ((memq 'auto-expire params)
2316 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2318 (gnus-auto-expirable-newsgroups ; Check var.
2319 (string-match gnus-auto-expirable-newsgroups group)))))
2321 (defun gnus-virtual-group-p (group)
2322 "Say whether GROUP is virtual or not."
2323 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2324 gnus-valid-select-methods)))
2326 (defun gnus-news-group-p (group &optional article)
2327 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2328 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2329 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2330 (eq (gnus-request-type group article) 'news))))
2332 ;; Returns a list of writable groups.
2333 (defun gnus-writable-groups ()
2334 (let ((alist gnus-newsrc-alist)
2336 (while (setq group (car (pop alist)))
2337 (unless (gnus-group-read-only-p group)
2338 (push group groups)))
2341 ;; Check whether to use long file names.
2342 (defun gnus-use-long-file-name (symbol)
2343 ;; The variable has to be set...
2344 (and gnus-use-long-file-name
2345 ;; If it isn't a list, then we return t.
2346 (or (not (listp gnus-use-long-file-name))
2347 ;; If it is a list, and the list contains `symbol', we
2349 (not (memq symbol gnus-use-long-file-name)))))
2351 ;; Generate a unique new group name.
2352 (defun gnus-generate-new-group-name (leaf)
2355 (while (gnus-gethash name gnus-newsrc-hashtb)
2356 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2359 (defun gnus-ephemeral-group-p (group)
2360 "Say whether GROUP is ephemeral or not."
2361 (gnus-group-get-parameter group 'quit-config t))
2363 (defun gnus-group-quit-config (group)
2364 "Return the quit-config of GROUP."
2365 (gnus-group-get-parameter group 'quit-config t))
2367 (defun gnus-kill-ephemeral-group (group)
2368 "Remove ephemeral GROUP from relevant structures."
2369 (gnus-sethash group nil gnus-newsrc-hashtb))
2371 (defun gnus-simplify-mode-line ()
2372 "Make mode lines a bit simpler."
2373 (setq mode-line-modified (cdr gnus-mode-line-modified))
2374 (when (listp mode-line-format)
2375 (make-local-variable 'mode-line-format)
2376 (setq mode-line-format (copy-sequence mode-line-format))
2377 (when (equal (nth 3 mode-line-format) " ")
2378 (setcar (nthcdr 3 mode-line-format) " "))))
2380 ;;; Servers and groups.
2382 (defsubst gnus-server-add-address (method)
2383 (let ((method-name (symbol-name (car method))))
2384 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2385 (not (assq (intern (concat method-name "-address")) method))
2386 (memq 'physical-address (assq (car method)
2387 gnus-valid-select-methods)))
2388 (append method (list (list (intern (concat method-name "-address"))
2392 (defsubst gnus-server-get-method (group method)
2393 ;; Input either a server name, and extended server name, or a
2394 ;; select method, and return a select method.
2395 (cond ((stringp method)
2396 (gnus-server-to-method method))
2397 ((equal method gnus-select-method)
2399 ((and (stringp (car method))
2401 (gnus-server-extend-method group method))
2404 (equal (cadr method) ""))
2407 (gnus-server-add-address method))))
2409 (defun gnus-server-to-method (server)
2410 "Map virtual server names to select methods."
2412 ;; Is this a method, perhaps?
2413 (and server (listp server) server)
2414 ;; Perhaps this is the native server?
2415 (and (equal server "native") gnus-select-method)
2416 ;; It should be in the server alist.
2417 (cdr (assoc server gnus-server-alist))
2418 ;; It could be in the predefined server alist.
2419 (cdr (assoc server gnus-predefined-server-alist))
2420 ;; If not, we look through all the opened server
2421 ;; to see whether we can find it there.
2422 (let ((opened gnus-opened-servers))
2424 (not (equal server (format "%s:%s" (caaar opened)
2428 ;; It could be a named method, search all servers
2429 (let ((servers gnus-secondary-select-methods))
2431 (not (equal server (format "%s:%s" (caar servers)
2436 (defmacro gnus-method-equal (ss1 ss2)
2437 "Say whether two servers are equal."
2441 (and (= (length s1) (length s2))
2443 (while (and s1 (member (car s1) s2))
2447 (defun gnus-server-equal (m1 m2)
2448 "Say whether two methods are equal."
2449 (let ((m1 (cond ((null m1) gnus-select-method)
2450 ((stringp m1) (gnus-server-to-method m1))
2452 (m2 (cond ((null m2) gnus-select-method)
2453 ((stringp m2) (gnus-server-to-method m2))
2455 (gnus-method-equal m1 m2)))
2457 (defun gnus-servers-using-backend (backend)
2458 "Return a list of known servers using BACKEND."
2459 (let ((opened gnus-opened-servers)
2462 (when (eq backend (caaar opened))
2463 (push (caar opened) out))
2467 (defun gnus-archive-server-wanted-p ()
2468 "Say whether the user wants to use the archive server."
2470 ((or (not gnus-message-archive-method)
2471 (not gnus-message-archive-group))
2473 ((and gnus-message-archive-method gnus-message-archive-group)
2476 (let ((active (cadr (assq 'nnfolder-active-file
2477 gnus-message-archive-method))))
2479 (file-exists-p active))))))
2481 (defun gnus-group-prefixed-name (group method)
2482 "Return the whole name from GROUP and METHOD."
2483 (and (stringp method) (setq method (gnus-server-to-method method)))
2484 (if (or (not method)
2485 (gnus-server-equal method "native"))
2487 (concat (format "%s" (car method))
2489 (or (assoc (format "%s" (car method))
2490 (gnus-methods-using 'address))
2491 (gnus-server-equal method gnus-message-archive-method))
2493 (not (string= (nth 1 method) "")))
2494 (concat "+" (nth 1 method)))
2497 (defun gnus-group-real-prefix (group)
2498 "Return the prefix of the current group name."
2499 (if (string-match "^[^:]+:" group)
2500 (substring group 0 (match-end 0))
2503 (defun gnus-group-method (group)
2504 "Return the server or method used for selecting GROUP.
2505 You should probably use `gnus-find-method-for-group' instead."
2506 (let ((prefix (gnus-group-real-prefix group)))
2507 (if (equal prefix "")
2509 (let ((servers gnus-opened-servers)
2511 backend possible found)
2512 (if (string-match "^[^\\+]+\\+" prefix)
2513 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2514 server (substring prefix (match-end 0) (1- (length prefix))))
2515 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2517 (when (eq (caaar servers) backend)
2518 (setq possible (caar servers))
2519 (when (equal (cadaar servers) server)
2520 (setq found (caar servers))))
2522 (or (car (rassoc found gnus-server-alist))
2524 (car (rassoc possible gnus-server-alist))
2526 (list backend server))))))
2528 (defsubst gnus-native-method-p (method)
2529 "Return whether METHOD is the native select method."
2530 (gnus-method-equal method gnus-select-method))
2532 (defsubst gnus-secondary-method-p (method)
2533 "Return whether METHOD is a secondary select method."
2534 (let ((methods gnus-secondary-select-methods)
2535 (gmethod (gnus-server-get-method nil method)))
2537 (not (gnus-method-equal
2538 (gnus-server-get-method nil (car methods))
2540 (setq methods (cdr methods)))
2543 (defun gnus-method-simplify (method)
2544 "Return the shortest uniquely identifying string or method for METHOD."
2545 (cond ((gnus-native-method-p method)
2547 ((gnus-secondary-method-p method)
2548 (format "%s:%s" (nth 0 method) (nth 1 method)))
2552 (defun gnus-groups-from-server (server)
2553 "Return a list of all groups that are fetched from SERVER."
2554 (let ((alist (cdr gnus-newsrc-alist))
2556 (while (setq info (pop alist))
2557 (when (gnus-server-equal (gnus-info-method info) server)
2558 (push (gnus-info-group info) groups)))
2559 (sort groups 'string<)))
2561 (defun gnus-group-foreign-p (group)
2562 "Say whether a group is foreign or not."
2563 (and (not (gnus-group-native-p group))
2564 (not (gnus-group-secondary-p group))))
2566 (defun gnus-group-native-p (group)
2567 "Say whether the group is native or not."
2568 (not (string-match ":" group)))
2570 (defun gnus-group-secondary-p (group)
2571 "Say whether the group is secondary or not."
2572 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2574 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2575 "Return the group parameters for GROUP.
2576 If SYMBOL, return the value of that symbol in the group parameters."
2578 (set-buffer gnus-group-buffer)
2579 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2581 (gnus-group-parameter-value parameters symbol allow-list)
2584 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2585 "Return the group parameters for GROUP.
2586 If SYMBOL, return the value of that symbol in the group parameters.
2587 Most functions should use `gnus-group-find-parameter', which
2588 also examines the topic parameters."
2589 (let ((params (gnus-info-params (gnus-get-info group))))
2591 (gnus-group-parameter-value params symbol allow-list)
2594 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2595 "Return the value of SYMBOL in group PARAMS."
2596 ;; We only wish to return group parameters (dotted lists) and
2597 ;; not local variables, which may have the same names.
2598 ;; But first we handle single elements...
2599 (or (car (memq symbol params))
2603 (while (setq elem (pop params))
2604 (when (and (consp elem)
2605 (eq (car elem) symbol)
2608 (throw 'found (cdr elem))))))))
2610 (defun gnus-group-add-parameter (group param)
2611 "Add parameter PARAM to GROUP."
2612 (let ((info (gnus-get-info group)))
2614 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2615 ;; Cons the new param to the old one and update.
2616 (gnus-group-set-info (cons param (gnus-info-params info))
2619 (defun gnus-group-set-parameter (group name value)
2620 "Set parameter NAME to VALUE in GROUP."
2621 (let ((info (gnus-get-info group)))
2623 (gnus-group-remove-parameter group name)
2624 (let ((old-params (gnus-info-params info))
2625 (new-params (list (cons name value))))
2627 (when (or (not (listp (car old-params)))
2628 (not (eq (caar old-params) name)))
2629 (setq new-params (append new-params (list (car old-params)))))
2630 (setq old-params (cdr old-params)))
2631 (gnus-group-set-info new-params group 'params)))))
2633 (defun gnus-group-remove-parameter (group name)
2634 "Remove parameter NAME from GROUP."
2635 (let ((info (gnus-get-info group)))
2637 (let ((params (gnus-info-params info)))
2639 (setq params (delq name params))
2640 (while (assq name params)
2641 (gnus-pull name params))
2642 (gnus-info-set-params info params))))))
2644 (defun gnus-group-add-score (group &optional score)
2645 "Add SCORE to the GROUP score.
2646 If SCORE is nil, add 1 to the score of GROUP."
2647 (let ((info (gnus-get-info group)))
2649 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2651 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2652 (defun gnus-short-group-name (group &optional levels)
2653 "Collapse GROUP name LEVELS.
2654 Select methods are stripped and any remote host name is stripped down to
2655 just the host name."
2662 (while (string-match "\\." group skip)
2663 (setq skip (match-end 0)
2666 ;; separate foreign select method from group name and collapse.
2667 ;; if method contains a server, collapse to non-domain server name,
2668 ;; otherwise collapse to select method
2669 (let* ((colon (string-match ":" group))
2670 (server (and colon (substring group 0 colon)))
2671 (plus (and server (string-match "+" server))))
2674 (setq foreign (substring server (+ 1 plus)
2675 (string-match "\\." server))
2676 group (substring group (+ 1 colon))))
2678 (setq foreign server
2679 group (substring group (+ 1 colon)))))
2680 (setq foreign (concat foreign ":"))))
2681 ;; collapse group name leaving LEVELS uncollapsed elements
2683 (if (and (string-match "\\." group) (> levels 0))
2684 (setq name (concat name (substring group 0 1))
2685 group (substring group (match-end 0))
2687 name (concat name "."))
2688 (setq name (concat foreign name group)
2692 (defun gnus-narrow-to-body ()
2693 "Narrow to the body of an article."
2696 (goto-char (point-min))
2697 (or (search-forward "\n\n" nil t)
2703 ;;; Kill file handling.
2706 (defun gnus-apply-kill-file ()
2707 "Apply a kill file to the current newsgroup.
2708 Returns the number of articles marked as read."
2709 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2710 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2711 (gnus-apply-kill-file-internal)
2714 (defun gnus-kill-save-kill-buffer ()
2715 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2716 (when (get-file-buffer file)
2718 (set-buffer (get-file-buffer file))
2719 (when (buffer-modified-p)
2721 (kill-buffer (current-buffer))))))
2723 (defcustom gnus-kill-file-name "KILL"
2724 "Suffix of the kill files."
2725 :group 'gnus-score-kill
2726 :group 'gnus-score-files
2729 (defun gnus-newsgroup-kill-file (newsgroup)
2730 "Return the name of a kill file name for NEWSGROUP.
2731 If NEWSGROUP is nil, return the global kill file name instead."
2733 ;; The global KILL file is placed at top of the directory.
2734 ((or (null newsgroup)
2735 (string-equal newsgroup ""))
2736 (expand-file-name gnus-kill-file-name
2737 gnus-kill-files-directory))
2738 ;; Append ".KILL" to newsgroup name.
2739 ((gnus-use-long-file-name 'not-kill)
2740 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2741 "." gnus-kill-file-name)
2742 gnus-kill-files-directory))
2743 ;; Place "KILL" under the hierarchical directory.
2745 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2746 "/" gnus-kill-file-name)
2747 gnus-kill-files-directory))))
2751 (defun gnus-member-of-valid (symbol group)
2752 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2754 (symbol-name (car (gnus-find-method-for-group group)))
2755 gnus-valid-select-methods)))
2757 (defun gnus-method-option-p (method option)
2758 "Return non-nil if select METHOD has OPTION as a parameter."
2759 (when (stringp method)
2760 (setq method (gnus-server-to-method method)))
2761 (memq option (assoc (format "%s" (car method))
2762 gnus-valid-select-methods)))
2764 (defun gnus-similar-server-opened (method)
2765 (let ((opened gnus-opened-servers))
2766 (while (and method opened)
2767 (when (and (equal (cadr method) (cadaar opened))
2768 (equal (car method) (caaar opened))
2769 (not (equal method (caar opened))))
2774 (defun gnus-server-extend-method (group method)
2775 ;; This function "extends" a virtual server. If the server is
2776 ;; "hello", and the select method is ("hello" (my-var "something"))
2777 ;; in the group "alt.alt", this will result in a new virtual server
2778 ;; called "hello+alt.alt".
2779 (if (or (not (inline (gnus-similar-server-opened method)))
2780 (not (cddr method)))
2782 `(,(car method) ,(concat (cadr method) "+" group)
2783 (,(intern (format "%s-address" (car method))) ,(cadr method))
2786 (defun gnus-server-status (method)
2787 "Return the status of METHOD."
2788 (nth 1 (assoc method gnus-opened-servers)))
2790 (defun gnus-group-name-to-method (group)
2791 "Guess a select method based on GROUP."
2792 (if (string-match ":" group)
2793 (let ((server (substring group 0 (match-beginning 0))))
2794 (if (string-match "\\+" server)
2795 (list (intern (substring server 0 (match-beginning 0)))
2796 (substring server (match-end 0)))
2797 (list (intern server) "")))
2798 gnus-select-method))
2800 (defun gnus-find-method-for-group (group &optional info)
2801 "Find the select method that GROUP uses."
2802 (or gnus-override-method
2805 (let ((info (or info (gnus-get-info group)))
2808 (not (setq method (gnus-info-method info)))
2809 (equal method "native"))
2812 (cond ((stringp method)
2813 (inline (gnus-server-to-method method)))
2814 ((stringp (cadr method))
2815 (inline (gnus-server-extend-method group method)))
2818 (cond ((equal (cadr method) "")
2820 ((null (cadr method))
2821 (list (car method) ""))
2823 (gnus-server-add-address method)))))))
2825 (defun gnus-methods-using (feature)
2826 "Find all methods that have FEATURE."
2827 (let ((valids gnus-valid-select-methods)
2830 (when (memq feature (car valids))
2831 (push (car valids) outs))
2832 (setq valids (cdr valids)))
2835 (defun gnus-read-group (prompt &optional default)
2836 "Prompt the user for a group name.
2837 Disallow invalid group names."
2843 (setq group (read-string (concat prefix prompt)
2844 (cons (or default "") 0)
2845 'gnus-group-history)))
2846 (setq prefix (format "Invalid group name: \"%s\". " group)
2850 (defun gnus-read-method (prompt)
2851 "Prompt the user for a method.
2852 Allow completion over sensible values."
2854 (append gnus-valid-select-methods
2855 gnus-predefined-server-alist
2860 nil t nil 'gnus-method-history)))
2863 (setq method gnus-select-method))
2864 ((assoc method gnus-valid-select-methods)
2865 (list (intern method)
2866 (if (memq 'prompt-address
2867 (assoc method gnus-valid-select-methods))
2868 (read-string "Address: ")
2870 ((assoc method servers)
2873 (list (intern method) "")))))
2875 ;;; User-level commands.
2878 (defun gnus-slave-no-server (&optional arg)
2879 "Read network news as a slave, without connecting to local server."
2881 (gnus-no-server arg t))
2884 (defun gnus-no-server (&optional arg slave)
2886 If ARG is a positive number, Gnus will use that as the
2887 startup level. If ARG is nil, Gnus will be started at level 2.
2888 If ARG is non-nil and not a positive number, Gnus will
2889 prompt the user for the name of an NNTP server to use.
2890 As opposed to `gnus', this command will not connect to the local server."
2892 (gnus-no-server-1 arg slave))
2895 (defun gnus-slave (&optional arg)
2896 "Read news as a slave."
2898 (gnus arg nil 'slave))
2901 (defun gnus-other-frame (&optional arg)
2902 "Pop up a frame to read news."
2904 (let ((window (get-buffer-window gnus-group-buffer)))
2906 (select-frame (window-frame window)))
2907 ((= (length (frame-list)) 1)
2908 (select-frame (make-frame)))
2914 (defun gnus (&optional arg dont-connect slave)
2916 If ARG is non-nil and a positive number, Gnus will use that as the
2917 startup level. If ARG is non-nil and not a positive number, Gnus will
2918 prompt the user for the name of an NNTP server to use."
2920 (gnus-1 arg dont-connect slave))
2922 ;; Allow redefinition of Gnus functions.
2928 ;;; gnus.el ends here