Variable: gnus-agent-parameters

gnus-agent-parameters is a variable defined in gnus-cus.el.gz.

Value

((agent-predicate (sexp :tag "Selection Predicate" :value false)
		  "Predicate used to automatically select articles for downloading."
		  gnus-agent-cat-predicate)
 (agent-score
  (choice :tag "Score File" :value nil
	  (const :value file :tag "Use group's score files")
	  (repeat (list (string :format "%v" :tag "File name"))))
  "Which score files to use when using score to select articles to fetch.\n\n    nil\n         All articles will be scored to zero (0).\n\n    `file'\n         The group's score files will be used to score the articles.\n\n    `List'\n         A list of score file names."
  gnus-agent-cat-score-file)
 (agent-short-article
  (integer :tag "Max Length of Short Article" :value "")
  "The SHORT predicate will evaluate to true when the article is\nshorter than this length."
  gnus-agent-cat-length-when-short)
 (agent-long-article
  (integer :tag "Min Length of Long Article" :value "")
  "The LONG predicate will evaluate to true when the article is\nlonger than this length."
  gnus-agent-cat-length-when-long)
 (agent-low-score (integer :tag "Low Score Limit" :value "")
		  "The LOW predicate will evaluate to true when the article scores\nlower than this limit."
		  gnus-agent-cat-low-score)
 (agent-high-score (integer :tag "High Score Limit" :value "")
		   "The HIGH predicate will evaluate to true when the article scores\nhigher than this limit."
		   gnus-agent-cat-high-score)
 (agent-days-until-old (integer :tag "Days Until Old" :value "")
		       "The OLD predicate will evaluate to true when the fetched article\nhas been stored locally for at least this many days."
		       gnus-agent-cat-days-until-old)
 (agent-enable-expiration
  (radio :tag "Expire in this Group or Topic" :value nil
	 (const :format "Enable " ENABLE)
	 (const :format "Disable " DISABLE))
  "\nEnable, or disable, agent expiration in this group or topic."
  gnus-agent-cat-enable-expiration)
 (agent-enable-undownloaded-faces (boolean :tag "Enable Agent Faces")
				  "Have the summary buffer use the agent's undownloaded faces.\nThese faces, when enabled, act as a warning that an article has not\nbeen fetched into either the agent nor the cache.  This is of most use\nto users who use the agent as a cache (i.e. they only operate on\narticles that have been downloaded).  Leave disabled to display normal\narticle faces even when the article hasn't been downloaded."
				  gnus-agent-cat-enable-undownloaded-faces))

Documentation

Alist of group parameters that are not also topic parameters.

Each entry has the form (NAME TYPE DOC ACCESSOR), where NAME is the parameter itself (a symbol), TYPE is the parameters type (a sexp widget), DOC is a documentation string for the parameter, and ACCESSOR is a function (symbol) that extracts the current value from the category.

Source Code

;; Defined in /usr/src/emacs/lisp/gnus/gnus-cus.el.gz
(eval-and-compile
  (defconst gnus-agent-parameters
    '((agent-predicate
       (sexp :tag "Selection Predicate" :value false)
       "Predicate used to automatically select articles for downloading."
       gnus-agent-cat-predicate)
      (agent-score
       (choice :tag "Score File" :value nil
               (const :value file :tag "Use group's score files")
               (repeat (list (string :format "%v" :tag "File name"))))
       "Which score files to use when using score to select articles to fetch.

    nil
         All articles will be scored to zero (0).

    `file'
         The group's score files will be used to score the articles.

    `List'
         A list of score file names."
       gnus-agent-cat-score-file)
      (agent-short-article
       (integer :tag "Max Length of Short Article" :value "")
       "The SHORT predicate will evaluate to true when the article is
shorter than this length."  gnus-agent-cat-length-when-short)
      (agent-long-article
       (integer :tag "Min Length of Long Article" :value "")
       "The LONG predicate will evaluate to true when the article is
longer than this length."  gnus-agent-cat-length-when-long)
      (agent-low-score
       (integer :tag "Low Score Limit" :value "")
       "The LOW predicate will evaluate to true when the article scores
lower than this limit."  gnus-agent-cat-low-score)
      (agent-high-score
       (integer :tag "High Score Limit" :value "")
       "The HIGH predicate will evaluate to true when the article scores
higher than this limit."  gnus-agent-cat-high-score)
      (agent-days-until-old
       (integer :tag "Days Until Old" :value "")
       "The OLD predicate will evaluate to true when the fetched article
has been stored locally for at least this many days."
       gnus-agent-cat-days-until-old)
      (agent-enable-expiration
       (radio :tag "Expire in this Group or Topic" :value nil
              (const :format "Enable " ENABLE)
              (const :format "Disable " DISABLE))
       "\nEnable, or disable, agent expiration in this group or topic."
       gnus-agent-cat-enable-expiration)
      (agent-enable-undownloaded-faces
       (boolean :tag "Enable Agent Faces")
       "Have the summary buffer use the agent's undownloaded faces.
These faces, when enabled, act as a warning that an article has not
been fetched into either the agent nor the cache.  This is of most use
to users who use the agent as a cache (i.e. they only operate on
articles that have been downloaded).  Leave disabled to display normal
article faces even when the article hasn't been downloaded."
gnus-agent-cat-enable-undownloaded-faces))
    "Alist of group parameters that are not also topic parameters.

Each entry has the form (NAME TYPE DOC ACCESSOR), where NAME is the
parameter itself (a symbol), TYPE is the parameters type (a sexp
widget), DOC is a documentation string for the parameter, and ACCESSOR
is a function (symbol) that extracts the current value from the
category."))