Mercurial > emacs
annotate man/newsticker.texi @ 77235:88224dc74061
Include GFDL.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Sun, 15 Apr 2007 20:57:15 +0000 |
parents | 3d45362f1d38 |
children | 6b1f95e26181 |
rev | line source |
---|---|
65496 | 1 \input texinfo @c -*-texinfo-*- |
2 @comment %**start of header | |
65543
27612d890a6c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
65529
diff
changeset
|
3 @setfilename ../info/newsticker |
66705
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
4 @set VERSION 1.9 |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
5 @set UPDATED November 2005 |
65496 | 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 | |
75348 | 16 Copyright @copyright{} 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
65496 | 17 |
18 @quotation | |
19 Permission is granted to copy, distribute and/or modify this document | |
20 under the terms of the GNU Free Documentation License, Version 1.2 or | |
21 any later version published by the Free Software Foundation; with no | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
22 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
23 and with the Back-Cover Texts as in (a) below. A copy of the license |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
24 is included in the section entitled ``GNU Free Documentation License'' |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
25 in the Emacs manual. |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
26 |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
27 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
28 this GNU Manual, like GNU software. Copies published by the Free |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
29 Software Foundation raise funds for GNU development.'' |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
30 |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
31 This document is part of a collection distributed under the GNU Free |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
32 Documentation License. If you want to distribute this document |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
33 separately from the collection, you can do so by adding a copy of the |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
34 license to the document, as described in section 6 of the license. |
65496 | 35 @end quotation |
36 @end copying | |
37 | |
38 @dircategory Emacs | |
39 @direntry | |
40 * Newsticker: (newsticker). A Newsticker for Emacs. | |
41 @end direntry | |
42 | |
43 @titlepage | |
44 @title Newsticker -- a Newsticker for Emacs | |
45 @subtitle for version @value{VERSION}, @value{UPDATED} | |
46 @author Ulf Jasper | |
47 @author @email{ulf.jasper@@web.de} | |
48 @author @uref{http://de.geocities.com/ulf_jasper} | |
49 @page | |
50 @vskip 0pt plus 1filll | |
51 @end titlepage | |
52 | |
53 @contents | |
54 | |
55 @ifnottex | |
56 @node Top | |
57 @top Newsticker | |
58 @end ifnottex | |
59 | |
60 @menu | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
61 * Overview:: General description of newsticker. |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
62 * Requirements:: Requirements for using newsticker. |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
63 * Installation:: Installing newsticker on your system. |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
64 * Usage:: Basic newsticker instructions. |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
65 * Configuration:: Customizable newsticker settings. |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
66 * Remarks:: Remarks about newsticker. |
77235 | 67 * GNU Free Documentation License:: The license for this documentation. |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
68 * Index:: Variable, function, and concept index. |
65496 | 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 | |
66705
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
79 |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
80 Headlines consist of a title and (possibly) a small description. They |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
81 are contained in "RSS" (RDF Site Summary) or "Atom" files. Newsticker |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
82 should work with the following RSS formats: |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
83 |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
84 @itemize |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
85 @item RSS 0.91 (see @uref{http://backend.userland.com/rss091} or |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
86 @uref{http://my.netscape.com/publish/formats/rss-spec-0.91.html}), |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
87 @item RSS 0.92 (see @uref{http://backend.userland.com/rss092}), |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
88 @item RSS 1.0 (see @uref{http://purl.org/rss/1.0/spec} |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
89 @item RSS 2.0 (see @uref{http://blogs.law.harvard.edu/tech/rss}), |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
90 @end itemize |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
91 @itemize |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
92 as well as the following Atom formats: |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
93 @item Atom 0.3 |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
94 @item Atom 1.0 (see |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
95 @uref{http://www.ietf.org/internet-drafts/draft-ietf-atompub-format-11.txt}). |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
96 @end itemize |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
97 |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
98 That makes Newsticker.el an "Atom aggregator, "RSS reader", or "RSS |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
99 aggregator". |
65496 | 100 |
101 Newsticker provides several commands for reading headlines, navigating | |
102 through them, marking them as read/unread, hiding old headlines etc. | |
103 Headlines can be displayed as plain text or as rendered HTML. | |
104 | |
105 Headlines can be displayed in the echo area, either scrolling like | |
106 messages in a stock-quote ticker, or just changing. | |
107 | |
108 Newsticker allows for automatic processing of headlines by providing | |
109 hooks and (sample) functions for automatically downloading images and | |
110 enclosed files (as delivered by podcasts, e.g.). | |
111 | |
112 @ifhtml | |
113 Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 | |
114 (current version)} and some older screen shots: | |
115 @uref{newsticker-1.6.png, version 1.6}, | |
116 @uref{newsticker-1.5.png, version 1.5}, | |
117 @uref{newsticker-1.4.png, version 1.4} | |
118 @uref{newsticker-1.3.png, version 1.3}, | |
119 @uref{newsticker-1.0.png, version 1.0}. | |
120 @end ifhtml | |
121 | |
122 @node Requirements | |
123 @chapter Requirements | |
124 | |
125 Newsticker can be used with | |
126 @uref{http://www.gnu.org/software/emacs/emacs.html, GNU Emacs} version | |
127 21.1 or later as well as @uref{http://www.xemacs.org, XEmacs}. It | |
128 requires an XML-parser (@file{xml.el}) which is part of GNU Emacs. If | |
129 you are using XEmacs you want to get the @file{net-utils} package | |
130 which contains @file{xml.el} for XEmacs. | |
131 | |
132 Newsticker requires a program which can retrieve files via http and | |
133 prints them to stdout. By default Newsticker will use | |
134 @uref{http://www.gnu.org/software/wget/wget.html, wget} for this task. | |
135 | |
136 | |
137 @node Installation | |
138 @chapter Installation | |
139 | |
66705
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
140 As Newsticker is part of GNU Emacs there is no need to perform any |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
141 installation steps in order to use Newsticker. |
65496 | 142 |
66705
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
143 However, if you are using imenu, which allows for navigating with the |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
144 help of a menu, you should add the following to your Emacs startup file |
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
145 (@file{~/.emacs}). |
65496 | 146 |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
147 @lisp |
65496 | 148 (add-hook 'newsticker-mode-hook 'imenu-add-menubar-index) |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
149 @end lisp |
65496 | 150 |
151 That's it. | |
152 | |
153 @node Usage | |
154 @chapter Usage | |
155 | |
156 @findex newsticker-show-news | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
157 The command @code{newsticker-show-news} will display all available |
65496 | 158 headlines in a special buffer, called @samp{*newsticker*}. It will |
159 also start the asynchronous download of headlines. The modeline in | |
160 the @samp{*newsticker*} buffer informs whenever new headlines have | |
161 arrived. Clicking mouse-button 2 or pressing RET in this buffer on a | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
162 headline will call @code{browse-url} to load the corresponding news |
65496 | 163 story in your favourite web browser. |
164 | |
165 @findex newsticker-start-ticker | |
166 @findex newsticker-stop-ticker | |
167 The scrolling, or flashing of headlines in the echo area, can be | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
168 started with the command @code{newsticker-start-ticker}. It can be |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
169 stopped with @code{newsticker-stop-ticker}. |
65496 | 170 |
171 @findex newsticker-start | |
172 @findex newsticker-stop | |
173 If you just want to start the periodic download of headlines use the | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
174 command @code{newsticker-start}. Calling @code{newsticker-stop} will |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
175 stop the periodic download, but will call |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
176 @code{newsticker-stop-ticker} as well. |
65496 | 177 |
178 @node Configuration | |
179 @chapter Configuration | |
180 | |
181 All Newsticker options are customizable, i.e. they can be changed with | |
182 Emacs customization methods: Call the command | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
183 @code{customize-group} and enter @samp{newsticker} for the customization |
65496 | 184 group. |
185 | |
186 All Newsticker options have reasonable default values, so that in most | |
187 cases it is not necessary to customize settings before starting Newsticker | |
188 for the first time. | |
189 | |
190 Newsticker options are organized in the following groups. | |
191 | |
192 @itemize | |
193 | |
194 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
195 @code{newsticker-feed} contains options that define which news |
65496 | 196 feeds are retrieved and how this is done. |
197 | |
198 @itemize | |
199 @item | |
200 @vindex newsticker-url-list | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
201 @code{newsticker-url-list} defines the list of headlines which are |
65496 | 202 retrieved. |
203 @item | |
204 @vindex newsticker-retrieval-interval | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
205 @code{newsticker-retrieval-interval} defines how often headlines |
65496 | 206 are retrieved. |
207 @end itemize | |
208 | |
209 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
210 @code{newsticker-headline-processing} contains options that define |
65496 | 211 how the retrieved headlines are processed. |
212 | |
213 @itemize | |
214 @item | |
215 @vindex newsticker-keep-obsolete-items | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
216 @code{newsticker-keep-obsolete-items} decides whether unread |
65496 | 217 headlines that have been removed from the feed are kept in the |
218 Newsticker cache. | |
219 @end itemize | |
220 | |
221 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
222 @code{newsticker-layout} contains options that define how the |
66705
b1f7ceeabf51
VERSION changed to 1.9. Updated UPDATED.
Eli Zaretskii <eliz@gnu.org>
parents:
66302
diff
changeset
|
223 buffer for reading news headlines is formatted. |
65496 | 224 |
225 @itemize | |
226 @item | |
227 @vindex newsticker-heading-format | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
228 @code{newsticker-item-format} defines how the title of a headline |
65496 | 229 is formatted. |
230 @end itemize | |
231 | |
232 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
233 @code{newsticker-ticker} contains options that define how headlines |
65496 | 234 are shown in the echo area. |
235 | |
236 @itemize | |
237 @item | |
238 @vindex newsticker-display-interval | |
239 @vindex newsticker-scroll-smoothly | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
240 @code{newsticker-display-interval} and |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
241 @code{newsticker-scroll-smoothly} define how headlines are shown in |
65496 | 242 the echo area. |
243 @end itemize | |
244 | |
245 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
246 @code{newsticker-hooks} contains options for hooking other Emacs |
65496 | 247 commands to newsticker functions. |
248 @itemize | |
249 @item | |
250 @vindex newsticker-new-item-functions | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
251 @code{newsticker-new-item-functions} allows for automatic |
65496 | 252 processing of headlines. See `newsticker-download-images', and |
253 `newsticker-download-enclosures' for sample functions. | |
254 @end itemize | |
255 | |
256 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
257 @code{newsticker-miscellaneous} contains other Newsticker options. |
65496 | 258 |
259 @end itemize | |
260 | |
261 Please have a look at the customization buffers for the complete list | |
262 of options. | |
263 | |
264 @node Remarks | |
265 @chapter Remarks | |
266 | |
267 This newsticker is designed do its job silently in the background | |
268 without disturbing you. However, it is probably impossible to prevent | |
269 such a tool from slightly attenuating your Editor's responsiveness | |
270 every once in a while. | |
271 | |
272 Byte-compiling newsticker.el is recommended. | |
273 | |
77235 | 274 @node GNU Free Documentation License |
275 @appendix GNU Free Documentation License | |
276 @include doclicense.texi | |
65496 | 277 |
278 @node Index | |
279 @unnumbered Index | |
280 | |
281 @printindex cp | |
282 | |
283 @bye | |
284 | |
285 | |
286 | |
65497 | 287 @ignore |
288 arch-tag: 7a4de539-117c-4658-b799-0b9e3d0ccec0 | |
289 @end ignore |