Mercurial > emacs
annotate man/newsticker.texi @ 66554:ba2cdafde956
(gdb-tooltip-print-1): Fix regexp.
(gdb-registers-font-lock-keywords): Delete.
(gdb-registers-mode): Don't fontify.
(gdb-info-registers-custom): Use text properties instead as, in
future, changed register values will use font-lock-warning-face.
(gdb-local-font-lock-keywords): Rename to...
(gdb-locals-font-lock-keywords): ...for consistency.
author | Nick Roberts <nickrob@snap.net.nz> |
---|---|
date | Sun, 30 Oct 2005 12:10:14 +0000 |
parents | 03166abdb4bd |
children | b1f7ceeabf51 b31326248cf6 |
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 |
65496 | 4 @set VERSION 1.8 |
66302 | 5 @set UPDATED October 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 | |
16 Copyright @copyright{} 2004, 2005 Free Software Foundation, Inc. | |
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. |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
67 * Index:: Variable, function, and concept index. |
65496 | 68 @end menu |
69 | |
70 @node Overview | |
71 @chapter Overview | |
72 | |
73 Newsticker provides a newsticker for Emacs. A newsticker is a thing | |
74 that asynchronously retrieves headlines from a list of news sites, | |
75 prepares these headlines for reading, and allows for loading the | |
76 corresponding articles in a web browser. | |
77 | |
78 Headlines consist of a title and (possibly) a small description. They | |
79 are contained in RSS (RDF Site Summary) files. Newsticker should work | |
80 with all RSS files that follow the @uref{http://purl.org/rss/1.0/spec, | |
81 RDF Rich Site Summary 1.0} specification. It should also work with | |
82 version 2.0 as well as other/older/alternative rss formats (like | |
83 0.9<something> or such). In other words: Newsticker is a ``RSS | |
84 reader'' or ``RSS aggregator''. | |
85 | |
86 Newsticker provides several commands for reading headlines, navigating | |
87 through them, marking them as read/unread, hiding old headlines etc. | |
88 Headlines can be displayed as plain text or as rendered HTML. | |
89 | |
90 Headlines can be displayed in the echo area, either scrolling like | |
91 messages in a stock-quote ticker, or just changing. | |
92 | |
93 Newsticker allows for automatic processing of headlines by providing | |
94 hooks and (sample) functions for automatically downloading images and | |
95 enclosed files (as delivered by podcasts, e.g.). | |
96 | |
97 @ifhtml | |
98 Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 | |
99 (current version)} and some older screen shots: | |
100 @uref{newsticker-1.6.png, version 1.6}, | |
101 @uref{newsticker-1.5.png, version 1.5}, | |
102 @uref{newsticker-1.4.png, version 1.4} | |
103 @uref{newsticker-1.3.png, version 1.3}, | |
104 @uref{newsticker-1.0.png, version 1.0}. | |
105 @end ifhtml | |
106 | |
107 @node Requirements | |
108 @chapter Requirements | |
109 | |
110 Newsticker can be used with | |
111 @uref{http://www.gnu.org/software/emacs/emacs.html, GNU Emacs} version | |
112 21.1 or later as well as @uref{http://www.xemacs.org, XEmacs}. It | |
113 requires an XML-parser (@file{xml.el}) which is part of GNU Emacs. If | |
114 you are using XEmacs you want to get the @file{net-utils} package | |
115 which contains @file{xml.el} for XEmacs. | |
116 | |
117 Newsticker requires a program which can retrieve files via http and | |
118 prints them to stdout. By default Newsticker will use | |
119 @uref{http://www.gnu.org/software/wget/wget.html, wget} for this task. | |
120 | |
121 | |
122 @node Installation | |
123 @chapter Installation | |
124 | |
125 Place Newsticker in a directory where Emacs can find it. Add the | |
126 following line to your Emacs startup file (@file{~/.emacs}). | |
127 | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
128 @lisp |
65496 | 129 (add-to-list 'load-path "/path/to/newsticker/") |
130 (autoload 'newsticker-start "newsticker" "Emacs Newsticker" t) | |
131 (autoload 'newsticker-show-news "newsticker" "Emacs Newsticker" t) | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
132 @end lisp |
65496 | 133 |
134 Newsticker-mode supports imenu. This allows for navigating with the | |
135 help of a menu. In order to use this feature you should also add the | |
136 following. | |
137 | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
138 @lisp |
65496 | 139 (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
|
140 @end lisp |
65496 | 141 |
142 That's it. | |
143 | |
144 @node Usage | |
145 @chapter Usage | |
146 | |
147 @findex newsticker-show-news | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
148 The command @code{newsticker-show-news} will display all available |
65496 | 149 headlines in a special buffer, called @samp{*newsticker*}. It will |
150 also start the asynchronous download of headlines. The modeline in | |
151 the @samp{*newsticker*} buffer informs whenever new headlines have | |
152 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
|
153 headline will call @code{browse-url} to load the corresponding news |
65496 | 154 story in your favourite web browser. |
155 | |
156 @findex newsticker-start-ticker | |
157 @findex newsticker-stop-ticker | |
158 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
|
159 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
|
160 stopped with @code{newsticker-stop-ticker}. |
65496 | 161 |
162 @findex newsticker-start | |
163 @findex newsticker-stop | |
164 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
|
165 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
|
166 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
|
167 @code{newsticker-stop-ticker} as well. |
65496 | 168 |
169 @node Configuration | |
170 @chapter Configuration | |
171 | |
172 All Newsticker options are customizable, i.e. they can be changed with | |
173 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
|
174 @code{customize-group} and enter @samp{newsticker} for the customization |
65496 | 175 group. |
176 | |
177 All Newsticker options have reasonable default values, so that in most | |
178 cases it is not necessary to customize settings before starting Newsticker | |
179 for the first time. | |
180 | |
181 Newsticker options are organized in the following groups. | |
182 | |
183 @itemize | |
184 | |
185 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
186 @code{newsticker-feed} contains options that define which news |
65496 | 187 feeds are retrieved and how this is done. |
188 | |
189 @itemize | |
190 @item | |
191 @vindex newsticker-url-list | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
192 @code{newsticker-url-list} defines the list of headlines which are |
65496 | 193 retrieved. |
194 @item | |
195 @vindex newsticker-retrieval-interval | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
196 @code{newsticker-retrieval-interval} defines how often headlines |
65496 | 197 are retrieved. |
198 @end itemize | |
199 | |
200 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
201 @code{newsticker-headline-processing} contains options that define |
65496 | 202 how the retrieved headlines are processed. |
203 | |
204 @itemize | |
205 @item | |
206 @vindex newsticker-keep-obsolete-items | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
207 @code{newsticker-keep-obsolete-items} decides whether unread |
65496 | 208 headlines that have been removed from the feed are kept in the |
209 Newsticker cache. | |
210 @end itemize | |
211 | |
212 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
213 @code{newsticker-layout} contains options that define how the |
65496 | 214 buffer for reading RSS headlines is formatted. |
215 | |
216 @itemize | |
217 @item | |
218 @vindex newsticker-heading-format | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
219 @code{newsticker-item-format} defines how the title of a headline |
65496 | 220 is formatted. |
221 @end itemize | |
222 | |
223 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
224 @code{newsticker-ticker} contains options that define how headlines |
65496 | 225 are shown in the echo area. |
226 | |
227 @itemize | |
228 @item | |
229 @vindex newsticker-display-interval | |
230 @vindex newsticker-scroll-smoothly | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
231 @code{newsticker-display-interval} and |
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
232 @code{newsticker-scroll-smoothly} define how headlines are shown in |
65496 | 233 the echo area. |
234 @end itemize | |
235 | |
236 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
237 @code{newsticker-hooks} contains options for hooking other Emacs |
65496 | 238 commands to newsticker functions. |
239 @itemize | |
240 @item | |
241 @vindex newsticker-new-item-functions | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
242 @code{newsticker-new-item-functions} allows for automatic |
65496 | 243 processing of headlines. See `newsticker-download-images', and |
244 `newsticker-download-enclosures' for sample functions. | |
245 @end itemize | |
246 | |
247 @item | |
65568
7b943aaa8890
Replace @command with @code. Replace @example with @lisp.
Eli Zaretskii <eliz@gnu.org>
parents:
65543
diff
changeset
|
248 @code{newsticker-miscellaneous} contains other Newsticker options. |
65496 | 249 |
250 @end itemize | |
251 | |
252 Please have a look at the customization buffers for the complete list | |
253 of options. | |
254 | |
255 @node Remarks | |
256 @chapter Remarks | |
257 | |
258 This newsticker is designed do its job silently in the background | |
259 without disturbing you. However, it is probably impossible to prevent | |
260 such a tool from slightly attenuating your Editor's responsiveness | |
261 every once in a while. | |
262 | |
263 Byte-compiling newsticker.el is recommended. | |
264 | |
265 | |
266 | |
267 @node Index | |
268 @unnumbered Index | |
269 | |
270 @printindex cp | |
271 | |
272 @bye | |
273 | |
274 | |
275 | |
65497 | 276 @ignore |
277 arch-tag: 7a4de539-117c-4658-b799-0b9e3d0ccec0 | |
278 @end ignore |