Mercurial > emacs
comparison man/newsticker.texi @ 90228:fa0da9b57058
Revision: miles@gnu.org--gnu-2005/emacs--unicode--0--patch-82
Merge from emacs--cvs-trunk--0
Patches applied:
* emacs--cvs-trunk--0 (patch 542-553)
- Update from CVS
- Merge from gnus--rel--5.10
* gnus--rel--5.10 (patch 116-121)
- Merge from emacs--cvs-trunk--0
- Update from CVS
author | Miles Bader <miles@gnu.org> |
---|---|
date | Mon, 19 Sep 2005 10:20:33 +0000 |
parents | 7b943aaa8890 |
children | 626b546fed64 |
comparison
equal
deleted
inserted
replaced
90227:10fe5fadaf89 | 90228:fa0da9b57058 |
---|---|
1 \input texinfo @c -*-texinfo-*- | |
2 @comment $Id: newsticker.texi,v 1.5 2005/09/17 11:25:06 eliz Exp $ | |
3 @comment %**start of header | |
4 @setfilename ../info/newsticker | |
5 @set VERSION 1.8 | |
6 @set UPDATED ``$Id: newsticker.texi,v 1.5 2005/09/17 11:25:06 eliz Exp $'' | |
7 @settitle Newsticker @value{VERSION} | |
8 @syncodeindex vr cp | |
9 @syncodeindex fn cp | |
10 @syncodeindex pg cp | |
11 @comment %**end of header | |
12 | |
13 @copying | |
14 This manual is for Newsticker (version @value{VERSION}, @value{UPDATED}). | |
15 | |
16 @noindent | |
17 Copyright @copyright{} 2004, 2005 Free Software Foundation, Inc. | |
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 | |
28 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify | |
29 this GNU Manual, like GNU software. Copies published by the Free | |
30 Software Foundation raise funds for GNU development.'' | |
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} | |
49 @author @uref{http://de.geocities.com/ulf_jasper} | |
50 @page | |
51 @vskip 0pt plus 1filll | |
52 @end titlepage | |
53 | |
54 @contents | |
55 | |
56 @ifnottex | |
57 @node Top | |
58 @top Newsticker | |
59 @end ifnottex | |
60 | |
61 @menu | |
62 * Overview:: General description of newsticker. | |
63 * Requirements:: Requirements for using newsticker. | |
64 * Installation:: Installing newsticker on your system. | |
65 * Usage:: Basic newsticker instructions. | |
66 * Configuration:: Customizable newsticker settings. | |
67 * Remarks:: Remarks about newsticker. | |
68 * Index:: Variable, function, and concept index. | |
69 @end menu | |
70 | |
71 @node Overview | |
72 @chapter Overview | |
73 | |
74 Newsticker provides a newsticker for Emacs. A newsticker is a thing | |
75 that asynchronously retrieves headlines from a list of news sites, | |
76 prepares these headlines for reading, and allows for loading the | |
77 corresponding articles in a web browser. | |
78 | |
79 Headlines consist of a title and (possibly) a small description. They | |
80 are contained in RSS (RDF Site Summary) files. Newsticker should work | |
81 with all RSS files that follow the @uref{http://purl.org/rss/1.0/spec, | |
82 RDF Rich Site Summary 1.0} specification. It should also work with | |
83 version 2.0 as well as other/older/alternative rss formats (like | |
84 0.9<something> or such). In other words: Newsticker is a ``RSS | |
85 reader'' or ``RSS aggregator''. | |
86 | |
87 Newsticker provides several commands for reading headlines, navigating | |
88 through them, marking them as read/unread, hiding old headlines etc. | |
89 Headlines can be displayed as plain text or as rendered HTML. | |
90 | |
91 Headlines can be displayed in the echo area, either scrolling like | |
92 messages in a stock-quote ticker, or just changing. | |
93 | |
94 Newsticker allows for automatic processing of headlines by providing | |
95 hooks and (sample) functions for automatically downloading images and | |
96 enclosed files (as delivered by podcasts, e.g.). | |
97 | |
98 @ifhtml | |
99 Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 | |
100 (current version)} and some older screen shots: | |
101 @uref{newsticker-1.6.png, version 1.6}, | |
102 @uref{newsticker-1.5.png, version 1.5}, | |
103 @uref{newsticker-1.4.png, version 1.4} | |
104 @uref{newsticker-1.3.png, version 1.3}, | |
105 @uref{newsticker-1.0.png, version 1.0}. | |
106 @end ifhtml | |
107 | |
108 @node Requirements | |
109 @chapter Requirements | |
110 | |
111 Newsticker can be used with | |
112 @uref{http://www.gnu.org/software/emacs/emacs.html, GNU Emacs} version | |
113 21.1 or later as well as @uref{http://www.xemacs.org, XEmacs}. It | |
114 requires an XML-parser (@file{xml.el}) which is part of GNU Emacs. If | |
115 you are using XEmacs you want to get the @file{net-utils} package | |
116 which contains @file{xml.el} for XEmacs. | |
117 | |
118 Newsticker requires a program which can retrieve files via http and | |
119 prints them to stdout. By default Newsticker will use | |
120 @uref{http://www.gnu.org/software/wget/wget.html, wget} for this task. | |
121 | |
122 | |
123 @node Installation | |
124 @chapter Installation | |
125 | |
126 Place Newsticker in a directory where Emacs can find it. Add the | |
127 following line to your Emacs startup file (@file{~/.emacs}). | |
128 | |
129 @lisp | |
130 (add-to-list 'load-path "/path/to/newsticker/") | |
131 (autoload 'newsticker-start "newsticker" "Emacs Newsticker" t) | |
132 (autoload 'newsticker-show-news "newsticker" "Emacs Newsticker" t) | |
133 @end lisp | |
134 | |
135 Newsticker-mode supports imenu. This allows for navigating with the | |
136 help of a menu. In order to use this feature you should also add the | |
137 following. | |
138 | |
139 @lisp | |
140 (add-hook 'newsticker-mode-hook 'imenu-add-menubar-index) | |
141 @end lisp | |
142 | |
143 That's it. | |
144 | |
145 @node Usage | |
146 @chapter Usage | |
147 | |
148 @findex newsticker-show-news | |
149 The command @code{newsticker-show-news} will display all available | |
150 headlines in a special buffer, called @samp{*newsticker*}. It will | |
151 also start the asynchronous download of headlines. The modeline in | |
152 the @samp{*newsticker*} buffer informs whenever new headlines have | |
153 arrived. Clicking mouse-button 2 or pressing RET in this buffer on a | |
154 headline will call @code{browse-url} to load the corresponding news | |
155 story in your favourite web browser. | |
156 | |
157 @findex newsticker-start-ticker | |
158 @findex newsticker-stop-ticker | |
159 The scrolling, or flashing of headlines in the echo area, can be | |
160 started with the command @code{newsticker-start-ticker}. It can be | |
161 stopped with @code{newsticker-stop-ticker}. | |
162 | |
163 @findex newsticker-start | |
164 @findex newsticker-stop | |
165 If you just want to start the periodic download of headlines use the | |
166 command @code{newsticker-start}. Calling @code{newsticker-stop} will | |
167 stop the periodic download, but will call | |
168 @code{newsticker-stop-ticker} as well. | |
169 | |
170 @node Configuration | |
171 @chapter Configuration | |
172 | |
173 All Newsticker options are customizable, i.e. they can be changed with | |
174 Emacs customization methods: Call the command | |
175 @code{customize-group} and enter @samp{newsticker} for the customization | |
176 group. | |
177 | |
178 All Newsticker options have reasonable default values, so that in most | |
179 cases it is not necessary to customize settings before starting Newsticker | |
180 for the first time. | |
181 | |
182 Newsticker options are organized in the following groups. | |
183 | |
184 @itemize | |
185 | |
186 @item | |
187 @code{newsticker-feed} contains options that define which news | |
188 feeds are retrieved and how this is done. | |
189 | |
190 @itemize | |
191 @item | |
192 @vindex newsticker-url-list | |
193 @code{newsticker-url-list} defines the list of headlines which are | |
194 retrieved. | |
195 @item | |
196 @vindex newsticker-retrieval-interval | |
197 @code{newsticker-retrieval-interval} defines how often headlines | |
198 are retrieved. | |
199 @end itemize | |
200 | |
201 @item | |
202 @code{newsticker-headline-processing} contains options that define | |
203 how the retrieved headlines are processed. | |
204 | |
205 @itemize | |
206 @item | |
207 @vindex newsticker-keep-obsolete-items | |
208 @code{newsticker-keep-obsolete-items} decides whether unread | |
209 headlines that have been removed from the feed are kept in the | |
210 Newsticker cache. | |
211 @end itemize | |
212 | |
213 @item | |
214 @code{newsticker-layout} contains options that define how the | |
215 buffer for reading RSS headlines is formatted. | |
216 | |
217 @itemize | |
218 @item | |
219 @vindex newsticker-heading-format | |
220 @code{newsticker-item-format} defines how the title of a headline | |
221 is formatted. | |
222 @end itemize | |
223 | |
224 @item | |
225 @code{newsticker-ticker} contains options that define how headlines | |
226 are shown in the echo area. | |
227 | |
228 @itemize | |
229 @item | |
230 @vindex newsticker-display-interval | |
231 @vindex newsticker-scroll-smoothly | |
232 @code{newsticker-display-interval} and | |
233 @code{newsticker-scroll-smoothly} define how headlines are shown in | |
234 the echo area. | |
235 @end itemize | |
236 | |
237 @item | |
238 @code{newsticker-hooks} contains options for hooking other Emacs | |
239 commands to newsticker functions. | |
240 @itemize | |
241 @item | |
242 @vindex newsticker-new-item-functions | |
243 @code{newsticker-new-item-functions} allows for automatic | |
244 processing of headlines. See `newsticker-download-images', and | |
245 `newsticker-download-enclosures' for sample functions. | |
246 @end itemize | |
247 | |
248 @item | |
249 @code{newsticker-miscellaneous} contains other Newsticker options. | |
250 | |
251 @end itemize | |
252 | |
253 Please have a look at the customization buffers for the complete list | |
254 of options. | |
255 | |
256 @node Remarks | |
257 @chapter Remarks | |
258 | |
259 This newsticker is designed do its job silently in the background | |
260 without disturbing you. However, it is probably impossible to prevent | |
261 such a tool from slightly attenuating your Editor's responsiveness | |
262 every once in a while. | |
263 | |
264 Byte-compiling newsticker.el is recommended. | |
265 | |
266 | |
267 | |
268 @node Index | |
269 @unnumbered Index | |
270 | |
271 @printindex cp | |
272 | |
273 @bye | |
274 | |
275 | |
276 | |
277 @ignore | |
278 arch-tag: 7a4de539-117c-4658-b799-0b9e3d0ccec0 | |
279 @end ignore |