Mercurial > emacs
comparison doc/misc/newsticker.texi @ 95912:dd0e2fbdf65e
Updated newsticker.texi
author | Ulf Jasper <ulf.jasper@web.de> |
---|---|
date | Sat, 14 Jun 2008 10:01:39 +0000 |
parents | eafbd7a5c9be |
children | 6f0fce2c3559 |
comparison
equal
deleted
inserted
replaced
95911:dd0b776b5331 | 95912:dd0e2fbdf65e |
---|---|
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 |
9 @syncodeindex pg cp | 9 @syncodeindex pg cp |
10 @comment %**end of header | 10 @comment %**end of header |
44 @titlepage | 44 @titlepage |
45 @title Newsticker -- a Newsticker for Emacs | 45 @title Newsticker -- a Newsticker for Emacs |
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 |
53 @end titlepage | 53 @end titlepage |
54 | 54 |
79 corresponding articles in a web browser. | 79 corresponding articles in a web browser. |
80 | 80 |
81 | 81 |
82 Headlines consist of a title and (possibly) a small description. They | 82 Headlines consist of a title and (possibly) a small description. They |
83 are contained in "RSS" (RDF Site Summary) or "Atom" files. Newsticker | 83 are contained in "RSS" (RDF Site Summary) or "Atom" files. Newsticker |
84 should work with the following RSS formats: | 84 works 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 |
88 @uref{http://my.netscape.com/publish/formats/rss-spec-0.91.html}), | 88 @uref{http://my.netscape.com/publish/formats/rss-spec-0.91.html}), |
89 @item RSS 0.92 (see @uref{http://backend.userland.com/rss092}), | 89 @item RSS 0.92 (see @uref{http://backend.userland.com/rss092}), |
95 @item Atom 0.3 | 95 @item Atom 0.3 |
96 @item Atom 1.0 (see | 96 @item Atom 1.0 (see |
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 |
100 That makes Newsticker.el an "Atom aggregator, "RSS reader", or "RSS | 100 That makes Newsticker.el an ``Atom aggregator'', ``RSS reader'', ``Feed |
101 aggregator". | 101 aggregator'', or ``Feed reader''. |
102 | 102 |
103 Newsticker provides several commands for reading headlines, navigating | 103 Newsticker provides several commands for reading headlines, navigating |
104 through them, marking them as read/unread, hiding old headlines etc. | 104 through them, marking them as read/unread, hiding old headlines etc. |
105 Headlines can be displayed as plain text or as rendered HTML. | 105 Headlines can be displayed as plain text or as rendered HTML. |
106 | 106 |
129 21.1 or later as well as @uref{http://www.xemacs.org, XEmacs}. It | 129 21.1 or later as well as @uref{http://www.xemacs.org, XEmacs}. It |
130 requires an XML-parser (@file{xml.el}) which is part of GNU Emacs. If | 130 requires an XML-parser (@file{xml.el}) which is part of GNU Emacs. If |
131 you are using XEmacs you want to get the @file{net-utils} package | 131 you are using XEmacs you want to get the @file{net-utils} package |
132 which contains @file{xml.el} for XEmacs. | 132 which contains @file{xml.el} for XEmacs. |
133 | 133 |
134 Newsticker requires a program which can retrieve files via http and | 134 Newsticker retrieves headlines either via Emacs' built-in retrieval |
135 prints them to stdout. By default Newsticker will use | 135 functions, by an arbitrary external program that retrieves files via |
136 @uref{http://www.gnu.org/software/wget/wget.html, wget} for this task. | 136 http and prints them to stdout (like |
137 @uref{http://www.gnu.org/software/wget/wget.html, wget}, or -- on a | |
138 per feed basis -- via an arbitrary Lisp command. | |
137 | 139 |
138 | 140 |
139 @node Installation | 141 @node Installation |
140 @chapter Installation | 142 @chapter Installation |
141 | 143 |
155 @node Usage | 157 @node Usage |
156 @chapter Usage | 158 @chapter Usage |
157 | 159 |
158 @findex newsticker-show-news | 160 @findex newsticker-show-news |
159 The command @code{newsticker-show-news} will display all available | 161 The command @code{newsticker-show-news} will display all available |
160 headlines in a special buffer, called @samp{*newsticker*}. It will | 162 headlines. It will also start the asynchronous download of headlines. |
161 also start the asynchronous download of headlines. The modeline in | 163 |
162 the @samp{*newsticker*} buffer informs whenever new headlines have | 164 You can choose between two different frontends for reading headlines: |
163 arrived. Clicking mouse-button 2 or pressing RET in this buffer on a | 165 @itemize |
164 headline will call @code{browse-url} to load the corresponding news | 166 @item Newsticker's @emph{treeview} uses separate windows for the |
165 story in your favourite web browser. | 167 feeds (in tree form), a list of headlines for the current feed, and |
168 the content of the current headline. Feeds can be placed into groups | |
169 which itself can be placed in groups and so on. | |
170 @item Newsticker's @emph{plainview} displays all headlines in a | |
171 single buffer, called @samp{*newsticker*}. The modeline in the | |
172 @samp{*newsticker*} buffer informs whenever new headlines have | |
173 arrived. | |
174 @end itemize | |
175 In both views clicking mouse-button 2 or pressing RET on a headline | |
176 will call @code{browse-url} to load the corresponding news story in | |
177 your 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 |
169 The scrolling, or flashing of headlines in the echo area, can be | 181 The scrolling, or flashing of headlines in the echo area, can be |
170 started with the command @code{newsticker-start-ticker}. It can be | 182 started with the command @code{newsticker-start-ticker}. It can be |
187 | 199 |
188 All Newsticker options have reasonable default values, so that in most | 200 All Newsticker options have reasonable default values, so that in most |
189 cases it is not necessary to customize settings before starting Newsticker | 201 cases it is not necessary to customize settings before starting Newsticker |
190 for the first time. | 202 for the first time. |
191 | 203 |
192 Newsticker options are organized in the following groups. | 204 The following list shows the available groups of newsticker options |
193 | 205 and some of the most important options. |
194 @itemize | 206 |
195 | 207 @itemize |
196 @item | 208 |
197 @code{newsticker-feed} contains options that define which news | 209 @item |
210 @code{newsticker-retrieval} contains options that define which news | |
198 feeds are retrieved and how this is done. | 211 feeds are retrieved and how this is done. |
199 | 212 |
200 @itemize | 213 @itemize |
201 @item | 214 @item |
202 @vindex newsticker-url-list | 215 @vindex newsticker-url-list |
203 @code{newsticker-url-list} defines the list of headlines which are | 216 @code{newsticker-url-list} defines the list of headlines which are |
204 retrieved. | 217 retrieved. |
218 @item | |
219 @vindex newsticker-retrieval-method | |
220 @code{newsticker-retrieval-method} defines how headlines are | |
221 retrieved. This is either done using Emacs' built-in download | |
222 capabilities or using an external tool. | |
205 @item | 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 |
208 are retrieved. | 226 are retrieved. |
209 @end itemize | 227 @end itemize |
216 @item | 234 @item |
217 @vindex newsticker-keep-obsolete-items | 235 @vindex newsticker-keep-obsolete-items |
218 @code{newsticker-keep-obsolete-items} decides whether unread | 236 @code{newsticker-keep-obsolete-items} decides whether unread |
219 headlines that have been removed from the feed are kept in the | 237 headlines that have been removed from the feed are kept in the |
220 Newsticker cache. | 238 Newsticker cache. |
221 @end itemize | 239 @item |
222 | 240 @vindex newsticker-auto-mark-filter-list |
223 @item | 241 @code{newsticker-auto-mark-filter-list} provides the possibility to |
224 @code{newsticker-layout} contains options that define how the | 242 automatically mark headlines as immortal or old. |
225 buffer for reading news headlines is formatted. | |
226 | |
227 @itemize | |
228 @item | |
229 @vindex newsticker-heading-format | |
230 @code{newsticker-item-format} defines how the title of a headline | |
231 is formatted. | |
232 @end itemize | |
233 | |
234 @item | |
235 @code{newsticker-ticker} contains options that define how headlines | |
236 are shown in the echo area. | |
237 | |
238 @itemize | |
239 @item | |
240 @vindex newsticker-display-interval | |
241 @vindex newsticker-scroll-smoothly | |
242 @code{newsticker-display-interval} and | |
243 @code{newsticker-scroll-smoothly} define how headlines are shown in | |
244 the echo area. | |
245 @end itemize | 243 @end itemize |
246 | 244 |
247 @item | 245 @item |
248 @code{newsticker-hooks} contains options for hooking other Emacs | 246 @code{newsticker-hooks} contains options for hooking other Emacs |
249 commands to newsticker functions. | 247 commands to newsticker functions. |
251 @item | 249 @item |
252 @vindex newsticker-new-item-functions | 250 @vindex newsticker-new-item-functions |
253 @code{newsticker-new-item-functions} allows for automatic | 251 @code{newsticker-new-item-functions} allows for automatic |
254 processing of headlines. See `newsticker-download-images', and | 252 processing of headlines. See `newsticker-download-images', and |
255 `newsticker-download-enclosures' for sample functions. | 253 `newsticker-download-enclosures' for sample functions. |
254 @item | |
255 @vindex newsticker-plainview-hooks | |
256 The subgroup @code{newsticker-plainview-hooks} contains hook which | |
257 apply to the plainview reader only. | |
256 @end itemize | 258 @end itemize |
257 | 259 |
258 @item | 260 @item |
259 @code{newsticker-miscellaneous} contains other Newsticker options. | 261 @code{newsticker-miscellaneous} contains other Newsticker options. |
260 | 262 |
261 @end itemize | 263 @item |
262 | 264 @code{newsticker-ticker} contains options that define how headlines |
263 Please have a look at the customization buffers for the complete list | 265 are shown in the echo area, i.e. the ``ticker''. |
264 of options. | 266 |
267 @itemize | |
268 @item | |
269 @vindex newsticker-display-interval | |
270 @vindex newsticker-scroll-smoothly | |
271 @code{newsticker-ticker-interval} and | |
272 @code{newsticker-scroll-smoothly} define how headlines are shown in | |
273 the echo area. | |
274 @end itemize | |
275 | |
276 | |
277 @item | |
278 @code{newsticker-reader} contains options for adjusting the headline reader. | |
279 | |
280 @itemize | |
281 @item | |
282 @vindex newsticker-frontend | |
283 @code{newsticker-frontend} determines the actual headline reader. The | |
284 ``plainview'' reader uses a single buffer, the ``treeview'' uses | |
285 separate buffers and windows. | |
286 @end itemize | |
287 | |
288 @itemize | |
289 @item | |
290 @vindex newsticker-plainview | |
291 The subgroup @code{newsticker-plainview} contains options for the | |
292 plainview reader. | |
293 @item | |
294 @vindex newsticker-treeview | |
295 The subgroup @code{newsticker-treeview} contains options for the | |
296 treeview reader. | |
297 @end itemize | |
298 | |
299 @end itemize | |
300 | |
301 For the complete list of options please have a look at the | |
302 customization buffers. | |
265 | 303 |
266 @node Remarks | 304 @node Remarks |
267 @chapter Remarks | 305 @chapter Remarks |
268 | |
269 This newsticker is designed do its job silently in the background | |
270 without disturbing you. However, it is probably impossible to prevent | |
271 such a tool from slightly attenuating your Editor's responsiveness | |
272 every once in a while. | |
273 | 306 |
274 Byte-compiling newsticker.el is recommended. | 307 Byte-compiling newsticker.el is recommended. |
275 | 308 |
276 @node GNU Free Documentation License | 309 @node GNU Free Documentation License |
277 @appendix GNU Free Documentation License | 310 @appendix GNU Free Documentation License |