Document interface to functions called from mail-sources.

diff --git a/texi/ChangeLog b/texi/ChangeLog
index 9da311d..e3a9d39 100644 (file)
--- a/texi/ChangeLog
+++ b/texi/ChangeLog
@@ -1,3 +1,9 @@
+2000-08-14  Kai Grossjohann  <Kai.Grossjohann@CS.Uni-Dortmund.DE>
+
+       * gnus.texi (Mail Source Specifiers): Try to document the
+       interface to the functions called via (among others) the
+       `:function' keyword.
+
 2000-08-13 20:00:35  ShengHuo ZHU  <zsh@cs.rochester.edu>
 
        * gnus.texi (Topic Commands): Fix typo.

diff --git a/texi/gnus.texi b/texi/gnus.texi
index 1fa3b9d..d25e646 100644 (file)
--- a/texi/gnus.texi
+++ b/texi/gnus.texi
@@ -11376,6 +11376,27 @@ useful when you use local mail and news.
 @end table
 @end table
 
+@paragraph Function Interface
+
+Some of the above keywords specify a Lisp function to be executed.
+For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
+the value of the keyword while the function is executing.  For example,
+consider the following mail-source setting:
+
+@lisp
+(setq mail-sources '((pop :user "jrl"
+                          :server "pophost" :function fetchfunc)))
+@end lisp
+
+While the function @code{fetchfunc} is executing, the symbol @code{user}
+is bound to @code{"jrl"}, and the symbol @code{server} is bound to
+@code{"pophost"}.  The symbols @code{port}, @code{password},
+@code{program}, @code{prescript}, @code{postscript}, @code{function},
+and @code{authentication} are also bound (to their default values).
+
+See above for a list of keywords for each type of mail source.
+
+
 @node Mail Source Customization
 @subsubsection Mail Source Customization