xemacs-beta: man/gnus.texi comparison

comparison man/gnus.texi @ 2:ac2d302a0011 r19-15b2

Import from CVS: tag r19-15b2

author	cvs
date	Mon, 13 Aug 2007 08:46:35 +0200
parents	376386a54a3c
children	0293115a14e9

comparison

equal deleted inserted replaced

-:c0c6a60d29db
+:ac2d302a0011
 @item gnus-subscribe-alphabetically
 @vindex gnus-subscribe-alphabetically
 Subscribe all new groups alphabetically.
 @item gnus-subscribe-hierarchically
 @vindex gnus-subscribe-hierarchically
-Subscribe all new groups hierarchically.
+Subscribe all new groups hierarchically.  The difference between this
+function and @code{gnus-subscribe-alphabetically} is slight.
+@code{gnus-subscribe-alphabetically} will subscribe new groups in a
+strictly alphabetical fashion, while this function will enter groups
+into it's hierarchy.  So if you want to have the @samp{rec} hierarchy
+before the @samp{comp} hierarchy, this function will not mess that
+configuration up.  Or something like that.
 @item gnus-subscribe-interactively
 @vindex gnus-subscribe-interactively
 Subscribe new groups interactively.  This means that Gnus will ask
 you about @strong{all} new groups.
 saving the @file{.newsrc.eld} file, and
 @code{gnus-save-standard-newsrc-hook} is called just before saving the
 @file{.newsrc} file.  The latter two are commonly used to turn version
 control on or off.  Version control is off by default when saving the
 startup files.
+@vindex gnus-init-file
+When Gnus starts, it will read the @code{gnus-init-file} file, which is
+@file{~/.gnus.el} by default.  This is a normal Emacs Lisp file and can
+be used to avoid cluttering your @file{.emacs} file with Gnus stuff.
 @node Auto Save
 @section Auto Save
 @cindex dribble file
 @item G r
 @kindex G r (Group)
 @findex gnus-group-rename-group
 Rename the current group to something else
-(@code{gnus-group-rename-group}).  This is legal only on some groups --
+(@code{gnus-group-rename-group}).  This is legal only on some
-mail groups mostly.  This command might very well be quite slow on some
+groups---mail groups mostly.  This command might very well be quite slow
-backends.
+on some backends.
 @item G e
 @kindex G e (Group)
 @findex gnus-group-edit-group-method
 Enter a buffer where you can edit the select method of the current
 @vindex gnus-group-archive-directory
 @vindex gnus-group-recent-archive-directory
 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
 default a group pointing to the most recent articles will be created
 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
-group will be created from from @code{gnus-group-archive-directory}.
+group will be created from @code{gnus-group-archive-directory}.
 @item G k
 @kindex G k (Group)
 @findex gnus-group-make-kiboze-group
 Make a kiboze group.  You will be prompted for a name, for a regexp to
 match groups to be ``included'' in the kiboze group, and a series of
 strings to match on headers (@code{gnus-group-make-kiboze-group}).
+@xref{Kibozed Groups}
 @item G D
 @kindex G D (Group)
 @findex gnus-group-enter-directory
 Read an arbitrary directory as if with were a newsgroup with the
 List all zombie groups (@code{gnus-group-list-zombies}).
 @item A m
 @kindex A m (Group)
 @findex gnus-group-list-matching
-List all subscribed groups with unread articles that match a regexp
+List all unread, subscribed groups with names that match a regexp
 (@code{gnus-group-list-matching}).
 @item A M
 @kindex A M (Group)
 @findex gnus-group-list-all-matching
 @cindex saving .newsrc
 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
 file(s) whether Gnus thinks it is necessary or not.
-@item Z
+@c @item Z
-@kindex Z (Group)
+@c @kindex Z (Group)
-@findex gnus-group-clear-dribble
+@c @findex gnus-group-clear-dribble
-Clear the dribble buffer (@code{gnus-group-clear-dribble}).
+@c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
 @end table
 @node The Summary Buffer
 @pxref{Group Levels}.
 @item gnus-auto-select-same
 @vindex gnus-auto-select-same
 If non-@code{nil}, all the movement commands will try to go to the next
-article with the same subject as the current.  This variable is not
+article with the same subject as the current.  (@dfn{Same} here might
+mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
+for details (@pxref{Customizing Threading}).)  This variable is not
 particularly useful if you use a threaded display.
 @item gnus-summary-check-current
 @vindex gnus-summary-check-current
 If non-@code{nil}, all the ``unread'' movement commands will not proceed
 @item W W p
 @kindex W W p (Summary)
 @findex gnus-article-hide-pgp
 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).
