Mercurial > emacs
annotate 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 |
rev | line source |
---|---|
84307 | 1 \input texinfo @c -*-texinfo-*- |
2 @comment %**start of header | |
84329
3d431f1997d8
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84307
diff
changeset
|
3 @setfilename ../../info/newsticker |
95912 | 4 @set VERSION 1.99 |
5 @set UPDATED June 2008 | |
84307 | 6 @settitle Newsticker @value{VERSION} |
7 @syncodeindex vr cp | |
8 @syncodeindex fn cp | |
9 @syncodeindex pg cp | |
10 @comment %**end of header | |
11 | |
12 @copying | |
13 This manual is for Newsticker (version @value{VERSION}, @value{UPDATED}). | |
14 | |
15 @noindent | |
95874
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
16 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 |
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
17 Free Software Foundation, Inc. |
84307 | 18 |
19 @quotation | |
20 Permission is granted to copy, distribute and/or modify this document | |
21 under the terms of the GNU Free Documentation License, Version 1.2 or | |
22 any later version published by the Free Software Foundation; with no | |
23 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', | |
24 and with the Back-Cover Texts as in (a) below. A copy of the license | |
25 is included in the section entitled ``GNU Free Documentation License'' | |
26 in the Emacs manual. | |
27 | |
95874
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
28 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
29 modify this GNU manual. Buying copies from the FSF supports it in |
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
30 developing GNU and promoting software freedom.'' |
84307 | 31 |
32 This document is part of a collection distributed under the GNU Free | |
33 Documentation License. If you want to distribute this document | |
34 separately from the collection, you can do so by adding a copy of the | |
35 license to the document, as described in section 6 of the license. | |
36 @end quotation | |
37 @end copying | |
38 | |
39 @dircategory Emacs | |
40 @direntry | |
41 * Newsticker: (newsticker). A Newsticker for Emacs. | |
42 @end direntry | |
43 | |
44 @titlepage | |
45 @title Newsticker -- a Newsticker for Emacs | |
46 @subtitle for version @value{VERSION}, @value{UPDATED} | |
47 @author Ulf Jasper | |
48 @author @email{ulf.jasper@@web.de} | |
95912 | 49 @author @uref{http://ulf.epplejasper.de/} |
84307 | 50 @page |
51 @vskip 0pt plus 1filll | |
52 @insertcopying | |
53 @end titlepage | |
54 | |
55 @contents | |
56 | |
57 @ifnottex | |
58 @node Top | |
59 @top Newsticker | |
60 @end ifnottex | |
61 | |
62 @menu | |
63 * Overview:: General description of newsticker. | |
64 * Requirements:: Requirements for using newsticker. | |
65 * Installation:: Installing newsticker on your system. | |
66 * Usage:: Basic newsticker instructions. | |
67 * Configuration:: Customizable newsticker settings. | |
68 * Remarks:: Remarks about newsticker. | |
69 * GNU Free Documentation License:: The license for this documentation. | |
70 * Index:: Variable, function, and concept index. | |
71 @end menu | |
72 | |
73 @node Overview | |
74 @chapter Overview | |
75 | |
76 Newsticker provides a newsticker for Emacs. A newsticker is a thing | |
77 that asynchronously retrieves headlines from a list of news sites, | |
78 prepares these headlines for reading, and allows for loading the | |
79 corresponding articles in a web browser. | |
80 | |
81 | |
82 Headlines consist of a title and (possibly) a small description. They | |
83 are contained in "RSS" (RDF Site Summary) or "Atom" files. Newsticker | |
95912 | 84 works with the following RSS formats: |
84307 | 85 |
86 @itemize | |
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}), | |
89 @item RSS 0.92 (see @uref{http://backend.userland.com/rss092}), | |
90 @item RSS 1.0 (see @uref{http://purl.org/rss/1.0/spec} | |
91 @item RSS 2.0 (see @uref{http://blogs.law.harvard.edu/tech/rss}), | |
92 @end itemize | |
93 @itemize | |
94 as well as the following Atom formats: | |
95 @item Atom 0.3 | |
96 @item Atom 1.0 (see | |
97 @uref{http://www.ietf.org/internet-drafts/draft-ietf-atompub-format-11.txt}). | |
98 @end itemize | |
99 | |
95912 | 100 That makes Newsticker.el an ``Atom aggregator'', ``RSS reader'', ``Feed |
101 aggregator'', or ``Feed reader''. | |
84307 | 102 |
103 Newsticker provides several commands for reading headlines, navigating | |
104 through them, marking them as read/unread, hiding old headlines etc. | |
105 Headlines can be displayed as plain text or as rendered HTML. | |
106 | |
107 Headlines can be displayed in the echo area, either scrolling like | |
108 messages in a stock-quote ticker, or just changing. | |
109 | |
110 Newsticker allows for automatic processing of headlines by providing | |
111 hooks and (sample) functions for automatically downloading images and | |
112 enclosed files (as delivered by podcasts, e.g.). | |
113 | |
114 @ifhtml | |
115 Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 | |
116 (current version)} and some older screen shots: | |
117 @uref{newsticker-1.6.png, version 1.6}, | |
118 @uref{newsticker-1.5.png, version 1.5}, | |
119 @uref{newsticker-1.4.png, version 1.4} | |
120 @uref{newsticker-1.3.png, version 1.3}, | |
121 @uref{newsticker-1.0.png, version 1.0}. | |
122 @end ifhtml | |
123 | |
124 @node Requirements | |
125 @chapter Requirements | |
126 | |
127 Newsticker can be used with | |
128 @uref{http://www.gnu.org/software/emacs/emacs.html, GNU Emacs} version | |
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 | |
131 you are using XEmacs you want to get the @file{net-utils} package | |
132 which contains @file{xml.el} for XEmacs. | |
133 | |
95912 | 134 Newsticker retrieves headlines either via Emacs' built-in retrieval |
135 functions, by an arbitrary external program that retrieves files via | |
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. | |
84307 | 139 |
140 | |
141 @node Installation | |
142 @chapter Installation | |
143 | |
144 As Newsticker is part of GNU Emacs there is no need to perform any | |
145 installation steps in order to use Newsticker. | |
146 | |
147 However, if you are using imenu, which allows for navigating with the | |
148 help of a menu, you should add the following to your Emacs startup file | |
149 (@file{~/.emacs}). | |
150 | |
151 @lisp | |
152 (add-hook 'newsticker-mode-hook 'imenu-add-menubar-index) | |
153 @end lisp | |
154 | |
155 That's it. | |
156 | |
157 @node Usage | |
158 @chapter Usage | |
159 | |
160 @findex newsticker-show-news | |
161 The command @code{newsticker-show-news} will display all available | |
95912 | 162 headlines. It will also start the asynchronous download of headlines. |
163 | |
164 You can choose between two different frontends for reading headlines: | |
165 @itemize | |
166 @item Newsticker's @emph{treeview} uses separate windows for the | |
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. | |
84307 | 178 |
179 @findex newsticker-start-ticker | |
180 @findex newsticker-stop-ticker | |
181 The scrolling, or flashing of headlines in the echo area, can be | |
182 started with the command @code{newsticker-start-ticker}. It can be | |
183 stopped with @code{newsticker-stop-ticker}. | |
184 | |
185 @findex newsticker-start | |
186 @findex newsticker-stop | |
187 If you just want to start the periodic download of headlines use the | |
188 command @code{newsticker-start}. Calling @code{newsticker-stop} will | |
189 stop the periodic download, but will call | |
190 @code{newsticker-stop-ticker} as well. | |
191 | |
192 @node Configuration | |
193 @chapter Configuration | |
194 | |
195 All Newsticker options are customizable, i.e. they can be changed with | |
196 Emacs customization methods: Call the command | |
197 @code{customize-group} and enter @samp{newsticker} for the customization | |
198 group. | |
199 | |
200 All Newsticker options have reasonable default values, so that in most | |
201 cases it is not necessary to customize settings before starting Newsticker | |
202 for the first time. | |
203 | |
95912 | 204 The following list shows the available groups of newsticker options |
205 and some of the most important options. | |
84307 | 206 |
207 @itemize | |
208 | |
209 @item | |
95912 | 210 @code{newsticker-retrieval} contains options that define which news |
84307 | 211 feeds are retrieved and how this is done. |
212 | |
213 @itemize | |
214 @item | |
215 @vindex newsticker-url-list | |
216 @code{newsticker-url-list} defines the list of headlines which are | |
217 retrieved. | |
218 @item | |
95912 | 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. | |
223 @item | |
84307 | 224 @vindex newsticker-retrieval-interval |
225 @code{newsticker-retrieval-interval} defines how often headlines | |
226 are retrieved. | |
227 @end itemize | |
228 | |
229 @item | |
230 @code{newsticker-headline-processing} contains options that define | |
231 how the retrieved headlines are processed. | |
232 | |
233 @itemize | |
234 @item | |
235 @vindex newsticker-keep-obsolete-items | |
236 @code{newsticker-keep-obsolete-items} decides whether unread | |
237 headlines that have been removed from the feed are kept in the | |
238 Newsticker cache. | |
239 @item | |
95912 | 240 @vindex newsticker-auto-mark-filter-list |
241 @code{newsticker-auto-mark-filter-list} provides the possibility to | |
242 automatically mark headlines as immortal or old. | |
84307 | 243 @end itemize |
244 | |
245 @item | |
246 @code{newsticker-hooks} contains options for hooking other Emacs | |
247 commands to newsticker functions. | |
248 @itemize | |
249 @item | |
250 @vindex newsticker-new-item-functions | |
251 @code{newsticker-new-item-functions} allows for automatic | |
252 processing of headlines. See `newsticker-download-images', and | |
253 `newsticker-download-enclosures' for sample functions. | |
95912 | 254 @item |
255 @vindex newsticker-plainview-hooks | |
256 The subgroup @code{newsticker-plainview-hooks} contains hook which | |
257 apply to the plainview reader only. | |
84307 | 258 @end itemize |
259 | |
260 @item | |
261 @code{newsticker-miscellaneous} contains other Newsticker options. | |
262 | |
95912 | 263 @item |
264 @code{newsticker-ticker} contains options that define how headlines | |
265 are shown in the echo area, i.e. the ``ticker''. | |
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. | |
84307 | 274 @end itemize |
275 | |
95912 | 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. | |
84307 | 303 |
304 @node Remarks | |
305 @chapter Remarks | |
306 | |
307 Byte-compiling newsticker.el is recommended. | |
308 | |
309 @node GNU Free Documentation License | |
310 @appendix GNU Free Documentation License | |
311 @include doclicense.texi | |
312 | |
313 @node Index | |
314 @unnumbered Index | |
315 | |
316 @printindex cp | |
317 | |
318 @bye | |
319 | |
320 | |
321 | |
322 @ignore | |
323 arch-tag: 7a4de539-117c-4658-b799-0b9e3d0ccec0 | |
324 @end ignore |