Newsticker
**********

This manual is for Newsticker (version 1.99, June 2008).

Copyright © 2004-2011 Free Software Foundation, Inc.

     Permission is granted to copy, distribute and/or modify this document 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.''

Overview
********

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 works with the following RSS formats:

  * RSS 0.91 (see http://backend.userland.com/rss091 or http://my.netscape.com/publish/formats/rss-spec-0.91.html),

  * RSS 0.92 (see http://backend.userland.com/rss092),

  * RSS 1.0 (see http://purl.org/rss/1.0/spec

  * RSS 2.0 (see http://blogs.law.harvard.edu/tech/rss),

     as well as the following Atom formats:

  * Atom 0.3

  * Atom 1.0 (see http://www.ietf.org/internet-drafts/draft-ietf-atompub-format-11.txt).

That makes Newsticker.el an ``Atom aggregator'', ``RSS reader'', ``Feed aggregator'', or ``Feed reader''.

Newsticker provides several commands for reading headlines, navigating through them, marking them as read/unread, hiding old headlines etc. Headlines can be displayed as plain text or as rendered HTML.

Headlines can be displayed in the echo area, either scrolling like 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.).

Requirements
************

Newsticker can be used with GNU Emacs (http://www.gnu.org/software/emacs/emacs.html) version 21.1 or later as well as XEmacs (http://www.xemacs.org).  It requires an XML-parser (xml.el) which is part of GNU Emacs.  If you are using XEmacs you want to get the net-utils package which contains xml.el for XEmacs.

Newsticker retrieves headlines either via Emacs' built-in retrieval functions, by an arbitrary external program that retrieves files via http and prints them to stdout (like wget (http://www.gnu.org/software/wget/wget.html), or -- on a per feed basis -- via an arbitrary Lisp command.

Installation
************

As Newsticker is part of GNU Emacs there is no need to perform any installation steps in order to use Newsticker.

However, if you are using imenu, which allows for navigating with the help of a menu, you should add the following to your Emacs startup file (~/.emacs).

     (add-hook 'newsticker-mode-hook 'imenu-add-menubar-index)

That's it.

Usage
*****

The command newsticker-show-news will display all available headlines.  It will also start the asynchronous download of headlines.

You can choose between two different frontends for reading headlines:

  * Newsticker's 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.

  * Newsticker's plainview displays all headlines in a single buffer, called *newsticker*. The modeline in the *newsticker* buffer informs whenever new headlines have arrived.

In both views clicking mouse-button 2 or pressing RET on a headline will call browse-url to load the corresponding news story in your favorite web browser.

The scrolling, or flashing of headlines in the echo area, can be started with the command newsticker-start-ticker. It can be stopped with newsticker-stop-ticker.

If you just want to start the periodic download of headlines use the command newsticker-start. Calling newsticker-stop will stop the periodic download, but will call newsticker-stop-ticker as well.

Configuration
*************

All Newsticker options are customizable, i.e. they can be changed with Emacs customization methods: Call the command customize-group and enter newsticker for the customization group.

All Newsticker options have reasonable default values, so that in most cases it is not necessary to customize settings before starting Newsticker for the first time.

The following list shows the available groups of newsticker options and some of the most important options.

  * newsticker-retrieval contains options that define which news feeds are retrieved and how this is done.

       * newsticker-url-list defines the list of headlines which are retrieved.

       * newsticker-retrieval-method defines how headlines are retrieved. This is either done using Emacs' built-in download capabilities or using an external tool.

       * newsticker-retrieval-interval defines how often headlines are retrieved.

  * newsticker-headline-processing contains options that define how the retrieved headlines are processed.

       * newsticker-keep-obsolete-items decides whether unread headlines that have been removed from the feed are kept in the Newsticker cache.

       * newsticker-auto-mark-filter-list provides the possibility to automatically mark headlines as immortal or old.

  * newsticker-hooks contains options for hooking other Emacs commands to newsticker functions.

       * newsticker-new-item-functions allows for automatic processing of headlines. See `newsticker-download-images', and `newsticker-download-enclosures' for sample functions.

       * The subgroup newsticker-plainview-hooks contains hook which apply to the plainview reader only.

  * newsticker-miscellaneous contains other Newsticker options.

  * newsticker-ticker contains options that define how headlines are shown in the echo area, i.e. the ``ticker''.

       * newsticker-ticker-interval and newsticker-scroll-smoothly define how headlines are shown in the echo area.

  * newsticker-reader contains options for adjusting the headline reader.

       * newsticker-frontend determines the actual headline reader. The ``plainview'' reader uses a single buffer, the ``treeview'' uses separate buffers and windows.

       * The subgroup newsticker-plainview contains options for the plainview reader.

       * The subgroup newsticker-treeview contains options for the treeview reader.

For the complete list of options please have a look at the customization buffers.

Remarks
*******

Byte-compiling newsticker.el is recommended.

GNU Free Documentation License
******************************

     [file doclicense.texi not included]