+@item W W P
+@kindex W W P (Summary)
+@findex gnus-article-hide-pem
+Hide @sc{pem} (privacy enhavnced hessages) gruft
+(@code{gnus-article-hide-pem}).
 @item W W c
 @kindex W W c (Summary)
 @findex gnus-article-hide-citation
 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
 customizing the hiding:
 Treat overstrike (@code{gnus-article-treat-overstrike}).
 @item W w
 @kindex W w (Summary)
 @findex gnus-article-fill-cited-article
-Do word wrap (@code{gnus-article-fill-cited-article}).
+Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
+function in @code{gnus-article-display-hook}, it should be run fairly
+late and certainly after any highlighting.
 @item W c
 @kindex W c (Summary)
 @findex gnus-article-remove-cr
 Remove CR (@code{gnus-article-remove-cr}).
 @findex gnus-article-x-face-command
 @vindex gnus-article-x-face-command
 @vindex gnus-article-x-face-too-ugly
 Look for and display any X-Face headers
 (@code{gnus-article-display-x-face}).  The command executed by this
-function is given by the @code{gnus-article-x-face-command} variable.  If
+function is given by the @code{gnus-article-x-face-command} variable.
-this variable is a string, this string will be executed in a sub-shell.
+If this variable is a string, this string will be executed in a
-If it is a function, this function will be called with the face as the
+sub-shell.  If it is a function, this function will be called with the
-argument.  If the @code{gnus-article-x-face-too-ugly} (which is a regexp)
+face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
-matches the @code{From} header, the face will not be shown.  The default
+is a regexp) matches the @code{From} header, the face will not be shown.
-action under Emacs is to fork off an @code{xv} to view the face; under
+The default action under Emacs is to fork off an @code{xv} to view the
-XEmacs the default action is to display the face before the @code{From}
+face; under XEmacs the default action is to display the face before the
-header.  (It's nicer if XEmacs has been compiled with X-Face support --
+@code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
-that will make display somewhat faster.  If there's no native X-Face
+support---that will make display somewhat faster.  If there's no native
-support, Gnus will try to convert the @code{X-Face} header using
+X-Face support, Gnus will try to convert the @code{X-Face} header using
 external programs from the @code{pbmplus} package and friends.)  If you
 want to have this function in the display hook, it should probably come
 last.
 @item W b
 @kindex W b (Summary)
 @findex gnus-article-add-buttons
 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
 Messages will be saved in that group.
 @item a list of strings
 Messages will be saved in all those groups.
 @item an alist of regexps, functions and forms
 When a key ``matches'', the result is used.
+@item @code{nil}
+No message archiving will take place.  This is the default.
 @end itemize
 Let's illustrate:
 Just saving to a single group called @samp{MisK}:
 '((if (message-news-p)
 "misc-news"
 "misc-mail")))
 @end lisp
-This is the default.
 How about storing all news messages in one file, but storing all mail
 messages in one file per month:
 @lisp
 (setq gnus-message-archive-group
 you can just remove the @code{Gcc} header that has been inserted.)  The
 archive group will appear in the group buffer the next time you start
 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
 enter it and read the articles in it just like you'd read any other
 group.  If the group gets really big and annoying, you can simply rename
-if (using @kbd{G r} in the group buffer) to something nice --
+if (using @kbd{G r} in the group buffer) to something
-@samp{misc-mail-september-1995}, or whatever.  New messages will
+nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
 continue to be stored in the old (now empty) group.
 That's the default method of archiving sent mail.  Gnus also offers two
 other variables for the people who don't like the default method.  In
 that case you should set @code{gnus-message-archive-group} to
 @section Getting News
 @cindex reading news
 @cindex news backends
 A newsreader is normally used for reading news.  Gnus currently provides
-only two methods of getting news -- it can read from an @sc{nntp}
+only two methods of getting news---it can read from an @sc{nntp} server,
-server, or it can read from a local spool.
+or it can read from a local spool.
 @menu
 * NNTP::               Reading news from an @sc{nntp} server.
 * News Spool::         Reading news from the local spool.
 @end menu
 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
 the news feed''.  @code{nnkiboze} is a backend that will do this for
 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
 with useless requests!  Oh happiness!
