1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987-1990,1993-1999 Free Software Foundation, Inc.
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 (eval '(run-hooks 'gnus-load-hook))
31 (eval-when-compile (require 'cl))
36 (if (< emacs-major-version 20)
37 (require 'gnus-load)))
41 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
45 (defgroup gnus-charset nil
46 "Group character set issues."
47 :link '(custom-manual "(gnus)Charsets")
50 (defgroup gnus-cache nil
54 (defgroup gnus-start nil
55 "Starting your favorite newsreader."
58 (defgroup gnus-start-server nil
59 "Server options at startup."
62 ;; These belong to gnus-group.el.
63 (defgroup gnus-group nil
65 :link '(custom-manual "(gnus)The Group Buffer")
68 (defgroup gnus-group-foreign nil
70 :link '(custom-manual "(gnus)Foreign Groups")
73 (defgroup gnus-group-new nil
74 "Automatic subscription of new groups."
77 (defgroup gnus-group-levels nil
79 :link '(custom-manual "(gnus)Group Levels")
82 (defgroup gnus-group-select nil
84 :link '(custom-manual "(gnus)Selecting a Group")
87 (defgroup gnus-group-listing nil
88 "Showing slices of the group list."
89 :link '(custom-manual "(gnus)Listing Groups")
92 (defgroup gnus-group-visual nil
93 "Sorting the group buffer."
94 :link '(custom-manual "(gnus)Group Buffer Format")
98 (defgroup gnus-group-various nil
99 "Various group options."
100 :link '(custom-manual "(gnus)Scanning New Messages")
103 ;; These belong to gnus-sum.el.
104 (defgroup gnus-summary nil
106 :link '(custom-manual "(gnus)The Summary Buffer")
109 (defgroup gnus-summary-exit nil
110 "Leaving summary buffers."
111 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
112 :group 'gnus-summary)
114 (defgroup gnus-summary-marks nil
115 "Marks used in summary buffers."
116 :link '(custom-manual "(gnus)Marking Articles")
117 :group 'gnus-summary)
119 (defgroup gnus-thread nil
120 "Ordering articles according to replies."
121 :link '(custom-manual "(gnus)Threading")
122 :group 'gnus-summary)
124 (defgroup gnus-summary-format nil
125 "Formatting of the summary buffer."
126 :link '(custom-manual "(gnus)Summary Buffer Format")
127 :group 'gnus-summary)
129 (defgroup gnus-summary-choose nil
131 :link '(custom-manual "(gnus)Choosing Articles")
132 :group 'gnus-summary)
134 (defgroup gnus-summary-maneuvering nil
135 "Summary movement commands."
136 :link '(custom-manual "(gnus)Summary Maneuvering")
137 :group 'gnus-summary)
139 (defgroup gnus-summary-mail nil
140 "Mail group commands."
141 :link '(custom-manual "(gnus)Mail Group Commands")
142 :group 'gnus-summary)
144 (defgroup gnus-summary-sort nil
145 "Sorting the summary buffer."
146 :link '(custom-manual "(gnus)Sorting")
147 :group 'gnus-summary)
149 (defgroup gnus-summary-visual nil
150 "Highlighting and menus in the summary buffer."
151 :link '(custom-manual "(gnus)Summary Highlighting")
153 :group 'gnus-summary)
155 (defgroup gnus-summary-various nil
156 "Various summary buffer options."
157 :link '(custom-manual "(gnus)Various Summary Stuff")
158 :group 'gnus-summary)
160 (defgroup gnus-summary-pick nil
161 "Pick mode in the summary buffer."
162 :link '(custom-manual "(gnus)Pick and Read")
164 :group 'gnus-summary)
166 (defgroup gnus-summary-tree nil
167 "Tree display of threads in the summary buffer."
168 :link '(custom-manual "(gnus)Tree Display")
170 :group 'gnus-summary)
172 ;; Belongs to gnus-uu.el
173 (defgroup gnus-extract-view nil
174 "Viewing extracted files."
175 :link '(custom-manual "(gnus)Viewing Files")
176 :group 'gnus-extract)
178 ;; Belongs to gnus-score.el
179 (defgroup gnus-score nil
180 "Score and kill file handling."
183 (defgroup gnus-score-kill nil
187 (defgroup gnus-score-adapt nil
188 "Adaptive score files."
191 (defgroup gnus-score-default nil
192 "Default values for score files."
195 (defgroup gnus-score-expire nil
196 "Expiring score rules."
199 (defgroup gnus-score-decay nil
200 "Decaying score rules."
203 (defgroup gnus-score-files nil
204 "Score and kill file names."
208 (defgroup gnus-score-various nil
209 "Various scoring and killing options."
213 (defgroup gnus-visual nil
214 "Options controling the visual fluff."
218 (defgroup gnus-agent nil
219 "Offline support for Gnus."
222 (defgroup gnus-files nil
223 "Files used by Gnus."
226 (defgroup gnus-dribble-file nil
228 :link '(custom-manual "(gnus)Auto Save")
231 (defgroup gnus-newsrc nil
232 "Storing Gnus state."
235 (defgroup gnus-server nil
236 "Options related to newsservers and other servers used by Gnus."
239 (defgroup gnus-message '((message custom-group))
240 "Composing replies and followups in Gnus."
243 (defgroup gnus-meta nil
244 "Meta variables controling major portions of Gnus.
245 In general, modifying these variables does not take affect until Gnus
246 is restarted, and sometimes reloaded."
249 (defgroup gnus-various nil
250 "Other Gnus options."
251 :link '(custom-manual "(gnus)Various Various")
254 (defgroup gnus-mime nil
255 "Variables for controlling the Gnus MIME interface."
258 (defgroup gnus-exit nil
260 :link '(custom-manual "(gnus)Exiting Gnus")
263 (defconst gnus-version-number "0.97"
264 "Version number for this version of Gnus.")
266 (defconst gnus-version (format "Pterodactyl Gnus v%s" gnus-version-number)
267 "Version string for this version of Gnus.")
269 (defcustom gnus-inhibit-startup-message nil
270 "If non-nil, the startup message will not be displayed.
271 This variable is used before `.gnus.el' is loaded, so it should
272 be set in `.emacs' instead."
276 (defcustom gnus-play-startup-jingle nil
277 "If non-nil, play the Gnus jingle at startup."
281 (unless (featurep 'gnus-xmas)
282 (defalias 'gnus-make-overlay 'make-overlay)
283 (defalias 'gnus-delete-overlay 'delete-overlay)
284 (defalias 'gnus-overlay-put 'overlay-put)
285 (defalias 'gnus-move-overlay 'move-overlay)
286 (defalias 'gnus-overlay-end 'overlay-end)
287 (defalias 'gnus-extent-detached-p 'ignore)
288 (defalias 'gnus-extent-start-open 'ignore)
289 (defalias 'gnus-set-text-properties 'set-text-properties)
290 (defalias 'gnus-group-remove-excess-properties 'ignore)
291 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
292 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
293 (defalias 'gnus-character-to-event 'identity)
294 (defalias 'gnus-add-text-properties 'add-text-properties)
295 (defalias 'gnus-put-text-property 'put-text-property)
296 (defalias 'gnus-mode-line-buffer-identification 'identity)
297 (defalias 'gnus-characterp 'numberp)
298 (defalias 'gnus-deactivate-mark 'deactivate-mark)
299 (defalias 'gnus-window-edges 'window-edges)
300 (defalias 'gnus-key-press-event-p 'numberp)
301 (defalias 'gnus-decode-rfc1522 'ignore))
303 ;; We define these group faces here to avoid the display
304 ;; update forced when creating new faces.
306 (defface gnus-group-news-1-face
309 (:foreground "PaleTurquoise" :bold t))
312 (:foreground "ForestGreen" :bold t))
315 "Level 1 newsgroup face.")
317 (defface gnus-group-news-1-empty-face
320 (:foreground "PaleTurquoise"))
323 (:foreground "ForestGreen"))
326 "Level 1 empty newsgroup face.")
328 (defface gnus-group-news-2-face
331 (:foreground "turquoise" :bold t))
334 (:foreground "CadetBlue4" :bold t))
337 "Level 2 newsgroup face.")
339 (defface gnus-group-news-2-empty-face
342 (:foreground "turquoise"))
345 (:foreground "CadetBlue4"))
348 "Level 2 empty newsgroup face.")
350 (defface gnus-group-news-3-face
359 "Level 3 newsgroup face.")
361 (defface gnus-group-news-3-empty-face
370 "Level 3 empty newsgroup face.")
372 (defface gnus-group-news-4-face
381 "Level 4 newsgroup face.")
383 (defface gnus-group-news-4-empty-face
392 "Level 4 empty newsgroup face.")
394 (defface gnus-group-news-5-face
403 "Level 5 newsgroup face.")
405 (defface gnus-group-news-5-empty-face
414 "Level 5 empty newsgroup face.")
416 (defface gnus-group-news-6-face
425 "Level 6 newsgroup face.")
427 (defface gnus-group-news-6-empty-face
436 "Level 6 empty newsgroup face.")
438 (defface gnus-group-news-low-face
441 (:foreground "DarkTurquoise" :bold t))
444 (:foreground "DarkGreen" :bold t))
447 "Low level newsgroup face.")
449 (defface gnus-group-news-low-empty-face
452 (:foreground "DarkTurquoise"))
455 (:foreground "DarkGreen"))
458 "Low level empty newsgroup face.")
460 (defface gnus-group-mail-1-face
463 (:foreground "aquamarine1" :bold t))
466 (:foreground "DeepPink3" :bold t))
469 "Level 1 mailgroup face.")
471 (defface gnus-group-mail-1-empty-face
474 (:foreground "aquamarine1"))
477 (:foreground "DeepPink3"))
479 (:italic t :bold t)))
480 "Level 1 empty mailgroup face.")
482 (defface gnus-group-mail-2-face
485 (:foreground "aquamarine2" :bold t))
488 (:foreground "HotPink3" :bold t))
491 "Level 2 mailgroup face.")
493 (defface gnus-group-mail-2-empty-face
496 (:foreground "aquamarine2"))
499 (:foreground "HotPink3"))
502 "Level 2 empty mailgroup face.")
504 (defface gnus-group-mail-3-face
507 (:foreground "aquamarine3" :bold t))
510 (:foreground "magenta4" :bold t))
513 "Level 3 mailgroup face.")
515 (defface gnus-group-mail-3-empty-face
518 (:foreground "aquamarine3"))
521 (:foreground "magenta4"))
524 "Level 3 empty mailgroup face.")
526 (defface gnus-group-mail-low-face
529 (:foreground "aquamarine4" :bold t))
532 (:foreground "DeepPink4" :bold t))
535 "Low level mailgroup face.")
537 (defface gnus-group-mail-low-empty-face
540 (:foreground "aquamarine4"))
543 (:foreground "DeepPink4"))
546 "Low level empty mailgroup face.")
548 ;; Summary mode faces.
550 (defface gnus-summary-selected-face '((t
552 "Face used for selected articles.")
554 (defface gnus-summary-cancelled-face
556 (:foreground "yellow" :background "black")))
557 "Face used for cancelled articles.")
559 (defface gnus-summary-high-ticked-face
562 (:foreground "pink" :bold t))
565 (:foreground "firebrick" :bold t))
568 "Face used for high interest ticked articles.")
570 (defface gnus-summary-low-ticked-face
573 (:foreground "pink" :italic t))
576 (:foreground "firebrick" :italic t))
579 "Face used for low interest ticked articles.")
581 (defface gnus-summary-normal-ticked-face
584 (:foreground "pink"))
587 (:foreground "firebrick"))
590 "Face used for normal interest ticked articles.")
592 (defface gnus-summary-high-ancient-face
595 (:foreground "SkyBlue" :bold t))
598 (:foreground "RoyalBlue" :bold t))
601 "Face used for high interest ancient articles.")
603 (defface gnus-summary-low-ancient-face
606 (:foreground "SkyBlue" :italic t))
609 (:foreground "RoyalBlue" :italic t))
612 "Face used for low interest ancient articles.")
614 (defface gnus-summary-normal-ancient-face
617 (:foreground "SkyBlue"))
620 (:foreground "RoyalBlue"))
623 "Face used for normal interest ancient articles.")
625 (defface gnus-summary-high-unread-face
628 "Face used for high interest unread articles.")
630 (defface gnus-summary-low-unread-face
633 "Face used for low interest unread articles.")
635 (defface gnus-summary-normal-unread-face
638 "Face used for normal interest unread articles.")
640 (defface gnus-summary-high-read-face
643 (:foreground "PaleGreen"
647 (:foreground "DarkGreen"
651 "Face used for high interest read articles.")
653 (defface gnus-summary-low-read-face
656 (:foreground "PaleGreen"
660 (:foreground "DarkGreen"
664 "Face used for low interest read articles.")
666 (defface gnus-summary-normal-read-face
669 (:foreground "PaleGreen"))
672 (:foreground "DarkGreen"))
675 "Face used for normal interest read articles.")
682 (defvar gnus-buffers nil)
684 (defun gnus-get-buffer-create (name)
685 "Do the same as `get-buffer-create', but store the created buffer."
686 (or (get-buffer name)
687 (car (push (get-buffer-create name) gnus-buffers))))
689 (defun gnus-add-buffer ()
690 "Add the current buffer to the list of Gnus buffers."
691 (push (current-buffer) gnus-buffers))
693 (defun gnus-buffers ()
694 "Return a list of live Gnus buffers."
695 (while (and gnus-buffers
696 (not (buffer-name (car gnus-buffers))))
698 (let ((buffers gnus-buffers))
700 (if (buffer-name (cadr buffers))
702 (setcdr buffers (cddr buffers)))))
707 (defvar gnus-group-buffer "*Group*")
710 (autoload 'gnus-play-jingle "gnus-audio"))
712 (defface gnus-splash-face
715 (:foreground "Brown"))
718 (:foreground "Brown"))
721 "Face of the splash screen.")
723 (defun gnus-splash ()
725 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
726 (let ((buffer-read-only nil))
728 (unless gnus-inhibit-startup-message
729 (gnus-group-startup-message)
731 (when gnus-play-startup-jingle
732 (gnus-play-jingle))))))
734 (defun gnus-indent-rigidly (start end arg)
735 "Indent rigidly using only spaces and no tabs."
738 (narrow-to-region start end)
740 (indent-rigidly start end arg)
741 ;; We translate tabs into spaces -- not everybody uses
742 ;; an 8-character tab.
743 (goto-char (point-min))
744 (while (search-forward "\t" nil t)
745 (replace-match " " t t))))))
747 (defvar gnus-simple-splash nil)
749 (defun gnus-group-startup-message (&optional x y)
750 "Insert startup message in current buffer."
751 ;; Insert the message.
756 _ ___ __ ___ __ _ ___
776 (gnus-indent-rigidly (point-min) (point-max)
777 (/ (max (- (window-width) (or x 46)) 0) 2))
778 (goto-char (point-min))
780 (let* ((pheight (count-lines (point-min) (point-max)))
781 (wheight (window-height))
782 (rest (- wheight pheight)))
783 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
785 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
786 (goto-char (point-min))
787 (setq mode-line-buffer-identification (concat " " gnus-version))
788 (setq gnus-simple-splash t)
789 (set-buffer-modified-p t))
792 (let ((command (format "%s" this-command)))
793 (if (and (string-match "gnus" command)
794 (not (string-match "gnus-other-frame" command)))
796 (gnus-get-buffer-create gnus-group-buffer))))
804 (defcustom gnus-home-directory "~/"
805 "Directory variable that specifies the \"home\" directory.
806 All other Gnus path variables are initialized from this variable."
810 (defcustom gnus-directory (or (getenv "SAVEDIR")
811 (nnheader-concat gnus-home-directory "News/"))
812 "*Directory variable from which all other Gnus file variables are derived.
814 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
815 This means that other directory variables that are initialized from
816 this variable won't be set properly if you set this variable in `.gnus.el'.
817 Set this variable in `.emacs' instead."
821 (defcustom gnus-default-directory nil
822 "*Default directory for all Gnus buffers."
824 :type '(choice (const :tag "current" nil)
827 ;; Site dependent variables. These variables should be defined in
830 (defvar gnus-default-nntp-server nil
831 "Specify a default NNTP server.
832 This variable should be defined in paths.el, and should never be set
834 If you want to change servers, you should use `gnus-select-method'.
835 See the documentation to that variable.")
837 ;; Don't touch this variable.
838 (defvar gnus-nntp-service "nntp"
839 "NNTP service name (\"nntp\" or 119).
840 This is an obsolete variable, which is scarcely used. If you use an
841 nntp server for your newsgroup and want to change the port number
842 used to 899, you would say something along these lines:
844 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
846 (defcustom gnus-nntpserver-file "/etc/nntpserver"
847 "A file with only the name of the nntp server in it."
852 ;; This function is used to check both the environment variable
853 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
854 ;; an nntp server name default.
855 (defun gnus-getenv-nntpserver ()
856 (or (getenv "NNTPSERVER")
857 (and (file-readable-p gnus-nntpserver-file)
859 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
860 (insert-file-contents gnus-nntpserver-file)
861 (let ((name (buffer-string)))
863 (if (string-match "\\'[ \t\n]*$" name)
866 (kill-buffer (current-buffer))))))))
868 (defcustom gnus-select-method
871 (list 'nntp (or (ignore-errors
872 (gnus-getenv-nntpserver))
873 (when (and gnus-default-nntp-server
874 (not (string= gnus-default-nntp-server "")))
875 gnus-default-nntp-server)
877 (if (or (null gnus-nntp-service)
878 (equal gnus-nntp-service "nntp"))
880 (list gnus-nntp-service))))
881 "*Default method for selecting a newsgroup.
882 This variable should be a list, where the first element is how the
883 news is to be fetched, the second is the address.
885 For instance, if you want to get your news via NNTP from
886 \"flab.flab.edu\", you could say:
888 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
890 If you want to use your local spool, say:
892 \(setq gnus-select-method (list 'nnspool (system-name)))
894 If you use this variable, you must set `gnus-nntp-server' to nil.
896 There is a lot more to know about select methods and virtual servers -
897 see the manual for details."
899 :type 'gnus-select-method)
901 (defcustom gnus-message-archive-method
904 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
905 (nnfolder-active-file
906 ,(nnheader-concat message-directory "archive/active"))
907 (nnfolder-get-new-mail nil)
908 (nnfolder-inhibit-expiry t))
909 "*Method used for archiving messages you've sent.
910 This should be a mail method.
912 It's probably not a very effective to change this variable once you've
913 run Gnus once. After doing that, you must edit this server from the
917 :type 'gnus-select-method)
919 (defcustom gnus-message-archive-group nil
920 "*Name of the group in which to save the messages you've written.
921 This can either be a string; a list of strings; or an alist
922 of regexps/functions/forms to be evaluated to return a string (or a list
923 of strings). The functions are called with the name of the current
924 group (or nil) as a parameter.
926 If you want to save your mail in one group and the news articles you
927 write in another group, you could say something like:
929 \(setq gnus-message-archive-group
930 '((if (message-news-p)
934 Normally the group names returned by this variable should be
935 unprefixed -- which implicitly means \"store on the archive server\".
936 However, you may wish to store the message on some other server. In
937 that case, just return a fully prefixed name of the group --
938 \"nnml+private:mail.misc\", for instance."
940 :type '(choice (const :tag "none" nil)
945 (defcustom gnus-secondary-servers nil
946 "List of NNTP servers that the user can choose between interactively.
947 To make Gnus query you for a server, you have to give `gnus' a
948 non-numeric prefix - `C-u M-x gnus', in short."
950 :type '(repeat string))
952 (defcustom gnus-nntp-server nil
953 "*The name of the host running the NNTP server.
954 This variable is semi-obsolete. Use the `gnus-select-method'
957 :type '(choice (const :tag "disable" nil)
960 (defcustom gnus-secondary-select-methods nil
961 "A list of secondary methods that will be used for reading news.
962 This is a list where each element is a complete select method (see
963 `gnus-select-method').
965 If, for instance, you want to read your mail with the nnml backend,
966 you could set this variable:
968 \(setq gnus-secondary-select-methods '((nnml \"\")))"
970 :type '(repeat gnus-select-method))
972 (defvar gnus-backup-default-subscribed-newsgroups
973 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
974 "Default default new newsgroups the first time Gnus is run.
975 Should be set in paths.el, and shouldn't be touched by the user.")
977 (defcustom gnus-local-domain nil
978 "Local domain name without a host name.
979 The DOMAINNAME environment variable is used instead if it is defined.
980 If the `system-name' function returns the full Internet name, there is
981 no need to set this variable."
983 :type '(choice (const :tag "default" nil)
986 (defvar gnus-local-organization nil
987 "String with a description of what organization (if any) the user belongs to.
988 Obsolete variable; use `message-user-organization' instead.")
990 ;; Customization variables
992 (defcustom gnus-refer-article-method nil
993 "Preferred method for fetching an article by Message-ID.
994 If you are reading news from the local spool (with nnspool), fetching
995 articles by Message-ID is painfully slow. By setting this method to an
996 nntp method, you might get acceptable results.
998 The value of this variable must be a valid select method as discussed
999 in the documentation of `gnus-select-method'."
1001 :type '(choice (const :tag "default" nil)
1002 gnus-select-method))
1004 (defcustom gnus-group-faq-directory
1005 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1006 "/ftp@sunsite.auc.dk:/pub/usenet/"
1007 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1008 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1009 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1010 "/ftp@rtfm.mit.edu:/pub/usenet/"
1011 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1012 "/ftp@ftp.sunet.se:/pub/usenet/"
1013 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1014 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1015 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1016 "*Directory where the group FAQs are stored.
1017 This will most commonly be on a remote machine, and the file will be
1018 fetched by ange-ftp.
1020 This variable can also be a list of directories. In that case, the
1021 first element in the list will be used by default. The others can
1022 be used when being prompted for a site.
1024 Note that Gnus uses an aol machine as the default directory. If this
1025 feels fundamentally unclean, just think of it as a way to finally get
1026 something of value back from them.
1028 If the default site is too slow, try one of these:
1030 North America: mirrors.aol.com /pub/rtfm/usenet
1031 ftp.seas.gwu.edu /pub/rtfm
1032 rtfm.mit.edu /pub/usenet
1033 Europe: ftp.uni-paderborn.de /pub/FAQ
1034 src.doc.ic.ac.uk /usenet/news-FAQS
1035 ftp.sunet.se /pub/usenet
1036 sunsite.auc.dk /pub/usenet
1037 Asia: nctuccca.edu.tw /USENET/FAQ
1038 hwarang.postech.ac.kr /pub/usenet
1039 ftp.hk.super.net /mirror/faqs"
1040 :group 'gnus-group-various
1041 :type '(choice directory
1042 (repeat directory)))
1044 (defcustom gnus-use-cross-reference t
1045 "*Non-nil means that cross referenced articles will be marked as read.
1046 If nil, ignore cross references. If t, mark articles as read in
1047 subscribed newsgroups. If neither t nor nil, mark as read in all
1050 :type '(choice (const :tag "off" nil)
1051 (const :tag "subscribed" t)
1055 (defcustom gnus-process-mark ?#
1057 :group 'gnus-group-visual
1058 :group 'gnus-summary-marks
1061 (defcustom gnus-asynchronous nil
1062 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1063 :group 'gnus-asynchronous
1066 (defcustom gnus-large-newsgroup 200
1067 "*The number of articles which indicates a large newsgroup.
1068 If the number of articles in a newsgroup is greater than this value,
1069 confirmation is required for selecting the newsgroup."
1070 :group 'gnus-group-select
1073 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1074 "*Non-nil means that the default name of a file to save articles in is the group name.
1075 If it's nil, the directory form of the group name is used instead.
1077 If this variable is a list, and the list contains the element
1078 `not-score', long file names will not be used for score files; if it
1079 contains the element `not-save', long file names will not be used for
1080 saving; and if it contains the element `not-kill', long file names
1081 will not be used for kill files.
1083 Note that the default for this variable varies according to what system
1084 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1085 to nil while on all other systems it defaults to t."
1089 (defcustom gnus-kill-files-directory gnus-directory
1090 "*Name of the directory where kill files will be stored (default \"~/News\")."
1091 :group 'gnus-score-files
1092 :group 'gnus-score-kill
1095 (defcustom gnus-save-score nil
1096 "*If non-nil, save group scoring info."
1097 :group 'gnus-score-various
1101 (defcustom gnus-use-undo t
1102 "*If non-nil, allow undoing in Gnus group mode buffers."
1106 (defcustom gnus-use-adaptive-scoring nil
1107 "*If non-nil, use some adaptive scoring scheme.
1108 If a list, then the values `word' and `line' are meaningful. The
1109 former will perform adaption on individual words in the subject
1110 header while `line' will perform adaption on several headers."
1112 :group 'gnus-score-adapt
1113 :type '(set (const word) (const line)))
1115 (defcustom gnus-use-cache 'passive
1116 "*If nil, Gnus will ignore the article cache.
1117 If `passive', it will allow entering (and reading) articles
1118 explicitly entered into the cache. If anything else, use the
1119 cache to the full extent of the law."
1122 :type '(choice (const :tag "off" nil)
1123 (const :tag "passive" passive)
1124 (const :tag "active" t)))
1126 (defcustom gnus-use-trees nil
1127 "*If non-nil, display a thread tree buffer."
1131 (defcustom gnus-use-grouplens nil
1132 "*If non-nil, use GroupLens ratings."
1136 (defcustom gnus-keep-backlog nil
1137 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1138 If it is a number N, then Gnus will only keep the last N articles
1139 read. If it is neither nil nor a number, Gnus will keep all read
1140 articles. This is not a good idea."
1142 :type '(choice (const :tag "off" nil)
1147 (defcustom gnus-use-nocem nil
1148 "*If non-nil, Gnus will read NoCeM cancel messages."
1152 (defcustom gnus-suppress-duplicates nil
1153 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1157 (defcustom gnus-use-scoring t
1158 "*If non-nil, enable scoring."
1162 (defcustom gnus-use-picons nil
1163 "*If non-nil, display picons in a frame of their own."
1167 (defcustom gnus-summary-prepare-exit-hook
1168 '(gnus-summary-expire-articles)
1169 "*A hook called when preparing to exit from the summary buffer.
1170 It calls `gnus-summary-expire-articles' by default."
1171 :group 'gnus-summary-exit
1174 (defcustom gnus-novice-user t
1175 "*Non-nil means that you are a usenet novice.
1176 If non-nil, verbose messages may be displayed and confirmations may be
1181 (defcustom gnus-expert-user nil
1182 "*Non-nil means that you will never be asked for confirmation about anything.
1183 That doesn't mean *anything* anything; particularly destructive
1184 commands will still require prompting."
1188 (defcustom gnus-interactive-catchup t
1189 "*If non-nil, require your confirmation when catching up a group."
1190 :group 'gnus-group-select
1193 (defcustom gnus-interactive-exit t
1194 "*If non-nil, require your confirmation when exiting Gnus."
1198 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1199 "*Function for extracting address components from a From header.
1200 Two pre-defined function exist: `gnus-extract-address-components',
1201 which is the default, quite fast, and too simplistic solution, and
1202 `mail-extract-address-components', which works much better, but is
1204 :group 'gnus-summary-format
1205 :type '(radio (function-item gnus-extract-address-components)
1206 (function-item mail-extract-address-components)
1207 (function :tag "Other")))
1209 (defcustom gnus-carpal nil
1210 "*If non-nil, display clickable icons."
1214 (defcustom gnus-shell-command-separator ";"
1215 "String used to separate to shell commands."
1219 (defcustom gnus-valid-select-methods
1220 '(("nntp" post address prompt-address physical-address)
1221 ("nnspool" post address)
1222 ("nnvirtual" post-mail virtual prompt-address)
1223 ("nnmbox" mail respool address)
1224 ("nnml" mail respool address)
1225 ("nnmh" mail respool address)
1226 ("nndir" post-mail prompt-address physical-address)
1227 ("nneething" none address prompt-address physical-address)
1228 ("nndoc" none address prompt-address)
1229 ("nnbabyl" mail address respool)
1230 ("nnkiboze" post virtual)
1231 ("nnsoup" post-mail address)
1232 ("nndraft" post-mail)
1233 ("nnfolder" mail respool address)
1234 ("nngateway" post-mail address prompt-address physical-address)
1237 ("nnagent" post-mail))
1238 "*An alist of valid select methods.
1239 The first element of each list lists should be a string with the name
1240 of the select method. The other elements may be the category of
1241 this method (i. e., `post', `mail', `none' or whatever) or other
1242 properties that this method has (like being respoolable).
1243 If you implement a new select method, all you should have to change is
1244 this variable. I think."
1246 :type '(repeat (group (string :tag "Name")
1247 (radio-button-choice (const :format "%v " post)
1248 (const :format "%v " mail)
1249 (const :format "%v " none)
1251 (checklist :inline t
1252 (const :format "%v " address)
1253 (const :format "%v " prompt-address)
1254 (const :format "%v " physical-address)
1255 (const :format "%v " virtual)
1258 (define-widget 'gnus-select-method 'list
1259 "Widget for entering a select method."
1260 :args `((choice :tag "Method"
1261 ,@(mapcar (lambda (entry)
1262 (list 'const :format "%v\n"
1263 (intern (car entry))))
1264 gnus-valid-select-methods))
1265 (string :tag "Address")
1266 (editable-list :inline t
1269 (sexp :tag "Value")))))
1271 (defcustom gnus-updated-mode-lines '(group article summary tree)
1272 "List of buffers that should update their mode lines.
1273 The list may contain the symbols `group', `article', `tree' and
1274 `summary'. If the corresponding symbol is present, Gnus will keep
1275 that mode line updated with information that may be pertinent.
1276 If this variable is nil, screen refresh may be quicker."
1277 :group 'gnus-various
1278 :type '(set (const group)
1283 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1284 (defcustom gnus-mode-non-string-length nil
1285 "*Max length of mode-line non-string contents.
1286 If this is nil, Gnus will take space as is needed, leaving the rest
1287 of the modeline intact. Note that the default of nil is unlikely
1288 to be desirable; see the manual for further details."
1289 :group 'gnus-various
1290 :type '(choice (const nil)
1293 (defcustom gnus-auto-expirable-newsgroups nil
1294 "*Groups in which to automatically mark read articles as expirable.
1295 If non-nil, this should be a regexp that should match all groups in
1296 which to perform auto-expiry. This only makes sense for mail groups."
1297 :group 'nnmail-expire
1298 :type '(choice (const nil)
1301 (defcustom gnus-total-expirable-newsgroups nil
1302 "*Groups in which to perform expiry of all read articles.
1303 Use with extreme caution. All groups that match this regexp will be
1304 expiring - which means that all read articles will be deleted after
1305 \(say) one week. (This only goes for mail groups and the like, of
1307 :group 'nnmail-expire
1308 :type '(choice (const nil)
1311 (defcustom gnus-group-uncollapsed-levels 1
1312 "Number of group name elements to leave alone when making a short group name."
1313 :group 'gnus-group-visual
1316 (defcustom gnus-group-use-permanent-levels nil
1317 "*If non-nil, once you set a level, Gnus will use this level."
1318 :group 'gnus-group-levels
1323 (defcustom gnus-load-hook nil
1324 "A hook run while Gnus is loaded."
1328 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1329 "A hook called to apply kill files to a group.
1330 This hook is intended to apply a kill file to the selected newsgroup.
1331 The function `gnus-apply-kill-file' is called by default.
1333 Since a general kill file is too heavy to use only for a few
1334 newsgroups, I recommend you to use a lighter hook function. For
1335 example, if you'd like to apply a kill file to articles which contains
1336 a string `rmgroup' in subject in newsgroup `control', you can use the
1339 (setq gnus-apply-kill-hook
1342 (cond ((string-match \"control\" gnus-newsgroup-name)
1343 (gnus-kill \"Subject\" \"rmgroup\")
1344 (gnus-expunge \"X\"))))))"
1345 :group 'gnus-score-kill
1346 :options '(gnus-apply-kill-file)
1349 (defcustom gnus-group-change-level-function nil
1350 "Function run when a group level is changed.
1351 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1352 :group 'gnus-group-levels
1357 (defcustom gnus-visual
1358 '(summary-highlight group-highlight article-highlight
1360 summary-menu group-menu article-menu
1361 tree-highlight menu highlight
1362 browse-menu server-menu
1363 page-marker tree-menu binary-menu pick-menu
1365 "*Enable visual features.
1366 If `visual' is disabled, there will be no menus and few faces. Most of
1367 the visual customization options below will be ignored. Gnus will use
1368 less space and be faster as a result.
1370 This variable can also be a list of visual elements to switch on. For
1371 instance, to switch off all visual things except menus, you can say:
1373 (setq gnus-visual '(menu))
1375 Valid elements include `summary-highlight', `group-highlight',
1376 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1377 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1378 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1379 and `grouplens-menu'."
1382 :type '(set (const summary-highlight)
1383 (const group-highlight)
1384 (const article-highlight)
1386 (const summary-menu)
1388 (const article-menu)
1389 (const tree-highlight)
1398 (const grouplens-menu)))
1400 (defcustom gnus-mouse-face
1402 (if (gnus-visual-p 'mouse-face 'highlight)
1403 (if (boundp 'gnus-mouse-face)
1404 (or gnus-mouse-face 'highlight)
1408 "*Face used for group or summary buffer mouse highlighting.
1409 The line beneath the mouse pointer will be highlighted with this
1414 (defcustom gnus-article-save-directory gnus-directory
1415 "*Name of the directory articles will be saved in (default \"~/News\")."
1416 :group 'gnus-article-saving
1419 (defvar gnus-plugged t
1420 "Whether Gnus is plugged or not.")
1422 (defcustom gnus-default-charset 'iso-8859-1
1423 "Default charset assumed to be used when viewing non-ASCII characters.
1424 This variable is overridden on a group-to-group basis by the
1425 gnus-group-charset-alist variable and is only used on groups not
1426 covered by that variable."
1428 :group 'gnus-charset)
1430 (defcustom gnus-default-posting-charset nil
1431 "Default charset assumed to be used when posting non-ASCII characters.
1432 This variable is overridden on a group-to-group basis by the
1433 gnus-group-posting-charset-alist variable and is only used on groups not
1434 covered by that variable.
1435 If nil, no default charset is assumed when posting."
1437 :group 'gnus-charset)
1440 ;;; Internal variables
1442 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1443 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1444 (defvar gnus-original-article-buffer " *Original Article*")
1445 (defvar gnus-newsgroup-name nil)
1446 (defvar gnus-ephemeral-servers nil)
1448 (defvar gnus-agent nil
1449 "Whether we want to use the Gnus agent or not.")
1451 (defvar gnus-command-method nil
1452 "Dynamically bound variable that says what the current backend is.")
1454 (defvar gnus-current-select-method nil
1455 "The current method for selecting a newsgroup.")
1457 (defvar gnus-tree-buffer "*Tree*"
1458 "Buffer where Gnus thread trees are displayed.")
1461 (defvar gnus-use-generic-from nil)
1463 ;; Variable holding the user answers to all method prompts.
1464 (defvar gnus-method-history nil)
1466 ;; Variable holding the user answers to all mail method prompts.
1467 (defvar gnus-mail-method-history nil)
1469 ;; Variable holding the user answers to all group prompts.
1470 (defvar gnus-group-history nil)
1472 (defvar gnus-server-alist nil
1473 "List of available servers.")
1475 (defcustom gnus-cache-directory
1476 (nnheader-concat gnus-directory "cache/")
1477 "*The directory where cached articles will be stored."
1481 (defvar gnus-predefined-server-alist
1484 (nnspool-spool-directory ,gnus-cache-directory)
1485 (nnspool-nov-directory ,gnus-cache-directory)
1486 (nnspool-active-file
1487 ,(nnheader-concat gnus-cache-directory "active"))))
1488 "List of predefined (convenience) servers.")
1490 (defvar gnus-topic-indentation "");; Obsolete variable.
1492 (defconst gnus-article-mark-lists
1493 '((marked . tick) (replied . reply)
1494 (expirable . expire) (killed . killed)
1495 (bookmarks . bookmark) (dormant . dormant)
1496 (scored . score) (saved . save)
1497 (cached . cache) (downloadable . download)
1498 (unsendable . unsend)))
1500 (defvar gnus-headers-retrieved-by nil)
1501 (defvar gnus-article-reply nil)
1502 (defvar gnus-override-method nil)
1503 (defvar gnus-article-check-size nil)
1504 (defvar gnus-opened-servers nil)
1506 (defvar gnus-current-kill-article nil)
1508 (defvar gnus-have-read-active-file nil)
1510 (defconst gnus-maintainer
1511 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1512 "The mail address of the Gnus maintainers.")
1514 (defvar gnus-info-nodes
1515 '((gnus-group-mode "(gnus)The Group Buffer")
1516 (gnus-summary-mode "(gnus)The Summary Buffer")
1517 (gnus-article-mode "(gnus)The Article Buffer")
1518 (gnus-server-mode "(gnus)The Server Buffer")
1519 (gnus-browse-mode "(gnus)Browse Foreign Server")
1520 (gnus-tree-mode "(gnus)Tree Display"))
1521 "Alist of major modes and related Info nodes.")
1523 (defvar gnus-group-buffer "*Group*")
1524 (defvar gnus-summary-buffer "*Summary*")
1525 (defvar gnus-article-buffer "*Article*")
1526 (defvar gnus-server-buffer "*Server*")
1528 (defvar gnus-slave nil
1529 "Whether this Gnus is a slave or not.")
1531 (defvar gnus-batch-mode nil
1532 "Whether this Gnus is running in batch mode or not.")
1534 (defvar gnus-variable-list
1535 '(gnus-newsrc-options gnus-newsrc-options-n
1536 gnus-newsrc-last-checked-date
1537 gnus-newsrc-alist gnus-server-alist
1538 gnus-killed-list gnus-zombie-list
1539 gnus-topic-topology gnus-topic-alist
1541 "Gnus variables saved in the quick startup file.")
1543 (defvar gnus-newsrc-alist nil
1544 "Assoc list of read articles.
1545 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1547 (defvar gnus-newsrc-hashtb nil
1548 "Hashtable of gnus-newsrc-alist.")
1550 (defvar gnus-killed-list nil
1551 "List of killed newsgroups.")
1553 (defvar gnus-killed-hashtb nil
1554 "Hash table equivalent of gnus-killed-list.")
1556 (defvar gnus-zombie-list nil
1557 "List of almost dead newsgroups.")
1559 (defvar gnus-description-hashtb nil
1560 "Descriptions of newsgroups.")
1562 (defvar gnus-list-of-killed-groups nil
1563 "List of newsgroups that have recently been killed by the user.")
1565 (defvar gnus-active-hashtb nil
1566 "Hashtable of active articles.")
1568 (defvar gnus-moderated-hashtb nil
1569 "Hashtable of moderated newsgroups.")
1571 ;; Save window configuration.
1572 (defvar gnus-prev-winconf nil)
1574 (defvar gnus-reffed-article-number nil)
1576 ;;; Let the byte-compiler know that we know about this variable.
1577 (defvar rmail-default-rmail-file)
1579 (defvar gnus-dead-summary nil)
1581 ;;; End of variables.
1583 ;; Define some autoload functions Gnus might use.
1586 ;; This little mapcar goes through the list below and marks the
1587 ;; symbols in question as autoloaded functions.
1590 (let ((interactive (nth 1 (memq ':interactive package))))
1594 (when (consp function)
1595 (setq keymap (car (memq 'keymap function)))
1596 (setq function (car function)))
1597 (autoload function (car package) nil interactive keymap)))
1598 (if (eq (nth 1 package) ':interactive)
1601 '(("metamail" metamail-buffer)
1602 ("info" Info-goto-node)
1603 ("pp" pp pp-to-string pp-eval-expression)
1604 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1605 ("ps-print" ps-print-preprint)
1606 ("mail-extr" mail-extract-address-components)
1607 ("browse-url" browse-url)
1608 ("message" :interactive t
1609 message-send-and-exit message-yank-original)
1610 ("babel" babel-as-string)
1611 ("nnmail" nnmail-split-fancy nnmail-article-group)
1612 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1613 ("rmailout" rmail-output rmail-output-to-rmail-file)
1614 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1615 rmail-show-message rmail-summary-exists
1616 rmail-select-summary rmail-update-summary)
1617 ("gnus-audio" :interactive t gnus-audio-play)
1618 ("gnus-xmas" gnus-xmas-splash)
1619 ("gnus-soup" :interactive t
1620 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1621 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1622 ("nnsoup" nnsoup-pack-replies)
1623 ("score-mode" :interactive t gnus-score-mode)
1624 ("gnus-mh" gnus-summary-save-article-folder
1625 gnus-Folder-save-name gnus-folder-save-name)
1626 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1627 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1628 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1629 gnus-demon-add-disconnection gnus-demon-add-handler
1630 gnus-demon-remove-handler)
1631 ("gnus-demon" :interactive t
1632 gnus-demon-init gnus-demon-cancel)
1633 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1634 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1635 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1636 gnus-nocem-unwanted-article-p)
1637 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1638 gnus-server-server-name)
1639 ("gnus-srvr" gnus-browse-foreign-server)
1640 ("gnus-cite" :interactive t
1641 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1642 gnus-article-hide-citation gnus-article-fill-cited-article
1643 gnus-article-hide-citation-in-followups)
1644 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1645 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1646 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1647 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1648 gnus-cache-possibly-remove-articles gnus-cache-request-article
1649 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1650 gnus-cache-enter-remove-article gnus-cached-article-p
1651 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1652 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1653 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1654 ("gnus-score" :interactive t
1655 gnus-summary-increase-score gnus-summary-set-score
1656 gnus-summary-raise-thread gnus-summary-raise-same-subject
1657 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1658 gnus-summary-lower-thread gnus-summary-lower-same-subject
1659 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1660 gnus-summary-current-score gnus-score-default
1661 gnus-score-flush-cache gnus-score-close
1662 gnus-possibly-score-headers gnus-score-followup-article
1663 gnus-score-followup-thread)
1665 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1666 gnus-current-score-file-nondirectory gnus-score-adaptive
1667 gnus-score-find-trace gnus-score-file-name)
1668 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1669 ("gnus-topic" :interactive t gnus-topic-mode)
1670 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1671 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1672 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1673 ("gnus-uu" :interactive t
1674 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1675 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1676 gnus-uu-mark-by-regexp gnus-uu-mark-all
1677 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1678 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1679 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1680 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1681 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1682 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1683 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1684 gnus-uu-mark-over gnus-uu-post-news)
1685 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1686 ("gnus-msg" (gnus-summary-send-map keymap)
1687 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1688 ("gnus-msg" :interactive t
1689 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1690 gnus-summary-followup gnus-summary-followup-with-original
1691 gnus-summary-cancel-article gnus-summary-supersede-article
1692 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1693 gnus-summary-mail-forward gnus-summary-mail-other-window
1694 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1695 gnus-summary-wide-reply gnus-summary-followup-to-mail
1696 gnus-summary-followup-to-mail-with-original gnus-bug
1697 gnus-summary-wide-reply-with-original
1698 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1699 gnus-summary-post-forward)
1700 ("gnus-picon" :interactive t gnus-article-display-picons
1701 gnus-group-display-picons gnus-picons-article-display-x-face
1702 gnus-picons-display-x-face)
1703 ("gnus-picon" gnus-picons-buffer-name)
1704 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1705 gnus-grouplens-mode)
1706 ("smiley" :interactive t gnus-smiley-display)
1707 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1708 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1709 gnus-list-of-unread-articles gnus-list-of-read-articles
1710 gnus-offer-save-summaries gnus-make-thread-indent-array
1711 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1712 gnus-summary-skip-intangible gnus-summary-article-number
1713 gnus-data-header gnus-data-find)
1714 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1715 gnus-group-list-groups gnus-group-first-unread-group
1716 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1717 gnus-group-setup-buffer gnus-group-get-new-news
1718 gnus-group-make-help-group gnus-group-update-group
1719 gnus-group-iterate gnus-group-group-name)
1720 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1721 gnus-backlog-remove-article)
1722 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1723 gnus-article-prepare gnus-article-set-window-start
1724 gnus-article-next-page gnus-article-prev-page
1725 gnus-request-article-this-buffer gnus-article-mode
1726 gnus-article-setup-buffer gnus-narrow-to-page
1727 gnus-article-delete-invisible-text gnus-treat-article)
1728 ("gnus-art" :interactive t
1729 gnus-article-hide-headers gnus-article-hide-boring-headers
1730 gnus-article-treat-overstrike
1731 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1732 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1733 gnus-article-hide-pgp
1734 gnus-article-hide-pem gnus-article-hide-signature
1735 gnus-article-strip-leading-blank-lines gnus-article-date-local
1736 gnus-article-date-original gnus-article-date-lapsed
1737 gnus-article-show-all-headers
1738 gnus-article-edit-mode gnus-article-edit-article
1739 gnus-article-edit-done gnus-article-decode-encoded-words
1740 gnus-start-date-timer gnus-stop-date-timer
1741 gnus-mime-view-all-parts)
1742 ("gnus-int" gnus-request-type)
1743 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1744 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1745 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1746 gnus-dup-enter-articles)
1747 ("gnus-range" gnus-copy-sequence)
1748 ("gnus-eform" gnus-edit-form)
1749 ("gnus-move" :interactive t
1750 gnus-group-move-group-to-server gnus-change-server)
1751 ("gnus-logic" gnus-score-advanced)
1752 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1753 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1754 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1755 gnus-async-halt-prefetch)
1756 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1757 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1758 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1759 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1760 ("gnus-agent" :interactive t
1761 gnus-unplugged gnus-agentize gnus-agent-batch)
1762 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1763 gnus-summary-save-article-vm)
1764 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1765 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1766 ("gnus-mlspl" :interactive t gnus-group-split-setup
1767 gnus-group-split-update))))
1769 ;;; gnus-sum.el thingies
1772 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1773 "*The format specification of the lines in the summary buffer.
1775 It works along the same lines as a normal formatting string,
1776 with some simple extensions.
1778 %N Article number, left padded with spaces (string)
1780 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1781 %n Name of the poster (string)
1782 %a Extracted name of the poster (string)
1783 %A Extracted address of the poster (string)
1784 %F Contents of the From: header (string)
1785 %f Contents of the From: or To: headers (string)
1786 %x Contents of the Xref: header (string)
1787 %D Date of the article (string)
1788 %d Date of the article (string) in DD-MMM format
1789 %M Message-id of the article (string)
1790 %r References of the article (string)
1791 %c Number of characters in the article (integer)
1792 %L Number of lines in the article (integer)
1793 %I Indentation based on thread level (a string of spaces)
1794 %T A string with two possible values: 80 spaces if the article
1795 is on thread level two or larger and 0 spaces on level one
1796 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1797 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1798 %[ Opening bracket (character, \"[\" or \"<\")
1799 %] Closing bracket (character, \"]\" or \">\")
1800 %> Spaces of length thread-level (string)
1801 %< Spaces of length (- 20 thread-level) (string)
1802 %i Article score (number)
1803 %z Article zcore (character)
1804 %t Number of articles under the current thread (number).
1805 %e Whether the thread is empty or not (character).
1806 %l GroupLens score (string).
1807 %V Total thread score (number).
1808 %P The line number (number).
1809 %O Download mark (character).
1810 %u User defined specifier. The next character in the format string should
1811 be a letter. Gnus will call the function gnus-user-format-function-X,
1812 where X is the letter following %u. The function will be passed the
1813 current header as argument. The function should return a string, which
1814 will be inserted into the summary just like information from any other
1817 Text between %( and %) will be highlighted with `gnus-mouse-face'
1818 when the mouse point is placed inside the area. There can only be one
1821 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1822 with care. For reasons of efficiency, Gnus will compute what column
1823 these characters will end up in, and \"hard-code\" that. This means that
1824 it is invalid to have these specs after a variable-length spec. Well,
1825 you might not be arrested, but your summary buffer will look strange,
1826 which is bad enough.
1828 The smart choice is to have these specs as for to the left as
1831 This restriction may disappear in later versions of Gnus."
1833 :group 'gnus-summary-format)
1836 ;;; Skeleton keymaps
1839 (defun gnus-suppress-keymap (keymap)
1840 (suppress-keymap keymap)
1841 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1843 (define-key keymap (pop keys) 'undefined))))
1845 (defvar gnus-article-mode-map
1846 (let ((keymap (make-sparse-keymap)))
1847 (gnus-suppress-keymap keymap)
1849 (defvar gnus-summary-mode-map
1850 (let ((keymap (make-keymap)))
1851 (gnus-suppress-keymap keymap)
1853 (defvar gnus-group-mode-map
1854 (let ((keymap (make-keymap)))
1855 (gnus-suppress-keymap keymap)
1860 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1861 ;; If you want the cursor to go somewhere else, set these two
1862 ;; functions in some startup hook to whatever you want.
1863 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1864 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1866 ;;; Various macros and substs.
1868 (defun gnus-header-from (header)
1869 (mail-header-from header))
1871 (defmacro gnus-gethash (string hashtable)
1872 "Get hash value of STRING in HASHTABLE."
1873 `(symbol-value (intern-soft ,string ,hashtable)))
1875 (defmacro gnus-sethash (string value hashtable)
1876 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1877 `(set (intern ,string ,hashtable) ,value))
1878 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1880 (defmacro gnus-group-unread (group)
1881 "Get the currently computed number of unread articles in GROUP."
1882 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1884 (defmacro gnus-group-entry (group)
1885 "Get the newsrc entry for GROUP."
1886 `(gnus-gethash ,group gnus-newsrc-hashtb))
1888 (defmacro gnus-active (group)
1889 "Get active info on GROUP."
1890 `(gnus-gethash ,group gnus-active-hashtb))
1892 (defmacro gnus-set-active (group active)
1893 "Set GROUP's active info."
1894 `(gnus-sethash ,group ,active gnus-active-hashtb))
1896 ;; Info access macros.
1898 (defmacro gnus-info-group (info)
1900 (defmacro gnus-info-rank (info)
1902 (defmacro gnus-info-read (info)
1904 (defmacro gnus-info-marks (info)
1906 (defmacro gnus-info-method (info)
1908 (defmacro gnus-info-params (info)
1911 (defmacro gnus-info-level (info)
1912 `(let ((rank (gnus-info-rank ,info)))
1916 (defmacro gnus-info-score (info)
1917 `(let ((rank (gnus-info-rank ,info)))
1918 (or (and (consp rank) (cdr rank)) 0)))
1920 (defmacro gnus-info-set-group (info group)
1921 `(setcar ,info ,group))
1922 (defmacro gnus-info-set-rank (info rank)
1923 `(setcar (nthcdr 1 ,info) ,rank))
1924 (defmacro gnus-info-set-read (info read)
1925 `(setcar (nthcdr 2 ,info) ,read))
1926 (defmacro gnus-info-set-marks (info marks &optional extend)
1928 `(gnus-info-set-entry ,info ,marks 3)
1929 `(setcar (nthcdr 3 ,info) ,marks)))
1930 (defmacro gnus-info-set-method (info method &optional extend)
1932 `(gnus-info-set-entry ,info ,method 4)
1933 `(setcar (nthcdr 4 ,info) ,method)))
1934 (defmacro gnus-info-set-params (info params &optional extend)
1936 `(gnus-info-set-entry ,info ,params 5)
1937 `(setcar (nthcdr 5 ,info) ,params)))
1939 (defun gnus-info-set-entry (info entry number)
1940 ;; Extend the info until we have enough elements.
1941 (while (<= (length info) number)
1942 (nconc info (list nil)))
1944 (setcar (nthcdr number info) entry))
1946 (defmacro gnus-info-set-level (info level)
1947 `(let ((rank (cdr ,info)))
1948 (if (consp (car rank))
1949 (setcar (car rank) ,level)
1950 (setcar rank ,level))))
1951 (defmacro gnus-info-set-score (info score)
1952 `(let ((rank (cdr ,info)))
1953 (if (consp (car rank))
1954 (setcdr (car rank) ,score)
1955 (setcar rank (cons (car rank) ,score)))))
1957 (defmacro gnus-get-info (group)
1958 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1960 ;; Byte-compiler warning.
1961 (defvar gnus-visual)
1962 ;; Find out whether the gnus-visual TYPE is wanted.
1963 (defun gnus-visual-p (&optional type class)
1964 (and gnus-visual ; Has to be non-nil, at least.
1965 (if (not type) ; We don't care about type.
1967 (if (listp gnus-visual) ; It's a list, so we check it.
1968 (or (memq type gnus-visual)
1969 (memq class gnus-visual))
1972 ;;; Load the compatability functions.
1981 (defvar gnus-shutdown-alist nil)
1983 (defun gnus-add-shutdown (function &rest symbols)
1984 "Run FUNCTION whenever one of SYMBOLS is shut down."
1985 (push (cons function symbols) gnus-shutdown-alist))
1987 (defun gnus-shutdown (symbol)
1988 "Shut down everything that waits for SYMBOL."
1989 (let ((alist gnus-shutdown-alist)
1991 (while (setq entry (pop alist))
1992 (when (memq symbol (cdr entry))
1993 (funcall (car entry))))))
1997 ;;; Gnus Utility Functions
2001 (defmacro gnus-string-or (&rest strings)
2002 "Return the first element of STRINGS that is a non-blank string.
2003 STRINGS will be evaluated in normal `or' order."
2004 `(gnus-string-or-1 ',strings))
2006 (defun gnus-string-or-1 (strings)
2009 (setq string (eval (pop strings)))
2010 (if (string-match "^[ \t]*$" string)
2012 (setq strings nil)))
2015 (defun gnus-version (&optional arg)
2016 "Version number of this version of Gnus.
2017 If ARG, insert string at point."
2020 (insert (message gnus-version))
2021 (message gnus-version)))
2023 (defun gnus-continuum-version (version)
2024 "Return VERSION as a floating point number."
2025 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2026 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2027 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2028 (number (match-string 2 version))
2030 (unless (string-match
2031 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2032 (error "Invalid version string: %s" version))
2033 (setq major (string-to-number (match-string 1 number))
2034 minor (string-to-number (match-string 2 number))
2035 least (if (match-beginning 3)
2036 (string-to-number (match-string 3 number))
2040 (format "%s00%02d%02d"
2041 (if (member alpha '("(ding)" "d"))
2045 (- (mm-char-int (aref (downcase alpha) 0))
2049 (format "%d.%02d%02d" major minor least))))))
2051 (defun gnus-info-find-node ()
2052 "Find Info documentation of Gnus."
2054 ;; Enlarge info window if needed.
2055 (let (gnus-info-buffer)
2056 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2057 (setq gnus-info-buffer (current-buffer))
2058 (gnus-configure-windows 'info)))
2061 ;;; gnus-interactive
2064 (defvar gnus-current-prefix-symbol nil
2065 "Current prefix symbol.")
2067 (defvar gnus-current-prefix-symbols nil
2068 "List of current prefix symbols.")
2070 (defun gnus-interactive (string &optional params)
2071 "Return a list that can be fed to `interactive'.
2072 See `interactive' for full documentation.
2074 Adds the following specs:
2076 y -- The current symbolic prefix.
2077 Y -- A list of the current symbolic prefix(es).
2078 A -- Article number.
2079 H -- Article header.
2083 (while (< i (length string))
2084 (string-match ".\\([^\n]*\\)\n?" string i)
2085 (setq c (aref string i))
2087 (setq prompt (match-string 1 string)))
2088 (setq i (match-end 0))
2089 ;; We basically emulate just about everything that
2090 ;; `interactive' does, but add the specs listed above.
2094 (completing-read prompt obarray 'fboundp t))
2096 (read-buffer prompt (current-buffer) t))
2098 (read-buffer prompt (other-buffer (current-buffer))))
2102 (completing-read prompt obarray 'commandp t))
2106 (read-file-name prompt nil default-directory 'lambda))
2108 (read-file-name prompt nil nil 'lambda))
2110 (read-file-name prompt))
2112 (read-key-sequence prompt))
2114 (error "Not implemented spec"))
2116 (error "Not implemented spec"))
2120 (error "Not implemented spec"))
2122 (string-to-number (read-from-minibuffer prompt)))
2124 (prefix-numeric-value current-prefix-arg))
2130 (read-string prompt))
2132 (intern (read-string prompt)))
2134 (read-variable prompt))
2136 (read-minibuffer prompt))
2138 (eval-minibuffer prompt))
2139 ;; And here the new specs come.
2141 gnus-current-prefix-symbol)
2143 gnus-current-prefix-symbols)
2145 (gnus-group-group-name))
2147 (gnus-summary-skip-intangible)
2148 (or (get-text-property (point) 'gnus-number)
2149 (gnus-summary-last-subject)))
2151 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2153 (error "Non-implemented spec")))
2157 (push (if (< (point) (mark) (point) (mark))) out)
2158 (push (if (> (point) (mark) (point) (mark))) out))))
2159 (setq out (delq 'gnus-prefix-nil out))
2162 (defun gnus-symbolic-argument (&optional arg)
2163 "Read a symbolic argument and a command, and then execute command."
2165 (let* ((in-command (this-command-keys))
2166 (command in-command)
2167 gnus-current-prefix-symbols
2168 gnus-current-prefix-symbol
2170 (while (equal in-command command)
2171 (message "%s-" (key-description (this-command-keys)))
2172 (push (intern (char-to-string (read-char))) syms)
2173 (setq command (read-key-sequence nil t)))
2174 (setq gnus-current-prefix-symbols (nreverse syms)
2175 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2176 (call-interactively (key-binding command t))))
2178 ;;; More various functions.
2180 (defsubst gnus-check-backend-function (func group)
2181 "Check whether GROUP supports function FUNC.
2182 GROUP can either be a string (a group name) or a select method."
2184 (let ((method (if (stringp group)
2185 (car (gnus-find-method-for-group group))
2187 (unless (featurep method)
2189 (fboundp (intern (format "%s-%s" method func))))))
2191 (defun gnus-group-read-only-p (&optional group)
2192 "Check whether GROUP supports editing or not.
2193 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2194 that that variable is buffer-local to the summary buffers."
2195 (let ((group (or group gnus-newsgroup-name)))
2196 (not (gnus-check-backend-function 'request-replace-article group))))
2198 (defun gnus-group-total-expirable-p (group)
2199 "Check whether GROUP is total-expirable or not."
2200 (let ((params (gnus-group-find-parameter group))
2203 ((memq 'total-expire params)
2205 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2207 (gnus-total-expirable-newsgroups ; Check var.
2208 (string-match gnus-total-expirable-newsgroups group)))))
2210 (defun gnus-group-auto-expirable-p (group)
2211 "Check whether GROUP is auto-expirable or not."
2212 (let ((params (gnus-group-find-parameter group))
2215 ((memq 'auto-expire params)
2217 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2219 (gnus-auto-expirable-newsgroups ; Check var.
2220 (string-match gnus-auto-expirable-newsgroups group)))))
2222 (defun gnus-virtual-group-p (group)
2223 "Say whether GROUP is virtual or not."
2224 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2225 gnus-valid-select-methods)))
2227 (defun gnus-news-group-p (group &optional article)
2228 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2229 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2230 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2231 (if (or (null article)
2232 (not (< article 0)))
2233 (eq (gnus-request-type group article) 'news)
2234 (if (not (vectorp article))
2236 ;; It's a real article.
2237 (eq (gnus-request-type group (mail-header-id article))
2240 ;; Returns a list of writable groups.
2241 (defun gnus-writable-groups ()
2242 (let ((alist gnus-newsrc-alist)
2244 (while (setq group (car (pop alist)))
2245 (unless (gnus-group-read-only-p group)
2246 (push group groups)))
2249 ;; Check whether to use long file names.
2250 (defun gnus-use-long-file-name (symbol)
2251 ;; The variable has to be set...
2252 (and gnus-use-long-file-name
2253 ;; If it isn't a list, then we return t.
2254 (or (not (listp gnus-use-long-file-name))
2255 ;; If it is a list, and the list contains `symbol', we
2257 (not (memq symbol gnus-use-long-file-name)))))
2259 ;; Generate a unique new group name.
2260 (defun gnus-generate-new-group-name (leaf)
2263 (while (gnus-gethash name gnus-newsrc-hashtb)
2264 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2267 (defun gnus-ephemeral-group-p (group)
2268 "Say whether GROUP is ephemeral or not."
2269 (gnus-group-get-parameter group 'quit-config t))
2271 (defun gnus-group-quit-config (group)
2272 "Return the quit-config of GROUP."
2273 (gnus-group-get-parameter group 'quit-config t))
2275 (defun gnus-kill-ephemeral-group (group)
2276 "Remove ephemeral GROUP from relevant structures."
2277 (gnus-sethash group nil gnus-newsrc-hashtb))
2279 (defun gnus-simplify-mode-line ()
2280 "Make mode lines a bit simpler."
2281 (setq mode-line-modified (cdr gnus-mode-line-modified))
2282 (when (listp mode-line-format)
2283 (make-local-variable 'mode-line-format)
2284 (setq mode-line-format (copy-sequence mode-line-format))
2285 (when (equal (nth 3 mode-line-format) " ")
2286 (setcar (nthcdr 3 mode-line-format) " "))))
2288 ;;; Servers and groups.
2290 (defsubst gnus-server-add-address (method)
2291 (let ((method-name (symbol-name (car method))))
2292 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2293 (not (assq (intern (concat method-name "-address")) method))
2294 (memq 'physical-address (assq (car method)
2295 gnus-valid-select-methods)))
2296 (append method (list (list (intern (concat method-name "-address"))
2300 (defsubst gnus-server-get-method (group method)
2301 ;; Input either a server name, and extended server name, or a
2302 ;; select method, and return a select method.
2303 (cond ((stringp method)
2304 (gnus-server-to-method method))
2305 ((equal method gnus-select-method)
2307 ((and (stringp (car method))
2309 (gnus-server-extend-method group method))
2312 (equal (cadr method) ""))
2315 (gnus-server-add-address method))))
2317 (defun gnus-server-to-method (server)
2318 "Map virtual server names to select methods."
2320 ;; Is this a method, perhaps?
2321 (and server (listp server) server)
2322 ;; Perhaps this is the native server?
2323 (and (equal server "native") gnus-select-method)
2324 ;; It should be in the server alist.
2325 (cdr (assoc server gnus-server-alist))
2326 ;; It could be in the predefined server alist.
2327 (cdr (assoc server gnus-predefined-server-alist))
2328 ;; If not, we look through all the opened server
2329 ;; to see whether we can find it there.
2330 (let ((opened gnus-opened-servers))
2332 (not (equal server (format "%s:%s" (caaar opened)
2336 ;; It could be a named method, search all servers
2337 (let ((servers gnus-secondary-select-methods))
2339 (not (equal server (format "%s:%s" (caar servers)
2344 (defmacro gnus-method-equal (ss1 ss2)
2345 "Say whether two servers are equal."
2349 (and (= (length s1) (length s2))
2351 (while (and s1 (member (car s1) s2))
2355 (defun gnus-methods-equal-p (m1 m2)
2356 (let ((m1 (or m1 gnus-select-method))
2357 (m2 (or m2 gnus-select-method)))
2359 (and (eq (car m1) (car m2))
2360 (or (not (memq 'address (assoc (symbol-name (car m1))
2361 gnus-valid-select-methods)))
2362 (equal (nth 1 m1) (nth 1 m2)))))))
2364 (defun gnus-server-equal (m1 m2)
2365 "Say whether two methods are equal."
2366 (let ((m1 (cond ((null m1) gnus-select-method)
2367 ((stringp m1) (gnus-server-to-method m1))
2369 (m2 (cond ((null m2) gnus-select-method)
2370 ((stringp m2) (gnus-server-to-method m2))
2372 (gnus-method-equal m1 m2)))
2374 (defun gnus-servers-using-backend (backend)
2375 "Return a list of known servers using BACKEND."
2376 (let ((opened gnus-opened-servers)
2379 (when (eq backend (caaar opened))
2380 (push (caar opened) out))
2384 (defun gnus-archive-server-wanted-p ()
2385 "Say whether the user wants to use the archive server."
2387 ((or (not gnus-message-archive-method)
2388 (not gnus-message-archive-group))
2390 ((and gnus-message-archive-method gnus-message-archive-group)
2393 (let ((active (cadr (assq 'nnfolder-active-file
2394 gnus-message-archive-method))))
2396 (file-exists-p active))))))
2398 (defun gnus-group-prefixed-name (group method)
2399 "Return the whole name from GROUP and METHOD."
2400 (and (stringp method) (setq method (gnus-server-to-method method)))
2401 (if (or (not method)
2402 (gnus-server-equal method "native"))
2404 (concat (format "%s" (car method))
2406 (or (assoc (format "%s" (car method))
2407 (gnus-methods-using 'address))
2408 (gnus-server-equal method gnus-message-archive-method))
2410 (not (string= (nth 1 method) "")))
2411 (concat "+" (nth 1 method)))
2414 (defun gnus-group-real-prefix (group)
2415 "Return the prefix of the current group name."
2416 (if (string-match "^[^:]+:" group)
2417 (substring group 0 (match-end 0))
2420 (defun gnus-group-method (group)
2421 "Return the server or method used for selecting GROUP.
2422 You should probably use `gnus-find-method-for-group' instead."
2423 (let ((prefix (gnus-group-real-prefix group)))
2424 (if (equal prefix "")
2426 (let ((servers gnus-opened-servers)
2428 backend possible found)
2429 (if (string-match "^[^\\+]+\\+" prefix)
2430 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2431 server (substring prefix (match-end 0) (1- (length prefix))))
2432 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2434 (when (eq (caaar servers) backend)
2435 (setq possible (caar servers))
2436 (when (equal (cadaar servers) server)
2437 (setq found (caar servers))))
2439 (or (car (rassoc found gnus-server-alist))
2441 (car (rassoc possible gnus-server-alist))
2443 (list backend server))))))
2445 (defsubst gnus-native-method-p (method)
2446 "Return whether METHOD is the native select method."
2447 (gnus-method-equal method gnus-select-method))
2449 (defsubst gnus-secondary-method-p (method)
2450 "Return whether METHOD is a secondary select method."
2451 (let ((methods gnus-secondary-select-methods)
2452 (gmethod (gnus-server-get-method nil method)))
2454 (not (gnus-method-equal
2455 (gnus-server-get-method nil (car methods))
2457 (setq methods (cdr methods)))
2460 (defun gnus-method-simplify (method)
2461 "Return the shortest uniquely identifying string or method for METHOD."
2462 (cond ((stringp method)
2464 ((gnus-native-method-p method)
2466 ((gnus-secondary-method-p method)
2467 (format "%s:%s" (nth 0 method) (nth 1 method)))
2471 (defun gnus-groups-from-server (server)
2472 "Return a list of all groups that are fetched from SERVER."
2473 (let ((alist (cdr gnus-newsrc-alist))
2475 (while (setq info (pop alist))
2476 (when (gnus-server-equal (gnus-info-method info) server)
2477 (push (gnus-info-group info) groups)))
2478 (sort groups 'string<)))
2480 (defun gnus-group-foreign-p (group)
2481 "Say whether a group is foreign or not."
2482 (and (not (gnus-group-native-p group))
2483 (not (gnus-group-secondary-p group))))
2485 (defun gnus-group-native-p (group)
2486 "Say whether the group is native or not."
2487 (not (string-match ":" group)))
2489 (defun gnus-group-secondary-p (group)
2490 "Say whether the group is secondary or not."
2491 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2493 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2494 "Return the group parameters for GROUP.
2495 If SYMBOL, return the value of that symbol in the group parameters."
2497 (set-buffer gnus-group-buffer)
2498 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2500 (gnus-group-parameter-value parameters symbol allow-list)
2503 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2504 "Return the group parameters for GROUP.
2505 If SYMBOL, return the value of that symbol in the group parameters.
2506 Most functions should use `gnus-group-find-parameter', which
2507 also examines the topic parameters."
2508 (let ((params (gnus-info-params (gnus-get-info group))))
2510 (gnus-group-parameter-value params symbol allow-list)
2513 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2514 "Return the value of SYMBOL in group PARAMS."
2515 ;; We only wish to return group parameters (dotted lists) and
2516 ;; not local variables, which may have the same names.
2517 ;; But first we handle single elements...
2518 (or (car (memq symbol params))
2522 (while (setq elem (pop params))
2523 (when (and (consp elem)
2524 (eq (car elem) symbol)
2527 (throw 'found (cdr elem))))))))
2529 (defun gnus-group-add-parameter (group param)
2530 "Add parameter PARAM to GROUP."
2531 (let ((info (gnus-get-info group)))
2533 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2534 ;; Cons the new param to the old one and update.
2535 (gnus-group-set-info (cons param (gnus-info-params info))
2538 (defun gnus-group-set-parameter (group name value)
2539 "Set parameter NAME to VALUE in GROUP."
2540 (let ((info (gnus-get-info group)))
2542 (gnus-group-remove-parameter group name)
2543 (let ((old-params (gnus-info-params info))
2544 (new-params (list (cons name value))))
2546 (when (or (not (listp (car old-params)))
2547 (not (eq (caar old-params) name)))
2548 (setq new-params (append new-params (list (car old-params)))))
2549 (setq old-params (cdr old-params)))
2550 (gnus-group-set-info new-params group 'params)))))
2552 (defun gnus-group-remove-parameter (group name)
2553 "Remove parameter NAME from GROUP."
2554 (let ((info (gnus-get-info group)))
2556 (let ((params (gnus-info-params info)))
2558 (setq params (delq name params))
2559 (while (assq name params)
2560 (gnus-pull name params))
2561 (gnus-info-set-params info params))))))
2563 (defun gnus-group-add-score (group &optional score)
2564 "Add SCORE to the GROUP score.
2565 If SCORE is nil, add 1 to the score of GROUP."
2566 (let ((info (gnus-get-info group)))
2568 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2570 (defun gnus-short-group-name (group &optional levels)
2571 "Collapse GROUP name LEVELS.
2572 Select methods are stripped and any remote host name is stripped down to
2573 just the host name."
2579 gnus-group-uncollapsed-levels
2581 (while (string-match "\\." group skip)
2582 (setq skip (match-end 0)
2585 ;; Separate foreign select method from group name and collapse.
2586 ;; If method contains a server, collapse to non-domain server name,
2587 ;; otherwise collapse to select method.
2588 (let* ((colon (string-match ":" group))
2589 (server (and colon (substring group 0 colon)))
2590 (plus (and server (string-match "+" server))))
2593 (setq foreign (substring server (+ 1 plus)
2594 (string-match "\\." server))
2595 group (substring group (+ 1 colon)))
2596 (setq foreign server
2597 group (substring group (+ 1 colon))))
2598 (setq foreign (concat foreign ":")))
2599 ;; Collapse group name leaving LEVELS uncollapsed elements
2600 (let* ((glist (split-string group "\\."))
2601 (glen (length glist))
2603 (setq levels (- glen levels))
2605 (push (if (>= (decf levels) 0)
2609 (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2611 (defun gnus-narrow-to-body ()
2612 "Narrow to the body of an article."
2615 (goto-char (point-min))
2616 (or (search-forward "\n\n" nil t)
2622 ;;; Kill file handling.
2625 (defun gnus-apply-kill-file ()
2626 "Apply a kill file to the current newsgroup.
2627 Returns the number of articles marked as read."
2628 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2629 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2630 (gnus-apply-kill-file-internal)
2633 (defun gnus-kill-save-kill-buffer ()
2634 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2635 (when (get-file-buffer file)
2637 (set-buffer (get-file-buffer file))
2638 (when (buffer-modified-p)
2640 (kill-buffer (current-buffer))))))
2642 (defcustom gnus-kill-file-name "KILL"
2643 "Suffix of the kill files."
2644 :group 'gnus-score-kill
2645 :group 'gnus-score-files
2648 (defun gnus-newsgroup-kill-file (newsgroup)
2649 "Return the name of a kill file name for NEWSGROUP.
2650 If NEWSGROUP is nil, return the global kill file name instead."
2652 ;; The global KILL file is placed at top of the directory.
2653 ((or (null newsgroup)
2654 (string-equal newsgroup ""))
2655 (expand-file-name gnus-kill-file-name
2656 gnus-kill-files-directory))
2657 ;; Append ".KILL" to newsgroup name.
2658 ((gnus-use-long-file-name 'not-kill)
2659 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2660 "." gnus-kill-file-name)
2661 gnus-kill-files-directory))
2662 ;; Place "KILL" under the hierarchical directory.
2664 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2665 "/" gnus-kill-file-name)
2666 gnus-kill-files-directory))))
2670 (defun gnus-member-of-valid (symbol group)
2671 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2673 (symbol-name (car (gnus-find-method-for-group group)))
2674 gnus-valid-select-methods)))
2676 (defun gnus-method-option-p (method option)
2677 "Return non-nil if select METHOD has OPTION as a parameter."
2678 (when (stringp method)
2679 (setq method (gnus-server-to-method method)))
2680 (memq option (assoc (format "%s" (car method))
2681 gnus-valid-select-methods)))
2683 (defun gnus-similar-server-opened (method)
2684 (let ((opened gnus-opened-servers))
2685 (while (and method opened)
2686 (when (and (equal (cadr method) (cadaar opened))
2687 (equal (car method) (caaar opened))
2688 (not (equal method (caar opened))))
2693 (defun gnus-server-extend-method (group method)
2694 ;; This function "extends" a virtual server. If the server is
2695 ;; "hello", and the select method is ("hello" (my-var "something"))
2696 ;; in the group "alt.alt", this will result in a new virtual server
2697 ;; called "hello+alt.alt".
2698 (if (or (not (inline (gnus-similar-server-opened method)))
2699 (not (cddr method)))
2701 `(,(car method) ,(concat (cadr method) "+" group)
2702 (,(intern (format "%s-address" (car method))) ,(cadr method))
2705 (defun gnus-server-status (method)
2706 "Return the status of METHOD."
2707 (nth 1 (assoc method gnus-opened-servers)))
2709 (defun gnus-group-name-to-method (group)
2710 "Guess a select method based on GROUP."
2711 (if (string-match ":" group)
2712 (let ((server (substring group 0 (match-beginning 0))))
2713 (if (string-match "\\+" server)
2714 (list (intern (substring server 0 (match-beginning 0)))
2715 (substring server (match-end 0)))
2716 (list (intern server) "")))
2717 gnus-select-method))
2719 (defun gnus-find-method-for-group (group &optional info)
2720 "Find the select method that GROUP uses."
2721 (or gnus-override-method
2724 (let ((info (or info (gnus-get-info group)))
2727 (not (setq method (gnus-info-method info)))
2728 (equal method "native"))
2731 (cond ((stringp method)
2732 (inline (gnus-server-to-method method)))
2733 ((stringp (cadr method))
2734 (inline (gnus-server-extend-method group method)))
2737 (cond ((equal (cadr method) "")
2739 ((null (cadr method))
2740 (list (car method) ""))
2742 (gnus-server-add-address method)))))))
2744 (defun gnus-methods-using (feature)
2745 "Find all methods that have FEATURE."
2746 (let ((valids gnus-valid-select-methods)
2749 (when (memq feature (car valids))
2750 (push (car valids) outs))
2751 (setq valids (cdr valids)))
2754 (defun gnus-read-group (prompt &optional default)
2755 "Prompt the user for a group name.
2756 Disallow invalid group names."
2762 (setq group (read-string (concat prefix prompt)
2763 (cons (or default "") 0)
2764 'gnus-group-history)))
2765 (setq prefix (format "Invalid group name: \"%s\". " group)
2769 (defun gnus-read-method (prompt)
2770 "Prompt the user for a method.
2771 Allow completion over sensible values."
2773 (append gnus-valid-select-methods
2774 gnus-predefined-server-alist
2779 nil t nil 'gnus-method-history)))
2782 (setq method gnus-select-method))
2783 ((assoc method gnus-valid-select-methods)
2784 (list (intern method)
2785 (if (memq 'prompt-address
2786 (assoc method gnus-valid-select-methods))
2787 (read-string "Address: ")
2789 ((assoc method servers)
2792 (list (intern method) "")))))
2794 ;;; User-level commands.
2797 (defun gnus-slave-no-server (&optional arg)
2798 "Read network news as a slave, without connecting to local server."
2800 (gnus-no-server arg t))
2803 (defun gnus-no-server (&optional arg slave)
2805 If ARG is a positive number, Gnus will use that as the
2806 startup level. If ARG is nil, Gnus will be started at level 2.
2807 If ARG is non-nil and not a positive number, Gnus will
2808 prompt the user for the name of an NNTP server to use.
2809 As opposed to `gnus', this command will not connect to the local server."
2811 (gnus-no-server-1 arg slave))
2814 (defun gnus-slave (&optional arg)
2815 "Read news as a slave."
2817 (gnus arg nil 'slave))
2820 (defun gnus-other-frame (&optional arg)
2821 "Pop up a frame to read news."
2823 (let ((window (get-buffer-window gnus-group-buffer)))
2825 (select-frame (window-frame window)))
2831 (defun gnus (&optional arg dont-connect slave)
2833 If ARG is non-nil and a positive number, Gnus will use that as the
2834 startup level. If ARG is non-nil and not a positive number, Gnus will
2835 prompt the user for the name of an NNTP server to use."
2837 (gnus-1 arg dont-connect slave))
2839 ;; Allow redefinition of Gnus functions.
2845 ;;; gnus.el ends here