aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/misc/ChangeLog4
-rw-r--r--doc/misc/newsticker.texi111
2 files changed, 76 insertions, 39 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index c7d18faef2a..28737fec2ff 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,7 @@
12008-06-14 Ulf Jasper <ulf.jasper@web.de>
2
3 * newsticker.texi: Updated to match latest newsticker changes.
4
12008-06-13 Glenn Morris <rgm@gnu.org> 52008-06-13 Glenn Morris <rgm@gnu.org>
2 6
3 * ada-mode.texi, autotype.texi, calc.texi, cc-mode.texi, cl.texi 7 * ada-mode.texi, autotype.texi, calc.texi, cc-mode.texi, cl.texi
diff --git a/doc/misc/newsticker.texi b/doc/misc/newsticker.texi
index 201a537d552..f29006da398 100644
--- a/doc/misc/newsticker.texi
+++ b/doc/misc/newsticker.texi
@@ -1,8 +1,8 @@
1\input texinfo @c -*-texinfo-*- 1\input texinfo @c -*-texinfo-*-
2@comment %**start of header 2@comment %**start of header
3@setfilename ../../info/newsticker 3@setfilename ../../info/newsticker
4@set VERSION 1.9 4@set VERSION 1.99
5@set UPDATED November 2005 5@set UPDATED June 2008
6@settitle Newsticker @value{VERSION} 6@settitle Newsticker @value{VERSION}
7@syncodeindex vr cp 7@syncodeindex vr cp
8@syncodeindex fn cp 8@syncodeindex fn cp
@@ -46,7 +46,7 @@ license to the document, as described in section 6 of the license.
46@subtitle for version @value{VERSION}, @value{UPDATED} 46@subtitle for version @value{VERSION}, @value{UPDATED}
47@author Ulf Jasper 47@author Ulf Jasper
48@author @email{ulf.jasper@@web.de} 48@author @email{ulf.jasper@@web.de}
49@author @uref{http://de.geocities.com/ulf_jasper} 49@author @uref{http://ulf.epplejasper.de/}
50@page 50@page
51@vskip 0pt plus 1filll 51@vskip 0pt plus 1filll
52@insertcopying 52@insertcopying
@@ -81,7 +81,7 @@ corresponding articles in a web browser.
81 81
82Headlines consist of a title and (possibly) a small description. They 82Headlines consist of a title and (possibly) a small description. They
83are contained in "RSS" (RDF Site Summary) or "Atom" files. Newsticker 83are contained in "RSS" (RDF Site Summary) or "Atom" files. Newsticker
84should work with the following RSS formats: 84works with the following RSS formats:
85 85
86@itemize 86@itemize
87@item RSS 0.91 (see @uref{http://backend.userland.com/rss091} or 87@item RSS 0.91 (see @uref{http://backend.userland.com/rss091} or
@@ -97,8 +97,8 @@ as well as the following Atom formats:
97@uref{http://www.ietf.org/internet-drafts/draft-ietf-atompub-format-11.txt}). 97@uref{http://www.ietf.org/internet-drafts/draft-ietf-atompub-format-11.txt}).
98@end itemize 98@end itemize
99 99
100That makes Newsticker.el an "Atom aggregator, "RSS reader", or "RSS 100That makes Newsticker.el an ``Atom aggregator'', ``RSS reader'', ``Feed
101aggregator". 101aggregator'', or ``Feed reader''.
102 102
103Newsticker provides several commands for reading headlines, navigating 103Newsticker provides several commands for reading headlines, navigating
104through them, marking them as read/unread, hiding old headlines etc. 104through them, marking them as read/unread, hiding old headlines etc.
@@ -131,9 +131,11 @@ requires an XML-parser (@file{xml.el}) which is part of GNU Emacs. If
131you are using XEmacs you want to get the @file{net-utils} package 131you are using XEmacs you want to get the @file{net-utils} package
132which contains @file{xml.el} for XEmacs. 132which contains @file{xml.el} for XEmacs.
133 133
134Newsticker requires a program which can retrieve files via http and 134Newsticker retrieves headlines either via Emacs' built-in retrieval
135prints them to stdout. By default Newsticker will use 135functions, by an arbitrary external program that retrieves files via
136@uref{http://www.gnu.org/software/wget/wget.html, wget} for this task. 136http and prints them to stdout (like
137@uref{http://www.gnu.org/software/wget/wget.html, wget}, or -- on a
138per feed basis -- via an arbitrary Lisp command.
137 139
138 140
139@node Installation 141@node Installation
@@ -157,12 +159,22 @@ That's it.
157 159
158@findex newsticker-show-news 160@findex newsticker-show-news
159The command @code{newsticker-show-news} will display all available 161The command @code{newsticker-show-news} will display all available
160headlines in a special buffer, called @samp{*newsticker*}. It will 162headlines. It will also start the asynchronous download of headlines.
161also start the asynchronous download of headlines. The modeline in 163
162the @samp{*newsticker*} buffer informs whenever new headlines have 164You can choose between two different frontends for reading headlines:
163arrived. Clicking mouse-button 2 or pressing RET in this buffer on a 165@itemize
164headline will call @code{browse-url} to load the corresponding news 166@item Newsticker's @emph{treeview} uses separate windows for the
165story in your favourite web browser. 167feeds (in tree form), a list of headlines for the current feed, and
168the content of the current headline. Feeds can be placed into groups
169which itself can be placed in groups and so on.
170@item Newsticker's @emph{plainview} displays all headlines in a
171single buffer, called @samp{*newsticker*}. The modeline in the
172@samp{*newsticker*} buffer informs whenever new headlines have
173arrived.
174@end itemize
175In both views clicking mouse-button 2 or pressing RET on a headline
176will call @code{browse-url} to load the corresponding news story in
177your favourite web browser.
166 178
167@findex newsticker-start-ticker 179@findex newsticker-start-ticker
168@findex newsticker-stop-ticker 180@findex newsticker-stop-ticker
@@ -189,12 +201,13 @@ All Newsticker options have reasonable default values, so that in most
189cases it is not necessary to customize settings before starting Newsticker 201cases it is not necessary to customize settings before starting Newsticker
190for the first time. 202for the first time.
191 203
192Newsticker options are organized in the following groups. 204The following list shows the available groups of newsticker options
205and some of the most important options.
193 206
194@itemize 207@itemize
195 208
196@item 209@item
197@code{newsticker-feed} contains options that define which news 210@code{newsticker-retrieval} contains options that define which news
198feeds are retrieved and how this is done. 211feeds are retrieved and how this is done.
199 212
200@itemize 213@itemize
@@ -203,6 +216,11 @@ feeds are retrieved and how this is done.
203@code{newsticker-url-list} defines the list of headlines which are 216@code{newsticker-url-list} defines the list of headlines which are
204retrieved. 217retrieved.
205@item 218@item
219@vindex newsticker-retrieval-method
220@code{newsticker-retrieval-method} defines how headlines are
221retrieved. This is either done using Emacs' built-in download
222capabilities or using an external tool.
223@item
206@vindex newsticker-retrieval-interval 224@vindex newsticker-retrieval-interval
207@code{newsticker-retrieval-interval} defines how often headlines 225@code{newsticker-retrieval-interval} defines how often headlines
208are retrieved. 226are retrieved.
@@ -218,59 +236,74 @@ how the retrieved headlines are processed.
218@code{newsticker-keep-obsolete-items} decides whether unread 236@code{newsticker-keep-obsolete-items} decides whether unread
219headlines that have been removed from the feed are kept in the 237headlines that have been removed from the feed are kept in the
220Newsticker cache. 238Newsticker cache.
239@item
240@vindex newsticker-auto-mark-filter-list
241@code{newsticker-auto-mark-filter-list} provides the possibility to
242automatically mark headlines as immortal or old.
221@end itemize 243@end itemize
222 244
223@item 245@item
224@code{newsticker-layout} contains options that define how the 246@code{newsticker-hooks} contains options for hooking other Emacs
225buffer for reading news headlines is formatted. 247commands to newsticker functions.
226
227@itemize 248@itemize
228@item 249@item
229@vindex newsticker-heading-format 250@vindex newsticker-new-item-functions
230@code{newsticker-item-format} defines how the title of a headline 251@code{newsticker-new-item-functions} allows for automatic
231is formatted. 252processing of headlines. See `newsticker-download-images', and
253`newsticker-download-enclosures' for sample functions.
254@item
255@vindex newsticker-plainview-hooks
256The subgroup @code{newsticker-plainview-hooks} contains hook which
257apply to the plainview reader only.
232@end itemize 258@end itemize
233 259
234@item 260@item
261@code{newsticker-miscellaneous} contains other Newsticker options.
262
263@item
235@code{newsticker-ticker} contains options that define how headlines 264@code{newsticker-ticker} contains options that define how headlines
236are shown in the echo area. 265are shown in the echo area, i.e. the ``ticker''.
237 266
238@itemize 267@itemize
239@item 268@item
240@vindex newsticker-display-interval 269@vindex newsticker-display-interval
241@vindex newsticker-scroll-smoothly 270@vindex newsticker-scroll-smoothly
242@code{newsticker-display-interval} and 271@code{newsticker-ticker-interval} and
243@code{newsticker-scroll-smoothly} define how headlines are shown in 272@code{newsticker-scroll-smoothly} define how headlines are shown in
244the echo area. 273the echo area.
245@end itemize 274@end itemize
246 275
276
247@item 277@item
248@code{newsticker-hooks} contains options for hooking other Emacs 278@code{newsticker-reader} contains options for adjusting the headline reader.
249commands to newsticker functions. 279
250@itemize 280@itemize
251@item 281@item
252@vindex newsticker-new-item-functions 282@vindex newsticker-frontend
253@code{newsticker-new-item-functions} allows for automatic 283@code{newsticker-frontend} determines the actual headline reader. The
254processing of headlines. See `newsticker-download-images', and 284``plainview'' reader uses a single buffer, the ``treeview'' uses
255`newsticker-download-enclosures' for sample functions. 285separate buffers and windows.
256@end itemize 286@end itemize
257 287
288@itemize
258@item 289@item
259@code{newsticker-miscellaneous} contains other Newsticker options. 290@vindex newsticker-plainview
291The subgroup @code{newsticker-plainview} contains options for the
292plainview reader.
293@item
294@vindex newsticker-treeview
295The subgroup @code{newsticker-treeview} contains options for the
296treeview reader.
297@end itemize
260 298
261@end itemize 299@end itemize
262 300
263Please have a look at the customization buffers for the complete list 301For the complete list of options please have a look at the
264of options. 302customization buffers.
265 303
266@node Remarks 304@node Remarks
267@chapter Remarks 305@chapter Remarks
268 306
269This newsticker is designed do its job silently in the background
270without disturbing you. However, it is probably impossible to prevent
271such a tool from slightly attenuating your Editor's responsiveness
272every once in a while.
273
274Byte-compiling newsticker.el is recommended. 307Byte-compiling newsticker.el is recommended.
275 308
276@node GNU Free Documentation License 309@node GNU Free Documentation License