1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
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 ;; Make sure it was the right mm-util.
38 (unless (fboundp 'mm-guess-mime-charset)
39 (error "Wrong `mm-util' found in `load-path'. Make sure the Gnus one is found first."))
42 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
46 (defgroup gnus-format nil
47 "Dealing with formatting issues."
51 (defgroup gnus-charset nil
52 "Group character set issues."
53 :link '(custom-manual "(gnus)Charsets")
57 (defgroup gnus-cache nil
61 (defgroup gnus-start nil
62 "Starting your favorite newsreader."
65 (defgroup gnus-start-server nil
66 "Server options at startup."
69 ;; These belong to gnus-group.el.
70 (defgroup gnus-group nil
72 :link '(custom-manual "(gnus)The Group Buffer")
75 (defgroup gnus-group-foreign nil
77 :link '(custom-manual "(gnus)Foreign Groups")
80 (defgroup gnus-group-new nil
81 "Automatic subscription of new groups."
84 (defgroup gnus-group-levels nil
86 :link '(custom-manual "(gnus)Group Levels")
89 (defgroup gnus-group-select nil
91 :link '(custom-manual "(gnus)Selecting a Group")
94 (defgroup gnus-group-listing nil
95 "Showing slices of the group list."
96 :link '(custom-manual "(gnus)Listing Groups")
99 (defgroup gnus-group-visual nil
100 "Sorting the group buffer."
101 :link '(custom-manual "(gnus)Group Buffer Format")
105 (defgroup gnus-group-various nil
106 "Various group options."
107 :link '(custom-manual "(gnus)Scanning New Messages")
110 ;; These belong to gnus-sum.el.
111 (defgroup gnus-summary nil
113 :link '(custom-manual "(gnus)The Summary Buffer")
116 (defgroup gnus-summary-exit nil
117 "Leaving summary buffers."
118 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
119 :group 'gnus-summary)
121 (defgroup gnus-summary-marks nil
122 "Marks used in summary buffers."
123 :link '(custom-manual "(gnus)Marking Articles")
124 :group 'gnus-summary)
126 (defgroup gnus-thread nil
127 "Ordering articles according to replies."
128 :link '(custom-manual "(gnus)Threading")
129 :group 'gnus-summary)
131 (defgroup gnus-summary-format nil
132 "Formatting of the summary buffer."
133 :link '(custom-manual "(gnus)Summary Buffer Format")
134 :group 'gnus-summary)
136 (defgroup gnus-summary-choose nil
138 :link '(custom-manual "(gnus)Choosing Articles")
139 :group 'gnus-summary)
141 (defgroup gnus-summary-maneuvering nil
142 "Summary movement commands."
143 :link '(custom-manual "(gnus)Summary Maneuvering")
144 :group 'gnus-summary)
146 (defgroup gnus-picon nil
147 "Show pictures of people, domains, and newsgroups."
150 (defgroup gnus-summary-mail nil
151 "Mail group commands."
152 :link '(custom-manual "(gnus)Mail Group Commands")
153 :group 'gnus-summary)
155 (defgroup gnus-summary-sort nil
156 "Sorting the summary buffer."
157 :link '(custom-manual "(gnus)Sorting")
158 :group 'gnus-summary)
160 (defgroup gnus-summary-visual nil
161 "Highlighting and menus in the summary buffer."
162 :link '(custom-manual "(gnus)Summary Highlighting")
164 :group 'gnus-summary)
166 (defgroup gnus-summary-various nil
167 "Various summary buffer options."
168 :link '(custom-manual "(gnus)Various Summary Stuff")
169 :group 'gnus-summary)
171 (defgroup gnus-summary-pick nil
172 "Pick mode in the summary buffer."
173 :link '(custom-manual "(gnus)Pick and Read")
175 :group 'gnus-summary)
177 (defgroup gnus-summary-tree nil
178 "Tree display of threads in the summary buffer."
179 :link '(custom-manual "(gnus)Tree Display")
181 :group 'gnus-summary)
183 ;; Belongs to gnus-uu.el
184 (defgroup gnus-extract-view nil
185 "Viewing extracted files."
186 :link '(custom-manual "(gnus)Viewing Files")
187 :group 'gnus-extract)
189 ;; Belongs to gnus-score.el
190 (defgroup gnus-score nil
191 "Score and kill file handling."
194 (defgroup gnus-score-kill nil
198 (defgroup gnus-score-adapt nil
199 "Adaptive score files."
202 (defgroup gnus-score-default nil
203 "Default values for score files."
206 (defgroup gnus-score-expire nil
207 "Expiring score rules."
210 (defgroup gnus-score-decay nil
211 "Decaying score rules."
214 (defgroup gnus-score-files nil
215 "Score and kill file names."
219 (defgroup gnus-score-various nil
220 "Various scoring and killing options."
224 (defgroup gnus-visual nil
225 "Options controlling the visual fluff."
229 (defgroup gnus-agent nil
230 "Offline support for Gnus."
233 (defgroup gnus-files nil
234 "Files used by Gnus."
237 (defgroup gnus-dribble-file nil
239 :link '(custom-manual "(gnus)Auto Save")
242 (defgroup gnus-newsrc nil
243 "Storing Gnus state."
246 (defgroup gnus-server nil
247 "Options related to newsservers and other servers used by Gnus."
250 (defgroup gnus-server-visual nil
251 "Highlighting and menus in the server buffer."
255 (defgroup gnus-message '((message custom-group))
256 "Composing replies and followups in Gnus."
259 (defgroup gnus-meta nil
260 "Meta variables controlling major portions of Gnus.
261 In general, modifying these variables does not take affect until Gnus
262 is restarted, and sometimes reloaded."
265 (defgroup gnus-various nil
266 "Other Gnus options."
267 :link '(custom-manual "(gnus)Various Various")
270 (defgroup gnus-mime nil
271 "Variables for controlling the Gnus MIME interface."
274 (defgroup gnus-exit nil
276 :link '(custom-manual "(gnus)Exiting Gnus")
279 (defgroup gnus-fun nil
280 "Frivolous Gnus extensions."
281 :link '(custom-manual "(gnus)Exiting Gnus")
284 (defconst gnus-version-number "0.08"
285 "Version number for this version of Gnus.")
287 (defconst gnus-version (format "Oort Gnus v%s" gnus-version-number)
288 "Version string for this version of Gnus.")
290 (defcustom gnus-inhibit-startup-message nil
291 "If non-nil, the startup message will not be displayed.
292 This variable is used before `.gnus.el' is loaded, so it should
293 be set in `.emacs' instead."
297 (defcustom gnus-play-startup-jingle nil
298 "If non-nil, play the Gnus jingle at startup."
302 (unless (fboundp 'gnus-group-remove-excess-properties)
303 (defalias 'gnus-group-remove-excess-properties 'ignore))
305 (unless (fboundp 'gnus-set-text-properties)
306 (defalias 'gnus-set-text-properties 'set-text-properties))
308 (unless (featurep 'gnus-xmas)
309 (defalias 'gnus-make-overlay 'make-overlay)
310 (defalias 'gnus-delete-overlay 'delete-overlay)
311 (defalias 'gnus-overlay-put 'overlay-put)
312 (defalias 'gnus-move-overlay 'move-overlay)
313 (defalias 'gnus-overlay-buffer 'overlay-buffer)
314 (defalias 'gnus-overlay-start 'overlay-start)
315 (defalias 'gnus-overlay-end 'overlay-end)
316 (defalias 'gnus-extent-detached-p 'ignore)
317 (defalias 'gnus-extent-start-open 'ignore)
318 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
319 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
320 (defalias 'gnus-character-to-event 'identity)
321 (defalias 'gnus-add-text-properties 'add-text-properties)
322 (defalias 'gnus-put-text-property 'put-text-property)
323 (defvar gnus-mode-line-image-cache t)
324 (if (fboundp 'find-image)
325 (defun gnus-mode-line-buffer-identification (line)
326 (let ((str (car-safe line)))
327 (if (and (stringp str)
328 (string-match "^Gnus:" str))
329 (progn (add-text-properties
332 (if (eq t gnus-mode-line-image-cache)
333 (setq gnus-mode-line-image-cache
335 '((:type xpm :file "gnus-pointer.xpm"
337 (:type xbm :file "gnus-pointer.xbm"
339 gnus-mode-line-image-cache)
340 'help-echo "This is Gnus")
344 (defalias 'gnus-mode-line-buffer-identification 'identity))
345 (defalias 'gnus-characterp 'numberp)
346 (defalias 'gnus-deactivate-mark 'deactivate-mark)
347 (defalias 'gnus-window-edges 'window-edges)
348 (defalias 'gnus-key-press-event-p 'numberp)
349 ;;(defalias 'gnus-decode-rfc1522 'ignore)
352 ;; We define these group faces here to avoid the display
353 ;; update forced when creating new faces.
355 (defface gnus-group-news-1-face
358 (:foreground "PaleTurquoise" :bold t))
361 (:foreground "ForestGreen" :bold t))
364 "Level 1 newsgroup face.")
366 (defface gnus-group-news-1-empty-face
369 (:foreground "PaleTurquoise"))
372 (:foreground "ForestGreen"))
375 "Level 1 empty newsgroup face.")
377 (defface gnus-group-news-2-face
380 (:foreground "turquoise" :bold t))
383 (:foreground "CadetBlue4" :bold t))
386 "Level 2 newsgroup face.")
388 (defface gnus-group-news-2-empty-face
391 (:foreground "turquoise"))
394 (:foreground "CadetBlue4"))
397 "Level 2 empty newsgroup face.")
399 (defface gnus-group-news-3-face
408 "Level 3 newsgroup face.")
410 (defface gnus-group-news-3-empty-face
419 "Level 3 empty newsgroup face.")
421 (defface gnus-group-news-4-face
430 "Level 4 newsgroup face.")
432 (defface gnus-group-news-4-empty-face
441 "Level 4 empty newsgroup face.")
443 (defface gnus-group-news-5-face
452 "Level 5 newsgroup face.")
454 (defface gnus-group-news-5-empty-face
463 "Level 5 empty newsgroup face.")
465 (defface gnus-group-news-6-face
474 "Level 6 newsgroup face.")
476 (defface gnus-group-news-6-empty-face
485 "Level 6 empty newsgroup face.")
487 (defface gnus-group-news-low-face
490 (:foreground "DarkTurquoise" :bold t))
493 (:foreground "DarkGreen" :bold t))
496 "Low level newsgroup face.")
498 (defface gnus-group-news-low-empty-face
501 (:foreground "DarkTurquoise"))
504 (:foreground "DarkGreen"))
507 "Low level empty newsgroup face.")
509 (defface gnus-group-mail-1-face
512 (:foreground "aquamarine1" :bold t))
515 (:foreground "DeepPink3" :bold t))
518 "Level 1 mailgroup face.")
520 (defface gnus-group-mail-1-empty-face
523 (:foreground "aquamarine1"))
526 (:foreground "DeepPink3"))
528 (:italic t :bold t)))
529 "Level 1 empty mailgroup face.")
531 (defface gnus-group-mail-2-face
534 (:foreground "aquamarine2" :bold t))
537 (:foreground "HotPink3" :bold t))
540 "Level 2 mailgroup face.")
542 (defface gnus-group-mail-2-empty-face
545 (:foreground "aquamarine2"))
548 (:foreground "HotPink3"))
551 "Level 2 empty mailgroup face.")
553 (defface gnus-group-mail-3-face
556 (:foreground "aquamarine3" :bold t))
559 (:foreground "magenta4" :bold t))
562 "Level 3 mailgroup face.")
564 (defface gnus-group-mail-3-empty-face
567 (:foreground "aquamarine3"))
570 (:foreground "magenta4"))
573 "Level 3 empty mailgroup face.")
575 (defface gnus-group-mail-low-face
578 (:foreground "aquamarine4" :bold t))
581 (:foreground "DeepPink4" :bold t))
584 "Low level mailgroup face.")
586 (defface gnus-group-mail-low-empty-face
589 (:foreground "aquamarine4"))
592 (:foreground "DeepPink4"))
595 "Low level empty mailgroup face.")
597 ;; Summary mode faces.
599 (defface gnus-summary-selected-face '((t
601 "Face used for selected articles.")
603 (defface gnus-summary-cancelled-face
605 (:foreground "yellow" :background "black")))
606 "Face used for cancelled articles.")
608 (defface gnus-summary-high-ticked-face
611 (:foreground "pink" :bold t))
614 (:foreground "firebrick" :bold t))
617 "Face used for high interest ticked articles.")
619 (defface gnus-summary-low-ticked-face
622 (:foreground "pink" :italic t))
625 (:foreground "firebrick" :italic t))
628 "Face used for low interest ticked articles.")
630 (defface gnus-summary-normal-ticked-face
633 (:foreground "pink"))
636 (:foreground "firebrick"))
639 "Face used for normal interest ticked articles.")
641 (defface gnus-summary-high-ancient-face
644 (:foreground "SkyBlue" :bold t))
647 (:foreground "RoyalBlue" :bold t))
650 "Face used for high interest ancient articles.")
652 (defface gnus-summary-low-ancient-face
655 (:foreground "SkyBlue" :italic t))
658 (:foreground "RoyalBlue" :italic t))
661 "Face used for low interest ancient articles.")
663 (defface gnus-summary-normal-ancient-face
666 (:foreground "SkyBlue"))
669 (:foreground "RoyalBlue"))
672 "Face used for normal interest ancient articles.")
674 (defface gnus-summary-high-uncached-face
676 (:bold t :background "Wheat1")))
677 "Face used for high interest uncached articles.")
679 (defface gnus-summary-low-uncached-face
681 (:italic t :background "Wheat1")))
682 "Face used for low interest uncached articles.")
684 (defface gnus-summary-normal-uncached-face
686 (:background "Wheat1")))
687 "Face used for normal interest uncached articles.")
689 (defface gnus-summary-high-unread-face
692 "Face used for high interest unread articles.")
694 (defface gnus-summary-low-unread-face
697 "Face used for low interest unread articles.")
699 (defface gnus-summary-normal-unread-face
702 "Face used for normal interest unread articles.")
704 (defface gnus-summary-high-read-face
707 (:foreground "PaleGreen"
711 (:foreground "DarkGreen"
715 "Face used for high interest read articles.")
717 (defface gnus-summary-low-read-face
720 (:foreground "PaleGreen"
724 (:foreground "DarkGreen"
728 "Face used for low interest read articles.")
730 (defface gnus-summary-normal-read-face
733 (:foreground "PaleGreen"))
736 (:foreground "DarkGreen"))
739 "Face used for normal interest read articles.")
746 (defvar gnus-buffers nil)
748 (defun gnus-get-buffer-create (name)
749 "Do the same as `get-buffer-create', but store the created buffer."
750 (or (get-buffer name)
751 (car (push (get-buffer-create name) gnus-buffers))))
753 (defun gnus-add-buffer ()
754 "Add the current buffer to the list of Gnus buffers."
755 (push (current-buffer) gnus-buffers))
757 (defun gnus-buffers ()
758 "Return a list of live Gnus buffers."
759 (while (and gnus-buffers
760 (not (buffer-name (car gnus-buffers))))
762 (let ((buffers gnus-buffers))
764 (if (buffer-name (cadr buffers))
766 (setcdr buffers (cddr buffers)))))
771 (defvar gnus-group-buffer "*Group*")
774 (autoload 'gnus-play-jingle "gnus-audio"))
776 (defface gnus-splash-face
779 (:foreground "#888888"))
782 (:foreground "#888888"))
785 "Face for the splash screen.")
787 (defun gnus-splash ()
789 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
790 (let ((buffer-read-only nil))
792 (unless gnus-inhibit-startup-message
793 (gnus-group-startup-message)
795 (when gnus-play-startup-jingle
796 (gnus-play-jingle))))))
798 (defun gnus-indent-rigidly (start end arg)
799 "Indent rigidly using only spaces and no tabs."
802 (narrow-to-region start end)
804 (indent-rigidly start end arg)
805 ;; We translate tabs into spaces -- not everybody uses
806 ;; an 8-character tab.
807 (goto-char (point-min))
808 (while (search-forward "\t" nil t)
809 (replace-match " " t t))))))
811 (defvar gnus-simple-splash nil)
813 ;;(format "%02x%02x%02x" 114 66 20) "724214"
815 (defvar gnus-logo-color-alist
816 '((flame "#cc3300" "#ff2200")
817 (pine "#c0cc93" "#f8ffb8")
818 (moss "#a1cc93" "#d2ffb8")
819 (irish "#04cc90" "#05ff97")
820 (sky "#049acc" "#05deff")
821 (tin "#6886cc" "#82b6ff")
822 (velvet "#7c68cc" "#8c82ff")
823 (grape "#b264cc" "#cf7df")
824 (labia "#cc64c2" "#fd7dff")
825 (berry "#cc6485" "#ff7db5")
826 (dino "#724214" "#1e3f03")
827 (oort "#cccccc" "#888888")
828 (storm "#666699" "#99ccff")
829 (pdino "#9999cc" "#99ccff")
830 (purp "#9999cc" "#666699")
831 (neutral "#b4b4b4" "#878787")
832 (september "#bf9900" "#ffcc00"))
833 "Color alist used for the Gnus logo.")
835 (defcustom gnus-logo-color-style 'oort
836 "*Color styles used for the Gnus logo."
837 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
838 gnus-logo-color-alist))
841 (defvar gnus-logo-colors
842 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
843 "Colors used for the Gnus logo.")
845 (defun gnus-group-startup-message (&optional x y)
846 "Insert startup message in current buffer."
847 ;; Insert the message.
851 (fboundp 'find-image)
853 (let ((image (find-image
854 `((:type xpm :file "gnus.xpm"
856 (("thing" . ,(car gnus-logo-colors))
857 ("shadow" . ,(cadr gnus-logo-colors))
858 ("background" . ,(face-background 'default))))
859 (:type pbm :file "gnus.pbm"
860 ;; Account for the pbm's blackground.
861 :background ,(face-foreground 'gnus-splash-face)
862 :foreground ,(face-background 'default))
863 (:type xbm :file "gnus.xbm"
864 ;; Account for the xbm's blackground.
865 :background ,(face-foreground 'gnus-splash-face)
866 :foreground ,(face-background 'default))))))
868 (let ((size (image-size image)))
869 (insert-char ?\n (max 0 (round (- (window-height)
870 (or y (cdr size)) 1) 2)))
871 (insert-char ?\ (max 0 (round (- (window-width)
872 (or x (car size))) 2)))
873 (insert-image image))
874 (setq gnus-simple-splash nil)
880 _ ___ __ ___ __ _ ___
900 (gnus-indent-rigidly (point-min) (point-max)
901 (/ (max (- (window-width) (or x 46)) 0) 2))
902 (goto-char (point-min))
904 (let* ((pheight (count-lines (point-min) (point-max)))
905 (wheight (window-height))
906 (rest (- wheight pheight)))
907 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
909 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
910 (setq gnus-simple-splash t)))
911 (goto-char (point-min))
912 (setq mode-line-buffer-identification (concat " " gnus-version))
913 (set-buffer-modified-p t))
916 (let ((command (format "%s" this-command)))
917 (if (and (string-match "gnus" command)
918 (not (string-match "gnus-other-frame" command)))
920 (gnus-get-buffer-create gnus-group-buffer))))
927 (defcustom gnus-parameters nil
928 "Alist of group parameters.
931 ((\"mail\\\\..*\" (gnus-show-threads nil)
932 (gnus-use-scoring nil)
933 (gnus-summary-line-format
934 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
937 (\"mail\\\\.me\" (gnus-use-scoring t))
938 (\"list\\\\..*\" (total-expire . t)
939 (broken-reply-to . t)))"
940 :group 'gnus-group-various
941 :type '(repeat (cons regexp
944 (defvar gnus-group-parameters-more nil)
946 (defmacro gnus-define-group-parameter (param &rest rest)
947 "Define a group parameter PARAM.
948 REST is a plist of following:
949 :type One of `bool', `list' or `nil'.
950 :function The name of the function.
951 :function-document The documentation of the function.
952 :parameter-type The type for customizing the parameter.
953 :parameter-document The documentation for the parameter.
954 :variable The name of the variable.
955 :variable-document The documentation for the variable.
956 :variable-group The group for customizing the variable.
957 :variable-type The type for customizing the variable.
958 :variable-default The default value of the variable."
959 (let* ((type (plist-get rest :type))
960 (parameter-type (plist-get rest :parameter-type))
961 (parameter-document (plist-get rest :parameter-document))
962 (function (or (plist-get rest :function)
963 (intern (format "gnus-parameter-%s" param))))
964 (function-document (or (plist-get rest :function-document) ""))
965 (variable (or (plist-get rest :variable)
966 (intern (format "gnus-parameter-%s-alist" param))))
967 (variable-document (or (plist-get rest :variable-document) ""))
968 (variable-group (plist-get rest :variable-group))
969 (variable-type (or (plist-get rest :variable-type)
971 (list (regexp :tag "Group")
972 ,(car (cdr parameter-type)))))))
973 (variable-default (plist-get rest :variable-default)))
976 `(defcustom ,variable ,variable-default
978 :group 'gnus-group-parameter
979 :group ',variable-group
980 :type ,variable-type)
981 `(setq gnus-group-parameters-more
982 (delq (assq ',param gnus-group-parameters-more)
983 gnus-group-parameters-more))
984 `(add-to-list 'gnus-group-parameters-more
987 ,parameter-document))
989 `(defun ,function (name)
991 (let ((params (gnus-group-find-parameter name))
994 ((memq ',param params)
996 ((setq val (assq ',param params))
999 (string-match ,variable name))
1001 (let ((alist ,variable)
1003 (while (setq elem (pop alist))
1005 (string-match (car elem) name))
1008 (if (consp value) (car value) value))))))
1009 `(defun ,function (name)
1012 (or (gnus-group-find-parameter name ',param ,(and type t))
1013 (let ((alist ,variable)
1015 (while (setq elem (pop alist))
1017 (string-match (car elem) name))
1022 '(if (consp value) (car value) value))))))))))
1024 (defcustom gnus-home-directory "~/"
1025 "Directory variable that specifies the \"home\" directory.
1026 All other Gnus path variables are initialized from this variable."
1030 (defcustom gnus-directory (or (getenv "SAVEDIR")
1031 (nnheader-concat gnus-home-directory "News/"))
1032 "*Directory variable from which all other Gnus file variables are derived.
1034 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1035 This means that other directory variables that are initialized from
1036 this variable won't be set properly if you set this variable in `.gnus.el'.
1037 Set this variable in `.emacs' instead."
1041 (defcustom gnus-default-directory nil
1042 "*Default directory for all Gnus buffers."
1044 :type '(choice (const :tag "current" nil)
1047 ;; Site dependent variables. These variables should be defined in
1050 (defvar gnus-default-nntp-server nil
1051 "Specify a default NNTP server.
1052 This variable should be defined in paths.el, and should never be set
1054 If you want to change servers, you should use `gnus-select-method'.
1055 See the documentation to that variable.")
1057 ;; Don't touch this variable.
1058 (defvar gnus-nntp-service "nntp"
1059 "NNTP service name (\"nntp\" or 119).
1060 This is an obsolete variable, which is scarcely used. If you use an
1061 nntp server for your newsgroup and want to change the port number
1062 used to 899, you would say something along these lines:
1064 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1066 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1067 "A file with only the name of the nntp server in it."
1072 ;; This function is used to check both the environment variable
1073 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
1074 ;; an nntp server name default.
1075 (defun gnus-getenv-nntpserver ()
1076 (or (getenv "NNTPSERVER")
1077 (and (file-readable-p gnus-nntpserver-file)
1079 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
1080 (insert-file-contents gnus-nntpserver-file)
1081 (let ((name (buffer-string)))
1083 (if (string-match "\\'[ \t\n]*$" name)
1086 (kill-buffer (current-buffer))))))))
1088 (defcustom gnus-select-method
1091 (list 'nntp (or (condition-case nil
1092 (gnus-getenv-nntpserver)
1094 (when (and gnus-default-nntp-server
1095 (not (string= gnus-default-nntp-server "")))
1096 gnus-default-nntp-server)
1098 (if (or (null gnus-nntp-service)
1099 (equal gnus-nntp-service "nntp"))
1101 (list gnus-nntp-service)))
1103 "Default method for selecting a newsgroup.
1104 This variable should be a list, where the first element is how the
1105 news is to be fetched, the second is the address.
1107 For instance, if you want to get your news via \"flab.flab.edu\" using
1108 NNTP, you could say:
1110 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1112 If you want to use your local spool, say:
1114 \(setq gnus-select-method (list 'nnspool (system-name)))
1116 If you use this variable, you must set `gnus-nntp-server' to nil.
1118 There is a lot more to know about select methods and virtual servers -
1119 see the manual for details."
1121 :type 'gnus-select-method)
1123 (defcustom gnus-message-archive-method "archive"
1124 "*Method used for archiving messages you've sent.
1125 This should be a mail method."
1127 :group 'gnus-message
1128 :type 'gnus-select-method)
1130 (defcustom gnus-message-archive-group nil
1131 "*Name of the group in which to save the messages you've written.
1132 This can either be a string; a list of strings; or an alist
1133 of regexps/functions/forms to be evaluated to return a string (or a list
1134 of strings). The functions are called with the name of the current
1135 group (or nil) as a parameter.
1137 If you want to save your mail in one group and the news articles you
1138 write in another group, you could say something like:
1140 \(setq gnus-message-archive-group
1141 '((if (message-news-p)
1145 Normally the group names returned by this variable should be
1146 unprefixed -- which implicitly means \"store on the archive server\".
1147 However, you may wish to store the message on some other server. In
1148 that case, just return a fully prefixed name of the group --
1149 \"nnml+private:mail.misc\", for instance."
1150 :group 'gnus-message
1151 :type '(choice (const :tag "none" nil)
1156 (defcustom gnus-secondary-servers nil
1157 "List of NNTP servers that the user can choose between interactively.
1158 To make Gnus query you for a server, you have to give `gnus' a
1159 non-numeric prefix - `C-u M-x gnus', in short."
1161 :type '(repeat string))
1163 (defcustom gnus-nntp-server nil
1164 "*The name of the host running the NNTP server.
1165 This variable is semi-obsolete. Use the `gnus-select-method'
1168 :type '(choice (const :tag "disable" nil)
1171 (defcustom gnus-secondary-select-methods nil
1172 "A list of secondary methods that will be used for reading news.
1173 This is a list where each element is a complete select method (see
1174 `gnus-select-method').
1176 If, for instance, you want to read your mail with the nnml back end,
1177 you could set this variable:
1179 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1181 :type '(repeat gnus-select-method))
1183 (defvar gnus-backup-default-subscribed-newsgroups
1184 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1185 "Default default new newsgroups the first time Gnus is run.
1186 Should be set in paths.el, and shouldn't be touched by the user.")
1188 (defcustom gnus-local-domain nil
1189 "Local domain name without a host name.
1190 The DOMAINNAME environment variable is used instead if it is defined.
1191 If the function `system-name' returns the full Internet name, there is
1192 no need to set this variable."
1193 :group 'gnus-message
1194 :type '(choice (const :tag "default" nil)
1197 (defvar gnus-local-organization nil
1198 "String with a description of what organization (if any) the user belongs to.
1199 Obsolete variable; use `message-user-organization' instead.")
1201 ;; Customization variables
1203 (defcustom gnus-refer-article-method nil
1204 "Preferred method for fetching an article by Message-ID.
1205 If you are reading news from the local spool (with nnspool), fetching
1206 articles by Message-ID is painfully slow. By setting this method to an
1207 nntp method, you might get acceptable results.
1209 The value of this variable must be a valid select method as discussed
1210 in the documentation of `gnus-select-method'.
1212 It can also be a list of select methods, as well as the special symbol
1213 `current', which means to use the current select method. If it is a
1214 list, Gnus will try all the methods in the list until it finds a match."
1216 :type '(choice (const :tag "default" nil)
1217 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1219 (repeat :menu-tag "Try multiple"
1221 :value (current (nnweb "refer" (nnweb-type google)))
1222 (choice :tag "Method"
1224 (const :tag "Google"
1225 (nnweb "refer" (nnweb-type google)))
1226 gnus-select-method))))
1228 (defcustom gnus-group-faq-directory
1229 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1230 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1231 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1232 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1233 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1234 "/ftp@rtfm.mit.edu:/pub/usenet/"
1235 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1236 "/ftp@ftp.sunet.se:/pub/usenet/"
1237 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1238 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1239 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1240 "*Directory where the group FAQs are stored.
1241 This will most commonly be on a remote machine, and the file will be
1242 fetched by ange-ftp.
1244 This variable can also be a list of directories. In that case, the
1245 first element in the list will be used by default. The others can
1246 be used when being prompted for a site.
1248 Note that Gnus uses an aol machine as the default directory. If this
1249 feels fundamentally unclean, just think of it as a way to finally get
1250 something of value back from them.
1252 If the default site is too slow, try one of these:
1254 North America: mirrors.aol.com /pub/rtfm/usenet
1255 ftp.seas.gwu.edu /pub/rtfm
1256 rtfm.mit.edu /pub/usenet
1257 Europe: ftp.uni-paderborn.de /pub/FAQ
1258 src.doc.ic.ac.uk /usenet/news-FAQS
1259 ftp.sunet.se /pub/usenet
1260 ftp.pasteur.fr /pub/FAQ
1261 Asia: nctuccca.edu.tw /USENET/FAQ
1262 hwarang.postech.ac.kr /pub/usenet
1263 ftp.hk.super.net /mirror/faqs"
1264 :group 'gnus-group-various
1265 :type '(choice directory
1266 (repeat directory)))
1268 (defcustom gnus-group-charter-alist
1269 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1270 ("de" . (concat "http://purl.net/charta/" name ".html"))
1271 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1272 ("england" . (concat "http://england.news-admin.org/charters/" name))
1273 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1274 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1275 (gnus-replace-in-string name "europa\\." "") ".html"))
1276 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1277 ("aus" . (concat "http://aus.news-admin.org/groupinfo.php/" name))
1278 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1279 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1280 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1281 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1282 ("wales" . (concat "http://www.wales-usenet.org/english/groups/" name ".html"))
1283 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1284 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1285 (gnus-replace-in-string name "\\." "_") ".html"))
1286 ("milw" . (concat "http://usenet.mil.wi.us/"
1287 (gnus-replace-in-string name "milw\\." "") "-charter"))
1288 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1289 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1290 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1291 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1292 When FORM is evaluated `name' is bound to the name of the group."
1293 :group 'gnus-group-various
1294 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1296 (defcustom gnus-group-fetch-control-use-browse-url nil
1297 "*Non-nil means that control messages are displayed using `browse-url'.
1298 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1300 :group 'gnus-group-various
1303 (defcustom gnus-use-cross-reference t
1304 "*Non-nil means that cross referenced articles will be marked as read.
1305 If nil, ignore cross references. If t, mark articles as read in
1306 subscribed newsgroups. If neither t nor nil, mark as read in all
1309 :type '(choice (const :tag "off" nil)
1310 (const :tag "subscribed" t)
1314 (defcustom gnus-process-mark ?#
1316 :group 'gnus-group-visual
1317 :group 'gnus-summary-marks
1320 (defcustom gnus-large-newsgroup 200
1321 "*The number of articles which indicates a large newsgroup.
1322 If the number of articles in a newsgroup is greater than this value,
1323 confirmation is required for selecting the newsgroup.
1324 If it is `nil', no confirmation is required."
1325 :group 'gnus-group-select
1326 :type '(choice (const :tag "No limit" nil)
1329 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1330 "*Non-nil means that the default name of a file to save articles in is the group name.
1331 If it's nil, the directory form of the group name is used instead.
1333 If this variable is a list, and the list contains the element
1334 `not-score', long file names will not be used for score files; if it
1335 contains the element `not-save', long file names will not be used for
1336 saving; and if it contains the element `not-kill', long file names
1337 will not be used for kill files.
1339 Note that the default for this variable varies according to what system
1340 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1341 to nil while on all other systems it defaults to t."
1345 (defcustom gnus-kill-files-directory gnus-directory
1346 "*Name of the directory where kill files will be stored (default \"~/News\")."
1347 :group 'gnus-score-files
1348 :group 'gnus-score-kill
1351 (defcustom gnus-save-score nil
1352 "*If non-nil, save group scoring info."
1353 :group 'gnus-score-various
1357 (defcustom gnus-use-undo t
1358 "*If non-nil, allow undoing in Gnus group mode buffers."
1362 (defcustom gnus-use-adaptive-scoring nil
1363 "*If non-nil, use some adaptive scoring scheme.
1364 If a list, then the values `word' and `line' are meaningful. The
1365 former will perform adaption on individual words in the subject
1366 header while `line' will perform adaption on several headers."
1368 :group 'gnus-score-adapt
1369 :type '(set (const word) (const line)))
1371 (defcustom gnus-use-cache 'passive
1372 "*If nil, Gnus will ignore the article cache.
1373 If `passive', it will allow entering (and reading) articles
1374 explicitly entered into the cache. If anything else, use the
1375 cache to the full extent of the law."
1378 :type '(choice (const :tag "off" nil)
1379 (const :tag "passive" passive)
1380 (const :tag "active" t)))
1382 (defcustom gnus-use-trees nil
1383 "*If non-nil, display a thread tree buffer."
1387 (defcustom gnus-use-grouplens nil
1388 "*If non-nil, use GroupLens ratings."
1392 (defcustom gnus-keep-backlog nil
1393 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1394 If it is a number N, then Gnus will only keep the last N articles
1395 read. If it is neither nil nor a number, Gnus will keep all read
1396 articles. This is not a good idea."
1398 :type '(choice (const :tag "off" nil)
1403 (defcustom gnus-use-nocem nil
1404 "*If non-nil, Gnus will read NoCeM cancel messages."
1408 (defcustom gnus-suppress-duplicates nil
1409 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1413 (defcustom gnus-use-scoring t
1414 "*If non-nil, enable scoring."
1418 (defcustom gnus-summary-prepare-exit-hook
1419 '(gnus-summary-expire-articles)
1420 "*A hook called when preparing to exit from the summary buffer.
1421 It calls `gnus-summary-expire-articles' by default."
1422 :group 'gnus-summary-exit
1425 (defcustom gnus-novice-user t
1426 "*Non-nil means that you are a usenet novice.
1427 If non-nil, verbose messages may be displayed and confirmations may be
1432 (defcustom gnus-expert-user nil
1433 "*Non-nil means that you will never be asked for confirmation about anything.
1434 That doesn't mean *anything* anything; particularly destructive
1435 commands will still require prompting."
1439 (defcustom gnus-interactive-catchup t
1440 "*If non-nil, require your confirmation when catching up a group."
1441 :group 'gnus-group-select
1444 (defcustom gnus-interactive-exit t
1445 "*If non-nil, require your confirmation when exiting Gnus."
1449 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1450 "*Function for extracting address components from a From header.
1451 Two pre-defined function exist: `gnus-extract-address-components',
1452 which is the default, quite fast, and too simplistic solution, and
1453 `mail-extract-address-components', which works much better, but is
1455 :group 'gnus-summary-format
1456 :type '(radio (function-item gnus-extract-address-components)
1457 (function-item mail-extract-address-components)
1458 (function :tag "Other")))
1460 (defcustom gnus-carpal nil
1461 "*If non-nil, display clickable icons."
1465 (defcustom gnus-shell-command-separator ";"
1466 "String used to separate to shell commands."
1470 (defcustom gnus-valid-select-methods
1471 '(("nntp" post address prompt-address physical-address)
1472 ("nnspool" post address)
1473 ("nnvirtual" post-mail virtual prompt-address)
1474 ("nnmbox" mail respool address)
1475 ("nnml" post-mail respool address)
1476 ("nnmh" mail respool address)
1477 ("nndir" post-mail prompt-address physical-address)
1478 ("nneething" none address prompt-address physical-address)
1479 ("nndoc" none address prompt-address)
1480 ("nnbabyl" mail address respool)
1481 ("nnkiboze" post virtual)
1482 ("nnsoup" post-mail address)
1483 ("nndraft" post-mail)
1484 ("nnfolder" mail respool address)
1485 ("nngateway" post-mail address prompt-address physical-address)
1494 ("nnagent" post-mail)
1495 ("nnimap" post-mail address prompt-address physical-address)
1496 ("nnmaildir" mail respool address)
1498 "*An alist of valid select methods.
1499 The first element of each list lists should be a string with the name
1500 of the select method. The other elements may be the category of
1501 this method (i. e., `post', `mail', `none' or whatever) or other
1502 properties that this method has (like being respoolable).
1503 If you implement a new select method, all you should have to change is
1504 this variable. I think."
1506 :type '(repeat (group (string :tag "Name")
1507 (radio-button-choice (const :format "%v " post)
1508 (const :format "%v " mail)
1509 (const :format "%v " none)
1511 (checklist :inline t
1512 (const :format "%v " address)
1513 (const :format "%v " prompt-address)
1514 (const :format "%v " physical-address)
1515 (const :format "%v " virtual)
1518 (defun gnus-redefine-select-method-widget ()
1519 "Recomputes the select-method widget based on the value of
1520 `gnus-valid-select-methods'."
1521 (define-widget 'gnus-select-method 'list
1522 "Widget for entering a select method."
1524 :tag "Select Method"
1525 :args `((choice :tag "Method"
1526 ,@(mapcar (lambda (entry)
1527 (list 'const :format "%v\n"
1528 (intern (car entry))))
1529 gnus-valid-select-methods)
1530 (symbol :tag "other"))
1531 (string :tag "Address")
1532 (repeat :tag "Options"
1536 (sexp :tag "Value"))))))
1538 (gnus-redefine-select-method-widget)
1540 (defcustom gnus-updated-mode-lines '(group article summary tree)
1541 "List of buffers that should update their mode lines.
1542 The list may contain the symbols `group', `article', `tree' and
1543 `summary'. If the corresponding symbol is present, Gnus will keep
1544 that mode line updated with information that may be pertinent.
1545 If this variable is nil, screen refresh may be quicker."
1546 :group 'gnus-various
1547 :type '(set (const group)
1552 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1553 (defcustom gnus-mode-non-string-length nil
1554 "*Max length of mode-line non-string contents.
1555 If this is nil, Gnus will take space as is needed, leaving the rest
1556 of the modeline intact. Note that the default of nil is unlikely
1557 to be desirable; see the manual for further details."
1558 :group 'gnus-various
1559 :type '(choice (const nil)
1562 ;; There should be special validation for this.
1563 (define-widget 'gnus-email-address 'string
1566 (gnus-define-group-parameter
1569 "Return GROUP's to-address."
1571 "*Alist of group regexps and correspondent to-addresses."
1572 :parameter-type '(gnus-email-address :tag "To Address")
1573 :parameter-document "\
1574 This will be used when doing followups and posts.
1576 This is primarily useful in mail groups that represent closed
1577 mailing lists--mailing lists where it's expected that everybody that
1578 writes to the mailing list is subscribed to it. Since using this
1579 parameter ensures that the mail only goes to the mailing list itself,
1580 it means that members won't receive two copies of your followups.
1582 Using `to-address' will actually work whether the group is foreign or
1583 not. Let's say there's a group on the server that is called
1584 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1585 articles from a mail-to-news gateway. Posting directly to this group
1586 is therefore impossible--you have to send mail to the mailing list
1589 The gnus-group-split mail splitting mechanism will behave as if this
1590 address was listed in gnus-group-split Addresses (see below).")
1592 (gnus-define-group-parameter
1595 "Return GROUP's to-list."
1597 "*Alist of group regexps and correspondent to-lists."
1598 :parameter-type '(gnus-email-address :tag "To List")
1599 :parameter-document "\
1600 This address will be used when doing a `a' in the group.
1602 It is totally ignored when doing a followup--except that if it is
1603 present in a news group, you'll get mail group semantics when doing
1606 The gnus-group-split mail splitting mechanism will behave as if this
1607 address was listed in gnus-group-split Addresses (see below).")
1609 (gnus-define-group-parameter
1613 "Return GROUP's subscription status."
1615 "*Groups which are automatically considered subscribed."
1616 :parameter-type '(const :tag "Subscribed" t)
1617 :parameter-document "\
1618 Gnus assumed that you are subscribed to the To/List address.
1620 When constructing a list of subscribed groups using
1621 `gnus-find-subscribed-addresses', Gnus includes the To address given
1622 above, or the list address (if the To address has not been set).")
1624 (gnus-define-group-parameter
1627 :function gnus-group-auto-expirable-p
1629 "Check whether GROUP is auto-expirable or not."
1630 :variable gnus-auto-expirable-newsgroups
1631 :variable-default nil
1633 "*Groups in which to automatically mark read articles as expirable.
1634 If non-nil, this should be a regexp that should match all groups in
1635 which to perform auto-expiry. This only makes sense for mail groups."
1636 :variable-group nnmail-expire
1637 :variable-type '(choice (const nil)
1639 :parameter-type '(const :tag "Automatic Expire" t)
1641 "All articles that are read will be marked as expirable.")
1643 (gnus-define-group-parameter
1646 :function gnus-group-total-expirable-p
1648 "Check whether GROUP is total-expirable or not."
1649 :variable gnus-total-expirable-newsgroups
1650 :variable-default nil
1652 "*Groups in which to perform expiry of all read articles.
1653 Use with extreme caution. All groups that match this regexp will be
1654 expiring - which means that all read articles will be deleted after
1655 \(say) one week. (This only goes for mail groups and the like, of
1657 :variable-group nnmail-expire
1658 :variable-type '(choice (const nil)
1660 :parameter-type '(const :tag "Total Expire" t)
1662 "All read articles will be put through the expiry process
1664 This happens even if they are not marked as expirable.
1667 (gnus-define-group-parameter
1670 "Return the default charset of GROUP."
1671 :variable gnus-group-charset-alist
1673 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1674 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1675 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1676 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1677 ("\\(^\\|:\\)relcom\\>" koi8-r)
1678 ("\\(^\\|:\\)fido7\\>" koi8-r)
1679 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1680 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1681 ("\\(^\\|:\\)han\\>" euc-kr)
1682 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1683 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1684 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1686 "Alist of regexps (to match group names) and default charsets to be used when reading."
1687 :variable-group gnus-charset
1688 :variable-type '(repeat (list (regexp :tag "Group")
1689 (symbol :tag "Charset")))
1690 :parameter-type '(symbol :tag "Charset")
1691 :parameter-document "\
1692 The default charset to use in the group.")
1694 (gnus-define-group-parameter
1698 "Return a posting method for GROUP."
1699 :variable gnus-post-method-alist
1701 "Alist of regexps (to match group names) and method to be used when
1702 posting an article."
1703 :variable-group gnus-group-foreign
1705 '(choice :tag "Posting Method"
1706 (const :tag "Use native server" native)
1707 (const :tag "Use current server" current)
1708 (list :convert-widget
1710 (list 'sexp :tag "Methods"
1711 :value gnus-select-method))))
1713 "Posting method for this group.")
1715 (gnus-define-group-parameter
1716 large-newsgroup-initial
1719 "Return GROUP's initial input of the number of articles."
1721 "*Alist of group regexps and its initial input of the number of articles."
1722 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1723 (const :tag "All" nil)
1725 :parameter-document "\
1727 This number will be prompted as the initial value of the number of
1728 articles to list when the group is a large newsgroup (see
1729 `gnus-large-newsgroup'). If it is `nil', the default value is the
1730 total number of articles in the group.")
1732 (defcustom gnus-group-uncollapsed-levels 1
1733 "Number of group name elements to leave alone when making a short group name."
1734 :group 'gnus-group-visual
1737 (defcustom gnus-group-use-permanent-levels nil
1738 "*If non-nil, once you set a level, Gnus will use this level."
1739 :group 'gnus-group-levels
1744 (defcustom gnus-load-hook nil
1745 "A hook run while Gnus is loaded."
1749 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1750 "A hook called to apply kill files to a group.
1751 This hook is intended to apply a kill file to the selected newsgroup.
1752 The function `gnus-apply-kill-file' is called by default.
1754 Since a general kill file is too heavy to use only for a few
1755 newsgroups, I recommend you to use a lighter hook function. For
1756 example, if you'd like to apply a kill file to articles which contains
1757 a string `rmgroup' in subject in newsgroup `control', you can use the
1760 (setq gnus-apply-kill-hook
1763 (cond ((string-match \"control\" gnus-newsgroup-name)
1764 (gnus-kill \"Subject\" \"rmgroup\")
1765 (gnus-expunge \"X\"))))))"
1766 :group 'gnus-score-kill
1767 :options '(gnus-apply-kill-file)
1770 (defcustom gnus-group-change-level-function nil
1771 "Function run when a group level is changed.
1772 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1773 :group 'gnus-group-levels
1778 (defcustom gnus-visual
1779 '(summary-highlight group-highlight article-highlight
1781 summary-menu group-menu article-menu
1782 tree-highlight menu highlight
1783 browse-menu server-menu
1784 page-marker tree-menu binary-menu pick-menu
1786 "*Enable visual features.
1787 If `visual' is disabled, there will be no menus and few faces. Most of
1788 the visual customization options below will be ignored. Gnus will use
1789 less space and be faster as a result.
1791 This variable can also be a list of visual elements to switch on. For
1792 instance, to switch off all visual things except menus, you can say:
1794 (setq gnus-visual '(menu))
1796 Valid elements include `summary-highlight', `group-highlight',
1797 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1798 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1799 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1800 and `grouplens-menu'."
1803 :type '(set (const summary-highlight)
1804 (const group-highlight)
1805 (const article-highlight)
1807 (const summary-menu)
1809 (const article-menu)
1810 (const tree-highlight)
1819 (const grouplens-menu)))
1821 ;; Byte-compiler warning.
1822 (defvar gnus-visual)
1823 ;; Find out whether the gnus-visual TYPE is wanted.
1824 (defun gnus-visual-p (&optional type class)
1825 (and gnus-visual ; Has to be non-nil, at least.
1826 (if (not type) ; We don't care about type.
1828 (if (listp gnus-visual) ; It's a list, so we check it.
1829 (or (memq type gnus-visual)
1830 (memq class gnus-visual))
1833 (defcustom gnus-mouse-face
1835 (if (gnus-visual-p 'mouse-face 'highlight)
1836 (if (boundp 'gnus-mouse-face)
1837 (or gnus-mouse-face 'highlight)
1841 "*Face used for group or summary buffer mouse highlighting.
1842 The line beneath the mouse pointer will be highlighted with this
1847 (defcustom gnus-article-save-directory gnus-directory
1848 "*Name of the directory articles will be saved in (default \"~/News\")."
1849 :group 'gnus-article-saving
1852 (defvar gnus-plugged t
1853 "Whether Gnus is plugged or not.")
1855 (defcustom gnus-agent-cache t
1856 "Whether Gnus use agent cache.
1857 You also need to enable `gnus-agent'."
1862 (defcustom gnus-default-charset (mm-guess-mime-charset)
1863 "Default charset assumed to be used when viewing non-ASCII characters.
1864 This variable is overridden on a group-to-group basis by the
1865 gnus-group-charset-alist variable and is only used on groups not
1866 covered by that variable."
1868 :group 'gnus-charset)
1870 (defcustom gnus-agent t
1871 "Whether we want to use the Gnus agent or not.
1872 Putting (gnus-agentize) in ~/.gnus is obsolete by (setq gnus-agent t)."
1877 (defcustom gnus-other-frame-function 'gnus
1878 "Function called by the command `gnus-other-frame'."
1880 :type '(choice (function-item gnus)
1881 (function-item gnus-no-server)
1882 (function-item gnus-slave)
1883 (function-item gnus-slave-no-server)))
1885 (defcustom gnus-other-frame-parameters nil
1886 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
1887 This should be an alist for FSF Emacs, or a plist for XEmacs."
1889 :type (if (featurep 'xemacs)
1890 '(repeat (list :inline t :format "%v"
1891 (symbol :tag "Property")
1892 (sexp :tag "Value")))
1893 '(repeat (cons :format "%v"
1894 (symbol :tag "Parameter")
1895 (sexp :tag "Value")))))
1898 ;;; Internal variables
1900 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1901 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1902 (defvar gnus-draft-meta-information-header "X-Draft-From")
1903 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1904 (defvar gnus-original-article-buffer " *Original Article*")
1905 (defvar gnus-newsgroup-name nil)
1906 (defvar gnus-ephemeral-servers nil)
1907 (defvar gnus-server-method-cache nil)
1909 (defvar gnus-agent-fetching nil
1910 "Whether Gnus agent is in fetching mode.")
1912 (defvar gnus-agent-covered-methods nil)
1914 (defvar gnus-command-method nil
1915 "Dynamically bound variable that says what the current back end is.")
1917 (defvar gnus-current-select-method nil
1918 "The current method for selecting a newsgroup.")
1920 (defvar gnus-tree-buffer "*Tree*"
1921 "Buffer where Gnus thread trees are displayed.")
1924 (defvar gnus-use-generic-from nil)
1926 ;; Variable holding the user answers to all method prompts.
1927 (defvar gnus-method-history nil)
1929 ;; Variable holding the user answers to all mail method prompts.
1930 (defvar gnus-mail-method-history nil)
1932 ;; Variable holding the user answers to all group prompts.
1933 (defvar gnus-group-history nil)
1935 (defvar gnus-server-alist nil
1936 "List of available servers.")
1938 (defcustom gnus-cache-directory
1939 (nnheader-concat gnus-directory "cache/")
1940 "*The directory where cached articles will be stored."
1944 (defvar gnus-predefined-server-alist
1947 (nnspool-spool-directory ,gnus-cache-directory)
1948 (nnspool-nov-directory ,gnus-cache-directory)
1949 (nnspool-active-file
1950 ,(nnheader-concat gnus-cache-directory "active"))))
1951 "List of predefined (convenience) servers.")
1953 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1955 (defconst gnus-article-mark-lists
1956 '((marked . tick) (replied . reply)
1957 (expirable . expire) (killed . killed)
1958 (bookmarks . bookmark) (dormant . dormant)
1959 (scored . score) (saved . save)
1960 (cached . cache) (downloadable . download)
1961 (unsendable . unsend) (forwarded . forward)
1962 (recent . recent) (seen . seen)))
1964 (defconst gnus-article-special-mark-lists
1970 ;; Propagate flags to server, with the following exceptions:
1971 ;; `seen' is private to each gnus installation
1972 ;; `cache' is a internal gnus flag for each gnus installation
1973 ;; `download' is a agent flag private to each gnus installation
1974 ;; `unsend' are for nndraft groups only
1975 ;; `score' is not a proper mark
1976 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
1977 (defconst gnus-article-unpropagated-mark-lists
1978 '(seen cache download unsend score bookmark)
1979 "Marks that shouldn't be propagated to back ends.
1980 Typical marks are those that make no sense in a standalone back end,
1981 such as a mark that says whether an article is stored in the cache
1982 \(which doesn't make sense in a standalone back end).")
1984 (defvar gnus-headers-retrieved-by nil)
1985 (defvar gnus-article-reply nil)
1986 (defvar gnus-override-method nil)
1987 (defvar gnus-article-check-size nil)
1988 (defvar gnus-opened-servers nil)
1990 (defvar gnus-current-kill-article nil)
1992 (defvar gnus-have-read-active-file nil)
1994 (defconst gnus-maintainer
1995 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1996 "The mail address of the Gnus maintainers.")
1998 (defvar gnus-info-nodes
1999 '((gnus-group-mode "(gnus)Group Buffer")
2000 (gnus-summary-mode "(gnus)Summary Buffer")
2001 (gnus-article-mode "(gnus)Article Buffer")
2002 (gnus-server-mode "(gnus)Server Buffer")
2003 (gnus-browse-mode "(gnus)Browse Foreign Server")
2004 (gnus-tree-mode "(gnus)Tree Display"))
2005 "Alist of major modes and related Info nodes.")
2007 (defvar gnus-group-buffer "*Group*")
2008 (defvar gnus-summary-buffer "*Summary*")
2009 (defvar gnus-article-buffer "*Article*")
2010 (defvar gnus-server-buffer "*Server*")
2012 (defvar gnus-slave nil
2013 "Whether this Gnus is a slave or not.")
2015 (defvar gnus-batch-mode nil
2016 "Whether this Gnus is running in batch mode or not.")
2018 (defvar gnus-variable-list
2019 '(gnus-newsrc-options gnus-newsrc-options-n
2020 gnus-newsrc-last-checked-date
2021 gnus-newsrc-alist gnus-server-alist
2022 gnus-killed-list gnus-zombie-list
2023 gnus-topic-topology gnus-topic-alist
2024 gnus-format-specs gnus-agent-covered-methods)
2025 "Gnus variables saved in the quick startup file.")
2027 (defvar gnus-newsrc-alist nil
2028 "Assoc list of read articles.
2029 gnus-newsrc-hashtb should be kept so that both hold the same information.")
2031 (defvar gnus-newsrc-hashtb nil
2032 "Hashtable of gnus-newsrc-alist.")
2034 (defvar gnus-killed-list nil
2035 "List of killed newsgroups.")
2037 (defvar gnus-killed-hashtb nil
2038 "Hash table equivalent of gnus-killed-list.")
2040 (defvar gnus-zombie-list nil
2041 "List of almost dead newsgroups.")
2043 (defvar gnus-description-hashtb nil
2044 "Descriptions of newsgroups.")
2046 (defvar gnus-list-of-killed-groups nil
2047 "List of newsgroups that have recently been killed by the user.")
2049 (defvar gnus-active-hashtb nil
2050 "Hashtable of active articles.")
2052 (defvar gnus-moderated-hashtb nil
2053 "Hashtable of moderated newsgroups.")
2055 ;; Save window configuration.
2056 (defvar gnus-prev-winconf nil)
2058 (defvar gnus-reffed-article-number nil)
2060 ;;; Let the byte-compiler know that we know about this variable.
2061 (defvar rmail-default-rmail-file)
2063 (defvar gnus-dead-summary nil)
2065 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2066 "Regexp matching invalid groups.")
2068 (defvar gnus-other-frame-object nil
2069 "A frame object which will be created by `gnus-other-frame'.")
2071 ;;; End of variables.
2073 ;; Define some autoload functions Gnus might use.
2076 ;; This little mapcar goes through the list below and marks the
2077 ;; symbols in question as autoloaded functions.
2080 (let ((interactive (nth 1 (memq ':interactive package))))
2084 (when (consp function)
2085 (setq keymap (car (memq 'keymap function)))
2086 (setq function (car function)))
2087 (unless (fboundp function)
2088 (autoload function (car package) nil interactive keymap))))
2089 (if (eq (nth 1 package) ':interactive)
2092 '(("info" :interactive t Info-goto-node)
2094 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2095 ("ps-print" ps-print-preprint)
2096 ("message" :interactive t
2097 message-send-and-exit message-yank-original)
2098 ("babel" babel-as-string)
2099 ("nnmail" nnmail-split-fancy nnmail-article-group)
2100 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2101 ("rmailout" rmail-output rmail-output-to-rmail-file)
2102 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2103 rmail-show-message rmail-summary-exists
2104 rmail-select-summary rmail-update-summary)
2105 ("gnus-audio" :interactive t gnus-audio-play)
2106 ("gnus-xmas" gnus-xmas-splash)
2107 ("gnus-soup" :interactive t
2108 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2109 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2110 ("nnsoup" nnsoup-pack-replies)
2111 ("score-mode" :interactive t gnus-score-mode)
2112 ("gnus-mh" gnus-summary-save-article-folder
2113 gnus-Folder-save-name gnus-folder-save-name)
2114 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2115 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2116 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2117 gnus-demon-add-disconnection gnus-demon-add-handler
2118 gnus-demon-remove-handler)
2119 ("gnus-demon" :interactive t
2120 gnus-demon-init gnus-demon-cancel)
2121 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2122 gnus-convert-image-to-gray-x-face)
2123 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2124 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2125 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2126 gnus-nocem-unwanted-article-p)
2127 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2128 gnus-server-server-name)
2129 ("gnus-srvr" gnus-browse-foreign-server)
2130 ("gnus-cite" :interactive t
2131 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2132 gnus-article-hide-citation gnus-article-fill-cited-article
2133 gnus-article-hide-citation-in-followups)
2134 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2135 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2136 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2137 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2138 gnus-cache-possibly-remove-articles gnus-cache-request-article
2139 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2140 gnus-cache-enter-remove-article gnus-cached-article-p
2141 gnus-cache-open gnus-cache-close gnus-cache-update-article
2142 gnus-cache-articles-in-group)
2143 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2144 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2145 ("gnus-score" :interactive t
2146 gnus-summary-increase-score gnus-summary-set-score
2147 gnus-summary-raise-thread gnus-summary-raise-same-subject
2148 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2149 gnus-summary-lower-thread gnus-summary-lower-same-subject
2150 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2151 gnus-summary-current-score gnus-score-delta-default
2152 gnus-score-flush-cache gnus-score-close
2153 gnus-possibly-score-headers gnus-score-followup-article
2154 gnus-score-followup-thread)
2156 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2157 gnus-current-score-file-nondirectory gnus-score-adaptive
2158 gnus-score-find-trace gnus-score-file-name)
2159 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2160 ("gnus-topic" :interactive t gnus-topic-mode)
2161 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2162 gnus-subscribe-topics)
2163 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2164 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2165 ("gnus-uu" :interactive t
2166 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2167 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2168 gnus-uu-mark-by-regexp gnus-uu-mark-all
2169 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2170 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2171 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2172 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2173 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2174 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2175 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2176 gnus-uu-mark-over gnus-uu-post-news)
2177 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2178 ("gnus-msg" (gnus-summary-send-map keymap)
2179 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2180 ("gnus-msg" :interactive t
2181 gnus-group-post-news gnus-group-mail gnus-group-news
2182 gnus-summary-post-news gnus-summary-news-other-window
2183 gnus-summary-followup gnus-summary-followup-with-original
2184 gnus-summary-cancel-article gnus-summary-supersede-article
2185 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2186 gnus-summary-mail-forward gnus-summary-mail-other-window
2187 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2188 gnus-summary-wide-reply gnus-summary-followup-to-mail
2189 gnus-summary-followup-to-mail-with-original gnus-bug
2190 gnus-summary-wide-reply-with-original
2191 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2192 gnus-summary-post-forward)
2193 ("gnus-picon" :interactive t gnus-treat-from-picon)
2194 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2195 gnus-grouplens-mode)
2196 ("smiley" :interactive t smiley-region)
2197 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2198 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2199 gnus-list-of-unread-articles gnus-list-of-read-articles
2200 gnus-offer-save-summaries gnus-make-thread-indent-array
2201 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2202 gnus-summary-skip-intangible gnus-summary-article-number
2203 gnus-data-header gnus-data-find)
2204 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2205 gnus-group-list-groups gnus-group-first-unread-group
2206 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2207 gnus-group-setup-buffer gnus-group-get-new-news
2208 gnus-group-make-help-group gnus-group-update-group
2209 gnus-group-iterate gnus-group-group-name)
2210 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2211 gnus-backlog-remove-article)
2212 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2213 gnus-article-prepare gnus-article-set-window-start
2214 gnus-article-next-page gnus-article-prev-page
2215 gnus-request-article-this-buffer gnus-article-mode
2216 gnus-article-setup-buffer gnus-narrow-to-page
2217 gnus-article-delete-invisible-text gnus-treat-article)
2218 ("gnus-art" :interactive t
2219 gnus-article-hide-headers gnus-article-hide-boring-headers
2220 gnus-article-treat-overstrike
2221 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2222 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2223 gnus-article-de-base64-unreadable
2224 gnus-article-decode-HZ
2225 gnus-article-wash-html
2226 gnus-article-unsplit-urls
2227 gnus-article-hide-pgp
2228 gnus-article-hide-pem gnus-article-hide-signature
2229 gnus-article-strip-leading-blank-lines gnus-article-date-local
2230 gnus-article-date-original gnus-article-date-lapsed
2231 ;; gnus-article-show-all-headers
2232 gnus-article-edit-mode gnus-article-edit-article
2233 gnus-article-edit-done gnus-article-decode-encoded-words
2234 gnus-start-date-timer gnus-stop-date-timer
2235 gnus-mime-view-all-parts)
2236 ("gnus-int" gnus-request-type)
2237 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2238 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2239 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2240 gnus-dup-enter-articles)
2241 ("gnus-range" gnus-copy-sequence)
2242 ("gnus-eform" gnus-edit-form)
2243 ("gnus-move" :interactive t
2244 gnus-group-move-group-to-server gnus-change-server)
2245 ("gnus-logic" gnus-score-advanced)
2246 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2247 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2248 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2249 gnus-async-halt-prefetch)
2250 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2251 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2252 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2253 gnus-summary-set-agent-mark gnus-agent-save-group-info
2254 gnus-agent-request-article gnus-agent-retrieve-headers)
2255 ("gnus-agent" :interactive t
2256 gnus-unplugged gnus-agentize gnus-agent-batch)
2257 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2258 gnus-summary-save-article-vm)
2259 ("compface" uncompface)
2260 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2261 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2262 ("gnus-mlspl" :interactive t gnus-group-split-setup
2263 gnus-group-split-update)
2264 ("gnus-delay" gnus-delay-initialize))))
2266 ;;; gnus-sum.el thingies
2269 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2270 "*The format specification of the lines in the summary buffer.
2272 It works along the same lines as a normal formatting string,
2273 with some simple extensions.
2275 %N Article number, left padded with spaces (string)
2277 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2278 %n Name of the poster (string)
2279 %a Extracted name of the poster (string)
2280 %A Extracted address of the poster (string)
2281 %F Contents of the From: header (string)
2282 %f Contents of the From: or To: headers (string)
2283 %x Contents of the Xref: header (string)
2284 %D Date of the article (string)
2285 %d Date of the article (string) in DD-MMM format
2286 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2287 %M Message-id of the article (string)
2288 %r References of the article (string)
2289 %c Number of characters in the article (integer)
2290 %k Pretty-printed version of the above (string)
2291 For example, \"1.2k\" or \"0.4M\".
2292 %L Number of lines in the article (integer)
2293 %I Indentation based on thread level (a string of spaces)
2294 %B A complex trn-style thread tree (string)
2295 The variables `gnus-sum-thread-*' can be used for customization.
2296 %T A string with two possible values: 80 spaces if the article
2297 is on thread level two or larger and 0 spaces on level one
2298 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2299 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2300 %[ Opening bracket (character, \"[\" or \"<\")
2301 %] Closing bracket (character, \"]\" or \">\")
2302 %> Spaces of length thread-level (string)
2303 %< Spaces of length (- 20 thread-level) (string)
2304 %i Article score (number)
2305 %z Article zcore (character)
2306 %t Number of articles under the current thread (number).
2307 %e Whether the thread is empty or not (character).
2308 %l GroupLens score (string).
2309 %V Total thread score (number).
2310 %P The line number (number).
2311 %O Download mark (character).
2312 %C If present, indicates desired cursor position
2313 (instead of after first colon).
2314 %u User defined specifier. The next character in the format string should
2315 be a letter. Gnus will call the function gnus-user-format-function-X,
2316 where X is the letter following %u. The function will be passed the
2317 current header as argument. The function should return a string, which
2318 will be inserted into the summary just like information from any other
2321 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2322 with care. For reasons of efficiency, Gnus will compute what column
2323 these characters will end up in, and \"hard-code\" that. This means that
2324 it is invalid to have these specs after a variable-length spec. Well,
2325 you might not be arrested, but your summary buffer will look strange,
2326 which is bad enough.
2328 The smart choice is to have these specs as far to the left as
2331 This restriction may disappear in later versions of Gnus.
2333 General format specifiers can also be used.
2334 See Info node `(gnus)Formatting Variables'."
2335 :link '(custom-manual "(gnus)Formatting Variables")
2337 :group 'gnus-summary-format)
2340 ;;; Skeleton keymaps
2343 (defun gnus-suppress-keymap (keymap)
2344 (suppress-keymap keymap)
2345 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2347 (define-key keymap (pop keys) 'undefined))))
2349 (defvar gnus-article-mode-map
2350 (let ((keymap (make-sparse-keymap)))
2351 (gnus-suppress-keymap keymap)
2353 (defvar gnus-summary-mode-map
2354 (let ((keymap (make-keymap)))
2355 (gnus-suppress-keymap keymap)
2357 (defvar gnus-group-mode-map
2358 (let ((keymap (make-keymap)))
2359 (gnus-suppress-keymap keymap)
2364 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2365 ;; If you want the cursor to go somewhere else, set these two
2366 ;; functions in some startup hook to whatever you want.
2367 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2368 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2370 ;;; Various macros and substs.
2372 (defun gnus-header-from (header)
2373 (mail-header-from header))
2375 (defmacro gnus-gethash (string hashtable)
2376 "Get hash value of STRING in HASHTABLE."
2377 `(symbol-value (intern-soft ,string ,hashtable)))
2379 (defmacro gnus-gethash-safe (string hashtable)
2380 "Get hash value of STRING in HASHTABLE.
2381 Return nil if not defined."
2382 `(let ((sym (intern-soft ,string ,hashtable)))
2383 (and (boundp sym) (symbol-value sym))))
2385 (defmacro gnus-sethash (string value hashtable)
2386 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2387 `(set (intern ,string ,hashtable) ,value))
2388 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2390 (defmacro gnus-group-unread (group)
2391 "Get the currently computed number of unread articles in GROUP."
2392 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2394 (defmacro gnus-group-entry (group)
2395 "Get the newsrc entry for GROUP."
2396 `(gnus-gethash ,group gnus-newsrc-hashtb))
2398 (defmacro gnus-active (group)
2399 "Get active info on GROUP."
2400 `(gnus-gethash ,group gnus-active-hashtb))
2402 (defmacro gnus-set-active (group active)
2403 "Set GROUP's active info."
2404 `(gnus-sethash ,group ,active gnus-active-hashtb))
2406 ;; Info access macros.
2408 (defmacro gnus-info-group (info)
2410 (defmacro gnus-info-rank (info)
2412 (defmacro gnus-info-read (info)
2414 (defmacro gnus-info-marks (info)
2416 (defmacro gnus-info-method (info)
2418 (defmacro gnus-info-params (info)
2421 (defmacro gnus-info-level (info)
2422 `(let ((rank (gnus-info-rank ,info)))
2426 (defmacro gnus-info-score (info)
2427 `(let ((rank (gnus-info-rank ,info)))
2428 (or (and (consp rank) (cdr rank)) 0)))
2430 (defmacro gnus-info-set-group (info group)
2431 `(setcar ,info ,group))
2432 (defmacro gnus-info-set-rank (info rank)
2433 `(setcar (nthcdr 1 ,info) ,rank))
2434 (defmacro gnus-info-set-read (info read)
2435 `(setcar (nthcdr 2 ,info) ,read))
2436 (defmacro gnus-info-set-marks (info marks &optional extend)
2438 `(gnus-info-set-entry ,info ,marks 3)
2439 `(setcar (nthcdr 3 ,info) ,marks)))
2440 (defmacro gnus-info-set-method (info method &optional extend)
2442 `(gnus-info-set-entry ,info ,method 4)
2443 `(setcar (nthcdr 4 ,info) ,method)))
2444 (defmacro gnus-info-set-params (info params &optional extend)
2446 `(gnus-info-set-entry ,info ,params 5)
2447 `(setcar (nthcdr 5 ,info) ,params)))
2449 (defun gnus-info-set-entry (info entry number)
2450 ;; Extend the info until we have enough elements.
2451 (while (<= (length info) number)
2452 (nconc info (list nil)))
2454 (setcar (nthcdr number info) entry))
2456 (defmacro gnus-info-set-level (info level)
2457 `(let ((rank (cdr ,info)))
2458 (if (consp (car rank))
2459 (setcar (car rank) ,level)
2460 (setcar rank ,level))))
2461 (defmacro gnus-info-set-score (info score)
2462 `(let ((rank (cdr ,info)))
2463 (if (consp (car rank))
2464 (setcdr (car rank) ,score)
2465 (setcar rank (cons (car rank) ,score)))))
2467 (defmacro gnus-get-info (group)
2468 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2470 ;;; Load the compatibility functions.
2479 (defvar gnus-shutdown-alist nil)
2481 (defun gnus-add-shutdown (function &rest symbols)
2482 "Run FUNCTION whenever one of SYMBOLS is shut down."
2483 (push (cons function symbols) gnus-shutdown-alist))
2485 (defun gnus-shutdown (symbol)
2486 "Shut down everything that waits for SYMBOL."
2487 (let ((alist gnus-shutdown-alist)
2489 (while (setq entry (pop alist))
2490 (when (memq symbol (cdr entry))
2491 (funcall (car entry))))))
2495 ;;; Gnus Utility Functions
2498 (defun gnus-find-subscribed-addresses ()
2499 "Return a regexp matching the addresses of all subscribed mail groups.
2500 It consists of the `to-address' or `to-list' parameter of all groups
2501 with a `subscribed' parameter."
2502 (let (group address addresses)
2503 (dolist (entry (cdr gnus-newsrc-alist))
2504 (setq group (car entry))
2505 (when (gnus-parameter-subscribed group)
2506 (setq address (mail-strip-quoted-names
2507 (or (gnus-group-fast-parameter group 'to-address)
2508 (gnus-group-fast-parameter group 'to-list))))
2510 (add-to-list 'addresses address))))
2512 (list (mapconcat 'regexp-quote addresses "\\|")))))
2514 (defmacro gnus-string-or (&rest strings)
2515 "Return the first element of STRINGS that is a non-blank string.
2516 STRINGS will be evaluated in normal `or' order."
2517 `(gnus-string-or-1 ',strings))
2519 (defun gnus-string-or-1 (strings)
2522 (setq string (eval (pop strings)))
2523 (if (string-match "^[ \t]*$" string)
2525 (setq strings nil)))
2528 (defun gnus-version (&optional arg)
2529 "Version number of this version of Gnus.
2530 If ARG, insert string at point."
2533 (insert (message gnus-version))
2534 (message gnus-version)))
2536 (defun gnus-continuum-version (&optional version)
2537 "Return VERSION as a floating point number."
2540 (setq version gnus-version))
2541 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2542 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2543 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2544 (number (match-string 2 version))
2546 (unless (string-match
2547 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2548 (error "Invalid version string: %s" version))
2549 (setq major (string-to-number (match-string 1 number))
2550 minor (string-to-number (match-string 2 number))
2551 least (if (match-beginning 3)
2552 (string-to-number (match-string 3 number))
2556 (format "%s00%02d%02d"
2557 (if (member alpha '("(ding)" "d"))
2561 (- (mm-char-int (aref (downcase alpha) 0))
2565 (format "%d.%02d%02d" major minor least))))))
2567 (defun gnus-info-find-node (&optional nodename)
2568 "Find Info documentation of Gnus."
2570 ;; Enlarge info window if needed.
2571 (let (gnus-info-buffer)
2572 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
2573 (setq gnus-info-buffer (current-buffer))
2574 (gnus-configure-windows 'info)))
2577 ;;; gnus-interactive
2580 (defvar gnus-current-prefix-symbol nil
2581 "Current prefix symbol.")
2583 (defvar gnus-current-prefix-symbols nil
2584 "List of current prefix symbols.")
2586 (defun gnus-interactive (string &optional params)
2587 "Return a list that can be fed to `interactive'.
2588 See `interactive' for full documentation.
2590 Adds the following specs:
2592 y -- The current symbolic prefix.
2593 Y -- A list of the current symbolic prefix(es).
2594 A -- Article number.
2595 H -- Article header.
2599 (while (< i (length string))
2600 (string-match ".\\([^\n]*\\)\n?" string i)
2601 (setq c (aref string i))
2603 (setq prompt (match-string 1 string)))
2604 (setq i (match-end 0))
2605 ;; We basically emulate just about everything that
2606 ;; `interactive' does, but add the specs listed above.
2610 (completing-read prompt obarray 'fboundp t))
2612 (read-buffer prompt (current-buffer) t))
2614 (read-buffer prompt (other-buffer (current-buffer))))
2618 (completing-read prompt obarray 'commandp t))
2622 (read-file-name prompt nil default-directory 'lambda))
2624 (read-file-name prompt nil nil 'lambda))
2626 (read-file-name prompt))
2628 (read-key-sequence prompt))
2630 (error "Not implemented spec"))
2632 (error "Not implemented spec"))
2636 (error "Not implemented spec"))
2638 (string-to-number (read-from-minibuffer prompt)))
2640 (prefix-numeric-value current-prefix-arg))
2646 (read-string prompt))
2648 (intern (read-string prompt)))
2650 (read-variable prompt))
2652 (read-minibuffer prompt))
2654 (eval-minibuffer prompt))
2655 ;; And here the new specs come.
2657 gnus-current-prefix-symbol)
2659 gnus-current-prefix-symbols)
2661 (gnus-group-group-name))
2663 (gnus-summary-skip-intangible)
2664 (or (get-text-property (point) 'gnus-number)
2665 (gnus-summary-last-subject)))
2667 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2669 (error "Non-implemented spec")))
2673 (push (if (< (point) (mark)) (point) (mark)) out)
2674 (push (if (> (point) (mark)) (point) (mark)) out))))
2675 (setq out (delq 'gnus-prefix-nil out))
2678 (defun gnus-symbolic-argument (&optional arg)
2679 "Read a symbolic argument and a command, and then execute command."
2681 (let* ((in-command (this-command-keys))
2682 (command in-command)
2683 gnus-current-prefix-symbols
2684 gnus-current-prefix-symbol
2686 (while (equal in-command command)
2687 (message "%s-" (key-description (this-command-keys)))
2688 (push (intern (char-to-string (read-char))) syms)
2689 (setq command (read-key-sequence nil t)))
2690 (setq gnus-current-prefix-symbols (nreverse syms)
2691 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2692 (call-interactively (key-binding command t))))
2694 ;;; More various functions.
2696 (defsubst gnus-check-backend-function (func group)
2697 "Check whether GROUP supports function FUNC.
2698 GROUP can either be a string (a group name) or a select method."
2700 (let ((method (if (stringp group)
2701 (car (gnus-find-method-for-group group))
2703 (unless (featurep method)
2705 (fboundp (intern (format "%s-%s" method func))))))
2707 (defun gnus-group-read-only-p (&optional group)
2708 "Check whether GROUP supports editing or not.
2709 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2710 that that variable is buffer-local to the summary buffers."
2711 (let ((group (or group gnus-newsgroup-name)))
2712 (not (gnus-check-backend-function 'request-replace-article group))))
2714 (defun gnus-virtual-group-p (group)
2715 "Say whether GROUP is virtual or not."
2716 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2717 gnus-valid-select-methods)))
2719 (defun gnus-news-group-p (group &optional article)
2720 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2721 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
2722 t) ;is news of course.
2723 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
2724 nil) ;must be mail then.
2725 ((vectorp article) ;Has header info.
2726 (eq (gnus-request-type group (mail-header-id article)) 'news))
2727 ((null article) ;Hasn't header info
2728 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
2729 ((< article 0) ;Virtual message
2730 nil) ;we don't know, guess mail.
2731 (t ;Has positive number
2732 (eq (gnus-request-type group article) 'news)))) ;use it.
2734 ;; Returns a list of writable groups.
2735 (defun gnus-writable-groups ()
2736 (let ((alist gnus-newsrc-alist)
2738 (while (setq group (car (pop alist)))
2739 (unless (gnus-group-read-only-p group)
2740 (push group groups)))
2743 ;; Check whether to use long file names.
2744 (defun gnus-use-long-file-name (symbol)
2745 ;; The variable has to be set...
2746 (and gnus-use-long-file-name
2747 ;; If it isn't a list, then we return t.
2748 (or (not (listp gnus-use-long-file-name))
2749 ;; If it is a list, and the list contains `symbol', we
2751 (not (memq symbol gnus-use-long-file-name)))))
2753 ;; Generate a unique new group name.
2754 (defun gnus-generate-new-group-name (leaf)
2757 (while (gnus-gethash name gnus-newsrc-hashtb)
2758 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2761 (defun gnus-ephemeral-group-p (group)
2762 "Say whether GROUP is ephemeral or not."
2763 (gnus-group-get-parameter group 'quit-config t))
2765 (defun gnus-group-quit-config (group)
2766 "Return the quit-config of GROUP."
2767 (gnus-group-get-parameter group 'quit-config t))
2769 (defun gnus-kill-ephemeral-group (group)
2770 "Remove ephemeral GROUP from relevant structures."
2771 (gnus-sethash group nil gnus-newsrc-hashtb))
2773 (defun gnus-simplify-mode-line ()
2774 "Make mode lines a bit simpler."
2775 (setq mode-line-modified (cdr gnus-mode-line-modified))
2776 (when (listp mode-line-format)
2777 (make-local-variable 'mode-line-format)
2778 (setq mode-line-format (copy-sequence mode-line-format))
2779 (when (equal (nth 3 mode-line-format) " ")
2780 (setcar (nthcdr 3 mode-line-format) " "))))
2782 ;;; Servers and groups.
2784 (defsubst gnus-server-add-address (method)
2785 (let ((method-name (symbol-name (car method))))
2786 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2787 (not (assq (intern (concat method-name "-address")) method))
2788 (memq 'physical-address (assq (car method)
2789 gnus-valid-select-methods)))
2790 (append method (list (list (intern (concat method-name "-address"))
2794 (defsubst gnus-server-to-method (server)
2795 "Map virtual server names to select methods."
2796 (or (and server (listp server) server)
2797 (cdr (assoc server gnus-server-method-cache))
2800 ;; Perhaps this is the native server?
2801 (and (equal server "native") gnus-select-method)
2802 ;; It should be in the server alist.
2803 (cdr (assoc server gnus-server-alist))
2804 ;; It could be in the predefined server alist.
2805 (cdr (assoc server gnus-predefined-server-alist))
2806 ;; If not, we look through all the opened server
2807 ;; to see whether we can find it there.
2808 (let ((opened gnus-opened-servers))
2810 (not (equal server (format "%s:%s" (caaar opened)
2814 ;; It could be a named method, search all servers
2815 (let ((servers gnus-secondary-select-methods))
2817 (not (equal server (format "%s:%s" (caar servers)
2821 (push (cons server result) gnus-server-method-cache)
2824 (defsubst gnus-server-get-method (group method)
2825 ;; Input either a server name, and extended server name, or a
2826 ;; select method, and return a select method.
2827 (cond ((stringp method)
2828 (gnus-server-to-method method))
2829 ((equal method gnus-select-method)
2831 ((and (stringp (car method))
2833 (gnus-server-extend-method group method))
2836 (equal (cadr method) ""))
2839 (gnus-server-add-address method))))
2841 (defmacro gnus-method-equal (ss1 ss2)
2842 "Say whether two servers are equal."
2846 (and (= (length s1) (length s2))
2848 (while (and s1 (member (car s1) s2))
2852 (defun gnus-methods-equal-p (m1 m2)
2853 (let ((m1 (or m1 gnus-select-method))
2854 (m2 (or m2 gnus-select-method)))
2856 (and (eq (car m1) (car m2))
2857 (or (not (memq 'address (assoc (symbol-name (car m1))
2858 gnus-valid-select-methods)))
2859 (equal (nth 1 m1) (nth 1 m2)))))))
2861 (defun gnus-server-equal (m1 m2)
2862 "Say whether two methods are equal."
2863 (let ((m1 (cond ((null m1) gnus-select-method)
2864 ((stringp m1) (gnus-server-to-method m1))
2866 (m2 (cond ((null m2) gnus-select-method)
2867 ((stringp m2) (gnus-server-to-method m2))
2869 (gnus-method-equal m1 m2)))
2871 (defun gnus-servers-using-backend (backend)
2872 "Return a list of known servers using BACKEND."
2873 (let ((opened gnus-opened-servers)
2876 (when (eq backend (caaar opened))
2877 (push (caar opened) out))
2881 (defun gnus-archive-server-wanted-p ()
2882 "Say whether the user wants to use the archive server."
2884 ((or (not gnus-message-archive-method)
2885 (not gnus-message-archive-group))
2887 ((and gnus-message-archive-method gnus-message-archive-group)
2890 (let ((active (cadr (assq 'nnfolder-active-file
2891 gnus-message-archive-method))))
2893 (file-exists-p active))))))
2895 (defsubst gnus-method-to-server-name (method)
2897 (format "%s" (car method))
2899 (or (assoc (format "%s" (car method))
2900 (gnus-methods-using 'address))
2901 (gnus-server-equal method gnus-message-archive-method))
2903 (not (string= (nth 1 method) "")))
2904 (concat "+" (nth 1 method)))))
2906 (defsubst gnus-method-to-full-server-name (method)
2907 (format "%s+%s" (car method) (nth 1 method)))
2909 (defun gnus-group-prefixed-name (group method)
2910 "Return the whole name from GROUP and METHOD."
2911 (and (stringp method) (setq method (gnus-server-to-method method)))
2912 (if (or (not method)
2913 (gnus-server-equal method "native")
2914 (string-match ":" group))
2916 (concat (gnus-method-to-server-name method) ":" group)))
2918 (defun gnus-group-real-prefix (group)
2919 "Return the prefix of the current group name."
2920 (if (string-match "^[^:]+:" group)
2921 (substring group 0 (match-end 0))
2924 (defun gnus-group-method (group)
2925 "Return the server or method used for selecting GROUP.
2926 You should probably use `gnus-find-method-for-group' instead."
2927 (let ((prefix (gnus-group-real-prefix group)))
2928 (if (equal prefix "")
2930 (let ((servers gnus-opened-servers)
2932 backend possible found)
2933 (if (string-match "^[^\\+]+\\+" prefix)
2934 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2935 server (substring prefix (match-end 0) (1- (length prefix))))
2936 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2938 (when (eq (caaar servers) backend)
2939 (setq possible (caar servers))
2940 (when (equal (cadaar servers) server)
2941 (setq found (caar servers))))
2943 (or (car (rassoc found gnus-server-alist))
2945 (car (rassoc possible gnus-server-alist))
2947 (list backend server))))))
2949 (defsubst gnus-native-method-p (method)
2950 "Return whether METHOD is the native select method."
2951 (gnus-method-equal method gnus-select-method))
2953 (defsubst gnus-secondary-method-p (method)
2954 "Return whether METHOD is a secondary select method."
2955 (let ((methods gnus-secondary-select-methods)
2956 (gmethod (gnus-server-get-method nil method)))
2958 (not (gnus-method-equal
2959 (gnus-server-get-method nil (car methods))
2961 (setq methods (cdr methods)))
2964 (defun gnus-method-simplify (method)
2965 "Return the shortest uniquely identifying string or method for METHOD."
2966 (cond ((stringp method)
2968 ((gnus-native-method-p method)
2970 ((gnus-secondary-method-p method)
2971 (format "%s:%s" (nth 0 method) (nth 1 method)))
2975 (defun gnus-groups-from-server (server)
2976 "Return a list of all groups that are fetched from SERVER."
2977 (let ((alist (cdr gnus-newsrc-alist))
2979 (while (setq info (pop alist))
2980 (when (gnus-server-equal (gnus-info-method info) server)
2981 (push (gnus-info-group info) groups)))
2982 (sort groups 'string<)))
2984 (defun gnus-group-foreign-p (group)
2985 "Say whether a group is foreign or not."
2986 (and (not (gnus-group-native-p group))
2987 (not (gnus-group-secondary-p group))))
2989 (defun gnus-group-native-p (group)
2990 "Say whether the group is native or not."
2991 (not (string-match ":" group)))
2993 (defun gnus-group-secondary-p (group)
2994 "Say whether the group is secondary or not."
2995 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2997 (defun gnus-parameters-get-parameter (group)
2998 "Return the group parameters for GROUP from `gnus-parameters'."
3000 (dolist (elem gnus-parameters)
3001 (when (string-match (car elem) group)
3003 (nconc (gnus-expand-group-parameters
3004 (car elem) (cdr elem) group)
3008 (defun gnus-expand-group-parameter (match value group)
3009 "Use MATCH to expand VALUE in GROUP."
3012 (goto-char (point-min))
3013 (while (re-search-forward match nil t)
3014 (replace-match value))
3017 (defun gnus-expand-group-parameters (match parameters group)
3018 "Go through PARAMETERS and expand them according to the match data."
3020 (dolist (elem parameters)
3021 (if (and (stringp (cdr elem))
3022 (string-match "\\\\[0-9&]" (cdr elem)))
3023 (push (cons (car elem)
3024 (gnus-expand-group-parameter match (cdr elem) group))
3029 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3030 "For GROUP, return the value of SYMBOL.
3032 You should call this in the `gnus-group-buffer' buffer.
3033 The function `gnus-group-find-parameter' will do that for you."
3034 ;; The speed trick: No cons'ing and quit early.
3035 (or (let ((params (funcall gnus-group-get-parameter-function group)))
3036 ;; Start easy, check the "real" group parameters.
3037 (gnus-group-parameter-value params symbol allow-list))
3038 ;; We didn't found it there, try `gnus-parameters'.
3041 (tail gnus-parameters))
3042 ;; A good old-fashioned non-cl loop.
3044 (setq head (car tail)
3046 ;; The car is regexp matching for matching the group name.
3047 (when (string-match (car head) group)
3048 ;; The cdr is the parameters.
3049 (setq result (gnus-group-parameter-value (cdr head)
3052 ;; Expand if necessary.
3053 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3054 (setq result (gnus-expand-group-parameter (car head)
3056 ;; Exit the loop early.
3061 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3062 "Return the group parameters for GROUP.
3063 If SYMBOL, return the value of that symbol in the group parameters.
3065 If you call this function inside a loop, consider using the faster
3066 `gnus-group-fast-parameter' instead."
3068 (set-buffer gnus-group-buffer)
3070 (gnus-group-fast-parameter group symbol allow-list)
3073 (funcall gnus-group-get-parameter-function group))
3074 (gnus-parameters-get-parameter group)))))
3076 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3077 "Return the group parameters for GROUP.
3078 If SYMBOL, return the value of that symbol in the group parameters.
3079 Most functions should use `gnus-group-find-parameter', which
3080 also examines the topic parameters."
3081 (let ((params (gnus-info-params (gnus-get-info group))))
3083 (gnus-group-parameter-value params symbol allow-list)
3086 (defun gnus-group-parameter-value (params symbol &optional allow-list)
3087 "Return the value of SYMBOL in group PARAMS."
3088 ;; We only wish to return group parameters (dotted lists) and
3089 ;; not local variables, which may have the same names.
3090 ;; But first we handle single elements...
3091 (or (car (memq symbol params))
3095 (while (setq elem (pop params))
3096 (when (and (consp elem)
3097 (eq (car elem) symbol)
3100 (throw 'found (cdr elem))))))))
3102 (defun gnus-group-add-parameter (group param)
3103 "Add parameter PARAM to GROUP."
3104 (let ((info (gnus-get-info group)))
3106 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3107 ;; Cons the new param to the old one and update.
3108 (gnus-group-set-info (cons param (gnus-info-params info))
3111 (defun gnus-group-set-parameter (group name value)
3112 "Set parameter NAME to VALUE in GROUP."
3113 (let ((info (gnus-get-info group)))
3115 (gnus-group-remove-parameter group name)
3116 (let ((old-params (gnus-info-params info))
3117 (new-params (list (cons name value))))
3119 (when (or (not (listp (car old-params)))
3120 (not (eq (caar old-params) name)))
3121 (setq new-params (append new-params (list (car old-params)))))
3122 (setq old-params (cdr old-params)))
3123 (gnus-group-set-info new-params group 'params)))))
3125 (defun gnus-group-remove-parameter (group name)
3126 "Remove parameter NAME from GROUP."
3127 (let ((info (gnus-get-info group)))
3129 (let ((params (gnus-info-params info)))
3131 (setq params (delq name params))
3132 (while (assq name params)
3133 (gnus-pull name params))
3134 (gnus-info-set-params info params))))))
3136 (defun gnus-group-add-score (group &optional score)
3137 "Add SCORE to the GROUP score.
3138 If SCORE is nil, add 1 to the score of GROUP."
3139 (let ((info (gnus-get-info group)))
3141 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3143 (defun gnus-short-group-name (group &optional levels)
3144 "Collapse GROUP name LEVELS.
3145 Select methods are stripped and any remote host name is stripped down to
3146 just the host name."
3152 gnus-group-uncollapsed-levels
3154 (while (string-match "\\." group skip)
3155 (setq skip (match-end 0)
3158 ;; Separate foreign select method from group name and collapse.
3159 ;; If method contains a server, collapse to non-domain server name,
3160 ;; otherwise collapse to select method.
3161 (let* ((colon (string-match ":" group))
3162 (server (and colon (substring group 0 colon)))
3163 (plus (and server (string-match "+" server))))
3166 (setq foreign (substring server (+ 1 plus)
3167 (string-match "\\." server))
3168 group (substring group (+ 1 colon)))
3169 (setq foreign server
3170 group (substring group (+ 1 colon))))
3171 (setq foreign (concat foreign ":")))
3172 ;; Collapse group name leaving LEVELS uncollapsed elements
3173 (let* ((slist (split-string group "/"))
3174 (slen (length slist))
3175 (dlist (split-string group "\\."))
3176 (dlen (length dlist))
3188 (setq levels (- glen levels))
3190 (push (if (>= (decf levels) 0)
3191 (if (zerop (length g))
3196 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3198 (defun gnus-narrow-to-body ()
3199 "Narrow to the body of an article."
3202 (goto-char (point-min))
3203 (or (search-forward "\n\n" nil t)
3209 ;;; Kill file handling.
3212 (defun gnus-apply-kill-file ()
3213 "Apply a kill file to the current newsgroup.
3214 Returns the number of articles marked as read."
3215 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3216 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3217 (gnus-apply-kill-file-internal)
3220 (defun gnus-kill-save-kill-buffer ()
3221 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3222 (when (get-file-buffer file)
3224 (set-buffer (get-file-buffer file))
3225 (when (buffer-modified-p)
3227 (kill-buffer (current-buffer))))))
3229 (defcustom gnus-kill-file-name "KILL"
3230 "Suffix of the kill files."
3231 :group 'gnus-score-kill
3232 :group 'gnus-score-files
3235 (defun gnus-newsgroup-kill-file (newsgroup)
3236 "Return the name of a kill file name for NEWSGROUP.
3237 If NEWSGROUP is nil, return the global kill file name instead."
3239 ;; The global KILL file is placed at top of the directory.
3240 ((or (null newsgroup)
3241 (string-equal newsgroup ""))
3242 (expand-file-name gnus-kill-file-name
3243 gnus-kill-files-directory))
3244 ;; Append ".KILL" to newsgroup name.
3245 ((gnus-use-long-file-name 'not-kill)
3246 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3247 "." gnus-kill-file-name)
3248 gnus-kill-files-directory))
3249 ;; Place "KILL" under the hierarchical directory.
3251 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3252 "/" gnus-kill-file-name)
3253 gnus-kill-files-directory))))
3257 (defun gnus-member-of-valid (symbol group)
3258 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3260 (symbol-name (car (gnus-find-method-for-group group)))
3261 gnus-valid-select-methods)))
3263 (defun gnus-method-option-p (method option)
3264 "Return non-nil if select METHOD has OPTION as a parameter."
3265 (when (stringp method)
3266 (setq method (gnus-server-to-method method)))
3267 (memq option (assoc (format "%s" (car method))
3268 gnus-valid-select-methods)))
3270 (defun gnus-similar-server-opened (method)
3271 (let ((opened gnus-opened-servers))
3272 (while (and method opened)
3273 (when (and (equal (cadr method) (cadaar opened))
3274 (equal (car method) (caaar opened))
3275 (not (equal method (caar opened))))
3280 (defun gnus-server-extend-method (group method)
3281 ;; This function "extends" a virtual server. If the server is
3282 ;; "hello", and the select method is ("hello" (my-var "something"))
3283 ;; in the group "alt.alt", this will result in a new virtual server
3284 ;; called "hello+alt.alt".
3285 (if (or (not (inline (gnus-similar-server-opened method)))
3286 (not (cddr method)))
3288 `(,(car method) ,(concat (cadr method) "+" group)
3289 (,(intern (format "%s-address" (car method))) ,(cadr method))
3292 (defun gnus-server-status (method)
3293 "Return the status of METHOD."
3294 (nth 1 (assoc method gnus-opened-servers)))
3296 (defun gnus-group-name-to-method (group)
3297 "Guess a select method based on GROUP."
3298 (if (string-match ":" group)
3299 (let ((server (substring group 0 (match-beginning 0))))
3300 (if (string-match "\\+" server)
3301 (list (intern (substring server 0 (match-beginning 0)))
3302 (substring server (match-end 0)))
3303 (list (intern server) "")))
3304 gnus-select-method))
3306 (defun gnus-server-string (server)
3307 "Return a readable string that describes SERVER."
3308 (let* ((server (gnus-server-to-method server))
3309 (address (nth 1 server)))
3311 (not (zerop (length address))))
3312 (format "%s using %s" address (car server))
3313 (format "%s" (car server)))))
3315 (defun gnus-find-method-for-group (group &optional info)
3316 "Find the select method that GROUP uses."
3317 (or gnus-override-method
3320 (and (not (gnus-group-entry group)) ;; a new group
3321 (gnus-group-name-to-method group))
3322 (let ((info (or info (gnus-get-info group)))
3325 (not (setq method (gnus-info-method info)))
3326 (equal method "native"))
3329 (cond ((stringp method)
3330 (inline (gnus-server-to-method method)))
3331 ((stringp (cadr method))
3332 (inline (gnus-server-extend-method group method)))
3335 (cond ((equal (cadr method) "")
3337 ((null (cadr method))
3338 (list (car method) ""))
3340 (gnus-server-add-address method)))))))
3342 (defun gnus-methods-using (feature)
3343 "Find all methods that have FEATURE."
3344 (let ((valids gnus-valid-select-methods)
3347 (when (memq feature (car valids))
3348 (push (car valids) outs))
3349 (setq valids (cdr valids)))
3352 (defun gnus-read-group (prompt &optional default)
3353 "Prompt the user for a group name.
3354 Disallow invalid group names."
3359 gnus-invalid-group-regexp
3360 (setq group (read-string (concat prefix prompt)
3361 (cons (or default "") 0)
3362 'gnus-group-history)))
3363 (setq prefix (format "Invalid group name: \"%s\". " group)
3367 (defun gnus-read-method (prompt)
3368 "Prompt the user for a method.
3369 Allow completion over sensible values."
3370 (let* ((open-servers
3371 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3372 gnus-opened-servers))
3375 (dolist (method gnus-valid-select-methods)
3376 (if (or (memq 'prompt-address method)
3377 (not (assoc (format "%s:" (car method)) open-servers)))
3378 (push method methods)))
3381 (append valid-methods
3383 gnus-predefined-server-alist
3388 nil t nil 'gnus-method-history)))
3391 (setq method gnus-select-method))
3392 ((assoc method gnus-valid-select-methods)
3393 (let ((address (if (memq 'prompt-address
3394 (assoc method gnus-valid-select-methods))
3395 (read-string "Address: ")
3397 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3398 (list (intern method) address))))
3399 ((assoc method servers)
3402 (list (intern method) "")))))
3406 (defun gnus-agent-method-p (method)
3407 "Say whether METHOD is covered by the agent."
3408 (member method gnus-agent-covered-methods))
3410 (defun gnus-online (method)
3413 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3414 (gnus-agent-method-p method))))
3416 ;;; User-level commands.
3419 (defun gnus-slave-no-server (&optional arg)
3420 "Read network news as a slave, without connecting to the local server."
3422 (gnus-no-server arg t))
3425 (defun gnus-no-server (&optional arg slave)
3427 If ARG is a positive number, Gnus will use that as the startup
3428 level. If ARG is nil, Gnus will be started at level 2. If ARG is
3429 non-nil and not a positive number, Gnus will prompt the user for the
3430 name of an NNTP server to use.
3431 As opposed to `gnus', this command will not connect to the local
3434 (gnus-no-server-1 arg slave))
3437 (defun gnus-slave (&optional arg)
3438 "Read news as a slave."
3440 (gnus arg nil 'slave))
3443 (defun gnus-other-frame (&optional arg display)
3444 "Pop up a frame to read news.
3445 This will call one of the Gnus commands which is specified by the user
3446 option `gnus-other-frame-function' (default `gnus') with the argument
3447 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
3448 optional second argument DISPLAY should be a standard display string
3449 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
3450 omitted or the function `make-frame-on-display' is not available, the
3451 current display is used."
3453 (if (fboundp 'make-frame-on-display)
3455 (setq display (gnus-frame-or-window-display-name (selected-frame))))
3457 (let ((alive (gnus-alive-p)))
3462 (when (and (or (not display)
3464 (gnus-frame-or-window-display-name
3466 (with-current-buffer (window-buffer window)
3467 (string-match "\\`gnus-"
3468 (symbol-name major-mode))))
3469 (gnus-select-frame-set-input-focus
3470 (setq gnus-other-frame-object (window-frame window)))
3471 (select-window window)
3474 (gnus-select-frame-set-input-focus
3475 (setq gnus-other-frame-object
3477 (make-frame-on-display display gnus-other-frame-parameters)
3478 (make-frame gnus-other-frame-parameters))))
3480 (switch-to-buffer gnus-group-buffer)
3481 (funcall gnus-other-frame-function arg)
3482 (add-hook 'gnus-exit-gnus-hook
3484 (when (and (frame-live-p gnus-other-frame-object)
3486 (delete-frame gnus-other-frame-object))
3487 (setq gnus-other-frame-object nil)))))))
3489 ;;(setq thing ? ; this is a comment
3493 (defun gnus (&optional arg dont-connect slave)
3495 If ARG is non-nil and a positive number, Gnus will use that as the
3496 startup level. If ARG is non-nil and not a positive number, Gnus will
3497 prompt the user for the name of an NNTP server to use."
3499 (unless (byte-code-function-p (symbol-function 'gnus))
3500 (message "You should byte-compile Gnus")
3502 (gnus-1 arg dont-connect slave))
3504 ;; Allow redefinition of Gnus functions.
3510 ;;; gnus.el ends here