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.040"
263 "Version number for this version of gnus.")
265 (defconst gnus-original-version-number "0.54"
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.11, FLIM 1.12)"
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-decode-rfc1522 'ignore))
311 ;; We define these group faces here to avoid the display
312 ;; update forced when creating new faces.
314 (defface gnus-group-news-1-face
317 (:foreground "PaleTurquoise" :bold t))
320 (:foreground "ForestGreen" :bold t))
323 "Level 1 newsgroup face.")
325 (defface gnus-group-news-1-empty-face
328 (:foreground "PaleTurquoise"))
331 (:foreground "ForestGreen"))
334 "Level 1 empty newsgroup face.")
336 (defface gnus-group-news-2-face
339 (:foreground "turquoise" :bold t))
342 (:foreground "CadetBlue4" :bold t))
345 "Level 2 newsgroup face.")
347 (defface gnus-group-news-2-empty-face
350 (:foreground "turquoise"))
353 (:foreground "CadetBlue4"))
356 "Level 2 empty newsgroup face.")
358 (defface gnus-group-news-3-face
367 "Level 3 newsgroup face.")
369 (defface gnus-group-news-3-empty-face
378 "Level 3 empty newsgroup face.")
380 (defface gnus-group-news-4-face
389 "Level 4 newsgroup face.")
391 (defface gnus-group-news-4-empty-face
400 "Level 4 empty newsgroup face.")
402 (defface gnus-group-news-5-face
411 "Level 5 newsgroup face.")
413 (defface gnus-group-news-5-empty-face
422 "Level 5 empty newsgroup face.")
424 (defface gnus-group-news-6-face
433 "Level 6 newsgroup face.")
435 (defface gnus-group-news-6-empty-face
444 "Level 6 empty newsgroup face.")
446 (defface gnus-group-news-low-face
449 (:foreground "DarkTurquoise" :bold t))
452 (:foreground "DarkGreen" :bold t))
455 "Low level newsgroup face.")
457 (defface gnus-group-news-low-empty-face
460 (:foreground "DarkTurquoise"))
463 (:foreground "DarkGreen"))
466 "Low level empty newsgroup face.")
468 (defface gnus-group-mail-1-face
471 (:foreground "aquamarine1" :bold t))
474 (:foreground "DeepPink3" :bold t))
477 "Level 1 mailgroup face.")
479 (defface gnus-group-mail-1-empty-face
482 (:foreground "aquamarine1"))
485 (:foreground "DeepPink3"))
487 (:italic t :bold t)))
488 "Level 1 empty mailgroup face.")
490 (defface gnus-group-mail-2-face
493 (:foreground "aquamarine2" :bold t))
496 (:foreground "HotPink3" :bold t))
499 "Level 2 mailgroup face.")
501 (defface gnus-group-mail-2-empty-face
504 (:foreground "aquamarine2"))
507 (:foreground "HotPink3"))
510 "Level 2 empty mailgroup face.")
512 (defface gnus-group-mail-3-face
515 (:foreground "aquamarine3" :bold t))
518 (:foreground "magenta4" :bold t))
521 "Level 3 mailgroup face.")
523 (defface gnus-group-mail-3-empty-face
526 (:foreground "aquamarine3"))
529 (:foreground "magenta4"))
532 "Level 3 empty mailgroup face.")
534 (defface gnus-group-mail-low-face
537 (:foreground "aquamarine4" :bold t))
540 (:foreground "DeepPink4" :bold t))
543 "Low level mailgroup face.")
545 (defface gnus-group-mail-low-empty-face
548 (:foreground "aquamarine4"))
551 (:foreground "DeepPink4"))
554 "Low level empty mailgroup face.")
556 ;; Summary mode faces.
558 (defface gnus-summary-selected-face '((t
560 "Face used for selected articles.")
562 (defface gnus-summary-cancelled-face
564 (:foreground "yellow" :background "black")))
565 "Face used for cancelled articles.")
567 (defface gnus-summary-high-ticked-face
570 (:foreground "pink" :bold t))
573 (:foreground "firebrick" :bold t))
576 "Face used for high interest ticked articles.")
578 (defface gnus-summary-low-ticked-face
581 (:foreground "pink" :italic t))
584 (:foreground "firebrick" :italic t))
587 "Face used for low interest ticked articles.")
589 (defface gnus-summary-normal-ticked-face
592 (:foreground "pink"))
595 (:foreground "firebrick"))
598 "Face used for normal interest ticked articles.")
600 (defface gnus-summary-high-ancient-face
603 (:foreground "SkyBlue" :bold t))
606 (:foreground "RoyalBlue" :bold t))
609 "Face used for high interest ancient articles.")
611 (defface gnus-summary-low-ancient-face
614 (:foreground "SkyBlue" :italic t))
617 (:foreground "RoyalBlue" :italic t))
620 "Face used for low interest ancient articles.")
622 (defface gnus-summary-normal-ancient-face
625 (:foreground "SkyBlue"))
628 (:foreground "RoyalBlue"))
631 "Face used for normal interest ancient articles.")
633 (defface gnus-summary-high-unread-face
636 "Face used for high interest unread articles.")
638 (defface gnus-summary-low-unread-face
641 "Face used for low interest unread articles.")
643 (defface gnus-summary-normal-unread-face
646 "Face used for normal interest unread articles.")
648 (defface gnus-summary-high-read-face
651 (:foreground "PaleGreen"
655 (:foreground "DarkGreen"
659 "Face used for high interest read articles.")
661 (defface gnus-summary-low-read-face
664 (:foreground "PaleGreen"
668 (:foreground "DarkGreen"
672 "Face used for low interest read articles.")
674 (defface gnus-summary-normal-read-face
677 (:foreground "PaleGreen"))
680 (:foreground "DarkGreen"))
683 "Face used for normal interest read articles.")
690 (defvar gnus-buffers nil)
692 (defun gnus-get-buffer-create (name)
693 "Do the same as `get-buffer-create', but store the created buffer."
694 (or (get-buffer name)
695 (car (push (get-buffer-create name) gnus-buffers))))
697 (defun gnus-add-buffer ()
698 "Add the current buffer to the list of Gnus buffers."
699 (push (current-buffer) gnus-buffers))
701 (defun gnus-buffers ()
702 "Return a list of live Gnus buffers."
703 (while (and gnus-buffers
704 (not (buffer-name (car gnus-buffers))))
706 (let ((buffers gnus-buffers))
708 (if (buffer-name (cadr buffers))
710 (setcdr buffers (cddr buffers)))))
715 (defvar gnus-group-buffer "*Group*")
718 (autoload 'gnus-play-jingle "gnus-audio"))
720 (defface gnus-splash-face
723 (:foreground "Brown"))
726 (:foreground "Brown"))
729 "Face of the splash screen.")
731 (defun gnus-splash ()
733 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
734 (let ((buffer-read-only nil))
736 (unless gnus-inhibit-startup-message
737 (gnus-group-startup-message)
739 (when gnus-play-startup-jingle
740 (gnus-play-jingle))))))
742 (defun gnus-indent-rigidly (start end arg)
743 "Indent rigidly using only spaces and no tabs."
746 (narrow-to-region start end)
748 (indent-rigidly start end arg)
749 ;; We translate tabs into spaces -- not everybody uses
750 ;; an 8-character tab.
751 (goto-char (point-min))
752 (while (search-forward "\t" nil t)
753 (replace-match " " t t))))))
755 (defvar gnus-simple-splash nil)
757 (defun gnus-group-startup-message (&optional x y)
758 "Insert startup message in current buffer."
759 ;; Insert the message.
764 _ ___ __ ___ __ _ ___
784 (gnus-indent-rigidly (point-min) (point-max)
785 (/ (max (- (window-width) (or x 46)) 0) 2))
786 (goto-char (point-min))
788 (let* ((pheight (count-lines (point-min) (point-max)))
789 (wheight (window-height))
790 (rest (- wheight pheight)))
791 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
793 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
794 (goto-char (point-min))
795 (setq mode-line-buffer-identification (concat " " gnus-version))
796 (setq gnus-simple-splash t)
797 (set-buffer-modified-p t))
800 (let ((command (format "%s" this-command)))
801 (if (and (string-match "gnus" command)
802 (not (string-match "gnus-other-frame" command)))
804 (gnus-get-buffer-create gnus-group-buffer))))
812 (defcustom gnus-home-directory "~/"
813 "Directory variable that specifies the \"home\" directory.
814 All other Gnus path variables are initialized from this variable."
818 (defcustom gnus-directory (or (getenv "SAVEDIR")
819 (nnheader-concat gnus-home-directory "News/"))
820 "*Directory variable from which all other Gnus file variables are derived.
822 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
823 This means that other directory variables that are initialized from
824 this variable won't be set properly if you set this variable in `.gnus.el'.
825 Set this variable in `.emacs' instead."
829 (defcustom gnus-default-directory nil
830 "*Default directory for all Gnus buffers."
832 :type '(choice (const :tag "current" nil)
835 ;; Site dependent variables. These variables should be defined in
838 (defvar gnus-default-nntp-server nil
839 "Specify a default NNTP server.
840 This variable should be defined in paths.el, and should never be set
842 If you want to change servers, you should use `gnus-select-method'.
843 See the documentation to that variable.")
845 ;; Don't touch this variable.
846 (defvar gnus-nntp-service "nntp"
847 "NNTP service name (\"nntp\" or 119).
848 This is an obsolete variable, which is scarcely used. If you use an
849 nntp server for your newsgroup and want to change the port number
850 used to 899, you would say something along these lines:
852 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
854 (defcustom gnus-nntpserver-file "/etc/nntpserver"
855 "A file with only the name of the nntp server in it."
860 ;; This function is used to check both the environment variable
861 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
862 ;; an nntp server name default.
863 (defun gnus-getenv-nntpserver ()
864 (or (getenv "NNTPSERVER")
865 (and (file-readable-p gnus-nntpserver-file)
867 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
868 (insert-file-contents gnus-nntpserver-file)
869 (let ((name (buffer-string)))
871 (if (string-match "^[ \t\n]*$" name)
874 (kill-buffer (current-buffer))))))))
876 (defcustom gnus-select-method
879 (list 'nntp (or (condition-case nil
880 (gnus-getenv-nntpserver)
882 (when (and gnus-default-nntp-server
883 (not (string= gnus-default-nntp-server "")))
884 gnus-default-nntp-server)
886 (if (or (null gnus-nntp-service)
887 (equal gnus-nntp-service "nntp"))
889 (list gnus-nntp-service)))
891 "*Default method for selecting a newsgroup.
892 This variable should be a list, where the first element is how the
893 news is to be fetched, the second is the address.
895 For instance, if you want to get your news via NNTP from
896 \"flab.flab.edu\", you could say:
898 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
900 If you want to use your local spool, say:
902 \(setq gnus-select-method (list 'nnspool (system-name)))
904 If you use this variable, you must set `gnus-nntp-server' to nil.
906 There is a lot more to know about select methods and virtual servers -
907 see the manual for details."
909 :type 'gnus-select-method)
911 (defcustom gnus-message-archive-method
914 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
915 (nnfolder-active-file
916 ,(nnheader-concat message-directory "archive/active"))
917 (nnfolder-get-new-mail nil)
918 (nnfolder-inhibit-expiry t))
919 "*Method used for archiving messages you've sent.
920 This should be a mail method.
922 It's probably not a very effective to change this variable once you've
923 run Gnus once. After doing that, you must edit this server from the
927 :type 'gnus-select-method)
929 (defcustom gnus-message-archive-group nil
930 "*Name of the group in which to save the messages you've written.
931 This can either be a string; a list of strings; or an alist
932 of regexps/functions/forms to be evaluated to return a string (or a list
933 of strings). The functions are called with the name of the current
934 group (or nil) as a parameter.
936 If you want to save your mail in one group and the news articles you
937 write in another group, you could say something like:
939 \(setq gnus-message-archive-group
940 '((if (message-news-p)
944 Normally the group names returned by this variable should be
945 unprefixed -- which implicitly means \"store on the archive server\".
946 However, you may wish to store the message on some other server. In
947 that case, just return a fully prefixed name of the group --
948 \"nnml+private:mail.misc\", for instance."
950 :type '(choice (const :tag "none" nil)
955 (defcustom gnus-secondary-servers nil
956 "List of NNTP servers that the user can choose between interactively.
957 To make Gnus query you for a server, you have to give `gnus' a
958 non-numeric prefix - `C-u M-x gnus', in short."
960 :type '(repeat string))
962 (defcustom gnus-nntp-server nil
963 "*The name of the host running the NNTP server.
964 This variable is semi-obsolete. Use the `gnus-select-method'
967 :type '(choice (const :tag "disable" nil)
970 (defcustom gnus-secondary-select-methods nil
971 "A list of secondary methods that will be used for reading news.
972 This is a list where each element is a complete select method (see
973 `gnus-select-method').
975 If, for instance, you want to read your mail with the nnml backend,
976 you could set this variable:
978 \(setq gnus-secondary-select-methods '((nnml \"\")))"
980 :type '(repeat gnus-select-method))
982 (defvar gnus-backup-default-subscribed-newsgroups
983 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
984 "Default default new newsgroups the first time Gnus is run.
985 Should be set in paths.el, and shouldn't be touched by the user.")
987 (defcustom gnus-local-domain nil
988 "Local domain name without a host name.
989 The DOMAINNAME environment variable is used instead if it is defined.
990 If the `system-name' function returns the full Internet name, there is
991 no need to set this variable."
993 :type '(choice (const :tag "default" nil)
996 (defvar gnus-local-organization nil
997 "String with a description of what organization (if any) the user belongs to.
998 Obsolete variable; use `message-user-organization' instead.")
1000 ;; Customization variables
1002 (defcustom gnus-refer-article-method nil
1003 "Preferred method for fetching an article by Message-ID.
1004 If you are reading news from the local spool (with nnspool), fetching
1005 articles by Message-ID is painfully slow. By setting this method to an
1006 nntp method, you might get acceptable results.
1008 The value of this variable must be a valid select method as discussed
1009 in the documentation of `gnus-select-method'."
1011 :type '(choice (const :tag "default" nil)
1012 gnus-select-method))
1014 (defcustom gnus-group-faq-directory
1015 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1016 "/ftp@sunsite.auc.dk:/pub/usenet/"
1017 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1018 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1019 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1020 "/ftp@rtfm.mit.edu:/pub/usenet/"
1021 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1022 "/ftp@ftp.sunet.se:/pub/usenet/"
1023 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1024 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1025 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1026 "*Directory where the group FAQs are stored.
1027 This will most commonly be on a remote machine, and the file will be
1028 fetched by ange-ftp.
1030 This variable can also be a list of directories. In that case, the
1031 first element in the list will be used by default. The others can
1032 be used when being prompted for a site.
1034 Note that Gnus uses an aol machine as the default directory. If this
1035 feels fundamentally unclean, just think of it as a way to finally get
1036 something of value back from them.
1038 If the default site is too slow, try one of these:
1040 North America: mirrors.aol.com /pub/rtfm/usenet
1041 ftp.seas.gwu.edu /pub/rtfm
1042 rtfm.mit.edu /pub/usenet
1043 Europe: ftp.uni-paderborn.de /pub/FAQ
1044 src.doc.ic.ac.uk /usenet/news-FAQS
1045 ftp.sunet.se /pub/usenet
1046 sunsite.auc.dk /pub/usenet
1047 Asia: nctuccca.edu.tw /USENET/FAQ
1048 hwarang.postech.ac.kr /pub/usenet
1049 ftp.hk.super.net /mirror/faqs"
1050 :group 'gnus-group-various
1051 :type '(choice directory
1052 (repeat directory)))
1054 (defcustom gnus-use-cross-reference t
1055 "*Non-nil means that cross referenced articles will be marked as read.
1056 If nil, ignore cross references. If t, mark articles as read in
1057 subscribed newsgroups. If neither t nor nil, mark as read in all
1060 :type '(choice (const :tag "off" nil)
1061 (const :tag "subscribed" t)
1065 (defcustom gnus-process-mark ?#
1067 :group 'gnus-group-visual
1068 :group 'gnus-summary-marks
1071 (defcustom gnus-asynchronous nil
1072 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1073 :group 'gnus-asynchronous
1076 (defcustom gnus-large-newsgroup 200
1077 "*The number of articles which indicates a large newsgroup.
1078 If the number of articles in a newsgroup is greater than this value,
1079 confirmation is required for selecting the newsgroup."
1080 :group 'gnus-group-select
1083 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1084 "*Non-nil means that the default name of a file to save articles in is the group name.
1085 If it's nil, the directory form of the group name is used instead.
1087 If this variable is a list, and the list contains the element
1088 `not-score', long file names will not be used for score files; if it
1089 contains the element `not-save', long file names will not be used for
1090 saving; and if it contains the element `not-kill', long file names
1091 will not be used for kill files.
1093 Note that the default for this variable varies according to what system
1094 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1095 to nil while on all other systems it defaults to t."
1099 (defcustom gnus-kill-files-directory gnus-directory
1100 "*Name of the directory where kill files will be stored (default \"~/News\")."
1101 :group 'gnus-score-files
1102 :group 'gnus-score-kill
1105 (defcustom gnus-save-score nil
1106 "*If non-nil, save group scoring info."
1107 :group 'gnus-score-various
1111 (defcustom gnus-use-undo t
1112 "*If non-nil, allow undoing in Gnus group mode buffers."
1116 (defcustom gnus-use-adaptive-scoring nil
1117 "*If non-nil, use some adaptive scoring scheme.
1118 If a list, then the values `word' and `line' are meaningful. The
1119 former will perform adaption on individual words in the subject
1120 header while `line' will perform adaption on several headers."
1122 :group 'gnus-score-adapt
1123 :type '(set (const word) (const line)))
1125 (defcustom gnus-use-cache 'passive
1126 "*If nil, Gnus will ignore the article cache.
1127 If `passive', it will allow entering (and reading) articles
1128 explicitly entered into the cache. If anything else, use the
1129 cache to the full extent of the law."
1132 :type '(choice (const :tag "off" nil)
1133 (const :tag "passive" passive)
1134 (const :tag "active" t)))
1136 (defcustom gnus-use-trees nil
1137 "*If non-nil, display a thread tree buffer."
1141 (defcustom gnus-use-grouplens nil
1142 "*If non-nil, use GroupLens ratings."
1146 (defcustom gnus-keep-backlog nil
1147 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1148 If it is a number N, then Gnus will only keep the last N articles
1149 read. If it is neither nil nor a number, Gnus will keep all read
1150 articles. This is not a good idea."
1152 :type '(choice (const :tag "off" nil)
1157 (defcustom gnus-use-nocem nil
1158 "*If non-nil, Gnus will read NoCeM cancel messages."
1162 (defcustom gnus-suppress-duplicates nil
1163 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1167 (defcustom gnus-use-demon nil
1168 "If non-nil, Gnus might use some demons."
1172 (defcustom gnus-use-scoring t
1173 "*If non-nil, enable scoring."
1177 (defcustom gnus-use-picons nil
1178 "*If non-nil, display picons."
1182 (defcustom gnus-summary-prepare-exit-hook
1183 '(gnus-summary-expire-articles)
1184 "*A hook called when preparing to exit from the summary buffer.
1185 It calls `gnus-summary-expire-articles' by default."
1186 :group 'gnus-summary-exit
1189 (defcustom gnus-novice-user t
1190 "*Non-nil means that you are a usenet novice.
1191 If non-nil, verbose messages may be displayed and confirmations may be
1196 (defcustom gnus-expert-user nil
1197 "*Non-nil means that you will never be asked for confirmation about anything.
1198 That doesn't mean *anything* anything; particularly destructive
1199 commands will still require prompting."
1203 (defcustom gnus-interactive-catchup t
1204 "*If non-nil, require your confirmation when catching up a group."
1205 :group 'gnus-group-select
1208 (defcustom gnus-interactive-exit t
1209 "*If non-nil, require your confirmation when exiting Gnus."
1213 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1214 "*Function for extracting address components from a From header.
1215 Two pre-defined function exist: `gnus-extract-address-components',
1216 which is the default, quite fast, and too simplistic solution, and
1217 `mail-extract-address-components', which works much better, but is
1219 :group 'gnus-summary-format
1220 :type '(radio (function-item gnus-extract-address-components)
1221 (function-item mail-extract-address-components)
1222 (function-item std11-extract-address-components)
1223 (function :tag "Other")))
1225 (defcustom gnus-carpal nil
1226 "*If non-nil, display clickable icons."
1230 (defcustom gnus-shell-command-separator ";"
1231 "String used to separate to shell commands."
1235 (defcustom gnus-valid-select-methods
1236 '(("nntp" post address prompt-address physical-address)
1237 ("nnspool" post address)
1238 ("nnvirtual" post-mail virtual prompt-address)
1239 ("nnmbox" mail respool address)
1240 ("nnml" mail respool address)
1241 ("nnmh" mail respool address)
1242 ("nndir" post-mail prompt-address physical-address)
1243 ("nneething" none address prompt-address physical-address)
1244 ("nndoc" none address prompt-address)
1245 ("nnbabyl" mail address respool)
1246 ("nnkiboze" post virtual)
1247 ("nnsoup" post-mail address)
1248 ("nndraft" post-mail)
1249 ("nnfolder" mail respool address)
1250 ("nngateway" post-mail address prompt-address physical-address)
1253 ("nnagent" post-mail))
1254 "*An alist of valid select methods.
1255 The first element of each list lists should be a string with the name
1256 of the select method. The other elements may be the category of
1257 this method (i. e., `post', `mail', `none' or whatever) or other
1258 properties that this method has (like being respoolable).
1259 If you implement a new select method, all you should have to change is
1260 this variable. I think."
1262 :type '(repeat (group (string :tag "Name")
1263 (radio-button-choice (const :format "%v " post)
1264 (const :format "%v " mail)
1265 (const :format "%v " none)
1267 (checklist :inline t
1268 (const :format "%v " address)
1269 (const :format "%v " prompt-address)
1270 (const :format "%v " physical-address)
1271 (const :format "%v " virtual)
1274 (define-widget 'gnus-select-method 'list
1275 "Widget for entering a select method."
1276 :args `((choice :tag "Method"
1277 ,@(mapcar (lambda (entry)
1278 (list 'const :format "%v\n"
1279 (intern (car entry))))
1280 gnus-valid-select-methods))
1281 (string :tag "Address")
1282 (editable-list :inline t
1285 (sexp :tag "Value")))))
1287 (defcustom gnus-updated-mode-lines '(group article summary tree)
1288 "List of buffers that should update their mode lines.
1289 The list may contain the symbols `group', `article', `tree' and
1290 `summary'. If the corresponding symbol is present, Gnus will keep
1291 that mode line updated with information that may be pertinent.
1292 If this variable is nil, screen refresh may be quicker."
1293 :group 'gnus-various
1294 :type '(set (const group)
1299 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1300 (defcustom gnus-mode-non-string-length nil
1301 "*Max length of mode-line non-string contents.
1302 If this is nil, Gnus will take space as is needed, leaving the rest
1303 of the modeline intact. Note that the default of nil is unlikely
1304 to be desirable; see the manual for further details."
1305 :group 'gnus-various
1306 :type '(choice (const nil)
1309 (defcustom gnus-auto-expirable-newsgroups nil
1310 "*Groups in which to automatically mark read articles as expirable.
1311 If non-nil, this should be a regexp that should match all groups in
1312 which to perform auto-expiry. This only makes sense for mail groups."
1313 :group 'nnmail-expire
1314 :type '(choice (const nil)
1317 (defcustom gnus-total-expirable-newsgroups nil
1318 "*Groups in which to perform expiry of all read articles.
1319 Use with extreme caution. All groups that match this regexp will be
1320 expiring - which means that all read articles will be deleted after
1321 \(say) one week. (This only goes for mail groups and the like, of
1323 :group 'nnmail-expire
1324 :type '(choice (const nil)
1327 (defcustom gnus-group-uncollapsed-levels 1
1328 "Number of group name elements to leave alone when making a short group name."
1329 :group 'gnus-group-visual
1332 (defcustom gnus-group-use-permanent-levels nil
1333 "*If non-nil, once you set a level, Gnus will use this level."
1334 :group 'gnus-group-levels
1339 (defcustom gnus-load-hook nil
1340 "A hook run while Gnus is loaded."
1344 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1345 "A hook called to apply kill files to a group.
1346 This hook is intended to apply a kill file to the selected newsgroup.
1347 The function `gnus-apply-kill-file' is called by default.
1349 Since a general kill file is too heavy to use only for a few
1350 newsgroups, I recommend you to use a lighter hook function. For
1351 example, if you'd like to apply a kill file to articles which contains
1352 a string `rmgroup' in subject in newsgroup `control', you can use the
1355 (setq gnus-apply-kill-hook
1358 (cond ((string-match \"control\" gnus-newsgroup-name)
1359 (gnus-kill \"Subject\" \"rmgroup\")
1360 (gnus-expunge \"X\"))))))"
1361 :group 'gnus-score-kill
1362 :options '(gnus-apply-kill-file)
1365 (defcustom gnus-group-change-level-function nil
1366 "Function run when a group level is changed.
1367 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1368 :group 'gnus-group-level
1373 (defcustom gnus-visual
1374 '(summary-highlight group-highlight article-highlight
1376 summary-menu group-menu article-menu
1377 tree-highlight menu highlight
1378 browse-menu server-menu
1379 page-marker tree-menu binary-menu pick-menu
1381 "*Enable visual features.
1382 If `visual' is disabled, there will be no menus and few faces. Most of
1383 the visual customization options below will be ignored. Gnus will use
1384 less space and be faster as a result.
1386 This variable can also be a list of visual elements to switch on. For
1387 instance, to switch off all visual things except menus, you can say:
1389 (setq gnus-visual '(menu))
1391 Valid elements include `summary-highlight', `group-highlight',
1392 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1393 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1394 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1395 and `grouplens-menu'."
1398 :type '(set (const summary-highlight)
1399 (const group-highlight)
1400 (const article-highlight)
1402 (const summary-menu)
1404 (const article-menu)
1405 (const tree-highlight)
1414 (const grouplens-menu)))
1416 (defcustom gnus-mouse-face
1418 (if (gnus-visual-p 'mouse-face 'highlight)
1419 (if (boundp 'gnus-mouse-face)
1420 (or gnus-mouse-face 'highlight)
1424 "*Face used for group or summary buffer mouse highlighting.
1425 The line beneath the mouse pointer will be highlighted with this
1430 (defcustom gnus-article-display-hook
1431 (if (and (string-match "XEmacs" emacs-version)
1433 '(gnus-article-hide-headers-if-wanted
1434 gnus-article-hide-boring-headers
1435 gnus-article-treat-overstrike
1436 gnus-article-maybe-highlight
1437 gnus-article-display-x-face)
1438 '(gnus-article-hide-headers-if-wanted
1439 gnus-article-hide-boring-headers
1440 gnus-article-treat-overstrike
1441 gnus-article-maybe-highlight))
1442 "*Controls how the article buffer will look.
1444 If you leave the list empty, the article will appear exactly as it is
1445 stored on the disk. The list entries will hide or highlight various
1446 parts of the article, making it easier to find the information you
1448 :group 'gnus-article-highlight
1451 :options '(gnus-article-add-buttons
1452 gnus-article-add-buttons-to-head
1453 gnus-article-emphasize
1454 gnus-article-fill-cited-article
1455 gnus-article-remove-cr
1456 gnus-summary-stop-page-breaking
1457 ;; gnus-summary-caesar-message
1458 ;; gnus-summary-verbose-headers
1459 gnus-summary-toggle-mime
1461 gnus-article-hide-headers
1462 gnus-article-hide-boring-headers
1463 gnus-article-hide-signature
1464 gnus-article-hide-citation
1465 gnus-article-hide-pgp
1466 gnus-article-hide-pem
1467 gnus-article-highlight
1468 gnus-article-highlight-headers
1469 gnus-article-highlight-citation
1470 gnus-article-highlight-signature
1471 gnus-article-date-ut
1472 gnus-article-date-local
1473 gnus-article-date-lapsed
1474 gnus-article-date-original
1475 gnus-article-remove-trailing-blank-lines
1476 gnus-article-strip-leading-blank-lines
1477 gnus-article-strip-multiple-blank-lines
1478 gnus-article-strip-blank-lines
1479 gnus-article-treat-overstrike
1480 gnus-article-display-x-face
1481 gnus-smiley-display))
1483 (defcustom gnus-article-save-directory gnus-directory
1484 "*Name of the directory articles will be saved in (default \"~/News\")."
1485 :group 'gnus-article-saving
1488 (defvar gnus-plugged t
1489 "Whether Gnus is plugged or not.")
1492 ;;; Internal variables
1494 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1495 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1496 (defvar gnus-original-article-buffer " *Original Article*")
1497 (defvar gnus-newsgroup-name nil)
1498 (defvar gnus-ephemeral-servers nil)
1500 (defvar gnus-agent nil
1501 "Whether we want to use the Gnus agent or not.")
1503 (defvar gnus-command-method nil
1504 "Dynamically bound variable that says what the current backend is.")
1506 (defvar gnus-current-select-method nil
1507 "The current method for selecting a newsgroup.")
1509 (defvar gnus-tree-buffer "*Tree*"
1510 "Buffer where Gnus thread trees are displayed.")
1513 (defvar gnus-use-generic-from nil)
1515 ;; Variable holding the user answers to all method prompts.
1516 (defvar gnus-method-history nil)
1518 ;; Variable holding the user answers to all mail method prompts.
1519 (defvar gnus-mail-method-history nil)
1521 ;; Variable holding the user answers to all group prompts.
1522 (defvar gnus-group-history nil)
1524 (defvar gnus-server-alist nil
1525 "List of available servers.")
1527 (defcustom gnus-cache-directory
1528 (nnheader-concat gnus-directory "cache/")
1529 "*The directory where cached articles will be stored."
1533 (defvar gnus-predefined-server-alist
1536 (nnspool-spool-directory ,gnus-cache-directory)
1537 (nnspool-nov-directory ,gnus-cache-directory)
1538 (nnspool-active-file
1539 ,(nnheader-concat gnus-cache-directory "active"))))
1540 "List of predefined (convenience) servers.")
1542 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1544 (defconst gnus-article-mark-lists
1545 '((marked . tick) (replied . reply)
1546 (expirable . expire) (killed . killed)
1547 (bookmarks . bookmark) (dormant . dormant)
1548 (scored . score) (saved . save)
1549 (cached . cache) (downloadable . download)
1550 (unsendable . unsend)))
1552 (defvar gnus-headers-retrieved-by nil)
1553 (defvar gnus-article-reply nil)
1554 (defvar gnus-override-method nil)
1555 (defvar gnus-article-check-size nil)
1556 (defvar gnus-opened-servers nil)
1558 (defvar gnus-current-kill-article nil)
1560 (defvar gnus-have-read-active-file nil)
1562 (defconst gnus-maintainer
1563 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1564 "The mail address of the Gnus maintainers.")
1566 (defconst semi-gnus-developers
1567 "Semi-gnus Developers:
1568 semi-gnus-en@meadow.scphys.kyoto-u.ac.jp (In English),\
1569 semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (In Japanese);"
1570 "The mail address of the Semi-gnus developers.")
1572 (defcustom gnus-info-filename nil
1573 "*Controls language of gnus Info.
1574 If nil and current-language-environment is Japanese, go to gnus-ja.
1575 Otherwise go to corresponding Info.
1576 This variable can be nil, gnus or gnus-ja."
1578 :type '(choice (const nil)
1579 (const :tag "English" gnus)
1580 (const :tag "Japanese" gnus-ja)))
1582 (defvar gnus-info-nodes
1583 '((gnus-group-mode "The Group Buffer")
1584 (gnus-summary-mode "The Summary Buffer")
1585 (gnus-article-mode "The Article Buffer")
1586 (gnus-server-mode "The Server Buffer")
1587 (gnus-browse-mode "Browse Foreign Server")
1588 (gnus-tree-mode "Tree Display"))
1589 "Alist of major modes and related Info nodes.")
1591 (defvar gnus-group-buffer "*Group*")
1592 (defvar gnus-summary-buffer "*Summary*")
1593 (defvar gnus-article-buffer "*Article*")
1594 (defvar gnus-server-buffer "*Server*")
1596 (defvar gnus-slave nil
1597 "Whether this Gnus is a slave or not.")
1599 (defvar gnus-batch-mode nil
1600 "Whether this Gnus is running in batch mode or not.")
1602 (defvar gnus-variable-list
1603 '(gnus-newsrc-options gnus-newsrc-options-n
1604 gnus-newsrc-last-checked-date
1605 gnus-newsrc-alist gnus-server-alist
1606 gnus-killed-list gnus-zombie-list
1607 gnus-topic-topology gnus-topic-alist
1609 "Gnus variables saved in the quick startup file.")
1611 (defvar gnus-newsrc-alist nil
1612 "Assoc list of read articles.
1613 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1615 (defvar gnus-newsrc-hashtb nil
1616 "Hashtable of gnus-newsrc-alist.")
1618 (defvar gnus-killed-list nil
1619 "List of killed newsgroups.")
1621 (defvar gnus-killed-hashtb nil
1622 "Hash table equivalent of gnus-killed-list.")
1624 (defvar gnus-zombie-list nil
1625 "List of almost dead newsgroups.")
1627 (defvar gnus-description-hashtb nil
1628 "Descriptions of newsgroups.")
1630 (defvar gnus-list-of-killed-groups nil
1631 "List of newsgroups that have recently been killed by the user.")
1633 (defvar gnus-active-hashtb nil
1634 "Hashtable of active articles.")
1636 (defvar gnus-moderated-hashtb nil
1637 "Hashtable of moderated newsgroups.")
1639 ;; Save window configuration.
1640 (defvar gnus-prev-winconf nil)
1642 (defvar gnus-reffed-article-number nil)
1644 ;;; Let the byte-compiler know that we know about this variable.
1645 (defvar rmail-default-rmail-file)
1647 (defvar gnus-dead-summary nil)
1649 ;;; End of variables.
1651 ;; Define some autoload functions Gnus might use.
1654 ;; This little mapcar goes through the list below and marks the
1655 ;; symbols in question as autoloaded functions.
1658 (let ((interactive (nth 1 (memq ':interactive package))))
1662 (when (consp function)
1663 (setq keymap (car (memq 'keymap function)))
1664 (setq function (car function)))
1665 (autoload function (car package) nil interactive keymap)))
1666 (if (eq (nth 1 package) ':interactive)
1669 '(("info" Info-goto-node)
1670 ("pp" pp pp-to-string pp-eval-expression)
1671 ("ps-print" ps-print-preprint)
1672 ("mail-extr" mail-extract-address-components)
1673 ("browse-url" browse-url)
1674 ("message" :interactive t
1675 message-send-and-exit message-yank-original)
1676 ("nnmail" nnmail-split-fancy nnmail-article-group)
1677 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1678 ("rmailout" rmail-output rmail-output-to-rmail-file)
1679 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1680 rmail-show-message rmail-summary-exists
1681 rmail-select-summary rmail-update-summary)
1682 ("gnus-audio" :interactive t gnus-audio-play)
1683 ("gnus-xmas" gnus-xmas-splash)
1684 ("gnus-soup" :interactive t
1685 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1686 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1687 ("nnsoup" nnsoup-pack-replies)
1688 ("score-mode" :interactive t gnus-score-mode)
1689 ("gnus-mh" gnus-summary-save-article-folder
1690 gnus-Folder-save-name gnus-folder-save-name)
1691 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1692 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1693 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1694 gnus-demon-add-disconnection gnus-demon-add-handler
1695 gnus-demon-remove-handler)
1696 ("gnus-demon" :interactive t
1697 gnus-demon-init gnus-demon-cancel)
1698 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1699 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1700 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1701 gnus-nocem-unwanted-article-p)
1702 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1703 gnus-server-server-name)
1704 ("gnus-srvr" gnus-browse-foreign-server)
1705 ("gnus-cite" :interactive t
1706 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1707 gnus-article-hide-citation gnus-article-fill-cited-article
1708 gnus-article-hide-citation-in-followups)
1709 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1710 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1711 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1712 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1713 gnus-cache-possibly-remove-articles gnus-cache-request-article
1714 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1715 gnus-cache-enter-remove-article gnus-cached-article-p
1716 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1717 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1718 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1719 ("gnus-score" :interactive t
1720 gnus-summary-increase-score gnus-summary-set-score
1721 gnus-summary-raise-thread gnus-summary-raise-same-subject
1722 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1723 gnus-summary-lower-thread gnus-summary-lower-same-subject
1724 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1725 gnus-summary-current-score gnus-score-default
1726 gnus-score-flush-cache gnus-score-close
1727 gnus-possibly-score-headers gnus-score-followup-article
1728 gnus-score-followup-thread)
1730 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1731 gnus-current-score-file-nondirectory gnus-score-adaptive
1732 gnus-score-find-trace gnus-score-file-name)
1733 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1734 ("gnus-topic" :interactive t gnus-topic-mode)
1735 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1736 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1737 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1738 ("gnus-uu" :interactive t
1739 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1740 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1741 gnus-uu-mark-by-regexp gnus-uu-mark-all
1742 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1743 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1744 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1745 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1746 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1747 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1748 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1749 gnus-uu-mark-over gnus-uu-post-news)
1750 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1751 gnus-uu-unmark-thread)
1752 ("gnus-msg" (gnus-summary-send-map keymap)
1753 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1754 ("gnus-msg" :interactive t
1755 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1756 gnus-summary-followup gnus-summary-followup-with-original
1757 gnus-summary-cancel-article gnus-summary-supersede-article
1758 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1759 gnus-summary-mail-forward gnus-summary-mail-other-window
1760 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1761 gnus-summary-wide-reply gnus-summary-followup-to-mail
1762 gnus-summary-followup-to-mail-with-original gnus-bug
1763 gnus-summary-wide-reply-with-original
1764 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1765 gnus-summary-post-forward)
1766 ("gnus-picon" :interactive t gnus-article-display-picons
1767 gnus-group-display-picons gnus-picons-article-display-x-face
1768 gnus-picons-display-x-face)
1769 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1770 gnus-grouplens-mode)
1771 ("smiley" :interactive t gnus-smiley-display)
1772 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1773 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1774 gnus-list-of-unread-articles gnus-list-of-read-articles
1775 gnus-offer-save-summaries gnus-make-thread-indent-array
1776 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1777 gnus-summary-skip-intangible gnus-summary-article-number
1778 gnus-data-header gnus-data-find)
1779 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1780 gnus-group-list-groups gnus-group-first-unread-group
1781 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1782 gnus-group-setup-buffer gnus-group-get-new-news
1783 gnus-group-make-help-group gnus-group-update-group
1784 gnus-clear-inboxes-moved gnus-group-iterate
1785 gnus-group-group-name)
1786 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1787 gnus-backlog-remove-article)
1788 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1789 gnus-article-prepare gnus-article-set-window-start
1790 gnus-article-next-page gnus-article-prev-page
1791 gnus-request-article-this-buffer gnus-article-mode
1792 gnus-article-setup-buffer gnus-narrow-to-page
1793 gnus-article-delete-invisible-text)
1794 ("gnus-art" :interactive t
1795 gnus-article-hide-headers gnus-article-hide-boring-headers
1796 gnus-article-treat-overstrike gnus-article-word-wrap
1797 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1798 gnus-article-display-x-face
1799 gnus-article-hide-pgp
1800 gnus-article-hide-pem gnus-article-hide-signature
1801 gnus-article-strip-leading-blank-lines gnus-article-date-local
1802 gnus-article-date-original gnus-article-date-lapsed
1803 gnus-article-show-all-headers
1804 gnus-article-edit-mode gnus-article-edit-article
1805 gnus-article-edit-done article-decode-encoded-words
1806 gnus-start-date-timer gnus-stop-date-timer)
1807 ("gnus-int" gnus-request-type)
1808 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1809 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1810 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1811 gnus-dup-enter-articles)
1812 ("gnus-range" gnus-copy-sequence)
1813 ("gnus-eform" gnus-edit-form)
1814 ("gnus-move" :interactive t
1815 gnus-group-move-group-to-server gnus-change-server)
1816 ("gnus-logic" gnus-score-advanced)
1817 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1818 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1819 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1820 gnus-async-halt-prefetch)
1823 ("gnus-offline" :interactive t
1824 gnus-offline-toggle-plugged
1825 gnus-offline-set-unplugged-state
1826 gnus-offline-toggle-auto-hangup
1827 gnus-offline-toggle-on/off-send-mail
1828 gnus-offline-toggle-articles-to-fetch
1829 gnus-offline-toggle-movemail-program
1830 gnus-offline-set-interval-time
1831 gnus-offline-agent-expire)
1832 ("pop3-fma" :interactive t
1833 pop3-fma-set-pop3-password)
1834 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1835 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1836 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1837 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1838 ("gnus-agent" :interactive t
1839 gnus-unplugged gnus-agentize gnus-agent-batch)
1840 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1841 gnus-summary-save-article-vm)
1842 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1844 ;;; gnus-sum.el thingies
1847 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1848 "*The format specification of the lines in the summary buffer.
1850 It works along the same lines as a normal formatting string,
1851 with some simple extensions.
1853 %N Article number, left padded with spaces (string)
1855 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1856 %n Name of the poster (string)
1857 %a Extracted name of the poster (string)
1858 %A Extracted address of the poster (string)
1859 %F Contents of the From: header (string)
1860 %f Contents of the From: or To: headers (string)
1861 %x Contents of the Xref: header (string)
1862 %D Date of the article (string)
1863 %d Date of the article (string) in DD-MMM format
1864 %M Message-id of the article (string)
1865 %r References of the article (string)
1866 %c Number of characters in the article (integer)
1867 %L Number of lines in the article (integer)
1868 %I Indentation based on thread level (a string of spaces)
1869 %T A string with two possible values: 80 spaces if the article
1870 is on thread level two or larger and 0 spaces on level one
1871 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1872 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1873 %[ Opening bracket (character, \"[\" or \"<\")
1874 %] Closing bracket (character, \"]\" or \">\")
1875 %> Spaces of length thread-level (string)
1876 %< Spaces of length (- 20 thread-level) (string)
1877 %i Article score (number)
1878 %z Article zcore (character)
1879 %t Number of articles under the current thread (number).
1880 %e Whether the thread is empty or not (character).
1881 %l GroupLens score (string).
1882 %V Total thread score (number).
1883 %P The line number (number).
1884 %O Download mark (character).
1885 %u User defined specifier. The next character in the format string should
1886 be a letter. Gnus will call the function gnus-user-format-function-X,
1887 where X is the letter following %u. The function will be passed the
1888 current header as argument. The function should return a string, which
1889 will be inserted into the summary just like information from any other
1892 Text between %( and %) will be highlighted with `gnus-mouse-face'
1893 when the mouse point is placed inside the area. There can only be one
1896 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1897 with care. For reasons of efficiency, Gnus will compute what column
1898 these characters will end up in, and \"hard-code\" that. This means that
1899 it is illegal to have these specs after a variable-length spec. Well,
1900 you might not be arrested, but your summary buffer will look strange,
1901 which is bad enough.
1903 The smart choice is to have these specs as for to the left as
1906 This restriction may disappear in later versions of Gnus."
1908 :group 'gnus-summary-format)
1911 ;;; Skeleton keymaps
1914 (defun gnus-suppress-keymap (keymap)
1915 (suppress-keymap keymap)
1916 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1918 (define-key keymap (pop keys) 'undefined))))
1920 (defvar gnus-article-mode-map
1921 (let ((keymap (make-sparse-keymap)))
1922 (gnus-suppress-keymap keymap)
1924 (defvar gnus-summary-mode-map
1925 (let ((keymap (make-keymap)))
1926 (gnus-suppress-keymap keymap)
1928 (defvar gnus-group-mode-map
1929 (let ((keymap (make-keymap)))
1930 (gnus-suppress-keymap keymap)
1935 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1936 ;; If you want the cursor to go somewhere else, set these two
1937 ;; functions in some startup hook to whatever you want.
1938 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1939 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1941 ;;; Various macros and substs.
1943 (defun gnus-header-from (header)
1944 (mail-header-from header))
1946 (defmacro gnus-gethash (string hashtable)
1947 "Get hash value of STRING in HASHTABLE."
1948 `(symbol-value (intern-soft ,string ,hashtable)))
1950 (defmacro gnus-sethash (string value hashtable)
1951 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1952 `(set (intern ,string ,hashtable) ,value))
1953 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1955 (defmacro gnus-group-unread (group)
1956 "Get the currently computed number of unread articles in GROUP."
1957 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1959 (defmacro gnus-group-entry (group)
1960 "Get the newsrc entry for GROUP."
1961 `(gnus-gethash ,group gnus-newsrc-hashtb))
1963 (defmacro gnus-active (group)
1964 "Get active info on GROUP."
1965 `(gnus-gethash ,group gnus-active-hashtb))
1967 (defmacro gnus-set-active (group active)
1968 "Set GROUP's active info."
1969 `(gnus-sethash ,group ,active gnus-active-hashtb))
1971 ;; Info access macros.
1973 (defmacro gnus-info-group (info)
1975 (defmacro gnus-info-rank (info)
1977 (defmacro gnus-info-read (info)
1979 (defmacro gnus-info-marks (info)
1981 (defmacro gnus-info-method (info)
1983 (defmacro gnus-info-params (info)
1986 (defmacro gnus-info-level (info)
1987 `(let ((rank (gnus-info-rank ,info)))
1991 (defmacro gnus-info-score (info)
1992 `(let ((rank (gnus-info-rank ,info)))
1993 (or (and (consp rank) (cdr rank)) 0)))
1995 (defmacro gnus-info-set-group (info group)
1996 `(setcar ,info ,group))
1997 (defmacro gnus-info-set-rank (info rank)
1998 `(setcar (nthcdr 1 ,info) ,rank))
1999 (defmacro gnus-info-set-read (info read)
2000 `(setcar (nthcdr 2 ,info) ,read))
2001 (defmacro gnus-info-set-marks (info marks &optional extend)
2003 `(gnus-info-set-entry ,info ,marks 3)
2004 `(setcar (nthcdr 3 ,info) ,marks)))
2005 (defmacro gnus-info-set-method (info method &optional extend)
2007 `(gnus-info-set-entry ,info ,method 4)
2008 `(setcar (nthcdr 4 ,info) ,method)))
2009 (defmacro gnus-info-set-params (info params &optional extend)
2011 `(gnus-info-set-entry ,info ,params 5)
2012 `(setcar (nthcdr 5 ,info) ,params)))
2014 (defun gnus-info-set-entry (info entry number)
2015 ;; Extend the info until we have enough elements.
2016 (while (<= (length info) number)
2017 (nconc info (list nil)))
2019 (setcar (nthcdr number info) entry))
2021 (defmacro gnus-info-set-level (info level)
2022 `(let ((rank (cdr ,info)))
2023 (if (consp (car rank))
2024 (setcar (car rank) ,level)
2025 (setcar rank ,level))))
2026 (defmacro gnus-info-set-score (info score)
2027 `(let ((rank (cdr ,info)))
2028 (if (consp (car rank))
2029 (setcdr (car rank) ,score)
2030 (setcar rank (cons (car rank) ,score)))))
2032 (defmacro gnus-get-info (group)
2033 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2035 ;; Byte-compiler warning.
2036 (defvar gnus-visual)
2037 ;; Find out whether the gnus-visual TYPE is wanted.
2038 (defun gnus-visual-p (&optional type class)
2039 (and gnus-visual ; Has to be non-nil, at least.
2040 (if (not type) ; We don't care about type.
2042 (if (listp gnus-visual) ; It's a list, so we check it.
2043 (or (memq type gnus-visual)
2044 (memq class gnus-visual))
2047 ;;; Load the compatability functions.
2056 (defvar gnus-shutdown-alist nil)
2058 (defun gnus-add-shutdown (function &rest symbols)
2059 "Run FUNCTION whenever one of SYMBOLS is shut down."
2060 (push (cons function symbols) gnus-shutdown-alist))
2062 (defun gnus-shutdown (symbol)
2063 "Shut down everything that waits for SYMBOL."
2064 (let ((alist gnus-shutdown-alist)
2066 (while (setq entry (pop alist))
2067 (when (memq symbol (cdr entry))
2068 (funcall (car entry))))))
2072 ;;; Gnus Utility Functions
2076 (defmacro gnus-string-or (&rest strings)
2077 "Return the first element of STRINGS that is a non-blank string.
2078 STRINGS will be evaluated in normal `or' order."
2079 `(gnus-string-or-1 ',strings))
2081 (defun gnus-string-or-1 (strings)
2084 (setq string (eval (pop strings)))
2085 (if (string-match "^[ \t]*$" string)
2087 (setq strings nil)))
2090 (defun gnus-version (&optional arg)
2091 "Version number of this version of Gnus.
2092 If ARG, insert string at point."
2095 (insert (message gnus-version))
2096 (message gnus-version)))
2098 (defun gnus-continuum-version (version)
2099 "Return VERSION as a floating point number."
2100 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2101 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2102 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2103 (number (match-string 2 version))
2105 (unless (string-match
2106 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2107 (error "Invalid version string: %s" version))
2108 (setq major (string-to-number (match-string 1 number))
2109 minor (string-to-number (match-string 2 number))
2110 least (if (match-beginning 3)
2111 (string-to-number (match-string 3 number))
2115 (format "%s00%02d%02d"
2116 (if (member alpha '("(ding)" "d"))
2120 (- (char-int (aref (downcase alpha) 0))
2124 (format "%d.%02d%02d" major minor least))))))
2126 (defun gnus-info-find-node ()
2127 "Find Info documentation of Gnus."
2129 ;; Enlarge info window if needed.
2130 (let (gnus-info-buffer)
2133 (or gnus-info-filename
2134 (get-language-info current-language-environment 'gnus-info)
2136 (cadr (assq major-mode gnus-info-nodes))))
2137 (setq gnus-info-buffer (current-buffer))
2138 (gnus-configure-windows 'info)))
2141 ;;; gnus-interactive
2144 (defvar gnus-current-prefix-symbol nil
2145 "Current prefix symbol.")
2147 (defvar gnus-current-prefix-symbols nil
2148 "List of current prefix symbols.")
2150 (defun gnus-interactive (string &optional params)
2151 "Return a list that can be fed to `interactive'.
2152 See `interactive' for full documentation.
2154 Adds the following specs:
2156 y -- The current symbolic prefix.
2157 Y -- A list of the current symbolic prefix(es).
2158 A -- Article number.
2159 H -- Article header.
2163 (while (< i (length string))
2164 (string-match ".\\([^\n]*\\)\n?" string i)
2165 (setq c (aref string i))
2167 (setq prompt (match-string 1 string)))
2168 (setq i (match-end 0))
2169 ;; We basically emulate just about everything that
2170 ;; `interactive' does, but add the specs listed above.
2174 (completing-read prompt obarray 'fboundp t))
2176 (read-buffer prompt (current-buffer) t))
2178 (read-buffer prompt (other-buffer (current-buffer))))
2182 (completing-read prompt obarray 'commandp t))
2186 (read-file-name prompt nil default-directory 'lambda))
2188 (read-file-name prompt nil nil 'lambda))
2190 (read-file-name prompt))
2192 (read-key-sequence prompt))
2194 (error "Not implemented spec"))
2196 (error "Not implemented spec"))
2200 (error "Not implemented spec"))
2202 (string-to-number (read-from-minibuffer prompt)))
2204 (prefix-numeric-value current-prefix-arg))
2210 (read-string prompt))
2212 (intern (read-string prompt)))
2214 (read-variable prompt))
2216 (read-minibuffer prompt))
2218 (eval-minibuffer prompt))
2219 ;; And here the new specs come.
2221 gnus-current-prefix-symbol)
2223 gnus-current-prefix-symbols)
2225 (gnus-group-group-name))
2227 (gnus-summary-skip-intangible)
2228 (or (get-text-property (point) 'gnus-number)
2229 (gnus-summary-last-subject)))
2231 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2233 (error "Non-implemented spec")))
2237 (push (if (< (point) (mark) (point) (mark))) out)
2238 (push (if (> (point) (mark) (point) (mark))) out))))
2239 (setq out (delq 'gnus-prefix-nil out))
2242 (defun gnus-symbolic-argument (&optional arg)
2243 "Read a symbolic argument and a command, and then execute command."
2245 (let* ((in-command (this-command-keys))
2246 (command in-command)
2247 gnus-current-prefix-symbols
2248 gnus-current-prefix-symbol
2250 (while (equal in-command command)
2251 (message "%s-" (key-description (this-command-keys)))
2252 (push (intern (char-to-string (read-char))) syms)
2253 (setq command (read-key-sequence nil t)))
2254 (setq gnus-current-prefix-symbols (nreverse syms)
2255 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2256 (call-interactively (key-binding command t))))
2258 ;;; More various functions.
2260 (defsubst gnus-check-backend-function (func group)
2261 "Check whether GROUP supports function FUNC.
2262 GROUP can either be a string (a group name) or a select method."
2264 (let ((method (if (stringp group)
2265 (car (gnus-find-method-for-group group))
2267 (unless (featurep method)
2269 (fboundp (intern (format "%s-%s" method func))))))
2271 (defun gnus-group-read-only-p (&optional group)
2272 "Check whether GROUP supports editing or not.
2273 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2274 that that variable is buffer-local to the summary buffers."
2275 (let ((group (or group gnus-newsgroup-name)))
2276 (not (gnus-check-backend-function 'request-replace-article group))))
2278 (defun gnus-group-total-expirable-p (group)
2279 "Check whether GROUP is total-expirable or not."
2280 (let ((params (gnus-group-find-parameter group))
2283 ((memq 'total-expire params)
2285 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2287 (gnus-total-expirable-newsgroups ; Check var.
2288 (string-match gnus-total-expirable-newsgroups group)))))
2290 (defun gnus-group-auto-expirable-p (group)
2291 "Check whether GROUP is auto-expirable or not."
2292 (let ((params (gnus-group-find-parameter group))
2295 ((memq 'auto-expire params)
2297 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2299 (gnus-auto-expirable-newsgroups ; Check var.
2300 (string-match gnus-auto-expirable-newsgroups group)))))
2302 (defun gnus-virtual-group-p (group)
2303 "Say whether GROUP is virtual or not."
2304 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2305 gnus-valid-select-methods)))
2307 (defun gnus-news-group-p (group &optional article)
2308 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2309 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2310 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2311 (eq (gnus-request-type group article) 'news))))
2313 ;; Returns a list of writable groups.
2314 (defun gnus-writable-groups ()
2315 (let ((alist gnus-newsrc-alist)
2317 (while (setq group (car (pop alist)))
2318 (unless (gnus-group-read-only-p group)
2319 (push group groups)))
2322 ;; Check whether to use long file names.
2323 (defun gnus-use-long-file-name (symbol)
2324 ;; The variable has to be set...
2325 (and gnus-use-long-file-name
2326 ;; If it isn't a list, then we return t.
2327 (or (not (listp gnus-use-long-file-name))
2328 ;; If it is a list, and the list contains `symbol', we
2330 (not (memq symbol gnus-use-long-file-name)))))
2332 ;; Generate a unique new group name.
2333 (defun gnus-generate-new-group-name (leaf)
2336 (while (gnus-gethash name gnus-newsrc-hashtb)
2337 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2340 (defun gnus-ephemeral-group-p (group)
2341 "Say whether GROUP is ephemeral or not."
2342 (gnus-group-get-parameter group 'quit-config t))
2344 (defun gnus-group-quit-config (group)
2345 "Return the quit-config of GROUP."
2346 (gnus-group-get-parameter group 'quit-config t))
2348 (defun gnus-kill-ephemeral-group (group)
2349 "Remove ephemeral GROUP from relevant structures."
2350 (gnus-sethash group nil gnus-newsrc-hashtb))
2352 (defun gnus-simplify-mode-line ()
2353 "Make mode lines a bit simpler."
2354 (setq mode-line-modified (cdr gnus-mode-line-modified))
2355 (when (listp mode-line-format)
2356 (make-local-variable 'mode-line-format)
2357 (setq mode-line-format (copy-sequence mode-line-format))
2358 (when (equal (nth 3 mode-line-format) " ")
2359 (setcar (nthcdr 3 mode-line-format) " "))))
2361 ;;; Servers and groups.
2363 (defsubst gnus-server-add-address (method)
2364 (let ((method-name (symbol-name (car method))))
2365 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2366 (not (assq (intern (concat method-name "-address")) method))
2367 (memq 'physical-address (assq (car method)
2368 gnus-valid-select-methods)))
2369 (append method (list (list (intern (concat method-name "-address"))
2373 (defsubst gnus-server-get-method (group method)
2374 ;; Input either a server name, and extended server name, or a
2375 ;; select method, and return a select method.
2376 (cond ((stringp method)
2377 (gnus-server-to-method method))
2378 ((equal method gnus-select-method)
2380 ((and (stringp (car method))
2382 (gnus-server-extend-method group method))
2385 (equal (cadr method) ""))
2388 (gnus-server-add-address method))))
2390 (defun gnus-server-to-method (server)
2391 "Map virtual server names to select methods."
2393 ;; Is this a method, perhaps?
2394 (and server (listp server) server)
2395 ;; Perhaps this is the native server?
2396 (and (equal server "native") gnus-select-method)
2397 ;; It should be in the server alist.
2398 (cdr (assoc server gnus-server-alist))
2399 ;; It could be in the predefined server alist.
2400 (cdr (assoc server gnus-predefined-server-alist))
2401 ;; If not, we look through all the opened server
2402 ;; to see whether we can find it there.
2403 (let ((opened gnus-opened-servers))
2405 (not (equal server (format "%s:%s" (caaar opened)
2410 (defmacro gnus-method-equal (ss1 ss2)
2411 "Say whether two servers are equal."
2415 (and (= (length s1) (length s2))
2417 (while (and s1 (member (car s1) s2))
2421 (defun gnus-server-equal (m1 m2)
2422 "Say whether two methods are equal."
2423 (let ((m1 (cond ((null m1) gnus-select-method)
2424 ((stringp m1) (gnus-server-to-method m1))
2426 (m2 (cond ((null m2) gnus-select-method)
2427 ((stringp m2) (gnus-server-to-method m2))
2429 (gnus-method-equal m1 m2)))
2431 (defun gnus-servers-using-backend (backend)
2432 "Return a list of known servers using BACKEND."
2433 (let ((opened gnus-opened-servers)
2436 (when (eq backend (caaar opened))
2437 (push (caar opened) out))
2441 (defun gnus-archive-server-wanted-p ()
2442 "Say whether the user wants to use the archive server."
2444 ((or (not gnus-message-archive-method)
2445 (not gnus-message-archive-group))
2447 ((and gnus-message-archive-method gnus-message-archive-group)
2450 (let ((active (cadr (assq 'nnfolder-active-file
2451 gnus-message-archive-method))))
2453 (file-exists-p active))))))
2455 (defun gnus-group-prefixed-name (group method)
2456 "Return the whole name from GROUP and METHOD."
2457 (and (stringp method) (setq method (gnus-server-to-method method)))
2458 (if (or (not method)
2459 (gnus-server-equal method "native"))
2461 (concat (format "%s" (car method))
2463 (or (assoc (format "%s" (car method))
2464 (gnus-methods-using 'address))
2465 (gnus-server-equal method gnus-message-archive-method))
2467 (not (string= (nth 1 method) "")))
2468 (concat "+" (nth 1 method)))
2471 (defun gnus-group-real-prefix (group)
2472 "Return the prefix of the current group name."
2473 (if (string-match "^[^:]+:" group)
2474 (substring group 0 (match-end 0))
2477 (defun gnus-group-method (group)
2478 "Return the server or method used for selecting GROUP.
2479 You should probably use `gnus-find-method-for-group' instead."
2480 (let ((prefix (gnus-group-real-prefix group)))
2481 (if (equal prefix "")
2483 (let ((servers gnus-opened-servers)
2485 backend possible found)
2486 (if (string-match "^[^\\+]+\\+" prefix)
2487 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2488 server (substring prefix (match-end 0) (1- (length prefix))))
2489 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2491 (when (eq (caaar servers) backend)
2492 (setq possible (caar servers))
2493 (when (equal (cadaar servers) server)
2494 (setq found (caar servers))))
2496 (or (car (rassoc found gnus-server-alist))
2498 (car (rassoc possible gnus-server-alist))
2500 (list backend server))))))
2502 (defsubst gnus-native-method-p (method)
2503 "Return whether METHOD is the native select method."
2504 (gnus-method-equal method gnus-select-method))
2506 (defsubst gnus-secondary-method-p (method)
2507 "Return whether METHOD is a secondary select method."
2508 (let ((methods gnus-secondary-select-methods)
2509 (gmethod (gnus-server-get-method nil method)))
2511 (not (gnus-method-equal
2512 (gnus-server-get-method nil (car methods))
2514 (setq methods (cdr methods)))
2517 (defun gnus-method-simplify (method)
2518 "Return the shortest uniquely identifying string or method for METHOD."
2519 (cond ((gnus-native-method-p method)
2521 ((gnus-secondary-method-p method)
2522 (format "%s:%s" (nth 0 method) (nth 1 method)))
2526 (defun gnus-groups-from-server (server)
2527 "Return a list of all groups that are fetched from SERVER."
2528 (let ((alist (cdr gnus-newsrc-alist))
2530 (while (setq info (pop alist))
2531 (when (gnus-server-equal (gnus-info-method info) server)
2532 (push (gnus-info-group info) groups)))
2533 (sort groups 'string<)))
2535 (defun gnus-group-foreign-p (group)
2536 "Say whether a group is foreign or not."
2537 (and (not (gnus-group-native-p group))
2538 (not (gnus-group-secondary-p group))))
2540 (defun gnus-group-native-p (group)
2541 "Say whether the group is native or not."
2542 (not (string-match ":" group)))
2544 (defun gnus-group-secondary-p (group)
2545 "Say whether the group is secondary or not."
2546 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2548 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2549 "Return the group parameters for GROUP.
2550 If SYMBOL, return the value of that symbol in the group parameters."
2552 (set-buffer gnus-group-buffer)
2553 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2555 (gnus-group-parameter-value parameters symbol allow-list)
2558 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2559 "Return the group parameters for GROUP.
2560 If SYMBOL, return the value of that symbol in the group parameters.
2561 Most functions should use `gnus-group-find-parameter', which
2562 also examines the topic parameters."
2563 (let ((params (gnus-info-params (gnus-get-info group))))
2565 (gnus-group-parameter-value params symbol allow-list)
2568 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2569 "Return the value of SYMBOL in group PARAMS."
2570 ;; We only wish to return group parameters (dotted lists) and
2571 ;; not local variables, which may have the same names.
2572 ;; But first we handle single elements...
2573 (or (car (memq symbol params))
2577 (while (setq elem (pop params))
2578 (when (and (consp elem)
2579 (eq (car elem) symbol)
2582 (throw 'found (cdr elem))))))))
2584 (defun gnus-group-add-parameter (group param)
2585 "Add parameter PARAM to GROUP."
2586 (let ((info (gnus-get-info group)))
2588 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2589 ;; Cons the new param to the old one and update.
2590 (gnus-group-set-info (cons param (gnus-info-params info))
2593 (defun gnus-group-set-parameter (group name value)
2594 "Set parameter NAME to VALUE in GROUP."
2595 (let ((info (gnus-get-info group)))
2597 (gnus-group-remove-parameter group name)
2598 (let ((old-params (gnus-info-params info))
2599 (new-params (list (cons name value))))
2601 (when (or (not (listp (car old-params)))
2602 (not (eq (caar old-params) name)))
2603 (setq new-params (append new-params (list (car old-params)))))
2604 (setq old-params (cdr old-params)))
2605 (gnus-group-set-info new-params group 'params)))))
2607 (defun gnus-group-remove-parameter (group name)
2608 "Remove parameter NAME from GROUP."
2609 (let ((info (gnus-get-info group)))
2611 (let ((params (gnus-info-params info)))
2613 (setq params (delq name params))
2614 (while (assq name params)
2615 (gnus-pull name params))
2616 (gnus-info-set-params info params))))))
2618 (defun gnus-group-add-score (group &optional score)
2619 "Add SCORE to the GROUP score.
2620 If SCORE is nil, add 1 to the score of GROUP."
2621 (let ((info (gnus-get-info group)))
2623 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2625 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2626 (defun gnus-short-group-name (group &optional levels)
2627 "Collapse GROUP name LEVELS.
2628 Select methods are stripped and any remote host name is stripped down to
2629 just the host name."
2636 (while (string-match "\\." group skip)
2637 (setq skip (match-end 0)
2640 ;; separate foreign select method from group name and collapse.
2641 ;; if method contains a server, collapse to non-domain server name,
2642 ;; otherwise collapse to select method
2643 (let* ((colon (string-match ":" group))
2644 (server (and colon (substring group 0 colon)))
2645 (plus (and server (string-match "+" server))))
2648 (setq foreign (substring server (+ 1 plus)
2649 (string-match "\\." server))
2650 group (substring group (+ 1 colon))))
2652 (setq foreign server
2653 group (substring group (+ 1 colon)))))
2654 (setq foreign (concat foreign ":"))))
2655 ;; collapse group name leaving LEVELS uncollapsed elements
2657 (if (and (string-match "\\." group) (> levels 0))
2658 (setq name (concat name (substring group 0 1))
2659 group (substring group (match-end 0))
2661 name (concat name "."))
2662 (setq name (concat foreign name group)
2666 (defun gnus-narrow-to-body ()
2667 "Narrow to the body of an article."
2670 (goto-char (point-min))
2671 (or (search-forward "\n\n" nil t)
2677 ;;; Kill file handling.
2680 (defun gnus-apply-kill-file ()
2681 "Apply a kill file to the current newsgroup.
2682 Returns the number of articles marked as read."
2683 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2684 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2685 (gnus-apply-kill-file-internal)
2688 (defun gnus-kill-save-kill-buffer ()
2689 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2690 (when (get-file-buffer file)
2692 (set-buffer (get-file-buffer file))
2693 (when (buffer-modified-p)
2695 (kill-buffer (current-buffer))))))
2697 (defcustom gnus-kill-file-name "KILL"
2698 "Suffix of the kill files."
2699 :group 'gnus-score-kill
2700 :group 'gnus-score-files
2703 (defun gnus-newsgroup-kill-file (newsgroup)
2704 "Return the name of a kill file name for NEWSGROUP.
2705 If NEWSGROUP is nil, return the global kill file name instead."
2707 ;; The global KILL file is placed at top of the directory.
2708 ((or (null newsgroup)
2709 (string-equal newsgroup ""))
2710 (expand-file-name gnus-kill-file-name
2711 gnus-kill-files-directory))
2712 ;; Append ".KILL" to newsgroup name.
2713 ((gnus-use-long-file-name 'not-kill)
2714 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2715 "." gnus-kill-file-name)
2716 gnus-kill-files-directory))
2717 ;; Place "KILL" under the hierarchical directory.
2719 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2720 "/" gnus-kill-file-name)
2721 gnus-kill-files-directory))))
2725 (defun gnus-member-of-valid (symbol group)
2726 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2728 (symbol-name (car (gnus-find-method-for-group group)))
2729 gnus-valid-select-methods)))
2731 (defun gnus-method-option-p (method option)
2732 "Return non-nil if select METHOD has OPTION as a parameter."
2733 (when (stringp method)
2734 (setq method (gnus-server-to-method method)))
2735 (memq option (assoc (format "%s" (car method))
2736 gnus-valid-select-methods)))
2738 (defun gnus-similar-server-opened (method)
2739 (let ((opened gnus-opened-servers))
2740 (while (and method opened)
2741 (when (and (equal (cadr method) (cadaar opened))
2742 (equal (car method) (caaar opened))
2743 (not (equal method (caar opened))))
2748 (defun gnus-server-extend-method (group method)
2749 ;; This function "extends" a virtual server. If the server is
2750 ;; "hello", and the select method is ("hello" (my-var "something"))
2751 ;; in the group "alt.alt", this will result in a new virtual server
2752 ;; called "hello+alt.alt".
2753 (if (or (not (inline (gnus-similar-server-opened method)))
2754 (not (cddr method)))
2756 `(,(car method) ,(concat (cadr method) "+" group)
2757 (,(intern (format "%s-address" (car method))) ,(cadr method))
2760 (defun gnus-server-status (method)
2761 "Return the status of METHOD."
2762 (nth 1 (assoc method gnus-opened-servers)))
2764 (defun gnus-group-name-to-method (group)
2765 "Guess a select method based on GROUP."
2766 (if (string-match ":" group)
2767 (let ((server (substring group 0 (match-beginning 0))))
2768 (if (string-match "\\+" server)
2769 (list (intern (substring server 0 (match-beginning 0)))
2770 (substring server (match-end 0)))
2771 (list (intern server) "")))
2772 gnus-select-method))
2774 (defun gnus-find-method-for-group (group &optional info)
2775 "Find the select method that GROUP uses."
2776 (or gnus-override-method
2779 (let ((info (or info (gnus-get-info group)))
2782 (not (setq method (gnus-info-method info)))
2783 (equal method "native"))
2786 (cond ((stringp method)
2787 (inline (gnus-server-to-method method)))
2788 ((stringp (cadr method))
2789 (inline (gnus-server-extend-method group method)))
2792 (cond ((equal (cadr method) "")
2794 ((null (cadr method))
2795 (list (car method) ""))
2797 (gnus-server-add-address method)))))))
2799 (defun gnus-methods-using (feature)
2800 "Find all methods that have FEATURE."
2801 (let ((valids gnus-valid-select-methods)
2804 (when (memq feature (car valids))
2805 (push (car valids) outs))
2806 (setq valids (cdr valids)))
2809 (defun gnus-read-group (prompt &optional default)
2810 "Prompt the user for a group name.
2811 Disallow illegal group names."
2817 (setq group (read-string (concat prefix prompt)
2818 (cons (or default "") 0)
2819 'gnus-group-history)))
2820 (setq prefix (format "Illegal group name: \"%s\". " group)
2824 (defun gnus-read-method (prompt)
2825 "Prompt the user for a method.
2826 Allow completion over sensible values."
2828 (append gnus-valid-select-methods
2829 gnus-predefined-server-alist
2834 nil t nil 'gnus-method-history)))
2837 (setq method gnus-select-method))
2838 ((assoc method gnus-valid-select-methods)
2839 (list (intern method)
2840 (if (memq 'prompt-address
2841 (assoc method gnus-valid-select-methods))
2842 (read-string "Address: ")
2844 ((assoc method servers)
2847 (list (intern method) "")))))
2849 ;;; User-level commands.
2852 (defun gnus-slave-no-server (&optional arg)
2853 "Read network news as a slave, without connecting to local server."
2855 (gnus-no-server arg t))
2858 (defun gnus-no-server (&optional arg slave)
2860 If ARG is a positive number, Gnus will use that as the
2861 startup level. If ARG is nil, Gnus will be started at level 2.
2862 If ARG is non-nil and not a positive number, Gnus will
2863 prompt the user for the name of an NNTP server to use.
2864 As opposed to `gnus', this command will not connect to the local server."
2866 (gnus-no-server-1 arg slave))
2869 (defun gnus-slave (&optional arg)
2870 "Read news as a slave."
2872 (gnus arg nil 'slave))
2875 (defun gnus-other-frame (&optional arg)
2876 "Pop up a frame to read news."
2878 (let ((window (get-buffer-window gnus-group-buffer)))
2880 (select-frame (window-frame window)))
2881 ((= (length (frame-list)) 1)
2882 (select-frame (make-frame)))
2888 (defun gnus (&optional arg dont-connect slave)
2890 If ARG is non-nil and a positive number, Gnus will use that as the
2891 startup level. If ARG is non-nil and not a positive number, Gnus will
2892 prompt the user for the name of an NNTP server to use."
2894 (gnus-1 arg dont-connect slave))
2896 ;; Allow redefinition of Gnus functions.
2902 ;;; gnus.el ends here