+@kindex G k (Group)
+To create a kibozed group, use the @kbd{G k} command in the group
+buffer.
 The address field of the @code{nnkiboze} method is, as with
 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
 @code{nnkiboze} group.  There most similarities between @code{nnkiboze}
 and @code{nnvirtual} ends.
 * Summary Score Commands::   Adding score entries for the current group.
 * Group Score Commands::     General score commands.
 * Score Variables::          Customize your scoring.  (My, what terminology).
 * Score File Format::        What a score file may contain.
 * Score File Editing::       You can edit score files by hand as well.
-* Adaptive Scoring::         Big Sister Gnus *knows* what you read.
+* Adaptive Scoring::         Big Sister Gnus @emph{knows} what you read.
 * Followups To Yourself::    Having Gnus notice when people answer you.
 * Scoring Tips::             How to score effectively.
 * Reverse Scoring::          That problem child of old is not problem.
 * Global Score Files::       Earth-spanning, ear-splitting score files.
 * Kill Files::               They are still here, but they can be ignored.
 @kindex V m (Summary)
 @findex gnus-score-set-mark-below
 Prompt for a score, and mark all articles with a score below this as
 read (@code{gnus-score-set-mark-below}).
-@item V E
+@item V x
-@kindex V E (Summary)
+@kindex V x (Summary)
 @findex gnus-score-set-expunge-below
-Expunge all articles with a score below the default score (or the
+Prompt for a score, and add a score rule to the current score file to
-numeric prefix) (@code{gnus-score-set-expunge-below}).
+expunge all articles below this score
+(@code{gnus-score-set-expunge-below}).
 @end table
 The keystrokes for actually making score entries follow a very regular
 pattern, so there's no need to list all the commands.  (Hundreds of
 them.)
 For the Date header we have three match types: @code{before}, @code{at}
 and @code{after}.  I can't really imagine this ever being useful, but,
 like, it would feel kinda silly not to provide this function.  Just in
 case.  You never know.  Better safe than sorry.  Once burnt, twice shy.
 Don't judge a book by its cover.  Never not have sex on a first date.
+(I have been told that at least one person, and I quote, ``found this
+function indispensable'', however.)
 @item Head, Body, All
 These three match keys use the same match types as the @code{From} (etc)
 header uses.
 threads.  You then raise the score of the threads that you find
 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
 rest.  Next time you enter the group, you will see new articles in the
 interesting threads, plus any new threads.
-I.e. -- the orphan score atom is for high-volume groups where there
+I.e.---the orphan score atom is for high-volume groups where there
 exist a few interesting threads which can't be found automatically by
 ordinary scoring rules.
 @item adapt
 This entry controls the adaptive scoring.  If it is @code{t}, the
 your own article.
 @end table
 @vindex gnus-inews-article-hook
 These two functions are both primarily meant to be used in hooks like
-@code{gnus-inews-article-hook}.
+@code{message-send-hook}.
 @node Scoring Tips
 @section Scoring Tips
 @cindex scoring tips
 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
 spec, and pad with spaces to get a 5-character field''.  Just like a
 normal format spec, almost.
 You can also say @samp{%6,4y}, which means that the field will never be
-more than 6 characters wide and never less than 4 characters wide.
+more than 4 characters wide and never less than 6 characters wide.
 There are also specs for highlighting, and these are shared by all the
 format variables.  Text inside the @samp{%(} and @samp{%)} specifiers
 will get the special @code{mouse-face} property set, which means that it
 will be highlighted (with @code{gnus-mouse-face}) when you put the mouse
 @vindex gnus-window-min-width
 @vindex gnus-window-min-height
 @cindex window height
 @cindex window width
 Finding the right sizes can be a bit complicated.  No window may be less
-than @code{gnus-window-min-height} (default 2) characters high, and all
+than @code{gnus-window-min-height} (default 1) characters high, and all
 windows must be at least @code{gnus-window-min-width} (default 1)
 characters wide.  Gnus will try to enforce this before applying the
 splits.  If you want to use the normal Emacs window width/height limit,
 you can just set these two variables to @code{nil}.
 Here's a list of all possible keys for
 @code{gnus-buffer-configuration}:
 @code{group}, @code{summary}, @code{article}, @code{server},
