Variable: gnus-group-parameters

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

Value

((extra-aliases
  (choice :tag "Extra Aliases"
	  (list :tag "List"
		(editable-list :inline t
			       (gnus-email-address :tag "Address")))
	  (gnus-email-address :tag "Address"))
  "Store messages posted from or to this address in this group.\n\nYou must be using gnus-group-split for this to work.  The VALUE of the\nnnmail-split-fancy SPLIT generated for this group will match these\naddresses.")
 (split-regexp (regexp :tag "gnus-group-split Regular Expression")
	       "Like gnus-group-split Address, but expects a regular expression.")
 (split-exclude
  (list :tag "gnus-group-split Restricts"
	(editable-list :inline t (regexp :tag "Restrict")))
  "Regular expression that cancels gnus-group-split matches.\n\nEach entry is added to the nnmail-split-fancy SPLIT as a separate\nRESTRICT clause.")
 (split-spec
  (choice :tag "gnus-group-split Overrider" (sexp :tag "Fancy Split")
	  (const :tag "Catch All" catch-all) (const :tag "Ignore" nil))
  "Override all other gnus-group-split fields.\n\nIn `Fancy Split', you can enter any nnmail-split-fancy SPLIT.  Note\nthat the name of this group won't be automatically assumed, you have\nto add it to the SPLITs yourself.  This means you can use such splits\nto split messages to other groups too.\n\nIf you select `Catch All', this group will get postings for any\nmessages not matched in any other group.  It overrides the variable\ngnus-group-split-default-catch-all-group.\n\nSelecting `Ignore' forces no SPLIT to be generated for this group,\ndisabling all other gnus-group-split fields.")
 (broken-reply-to (const :tag "Broken Reply To" t)
		  "Ignore `Reply-To' headers in this group.\n\nThat can be useful if you're reading a mailing list group where the\nlistserv has inserted `Reply-To' headers that point back to the\nlistserv itself.  This is broken behavior.  So there!")
 (to-group (string :tag "To Group")
	   "All posts will be sent to the specified group.")
 (gcc-self
  (choice :tag "GCC" :value t (const :tag "To current group" t)
	  (const none) (string :format "%v" :hide-front-space t))
  "Specify default value for GCC header.\n\nIf this symbol is present in the group parameter list and set to t,\nnew composed messages will be `Gcc''d to the current group.  If it is\npresent and set to `none', no `Gcc:' header will be generated, if it\nis present and a string, this string will be inserted literally as a\n`gcc' header (this symbol takes precedence over any default `Gcc'\nrules as described later).")
 (expiry-wait
  (choice :tag "Expire Wait" :value never (const never)
	  (const immediate) (number :hide-front-space t :format "%v"))
  "When to expire.\n\nOverrides any `nnmail-expiry-wait' or `nnmail-expiry-wait-function'\nsettings when expiring expirable messages.  The value can be\neither a number of days (not necessarily an integer), or one of\nthe symbols `never' or `immediate'.")
 (expiry-target
  (choice :tag "Expiry Target" :value delete (const delete)
	  (function :format "%v" nnmail-) string)
  "Where expired messages end up.\n\nOverrides `nnmail-expiry-target'.")
 (score-file (file :tag "Score File")
	     "Make the specified file into the current score file.\nThis means that all score commands you issue will end up in this file.")
 (adapt-file (file :tag "Adapt File")
	     "Make the specified file into the current adaptive file.\nAll adaptive score entries will be put into this file.")
 (admin-address (gnus-email-address :tag "Admin Address")
		"Administration address for a mailing list.\n\nWhen unsubscribing to a mailing list you should never send the\nunsubscription notice to the mailing list itself.  Instead, you'd\nsend messages to the administrative address.  This parameter allows\nyou to put the admin address somewhere convenient.")
 (display
  (choice :tag "Display" :value default (const all) (integer)
	  (const default) (sexp :tag "Other"))
  "Which articles to display on entering the group.\n\n`all'\n     Display all articles, both read and unread.\n\n`integer'\n     Display the last NUMBER articles in the group.  This is the same as\n     entering the group with C-u NUMBER.\n\n`default'\n     Display the default visible articles, which normally includes\n     unread and ticked articles.\n\n`Other'\n     Display the articles that satisfy the S-expression.  The S-expression\n     should be in an array form.")
 (comment (string :tag "Comment") "An arbitrary comment on the group.")
 (visible (const :tag "Permanently visible" t)
	  "Always display this group, even when there are no unread articles in it.")
 (highlight-words
  (choice :tag "Highlight words" :value nil
	  (repeat
	   (list (regexp :tag "Highlight regexp")
		 (number :tag "Group for entire word" 0)
		 (number :tag "Group for displayed part" 0)
		 (symbol :tag "Face" gnus-emphasis-highlight-words))))
  "highlight regexps.\nSee `gnus-emphasis-alist'.")
 (posting-style
  (choice :tag "Posting style" :value nil
	  (repeat
	   (list
	    (choice :tag "Type" :value nil (const signature)
		    (const signature-file) (const organization)
		    (const address) (const x-face-file) (const name)
		    (const body) (symbol) (string :tag "Header"))
	    (string :format "%v"))))
  "post style.\nSee `gnus-posting-styles'."))

Documentation

Alist of valid group or topic parameters.

Each entry has the form (NAME TYPE DOC), where NAME is the parameter itself (a symbol), TYPE is the parameters type (a sexp widget), and DOC is a documentation string for the parameter.

Source Code

