X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/9850eff524bd0747a9561f3b4c90dfc3749f4ecb..5c560880659048888420389c02e20d6867ec81df:/doc/misc/newsticker.texi diff --git a/doc/misc/newsticker.texi b/doc/misc/newsticker.texi index 657c891dd6..56702502f9 100644 --- a/doc/misc/newsticker.texi +++ b/doc/misc/newsticker.texi @@ -13,30 +13,28 @@ This manual is for Newsticker (version @value{VERSION}, @value{UPDATED}). @noindent -Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 -Free Software Foundation, Inc. +Copyright @copyright{} 2004--2012 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.2 or +under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying -@dircategory Emacs +@dircategory Emacs network features @direntry -* Newsticker: (newsticker). A Newsticker for Emacs. +* Newsticker: (newsticker). A Newsticker for Emacs. @end direntry @titlepage -@title Newsticker -- a Newsticker for Emacs +@title Newsticker---a Newsticker for Emacs @subtitle for version @value{VERSION}, @value{UPDATED} @author Ulf Jasper @author @email{ulf.jasper@@web.de} @@ -51,6 +49,9 @@ developing GNU and promoting software freedom.'' @ifnottex @node Top @top Newsticker + +@insertcopying + @end ifnottex @menu @@ -67,14 +68,14 @@ developing GNU and promoting software freedom.'' @node Overview @chapter Overview -Newsticker provides a newsticker for Emacs. A newsticker is a thing +Newsticker provides a newsticker for Emacs. A newsticker is a thing that asynchronously retrieves headlines from a list of news sites, prepares these headlines for reading, and allows for loading the corresponding articles in a web browser. Headlines consist of a title and (possibly) a small description. They -are contained in "RSS" (RDF Site Summary) or "Atom" files. Newsticker +are contained in ``RSS'' (RDF Site Summary) or ``Atom'' files. Newsticker works with the following RSS formats: @itemize @@ -103,17 +104,19 @@ messages in a stock-quote ticker, or just changing. Newsticker allows for automatic processing of headlines by providing hooks and (sample) functions for automatically downloading images and -enclosed files (as delivered by podcasts, e.g.). +enclosed files (as delivered by, e.g., podcasts). +@ignore @ifhtml Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 (current version)} and some older screen shots: @uref{newsticker-1.6.png, version 1.6}, -@uref{newsticker-1.5.png, version 1.5}, +@uref{newsticker-1.5.png, version 1.5}, @uref{newsticker-1.4.png, version 1.4} -@uref{newsticker-1.3.png, version 1.3}, +@uref{newsticker-1.3.png, version 1.3}, @uref{newsticker-1.0.png, version 1.0}. @end ifhtml +@end ignore @node Requirements @chapter Requirements @@ -121,15 +124,15 @@ Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 Newsticker can be used with @uref{http://www.gnu.org/software/emacs/emacs.html, GNU Emacs} version 21.1 or later as well as @uref{http://www.xemacs.org, XEmacs}. It -requires an XML-parser (@file{xml.el}) which is part of GNU Emacs. If +requires an XML-parser (@file{xml.el}), which is part of GNU Emacs. If you are using XEmacs you want to get the @file{net-utils} package which contains @file{xml.el} for XEmacs. -Newsticker retrieves headlines either via Emacs' built-in retrieval +Newsticker retrieves headlines either via Emacs's built-in retrieval functions, by an arbitrary external program that retrieves files via http and prints them to stdout (like -@uref{http://www.gnu.org/software/wget/wget.html, wget}, or -- on a -per feed basis -- via an arbitrary Lisp command. +@uref{http://www.gnu.org/software/wget/wget.html, wget}, or---on a +per feed basis---via an arbitrary Lisp command. @node Installation @@ -159,35 +162,35 @@ You can choose between two different frontends for reading headlines: @itemize @item Newsticker's @emph{treeview} uses separate windows for the feeds (in tree form), a list of headlines for the current feed, and -the content of the current headline. Feeds can be placed into groups -which itself can be placed in groups and so on. +the content of the current headline. Feeds can be placed into groups, +which themselves can be placed in groups and so on. @item Newsticker's @emph{plainview} displays all headlines in a -single buffer, called @samp{*newsticker*}. The modeline in the -@samp{*newsticker*} buffer informs whenever new headlines have +single buffer, called @samp{*newsticker*}. The modeline in the +@samp{*newsticker*} buffer informs you whenever new headlines have arrived. @end itemize In both views clicking mouse-button 2 or pressing RET on a headline will call @code{browse-url} to load the corresponding news story in -your favourite web browser. +your favorite web browser. @findex newsticker-start-ticker @findex newsticker-stop-ticker The scrolling, or flashing of headlines in the echo area, can be -started with the command @code{newsticker-start-ticker}. It can be +started with the command @code{newsticker-start-ticker}. It can be stopped with @code{newsticker-stop-ticker}. @findex newsticker-start @findex newsticker-stop If you just want to start the periodic download of headlines use the -command @code{newsticker-start}. Calling @code{newsticker-stop} will +command @code{newsticker-start}. Calling @code{newsticker-stop} will stop the periodic download, but will call @code{newsticker-stop-ticker} as well. @node Configuration @chapter Configuration -All Newsticker options are customizable, i.e. they can be changed with -Emacs customization methods: Call the command +All Newsticker options are customizable, i.e., they can be changed with +Emacs customization methods. Call the command @code{customize-group} and enter @samp{newsticker} for the customization group. @@ -202,17 +205,17 @@ and some of the most important options. @item @code{newsticker-retrieval} contains options that define which news -feeds are retrieved and how this is done. +feeds are retrieved and how this is done. @itemize @item @vindex newsticker-url-list -@code{newsticker-url-list} defines the list of headlines which are +@code{newsticker-url-list} defines the list of headlines that are retrieved. @item @vindex newsticker-retrieval-method @code{newsticker-retrieval-method} defines how headlines are -retrieved. This is either done using Emacs' built-in download +retrieved. This is either done using Emacs's built-in download capabilities or using an external tool. @item @vindex newsticker-retrieval-interval @@ -238,16 +241,16 @@ automatically mark headlines as immortal or old. @item @code{newsticker-hooks} contains options for hooking other Emacs -commands to newsticker functions. +commands to newsticker functions. @itemize @item @vindex newsticker-new-item-functions @code{newsticker-new-item-functions} allows for automatic -processing of headlines. See `newsticker-download-images', and -`newsticker-download-enclosures' for sample functions. +processing of headlines. See @code{newsticker-download-images}, and +@code{newsticker-download-enclosures} for sample functions. @item @vindex newsticker-plainview-hooks -The subgroup @code{newsticker-plainview-hooks} contains hook which +The subgroup @code{newsticker-plainview-hooks} contains hooks that apply to the plainview reader only. @end itemize @@ -256,7 +259,7 @@ apply to the plainview reader only. @item @code{newsticker-ticker} contains options that define how headlines -are shown in the echo area, i.e. the ``ticker''. +are shown in the echo area, i.e., the ``ticker''. @itemize @item @@ -274,7 +277,7 @@ the echo area. @itemize @item @vindex newsticker-frontend -@code{newsticker-frontend} determines the actual headline reader. The +@code{newsticker-frontend} determines the actual headline reader. The ``plainview'' reader uses a single buffer, the ``treeview'' uses separate buffers and windows. @end itemize @@ -310,9 +313,3 @@ Byte-compiling newsticker.el is recommended. @printindex cp @bye - - - -@ignore - arch-tag: 7a4de539-117c-4658-b799-0b9e3d0ccec0 -@end ignore