-@code{browse}, @code{group-mail}, @code{summary-mail},
+@code{browse}, @code{message}, @code{pick}, @code{info},
-@code{summary-reply}, @code{info}, @code{summary-faq},
+@code{summary-faq}, @code{edit-group}, @code{edit-server},
-@code{edit-group}, @code{edit-server}, @code{reply}, @code{reply-yank},
+@code{edit-score}, @code{post}, @code{reply}, @code{forward},
-@code{followup}, @code{followup-yank}, @code{edit-score}.
+@code{reply-yank}, @code{mail-bounce}, @code{draft},
+@code{pipe}, @code{bug}, @code{compose-bounce}.
+Note that the @code{message} key is used for both
+@code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
+it is desireable to distinguish between the two, something like this
+might be used:
+@lisp
+(message (horizontal 1.0
+		     (vertical 1.0 (message 1.0 point))
+		     (vertical 0.24
+			       (if (buffer-live-p gnus-summary-buffer)
+				   '(summary 0.5))
+			       (group 1.0)))))
+@end lisp
 @findex gnus-add-configuration
 Since the @code{gnus-buffer-configuration} variable is so long and
 complicated, there's a function you can use to ease changing the config
 of a single setting: @code{gnus-add-configuration}.  If, for instance,
 (summary .25 point)
 (article 1.0))))
 @end lisp
 You'd typically stick these @code{gnus-add-configuration} calls in your
-@file{.gnus} file or in some startup hook -- they should be run after
+@file{.gnus} file or in some startup hook---they should be run after
 Gnus has been loaded.
 @node Compilation
 @section Compilation
 over your shoulder as you read news.
 @menu
 * Picon Basics::           What are picons and How do I get them.
 * Picon Requirements::     Don't go further if you aren't using XEmacs.
-* Easy Picons::            Displaying Picons -- the easy way.
+* Easy Picons::            Displaying Picons---the easy way.
 * Hard Picons::            The way you should do it.  You'll learn something.
 * Picon Configuration::    Other variables you can trash/tweak/munge/play with.
 @end menu
 @vindex gnus-picons-display-where
 Where the picon images should be displayed.  It is @code{picons} by
 default (which by default maps to the buffer @samp{*Picons*}).  Other
 valid places could be @code{article}, @code{summary}, or
 @samp{"*scratch*"} for all I care.  Just make sure that you've made the
-buffer visible using the standard Gnus window configuration routines --
+buffer visible using the standard Gnus window configuration
-@xref{Windows Configuration}.
+routines---@xref{Windows Configuration}.
 @end table
 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
 window configuration for you to include the @code{picons} buffer.
 @item gnus-parse-headers-hook
 @vindex gnus-parse-headers-hook
 A hook called before parsing headers.  It can be used, for instance, to
 gather statistics on the headers fetched, or perhaps you'd like to prune
 some headers.  I don't see why you'd want that, though.
+@item gnus-shell-command-separator
+@vindex gnus-shell-command-separator
+String used to separate to shell commands.  The default is @samp{;}.
 @end table
 @node The End
 @item RFC 1036
 @cindex RFC 1036
 There are no known breaches of this standard, either.
-@item Usenet Seal of Approval
+@item Good Net-Keeping Seal of Approval
-@cindex Usenet Seal of Approval
+@cindex Good Net-Keeping Seal of Approval
-Gnus hasn't been formally through the Seal process, but I have read
+Gnus has been through the Seal process and failed.  I think it'll pass
-through the Seal text and I think Gnus would pass.
+the next inspection.
 @item Son-of-RFC 1036
 @cindex Son-of-RFC 1036
 We do have some breaches to this one.
 which is what I'm talking about here.  This is a 9-element vector,
 basically, with each header (ouch) having one slot.
 These slots are, in order: @code{number}, @code{subject}, @code{from},
 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
-@code{xref}.  There are macros for accessing and setting these slots --
+@code{xref}.  There are macros for accessing and setting these
-they all have predictable names beginning with @code{mail-header-} and
+slots---they all have predictable names beginning with
-@code{mail-header-set-}, respectively.
+@code{mail-header-} and @code{mail-header-set-}, respectively.
 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
 be put in there.
 (,function ,@@args))
 time repeat))
 @end lisp
 This sort of thing has been done for bunches of functions.  Gnus does
-not redefine any native Emacs functions while running under XEmacs -- it
+not redefine any native Emacs functions while running under XEmacs---it
 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
 all over.
 Of course, I could have chosen XEmacs as my native platform and done
 mapping functions the other way around.  But I didn't.  The performance

Mercurial > hg > xemacs-beta

comparison man/gnus.texi @ 2:ac2d302a0011 r19-15b2