;; Defined in /usr/src/emacs/lisp/gnus/gnus-cus.el.gz
;;; Group Customization:

(defconst gnus-group-parameters
  '((extra-aliases (choice
		    :tag "Extra Aliases"
		    (list
		     :tag "List"
		     (editable-list
		      :inline t
		      (gnus-email-address :tag "Address")))
		    (gnus-email-address :tag "Address")) "\
Store messages posted from or to this address in this group.

You must be using gnus-group-split for this to work.  The VALUE of the
nnmail-split-fancy SPLIT generated for this group will match these
addresses.")

    (split-regexp (regexp :tag "gnus-group-split Regular Expression") "\
Like gnus-group-split Address, but expects a regular expression.")

    (split-exclude (list :tag "gnus-group-split Restricts"
			 (editable-list
			  :inline t (regexp :tag "Restrict"))) "\
Regular expression that cancels gnus-group-split matches.

Each entry is added to the nnmail-split-fancy SPLIT as a separate
RESTRICT clause.")

    (split-spec (choice :tag "gnus-group-split Overrider"
			(sexp :tag "Fancy Split")
			(const :tag "Catch All" catch-all)
			(const :tag "Ignore" nil)) "\
Override all other gnus-group-split fields.

In `Fancy Split', you can enter any nnmail-split-fancy SPLIT.  Note
that the name of this group won't be automatically assumed, you have
to add it to the SPLITs yourself.  This means you can use such splits
to split messages to other groups too.

If you select `Catch All', this group will get postings for any
messages not matched in any other group.  It overrides the variable
gnus-group-split-default-catch-all-group.

Selecting `Ignore' forces no SPLIT to be generated for this group,
disabling all other gnus-group-split fields.")

    (broken-reply-to (const :tag "Broken Reply To" t) "\
Ignore `Reply-To' headers in this group.

That can be useful if you're reading a mailing list group where the
listserv has inserted `Reply-To' headers that point back to the
listserv itself.  This is broken behavior.  So there!")

    (to-group (string :tag "To Group") "\
All posts will be sent to the specified group.")

    (gcc-self (choice :tag  "GCC"
		      :value t
		      (const :tag "To current group" t)
		      (const none)
		      (string :format "%v" :hide-front-space t)) "\
Specify default value for GCC header.

If this symbol is present in the group parameter list and set to t,
new composed messages will be `Gcc''d to the current group.  If it is
present and set to `none', no `Gcc:' header will be generated, if it
is present and a string, this string will be inserted literally as a
`gcc' header (this symbol takes precedence over any default `Gcc'
rules as described later).")

    (expiry-wait (choice :tag  "Expire Wait"
			 :value never
			 (const never)
			 (const immediate)
			 (number :hide-front-space t
				 :format "%v")) "\
When to expire.

Overrides any `nnmail-expiry-wait' or `nnmail-expiry-wait-function'
settings when expiring expirable messages.  The value can be
either a number of days (not necessarily an integer), or one of
the symbols `never' or `immediate'.")

    (expiry-target (choice :tag "Expiry Target"
			   :value delete
			   (const delete)
			   (function :format "%v" nnmail-)
			   string) "\
Where expired messages end up.

Overrides `nnmail-expiry-target'.")

    (score-file (file :tag "Score File") "\
Make the specified file into the current score file.
This means that all score commands you issue will end up in this file.")

    (adapt-file (file :tag "Adapt File") "\
Make the specified file into the current adaptive file.
All adaptive score entries will be put into this file.")

    (admin-address (gnus-email-address :tag "Admin Address") "\
Administration address for a mailing list.

When unsubscribing to a mailing list you should never send the
unsubscription notice to the mailing list itself.  Instead, you'd
send messages to the administrative address.  This parameter allows
you to put the admin address somewhere convenient.")

    (display (choice :tag "Display"
		     :value default
		     (const all)
		     (integer)
		     (const default)
		     (sexp  :tag "Other")) "\
Which articles to display on entering the group.

`all'
     Display all articles, both read and unread.

`integer'
     Display the last NUMBER articles in the group.  This is the same as
     entering the group with C-u NUMBER.

`default'
     Display the default visible articles, which normally includes
     unread and ticked articles.

`Other'
     Display the articles that satisfy the S-expression.  The S-expression
     should be in an array form.")

    (comment (string :tag  "Comment") "\
An arbitrary comment on the group.")

    (visible (const :tag "Permanently visible" t) "\
Always display this group, even when there are no unread articles in it.")

    (highlight-words
     (choice :tag "Highlight words"
	     :value nil
	     (repeat (list (regexp :tag "Highlight regexp")
			   (number :tag "Group for entire word" 0)
			   (number :tag "Group for displayed part" 0)
			   (symbol :tag "Face"
				   gnus-emphasis-highlight-words))))
     "highlight regexps.
See `gnus-emphasis-alist'.")

    (posting-style
     (choice :tag "Posting style"
	     :value nil
	     (repeat (list
		      (choice :tag "Type"
			      :value nil
			      (const signature)
			      (const signature-file)
			      (const organization)
			      (const address)
			      (const x-face-file)
			      (const name)
			      (const body)
			      (symbol)
			      (string :tag "Header"))
		      (string :format "%v"))))
     "post style.
See `gnus-posting-styles'."))
  "Alist of valid group or topic parameters.

Each entry has the form (NAME TYPE DOC), where NAME is the parameter
itself (a symbol), TYPE is the parameters type (a sexp widget), and
DOC is a documentation string for the parameter.")